@slickgrid-universal/graphql 2.4.1 → 2.6.0

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@slickgrid-universal/graphql",
-  "version": "2.4.1",
+  "version": "2.6.0",
   "description": "GraphQL Service to sync a grid with a GraphQL backend server",
   "main": "dist/commonjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {
     ".": {
-      "browser": "./dist/esm/index.js",
-      "import": "./dist/esm/index.d.ts",
-      "require": "./dist/commonjs/index.js"
+      "import": "./dist/esm/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,11 +43,11 @@
     "not dead"
   ],
   "dependencies": {
-    "@slickgrid-universal/common": "~2.4.1"
+    "@slickgrid-universal/common": "~2.6.0"
   },
   "funding": {
     "type": "ko_fi",
     "url": "https://ko-fi.com/ghiscoding"
   },
-  "gitHead": "e62c2da0d9d1c8e97462f4125bfdf735d4e4782d"
+  "gitHead": "9cddf3ee91a91ca829d0ced99c1f20f6d0e9941f"
 }

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

@@ -1,10 +0,0 @@
-export interface GraphqlCursorPaginationOption {
-    /** Start our page After cursor X */
-    after?: string;
-    /** Start our page Before cursor X */
-    before?: string;
-    /** Get first X number of objects */
-    first?: number;
-    /** Get last X number of objects */
-    last?: number;
-}

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

@@ -1,9 +0,0 @@
-import { OperatorString, OperatorType } from '@slickgrid-universal/common';
-export interface GraphqlFilteringOption {
-    /** Field name to use when filtering */
-    field: string;
-    /** Operator to use when filtering */
-    operator: OperatorType | OperatorString;
-    /** Value to use when filtering */
-    value: any | any[];
-}

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

@@ -1,22 +0,0 @@
-import { BackendServiceApi, Observable } from '@slickgrid-universal/common';
-import { GraphqlResult } from './graphqlResult.interface';
-import { GraphqlPaginatedResult } from './graphqlPaginatedResult.interface';
-import { GraphqlServiceOption } from './graphqlServiceOption.interface';
-import { GraphqlService } from '../services/index';
-export interface GraphqlServiceApi extends BackendServiceApi {
-    /** Backend Service Options */
-    options: GraphqlServiceOption;
-    /** Backend Service instance (could be OData or GraphQL Service) */
-    service: GraphqlService;
-    /** On init (or on page load), what action to perform? */
-    onInit?: (query: string) => Promise<GraphqlResult | GraphqlPaginatedResult> | Observable<GraphqlResult | GraphqlPaginatedResult>;
-    /** On Processing, we get the query back from the service, and we need to provide a Promise/Observable. For example: this.http.get(myGraphqlUrl) */
-    process: (query: string) => Promise<GraphqlResult | GraphqlPaginatedResult> | Observable<GraphqlResult | GraphqlPaginatedResult>;
-    /** After executing the query, what action to perform? For example, stop the spinner */
-    postProcess?: (response: GraphqlResult | GraphqlPaginatedResult) => void;
-    /**
-     * INTERNAL USAGE ONLY by Slickgrid-Universal
-     * This internal process will be run just before postProcess and is meant to refresh the Dataset & Pagination after a GraphQL call
-     */
-    internalPostProcess?: (result: GraphqlResult | GraphqlPaginatedResult) => void;
-}

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

@@ -1,34 +0,0 @@
-import { BackendServiceOption } from '@slickgrid-universal/common';
-import { GraphqlFilteringOption } from './graphqlFilteringOption.interface';
-import { GraphqlSortingOption } from './graphqlSortingOption.interface';
-import { GraphqlCursorPaginationOption } from './graphqlCursorPaginationOption.interface';
-import { GraphqlPaginationOption } from './graphqlPaginationOption.interface';
-import { QueryArgument } from './queryArgument.interface';
-export interface GraphqlServiceOption extends BackendServiceOption {
-    /**
-     * When using Translation, we probably want to add locale as a query parameter for the filterBy/orderBy to work
-     * ex.: users(first: 10, offset: 0, locale: "en-CA", filterBy: [{field: name, operator: EQ, value:"John"}]) { }
-     */
-    addLocaleIntoQuery?: boolean;
-    /** What is the dataset, this is required for the GraphQL query to be built */
-    datasetName: string;
-    /**
-     * Extra query arguments that be passed in addition to the default query arguments
-     * For example in GraphQL, if we want to pass "userId" and we want the query to look like
-     * users (first: 20, offset: 10, userId: 123) { ... }
-     */
-    extraQueryArguments?: QueryArgument[];
-    /** (NOT FULLY IMPLEMENTED) Is the GraphQL Server using cursors? */
-    isWithCursor?: boolean;
-    /** What are the pagination options? ex.: (first, last, offset) */
-    paginationOptions?: GraphqlPaginationOption | GraphqlCursorPaginationOption;
-    /** array of Filtering Options, ex.: { field: name, operator: EQ, value: "John" }  */
-    filteringOptions?: GraphqlFilteringOption[];
-    /** array of Filtering Options, ex.: { field: name, direction: DESC }  */
-    sortingOptions?: GraphqlSortingOption[];
-    /**
-     * Do we want to keep double quotes on field arguments of filterBy/sortBy (field: "name" instead of field: name)
-     * ex.: { field: "name", operator: EQ, value: "John" }
-     */
-    keepArgumentFieldDoubleQuotes?: boolean;
-}

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

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

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

@@ -1,10 +0,0 @@
-export * from './graphqlCursorPaginationOption.interface';
-export * from './graphqlDatasetFilter.interface';
-export * from './graphqlFilteringOption.interface';
-export * from './graphqlPaginatedResult.interface';
-export * from './graphqlPaginationOption.interface';
-export * from './graphqlResult.interface';
-export * from './graphqlServiceApi.interface';
-export * from './graphqlServiceOption.interface';
-export * from './graphqlSortingOption.interface';
-export * from './queryArgument.interface';

package/dist/commonjs/services/graphqlQueryBuilder.d.ts

@@ -1,38 +0,0 @@
-/**
- * This GraphqlQueryBuilder class is a lib that already exist
- * but was causing issues with TypeScript, RequireJS and other bundler/packagers
- * and so I rewrote it in pure TypeScript.
- *
- * The previous lib can be viewed here at this Github
- * https://github.com/codemeasandwich/graphql-query-builder
- */
-export default class GraphqlQueryBuilder {
-    protected queryFnName: string;
-    alias: string | Function;
-    head: any[];
-    body: any;
-    constructor(queryFnName: string, aliasOrFilter?: string | object);
-    /**
-     * The parameters to run the query against.
-     * @param filters An object mapping attribute to values
-     */
-    filter(filters: any): this;
-    /**
-     * Outlines the properties you wish to be returned from the query.
-     * @param properties representing each attribute you want Returned
-     */
-    find(...searches: any[]): this;
-    /**
-     * set an alias for this result.
-     * @param alias
-     */
-    setAlias(alias: string): void;
-    /**
-     * Return to the formatted query string
-     * @return
-     */
-    toString(): string;
-    protected parceFind(_levelA: any[]): string;
-    protected getGraphQLValue(value: any): any;
-    protected objectToString(obj: any): string;
-}

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

@@ -1,2 +0,0 @@
-export * from './graphql.service';
-export { default as GraphqlQueryBuilder } from './graphqlQueryBuilder';

package/dist/esm/index.d.ts

@@ -1,3 +0,0 @@
-export { GraphqlService } from './services/graphql.service';
-export { default as GraphqlQueryBuilder } from './services/graphqlQueryBuilder';
-export * from './interfaces/index';

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

@@ -1,12 +0,0 @@
-import { GraphqlFilteringOption } from './graphqlFilteringOption.interface';
-import { GraphqlSortingOption } from './graphqlSortingOption.interface';
-export interface GraphqlDatasetFilter {
-    first?: number;
-    last?: number;
-    offset?: number;
-    after?: string;
-    before?: string;
-    locale?: string;
-    filterBy?: GraphqlFilteringOption[];
-    orderBy?: GraphqlSortingOption[];
-}

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

@@ -1,29 +0,0 @@
-import { Metrics } from '@slickgrid-universal/common';
-export interface GraphqlPaginatedResult {
-    data: {
-        [datasetName: string]: {
-            /** result set of data objects (array of data) */
-            nodes: any[];
-            /** Total count of items in the table (needed for the Pagination to work) */
-            totalCount: number;
-            /** Edges information of the current cursor */
-            edges?: {
-                /** Current cursor position */
-                cursor: string;
-            };
-            /** Page information of the current cursor, do we have a next page and what is the end cursor? */
-            pageInfo?: {
-                /** Do we have a next page from current cursor position? */
-                hasNextPage: boolean;
-                /** Do we have a previous page from current cursor position? */
-                hasPreviousPage: boolean;
-                /** What is the last cursor? */
-                endCursor: string;
-                /** What is the first cursor? */
-                startCursor: string;
-            };
-        };
-    };
-    /** Some metrics of the last executed query (startTime, endTime, executionTime, itemCount, totalItemCount) */
-    metrics?: Metrics;
-}

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

@@ -1,5 +0,0 @@
-export interface GraphqlPaginationOption {
-    first?: number;
-    last?: number;
-    offset?: number;
-}

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

@@ -1,8 +0,0 @@
-import { Metrics } from '@slickgrid-universal/common';
-export interface GraphqlResult<T = any> {
-    data: {
-        [datasetName: string]: T[];
-    };
-    /** Some metrics of the last executed query (startTime, endTime, executionTime, itemCount, totalItemCount) */
-    metrics?: Metrics;
-}

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

@@ -1,4 +0,0 @@
-export interface QueryArgument {
-    field: string;
-    value: string | number | boolean;
-}

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

@@ -1,99 +0,0 @@
-import { BackendService, Column, ColumnFilters, ColumnSort, CurrentFilter, CurrentPagination, CurrentSorter, FieldType, FilterChangedArgs, GridOption, MultiColumnSort, Pagination, PaginationChangedArgs, SharedService, SingleColumnSort, SlickGrid } from '@slickgrid-universal/common';
-import { GraphqlCursorPaginationOption, GraphqlDatasetFilter, GraphqlPaginationOption, GraphqlServiceOption } from '../interfaces/index';
-export declare class GraphqlService implements BackendService {
-    protected _currentFilters: ColumnFilters | CurrentFilter[];
-    protected _currentPagination: CurrentPagination | null;
-    protected _currentSorters: CurrentSorter[];
-    protected _columnDefinitions?: Column[];
-    protected _grid: SlickGrid | undefined;
-    protected _datasetIdPropName: string;
-    options: GraphqlServiceOption | undefined;
-    pagination: Pagination | undefined;
-    defaultPaginationOptions: GraphqlPaginationOption | GraphqlCursorPaginationOption;
-    /** Getter for the Column Definitions */
-    get columnDefinitions(): Column<any>[] | undefined;
-    /** Getter for the Grid Options pulled through the Grid Object */
-    protected get _gridOptions(): GridOption;
-    /** Initialization of the service, which acts as a constructor */
-    init(serviceOptions?: GraphqlServiceOption, pagination?: Pagination, grid?: SlickGrid, sharedService?: SharedService): void;
-    /**
-     * Build the GraphQL query, since the service include/exclude cursor, the output query will be different.
-     * @param serviceOptions GraphqlServiceOption
-     */
-    buildQuery(): string;
-    /**
-     * From an input array of strings, we want to build a GraphQL query string.
-     * The process has to take the dot notation and parse it into a valid GraphQL query
-     * Following this SO answer https://stackoverflow.com/a/47705476/1212166
-     *
-     * INPUT
-     *  ['firstName', 'lastName', 'billing.address.street', 'billing.address.zip']
-     * OUTPUT
-     * firstName, lastName, billing{address{street, zip}}
-     * @param inputArray
-     */
-    buildFilterQuery(inputArray: string[]): string;
-    clearFilters(): void;
-    clearSorters(): void;
-    /**
-     * Get an initialization of Pagination options
-     * @return Pagination Options
-     */
-    getInitPaginationOptions(): GraphqlDatasetFilter;
-    /** Get the GraphQL dataset name */
-    getDatasetName(): string;
-    /** Get the Filters that are currently used by the grid */
-    getCurrentFilters(): ColumnFilters | 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[];
-    resetPaginationOptions(): void;
-    updateOptions(serviceOptions?: Partial<GraphqlServiceOption>): 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 filteringOptions
-     * @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 sortingOptions
-     * @param columnFilters
-     */
-    updateSorters(sortColumns?: ColumnSort[], presetSorters?: CurrentSorter[]): void;
-    /**
-     * A function which takes an input string and removes double quotes only
-     * on certain fields are identified as GraphQL enums (except fields with dot notation)
-     * For example let say we identified ("direction:", "sort") as word which are GraphQL enum fields
-     * then the result will be:
-     * FROM
-     * query { users (orderBy:[{field:"firstName", direction:"ASC"} }]) }
-     * TO
-     * query { users (orderBy:[{field: firstName, direction: ASC}})}
-     *
-     * EXCEPTIONS (fields with dot notation "." which are inside a "field:")
-     * these fields will keep double quotes while everything else will be stripped of double quotes
-     * query { users (orderBy:[{field:"billing.street.name", direction: "ASC"} }
-     * TO
-     * query { users (orderBy:[{field:"billing.street.name", direction: ASC}}
-     * @param inputStr input string
-     * @param enumSearchWords array of enum words to filter
-     * @returns outputStr output string
-     */
-    trimDoubleQuotesOnEnumField(inputStr: string, enumSearchWords: string[], keepArgumentFieldDoubleQuotes: boolean): string;
-    /**
-     * Cast provided filters (could be in multiple formats) into an array of CurrentFilter
-     * @param columnFilters
-     */
-    protected castFilterToColumnFilters(columnFilters: ColumnFilters | CurrentFilter[]): CurrentFilter[];
-    /** Normalizes the search value according to field type. */
-    protected normalizeSearchValue(fieldType: typeof FieldType[keyof typeof FieldType], searchValue: any): any;
-}