@skyux/ag-grid 14.11.0 → 14.13.0

package/types/skyux-ag-grid.d.ts

@@ -1,15 +1,15 @@
 import * as i0 from '@angular/core';
-import { AfterContentInit, AfterViewInit, ElementRef, OnDestroy, TemplateRef, Type, Signal, WritableSignal } from '@angular/core';
+import { AfterContentInit, AfterViewInit, ElementRef, OnDestroy, TemplateRef, Signal, Type, WritableSignal } from '@angular/core';
 import * as i1$1 from 'ag-grid-angular';
 import { AgGridAngular, ICellEditorAngularComp, ICellRendererAngularComp, IDateAngularComp, IHeaderGroupAngularComp, IHeaderAngularComp } from 'ag-grid-angular';
 import * as i2 from '@angular/common';
 import * as ag_grid_community from 'ag-grid-community';
-import { GridOptions, ICellEditorParams, ColumnGroup, IHeaderGroupParams, Column, IHeaderParams, GridApi, ICellRendererParams, IRowNode, IDateParams } from 'ag-grid-community';
+import { GridOptions, ColDef, ICellEditorParams, ICellRendererParams, ColumnGroup, IHeaderGroupParams, Column, IHeaderParams, GridApi, IRowNode, IDateParams } from 'ag-grid-community';
 import * as i1 from '@skyux/i18n';
 import { SkyAutocompleteSelectionChange, SkyLookupAddClickEventArgs, SkyAutocompleteSearchFunction, SkyAutocompleteSearchAsyncArgs, SkyAutocompleteSearchFunctionFilter, SkyLookupSelectModeType, SkyLookupShowMoreConfig } from '@skyux/lookup';
+import { SkyNumericOptions } from '@skyux/core';
 import { Observable, Subject, Subscription, BehaviorSubject } from 'rxjs';
 import { UntypedFormGroup, UntypedFormControl, FormControl } from '@angular/forms';
-import { SkyNumericOptions } from '@skyux/core';
 import { SkyPopoverMessage } from '@skyux/popovers';
 
 declare class SkyAgGridWrapperComponent implements AfterContentInit, AfterViewInit {
@@ -151,17 +151,29 @@ interface SkyGetGridOptionsArgs<T = any> {
 
 /**
  * `SkyAgGridService` provides methods to get AG Grid `gridOptions` to ensure grids match SKY UX functionality. The `gridOptions` can be overridden, and include registered SKY UX column types.
+ *
+ * Locale text is resolved once, when the grid options are created. [AG Grid does not re-read
+ * locale text after a grid is created](https://www.ag-grid.com/angular-data-grid/localisation/),
+ * so an application that changes locale at runtime must destroy and recreate the grid. Setting
+ * `gridOptions.getLocaleText` replaces SKY UX locale text entirely — use `gridOptions.localeText`
+ * to override individual strings instead.
  */
 declare class SkyAgGridService {
     #private;
     /**
      * Returns [AG Grid `gridOptions`](https://www.ag-grid.com/angular-data-grid/grid-options/) with default SKY UX options, styling, and cell renderers registered for read-only grids.
+     *
+     * Locale text is resolved once, at call time. If the application's locale changes at
+     * runtime, destroy and recreate the grid to pick up the new locale text.
      * @param args
      * @returns
      */
     getGridOptions<T = any>(args: SkyGetGridOptionsArgs<T>): GridOptions<T>;
     /**
      * Returns [AG Grid `gridOptions`](https://www.ag-grid.com/angular-data-grid/grid-options/) with default SKY UX options, styling, and cell editors registered for editable grids.
+     *
+     * Locale text is resolved once, at call time. If the application's locale changes at
+     * runtime, destroy and recreate the grid to pick up the new locale text.
      * @param args
      * @returns
      */
@@ -234,29 +246,124 @@ interface SkyAutocompleteProperties extends SkyAgGridAutocompleteProperties {
 }
 
 /**
- * @internal
+ * These column types can be used by setting the AG Grid [column definition `type`](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing) to one of the following values.
+ * Any [SKY UX component](https://developer.blackbaud.com/skyux/components) can be made into a [cell editor](https://www.ag-grid.com/angular-data-grid/cell-editors/) or [cell renderer](https://www.ag-grid.com/angular-data-grid/component-cell-renderer/) component. If you would like to use a component that does not have a column definition yet, please consider [contributing it](https://github.com/blackbaud/skyux/blob/main/CONTRIBUTING.md) to the SKY UX data entry grid module.
+ * Use `defineSkyAgGridColDef()` to validate a column definition's `cellEditorParams` and `cellRendererParams` against its cell type.
  */
-declare enum SkyCellClass {
-    Autocomplete = "sky-ag-grid-cell-autocomplete",
-    Currency = "sky-ag-grid-cell-currency",
-    Date = "sky-ag-grid-cell-date",
-    Editable = "sky-ag-grid-cell-editable",
-    Invalid = "sky-ag-grid-cell-invalid",
-    Lookup = "sky-ag-grid-cell-lookup",
-    Number = "sky-ag-grid-cell-number",
-    RightAligned = "sky-ag-grid-cell-right-aligned",
-    RowSelector = "sky-ag-grid-cell-row-selector",
-    Template = "sky-ag-grid-cell-template",
-    Text = "sky-ag-grid-cell-text",
-    Uneditable = "sky-ag-grid-cell-uneditable",
-    Validator = "sky-ag-grid-cell-validator"
+declare enum SkyCellType {
+    /**
+     * **Edit mode**
+     *
+     * Cells in the column will be edited as [SKY UX autocomplete components](https://developer.blackbaud.com/skyux/components/autocomplete). You can set any of the autocomplete component's properties by passing `SkyCellEditorAutocompleteParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/angular-data-grid/cell-editing/) based on other cell values. See the demo for an example. Text can be entered and a value selected from the provided list.
+     *
+     * **Read-only mode**
+     *
+     * Cells the column will display the currently selected value's name property by default. If the autocomplete needs to show a different property or needs to be formatted in any way, you can [define a `valueFormatter`](https://www.ag-grid.com/angular-data-grid/value-formatters/) on the column definition.
+     */
+    Autocomplete = "skyCellAutocomplete",
+    /**
+     * **Edit mode**
+     *
+     * Cells in the column will be edited as a currency amount.
+     *
+     * **Read-only mode**
+     *
+     * Formats the display as currency using [SKY UX numeric components](https://developer.blackbaud.com/skyux/components/numeric).
+     */
+    Currency = "skyCellCurrency",
+    /**
+     * **Edit and read-only modes**
+     *
+     * Combines SkyCellType.Currency and SkyCellType.Validator, where the value is displayed as a currency and passed to a validator function.
+     */
+    CurrencyValidator = "skyCellCurrencyValidator",
+    /**
+     * **Edit mode**
+     *
+     * Cells in the column will be edited as [SKY UX datepicker components](https://developer.blackbaud.com/skyux/components/datepicker). You can set any of the datepicker component's properties by passing `SkyCellEditorDatepickerParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/angular-data-grid/cell-editing/) based on other cell values. See the demo for an example. Date values can be entered.
+     *
+     * **Read-only mode**
+     *
+     * Cells in the column will display the currently selected date formatted as `MM-DD-YYYY`, or the date format of the locale passed to `getGridOptions()`. If you would like to overwrite this format, you can [define a `valueFormatter`](https://www.ag-grid.com/angular-data-grid/value-formatters/) on the column definition. See the demo for an example.
+     */
+    Date = "skyCellDate",
+    /**
+     * **Edit mode**
+     *
+     * Cells in the column will be edited as [SKY UX lookup components](https://developer.blackbaud.com/skyux-v5/components/lookup). You can set any of the lookup component's properties by passing `SkyCellEditorLookupParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/angular-data-grid/cell-editing/) based on other cell values. See the demo for an example. Text can be entered and a value selected from the provided list.
+     *
+     * **Read-only mode**
+     *
+     * Cells in the column will display, by default, either: the name(s) of the selected value(s) if there are less than 6, or a summary count of the values if there are more than 5. If the lookup needs to show a different property or needs to be formatted in any way, you can [define a `valueFormatter`](https://www.ag-grid.com/angular-data-grid/value-formatters/) on the column definition.
+     */
+    Lookup = "skyCellLookup",
+    /**
+     * **Edit mode**
+     *
+     * Cells in the column will be edited as HTML number `inputs`. Only numbers can be entered.
+     *
+     * **Read-only mode**
+     *
+     * Cells in the column will render as the number value.
+     */
+    Number = "skyCellNumber",
+    /**
+     * **Edit and read-only modes**
+     *
+     * Combines SkyCellType.Number and SkyCellType.Validator, where the value is displayed as a number and passed to a validator function.
+     */
+    NumberValidator = "skyCellNumberValidator",
+    /**
+     * **Edit and read-only modes**
+     *
+     * The header and cells in the column will render right aligned.
+     */
+    RightAligned = "skyCellRightAligned",
+    /**
+     * **Edit and read-only modes**
+     *
+     * Cells in the column will render as [SKY UX checkbox components](https://developer.blackbaud.com/skyux/components/checkbox). It allows the user to select multiple rows, and adds a highlight to selected rows. The [Ag Grid `rowNode`](https://www.ag-grid.com/angular-data-grid/row-object/) will be updated to reflect the selected state.
+     */
+    RowSelector = "skyCellRowSelector",
+    /**
+     * **Read-only mode**
+     *
+     * Cells in the column will render in a `TemplateRef` passed in the column definition's `cellRendererParams.template` property, with `value` and `row` context. See the demo for an example.
+     */
+    Template = "skyCellTemplate",
+    /**
+     * **Edit mode**
+     *
+     * Cells in the column will be edited as HTML text `inputs`. Any characters can be entered.
+     *
+     * **Read-only mode**
+     *
+     * Cells in the column will render as their string value.
+     */
+    Text = "skyCellText",
+    /**
+     * **Edit and read-only modes**
+     *
+     * Cells in the column will be passed to a validator function that flags erroneous entries. You can set the validator function and message by passing a `SkyAgGridValidatorProperties` object as `skyComponentProperties` to [column definition's `cellRendererParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing), like `skyComponentProperties.validator` and `skyComponentProperties.validatorMessage`. SkyCellType.Validator can be combined with other cell types, such as SkyCellType.Autocomplete or SkyCellType.Date, by using the array syntax for the [column definition's `type` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing).
+     */
+    Validator = "skyCellValidator"
 }
 
-interface SkyCellEditorAutocompleteParams extends ICellEditorParams {
+interface SkyAgGridCurrencyProperties {
     /**
-     * The parameters provided to the autocomplete component.
+     * The currency symbol to display in the cell.
+     * @default "$"
      */
-    skyComponentProperties?: SkyAutocompleteProperties | SkyAgGridAutocompleteProperties;
+    currencySymbol?: string;
+    /**
+     * The number of decimal places to display on the currency.
+     * @default 2
+     */
+    decimalPlaces?: number | string;
+    /**
+     * Adds the specified brackets around negative values when unfocused.
+     */
+    negativeBracketsTypeOnBlur?: '(,)' | '[,]' | '<,>' | '{,}' | '〈,〉' | '｢,｣' | '⸤,⸥' | '⟦,⟧' | '‹,›' | '«,»' | null;
 }
 
 interface SkyAgGridDatepickerProperties {
@@ -295,25 +402,6 @@ interface SkyAgGridDatepickerProperties {
 interface SkyDatepickerProperties extends SkyAgGridDatepickerProperties {
 }
 
-interface SkyCellEditorDatepickerParams extends ICellEditorParams {
-    /**
-     * The parameters provided to the datepicker component.
-     */
-    skyComponentProperties?: SkyDatepickerProperties | SkyAgGridDatepickerProperties;
-}
-
-/** The initial action that a cell editor should take when initialized. */
-declare enum SkyAgGridCellEditorInitialAction {
-    /** The cell should be cleared. */
-    Delete = 0,
-    /** The cell value should be highlighted. */
-    Highlighted = 1,
-    /** The cell value should be replaced with the initializing value. */
-    Replace = 2,
-    /** The cell should not be modified and the cursor is placed at the end of the value. */
-    Untouched = 3
-}
-
 interface SkyAgGridLookupProperties {
     /**
      * Fires when users select the button to add options to the list. When the button opens a modal, include
@@ -422,145 +510,292 @@ interface SkyAgGridLookupProperties {
     wrapperClass?: string;
 }
 
-interface SkyCellEditorLookupParams extends ICellEditorParams {
+interface SkyAgGridNumberProperties {
     /**
-     * The parameters provided to the lookup component.
+     * The maximum number that users can enter in the cell.
      */
-    skyComponentProperties?: SkyAgGridLookupProperties;
-}
-
-declare class SkyAgGridCellEditorUtils {
+    max?: number;
     /**
-     * Gets the initial action that a cell editor should take when initialized.
-     * @param params The editor's initializing parameters.
+     * The minimum number that users can enter in the cell.
      */
-    static getEditorInitialAction(params: ICellEditorParams | undefined): SkyAgGridCellEditorInitialAction;
+    min?: number;
+}
+
+interface SkyAgGridTextProperties {
     /**
-     * Returns the difference between the minuend and subtrahend. If the minuend is not defined, returns 0.
-     * @param minuend The number from which another number is subtracted.
-     * @param subtrahend The number that is subtracted from the minuend.
+     * The maximum length of the text that users can enter into the cell.
      */
-    static subtractOrZero(minuend: number | null | undefined, subtrahend: number): number;
+    maxlength?: number;
 }
 
 /**
- * These column types can be used by setting the AG Grid [column definition `type`](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing) to one of the following values.
- * Any [SKY UX component](https://developer.blackbaud.com/skyux/components) can be made into a [cell editor](https://www.ag-grid.com/angular-data-grid/cell-editors/) or [cell renderer](https://www.ag-grid.com/angular-data-grid/component-cell-renderer/) component. If you would like to use a component that does not have a column definition yet, please consider [contributing it](https://github.com/blackbaud/skyux/blob/main/CONTRIBUTING.md) to the SKY UX data entry grid module.
+ * The parameters that each SKY UX cell type accepts in the
+ * [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing-cellEditorParams).
+ * Cell types that map to `never` do not accept editor parameters.
+ * Use `defineSkyAgGridColDef()` to validate `cellEditorParams` against the column's
+ * cell type.
  */
-declare enum SkyCellType {
-    /**
-     * **Edit mode**
-     *
-     * Cells in the column will be edited as [SKY UX autocomplete components](https://developer.blackbaud.com/skyux/components/autocomplete). You can set any of the autocomplete component's properties by passing `SkyCellEditorAutocompleteParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/angular-data-grid/cell-editing/) based on other cell values. See the demo for an example. Text can be entered and a value selected from the provided list.
-     *
-     * **Read-only mode**
-     *
-     * Cells the column will display the currently selected value's name property by default. If the autocomplete needs to show a different property or needs to be formatted in any way, you can [define a `valueFormatter`](https://www.ag-grid.com/angular-data-grid/value-formatters/) on the column definition.
-     */
-    Autocomplete = "skyCellAutocomplete",
-    /**
-     * **Edit mode**
-     *
-     * Cells in the column will be edited as a currency amount.
-     *
-     * **Read-only mode**
-     *
-     * Formats the display as currency using [SKY UX numeric components](https://developer.blackbaud.com/skyux/components/numeric).
-     */
-    Currency = "skyCellCurrency",
-    /**
-     * **Edit and read-only modes**
-     *
-     * Combines SkyCellType.Currency and SkyCellType.Validator, where the value is displayed as a currency and passed to a validator function.
-     */
-    CurrencyValidator = "skyCellCurrencyValidator",
-    /**
-     * **Edit mode**
-     *
-     * Cells in the column will be edited as [SKY UX datepicker components](https://developer.blackbaud.com/skyux/components/datepicker). You can set any of the datepicker component's properties by passing `SkyCellEditorDatepickerParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/angular-data-grid/cell-editing/) based on other cell values. See the demo for an example. Date values can be entered.
-     *
-     * **Read-only mode**
-     *
-     * Cells in the column will display the currently selected date formatted as `MM-DD-YYYY`, or the date format of the locale passed to `getGridOptions()`. If you would like to overwrite this format, you can [define a `valueFormatter`](https://www.ag-grid.com/angular-data-grid/value-formatters/) on the column definition. See the demo for an example.
-     */
-    Date = "skyCellDate",
+interface SkyCellEditorParamsByType {
+    [SkyCellType.Autocomplete]: {
+        /**
+         * The parameters provided to the autocomplete component.
+         */
+        skyComponentProperties?: SkyAutocompleteProperties | SkyAgGridAutocompleteProperties;
+    };
+    [SkyCellType.Currency]: {
+        /**
+         * The parameters provided to the currency cell editor.
+         */
+        skyComponentProperties?: SkyAgGridCurrencyProperties;
+    };
+    [SkyCellType.CurrencyValidator]: {
+        /**
+         * The parameters provided to the currency cell editor.
+         */
+        skyComponentProperties?: SkyAgGridCurrencyProperties;
+    };
+    [SkyCellType.Date]: {
+        /**
+         * The parameters provided to the datepicker component.
+         */
+        skyComponentProperties?: SkyDatepickerProperties | SkyAgGridDatepickerProperties;
+    };
+    [SkyCellType.Lookup]: {
+        /**
+         * The parameters provided to the lookup component.
+         */
+        skyComponentProperties?: SkyAgGridLookupProperties;
+    };
+    [SkyCellType.Number]: {
+        /**
+         * The parameters provided to the number cell editor.
+         */
+        skyComponentProperties?: SkyAgGridNumberProperties;
+    };
+    [SkyCellType.NumberValidator]: {
+        /**
+         * The parameters provided to the number cell editor.
+         */
+        skyComponentProperties?: SkyAgGridNumberProperties;
+    };
+    [SkyCellType.RightAligned]: never;
+    [SkyCellType.RowSelector]: never;
+    [SkyCellType.Template]: never;
+    [SkyCellType.Text]: {
+        /**
+         * The parameters provided to the text cell editor.
+         */
+        skyComponentProperties?: SkyAgGridTextProperties;
+    };
+    [SkyCellType.Validator]: never;
+}
+
+interface SkyAgGridValidatorProperties<TValue = unknown, TData = unknown> {
     /**
-     * **Edit mode**
-     *
-     * Cells in the column will be edited as [SKY UX lookup components](https://developer.blackbaud.com/skyux-v5/components/lookup). You can set any of the lookup component's properties by passing `SkyCellEditorLookupParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/angular-data-grid/cell-editing/) based on other cell values. See the demo for an example. Text can be entered and a value selected from the provided list.
-     *
-     * **Read-only mode**
-     *
-     * Cells the column will display, by default, either: the name(s) of the selected value(s) if there are less than 6, or a summary count of the values if there are more than 5. If the lookup needs to show a different property or needs to be formatted in any way, you can [define a `valueFormatter`](https://www.ag-grid.com/angular-data-grid/value-formatters/) on the column definition.
+     * An optional function that returns an observable that emits a string. Can be used with resources to localize the
+     * value displayed in the cell.
      */
-    Lookup = "skyCellLookup",
+    valueResourceObservable?: (value: TValue, data?: TData, rowIndex?: number | null) => Observable<string>;
     /**
-     * **Edit mode**
-     *
-     * Cells in the column will be edited as HTML number `inputs`. Only numbers can be entered.
-     *
-     * **Read-only mode**
-     *
-     * Cells in the column will render as the number value.
+     * A function that returns true if the value is valid, or false if it is not. Invalid values
+     * will be highlighted and display a validation message.
      */
-    Number = "skyCellNumber",
+    validator?: (value: TValue, data?: TData, rowIndex?: number | null) => boolean;
     /**
-     * **Edit and read-only modes**
-     *
-     * Combines SkyCellType.Number and SkyCellType.Validator, where the value is displayed as a number and passed to a validator function.
+     * A string signal function, a string, or a function that returns a string. The message to display when the value is
+     * invalid.
      */
-    NumberValidator = "skyCellNumberValidator",
+    validatorMessage?: Signal<string> | string | ((value: TValue, data?: TData, rowIndex?: number | null) => string);
+}
+
+/**
+ * The parameters that each SKY UX cell type accepts in the
+ * [column definition's `cellRendererParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-styling-cellRendererParams).
+ * Cell types that map to `never` do not accept renderer parameters.
+ * Use `defineSkyAgGridColDef()` to validate `cellRendererParams` against the column's
+ * cell type.
+ */
+interface SkyCellRendererParamsByType<TData = unknown, TValue = unknown> {
+    [SkyCellType.Autocomplete]: never;
+    [SkyCellType.Currency]: {
+        /**
+         * Options to pass to the `SkyNumericPipe` for formatting the cell value,
+         * and validator properties to flag erroneous entries. `format` is always
+         * set to `'currency'`. If not specified, `minDigits` defaults to `2` and
+         * `truncate` defaults to `false`.
+         */
+        skyComponentProperties?: SkyNumericOptions & SkyAgGridValidatorProperties<TValue, TData>;
+    };
+    [SkyCellType.CurrencyValidator]: {
+        /**
+         * Options to pass to the `SkyNumericPipe` for formatting the cell value,
+         * and validator properties to flag erroneous entries. `format` is always
+         * set to `'currency'`. If not specified, `minDigits` defaults to `2` and
+         * `truncate` defaults to `false`.
+         */
+        skyComponentProperties?: SkyNumericOptions & SkyAgGridValidatorProperties<TValue, TData>;
+    };
+    [SkyCellType.Date]: never;
+    [SkyCellType.Lookup]: {
+        /**
+         * The parameters provided to the lookup component.
+         */
+        skyComponentProperties?: SkyAgGridLookupProperties;
+    };
+    [SkyCellType.Number]: {
+        /**
+         * The validator properties used to validate the cell value and display a
+         * validation message.
+         */
+        skyComponentProperties?: SkyAgGridValidatorProperties<TValue, TData>;
+    };
+    [SkyCellType.NumberValidator]: {
+        /**
+         * The validator properties used to validate the cell value and display a
+         * validation message.
+         */
+        skyComponentProperties?: SkyAgGridValidatorProperties<TValue, TData>;
+    };
+    [SkyCellType.RightAligned]: never;
+    [SkyCellType.RowSelector]: {
+        /**
+         * The `aria-label` for the row selector checkbox, or a function that
+         * returns it from the row's data. If not specified, the label defaults to
+         * a localized string that includes the row number.
+         */
+        label?: string | ((data: TData) => string | Observable<string>);
+    };
+    [SkyCellType.Template]: {
+        /**
+         * The template to render in the cell. The template's context is a
+         * `SkyCellRendererTemplateContext` with `value` and `row` properties.
+         */
+        template: TemplateRef<unknown> | Signal<TemplateRef<unknown> | undefined>;
+    };
+    [SkyCellType.Text]: {
+        /**
+         * The validator properties used to validate the cell value and display a
+         * validation message.
+         */
+        skyComponentProperties?: SkyAgGridValidatorProperties<TValue, TData>;
+    };
+    [SkyCellType.Validator]: {
+        /**
+         * The validator properties used to validate the cell value and display a
+         * validation message.
+         */
+        skyComponentProperties?: SkyAgGridValidatorProperties<TValue, TData>;
+    };
+}
+
+type UnionToIntersection<U> = [U] extends [never] ? never : (U extends unknown ? (u: U) => void : never) extends (i: infer I) => void ? I : never;
+/**
+ * A column definition that validates `cellEditorParams` and
+ * `cellRendererParams` against the SKY UX cell types in the column's `type`
+ * property. Combine cell types by passing a union of `SkyCellType` values,
+ * like `SkyAgGridColDef<SkyCellType.Number | SkyCellType.Validator>`.
+ */
+type SkyAgGridColDef<T extends SkyCellType, TData = any, TValue = any> = Omit<ColDef<TData, TValue>, 'type' | 'cellEditorParams' | 'cellRendererParams'> & {
+    type: T | T[];
+    cellEditorParams?: UnionToIntersection<SkyCellEditorParamsByType[T]> | ((params: ICellEditorParams<TData, TValue>) => UnionToIntersection<SkyCellEditorParamsByType[T]>);
+    cellRendererParams?: UnionToIntersection<SkyCellRendererParamsByType<TData, TValue>[T]> | ((params: ICellRendererParams<TData, TValue>) => UnionToIntersection<SkyCellRendererParamsByType<TData, TValue>[T]>);
+};
+/**
+ * Builds a column definition whose `cellEditorParams` and `cellRendererParams`
+ * are validated against the SKY UX cell types in the `type` property. The cell
+ * type is inferred, so no type arguments are needed:
+ * ```
+ * defineSkyAgGridColDef({
+ *   field: 'endDate',
+ *   type: [SkyCellType.Date, SkyCellType.Validator],
+ *   cellRendererParams: { skyComponentProperties: { validator: ... } },
+ * })
+ * ```
+ */
+declare function defineSkyAgGridColDef<T extends SkyCellType, F extends string = never, C extends SkyAgGridColDef<T> = SkyAgGridColDef<T>>(colDef: C & SkyAgGridColDef<T> & {
+    field?: F;
+} & Record<Exclude<keyof C, keyof SkyAgGridColDef<T>>, never>): C & {
+    field?: F;
+};
+
+/**
+ * @internal
+ */
+declare enum SkyCellClass {
+    Autocomplete = "sky-ag-grid-cell-autocomplete",
+    Currency = "sky-ag-grid-cell-currency",
+    Date = "sky-ag-grid-cell-date",
+    Editable = "sky-ag-grid-cell-editable",
+    Invalid = "sky-ag-grid-cell-invalid",
+    Lookup = "sky-ag-grid-cell-lookup",
+    Number = "sky-ag-grid-cell-number",
+    RightAligned = "sky-ag-grid-cell-right-aligned",
+    RowSelector = "sky-ag-grid-cell-row-selector",
+    Template = "sky-ag-grid-cell-template",
+    Text = "sky-ag-grid-cell-text",
+    Uneditable = "sky-ag-grid-cell-uneditable",
+    Validator = "sky-ag-grid-cell-validator"
+}
+
+interface SkyCellEditorAutocompleteParams extends ICellEditorParams {
     /**
-     * **Edit and read-only modes**
-     *
-     * The header and cells in the column will render right aligned.
+     * The parameters provided to the autocomplete component.
      */
-    RightAligned = "skyCellRightAligned",
+    skyComponentProperties?: SkyAutocompleteProperties | SkyAgGridAutocompleteProperties;
+}
+
+interface SkyCellEditorDatepickerParams extends ICellEditorParams {
     /**
-     * **Edit and read-only modes**
-     *
-     * Cells in the column will render as [SKY UX checkbox components](https://developer.blackbaud.com/skyux/components/checkbox). It allows the user to select multiple rows, and adds a highlight to selected rows. The [Ag Grid `rowNode`](https://www.ag-grid.com/angular-data-grid/row-object/) will be updated to reflect the selected state.
+     * The parameters provided to the datepicker component.
      */
-    RowSelector = "skyCellRowSelector",
+    skyComponentProperties?: SkyDatepickerProperties | SkyAgGridDatepickerProperties;
+}
+
+/** The initial action that a cell editor should take when initialized. */
+declare enum SkyAgGridCellEditorInitialAction {
+    /** The cell should be cleared. */
+    Delete = 0,
+    /** The cell value should be highlighted. */
+    Highlighted = 1,
+    /** The cell value should be replaced with the initializing value. */
+    Replace = 2,
+    /** The cell should not be modified and the cursor is placed at the end of the value. */
+    Untouched = 3
+}
+
+interface SkyCellEditorLookupParams extends ICellEditorParams {
     /**
-     * **Read-only mode**
-     *
-     * Cells in the column will render in a `TemplateRef` passed in the column definition's `cellRendererParams.template` property, with `value` and `row` context. See the demo for an example.
+     * The parameters provided to the lookup component.
      */
-    Template = "skyCellTemplate",
+    skyComponentProperties?: SkyAgGridLookupProperties;
+}
+
+declare class SkyAgGridCellEditorUtils {
     /**
-     * **Edit mode**
-     *
-     * Cells in the column will be edited as HTML text `inputs`. Any characters can be entered.
-     *
-     * **Read-only mode**
-     *
-     * Cells in the column will render as their string value.
+     * Gets the initial action that a cell editor should take when initialized.
+     * @param params The editor's initializing parameters.
      */
-    Text = "skyCellText",
+    static getEditorInitialAction(params: ICellEditorParams | undefined): SkyAgGridCellEditorInitialAction;
     /**
-     * **Edit and read-only modes**
-     *
-     * Cells in the column will be passed to a validator function that flags erroneous entries. You can set the validator function and message by passing a `SkyAgGridValidatorProperties` object as `skyComponentProperties` to [column definition's `cellRendererParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing), like `skyComponentProperties.validator` and `skyComponentProperties.validatorMessage`. SkyCellType.Validator can be combined with other cell types, such as SkyCellType.Autocomplete or SkyCellType.Date, by using the array syntax for the [column definition's `type` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing).
+     * Returns the difference between the minuend and subtrahend. If the minuend is not defined, returns 0.
+     * @param minuend The number from which another number is subtracted.
+     * @param subtrahend The number that is subtracted from the minuend.
      */
-    Validator = "skyCellValidator"
+    static subtractOrZero(minuend: number | null | undefined, subtrahend: number): number;
 }
 
-interface SkyAgGridCurrencyProperties {
+/**
+ * The context provided to the template of a template cell renderer.
+ */
+interface SkyCellRendererTemplateContext {
     /**
-     * The currency symbol to display in the cell.
-     * @default "$"
+     * The cell's value.
      */
-    currencySymbol?: string;
+    value: unknown;
     /**
-     * The number of decimal places to display on the currency.
-     * @default 2
+     * The row's data.
      */
-    decimalPlaces?: number | string;
-    /**
-     * Adds the specified brackets around negative values when unfocused.
-     */
-    negativeBracketsTypeOnBlur?: '(,)' | '[,]' | '<,>' | '{,}' | '〈,〉' | '｢,｣' | '⸤,⸥' | '⟦,⟧' | '‹,›' | '«,»' | null;
+    row: object | undefined;
 }
 
 /**
@@ -655,42 +890,6 @@ interface SkyAgGridHeaderParams extends IHeaderParams {
     inlineHelpComponent?: Type<unknown>;
 }
 
-interface SkyAgGridNumberProperties {
-    /**
-     * The maximum number that users can enter in the cell.
-     */
-    max?: number;
-    /**
-     * The minimum number that users can enter in the cell.
-     */
-    min?: number;
-}
-
-interface SkyAgGridTextProperties {
-    /**
-     * The maximum length of the text that users can enter into the cell.
-     */
-    maxlength?: number;
-}
-
-interface SkyAgGridValidatorProperties {
-    /**
-     * An optional function that returns an observable that emits a string. Can be used with resources to localize the
-     * value displayed in the cell.
-     */
-    valueResourceObservable?: (value: unknown, data?: unknown, rowIndex?: number | null) => Observable<string>;
-    /**
-     * A function that returns true if the value is valid, or false if it is not. Invalid values
-     * will be highlighted and display a validation message.
-     */
-    validator?: (value: unknown, data?: unknown, rowIndex?: number | null) => boolean;
-    /**
-     * A string signal function, a string, or a function that returns a string. The message to display when the value is
-     * invalid.
-     */
-    validatorMessage?: Signal<string> | string | ((value: unknown, data?: unknown, rowIndex?: number | null) => string);
-}
-
 /**
  * Used to provide dependencies to the `SkyAgGridRowDeleteComponent` overlay.
  * @internal
@@ -1068,7 +1267,7 @@ declare class SkyAgGridCellValidatorTooltipComponent {
     #private;
     readonly params: i0.InputSignal<SkyCellRendererValidatorParams | undefined>;
     protected readonly popoverMessageStream: Subject<SkyPopoverMessage>;
-    protected readonly validatorProperties: i0.Signal<SkyAgGridValidatorProperties | undefined>;
+    protected readonly validatorProperties: i0.Signal<SkyAgGridValidatorProperties<unknown, unknown> | undefined>;
     protected readonly validatorMessage: i0.Signal<string>;
     protected readonly showValidatorMessage: i0.Signal<boolean>;
     constructor();
@@ -1140,5 +1339,5 @@ declare class SkyAgGridHeaderComponent implements IHeaderAngularComp, OnDestroy,
     static ɵcmp: i0.ɵɵComponentDeclaration<SkyAgGridHeaderComponent, "sky-ag-grid-header", never, {}, {}, never, never, true, never>;
 }
 
-export { SkyAgGridCellEditorInitialAction, SkyAgGridCellEditorUtils, SkyAgGridHeaderGroupInfo, SkyAgGridHeaderInfo, SkyAgGridModule, SkyAgGridService, SkyCellClass, SkyCellType, SkyHeaderClass, SkyAgGridCellEditorAutocompleteComponent as λ1, SkyAgGridCellRendererValidatorTooltipComponent as λ10, SkyAgGridCellValidatorTooltipComponent as λ11, SkyAgGridWrapperComponent as λ12, SkyAgGridRowDeleteDirective as λ13, SkyAgGridDataManagerAdapterDirective as λ14, SkyAgGridCellEditorLookupComponent as λ15, SkyAgGridCellRendererLookupComponent as λ16, SkyAgGridHeaderComponent as λ17, SkyAgGridHeaderGroupComponent as λ18, SkyAgGridColumnFilterDatepickerComponent as λ19, SkyAgGridCellEditorTextComponent as λ2, SkyAgGridCellEditorCurrencyComponent as λ3, SkyAgGridCellEditorNumberComponent as λ4, SkyAgGridCellEditorDatepickerComponent as λ5, SkyAgGridRowDeleteComponent as λ6, SkyAgGridCellRendererRowSelectorComponent as λ7, SkyAgGridCellRendererCurrencyValidatorComponent as λ8, SkyAgGridCellRendererCurrencyComponent as λ9 };
-export type { SkyAgGridAutocompleteProperties, SkyAgGridCurrencyProperties, SkyAgGridDatepickerProperties, SkyAgGridHeaderGroupParams, SkyAgGridHeaderParams, SkyAgGridLookupProperties, SkyAgGridNumberProperties, SkyAgGridRowDeleteCancelArgs, SkyAgGridRowDeleteConfirmArgs, SkyAgGridTextProperties, SkyAgGridValidatorProperties, SkyAutocompleteProperties, SkyCellEditorAutocompleteParams, SkyCellEditorDatepickerParams, SkyCellEditorLookupParams, SkyDatepickerProperties, SkyGetGridOptionsArgs };
+export { SkyAgGridCellEditorInitialAction, SkyAgGridCellEditorUtils, SkyAgGridHeaderGroupInfo, SkyAgGridHeaderInfo, SkyAgGridModule, SkyAgGridService, SkyCellClass, SkyCellType, SkyHeaderClass, defineSkyAgGridColDef, SkyAgGridCellEditorAutocompleteComponent as λ1, SkyAgGridCellRendererValidatorTooltipComponent as λ10, SkyAgGridCellValidatorTooltipComponent as λ11, SkyAgGridWrapperComponent as λ12, SkyAgGridRowDeleteDirective as λ13, SkyAgGridDataManagerAdapterDirective as λ14, SkyAgGridCellEditorLookupComponent as λ15, SkyAgGridCellRendererLookupComponent as λ16, SkyAgGridHeaderComponent as λ17, SkyAgGridHeaderGroupComponent as λ18, SkyAgGridColumnFilterDatepickerComponent as λ19, SkyAgGridCellEditorTextComponent as λ2, SkyAgGridCellEditorCurrencyComponent as λ3, SkyAgGridCellEditorNumberComponent as λ4, SkyAgGridCellEditorDatepickerComponent as λ5, SkyAgGridRowDeleteComponent as λ6, SkyAgGridCellRendererRowSelectorComponent as λ7, SkyAgGridCellRendererCurrencyValidatorComponent as λ8, SkyAgGridCellRendererCurrencyComponent as λ9 };
+export type { SkyAgGridAutocompleteProperties, SkyAgGridColDef, SkyAgGridCurrencyProperties, SkyAgGridDatepickerProperties, SkyAgGridHeaderGroupParams, SkyAgGridHeaderParams, SkyAgGridLookupProperties, SkyAgGridNumberProperties, SkyAgGridRowDeleteCancelArgs, SkyAgGridRowDeleteConfirmArgs, SkyAgGridTextProperties, SkyAgGridValidatorProperties, SkyAutocompleteProperties, SkyCellEditorAutocompleteParams, SkyCellEditorDatepickerParams, SkyCellEditorLookupParams, SkyCellEditorParamsByType, SkyCellRendererParamsByType, SkyCellRendererTemplateContext, SkyDatepickerProperties, SkyGetGridOptionsArgs };