@orangelogic/design-system 2.130.0 → 2.131.0

package/library/packages/types/src/table.d.ts

@@ -928,6 +928,11 @@ export interface ITabulatorFull extends ITabulator {
     createFilterFieldFunction: IFilter['createFilterFieldFunction'];
     clearFilter: IFilter['clearFilter'];
     setSort: (sortList: string | Sorter[], dir?: SortDirection) => void;
+    validate: () => true | ICellComponent[];
+    validateAsync: () => Promise<ValidationSummary>;
+    getValidationSummary: () => ValidationSummary;
+    getInvalidCells: () => ICellComponent[];
+    clearCellValidation: (cells?: ICellComponent | ICellComponent[]) => void;
 }
 /**
  * Table type
@@ -1769,6 +1774,19 @@ export interface OptionsGeneral {
      * manual - no validation is automatically performed on edit, but it can be triggered by calling the validate function on the table or any Component Object
      */
     validationMode?: 'blocking' | 'highlight' | 'manual';
+    /**
+     * When true, the whole dataset is validated automatically each time data is
+     * loaded or replaced (`data-processed`). Defaults to false for backward
+     * compatibility.
+     */
+    validateOnLoad?: boolean;
+    /**
+     * Row-count threshold above which table-wide validation passes
+     * (`validateAsync` / `validateOnLoad`) are offloaded to a Web Worker instead
+     * of running synchronously on the main thread. Set to `false` to always
+     * validate synchronously. Defaults to 2000.
+     */
+    validationWorkerThreshold?: number | false;
     textDirection?: TextDirection;
     /**
      * Sometimes it can be useful to add a visual header to the start of a row.
@@ -2607,10 +2625,45 @@ export type JSONRecord = Record<string, string | number | boolean>;
  *     {title:"Example", field:"example", validator:"regex:\\.com$"} \\allow strings that end in '.com'
  * ```
  */
-export type StandardValidatorType = 'required' | 'unique' | 'integer' | 'float' | 'numeric' | 'string' | 'alphanumeric';
+export type StandardValidatorType = 'required' | 'unique' | 'integer' | 'float' | 'numeric' | 'string' | 'alphanumeric' | 'boolean' | 'date' | 'in' | 'regex';
+/** Range constraints accepted by the numeric-type validators (`numeric`, `integer`, `float`). */
+export interface NumericValidatorParameters {
+    min?: number;
+    max?: number;
+}
+/** Length constraints accepted by the `string` validator. */
+export interface StringValidatorParameters {
+    minLength?: number;
+    maxLength?: number;
+}
+/**
+ * Range constraints accepted by the `date` validator. `starts` / `ends` are
+ * inclusive bounds as ISO date strings (or anything `Date.parse` understands).
+ */
+export interface DateValidatorParameters {
+    starts?: string;
+    ends?: string;
+}
 export interface Validator {
     type: StandardValidatorType | ((cell: ICellComponent, value: any, parameters?: any) => boolean);
     parameters?: any;
+    /**
+     * Optional human-readable error message attached to validation failures for
+     * this rule. Propagated to cell validation state, the cell `title` tooltip,
+     * and validation events. JSON-serializable.
+     */
+    message?: string;
+}
+/** A single failed validation rule on a cell. */
+export interface CellValidationFailure {
+    type: string;
+    parameters?: any;
+    message?: string;
+}
+/** Aggregate result of a table-wide validation pass. */
+export interface ValidationSummary {
+    invalidCellCount: number;
+    invalidCells: ICellComponent[];
 }
 export type ColumnSorterParamLookupFunction = (column: IColumnComponent, dir: SortDirection) => Record<string, unknown>;
 export type ColumnLookup = IColumn | IColumnComponent | ColumnDefinition | HTMLElement | string;
@@ -2815,6 +2868,7 @@ export interface RangeComponent {
 }
 export interface EventCallBackMethods {
     validationFailed: (cell: ICellComponent, value: any, validators: Validator[]) => void;
+    validationChanged: (summary: ValidationSummary) => void;
     scrollHorizontal: (left: number, leftDir: boolean) => void;
     scrollVertical: (top: number, topDir: boolean) => void;
     rowAdded: (row: IRowComponent) => void;