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

package/docs/api/README.md

@@ -0,0 +1,147 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+**@laminapdf/sdk**
+
+***
+
+# @laminapdf/sdk
+
+## Classes
+
+- [Builder](classes/Builder.md)
+- [Document](classes/Document.md)
+- [Font](classes/Font.md)
+- [Image](classes/Image.md)
+- [LaminaPdfError](classes/LaminaPdfError.md)
+- [Page](classes/Page.md)
+- [PageRef](classes/PageRef.md)
+- [PageText](classes/PageText.md)
+- [PageTextRun](classes/PageTextRun.md)
+- [PendingPath](classes/PendingPath.md)
+- [SaveJob](classes/SaveJob.md)
+- [Surface](classes/Surface.md)
+- [Transaction](classes/Transaction.md)
+
+## Interfaces
+
+- [BuilderOptions](interfaces/BuilderOptions.md)
+- [ByteRange](interfaces/ByteRange.md)
+- [ChunkOptions](interfaces/ChunkOptions.md)
+- [Diagnostic](interfaces/Diagnostic.md)
+- [ExtractOptions](interfaces/ExtractOptions.md)
+- [ExtractResult](interfaces/ExtractResult.md)
+- [FontInfo](interfaces/FontInfo.md)
+- [HttpRangeOptions](interfaces/HttpRangeOptions.md)
+- [InitOptions](interfaces/InitOptions.md)
+- [Leak](interfaces/Leak.md)
+- [Location](interfaces/Location.md)
+- [OpenOptions](interfaces/OpenOptions.md)
+- [OpLog](interfaces/OpLog.md)
+- [PageTextOptions](interfaces/PageTextOptions.md)
+- [PathBuilder](interfaces/PathBuilder.md)
+- [QuadPoint](interfaces/QuadPoint.md)
+- [RangeOptions](interfaces/RangeOptions.md)
+- [RangeSource](interfaces/RangeSource.md)
+- [StrokeStyle](interfaces/StrokeStyle.md)
+- [TagSpec](interfaces/TagSpec.md)
+- [TextBoxOptions](interfaces/TextBoxOptions.md)
+- [TextGlyph](interfaces/TextGlyph.md)
+- [TextOptions](interfaces/TextOptions.md)
+- [WasmMemory](interfaces/WasmMemory.md)
+
+## Type Aliases
+
+- [AfRelationship](type-aliases/AfRelationship.md)
+- [Align](type-aliases/Align.md)
+- [ArtifactKind](type-aliases/ArtifactKind.md)
+- [AttachmentOptions](type-aliases/AttachmentOptions.md)
+- [BlendMode](type-aliases/BlendMode.md)
+- [BoxRect](type-aliases/BoxRect.md)
+- [BuildOptions](type-aliases/BuildOptions.md)
+- [Cell](type-aliases/Cell.md)
+- [Chunk](type-aliases/Chunk.md)
+- [Color](type-aliases/Color.md)
+- [Coordinates](type-aliases/Coordinates.md)
+- [Direction](type-aliases/Direction.md)
+- [DocumentInfo](type-aliases/DocumentInfo.md)
+- [Dropped](type-aliases/Dropped.md)
+- [DropReason](type-aliases/DropReason.md)
+- [Edited](type-aliases/Edited.md)
+- [ErrorCode](type-aliases/ErrorCode.md)
+- [ErrorKind](type-aliases/ErrorKind.md)
+- [ExtractedBlock](type-aliases/ExtractedBlock.md)
+- [ExtractedPage](type-aliases/ExtractedPage.md)
+- [ExtractedSource](type-aliases/ExtractedSource.md)
+- [ExtractFormat](type-aliases/ExtractFormat.md)
+- [Extraction](type-aliases/Extraction.md)
+- [FillRule](type-aliases/FillRule.md)
+- [Fit](type-aliases/Fit.md)
+- [Flags](type-aliases/Flags.md)
+- [Generator](type-aliases/Generator.md)
+- [GlyphQuad](type-aliases/GlyphQuad.md)
+- [InfoPatch](type-aliases/InfoPatch.md)
+- [LaminaPdfWarning](type-aliases/LaminaPdfWarning.md)
+- [LimitName](type-aliases/LimitName.md)
+- [Limits](type-aliases/Limits.md)
+- [LineBox](type-aliases/LineBox.md)
+- [LineCap](type-aliases/LineCap.md)
+- [LineJoin](type-aliases/LineJoin.md)
+- [LinkTarget](type-aliases/LinkTarget.md)
+- [Metadata](type-aliases/Metadata.md)
+- [Op](type-aliases/Op.md)
+- [OutlineEntry](type-aliases/OutlineEntry.md)
+- [Overflow](type-aliases/Overflow.md)
+- [PageInfo](type-aliases/PageInfo.md)
+- [PageLabel](type-aliases/PageLabel.md)
+- [PageSizeName](type-aliases/PageSizeName.md)
+- [Point](type-aliases/Point.md)
+- [Profile](type-aliases/Profile.md)
+- [Progress](type-aliases/Progress.md)
+- [ReadingOrder](type-aliases/ReadingOrder.md)
+- [Rect](type-aliases/Rect.md)
+- [Region](type-aliases/Region.md)
+- [RenderMode](type-aliases/RenderMode.md)
+- [Rotation](type-aliases/Rotation.md)
+- [SaveOptions](type-aliases/SaveOptions.md)
+- [SaveReport](type-aliases/SaveReport.md)
+- [Span](type-aliases/Span.md)
+- [SplitOn](type-aliases/SplitOn.md)
+- [Standard14](type-aliases/Standard14.md)
+- [StructRef](type-aliases/StructRef.md)
+- [StructSource](type-aliases/StructSource.md)
+- [TableDetector](type-aliases/TableDetector.md)
+- [TableMode](type-aliases/TableMode.md)
+- [TableScope](type-aliases/TableScope.md)
+- [Tag](type-aliases/Tag.md)
+- [TagName](type-aliases/TagName.md)
+- [TextLayout](type-aliases/TextLayout.md)
+- [TextRange](type-aliases/TextRange.md)
+- [TextRunInfo](type-aliases/TextRunInfo.md)
+- [Transform](type-aliases/Transform.md)
+- [UndoOutcome](type-aliases/UndoOutcome.md)
+- [ViewerPreferences](type-aliases/ViewerPreferences.md)
+- [WarningCode](type-aliases/WarningCode.md)
+- [WasmSource](type-aliases/WasmSource.md)
+
+## Variables
+
+- [Matrix](variables/Matrix.md)
+- [PAGE\_SIZES](variables/PAGE_SIZES.md)
+- [TAG\_NAMES](variables/TAG_NAMES.md)
+
+## Functions
+
+- [callbackSource](functions/callbackSource.md)
+- [httpRangeSource](functions/httpRangeSource.md)
+- [init](functions/init.md)
+- [isExtractLoaded](functions/isExtractLoaded.md)
+- [isInitialized](functions/isInitialized.md)
+- [isLaminaPdfError](functions/isLaminaPdfError.md)
+- [isTextLoaded](functions/isTextLoaded.md)
+- [loadExtract](functions/loadExtract.md)
+- [loadText](functions/loadText.md)
+- [onLeak](functions/onLeak.md)
+- [reset](functions/reset.md)
+- [wasmMemory](functions/wasmMemory.md)

package/docs/api/classes/Builder.md

@@ -0,0 +1,467 @@
+---
+version: "0.2.0-alpha.3"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / Builder
+
+# Class: Builder
+
+Builds a new document: pages, navigation and metadata; [Builder.finish](#finish) returns a
+[Document](Document.md) to save. Created in the text module when it is loaded (or `text: true`),
+else in the reading module (text, extract, then base; vector and image pages only). `finish()`
+frees its WebAssembly memory; to drop it unfinished, use `using` or [Builder.free](#free).
+
+## Example
+
+```ts
+await init({ text: true });
+const b = new Builder({ producer: "my app" });
+const page = b.page("A4");
+page.surface().text("Hello, world!", { font: Font.standard("Helvetica"), size: 24, at: [72, 96] });
+page.finish();
+const bytes = b.finish().save();
+```
+
+## Extends
+
+- `Handle`\<`BaseGlue`\>
+
+## Constructors
+
+### Constructor
+
+> **new Builder**(`options?`): `Builder`
+
+#### Parameters
+
+##### options?
+
+[`BuilderOptions`](../interfaces/BuilderOptions.md) = `{}`
+
+version, file ID, producer, creation date, compression, tagging,
+  conformance `profiles`; `text`.
+
+#### Returns
+
+`Builder`
+
+#### Throws
+
+[LaminaPdfError](LaminaPdfError.md) `not-initialized`, `text-module-not-loaded`; `unknown-option`.
+
+#### Overrides
+
+`Handle<BaseGlue>.constructor`
+
+## Accessors
+
+### hasText
+
+#### Get Signature
+
+> **get** **hasText**(): `boolean`
+
+Whether this builder draws in the text module (fonts and text).
+
+##### Returns
+
+`boolean`
+
+***
+
+### 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`
+
+***
+
+### attach()
+
+> **attach**(`name`, `bytes`, `mime`, `options?`): `this`
+
+Attaches a file: PDF/A-3b's associated files, such as an e-invoice's XML. The same name
+again replaces the file. PDF/A-2b and PDF/A-2u refuse attachments at [Builder.finish](#finish),
+and every PDF/A profile refuses one without a MIME type there.
+
+#### Parameters
+
+##### name
+
+`string`
+
+the file name viewers show.
+
+##### bytes
+
+`Uint8Array`
+
+the file's contents.
+
+##### mime
+
+`string`
+
+its MIME type, such as `text/xml`.
+
+##### options?
+
+`AttachmentInit`
+
+how the file relates to the document (`relationship`, default
+  `unspecified`), its `description` and `modDate`.
+
+#### Returns
+
+`this`
+
+#### Throws
+
+[LaminaPdfError](LaminaPdfError.md) `invalid-argument` for a `modDate` that isn't a PDF date,
+  `unknown-option` for an unknown key, `builder-finished` after [Builder.finish](#finish).
+
+***
+
+### 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`
+
+***
+
+### destination()
+
+> **destination**(`name`, `index`, `fit?`): `this`
+
+Defines the named destination `name`: page `index`, shown as `fit` (default: the page).
+
+#### Parameters
+
+##### name
+
+`string`
+
+##### index
+
+`number`
+
+##### fit?
+
+`FitInit`
+
+#### Returns
+
+`this`
+
+***
+
+### finish()
+
+> **finish**(): [`Document`](Document.md)
+
+Writes fonts, links, the page tree, outline and metadata; the builder (and its unfinished
+pages) take no more calls afterwards.
+
+#### Returns
+
+[`Document`](Document.md)
+
+the new document (unsaved; its save is a full rewrite).
+
+#### Throws
+
+[LaminaPdfError](LaminaPdfError.md) `page-index-out-of-range`, `unknown-destination`,
+  `invalid-page-labels`, `invalid-geometry`, `subset-failed`, `builder-finished`; under a
+  profile (`profiles` in the options), the first rule the document breaks, with that rule's
+  code (the error reference lists them, from `profile-version-conflict` on).
+
+***
+
+### font()
+
+> **font**(`font`): [`FontInfo`](../interfaces/FontInfo.md)
+
+Registers `font` with this builder (otherwise it is registered at first use).
+
+#### Parameters
+
+##### font
+
+[`Font`](Font.md)
+
+#### Returns
+
+[`FontInfo`](../interfaces/FontInfo.md)
+
+#### Throws
+
+[LaminaPdfError](LaminaPdfError.md) `text-module-not-loaded`, `invalid-font`, `font-not-embeddable`.
+
+***
+
+### 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`
+
+***
+
+### lang()
+
+> **lang**(`tag`): `this`
+
+The natural language (`/Lang`), a BCP 47 tag.
+
+#### Parameters
+
+##### tag
+
+`string`
+
+#### Returns
+
+`this`
+
+***
+
+### metadata()
+
+> **metadata**(`metadata`): `this`
+
+The metadata, written as the Info dictionary and an XMP packet.
+
+#### Parameters
+
+##### metadata
+
+`MetadataInit`
+
+#### Returns
+
+`this`
+
+***
+
+### outline()
+
+> **outline**(`entries`): `string`[]
+
+Adds outline (bookmark) items with their children.
+
+#### Parameters
+
+##### entries
+
+readonly `OutlineEntryInit`[]
+
+#### Returns
+
+`string`[]
+
+their IDs, in pre-order.
+
+***
+
+### page()
+
+> **page**(`size?`): [`Page`](Page.md)
+
+A new page of a named size or `[width, height]` in points.
+
+#### Parameters
+
+##### size?
+
+[`PageSizeName`](../type-aliases/PageSizeName.md) \| readonly \[`number`, `number`\] = `"A4"`
+
+#### Returns
+
+[`Page`](Page.md)
+
+***
+
+### pageLabels()
+
+> **pageLabels**(`ranges`): `this`
+
+The page labels (`i, ii, 1, 2…`), ranges by first page; checked at finish.
+
+#### Parameters
+
+##### ranges
+
+readonly `PageLabelInit`[]
+
+#### Returns
+
+`this`
+
+***
+
+### release()
+
+> `protected` **release**(): `void`
+
+Frees the WebAssembly side; called at most once, and only while [owned](#owned).
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+`Handle.release`
+
+***
+
+### viewerPreferences()
+
+> **viewerPreferences**(`preferences`): `this`
+
+How viewers present the document when it opens.
+
+#### Parameters
+
+##### preferences
+
+`ViewerPreferencesInit`
+
+#### Returns
+
+`this`
+
+***
+
+### create()
+
+> `static` **create**(`options?`): `Builder`
+
+As `new Builder(options)`.
+
+#### Parameters
+
+##### options?
+
+[`BuilderOptions`](../interfaces/BuilderOptions.md)
+
+#### Returns
+
+`Builder`