@rowsncolumns/spreadsheet-state 28.0.66

package/dist/esm/api/filter-range.d.ts

@@ -0,0 +1,4 @@
+import type { CellCoordinateRange } from "@rowsncolumns/dag";
+import type { ParsedToken } from "@rowsncolumns/spreadsheet";
+export declare const parseFilterSourceRange: (formula: string | undefined, currentSheetId: number, getSheetId: (sheetName: string) => number, tokenizer: (str: string) => ParsedToken[]) => CellCoordinateRange | undefined;
+//# sourceMappingURL=filter-range.d.ts.map

package/dist/esm/api/filter-range.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-range.d.ts","sourceRoot":"","sources":["../../../api/filter-range.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAE7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAoE7D,eAAO,MAAM,sBAAsB,GACjC,SAAS,MAAM,GAAG,SAAS,EAC3B,gBAAgB,MAAM,EACtB,YAAY,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,EACzC,WAAW,CAAC,GAAG,EAAE,MAAM,KAAK,WAAW,EAAE,KACxC,mBAAmB,GAAG,SAgDxB,CAAC"}

package/dist/esm/api/filter-range.js

@@ -0,0 +1,100 @@
+import { tokenVocabulary } from "@rowsncolumns/fast-formula-parser";
+import { addressToCell } from "@rowsncolumns/utils";
+const getFilterFirstArgFromTokens = (tokens) => {
+    if (!tokens.length)
+        return undefined;
+    let index = 0;
+    const first = tokens[0];
+    if (!first)
+        return undefined;
+    if (first.tokenType.name === tokenVocabulary.Function.name) {
+        const functionName = first.image.slice(0, -1).toUpperCase();
+        if (functionName !== "FILTER") {
+            return undefined;
+        }
+        index = 1;
+    }
+    else {
+        const second = tokens[1];
+        const isNameBasedFilter = first.tokenType.name === tokenVocabulary.Name.name &&
+            first.image.toUpperCase() === "FILTER" &&
+            second?.tokenType.name === tokenVocabulary.OpenParen.name;
+        if (!isNameBasedFilter) {
+            return undefined;
+        }
+        index = 2;
+    }
+    let depth = 0;
+    const argTokens = [];
+    for (let i = index; i < tokens.length; i += 1) {
+        const token = tokens[i];
+        if (!token)
+            continue;
+        const tokenName = token.tokenType.name;
+        if (tokenName === tokenVocabulary.Comma.name && depth === 0) {
+            break;
+        }
+        if (tokenName === tokenVocabulary.CloseParen.name && depth === 0) {
+            break;
+        }
+        argTokens.push(token);
+        if (tokenName === tokenVocabulary.Function.name ||
+            tokenName === tokenVocabulary.OpenParen.name ||
+            tokenName === tokenVocabulary.OpenCurlyParen.name) {
+            depth += 1;
+            continue;
+        }
+        if (tokenName === tokenVocabulary.CloseParen.name ||
+            tokenName === tokenVocabulary.CloseCurlyParen.name) {
+            depth = Math.max(0, depth - 1);
+            continue;
+        }
+    }
+    const firstArg = argTokens
+        .map((token) => token.image)
+        .join("")
+        .trim();
+    return firstArg || undefined;
+};
+export const parseFilterSourceRange = (formula, currentSheetId, getSheetId, tokenizer) => {
+    if (!formula) {
+        return undefined;
+    }
+    const trimmed = formula.trim();
+    if (!trimmed.startsWith("=")) {
+        return undefined;
+    }
+    const formulaBody = trimmed.slice(1).trimStart();
+    if (!formulaBody.toUpperCase().startsWith("FILTER")) {
+        return undefined;
+    }
+    const tokens = tokenizer(formulaBody);
+    const firstArg = getFilterFirstArgFromTokens(tokens);
+    if (!firstArg) {
+        return undefined;
+    }
+    let targetSheetId = currentSheetId;
+    let rangeArg = firstArg;
+    const lastBang = rangeArg.lastIndexOf("!");
+    if (lastBang !== -1) {
+        const sheetName = rangeArg.slice(0, lastBang).replace(/^'|'$/g, "");
+        rangeArg = rangeArg.slice(lastBang + 1);
+        targetSheetId = getSheetId(sheetName);
+    }
+    const [startRef, endRef] = rangeArg.split(":");
+    if (!startRef) {
+        return undefined;
+    }
+    const start = addressToCell(startRef.trim());
+    const end = addressToCell((endRef ?? startRef).trim());
+    if (!start || !end) {
+        return undefined;
+    }
+    return {
+        sheetId: targetSheetId,
+        startRowIndex: Math.min(start.rowIndex, end.rowIndex),
+        endRowIndex: Math.max(start.rowIndex, end.rowIndex),
+        startColumnIndex: Math.min(start.columnIndex, end.columnIndex),
+        endColumnIndex: Math.max(start.columnIndex, end.columnIndex),
+    };
+};

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

@@ -0,0 +1,24 @@
+import type { ColorFilterCriteria, ConditionType, ConditionValue, FilterSpec, IconFilterCriteria } from "@rowsncolumns/spreadsheet";
+export type CreateFilterSpecsExtras = {
+    /** Pass `null` to clear an existing color filter on this column. */
+    colorFilter?: ColorFilterCriteria | null;
+    /** Pass `null` to clear an existing icon filter on this column. */
+    iconFilter?: IconFilterCriteria | null;
+};
+/**
+ * Create a new filterspec
+ * @param filterSpecs
+ * @param columnIndex
+ * @param conditionType
+ * @param conditionValues
+ * @param visibleValues
+ * @param extras Optional colorFilter / iconFilter criteria.
+ */
+export declare const createFilterSpecs: (filterSpecs: FilterSpec[] | undefined, columnIndex: number, conditionType: ConditionType | undefined, conditionValues: ConditionValue[] | undefined, visibleValues: string[] | undefined | null, extras?: CreateFilterSpecsExtras) => FilterSpec[];
+/**
+ * Create filter spec by columnIndex
+ * @param filterSpecs
+ * @returns
+ */
+export declare const createFilterSpecsByColumnIndex: (filterSpecs?: FilterSpec[]) => Record<number, FilterSpec>;
+//# sourceMappingURL=filter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"filter.d.ts","sourceRoot":"","sources":["../../../api/filter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,UAAU,EACV,kBAAkB,EACnB,MAAM,2BAA2B,CAAC;AAEnC,MAAM,MAAM,uBAAuB,GAAG;IACpC,oEAAoE;IACpE,WAAW,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACzC,mEAAmE;IACnE,UAAU,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACxC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,GAC5B,aAAa,UAAU,EAAE,GAAG,SAAS,EACrC,aAAa,MAAM,EACnB,eAAe,aAAa,GAAG,SAAS,EACxC,iBAAiB,cAAc,EAAE,GAAG,SAAS,EAC7C,eAAe,MAAM,EAAE,GAAG,SAAS,GAAG,IAAI,EAC1C,SAAQ,uBAA4B,KACnC,UAAU,EAuCZ,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,GACzC,cAAa,UAAU,EAAO,+BAO/B,CAAC"}

package/dist/esm/api/filter.js

@@ -0,0 +1,62 @@
+/**
+ * Create a new filterspec
+ * @param filterSpecs
+ * @param columnIndex
+ * @param conditionType
+ * @param conditionValues
+ * @param visibleValues
+ * @param extras Optional colorFilter / iconFilter criteria.
+ */
+export const createFilterSpecs = (filterSpecs, columnIndex, conditionType, conditionValues, visibleValues, extras = {}) => {
+    const exists = filterSpecs?.find((spec) => spec.columnIndex === columnIndex);
+    // Spec
+    const filterSpec = {
+        columnIndex,
+        filterCriteria: {
+            condition: {
+                type: conditionType,
+                values: conditionValues,
+            },
+            visibleValues,
+            // `colorFilter`/`iconFilter` are kept only when explicitly set this
+            // turn. Passing `null` clears them; passing `undefined` carries the
+            // old value forward (so editing one criterion doesn't drop another).
+            ...(extras.colorFilter !== undefined
+                ? { colorFilter: extras.colorFilter ?? undefined }
+                : exists?.filterCriteria.colorFilter
+                    ? { colorFilter: exists.filterCriteria.colorFilter }
+                    : {}),
+            ...(extras.iconFilter !== undefined
+                ? { iconFilter: extras.iconFilter ?? undefined }
+                : exists?.filterCriteria.iconFilter
+                    ? { iconFilter: exists.filterCriteria.iconFilter }
+                    : {}),
+        },
+    };
+    if (exists && filterSpecs) {
+        return filterSpecs.map((spec) => {
+            if (spec.columnIndex === columnIndex) {
+                return {
+                    ...spec,
+                    ...filterSpec,
+                };
+            }
+            return spec;
+        });
+    }
+    else {
+        return [...(filterSpecs ?? []), filterSpec];
+    }
+};
+/**
+ * Create filter spec by columnIndex
+ * @param filterSpecs
+ * @returns
+ */
+export const createFilterSpecsByColumnIndex = (filterSpecs = []) => {
+    const filterSpecByColumnIndex = {};
+    for (const spec of filterSpecs) {
+        filterSpecByColumnIndex[spec.columnIndex] = spec;
+    }
+    return filterSpecByColumnIndex;
+};

package/dist/esm/api/format-caches.d.ts

@@ -0,0 +1,43 @@
+/**
+ * LRU caches used by `useSheetProperties` to memoise expensive
+ * format-derivation and number-formatting calls. Both are pull-based —
+ * entries only land in the cache when a getter is invoked on a cell, so in
+ * practice the working set is roughly the visible viewport plus any cells
+ * touched by chart/series/copy paths. The LRU bound prevents unbounded
+ * growth over long sessions where the user scrolls, switches sheets, or
+ * imports/deletes data.
+ *
+ * Insertion-order Maps double as LRU: re-inserting a key on hit moves it
+ * to the most-recently-used end; eviction picks `keys().next().value`,
+ * which is the oldest entry.
+ */
+/**
+ * Position-keyed LRU cache for per-formula-cell derived-format entries.
+ * Generic over the entry shape so the caller owns the value type.
+ */
+export declare class FormulaFormatCache<V> {
+    private cache;
+    private maxSize;
+    constructor(maxSize?: number);
+    private key;
+    get(sheetId: number, rowIndex: number, columnIndex: number): V | undefined;
+    set(sheetId: number, rowIndex: number, columnIndex: number, value: V): void;
+    clear(): void;
+    get size(): number;
+}
+/**
+ * Tuple-keyed LRU cache for `createFormattedValue` results. Many cells
+ * share the same `(locale, pattern, valueType, value)` tuple, so this
+ * dedups aggressively across the workbook.
+ */
+export declare class FormattedValueCache {
+    private cache;
+    private maxSize;
+    constructor(maxSize?: number);
+    private key;
+    get(locale: string | undefined, pattern: string, valueType: string, value: unknown): string | undefined;
+    set(locale: string | undefined, pattern: string, valueType: string, value: unknown, formatted: string): void;
+    clear(): void;
+    get size(): number;
+}
+//# sourceMappingURL=format-caches.d.ts.map

package/dist/esm/api/format-caches.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-caches.d.ts","sourceRoot":"","sources":["../../../api/format-caches.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAKH;;;GAGG;AACH,qBAAa,kBAAkB,CAAC,CAAC;IAC/B,OAAO,CAAC,KAAK,CAAwB;IACrC,OAAO,CAAC,OAAO,CAAS;gBAEZ,OAAO,GAAE,MAA0C;IAI/D,OAAO,CAAC,GAAG;IAIX,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAW1E,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAU3E,KAAK,IAAI,IAAI;IAIb,IAAI,IAAI,IAAI,MAAM,CAEjB;CACF;AAED;;;;GAIG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,KAAK,CAA6B;IAC1C,OAAO,CAAC,OAAO,CAAS;gBAEZ,OAAO,GAAE,MAA2C;IAIhE,OAAO,CAAC,GAAG;IASX,GAAG,CACD,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,OAAO,GACb,MAAM,GAAG,SAAS;IAUrB,GAAG,CACD,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,OAAO,EACd,SAAS,EAAE,MAAM,GAChB,IAAI;IAUP,KAAK,IAAI,IAAI;IAIb,IAAI,IAAI,IAAI,MAAM,CAEjB;CACF"}

package/dist/esm/api/format-caches.js

@@ -0,0 +1,95 @@
+/**
+ * LRU caches used by `useSheetProperties` to memoise expensive
+ * format-derivation and number-formatting calls. Both are pull-based —
+ * entries only land in the cache when a getter is invoked on a cell, so in
+ * practice the working set is roughly the visible viewport plus any cells
+ * touched by chart/series/copy paths. The LRU bound prevents unbounded
+ * growth over long sessions where the user scrolls, switches sheets, or
+ * imports/deletes data.
+ *
+ * Insertion-order Maps double as LRU: re-inserting a key on hit moves it
+ * to the most-recently-used end; eviction picks `keys().next().value`,
+ * which is the oldest entry.
+ */
+const DEFAULT_FORMULA_FORMAT_CACHE_SIZE = 50_000;
+const DEFAULT_FORMATTED_VALUE_CACHE_SIZE = 50_000;
+/**
+ * Position-keyed LRU cache for per-formula-cell derived-format entries.
+ * Generic over the entry shape so the caller owns the value type.
+ */
+export class FormulaFormatCache {
+    cache = new Map();
+    maxSize;
+    constructor(maxSize = DEFAULT_FORMULA_FORMAT_CACHE_SIZE) {
+        this.maxSize = maxSize;
+    }
+    key(sheetId, rowIndex, columnIndex) {
+        return `${sheetId}!${rowIndex},${columnIndex}`;
+    }
+    get(sheetId, rowIndex, columnIndex) {
+        const k = this.key(sheetId, rowIndex, columnIndex);
+        const v = this.cache.get(k);
+        if (v !== undefined) {
+            // Touch: re-insert to move to MRU end.
+            this.cache.delete(k);
+            this.cache.set(k, v);
+        }
+        return v;
+    }
+    set(sheetId, rowIndex, columnIndex, value) {
+        const k = this.key(sheetId, rowIndex, columnIndex);
+        this.cache.delete(k);
+        this.cache.set(k, value);
+        if (this.cache.size > this.maxSize) {
+            const oldest = this.cache.keys().next().value;
+            if (oldest !== undefined)
+                this.cache.delete(oldest);
+        }
+    }
+    clear() {
+        this.cache.clear();
+    }
+    get size() {
+        return this.cache.size;
+    }
+}
+/**
+ * Tuple-keyed LRU cache for `createFormattedValue` results. Many cells
+ * share the same `(locale, pattern, valueType, value)` tuple, so this
+ * dedups aggressively across the workbook.
+ */
+export class FormattedValueCache {
+    cache = new Map();
+    maxSize;
+    constructor(maxSize = DEFAULT_FORMATTED_VALUE_CACHE_SIZE) {
+        this.maxSize = maxSize;
+    }
+    key(locale, pattern, valueType, value) {
+        return `${locale ?? ""}|${pattern}|${valueType}|${String(value)}`;
+    }
+    get(locale, pattern, valueType, value) {
+        const k = this.key(locale, pattern, valueType, value);
+        const v = this.cache.get(k);
+        if (v !== undefined) {
+            this.cache.delete(k);
+            this.cache.set(k, v);
+        }
+        return v;
+    }
+    set(locale, pattern, valueType, value, formatted) {
+        const k = this.key(locale, pattern, valueType, value);
+        this.cache.delete(k);
+        this.cache.set(k, formatted);
+        if (this.cache.size > this.maxSize) {
+            const oldest = this.cache.keys().next().value;
+            if (oldest !== undefined)
+                this.cache.delete(oldest);
+        }
+    }
+    clear() {
+        this.cache.clear();
+    }
+    get size() {
+        return this.cache.size;
+    }
+}

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

@@ -0,0 +1,69 @@
+import type { ParsedToken } from "@rowsncolumns/spreadsheet";
+export { ERROR_CIRCULAR_DEPENDENCY, ERROR_REFERENCE, formulaToRelativeReference, } from "@rowsncolumns/calculator";
+export type { FormulaToRelativeReferenceOptions } from "@rowsncolumns/calculator";
+/**
+ * Update sheet name in formula
+ * @param formulaValue
+ * @param oldName
+ * @param newName
+ */
+export declare const updateSheetName: (formulaValue: string, newName: string, oldName: string) => string;
+/**
+ * Update sheet name in formula
+ * @param formulaValue
+ * @param oldName
+ * @param newName
+ */
+export declare const updateNamedRangeName: (formulaValue: string, newName: string, oldName: string) => string;
+/**
+ * Update sheet name in formula
+ * @param formulaValue
+ * @param oldName
+ * @param newName
+ */
+export declare const updateColumnName: (formulaValue: string, newName: string, oldName: string) => string;
+/**
+ * Converts tokens to string
+ * @param tokens
+ */
+export declare const detokenize: (tokens: ParsedToken[]) => string;
+/**
+ * Create cell identifier
+ * @param sheetId
+ * @param rowIndex
+ * @param columnIndex
+ */
+export declare const createSheetCellIdentifier: (sheetId: number, rowIndex: number, columnIndex: number) => string;
+/**
+ * Check if a formula contains absolute column references
+ * $A2 | $A$2
+ * @param formula
+ */
+export declare const isAbsoluteColumnReference: (formula: string | undefined) => boolean;
+/**
+ * Check if a formula contains absolute row references
+ * A$2 | $A$2
+ * @param formula
+ */
+export declare const isAbsoluteRowReference: (formula: string | undefined) => boolean;
+/**
+ * Expands ranges in a formula when rows or columns are inserted within the range
+ * @param formula The formula to process
+ * @param insertionIndex The row or column index where insertion happens
+ * @param count Number of rows or columns being inserted
+ * @param dimension Whether inserting 'row' or 'column'
+ * @param activeSheetName Active sheet name to scope range updates
+ * @returns The formula with expanded ranges, or undefined if no changes
+ */
+export declare const expandRangesInFormula: (formula: string | undefined, insertionIndex: number, count: number, dimension: "row" | "column", activeSheetName: string) => string | undefined;
+/**
+ * Contracts ranges in a formula when rows or columns are deleted within the range
+ * @param formula The formula to process
+ * @param deletionIndex The row or column index where deletion starts
+ * @param count Number of rows or columns being deleted
+ * @param dimension Whether deleting 'row' or 'column'
+ * @param activeSheetName Active sheet name to scope range updates
+ * @returns The formula with contracted ranges, or undefined if no changes
+ */
+export declare const contractRangesInFormula: (formula: string | undefined, deletionIndex: number, count: number, dimension: "row" | "column", activeSheetName: string) => string | undefined;
+//# sourceMappingURL=formula.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"formula.d.ts","sourceRoot":"","sources":["../../../api/formula.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,WAAW,EAAS,MAAM,2BAA2B,CAAC;AAUpE,OAAO,EACL,yBAAyB,EACzB,eAAe,EACf,0BAA0B,GAC3B,MAAM,0BAA0B,CAAC;AAClC,YAAY,EAAE,iCAAiC,EAAE,MAAM,0BAA0B,CAAC;AAElF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAC1B,cAAc,MAAM,EACpB,SAAS,MAAM,EACf,SAAS,MAAM,WA4BhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAC/B,cAAc,MAAM,EACpB,SAAS,MAAM,EACf,SAAS,MAAM,WAehB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAC3B,cAAc,MAAM,EACpB,SAAS,MAAM,EACf,SAAS,MAAM,WAYhB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,WAAW,EAAE,WAU/C,CAAC;AAiBF;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GACpC,SAAS,MAAM,EACf,UAAU,MAAM,EAChB,aAAa,MAAM,WAGpB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,GAAI,SAAS,MAAM,GAAG,SAAS,YAGpE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GAAI,SAAS,MAAM,GAAG,SAAS,YAGjE,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAChC,SAAS,MAAM,GAAG,SAAS,EAC3B,gBAAgB,MAAM,EACtB,OAAO,MAAM,EACb,WAAW,KAAK,GAAG,QAAQ,EAC3B,iBAAiB,MAAM,KACtB,MAAM,GAAG,SAmKX,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB,GAClC,SAAS,MAAM,GAAG,SAAS,EAC3B,eAAe,MAAM,EACrB,OAAO,MAAM,EACb,WAAW,KAAK,GAAG,QAAQ,EAC3B,iBAAiB,MAAM,KACtB,MAAM,GAAG,SA6NX,CAAC"}