@aicayzer/inkkit 0.0.0-stage → 0.0.2

package/dist/editor.d.ts

@@ -0,0 +1,110 @@
+import { type TableCommand } from './tables.js';
+import { type DocumentInput, type DocumentSnapshot, type ImageAdapter, type ClipboardInput, type ClipboardOutput } from './types.js';
+export type Mark = 'bold' | 'italic' | 'strikethrough' | 'code' | 'link';
+export type Block = {
+    type: 'paragraph';
+} | {
+    type: 'heading';
+    level: number;
+} | {
+    type: 'codeBlock';
+} | {
+    type: 'bulletList';
+} | {
+    type: 'orderedList';
+} | {
+    type: 'taskList';
+};
+export interface CaretState {
+    marks: Mark[];
+    block: Block;
+    /** One quote holds the whole selection; the block is what sits inside it. */
+    quoted: boolean;
+}
+export type FormatCommand = 'heading' | 'paragraph' | 'bold' | 'italic' | 'strikethrough' | 'code' | 'codeBlock' | 'quote' | 'bulletList' | 'orderedList' | 'taskList' | 'link';
+/** The bindings the app sets, by shortcut name; each runs a format command. */
+export type Keymap = Record<string, string[]>;
+export interface EditorEvents {
+    changed(markdown: string, generation: number): void;
+    stateChanged(state: CaretState): void;
+    openLink(href: string): void;
+    copy(text: string): void;
+    error?(error: Error): void;
+    clipboard?(content: ClipboardOutput): void | Promise<void>;
+}
+export declare class InkKitEditor {
+    private readonly events;
+    private readonly options;
+    private editor;
+    private lastMarkdown;
+    private baseline;
+    private documentId;
+    private formatType;
+    private revision;
+    private documentEpoch;
+    private operationSequence;
+    private plainComposing;
+    private plainSearch;
+    private ready;
+    private destroyed;
+    private preservation?;
+    private pasteController;
+    private plain;
+    private root;
+    private clickHandler?;
+    private footnoteKeyHandler?;
+    private copyHandler?;
+    private originalSource;
+    private generation;
+    private loading;
+    private changePlugin;
+    private keys;
+    private constructor();
+    private context;
+    private assertAlive;
+    private assertCurrent;
+    private plainSource;
+    snapshot(expectedGeneration?: number): DocumentSnapshot;
+    clipboardSnapshot(all?: boolean): Promise<ClipboardOutput>;
+    paste(input: ClipboardInput): Promise<void>;
+    pasteAsPlainText(text: string): void;
+    table(command: TableCommand, options?: {
+        rows?: number;
+        columns?: number;
+    }): boolean;
+    destroy(): Promise<void>;
+    private keymapPlugin;
+    static mount(root: HTMLElement, events: EditorEvents, options?: {
+        images?: ImageAdapter;
+    }): Promise<InkKitEditor>;
+    loadDocument(input: DocumentInput): void;
+    reloadDocument(input: DocumentInput): void;
+    private load;
+    find(text: string): void;
+    /** Buffered native typing follows the same input rules as direct typing. */
+    insertText(text: string, generation: number): boolean;
+    /** Let existing keymaps handle buffered editing commands before native fallback. */
+    keyDown(key: string, code: string, metaKey: boolean, ctrlKey: boolean, altKey: boolean, shiftKey: boolean, generation: number): boolean;
+    focus(): void;
+    /** Binds keys, in ProseMirror's names, to the formatting each shortcut runs. Walked in the table's
+     *  order, so a key given to two shortcuts lands the same way every time. */
+    setKeymap(keymap: Keymap): void;
+    /** Dropped files land as one paragraph per path at the drop point: in place of an empty block, after
+     *  the top-level block otherwise, so a list or quote is not opened up by them. */
+    insertPaths(paths: string[], x: number, y: number): void;
+    insertImages(images: {
+        path: string;
+        alt: string;
+        title?: string;
+    }[], x?: number, y?: number): void;
+    private insertBlocks;
+    private withMarkRunSelected;
+    private toggleInlineCode;
+    private list;
+    private quote;
+    private unquote;
+    format(command: FormatCommand, arg?: string | number): void;
+    editReferenceDefinition(label: string, destination: string, title?: string): boolean;
+    insertFootnote(label?: string): void;
+    navigateFootnote(target: 'definition' | 'reference'): boolean;
+}