@shko.online/dataverse-odata 0.1.0 → 0.1.1

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

@@ -1 +1 @@
-{"version":3,"file":"parseOData.d.ts","sourceRoot":"","sources":["../../src/parseOData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAMhD,eAAO,MAAM,UAAU,UAAW,MAAM,eAgBvC,CAAC"}
+{"version":3,"file":"parseOData.d.ts","sourceRoot":"","sources":["../../src/parseOData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAOhD;;;;GAIG;AACH,eAAO,MAAM,UAAU,UAAW,MAAM,eAgBvC,CAAC"}

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@shko.online/dataverse-odata",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "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",
     "lint": "eslint",
     "tsc": "tsc --project tsconfig.build.json",
-    "test": "jest --coverage --maxWorkers=4"
+    "test": "jest --coverage --maxWorkers=4",
+    "semantic-release": "semantic-release"
   },
   "exports": {
     ".": {
@@ -25,10 +26,7 @@
       ]
     }
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/shko.online/dataverse-odata.git"
-  },
+  "repository": "https://github.com/shko-online/dataverse-odata",
   "keywords": [
     "odata",
     "dataverse",
@@ -37,9 +35,9 @@
   "author": "Shko Online <sales@shko.online> (https://shko.online);Betim Beja",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/shko.online/dataverse-odata/issues"
+    "url": "https://github.com/shko-online/dataverse-odata/issues"
   },
-  "homepage": "https://github.com/shko.online/dataverse-odata#readme",
+  "homepage": "https://github.com/shko-online/dataverse-odata#readme",
   "devDependencies": {
     "@babel/cli": "^7.20.7",
     "@babel/core": "^7.20.12",
@@ -57,6 +55,12 @@
     "@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/git": "^10.0.1",
+    "@semantic-release/npm": "^9.0.2",
+    "@semantic-release/release-notes-generator": "^10.0.3",
     "@storybook/babel-plugin-require-context-hook": "^1.0.1",
     "@typescript-eslint/eslint-plugin": "^5.40.1",
     "@typescript-eslint/parser": "^5.40.1",
@@ -66,6 +70,7 @@
     "eslint": "^8.25.0",
     "jest": "^29.2.1",
     "jest-environment-jsdom": "^29.2.1",
+    "semantic-release": "^20.1.0",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
     "typescript": "^4.8.4"

package/src/OData.types.d.ts

@@ -1,61 +1,61 @@
-export interface ODataError {
-    error?: {
-        code: string;
-        message: string;
-    };
-}
-
-export interface ODataExpand {
-    $expand?: {
-        [relationship: string]: ODataExpandQuery;
-    };
-}
-
-export type ODataExpandQuery = ODataSelect & ODataExpand;
-
-export interface ODataFilter {
-    $filter?: StandardOperator;
-}
-
-export interface ODataFetch {
-    fetchXml?: XMLDocument;
-}
-
-export interface ODataSelect {
-    /**
-     * Attributes to select.
-     * Empty array equals to all Attributes.
-     */
-    $select?: string[];
-}
-
-export interface ODataTop {
-    $top?: number;
-}
-
-export type StandardOperators = 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
-
-export interface StandardOperator {
-    operator: StandardOperators;
-    /**
-     * 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 | number;
-}
-
-export interface UnaryOperator {
-    operator: 'not';
-    right: StandardOperator;
-}
-
-export interface BinaryOperator {
-    operator: 'and' | 'or';
-    left: StandardOperator;
-    right: StandardOperator;
-}
-
-export type ODataQuery = ODataError & ODataExpand & ODataFilter & ODataSelect & ODataTop & ODataFetch;
+export interface ODataError {
+    error?: {
+        code: string;
+        message: string;
+    };
+}
+
+export interface ODataExpand {
+    $expand?: {
+        [relationship: string]: ODataExpandQuery;
+    };
+}
+
+export type ODataExpandQuery = ODataSelect & ODataExpand;
+
+export interface ODataFilter {
+    $filter?: StandardOperator;
+}
+
+export interface ODataFetch {
+    fetchXml?: XMLDocument;
+}
+
+export interface ODataSelect {
+    /**
+     * Attributes to select.
+     * Empty array equals to all Attributes.
+     */
+    $select?: string[];
+}
+
+export interface ODataTop {
+    $top?: number;
+}
+
+export type StandardOperators = 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+
+export interface StandardOperator {
+    operator: StandardOperators;
+    /**
+     * 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 | number;
+}
+
+export interface UnaryOperator {
+    operator: 'not';
+    right: StandardOperator;
+}
+
+export interface BinaryOperator {
+    operator: 'and' | 'or';
+    left: StandardOperator;
+    right: StandardOperator;
+}
+
+export type ODataQuery = ODataError & ODataExpand & ODataFilter & ODataSelect & ODataTop & ODataFetch;

package/src/getExpandFromParser.ts

@@ -1,105 +1,106 @@
-import type { ODataError, ODataExpand, ODataExpandQuery, ODataQuery } from './OData.types';
-import { getSelectFromParser } from './getSelectFromParser';
-
-/**
- * Parses the $expand query
- * @returns Returns true when the parse has an error
- */
-export const getExpandFromParser = (parser: URLSearchParams, result: ODataQuery): boolean => {
-    const $expand = parser.get('$expand');
-    if ($expand !== null) {
-        result.$expand = {};
-
-        if (extractExpand($expand, result)) {
-            return true;
-        }
-    }
-    return false;
-};
-
-const extractExpand = (value: string, $expand: ODataExpand & ODataError) => {
-    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 true;
-    }
-    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 true;
-        }
-
-        if ($expand.$expand !== undefined) {
-            const innerExpand = {} as ODataExpandQuery & ODataError;
-            const parser = new URLSearchParams('?' + value.substring(matchLength, matchLength + index));
-            if (getSelectFromParser(parser, innerExpand)) {
-                $expand.error = innerExpand.error;
-                return true;
-            }
-            if (getExpandFromParser(parser, innerExpand)) {
-                $expand.error = innerExpand.error;
-                return true;
-            }
-            if (innerExpand.$expand === undefined && innerExpand.$select === undefined) {
-                $expand.error = { code: '0x0', message: 'Empty expand' };
-                return true;
-            }
-            $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 true;
-        }
-    }
-
-    return false;
-};
-
-const getClosingBracket = (value: string): { index: number; error?: string } => {
-    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 };
-};
+import type { ODataError, ODataExpand, ODataExpandQuery, ODataQuery } from './OData.types';
+
+import { getSelectFromParser } from './getSelectFromParser';
+
+/**
+ * Parses the $expand query
+ * @returns Returns true when the parse has an error
+ */
+export const getExpandFromParser = (parser: URLSearchParams, result: ODataQuery): boolean => {
+    const $expand = parser.get('$expand');
+    if ($expand !== null) {
+        result.$expand = {};
+
+        if (extractExpand($expand, result)) {
+            return true;
+        }
+    }
+    return false;
+};
+
+const extractExpand = (value: string, $expand: ODataExpand & ODataError) => {
+    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 true;
+    }
+    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 true;
+        }
+
+        if ($expand.$expand !== undefined) {
+            const innerExpand = {} as ODataExpandQuery & ODataError;
+            const parser = new URLSearchParams('?' + value.substring(matchLength, matchLength + index));
+            if (getSelectFromParser(parser, innerExpand)) {
+                $expand.error = innerExpand.error;
+                return true;
+            }
+            if (getExpandFromParser(parser, innerExpand)) {
+                $expand.error = innerExpand.error;
+                return true;
+            }
+            if (innerExpand.$expand === undefined && innerExpand.$select === undefined) {
+                $expand.error = { code: '0x0', message: 'Empty expand' };
+                return true;
+            }
+            $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 true;
+        }
+    }
+
+    return false;
+};
+
+const getClosingBracket = (value: string): { index: number; error?: string } => {
+    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/src/getFetchXmlFromParser.ts

@@ -1,48 +1,48 @@
-import type { ODataQuery } from './OData.types';
-
-/**
- * Parses the $fetchXml query
- * @returns Returns true when the parse has an error
- */
-export const getFetchXmlFromParser = (parser: URLSearchParams, result: ODataQuery): boolean => {
-    const fetchXml = parser.get('fetchXml');
-    if (fetchXml !== null) {
-        const serializer = new DOMParser();
-        const fetchXmlDocument = serializer.parseFromString(fetchXml, 'text/xml');
-        if (fetchXmlDocument.documentElement.tagName === 'parsererror') {
-            result.error = {
-                code: '0x80040201',
-                message: 'Invalid XML.',
-            };
-            return true;
-        }
-        const entity = fetchXmlDocument
-            .evaluate('fetch/entity', fetchXmlDocument, null, XPathResult.ANY_TYPE, null)
-            .iterateNext() as Element;
-        if (fetchXmlDocument.documentElement.children.length != 1 || !entity || !entity.getAttribute('name')) {
-            result.error = {
-                code: '0x80041102',
-                message: 'Entity Name was not specified in FetchXml String.',
-            };
-            return true;
-        }
-        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() as Element;
-        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 true;
-        }
-        result.fetchXml = fetchXmlDocument;
-    }
-    return false;
-};
+import type { ODataQuery } from './OData.types';
+
+/**
+ * Parses the fetchXml query
+ * @returns Returns true when the parse has an error
+ */
+export const getFetchXmlFromParser = (parser: URLSearchParams, result: ODataQuery): boolean => {
+    const fetchXml = parser.get('fetchXml');
+    if (fetchXml !== null) {
+        const serializer = new DOMParser();
+        const fetchXmlDocument = serializer.parseFromString(fetchXml, 'text/xml');
+        if (fetchXmlDocument.documentElement.tagName === 'parsererror') {
+            result.error = {
+                code: '0x80040201',
+                message: 'Invalid XML.',
+            };
+            return true;
+        }
+        const entity = fetchXmlDocument
+            .evaluate('fetch/entity', fetchXmlDocument, null, XPathResult.ANY_TYPE, null)
+            .iterateNext() as Element;
+        if (fetchXmlDocument.documentElement.children.length != 1 || !entity || !entity.getAttribute('name')) {
+            result.error = {
+                code: '0x80041102',
+                message: 'Entity Name was not specified in FetchXml String.',
+            };
+            return true;
+        }
+        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() as Element;
+        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 true;
+        }
+        result.fetchXml = fetchXmlDocument;
+    }
+    return false;
+};

package/src/getSelectFromParser.ts

@@ -1,13 +1,13 @@
-import type { ODataQuery } from './OData.types';
-
-/**
- * Parses the $select query
- * @returns Returns true when the parse has an error
- */
-export const getSelectFromParser = (parser: URLSearchParams, result: ODataQuery): boolean => {
-    const $select = parser.get('$select');
-    if ($select !== null) {
-        result.$select = $select.split(',');
-    }
-    return false;
-};
+import type { ODataQuery } from './OData.types';
+
+/**
+ * Parses the $select query
+ * @returns Returns true when the parse has an error
+ */
+export const getSelectFromParser = (parser: URLSearchParams, result: ODataQuery): boolean => {
+    const $select = parser.get('$select');
+    if ($select !== null) {
+        result.$select = $select.split(',');
+    }
+    return false;
+};

package/src/getTopFromParser.ts

@@ -1,27 +1,27 @@
-import type { ODataQuery } from './OData.types';
-
-/**
- * Parses the $top query
- * @returns Returns true when the parse has an error
- */
-export const getTopFromParser = (parser: URLSearchParams, result: ODataQuery): boolean => {
-    const $topValue = parser.get('$top');
-    if ($topValue !== null) {
-        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 true;
-        } else if ($top === 0) {
-            result.error = {
-                code: '0x0',
-                message: `Invalid value for $top query option.`,
-            };
-            return true;
-        }
-        result.$top = $top;
-    }
-    return false;
-};
+import type { ODataQuery } from './OData.types';
+
+/**
+ * Parses the $top query
+ * @returns Returns true when the parse has an error
+ */
+export const getTopFromParser = (parser: URLSearchParams, result: ODataQuery): boolean => {
+    const $topValue = parser.get('$top');
+    if ($topValue !== null) {
+        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 true;
+        } else if ($top === 0) {
+            result.error = {
+                code: '0x0',
+                message: `Invalid value for $top query option.`,
+            };
+            return true;
+        }
+        result.$top = $top;
+    }
+    return false;
+};

package/src/index.ts

@@ -1,16 +1,17 @@
-export type {
-    BinaryOperator,
-    ODataError,
-    ODataExpand,
-    ODataExpandQuery,
-    ODataFetch,
-    ODataFilter,
-    ODataQuery,
-    ODataSelect,
-    ODataTop,
-    StandardOperator,
-    StandardOperators,
-} from './OData.types';
-export { parseOData } from './parseOData';
-import { parseOData } from './parseOData';
-export default parseOData;
+export type {
+    BinaryOperator,
+    ODataError,
+    ODataExpand,
+    ODataExpandQuery,
+    ODataFetch,
+    ODataFilter,
+    ODataQuery,
+    ODataSelect,
+    ODataTop,
+    StandardOperator,
+    StandardOperators,
+} from './OData.types';
+
+export { parseOData } from './parseOData';
+import { parseOData } from './parseOData';
+export default parseOData;