pdf-lite 1.0.0 → 1.0.1-alpha.2

package/docs/pdf/pdf-reader/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / pdf/pdf-reader
+
+# pdf/pdf-reader
+
+## Classes
+
+- [PdfReader](classes/PdfReader.md)

package/docs/pdf/pdf-reader/classes/PdfReader.md

@@ -0,0 +1,82 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [pdf/pdf-reader](../README.md) / PdfReader
+
+# Class: PdfReader
+
+A reader for parsing PDF data into PdfDocument instances.
+Processes streams of PDF objects and constructs documents from them.
+
+## Example
+
+```typescript
+// Read PDF from file bytes
+const document = await PdfReader.fromBytes(fileBytes)
+```
+
+## Constructors
+
+### Constructor
+
+> **new PdfReader**(`objectStream`): `PdfReader`
+
+Creates a new PdfReader instance.
+
+#### Parameters
+
+##### objectStream
+
+An async or sync iterable of PDF objects
+
+`Iterable`\<[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md), `any`, `any`\> | `AsyncIterable`\<[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md), `any`, `any`\>
+
+#### Returns
+
+`PdfReader`
+
+## Properties
+
+### objectStream
+
+> `protected` **objectStream**: `Iterable`\<[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md), `any`, `any`\> \| `AsyncIterable`\<[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md), `any`, `any`\>
+
+The stream of PDF objects to read from
+
+## Methods
+
+### read()
+
+> **read**(): `Promise`\<[`PdfDocument`](../../pdf-document/classes/PdfDocument.md)\>
+
+Reads all objects from the stream and constructs a PdfDocument.
+
+#### Returns
+
+`Promise`\<[`PdfDocument`](../../pdf-document/classes/PdfDocument.md)\>
+
+A promise that resolves to the parsed PdfDocument
+
+---
+
+### fromBytes()
+
+> `static` **fromBytes**(`input`): `Promise`\<[`PdfDocument`](../../pdf-document/classes/PdfDocument.md)\>
+
+Creates a PdfDocument directly from a byte stream.
+Convenience method that creates a reader internally.
+
+#### Parameters
+
+##### input
+
+Async or sync iterable of byte arrays
+
+`Iterable`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md), `any`, `any`\> | `AsyncIterable`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md), `any`, `any`\>
+
+#### Returns
+
+`Promise`\<[`PdfDocument`](../../pdf-document/classes/PdfDocument.md)\>
+
+A promise that resolves to the parsed PdfDocument

package/docs/pdf/pdf-revision/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / pdf/pdf-revision
+
+# pdf/pdf-revision
+
+## Classes
+
+- [PdfRevision](classes/PdfRevision.md)

package/docs/pdf/pdf-revision/classes/PdfRevision.md

@@ -0,0 +1,508 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [pdf/pdf-revision](../README.md) / PdfRevision
+
+# Class: PdfRevision
+
+Represents a single revision of a PDF document.
+PDF documents can have multiple revisions for incremental updates,
+where each revision contains its own set of objects and cross-reference table.
+
+## Extends
+
+- [`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md)
+
+## Constructors
+
+### Constructor
+
+> **new PdfRevision**(`options?`): `PdfRevision`
+
+Creates a new PDF revision.
+
+#### Parameters
+
+##### options?
+
+Configuration options for the revision
+
+###### locked?
+
+`boolean`
+
+Whether the revision should be locked initially
+
+###### objects?
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md)[]
+
+Initial objects for this revision
+
+###### prev?
+
+[`PdfXrefLookup`](../../pdf-xref-lookup/classes/PdfXrefLookup.md) \| `PdfRevision`
+
+Previous revision or xref lookup to link to
+
+#### Returns
+
+`PdfRevision`
+
+#### Overrides
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md).[`constructor`](../../../core/objects/pdf-object/classes/PdfObject.md#constructor)
+
+## Properties
+
+### locked
+
+> **locked**: `boolean` = `false`
+
+Whether this revision is locked (cannot be modified)
+
+---
+
+### modified
+
+> `protected` **modified**: `boolean` = `true`
+
+Indicates whether the object has been modified. By default, assume it has been modified because it's a new object
+
+#### Inherited from
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md).[`modified`](../../../core/objects/pdf-object/classes/PdfObject.md#modified)
+
+---
+
+### objects
+
+> **objects**: [`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md)[] = `[]`
+
+Objects contained in this revision
+
+---
+
+### postTokens?
+
+> `optional` **postTokens**: [`PdfToken`](../../../core/tokens/token/classes/PdfToken.md)[]
+
+Optional tokens to prepend or append during serialization
+
+#### Inherited from
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md).[`postTokens`](../../../core/objects/pdf-object/classes/PdfObject.md#posttokens)
+
+---
+
+### preTokens?
+
+> `optional` **preTokens**: [`PdfToken`](../../../core/tokens/token/classes/PdfToken.md)[]
+
+Optional tokens to prepend or append during serialization
+
+#### Inherited from
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md).[`preTokens`](../../../core/objects/pdf-object/classes/PdfObject.md#pretokens)
+
+---
+
+### xref
+
+> **xref**: [`PdfXrefLookup`](../../pdf-xref-lookup/classes/PdfXrefLookup.md)
+
+Cross-reference lookup table for this revision
+
+## Accessors
+
+### objectType
+
+#### Get Signature
+
+> **get** **objectType**(): `string`
+
+The type of this PDF object
+
+##### Returns
+
+`string`
+
+#### Inherited from
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md).[`objectType`](../../../core/objects/pdf-object/classes/PdfObject.md#objecttype)
+
+---
+
+### trailerDict
+
+#### Get Signature
+
+> **get** **trailerDict**(): [`PdfDictionary`](../../../core/objects/pdf-dictionary/classes/PdfDictionary.md)\<[`PdfTrailerEntries`](../../../core/objects/pdf-trailer/type-aliases/PdfTrailerEntries.md)\>
+
+Gets the trailer dictionary for this revision.
+
+##### Returns
+
+[`PdfDictionary`](../../../core/objects/pdf-dictionary/classes/PdfDictionary.md)\<[`PdfTrailerEntries`](../../../core/objects/pdf-trailer/type-aliases/PdfTrailerEntries.md)\>
+
+The trailer dictionary containing document metadata references
+
+## Methods
+
+### addObject()
+
+> **addObject**(...`objects`): `void`
+
+Adds objects to the revision.
+
+#### Parameters
+
+##### objects
+
+...[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md)[]
+
+Objects to add to the revision
+
+#### Returns
+
+`void`
+
+---
+
+### addObjectAt()
+
+> **addObjectAt**(`object`, `index?`): `void`
+
+Adds an object at a specific position in the revision.
+
+#### Parameters
+
+##### object
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md)
+
+The object to add
+
+##### index?
+
+Position to insert at (number) or object to insert before
+
+`number` | [`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md)
+
+#### Returns
+
+`void`
+
+#### Throws
+
+Error if the revision is locked or index is out of bounds
+
+---
+
+### as()
+
+> **as**\<`T`\>(`ctor`): `T`
+
+Attempts to cast the object to a specific PdfObject subclass
+
+#### Type Parameters
+
+##### T
+
+`T` _extends_ [`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md)
+
+#### Parameters
+
+##### ctor
+
+(...`args`) => `T`
+
+#### Returns
+
+`T`
+
+#### Inherited from
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md).[`as`](../../../core/objects/pdf-object/classes/PdfObject.md#as)
+
+---
+
+### clone()
+
+> **clone**(): `this`
+
+Creates a deep copy of this revision.
+
+#### Returns
+
+`this`
+
+A cloned PdfRevision instance
+
+#### Overrides
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md).[`clone`](../../../core/objects/pdf-object/classes/PdfObject.md#clone)
+
+---
+
+### contains()
+
+> **contains**(`object`): `boolean`
+
+Checks if an object reference exists in this revision.
+
+#### Parameters
+
+##### object
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md)
+
+The object to check for
+
+#### Returns
+
+`boolean`
+
+True if the exact object instance exists in this revision
+
+---
+
+### deleteObject()
+
+> **deleteObject**(...`objects`): `void`
+
+Removes objects from the revision.
+
+#### Parameters
+
+##### objects
+
+...[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md)[]
+
+Objects to remove from the revision
+
+#### Returns
+
+`void`
+
+#### Throws
+
+Error if the revision is locked
+
+---
+
+### equals()
+
+> **equals**(`other?`): `boolean`
+
+Compares this object to another for equality based on their token representations
+
+#### Parameters
+
+##### other?
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md)
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md).[`equals`](../../../core/objects/pdf-object/classes/PdfObject.md#equals)
+
+---
+
+### exists()
+
+> **exists**(`object`): `boolean`
+
+Checks if an equivalent object exists in this revision (by value equality).
+
+#### Parameters
+
+##### object
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md)
+
+The object to check for
+
+#### Returns
+
+`boolean`
+
+True if an equal object exists in this revision
+
+---
+
+### isModified()
+
+> **isModified**(): `boolean`
+
+Indicates whether the object has been modified. Override this method if the modified state is determined differently
+
+#### Returns
+
+`boolean`
+
+#### Overrides
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md).[`isModified`](../../../core/objects/pdf-object/classes/PdfObject.md#ismodified)
+
+---
+
+### setModified()
+
+> **setModified**(`modified`): `void`
+
+Sets the modified state of the object. Override this method if the modified state is determined differently
+
+#### Parameters
+
+##### modified
+
+`boolean` = `true`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md).[`setModified`](../../../core/objects/pdf-object/classes/PdfObject.md#setmodified)
+
+---
+
+### setPrev()
+
+> **setPrev**(`xref`): `void`
+
+Links this revision to a previous revision's cross-reference table.
+
+#### Parameters
+
+##### xref
+
+The previous revision's xref lookup or revision
+
+[`PdfXrefLookup`](../../pdf-xref-lookup/classes/PdfXrefLookup.md) | `PdfRevision`
+
+#### Returns
+
+`void`
+
+---
+
+### sortObjects()
+
+> **sortObjects**(): `void`
+
+Sorts objects by their insertion order.
+Indirect objects are placed before other objects.
+
+#### Returns
+
+`void`
+
+---
+
+### toBytes()
+
+> **toBytes**(`padTo?`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+Converts the object to a ByteArray, optionally padding to a specified length
+
+#### Parameters
+
+##### padTo?
+
+`number`
+
+#### Returns
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+#### Inherited from
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md).[`toBytes`](../../../core/objects/pdf-object/classes/PdfObject.md#tobytes)
+
+---
+
+### tokenize()
+
+> `protected` **tokenize**(): [`PdfToken`](../../../core/tokens/token/classes/PdfToken.md)[]
+
+Tokenizes the object into an array of PdfTokens
+
+#### Returns
+
+[`PdfToken`](../../../core/tokens/token/classes/PdfToken.md)[]
+
+#### Overrides
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md).[`tokenize`](../../../core/objects/pdf-object/classes/PdfObject.md#tokenize)
+
+---
+
+### toString()
+
+> **toString**(): `string`
+
+Converts the object to a string representation
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md).[`toString`](../../../core/objects/pdf-object/classes/PdfObject.md#tostring)
+
+---
+
+### toTokens()
+
+> **toTokens**(): [`PdfToken`](../../../core/tokens/token/classes/PdfToken.md)[]
+
+Converts the object to an array of PdfTokens, including any pre or post tokens
+
+#### Returns
+
+[`PdfToken`](../../../core/tokens/token/classes/PdfToken.md)[]
+
+#### Inherited from
+
+[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md).[`toTokens`](../../../core/objects/pdf-object/classes/PdfObject.md#totokens)
+
+---
+
+### unshift()
+
+> **unshift**(...`objects`): `void`
+
+Adds objects to the beginning of the revision's object list.
+
+#### Parameters
+
+##### objects
+
+...[`PdfObject`](../../../core/objects/pdf-object/classes/PdfObject.md)[]
+
+Objects to add at the beginning
+
+#### Returns
+
+`void`
+
+---
+
+### update()
+
+> **update**(): `void`
+
+Updates the revision by sorting objects and updating the xref table.
+
+#### Returns
+
+`void`

package/docs/pdf/pdf-xref-lookup/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / pdf/pdf-xref-lookup
+
+# pdf/pdf-xref-lookup
+
+## Classes
+
+- [PdfXrefLookup](classes/PdfXrefLookup.md)