@shko.online/dataverse-odata 0.1.4 → 0.1.5

package/src/validators/recognizedGuid.ts

@@ -1,18 +1,18 @@
-import type { ODataQuery } from '../OData.types';
-
-/**
- * 
- * @param value The result of {@link URLSearchParams.getAll getAll}
- * @param result The {@link ODataQuery} to append the error to
- * @returns {boolean} Returns `false` when the parse has an error
- */
-export const recognizedGuid = (value: string[], result: ODataQuery) => {
-    if (!value[0].trim()) {
-        result.error = {
-            code: '0x0',
-            message: 'Unrecognized Guid format.',
-        };
-        return false;
-    }
-    return true;
-};
+import type { ODataQuery } from '../OData.types';
+
+/**
+ * 
+ * @param value The result of {@link URLSearchParams.getAll getAll}
+ * @param result The {@link ODataQuery} to append the error to
+ * @returns {boolean} Returns `false` when the parse has an error
+ */
+export const recognizedGuid = (value: string[], result: ODataQuery) => {
+    if (!value[0].trim()) {
+        result.error = {
+            code: '0x0',
+            message: 'Unrecognized Guid format.',
+        };
+        return false;
+    }
+    return true;
+};

package/lib/cjs/OData.types.d.js

@@ -1 +0,0 @@
-"use strict";

package/lib/cjs/getExpandFromParser.js

@@ -1,122 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getExpandFromParser = void 0;
-var _getSelectFromParser = require("./getSelectFromParser");
-var _atMostOnce = require("./validators/atMostOnce");
-const option = '$expand';
-
-/**
- * Parses the {@link ODataExpand.$expand $expand} query
- * @returns Returns `false` when the parse has an error
- */
-const getExpandFromParser = (parser, result) => {
-  const value = parser.getAll(option);
-  if (value.length === 0) {
-    return true;
-  }
-  if (!(0, _atMostOnce.atMostOnce)(option, value, result)) {
-    return false;
-  }
-  result.$expand = {};
-  if (!extractExpand(value[0], result)) {
-    return false;
-  }
-  return true;
-};
-exports.getExpandFromParser = getExpandFromParser;
-const extractExpand = (value, $expand) => {
-  const match = value.match(/^\s*(\w(\w|\d|_)*)\s*(,|\(|\))?\s*/);
-  if (match === null || match[0].length < value.length && match[3] === null || match[0].length === value.length && match[3] !== undefined) {
-    $expand.error = {
-      code: '0x0',
-      message: `Term '${value}' is not valid in a $select or $expand expression.`
-    };
-    return false;
-  }
-  let matchSeparator = match[3];
-  let matchLength = match[0].length;
-  if (matchSeparator !== '(') {
-    if ($expand.$expand !== undefined) {
-      $expand.$expand[match[1]] = {
-        $select: []
-      };
-    }
-  } else {
-    const {
-      index,
-      error
-    } = getClosingBracket(value.substring(matchLength));
-    if (error) {
-      $expand.error = {
-        code: '0x0',
-        message: error
-      };
-      return false;
-    }
-    if ($expand.$expand !== undefined) {
-      const innerExpand = {};
-      const parser = new URLSearchParams('?' + value.substring(matchLength, matchLength + index));
-      if (!(0, _getSelectFromParser.getSelectFromParser)(parser, innerExpand)) {
-        $expand.error = innerExpand.error;
-        return false;
-      }
-      if (!getExpandFromParser(parser, innerExpand)) {
-        $expand.error = innerExpand.error;
-        return false;
-      }
-      if (innerExpand.$expand === undefined && innerExpand.$select === undefined) {
-        $expand.error = {
-          code: '0x0',
-          message: `Missing expand option on navigation property '${match[1]}'. If a parenthesis expression follows an expanded navigation property, then at least one expand option must be provided.`
-        };
-        return false;
-      }
-      $expand.$expand[match[1]] = innerExpand;
-    }
-    matchLength = matchLength + index;
-    const secondMatch = value.substring(matchLength + 1).match(/\s*(,?)\s*d/);
-    if (secondMatch !== null) {
-      matchLength = matchLength + secondMatch[0].length;
-      if (secondMatch[1] !== null) {
-        matchSeparator = ',';
-      }
-    }
-  }
-  if (matchSeparator === ',') {
-    if (!extractExpand(value.substring(matchLength), $expand)) {
-      return false;
-    }
-  }
-  return true;
-};
-const getClosingBracket = value => {
-  let depth = 1;
-  let startAt = 0;
-  while (depth > 0) {
-    const match = value.substring(startAt).match(/\(|\)/);
-    if (match === null) {
-      return {
-        error: 'Found an unbalanced bracket expression.',
-        index: -1
-      };
-    }
-    if (match[0] === ')') {
-      depth -= 1;
-      if (depth === 0) {
-        return {
-          index: match.index || 0
-        };
-      }
-    } else {
-      depth += 1;
-    }
-    startAt += (match.index || 0) + 1;
-  }
-  return {
-    error: 'Found an unbalanced bracket expression.',
-    index: -1
-  };
-};

package/lib/cjs/getFetchXmlFromParser.js

@@ -1,52 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getFetchXmlFromParser = void 0;
-var _atMostOnce = require("./validators/atMostOnce");
-var _differentFromEmptyString = require("./validators/differentFromEmptyString");
-const option = 'fetchXml';
-
-/**
- * Parses the {@link ODataFetch.fetchXml fetchXml} query
- * @returns Returns `false` when the parse has an error
- */
-const getFetchXmlFromParser = (parser, result) => {
-  const value = parser.getAll(option);
-  if (value.length === 0) {
-    return true;
-  }
-  if (!(0, _atMostOnce.atMostOnce)(option, value, result) || !(0, _differentFromEmptyString.differentFromEmptyString)(value, result)) {
-    return false;
-  }
-  const fetchXml = value[0];
-  const serializer = new DOMParser();
-  const fetchXmlDocument = serializer.parseFromString(fetchXml, 'text/xml');
-  if (fetchXmlDocument.documentElement.tagName === 'parsererror') {
-    result.error = {
-      code: '0x80040201',
-      message: 'Invalid XML.'
-    };
-    return false;
-  }
-  const entity = fetchXmlDocument.evaluate('fetch/entity', fetchXmlDocument, null, XPathResult.ANY_TYPE, null).iterateNext();
-  if (fetchXmlDocument.documentElement.children.length != 1 || !entity || !entity.getAttribute('name')) {
-    result.error = {
-      code: '0x80041102',
-      message: 'Entity Name was not specified in FetchXml String.'
-    };
-    return false;
-  }
-  const invalidAttribute = fetchXmlDocument.evaluate('fetch/entity/*[not(self::filter or self::order or self::link-entity or self::attribute or self::all-attributes or self::no-attrs)]', fetchXmlDocument, null, XPathResult.ANY_TYPE, null).iterateNext();
-  if (invalidAttribute) {
-    result.error = {
-      code: '0x8004111c',
-      message: `Invalid Child Node, valid nodes are filter, order, link-entity, attribute, all-attributes, no-attrs. NodeName = ${invalidAttribute.tagName} NodeXml = ${invalidAttribute.outerHTML}`
-    };
-    return false;
-  }
-  result.fetchXml = fetchXmlDocument;
-  return true;
-};
-exports.getFetchXmlFromParser = getFetchXmlFromParser;

package/lib/cjs/getOrderByFromParser.js

@@ -1,47 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getOrderByFromParser = void 0;
-var _atMostOnce = require("./validators/atMostOnce");
-var _hasContent = require("./validators/hasContent");
-const option = '$orderby';
-const edmProperty = /\w{1-255}/gi;
-
-/**
- * Parses the {@link ODataOrderBy.$orderby $orderby} query
- * @returns Returns `false` when the parse has an error
- */
-const getOrderByFromParser = (parser, result) => {
-  let value = parser.getAll(option);
-  if (value.length === 0) {
-    return true;
-  }
-  if (!(0, _atMostOnce.atMostOnce)(option, value, result) || !(0, _hasContent.hasContent)(option, value, result)) {
-    return false;
-  }
-  let $orderby = value[0].trimEnd();
-  const orderByArray = [];
-  for (let i = 0; i < $orderby.length; i++) {
-    if (false /* syntax error */) {
-      result.error = {
-        code: '0x0',
-        message: `Syntax error at position ${i} in '${$orderby}'.`
-      };
-      return false;
-    }
-  }
-  orderByArray.forEach(orderBy => {
-    if (!orderBy.column?.match(edmProperty)) {
-      result.error = {
-        code: '0x80060888',
-        message: 'Order By Property must be of type EdmProperty'
-      };
-      return false;
-    }
-  });
-  result.$orderby = orderByArray;
-  return true;
-};
-exports.getOrderByFromParser = getOrderByFromParser;

package/lib/cjs/getSelectFromParser.js

@@ -1,27 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getSelectFromParser = void 0;
-var _atMostOnce = require("./validators/atMostOnce");
-const option = '$select';
-
-/**
- * Parses the {@link ODataSelect.$select $select} query
- * @returns {boolean} Returns `false` when the parse has an error
- */
-const getSelectFromParser = (parser, result) => {
-  const value = parser.getAll(option);
-  if (value.length === 0) {
-    return true;
-  }
-  if (!(0, _atMostOnce.atMostOnce)(option, value, result)) {
-    return false;
-  }
-  if (value.length > 0) {
-    result.$select = value[0].split(',');
-  }
-  return true;
-};
-exports.getSelectFromParser = getSelectFromParser;

package/lib/cjs/getTopFromParser.js

@@ -1,40 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getTopFromParser = void 0;
-var _atMostOnce = require("./validators/atMostOnce");
-var _hasContent = require("./validators/hasContent");
-const option = '$top';
-
-/**
- * Parses the {@link ODataTop.$top $top} query
- * @returns Returns `false` when the parse has an error
- */
-const getTopFromParser = (parser, result) => {
-  const value = parser.getAll(option);
-  if (value.length === 0) {
-    return true;
-  }
-  if (!(0, _atMostOnce.atMostOnce)(option, value, result) || !(0, _hasContent.hasContent)(option, value, result)) {
-    return false;
-  }
-  let $top;
-  if (!value[0].match(/^\d+$/) || ($top = parseInt(value[0])) < 0) {
-    result.error = {
-      code: '0x0',
-      message: `Invalid value '${value}' for $top query option found. The $top query option requires a non-negative integer value.`
-    };
-    return false;
-  } else if ($top === 0) {
-    result.error = {
-      code: '0x0',
-      message: `Invalid value for $top query option.`
-    };
-    return false;
-  }
-  result.$top = $top;
-  return true;
-};
-exports.getTopFromParser = getTopFromParser;

package/lib/cjs/getXQueryFromParser.js

@@ -1,25 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getXQueryFromParser = void 0;
-var _isGuid = require("./validators/isGuid");
-var _recognizedGuid = require("./validators/recognizedGuid");
-/**
- * Parses the {@link ODataSavedQuery.savedQuery savedQuery} or
- * {@link ODataUserQuery.userQuery userQuery} query
- * @returns Returns `false` when the parse has an error
- */
-const getXQueryFromParser = (X, parser, result) => {
-  const value = parser.getAll(X);
-  if (value.length === 0) {
-    return true;
-  }
-  if (!(0, _recognizedGuid.recognizedGuid)(value, result) || !(0, _isGuid.isGuid)(value, result)) {
-    return false;
-  }
-  result[X] = value[0];
-  return true;
-};
-exports.getXQueryFromParser = getXQueryFromParser;

package/lib/cjs/index.js

@@ -1,57 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-Object.defineProperty(exports, "getExpandFromParser", {
-  enumerable: true,
-  get: function () {
-    return _getExpandFromParser.getExpandFromParser;
-  }
-});
-Object.defineProperty(exports, "getFetchXmlFromParser", {
-  enumerable: true,
-  get: function () {
-    return _getFetchXmlFromParser.getFetchXmlFromParser;
-  }
-});
-Object.defineProperty(exports, "getOrderByFromParser", {
-  enumerable: true,
-  get: function () {
-    return _getOrderByFromParser.getOrderByFromParser;
-  }
-});
-Object.defineProperty(exports, "getSelectFromParser", {
-  enumerable: true,
-  get: function () {
-    return _getSelectFromParser.getSelectFromParser;
-  }
-});
-Object.defineProperty(exports, "getTopFromParser", {
-  enumerable: true,
-  get: function () {
-    return _getTopFromParser.getTopFromParser;
-  }
-});
-Object.defineProperty(exports, "getXQueryFromParser", {
-  enumerable: true,
-  get: function () {
-    return _getXQueryFromParser.getXQueryFromParser;
-  }
-});
-Object.defineProperty(exports, "parseOData", {
-  enumerable: true,
-  get: function () {
-    return _parseOData.parseOData;
-  }
-});
-var _getExpandFromParser = require("./getExpandFromParser");
-var _getFetchXmlFromParser = require("./getFetchXmlFromParser");
-var _getOrderByFromParser = require("./getOrderByFromParser");
-var _getSelectFromParser = require("./getSelectFromParser");
-var _getTopFromParser = require("./getTopFromParser");
-var _getXQueryFromParser = require("./getXQueryFromParser");
-var _parseOData = require("./parseOData");
-var _default = _parseOData.parseOData;
-exports.default = _default;

package/lib/cjs/parseOData.js

@@ -1,24 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.parseOData = void 0;
-var _getTopFromParser = require("./getTopFromParser");
-var _getSelectFromParser = require("./getSelectFromParser");
-var _getExpandFromParser = require("./getExpandFromParser");
-var _getFetchXmlFromParser = require("./getFetchXmlFromParser");
-var _getXQueryFromParser = require("./getXQueryFromParser");
-var _getOrderByFromParser = require("./getOrderByFromParser");
-/**
- * parses the OData query and applies some Dataverse validations
- * @param query The OData query
- * @returns The parsed OData query
- */
-const parseOData = query => {
-  const parser = new URLSearchParams(query);
-  const result = {};
-  (0, _getExpandFromParser.getExpandFromParser)(parser, result) && (0, _getSelectFromParser.getSelectFromParser)(parser, result) && (0, _getTopFromParser.getTopFromParser)(parser, result) && (0, _getFetchXmlFromParser.getFetchXmlFromParser)(parser, result) && (0, _getXQueryFromParser.getXQueryFromParser)('savedQuery', parser, result) && (0, _getXQueryFromParser.getXQueryFromParser)('userQuery', parser, result) && (0, _getOrderByFromParser.getOrderByFromParser)(parser, result);
-  return result;
-};
-exports.parseOData = parseOData;

package/lib/cjs/validators/atMostOnce.js

@@ -1,24 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.atMostOnce = void 0;
-/**
- * Options of this type must be specified at most once.
- * @param option The option being validated (ex. $top)
- * @param value The result of {@link URLSearchParams.getAll getAll}
- * @param result The {@link ODataQuery} to append the error to
- * @returns {boolean} Returns `false` when the parse has an error
- */
-const atMostOnce = (option, value, result) => {
-  if (value.length > 1) {
-    result.error = {
-      code: '0x0',
-      message: `Query option '${option}' was specified more than once, but it must be specified at most once.`
-    };
-    return false;
-  }
-  return true;
-};
-exports.atMostOnce = atMostOnce;

package/lib/cjs/validators/differentFromEmptyString.js

@@ -1,23 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.differentFromEmptyString = void 0;
-/**
- * 
- * @param value The result of {@link URLSearchParams.getAll getAll}
- * @param result The {@link ODataQuery} to append the error to
- * @returns {boolean} Returns `false` when the parse has an error
- */
-const differentFromEmptyString = (value, result) => {
-  if (value[0] === '') {
-    result.error = {
-      code: '0x80040203',
-      message: 'Expected non-empty string.'
-    };
-    return false;
-  }
-  return true;
-};
-exports.differentFromEmptyString = differentFromEmptyString;

package/lib/cjs/validators/hasContent.js

@@ -1,24 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.hasContent = void 0;
-/**
- * Options of this type must be specified at most once.
- * @param option The option being validated (ex. $top)
- * @param value The result of {@link URLSearchParams.getAll getAll}
- * @param result The {@link ODataQuery} to append the error to
- * @returns {boolean} Returns `false` when the parse has an error
- */
-const hasContent = (query, value, result) => {
-  if (!value[0].trim()) {
-    result.error = {
-      code: '0x0',
-      message: `The value for OData query '${query}' cannot be empty.`
-    };
-    return false;
-  }
-  return true;
-};
-exports.hasContent = hasContent;

package/lib/cjs/validators/isGuid.js

@@ -1,25 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isGuid = void 0;
-const guidRegex = /[0-9A-F]{8}\-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}/gi;
-
-/**
- * 
- * @param value The result of {@link URLSearchParams.getAll getAll}
- * @param result The {@link ODataQuery} to append the error to
- * @returns {boolean} Returns `false` when the parse has an error
- */
-const isGuid = (value, result) => {
-  if (!value[0].match(guidRegex)) {
-    result.error = {
-      code: '0x0',
-      message: 'Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).'
-    };
-    return false;
-  }
-  return true;
-};
-exports.isGuid = isGuid;

package/lib/cjs/validators/recognizedGuid.js

@@ -1,23 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.recognizedGuid = void 0;
-/**
- * 
- * @param value The result of {@link URLSearchParams.getAll getAll}
- * @param result The {@link ODataQuery} to append the error to
- * @returns {boolean} Returns `false` when the parse has an error
- */
-const recognizedGuid = (value, result) => {
-  if (!value[0].trim()) {
-    result.error = {
-      code: '0x0',
-      message: 'Unrecognized Guid format.'
-    };
-    return false;
-  }
-  return true;
-};
-exports.recognizedGuid = recognizedGuid;

package/lib/esm/getExpandFromParser.js

@@ -1,115 +0,0 @@
-import { getSelectFromParser } from './getSelectFromParser';
-import { atMostOnce } from './validators/atMostOnce';
-const option = '$expand';
-
-/**
- * Parses the {@link ODataExpand.$expand $expand} query
- * @returns Returns `false` when the parse has an error
- */
-export const getExpandFromParser = (parser, result) => {
-  const value = parser.getAll(option);
-  if (value.length === 0) {
-    return true;
-  }
-  if (!atMostOnce(option, value, result)) {
-    return false;
-  }
-  result.$expand = {};
-  if (!extractExpand(value[0], result)) {
-    return false;
-  }
-  return true;
-};
-const extractExpand = (value, $expand) => {
-  const match = value.match(/^\s*(\w(\w|\d|_)*)\s*(,|\(|\))?\s*/);
-  if (match === null || match[0].length < value.length && match[3] === null || match[0].length === value.length && match[3] !== undefined) {
-    $expand.error = {
-      code: '0x0',
-      message: `Term '${value}' is not valid in a $select or $expand expression.`
-    };
-    return false;
-  }
-  let matchSeparator = match[3];
-  let matchLength = match[0].length;
-  if (matchSeparator !== '(') {
-    if ($expand.$expand !== undefined) {
-      $expand.$expand[match[1]] = {
-        $select: []
-      };
-    }
-  } else {
-    const {
-      index,
-      error
-    } = getClosingBracket(value.substring(matchLength));
-    if (error) {
-      $expand.error = {
-        code: '0x0',
-        message: error
-      };
-      return false;
-    }
-    if ($expand.$expand !== undefined) {
-      const innerExpand = {};
-      const parser = new URLSearchParams('?' + value.substring(matchLength, matchLength + index));
-      if (!getSelectFromParser(parser, innerExpand)) {
-        $expand.error = innerExpand.error;
-        return false;
-      }
-      if (!getExpandFromParser(parser, innerExpand)) {
-        $expand.error = innerExpand.error;
-        return false;
-      }
-      if (innerExpand.$expand === undefined && innerExpand.$select === undefined) {
-        $expand.error = {
-          code: '0x0',
-          message: `Missing expand option on navigation property '${match[1]}'. If a parenthesis expression follows an expanded navigation property, then at least one expand option must be provided.`
-        };
-        return false;
-      }
-      $expand.$expand[match[1]] = innerExpand;
-    }
-    matchLength = matchLength + index;
-    const secondMatch = value.substring(matchLength + 1).match(/\s*(,?)\s*d/);
-    if (secondMatch !== null) {
-      matchLength = matchLength + secondMatch[0].length;
-      if (secondMatch[1] !== null) {
-        matchSeparator = ',';
-      }
-    }
-  }
-  if (matchSeparator === ',') {
-    if (!extractExpand(value.substring(matchLength), $expand)) {
-      return false;
-    }
-  }
-  return true;
-};
-const getClosingBracket = value => {
-  let depth = 1;
-  let startAt = 0;
-  while (depth > 0) {
-    const match = value.substring(startAt).match(/\(|\)/);
-    if (match === null) {
-      return {
-        error: 'Found an unbalanced bracket expression.',
-        index: -1
-      };
-    }
-    if (match[0] === ')') {
-      depth -= 1;
-      if (depth === 0) {
-        return {
-          index: match.index || 0
-        };
-      }
-    } else {
-      depth += 1;
-    }
-    startAt += (match.index || 0) + 1;
-  }
-  return {
-    error: 'Found an unbalanced bracket expression.',
-    index: -1
-  };
-};