@shko.online/dataverse-odata 0.1.0

package/.babelrc.js

@@ -0,0 +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,
+            },
+          ],
+        ],
+      },
+    ],
+  };

package/jest.config.ts

@@ -0,0 +1,12 @@
+import { JestConfigWithTsJest } from 'ts-jest';
+
+export default {
+  testMatch: [' **/tests/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[tj]s?(x)'],
+  clearMocks: true,
+  collectCoverage: true,
+  coverageDirectory: 'coverage',
+  coverageProvider: 'v8',
+  preset: 'ts-jest',
+  testEnvironment: 'jsdom',
+  coverageReporters: ['cobertura', 'text', 'html']
+} as JestConfigWithTsJest;

package/lib/cjs/OData.types.d.js

@@ -0,0 +1 @@
+"use strict";

package/lib/cjs/getExpandFromParser.js

@@ -0,0 +1,115 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getExpandFromParser = void 0;
+var _getSelectFromParser = require("./getSelectFromParser");
+/**
+ * Parses the $expand query
+ * @returns Returns true 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;
+    }
+  }
+  return false;
+};
+exports.getExpandFromParser = getExpandFromParser;
+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: 'invalid expand expression'
+    };
+    return true;
+  }
+  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 true;
+    }
+    if ($expand.$expand !== undefined) {
+      const innerExpand = {};
+      const parser = new URLSearchParams('?' + value.substring(matchLength, matchLength + index));
+      if ((0, _getSelectFromParser.getSelectFromParser)(parser, innerExpand)) {
+        $expand.error = innerExpand.error;
+        return true;
+      }
+      if (getExpandFromParser(parser, innerExpand)) {
+        $expand.error = innerExpand.error;
+        return true;
+      }
+      if (innerExpand.$expand === undefined && innerExpand.$select === undefined) {
+        $expand.error = {
+          code: '0x0',
+          message: 'Empty expand'
+        };
+        return true;
+      }
+      $expand.$expand[match[1]] = innerExpand;
+    }
+    matchLength = matchLength + index;
+    const secondMatch = value.substring(matchLength + 1).match(/\s*(,?)\s*d/);
+    if (secondMatch !== null) {
+      matchLength = matchLength + secondMatch[0].length;
+      if (secondMatch[1] !== null) {
+        matchSeparator = ',';
+      }
+    }
+  }
+  if (matchSeparator === ',') {
+    if (extractExpand(value.substring(matchLength), $expand)) {
+      return true;
+    }
+  }
+  return false;
+};
+const getClosingBracket = value => {
+  let depth = 1;
+  let startAt = 0;
+  while (depth > 0) {
+    const match = value.substring(startAt).match(/\(|\)/);
+    if (match === null) {
+      return {
+        error: 'no closing bracket found',
+        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: 'no closing bracket found',
+    index: -1
+  };
+};

package/lib/cjs/getFetchXmlFromParser.js

@@ -0,0 +1,43 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getFetchXmlFromParser = void 0;
+/**
+ * Parses the $fetchXml query
+ * @returns Returns true when the parse has an error
+ */
+const getFetchXmlFromParser = (parser, result) => {
+  const fetchXml = parser.get('fetchXml');
+  if (fetchXml !== null) {
+    const serializer = new DOMParser();
+    const fetchXmlDocument = serializer.parseFromString(fetchXml, 'text/xml');
+    if (fetchXmlDocument.documentElement.tagName === 'parsererror') {
+      result.error = {
+        code: '0x80040201',
+        message: 'Invalid XML.'
+      };
+      return true;
+    }
+    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 true;
+    }
+    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 true;
+    }
+    result.fetchXml = fetchXmlDocument;
+  }
+  return false;
+};
+exports.getFetchXmlFromParser = getFetchXmlFromParser;

package/lib/cjs/getSelectFromParser.js

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

package/lib/cjs/getTopFromParser.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getTopFromParser = void 0;
+/**
+ * Parses the $top query
+ * @returns Returns true when the parse has an error
+ */
+const getTopFromParser = (parser, result) => {
+  const $topValue = parser.get('$top');
+  if ($topValue !== null) {
+    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;
+    } else if ($top === 0) {
+      result.error = {
+        code: '0x0',
+        message: `Invalid value for $top query option.`
+      };
+      return true;
+    }
+    result.$top = $top;
+  }
+  return false;
+};
+exports.getTopFromParser = getTopFromParser;

package/lib/cjs/index.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+Object.defineProperty(exports, "parseOData", {
+  enumerable: true,
+  get: function () {
+    return _parseOData.parseOData;
+  }
+});
+var _parseOData = require("./parseOData");
+var _default = _parseOData.parseOData;
+exports.default = _default;

package/lib/cjs/parseOData.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.parseOData = void 0;
+var _getTopFromParser = require("./getTopFromParser");
+var _getSelectFromParser = require("./getSelectFromParser");
+var _getExpandFromParser = require("./getExpandFromParser");
+var _getFetchXmlFromParser = require("./getFetchXmlFromParser");
+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;
+  }
+  return result;
+};
+exports.parseOData = parseOData;

package/lib/esm/getExpandFromParser.js

@@ -0,0 +1,109 @@
+import { getSelectFromParser } from './getSelectFromParser';
+
+/**
+ * Parses the $expand query
+ * @returns Returns true 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;
+    }
+  }
+  return false;
+};
+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: 'invalid expand expression'
+    };
+    return true;
+  }
+  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 true;
+    }
+    if ($expand.$expand !== undefined) {
+      const innerExpand = {};
+      const parser = new URLSearchParams('?' + value.substring(matchLength, matchLength + index));
+      if (getSelectFromParser(parser, innerExpand)) {
+        $expand.error = innerExpand.error;
+        return true;
+      }
+      if (getExpandFromParser(parser, innerExpand)) {
+        $expand.error = innerExpand.error;
+        return true;
+      }
+      if (innerExpand.$expand === undefined && innerExpand.$select === undefined) {
+        $expand.error = {
+          code: '0x0',
+          message: 'Empty expand'
+        };
+        return true;
+      }
+      $expand.$expand[match[1]] = innerExpand;
+    }
+    matchLength = matchLength + index;
+    const secondMatch = value.substring(matchLength + 1).match(/\s*(,?)\s*d/);
+    if (secondMatch !== null) {
+      matchLength = matchLength + secondMatch[0].length;
+      if (secondMatch[1] !== null) {
+        matchSeparator = ',';
+      }
+    }
+  }
+  if (matchSeparator === ',') {
+    if (extractExpand(value.substring(matchLength), $expand)) {
+      return true;
+    }
+  }
+  return false;
+};
+const getClosingBracket = value => {
+  let depth = 1;
+  let startAt = 0;
+  while (depth > 0) {
+    const match = value.substring(startAt).match(/\(|\)/);
+    if (match === null) {
+      return {
+        error: 'no closing bracket found',
+        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: 'no closing bracket found',
+    index: -1
+  };
+};

package/lib/esm/getFetchXmlFromParser.js

@@ -0,0 +1,36 @@
+/**
+ * Parses the $fetchXml query
+ * @returns Returns true when the parse has an error
+ */
+export const getFetchXmlFromParser = (parser, result) => {
+  const fetchXml = parser.get('fetchXml');
+  if (fetchXml !== null) {
+    const serializer = new DOMParser();
+    const fetchXmlDocument = serializer.parseFromString(fetchXml, 'text/xml');
+    if (fetchXmlDocument.documentElement.tagName === 'parsererror') {
+      result.error = {
+        code: '0x80040201',
+        message: 'Invalid XML.'
+      };
+      return true;
+    }
+    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 true;
+    }
+    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 true;
+    }
+    result.fetchXml = fetchXmlDocument;
+  }
+  return false;
+};

package/lib/esm/getSelectFromParser.js

@@ -0,0 +1,11 @@
+/**
+ * Parses the $select query
+ * @returns Returns true 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;
+};

package/lib/esm/getTopFromParser.js

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

package/lib/esm/index.js

@@ -0,0 +1,3 @@
+export { parseOData } from './parseOData';
+import { parseOData } from './parseOData';
+export default parseOData;

package/lib/esm/parseOData.js

@@ -0,0 +1,21 @@
+import { getTopFromParser } from './getTopFromParser';
+import { getSelectFromParser } from './getSelectFromParser';
+import { getExpandFromParser } from './getExpandFromParser';
+import { getFetchXmlFromParser } from './getFetchXmlFromParser';
+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;
+  }
+  return result;
+};

package/lib/getExpandFromParser.d.ts

@@ -0,0 +1,7 @@
+import type { ODataQuery } from './OData.types';
+/**
+ * Parses the $expand query
+ * @returns Returns true when the parse has an error
+ */
+export declare const getExpandFromParser: (parser: URLSearchParams, result: ODataQuery) => boolean;
+//# sourceMappingURL=getExpandFromParser.d.ts.map

package/lib/getExpandFromParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExpandFromParser.d.ts","sourceRoot":"","sources":["../src/getExpandFromParser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAA6C,UAAU,EAAE,MAAM,eAAe,CAAC;AAG3F;;;GAGG;AACH,eAAO,MAAM,mBAAmB,WAAY,eAAe,UAAU,UAAU,KAAG,OAUjF,CAAC"}