@shko.online/dataverse-odata 0.1.3 → 0.1.5

package/lib/cjs/getXQueryFromParser.js

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

@@ -1,57 +0,0 @@
-"use strict";
-
-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

@@ -1,40 +0,0 @@
-"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");
-var _getXQueryFromParser = require("./getXQueryFromParser");
-/**
- * parses the OData query and applies some Dataverse validations
- * @param query The OData query
- * @returns The parsed OData query
- */
-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;
-  }
-  return result;
-};
-exports.parseOData = parseOData;

package/lib/cjs/validateNotEmpty.js

@@ -1,17 +0,0 @@
-"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,109 +0,0 @@
-import { getSelectFromParser } from './getSelectFromParser';
-
-/**
- * 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;
-    }
-  }
-  return true;
-};
-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 false;
-  }
-  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 false;
-    }
-    if ($expand.$expand !== undefined) {
-      const innerExpand = {};
-      const parser = new URLSearchParams('?' + value.substring(matchLength, matchLength + index));
-      if (!getSelectFromParser(parser, innerExpand)) {
-        $expand.error = innerExpand.error;
-        return false;
-      }
-      if (!getExpandFromParser(parser, innerExpand)) {
-        $expand.error = innerExpand.error;
-        return false;
-      }
-      if (innerExpand.$expand === undefined && innerExpand.$select === undefined) {
-        $expand.error = {
-          code: '0x0',
-          message: 'Empty expand'
-        };
-        return false;
-      }
-      $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 false;
-    }
-  }
-  return true;
-};
-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

@@ -1,43 +0,0 @@
-/**
- * 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;
-  }
-  return true;
-};

package/lib/esm/getOrderByFromParser.js

@@ -1,37 +0,0 @@
-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 +0,0 @@
-/**
- * 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 true;
-};

package/lib/esm/getTopFromParser.js

@@ -1,30 +0,0 @@
-import { validateNotEmpty } from './validateNotEmpty';
-
-/**
- * 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;
-  }
-  return true;
-};

package/lib/esm/getXQueryFromParser.js

@@ -1,28 +0,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
- */
-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,9 +0,0 @@
-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;

package/lib/esm/parseOData.js

@@ -1,34 +0,0 @@
-import { getTopFromParser } from './getTopFromParser';
-import { getSelectFromParser } from './getSelectFromParser';
-import { getExpandFromParser } from './getExpandFromParser';
-import { getFetchXmlFromParser } from './getFetchXmlFromParser';
-import { getXQueryFromParser } from './getXQueryFromParser';
-
-/**
- * parses the OData query and applies some Dataverse validations
- * @param query The OData query
- * @returns The parsed OData query
- */
-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;
-  }
-  return result;
-};

package/lib/esm/validateNotEmpty.js

@@ -1,10 +0,0 @@
-export 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;
-};

package/lib/modern/getExpandFromParser.js

@@ -1,109 +0,0 @@
-import { getSelectFromParser } from './getSelectFromParser';
-
-/**
- * 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;
-    }
-  }
-  return true;
-};
-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 false;
-  }
-  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 false;
-    }
-    if ($expand.$expand !== undefined) {
-      const innerExpand = {};
-      const parser = new URLSearchParams('?' + value.substring(matchLength, matchLength + index));
-      if (!getSelectFromParser(parser, innerExpand)) {
-        $expand.error = innerExpand.error;
-        return false;
-      }
-      if (!getExpandFromParser(parser, innerExpand)) {
-        $expand.error = innerExpand.error;
-        return false;
-      }
-      if (innerExpand.$expand === undefined && innerExpand.$select === undefined) {
-        $expand.error = {
-          code: '0x0',
-          message: 'Empty expand'
-        };
-        return false;
-      }
-      $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 false;
-    }
-  }
-  return true;
-};
-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/modern/getFetchXmlFromParser.js

@@ -1,43 +0,0 @@
-/**
- * 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;
-  }
-  return true;
-};

package/lib/modern/getOrderByFromParser.js

@@ -1,38 +0,0 @@
-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 => {
-      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 +0,0 @@
-/**
- * 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 true;
-};