@fileverse-dev/dsheet 0.0.22 → 0.0.24

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

@@ -0,0 +1,20 @@
+import { default as React } from 'react';
+import { OnboardingHandlerType, DataBlockApiKeyHandlerType } from '../types';
+
+type OnboardingHandler = OnboardingHandlerType;
+type DataBlockApiKeyHandler = DataBlockApiKeyHandlerType;
+interface EditorWorkbookProps {
+    isReadOnly?: boolean;
+    toggleTemplateSidebar?: () => void;
+    onboardingComplete?: boolean;
+    onboardingHandler?: OnboardingHandler;
+    dataBlockApiKeyHandler?: DataBlockApiKeyHandler;
+    exportDropdownOpen?: boolean;
+    setExportDropdownOpen?: React.Dispatch<React.SetStateAction<boolean>>;
+    dsheetId: string;
+}
+/**
+ * EditorWorkbook component handles rendering the Fortune Workbook with proper configuration
+ */
+export declare const EditorWorkbook: React.FC<EditorWorkbookProps>;
+export {};

package/dist/package/components/skeleton-loader.d.ts

@@ -0,0 +1,6 @@
+export declare const SkeletonToolbar: () => import("react/jsx-runtime").JSX.Element;
+export declare const SkeletonGrid: () => import("react/jsx-runtime").JSX.Element;
+declare const SkeletonLoader: ({ isReadOnly, }: {
+    isReadOnly: boolean | undefined;
+}) => import("react/jsx-runtime").JSX.Element;
+export default SkeletonLoader;

package/dist/package/contexts/editor-context.d.ts

@@ -0,0 +1,39 @@
+import { default as React } from 'react';
+import { Sheet } from '@fileverse-dev/fortune-core';
+import { WorkbookInstance } from '@fileverse-dev/fortune-react';
+import { IndexeddbPersistence } from 'y-indexeddb';
+import { SheetUpdateData } from '../types';
+
+import * as Y from 'yjs';
+export interface EditorContextType {
+    sheetEditorRef: React.MutableRefObject<WorkbookInstance | null>;
+    ydocRef: React.MutableRefObject<Y.Doc | null>;
+    persistenceRef: React.MutableRefObject<IndexeddbPersistence | null>;
+    sheetData: Sheet[];
+    setSheetData: React.Dispatch<React.SetStateAction<Sheet[]>>;
+    currentDataRef: React.MutableRefObject<Sheet[]>;
+    remoteUpdateRef: React.MutableRefObject<boolean>;
+    handleChange: (data: Sheet[]) => void;
+    loading: boolean;
+    forceSheetRender: number;
+    setForceSheetRender: React.Dispatch<React.SetStateAction<number>>;
+    activeUsers: string[];
+    collaborationStatus: 'disconnected' | 'connecting' | 'connected' | 'error';
+    syncStatus: 'initializing' | 'syncing' | 'synced' | 'error';
+    isCollaborative?: boolean;
+}
+interface EditorProviderProps {
+    children: React.ReactNode;
+    dsheetId: string;
+    username?: string;
+    portalContent?: string;
+    enableIndexeddbSync?: boolean;
+    enableWebrtc?: boolean;
+    isReadOnly?: boolean;
+    onChange?: (data: SheetUpdateData, encodedUpdate?: string) => void;
+    externalEditorRef?: React.MutableRefObject<WorkbookInstance | null>;
+    isCollaborative?: boolean;
+}
+export declare const EditorProvider: React.FC<EditorProviderProps>;
+export declare const useEditor: () => EditorContextType;
+export {};

package/dist/package/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, renderNavbar, initialSheetData, enableIndexeddbSync, dsheetId, portalContent, onChange, username, selectedTemplate, toggleTemplateSidebar, isTemplateOpen, enableWebrtc, onboardingComplete, onboardingHandler, sheetEditorRef: externalSheetEditorRef, }: DsheetProps) => JSX.Element;
+declare const SpreadsheetEditor: ({ isCollaborative, isReadOnly, renderNavbar, enableIndexeddbSync, dsheetId, portalContent, onChange, username, selectedTemplate, toggleTemplateSidebar, isTemplateOpen, enableWebrtc, onboardingComplete, onboardingHandler, dataBlockApiKeyHandler, sheetEditorRef: externalSheetEditorRef, }: DsheetProps) => JSX.Element;
 export default SpreadsheetEditor;

package/dist/package/hooks/use-editor-collaboration.d.ts

@@ -0,0 +1,9 @@
+import * as Y from 'yjs';
+/**
+ * Hook for setting up WebRTC-based collaboration
+ * Handles real-time synchronization between peers
+ */
+export declare const useEditorCollaboration: (ydoc: Y.Doc | null, dsheetId: string, username?: string, enableWebrtc?: boolean, signalData?: string) => {
+    collaborationStatus: "error" | "disconnected" | "connecting" | "connected";
+    activeUsers: string[];
+};

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

@@ -0,0 +1,16 @@
+import { Sheet } from '@fileverse-dev/fortune-core';
+import { WorkbookInstance } from '@fileverse-dev/fortune-react';
+
+import * as Y from 'yjs';
+/**
+ * Hook for managing sheet data
+ * Handles initialization, updates, and persistence of sheet data
+ */
+export declare const useEditorData: (ydocRef: React.MutableRefObject<Y.Doc | null>, dsheetId: string, sheetEditorRef: React.MutableRefObject<WorkbookInstance | null>, setForceSheetRender?: React.Dispatch<React.SetStateAction<number>>, portalContent?: string, isReadOnly?: boolean, onChange?: (data: Sheet[]) => void, syncStatus?: "initializing" | "syncing" | "synced" | "error") => {
+    sheetData: Sheet[];
+    setSheetData: import('react').Dispatch<import('react').SetStateAction<Sheet[]>>;
+    currentDataRef: import('react').MutableRefObject<Sheet[]>;
+    remoteUpdateRef: import('react').MutableRefObject<boolean>;
+    isDataLoaded: boolean;
+    handleChange: (data: Sheet[]) => void;
+};

package/dist/package/hooks/use-editor-sync.d.ts

@@ -0,0 +1,12 @@
+import { IndexeddbPersistence } from 'y-indexeddb';
+import * as Y from 'yjs';
+/**
+ * Hook for setting up YJS document and persistence
+ * Handles initialization of YJS document and optional IndexedDB persistence
+ */
+export declare const useEditorSync: (dsheetId: string, enableIndexeddbSync?: boolean, isReadOnly?: boolean) => {
+    ydocRef: import('react').MutableRefObject<Y.Doc | null>;
+    persistenceRef: import('react').MutableRefObject<IndexeddbPersistence | null>;
+    syncStatus: "initializing" | "syncing" | "synced" | "error";
+    isSyncedRef: import('react').MutableRefObject<boolean>;
+};

package/dist/package/types.d.ts

@@ -1,4 +1,4 @@
-import { Sheet } from '@fileverse-dev/fortune-core';
+import { Sheet, Cell } from '@fileverse-dev/fortune-core';
 import { RefObject } from 'react';
 import { WorkbookInstance } from '@fileverse-dev/fortune-react';
 
@@ -11,9 +11,31 @@ export interface EditorValues {
     currentDataRef: React.MutableRefObject<Sheet[] | null>;
     ydocRef: React.RefObject<Y.Doc | null>;
 }
+export type OnboardingHandlerType = (params: {
+    row: number;
+    column: number;
+    sheetEditorRef: React.RefObject<WorkbookInstance | null>;
+}) => {
+    row: number;
+    column: number;
+};
+export type DataBlockApiKeyHandlerType = (params: {
+    data: string;
+    sheetEditorRef: React.RefObject<WorkbookInstance | null>;
+    executeStringFunction: (functionCallString: string) => Promise<unknown>;
+    row: number;
+    column: number;
+    newValue: Cell;
+    formulaResponseUiSync: (params: {
+        row: number;
+        column: number;
+        newValue: Record<string, string>;
+        apiData: Array<Record<string, object>>;
+        sheetEditorRef: React.RefObject<WorkbookInstance | null>;
+    }) => void;
+}) => void;
 export interface DsheetProps {
     renderNavbar?: (editorValues?: EditorValues) => JSX.Element;
-    initialSheetData?: Sheet[];
     enableIndexeddbSync?: boolean;
     dsheetId: string;
     onChange?: (updateData: SheetUpdateData, encodedUpdate?: string) => void;
@@ -25,7 +47,8 @@ export interface DsheetProps {
     isCollaborative?: boolean;
     selectedTemplate?: string;
     onboardingComplete?: boolean;
-    onboardingHandler?: Function;
+    onboardingHandler?: OnboardingHandlerType;
+    dataBlockApiKeyHandler?: DataBlockApiKeyHandlerType;
     setForceSheetRender?: React.Dispatch<React.SetStateAction<number>>;
     toggleTemplateSidebar?: () => void;
     sheetEditorRef?: RefObject<WorkbookInstance>;

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

@@ -1,6 +1,15 @@
 import { Cell } from '@fileverse-dev/fortune-core';
 import { WorkbookInstance } from '@fileverse-dev/fortune-react';
+import { OnboardingHandlerType, DataBlockApiKeyHandlerType } from '../types';
 
+export type FormulaSyncType = {
+    row: number;
+    column: number;
+    newValue: Record<string, string>;
+    apiData: Array<Record<string, object>>;
+    sheetEditorRef: React.RefObject<WorkbookInstance | null>;
+};
+export declare const formulaResponseUiSync: ({ row, column, newValue, apiData, sheetEditorRef, }: FormulaSyncType) => void;
 /**
  * Handles logic after a cell is updated, including processing formula results
  *
@@ -9,19 +18,15 @@ import { WorkbookInstance } from '@fileverse-dev/fortune-react';
  * @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
+ * @param onboardingHandler - Function to handle onboarding from consumer side
  * @returns {Promise<void>}
  */
-export declare const afterUpdateCell: ({ row, column, newValue, sheetEditorRef, setOpenApiKeyModal, openApiKeyModalRef, contextApiKeyName, onboardingComplete, onboardingHandler, }: {
+export declare const afterUpdateCell: ({ row, column, newValue, sheetEditorRef, onboardingComplete, onboardingHandler, dataBlockApiKeyHandler, }: {
     row: number;
     column: number;
     newValue: Cell;
     sheetEditorRef: React.RefObject<WorkbookInstance | null>;
-    setOpenApiKeyModal: React.Dispatch<React.SetStateAction<boolean>>;
-    openApiKeyModalRef: React.MutableRefObject<boolean>;
-    contextApiKeyName: React.MutableRefObject<string | null>;
     onboardingComplete: boolean | undefined;
-    onboardingHandler: Function | undefined;
+    onboardingHandler: OnboardingHandlerType | undefined;
+    dataBlockApiKeyHandler: DataBlockApiKeyHandlerType | undefined;
 }) => Promise<void>;