@rowsncolumns/spreadsheet-state 28.0.66

package/dist/cjs/api/dependency.js

@@ -0,0 +1,279 @@
+import { __values } from "tslib";
+import { isStaticNode } from "@rowsncolumns/dag";
+import { isCellWithinBounds } from "@rowsncolumns/utils";
+import { SheetCell } from "../sheet-cell";
+import { createSheetCellIdentifier } from "./formula";
+import { createSheetDraft } from "./immer-utils";
+export var processSideEffectDependentCells = function (_a) {
+    var e_1, _b;
+    var _c, _d, _e, _f;
+    var draft = _a.draft, rowIndex = _a.rowIndex, columnIndex = _a.columnIndex, sheetId = _a.sheetId, _g = _a.destinationSheetId, destinationSheetId = _g === void 0 ? sheetId : _g, getDependents = _a.getDependents, _h = _a.getSheetName, getSheetName = _h === void 0 ? function () { return ""; } : _h, enqueueCalculation = _a.enqueueCalculation, enqueueGraphOperation = _a.enqueueGraphOperation, recalcCells = _a.recalcCells, _j = _a.columnDelta, columnDelta = _j === void 0 ? 0 : _j, _k = _a.rowDelta, rowDelta = _k === void 0 ? 0 : _k, sourceRange = _a.sourceRange, movedKeys = _a.movedKeys, locale = _a.locale, rowCount = _a.rowCount, columnCount = _a.columnCount, cellXfsRegistry = _a.cellXfsRegistry, sharedStringRegistry = _a.sharedStringRegistry;
+    // Create a cell
+    var sheetCell = new SheetCell();
+    try {
+        // const movedKeys = new Set<string>();
+        for (var _l = __values(getDependents({
+            rowIndex: rowIndex,
+            columnIndex: columnIndex,
+            sheetId: sheetId,
+        })), _m = _l.next(); !_m.done; _m = _l.next()) {
+            var dependent = _m.value;
+            // Ignore staitc nodes
+            if (isStaticNode(dependent)) {
+                enqueueCalculation === null || enqueueCalculation === void 0 ? void 0 : enqueueCalculation({
+                    position: {
+                        rowIndex: rowIndex,
+                        columnIndex: columnIndex,
+                        sheetId: sheetId,
+                    },
+                    type: "dirty",
+                });
+                // Add to recalc
+                // Add to recalc cells
+                recalcCells.set(createSheetCellIdentifier(sheetId, rowIndex, columnIndex), {
+                    sheetId: sheetId,
+                    rowIndex: rowIndex,
+                    columnIndex: columnIndex,
+                });
+                continue;
+            }
+            var position = dependent.position;
+            var activeSheetName = getSheetName(position.sheetId);
+            var currentSheet_1 = createSheetDraft(draft, position.sheetId, position.rowIndex);
+            var cellData_1 = (_d = (_c = currentSheet_1[position.rowIndex]) === null || _c === void 0 ? void 0 : _c.values) === null || _d === void 0 ? void 0 : _d[position.columnIndex];
+            // Create a cell
+            sheetCell.assign(position.sheetId, {
+                rowIndex: position.rowIndex,
+                columnIndex: position.columnIndex,
+            }, cellData_1, { locale: locale, cellXfsRegistry: cellXfsRegistry, sharedStringRegistry: sharedStringRegistry });
+            var newRowIndex_1 = position.rowIndex +
+                (typeof rowDelta === "function" ? rowDelta(rowIndex) : rowDelta);
+            var newColumnIndex_1 = position.columnIndex +
+                (typeof columnDelta === "function" ? columnDelta(rowIndex) : columnDelta);
+            if (!movedKeys.has(sheetCell.key) && sheetCell.isFormula()) {
+                // Cater to range values that has already been updated
+                movedKeys.add(sheetCell.key);
+                var previousFormula = sheetCell.formula;
+                // Move formulas
+                sheetCell.moveFormula({
+                    rowIndex: position.rowIndex,
+                    columnIndex: position.columnIndex,
+                }, {
+                    rowIndex: newRowIndex_1,
+                    columnIndex: newColumnIndex_1,
+                }, activeSheetName, {
+                    exclusionRange: sourceRange,
+                    rowCount: rowCount,
+                    columnCount: columnCount,
+                });
+                // Check if formula is a table reference
+                var enqueueOperation = sheetCell.ephemeral()
+                    ? enqueueCalculation
+                    : enqueueGraphOperation;
+                var movedInsideSource = isCellWithinBounds(position, sourceRange);
+                if (movedInsideSource) {
+                    enqueueOperation === null || enqueueOperation === void 0 ? void 0 : enqueueOperation({
+                        type: "add",
+                        position: {
+                            sheetId: position.sheetId,
+                            rowIndex: newRowIndex_1,
+                            columnIndex: newColumnIndex_1,
+                        },
+                        previousPosition: position,
+                    });
+                }
+                else {
+                    enqueueOperation === null || enqueueOperation === void 0 ? void 0 : enqueueOperation({
+                        type: "add",
+                        position: position,
+                    });
+                }
+                enqueueCalculation === null || enqueueCalculation === void 0 ? void 0 : enqueueCalculation({
+                    type: "dirty",
+                    position: movedInsideSource
+                        ? {
+                            sheetId: position.sheetId,
+                            rowIndex: newRowIndex_1,
+                            columnIndex: newColumnIndex_1,
+                        }
+                        : position,
+                    force: true,
+                });
+                // Add to recalc cells
+                recalcCells.set(createSheetCellIdentifier(position.sheetId, position.rowIndex, position.columnIndex), 
+                // @Todo Check if it requires force: true
+                position);
+                // Add to recalc cells
+                recalcCells.set(createSheetCellIdentifier(position.sheetId, newRowIndex_1, newColumnIndex_1), {
+                    sheetId: position.sheetId,
+                    rowIndex: newRowIndex_1,
+                    columnIndex: newColumnIndex_1,
+                });
+                if (previousFormula !== sheetCell.formula) {
+                    // Set cell data
+                    currentSheet_1[position.rowIndex].values[position.columnIndex] =
+                        sheetCell.getCellData();
+                }
+            }
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (_m && !_m.done && (_b = _l.return)) _b.call(_l);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    // Trigger recalc for current formula cells
+    var newRowIndex = rowIndex + (typeof rowDelta === "function" ? rowDelta(rowIndex) : rowDelta);
+    var newColumnIndex = columnIndex +
+        (typeof columnDelta === "function" ? columnDelta(rowIndex) : columnDelta);
+    var currentSheet = createSheetDraft(draft, sheetId, rowIndex);
+    var cellData = (_f = (_e = currentSheet[rowIndex]) === null || _e === void 0 ? void 0 : _e.values) === null || _f === void 0 ? void 0 : _f[columnIndex];
+    // Create a cell
+    sheetCell.assign(sheetId, { rowIndex: rowIndex, columnIndex: columnIndex }, cellData, { locale: locale });
+    if (!movedKeys.has(sheetCell.key) && sheetCell.isFormula()) {
+        var activeSheetName = getSheetName(sheetId);
+        // Cater to range values that has already been updated
+        movedKeys.add(sheetCell.key);
+        var previousFormula = sheetCell.formula;
+        sheetCell.moveFormula({
+            rowIndex: rowIndex,
+            columnIndex: columnIndex,
+        }, {
+            rowIndex: newRowIndex,
+            columnIndex: newColumnIndex,
+        }, activeSheetName, {
+            exclusionRange: sourceRange,
+            rowCount: rowCount,
+            columnCount: columnCount,
+        });
+        if (previousFormula !== sheetCell.formula) {
+            // Set cell data
+            currentSheet[rowIndex].values[columnIndex] = sheetCell.getCellData();
+        }
+        // Check if formula is a table reference
+        var enqueueOperation = sheetCell.ephemeral()
+            ? enqueueCalculation
+            : enqueueGraphOperation;
+        // Remove old formula
+        enqueueOperation === null || enqueueOperation === void 0 ? void 0 : enqueueOperation({
+            type: "add",
+            position: {
+                sheetId: destinationSheetId,
+                rowIndex: newRowIndex,
+                columnIndex: newColumnIndex,
+            },
+            previousPosition: {
+                sheetId: sheetId,
+                rowIndex: rowIndex,
+                columnIndex: columnIndex,
+            },
+        });
+        // Add to recalc cells
+        recalcCells.set(createSheetCellIdentifier(sheetId, rowIndex, columnIndex), {
+            sheetId: sheetId,
+            rowIndex: rowIndex,
+            columnIndex: columnIndex,
+        });
+        // // Add to recalc cells
+        recalcCells.set(createSheetCellIdentifier(destinationSheetId, newRowIndex, newColumnIndex), {
+            sheetId: destinationSheetId,
+            rowIndex: newRowIndex,
+            columnIndex: newColumnIndex,
+        });
+    }
+};
+// Collect unique dependents for a given source range to avoid processing the same
+// dependent multiple times when a large range shifts.
+export var collectUniqueDependentsForRange = function (params) {
+    var e_2, _a;
+    var _b, _c, _d;
+    var draft = params.draft, sheetId = params.sheetId, sourceRange = params.sourceRange, getDependents = params.getDependents;
+    var dependentMap = new Map();
+    var startRow = Math.max(1, sourceRange.startRowIndex);
+    var endRow = sourceRange.endRowIndex;
+    for (var rowIndex = startRow; rowIndex <= endRow; rowIndex++) {
+        var row = (_b = draft[sheetId]) === null || _b === void 0 ? void 0 : _b[rowIndex];
+        var dataColumnCount = (_d = (_c = row === null || row === void 0 ? void 0 : row.values) === null || _c === void 0 ? void 0 : _c.length) !== null && _d !== void 0 ? _d : 0;
+        var startCol = Math.min(Math.max(sourceRange.startColumnIndex, 1), dataColumnCount);
+        var endCol = Math.min(sourceRange.endColumnIndex, dataColumnCount);
+        for (var columnIndex = startCol; columnIndex <= endCol; columnIndex++) {
+            try {
+                for (var _e = (e_2 = void 0, __values(getDependents({
+                    sheetId: sheetId,
+                    rowIndex: rowIndex,
+                    columnIndex: columnIndex,
+                }))), _f = _e.next(); !_f.done; _f = _e.next()) {
+                    var dependent = _f.value;
+                    if (isStaticNode(dependent))
+                        continue;
+                    var pos = dependent.position;
+                    var key = SheetCell.generateCellKey(pos.sheetId, pos.rowIndex, pos.columnIndex);
+                    if (!dependentMap.has(key)) {
+                        dependentMap.set(key, {
+                            sheetId: pos.sheetId,
+                            rowIndex: pos.rowIndex,
+                            columnIndex: pos.columnIndex,
+                        });
+                    }
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (_f && !_f.done && (_a = _e.return)) _a.call(_e);
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+        }
+    }
+    return dependentMap;
+};
+// Process a single formula move at a specific position with the specified deltas.
+export var moveFormulaAtPosition = function (_a) {
+    var _b, _c;
+    var draft = _a.draft, position = _a.position, destinationSheetId = _a.destinationSheetId, activeSheetName = _a.activeSheetName, enqueueCalculation = _a.enqueueCalculation, enqueueGraphOperation = _a.enqueueGraphOperation, recalcCells = _a.recalcCells, movedKeys = _a.movedKeys, _d = _a.rowDelta, rowDelta = _d === void 0 ? 0 : _d, _e = _a.columnDelta, columnDelta = _e === void 0 ? 0 : _e, sourceRange = _a.sourceRange, locale = _a.locale, rowCount = _a.rowCount, columnCount = _a.columnCount, cellXfsRegistry = _a.cellXfsRegistry, sharedStringRegistry = _a.sharedStringRegistry;
+    var sheetCell = new SheetCell();
+    var currentSheet = createSheetDraft(draft, position.sheetId, position.rowIndex);
+    var cellData = (_c = (_b = currentSheet[position.rowIndex]) === null || _b === void 0 ? void 0 : _b.values) === null || _c === void 0 ? void 0 : _c[position.columnIndex];
+    sheetCell.assign(position.sheetId, { rowIndex: position.rowIndex, columnIndex: position.columnIndex }, cellData, { locale: locale, cellXfsRegistry: cellXfsRegistry, sharedStringRegistry: sharedStringRegistry });
+    if (!movedKeys.has(sheetCell.key) && sheetCell.isFormula()) {
+        movedKeys.add(sheetCell.key);
+        var previousFormula = sheetCell.formula;
+        var newRowIndex = position.rowIndex + rowDelta;
+        var newColumnIndex = position.columnIndex + columnDelta;
+        var resolvedSheetName = activeSheetName !== null && activeSheetName !== void 0 ? activeSheetName : "";
+        sheetCell.moveFormula({ rowIndex: position.rowIndex, columnIndex: position.columnIndex }, { rowIndex: newRowIndex, columnIndex: newColumnIndex }, resolvedSheetName, {
+            exclusionRange: sourceRange,
+            rowCount: rowCount,
+            columnCount: columnCount,
+        });
+        if (previousFormula !== sheetCell.formula) {
+            // Set cell data at old position (formula updated prior to structural move)
+            currentSheet[position.rowIndex].values[position.columnIndex] =
+                sheetCell.getCellData();
+        }
+        var enqueuOperation = sheetCell.ephemeral()
+            ? enqueueCalculation
+            : enqueueGraphOperation;
+        // Recompute graph for old and new positions
+        enqueuOperation === null || enqueuOperation === void 0 ? void 0 : enqueuOperation({ type: "remove", position: position });
+        enqueuOperation === null || enqueuOperation === void 0 ? void 0 : enqueuOperation({
+            type: "add",
+            position: {
+                sheetId: destinationSheetId !== null && destinationSheetId !== void 0 ? destinationSheetId : position.sheetId,
+                rowIndex: newRowIndex,
+                columnIndex: newColumnIndex,
+            },
+            previousPosition: position,
+        });
+        // Recalc marks
+        recalcCells.set(createSheetCellIdentifier(position.sheetId, position.rowIndex, position.columnIndex), position);
+        recalcCells.set(createSheetCellIdentifier(destinationSheetId !== null && destinationSheetId !== void 0 ? destinationSheetId : position.sheetId, newRowIndex, newColumnIndex), {
+            sheetId: destinationSheetId !== null && destinationSheetId !== void 0 ? destinationSheetId : position.sheetId,
+            rowIndex: newRowIndex,
+            columnIndex: newColumnIndex,
+        });
+    }
+};

package/dist/cjs/api/fill.d.ts

@@ -0,0 +1,88 @@
+import type { SelectionArea } from "@rowsncolumns/common-types";
+import type { GridRange } from "@rowsncolumns/common-types";
+import { Direction } from "@rowsncolumns/common-types";
+import type { SelectionAttributes } from "@rowsncolumns/spreadsheet";
+import type { CellData } from "@rowsncolumns/spreadsheet";
+import type { CanvasGridProps } from "@rowsncolumns/spreadsheet";
+import type { Draft } from "immer";
+import type { CellXfsRegistry } from "../hooks/use-cellxfs-registry";
+import type { useSheetProperties } from "../hooks/use-sheet-properties";
+export type AutoFillType = "FillCopy" | "FillCustomList" | "FillDays" | "FillDefault" | "FillFormats" | "FillMonths" | "FillSeries" | "FillValues" | "FillWeekdays" | "FillYears" | "FlashFill" | "GrowthTrend" | "LinearTrend";
+/**
+ * User-defined autofill lists. Each list is an array of strings that
+ * the autofill engine treats as a cyclic sequence — e.g. starting from
+ * "Mon" with `customAutofillLists: [["Mon","Tue","Wed","Thu","Fri",
+ * "Sat","Sun"]]` and dragging down produces Tue, Wed, Thu, ...
+ *
+ * Excel stores these in the user's profile (Excel Options), not in the
+ * workbook, so they don't round-trip through xlsx by design.
+ */
+export type CustomAutofillList = string[];
+export type GetAutoFillValuesProps<T extends CellData> = {
+    /**
+     * Sheet ID
+     */
+    sheetId: number;
+    /**
+     * Direction user is trying to fill
+     * import { Direction } from "@rowsncolumns/common-types";
+     */
+    direction: Direction;
+    /**
+     * Current user selection
+     */
+    selection: SelectionArea<SelectionAttributes>;
+    /**
+     * Area user is trying to fill
+     */
+    fillBounds: GridRange;
+    /**
+     * Get cell data of a sheet
+     */
+    getCellData: NonNullable<CanvasGridProps<T>["getCellData"]>;
+    /**
+     * Get effective value of a cell
+     */
+    getEffectiveValue: NonNullable<CanvasGridProps<T>["getEffectiveValue"]>;
+    /**
+     * Get formatted value of a cell
+     */
+    getFormattedValue: NonNullable<CanvasGridProps<T>["getFormattedValue"]>;
+    getSheetName(sheetId: number): string;
+    /**
+     * Active locale of the data
+     */
+    locale?: string;
+    /**
+     * Cell format registry
+     */
+    cellXfsRegistry?: CellXfsRegistry;
+    /**
+     * Auto fill type - if not specified, will auto-detect
+     */
+    fillType?: AutoFillType;
+    /**
+     * User-defined autofill lists. When the selection matches a
+     * contiguous slice of one of these lists, the fill cycles through
+     * the list instead of running other heuristics.
+     */
+    customAutofillLists?: CustomAutofillList[];
+    /**
+     * Data validation
+     */
+    getDataValidationById?: ReturnType<typeof useSheetProperties>["getDataValidationById"];
+};
+/**
+ * Detect the fill type based on selection data
+ */
+export declare const detectFillType: (selectionData: (string | number | boolean | Date | undefined | null)[][], locale?: string, customAutofillLists?: CustomAutofillList[]) => AutoFillType;
+/**
+ * Generate fill values based on type and pattern
+ */
+export declare const generateFillValues: (sourceValues: any[], fillType: AutoFillType, count: number, locale?: string, customAutofillLists?: CustomAutofillList[]) => any[];
+/**
+ * Get auto fill values
+ * @returns T[][]
+ */
+export declare const getAutoFillValues: <T extends CellData>({ sheetId, direction, selection, fillBounds, getCellData, getEffectiveValue, getFormattedValue, getSheetName, getDataValidationById, cellXfsRegistry, locale, fillType, customAutofillLists, }: GetAutoFillValuesProps<T>) => Promise<(T | string | number | null | undefined | Draft<T>)[][]>;
+//# sourceMappingURL=fill.d.ts.map

package/dist/cjs/api/fill.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fill.d.ts","sourceRoot":"","sources":["../../../api/fill.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAGjE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAGxE,MAAM,MAAM,YAAY,GACpB,UAAU,GACV,gBAAgB,GAChB,UAAU,GACV,aAAa,GACb,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,cAAc,GACd,WAAW,GACX,WAAW,GACX,aAAa,GACb,aAAa,CAAC;AAElB;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,EAAE,CAAC;AAE1C,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,QAAQ,IAAI;IACvD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,SAAS,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;IAC9C;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;IAC5D;;OAEG;IACH,iBAAiB,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACxE;;OAEG;IACH,iBAAiB,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACxE,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC3C;;OAEG;IACH,qBAAqB,CAAC,EAAE,UAAU,CAChC,OAAO,kBAAkB,CAC1B,CAAC,uBAAuB,CAAC,CAAC;CAC5B,CAAC;AAqSF;;GAEG;AACH,eAAO,MAAM,cAAc,GACzB,eAAe,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,CAAC,EAAE,EAAE,EACxE,eAAa,EACb,sBAAsB,kBAAkB,EAAE,KACzC,YA6KF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,GAC7B,cAAc,GAAG,EAAE,EACnB,UAAU,YAAY,EACtB,OAAO,MAAM,EACb,SAAS,MAAM,EACf,sBAAsB,kBAAkB,EAAE,KACzC,GAAG,EAqTL,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAU,CAAC,SAAS,QAAQ,EAAE,gMAczD,sBAAsB,CAAC,CAAC,CAAC,KAAG,OAAO,CACpC,CAAC,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAyiBxD,CAAC"}