@fileverse-dev/dsheet 0.0.14 → 0.0.16

package/dist/package/components/api-key-modal.d.ts

@@ -0,0 +1,13 @@
+import { default as React } from 'react';
+
+/**
+ * ApiKeyModal component
+ *
+ * A modal dialog that prompts users to name their document before sharing it
+ */
+export declare const ApiKeyModal: ({ openApiKeyModal, setOpenApiKeyModal, openApiKeyModalRef, contextApiKeyName, }: {
+    openApiKeyModal: boolean;
+    setOpenApiKeyModal: React.Dispatch<React.SetStateAction<boolean>>;
+    openApiKeyModalRef: React.MutableRefObject<boolean>;
+    contextApiKeyName: React.MutableRefObject<string | null>;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/package/components/onboarding.d.ts

@@ -0,0 +1,5 @@
+import { WorkbookInstance } from '@fileverse-dev/fortune-react';
+
+export declare const OnboardingUI: ({ sheetEditorRef, }: {
+    sheetEditorRef: React.RefObject<WorkbookInstance | null>;
+}) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,4 +1,11 @@
-import { DsheetProp } from './types';
+import { DsheetProps } from './types';
 
-declare const SpreadsheetEditor: import('react').ForwardRefExoticComponent<DsheetProp & import('react').RefAttributes<unknown>>;
+/**
+ * SpreadsheetEditor component that provides a collaborative spreadsheet interface
+ * with various import/export capabilities and template support.
+ *
+ * @param props - Component properties
+ * @returns The SpreadsheetEditor component
+ */
+declare const SpreadsheetEditor: ({ isCollaborative, isReadOnly, renderNavbar, initialSheetData, enableIndexeddbSync, dsheetId, portalContent, onChange, username, selectedTemplate, toggleTemplateSidebar, isTemplateOpen, enableWebrtc, sheetEditorRef: externalSheetEditorRef, }: DsheetProps) => JSX.Element;
 export default SpreadsheetEditor;

package/dist/package/hooks/use-sheet-data.d.ts

@@ -0,0 +1,9 @@
+import { Sheet } from '@fileverse-dev/fortune-core';
+import { SheetUpdateData } from '../types';
+import * as Y from 'yjs';
+export declare const useSheetData: (ydoc: Y.Doc | null, dsheetId: string, onChange?: (updateData: SheetUpdateData, encodedUpdate?: string) => void) => {
+    sheetData: Sheet[] | null;
+    setSheetData: import('react').Dispatch<import('react').SetStateAction<Sheet[] | null>>;
+    currentDataRef: import('react').MutableRefObject<Sheet[] | null>;
+    remoteUpdateRef: import('react').MutableRefObject<boolean>;
+};

package/dist/package/hooks/use-webrtc-connection.d.ts

@@ -0,0 +1,7 @@
+import { WebsocketProvider } from 'y-websocket';
+import { Awareness } from 'y-protocols/awareness';
+import * as Y from 'yjs';
+export declare const useWebRTCConnection: (ydoc: Y.Doc | null, dsheetId: string, username: string, enableWebrtc: boolean, portalContent: string) => {
+    webrtcProviderRef: import('react').MutableRefObject<WebsocketProvider | null>;
+    awarenessRef: import('react').MutableRefObject<Awareness | null>;
+};

package/dist/package/hooks/use-yjs-document.d.ts

@@ -0,0 +1,6 @@
+import { IndexeddbPersistence } from 'y-indexeddb';
+import * as Y from 'yjs';
+export declare const useYjsDocument: (dsheetId: string, enableIndexeddbSync: boolean, isReadOnly?: boolean) => {
+    ydocRef: import('react').MutableRefObject<Y.Doc | null>;
+    persistenceRef: import('react').MutableRefObject<IndexeddbPersistence | null>;
+};

package/dist/package/types.d.ts

@@ -1,11 +1,22 @@
 import { Sheet } from '@fileverse-dev/fortune-core';
+import { RefObject } from 'react';
+import { WorkbookInstance } from '@fileverse-dev/fortune-react';
 
-export interface DsheetProp {
-    renderNavbar?: () => JSX.Element;
+import * as Y from 'yjs';
+export interface SheetUpdateData {
+    data: Sheet[];
+}
+export interface EditorValues {
+    sheetEditorRef: RefObject<WorkbookInstance>;
+    currentDataRef: React.MutableRefObject<Sheet[] | null>;
+    ydocRef: React.RefObject<Y.Doc | null>;
+}
+export interface DsheetProps {
+    renderNavbar?: (editorValues?: EditorValues) => JSX.Element;
     initialSheetData?: Sheet[];
     enableIndexeddbSync?: boolean;
     dsheetId: string;
-    onChange?: (updatedSheetContent: string, updateChunk: string) => void;
+    onChange?: (updateData: SheetUpdateData, encodedUpdate?: string) => void;
     username?: string;
     enableWebrtc?: boolean;
     portalContent?: string;
@@ -15,4 +26,5 @@ export interface DsheetProp {
     selectedTemplate?: string;
     setForceSheetRender?: React.Dispatch<React.SetStateAction<number>>;
     toggleTemplateSidebar?: () => void;
+    sheetEditorRef?: RefObject<WorkbookInstance>;
 }

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

@@ -1,7 +1,8 @@
 import { Sheet } from '@fileverse-dev/fortune-core';
-import { DsheetProp } from './types';
+import { DsheetProps } from './types';
+
 import * as Y from 'yjs';
-export declare const useDsheetEditor: ({ initialSheetData, enableIndexeddbSync, dsheetId, onChange, username, enableWebrtc, portalContent, }: Partial<DsheetProp>) => {
+export declare const useDsheetEditor: ({ enableIndexeddbSync, dsheetId, onChange, username, enableWebrtc, portalContent, sheetEditorRef: externalSheetEditorRef, initialSheetData, setForceSheetRender, isReadOnly, }: Partial<DsheetProps>) => {
     sheetEditorRef: import('react').RefObject<{
         applyOp: (ops: import('@fileverse-dev/fortune-core').Op[]) => void;
         getCellValue: (row: number, column: number, options?: import('@fileverse-dev/fortune-core/dist/api').CommonOptions & {

package/dist/package/utils/after-update-cell.d.ts

@@ -1,4 +1,17 @@
 import { Cell } from '@fileverse-dev/fortune-core';
 import { WorkbookInstance } from '@fileverse-dev/fortune-react';
 
-export declare const afterUpdateCell: (row: number, column: number, oldValue: Cell, newValue: Cell, sheetEditorRef: React.RefObject<WorkbookInstance | null>) => void;
+/**
+ * Handles logic after a cell is updated, including processing formula results
+ *
+ * @param row - The row index of the updated cell
+ * @param column - The column index of the updated cell
+ * @param oldValue - The previous value of the cell
+ * @param newValue - The new value of the cell
+ * @param sheetEditorRef - Reference to the workbook instance
+ * @param setOpenApiKeyModal - Function to set the API key modal open state
+ * @param openApiKeyModalRef - Ref object tracking if the API key modal is open
+ * @param contextApiKeyName - Ref object for the current API key name context
+ * @returns {Promise<void>}
+ */
+export declare const afterUpdateCell: (row: number, column: number, oldValue: Cell, newValue: Cell, sheetEditorRef: React.RefObject<WorkbookInstance | null>, setOpenApiKeyModal: React.Dispatch<React.SetStateAction<boolean>>, openApiKeyModalRef: React.MutableRefObject<boolean>, contextApiKeyName: React.MutableRefObject<string | null>) => Promise<void>;

package/dist/package/utils/sheet-operations.d.ts

@@ -0,0 +1,5 @@
+import { Sheet } from '@fileverse-dev/fortune-core';
+import { WorkbookInstance } from '@fileverse-dev/fortune-react';
+import * as Y from 'yjs';
+export declare const updateSheetData: (ydoc: Y.Doc | null, dsheetId: string, data: Sheet[], sheetEditor: WorkbookInstance | null) => void;
+export declare const formatSheetData: (data: Sheet[], preSheetArray: Sheet[], sheetEditor: WorkbookInstance) => Sheet[];