@shko.online/dataverse-odata 0.1.3 → 0.1.4

package/lib/esm/getFetchXmlFromParser.js

@@ -1,43 +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 fetchXml = parser.get('fetchXml');
-  if (fetchXml !== null) {
-    if (fetchXml === '') {
-      result.error = {
-        code: '0x80040203',
-        message: 'Expected non-empty string.'
-      };
-      return false;
-    }
-    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;
+  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;
 };

package/lib/esm/getOrderByFromParser.js

@@ -1,4 +1,6 @@
-import { validateNotEmpty } from './validateNotEmpty';
+import { atMostOnce } from './validators/atMostOnce';
+import { hasContent } from './validators/hasContent';
+const option = '$orderby';
 const edmProperty = /\w{1-255}/gi;
 
 /**
@@ -6,32 +8,33 @@ const edmProperty = /\w{1-255}/gi;
  * @returns Returns `false` when the parse has an error
  */
 export const getOrderByFromParser = (parser, result) => {
-  let $orderby = parser.get('$orderby');
-  if ($orderby !== null) {
-    if (!validateNotEmpty('$orderby', $orderby, 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();
+  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;
     }
-    $orderby = $orderby.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;
   }
+  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;
 };

package/lib/esm/getSelectFromParser.js

@@ -1,11 +1,20 @@
+import { atMostOnce } from './validators/atMostOnce';
+const option = '$select';
+
 /**
  * Parses the {@link ODataSelect.$select $select} query
- * @returns Returns `false` when the parse has an error
+ * @returns {boolean} Returns `false` when the parse has an error
  */
 export const getSelectFromParser = (parser, result) => {
-  const $select = parser.get('$select');
-  if ($select !== null) {
-    result.$select = $select.split(',');
+  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

@@ -1,30 +1,33 @@
-import { validateNotEmpty } from './validateNotEmpty';
+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 $topValue = parser.get('$top');
-  if ($topValue !== null) {
-    if (!validateNotEmpty('$orderby', $topValue, result)) {
-      return false;
-    }
-    let $top;
-    if (!$topValue.match(/^\d+$/) || ($top = parseInt($topValue)) < 0) {
-      result.error = {
-        code: '0x0',
-        message: `Invalid value '${$topValue}' 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;
+  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

@@ -1,4 +1,5 @@
-const guidRegex = /[0-9A-F]{8}\-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}/gi;
+import { isGuid } from './validators/isGuid';
+import { recognizedGuid } from './validators/recognizedGuid';
 
 /**
  * Parses the {@link ODataSavedQuery.savedQuery savedQuery} or
@@ -6,23 +7,13 @@ const guidRegex = /[0-9A-F]{8}\-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}
  * @returns Returns `false` when the parse has an error
  */
 export const getXQueryFromParser = (X, parser, result) => {
-  const xQuery = parser.get(X);
-  if (xQuery !== null) {
-    if (!xQuery.trim()) {
-      result.error = {
-        code: '0x0',
-        message: 'Unrecognized Guid format.'
-      };
-      return false;
-    }
-    if (!xQuery.match(guidRegex)) {
-      result.error = {
-        code: '0x0',
-        message: 'Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).'
-      };
-      return false;
-    }
-    result[X] = xQuery;
+  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/parseOData.js

@@ -3,6 +3,7 @@ import { getSelectFromParser } from './getSelectFromParser';
 import { getExpandFromParser } from './getExpandFromParser';
 import { getFetchXmlFromParser } from './getFetchXmlFromParser';
 import { getXQueryFromParser } from './getXQueryFromParser';
+import { getOrderByFromParser } from './getOrderByFromParser';
 
 /**
  * parses the OData query and applies some Dataverse validations
@@ -12,23 +13,6 @@ import { getXQueryFromParser } from './getXQueryFromParser';
 export const parseOData = query => {
   const parser = new URLSearchParams(query);
   const result = {};
-  if (!getExpandFromParser(parser, result)) {
-    return result;
-  }
-  if (!getSelectFromParser(parser, result)) {
-    return result;
-  }
-  if (!getTopFromParser(parser, result)) {
-    return result;
-  }
-  if (!getFetchXmlFromParser(parser, result)) {
-    return result;
-  }
-  if (!getXQueryFromParser('savedQuery', parser, result)) {
-    return result;
-  }
-  if (!getXQueryFromParser('userQuery', parser, result)) {
-    return result;
-  }
+  getExpandFromParser(parser, result) && getSelectFromParser(parser, result) && getTopFromParser(parser, result) && getFetchXmlFromParser(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.getAll 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/getExpandFromParser.js

@@ -1,25 +1,31 @@
 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 $expand = parser.get('$expand');
-  if ($expand !== null) {
-    result.$expand = {};
-    if (!extractExpand($expand, result)) {
-      return false;
-    }
+  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*/);
+  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: 'invalid expand expression'
+      message: `Term '${value}' is not valid in a $select or $expand expression.`
     };
     return false;
   }
@@ -57,7 +63,7 @@ const extractExpand = (value, $expand) => {
       if (innerExpand.$expand === undefined && innerExpand.$select === undefined) {
         $expand.error = {
           code: '0x0',
-          message: 'Empty expand'
+          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;
       }
@@ -86,7 +92,7 @@ const getClosingBracket = value => {
     const match = value.substring(startAt).match(/\(|\)/);
     if (match === null) {
       return {
-        error: 'no closing bracket found',
+        error: 'Found an unbalanced bracket expression.',
         index: -1
       };
     }
@@ -100,10 +106,10 @@ const getClosingBracket = value => {
     } else {
       depth += 1;
     }
-    startAt = (match.index || 0) + 1;
+    startAt += (match.index || 0) + 1;
   }
   return {
-    error: 'no closing bracket found',
+    error: 'Found an unbalanced bracket expression.',
     index: -1
   };
 };

package/lib/modern/getFetchXmlFromParser.js

@@ -1,43 +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 fetchXml = parser.get('fetchXml');
-  if (fetchXml !== null) {
-    if (fetchXml === '') {
-      result.error = {
-        code: '0x80040203',
-        message: 'Expected non-empty string.'
-      };
-      return false;
-    }
-    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;
+  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;
 };

package/lib/modern/getOrderByFromParser.js

@@ -1,4 +1,6 @@
-import { validateNotEmpty } from './validateNotEmpty';
+import { atMostOnce } from './validators/atMostOnce';
+import { hasContent } from './validators/hasContent';
+const option = '$orderby';
 const edmProperty = /\w{1-255}/gi;
 
 /**
@@ -6,33 +8,34 @@ const edmProperty = /\w{1-255}/gi;
  * @returns Returns `false` when the parse has an error
  */
 export const getOrderByFromParser = (parser, result) => {
-  let $orderby = parser.get('$orderby');
-  if ($orderby !== null) {
-    if (!validateNotEmpty('$orderby', $orderby, 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();
+  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;
     }
-    $orderby = $orderby.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 => {
-      var _orderBy$column;
-      if (!((_orderBy$column = orderBy.column) !== null && _orderBy$column !== void 0 && _orderBy$column.match(edmProperty))) {
-        result.error = {
-          code: '0x80060888',
-          message: 'Order By Property must be of type EdmProperty'
-        };
-        return false;
-      }
-    });
-    result.$orderby = orderByArray;
   }
+  orderByArray.forEach(orderBy => {
+    var _orderBy$column;
+    if (!((_orderBy$column = orderBy.column) !== null && _orderBy$column !== void 0 && _orderBy$column.match(edmProperty))) {
+      result.error = {
+        code: '0x80060888',
+        message: 'Order By Property must be of type EdmProperty'
+      };
+      return false;
+    }
+  });
+  result.$orderby = orderByArray;
   return true;
 };

package/lib/modern/getSelectFromParser.js

@@ -1,11 +1,20 @@
+import { atMostOnce } from './validators/atMostOnce';
+const option = '$select';
+
 /**
  * Parses the {@link ODataSelect.$select $select} query
- * @returns Returns `false` when the parse has an error
+ * @returns {boolean} Returns `false` when the parse has an error
  */
 export const getSelectFromParser = (parser, result) => {
-  const $select = parser.get('$select');
-  if ($select !== null) {
-    result.$select = $select.split(',');
+  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;
 };