proposal-studio 0.1.2

package/dist/proposal-studio.d.ts

@@ -0,0 +1,90 @@
+// Type definitions for proposal-studio.
+
+/** A message posted by the editor iframe (re-broadcast as a `message` event). */
+export interface ProposalStudioMessage {
+  source?: string;
+  type?: string;
+  [key: string]: unknown;
+}
+
+export interface ProposalStudioReadyDetail {
+  editor: ProposalStudioElement;
+}
+export interface ProposalStudioChangeDetail {
+  html: string;
+}
+export interface ProposalStudioResizeDetail {
+  height: number;
+}
+
+export interface ProposalStudioEventMap {
+  ready: CustomEvent<ProposalStudioReadyDetail>;
+  change: CustomEvent<ProposalStudioChangeDetail>;
+  resize: CustomEvent<ProposalStudioResizeDetail>;
+  message: CustomEvent<ProposalStudioMessage>;
+}
+
+/**
+ * The `<proposal-studio>` custom element. Hosts the visual editor in an
+ * isolated, same-origin iframe.
+ */
+export declare class ProposalStudioElement extends HTMLElement {
+  static readonly observedAttributes: string[];
+
+  /** True once the editor engine has booted inside the iframe. */
+  readonly ready: boolean;
+  /** The editor iframe's window (same-origin). */
+  readonly contentWindow: Window | null;
+  /** The editor iframe's document. */
+  readonly contentDocument: Document | null;
+
+  /** Get/set the canvas HTML. */
+  value: string;
+
+  /** Resolves when the editor is ready (immediately if already ready). */
+  whenReady(): Promise<this>;
+  /** Returns the current canvas HTML (or '' before ready). */
+  getHtml(): string;
+  /** Replaces the canvas content; queued if called before ready. */
+  setHtml(html: string): this;
+  /** Alias of setHtml, reads naturally when loading a saved template. */
+  loadTemplate(html: string): this;
+  /** Low-level: post a message to the editor iframe. */
+  post(message: unknown): this;
+  /** Focus the editor canvas. */
+  focus(): void;
+
+  addEventListener<K extends keyof ProposalStudioEventMap>(
+    type: K,
+    listener: (this: ProposalStudioElement, ev: ProposalStudioEventMap[K]) => unknown,
+    options?: boolean | AddEventListenerOptions
+  ): void;
+  addEventListener(
+    type: string,
+    listener: EventListenerOrEventListenerObject,
+    options?: boolean | AddEventListenerOptions
+  ): void;
+  removeEventListener<K extends keyof ProposalStudioEventMap>(
+    type: K,
+    listener: (this: ProposalStudioElement, ev: ProposalStudioEventMap[K]) => unknown,
+    options?: boolean | EventListenerOptions
+  ): void;
+  removeEventListener(
+    type: string,
+    listener: EventListenerOrEventListenerObject,
+    options?: boolean | EventListenerOptions
+  ): void;
+}
+
+export declare const TAG_NAME: 'proposal-studio';
+
+/** Register the custom element (idempotent). */
+export declare function defineProposalStudio(tagName?: string): typeof ProposalStudioElement;
+
+export default ProposalStudioElement;
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'proposal-studio': ProposalStudioElement;
+  }
+}