@slickgrid-universal/odata 2.5.0 → 2.6.0

package/dist/{commonjs → types}/services/odataQueryBuilder.service.d.ts

@@ -1,28 +1,29 @@
-import { Column } from '@slickgrid-universal/common';
-import { OdataOption } from '../interfaces/odataOption.interface';
-export declare class OdataQueryBuilderService {
-    _columnFilters: any;
-    _defaultSortBy: string;
-    _filterCount: number;
-    _odataOptions: Partial<OdataOption>;
-    protected _columnDefinitions: Column[];
-    set columnDefinitions(columnDefinitions: Column[]);
-    protected _datasetIdPropName: string;
-    set datasetIdPropName(datasetIdPropName: string);
-    constructor();
-    buildQuery(): string;
-    getFilterCount(): number;
-    get columnFilters(): any[];
-    get options(): Partial<OdataOption>;
-    set options(options: Partial<OdataOption>);
-    removeColumnFilter(fieldName: string): void;
-    saveColumnFilter(fieldName: string, value: any, searchTerms?: any[]): void;
-    /**
-     * Change any OData options that will be used to build the query
-     * @param object options
-     */
-    updateOptions(options: Partial<OdataOption>): void;
-    protected addToFilterQueueWhenNotExists(filterStr: string): void;
-    private buildSelectExpand;
-    private buildExpand;
-}
+import { Column } from '@slickgrid-universal/common';
+import { OdataOption } from '../interfaces/odataOption.interface';
+export declare class OdataQueryBuilderService {
+    _columnFilters: any;
+    _defaultSortBy: string;
+    _filterCount: number;
+    _odataOptions: Partial<OdataOption>;
+    protected _columnDefinitions: Column[];
+    set columnDefinitions(columnDefinitions: Column[]);
+    protected _datasetIdPropName: string;
+    set datasetIdPropName(datasetIdPropName: string);
+    constructor();
+    buildQuery(): string;
+    getFilterCount(): number;
+    get columnFilters(): any[];
+    get options(): Partial<OdataOption>;
+    set options(options: Partial<OdataOption>);
+    removeColumnFilter(fieldName: string): void;
+    saveColumnFilter(fieldName: string, value: any, searchTerms?: any[]): void;
+    /**
+     * Change any OData options that will be used to build the query
+     * @param object options
+     */
+    updateOptions(options: Partial<OdataOption>): void;
+    protected addToFilterQueueWhenNotExists(filterStr: string): void;
+    private buildSelectExpand;
+    private buildExpand;
+}
+//# sourceMappingURL=odataQueryBuilder.service.d.ts.map

package/dist/types/services/odataQueryBuilder.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"odataQueryBuilder.service.d.ts","sourceRoot":"","sources":["../../../src/services/odataQueryBuilder.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAE/D,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAElE,qBAAa,wBAAwB;IACnC,cAAc,EAAE,GAAG,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,SAAK;IACjB,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAEpC,SAAS,CAAC,kBAAkB,EAAE,MAAM,EAAE,CAAM;IAC5C,IAAW,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,EAAE,EAEvD;IAED,SAAS,CAAC,kBAAkB,SAAQ;IACpC,IAAW,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,EAErD;;IAeD,UAAU,IAAI,MAAM;IAwEpB,cAAc,IAAI,MAAM;IAIxB,IAAI,aAAa,IAAI,GAAG,EAAE,CAEzB;IAED,IAAI,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,CAElC;IAED,IAAI,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,EAExC;IAED,kBAAkB,CAAC,SAAS,EAAE,MAAM;IAMpC,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,GAAG,EAAE;IAOnE;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC;IA+B3C,SAAS,CAAC,6BAA6B,CAAC,SAAS,EAAE,MAAM;IAUzD,OAAO,CAAC,iBAAiB;IA8BzB,OAAO,CAAC,WAAW;CAuBpB"}

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@slickgrid-universal/odata",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Grid OData Service to sync a grid with an OData backend server",
   "main": "dist/commonjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {
     ".": {
-      "browser": "./dist/esm/index.js",
       "import": "./dist/esm/index.js",
-      "require": "./dist/commonjs/index.js"
+      "require": "./dist/commonjs/index.js",
+      "default": "./dist/esm/index.js"
     },
     "./*": "./*"
   },
   "typesVersions": {
     "*": {
       "*": [
-        "./dist/esm/index.d.ts"
+        "./dist/types/index.d.ts"
       ]
     }
   },
-  "types": "dist/esm/index.d.ts",
+  "types": "dist/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -43,12 +43,12 @@
     "not dead"
   ],
   "dependencies": {
-    "@slickgrid-universal/common": "~2.5.0",
-    "@slickgrid-universal/utils": "~2.5.0"
+    "@slickgrid-universal/common": "~2.6.0",
+    "@slickgrid-universal/utils": "~2.6.0"
   },
   "funding": {
     "type": "ko_fi",
     "url": "https://ko-fi.com/ghiscoding"
   },
-  "gitHead": "5e25aa044aab301d7246c24003386ab59e75b486"
+  "gitHead": "9cddf3ee91a91ca829d0ced99c1f20f6d0e9941f"
 }

package/dist/commonjs/interfaces/index.d.ts

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

package/dist/commonjs/interfaces/odataServiceApi.interface.d.ts

@@ -1,9 +0,0 @@
-import { BackendServiceApi } from '@slickgrid-universal/common';
-import { OdataOption } from './odataOption.interface';
-import { 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/dist/commonjs/services/index.d.ts

@@ -1,2 +0,0 @@
-export * from './grid-odata.service';
-export * from './odataQueryBuilder.service';

package/dist/esm/index.d.ts

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

package/dist/esm/interfaces/odataOption.interface.d.ts

@@ -1,37 +0,0 @@
-import { 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;
-    /** 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/dist/esm/interfaces/odataSortingOption.interface.d.ts

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

package/dist/esm/services/grid-odata.service.d.ts

@@ -1,74 +0,0 @@
-import { BackendService, Column, ColumnFilters, ColumnSort, CurrentFilter, CurrentPagination, CurrentSorter, FilterChangedArgs, FieldType, GridOption, MultiColumnSort, Pagination, PaginationChangedArgs, OperatorType, OperatorString, SearchTerm, SharedService, SingleColumnSort, SlickGrid } from '@slickgrid-universal/common';
-import { OdataQueryBuilderService } from './odataQueryBuilder.service';
-import { OdataOption } from '../interfaces/index';
-export declare class GridOdataService implements BackendService {
-    protected _currentFilters: CurrentFilter[];
-    protected _currentPagination: CurrentPagination | null;
-    protected _currentSorters: CurrentSorter[];
-    protected _columnDefinitions: Column[];
-    protected _grid: SlickGrid | undefined;
-    protected _odataService: OdataQueryBuilderService;
-    options?: Partial<OdataOption>;
-    pagination: Pagination | undefined;
-    defaultOptions: OdataOption;
-    /** Getter for the Column Definitions */
-    get columnDefinitions(): Column<any>[];
-    /** Getter for the Odata Service */
-    get odataService(): OdataQueryBuilderService;
-    /** Getter for the Grid Options pulled through the Grid Object */
-    protected get _gridOptions(): GridOption;
-    constructor();
-    init(serviceOptions?: Partial<OdataOption>, pagination?: Pagination, grid?: SlickGrid, sharedService?: SharedService): void;
-    buildQuery(): string;
-    postProcess(processResult: any): void;
-    clearFilters(): void;
-    clearSorters(): void;
-    updateOptions(serviceOptions?: Partial<OdataOption>): void;
-    removeColumnFilter(fieldName: string): void;
-    /** Get the Filters that are currently used by the grid */
-    getCurrentFilters(): CurrentFilter[];
-    /** Get the Pagination that is currently used by the grid */
-    getCurrentPagination(): CurrentPagination | null;
-    /** Get the Sorters that are currently used by the grid */
-    getCurrentSorters(): CurrentSorter[];
-    /**
-     * Mapper for mathematical operators (ex.: <= is "le", > is "gt")
-     * @param string operator
-     * @returns string map
-     */
-    mapOdataOperator(operator: string): string;
-    resetPaginationOptions(): void;
-    saveColumnFilter(fieldName: string, value: string, terms?: SearchTerm[]): void;
-    processOnFilterChanged(_event: Event | undefined, args: FilterChangedArgs): string;
-    processOnPaginationChanged(_event: Event | undefined, args: PaginationChangedArgs): string;
-    processOnSortChanged(_event: Event | undefined, args: SingleColumnSort | MultiColumnSort): string;
-    /**
-     * loop through all columns to inspect filters & update backend service filters
-     * @param columnFilters
-     */
-    updateFilters(columnFilters: ColumnFilters | CurrentFilter[], isUpdatedByPresetOrDynamically?: boolean): void;
-    /**
-     * Update the pagination component with it's new page number and size
-     * @param newPage
-     * @param pageSize
-     */
-    updatePagination(newPage: number, pageSize: number): void;
-    /**
-     * loop through all columns to inspect sorters & update backend service orderBy
-     * @param columnFilters
-     */
-    updateSorters(sortColumns?: ColumnSort[], presetSorters?: CurrentSorter[]): string;
-    /**
-     * Cast provided filters (could be in multiple format) into an array of ColumnFilter
-     * @param columnFilters
-     */
-    protected castFilterToColumnFilters(columnFilters: ColumnFilters | CurrentFilter[]): CurrentFilter[];
-    /**
-     * Filter by a range of searchTerms (2 searchTerms OR 1 string separated by 2 dots "value1..value2")
-     */
-    protected filterBySearchTermRange(fieldName: string, operator: OperatorType | OperatorString, searchTerms: SearchTerm[]): string;
-    /**
-     * Normalizes the search value according to field type and oData version.
-     */
-    protected normalizeSearchValue(fieldType: typeof FieldType[keyof typeof FieldType], searchValue: any, version: number): any;
-}

package/dist/esm/services/odataQueryBuilder.service.d.ts

@@ -1,28 +0,0 @@
-import { Column } from '@slickgrid-universal/common';
-import { OdataOption } from '../interfaces/odataOption.interface';
-export declare class OdataQueryBuilderService {
-    _columnFilters: any;
-    _defaultSortBy: string;
-    _filterCount: number;
-    _odataOptions: Partial<OdataOption>;
-    protected _columnDefinitions: Column[];
-    set columnDefinitions(columnDefinitions: Column[]);
-    protected _datasetIdPropName: string;
-    set datasetIdPropName(datasetIdPropName: string);
-    constructor();
-    buildQuery(): string;
-    getFilterCount(): number;
-    get columnFilters(): any[];
-    get options(): Partial<OdataOption>;
-    set options(options: Partial<OdataOption>);
-    removeColumnFilter(fieldName: string): void;
-    saveColumnFilter(fieldName: string, value: any, searchTerms?: any[]): void;
-    /**
-     * Change any OData options that will be used to build the query
-     * @param object options
-     */
-    updateOptions(options: Partial<OdataOption>): void;
-    protected addToFilterQueueWhenNotExists(filterStr: string): void;
-    private buildSelectExpand;
-    private buildExpand;
-}