@shko.online/dataverse-odata 0.1.2 → 0.1.4

package/.eslintrc.json

@@ -0,0 +1,59 @@
+{
+  "env": {
+      "browser": true,
+      "es2021": true
+  },
+  "extends": [
+      "eslint:recommended",
+      "plugin:react/recommended",
+      "plugin:@typescript-eslint/recommended",
+      "plugin:prettier/recommended",
+      "prettier",
+      "plugin:sonarjs/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+      "ecmaFeatures": {
+          "jsx": true
+      },
+      "ecmaVersion": 12,
+      "sourceType": "module"
+  },
+  "plugins": [
+      "react",
+      "react-hooks",
+      "@typescript-eslint",
+      "prettier",
+      "sonarjs"
+  ],
+  "settings": {
+      "react": {
+        "pragma": "React",
+        "version": "detect"
+      }
+    },
+  "ignorePatterns": ["**/generated/*.ts"],
+  "rules": {
+      "eqeqeq": [2, "smart"],
+      "react-hooks/exhaustive-deps": "warn",
+      "prettier/prettier": "error",
+      "arrow-body-style": "off",
+      "prefer-arrow-callback": "off",
+      "linebreak-style": [
+          "error",
+          "windows"
+      ],
+      "quotes": [
+          "error",
+          "single",
+          {
+            "avoidEscape": true,
+            "allowTemplateLiterals": true
+          }
+      ],
+      "semi": [
+          "error",
+          "always"
+      ]
+  }
+}

package/.prettierrc.json

@@ -0,0 +1,8 @@
+{
+    "semi": true,
+    "trailingComma": "all",
+    "singleQuote": true,
+    "printWidth": 120,
+    "tabWidth": 4,
+    "endOfLine":"auto"    
+  }

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.1.4](https://github.com/shko-online/dataverse-odata/compare/v0.1.3...v0.1.4) (2023-02-12)
+
+
+### Bug Fixes
+
+* added orderby support ([ea3748a](https://github.com/shko-online/dataverse-odata/commit/ea3748a5569d6ce2a086ff14ceb4a99421ecd069))
+
+## [0.1.3](https://github.com/shko-online/dataverse-odata/compare/v0.1.2...v0.1.3) (2023-02-11)
+
+
+### Bug Fixes
+
+* Fixed bundled types ([abbd95b](https://github.com/shko-online/dataverse-odata/commit/abbd95bbc0d118e9c2c20cbeb224025e84e33a9e))
+
 ## [0.1.2](https://github.com/shko-online/dataverse-odata/compare/v0.1.1...v0.1.2) (2023-02-11)
 
 

package/lib/cjs/getExpandFromParser.js

@@ -5,27 +5,34 @@ Object.defineProperty(exports, "__esModule", {
 });
 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 $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 (!(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*/);
+  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;
   }
@@ -63,7 +70,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;
       }
@@ -92,7 +99,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
       };
     }
@@ -106,10 +113,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/cjs/getFetchXmlFromParser.js

@@ -4,47 +4,49 @@ 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 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 (!(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

@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getOrderByFromParser = void 0;
-var _validateNotEmpty = require("./validateNotEmpty");
+var _atMostOnce = require("./validators/atMostOnce");
+var _hasContent = require("./validators/hasContent");
+const option = '$orderby';
 const edmProperty = /\w{1-255}/gi;
 
 /**
@@ -12,33 +14,34 @@ const edmProperty = /\w{1-255}/gi;
  * @returns Returns `false` when the parse has an error
  */
 const getOrderByFromParser = (parser, result) => {
-  let $orderby = parser.get('$orderby');
-  if ($orderby !== null) {
-    if (!(0, _validateNotEmpty.validateNotEmpty)('$orderby', $orderby, 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;
     }
-    $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;
 };
 exports.getOrderByFromParser = getOrderByFromParser;

package/lib/cjs/getSelectFromParser.js

@@ -4,14 +4,23 @@ 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 Returns `false` when the parse has an error
+ * @returns {boolean} Returns `false` when the parse has an error
  */
 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 (!(0, _atMostOnce.atMostOnce)(option, value, result)) {
+    return false;
+  }
+  if (value.length > 0) {
+    result.$select = value[0].split(',');
   }
   return true;
 };

package/lib/cjs/getTopFromParser.js

@@ -4,33 +4,37 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getTopFromParser = void 0;
-var _validateNotEmpty = require("./validateNotEmpty");
+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 $topValue = parser.get('$top');
-  if ($topValue !== null) {
-    if (!(0, _validateNotEmpty.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 (!(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

@@ -4,32 +4,22 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getXQueryFromParser = 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;
-
+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 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 (!(0, _recognizedGuid.recognizedGuid)(value, result) || !(0, _isGuid.isGuid)(value, result)) {
+    return false;
   }
+  result[X] = value[0];
   return true;
 };
 exports.getXQueryFromParser = getXQueryFromParser;

package/lib/cjs/parseOData.js

@@ -9,6 +9,7 @@ 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
@@ -17,24 +18,7 @@ var _getXQueryFromParser = require("./getXQueryFromParser");
 const parseOData = query => {
   const parser = new URLSearchParams(query);
   const result = {};
-  if (!(0, _getExpandFromParser.getExpandFromParser)(parser, result)) {
-    return result;
-  }
-  if (!(0, _getSelectFromParser.getSelectFromParser)(parser, result)) {
-    return result;
-  }
-  if (!(0, _getTopFromParser.getTopFromParser)(parser, result)) {
-    return result;
-  }
-  if (!(0, _getFetchXmlFromParser.getFetchXmlFromParser)(parser, result)) {
-    return result;
-  }
-  if (!(0, _getXQueryFromParser.getXQueryFromParser)('savedQuery', parser, result)) {
-    return result;
-  }
-  if (!(0, _getXQueryFromParser.getXQueryFromParser)('userQuery', parser, result)) {
-    return 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

@@ -0,0 +1,24 @@
+"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

@@ -0,0 +1,23 @@
+"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

@@ -0,0 +1,24 @@
+"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

@@ -0,0 +1,25 @@
+"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

@@ -0,0 +1,23 @@
+"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;