@genesislcap/grid-pro 14.199.1 → 14.199.2-alpha-6f7195d.0

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

@@ -1,15 +1,14 @@
 import { __awaiter, __decorate } from "tslib";
-import { Auth, Datasource, DatasourceDefaults, MessageType, dataServerResultFilter, normaliseCriteria, } from '@genesislcap/foundation-comms';
+import { Events, } from '@ag-grid-community/core';
+import { MessageType, dataServerResultFilter, normaliseCriteria, } from '@genesislcap/foundation-comms';
 import { LifecycleMixin } from '@genesislcap/foundation-utils';
-import { DOM, attr, customElement, observable } from '@microsoft/fast-element';
+import { DOM, attr, customElement } from '@microsoft/fast-element';
 import { BehaviorSubject, EMPTY } from 'rxjs';
 import { catchError, debounceTime, skip, tap } from 'rxjs/operators';
-import { GridProBaseDatasource } from '../datasource/base.datasource';
+import { criteriaDelimiter, 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;
 /**
@@ -22,13 +21,9 @@ 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) {
@@ -75,7 +70,7 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
         DOM.queueUpdate(() => {
             if (!shouldRunDisconnect)
                 return;
-            this.deinit();
+            this.destroy();
         });
     }
     deepClone() {
@@ -122,11 +117,11 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
      */
     init(columnDefinitions, columnStates) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this.agGrid && this.datasource.validResourceName(this.resourceName)) {
+            if (this.agGrid) {
                 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('onGridReady', () => __awaiter(this, void 0, void 0, function* () {
+                this.agGrid.addEventListener(Events.EVENT_GRID_READY, () => __awaiter(this, void 0, void 0, function* () {
                     if (columnStates) {
                         this.agGrid.columnApi.applyColumnState({ state: columnStates });
                     }
@@ -143,8 +138,16 @@ 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() {
@@ -153,7 +156,7 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
     /**
      * Resets the datasource to its initial state.
      * @public
-     * @deprecated Use `deinit` instead
+     * @deprecated Use `destroy` instead
      */
     reset() {
         var _a;
@@ -171,7 +174,6 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
             this.connectionSub = undefined;
         }
         this.clearRowData();
-        this.isRequestServer = false;
         this.requiresFullRowDataAndColDefs = true;
         this.dataSubWasLoggedOff = false;
         this.criteriaFromFilters = new Map();
@@ -179,7 +181,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.deinit();
+        this.datasource.destroy();
     }
     /**
      * Restarts the datasource, uses `deinit` and `init` in sequence.
@@ -192,7 +194,7 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
             columnDefinitions = this.agGrid.gridApi.getColumnDefs();
             columnStates = this.agGrid.columnApi.getColumnState();
         }
-        this.deinit();
+        this.destroy();
         this.init(columnDefinitions, columnStates);
     }
     /**
@@ -299,12 +301,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.join(', '));
+                    this.handleErrors((_a = err === null || err === void 0 ? void 0 : err.receivedMessage) === null || _a === void 0 ? void 0 : _a.ERROR);
                     return EMPTY;
                 }))
                     .subscribe((result) => {
                     if (result === null || result === void 0 ? void 0 : result.ERROR) {
-                        this.handleErrors(result.ERROR.join(', '));
+                        this.handleErrors(result.ERROR);
                     }
                     const messageType = result.MESSAGE_TYPE;
                     if (messageType && messageType === MessageType.LOGOFF_ACK) {
@@ -343,31 +345,30 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
         }
         return result.inserts;
     }
-    handleErrors(message) {
+    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(', ');
+        }
         if (this.agGrid) {
             this.agGrid.setAttribute('ds-disconnected', 'ds-disconnected');
         }
         if (message) {
-            logger.warn(message);
+            logger.error(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;
@@ -388,9 +389,21 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
             return;
         }
         if (this.requiresFullRowDataAndColDefs) {
+            let noRowIdError = false;
             requestServerData === null || requestServerData === void 0 ? void 0 : requestServerData.forEach((insertData) => {
+                const insertDataRowId = insertData[this.rowId];
                 this.rowData.set(insertData[this.rowId], insertData);
+                this.rowData.set(insertDataRowId, insertData);
+                if (!insertDataRowId && !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;
+                }
             });
+            if (noRowIdError) {
+                this.destroy();
+                return;
+            }
             const rowData = this.rowData.size > 0 ? Array.from(this.rowData.values()) : requestServerData;
             this.handleSizeChanged(previousSize, this.rowData.size);
             this.setRowData(rowData);
@@ -440,12 +453,6 @@ 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);
@@ -469,21 +476,6 @@ 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,7 +138,10 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
             action: this.handleError.bind(this, gridProErrorNames.datasource),
         });
     }
-    addEventListener(type, listener, options) {
+    addEventListener(eventType, listener, options) {
+        const type = eventType.startsWith('on')
+            ? eventType
+            : `on${eventType.charAt(0).toUpperCase() + eventType.slice(1)}`;
         super.addEventListener(type, listener, options);
         if (ComponentUtil.PUBLIC_EVENTS.includes(type)) {
             if (this.gridApi) {
@@ -149,9 +152,9 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
             }
         }
     }
-    addGridEventListener(type) {
-        this.gridApi.addEventListener(type, (e) => {
-            this.$emit(type, e);
+    addGridEventListener(eventType) {
+        this.gridApi.addEventListener(eventType, (e) => {
+            this.$emit(eventType, e);
         });
     }
     handleError(type, event) {

package/dist/grid-pro.api.json

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