@fileverse-dev/dsheet 2.0.27 → 2.0.29

package/dist/editor/components/editor-workbook.d.ts

@@ -14,6 +14,7 @@ interface EditorWorkbookProps {
     allowComments?: boolean;
     toggleTemplateSidebar?: () => void;
     onboardingComplete?: boolean;
+    onboardingCompleteLocalStorageKey?: string;
     onboardingHandler?: OnboardingHandler;
     dataBlockApiKeyHandler?: DataBlockApiKeyHandler;
     exportDropdownOpen?: boolean;

package/dist/editor/dsheet-editor.d.ts

@@ -7,5 +7,5 @@ import { DsheetProps } from './types';
  * @param props - Component properties
  * @returns The SpreadsheetEditor component
  */
-declare const SpreadsheetEditor: ({ isCollaborative, isReadOnly, allowComments, renderNavbar, enableIndexeddbSync, dsheetId, portalContent, onChange, username, selectedTemplate, toggleTemplateSidebar, isTemplateOpen, enableWebrtc, onboardingComplete, onboardingHandler, commentData, getCommentCellUI, dataBlockApiKeyHandler, setFetchingURLData, setShowFetchURLModal, setInputFetchURLDataBlock, sheetEditorRef: externalSheetEditorRef, storeApiKey, onDuneChartEmbed, onSheetCountChange, onDataBlockApiResponse, isAuthorized, getDocumentTitle, updateDocumentTitle, setShowSmartContractModal, editorStateRef, handleSmartContractQuery, setSelectedTemplate, isNewSheet, liveQueryRefreshRate, enableLiveQuery, }: DsheetProps) => JSX.Element;
+declare const SpreadsheetEditor: ({ isCollaborative, isReadOnly, allowComments, renderNavbar, enableIndexeddbSync, dsheetId, portalContent, onChange, username, selectedTemplate, toggleTemplateSidebar, isTemplateOpen, enableWebrtc, onboardingComplete, onboardingCompleteLocalStorageKey, onboardingHandler, commentData, getCommentCellUI, dataBlockApiKeyHandler, setFetchingURLData, setShowFetchURLModal, setInputFetchURLDataBlock, sheetEditorRef: externalSheetEditorRef, storeApiKey, onDuneChartEmbed, onSheetCountChange, onDataBlockApiResponse, isAuthorized, getDocumentTitle, updateDocumentTitle, setShowSmartContractModal, editorStateRef, handleSmartContractQuery, setSelectedTemplate, isNewSheet, liveQueryRefreshRate, enableLiveQuery, }: DsheetProps) => JSX.Element;
 export default SpreadsheetEditor;

package/dist/editor/hooks/use-apply-templates.d.ts

@@ -2,8 +2,9 @@ import { Dispatch, SetStateAction } from 'react';
 import { Sheet, WorkbookInstance } from '../../sheet-engine/react';
 
 import * as Y from 'yjs';
-export declare const useApplyTemplatesBtn: ({ selectedTemplate, ydocRef, dsheetId, currentDataRef, setForceSheetRender, sheetEditorRef, setDataBlockCalcFunction, initialiseLiveQueryData, }: {
+export declare const useApplyTemplatesBtn: ({ selectedTemplate, setSelectedTemplate, ydocRef, dsheetId, currentDataRef, setForceSheetRender, sheetEditorRef, setDataBlockCalcFunction, initialiseLiveQueryData, }: {
     selectedTemplate: string | undefined;
+    setSelectedTemplate?: React.Dispatch<React.SetStateAction<string>> | ((slug: string | null) => void);
     ydocRef: React.RefObject<Y.Doc | null>;
     dsheetId: string;
     currentDataRef: React.MutableRefObject<object | null>;

package/dist/editor/hooks/use-xlsx-import-impl.d.ts

@@ -0,0 +1,16 @@
+import { default as React } from 'react';
+import { WorkbookInstance } from '../../sheet-engine/react';
+
+import * as Y from 'yjs';
+export type XlsxImportRuntimeDeps = {
+    sheetEditorRef: React.RefObject<WorkbookInstance | null>;
+    ydocRef: React.RefObject<Y.Doc | null>;
+    setForceSheetRender: React.Dispatch<React.SetStateAction<number>>;
+    dsheetId: string;
+    currentDataRef: React.MutableRefObject<object | null>;
+    updateDocumentTitle?: (title: string) => void;
+    filterToastShown: boolean;
+    setFilterToastShown: React.Dispatch<React.SetStateAction<boolean>>;
+};
+/** Full XLSX import pipeline; loaded only when user imports a file. */
+export declare function runXlsxFileUpload({ sheetEditorRef, ydocRef, setForceSheetRender, dsheetId, currentDataRef, updateDocumentTitle, filterToastShown, setFilterToastShown, }: XlsxImportRuntimeDeps, event: React.ChangeEvent<HTMLInputElement> | undefined, fileArg: File, importType?: 'new-dsheet' | 'merge-current-dsheet' | 'new-current-dsheet'): Promise<void>;

package/dist/editor/hooks/use-xlsx-import.d.ts

@@ -1,14 +1,20 @@
-import { default as React } from 'react';
+import { ChangeEvent, Dispatch, MutableRefObject, RefObject, SetStateAction } from 'react';
 import { WorkbookInstance } from '../../sheet-engine/react';
 
-import * as Y from 'yjs';
+import type * as Y from 'yjs';
+type ImportType = 'new-dsheet' | 'merge-current-dsheet' | 'new-current-dsheet';
+/**
+ * XLSX import: keeps ~100k+ LOC (SSF, hyperlink helpers, exceljs/luckyexcel orchestration)
+ * in a separate chunk until the user actually imports a file.
+ */
 export declare const useXLSXImport: ({ sheetEditorRef, ydocRef, setForceSheetRender, dsheetId, currentDataRef, updateDocumentTitle, }: {
-    sheetEditorRef: React.RefObject<WorkbookInstance | null>;
-    ydocRef: React.RefObject<Y.Doc | null>;
-    setForceSheetRender: React.Dispatch<React.SetStateAction<number>>;
+    sheetEditorRef: RefObject<WorkbookInstance | null>;
+    ydocRef: RefObject<Y.Doc | null>;
+    setForceSheetRender: Dispatch<SetStateAction<number>>;
     dsheetId: string;
-    currentDataRef: React.MutableRefObject<object | null>;
+    currentDataRef: MutableRefObject<object | null>;
     updateDocumentTitle?: (title: string) => void;
 }) => {
-    handleXLSXUpload: (event: React.ChangeEvent<HTMLInputElement> | undefined, fileArg: File, importType?: "new-dsheet" | "merge-current-dsheet" | "new-current-dsheet") => Promise<void>;
+    handleXLSXUpload: (event: ChangeEvent<HTMLInputElement> | undefined, fileArg: File, importType?: ImportType) => Promise<void>;
 };
+export {};

package/dist/editor/types.d.ts

@@ -63,6 +63,8 @@ export interface DsheetProps {
     isCollaborative?: boolean;
     selectedTemplate?: string;
     onboardingComplete?: boolean;
+    /** When `onboardingComplete` is omitted, read `localStorage.getItem(key)==='true'` (default key `onboardingComplete`). */
+    onboardingCompleteLocalStorageKey?: string;
     onboardingHandler?: OnboardingHandlerType;
     dataBlockApiKeyHandler?: DataBlockApiKeyHandlerType;
     setForceSheetRender?: React.Dispatch<React.SetStateAction<number>>;

package/dist/editor/utils/xlsx-export-impl.d.ts

@@ -0,0 +1,4 @@
+import { WorkbookInstance } from '../../sheet-engine/react';
+import { MutableRefObject } from 'react';
+import * as Y from 'yjs';
+export declare const handleExportToXLSX: (workbookRef: MutableRefObject<WorkbookInstance | null>, ydocRef: MutableRefObject<Y.Doc | null>, dsheetId: string, getDocumentTitle?: (dsheetId: string) => Promise<string>) => Promise<void>;

package/dist/editor/utils/xlsx-export.d.ts

@@ -1,4 +1,8 @@
 import { WorkbookInstance } from '../../sheet-engine/react';
 import { MutableRefObject } from 'react';
 import * as Y from 'yjs';
+/**
+ * Loads xlsx-js-style + exceljs + export helpers only when the user exports.
+ * Keeps the main editor chunk smaller for consuming apps.
+ */
 export declare const handleExportToXLSX: (workbookRef: MutableRefObject<WorkbookInstance | null>, ydocRef: MutableRefObject<Y.Doc | null>, dsheetId: string, getDocumentTitle?: (dsheetId: string) => Promise<string>) => Promise<void>;