@fileverse-dev/ddoc 4.2.3 → 4.2.4-patch-0

package/dist/package/sync-local/types/index.d.ts

@@ -7,6 +7,64 @@ export interface CollabConnectionConfig {
     roomId: string;
     wsUrl: string;
     isOwner: boolean;
+    /** Host signal: doc is in an active live-collaboration context (shared / peers present). Keeps the socket connected. */
+    livePresence?: boolean;
+    /** Host signal: connect once on open to initialise durability even without an edit. */
+    connectOnOpen?: boolean;
+    /** Host signal (owner-only): the owner identity signingKey DID. Recorded by the durable server on the first owner /auth as the R3 owner binding. */
+    ownerIdentityDid?: string;
+    /** Host signal (owner-only): wrapped roomKey bytes (owner-lock construction), uploaded as the server editLock recovery artifact. Opaque to the package. */
+    editLock?: string;
+    /** Host signal (owner-only): the document title encrypted with the roomKey, uploaded as the server title recovery artifact. Opaque to the package. */
+    encryptedTitle?: string;
+    /** Host signal (owner-only): Ed25519 UCAN proving the owner identity, sent on /auth so the server binds the CRYPTOGRAPHICALLY PROVEN owner DID (not a bare asserted string). Opaque to the package. */
+    identityToken?: string;
+    /** Host signal (owner-only): the identity contract address the server reads to resolve the on-chain signingDid that verifies identityToken. */
+    identityContractAddress?: string;
+    /** Host signal (non-owner editor): the gate-minted edit-admission UCAN, forwarded on /auth so the
+     *  server admits this connection as a GP-rail editor. Opaque to the package. */
+    editUcan?: string;
+    /** Host signal (non-owner editor): re-mints a CURRENT-epoch editUcan. Called at every /auth
+     *  (incl. reconnect after a force-drop). Tri-state: `ok` (fresh token; overrides the static
+     *  `editUcan`), `demoted` (no longer an editor → terminal, drop to viewer), or `unavailable`
+     *  (transient/network → retry on the last-good claim). Opaque to the package. */
+    refreshEditClaim?: () => Promise<{
+        status: 'ok';
+        token: string;
+    } | {
+        status: 'demoted';
+    } | {
+        status: 'unavailable';
+    }>;
+    /** Host signal: resolves the rotated roomKey for the given epoch payload (GP: gate release
+     *  unwrap of `gp`; workspace: app-key unwrap of `appLock`). Returns the new base64 roomKey —
+     *  or, for a gate-admitted editor, `{ roomKey, editUcan }`: the same gate release that unwraps
+     *  the relay also mints the new-epoch editUcan, and the cutover re-auth must present THAT token
+     *  (a re-mint through the host's fresh-open flow can race the deferred publish and hand back a
+     *  stale-epoch claim). `null` if this actor can't resolve it (falls back to the decrypt-miss
+     *  self-heal path). Opaque to the package. */
+    onRotationPrepare?: (inner: {
+        epoch: number;
+        gp: string;
+        appLock?: string;
+    }) => Promise<string | {
+        roomKey: string;
+        editUcan?: string;
+    } | null>;
+    /** Host signal: an anonymous per-connection actor handle (public rail). Record-only; opaque. */
+    actorHandle?: string;
+    /** Host signal (non-creator workspace member): join-only. The server never creates or
+     *  binds a session for this connection and caps the role at editor; every handshake
+     *  rejection resolves to a quiet terminated state ('ROOM_NOT_ESTABLISHED' when the room
+     *  was never established, 'JOIN_REJECTED' otherwise) instead of an error. */
+    joinOnly?: boolean;
+    /** Host signal (editor): produces the view-plane mirror ciphertext from the live Yjs state. The app
+     *  AES-GCM-encrypts `{ file: base64(yjsUpdate), source }` under the fileKey in the publish wire
+     *  format. Absent ⇒ the mirror is not written. The package never sees the fileKey or the crypto. */
+    encryptMirror?: (yjsUpdate: Uint8Array) => Promise<string>;
+    /** Host signal: the fileKey's rotation epoch (the gate `currentEpoch` / fileKey version — NOT
+     *  `editGrantEpoch`; default 0 for non-rotating plain-public docs). */
+    fileKeyEpoch?: number;
     ownerEdSecret?: string;
     contractAddress?: string;
     ownerAddress?: string;
@@ -21,18 +79,14 @@ export interface CollabSessionMeta {
     username: string;
     isEns?: boolean;
 }
-/** Storage integrations the sync engine depends on */
-export interface CollabServices {
-    commitToStorage?: (file: File) => Promise<string>;
-    fetchFromStorage?: (cid: string) => Promise<any>;
-}
+export type CollabServices = Record<string, never>;
 export type CollabErrorCode = 'CONNECTION_FAILED' | 'AUTH_FAILED' | 'SYNC_FAILED' | 'TIMEOUT' | 'UNKNOWN';
 export type CollabError = {
     code: CollabErrorCode;
     message: string;
     recoverable: boolean;
 };
-export type CollabStatus = 'idle' | 'connecting' | 'syncing' | 'ready' | 'reconnecting' | 'error' | 'terminated';
+export type CollabStatus = 'idle' | 'connecting' | 'syncing' | 'ready' | 'reconnecting' | 'rotating' | 'error' | 'terminated';
 export type CollabState = {
     status: 'idle';
 } | {
@@ -46,6 +100,10 @@ export type CollabState = {
     status: 'reconnecting';
     attempt: number;
     maxAttempts: number;
+}
+/** roomKey migration in flight — distinct from `terminated` so consumers don't mistake it for a kick. */
+ | {
+    status: 'rotating';
 } | {
     status: 'error';
     error: CollabError;
@@ -74,6 +132,10 @@ export type CollabEvent = {
 } | {
     type: 'SESSION_TERMINATED';
     reason?: string;
+}
+/** roomKey cutover in progress; no-op on status — lets the manager gate re-entrancy itself. */
+ | {
+    type: 'CUTOVER';
 } | {
     type: 'RESET';
 };
@@ -93,6 +155,13 @@ export interface CollabCallbacks {
         data: AckResponse;
         roomKey: string;
     }) => void;
+    /** Live rename from the room owner; title is roomKey-encrypted. */
+    onTitleUpdate?: (encryptedTitle: string | null) => void;
+    /** Decrypt-miss self-heal: resolves the CURRENT-epoch roomKey (same resolution the host
+     *  uses for `onRotationPrepare`, minus the relay payload — re-read the blob's
+     *  `wrappedRoomKey` / appLock). Returns the new base64 roomKey, or `null` if this actor
+     *  can't resolve one (the miss is then a real revocation, not a rotation lag). */
+    onRotationSelfHeal?: () => Promise<string | null>;
 }
 /** Discriminated union — TypeScript enforces config+services only when enabled */
 export type CollaborationProps = {
@@ -127,7 +196,10 @@ export declare enum ServerErrorCode {
     INVALID_ADDRESS = "INVALID_ADDRESS",
     NOT_AUTHENTICATED = "NOT_AUTHENTICATED",
     DB_ERROR = "DB_ERROR",
-    INTERNAL_ERROR = "INTERNAL_ERROR"
+    INTERNAL_ERROR = "INTERNAL_ERROR",
+    JOIN_DISABLED = "JOIN_DISABLED",
+    EDIT_REVOKED = "EDIT_REVOKED",
+    ROOM_NOT_ESTABLISHED = "ROOM_NOT_ESTABLISHED"
 }
 export interface AckResponse<T = Record<string, any>> {
     status: boolean;
@@ -145,11 +217,30 @@ export interface SendUpdateResponse extends AckResponse<{
     createdAt: number;
 }> {
 }
-export interface CommitResponse extends AckResponse<{
-    cid: string;
-    createdAt: number;
+export interface HydrationRow {
+    id: string;
     documentId: string;
-    updates: string[];
+    seq: number;
+    data: string;
+    updateType: string;
+    committed?: boolean;
+    commitCid?: string | null;
+    createdAt?: number;
+    sessionDid?: string;
+    publishedMarker?: string | null;
+    floorSeq?: number | null;
+}
+export interface HydrationResponse extends AckResponse<{
+    history: HydrationRow[];
+    total: number;
+    snapshot: HydrationRow | null;
+    nextSeq: number | null;
+    hasMore: boolean;
+}> {
+}
+export interface SnapshotResponse extends AckResponse<{
+    id: string;
+    seq: number;
 }> {
 }
 export interface ISocketInitConfig {
@@ -157,7 +248,7 @@ export interface ISocketInitConfig {
     onDisconnect: () => void;
     onSocketDropped: () => void;
     onError: (err: Error) => void;
-    onHandShakeError: (err: Error, statusCode?: number) => void;
+    onHandShakeError: (err: Error, statusCode?: number, errorCode?: ServerErrorCode) => void;
     onContentUpdate: (data: {
         id: string;
         data: string;
@@ -171,6 +262,8 @@ export interface ISocketInitConfig {
         };
         roomId: string;
     }) => void;
+    onPresenceChange?: (collaborators: IDocCollabUsers[]) => void;
+    onTitleUpdate?: (encryptedTitle: string | null) => void;
     onSessionTerminated: (data: {
         roomId: string;
     }) => void;
@@ -196,4 +289,10 @@ export interface IAuthArgs {
     contractAddress?: string;
     sessionDid?: string;
     roomInfo?: string;
+    ownerIdentityDid?: string;
+    identityToken?: string;
+    identityContractAddress?: string;
+    editUcan?: string;
+    actorHandle?: string;
+    joinOnly?: boolean;
 }

package/dist/package/sync-local/useSyncManager.d.ts

@@ -5,6 +5,10 @@ export declare const useSyncManager: (config: SyncManagerConfig) => {
     connect: (connectConfig: CollabConnectionConfig) => void;
     disconnect: () => void;
     terminateSession: () => void;
+    updateTitle: (args: {
+        encryptedTitle: string;
+        documentTitle: string;
+    }) => void;
     isReady: boolean;
     isSyncing: boolean;
     awareness: import('y-protocols/awareness.js').Awareness | null;

package/dist/package/types.d.ts

@@ -9,10 +9,11 @@ import { CollaborationProps } from './sync-local/types';
 export type { CollaborationProps, CollabConnectionConfig, CollabSessionMeta, CollabServices, CollabCallbacks, CollabState, CollabError, CollabErrorCode, CollabStatus, } from './sync-local/types';
 export declare const DdocEditorProps: EditorProps;
 export interface IDocCollabUsers {
-    clientId: number;
+    clientId: string | number;
     name: string;
     isEns: string;
     color: string;
+    isPlaceholder?: boolean;
 }
 export type InlineCommentData = {
     inlineCommentText: string;

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

@@ -28,8 +28,13 @@ export declare const useDdocEditor: ({ isPreviewMode, viewerMode, initialContent
     duplicateTab: (tabId: string) => string | undefined;
     orderTab: (destinationTabId: string, movedTabId: string) => void;
     onConnect: (connectConfig: import('./types').CollabConnectionConfig) => void;
+    onDisconnect: () => void;
     isReady: boolean;
     isSyncing: boolean;
+    updateTitle: (args: {
+        encryptedTitle: string;
+        documentTitle: string;
+    }) => void;
     hasCollabContentInitialised: boolean;
     isIndexeddbSynced: boolean;
     initialiseYjsIndexedDbProvider: () => Promise<void>;

package/dist/{split-view-toolbar-fzF0a8Qb.mjs → split-view-toolbar-CXCPVdyq.mjs}

@@ -1,7 +1,7 @@
-import { j as d } from "./index-DU4ChFqp.mjs";
+import { j as d } from "./index-CsZ0zljP.mjs";
 import { useRef as I, useState as N, useEffect as D } from "react";
 import { DynamicDropdown as E, Tooltip as R, IconButton as O } from "@fileverse/ui";
-import { a3 as A, a4 as P, c as y } from "./index-B59aQPXt.mjs";
+import { a3 as A, a4 as P, c as y } from "./index-Dehs4zRZ.mjs";
 const p = (e, t, o = t) => {
   const { state: s } = e, l = s.changeByRange((n) => {
     const u = s.sliceDoc(n.from, n.to), r = s.sliceDoc(

package/package.json

@@ -2,7 +2,7 @@
   "name": "@fileverse-dev/ddoc",
   "private": false,
   "description": "DDoc",
-  "version": "4.2.3",
+  "version": "4.2.4-patch-0",
   "main": "dist/index.es.js",
   "module": "dist/index.es.js",
   "exports": {
@@ -121,7 +121,6 @@
     "y-indexeddb": "^9.0.12",
     "y-prosemirror": "^1.2.5",
     "y-protocols": "^1.0.6",
-    "y-webrtc": "^10.3.0",
     "yjs": "^13.6.15",
     "zustand": "^5.0.12"
   },
@@ -167,4 +166,4 @@
     "vite": "^5.0.0",
     "vitest": "^2.1.0"
   }
-}
+}