@shko.online/dataverse-odata 0.1.4 → 0.1.6

package/lib/esm/validators/hasContent.js

@@ -1,9 +1,9 @@
-/**
- * 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
+/**
+ * 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
  */
 export const hasContent = (query, value, result) => {
   if (!value[0].trim()) {

package/lib/esm/validators/isGuid.js

@@ -1,10 +1,10 @@
 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
+/**
+ * 
+ * @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
  */
 export const isGuid = (value, result) => {
   if (!value[0].match(guidRegex)) {

package/lib/esm/validators/recognizedGuid.js

@@ -1,8 +1,8 @@
-/**
- * 
- * @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
+/**
+ * 
+ * @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
  */
 export const recognizedGuid = (value, result) => {
   if (!value[0].trim()) {

package/lib/modern/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/modern/getExpandFromParser.js

@@ -70,7 +70,7 @@ const extractExpand = (value, $expand) => {
       $expand.$expand[match[1]] = innerExpand;
     }
     matchLength = matchLength + index;
-    const secondMatch = value.substring(matchLength + 1).match(/\s*(,?)\s*d/);
+    const secondMatch = new RegExp(/\s*(,?)\s*d/).exec(value.substring(matchLength + 1));
     if (secondMatch !== null) {
       matchLength = matchLength + secondMatch[0].length;
       if (secondMatch[1] !== null) {

package/lib/modern/getFilterFromParser.js

@@ -0,0 +1,24 @@
+import { atMostOnce } from './validators/atMostOnce';
+const option = '$filter';
+
+/**
+ * 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)) {
+    return false;
+  }
+  if (value.length > 0) {
+    result.$filter = {
+      operator: 'eq',
+      left: '',
+      right: ''
+    };
+  }
+  return true;
+};

package/lib/modern/getOrderByFromParser.js

@@ -1,7 +1,8 @@
+import "core-js/modules/esnext.string.match-all.js";
+import { getAliasedProperty } from './getAliasedProperty';
 import { atMostOnce } from './validators/atMostOnce';
 import { hasContent } from './validators/hasContent';
 const option = '$orderby';
-const edmProperty = /\w{1-255}/gi;
 
 /**
  * Parses the {@link ODataOrderBy.$orderby $orderby} query
@@ -16,26 +17,56 @@ export const getOrderByFromParser = (parser, result) => {
     return false;
   }
   let $orderby = value[0].trimEnd();
+  let $orderbyParts = $orderby.split(',');
   const orderByArray = [];
-  for (let i = 0; i < $orderby.length; i++) {
-    if (false /* syntax error */) {
+  let position = 0;
+  for (const element of $orderbyParts) {
+    const parts = Array.from(element.matchAll(/\s*(\S+)/gi));
+    if (parts.length > 2) {
+      position = position + parts[0][0].length + parts[1][0].length + parts[2][0].length;
       result.error = {
-        code: '0x0',
-        message: `Syntax error at position ${i} in '${$orderby}'.`
+        code: '0x80060888',
+        message: `Syntax error at position ${position} in '${$orderby}'.`
       };
       return false;
     }
-  }
-  orderByArray.forEach(orderBy => {
-    var _orderBy$column;
-    if (!((_orderBy$column = orderBy.column) !== null && _orderBy$column !== void 0 && _orderBy$column.match(edmProperty))) {
+    if (!/^[@a-zA-Z]\w+/gi.test(parts[0][1])) {
+      position = position + parts[0][0].length;
+      result.error = {
+        code: '0x80060888',
+        message: `Syntax error at position ${position} in '${$orderby}'.`
+      };
+      return false;
+    }
+    const orderBy = {
+      column: parts[0][1],
+      asc: true // default is ascending
+    };
+    if (parts[0][1].startsWith('@')) {
+      orderBy.column = getAliasedProperty(parser, result, parts[0][1]);
+      if (!orderBy.column) {
+        return false;
+      }
+    }
+    if (parts.length === 1) {
+      orderByArray.push(orderBy);
+      continue;
+    }
+    if (parts[1][1].toLowerCase() === 'asc') {
+      orderBy.asc = true;
+      orderByArray.push(orderBy);
+    } else if (parts[1][1].toLowerCase() === 'desc') {
+      orderBy.asc = false;
+      orderByArray.push(orderBy);
+    } else {
+      position = position + parts[0][0].length + parts[1][0].length;
       result.error = {
         code: '0x80060888',
-        message: 'Order By Property must be of type EdmProperty'
+        message: `Syntax error at position ${position} in '${$orderby}'.`
       };
       return false;
     }
-  });
+  }
   result.$orderby = orderByArray;
   return true;
 };

package/lib/modern/parseOData.js

@@ -4,6 +4,7 @@ import { getExpandFromParser } from './getExpandFromParser';
 import { getFetchXmlFromParser } from './getFetchXmlFromParser';
 import { getXQueryFromParser } from './getXQueryFromParser';
 import { getOrderByFromParser } from './getOrderByFromParser';
+import { getFilterFromParser } from './getFilterFromParser';
 
 /**
  * parses the OData query and applies some Dataverse validations
@@ -13,6 +14,6 @@ import { getOrderByFromParser } from './getOrderByFromParser';
 export const parseOData = query => {
   const parser = new URLSearchParams(query);
   const result = {};
-  getExpandFromParser(parser, result) && getSelectFromParser(parser, result) && getTopFromParser(parser, result) && getFetchXmlFromParser(parser, result) && getXQueryFromParser('savedQuery', parser, result) && getXQueryFromParser('userQuery', parser, result) && getOrderByFromParser(parser, result);
+  getExpandFromParser(parser, result) && getFetchXmlFromParser(parser, result) && getFilterFromParser(parser, result) && getSelectFromParser(parser, result) && getTopFromParser(parser, result) && getXQueryFromParser('savedQuery', parser, result) && getXQueryFromParser('userQuery', parser, result) && getOrderByFromParser(parser, result);
   return result;
 };

package/lib/modern/validators/atMostOnce.js

@@ -1,9 +1,9 @@
-/**
- * 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
+/**
+ * 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
  */
 export const atMostOnce = (option, value, result) => {
   if (value.length > 1) {

package/lib/modern/validators/differentFromEmptyString.js

@@ -1,8 +1,8 @@
-/**
- * 
- * @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
+/**
+ * 
+ * @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
  */
 export const differentFromEmptyString = (value, result) => {
   if (value[0] === '') {

package/lib/modern/validators/hasContent.js

@@ -1,9 +1,9 @@
-/**
- * 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
+/**
+ * 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
  */
 export const hasContent = (query, value, result) => {
   if (!value[0].trim()) {

package/lib/modern/validators/isGuid.js

@@ -1,10 +1,10 @@
 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
+/**
+ * 
+ * @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
  */
 export const isGuid = (value, result) => {
   if (!value[0].match(guidRegex)) {

package/lib/modern/validators/recognizedGuid.js

@@ -1,8 +1,8 @@
-/**
- * 
- * @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
+/**
+ * 
+ * @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
  */
 export const recognizedGuid = (value, result) => {
   if (!value[0].trim()) {

package/lib/ts3.4/OData.types.d.ts

@@ -27,12 +27,13 @@ interface ODataExpand {
 type ODataExpandQuery = ODataSelect & ODataExpand;
 interface ODataFilter {
     /**
-     * Use the {@link ODataFilter.$filter $filter} system query option to set criteria for which rows will be returned.
+     * Use the {@link $filter $filter} system query option to set criteria for which rows will be returned.
      *
      * * Microsoft Docs: {@link https://learn.microsoft.com/power-apps/developer/data-platform/webapi/query-data-web-api?WT.mc_id=DX-MVP-5004767#filter-results Filter results }
      */
-    $filter?: StandardOperator;
+    $filter?: FilterOperator;
 }
+type FilterOperator = StandardOperator | ColumnOperator | UnaryOperator | BinaryOperator | QueryFunctionOperator;
 interface ODataFetch {
     /**
      * You can compose a FetchXML query for a specific table.
@@ -93,7 +94,17 @@ interface ODataUserQuery {
      */
     userQuery?: string;
 }
-type StandardOperators = 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+type StandardEqualityOperators = 'eq' | 'ne';
+type StandardOperators = StandardEqualityOperators | 'gt' | 'ge' | 'lt' | 'le';
+/**
+ *
+ * * Microsoft Docs: {@link https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/query/filter-rows#column-comparison Column comparison }
+ */
+interface ColumnOperator {
+    column: string;
+    operator: StandardOperators;
+    otherColumn: string;
+}
 interface StandardOperator {
     operator: StandardOperators;
     /**
@@ -105,14 +116,26 @@ interface StandardOperator {
      */
     right: string | number;
 }
+type QueryFunctionOperators = 'contains' | 'endswith' | 'startswith';
+interface QueryFunctionOperator {
+    operator: QueryFunctionOperators;
+    /**
+     * The left side of the 'X' operator must be a property of the entity.
+     */
+    left: string;
+    /**
+     * The right side of the 'X' operator must be a constant value.
+     */
+    right: string;
+}
 interface UnaryOperator {
     operator: 'not';
-    right: StandardOperator;
+    right: FilterOperator;
 }
 interface BinaryOperator {
     operator: 'and' | 'or';
-    left: StandardOperator;
-    right: StandardOperator;
+    left: FilterOperator;
+    right: FilterOperator;
 }
 type ODataQuery = ODataError & ODataExpand & ODataFetch & ODataFilter & ODataOrderBy & ODataSavedQuery & ODataSelect & ODataTop & ODataUserQuery;
 export { BinaryOperator, ODataError, ODataExpand, ODataExpandQuery, ODataFetch, ODataFilter, ODataOrderBy, ODataQuery, ODataSavedQuery, ODataSelect, ODataTop, ODataUserQuery, StandardOperator, StandardOperators, UnaryOperator, };

package/lib/ts3.4/getAliasedProperty.d.ts

@@ -0,0 +1,10 @@
+import { ODataQuery } from "./OData.types";
+/**
+ * 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 declare const getAliasedProperty: (parser: URLSearchParams, result: ODataQuery, property: string) => string;
+//# sourceMappingURL=getAliasedProperty.d.ts.map

package/lib/ts3.4/getFilterFromParser.d.ts

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

package/lib/ts3.4/getXQueryFromParser.d.ts

@@ -4,5 +4,5 @@ import { ODataQuery } from './OData.types';
  * {@link ODataUserQuery.userQuery userQuery} query
  * @returns Returns `false` when the parse has an error
  */
-export declare const getXQueryFromParser: (X: 'savedQuery' | 'userQuery', parser: URLSearchParams, result: ODataQuery) => boolean;
+export declare const getXQueryFromParser: (X: "savedQuery" | "userQuery", parser: URLSearchParams, result: ODataQuery) => boolean;
 //# sourceMappingURL=getXQueryFromParser.d.ts.map

package/lib/ts3.4/validators/atMostOnce.d.ts

@@ -2,7 +2,7 @@ import { ODataQuery } from '../OData.types';
 /**
  * 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 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
  */