npm - pdf-creator-node - Versions diffs - 2.3.5 → 2.5.0 - Mend

pdf-creator-node 2.3.5 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3544) hide show

package/readme.md CHANGED Viewed

@@ -1,196 +1,198 @@
-# Follow these steps to convert HTML to PDF
-- Step 1 - install the pdf creator package using the following command
-  `$ npm i pdf-creator-node --save`
-  > --save flag adds package name to package.json file.
-- Step 2 - Add required packages and read HTML template
-  ```javascript
-  //Required package
-  var pdf = require("pdf-creator-node");
-  var fs = require("fs");
-  // Read HTML Template
-  var html = fs.readFileSync("template.html", "utf8");
-  ```
-- Step 3 - Create your HTML Template
-  ```html
-  <!DOCTYPE html>
-  <html>
-    <head>
-      <meta charset="utf-8" />
-      <title>Hello world!</title>
-    </head>
-    <body>
-      <h1>User List</h1>
-      <ul>
-        {{#each users}}
-        <li>Name: {{this.name}}</li>
-        <li>Age: {{this.age}}</li>
-        <br />
-        {{/each}}
-      </ul>
-    </body>
-  </html>
-  ```
-- Step 4 - Provide format and orientation as per your need
-  > "height": "10.5in", // allowed units: mm, cm, in, px
-  > "width": "8in", // allowed units: mm, cm, in, px
-  - or -
-  > "format": "Letter", // allowed units: A3, A4, A5, Legal, Letter, Tabloid
-  > "orientation": "portrait", // portrait or landscape
-    ```javascript
-        var options = {
-            format: "A3",
-            orientation: "portrait",
-            border: "10mm",
-            header: {
-                height: "45mm",
-                contents: '<div style="text-align: center;">Author: Shyam Hajare</div>'
-            },
-            footer: {
-                height: "28mm",
-                contents: {
-                    first: 'Cover page',
-                    2: 'Second page', // Any page number is working. 1-based index
-                    default: '<span style="color: #444;">{{page}}</span>/<span>{{pages}}</span>', // fallback value
-                    last: 'Last Page'
-                }
-            }
-        };
-    ```
-- Step 5 - Provide HTML, user data and PDF path for output
-  ```javascript
-  var users = [
-    {
-      name: "Shyam",
-      age: "26",
-    },
-    {
-      name: "Navjot",
-      age: "26",
-    },
-    {
-      name: "Vitthal",
-      age: "26",
+# pdf-creator-node
+Convert **HTML + Handlebars** templates to **PDF** in Node.js (via [html-pdf](https://www.npmjs.com/package/html-pdf)).
+**Requirements:** [Node.js](https://nodejs.org/) 18 or newer.
+## Install
+```bash
+npm i pdf-creator-node
+```
+## Quick usage
+```javascript
+const pdf = require("pdf-creator-node");
+const fs = require("fs");
+const html = fs.readFileSync("template.html", "utf8");
+const options = {
+  format: "A3",
+  orientation: "portrait",
+  border: "10mm",
+};
+const document = {
+  html,
+  data: { users: [{ name: "Ada", age: 36 }] },
+  path: "./output.pdf",
+  // type: ""  // optional; omit or use "" / "file" for file output
+};
+pdf
+  .create(document, options)
+  .then((res) => console.log(res))
+  .catch((err) => console.error(err));
+```
+### TypeScript
+```typescript
+import pdf from "pdf-creator-node";
+import type { PdfDocument, PdfCreateOptions } from "pdf-creator-node";
+const document: PdfDocument = {
+  html: "<p>{{title}}</p>",
+  data: { title: "Hello" },
+  path: "./out.pdf",
+};
+const options: PdfCreateOptions = {
+  format: "A4",
+  orientation: "portrait",
+};
+await pdf.create(document, options);
+```
+### Output type
+- **File (default):** set `path`. You can omit `type`, or use `type: ""` or `type: "file"`.
+- **Buffer:** `type: "buffer"`.
+- **Stream:** `type: "stream"`.
+### Layout, header, footer, and copyright (`pdfChrome`)
+Use **`pdfChrome`** on the second argument for common paper layout and repeating header/footer without hand-writing `html-pdf` structures. Plain `title` / `copyright` strings are HTML-escaped.
+- **`layout`:** `format`, `orientation`, `width`, `height`, `border` (same meaning as [html-pdf](https://www.npmjs.com/package/html-pdf) / Phantom paper size).
+- **`header`:** `html` (raw HTML per page) **or** `title` (centered text). Default height `45mm` when content is set.
+- **`footer`:** `html` **or** combine **`copyright`** with optional **`showPageNumbers`** (`{{page}}` / `{{pages}}`). With `copyright` only, page numbers default **on** unless you set `showPageNumbers: false`. For **page numbers only**, set `showPageNumbers: true` and omit `copyright`. Default footer height `28mm` when content is set.
+Anything you set directly on the options object (`format`, `header`, `footer`, …) **overrides** the matching field from `pdfChrome`.
+```javascript
+pdf.create(document, {
+  pdfChrome: {
+    layout: { format: "A4", orientation: "portrait", border: "12mm" },
+    header: { title: "Quarterly report" },
+    footer: { copyright: "© 2026 My Company", showPageNumbers: true },
+  },
+});
+```
+Advanced: `buildPdfChrome(pdfChrome)` returns partial html-pdf options if you want to compose manually (also exported from the package).
+### Optional Handlebars helpers
+Pass `handlebarsHelpers` on the **second** argument (alongside `html-pdf` options). Helpers apply only to that render (isolated Handlebars instance). Built-in `ifCond` is always registered.
+```javascript
+pdf.create(
+  {
+    html: "<p>{{upper name}}</p>",
+    data: { name: "test" },
+    path: "./out.pdf",
+  },
+  {
+    format: "A4",
+    handlebarsHelpers: {
+      upper: (s) => String(s).toUpperCase(),
     },
-  ];
-  var document = {
-    html: html,
-    data: {
-      users: users,
+  }
+);
+```
+### Validation errors
+You may see explicit errors such as:
+- `document.html` must be a non-empty string
+- `document.data` is required (use `{}` if there are no variables)
+- `document.path` is required when writing a file (or use `buffer` / `stream`)
+- `template rendering failed:` … (Handlebars compile/render issue)
+## HTML template
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>Hello world!</title>
+  </head>
+  <body>
+    <h1>User List</h1>
+    <ul>
+      {{#each users}}
+      <li>Name: {{this.name}}</li>
+      <li>Age: {{this.age}}</li>
+      {{/each}}
+    </ul>
+  </body>
+</html>
+```
+## PDF options (html-pdf)
+Examples:
+- **Size:** `"height": "10.5in"`, `"width": "8in"` (units: mm, cm, in, px)
+- **Or:** `"format": "Letter"` (A3, A4, A5, Legal, Letter, Tabloid) and `"orientation": "portrait"` or `"landscape"`
+```javascript
+const options = {
+  format: "A3",
+  orientation: "portrait",
+  border: "10mm",
+  header: {
+    height: "45mm",
+    contents: '<div style="text-align: center;">Author: Shyam Hajare</div>',
+  },
+  footer: {
+    height: "28mm",
+    contents: {
+      first: "Cover page",
+      2: "Second page",
+      default:
+        '<span style="color: #444;">{{page}}</span>/<span>{{pages}}</span>',
+      last: "Last Page",
     },
-    path: "./output.pdf",
-    type: "",
-  };
-  // By default a file is created but you could switch between Buffer and Streams by using "buffer" or "stream" respectively.
-  ```
-- Step 6 - After setting all parameters, just pass document and options to `pdf.create` method.
-  ```javascript
-  pdf
-    .create(document, options)
-    .then((res) => {
-      console.log(res);
-    })
-    .catch((error) => {
-      console.error(error);
-    });
-  ```
-### If Conditional Checks
-You can do conditional checks by calling helper block _ifCond_ example
-```js
+  },
+};
+```
+## `ifCond` helper
+Compare two values in the template:
+```handlebars
 {{#ifCond inputData "===" toCheckValue}}
+  …
+{{/ifCond}}
 ```
-  ```html
-  <!DOCTYPE html>
-  <html>
-    <head>
-      <meta charset="utf-8" />
-      <title>Hello world!</title>
-    </head>
-    <body>
-      <h1>User List</h1>
-      <ul>
-        {{#each users}}
-        <li>Name: {{this.name}}</li>
-        <li>Age: {{#ifCond this.age '===' '26'}}</li>
-        <br />
-        {{/ifCond}}
-        {{/each}}
-      </ul>
-    </body>
-  </html>
-  ```
-Can check variables with different type ie _string_, _integer_, _boolean_, _double_
-Other logical operators are-:
-- ==
-   ```js
-    {{#ifCond inputData "==" toCheckValue}}
-   ```
-- ===
-   ```js
-    {{#ifCond inputData "===" toCheckValue}}
-   ```
-- !=
-   ```js
-    {{#ifCond inputData "!=" toCheckValue}}
-   ```
-- !==
-   ```js
-    {{#ifCond inputData "!==" toCheckValue}}
-   ```
-- <
-   ```js
-    {{#ifCond inputData "<" toCheckValue}}
-   ```
-- <=
-   ```js
-    {{#ifCond inputData "<=" toCheckValue}}
-   ```
-- '>
-   ```js
-    {{#ifCond inputData ">" toCheckValue}}
-   ```
-- '>=
-   ```js
-    {{#ifCond inputData ">=" toCheckValue}}
-   ```
-- &&
-   ```js
-    {{#ifCond inputData "&&" toCheckValue}}
-   ```
-- ||
-   ```js
-    {{#ifCond inputData "||" toCheckValue}}
-   ```
-##NOTE!!
-You can only match 2 variables
-### End
-### License
-pdf-creator-node is [MIT licensed](./LICENSE).
+Example with `each`:
+```html
+<ul>
+  {{#each users}}
+  <li>
+    {{this.name}}
+    {{#ifCond this.age "===" "26"}}
+      (twenty-six)
+    {{/ifCond}}
+  </li>
+  {{/each}}
+</ul>
+```
+Supported operators: `==`, `===`, `!=`, `!==`, `<`, `<=`, `>`, `>=`, `&&`, `||`.
+**Note:** Only two operands are compared per `ifCond`.
+## License
+[MIT](LICENSE)

package/example/index.js DELETED Viewed

@@ -1,54 +0,0 @@
-var pdf = require("pdf-creator-node");
-// var pdf = require("../index");
-var fs = require("fs");
-var path = require("path");
-// Read HTML Template
-var html = fs.readFileSync(path.join(__dirname, "./template.html"), "utf8");
-var options = {
-  format: "A3",
-  orientation: "portrait",
-  border: "10mm",
-};
-var users = [
-  {
-    name: "Shyam",
-    age: "26",
-  },
-  {
-    name: "Navjot",
-    age: "26",
-  },
-  {
-    name: "Vitthal",
-    age: "26",
-  },
-];
-var document = {
-  html: html,
-  data: {
-    users: users,
-  },
-  path: "./output.pdf",
-  type: "",
-};
-// By default a file is created but you could switch between Buffer and Streams by using "buffer" or "stream" respectively.
-var document = {
-  html: html,
-  data: {
-    users,
-  },
-  path: "./output.pdf",
-  type: "", // "stream" || "buffer" || "" ("" defaults to pdf)
-};
-pdf
-  .create(document, options)
-  .then((res) => {
-    console.log(res);
-  })
-  .catch((error) => {
-    console.error(error);
-  });

package/example/node_modules/ajv/.tonic_example.js DELETED Viewed

@@ -1,20 +0,0 @@
-var Ajv = require('ajv');
-var ajv = new Ajv({allErrors: true});
-var schema = {
-  "properties": {
-    "foo": { "type": "string" },
-    "bar": { "type": "number", "maximum": 3 }
-  }
-};
-var validate = ajv.compile(schema);
-test({"foo": "abc", "bar": 2});
-test({"foo": 2, "bar": 4});
-function test(data) {
-  var valid = validate(data);
-  if (valid) console.log('Valid!');
-  else console.log('Invalid: ' + ajv.errorsText(validate.errors));
-}

package/example/node_modules/ajv/LICENSE DELETED Viewed

@@ -1,22 +0,0 @@
-The MIT License (MIT)
-Copyright (c) 2015-2017 Evgeny Poberezkin
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.