@openeditor/react-native-prose-editor 0.0.2

package/dist/NativeEditorBridge.d.ts

@@ -0,0 +1,325 @@
+import type { EditorMentionTheme } from './EditorTheme';
+import { type SchemaDefinition } from './schemas';
+export interface NativeEditorModule {
+    editorCreate(configJson: string): number;
+    editorDestroy(editorId: number): void;
+    editorPrepareForCommand?(editorId: number): string;
+    collaborationSessionCreate(configJson: string): number;
+    collaborationSessionDestroy(sessionId: number): void;
+    collaborationSessionGetDocumentJson(sessionId: number): string;
+    collaborationSessionGetEncodedState(sessionId: number): string;
+    collaborationSessionGetPeersJson(sessionId: number): string;
+    collaborationSessionStart(sessionId: number): string;
+    collaborationSessionApplyLocalDocumentJson(sessionId: number, json: string): string;
+    collaborationSessionApplyEncodedState(sessionId: number, encodedStateJson: string): string;
+    collaborationSessionReplaceEncodedState(sessionId: number, encodedStateJson: string): string;
+    collaborationSessionHandleMessage(sessionId: number, messageJson: string): string;
+    collaborationSessionSetLocalAwareness(sessionId: number, awarenessJson: string): string;
+    collaborationSessionClearLocalAwareness(sessionId: number): string;
+    editorSetHtml(editorId: number, html: string): string;
+    editorGetHtml(editorId: number): string;
+    editorSetJson(editorId: number, json: string): string;
+    editorGetJson(editorId: number): string;
+    editorGetContentSnapshot(editorId: number): string;
+    editorReplaceHtml(editorId: number, html: string): string;
+    editorReplaceJson(editorId: number, json: string): string;
+    editorInsertText(editorId: number, pos: number, text: string): string;
+    editorReplaceSelectionText(editorId: number, text: string): string;
+    editorDeleteRange(editorId: number, from: number, to: number): string;
+    editorSplitBlock(editorId: number, pos: number): string;
+    editorInsertContentHtml(editorId: number, html: string): string;
+    editorInsertContentJson(editorId: number, json: string): string;
+    editorInsertContentJsonAtSelectionScalar(editorId: number, scalarAnchor: number, scalarHead: number, json: string): string;
+    editorToggleMark(editorId: number, markName: string): string;
+    editorSetMark(editorId: number, markName: string, attrsJson: string): string;
+    editorUnsetMark(editorId: number, markName: string): string;
+    editorToggleBlockquote(editorId: number): string;
+    editorToggleHeading(editorId: number, level: number): string;
+    editorSetSelection(editorId: number, anchor: number, head: number): void;
+    editorGetSelection(editorId: number): string;
+    editorGetSelectionState(editorId: number): string;
+    editorGetCurrentState(editorId: number): string;
+    editorInsertTextScalar(editorId: number, scalarPos: number, text: string): string;
+    editorDeleteScalarRange(editorId: number, scalarFrom: number, scalarTo: number): string;
+    editorReplaceTextScalar(editorId: number, scalarFrom: number, scalarTo: number, text: string): string;
+    editorSplitBlockScalar(editorId: number, scalarPos: number): string;
+    editorDeleteAndSplitScalar(editorId: number, scalarFrom: number, scalarTo: number): string;
+    editorSetSelectionScalar(editorId: number, scalarAnchor: number, scalarHead: number): void;
+    editorToggleMarkAtSelectionScalar(editorId: number, scalarAnchor: number, scalarHead: number, markName: string): string;
+    editorSetMarkAtSelectionScalar(editorId: number, scalarAnchor: number, scalarHead: number, markName: string, attrsJson: string): string;
+    editorUnsetMarkAtSelectionScalar(editorId: number, scalarAnchor: number, scalarHead: number, markName: string): string;
+    editorToggleBlockquoteAtSelectionScalar(editorId: number, scalarAnchor: number, scalarHead: number): string;
+    editorToggleHeadingAtSelectionScalar(editorId: number, scalarAnchor: number, scalarHead: number, level: number): string;
+    editorWrapInListAtSelectionScalar(editorId: number, scalarAnchor: number, scalarHead: number, listType: string): string;
+    editorUnwrapFromListAtSelectionScalar(editorId: number, scalarAnchor: number, scalarHead: number): string;
+    editorIndentListItemAtSelectionScalar(editorId: number, scalarAnchor: number, scalarHead: number): string;
+    editorOutdentListItemAtSelectionScalar(editorId: number, scalarAnchor: number, scalarHead: number): string;
+    editorInsertNodeAtSelectionScalar(editorId: number, scalarAnchor: number, scalarHead: number, nodeType: string): string;
+    editorDocToScalar(editorId: number, docPos: number): number;
+    editorScalarToDoc(editorId: number, scalar: number): number;
+    editorWrapInList(editorId: number, listType: string): string;
+    editorUnwrapFromList(editorId: number): string;
+    editorIndentListItem(editorId: number): string;
+    editorOutdentListItem(editorId: number): string;
+    editorInsertNode(editorId: number, nodeType: string): string;
+    editorUndo(editorId: number): string;
+    editorRedo(editorId: number): string;
+    editorCanUndo(editorId: number): boolean;
+    editorCanRedo(editorId: number): boolean;
+}
+export interface Selection {
+    type: 'text' | 'node' | 'all';
+    anchor?: number;
+    head?: number;
+    pos?: number;
+}
+export interface ListContext {
+    ordered: boolean;
+    index: number;
+    total: number;
+    start: number;
+    isFirst: boolean;
+    isLast: boolean;
+    kind?: string | null;
+    checked?: boolean | null;
+}
+export interface RenderMarkWithAttrs {
+    type: string;
+    [key: string]: unknown;
+}
+export type RenderMark = string | RenderMarkWithAttrs;
+export interface RenderElement {
+    type: 'textRun' | 'blockStart' | 'blockEnd' | 'voidInline' | 'voidBlock' | 'opaqueInlineAtom' | 'opaqueBlockAtom';
+    text?: string;
+    marks?: RenderMark[];
+    nodeType?: string;
+    depth?: number;
+    docPos?: number;
+    label?: string;
+    attrs?: Record<string, unknown>;
+    mentionTheme?: EditorMentionTheme;
+    listContext?: ListContext;
+}
+interface RenderBlocksPatch {
+    startIndex: number;
+    deleteCount: number;
+    renderBlocks: RenderElement[][];
+}
+export interface ActiveState {
+    marks: Record<string, boolean>;
+    markAttrs: Record<string, Record<string, unknown>>;
+    nodes: Record<string, boolean>;
+    commands: Record<string, boolean>;
+    allowedMarks: string[];
+    insertableNodes: string[];
+}
+export interface HistoryState {
+    canUndo: boolean;
+    canRedo: boolean;
+}
+export interface EditorUpdate {
+    renderElements: RenderElement[];
+    renderBlocks?: RenderElement[][];
+    renderPatch?: RenderBlocksPatch;
+    selection: Selection;
+    activeState: ActiveState;
+    historyState: HistoryState;
+    documentVersion?: number;
+}
+export interface ParseUpdateOptions {
+    rejectSameDocumentVersion?: boolean;
+    rejectVersionlessAfterDocumentVersion?: boolean;
+}
+export interface ContentSnapshot {
+    html: string;
+    json: DocumentJSON;
+}
+export interface DocumentJSON {
+    [key: string]: unknown;
+}
+export interface CollaborationPeer {
+    clientId: number;
+    isLocal: boolean;
+    state: Record<string, unknown> | null;
+}
+export interface CollaborationResult {
+    messages: number[][];
+    documentChanged: boolean;
+    documentJson?: DocumentJSON;
+    peersChanged: boolean;
+    peers?: CollaborationPeer[];
+}
+export type CommandBlockedReason = 'composition' | 'detached' | 'pendingUpdate' | 'destroyed' | 'unknown';
+export interface CommandBlockedInfo {
+    blocked: boolean;
+    reason: CommandBlockedReason | null;
+}
+export type EncodedCollaborationStateInput = Uint8Array | readonly number[] | string;
+export declare function normalizeActiveState(raw: unknown): ActiveState;
+export declare function parseEditorUpdateJson(json: string, previousRenderBlocks?: RenderElement[][]): EditorUpdate | null;
+export declare function encodeCollaborationStateBase64(encodedState: EncodedCollaborationStateInput): string;
+export declare function decodeCollaborationStateBase64(base64: string): Uint8Array;
+export declare function parseCollaborationResultJson(json: string): CollaborationResult;
+/** @internal Reset the cached native module reference. For testing only. */
+export declare function _resetNativeModuleCache(): void;
+export declare class NativeEditorBridge {
+    private _editorId;
+    private _schema?;
+    private _destroyed;
+    private _lastSelection;
+    private _documentVersion;
+    private _cachedHtml;
+    private _cachedJsonString;
+    private _renderBlocksCache;
+    private _lastCommandBlocked;
+    private _lastCommandBlockedReason;
+    private _lastCommandPreflightUpdate;
+    private _lastAcceptedUpdateJson;
+    private _hasSeenDocumentVersion;
+    private constructor();
+    /** Create a new editor instance backed by the Rust engine. */
+    static create(config?: {
+        maxLength?: number;
+        schemaJson?: string;
+        allowBase64Images?: boolean;
+    }): NativeEditorBridge;
+    /** The underlying native editor ID. */
+    get editorId(): number;
+    /** Whether this bridge has been destroyed. */
+    get isDestroyed(): boolean;
+    consumeLastCommandBlocked(): boolean;
+    consumeLastCommandBlockedReason(): CommandBlockedReason | null;
+    consumeLastCommandBlockedInfo(): CommandBlockedInfo;
+    consumeLastCommandPreflightUpdate(): EditorUpdate | null;
+    prepareForNativeCommand(): boolean;
+    /** Destroy the editor instance and free native resources. */
+    destroy(): void;
+    /** Set content from HTML. Returns render elements for display. */
+    setHtml(html: string): RenderElement[];
+    /** Get content as HTML. */
+    getHtml(): string;
+    /** Get cached HTML without making a native roundtrip. */
+    getCachedHtml(): string | null;
+    /** Set content from ProseMirror JSON. Returns render elements. */
+    setJson(doc: DocumentJSON): RenderElement[];
+    /** Set content from a serialized ProseMirror JSON string. Returns render elements. */
+    setJsonString(jsonString: string): RenderElement[];
+    /** Get content as raw ProseMirror JSON string. */
+    getJsonString(): string;
+    /** Get cached raw ProseMirror JSON without making a native roundtrip. */
+    getCachedJsonString(): string | null;
+    /** Get cached ProseMirror JSON without making a native roundtrip. */
+    getCachedJson(): DocumentJSON | null;
+    /** Get content as ProseMirror JSON. */
+    getJson(): DocumentJSON;
+    /** Get both HTML and JSON content in one native roundtrip. */
+    getContentSnapshot(): ContentSnapshot;
+    /** Insert text at a document position. Returns the full update. */
+    insertText(pos: number, text: string): EditorUpdate | null;
+    /** Delete a range [from, to). Returns the full update. */
+    deleteRange(from: number, to: number): EditorUpdate | null;
+    /** Replace the current selection with text atomically. */
+    replaceSelectionText(text: string): EditorUpdate | null;
+    /** Toggle a mark (bold, italic, etc.) on the current selection. */
+    toggleMark(markType: string): EditorUpdate | null;
+    /** Set a mark with attrs on the current selection. */
+    setMark(markType: string, attrs: Record<string, unknown>): EditorUpdate | null;
+    /** Set a mark with attrs at an explicit scalar selection. */
+    setMarkAtSelectionScalar(scalarAnchor: number, scalarHead: number, markType: string, attrs: Record<string, unknown>): EditorUpdate | null;
+    /** Remove a mark from the current selection. */
+    unsetMark(markType: string): EditorUpdate | null;
+    /** Remove a mark at an explicit scalar selection. */
+    unsetMarkAtSelectionScalar(scalarAnchor: number, scalarHead: number, markType: string): EditorUpdate | null;
+    /** Toggle blockquote wrapping for the current block selection. */
+    toggleBlockquote(): EditorUpdate | null;
+    /** Toggle a heading level on the current block selection. */
+    toggleHeading(level: number): EditorUpdate | null;
+    /** Set the document selection by anchor and head positions. */
+    setSelection(anchor: number, head: number): void;
+    /** Convert a document position to a scalar position used by native text views. */
+    docToScalar(docPos: number): number;
+    /** Convert a native scalar position back to a document position. */
+    scalarToDoc(scalar: number): number;
+    /** Get the current selection from the Rust engine (synchronous native call).
+     *  Always returns the live selection, not a stale cache. */
+    getSelection(): Selection;
+    /** Update the cached selection from native events (scalar offsets).
+     *  Called by the React component when native selection change events arrive. */
+    updateSelectionFromNative(anchor: number, head: number): void;
+    /** Get the current full state from Rust (render elements, selection, etc.). */
+    getCurrentState(): EditorUpdate | null;
+    /** Get the current selection-related state without render elements. */
+    getSelectionState(): EditorUpdate | null;
+    /** Split the block at a position (Enter key). */
+    splitBlock(pos: number): EditorUpdate | null;
+    /** Insert HTML content at the current selection. */
+    insertContentHtml(html: string): EditorUpdate | null;
+    /** Insert JSON content at the current selection. */
+    insertContentJson(doc: DocumentJSON): EditorUpdate | null;
+    /** Insert JSON content at an explicit scalar selection. */
+    insertContentJsonAtSelectionScalar(scalarAnchor: number, scalarHead: number, doc: DocumentJSON): EditorUpdate | null;
+    /** Insert lazily-built JSON content at an explicit scalar selection. */
+    insertContentJsonAtSelectionScalarLazy(scalarAnchor: number, scalarHead: number, resolveDoc: () => DocumentJSON): EditorUpdate | null;
+    /** Replace entire document with HTML via transaction (preserves undo history). */
+    replaceHtml(html: string): EditorUpdate | null;
+    /** Replace entire document with JSON via transaction (preserves undo history). */
+    replaceJson(doc: DocumentJSON): EditorUpdate | null;
+    /** Replace entire document with a serialized JSON transaction. */
+    replaceJsonString(jsonString: string): EditorUpdate | null;
+    /** Undo the last operation. Returns update or null if nothing to undo. */
+    undo(): EditorUpdate | null;
+    /** Redo the last undone operation. Returns update or null if nothing to redo. */
+    redo(): EditorUpdate | null;
+    /** Check if undo is available. */
+    canUndo(): boolean;
+    /** Check if redo is available. */
+    canRedo(): boolean;
+    /** Toggle a list type on the current selection. Wraps if not in list, unwraps if already in that list type. */
+    toggleList(listType: string): EditorUpdate | null;
+    /** Unwrap the current list item back to a paragraph. */
+    unwrapFromList(): EditorUpdate | null;
+    /** Indent the current list item into a nested list. */
+    indentListItem(): EditorUpdate | null;
+    /** Outdent the current list item to the parent list level. */
+    outdentListItem(): EditorUpdate | null;
+    /** Insert a void node (e.g. 'horizontalRule') at the current selection. */
+    insertNode(nodeType: string): EditorUpdate | null;
+    parseUpdateJson(json: string, options?: ParseUpdateOptions): EditorUpdate | null;
+    private noteUpdate;
+    private shouldRejectUpdate;
+    private parseAndNoteUpdate;
+    private prepareForCommand;
+    private runPreparedCommand;
+    private invalidateContentCaches;
+    private assertNotDestroyed;
+    private currentScalarSelection;
+}
+export declare class NativeCollaborationBridge {
+    private _sessionId;
+    private _destroyed;
+    private constructor();
+    static create(config?: {
+        clientId?: number;
+        fragmentName?: string;
+        schema?: SchemaDefinition;
+        initialDocumentJson?: DocumentJSON;
+        initialEncodedState?: EncodedCollaborationStateInput;
+        localAwareness?: Record<string, unknown>;
+    }): NativeCollaborationBridge;
+    get sessionId(): number;
+    get isDestroyed(): boolean;
+    destroy(): void;
+    getDocumentJson(): DocumentJSON;
+    getEncodedState(): Uint8Array;
+    getEncodedStateBase64(): string;
+    getPeers(): CollaborationPeer[];
+    start(): CollaborationResult;
+    applyLocalDocumentJson(doc: DocumentJSON): CollaborationResult;
+    applyEncodedState(encodedState: EncodedCollaborationStateInput): CollaborationResult;
+    replaceEncodedState(encodedState: EncodedCollaborationStateInput): CollaborationResult;
+    handleMessage(bytes: readonly number[]): CollaborationResult;
+    setLocalAwareness(state: Record<string, unknown>): CollaborationResult;
+    clearLocalAwareness(): CollaborationResult;
+    private assertNotDestroyed;
+}
+export {};