@fileverse-dev/dsheet 4.0.4 → 4.0.5

package/dist/editor/components/sidebar/use-right-panels.d.ts

@@ -1,4 +1,4 @@
-export type BuiltInPanelType = 'templates' | 'comments' | 'functions' | 'data-verification' | 'conditional-format';
+export type BuiltInPanelType = 'templates' | 'comments' | 'functions' | 'data-verification' | 'conditional-format' | 'named-ranges';
 export type PanelId = BuiltInPanelType | string;
 interface UseRightPanelsReturn {
     activePanel: PanelId | null;

package/dist/editor/components/sidebars/named-ranges.d.ts

@@ -0,0 +1,2 @@
+declare const NamedRanges: () => import("react/jsx-runtime").JSX.Element;
+export { NamedRanges };

package/dist/editor/hooks/use-celldata-compaction.d.ts

@@ -15,9 +15,8 @@ type UseCelldataCompactionArgs = {
     collabSyncing: boolean;
 };
 /**
- * One-shot background compaction: remove committed celldata entries that copy/paste
- * would never write (`shouldPersistCelldataCell` === false). Runs once per dsheetId
- * after the editor is synced and idle so it does not compete with load or edits.
+ * One-shot background compaction (celldata + borderInfo). Completion is stored
+ * on the anchor sheet's config in Yjs so it syncs across devices.
  */
 export declare function useCelldataCompaction({ dsheetId, ydocRef, sheetEditorRef, currentDataRef, handleOnChangePortalUpdate, syncStatus, isDataLoaded, isReadOnly, remoteUpdateRef, collabSyncing, }: UseCelldataCompactionArgs): void;
 export {};

package/dist/editor/utils/compact-committed-celldata.d.ts

@@ -1,15 +1,19 @@
 import { CellMatrix, CellWithRowAndCol, Sheet } from '../../sheet-engine/core/types';
 import { SheetChangePath } from './update-ydoc';
 import * as Y from 'yjs';
-export declare const CELLDATA_COMPACT_STORAGE_KEY_PREFIX = "dsheet-celldata-compact-v1:";
-export type CelldataCompactionResult = {
+/** Celldata + borderInfo compaction; bump when rules change. */
+export declare const SHEET_COMPACTION_REV = 2;
+export declare const SHEET_COMPACTION_CONFIG_KEY = "sheetCompactionRev";
+export type SheetCompactionResult = {
     removedFromYdoc: number;
     clearedInMemory: number;
     changes: SheetChangePath[];
 };
-export declare function celldataCompactStorageKey(dsheetId: string): string;
-export declare function hasCelldataCompactionCompleted(dsheetId: string): boolean;
-export declare function markCelldataCompactionCompleted(dsheetId: string): void;
+export declare function readSheetCompactionRev(config: unknown): number;
+export declare function getAnchorSheet(sheets: Sheet[] | null | undefined): Sheet | null;
+export declare function hasSheetCompactionCompleted(ydoc: Y.Doc, dsheetId: string): boolean;
+export declare function buildCompactionRevChange(ydoc: Y.Doc, dsheetId: string): SheetChangePath | null;
+export declare function markCompactionRevInMemory(sheets: Sheet[] | null | undefined): void;
 /** Collect Yjs celldata keys that should not be persisted (format-only / empty ghosts). */
 export declare function collectStaleCelldataKeys(celldataMap: Y.Map<unknown> | Record<string, unknown> | null | undefined): string[];
 export declare function buildCelldataDeleteChanges(sheetId: string, keys: string[]): SheetChangePath[];
@@ -21,8 +25,5 @@ export declare function compactSheetCelldataArray(celldata: CellWithRowAndCol[]
     removed: number;
 };
 export declare function compactInMemorySheets(sheets: Sheet[] | null | undefined): number;
-/**
- * Scan Y.Doc for committed celldata ghosts. Does not mutate — caller applies
- * `changes` via `updateYdocSheetData`.
- */
-export declare function planYdocCelldataCompaction(ydoc: Y.Doc, dsheetId: string): CelldataCompactionResult;
+/** Scan Y.Doc for committed ghosts. Does not mutate — caller applies `changes`. */
+export declare function planYdocCompaction(ydoc: Y.Doc, dsheetId: string): SheetCompactionResult;

package/dist/editor/utils/defined-names-ydoc.d.ts

@@ -0,0 +1,31 @@
+import { WorkbookInstance } from '../../sheet-engine/react';
+import { DefinedName } from '../../sheet-engine/core/types';
+import { RefObject } from 'react';
+
+import * as Y from 'yjs';
+/** Sibling share key on the same Y.Doc as the sheet array. */
+export declare function getDefinedNamesMapKey(dsheetId: string): string;
+export declare function getDefinedNamesYMap(ydoc: Y.Doc, dsheetId: string): Y.Map<DefinedName>;
+/** Read workbook-level named ranges from Yjs (stable name order). */
+export declare function readDefinedNamesFromYdoc(ydoc: Y.Doc, dsheetId: string): DefinedName[];
+/**
+ * Prefer the sheet `Y.Array` share key when a doc has sibling maps
+ * (e.g. `${dsheetId}:definedNames`).
+ */
+export declare function resolveSheetArrayShareKey(doc: Y.Doc, preferredKey?: string): string | null;
+/**
+ * Diff Context definedNames against the Y.Map and apply set/delete by id.
+ */
+export declare function syncDefinedNamesToYdoc({ ydoc, dsheetId, definedNames, handleContentPortal, }: {
+    ydoc: Y.Doc;
+    dsheetId: string;
+    definedNames: DefinedName[];
+    handleContentPortal?: () => void;
+}): void;
+/** Push current workbook definedNames into Yjs (editor hook target). */
+export declare const definedNamesYdocUpdate: ({ sheetEditorRef, ydocRef, dsheetId, handleContentPortal, }: {
+    sheetEditorRef: RefObject<WorkbookInstance | null>;
+    ydocRef: RefObject<Y.Doc | null>;
+    dsheetId: string;
+    handleContentPortal?: () => void;
+}) => void;

package/dist/editor/utils/import-compaction.d.ts

@@ -0,0 +1,25 @@
+import { Sheet } from '../../sheet-engine/react';
+
+/**
+ * XLSX imports (Google Sheets exports especially) materialize every
+ * styled-but-empty cell. Move those into config.cellFormatRanges — the same
+ * sparse representation the editor uses — so they never inflate celldata/Yjs.
+ * Cells with content, merges, hyperlinks, notes or masks are kept verbatim.
+ */
+export declare function compactImportedSheetFormatting(sheet: Sheet): void;
+/**
+ * Imported validations repeat the full option list + per-option color string
+ * on every covered cell (whole-column dropdowns → thousands of copies). Store
+ * each unique entry once in dataVerificationDefs and keep numeric refs in the
+ * per-cell map; expandSheetDataVerification restores objects for the engine.
+ */
+export declare function internImportedDataVerification(sheet: Sheet): void;
+/**
+ * Resolve interned dataVerification refs back to shared entry objects before
+ * the sheet reaches the engine or the XLSX exporter. No-op (and no mutation)
+ * when the map already holds objects, so live workbook sheets pass through.
+ */
+export declare function expandSheetDataVerification<T extends {
+    dataVerification?: unknown;
+    dataVerificationDefs?: unknown;
+}>(sheet: T): T;

package/dist/editor/utils/xlsx-defined-names.d.ts

@@ -0,0 +1,41 @@
+import { DefinedName } from '../../sheet-engine/core/types';
+
+export type ExcelDefinedNameEntry = {
+    name: string;
+    ranges: string[];
+    localSheetId?: number;
+};
+export declare function isExcelSystemDefinedName(name: string): boolean;
+/** Build Excel loc string: `Sheet1!$A$1:$C$2` (or single cell). */
+export declare function encodeDefinedNameExcelRef(sheetName: string, range: DefinedName['range']): string;
+/**
+ * Parse `Sheet1!$A$1:$B$2` / `'My Sheet'!$A$1` into sheet name + 0-based range.
+ */
+export declare function parseExcelDefinedNameRef(ref: string): {
+    sheetName: string;
+    range: {
+        row: [number, number];
+        column: [number, number];
+    };
+} | null;
+/**
+ * Convert Excel defined-name entries into our DefinedName list.
+ * `sheets` must already have stable ids and names (Excel order).
+ */
+export declare function excelEntriesToDefinedNames(entries: ExcelDefinedNameEntry[], sheets: Array<{
+    id?: string;
+    name?: string;
+}>): DefinedName[];
+/** Write defined names onto an ExcelJS workbook (Pass 2). */
+export declare function applyDefinedNamesToExcelWorkbook(excelWorkbook: {
+    definedNames: {
+        add: (loc: string, name: string) => void;
+    };
+}, definedNames: DefinedName[] | undefined, sheets: Array<{
+    id?: string;
+    name?: string;
+}>): void;
+/**
+ * Parse `<definedNames>` from xl/workbook.xml (keeps localSheetId).
+ */
+export declare function parseDefinedNamesFromXlsxBuffer(arrayBuffer: ArrayBuffer): Promise<ExcelDefinedNameEntry[]>;

package/dist/editor/utils/xlsx-import-pipeline.d.ts

@@ -0,0 +1,28 @@
+import { Sheet } from '../../sheet-engine/react';
+import { ExcelDefinedNameEntry } from './xlsx-defined-names';
+
+export declare function generateImportSheetId(): string;
+export type XlsxImportWarning = {
+    code: 'tables-unsupported';
+} | {
+    code: 'filters-unsupported';
+};
+export type XlsxParseSettings = {
+    /** Workbook default column width in px (from the live workbook settings, if any). */
+    workbookDefaultColWidth?: number;
+    /** Workbook default row height in px (from the live workbook settings, if any). */
+    workbookDefaultRowHeight?: number;
+};
+export type XlsxParsedWorkbook = {
+    /** Decorated + compacted sheets, ready for the ydoc write. */
+    sheets: Sheet[];
+    /** Workbook name from luckyexcel info (extension not yet stripped). */
+    workbookName: string;
+    /** UI warnings to replay on the main thread (toasts/onWarning). */
+    warnings: XlsxImportWarning[];
+    /** Sheet ids this pipeline generated — the caller may remap them with a custom generator. */
+    generatedSheetIds: string[];
+    /** Named ranges from xl/workbook.xml — synced to Yjs on the main thread. */
+    definedNameEntries: ExcelDefinedNameEntry[];
+};
+export declare function parseXlsxWorkbook(file: File, settings?: XlsxParseSettings): Promise<XlsxParsedWorkbook>;