@shko.online/dataverse-odata 0.1.4 → 0.1.5

package/.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+end_of_line = lf
+
+[*.{js,json,ts,tsx,vue,svelte,html}]
+indent_style = space
+indent_size = 2

package/.github/workflows/publish.yml

@@ -0,0 +1,44 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Semantic Release
+
+on:
+  push:
+    branches: [ main, beta, alpha ]
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for trusted publishing and npm provenance
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0 # to be able to get all tags for semantic-release
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: "lts/*"
+
+      - name: Update npm
+        run: npm install -g npm@latest
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test
+
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx semantic-release

package/.prettierrc.json

@@ -1,8 +1,8 @@
 {
-    "semi": true,
-    "trailingComma": "all",
-    "singleQuote": true,
-    "printWidth": 120,
-    "tabWidth": 4,
-    "endOfLine":"auto"    
-  }
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 120,
+  "tabWidth": 4,
+  "endOfLine": "auto"
+}

package/.releaserc.yaml

@@ -1,23 +1,23 @@
-plugins:
-  - '@semantic-release/commit-analyzer'
-  - '@semantic-release/release-notes-generator'
-  - '@semantic-release/changelog'
-  - '@semantic-release/npm'
-  - '@semantic-release/exec'
-  - - '@semantic-release/git'
-    - assets:
-        - package.json
-        - CHANGELOG.md
-      message: |-
-        chore(release): ${nextRelease.version} [skip ci]
-
-        ${nextRelease.notes}
-branches:
-  - '+([0-9])?(.{+([0-9]),x}).x'
-  - main
-  - next
-  - next-major
-  - name: beta
-    prerelease: true
-  - name: alpha
-    prerelease: true
+plugins:
+  - '@semantic-release/commit-analyzer'
+  - '@semantic-release/release-notes-generator'
+  - '@semantic-release/changelog'
+  - '@semantic-release/npm'
+  - '@semantic-release/exec'
+  - - '@semantic-release/git'
+    - assets:
+        - package.json
+        - CHANGELOG.md
+      message: |-
+        chore(release): ${nextRelease.version} [skip ci]
+
+        ${nextRelease.notes}
+branches:
+  - '+([0-9])?(.{+([0-9]),x}).x'
+  - main
+  - next
+  - next-major
+  - name: beta
+    prerelease: true
+  - name: alpha
+    prerelease: true

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.1.5](https://github.com/Shko-Online/dataverse-odata/compare/v0.1.4...v0.1.5) (2026-03-15)
+
+
+### Bug Fixes
+
+* Properly implemented $orderBy ([c693298](https://github.com/Shko-Online/dataverse-odata/commit/c693298bcc4cb2a96ebbc39939c60fb5abdd93d4))
+
 ## [0.1.4](https://github.com/shko-online/dataverse-odata/compare/v0.1.3...v0.1.4) (2023-02-12)
 
 

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Betim Beja and Shko Online LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/azure-pipelines.yml

@@ -0,0 +1,32 @@
+pool:
+  vmImage: ubuntu-latest
+
+steps:
+- task: NodeTool@0
+  inputs:
+    versionSpec: '24.x'
+  displayName: 'Install Node.js'
+
+- task: Npm@1
+  inputs:
+    command: 'install'
+  displayName: "Install NPM Dependencies"
+
+- task: Npm@1
+  inputs:
+    command: 'custom'
+    customCommand: 'test'
+  displayName: "Test"
+
+- task: Npm@1
+  inputs:
+    command: 'custom'
+    customCommand: 'run build'
+  displayName: "Build"
+
+- task: PublishCodeCoverageResults@2
+  displayName: "Publish code coverage results"
+  condition: succeededOrFailed()
+  inputs:
+    codeCoverageTool: Cobertura
+    summaryFileLocation: "coverage/cobertura-coverage.xml"

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@shko.online/dataverse-odata",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "This package will help parse OData strings (only the Microsoft Dataverse subset). It can be used as a validator, or you can build some javascript library which consumes the output of this library.",
   "scripts": {
-    "build": "npm run lint && node ../scripts/build.js",
+    "build": "npm run lint && build-npm-package",
     "lint": "eslint",
     "tsc": "tsc --project tsconfig.build.json",
-    "test": "jest --coverage --maxWorkers=4",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
     "semantic-release": "semantic-release"
   },
   "exports": {
@@ -26,7 +27,10 @@
       ]
     }
   },
-  "repository": "https://github.com/shko-online/dataverse-odata",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Shko-Online/dataverse-odata"
+  },
   "keywords": [
     "odata",
     "dataverse",
@@ -55,24 +59,29 @@
     "@babel/preset-typescript": "^7.18.6",
     "@emotion/babel-plugin": "^11.10.5",
     "@jest/globals": "^29.4.2",
-    "@semantic-release/changelog": "^6.0.2",
-    "@semantic-release/commit-analyzer": "^9.0.2",
-    "@semantic-release/exec": "^6.0.3",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/exec": "^7.1.0",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/npm": "^9.0.2",
-    "@semantic-release/release-notes-generator": "^10.0.3",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "@shko.online/build-npm-package": "^0.1.0",
     "@storybook/babel-plugin-require-context-hook": "^1.0.1",
+    "@types/node": "^24.12.0",
     "@typescript-eslint/eslint-plugin": "^5.40.1",
     "@typescript-eslint/parser": "^5.40.1",
     "babel-plugin-dynamic-import-node": "^2.3.3",
     "babel-plugin-macros": "^3.1.0",
     "copyfiles": "^2.4.1",
     "eslint": "^8.25.0",
+    "eslint-plugin-prettier": "^5.5.5",
+    "eslint-plugin-react": "^7.37.5",
     "jest": "^29.2.1",
     "jest-environment-jsdom": "^29.2.1",
-    "semantic-release": "^20.1.0",
+    "prettier": "^3.8.1",
+    "prettier-eslint": "^16.4.2",
+    "semantic-release": "^25.0.3",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
-    "typescript": "^4.8.4"
+    "typescript": "^5.9.3"
   }
 }

package/src/OData.types.d.ts

@@ -30,13 +30,15 @@ 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.
@@ -100,7 +102,20 @@ 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;
@@ -114,15 +129,29 @@ 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 &

package/src/getAliasedProperty.ts

@@ -0,0 +1,34 @@
+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 const getAliasedProperty = (parser: URLSearchParams, result: ODataQuery, property: string): string => {
+    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/src/getExpandFromParser.ts

@@ -77,7 +77,7 @@ const extractExpand = (value: string, $expand: ODataExpand & ODataError) => {
         }
 
         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/src/getFilterFromParser.ts

@@ -0,0 +1,23 @@
+import type { ODataQuery, ODataFilter } from './OData.types';
+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: URLSearchParams, result: ODataQuery): boolean => {
+    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/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;
+};