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

package/dist/package/components/editor-utils.d.ts

@@ -10,6 +10,7 @@ export interface IEditorToolElement {
     isActive: boolean;
     group?: string;
     isNew?: boolean;
+    subtitle?: string;
     notVisible?: number;
     disabled?: boolean;
 }

package/dist/package/components/export-modal.d.ts

@@ -1,12 +1,12 @@
-interface ExportFormatOption {
+export interface ExportFormatOption {
     id: string;
     label: string;
 }
-interface ExportTabOption {
+export interface ExportTabOption {
     id: string;
     label: string;
 }
-interface ExportAsModalProps {
+export interface ExportAsModalProps {
     open: boolean;
     onOpenChange: (open: boolean) => void;
     onExport?: (data: {
@@ -19,4 +19,3 @@ interface ExportAsModalProps {
     initialTab?: string;
 }
 export declare const ExportAsModal: ({ open, onOpenChange, onExport, formatOptions, tabOptions, initialFormat, initialTab, }: ExportAsModalProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/package/components/inline-comment/context/comment-context.d.ts

@@ -1,4 +1,4 @@
 import { CommentContextType, CommentProviderProps } from './types';
 
-export declare const CommentProvider: ({ children, editor, initialComments, setInitialComments, username, setUsername, activeCommentId, setActiveCommentId, activeTabId, focusCommentWithActiveId, onNewComment, onCommentReply, ensResolutionUrl, onResolveComment, onUnresolveComment, onDeleteComment, isConnected, connectViaWallet, isLoading, connectViaUsername, isDDocOwner, onInlineComment, onComment, setCommentDrawerOpen, }: CommentProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const CommentProvider: ({ children, editor, ydoc, initialComments, setInitialComments, username, setUsername, activeCommentId, setActiveCommentId, activeTabId, focusCommentWithActiveId, onNewComment, onCommentReply, ensResolutionUrl, onResolveComment, onUnresolveComment, onDeleteComment, isConnected, connectViaWallet, isLoading, connectViaUsername, isDDocOwner, onInlineComment, onComment, setCommentDrawerOpen, }: CommentProviderProps) => import("react/jsx-runtime").JSX.Element;
 export declare const useComments: () => CommentContextType;

package/dist/package/components/inline-comment/context/types.d.ts

@@ -1,9 +1,10 @@
 import { Editor } from '@tiptap/react';
 import { IComment } from '../../../extensions/comment';
 import { SetStateAction } from 'react';
-import { CommentAccountProps } from '../../../types';
+import { CommentAccountProps, CommentMutationMeta } from '../../../types';
 import { EnsStatus } from '../types';
 
+import * as Y from 'yjs';
 export interface CommentContextType extends CommentAccountProps {
     comments: IComment[];
     setComments: React.Dispatch<SetStateAction<IComment[]>>;
@@ -68,13 +69,14 @@ export interface CommentContextType extends CommentAccountProps {
 export interface CommentProviderProps extends CommentAccountProps {
     children: React.ReactNode;
     editor: Editor;
+    ydoc: Y.Doc;
     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;
     username: string | null;
     setUsername?: React.Dispatch<SetStateAction<string>>;
     activeCommentId: string | null;

package/dist/package/hooks/use-ddoc-export.d.ts

@@ -6,7 +6,7 @@ import * as Y from 'yjs';
 interface UseDdocExportArgs {
     editor: Editor | null;
     tabs: Tab[];
-    ydoc: Y.Doc;
+    ydoc: Y.Doc | null;
     exportOptions: (IEditorToolElement | null)[];
 }
 declare const useDdocExport: ({ editor, tabs, ydoc, exportOptions, }: UseDdocExportArgs) => {
@@ -20,5 +20,10 @@ declare const useDdocExport: ({ editor, tabs, ydoc, exportOptions, }: UseDdocExp
         tab: string;
         name?: string;
     }) => void;
+    handleExportAsync: ({ format, tab, name, }: {
+        format: string;
+        tab: string;
+        name?: string;
+    }) => Promise<void>;
 };
 export { useDdocExport };

package/dist/package/hooks/use-export-headless-editor-content.d.ts

@@ -0,0 +1,31 @@
+import { Editor, JSONContent } from '@tiptap/react';
+import { ExportAsModalProps } from '../components/export-modal';
+import { UseHeadlessEditorProps } from './use-headless-editor';
+
+import * as Y from 'yjs';
+export type HeadlessEditorExportFormat = 'pdf' | 'md' | 'html' | 'txt';
+export interface HeadlessEditorExportOption {
+    content: string;
+    fileName?: string;
+    initialFormat?: HeadlessEditorExportFormat;
+}
+export declare const useExportHeadlessEditorContent: (props?: UseHeadlessEditorProps) => {
+    exportContent: (option: HeadlessEditorExportOption) => void;
+    exportModalProps: ExportAsModalProps;
+    setContent: (initialContent: string | string[] | JSONContent, editor: Editor, ydoc: Y.Doc) => void;
+    getEditor: () => {
+        editor: Editor;
+        ydoc: Y.Doc;
+    };
+    getYjsConvertor: () => {
+        convertJSONContentToYjsEncodedString: (content: JSONContent) => string;
+        cleanup: () => void;
+    };
+    downloadContentAsMd: (content: string | string[] | JSONContent, title: string) => Promise<void>;
+    downloadContentAsHtml: (content: string | string[] | JSONContent, title: string) => Promise<void>;
+    downloadContentAsTxt: (content: string | string[] | JSONContent, title: string) => Promise<void>;
+    mergeYjsUpdates: (contents: string[]) => string;
+    handleMarkdownContent: typeof import('../extensions/mardown-paste-handler').handleMarkdownContent;
+    getYjsContentFromMarkdown: (file: File, ipfsImageUploadFn: (file: File) => Promise<import('../types').IpfsImageUploadResponse>) => Promise<string | null>;
+    getYjsContentFromDocx: (file: File, ipfsImageUploadFn: (file: File) => Promise<import('../types').IpfsImageUploadResponse>) => Promise<string | null>;
+};

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

@@ -3,9 +3,10 @@ import { handleMarkdownContent } from '../extensions/mardown-paste-handler';
 import { IpfsImageUploadResponse } from '../types';
 
 import * as Y from 'yjs';
-export declare const useHeadlessEditor: (props?: {
+export interface UseHeadlessEditorProps {
     optionalExtensions?: string[];
-}) => {
+}
+export declare const useHeadlessEditor: (props?: UseHeadlessEditorProps) => {
     setContent: (initialContent: string | string[] | JSONContent, editor: Editor, ydoc: Y.Doc) => void;
     getEditor: () => {
         editor: Editor;

package/dist/package/hooks/use-rtc-websocket-disconnector.d.ts

@@ -0,0 +1 @@
+export declare const useRtcWebsocketDisconnector: (syncState: any, enableCollaboration: boolean | undefined) => void;

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

@@ -2,7 +2,7 @@ import { Dispatch, MutableRefObject, SetStateAction } from 'react';
 import { DdocProps } from '../types';
 import { AnyExtension, Editor } from '@tiptap/react';
 import { ToCItemType } from '../components/toc/types';
-import { ConnectConfig } from '../sync-local/types';
+import { IConnectConf } from '../sync-local/useSyncMachine';
 
 import * as Y from 'yjs';
 interface UseTabEditorArgs {
@@ -38,7 +38,7 @@ interface UseTabEditorArgs {
     onInvalidContentError?: DdocProps['onInvalidContentError'];
     ignoreCorruptedData?: boolean;
     onCollaboratorChange?: DdocProps['onCollaboratorChange'];
-    onConnect: (connectConfig: ConnectConfig) => void;
+    onConnect: (connectConfig: IConnectConf) => void;
     hasCollabContentInitialised?: boolean;
     initialiseYjsIndexedDbProvider: () => Promise<void>;
     externalExtensions?: Record<string, AnyExtension>;

package/dist/package/hooks/use-yjs-setup.d.ts

@@ -14,12 +14,12 @@ interface UseYjsSetupArgs {
     onCollabSessionTermination?: () => void;
     onUnMergedUpdates?: (state: boolean) => void;
 }
-export declare const useYjsSetup: ({ onChange, enableIndexeddbSync, ddocId, onIndexedDbError, onCollabError, onCollaborationConnectCallback, onCollaborationCommit, onFetchCommitContent, onCollabSessionTermination, onUnMergedUpdates, }: UseYjsSetupArgs) => {
+export declare const useYjsSetup: ({ onChange, enableIndexeddbSync, ddocId, enableCollaboration, onIndexedDbError, onCollabError, onCollaborationConnectCallback, onCollaborationCommit, onFetchCommitContent, onCollabSessionTermination, onUnMergedUpdates, }: UseYjsSetupArgs) => {
     ydoc: Y.Doc;
-    onConnect: (connectConfig: import('../sync-local').ConnectConfig) => void;
+    onConnect: (connectConfig: import('../sync-local/useSyncMachine').IConnectConf) => void;
     isReady: boolean;
     terminateSession: () => void;
-    awareness: import('y-protocols/awareness.js').Awareness | null;
+    awareness: any;
     hasCollabContentInitialised: boolean;
     initialiseYjsIndexedDbProvider: () => Promise<void>;
     refreshYjsIndexedDbProvider: () => Promise<void>;

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

@@ -0,0 +1,137 @@
+import { SyncMachineContext, SyncMachinEvent } from '../types';
+import { SocketClient } from '../socketClient';
+
+import * as awarenessProtocol from 'y-protocols/awareness';
+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;
+    onLocalUpdate: ((updatedDocContent: import('../../types').Data["editorJSONData"], updateChunk: string) => void) | undefined;
+};
+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 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/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

@@ -1,3 +1,6 @@
-export { useSyncManager } from './useSyncManager';
-export { SyncManager } from './SyncManager';
-export type { SyncManagerConfig, ConnectConfig, SyncStatus, SyncManagerSnapshot, } from './types';
+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

@@ -1,15 +1,14 @@
-import { ISocketInitConfig, RoomMember, SocketStatusEnum, SendUpdateResponse, CommitResponse, AckResponse } from './types';
+import { UrlProvider } from 'partysocket/ws';
+import { ISocketInitConfig, RoomMember, SocketStatusEnum, SendUpdateResponse, CommitResponse } from './types';
 import { Awareness } from 'y-protocols/awareness.js';
 
 interface ISocketClientConfig {
-    wsUrl: string;
+    wsUrl: UrlProvider;
     roomKey: string;
-    roomId: string;
     ownerEdSecret?: string;
     contractAddress?: string;
     ownerAddress?: string;
     onCollaborationConnectCallback: (response: any) => void;
-    onError?: (e: Error) => void;
     roomInfo?: {
         documentTitle: string;
         portalAddress: string;
@@ -17,11 +16,14 @@ interface ISocketClientConfig {
     };
 }
 export declare class SocketClient {
-    private _socketUrl;
-    private _socket;
-    private _webSocketStatus;
-    get isConnected(): boolean;
-    get status(): SocketStatusEnum;
+    private _websocketUrl;
+    private _machineEventHandler;
+    private _onConnect;
+    private _onDisconnection;
+    private _onHandShakeError;
+    private _sequenceCallbackMap;
+    _webSocketStatus: SocketStatusEnum;
+    private _webSocket;
     private _websocketServiceDid;
     private roomId;
     roomMembers: RoomMember[];
@@ -37,8 +39,11 @@ export declare class SocketClient {
     _onError: ISocketInitConfig['onError'] | null;
     _onCollaborationConnectCallback: ISocketClientConfig['onCollaborationConnectCallback'] | null;
     constructor(config: ISocketClientConfig);
+    private _getSequenceIdCallback;
+    private _removeSequenceIdFromMap;
     registerAwareness(awareness: Awareness): void;
-    private _emitWithAck;
+    private _registerSequenceCallback;
+    private _sendNetworkRequest;
     private _fetchRoomMembers;
     sendUpdate({ update }: {
         update: string;
@@ -47,19 +52,24 @@ export declare class SocketClient {
         updates: string[];
         cid: string;
     }): Promise<CommitResponse>;
-    fetchLatestCommit(): Promise<AckResponse<any>>;
-    getUncommittedChanges(): Promise<AckResponse<any>>;
-    broadcastAwareness(awarenessUpdate: string): Promise<void>;
-    disconnect: () => void;
+    fetchLatestCommit(): Promise<any>;
+    getUncommittedChanges(): Promise<any>;
+    broadcastAwareness(awarenessUpdate: string): Promise<any>;
+    disconnect: (reason: string, code: number) => void;
     terminateSession: () => Promise<void>;
+    private _buildRequest;
     private getCollaborationKeyPair;
     private isUcanValid;
     private getOwnerToken;
     private buildSessionToken;
     private _handleHandShake;
-    private _handleAwarenessUpdate;
-    connectSocket(config: ISocketInitConfig): Promise<void>;
+    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;