@genesislcap/grid-pro 15.11.0 → 15.12.0-FUI-2601.1

package/dist/grid-pro.d.ts

@@ -26,8 +26,8 @@ import { ColDef as ColDef_2 } from 'ag-grid-community';
 import { ColGroupDef } from '@ag-grid-community/core';
 import { ColSpanFunc } from 'ag-grid-community';
 import { ColSpanParams } from '@ag-grid-community/core';
-import { Column } from '@ag-grid-community/core';
-import { Column as Column_2 } from 'ag-grid-community';
+import { Column } from 'ag-grid-community';
+import { Column as Column_2 } from '@ag-grid-community/core';
 import type { ColumnApi } from '@ag-grid-community/core';
 import { ColumnChooserParams } from 'ag-grid-community';
 import { ColumnMenuTab } from '@ag-grid-community/core';
@@ -69,8 +69,8 @@ import { GetQuickFilterTextParams } from '@ag-grid-community/core';
 import { Grid } from '@ag-grid-community/core';
 import type { GridApi } from '@ag-grid-community/core';
 import type { GridApi as GridApi_2 } from 'ag-grid-community';
-import { GridOptions } from '@ag-grid-community/core';
-import { GridOptions as GridOptions_2 } from 'ag-grid-community';
+import { GridOptions } from 'ag-grid-community';
+import { GridOptions as GridOptions_2 } from '@ag-grid-community/core';
 import type { GridParams } from '@ag-grid-community/core';
 import type { GridParams as GridParams_2 } from 'ag-grid-community';
 import { GridReadyEvent } from 'ag-grid-community';
@@ -99,6 +99,8 @@ import { IRowDragItem } from '@ag-grid-community/core';
 import { IRowNode } from '@ag-grid-community/core';
 import { IStatusPanelComp } from 'ag-grid-community';
 import { IStatusPanelParams } from 'ag-grid-community';
+import type { IToolPanelComp } from 'ag-grid-community';
+import type { IToolPanelParams } from 'ag-grid-community';
 import { ITooltipComp } from '@ag-grid-community/core';
 import { ITooltipParams } from '@ag-grid-community/core';
 import { JSONSerializer } from '@genesislcap/foundation-utils';
@@ -145,6 +147,7 @@ import { SwatchRGB } from '@microsoft/fast-components';
 import { TextField } from '@genesislcap/foundation-ui';
 import { ToolPanelClassParams } from '@ag-grid-community/core';
 import { ToolPanelClassParams as ToolPanelClassParams_2 } from 'ag-grid-community';
+import type { ToolPanelDef } from 'ag-grid-community';
 import { TooltipValueGetterFunc } from 'ag-grid-community';
 import { ValueFormatterFunc } from '@ag-grid-community/core';
 import { ValueFormatterFunc as ValueFormatterFunc_2 } from 'ag-grid-community';
@@ -569,6 +572,11 @@ export declare const agThemeTokenMapClassname: (themeName: string) => string;
  */
 export declare const agThemeTokenMapCSS: (themeName: string, tokenMap: CSSVarTokenMap<any>) => ElementStyles;
 
+export declare function applyVisibleOrder<T extends {
+    colId?: string;
+    hide?: boolean | null;
+}>(columnState: T[], visibleOrder: string[]): T[];
+
 /**
  * The background color swatch.
  * @internal
@@ -642,6 +650,73 @@ export declare type BooleanRendererParams = {
  */
 export declare const CellTemplate: ViewTemplate<GridProCell, any>;
 
+export declare interface ColumnPickerItem {
+    colId: string;
+    headerName: string;
+    visible: boolean;
+    lockVisible: boolean;
+}
+
+/**
+ * Custom columns tool panel. Replaces AG Grid Enterprise `agColumnsToolPanel`.
+ *
+ * @public
+ * @remarks
+ * Registered as `gridProColumnsToolPanel` (`GridProToolPanelTypes.columns`).
+ * `resolveGridProSideBar` rewrites `sideBar: ['columns']` / `agColumnsToolPanel` to this
+ * component so hosts do not need `ColumnsToolPanelModule` — only `SideBarModule`.
+ *
+ * Layout: search → visible columns (drag to reorder) → divider → hidden columns.
+ * Checkboxes toggle visibility via `api.setColumnsVisible`; drag is limited to the
+ * visible list and disabled while a search filter is active.
+ */
+export declare class ColumnsToolPanel implements IToolPanelComp {
+    private params;
+    private api;
+    private eGui;
+    private searchInput;
+    /** Visible (checked) columns, in grid display order. */
+    private selectedList;
+    /** Hidden columns, alphabetical after search filter. */
+    private unselectedList;
+    private divider;
+    private search;
+    /** Source colId while a visible-row drag is in progress. */
+    private dragColId;
+    /** Stable listener refs so `destroy` can remove the same functions `init` added. */
+    private readonly boundRefresh;
+    /**
+     * AG Grid `IToolPanelComp` entry. Builds the DOM once and subscribes to column
+     * events so the picker stays in sync with header menu / API visibility changes.
+     */
+    init(params: IToolPanelParams): void;
+    /**
+     * Rebuilds both lists from current grid column state.
+     * Displayed columns stay first (grid order); hidden columns follow so search
+     * and drag operate on a single ordered picker model.
+     */
+    refresh(): void;
+    /** Root element AG Grid mounts into the sidebar. */
+    getGui(): HTMLElement;
+    destroy(): void;
+    /** One-time DOM: scoped styles, search, visible list, divider, hidden list. */
+    private buildGui;
+    private renderList;
+    /**
+     * One picker row: drag handle + visibility checkbox + header label.
+     * Drag is only bound for visible rows when search is empty so reorder
+     * matches full grid order, not a filtered subset.
+     */
+    private createItem;
+    /** HTML5 drag-and-drop between visible rows; drop target colId is `colId`. */
+    private bindDrag;
+    /**
+     * Applies a new visible-column order via `applyColumnState({ applyOrder: true })`.
+     * Hidden columns keep their relative positions; only the visible slice is permuted.
+     */
+    private reorderSelected;
+}
+
 /**
  * The Grid Pro Column Template.
  * @public
@@ -1399,7 +1474,7 @@ export declare interface FuiCellRendererParams extends ICellRendererParams {
 export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_base {
     connect: Connect;
     datasource: Datasource;
-    deferredGridOptions: GridOptions;
+    deferredGridOptions: GridOptions_2;
     deferredColumnStates: ColumnState[];
     /**
      * Allows grid data updates to be processed via and external function before applying in grid
@@ -2033,6 +2108,8 @@ export declare const getMultiselectEditorTemplate: (designSystem?: string) => Vi
  */
 export declare const getNumberEditorTemplate: (designSystem?: string) => ViewTemplate<NumberEditor, any>;
 
+export declare function getPickerItems(columns: Column[]): ColumnPickerItem[];
+
 /**
  * Get a Design System prefixed Select template.
  * @param designSystem - The design system prefix to use. Defaults to 'foundation'.
@@ -2107,7 +2184,7 @@ export declare interface GridCssClassEventDetail {
  * Grid options config used to configure grids across the application
  * @public
  */
-export declare type GridOptionsConfig = GridOptions_2 | GridOptions;
+export declare type GridOptionsConfig = GridOptions | GridOptions_2;
 
 /**
  * Grid options config used to inject into grids in application
@@ -2260,7 +2337,7 @@ export declare class GridPro extends GridPro_base {
     private columnState;
     protected agAttributes: Record<string, string>;
     protected agPropertiesMap: Record<string, string>;
-    protected agGridOptions: GridOptions;
+    protected agGridOptions: GridOptions_2;
     /**
      * Last grid options supplied via the public `gridOptions` setter (not datasource init).
      * Used as the merge base in `handleInitialize` so user options survive datasource restart.
@@ -2534,7 +2611,7 @@ export declare class GridPro extends GridPro_base {
     private addMaxRowsPanel;
     private addAggregationPanel;
     private addDatasourcePanels;
-    protected setupStatusBar(gridOptions: GridOptions): void;
+    protected setupStatusBar(gridOptions: GridOptions_2): void;
     /**
      * Handles column sizing based on sizeColumnsToContent and sizeColumnsToFit attributes
      * @private
@@ -3103,7 +3180,7 @@ export declare class GridProBeta extends GridProBeta_base {
     private columnState;
     protected agAttributes: Record<string, any>;
     protected agPropertiesMap: Record<string, string>;
-    protected agGridOptions: GridOptions_2;
+    protected agGridOptions: GridOptions;
     /** User-supplied grid options cached as merge base for datasource re-init. */
     private userProvidedGridOptions;
     private applyingDatasourceGridOptions;
@@ -3310,7 +3387,7 @@ export declare class GridProBeta extends GridProBeta_base {
     /**
      * @public
      */
-    get gridOptions(): GridOptions_2;
+    get gridOptions(): GridOptions;
     /**
      * @public
      */
@@ -3331,7 +3408,7 @@ export declare class GridProBeta extends GridProBeta_base {
      * @internal
      */
     private notifyDatasourceVisibleColumns;
-    set gridOptions(options: GridOptions_2);
+    set gridOptions(options: GridOptions);
     private setLocalGridOptions;
     /**
      * Clears the local grid options, this is used to clear the grid options when the grid is restarted.
@@ -3457,7 +3534,7 @@ export declare class GridProBeta extends GridProBeta_base {
         resizable?: boolean;
         suppressSizeToFit?: boolean;
         suppressAutoSize?: boolean;
-        pivotValueColumn?: Column | Column_2<any>;
+        pivotValueColumn?: Column_2 | Column<any>;
         pivotTotalColumnIds?: string[];
         spanHeaderHeight?: boolean;
         headerName?: string;
@@ -3521,7 +3598,7 @@ export declare class GridProBeta extends GridProBeta_base {
     private addMaxRowsPanel;
     private addAggregationPanel;
     private addDatasourcePanels;
-    protected setupStatusBar(gridOptions: GridOptions_2): void;
+    protected setupStatusBar(gridOptions: GridOptions): void;
     get observedAttributes(): string[];
     agAttributeChangedCallback(attName: any, oldValue: any, newValue: any): void;
     globalEventListener(eventType: any, event: any): void;
@@ -3603,9 +3680,7 @@ declare const GridProBeta_base: (new (...args: any[]) => {
     slot: string;
     readonly tagName: string;
     attachShadow(init: ShadowRootInit): ShadowRoot;
-    checkVisibility(options? /**
-    * The key to use for persisting the filter model in local browser or KV storage.
-    */: CheckVisibilityOptions): boolean;
+    checkVisibility(options?: CheckVisibilityOptions): boolean;
     closest<K extends keyof HTMLElementTagNameMap>(selector: K): HTMLElementTagNameMap[K];
     closest<K extends keyof SVGElementTagNameMap>(selector: K): SVGElementTagNameMap[K];
     closest<K extends keyof MathMLElementTagNameMap>(selector: K): MathMLElementTagNameMap[K];
@@ -4347,6 +4422,8 @@ declare const GridProColumn_base: (new (...args: any[]) => {
  */
 export declare function gridProColumns<TSource = any>(itemsBinding: Binding<TSource, readonly ColDef[]> | readonly ColDef[], includeRenderers?: boolean): CaptureType<TSource>;
 
+export declare const gridProColumnsToolPanelDef: ToolPanelDef;
+
 /**
  * Grid Pro possible error events
  * @public
@@ -4390,7 +4467,7 @@ export declare const gridProEventNames: {
  * @remarks - This type is used to define the events and callbacks that can be passed to the grid
  * @public
  */
-export declare type GridProEventsAndCallbacks = OnlyFunctions<UntypeNonFunctions<GridOptions_2>>;
+export declare type GridProEventsAndCallbacks = OnlyFunctions<UntypeNonFunctions<GridOptions>>;
 
 /**
  * Grid Pro Event Listeners
@@ -5660,6 +5737,15 @@ export declare enum GridProStatusBarTypes {
  */
 export declare const gridProTemplate: ViewTemplate;
 
+/**
+ * Custom Grid Pro tool panel component names.
+ * @public
+ * @remarks Replaces AG Grid Enterprise `agColumnsToolPanel`. Requires `SideBarModule`.
+ */
+export declare enum GridProToolPanelTypes {
+    columns = "gridProColumnsToolPanel"
+}
+
 /**
  * Event detail for the `gridReady`/`onGridReady` signals.
  * @public
@@ -6480,6 +6566,11 @@ export declare enum OperationType {
 /** The CSS class to use for the options element's class in the dropdown */
 export declare const optionsClass = "options";
 
+export declare function partitionPickerItems(items: ColumnPickerItem[], search: string): {
+    selected: ColumnPickerItem[];
+    unselected: ColumnPickerItem[];
+};
+
 /**
  * Event detail for requesting a server-side row model refresh.
  */
@@ -6523,6 +6614,13 @@ export declare type ReloadStatusBarParams = {
     tooltip?: string;
 };
 
+export declare function reorderVisibleIds(allVisibleIds: string[], shownIds: string[], fromId: string, toId: string): string[] | null;
+
+/**
+ * Rewrites `sideBar: ['columns']` / `agColumnsToolPanel` to the custom Grid Pro picker.
+ */
+export declare function resolveGridProSideBar(sideBar: GridOptions['sideBar']): GridOptions['sideBar'];
+
 /**
  * Resolves the field names of the currently visible columns.
  * @remarks Prefers the grid's displayed columns (`getAllDisplayedColumns()` — already excludes
@@ -6815,6 +6913,8 @@ export declare const textFieldRendererStyles: ElementStyles;
  */
 export declare const textRendererStyles: ElementStyles;
 
+export declare function toPickerItem(col: Column): ColumnPickerItem | null;
+
 /**
  * @public
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/grid-pro",
   "description": "Genesis Foundation AG Grid",
-  "version": "15.11.0",
+  "version": "15.12.0-FUI-2601.1",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -40,20 +40,20 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "15.11.0",
-    "@genesislcap/genx": "15.11.0",
-    "@genesislcap/rollup-builder": "15.11.0",
-    "@genesislcap/ts-builder": "15.11.0",
-    "@genesislcap/uvu-playwright-builder": "15.11.0",
-    "@genesislcap/vite-builder": "15.11.0",
-    "@genesislcap/webpack-builder": "15.11.0"
+    "@genesislcap/foundation-testing": "15.12.0-FUI-2601.1",
+    "@genesislcap/genx": "15.12.0-FUI-2601.1",
+    "@genesislcap/rollup-builder": "15.12.0-FUI-2601.1",
+    "@genesislcap/ts-builder": "15.12.0-FUI-2601.1",
+    "@genesislcap/uvu-playwright-builder": "15.12.0-FUI-2601.1",
+    "@genesislcap/vite-builder": "15.12.0-FUI-2601.1",
+    "@genesislcap/webpack-builder": "15.12.0-FUI-2601.1"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "15.11.0",
-    "@genesislcap/foundation-criteria": "15.11.0",
-    "@genesislcap/foundation-logger": "15.11.0",
-    "@genesislcap/foundation-ui": "15.11.0",
-    "@genesislcap/foundation-utils": "15.11.0",
+    "@genesislcap/foundation-comms": "15.12.0-FUI-2601.1",
+    "@genesislcap/foundation-criteria": "15.12.0-FUI-2601.1",
+    "@genesislcap/foundation-logger": "15.12.0-FUI-2601.1",
+    "@genesislcap/foundation-ui": "15.12.0-FUI-2601.1",
+    "@genesislcap/foundation-utils": "15.12.0-FUI-2601.1",
     "@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": "261d900881ea1ca2b613033af497ffd449868eb0"
+  "gitHead": "7a4081c72e81fa1307d4aab9280dca81f0cb2e38"
 }