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

package/docs/api/interfaces/WasmMemory.md

@@ -0,0 +1,37 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / WasmMemory
+
+# Interface: WasmMemory
+
+The size of each loaded module's linear memory, in bytes.
+
+## Properties
+
+### base?
+
+> `readonly` `optional` **base?**: `number`
+
+The base module's (absent before `init()`).
+
+***
+
+### extract?
+
+> `readonly` `optional` **extract?**: `number`
+
+The extract module's (absent until it is loaded).
+
+***
+
+### text?
+
+> `readonly` `optional` **text?**: `number`
+
+The text module's (absent until it is loaded).

package/docs/api/type-aliases/AfRelationship.md

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / AfRelationship
+
+# Type Alias: AfRelationship
+
+> **AfRelationship** = `AfRelationshipInit`
+
+How an attached file relates to the document (`/AFRelationship`).

package/docs/api/type-aliases/Align.md

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Align
+
+# Type Alias: Align
+
+> **Align** = `AlignInit`
+
+Text alignment in a text box.

package/docs/api/type-aliases/ArtifactKind.md

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ArtifactKind
+
+# Type Alias: ArtifactKind
+
+> **ArtifactKind** = *typeof* `ARTIFACT_KINDS`\[`number`\]
+
+What kind of artifact (content outside the logical structure); `header`, `footer` and `watermark` are pagination artifacts that say which.

package/docs/api/type-aliases/AttachmentOptions.md

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / AttachmentOptions
+
+# Type Alias: AttachmentOptions
+
+> **AttachmentOptions** = `AttachmentInit`
+
+An attached file's relationship, description and modification date.

package/docs/api/type-aliases/BlendMode.md

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / BlendMode
+
+# Type Alias: BlendMode
+
+> **BlendMode** = *typeof* `BLEND_MODES`\[`number`\]
+
+Blend modes (`/BM`), camelCase.

package/docs/api/type-aliases/BoxRect.md

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / BoxRect
+
+# Type Alias: BoxRect
+
+> **BoxRect** = `RectJs`
+
+A rectangle returned by the builder (page space).

package/docs/api/type-aliases/BuildOptions.md

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / BuildOptions
+
+# Type Alias: BuildOptions
+
+> **BuildOptions** = `BuildOptionsInit`
+
+Options for a new document: version, fixed file ID (32 hex digits), producer, creation date.

package/docs/api/type-aliases/Cell.md

@@ -0,0 +1,71 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Cell
+
+# Type Alias: Cell
+
+> **Cell** = `object`
+
+One cell of a table block.
+
+## Properties
+
+### bbox
+
+> **bbox**: \[`number`, `number`, `number`, `number`\]
+
+Its box in page space.
+
+***
+
+### col
+
+> **col**: `number`
+
+The first column it covers, 0 at the left.
+
+***
+
+### colSpan
+
+> **colSpan**: `number`
+
+How many columns it covers.
+
+***
+
+### header
+
+> **header**: `boolean`
+
+Whether it is in a header row.
+
+***
+
+### row
+
+> **row**: `number`
+
+The first row it covers, 0 at the top.
+
+***
+
+### rowSpan
+
+> **rowSpan**: `number`
+
+How many rows it covers.
+
+***
+
+### text
+
+> **text**: `string`
+
+Its visible text, lines joined by a space.

package/docs/api/type-aliases/Chunk.md

@@ -0,0 +1,79 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Chunk
+
+# Type Alias: Chunk
+
+> **Chunk** = `object`
+
+One chunk.
+
+## Properties
+
+### blockIds
+
+> **blockIds**: `string`[]
+
+The blocks it holds, in order.
+
+***
+
+### headingPath
+
+> **headingPath**: `string`[]
+
+The headings above its first block, outermost first.
+
+***
+
+### id
+
+> **id**: `string`
+
+`c<n>`, from 0, in order.
+
+***
+
+### pages
+
+> **pages**: `number`[]
+
+The pages its blocks are on, ascending.
+
+***
+
+### regions
+
+> **regions**: [`Region`](Region.md)[]
+
+Its area on each of those pages.
+
+***
+
+### text
+
+> **text**: `string`
+
+The Markdown from the first block's start to the last block's end.
+
+***
+
+### textRange
+
+> **textRange**: [`TextRange`](TextRange.md)
+
+Where `text` sits in the Markdown.
+
+***
+
+### tokensApprox
+
+> **tokensApprox**: `number`
+
+[`tokens_approx`] of `text`.

package/docs/api/type-aliases/Color.md

@@ -0,0 +1,16 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Color
+
+# Type Alias: Color
+
+> **Color** = `string` \| readonly \[`number`\] \| readonly \[`number`, `number`, `number`\] \| readonly \[`number`, `number`, `number`, `number`\]
+
+A colour: `[gray]`, `[r, g, b]` or `[c, m, y, k]` with components from 0 to 1, or `"#rrggbb"`
+/ `"#rgb"` (DeviceRGB).

package/docs/api/type-aliases/Coordinates.md

@@ -0,0 +1,55 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Coordinates
+
+# Type Alias: Coordinates
+
+> **Coordinates** = `object`
+
+ADR 0027 §4's `coordinates` block: top-left points of the displayed box.
+
+## Properties
+
+### box
+
+> **box**: `string`
+
+`"CropBox"`, or `"default"` when the page had no usable box and US Letter was used.
+
+***
+
+### origin
+
+> **origin**: `string`
+
+Always `"top-left"`.
+
+***
+
+### rotate
+
+> **rotate**: `number`
+
+The `/Rotate` applied, in degrees clockwise.
+
+***
+
+### unit
+
+> **unit**: `string`
+
+Always `"pt"`.
+
+***
+
+### userUnit
+
+> **userUnit**: `number`
+
+The `/UserUnit` applied.

package/docs/api/type-aliases/Direction.md

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Direction
+
+# Type Alias: Direction
+
+> **Direction** = `DirectionInit`
+
+Paragraph direction.

package/docs/api/type-aliases/DocumentInfo.md

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / DocumentInfo
+
+# Type Alias: DocumentInfo
+
+> **DocumentInfo** = `DocumentInfoJs`
+
+The Info dictionary's text entries (document text).

package/docs/api/type-aliases/DropReason.md

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / DropReason
+
+# Type Alias: DropReason
+
+> **DropReason** = `"invisible"` \| `"off-page"` \| `"tiny"` \| `"clipped"` \| `"low-contrast"` \| `"covered"` \| `"artifact"` \| `"running-header"` \| `"running-footer"` \| `"page-number"`
+
+Why text was left out.

package/docs/api/type-aliases/Dropped.md

@@ -0,0 +1,59 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Dropped
+
+# Type Alias: Dropped
+
+> **Dropped** = `object`
+
+Text left out of the output ([ADR 0030] §4). It records a count, never the text, so a log of
+the output can't leak what was hidden.
+
+[ADR 0030]: https://github.com/laudebugs/laminapdf/blob/main/docs/decisions/0030-extraction-output-and-model-plugins.md
+
+## Properties
+
+### bbox
+
+> **bbox**: \[`number`, `number`, `number`, `number`\]
+
+Where it was, in page space.
+
+***
+
+### chars
+
+> **chars**: `number`
+
+How many characters were left out.
+
+***
+
+### page
+
+> **page**: `number`
+
+The page index.
+
+***
+
+### reason
+
+> **reason**: [`DropReason`](DropReason.md)
+
+Why it was left out (the first reason when there are several).
+
+***
+
+### spans?
+
+> `optional` **spans?**: [`Span`](Span.md)[]
+
+The run itself, only when [`DropOptions::keep_spans`](crate::DropOptions::keep_spans)
+asked for it.

package/docs/api/type-aliases/Edited.md

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Edited
+
+# Type Alias: Edited
+
+> **Edited** = `EditedJs`
+
+The pages an edit touched.

package/docs/api/type-aliases/ErrorCode.md

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ErrorCode
+
+# Type Alias: ErrorCode
+
+> **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"` \| `"invalid-spans"` \| `"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"` \| `"tag-element-not-open"` \| `"tag-element-unclosed"` \| `"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"` \| `"flow-content-too-large"` \| `"flow-layout-unstable"` \| `"render-too-large"` \| `"render-failed"` \| `"render-backend-unavailable"` \| `"model-failed"` \| `"model-result-unexpected"` \| `"model-needs-host"` \| `"cancelled"` \| `"job-finished"` \| `"document-changed"` \| `"revision-index-out-of-range"` \| `"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 error code (ADR 0026 §3; `fixtures/codes.json`).

package/docs/api/type-aliases/ErrorKind.md

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ErrorKind
+
+# Type Alias: ErrorKind
+
+> **ErrorKind** = `"input"` \| `"io"` \| `"unsupported"` \| `"limit"` \| `"security"` \| `"usage"` \| `"state"` \| `"cancelled"` \| `"internal"`
+
+The nine kinds of ADR 0026 §2: what the caller can do about an error.

package/docs/api/type-aliases/ExtractFormat.md

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ExtractFormat
+
+# Type Alias: ExtractFormat
+
+> **ExtractFormat** = `"markdown"` \| `"json"` \| `"text"` \| `"chunks"`
+
+What `WasmDocument.extract` returns.

package/docs/api/type-aliases/ExtractJobOptions.md

@@ -0,0 +1,31 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ExtractJobOptions
+
+# Type Alias: ExtractJobOptions\<F\>
+
+> **ExtractJobOptions**\<`F`\> = [`ExtractOptions`](../interfaces/ExtractOptions.md)\<`F`\> & `object`
+
+Options for [Document.extractJob](../classes/Document.md#extractjob): [ExtractOptions](../interfaces/ExtractOptions.md) and the models the host runs.
+
+## Type Parameters
+
+### F
+
+`F` *extends* [`ExtractFormat`](ExtractFormat.md) = [`ExtractFormat`](ExtractFormat.md)
+
+## Type Declaration
+
+### models?
+
+> `readonly` `optional` **models?**: [`Models`](../interfaces/Models.md)
+
+The models the host runs, each named as the output's `generator.models` records it: a
+`layout` model is asked for every page's regions, an `ocr` engine for the pages with no
+visible text. `dpi` (150 by default) is the resolution pages are asked for at.

package/docs/api/type-aliases/ExtractStep.md

@@ -0,0 +1,61 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ExtractStep
+
+# Type Alias: ExtractStep\<F\>
+
+> **ExtractStep**\<`F`\> = \{ `done`: `number`; `phase`: `string`; `request?`: [`ModelRequest`](../interfaces/ModelRequest.md); `state`: `"progress"`; `total?`: `number`; \} \| \{ `output`: [`ExtractResult`](../interfaces/ExtractResult.md)\[`F`\]; `state`: `"done"`; \}
+
+What [ExtractJob.step](../classes/ExtractJob.md#step) returns.
+
+## Type Parameters
+
+### F
+
+`F` *extends* [`ExtractFormat`](ExtractFormat.md)
+
+## Union Members
+
+### Type Literal
+
+\{ `done`: `number`; `phase`: `string`; `request?`: [`ModelRequest`](../interfaces/ModelRequest.md); `state`: `"progress"`; `total?`: `number`; \}
+
+#### done
+
+> `readonly` **done**: `number`
+
+Pages done.
+
+#### phase
+
+> `readonly` **phase**: `string`
+
+`"extract"`, or `"model"` while request is set.
+
+#### request?
+
+> `readonly` `optional` **request?**: [`ModelRequest`](../interfaces/ModelRequest.md)
+
+The model result the job waits for: answer it with [ExtractJob.provide](../classes/ExtractJob.md#provide).
+
+#### state
+
+> `readonly` **state**: `"progress"`
+
+#### total?
+
+> `readonly` `optional` **total?**: `number`
+
+Pages asked for.
+
+***
+
+### Type Literal
+
+\{ `output`: [`ExtractResult`](../interfaces/ExtractResult.md)\[`F`\]; `state`: `"done"`; \}