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

package/docs/api/interfaces/HttpRangeOptions.md

@@ -0,0 +1,78 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / HttpRangeOptions
+
+# Interface: HttpRangeOptions
+
+Options for [httpRangeSource](../functions/httpRangeSource.md).
+
+## Properties
+
+### blockSize?
+
+> `readonly` `optional` **blockSize?**: `number`
+
+Fetches are aligned to blocks of this many bytes (default 16 384: each object a reader
+checks costs one block, so larger blocks fetch more of the file).
+
+***
+
+### credentials?
+
+> `readonly` `optional` **credentials?**: `RequestCredentials`
+
+`fetch`'s credentials mode.
+
+***
+
+### fetch?
+
+> `readonly` `optional` **fetch?**: (`input`, `init?`) => `Promise`\<`Response`\>
+
+The `fetch` to use (default: the global one).
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)
+
+#### Parameters
+
+##### input
+
+`URL` \| `RequestInfo`
+
+##### init?
+
+`RequestInit`
+
+#### Returns
+
+`Promise`\<`Response`\>
+
+***
+
+### headers?
+
+> `readonly` `optional` **headers?**: `Readonly`\<`Record`\<`string`, `string`\>\>
+
+Extra request headers (authorisation, …). `Range` and `If-Range` are Lamina PDF's.
+
+***
+
+### signal?
+
+> `readonly` `optional` **signal?**: `AbortSignal`
+
+Aborts the probe; reads take their own signal.
+
+***
+
+### tail?
+
+> `readonly` `optional` **tail?**: `number`
+
+The first request asks for this many bytes at the end of the file (default 65 536).

package/docs/api/interfaces/InitOptions.md

@@ -0,0 +1,40 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / InitOptions
+
+# Interface: InitOptions
+
+Options for [init](../functions/init.md).
+
+## Properties
+
+### extract?
+
+> `readonly` `optional` **extract?**: `boolean` \| [`WasmSource`](../type-aliases/WasmSource.md)
+
+Also load the extract module (reading plus text extraction, about half the text module's
+size): `true` for the default file, or where it comes from. Documents opened afterwards can
+extract text ([PageRef.text](../classes/PageRef.md#text)). Not needed when the text module is loaded.
+
+***
+
+### module?
+
+> `readonly` `optional` **module?**: [`WasmSource`](../type-aliases/WasmSource.md)
+
+The base module (default: the `lamina_pdf_base.wasm` next to the package, per export condition).
+
+***
+
+### text?
+
+> `readonly` `optional` **text?**: `boolean` \| [`WasmSource`](../type-aliases/WasmSource.md)
+
+Also load the text module (fonts and text): `true` for the default file, or where it comes
+from. Without it, only builders created after a later [loadText](../functions/loadText.md) can draw text.

package/docs/api/interfaces/Leak.md

@@ -0,0 +1,21 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Leak
+
+# Interface: Leak
+
+A handle the garbage collector reclaimed without a `free()`.
+
+## Properties
+
+### handle
+
+> `readonly` **handle**: `string`
+
+The handle's class: `Document`, `Builder` or `Image`.

package/docs/api/interfaces/Location.md

@@ -0,0 +1,53 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Location
+
+# Interface: Location
+
+Where a problem is (ADR 0026 §1.1); each field has one meaning, all lamina-made values.
+
+## Properties
+
+### id?
+
+> `readonly` `optional` **id?**: `string`
+
+A LaminaPdfId (`p12.0`).
+
+***
+
+### object?
+
+> `readonly` `optional` **object?**: `number`
+
+Object number of the indirect object the problem is in or at.
+
+***
+
+### offset?
+
+> `readonly` `optional` **offset?**: `number`
+
+Byte offset in the input file.
+
+***
+
+### pageIndex?
+
+> `readonly` `optional` **pageIndex?**: `number`
+
+0-based page index (ADR 0027 §6).
+
+***
+
+### streamOffset?
+
+> `readonly` `optional` **streamOffset?**: `number`
+
+Byte offset in the decoded data of `object`.

package/docs/api/interfaces/OpLog.md

@@ -0,0 +1,25 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / OpLog
+
+# Interface: OpLog
+
+An op log: `{ v: 1, ops }`.
+
+## Properties
+
+### ops
+
+> `readonly` **ops**: readonly `Op`[]
+
+***
+
+### v
+
+> `readonly` **v**: `1`

package/docs/api/interfaces/OpenOptions.md

@@ -0,0 +1,37 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / OpenOptions
+
+# Interface: OpenOptions
+
+Options for [Document.open](../classes/Document.md#open).
+
+## Properties
+
+### limits?
+
+> `readonly` `optional` **limits?**: `LimitsInit`
+
+Resource limits.
+
+***
+
+### password?
+
+> `readonly` `optional` **password?**: `string`
+
+The user or owner password of an encrypted document (normalised to NFKC, ADR 0016 §7).
+
+***
+
+### strict?
+
+> `readonly` `optional` **strict?**: `boolean`
+
+Refuse files that need repair (`strict`).

package/docs/api/interfaces/PageTextOptions.md

@@ -0,0 +1,21 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / PageTextOptions
+
+# Interface: PageTextOptions
+
+Options for [PageRef.text](../classes/PageRef.md#text).
+
+## Properties
+
+### skipInvisible?
+
+> `readonly` `optional` **skipInvisible?**: `boolean`
+
+Leave out text drawn invisibly (rendering modes 3 and 7: OCR layers, hidden text).

package/docs/api/interfaces/PathBuilder.md

@@ -0,0 +1,195 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / PathBuilder
+
+# Interface: PathBuilder
+
+Builds a path in page space; every method returns the builder, so calls chain.
+
+## Methods
+
+### circle()
+
+> **circle**(`center`, `radius`): `PathBuilder`
+
+A circle around `center`.
+
+#### Parameters
+
+##### center
+
+[`Point`](../type-aliases/Point.md)
+
+##### radius
+
+`number`
+
+#### Returns
+
+`PathBuilder`
+
+***
+
+### close()
+
+> **close**(): `PathBuilder`
+
+Closes the subpath.
+
+#### Returns
+
+`PathBuilder`
+
+***
+
+### cubicTo()
+
+> **cubicTo**(`x1`, `y1`, `x2`, `y2`, `x`, `y`): `PathBuilder`
+
+A cubic Bézier curve through two control points to (x, y).
+
+#### Parameters
+
+##### x1
+
+`number`
+
+##### y1
+
+`number`
+
+##### x2
+
+`number`
+
+##### y2
+
+`number`
+
+##### x
+
+`number`
+
+##### y
+
+`number`
+
+#### Returns
+
+`PathBuilder`
+
+***
+
+### ellipse()
+
+> **ellipse**(`rect`): `PathBuilder`
+
+The ellipse inscribed in a rectangle.
+
+#### Parameters
+
+##### rect
+
+[`Rect`](../type-aliases/Rect.md)
+
+#### Returns
+
+`PathBuilder`
+
+***
+
+### lineTo()
+
+> **lineTo**(`x`, `y`): `PathBuilder`
+
+A straight line to (x, y).
+
+#### Parameters
+
+##### x
+
+`number`
+
+##### y
+
+`number`
+
+#### Returns
+
+`PathBuilder`
+
+***
+
+### moveTo()
+
+> **moveTo**(`x`, `y`): `PathBuilder`
+
+Starts a subpath at (x, y).
+
+#### Parameters
+
+##### x
+
+`number`
+
+##### y
+
+`number`
+
+#### Returns
+
+`PathBuilder`
+
+***
+
+### quadTo()
+
+> **quadTo**(`x1`, `y1`, `x`, `y`): `PathBuilder`
+
+A quadratic Bézier curve through one control point to (x, y).
+
+#### Parameters
+
+##### x1
+
+`number`
+
+##### y1
+
+`number`
+
+##### x
+
+`number`
+
+##### y
+
+`number`
+
+#### Returns
+
+`PathBuilder`
+
+***
+
+### rect()
+
+> **rect**(`rect`): `PathBuilder`
+
+A rectangle: left, top, width, height.
+
+#### Parameters
+
+##### rect
+
+[`Rect`](../type-aliases/Rect.md)
+
+#### Returns
+
+`PathBuilder`

package/docs/api/interfaces/QuadPoint.md

@@ -0,0 +1,25 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / QuadPoint
+
+# Interface: QuadPoint
+
+A point in page space (ADR 0027: top-left of the displayed CropBox, y down, points).
+
+## Properties
+
+### x
+
+> `readonly` **x**: `number`
+
+***
+
+### y
+
+> `readonly` **y**: `number`

package/docs/api/interfaces/RangeOptions.md

@@ -0,0 +1,54 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / RangeOptions
+
+# Interface: RangeOptions
+
+How a range document fetches.
+
+## Properties
+
+### blockSize?
+
+> `readonly` `optional` **blockSize?**: `number`
+
+Fetches are widened to whole blocks of this many bytes (default: the source's, else 4096).
+
+***
+
+### budget?
+
+> `readonly` `optional` **budget?**: `number`
+
+The most bytes the document may hold (default: no limit); more is `source-budget-exceeded`.
+
+***
+
+### maxRounds?
+
+> `readonly` `optional` **maxRounds?**: `number`
+
+Rounds of fetches per call before giving up with the last `data-pending` (default 1024).
+
+***
+
+### readahead?
+
+> `readonly` `optional` **readahead?**: `number`
+
+Extra bytes fetched after each range (default 0).
+
+***
+
+### signal?
+
+> `readonly` `optional` **signal?**: `AbortSignal`
+
+Aborts the open's fetches: it rejects with the signal's reason. Later calls take their own
+signal ([Document.ensure](../classes/Document.md#ensure)).

package/docs/api/interfaces/RangeSource.md

@@ -0,0 +1,59 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / RangeSource
+
+# Interface: RangeSource
+
+Random access to a file whose bytes are fetched on demand (a remote file, a `Blob`, a file
+handle). `@laminapdf/viewer`'s document worker reads a `Blob` through it too.
+
+## Properties
+
+### blockSize?
+
+> `readonly` `optional` **blockSize?**: `number`
+
+The block size this source prefers fetches aligned to (HTTP: fewer, larger requests).
+
+***
+
+### size
+
+> `readonly` **size**: `number`
+
+The file's size in bytes.
+
+## Methods
+
+### read()
+
+> **read**(`offset`, `length`, `options?`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+The `length` bytes at `offset` (exactly that many: the file is at least `offset + length`
+long). Rejects when `signal` aborts.
+
+#### Parameters
+
+##### offset
+
+`number`
+
+##### length
+
+`number`
+
+##### options?
+
+###### signal?
+
+`AbortSignal`
+
+#### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>

package/docs/api/interfaces/StrokeStyle.md

@@ -0,0 +1,61 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / StrokeStyle
+
+# Interface: StrokeStyle
+
+How strokes are drawn.
+
+## Properties
+
+### cap?
+
+> `readonly` `optional` **cap?**: `"butt"` \| `"round"` \| `"square"`
+
+Line ends (default `butt`).
+
+***
+
+### dash?
+
+> `readonly` `optional` **dash?**: readonly `number`[]
+
+Dash pattern in points (default: solid).
+
+***
+
+### dashPhase?
+
+> `readonly` `optional` **dashPhase?**: `number`
+
+Where the dash pattern starts (default 0).
+
+***
+
+### join?
+
+> `readonly` `optional` **join?**: `"round"` \| `"miter"` \| `"bevel"`
+
+Corners (default `miter`).
+
+***
+
+### miterLimit?
+
+> `readonly` `optional` **miterLimit?**: `number`
+
+Miter limit (default 10).
+
+***
+
+### width?
+
+> `readonly` `optional` **width?**: `number`
+
+Line width in points (default 1).