@fileverse-dev/ddoc 3.0.57-patch-5 → 3.0.58-folder-sharing-1

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

@@ -1,108 +1,130 @@
 import { Data } from '../../types';
-import { Awareness } from 'y-protocols/awareness';
+import { SocketClient } from '../socketClient';
 
 import * as Y from 'yjs';
-export declare enum SyncStatus {
-    DISCONNECTED = "disconnected",
-    CONNECTING = "connecting",
-    SYNCING = "syncing",
-    CONNECTED = "connected",
-    PROCESSING = "processing",
-    DISCONNECTING = "disconnecting"
+export interface IRoomMember {
+    userId: string;
+    username: string;
+    role: 'owner' | 'editor';
 }
-export interface SyncManagerConfig {
-    ydoc: Y.Doc;
-    onError?: (e: Error) => void;
-    onCollaborationConnectCallback?: (response: any) => void;
-    onCollaborationCommit?: (file: File) => Promise<string>;
-    onFetchCommitContent?: (cid: string) => Promise<any>;
-    onSessionTerminated?: () => void;
-    onUnMergedUpdates?: (state: boolean) => void;
-    onLocalUpdate?: (updatedDocContent: Data['editorJSONData'], updateChunk: string) => void;
+export interface SendUpdateResponse {
+    data: {
+        agent_id: string;
+        commitCid: string | null;
+        created_at: number;
+        data: string;
+        documentId: string;
+        id: string;
+        update_snapshot_ref: string | null;
+        updateType: string;
+    };
+    is_handshake_response: boolean;
+    status: boolean;
+    statusCode: number;
 }
-export interface ConnectConfig {
-    username?: string;
-    roomKey: string;
-    roomId: string;
-    isOwner: boolean;
-    ownerEdSecret?: string;
-    contractAddress?: string;
-    ownerAddress?: string;
-    isEns?: boolean;
-    wsUrl: string;
-    roomInfo?: {
-        documentTitle: string;
-        portalAddress: string;
-        commentKey: string;
+export interface CommitResponse {
+    data: {
+        agent_id: string;
+        cid: string;
+        created_at: number;
+        data: any | null;
+        documentId: string;
+        updates: string[];
     };
+    is_handshake_response: boolean;
+    status: boolean;
+    statusCode: number;
 }
-export interface SyncManagerSnapshot {
-    status: SyncStatus;
+export interface SyncMachineContext {
+    ydoc: Y.Doc;
+    socketClient: SocketClient | null;
+    roomId: string;
+    username: string;
+    roomMembers: IRoomMember[];
     isConnected: boolean;
+    awareness: any;
+    _awarenessUpdateHandler: (({ added, updated, removed, }: {
+        added: number[];
+        updated: number[];
+        removed: number[];
+    }) => void) | null;
+    onError: ((e: Error) => void) | null;
+    roomKey: string;
+    wsUrl: string;
+    uncommittedUpdatesIdList: string[];
+    isOwner: boolean;
+    updateQueue: Uint8Array[];
     isReady: boolean;
+    isNewDoc: boolean;
+    contentTobeAppliedQueue: string[];
+    initialUpdate: string | null;
+    errorCount: number;
+    errorMaxRetryCount: number;
     errorMessage: string;
-    awareness: Awareness | null;
-    initialDocumentDecryptionState: 'done' | 'pending';
+    initalDocumentDecryptionState: 'done' | 'pending';
+    onCollaborationConnectCallback: (response: any) => void;
+    onCollaborationCommit: (file: File) => Promise<string>;
+    onFetchCommitContent: (cid: string) => Promise<any>;
+    onSessionTerminated: () => void;
+    onUnMergedUpdates: (state: boolean) => void;
+    onLocalUpdate?: (updatedDocContent: Data['editorJSONData'], updateChunk: string) => void;
 }
-export declare enum ServerErrorCode {
-    AUTH_TOKEN_MISSING = "AUTH_TOKEN_MISSING",
-    AUTH_TOKEN_INVALID = "AUTH_TOKEN_INVALID",
-    SESSION_NOT_FOUND = "SESSION_NOT_FOUND",
-    SESSION_TERMINATED = "SESSION_TERMINATED",
-    SESSION_DID_MISSING = "SESSION_DID_MISSING",
-    DOCUMENT_ID_MISSING = "DOCUMENT_ID_MISSING",
-    UPDATE_DATA_MISSING = "UPDATE_DATA_MISSING",
-    COMMIT_UNAUTHORIZED = "COMMIT_UNAUTHORIZED",
-    COMMIT_MISSING_DATA = "COMMIT_MISSING_DATA",
-    INVALID_ADDRESS = "INVALID_ADDRESS",
-    NOT_AUTHENTICATED = "NOT_AUTHENTICATED",
-    DB_ERROR = "DB_ERROR",
-    INTERNAL_ERROR = "INTERNAL_ERROR"
+export interface ErrorResponseMessage {
+    status: boolean;
+    statusCode: number;
+    seqId: string | null;
+    is_handshake_response: boolean;
+    err: string;
+    err_detail: {
+        [key: string]: any;
+    } | null;
 }
-export interface AckResponse<T = Record<string, any>> {
+export interface SuccessResponseMessage {
     status: boolean;
     statusCode: number;
-    data?: T;
-    error?: string;
-    errorCode?: ServerErrorCode;
+    seqId: string | null;
+    is_handshake_response: boolean;
+    data: {
+        [key: string]: any;
+    };
 }
-export interface SendUpdateResponse extends AckResponse<{
-    id: string;
-    documentId: string;
-    data: string;
-    updateType: string;
-    commitCid: string | null;
-    createdAt: number;
-}> {
+export interface EventMessage {
+    type: string;
+    event_type: string;
+    event: {
+        data: any;
+        roomId: string;
+    };
 }
-export interface CommitResponse extends AckResponse<{
-    cid: string;
-    createdAt: number;
-    documentId: string;
-    updates: string[];
-}> {
+export type RequestResponse = ErrorResponseMessage | SuccessResponseMessage;
+export type OnMessagePayloadType = RequestResponse | EventMessage;
+export type EventHandler = (message: EventMessage) => void;
+export type DisconnectHandler = (e: CloseEvent | ErrorEvent) => void;
+export type ConnectHandler = () => void;
+export interface PartialRequest {
+    cmd: string;
+    args: {
+        [key: string]: any;
+    };
+}
+export interface RequestPayload extends PartialRequest {
+    seqId: string;
+}
+export type SequenceResponseCB = (data: RequestResponse) => void;
+export interface SequenceToRequestMapValue {
+    callback: SequenceResponseCB;
 }
+export type SequenceToRequestMap = {
+    [key: string]: SequenceToRequestMapValue;
+};
+export type Update = Uint8Array;
 export interface ISocketInitConfig {
-    onConnect: () => void;
-    onDisconnect: () => void;
+    onConnect: ConnectHandler;
+    onDisconnect: DisconnectHandler;
     onError: (err: Error) => void;
+    onWsEvent: EventHandler;
     onHandShakeError: (err: Error) => void;
-    onContentUpdate: (data: {
-        id: string;
-        data: string;
-        createdAt: number;
-        roomId: string;
-    }) => void;
-    onMembershipChange: (data: {
-        action: string;
-        user: {
-            role: string;
-        };
-        roomId: string;
-    }) => void;
-    onSessionTerminated: (data: {
-        roomId: string;
-    }) => void;
+    roomId: string;
 }
 export declare enum SocketStatusEnum {
     CLOSED = "CLOSED",
@@ -116,6 +138,19 @@ export interface RoomMember {
     userId: string;
     role: 'owner' | 'editor';
 }
+export type IAesKey = string;
+export type SyncMachinEvent = {
+    type: string;
+    data: any;
+};
+export interface IpfsUploadResponse {
+    ipfsUrl: string;
+    ipfsHash: string;
+    ipfsStorage: string;
+    cachedUrl: string;
+    fileSize: number;
+    mimetype: string;
+}
 export interface IAuthArgs {
     collaborationToken: string;
     documentId: string;

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

@@ -0,0 +1,38 @@
+import { SyncMachineContext } from '.';
+
+export interface IConnectConf {
+    username?: string;
+    roomKey: string;
+    roomId: string;
+    isOwner: boolean;
+    ownerEdSecret?: string;
+    contractAddress?: string;
+    ownerAddress?: string;
+    isEns?: boolean;
+    wsUrl: string;
+    roomInfo?: {
+        documentTitle: string;
+        portalAddress: string;
+        commentKey: string;
+    };
+}
+export declare const useSyncMachine: (config: Partial<SyncMachineContext>) => {
+    connect: (connectConfig: IConnectConf) => void;
+    disconnect: () => void;
+    isConnected: any;
+    isReady: boolean;
+    error: any;
+    terminateSession: () => void;
+    awareness: any;
+    hasCollabContentInitialised: boolean;
+    state: import('xstate').State<SyncMachineContext, {
+        type: string;
+        data: any;
+    }, any, {
+        value: any;
+        context: SyncMachineContext;
+    }, import('xstate').ResolveTypegenMeta<import('xstate').TypegenDisabled, {
+        type: string;
+        data: any;
+    }, import('xstate').BaseActionObject, import('xstate').ServiceMap>>;
+};

package/dist/package/sync-local/utils/createAwarenessUpdateHandler.d.ts

@@ -1,8 +1,8 @@
 import { Awareness } from 'y-protocols/awareness';
-import { SocketClient } from '../socketClient';
+import { SyncMachineContext } from '../types';
 
-export declare const createAwarenessUpdateHandler: (awareness: Awareness, socketClient: SocketClient, roomKey: string) => ({ added, updated, removed }: {
+export declare const createAwarenessUpdateHandler: (awareness: Awareness, context: SyncMachineContext) => ({ added, updated, removed, }: {
     added: number[];
     updated: number[];
     removed: number[];
-}, origin: any) => void;
+}) => void;

package/dist/package/types.d.ts

@@ -17,6 +17,11 @@ export type InlineCommentData = {
     highlightedTextContent: string;
     handleClick: boolean;
 };
+export type CommentMutationType = 'create' | 'resolve' | 'unresolve' | 'delete';
+export interface CommentMutationMeta {
+    type: CommentMutationType;
+    updateChunk: string;
+}
 export interface CommentAccountProps {
     isConnected?: boolean;
     connectViaWallet?: () => Promise<void>;
@@ -94,10 +99,10 @@ export interface DdocProps extends CommentAccountProps {
     initialComments?: IComment[];
     setInitialComments?: React.Dispatch<SetStateAction<IComment[]>>;
     onCommentReply?: (activeCommentId: string, reply: IComment) => void;
-    onNewComment?: (newComment: IComment) => void;
-    onResolveComment?: (activeCommentId: string) => void;
-    onUnresolveComment?: (activeCommentId: string) => void;
-    onDeleteComment?: (activeCommentId: string) => void;
+    onNewComment?: (newComment: IComment, meta?: CommentMutationMeta) => void;
+    onResolveComment?: (activeCommentId: string, meta?: CommentMutationMeta) => void;
+    onUnresolveComment?: (activeCommentId: string, meta?: CommentMutationMeta) => void;
+    onDeleteComment?: (activeCommentId: string, meta?: CommentMutationMeta) => void;
     showTOC?: boolean;
     setShowTOC?: React.Dispatch<SetStateAction<boolean>>;
     extensions?: Record<string, Extension | any>;

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

@@ -3,7 +3,7 @@ import { Editor } from '@tiptap/react';
 
 export declare const useDdocEditor: ({ isPreviewMode, initialContent, versionHistoryState, enableCollaboration, onChange, onCollaboratorChange, onCommentInteraction, onError, setCharacterCount, setWordCount, ipfsImageUploadFn, ddocId, enableIndexeddbSync, unFocused, theme, zoomLevel, onInvalidContentError, ignoreCorruptedData, isPresentationMode, metadataProxyUrl, extensions: externalExtensions, onCopyHeadingLink, ipfsImageFetchFn, fetchV1ImageFn, isConnected, activeModel, maxTokens, isAIAgentEnabled, collabConfig, onIndexedDbError, disableInlineComment, ...rest }: Partial<DdocProps>) => {
     ydoc: import('yjs').Doc;
-    awareness: import('y-protocols/awareness.js').Awareness | null;
+    awareness: any;
     refreshYjsIndexedDbProvider: () => Promise<void>;
     terminateSession: () => void;
     isContentLoading: boolean;
@@ -21,7 +21,7 @@ export declare const useDdocEditor: ({ isPreviewMode, initialContent, versionHis
     }) => void;
     duplicateTab: (tabId: string) => string | undefined;
     orderTab: (destinationTabId: string, movedTabId: string) => void;
-    onConnect: (connectConfig: import('./sync-local').ConnectConfig) => void;
+    onConnect: (connectConfig: import('./sync-local/useSyncMachine').IConnectConf) => void;
     isReady: boolean;
     hasCollabContentInitialised: boolean;
     initialiseYjsIndexedDbProvider: () => Promise<void>;