@shko.online/dataverse-odata 0.1.5 → 0.2.0

package/lib/esm/getOrderByFromParser.js

@@ -0,0 +1,71 @@
+import { getAliasedProperty } from './getAliasedProperty';
+import { atMostOnce } from './validators/atMostOnce';
+import { hasContent } from './validators/hasContent';
+const option = '$orderby';
+
+/**
+ * Parses the {@link ODataOrderBy.$orderby $orderby} query
+ * @returns Returns `false` when the parse has an error
+ */
+export const getOrderByFromParser = (parser, result) => {
+  let value = parser.getAll(option);
+  if (value.length === 0) {
+    return true;
+  }
+  if (!atMostOnce(option, value, result) || !hasContent(option, value, result)) {
+    return false;
+  }
+  let $orderby = value[0].trimEnd();
+  let $orderbyParts = $orderby.split(',');
+  const orderByArray = [];
+  let position = 0;
+  for (const element of $orderbyParts) {
+    const parts = Array.from(element.matchAll(/\s*(\S+)/gi));
+    if (parts.length > 2) {
+      position = position + parts[0][0].length + parts[1][0].length + parts[2][0].length;
+      result.error = {
+        code: '0x80060888',
+        message: `Syntax error at position ${position} in '${$orderby}'.`
+      };
+      return false;
+    }
+    if (!/^[@a-zA-Z]\w+/gi.test(parts[0][1])) {
+      position = position + parts[0][0].length;
+      result.error = {
+        code: '0x80060888',
+        message: `Syntax error at position ${position} in '${$orderby}'.`
+      };
+      return false;
+    }
+    const orderBy = {
+      column: parts[0][1],
+      asc: true // default is ascending
+    };
+    if (parts[0][1].startsWith('@')) {
+      orderBy.column = getAliasedProperty(parser, result, parts[0][1]);
+      if (!orderBy.column) {
+        return false;
+      }
+    }
+    if (parts.length === 1) {
+      orderByArray.push(orderBy);
+      continue;
+    }
+    if (parts[1][1].toLowerCase() === 'asc') {
+      orderBy.asc = true;
+      orderByArray.push(orderBy);
+    } else if (parts[1][1].toLowerCase() === 'desc') {
+      orderBy.asc = false;
+      orderByArray.push(orderBy);
+    } else {
+      position = position + parts[0][0].length + parts[1][0].length;
+      result.error = {
+        code: '0x80060888',
+        message: `Syntax error at position ${position} in '${$orderby}'.`
+      };
+      return false;
+    }
+  }
+  result.$orderby = orderByArray;
+  return true;
+};

package/lib/esm/getSelectFromParser.js

@@ -0,0 +1,20 @@
+import { atMostOnce } from './validators/atMostOnce';
+const option = '$select';
+
+/**
+ * Parses the {@link ODataSelect.$select $select} query
+ * @returns {boolean} Returns `false` when the parse has an error
+ */
+export const getSelectFromParser = (parser, result) => {
+  const value = parser.getAll(option);
+  if (value.length === 0) {
+    return true;
+  }
+  if (!atMostOnce(option, value, result)) {
+    return false;
+  }
+  if (value.length > 0) {
+    result.$select = value[0].split(',');
+  }
+  return true;
+};

package/lib/esm/getTopFromParser.js

@@ -0,0 +1,33 @@
+import { atMostOnce } from './validators/atMostOnce';
+import { hasContent } from './validators/hasContent';
+const option = '$top';
+
+/**
+ * Parses the {@link ODataTop.$top $top} query
+ * @returns Returns `false` when the parse has an error
+ */
+export const getTopFromParser = (parser, result) => {
+  const value = parser.getAll(option);
+  if (value.length === 0) {
+    return true;
+  }
+  if (!atMostOnce(option, value, result) || !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;
+};

package/lib/esm/getXQueryFromParser.js

@@ -0,0 +1,19 @@
+import { isGuid } from './validators/isGuid';
+import { recognizedGuid } from './validators/recognizedGuid';
+
+/**
+ * Parses the {@link ODataSavedQuery.savedQuery savedQuery} or
+ * {@link ODataUserQuery.userQuery userQuery} query
+ * @returns Returns `false` when the parse has an error
+ */
+export const getXQueryFromParser = (X, parser, result) => {
+  const value = parser.getAll(X);
+  if (value.length === 0) {
+    return true;
+  }
+  if (!recognizedGuid(value, result) || !isGuid(value, result)) {
+    return false;
+  }
+  result[X] = value[0];
+  return true;
+};

package/lib/esm/index.js

@@ -0,0 +1,9 @@
+export { getExpandFromParser } from './getExpandFromParser';
+export { getFetchXmlFromParser } from './getFetchXmlFromParser';
+export { getOrderByFromParser } from './getOrderByFromParser';
+export { getSelectFromParser } from './getSelectFromParser';
+export { getTopFromParser } from './getTopFromParser';
+export { getXQueryFromParser } from './getXQueryFromParser';
+export { parseOData } from './parseOData';
+import { parseOData } from './parseOData';
+export default parseOData;

package/lib/esm/parseOData.js

@@ -0,0 +1,19 @@
+import { getTopFromParser } from './getTopFromParser';
+import { getSelectFromParser } from './getSelectFromParser';
+import { getExpandFromParser } from './getExpandFromParser';
+import { getFetchXmlFromParser } from './getFetchXmlFromParser';
+import { getXQueryFromParser } from './getXQueryFromParser';
+import { getOrderByFromParser } from './getOrderByFromParser';
+import { getFilterFromParser } from './getFilterFromParser';
+
+/**
+ * parses the OData query and applies some Dataverse validations
+ * @param query The OData query
+ * @returns The parsed OData query
+ */
+export const parseOData = query => {
+  const parser = new URLSearchParams(query);
+  const result = {};
+  getExpandFromParser(parser, result) && getFetchXmlFromParser(parser, result) && getFilterFromParser(parser, result) && getSelectFromParser(parser, result) && getTopFromParser(parser, result) && getXQueryFromParser('savedQuery', parser, result) && getXQueryFromParser('userQuery', parser, result) && getOrderByFromParser(parser, result);
+  return result;
+};

package/lib/esm/validators/atMostOnce.js

@@ -0,0 +1,17 @@
+/**
+ * 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.prototype.getAll URLSearchParams.getAll}
+ * @param result The {@link ODataQuery} to append the error to
+ * @returns {boolean} Returns `false` when the parse has an error
+ */
+export 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;
+};

package/lib/esm/validators/differentFromEmptyString.js

@@ -0,0 +1,16 @@
+/**
+ * 
+ * @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 differentFromEmptyString = (value, result) => {
+  if (value[0] === '') {
+    result.error = {
+      code: '0x80040203',
+      message: 'Expected non-empty string.'
+    };
+    return false;
+  }
+  return true;
+};

package/lib/esm/validators/hasContent.js

@@ -0,0 +1,17 @@
+/**
+ * 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
+ */
+export 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;
+};

package/lib/esm/validators/isGuid.js

@@ -0,0 +1,18 @@
+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
+ */
+export 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;
+};

package/lib/esm/validators/recognizedGuid.js

@@ -0,0 +1,16 @@
+/**
+ * 
+ * @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, result) => {
+  if (!value[0].trim()) {
+    result.error = {
+      code: '0x0',
+      message: 'Unrecognized Guid format.'
+    };
+    return false;
+  }
+  return true;
+};

package/lib/modern/getAliasedProperty.js

@@ -0,0 +1,29 @@
+/**
+ * Recursively gets the value of an aliased property. For example, if the query is `$orderby=@p1` and `@p1=name`, this function will return `name`
+ * @param parser The URLSearchParams object containing the query parameters
+ * @param result Will contain the error details in case there is any
+ * @param property The property to expand
+ * @returns The expanded property or null when there is an error
+ */
+export const getAliasedProperty = (parser, result, property) => {
+  let propertyName = parser.get(property);
+  if (!propertyName) {
+    result.error = {
+      code: '0x80060888',
+      message: 'Order By Property must be of type EdmProperty'
+    };
+    return null;
+  }
+  if (!/^[@a-zA-Z]\w+/gi.test(propertyName)) {
+    const position = propertyName.length;
+    result.error = {
+      code: '0x80060888',
+      message: `Syntax error at position ${position} in '${propertyName}'.`
+    };
+    return null;
+  }
+  if (propertyName.startsWith('@')) {
+    return getAliasedProperty(parser, result, propertyName);
+  }
+  return propertyName;
+};

package/lib/modern/getExpandFromParser.js

@@ -0,0 +1,115 @@
+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 = new RegExp(/\s*(,?)\s*d/).exec(value.substring(matchLength + 1));
+    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/modern/getFetchXmlFromParser.js

@@ -0,0 +1,45 @@
+import { atMostOnce } from './validators/atMostOnce';
+import { differentFromEmptyString } from './validators/differentFromEmptyString';
+const option = 'fetchXml';
+
+/**
+ * Parses the {@link ODataFetch.fetchXml fetchXml} query
+ * @returns Returns `false` when the parse has an error
+ */
+export const getFetchXmlFromParser = (parser, result) => {
+  const value = parser.getAll(option);
+  if (value.length === 0) {
+    return true;
+  }
+  if (!atMostOnce(option, value, result) || !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;
+};