pdf-lite 1.0.0 → 1.0.1-alpha.2

package/docs/core/tokens/xref-table-entry-token/classes/PdfXRefTableEntryToken.md

@@ -0,0 +1,157 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [core/tokens/xref-table-entry-token](../README.md) / PdfXRefTableEntryToken
+
+# Class: PdfXRefTableEntryToken
+
+## Extends
+
+- [`PdfToken`](../../token/classes/PdfToken.md)
+
+## Constructors
+
+### Constructor
+
+> **new PdfXRefTableEntryToken**(`offset`, `generationNumber`, `objectNumber`, `inUse`): `PdfXRefTableEntryToken`
+
+#### Parameters
+
+##### offset
+
+`number` | [`PdfNumberToken`](../../number-token/classes/PdfNumberToken.md) | [`Ref`](../../../ref/classes/Ref.md)\<`number`\>
+
+##### generationNumber
+
+`number` | [`PdfNumberToken`](../../number-token/classes/PdfNumberToken.md)
+
+##### objectNumber
+
+`number` | [`PdfNumberToken`](../../number-token/classes/PdfNumberToken.md)
+
+##### inUse
+
+`boolean`
+
+#### Returns
+
+`PdfXRefTableEntryToken`
+
+#### Overrides
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`constructor`](../../token/classes/PdfToken.md#constructor)
+
+## Properties
+
+### generationNumber
+
+> **generationNumber**: [`PdfNumberToken`](../../number-token/classes/PdfNumberToken.md)
+
+---
+
+### inUse
+
+> **inUse**: `boolean`
+
+---
+
+### objectNumber
+
+> **objectNumber**: [`PdfNumberToken`](../../number-token/classes/PdfNumberToken.md)
+
+---
+
+### offset
+
+> **offset**: [`PdfNumberToken`](../../number-token/classes/PdfNumberToken.md)
+
+---
+
+### rawBytes
+
+> `protected` **rawBytes**: [`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`rawBytes`](../../token/classes/PdfToken.md#rawbytes)
+
+## Accessors
+
+### byteLength
+
+#### Get Signature
+
+> **get** **byteLength**(): `number`
+
+##### Returns
+
+`number`
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`byteLength`](../../token/classes/PdfToken.md#bytelength)
+
+---
+
+### type
+
+#### Get Signature
+
+> **get** **type**(): `string`
+
+##### Returns
+
+`string`
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`type`](../../token/classes/PdfToken.md#type)
+
+## Methods
+
+### equals()
+
+> **equals**(`other`): `boolean`
+
+#### Parameters
+
+##### other
+
+[`PdfToken`](../../token/classes/PdfToken.md)
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`equals`](../../token/classes/PdfToken.md#equals)
+
+---
+
+### toBytes()
+
+> **toBytes**(): [`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+#### Returns
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+#### Overrides
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`toBytes`](../../token/classes/PdfToken.md#tobytes)
+
+---
+
+### toString()
+
+> **toString**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`toString`](../../token/classes/PdfToken.md#tostring)

package/docs/core/tokens/xref-table-section-start-token/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / core/tokens/xref-table-section-start-token
+
+# core/tokens/xref-table-section-start-token
+
+## Classes
+
+- [PdfXRefTableSectionStartToken](classes/PdfXRefTableSectionStartToken.md)

package/docs/core/tokens/xref-table-section-start-token/classes/PdfXRefTableSectionStartToken.md

@@ -0,0 +1,137 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [core/tokens/xref-table-section-start-token](../README.md) / PdfXRefTableSectionStartToken
+
+# Class: PdfXRefTableSectionStartToken
+
+## Extends
+
+- [`PdfToken`](../../token/classes/PdfToken.md)
+
+## Constructors
+
+### Constructor
+
+> **new PdfXRefTableSectionStartToken**(`start`, `count`): `PdfXRefTableSectionStartToken`
+
+#### Parameters
+
+##### start
+
+`number` | [`PdfNumberToken`](../../number-token/classes/PdfNumberToken.md)
+
+##### count
+
+`number` | [`PdfNumberToken`](../../number-token/classes/PdfNumberToken.md)
+
+#### Returns
+
+`PdfXRefTableSectionStartToken`
+
+#### Overrides
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`constructor`](../../token/classes/PdfToken.md#constructor)
+
+## Properties
+
+### count
+
+> **count**: [`PdfNumberToken`](../../number-token/classes/PdfNumberToken.md)
+
+---
+
+### rawBytes
+
+> `protected` **rawBytes**: [`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`rawBytes`](../../token/classes/PdfToken.md#rawbytes)
+
+---
+
+### start
+
+> **start**: [`PdfNumberToken`](../../number-token/classes/PdfNumberToken.md)
+
+## Accessors
+
+### byteLength
+
+#### Get Signature
+
+> **get** **byteLength**(): `number`
+
+##### Returns
+
+`number`
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`byteLength`](../../token/classes/PdfToken.md#bytelength)
+
+---
+
+### type
+
+#### Get Signature
+
+> **get** **type**(): `string`
+
+##### Returns
+
+`string`
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`type`](../../token/classes/PdfToken.md#type)
+
+## Methods
+
+### equals()
+
+> **equals**(`other`): `boolean`
+
+#### Parameters
+
+##### other
+
+[`PdfToken`](../../token/classes/PdfToken.md)
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`equals`](../../token/classes/PdfToken.md#equals)
+
+---
+
+### toBytes()
+
+> **toBytes**(): [`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+#### Returns
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`toBytes`](../../token/classes/PdfToken.md#tobytes)
+
+---
+
+### toString()
+
+> **toString**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`toString`](../../token/classes/PdfToken.md#tostring)

package/docs/core/tokens/xref-table-start-token/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / core/tokens/xref-table-start-token
+
+# core/tokens/xref-table-start-token
+
+## Classes
+
+- [PdfXRefTableStartToken](classes/PdfXRefTableStartToken.md)

package/docs/core/tokens/xref-table-start-token/classes/PdfXRefTableStartToken.md

@@ -0,0 +1,127 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [core/tokens/xref-table-start-token](../README.md) / PdfXRefTableStartToken
+
+# Class: PdfXRefTableStartToken
+
+## Extends
+
+- [`PdfToken`](../../token/classes/PdfToken.md)
+
+## Constructors
+
+### Constructor
+
+> **new PdfXRefTableStartToken**(`byteOffset?`): `PdfXRefTableStartToken`
+
+#### Parameters
+
+##### byteOffset?
+
+`number`
+
+#### Returns
+
+`PdfXRefTableStartToken`
+
+#### Overrides
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`constructor`](../../token/classes/PdfToken.md#constructor)
+
+## Properties
+
+### byteOffset?
+
+> `optional` **byteOffset**: `number`
+
+---
+
+### rawBytes
+
+> `protected` **rawBytes**: [`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`rawBytes`](../../token/classes/PdfToken.md#rawbytes)
+
+## Accessors
+
+### byteLength
+
+#### Get Signature
+
+> **get** **byteLength**(): `number`
+
+##### Returns
+
+`number`
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`byteLength`](../../token/classes/PdfToken.md#bytelength)
+
+---
+
+### type
+
+#### Get Signature
+
+> **get** **type**(): `string`
+
+##### Returns
+
+`string`
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`type`](../../token/classes/PdfToken.md#type)
+
+## Methods
+
+### equals()
+
+> **equals**(`other`): `boolean`
+
+#### Parameters
+
+##### other
+
+[`PdfToken`](../../token/classes/PdfToken.md)
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`equals`](../../token/classes/PdfToken.md#equals)
+
+---
+
+### toBytes()
+
+> **toBytes**(): [`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+#### Returns
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`toBytes`](../../token/classes/PdfToken.md#tobytes)
+
+---
+
+### toString()
+
+> **toString**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[`PdfToken`](../../token/classes/PdfToken.md).[`toString`](../../token/classes/PdfToken.md#tostring)

package/docs/crypto/ciphers/aes128/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / crypto/ciphers/aes128
+
+# crypto/ciphers/aes128
+
+## Functions
+
+- [aes128](functions/aes128.md)

package/docs/crypto/ciphers/aes128/functions/aes128.md

@@ -0,0 +1,39 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/ciphers/aes128](../README.md) / aes128
+
+# Function: aes128()
+
+> **aes128**(`key`): [`Cipher`](../../../types/interfaces/Cipher.md)
+
+Creates an AES-128-CBC cipher for PDF encryption.
+The cipher prepends a zero IV to encrypted data during encryption
+and extracts the IV from the first 16 bytes during decryption.
+
+## Parameters
+
+### key
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The 16-byte encryption key.
+
+## Returns
+
+[`Cipher`](../../../types/interfaces/Cipher.md)
+
+A Cipher object with encrypt and decrypt methods.
+
+## Throws
+
+Error if the key is not exactly 16 bytes.
+
+## Example
+
+```typescript
+const cipher = aes128(key)
+const encrypted = await cipher.encrypt(plaintext)
+const decrypted = await cipher.decrypt(encrypted)
+```

package/docs/crypto/ciphers/aes256/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / crypto/ciphers/aes256
+
+# crypto/ciphers/aes256
+
+## Functions
+
+- [aes256](functions/aes256.md)

package/docs/crypto/ciphers/aes256/functions/aes256.md

@@ -0,0 +1,35 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/ciphers/aes256](../README.md) / aes256
+
+# Function: aes256()
+
+> **aes256**(`key`): [`Cipher`](../../../types/interfaces/Cipher.md)
+
+Creates an AES-256-CBC cipher for PDF encryption.
+The cipher prepends a zero IV to encrypted data during encryption
+and extracts the IV from the first 16 bytes during decryption.
+
+## Parameters
+
+### key
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The 32-byte encryption key.
+
+## Returns
+
+[`Cipher`](../../../types/interfaces/Cipher.md)
+
+A Cipher object with encrypt and decrypt methods.
+
+## Example
+
+```typescript
+const cipher = aes256(key)
+const encrypted = await cipher.encrypt(plaintext)
+const decrypted = await cipher.decrypt(encrypted)
+```

package/docs/crypto/ciphers/rc4/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / crypto/ciphers/rc4
+
+# crypto/ciphers/rc4
+
+## Functions
+
+- [rc4](functions/rc4.md)

package/docs/crypto/ciphers/rc4/functions/rc4.md

@@ -0,0 +1,35 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/ciphers/rc4](../README.md) / rc4
+
+# Function: rc4()
+
+> **rc4**(`key`): [`Cipher`](../../../types/interfaces/Cipher.md)
+
+Creates an RC4 cipher for PDF encryption.
+RC4 is a symmetric stream cipher where encryption and decryption
+use the same operation (XOR with the key stream).
+
+## Parameters
+
+### key
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The encryption key (variable length).
+
+## Returns
+
+[`Cipher`](../../../types/interfaces/Cipher.md)
+
+A Cipher object with encrypt and decrypt methods.
+
+## Example
+
+```typescript
+const cipher = rc4(key)
+const encrypted = await cipher.encrypt(plaintext)
+const decrypted = await cipher.decrypt(encrypted)
+```

package/docs/crypto/constants/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / crypto/constants
+
+# crypto/constants
+
+## Variables
+
+- [DEFAULT_PADDING](variables/DEFAULT_PADDING.md)

package/docs/crypto/constants/variables/DEFAULT_PADDING.md

@@ -0,0 +1,13 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [crypto/constants](../README.md) / DEFAULT_PADDING
+
+# Variable: DEFAULT_PADDING
+
+> `const` **DEFAULT_PADDING**: `Uint8Array`\<`ArrayBuffer`\>
+
+Default password padding used in PDF encryption.
+This 32-byte constant is defined in the PDF specification and is used
+to pad passwords shorter than 32 bytes during encryption key derivation.

package/docs/crypto/key-derivation/key-derivation/README.md

@@ -0,0 +1,13 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / crypto/key-derivation/key-derivation
+
+# crypto/key-derivation/key-derivation
+
+## Functions
+
+- [computeMasterKey](functions/computeMasterKey.md)
+- [deriveObjectKey](functions/deriveObjectKey.md)
+- [padPassword](functions/padPassword.md)

package/docs/crypto/key-derivation/key-derivation/functions/computeMasterKey.md

@@ -0,0 +1,57 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-derivation/key-derivation](../README.md) / computeMasterKey
+
+# Function: computeMasterKey()
+
+> **computeMasterKey**(`password`, `ownerKey`, `permissions`, `id0`, `keyLengthBits`, `encryptMetadata`, `revision`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Compute the master encryption key for a PDF file.
+
+## Parameters
+
+### password
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+User-supplied password (empty if no password)
+
+### ownerKey
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+Owner key (/O value)
+
+### permissions
+
+`number`
+
+/P value
+
+### id0
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+First element of /ID array
+
+### keyLengthBits
+
+`number`
+
+Usually 40, 128 or 256
+
+### encryptMetadata
+
+`boolean`
+
+Whether /EncryptMetadata is false
+
+### revision
+
+`number` = `3`
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>