@rowsncolumns/spreadsheet 10.6.4 → 10.7.0

package/dist/esm/api/error-checking.d.ts

@@ -0,0 +1,82 @@
+import type { GridRange } from "@rowsncolumns/common-types";
+import type { ErrorValue, ExtendedValue, IgnoredError } from "../types";
+/**
+ * The Excel background error-checking rules the grid flags with the green ◤ indicator. The names
+ * are the OOXML `<ignoredError>` attribute names, so an ignored error round-trips through xlsx.
+ *
+ * - `evalError` — "Cells containing formulas that result in an error".
+ * - `numberStoredAsText` — "Numbers formatted as text or preceded by an apostrophe".
+ */
+export type ErrorCheckKind = "evalError" | "numberStoredAsText";
+/**
+ * The number a "number stored as text" holds, or `undefined` when the text is not one. This is
+ * the value Excel's Convert to Number writes back.
+ */
+export declare const parseNumberStoredAsText: (text: string | null | undefined) => number | undefined;
+export type ErrorCheckInput = {
+    /** What the user typed (`uev`): a formula, a number, a string, … */
+    userEnteredValue: ExtendedValue | null | undefined;
+    /** The cell's error, if its effective value is one. */
+    errorValue: ErrorValue | null | undefined;
+};
+/**
+ * Which error-checking rule (if any) flags this cell, before ignored errors are applied.
+ * A typed error constant (`#N/A` entered as a value) is not flagged — only a formula's result.
+ * A data-validation failure is not an error-checking rule (Excel only circles it on request).
+ */
+export declare const getErrorCheckKind: ({ userEnteredValue, errorValue, }: ErrorCheckInput) => ErrorCheckKind | undefined;
+/** What the error-checking smart tag's menu can do. */
+export type ErrorCheckOption = "convertToNumber" | "help" | "ignore" | "editInFormulaBar" | "options";
+/** The menu's heading, as Excel words it. */
+export declare const getErrorCheckTitle: (kind: ErrorCheckKind, errorName?: string) => string;
+/** Excel's own help pages: hiding error values and error indicators, and the rule options. */
+export declare const ERROR_CHECKING_HELP_URL = "https://support.microsoft.com/en-us/office/hide-error-values-and-error-indicators-in-cells-d171b96e-8fb4-4863-a1ba-b64557474439";
+/** "Help on this Error": Excel's article for the error, else the error-indicators article. */
+export declare const getErrorHelpUrl: (kind: ErrorCheckKind, errorName?: string) => string;
+/** Has the user ignored this rule for this cell ("Ignore Error", or the file's `<ignoredErrors>`)? */
+export declare const isErrorIgnored: (ignoredErrors: ReadonlyArray<IgnoredError> | null | undefined, rowIndex: number, columnIndex: number, kind: ErrorCheckKind) => boolean;
+/** The sheet's ignored-errors list after "Ignore Error" on `ranges` (one new entry, as Excel writes). */
+export declare const appendIgnoredError: (ignoredErrors: ReadonlyArray<IgnoredError> | null | undefined, ranges: GridRange[], kind: ErrorCheckKind) => IgnoredError[];
+/** One row's run of adjacent cells Convert to Number rewrites, with their numbers. */
+export type NumberRun = {
+    rowIndex: number;
+    startColumnIndex: number;
+    values: number[];
+};
+/**
+ * The numbers stored as text inside `ranges`, as runs of adjacent cells per row — so Convert to
+ * Number writes each run in one call and never touches the cells between them. Rows / columns are
+ * clipped to `maxRow` / `maxColumn` (the sheet's data extent) so a whole-column selection scans
+ * only the used rows.
+ */
+export declare const collectNumberStoredAsTextRuns: (ranges: GridRange[], getUserEnteredValue: (rowIndex: number, columnIndex: number) => ExtendedValue | null | undefined, maxRow: number, maxColumn: number) => NumberRun[];
+export type ErrorCheckActionContext = {
+    sheetId: number;
+    kind: ErrorCheckKind;
+    errorName?: string;
+    /** The selection's ranges (the active cell's when nothing else is selected). */
+    ranges: GridRange[];
+    getUserEnteredValue(rowIndex: number, columnIndex: number): ExtendedValue | null | undefined;
+    /** The sheet's data extent: Convert to Number scans no further. */
+    maxRow: number;
+    maxColumn: number;
+    getIgnoredErrors?(sheetId: number): IgnoredError[] | null | undefined;
+    onChangeBatch?(sheetId: number, range: GridRange, values: number[][]): void;
+    /** Records every write `action` makes as one undo step. */
+    batchHistory?<R>(action: () => R): R;
+    onUpdateSheet?(sheetId: number, sheet: {
+        ignoredErrors: IgnoredError[];
+    }): void;
+    /** Start editing the active cell in the formula bar (or in the cell when there is no bar). */
+    editInFormulaBar(): void;
+    openUrl(url: string): void;
+};
+/**
+ * Run one of the error-checking smart tag's menu items. Convert to Number and Ignore Error act on
+ * every selected cell, as Excel does: Convert to Number rewrites each number stored as text as its
+ * number — one `onChangeBatch` per run of adjacent cells, all inside one `batchHistory`, so it is a
+ * single undo step and syncs as ordinary value writes; Ignore Error appends the selection to the
+ * sheet's `ignoredErrors` (persisted, xlsx `<ignoredErrors>`).
+ */
+export declare const runErrorCheckOption: (option: ErrorCheckOption, context: ErrorCheckActionContext) => void;
+//# sourceMappingURL=error-checking.d.ts.map

package/dist/esm/api/error-checking.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-checking.d.ts","sourceRoot":"","sources":["../../../api/error-checking.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAE5D,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExE;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,oBAAoB,CAAC;AAShE;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAClC,MAAM,MAAM,GAAG,IAAI,GAAG,SAAS,KAC9B,MAAM,GAAG,SAQX,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,oEAAoE;IACpE,gBAAgB,EAAE,aAAa,GAAG,IAAI,GAAG,SAAS,CAAC;IACnD,uDAAuD;IACvD,UAAU,EAAE,UAAU,GAAG,IAAI,GAAG,SAAS,CAAC;CAC3C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,mCAG/B,eAAe,KAAG,cAAc,GAAG,SAQrC,CAAC;AAEF,uDAAuD;AACvD,MAAM,MAAM,gBAAgB,GACxB,iBAAiB,GACjB,MAAM,GACN,QAAQ,GACR,kBAAkB,GAClB,SAAS,CAAC;AAcd,6CAA6C;AAC7C,eAAO,MAAM,kBAAkB,GAAI,MAAM,cAAc,EAAE,YAAY,MAAM,WAGT,CAAC;AAEnE,8FAA8F;AAC9F,eAAO,MAAM,uBAAuB,oIAC+F,CAAC;AAapI,8FAA8F;AAC9F,eAAO,MAAM,eAAe,GAAI,MAAM,cAAc,EAAE,YAAY,MAAM,WAE/C,CAAC;AAQ1B,sGAAsG;AACtG,eAAO,MAAM,cAAc,GACzB,eAAe,aAAa,CAAC,YAAY,CAAC,GAAG,IAAI,GAAG,SAAS,EAC7D,UAAU,MAAM,EAChB,aAAa,MAAM,EACnB,MAAM,cAAc,YAMnB,CAAC;AAEJ,yGAAyG;AACzG,eAAO,MAAM,kBAAkB,GAC7B,eAAe,aAAa,CAAC,YAAY,CAAC,GAAG,IAAI,GAAG,SAAS,EAC7D,QAAQ,SAAS,EAAE,EACnB,MAAM,cAAc,KACnB,YAAY,EAGd,CAAC;AAEF,sFAAsF;AACtF,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,GACxC,QAAQ,SAAS,EAAE,EACnB,qBAAqB,CACnB,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,KAChB,aAAa,GAAG,IAAI,GAAG,SAAS,EACrC,QAAQ,MAAM,EACd,WAAW,MAAM,KAChB,SAAS,EA8BX,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,cAAc,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gFAAgF;IAChF,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,mBAAmB,CACjB,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,GAClB,aAAa,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC,mEAAmE;IACnE,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC;IACtE,aAAa,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC;IAC5E,2DAA2D;IAC3D,YAAY,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IACrC,aAAa,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE;QAAE,aAAa,EAAE,YAAY,EAAE,CAAA;KAAE,GAAG,IAAI,CAAC;IAChF,8FAA8F;IAC9F,gBAAgB,IAAI,IAAI,CAAC;IACzB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAC9B,QAAQ,gBAAgB,EACxB,SAAS,uBAAuB,SAiDjC,CAAC"}

package/dist/esm/api/error-checking.js

@@ -0,0 +1,156 @@
+/**
+ * Text that Excel's "Number Stored as Text" rule flags: an optionally signed number, with optional
+ * thousands separators, decimals, exponent or a trailing percent sign — and nothing else.
+ */
+const NUMBER_STORED_AS_TEXT = /^[+-]?(?:\d{1,3}(?:,\d{3})+|\d+)?(?:\.\d+)?(?:[eE][+-]?\d+)?%?$/;
+/**
+ * The number a "number stored as text" holds, or `undefined` when the text is not one. This is
+ * the value Excel's Convert to Number writes back.
+ */
+export const parseNumberStoredAsText = (text) => {
+    if (typeof text !== "string" || !/\d/.test(text))
+        return undefined;
+    if (!NUMBER_STORED_AS_TEXT.test(text))
+        return undefined;
+    const isPercent = text.endsWith("%");
+    const body = (isPercent ? text.slice(0, -1) : text).replace(/,/g, "");
+    const value = Number(body);
+    if (!Number.isFinite(value))
+        return undefined;
+    return isPercent ? value / 100 : value;
+};
+/**
+ * Which error-checking rule (if any) flags this cell, before ignored errors are applied.
+ * A typed error constant (`#N/A` entered as a value) is not flagged — only a formula's result.
+ * A data-validation failure is not an error-checking rule (Excel only circles it on request).
+ */
+export const getErrorCheckKind = ({ userEnteredValue, errorValue, }) => {
+    const formula = userEnteredValue?.fv ?? userEnteredValue?.formulaValue;
+    if (formula) {
+        return errorValue?.type === "Error" ? "evalError" : undefined;
+    }
+    const text = userEnteredValue?.sv ?? userEnteredValue?.stringValue;
+    if (parseNumberStoredAsText(text) !== undefined)
+        return "numberStoredAsText";
+    return undefined;
+};
+const ERROR_TITLES = {
+    "#VALUE!": "Error in Value",
+    "#DIV/0!": "Divide by Zero Error",
+    "#N/A": "Value Not Available Error",
+    "#NAME?": "Invalid Name Error",
+    "#NULL!": "Null Error",
+    "#NUM!": "Invalid Number Error",
+    "#REF!": "Invalid Cell Reference Error",
+    "#SPILL!": "Spill Range Isn't Blank",
+    "#CALC!": "Calculation Error",
+};
+/** The menu's heading, as Excel words it. */
+export const getErrorCheckTitle = (kind, errorName) => kind === "numberStoredAsText"
+    ? "Number Stored as Text"
+    : (errorName && ERROR_TITLES[errorName]) || "Error in Formula";
+/** Excel's own help pages: hiding error values and error indicators, and the rule options. */
+export const ERROR_CHECKING_HELP_URL = "https://support.microsoft.com/en-us/office/hide-error-values-and-error-indicators-in-cells-d171b96e-8fb4-4863-a1ba-b64557474439";
+const ERROR_HELP_URLS = {
+    "#VALUE!": "https://support.microsoft.com/en-us/office/how-to-correct-a-value-error-15e1b616-fbf2-4147-9c0b-0a11a20e409e",
+    "#NAME?": "https://support.microsoft.com/en-us/office/how-to-correct-a-name-error-b6d54e31-a743-4d7d-9b61-40002a7b4286",
+    "#NUM!": "https://support.microsoft.com/en-us/office/how-to-correct-a-num-error-f5193bfc-4400-43f4-88c4-8e1dcca0428b",
+    "#SPILL!": "https://support.microsoft.com/en-us/office/how-to-correct-a-spill-error-ffe0f555-b479-4a17-a6e2-ef9cc9ad4023",
+};
+/** "Help on this Error": Excel's article for the error, else the error-indicators article. */
+export const getErrorHelpUrl = (kind, errorName) => (kind === "evalError" && errorName && ERROR_HELP_URLS[errorName]) ||
+    ERROR_CHECKING_HELP_URL;
+const inRange = (range, rowIndex, columnIndex) => rowIndex >= range.startRowIndex &&
+    rowIndex <= range.endRowIndex &&
+    columnIndex >= range.startColumnIndex &&
+    columnIndex <= range.endColumnIndex;
+/** Has the user ignored this rule for this cell ("Ignore Error", or the file's `<ignoredErrors>`)? */
+export const isErrorIgnored = (ignoredErrors, rowIndex, columnIndex, kind) => !!ignoredErrors?.some((entry) => entry[kind] === true &&
+    entry.ranges.some((range) => inRange(range, rowIndex, columnIndex)));
+/** The sheet's ignored-errors list after "Ignore Error" on `ranges` (one new entry, as Excel writes). */
+export const appendIgnoredError = (ignoredErrors, ranges, kind) => [
+    ...(ignoredErrors ?? []),
+    { ranges: ranges.map((range) => ({ ...range })), [kind]: true },
+];
+/**
+ * The numbers stored as text inside `ranges`, as runs of adjacent cells per row — so Convert to
+ * Number writes each run in one call and never touches the cells between them. Rows / columns are
+ * clipped to `maxRow` / `maxColumn` (the sheet's data extent) so a whole-column selection scans
+ * only the used rows.
+ */
+export const collectNumberStoredAsTextRuns = (ranges, getUserEnteredValue, maxRow, maxColumn) => {
+    const runs = [];
+    const seen = new Set();
+    for (const range of ranges) {
+        const endRow = Math.min(range.endRowIndex, maxRow);
+        const endColumn = Math.min(range.endColumnIndex, maxColumn);
+        for (let row = range.startRowIndex; row <= endRow; row++) {
+            let run = null;
+            for (let col = range.startColumnIndex; col <= endColumn; col++) {
+                const key = `${row}:${col}`;
+                const uev = seen.has(key) ? null : getUserEnteredValue(row, col);
+                seen.add(key);
+                const kind = getErrorCheckKind({ userEnteredValue: uev, errorValue: null });
+                const value = kind === "numberStoredAsText"
+                    ? parseNumberStoredAsText(uev?.sv ?? uev?.stringValue)
+                    : undefined;
+                if (value === undefined) {
+                    run = null;
+                    continue;
+                }
+                if (!run) {
+                    run = { rowIndex: row, startColumnIndex: col, values: [] };
+                    runs.push(run);
+                }
+                run.values.push(value);
+            }
+        }
+    }
+    return runs;
+};
+/**
+ * Run one of the error-checking smart tag's menu items. Convert to Number and Ignore Error act on
+ * every selected cell, as Excel does: Convert to Number rewrites each number stored as text as its
+ * number — one `onChangeBatch` per run of adjacent cells, all inside one `batchHistory`, so it is a
+ * single undo step and syncs as ordinary value writes; Ignore Error appends the selection to the
+ * sheet's `ignoredErrors` (persisted, xlsx `<ignoredErrors>`).
+ */
+export const runErrorCheckOption = (option, context) => {
+    const { sheetId, kind, ranges } = context;
+    switch (option) {
+        case "convertToNumber": {
+            const runs = collectNumberStoredAsTextRuns(ranges, context.getUserEnteredValue, context.maxRow, context.maxColumn);
+            if (!runs.length)
+                return;
+            const write = () => {
+                for (const run of runs) {
+                    context.onChangeBatch?.(sheetId, {
+                        startRowIndex: run.rowIndex,
+                        endRowIndex: run.rowIndex,
+                        startColumnIndex: run.startColumnIndex,
+                        endColumnIndex: run.startColumnIndex + run.values.length - 1,
+                    }, [run.values]);
+                }
+            };
+            if (context.batchHistory)
+                context.batchHistory(write);
+            else
+                write();
+            return;
+        }
+        case "ignore":
+            context.onUpdateSheet?.(sheetId, {
+                ignoredErrors: appendIgnoredError(context.getIgnoredErrors?.(sheetId), ranges, kind),
+            });
+            return;
+        case "editInFormulaBar":
+            context.editInFormulaBar();
+            return;
+        case "help":
+            context.openUrl(getErrorHelpUrl(kind, context.errorName));
+            return;
+        case "options":
+            context.openUrl(ERROR_CHECKING_HELP_URL);
+            return;
+    }
+};

package/dist/esm/api/move-overwrite.d.ts

@@ -7,8 +7,14 @@ export declare const MOVE_OVERWRITE_PROMPT = "There's already data here. Do you
  * destination cell OUTSIDE the source block holds a value. Cells the block itself
  * currently occupies are never "data here" — they leave with the move — so an
  * overlapping drag one cell over prompts only for the newly covered strip. An
- * empty destination never prompts; Shift+drag (insert) and Ctrl+drag (copy) never
- * reach this check.
+ * empty destination never prompts; Shift+drag (insert) never reaches this check and
+ * Ctrl+drag (copy) uses {@link needsCopyOverwritePrompt}.
  */
 export declare const needsOverwritePrompt: (from: GridRange, to: GridRange, hasValue: (rowIndex: number, columnIndex: number) => boolean) => boolean;
+/**
+ * Whether a Ctrl+drag (⌥+drag on macOS) COPY onto `to` needs the same prompt: any
+ * destination cell holding a value counts — a copy leaves the source in place, so
+ * source cells the copy lands on are replaced too.
+ */
+export declare const needsCopyOverwritePrompt: (to: GridRange, hasValue: (rowIndex: number, columnIndex: number) => boolean) => boolean;
 //# sourceMappingURL=move-overwrite.d.ts.map

package/dist/esm/api/move-overwrite.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"move-overwrite.d.ts","sourceRoot":"","sources":["../../../api/move-overwrite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEpD,sFAAsF;AACtF,eAAO,MAAM,qBAAqB,0DACuB,CAAC;AAE1D;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB,GAC/B,MAAM,SAAS,EACf,IAAI,SAAS,EACb,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,KAC3D,OAkBF,CAAC"}
+{"version":3,"file":"move-overwrite.d.ts","sourceRoot":"","sources":["../../../api/move-overwrite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEpD,sFAAsF;AACtF,eAAO,MAAM,qBAAqB,0DACuB,CAAC;AAE1D;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB,GAC/B,MAAM,SAAS,EACf,IAAI,SAAS,EACb,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,KAC3D,OAkBF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,GACnC,IAAI,SAAS,EACb,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,KAC3D,OAaF,CAAC"}

package/dist/esm/api/move-overwrite.js

@@ -6,8 +6,8 @@ export const MOVE_OVERWRITE_PROMPT = "There's already data here. Do you want to
  * destination cell OUTSIDE the source block holds a value. Cells the block itself
  * currently occupies are never "data here" — they leave with the move — so an
  * overlapping drag one cell over prompts only for the newly covered strip. An
- * empty destination never prompts; Shift+drag (insert) and Ctrl+drag (copy) never
- * reach this check.
+ * empty destination never prompts; Shift+drag (insert) never reaches this check and
+ * Ctrl+drag (copy) uses {@link needsCopyOverwritePrompt}.
  */
 export const needsOverwritePrompt = (from, to, hasValue) => {
     for (let rowIndex = to.startRowIndex; rowIndex <= to.endRowIndex; rowIndex++) {
@@ -23,3 +23,18 @@ export const needsOverwritePrompt = (from, to, hasValue) => {
     }
     return false;
 };
+/**
+ * Whether a Ctrl+drag (⌥+drag on macOS) COPY onto `to` needs the same prompt: any
+ * destination cell holding a value counts — a copy leaves the source in place, so
+ * source cells the copy lands on are replaced too.
+ */
+export const needsCopyOverwritePrompt = (to, hasValue) => {
+    for (let rowIndex = to.startRowIndex; rowIndex <= to.endRowIndex; rowIndex++) {
+        for (let columnIndex = to.startColumnIndex; columnIndex <= to.endColumnIndex; columnIndex++) {
+            if (hasValue(rowIndex, columnIndex)) {
+                return true;
+            }
+        }
+    }
+    return false;
+};

package/dist/esm/api/selections.d.ts

@@ -8,7 +8,7 @@ import type { SheetRange, TableView } from "../types";
  * @param isActiveCell
  * @param isSelection
  */
-export declare const getSelectionStrokeStyle: (formulaMode: boolean, isFill: boolean, isActiveCell: boolean, emptySelections: boolean) => "dashed" | "solid";
+export declare const getSelectionStrokeStyle: (formulaMode: boolean, isFill: boolean, isActiveCell: boolean, emptySelections: boolean) => "solid" | "dashed";
 export type SelectionStrokeOptions = {
     /** Border width of a range selection outside formula mode. Default `1`. */
     selectionStrokeWidth?: number;
@@ -37,7 +37,7 @@ export declare const getSelectionStrokeWidth: (formulaMode: boolean, isFill: boo
  * @param isFill
  * @returns
  */
-export declare const getSelectionFillOpacity: (formulaMode: boolean, isFill: boolean) => 1 | 0 | 0.2;
+export declare const getSelectionFillOpacity: (formulaMode: boolean, isFill: boolean) => 0 | 1 | 0.2;
 /**
  * Get background color of selection
  * @param formulaMode

package/dist/esm/api/validation.d.ts

@@ -1,5 +1,5 @@
 import type { CellInterface, GridRange } from "@rowsncolumns/grid";
-import type { BooleanCondition, CellData, ConditionType, ConditionValue, CustomFormulaResult, DataValidationRule, DataValidationRuleAlert, FilterCriteria, Maybe, ProtectedRange, SheetProtection, TimePeriodTypes } from "../types";
+import type { AllowEditRange, BooleanCondition, CellData, ConditionType, ConditionValue, CustomFormulaResult, DataValidationRule, DataValidationRuleAlert, FilterCriteria, Maybe, ProtectedRange, SheetProtection, TimePeriodTypes } from "../types";
 export type CheckBooleanRuleOptions = {
     locale?: string;
 };
@@ -50,6 +50,28 @@ export declare const showValidationDropdownArrow: (rule?: DataValidationRule | n
  * @returns
  */
 export declare const isProtectedCell: (sheetId: number, cell: CellInterface, protectedRanges: ProtectedRange[]) => boolean;
+/**
+ * The Excel Allow Edit Range covering `cell` on `sheetId`, preferring one this
+ * session may already edit (no password, or unlocked). `undefined` when no
+ * range covers the cell.
+ */
+export declare const getAllowEditRangeAt: (sheetId: number, cell: CellInterface, allowEditRanges: Maybe<AllowEditRange[]> | undefined) => AllowEditRange | undefined;
+/**
+ * What worksheet protection lets a typed edit of `cell` do (Excel's rules):
+ * `"edit"` for an unprotected sheet, an unlocked cell or a cell of an open
+ * Allow Edit Range; `"locked"` for any other locked cell; `{ unlock }` for a
+ * cell of a password-protected range this session has not unlocked (Excel's
+ * Unlock Range prompt).
+ */
+export declare const resolveProtectedCellEdit: ({ sheetId, cell, sheetProtection, cellProtection, allowEditRanges, }: {
+    sheetId: number;
+    cell: CellInterface;
+    sheetProtection: Maybe<SheetProtection> | undefined;
+    cellProtection: Maybe<Pick<NonNullable<CellData["protection"]>, "locked">>;
+    allowEditRanges?: Maybe<AllowEditRange[]>;
+}) => "edit" | "locked" | {
+    unlock: AllowEditRange;
+};
 /**
  * Check if the entire sheet is protected
  * @param sheetId
@@ -86,6 +108,22 @@ export declare const isActionBlockedBySheetProtection: (sheetProtection: Maybe<S
  * protection is inactive.
  */
 export declare const isCellLockedUnderProtection: (sheetProtection: Maybe<SheetProtection> | undefined, cellProtection: Maybe<Pick<NonNullable<CellData["protection"]>, "locked">>) => boolean;
+/**
+ * Past this many cells a selection on a sheet that refuses locked cells is
+ * refused without a per-cell scan (it would cover a locked default cell in
+ * practice — the engine's protection gate uses the same reasoning).
+ */
+export declare const SELECTABLE_SCAN_CELL_CAP = 100000;
+/**
+ * Excel's "Select locked cells" / "Select unlocked cells" (support.microsoft.com
+ * "Protect a worksheet"): whether the selection may cover `range` on a sheet.
+ * Only an ACTIVE protection restricts anything. `selectUnlockedCells` set
+ * (`true` prohibits) means no cell can be selected — Excel clears both boxes
+ * together. `selectLockedCells` set means the range must hold only unlocked
+ * cells (`protection.locked === false`; a cell is locked by default). Absent
+ * flags take the OOXML schema default: allowed.
+ */
+export declare const isRangeSelectableUnderProtection: (sheetProtection: Maybe<SheetProtection> | undefined, range: GridRange, getCellProtection: (rowIndex: number, columnIndex: number) => Maybe<Pick<NonNullable<CellData["protection"]>, "locked">> | undefined) => boolean;
 /**
  * Whether a cell's contents are hidden from the formula bar: Excel's Format
  * Cells ▸ Protection ▸ Hidden takes effect only while the sheet is protected.

package/dist/esm/api/validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../../api/validation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAanE,OAAO,KAAK,EACV,gBAAgB,EAChB,QAAQ,EACR,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,kBAAkB,EAClB,uBAAuB,EAEvB,cAAc,EACd,KAAK,EACL,cAAc,EACd,eAAe,EACf,eAAe,EAChB,MAAM,UAAU,CAAC;AAElB,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AA6CF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,CAAC,SAAS,QAAQ,EACjD,OAAO,kBAAkB,GAAG,SAAS,EACrC,QAAQ,mBAAmB,EAC3B,gBAAgB,mBAAmB,EACnC,iBAAiB,CAAC,OAAO,EAAE,MAAM,KAAK,cAAc,EAAE,EACtD,UAAU,uBAAuB,wBAyYlC,CAAC;AAEF,eAAO,MAAM,eAAe,GAC1B,gBAAgB,cAAc,EAC9B,QAAQ,mBAAmB,wBAM5B,CAAC;AAEF,gGAAgG;AAChG,eAAO,MAAM,oBAAoB,GAC/B,WAAW,gBAAgB,EAC3B,QAAQ,mBAAmB,wBACc,CAAC;AAE5C;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC,EAAE,WAAW,CAAC,aAAa,CAQpE,CAAC;AAEL,eAAO,MAAM,0BAA0B,GACrC,WAAW,KAAK,CAAC,gBAAgB,CAAC,GAAG,SAAS,KAC7C,OACwE,CAAC;AAE5E,MAAM,MAAM,wBAAwB,GAAG;IACrC,EAAE,EAAE,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,+BAA+B,GAC1C,WAAW,gBAAgB,EAC3B,cAAc,SAAS,MAAM,EAAE,KAC9B,wBAAwB,GAAG,SAmB7B,CAAC;AAEF,eAAO,MAAM,8BAA8B,GACzC,WAAW,wBAAwB,GAAG,SAAS,EAC/C,OAAO,OAAO,KACb,OAmBF,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAAI,OAAO,MAAM,GAAG,eAAe,SA+BpE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,GACtC,OAAO,kBAAkB,GAAG,IAAI,GAAG,SAAS,YAO7C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAC1B,SAAS,MAAM,EACf,MAAM,aAAa,EACnB,iBAAiB,cAAc,EAAE,YA2BlC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAC3B,SAAS,MAAM,EACf,kBAAkB,cAAc,EAAE,YAcnC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAC7B,aAAa,GACb,eAAe,GACf,YAAY,GACZ,eAAe,GACf,YAAY,GACZ,kBAAkB,GAClB,eAAe,GACf,YAAY,GACZ,MAAM,GACN,YAAY,GACZ,aAAa,GACb,YAAY,CAAC;AAEjB;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAClC,kBAAkB,KAAK,CAAC,eAAe,CAAC,KACvC,OAA0C,CAAC;AAE9C;;;;;;;;GAQG;AACH,eAAO,MAAM,gCAAgC,GAC3C,iBAAiB,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS,EACnD,QAAQ,qBAAqB,KAC5B,OAQF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B,GACtC,iBAAiB,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS,EACnD,gBAAgB,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,KACzE,OAC2E,CAAC;AAE/E;;;;GAIG;AACH,eAAO,MAAM,kCAAkC,GAC7C,iBAAiB,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS,EACnD,gBAAgB,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,KACzE,OAC0E,CAAC;AAE9E;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAC3B,SAAS,MAAM,EACf,OAAO,SAAS,EAChB,iBAAiB,cAAc,EAAE,GAAG,SAAS,GAAG,IAAI,wBAWrD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAC5B,SAAS,MAAM,EACf,OAAO,SAAS,EAChB,iBAAiB,cAAc,EAAE,GAAG,SAAS,+BAW9C,CAAC;AAEF,eAAO,MAAM,sBAAsB,GAAI,OAAO,KAAK,CAAC,aAAa,CAAC,YAGjE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;AAEvE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,GACjC,OAAO,KAAK,CAAC,uBAAuB,CAAC,EACrC,SAAS,OAAO,KACf,wBAKF,CAAC"}
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../../api/validation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAanE,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,QAAQ,EACR,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,kBAAkB,EAClB,uBAAuB,EAEvB,cAAc,EACd,KAAK,EACL,cAAc,EACd,eAAe,EACf,eAAe,EAChB,MAAM,UAAU,CAAC;AAElB,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AA6CF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,CAAC,SAAS,QAAQ,EACjD,OAAO,kBAAkB,GAAG,SAAS,EACrC,QAAQ,mBAAmB,EAC3B,gBAAgB,mBAAmB,EACnC,iBAAiB,CAAC,OAAO,EAAE,MAAM,KAAK,cAAc,EAAE,EACtD,UAAU,uBAAuB,wBAyYlC,CAAC;AAEF,eAAO,MAAM,eAAe,GAC1B,gBAAgB,cAAc,EAC9B,QAAQ,mBAAmB,wBAM5B,CAAC;AAEF,gGAAgG;AAChG,eAAO,MAAM,oBAAoB,GAC/B,WAAW,gBAAgB,EAC3B,QAAQ,mBAAmB,wBACc,CAAC;AAE5C;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC,EAAE,WAAW,CAAC,aAAa,CAQpE,CAAC;AAEL,eAAO,MAAM,0BAA0B,GACrC,WAAW,KAAK,CAAC,gBAAgB,CAAC,GAAG,SAAS,KAC7C,OACwE,CAAC;AAE5E,MAAM,MAAM,wBAAwB,GAAG;IACrC,EAAE,EAAE,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,+BAA+B,GAC1C,WAAW,gBAAgB,EAC3B,cAAc,SAAS,MAAM,EAAE,KAC9B,wBAAwB,GAAG,SAmB7B,CAAC;AAEF,eAAO,MAAM,8BAA8B,GACzC,WAAW,wBAAwB,GAAG,SAAS,EAC/C,OAAO,OAAO,KACb,OAmBF,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAAI,OAAO,MAAM,GAAG,eAAe,SA+BpE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,GACtC,OAAO,kBAAkB,GAAG,IAAI,GAAG,SAAS,YAO7C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAC1B,SAAS,MAAM,EACf,MAAM,aAAa,EACnB,iBAAiB,cAAc,EAAE,YA2BlC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAC9B,SAAS,MAAM,EACf,MAAM,aAAa,EACnB,iBAAiB,KAAK,CAAC,cAAc,EAAE,CAAC,GAAG,SAAS,KACnD,cAAc,GAAG,SASnB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,GAAI,sEAMtC;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,aAAa,CAAC;IACpB,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IACpD,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC3E,eAAe,CAAC,EAAE,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC;CAC3C,KAAG,MAAM,GAAG,QAAQ,GAAG;IAAE,MAAM,EAAE,cAAc,CAAA;CAO/C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAC3B,SAAS,MAAM,EACf,kBAAkB,cAAc,EAAE,YAcnC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAC7B,aAAa,GACb,eAAe,GACf,YAAY,GACZ,eAAe,GACf,YAAY,GACZ,kBAAkB,GAClB,eAAe,GACf,YAAY,GACZ,MAAM,GACN,YAAY,GACZ,aAAa,GACb,YAAY,CAAC;AAEjB;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAClC,kBAAkB,KAAK,CAAC,eAAe,CAAC,KACvC,OAA0C,CAAC;AAE9C;;;;;;;;GAQG;AACH,eAAO,MAAM,gCAAgC,GAC3C,iBAAiB,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS,EACnD,QAAQ,qBAAqB,KAC5B,OAQF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B,GACtC,iBAAiB,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS,EACnD,gBAAgB,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,KACzE,OAC2E,CAAC;AAE/E;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,SAAU,CAAC;AAEhD;;;;;;;;GAQG;AACH,eAAO,MAAM,gCAAgC,GAC3C,iBAAiB,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS,EACnD,OAAO,SAAS,EAChB,mBAAmB,CACjB,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,KAChB,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,GAAG,SAAS,KAC1E,OAkBF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,kCAAkC,GAC7C,iBAAiB,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS,EACnD,gBAAgB,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,KACzE,OAC0E,CAAC;AAE9E;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAC3B,SAAS,MAAM,EACf,OAAO,SAAS,EAChB,iBAAiB,cAAc,EAAE,GAAG,SAAS,GAAG,IAAI,wBAWrD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAC5B,SAAS,MAAM,EACf,OAAO,SAAS,EAChB,iBAAiB,cAAc,EAAE,GAAG,SAAS,+BAW9C,CAAC;AAEF,eAAO,MAAM,sBAAsB,GAAI,OAAO,KAAK,CAAC,aAAa,CAAC,YAGjE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;AAEvE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,GACjC,OAAO,KAAK,CAAC,uBAAuB,CAAC,EACrC,SAAS,OAAO,KACf,wBAKF,CAAC"}

package/dist/esm/api/validation.js

@@ -482,6 +482,40 @@ export const isProtectedCell = (sheetId, cell, protectedRanges) => {
         }
     });
 };
+/**
+ * The Excel Allow Edit Range covering `cell` on `sheetId`, preferring one this
+ * session may already edit (no password, or unlocked). `undefined` when no
+ * range covers the cell.
+ */
+export const getAllowEditRangeAt = (sheetId, cell, allowEditRanges) => {
+    let found;
+    for (const range of allowEditRanges ?? []) {
+        if (range.sheetId !== sheetId)
+            continue;
+        if (!range.ranges.some((r) => isCellWithinBounds(cell, r)))
+            continue;
+        if (range.unlocked)
+            return range;
+        found ??= range;
+    }
+    return found;
+};
+/**
+ * What worksheet protection lets a typed edit of `cell` do (Excel's rules):
+ * `"edit"` for an unprotected sheet, an unlocked cell or a cell of an open
+ * Allow Edit Range; `"locked"` for any other locked cell; `{ unlock }` for a
+ * cell of a password-protected range this session has not unlocked (Excel's
+ * Unlock Range prompt).
+ */
+export const resolveProtectedCellEdit = ({ sheetId, cell, sheetProtection, cellProtection, allowEditRanges, }) => {
+    if (!isCellLockedUnderProtection(sheetProtection, cellProtection)) {
+        return "edit";
+    }
+    const range = getAllowEditRangeAt(sheetId, cell, allowEditRanges);
+    if (!range)
+        return "locked";
+    return range.unlocked ? "edit" : { unlock: range };
+};
 /**
  * Check if the entire sheet is protected
  * @param sheetId
@@ -530,6 +564,42 @@ export const isActionBlockedBySheetProtection = (sheetProtection, action) => {
  * protection is inactive.
  */
 export const isCellLockedUnderProtection = (sheetProtection, cellProtection) => isSheetProtectionActive(sheetProtection) && cellProtection?.locked !== false;
+/**
+ * Past this many cells a selection on a sheet that refuses locked cells is
+ * refused without a per-cell scan (it would cover a locked default cell in
+ * practice — the engine's protection gate uses the same reasoning).
+ */
+export const SELECTABLE_SCAN_CELL_CAP = 100_000;
+/**
+ * Excel's "Select locked cells" / "Select unlocked cells" (support.microsoft.com
+ * "Protect a worksheet"): whether the selection may cover `range` on a sheet.
+ * Only an ACTIVE protection restricts anything. `selectUnlockedCells` set
+ * (`true` prohibits) means no cell can be selected — Excel clears both boxes
+ * together. `selectLockedCells` set means the range must hold only unlocked
+ * cells (`protection.locked === false`; a cell is locked by default). Absent
+ * flags take the OOXML schema default: allowed.
+ */
+export const isRangeSelectableUnderProtection = (sheetProtection, range, getCellProtection) => {
+    if (!isSheetProtectionActive(sheetProtection))
+        return true;
+    if (sheetProtection?.selectUnlockedCells === true)
+        return false;
+    if (sheetProtection?.selectLockedCells !== true)
+        return true;
+    const rows = range.endRowIndex - range.startRowIndex + 1;
+    const columns = range.endColumnIndex - range.startColumnIndex + 1;
+    if (rows <= 0 || columns <= 0)
+        return true;
+    if (rows * columns > SELECTABLE_SCAN_CELL_CAP)
+        return false;
+    for (let row = range.startRowIndex; row <= range.endRowIndex; row++) {
+        for (let column = range.startColumnIndex; column <= range.endColumnIndex; column++) {
+            if (getCellProtection(row, column)?.locked !== false)
+                return false;
+        }
+    }
+    return true;
+};
 /**
  * Whether a cell's contents are hidden from the formula bar: Excel's Format
  * Cells ▸ Protection ▸ Hidden takes effect only while the sheet is protected.

package/dist/esm/atoms/cell-input-context.atom.d.ts

@@ -1,7 +1,10 @@
 export declare const useCellInputContext: () => {
     makeEditable: ((sheetId: number, cell: import("@rowsncolumns/grid").CellInterface, initialValue?: string, options?: import("../hooks/use-editable").MakeEditableOptions) => void) | undefined;
     getNextFocusableCell: ((sheetId: number, currentCell: import("@rowsncolumns/grid").CellInterface, direction?: import("@rowsncolumns/grid").Direction, restrictWithinSelection?: boolean) => import("@rowsncolumns/grid").CellInterface | null) | undefined;
-    submitEditor: ((value: string, textFormatRuns: import("@rowsncolumns/common-types").TextFormatRun[] | undefined, sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, nextActiveCell?: import("@rowsncolumns/grid").CellInterface | null | undefined) => void) | undefined;
+    submitEditor: ((value: string, textFormatRuns: import("@rowsncolumns/common-types").TextFormatRun[] | undefined, sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, nextActiveCell?: import("@rowsncolumns/grid").CellInterface | null | undefined, shouldFocusGrid?: boolean, options?: {
+        arrayFormula?: boolean;
+        fillSelection?: boolean;
+    }) => void) | undefined;
     cancelEditor: ((e?: React.KeyboardEvent<HTMLDivElement>) => void) | undefined;
     onEditorKeyDown: ((e: React.KeyboardEvent<HTMLDivElement>) => void) | undefined;
     canEditCell: ((sheetId: number, cell: import("@rowsncolumns/grid").CellInterface) => boolean) | undefined;

package/dist/esm/atoms/cell-input-context.atom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cell-input-context.atom.d.ts","sourceRoot":"","sources":["../../../atoms/cell-input-context.atom.ts"],"names":[],"mappings":"AAoCA,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;CAA+C,CAAC"}
+{"version":3,"file":"cell-input-context.atom.d.ts","sourceRoot":"","sources":["../../../atoms/cell-input-context.atom.ts"],"names":[],"mappings":"AAoCA,eAAO,MAAM,mBAAmB;;;;oBACohiF,CAAC;qBAAwB,CAAC;;;;;;;;;;;CAD//hF,CAAC"}

package/dist/esm/atoms/enter-key-direction.atom.d.ts

@@ -0,0 +1,11 @@
+import type { EnterKeyDirection } from "../components/cell-editor/helpers";
+/**
+ * The grid's `enterKeyDirection`, for the editors that commit on Enter outside its props (the
+ * in-cell editor a host supplies, the formula bar).
+ */
+export declare const enterKeyDirectionAtom: import("jotai").PrimitiveAtom<EnterKeyDirection> & {
+    init: EnterKeyDirection;
+};
+export declare const useEnterKeyDirection: () => EnterKeyDirection;
+export declare const useSetEnterKeyDirection: () => (args_0: EnterKeyDirection | ((prev: EnterKeyDirection) => EnterKeyDirection)) => void;
+//# sourceMappingURL=enter-key-direction.atom.d.ts.map

package/dist/esm/atoms/enter-key-direction.atom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enter-key-direction.atom.d.ts","sourceRoot":"","sources":["../../../atoms/enter-key-direction.atom.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAE3E;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;CAAkC,CAAC;AAErE,eAAO,MAAM,oBAAoB,yBAA4C,CAAC;AAC9E,eAAO,MAAM,uBAAuB,8FAA0C,CAAC"}

package/dist/esm/atoms/enter-key-direction.atom.js

@@ -0,0 +1,8 @@
+import { atom, useAtomValue, useSetAtom } from "jotai";
+/**
+ * The grid's `enterKeyDirection`, for the editors that commit on Enter outside its props (the
+ * in-cell editor a host supplies, the formula bar).
+ */
+export const enterKeyDirectionAtom = atom("down");
+export const useEnterKeyDirection = () => useAtomValue(enterKeyDirectionAtom);
+export const useSetEnterKeyDirection = () => useSetAtom(enterKeyDirectionAtom);

package/dist/esm/atoms/index.d.ts

@@ -13,6 +13,7 @@ export * from "./selected-chart-embed.atom";
 export * from "./selected-chart-series.atom";
 export * from "./popover.atom";
 export * from "./paste-menu.atom";
+export * from "./pick-list.atom";
 export * from "./fill-options.atom";
 export * from "./fill-series-dialog.atom";
 export * from "./magic-fill-state.atom";

package/dist/esm/atoms/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../atoms/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iCAAiC,CAAC;AAChD,cAAc,qBAAqB,CAAC;AACpC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../atoms/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iCAAiC,CAAC;AAChD,cAAc,qBAAqB,CAAC;AACpC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yBAAyB,CAAC"}

package/dist/esm/atoms/index.js

@@ -13,6 +13,7 @@ export * from "./selected-chart-embed.atom";
 export * from "./selected-chart-series.atom";
 export * from "./popover.atom";
 export * from "./paste-menu.atom";
+export * from "./pick-list.atom";
 export * from "./fill-options.atom";
 export * from "./fill-series-dialog.atom";
 export * from "./magic-fill-state.atom";

package/dist/esm/atoms/paste-menu.atom.d.ts

@@ -1,6 +1,28 @@
+import type { PasteOptionId } from "../components/selection/paste-options";
 export declare const showPasteMenuAtom: import("jotai").PrimitiveAtom<boolean> & {
     init: boolean;
 };
 export declare const useShowPasteMenu: () => [boolean, (args_0: boolean | ((prev: boolean) => boolean)) => void];
 export declare const useSetShowPasteMenu: () => (args_0: boolean | ((prev: boolean) => boolean)) => void;
+/**
+ * The Paste Options button's state for the last paste: whether its gallery
+ * is open (a click, or Ctrl pressed alone after the paste), which gallery
+ * entry the paste currently stands as, and what the gallery may offer.
+ */
+export type PasteMenuState = {
+    open: boolean;
+    /** The gallery entry the last paste was applied as. */
+    active?: PasteOptionId;
+    /** The last paste can be re-applied in another mode (a copy, not a cut). */
+    canReapply: boolean;
+    /** Paste Link needs copied grid cells (not after a cut or a foreign clipboard). */
+    canLink: boolean;
+};
+export declare const DEFAULT_PASTE_MENU_STATE: PasteMenuState;
+export declare const pasteMenuStateAtom: import("jotai").PrimitiveAtom<PasteMenuState> & {
+    init: PasteMenuState;
+};
+export declare const usePasteMenuState: () => [PasteMenuState, (args_0: PasteMenuState | ((prev: PasteMenuState) => PasteMenuState)) => void];
+export declare const usePasteMenuStateValue: () => PasteMenuState;
+export declare const useSetPasteMenuState: () => (args_0: PasteMenuState | ((prev: PasteMenuState) => PasteMenuState)) => void;
 //# sourceMappingURL=paste-menu.atom.d.ts.map

package/dist/esm/atoms/paste-menu.atom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"paste-menu.atom.d.ts","sourceRoot":"","sources":["../../../atoms/paste-menu.atom.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,iBAAiB;;CAAc,CAAC;AAE7C,eAAO,MAAM,gBAAgB,2EAAmC,CAAC;AACjE,eAAO,MAAM,mBAAmB,gEAAsC,CAAC"}
+{"version":3,"file":"paste-menu.atom.d.ts","sourceRoot":"","sources":["../../../atoms/paste-menu.atom.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AAE3E,eAAO,MAAM,iBAAiB;;CAAc,CAAC;AAE7C,eAAO,MAAM,gBAAgB,2EAAmC,CAAC;AACjE,eAAO,MAAM,mBAAmB,gEAAsC,CAAC;AAEvE;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,OAAO,CAAC;IACd,uDAAuD;IACvD,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,4EAA4E;IAC5E,UAAU,EAAE,OAAO,CAAC;IACpB,mFAAmF;IACnF,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,cAItC,CAAC;AAEF,eAAO,MAAM,kBAAkB;;CAAiD,CAAC;AAEjF,eAAO,MAAM,iBAAiB,uGAAoC,CAAC;AACnE,eAAO,MAAM,sBAAsB,sBAAyC,CAAC;AAC7E,eAAO,MAAM,oBAAoB,qFAAuC,CAAC"}

package/dist/esm/atoms/paste-menu.atom.js

@@ -1,4 +1,13 @@
-import { atom, useAtom, useSetAtom } from "jotai";
+import { atom, useAtom, useAtomValue, useSetAtom } from "jotai";
 export const showPasteMenuAtom = atom(false);
 export const useShowPasteMenu = () => useAtom(showPasteMenuAtom);
 export const useSetShowPasteMenu = () => useSetAtom(showPasteMenuAtom);
+export const DEFAULT_PASTE_MENU_STATE = {
+    open: false,
+    canReapply: false,
+    canLink: false,
+};
+export const pasteMenuStateAtom = atom(DEFAULT_PASTE_MENU_STATE);
+export const usePasteMenuState = () => useAtom(pasteMenuStateAtom);
+export const usePasteMenuStateValue = () => useAtomValue(pasteMenuStateAtom);
+export const useSetPasteMenuState = () => useSetAtom(pasteMenuStateAtom);

package/dist/esm/atoms/pick-list.atom.d.ts

@@ -0,0 +1,15 @@
+import type { CellInterface } from "@rowsncolumns/grid";
+/**
+ * Excel's Pick From Drop-down List (Alt+↓ on a cell with no list of its
+ * own): the column's entries the cell editor offers for `cell`.
+ */
+export type PickListRequest = {
+    sheetId: number;
+    cell: CellInterface;
+    entries: string[];
+};
+export declare const pickListAtom: import("jotai").PrimitiveAtom<PickListRequest | null> & {
+    init: PickListRequest | null;
+};
+export declare const usePickList: () => [PickListRequest | null, (args_0: PickListRequest | ((prev: PickListRequest | null) => PickListRequest | null) | null) => void];
+//# sourceMappingURL=pick-list.atom.d.ts.map

package/dist/esm/atoms/pick-list.atom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pick-list.atom.d.ts","sourceRoot":"","sources":["../../../atoms/pick-list.atom.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGxD;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,eAAO,MAAM,YAAY;;CAAqC,CAAC;AAE/D,eAAO,MAAM,WAAW,uIAA8B,CAAC"}

package/dist/esm/atoms/pick-list.atom.js

@@ -0,0 +1,3 @@
+import { atom, useAtom } from "jotai";
+export const pickListAtom = atom(null);
+export const usePickList = () => useAtom(pickListAtom);