pdf-lite 1.0.1-alpha.2 → 1.0.1

package/docs/utils/predictors/classes/Predictor.md

@@ -1,306 +0,0 @@
-[**pdf-lite**](../../../README.md)
-
----
-
-[pdf-lite](../../../README.md) / [utils/predictors](../README.md) / Predictor
-
-# Class: Predictor
-
-Handles PNG and TIFF predictor encoding and decoding for PDF streams.
-Predictors are used to improve compression efficiency by transforming
-image data before or after compression.
-
-## Constructors
-
-### Constructor
-
-> **new Predictor**(): `Predictor`
-
-#### Returns
-
-`Predictor`
-
-## Methods
-
-### canHandleDecodeParms()
-
-> `static` **canHandleDecodeParms**(`decodeParms?`): `boolean`
-
-Checks if the decode parameters can be handled by this predictor.
-
-#### Parameters
-
-##### decodeParms?
-
-[`PdfDictionary`](../../../core/objects/pdf-dictionary/classes/PdfDictionary.md)\<[`PdfDictionaryEntries`](../../../core/objects/pdf-dictionary/type-aliases/PdfDictionaryEntries.md)\>
-
-Optional PDF dictionary containing decode parameters.
-
-#### Returns
-
-`boolean`
-
-True if the parameters can be handled, false otherwise.
-
-#### Example
-
-```typescript
-if (Predictor.canHandleDecodeParms(dictionary)) {
-    // Process with predictor
-}
-```
-
----
-
-### decode()
-
-> `static` **decode**(`data`, `params`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-Decodes data that was encoded with a predictor.
-
-#### Parameters
-
-##### data
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The encoded data to decode.
-
-##### params
-
-[`DecodeParms`](../../../types/type-aliases/DecodeParms.md) = `{}`
-
-Optional decode parameters including Predictor, Columns, Colors, and BitsPerComponent.
-
-#### Returns
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The decoded byte array.
-
-#### Example
-
-```typescript
-const decoded = Predictor.decode(encodedData, { Predictor: 12, Columns: 100 })
-```
-
----
-
-### encode()
-
-> `static` **encode**(`data`, `params`, `PdfStreamFilterType`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-Encodes data using a predictor algorithm.
-
-#### Parameters
-
-##### data
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The data to encode.
-
-##### params
-
-[`DecodeParms`](../../../types/type-aliases/DecodeParms.md) = `{}`
-
-Optional encode parameters including Predictor, Columns, Colors, and BitsPerComponent.
-
-##### PdfStreamFilterType
-
-`number` = `0`
-
-The PNG filter type to use for encoding.
-
-#### Returns
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The encoded byte array.
-
-#### Example
-
-```typescript
-const encoded = Predictor.encode(rawData, { Predictor: 12, Columns: 100 }, 1)
-```
-
----
-
-### getDecodeParms()
-
-> `static` **getDecodeParms**(`decodeParms?`): [`DecodeParms`](../../../types/type-aliases/DecodeParms.md) \| `null`
-
-Extracts decode parameters from a PDF dictionary.
-
-#### Parameters
-
-##### decodeParms?
-
-[`PdfDictionary`](../../../core/objects/pdf-dictionary/classes/PdfDictionary.md)\<[`PdfDictionaryEntries`](../../../core/objects/pdf-dictionary/type-aliases/PdfDictionaryEntries.md)\>
-
-Optional PDF dictionary containing decode parameters.
-
-#### Returns
-
-[`DecodeParms`](../../../types/type-aliases/DecodeParms.md) \| `null`
-
-The decode parameters object or null if not applicable.
-
-#### Example
-
-```typescript
-const params = Predictor.getDecodeParms(dictionary)
-if (params) {
-    console.log(params.Predictor)
-}
-```
-
----
-
-### pngDecode()
-
-> `static` **pngDecode**(`data`, `columns`, `bpp`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-Decodes PNG predictor encoded data.
-
-#### Parameters
-
-##### data
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The PNG encoded data.
-
-##### columns
-
-`number`
-
-The number of columns in the image.
-
-##### bpp
-
-`number`
-
-Bytes per pixel.
-
-#### Returns
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The decoded byte array.
-
-#### Throws
-
-Error if an unsupported PNG filter type is encountered.
-
----
-
-### pngEncode()
-
-> `static` **pngEncode**(`data`, `columns`, `bpp`, `PdfStreamFilterType`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-Encodes data using PNG predictor.
-
-#### Parameters
-
-##### data
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The data to encode.
-
-##### columns
-
-`number`
-
-The number of columns in the image.
-
-##### bpp
-
-`number`
-
-Bytes per pixel.
-
-##### PdfStreamFilterType
-
-`number`
-
-The PNG filter type (0-4) to use.
-
-#### Returns
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The PNG encoded byte array.
-
-#### Throws
-
-Error if an unsupported PNG filter type is specified.
-
----
-
-### tiffDecode()
-
-> `static` **tiffDecode**(`data`, `columns`, `bpp`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-Decodes TIFF predictor encoded data.
-
-#### Parameters
-
-##### data
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The TIFF encoded data.
-
-##### columns
-
-`number`
-
-The number of columns in the image.
-
-##### bpp
-
-`number`
-
-Bytes per pixel.
-
-#### Returns
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The decoded byte array.
-
----
-
-### tiffEncode()
-
-> `static` **tiffEncode**(`data`, `columns`, `bpp`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-Encodes data using TIFF predictor.
-
-#### Parameters
-
-##### data
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The data to encode.
-
-##### columns
-
-`number`
-
-The number of columns in the image.
-
-##### bpp
-
-`number`
-
-Bytes per pixel.
-
-#### Returns
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The TIFF encoded byte array.

package/docs/utils/replaceInBuffer/README.md

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

package/docs/utils/replaceInBuffer/functions/replaceInBuffer.md

@@ -1,65 +0,0 @@
-[**pdf-lite**](../../../README.md)
-
----
-
-[pdf-lite](../../../README.md) / [utils/replaceInBuffer](../README.md) / replaceInBuffer
-
-# Function: replaceInBuffer()
-
-> **replaceInBuffer**\<`T`\>(`searchBuffer`, `replaceBuffer`, `targetBuffer`, `multiple`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-Replaces occurrences of a search buffer with a replacement buffer within a target buffer.
-
-## Type Parameters
-
-### T
-
-`T` _extends_ [`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The type of the target buffer, extending ByteArray.
-
-## Parameters
-
-### searchBuffer
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The byte pattern to search for.
-
-### replaceBuffer
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The byte pattern to replace with.
-
-### targetBuffer
-
-`T`
-
-The buffer to search within.
-
-### multiple
-
-`boolean` = `false`
-
-Whether to replace all occurrences or just the first. Defaults to false.
-
-## Returns
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-A new byte array with the replacements made.
-
-## Throws
-
-Error if the search buffer is not found in the target buffer.
-
-## Example
-
-```typescript
-const result = replaceInBuffer(
-    new Uint8Array([1, 2]),
-    new Uint8Array([3, 4, 5]),
-    new Uint8Array([0, 1, 2, 6]),
-) // Returns Uint8Array([0, 3, 4, 5, 6])
-```

package/docs/utils/stringToBytes/README.md

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

package/docs/utils/stringToBytes/functions/stringToBytes.md

@@ -1,32 +0,0 @@
-[**pdf-lite**](../../../README.md)
-
----
-
-[pdf-lite](../../../README.md) / [utils/stringToBytes](../README.md) / stringToBytes
-
-# Function: stringToBytes()
-
-> **stringToBytes**(`str`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-Converts a string or byte array to a byte array using UTF-8 encoding.
-If the input is already a byte array, it is returned as-is.
-
-## Parameters
-
-### str
-
-The string or byte array to convert.
-
-`string` | [`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-## Returns
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The input as a byte array.
-
-## Example
-
-```typescript
-stringToBytes('Hello') // Returns Uint8Array([72, 101, 108, 108, 111])
-```

package/docs/utils/stringToHexBytes/README.md

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

package/docs/utils/stringToHexBytes/functions/stringToHexBytes.md

@@ -1,33 +0,0 @@
-[**pdf-lite**](../../../README.md)
-
----
-
-[pdf-lite](../../../README.md) / [utils/stringToHexBytes](../README.md) / stringToHexBytes
-
-# Function: stringToHexBytes()
-
-> **stringToHexBytes**(`str`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-Converts a hexadecimal string (optionally with angle brackets) to a byte array.
-Strips any surrounding angle brackets before conversion.
-
-## Parameters
-
-### str
-
-`string`
-
-The hexadecimal string to convert, optionally wrapped in angle brackets.
-
-## Returns
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-A byte array with the decoded values.
-
-## Example
-
-```typescript
-stringToHexBytes('<FF00>') // Returns Uint8Array([255, 0])
-stringToHexBytes('FF00') // Also returns Uint8Array([255, 0])
-```

package/docs/utils/unescapeString/README.md

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

package/docs/utils/unescapeString/functions/unescapeString.md

@@ -1,34 +0,0 @@
-[**pdf-lite**](../../../README.md)
-
----
-
-[pdf-lite](../../../README.md) / [utils/unescapeString](../README.md) / unescapeString
-
-# Function: unescapeString()
-
-> **unescapeString**(`input`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-Unescapes a PDF literal string by processing escape sequences.
-Handles escape sequences for special characters including newlines, tabs,
-backslashes, parentheses, and octal character codes.
-
-## Parameters
-
-### input
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-The escaped byte array to unescape.
-
-## Returns
-
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-
-A new byte array with escape sequences converted to their literal values.
-
-## Example
-
-```typescript
-// Unescapes '\n' to a literal newline
-unescapeString(new Uint8Array([0x5c, 0x6e])) // Returns Uint8Array([0x0a])
-```

package/examples/001-create-pdf.ts

@@ -1,112 +0,0 @@
-// PDF creation from scratch example
-
-import { writeFileSync } from 'fs'
-import { PdfArray } from 'pdf-lite/core/objects/pdf-array'
-import { PdfDictionary } from 'pdf-lite/core/objects/pdf-dictionary'
-import { PdfIndirectObject } from 'pdf-lite/core/objects/pdf-indirect-object'
-import { PdfName } from 'pdf-lite/core/objects/pdf-name'
-import { PdfNumber } from 'pdf-lite/core/objects/pdf-number'
-import { PdfObjectReference } from 'pdf-lite/core/objects/pdf-object-reference'
-import { PdfStream } from 'pdf-lite/core/objects/pdf-stream'
-import { PdfDocument } from 'pdf-lite/pdf/pdf-document'
-
-function createPage(
-    contentStreamRef: PdfObjectReference,
-): PdfIndirectObject<PdfDictionary> {
-    const pageDict = new PdfDictionary()
-    pageDict.set('Type', new PdfName('Page'))
-    pageDict.set(
-        'MediaBox',
-        new PdfArray([
-            new PdfNumber(0),
-            new PdfNumber(0),
-            new PdfNumber(612),
-            new PdfNumber(792),
-        ]),
-    )
-    pageDict.set('Contents', contentStreamRef)
-    return new PdfIndirectObject({ content: pageDict })
-}
-
-function createPages(
-    pages: PdfIndirectObject<PdfDictionary>[],
-): PdfIndirectObject<PdfDictionary> {
-    const pagesDict = new PdfDictionary()
-    pagesDict.set('Type', new PdfName('Pages'))
-    pagesDict.set('Kids', new PdfArray(pages.map((x) => x.reference)))
-    pagesDict.set('Count', new PdfNumber(pages.length))
-    return new PdfIndirectObject({ content: pagesDict })
-}
-
-function createCatalog(
-    pagesRef: PdfObjectReference,
-): PdfIndirectObject<PdfDictionary> {
-    const catalogDict = new PdfDictionary()
-    catalogDict.set('Type', new PdfName('Catalog'))
-    catalogDict.set('Pages', pagesRef)
-    return new PdfIndirectObject({ content: catalogDict })
-}
-
-function createFont(): PdfIndirectObject<PdfDictionary> {
-    const fontDict = new PdfDictionary()
-    fontDict.set('Type', new PdfName('Font'))
-    fontDict.set('Subtype', new PdfName('Type1'))
-    fontDict.set('BaseFont', new PdfName('Helvetica'))
-    return new PdfIndirectObject({ content: fontDict })
-}
-
-function createResources(
-    fontRef: PdfObjectReference,
-): PdfIndirectObject<PdfDictionary> {
-    const resourcesDict = new PdfDictionary()
-    const fontDict = new PdfDictionary()
-    fontDict.set('F1', fontRef)
-    resourcesDict.set('Font', fontDict)
-    return new PdfIndirectObject({ content: resourcesDict })
-}
-
-// Create the document
-const document = new PdfDocument()
-
-// Create font
-const font = createFont()
-document.add(font)
-
-// Create resources with the font
-const resources = createResources(font.reference)
-document.add(resources)
-
-// Create content stream
-const contentStream = new PdfIndirectObject({
-    content: new PdfStream({
-        header: new PdfDictionary(),
-        original: 'BT /F1 24 Tf 100 700 Td (Hello, PDF-Lite!) Tj ET',
-    }),
-})
-
-// Create a page
-const page = createPage(contentStream.reference)
-// Add resources to the page
-page.content.set('Resources', resources.reference)
-document.add(page)
-
-// Create pages collection
-const pages = createPages([page])
-// Set parent reference for the page
-page.content.set('Parent', pages.reference)
-document.add(pages)
-
-// Create catalog
-const catalog = createCatalog(pages.reference)
-document.add(catalog)
-
-// Set the catalog as the root
-document.trailerDict.set('Root', catalog.reference)
-
-document.add(contentStream)
-await document.commit()
-
-const file = `${import.meta.dirname}/tmp/created.pdf`
-console.log(`Writing PDF to: ${file}`)
-
-await writeFileSync(`${file}`, document.toBytes())