@shko.online/dataverse-odata 0.1.2 → 0.1.3

package/.eslintrc.json

@@ -0,0 +1,59 @@
+{
+  "env": {
+      "browser": true,
+      "es2021": true
+  },
+  "extends": [
+      "eslint:recommended",
+      "plugin:react/recommended",
+      "plugin:@typescript-eslint/recommended",
+      "plugin:prettier/recommended",
+      "prettier",
+      "plugin:sonarjs/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+      "ecmaFeatures": {
+          "jsx": true
+      },
+      "ecmaVersion": 12,
+      "sourceType": "module"
+  },
+  "plugins": [
+      "react",
+      "react-hooks",
+      "@typescript-eslint",
+      "prettier",
+      "sonarjs"
+  ],
+  "settings": {
+      "react": {
+        "pragma": "React",
+        "version": "detect"
+      }
+    },
+  "ignorePatterns": ["**/generated/*.ts"],
+  "rules": {
+      "eqeqeq": [2, "smart"],
+      "react-hooks/exhaustive-deps": "warn",
+      "prettier/prettier": "error",
+      "arrow-body-style": "off",
+      "prefer-arrow-callback": "off",
+      "linebreak-style": [
+          "error",
+          "windows"
+      ],
+      "quotes": [
+          "error",
+          "single",
+          {
+            "avoidEscape": true,
+            "allowTemplateLiterals": true
+          }
+      ],
+      "semi": [
+          "error",
+          "always"
+      ]
+  }
+}

package/.prettierrc.json

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

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.1.3](https://github.com/shko-online/dataverse-odata/compare/v0.1.2...v0.1.3) (2023-02-11)
+
+
+### Bug Fixes
+
+* Fixed bundled types ([abbd95b](https://github.com/shko-online/dataverse-odata/commit/abbd95bbc0d118e9c2c20cbeb224025e84e33a9e))
+
 ## [0.1.2](https://github.com/shko-online/dataverse-odata/compare/v0.1.1...v0.1.2) (2023-02-11)
 
 

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

@@ -0,0 +1,118 @@
+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 { BinaryOperator, ODataError, ODataExpand, ODataExpandQuery, ODataFetch, ODataFilter, ODataOrderBy, ODataQuery, ODataSavedQuery, ODataSelect, ODataTop, ODataUserQuery, StandardOperator, StandardOperators, UnaryOperator, };

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shko.online/dataverse-odata",
-  "version": "0.1.2",
+  "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,11 +1,11 @@
-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.
@@ -26,9 +26,9 @@ export interface ODataExpand {
     };
 }
 
-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.
      *
@@ -37,7 +37,7 @@ export interface ODataFilter {
     $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
@@ -48,7 +48,7 @@ export interface ODataFetch {
     fetchXml?: XMLDocument;
 }
 
-export interface ODataOrderBy {
+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
@@ -59,7 +59,7 @@ export interface ODataOrderBy {
     $orderby?: { column: string; asc: boolean }[];
 }
 
-export interface ODataSavedQuery {
+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.
@@ -69,7 +69,7 @@ export interface ODataSavedQuery {
     savedQuery?: string;
 }
 
-export interface ODataSelect {
+interface ODataSelect {
     /**
      * Use the {@link ODataSelect.$select $select} system query option to limit the properties returned.
      *
@@ -81,7 +81,7 @@ export interface ODataSelect {
     $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.
      *
@@ -90,7 +90,7 @@ export interface ODataTop {
     $top?: number;
 }
 
-export interface ODataUserQuery {
+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.
@@ -100,9 +100,9 @@ export interface ODataUserQuery {
     userQuery?: string;
 }
 
-export type StandardOperators = 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+type StandardOperators = 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
 
-export interface StandardOperator {
+interface StandardOperator {
     operator: StandardOperators;
     /**
      * The left side of the 'X' operator must be a property of the entity.
@@ -114,18 +114,18 @@ 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 &
+type ODataQuery = ODataError &
     ODataExpand &
     ODataFetch &
     ODataFilter &
@@ -134,3 +134,21 @@ export type ODataQuery = ODataError &
     ODataSelect &
     ODataTop &
     ODataUserQuery;
+
+export type {
+    BinaryOperator,
+    ODataError,
+    ODataExpand,
+    ODataExpandQuery,
+    ODataFetch,
+    ODataFilter,
+    ODataOrderBy,
+    ODataQuery,
+    ODataSavedQuery,
+    ODataSelect,
+    ODataTop,
+    ODataUserQuery,
+    StandardOperator,
+    StandardOperators,
+    UnaryOperator,    
+};

package/tsconfig.build.json

@@ -1,5 +1,8 @@
 {
     "extends": "./tsconfig.json",
+    "include": [
+        "src"
+    ],
     "exclude": [
         "tests",
         "lib",

package/tsconfig.json

@@ -16,11 +16,8 @@
         "resolveJsonModule": true,
         "declaration": true,
         "declarationMap": true,
-        "sourceMap": true,       
-        "baseUrl": ".",       
-        "typeRoots": [
-            "./node_modules/@types"
-        ]
+        "sourceMap": true,
+        "baseUrl": "."
     },
     "exclude": [
         "node_modules",