prepare release 0.8.0

dist/package.json

@@ -1 +1 @@
-{"name":"angular-slickgrid","version":"0.7.10","description":"Slickgrid components made available in Angular","keywords":["angular","plugin","datatable","slickgrid"],"license":"MIT","scripts":{"ng":"ng","start":"ng serve","build":"ng build","test":"ng test","lint":"ng lint","e2e":"ng e2e","build-lib":"npm-run-all packagr sass:build sass:copy copy:i18n","build-lib-pack":"npm-run-all build-lib pack-lib copy-pack del-pack","copy:i18n":"cross-env copyfiles -f src/assets/i18n/*.json dist/i18n","copy-pack":"cross-env copyfiles -f *.tgz ../Angular-Slickgrid-PackageTest","del-pack":"cross-env del *.tgz","pack-lib":"npm pack ./dist","packagr":"ng-packagr -p ng-package.json","sass-build-task:scss-compile":"node-sass --source-map true src/app/modules/angular-slickgrid/styles/ -o dist/styles/css","sass-build-task:autoprefixer":"postcss dist/styles/css/*.css --use autoprefixer -d dist/styles/css","sass:build":"npm-run-all -p sass-build-task:*","sass:copy":"cross-env copyfiles -f src/app/modules/angular-slickgrid/styles/*.scss dist/styles/sass","sass:watch":"node-sass 'src/app/modules/angular-slickgrid/styles/**/*.scss' -c 'npm run sass:build'"},"author":"Ghislain B.","repository":{"type":"git","url":"http://github.com/ghiscoding/angular-slickgrid"},"private":false,"dependencies":{"@ngx-translate/core":"^9.1.1","@ngx-translate/http-loader":"^2.0.0","bootstrap":"^3.3.7","core-js":"^2.5.1","flatpickr":"^4.0.6","font-awesome":"^4.7.0","jquery":"^3.2.1","lodash":"^4.17.4","moment-mini":"^2.18.1","slickgrid":"^2.3.12","vinyl-paths":"^2.1.0"},"devDependencies":{"@angular/animations":"^5.0.0","@angular/cli":"1.5.4","@angular/common":"^5.0.0","@angular/compiler":"^5.0.0","@angular/compiler-cli":"^5.0.0","@angular/core":"^5.0.0","@angular/forms":"^5.0.0","@angular/http":"^5.0.0","@angular/language-service":"^5.0.0","@angular/platform-browser":"^5.0.0","@angular/platform-browser-dynamic":"^5.0.0","@angular/router":"^5.0.0","@types/flatpickr":"^3.1.2","@types/jasmine":"~2.6.0","@types/jasminewd2":"~2.0.3","@types/moment":"^2.13.0","@types/node":"^8.0.39","codelyzer":"~3.2.0","copyfiles":"^1.2.0","cross-env":"^5.1.0","del":"^3.0.0","del-cli":"^1.1.0","gulp":"^3.9.1","gulp-bump":"^2.7.0","gulp-sass":"^3.1.0","gulp-yuidoc":"^0.1.2","jasmine-core":"~2.8.0","jasmine-spec-reporter":"~4.2.1","karma":"~1.7.1","karma-chrome-launcher":"~2.2.0","karma-cli":"~1.0.1","karma-coverage-istanbul-reporter":"^1.3.0","karma-jasmine":"~1.1.0","karma-jasmine-html-reporter":"^0.2.2","ng-packagr":"^1.6.0","node-sass":"^4.5.3","npm-run-all":"^4.1.1","postcss-cli":"^4.1.1","protractor":"~5.1.2","require-dir":"^0.3.2","run-sequence":"^2.2.0","rxjs":"^5.4.2","ts-node":"~3.3.0","tslint":"^5.8.0","typescript":"^2.3.4","yargs":"^9.0.1","zone.js":"^0.8.17"},"main":"bundles/angular-slickgrid.umd.js","module":"angular-slickgrid.es5.js","es2015":"angular-slickgrid.js","typings":"angular-slickgrid.d.ts","metadata":"angular-slickgrid.metadata.json"}
+{"name":"angular-slickgrid","version":"0.8.0","description":"Slickgrid components made available in Angular","keywords":["angular","plugin","datatable","slickgrid"],"license":"MIT","scripts":{"ng":"ng","start":"ng serve","build":"ng build","test":"ng test","lint":"ng lint","e2e":"ng e2e","build-lib":"npm-run-all packagr sass:build sass:copy copy:i18n","build-lib-pack":"npm-run-all build-lib pack-lib copy-pack del-pack","copy:i18n":"cross-env copyfiles -f src/assets/i18n/*.json dist/i18n","copy-pack":"cross-env copyfiles -f *.tgz ../Angular-Slickgrid-PackageTest","del-pack":"cross-env del *.tgz","pack-lib":"npm pack ./dist","packagr":"ng-packagr -p ng-package.json","sass-build-task:scss-compile":"node-sass --source-map true src/app/modules/angular-slickgrid/styles/ -o dist/styles/css","sass-build-task:autoprefixer":"postcss dist/styles/css/*.css --use autoprefixer -d dist/styles/css","sass:build":"npm-run-all -p sass-build-task:*","sass:copy":"cross-env copyfiles -f src/app/modules/angular-slickgrid/styles/*.scss dist/styles/sass","sass:watch":"node-sass 'src/app/modules/angular-slickgrid/styles/**/*.scss' -c 'npm run sass:build'"},"author":"Ghislain B.","repository":{"type":"git","url":"http://github.com/ghiscoding/angular-slickgrid"},"private":false,"dependencies":{"@ngx-translate/core":"^9.1.1","@ngx-translate/http-loader":"^2.0.0","bootstrap":"^3.3.7","core-js":"^2.5.1","flatpickr":"^4.0.6","font-awesome":"^4.7.0","jquery":"^3.2.1","lodash":"^4.17.4","moment-mini":"^2.18.1","slickgrid":"^2.3.12","vinyl-paths":"^2.1.0"},"devDependencies":{"@angular/animations":"^5.0.0","@angular/cli":"1.5.4","@angular/common":"^5.0.0","@angular/compiler":"^5.0.0","@angular/compiler-cli":"^5.0.0","@angular/core":"^5.0.0","@angular/forms":"^5.0.0","@angular/http":"^5.0.0","@angular/language-service":"^5.0.0","@angular/platform-browser":"^5.0.0","@angular/platform-browser-dynamic":"^5.0.0","@angular/router":"^5.0.0","@types/flatpickr":"^3.1.2","@types/jasmine":"~2.6.0","@types/jasminewd2":"~2.0.3","@types/moment":"^2.13.0","@types/node":"^8.0.39","codelyzer":"~3.2.0","copyfiles":"^1.2.0","cross-env":"^5.1.0","del":"^3.0.0","del-cli":"^1.1.0","gulp":"^3.9.1","gulp-bump":"^2.7.0","gulp-sass":"^3.1.0","gulp-yuidoc":"^0.1.2","jasmine-core":"~2.8.0","jasmine-spec-reporter":"~4.2.1","karma":"~1.7.1","karma-chrome-launcher":"~2.2.0","karma-cli":"~1.0.1","karma-coverage-istanbul-reporter":"^1.3.0","karma-jasmine":"~1.1.0","karma-jasmine-html-reporter":"^0.2.2","ng-packagr":"^1.6.0","node-sass":"^4.5.3","npm-run-all":"^4.1.1","postcss-cli":"^4.1.1","protractor":"~5.1.2","require-dir":"^0.3.2","run-sequence":"^2.2.0","rxjs":"^5.4.2","ts-node":"~3.3.0","tslint":"^5.8.0","typescript":"^2.3.4","yargs":"^9.0.1","zone.js":"^0.8.17"},"main":"bundles/angular-slickgrid.umd.js","module":"angular-slickgrid.es5.js","es2015":"angular-slickgrid.js","typings":"angular-slickgrid.d.ts","metadata":"angular-slickgrid.metadata.json"}

dist/src/app/modules/angular-slickgrid/components/angular-slickgrid.component.d.ts

@@ -49,7 +49,7 @@ export declare class AngularSlickgridComponent implements AfterViewInit, OnDestr
     onGridCreated: EventEmitter<any>;
     onBeforeGridCreate: EventEmitter<boolean>;
     onBeforeGridDestroy: EventEmitter<any>;
-    onGridDestroyed: EventEmitter<boolean>;
+    onAfterGridDestroyed: EventEmitter<boolean>;
     gridId: string;
     columnDefinitions: Column[];
     gridOptions: GridOption;
@@ -61,7 +61,12 @@ export declare class AngularSlickgridComponent implements AfterViewInit, OnDestr
     ngOnDestroy(): void;
     destroy(): void;
     ngAfterViewInit(): void;
-    attachDifferentHooks(grid: any, options: GridOption, dataView: any): void;
+    /**
+     * Define what our internal Post Process callback, it will execute internally after we get back result from the Process backend call
+     * For now, this is GraphQL Service only feautre and it will basically refresh the Dataset & Pagination without having the user to create his own PostProcess every time
+     */
+    createBackendApiInternalPostProcessCallback(): void;
+    attachDifferentHooks(grid: any, gridOptions: GridOption, dataView: any): void;
     attachResizeHook(grid: any, options: GridOption): void;
     mergeGridOptions(): GridOption;
     /**

dist/src/app/modules/angular-slickgrid/editors/dateEditor.d.ts

@@ -1,11 +1,13 @@
-import { Editor } from './../models';
+import { Column, Editor, GridOption } from './../models';
 export declare class DateEditor implements Editor {
     private args;
     $input: any;
     flatInstance: any;
     defaultDate: string;
     constructor(args: any);
     init(): void;
+    getCurrentLocale(columnDef: Column, gridOptions: GridOption): any;
+    loadFlatpickrLocale(locale: string): any;
     destroy(): void;
     show(): void;
     hide(): void;

dist/src/app/modules/angular-slickgrid/index.d.ts

@@ -18,6 +18,7 @@ export { FormElementType } from './models/formElementType';
 export { GraphqlDatasetFilter } from './models/graphqlDatasetFilter.interface';
 export { GraphqlCursorPaginationOption } from './models/graphqlCursorPaginationOption.interface';
 export { GraphqlFilteringOption } from './models/graphqlFilteringOption.interface';
+export { GraphqlResult } from './models/graphqlResult.interface';
 export { GraphqlPaginationOption } from './models/graphqlPaginationOption.interface';
 export { GraphqlServiceOption } from './models/graphqlServiceOption.interface';
 export { GraphqlSortingOption } from './models/graphqlSortingOption.interface';

dist/src/app/modules/angular-slickgrid/models/backendEventChanged.interface.d.ts

@@ -1,11 +1,22 @@
 import { BackendService } from './index';
 import { Observable } from 'rxjs/Observable';
-import 'rxjs/add/operator/toPromise';
+import { GraphqlResult } from './graphqlResult.interface';
 export interface BackendEventChanged {
-    onInit?: (query: string) => Promise<any> | Observable<any>;
+    /** On init (or on page load), what action to perform? */
+    onInit?: (query: string) => Promise<GraphqlResult | any> | Observable<GraphqlResult | any>;
+    /** Before executing the query, what action to perform? For example, start a spinner */
     preProcess?: () => void;
-    process: (query: string) => Promise<any> | Observable<any>;
-    postProcess: (response: any) => void;
-    service: BackendService;
+    /** 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 | any> | Observable<GraphqlResult | any>;
+    /** After executing the query, what action to perform? For example, stop the spinner */
+    postProcess?: (response: any) => void;
+    /** Backend Service instance (could be OData or GraphQL Service) */
+    service?: BackendService;
+    /** How long to wait until we start querying backend to avoid sending too many requests to backend server. Default to 750ms */
     filterTypingDebounce?: number;
+    /**
+     * INTERNAL USAGE ONLY by Angular-Validation
+     * This internal process will be run just before postProcess and is meant to refresh the Dataset & Pagination after a GraphQL call
+     */
+    internalPostProcess?: (result: GraphqlResult) => void;
 }

dist/src/app/modules/angular-slickgrid/models/backendService.interface.d.ts

@@ -3,8 +3,10 @@ import { SortChangedArgs } from './sortChangedArgs.interface';
 import { PaginationChangedArgs } from './paginationChangedArgs.interface';
 import { FilterChangedArgs } from './filterChangedArgs.interface';
 export interface BackendService {
+    options?: BackendServiceOption;
     buildQuery: (serviceOptions?: BackendServiceOption) => string;
     initOptions: (serviceOptions?: BackendServiceOption) => void;
+    getDatasetName?: () => string;
     resetPaginationOptions: () => void;
     updateOptions: (serviceOptions?: BackendServiceOption) => void;
     onFilterChanged: (event: Event, args: FilterChangedArgs) => Promise<string>;

dist/src/app/modules/angular-slickgrid/models/backendServiceApi.interface.d.ts

@@ -0,0 +1,26 @@
+import { OdataOption } from './odataOption.interface';
+import { GraphqlResult } from './graphqlResult.interface';
+import { BackendService } from './backendService.interface';
+import { GraphqlServiceOption } from './graphqlServiceOption.interface';
+import { Observable } from 'rxjs/Observable';
+export interface BackendServiceApi {
+    /** Backend Service Options */
+    options: OdataOption | GraphqlServiceOption;
+    /** Backend Service instance (could be OData or GraphQL Service) */
+    service: BackendService;
+    /** On init (or on page load), what action to perform? */
+    onInit?: (query: string) => Promise<GraphqlResult | any> | Observable<GraphqlResult | any>;
+    /** Before executing the query, what action to perform? For example, start a spinner */
+    preProcess?: () => void;
+    /** 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 | any> | Observable<GraphqlResult | any>;
+    /** After executing the query, what action to perform? For example, stop the spinner */
+    postProcess?: (response: any) => void;
+    /** How long to wait until we start querying backend to avoid sending too many requests to backend server. Default to 750ms */
+    filterTypingDebounce?: number;
+    /**
+     * INTERNAL USAGE ONLY by Angular-Validation
+     * This internal process will be run just before postProcess and is meant to refresh the Dataset & Pagination after a GraphQL call
+     */
+    internalPostProcess?: (result: GraphqlResult) => void;
+}

dist/src/app/modules/angular-slickgrid/models/backendServiceOption.interface.d.ts

@@ -1,8 +1,13 @@
 import { BackendEventChanged } from './backendEventChanged.interface';
 export interface BackendServiceOption {
+    /** Array of column ids that are included in the column definitions */
     datasetName?: string;
+    /** What are the pagination options? ex.: (first, last, offset) */
     paginationOptions?: any;
+    /** array of Filtering Options, ex.: { field: name, operator: EQ, value: "John" }  */
     filteringOptions?: any[];
+    /** array of Filtering Options, ex.: { field: name, direction: DESC }  */
     sortingOptions?: any[];
+    /** Backend Event callbacks that will be used by the Backend Service */
     onBackendEventApi?: BackendEventChanged;
 }

dist/src/app/modules/angular-slickgrid/models/column.interface.d.ts

@@ -40,6 +40,7 @@ export interface Column {
     outputType?: FieldType;
     params?: any;
     previousWidth?: number;
+    queryField?: string;
     resizable?: boolean;
     rerenderOnResize?: boolean;
     showHidden?: boolean;

dist/src/app/modules/angular-slickgrid/models/graphqlDatasetFilter.interface.d.ts

@@ -6,6 +6,7 @@ export interface GraphqlDatasetFilter {
     offset?: number;
     after?: string;
     before?: string;
+    locale?: string;
     filterBy?: GraphqlFilteringOption[];
     orderBy?: GraphqlSortingOption[];
 }

dist/src/app/modules/angular-slickgrid/models/graphqlResult.interface.d.ts

@@ -0,0 +1,11 @@
+export interface GraphqlResult {
+    data: {
+        [datasetName: string]: {
+            nodes: any[];
+            pageInfo: {
+                hasNextPage: boolean;
+            };
+            totalCount: number;
+        };
+    };
+}

dist/src/app/modules/angular-slickgrid/models/graphqlServiceOption.interface.d.ts

@@ -5,13 +5,32 @@ import { GraphqlSortingOption } from './graphqlSortingOption.interface';
 import { GraphqlCursorPaginationOption } from './graphqlCursorPaginationOption.interface';
 import { GraphqlPaginationOption } from './graphqlPaginationOption.interface';
 export interface GraphqlServiceOption extends BackendServiceOption {
+    /**
+     * When using Translation, we probably want to add locale in the query for the filterBy/orderBy to work
+     * ex.: users(first: 10, offset: 0, locale: "en-CA", filterBy: [{field: name, operator: EQ, value:"John"}]) {
+     */
+    addLocaleIntoQuery?: boolean;
+    /** Array of column ids that are included in the column definitions */
     columnIds?: string[];
+    /** DEPRECATED, please use "columnIds" or "columnDefinitions" instead */
     dataFilters?: string[];
+    /** What is the dataset, this is required for the GraphQL query to be built */
     datasetName?: string;
+    /** Column definitions, you can pass this instead of "columnIds" */
     columnDefinitions?: Column[];
+    /** Execute the process callback command on component init (page load) */
+    executeProcessCommandOnInit?: boolean;
+    /** (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;
 }

dist/src/app/modules/angular-slickgrid/models/gridOption.interface.d.ts

@@ -1,5 +1,6 @@
 import { AutoResizeOption } from './autoResizeOption.interface';
 import { BackendEventChanged } from './backendEventChanged.interface';
+import { BackendServiceApi } from './backendServiceApi.interface';
 import { ColumnPicker } from './columnPicker.interface';
 import { CheckboxSelector } from './checkboxSelector.interface';
 import { GridMenu } from './gridMenu.interface';
@@ -16,6 +17,8 @@ export interface GridOption {
         enableForHeaderCells: boolean;
         maxToolTipLength: number;
     };
+    /** Backend Service API definition (GraphQL/OData Services), also goes with onBackendEventApi */
+    backendServiceApi?: BackendServiceApi;
     cellHighlightCssClass?: string | null;
     checkboxSelector?: CheckboxSelector;
     columnPicker?: ColumnPicker;
@@ -47,9 +50,12 @@ export interface GridOption {
     headerMenu?: HeaderMenu;
     locale?: string;
     multiColumnSort?: boolean;
+    /** DEPRECATED, Please use "backendServiceApi" instead */
     onBackendEventApi?: BackendEventChanged;
+    /** Pagination options, these are used ONLY with a Backend Service API (GraphQL/OData Services) */
     pagination?: Pagination;
-    params?: any;
+    /** if you want to pass custom paramaters to your Formatter/Editor or anything else */
+    params?: any | any[];
     registerPlugins?: any | any[];
     rowHeight?: number;
     rowSelectionOptions?: {

dist/src/app/modules/angular-slickgrid/models/index.d.ts

@@ -20,9 +20,11 @@ export { GraphqlDatasetFilter } from './graphqlDatasetFilter.interface';
 export { GraphqlCursorPaginationOption } from './graphqlCursorPaginationOption.interface';
 export { GraphqlFilteringOption } from './graphqlFilteringOption.interface';
 export { GraphqlPaginationOption } from './graphqlPaginationOption.interface';
+export { GraphqlResult } from './graphqlResult.interface';
 export { GraphqlServiceOption } from './graphqlServiceOption.interface';
 export { GraphqlSortingOption } from './graphqlSortingOption.interface';
 export { CustomGridMenu } from './customGridMenu.interface';
+export { GridMenu } from './gridMenu.interface';
 export { GridOption } from './gridOption.interface';
 export { HeaderButton } from './headerButton.interface';
 export { HeaderButtonItem } from './headerButtonItem.interface';

dist/src/app/modules/angular-slickgrid/services/controlAndPlugin.service.d.ts

@@ -28,14 +28,33 @@ export declare class ControlAndPluginService {
      */
     attachDifferentControlOrPlugins(grid: any, columnDefinitions: Column[], options: GridOption, dataView: any): void;
     createColumnPicker(grid: any, columnDefinitions: Column[], options: GridOption): void;
+    /**
+     * Create (or re-create) Grid Menu and expose all the available hooks that user can subscribe (onCommand, onMenuClose, ...)
+     * @param grid
+     * @param columnDefinitions
+     * @param options
+     */
     createGridMenu(grid: any, columnDefinitions: Column[], options: GridOption): any;
     hideColumn(column: Column): void;
     removeColumnByIndex(array: any[], index: number): any[];
     autoResizeColumns(): void;
     destroy(): void;
+    /**
+     * Create Grid Menu with Custom Commands if user has enabled Filters and/or uses a Backend Service (OData, GraphQL)
+     * @param grid
+     * @param options
+     */
     private addGridMenuCustomCommands(grid, options);
-    private prepareGridMenu(grid, options);
-    private refreshBackendDataset(options);
+    /**
+     * @return default Grid Menu options
+     */
+    private getDefaultGridMenuOptions();
+    private refreshBackendDataset(gridOptions);
+    /**
+     * Reset all the Grid Menu options which have text to translate
+     * @param grid menu object
+     */
+    private resetGridMenuTranslations(gridMenu);
     /**
      * Translate the Column Picker and it's last 2 checkboxes
      * Note that the only way that seems to work is to destroy and re-create the Column Picker