docxodus 9.1.0 → 9.2.0

package/dist/ribbon-chrome.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ribbon-chrome.js","sourceRoot":"","sources":["../src/ribbon-chrome.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,sFAAsF;AACtF,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,CAAC;AACxC,MAAM,CAAC,MAAM,iBAAiB,GAAG,6BAA6B,CAAC;AAE/D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAypBzB,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE,CAClC,sEAAsE,IAAI,QAAQ,CAAC;AAErF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wFA4D6D,UAAU,CACtF,mLAAmL,CACpL;4FACiF,UAAU,CAC1F,mLAAmL,CACpL;0FAC+E,UAAU,CACxF,mLAAmL,CACpL;wFAC6E,UAAU,CACtF,qLAAqL,CACtL;8FACmF,UAAU,CAC5F,oNAAoN,CACrN;6FACkF,UAAU,CAC3F,kNAAkN,CACnN;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0LV,CAAC;AAEF,sEAAsE;AACtE,MAAM,CAAC,MAAM,gBAAgB,GAC3B,uFAAuF;IACvF,sGAAsG;IACtG,qGAAqG;IACrG,yDAAyD,CAAC"}

package/dist/ribbon.d.ts

@@ -0,0 +1,153 @@
+/**
+ * The ribbon surface — the full editor UI as a mountable module.
+ *
+ * `DocxEditor` (editor.ts) is the document engine: it owns the live `DocxSession`,
+ * the block wiring and every command. It has deliberately no chrome. This module is
+ * the chrome — the tabbed ribbon, the anchor rail, the table picker and the loading
+ * overlay — wired onto exactly that command surface and nothing else.
+ *
+ * It exists because the same UI was hand-written three times (the standalone demo,
+ * the GitHub Pages landing page, the compact iframe player) and drifted. Now the
+ * surface has one owner, and the three hosts differ only in how they obtain the
+ * WASM exports and how much of the chrome they turn on:
+ *
+ * ```ts
+ * // Host that already booted the .NET runtime itself:
+ * const ribbon = mountRibbon(document.querySelector("#app")!, { exports });
+ * ribbon.open(bytes, "contract.docx");
+ *
+ * // Host that wants one call and a CDN (see embed.ts):
+ * await createRibbonEditor("#app", "./contract.docx", { chrome: "auto" });
+ * ```
+ *
+ * Chrome density is measured from the ROOT ELEMENT, not the viewport: a narrow
+ * embed on a wide desktop page is narrow. See ribbon-chrome.ts for the layout.
+ */
+import { DocxEditor } from "./editor.js";
+import type { DocxEditorExports, DocxEditorOptions } from "./editor.js";
+export { DocxEditor } from "./editor.js";
+export type { DocxEditorExports, DocxEditorOptions } from "./editor.js";
+/** Which layout the chrome uses. "auto" measures the root and switches at `compactBreakpoint`. */
+export type RibbonChromeMode = "full" | "compact" | "auto";
+/** The lifecycle the surface reports on its root as `data-state`. */
+export type RibbonState = "idle" | "loading" | "ready" | "error";
+/** One step of the loading narrative: what is happening, and how far along it is. */
+export interface RibbonLoaderStage {
+    title: string;
+    copy: string;
+    /** 0–100. Drives the progress bar. */
+    progress: number;
+    /** The short machine-side label under the bar. */
+    label: string;
+}
+/** A rotating capability card shown while the engine streams. */
+export interface RibbonLoaderFeature {
+    number: string;
+    title: string;
+    copy: string;
+}
+export interface RibbonLoaderOptions {
+    /** Replace the four default stages. */
+    stages?: RibbonLoaderStage[];
+    /** Replace the rotating cards. Pass `[]` to hide the card entirely. */
+    features?: RibbonLoaderFeature[];
+    /** Micro-caps line above the title. */
+    eyebrow?: string;
+    /** Right-hand label under the progress bar. */
+    meta?: string;
+    /** Milliseconds between card rotations. Default 1750. */
+    rotateMs?: number;
+    /** What the Retry button does. Default: reload the page. */
+    onRetry?: () => void;
+}
+export interface RibbonOptions extends DocxEditorOptions {
+    /** WASM exports. Omit to mount chrome first (showing the loader) and call `setExports` later. */
+    exports?: DocxEditorExports;
+    /** Layout density. Default "auto". */
+    chrome?: RibbonChromeMode;
+    /** Root width, in px, below which "auto" picks compact. Default 720. */
+    compactBreakpoint?: number;
+    /** Show the anchor rail (full chrome only). Default true. */
+    rail?: boolean;
+    /** Show New / Open / Save. Default true. */
+    fileActions?: boolean;
+    /**
+     * Editing hint above the document: false to hide, or a string to replace it.
+     * Rendered as HTML (the default copy uses `<kbd>`), so pass author-controlled
+     * markup only. Default true.
+     */
+    hint?: boolean | string;
+    /** Loading overlay: false to suppress it, or an object to reword it. Default true. */
+    loader?: boolean | RibbonLoaderOptions;
+    /** Name shown in the title bar and used for the downloaded file. Default "untitled.docx". */
+    documentName?: string;
+    /**
+     * Element-id prefix. Controls are addressable as `data-dxr="<name>"` always, and
+     * additionally get `id = idPrefix + name`. Omit and the surface uses bare ids when
+     * they are free on the page, falling back to a generated prefix when they are not —
+     * so a second ribbon never collides with the first.
+     */
+    idPrefix?: string;
+    /** Replace the default Save behaviour (download the bytes). */
+    onSave?: (bytes: Uint8Array, name: string) => void;
+    /** Called after any document opens, with the live editor. */
+    onOpen?: (editor: DocxEditor) => void;
+    /** Called whenever the status line changes. */
+    onStatus?: (text: string) => void;
+    /** Called after every ribbon command, with its label and measured duration. */
+    onCommand?: (label: string, ms: number) => void;
+}
+/** Drives the loading overlay. Safe to call when the loader is disabled — every method no-ops. */
+export interface RibbonLoader {
+    /** Re-show the overlay (e.g. before loading a second document). */
+    show(): void;
+    /** Jump to a numbered stage, or set one inline. */
+    stage(step: number | Partial<RibbonLoaderStage>): void;
+    /** Move the bar without changing the copy. */
+    progress(percent: number, label?: string): void;
+    /** Fade the overlay out and stop the rotation. */
+    done(): void;
+    /** Show the failure state with a Retry button. */
+    fail(error: unknown): void;
+}
+export interface RibbonEditor {
+    /** The mounted root element (carries `data-state` and `data-chrome`). */
+    readonly element: HTMLElement;
+    /** The element the document renders into. */
+    readonly surface: HTMLElement;
+    /** The live editor, or null before a document is open. */
+    readonly editor: DocxEditor | null;
+    /** The density actually in effect right now. */
+    readonly chrome: "full" | "compact";
+    /** The loading overlay controller. */
+    readonly loader: RibbonLoader;
+    /** Supply (or replace) the WASM exports after mounting. */
+    setExports(exports: DocxEditorExports): void;
+    /** Open a document, replacing any open one. Throws if exports are not set yet. */
+    open(bytes: Uint8Array, name?: string): DocxEditor;
+    /** Open a fresh blank document. */
+    openBlank(name?: string): DocxEditor;
+    /** Lossless DOCX bytes, or null when nothing is open. */
+    save(): Uint8Array | null;
+    /** Save and hand the bytes to `onSave` (default: browser download). */
+    download(name?: string): void;
+    /** Set the status line. */
+    setStatus(text: string): void;
+    /** Activate a ribbon tab by name ("home" | "insert" | "layout" | "table"). */
+    selectTab(name: string): void;
+    /** Force a density, or hand control back to measurement with "auto". */
+    setChrome(mode: RibbonChromeMode): void;
+    /** Look up a control by its `data-dxr` name. */
+    control<T extends HTMLElement = HTMLElement>(name: string): T | null;
+    /** Close the session, drop listeners and empty the container. */
+    destroy(): void;
+}
+/**
+ * Mount the ribbon surface into `container`.
+ *
+ * The chrome paints synchronously — including the loading overlay — so a host can
+ * mount before its WASM runtime exists, narrate the boot through `loader`, then call
+ * `setExports` and `open`.
+ */
+export declare function mountRibbon(container: string | HTMLElement, options?: RibbonOptions): RibbonEditor;
+//# sourceMappingURL=ribbon.d.ts.map

package/dist/ribbon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ribbon.d.ts","sourceRoot":"","sources":["../src/ribbon.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EAGlB,MAAM,aAAa,CAAC;AAYrB,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,YAAY,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAExE,kGAAkG;AAClG,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,CAAC;AAE3D,qEAAqE;AACrE,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC;AAEjE,qFAAqF;AACrF,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,kDAAkD;IAClD,KAAK,EAAE,MAAM,CAAC;CACf;AAED,iEAAiE;AACjE,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mBAAmB;IAClC,uCAAuC;IACvC,MAAM,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC7B,uEAAuE;IACvE,QAAQ,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACjC,uCAAuC;IACvC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,aAAc,SAAQ,iBAAiB;IACtD,iGAAiG;IACjG,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,sCAAsC;IACtC,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,wEAAwE;IACxE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,6DAA6D;IAC7D,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,4CAA4C;IAC5C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IACxB,sFAAsF;IACtF,MAAM,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAC;IACvC,6FAA6F;IAC7F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+DAA+D;IAC/D,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACnD,6DAA6D;IAC7D,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAC;IACtC,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,+EAA+E;IAC/E,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CACjD;AAED,kGAAkG;AAClG,MAAM,WAAW,YAAY;IAC3B,mEAAmE;IACnE,IAAI,IAAI,IAAI,CAAC;IACb,mDAAmD;IACnD,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IACvD,8CAA8C;IAC9C,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChD,kDAAkD;IAClD,IAAI,IAAI,IAAI,CAAC;IACb,kDAAkD;IAClD,IAAI,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,YAAY;IAC3B,yEAAyE;IACzE,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;IAC9B,6CAA6C;IAC7C,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;IAC9B,0DAA0D;IAC1D,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,CAAC;IACnC,gDAAgD;IAChD,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,sCAAsC;IACtC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,2DAA2D;IAC3D,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAC7C,kFAAkF;IAClF,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IACnD,mCAAmC;IACnC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IACrC,yDAAyD;IACzD,IAAI,IAAI,UAAU,GAAG,IAAI,CAAC;IAC1B,uEAAuE;IACvE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,2BAA2B;IAC3B,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,8EAA8E;IAC9E,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,wEAAwE;IACxE,SAAS,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACxC,gDAAgD;IAChD,OAAO,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC;IACrE,iEAAiE;IACjE,OAAO,IAAI,IAAI,CAAC;CACjB;AAsFD;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,SAAS,EAAE,MAAM,GAAG,WAAW,EAC/B,OAAO,GAAE,aAAkB,GAC1B,YAAY,CAEd"}