adding skipNameCheck for a composable function workaround #168

Author: AleksandrRogov

.github/README.md

@@ -305,6 +305,7 @@ queryParams | Array | `retrieveMultipleRequest`, `retrieveAllRequest` | `v.1.7.7
 returnRepresentation | Boolean | `createRequest`, `updateRequest`, `upsertRequest` | Sets Prefer header request with value "return=representation". Use this property to return just created or updated entity in a single request.
 savedQuery | String | `retrieveRequest` | A String representing the GUID value of the saved query.
 select | Array | `retrieveRequest`, `retrieveMultipleRequest`, `retrieveAllRequest`, `updateRequest`, `upsertRequest` | An Array (of Strings) representing the $select OData System Query Option to control which attributes will be returned.
+skipNameCheck | Boolean | All | `v.1.7.12+` Skips the collection name check in DynamicsWebApi. Helpful when the collection name should stay the same in the URL as it was set in the request.
 timeout | Number | All | `v.1.6.10+` Sets a number of milliseconds before a request times out.
 token | String | All | Authorization Token. If set, onTokenRefresh will not be called.
 top | Number | `retrieveMultipleRequest`, `retrieveAllRequest` | Limit the number of results returned by using the $top system query option. Do not use $top with $count!

lib/requests/sendRequest.js

@@ -387,9 +387,8 @@ function _isEntityNameException(entityName) {
 	return exceptions.indexOf(entityName) > -1;
 }
 
-function _checkCollectionName(entityName, config, successCallback, errorCallback) {
-
-	if (_isEntityNameException(entityName) || Utility.isNull(entityName)) {
+function _checkCollectionName(entityName, config, skipNameCheck, successCallback, errorCallback) {
+	if (!!skipNameCheck || _isEntityNameException(entityName) || Utility.isNull(entityName)) {
 		successCallback(entityName);
 		return;
 	}
@@ -427,7 +426,7 @@ function makeRequest(method, request, functionName, config, responseParams, reso
 		RequestConverter.convertRequest(request, functionName, config);
 	}
 	else {
-		_checkCollectionName(request.collection, config, function (collectionName) {
+		_checkCollectionName(request.collection, config, request.skipNameCheck, function (collectionName) {
 			request.collection = collectionName;
 			var result = RequestConverter.convertRequest(request, functionName, config);
 			var requestId = request.requestId;

lib/utilities/RequestConverter.js

@@ -274,6 +274,7 @@ function convertRequestOptions(request, functionName, url, joinSymbol, config) {
 function convertRequest(request, functionName, config) {
 	var url = "";
 	var result;
+
 	if (!request.url) {
 		if (!request._unboundRequest && !request.collection) {
 			ErrorHelper.parameterCheck(request.collection, "DynamicsWebApi." + functionName, "request.collection");
@@ -328,6 +329,7 @@ function convertRequest(request, functionName, config) {
 		result.async = true;
 	}
 
+
 	return { url: result.url, headers: result.headers, async: result.async };
 }
 

tests/main-tests.js

@@ -1627,6 +1627,40 @@ describe("promises -", function () {
             });
         });
 
+        describe("unbound - composable (skipNameCheck)", function () {
+            var scope;
+            before(function () {
+                var response = mocks.responses.response200;
+                scope = nock(mocks.webApiUrl)
+                    .get("/FUN(param1=@p1)?$select=something&@p1=0000")
+                    .reply(response.status, response.responseText, response.responseHeaders);
+            });
+
+            after(function () {
+                nock.cleanAll();
+            });
+
+            it("(with parameters) returns a correct response", function (done) {
+                dynamicsWebApiTest.retrieveRequest({
+                    collection: "FUN",
+                    key: "param1=@p1",
+                    select: ["something"],
+                    queryParams: ["@p1=0000"],
+                    skipNameCheck: true
+                }).then(function (object) {
+                    expect(object).to.deep.equal(mocks.data.testEntity);
+                    done();
+                })
+                .catch(function (object) {
+                    done(object);
+                });
+            });
+
+            it("all requests have been made", function () {
+                expect(scope.isDone()).to.be.true;
+            });
+        });
+
         describe("bound", function () {
             var scope;
             before(function () {

types/dynamics-web-api-callbacks.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for dynamics-web-api-callbacks v1.7.11
+// Type definitions for dynamics-web-api-callbacks v1.7.12
 // Project: https://github.com/AleksandrRogov/DynamicsWebApi
 // Definitions by: Aleksandr Rogov https://github.com/AleksandrRogov/
 
@@ -876,6 +876,8 @@ declare namespace DynamicsWebApi {
     interface Request extends RequestBase {
         /**The name of the Entity Collection or Entity Logical name. */
         collection?: string;
+        /**Skips the collection name check in DynamicsWebApi */
+        skipNameCheck?: boolean;
     }
 
     interface CRUDRequest extends Request {

types/dynamics-web-api.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for dynamics-web-api v1.7.11
+// Type definitions for dynamics-web-api v1.7.12
 // Project: https://github.com/AleksandrRogov/DynamicsWebApi/
 // Definitions by: Aleksandr Rogov https://github.com/AleksandrRogov/
 
@@ -564,6 +564,8 @@ declare namespace DynamicsWebApi {
     interface Request extends RequestBase {
         /**The name of the Entity Collection or Entity Logical name. */
         collection?: string;
+        /**Skips the collection name check in DynamicsWebApi */
+        skipNameCheck?: boolean;
     }
 
     interface CRUDRequest extends Request {