@codeauradev/ngx-wind-editor 0.0.0-stage → 1.0.1

package/types/codeauradev-ngx-wind-editor.d.ts

@@ -0,0 +1,270 @@
+import * as Y from "yjs";
+import * as i0 from "@angular/core";
+declare const BLOCK_TYPES: readonly ["paragraph", "heading", "blockquote", "code", "bullet", "ordered", "rule", "image"];
+type BlockType = (typeof BLOCK_TYPES)[number];
+declare const MARKS: readonly ["bold", "italic", "underline", "strike", "code"];
+type MarkName = (typeof MARKS)[number];
+interface TextAttrs {
+  bold?: boolean;
+  italic?: boolean;
+  underline?: boolean;
+  strike?: boolean;
+  code?: boolean;
+  href?: string;
+}
+interface DeltaOp {
+  insert: string;
+  attributes?: TextAttrs;
+}
+type Delta = DeltaOp[];
+interface BlockData {
+  id: string;
+  type: BlockType;
+  level: number;
+  src: string;
+  alt: string;
+  delta: Delta;
+}
+interface Point {
+  blockId: string;
+  offset: number;
+}
+interface Selection {
+  anchor: Point;
+  head: Point;
+}
+interface EditorSnapshot {
+  html: string;
+  text: string;
+  words: number;
+  characters: number;
+  blockType: BlockType;
+  level: number;
+  marks: TextAttrs;
+  href: string | null;
+  canUndo: boolean;
+  canRedo: boolean;
+  slash: string | null;
+}
+declare function isBlockType(value: unknown): value is BlockType;
+interface LocatedBlock {
+  map: Y.Map<unknown>;
+  index: number;
+  id: string;
+  type: BlockType;
+  level: number;
+  text: Y.Text | null;
+}
+type SlashChoice = 'paragraph' | 'h1' | 'h2' | 'h3' | 'bullet' | 'ordered' | 'quote' | 'code' | 'rule' | 'image';
+declare function blocksOf(doc: Y.Doc): Y.Array<Y.Map<unknown>>;
+declare function makeBlock(type: BlockType, fields?: {
+  level?: number;
+  src?: string;
+  alt?: string;
+  delta?: Delta;
+}): Y.Map<unknown>;
+declare function readDelta(text: Y.Text): Delta;
+export declare function readBlocks(doc: Y.Doc): BlockData[];
+interface SessionSnapshot {
+  blockType: BlockType;
+  level: number;
+  marks: TextAttrs;
+  href: string | null;
+  slash: string | null;
+  canUndo: boolean;
+  canRedo: boolean;
+}
+export declare class WindSession {
+  readonly doc: Y.Doc;
+  readonly origin: object;
+  selection: Selection;
+  private stored;
+  private pendingBefore;
+  private readonly undoManager;
+  private readonly listeners;
+  constructor(doc: Y.Doc);
+  onChange(listener: (structural: boolean) => void): () => void;
+  get html(): string;
+  get text(): string;
+  get words(): number;
+  get canUndo(): boolean;
+  get canRedo(): boolean;
+  undo(): void;
+  redo(): void;
+  select(selection: Selection): void;
+  focusPoint(blockId: string, offset: number): void;
+  insertText(value: string): void;
+  deleteBackward(): void;
+  deleteForward(): void;
+  split(mode: 'enter' | 'hard' | 'exit'): void;
+  toggleMark(mark: MarkName): void;
+  setLink(href: string | null): void;
+  clearMarks(): void;
+  setBlockType(type: BlockType, level?: number): void;
+  insertDivider(): void;
+  insertImage(src: string, alt?: string): void;
+  applySlash(choice: SlashChoice): 'image' | 'applied';
+  paste(html: string | null, plain: string | null): void;
+  replaceHtml(html: string): void;
+  reconcileText(blockId: string, next: string): void;
+  snapshot(): SessionSnapshot;
+  dismissSlash(): void;
+  private slashQuery;
+  private consumeSlash;
+  private typingAttrs;
+  private effectiveMarks;
+  private toolbarMarks;
+  private rangeHas;
+  private formatRange;
+  private iterRange;
+  private deleteRange;
+  private insertParsed;
+  private selectedBlocks;
+  private ensureText;
+  private ensureBlock;
+  private current;
+  private clampSelection;
+  private transact;
+  private emit;
+}
+export declare function loadHtml(doc: Y.Doc, html: string, origin?: unknown): void;
+interface SlashItem {
+  id: SlashChoice;
+  label: string;
+  hint: string;
+  keys: string;
+}
+export declare const SLASH_ITEMS: readonly SlashItem[];
+export declare function filterSlash(query: string): SlashItem[];
+export declare const WIND_TOOLS: readonly ["paragraph", "h1", "h2", "bold", "italic", "underline", "strike", "code", "link", "bullet", "ordered", "quote", "codeblock", "rule", "image", "clear", "undo", "redo", "source"];
+type WindTool = (typeof WIND_TOOLS)[number];
+type WindToolbarPreset = 'full' | 'writing' | 'basic' | 'minimal';
+export declare const WIND_TOOLBAR_PRESETS: Record<WindToolbarPreset, readonly WindTool[]>;
+export declare function isWindTool(value: string): value is WindTool;
+export declare function isToolbarPreset(value: string): value is WindToolbarPreset;
+/** A preset name, or an explicit list. Unknown ids are dropped. List order is the button order. */
+export declare function resolveToolbar(value?: WindToolbarPreset | readonly string[] | null): WindTool[];
+interface SlashPoint {
+  top: number;
+  left: number;
+}
+interface SurfaceChange extends EditorSnapshot {
+  slashRect: SlashPoint | null;
+}
+type WindCommand = {
+  type: 'mark';
+  mark: MarkName;
+} | {
+  type: 'link';
+  href: string | null;
+} | {
+  type: 'clear';
+} | {
+  type: 'block';
+  block: BlockType;
+  level?: number;
+} | {
+  type: 'divider';
+} | {
+  type: 'image';
+  src: string;
+  alt?: string;
+} | {
+  type: 'undo';
+} | {
+  type: 'redo';
+} | {
+  type: 'slash';
+  choice: SlashChoice;
+};
+interface WindMount {
+  destroy(): void;
+  focus(): void;
+  exec(command: WindCommand): void;
+  setReadonly(readonly: boolean): void;
+  setPlaceholder(value: string): void;
+  setHtml(html: string): void;
+  getHtml(): string;
+  session: WindSession;
+}
+interface SurfaceOptions {
+  html?: string;
+  placeholder?: string;
+  readonly?: boolean;
+  onChange?: (change: SurfaceChange) => void;
+  /** Return true to swallow the key (slash menu, for example). */
+  interceptKey?: (event: KeyboardEvent) => boolean;
+  onLink?: () => void;
+}
+declare function mountWindSurface(host: HTMLElement, options: SurfaceOptions): WindMount;
+interface Tool {
+  id: WindTool;
+  label: string;
+  icon: string;
+}
+export declare class WindEditor {
+  readonly html: import("@angular/core").ModelSignal<string>;
+  readonly placeholder: import("@angular/core").InputSignal<string>;
+  readonly readOnly: import("@angular/core").InputSignal<boolean>;
+  readonly showToolbar: import("@angular/core").InputSignal<boolean>;
+  /** Preset name, or the buttons to show, in order. */
+  readonly toolbar: import("@angular/core").InputSignal<readonly ("paragraph" | "code" | "bullet" | "ordered" | "rule" | "image" | "bold" | "italic" | "underline" | "strike" | "link" | "source" | "h1" | "h2" | "quote" | "undo" | "redo" | "codeblock" | "clear")[] | WindToolbarPreset>;
+  protected readonly tools: import("@angular/core").Signal<Tool[]>;
+  protected readonly change: import("@angular/core").WritableSignal<SurfaceChange | null>;
+  protected readonly linkOpen: import("@angular/core").WritableSignal<boolean>;
+  protected readonly linkDraft: import("@angular/core").WritableSignal<string>;
+  protected readonly imageOpen: import("@angular/core").WritableSignal<boolean>;
+  protected readonly imageSrc: import("@angular/core").WritableSignal<string>;
+  protected readonly imageAlt: import("@angular/core").WritableSignal<string>;
+  protected readonly sourceOpen: import("@angular/core").WritableSignal<boolean>;
+  protected readonly sourceDraft: import("@angular/core").WritableSignal<string>;
+  protected readonly slashIndex: import("@angular/core").WritableSignal<number>;
+  protected readonly slashItems: import("@angular/core").Signal<SlashItem[]>;
+  private readonly surfaceRef;
+  private readonly destroyRef;
+  private handle;
+  private echo;
+  constructor();
+  protected pressed(id: string): boolean;
+  protected disabled(id: string): boolean;
+  protected run(id: string): void;
+  protected pickSlash(item: SlashItem): void;
+  protected applyLink(event: Event): void;
+  protected clearLink(): void;
+  protected applyImage(event: Event): void;
+  protected applySource(): void;
+  protected onDraft(event: Event, field: 'link' | 'src' | 'alt' | 'source'): void;
+  private attach;
+  private onKey;
+  static ɵfac: i0.ɵɵFactoryDeclaration<WindEditor, never>;
+  static ɵcmp: i0.ɵɵComponentDeclaration<WindEditor, "wind-editor", never, {
+    "html": {
+      "alias": "html";
+      "required": false;
+      "isSignal": true;
+    };
+    "placeholder": {
+      "alias": "placeholder";
+      "required": false;
+      "isSignal": true;
+    };
+    "readOnly": {
+      "alias": "readonly";
+      "required": false;
+      "isSignal": true;
+    };
+    "showToolbar": {
+      "alias": "showToolbar";
+      "required": false;
+      "isSignal": true;
+    };
+    "toolbar": {
+      "alias": "toolbar";
+      "required": false;
+      "isSignal": true;
+    };
+  }, {
+    "html": "htmlChange";
+  }, never, never, true, never>;
+}
+export type { BlockData, BlockType, EditorSnapshot, MarkName, Selection, SlashChoice, SlashItem, TextAttrs, WindTool, WindToolbarPreset };