@2018kguo/recto 0.0.0-stage → 0.3.0

package/wasm/recto.types.d.mts

@@ -0,0 +1,295 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * `PdfAnnotation[]` as columns, entry `i` per annotation. `hasField[i]` is
+ * 0 where `field` is null.
+ */
+export class Annotations {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly appearanceObjects: Uint32Array<ArrayBuffer>;
+    readonly appearanceTextObjects: Uint32Array<ArrayBuffer>;
+    readonly appearanceText: string[];
+    readonly boxes: Float32Array<ArrayBuffer>;
+    readonly contents: string[];
+    readonly count: number;
+    readonly fieldTypes: string[];
+    readonly fieldValues: string[];
+    readonly hasField: Uint8Array<ArrayBuffer>;
+    readonly subtypes: Uint8Array<ArrayBuffer>;
+}
+
+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;
+    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;
+    constructor(bytes: Uint8Array, password?: string | null);
+    /**
+     * Flat, in order: `[title, url or "", level, page]` per item.
+     */
+    outline(): Array<any>;
+    /**
+     * [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;
+    /**
+     * A render that returns to its caller between slices, for as long as it's asked to run.
+     */
+    renderTask(index: number, width: number, max_height: number): RenderTask;
+    render(index: number, width: number, max_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).
+     */
+    textAndAnnotations(index: number): PageScan;
+    readonly pageCount: number;
+}
+
+/**
+ * `PdfPageObjects` as columns: `images.boxes` is `imageBoxes`, and so on.
+ */
+export class PageObjects {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly imageBoxes: Float32Array<ArrayBuffer>;
+    readonly imagePixels: Uint32Array<ArrayBuffer>;
+    readonly pathBoxes: Float32Array<ArrayBuffer>;
+    readonly pathFlags: Uint8Array<ArrayBuffer>;
+    readonly pathStart: Uint32Array<ArrayBuffer>;
+    readonly segmentKinds: Uint8Array<ArrayBuffer>;
+    readonly segmentPoints: Float32Array<ArrayBuffer>;
+    readonly textObjects: number;
+    readonly truncated: boolean;
+}
+
+/**
+ * `scan`'s result: take each part once.
+ */
+export class PageScan {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    takeAnnotations(): Annotations | undefined;
+    takeObjects(): PageObjects | undefined;
+    takeText(): PageText | undefined;
+}
+
+/**
+ * `PdfPageText` as columns: one entry per Unicode code
+ * point (a ligature's chars share its box). `fonts`, `words` and `runs` are
+ * flattened into `font*`, `word*` and `run*` columns.
+ */
+export class PageText {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly angles: Float32Array<ArrayBuffer>;
+    readonly boxes: Float32Array<ArrayBuffer>;
+    readonly codepoints: Uint32Array<ArrayBuffer>;
+    readonly count: number;
+    readonly fills: Uint32Array<ArrayBuffer>;
+    readonly flags: Uint8Array<ArrayBuffer>;
+    readonly fontAscents: Float32Array<ArrayBuffer>;
+    readonly fontDescents: Float32Array<ArrayBuffer>;
+    readonly fontEmbedded: Uint8Array<ArrayBuffer>;
+    readonly fontFlags: Uint32Array<ArrayBuffer>;
+    readonly fontIds: Int32Array<ArrayBuffer>;
+    readonly fontNames: string[];
+    readonly fontSizes: Float32Array<ArrayBuffer>;
+    readonly fontWeights: Uint32Array<ArrayBuffer>;
+    readonly runEms: Float32Array<ArrayBuffer>;
+    readonly runIds: Int32Array<ArrayBuffer>;
+    readonly runOrigins: Float32Array<ArrayBuffer>;
+    readonly text: string;
+    readonly tfSizes: Float32Array<ArrayBuffer>;
+    readonly truncated: boolean;
+    readonly wordBoxes: Float32Array<ArrayBuffer>;
+    readonly wordFirstChar: Uint32Array<ArrayBuffer>;
+    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;
+    [Symbol.dispose](): void;
+    /**
+     * Moves the pixels out; call once.
+     */
+    takeRgba(): Uint8Array<ArrayBuffer>;
+    height: number;
+    truncated: boolean;
+    width: number;
+}
+
+/**
+ * The host's asset loader: `(index) => Uint8Array | undefined`, called
+ * synchronously the first time a document needs a built-in font (0..13,
+ * `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;
+
+/**
+ * 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 {
+    readonly memory: WebAssembly.Memory;
+    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_truncated: (a: number) => number;
+    readonly __wbg_get_renderedpage_width: (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_truncated: (a: number, b: number) => void;
+    readonly __wbg_set_renderedpage_width: (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];
+    readonly annotations_boxes: (a: number) => [number, number];
+    readonly annotations_contents: (a: number) => [number, number];
+    readonly annotations_count: (a: number) => number;
+    readonly annotations_fieldTypes: (a: number) => [number, number];
+    readonly annotations_fieldValues: (a: number) => [number, number];
+    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_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_renderTask: (a: number, b: number, c: number, d: 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];
+    readonly pageobjects_pathBoxes: (a: number) => [number, number];
+    readonly pageobjects_pathFlags: (a: number) => [number, number];
+    readonly pageobjects_pathStart: (a: number) => [number, number];
+    readonly pageobjects_segmentKinds: (a: number) => [number, number];
+    readonly pageobjects_segmentPoints: (a: number) => [number, number];
+    readonly pageobjects_textObjects: (a: number) => number;
+    readonly pageobjects_truncated: (a: number) => number;
+    readonly pagescan_takeAnnotations: (a: number) => number;
+    readonly pagescan_takeObjects: (a: number) => number;
+    readonly pagescan_takeText: (a: number) => number;
+    readonly pagetext_angles: (a: number) => [number, number];
+    readonly pagetext_boxes: (a: number) => [number, number];
+    readonly pagetext_codepoints: (a: number) => [number, number];
+    readonly pagetext_count: (a: number) => number;
+    readonly pagetext_fills: (a: number) => [number, number];
+    readonly pagetext_flags: (a: number) => [number, number];
+    readonly pagetext_fontAscents: (a: number) => [number, number];
+    readonly pagetext_fontDescents: (a: number) => [number, number];
+    readonly pagetext_fontEmbedded: (a: number) => [number, number];
+    readonly pagetext_fontFlags: (a: number) => [number, number];
+    readonly pagetext_fontIds: (a: number) => [number, number];
+    readonly pagetext_fontNames: (a: number) => [number, number];
+    readonly pagetext_fontSizes: (a: number) => [number, number];
+    readonly pagetext_fontWeights: (a: number) => [number, number];
+    readonly pagetext_runEms: (a: number) => [number, number];
+    readonly pagetext_runIds: (a: number) => [number, number];
+    readonly pagetext_runOrigins: (a: number) => [number, number];
+    readonly pagetext_text: (a: number) => [number, number];
+    readonly pagetext_tfSizes: (a: number) => [number, number];
+    readonly pagetext_truncated: (a: number) => number;
+    readonly pagetext_wordBoxes: (a: number) => [number, number];
+    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 sha256: (a: number, b: number) => [number, number];
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __externref_drop_slice: (a: number, b: number) => void;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;