pdf-lite 1.0.0 → 1.0.1-alpha.2

package/docs/core/streams/object-stream/classes/PdfObjectStream.md

@@ -0,0 +1,69 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [core/streams/object-stream](../README.md) / PdfObjectStream
+
+# Class: PdfObjectStream
+
+A ReadableStream that supports async iteration.
+Extends the standard ReadableStream with Symbol.asyncIterator support.
+
+## Example
+
+```typescript
+const stream = new IterableReadableStream<Uint8Array>(...)
+for await (const chunk of stream) {
+  console.log(chunk)
+}
+```
+
+## Extends
+
+- [`IterableReadableStream`](../../../../utils/IterableReadableStream/classes/IterableReadableStream.md)\<[`PdfObject`](../../../objects/pdf-object/classes/PdfObject.md)\>
+
+## Constructors
+
+### Constructor
+
+> **new PdfObjectStream**(`input`): `PdfObjectStream`
+
+#### Parameters
+
+##### input
+
+`Iterable`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md), `any`, `any`\> | `AsyncIterable`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md), `any`, `any`\>
+
+#### Returns
+
+`PdfObjectStream`
+
+#### Overrides
+
+[`IterableReadableStream`](../../../../utils/IterableReadableStream/classes/IterableReadableStream.md).[`constructor`](../../../../utils/IterableReadableStream/classes/IterableReadableStream.md#constructor)
+
+## Methods
+
+### \[asyncIterator\]()
+
+> **\[asyncIterator\]**(): `object`
+
+Returns an async iterator for the stream.
+
+#### Returns
+
+`object`
+
+An async iterator that yields chunks from the stream.
+
+##### next()
+
+> **next**(): `Promise`\<`IteratorResult`\<[`PdfObject`](../../../objects/pdf-object/classes/PdfObject.md), `any`\>\>
+
+###### Returns
+
+`Promise`\<`IteratorResult`\<[`PdfObject`](../../../objects/pdf-object/classes/PdfObject.md), `any`\>\>
+
+#### Inherited from
+
+[`IterableReadableStream`](../../../../utils/IterableReadableStream/classes/IterableReadableStream.md).[`[asyncIterator]`](../../../../utils/IterableReadableStream/classes/IterableReadableStream.md#asynciterator)

package/docs/core/tokeniser/README.md

@@ -0,0 +1,21 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / core/tokeniser
+
+# core/tokeniser
+
+## Classes
+
+- [PdfByteStreamTokeniser](classes/PdfByteStreamTokeniser.md)
+- [PdfObjectTokeniser](classes/PdfObjectTokeniser.md)
+
+## Type Aliases
+
+- [PdfTokeniser](type-aliases/PdfTokeniser.md)
+
+## Functions
+
+- [objectToTokens](functions/objectToTokens.md)
+- [pdfObjectStreamTokeniser](functions/pdfObjectStreamTokeniser.md)

package/docs/core/tokeniser/classes/PdfByteStreamTokeniser.md

@@ -0,0 +1,366 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [core/tokeniser](../README.md) / PdfByteStreamTokeniser
+
+# Class: PdfByteStreamTokeniser
+
+Tokenizes a byte stream into PDF tokens.
+Handles all PDF syntax including objects, streams, and xref tables.
+
+## Extends
+
+- [`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md)\<`number`, [`PdfToken`](../../tokens/token/classes/PdfToken.md)\>
+
+## Constructors
+
+### Constructor
+
+> **new PdfByteStreamTokeniser**(`options?`): `PdfByteStreamTokeniser`
+
+Creates a new byte stream tokenizer.
+
+#### Parameters
+
+##### options?
+
+Configuration options
+
+###### streamChunkSizeBytes?
+
+`number`
+
+Size of stream chunks (default: 1024)
+
+#### Returns
+
+`PdfByteStreamTokeniser`
+
+#### Overrides
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`constructor`](../../incremental-parser/classes/IncrementalParser.md#constructor)
+
+## Properties
+
+### buffer
+
+> `protected` **buffer**: `number`[] = `[]`
+
+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)
+
+---
+
+### 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
+
+#### Inherited from
+
+[`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_ `number`
+
+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
+
+...(`number` \| `number`[])[]
+
+Input items to add to the buffer
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`feed`](../../incremental-parser/classes/IncrementalParser.md#feed)
+
+---
+
+### feedBytes()
+
+> **feedBytes**(`bytes`): `void`
+
+Feeds a byte array into the tokenizer.
+
+#### Parameters
+
+##### bytes
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The bytes to process
+
+#### Returns
+
+`void`
+
+---
+
+### next()
+
+> `protected` **next**(): `number`
+
+Consumes and returns the next item from the buffer.
+
+#### Returns
+
+`number`
+
+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`\<[`PdfToken`](../../tokens/token/classes/PdfToken.md)\>
+
+Generates parsed output items from the buffer.
+Handles backtracking when more input is needed.
+
+#### Returns
+
+`Generator`\<[`PdfToken`](../../tokens/token/classes/PdfToken.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`): [`PdfToken`](../../tokens/token/classes/PdfToken.md)
+
+Tries multiple parsing functions and returns the first successful result.
+Automatically backtracks on failure.
+
+#### Parameters
+
+##### fn
+
+...() => [`PdfToken`](../../tokens/token/classes/PdfToken.md)[]
+
+Array of parsing functions to try
+
+#### Returns
+
+[`PdfToken`](../../tokens/token/classes/PdfToken.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**(): [`PdfToken`](../../tokens/token/classes/PdfToken.md)
+
+Abstract method to parse the next output item from the buffer.
+Subclasses must implement this to define parsing logic.
+
+#### Returns
+
+[`PdfToken`](../../tokens/token/classes/PdfToken.md)
+
+The parsed output item
+
+#### Overrides
+
+[`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md).[`parse`](../../incremental-parser/classes/IncrementalParser.md#parse)
+
+---
+
+### peek()
+
+> `protected` **peek**(`ahead`): `number` \| `null`
+
+Peeks at an item in the buffer without consuming it.
+
+#### Parameters
+
+##### ahead
+
+`number` = `0`
+
+Number of positions to look ahead (default: 0)
+
+#### Returns
+
+`number` \| `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/tokeniser/classes/PdfObjectTokeniser.md

@@ -0,0 +1,69 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [core/tokeniser](../README.md) / PdfObjectTokeniser
+
+# Class: PdfObjectTokeniser
+
+Tokenizes PDF objects into a stream of PDF tokens.
+
+## Extends
+
+- [`Parser`](../../parser/classes/Parser.md)\<[`PdfObject`](../../objects/pdf-object/classes/PdfObject.md), [`PdfToken`](../../tokens/token/classes/PdfToken.md)\>
+
+## Constructors
+
+### Constructor
+
+> **new PdfObjectTokeniser**(): `PdfObjectTokeniser`
+
+#### Returns
+
+`PdfObjectTokeniser`
+
+#### Inherited from
+
+[`Parser`](../../parser/classes/Parser.md).[`constructor`](../../parser/classes/Parser.md#constructor)
+
+## Methods
+
+### feed()
+
+> **feed**(...`input`): `void`
+
+Feeds PDF objects into the tokenizer buffer.
+
+#### Parameters
+
+##### input
+
+...[`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)[]
+
+PDF objects to tokenize
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`Parser`](../../parser/classes/Parser.md).[`feed`](../../parser/classes/Parser.md#feed)
+
+---
+
+### nextItems()
+
+> **nextItems**(): `Generator`\<[`PdfToken`](../../tokens/token/classes/PdfToken.md)\>
+
+Generates tokens from the buffered PDF objects.
+
+#### Returns
+
+`Generator`\<[`PdfToken`](../../tokens/token/classes/PdfToken.md)\>
+
+A generator yielding PDF tokens
+
+#### Overrides
+
+[`Parser`](../../parser/classes/Parser.md).[`nextItems`](../../parser/classes/Parser.md#nextitems)

package/docs/core/tokeniser/functions/objectToTokens.md

@@ -0,0 +1,25 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [core/tokeniser](../README.md) / objectToTokens
+
+# Function: objectToTokens()
+
+> **objectToTokens**(`object`): `Generator`\<[`PdfToken`](../../tokens/token/classes/PdfToken.md)\>
+
+Converts a PDF object to its token representation.
+
+## Parameters
+
+### object
+
+[`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)
+
+The PDF object to tokenize
+
+## Returns
+
+`Generator`\<[`PdfToken`](../../tokens/token/classes/PdfToken.md)\>
+
+A generator yielding the object's tokens

package/docs/core/tokeniser/functions/pdfObjectStreamTokeniser.md

@@ -0,0 +1,27 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [core/tokeniser](../README.md) / pdfObjectStreamTokeniser
+
+# Function: pdfObjectStreamTokeniser()
+
+> **pdfObjectStreamTokeniser**(): (`objects`) => `Generator`\<[`PdfToken`](../../tokens/token/classes/PdfToken.md)\>
+
+Creates a function that converts a stream of PDF objects to tokens.
+
+## Returns
+
+A generator function that yields tokens from PDF objects
+
+> (`objects`): `Generator`\<[`PdfToken`](../../tokens/token/classes/PdfToken.md)\>
+
+### Parameters
+
+#### objects
+
+`Iterable`\<[`PdfObject`](../../objects/pdf-object/classes/PdfObject.md)\>
+
+### Returns
+
+`Generator`\<[`PdfToken`](../../tokens/token/classes/PdfToken.md)\>

package/docs/core/tokeniser/type-aliases/PdfTokeniser.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [core/tokeniser](../README.md) / PdfTokeniser
+
+# Type Alias: PdfTokeniser
+
+> **PdfTokeniser** = [`Parser`](../../parser/classes/Parser.md)\<`number`, [`PdfToken`](../../tokens/token/classes/PdfToken.md)\>
+
+Type alias for a parser that converts bytes to PDF tokens.

package/docs/core/tokens/boolean-token/README.md

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