@shko.online/dataverse-odata 0.1.0 → 0.1.2

package/.babelrc.js

@@ -1,161 +1,161 @@
-const withTests = {
-    presets: [
-      [
-        '@babel/preset-env',
-        { shippedProposals: true, useBuiltIns: 'usage', corejs: '3', targets: { node: 'current' } },
-      ],
-    ],
-    plugins: [
-      '@storybook/babel-plugin-require-context-hook',
-      'babel-plugin-dynamic-import-node',
-      '@babel/plugin-transform-runtime',
-    ],
-  };
-  
-  // type BabelMode = 'cjs' | 'esm' | 'modern';
-  
-  const modules = process.env.BABEL_MODE === 'cjs' ? 'auto' : false;
-  
-  // FIXME: optional chaining introduced in chrome 80, not supported by wepback4
-  // https://github.com/webpack/webpack/issues/10227#issuecomment-642734920
-  const targets = process.env.BABEL_MODE === 'modern' ? { chrome: '79' } : 'defaults';
-  
-  module.exports = {
-    ignore: [
-      './lib/codemod/src/transforms/__testfixtures__',
-      './lib/postinstall/src/__testfixtures__',
-      '**/typings.d.ts',
-    ],
-    presets: [
-      [
-        '@babel/preset-env',
-        {
-          shippedProposals: true,
-          useBuiltIns: 'usage',
-          corejs: '3',
-          targets,
-          modules,
-        },
-      ],
-      '@babel/preset-typescript',
-      '@babel/preset-react',
-      '@babel/preset-flow',
-    ],
-    plugins: [
-      [
-        '@babel/plugin-proposal-decorators',
-        {
-          legacy: true,
-        },
-      ],
-      ['@babel/plugin-proposal-class-properties', { loose: true }],
-      ['@babel/plugin-proposal-private-methods', { loose: true }],
-      ['@babel/plugin-proposal-private-property-in-object', { loose: true }],
-      '@babel/plugin-proposal-export-default-from',
-      '@babel/plugin-syntax-dynamic-import',
-      ['@babel/plugin-proposal-object-rest-spread', { loose: true, useBuiltIns: true }],
-      'babel-plugin-macros',
-      ['@emotion', { sourceMap: true, autoLabel: 'always' }],
-    ],
-    env: {
-      test: withTests,
-    },
-    overrides: [
-      {
-        test: './examples/vue-kitchen-sink',
-        presets: ['@vue/babel-preset-jsx'],
-        env: {
-          test: withTests,
-        },
-      },
-      {
-        test: './lib',
-        presets: [
-          [
-            '@babel/preset-env',
-            {
-              shippedProposals: true,
-              useBuiltIns: 'usage',
-              corejs: '3',
-              modules,
-              targets,
-            },
-          ],
-          '@babel/preset-react',
-        ],
-        plugins: [
-          ['@babel/plugin-proposal-object-rest-spread', { loose: true, useBuiltIns: true }],
-          '@babel/plugin-proposal-export-default-from',
-          '@babel/plugin-syntax-dynamic-import',
-          ['@babel/plugin-proposal-private-property-in-object', { loose: true }],
-          ['@babel/plugin-proposal-class-properties', { loose: true }],
-          'babel-plugin-macros',
-          ['@emotion', { sourceMap: true, autoLabel: 'always' }],
-          'babel-plugin-add-react-displayname',
-        ],
-        env: {
-          test: withTests,
-        },
-      },
-      {
-        test: [
-          './lib/node-logger',
-          './lib/core',
-          './lib/core-common',
-          './lib/core-server',
-          './lib/builder-webpack4',
-          './lib/builder-webpack5',
-          './lib/codemod',
-          './addons/storyshots',
-          '**/src/server/**',
-          '**/src/bin/**',
-        ],
-        presets: [
-          [
-            '@babel/preset-env',
-            {
-              shippedProposals: true,
-              useBuiltIns: 'usage',
-              targets: {
-                node: '10',
-              },
-              modules,
-              corejs: '3',
-            },
-          ],
-        ],
-        plugins: [
-          '@emotion',
-          'babel-plugin-macros',
-          '@babel/plugin-transform-arrow-functions',
-          '@babel/plugin-transform-shorthand-properties',
-          '@babel/plugin-transform-block-scoping',
-          '@babel/plugin-transform-destructuring',
-          ['@babel/plugin-proposal-private-property-in-object', { loose: true }],
-          ['@babel/plugin-proposal-class-properties', { loose: true }],
-          '@babel/plugin-proposal-object-rest-spread',
-          '@babel/plugin-proposal-export-default-from',
-        ],
-        env: {
-          test: withTests,
-        },
-      },
-      {
-        test: ['**/virtualModuleEntry.template.js'],
-        presets: [
-          [
-            '@babel/preset-env',
-            {
-              shippedProposals: true,
-              useBuiltIns: 'usage',
-              targets: {
-                node: '10',
-              },
-              corejs: '3',
-              modules: false,
-            },
-          ],
-        ],
-      },
-    ],
+const withTests = {
+    presets: [
+      [
+        '@babel/preset-env',
+        { shippedProposals: true, useBuiltIns: 'usage', corejs: '3', targets: { node: 'current' } },
+      ],
+    ],
+    plugins: [
+      '@storybook/babel-plugin-require-context-hook',
+      'babel-plugin-dynamic-import-node',
+      '@babel/plugin-transform-runtime',
+    ],
+  };
+  
+  // type BabelMode = 'cjs' | 'esm' | 'modern';
+  
+  const modules = process.env.BABEL_MODE === 'cjs' ? 'auto' : false;
+  
+  // FIXME: optional chaining introduced in chrome 80, not supported by wepback4
+  // https://github.com/webpack/webpack/issues/10227#issuecomment-642734920
+  const targets = process.env.BABEL_MODE === 'modern' ? { chrome: '79' } : 'defaults';
+  
+  module.exports = {
+    ignore: [
+      './lib/codemod/src/transforms/__testfixtures__',
+      './lib/postinstall/src/__testfixtures__',
+      '**/typings.d.ts',
+    ],
+    presets: [
+      [
+        '@babel/preset-env',
+        {
+          shippedProposals: true,
+          useBuiltIns: 'usage',
+          corejs: '3',
+          targets,
+          modules,
+        },
+      ],
+      '@babel/preset-typescript',
+      '@babel/preset-react',
+      '@babel/preset-flow',
+    ],
+    plugins: [
+      [
+        '@babel/plugin-proposal-decorators',
+        {
+          legacy: true,
+        },
+      ],
+      ['@babel/plugin-proposal-class-properties', { loose: true }],
+      ['@babel/plugin-proposal-private-methods', { loose: true }],
+      ['@babel/plugin-proposal-private-property-in-object', { loose: true }],
+      '@babel/plugin-proposal-export-default-from',
+      '@babel/plugin-syntax-dynamic-import',
+      ['@babel/plugin-proposal-object-rest-spread', { loose: true, useBuiltIns: true }],
+      'babel-plugin-macros',
+      ['@emotion', { sourceMap: true, autoLabel: 'always' }],
+    ],
+    env: {
+      test: withTests,
+    },
+    overrides: [
+      {
+        test: './examples/vue-kitchen-sink',
+        presets: ['@vue/babel-preset-jsx'],
+        env: {
+          test: withTests,
+        },
+      },
+      {
+        test: './lib',
+        presets: [
+          [
+            '@babel/preset-env',
+            {
+              shippedProposals: true,
+              useBuiltIns: 'usage',
+              corejs: '3',
+              modules,
+              targets,
+            },
+          ],
+          '@babel/preset-react',
+        ],
+        plugins: [
+          ['@babel/plugin-proposal-object-rest-spread', { loose: true, useBuiltIns: true }],
+          '@babel/plugin-proposal-export-default-from',
+          '@babel/plugin-syntax-dynamic-import',
+          ['@babel/plugin-proposal-private-property-in-object', { loose: true }],
+          ['@babel/plugin-proposal-class-properties', { loose: true }],
+          'babel-plugin-macros',
+          ['@emotion', { sourceMap: true, autoLabel: 'always' }],
+          'babel-plugin-add-react-displayname',
+        ],
+        env: {
+          test: withTests,
+        },
+      },
+      {
+        test: [
+          './lib/node-logger',
+          './lib/core',
+          './lib/core-common',
+          './lib/core-server',
+          './lib/builder-webpack4',
+          './lib/builder-webpack5',
+          './lib/codemod',
+          './addons/storyshots',
+          '**/src/server/**',
+          '**/src/bin/**',
+        ],
+        presets: [
+          [
+            '@babel/preset-env',
+            {
+              shippedProposals: true,
+              useBuiltIns: 'usage',
+              targets: {
+                node: '10',
+              },
+              modules,
+              corejs: '3',
+            },
+          ],
+        ],
+        plugins: [
+          '@emotion',
+          'babel-plugin-macros',
+          '@babel/plugin-transform-arrow-functions',
+          '@babel/plugin-transform-shorthand-properties',
+          '@babel/plugin-transform-block-scoping',
+          '@babel/plugin-transform-destructuring',
+          ['@babel/plugin-proposal-private-property-in-object', { loose: true }],
+          ['@babel/plugin-proposal-class-properties', { loose: true }],
+          '@babel/plugin-proposal-object-rest-spread',
+          '@babel/plugin-proposal-export-default-from',
+        ],
+        env: {
+          test: withTests,
+        },
+      },
+      {
+        test: ['**/virtualModuleEntry.template.js'],
+        presets: [
+          [
+            '@babel/preset-env',
+            {
+              shippedProposals: true,
+              useBuiltIns: 'usage',
+              targets: {
+                node: '10',
+              },
+              corejs: '3',
+              modules: false,
+            },
+          ],
+        ],
+      },
+    ],
   };

package/.releaserc.yaml

@@ -0,0 +1,23 @@
+plugins:
+  - '@semantic-release/commit-analyzer'
+  - '@semantic-release/release-notes-generator'
+  - '@semantic-release/changelog'
+  - '@semantic-release/npm'
+  - '@semantic-release/exec'
+  - - '@semantic-release/git'
+    - assets:
+        - package.json
+        - CHANGELOG.md
+      message: |-
+        chore(release): ${nextRelease.version} [skip ci]
+
+        ${nextRelease.notes}
+branches:
+  - '+([0-9])?(.{+([0-9]),x}).x'
+  - main
+  - next
+  - next-major
+  - name: beta
+    prerelease: true
+  - name: alpha
+    prerelease: true

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [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)
+
+
+### Bug Fixes
+
+* improved documentation and type exports ([26c0b2f](https://github.com/shko-online/dataverse-odata/commit/26c0b2f8f6146007ed4f51a03ae64adbd3cf6ca5))

package/README.md

@@ -0,0 +1,3 @@
+# @shko.online/dataverse-odata
+This package will help parse OData strings (only the Microsoft Dataverse subset). It can be used as a validator, or you can build a javascript library which consumes the output of this library. We are using this to mock the `WebAPI` on the `@shko.online/componentframework-mock` package.
+

package/lib/cjs/getExpandFromParser.js

@@ -5,19 +5,19 @@ 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

@@ -4,13 +4,20 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 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

@@ -4,15 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 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;
-/**
- * Parses the $top query
- * @returns Returns true when the parse has an error
+var _validateNotEmpty = require("./validateNotEmpty");
+/**
+ * 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;