@genesislcap/grid-pro 14.200.1-alpha-eb310c6.0 → 14.201.0

package/dist/esm/datasource/server-side.grid-definitions.js

@@ -13,7 +13,7 @@ export function getServerSideFilterParamsByFieldType(type) {
                 buttons: ['reset', 'apply'],
                 closeOnApply: true,
                 closeOnClear: true,
-                maxNumConditions: 1,
+                suppressAndOrCondition: true,
                 filterOptions: [
                     'contains',
                     {
@@ -61,22 +61,9 @@ export function getServerSideFilterParamsByFieldType(type) {
                 buttons: ['reset', 'apply'],
                 closeOnApply: true,
                 closeOnClear: true,
-                maxNumConditions: 1,
+                suppressAndOrCondition: true,
                 browserDatePicker: true,
-                filterOptions: [
-                    'equals',
-                    'lessThan',
-                    'greaterThan',
-                    'inRange',
-                    {
-                        displayKey: 'isToday',
-                        displayName: 'Is today',
-                        numberOfInputs: 0,
-                        predicate: () => true,
-                    },
-                    'blank',
-                    'notBlank',
-                ],
+                filterOptions: ['equals', 'lessThan', 'greaterThan'],
             };
         }
         case FieldTypeEnum.NUMBER: {
@@ -84,18 +71,8 @@ export function getServerSideFilterParamsByFieldType(type) {
                 buttons: ['reset', 'apply'],
                 closeOnApply: true,
                 closeOnClear: true,
-                maxNumConditions: 1,
-                filterOptions: [
-                    'equals',
-                    'notEqual',
-                    'greaterThan',
-                    'greaterThanOrEqual',
-                    'lessThan',
-                    'lessThanOrEqual',
-                    'inRange',
-                    'blank',
-                    'notBlank',
-                ],
+                suppressAndOrCondition: true,
+                filterOptions: ['equals', 'lessThan', 'greaterThan'],
             };
         }
         default: {
@@ -103,20 +80,8 @@ export function getServerSideFilterParamsByFieldType(type) {
                 buttons: ['reset', 'apply'],
                 closeOnApply: true,
                 closeOnClear: true,
-                maxNumConditions: 1,
-                filterOptions: [
-                    'contains',
-                    'equals',
-                    'notEqual',
-                    {
-                        displayKey: 'wordStartsWith',
-                        displayName: 'Word starts with',
-                        numberOfInputs: 1,
-                        predicate: () => true,
-                    },
-                    'blank',
-                    'notBlank',
-                ],
+                suppressAndOrCondition: true,
+                filterOptions: ['contains', 'equals'],
             };
         }
     }

package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js

@@ -1,14 +1,15 @@
 import { __awaiter, __decorate } from "tslib";
-import { Events, } from '@ag-grid-community/core';
-import { MessageType, dataServerResultFilter, normaliseCriteria, } from '@genesislcap/foundation-comms';
+import { Auth, Datasource, DatasourceDefaults, MessageType, dataServerResultFilter, normaliseCriteria, } from '@genesislcap/foundation-comms';
 import { LifecycleMixin } from '@genesislcap/foundation-utils';
-import { DOM, attr, customElement } from '@microsoft/fast-element';
+import { DOM, attr, customElement, observable } from '@microsoft/fast-element';
 import { BehaviorSubject, EMPTY } from 'rxjs';
 import { catchError, debounceTime, skip, tap } from 'rxjs/operators';
-import { criteriaDelimiter, GridProBaseDatasource } from '../datasource/base.datasource';
+import { GridProBaseDatasource } from '../datasource/base.datasource';
 import { getClientSideFilterParamsByFieldType } from '../datasource/client-side.grid-definitions';
 import { logger } from '../utils/logger';
 import { gridProGenesisDatasourceEventNames } from './grid-pro-genesis-datasource.config';
+const criteriaDelimiter = ';';
+const criteriaJoin = ' && ';
 const withoutFullInit = null;
 const withoutColumnDefs = null;
 /**
@@ -21,9 +22,13 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
         super(...arguments);
         this.applyFuncName = 'applyTransaction';
         this.applyAsyncFuncName = 'applyTransactionAsync';
+        this.pollingInterval = DatasourceDefaults.REQ_REP_POLLING_INTERVAL_MS;
+        this.disablePolling = false;
         this.restartOnReconnection = false;
         this.keepColDefsOnClearRowData = false;
         this.requiresFullRowDataAndColDefs = true;
+        this.criteriaFromFilters = new Map();
+        this.update = new BehaviorSubject(new Map());
     }
     // DatasourceOptions
     criteriaChanged(oldCriteria, newCriteria) {
@@ -70,7 +75,7 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
         DOM.queueUpdate(() => {
             if (!shouldRunDisconnect)
                 return;
-            this.destroy();
+            this.deinit();
         });
     }
     deepClone() {
@@ -117,11 +122,11 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
      */
     init(columnDefinitions, columnStates) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this.agGrid) {
+            if (this.agGrid && this.datasource.validResourceName(this.resourceName)) {
                 const gridOptions = Object.assign(Object.assign(Object.assign({ getRowId: (params) => params.data[this.rowId] }, (columnDefinitions && { columnDefs: columnDefinitions })), this.agGrid['agGridOptions']), this.deferredGridOptions);
                 this.agGrid.gridOptions = Object.assign({}, gridOptions);
                 this.agGrid['initGrid']();
-                this.agGrid.addEventListener(Events.EVENT_GRID_READY, () => __awaiter(this, void 0, void 0, function* () {
+                this.agGrid.addEventListener('onGridReady', () => __awaiter(this, void 0, void 0, function* () {
                     if (columnStates) {
                         this.agGrid.columnApi.applyColumnState({ state: columnStates });
                     }
@@ -138,16 +143,8 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
             this.handleErrors('Application not connected or invalid resource name, datasource will not work. Falling back to local columnDefs/rowData.');
         });
     }
-    /**
-     * Destroys the datasource, resetting it to its initial state.
-     * @public
-     */
-    destroy() {
-        this.reset();
-    }
     /**
      * Deinitialises the datasource, resetting it to its initial state.
-     * @deprecated Use `destroy` instead
      * @public
      */
     deinit() {
@@ -156,7 +153,7 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
     /**
      * Resets the datasource to its initial state.
      * @public
-     * @deprecated Use `destroy` instead
+     * @deprecated Use `deinit` instead
      */
     reset() {
         var _a;
@@ -174,6 +171,7 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
             this.connectionSub = undefined;
         }
         this.clearRowData();
+        this.isRequestServer = false;
         this.requiresFullRowDataAndColDefs = true;
         this.dataSubWasLoggedOff = false;
         this.criteriaFromFilters = new Map();
@@ -181,7 +179,7 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
         this.update = new BehaviorSubject(new Map());
         this.agGrid.removeAttribute('ds-disconnected');
         // TODO: There may need to be a full destroy path. Datasources need some love!
-        this.datasource.destroy();
+        this.datasource.deinit();
     }
     /**
      * Restarts the datasource, uses `deinit` and `init` in sequence.
@@ -194,7 +192,7 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
             columnDefinitions = this.agGrid.gridApi.getColumnDefs();
             columnStates = this.agGrid.columnApi.getColumnState();
         }
-        this.destroy();
+        this.deinit();
         this.init(columnDefinitions, columnStates);
     }
     /**
@@ -246,7 +244,7 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
             }
             const data = this.rowDataMapper ? this.rowDataMapper(rowData) : rowData;
             this.agGrid.restoreCachedFilterConfig();
-            this.agTransaction = { add: data ? [...data] : [], remove: [], update: [], addIndex: 0 };
+            this.agTransaction = { add: [...data], remove: [], update: [], addIndex: 0 };
             this.applyAllAgTransactions();
             this.requiresFullRowDataAndColDefs = false;
         });
@@ -301,12 +299,12 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
                 this.dataSub = this.datasource.stream
                     .pipe(catchError((err) => {
                     var _a;
-                    this.handleErrors((_a = err === null || err === void 0 ? void 0 : err.receivedMessage) === null || _a === void 0 ? void 0 : _a.ERROR);
+                    this.handleErrors((_a = err === null || err === void 0 ? void 0 : err.receivedMessage) === null || _a === void 0 ? void 0 : _a.ERROR.join(', '));
                     return EMPTY;
                 }))
                     .subscribe((result) => {
                     if (result === null || result === void 0 ? void 0 : result.ERROR) {
-                        this.handleErrors(result.ERROR);
+                        this.handleErrors(result.ERROR.join(', '));
                     }
                     const messageType = result.MESSAGE_TYPE;
                     if (messageType && messageType === MessageType.LOGOFF_ACK) {
@@ -345,30 +343,31 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
         }
         return result.inserts;
     }
-    handleErrors(errors) {
-        let message;
-        if (Array.isArray(errors)) {
-            const stringArray = errors.map((item) => {
-                if (typeof item === 'string') {
-                    return item;
-                }
-                else if (typeof item === 'object' && item !== null && 'TEXT' in item) {
-                    return item.TEXT;
-                }
-                else {
-                    throw new Error('Array contains invalid elements');
-                }
-            });
-            message = stringArray.join(', ');
-        }
+    handleErrors(message) {
         if (this.agGrid) {
             this.agGrid.setAttribute('ds-disconnected', 'ds-disconnected');
         }
         if (message) {
-            logger.error(message);
+            logger.warn(message);
             this.$emit(gridProGenesisDatasourceEventNames.error, { message });
         }
     }
+    datasourceOptions() {
+        return {
+            criteria: this.buildCriteria(),
+            fields: this.fields,
+            isSnapshot: this.isSnapshot,
+            maxRows: this.maxRows,
+            maxView: this.maxView,
+            movingView: this.movingView,
+            orderBy: this.orderBy,
+            pollingInterval: this.pollingInterval,
+            disablePolling: this.disablePolling,
+            request: this.request,
+            resourceName: this.resourceName,
+            reverse: this.reverse,
+        };
+    }
     handleStreamResult(result) {
         if (!result)
             return;
@@ -389,23 +388,9 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
             return;
         }
         if (this.requiresFullRowDataAndColDefs) {
-            let noRowIdError = false;
-            for (const insertData of requestServerData || []) {
-                const insertDataRowId = insertData[this.rowId];
-                if (!insertDataRowId) {
-                    if (!noRowIdError) {
-                        const noRowIdMessage = `The specified rowId (${this.rowId}) is not present in the data. Since this is not a snapshot (isSnapshot=false), the data will not be loaded. Please provide a valid 'row-id' attribute.`;
-                        logger.error(noRowIdMessage);
-                        noRowIdError = true;
-                    }
-                    break;
-                }
-                this.rowData.set(insertDataRowId, insertData);
-            }
-            if (noRowIdError) {
-                this.destroy();
-                return;
-            }
+            requestServerData === null || requestServerData === void 0 ? void 0 : requestServerData.forEach((insertData) => {
+                this.rowData.set(insertData[this.rowId], insertData);
+            });
             const rowData = this.rowData.size > 0 ? Array.from(this.rowData.values()) : requestServerData;
             this.handleSizeChanged(previousSize, this.rowData.size);
             this.setRowData(rowData);
@@ -455,6 +440,12 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
             return colDefsMergedWithTemplateDefs;
         });
     }
+    buildCriteria() {
+        var _a;
+        const initialCriteria = ((_a = this.criteria) === null || _a === void 0 ? void 0 : _a.split(criteriaDelimiter)) || [];
+        const criteria = initialCriteria.concat(Array.from(this.criteriaFromFilters.values()));
+        return normaliseCriteria(criteria.join(criteriaJoin), criteriaDelimiter);
+    }
     setFilter(fieldName, newFilter) {
         this.criteriaFromFilters.set(fieldName, newFilter);
         this.update.next(this.criteriaFromFilters);
@@ -478,6 +469,21 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
         });
     }
 };
+__decorate([
+    Auth
+], GridProGenesisDatasource.prototype, "auth", void 0);
+__decorate([
+    Datasource
+], GridProGenesisDatasource.prototype, "datasource", void 0);
+__decorate([
+    attr({ attribute: 'polling-interval' })
+], GridProGenesisDatasource.prototype, "pollingInterval", void 0);
+__decorate([
+    attr({ mode: 'boolean', attribute: 'disable-polling' })
+], GridProGenesisDatasource.prototype, "disablePolling", void 0);
+__decorate([
+    observable
+], GridProGenesisDatasource.prototype, "request", void 0);
 __decorate([
     attr({ mode: 'boolean', attribute: 'restart-on-reconnection' })
 ], GridProGenesisDatasource.prototype, "restartOnReconnection", void 0);

package/dist/esm/grid-pro.js

@@ -138,10 +138,7 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
             action: this.handleError.bind(this, gridProErrorNames.datasource),
         });
     }
-    addEventListener(eventType, listener, options) {
-        const type = eventType.startsWith('on')
-            ? eventType
-            : `on${eventType.charAt(0).toUpperCase() + eventType.slice(1)}`;
+    addEventListener(type, listener, options) {
         super.addEventListener(type, listener, options);
         if (ComponentUtil.PUBLIC_EVENTS.includes(type)) {
             if (this.gridApi) {
@@ -152,9 +149,9 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
             }
         }
     }
-    addGridEventListener(eventType) {
-        this.gridApi.addEventListener(eventType, (e) => {
-            this.$emit(eventType, e);
+    addGridEventListener(type) {
+        this.gridApi.addEventListener(type, (e) => {
+            this.$emit(type, e);
         });
     }
     handleError(type, event) {

package/dist/grid-pro.api.json

@@ -7627,11 +7627,11 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "addEventListener(eventType: "
+                  "text": "addEventListener(type: "
                 },
                 {
                   "kind": "Content",
-                  "text": "string"
+                  "text": "any"
                 },
                 {
                   "kind": "Content",
@@ -7677,7 +7677,7 @@
               "overloadIndex": 1,
               "parameters": [
                 {
-                  "parameterName": "eventType",
+                  "parameterName": "type",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
                     "endIndex": 2
@@ -11036,6 +11036,37 @@
               "isAbstract": false,
               "name": "applyTransactionAsync"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#auth:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "auth: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Auth",
+                  "canonicalReference": "@genesislcap/foundation-comms!Auth:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "auth",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#connectedCallback:member(1)",
@@ -11131,6 +11162,37 @@
               "isAbstract": false,
               "name": "criteriaChanged"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#datasource:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "datasource: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Datasource",
+                  "canonicalReference": "@genesislcap/foundation-comms!Datasource:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "datasource",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#deepClone:member(1)",
@@ -11166,7 +11228,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#deinit:member(1)",
-              "docComment": "/**\n * Deinitialises the datasource, resetting it to its initial state.\n *\n * @deprecated\n *\n * Use `destroy` instead\n *\n * @public\n */\n",
+              "docComment": "/**\n * Deinitialises the datasource, resetting it to its initial state.\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -11195,35 +11257,34 @@
               "name": "deinit"
             },
             {
-              "kind": "Method",
-              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#destroy:member(1)",
-              "docComment": "/**\n * Destroys the datasource, resetting it to its initial state.\n *\n * @public\n */\n",
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#disablePolling:member",
+              "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "destroy(): "
+                  "text": "disablePolling: "
                 },
                 {
                   "kind": "Content",
-                  "text": "void"
+                  "text": "boolean"
                 },
                 {
                   "kind": "Content",
                   "text": ";"
                 }
               ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "disablePolling",
+              "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
               },
-              "releaseTag": "Public",
+              "isStatic": false,
               "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [],
-              "isOptional": false,
-              "isAbstract": false,
-              "name": "destroy"
+              "isAbstract": false
             },
             {
               "kind": "Method",
@@ -11263,11 +11324,11 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "handleErrors(errors: "
+                  "text": "handleErrors(message: "
                 },
                 {
                   "kind": "Content",
-                  "text": "string | any[]"
+                  "text": "string"
                 },
                 {
                   "kind": "Content",
@@ -11292,7 +11353,7 @@
               "overloadIndex": 1,
               "parameters": [
                 {
-                  "parameterName": "errors",
+                  "parameterName": "message",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
                     "endIndex": 2
@@ -11413,6 +11474,36 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#pollingInterval:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "pollingInterval: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "pollingInterval",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#refreshRows:member(1)",
@@ -11492,6 +11583,36 @@
               "isAbstract": false,
               "name": "removeFilter"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#request:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "request: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "request",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#requestChanged:member(1)",
@@ -11559,7 +11680,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#reset:member(1)",
-              "docComment": "/**\n * Resets the datasource to its initial state.\n *\n * @deprecated\n *\n * Use `destroy` instead\n *\n * @public\n */\n",
+              "docComment": "/**\n * Resets the datasource to its initial state.\n *\n * @deprecated\n *\n * Use `deinit` instead\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",