@openeditor/react-native-prose-editor 0.0.2

package/dist/YjsCollaboration.d.ts

@@ -0,0 +1,90 @@
+import { type CollaborationPeer, type DocumentJSON, type EncodedCollaborationStateInput, type Selection } from './NativeEditorBridge';
+import type { RemoteSelectionDecoration } from './NativeRichTextEditor';
+import type { SchemaDefinition } from './schemas';
+export type YjsTransportStatus = 'idle' | 'connecting' | 'connected' | 'disconnected' | 'error';
+export interface YjsRetryContext {
+    attempt: number;
+    documentId: string;
+    lastError?: Error;
+}
+export type YjsRetryInterval = number | ((context: YjsRetryContext) => number | null | false);
+export interface LocalAwarenessUser {
+    userId: string;
+    name: string;
+    color: string;
+    avatarUrl?: string;
+    extra?: Record<string, unknown>;
+}
+export interface LocalAwarenessState {
+    user: LocalAwarenessUser;
+    selection?: {
+        anchor: number;
+        head: number;
+    };
+    focused?: boolean;
+}
+export interface YjsCollaborationState {
+    documentId: string;
+    status: YjsTransportStatus;
+    isConnected: boolean;
+    documentJson: DocumentJSON;
+    /** Local selection remapped through the latest collaboration document update. */
+    selectionOnValueJSONReset?: Selection;
+    lastError?: Error;
+}
+export interface YjsCollaborationOptions {
+    documentId: string;
+    createWebSocket: () => WebSocket;
+    connect?: boolean;
+    retryIntervalMs?: YjsRetryInterval | false;
+    fragmentName?: string;
+    schema?: SchemaDefinition;
+    initialDocumentJson?: DocumentJSON;
+    initialEncodedState?: EncodedCollaborationStateInput;
+    localAwareness: LocalAwarenessUser;
+    onPeersChange?: (peers: CollaborationPeer[]) => void;
+    onStateChange?: (state: YjsCollaborationState) => void;
+    onError?: (error: Error) => void;
+}
+export interface YjsCollaborationController {
+    readonly state: YjsCollaborationState;
+    readonly peers: CollaborationPeer[];
+    connect(): void;
+    disconnect(): void;
+    reconnect(): void;
+    destroy(): void;
+    getEncodedState(): Uint8Array;
+    getEncodedStateBase64(): string;
+    applyEncodedState(encodedState: EncodedCollaborationStateInput): void;
+    replaceEncodedState(encodedState: EncodedCollaborationStateInput): void;
+    updateLocalAwareness(partial: Partial<LocalAwarenessState>): void;
+    handleLocalDocumentChange(doc: DocumentJSON): void;
+    handleSelectionChange(selection: Selection): void;
+    handleFocusChange(focused: boolean): void;
+}
+export interface UseYjsCollaborationResult {
+    state: YjsCollaborationState;
+    peers: CollaborationPeer[];
+    isConnected: boolean;
+    connect(): void;
+    disconnect(): void;
+    reconnect(): void;
+    getEncodedState(): Uint8Array;
+    getEncodedStateBase64(): string;
+    applyEncodedState(encodedState: EncodedCollaborationStateInput): void;
+    replaceEncodedState(encodedState: EncodedCollaborationStateInput): void;
+    updateLocalAwareness(partial: Partial<LocalAwarenessState>): void;
+    editorBindings: {
+        valueJSON: DocumentJSON;
+        valueJSONUpdateMode: 'reset';
+        preserveSelectionOnValueJSONReset: true;
+        selectionOnValueJSONReset?: Selection;
+        remoteSelections: RemoteSelectionDecoration[];
+        onContentChangeJSON: (doc: DocumentJSON) => void;
+        onSelectionChange: (selection: Selection) => void;
+        onFocus: () => void;
+        onBlur: () => void;
+    };
+}
+export declare function createYjsCollaborationController(options: YjsCollaborationOptions): YjsCollaborationController;
+export declare function useYjsCollaboration(options: YjsCollaborationOptions): UseYjsCollaborationResult;