@genesislcap/grid-pro 14.486.1 → 14.487.0

package/dist/grid-pro.d.ts

@@ -847,6 +847,13 @@ export declare const defaultGridProConfig: {
 /** Class name used to hide elements with display:none */
 export declare const DISPLAY_NONE_CLASS = "dnone";
 
+/** Minimal shape of a displayed AG Grid column needed to resolve its field (package-agnostic). */
+declare interface DisplayedColumnLike {
+    getColDef(): {
+        field?: string | null;
+    };
+}
+
 /** The CSS variable to use for specifying the dropdown's width */
 export declare const dropdownWidthVar = "--dropdown-width";
 
@@ -2120,6 +2127,7 @@ export declare class GridPro extends GridPro_base {
     private disposed;
     private readonly debouncedSaveColumnState;
     private readonly debouncedSaveFilterModel;
+    private readonly debouncedNotifyDatasourceVisibleColumns;
     autoCellRendererByType: boolean;
     onlyTemplateColDefs: boolean;
     /**
@@ -2485,6 +2493,12 @@ export declare class GridPro extends GridPro_base {
      * @public
      */
     get gridProDatasource(): GridProBaseDatasource;
+    /**
+     * Reports the currently visible columns to the datasource. The datasource decides what to do with
+     * them (e.g. narrowing the server request); the grid stays agnostic of that behaviour.
+     * @internal
+     */
+    private notifyDatasourceVisibleColumns;
     set gridOptions(options: GridOptionsConfig);
     private setLocalGridOptions;
     /**
@@ -2954,6 +2968,14 @@ export declare class GridProBaseDatasource extends GenesisGridDatasourceElement
     private mapTransaction;
     protected pagination: boolean;
     loadMore(): void;
+    /**
+     * Notifies the datasource of the field names of the currently visible columns.
+     * @remarks No-op by default. Datasources that support column-scoped requests override this to
+     * narrow the server query and reload data when the visible column set changes.
+     * @param visibleFields - Field names of the currently visible columns.
+     * @public
+     */
+    setVisibleColumns(visibleFields: string[]): void;
     restart(): void;
     reloadResourceData(): void;
     destroy(): void;
@@ -3006,6 +3028,7 @@ export declare class GridProBeta extends GridProBeta_base {
     private disposed;
     private readonly debouncedSaveColumnState;
     private readonly debouncedSaveFilterModel;
+    private readonly debouncedNotifyDatasourceVisibleColumns;
     autoCellRendererByType: boolean;
     onlyTemplateColDefs: boolean;
     /**
@@ -3325,6 +3348,12 @@ export declare class GridProBeta extends GridProBeta_base {
      * @public
      */
     get gridProDatasource(): GridProBaseDatasource;
+    /**
+     * Reports the currently visible columns to the datasource. The datasource decides what to do with
+     * them (e.g. narrowing the server request); the grid stays agnostic of that behaviour.
+     * @internal
+     */
+    private notifyDatasourceVisibleColumns;
     set gridOptions(options: GridOptions_2);
     private setLocalGridOptions;
     /**
@@ -4420,6 +4449,16 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
     requestChanged(oldRequest: string, newRequest: string): void;
     resourceNameChanged(oldValue: string, newValue: string): void;
     keepColDefsOnClearRowData: boolean;
+    /**
+     * When enabled and column definitions are provided, the datasource requests data only for the
+     * columns that are currently visible. The visible set is seeded from the column config (columns
+     * not flagged with `hide`) and updated by the host grid via `setVisibleColumns`; the data
+     * is reloaded whenever that set changes.
+     * @remarks DATASERVER only.
+     * @default false
+     */
+    requestVisibleColumnsOnly: boolean;
+    private _visibleColumns;
     private dataSub;
     private updateSub;
     private requiresFullRowDataAndColDefs;
@@ -4536,6 +4575,38 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
      * @param deletes - List of records to remove from the grid stream
      */
     handleStreamDeletes(deletes?: any[]): void;
+    /**
+     * Extends the base options to constrain the requested fields to the visible columns when
+     * `requestVisibleColumnsOnly` is enabled.
+     * @remarks DATASERVER only; for other resource types the derived `fields` are ignored.
+     * @internal
+     */
+    protected datasourceOptions(): DatasourceOptions;
+    /**
+     * Builds the DATASERVER `FIELDS` string (space-separated) from the visible columns, always
+     * including the `rowId` so rows can be tracked.
+     * @internal
+     */
+    private getRequestedFields;
+    /**
+     * Returns the field names of the configured columns that are not hidden, used to seed the visible
+     * set before the host grid reports runtime visibility.
+     * @internal
+     */
+    private getConfiguredVisibleColumns;
+    /**
+     * Updates the set of visible columns and reloads the data when the set changes.
+     * @remarks Called by the host grid on column visibility changes; no-ops unless
+     * `requestVisibleColumnsOnly` is enabled. DATASERVER only; no-ops for other resource types.
+     * @param visibleFields - Field names of the currently visible columns.
+     * @public
+     */
+    setVisibleColumns(visibleFields: string[]): void;
+    /**
+     * Compares two column field lists irrespective of order.
+     * @internal
+     */
+    private columnsChanged;
     loadMore(): void;
 }
 
@@ -6494,6 +6565,19 @@ export declare type ReloadStatusBarParams = {
     tooltip?: string;
 };
 
+/**
+ * Resolves the field names of the currently visible columns.
+ * @remarks Prefers the grid's displayed columns (`getAllDisplayedColumns()` — already excludes
+ * hidden columns and children of collapsed groups, so no extra visibility check is needed); falls
+ * back to the current column defs (available earlier in the lifecycle than the columns), treating
+ * `hide` as not visible. Shared by the host grids to report the visible set to the datasource.
+ * Typed structurally so it works across the differing AG Grid type packages the grids depend on.
+ * @param displayedColumns - The grid's currently displayed columns, when available.
+ * @param colDefs - The current column defs, used as a fallback before the columns are populated.
+ * @public
+ */
+export declare function resolveVisibleColumnFields(displayedColumns: DisplayedColumnLike[] | null | undefined, colDefs: readonly unknown[] | null | undefined): string[];
+
 /**
  * Row Count Status Bar Component for Server-Side Infinite Scroll
  * Displays current row count information for server-side grids without pagination.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/grid-pro",
   "description": "Genesis Foundation AG Grid",
-  "version": "14.486.1",
+  "version": "14.487.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -40,20 +40,20 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.486.1",
-    "@genesislcap/genx": "14.486.1",
-    "@genesislcap/rollup-builder": "14.486.1",
-    "@genesislcap/ts-builder": "14.486.1",
-    "@genesislcap/uvu-playwright-builder": "14.486.1",
-    "@genesislcap/vite-builder": "14.486.1",
-    "@genesislcap/webpack-builder": "14.486.1"
+    "@genesislcap/foundation-testing": "14.487.0",
+    "@genesislcap/genx": "14.487.0",
+    "@genesislcap/rollup-builder": "14.487.0",
+    "@genesislcap/ts-builder": "14.487.0",
+    "@genesislcap/uvu-playwright-builder": "14.487.0",
+    "@genesislcap/vite-builder": "14.487.0",
+    "@genesislcap/webpack-builder": "14.487.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.486.1",
-    "@genesislcap/foundation-criteria": "14.486.1",
-    "@genesislcap/foundation-logger": "14.486.1",
-    "@genesislcap/foundation-ui": "14.486.1",
-    "@genesislcap/foundation-utils": "14.486.1",
+    "@genesislcap/foundation-comms": "14.487.0",
+    "@genesislcap/foundation-criteria": "14.487.0",
+    "@genesislcap/foundation-logger": "14.487.0",
+    "@genesislcap/foundation-ui": "14.487.0",
+    "@genesislcap/foundation-utils": "14.487.0",
     "@microsoft/fast-colors": "5.3.1",
     "@microsoft/fast-components": "2.30.6",
     "@microsoft/fast-element": "1.14.0",
@@ -91,5 +91,5 @@
       "require": "./dist/react.cjs"
     }
   },
-  "gitHead": "1e4e55b1ba9ef3aca8177127b52111d3ef0e53ae"
+  "gitHead": "e91b34059e2dab1ad9b0799de26c31f3fdfc0ece"
 }