@laminapdf/wasm 0.2.0-alpha.5 → 0.2.0

package/dist/lamina_pdf_text.js

@@ -75,6 +75,30 @@ export class WasmBuilder {
         }
         return WasmDocument.__wrap(ret[0]);
     }
+    /**
+     * Lays `document` out as tagged pages that flow, after any pages already added, filled from
+     * `options.data` first when it is given. The document's profiles are the builder's to set
+     * (`profiles` in its options); its warnings are the finished document's.
+     *
+     * # Errors
+     * `builder-finished`; `unknown-option`, `invalid-argument`; `invalid-document` with the JSON
+     * Pointer at fault and the closest keys in `didYouMean`; `template-data-missing`,
+     * `template-data-type`, `template-too-large`; `unknown-font` and `unknown-image` for a name
+     * `resources` lacks; `missing-glyph`, `flow-content-too-large`.
+     * @param {unknown} document
+     * @param {WasmFlowResources} resources
+     * @param {FlowOptionsInit | undefined} options
+     * @returns {FlowReportJs}
+     */
+    flow(document, resources, options) {
+        _assertClass(resources, WasmFlowResources);
+        let ret;
+        ret = wasm.wasmbuilder_flow(this.__wbg_ptr, document, resources.__wbg_ptr, options);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
     /**
      * Loads a font from its bytes (TrueType or OpenType/CFF) and registers it; it is
      * subset to the glyphs drawn.
@@ -94,6 +118,25 @@ export class WasmBuilder {
         }
         return WasmFont.__wrap(ret[0]);
     }
+    /**
+     * Loads face `index` (from 0) of a font collection (`.ttc`, `.otc`) and registers it.
+     *
+     * # Errors
+     * `builder-finished`; `invalid-font`, `collection-index` (no such face), `font-not-embeddable`.
+     * @param {Uint8Array} bytes
+     * @param {number} index
+     * @returns {WasmFont}
+     */
+    fontCollection(bytes, index) {
+        const ptr0 = passArray8ToWasm0(bytes, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        let ret;
+        ret = wasm.wasmbuilder_fontCollection(this.__wbg_ptr, ptr0, len0, index);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return WasmFont.__wrap(ret[0]);
+    }
     /**
      * The natural language (`/Lang`), a BCP 47 tag.
      *
@@ -110,6 +153,31 @@ export class WasmBuilder {
             throw takeFromExternrefTable0(ret[0]);
         }
     }
+    /**
+     * Lays `markdown` out as tagged pages that flow, after any pages already added; its front
+     * matter's title, language, author and subject become the document's. Its warnings
+     * (`markdown-html-ignored`, `markdown-image-missing`, the flow's) are the finished
+     * document's.
+     *
+     * # Errors
+     * `builder-finished`; `unknown-option`, `invalid-argument`; `missing-glyph`,
+     * `flow-content-too-large`; `unknown-font` at `finish` for a font another builder registered.
+     * @param {string} markdown
+     * @param {WasmMarkdownOptions} resources
+     * @param {MarkdownOptionsInit | undefined} options
+     * @returns {MarkdownReportJs}
+     */
+    markdown(markdown, resources, options) {
+        const ptr0 = passStringToWasm0(markdown, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        _assertClass(resources, WasmMarkdownOptions);
+        let ret;
+        ret = wasm.wasmbuilder_markdown(this.__wbg_ptr, ptr0, len0, resources.__wbg_ptr, options);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
     /**
      * The metadata, written as the Info dictionary and an XMP packet.
      *
@@ -243,6 +311,25 @@ export class WasmDocument {
         wasm.__wbg_wasmdocument_free(ptr, 0);
 
     }
+    /**
+     * Makes `bytes`, the whole output of `saveCopy`, the document's saved file (it rebases onto
+     * them), once they are written where the document lives; `historyCleared` is the copy's
+     * report's.
+     *
+     * # Errors
+     * `nested-transaction`, `saved-not-rebased`; `not-rebased` when `bytes` can't be read.
+     * @param {Uint8Array} bytes
+     * @param {boolean} historyCleared
+     */
+    adoptCopy(bytes, historyCleared) {
+        const ptr0 = passArray8ToWasm0(bytes, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        let ret;
+        ret = wasm.wasmdocument_adoptCopy(this.__wbg_ptr, ptr0, len0, historyCleared);
+        if (ret[1]) {
+            throw takeFromExternrefTable0(ret[0]);
+        }
+    }
     /**
      * Applies an op log (`{ "v": 1, "ops": [ … ] }`) as one transaction.
      *
@@ -350,6 +437,15 @@ export class WasmDocument {
         }
         return takeFromExternrefTable0(ret[0]);
     }
+    /**
+     * Whether the file is encrypted (it opened with its password, or the empty one).
+     * @returns {boolean}
+     */
+    isEncrypted() {
+        let ret;
+        ret = wasm.wasmdocument_isEncrypted(this.__wbg_ptr);
+        return ret !== 0;
+    }
     /**
      * Whether the document says it is tagged (`/MarkInfo /Marked true`; the extract and text modules).
      *
@@ -365,6 +461,22 @@ export class WasmDocument {
         }
         return ret[0] !== 0;
     }
+    /**
+     * The document's metadata, read from Info and XMP together, with the fields where they
+     * disagree.
+     *
+     * # Errors
+     * Reading errors.
+     * @returns {DocumentMetadata}
+     */
+    metadata() {
+        let ret;
+        ret = wasm.wasmdocument_metadata(this.__wbg_ptr);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
     /**
      * The named destination `name`, or `undefined` when the document has none by that name or
      * it names no page here (the extract and text modules).
@@ -536,6 +648,22 @@ export class WasmDocument {
         }
         return WasmPage.__wrap(ret[0]);
     }
+    /**
+     * How a save with `options` would go, without saving.
+     *
+     * # Errors
+     * `invalid-argument` / `unknown-option` for bad options; reading errors.
+     * @param {SaveOptionsInit | undefined} options
+     * @returns {PlannedSaveJs}
+     */
+    plan(options) {
+        let ret;
+        ret = wasm.wasmdocument_plan(this.__wbg_ptr, options);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
     /**
      * The document's properties (the extract and text modules). Reads every object once.
      *
@@ -568,11 +696,12 @@ export class WasmDocument {
         }
     }
     /**
-     * Redoes the newest undone transaction; `undefined` when there is nothing to redo.
+     * Redoes the newest undone transaction: how it went and the pages it touched; `undefined`
+     * when there is nothing to redo.
      *
      * # Errors
      * As [`WasmDocument::undo`].
-     * @returns {UndoOutcomeJs | undefined}
+     * @returns {RevertedJs | undefined}
      */
     redo() {
         let ret;
@@ -582,6 +711,23 @@ export class WasmDocument {
         }
         return takeFromExternrefTable0(ret[0]);
     }
+    /**
+     * Writes what `save` would and leaves the document as it was: not rebased, its changes
+     * still unsaved, the save-time stamp in the copy only (Save a copy).
+     *
+     * # Errors
+     * As `save`; the document is unchanged either way.
+     * @param {SaveOptionsInit | undefined} options
+     * @returns {{ bytes: Uint8Array<ArrayBuffer>; report: SaveReportJs }}
+     */
+    saveCopy(options) {
+        let ret;
+        ret = wasm.wasmdocument_saveCopy(this.__wbg_ptr, options);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
     /**
      * A save as a job, stepped with a budget of work units (ADR 0028 §3, §4).
      *
@@ -631,11 +777,12 @@ export class WasmDocument {
         return takeFromExternrefTable0(ret[0]);
     }
     /**
-     * Undoes the newest transaction; `undefined` when there is nothing to undo.
+     * Undoes the newest transaction: how it went and the pages it touched; `undefined` when
+     * there is nothing to undo.
      *
      * # Errors
      * `nested-transaction`, `saved-not-rebased`; reading errors.
-     * @returns {UndoOutcomeJs | undefined}
+     * @returns {RevertedJs | undefined}
      */
     undo() {
         let ret;
@@ -654,6 +801,22 @@ export class WasmDocument {
         ret = wasm.wasmdocument_warnings(this.__wbg_ptr);
         return WasmWarningCursor.__wrap(ret);
     }
+    /**
+     * The signature restrictions `op` would break if it were applied and saved.
+     *
+     * # Errors
+     * `invalid-argument` for a value that isn't an op; reading errors.
+     * @param {Op} op
+     * @returns {ViolationJs[]}
+     */
+    wouldViolate(op) {
+        let ret;
+        ret = wasm.wasmdocument_wouldViolate(this.__wbg_ptr, op);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
 }
 if (Symbol.dispose) WasmDocument.prototype[Symbol.dispose] = WasmDocument.prototype.free;
 
@@ -724,6 +887,57 @@ export class WasmExtractJob {
 }
 if (Symbol.dispose) WasmExtractJob.prototype[Symbol.dispose] = WasmExtractJob.prototype.free;
 
+/**
+ * The fonts and images a document names, by the names it gives them.
+ */
+export class WasmFlowResources {
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        WasmFlowResourcesFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_wasmflowresources_free(ptr, 0);
+
+    }
+    /**
+     * `font` for the styles that name `name`; the same name again replaces it.
+     * @param {string} name
+     * @param {WasmFont} font
+     */
+    font(name, font) {
+        const ptr0 = passStringToWasm0(name, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        _assertClass(font, WasmFont);
+        wasm.wasmflowresources_font(this.__wbg_ptr, ptr0, len0, font.__wbg_ptr);
+    }
+    /**
+     * `image` for the figures that name `name`; the same name again replaces it.
+     * @param {string} name
+     * @param {WasmImage} image
+     */
+    image(name, image) {
+        const ptr0 = passStringToWasm0(name, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        _assertClass(image, WasmImage);
+        wasm.wasmflowresources_image(this.__wbg_ptr, ptr0, len0, image.__wbg_ptr);
+    }
+    /**
+     * No fonts and no images.
+     */
+    constructor() {
+        let ret;
+        ret = wasm.wasmflowresources_new();
+        this.__wbg_ptr = ret;
+        Object.defineProperty(this, '__wbg_inst', { value: __wbg_instance_id, writable: true });
+        WasmFlowResourcesFinalization.register(this, { ptr: ret, instance: __wbg_instance_id }, this);
+        return this;
+    }
+}
+if (Symbol.dispose) WasmFlowResources.prototype[Symbol.dispose] = WasmFlowResources.prototype.free;
+
 /**
  * A font registered with a [`WasmBuilder`].
  */
@@ -893,6 +1107,65 @@ export class WasmImage {
 }
 if (Symbol.dispose) WasmImage.prototype[Symbol.dispose] = WasmImage.prototype.free;
 
+/**
+ * The fonts and images of a Markdown build, by role and by the target the Markdown names.
+ */
+export class WasmMarkdownOptions {
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        WasmMarkdownOptionsFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_wasmmarkdownoptions_free(ptr, 0);
+
+    }
+    /**
+     * `font` for `role`: `regular`, `bold` (headings too), `italic`, `boldItalic`, `mono`, or
+     * `fallback` (each call adds one) for characters the others lack.
+     *
+     * # Errors
+     * `invalid-argument` for another role.
+     * @param {string} role
+     * @param {WasmFont} font
+     */
+    font(role, font) {
+        const ptr0 = passStringToWasm0(role, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        _assertClass(font, WasmFont);
+        let ret;
+        ret = wasm.wasmmarkdownoptions_font(this.__wbg_ptr, ptr0, len0, font.__wbg_ptr);
+        if (ret[1]) {
+            throw takeFromExternrefTable0(ret[0]);
+        }
+    }
+    /**
+     * `image` for the images whose target is `target`, as the Markdown writes it.
+     * @param {string} target
+     * @param {WasmImage} image
+     */
+    image(target, image) {
+        const ptr0 = passStringToWasm0(target, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        _assertClass(image, WasmImage);
+        wasm.wasmmarkdownoptions_image(this.__wbg_ptr, ptr0, len0, image.__wbg_ptr);
+    }
+    /**
+     * No fonts (the standard 14 Helvetica family and Courier) and no images.
+     */
+    constructor() {
+        let ret;
+        ret = wasm.wasmmarkdownoptions_new();
+        this.__wbg_ptr = ret;
+        Object.defineProperty(this, '__wbg_inst', { value: __wbg_instance_id, writable: true });
+        WasmMarkdownOptionsFinalization.register(this, { ptr: ret, instance: __wbg_instance_id }, this);
+        return this;
+    }
+}
+if (Symbol.dispose) WasmMarkdownOptions.prototype[Symbol.dispose] = WasmMarkdownOptions.prototype.free;
+
 /**
  * A page of a [`WasmDocument`], held by its ID (F2): moving pages doesn't retarget it.
  */
@@ -1837,6 +2110,11 @@ const WasmExtractJobFinalization = (typeof FinalizationRegistry === 'undefined')
     : new FinalizationRegistry(({ ptr, instance }) => {
     if (instance === __wbg_instance_id) wasm.__wbg_wasmextractjob_free(ptr, 1);
 });
+const WasmFlowResourcesFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(({ ptr, instance }) => {
+    if (instance === __wbg_instance_id) wasm.__wbg_wasmflowresources_free(ptr, 1);
+});
 const WasmFontFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(({ ptr, instance }) => {
@@ -1847,6 +2125,11 @@ const WasmImageFinalization = (typeof FinalizationRegistry === 'undefined')
     : new FinalizationRegistry(({ ptr, instance }) => {
     if (instance === __wbg_instance_id) wasm.__wbg_wasmimage_free(ptr, 1);
 });
+const WasmMarkdownOptionsFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(({ ptr, instance }) => {
+    if (instance === __wbg_instance_id) wasm.__wbg_wasmmarkdownoptions_free(ptr, 1);
+});
 const WasmPageFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(({ ptr, instance }) => {

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@laminapdf/wasm",
-  "version": "0.2.0-alpha.5",
-  "description": "Lamina PDF's WebAssembly modules and their wasm-bindgen glue: lamina_pdf_base (open, read, edit, save, vector and image pages), lamina_pdf_text (all of base plus fonts and text) and lamina_pdf_extract (all of base plus text extraction); and lamina_pdf_render_hayro, laminapdf-render's hayro adapter, which @laminapdf/render-hayro wraps. Generated into dist/ by `cargo xtask wasm`; @laminapdf/sdk is the API to use.",
+  "version": "0.2.0",
+  "description": "The WebAssembly build of Lamina PDF's Rust core, which @laminapdf/sdk runs on: create, read, edit and save PDFs and extract their text. Use @laminapdf/sdk; this package holds its compiled modules.",
   "license": "MIT OR Apache-2.0",
   "homepage": "https://laminapdf.com",
+  "bugs": {
+    "url": "https://github.com/laudebugs/laminapdf/issues"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/laudebugs/laminapdf.git",
@@ -12,7 +15,10 @@
   "keywords": [
     "pdf",
     "wasm",
-    "webassembly"
+    "webassembly",
+    "pdf-generation",
+    "pdf-editing",
+    "text-extraction"
   ],
   "type": "module",
   "sideEffects": false,
@@ -46,11 +52,11 @@
     "./package.json": "./package.json"
   },
   "devDependencies": {
-    "@types/node": "26.6.5",
+    "@types/node": "26.6.6",
     "ajv": "8.20.0",
     "esbuild": "0.28.2",
     "typescript": "7.0.2",
-    "vitest": "5.0.5",
+    "vitest": "5.1.0",
     "@laminapdf/test-utils": "0.0.0"
   },
   "publishConfig": {