pdf-node - npm Package Compare versions

Comparing version 0.0.2 to 1.0.0

index.js

 #!/usr/bin/env node
 
-(async () => {
-  console.log("start");
-})();
+const pdf = require('html-pdf');
+const Handlebars = require('handlebars');
+const handleError = require('cli-error-handler');
+
+module.exports = (doc, options) => {
+	return new Promise((resolve, reject) => {
+		if (!doc || !doc.html || !doc.data) {
+			reject(new Error('Some, or all, options are missing.'));
+		}
+		if (doc.type === 'pdf') {
+			
+			// Create PDF from html template generated by handlebars
+			// Output will be PDF file
+			let html = Handlebars.compile(doc.html)(doc.data);
+			let filepath = doc.path;
+			pdf.create(html).toFile(filepath, function (err, res) {
+				if (err) handleError('error in creating file', err);
+				console.log('file generated:', res.filename);
+				resolve(res);
+			});
+		} else {
+			reject('only pdf file type supported');
+		}
+	});
+};

package.json

 {
-  "name": "pdf-node",
-  "version": "0.0.2",
-  "description": "A JavaScript PDF generation library for NodeJs",
-  "main": "index.js",
-  "scripts": {
-    "start": "node index.js",
-    "test": "node test.js",
-    "format": "prettier --write \"./**/*.{js,json}\""
-  },
-  "keywords": [
-    "pdf",
-    "generator",
-    "node pdf generator",
-    "html2pdf",
-    "htmltopdf",
-    "Pdf generator",
-    "node pdf",
-    "npm node pdf",
-    "pdf node",
-    "node pdf parser",
-    "node pdf npm",
-    "node pdf generator from html",
-    "node pdf generator",
-    "node js api pdf",
-    "node pdf converter",
-    "node pdf create",
-    "node pdf export",
-    "node express pdf",
-    "node pdf from html",
-    "node fs pdf",
-    "node generate pdf from html",
-    "node generate pdf report",
-    "node get pdf file",
-    "node js pdf generation",
-    "node js pdf generator module",
-    "node pdf html",
-    "pdf in node js",
-    "node pdf js",
-    "node"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/tawseefnabi/pdf-node.git"
-  },
-  "bugs": {
-    "url": "https://github.com/tawseefnabi/pdf-node/issues"
-  },
-  "homepage": "https://github.com/tawseefnabi/pdf-node#readme",
-  "author": "tawseef <[e-mail]> (https://twitter.com/NabiTowseef)",
-  "license": "MIT",
-  "publishConfig": {
-    "@tawseef:registry": "https://npm.pkg.github.com/",
-    "access": "public"
-  },
-  "devDependencies": {
-    "prettier": "^2.3.2"
-  }
+	"name": "pdf-node",
+	"version": "1.0.0",
+	"description": "A JavaScript PDF generation library for NodeJs",
+	"main": "index.js",
+	"scripts": {
+		"start": "node index.js",
+		"test": "node test.js",
+		"format": "prettier --write \"./**/*.{js,json}\""
+	},
+	"keywords": [
+		"pdf",
+		"generator",
+		"node pdf generator",
+		"html2pdf",
+		"htmltopdf",
+		"Pdf generator",
+		"node pdf",
+		"npm node pdf",
+		"pdf node",
+		"node pdf parser",
+		"node pdf npm",
+		"node pdf generator from html",
+		"node pdf generator",
+		"node js api pdf",
+		"node pdf converter",
+		"node pdf create",
+		"node pdf export",
+		"node express pdf",
+		"node pdf from html",
+		"node fs pdf",
+		"node generate pdf from html",
+		"node generate pdf report",
+		"node get pdf file",
+		"node js pdf generation",
+		"node js pdf generator module",
+		"node pdf html",
+		"pdf in node js",
+		"node pdf js",
+		"node"
+	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/tawseefnabi/pdf-node.git"
+	},
+	"bugs": {
+		"url": "https://github.com/tawseefnabi/pdf-node/issues"
+	},
+	"homepage": "https://github.com/tawseefnabi/pdf-node#readme",
+	"author": "tawseef <[e-mail]> (https://twitter.com/NabiTowseef)",
+	"license": "MIT",
+	"publishConfig": {
+		"@tawseef:registry": "https://npm.pkg.github.com/",
+		"access": "public"
+	},
+	"dependencies": {
+		"cli-error-handler": "^1.0.3",
+		"handlebars": "^4.7.7",
+		"html-pdf": "^3.0.1"
+	},
+	"devDependencies": {
+		"prettier": "^2.3.2"
+	}
 }

readme.md

@@ -14,3 +14,118 @@ # pdf-node
 
+- Step 1 - Add required packages and read HTML template
+
+  ```javascript
+  //Required package
+  var pdf = require("pdf--node");
+  var fs = require("fs");
+
+  // Read HTML Template
+  var html = fs.readFileSync("template.html", "utf8");
+  ```
+
+- Step 2 - Create your HTML Template
+
+  ```html
+  <!DOCTYPE html>
+  <html>
+    <head>
+      <mate charest="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 3 - 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 4 - Provide HTML, user data and PDF path for output
+
+  ```javascript
+  var users = [
+    {
+      name: "tom",
+      age: "21",
+    },
+    {
+      name: "dick",
+      age: "23",
+    },
+    {
+      name: "harry",
+      age: "29",
+    },
+  ];
+  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.
+  ```
+
+- Step 5- 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);
+    });
+  ```
+
+## Reference
+
+Please refer to the following if you want to use conditions in your HTML template:
+
+- https://handlebarsjs.com/builtin_helpers.html
+
+
 <br>
+
 ## Connect
@@ -17,0 +132,0 @@

Fixed alerts

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

22312

increased by484.24%

Number of package files

8

increased by60%

Lines of code

84

increased by2000%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

143

increased by410.71%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

3

increased byInfinity%

Dependency changes

• + Addedcli-error-handler@^1.0.3

• + Addedhandlebars@^4.7.7

• + Addedhtml-pdf@^3.0.1

• + Addedajv@6.12.6(transitive)

• + Addedansi-styles@3.2.14.3.0(transitive)

• + Addedasn1@0.2.6(transitive)

• + Addedassert-plus@1.0.0(transitive)

• + Addedasynckit@0.4.0(transitive)

• + Addedaws-sign2@0.7.0(transitive)

• + Addedaws4@1.13.0(transitive)

• + Addedbcrypt-pbkdf@1.0.2(transitive)

• + Addedbuffer-crc32@0.2.13(transitive)

• + Addedbuffer-from@1.1.2(transitive)

• + Addedcaseless@0.12.0(transitive)

• + Addedchalk@2.4.24.1.2(transitive)

• + Addedcli-error-handler@1.0.3(transitive)

• + Addedcolor-convert@1.9.32.0.1(transitive)

• + Addedcolor-name@1.1.31.1.4(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addedconcat-stream@1.6.2(transitive)

• + Addedcore-util-is@1.0.21.0.3(transitive)

• + Addeddashdash@1.14.1(transitive)

• + Addeddebug@2.6.9(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addedecc-jsbn@0.1.2(transitive)

• + Addedes6-promise@4.2.8(transitive)

• + Addedescape-string-regexp@1.0.5(transitive)

• + Addedextend@3.0.2(transitive)

• + Addedextract-zip@1.7.0(transitive)

• + Addedextsprintf@1.3.0(transitive)

• + Addedfast-deep-equal@3.1.3(transitive)

• + Addedfast-json-stable-stringify@2.1.0(transitive)

• + Addedfd-slicer@1.1.0(transitive)

• + Addedforever-agent@0.6.1(transitive)

• + Addedform-data@2.3.3(transitive)

• + Addedfs-extra@1.0.0(transitive)

• + Addedgetpass@0.1.7(transitive)

• + Addedgraceful-fs@4.2.11(transitive)

• + Addedhandlebars@4.7.8(transitive)

• + Addedhar-schema@2.0.0(transitive)

• + Addedhar-validator@5.1.5(transitive)

• + Addedhas-flag@3.0.04.0.0(transitive)

• + Addedhasha@2.2.0(transitive)

• + Addedhtml-pdf@3.0.1(transitive)

• + Addedhttp-signature@1.2.0(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedis-stream@1.1.0(transitive)

• + Addedis-typedarray@1.0.0(transitive)

• + Addedisarray@1.0.0(transitive)

• + Addedisexe@2.0.0(transitive)

• + Addedisstream@0.1.2(transitive)

• + Addedjsbn@0.1.1(transitive)

• + Addedjson-schema@0.4.0(transitive)

• + Addedjson-schema-traverse@0.4.1(transitive)

• + Addedjson-stringify-safe@5.0.1(transitive)

• + Addedjsonfile@2.4.0(transitive)

• + Addedjsprim@1.4.2(transitive)

• + Addedkew@0.7.0(transitive)

• + Addedklaw@1.3.1(transitive)

• + Addedlog-symbols@3.0.0(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedmkdirp@0.5.6(transitive)

• + Addedms@2.0.0(transitive)

• + Addedneo-async@2.6.2(transitive)

• + Addedoauth-sign@0.9.0(transitive)

• + Addedpend@1.2.0(transitive)

• + Addedperformance-now@2.1.0(transitive)

• + Addedphantomjs-prebuilt@2.1.16(transitive)

• + Addedpinkie@2.0.4(transitive)

• + Addedpinkie-promise@2.0.1(transitive)

• + Addedprocess-nextick-args@2.0.1(transitive)

• + Addedprogress@1.1.8(transitive)

• + Addedpsl@1.9.0(transitive)

• + Addedpunycode@2.3.1(transitive)

• + Addedqs@6.5.3(transitive)

• + Addedreadable-stream@2.3.8(transitive)

• + Addedrequest@2.88.2(transitive)

• + Addedrequest-progress@2.0.1(transitive)

• + Addedsafe-buffer@5.1.2(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsource-map@0.6.1(transitive)

• + Addedsshpk@1.18.0(transitive)

• + Addedstring_decoder@1.1.1(transitive)

• + Addedsupports-color@5.5.07.2.0(transitive)

• + Addedthrottleit@1.0.1(transitive)

• + Addedtough-cookie@2.5.0(transitive)

• + Addedtunnel-agent@0.6.0(transitive)

• + Addedtweetnacl@0.14.5(transitive)

• + Addedtypedarray@0.0.6(transitive)

• + Addeduglify-js@3.18.0(transitive)

• + Addeduri-js@4.4.1(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addeduuid@3.4.0(transitive)

• + Addedverror@1.10.0(transitive)

• + Addedwhich@1.3.1(transitive)

• + Addedwordwrap@1.0.0(transitive)

• + Addedyauzl@2.10.0(transitive)