@sheetxl/sdk 0.7.21 → 0.7.23-beta.2

package/types/src/dataValidation/DataValidation.d.ts

@@ -0,0 +1,121 @@
+import { ReferenceableClipboard } from '@sheetxl/utils';
+import { IListener } from '../listener';
+import { ITransaction } from '../transaction';
+import { IGrid } from '../collections';
+import { ICellRange } from '../cellRange';
+import { AnchoredConditional } from '../condition/AnchoredConditional';
+import { IDataValidation } from './IDataValidation';
+/**
+ * Implementation of {@link IDataValidation}.
+ */
+export declare class DataValidation extends AnchoredConditional<State, CommitView, IDataValidation.Events> implements IDataValidation {
+    /**
+     * Cache of failing cells for quick reads in {@link getAlertAt} — a plain field, NOT transactional
+     * state, mirroring ConditionalFormat's `_matches`.
+     *
+     * @remarks
+     * Results are DERIVED from values + condition, so they need no undo snapshot: undo/restore
+     * re-fires the non-transactional range listeners and the cache re-derives. Holding them in state
+     * meant every re-evaluation (each calc delivery, for every validation it reached) pushed a
+     * commit onto the undo stack for a change no user made.
+     */
+    protected _results: IGrid<boolean> | null;
+    /**
+     * Which evaluation round is current. Bumped once per {@link _processValueUpdates}; a round
+     * writes its results only if it is still the newest when it finishes. Same shape and reason as
+     * ConditionalFormat's `_prepareGeneration`.
+     */
+    protected _evalGeneration: number;
+    /** @internal */
+    protected _getType(): string;
+    /** @internal */
+    protected _getActionDescription(action: 'delete' | 'initialize' | 'updateListener'): string | null;
+    /** @internal */
+    protected _getDefaultState(options: DataValidation.ConstructorOptions): Readonly<State>;
+    /** @internal */
+    protected _processValueUpdates(_range?: ICellRange | null): void;
+    /** {@inheritDoc IDataValidation.getAlertAt} */
+    getAlertAt(rowIndex: number, columnIndex: number): boolean;
+    /** {@inheritDoc IDataValidation.getAlertEntries} */
+    getAlertEntries(options?: ICellRange.IteratorOptions): IGrid.EntryIterator<boolean>;
+    /** {@inheritDoc IDataValidation.getAlertCount} */
+    getAlertCount(): number;
+    /** {@inheritDoc IDataValidation.setHideDropdown} */
+    setHideDropdown(hide: boolean, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc IDataValidation.isHideDropdown} */
+    isHideDropdown(): boolean;
+    /** {@inheritDoc IDataValidation.setPromptMessage} */
+    setPromptMessage(message: string, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc IDataValidation.getPromptMessage} */
+    getPromptMessage(): string;
+    /** {@inheritDoc IDataValidation.setPromptTitle} */
+    setPromptTitle(title: string, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc IDataValidation.getPromptTitle} */
+    getPromptTitle(): string;
+    /** {@inheritDoc IDataValidation.setShowPromptMessage} */
+    setShowPromptMessage(show: boolean, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc IDataValidation.isShowPromptMessage} */
+    isShowPromptMessage(): boolean;
+    /** {@inheritDoc IDataValidation.setAlertMessage} */
+    setAlertMessage(message: string, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc IDataValidation.getAlertMessage} */
+    getAlertMessage(): string;
+    /** {@inheritDoc IDataValidation.setAlertTitle} */
+    setAlertTitle(title: string, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc IDataValidation.getAlertTitle} */
+    getAlertTitle(): string;
+    /** {@inheritDoc IDataValidation.setShowAlertMessage} */
+    setShowAlertMessage(show: boolean, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc IDataValidation.isShowAlertMessage} */
+    isShowAlertMessage(): boolean;
+    /** {@inheritDoc IDataValidation.setAlertStyle} */
+    setAlertStyle(alertStyle: IDataValidation.AlertStyle, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc IDataValidation.getAlertStyle} */
+    getAlertStyle(): IDataValidation.AlertStyle;
+    /** {@inheritDoc IDataValidation.setIncludeBlanks} */
+    setIncludeBlanks(include: boolean, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc IDataValidation.isIncludeBlanks} */
+    isIncludeBlanks(): boolean;
+    /** {@inheritDoc IDataValidation.getRenderHints} */
+    getRenderHints(): readonly string[];
+    /** {@inheritDoc IDataValidation.update} */
+    update(update: Partial<IDataValidation.Properties> | IDataValidation, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc IDataValidation.getSnapshot} */
+    getSnapshot(options?: ReferenceableClipboard.CopyOptions): IDataValidation.ISnapshot;
+    /** {@inheritDoc IListener.ISource.addListeners} */
+    addListeners(listeners: IDataValidation.IListeners, options?: IListener.Options): IListener.Remove;
+    /** {@inheritDoc IDataValidation.toJSON} */
+    toJSON(): IDataValidation.JSON | null;
+    /** @internal */
+    protected _fromJSON(json: IDataValidation.JSON, options?: ITransaction.OperationOptions): void;
+    /** {@inheritDoc IDataValidation.isIDataValidation} */
+    get isIDataValidation(): true;
+}
+/**
+ * Tables are designed to be instantiated as both standalone and anchored items that represent a table of data on a sheet.
+ */
+export declare namespace DataValidation {
+    interface ConstructorOptions extends AnchoredConditional.ConstructorOptions<IDataValidation.JSON> {
+    }
+}
+/** @internal */
+interface State extends AnchoredConditional.State {
+    prompt: string;
+    promptTitle: string;
+    showPromptMessage: boolean;
+    alert: string;
+    alertTitle: string;
+    showAlertMessage: boolean;
+    alertStyle: IDataValidation.AlertStyle;
+    /** Suppresses the in-cell dropdown arrow of a list validation. Rendering only. */
+    hideDropdown: boolean;
+    /** Opaque IME hint. Carried, never interpreted. */
+    imeMode: string | null;
+    /** Opaque third-party payload. Carried, never interpreted. */
+    ext: Record<string, unknown> | null;
+}
+/** @internal */
+interface CommitView extends AnchoredConditional.CommitView {
+}
+export {};
+//# sourceMappingURL=DataValidation.d.ts.map

package/types/src/dataValidation/DataValidation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataValidation.d.ts","sourceRoot":"","sources":["../../../../src/dataValidation/DataValidation.ts"],"names":[],"mappings":"AACA,OAAO,EAA0C,KAAK,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAErG,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAqB,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE/D,OAAO,EAAE,KAAK,UAAU,EAAoB,MAAM,cAAc,CAAC;AAOjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAEvE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;GAEG;AACH,qBAAa,cAAe,SAAQ,mBAAmB,CAAC,KAAK,EAAE,UAAU,EAAE,eAAe,CAAC,MAAM,CAAE,YAAW,eAAe;IAE3H;;;;;;;;;OASG;IACH,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAAQ;IAEjD;;;;OAIG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,CAAK;IAEtC,gBAAgB;IAChB,SAAS,CAAC,QAAQ,IAAI,MAAM;IAI5B,gBAAgB;IAChB,SAAS,CAAC,qBAAqB,CAAC,MAAM,EAAE,QAAQ,GAAG,YAAY,GAAG,gBAAgB,GAAG,MAAM,GAAG,IAAI;IAMlG,gBAAgB;IAChB,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,cAAc,CAAC,kBAAkB,GAAG,QAAQ,CAAC,KAAK,CAAC;IAMvF,gBAAgB;IAChB,SAAS,CAAC,oBAAoB,CAAC,MAAM,GAAE,UAAU,GAAG,IAAW,GAAG,IAAI;IAiEtE,+CAA+C;IAC/C,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO;IAI1D,oDAAoD;IACpD,eAAe,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,GAAG,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC;IAWnF,kDAAkD;IAClD,aAAa,IAAI,MAAM;IAIvB,oDAAoD;IACpD,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI;IAU7E,mDAAmD;IACnD,cAAc,IAAI,OAAO;IAIzB,qDAAqD;IACrD,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI;IAUhF,qDAAqD;IACrD,gBAAgB,IAAI,MAAM;IAI1B,mDAAmD;IACnD,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI;IAU5E,mDAAmD;IACnD,cAAc,IAAI,MAAM;IAIxB,yDAAyD;IACzD,oBAAoB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI;IAUlF,wDAAwD;IACxD,mBAAmB,IAAI,OAAO;IAI9B,oDAAoD;IACpD,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI;IAU/E,oDAAoD;IACpD,eAAe,IAAI,MAAM;IAIzB,kDAAkD;IAClD,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI;IAU3E,kDAAkD;IAClD,aAAa,IAAI,MAAM;IAIvB,wDAAwD;IACxD,mBAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI;IAUjF,uDAAuD;IACvD,kBAAkB,IAAI,OAAO;IAI7B,kDAAkD;IAClD,aAAa,CAAC,UAAU,EAAE,eAAe,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI;IAUpG,kDAAkD;IAClD,aAAa,IAAI,eAAe,CAAC,UAAU;IAI3C,qDAAqD;IACrD,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI;IAejF,oDAAoD;IACpD,eAAe,IAAI,OAAO;IAI1B,mDAAmD;IACnD,cAAc,IAAI,SAAS,MAAM,EAAE;IAOnC,2CAA2C;IAC3C,MAAM,CACJ,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,UAAU,CAAC,GAAG,eAAe,EAC7D,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GACtC,IAAI;IAYP,gDAAgD;IAChD,WAAW,CAAC,OAAO,CAAC,EAAE,sBAAsB,CAAC,WAAW,GAAG,eAAe,CAAC,SAAS;IAsCpF,mDAAmD;IACnD,YAAY,CAAC,SAAS,EAAE,eAAe,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM;IAIlG,2CAA2C;IAC3C,MAAM,IAAI,eAAe,CAAC,IAAI,GAAG,IAAI;IA+CrC,gBAAgB;IAChB,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI;IAmD9F,sDAAsD;IACtD,IAAI,iBAAiB,IAAI,IAAI,CAE5B;CACF;AAED;;GAEG;AACH,yBAAiB,cAAc,CAAC;IAE9B,UAAiB,kBAAmB,SAAQ,mBAAmB,CAAC,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC;KAAG;CAC5G;AAED,gBAAgB;AAChB,UAAU,KAAM,SAAQ,mBAAmB,CAAC,KAAK;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,OAAO,CAAC;IAE3B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,UAAU,EAAE,eAAe,CAAC,UAAU,CAAC;IAIvC,kFAAkF;IAClF,YAAY,EAAE,OAAO,CAAC;IACtB,mDAAmD;IACnD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,8DAA8D;IAC9D,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAIrC;AAED,gBAAgB;AAChB,UAAU,UAAW,SAAQ,mBAAmB,CAAC,UAAU;CAC1D"}

package/types/src/dataValidation/DataValidationCollection.d.ts

@@ -0,0 +1,20 @@
+import { ICellRanges } from '../cellRange';
+import { IDataValidationCollection } from './IDataValidationCollection';
+import { IDataValidation } from './IDataValidation';
+export declare class DataValidationCollection implements IDataValidationCollection {
+    private _add;
+    private _get;
+    private _createItem;
+    constructor(add: (address: ICellRanges.Address | IDataValidation, options?: IDataValidationCollection.AddOptions) => IDataValidation, get: (address: ICellRanges.Address | null | undefined, ignoreHidden?: boolean, fullyContained?: boolean) => IDataValidation[], createItem: (template?: IDataValidation | null) => IDataValidation);
+    /** {@inheritDoc IDataValidationCollection.add} */
+    add(address: ICellRanges.Address | IDataValidation, options?: IDataValidationCollection.AddOptions): IDataValidation;
+    /** {@inheritDoc ICollection.[Symbol.iterator]} */
+    [Symbol.iterator](): IterableIterator<IDataValidation>;
+    /** {@inheritDoc IDataValidationCollection.getItems} */
+    getItems(options?: IDataValidationCollection.GetItemsOptions): IDataValidation[];
+    /** {@inheritDoc IDataValidationCollection.getCount} */
+    getCount(): number;
+    /** {@inheritDoc IDataValidationCollection.getCount} */
+    createItem(template?: IDataValidation | null): IDataValidation;
+}
+//# sourceMappingURL=DataValidationCollection.d.ts.map

package/types/src/dataValidation/DataValidationCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataValidationCollection.d.ts","sourceRoot":"","sources":["../../../../src/dataValidation/DataValidationCollection.ts"],"names":[],"mappings":"AAEA,OAAO,EAAmB,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAKjE,OAAO,EAAE,KAAK,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAE7E,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAKzD,qBAAa,wBAAyB,YAAW,yBAAyB;IACxE,OAAO,CAAC,IAAI,CAAsH;IAClI,OAAO,CAAC,IAAI,CAA2H;IACvI,OAAO,CAAC,WAAW,CAAyD;gBAG1E,GAAG,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,eAAe,EAAE,OAAO,CAAC,EAAE,yBAAyB,CAAC,UAAU,KAAK,eAAe,EACxH,GAAG,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,IAAI,GAAG,SAAS,EAAE,YAAY,CAAC,EAAE,OAAO,EAAE,cAAc,CAAC,EAAE,OAAO,KAAK,eAAe,EAAE,EAC7H,UAAU,EAAE,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,KAAK,eAAe;IAOpE,kDAAkD;IAClD,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,eAAe,EAAE,OAAO,CAAC,EAAE,yBAAyB,CAAC,UAAU,GAAG,eAAe;IAMpH,kDAAkD;IACjD,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,eAAe,CAAC;IAIvD,uDAAuD;IACvD,QAAQ,CAAC,OAAO,CAAC,EAAE,yBAAyB,CAAC,eAAe,GAAG,eAAe,EAAE;IAUhF,uDAAuD;IACvD,QAAQ,IAAI,MAAM;IAIlB,uDAAuD;IACvD,UAAU,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,GAAG,eAAe;CAG/D"}

package/types/src/dataValidation/IDataValidation.d.ts

@@ -0,0 +1,327 @@
+import { IRange } from '@sheetxl/primitives';
+import { ReferenceableClipboard } from '@sheetxl/utils';
+import { ITransaction } from '../transaction';
+import { IHistory } from '../history';
+import { IAnchored } from '../anchored';
+import { IListener } from '../listener';
+import { IGrid } from '../collections';
+import { ICondition } from '../condition';
+import { ICellRange, ICellRanges } from '../cellRange';
+import { IDataValidationCollection } from './IDataValidationCollection';
+/**
+ * Represents a data validation range.
+ *
+ * @remarks
+ * Used for modifying the type and rules of a data validation entry.
+ */
+export interface IDataValidation extends IAnchored, ICondition.Stateful {
+    /** @inheritdoc ICondition.Stateful.getCondition */
+    getCondition(): ICondition | null;
+    /**
+     * Set the condition.
+     */
+    setCondition(condition: ICondition.Input | null, options?: ITransaction.OperationOptions): this;
+    /**
+     * Creates a default condition for the data validation based on its range and the data.
+     */
+    createDefaultCondition(): ICondition;
+    /**
+     * Returns the validation results at the specified cell coordinates.
+     *
+     * @remarks
+     * If there are multiple validations this will return the first one to fail.
+     */
+    getAlertAt(rowIndex: number, columnIndex: number): boolean;
+    /**
+     * Returns an iterator that allows you to iterate over the individual alert entries within the range,
+     * yielding pairs of `IteratorContext` and a `Value`.
+     *
+     * @returns An iterator that yields `ICellRange.Entry<IDataValidation.Results>` tuples for each value within the range.
+     */
+    getAlertEntries(options?: ICellRange.IteratorOptions): IGrid.EntryIterator<boolean>;
+    /**
+     * Returns the count of alert entries within the range.
+     */
+    getAlertCount(): number;
+    /**
+     * Set whether to suppress the in-cell dropdown arrow for a list validation.
+     *
+     * @param hide `true` to hide the dropdown arrow.
+     *
+     * @remarks
+     * A rendering flag only — it never affects whether input is validated. Meaningful only for
+     * list validations, matching Excel's *In-cell dropdown* checkbox (inverted: the checkbox ON
+     * means `false` here).
+     */
+    setHideDropdown(hide: boolean, options?: ITransaction.OperationOptions): this;
+    /**
+     * @see {@link IDataValidation.setHideDropdown}
+     */
+    isHideDropdown(): boolean;
+    /**
+     * Message for a user prompt.
+     *
+     * @remarks
+     * This may be a tooltip or other indicator depending on the client.
+     */
+    setPromptMessage(message: string, options?: ITransaction.OperationOptions): this;
+    /**
+     * @see {@link IDataValidation.setPromptMessage}
+     */
+    getPromptMessage(): string;
+    /**
+     * Title text of the prompt.
+     *
+     * @param title The title text of the prompt.
+     */
+    setPromptTitle(title: string, options?: ITransaction.OperationOptions): this;
+    /**
+     * @see {@link IDataValidation.setPromptTitle}
+     */
+    getPromptTitle(): string;
+    /**
+     * Sets whether to show the prompt message when the cell is selected.
+     */
+    setShowPromptMessage(show: boolean, options?: ITransaction.OperationOptions): this;
+    /**
+     * @see {@link IDataValidation.setShowPromptMessage}
+     */
+    isShowPromptMessage(): boolean;
+    /**
+     * Message text of the alert.
+     */
+    setAlertMessage(message: string, options?: ITransaction.OperationOptions): this;
+    /**
+     * @see {@link IDataValidation.setAlertMessage}
+     */
+    getAlertMessage(): string;
+    /**
+     * Title text of the alert.
+     *
+     * @param title The title text of the alert.
+     */
+    setAlertTitle(title: string, options?: ITransaction.OperationOptions): this;
+    /**
+     * @see {@link IDataValidation.setAlertTitle}
+     */
+    getAlertTitle(): string;
+    /**
+     * Sets whether to show the alert message when the cell is selected.
+     */
+    setShowAlertMessage(show: boolean, options?: ITransaction.OperationOptions): this;
+    /**
+     * @see {@link IDataValidation.setShowAlertMessage}
+     */
+    isShowAlertMessage(): boolean;
+    /**
+     * Sets the style of the alert shown when validation fails.
+     *
+     * @remarks
+     * This controls whether alert values are blocked (`Stop`),
+     * allowed with a warning (`Warning`), or allowed with an informational
+     * message (`Information`).
+     */
+    setAlertStyle(alertStyle: IDataValidation.AlertStyle, options?: ITransaction.OperationOptions): this;
+    /**
+     * @see {@link IDataValidation.setAlertStyle}
+     */
+    getAlertStyle(): IDataValidation.AlertStyle;
+    /**
+     * If the cell has custom rendering.
+     *
+     * @remarks
+     * This could be a list or a checkbox or a custom editor
+     */
+    getRenderHints(): readonly string[];
+    /**
+     * Sets whether blanks are included in validation.
+     *
+     * @remarks
+     * Reads and writes through to the condition — blanks-pass-or-fail is a property of the predicate,
+     * and this is Excel's *Ignore blank* checkbox. A validation with no condition has nothing to set.
+     *
+     * @see {@link ICondition.isIncludeBlanks}
+     */
+    setIncludeBlanks(include: boolean, options?: ITransaction.OperationOptions): this;
+    /**
+     * If true, blanks are included in validation.
+     *
+     * @see {@link IDataValidation.setIncludeBlanks}
+     */
+    isIncludeBlanks(): boolean;
+    /**
+     * Updates multiple properties of the data validation.
+     */
+    update(update: Partial<IDataValidation.Properties> | IDataValidation, options?: ITransaction.OperationOptions): this;
+    /**
+     * Returns the index of this data validation within its container.
+     */
+    getIndex(): number;
+    /**
+     * Sets the index of this data validation within its container.
+     * @param index The new index to set.
+     */
+    setIndex(index: number): this;
+    /**
+     * Re-anchors this rule to `address`, REPLACING every range it currently covers.
+     *
+     * @param address The range or ranges to cover — anything `ISheet.getRanges` accepts
+     *   (`'A1:C20'`, `'A1:A5, C1:C5'`, coords). Resolved against this rule's own sheet.
+     * @param options Transaction options; `description` names the entry in undo history.
+     *
+     * @remarks
+     * A REPLACE, not an add: the ranges named become the whole anchor. An address that names
+     * nothing throws rather than leaving the rule unanchored — clearing is
+     * {@link IAnchored.delete}.
+     *
+     * Undoable, and refused on a protected sheet. A rule spans several ranges as readily as
+     * one; Excel writes them as one `sqref`, and so do we.
+     */
+    setRanges(address: ICellRanges.Address, options?: ITransaction.OperationOptions): this;
+    /**
+     * Returns a snapshot of the data validation that can be used for copying and archiving.
+     */
+    getSnapshot(options?: ReferenceableClipboard.CopyOptions): IDataValidation.ISnapshot;
+    /**
+     * Add Listeners.
+     *
+     * @see
+     * {@link IListener.ISource.addListeners}
+     */
+    addListeners(listeners: IDataValidation.IListeners, options?: IListener.Options): IListener.Remove;
+    /**
+     * @returns The current state as a JSON object, or `null` if there is no state.
+     */
+    toJSON(): IDataValidation.JSON | null;
+    /**
+     * For runtime type checking.
+     */
+    readonly isIDataValidation: true;
+}
+/**
+ * Capabilities for working with conditional styling ranges.
+ *
+ * @see
+ * ### **Interface**
+ *
+ * {@link IDataValidation}
+ *
+ * **Additional Interfaces**
+ * * {@link IDataValidationCollection}
+ */
+export declare namespace IDataValidation {
+    /**
+     * The style of data validation error.
+     */
+    const AlertStyle: {
+        /**
+         * Stops the user from entering alert data.
+         */
+        readonly Stop: "stop";
+        /**
+         * Shows a warning message when the user enters alert data.
+         */
+        readonly Warning: "warning";
+        /**
+         * Shows an information message when the user enters alert data.
+         */
+        readonly Information: "information";
+    };
+    type AlertStyle = typeof AlertStyle[keyof typeof AlertStyle];
+    /**
+     * A set of values that can be set on a IDataValidation.
+     *
+     * @see
+     * {@link IDataValidation}
+     */
+    interface Properties {
+        prompt?: string;
+        promptTitle?: string;
+        showPromptMessage?: boolean;
+        alert?: string;
+        alertTitle?: string;
+        showAlertMessage?: boolean;
+        alertStyle?: IDataValidation.AlertStyle;
+        /**
+         * The predicate a value must satisfy to be valid.
+         *
+         * @remarks
+         * Whether blanks pass is part of the predicate and lives here as
+         * {@link ICondition.Properties.includeBlanks} — {@link IDataValidation.isIncludeBlanks} reads
+         * through to it.
+         */
+        condition?: ICondition.Properties;
+        /**
+         * Suppresses the in-cell dropdown arrow of a list validation. Rendering only; validation is
+         * unaffected.
+         *
+         * @defaultValue false
+         */
+        hideDropdown?: boolean;
+        /**
+         * Input Method Editor mode for East Asian text entry.
+         *
+         * @remarks
+         * An **opaque passthrough**. The model carries the value so it survives a round trip and never
+         * interprets it; nothing in SheetXL reads it.
+         */
+        imeMode?: string;
+    }
+    /**
+     * JSON representation of the IDataValidation.
+     */
+    interface JSON extends IDataValidation.Properties {
+        /**
+         * Payload from a rule this build does not understand.
+         *
+         * @remarks
+         * Namespaced by producer. Survives the sxl round-trip; **dropped with a warning on xlsx
+         * write** until a carrier is chosen. Reserved so that adding one later does not change the
+         * persisted shape.
+         */
+        ext?: Record<string, unknown>;
+    }
+    /**
+     * Provides destination details for the Snapshot when using {@link IHistory.ISnapshot.copyTo}.
+     */
+    interface SnapshotDestination {
+        validations: IDataValidationCollection;
+        /** The first pasted area. `ranges` carries the rest when the paste tiles. */
+        range: IRange.Coords;
+        /** Every pasted image of the validation's marked areas — tiled, transposed, clipped. */
+        ranges?: IRange.Coords[];
+        /**
+         * Extend the live source validation instead of cloning — the same-sheet paste. Falls
+         * back to a clone when the source is gone or its definition changed since the mark.
+         */
+        extend?: boolean;
+        /** Insert position for a cloned validation. Pastes land at top priority. */
+        index?: number;
+    }
+    interface ISnapshot extends IHistory.ISnapshot<IDataValidation.SnapshotDestination, IDataValidation, IRange.Coords> {
+    }
+    /**
+     * IListener for {@link IDataValidation} events.
+     */
+    interface Events extends IAnchored.Events {
+        /**
+         * Called when any property changes.
+         */
+        onAnyChange?(source: IDataValidation): void;
+        /**
+         * Called when the condition changes.
+         */
+        onConditionChange?(source: IDataValidation): void;
+        /**
+         * Called when the configuration changes.
+         */
+        onConfigChange?(source: IDataValidation): void;
+        /**
+         * Called when the alerts entries change.
+         */
+        onAlertsChange?(source: IDataValidation): void;
+    }
+    interface IListeners extends IListener.Callbacks<IDataValidation, IDataValidation.Events> {
+    }
+}
+//# sourceMappingURL=IDataValidation.d.ts.map

package/types/src/dataValidation/IDataValidation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDataValidation.d.ts","sourceRoot":"","sources":["../../../../src/dataValidation/IDataValidation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAE7D,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,KAAK,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAE7E;;;;;GAKG;AAGH,MAAM,WAAW,eAAgB,SAAQ,SAAS,EAAE,UAAU,CAAC,QAAQ;IACrE,mDAAmD;IACnD,YAAY,IAAI,UAAU,GAAG,IAAI,CAAC;IAClC;;OAEG;IACH,YAAY,CACV,SAAS,EAAE,UAAU,CAAC,KAAK,GAAG,IAAI,EAClC,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GACtC,IAAI,CAAC;IACR;;OAEG;IAEH,sBAAsB,IAAI,UAAU,CAAC;IACrC;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3D;;;;;OAKG;IACH,eAAe,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,GAAG,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACpF;;OAEG;IACH,aAAa,IAAI,MAAM,CAAC;IACxB;;;;;;;;;OASG;IACH,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAC9E;;OAEG;IACH,cAAc,IAAI,OAAO,CAAC;IAC1B;;;;;OAKG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IACjF;;OAEG;IACH,gBAAgB,IAAI,MAAM,CAAC;IAC3B;;;;OAIG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAC7E;;OAEG;IACH,cAAc,IAAI,MAAM,CAAC;IACzB;;OAEG;IACH,oBAAoB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IACnF;;OAEG;IAEH,mBAAmB,IAAI,OAAO,CAAC;IAC/B;;OAEG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAChF;;OAEG;IACH,eAAe,IAAI,MAAM,CAAC;IAC1B;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAC5E;;OAEG;IACH,aAAa,IAAI,MAAM,CAAC;IACxB;;OAEG;IACH,mBAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAClF;;OAEG;IACH,kBAAkB,IAAI,OAAO,CAAC;IAC9B;;;;;;;OAOG;IACH,aAAa,CAAC,UAAU,EAAE,eAAe,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IACrG;;OAEG;IACH,aAAa,IAAI,eAAe,CAAC,UAAU,CAAC;IAC5C;;;;;OAKG;IACH,cAAc,IAAI,SAAS,MAAM,EAAE,CAAC;IACpC;;;;;;;;OAQG;IACH,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAClF;;;;OAIG;IACH,eAAe,IAAI,OAAO,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,UAAU,CAAC,GAAG,eAAe,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IACrH;;OAEG;IACH,QAAQ,IAAI,MAAM,CAAC;IACnB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IACvF;;OAEG;IACH,WAAW,CAAC,OAAO,CAAC,EAAE,sBAAsB,CAAC,WAAW,GAAG,eAAe,CAAC,SAAS,CAAC;IACrF;;;;;OAKG;IACH,YAAY,CAAC,SAAS,EAAE,eAAe,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;IACnG;;OAEG;IACH,MAAM,IAAI,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC;IACtC;;OAEG;IACH,QAAQ,CAAC,iBAAiB,EAAE,IAAI,CAAC;CAelC;AAED;;;;;;;;;;GAUG;AACH,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACI,MAAM,UAAU;QACrB;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;KAEK,CAAC;IACX,KAAY,UAAU,GAAG,OAAO,UAAU,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC;IAoBpE;;;;;OAKG;IACH,UAAiB,UAAU;QACzB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAE5B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAC3B,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;QAExC;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC;QAElC;;;;;WAKG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB;;;;;;WAMG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,IAAK,SAAQ,eAAe,CAAC,UAAU;QACtD;;;;;;;WAOG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAC/B;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC,WAAW,EAAE,yBAAyB,CAAC;QACvC,6EAA6E;QAC7E,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;QACrB,wFAAwF;QACxF,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;QACzB;;;WAGG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,4EAA4E;QAC5E,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED,UAAiB,SAAU,SAAQ,QAAQ,CAAC,SAAS,CAAC,eAAe,CAAC,mBAAmB,EAAE,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC;KAAG;IAG7H;;OAEG;IACH,UAAiB,MAAO,SAAQ,SAAS,CAAC,MAAM;QAC9C;;WAEG;QACH,WAAW,CAAC,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAC;QAC5C;;WAEG;QACH,iBAAiB,CAAC,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAC;QAClD;;WAEG;QACH,cAAc,CAAC,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAC;QAC/C;;WAEG;QACH,cAAc,CAAC,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAC;KAChD;IAED,UAAiB,UAAW,SAAQ,SAAS,CAAC,SAAS,CAAC,eAAe,EAAE,eAAe,CAAC,MAAM,CAAC;KAAG;CACpG"}

package/types/src/dataValidation/IDataValidationCollection.d.ts

@@ -0,0 +1,63 @@
+import { ITransaction } from '../transaction';
+import { ICollection } from '../type';
+import { ICellRange, ICellRanges } from '../cellRange';
+import { IDataValidation } from './IDataValidation';
+/**
+ * Holds a collection of {@link IDataValidation}s.
+ */
+export interface IDataValidationCollection extends ICollection<IDataValidation> {
+    /**
+     * Returns items that match the filter criteria.
+     *
+     * If no filter criteria is provided, all items will be returned.
+     *
+     * @param options {@link IDataValidationCollection.GetItemsOptions}
+     */
+    getItems(options?: IDataValidationCollection.GetItemsOptions): IDataValidation[];
+    /**
+     * Add an `IDataValidation` to the container.
+     *
+     * @param address The address of the item. May name several discontiguous ranges.
+     * @param options Additional options available when adding a table or a `boolean` that indicates if the table has headers.
+     */
+    add(address: ICellRanges.Address | IDataValidation, options?: IDataValidationCollection.AddOptions): IDataValidation;
+    /**
+     * Create a temporary item that can be interacted with but is not added to the collection.
+     *
+     * @param template A template to use for the temporary item.
+     */
+    createItem(template?: IDataValidation): IDataValidation;
+}
+/**
+ * {@inheritDoc IDataValidationCollection}
+ * @see
+ * ### **Interface**
+ *
+ * {@link IDataValidationCollection}
+ */
+export declare namespace IDataValidationCollection {
+    /**
+     * Options for adding a data validation to the collection.
+     */
+    interface AddOptions extends IDataValidation.Properties, ITransaction.OperationOptions {
+    }
+    interface GetItemsOptions {
+        /**
+         * If provided, the filter will be limited to items that intersect the range.
+        */
+        address?: ICellRange.Address;
+        /**
+         * Indicate if items that are in hidden headers or marked as hidden should be returned.
+         *
+         * @defaultValue false
+         */
+        ignoreHidden?: boolean;
+        /**
+         * Only return items that are completely contained with the search bounds.
+         *
+         * @defaultValue false
+         */
+        fullyContained?: boolean;
+    }
+}
+//# sourceMappingURL=IDataValidationCollection.d.ts.map

package/types/src/dataValidation/IDataValidationCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDataValidationCollection.d.ts","sourceRoot":"","sources":["../../../../src/dataValidation/IDataValidationCollection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAEjE,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,WAAW,CAAC,eAAe,CAAC;IAC7E;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,yBAAyB,CAAC,eAAe,GAAG,eAAe,EAAE,CAAC;IACjF;;;;;OAKG;IACH,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,eAAe,EAAE,OAAO,CAAC,EAAE,yBAAyB,CAAC,UAAU,GAAG,eAAe,CAAC;IACrH;;;;OAIG;IACH,UAAU,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,eAAe,CAAC;CAEzD;AAED;;;;;;GAMG;AACH,yBAAiB,yBAAyB,CAAC;IAEzC;;OAEG;IACH,UAAiB,UAAW,SAAQ,eAAe,CAAC,UAAU,EAAE,YAAY,CAAC,gBAAgB;KAE5F;IAGD,UAAiB,eAAe;QAC9B;;UAEE;QACF,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC;QAC7B;;;;WAIG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB;;;;WAIG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;KAC1B;CACF"}

package/types/src/dataValidation/_DataValidationMessages.d.ts

@@ -0,0 +1,2 @@
+export declare const ERROR_INVALID_CRITERIA = "The criteria provided is invalid or not supported.";
+//# sourceMappingURL=_DataValidationMessages.d.ts.map

package/types/src/dataValidation/_DataValidationMessages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_DataValidationMessages.d.ts","sourceRoot":"","sources":["../../../../src/dataValidation/_DataValidationMessages.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,sBAAsB,uDAAuD,CAAC"}

package/types/src/dataValidation/_Utils.d.ts

@@ -0,0 +1,10 @@
+declare class ValidationMask {
+    private readonly bytes;
+    readonly length: number;
+    constructor(length: number);
+    setInvalid(index: number): void;
+    clearInvalid(index: number): void;
+    isInvalid(index: number): boolean;
+    clearAll(): void;
+}
+//# sourceMappingURL=_Utils.d.ts.map

package/types/src/dataValidation/_Utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_Utils.d.ts","sourceRoot":"","sources":["../../../../src/dataValidation/_Utils.ts"],"names":[],"mappings":"AAGA,cAAM,cAAc;IAClB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAa;IACnC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEZ,MAAM,EAAE,MAAM;IAM1B,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAM/B,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAMjC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAMjC,QAAQ,IAAI,IAAI;CAGjB"}

package/types/src/dataValidation/index.d.ts

@@ -0,0 +1,3 @@
+export * from './IDataValidation';
+export * from './IDataValidationCollection';
+//# sourceMappingURL=index.d.ts.map

package/types/src/dataValidation/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/dataValidation/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC"}

package/types/src/date/DateUtils.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns Date.now() rounded to a nearest time.
+ *
+ * @param precision The precision of time. Set to 1 if exact.
+ * @defaultValue The nearest minute.
+ */
+export declare function nowWithPrecision(precision?: number): Date;
+//# sourceMappingURL=DateUtils.d.ts.map

package/types/src/date/DateUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DateUtils.d.ts","sourceRoot":"","sources":["../../../../src/date/DateUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,GAAE,MAAoB,GAAG,IAAI,CAEtE"}