@fileverse-dev/ddoc 2.3.4 → 2.4.0

package/dist/index.d.ts

@@ -5,3 +5,4 @@ export { useHeadlessEditor } from './package/hooks/use-headless-editor';
 export { ReminderBlock } from './package/extensions/reminder-block/reminder-block';
 export { type Reminder, type ReminderBlockOptions, } from './package/extensions/reminder-block/types';
 export { Editor } from '@tiptap/react';
+export type { ICollaborationConfig } from './package/types';

package/dist/index.es.js

@@ -1,4 +1,4 @@
-import { D as d, E as r, P as s, R as a, h as t, u as i } from "./index-BDeTWJWD.mjs";
+import { D as d, E as r, P as s, R as a, h as t, u as i } from "./index-CT3AMJnE.mjs";
 export {
   d as DdocEditor,
   r as Editor,

package/dist/package/components/editor-bubble-menu/props.d.ts

@@ -61,6 +61,8 @@ export declare const bubbleMenuProps: (props: EditorBubbleMenuProps) => {
     }>;
     onReminderCreate?: (reminder: import('../../..').Reminder, type: string) => void;
     isConnected?: boolean;
+    isCollabDocOwner?: boolean;
+    enableCollaboration?: boolean;
 };
 export declare const shouldShow: ({ editor }: {
     editor: Editor;

package/dist/package/components/editor-bubble-menu/types.d.ts

@@ -31,6 +31,8 @@ export type EditorBubbleMenuProps = Omit<BubbleMenuProps, 'children'> & {
     }>;
     onReminderCreate?: (reminder: Reminder, type: string) => void;
     isConnected?: boolean;
+    isCollabDocOwner?: boolean;
+    enableCollaboration?: boolean;
 };
 export interface NodeSelectorProps {
     editor: Editor;

package/dist/package/extensions/slash-command/slash-comand.d.ts

@@ -2,5 +2,5 @@ import { Extension } from '@tiptap/core';
 import { IpfsImageUploadResponse } from '../../types';
 
 export declare const Command: Extension<any, any>;
-declare const SlashCommand: (onError?: (errorString: string) => void, ipfsImageUploadFn?: (file: File) => Promise<IpfsImageUploadResponse>, isConnected?: boolean) => Extension<any, any>;
+declare const SlashCommand: (onError?: (errorString: string) => void, ipfsImageUploadFn?: (file: File) => Promise<IpfsImageUploadResponse>, isConnected?: boolean, enableCollaboration?: boolean) => Extension<any, any>;
 export default SlashCommand;

package/dist/package/extensions/slash-command/slash-command-utils.d.ts

@@ -1,12 +1,13 @@
 import { CommandProps } from './types';
 import { IpfsImageUploadResponse } from '../../types';
 
-export declare const getSuggestionItems: ({ query, onError, isConnected, ipfsImageUploadFn, editor, }: {
+export declare const getSuggestionItems: ({ query, onError, isConnected, ipfsImageUploadFn, editor, enableCollaboration, }: {
     query: string;
     onError?: (errorString: string) => void;
     ipfsImageUploadFn?: (file: File) => Promise<IpfsImageUploadResponse>;
     isConnected?: boolean;
     editor?: any;
+    enableCollaboration?: boolean;
 }) => ({
     title: string;
     description: string;
@@ -23,5 +24,13 @@ export declare const getSuggestionItems: ({ query, onError, isConnected, ipfsIma
     image: string;
     command: ({ editor, range }: CommandProps) => void;
     isDisabled?: undefined;
+} | {
+    title: string;
+    description: string;
+    searchTerms: string[];
+    icon: import("react/jsx-runtime").JSX.Element;
+    image: string;
+    isDisabled: boolean | undefined;
+    command: ({ editor, range }: CommandProps) => true | undefined;
 })[];
 export declare const updateScrollView: (container: HTMLElement, item: HTMLElement) => void;

package/dist/package/extensions/sync-cursor.d.ts

@@ -0,0 +1,28 @@
+import { Extension } from '@tiptap/core';
+
+type CollaborationCursorStorage = {
+    users: {
+        clientId: number;
+        [key: string]: any;
+    }[];
+};
+export interface CollaborationCursorOptions {
+    provider: any;
+    user: Record<string, any>;
+    render(user: Record<string, any>): HTMLElement;
+    selectionRender(user: Record<string, any>): any;
+    onUpdate: (users: {
+        clientId: number;
+        [key: string]: any;
+    }[]) => null;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        collaborationCursor: {
+            updateUser: (attributes: Record<string, any>) => ReturnType;
+            user: (attributes: Record<string, any>) => ReturnType;
+        };
+    }
+}
+export declare const SyncCursor: Extension<CollaborationCursorOptions, CollaborationCursorStorage>;
+export {};

package/dist/package/hooks/use-editing-context.d.ts

@@ -3,12 +3,14 @@ import { default as React, ReactNode } from 'react';
 type EditingContextType = {
     isPreviewMode: boolean;
     isPresentationMode?: boolean;
+    isCollaboratorsDoc?: boolean;
 };
 export declare const useEditingContext: () => EditingContextType;
 type EditingProviderProps = {
     children: ReactNode;
     isPreviewMode: boolean;
     isPresentationMode?: boolean;
+    isCollaboratorsDoc?: boolean;
 };
 export declare const EditingProvider: React.FC<EditingProviderProps>;
 export {};

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

@@ -0,0 +1,144 @@
+import { SyncMachineContext, SyncMachinEvent } from '../types';
+import { SocketClient } from '../socketClient';
+
+import * as awarenessProtocol from 'y-protocols/awareness';
+export declare const awarenessUpdateHandler: (context: SyncMachineContext, event: SyncMachinEvent) => {};
+export declare const initAwarenessHandler: (context: SyncMachineContext) => {
+    awareness: awarenessProtocol.Awareness;
+    _awarenessUpdateHandler: ({ added, updated, removed, }: {
+        added: number[];
+        updated: number[];
+        removed: number[];
+    }) => void;
+};
+export declare const updateConnectionStateHandler: (context: SyncMachineContext) => {
+    isConnected: boolean;
+};
+export declare const websocketInitializer: (context: SyncMachineContext, event: SyncMachinEvent) => {
+    socketClient: SocketClient;
+    initialUpdate: any;
+    roomKey: any;
+    roomId: any;
+    isOwner: any;
+    isEns: any;
+    wsUrl: any;
+    onCollaborationCommit: (file: File) => Promise<string>;
+    onFetchCommitContent: (cid: string) => Promise<any>;
+    onSessionTerminated: () => void;
+    onUnMergedUpdates: (state: boolean) => void;
+};
+export declare const yjsUpdateHandler: (context: SyncMachineContext, event: SyncMachinEvent) => {
+    uncommittedUpdatesIdList?: undefined;
+} | {
+    uncommittedUpdatesIdList: any[];
+};
+export declare const roomMemberUpdateHandler: (context: SyncMachineContext) => {
+    roomMembers: import('../types').RoomMember[];
+};
+export declare const stateResetHandler: () => {
+    roomMembers: never[];
+    isConnected: boolean;
+    awareness: null;
+    _awarenessUpdateHandler: null;
+    socketClient: null;
+};
+export declare const registerUpdateHandler: (context: SyncMachineContext, event: SyncMachinEvent) => {
+    uncommittedUpdatesIdList?: undefined;
+} | {
+    uncommittedUpdatesIdList: any[];
+};
+export declare const removeLastProcessedUpdate: (context: SyncMachineContext, event: SyncMachinEvent) => {
+    updateQueue: Uint8Array<ArrayBufferLike>[];
+};
+export declare const clearUncommitedUpdatesHandler: () => {
+    uncommittedUpdatesIdList: never[];
+};
+export declare const addUpdateToQueueHandler: (context: SyncMachineContext, event: SyncMachinEvent) => {
+    updateQueue: any[];
+};
+export declare const updateConnectionReadyStateHandler: (_context: SyncMachineContext, event: SyncMachinEvent) => {
+    isReady: any;
+};
+export declare const setNewDocFlagHandler: (_context: SyncMachineContext, event: SyncMachinEvent) => {
+    isNewDoc: any;
+};
+export declare const commitUncommittedIdsHandler: (_context: SyncMachineContext, event: SyncMachinEvent) => {
+    uncommittedUpdatesIdList: any;
+};
+export declare const setConnectionActiveStateHandler: (context: SyncMachineContext) => {
+    isConnected: boolean;
+};
+export declare const setMachineReadyStateHandler: () => {
+    isReady: boolean;
+};
+export declare const addRemoteContentToQueueHandler: (context: SyncMachineContext, event: SyncMachinEvent) => {
+    contentTobeAppliedQueue: any[];
+};
+export declare const applyContentsFromRemote: (context: SyncMachineContext) => {
+    contentTobeAppliedQueue?: undefined;
+} | {
+    contentTobeAppliedQueue: never[];
+};
+export declare const clearErrorCountHandler: () => {
+    errorCount: number;
+    errorMessage: string;
+};
+export declare const updateErrorCountHandler: (context: SyncMachineContext) => {
+    errorCount: number;
+};
+export declare const setCommitMessageErrorHandler: (_context: SyncMachineContext, event: SyncMachinEvent) => {
+    errorMessage: string;
+};
+export declare const setUpdateErrorMessageHandler: (_context: SyncMachineContext, event: SyncMachinEvent) => {
+    errorMessage: string;
+};
+export declare const setConnectionErrorMessageHandler: (_context: SyncMachineContext, event: SyncMachinEvent) => {
+    errorMessage: string;
+};
+export declare const setIpfsQueryErrorMessageHandler: (_context: SyncMachineContext, event: SyncMachinEvent) => {
+    errorMessage: string;
+};
+export declare const setInitialCommitErrorMessageHandler: (_context: SyncMachineContext, event: SyncMachinEvent) => {
+    errorMessage: string;
+};
+export declare const setInitialUpdateErrorMessageHandler: (_context: SyncMachineContext, event: SyncMachinEvent) => {
+    errorMessage: string;
+};
+export declare const disconnectedStateHandler: () => {
+    socketClient: null;
+    roomMembers: never[];
+    isConnected: boolean;
+    awareness: null;
+    _awarenessUpdateHandler: null;
+    uncommittedUpdatesIdList: never[];
+    updateQueue: never[];
+};
+export declare const handleDisconnectionDueToError: (context: SyncMachineContext, event: SyncMachinEvent) => {
+    errorCount: number;
+    errorMessage: any;
+} | {
+    errorCount?: undefined;
+    errorMessage?: undefined;
+};
+export declare const terminateSessionHandler: (context: SyncMachineContext) => {
+    socketClient: null;
+    roomId: string;
+    roomMembers: never[];
+    isConnected: boolean;
+    awareness: null;
+    _awarenessUpdateHandler: null;
+    roomKey: string;
+    wsUrl: string;
+    uncommittedUpdatesIdList: never[];
+    updateQueue: never[];
+    isOwner: boolean;
+    isReady: boolean;
+    isNewDoc: boolean;
+    contentTobeAppliedQueue: never[];
+    initialUpdate: null;
+    errorCount: number;
+    errorMessage: string;
+};
+export declare const setDocumentDecryptionStateHandler: (_: SyncMachineContext, event: SyncMachinEvent) => {
+    initalDocumentDecryptionState: any;
+};

package/dist/package/sync-local/actions/syncMachineActions.d.ts

@@ -0,0 +1 @@
+export declare const syncMachineActions: Record<any, any>;

package/dist/package/sync-local/constants/config.d.ts

@@ -0,0 +1,7 @@
+export declare const WEBSOCKET_CONFIG: {
+    maxReconnectionDelay: number;
+    minReconnectionDelay: number;
+    reconnectionDelayGrowFactor: number;
+    connectionTimeout: number;
+    maxRetries: number;
+};

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

@@ -0,0 +1,5 @@
+import { SyncMachineContext } from '../types';
+
+export declare const initialContext: SyncMachineContext;
+export declare const STORAGE_API = "https://dev-fileverse-storage.herokuapp.com/upload/public";
+export declare const IPFS_GATEWAYS: string[];

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

@@ -0,0 +1,6 @@
+export declare const crypto: {
+    generateKeyPair: () => import('@fileverse/crypto/ecies').EciesKeyPairBytes;
+    encryptData: (key: Uint8Array, message: Uint8Array) => string;
+    decryptData: (key: Uint8Array, message: string) => Uint8Array<ArrayBufferLike>;
+    generateRandomBytes: <E extends import('@fileverse/crypto/types').EncodingType = "bytes">(length?: number, encoding?: E) => import('@fileverse/crypto/types').EncodedReturnType<E>;
+};

package/dist/package/sync-local/guards/syncMachineGuards.d.ts

@@ -0,0 +1,10 @@
+import { SyncMachineContext } from '../types';
+
+export declare const syncMachineGuards: {
+    isUserConnected: (context: SyncMachineContext) => boolean;
+    hasMoreUpdates: (context: SyncMachineContext) => boolean;
+    isOwner: (context: SyncMachineContext) => boolean;
+    errorIsLessThanRetryCount: (context: SyncMachineContext) => boolean;
+    shouldRetryConnection: (context: SyncMachineContext) => boolean;
+    shouldRefetchCommit: (context: SyncMachineContext) => boolean;
+};

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

@@ -0,0 +1,6 @@
+import { default as syncMachine } from './syncMachine';
+import { SyncMachineContext } from './types';
+
+export { useSyncMachine } from './useSyncMachine';
+export { syncMachine };
+export type { SyncMachineContext };

package/dist/package/sync-local/services/syncMachineServices.d.ts

@@ -0,0 +1,19 @@
+import { Sender } from 'xstate';
+import { SyncMachineContext, SyncMachinEvent } from '../types';
+
+export declare const syncMachineServices: {
+    connectSocket: (context: SyncMachineContext) => (send: Sender<SyncMachinEvent>) => Promise<void>;
+    disconnectSocket: (context: SyncMachineContext) => () => Promise<void>;
+    processNextUpdate: (context: SyncMachineContext) => () => Promise<{
+        updateId: string | undefined;
+        queueOffset: number;
+    } | undefined>;
+    processCommit: (context: SyncMachineContext) => (send: Sender<SyncMachinEvent>) => Promise<void>;
+    syncLatestCommitFromIpfs: (context: SyncMachineContext) => (send: Sender<SyncMachinEvent>) => Promise<{
+        ids: string[];
+        unbroadcastedUpdate: string | null;
+    }>;
+    broadcastLocalContents: (context: SyncMachineContext, event: SyncMachinEvent) => () => Promise<boolean>;
+    commitLocalContents: (context: SyncMachineContext, event: SyncMachinEvent) => (send: Sender<SyncMachinEvent>) => Promise<string | undefined>;
+    verifyConnectionState: (context: SyncMachineContext) => (send: Sender<SyncMachinEvent>) => Promise<void>;
+};

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

@@ -0,0 +1,72 @@
+import { UrlProvider } from 'partysocket/ws';
+import { ISocketInitConfig, RoomMember, SocketStatusEnum, SendUpdateResponse, CommitResponse } from './types';
+import { Awareness } from 'y-protocols/awareness.js';
+
+interface ISocketClientConfig {
+    wsUrl: UrlProvider;
+    roomKey: string;
+    ownerEdSecret?: string;
+    contractAddress?: string;
+    ownerAddress?: string;
+    onCollaborationConnectCallback: (response: any) => void;
+    roomInfo?: {
+        documentTitle: string;
+        portalAddress: string;
+        commentKey: string;
+    };
+}
+export declare class SocketClient {
+    private _websocketUrl;
+    private _machineEventHandler;
+    private _onConnect;
+    private _onDisconnection;
+    private _sequenceCallbackMap;
+    _webSocketStatus: SocketStatusEnum;
+    private _webSocket;
+    private _websocketServiceDid;
+    private roomId;
+    roomMembers: RoomMember[];
+    private collaborationKeyPair;
+    private ownerKeyPair?;
+    private contractAddress?;
+    private ownerUcan?;
+    private ownerAddress?;
+    private roomKey;
+    private roomInfo?;
+    private awareness;
+    _onError: ISocketInitConfig['onError'] | null;
+    _onCollaborationConnectCallback: ISocketClientConfig['onCollaborationConnectCallback'] | null;
+    constructor(config: ISocketClientConfig);
+    private _getSequenceIdCallback;
+    private _removeSequenceIdFromMap;
+    registerAwareness(awareness: Awareness): void;
+    private _registerSequenceCallback;
+    private _sendNetworkRequest;
+    private _fetchRoomMembers;
+    sendUpdate({ update }: {
+        update: string;
+    }): Promise<SendUpdateResponse>;
+    commitUpdates({ updates, cid }: {
+        updates: string[];
+        cid: string;
+    }): Promise<CommitResponse>;
+    fetchLatestCommit(): Promise<any>;
+    getUncommittedChanges(): Promise<any>;
+    broadcastAwareness(awarenessUpdate: string): Promise<any>;
+    disconnect: () => void;
+    terminateSession: () => Promise<void>;
+    private _buildRequest;
+    private getCollaborationKeyPair;
+    private getOwnerToken;
+    private buildToken;
+    private _handleHandShake;
+    private _executeRequestCallback;
+    private _dispatchEventHandler;
+    private _onSessionTerminated;
+    private _processMessage;
+    private _clearSequenceCallbackMap;
+    connectSocket(): Promise<void> | undefined;
+    init(config: ISocketInitConfig): Promise<void>;
+    private resetSocketClient;
+}
+export {};

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

@@ -0,0 +1,13 @@
+import { SyncMachineContext } from './types';
+
+declare const syncMachine: import('xstate').StateMachine<SyncMachineContext, any, {
+    type: string;
+    data: any;
+}, {
+    value: any;
+    context: SyncMachineContext;
+}, import('xstate').BaseActionObject, import('xstate').ServiceMap, import('xstate').ResolveTypegenMeta<import('xstate').TypegenDisabled, {
+    type: string;
+    data: any;
+}, import('xstate').BaseActionObject, import('xstate').ServiceMap>>;
+export default syncMachine;

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

@@ -0,0 +1,159 @@
+import { SocketClient } from '../socketClient';
+
+import * as Y from 'yjs';
+export interface IRoomMember {
+    userId: string;
+    username: string;
+    role: 'owner' | 'editor';
+}
+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 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 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: string) => 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;
+    initalDocumentDecryptionState: 'done' | 'pending';
+    onCollaborationConnectCallback: (response: any) => void;
+    onCollaborationCommit: (file: File) => Promise<string>;
+    onFetchCommitContent: (cid: string) => Promise<any>;
+    onSessionTerminated: () => void;
+    onUnMergedUpdates: (state: boolean) => void;
+}
+export interface ErrorResponseMessage {
+    status: boolean;
+    statusCode: number;
+    seqId: string | null;
+    is_handshake_response: boolean;
+    err: string;
+    err_detail: {
+        [key: string]: any;
+    } | null;
+}
+export interface SuccessResponseMessage {
+    status: boolean;
+    statusCode: number;
+    seqId: string | null;
+    is_handshake_response: boolean;
+    data: {
+        [key: string]: any;
+    };
+}
+export interface EventMessage {
+    type: string;
+    event_type: string;
+    event: {
+        data: any;
+        roomId: 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: ConnectHandler;
+    onDisconnect: DisconnectHandler;
+    onError: (err: string) => void;
+    onWsEvent: EventHandler;
+    roomId: string;
+}
+export declare enum SocketStatusEnum {
+    CLOSED = "CLOSED",
+    CONNECTED = "CONNECTED",
+    CONNECTING = "CONNECTING",
+    DISCONNECTING = "DISCONNECTING",
+    DISCONNECTED = "DISCONNECTED"
+}
+export interface RoomMember {
+    username: string;
+    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;
+    ownerToken?: string;
+    ownerAddress?: string;
+    contractAddress?: string;
+    sessionDid?: string;
+    roomInfo?: string;
+}

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

@@ -0,0 +1,31 @@
+import { SyncMachineContext } from '.';
+
+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: any;
+    getYjsEncodedState: () => string;
+    applyYjsEncodedState: (update: string) => void;
+    error: any;
+    terminateSession: () => void;
+    awareness: any;
+    hasCollabContentInitialised: boolean;
+};
+export {};

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

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

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

@@ -0,0 +1 @@
+export declare const objectToFile: (data: Record<string, unknown>, fileName: string) => File;

package/dist/package/types.d.ts

@@ -7,6 +7,7 @@ import { IComment } from './extensions/comment';
 
 export declare const DdocEditorProps: EditorProps;
 export interface IDocCollabUsers {
+    clientId: number;
     name: string;
     isEns: string;
     color: string;
@@ -142,11 +143,24 @@ export interface DdocProps extends CommentAccountProps {
     activeModel?: CustomModel;
     maxTokens?: number;
     isAIAgentEnabled?: boolean;
+    collaborationKey?: CryptoKey | null;
+    collaborationKeyPair?: {
+        publicKey: string;
+        privateKey: string;
+    };
+    collabConfig?: ICollaborationConfig;
     /**
      * Document styling configuration
      * @description Customize the appearance of the document editor
      */
     documentStyling?: DocumentStyling;
+    onCollaborationConnectCallback?: (response: any) => void;
+    onCollaborationCommit?: (file: File) => Promise<string>;
+    onFetchCommitContent?: (cid: string) => Promise<any>;
+    onCollabSessionTermination?: () => void;
+    onUnMergedUpdates?: (state: boolean) => void;
+    onCollabError?: (error: any) => void;
+    isExistingCollabSession?: boolean;
 }
 export interface IEditorSelectionData {
     from: number;
@@ -178,3 +192,19 @@ export interface IpfsImageFetchPayload {
     mimeType: string;
     authTag: string;
 }
+export interface ICollaborationConfig {
+    roomKey: string;
+    collaborationId: string;
+    username: string;
+    isOwner: boolean;
+    ownerEdSecret?: string;
+    contractAddress?: string;
+    ownerAddress?: string;
+    wsUrl: string;
+    isEns?: boolean;
+    roomInfo?: {
+        documentTitle: string;
+        portalAddress: string;
+        commentKey: string;
+    };
+}