@genesislcap/grid-pro 14.83.8-alpha-c2a75d5.0 → 14.84.1

package/dist/esm/grid-pro.definitions.next.js

@@ -0,0 +1,172 @@
+import { FieldTypeEnum } from '@genesislcap/foundation-comms';
+import { formatDateTimestamp, formatDateTimeTimestamp } from '@genesislcap/foundation-utils';
+/**
+ * Returns a filter type based on the Grid Pro field/column type.
+ * @param type - The type of the field/column
+ * @returns The ag-grid filter type
+ * @remarks Currently only returns agTextColumnFilter
+ * @alpha
+ */
+export function getFilterByFieldType(type) {
+    switch (type === null || type === void 0 ? void 0 : type.toLowerCase()) {
+        case 'int':
+        case 'long':
+        case 'double':
+        case 'bigdecimal':
+        case 'number':
+            return 'agNumberColumnFilter';
+        case 'date':
+        case 'datetime':
+            return 'agDateColumnFilter';
+        default:
+            return 'agTextColumnFilter';
+    }
+}
+/**
+ * Return a column type base on each field's metadata from the selected resource.
+ * @param metadataType - The type of the field/column
+ * @returns the column type
+ * @remarks Currently only handles numeric columns
+ * @alpha
+ */
+export function getColumnType(metadataType) {
+    switch (metadataType === null || metadataType === void 0 ? void 0 : metadataType.toLowerCase()) {
+        case 'int':
+        case 'long':
+        case 'double':
+        case 'bigdecimal':
+        case 'number':
+            return 'numericColumn';
+        case 'date':
+        case 'datetime':
+            return 'dateColumn';
+        default:
+            return 'textColumn';
+    }
+}
+/**
+ * Returns the filter params based on the Grid Pro field/column type.
+ * @param type - The type of the field/column
+ * @returns the filter params for the specified field type
+ * @remarks Currently only returns a default filter params object, for all field types
+ * @alpha
+ */
+export function getFilterParamsByFieldType(type) {
+    switch (type) {
+        case FieldTypeEnum.BOOLEAN: {
+            return {
+                buttons: ['reset', 'apply'],
+                closeOnApply: true,
+                closeOnClear: true,
+                suppressAndOrCondition: true,
+                filterOptions: [
+                    'contains',
+                    {
+                        displayKey: 'true',
+                        displayName: 'True',
+                        predicate: (_, cellValue) => cellValue === 'true' || cellValue === true,
+                        numberOfInputs: 0,
+                    },
+                    {
+                        displayKey: 'false',
+                        displayName: 'False',
+                        predicate: (_, cellValue) => cellValue === 'false' || cellValue === false,
+                        numberOfInputs: 0,
+                    },
+                    {
+                        displayKey: 'true-false',
+                        displayName: 'True/False',
+                        predicate: (_, cellValue) => cellValue === 'true' ||
+                            cellValue === true ||
+                            cellValue === 'false' ||
+                            cellValue === false,
+                        numberOfInputs: 0,
+                    },
+                ],
+            };
+        }
+        case FieldTypeEnum.DATE:
+        case FieldTypeEnum.DATETIME: {
+            return {
+                comparator: (filterLocalDateAtMidnight, cellValue) => {
+                    if (!cellValue)
+                        return -1;
+                    const cellValueTime = new Date(cellValue).setHours(0, 0, 0, 0);
+                    const filterValueTime = filterLocalDateAtMidnight.getTime();
+                    if (cellValueTime === filterValueTime) {
+                        return 0;
+                    }
+                    if (cellValueTime < filterValueTime) {
+                        return -1;
+                    }
+                    if (cellValueTime > filterValueTime) {
+                        return 1;
+                    }
+                },
+                buttons: ['reset', 'apply'],
+                closeOnApply: true,
+                closeOnClear: true,
+                suppressAndOrCondition: true,
+                browserDatePicker: true,
+                filterOptions: ['equals', 'lessThan', 'greaterThan'],
+            };
+        }
+        case FieldTypeEnum.NUMBER: {
+            return {
+                buttons: ['reset', 'apply'],
+                closeOnApply: true,
+                closeOnClear: true,
+                suppressAndOrCondition: true,
+                filterOptions: ['equals', 'lessThan', 'greaterThan'],
+            };
+        }
+        default: {
+            return {
+                buttons: ['reset', 'apply'],
+                closeOnApply: true,
+                closeOnClear: true,
+                suppressAndOrCondition: true,
+                filterOptions: ['contains', 'equals'],
+            };
+        }
+    }
+}
+/**
+ * Returns a formatted date value from the Grid Pro cell value.
+ * @param param - A ValueFormatterParams object.
+ * @returns A formatted date value.
+ * @public
+ */
+export function dateValueFormatter({ value }) {
+    return formatDateTimestamp(value);
+}
+/**
+ * Returns a formatted date time value from the Grid Pro cell value.
+ * @param param - A ValueFormatterParams object.
+ * @returns A formatted date time value.
+ * @public
+ */
+export function dateTimeValueFormatter({ value }) {
+    return formatDateTimeTimestamp(value);
+}
+// TODO: possible duplicate - need to evaluate the differences
+const isoDateTimeSliceEnd = 19;
+/**
+ * Returns a formatted date value from an epoch number.
+ * @param epoch - A number representing the number of milliseconds since the Unix epoch (1 January 1970 00:00:00 UTC).
+ * @returns A formatted date value.
+ * @alpha
+ * @deprecated No longer used in the Grid Pro package.
+ */
+export function formatDateExtra(epoch) {
+    return new Date(epoch)
+        .toISOString()
+        .slice(0, isoDateTimeSliceEnd)
+        .replace(/-/g, '')
+        .replace('T', '-');
+}
+/**
+ * The time between allowing the grids to automatically resize.
+ * @internal
+ */
+export const DEBOUNCED_RESIZE_TIME = 5;

package/dist/esm/grid-pro.js

@@ -9,18 +9,19 @@ import { FoundationElement } from '@microsoft/fast-foundation';
 import { classNames } from '@microsoft/fast-web-utilities';
 import { GridProCell } from './cell';
 import { ActionRenderer, ActionsMenuRenderer, BooleanRenderer } from './cell-renderers';
-import { GridColumn } from './column';
+import { GridProColumn } from './column';
 import { agThemeFontFaceMap, defaultAgGridFontFace } from './external';
-import { GridProGenesisDatasource, GridProGenesisDatasourceNext, } from './grid-pro-genesis-datasource';
+import { GridProClientSideDatasource, GridProGenesisDatasource, GridProServerSideDatasource, } from './grid-pro-genesis-datasource';
 import { DEBOUNCED_RESIZE_TIME } from './grid-pro.definitions';
 import { foundationGridProStyles as styles } from './grid-pro.styles';
 import { gridProTemplate as template } from './grid-pro.template';
 import { AgGridTheme, GridProRendererTypes, agThemeFontsId, agThemeTokenMapClassname, } from './grid-pro.types';
 import { logger, mergeAndDedupColDefWithColumnState } from './utils';
 GridProGenesisDatasource;
-GridProGenesisDatasourceNext;
+GridProClientSideDatasource;
+GridProServerSideDatasource;
 GridProCell;
-GridColumn;
+GridProColumn;
 ModuleRegistry.registerModules([CsvExportModule, ClientSideRowModelModule]);
 /**
  * Convert string values from 'camelCase' to 'kebab-case'

package/dist/grid-pro.api.json

@@ -3024,8 +3024,8 @@
             },
             {
               "kind": "Reference",
-              "text": "GridColumn",
-              "canonicalReference": "@genesislcap/grid-pro!GridColumn:class"
+              "text": "GridProColumn",
+              "canonicalReference": "@genesislcap/grid-pro!GridProColumn:class"
             },
             {
               "kind": "Content",
@@ -4593,135 +4593,6 @@
             "endIndex": 6
           }
         },
-        {
-          "kind": "Class",
-          "canonicalReference": "@genesislcap/grid-pro!GridColumn:class",
-          "docComment": "/**\n * The Grid Pro Column element.\n *\n * @remarks\n *\n * Used insde the Grid Pro element, to specify the column definitions (ColDef) for a given column.\n *\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare class GridColumn extends "
-            },
-            {
-              "kind": "Reference",
-              "text": "FoundationElement",
-              "canonicalReference": "@microsoft/fast-foundation!FoundationElement:class"
-            },
-            {
-              "kind": "Content",
-              "text": " "
-            }
-          ],
-          "fileUrlPath": "src/column/column.ts",
-          "releaseTag": "Public",
-          "isAbstract": false,
-          "name": "GridColumn",
-          "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "Property",
-              "canonicalReference": "@genesislcap/grid-pro!GridColumn#definition:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "definition: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "ColDef",
-                  "canonicalReference": "@ag-grid-community/core!ColDef:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "definition",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
-            },
-            {
-              "kind": "Property",
-              "canonicalReference": "@genesislcap/grid-pro!GridColumn#slottedAgCell:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "slottedAgCell: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "HTMLElement",
-                  "canonicalReference": "!HTMLElement:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "[]"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "slottedAgCell",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 3
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
-            },
-            {
-              "kind": "Method",
-              "canonicalReference": "@genesislcap/grid-pro!GridColumn#slottedAgCellChanged:member(1)",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "slottedAgCellChanged(): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [],
-              "isOptional": false,
-              "isAbstract": false,
-              "name": "slottedAgCellChanged"
-            }
-          ],
-          "extendsTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          },
-          "implementsTokenRanges": []
-        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/grid-pro!GridComponents:type",
@@ -6548,6 +6419,166 @@
             }
           ]
         },
+        {
+          "kind": "Class",
+          "canonicalReference": "@genesislcap/grid-pro!GridProClientSideDatasource:class",
+          "docComment": "/**\n * The Genesis Datasource element, for client-side | CSRM-compatible data fetching and used exclusively by the GridPro element.\n *\n * @remarks\n *\n * Only supports Client-Side Row Model.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class GridProClientSideDatasource extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "GridProGenesisDatasource",
+              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource:class"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts",
+          "releaseTag": "Public",
+          "isAbstract": false,
+          "name": "GridProClientSideDatasource",
+          "preserveMemberOrder": false,
+          "members": [],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
+        },
+        {
+          "kind": "Class",
+          "canonicalReference": "@genesislcap/grid-pro!GridProColumn:class",
+          "docComment": "/**\n * The Grid Pro Column element.\n *\n * @remarks\n *\n * Used insde the Grid Pro element, to specify the column definitions (ColDef) for a given column.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class GridProColumn extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "FoundationElement",
+              "canonicalReference": "@microsoft/fast-foundation!FoundationElement:class"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/column/column.ts",
+          "releaseTag": "Public",
+          "isAbstract": false,
+          "name": "GridProColumn",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridProColumn#definition:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "definition: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ColDef",
+                  "canonicalReference": "@ag-grid-community/core!ColDef:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "definition",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridProColumn#slottedAgCell:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "slottedAgCell: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HTMLElement",
+                  "canonicalReference": "!HTMLElement:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "slottedAgCell",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/grid-pro!GridProColumn#slottedAgCellChanged:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "slottedAgCellChanged(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "slottedAgCellChanged"
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
+        },
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/grid-pro!gridProColumns:function(1)",

package/dist/grid-pro.d.ts

@@ -23,8 +23,8 @@ import { GridOptions } from '@ag-grid-community/core';
 import { ICellRendererComp } from '@ag-grid-community/core';
 import { ICellRendererFunc } from '@ag-grid-community/core';
 import { ICellRendererParams } from '@ag-grid-community/core';
-import { IServerSideDatasource } from '@ag-grid-community/core';
-import { IServerSideGetRowsParams } from '@ag-grid-community/core';
+import type { IServerSideDatasource } from '@ag-grid-community/core';
+import type { IServerSideGetRowsParams } from '@ag-grid-community/core';
 import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
 import { Logger } from '@genesislcap/foundation-logger';
 import { MetadataDetail } from '@genesislcap/foundation-comms';
@@ -383,7 +383,7 @@ export declare const CellTemplate: ViewTemplate<GridProCell, any>;
  * The Grid Pro Column Template.
  * @public
  */
-export declare const ColumnTemplate: ViewTemplate<GridColumn, any>;
+export declare const ColumnTemplate: ViewTemplate<GridProColumn, any>;
 
 /**
  * Convert string values from 'camelCase' to 'kebab-case'
@@ -754,17 +754,6 @@ export declare const getTextFieldRendererTemplate: (designSystem?: string) => Vi
  */
 export declare const getTextRendererTemplate: (designSystem?: string) => ViewTemplate<AgTextFieldRenderer, any>;
 
-/**
- * The Grid Pro Column element.
- * @remarks Used insde the Grid Pro element, to specify the column definitions (ColDef) for a given column.
- * @public
- */
-export declare class GridColumn extends FoundationElement {
-    slottedAgCell: HTMLElement[];
-    definition: ColDef;
-    slottedAgCellChanged(): void;
-}
-
 /**
  * Grid Pro Components type, used to define the custom components that will be registered in the grid
  * @public
@@ -902,10 +891,7 @@ declare const GridPro_base: (new (...args: any[]) => {
     "__#1@#_cleanupTimeout": NodeJS.Timeout;
     "__#1@#_shouldForceLifecycle": boolean;
     cloneNode(deep?: boolean): Node;
-    deepClone(): Node; /**
-    * Whether to use the `applyTransactionAsync` function for *remove* transactions
-    * @remarks Defaults to false
-    */
+    deepClone(): Node;
     readonly shouldRunDisconnect: boolean;
     readonly shouldRunConnect: boolean;
     "__#1@#_blockLifecycleDueToTokenChange"(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean;
@@ -1241,6 +1227,25 @@ export declare class GridProCell extends FoundationElement implements ICellRende
     slottedAgRendererChanged(): void;
 }
 
+/**
+ * The Genesis Datasource element, for client-side | CSRM-compatible data fetching and used exclusively by the GridPro element.
+ * @remarks Only supports Client-Side Row Model.
+ * @public
+ */
+export declare class GridProClientSideDatasource extends GridProGenesisDatasource {
+}
+
+/**
+ * The Grid Pro Column element.
+ * @remarks Used insde the Grid Pro element, to specify the column definitions (ColDef) for a given column.
+ * @public
+ */
+export declare class GridProColumn extends FoundationElement {
+    slottedAgCell: HTMLElement[];
+    definition: ColDef;
+    slottedAgCellChanged(): void;
+}
+
 /**
  * A directive that renders a set of grid-pro-column elements from a given input binding
  *
@@ -1719,11 +1724,23 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
 }) & typeof FoundationElement;
 
 /**
- * The Genesis Datasource (Next) element, for SSRM-compatible data fetching and used exclusively by the GridPro element.
- * @remarks Intended to be the "next version" of the `grid-pro-genesis-datasource` element, supporting SSRM.
+ * The available Grid Pro Renderer Types
+ * @public
+ */
+export declare enum GridProRendererTypes {
+    action = "action",
+    actionsMenu = "actionsMenu",
+    boolean = "boolean",
+    text = "text",
+    select = "select"
+}
+
+/**
+ * A Genesis Datasource element, for server-side | SSRM-compatible data fetching and used exclusively by the GridPro element.
+ * @remarks Only supports Server-Side Row Model. Requires `@ag-grid-enterprise/server-side-row-model` setup and valid AG Grid Enterprise license.
  * @alpha
  */
-export declare class GridProGenesisDatasourceNext extends GridProGenesisDatasourceNext_base {
+export declare class GridProServerSideDatasource extends GridProServerSideDatasource_base {
     connect: Connect;
     criteria: string;
     criteriaChanged(oldCriteria: string, newCriteria: string): void;
@@ -1754,7 +1771,7 @@ export declare class GridProGenesisDatasourceNext extends GridProGenesisDatasour
     private getAgColumnDefs;
 }
 
-declare const GridProGenesisDatasourceNext_base: (new (...args: any[]) => {
+declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
     "__#1@#_container": FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
     "__#1@#_latestTokenCode": string;
     "__#1@#_hasFirstLoaded": boolean;
@@ -2080,18 +2097,6 @@ declare const GridProGenesisDatasourceNext_base: (new (...args: any[]) => {
     focus(options?: FocusOptions): void;
 }) & typeof FoundationElement;
 
-/**
- * The available Grid Pro Renderer Types
- * @public
- */
-export declare enum GridProRendererTypes {
-    action = "action",
-    actionsMenu = "actionsMenu",
-    boolean = "boolean",
-    text = "text",
-    select = "select"
-}
-
 /**
  * The Grid Pro Template.
  * @public
@@ -2154,6 +2159,7 @@ export declare class SelectRenderer extends FoundationElement implements ICellRe
  * @alpha
  */
 export declare class StreamDatasource implements IServerSideDatasource {
+    auth: Auth;
     connect: Connect;
     dataserverStream: SocketObservable<FilteredDataServerResult>;
     private resourceName;
@@ -2164,7 +2170,16 @@ export declare class StreamDatasource implements IServerSideDatasource {
     private maxView;
     private pagination;
     streamSourceRef: string;
-    private rowCount;
+    /**
+     * The number of rows in the grid. THIS DO NOT CONSIDER CRITERIA_MATCH scenarios.
+     * @internal
+     */
+    private server_ROWS_COUNT;
+    /**
+     * The number of rows in the grid. THIS IS A LOCAL COUNT CONSIDERING CONSIDER CRITERIA_MATCH scenarios.
+     * @internal
+     */
+    private client_ROWS_COUNT;
     private moreRows;
     private calculatedRowsCount;
     private lastSequenceId;
@@ -2176,6 +2191,7 @@ export declare class StreamDatasource implements IServerSideDatasource {
     private rowId;
     constructor(options: StreamDatasourceOptions);
     getRows(params: IServerSideGetRowsParams): Promise<void>;
+    private dataLogoff;
     private restartSubscription;
     private getOrderByAndToBeSortedColIds;
     private handleInitialStreamLoad;

package/docs/api/grid-pro.columntemplate.md

@@ -9,5 +9,5 @@ The Grid Pro Column Template.
 **Signature:**
 
 ```typescript
-ColumnTemplate: import("@microsoft/fast-element").ViewTemplate<GridColumn, any>
+ColumnTemplate: import("@microsoft/fast-element").ViewTemplate<GridProColumn, any>
 ```