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

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / DropReason
+
+# Type Alias: DropReason
+
+> **DropReason** = `"invisible"` \| `"off-page"` \| `"tiny"` \| `"clipped"` \| `"low-contrast"` \| `"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.3"
+---
+
+[**@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.3"
+---
+
+[**@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.3"
+---
+
+[**@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"` \| `"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 error code (ADR 0026 §3; `fixtures/codes.json`).

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@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.3"
+---
+
+[**@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/ExtractedBlock.md

@@ -0,0 +1,82 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ExtractedBlock
+
+# Type Alias: ExtractedBlock
+
+> **ExtractedBlock** = `object` & (\{ `level`: `number`; `type`: `"heading"`; \} \| \{ `type`: `"paragraph"`; \} \| \{ `depth`: `number`; `marker`: `string`; `type`: `"list-item"`; \} \| \{ `type`: `"caption"`; \} \| \{ `type`: `"footnote"`; \} \| \{ `type`: `"other"`; \} \| \{ `cols`: `number`; `detector`: [`TableDetector`](TableDetector.md); `rows`: `number`; `type`: `"table"`; \})
+
+A block and where its text sits in the Markdown.
+
+## Type Declaration
+
+### bbox
+
+> **bbox**: \[`number`, `number`, `number`, `number`\]
+
+The block's box in page space.
+
+### bboxNorm?
+
+> `optional` **bboxNorm?**: \[`number`, `number`, `number`, `number`\] \| `null`
+
+The box divided by the page's width and height, clamped to [0, 1]; `None` when the
+block lies wholly outside the page.
+
+### cells?
+
+> `optional` **cells?**: [`Cell`](Cell.md)[]
+
+A table's cells, row by row; empty for every other block.
+
+### confidence
+
+> **confidence**: `number`
+
+In [0, 1]: 1 for structure from the tree, lower for structure inferred from layout.
+
+### id
+
+> **id**: `string`
+
+`p<page index>-b<position in the page's reading order>`.
+
+### page
+
+> **page**: `number`
+
+The page index.
+
+### spans
+
+> **spans**: [`Span`](Span.md)[]
+
+The runs of text, in reading order.
+
+### structPath
+
+> **structPath**: `string`[]
+
+The structure types from the root down to the block; empty when untagged.
+
+### structRef?
+
+> `optional` **structRef?**: [`StructRef`](StructRef.md) \| `null`
+
+The structure element the block comes from, when it comes from one.
+
+### text
+
+> **text**: `string`
+
+The visible text, lines joined by a space after the text fixes (ADR 0030 §5).
+
+### textRange
+
+> **textRange**: [`TextRange`](TextRange.md)

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

@@ -0,0 +1,65 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ExtractedPage
+
+# Type Alias: ExtractedPage
+
+> **ExtractedPage** = `object`
+
+One extracted page ([ADR 0027] §4).
+
+[ADR 0027]: https://github.com/laudebugs/laminapdf/blob/main/docs/decisions/0027-coordinates-units-and-page-indexing.md
+
+## Properties
+
+### coordinates
+
+> **coordinates**: [`Coordinates`](Coordinates.md)
+
+The frame the boxes are in.
+
+***
+
+### height
+
+> **height**: `number`
+
+The displayed height in points.
+
+***
+
+### index
+
+> **index**: `number`
+
+0-based.
+
+***
+
+### label?
+
+> `optional` **label?**: `string` \| `null`
+
+The page label (`/PageLabels`), when there is one.
+
+***
+
+### number
+
+> **number**: `number`
+
+1-based, as people count.
+
+***
+
+### width
+
+> **width**: `number`
+
+The displayed width in points (after `/Rotate` and `/UserUnit`).

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

@@ -0,0 +1,48 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ExtractedSource
+
+# Type Alias: ExtractedSource
+
+> **ExtractedSource** = `object`
+
+The input, as ADR 0030 §1's `source` describes it.
+
+## Properties
+
+### pageCount
+
+> **pageCount**: `number`
+
+The document's page count.
+
+***
+
+### sha256?
+
+> `optional` **sha256?**: `string` \| `null`
+
+The input's SHA-256 in hex: filled by the caller that holds the bytes (the façade), since
+a windowed source can't be hashed without reading it whole.
+
+***
+
+### structSource
+
+> **structSource**: [`StructSource`](StructSource.md)
+
+Where the reading order came from.
+
+***
+
+### tagged
+
+> **tagged**: `boolean`
+
+Whether the catalog's `/MarkInfo` says `/Marked true`.

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

@@ -0,0 +1,22 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Extraction
+
+# Type Alias: Extraction
+
+> **Extraction** = `Omit`\<`ExtractionJson`, `"warnings"`\> & `object`
+
+The `laminapdf.extract/1` document: the schema's type, with the file's warnings as the
+[LaminaPdfWarning](LaminaPdfWarning.md)s they are (the schema leaves their shape to ADR 0026's).
+
+## Type Declaration
+
+### warnings
+
+> **warnings**: [`LaminaPdfWarning`](LaminaPdfWarning.md)[]

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / FillRule
+
+# Type Alias: FillRule
+
+> **FillRule** = *typeof* `FILL_RULES`\[`number`\]
+
+How a filled or clipped path decides what is inside.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Fit
+
+# Type Alias: Fit
+
+> **Fit** = `FitInit`
+
+How a destination shows its page.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Flags
+
+# Type Alias: Flags
+
+> **Flags** = [`DropReason`](DropReason.md)[]
+
+Why a run would be hidden from a reader; empty for visible text.

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

@@ -0,0 +1,41 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Generator
+
+# Type Alias: Generator
+
+> **Generator** = `object`
+
+Who made the extraction (ADR 0030 §1's `generator`).
+
+## Properties
+
+### mode
+
+> **mode**: `string`
+
+`"rules"`, or `"rules+models"` once model plug-ins exist.
+
+***
+
+### models
+
+> **models**: `unknown`[]
+
+***
+
+### name
+
+> **name**: `string`
+
+***
+
+### version
+
+> **version**: `string`

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / GlyphQuad
+
+# Type Alias: GlyphQuad
+
+> **GlyphQuad** = readonly \[[`QuadPoint`](../interfaces/QuadPoint.md), [`QuadPoint`](../interfaces/QuadPoint.md), [`QuadPoint`](../interfaces/QuadPoint.md), [`QuadPoint`](../interfaces/QuadPoint.md)\]
+
+A glyph's quad: its four corners, in drawing order (bottom-left, bottom-right, top-right, top-left of the glyph box).

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / InfoPatch
+
+# Type Alias: InfoPatch
+
+> **InfoPatch** = \{ readonly \[K in keyof DocumentInfo\]?: string \| null \}
+
+An Info patch: a string sets the entry, `null` removes it, a missing key leaves it alone.

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

@@ -0,0 +1,16 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / LaminaPdfWarning
+
+# Type Alias: LaminaPdfWarning
+
+> **LaminaPdfWarning** = `Omit`\<[`Diagnostic`](../interfaces/Diagnostic.md)\<[`WarningCode`](WarningCode.md)\>, `"didYouMean"`\>
+
+A warning: something Lamina PDF repaired or skipped (ADR 0003, ADR 0026 §1). The §1 object without
+`didYouMean`; document text appears only in `data`.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / LimitName
+
+# Type Alias: LimitName
+
+> **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"`
+
+The names of the `Limits` (ADR 0003 §3), as `data.limit` of `limit-exceeded`.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Limits
+
+# Type Alias: Limits
+
+> **Limits** = `LimitsInit`
+
+`Limits` (ADR 0003 §3); each one left out keeps its default.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / LineBox
+
+# Type Alias: LineBox
+
+> **LineBox** = `LineBoxJs`
+
+A line of a text box.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / LineCap
+
+# Type Alias: LineCap
+
+> **LineCap** = *typeof* `LINE_CAPS`\[`number`\]
+
+How open line ends are drawn.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / LineJoin
+
+# Type Alias: LineJoin
+
+> **LineJoin** = *typeof* `LINE_JOINS`\[`number`\]
+
+How corners are drawn.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / LinkTarget
+
+# Type Alias: LinkTarget
+
+> **LinkTarget** = `LinkTargetInit`
+
+Where a link or outline item goes.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Metadata
+
+# Type Alias: Metadata
+
+> **Metadata** = `MetadataInit`
+
+The document's metadata (Info and XMP).

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Op
+
+# Type Alias: Op
+
+> **Op** = `OpJs`
+
+An edit (ADR 0006 §6: `{ op: "setInfo" | "rotatePage", args }`), as in `fixtures/ops/v1`.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / OutlineEntry
+
+# Type Alias: OutlineEntry
+
+> **OutlineEntry** = `OutlineEntryInit`
+
+An outline (bookmarks) item with its children.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Overflow
+
+# Type Alias: Overflow
+
+> **Overflow** = `OverflowInit`
+
+What happens to text that doesn't fit a text box.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / PageInfo
+
+# Type Alias: PageInfo
+
+> **PageInfo** = `PageInfoJs`
+
+A page's facts: index, ID, displayed size in points, rotation, label.