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

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ReadingOrder
+
+# Type Alias: ReadingOrder
+
+> **ReadingOrder** = `"auto"` \| `"tagged"` \| `"layout"` \| `"content-stream"`
+
+Where the reading order comes from.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Rect
+
+# Type Alias: Rect
+
+> **Rect** = readonly \[`x`: `number`, `y`: `number`, `width`: `number`, `height`: `number`\]
+
+A rectangle in page space: left, top, width, height.

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

@@ -0,0 +1,31 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Region
+
+# Type Alias: Region
+
+> **Region** = `object`
+
+A chunk's area on one page.
+
+## Properties
+
+### bbox
+
+> **bbox**: \[`number`, `number`, `number`, `number`\]
+
+The union of the chunk's blocks' boxes on that page, in page space.
+
+***
+
+### page
+
+> **page**: `number`
+
+The page index.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / RegionLabel
+
+# Type Alias: RegionLabel
+
+> **RegionLabel** = `"text"` \| `"title"` \| `"section-header"` \| `"list-item"` \| `"table"` \| `"picture"` \| `"caption"` \| `"footnote"` \| `"formula"` \| `"page-header"` \| `"page-footer"` \| `"other"`
+
+A region's kind.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / RenderMode
+
+# Type Alias: RenderMode
+
+> **RenderMode** = `RenderModeInit`
+
+Text rendering mode.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Rotation
+
+# Type Alias: Rotation
+
+> **Rotation** = `0` \| `90` \| `180` \| `270`
+
+The rotations `/Rotate` allows.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / SaveOptions
+
+# Type Alias: SaveOptions
+
+> **SaveOptions** = `SaveOptionsInit`
+
+Options for saving.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / SaveReport
+
+# Type Alias: SaveReport
+
+> **SaveReport** = `SaveReportJs`
+
+What a save wrote.

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

@@ -0,0 +1,74 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Span
+
+# Type Alias: Span
+
+> **Span** = `object`
+
+One run of text in a block or a dropped entry.
+
+## Properties
+
+### baseline
+
+> **baseline**: `number`
+
+The baseline's y in page space (ADR 0027 §5).
+
+***
+
+### bbox
+
+> **bbox**: \[`number`, `number`, `number`, `number`\]
+
+Its box in page space.
+
+***
+
+### flags
+
+> **flags**: [`Flags`](Flags.md)
+
+Why the run would be hidden; empty for visible text.
+
+***
+
+### font
+
+> **font**: `string`
+
+The font's `/BaseFont`.
+
+***
+
+### ocr?
+
+> `optional` **ocr?**: `number` \| `null`
+
+The OCR engine's confidence, 0 to 1, when an engine read this text from the page image
+rather than the file's text layer ([ADR 0030] §6); absent for the text layer's runs.
+
+[ADR 0030]: https://github.com/laudebugs/laminapdf/blob/main/docs/decisions/0030-extraction-output-and-model-plugins.md
+
+***
+
+### size
+
+> **size**: `number`
+
+The glyph size in points.
+
+***
+
+### text
+
+> **text**: `string`
+
+The run's text.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / SplitOn
+
+# Type Alias: SplitOn
+
+> **SplitOn** = `"headings"` \| `"blocks"` \| `"pages"`
+
+Where chunks may start.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Standard14
+
+# Type Alias: Standard14
+
+> **Standard14** = `"Times-Roman"` \| `"Times-Bold"` \| `"Times-Italic"` \| `"Times-BoldItalic"` \| `"Helvetica"` \| `"Helvetica-Bold"` \| `"Helvetica-Oblique"` \| `"Helvetica-BoldOblique"` \| `"Courier"` \| `"Courier-Bold"` \| `"Courier-Oblique"` \| `"Courier-BoldOblique"` \| `"Symbol"` \| `"ZapfDingbats"`
+
+The standard 14 fonts, by PostScript name: no bytes needed, not embedded, Latin only, unshaped.

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

@@ -0,0 +1,41 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / StructRef
+
+# Type Alias: StructRef
+
+> **StructRef** = `object`
+
+A structure element ([ADR 0030] §1's `structRef`).
+
+[ADR 0030]: https://github.com/laudebugs/laminapdf/blob/main/docs/decisions/0030-extraction-output-and-model-plugins.md
+
+## Properties
+
+### gen
+
+> **gen**: `number`
+
+Its generation.
+
+***
+
+### mcids
+
+> **mcids**: `number`[]
+
+The marked-content identifiers it covers on the page.
+
+***
+
+### obj
+
+> **obj**: `number`
+
+The element's object number.

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

@@ -0,0 +1,17 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / StructSource
+
+# Type Alias: StructSource
+
+> **StructSource** = `"tagged"` \| `"xycut"` \| `"content"`
+
+Where the reading order came from ([ADR 0030] §2).
+
+[ADR 0030]: https://github.com/laudebugs/laminapdf/blob/main/docs/decisions/0030-extraction-output-and-model-plugins.md

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / StructureKid
+
+# Type Alias: StructureKid
+
+> **StructureKid** = `StructureKidJs`
+
+A kid of a [StructureNode](StructureNode.md): an element, or marked content `mcid` on page `page`.

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

@@ -0,0 +1,16 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / StructureNode
+
+# Type Alias: StructureNode
+
+> **StructureNode** = `StructureNodeJs`
+
+An element of a tagged document's structure tree: its standard type (`H1`, `P`, `LI`,
+`Figure` …), alternate text, language, actual text, and kids in reading order (document text).

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TableDetector
+
+# Type Alias: TableDetector
+
+> **TableDetector** = `"lattice"` \| `"stream"` \| `"tagged"`
+
+What found a table.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TableMode
+
+# Type Alias: TableMode
+
+> **TableMode** = `"off"` \| `"lattice"` \| `"lattice-and-stream"`
+
+Which table detectors run.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TableScope
+
+# Type Alias: TableScope
+
+> **TableScope** = *typeof* `TABLE_SCOPES`\[`number`\]
+
+Which header cells a `TH` heads (`/Scope`).

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Tag
+
+# Type Alias: Tag
+
+> **Tag** = [`TagName`](TagName.md) \| [`TagSpec`](../interfaces/TagSpec.md)
+
+A structure element: a type, or a type with attributes.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TagName
+
+# Type Alias: TagName
+
+> **TagName** = *typeof* [`TAG_NAMES`](../variables/TAG_NAMES.md)\[`number`\]
+
+A standard structure type (ISO 32000-1 §14.8.4).

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Target
+
+# Type Alias: Target
+
+> **Target** = `TargetJs`
+
+A place in a document: a 0-based page index and how to show it.

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

@@ -0,0 +1,18 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TargetView
+
+# Type Alias: TargetView
+
+> **TargetView** = `TargetViewJs`
+
+How a [Target](Target.md) shows its page, in page space (points from the displayed page's top-left,
+y down), by `kind`: `"at"` puts (`x`, `y`) at the viewport's top-left at `zoom`, `"fit"` fits
+the page, `"fit-width"` its width from `y`, `"fit-height"` its height from `x`, `"fit-rect"` the
+rectangle. A coordinate the file leaves unset is absent: keep the current one.

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

@@ -0,0 +1,72 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TextLayer
+
+# Type Alias: TextLayer
+
+> **TextLayer** = `object`
+
+What a page's text layer is: whether its extracted text is the page's text, or the page
+needs OCR. The measures let a pipeline apply its own cut-offs.
+
+## Properties
+
+### chars
+
+> **chars**: `number`
+
+Visible characters (spaces left out) in runs that aren't invisible, off the page or tiny.
+
+***
+
+### images
+
+> **images**: `number`
+
+How many images the page draws, in its forms too.
+
+***
+
+### imageShare
+
+> **imageShare**: `number`
+
+The share of the page the images cover, measured on a 32 × 32 grid.
+
+***
+
+### invisibleChars
+
+> **invisibleChars**: `number`
+
+Characters drawn invisibly (text rendering mode 3 or 7), such as an OCR layer.
+
+***
+
+### paths
+
+> **paths**: `number`
+
+How many paths the page paints (fills and strokes).
+
+***
+
+### status
+
+> **status**: [`TextLayerStatus`](TextLayerStatus.md)
+
+The verdict.
+
+***
+
+### unmappedShare
+
+> **unmappedShare**: `number`
+
+The share of the visible runs' glyphs that map to no Unicode; 0 with no visible glyphs.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TextLayerStatus
+
+# Type Alias: TextLayerStatus
+
+> **TextLayerStatus** = `"empty"` \| `"ocr-layer"` \| `"needs-ocr"` \| `"mixed"` \| `"native"`
+
+A page's text-layer status, the first that applies.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TextLayout
+
+# Type Alias: TextLayout
+
+> **TextLayout** = `TextLayoutJs`
+
+How a text box laid its text out.

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

@@ -0,0 +1,33 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TextRange
+
+# Type Alias: TextRange
+
+> **TextRange** = `object`
+
+Where a piece of text sits in a rendering, in Unicode scalar values (`char`s), `start`
+inclusive and `end` exclusive. Code points, not bytes or UTF-16 units, so Python slices a
+rendering with them as they are; [`Rendered::slice`] does it in Rust.
+
+## Properties
+
+### end
+
+> **end**: `number`
+
+One past the last character.
+
+***
+
+### start
+
+> **start**: `number`
+
+The first character.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TextRunInfo
+
+# Type Alias: TextRunInfo
+
+> **TextRunInfo** = `TextRunJs`
+
+What a text run measures.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Transform
+
+# Type Alias: Transform
+
+> **Transform** = readonly \[`a`: `number`, `b`: `number`, `c`: `number`, `d`: `number`, `e`: `number`, `f`: `number`\]
+
+A transformation matrix `[a, b, c, d, e, f]` (ISO 32000-2 §8.3.4), in page space.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / UndoOutcome
+
+# Type Alias: UndoOutcome
+
+> **UndoOutcome** = `UndoOutcomeJs`
+
+How an undo or redo went.

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

@@ -0,0 +1,15 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ViewerPreferences
+
+# Type Alias: ViewerPreferences
+
+> **ViewerPreferences** = `ViewerPreferencesInit`
+
+How viewers present the document.