@2018kguo/recto 0.1.0 → 0.5.0

package/wasm/recto.types.d.mts

@@ -25,13 +25,25 @@ export class Document {
     free(): void;
     [Symbol.dispose](): void;
     annotations(index: number): Annotations;
+    fileLength(): number;
+    /**
+     * 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.
@@ -41,15 +53,31 @@ export class Document {
      * [width, height, rotation]
      */
     pageInfo(index: number): Float32Array<ArrayBuffer>;
+    /**
+     * One string per page, or null if the file gives no labels.
+     */
+    pageLabels(): any;
     /**
      * `PdfPageText` columns.
      */
     pageText(index: number): PageText;
-    render(index: number, width: number, max_height: number): RenderedPage;
+    /**
+     * 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, 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.
      */
     scan(index: number): PageScan;
+    /**
+     * `[pages, pageLabels, outline]`: whether a limit cut each short.
+     */
+    structureTruncated(): Uint8Array<ArrayBuffer>;
     /**
      * Text and annotations (no objects).
      */
@@ -121,6 +149,20 @@ export class PageText {
     readonly wordLastChar: Uint32Array<ArrayBuffer>;
 }
 
+export class RenderTask {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Rasterizes what `step` drew: the rest of the page, in one call.
+     */
+    finish(): RenderedPage;
+    /**
+     * Runs for about `budget_ms`; true once the page's content is done.
+     */
+    step(budget_ms: number): boolean;
+}
+
 export class RenderedPage {
     private constructor();
     free(): void;
@@ -130,18 +172,36 @@ 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;
 }
 
 /**
  * The host's asset loader: `(index) => Uint8Array | undefined`, called
  * synchronously the first time a document needs a built-in font (0..13,
- * `fonts.bin` order), the CJK fallback (14) or the predefined CMaps (15).
+ * `STANDARD_FONTS` order), the CJK fallback (14) or the predefined CMaps (15).
  * Fonts are kept per instance; the CMaps are decompressed once and kept.
  */
 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.
+ */
+export function sha256(bytes: Uint8Array): Uint8Array<ArrayBuffer>;
+
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 
 export interface InitOutput {
@@ -149,15 +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];
@@ -169,15 +238,21 @@ export interface InitOutput {
     readonly annotations_hasField: (a: number) => [number, number];
     readonly annotations_subtypes: (a: number) => [number, number];
     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];
     readonly document_outline: (a: number) => any;
     readonly document_pageCount: (a: number) => number;
     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_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];
     readonly pageobjects_imageBoxes: (a: number) => [number, number];
     readonly pageobjects_imagePixels: (a: number) => [number, number];
@@ -215,7 +290,11 @@ export interface InitOutput {
     readonly pagetext_wordFirstChar: (a: number) => [number, number];
     readonly pagetext_wordLastChar: (a: number) => [number, number];
     readonly renderedpage_takeRgba: (a: number) => [number, number];
+    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;
     readonly __wbindgen_externrefs: WebAssembly.Table;