@genesislcap/grid-pro 14.292.0 → 14.293.1

package/dist/grid-pro.api.json

@@ -7184,6 +7184,37 @@
               "isProtected": true,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/grid-pro!GenesisGridDatasourceElement#clearErrors:member(1)",
+              "docComment": "/**\n * Clears error state and emits connected event.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "clearErrors(): "
+                },
+                {
+                  "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": "clearErrors"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/grid-pro!GenesisGridDatasourceElement#connect:member",
@@ -7565,6 +7596,75 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/grid-pro!GenesisGridDatasourceElement#handleErrors:member(1)",
+              "docComment": "/**\n * Handles errors and emits appropriate error events.\n *\n * @param errors - The error message or array of error messages\n *\n * @param type - The type of error that occurred\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "handleErrors(errors: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string | any[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", type?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BaseDatasourceErrorEventDetail",
+                  "canonicalReference": "@genesislcap/grid-pro!~BaseDatasourceErrorEventDetail:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "['type']"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 6,
+                "endIndex": 7
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "errors",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "type",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 5
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "handleErrors"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/grid-pro!GenesisGridDatasourceElement#isRequestServer:member",
@@ -7913,6 +8013,36 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GenesisGridDatasourceElement#restartOnReconnection:member",
+              "docComment": "/**\n * Attribute to set whether the datasource should restart when it reconnects.\n *\n * @remarks\n *\n * Defaults to `true`.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "restartOnReconnection: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "restartOnReconnection",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/grid-pro!GenesisGridDatasourceElement#reverse:member",
@@ -11484,6 +11614,41 @@
               "isAbstract": false,
               "name": "applyTransactionAsync"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridProBaseDatasource#connectionSub:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected connectionSub: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Subscription",
+                  "canonicalReference": "rxjs!Subscription:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "connectionSub",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": true,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/grid-pro!GridProBaseDatasource#dataSubWasLoggedOff:member",
@@ -11828,6 +11993,37 @@
               "isAbstract": false,
               "name": "handleStreamUpdates"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/grid-pro!GridProBaseDatasource#isDisconnected:member(1)",
+              "docComment": "/**\n * Returns true if the grid has the ds-disconnected attribute.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "isDisconnected(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "isDisconnected"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!GridProBaseDatasource#loadMore:member(1)",
@@ -11985,6 +12181,116 @@
               "isStatic": false,
               "isProtected": false,
               "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/grid-pro!GridProBaseDatasource#setDisconnected:member(1)",
+              "docComment": "/**\n * Sets or removes the ds-disconnected attribute on the grid element.\n *\n * @param disconnected - true to set, false to remove\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setDisconnected(disconnected: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "disconnected",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setDisconnected"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/grid-pro!GridProBaseDatasource#subscribeToConnection:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected subscribeToConnection(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": true,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "subscribeToConnection"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/grid-pro!GridProBaseDatasource#unsubscribeFromConnection:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected unsubscribeFromConnection(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": true,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "unsubscribeFromConnection"
             }
           ],
           "extendsTokenRange": {
@@ -13587,54 +13893,6 @@
               "isAbstract": false,
               "name": "disconnectedCallback"
             },
-            {
-              "kind": "Method",
-              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#handleErrors:member(1)",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "handleErrors(errors: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string | any[]"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "errors",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                }
-              ],
-              "isOptional": false,
-              "isAbstract": false,
-              "name": "handleErrors"
-            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#handleStreamDeletes:member(1)",
@@ -14229,36 +14487,6 @@
               "isAbstract": false,
               "name": "restart"
             },
-            {
-              "kind": "Property",
-              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#restartOnReconnection:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "restartOnReconnection: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "boolean"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "restartOnReconnection",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
-            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#setFilter:member(1)",
@@ -15984,7 +16212,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/grid-pro!gridProTemplate:var",
-          "docComment": "/**\n * @remarks\n *\n * HTML Element: \\<foundation-grid-pro\\>\n *\n * @public\n */\n",
+          "docComment": "/**\n * @remarks\n *\n * HTML Element: <foundation-grid-pro>\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",

package/dist/grid-pro.d.ts

@@ -46,6 +46,7 @@ import { RowNodeTransaction } from '@ag-grid-community/core';
 import type { ServerSideTransaction } from '@ag-grid-community/core';
 import { ServerSideTransactionResult } from '@ag-grid-community/core';
 import { Session } from '@genesislcap/foundation-comms';
+import { Subscription } from 'rxjs';
 import { Swatch } from '@microsoft/fast-components';
 import { SwatchRGB } from '@microsoft/fast-components';
 import { TextField } from '@genesislcap/foundation-ui';
@@ -430,6 +431,15 @@ export declare const agThemeTokenMapCSS: (themeName: string, tokenMap: CSSVarTok
  */
 export declare const backgroundSwatch: SwatchRGB;
 
+/**
+ * Base datasource error event detail.
+ * @public
+ */
+declare type BaseDatasourceErrorEventDetail = {
+    message: string;
+    type: 'connection' | 'resource-validation' | 'resource-type' | 'metadata' | 'stream' | 'criteria' | 'unknown';
+};
+
 /**
  * The AG Boolean Renderer element.
  * @public
@@ -1072,6 +1082,12 @@ export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceE
      * @privateRemarks Attribute-only, not to be used as a property. Use `rowId` getter instead.
      */
     rowIdAttr: any;
+    /**
+     * Attribute to set whether the datasource should restart when it reconnects.
+     * @remarks Defaults to `true`.
+     * @privateRemarks This attribute is shared across all datasources to ensure consistent behavior.
+     */
+    restartOnReconnection: boolean;
     protected get rowId(): string;
     /**
      * Returns whether the `row-id` attribute is the default one, depending on the resource type.
@@ -1088,6 +1104,23 @@ export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceE
     get isRequestServer(): boolean;
     datasourceStatusChanged(prev: DatasourceStatus, next: DatasourceStatus): void;
     protected get agGrid(): GridPro | null;
+    /**
+     * Handles errors and emits appropriate error events.
+     * @param errors - The error message or array of error messages
+     * @param type - The type of error that occurred
+     * @public
+     */
+    handleErrors(errors: string | any[], type?: BaseDatasourceErrorEventDetail['type']): void;
+    /**
+     * Clears error state and emits connected event.
+     * @public
+     */
+    clearErrors(): void;
+    /**
+     * Override datasource initialization to handle errors properly.
+     * @internal
+     */
+    protected initializeDatasource(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
 }
 
 declare const GenesisGridDatasourceElement_base: new () => {
@@ -1102,11 +1135,7 @@ declare const GenesisGridDatasourceElement_base: new () => {
     autocapitalize: string;
     dir: string;
     draggable: boolean;
-    hidden: boolean; /**
-    * Attribute to set whether the REQUEST object should be automatically set up.
-    * @remarks Defaults to `true`. Only applies to REQUEST_SERVER (REQ-REP) resources.
-    * @privateRemarks To avoid breaking changes for now, once V15 is out this will be removed and the default behavior will be the same as `false` here.
-    */
+    hidden: boolean;
     inert: boolean;
     innerText: string;
     lang: string;
@@ -1262,7 +1291,9 @@ declare const GenesisGridDatasourceElement_base: new () => {
     ariaModal: string;
     ariaMultiLine: string;
     ariaMultiSelectable: string;
-    ariaOrientation: string;
+    ariaOrientation: string; /**
+    * @public
+    */
     ariaPlaceholder: string;
     ariaPosInSet: string;
     ariaPressed: string;
@@ -1350,10 +1381,7 @@ declare const GenesisGridDatasourceElement_base: new () => {
     onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
     onload: (this: GlobalEventHandlers, ev: Event) => any;
     onloadeddata: (this: GlobalEventHandlers, ev: Event) => any;
-    onloadedmetadata: (this: GlobalEventHandlers, ev: Event) => any; /**
-    * Helper function to extract configuration for status bar actions
-    * @internal
-    */
+    onloadedmetadata: (this: GlobalEventHandlers, ev: Event) => any;
     onloadstart: (this: GlobalEventHandlers, ev: Event) => any;
     onlostpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
     onmousedown: (this: GlobalEventHandlers, ev: MouseEvent) => any;
@@ -1781,6 +1809,7 @@ export declare class GridPro extends GridPro_base {
     addEventListener(eventType: string, listener: any, options?: boolean | AddEventListenerOptions): void;
     private addGridEventListener;
     private handleError;
+    private handleBaseDatasourceError;
     hideDatasourceError(): void;
     connectedCallback(): void;
     disconnectedCallback(): void;
@@ -1902,9 +1931,6 @@ declare const GridPro_base: (new (...args: any[]) => {
     spellcheck: boolean;
     title: string;
     translate: boolean;
-    /**
-     * If true, will enable row flashing for all rows for `add` async transactions
-     */
     attachInternals(): ElementInternals;
     click(): void;
     addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2014,6 +2040,14 @@ declare const GridPro_base: (new (...args: any[]) => {
     readonly DOCUMENT_NODE: number;
     readonly DOCUMENT_POSITION_CONTAINED_BY: number;
     readonly DOCUMENT_POSITION_CONTAINS: number;
+    /**
+     * Adds an event listener to the grid element.
+     * @param eventType - The event type to listen for. Recommened to use the `Events` from AG Grid.
+     * @param listener - The event listener to call when the event is fired.
+     * @param options - An options object that specifies characteristics about the event listener.
+     * @privateRemarks
+     * This will change once we do the AG Upgrade and `eventType` will be correctly typed.
+     */
     readonly DOCUMENT_POSITION_DISCONNECTED: number;
     readonly DOCUMENT_POSITION_FOLLOWING: number;
     readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
@@ -2205,6 +2239,9 @@ export declare class GridProBaseDatasource extends GenesisGridDatasourceElement
     protected agTransaction: RowDataTransaction | ServerSideTransaction;
     protected applyFuncName: string;
     protected applyAsyncFuncName: string;
+    protected connectionSub: Subscription | undefined;
+    protected subscribeToConnection(): void;
+    protected unsubscribeFromConnection(): void;
     protected generateColumnDefsFromMetadata(fieldsMetadata: FieldMetadata[], getFilterParamsByFieldType: Function): ColDef[];
     protected handleStreamInserts(insertedRows: any[], addIndex?: number): void;
     protected handleStreamDeletes(deletedRows: any[]): void;
@@ -2226,6 +2263,15 @@ export declare class GridProBaseDatasource extends GenesisGridDatasourceElement
     restart(): void;
     reloadResourceData(): void;
     destroy(): void;
+    /**
+     * Sets or removes the ds-disconnected attribute on the grid element.
+     * @param disconnected - true to set, false to remove
+     */
+    setDisconnected(disconnected: boolean): void;
+    /**
+     * Returns true if the grid has the ds-disconnected attribute.
+     */
+    isDisconnected(): boolean;
     /**
      * Helper function to extract configuration for status bar actions
      * @internal
@@ -2697,11 +2743,9 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
     criteriaChanged(oldCriteria: string, newCriteria: string): Promise<void>;
     requestChanged(oldRequest: string, newRequest: string): void;
     resourceNameChanged(oldValue: string, newValue: string): void;
-    restartOnReconnection: boolean;
     keepColDefsOnClearRowData: boolean;
     private dataSub;
     private updateSub;
-    private connectionSub;
     private requiresFullRowDataAndColDefs;
     private _lastMoreRows;
     private _isMoreRowsResult;
@@ -2780,7 +2824,6 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
      */
     private loadResourceData;
     private handleSnapshot;
-    handleErrors(errors: string | any[]): void;
     private handleStreamResult;
     /**
      * Updates the status bar based on more rows status
@@ -3670,7 +3713,7 @@ export declare enum GridProStatusBarTypes {
  *
  * @public
  * @remarks
- * HTML Element: \<foundation-grid-pro\>
+ * HTML Element: <foundation-grid-pro>
  */
 export declare const gridProTemplate: ViewTemplate;
 

package/docs/api/grid-pro.genesisgriddatasourceelement.clearerrors.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [clearErrors](./grid-pro.genesisgriddatasourceelement.clearerrors.md)
+
+## GenesisGridDatasourceElement.clearErrors() method
+
+Clears error state and emits connected event.
+
+**Signature:**
+
+```typescript
+clearErrors(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/grid-pro.genesisgriddatasourceelement.handleerrors.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [handleErrors](./grid-pro.genesisgriddatasourceelement.handleerrors.md)
+
+## GenesisGridDatasourceElement.handleErrors() method
+
+Handles errors and emits appropriate error events.
+
+**Signature:**
+
+```typescript
+handleErrors(errors: string | any[], type?: BaseDatasourceErrorEventDetail['type']): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  errors | string \| any\[\] | The error message or array of error messages |
+|  type | BaseDatasourceErrorEventDetail\['type'\] | _(Optional)_ The type of error that occurred |
+
+**Returns:**
+
+void
+