@genesislcap/grid-pro 14.168.0 → 14.170.0-genxgit.1

package/dist/esm/grid-pro.js

@@ -14,8 +14,8 @@ import { ActionRenderer, ActionsMenuRenderer, BooleanRenderer, EditableRenderer,
 import { GridProColumn } from './column';
 import { GridProClientSideDatasource, GridProServerSideDatasource } from './datasource';
 import { agThemeFontFaceMap, defaultAgGridFontFace } from './external';
-import { GridProGenesisDatasource } from './grid-pro-genesis-datasource';
-import { DEBOUNCED_RESIZE_TIME } from './grid-pro.definitions';
+import { GridProGenesisDatasource, gridProGenesisDatasourceEventNames, } from './grid-pro-genesis-datasource';
+import { DEBOUNCED_RESIZE_TIME, gridProEventNames, gridProErrorNames, } 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, GRID_READY_EVENT, ERROR_COLUMN_FIELD, EDITED_COLUMN_FIELD, GridOptionsConfig, } from './grid-pro.types';
@@ -65,6 +65,7 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
     }
     constructor() {
         super();
+        this.gridErrorItems = [];
         // Genesis-specific attrs
         this.autoCellRendererByType = false;
         this.onlyTemplateColDefs = false;
@@ -111,6 +112,7 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
         this.columnComponentName = 'grid-pro-column';
         this.theme = AgGridTheme.alpine;
         this.rehydrationAttempted = false;
+        this.rootEventsListeners = [];
         this.gridEventsQueue = [];
         this._filterConfig = undefined;
         this.agAttributes = {};
@@ -119,6 +121,11 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
             map[convertToKebabCase(property)] = property;
             return map;
         }, {});
+        const hideDataSourceError = this.hideDatasourceError.bind(this);
+        this.rootEventsListeners.push({ key: gridProGenesisDatasourceEventNames.rowDataSet, action: hideDataSourceError }, { key: gridProEventNames.datasourceErrorClose, action: hideDataSourceError }, {
+            key: gridProGenesisDatasourceEventNames.error,
+            action: this.handleError.bind(this, gridProErrorNames.datasource),
+        });
     }
     addEventListener(type, listener, options) {
         super.addEventListener(type, listener, options);
@@ -136,6 +143,12 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
             this.$emit(type, e);
         });
     }
+    handleError(type, event) {
+        this.gridErrorItems = [...this.gridErrorItems, { detail: event.detail, type }];
+    }
+    hideDatasourceError() {
+        this.gridErrorItems = this.gridErrorItems.filter((item) => item.type !== gridProErrorNames.datasource);
+    }
     connectedCallback() {
         super.connectedCallback();
         if (this.gridAutosizingEnabled) {
@@ -157,11 +170,17 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
                 configurable: true,
             });
         });
+        this.rootEventsListeners.forEach(({ key, action }) => {
+            this.addEventListener(key, action);
+        });
     }
     disconnectedCallback() {
         super.disconnectedCallback();
         this.rehydrationAttempted = false;
         const shouldRunDisconnect = this.shouldRunDisconnect;
+        this.rootEventsListeners.forEach(({ key, action }) => {
+            this.removeEventListener(key, action);
+        });
         DOM.queueUpdate(() => {
             var _a;
             if (!shouldRunDisconnect)
@@ -495,6 +514,9 @@ __decorate([
 __decorate([
     observable
 ], GridPro.prototype, "gridApi", void 0);
+__decorate([
+    observable
+], GridPro.prototype, "gridErrorItems", void 0);
 __decorate([
     StatePersistence
 ], GridPro.prototype, "statePersistence", void 0);

package/dist/esm/grid-pro.styles.js

@@ -8,19 +8,23 @@ import { agExternalStockStyles } from './external';
 export const foundationGridProStyles = css `
   ${agExternalStockStyles}
   :host {
+    --datasource-error-background-color: var(--neutral-layer-4);
+    --datasource-error-background-opacity: 0.5;
+    --datasource-error-dialog-max-width: 50%;
+    --datasource-error-dialog-min-width: auto;
+
+    position: relative;
     width: 100%;
     height: 100%;
   }
 
   :host([ds-disconnected]) {
-    opacity: 40%;
+    display: block;
   }
 
-  :host([ds-disconnected]) > * {
+  :host([ds-disconnected])::part(grid) {
     cursor: not-allowed;
-  }
-
-  :host([ds-disconnected]) > * > * {
+    opacity: 40%;
     pointer-events: none;
   }
 
@@ -33,4 +37,30 @@ export const foundationGridProStyles = css `
   .ag-cell-inline-editing {
     height: inherit !important;
   }
+
+  .hidden {
+    display: none;
+  }
+
+  .grid-datasource-error-dialog::part(dialog) {
+    position: absolute;
+    z-index: 2;
+    max-width: var(--datasource-error-dialog-max-width);
+
+    --dialog-min-width: var(--datasource-error-dialog-min-width);
+  }
+
+  .grid-datasource-error-dialog::before {
+    content: '';
+    position: absolute;
+    top: 50%;
+    transform: translateY(-50%);
+    left: 0;
+    height: 100%;
+    width: 100%;
+    border-radius: 2px;
+    background-color: var(--datasource-error-background-color);
+    opacity: var(--datasource-error-background-opacity);
+    z-index: 1;
+  }
 `;

package/dist/esm/grid-pro.template.js

@@ -1,13 +1,52 @@
 import { html, ref } from '@microsoft/fast-element';
+import { gridProErrorNames } from './grid-pro.definitions';
 /**
- * The Grid Pro Template.
+ * Get a Design System prefixed The Grid Pro template.
+ * @param prefix - The design system prefix to use. Defaults to 'foundation'.
+ * @returns A grid Pro template prefixed with the correct design system.
  * @public
  */
-export const gridProTemplate = html `
+export const getGridProTemplate = (prefix = 'foundation') => html `
   <template>
     <span part="grid" class="${(x) => x.classNames}">
       <slot name="grid" ${ref('gridSlot')}></slot>
       <slot></slot>
     </span>
+    <slot
+        name="grid-datasource-error"
+        part="grid-datasource-error"
+        class="${(x) => (x.gridErrorItems.filter(({ type }) => type === gridProErrorNames.datasource).length > 0 ? '' : 'hidden')}"
+      >
+        <${prefix}-dialog
+          class="grid-datasource-error-dialog"
+          type="error"
+          show-close-icon="false"
+          open
+        >
+          <h2 slot="top" class="title">Component unavailable</h2>
+          <p>
+            Please refresh to reconnect.
+            It is recommended that you save your data before refreshing.
+            Data is not current and may be incomplete.
+          </p>
+          <div slot="bottom">
+          <${prefix}-button
+            appearance="lightweight"
+            @click=${() => {
+    window.location.reload();
+}}
+          >
+            Refresh
+          </${prefix}-button>
+        </div>
+        </${prefix}-dialog>
+      </slot>
   </template>
 `;
+/**
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<foundation-grid-pro\>
+ */
+export const gridProTemplate = getGridProTemplate();

package/dist/grid-pro.api.json

@@ -7020,6 +7020,47 @@
             "endIndex": 6
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/grid-pro!getGridProTemplate:var",
+          "docComment": "/**\n * Get a Design System prefixed The Grid Pro template.\n *\n * @param prefix - The design system prefix to use. Defaults to 'foundation'.\n *\n * @returns A grid Pro template prefixed with the correct design system.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "getGridProTemplate: "
+            },
+            {
+              "kind": "Content",
+              "text": "(prefix?: string) => "
+            },
+            {
+              "kind": "Reference",
+              "text": "ViewTemplate",
+              "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "GridPro",
+              "canonicalReference": "@genesislcap/grid-pro!GridPro:class"
+            },
+            {
+              "kind": "Content",
+              "text": ", any>"
+            }
+          ],
+          "fileUrlPath": "src/grid-pro.template.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "getGridProTemplate",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/grid-pro!getMultiselectEditorTemplate:var",
@@ -8511,6 +8552,50 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridPro#gridErrorItems:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "gridErrorItems: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "GridProErrorItem",
+                  "canonicalReference": "@genesislcap/grid-pro!GridProErrorItem:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "GridProErrorEvent",
+                  "canonicalReference": "@genesislcap/grid-pro!GridProErrorEvent:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "['detail']>[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "gridErrorItems",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/grid-pro!GridPro#gridFontFace:member",
@@ -10145,6 +10230,218 @@
           ],
           "name": "gridProColumns"
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/grid-pro!GridProErrorEvent:type",
+          "docComment": "/**\n * Grid Pro possible error events\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type GridProErrorEvent = "
+            },
+            {
+              "kind": "Reference",
+              "text": "GridProGenesisDatasourceErrorEvent",
+              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasourceErrorEvent:type"
+            },
+            {
+              "kind": "Content",
+              "text": " | "
+            },
+            {
+              "kind": "Reference",
+              "text": "CustomEvent",
+              "canonicalReference": "!CustomEvent:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "GridProErrorItem",
+              "canonicalReference": "@genesislcap/grid-pro!GridProErrorItem:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<any>>"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/grid-pro.types.ts",
+          "releaseTag": "Public",
+          "name": "GridProErrorEvent",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 7
+          }
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@genesislcap/grid-pro!GridProErrorItem:interface",
+          "docComment": "/**\n * Grid Pro Error Item\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface GridProErrorItem<GridProErrorItemDetailType> "
+            }
+          ],
+          "fileUrlPath": "src/grid-pro.types.ts",
+          "releaseTag": "Public",
+          "typeParameters": [
+            {
+              "typeParameterName": "GridProErrorItemDetailType",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "GridProErrorItem",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/grid-pro!GridProErrorItem#detail:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "detail: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "GridProErrorItemDetailType"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "detail",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/grid-pro!GridProErrorItem#type:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "type: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "GridProErrorTypes",
+                  "canonicalReference": "@genesislcap/grid-pro!GridProErrorTypes:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "type",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/grid-pro!gridProErrorNames:var",
+          "docComment": "/**\n * The error names for the Grid Pro component.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "gridProErrorNames: "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    readonly datasource: \"datasource\";\n    readonly unknown: \"unknown\";\n}"
+            }
+          ],
+          "fileUrlPath": "src/grid-pro.definitions.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "gridProErrorNames",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/grid-pro!GridProErrorTypes:type",
+          "docComment": "/**\n * Grid Pro Error Types\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type GridProErrorTypes = "
+            },
+            {
+              "kind": "Content",
+              "text": "keyof typeof "
+            },
+            {
+              "kind": "Reference",
+              "text": "gridProErrorNames",
+              "canonicalReference": "@genesislcap/grid-pro!gridProErrorNames:var"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/grid-pro.types.ts",
+          "releaseTag": "Public",
+          "name": "GridProErrorTypes",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/grid-pro!gridProEventNames:var",
+          "docComment": "/**\n * The event names for the Grid Pro component.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "gridProEventNames: "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    datasourceErrorClose: string;\n}"
+            }
+          ],
+          "fileUrlPath": "src/grid-pro.definitions.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "gridProEventNames",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource:class",
@@ -11162,6 +11459,161 @@
           },
           "implementsTokenRanges": []
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasourceErrorEvent:type",
+          "docComment": "/**\n * The error event grid pro genesis datasource.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type GridProGenesisDatasourceErrorEvent = "
+            },
+            {
+              "kind": "Reference",
+              "text": "CustomEvent",
+              "canonicalReference": "!CustomEvent:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "GridProGenesisDatasourceErrorEventDetail",
+              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasourceErrorEventDetail:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.ts",
+          "releaseTag": "Public",
+          "name": "GridProGenesisDatasourceErrorEvent",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasourceErrorEventDetail:type",
+          "docComment": "/**\n * The event detail for the grid pro genesis datasource `error` event.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type GridProGenesisDatasourceErrorEventDetail = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    message: string;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.ts",
+          "releaseTag": "Public",
+          "name": "GridProGenesisDatasourceErrorEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/grid-pro!gridProGenesisDatasourceEventNames:var",
+          "docComment": "/**\n * The Genesis Datasource events names.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "gridProGenesisDatasourceEventNames: "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    error: string;\n    rowDataSet: string;\n}"
+            }
+          ],
+          "fileUrlPath": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.config.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "gridProGenesisDatasourceEventNames",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/grid-pro!GridProGenesisRowDataSetEvent:type",
+          "docComment": "/**\n * The rowDataSet event grid pro genesis datasource.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type GridProGenesisRowDataSetEvent = "
+            },
+            {
+              "kind": "Reference",
+              "text": "CustomEvent",
+              "canonicalReference": "!CustomEvent:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "GridProGenesisRowDataSetEventDetail",
+              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisRowDataSetEventDetail:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.ts",
+          "releaseTag": "Public",
+          "name": "GridProGenesisRowDataSetEvent",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/grid-pro!GridProGenesisRowDataSetEventDetail:type",
+          "docComment": "/**\n * The event detail for the grid pro genesis datasource `rowDataSet` event.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type GridProGenesisRowDataSetEventDetail = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    data: any[];\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.ts",
+          "releaseTag": "Public",
+          "name": "GridProGenesisRowDataSetEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Enum",
           "canonicalReference": "@genesislcap/grid-pro!GridProRendererTypes:enum",
@@ -11413,7 +11865,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/grid-pro!gridProTemplate:var",
-          "docComment": "/**\n * The Grid Pro Template.\n *\n * @public\n */\n",
+          "docComment": "/**\n * @remarks\n *\n * HTML Element: \\<foundation-grid-pro\\>\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",