@2018kguo/recto 0.3.0 → 0.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@2018kguo/recto",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "A PDF engine for JavaScript: text with boxes, page objects, annotations and rendering, in Rust compiled to WebAssembly.",
   "license": "MIT",
   "repository": {

package/wasm/pins.mjs

@@ -1,9 +1,9 @@
 // Generated by scripts/package-wasm.mjs.
 export const PINS = {
-  "recto.wasm": "1ca7ee27355011de489c91749e764c9ac76fcb0f37020f96273075f5fe4d4841",
-  "recto-render.wasm": "356f4f94b1cf4125247da4991f1ff827879e5cf1c35354ecb572e53545b01b2c",
-  "recto-more.wasm": "a4d05fc178ebc4696f72dfd2b3f3d027ac30931383363754b9629be69dd80f99",
-  "recto-rare.wasm": "e5f0137133d92c8bf2aacbc6e2363c55276b258d0dc81bcaa8ba7a9c2c891f2a",
+  "recto.wasm": "6ea5dcbefb46130b65af4e3e8abd4c36204ecff4beaa089960c5d24e58dd6345",
+  "recto-render.wasm": "903b95817bb9c23769db27cedf3a29a7b5d3dcff0c65fbe28c0d0191943d59b7",
+  "recto-more.wasm": "e612392af0129e4e2f9083605f56c1e39b6eca0e2c5fef6ee39b72849b384f9b",
+  "recto-rare.wasm": "da54f130b42290ff9ef8c0ba45a0f9f49545f038f3bcfa19c5ec75ac2e9f4e6e",
   "FoxitFixed.pfb": "b6c8fe53f134b8b6d4578cd2d544df4cee9624c4efa8d51a560fb40ea296101b",
   "FoxitFixedBold.pfb": "f1b7159702973f54fc86254ea38bcf3712b2a736eb3a0995751e9f4bb45ad603",
   "FoxitFixedBoldItalic.pfb": "8a000945843bd31add06aee63bf9fd41b7578b4f3242a4b7cd46349ad9d24d4d",

package/wasm/recto.gen.d.mts

@@ -1,3 +1,3 @@
 import type * as Glue from "./recto.types.mjs";
-export declare function createGlue(placeholders: Record<string, object>, finalizing: (free: () => void) => void): Pick<typeof Glue, "Annotations" | "Document" | "PageObjects" | "PageScan" | "PageText" | "RenderTask" | "RenderedPage" | "setAssetLoader" | "sha256" | "initSync">;
+export declare function createGlue(placeholders: Record<string, object>, finalizing: (free: () => void) => void): Pick<typeof Glue, "Annotations" | "Document" | "PageObjects" | "PageScan" | "PageText" | "RenderTask" | "RenderedPage" | "setAssetLoader" | "setMaxDecodedBytes" | "sha256" | "initSync">;
 export declare const PART_TABLE: string;

package/wasm/recto.gen.mjs

@@ -157,6 +157,21 @@ class Document {
         const ret = wasm.document_filePointer(this.__wbg_ptr);
         return ret >>> 0;
     }
+    /**
+     * Flat, per link: `[annotation, x, y, width, height, kind, text, page, view, destX, destY,
+     * zoom, rectX, rectY, rectWidth, rectHeight, name]`, NaN for a number that isn't there.
+     * `kind` is "none", "uri", "page", "remote", "launch" or "action"; `text` is the URI, the
+     * file, or the action's `/S`; `name` a remote destination's name or a `Named` action's `/N`.
+     * @param {number} index
+     * @returns {Array<any>}
+     */
+    links(index) {
+        const ret = wasm.document_links(this.__wbg_ptr, index);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
     /**
      * @param {number} index
      * @returns {PageObjects}
@@ -174,7 +189,7 @@ class Document {
      * read them; it is called synchronously, chunk-aligned, at most 1 MiB.
      * @param {number} length
      * @param {number} chunk
-     * @param {(offset: number, length: number) => Uint8Array | undefined} read
+     * @param {(offset: number, length: number, ahead: number) => Uint8Array | undefined} read
      * @param {string | null} [password]
      * @returns {Document}
      */
@@ -255,26 +270,36 @@ class Document {
     }
     /**
      * A render that returns to its caller between slices, for as long as it's asked to run.
+     * The region is x, y, width, height in the viewer frame, or NaNs for the whole page.
      * @param {number} index
      * @param {number} width
      * @param {number} max_height
+     * @param {number} x
+     * @param {number} y
+     * @param {number} region_width
+     * @param {number} region_height
      * @returns {RenderTask}
      */
-    renderTask(index, width, max_height) {
-        const ret = wasm.document_renderTask(this.__wbg_ptr, index, width, max_height);
+    renderTask(index, width, max_height, x, y, region_width, region_height) {
+        const ret = wasm.document_renderTask(this.__wbg_ptr, index, width, max_height, x, y, region_width, region_height);
         if (ret[2]) {
             throw takeFromExternrefTable0(ret[1]);
         }
         return RenderTask.__wrap(ret[0]);
     }
     /**
+     * The region as `renderTask`'s.
      * @param {number} index
      * @param {number} width
      * @param {number} max_height
+     * @param {number} x
+     * @param {number} y
+     * @param {number} region_width
+     * @param {number} region_height
      * @returns {RenderedPage}
      */
-    render(index, width, max_height) {
-        const ret = wasm.document_render(this.__wbg_ptr, index, width, max_height);
+    render(index, width, max_height, x, y, region_width, region_height) {
+        const ret = wasm.document_render(this.__wbg_ptr, index, width, max_height, x, y, region_width, region_height);
         if (ret[2]) {
             throw takeFromExternrefTable0(ret[1]);
         }
@@ -756,6 +781,20 @@ class RenderedPage {
         const ret = wasm.__wbg_get_renderedpage_height(this.__wbg_ptr);
         return ret >>> 0;
     }
+    /**
+     * @returns {number}
+     */
+    get pageHeight() {
+        const ret = wasm.__wbg_get_renderedpage_pageHeight(this.__wbg_ptr);
+        return ret >>> 0;
+    }
+    /**
+     * @returns {number}
+     */
+    get pageWidth() {
+        const ret = wasm.__wbg_get_renderedpage_pageWidth(this.__wbg_ptr);
+        return ret >>> 0;
+    }
     /**
      * @returns {boolean}
      */
@@ -770,6 +809,21 @@ class RenderedPage {
         const ret = wasm.__wbg_get_renderedpage_width(this.__wbg_ptr);
         return ret >>> 0;
     }
+    /**
+     * Where it is in the page's bitmap, and that bitmap's size: see `Bitmap`.
+     * @returns {number}
+     */
+    get x() {
+        const ret = wasm.__wbg_get_renderedpage_x(this.__wbg_ptr);
+        return ret >>> 0;
+    }
+    /**
+     * @returns {number}
+     */
+    get y() {
+        const ret = wasm.__wbg_get_renderedpage_y(this.__wbg_ptr);
+        return ret >>> 0;
+    }
     /**
      * Moves the pixels out; call once.
      * @returns {Uint8Array}
@@ -786,6 +840,18 @@ class RenderedPage {
     set height(arg0) {
         wasm.__wbg_set_renderedpage_height(this.__wbg_ptr, arg0);
     }
+    /**
+     * @param {number} arg0
+     */
+    set pageHeight(arg0) {
+        wasm.__wbg_set_renderedpage_pageHeight(this.__wbg_ptr, arg0);
+    }
+    /**
+     * @param {number} arg0
+     */
+    set pageWidth(arg0) {
+        wasm.__wbg_set_renderedpage_pageWidth(this.__wbg_ptr, arg0);
+    }
     /**
      * @param {boolean} arg0
      */
@@ -798,6 +864,19 @@ class RenderedPage {
     set width(arg0) {
         wasm.__wbg_set_renderedpage_width(this.__wbg_ptr, arg0);
     }
+    /**
+     * Where it is in the page's bitmap, and that bitmap's size: see `Bitmap`.
+     * @param {number} arg0
+     */
+    set x(arg0) {
+        wasm.__wbg_set_renderedpage_x(this.__wbg_ptr, arg0);
+    }
+    /**
+     * @param {number} arg0
+     */
+    set y(arg0) {
+        wasm.__wbg_set_renderedpage_y(this.__wbg_ptr, arg0);
+    }
 }
 if (Symbol.dispose) RenderedPage.prototype[Symbol.dispose] = RenderedPage.prototype.free;
 
@@ -812,6 +891,15 @@ function setAssetLoader(loader) {
     wasm.setAssetLoader(loader);
 }
 
+/**
+ * The most bytes one stream may decode to and one image hold, for this instance: past it, it's left
+ * out and the page's results say `truncated`.
+ * @param {number} bytes
+ */
+function setMaxDecodedBytes(bytes) {
+    wasm.setMaxDecodedBytes(bytes);
+}
+
 /**
  * SHA-256, for the JavaScript side's checks on large assets it read synchronously.
  * @param {Uint8Array} bytes
@@ -828,7 +916,7 @@ function sha256(bytes) {
 function __wbg_get_imports() {
     const import0 = {
         __proto__: null,
-        __wbg_Error_ea7352bf93a3f61d: function(arg0, arg1) {
+        __wbg_Error_ac777cef8e847b72: function(arg0, arg1) {
             const ret = Error(getStringFromWasm0(arg0, arg1));
             return ret;
         },
@@ -843,14 +931,14 @@ function __wbg_get_imports() {
         __wbg___wbindgen_throw_41e9ee4f547fc59a: function(arg0, arg1) {
             throw new Error(getStringFromWasm0(arg0, arg1));
         },
-        __wbg_call_1875a20c43a36133: function() { return handleError(function (arg0, arg1, arg2, arg3) {
-            const ret = arg0.call(arg1, arg2, arg3);
-            return ret;
-        }, arguments); },
         __wbg_call_187d372bd5fdd4aa: function() { return handleError(function (arg0, arg1, arg2) {
             const ret = arg0.call(arg1, arg2);
             return ret;
         }, arguments); },
+        __wbg_call_939a2607c4484b0b: function() { return handleError(function (arg0, arg1, arg2, arg3, arg4) {
+            const ret = arg0.call(arg1, arg2, arg3, arg4);
+            return ret;
+        }, arguments); },
         __wbg_length_7f3c00c40364105e: function(arg0) {
             const ret = arg0.length;
             return ret;
@@ -874,7 +962,7 @@ function __wbg_get_imports() {
             const ret = arg0.push(arg1);
             return ret;
         },
-        __wbg_set_807eb08c2580223b: function() { return handleError(function (arg0, arg1, arg2) {
+        __wbg_set_0fd79ff56b8778a4: function() { return handleError(function (arg0, arg1, arg2) {
             const ret = Reflect.set(arg0, arg1, arg2);
             return ret;
         }, arguments); },
@@ -1198,6 +1286,6 @@ async function __wbg_init(module_or_path) {
 
 
 
-return { Annotations, Document, PageObjects, PageScan, PageText, RenderTask, RenderedPage, setAssetLoader, sha256, initSync };
+return { Annotations, Document, PageObjects, PageScan, PageText, RenderTask, RenderedPage, setAssetLoader, setMaxDecodedBytes, sha256, initSync };
 }
 export const PART_TABLE = "%c";

package/wasm/recto.types.d.mts

@@ -30,13 +30,20 @@ export class Document {
      * Where the file is in this instance's memory, to reopen it on the full engine without a copy.
      */
     filePointer(): number;
+    /**
+     * Flat, per link: `[annotation, x, y, width, height, kind, text, page, view, destX, destY,
+     * zoom, rectX, rectY, rectWidth, rectHeight, name]`, NaN for a number that isn't there.
+     * `kind` is "none", "uri", "page", "remote", "launch" or "action"; `text` is the URI, the
+     * file, or the action's `/S`; `name` a remote destination's name or a `Named` action's `/N`.
+     */
+    links(index: number): Array<any>;
     objects(index: number): PageObjects;
     /**
      * A file of `length` bytes read by range. `read(offset, length)`
      * returns those bytes (a Uint8Array), or undefined when it could not
      * read them; it is called synchronously, chunk-aligned, at most 1 MiB.
      */
-    static openRanged(length: number, chunk: number, read: (offset: number, length: number) => Uint8Array | undefined, password?: string | null): Document;
+    static openRanged(length: number, chunk: number, read: (offset: number, length: number, ahead: number) => Uint8Array | undefined, password?: string | null): Document;
     constructor(bytes: Uint8Array, password?: string | null);
     /**
      * Flat, in order: `[title, url or "", level, page]` per item.
@@ -56,9 +63,13 @@ export class Document {
     pageText(index: number): PageText;
     /**
      * A render that returns to its caller between slices, for as long as it's asked to run.
+     * The region is x, y, width, height in the viewer frame, or NaNs for the whole page.
      */
-    renderTask(index: number, width: number, max_height: number): RenderTask;
-    render(index: number, width: number, max_height: number): RenderedPage;
+    renderTask(index: number, width: number, max_height: number, x: number, y: number, region_width: number, region_height: number): RenderTask;
+    /**
+     * The region as `renderTask`'s.
+     */
+    render(index: number, width: number, max_height: number, x: number, y: number, region_width: number, region_height: number): RenderedPage;
     /**
      * Text, objects and annotations from one interpretation of the page.
      */
@@ -161,8 +172,15 @@ export class RenderedPage {
      */
     takeRgba(): Uint8Array<ArrayBuffer>;
     height: number;
+    pageHeight: number;
+    pageWidth: number;
     truncated: boolean;
     width: number;
+    /**
+     * Where it is in the page's bitmap, and that bitmap's size: see `Bitmap`.
+     */
+    x: number;
+    y: number;
 }
 
 /**
@@ -173,6 +191,12 @@ export class RenderedPage {
  */
 export function setAssetLoader(loader: (index: number) => Uint8Array | undefined): void;
 
+/**
+ * The most bytes one stream may decode to and one image hold, for this instance: past it, it's left
+ * out and the page's results say `truncated`.
+ */
+export function setMaxDecodedBytes(bytes: number): void;
+
 /**
  * SHA-256, for the JavaScript side's checks on large assets it read synchronously.
  */
@@ -185,16 +209,24 @@ export interface InitOutput {
     readonly __wbg_annotations_free: (a: number, b: number) => void;
     readonly __wbg_document_free: (a: number, b: number) => void;
     readonly __wbg_get_renderedpage_height: (a: number) => number;
+    readonly __wbg_get_renderedpage_pageHeight: (a: number) => number;
+    readonly __wbg_get_renderedpage_pageWidth: (a: number) => number;
     readonly __wbg_get_renderedpage_truncated: (a: number) => number;
     readonly __wbg_get_renderedpage_width: (a: number) => number;
+    readonly __wbg_get_renderedpage_x: (a: number) => number;
+    readonly __wbg_get_renderedpage_y: (a: number) => number;
     readonly __wbg_pageobjects_free: (a: number, b: number) => void;
     readonly __wbg_pagescan_free: (a: number, b: number) => void;
     readonly __wbg_pagetext_free: (a: number, b: number) => void;
     readonly __wbg_renderedpage_free: (a: number, b: number) => void;
     readonly __wbg_rendertask_free: (a: number, b: number) => void;
     readonly __wbg_set_renderedpage_height: (a: number, b: number) => void;
+    readonly __wbg_set_renderedpage_pageHeight: (a: number, b: number) => void;
+    readonly __wbg_set_renderedpage_pageWidth: (a: number, b: number) => void;
     readonly __wbg_set_renderedpage_truncated: (a: number, b: number) => void;
     readonly __wbg_set_renderedpage_width: (a: number, b: number) => void;
+    readonly __wbg_set_renderedpage_x: (a: number, b: number) => void;
+    readonly __wbg_set_renderedpage_y: (a: number, b: number) => void;
     readonly annotations_appearanceObjects: (a: number) => [number, number];
     readonly annotations_appearanceText: (a: number) => [number, number];
     readonly annotations_appearanceTextObjects: (a: number) => [number, number];
@@ -208,6 +240,7 @@ export interface InitOutput {
     readonly document_annotations: (a: number, b: number) => [number, number, number];
     readonly document_fileLength: (a: number) => number;
     readonly document_filePointer: (a: number) => number;
+    readonly document_links: (a: number, b: number) => [number, number, number];
     readonly document_objects: (a: number, b: number) => [number, number, number];
     readonly document_open: (a: number, b: number, c: number, d: number) => [number, number, number];
     readonly document_openRanged: (a: number, b: number, c: any, d: number, e: number) => [number, number, number];
@@ -216,8 +249,8 @@ export interface InitOutput {
     readonly document_pageInfo: (a: number, b: number) => [number, number, number, number];
     readonly document_pageLabels: (a: number) => any;
     readonly document_pageText: (a: number, b: number) => [number, number, number];
-    readonly document_render: (a: number, b: number, c: number, d: number) => [number, number, number];
-    readonly document_renderTask: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly document_render: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number];
+    readonly document_renderTask: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number];
     readonly document_scan: (a: number, b: number) => [number, number, number];
     readonly document_structureTruncated: (a: number) => [number, number];
     readonly document_textAndAnnotations: (a: number, b: number) => [number, number, number];
@@ -260,6 +293,7 @@ export interface InitOutput {
     readonly rendertask_finish: (a: number) => number;
     readonly rendertask_step: (a: number, b: number) => number;
     readonly setAssetLoader: (a: any) => void;
+    readonly setMaxDecodedBytes: (a: number) => void;
     readonly sha256: (a: number, b: number) => [number, number];
     readonly __wbindgen_exn_store: (a: number) => void;
     readonly __externref_table_alloc: () => number;