@lpdfio/lpdf 0.29.0 → 0.31.0

package/dist/wasm/lpdf.js

@@ -12,10 +12,17 @@ class LpdfEngine {
         wasm.__wbg_lpdfengine_free(ptr, 0);
     }
     /**
-     * Remove any previously configured encryption.
+     * Register the bytes of a file a document carries, for the `<file>` of its `<attachments>` whose `ref`, or with
+     * no ref whose name, is `name`. The PDF carries them as they are.
+     * @param {string} name
+     * @param {Uint8Array} bytes
      */
-    clear_encryption() {
-        wasm.lpdfengine_clear_encryption(this.__wbg_ptr);
+    load_file(name, bytes) {
+        const ptr0 = passStringToWasm0(name, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passArray8ToWasm0(bytes, wasm.__wbindgen_malloc);
+        const len1 = WASM_VECTOR_LEN;
+        wasm.lpdfengine_load_file(this.__wbg_ptr, ptr0, len0, ptr1, len1);
     }
     /**
      * Register raw font bytes (TTF/OTF) for a custom font name.
@@ -46,6 +53,20 @@ class LpdfEngine {
         const len1 = WASM_VECTOR_LEN;
         wasm.lpdfengine_load_image(this.__wbg_ptr, ptr0, len0, ptr1, len1);
     }
+    /**
+     * Register the text of a file of Markdown rules, the root of which is a `<markdown-styles>`, for the
+     * `src` that names it. The engine reads no files: call this once for every `<markdown-styles src="…">`
+     * of the document before `render_pdf`, as `load_font` is called for a font.
+     * @param {string} src
+     * @param {string} xml
+     */
+    load_markdown_styles(src, xml) {
+        const ptr0 = passStringToWasm0(src, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passStringToWasm0(xml, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len1 = WASM_VECTOR_LEN;
+        wasm.lpdfengine_load_markdown_styles(this.__wbg_ptr, ptr0, len0, ptr1, len1);
+    }
     /**
      * @param {string} license_key
      */
@@ -84,22 +105,38 @@ class LpdfEngine {
      * `json_data` is an optional JSON string used to resolve `data-*`
      * attributes in the template.  Pass `None` (or `null` / `undefined` from
      * JavaScript) to render the template with its inline fallback content.
+     *
+     * The rest is for a document that asks for encryption in its `<output>`, which sets the cipher and
+     * the permissions: the passwords, which the template never holds, and `entropy`, at least 32 random
+     * bytes from the host's secure generator for AES-256. A document that asks for encryption needs an
+     * owner password, or `skip_encryption` to render it unencrypted, as a preview does; passwords for a
+     * document that doesn't ask for it are an error, and so are passwords with `skip_encryption`.
      * @param {string} xml
-     * @param {string | null} [json_data]
+     * @param {string | null | undefined} json_data
+     * @param {string | null | undefined} user_password
+     * @param {string | null | undefined} owner_password
+     * @param {boolean} skip_encryption
+     * @param {Uint8Array} entropy
      * @returns {Uint8Array}
      */
-    render_pdf(xml, json_data) {
+    render_pdf(xml, json_data, user_password, owner_password, skip_encryption, entropy) {
         const ptr0 = passStringToWasm0(xml, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
         var ptr1 = isLikeNone(json_data) ? 0 : passStringToWasm0(json_data, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         var len1 = WASM_VECTOR_LEN;
-        const ret = wasm.lpdfengine_render_pdf(this.__wbg_ptr, ptr0, len0, ptr1, len1);
+        var ptr2 = isLikeNone(user_password) ? 0 : passStringToWasm0(user_password, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        var len2 = WASM_VECTOR_LEN;
+        var ptr3 = isLikeNone(owner_password) ? 0 : passStringToWasm0(owner_password, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        var len3 = WASM_VECTOR_LEN;
+        const ptr4 = passArray8ToWasm0(entropy, wasm.__wbindgen_malloc);
+        const len4 = WASM_VECTOR_LEN;
+        const ret = wasm.lpdfengine_render_pdf(this.__wbg_ptr, ptr0, len0, ptr1, len1, ptr2, len2, ptr3, len3, skip_encryption, ptr4, len4);
         if (ret[3]) {
             throw takeFromExternrefTable0(ret[2]);
         }
-        var v3 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
+        var v6 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
         wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
-        return v3;
+        return v6;
     }
     /**
      * @param {string} json
@@ -126,23 +163,37 @@ class LpdfEngine {
      * when an `LpdfDocument` Kit tree is passed to `renderPdf()`, avoiding an
      * intermediate XML serialisation step. PHP, Python, and .NET adapters also
      * use this entry point.
+     *
+     * The passwords, `skip_encryption` and `entropy` are those of `render_pdf`, for a document whose
+     * `output` asks for encryption.
      * @param {string} json
+     * @param {string | null | undefined} user_password
+     * @param {string | null | undefined} owner_password
+     * @param {boolean} skip_encryption
+     * @param {Uint8Array} entropy
      * @returns {Uint8Array}
      */
-    render_tree_pdf(json) {
+    render_tree_pdf(json, user_password, owner_password, skip_encryption, entropy) {
         const ptr0 = passStringToWasm0(json, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.lpdfengine_render_tree_pdf(this.__wbg_ptr, ptr0, len0);
+        var ptr1 = isLikeNone(user_password) ? 0 : passStringToWasm0(user_password, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        var len1 = WASM_VECTOR_LEN;
+        var ptr2 = isLikeNone(owner_password) ? 0 : passStringToWasm0(owner_password, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        var len2 = WASM_VECTOR_LEN;
+        const ptr3 = passArray8ToWasm0(entropy, wasm.__wbindgen_malloc);
+        const len3 = WASM_VECTOR_LEN;
+        const ret = wasm.lpdfengine_render_tree_pdf(this.__wbg_ptr, ptr0, len0, ptr1, len1, ptr2, len2, skip_encryption, ptr3, len3);
         if (ret[3]) {
             throw takeFromExternrefTable0(ret[2]);
         }
-        var v2 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
+        var v5 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
         wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
-        return v2;
+        return v5;
     }
     /**
-     * Set an optional ISO 8601 creation timestamp (e.g. `"2024-06-01T12:00:00"`).
-     * When provided, written as `/CreationDate` in the PDF info dictionary.
+     * Set an optional ISO 8601 creation timestamp (e.g. `"2024-06-01T12:00:00"`, `"2024-06-01T12:00:00.000Z"` or
+     * `"2024-06-01T12:00:00+01:00"`). When provided, written as `/CreationDate` in the PDF info dictionary, with
+     * the precision and the time zone it was given in; a value that is not a date makes the render an error.
      * Omitting this keeps builds reproducible (no embedded timestamp).
      * @param {string} iso
      */
@@ -151,28 +202,6 @@ class LpdfEngine {
         const len0 = WASM_VECTOR_LEN;
         wasm.lpdfengine_set_created_on(this.__wbg_ptr, ptr0, len0);
     }
-    /**
-     * Configure RC4-128 encryption applied to every subsequent `render_pdf` call.
-     *
-     * `permissions_json` is a JSON object with boolean fields matching the
-     * `Permissions` struct (`print`, `modify`, `copy`, `annotate`, `fill_forms`,
-     * `accessibility`, `assemble`, `print_hq`). Omitted fields default to `true`.
-     *
-     * To apply permissions without an open password, pass an empty `user_password`
-     * and a non-empty `owner_password`.
-     * @param {string} user_password
-     * @param {string} owner_password
-     * @param {string} permissions_json
-     */
-    set_encryption(user_password, owner_password, permissions_json) {
-        const ptr0 = passStringToWasm0(user_password, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        const len0 = WASM_VECTOR_LEN;
-        const ptr1 = passStringToWasm0(owner_password, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        const len1 = WASM_VECTOR_LEN;
-        const ptr2 = passStringToWasm0(permissions_json, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        const len2 = WASM_VECTOR_LEN;
-        wasm.lpdfengine_set_encryption(this.__wbg_ptr, ptr0, len0, ptr1, len1, ptr2, len2);
-    }
     /**
      * Inject glyph advance-width tables for custom fonts.
      *
@@ -349,6 +378,138 @@ function kit_to_xml(json) {
     }
 }
 exports.kit_to_xml = kit_to_xml;
+
+/**
+ * The template `template` with an `<image>` declared for each path of the JSON array `srcs`, named as
+ * `markdown_file_images` says.
+ * @param {string} template
+ * @param {string} srcs
+ * @returns {string}
+ */
+function markdown_declare_images(template, srcs) {
+    let deferred4_0;
+    let deferred4_1;
+    try {
+        const ptr0 = passStringToWasm0(template, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passStringToWasm0(srcs, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len1 = WASM_VECTOR_LEN;
+        const ret = wasm.markdown_declare_images(ptr0, len0, ptr1, len1);
+        var ptr3 = ret[0];
+        var len3 = ret[1];
+        if (ret[3]) {
+            ptr3 = 0; len3 = 0;
+            throw takeFromExternrefTable0(ret[2]);
+        }
+        deferred4_0 = ptr3;
+        deferred4_1 = len3;
+        return getStringFromWasm0(ptr3, len3);
+    } finally {
+        wasm.__wbindgen_free(deferred4_0, deferred4_1, 1);
+    }
+}
+exports.markdown_declare_images = markdown_declare_images;
+
+/**
+ * The rules a `<markdown>` with no styles uses, as the file to start a style of one's own from.
+ * @returns {string}
+ */
+function markdown_default_styles() {
+    let deferred1_0;
+    let deferred1_1;
+    try {
+        const ret = wasm.markdown_default_styles();
+        deferred1_0 = ret[0];
+        deferred1_1 = ret[1];
+        return getStringFromWasm0(ret[0], ret[1]);
+    } finally {
+        wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+    }
+}
+exports.markdown_default_styles = markdown_default_styles;
+
+/**
+ * The data a template gets for the `.md` file `markdown`, as JSON: the text as `markdown`, and the fields of its
+ * front matter, each a string.
+ * @param {string} markdown
+ * @returns {string}
+ */
+function markdown_file_data(markdown) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const ptr0 = passStringToWasm0(markdown, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.markdown_file_data(ptr0, len0);
+        deferred2_0 = ret[0];
+        deferred2_1 = ret[1];
+        return getStringFromWasm0(ret[0], ret[1]);
+    } finally {
+        wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
+    }
+}
+exports.markdown_file_data = markdown_file_data;
+
+/**
+ * The relative paths of the images of the `.md` file `markdown`, as a JSON array. The caller declares them with
+ * `markdown_declare_images` and loads each file, relative to the `.md`, under the name `markdown-image-N` where N
+ * counts from 1 in the order of the array.
+ * @param {string} markdown
+ * @returns {string}
+ */
+function markdown_file_images(markdown) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const ptr0 = passStringToWasm0(markdown, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.markdown_file_images(ptr0, len0);
+        deferred2_0 = ret[0];
+        deferred2_1 = ret[1];
+        return getStringFromWasm0(ret[0], ret[1]);
+    } finally {
+        wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
+    }
+}
+exports.markdown_file_images = markdown_file_images;
+
+/**
+ * The looks a `.md` file can start from besides the default one, as a JSON array of `name`, `label`, `description`
+ * and `styles`: the file of styles, to write beside the `.md` file and edit.
+ * @returns {string}
+ */
+function markdown_style_presets() {
+    let deferred1_0;
+    let deferred1_1;
+    try {
+        const ret = wasm.markdown_style_presets();
+        deferred1_0 = ret[0];
+        deferred1_1 = ret[1];
+        return getStringFromWasm0(ret[0], ret[1]);
+    } finally {
+        wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+    }
+}
+exports.markdown_style_presets = markdown_style_presets;
+
+/**
+ * The template that wraps a `.md` file when it is rendered with no template of its own: A4, a margin and the
+ * page number. It reads the Markdown from the data `markdown`, the rest of which is the file's front matter.
+ * @returns {string}
+ */
+function markdown_template() {
+    let deferred1_0;
+    let deferred1_1;
+    try {
+        const ret = wasm.markdown_template();
+        deferred1_0 = ret[0];
+        deferred1_1 = ret[1];
+        return getStringFromWasm0(ret[0], ret[1]);
+    } finally {
+        wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+    }
+}
+exports.markdown_template = markdown_template;
 function __wbg_get_imports() {
     const import0 = {
         __proto__: null,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lpdfio/lpdf",
-  "version": "0.29.0",
+  "version": "0.31.0",
   "description": "Node.js SDK for Lpdf — PDF as Code on every platform. You describe a document as code or XML. Lpdf renders a compact, pixel-perfect PDF — identical across platforms.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -48,5 +48,8 @@
     "@types/node": "^20.0.0",
     "esbuild": "^0.25.0",
     "typescript": "^5.0.0"
+  },
+  "allowScripts": {
+    "esbuild": false
   }
 }