@genesislcap/grid-pro 14.393.3 → 14.393.4

package/docs/api/grid-pro.sizechangedeventdetail.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; [SizeChangedEventDetail](./grid-pro.sizechangedeventdetail.md)
+
+## SizeChangedEventDetail interface
+
+Event detail for size changes
+
+**Signature:**
+
+```typescript
+export interface SizeChangedEventDetail 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[oldValue](./grid-pro.sizechangedeventdetail.oldvalue.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[value](./grid-pro.sizechangedeventdetail.value.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/grid-pro.sizechangedeventdetail.oldvalue.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; [SizeChangedEventDetail](./grid-pro.sizechangedeventdetail.md) &gt; [oldValue](./grid-pro.sizechangedeventdetail.oldvalue.md)
+
+## SizeChangedEventDetail.oldValue property
+
+**Signature:**
+
+```typescript
+oldValue: number;
+```

package/docs/api/grid-pro.sizechangedeventdetail.value.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; [SizeChangedEventDetail](./grid-pro.sizechangedeventdetail.md) &gt; [value](./grid-pro.sizechangedeventdetail.value.md)
+
+## SizeChangedEventDetail.value property
+
+**Signature:**
+
+```typescript
+value: number;
+```

package/docs/api-report.md.api.md

@@ -46,6 +46,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';
@@ -61,6 +62,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';
@@ -108,14 +110,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';
@@ -426,6 +432,21 @@ export const agThemeTokenMapCSS: (themeName: string, tokenMap: CSSVarTokenMap<an
 // @internal @deprecated
 export const backgroundSwatch: SwatchRGB;
 
+// @public
+export type BaseDatasourceErrorEvent = CustomEvent<BaseDatasourceErrorEventDetail>;
+
+// @public
+export type BaseDatasourceErrorEventDetail = {
+    message: string;
+    type: 'connection' | 'resource-validation' | 'resource-type' | 'metadata' | 'stream' | 'criteria' | 'unknown';
+};
+
+// @public
+export const baseDatasourceEventNames: {
+    readonly error: "base-datasource-error";
+    readonly connected: "base-datasource-connected";
+};
+
 // @public
 export class BooleanRenderer extends FoundationElement implements ICellRendererComp {
     // (undocumented)
@@ -488,6 +509,72 @@ export const criteriaJoin = " && ";
 // @public
 export const csvExportParams: CsvExportParams;
 
+// @public
+export interface DataChangedEventDetail {
+    // (undocumented)
+    changes: {
+        add?: any[];
+        remove?: any[];
+        update?: any[];
+        insertIndex?: number;
+    };
+}
+
+// @public
+export interface DataClearedEventDetail {
+    // (undocumented)
+    includeSchema?: boolean;
+}
+
+// @public
+export interface DataLoadedEventDetail {
+    // (undocumented)
+    data: any[];
+    // (undocumented)
+    isInitialLoad?: boolean;
+}
+
+// @public
+export interface DatasourceErrorEventDetail {
+    // (undocumented)
+    message: string;
+    // (undocumented)
+    type: 'stream' | 'criteria' | 'connection' | 'unknown';
+}
+
+// @public
+export interface DatasourceEvent<T = DatasourceEventDetail> extends CustomEvent<T> {
+    // (undocumented)
+    type: keyof typeof datasourceEventNames;
+}
+
+// @public
+export type DatasourceEventDetail = InitializeEventDetail | DataLoadedEventDetail | DataChangedEventDetail | SchemaUpdatedEventDetail | MoreDataAvailableEventDetail | SizeChangedEventDetail | DataClearedEventDetail | DatasourceErrorEventDetail;
+
+// @public
+export 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";
+};
+
 // @public
 export type DatasourceType = 'client' | 'server';
 
@@ -912,7 +999,6 @@ export class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_b
     deferredGridOptions: GridOptions;
     disablePolling: boolean;
     fields: string;
-    // Warning: (ae-forgotten-export) The symbol "BaseDatasourceErrorEventDetail" needs to be exported by the entry point index.d.ts
     handleErrors(errors: string | any[], type?: BaseDatasourceErrorEventDetail['type']): void;
     // @internal
     protected get hasDefaultRowId(): boolean;
@@ -1755,6 +1841,18 @@ export type GrigProGenesisDatasourceSizeChangedEventDetail = {
     oldValue: number;
 };
 
+// @public
+export interface InitializeEventDetail {
+    // (undocumented)
+    keepColDefsOnClearRowData: boolean;
+    // (undocumented)
+    options: {
+        getRowId?: (params: any) => string;
+        columnDefs?: ColDef[];
+        [key: string]: any;
+    };
+}
+
 // @public
 export class KVStorageStatePersistence implements StatePersistence {
     // (undocumented)
@@ -1844,6 +1942,14 @@ export const logger: Logger;
 // @public
 export function mergeAndDedupColDefWithColumnState(colDefs: ColDef[], columnStates: ColumnState[]): ColDef[];
 
+// @public
+export interface MoreDataAvailableEventDetail {
+    // (undocumented)
+    hasMoreData: boolean;
+    // (undocumented)
+    sourceRef: string;
+}
+
 // @public
 export type MoreRowsDetail = {
     moreRows: boolean;
@@ -1988,6 +2094,14 @@ export class RowCountStatusBarComponent implements IStatusPanelComp {
     init(params: IStatusPanelParams): void;
 }
 
+// @public
+export interface SchemaUpdatedEventDetail {
+    // (undocumented)
+    metadata?: FieldMetadata[];
+    // (undocumented)
+    schema: ColDef[];
+}
+
 // @public
 export interface SelectCellRendererParams extends ICellRendererParams {
     // (undocumented)
@@ -2084,6 +2198,40 @@ export interface SelectRendererOptions {
     tooltip?: string;
 }
 
+// @alpha
+export type ServerSideDatasourceOptions = {
+    createDataserverStreamFunc?: (existingParams?: any) => Promise<SocketObservable<FilteredDataServerResult>>;
+    createReqRepRequestFunc?: (existingParams?: any) => Promise<RequestServerResult>;
+    createReqRepStreamFunc?: (params?: any) => Promise<{
+        stream: SocketObservable<RequestServerResult>;
+        datasource: Datasource;
+    }>;
+    onPollingUpdateFunc?: (result: RequestServerResult) => void;
+    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;
+};
+
+// @public
+export interface SizeChangedEventDetail {
+    // (undocumented)
+    oldValue: number;
+    // (undocumented)
+    value: number;
+}
+
 // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "StatePersistence" because one of its declarations is marked as @internal
 //
 // @public

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/grid-pro",
   "description": "Genesis Foundation AG Grid",
-  "version": "14.393.3",
+  "version": "14.393.4",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -40,19 +40,19 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.393.3",
-    "@genesislcap/genx": "14.393.3",
-    "@genesislcap/rollup-builder": "14.393.3",
-    "@genesislcap/ts-builder": "14.393.3",
-    "@genesislcap/uvu-playwright-builder": "14.393.3",
-    "@genesislcap/vite-builder": "14.393.3",
-    "@genesislcap/webpack-builder": "14.393.3"
+    "@genesislcap/foundation-testing": "14.393.4",
+    "@genesislcap/genx": "14.393.4",
+    "@genesislcap/rollup-builder": "14.393.4",
+    "@genesislcap/ts-builder": "14.393.4",
+    "@genesislcap/uvu-playwright-builder": "14.393.4",
+    "@genesislcap/vite-builder": "14.393.4",
+    "@genesislcap/webpack-builder": "14.393.4"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.393.3",
-    "@genesislcap/foundation-logger": "14.393.3",
-    "@genesislcap/foundation-ui": "14.393.3",
-    "@genesislcap/foundation-utils": "14.393.3",
+    "@genesislcap/foundation-comms": "14.393.4",
+    "@genesislcap/foundation-logger": "14.393.4",
+    "@genesislcap/foundation-ui": "14.393.4",
+    "@genesislcap/foundation-utils": "14.393.4",
     "@microsoft/fast-colors": "5.3.1",
     "@microsoft/fast-components": "2.30.6",
     "@microsoft/fast-element": "1.14.0",
@@ -79,5 +79,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "ebb3f21dffc97d5139e2127dac78a0a1f8934986"
+  "gitHead": "b1ee3b153d9a2d9fea81ec401c3a3a7ca4f2db6e"
 }