pdf-lite 1.0.0 → 1.0.1-alpha.2

package/docs/utils/algos/functions/aes128cbcDecrypt.md

@@ -0,0 +1,47 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / aes128cbcDecrypt
+
+# Function: aes128cbcDecrypt()
+
+> **aes128cbcDecrypt**(`key`, `encrypted`, `iv`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Decrypts data using AES-128-CBC mode.
+
+## Parameters
+
+### key
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The 16-byte decryption key.
+
+### encrypted
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The encrypted data to decrypt.
+
+### iv
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md) = `...`
+
+The 16-byte initialization vector. Defaults to zero IV.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the decrypted data.
+
+## Throws
+
+Error if the key is not exactly 16 bytes or encrypted data is too short.
+
+## Example
+
+```typescript
+const decrypted = await aes128cbcDecrypt(key, ciphertext, iv)
+```

package/docs/utils/algos/functions/aes128cbcEncrypt.md

@@ -0,0 +1,47 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / aes128cbcEncrypt
+
+# Function: aes128cbcEncrypt()
+
+> **aes128cbcEncrypt**(`key`, `data`, `iv`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Encrypts data using AES-128-CBC mode.
+
+## Parameters
+
+### key
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The 16-byte encryption key.
+
+### data
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The data to encrypt.
+
+### iv
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md) = `...`
+
+The 16-byte initialization vector. Defaults to zero IV.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the encrypted data.
+
+## Throws
+
+Error if the key is not exactly 16 bytes.
+
+## Example
+
+```typescript
+const encrypted = await aes128cbcEncrypt(key, plaintext, iv)
+```

package/docs/utils/algos/functions/aes256CbcNoPaddingDecrypt.md

@@ -0,0 +1,43 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / aes256CbcNoPaddingDecrypt
+
+# Function: aes256CbcNoPaddingDecrypt()
+
+> **aes256CbcNoPaddingDecrypt**(`key`, `ciphertext`, `iv`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Decrypts data using AES-256-CBC mode without PKCS#7 padding.
+
+## Parameters
+
+### key
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The 32-byte decryption key.
+
+### ciphertext
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The encrypted data to decrypt.
+
+### iv
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md) = `...`
+
+The 16-byte initialization vector. Defaults to zero IV.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the decrypted data.
+
+## Example
+
+```typescript
+const decrypted = await aes256CbcNoPaddingDecrypt(key, ciphertext, iv)
+```

package/docs/utils/algos/functions/aes256CbcNoPaddingEncrypt.md

@@ -0,0 +1,43 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / aes256CbcNoPaddingEncrypt
+
+# Function: aes256CbcNoPaddingEncrypt()
+
+> **aes256CbcNoPaddingEncrypt**(`key`, `data`, `iv`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Encrypts data using AES-256-CBC mode without PKCS#7 padding.
+
+## Parameters
+
+### key
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The 32-byte encryption key.
+
+### data
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The data to encrypt. Must be a multiple of 16 bytes.
+
+### iv
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The 16-byte initialization vector.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the encrypted data.
+
+## Example
+
+```typescript
+const encrypted = await aes256CbcNoPaddingEncrypt(key, data, iv)
+```

package/docs/utils/algos/functions/aes256cbcDecrypt.md

@@ -0,0 +1,43 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / aes256cbcDecrypt
+
+# Function: aes256cbcDecrypt()
+
+> **aes256cbcDecrypt**(`fileKey`, `ciphertext`, `iv`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Decrypts data using AES-256-CBC mode.
+
+## Parameters
+
+### fileKey
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The 32-byte decryption key.
+
+### ciphertext
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The encrypted data to decrypt.
+
+### iv
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md) = `...`
+
+The 16-byte initialization vector. Defaults to zero IV.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the decrypted data.
+
+## Example
+
+```typescript
+const decrypted = await aes256cbcDecrypt(key, ciphertext, iv)
+```

package/docs/utils/algos/functions/aes256cbcEncrypt.md

@@ -0,0 +1,43 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / aes256cbcEncrypt
+
+# Function: aes256cbcEncrypt()
+
+> **aes256cbcEncrypt**(`fileKey`, `block`, `iv`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Encrypts data using AES-256-CBC mode.
+
+## Parameters
+
+### fileKey
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The 32-byte encryption key.
+
+### block
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The data to encrypt.
+
+### iv
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md) = `...`
+
+The 16-byte initialization vector. Defaults to zero IV.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the encrypted data.
+
+## Example
+
+```typescript
+const encrypted = await aes256cbcEncrypt(key, plaintext, iv)
+```

package/docs/utils/algos/functions/aes256ecbDecrypt.md

@@ -0,0 +1,41 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / aes256ecbDecrypt
+
+# Function: aes256ecbDecrypt()
+
+> **aes256ecbDecrypt**(`fileKey`, `encrypted`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Decrypts data using AES-256-ECB mode.
+
+## Parameters
+
+### fileKey
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The 32-byte decryption key.
+
+### encrypted
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The encrypted data to decrypt.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the decrypted data.
+
+## Throws
+
+Error if the key is not exactly 32 bytes.
+
+## Example
+
+```typescript
+const decrypted = await aes256ecbDecrypt(key, ciphertext)
+```

package/docs/utils/algos/functions/aes256ecbEncrypt.md

@@ -0,0 +1,41 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / aes256ecbEncrypt
+
+# Function: aes256ecbEncrypt()
+
+> **aes256ecbEncrypt**(`fileKey`, `data`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Encrypts data using AES-256-ECB mode.
+
+## Parameters
+
+### fileKey
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The 32-byte encryption key.
+
+### data
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The data to encrypt.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the encrypted data.
+
+## Throws
+
+Error if the key is not exactly 32 bytes.
+
+## Example
+
+```typescript
+const encrypted = await aes256ecbEncrypt(key, plaintext)
+```

package/docs/utils/algos/functions/deflateData.md

@@ -0,0 +1,31 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / deflateData
+
+# Function: deflateData()
+
+> **deflateData**(`data`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+Compresses data using the DEFLATE algorithm.
+
+## Parameters
+
+### data
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The data to compress.
+
+## Returns
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The compressed data as a byte array.
+
+## Example
+
+```typescript
+const compressed = deflateData(rawData)
+```

package/docs/utils/algos/functions/getRandomBytes.md

@@ -0,0 +1,35 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / getRandomBytes
+
+# Function: getRandomBytes()
+
+> **getRandomBytes**(`length`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+Generates cryptographically secure random bytes.
+
+## Parameters
+
+### length
+
+`number`
+
+The number of random bytes to generate.
+
+## Returns
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+A byte array containing random bytes.
+
+## Throws
+
+Error if length is not a positive integer.
+
+## Example
+
+```typescript
+const randomBytes = getRandomBytes(16) // 16 random bytes
+```

package/docs/utils/algos/functions/hash.md

@@ -0,0 +1,41 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / hash
+
+# Function: hash()
+
+> **hash**(`input`, `algorithm`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Computes a cryptographic hash of the input data using the specified algorithm.
+
+## Parameters
+
+### input
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The data to hash.
+
+### algorithm
+
+The hash algorithm to use. Defaults to 'SHA-256'.
+
+`"SHA-1"` | `"SHA-256"` | `"SHA-384"` | `"SHA-512"` | `"MD5"`
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the hash as a byte array.
+
+## Throws
+
+Error if an unsupported hash algorithm is specified.
+
+## Example
+
+```typescript
+const hash = await hash(data, 'SHA-256')
+```

package/docs/utils/algos/functions/inflateData.md

@@ -0,0 +1,35 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / inflateData
+
+# Function: inflateData()
+
+> **inflateData**(`data`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+Decompresses data using the INFLATE algorithm (reverses DEFLATE).
+
+## Parameters
+
+### data
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The compressed data to decompress.
+
+## Returns
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The decompressed data as a byte array.
+
+## Throws
+
+Error if inflation fails due to invalid or corrupted data.
+
+## Example
+
+```typescript
+const decompressed = inflateData(compressedData)
+```

package/docs/utils/algos/functions/md5.md

@@ -0,0 +1,31 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / md5
+
+# Function: md5()
+
+> **md5**(`input`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Computes the MD5 hash of the input data.
+
+## Parameters
+
+### input
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The data to hash.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the MD5 hash as a byte array.
+
+## Example
+
+```typescript
+const hash = await md5(new Uint8Array([1, 2, 3]))
+```

package/docs/utils/algos/functions/sha1.md

@@ -0,0 +1,31 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / sha1
+
+# Function: sha1()
+
+> **sha1**(`input`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Computes the SHA-1 hash of the input data.
+
+## Parameters
+
+### input
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The data to hash.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the SHA-1 hash as a byte array.
+
+## Example
+
+```typescript
+const hash = await sha1(new Uint8Array([1, 2, 3]))
+```

package/docs/utils/algos/functions/sha256.md

@@ -0,0 +1,31 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / sha256
+
+# Function: sha256()
+
+> **sha256**(`input`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Computes the SHA-256 hash of the input data.
+
+## Parameters
+
+### input
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The data to hash.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the SHA-256 hash as a byte array.
+
+## Example
+
+```typescript
+const hash = await sha256(new Uint8Array([1, 2, 3]))
+```

package/docs/utils/algos/functions/sha384.md

@@ -0,0 +1,31 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / sha384
+
+# Function: sha384()
+
+> **sha384**(`input`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Computes the SHA-384 hash of the input data.
+
+## Parameters
+
+### input
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The data to hash.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the SHA-384 hash as a byte array.
+
+## Example
+
+```typescript
+const hash = await sha384(new Uint8Array([1, 2, 3]))
+```

package/docs/utils/algos/functions/sha512.md

@@ -0,0 +1,31 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/algos](../README.md) / sha512
+
+# Function: sha512()
+
+> **sha512**(`input`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Computes the SHA-512 hash of the input data.
+
+## Parameters
+
+### input
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The data to hash.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the SHA-512 hash as a byte array.
+
+## Example
+
+```typescript
+const hash = await sha512(new Uint8Array([1, 2, 3]))
+```

package/docs/utils/assert/README.md

@@ -0,0 +1,12 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / utils/assert
+
+# utils/assert
+
+## Functions
+
+- [assert](functions/assert.md)
+- [assertIfDefined](functions/assertIfDefined.md)