@shko.online/dataverse-odata 0.1.1 → 0.1.2

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.1.2](https://github.com/shko-online/dataverse-odata/compare/v0.1.1...v0.1.2) (2023-02-11)
+
+
+### Bug Fixes
+
+* Improved documentation ([720fb93](https://github.com/shko-online/dataverse-odata/commit/720fb93a6d330ea51ba262019543519a6255af02))
+
 ## [0.1.1](https://github.com/shko-online/dataverse-odata/compare/v0.1.0...v0.1.1) (2023-02-11)
 
 

package/lib/cjs/getExpandFromParser.js

@@ -6,18 +6,18 @@ Object.defineProperty(exports, "__esModule", {
 exports.getExpandFromParser = void 0;
 var _getSelectFromParser = require("./getSelectFromParser");
 /**
- * Parses the $expand query
- * @returns Returns true when the parse has an error
+ * 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 true;
+    if (!extractExpand($expand, result)) {
+      return false;
     }
   }
-  return false;
+  return true;
 };
 exports.getExpandFromParser = getExpandFromParser;
 const extractExpand = (value, $expand) => {
@@ -27,7 +27,7 @@ const extractExpand = (value, $expand) => {
       code: '0x0',
       message: 'invalid expand expression'
     };
-    return true;
+    return false;
   }
   let matchSeparator = match[3];
   let matchLength = match[0].length;
@@ -47,25 +47,25 @@ const extractExpand = (value, $expand) => {
         code: '0x0',
         message: error
       };
-      return true;
+      return false;
     }
     if ($expand.$expand !== undefined) {
       const innerExpand = {};
       const parser = new URLSearchParams('?' + value.substring(matchLength, matchLength + index));
-      if ((0, _getSelectFromParser.getSelectFromParser)(parser, innerExpand)) {
+      if (!(0, _getSelectFromParser.getSelectFromParser)(parser, innerExpand)) {
         $expand.error = innerExpand.error;
-        return true;
+        return false;
       }
-      if (getExpandFromParser(parser, innerExpand)) {
+      if (!getExpandFromParser(parser, innerExpand)) {
         $expand.error = innerExpand.error;
-        return true;
+        return false;
       }
       if (innerExpand.$expand === undefined && innerExpand.$select === undefined) {
         $expand.error = {
           code: '0x0',
           message: 'Empty expand'
         };
-        return true;
+        return false;
       }
       $expand.$expand[match[1]] = innerExpand;
     }
@@ -79,11 +79,11 @@ const extractExpand = (value, $expand) => {
     }
   }
   if (matchSeparator === ',') {
-    if (extractExpand(value.substring(matchLength), $expand)) {
-      return true;
+    if (!extractExpand(value.substring(matchLength), $expand)) {
+      return false;
     }
   }
-  return false;
+  return true;
 };
 const getClosingBracket = value => {
   let depth = 1;

package/lib/cjs/getFetchXmlFromParser.js

@@ -5,12 +5,19 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getFetchXmlFromParser = void 0;
 /**
- * Parses the fetchXml query
- * @returns Returns true when the parse has an error
+ * 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') {
@@ -18,7 +25,7 @@ const getFetchXmlFromParser = (parser, result) => {
         code: '0x80040201',
         message: 'Invalid XML.'
       };
-      return true;
+      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')) {
@@ -26,7 +33,7 @@ const getFetchXmlFromParser = (parser, result) => {
         code: '0x80041102',
         message: 'Entity Name was not specified in FetchXml String.'
       };
-      return true;
+      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) {
@@ -34,10 +41,10 @@ const getFetchXmlFromParser = (parser, result) => {
         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 true;
+      return false;
     }
     result.fetchXml = fetchXmlDocument;
   }
-  return false;
+  return true;
 };
 exports.getFetchXmlFromParser = getFetchXmlFromParser;

package/lib/cjs/getOrderByFromParser.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getOrderByFromParser = void 0;
+var _validateNotEmpty = require("./validateNotEmpty");
+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 $orderby = parser.get('$orderby');
+  if ($orderby !== null) {
+    if (!(0, _validateNotEmpty.validateNotEmpty)('$orderby', $orderby, result)) {
+      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;
+  }
+  return true;
+};
+exports.getOrderByFromParser = getOrderByFromParser;

package/lib/cjs/getSelectFromParser.js

@@ -5,14 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getSelectFromParser = void 0;
 /**
- * Parses the $select query
- * @returns Returns true when the parse has an error
+ * Parses the {@link ODataSelect.$select $select} query
+ * @returns Returns `false` when the parse has an error
  */
 const getSelectFromParser = (parser, result) => {
   const $select = parser.get('$select');
   if ($select !== null) {
     result.$select = $select.split(',');
   }
-  return false;
+  return true;
 };
 exports.getSelectFromParser = getSelectFromParser;

package/lib/cjs/getTopFromParser.js

@@ -4,29 +4,33 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getTopFromParser = void 0;
+var _validateNotEmpty = require("./validateNotEmpty");
 /**
- * Parses the $top query
- * @returns Returns true when the parse has an error
+ * 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 true;
+      return false;
     } else if ($top === 0) {
       result.error = {
         code: '0x0',
         message: `Invalid value for $top query option.`
       };
-      return true;
+      return false;
     }
     result.$top = $top;
   }
-  return false;
+  return true;
 };
 exports.getTopFromParser = getTopFromParser;

package/lib/cjs/getXQueryFromParser.js

@@ -0,0 +1,35 @@
+"use strict";
+
+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;
+
+/**
+ * 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;
+  }
+  return true;
+};
+exports.getXQueryFromParser = getXQueryFromParser;

package/lib/cjs/index.js

@@ -4,12 +4,54 @@ 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

@@ -8,6 +8,7 @@ var _getTopFromParser = require("./getTopFromParser");
 var _getSelectFromParser = require("./getSelectFromParser");
 var _getExpandFromParser = require("./getExpandFromParser");
 var _getFetchXmlFromParser = require("./getFetchXmlFromParser");
+var _getXQueryFromParser = require("./getXQueryFromParser");
 /**
  * parses the OData query and applies some Dataverse validations
  * @param query The OData query
@@ -16,16 +17,22 @@ var _getFetchXmlFromParser = require("./getFetchXmlFromParser");
 const parseOData = query => {
   const parser = new URLSearchParams(query);
   const result = {};
-  if ((0, _getExpandFromParser.getExpandFromParser)(parser, result)) {
+  if (!(0, _getExpandFromParser.getExpandFromParser)(parser, result)) {
     return result;
   }
-  if ((0, _getSelectFromParser.getSelectFromParser)(parser, result)) {
+  if (!(0, _getSelectFromParser.getSelectFromParser)(parser, result)) {
     return result;
   }
-  if ((0, _getTopFromParser.getTopFromParser)(parser, result)) {
+  if (!(0, _getTopFromParser.getTopFromParser)(parser, result)) {
     return result;
   }
-  if ((0, _getFetchXmlFromParser.getFetchXmlFromParser)(parser, 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;
   }
   return result;

package/lib/cjs/validateNotEmpty.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.validateNotEmpty = void 0;
+const validateNotEmpty = (query, value, result) => {
+  if (!value.trim()) {
+    result.error = {
+      code: '0x0',
+      message: `The value for OData query '${query}' cannot be empty.`
+    };
+    return false;
+  }
+  return true;
+};
+exports.validateNotEmpty = validateNotEmpty;

package/lib/esm/getExpandFromParser.js

@@ -1,18 +1,18 @@
 import { getSelectFromParser } from './getSelectFromParser';
 
 /**
- * Parses the $expand query
- * @returns Returns true when the parse has an error
+ * 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 true;
+    if (!extractExpand($expand, result)) {
+      return false;
     }
   }
-  return false;
+  return true;
 };
 const extractExpand = (value, $expand) => {
   const match = value.match(/^\s*(\w(\w|\d|_)*)\s*(,|\()?\s*/);
@@ -21,7 +21,7 @@ const extractExpand = (value, $expand) => {
       code: '0x0',
       message: 'invalid expand expression'
     };
-    return true;
+    return false;
   }
   let matchSeparator = match[3];
   let matchLength = match[0].length;
@@ -41,25 +41,25 @@ const extractExpand = (value, $expand) => {
         code: '0x0',
         message: error
       };
-      return true;
+      return false;
     }
     if ($expand.$expand !== undefined) {
       const innerExpand = {};
       const parser = new URLSearchParams('?' + value.substring(matchLength, matchLength + index));
-      if (getSelectFromParser(parser, innerExpand)) {
+      if (!getSelectFromParser(parser, innerExpand)) {
         $expand.error = innerExpand.error;
-        return true;
+        return false;
       }
-      if (getExpandFromParser(parser, innerExpand)) {
+      if (!getExpandFromParser(parser, innerExpand)) {
         $expand.error = innerExpand.error;
-        return true;
+        return false;
       }
       if (innerExpand.$expand === undefined && innerExpand.$select === undefined) {
         $expand.error = {
           code: '0x0',
           message: 'Empty expand'
         };
-        return true;
+        return false;
       }
       $expand.$expand[match[1]] = innerExpand;
     }
@@ -73,11 +73,11 @@ const extractExpand = (value, $expand) => {
     }
   }
   if (matchSeparator === ',') {
-    if (extractExpand(value.substring(matchLength), $expand)) {
-      return true;
+    if (!extractExpand(value.substring(matchLength), $expand)) {
+      return false;
     }
   }
-  return false;
+  return true;
 };
 const getClosingBracket = value => {
   let depth = 1;

package/lib/esm/getFetchXmlFromParser.js

@@ -1,10 +1,17 @@
 /**
- * Parses the fetchXml query
- * @returns Returns true when the parse has an error
+ * 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') {
@@ -12,7 +19,7 @@ export const getFetchXmlFromParser = (parser, result) => {
         code: '0x80040201',
         message: 'Invalid XML.'
       };
-      return true;
+      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')) {
@@ -20,7 +27,7 @@ export const getFetchXmlFromParser = (parser, result) => {
         code: '0x80041102',
         message: 'Entity Name was not specified in FetchXml String.'
       };
-      return true;
+      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) {
@@ -28,9 +35,9 @@ export const getFetchXmlFromParser = (parser, result) => {
         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 true;
+      return false;
     }
     result.fetchXml = fetchXmlDocument;
   }
-  return false;
+  return true;
 };

package/lib/esm/getOrderByFromParser.js

@@ -0,0 +1,37 @@
+import { validateNotEmpty } from './validateNotEmpty';
+const edmProperty = /\w{1-255}/gi;
+
+/**
+ * Parses the {@link ODataOrderBy.$orderby $orderby} query
+ * @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)) {
+      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;
+  }
+  return true;
+};

package/lib/esm/getSelectFromParser.js

@@ -1,11 +1,11 @@
 /**
- * Parses the $select query
- * @returns Returns true when the parse has an error
+ * Parses the {@link ODataSelect.$select $select} query
+ * @returns 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(',');
   }
-  return false;
+  return true;
 };

package/lib/esm/getTopFromParser.js

@@ -1,25 +1,30 @@
+import { validateNotEmpty } from './validateNotEmpty';
+
 /**
- * Parses the $top query
- * @returns Returns true when the parse has an error
+ * 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 true;
+      return false;
     } else if ($top === 0) {
       result.error = {
         code: '0x0',
         message: `Invalid value for $top query option.`
       };
-      return true;
+      return false;
     }
     result.$top = $top;
   }
-  return false;
+  return true;
 };

package/lib/esm/getXQueryFromParser.js

@@ -0,0 +1,28 @@
+const guidRegex = /[0-9A-F]{8}\-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}/gi;
+
+/**
+ * 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 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;
+  }
+  return true;
+};

package/lib/esm/index.js

@@ -1,3 +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;