pdf-lite 1.0.0 → 1.0.1-alpha.2

package/.github/workflows/docs.yaml

@@ -32,6 +32,8 @@ jobs:
         strategy:
             matrix:
                 version:
+                    - v1
+                    - latest
                     - ${{ github.ref_name }}
         steps:
             - name: Checkout ${{ matrix.version }}

package/EXAMPLES.md

@@ -1132,7 +1132,7 @@ async function findField(
         const name = fieldObj.content.get('T')
         if (name instanceof PdfString) {
             // Convert bytes to string for comparison
-            const nameStr = new TextDecoder().decode(name.raw)
+            const nameStr = name.value
             if (nameStr === fieldName) {
                 return fieldObj as PdfIndirectObject<PdfDictionary>
             }
@@ -1166,9 +1166,6 @@ if (subscribeFieldObj) {
     subscribeFieldObj.content.set('AS', new PdfName('Yes'))
 }
 
-// Commit the changes
-await filledDocument.commit()
-
 // Save the filled form
 await fs.writeFile(`${tmpFolder}/form-filled.pdf`, filledDocument.toBytes())
 console.log('Created form-filled.pdf with filled form fields')

package/docs/README.md

@@ -0,0 +1,127 @@
+**pdf-lite**
+
+---
+
+# pdf-lite
+
+## Packages
+
+- [core](core/README.md)
+- [core/decoder](core/decoder/README.md)
+- [core/generators](core/generators/README.md)
+- [core/incremental-parser](core/incremental-parser/README.md)
+- [core/objects/pdf-array](core/objects/pdf-array/README.md)
+- [core/objects/pdf-boolean](core/objects/pdf-boolean/README.md)
+- [core/objects/pdf-comment](core/objects/pdf-comment/README.md)
+- [core/objects/pdf-date](core/objects/pdf-date/README.md)
+- [core/objects/pdf-dictionary](core/objects/pdf-dictionary/README.md)
+- [core/objects/pdf-hexadecimal](core/objects/pdf-hexadecimal/README.md)
+- [core/objects/pdf-indirect-object](core/objects/pdf-indirect-object/README.md)
+- [core/objects/pdf-name](core/objects/pdf-name/README.md)
+- [core/objects/pdf-null](core/objects/pdf-null/README.md)
+- [core/objects/pdf-number](core/objects/pdf-number/README.md)
+- [core/objects/pdf-object](core/objects/pdf-object/README.md)
+- [core/objects/pdf-object-reference](core/objects/pdf-object-reference/README.md)
+- [core/objects/pdf-start-xref](core/objects/pdf-start-xref/README.md)
+- [core/objects/pdf-stream](core/objects/pdf-stream/README.md)
+- [core/objects/pdf-string](core/objects/pdf-string/README.md)
+- [core/objects/pdf-trailer](core/objects/pdf-trailer/README.md)
+- [core/objects/pdf-xref-table](core/objects/pdf-xref-table/README.md)
+- [core/parser](core/parser/README.md)
+- [core/ref](core/ref/README.md)
+- [core/serializer](core/serializer/README.md)
+- [core/streams/object-stream](core/streams/object-stream/README.md)
+- [core/tokeniser](core/tokeniser/README.md)
+- [core/tokens/boolean-token](core/tokens/boolean-token/README.md)
+- [core/tokens/byte-offset-token](core/tokens/byte-offset-token/README.md)
+- [core/tokens/comment-token](core/tokens/comment-token/README.md)
+- [core/tokens/end-array-token](core/tokens/end-array-token/README.md)
+- [core/tokens/end-dictionary-token](core/tokens/end-dictionary-token/README.md)
+- [core/tokens/end-object-token](core/tokens/end-object-token/README.md)
+- [core/tokens/end-stream-token](core/tokens/end-stream-token/README.md)
+- [core/tokens/hexadecimal-token](core/tokens/hexadecimal-token/README.md)
+- [core/tokens/name-token](core/tokens/name-token/README.md)
+- [core/tokens/null-token](core/tokens/null-token/README.md)
+- [core/tokens/number-token](core/tokens/number-token/README.md)
+- [core/tokens/object-reference-token](core/tokens/object-reference-token/README.md)
+- [core/tokens/start-array-token](core/tokens/start-array-token/README.md)
+- [core/tokens/start-dictionary-token](core/tokens/start-dictionary-token/README.md)
+- [core/tokens/start-object-token](core/tokens/start-object-token/README.md)
+- [core/tokens/start-stream-token](core/tokens/start-stream-token/README.md)
+- [core/tokens/start-xref-token](core/tokens/start-xref-token/README.md)
+- [core/tokens/stream-chunk-token](core/tokens/stream-chunk-token/README.md)
+- [core/tokens/string-token](core/tokens/string-token/README.md)
+- [core/tokens/token](core/tokens/token/README.md)
+- [core/tokens/trailer-token](core/tokens/trailer-token/README.md)
+- [core/tokens/whitespace-token](core/tokens/whitespace-token/README.md)
+- [core/tokens/xref-table-entry-token](core/tokens/xref-table-entry-token/README.md)
+- [core/tokens/xref-table-section-start-token](core/tokens/xref-table-section-start-token/README.md)
+- [core/tokens/xref-table-start-token](core/tokens/xref-table-start-token/README.md)
+- [crypto/ciphers/aes128](crypto/ciphers/aes128/README.md)
+- [crypto/ciphers/aes256](crypto/ciphers/aes256/README.md)
+- [crypto/ciphers/rc4](crypto/ciphers/rc4/README.md)
+- [crypto/constants](crypto/constants/README.md)
+- [crypto/key-derivation/key-derivation](crypto/key-derivation/key-derivation/README.md)
+- [crypto/key-derivation/key-derivation-aes256](crypto/key-derivation/key-derivation-aes256/README.md)
+- [crypto/key-gen/key-gen-aes256](crypto/key-gen/key-gen-aes256/README.md)
+- [crypto/key-gen/key-gen-rc4-128](crypto/key-gen/key-gen-rc4-128/README.md)
+- [crypto/key-gen/key-gen-rc4-40](crypto/key-gen/key-gen-rc4-40/README.md)
+- [crypto/types](crypto/types/README.md)
+- [crypto/utils](crypto/utils/README.md)
+- [filters/ascii85](filters/ascii85/README.md)
+- [filters/asciihex](filters/asciihex/README.md)
+- [filters/flate](filters/flate/README.md)
+- [filters/lzw](filters/lzw/README.md)
+- [filters/pass-through](filters/pass-through/README.md)
+- [filters/runlength](filters/runlength/README.md)
+- [filters/types](filters/types/README.md)
+- [index](index/README.md)
+- [pdf](pdf/README.md)
+- [pdf/errors](pdf/errors/README.md)
+- [pdf/pdf-document](pdf/pdf-document/README.md)
+- [pdf/pdf-reader](pdf/pdf-reader/README.md)
+- [pdf/pdf-revision](pdf/pdf-revision/README.md)
+- [pdf/pdf-xref-lookup](pdf/pdf-xref-lookup/README.md)
+- [security/crypt-filters/aesv2](security/crypt-filters/aesv2/README.md)
+- [security/crypt-filters/aesv3](security/crypt-filters/aesv3/README.md)
+- [security/crypt-filters/base](security/crypt-filters/base/README.md)
+- [security/crypt-filters/identity](security/crypt-filters/identity/README.md)
+- [security/crypt-filters/v2](security/crypt-filters/v2/README.md)
+- [security/handlers/base](security/handlers/base/README.md)
+- [security/handlers/pubSec](security/handlers/pubSec/README.md)
+- [security/handlers/utils](security/handlers/utils/README.md)
+- [security/handlers/v1](security/handlers/v1/README.md)
+- [security/handlers/v2](security/handlers/v2/README.md)
+- [security/handlers/v4](security/handlers/v4/README.md)
+- [security/handlers/v5](security/handlers/v5/README.md)
+- [security/types](security/types/README.md)
+- [signing](signing/README.md)
+- [signing/document-security-store](signing/document-security-store/README.md)
+- [signing/signatures](signing/signatures/README.md)
+- [signing/signatures/adbe-pkcs7-detached](signing/signatures/adbe-pkcs7-detached/README.md)
+- [signing/signatures/adbe-pkcs7-sha1](signing/signatures/adbe-pkcs7-sha1/README.md)
+- [signing/signatures/adbe-x509-rsa-sha1](signing/signatures/adbe-x509-rsa-sha1/README.md)
+- [signing/signatures/base](signing/signatures/base/README.md)
+- [signing/signatures/etsi-cades-detached](signing/signatures/etsi-cades-detached/README.md)
+- [signing/signatures/etsi-rfc3161](signing/signatures/etsi-rfc3161/README.md)
+- [signing/signer](signing/signer/README.md)
+- [signing/types](signing/types/README.md)
+- [signing/utils](signing/utils/README.md)
+- [types](types/README.md)
+- [utils/algos](utils/algos/README.md)
+- [utils/assert](utils/assert/README.md)
+- [utils/bytesToHex](utils/bytesToHex/README.md)
+- [utils/bytesToHexBytes](utils/bytesToHexBytes/README.md)
+- [utils/bytesToString](utils/bytesToString/README.md)
+- [utils/concatUint8Arrays](utils/concatUint8Arrays/README.md)
+- [utils/escapeString](utils/escapeString/README.md)
+- [utils/hexBytesToBytes](utils/hexBytesToBytes/README.md)
+- [utils/hexBytesToString](utils/hexBytesToString/README.md)
+- [utils/hexToBytes](utils/hexToBytes/README.md)
+- [utils/IterableReadableStream](utils/IterableReadableStream/README.md)
+- [utils/padBytes](utils/padBytes/README.md)
+- [utils/predictors](utils/predictors/README.md)
+- [utils/replaceInBuffer](utils/replaceInBuffer/README.md)
+- [utils/stringToBytes](utils/stringToBytes/README.md)
+- [utils/stringToHexBytes](utils/stringToHexBytes/README.md)
+- [utils/unescapeString](utils/unescapeString/README.md)

package/docs/core/README.md

@@ -0,0 +1,43 @@
+[**pdf-lite**](../README.md)
+
+---
+
+[pdf-lite](../README.md) / core
+
+# core
+
+## References
+
+### objectToTokens
+
+Re-exports [objectToTokens](tokeniser/functions/objectToTokens.md)
+
+---
+
+### PdfByteStreamTokeniser
+
+Re-exports [PdfByteStreamTokeniser](tokeniser/classes/PdfByteStreamTokeniser.md)
+
+---
+
+### PdfDecoder
+
+Re-exports [PdfDecoder](decoder/classes/PdfDecoder.md)
+
+---
+
+### pdfObjectStreamTokeniser
+
+Re-exports [pdfObjectStreamTokeniser](tokeniser/functions/pdfObjectStreamTokeniser.md)
+
+---
+
+### PdfObjectTokeniser
+
+Re-exports [PdfObjectTokeniser](tokeniser/classes/PdfObjectTokeniser.md)
+
+---
+
+### PdfTokeniser
+
+Re-exports [PdfTokeniser](tokeniser/type-aliases/PdfTokeniser.md)

package/docs/core/decoder/README.md

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

package/docs/core/decoder/classes/PdfDecoder.md

@@ -0,0 +1,362 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [core/decoder](../README.md) / PdfDecoder
+
+# Class: PdfDecoder
+
+Decodes PDF tokens into PDF objects.
+Handles parsing of all PDF object types including dictionaries, arrays, streams, and xref tables.
+
+## Extends
+
+- [`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md)\<[`PdfToken`](../../tokens/token/classes/PdfToken.md), [`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)\>
+
+## Constructors
+
+### Constructor
+
+> **new PdfDecoder**(`options?`): `PdfDecoder`
+
+Creates a new PDF decoder.
+
+#### Parameters
+
+##### options?
+
+Configuration options
+
+###### ignoreWhitespace?
+
+`boolean`
+
+If true, whitespace tokens are ignored
+
+###### maxBufferSizeBytes?
+
+`number`
+
+Maximum buffer size before compaction (default: 10MB)
+
+#### Returns
+
+`PdfDecoder`
+
+#### Overrides
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`constructor`](../../incremental-parser/classes/IncrementalParser.md#constructor)
+
+## Properties
+
+### buffer
+
+> `protected` **buffer**: [`PdfToken`](../../tokens/token/classes/PdfToken.md)[] = `[]`
+
+Buffer holding input items
+
+#### Inherited from
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`buffer`](../../incremental-parser/classes/IncrementalParser.md#buffer)
+
+---
+
+### bufferIndex
+
+> `protected` **bufferIndex**: `number` = `0`
+
+Current position in the buffer
+
+#### Inherited from
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`bufferIndex`](../../incremental-parser/classes/IncrementalParser.md#bufferindex)
+
+---
+
+### eof
+
+> **eof**: `boolean` = `false`
+
+Whether end of file has been signaled
+
+#### Inherited from
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`eof`](../../incremental-parser/classes/IncrementalParser.md#eof)
+
+---
+
+### inputOffset
+
+> `protected` **inputOffset**: `number` = `0`
+
+Current position in the input stream
+
+#### Inherited from
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`inputOffset`](../../incremental-parser/classes/IncrementalParser.md#inputoffset)
+
+---
+
+### outputOffset
+
+> `protected` **outputOffset**: `number` = `0`
+
+Number of outputs generated
+
+#### Inherited from
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`outputOffset`](../../incremental-parser/classes/IncrementalParser.md#outputoffset)
+
+## Methods
+
+### atEof()
+
+> `protected` **atEof**(): `boolean`
+
+Checks if end of file has been reached and buffer is exhausted.
+
+#### Returns
+
+`boolean`
+
+True if no more input is available
+
+#### Inherited from
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`atEof`](../../incremental-parser/classes/IncrementalParser.md#ateof)
+
+---
+
+### bufferSize()
+
+> `protected` **bufferSize**(): `number`
+
+#### Returns
+
+`number`
+
+---
+
+### canCompact()
+
+> `protected` **canCompact**(): `boolean`
+
+Override to customize when to compact the buffer
+By default, compacts when more than 1000 items have been consumed
+
+#### Returns
+
+`boolean`
+
+boolean indicating whether to compact the buffer
+
+#### Overrides
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`canCompact`](../../incremental-parser/classes/IncrementalParser.md#cancompact)
+
+---
+
+### compact()
+
+> `protected` **compact**(): `void`
+
+Compacts the buffer by removing consumed items
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`compact`](../../incremental-parser/classes/IncrementalParser.md#compact)
+
+---
+
+### expect()
+
+> `protected` **expect**\<`T`\>(`itemType`): `T`
+
+Consumes and validates the next item against an expected type or value.
+
+#### Type Parameters
+
+##### T
+
+`T` _extends_ [`PdfToken`](../../tokens/token/classes/PdfToken.md)
+
+The expected item type
+
+#### Parameters
+
+##### itemType
+
+Constructor or value to match against
+
+`T` | (...`args`) => `T`
+
+#### Returns
+
+`T`
+
+The consumed item cast to the expected type
+
+#### Throws
+
+Error if the item doesn't match the expected type/value
+
+#### Inherited from
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`expect`](../../incremental-parser/classes/IncrementalParser.md#expect)
+
+---
+
+### feed()
+
+> **feed**(...`input`): `void`
+
+Feeds input items into the parser buffer.
+
+#### Parameters
+
+##### input
+
+...([`PdfToken`](../../tokens/token/classes/PdfToken.md) \| [`PdfToken`](../../tokens/token/classes/PdfToken.md)[])[]
+
+Input items to add to the buffer
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`feed`](../../incremental-parser/classes/IncrementalParser.md#feed)
+
+---
+
+### next()
+
+> `protected` **next**(): [`PdfToken`](../../tokens/token/classes/PdfToken.md)
+
+Consumes and returns the next item from the buffer.
+
+#### Returns
+
+[`PdfToken`](../../tokens/token/classes/PdfToken.md)
+
+The next item
+
+#### Throws
+
+NoMoreTokensError if more input is needed and EOF not signaled
+
+#### Throws
+
+EofReachedError if at EOF and no more items available
+
+#### Inherited from
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`next`](../../incremental-parser/classes/IncrementalParser.md#next)
+
+---
+
+### nextItems()
+
+> **nextItems**(): `Generator`\<[`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)\>
+
+Generates parsed output items from the buffer.
+Handles backtracking when more input is needed.
+
+#### Returns
+
+`Generator`\<[`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)\>
+
+A generator yielding parsed output items
+
+#### Inherited from
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`nextItems`](../../incremental-parser/classes/IncrementalParser.md#nextitems)
+
+---
+
+### oneOf()
+
+> `protected` **oneOf**(...`fn`): [`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)
+
+Tries multiple parsing functions and returns the first successful result.
+Automatically backtracks on failure.
+
+#### Parameters
+
+##### fn
+
+...() => [`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)[]
+
+Array of parsing functions to try
+
+#### Returns
+
+[`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)
+
+The result from the first successful parsing function
+
+#### Throws
+
+NoMoreTokensError if any function needs more input
+
+#### Throws
+
+Error if all parsing functions fail
+
+#### Inherited from
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`oneOf`](../../incremental-parser/classes/IncrementalParser.md#oneof)
+
+---
+
+### parse()
+
+> `protected` **parse**(): [`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)
+
+Abstract method to parse the next output item from the buffer.
+Subclasses must implement this to define parsing logic.
+
+#### Returns
+
+[`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)
+
+The parsed output item
+
+#### Overrides
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`parse`](../../incremental-parser/classes/IncrementalParser.md#parse)
+
+---
+
+### peek()
+
+> `protected` **peek**(`ahead`): [`PdfToken`](../../tokens/token/classes/PdfToken.md) \| `null`
+
+Peeks at an item in the buffer without consuming it.
+
+#### Parameters
+
+##### ahead
+
+`number` = `0`
+
+Number of positions to look ahead (default: 0)
+
+#### Returns
+
+[`PdfToken`](../../tokens/token/classes/PdfToken.md) \| `null`
+
+The item at the peek position, or null if at EOF
+
+#### Throws
+
+NoMoreTokensError if more input is needed and EOF not signaled
+
+#### Inherited from
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`peek`](../../incremental-parser/classes/IncrementalParser.md#peek)

package/docs/core/generators/README.md

@@ -0,0 +1,14 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / core/generators
+
+# core/generators
+
+## Functions
+
+- [bytesToPdfObjects](functions/bytesToPdfObjects.md)
+- [pdfDecoder](functions/pdfDecoder.md)
+- [pdfDecoderAsync](functions/pdfDecoderAsync.md)
+- [stringToPdfObjects](functions/stringToPdfObjects.md)

package/docs/core/generators/functions/bytesToPdfObjects.md

@@ -0,0 +1,26 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [core/generators](../README.md) / bytesToPdfObjects
+
+# Function: bytesToPdfObjects()
+
+> **bytesToPdfObjects**(`bytes`): `Generator`\<[`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)\>
+
+Converts an iterable of byte arrays into PDF objects.
+Processes bytes through tokenization and decoding.
+
+## Parameters
+
+### bytes
+
+`Iterable`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Iterable of byte arrays to process
+
+## Returns
+
+`Generator`\<[`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)\>
+
+A generator yielding parsed PDF objects

package/docs/core/generators/functions/pdfDecoder.md

@@ -0,0 +1,36 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [core/generators](../README.md) / pdfDecoder
+
+# Function: pdfDecoder()
+
+> **pdfDecoder**(`input`, `options?`): `Generator`\<[`PdfObject`](../../objects/pdf-object/classes/PdfObject.md), `void`, `any`\>
+
+Decodes an iterable of byte arrays into PDF objects.
+Allows configuring whitespace handling.
+
+## Parameters
+
+### input
+
+`Iterable`\<[`ByteArray`](../../../types/type-aliases/ByteArray.md)\>
+
+Iterable of byte arrays to decode
+
+### options?
+
+Configuration options
+
+#### ignoreWhitespace?
+
+`boolean`
+
+If true, whitespace tokens are ignored
+
+## Returns
+
+`Generator`\<[`PdfObject`](../../objects/pdf-object/classes/PdfObject.md), `void`, `any`\>
+
+A generator yielding parsed PDF objects

package/docs/core/generators/functions/pdfDecoderAsync.md

@@ -0,0 +1,26 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [core/generators](../README.md) / pdfDecoderAsync
+
+# Function: pdfDecoderAsync()
+
+> **pdfDecoderAsync**(`input`): `AsyncGenerator`\<[`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)\>
+
+Asynchronously decodes byte arrays into PDF objects.
+Supports both async and sync iterables for streaming PDF parsing.
+
+## 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
+
+`AsyncGenerator`\<[`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)\>
+
+An async generator yielding parsed PDF objects