@shko.online/dataverse-odata 0.1.5 → 0.2.0

package/lib/cjs/index.js

@@ -0,0 +1,56 @@
+"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 = exports.default = _parseOData.parseOData;

package/lib/cjs/parseOData.js

@@ -0,0 +1,25 @@
+"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");
+var _getOrderByFromParser = require("./getOrderByFromParser");
+var _getFilterFromParser = require("./getFilterFromParser");
+/**
+ * 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 = {};
+  (0, _getExpandFromParser.getExpandFromParser)(parser, result) && (0, _getFetchXmlFromParser.getFetchXmlFromParser)(parser, result) && (0, _getFilterFromParser.getFilterFromParser)(parser, result) && (0, _getSelectFromParser.getSelectFromParser)(parser, result) && (0, _getTopFromParser.getTopFromParser)(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.prototype.getAll URLSearchParams.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;

package/lib/esm/getAliasedProperty.js

@@ -0,0 +1,29 @@
+/**
+ * Recursively gets the value of an aliased property. For example, if the query is `$orderby=@p1` and `@p1=name`, this function will return `name`
+ * @param parser The URLSearchParams object containing the query parameters
+ * @param result Will contain the error details in case there is any
+ * @param property The property to expand
+ * @returns The expanded property or null when there is an error
+ */
+export const getAliasedProperty = (parser, result, property) => {
+  let propertyName = parser.get(property);
+  if (!propertyName) {
+    result.error = {
+      code: '0x80060888',
+      message: 'Order By Property must be of type EdmProperty'
+    };
+    return null;
+  }
+  if (!/^[@a-zA-Z]\w+/gi.test(propertyName)) {
+    const position = propertyName.length;
+    result.error = {
+      code: '0x80060888',
+      message: `Syntax error at position ${position} in '${propertyName}'.`
+    };
+    return null;
+  }
+  if (propertyName.startsWith('@')) {
+    return getAliasedProperty(parser, result, propertyName);
+  }
+  return propertyName;
+};

package/lib/esm/getExpandFromParser.js

@@ -0,0 +1,115 @@
+import { getSelectFromParser } from './getSelectFromParser';
+import { atMostOnce } from './validators/atMostOnce';
+const option = '$expand';
+
+/**
+ * Parses the {@link ODataExpand.$expand $expand} query
+ * @returns Returns `false` when the parse has an error
+ */
+export const getExpandFromParser = (parser, result) => {
+  const value = parser.getAll(option);
+  if (value.length === 0) {
+    return true;
+  }
+  if (!atMostOnce(option, value, result)) {
+    return false;
+  }
+  result.$expand = {};
+  if (!extractExpand(value[0], 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: `Term '${value}' is not valid in a $select or $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: `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;
+      }
+      $expand.$expand[match[1]] = innerExpand;
+    }
+    matchLength = matchLength + index;
+    const secondMatch = new RegExp(/\s*(,?)\s*d/).exec(value.substring(matchLength + 1));
+    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: 'Found an unbalanced bracket expression.',
+        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: 'Found an unbalanced bracket expression.',
+    index: -1
+  };
+};

package/lib/esm/getFetchXmlFromParser.js

@@ -0,0 +1,45 @@
+import { atMostOnce } from './validators/atMostOnce';
+import { differentFromEmptyString } from './validators/differentFromEmptyString';
+const option = 'fetchXml';
+
+/**
+ * Parses the {@link ODataFetch.fetchXml fetchXml} query
+ * @returns Returns `false` when the parse has an error
+ */
+export const getFetchXmlFromParser = (parser, result) => {
+  const value = parser.getAll(option);
+  if (value.length === 0) {
+    return true;
+  }
+  if (!atMostOnce(option, value, result) || !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;
+};

package/lib/esm/getFilterFromParser.js

@@ -0,0 +1,250 @@
+import { atMostOnce } from './validators/atMostOnce';
+import { hasContent } from './validators/hasContent';
+const option = '$filter';
+const STANDARD_OPERATORS = ['eq', 'ne', 'gt', 'ge', 'lt', 'le'];
+const QUERY_FUNCTION_OPERATORS = ['contains', 'endswith', 'startswith'];
+function isStandardOperator(s) {
+  return STANDARD_OPERATORS.includes(s);
+}
+function isQueryFunctionOperator(s) {
+  return QUERY_FUNCTION_OPERATORS.includes(s);
+}
+const GUID_REGEX = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/;
+function tokenize(input) {
+  const tokens = [];
+  let i = 0;
+  while (i < input.length) {
+    if (/\s/.test(input[i])) {
+      i++;
+      continue;
+    }
+    if (input[i] === '(') {
+      tokens.push({
+        type: 'lparen',
+        value: '('
+      });
+      i++;
+    } else if (input[i] === ')') {
+      tokens.push({
+        type: 'rparen',
+        value: ')'
+      });
+      i++;
+    } else if (input[i] === ',') {
+      tokens.push({
+        type: 'comma',
+        value: ','
+      });
+      i++;
+    } else if (input[i] === "'") {
+      let j = i + 1;
+      let str = '';
+      while (j < input.length) {
+        if (input[j] === "'" && j + 1 < input.length && input[j + 1] === "'") {
+          str += "'";
+          j += 2;
+        } else if (input[j] === "'") {
+          break;
+        } else {
+          str += input[j];
+          j++;
+        }
+      }
+      tokens.push({
+        type: 'string',
+        value: str
+      });
+      i = j + 1;
+    } else if (/[0-9a-fA-F]/.test(input[i]) && GUID_REGEX.test(input.slice(i))) {
+      tokens.push({
+        type: 'string',
+        value: input.slice(i, i + 36)
+      });
+      i += 36;
+    } else if (/[0-9]/.test(input[i]) || input[i] === '-' && /[0-9]/.test(input[i + 1] ?? '')) {
+      let j = i;
+      if (input[j] === '-') j++;
+      while (j < input.length && /[0-9.]/.test(input[j])) j++;
+      tokens.push({
+        type: 'number',
+        value: input.slice(i, j)
+      });
+      i = j;
+    } else if (/[a-zA-Z_]/.test(input[i])) {
+      let j = i;
+      while (j < input.length && /[a-zA-Z0-9_]/.test(input[j])) j++;
+      tokens.push({
+        type: 'word',
+        value: input.slice(i, j)
+      });
+      i = j;
+    } else {
+      i++;
+    }
+  }
+  return tokens;
+}
+class FilterParser {
+  constructor(tokens) {
+    this.tokens = void 0;
+    this.pos = 0;
+    this.tokens = tokens;
+  }
+  peek() {
+    return this.tokens[this.pos] ?? null;
+  }
+  consume(expected) {
+    const token = this.tokens[this.pos++];
+    if (!token) throw new Error(`Unexpected end of filter expression${expected ? `, expected ${expected}` : ''}`);
+    return token;
+  }
+  expect(type, value) {
+    const token = this.consume(`${type}${value ? ` '${value}'` : ''}`);
+    if (token.type !== type || value !== undefined && token.value !== value) {
+      throw new Error(`Expected ${type}${value ? ` '${value}'` : ''} but got ${token.type} '${token.value}'`);
+    }
+    return token;
+  }
+  parse() {
+    const expr = this.parseOr();
+    if (this.pos < this.tokens.length) {
+      throw new Error(`Unexpected token '${this.tokens[this.pos].value}'`);
+    }
+    return expr;
+  }
+  parseOr() {
+    let left = this.parseAnd();
+    while (this.peek()?.value === 'or') {
+      this.consume();
+      const right = this.parseAnd();
+      left = {
+        operator: 'or',
+        left,
+        right
+      };
+    }
+    return left;
+  }
+  parseAnd() {
+    let left = this.parseNot();
+    while (this.peek()?.value === 'and') {
+      this.consume();
+      const right = this.parseNot();
+      left = {
+        operator: 'and',
+        left,
+        right
+      };
+    }
+    return left;
+  }
+  parseNot() {
+    if (this.peek()?.value === 'not') {
+      this.consume();
+      const right = this.parseNot();
+      return {
+        operator: 'not',
+        right
+      };
+    }
+    return this.parsePrimary();
+  }
+  parsePrimary() {
+    const token = this.peek();
+    if (!token) throw new Error('Unexpected end of filter expression');
+    if (token.type === 'lparen') {
+      this.consume();
+      const expr = this.parseOr();
+      this.expect('rparen');
+      return expr;
+    }
+    if (token.type === 'word' && isQueryFunctionOperator(token.value.toLowerCase())) {
+      const func = this.consume().value.toLowerCase();
+      this.expect('lparen');
+      const left = this.expect('word').value;
+      this.expect('comma');
+      const right = this.expect('string').value;
+      this.expect('rparen');
+      return {
+        operator: func,
+        left,
+        right
+      };
+    }
+    if (token.type === 'word') {
+      const left = this.consume().value;
+      const opToken = this.consume(`a comparison operator`);
+      if (!isStandardOperator(opToken.value.toLowerCase())) {
+        throw new Error(`Invalid operator '${opToken.value}'`);
+      }
+      const operator = opToken.value.toLowerCase();
+      const right = this.consume(`a value or column name`);
+      if (right.type === 'string') {
+        return {
+          operator,
+          left,
+          right: right.value
+        };
+      } else if (right.type === 'number') {
+        return {
+          operator,
+          left,
+          right: Number(right.value)
+        };
+      } else if (right.type === 'word') {
+        // Constant keywords stay as StandardOperator; bare identifiers are column comparisons
+        const BOOL_CONSTANTS = ['true', 'false'];
+        if (BOOL_CONSTANTS.includes(right.value.toLowerCase())) {
+          return {
+            operator,
+            left,
+            isBooleanOperation: true,
+            right: right.value === 'true'
+          };
+        } else if (right.value.toLowerCase() === 'null') {
+          return {
+            operator,
+            left,
+            isNullOperation: true,
+            right: null
+          };
+        }
+        return {
+          left,
+          operator,
+          isColumnOperation: true,
+          right: right.value
+        };
+      } else {
+        throw new Error(`Invalid right-hand side value of type '${right.type}' in filter expression`);
+      }
+    }
+    throw new Error(`Unexpected token '${token.value}'`);
+  }
+}
+
+/**
+ * Parses the {@link ODataFilter.$filter $filter} query
+ * @returns {boolean} Returns `false` when the parse has an error
+ */
+export const getFilterFromParser = (parser, result) => {
+  const value = parser.getAll(option);
+  if (value.length === 0) {
+    return true;
+  }
+  if (!atMostOnce(option, value, result) || !hasContent(option, value, result)) {
+    return false;
+  }
+  try {
+    const tokens = tokenize(value[0]);
+    const p = new FilterParser(tokens);
+    result.$filter = p.parse();
+  } catch (e) {
+    result.error = {
+      code: '0x80060888',
+      message: `Syntax error in '$filter': ${e.message}`
+    };
+    return false;
+  }
+  return true;
+};