{"_id":"@bigtechbro/nestjs-html-pdf","_rev":"1-4e9762058087de672d1c09d2207fc58a","name":"@bigtechbro/nestjs-html-pdf","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"version":"0.1.0","license":"MIT","main":"dist/index.js","typings":"dist/index.d.ts","engines":{"node":">=20"},"scripts":{"start":"tsdx watch","build":"tsdx build","test":"tsdx test","lint":"tsdx lint","prepare":"tsdx build","size":"size-limit","analyze":"size-limit --why"},"husky":{"hooks":{"pre-commit":"tsdx lint"}},"prettier":{"printWidth":80,"semi":true,"singleQuote":true,"trailingComma":"es5"},"name":"@bigtechbro/nestjs-html-pdf","module":"dist/nestjs-html-pdf.esm.js","description":"A NestJS module to generate PDF files from HTML","author":{"name":"Ifeanyi Amadi","email":"helloamadiify@gmail.com","url":"https://github.com/line33"},"repository":{"type":"git","url":"git+https://github.com/line33/nestjs-html-pdf.git"},"bugs":{"url":"https://github.com/line33/nestjs-html-pdf/issues"},"homepage":"https://github.com/line33/nestjs-html-pdf#readme","size-limit":[{"path":"dist/nestjs-html-pdf.cjs.production.min.js","limit":"10 KB"},{"path":"dist/nestjs-html-pdf.esm.js","limit":"10 KB"}],"devDependencies":{"@size-limit/preset-small-lib":"^11.1.2","husky":"^9.0.11","size-limit":"^11.1.2","tsdx":"^0.14.1","tslib":"^2.6.2","typescript":"^5.4.5"},"dependencies":{"fs-extra":"^11.2.0","handlebars":"^4.7.8","puppeteer":"^22.8.0"},"_id":"@bigtechbro/nestjs-html-pdf@0.1.0","gitHead":"ed06607fff337b1a261dc990286c15f8b6b593f9","_nodeVersion":"20.12.2","_npmVersion":"10.5.0","dist":{"integrity":"sha512-IFZwx0cbASiZv28nL9BmNqao6CR4R1jjVPjpBtnB/kVfNsiYETmZkctNGxwavA0PUxecogj4eQEI1ezwKdANgA==","shasum":"3ca098e15642198ab122ef5d28888f424aef91e3","tarball":"https://registry.npmjs.org/@bigtechbro/nestjs-html-pdf/-/nestjs-html-pdf-0.1.0.tgz","fileCount":12,"unpackedSize":78597,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD7f/a1N5e90cIczqckOvSHO6LL8puuoVEbyAV3/3wrEgIgIUkmpCrGG5pc3Mth3Kunk5cv+HnkwX/2jH9pf4JpFZU="}]},"_npmUser":{"name":"bigtechbro","email":"helloamadiify@gmail.com"},"directories":{},"maintainers":[{"name":"bigtechbro","email":"helloamadiify@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nestjs-html-pdf_0.1.0_1715273713030_0.6506135865948306"},"_hasShrinkwrap":false},"0.1.1":{"version":"0.1.1","license":"MIT","main":"dist/index.js","typings":"dist/index.d.ts","engines":{"node":">=18"},"scripts":{"start":"tsdx watch","build":"tsdx build","test":"tsdx test","lint":"tsdx lint","prepare":"tsdx build","size":"size-limit","analyze":"size-limit --why"},"husky":{"hooks":{"pre-commit":"tsdx lint"}},"prettier":{"printWidth":80,"semi":true,"singleQuote":true,"trailingComma":"es5"},"name":"@bigtechbro/nestjs-html-pdf","module":"dist/nestjs-html-pdf.esm.js","description":"A NestJS module to generate PDF files from HTML","author":{"name":"Ifeanyi Amadi","email":"helloamadiify@gmail.com","url":"https://github.com/line33"},"repository":{"type":"git","url":"git+https://github.com/line33/nestjs-html-pdf.git"},"bugs":{"url":"https://github.com/line33/nestjs-html-pdf/issues"},"homepage":"https://github.com/line33/nestjs-html-pdf#readme","size-limit":[{"path":"dist/nestjs-html-pdf.cjs.production.min.js","limit":"10 KB"},{"path":"dist/nestjs-html-pdf.esm.js","limit":"10 KB"}],"devDependencies":{"@size-limit/preset-small-lib":"^11.1.2","husky":"^9.0.11","size-limit":"^11.1.2","tsdx":"^0.14.1","tslib":"^2.6.2","typescript":"^5.4.5"},"dependencies":{"fs-extra":"^11.2.0","handlebars":"^4.7.8","puppeteer":"^22.8.0"},"_id":"@bigtechbro/nestjs-html-pdf@0.1.1","gitHead":"89a6a62933a6344060fa5a5a5ddebe5919942691","_nodeVersion":"20.12.2","_npmVersion":"10.5.0","dist":{"integrity":"sha512-rzG3tTsHLe3qpqi+8icSNpwm42G74HOWXBv61FOWl6mormyV2RdQSLICoevyumV0JK0nygK4ffRVlAeu0cXEZg==","shasum":"4717890321d680ecdfc4eb21d4205c400372356b","tarball":"https://registry.npmjs.org/@bigtechbro/nestjs-html-pdf/-/nestjs-html-pdf-0.1.1.tgz","fileCount":12,"unpackedSize":78597,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGN+QD6A9ksMRN+o/jOvx+hs1HtekkHzCoLAA7YWcDegAiEAunG5arBVDkn0VRejXb+QJlHLrilCZFEXhwY+DXb1Zp0="}]},"_npmUser":{"name":"bigtechbro","email":"helloamadiify@gmail.com"},"directories":{},"maintainers":[{"name":"bigtechbro","email":"helloamadiify@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nestjs-html-pdf_0.1.1_1715274219272_0.2240676241026156"},"_hasShrinkwrap":false}},"time":{"created":"2024-05-09T16:55:12.876Z","0.1.0":"2024-05-09T16:55:13.163Z","modified":"2024-05-09T17:03:39.863Z","0.1.1":"2024-05-09T17:03:39.680Z"},"maintainers":[{"name":"bigtechbro","email":"helloamadiify@gmail.com"}],"description":"A NestJS module to generate PDF files from HTML","homepage":"https://github.com/line33/nestjs-html-pdf#readme","repository":{"type":"git","url":"git+https://github.com/line33/nestjs-html-pdf.git"},"author":{"name":"Ifeanyi Amadi","email":"helloamadiify@gmail.com","url":"https://github.com/line33"},"bugs":{"url":"https://github.com/line33/nestjs-html-pdf/issues"},"license":"MIT","readme":"# NEST HTML PDF\n\nA package to generate PDF files from HTML for NestJs\n\n## Installation\n\n`npm i @bigtechbro/nestjs-html-pdf`\n\n## Usage\n\n### Initialization\n\nservice file\n\n```\nimport { Injectable } from '@nestjs/common';\nimport { createPdf } from '@bigtechbro/nestjs-html-pdf';\nimport * as path from 'path';\n```\n\ncall the function create createPdf([filePath], [options], [data])\n\n- `filePath` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type 'String')> It's required. HTML file path.\n- `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object 'Object')> It's optional.\n Default value:\n\n```\n{\n format: 'a4',\n printBackground: true,\n margin: {\n left: '10mm',\n top: '10mm',\n right: '10mm',\n bottom: '10mm',\n }\n}\n```\n\nFor more values [see this link](https://github.com/saemhco/master/pdf-options.txt)\n\n- `data` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object 'Object')> It's optional.\n\n### Quick use\n\nservice file\n\n```\nfirstExample() {\n const filePath = path.join(process.cwd(), 'templates', 'pdf-profile.hbs');\n return createPdf(filePath);\n}\n```\n\npath/pdf-profile.hbs\n\n```\n\n\n \n \n \n Profile\n \n \n \n \n
\n
\n
\n
\n
\n
\n

Saúl Escandón

\n
\n
\n
Sistem enginer & Developer
\n
\n
\n
\n

90%

\n
JavaScript
\n
\n
\n

70%

\n
NodeJs
\n
\n
\n

80%

\n
HTML
\n
\n
\n

75%

\n
PHP
\n
\n
\n
\n
\n
\n
\n \n\n```\n\ncontroller\n\n```\n@Get('pdf')\nasync generatePdf(@Res() res) {\nconst buffer = await this.appService.firstExample();\nres.set({\n // pdf\n 'Content-Type': 'application/pdf',\n 'Content-Disposition': `attachment; filename=pdf.pdf`,\n 'Content-Length': buffer.length,\n // prevent cache\n 'Cache-Control': 'no-cache, no-store, must-revalidate',\n Pragma: 'no-cache',\n Expires: 0,\n});\nres.end(buffer);\n}\n```\n\nResult\n![image](https://user-images.githubusercontent.com/26281994/207532590-f4f7a0db-a620-4912-8137-3803cf748c66.png)\n\n### Other example\n\nservice file\n\n```\nsecondExample() {\n const data = {\n title: 'My PDF file',\n status: 'paid',\n invoiceId: '#123-123',\n customerName: 'Saúl Escandón',\n customerAddress: '1234 Main St',\n customerCity: 'Huánuco',\n customerState: 'Huánuco',\n customerCountry: 'Perú',\n customerPhone: '555-555-5555',\n items: [\n {\n description: 'custom suit',\n detail: {\n color: 'blue',\n size: '42',\n },\n price: {\n price0: 1500.0,\n price: 1050.0,\n save: 25,\n },\n quantity: 1,\n image:\n 'https://mdbcdn.b-cdn.net/img/Photos/Horizontal/E-commerce/new/img(4).webp',\n },\n {\n description: 'playstation 5',\n detail: {\n color: 'white',\n size: '45cmx45cm',\n },\n price: {\n price0: 500.0,\n price: 250.0,\n save: 50,\n },\n quantity: 2,\n image:\n 'https://promart.vteximg.com.br/arquivos/ids/931599-1000-1000/image-b08a9ed36e114598bc56d7d4a5e7dd2d.jpg?v=637569550232800000',\n },\n ],\n subTotal: 1550.0,\n shipping: 15.0,\n total: 1565.0,\n };\n const options = {\n format: 'A4',\n displayHeaderFooter: true,\n margin: {\n left: '10mm',\n top: '25mm',\n right: '10mm',\n bottom: '15mm',\n },\n headerTemplate: `
@saemhco CORP
`,\n footerTemplate:\n '
Page of
',\n landscape: true,\n };\n const filePath = path.join(process.cwd(), 'templates', 'pdf-invoice.hbs');;\n return createPdf(filePath, options, data);\n}\n```\n\npath/pdf-invoice.hbs\n\n```\n\n\n \n \n \n {{title}}\n \n \n \n
\n
\n
\n
\n
\n

Invoice >> ID: {{invoiceId}}

\n
\n
\n
\n
\n
\n
\n
\n
    \n
  • To: {{customerName}}
    • \n
  • {{customerAddress}} | {{customerState}}, {{customerCountry}}
    • \n
  • {{customerPhone}}
    • \n
\n
\n
\n
    \n
  • ID:#123-456
    • \n
  • \n Status:\n {{#ifCond status \"===\" \"paid\"}}\n Unpaid\n {{/ifCond}}\n {{#ifCond status \"===\" \"unpaid\"}}\n Paid\n {{/ifCond}}\n
    • \n
\n
\n
\n
\n {{#each items}}\n
\n
\n \"Elegant\n \n
\n
\n
\n \n
\n
\n
\n

{{description}}

\n

\n Size:{{detail.size}}\n

\n

\n Color:{{detail.color}}\n

\n
\n
\n
\n ${{price.price0}}${{price.price}}\n
\n

You save {{price.save}}%

\n
\n {{/each}}\n\n
\n
\n
\n
\n
    \n
  • SubTotal${{subTotal}}
    • \n
  • Shipping${{shipping}}
    • \n
\n

Total Amount${{total}}

\n
\n
\n
\n
\n
\n
\n \n\n```\n\ncontroller\n\n```\n@Get('pdf')\nasync generatePdf2(@Res() res) {\n const buffer = await this.appService.secondExample();\n res.set({\n // pdf\n 'Content-Type': 'application/pdf',\n 'Content-Disposition': `attachment; filename=pdf.pdf`,\n 'Content-Length': buffer.length,\n // prevent cache\n 'Cache-Control': 'no-cache, no-store, must-revalidate',\n Pragma: 'no-cache',\n Expires: 0,\n });\n res.end(buffer);\n }\n}\n```\n\nResult\n![image](https://user-images.githubusercontent.com/26281994/207534170-ad8ffd45-3385-4c3a-a579-aad5b585e1eb.png)\n\n### More details\n\n---\n\n| JavaScript | HTMLBars OP1 | HTMLBars OP2 |\n| --------------- | ---------------------- | ----------------------------- |\n| `if (a === b)` | `{{#if (eq a b)}}` | `{{#ifCond var1 '===' var2}}` |\n| `if (a !== b)` | `{{#if (not-eq a b)}}` | `{{#ifCond var1 '!==' var2}}` |\n| `if (a && b)` | `{{#if (and a b)}}` | `{{#ifCond var1 '&&' var2}}` |\n| `if (a > b)` | `{{#if (gt a b)}}` | `{{#ifCond var1 '>' var2}}` |\n| `if (a >= b)` | `{{#if (gte a b)}}` | `{{#ifCond var1 '>=' var2}}` |\n| `if (a < b)` | `{{#if (lt a b)}}` | `{{#ifCond var1 '<' var2}}` |\n| `if (a <= b)` | `{{#if (lte a b)}}` | `{{#ifCond var1 '<=' var2}}` |\n| `if (a && b)` | `{{#if (and a b)}}` | `{{#ifCond var1 '&&' var2}}` |\n| `if (a \\|\\| b)` | `{{#if (or a b)}}` | `{{#ifCond var1 \\|\\| var2}}` |\n","readmeFilename":"README.md"}