autumnnote 1.15.0 → 1.16.0

package/types/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * AutumnNote – TypeScript declarations
- * @version 1.15.0
+ * @version 1.16.0
  */
 
 // ---------------------------------------------------------------------------
@@ -16,6 +16,35 @@ export interface PasteErrorData {
   maxBytes?: number;
 }
 
+export interface AutoSavePayload {
+  key: string;
+  html: string;
+  savedAt: number;
+  context: Context;
+}
+
+export interface AutoSaveAdapter {
+  save(payload: AutoSavePayload): void | Promise<void>;
+  load?(payload: { key: string; context: Context }): string | null | Promise<string | null>;
+  remove?(payload: { key: string; context: Context }): void | Promise<void>;
+}
+
+export interface SlashCommand {
+  id: string;
+  label?: string;
+  keywords?: string;
+  run(context: Context): void | Promise<void>;
+}
+
+export interface DocumentAdapter {
+  import?(data: unknown, context: Context): string | Promise<string>;
+  export?(context: Context, html: string): unknown | Promise<unknown>;
+}
+
+export interface CollaborationAdapter {
+  onLocalChange?(html: string, context: Context): void | Promise<void>;
+}
+
 export interface AsnOptions {
   /** Placeholder text when the editor is empty. */
   placeholder?: string;
@@ -85,6 +114,8 @@ export interface AsnOptions {
   markdownPaste?: boolean;
   /** Maximum undo/redo history steps. */
   historyLimit?: number;
+  /** Maximum combined size (chars) of all stacked undo/redo snapshots. Default 10485760 (10 MB). */
+  historyMaxBytes?: number;
   /** Default font family applied to the editable area on init. */
   defaultFontFamily?: string;
   /** Default font size applied to the editable area on init (e.g. '14px'). */
@@ -103,6 +134,10 @@ export interface AsnOptions {
   autoSave?: boolean;
   /** localStorage key used for auto-save. */
   autoSaveKey?: string;
+  /** Debounce delay for auto-save writes. Default: 400ms. */
+  autoSaveDelay?: number;
+  /** Optional persistence adapter; localStorage remains the default. */
+  autoSaveAdapter?: AutoSaveAdapter | null;
   /** Maximum character count for the statusbar warning (0 = unlimited). */
   maxChars?: number;
   /** Maximum word count for the statusbar warning (0 = unlimited). */
@@ -153,6 +188,20 @@ export interface AsnOptions {
 
   /** @mention autocomplete configuration. Activated when mention.onSearch is provided. */
   mention?: MentionOptions | null;
+
+  // ---- Slash command menu ----------------------------------------------------
+
+  /** Show a "/" command palette for quick block insertion (headings, lists, table, image, ...). Default: true. */
+  slashMenu?: boolean;
+  /** Application/plugin-provided slash commands. */
+  slashCommands?: SlashCommand[];
+  /** Import/export adapters keyed by format. */
+  documentAdapters?: Record<string, DocumentAdapter>;
+  /** Optional external image processor, such as a Web Worker bridge. */
+  imageProcessor?: (file: File, helpers: { context: Context }) => string | Promise<string>;
+  collaborationAdapter?: CollaborationAdapter | null;
+  /** Adds stable IDs to top-level blocks for external collaboration adapters. */
+  blockIds?: boolean;
 }
 
 // ---------------------------------------------------------------------------
@@ -334,6 +383,20 @@ export interface AsnLocale {
     restore: string;
     discard: string;
   };
+  slashMenu: {
+    noResults: string;
+    heading1: string;
+    heading2: string;
+    heading3: string;
+    bulletList: string;
+    numberedList: string;
+    checklist: string;
+    blockquote: string;
+    codeBlock: string;
+    horizontalRule: string;
+    table: string;
+    image: string;
+  };
 }
 
 /** Registry of all built-in locales (keys: 'en', 'vi', 'ja', 'zh', 'fr', 'de', 'es', 'ko'). */
@@ -387,6 +450,15 @@ export declare class Context {
   /** Triggers an editor event. */
   triggerEvent(eventName: string, ...args: unknown[]): void;
 
+  /** Applies runtime-safe option changes without recreating the editor. */
+  updateOptions(overrides: Partial<AsnOptions>): this;
+
+  /** Flushes any pending auto-save write. */
+  flushAutoSave(): Promise<void>;
+
+  /** Loads a draft through the configured adapter or localStorage. */
+  loadAutoSave(): Promise<string | null>;
+
   /** Returns the current HTML content of the editor. */
   getHTML(): string;
 
@@ -430,6 +502,15 @@ export declare class Context {
   /** Returns the editor content as a Markdown string. */
   getMarkdown(): string;
 
+  getSelectionBookmark(): { start: number; end: number } | null;
+  restoreSelectionBookmark(bookmark: { start: number; end: number }): boolean;
+  importDocument(format: string, data: unknown): Promise<this>;
+  exportDocument(format: string): Promise<unknown>;
+  ensureBlockIds(): this;
+  getDocument(): { version: 1; html: string; markdown: string };
+  loadDocument(documentData: { html: string }): this;
+  applyRemoteHTML(html: string): this;
+
   /** Returns the current word count of the editor content. */
   getWordCount(): number;
 
@@ -469,6 +550,7 @@ export declare class Context {
    * @param ModuleClass - Class with `initialize()` and optional `destroy()`
    */
   registerModule(name: string, ModuleClass: new (ctx: Context) => object): this;
+  registerSlashCommand(command: SlashCommand): this;
 
   /**
    * Installs a plugin on this editor instance.
@@ -629,6 +711,7 @@ export interface AutumnNoteStatic {
    * referenced by string name in toolbar configuration.
    */
   registerButton(btnDef: ToolbarItemDef): this;
+  registerSlashCommand(command: SlashCommand): this;
 
   /**
    * All pre-built button definitions in a single namespace.