@laminapdf/sdk 0.2.0-alpha.2 → 0.2.0-alpha.3

package/docs/schemas/error.schema.json

@@ -0,0 +1,305 @@
+{
+  "$defs": {
+    "error": {
+      "properties": {
+        "code": {
+          "description": "The stable kebab-case code (fixtures/codes.json).",
+          "enum": [
+            "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"
+          ]
+        },
+        "data": {
+          "description": "Code-specific fields, listed on the code's page; the only place document-derived strings appear (untrusted).",
+          "type": "object"
+        },
+        "didYouMean": {
+          "description": "For usage errors: the closest names from lamina's own vocabulary.",
+          "items": {
+            "type": "string"
+          },
+          "minItems": 1,
+          "type": "array"
+        },
+        "docsUrl": {
+          "description": "The code's explain page: base + code + suffix (ADR 0026 §6).",
+          "pattern": "^https:\\/\\/github\\.com\\/laudebugs\\/laminapdf\\/blob\\/main\\/docs\\/errors\\/[a-z0-9-]+\\.md$",
+          "type": "string"
+        },
+        "hint": {
+          "description": "One actionable sentence for this code. Never document text.",
+          "minLength": 1,
+          "type": "string"
+        },
+        "kind": {
+          "$ref": "#/$defs/kind"
+        },
+        "location": {
+          "$ref": "#/$defs/location"
+        },
+        "message": {
+          "description": "One lowercase sentence. Never document text (ADR 0026 §4).",
+          "minLength": 1,
+          "type": "string"
+        }
+      },
+      "required": [
+        "code",
+        "kind",
+        "message",
+        "docsUrl"
+      ],
+      "type": "object"
+    },
+    "kind": {
+      "description": "The nine kinds of ADR 0026 §2.",
+      "enum": [
+        "input",
+        "io",
+        "unsupported",
+        "limit",
+        "security",
+        "usage",
+        "state",
+        "cancelled",
+        "internal"
+      ]
+    },
+    "location": {
+      "additionalProperties": false,
+      "dependentRequired": {
+        "streamOffset": [
+          "object"
+        ]
+      },
+      "description": "Where the problem is (ADR 0026 §1.1); every value is lamina-made.",
+      "properties": {
+        "id": {
+          "description": "A LaminaPdfId (p12.0).",
+          "type": "string"
+        },
+        "object": {
+          "description": "Object number of the indirect object the problem is in or at.",
+          "minimum": 0,
+          "type": "integer"
+        },
+        "offset": {
+          "description": "Byte offset in the input file.",
+          "minimum": 0,
+          "type": "integer"
+        },
+        "pageIndex": {
+          "description": "0-based page index (ADR 0027 §6).",
+          "minimum": 0,
+          "type": "integer"
+        },
+        "streamOffset": {
+          "description": "Byte offset in the decoded data of `object`.",
+          "minimum": 0,
+          "type": "integer"
+        }
+      },
+      "type": "object"
+    },
+    "warning": {
+      "properties": {
+        "code": {
+          "description": "The stable kebab-case code (fixtures/codes.json).",
+          "enum": [
+            "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"
+          ]
+        },
+        "data": {
+          "description": "Code-specific fields, listed on the code's page; the only place document-derived strings appear (untrusted).",
+          "type": "object"
+        },
+        "didYouMean": false,
+        "docsUrl": {
+          "description": "The code's explain page: base + code + suffix (ADR 0026 §6).",
+          "pattern": "^https:\\/\\/github\\.com\\/laudebugs\\/laminapdf\\/blob\\/main\\/docs\\/errors\\/[a-z0-9-]+\\.md$",
+          "type": "string"
+        },
+        "hint": {
+          "description": "One actionable sentence for this code. Never document text.",
+          "minLength": 1,
+          "type": "string"
+        },
+        "kind": {
+          "$ref": "#/$defs/kind"
+        },
+        "location": {
+          "$ref": "#/$defs/location"
+        },
+        "message": {
+          "description": "One lowercase sentence. Never document text (ADR 0026 §4).",
+          "minLength": 1,
+          "type": "string"
+        }
+      },
+      "required": [
+        "code",
+        "kind",
+        "message",
+        "docsUrl"
+      ],
+      "type": "object"
+    }
+  },
+  "$id": "https://github.com/laudebugs/laminapdf/blob/main/packages/sdk/schemas/error.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "An error or warning of every lamina surface (ADR 0026 §1): camelCase keys, optional keys omitted (never null). Generated from fixtures/codes.json by `cargo xtask gen codes`; do not edit. New optional keys may appear within version 1; consumers ignore unknown keys.",
+  "oneOf": [
+    {
+      "$ref": "#/$defs/error"
+    },
+    {
+      "$ref": "#/$defs/warning"
+    }
+  ],
+  "title": "laminapdf.error/1"
+}

package/docs/schemas/renames.schema.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://docs.laminapdf.com/schemas/renames-1.json",
+  "title": "laminapdf.renames/1",
+  "description": "What old names in Lamina PDF's APIs became: one entry per renamed, moved or deprecated item, so a coding agent can map old code to the current names.",
+  "type": "object",
+  "required": ["schema", "renames"],
+  "additionalProperties": false,
+  "properties": {
+    "$schema": { "type": "string" },
+    "schema": { "const": "laminapdf.renames/1" },
+    "renames": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["from", "to", "surface", "kind", "since", "note"],
+        "additionalProperties": false,
+        "properties": {
+          "from": { "type": "string", "minLength": 1, "description": "The old name, as a path (laminapdf::extract::TextRun) or a TypeScript export (Document.save)." },
+          "to": { "type": "string", "minLength": 1, "description": "The name to use now." },
+          "surface": { "enum": ["rust", "ts", "cli"] },
+          "kind": { "enum": ["type", "function", "method", "field", "module", "option", "command", "flag", "code"] },
+          "since": { "type": "string", "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+(-[0-9A-Za-z.-]+)?$", "description": "The first version with the new name." },
+          "note": { "type": "string" }
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@laminapdf/sdk",
-  "version": "0.2.0-alpha.2",
+  "version": "0.2.0-alpha.3",
   "description": "Create, read, edit and save PDFs from TypeScript: Lamina PDF's Rust core as WebAssembly, synchronous after init(), in browsers, Node, Deno, Bun and Cloudflare Workers.",
   "license": "MIT OR Apache-2.0",
   "homepage": "https://laminapdf.com",
@@ -23,6 +23,7 @@
   },
   "files": [
     "dist",
+    "docs",
     "schemas"
   ],
   "exports": {
@@ -64,10 +65,11 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@laminapdf/wasm": "0.2.0-alpha.2"
+    "@laminapdf/wasm": "0.2.0-alpha.3"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.18.5",
+    "@microsoft/api-extractor": "7.59.4",
     "@types/node": "26.6.5",
     "@vitest/browser-playwright": "5.0.5",
     "ajv": "8.20.0",
@@ -88,7 +90,7 @@
   "scripts": {
     "build:wasm": "tsc -p tsconfig.build.json",
     "typecheck:wasm": "tsc --noEmit -p tsconfig.json",
-    "test:wasm": "pnpm run build:wasm && tsc --noEmit -p tsconfig.json && vitest run -c vitest.node.config.ts --project node",
+    "test:wasm": "pnpm run build:wasm && tsc --noEmit -p tsconfig.json && vitest run -c vitest.node.config.ts --project node --project small-memory",
     "lint:package": "publint --strict && attw --pack . --profile esm-only"
   }
 }

package/schemas/error.schema.json

@@ -87,6 +87,7 @@
             "job-finished",
             "document-changed",
             "builder-finished",
+            "disposed",
             "invalid-argument",
             "source-budget-exceeded",
             "unknown-option",
@@ -96,10 +97,20 @@
             "not-initialized",
             "source-changed",
             "text-module-not-loaded",
-            "disposed",
             "worker-version-mismatch",
             "worker-crashed",
-            "worker-failed"
+            "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"
           ]
         },
         "data": {
@@ -233,6 +244,12 @@
             "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"
           ]