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

package/docs/api/interfaces/TagSpec.md

@@ -0,0 +1,69 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TagSpec
+
+# Interface: TagSpec
+
+A structure element with attributes; `type` may be a custom name when `role` is given.
+
+## Properties
+
+### actualText?
+
+> `readonly` `optional` **actualText?**: `string`
+
+`/ActualText`: the exact text the content stands for.
+
+***
+
+### alt?
+
+> `readonly` `optional` **alt?**: `string`
+
+`/Alt`: alternate text (a `Figure` needs it).
+
+***
+
+### expansion?
+
+> `readonly` `optional` **expansion?**: `string`
+
+`/E`: the expansion of an abbreviation.
+
+***
+
+### lang?
+
+> `readonly` `optional` **lang?**: `string`
+
+`/Lang`: the element's language (BCP 47).
+
+***
+
+### role?
+
+> `readonly` `optional` **role?**: `"Document"` \| `"Part"` \| `"Sect"` \| `"H1"` \| `"H2"` \| `"H3"` \| `"H4"` \| `"H5"` \| `"H6"` \| `"P"` \| `"L"` \| `"LI"` \| `"Lbl"` \| `"LBody"` \| `"Table"` \| `"TR"` \| `"TH"` \| `"TD"` \| `"Figure"` \| `"Caption"` \| `"Link"` \| `"Span"` \| `"Quote"` \| `"Note"` \| `"Code"`
+
+The standard type a custom `type` stands for.
+
+***
+
+### scope?
+
+> `readonly` `optional` **scope?**: `"row"` \| `"column"` \| `"both"`
+
+`/Scope` of a `TH`.
+
+***
+
+### type
+
+> `readonly` **type**: `"Document"` \| `"Part"` \| `"Sect"` \| `"H1"` \| `"H2"` \| `"H3"` \| `"H4"` \| `"H5"` \| `"H6"` \| `"P"` \| `"L"` \| `"LI"` \| `"Lbl"` \| `"LBody"` \| `"Table"` \| `"TR"` \| `"TH"` \| `"TD"` \| `"Figure"` \| `"Caption"` \| `"Link"` \| `"Span"` \| `"Quote"` \| `"Note"` \| `"Code"` \| `string` & `object`
+
+A standard type, or a custom name written with a `RoleMap` entry to `role`.

package/docs/api/interfaces/TextBoxOptions.md

@@ -0,0 +1,93 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TextBoxOptions
+
+# Interface: TextBoxOptions
+
+Options of [Surface.textBox](../classes/Surface.md#textbox).
+
+## Properties
+
+### align?
+
+> `readonly` `optional` **align?**: `AlignInit`
+
+Line alignment (default `start`).
+
+***
+
+### box
+
+> `readonly` **box**: [`Rect`](../type-aliases/Rect.md)
+
+The box the lines are broken into.
+
+***
+
+### direction?
+
+> `readonly` `optional` **direction?**: `DirectionInit`
+
+Paragraph direction.
+
+***
+
+### features?
+
+> `readonly` `optional` **features?**: readonly `string`[]
+
+OpenType features.
+
+***
+
+### font
+
+> `readonly` **font**: [`Font`](../classes/Font.md)
+
+The font (needs the text module).
+
+***
+
+### language?
+
+> `readonly` `optional` **language?**: `string`
+
+Language (BCP 47).
+
+***
+
+### lineHeight?
+
+> `readonly` `optional` **lineHeight?**: `number`
+
+Line height as a factor of the size (default 1.2).
+
+***
+
+### overflow?
+
+> `readonly` `optional` **overflow?**: `OverflowInit`
+
+What happens to text that doesn't fit (default `clip`; `error` throws `text-overflow`).
+
+***
+
+### size
+
+> `readonly` **size**: `number`
+
+Size in points.
+
+***
+
+### tag?
+
+> `readonly` `optional` **tag?**: [`Tag`](../type-aliases/Tag.md)
+
+The structure element the box is (as drawing it inside [Surface.tag](../classes/Surface.md#tag)).

package/docs/api/interfaces/TextGlyph.md

@@ -0,0 +1,29 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TextGlyph
+
+# Interface: TextGlyph
+
+One glyph of a run.
+
+## Properties
+
+### quad
+
+> `readonly` **quad**: [`GlyphQuad`](../type-aliases/GlyphQuad.md)
+
+Its quad in page space.
+
+***
+
+### text
+
+> `readonly` **text**: `string`
+
+The glyph's text (document text; U+FFFD when its Unicode is unknown).

package/docs/api/interfaces/TextOptions.md

@@ -0,0 +1,101 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TextOptions
+
+# Interface: TextOptions
+
+Options of [Surface.text](../classes/Surface.md#text).
+
+## Properties
+
+### at
+
+> `readonly` **at**: [`Point`](../type-aliases/Point.md)
+
+Where the first line starts: `x`, and `y` is the baseline (ADR 0027 §5).
+
+***
+
+### direction?
+
+> `readonly` `optional` **direction?**: `DirectionInit`
+
+Paragraph direction (default: from the first strong character).
+
+***
+
+### features?
+
+> `readonly` `optional` **features?**: readonly `string`[]
+
+OpenType features (`liga=0`, `smcp`).
+
+***
+
+### fill?
+
+> `readonly` `optional` **fill?**: [`Color`](../type-aliases/Color.md)
+
+Fill colour.
+
+***
+
+### font
+
+> `readonly` **font**: [`Font`](../classes/Font.md)
+
+The font (needs the text module).
+
+***
+
+### language?
+
+> `readonly` `optional` **language?**: `string`
+
+Language (BCP 47).
+
+***
+
+### link?
+
+> `readonly` `optional` **link?**: `object`
+
+A link over the run.
+
+#### contents?
+
+> `readonly` `optional` **contents?**: `string`
+
+#### target
+
+> `readonly` **target**: `LinkTargetInit`
+
+***
+
+### renderMode?
+
+> `readonly` `optional` **renderMode?**: `RenderModeInit`
+
+Rendering mode (`invisible` for an OCR layer).
+
+***
+
+### size
+
+> `readonly` **size**: `number`
+
+Size in points.
+
+***
+
+### tag?
+
+> `readonly` `optional` **tag?**: [`Tag`](../type-aliases/Tag.md)
+
+The structure element the run is (as drawing it inside [Surface.tag](../classes/Surface.md#tag)).

package/docs/api/interfaces/WasmMemory.md

@@ -0,0 +1,37 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@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.3"
+---
+
+[**@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.3"
+---
+
+[**@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.3"
+---
+
+[**@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).

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

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