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

package/docs/api/classes/PageRef.md

@@ -0,0 +1,253 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / PageRef
+
+# Class: PageRef
+
+A page of a [Document](Document.md), held by its ID: moving pages doesn't retarget it (ADR 0028 F2).
+Freed with its document; every call after that throws `disposed`.
+
+## Extends
+
+- `Handle`\<`BaseGlue`\>
+
+## Accessors
+
+### id
+
+#### Get Signature
+
+> **get** **id**(): `string`
+
+The page's stable ID (`p12.0`).
+
+##### Returns
+
+`string`
+
+***
+
+### index
+
+#### Get Signature
+
+> **get** **index**(): `number`
+
+The page's current 0-based index.
+
+##### Throws
+
+[LaminaPdfError](LaminaPdfError.md) `unknown-page` when it is gone.
+
+##### Returns
+
+`number`
+
+***
+
+### info
+
+#### Get Signature
+
+> **get** **info**(): `PageInfoJs`
+
+The page's facts now.
+
+##### Throws
+
+[LaminaPdfError](LaminaPdfError.md) `unknown-page` when it is gone.
+
+##### Returns
+
+`PageInfoJs`
+
+***
+
+### 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`
+
+***
+
+### 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`
+
+***
+
+### release()
+
+> `protected` **release**(): `void`
+
+Frees the WebAssembly side; called at most once, and only while [owned](#owned).
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+`Handle.release`
+
+***
+
+### text()
+
+> **text**(`options?`): [`PageText`](PageText.md)
+
+The page's text: lines in reading order, runs, and every glyph's quad in page space.
+Needs a document opened while the extract or text module was loaded.
+
+#### Parameters
+
+##### options?
+
+[`PageTextOptions`](../interfaces/PageTextOptions.md)
+
+`skipInvisible` leaves out invisible text (OCR layers).
+
+#### Returns
+
+[`PageText`](PageText.md)
+
+#### Example
+
+```ts
+await init({ extract: true });
+const doc = Document.open(bytes);
+const text = doc.page(0).text().text();
+```
+
+#### Throws
+
+[LaminaPdfError](LaminaPdfError.md) `extract-module-not-loaded` for a document opened in the base
+  module; `unknown-page`; reading errors (`data-pending` for a range document: use `ensure`).

package/docs/api/classes/PageText.md

@@ -0,0 +1,129 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / PageText
+
+# Class: PageText
+
+A page's extracted text: lines in reading order, and runs with their glyphs' quads.
+
+## Properties
+
+### glyphCount
+
+> `readonly` **glyphCount**: `number`
+
+The number of glyphs.
+
+## Accessors
+
+### buffers
+
+#### Get Signature
+
+> **get** **buffers**(): `object`
+
+The arrays as the WASM returned them: `quads` (8 numbers per glyph), `glyphText` and
+`glyphOffsets` (glyph i is `glyphText.slice(glyphOffsets[i], glyphOffsets[i + 1])`). Post
+`quads.buffer` and `glyphOffsets.buffer` as transferables to move them to another thread;
+that detaches them here, and this PageText's `glyph()` and `glyphs()` then throw (`lines`
+and `runs` keep working). They are this PageText's own arrays, not copies: writing to them
+changes what `glyph()` returns.
+
+##### Returns
+
+`object`
+
+###### glyphOffsets
+
+> `readonly` **glyphOffsets**: `Uint32Array`
+
+###### glyphText
+
+> `readonly` **glyphText**: `string`
+
+###### quads
+
+> `readonly` **quads**: `Float32Array`
+
+***
+
+### lines
+
+#### Get Signature
+
+> **get** **lines**(): readonly `string`[]
+
+The text by line (runs on one baseline joined, trimmed), in content order.
+
+##### Returns
+
+readonly `string`[]
+
+***
+
+### runs
+
+#### Get Signature
+
+> **get** **runs**(): readonly [`PageTextRun`](PageTextRun.md)[]
+
+The runs, in content order (made on first use).
+
+##### Returns
+
+readonly [`PageTextRun`](PageTextRun.md)[]
+
+***
+
+### unmapped
+
+#### Get Signature
+
+> **get** **unmapped**(): `number`
+
+Glyphs whose Unicode is unknown (shown as U+FFFD).
+
+##### Returns
+
+`number`
+
+## Methods
+
+### glyph()
+
+> **glyph**(`i`): [`TextGlyph`](../interfaces/TextGlyph.md)
+
+Glyph `i`'s text and quad.
+
+#### Parameters
+
+##### i
+
+`number`
+
+#### Returns
+
+[`TextGlyph`](../interfaces/TextGlyph.md)
+
+#### Throws
+
+`RangeError` for an index outside `0 … glyphCount - 1`; `TypeError` once
+  [PageText.buffers](#buffers)' arrays were transferred to another thread.
+
+***
+
+### text()
+
+> **text**(): `string`
+
+The page's text: its lines joined with `\n`.
+
+#### Returns
+
+`string`

package/docs/api/classes/PageTextRun.md

@@ -0,0 +1,167 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / PageTextRun
+
+# Class: PageTextRun
+
+A run: glyphs of one font, size, direction and marked content on one baseline, in logical order.
+
+## Accessors
+
+### actualText
+
+#### Get Signature
+
+> **get** **actualText**(): `boolean`
+
+The text comes from an `/ActualText` span.
+
+##### Returns
+
+`boolean`
+
+***
+
+### bounds
+
+#### Get Signature
+
+> **get** **bounds**(): `object`
+
+The bounds of its glyph quads in page space: `{ x, y, width, height }`.
+
+##### Returns
+
+`object`
+
+###### height
+
+> `readonly` **height**: `number`
+
+###### width
+
+> `readonly` **width**: `number`
+
+###### x
+
+> `readonly` **x**: `number`
+
+###### y
+
+> `readonly` **y**: `number`
+
+***
+
+### font
+
+#### Get Signature
+
+> **get** **font**(): `string`
+
+The font's `/BaseFont` (document text).
+
+##### Returns
+
+`string`
+
+***
+
+### glyphRange
+
+#### Get Signature
+
+> **get** **glyphRange**(): readonly \[`number`, `number`\]
+
+The `[start, end)` range of its glyphs in the page's glyph arrays ([PageText.buffers](PageText.md#buffers)).
+
+##### Returns
+
+readonly \[`number`, `number`\]
+
+***
+
+### invisible
+
+#### Get Signature
+
+> **get** **invisible**(): `boolean`
+
+Drawn invisibly (`Tr` 3 or 7: an OCR layer, hidden text).
+
+##### Returns
+
+`boolean`
+
+***
+
+### mcid
+
+#### Get Signature
+
+> **get** **mcid**(): `number` \| `undefined`
+
+The marked-content ID the run is in, if any (structure tree links).
+
+##### Returns
+
+`number` \| `undefined`
+
+***
+
+### size
+
+#### Get Signature
+
+> **get** **size**(): `number`
+
+Font size, the text matrix applied.
+
+##### Returns
+
+`number`
+
+***
+
+### text
+
+#### Get Signature
+
+> **get** **text**(): `string`
+
+The run's text in logical order (document text).
+
+##### Returns
+
+`string`
+
+***
+
+### vertical
+
+#### Get Signature
+
+> **get** **vertical**(): `boolean`
+
+Vertical writing.
+
+##### Returns
+
+`boolean`
+
+## Methods
+
+### glyphs()
+
+> **glyphs**(): [`TextGlyph`](../interfaces/TextGlyph.md)[]
+
+Its glyphs, with their quads (built on each call).
+
+#### Returns
+
+[`TextGlyph`](../interfaces/TextGlyph.md)[]

package/docs/api/classes/PendingPath.md

@@ -0,0 +1,97 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / PendingPath
+
+# Class: PendingPath
+
+A path waiting to be painted: fill it, stroke it, both, or clip to it.
+
+## Methods
+
+### clip()
+
+> **clip**(`rule?`): [`Surface`](Surface.md)
+
+Clips what is drawn next to the path, until the next `restore`.
+
+#### Parameters
+
+##### rule?
+
+`"nonZero"` \| `"evenOdd"` = `"nonZero"`
+
+#### Returns
+
+[`Surface`](Surface.md)
+
+the surface.
+
+***
+
+### fill()
+
+> **fill**(`rule?`): [`Surface`](Surface.md)
+
+Fills the path with the fill colour.
+
+#### Parameters
+
+##### rule?
+
+`"nonZero"` \| `"evenOdd"` = `"nonZero"`
+
+#### Returns
+
+[`Surface`](Surface.md)
+
+the surface.
+
+***
+
+### fillStroke()
+
+> **fillStroke**(`rule?`, `style?`): [`Surface`](Surface.md)
+
+Fills, then strokes the path.
+
+#### Parameters
+
+##### rule?
+
+`"nonZero"` \| `"evenOdd"` = `"nonZero"`
+
+##### style?
+
+[`StrokeStyle`](../interfaces/StrokeStyle.md) = `{}`
+
+#### Returns
+
+[`Surface`](Surface.md)
+
+the surface.
+
+***
+
+### stroke()
+
+> **stroke**(`style?`): [`Surface`](Surface.md)
+
+Strokes the path with the stroke colour and `style`.
+
+#### Parameters
+
+##### style?
+
+[`StrokeStyle`](../interfaces/StrokeStyle.md) = `{}`
+
+#### Returns
+
+[`Surface`](Surface.md)
+
+the surface.