phormat 0.0.5

package/dist/editor/MarkdownEditor.svelte.d.ts

@@ -0,0 +1,160 @@
+import { type TreeDropPlacement, type DocumentSelection, type EditorBlock, type EditorDocument, type EditorTransaction, type FocusOutcome, type InlineWrapKind, type EditorSelection, type SourceEditResult } from './model';
+import type { EditorBlockType, InlineNode, TableCellAddress } from './model/types';
+import type { CalloutBlock } from './block-specs/callout/types';
+import type { AnyEditorRenderBlock } from './plugins';
+import type { HeaderBlock } from './block-specs/heading/types';
+export type SetSourceOptions = {
+    fileName?: string | null;
+    /** Clear undo/redo and dirty-block tracking. Default `true`. */
+    resetHistory?: boolean;
+    /** Set `#lastSavedSource` to the new source. Default `true`. */
+    syncBaseline?: boolean;
+    selection?: EditorSelection;
+};
+export declare class MarkdownEditor {
+    #private;
+    get source(): string;
+    set source(value: string);
+    get fileName(): string | null;
+    set fileName(value: string | null);
+    get document(): EditorDocument;
+    get blocks(): AnyEditorRenderBlock[];
+    constructor();
+    get isLoading(): boolean;
+    get error(): string | null;
+    get selection(): EditorSelection;
+    get documentSelection(): DocumentSelection | null;
+    get isReparsing(): boolean;
+    /** Whether a post-structural focus restore is pending for this block (suppress stale blur cleanup). */
+    isPendingFocusTarget(blockId: string): boolean;
+    get sourceLineCount(): number;
+    get sourceCharacterCount(): number;
+    get dirty(): boolean;
+    /** Stable ids of top-level blocks touched by edits (cleared on load, draft restore, undo/redo). Used with `serializeMarkdownDocumentPreserving`. */
+    get dirtyBlockIds(): ReadonlySet<string>;
+    isBlockDirty(id: string): boolean;
+    get readonly(): boolean;
+    setReadonly(value: boolean): void;
+    get canUndo(): boolean;
+    get canRedo(): boolean;
+    markSaved(): void;
+    /** Replace document source — used by controlled embedders and demo file load. */
+    setSource(source: string, opts?: SetSourceOptions): void;
+    /** Subscribe to source mutations (not fired during silent {@link setSource}). Returns unsubscribe. */
+    onSourceChange(listener: (source: string) => void): () => void;
+    commitSourceEdit(result: SourceEditResult, dirtyBlockIndices?: readonly number[], focusAfter?: FocusOutcome): boolean;
+    /** Apply a built transaction through the same undo/history path as {@link commitSourceEdit}. */
+    commitTransaction(transaction: EditorTransaction, dirtyBlockIndices?: readonly number[], focusAfter?: FocusOutcome): boolean;
+    undo(): boolean;
+    redo(): boolean;
+    /** One undo step per focused plain-text session (paragraph / heading body). */
+    beginPlainEditSession(blockIndex: number): void;
+    commitPlainEditSession(): void;
+    silentUpdateBlockPlain(blockIndex: number, plainText: string, kind: 'paragraph' | 'heading', selectionPlainOffset: number): boolean;
+    commitParagraphInlineDraftAt(blockIndex: number, inlines: InlineNode[], plainCaret: number): boolean;
+    commitHeadingInlineDraftAt(blockIndex: number, inlines: InlineNode[], plainCaret: number): boolean;
+    commitTableCellInlineDraftAt(blockIndex: number, row: number, col: number, inlines: InlineNode[], plainCaret: number): boolean;
+    navigateTableCellAt(blockIndex: number, from: TableCellAddress, to: TableCellAddress, inlines: InlineNode[], plainCaret: number): boolean;
+    appendTableRowAt(blockIndex: number): boolean;
+    appendTableColumnAt(blockIndex: number): boolean;
+    convertBlockToTableAt(blockIndex: number): boolean;
+    commitListItemInlineDraftAt(blockIndex: number, itemId: string, inlines: InlineNode[], _plainCaret: number): boolean;
+    commitBlockquoteBodyInlineDraftAt(topBlockIndex: number, quoteBlockId: string, inlines: InlineNode[], _plainCaret: number): boolean;
+    commitBlockquoteParagraphInlineDraftAt(topBlockIndex: number, paragraphId: string, inlines: InlineNode[], _plainCaret: number): boolean;
+    commitCalloutOpenerDraftAt(topBlockIndex: number, calloutId: string, data: CalloutBlock): boolean;
+    commitCalloutParagraphInlineDraftAt(topBlockIndex: number, paragraphId: string, inlines: InlineNode[], _plainCaret: number): boolean;
+    commitCalloutListItemInlineDraftAt(topBlockIndex: number, itemId: string, inlines: InlineNode[], _plainCaret: number): boolean;
+    /** Ensure an imported opener-only callout has a real empty body line in source. */
+    ensureCalloutEmptyBodyAt(blockIndex: number): boolean;
+    updateBlockPlain(blockIndex: number, plainText: string, kind: 'paragraph' | 'heading', selectionPlainOffset: number): boolean;
+    /** @deprecated Use {@link tryStructuralMarkdownShortcut}. */
+    maybeApplyParagraphShortcut(blockIndex: number, plainText: string): void;
+    /** Sole public Enter API — dispatches by block type, commits via transactions, sets post-split focus. */
+    enterAt({ blockId, plainOffset, plainText }: {
+        blockId: string;
+        plainOffset: number;
+        plainText: string;
+    }): boolean;
+    shouldSuppressPlainInputForBlock(blockId: string): boolean;
+    shouldSkipTableCellBlurCommit(): boolean;
+    /** Set post-command caret: resolves to {@link DocumentSelection} + one-shot pending focus. */
+    setFocusOutcome(target: FocusOutcome): void;
+    mergeWithPrevious(blockIndex: number): boolean;
+    /** Line-start `#` / `-` / `1.` shortcut when the pattern is complete (Space, Enter, or blur). */
+    tryStructuralMarkdownShortcut(blockIndex: number, plainText: string): boolean;
+    insertEmptyParagraph(blockIndex: number, after: boolean): boolean;
+    deleteBlockAt(blockIndex: number): boolean;
+    /** Replace one block’s source slice (code fences, lists, blockquotes). */
+    replaceBlockMarkdown(blockIndex: number, markdown: string): boolean;
+    /** Coalesced list/blockquote/code edits within {@link beginPlainEditSession} (no undo frame per keystroke). */
+    silentReplaceBlockMarkdown(blockIndex: number, markdown: string): boolean;
+    applyInlineWrapAt(blockIndex: number, plainStart: number, plainEnd: number, kind: InlineWrapKind, linkHref?: string): boolean;
+    duplicateBlockAt(blockIndex: number): boolean;
+    moveBlockUpAt(blockIndex: number): boolean;
+    moveBlockDownAt(blockIndex: number): boolean;
+    moveBlockToIndex(fromIndex: number, toIndex: number): boolean;
+    convertParagraphToHeadingAt(blockIndex: number, level: HeaderBlock['level']): boolean;
+    convertParagraphToBulletListAt(blockIndex: number): boolean;
+    convertHeadingToParagraphAt(blockIndex: number): boolean;
+    convertHeadingLevelAt(blockIndex: number, level: HeaderBlock['level']): boolean;
+    setSelection(sel: EditorSelection): void;
+    setDocumentSelection(sel: DocumentSelection): void;
+    /**
+     * Caret/selection updates from a focused surface (selectionchange, keyup, input).
+     * Ignored while reparsing or another block owns {@link #pendingFocusBlockId}.
+     */
+    emitDocumentSelection(sel: DocumentSelection): void;
+    /** Focus moved to this surface; ignored while reparsing or another block owns post-split focus. */
+    claimDocumentSelection(sel: DocumentSelection): void;
+    /** Whether this block (and optional table cell) should receive one-shot programmatic focus. */
+    takePendingFocusForBlock(blockId: string, tableCell?: TableCellAddress, surfaceBlockType?: EditorBlockType): boolean;
+    clearDocumentSelection(blockId: string): void;
+    registerInlinePlainFocus(blockIndex: number, start: number, end: number): void;
+    clearInlinePlainFocus(blockIndex: number): void;
+    getInlinePlainFocus(blockIndex: number): {
+        start: number;
+        end: number;
+    } | null;
+    getDocumentSelectionPlain(blockId: string): {
+        start: number;
+        end: number;
+    } | null;
+    moveListItemSiblingAt(blockIndex: number, itemId: string, direction: 'up' | 'down'): boolean;
+    blockTreeDropAt(draggedId: string, targetId: string, placement: TreeDropPlacement): boolean;
+    applyBlockTreeTabReparent(blockId: string, shift: boolean, focusPlain?: {
+        start: number;
+        end: number;
+    }): boolean;
+    listItemTreeDropAt(blockIndex: number, draggedId: string, targetId: string, placement: TreeDropPlacement): boolean;
+    deleteListItemAt(blockIndex: number, itemId: string): boolean;
+    applyListStructMutation(blockIndex: number, itemId: string, mutate: (blocks: EditorBlock[]) => EditorBlock[] | null, opts?: {
+        focusBlockId?: string;
+        focusPlain?: {
+            start: number;
+            end: number;
+        };
+        preserveBlockId?: string;
+    }): boolean;
+    applyQuoteStructMutation(blockIndex: number, quoteBlockId: string, mutate: (root: EditorBlock) => EditorBlock | null, opts?: {
+        focusBlockId?: string;
+    }): boolean;
+    updateListItemBodyAt(blockIndex: number, itemId: string, plain: string): boolean;
+    duplicateListItemAt(blockIndex: number, itemId: string): boolean;
+    moveQuoteParagraphSiblingAt(blockIndex: number, paragraphId: string, direction: 'up' | 'down'): boolean;
+    quoteParagraphReorderAt(blockIndex: number, quotePath: readonly number[], fromIndex: number, toIndex: number, paragraphId: string): boolean;
+    deleteQuoteParagraphAt(blockIndex: number, paragraphId: string): boolean;
+    duplicateQuoteParagraphAt(blockIndex: number, paragraphId: string): boolean;
+    moveCalloutChildSiblingAt(blockIndex: number, childId: string, direction: 'up' | 'down'): boolean;
+    calloutBodyTreeDropAt(blockIndex: number, draggedId: string, targetId: string, placement: TreeDropPlacement): boolean;
+    deleteCalloutChildAt(blockIndex: number, childId: string): boolean;
+    duplicateCalloutChildAt(blockIndex: number, childId: string): boolean;
+    applyCalloutStructMutation(blockIndex: number, anchorBlockId: string, mutate: (blocks: import('./model/types').EditorBlock[]) => import('./model/types').EditorBlock[] | null, opts?: {
+        focusBlockId?: string;
+        focusPlain?: {
+            start: number;
+            end: number;
+        };
+        preserveBlockId?: string;
+    }): boolean;
+    applyInlineWrapOnNestedRow(blockIndex: number, rowBlockId: string, plainStart: number, plainEnd: number, kind: InlineWrapKind, linkHref?: string): boolean;
+}