@fileverse-dev/dsheet 2.0.36-shortcut-2 → 2.1.0

package/dist/{constants-CnhOvijG.js → constants-yStXQJiK.js}

@@ -1,5 +1,5 @@
-import { E as e, S as t } from "./crypto-constants-CqpCRs86.js";
-const o = e, a = t, l = [
+import { E as n, S as a } from "./crypto-constants-CqpCRs86.js";
+const E = n, d = a, f = [
   {
     id: "0",
     name: "Sheet1",
@@ -9,7 +9,7 @@ const o = e, a = t, l = [
     row: 500,
     column: 26
   }
-], c = [
+], m = [
   "undo",
   "redo",
   "format-painter",
@@ -47,7 +47,7 @@ const o = e, a = t, l = [
   "quick-formula",
   "dataVerification",
   "search"
-], n = [
+], u = [
   "cut",
   "copy",
   "paste",
@@ -84,7 +84,7 @@ const o = e, a = t, l = [
   "freeze-row",
   "|",
   "clear-format"
-], i = [
+], S = [
   "cut",
   "copy",
   "paste",
@@ -121,20 +121,41 @@ const o = e, a = t, l = [
   "freeze-column",
   "|",
   "clear-format"
-], s = {
+], _ = {
   height: null,
   isShow: !1,
   left: null,
   top: null,
   value: "",
   width: null
-};
+}, l = "#5298FF", r = [
+  "#30bced",
+  "#6eeb83",
+  "#fa69d1",
+  "#ecd444",
+  "#ee6352",
+  "#db3041",
+  "#0ad7f2",
+  "#1bff39"
+];
+function c(e) {
+  return r[e % r.length];
+}
+function i() {
+  return "#" + Math.floor(Math.random() * 16777215).toString(16).padStart(6, "0");
+}
+function h(e, o, t) {
+  return e ? l : o ?? (t != null ? c(t) : i());
+}
 export {
-  s as C,
-  l as D,
-  o as E,
-  i as H,
-  a as S,
-  c as T,
-  n as a
+  _ as C,
+  f as D,
+  E,
+  S as H,
+  d as S,
+  m as T,
+  r as a,
+  u as b,
+  l as c,
+  h as p
 };

package/dist/constants.d.ts

@@ -1 +1,5 @@
 export { ERROR_MESSAGES_FLAG, SERVICES_API_KEY, } from './editor/constants/shared-constants';
+export declare const ENS_PRESENCE_COLOR = "#5298FF";
+export declare const COLLAB_PRESENCE_COLORS: readonly ["#30bced", "#6eeb83", "#fa69d1", "#ecd444", "#ee6352", "#db3041", "#0ad7f2", "#1bff39"];
+/** ENS brand color, else `color`, else palette by `clientId`, else random. */
+export declare function presenceColor(isEns: boolean | undefined, color?: string, clientId?: number): string;

package/dist/constants.js

@@ -1,5 +1,8 @@
-import { E as R, S as _ } from "./constants-CnhOvijG.js";
+import { a as R, c as _, E as C, S as a, p as s } from "./constants-yStXQJiK.js";
 export {
-  R as ERROR_MESSAGES_FLAG,
-  _ as SERVICES_API_KEY
+  R as COLLAB_PRESENCE_COLORS,
+  _ as ENS_PRESENCE_COLOR,
+  C as ERROR_MESSAGES_FLAG,
+  a as SERVICES_API_KEY,
+  s as presenceColor
 };

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, CollabUser } from '../../sync-local/types';
+import { Awareness } from 'y-protocols/awareness';
 
 import * as Y from 'yjs';
 export interface EditorContextType {
@@ -35,10 +37,16 @@ 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;
+    collabEnabled?: boolean;
+    collabIsOwner?: boolean;
+    collabState?: CollabState;
+    isCollabReady?: boolean;
+    isCollabSyncing?: boolean;
+    hasCollabContentInitialised?: boolean;
+    awareness?: Awareness | null;
+    terminateSession?: () => void;
+    onCollaboratorsChange?: (collaborators: CollabUser[]) => void;
     handleLiveQuery: (subsheetIndex: number, data: LiveQueryData) => void;
 }
 interface EditorProviderProps {
@@ -53,14 +61,16 @@ 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>;
+        terminateSession?: () => void;
+        updateCollaboratorName?: (name: string) => void;
+        rehydrateAfterCollabSync?: (reason?: string) => boolean;
     } | null>;
     enableLiveQuery?: boolean;
     liveQueryRefreshRate?: number;

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,17 @@
+import { Awareness } from 'y-protocols/awareness';
+import { WorkbookInstance } from '../../sheet-engine/react';
+import { CollabUser } from '../../sync-local/types';
+
+/**
+ * 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[].
+ *
+ * Also emits the full collaborator list (including the local user) via
+ * `onCollaboratorsChange` so host apps can render navbar chips. This mirrors
+ * ddoc's editor-layer awareness handler, which maps awareness.states →
+ * `{ clientId, ...user }` and fires on every awareness update + once on mount.
+ */
+export declare const useCollabAwareness: (awareness: Awareness | null | undefined, sheetEditorRef: React.MutableRefObject<WorkbookInstance | null>, onCollaboratorsChange?: (collaborators: CollabUser[]) => void) => {
+    localColor: "#30bced" | "#6eeb83" | "#fa69d1" | "#ecd444" | "#ee6352" | "#db3041" | "#0ad7f2" | "#1bff39";
+};

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, collabEnabled?: boolean) => {
     sheetData: Sheet[];
     setSheetData: import('react').Dispatch<import('react').SetStateAction<Sheet[]>>;
     currentDataRef: import('react').MutableRefObject<Sheet[]>;
@@ -24,4 +24,5 @@ export declare const useEditorData: (ydocRef: React.MutableRefObject<Y.Doc | nul
     handleChange: (_data: Sheet[]) => void;
     handleLiveQuery: (subsheetIndex: number, queryData: import('../../sheet-engine/react').LiveQueryData) => void;
     initialiseLiveQueryData: (sheets: Sheet[]) => void;
+    rehydrateWorkbookFromYdoc: (reason?: string) => boolean;
 };

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`). */

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

@@ -41,7 +41,19 @@ interface AfterUpdateCellParams {
             [key: string]: any;
         };
     };
+    collabEnabled?: boolean;
+    collabIsOwner?: boolean;
+    remoteUpdateRef?: React.MutableRefObject<boolean>;
+    localUserEditRef?: React.MutableRefObject<boolean>;
 }
+/** True when data-block formulas (API / smart contract) should run for this edit. */
+export declare const shouldExecuteDataBlocks: (params: {
+    collabEnabled?: boolean;
+    collabIsOwner?: boolean;
+    remoteUpdateRef?: React.MutableRefObject<boolean>;
+    localUserEditRef?: React.MutableRefObject<boolean>;
+    sheetEditorRef: React.RefObject<WorkbookInstance | null>;
+}) => boolean;
 export declare const isDatablockError: (value: any) => boolean;
 /**
  * Handles logic after a cell is updated, including processing formula results

package/dist/editor/utils/formula-ui-sync.d.ts

@@ -7,10 +7,12 @@ export type FormulaSyncType = {
     apiData: Array<Record<string, object>> | Array<Array<string>>;
     sheetEditorRef: React.RefObject<WorkbookInstance | null>;
     shouldIgnoreUsdValue?: boolean;
+    /** Instruction lines rendered above the formula table (synced to Yjs). */
+    staticLinesAbove?: string[];
 };
 export declare function isUsdValue(str: string): boolean;
 export declare const USD_FA: string;
-export declare const formulaResponseUiSync: ({ row, column, newValue, apiData, sheetEditorRef, shouldIgnoreUsdValue, }: FormulaSyncType) => void;
+export declare const formulaResponseUiSync: ({ row, column, newValue, apiData, sheetEditorRef, shouldIgnoreUsdValue, staticLinesAbove, }: FormulaSyncType) => void;
 export declare const getCellClone: (r: number, c: number, sheetEditorRef: React.RefObject<WorkbookInstance | null>) => {
     v?: string | number | boolean;
     m?: string | number;

package/dist/editor/utils/remote-apply-guard.d.ts

@@ -0,0 +1,19 @@
+import { MutableRefObject } from 'react';
+
+/**
+ * Scoped guard for RTC remote → local apply.
+ *
+ * `remoteUpdateRef` used to stay true for seconds (holdRemoteApplyLock), which
+ * blocked real user metadata writes via guardRemoteEcho. Depth tracks only the
+ * synchronous remote-apply window (plus one paint for structural remounts).
+ */
+export type RemoteApplyGuardRefs = {
+    remoteApplyDepthRef: MutableRefObject<number>;
+    remoteUpdateRef: MutableRefObject<boolean>;
+};
+export declare function syncRemoteUpdateFlag(refs: RemoteApplyGuardRefs): void;
+export declare function beginRemoteApply(refs: RemoteApplyGuardRefs): void;
+export declare function endRemoteApply(refs: RemoteApplyGuardRefs): void;
+export declare function runUnderRemoteApply(refs: RemoteApplyGuardRefs, fn: () => void): void;
+/** End after Workbook remount hooks have flushed (2 rAF ≈ one paint). */
+export declare function endRemoteApplyAfterPaint(refs: RemoteApplyGuardRefs): void;