add new request params: partitionid and parameter aliases

Author: AleksandrRogov

README.md

@@ -136,7 +136,7 @@ import DynamicsWebApi from 'dynamics-web-api';
 ```
 
 At this moment DynamicsWebApi does not fetch authorization tokens, so you will need to acquire OAuth token in your code and pass it to the DynamicsWebApi.
-Token can be aquired using [MSAL for JS](https://github.com/AzureAD/microsoft-authentication-library-for-js) or you can write your own functionality, as it is described [here](http://alexanderdevelopment.net/post/2016/11/23/dynamics-365-and-node-js-integration-using-the-web-api/).
+Token can be acquired using [MSAL for JS](https://github.com/AzureAD/microsoft-authentication-library-for-js) or you can write your own functionality, as it is described [here](http://alexanderdevelopment.net/post/2016/11/23/dynamics-365-and-node-js-integration-using-the-web-api/).
 
 Here is a sample using `@azure/msal-node`:
 
@@ -286,6 +286,8 @@ navigationProperty | String | `retrieveRequest`, `createRequest`, `updateRequest
 navigationPropertyKey | String | `retrieveRequest`, `createRequest`, `updateRequest` | `v.1.4.3+` A String representing navigation property's Primary Key (GUID) or Alternate Key(s). (For example, to retrieve Attribute Metadata)
 noCache | Boolean | All | `v.1.4.0+` If set to `true`, DynamicsWebApi adds a request header `Cache-Control: no-cache`. Default value is `false`.
 orderBy | Array | `retrieveMultipleRequest`, `retrieveAllRequest` | An Array (of Strings) representing the order in which items are returned using the $orderby system query option. Use the asc or desc suffix to specify ascending or descending order respectively. The default is ascending if the suffix isn't applied.
+partitionId | String | `createRequest`, `updateRequest`, `upsertRequest`, `deleteRequest`, `retrieveRequest`, `retrieveMultipleRequest` | `v.1.7.7+` Sets a unique partition key value of a logical partition for non-relational custom entity data stored in NoSql tables of Azure heterogenous storage. [More Info](https://docs.microsoft.com/en-us/power-apps/developer/data-platform/webapi/azure-storage-partitioning)
+queryParams | Array | `retrieveMultipleRequest`, `retrieveAllRequest` | `v.1.7.7+` Additional query parameters that either have not been implemented yet or they are [parameter aliases](https://docs.microsoft.com/en-us/power-apps/developer/data-platform/webapi/query-data-web-api#use-parameter-aliases-with-system-query-options) for "$filter" and "$orderBy". **Important!** These parameters ARE NOT URI encoded!
 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.
@@ -2172,6 +2174,7 @@ the config option "formatted" will enable developers to retrieve all information
 - [X] Shrink size of an NPM package. `Added in v.1.7.1`.
 - [X] Full proxy support. `Added in v.1.7.2`.
 - [ ] Refactoring and conversion to TypeScript - coming with `v.2.0`! Stay tuned!
+- [ ] Implement [Dataverse Search API](https://docs.microsoft.com/en-us/power-apps/developer/data-platform/webapi/relevance-search). 
 
 Many more features to come!
 

lib/requests/helpers/parseResponse.js

@@ -1,7 +1,7 @@
-var DWA = require('../../dwa');
-var Utility = require('../../utilities/Utility');
-var ErrorHelper = require('../../helpers/ErrorHelper');
-var dateReviver = require('./dateReviver');
+var DWA = require("../../dwa");
+var Utility = require("../../utilities/Utility");
+var ErrorHelper = require("../../helpers/ErrorHelper");
+var dateReviver = require("./dateReviver");
 
 //string es6 polyfill
 if (!String.prototype.endsWith || !String.prototype.startsWith) {
@@ -10,40 +10,30 @@ if (!String.prototype.endsWith || !String.prototype.startsWith) {
 
 function getFormattedKeyValue(keyName, value) {
 	var newKey = null;
-	if (keyName.indexOf('@') !== -1) {
-		var format = keyName.split('@');
+	if (keyName.indexOf("@") !== -1) {
+		var format = keyName.split("@");
 		switch (format[1]) {
-			case 'odata.context':
-				newKey = 'oDataContext';
+			case "odata.context":
+				newKey = "oDataContext";
 				break;
-			case 'odata.count':
-				newKey = 'oDataCount';
-				value = value != null
-					? parseInt(value)
-					: 0;
+			case "odata.count":
+				newKey = "oDataCount";
+				value = value != null ? parseInt(value) : 0;
 				break;
-			case '@Microsoft.Dynamics.CRM.totalrecordcount':
-				newKey = "microsoftTotalRecordCount";
-				value = value === "true";
+			case "odata.nextLink":
+				newKey = "oDataNextLink";
 				break;
-			case '@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded':
-				newKey = "microsoftTotalRecordCountLimitExceeded";
-				value = value === "true";
-				break;
-			case 'odata.nextLink':
-				newKey = 'oDataNextLink';
-				break;
-			case 'odata.deltaLink':
-				newKey = 'oDataDeltaLink';
+			case "odata.deltaLink":
+				newKey = "oDataDeltaLink";
 				break;
 			case DWA.Prefer.Annotations.FormattedValue:
-				newKey = format[0] + '_Formatted';
+				newKey = format[0] + "_Formatted";
 				break;
 			case DWA.Prefer.Annotations.AssociatedNavigationProperty:
-				newKey = format[0] + '_NavigationProperty';
+				newKey = format[0] + "_NavigationProperty";
 				break;
 			case DWA.Prefer.Annotations.LookupLogicalName:
-				newKey = format[0] + '_LogicalName';
+				newKey = format[0] + "_LogicalName";
 				break;
 		}
 	}
@@ -64,7 +54,7 @@ function parseData(object, parseParams) {
 		}
 
 		if (parseParams.toCount) {
-			return getFormattedKeyValue('@odata.count', object['@odata.count'])[1] || 0;
+			return getFormattedKeyValue("@odata.count", object["@odata.count"])[1] || 0;
 		}
 	}
 
@@ -78,8 +68,7 @@ function parseData(object, parseParams) {
 				for (var j = 0; j < object[currentKey].length; j++) {
 					object[currentKey][j] = parseData(object[currentKey][j]);
 				}
-			}
-			else if (typeof (object[currentKey]) === "object") {
+			} else if (typeof object[currentKey] === "object") {
 				parseData(object[currentKey]);
 			}
 		}
@@ -91,17 +80,18 @@ function parseData(object, parseParams) {
 		}
 
 		//parse aliased values
-		if (currentKey.indexOf('_x002e_') !== -1) {
-			var aliasKeys = currentKey.split('_x002e_');
+		if (currentKey.indexOf("_x002e_") !== -1) {
+			var aliasKeys = currentKey.split("_x002e_");
 
 			if (!object.hasOwnProperty(aliasKeys[0])) {
-				object[aliasKeys[0]] = { _dwaType: 'alias' };
+				object[aliasKeys[0]] = { _dwaType: "alias" };
 			}
 			//throw an error if there is already a property which is not an 'alias'
 			else if (
-				typeof object[aliasKeys[0]] !== 'object' ||
-				typeof object[aliasKeys[0]] === 'object' && !object[aliasKeys[0]].hasOwnProperty('_dwaType')) {
-				throw new Error('The alias name of the linked entity must be unique!');
+				typeof object[aliasKeys[0]] !== "object" ||
+				(typeof object[aliasKeys[0]] === "object" && !object[aliasKeys[0]].hasOwnProperty("_dwaType"))
+			) {
+				throw new Error("The alias name of the linked entity must be unique!");
 			}
 
 			object[aliasKeys[0]][aliasKeys[1]] = object[currentKey];
@@ -115,8 +105,8 @@ function parseData(object, parseParams) {
 	}
 
 	if (parseParams) {
-		if (parseParams.hasOwnProperty('pageNumber') && object['@' + DWA.Prefer.Annotations.FetchXmlPagingCookie] != null) {
-			object.PagingInfo = Utility.getFetchXmlPagingCookie(object['@' + DWA.Prefer.Annotations.FetchXmlPagingCookie], parseParams.pageNumber);
+		if (parseParams.hasOwnProperty("pageNumber") && object["@" + DWA.Prefer.Annotations.FetchXmlPagingCookie] != null) {
+			object.PagingInfo = Utility.getFetchXmlPagingCookie(object["@" + DWA.Prefer.Annotations.FetchXmlPagingCookie], parseParams.pageNumber);
 		}
 	}
 
@@ -139,8 +129,7 @@ function parseBatchHeaders(text) {
 		parts = responseHeaderRegex.exec(line);
 		if (parts !== null) {
 			headers[parts[1].toLowerCase()] = parts[2];
-		}
-		else {
+		} else {
 			// Whatever was found is not a header, so reset the context position.
 			ctx.position = pos;
 		}
@@ -182,7 +171,7 @@ function readTo(text, ctx, str) {
 function parseBatchResponse(response, parseParams, requestNumber) {
 	// Not the same delimiter in the response as we specify ourselves in the request,
 	// so we have to extract it.
-	var delimiter = response.substr(0, response.indexOf('\r\n'));
+	var delimiter = response.substr(0, response.indexOf("\r\n"));
 	var batchResponseParts = response.split(delimiter);
 	// The first part will always be an empty string. Just remove it.
 	batchResponseParts.shift();
@@ -194,14 +183,12 @@ function parseBatchResponse(response, parseParams, requestNumber) {
 	var result = [];
 	for (var i = 0; i < batchResponseParts.length; i++) {
 		var batchResponse = batchResponseParts[i];
-		if (batchResponse.indexOf('--changesetresponse_') > -1) {
+		if (batchResponse.indexOf("--changesetresponse_") > -1) {
 			batchResponse = batchResponse.trim();
-			var batchToProcess = batchResponse
-				.substring(batchResponse.indexOf('\r\n') + 1).trim();
+			var batchToProcess = batchResponse.substring(batchResponse.indexOf("\r\n") + 1).trim();
 
 			result = result.concat(parseBatchResponse(batchToProcess, parseParams, requestNumber));
-		}
-		else {
+		} else {
 			//check http status
 			var httpStatusReg = /HTTP\/?\s*[\d.]*\s+(\d{3})\s+([\w\s]*)$/gm.exec(batchResponse);
 			var httpStatus = parseInt(httpStatusReg[1]);
@@ -216,38 +203,36 @@ function parseBatchResponse(response, parseParams, requestNumber) {
 
 					//check if a plain content is a number or not
 					result.push(isNaN(plainContent) ? plainContent : parseInt(plainContent));
-				}
-				else
-					if (parseParams.length && parseParams[requestNumber] && parseParams[requestNumber].hasOwnProperty('valueIfEmpty')) {
-						result.push(parseParams[requestNumber].valueIfEmpty);
-					}
-					else {
-						var entityUrl = /OData-EntityId.+/i.exec(batchResponse);
+				} else if (parseParams.length && parseParams[requestNumber] && parseParams[requestNumber].hasOwnProperty("valueIfEmpty")) {
+					result.push(parseParams[requestNumber].valueIfEmpty);
+				} else {
+					var entityUrl = /OData-EntityId.+/i.exec(batchResponse);
 
-						if (entityUrl && entityUrl.length) {
-							var guidResult = /([0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12})\)$/i.exec(entityUrl[0]);
+					if (entityUrl && entityUrl.length) {
+						var guidResult = /([0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12})\)$/i.exec(entityUrl[0]);
 
-							result.push(guidResult ? guidResult[1] : undefined);
-						}
-						else {
-							result.push(undefined);
-						}
+						result.push(guidResult ? guidResult[1] : undefined);
+					} else {
+						result.push(undefined);
 					}
-			}
-			else {
+				}
+			} else {
 				var parsedResponse = parseData(JSON.parse(responseData, dateReviver), parseParams[requestNumber]);
 
 				if (httpStatus >= 400) {
-					var responseHeaders = parseBatchHeaders(batchResponse.substring(batchResponse.indexOf(httpStatusReg[0]) + httpStatusReg[0].length + 1, batchResponse.indexOf("{")));
-
-					result.push(ErrorHelper.handleHttpError(parsedResponse, {
-						status: httpStatus,
-						statusText: httpStatusMessage,
-						statusMessage: httpStatusMessage,
-						headers: responseHeaders
-					}));
-				}
-				else {
+					var responseHeaders = parseBatchHeaders(
+						batchResponse.substring(batchResponse.indexOf(httpStatusReg[0]) + httpStatusReg[0].length + 1, batchResponse.indexOf("{"))
+					);
+
+					result.push(
+						ErrorHelper.handleHttpError(parsedResponse, {
+							status: httpStatus,
+							statusText: httpStatusMessage,
+							statusMessage: httpStatusMessage,
+							headers: responseHeaders,
+						})
+					);
+				} else {
 					result.push(parsedResponse);
 				}
 			}
@@ -263,32 +248,28 @@ function base64ToString(base64) {
 	/* develblock:start */
 	if (typeof process !== "undefined") {
 		return Buffer.from(base64, "base64").toString("binary");
-	}
-	else if (typeof window !== "undefined")
+	} else if (typeof window !== "undefined")
 		/* develblock:end */
 		return window.atob(base64);
 }
 
 function parseFileResponse(response, responseHeaders, parseParams) {
 	var data = response;
 
-	if (parseParams.hasOwnProperty('parse')) {
+	if (parseParams.hasOwnProperty("parse")) {
 		data = JSON.parse(data).value;
 		data = base64ToString(data);
 	}
 
 	var parseResult = {
-		value: data
+		value: data,
 	};
 
-	if (responseHeaders['x-ms-file-name'])
-		parseResult.fileName = responseHeaders['x-ms-file-name'];
+	if (responseHeaders["x-ms-file-name"]) parseResult.fileName = responseHeaders["x-ms-file-name"];
 
-	if (responseHeaders['x-ms-file-size'])
-		parseResult.fileSize = parseInt(responseHeaders['x-ms-file-size']);
+	if (responseHeaders["x-ms-file-size"]) parseResult.fileSize = parseInt(responseHeaders["x-ms-file-size"]);
 
-	if (hasHeader(responseHeaders, 'Location'))
-		parseResult.location = getHeader(responseHeaders, 'Location');
+	if (hasHeader(responseHeaders, "Location")) parseResult.location = getHeader(responseHeaders, "Location");
 
 	return parseResult;
 }
@@ -298,8 +279,7 @@ function hasHeader(headers, name) {
 }
 
 function getHeader(headers, name) {
-	if (headers[name])
-		return headers[name];
+	if (headers[name]) return headers[name];
 
 	return headers[name.toLowerCase()];
 }
@@ -314,47 +294,38 @@ function getHeader(headers, name) {
 module.exports = function parseResponse(response, responseHeaders, parseParams) {
 	var parseResult = undefined;
 	if (response.length) {
-		if (response.indexOf('--batchresponse_') > -1) {
+		if (response.indexOf("--batchresponse_") > -1) {
 			var batch = parseBatchResponse(response, parseParams);
 
-			parseResult = parseParams.length === 1 && parseParams[0].convertedToBatch
-				? batch[0]
-				: batch;
-		}
-		else {
-			if (hasHeader(responseHeaders, 'Content-Disposition')) {
+			parseResult = parseParams.length === 1 && parseParams[0].convertedToBatch ? batch[0] : batch;
+		} else {
+			if (hasHeader(responseHeaders, "Content-Disposition")) {
 				parseResult = parseFileResponse(response, responseHeaders, parseParams[0]);
-			}
-			else {
+			} else {
 				parseResult = parseData(JSON.parse(response, dateReviver), parseParams[0]);
 			}
 		}
-	}
-	else {
-		if (parseParams.length && parseParams[0].hasOwnProperty('valueIfEmpty')) {
+	} else {
+		if (parseParams.length && parseParams[0].hasOwnProperty("valueIfEmpty")) {
 			parseResult = parseParams[0].valueIfEmpty;
-		}
-		else
-			if (hasHeader(responseHeaders, 'OData-EntityId')) {
-				var entityUrl = getHeader(responseHeaders, 'OData-EntityId');
+		} else if (hasHeader(responseHeaders, "OData-EntityId")) {
+			var entityUrl = getHeader(responseHeaders, "OData-EntityId");
 
-				var guidResult = /([0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12})\)$/i.exec(entityUrl);
+			var guidResult = /([0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12})\)$/i.exec(entityUrl);
 
-				if (guidResult) {
-					parseResult = guidResult[1];
-				}
+			if (guidResult) {
+				parseResult = guidResult[1];
 			}
-			else if (hasHeader(responseHeaders, 'Location')) {
-				parseResult = {
-					location: getHeader(responseHeaders, 'Location')
-				}
+		} else if (hasHeader(responseHeaders, "Location")) {
+			parseResult = {
+				location: getHeader(responseHeaders, "Location"),
+			};
 
-				if (responseHeaders['x-ms-chunk-size'])
-					parseResult.chunkSize = parseInt(responseHeaders['x-ms-chunk-size']);
-			}
+			if (responseHeaders["x-ms-chunk-size"]) parseResult.chunkSize = parseInt(responseHeaders["x-ms-chunk-size"]);
+		}
 	}
 
 	//parseParams.length = 0;
 
 	return parseResult;
-}
+};

lib/utilities/RequestConverter.js

@@ -123,6 +123,11 @@ function convertRequestOptions(request, functionName, url, joinSymbol, config) {
 			requestArray.push("$orderby=" + request.orderBy.join(","));
 		}
 
+		if (request.partitionId) {
+			ErrorHelper.stringParameterCheck(request.partitionId, "DynamicsWebApi." + functionName, "request.partitionId");
+			requestArray.push("partitionid='" + request.partitionId + "'");
+		}
+
 		if (request.downloadSize) {
 			ErrorHelper.stringParameterCheck(request.downloadSize, "DynamicsWebApi." + functionName, "request.downloadSize");
 			requestArray.push("size=" + request.downloadSize);
@@ -133,6 +138,11 @@ function convertRequestOptions(request, functionName, url, joinSymbol, config) {
 			requestArray.push("x-ms-file-name=" + request.fileName);
 		}
 
+		if (request.queryParams != null && request.queryParams.length) {
+			ErrorHelper.arrayParameterCheck(request.queryParams, "DynamicsWebApi." + functionName, "request.queryParams");
+			requestArray.push(request.queryParams.join("&"));
+		}
+
 		var prefer = buildPreferHeader(request, functionName, config);
 
 		if (prefer.length) {