@rockrms/obsidian-framework 1.16.9-rc.1 → 17.0.43

package/types/Core/Controls/grid.d.ts

@@ -1,406 +1,406 @@
-import { VNode } from "vue";
-import { ColumnDefinition, IGridState, StandardFilterProps, StandardCellProps, IGridCache, IGridRowCache, ColumnSort, StandardColumnProps, StandardHeaderCellProps, EntitySetOptions, StandardSkeletonCellProps } from "@Obsidian/Types/Controls/grid";
-import { GridDefinitionBag } from "@Obsidian/ViewModels/Core/Grid/gridDefinitionBag";
-import { GridEntitySetBag } from "@Obsidian/ViewModels/Core/Grid/gridEntitySetBag";
-import { Guid } from "@Obsidian/Types";
-/**
- * Defines the grid event names and the parameter they are passed.
- */
-declare type GridEvents = {
-    /** Called when the {@link IGridState.rows} value has changed. */
-    rowsChanged: IGridState;
-    /** Called when the {@link IGridState.filteredRows} value has changed. */
-    filteredRowsChanged: IGridState;
-    /** Called when the {@link IGridState.sortedRows} value has changed. */
-    sortedRowsChanged: IGridState;
-    /** Called when the {@link IGridState.visibleColumns} value has changed. */
-    visibleColumnsChanged: IGridState;
-    /** Called when the {@link IGridState.selectedKeys} value has changed. */
-    selectedKeysChanged: IGridState;
-    /** Called when the {@link IGridState.isFiltered} value has changed. */
-    isFilteredChanged: IGridState;
-    /** Called when the {@link IGridState.isSorted} value has changed. */
-    isSortedChanged: IGridState;
-};
-/**
- * The standard action URLs to use when performing grid actions.
- */
-export declare const GridActionUrlKey: {
-    /** The URL to use when sending a communication. */
-    readonly Communicate: "communicate";
-    /** The URL to use when merging Person records. */
-    readonly MergePerson: "mergePerson";
-    /** The URL to use when merging Business records. */
-    readonly MergeBusiness: "mergeBusiness";
-    /** The URL to use when performing a bulk update. */
-    readonly BulkUpdate: "bulkUpdate";
-    /** The URL to use when launching a workflow for each record. */
-    readonly LaunchWorkflow: "launchWorkflow";
-    /** The URL to use to start a merge template request. */
-    readonly MergeTemplate: "mergeTemplate";
-};
-/**
- * Defines the standard properties available on all columns.
- */
-export declare const standardColumnProps: StandardColumnProps;
-/** The standard properties available on header cells. */
-export declare const standardHeaderCellProps: StandardHeaderCellProps;
-/** The standard properties available on cells. */
-export declare const standardCellProps: StandardCellProps;
-/** The standard properties available on skeleton cells. */
-export declare const standardSkeletonCellProps: StandardSkeletonCellProps;
-/**
- * The standard properties that are made available to column filter
- * components.
- */
-export declare const standardFilterProps: StandardFilterProps;
-/**
- * The text column filter that performs a comparison of `haystack` and
- * the value and comparison type inside `needle` to see if it matches.
- *
- * @private This is used internally by Rock and should not be used directly.
- *
- * @param needle The filter value defined in the UI component.
- * @param haystack The filter value from the row that must match the `needle`.
- *
- * @returns True if `haystack` matches the `needle` and should be included in the results.
- */
-export declare function textFilterMatches(needle: unknown, haystack: unknown): boolean;
-/**
- * The boolean column filter that performs a comparison of `haystack` and
- * the comparison type inside `needle` to see if it matches.
- *
- * @private This is used internally by Rock and should not be used directly.
- *
- * @param needle The filter value defined in the UI component.
- * @param haystack The filter value from the row that must match the `needle`.
- *
- * @returns True if `haystack` matches the `needle` and should be included in the results.
- */
-export declare function booleanFilterMatches(needle: unknown, haystack: unknown): boolean;
-/**
- * The column filter compares the `needle` against the `haystack` to see if
- * they match. This is a deep equality check so if they are arrays or objects
- * then all child objects and properties must match exactly.
- *
- * @private This is used internally by Rock and should not be used directly.
- *
- * @param needle The filter value defined in the UI component.
- * @param haystack The filter value from the row that must match the `needle`.
- *
- * @returns True if `haystack` matches the `needle` and should be included in the results.
- */
-export declare function pickExistingFilterMatches(needle: unknown, haystack: unknown): boolean;
-/**
- * The number column filter that performs a comparison of `haystack` and
- * the value and comparison type inside `needle` to see if it matches.
- *
- * @private This is used internally by Rock and should not be used directly.
- *
- * @param needle The filter value defined in the UI component.
- * @param haystack The filter value from the row that must match the `needle`.
- *
- * @returns True if `haystack` matches the `needle` and should be included in the results.
- */
-export declare function numberFilterMatches(needle: unknown, haystack: unknown, column: ColumnDefinition, grid: IGridState): boolean;
-/**
- * The date column filter that performs a comparison of `haystack` and
- * the value and comparison type inside `needle` to see if it matches.
- *
- * @private This is used internally by Rock and should not be used directly.
- *
- * @param needle The filter value defined in the UI component.
- * @param haystack The filter value from the row that must match the `needle`.
- *
- * @returns True if `haystack` matches the `needle` and should be included in the results.
- */
-export declare function dateFilterMatches(needle: unknown, haystack: unknown): boolean;
-/**
- * Gets the entity set bag that can be send to the server to create an entity
- * set representing the selected items in the grid.
- *
- * @param grid The grid state that will be used as the source data.
- * @param keyFields The fields to use for the entity keys. This is only used when
- * populating the item entityKey value. It is not used to detect selection state.
- * If multiple keys are specified then an {@link GridEntitySetItemBag} will be
- * created for each key.
- * @param options The options that describe how the entity set should be generated.
- *
- * @returns A new instance of {@link GridEntitySetBag} that contains the data.
- */
-export declare function getEntitySetBag(grid: IGridState, keyFields: string[], options?: EntitySetOptions): Promise<GridEntitySetBag>;
-/**
- * Calculates the average numerical value across all rows in a grid column.
- *
- * @param column The column whose values should be considered for the average.
- * @param grid The grid that provides all the rows.
- *
- * @returns A number that represents the average value or `0` if no rows with numeric values existed.
- */
-export declare function calculateColumnAverageValue(column: ColumnDefinition, grid: IGridState): number;
-/**
- * Calculates top Nth numeric row value for a column. If the cell values are
- * `1, 2, 3, 4, 4, 5, 5` and `rowCount` is 3 then this will return
- * the value `4`. Which means the final row count displayed will be 4 because
- * there are 4 rows with values >= 4.
- *
- * @param column The column whose values should be considered for the average.
- * @param grid The grid that provides all the rows.
- *
- * @returns A number that represents the average value or `0` if no rows with numeric values existed.
- */
-export declare function calculateColumnTopNRowValue(rowCount: number, column: ColumnDefinition, grid: IGridState): number;
-/**
- * Builds the column definitions from the array of virtual nodes found inside
- * of a component.
- *
- * @param columnNodes The virtual nodes that contain the definitions of the columns.
- *
- * @returns An array of {@link ColumnDefinition} objects.
- */
-export declare function getColumnDefinitions(columnNodes: VNode[]): ColumnDefinition[];
-/**
- * Gets the key to use on the internal cache object to load the cached data
- * for the specified row.
- *
- * @param row The row whose identifier key is needed.
- *
- * @returns The identifier key of the row or `undefined` if it could not be determined.
- */
-export declare function getRowKey(row: Record<string, unknown>, itemIdKey?: string): string | undefined;
-/**
- * Gets the custom styles to apply to cells of a specific column.
- *
- * @param column The column whose cell styles are being requested.
- *
- * @returns An object that contains the custom styles to apply to cells of this column.
- */
-export declare function getColumnStyles(column: ColumnDefinition): Record<string, string>;
-/**
- * Default implementation used for caching data with Grid.
- *
- * @private This class is meant for internal use only.
- */
-export declare class GridCache implements IGridCache {
-    /** The private cache data storage. */
-    private cacheData;
-    clear(): void;
-    remove(key: string): void;
-    get<T = unknown>(key: string): T | undefined;
-    getOrAdd<T = unknown>(key: string, factory: () => T): T;
-    getOrAdd<T = unknown>(key: string, factory: () => T | undefined): T | undefined;
-    addOrReplace<T = unknown>(key: string, value: T): T;
-}
-/**
- * Default implementation used for caching grid row data.
- *
- * @private This class is meant for internal use only.
- */
-export declare class GridRowCache implements IGridRowCache {
-    /** The internal cache object used to find the cached row data. */
-    private cache;
-    /** The key name to use on the row objects to find the row identifier. */
-    private rowItemKey?;
-    /**
-     * Creates a new grid row cache object that provides caching for each row.
-     * This is used by other parts of the grid to cache expensive calculations
-     * that pertain to a single row.
-     *
-     * @param itemIdKey The key name to use on the row objects to find the row identifier.
-     */
-    constructor(itemIdKey: string | undefined);
-    /**
-     * Gets the key to use on the internal cache object to load the cached data
-     * for the specified row.
-     *
-     * @param row The row whose identifier key is needed.
-     *
-     * @returns The identifier key of the row or `undefined` if it could not be determined.
-     */
-    private getRowKey;
-    /**
-     * Sets the key that will be used when accessing a row to determine its
-     * unique identifier in the grid. This will also clear all cached data.
-     *
-     * @param itemKey The key name to use on the row objects to find the row identifier.
-     */
-    setRowItemKey(itemKey: string | undefined): void;
-    /**
-     * Removes the cached values for a row.
-     *
-     * @param rowKey The key that identifies the row.
-     * @param key The key inside the row cache to be removed or `undefined` to remove all cached data for the row.
-     */
-    removeByRowKey(rowKey: string, key: string | undefined): void;
-    clear(): void;
-    remove(row: Record<string, unknown>): void;
-    remove(row: Record<string, unknown>, key: string): void;
-    get<T = unknown>(row: Record<string, unknown>, key: string): T | undefined;
-    getOrAdd<T = unknown>(row: Record<string, unknown>, key: string, factory: () => T): T;
-    getOrAdd<T = unknown>(row: Record<string, unknown>, key: string, factory: () => T | undefined): T | undefined;
-    addOrReplace<T = unknown>(row: Record<string, unknown>, key: string, value: T): T;
-}
-/**
- * Default implementation of the grid state for internal use.
- *
- * @private The is an internal class that should not be used by plugins.
- */
-export declare class GridState implements IGridState {
-    private internalColumns;
-    private internalRows;
-    private internalFilteredRows;
-    private internalSortedRows;
-    private internalVisibleColumns;
-    private internalSelectedKeys;
-    private internalIsFiltered;
-    private internalIsSorted;
-    /** The definition data we were created with. */
-    private gridDefinition?;
-    /** This tracks the state of each row when operating in reactive mode. */
-    private rowReactiveTracker;
-    /** The handle that can be used to stop watching row changes. */
-    private internalRowsWatcher?;
-    /** Determines if we are monitoring for changes to the row data. */
-    private liveUpdates;
-    /** The key to get the unique identifier of each row. */
-    private itemKey?;
-    /** The current quick filter value that will be used to filter the rows. */
-    private quickFilter;
-    /**
-     * The currently applied per-column filters that will be used to filter
-     * the rows.
-     */
-    private columnFilters;
-    /** The current column being used to sort the rows. */
-    private columnSort?;
-    /** The event emitter for all the grid events. */
-    private readonly emitter;
-    /** A background worker that will populate all the row cache data. */
-    private populateRowCacheWorker;
-    /**
-     * Creates a new instance of the GridState for use with the Grid component.
-     *
-     * @param columns The columns to initialize the Grid with.
-     * @param gridDefinition The definition data that defines some of the structure of the grid.
-     * @param liveUpdates If true then the grid will monitor for live updates to rows.
-     * @param itemTerm The word or phrase that describes each row.
-     * @param entityTypeGuid The unique identifier of the entity type this grid represents, or `undefined`.
-     */
-    constructor(columns: ColumnDefinition[], gridDefinition: GridDefinitionBag | undefined, liveUpdates: boolean, itemTerm: string, entityTypeGuid: Guid | undefined);
-    /**
-     * Dispose of all resources this grid state has. This includes any watchers
-     * and other things that might need to be manually destroyed to free up
-     * memory. A common pattern would be to call this in the onUmounted() callback.
-     */
-    dispose(): void;
-    get rows(): ReadonlyArray<Record<string, unknown>>;
-    get filteredRows(): ReadonlyArray<Record<string, unknown>>;
-    private set filteredRows(value);
-    get sortedRows(): ReadonlyArray<Record<string, unknown>>;
-    private set sortedRows(value);
-    get columns(): ColumnDefinition[];
-    get visibleColumns(): ReadonlyArray<ColumnDefinition>;
-    private set visibleColumns(value);
-    get selectedKeys(): string[];
-    set selectedKeys(value: string[]);
-    get isFiltered(): boolean;
-    private set isFiltered(value);
-    get isSorted(): boolean;
-    private set isSorted(value);
-    readonly cache: IGridCache;
-    readonly rowCache: GridRowCache;
-    readonly itemTerm: string;
-    readonly entityTypeGuid?: Guid | undefined;
-    getColumnCacheKey(column: ColumnDefinition, component: string, key: string): string;
-    getRowKey(row: Record<string, unknown>): string | undefined;
-    getSortedRows(): Record<string, unknown>[];
-    on(event: keyof GridEvents, callback: (grid: IGridState) => void): void;
-    off(event: keyof GridEvents, callback: (grid: IGridState) => void): void;
-    /**
-     * Begins tracking all rows in the grid so that we can monitor for
-     * changes and update the UI accordingly.
-     */
-    private initializeReactiveTracker;
-    /**
-     * Detects any changes to the row data from the last time we were called.
-     * Must be called after {@link initializeReactiveTracker}.
-     */
-    private detectRowChanges;
-    /**
-     * Performs filtering of the {@link rows} and determines which rows
-     * match the filters.
-     */
-    private updateFilteredRows;
-    /**
-     * Sorts the given set of rows.
-     *
-     * @param rows The rows that should be sorted according to the current sorting definition.
-     *
-     * @returns A new array of rows that is properly sorted.
-     */
-    private sortRows;
-    /**
-     * Takes the {@link filteredRows} and sorts them according to the information
-     * tracked by the Grid and updates the {@link sortedRows} property.
-     */
-    private updateSortedRows;
-    /**
-     * Gets the row key and row index of the specified key or index.
-     *
-     * @param keyOrIndex The row key or index.
-     *
-     * @returns An object that contains both the key and index or `undefined` if it was not found.
-     */
-    private getRowKeyAndIndex;
-    /**
-     * Sets the item key used to uniquely identify rows.
-     *
-     * @param value The field name that contains the item key.
-     */
-    setItemKey(value: string | undefined): void;
-    /**
-     * Sets the columns that can be used on the grid.
-     *
-     * @param columns The new columns that should be available on the grid.
-     */
-    setColumns(columns: ColumnDefinition[]): void;
-    /**
-     * Sets the rows to be used by the Grid. This will replace all existing
-     * row data.
-     *
-     * @param rows The array of row data to use for the Grid.
-     */
-    setDataRows(rows: Record<string, unknown>[]): void;
-    /**
-     * Sets the filters to be used to filter the rows down to a limited set.
-     *
-     * @param quickFilter The value to use for quick filtering.
-     * @param columnFilters The column filters to apply to the data.
-     */
-    setFilters(quickFilter: string | undefined, columnFilters: Record<string, unknown> | undefined): void;
-    /**
-     * Sets the column that will be used to sort the filtered rows.
-     *
-     * @param columnSort The column that will be used for sorting.
-     */
-    setSort(columnSort: ColumnSort | undefined): void;
-    /**
-     * Deletes a row from the grid when not tracking live updates.
-     *
-     * @param keyOrIndex The row key or row index that should be deleted.
-     */
-    deleteRow(keyOrIndex: string | number): void;
-    /**
-     * Informs the grid that the specified row has been modified.
-     *
-     * @param keyOrIndex The row key or index that was updated.
-     */
-    rowUpdated(keyOrIndex: string | number): void;
-    /**
-     * Informs the grid that the specified rows have been modified.
-     *
-     * @param keysOrIndexes The row keys or indexes that have been updated.
-     */
-    rowsUpdated(keysOrIndexes: readonly string[] | readonly number[]): void;
-}
-export {};
+import { VNode } from "vue";
+import { ColumnDefinition, IGridState, StandardFilterProps, StandardCellProps, IGridCache, IGridRowCache, ColumnSort, StandardColumnProps, StandardHeaderCellProps, EntitySetOptions, StandardSkeletonCellProps } from "@Obsidian/Types/Controls/grid";
+import { GridDefinitionBag } from "@Obsidian/ViewModels/Core/Grid/gridDefinitionBag";
+import { GridEntitySetBag } from "@Obsidian/ViewModels/Core/Grid/gridEntitySetBag";
+import { Guid } from "@Obsidian/Types";
+/**
+ * Defines the grid event names and the parameter they are passed.
+ */
+type GridEvents = {
+    /** Called when the {@link IGridState.rows} value has changed. */
+    rowsChanged: IGridState;
+    /** Called when the {@link IGridState.filteredRows} value has changed. */
+    filteredRowsChanged: IGridState;
+    /** Called when the {@link IGridState.sortedRows} value has changed. */
+    sortedRowsChanged: IGridState;
+    /** Called when the {@link IGridState.visibleColumns} value has changed. */
+    visibleColumnsChanged: IGridState;
+    /** Called when the {@link IGridState.selectedKeys} value has changed. */
+    selectedKeysChanged: IGridState;
+    /** Called when the {@link IGridState.isFiltered} value has changed. */
+    isFilteredChanged: IGridState;
+    /** Called when the {@link IGridState.isSorted} value has changed. */
+    isSortedChanged: IGridState;
+};
+/**
+ * The standard action URLs to use when performing grid actions.
+ */
+export declare const GridActionUrlKey: {
+    /** The URL to use when sending a communication. */
+    readonly Communicate: "communicate";
+    /** The URL to use when merging Person records. */
+    readonly MergePerson: "mergePerson";
+    /** The URL to use when merging Business records. */
+    readonly MergeBusiness: "mergeBusiness";
+    /** The URL to use when performing a bulk update. */
+    readonly BulkUpdate: "bulkUpdate";
+    /** The URL to use when launching a workflow for each record. */
+    readonly LaunchWorkflow: "launchWorkflow";
+    /** The URL to use to start a merge template request. */
+    readonly MergeTemplate: "mergeTemplate";
+};
+/**
+ * Defines the standard properties available on all columns.
+ */
+export declare const standardColumnProps: StandardColumnProps;
+/** The standard properties available on header cells. */
+export declare const standardHeaderCellProps: StandardHeaderCellProps;
+/** The standard properties available on cells. */
+export declare const standardCellProps: StandardCellProps;
+/** The standard properties available on skeleton cells. */
+export declare const standardSkeletonCellProps: StandardSkeletonCellProps;
+/**
+ * The standard properties that are made available to column filter
+ * components.
+ */
+export declare const standardFilterProps: StandardFilterProps;
+/**
+ * The text column filter that performs a comparison of `haystack` and
+ * the value and comparison type inside `needle` to see if it matches.
+ *
+ * @private This is used internally by Rock and should not be used directly.
+ *
+ * @param needle The filter value defined in the UI component.
+ * @param haystack The filter value from the row that must match the `needle`.
+ *
+ * @returns True if `haystack` matches the `needle` and should be included in the results.
+ */
+export declare function textFilterMatches(needle: unknown, haystack: unknown): boolean;
+/**
+ * The boolean column filter that performs a comparison of `haystack` and
+ * the comparison type inside `needle` to see if it matches.
+ *
+ * @private This is used internally by Rock and should not be used directly.
+ *
+ * @param needle The filter value defined in the UI component.
+ * @param haystack The filter value from the row that must match the `needle`.
+ *
+ * @returns True if `haystack` matches the `needle` and should be included in the results.
+ */
+export declare function booleanFilterMatches(needle: unknown, haystack: unknown): boolean;
+/**
+ * The column filter compares the `needle` against the `haystack` to see if
+ * they match. This is a deep equality check so if they are arrays or objects
+ * then all child objects and properties must match exactly.
+ *
+ * @private This is used internally by Rock and should not be used directly.
+ *
+ * @param needle The filter value defined in the UI component.
+ * @param haystack The filter value from the row that must match the `needle`.
+ *
+ * @returns True if `haystack` matches the `needle` and should be included in the results.
+ */
+export declare function pickExistingFilterMatches(needle: unknown, haystack: unknown): boolean;
+/**
+ * The number column filter that performs a comparison of `haystack` and
+ * the value and comparison type inside `needle` to see if it matches.
+ *
+ * @private This is used internally by Rock and should not be used directly.
+ *
+ * @param needle The filter value defined in the UI component.
+ * @param haystack The filter value from the row that must match the `needle`.
+ *
+ * @returns True if `haystack` matches the `needle` and should be included in the results.
+ */
+export declare function numberFilterMatches(needle: unknown, haystack: unknown, column: ColumnDefinition, grid: IGridState): boolean;
+/**
+ * The date column filter that performs a comparison of `haystack` and
+ * the value and comparison type inside `needle` to see if it matches.
+ *
+ * @private This is used internally by Rock and should not be used directly.
+ *
+ * @param needle The filter value defined in the UI component.
+ * @param haystack The filter value from the row that must match the `needle`.
+ *
+ * @returns True if `haystack` matches the `needle` and should be included in the results.
+ */
+export declare function dateFilterMatches(needle: unknown, haystack: unknown): boolean;
+/**
+ * Gets the entity set bag that can be sent to the server to create an entity
+ * set representing the selected items in the grid.
+ *
+ * @param grid The grid state that will be used as the source data.
+ * @param keyFields The fields to use for the entity keys. This is only used when
+ * populating the item entityKey value. It is not used to detect selection state.
+ * If multiple keys are specified then an {@link GridEntitySetItemBag} will be
+ * created for each key.
+ * @param options The options that describe how the entity set should be generated.
+ *
+ * @returns A new instance of {@link GridEntitySetBag} that contains the data.
+ */
+export declare function getEntitySetBag(grid: IGridState, keyFields: string[], options?: EntitySetOptions): Promise<GridEntitySetBag>;
+/**
+ * Calculates the average numerical value across all rows in a grid column.
+ *
+ * @param column The column whose values should be considered for the average.
+ * @param grid The grid that provides all the rows.
+ *
+ * @returns A number that represents the average value or `0` if no rows with numeric values existed.
+ */
+export declare function calculateColumnAverageValue(column: ColumnDefinition, grid: IGridState): number;
+/**
+ * Calculates top Nth numeric row value for a column. If the cell values are
+ * `1, 2, 3, 4, 4, 5, 5` and `rowCount` is 3 then this will return
+ * the value `4`. Which means the final row count displayed will be 4 because
+ * there are 4 rows with values >= 4.
+ *
+ * @param column The column whose values should be considered for the average.
+ * @param grid The grid that provides all the rows.
+ *
+ * @returns A number that represents the average value or `0` if no rows with numeric values existed.
+ */
+export declare function calculateColumnTopNRowValue(rowCount: number, column: ColumnDefinition, grid: IGridState): number;
+/**
+ * Builds the column definitions from the array of virtual nodes found inside
+ * of a component.
+ *
+ * @param columnNodes The virtual nodes that contain the definitions of the columns.
+ *
+ * @returns An array of {@link ColumnDefinition} objects.
+ */
+export declare function getColumnDefinitions(columnNodes: VNode[]): ColumnDefinition[];
+/**
+ * Gets the key to use on the internal cache object to load the cached data
+ * for the specified row.
+ *
+ * @param row The row whose identifier key is needed.
+ *
+ * @returns The identifier key of the row or `undefined` if it could not be determined.
+ */
+export declare function getRowKey(row: Record<string, unknown>, itemIdKey?: string): string | undefined;
+/**
+ * Gets the custom styles to apply to cells of a specific column.
+ *
+ * @param column The column whose cell styles are being requested.
+ *
+ * @returns An object that contains the custom styles to apply to cells of this column.
+ */
+export declare function getColumnStyles(column: ColumnDefinition): Record<string, string>;
+/**
+ * Default implementation used for caching data with Grid.
+ *
+ * @private This class is meant for internal use only.
+ */
+export declare class GridCache implements IGridCache {
+    /** The private cache data storage. */
+    private cacheData;
+    clear(): void;
+    remove(key: string): void;
+    get<T = unknown>(key: string): T | undefined;
+    getOrAdd<T = unknown>(key: string, factory: () => T): T;
+    getOrAdd<T = unknown>(key: string, factory: () => T | undefined): T | undefined;
+    addOrReplace<T = unknown>(key: string, value: T): T;
+}
+/**
+ * Default implementation used for caching grid row data.
+ *
+ * @private This class is meant for internal use only.
+ */
+export declare class GridRowCache implements IGridRowCache {
+    /** The internal cache object used to find the cached row data. */
+    private cache;
+    /** The key name to use on the row objects to find the row identifier. */
+    private rowItemKey?;
+    /**
+     * Creates a new grid row cache object that provides caching for each row.
+     * This is used by other parts of the grid to cache expensive calculations
+     * that pertain to a single row.
+     *
+     * @param itemIdKey The key name to use on the row objects to find the row identifier.
+     */
+    constructor(itemIdKey: string | undefined);
+    /**
+     * Gets the key to use on the internal cache object to load the cached data
+     * for the specified row.
+     *
+     * @param row The row whose identifier key is needed.
+     *
+     * @returns The identifier key of the row or `undefined` if it could not be determined.
+     */
+    private getRowKey;
+    /**
+     * Sets the key that will be used when accessing a row to determine its
+     * unique identifier in the grid. This will also clear all cached data.
+     *
+     * @param itemKey The key name to use on the row objects to find the row identifier.
+     */
+    setRowItemKey(itemKey: string | undefined): void;
+    /**
+     * Removes the cached values for a row.
+     *
+     * @param rowKey The key that identifies the row.
+     * @param key The key inside the row cache to be removed or `undefined` to remove all cached data for the row.
+     */
+    removeByRowKey(rowKey: string, key: string | undefined): void;
+    clear(): void;
+    remove(row: Record<string, unknown>): void;
+    remove(row: Record<string, unknown>, key: string): void;
+    get<T = unknown>(row: Record<string, unknown>, key: string): T | undefined;
+    getOrAdd<T = unknown>(row: Record<string, unknown>, key: string, factory: () => T): T;
+    getOrAdd<T = unknown>(row: Record<string, unknown>, key: string, factory: () => T | undefined): T | undefined;
+    addOrReplace<T = unknown>(row: Record<string, unknown>, key: string, value: T): T;
+}
+/**
+ * Default implementation of the grid state for internal use.
+ *
+ * @private The is an internal class that should not be used by plugins.
+ */
+export declare class GridState implements IGridState {
+    private internalColumns;
+    private internalRows;
+    private internalFilteredRows;
+    private internalSortedRows;
+    private internalVisibleColumns;
+    private internalSelectedKeys;
+    private internalIsFiltered;
+    private internalIsSorted;
+    /** The definition data we were created with. */
+    private gridDefinition?;
+    /** This tracks the state of each row when operating in reactive mode. */
+    private rowReactiveTracker;
+    /** The handle that can be used to stop watching row changes. */
+    private internalRowsWatcher?;
+    /** Determines if we are monitoring for changes to the row data. */
+    private liveUpdates;
+    /** The key to get the unique identifier of each row. */
+    private itemKey?;
+    /** The current quick filter value that will be used to filter the rows. */
+    private quickFilter;
+    /**
+     * The currently applied per-column filters that will be used to filter
+     * the rows.
+     */
+    private columnFilters;
+    /** The current column being used to sort the rows. */
+    private columnSort?;
+    /** The event emitter for all the grid events. */
+    private readonly emitter;
+    /** A background worker that will populate all the row cache data. */
+    private populateRowCacheWorker;
+    /**
+     * Creates a new instance of the GridState for use with the Grid component.
+     *
+     * @param columns The columns to initialize the Grid with.
+     * @param gridDefinition The definition data that defines some of the structure of the grid.
+     * @param liveUpdates If true then the grid will monitor for live updates to rows.
+     * @param itemTerm The word or phrase that describes each row.
+     * @param entityTypeGuid The unique identifier of the entity type this grid represents, or `undefined`.
+     */
+    constructor(columns: ColumnDefinition[], gridDefinition: GridDefinitionBag | undefined, liveUpdates: boolean, itemTerm: string, entityTypeGuid: Guid | undefined);
+    /**
+     * Dispose of all resources this grid state has. This includes any watchers
+     * and other things that might need to be manually destroyed to free up
+     * memory. A common pattern would be to call this in the onUmounted() callback.
+     */
+    dispose(): void;
+    get rows(): ReadonlyArray<Record<string, unknown>>;
+    get filteredRows(): ReadonlyArray<Record<string, unknown>>;
+    private set filteredRows(value);
+    get sortedRows(): ReadonlyArray<Record<string, unknown>>;
+    private set sortedRows(value);
+    get columns(): ColumnDefinition[];
+    get visibleColumns(): ReadonlyArray<ColumnDefinition>;
+    private set visibleColumns(value);
+    get selectedKeys(): string[];
+    set selectedKeys(value: string[]);
+    get isFiltered(): boolean;
+    private set isFiltered(value);
+    get isSorted(): boolean;
+    private set isSorted(value);
+    readonly cache: IGridCache;
+    readonly rowCache: GridRowCache;
+    readonly itemTerm: string;
+    readonly entityTypeGuid?: Guid | undefined;
+    getColumnCacheKey(column: ColumnDefinition, component: string, key: string): string;
+    getRowKey(row: Record<string, unknown>): string | undefined;
+    getSortedRows(): Record<string, unknown>[];
+    on(event: keyof GridEvents, callback: (grid: IGridState) => void): void;
+    off(event: keyof GridEvents, callback: (grid: IGridState) => void): void;
+    /**
+     * Begins tracking all rows in the grid so that we can monitor for
+     * changes and update the UI accordingly.
+     */
+    private initializeReactiveTracker;
+    /**
+     * Detects any changes to the row data from the last time we were called.
+     * Must be called after {@link initializeReactiveTracker}.
+     */
+    private detectRowChanges;
+    /**
+     * Performs filtering of the {@link rows} and determines which rows
+     * match the filters.
+     */
+    private updateFilteredRows;
+    /**
+     * Sorts the given set of rows.
+     *
+     * @param rows The rows that should be sorted according to the current sorting definition.
+     *
+     * @returns A new array of rows that is properly sorted.
+     */
+    private sortRows;
+    /**
+     * Takes the {@link filteredRows} and sorts them according to the information
+     * tracked by the Grid and updates the {@link sortedRows} property.
+     */
+    private updateSortedRows;
+    /**
+     * Gets the row key and row index of the specified key or index.
+     *
+     * @param keyOrIndex The row key or index.
+     *
+     * @returns An object that contains both the key and index or `undefined` if it was not found.
+     */
+    private getRowKeyAndIndex;
+    /**
+     * Sets the item key used to uniquely identify rows.
+     *
+     * @param value The field name that contains the item key.
+     */
+    setItemKey(value: string | undefined): void;
+    /**
+     * Sets the columns that can be used on the grid.
+     *
+     * @param columns The new columns that should be available on the grid.
+     */
+    setColumns(columns: ColumnDefinition[]): void;
+    /**
+     * Sets the rows to be used by the Grid. This will replace all existing
+     * row data.
+     *
+     * @param rows The array of row data to use for the Grid.
+     */
+    setDataRows(rows: Record<string, unknown>[]): void;
+    /**
+     * Sets the filters to be used to filter the rows down to a limited set.
+     *
+     * @param quickFilter The value to use for quick filtering.
+     * @param columnFilters The column filters to apply to the data.
+     */
+    setFilters(quickFilter: string | undefined, columnFilters: Record<string, unknown> | undefined): void;
+    /**
+     * Sets the column that will be used to sort the filtered rows.
+     *
+     * @param columnSort The column that will be used for sorting.
+     */
+    setSort(columnSort: ColumnSort | undefined): void;
+    /**
+     * Deletes a row from the grid when not tracking live updates.
+     *
+     * @param keyOrIndex The row key or row index that should be deleted.
+     */
+    deleteRow(keyOrIndex: string | number): void;
+    /**
+     * Informs the grid that the specified row has been modified.
+     *
+     * @param keyOrIndex The row key or index that was updated.
+     */
+    rowUpdated(keyOrIndex: string | number): void;
+    /**
+     * Informs the grid that the specified rows have been modified.
+     *
+     * @param keysOrIndexes The row keys or indexes that have been updated.
+     */
+    rowsUpdated(keysOrIndexes: readonly string[] | readonly number[]): void;
+}
+export {};