@slickgrid-universal/odata 4.0.2 → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slickgrid-universal/odata",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Grid OData Service to sync a grid with an OData backend server",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -25,7 +25,8 @@
     "access": "public"
   },
   "files": [
-    "/dist"
+    "/dist",
+    "/src"
   ],
   "license": "MIT",
   "author": "Ghislain B.",
@@ -44,12 +45,12 @@
     "not dead"
   ],
   "dependencies": {
-    "@slickgrid-universal/common": "~4.0.2",
-    "@slickgrid-universal/utils": "~4.0.2"
+    "@slickgrid-universal/common": "~4.1.0",
+    "@slickgrid-universal/utils": "~4.1.0"
   },
   "funding": {
     "type": "ko_fi",
     "url": "https://ko-fi.com/ghiscoding"
   },
-  "gitHead": "bcfcd08a502c43be4a17202174f631b064b56571"
+  "gitHead": "1cfc2658f5d70e66c096e5ea77d1827dd44e0292"
 }

package/src/index.ts

@@ -0,0 +1,3 @@
+export { GridOdataService } from './services/grid-odata.service';
+export { OdataQueryBuilderService } from './services/odataQueryBuilder.service';
+export * from './interfaces/index';

package/src/interfaces/index.ts

@@ -0,0 +1,3 @@
+export * from './odataOption.interface';
+export * from './odataServiceApi.interface';
+export * from './odataSortingOption.interface';

package/src/interfaces/odataOption.interface.ts

@@ -0,0 +1,57 @@
+import type { BackendServiceOption, CaseType } from '@slickgrid-universal/common';
+
+export interface OdataOption extends BackendServiceOption {
+  /** What is the casing type to use? Typically that would be 1 of the following 2: camelCase or PascalCase */
+  caseType: CaseType;
+
+  /** Add the total count $inlinecount (OData v2) or $count (OData v4) to the OData query */
+  enableCount?: boolean;
+
+  /**
+   * Query fields using $select. The row identifier field is always added.
+   * E.g.: columns [{ field: 'date' }] results in $select=id,date
+   */
+  enableSelect?: boolean;
+
+  /**
+   * Query navigation fields (containing '/') using $expand.
+   * E.g.: with odata v4 and columns [{ field: 'date' }, { field: 'products/name' }] result in $select=id,date&$expand=products($select=name)
+   */
+  enableExpand?: boolean;
+
+  /** How many rows to pull? */
+  top?: number;
+
+  /** How many rows to skip on the pagination? */
+  skip?: number;
+
+  /** (alias to "filter") Filter string (or array of string) that must be a valid OData string */
+  filter?: string | string[];
+
+  /** Filter string (or array of string) that must be a valid OData string */
+  filterBy?: any;
+
+  /** What is the separator between each filters? Typically "and", "or" */
+  filterBySeparator?: 'and' | 'or';
+
+  /** Filter queue */
+  filterQueue?: any[];
+
+  /** Sorting string (or array of string) that must be a valid OData string */
+  orderBy?: string | string[];
+
+  /** OData (or any other) version number (the query string is different between versions) */
+  version?: number;
+
+  /**
+   * When false, searchTerms may be manipulated to be functional with certain filters eg: string only filters.
+   * When true, JSON.stringify is used on the searchTerms and used in the query "as-is". It is then the responsibility of the developer to sanitise the `searchTerms` property if necessary.
+   */
+  useVerbatimSearchTerms?: boolean;
+
+  /** A callback which will extract and return the count from the data queried. Defaults to 'd.__count' for v2, '__count' for v3 and '@odata.count' for v4. */
+  countExtractor?: (response: any) => number;
+
+  /** A callback which will extract and return the dataset from the data queried. Defaults to 'd.results' for v2, 'results' for v3 and 'value' for v4. */
+  datasetExtractor?: (response: any) => number;
+}

package/src/interfaces/odataServiceApi.interface.ts

@@ -0,0 +1,11 @@
+import type { BackendServiceApi } from '@slickgrid-universal/common';
+import type { OdataOption } from './odataOption.interface';
+import type { GridOdataService } from '../services/index';
+
+export interface OdataServiceApi extends BackendServiceApi {
+  /** Backend Service Options */
+  options?: Partial<OdataOption>;
+
+  /** Backend Service instance (could be OData or GraphQL Service) */
+  service: GridOdataService;
+}

package/src/interfaces/odataSortingOption.interface.ts

@@ -0,0 +1,6 @@
+import type { SortDirection, SortDirectionString } from '@slickgrid-universal/common';
+
+export interface OdataSortingOption {
+  field: string;
+  direction: SortDirection | SortDirectionString;
+}