@aseity/idocs-preview 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @aseity/idocs-preview
 
+## 0.3.0
+
+### Minor Changes
+
+- Add `Session.exportDocx` to export iDocs source bytes and referenced images as a Word document in the browser. Invalid source, missing images and unapproved conversion losses reject instead of producing a partial file.
+
 ## 0.2.0
 
 ### Minor Changes

package/README.md

@@ -50,6 +50,7 @@ during server rendering.
 - `@aseity/idocs-preview/core`: the headless session. `createSession()` starts the
   worker; `session.open(bytes, options)` resolves to a `PreviewDocument` with the
   pages' display lists, diagnostics and conversion losses.
+  `session.exportDocx(bytes, options)` exports iDocs source to DOCX bytes.
 - `@aseity/idocs-preview/view`: the reference view. `createPreview(container)`
   owns a session and a view; `mountPreview(container, doc)` shows a document you
   opened yourself. Both re-export the core types.
@@ -99,6 +100,36 @@ document. A callback exception rejects its open.
 The development page enables progressive delivery with `?progressive=1`.
 There is no `compact` option or legacy JSON-only transport.
 
+## Exporting Word documents
+
+`session.exportDocx(bytes, { name?, readResource? })` exports an iDocs source
+into DOCX bytes. It accepts the same byte types and image callback as `open`.
+The source bytes are copied before transfer. Every export owns its resources,
+so concurrent opens and exports remain independent.
+
+```ts
+const session = createSession();
+try {
+  const bytes = await session.exportDocx(source, {
+    name: "report.idoc",
+    readResource: (path) => readImage(path),
+  });
+  const file = new Blob([bytes], {
+    type: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+  });
+  saveFile(file, "report.docx");
+} finally {
+  session.dispose();
+}
+```
+
+Export uses browser font measurements for layout and preserves the document's
+font declarations in DOCX. Word may paginate differently on the recipient's
+machine. Invalid source, unavailable or invalid images, layout errors and
+unapproved conversion losses reject with `PreviewError`. Export never replaces
+missing images with preview placeholders. Export failures also include the
+`export-failed` code. Disposing the session rejects pending and future exports.
+
 ## View
 
 - Zoom 1 is 100% (one point is 4/3 CSS pixels), clamped to 0.1–10. `setZoom` keeps

package/dist/core/engine.js

@@ -3,7 +3,7 @@
 // code behind a MessageChannel. Layout is synchronous inside one wasm call;
 // resources the host has not answered yet come back as `needs`, and the open
 // is retried once they arrive.
-import init, { openDocument } from '../../wasm/idocs_wasm.js';
+import init, { exportDocx, openDocument } from '../../wasm/idocs_wasm.js';
 import { canvasMeasure } from './fonts.js';
 export function serve(endpoint, options = {}) {
     let ready;
@@ -19,12 +19,17 @@ export function serve(endpoint, options = {}) {
         try {
             if (!measure)
                 throw new Error('Browser font measurement requires OffscreenCanvas 2D');
-            if (job.progressive)
-                post({ type: 'pageReset', id });
-            const onPage = job.progressive ? (packet) => {
-                post({ type: 'page', id, ...packet }, [packet.data.buffer, ...packet.images.map(bytes => bytes.buffer)]);
-            } : undefined;
-            outcome = openDocument(job.kind, job.bytes, job.name, job.assets, measure, onPage);
+            if (job.type === 'exportDocx') {
+                outcome = exportDocx(job.bytes, job.name, job.assets, measure);
+            }
+            else {
+                if (job.progressive)
+                    post({ type: 'pageReset', id });
+                const onPage = job.progressive ? (packet) => {
+                    post({ type: 'page', id, ...packet }, [packet.data.buffer, ...packet.images.map(bytes => bytes.buffer)]);
+                } : undefined;
+                outcome = openDocument(job.kind, job.bytes, job.name, job.assets, measure, onPage);
+            }
         }
         catch (error) {
             pending.delete(id);
@@ -40,6 +45,10 @@ export function serve(endpoint, options = {}) {
             post({ type: 'failed', id, error: JSON.parse(outcome.json) });
             return;
         }
+        if (outcome.status === 'exported') {
+            post({ type: 'exported', id, bytes: outcome.bytes }, [outcome.bytes.buffer]);
+            return;
+        }
         post({ type: 'opened', id, json: outcome.json, images: outcome.images, data: outcome.data }, [outcome.data.buffer, ...outcome.images.map((bytes) => bytes.buffer)]);
     };
     endpoint.addEventListener('message', async (event) => {
@@ -58,8 +67,12 @@ export function serve(endpoint, options = {}) {
             post({ type: 'failed', id, error: { code: 'wasm-unavailable', message: String(error), diagnostics: [] } });
             return;
         }
-        if (message.type === 'open') {
+        if (message.type === 'exportDocx') {
+            pending.set(message.id, { type: 'exportDocx', name: message.name, bytes: message.bytes, assets: new Map() });
+        }
+        else if (message.type === 'open') {
             pending.set(message.id, {
+                type: 'open',
                 kind: message.kind,
                 progressive: message.progressive ?? false,
                 name: message.name,

package/dist/core/index.d.ts

@@ -34,7 +34,9 @@ export declare class PreviewError extends Error {
         diagnostics: PreviewDocument['diagnostics'];
     });
 }
+export type ExportOptions = Pick<OpenOptions, 'name' | 'readResource'>;
 export interface Session {
+    exportDocx(bytes: Bytes, options?: ExportOptions): Promise<Uint8Array>;
     open(bytes: Bytes, options?: OpenOptions): Promise<PreviewDocument>;
     /**
      * Terminates the worker; pending opens reject. A worker that fails on its

package/dist/core/index.js

@@ -52,14 +52,14 @@ export function createSession(options = {}) {
         const job = jobs.get(message.id);
         if (!job)
             return;
-        if (message.type === 'pageReset') {
+        if (message.type === 'pageReset' && job.kind === 'open') {
             job.pages = [];
             job.images = [];
             job.previewImages = [];
             job.outlines = [];
             return;
         }
-        if (message.type === 'page') {
+        if (message.type === 'page' && job.kind === 'open') {
             try {
                 job.images.push(...message.images);
                 const partial = decodeCompact(message.json, message.data, message.images);
@@ -86,7 +86,10 @@ export function createSession(options = {}) {
             return;
         }
         jobs.delete(message.id);
-        if (message.type === 'opened') {
+        if (message.type === 'exported' && job.kind === 'export') {
+            job.resolve(message.bytes);
+        }
+        else if (message.type === 'opened' && job.kind === 'open') {
             try {
                 const doc = decodeCompact(message.json, message.data, job.options.onPage ? job.images : message.images);
                 if (job.options.onPage) {
@@ -100,8 +103,10 @@ export function createSession(options = {}) {
                 job.reject(new PreviewError({ code: 'internal-error', message: String(error), diagnostics: [] }));
             }
         }
-        else
+        else if (message.type === 'failed')
             job.reject(new PreviewError(message.error));
+        else
+            job.reject(new PreviewError({ code: 'internal-error', message: 'Unexpected worker response', diagnostics: [] }));
     });
     // A worker script that fails to load or run, or a message that cannot be
     // deserialized, leaves no reply to wait for: give up on the worker.
@@ -124,6 +129,18 @@ export function createSession(options = {}) {
     worker.start?.();
     post({ type: 'init', wasmUrl: options.wasmUrl?.toString() });
     return {
+        exportDocx(input, exportOptions = {}) {
+            if (disposed)
+                return Promise.reject(new Error('The preview session is disposed'));
+            if (broken)
+                return Promise.reject(broken);
+            const bytes = copyBytes(input);
+            const id = next++;
+            return new Promise((resolve, reject) => {
+                jobs.set(id, { kind: 'export', options: exportOptions, resolve, reject });
+                post({ type: 'exportDocx', id, name: exportOptions.name ?? 'document.idoc', bytes }, [bytes.buffer]);
+            });
+        },
         open(input, openOptions = {}) {
             if (disposed)
                 return Promise.reject(new Error('The preview session is disposed'));
@@ -132,7 +149,7 @@ export function createSession(options = {}) {
             const bytes = copyBytes(input);
             const id = next++;
             return new Promise((resolve, reject) => {
-                jobs.set(id, { options: openOptions, resolve, reject, pages: [], images: [], previewImages: [], outlines: [] });
+                jobs.set(id, { kind: 'open', options: openOptions, resolve, reject, pages: [], images: [], previewImages: [], outlines: [] });
                 post({
                     type: 'open',
                     progressive: openOptions.onPage !== undefined,

package/dist/core/protocol.d.ts

@@ -84,6 +84,11 @@ export type ResourceNeed = {
 export type ToWorker = {
     type: 'init';
     wasmUrl?: string;
+} | {
+    type: 'exportDocx';
+    id: number;
+    name: string;
+    bytes: Uint8Array;
 } | {
     type: 'open';
     id: number;
@@ -120,6 +125,10 @@ export type FromWorker = {
     type: 'needs';
     id: number;
     needs: ResourceNeed[];
+} | {
+    type: 'exported';
+    id: number;
+    bytes: Uint8Array;
 } | {
     type: 'opened';
     id: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aseity/idocs-preview",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Read-only browser preview for DOCX and iDocs source documents: Browser font measurements with layout in a Web Worker (WASM) and drawing in a Canvas page view.",
   "license": "MIT",
   "type": "module",

package/wasm/idocs_wasm.d.ts

@@ -1,6 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 
+export function exportDocx(bytes: Uint8Array, file_name: string, assets: Map<any, any>, measure: Function): any;
+
 /**
  * Returns `{status: "needs" | "ready" | "failed", json, data?, images}`; see
  * `web/src/core/protocol.ts` for the JSON shapes. `measure(family,
@@ -13,6 +15,7 @@ export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembl
 
 export interface InitOutput {
     readonly memory: WebAssembly.Memory;
+    readonly exportDocx: (a: number, b: number, c: number, d: number, e: any, f: any) => any;
     readonly openDocument: (a: number, b: number, c: number, d: number, e: number, f: number, g: any, h: any, i: number) => any;
     readonly __wbindgen_malloc: (a: number, b: number) => number;
     readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;

package/wasm/idocs_wasm.js

@@ -1,5 +1,21 @@
 /* @ts-self-types="./idocs_wasm.d.ts" */
 
+/**
+ * @param {Uint8Array} bytes
+ * @param {string} file_name
+ * @param {Map<any, any>} assets
+ * @param {Function} measure
+ * @returns {any}
+ */
+export function exportDocx(bytes, file_name, assets, measure) {
+    const ptr0 = passArray8ToWasm0(bytes, wasm.__wbindgen_malloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ptr1 = passStringToWasm0(file_name, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len1 = WASM_VECTOR_LEN;
+    const ret = wasm.exportDocx(ptr0, len0, ptr1, len1, assets, measure);
+    return ret;
+}
+
 /**
  * Returns `{status: "needs" | "ready" | "failed", json, data?, images}`; see
  * `web/src/core/protocol.ts` for the JSON shapes. `measure(family,

package/wasm/idocs_wasm_bg.wasm.d.ts

@@ -1,6 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 export const memory: WebAssembly.Memory;
+export const exportDocx: (a: number, b: number, c: number, d: number, e: any, f: any) => any;
 export const openDocument: (a: number, b: number, c: number, d: number, e: number, f: number, g: any, h: any, i: number) => any;
 export const __wbindgen_malloc: (a: number, b: number) => number;
 export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;