@genesislcap/grid-pro 14.393.3 → 14.393.4

package/dist/grid-pro.d.ts

@@ -40,6 +40,7 @@ import { CountdownUnit } from '@genesislcap/foundation-ui';
 import { CSSDesignToken } from '@microsoft/fast-foundation';
 import { CSSVarTokenMap } from '@genesislcap/foundation-ui';
 import { CsvExportParams } from '@ag-grid-community/core';
+import { DataserverParams } from '@genesislcap/foundation-comms';
 import { Datasource } from '@genesislcap/foundation-comms';
 import { DatasourceOptions } from '@genesislcap/foundation-comms';
 import { DatasourceStatus } from '@genesislcap/foundation-comms';
@@ -55,6 +56,7 @@ import { EditableCallback as EditableCallback_2 } from 'ag-grid-community';
 import { ElementStyles } from '@microsoft/fast-element';
 import { FieldMetadata } from '@genesislcap/foundation-comms';
 import { FieldTypeEnum } from '@genesislcap/foundation-comms';
+import { FilteredDataServerResult } from '@genesislcap/foundation-comms';
 import { FoundationElement } from '@microsoft/fast-foundation';
 import { FoundationElementRegistry } from '@microsoft/fast-foundation';
 import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
@@ -102,14 +104,18 @@ import { KVStorage } from '@genesislcap/foundation-comms';
 import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
 import { Logger } from '@genesislcap/foundation-logger';
 import { MenuItemDef } from 'ag-grid-community';
+import { MetadataDetail } from '@genesislcap/foundation-comms';
 import { NewValueParams } from '@ag-grid-community/core';
 import { NewValueParams as NewValueParams_2 } from 'ag-grid-community';
 import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
+import { RequestParams } from '@genesislcap/foundation-comms';
+import { RequestServerResult } from '@genesislcap/foundation-comms';
 import { RowDragCallback } from '@ag-grid-community/core';
 import { RowDragCallback as RowDragCallback_2 } from 'ag-grid-community';
 import { RowSpanParams } from '@ag-grid-community/core';
 import { RowSpanParams as RowSpanParams_2 } from 'ag-grid-community';
 import { Session } from '@genesislcap/foundation-comms';
+import { SocketObservable } from '@genesislcap/foundation-comms';
 import { SortComparatorFn } from 'ag-grid-community/dist/types/src/entities/colDef';
 import { SortDef } from 'ag-grid-community';
 import { SortDirection } from 'ag-grid-community';
@@ -532,15 +538,30 @@ export declare const agThemeTokenMapCSS: (themeName: string, tokenMap: CSSVarTok
  */
 export declare const backgroundSwatch: SwatchRGB;
 
+/**
+ * Base datasource error event.
+ * @public
+ */
+export declare type BaseDatasourceErrorEvent = CustomEvent<BaseDatasourceErrorEventDetail>;
+
 /**
  * Base datasource error event detail.
  * @public
  */
-declare type BaseDatasourceErrorEventDetail = {
+export declare type BaseDatasourceErrorEventDetail = {
     message: string;
     type: 'connection' | 'resource-validation' | 'resource-type' | 'metadata' | 'stream' | 'criteria' | 'unknown';
 };
 
+/**
+ * Base datasource error event names.
+ * @public
+ */
+export declare const baseDatasourceEventNames: {
+    readonly error: "base-datasource-error";
+    readonly connected: "base-datasource-connected";
+};
+
 /**
  * The AG Boolean Renderer element.
  * @public
@@ -638,6 +659,80 @@ export declare const criteriaJoin = " && ";
  */
 export declare const csvExportParams: CsvExportParams;
 
+/**
+ * Event detail for data changes
+ */
+export declare interface DataChangedEventDetail {
+    changes: {
+        add?: any[];
+        remove?: any[];
+        update?: any[];
+        insertIndex?: number;
+    };
+}
+
+/**
+ * Event detail for data clearing
+ */
+export declare interface DataClearedEventDetail {
+    includeSchema?: boolean;
+}
+
+/**
+ * Event detail for data loading
+ */
+export declare interface DataLoadedEventDetail {
+    data: any[];
+    isInitialLoad?: boolean;
+}
+
+/**
+ * Event detail for error events
+ */
+export declare interface DatasourceErrorEventDetail {
+    message: string;
+    type: 'stream' | 'criteria' | 'connection' | 'unknown';
+}
+
+/**
+ * Generic datasource event interface
+ */
+export declare interface DatasourceEvent<T = DatasourceEventDetail> extends CustomEvent<T> {
+    type: keyof typeof datasourceEventNames;
+}
+
+/**
+ * Union type for all datasource event details
+ */
+export declare type DatasourceEventDetail = InitializeEventDetail | DataLoadedEventDetail | DataChangedEventDetail | SchemaUpdatedEventDetail | MoreDataAvailableEventDetail | SizeChangedEventDetail | DataClearedEventDetail | DatasourceErrorEventDetail;
+
+/**
+ * Event names for datasource-grid communication
+ * These represent datasource operations, not grid-specific actions
+ */
+export declare const datasourceEventNames: {
+    readonly initialize: "datasource-initialize";
+    readonly ready: "datasource-ready";
+    readonly dataLoaded: "datasource-data-loaded";
+    readonly dataChanged: "datasource-data-changed";
+    readonly dataCleared: "datasource-data-cleared";
+    readonly schemaUpdated: "datasource-schema-updated";
+    readonly loadingStarted: "datasource-loading-started";
+    readonly loadingFinished: "datasource-loading-finished";
+    readonly noDataAvailable: "datasource-no-data-available";
+    readonly moreDataAvailable: "datasource-more-data-available";
+    readonly filtersRestored: "datasource-filters-restored";
+    readonly error: "datasource-error";
+    readonly destroy: "datasource-destroy";
+    readonly sizeChanged: "datasource-size-changed";
+    readonly cacheFilterConfig: "cache-filter-config";
+    readonly refreshServerSide: "refresh-server-side";
+    readonly setServerSideDatasource: "set-server-side-datasource";
+    readonly addGridCssClass: "add-grid-css-class";
+    readonly removeGridCssClass: "remove-grid-css-class";
+    readonly applyServerSideTransaction: "apply-server-side-transaction";
+};
+
 /**
  * Available datasource types
  * @remarks - This type is used to define what kind of datasource will be used in components like entity manager.
@@ -5276,6 +5371,18 @@ export declare type GrigProGenesisDatasourceSizeChangedEventDetail = {
     oldValue: number;
 };
 
+/**
+ * Event detail for datasource initialization
+ */
+export declare interface InitializeEventDetail {
+    keepColDefsOnClearRowData: boolean;
+    options: {
+        getRowId?: (params: any) => string;
+        columnDefs?: ColDef[];
+        [key: string]: any;
+    };
+}
+
 /**
  * Implementation for the KV Storage State Persistence interface.
  * @public
@@ -5395,6 +5502,14 @@ export declare const logger: Logger;
  */
 export declare function mergeAndDedupColDefWithColumnState(colDefs: ColDef[], columnStates: ColumnState[]): ColDef[];
 
+/**
+ * Event detail for more data availability
+ */
+export declare interface MoreDataAvailableEventDetail {
+    hasMoreData: boolean;
+    sourceRef: string;
+}
+
 /**
  * The Genesis Datasource event payload types.
  * @public
@@ -5579,6 +5694,14 @@ export declare class RowCountStatusBarComponent implements IStatusPanelComp {
     destroy(): void;
 }
 
+/**
+ * Event detail for schema updates
+ */
+export declare interface SchemaUpdatedEventDetail {
+    schema: ColDef[];
+    metadata?: FieldMetadata[];
+}
+
 /**
  * The interface for the select renderer parameters
  * @public
@@ -5654,6 +5777,57 @@ export declare interface SelectRendererOptions {
     tooltip?: string;
 }
 
+/**
+ * Type definition for configuration options used for streams.
+ * @remarks
+ * Used by {@link @genesislcap/grid-pro#GridProServerSideDatasource} constructor to configure options for the stream.
+ * @alpha
+ */
+export declare type ServerSideDatasourceOptions = {
+    createDataserverStreamFunc?: (existingParams?: any) => Promise<SocketObservable<FilteredDataServerResult>>;
+    createReqRepRequestFunc?: (existingParams?: any) => Promise<RequestServerResult>;
+    /**
+     * Function to create a polling stream for REQUEST_SERVER resources.
+     * @remarks Returns both the stream and the datasource instance for proper lifecycle management.
+     */
+    createReqRepStreamFunc?: (params?: any) => Promise<{
+        stream: SocketObservable<RequestServerResult>;
+        datasource: Datasource;
+    }>;
+    /**
+     * Callback function invoked when a polling update is received.
+     * @remarks Used by REQUEST_SERVER resources to apply updates via applyServerSideTransaction.
+     */
+    onPollingUpdateFunc?: (result: RequestServerResult) => void;
+    /**
+     * Callback function to reset the previous poll result comparison state.
+     * @remarks Called when the polling stream is destroyed or recreated with new parameters.
+     */
+    resetPreviousPollResultFunc?: () => void;
+    reloadResourceDataFunc?: (params: any) => Promise<void>;
+    errorHandlerFunc?: (message: string, type: string) => void;
+    resourceName: string;
+    resourceParams?: DataserverParams | RequestParams;
+    resourceIndexes?: Map<string, [string]>;
+    resourceColDefs?: MetadataDetail[];
+    maxRows?: number;
+    maxView?: number;
+    rowId?: string;
+    pagination?: boolean;
+    zeroBasedViewNumber?: boolean;
+    pagingMode?: PagingMode | undefined;
+    criteriaOnlyRequest?: boolean;
+    usePolling?: boolean;
+};
+
+/**
+ * Event detail for size changes
+ */
+export declare interface SizeChangedEventDetail {
+    value: number;
+    oldValue: number;
+}
+
 /**
  * Represents a state persistence and its capabilities.
  * Provides methods to set and get columns from the storage.

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [BaseDatasourceErrorEvent](./grid-pro.basedatasourceerrorevent.md)
+
+## BaseDatasourceErrorEvent type
+
+Base datasource error event.
+
+**Signature:**
+
+```typescript
+export type BaseDatasourceErrorEvent = CustomEvent<BaseDatasourceErrorEventDetail>;
+```
+**References:** [BaseDatasourceErrorEventDetail](./grid-pro.basedatasourceerroreventdetail.md)
+

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

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [BaseDatasourceErrorEventDetail](./grid-pro.basedatasourceerroreventdetail.md)
+
+## BaseDatasourceErrorEventDetail type
+
+Base datasource error event detail.
+
+**Signature:**
+
+```typescript
+export type BaseDatasourceErrorEventDetail = {
+    message: string;
+    type: 'connection' | 'resource-validation' | 'resource-type' | 'metadata' | 'stream' | 'criteria' | 'unknown';
+};
+```

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

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [baseDatasourceEventNames](./grid-pro.basedatasourceeventnames.md)
+
+## baseDatasourceEventNames variable
+
+Base datasource error event names.
+
+**Signature:**
+
+```typescript
+baseDatasourceEventNames: {
+    readonly error: "base-datasource-error";
+    readonly connected: "base-datasource-connected";
+}
+```

package/docs/api/grid-pro.datachangedeventdetail.changes.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [DataChangedEventDetail](./grid-pro.datachangedeventdetail.md) &gt; [changes](./grid-pro.datachangedeventdetail.changes.md)
+
+## DataChangedEventDetail.changes property
+
+**Signature:**
+
+```typescript
+changes: {
+        add?: any[];
+        remove?: any[];
+        update?: any[];
+        insertIndex?: number;
+    };
+```

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

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [DataChangedEventDetail](./grid-pro.datachangedeventdetail.md)
+
+## DataChangedEventDetail interface
+
+Event detail for data changes
+
+**Signature:**
+
+```typescript
+export interface DataChangedEventDetail 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[changes](./grid-pro.datachangedeventdetail.changes.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ add?: any\[\]; remove?: any\[\]; update?: any\[\]; insertIndex?: number; }
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/grid-pro.dataclearedeventdetail.includeschema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [DataClearedEventDetail](./grid-pro.dataclearedeventdetail.md) &gt; [includeSchema](./grid-pro.dataclearedeventdetail.includeschema.md)
+
+## DataClearedEventDetail.includeSchema property
+
+**Signature:**
+
+```typescript
+includeSchema?: boolean;
+```

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

@@ -0,0 +1,58 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [DataClearedEventDetail](./grid-pro.dataclearedeventdetail.md)
+
+## DataClearedEventDetail interface
+
+Event detail for data clearing
+
+**Signature:**
+
+```typescript
+export interface DataClearedEventDetail 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[includeSchema?](./grid-pro.dataclearedeventdetail.includeschema.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/grid-pro.dataloadedeventdetail.data.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [DataLoadedEventDetail](./grid-pro.dataloadedeventdetail.md) &gt; [data](./grid-pro.dataloadedeventdetail.data.md)
+
+## DataLoadedEventDetail.data property
+
+**Signature:**
+
+```typescript
+data: any[];
+```

package/docs/api/grid-pro.dataloadedeventdetail.isinitialload.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [DataLoadedEventDetail](./grid-pro.dataloadedeventdetail.md) &gt; [isInitialLoad](./grid-pro.dataloadedeventdetail.isinitialload.md)
+
+## DataLoadedEventDetail.isInitialLoad property
+
+**Signature:**
+
+```typescript
+isInitialLoad?: boolean;
+```

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

@@ -0,0 +1,75 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [DataLoadedEventDetail](./grid-pro.dataloadedeventdetail.md)
+
+## DataLoadedEventDetail interface
+
+Event detail for data loading
+
+**Signature:**
+
+```typescript
+export interface DataLoadedEventDetail 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[data](./grid-pro.dataloadedeventdetail.data.md)
+
+
+</td><td>
+
+
+</td><td>
+
+any\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isInitialLoad?](./grid-pro.dataloadedeventdetail.isinitialload.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

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

@@ -0,0 +1,73 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [DatasourceErrorEventDetail](./grid-pro.datasourceerroreventdetail.md)
+
+## DatasourceErrorEventDetail interface
+
+Event detail for error events
+
+**Signature:**
+
+```typescript
+export interface DatasourceErrorEventDetail 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[message](./grid-pro.datasourceerroreventdetail.message.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[type](./grid-pro.datasourceerroreventdetail.type.md)
+
+
+</td><td>
+
+
+</td><td>
+
+'stream' \| 'criteria' \| 'connection' \| 'unknown'
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/grid-pro.datasourceerroreventdetail.message.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [DatasourceErrorEventDetail](./grid-pro.datasourceerroreventdetail.md) &gt; [message](./grid-pro.datasourceerroreventdetail.message.md)
+
+## DatasourceErrorEventDetail.message property
+
+**Signature:**
+
+```typescript
+message: string;
+```

package/docs/api/grid-pro.datasourceerroreventdetail.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [DatasourceErrorEventDetail](./grid-pro.datasourceerroreventdetail.md) &gt; [type](./grid-pro.datasourceerroreventdetail.type.md)
+
+## DatasourceErrorEventDetail.type property
+
+**Signature:**
+
+```typescript
+type: 'stream' | 'criteria' | 'connection' | 'unknown';
+```