pdf-lite 1.0.0 → 1.0.1-alpha.2

package/docs/crypto/key-gen/key-gen-rc4-40/functions/decryptUserPasswordRc4_40.md

@@ -0,0 +1,38 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-gen/key-gen-rc4-40](../README.md) / decryptUserPasswordRc4_40
+
+# Function: decryptUserPasswordRc4_40()
+
+> **decryptUserPasswordRc4_40**(`ownerPw`, `ownerKey`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Decrypts the user password from the /O value using RC4-40.
+Used to recover the user password when the owner password is known.
+
+## Parameters
+
+### ownerPw
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The owner password.
+
+### ownerKey
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The /O value from the encryption dictionary.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the decrypted user password (with padding removed).
+
+## Example
+
+```typescript
+const userPassword = await decryptUserPasswordRc4_40(ownerPw, O)
+```

package/docs/crypto/types/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / crypto/types
+
+# crypto/types
+
+## Interfaces
+
+- [Cipher](interfaces/Cipher.md)

package/docs/crypto/types/interfaces/Cipher.md

@@ -0,0 +1,39 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [crypto/types](../README.md) / Cipher
+
+# Interface: Cipher
+
+## Methods
+
+### decrypt()
+
+> **decrypt**(`data`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+#### Parameters
+
+##### data
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+#### Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+---
+
+### encrypt()
+
+> **encrypt**(`data`): `Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+#### Parameters
+
+##### data
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+#### Returns
+
+`Promise`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>

package/docs/crypto/utils/README.md

@@ -0,0 +1,13 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / crypto/utils
+
+# crypto/utils
+
+## Functions
+
+- [int32ToLittleEndianBytes](functions/int32ToLittleEndianBytes.md)
+- [padPassword](functions/padPassword.md)
+- [removePdfPasswordPadding](functions/removePdfPasswordPadding.md)

package/docs/crypto/utils/functions/int32ToLittleEndianBytes.md

@@ -0,0 +1,31 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [crypto/utils](../README.md) / int32ToLittleEndianBytes
+
+# Function: int32ToLittleEndianBytes()
+
+> **int32ToLittleEndianBytes**(`value`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+Converts a 32-bit integer to a 4-byte little-endian byte array.
+
+## Parameters
+
+### value
+
+`number`
+
+The 32-bit integer to convert.
+
+## Returns
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+A 4-byte array in little-endian order.
+
+## Example
+
+```typescript
+int32ToLittleEndianBytes(0x12345678) // Returns [0x78, 0x56, 0x34, 0x12]
+```

package/docs/crypto/utils/functions/padPassword.md

@@ -0,0 +1,33 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [crypto/utils](../README.md) / padPassword
+
+# Function: padPassword()
+
+> **padPassword**(`password`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+Pads a password to exactly 32 bytes using the PDF standard padding.
+If the password is shorter than 32 bytes, it is padded with bytes from DEFAULT_PADDING.
+If the password is 32 bytes or longer, only the first 32 bytes are used.
+
+## Parameters
+
+### password
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The password to pad.
+
+## Returns
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+A 32-byte padded password.
+
+## Example
+
+```typescript
+const padded = padPassword(new Uint8Array([1, 2, 3])) // Returns 32-byte array
+```

package/docs/crypto/utils/functions/removePdfPasswordPadding.md

@@ -0,0 +1,32 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [crypto/utils](../README.md) / removePdfPasswordPadding
+
+# Function: removePdfPasswordPadding()
+
+> **removePdfPasswordPadding**(`buffer`): `Uint8Array`\<`ArrayBuffer`\>
+
+Removes PDF standard password padding from a buffer.
+Searches from the end of the buffer for the padding pattern and removes it.
+
+## Parameters
+
+### buffer
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The buffer with potential password padding.
+
+## Returns
+
+`Uint8Array`\<`ArrayBuffer`\>
+
+The buffer with padding removed.
+
+## Example
+
+```typescript
+const unpadded = removePdfPasswordPadding(paddedPassword)
+```

package/docs/filters/ascii85/README.md

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

package/docs/filters/ascii85/functions/ascii85.md

@@ -0,0 +1,27 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [filters/ascii85](../README.md) / ascii85
+
+# Function: ascii85()
+
+> **ascii85**(): [`PdfFilter`](../../types/interfaces/PdfFilter.md)
+
+Creates an ASCII85 filter for encoding and decoding PDF stream data.
+ASCII85 (also known as Base85) encodes binary data into ASCII characters,
+resulting in a 25% expansion compared to the original data.
+
+## Returns
+
+[`PdfFilter`](../../types/interfaces/PdfFilter.md)
+
+A PdfFilter object with encode and decode methods.
+
+## Example
+
+```typescript
+const filter = ascii85()
+const encoded = filter.encode(binaryData)
+const decoded = filter.decode(encoded)
+```

package/docs/filters/asciihex/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / filters/asciihex
+
+# filters/asciihex
+
+## Functions
+
+- [asciiHex](functions/asciiHex.md)

package/docs/filters/asciihex/functions/asciiHex.md

@@ -0,0 +1,27 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [filters/asciihex](../README.md) / asciiHex
+
+# Function: asciiHex()
+
+> **asciiHex**(): [`PdfFilter`](../../types/interfaces/PdfFilter.md)
+
+Creates an ASCIIHex filter for encoding and decoding PDF stream data.
+ASCIIHex encodes binary data as pairs of hexadecimal digits,
+resulting in a 100% expansion compared to the original data.
+
+## Returns
+
+[`PdfFilter`](../../types/interfaces/PdfFilter.md)
+
+A PdfFilter object with encode and decode methods.
+
+## Example
+
+```typescript
+const filter = asciiHex()
+const encoded = filter.encode(binaryData)
+const decoded = filter.decode(encoded)
+```

package/docs/filters/flate/README.md

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

package/docs/filters/flate/functions/flate.md

@@ -0,0 +1,26 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [filters/flate](../README.md) / flate
+
+# Function: flate()
+
+> **flate**(): [`PdfFilter`](../../types/interfaces/PdfFilter.md)
+
+Creates a Flate filter for compressing and decompressing PDF stream data.
+Uses the DEFLATE compression algorithm (same as zlib/gzip).
+
+## Returns
+
+[`PdfFilter`](../../types/interfaces/PdfFilter.md)
+
+A PdfFilter object with encode and decode methods.
+
+## Example
+
+```typescript
+const filter = flate()
+const compressed = filter.encode(rawData)
+const decompressed = filter.decode(compressed)
+```

package/docs/filters/lzw/README.md

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

package/docs/filters/lzw/functions/lzw.md

@@ -0,0 +1,27 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [filters/lzw](../README.md) / lzw
+
+# Function: lzw()
+
+> **lzw**(): [`PdfFilter`](../../types/interfaces/PdfFilter.md)
+
+Creates an LZW filter for encoding and decoding PDF stream data.
+LZW (Lempel-Ziv-Welch) is a lossless compression algorithm.
+This is a minimal implementation for PDF (12-bit, no early change, no predictor).
+
+## Returns
+
+[`PdfFilter`](../../types/interfaces/PdfFilter.md)
+
+A PdfFilter object with encode and decode methods.
+
+## Example
+
+```typescript
+const filter = lzw()
+const compressed = filter.encode(rawData)
+const decompressed = filter.decode(compressed)
+```

package/docs/filters/pass-through/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / filters/pass-through
+
+# filters/pass-through
+
+## Functions
+
+- [passthroughFilter](functions/passthroughFilter.md)

package/docs/filters/pass-through/functions/passthroughFilter.md

@@ -0,0 +1,25 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [filters/pass-through](../README.md) / passthroughFilter
+
+# Function: passthroughFilter()
+
+> **passthroughFilter**(): [`PdfFilter`](../../types/interfaces/PdfFilter.md)
+
+Creates a pass-through filter that performs no transformation.
+Returns data unchanged, useful for testing or as a placeholder filter.
+
+## Returns
+
+[`PdfFilter`](../../types/interfaces/PdfFilter.md)
+
+A PdfFilter object with encode and decode methods that return data unchanged.
+
+## Example
+
+```typescript
+const filter = passthroughFilter()
+const result = filter.encode(data) // Returns data unchanged
+```

package/docs/filters/runlength/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / filters/runlength
+
+# filters/runlength
+
+## Functions
+
+- [runLength](functions/runLength.md)

package/docs/filters/runlength/functions/runLength.md

@@ -0,0 +1,27 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [filters/runlength](../README.md) / runLength
+
+# Function: runLength()
+
+> **runLength**(): [`PdfFilter`](../../types/interfaces/PdfFilter.md)
+
+Creates a Run-Length filter for encoding and decoding PDF stream data.
+Run-Length encoding is a simple compression algorithm that replaces
+sequences of repeated bytes with a count and the byte value.
+
+## Returns
+
+[`PdfFilter`](../../types/interfaces/PdfFilter.md)
+
+A PdfFilter object with encode and decode methods.
+
+## Example
+
+```typescript
+const filter = runLength()
+const compressed = filter.encode(rawData)
+const decompressed = filter.decode(compressed)
+```

package/docs/filters/types/README.md

@@ -0,0 +1,19 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / filters/types
+
+# filters/types
+
+## Interfaces
+
+- [PdfFilter](interfaces/PdfFilter.md)
+
+## Type Aliases
+
+- [PdfStreamFilterType](type-aliases/PdfStreamFilterType.md)
+
+## Variables
+
+- [PDF_FILTER_TYPES](variables/PDF_FILTER_TYPES.md)

package/docs/filters/types/interfaces/PdfFilter.md

@@ -0,0 +1,39 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [filters/types](../README.md) / PdfFilter
+
+# Interface: PdfFilter
+
+## Methods
+
+### decode()
+
+> **decode**(`data`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+#### Parameters
+
+##### data
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+#### Returns
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+---
+
+### encode()
+
+> **encode**(`data`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+#### Parameters
+
+##### data
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+#### Returns
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)

package/docs/filters/types/type-aliases/PdfStreamFilterType.md

@@ -0,0 +1,9 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [filters/types](../README.md) / PdfStreamFilterType
+
+# Type Alias: PdfStreamFilterType
+
+> **PdfStreamFilterType** = keyof _typeof_ [`PDF_FILTER_TYPES`](../variables/PDF_FILTER_TYPES.md)

package/docs/filters/types/variables/PDF_FILTER_TYPES.md

@@ -0,0 +1,51 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [filters/types](../README.md) / PDF_FILTER_TYPES
+
+# Variable: PDF_FILTER_TYPES
+
+> `const` **PDF_FILTER_TYPES**: `object`
+
+## Type Declaration
+
+### ASCII85Decode
+
+> `readonly` **ASCII85Decode**: `"ASCII85Decode"` = `'ASCII85Decode'`
+
+### ASCIIHexDecode
+
+> `readonly` **ASCIIHexDecode**: `"ASCIIHexDecode"` = `'ASCIIHexDecode'`
+
+### CCITTFaxDecode
+
+> `readonly` **CCITTFaxDecode**: `"CCITTFaxDecode"` = `'CCITTFaxDecode'`
+
+### Crypt
+
+> `readonly` **Crypt**: `"Crypt"` = `'Crypt'`
+
+### DCTDecode
+
+> `readonly` **DCTDecode**: `"DCTDecode"` = `'DCTDecode'`
+
+### Fl
+
+> `readonly` **Fl**: `"Fl"` = `'Fl'`
+
+### FlateDecode
+
+> `readonly` **FlateDecode**: `"FlateDecode"` = `'FlateDecode'`
+
+### JPXDecode
+
+> `readonly` **JPXDecode**: `"JPXDecode"` = `'JPXDecode'`
+
+### LZWDecode
+
+> `readonly` **LZWDecode**: `"LZWDecode"` = `'LZWDecode'`
+
+### RunLengthDecode
+
+> `readonly` **RunLengthDecode**: `"RunLengthDecode"` = `'RunLengthDecode'`