-
-
Notifications
You must be signed in to change notification settings - Fork 59
/
Copy pathdynamics-web-api.js
2105 lines (1795 loc) · 82.5 KB
/
dynamics-web-api.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*! dynamics-web-api v1.3.3 (c) 2017 Aleksandr Rogov */
(function webpackUniversalModuleDefinition(root, factory) {
if(typeof exports === 'object' && typeof module === 'object')
module.exports = factory();
else if(typeof define === 'function' && define.amd)
define("DynamicsWebApi", [], factory);
else if(typeof exports === 'object')
exports["DynamicsWebApi"] = factory();
else
root["DynamicsWebApi"] = factory();
})(this, function() {
return /******/ (function(modules) { // webpackBootstrap
/******/ // The module cache
/******/ var installedModules = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/
/******/ // Check if module is in cache
/******/ if(installedModules[moduleId]) {
/******/ return installedModules[moduleId].exports;
/******/ }
/******/ // Create a new module (and put it into the cache)
/******/ var module = installedModules[moduleId] = {
/******/ i: moduleId,
/******/ l: false,
/******/ exports: {}
/******/ };
/******/
/******/ // Execute the module function
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
/******/
/******/ // Flag the module as loaded
/******/ module.l = true;
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/******/
/******/ // expose the modules object (__webpack_modules__)
/******/ __webpack_require__.m = modules;
/******/
/******/ // expose the module cache
/******/ __webpack_require__.c = installedModules;
/******/
/******/ // identity function for calling harmony imports with the correct context
/******/ __webpack_require__.i = function(value) { return value; };
/******/
/******/ // define getter function for harmony exports
/******/ __webpack_require__.d = function(exports, name, getter) {
/******/ if(!__webpack_require__.o(exports, name)) {
/******/ Object.defineProperty(exports, name, {
/******/ configurable: false,
/******/ enumerable: true,
/******/ get: getter
/******/ });
/******/ }
/******/ };
/******/
/******/ // getDefaultExport function for compatibility with non-harmony modules
/******/ __webpack_require__.n = function(module) {
/******/ var getter = module && module.__esModule ?
/******/ function getDefault() { return module['default']; } :
/******/ function getModuleExports() { return module; };
/******/ __webpack_require__.d(getter, 'a', getter);
/******/ return getter;
/******/ };
/******/
/******/ // Object.prototype.hasOwnProperty.call
/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };
/******/
/******/ // __webpack_public_path__
/******/ __webpack_require__.p = "";
/******/
/******/ // Load entry module and return exports
/******/ return __webpack_require__(__webpack_require__.s = 6);
/******/ })
/************************************************************************/
/******/ ([
/* 0 */
/***/ (function(module, exports) {
var DWA = {
Types: {
ResponseBase: function () {
/// <field name='oDataContext' type='String'>The context URL (see [OData-Protocol]) for the payload.</field>
this.oDataContext = "";
},
Response: function () {
/// <field name='value' type='Object'>Response value returned from the request.</field>
DWA.Types.ResponseBase.call(this);
this.value = {};
},
ReferenceResponse: function () {
/// <field name='id' type='String'>A String representing the GUID value of the record.</field>
/// <field name='collection' type='String'>The name of the Entity Collection that the record belongs to.</field>
DWA.Types.ResponseBase.call(this);
this.id = "";
this.collection = "";
},
MultipleResponse: function () {
/// <field name='oDataNextLink' type='String'>The link to the next page.</field>
/// <field name='oDataCount' type='Number'>The count of the records.</field>
/// <field name='value' type='Array'>The array of the records returned from the request.</field>
DWA.Types.ResponseBase.call(this);
this.oDataNextLink = "";
this.oDataCount = 0;
this.value = [];
},
FetchXmlResponse: function () {
/// <field name='value' type='Array'>The array of the records returned from the request.</field>
/// <field name='pagingInfo' type='Object'>Paging Information</field>
DWA.Types.ResponseBase.call(this);
this.value = [];
this.PagingInfo = {
/// <param name='cookie' type='String'>Paging Cookie</param>
/// <param name='number' type='Number'>Page Number</param>
cookie: "",
page: 0,
nextPage: 1
}
}
},
Prefer: {
/// <field type="String">return=representation</field>
ReturnRepresentation: "return=representation",
Annotations: {
/// <field type="String">Microsoft.Dynamics.CRM.associatednavigationproperty</field>
AssociatedNavigationProperty: 'Microsoft.Dynamics.CRM.associatednavigationproperty',
/// <field type="String">Microsoft.Dynamics.CRM.lookuplogicalname</field>
LookupLogicalName: 'Microsoft.Dynamics.CRM.lookuplogicalname',
/// <field type="String">*</field>
All: '*',
/// <field type="String">OData.Community.Display.V1.FormattedValue</field>
FormattedValue: 'OData.Community.Display.V1.FormattedValue',
/// <field type="String">Microsoft.Dynamics.CRM.fetchxmlpagingcookie</field>
FetchXmlPagingCookie: 'Microsoft.Dynamics.CRM.fetchxmlpagingcookie'
}
}
}
module.exports = DWA;
/***/ }),
/* 1 */
/***/ (function(module, exports) {
function throwParameterError(functionName, parameterName, type) {
throw new Error(type
? functionName + " requires the " + parameterName + " parameter to be of type " + type
: functionName + " requires the " + parameterName + " parameter.");
};
var ErrorHelper = {
handleErrorResponse: function (req) {
///<summary>
/// Private function return an Error object to the errorCallback
///</summary>
///<param name="req" type="XMLHttpRequest">
/// The XMLHttpRequest response that returned an error.
///</param>
///<returns>Error</returns>
throw new Error("Error: " +
req.status + ": " +
req.message);
},
parameterCheck: function (parameter, functionName, parameterName, type) {
///<summary>
/// Private function used to check whether required parameters are null or undefined
///</summary>
///<param name="parameter" type="Object">
/// The parameter to check;
///</param>
///<param name="message" type="String">
/// The error message text to include when the error is thrown.
///</param>
if ((typeof parameter === "undefined") || parameter === null || parameter == "") {
throwParameterError(functionName, parameterName, type);
}
},
stringParameterCheck: function (parameter, functionName, parameterName) {
///<summary>
/// Private function used to check whether required parameters are null or undefined
///</summary>
///<param name="parameter" type="String">
/// The string parameter to check;
///</param>
///<param name="message" type="String">
/// The error message text to include when the error is thrown.
///</param>
if (typeof parameter != "string") {
throwParameterError(functionName, parameterName, "String");
}
},
arrayParameterCheck: function (parameter, functionName, parameterName) {
///<summary>
/// Private function used to check whether required parameters are null or undefined
///</summary>
///<param name="parameter" type="String">
/// The string parameter to check;
///</param>
///<param name="message" type="String">
/// The error message text to include when the error is thrown.
///</param>
if (parameter.constructor !== Array) {
throwParameterError(functionName, parameterName, "Array");
}
},
stringOrArrayParameterCheck: function(parameter, functionName, parameterName) {
if (parameter.constructor !== Array && typeof parameter != "string") {
throwParameterError(functionName, parameterName, "String or Array");
}
},
numberParameterCheck : function (parameter, functionName, parameterName) {
///<summary>
/// Private function used to check whether required parameters are null or undefined
///</summary>
///<param name="parameter" type="Number">
/// The string parameter to check;
///</param>
///<param name="message" type="String">
/// The error message text to include when the error is thrown.
///</param>
if (typeof parameter != "number") {
if (typeof parameter === "string" && parameter) {
if (!isNaN(parseInt(parameter))) {
return;
}
}
throwParameterError(functionName, parameterName, "Number");
}
},
boolParameterCheck: function (parameter, functionName, parameterName) {
///<summary>
/// Private function used to check whether required parameters are null or undefined
///</summary>
///<param name="parameter" type="Boolean">
/// The string parameter to check;
///</param>
///<param name="message" type="String">
/// The error message text to include when the error is thrown.
///</param>
if (typeof parameter != "boolean") {
throwParameterError(functionName, parameterName, "Boolean");
}
},
guidParameterCheck: function (parameter, functionName, parameterName) {
///<summary>
/// Private function used to check whether required parameter is a valid GUID
///</summary>
///<param name="parameter" type="String">
/// The GUID parameter to check;
///</param>
///<param name="message" type="String">
/// The error message text to include when the error is thrown.
///</param>
/// <returns type="String" />
try {
var match = /[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}/i.exec(parameter)[0];
return match;
}
catch (error) {
throwParameterError(functionName, parameterName, "GUID String");
}
},
callbackParameterCheck: function (callbackParameter, functionName, parameterName) {
///<summary>
/// Private function used to check whether required callback parameters are functions
///</summary>
///<param name="callbackParameter" type="Function">
/// The callback parameter to check;
///</param>
///<param name="message" type="String">
/// The error message text to include when the error is thrown.
///</param>
if (typeof callbackParameter != "function") {
throwParameterError(functionName, parameterName, "Function");
}
}
};
module.exports = ErrorHelper;
/***/ }),
/* 2 */
/***/ (function(module, exports) {
String.prototype.endsWith = function (searchString, position) {
var subjectString = this.toString();
if (typeof position !== 'number' || !isFinite(position) || Math.floor(position) !== position || position > subjectString.length) {
position = subjectString.length;
}
position -= searchString.length;
var lastIndex = subjectString.lastIndexOf(searchString, position);
return lastIndex !== -1 && lastIndex === position;
};
String.prototype.startsWith = function (searchString, position) {
position = position || 0;
return this.substr(position, searchString.length) === searchString;
};
/***/ }),
/* 3 */
/***/ (function(module, exports, __webpack_require__) {
var DWA = __webpack_require__(0);
//var RequestConverter = require('../utilities/RequestConverter');
//https://stackoverflow.com/a/8809472
function generateUUID() { // Public Domain/MIT
var d = new Date().getTime();
if (typeof performance !== 'undefined' && typeof performance.now === 'function') {
d += performance.now(); //use high-precision timer if available
}
return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
var r = (d + Math.random() * 16) % 16 | 0;
d = Math.floor(d / 16);
return (c === 'x' ? r : (r & 0x3 | 0x8)).toString(16);
});
}
function setStandardHeaders(additionalHeaders) {
additionalHeaders["Accept"] = "application/json";
additionalHeaders["OData-MaxVersion"] = "4.0";
additionalHeaders["OData-Version"] = "4.0";
additionalHeaders['Content-Type'] = 'application/json; charset=utf-8';
return additionalHeaders;
}
function stringifyData(data, config) {
var stringifiedData;
if (data) {
stringifiedData = JSON.stringify(data, function (key, value) {
/// <param name="key" type="String">Description</param>
if (key.endsWith("@odata.bind")) {
if (typeof value === "string") {
//remove brackets in guid
if (/\(\{[\w\d-]+\}\)/g.test(value)) {
value = value.replace(/(.+)\(\{([\w\d-]+)\}\)/g, '$1($2)');
}
//add full web api url if it's not set
if (!value.startsWith(config.webApiUrl)) {
value = config.webApiUrl + value.replace(/^\\/, '');
}
}
}
return value;
});
stringifiedData = stringifiedData.replace(/[\u007F-\uFFFF]/g, function (chr) {
return "\\u" + ("0000" + chr.charCodeAt(0).toString(16)).substr(-4)
});
}
return stringifiedData;
}
/**
* Sends a request to given URL with given parameters
*
* @param {string} method - Method of the request.
* @param {string} path - Request path.
* @param {Function} successCallback - A callback called on success of the request.
* @param {Function} errorCallback - A callback called when a request failed.
* @param {Object} config - DynamicsWebApi config.
* @param {Object} [data] - Data to send in the request.
* @param {Object} [additionalHeaders] - Object with additional headers. IMPORTANT! This object does not contain default headers needed for every request.
* @param {boolean} [isAsync] - Indicates whether the request should be made synchronously or asynchronously.
* @returns {Promise}
*/
module.exports = function sendRequest(method, path, config, data, additionalHeaders, successCallback, errorCallback, isAsync) {
if (!additionalHeaders) {
additionalHeaders = {};
}
additionalHeaders = setStandardHeaders(additionalHeaders);
//stringify passed data
var stringifiedData = stringifyData(data, config);
//if the URL contains more characters than max possible limit, convert the request to a batch request
if (path.length > 2000) {
var batchBoundary = 'dwa_batch_' + generateUUID();
var batchBody = [];
batchBody.push('--' + batchBoundary);
batchBody.push('Content-Type: application/http');
batchBody.push('Content-Transfer-Encoding: binary\n');
batchBody.push(method + ' ' + config.webApiUrl + path + ' HTTP/1.1');
for (var key in additionalHeaders) {
batchBody.push(key + ': ' + additionalHeaders[key]);
delete additionalHeaders[key];
}
batchBody.push('\n--' + batchBoundary + '--');
stringifiedData = batchBody.join('\n');
additionalHeaders = setStandardHeaders(additionalHeaders);
additionalHeaders['Content-Type'] = 'multipart/mixed;boundary=' + batchBoundary;
path = '$batch';
method = 'POST';
}
if (config.impersonate && !additionalHeaders['MSCRMCallerID']) {
additionalHeaders['MSCRMCallerID'] = config.impersonate;
}
var executeRequest;
if (typeof XMLHttpRequest !== 'undefined') {
executeRequest = __webpack_require__(10);
}
var sendInternalRequest = function (token) {
if (token) {
if (!additionalHeaders) {
additionalHeaders = {};
}
additionalHeaders['Authorization'] = 'Bearer ' + token.accessToken;
}
executeRequest(method, config.webApiUrl + path, stringifiedData, additionalHeaders, successCallback, errorCallback, isAsync);
};
//call a token refresh callback only if it is set and there is no "Authorization" header set yet
if (config.onTokenRefresh && (!additionalHeaders || (additionalHeaders && !additionalHeaders['Authorization']))) {
config.onTokenRefresh(sendInternalRequest);
}
else {
sendInternalRequest();
}
};
/***/ }),
/* 4 */
/***/ (function(module, exports, __webpack_require__) {
var DWA = __webpack_require__(0);
var ErrorHelper = __webpack_require__(1);
var buildPreferHeader = __webpack_require__(12);
/**
* @typedef {Object} ConvertedRequestOptions
* @property {string} url URL (without query)
* @property {string} query Query String
* @property {Object} headers Heades object (always an Object; can be empty: {})
*/
/**
* @typedef {Object} ConvertedRequest
* @property {string} url URL (including Query String)
* @property {Object} headers Heades object (always an Object; can be empty: {})
*/
/**
* Converts optional parameters of the request to URL. If expand parameter exists this function is called recursively.
*
* @param {Object} request - Request object
* @param {string} functionName - Name of the function that converts a request (for Error Handling)
* @param {string} url - URL beginning (with required parameters)
* @param {string} [joinSymbol] - URL beginning (with required parameters)
* @param {Object} [config] - DynamicsWebApi config
* @returns {ConvertedRequestOptions}
*/
function convertRequestOptions(request, functionName, url, joinSymbol, config) {
var headers = {};
var requestArray = [];
joinSymbol = joinSymbol != null ? joinSymbol : "&";
if (request) {
if (request.navigationProperty) {
ErrorHelper.stringParameterCheck(request.navigationProperty, "DynamicsWebApi." + functionName, "request.navigationProperty");
url += "/" + request.navigationProperty;
}
if (request.select != null && request.select.length) {
ErrorHelper.arrayParameterCheck(request.select, "DynamicsWebApi." + functionName, "request.select");
if (functionName == "retrieve" && request.select.length == 1 && request.select[0].endsWith("/$ref")) {
url += "/" + request.select[0];
}
else {
if (request.select[0].startsWith("/") && functionName == "retrieve") {
if (request.navigationProperty == null) {
url += request.select.shift();
}
else {
request.select.shift();
}
}
//check if anything left in the array
if (request.select.length) {
requestArray.push("$select=" + request.select.join(','));
}
}
}
if (request.filter) {
ErrorHelper.stringParameterCheck(request.filter, "DynamicsWebApi." + functionName, "request.filter");
requestArray.push("$filter=" + request.filter);
}
if (request.savedQuery) {
requestArray.push("savedQuery=" + ErrorHelper.guidParameterCheck(request.savedQuery, "DynamicsWebApi." + functionName, "request.savedQuery"));
}
if (request.userQuery) {
requestArray.push("userQuery=" + ErrorHelper.guidParameterCheck(request.userQuery, "DynamicsWebApi." + functionName, "request.userQuery"));
}
if (request.count) {
ErrorHelper.boolParameterCheck(request.count, "DynamicsWebApi." + functionName, "request.count");
requestArray.push("$count=" + request.count);
}
if (request.top && request.top > 0) {
ErrorHelper.numberParameterCheck(request.top, "DynamicsWebApi." + functionName, "request.top");
requestArray.push("$top=" + request.top);
}
if (request.orderBy != null && request.orderBy.length) {
ErrorHelper.arrayParameterCheck(request.orderBy, "DynamicsWebApi." + functionName, "request.orderBy");
requestArray.push("$orderby=" + request.orderBy.join(','));
}
var prefer = buildPreferHeader(request, functionName, config);
if (prefer.length) {
headers['Prefer'] = prefer;
}
if (request.ifmatch != null && request.ifnonematch != null) {
throw new Error("DynamicsWebApi." + functionName + ". Either one of request.ifmatch or request.ifnonematch parameters should be used in a call, not both.")
}
if (request.ifmatch) {
ErrorHelper.stringParameterCheck(request.ifmatch, "DynamicsWebApi." + functionName, "request.ifmatch");
headers['If-Match'] = request.ifmatch;
}
if (request.ifnonematch) {
ErrorHelper.stringParameterCheck(request.ifnonematch, "DynamicsWebApi." + functionName, "request.ifnonematch");
headers['If-None-Match'] = request.ifnonematch;
}
if (request.impersonate) {
ErrorHelper.stringParameterCheck(request.impersonate, "DynamicsWebApi." + functionName, "request.impersonate");
headers['MSCRMCallerID'] = ErrorHelper.guidParameterCheck(request.impersonate, "DynamicsWebApi." + functionName, "request.impersonate");
}
if (request.token) {
ErrorHelper.stringParameterCheck(request.token, "DynamicsWebApi." + functionName, "request.token");
headers["Authorization"] = "Bearer " + request.token;
}
if (request.expand && request.expand.length) {
ErrorHelper.stringOrArrayParameterCheck(request.expand, "DynamicsWebApi." + functionName, "request.expand");
if (typeof request.expand === "string") {
requestArray.push("$expand=" + request.expand);
}
else {
var expandRequestArray = [];
for (var i = 0; i < request.expand.length; i++) {
if (request.expand[i].property) {
var expandConverted = convertRequestOptions(request.expand[i], functionName + " $expand", null, ";");
var expandQuery = expandConverted.query;
if (expandQuery && expandQuery.length) {
expandQuery = "(" + expandQuery + ")";
}
expandRequestArray.push(request.expand[i].property + expandQuery);
}
}
if (expandRequestArray.length) {
requestArray.push("$expand=" + expandRequestArray.join(","));
}
}
}
}
return { url: url, query: requestArray.join(joinSymbol), headers: headers };
}
/**
* @param {string} collectionName - name of the collection to check
*/
function getCollectionName(collectionName) {
var exceptions = ['EntityDefinitions'];
return exceptions.indexOf(collectionName) > -1
? collectionName
: collectionName.toLowerCase();
}
/**
* Converts a request object to URL link
*
* @param {Object} request - Request object
* @param {string} [functionName] - Name of the function that converts a request (for Error Handling only)
* @param {Object} [config] - DynamicsWebApi config
* @returns {ConvertedRequest}
*/
function convertRequest(request, functionName, config) {
if (!request.collection) {
ErrorHelper.parameterCheck(request.collection, "DynamicsWebApi." + functionName, "request.collection");
}
else {
ErrorHelper.stringParameterCheck(request.collection, "DynamicsWebApi." + functionName, "request.collection");
}
var url = getCollectionName(request.collection);
if (request.id) {
request.id = ErrorHelper.guidParameterCheck(request.id, "DynamicsWebApi." + functionName, "request.id");
url += "(" + request.id + ")";
}
var result = convertRequestOptions(request, functionName, url, '&', config);
if (result.query) {
result.url += "?" + encodeURI(result.query);
}
if (request.hasOwnProperty('async') && request.async != null) {
ErrorHelper.boolParameterCheck(request.async, "DynamicsWebApi." + functionName, "request.async");
result.async = request.async;
}
else {
result.async = true;
}
return { url: result.url, headers: result.headers, async: result.async };
};
var RequestConverter = {
convertRequestOptions: convertRequestOptions,
convertRequest: convertRequest
};
module.exports = RequestConverter;
/***/ }),
/* 5 */
/***/ (function(module, exports, __webpack_require__) {
var Utility = {
/**
* Builds parametes for a funciton. Returns '()' (if no parameters) or '([params])?[query]'
*
* @param {Object} [parameters] - Function's input parameters. Example: { param1: "test", param2: 3 }.
* @returns {string}
*/
buildFunctionParameters: __webpack_require__(11),
/**
* Parses a paging cookie returned in response
*
* @param {string} pageCookies - Page cookies returned in @Microsoft.Dynamics.CRM.fetchxmlpagingcookie.
* @param {number} currentPageNumber - A current page number. Fix empty paging-cookie for complex fetch xmls.
* @returns {{cookie: "", number: 0, next: 1}}
*/
getFetchXmlPagingCookie: __webpack_require__(14),
/**
* Converts a response to a reference object
*
* @param {Object} responseData - Response object
* @returns {ReferenceObject}
*/
convertToReferenceObject: __webpack_require__(13)
}
module.exports = Utility;
/***/ }),
/* 6 */
/***/ (function(module, exports, __webpack_require__) {
var DWA = __webpack_require__(0);
var Utility = __webpack_require__(5);
var RequestConverter = __webpack_require__(4);
var ErrorHelper = __webpack_require__(1);
var sendRequest = __webpack_require__(3);
//string es6 polyfill
if (!String.prototype.endsWith || !String.prototype.startsWith) {
__webpack_require__(2);
}
/**
* Configuration object for DynamicsWebApi
* @typedef {object} DWAConfig
* @property {string} webApiUrl - A String representing a URL to Web API (webApiVersion not required if webApiUrl specified) [not used inside of CRM]
* @property {string} webApiVersion - The version of Web API to use, for example: "8.1"
* @property {string} impersonate - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
* @property {Function} onTokenRefresh - A function that is called when a security token needs to be refreshed.
* @property {string} includeAnnotations - Sets Prefer header with value "odata.include-annotations=" and the specified annotation. Annotations provide additional information about lookups, options sets and other complex attribute types.
* @property {string} maxPageSize - Sets the odata.maxpagesize preference value to request the number of entities returned in the response.
* @property {string} returnRepresentation - Sets Prefer header request with value "return=representation". Use this property to return just created or updated entity in a single request.
*/
/**
* Dynamics Web Api Request
* @typedef {Object} DWARequest
* @property {string} collection
* @property {string} id
* @property {Array} select
* @property {Array} expand
* @property {string} filter
* @property {number} maxPageSize
* @property {boolean} count
* @property {number} top
* @property {Array} orderBy
* @property {string} includeAnnotations
* @property {string} ifmatch
* @property {string} ifnonematch
* @property {boolean} returnRepresentation
* @property {Object} entity
* @property {string} impersonate: "",
* @property {string} navigationProperty: "",
* @property {string} savedQuery: "",
* @property {string} userQuery: ""
*/
/**
* DynamicsWebApi - a Microsoft Dynamics CRM Web API helper library. Current version uses Promises instead of Callbacks.
*
* @param {DWAConfig} [config] - configuration object
*/
function DynamicsWebApi(config) {
var _internalConfig = {
webApiVersion: "8.0",
webApiUrl: null,
impersonate: null,
onTokenRefresh: null,
includeAnnotations: null,
maxPageSize: null,
returnRepresentation: null
};
if (!config) {
config = _internalConfig;
}
var _context = function () {
if (typeof GetGlobalContext != "undefined") {
return GetGlobalContext();
}
else {
if (typeof Xrm != "undefined") {
return Xrm.Page.context;
}
else {
throw new Error("Xrm Context is not available.");
}
}
};
var _getClientUrl = function () {
var context = _context();
if (context) {
var clientUrl = context.getClientUrl();
if (clientUrl.match(/\/$/)) {
clientUrl = clientUrl.substring(0, clientUrl.length - 1);
}
return clientUrl;
}
return "";
};
var _initUrl = function () {
return _getClientUrl() + "/api/data/v" + _internalConfig.webApiVersion + "/";
};
/**
* Sets the configuration parameters for DynamicsWebApi helper.
*
* @param {DWAConfig} config - configuration object
*/
this.setConfig = function (config) {
if (config.webApiVersion) {
ErrorHelper.stringParameterCheck(config.webApiVersion, "DynamicsWebApi.setConfig", "config.webApiVersion");
_internalConfig.webApiVersion = config.webApiVersion;
}
if (config.webApiUrl) {
ErrorHelper.stringParameterCheck(config.webApiUrl, "DynamicsWebApi.setConfig", "config.webApiUrl");
_internalConfig.webApiUrl = config.webApiUrl;
} else {
_internalConfig.webApiUrl = _initUrl();
}
if (config.impersonate) {
_internalConfig.impersonate = ErrorHelper.guidParameterCheck(config.impersonate, "DynamicsWebApi.setConfig", "config.impersonate");
}
if (config.onTokenRefresh) {
ErrorHelper.callbackParameterCheck(config.onTokenRefresh, "DynamicsWebApi.setConfig", "config.onTokenRefresh");
_internalConfig.onTokenRefresh = config.onTokenRefresh;
}
if (config.includeAnnotations) {
ErrorHelper.stringParameterCheck(config.includeAnnotations, "DynamicsWebApi.setConfig", "config.includeAnnotations");
_internalConfig.includeAnnotations = config.includeAnnotations;
}
if (config.maxPageSize) {
ErrorHelper.numberParameterCheck(config.maxPageSize, "DynamicsWebApi.setConfig", "config.maxPageSize");
_internalConfig.maxPageSize = config.maxPageSize;
}
if (config.returnRepresentation) {
ErrorHelper.boolParameterCheck(config.returnRepresentation, "DynamicsWebApi.setConfig", "config.returnRepresentation");
_internalConfig.returnRepresentation = config.returnRepresentation;
}
};
this.setConfig(config);
/**
* Sends a request to given URL with given parameters
*
* @param {string} method - Method of the request.
* @param {string} uri - Request URI.
* @param {Object} [data] - Data to send in the request.
* @param {Object} [additionalHeaders] - Object with additional headers. IMPORTANT! This object does not contain default headers needed for every request.
* @param {boolean} [isAsync] - Indicates whether the request should be made synchronously or asynchronously.
* @returns {Promise}
*/
var _sendRequest = function (method, uri, data, additionalHeaders, isAsync) {
return new Promise(function (resolve, reject) {
sendRequest(method, uri, _internalConfig, data, additionalHeaders, resolve, reject, isAsync);
});
};
/**
* Sends an asynchronous request to create a new record.
*
* @param {Object} object - A JavaScript object valid for create operations.
* @param {string} collection - The Name of the Entity Collection.
* @param {string|Array} [prefer] - Sets a Prefer header value. For example: ['retrun=representation', 'odata.include-annotations="*"']
* @param {Array} [select] - An Array representing the $select Query Option to control which attributes will be returned.
* @returns {Promise}
*/
this.create = function (object, collection, prefer, select) {
ErrorHelper.parameterCheck(object, "DynamicsWebApi.create", "object");
ErrorHelper.stringParameterCheck(collection, "DynamicsWebApi.create", "collection");
if (prefer) {
ErrorHelper.stringOrArrayParameterCheck(prefer, "DynamicsWebApi.create", "prefer");
}
if (select) {
ErrorHelper.arrayParameterCheck(select, "DynamicsWebApi.create", "select");
}
var request = {
collection: collection,
select: select,
prefer: prefer
};
var result = RequestConverter.convertRequest(request, "create", _internalConfig);
return _sendRequest("POST", result.url, object, result.headers, result.async)
.then(function (response) {
if (response.data) {
return response.data;
}
var entityUrl = response.headers['OData-EntityId']
? response.headers['OData-EntityId']
: response.headers['odata-entityid'];
var id = /[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}/i.exec(entityUrl)[0];
return id;
});
};
/**
* Sends an asynchronous request to retrieve a record.
*
* @param {Object} request - An object that represents all possible options for a current request.
* @returns {Promise}
*/
this.retrieveRequest = function (request) {
ErrorHelper.parameterCheck(request, "DynamicsWebApi.retrieve", "request");
var result = RequestConverter.convertRequest(request, "retrieve", _internalConfig);
//copy locally
var select = request.select;
return _sendRequest("GET", result.url, null, result.headers, result.async).then(function (response) {
if (select != null && select.length == 1 && select[0].endsWith("/$ref") && response.data["@odata.id"] != null) {
return Utility.convertToReferenceObject(response.data);
}
return response.data;
});
};
/**
* Sends an asynchronous request to retrieve a record.
*
* @param {string} id - A String representing the GUID value for the record to retrieve.
* @param {string} collection - The Name of the Entity Collection.
* @param {Array} [select] - An Array representing the $select Query Option to control which attributes will be returned.
* @param {string|Array} [expand] - A String or Array of Expand Objects representing the $expand Query Option value to control which related records need to be returned.
* @returns {Promise}
*/
this.retrieve = function (id, collection, select, expand) {
ErrorHelper.stringParameterCheck(id, "DynamicsWebApi.retrieve", "id");
id = ErrorHelper.guidParameterCheck(id, "DynamicsWebApi.retrieve", "id")
ErrorHelper.stringParameterCheck(collection, "DynamicsWebApi.retrieve", "collection");
if (select && select.length) {
ErrorHelper.arrayParameterCheck(select, "DynamicsWebApi.retrieve", "select");
}
if (expand && expand.length) {
ErrorHelper.stringOrArrayParameterCheck(expand, "DynamicsWebApi.retrieve", "expand");
}
var request = {
collection: collection,
id: id,
select: select,
expand: expand
};
return this.retrieveRequest(request);
};
/**
* Sends an asynchronous request to update a record.
*
* @param {Object} request - An object that represents all possible options for a current request.
* @returns {Promise}
*/
this.updateRequest = function (request) {
ErrorHelper.parameterCheck(request, "DynamicsWebApi.update", "request");
ErrorHelper.parameterCheck(request.entity, "DynamicsWebApi.update", "request.entity");
if (request.ifmatch == null) {
request.ifmatch = '*'; //to prevent upsert
}
var result = RequestConverter.convertRequest(request, "update", _internalConfig);
//copy locally
var ifmatch = request.ifmatch;
return _sendRequest("PATCH", result.url, request.entity, result.headers, result.async)
.then(function (response) {
if (response.data) {
return response.data;
}
return true; //updated
}).catch(function (error) {
if (ifmatch && error.status == 412) {
//precondition failed - not updated
return false;
}
//rethrow error otherwise
throw error;
});
};