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

package/docs/api/classes/ExtractJob.md

@@ -0,0 +1,236 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ExtractJob
+
+# Class: ExtractJob\<F\>
+
+An extraction in progress, from [Document.extractJob](Document.md#extractjob). It holds WebAssembly memory and is
+freed with its document, or earlier with `free()` or `using`.
+
+## Extends
+
+- `Handle`\<`BaseGlue`\>
+
+## Type Parameters
+
+### F
+
+`F` *extends* [`ExtractFormat`](../type-aliases/ExtractFormat.md) = [`ExtractFormat`](../type-aliases/ExtractFormat.md)
+
+## Accessors
+
+### instance
+
+#### Get Signature
+
+> **get** `protected` **instance**(): `Instance`\<`G`\>
+
+The instance this handle lives in (for the handles it makes).
+
+##### Returns
+
+`Instance`\<`G`\>
+
+#### Inherited from
+
+`Handle.instance`
+
+***
+
+### isFreed
+
+#### Get Signature
+
+> **get** `protected` **isFreed**(): `boolean`
+
+Whether `free()` ran on this handle or its parent.
+
+##### Returns
+
+`boolean`
+
+#### Inherited from
+
+`Handle.isFreed`
+
+***
+
+### owned
+
+#### Get Signature
+
+> **get** `protected` **owned**(): `boolean`
+
+Whether the handle's raw objects can be freed: its instance is current and hasn't trapped.
+
+##### Returns
+
+`boolean`
+
+#### Inherited from
+
+`Handle.owned`
+
+## Methods
+
+### \[dispose\]()
+
+> **\[dispose\]**(): `void`
+
+Frees the handle at the end of a `using` block (an alias of `free()`).
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`Handle.[dispose]`
+
+***
+
+### assertLive()
+
+> `protected` **assertLive**(): `void`
+
+#### Returns
+
+`void`
+
+#### Throws
+
+[LaminaPdfError](LaminaPdfError.md) `disposed` after `free()` (here or on the parent);
+  `instance-reset` when the instance was replaced (a trapped one is replaced first).
+
+#### Inherited from
+
+`Handle.assertLive`
+
+***
+
+### call()
+
+> `protected` **call**\<`T`\>(`f`): `T`
+
+Runs `f` (calls into the glue) on this live handle; see Instance.call.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### f
+
+(`glue`) => `T`
+
+#### Returns
+
+`T`
+
+#### Inherited from
+
+`Handle.call`
+
+***
+
+### cancel()
+
+> **cancel**(): `void`
+
+Stops the job: its next step fails with `cancelled`.
+
+#### Returns
+
+`void`
+
+***
+
+### free()
+
+> **free**(): `void`
+
+Frees the handle's memory now; without it, the garbage collector frees it later. A second
+call does nothing, and any other call afterwards throws `disposed`. Prefer `using`, which
+calls this at the end of the block.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`Handle.free`
+
+***
+
+### provide()
+
+> **provide**(`result`): `void`
+
+Hands the job the result of its open request.
+
+#### Parameters
+
+##### result
+
+[`ModelResult`](../type-aliases/ModelResult.md)
+
+#### Returns
+
+`void`
+
+#### Throws
+
+[LaminaPdfError](LaminaPdfError.md) `model-result-unexpected` when nothing was asked for or `result`
+  is the other model's; `invalid-argument` / `unknown-option` for a malformed result.
+
+***
+
+### release()
+
+> `protected` **release**(): `void`
+
+Frees the WebAssembly side; called at most once, and only while [owned](#owned).
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+`Handle.release`
+
+***
+
+### step()
+
+> **step**(`budget?`): [`ExtractStep`](../type-aliases/ExtractStep.md)\<`F`\>
+
+Extracts up to `budget` pages. While a model's result is awaited, the step returns
+`{ state: "progress", phase: "model", request }` and does nothing more until
+[provide](#provide) answers it.
+
+#### Parameters
+
+##### budget?
+
+`number` = `1`
+
+#### Returns
+
+[`ExtractStep`](../type-aliases/ExtractStep.md)\<`F`\>
+
+progress, or `{ state: "done", output }` with the output in the job's format.
+
+#### Throws
+
+[LaminaPdfError](LaminaPdfError.md) `cancelled`, `document-changed`, `job-finished`, the reading errors.

package/docs/api/classes/Font.md

@@ -0,0 +1,74 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Font
+
+# Class: Font
+
+A font to draw text with: TrueType or OpenType bytes (subset to the glyphs drawn and embedded)
+or one of the standard 14. Needs the text module (`init({ text: true })`).
+
+## Example
+
+```ts
+const inter = Font.fromBytes(await (await fetch("/Inter.ttf")).arrayBuffer());
+surface.text("Hello", { font: inter, size: 12, at: [72, 72] });
+```
+
+## Properties
+
+### bytes
+
+> `readonly` **bytes**: `Uint8Array`\<`ArrayBufferLike`\> \| `undefined`
+
+The font program, for a font loaded from bytes.
+
+***
+
+### standard
+
+> `readonly` **standard**: [`Standard14`](../type-aliases/Standard14.md) \| `undefined`
+
+The PostScript name, for a standard 14 font.
+
+## Methods
+
+### fromBytes()
+
+> `static` **fromBytes**(`bytes`): `Font`
+
+A font from its bytes (TrueType or OpenType/CFF). The bytes are checked when a builder first
+uses the font (`invalid-font`, `font-not-embeddable`).
+
+#### Parameters
+
+##### bytes
+
+`ArrayBuffer` \| `Uint8Array`\<`ArrayBufferLike`\>
+
+#### Returns
+
+`Font`
+
+***
+
+### standard()
+
+> `static` **standard**(`name`): `Font`
+
+One of the standard 14 fonts.
+
+#### Parameters
+
+##### name
+
+[`Standard14`](../type-aliases/Standard14.md)
+
+#### Returns
+
+`Font`

package/docs/api/classes/Image.md

@@ -0,0 +1,140 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Image
+
+# Class: Image
+
+An image to draw: a JPEG (passed through), a PNG (alpha as a soft mask) or raw RGBA pixels.
+The bytes are copied when the image is created. It is decoded once per WASM module, the first
+time a builder of that module draws it (or `width`/`height` is read), so problems with the
+data (`invalid-image`, `unsupported-image`, …) surface there. Written once per document however
+often it is drawn. It keeps its bytes, so it outlives `reset()` and decodes again.
+
+## Accessors
+
+### height
+
+#### Get Signature
+
+> **get** **height**(): `number`
+
+Height in pixels (decodes the image if no module has yet).
+
+##### Throws
+
+[LaminaPdfError](LaminaPdfError.md) as `in`.
+
+##### Returns
+
+`number`
+
+***
+
+### width
+
+#### Get Signature
+
+> **get** **width**(): `number`
+
+Width in pixels (decodes the image if no module has yet).
+
+##### Throws
+
+[LaminaPdfError](LaminaPdfError.md) as `in`.
+
+##### Returns
+
+`number`
+
+## Methods
+
+### \[dispose\]()
+
+> **\[dispose\]**(): `void`
+
+Frees the image at the end of a `using` block (an alias of `free()`).
+
+#### Returns
+
+`void`
+
+***
+
+### free()
+
+> **free**(): `void`
+
+Frees the image's WASM memory now; without it, the garbage collector frees it later. A second
+call does nothing, and any other call afterwards throws `disposed`. Prefer `using`.
+
+#### Returns
+
+`void`
+
+***
+
+### jpeg()
+
+> `static` **jpeg**(`bytes`): `Image`
+
+A JPEG.
+
+#### Parameters
+
+##### bytes
+
+`Uint8Array`
+
+#### Returns
+
+`Image`
+
+***
+
+### png()
+
+> `static` **png**(`bytes`): `Image`
+
+A PNG.
+
+#### Parameters
+
+##### bytes
+
+`Uint8Array`
+
+#### Returns
+
+`Image`
+
+***
+
+### rgba()
+
+> `static` **rgba**(`width`, `height`, `pixels`): `Image`
+
+8-bit RGBA pixels, row by row (`image-data-length` at first use for a wrong length).
+
+#### Parameters
+
+##### width
+
+`number`
+
+##### height
+
+`number`
+
+##### pixels
+
+`Uint8Array`
+
+#### Returns
+
+`Image`

package/docs/api/classes/LaminaPdfError.md

@@ -0,0 +1,189 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / LaminaPdfError
+
+# Class: LaminaPdfError\<C\>
+
+The one error class of `@laminapdf/sdk` (ADR 0026 §7). `message`, `hint` and `didYouMean` never
+hold document text (ADR 0026 §4); that goes in `data`, marked untrusted on the code's page at
+`docsUrl`.
+
+## Example
+
+```ts
+try {
+  Document.open(bytes, { password: "secret" });
+} catch (e) {
+  if (isLaminaPdfError(e, "wrong-password")) askAgain();
+  else throw e;
+}
+```
+
+## Extends
+
+- `Error`
+
+## Type Parameters
+
+### C
+
+`C` *extends* [`ErrorCode`](../type-aliases/ErrorCode.md) = [`ErrorCode`](../type-aliases/ErrorCode.md)
+
+## Constructors
+
+### Constructor
+
+> **new LaminaPdfError**\<`C`\>(`diagnostic`, `options?`): `LaminaPdfError`\<`C`\>
+
+#### Parameters
+
+##### diagnostic
+
+[`Diagnostic`](../interfaces/Diagnostic.md)\<`C`\>
+
+the ADR 0026 §1 object.
+
+##### options?
+
+`cause`, when wrapping another error.
+
+###### cause?
+
+`unknown`
+
+#### Returns
+
+`LaminaPdfError`\<`C`\>
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### cause?
+
+> `optional` **cause?**: `unknown`
+
+#### Inherited from
+
+`Error.cause`
+
+***
+
+### code
+
+> `readonly` **code**: `C`
+
+The stable code (`fixtures/codes.json`).
+
+***
+
+### data?
+
+> `readonly` `optional` **data?**: `Readonly`\<`Record`\<`string`, `unknown`\>\>
+
+Code-specific fields, documented on the code's page (the only place document text appears).
+
+***
+
+### didYouMean?
+
+> `readonly` `optional` **didYouMean?**: readonly `string`[]
+
+For `usage` errors: the closest known names (Lamina PDF's own vocabulary).
+
+***
+
+### docsUrl
+
+> `readonly` **docsUrl**: `string`
+
+The code's page.
+
+***
+
+### hint?
+
+> `readonly` `optional` **hint?**: `string`
+
+One actionable sentence for this code.
+
+***
+
+### kind
+
+> `readonly` **kind**: [`ErrorKind`](../type-aliases/ErrorKind.md)
+
+What the caller can do about it.
+
+***
+
+### location?
+
+> `readonly` `optional` **location?**: [`Location`](../interfaces/Location.md)
+
+Where in the input or the document.
+
+***
+
+### message
+
+> **message**: `string`
+
+#### Inherited from
+
+`Error.message`
+
+***
+
+### name
+
+> `readonly` **name**: `"LaminaPdfError"` = `"LaminaPdfError"`
+
+#### Overrides
+
+`Error.name`
+
+***
+
+### stack?
+
+> `optional` **stack?**: `string`
+
+#### Inherited from
+
+`Error.stack`
+
+## Accessors
+
+### ranges
+
+#### Get Signature
+
+> **get** **ranges**(): readonly `object`[] \| `undefined`
+
+For `data-pending`: the byte ranges a range document needs fetched before the call can
+succeed (`data.ranges`); `undefined` for other codes. [Document.ensure](Document.md#ensure) fetches them.
+
+##### Returns
+
+readonly `object`[] \| `undefined`
+
+## Methods
+
+### toJSON()
+
+> **toJSON**(): [`Diagnostic`](../interfaces/Diagnostic.md)\<`C`\>
+
+The ADR 0026 §1 object (for logs, workers and `--json` output); optional fields omitted.
+
+#### Returns
+
+[`Diagnostic`](../interfaces/Diagnostic.md)\<`C`\>