@shko.online/dataverse-odata 0.1.4 → 0.1.6

package/src/getOrderByFromParser.ts

@@ -1,9 +1,9 @@
+import { getAliasedProperty } from './getAliasedProperty';
 import type { ODataQuery, ODataOrderBy } from './OData.types';
 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
@@ -18,27 +18,63 @@ export const getOrderByFromParser = (parser: URLSearchParams, result: ODataQuery
         return false;
     }
     let $orderby = value[0].trimEnd();
+    let $orderbyParts = $orderby.split(',');
     const orderByArray: ODataOrderBy['$orderby'] = [];
-    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) => {
-        if (!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: 'Order By Property must be of type EdmProperty',
+                message: `Syntax error at position ${position} in '${$orderby}'.`,
             };
             return false;
         }
-    });
+
+        const orderBy: ODataOrderBy['$orderby'][0] = {
+            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: `Syntax error at position ${position} in '${$orderby}'.`,
+            };
+            return false;
+        }
+    }
 
     result.$orderby = orderByArray;
 

package/src/parseOData.ts

@@ -6,6 +6,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
@@ -17,9 +18,10 @@ export const parseOData = (query: string) => {
     const result = {} as ODataQuery;
 
     getExpandFromParser(parser, result) &&
+        getFetchXmlFromParser(parser, result) &&
+        getFilterFromParser(parser, result) &&
         getSelectFromParser(parser, result) &&
         getTopFromParser(parser, result) &&
-        getFetchXmlFromParser(parser, result) &&
         getXQueryFromParser('savedQuery', parser, result) &&
         getXQueryFromParser('userQuery', parser, result) &&
         getOrderByFromParser(parser, result);

package/src/validators/atMostOnce.ts

@@ -1,19 +1,19 @@
-import type { 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 result The {@link ODataQuery} to append the error to
- * @returns {boolean} Returns `false` when the parse has an error
- */
-export const atMostOnce = (option: string, value: string[], result: ODataQuery) => {
-    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;
-};
+import type { 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.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: string, value: string[], result: ODataQuery) => {
+    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;
+};

package/src/validators/differentFromEmptyString.ts

@@ -1,18 +1,18 @@
-import type { ODataQuery } from '../OData.types';
-
-/**
- * 
- * @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: string[], result: ODataQuery) => {
-    if (value[0] === '') {
-        result.error = {
-            code: '0x80040203',
-            message: 'Expected non-empty string.',
-        };
-        return false;
-    }
-    return true;
-};
+import type { ODataQuery } from '../OData.types';
+
+/**
+ * 
+ * @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: string[], result: ODataQuery) => {
+    if (value[0] === '') {
+        result.error = {
+            code: '0x80040203',
+            message: 'Expected non-empty string.',
+        };
+        return false;
+    }
+    return true;
+};

package/src/validators/hasContent.ts

@@ -1,19 +1,19 @@
-import type { 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 result The {@link ODataQuery} to append the error to
- * @returns {boolean} Returns `false` when the parse has an error
- */
-export const hasContent = (query: string, value: string[], result: ODataQuery) => {
-    if (!value[0].trim()) {
-        result.error = {
-            code: '0x0',
-            message: `The value for OData query '${query}' cannot be empty.`,
-        };
-        return false;
-    }
-    return true;
-};
+import type { 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 result The {@link ODataQuery} to append the error to
+ * @returns {boolean} Returns `false` when the parse has an error
+ */
+export const hasContent = (query: string, value: string[], result: ODataQuery) => {
+    if (!value[0].trim()) {
+        result.error = {
+            code: '0x0',
+            message: `The value for OData query '${query}' cannot be empty.`,
+        };
+        return false;
+    }
+    return true;
+};

package/src/validators/isGuid.ts

@@ -1,20 +1,20 @@
-import type { ODataQuery } from '../OData.types';
-
-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
- */
-export const isGuid = (value: string[], result: ODataQuery) => {
-    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;
-};
+import type { ODataQuery } from '../OData.types';
+
+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
+ */
+export const isGuid = (value: string[], result: ODataQuery) => {
+    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;
+};

package/src/validators/recognizedGuid.ts

@@ -1,18 +1,18 @@
-import type { ODataQuery } from '../OData.types';
-
-/**
- * 
- * @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: string[], result: ODataQuery) => {
-    if (!value[0].trim()) {
-        result.error = {
-            code: '0x0',
-            message: 'Unrecognized Guid format.',
-        };
-        return false;
-    }
-    return true;
-};
+import type { ODataQuery } from '../OData.types';
+
+/**
+ * 
+ * @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: string[], result: ODataQuery) => {
+    if (!value[0].trim()) {
+        result.error = {
+            code: '0x0',
+            message: 'Unrecognized Guid format.',
+        };
+        return false;
+    }
+    return true;
+};

package/lib/ts3.9/getOrderByFromParser.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getOrderByFromParser.d.ts","sourceRoot":"","sources":["../../src/getOrderByFromParser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAgB,MAAM,eAAe,CAAC;AAO9D;;;GAGG;AACH,eAAO,MAAM,oBAAoB,WAAY,eAAe,UAAU,UAAU,KAAG,OAkClF,CAAC"}