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

package/docs/api/interfaces/ExtractOptions.md

@@ -0,0 +1,92 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ExtractOptions
+
+# Interface: ExtractOptions\<F\>
+
+Options for [Document.extract](../classes/Document.md#extract).
+
+## Type Parameters
+
+### F
+
+`F` *extends* [`ExtractFormat`](../type-aliases/ExtractFormat.md) = [`ExtractFormat`](../type-aliases/ExtractFormat.md)
+
+## Properties
+
+### chunk?
+
+> `readonly` `optional` **chunk?**: [`ChunkOptions`](ChunkOptions.md)
+
+How chunks are cut (`"chunks"`, and `"json"` to include them).
+
+***
+
+### dehyphenate?
+
+> `readonly` `optional` **dehyphenate?**: `boolean`
+
+Join words hyphenated across lines; on by default.
+
+***
+
+### drop?
+
+> `readonly` `optional` **drop?**: `object`
+
+`keepSpans` keeps each dropped run's text in its `dropped` entry (JSON), for auditing a file.
+`furniture` (on by default) drops running headers, footers, page numbers and artifact-marked text too.
+
+#### furniture?
+
+> `readonly` `optional` **furniture?**: `boolean`
+
+#### keepSpans?
+
+> `readonly` `optional` **keepSpans?**: `boolean`
+
+***
+
+### format
+
+> `readonly` **format**: `F`
+
+What to return: Markdown or plain text as a string, the JSON as an [Extraction](../type-aliases/Extraction.md), or [Chunk](../type-aliases/Chunk.md)s.
+
+***
+
+### pageMarkers?
+
+> `readonly` `optional` **pageMarkers?**: `boolean`
+
+Write `<!-- page N -->` before each page's first block (Markdown, chunks and the JSON's text ranges).
+
+***
+
+### pages?
+
+> `readonly` `optional` **pages?**: readonly `number`[]
+
+The 0-based page indices to extract, in this order; every page by default.
+
+***
+
+### readingOrder?
+
+> `readonly` `optional` **readingOrder?**: [`ReadingOrder`](../type-aliases/ReadingOrder.md)
+
+Where the reading order comes from; `"auto"` by default.
+
+***
+
+### tables?
+
+> `readonly` `optional` **tables?**: [`TableMode`](../type-aliases/TableMode.md)
+
+Which table detectors run; `"lattice"` by default.

package/docs/api/interfaces/ExtractResult.md

@@ -0,0 +1,37 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ExtractResult
+
+# Interface: ExtractResult
+
+The result of [Document.extract](../classes/Document.md#extract) for each format.
+
+## Properties
+
+### chunks
+
+> `readonly` **chunks**: [`Chunk`](../type-aliases/Chunk.md)[]
+
+***
+
+### json
+
+> `readonly` **json**: [`Extraction`](../type-aliases/Extraction.md)
+
+***
+
+### markdown
+
+> `readonly` **markdown**: `string`
+
+***
+
+### text
+
+> `readonly` **text**: `string`

package/docs/api/interfaces/FontInfo.md

@@ -0,0 +1,37 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / FontInfo
+
+# Interface: FontInfo
+
+What a builder knows of a font once registered.
+
+## Properties
+
+### family
+
+> `readonly` **family**: `string`
+
+The family name.
+
+***
+
+### isStandard
+
+> `readonly` **isStandard**: `boolean`
+
+Whether it is one of the standard 14 (not embedded).
+
+***
+
+### postscriptName
+
+> `readonly` **postscriptName**: `string`
+
+The PostScript name.

package/docs/api/interfaces/HostModels.md

@@ -0,0 +1,57 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / HostModels
+
+# Interface: HostModels
+
+The host's models for [extractWithModels](../functions/extractWithModels.md): each renders the page it is asked for and runs.
+
+## Properties
+
+### layout?
+
+> `readonly` `optional` **layout?**: (`request`, `signal`) => `Promise`\<readonly [`LayoutRegion`](LayoutRegion.md)[]\>
+
+A layout model's regions on `request.page`, rendered at `request.dpi`.
+
+#### Parameters
+
+##### request
+
+[`ModelRequest`](ModelRequest.md)
+
+##### signal
+
+`AbortSignal` \| `undefined`
+
+#### Returns
+
+`Promise`\<readonly [`LayoutRegion`](LayoutRegion.md)[]\>
+
+***
+
+### ocr?
+
+> `readonly` `optional` **ocr?**: (`request`, `signal`) => `Promise`\<readonly [`OcrWord`](OcrWord.md)[]\>
+
+An OCR engine's words on `request.page`, rendered at `request.dpi`, in `request.langs`.
+
+#### Parameters
+
+##### request
+
+[`ModelRequest`](ModelRequest.md)
+
+##### signal
+
+`AbortSignal` \| `undefined`
+
+#### Returns
+
+`Promise`\<readonly [`OcrWord`](OcrWord.md)[]\>

package/docs/api/interfaces/HttpRangeOptions.md

@@ -0,0 +1,78 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@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.4"
+---
+
+[**@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/LayoutRegion.md

@@ -0,0 +1,38 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / LayoutRegion
+
+# Interface: LayoutRegion
+
+A layout region, its box `[x, y, width, height]` in top-left points (ADR 0027), as the
+output's boxes are.
+
+## Properties
+
+### bbox
+
+> **bbox**: \[`number`, `number`, `number`, `number`\]
+
+`[x, y, width, height]`.
+
+***
+
+### label
+
+> **label**: [`RegionLabel`](../type-aliases/RegionLabel.md)
+
+What it is.
+
+***
+
+### score
+
+> **score**: `number`
+
+The model's confidence, 0 to 1.

package/docs/api/interfaces/Leak.md

@@ -0,0 +1,21 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@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.4"
+---
+
+[**@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/ModelInfo.md

@@ -0,0 +1,45 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ModelInfo
+
+# Interface: ModelInfo
+
+A model the host runs, as the output's `generator.models` names it.
+
+## Properties
+
+### licence
+
+> **licence**: `string`
+
+Its weights' SPDX licence.
+
+***
+
+### name
+
+> **name**: `string`
+
+Its name.
+
+***
+
+### sha256
+
+> **sha256**: `string`
+
+Its weights' SHA-256, lowercase hex.
+
+***
+
+### version
+
+> **version**: `string`
+
+Its version or revision.

package/docs/api/interfaces/ModelRequest.md

@@ -0,0 +1,45 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / ModelRequest
+
+# Interface: ModelRequest
+
+A model result the job waits for.
+
+## Properties
+
+### dpi
+
+> **dpi**: `number`
+
+The resolution to render it at.
+
+***
+
+### kind
+
+> **kind**: `string`
+
+`layout` (regions) or `ocr` (words).
+
+***
+
+### langs
+
+> **langs**: `string`[]
+
+OCR's languages (BCP 47); empty for the engine's default.
+
+***
+
+### page
+
+> **page**: `number`
+
+The 0-based page to render.

package/docs/api/interfaces/Models.md

@@ -0,0 +1,45 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Models
+
+# Interface: Models
+
+The models the host runs for an extraction job.
+
+## Properties
+
+### dpi?
+
+> `optional` **dpi?**: `number`
+
+The resolution pages are asked for at; 150 by default.
+
+***
+
+### langs?
+
+> `optional` **langs?**: `string`[]
+
+OCR's languages (BCP 47).
+
+***
+
+### layout?
+
+> `optional` **layout?**: [`ModelInfo`](ModelInfo.md)
+
+A layout model: every page's regions are asked for.
+
+***
+
+### ocr?
+
+> `optional` **ocr?**: [`ModelInfo`](ModelInfo.md)
+
+An OCR engine: pages with no visible text are asked for.

package/docs/api/interfaces/OcrWord.md

@@ -0,0 +1,37 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / OcrWord
+
+# Interface: OcrWord
+
+An OCR word, its box as a region's.
+
+## Properties
+
+### bbox
+
+> **bbox**: \[`number`, `number`, `number`, `number`\]
+
+`[x, y, width, height]`.
+
+***
+
+### confidence
+
+> **confidence**: `number`
+
+The engine's confidence, 0 to 1.
+
+***
+
+### text
+
+> **text**: `string`
+
+Its text.

package/docs/api/interfaces/OpLog.md

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