Merge pull request #129 from hajareshyam/feat/2.4.0-dx-validation-helpers

Release v2.4.0: DX improvements, validation, optional Handlebars helpers, tests & CI

Author: hajarerisha

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+    branches: [master, main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Test
+        run: npm test

.gitignore

@@ -1,3 +1,5 @@
 node_modules/
 .package-lock.json
+dist/
+example/output.pdf
 

CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+## [2.4.0] — 2026-04-03
+
+### Added
+
+- Clear validation errors for missing `html`, `data`, or `path` (when writing a file).
+- `document.data` can be any value except `null`/`undefined` (e.g. `0` is allowed).
+- Optional `handlebarsHelpers` on PDF options to register extra Handlebars helpers for that render (isolated `Handlebars.create()` instance).
+- Stricter TypeScript types: `PdfDocumentFile`, `PdfDocumentBuffer`, `PdfDocumentStream`, and a `PdfDocument` union.
+- `src/validation.ts` with `validatePdfDocument()` (used internally).
+- Automated tests (`npm test`) and GitHub Actions CI.
+- `engines.node` set to `>=18`.
+
+### Changed
+
+- Template compile/render errors are wrapped with prefix `pdf-creator-node: template rendering failed:`.
+- README: corrected `ifCond` HTML example, TypeScript usage, optional helpers, and license line (`package.json` `license` set to **MIT** to match `LICENSE`).
+- `package.json` keywords deduplicated.
+
+## Earlier releases
+
+See git history for changes before this changelog was added.