docxodus 8.0.0 → 9.1.0

package/dist/embed.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Embeddable viewer/editor entry point — the CDN story.
+ *
+ * This module packages the whole stack behind two one-call factories so a page
+ * can embed a DOCX viewer or editor with a single script tag and no build step:
+ *
+ * ```html
+ * <div id="doc"></div>
+ * <script type="module">
+ *   import { createViewer } from "https://cdn.jsdelivr.net/npm/docxodus@9.1.0/dist/embed.bundle.js";
+ *   await createViewer("#doc", "./contract.docx");
+ * </script>
+ * ```
+ *
+ * It ships in three shapes (see package.json build scripts):
+ *  - `dist/embed.js`         — plain ESM with relative imports, for bundler users
+ *                              (`import { createEditor } from "docxodus/embed"`).
+ *                              Shares module state with the main `docxodus` entry.
+ *  - `dist/embed.bundle.js`  — self-contained ESM bundle for CDN `<script type="module">`.
+ *  - `dist/embed.iife.js`    — classic-script bundle exposing `window.Docxodus`.
+ *
+ * WASM asset resolution: the .NET runtime files live in `wasm/` next to this
+ * file (`dist/wasm/` in the published package), which auto-resolves through
+ * `import.meta.url` in the ESM shapes. The IIFE shape has no `import.meta`, so
+ * it falls back to `document.currentScript.src` captured at load time. An
+ * explicit `wasmBasePath` option always wins.
+ */
+import { DocxEditor } from "./editor.js";
+import type { DocxEditorOptions } from "./editor.js";
+import type { ConversionOptions } from "./types.js";
+export * from "./index.js";
+export { DocxEditor } from "./editor.js";
+export type { DocxEditorExports, DocxEditorOptions } from "./editor.js";
+/**
+ * A document to load: raw bytes, a Blob/File (e.g. from an <input type="file">),
+ * or a URL string to fetch (must be same-origin or CORS-readable).
+ */
+export type DocumentSource = Uint8Array | ArrayBuffer | Blob | string;
+/** Normalize any DocumentSource to bytes. */
+export declare function toDocumentBytes(source: DocumentSource): Promise<Uint8Array>;
+export interface DocxViewerOptions extends ConversionOptions {
+    /** Explicit URL of the wasm assets directory; omit to auto-detect. */
+    wasmBasePath?: string;
+}
+export interface DocxViewer {
+    /** The container the document was rendered into. */
+    readonly element: HTMLElement;
+    /** The full HTML document string the converter produced. */
+    readonly html: string;
+    /** Re-render a (new) document into the same container. */
+    reload(source: DocumentSource, options?: ConversionOptions): Promise<void>;
+    /** Empty the container. */
+    destroy(): void;
+}
+/**
+ * Render a read-only DOCX viewer into `container`.
+ *
+ * Injects the converter's stylesheet plus the document body into the container
+ * (the same mounting the editor uses), so the page's own styles are untouched.
+ * Footnotes/endnotes render by default — they are document content; override
+ * any conversion option via `options`.
+ */
+export declare function createViewer(container: string | HTMLElement, source: DocumentSource, options?: DocxViewerOptions): Promise<DocxViewer>;
+export interface CreateEditorOptions extends DocxEditorOptions {
+    /** Explicit URL of the wasm assets directory; omit to auto-detect. */
+    wasmBasePath?: string;
+}
+/**
+ * Open an editable DOCX editor in `container`.
+ *
+ * With a `source`, opens that document; without one, opens a blank "New
+ * document". Returns the `DocxEditor` instance — `save()` for the edited
+ * bytes, `close()` to release the WASM session, plus the full command surface
+ * (formatting, tables, notes, headers/footers, undo/redo).
+ */
+export declare function createEditor(container: string | HTMLElement, source?: DocumentSource | null, options?: CreateEditorOptions): Promise<DocxEditor>;
+//# sourceMappingURL=embed.d.ts.map

package/dist/embed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"embed.d.ts","sourceRoot":"","sources":["../src/embed.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAOH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAqB,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAIpD,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,YAAY,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAExE;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI,GAAG,MAAM,CAAC;AA+OtE,6CAA6C;AAC7C,wBAAsB,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,CAgBjF;AAED,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D,sEAAsE;IACtE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IACzB,oDAAoD;IACpD,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;IAC9B,4DAA4D;IAC5D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,0DAA0D;IAC1D,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3E,2BAA2B;IAC3B,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,wBAAsB,YAAY,CAChC,SAAS,EAAE,MAAM,GAAG,WAAW,EAC/B,MAAM,EAAE,cAAc,EACtB,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,UAAU,CAAC,CAsCrB;AAED,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC5D,sEAAsE;IACtE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;GAOG;AACH,wBAAsB,YAAY,CAChC,SAAS,EAAE,MAAM,GAAG,WAAW,EAC/B,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,EAC9B,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,UAAU,CAAC,CAmBrB"}