fixes: on-premise service url issue; incomplete type definitions for typescript, inconsistent removing curly brackets for odata.bind actions.

AleksandrRogov · AleksandrRogov · commit 6f8f5689aee1 · 2019-07-05T15:09:19.000-04:00
diff --git a/README.md b/README.md
@@ -235,7 +235,7 @@ contentId | String | `createRequest`, `updateRequest`, `upsertRequest`, `deleteR
 count | Boolean | `retrieveMultipleRequest`, `retrieveAllRequest` | Boolean that sets the $count system query option with a value of true to include a count of entities that match the filter criteria up to 5000 (per page). Do not use $top with $count!
 duplicateDetection | Boolean | `createRequest`, `updateRequest`, `upsertRequest` | `v.1.3.4+` **Web API v9+ only!** Boolean that enables duplicate detection. [More Info](https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/webapi/update-delete-entities-using-web-api#check-for-duplicate-records)
 entity | Object | `createRequest`, `updateRequest`, `upsertRequest` | A JavaScript object with properties corresponding to the logical name of entity attributes (exceptions are lookups and single-valued navigation properties).
-expand | Array | `retrieveRequest`, `createRequest`, `updateRequest`, `upsertRequest` | An array of Expand Objects (described below the table) representing the $expand OData System Query Option value to control which related records are also returned.
+expand | Array | `retrieveRequest`, `retrieveMultipleRequest`, `createRequest`, `updateRequest`, `upsertRequest` | An array of Expand Objects (described below the table) representing the $expand OData System Query Option value to control which related records are also returned.
 filter | String | `retrieveRequest`, `retrieveMultipleRequest`, `retrieveAllRequest` | Use the $filter system query option to set criteria for which entities will be returned.
 id | String | `retrieveRequest`, `createRequest`, `updateRequest`, `upsertRequest`, `deleteRequest` | `deprecated in v.1.3.4` Use `key` field, instead of `id`. A String representing the Primary Key (GUID) of the record. 
 ifmatch | String | `retrieveRequest`, `updateRequest`, `upsertRequest`, `deleteRequest` | Sets If-Match header value that enables to use conditional retrieval or optimistic concurrency in applicable requests. [More Info](https://msdn.microsoft.com/en-us/library/mt607711.aspx)
@@ -268,9 +268,9 @@ property | String | A name of a single-valued navigation property which needs to
 select | Array | An Array (of Strings) representing the $select OData System Query Option to control which attributes will be returned.
 top | Number | Limit the number of results returned by using the $top system query option.
 
-According to CRM developers ([here](http://stackoverflow.com/a/34742977/2042071) and [here](https://community.dynamics.com/crm/b/joegilldynamicscrm/archive/2016/03/23/web-api-querying-with-expand) 
-$expand does not work for retrieveMultiple requests which is claimed as a bug of CRM Web API.
-As well as multi-level expands are not implemented yet. This situation may be changed with the future updates in the platform. Please look for the news!
+The following seems to be fixed: ~~According to CRM developers ([here](http://stackoverflow.com/a/34742977/2042071) and [here](https://community.dynamics.com/crm/b/joegilldynamicscrm/archive/2016/03/23/web-api-querying-with-expand) 
+$expand does not work for retrieveMultiple requests which is claimed as a bug of CRM Web API.~~
+Unconfirmed: Multi-level expands are not implemented yet. This situation may be changed with the future updates in the platform. Please look for the news!
 
 For complex requests to Web API with multi-level expands use `executeFetchXml` function.
 
diff --git a/dist/dynamics-web-api-callbacks.js b/dist/dynamics-web-api-callbacks.js
@@ -829,9 +829,16 @@ function stringifyData(data, config) {
                         }
                     }
 
-                    //add full web api url if it's not set
                     if (!value.startsWith(config.webApiUrl)) {
-                        value = config.webApiUrl + value.replace(/^\\/, '');
+                        //add full web api url if it's not set
+                        if (key.endsWith('@odata.bind')) {
+                            if (!value.startsWith('/')) {
+                                value = '/' + value;
+                            }
+                        }
+                        else {
+                            value = config.webApiUrl + value.replace(/^\//, '');
+                        }
                     }
                 }
             }
@@ -847,7 +854,7 @@ function stringifyData(data, config) {
         });
 
         stringifiedData = stringifiedData.replace(/[\u007F-\uFFFF]/g, function (chr) {
-            return "\\u" + ("0000" + chr.charCodeAt(0).toString(16)).substr(-4)
+            return "\\u" + ("0000" + chr.charCodeAt(0).toString(16)).substr(-4);
         });
     }
 
@@ -2126,7 +2133,7 @@ function DynamicsWebApi(config) {
     /**
      * Executes a bound Web API action (bound to a particular entity record)
      *
-     * @param {string} id - A String representing the GUID value for the record.
+     * @param {string} [id] - A String representing the GUID value for the record.
      * @param {string} collection - The name of the Entity Collection or Entity Logical name.
      * @param {string} actionName - The name of the Web API action.
      * @param {Object} [requestObject] - Action request body object.
diff --git a/dist/dynamics-web-api-callbacks.min.js b/dist/dynamics-web-api-callbacks.min.js
diff --git a/dist/dynamics-web-api.js b/dist/dynamics-web-api.js
@@ -539,9 +539,16 @@ function stringifyData(data, config) {
                         }
                     }
 
-                    //add full web api url if it's not set
                     if (!value.startsWith(config.webApiUrl)) {
-                        value = config.webApiUrl + value.replace(/^\\/, '');
+                        //add full web api url if it's not set
+                        if (key.endsWith('@odata.bind')) {
+                            if (!value.startsWith('/')) {
+                                value = '/' + value;
+                            }
+                        }
+                        else {
+                            value = config.webApiUrl + value.replace(/^\//, '');
+                        }
                     }
                 }
             }
@@ -557,7 +564,7 @@ function stringifyData(data, config) {
         });
 
         stringifiedData = stringifiedData.replace(/[\u007F-\uFFFF]/g, function (chr) {
-            return "\\u" + ("0000" + chr.charCodeAt(0).toString(16)).substr(-4)
+            return "\\u" + ("0000" + chr.charCodeAt(0).toString(16)).substr(-4);
         });
     }
 
@@ -1643,7 +1650,7 @@ function DynamicsWebApi(config) {
     /**
      * Executes a bound function
      *
-     * @param {string} id - A String representing the GUID value for the record.
+     * @param {string} [id] - A String representing the GUID value for the record.
      * @param {string} collection - The name of the Entity Collection or Entity Logical name.
      * @param {string} functionName - The name of the function.
      * @param {Object} [parameters] - Function's input parameters. Example: { param1: "test", param2: 3 }.
diff --git a/dist/dynamics-web-api.min.js b/dist/dynamics-web-api.min.js
diff --git a/lib/dynamics-web-api-callbacks.js b/lib/dynamics-web-api-callbacks.js
@@ -1095,7 +1095,7 @@ function DynamicsWebApi(config) {
     /**
      * Executes a bound Web API action (bound to a particular entity record)
      *
-     * @param {string} id - A String representing the GUID value for the record.
+     * @param {string} [id] - A String representing the GUID value for the record.
      * @param {string} collection - The name of the Entity Collection or Entity Logical name.
      * @param {string} actionName - The name of the Web API action.
      * @param {Object} [requestObject] - Action request body object.
diff --git a/lib/dynamics-web-api.js b/lib/dynamics-web-api.js
@@ -903,7 +903,7 @@ function DynamicsWebApi(config) {
     /**
      * Executes a bound function
      *
-     * @param {string} id - A String representing the GUID value for the record.
+     * @param {string} [id] - A String representing the GUID value for the record.
      * @param {string} collection - The name of the Entity Collection or Entity Logical name.
      * @param {string} functionName - The name of the function.
      * @param {Object} [parameters] - Function's input parameters. Example: { param1: "test", param2: 3 }.
diff --git a/lib/requests/sendRequest.js b/lib/requests/sendRequest.js
@@ -67,9 +67,16 @@ function stringifyData(data, config) {
                         }
                     }
 
-                    //add full web api url if it's not set
                     if (!value.startsWith(config.webApiUrl)) {
-                        value = config.webApiUrl + value.replace(/^\\/, '');
+                        //add full web api url if it's not set
+                        if (key.endsWith('@odata.bind')) {
+                            if (!value.startsWith('/')) {
+                                value = '/' + value;
+                            }
+                        }
+                        else {
+                            value = config.webApiUrl + value.replace(/^\//, '');
+                        }
                     }
                 }
             }
@@ -85,7 +92,7 @@ function stringifyData(data, config) {
         });
 
         stringifiedData = stringifiedData.replace(/[\u007F-\uFFFF]/g, function (chr) {
-            return "\\u" + ("0000" + chr.charCodeAt(0).toString(16)).substr(-4)
+            return "\\u" + ("0000" + chr.charCodeAt(0).toString(16)).substr(-4);
         });
     }
 
diff --git a/tests/main-tests.js b/tests/main-tests.js
@@ -1149,7 +1149,7 @@ describe("promises -", function () {
                     .post("/tests_records/$ref", {
                         "@odata.id": mocks.webApiUrl + "records(" + mocks.data.testEntityId2 + ")"
                     })
-                    .reply(response.status, response.responseText, response.responseHeaders)
+                    .reply(response.status, response.responseText, response.responseHeaders);
             });
 
             after(function () {
@@ -1604,7 +1604,7 @@ describe("promises -", function () {
                 var response = mocks.responses.basicEmptyResponseSuccess;
                 scope = nock(mocks.webApiUrl)
                     .post("/FUN", mocks.responses.actionRequestModified)
-                    .reply(response.status, response.responseText, response.responseHeaders)
+                    .reply(response.status, response.responseText, response.responseHeaders);
             });
 
             after(function () {
diff --git a/tests/stubs.js b/tests/stubs.js
@@ -819,7 +819,7 @@ var responseStubs = {
         Status: 3,
         OpportunityClose: {
             subject: "Won Opportunity",
-            "testid@odata.bind": webApiUrl + "tests(" + dataStubs.testEntityId + ")"
+            "testid@odata.bind": "/tests(" + dataStubs.testEntityId + ")"
         }
     },
     upsertPreventCreateResponse: {
diff --git a/types/dynamics-web-api-callbacks.d.ts b/types/dynamics-web-api-callbacks.d.ts
@@ -349,7 +349,7 @@ declare class DynamicsWebApi {
      * @param errorCallback - The function that will be passed through and be called by a failed response.
      * @param impersonateUserId - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
      */
-    executeBoundAction(id: string, collection: string, actionName: string, requestObject: Object, successCallback: Function, errorCallback: Function, impersonateUserId?: string): void;
+    executeBoundAction(id?: string, collection: string, actionName: string, requestObject: Object, successCallback: Function, errorCallback: Function, impersonateUserId?: string): void;
     /**
      * Sends an asynchronous request to create an entity definition.
      *
@@ -661,6 +661,8 @@ declare namespace DynamicsWebApi {
     }
 
     interface RetrieveMultipleRequest extends Request {
+        /**An array of Expand Objects(described below the table) representing the $expand OData System Query Option value to control which related records are also returned. */
+        expand?: Expand[];
         /**Boolean that sets the $count system query option with a value of true to include a count of entities that match the filter criteria up to 5000(per page).Do not use $top with $count! */
         count?: boolean;
         /**Use the $filter system query option to set criteria for which entities will be returned. */
diff --git a/types/dynamics-web-api.d.ts b/types/dynamics-web-api.d.ts
@@ -291,7 +291,7 @@ declare class DynamicsWebApi {
      * @param requestObject - Action request body object.
      * @param impersonateUserId - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
      */
-    executeBoundAction(id: string, collection: string, actionName: string, requestObject?: Object, impersonateUserId?: string): Promise<any>;
+    executeBoundAction(id?: string, collection: string, actionName: string, requestObject?: Object, impersonateUserId?: string): Promise<any>;
     /**
      * Sends an asynchronous request to create an entity definition.
      *
@@ -481,7 +481,7 @@ declare namespace DynamicsWebApi {
     interface CreateRequest extends CRUDRequest {
         /**v.1.3.4+ Web API v9+ only! Boolean that enables duplicate detection. */
         duplicateDetection?: boolean;
-        /**A JavaScript object with properties corresponding to the logical name of entity attributes(exceptions are lookups and single - valued navigation properties). */
+        /**A JavaScript object with properties corresponding to the logical name of entity attributes(exceptions are lookups and single-valued navigation properties). */
         entity?: any;
         /**An array of Expand Objects(described below the table) representing the $expand OData System Query Option value to control which related records are also returned. */
         expand?: Expand[];
@@ -500,7 +500,7 @@ declare namespace DynamicsWebApi {
     interface UpdateRequestBase extends CRUDRequest {
         /**v.1.3.4+ Web API v9+ only! Boolean that enables duplicate detection. */
         duplicateDetection?: boolean;
-        /**A JavaScript object with properties corresponding to the logical name of entity attributes(exceptions are lookups and single - valued navigation properties). */
+        /**A JavaScript object with properties corresponding to the logical name of entity attributes(exceptions are lookups and single-valued navigation properties). */
         entity?: any;
         /**An array of Expand Objects(described below the table) representing the $expand OData System Query Option value to control which related records are also returned. */
         expand?: Expand[];
@@ -565,6 +565,8 @@ declare namespace DynamicsWebApi {
     }
 
     interface RetrieveMultipleRequest extends Request {
+        /**An array of Expand Objects(described below the table) representing the $expand OData System Query Option value to control which related records are also returned. */
+        expand?: Expand[];
         /**Boolean that sets the $count system query option with a value of true to include a count of entities that match the filter criteria up to 5000(per page).Do not use $top with $count! */
         count?: boolean;
         /**Use the $filter system query option to set criteria for which entities will be returned. */

Original file line number	Diff line number	Diff line change
`@@ -829,9 +829,16 @@ function stringifyData(data, config) {`
`829`	`829`	`}`
`830`	`830`	`}`
`831`	`831`
`832`		`- //add full web api url if it's not set`
`833`	`832`	`if (!value.startsWith(config.webApiUrl)) {`
`834`		`- value = config.webApiUrl + value.replace(/^\\/, '');`
	`833`	`+ //add full web api url if it's not set`
	`834`	`+ if (key.endsWith('@odata.bind')) {`
	`835`	`+ if (!value.startsWith('/')) {`
	`836`	`+ value = '/' + value;`
	`837`	`+ }`
	`838`	`+ }`
	`839`	`+ else {`
	`840`	`+ value = config.webApiUrl + value.replace(/^\//, '');`
	`841`	`+ }`
`835`	`842`	`}`
`836`	`843`	`}`
`837`	`844`	`}`
`@@ -847,7 +854,7 @@ function stringifyData(data, config) {`
`847`	`854`	`});`
`848`	`855`
`849`	`856`	`stringifiedData = stringifiedData.replace(/[\u007F-\uFFFF]/g, function (chr) {`
`850`		`- return "\\u" + ("0000" + chr.charCodeAt(0).toString(16)).substr(-4)`
	`857`	`+ return "\\u" + ("0000" + chr.charCodeAt(0).toString(16)).substr(-4);`
`851`	`858`	`});`
`852`	`859`	`}`
`853`	`860`
`@@ -2126,7 +2133,7 @@ function DynamicsWebApi(config) {`
`2126`	`2133`	`/**`
`2127`	`2134`	`* Executes a bound Web API action (bound to a particular entity record)`
`2128`	`2135`	`*`
`2129`		`- * @param {string} id - A String representing the GUID value for the record.`
	`2136`	`+ * @param {string} [id] - A String representing the GUID value for the record.`
`2130`	`2137`	`* @param {string} collection - The name of the Entity Collection or Entity Logical name.`
`2131`	`2138`	`* @param {string} actionName - The name of the Web API action.`
`2132`	`2139`	`* @param {Object} [requestObject] - Action request body object.`
Original file line number	Diff line number	Diff line change
`@@ -539,9 +539,16 @@ function stringifyData(data, config) {`
`539`	`539`	`}`
`540`	`540`	`}`
`541`	`541`
`542`		`- //add full web api url if it's not set`
`543`	`542`	`if (!value.startsWith(config.webApiUrl)) {`
`544`		`- value = config.webApiUrl + value.replace(/^\\/, '');`
	`543`	`+ //add full web api url if it's not set`
	`544`	`+ if (key.endsWith('@odata.bind')) {`
	`545`	`+ if (!value.startsWith('/')) {`
	`546`	`+ value = '/' + value;`
	`547`	`+ }`
	`548`	`+ }`
	`549`	`+ else {`
	`550`	`+ value = config.webApiUrl + value.replace(/^\//, '');`
	`551`	`+ }`
`545`	`552`	`}`
`546`	`553`	`}`
`547`	`554`	`}`
`@@ -557,7 +564,7 @@ function stringifyData(data, config) {`
`557`	`564`	`});`
`558`	`565`
`559`	`566`	`stringifiedData = stringifiedData.replace(/[\u007F-\uFFFF]/g, function (chr) {`
`560`		`- return "\\u" + ("0000" + chr.charCodeAt(0).toString(16)).substr(-4)`
	`567`	`+ return "\\u" + ("0000" + chr.charCodeAt(0).toString(16)).substr(-4);`
`561`	`568`	`});`
`562`	`569`	`}`
`563`	`570`
`@@ -1643,7 +1650,7 @@ function DynamicsWebApi(config) {`
`1643`	`1650`	`/**`
`1644`	`1651`	`* Executes a bound function`
`1645`	`1652`	`*`
`1646`		`- * @param {string} id - A String representing the GUID value for the record.`
	`1653`	`+ * @param {string} [id] - A String representing the GUID value for the record.`
`1647`	`1654`	`* @param {string} collection - The name of the Entity Collection or Entity Logical name.`
`1648`	`1655`	`* @param {string} functionName - The name of the function.`
`1649`	`1656`	`* @param {Object} [parameters] - Function's input parameters. Example: { param1: "test", param2: 3 }.`
Original file line number	Diff line number	Diff line change
`@@ -1095,7 +1095,7 @@ function DynamicsWebApi(config) {`
`1095`	`1095`	`/**`
`1096`	`1096`	`* Executes a bound Web API action (bound to a particular entity record)`
`1097`	`1097`	`*`
`1098`		`- * @param {string} id - A String representing the GUID value for the record.`
	`1098`	`+ * @param {string} [id] - A String representing the GUID value for the record.`
`1099`	`1099`	`* @param {string} collection - The name of the Entity Collection or Entity Logical name.`
`1100`	`1100`	`* @param {string} actionName - The name of the Web API action.`
`1101`	`1101`	`* @param {Object} [requestObject] - Action request body object.`
Original file line number	Diff line number	Diff line change
`@@ -903,7 +903,7 @@ function DynamicsWebApi(config) {`
`903`	`903`	`/**`
`904`	`904`	`* Executes a bound function`
`905`	`905`	`*`
`906`		`- * @param {string} id - A String representing the GUID value for the record.`
	`906`	`+ * @param {string} [id] - A String representing the GUID value for the record.`
`907`	`907`	`* @param {string} collection - The name of the Entity Collection or Entity Logical name.`
`908`	`908`	`* @param {string} functionName - The name of the function.`
`909`	`909`	`* @param {Object} [parameters] - Function's input parameters. Example: { param1: "test", param2: 3 }.`
Original file line number	Diff line number	Diff line change
`@@ -67,9 +67,16 @@ function stringifyData(data, config) {`
`67`	`67`	`}`
`68`	`68`	`}`
`69`	`69`
`70`		`- //add full web api url if it's not set`
`71`	`70`	`if (!value.startsWith(config.webApiUrl)) {`
`72`		`- value = config.webApiUrl + value.replace(/^\\/, '');`
	`71`	`+ //add full web api url if it's not set`
	`72`	`+ if (key.endsWith('@odata.bind')) {`
	`73`	`+ if (!value.startsWith('/')) {`
	`74`	`+ value = '/' + value;`
	`75`	`+ }`
	`76`	`+ }`
	`77`	`+ else {`
	`78`	`+ value = config.webApiUrl + value.replace(/^\//, '');`
	`79`	`+ }`
`73`	`80`	`}`
`74`	`81`	`}`
`75`	`82`	`}`
`@@ -85,7 +92,7 @@ function stringifyData(data, config) {`
`85`	`92`	`});`
`86`	`93`
`87`	`94`	`stringifiedData = stringifiedData.replace(/[\u007F-\uFFFF]/g, function (chr) {`
`88`		`- return "\\u" + ("0000" + chr.charCodeAt(0).toString(16)).substr(-4)`
	`95`	`+ return "\\u" + ("0000" + chr.charCodeAt(0).toString(16)).substr(-4);`
`89`	`96`	`});`
`90`	`97`	`}`
`91`	`98`
Original file line number	Diff line number	Diff line change
`@@ -819,7 +819,7 @@ var responseStubs = {`
`819`	`819`	`Status: 3,`
`820`	`820`	`OpportunityClose: {`
`821`	`821`	`subject: "Won Opportunity",`
`822`		`- "[email protected]": webApiUrl + "tests(" + dataStubs.testEntityId + ")"`
	`822`	`+ "[email protected]": "/tests(" + dataStubs.testEntityId + ")"`
`823`	`823`	`}`
`824`	`824`	`},`
`825`	`825`	`upsertPreventCreateResponse: {`