@laminapdf/sdk 0.0.0-stage → 0.2.0-alpha.3

package/dist/generated/builder-enums.js

@@ -0,0 +1,80 @@
+// @generated by cargo xtask gen boundary. DO NOT EDIT.
+// From laminapdf-wasm's name tables and laminapdf-build's TagKind::as_str; `cargo xtask check docs` fails when it is stale.
+/** Every FillRule, as the WASM module names it. */
+export const FILL_RULES = [
+    "nonZero",
+    "evenOdd",
+];
+/** Every LineCap, as the WASM module names it. */
+export const LINE_CAPS = [
+    "butt",
+    "round",
+    "square",
+];
+/** Every LineJoin, as the WASM module names it. */
+export const LINE_JOINS = [
+    "miter",
+    "round",
+    "bevel",
+];
+/** Every BlendMode, as the WASM module names it. */
+export const BLEND_MODES = [
+    "normal",
+    "multiply",
+    "screen",
+    "overlay",
+    "darken",
+    "lighten",
+    "colorDodge",
+    "colorBurn",
+    "hardLight",
+    "softLight",
+    "difference",
+    "exclusion",
+    "hue",
+    "saturation",
+    "color",
+    "luminosity",
+];
+/** Every ArtifactKind, as the WASM module names it. */
+export const ARTIFACT_KINDS = [
+    "layout",
+    "page",
+    "pagination",
+    "background",
+];
+/** Every TableScope, as the WASM module names it. */
+export const TABLE_SCOPES = [
+    "row",
+    "column",
+    "both",
+];
+/** Every TagName, as the WASM module names it. */
+export const TAG_NAMES = [
+    "Document",
+    "Part",
+    "Sect",
+    "H1",
+    "H2",
+    "H3",
+    "H4",
+    "H5",
+    "H6",
+    "P",
+    "L",
+    "LI",
+    "Lbl",
+    "LBody",
+    "Table",
+    "TR",
+    "TH",
+    "TD",
+    "Figure",
+    "Caption",
+    "Link",
+    "Span",
+    "Quote",
+    "Note",
+    "Code",
+];
+//# sourceMappingURL=builder-enums.js.map

package/dist/generated/builder-enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder-enums.js","sourceRoot":"","sources":["../../src/generated/builder-enums.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,4HAA4H;AAE5H,mDAAmD;AACnD,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,SAAS;IACT,SAAS;CACD,CAAC;AAKX,kDAAkD;AAClD,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,MAAM;IACN,OAAO;IACP,QAAQ;CACA,CAAC;AAKX,mDAAmD;AACnD,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,OAAO;IACP,OAAO;IACP,OAAO;CACC,CAAC;AAKX,oDAAoD;AACpD,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,QAAQ;IACR,UAAU;IACV,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,SAAS;IACT,YAAY;IACZ,WAAW;IACX,WAAW;IACX,WAAW;IACX,YAAY;IACZ,WAAW;IACX,KAAK;IACL,YAAY;IACZ,OAAO;IACP,YAAY;CACJ,CAAC;AAKX,uDAAuD;AACvD,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,QAAQ;IACR,MAAM;IACN,YAAY;IACZ,YAAY;CACJ,CAAC;AAKX,qDAAqD;AACrD,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,KAAK;IACL,QAAQ;IACR,MAAM;CACE,CAAC;AAKX,kDAAkD;AAClD,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,UAAU;IACV,MAAM;IACN,MAAM;IACN,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,GAAG;IACH,GAAG;IACH,IAAI;IACJ,KAAK;IACL,OAAO;IACP,OAAO;IACP,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,QAAQ;IACR,SAAS;IACT,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;CACE,CAAC"}

package/dist/generated/codes.d.ts

@@ -0,0 +1,109 @@
+/** The nine kinds of ADR 0026 §2: what the caller can do about an error. */
+export type ErrorKind = "input" | "io" | "unsupported" | "limit" | "security" | "usage" | "state" | "cancelled" | "internal";
+/** Every error code (ADR 0026 §3; `fixtures/codes.json`). */
+export type ErrorCode = "not-pdf" | "missing-root" | "reference-cycle" | "limit-exceeded" | "strict" | "data-pending" | "source" | "type" | "invalid-structure" | "unset-object" | "repaired-base" | "encrypted-base" | "password-required" | "wrong-password" | "unsupported-security-handler" | "unexpected-eof" | "syntax" | "unsupported-filter" | "decompress" | "nested-transaction" | "no-transaction" | "unknown-page" | "direct-page" | "unsupported-version" | "invalid-op-log" | "saved-not-rebased" | "no-pending-save" | "sink" | "not-rebased" | "sink-not-empty" | "would-invalidate-signatures" | "requires-rewrite" | "invalid-font" | "collection-index" | "unknown-axis" | "font-not-embeddable" | "missing-glyph" | "glyph-out-of-range" | "unknown-font" | "subset-failed" | "invalid-axis-value" | "wrong-document" | "invalid-feature" | "invalid-text-range" | "unsupported-layout-option" | "font-mismatch" | "encoding-full" | "font-not-shapable" | "invalid-image" | "unsupported-image" | "image-too-large" | "image-data-length" | "invalid-icc-profile" | "color-components" | "invalid-color" | "invalid-geometry" | "text-overflow" | "page-index-out-of-range" | "unknown-destination" | "invalid-page-labels" | "profile-version-conflict" | "missing-title" | "missing-lang" | "missing-alt-text" | "untagged-content" | "heading-level-skipped" | "unnumbered-heading-misused" | "invalid-structure-nesting" | "link-without-structure" | "link-without-contents" | "font-not-embedded" | "glyph-without-unicode" | "device-color-without-output-intent" | "embedded-file-forbidden" | "embedded-file-without-mime-type" | "render-too-large" | "render-failed" | "render-backend-unavailable" | "cancelled" | "job-finished" | "document-changed" | "builder-finished" | "disposed" | "invalid-argument" | "source-budget-exceeded" | "unknown-option" | "already-initialized" | "extract-module-not-loaded" | "fetch-failed" | "not-initialized" | "source-changed" | "text-module-not-loaded" | "worker-version-mismatch" | "worker-crashed" | "worker-failed" | "wasm-trap" | "out-of-memory" | "instance-reset" | "invalid-command-line" | "invalid-page-range" | "binary-output-to-terminal" | "unknown-code" | "overwrite-refused" | "input-unreadable" | "output-unwritable" | "path-outside-roots";
+/** Every warning code (ADR 0026 §3; `fixtures/codes.json`). */
+export type WarningCode = "missing-header" | "xref-repaired" | "xrefstm-ignored" | "stream-length-recovered" | "stale-generation" | "page-tree-node-skipped" | "page-count-mismatch" | "flate-truncated" | "objstm-index-mismatch" | "object-number-out-of-range" | "aes-padding-invalid" | "perms-mismatch" | "warnings-truncated" | "invalid-box" | "invalid-rotate" | "name-tree-node-skipped" | "outline-cycle" | "outline-item-skipped" | "invalid-date" | "invalid-page-label" | "invalid-entry" | "content-unknown-operator" | "content-bad-operands" | "content-unbalanced-q" | "content-unbalanced-bt" | "content-unbalanced-marked" | "content-syntax" | "content-resource-missing" | "inline-image-unterminated" | "xobject-cycle" | "content-path-unpainted" | "font-invalid" | "cmap-invalid" | "unmapped-glyph" | "extract-limit-blocks" | "extract-reading-order-ambiguous" | "extract-table-ambiguous" | "extract-table-limit" | "extract-struct-tree-ignored" | "extract-untagged-content" | "tounicode-conflict" | "whole-font-rebuilt";
+/** The names of the `Limits` (ADR 0003 §3), as `data.limit` of `limit-exceeded`. */
+export type LimitName = "max_nesting_depth" | "max_stream_decoded" | "max_decoded_total" | "max_filter_chain" | "max_resolve_depth" | "max_page_tree_depth" | "max_tree_depth" | "max_string_length" | "max_content_operators" | "max_xobject_depth" | "max_image_pixels" | "max_read_window";
+/** Every error code, in `codes.json` order. */
+export declare const ERROR_CODES: readonly ErrorCode[];
+/** Every warning code, in `codes.json` order. */
+export declare const WARNING_CODES: readonly WarningCode[];
+/** The kind of every code. */
+export declare const KINDS: {
+    readonly [C in ErrorCode | WarningCode]: ErrorKind;
+};
+/** The hint of every code (ADR 0026 §5), with its `{limit}`/`{option}` parameters unfilled. */
+export declare const HINTS: {
+    readonly [C in ErrorCode | WarningCode]: string;
+};
+/** `docsUrl` = base + code + suffix (ADR 0026 §6). */
+export declare const DOCS_URL: {
+    readonly base: "https://github.com/laudebugs/laminapdf/blob/main/docs/errors/";
+    readonly suffix: ".md";
+};
+/** The explain page of `code` (`docsUrl`, ADR 0026 §6). */
+export declare function docsUrl(code: ErrorCode | WarningCode): string;
+/** The groups of `codes.json` that list errors. */
+export declare const ERROR_GROUPS: readonly string[];
+/** The groups of `codes.json` that list warnings. */
+export declare const WARNING_GROUPS: readonly string[];
+/** The groups whose codes only `@laminapdf/sdk` raises (not in the Rust enums or the WASM). */
+export declare const TS_ONLY_GROUPS: readonly string[];
+/** Kind and hint of the codes `@laminapdf/sdk` raises itself (the WASM fills in the others). */
+export declare const RAISED_BY_PACKAGE: {
+    readonly "nested-transaction": {
+        readonly kind: "state";
+        readonly hint: "commit or roll back the open transaction first, or use a savepoint inside it";
+    };
+    readonly "no-transaction": {
+        readonly kind: "state";
+        readonly hint: "call begin first, or use transact";
+    };
+    readonly cancelled: {
+        readonly kind: "cancelled";
+        readonly hint: "nothing to do: this is the outcome the caller asked for; start a new job to try again";
+    };
+    readonly "builder-finished": {
+        readonly kind: "state";
+        readonly hint: "create a new builder or page: a finished one takes no more drawing, pages, fonts or settings";
+    };
+    readonly disposed: {
+        readonly kind: "state";
+        readonly hint: "free a handle only after its last use; to keep working, open the document again or create a new builder";
+    };
+    readonly "invalid-argument": {
+        readonly kind: "usage";
+        readonly hint: "pass the value the type declarations describe; the data field says what was wrong";
+    };
+    readonly "already-initialized": {
+        readonly kind: "state";
+        readonly hint: "call init and loadText with a source once, before the first load; later calls need no source";
+    };
+    readonly "extract-module-not-loaded": {
+        readonly kind: "state";
+        readonly hint: "load the extract module (init with the extract option, or loadExtract) or the text module before opening the document";
+    };
+    readonly "fetch-failed": {
+        readonly kind: "io";
+        readonly hint: "check that the URL is reachable and that the server sends the CORS headers range requests need (Content-Range must be exposed); data.reason and data.status say what failed";
+    };
+    readonly "not-initialized": {
+        readonly kind: "state";
+        readonly hint: "await init() once before calling anything else in @laminapdf/sdk";
+    };
+    readonly "source-changed": {
+        readonly kind: "io";
+        readonly hint: "open the file again; the document already read parts of the old version and can't mix in the new one";
+    };
+    readonly "text-module-not-loaded": {
+        readonly kind: "state";
+        readonly hint: "load the text module with init and the text option, or with loadText, before creating the builder that draws text";
+    };
+    readonly "worker-version-mismatch": {
+        readonly kind: "usage";
+        readonly hint: "serve the worker file from the same @laminapdf/sdk build as the page; don't load it from a CDN or an older deploy";
+    };
+    readonly "worker-crashed": {
+        readonly kind: "internal";
+        readonly hint: "call client.restart() and open the document again; report the file if it keeps happening";
+    };
+    readonly "worker-failed": {
+        readonly kind: "internal";
+        readonly hint: "this is a bug in Lamina PDF: report it with the call and the message; the worker keeps running";
+    };
+    readonly "wasm-trap": {
+        readonly kind: "internal";
+        readonly hint: "open the document again and retry; report the file and the call if it traps again";
+    };
+    readonly "out-of-memory": {
+        readonly kind: "limit";
+        readonly hint: "open fewer or smaller documents at once and free each when done; lower the open limits so hostile files fail sooner";
+    };
+    readonly "instance-reset": {
+        readonly kind: "state";
+        readonly hint: "open the document again or create a new builder: nothing from the old instance survives";
+    };
+};
+//# sourceMappingURL=codes.d.ts.map

package/dist/generated/codes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codes.d.ts","sourceRoot":"","sources":["../../src/generated/codes.ts"],"names":[],"mappings":"AAGA,4EAA4E;AAC5E,MAAM,MAAM,SAAS,GACjB,OAAO,GACP,IAAI,GACJ,aAAa,GACb,OAAO,GACP,UAAU,GACV,OAAO,GACP,OAAO,GACP,WAAW,GACX,UAAU,CAAC;AAEf,6DAA6D;AAC7D,MAAM,MAAM,SAAS,GACjB,SAAS,GACT,cAAc,GACd,iBAAiB,GACjB,gBAAgB,GAChB,QAAQ,GACR,cAAc,GACd,QAAQ,GACR,MAAM,GACN,mBAAmB,GACnB,cAAc,GACd,eAAe,GACf,gBAAgB,GAChB,mBAAmB,GACnB,gBAAgB,GAChB,8BAA8B,GAC9B,gBAAgB,GAChB,QAAQ,GACR,oBAAoB,GACpB,YAAY,GACZ,oBAAoB,GACpB,gBAAgB,GAChB,cAAc,GACd,aAAa,GACb,qBAAqB,GACrB,gBAAgB,GAChB,mBAAmB,GACnB,iBAAiB,GACjB,MAAM,GACN,aAAa,GACb,gBAAgB,GAChB,6BAA6B,GAC7B,kBAAkB,GAClB,cAAc,GACd,kBAAkB,GAClB,cAAc,GACd,qBAAqB,GACrB,eAAe,GACf,oBAAoB,GACpB,cAAc,GACd,eAAe,GACf,oBAAoB,GACpB,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,2BAA2B,GAC3B,eAAe,GACf,eAAe,GACf,mBAAmB,GACnB,eAAe,GACf,mBAAmB,GACnB,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,GAClB,eAAe,GACf,kBAAkB,GAClB,eAAe,GACf,yBAAyB,GACzB,qBAAqB,GACrB,qBAAqB,GACrB,0BAA0B,GAC1B,eAAe,GACf,cAAc,GACd,kBAAkB,GAClB,kBAAkB,GAClB,uBAAuB,GACvB,4BAA4B,GAC5B,2BAA2B,GAC3B,wBAAwB,GACxB,uBAAuB,GACvB,mBAAmB,GACnB,uBAAuB,GACvB,oCAAoC,GACpC,yBAAyB,GACzB,iCAAiC,GACjC,kBAAkB,GAClB,eAAe,GACf,4BAA4B,GAC5B,WAAW,GACX,cAAc,GACd,kBAAkB,GAClB,kBAAkB,GAClB,UAAU,GACV,kBAAkB,GAClB,wBAAwB,GACxB,gBAAgB,GAChB,qBAAqB,GACrB,2BAA2B,GAC3B,cAAc,GACd,iBAAiB,GACjB,gBAAgB,GAChB,wBAAwB,GACxB,yBAAyB,GACzB,gBAAgB,GAChB,eAAe,GACf,WAAW,GACX,eAAe,GACf,gBAAgB,GAChB,sBAAsB,GACtB,oBAAoB,GACpB,2BAA2B,GAC3B,cAAc,GACd,mBAAmB,GACnB,kBAAkB,GAClB,mBAAmB,GACnB,oBAAoB,CAAC;AAEzB,+DAA+D;AAC/D,MAAM,MAAM,WAAW,GACnB,gBAAgB,GAChB,eAAe,GACf,iBAAiB,GACjB,yBAAyB,GACzB,kBAAkB,GAClB,wBAAwB,GACxB,qBAAqB,GACrB,iBAAiB,GACjB,uBAAuB,GACvB,4BAA4B,GAC5B,qBAAqB,GACrB,gBAAgB,GAChB,oBAAoB,GACpB,aAAa,GACb,gBAAgB,GAChB,wBAAwB,GACxB,eAAe,GACf,sBAAsB,GACtB,cAAc,GACd,oBAAoB,GACpB,eAAe,GACf,0BAA0B,GAC1B,sBAAsB,GACtB,sBAAsB,GACtB,uBAAuB,GACvB,2BAA2B,GAC3B,gBAAgB,GAChB,0BAA0B,GAC1B,2BAA2B,GAC3B,eAAe,GACf,wBAAwB,GACxB,cAAc,GACd,cAAc,GACd,gBAAgB,GAChB,sBAAsB,GACtB,iCAAiC,GACjC,yBAAyB,GACzB,qBAAqB,GACrB,6BAA6B,GAC7B,0BAA0B,GAC1B,oBAAoB,GACpB,oBAAoB,CAAC;AAEzB,oFAAoF;AACpF,MAAM,MAAM,SAAS,GACjB,mBAAmB,GACnB,oBAAoB,GACpB,mBAAmB,GACnB,kBAAkB,GAClB,mBAAmB,GACnB,qBAAqB,GACrB,gBAAgB,GAChB,mBAAmB,GACnB,uBAAuB,GACvB,mBAAmB,GACnB,kBAAkB,GAClB,iBAAiB,CAAC;AAEtB,+CAA+C;AAC/C,eAAO,MAAM,WAAW,EAAE,SAAS,SAAS,EA2G3C,CAAC;AAEF,iDAAiD;AACjD,eAAO,MAAM,aAAa,EAAE,SAAS,WAAW,EA2C/C,CAAC;AAEF,8BAA8B;AAC9B,eAAO,MAAM,KAAK,EAAE;IAAE,QAAQ,EAAE,CAAC,IAAI,SAAS,GAAG,WAAW,GAAG,SAAS;CAqJvE,CAAC;AAEF,+FAA+F;AAC/F,eAAO,MAAM,KAAK,EAAE;IAAE,QAAQ,EAAE,CAAC,IAAI,SAAS,GAAG,WAAW,GAAG,MAAM;CAqJpE,CAAC;AAEF,sDAAsD;AACtD,eAAO,MAAM,QAAQ;aAAK,IAAI,EAAE,+DAA+D;aAAE,MAAM,EAAE,KAAK;CAAW,CAAC;AAE1H,2DAA2D;AAC3D,wBAAgB,OAAO,CAAC,IAAI,EAAE,SAAS,GAAG,WAAW,GAAG,MAAM,CAE7D;AAED,mDAAmD;AACnD,eAAO,MAAM,YAAY,EAAE,SAAS,MAAM,EAWzC,CAAC;AAEF,qDAAqD;AACrD,eAAO,MAAM,cAAc,EAAE,SAAS,MAAM,EAG3C,CAAC;AAEF,+FAA+F;AAC/F,eAAO,MAAM,cAAc,EAAE,SAAS,MAAM,EAE3C,CAAC;AAEF,gGAAgG;AAChG,eAAO,MAAM,iBAAiB;aAC5B,oBAAoB;iBAAI,IAAI,EAAE,OAAO;iBAAE,IAAI,EAAE,8EAA8E;;aAC3H,gBAAgB;iBAAI,IAAI,EAAE,OAAO;iBAAE,IAAI,EAAE,mCAAmC;;aAC5E,SAAW;iBAAI,IAAI,EAAE,WAAW;iBAAE,IAAI,EAAE,uFAAuF;;aAC/H,kBAAkB;iBAAI,IAAI,EAAE,OAAO;iBAAE,IAAI,EAAE,8FAA8F;;aACzI,QAAU;iBAAI,IAAI,EAAE,OAAO;iBAAE,IAAI,EAAE,yGAAyG;;aAC5I,kBAAkB;iBAAI,IAAI,EAAE,OAAO;iBAAE,IAAI,EAAE,mFAAmF;;aAC9H,qBAAqB;iBAAI,IAAI,EAAE,OAAO;iBAAE,IAAI,EAAE,8FAA8F;;aAC5I,2BAA2B;iBAAI,IAAI,EAAE,OAAO;iBAAE,IAAI,EAAE,uHAAuH;;aAC3K,cAAc;iBAAI,IAAI,EAAE,IAAI;iBAAE,IAAI,EAAE,6KAA6K;;aACjN,iBAAiB;iBAAI,IAAI,EAAE,OAAO;iBAAE,IAAI,EAAE,kEAAkE;;aAC5G,gBAAgB;iBAAI,IAAI,EAAE,IAAI;iBAAE,IAAI,EAAE,sGAAsG;;aAC5I,wBAAwB;iBAAI,IAAI,EAAE,OAAO;iBAAE,IAAI,EAAE,mHAAmH;;aACpK,yBAAyB;iBAAI,IAAI,EAAE,OAAO;iBAAE,IAAI,EAAE,mHAAmH;;aACrK,gBAAgB;iBAAI,IAAI,EAAE,UAAU;iBAAE,IAAI,EAAE,0FAA0F;;aACtI,eAAe;iBAAI,IAAI,EAAE,UAAU;iBAAE,IAAI,EAAE,gGAAgG;;aAC3I,WAAW;iBAAI,IAAI,EAAE,UAAU;iBAAE,IAAI,EAAE,mFAAmF;;aAC1H,eAAe;iBAAI,IAAI,EAAE,OAAO;iBAAE,IAAI,EAAE,qHAAqH;;aAC7J,gBAAgB;iBAAI,IAAI,EAAE,OAAO;iBAAE,IAAI,EAAE,yFAAyF;;CAC1H,CAAC"}