@openstage/glyph-element 0.2.0

package/dist/editor-element.d.ts

@@ -0,0 +1,93 @@
+import { type EditorApi, type EditorConfig, type EditorDocument, type EditorTheme, type SlashCommand } from '@openstage/glyph-core';
+/**
+ * Public shape of the `<glyph-editor>` element. The DOM type is also augmented
+ * (`HTMLElementTagNameMap`), so `document.querySelector('glyph-editor')` is
+ * typed as this interface automatically.
+ *
+ * Properties accept rich values (objects/arrays) and must be set in JavaScript,
+ * not via HTML attributes. The only attributes observed are `placeholder` and
+ * `show-header`.
+ *
+ * Events (all `bubbles: true, composed: true` so they cross Shadow DOM):
+ * - `content-change` — `CustomEvent<EditorDocument>`, fired on every edit
+ * - `selection-change` — `CustomEvent<void>`, caret/selection moved
+ * - `ready` — `CustomEvent<void>`, editor initialised
+ * - `focus` / `blur` — `CustomEvent<void>`
+ */
+export interface GlyphEditorElement extends HTMLElement {
+    /** The current document. Reading returns {@link getJSON}; writing calls {@link setContent}. */
+    content: EditorDocument;
+    /** Color theme; merged onto CSS custom properties. Omit for the built-in light theme. */
+    theme?: EditorTheme;
+    /** Slash-command menu entries. Defaults to the built-in set; assign to replace. */
+    commands?: readonly SlashCommand[];
+    /** Toolbar/behaviour configuration. Assigning rebuilds the editor instance. */
+    config?: EditorConfig;
+    /**
+     * Returns the current document as canonical JSON. Safe to persist verbatim
+     * and later pass back to {@link setContent}.
+     */
+    getJSON(): EditorDocument;
+    /**
+     * Replaces the document. The input is validated and migrated to the current
+     * schema; an invalid value throws `TypeError`.
+     *
+     * @param document - A document previously produced by {@link getJSON} (or
+     *   built with the `@openstage/glyph-core` node constructors).
+     */
+    setContent(document: EditorDocument): void;
+    /** Moves keyboard focus into the editor. */
+    focus(): void;
+    /**
+     * The abstracted command surface (no engine types). For headless usage set
+     * `config.showHeader = false` and drive the editor from your own UI plus the
+     * DOM events. Throws if called before the element is connected to the DOM.
+     *
+     * @example
+     * ```ts
+     * const api = editor.getApi();
+     * api.toggleBold();
+     * api.setHeading(2);
+     * ```
+     */
+    getApi(): EditorApi;
+    /**
+     * Sets the text shown in the toolbar `status` slot (e.g. save state).
+     * No-op if `status` is not part of the configured toolbar.
+     *
+     * @param text - Status text, or `''` to clear it.
+     */
+    setStatus(text: string): void;
+}
+/**
+ * `<glyph-editor>` implementation. Instantiated by the browser via the custom
+ * element registry — construct it through the DOM
+ * (`document.createElement('glyph-editor')` or markup), never with `new`.
+ *
+ * All implementation state uses ECMAScript private fields (`#x`) so the emitted
+ * type declarations expose no engine (Tiptap/ProseMirror) types.
+ *
+ * @see {@link GlyphEditorElement} for the documented public API.
+ */
+export declare class GlyphEditor extends HTMLElement implements GlyphEditorElement {
+    #private;
+    static get observedAttributes(): string[];
+    constructor();
+    get content(): EditorDocument;
+    set content(document: EditorDocument);
+    get theme(): EditorTheme | undefined;
+    set theme(theme: EditorTheme | undefined);
+    get commands(): readonly SlashCommand[];
+    set commands(commands: readonly SlashCommand[]);
+    get config(): EditorConfig;
+    set config(config: EditorConfig);
+    getJSON: () => EditorDocument;
+    setContent: (document: EditorDocument) => void;
+    focus: () => void;
+    getApi: () => EditorApi;
+    setStatus: (text: string) => void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(): void;
+}
+//# sourceMappingURL=editor-element.d.ts.map

package/dist/editor-element.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor-element.d.ts","sourceRoot":"","sources":["../src/editor-element.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,KAAK,cAAc,EAEnB,KAAK,WAAW,EAChB,KAAK,YAAY,EAMlB,MAAM,uBAAuB,CAAC;AAQ/B;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,+FAA+F;IAC/F,OAAO,EAAE,cAAc,CAAC;IACxB,yFAAyF;IACzF,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,mFAAmF;IACnF,QAAQ,CAAC,EAAE,SAAS,YAAY,EAAE,CAAC;IACnC,+EAA+E;IAC/E,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB;;;OAGG;IACH,OAAO,IAAI,cAAc,CAAC;IAC1B;;;;;;OAMG;IACH,UAAU,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;IAC3C,4CAA4C;IAC5C,KAAK,IAAI,IAAI,CAAC;IACd;;;;;;;;;;;OAWG;IACH,MAAM,IAAI,SAAS,CAAC;IACpB;;;;;OAKG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;;;;;;;;GASG;AACH,qBAAa,WAAY,SAAQ,WAAY,YAAW,kBAAkB;;IACxE,MAAM,KAAK,kBAAkB,IAAI,MAAM,EAAE,CAExC;;IAuBD,IAAI,OAAO,IAAI,cAAc,CAE5B;IACD,IAAI,OAAO,CAAC,QAAQ,EAAE,cAAc,EAEnC;IAED,IAAI,KAAK,IAAI,WAAW,GAAG,SAAS,CAEnC;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,EAGvC;IAED,IAAI,QAAQ,IAAI,SAAS,YAAY,EAAE,CAEtC;IACD,IAAI,QAAQ,CAAC,QAAQ,EAAE,SAAS,YAAY,EAAE,EAG7C;IAED,IAAI,MAAM,IAAI,YAAY,CAEzB;IACD,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,EAG9B;IAED,OAAO,QAAO,cAAc,CAC2C;IAEvE,UAAU,GAAI,UAAU,cAAc,KAAG,IAAI,CAM3C;IAEO,KAAK,QAAO,IAAI,CAEvB;IAEF,MAAM,QAAO,SAAS,CAGpB;IAEF,SAAS,GAAI,MAAM,MAAM,KAAG,IAAI,CAG9B;IAEF,iBAAiB,IAAI,IAAI;IAIzB,oBAAoB,IAAI,IAAI;IAI5B,wBAAwB,IAAI,IAAI;CA+NjC"}