@fileverse-dev/dsheet 2.0.33-comment → 2.0.33-rtc

package/dist/editor/components/collab-status-chip.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+import { CollabState } from '../../sync-local/types';
+
+interface Props {
+    state: CollabState;
+}
+export declare const CollabStatusChip: React.FC<Props>;
+export {};

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

@@ -2,6 +2,8 @@ import { default as React } from 'react';
 import { LiveQueryData, Sheet, WorkbookInstance } from '../../sheet-engine/react';
 import { IndexeddbPersistence } from 'y-indexeddb';
 import { DataBlockApiKeyHandlerType, SheetUpdateData } from '../types';
+import { CollaborationProps, CollabState } from '../../sync-local/types';
+import { Awareness } from 'y-protocols/awareness';
 
 import * as Y from 'yjs';
 export interface EditorContextType {
@@ -35,10 +37,13 @@ export interface EditorContextType {
     loading: boolean;
     forceSheetRender: number;
     setForceSheetRender: React.Dispatch<React.SetStateAction<number>>;
-    activeUsers: string[];
-    collaborationStatus: 'disconnected' | 'connecting' | 'connected' | 'error';
     syncStatus: 'initializing' | 'syncing' | 'synced' | 'error';
-    isCollaborative?: boolean;
+    collabState?: CollabState;
+    isCollabReady?: boolean;
+    isCollabSyncing?: boolean;
+    hasCollabContentInitialised?: boolean;
+    awareness?: Awareness | null;
+    terminateSession?: () => void;
     handleLiveQuery: (subsheetIndex: number, data: LiveQueryData) => void;
 }
 interface EditorProviderProps {
@@ -53,11 +58,10 @@ interface EditorProviderProps {
     username?: string;
     portalContent?: string;
     enableIndexeddbSync?: boolean;
-    enableWebrtc?: boolean;
     isReadOnly?: boolean;
     onChange?: (data: SheetUpdateData, encodedUpdate?: string) => void;
+    collaboration?: CollaborationProps;
     externalEditorRef?: React.MutableRefObject<WorkbookInstance | null>;
-    isCollaborative?: boolean;
     commentData?: object;
     editorStateRef?: React.MutableRefObject<{
         refreshIndexedDB: () => Promise<void>;

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, allowSheetDownload, 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;
+declare const SpreadsheetEditor: ({ isReadOnly, allowSheetDownload, allowComments, renderNavbar, enableIndexeddbSync, dsheetId, portalContent, onChange, username, selectedTemplate, toggleTemplateSidebar, isTemplateOpen, 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, collaboration, }: DsheetProps) => JSX.Element;
 export default SpreadsheetEditor;

package/dist/editor/hooks/use-collab-awareness.d.ts

@@ -0,0 +1,11 @@
+import { Awareness } from 'y-protocols/awareness';
+import { WorkbookInstance } from '../../sheet-engine/react';
+
+/**
+ * Reads remote cursor positions from Yjs awareness and keeps Fortune sheet's
+ * native presence list in sync. Fortune renders colored cell borders + username
+ * labels automatically via context.presences[].
+ */
+export declare const useCollabAwareness: (awareness: Awareness | null | undefined, sheetEditorRef: React.MutableRefObject<WorkbookInstance | null>) => {
+    localColor: string;
+};

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

@@ -14,7 +14,7 @@ export declare const useEditorData: (ydocRef: React.MutableRefObject<Y.Doc | nul
     [key: string]: {
         [key: string]: any;
     };
-}>>, enableLiveQuery?: boolean, liveQueryRefreshRate?: number, dataBlockApiKeyHandler?: DataBlockApiKeyHandlerType, allowComments?: boolean) => {
+}>>, enableLiveQuery?: boolean, liveQueryRefreshRate?: number, dataBlockApiKeyHandler?: DataBlockApiKeyHandlerType, allowComments?: boolean, hasCollabContentInitialised?: boolean) => {
     sheetData: Sheet[];
     setSheetData: import('react').Dispatch<import('react').SetStateAction<Sheet[]>>;
     currentDataRef: import('react').MutableRefObject<Sheet[]>;

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

@@ -1,13 +1,16 @@
 import { IndexeddbPersistence } from 'y-indexeddb';
+import { CollaborationProps } from '../../sync-local/types';
 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) => {
+export declare const useEditorSync: (dsheetId: string, enableIndexeddbSync?: boolean, isReadOnly?: boolean, collaboration?: CollaborationProps, onCollabUpdate?: (fullState: string, updateChunk: string) => void) => {
     ydocRef: import('react').MutableRefObject<Y.Doc | null>;
     persistenceRef: import('react').MutableRefObject<IndexeddbPersistence | null>;
-    syncStatus: "error" | "initializing" | "syncing" | "synced";
+    syncStatus: "error" | "syncing" | "initializing" | "synced";
     isSyncedRef: import('react').MutableRefObject<boolean>;
     refreshIndexedDB: () => Promise<void>;
+    collabState: import('../..').CollabState;
+    isCollabReady: boolean;
+    isCollabSyncing: boolean;
+    terminateSession: () => void;
+    awareness: import('y-protocols/awareness.js').Awareness | null;
+    hasCollabContentInitialised: boolean;
 };

package/dist/editor/types.d.ts

@@ -2,6 +2,7 @@ import { Sheet, Workbook, WorkbookInstance, Cell } from '../sheet-engine/react';
 import { ComponentProps, RefObject } from 'react';
 import { ERROR_MESSAGES_FLAG } from './constants/shared-constants';
 import { SmartContractQueryHandler } from './utils/after-update-cell';
+import { CollaborationProps } from '../sync-local/types';
 
 import * as Y from 'yjs';
 export interface SheetUpdateData {
@@ -55,13 +56,12 @@ export interface DsheetProps {
     enableIndexeddbSync?: boolean;
     dsheetId: string;
     onChange?: (updateData: SheetUpdateData, encodedUpdate?: string) => void;
+    collaboration?: CollaborationProps;
     username?: string;
-    enableWebrtc?: boolean;
     portalContent?: string;
     isReadOnly?: boolean;
     allowSheetDownload?: boolean;
     isTemplateOpen?: boolean;
-    isCollaborative?: boolean;
     selectedTemplate?: string;
     onboardingComplete?: boolean;
     /** When `onboardingComplete` is omitted, read `localStorage.getItem(key)==='true'` (default key `onboardingComplete`). */