pdf-lite 1.0.1-alpha.2 → 1.0.1

package/dist/utils/unescapeString.js

@@ -0,0 +1,114 @@
+/**
+ * Unescapes a PDF literal string by processing escape sequences.
+ * Handles escape sequences for special characters including newlines, tabs,
+ * backslashes, parentheses, and octal character codes.
+ *
+ * @param input - The escaped byte array to unescape.
+ * @returns 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])
+ * ```
+ */
+export function unescapeString(input) {
+    const buffer = input;
+    const bytes = [];
+    let offset = 0;
+    let nesting = 1;
+    let inEscape = false;
+    const ByteMap = {
+        LEFT_PARENTHESIS: 0x28,
+        RIGHT_PARENTHESIS: 0x29,
+        BACKSLASH: 0x5c,
+        n: 0x6e,
+        r: 0x72,
+        t: 0x74,
+        b: 0x62,
+        f: 0x66,
+    };
+    function isOctet(byte) {
+        return byte >= 0x30 && byte <= 0x37; // 0-7
+    }
+    while (inEscape || nesting > 0) {
+        if (offset >= buffer.length) {
+            break;
+        }
+        if (buffer[offset] === ByteMap.LEFT_PARENTHESIS) {
+            nesting++;
+        }
+        else if (buffer[offset] === ByteMap.RIGHT_PARENTHESIS) {
+            nesting--;
+            if (nesting === 0) {
+                offset++;
+                break;
+            }
+        }
+        else if (buffer[offset] === ByteMap.BACKSLASH || inEscape) {
+            inEscape = true;
+            const next = buffer[offset + 1];
+            if (next === undefined) {
+                break;
+            }
+            switch (next) {
+                case ByteMap.n:
+                    bytes.push(0x0a);
+                    break; // \n
+                case ByteMap.r:
+                    bytes.push(0x0d);
+                    break; // \r
+                case ByteMap.t:
+                    bytes.push(0x09);
+                    break; // \t
+                case ByteMap.b:
+                    bytes.push(0x08);
+                    break; // \b
+                case ByteMap.f:
+                    bytes.push(0x0c);
+                    break; // \f
+                case ByteMap.LEFT_PARENTHESIS:
+                    bytes.push(ByteMap.LEFT_PARENTHESIS);
+                    break; // \(
+                case ByteMap.RIGHT_PARENTHESIS:
+                    bytes.push(ByteMap.RIGHT_PARENTHESIS);
+                    break; // \)
+                case ByteMap.BACKSLASH:
+                    bytes.push(ByteMap.BACKSLASH);
+                    break; // \\
+                case 0x0a:
+                case 0x0d:
+                    // Ignore line breaks in the string after a backslash
+                    break;
+                default:
+                    if (isOctet(next)) {
+                        let octal = String.fromCharCode(next);
+                        // Octal: up to 3 digits
+                        const next2 = buffer[offset + 2];
+                        if (next2 !== undefined && isOctet(next2)) {
+                            octal += String.fromCharCode(next2);
+                            const next3 = buffer[offset + 3];
+                            if (next3 !== undefined && isOctet(next3)) {
+                                octal += String.fromCharCode(next3);
+                            }
+                        }
+                        bytes.push(parseInt(octal, 8));
+                        offset += octal.length + 1; // Adjust offset for the number of octal digits
+                        inEscape = false;
+                        continue;
+                    }
+                    else {
+                        // If it's not a valid escape sequence, just add the next byte
+                        bytes.push(next);
+                    }
+                    break;
+            }
+            offset += 2; // Skip the escape character and the next character
+            inEscape = false;
+            continue;
+        }
+        bytes.push(buffer[offset]);
+        offset++;
+    }
+    return new Uint8Array(bytes);
+}

package/package.json

@@ -1,16 +1,24 @@
 {
   "name": "pdf-lite",
-  "version": "1.0.1-alpha.2",
-  "type": "module",
-  "description": "A lightweight PDF library for Node.js and the browser",
+  "version": "1.0.1",
   "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "default": "./dist/*"
+    }
+  },
   "keywords": [
     "pdf",
     "typescript",
     "browser",
     "nodejs",
-    "zero-dependency",
+    "minimal-dependency",
     "type-safe",
     "pdf-parser",
     "pdf-reader",
@@ -21,44 +29,39 @@
   ],
   "author": "Jacob Shirley",
   "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^20.19.17",
+    "@types/pako": "^2.0.4",
+    "@vitest/browser-playwright": "^4.0.14",
+    "@vitest/coverage-v8": "^4.0.14",
+    "playwright": "^1.56.1",
+    "typescript": "5.9.3",
+    "vitest": "^4.0.14"
+  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/jacobshirley/pdf-lite.git"
+    "url": "git+ssh://git@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"
-  },
+  "description": "A low-level, zero-dependency, type-safe PDF library for Node.js and the browser",
+  "files": [
+    "dist"
+  ],
   "dependencies": {
-    "pdf-lite": "^1.0.1-alpha.2"
+    "pako": "2.1.0",
+    "pki-lite": "^1.0.10",
+    "pki-lite-crypto-extended": "^1.0.10"
   },
   "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"
+    "test:acceptance": "vitest run test/acceptance",
+    "test:unit": "vitest run test/unit",
+    "test": "vitest run",
+    "compile": "pnpm compile:validate && tsc -p tsconfig.prod.json",
+    "compile:validate": "tsc -p tsconfig.json --noEmit",
+    "watch": "tsc -watch -p tsconfig.prod.json",
+    "watch:all": "tsc -watch -p tsconfig.json"
   }
 }

package/.commitlintrc.cjs

@@ -1,25 +0,0 @@
-module.exports = {
-    extends: ['@commitlint/config-conventional'],
-    rules: {
-        'type-empty': [2, 'never'],
-        'type-enum': [
-            2,
-            'always',
-            [
-                'ci',
-                'feat',
-                'fix',
-                'refactor',
-                'revert',
-                'style',
-                'chore',
-                'docs',
-                'test',
-                'bump',
-                'perf',
-                'security',
-                'release',
-            ],
-        ],
-    },
-}

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,40 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
-
-- OS: [e.g. iOS]
-- Browser [e.g. chrome, safari]
-- Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
-
-- Device: [e.g. iPhone6]
-- OS: [e.g. iOS8.1]
-- Browser [e.g. stock browser, safari]
-- Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,19 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

package/.github/workflows/docs.yaml

@@ -1,95 +0,0 @@
-name: Deploy Docs
-
-on:
-    push:
-        branches:
-            - master
-            - docs/* # Useful for testing changes to docs
-        tags:
-            - 'v*.*.*' # Trigger on version tags like v1.0.0, v2.1.3, etc.
-            - 'v*'
-            - 'latest'
-
-    workflow_dispatch:
-
-permissions:
-    contents: read
-    pages: write
-    id-token: write
-
-concurrency:
-    group: 'pages'
-    cancel-in-progress: false
-
-defaults:
-    run:
-        shell: bash
-
-jobs:
-    build:
-        name: Build Docs for ${{ matrix.version }}
-        runs-on: ubuntu-latest
-        strategy:
-            matrix:
-                version:
-                    - v1
-                    - latest
-                    - ${{ github.ref_name }}
-        steps:
-            - name: Checkout ${{ matrix.version }}
-              uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6
-              with:
-                  ref: ${{ matrix.version }}
-            - name: Get formatted ref name
-              id: formatted-ref-name
-              run: echo "formatted_ref_name=${{ matrix.version }}" | sed 's/\//_/g' >> $GITHUB_OUTPUT
-            - uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4
-              with:
-                  run_install: true
-            - uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
-              with:
-                  node-version: '24'
-                  cache: 'pnpm'
-            - name: Setup Pages
-              id: pages
-              uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b #v5
-            - name: Compile TypeScript
-              run: pnpm compile
-            - name: Build docs
-              run: pnpm docs:gen ${{ steps.formatted-ref-name.outputs.formatted_ref_name }}
-            - name: Copy latest to root
-              if: matrix.version == 'latest'
-              run: cp -r docs-html/latest/* docs-html/
-            - name: Upload artifact
-              uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
-              with:
-                  name: docs-${{ steps.formatted-ref-name.outputs.formatted_ref_name }}
-                  path: ./docs-html
-                  retention-days: 1
-            - name: Where to find the docs
-              run: echo "You can find the documentation for version ${{ matrix.version }} at https://jacobshirley.github.io/pdf-lite/${{ steps.formatted-ref-name.outputs.formatted_ref_name }}" >> $GITHUB_STEP_SUMMARY
-    combine:
-        name: Combine Docs
-        runs-on: ubuntu-latest
-        needs: build
-        steps:
-            - name: Download artifacts
-              uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
-              with:
-                  merge-multiple: true
-                  path: ./docs-html
-            - name: Upload combined artifact
-              uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4
-              with:
-                  path: ./docs-html
-                  retention-days: 1
-                  name: 'github-pages'
-
-    deploy:
-        name: Deploy
-        runs-on: ubuntu-latest
-        needs: combine
-        steps:
-            - name: Deploy to GitHub Pages
-              id: deployment
-              uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e #v4

package/.github/workflows/prepare-release.yaml

@@ -1,79 +0,0 @@
-name: Prepare Release
-on:
-    workflow_dispatch:
-        inputs:
-            version:
-                description: 'Version to prepare as (e.g. patch, minor, major)'
-                type: choice
-                options:
-                    - patch
-                    - minor
-                    - major
-                    - prepatch
-                    - preminor
-                    - premajor
-                    - prerelease
-                required: true
-            preid:
-                description: 'Prerelease identifier (e.g. alpha, beta, rc). Only used if version is a prerelease type'
-                type: choice
-                required: false
-                options:
-                    - alpha
-                    - beta
-                    - rc
-            force:
-                description: 'Force prepare even if no changes detected'
-                required: false
-                type: boolean
-    push:
-        branches:
-            - release/**
-permissions:
-    actions: write
-    checks: write
-    contents: write
-    pull-requests: write
-jobs:
-    prepare-release:
-        runs-on: ubuntu-latest
-        name: Prepare Release
-        steps:
-            - name: Checkout repository
-              uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6
-            - name: Set up pnpm
-              uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4
-              with:
-                  run_install: true
-            - name: Set up Node.js
-              uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
-              with:
-                  node-version: '24'
-                  cache: 'pnpm'
-            - name: Compile
-              run: pnpm compile
-            - name: Bump version
-              run: ./scripts/bump-version.sh ${{ github.event.inputs.version }} --preid='${{ github.event.inputs.preid }}'
-            - name: Generate docs
-              run: pnpm docs:gen:md
-            - name: Set up committer
-              run: |
-                  git config --global user.name "github-actions[bot]"
-                  git config --global user.email "github-actions[bot]@users.noreply.github.com"
-            - name: Prepare release
-              if: github.event_name == 'workflow_dispatch'
-              run: ./scripts/prepare-release.sh --create-pr --force=${{ github.event.inputs.force }}
-              env:
-                  GH_TOKEN: ${{ github.token }}
-            - name: Get release version
-              id: get_release_version
-              run: echo "version=$(cat .release-version)" >> $GITHUB_OUTPUT
-            - name: Pack
-              run: pnpm pack -r
-            - name: Push artifacts
-              uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
-              with:
-                  name: pdf-lite-${{ steps.get_release_version.outputs.version }}
-                  path: ./*.tgz
-            - name: Test publish
-              run: pnpm publish -r --dry-run --publish-branch=$(git branch --show-current) --no-git-checks

package/.github/workflows/release.yaml

@@ -1,80 +0,0 @@
-name: Release
-
-on:
-    push:
-        branches:
-            - 'master'
-
-    # Manual trigger
-    workflow_dispatch:
-permissions:
-    contents: read
-
-jobs:
-    publish:
-        runs-on: ubuntu-latest
-        name: Publish to npm
-        permissions:
-            contents: write
-            id-token: write
-        if: github.event_name == 'workflow_dispatch' || contains( github.event.head_commit.message, 'release' )
-        steps:
-            - name: Checkout repository
-              uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6
-            - name: Set up pnpm
-              uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4
-              with:
-                  run_install: true
-            - name: Set up Node.js
-              uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
-              with:
-                  node-version: '24'
-                  cache: 'pnpm'
-            - name: Get release version
-              id: get_release_version
-              run: echo "version=$(jq -r .version ./package.json)" >> $GITHUB_OUTPUT
-            - name: Compile
-              run: pnpm compile
-            - name: Publish packages
-              run: pnpm -r publish --tag=latest --provenance
-            - name: Tag version
-              run: |
-                  git config --global user.name "github-actions[bot]"
-                  git config --global user.email "github-actions[bot]@users.noreply.github.com"
-                  git tag v${{ steps.get_release_version.outputs.version }} --force
-                  MAJOR_VERSION=$(echo ${{ steps.get_release_version.outputs.version }} | cut -d. -f1)
-                  git tag v${MAJOR_VERSION} --force
-                  git tag latest --force
-                  git push origin v${{ steps.get_release_version.outputs.version }} --force
-                  git push origin v${MAJOR_VERSION} --force
-                  git push origin latest --force
-              env:
-                  GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-            - name: Pack
-              run: pnpm -r pack
-            - name: Push artifacts
-              uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
-              with:
-                  name: pdf-lite-${{ steps.get_release_version.outputs.version }}
-                  path: ./*.tgz
-    github-release:
-        runs-on: ubuntu-latest
-        name: Create GitHub Release
-        needs: publish
-        permissions:
-            contents: write
-        steps:
-            - name: Download artifacts
-              uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
-            - name: Get release version
-              id: get_release_version
-              run: VERSION_FILE=$(ls *.tgz | head -n 1) && echo "version=$(echo $VERSION_FILE | sed -E 's/^pdf-lite-(.*)\.tgz$/\1/')" >> $GITHUB_OUTPUT
-            - name: Create Release
-              id: create_release
-              uses: softprops/action-gh-release@6cbd405e2c4e67a21c47fa9e383d020e4e28b836 # v2
-              with:
-                  draft: false
-                  prerelease: ${{ contains(steps.get_release_version.outputs.version, '-') }}
-                  generate_release_notes: true
-                  tag_name: v${{ steps.get_release_version.outputs.version }}
-                  files: './*.tgz'

package/.github/workflows/test.yaml

@@ -1,35 +0,0 @@
-name: Test
-on:
-    push:
-        branches:
-            - master
-            - ci/test # For testing changes to this workflow
-    pull_request:
-        branches:
-            - master
-    merge_group:
-    workflow_dispatch:
-    workflow_call:
-permissions:
-    contents: read
-    actions: read
-    checks: write
-jobs:
-    Tests:
-        runs-on: ubuntu-latest
-        name: Tests
-        steps:
-            - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6
-            - uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4
-              with:
-                  run_install: true
-            - uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
-              with:
-                  node-version: '24'
-                  cache: 'pnpm'
-            - name: Install Playwright Browsers
-              run: pnpm exec playwright install chromium --only-shell
-            - name: Compile
-              run: pnpm compile
-            - name: Run tests
-              run: pnpm test

package/.husky/commit-msg

@@ -1 +0,0 @@
-pnpm lint:commit

package/.husky/pre-commit

@@ -1 +0,0 @@
-pnpm lint:staged

package/.prettierignore

@@ -1,4 +0,0 @@
-**/*.autogenerated.*
-**/*.generated.*
-**/*.gen.*
-pnpm-lock.yaml

package/.prettierrc

@@ -1,4 +0,0 @@
-trailingComma: 'all'
-tabWidth: 4
-semi: false
-singleQuote: true