basesite-shared-grid-lib 0.0.1

package/lib/helpers/oDataProvider.d.ts

@@ -0,0 +1,338 @@
+import { IGetRowsParams, ColDef, ColGroupDef, IServerSideGetRowsRequest, IServerSideGetRowsParams } from 'ag-grid-community';
+import { OdataQueryExtendFull, OdataQueryExtendOptions, OdataQueryOptions } from './types';
+export declare class OdataProviderOptions {
+    /**
+     * Function for call odata api
+     */
+    callApi: (query: string) => Promise<any>;
+    /**
+     * Name of field contain count of record results in grouping odata query
+     * @default childCount
+     */
+    groupCountFieldName?: string;
+    /**
+     * Use in odata build query
+     * @default false
+     */
+    isCaseSensitiveStringFilter?: boolean;
+    /**
+     * Callback for extend odata query options for implement user logic
+     */
+    beforeRequest?: (options: OdataQueryOptions, provider: OdataProvider, request: IGetRowsParams | IServerSideGetRowsRequest) => void;
+    /**
+    * Callback for pivot or group for aplly column ag-grid settings
+    * @example
+    * <pre><code>
+    * beforeSetSecondaryColumns = secondaryColumns => {
+     for (let i = 0; i < secondaryColumns.length; i++) {
+       const col = secondaryColumns[i]
+       if (col.children) {
+         beforeSetSecondaryColumns(col.children)
+       } else {
+         //Aplly new setting for group dyncamic created column
+         // col.cellClassRules =
+         // col.valueFormatter =
+       }
+     }
+   }
+    * </pre></code>
+    */
+    beforeSetSecondaryColumns?: (secondaryColDefs: (ColDef | ColGroupDef)[]) => void;
+    /**
+    * Callback invoked after load data
+    * @param options odata provider options
+    * @param rowData data for ag-grid
+    * @param totalCount total count records
+    *
+    * @example
+    * <pre><code>
+         afterLoadData = (options, rowData, totalCount) => {
+             if (options.skip === 0 && rowData.length > 0) {
+             gridApi.columnController.autoSizeAllColumns()
+             }
+         }
+    * </code></pre>
+    */
+    afterLoadData?: (options: OdataQueryExtendOptions, rowData: any[], totalCount: number) => void;
+    /**
+     * Callback for catch error
+     */
+    setError?: (error: any, params: IGetRowsParams | IServerSideGetRowsParams) => void;
+    /**
+     * List of columns by id/field are case sensitive for build odata query
+     */
+    caseSensitiveColumns?: string[];
+    /**
+     * Use for specified column custom filter implementation
+     * <pre><code>
+         customFilters: {
+             "customer": (colName,col,isCaseSensitiveStringFilter,provider) =>{
+               return provider.odataOperator.in(
+                colName,
+                col.values
+              )
+             }
+         }
+     */
+    customFilters?: {
+        [index: string]: (colName: string, col: any, isCaseSensitiveStringFilter: boolean, provider: OdataProvider) => string;
+    };
+}
+declare interface CancelablePromise {
+    promise: Promise<any>;
+    cancel: () => void;
+}
+export declare class OdataProvider implements OdataProviderOptions {
+    /**
+     * Function for call odata api
+     */
+    callApi: (query: string) => Promise<any>;
+    /**
+     * Name of field contain count of record results in grouping odata query
+     * @default childCount
+     */
+    groupCountFieldName: string;
+    /**
+     * Use in odata build query
+     * @default false
+     */
+    isCaseSensitiveStringFilter: boolean;
+    /**
+     * Callback for extend odata query options for implement user logic
+     */
+    beforeRequest: ((options: OdataQueryOptions, provider: OdataProvider, request: IGetRowsParams | IServerSideGetRowsRequest) => void) | undefined;
+    /**
+      * Callback for pivot or group for aplly column ag-grid settings
+      * @example
+      * <pre><code>
+      * beforeSetSecondaryColumns = secondaryColumns => {
+       for (let i = 0; i < secondaryColumns.length; i++) {
+         const col = secondaryColumns[i]
+         if (col.children) {
+           beforeSetSecondaryColumns(col.children)
+         } else {
+           //Aplly new setting for group dyncamic created column
+           // col.cellClassRules =
+           // col.valueFormatter =
+         }
+       }
+     }
+      * </pre></code>
+      */
+    beforeSetSecondaryColumns: ((secondaryColDefs: (ColDef | ColGroupDef)[]) => void) | undefined;
+    /**
+      * Callback invoked after load data
+      * @param options odata provider options
+      * @param rowData data for ag-grid
+      * @param totalCount total count records
+      *
+      * @example
+      * <pre><code>
+           afterLoadData = (options, rowData, totalCount) => {
+               if (options.skip === 0 && rowData.length > 0) {
+               gridApi.columnController.autoSizeAllColumns()
+               }
+           }
+      * </code></pre>
+      */
+    afterLoadData: ((options: OdataQueryExtendOptions, rowData: any[], totalCount: number) => void) | undefined;
+    /**
+     * Callback for catch error
+     */
+    setError: ((error: any, params: IGetRowsParams | IServerSideGetRowsParams) => void) | undefined;
+    /**
+     * List of columns by id/field are case sensitive for build odata query
+     */
+    caseSensitiveColumns?: string[];
+    /**
+     * Use for specified column custom filter implementation
+     * <pre><code>
+         customFilters: {
+             "customer": (colName,col,isCaseSensitiveStringFilter,provider) =>{
+               return provider.odataOperator.in(
+                colName,
+                col.values
+              )
+             }
+         }
+     */
+    customFilters?: {
+        [index: string]: (colName: string, col: any, isCaseSensitiveStringFilter: boolean, provider: OdataProvider) => string;
+    };
+    cancelPromice: CancelablePromise;
+    constructor(options: OdataProviderOptions);
+    /**Creator a cancelable Promise */
+    createCancelablePromise: () => CancelablePromise;
+    /**Odata query operations */
+    odataOperator: any;
+    /**
+     * Apply tolower for column in odata syntax
+     * @param col column name
+     * @param isCaseSensitiveStringFilter need apply tolower
+     */
+    ifTolowerCol: (col: string, isCaseSensitiveStringFilter: boolean) => string;
+    /**
+     *
+     * @param value string value
+     * @param isCaseSensitiveStringFilter  need apply tolower
+     */
+    ifTolower: (value: string, isCaseSensitiveStringFilter: boolean) => string;
+    /**
+     * Odata aggregation operations
+     */
+    odataAggregation: any;
+    /**
+     * Odata query builder
+     * @param options parameter for odata query
+     */
+    toQuery: (options: OdataQueryExtendFull) => string;
+    /**
+     * Add quotes for string value
+     * @param value string value
+     */
+    encode: (value: string) => string;
+    /**
+     * Conctat to date a time for create datetime format for odata query
+     * @param value date string
+     */
+    toDateTime: (value: string) => string | null;
+    /**
+     *
+     * @param colName columnName
+     * @returns is CaseSensitive for column
+     */
+    private getIsNeedCaseSensitive;
+    /**
+     * Convert ag-grid column filter to odata query
+     * @param colName columnName
+     * @param col ag-grid column
+     */
+    private getFilterOdata;
+    /**
+     * Extract value from record by path to field
+     * @param field path to column value
+     * @param obj  record
+     */
+    private getValue;
+    /**
+     * Caclulate pivot data for ag-grid from odata
+     * @param pivotCols pivot columns
+     * @param rowGroupCols row group columns
+     * @param valueCols value columns
+     * @param data odata result
+     * @param countField count field name
+     */
+    private getPivot;
+    /**
+     *
+     * @param rowData array odata result
+     * @param rowGroupCols row group columns
+     * @param groupKeys what groups the user is viewing
+     * @param countField count field name
+     */
+    private buildGroupsFromData;
+    /**
+     * Internal function for execute callback function for each property of object
+     * @param object object contained odata grouped result
+     * @param callback function do somthing
+     */
+    private iterateObject;
+    /**
+     * Prepeare grouped data
+     * @param rowData array odata result
+     * @param field grouping field
+     */
+    private groupBy;
+    /**
+     * Calculate total count records in group
+     * @param rowData array odata result data
+     * @param countField field contained count of all records
+     */
+    private aggregateList;
+    /**
+       * Calculate distinct values for input field from Odata api
+       * @param field The field of the row to get the cells data from
+       * @param callback The function for return distinct values for input field
+       * @param beforeRequest The function for customize request
+       * @example
+       * <pre><code>
+       *  const setFilterValuesFuncParams = params => {
+       *    const me = this
+       *    const col = params.colDef.field
+       *    const storeName = me.getStoreName(col)
+       *    const callback = data => {
+       *      if (data) {
+       *        me.setState({ [storeName]: data })
+       *        params.success(data)
+       *      }
+       *    }
+       *    odataProviderInstance.getFilterValuesParams(params.colDef.field, callback)
+       *  }
+       *
+       * ///....
+       *      <AgGridColumn
+                    field="product"
+                    headerName={'PRODUCT'}
+                    filter="agSetColumnFilter"
+                    // rowGroup
+                    // enablePivot
+                    enableRowGroup
+                    filterParams={{
+                      values: setFilterValuesFuncParams,
+                      newRowsAction: 'keep'
+                    }}
+                    // filterParams={{caseSensitive: true}}
+                  />
+       * </code></pre>
+       */
+    getFilterValuesParams: (field: string, callback: (data: any[]) => void, beforeRequest: (options: OdataQueryExtendFull) => void | undefined) => void;
+    /**
+     * Detect is string value
+     * @param value
+     */
+    isStrVal: (value: any) => boolean;
+    /**
+     * Extartc values from odata response
+     * @param response
+     */
+    private getOdataResult;
+    /**
+     * Endocing column name to odata notation
+     * @param colName column name
+     */
+    private getWrapColumnName;
+    /**
+     * grid calls this to get rows for IServerSideDatasource
+     * @param params ag-grid details for the request
+     */
+    /**
+     * grid calls this to get rows implement
+     * @param params ag-grid details for the request
+     */
+    getRows(params: IGetRowsParams | IServerSideGetRowsParams): void;
+    /**
+     * Set result
+     * @param params ag-grid details for the request
+     * @param isServerMode detect type of params
+     * @param rowsThisBlock data of the request
+     * @param rowCount count of total result
+     */
+    private setResult;
+    /**
+     * Generate odata options for build query from ag-grid request
+     * @param params ag-grid details for the request
+     */
+    getOdataOptions: (params: IGetRowsParams | IServerSideGetRowsParams) => OdataQueryExtendFull;
+    /**
+     * Generate odata query from ag-grid request
+     * @param params ag-grid details for the request
+     */
+    getOdataQuery: (params: IGetRowsParams | IServerSideGetRowsParams) => string;
+}
+export declare class OdataProviderClient extends OdataProvider {
+    getRows(params: IServerSideGetRowsParams): void;
+}
+export declare class OdataServerSideProvider extends OdataProvider {
+    getRows(params: IServerSideGetRowsParams): void;
+}
+export {};

package/lib/helpers/types.d.ts

@@ -0,0 +1,20 @@
+import { ColumnVO } from 'ag-grid-community';
+export interface OdataQueryOptions {
+    sort?: Array<string>;
+    filter?: Array<string>;
+    expand?: Array<string>;
+    select?: Array<string>;
+}
+export interface OdataQueryExtendOptions extends OdataQueryOptions {
+    skip?: number;
+    top?: number;
+}
+export interface OdataQueryExtendFull extends OdataQueryExtendOptions {
+    count?: boolean;
+    apply?: Array<string>;
+}
+export declare class PivotResultDat {
+    data: any[];
+    aggCols: any[];
+    secondaryColDefs: ColumnVO[];
+}

package/lib/helpers/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function escapeRegExp(string: any): any;
+export declare function replaceAll(str: string, search: string, replacement: string): string;

package/lib/renderer/button-renderer/button-renderer.component.d.ts

@@ -0,0 +1,12 @@
+import { ICellRendererAngularComp } from 'ag-grid-angular';
+import * as i0 from "@angular/core";
+export declare class ButtonRendererComponent implements ICellRendererAngularComp {
+    params: any;
+    label: any;
+    icon: any;
+    agInit(params: any): void;
+    refresh(params?: any): boolean;
+    onClick($event: any): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ButtonRendererComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ButtonRendererComponent, "lib-button-renderer", never, {}, {}, never, never, false, never>;
+}

package/lib/renderer/tooltip-renderer/custom-tooltip-renderer.d.ts

@@ -0,0 +1,16 @@
+import { DatePipe } from '@angular/common';
+import { ITooltipAngularComp } from 'ag-grid-angular';
+import { ITooltipParams } from 'ag-grid-community';
+import * as i0 from "@angular/core";
+export declare class CustomTooltip implements ITooltipAngularComp {
+    private datePipe;
+    constructor(datePipe: DatePipe);
+    params: {
+        color: string;
+    } & ITooltipParams;
+    agInit(params: {
+        color: string;
+    } & ITooltipParams): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CustomTooltip, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<CustomTooltip, "tooltip-component", never, {}, {}, never, never, false, never>;
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "basesite-shared-grid-lib",
+  "version": "0.0.1",
+  "peerDependencies": {
+    "@angular/common": "^15.1.0",
+    "@angular/core": "^15.1.0",
+    "ag-grid-angular": "^29.0.0",
+    "ag-grid-community": "^29.0.0",
+    "ag-grid-enterprise": "^29.0.0"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "bundledDependencies": [
+    "ag-grid-angular",
+    "ag-grid-community",
+    "ag-grid-enterprise"
+  ],
+  "sideEffects": false,
+  "module": "fesm2015/basesite-shared-grid-lib.mjs",
+  "es2020": "fesm2020/basesite-shared-grid-lib.mjs",
+  "esm2020": "esm2020/basesite-shared-grid-lib.mjs",
+  "fesm2020": "fesm2020/basesite-shared-grid-lib.mjs",
+  "fesm2015": "fesm2015/basesite-shared-grid-lib.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "esm2020": "./esm2020/basesite-shared-grid-lib.mjs",
+      "es2020": "./fesm2020/basesite-shared-grid-lib.mjs",
+      "es2015": "./fesm2015/basesite-shared-grid-lib.mjs",
+      "node": "./fesm2015/basesite-shared-grid-lib.mjs",
+      "default": "./fesm2020/basesite-shared-grid-lib.mjs"
+    }
+  }
+}

package/public-api.d.ts

@@ -0,0 +1,3 @@
+export * from './lib/grid-library.service';
+export * from './lib/grid-library.component';
+export * from './lib/grid-library.module';

package/src/lib/styles/styles.scss

@@ -0,0 +1,84 @@
+@import 'ag-grid-community/styles/ag-grid.css';
+@import 'ag-grid-community/styles/ag-theme-balham.css';
+
+
+button {
+    font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;
+}
+
+.btn-actions {
+  background: #E1E6EF;
+  border: 1px solid rgba(0, 0, 0, .08);
+  color: #324168;
+  position: absolute;
+  border-radius: 3.81078px;
+  margin-top: 1px;
+  padding: 3px;
+}
+.custom-tooltip {
+    width: auto;
+    height: auto;
+    border: 1px solid cornflowerblue;
+    overflow: hidden;
+    background-color: #fff !important;
+  }
+  
+  .custom-tooltip p {
+    margin: 5px;
+    white-space: nowrap;
+  }
+  
+  .custom-tooltip p:first-of-type {
+    font-weight: bold;
+  }
+
+ .btn-actions::before {
+  background-color: #fff !important;
+  border: 1px solid cornflowerblue;
+    content: attr(data-title);
+    display: none;
+    font-weight: bold;
+    position: absolute;
+    top: 0px;
+    left: 25px;
+    z-index: 1;
+ }
+ .btn-actions:hover::before {
+    display: block;
+    position: absolute;
+    padding: 3px 7px;
+ }
+ .action-button{
+  overflow: unset !important;
+}
+.ag-paging-panel,.ag-icon::before{
+  color: #7141B1 !important;
+  font-weight: 700 !important;
+}
+.ag-ltr .ag-cell,.ag-header-cell-comp-wrapper {
+  color: #324168;
+  font-weight: 500;
+}
+.ag-header-cell, .ag-header-group-cell{
+  background-color: #fff;
+}
+.ag-row{
+  border-bottom: 0;
+}
+.ag-row-odd{
+  background-color: #fafafa;
+}
+.ag-pinned-right-cols-container > div > div .btn-actions:hover::before{
+  left: auto;
+  right: 20px !important;
+}
+.ag-pinned-left-cols-container > div > div:last-child .btn-actions:hover::before{
+  left: auto;
+  right: 15px !important;
+}
+.ag-header-cell::after, .ag-header-group-cell::after{
+  background-color: #ffffff !important;
+}
+.ag-root-wrapper,.ag-header{
+  border:none !important;
+}