@shko.online/dataverse-odata 0.1.1 → 0.1.3

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

@@ -0,0 +1,154 @@
+interface ODataError {
+    error?: {
+        code: string;
+        message: string;
+    };
+}
+
+interface ODataExpand {
+    /**
+     * Use the {@link ODataExpand.$expand $expand} system query option in the navigation properties
+     * to control what data from related entities is returned.
+     * There are two types of navigation properties:
+     * * Single-valued navigation properties correspond to Lookup attributes that support many-to-one
+     * relationships and allow setting a reference to another entity.
+     * * Collection-valued navigation properties correspond to one-to-many or many-to-many relationships.
+     *
+     * If you include only the name of the navigation property, you'll receive all the properties for
+     * related records. You can limit the properties returned for related records using the
+     * {@link ODataSelect.$select $select} system query option in parentheses after the navigation
+     * property name. Use this for both single-valued and collection-valued navigation properties.
+     *
+     * * Microsoft Docs: {@link https://learn.microsoft.com/power-apps/developer/data-platform/webapi/retrieve-related-entities-query?WT.mc_id=DX-MVP-5004767 Retrieve related table records with a query }
+     */
+    $expand?: {
+        [relationship: string]: ODataExpandQuery;
+    };
+}
+
+type ODataExpandQuery = ODataSelect & ODataExpand;
+
+interface ODataFilter {
+    /**
+     * Use the {@link ODataFilter.$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;
+}
+
+interface ODataFetch {
+    /**
+     * You can compose a FetchXML query for a specific table.
+     * Then, URL-encode the XML and pass it to the entity set
+     * using the {@link ODataFetch.fetchXml fetchXml} query string parameter.
+     *
+     * * Microsoft Docs: {@link https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/use-fetchxml-web-api?WT.mc_id=DX-MVP-5004767 Use FetchXml with Web API }
+     */
+    fetchXml?: XMLDocument;
+}
+
+interface ODataOrderBy {
+    /**
+     * Specify the order in which items are returned using the {@link ODataOrderBy.$orderby $orderby}
+     * system query option. Use the asc or desc suffix to specify ascending or descending order
+     * respectively. The default is ascending if the suffix isn't applied.
+     *
+     * * Microsoft Docs: {@link https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/query-data-web-api?WT.mc_id=DX-MVP-5004767#order-results Order results }
+     */
+    $orderby?: { column: string; asc: boolean }[];
+}
+
+interface ODataSavedQuery {
+    /**
+     * You can use the `savedqueryid` value and pass it as the value to the {@link ODataSavedQuery.savedQuery savedQuery}
+     * parameter to the entity set that matches the corresponding `returnedtypecode` of the saved query.
+     *
+     * * Microsoft Docs: {@link https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/retrieve-and-execute-predefined-queries?WT.mc_id=DX-MVP-5004767#predefined-queries Retrieve and execute predefined queries }
+     */
+    savedQuery?: string;
+}
+
+interface ODataSelect {
+    /**
+     * Use the {@link ODataSelect.$select $select} system query option to limit the properties returned.
+     *
+     * This is a performance best practice. If properties aren't specified using
+     * {@link ODataSelect.$select $select}, all properties 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#request-specific-properties Request specific properties }
+     */
+    $select?: string[];
+}
+
+interface ODataTop {
+    /**
+     * You can limit the number of results returned by using the {@link ODataTop.$top $top} system query option.
+     *
+     * * Microsoft Docs: {@link https://learn.microsoft.com/power-apps/developer/data-platform/webapi/query-data-web-api?WT.mc_id=DX-MVP-5004767#use-top-query-option Use $top query option }
+     */
+    $top?: number;
+}
+
+interface ODataUserQuery {
+    /**
+     * You can use the `userqueryid` value and pass it as the value to the {@link OdataUserQuery.userQuery userQuery}
+     * parameter to the entity set that matches the corresponding `returnedtypecode` of the user query.
+     *
+     * * Microsoft Docs: {@link https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/retrieve-and-execute-predefined-queries?WT.mc_id=DX-MVP-5004767#predefined-queries Retrieve and execute predefined queries }
+     */
+    userQuery?: string;
+}
+
+type StandardOperators = 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+
+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;
+}
+
+interface UnaryOperator {
+    operator: 'not';
+    right: StandardOperator;
+}
+
+interface BinaryOperator {
+    operator: 'and' | 'or';
+    left: StandardOperator;
+    right: StandardOperator;
+}
+
+type ODataQuery = ODataError &
+    ODataExpand &
+    ODataFetch &
+    ODataFilter &
+    ODataOrderBy &
+    ODataSavedQuery &
+    ODataSelect &
+    ODataTop &
+    ODataUserQuery;
+
+export type {
+    BinaryOperator,
+    ODataError,
+    ODataExpand,
+    ODataExpandQuery,
+    ODataFetch,
+    ODataFilter,
+    ODataOrderBy,
+    ODataQuery,
+    ODataSavedQuery,
+    ODataSelect,
+    ODataTop,
+    ODataUserQuery,
+    StandardOperator,
+    StandardOperators,
+    UnaryOperator,    
+};

package/lib/ts3.9/getExpandFromParser.d.ts

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

package/lib/ts3.9/getFetchXmlFromParser.d.ts

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

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

@@ -1 +1 @@
-{"version":3,"file":"getFetchXmlFromParser.d.ts","sourceRoot":"","sources":["../../src/getFetchXmlFromParser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,qBAAqB,WAAY,eAAe,UAAU,UAAU,KAAG,OAyCnF,CAAC"}
+{"version":3,"file":"getFetchXmlFromParser.d.ts","sourceRoot":"","sources":["../../src/getFetchXmlFromParser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAc,MAAM,eAAe,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,qBAAqB,WAAY,eAAe,UAAU,UAAU,KAAG,OAiDnF,CAAC"}

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

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

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

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

package/lib/ts3.9/getSelectFromParser.d.ts

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

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

@@ -1 +1 @@
-{"version":3,"file":"getSelectFromParser.d.ts","sourceRoot":"","sources":["../../src/getSelectFromParser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,WAAY,eAAe,UAAU,UAAU,KAAG,OAMjF,CAAC"}
+{"version":3,"file":"getSelectFromParser.d.ts","sourceRoot":"","sources":["../../src/getSelectFromParser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAe,MAAM,eAAe,CAAC;AAE7D;;;GAGG;AACH,eAAO,MAAM,mBAAmB,WAAY,eAAe,UAAU,UAAU,KAAG,OAMjF,CAAC"}

package/lib/ts3.9/getTopFromParser.d.ts

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

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

@@ -1 +1 @@
-{"version":3,"file":"getTopFromParser.d.ts","sourceRoot":"","sources":["../../src/getTopFromParser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,WAAY,eAAe,UAAU,UAAU,KAAG,OAoB9E,CAAC"}
+{"version":3,"file":"getTopFromParser.d.ts","sourceRoot":"","sources":["../../src/getTopFromParser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAY,MAAM,eAAe,CAAC;AAG1D;;;GAGG;AACH,eAAO,MAAM,gBAAgB,WAAY,eAAe,UAAU,UAAU,KAAG,OAuB9E,CAAC"}

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

@@ -0,0 +1,8 @@
+import type { ODataQuery } from './OData.types';
+/**
+ * Parses the {@link ODataSavedQuery.savedQuery savedQuery} or
+ * {@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;
+//# sourceMappingURL=getXQueryFromParser.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getXQueryFromParser.d.ts","sourceRoot":"","sources":["../../src/getXQueryFromParser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAmC,MAAM,eAAe,CAAC;AAIjF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,MACzB,YAAY,GAAG,WAAW,UACrB,eAAe,UACf,UAAU,KACnB,OAoBF,CAAC"}

package/lib/ts3.9/index.d.ts

@@ -1,4 +1,10 @@
 export type { BinaryOperator, ODataError, ODataExpand, ODataExpandQuery, ODataFetch, ODataFilter, ODataQuery, ODataSelect, ODataTop, StandardOperator, StandardOperators, } from './OData.types';
+export { getExpandFromParser } from './getExpandFromParser';
+export { getFetchXmlFromParser } from './getFetchXmlFromParser';
+export { getOrderByFromParser } from './getOrderByFromParser';
+export { getSelectFromParser } from './getSelectFromParser';
+export { getTopFromParser } from './getTopFromParser';
+export { getXQueryFromParser } from './getXQueryFromParser';
 export { parseOData } from './parseOData';
 import { parseOData } from './parseOData';
 export default parseOData;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACR,cAAc,EACd,UAAU,EACV,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,WAAW,EACX,UAAU,EACV,WAAW,EACX,QAAQ,EACR,gBAAgB,EAChB,iBAAiB,GACpB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,eAAe,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACR,cAAc,EACd,UAAU,EACV,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,WAAW,EACX,UAAU,EACV,WAAW,EACX,QAAQ,EACR,gBAAgB,EAChB,iBAAiB,GACpB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,eAAe,UAAU,CAAC"}

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;AAOhD;;;;GAIG;AACH,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;AAQhD;;;;GAIG;AACH,eAAO,MAAM,UAAU,UAAW,MAAM,eAsBvC,CAAC"}

package/lib/ts3.9/validateNotEmpty.d.ts

@@ -0,0 +1,3 @@
+import type { ODataQuery } from './OData.types';
+export declare const validateNotEmpty: (query: string, value: string, result: ODataQuery) => boolean;
+//# sourceMappingURL=validateNotEmpty.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validateNotEmpty.d.ts","sourceRoot":"","sources":["../../src/validateNotEmpty.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,eAAO,MAAM,gBAAgB,UAAW,MAAM,SAAS,MAAM,UAAU,UAAU,YAShF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shko.online/dataverse-odata",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "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",

package/src/OData.types.d.ts

@@ -1,41 +1,108 @@
-export interface ODataError {
+interface ODataError {
     error?: {
         code: string;
         message: string;
     };
 }
 
-export interface ODataExpand {
+interface ODataExpand {
+    /**
+     * Use the {@link ODataExpand.$expand $expand} system query option in the navigation properties
+     * to control what data from related entities is returned.
+     * There are two types of navigation properties:
+     * * Single-valued navigation properties correspond to Lookup attributes that support many-to-one
+     * relationships and allow setting a reference to another entity.
+     * * Collection-valued navigation properties correspond to one-to-many or many-to-many relationships.
+     *
+     * If you include only the name of the navigation property, you'll receive all the properties for
+     * related records. You can limit the properties returned for related records using the
+     * {@link ODataSelect.$select $select} system query option in parentheses after the navigation
+     * property name. Use this for both single-valued and collection-valued navigation properties.
+     *
+     * * Microsoft Docs: {@link https://learn.microsoft.com/power-apps/developer/data-platform/webapi/retrieve-related-entities-query?WT.mc_id=DX-MVP-5004767 Retrieve related table records with a query }
+     */
     $expand?: {
         [relationship: string]: ODataExpandQuery;
     };
 }
 
-export type ODataExpandQuery = ODataSelect & ODataExpand;
+type ODataExpandQuery = ODataSelect & ODataExpand;
 
-export interface ODataFilter {
+interface ODataFilter {
+    /**
+     * Use the {@link ODataFilter.$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;
 }
 
-export interface ODataFetch {
+interface ODataFetch {
+    /**
+     * You can compose a FetchXML query for a specific table.
+     * Then, URL-encode the XML and pass it to the entity set
+     * using the {@link ODataFetch.fetchXml fetchXml} query string parameter.
+     *
+     * * Microsoft Docs: {@link https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/use-fetchxml-web-api?WT.mc_id=DX-MVP-5004767 Use FetchXml with Web API }
+     */
     fetchXml?: XMLDocument;
 }
 
-export interface ODataSelect {
+interface ODataOrderBy {
     /**
-     * Attributes to select.
-     * Empty array equals to all Attributes.
+     * Specify the order in which items are returned using the {@link ODataOrderBy.$orderby $orderby}
+     * system query option. Use the asc or desc suffix to specify ascending or descending order
+     * respectively. The default is ascending if the suffix isn't applied.
+     *
+     * * Microsoft Docs: {@link https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/query-data-web-api?WT.mc_id=DX-MVP-5004767#order-results Order results }
+     */
+    $orderby?: { column: string; asc: boolean }[];
+}
+
+interface ODataSavedQuery {
+    /**
+     * You can use the `savedqueryid` value and pass it as the value to the {@link ODataSavedQuery.savedQuery savedQuery}
+     * parameter to the entity set that matches the corresponding `returnedtypecode` of the saved query.
+     *
+     * * Microsoft Docs: {@link https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/retrieve-and-execute-predefined-queries?WT.mc_id=DX-MVP-5004767#predefined-queries Retrieve and execute predefined queries }
+     */
+    savedQuery?: string;
+}
+
+interface ODataSelect {
+    /**
+     * Use the {@link ODataSelect.$select $select} system query option to limit the properties returned.
+     *
+     * This is a performance best practice. If properties aren't specified using
+     * {@link ODataSelect.$select $select}, all properties 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#request-specific-properties Request specific properties }
      */
     $select?: string[];
 }
 
-export interface ODataTop {
+interface ODataTop {
+    /**
+     * You can limit the number of results returned by using the {@link ODataTop.$top $top} system query option.
+     *
+     * * Microsoft Docs: {@link https://learn.microsoft.com/power-apps/developer/data-platform/webapi/query-data-web-api?WT.mc_id=DX-MVP-5004767#use-top-query-option Use $top query option }
+     */
     $top?: number;
 }
 
-export type StandardOperators = 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+interface ODataUserQuery {
+    /**
+     * You can use the `userqueryid` value and pass it as the value to the {@link OdataUserQuery.userQuery userQuery}
+     * parameter to the entity set that matches the corresponding `returnedtypecode` of the user query.
+     *
+     * * Microsoft Docs: {@link https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/retrieve-and-execute-predefined-queries?WT.mc_id=DX-MVP-5004767#predefined-queries Retrieve and execute predefined queries }
+     */
+    userQuery?: string;
+}
 
-export interface StandardOperator {
+type StandardOperators = 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+
+interface StandardOperator {
     operator: StandardOperators;
     /**
      * The left side of the 'X' operator must be a property of the entity.
@@ -47,15 +114,41 @@ export interface StandardOperator {
     right: string | number;
 }
 
-export interface UnaryOperator {
+interface UnaryOperator {
     operator: 'not';
     right: StandardOperator;
 }
 
-export interface BinaryOperator {
+interface BinaryOperator {
     operator: 'and' | 'or';
     left: StandardOperator;
     right: StandardOperator;
 }
 
-export type ODataQuery = ODataError & ODataExpand & ODataFilter & ODataSelect & ODataTop & ODataFetch;
+type ODataQuery = ODataError &
+    ODataExpand &
+    ODataFetch &
+    ODataFilter &
+    ODataOrderBy &
+    ODataSavedQuery &
+    ODataSelect &
+    ODataTop &
+    ODataUserQuery;
+
+export type {
+    BinaryOperator,
+    ODataError,
+    ODataExpand,
+    ODataExpandQuery,
+    ODataFetch,
+    ODataFilter,
+    ODataOrderBy,
+    ODataQuery,
+    ODataSavedQuery,
+    ODataSelect,
+    ODataTop,
+    ODataUserQuery,
+    StandardOperator,
+    StandardOperators,
+    UnaryOperator,    
+};

package/src/getExpandFromParser.ts

@@ -3,19 +3,19 @@ import type { ODataError, ODataExpand, ODataExpandQuery, ODataQuery } from './OD
 import { getSelectFromParser } from './getSelectFromParser';
 
 /**
- * Parses the $expand query
- * @returns Returns true when the parse has an error
+ * Parses the {@link ODataExpand.$expand $expand} query
+ * @returns Returns `false` 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;
+        if (!extractExpand($expand, result)) {
+            return false;
         }
     }
-    return false;
+    return true;
 };
 
 const extractExpand = (value: string, $expand: ODataExpand & ODataError) => {
@@ -29,7 +29,7 @@ const extractExpand = (value: string, $expand: ODataExpand & ODataError) => {
             code: '0x0',
             message: 'invalid expand expression',
         };
-        return true;
+        return false;
     }
     let matchSeparator = match[3];
     let matchLength = match[0].length;
@@ -44,23 +44,23 @@ const extractExpand = (value: string, $expand: ODataExpand & ODataError) => {
                 code: '0x0',
                 message: error,
             };
-            return true;
+            return false;
         }
 
         if ($expand.$expand !== undefined) {
             const innerExpand = {} as ODataExpandQuery & ODataError;
             const parser = new URLSearchParams('?' + value.substring(matchLength, matchLength + index));
-            if (getSelectFromParser(parser, innerExpand)) {
+            if (!getSelectFromParser(parser, innerExpand)) {
                 $expand.error = innerExpand.error;
-                return true;
+                return false;
             }
-            if (getExpandFromParser(parser, innerExpand)) {
+            if (!getExpandFromParser(parser, innerExpand)) {
                 $expand.error = innerExpand.error;
-                return true;
+                return false;
             }
             if (innerExpand.$expand === undefined && innerExpand.$select === undefined) {
                 $expand.error = { code: '0x0', message: 'Empty expand' };
-                return true;
+                return false;
             }
             $expand.$expand[match[1]] = innerExpand;
         }
@@ -76,12 +76,12 @@ const extractExpand = (value: string, $expand: ODataExpand & ODataError) => {
     }
 
     if (matchSeparator === ',') {
-        if (extractExpand(value.substring(matchLength), $expand)) {
-            return true;
+        if (!extractExpand(value.substring(matchLength), $expand)) {
+            return false;
         }
     }
 
-    return false;
+    return true;
 };
 
 const getClosingBracket = (value: string): { index: number; error?: string } => {

package/src/getFetchXmlFromParser.ts

@@ -1,12 +1,20 @@
-import type { ODataQuery } from './OData.types';
+import type { ODataQuery, ODataFetch } from './OData.types';
 
 /**
- * Parses the fetchXml query
- * @returns Returns true when the parse has an error
+ * Parses the {@link ODataFetch.fetchXml fetchXml} query
+ * @returns Returns `false` when the parse has an error
  */
 export const getFetchXmlFromParser = (parser: URLSearchParams, result: ODataQuery): boolean => {
     const fetchXml = parser.get('fetchXml');
     if (fetchXml !== null) {
+        if (fetchXml === '') {
+            result.error = {
+                code: '0x80040203',
+                message: 'Expected non-empty string.',
+            };
+            return false;
+        }
+
         const serializer = new DOMParser();
         const fetchXmlDocument = serializer.parseFromString(fetchXml, 'text/xml');
         if (fetchXmlDocument.documentElement.tagName === 'parsererror') {
@@ -14,7 +22,7 @@ export const getFetchXmlFromParser = (parser: URLSearchParams, result: ODataQuer
                 code: '0x80040201',
                 message: 'Invalid XML.',
             };
-            return true;
+            return false;
         }
         const entity = fetchXmlDocument
             .evaluate('fetch/entity', fetchXmlDocument, null, XPathResult.ANY_TYPE, null)
@@ -24,7 +32,7 @@ export const getFetchXmlFromParser = (parser: URLSearchParams, result: ODataQuer
                 code: '0x80041102',
                 message: 'Entity Name was not specified in FetchXml String.',
             };
-            return true;
+            return false;
         }
         const invalidAttribute = fetchXmlDocument
             .evaluate(
@@ -40,9 +48,9 @@ export const getFetchXmlFromParser = (parser: URLSearchParams, result: ODataQuer
                 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;
+            return false;
         }
         result.fetchXml = fetchXmlDocument;
     }
-    return false;
+    return true;
 };

package/src/getOrderByFromParser.ts

@@ -0,0 +1,42 @@
+import type { ODataQuery, ODataOrderBy } from './OData.types';
+import { validateNotEmpty } from './validateNotEmpty';
+
+const edmProperty = /\w{1-255}/gi;
+
+/**
+ * Parses the {@link ODataOrderBy.$orderby $orderby} query
+ * @returns Returns `false` when the parse has an error
+ */
+export const getOrderByFromParser = (parser: URLSearchParams, result: ODataQuery): boolean => {
+    let $orderby = parser.get('$orderby');
+    if ($orderby !== null) {
+        if (!validateNotEmpty('$orderby', $orderby, result)) {
+            return false;
+        }
+        $orderby = $orderby.trimEnd();
+        const orderByArray: ODataOrderBy['$orderby'] = [];
+        for (let i = 0; i < $orderby.length; i++) {
+            if (false /* syntax error */) {
+                result.error = {
+                    code: '0x0',
+                    message: `Syntax error at position ${i} in '${$orderby}'.`,
+                };
+    
+                return false;
+            }
+        }
+
+        orderByArray.forEach((orderBy) => {
+            if (!orderBy.column?.match(edmProperty)) {
+                result.error = {
+                    code: '0x80060888',
+                    message: 'Order By Property must be of type EdmProperty',
+                };
+                return false;
+            }
+        });
+
+        result.$orderby = orderByArray;
+    }
+    return true;
+};

package/src/getSelectFromParser.ts

@@ -1,13 +1,13 @@
-import type { ODataQuery } from './OData.types';
+import type { ODataQuery, ODataSelect } from './OData.types';
 
 /**
- * Parses the $select query
- * @returns Returns true when the parse has an error
+ * Parses the {@link ODataSelect.$select $select} query
+ * @returns Returns `false` 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;
+    return true;
 };