pdf-lite 1.0.0 → 1.0.1-alpha.2

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

@@ -0,0 +1,306 @@
+[**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

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

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

@@ -0,0 +1,65 @@
+[**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

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

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

@@ -0,0 +1,32 @@
+[**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

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

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

@@ -0,0 +1,33 @@
+[**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

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

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

@@ -0,0 +1,34 @@
+[**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/package.json

@@ -1,72 +1,64 @@
 {
-    "name": "pdf-lite",
-    "version": "1.0.0",
-    "type": "module",
-    "description": "A lightweight PDF library for Node.js and the browser",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "scripts": {
-        "compile": "pnpm -r run compile && pnpm compile:examples && pnpm compile:test",
-        "compile:examples": "tsx ./scripts/build-examples.ts && prettier --write EXAMPLES.md",
-        "compile:test": "tsc --noEmit",
-        "prepublish": "pnpm -r run compile",
-        "test": "pnpm -r --no-sort run test",
-        "prepare": "husky || true",
-        "lint:staged": "lint-staged --allow-empty",
-        "lint:commit": "commitlint --edit $1",
-        "format": "prettier --write '**/*.{js,ts,json,md,yaml,yml}'",
-        "docs:gen": "sh -c 'pnpm docs:gen:md \"$@\" && pnpm docs:gen:html \"$@\"' --",
-        "docs:gen:md": "./scripts/gen-md-docs.sh",
-        "docs:gen:html": "./scripts/gen-html-docs.sh"
-    },
-    "keywords": [
-        "pdf",
-        "typescript",
-        "browser",
-        "nodejs",
-        "zero-dependency",
-        "type-safe",
-        "pdf-parser",
-        "pdf-reader",
-        "pdf-writer",
-        "digital-signature",
-        "encryption",
-        "decryption"
-    ],
-    "author": "Jacob Shirley",
-    "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/jacobshirley/pdf-lite.git"
-    },
-    "bugs": {
-        "url": "https://github.com/jacobshirley/pdf-lite/issues"
-    },
-    "homepage": "https://jacobshirley.github.io/pdf-lite",
-    "packageManager": "pnpm@10.23.0",
-    "lint-staged": {
-        "*.{js,ts,json,md}": "pnpm format"
-    },
-    "pnpm": {
-        "overrides": {
-            "playwright": "$playwright",
-            "typescript": "$typescript"
-        }
-    },
-    "devDependencies": {
-        "@commitlint/cli": "^20.1.0",
-        "@commitlint/config-conventional": "^20.0.0",
-        "@types/node": "^24",
-        "husky": "^9.1.7",
-        "lint-staged": "^16.2.7",
-        "playwright": "^1.56.1",
-        "prettier": "^3.6.2",
-        "tsx": "^4.20.6",
-        "typedoc": "^0.28.14",
-        "typedoc-plugin-markdown": "^4.9.0",
-        "typescript": "5.9.3"
-    },
-    "dependencies": {
-        "pdf-lite": "^1.0.0"
-    }
-}
+  "name": "pdf-lite",
+  "version": "1.0.1-alpha.2",
+  "type": "module",
+  "description": "A lightweight PDF library for Node.js and the browser",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "pdf",
+    "typescript",
+    "browser",
+    "nodejs",
+    "zero-dependency",
+    "type-safe",
+    "pdf-parser",
+    "pdf-reader",
+    "pdf-writer",
+    "digital-signature",
+    "encryption",
+    "decryption"
+  ],
+  "author": "Jacob Shirley",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jacobshirley/pdf-lite.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jacobshirley/pdf-lite/issues"
+  },
+  "homepage": "https://jacobshirley.github.io/pdf-lite",
+  "lint-staged": {
+    "*.{js,ts,json,md}": "pnpm format"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^20.1.0",
+    "@commitlint/config-conventional": "^20.0.0",
+    "@types/node": "^24",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.7",
+    "playwright": "^1.56.1",
+    "prettier": "^3.6.2",
+    "tsx": "^4.20.6",
+    "typedoc": "^0.28.14",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typescript": "5.9.3"
+  },
+  "dependencies": {
+    "pdf-lite": "^1.0.1-alpha.2"
+  },
+  "scripts": {
+    "compile": "pnpm -r run compile && pnpm compile:examples && pnpm compile:test",
+    "compile:examples": "tsx ./scripts/build-examples.ts && prettier --write EXAMPLES.md",
+    "compile:test": "tsc --noEmit",
+    "prepublish": "pnpm -r run compile",
+    "test": "pnpm -r --no-sort run test",
+    "lint:staged": "lint-staged --allow-empty",
+    "lint:commit": "commitlint --edit $1",
+    "format": "prettier --write '**/*.{js,ts,json,md,yaml,yml}'",
+    "docs:gen": "sh -c 'pnpm docs:gen:md \"$@\" && pnpm docs:gen:html \"$@\"' --",
+    "docs:gen:md": "./scripts/gen-md-docs.sh",
+    "docs:gen:html": "./scripts/gen-html-docs.sh"
+  }
+}

package/packages/pdf-lite/node_modules/.bin/playwright

@@ -0,0 +1,16 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*|*MINGW*|*MSYS*)
+        if command -v cygpath > /dev/null 2>&1; then
+            basedir=`cygpath -w "$basedir"`
+        fi
+    ;;
+esac
+
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../playwright/cli.js" "$@"
+else
+  exec node  "$basedir/../playwright/cli.js" "$@"
+fi

package/packages/pdf-lite/node_modules/.bin/tsc

@@ -0,0 +1,16 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*|*MINGW*|*MSYS*)
+        if command -v cygpath > /dev/null 2>&1; then
+            basedir=`cygpath -w "$basedir"`
+        fi
+    ;;
+esac
+
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../typescript/bin/tsc" "$@"
+else
+  exec node  "$basedir/../typescript/bin/tsc" "$@"
+fi