Compare commits
36 Commits
Author | SHA1 | Date | |
---|---|---|---|
040bac5256 | |||
bf44901a0a | |||
b4d0f4e949 | |||
b2b47b1f6a | |||
1b1398653b | |||
1f61dcb115 | |||
1476fc9174 | |||
d157a3acd9 | |||
fe6be928a9 | |||
8e537be454 | |||
6947529e02 | |||
b6d78929b9 | |||
e997189a64 | |||
31940deb7a | |||
922c6da234 | |||
aa8fb165eb | |||
4cd4431565 | |||
826183be8c | |||
6d9b7ee0e4 | |||
3c66acb653 | |||
aa0ad1dce5 | |||
65756457aa | |||
67f21d2500 | |||
1cf095a5cc | |||
ffeaec7fe9 | |||
a31e196e5b | |||
57851d90a5 | |||
1e4b16b734 | |||
876466b18d | |||
82b1c187ee | |||
4f93d258b8 | |||
60993fc005 | |||
db4965c8f5 | |||
36a964d931 | |||
6d90f4c9b4 | |||
839eafd73f |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
name: Default (not tags)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags-ignore:
|
||||||
|
- '**'
|
||||||
|
|
||||||
|
env:
|
||||||
|
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||||
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
|
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
security:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Install pnpm and npmci
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
|
||||||
|
- name: Run npm prepare
|
||||||
|
run: npmci npm prepare
|
||||||
|
|
||||||
|
- name: Audit production dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --prod
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Audit development dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --dev
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
test:
|
||||||
|
if: ${{ always() }}
|
||||||
|
needs: security
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Test stable
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm test
|
||||||
|
|
||||||
|
- name: Test build
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm build
|
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal file
@ -0,0 +1,124 @@
|
|||||||
|
name: Default (tags)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- '*'
|
||||||
|
|
||||||
|
env:
|
||||||
|
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||||
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
|
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
security:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Audit production dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --prod
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Audit development dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --dev
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
test:
|
||||||
|
if: ${{ always() }}
|
||||||
|
needs: security
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Test stable
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm test
|
||||||
|
|
||||||
|
- name: Test build
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm build
|
||||||
|
|
||||||
|
release:
|
||||||
|
needs: test
|
||||||
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Release
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm publish
|
||||||
|
|
||||||
|
metadata:
|
||||||
|
needs: test
|
||||||
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Code quality
|
||||||
|
run: |
|
||||||
|
npmci command npm install -g typescript
|
||||||
|
npmci npm install
|
||||||
|
|
||||||
|
- name: Trigger
|
||||||
|
run: npmci trigger
|
||||||
|
|
||||||
|
- name: Build docs and upload artifacts
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
pnpm install -g @git.zone/tsdoc
|
||||||
|
npmci command tsdoc
|
||||||
|
continue-on-error: true
|
137
.gitlab-ci.yml
137
.gitlab-ci.yml
@ -1,137 +0,0 @@
|
|||||||
# gitzone ci_default
|
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|
||||||
|
|
||||||
cache:
|
|
||||||
paths:
|
|
||||||
- .npmci_cache/
|
|
||||||
key: '$CI_BUILD_STAGE'
|
|
||||||
|
|
||||||
stages:
|
|
||||||
- security
|
|
||||||
- test
|
|
||||||
- release
|
|
||||||
- metadata
|
|
||||||
|
|
||||||
# ====================
|
|
||||||
# security stage
|
|
||||||
# ====================
|
|
||||||
mirror:
|
|
||||||
stage: security
|
|
||||||
script:
|
|
||||||
- npmci git mirror
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
tags:
|
|
||||||
- lossless
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
|
|
||||||
auditProductionDependencies:
|
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|
||||||
stage: security
|
|
||||||
script:
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci command npm install --production --ignore-scripts
|
|
||||||
- npmci command npm config set registry https://registry.npmjs.org
|
|
||||||
- npmci command npm audit --audit-level=high --only=prod --production
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
auditDevDependencies:
|
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|
||||||
stage: security
|
|
||||||
script:
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci command npm install --ignore-scripts
|
|
||||||
- npmci command npm config set registry https://registry.npmjs.org
|
|
||||||
- npmci command npm audit --audit-level=high --only=dev
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
allow_failure: true
|
|
||||||
|
|
||||||
# ====================
|
|
||||||
# test stage
|
|
||||||
# ====================
|
|
||||||
|
|
||||||
testStable:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci node install stable
|
|
||||||
- npmci npm install
|
|
||||||
- npmci npm test
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
testBuild:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci node install stable
|
|
||||||
- npmci npm install
|
|
||||||
- npmci command npm run build
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
release:
|
|
||||||
stage: release
|
|
||||||
script:
|
|
||||||
- npmci node install stable
|
|
||||||
- npmci npm publish
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
tags:
|
|
||||||
- lossless
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
|
|
||||||
# ====================
|
|
||||||
# metadata stage
|
|
||||||
# ====================
|
|
||||||
codequality:
|
|
||||||
stage: metadata
|
|
||||||
allow_failure: true
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
script:
|
|
||||||
- npmci command npm install -g tslint typescript
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci npm install
|
|
||||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
|
||||||
tags:
|
|
||||||
- lossless
|
|
||||||
- docker
|
|
||||||
- priv
|
|
||||||
|
|
||||||
trigger:
|
|
||||||
stage: metadata
|
|
||||||
script:
|
|
||||||
- npmci trigger
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
tags:
|
|
||||||
- lossless
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
|
|
||||||
pages:
|
|
||||||
stage: metadata
|
|
||||||
script:
|
|
||||||
- npmci node install lts
|
|
||||||
- npmci command npm install -g @gitzone/tsdoc
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci npm install
|
|
||||||
- npmci command tsdoc
|
|
||||||
tags:
|
|
||||||
- lossless
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
artifacts:
|
|
||||||
expire_in: 1 week
|
|
||||||
paths:
|
|
||||||
- public
|
|
||||||
allow_failure: true
|
|
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@ -2,28 +2,10 @@
|
|||||||
"version": "0.2.0",
|
"version": "0.2.0",
|
||||||
"configurations": [
|
"configurations": [
|
||||||
{
|
{
|
||||||
"name": "current file",
|
"command": "npm test",
|
||||||
"type": "node",
|
"name": "Run npm test",
|
||||||
"request": "launch",
|
"request": "launch",
|
||||||
"args": [
|
"type": "node-terminal"
|
||||||
"${relativeFile}"
|
|
||||||
],
|
|
||||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
|
||||||
"cwd": "${workspaceRoot}",
|
|
||||||
"protocol": "inspector",
|
|
||||||
"internalConsoleOptions": "openOnSessionStart"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "test.ts",
|
|
||||||
"type": "node",
|
|
||||||
"request": "launch",
|
|
||||||
"args": [
|
|
||||||
"test/test.ts"
|
|
||||||
],
|
|
||||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
|
||||||
"cwd": "${workspaceRoot}",
|
|
||||||
"protocol": "inspector",
|
|
||||||
"internalConsoleOptions": "openOnSessionStart"
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
@ -6,12 +6,29 @@
|
|||||||
"gitzone": {
|
"gitzone": {
|
||||||
"projectType": "npm",
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "code.foss.global",
|
||||||
"gitscope": "pushrocks",
|
"gitscope": "push.rocks",
|
||||||
"gitrepo": "smartpdf",
|
"gitrepo": "smartpdf",
|
||||||
"shortDescription": "Create PDFs fast and smoothly",
|
"description": "A library for creating PDFs dynamically from HTML or websites with additional features like merging PDFs.",
|
||||||
"npmPackagename": "@pushrocks/smartpdf",
|
"npmPackagename": "@push.rocks/smartpdf",
|
||||||
"license": "MIT"
|
"license": "MIT",
|
||||||
|
"keywords": [
|
||||||
|
"PDF generation",
|
||||||
|
"HTML to PDF",
|
||||||
|
"website to PDF",
|
||||||
|
"PDF manipulation",
|
||||||
|
"puppeteer",
|
||||||
|
"express",
|
||||||
|
"node.js",
|
||||||
|
"typescript",
|
||||||
|
"automation",
|
||||||
|
"PDF merging",
|
||||||
|
"text extraction",
|
||||||
|
"PDF management"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"tsdoc": {
|
||||||
|
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||||
}
|
}
|
||||||
}
|
}
|
10667
package-lock.json
generated
10667
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
59
package.json
59
package.json
@ -1,8 +1,8 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartpdf",
|
"name": "@push.rocks/smartpdf",
|
||||||
"version": "3.0.6",
|
"version": "3.1.3",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "create pdfs on the fly",
|
"description": "A library for creating PDFs dynamically from HTML or websites with additional features like merging PDFs.",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
@ -10,27 +10,32 @@
|
|||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/ --web)",
|
"test": "(tstest test/ --web)",
|
||||||
"build": "(tsbuild --web --allowimplicitany)"
|
"build": "(tsbuild --web --allowimplicitany)",
|
||||||
|
"buildDocs": "tsdoc"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.63",
|
"@git.zone/tsbuild": "^2.1.66",
|
||||||
"@gitzone/tsrun": "^1.2.35",
|
"@git.zone/tsdoc": "^1.1.12",
|
||||||
"@gitzone/tstest": "^1.0.71",
|
"@git.zone/tsrun": "^1.2.44",
|
||||||
"@pushrocks/tapbundle": "^5.0.3",
|
"@git.zone/tstest": "^1.0.77",
|
||||||
"@types/node": "^17.0.42"
|
"@push.rocks/tapbundle": "^5.0.23",
|
||||||
|
"@types/node": "^20.12.7"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/smartfile": "^10.0.2",
|
"@push.rocks/smartbuffer": "^3.0.4",
|
||||||
"@pushrocks/smartnetwork": "^3.0.0",
|
"@push.rocks/smartdelay": "^3.0.5",
|
||||||
"@pushrocks/smartpath": "^5.0.5",
|
"@push.rocks/smartfile": "^11.0.14",
|
||||||
"@pushrocks/smartpromise": "^3.1.7",
|
"@push.rocks/smartnetwork": "^3.0.0",
|
||||||
"@pushrocks/smartpuppeteer": "^2.0.0",
|
"@push.rocks/smartpath": "^5.0.18",
|
||||||
"@pushrocks/smartunique": "^3.0.3",
|
"@push.rocks/smartpromise": "^4.0.3",
|
||||||
"@tsclass/tsclass": "^4.0.15",
|
"@push.rocks/smartpuppeteer": "^2.0.2",
|
||||||
"@types/express": "^4.17.13",
|
"@push.rocks/smartunique": "^3.0.9",
|
||||||
"express": "^4.18.1",
|
"@tsclass/tsclass": "^4.0.54",
|
||||||
"pdf-merger-js": "^3.4.0",
|
"@types/express": "^4.17.21",
|
||||||
"pdf2json": "^2.0.0"
|
"express": "^4.19.2",
|
||||||
|
"pdf-lib": "^1.17.1",
|
||||||
|
"pdf2json": "^3.0.5",
|
||||||
|
"pdf2pic": "^3.1.1"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/**/*",
|
"ts/**/*",
|
||||||
@ -46,5 +51,19 @@
|
|||||||
],
|
],
|
||||||
"browserslist": [
|
"browserslist": [
|
||||||
"last 1 chrome versions"
|
"last 1 chrome versions"
|
||||||
|
],
|
||||||
|
"keywords": [
|
||||||
|
"PDF generation",
|
||||||
|
"HTML to PDF",
|
||||||
|
"website to PDF",
|
||||||
|
"PDF manipulation",
|
||||||
|
"puppeteer",
|
||||||
|
"express",
|
||||||
|
"node.js",
|
||||||
|
"typescript",
|
||||||
|
"automation",
|
||||||
|
"PDF merging",
|
||||||
|
"text extraction",
|
||||||
|
"PDF management"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
4929
pnpm-lock.yaml
generated
Normal file
4929
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
|
133
readme.md
133
readme.md
@ -1,41 +1,116 @@
|
|||||||
# @pushrocks/smartpdf
|
# @push.rocks/smartpdf
|
||||||
Create PDFs fast and smoothly
|
Create PDFs on the fly
|
||||||
|
|
||||||
## Availabililty and Links
|
## Install
|
||||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartpdf)
|
To install `@push.rocks/smartpdf`, use the following command with npm:
|
||||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartpdf)
|
|
||||||
* [github.com (source mirror)](https://github.com/pushrocks/smartpdf)
|
|
||||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartpdf/)
|
|
||||||
|
|
||||||
## Status for master
|
```bash
|
||||||
|
npm install @push.rocks/smartpdf --save
|
||||||
|
```
|
||||||
|
|
||||||
Status Category | Status Badge
|
Or with yarn:
|
||||||
-- | --
|
|
||||||
GitLab Pipelines | [](https://lossless.cloud)
|
```bash
|
||||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
yarn add @push.rocks/smartpdf
|
||||||
npm | [](https://lossless.cloud)
|
```
|
||||||
Snyk | [](https://lossless.cloud)
|
|
||||||
TypeScript Support | [](https://lossless.cloud)
|
|
||||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
Code Style | [](https://lossless.cloud)
|
|
||||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
||||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
||||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
||||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
This documentation will guide you through using `@push.rocks/smartpdf` to create PDFs in various ways, such as from HTML strings or full web pages, and provides examples on how to merge multiple PDFs into one. Remember, all examples provided here use ESM syntax and TypeScript.
|
||||||
|
|
||||||
## Contribution
|
### Getting Started
|
||||||
|
First, ensure you have the package installed and you can import it into your TypeScript project:
|
||||||
|
|
||||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
```typescript
|
||||||
|
import { SmartPdf, IPdf } from '@push.rocks/smartpdf';
|
||||||
|
```
|
||||||
|
|
||||||
## Contribution
|
### Creating a PDF from an HTML String
|
||||||
|
To create a PDF from a simple HTML string, you’ll need to instantiate `SmartPdf` and call `getA4PdfResultForHtmlString`.
|
||||||
|
|
||||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
```typescript
|
||||||
|
async function createPdfFromHtml() {
|
||||||
|
const smartPdf = await SmartPdf.create();
|
||||||
|
await smartPdf.start();
|
||||||
|
const htmlString = `<h1>Hello World</h1>`;
|
||||||
|
const pdf: IPdf = await smartPdf.getA4PdfResultForHtmlString(htmlString);
|
||||||
|
console.log(pdf.buffer); // This is your PDF buffer
|
||||||
|
await smartPdf.stop();
|
||||||
|
}
|
||||||
|
createPdfFromHtml();
|
||||||
|
```
|
||||||
|
|
||||||
For further information read the linked docs at the top of this readme.
|
### Generating a PDF from a Website
|
||||||
|
You may want to capture a full webpage as a PDF. `SmartPdf` provides two methods to accomplish this. One captures the viewable area as an A4 pdf, and the other captures the entire webpage.
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
#### A4 PDF from a Website
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
|
||||||
|
|
||||||
[](https://maintainedby.lossless.com)
|
```typescript
|
||||||
|
async function createA4PdfFromWebsite() {
|
||||||
|
const smartPdf = await SmartPdf.create();
|
||||||
|
await smartPdf.start();
|
||||||
|
const pdf: IPdf = await smartPdf.getPdfResultForWebsite('https://example.com');
|
||||||
|
console.log(pdf.buffer); // PDF buffer of the webpage
|
||||||
|
await smartPdf.stop();
|
||||||
|
}
|
||||||
|
createA4PdfFromWebsite();
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Full Webpage as a Single PDF
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
async function createFullPdfFromWebsite() {
|
||||||
|
const smartPdf = await SmartPdf.create();
|
||||||
|
await smartPdf.start();
|
||||||
|
const pdf: IPdf = await smartPdf.getFullWebsiteAsSinglePdf('https://example.com');
|
||||||
|
console.log(pdf.buffer); // PDF buffer with the full webpage
|
||||||
|
await smartPdf.stop();
|
||||||
|
}
|
||||||
|
createFullPdfFromWebsite();
|
||||||
|
```
|
||||||
|
|
||||||
|
### Merging Multiple PDFs
|
||||||
|
If you have multiple PDF objects (`IPdf`) that you wish to merge into a single PDF file, you can use the `mergePdfs` method.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
async function mergePdfs() {
|
||||||
|
const smartPdf = await SmartPdf.create();
|
||||||
|
// Assume pdf1 and pdf2 are objects of type IPdf that you want to merge
|
||||||
|
const mergedPdf: IPdf = await smartPdf.mergePdfs([pdf1, pdf2]);
|
||||||
|
console.log(mergedPdf.buffer); // Buffer of the merged PDF
|
||||||
|
}
|
||||||
|
mergePdfs();
|
||||||
|
```
|
||||||
|
|
||||||
|
### Reading PDF from Disk and Extracting Text
|
||||||
|
To read a PDF from the disk and extract its text content:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
async function readAndExtractFromPdf() {
|
||||||
|
const smartPdf = await SmartPdf.create();
|
||||||
|
const pdf: IPdf = await smartPdf.readFileToPdfObject('/path/to/your/pdf/file.pdf');
|
||||||
|
const extractedText = await smartPdf.extractTextFromPdfBuffer(pdf.buffer);
|
||||||
|
console.log(extractedText); // Extracted text from the PDF
|
||||||
|
}
|
||||||
|
readAndExtractFromPdf();
|
||||||
|
```
|
||||||
|
|
||||||
|
This guide provides a comprehensive overview of generating PDFs using `@push.rocks/smartpdf`. Remember to start and stop your `SmartPdf` instance to properly initialize and clean up resources, especially when working with server-side rendering or capturing web pages.
|
||||||
|
|
||||||
|
## License and Legal Information
|
||||||
|
|
||||||
|
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||||
|
|
||||||
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
### Trademarks
|
||||||
|
|
||||||
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||||
|
|
||||||
|
### Company Information
|
||||||
|
|
||||||
|
Task Venture Capital GmbH
|
||||||
|
Registered at District court Bremen HRB 35230 HB, Germany
|
||||||
|
|
||||||
|
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||||
|
|
||||||
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||||
|
20
test/test.ts
20
test/test.ts
@ -1,4 +1,4 @@
|
|||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
import { expect, tap } from '@push.rocks/tapbundle';
|
||||||
import * as smartpdf from '../ts/index.js';
|
import * as smartpdf from '../ts/index.js';
|
||||||
|
|
||||||
let testSmartPdf: smartpdf.SmartPdf;
|
let testSmartPdf: smartpdf.SmartPdf;
|
||||||
@ -39,17 +39,25 @@ tap.test('should create a valid PDFResult', async () => {
|
|||||||
}
|
}
|
||||||
fs.writeFileSync(`.nogit/${fileName}`, pdfResult.buffer as Buffer);
|
fs.writeFileSync(`.nogit/${fileName}`, pdfResult.buffer as Buffer);
|
||||||
};
|
};
|
||||||
await writePDfToDisk('https://maintainedby.lossless.com/', '1.pdf')
|
await writePDfToDisk('https://lossless.com/', '1.pdf');
|
||||||
await writePDfToDisk('https://rendertron.lossless.one/render/https://layer.io', '2.pdf')
|
await writePDfToDisk('https://layer.io', '2.pdf');
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('should combine pdfs', async () => {
|
tap.test('should merge pdfs', async () => {
|
||||||
const fs = await import('fs');
|
const fs = await import('fs');
|
||||||
const pdf1 = await testSmartPdf.readFileToPdfObject('.nogit/1.pdf');
|
const pdf1 = await testSmartPdf.readFileToPdfObject('.nogit/1.pdf');
|
||||||
const pdf2 = await testSmartPdf.readFileToPdfObject('.nogit/2.pdf');
|
const pdf2 = await testSmartPdf.readFileToPdfObject('.nogit/2.pdf');
|
||||||
fs.writeFileSync(`.nogit/combined.pdf`, (await testSmartPdf.mergePdfs([pdf1, pdf2])).buffer as Buffer);
|
fs.writeFileSync(
|
||||||
|
`.nogit/combined.pdf`,
|
||||||
|
await testSmartPdf.mergePdfs([pdf1.buffer, pdf2.buffer])
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
})
|
tap.test('should create images from an pdf', async () => {
|
||||||
|
const pdfObject = await testSmartPdf.readFileToPdfObject('.nogit/combined.pdf');
|
||||||
|
const images = await testSmartPdf.convertPDFToJPGBytes(pdfObject.buffer);
|
||||||
|
console.log(images);
|
||||||
|
});
|
||||||
|
|
||||||
tap.test('should be able to close properly', async () => {
|
tap.test('should be able to close properly', async () => {
|
||||||
await testSmartPdf.stop();
|
await testSmartPdf.stop();
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
* autocreated commitinfo by @pushrocks/commitinfo
|
* autocreated commitinfo by @pushrocks/commitinfo
|
||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@pushrocks/smartpdf',
|
name: '@push.rocks/smartpdf',
|
||||||
version: '3.0.6',
|
version: '3.1.3',
|
||||||
description: 'create pdfs on the fly'
|
description: 'A library for creating PDFs dynamically from HTML or websites with additional features like merging PDFs.'
|
||||||
}
|
}
|
||||||
|
@ -7,3 +7,9 @@ declare global {
|
|||||||
|
|
||||||
// normal
|
// normal
|
||||||
export * from './smartpdf.classes.smartpdf.js';
|
export * from './smartpdf.classes.smartpdf.js';
|
||||||
|
|
||||||
|
// additional types
|
||||||
|
import type * as tsclassTypes from '@tsclass/tsclass';
|
||||||
|
type IPdf = tsclassTypes.business.IPdf;
|
||||||
|
|
||||||
|
export type { IPdf };
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
/*
|
/*
|
||||||
* pdf candidate is a construct used internally for mapping html
|
* pdf candidate is a construct used internally for mapping html
|
||||||
* to pdf buffers delivered by puppeteer
|
* to pdf buffers delivered by puppeteer
|
||||||
*/
|
*/
|
||||||
import * as plugins from './smartpdf.plugins.js';
|
import * as plugins from './smartpdf.plugins.js';
|
||||||
|
|
||||||
export class PdfCandidate {
|
export class PdfCandidate {
|
||||||
|
@ -2,7 +2,7 @@ import * as plugins from './smartpdf.plugins.js';
|
|||||||
import * as paths from './smartpdf.paths.js';
|
import * as paths from './smartpdf.paths.js';
|
||||||
import { Server } from 'http';
|
import { Server } from 'http';
|
||||||
import { PdfCandidate } from './smartpdf.classes.pdfcandidate.js';
|
import { PdfCandidate } from './smartpdf.classes.pdfcandidate.js';
|
||||||
import { IPdf } from '@tsclass/tsclass/dist_ts/business/pdf.js';
|
import { type IPdf } from '@tsclass/tsclass/dist_ts/business/pdf.js';
|
||||||
|
|
||||||
declare const document: any;
|
declare const document: any;
|
||||||
|
|
||||||
@ -26,6 +26,7 @@ export class SmartPdf {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async start(headlessBrowserArg?: plugins.smartpuppeteer.puppeteer.Browser) {
|
async start(headlessBrowserArg?: plugins.smartpuppeteer.puppeteer.Browser) {
|
||||||
|
const done = plugins.smartpromise.defer();
|
||||||
// lets set the external browser in case one is provided
|
// lets set the external browser in case one is provided
|
||||||
this.headlessBrowser = headlessBrowserArg;
|
this.headlessBrowser = headlessBrowserArg;
|
||||||
// setup puppeteer
|
// setup puppeteer
|
||||||
@ -49,7 +50,9 @@ export class SmartPdf {
|
|||||||
this.htmlServerInstance.listen(3210, 'localhost');
|
this.htmlServerInstance.listen(3210, 'localhost');
|
||||||
this.htmlServerInstance.on('listening', () => {
|
this.htmlServerInstance.on('listening', () => {
|
||||||
this._readyDeferred.resolve();
|
this._readyDeferred.resolve();
|
||||||
|
done.resolve();
|
||||||
});
|
});
|
||||||
|
await done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
// stop
|
// stop
|
||||||
@ -81,6 +84,7 @@ export class SmartPdf {
|
|||||||
const response = await page.goto(`http://localhost:3210/${pdfCandidate.pdfId}`, {
|
const response = await page.goto(`http://localhost:3210/${pdfCandidate.pdfId}`, {
|
||||||
waitUntil: 'networkidle2',
|
waitUntil: 'networkidle2',
|
||||||
});
|
});
|
||||||
|
// await plugins.smartdelay.delayFor(1000);
|
||||||
const headers = response.headers();
|
const headers = response.headers();
|
||||||
if (headers['pdf-id'] !== pdfCandidate.pdfId) {
|
if (headers['pdf-id'] !== pdfCandidate.pdfId) {
|
||||||
console.log('Error! Headers do not match. For security reasons no pdf is being emitted!');
|
console.log('Error! Headers do not match. For security reasons no pdf is being emitted!');
|
||||||
@ -179,18 +183,16 @@ export class SmartPdf {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
public async mergePdfs(pdfArrayArg: plugins.tsclass.business.IPdf[]): Promise<IPdf> {
|
public async mergePdfs(inputPdfBuffers: Uint8Array[]): Promise<Uint8Array> {
|
||||||
const merger = new plugins.pdfMerger();
|
const mergedPdf = await plugins.pdfLib.PDFDocument.create();
|
||||||
for (const pdf of pdfArrayArg) {
|
for (const pdfBytes of inputPdfBuffers) {
|
||||||
merger.add(pdf.buffer as Buffer);
|
const pdfDoc = await plugins.pdfLib.PDFDocument.load(pdfBytes);
|
||||||
|
const pages = await mergedPdf.copyPages(pdfDoc, pdfDoc.getPageIndices());
|
||||||
|
pages.forEach((page) => mergedPdf.addPage(page));
|
||||||
}
|
}
|
||||||
const resultBuffer = await merger.saveAsBuffer();
|
|
||||||
return {
|
const mergedPdfBytes = await mergedPdf.save();
|
||||||
name: 'mergedPdf',
|
return mergedPdfBytes;
|
||||||
buffer: resultBuffer,
|
|
||||||
id: null,
|
|
||||||
metadata: null
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public async readFileToPdfObject(pathArg: string): Promise<plugins.tsclass.business.IPdf> {
|
public async readFileToPdfObject(pathArg: string): Promise<plugins.tsclass.business.IPdf> {
|
||||||
@ -201,8 +203,8 @@ export class SmartPdf {
|
|||||||
name: parsedPath.base,
|
name: parsedPath.base,
|
||||||
buffer,
|
buffer,
|
||||||
id: null,
|
id: null,
|
||||||
metadata: null
|
metadata: null,
|
||||||
}
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
public async extractTextFromPdfBuffer(pdfBufferArg: Buffer): Promise<string> {
|
public async extractTextFromPdfBuffer(pdfBufferArg: Buffer): Promise<string> {
|
||||||
@ -222,4 +224,39 @@ export class SmartPdf {
|
|||||||
pdfParser.parseBuffer(pdfBufferArg);
|
pdfParser.parseBuffer(pdfBufferArg);
|
||||||
return deferred.promise;
|
return deferred.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public async convertPDFToJPGBytes(
|
||||||
|
pdfBytes: Uint8Array,
|
||||||
|
options: {
|
||||||
|
width?: number;
|
||||||
|
height?: number;
|
||||||
|
quality?: number;
|
||||||
|
} = {}
|
||||||
|
): Promise<Uint8Array[]> {
|
||||||
|
const { width = 1024, height = 768, quality = 100 } = options;
|
||||||
|
|
||||||
|
// Load the PDF document
|
||||||
|
const pdfDoc = await plugins.pdfLib.PDFDocument.load(pdfBytes);
|
||||||
|
|
||||||
|
const converter = plugins.pdf2pic.fromBuffer(Buffer.from(pdfBytes), {
|
||||||
|
density: 100, // Image density (DPI)
|
||||||
|
format: 'jpg', // Image format
|
||||||
|
width, // Output image width
|
||||||
|
height, // Output image height
|
||||||
|
quality, // Output image quality
|
||||||
|
});
|
||||||
|
|
||||||
|
// Get array promises that resolve to JPG buffers
|
||||||
|
const imagePromises: Promise<Buffer>[] = [];
|
||||||
|
const numPages = pdfDoc.getPageCount();
|
||||||
|
|
||||||
|
for (let i = 0; i < numPages; i++) {
|
||||||
|
imagePromises.push(converter(i + 1, {
|
||||||
|
responseType: 'buffer',
|
||||||
|
}).then((output) => output.buffer));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Resolve all promises and return the array of buffers
|
||||||
|
return Promise.all(imagePromises);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,3 +1,6 @@
|
|||||||
import * as plugins from './smartpdf.plugins.js';
|
import * as plugins from './smartpdf.plugins.js';
|
||||||
|
|
||||||
export const packageDir = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../');
|
export const packageDir = plugins.path.join(
|
||||||
|
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
|
||||||
|
'../'
|
||||||
|
);
|
||||||
|
@ -5,26 +5,35 @@ import * as path from 'path';
|
|||||||
export { http, path };
|
export { http, path };
|
||||||
|
|
||||||
// @pushrocks
|
// @pushrocks
|
||||||
import * as smartfile from '@pushrocks/smartfile';
|
import * as smartbuffer from '@push.rocks/smartbuffer';
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
import * as smartfile from '@push.rocks/smartfile';
|
||||||
import * as smartpath from '@pushrocks/smartpath';
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
import * as smartpuppeteer from '@pushrocks/smartpuppeteer';
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
import * as smartnetwork from '@pushrocks/smartnetwork';
|
import * as smartpath from '@push.rocks/smartpath';
|
||||||
import * as smartunique from '@pushrocks/smartunique';
|
import * as smartpuppeteer from '@push.rocks/smartpuppeteer';
|
||||||
|
import * as smartnetwork from '@push.rocks/smartnetwork';
|
||||||
|
import * as smartunique from '@push.rocks/smartunique';
|
||||||
|
|
||||||
export { smartfile, smartpromise, smartpath, smartpuppeteer, smartunique, smartnetwork };
|
export {
|
||||||
|
smartbuffer,
|
||||||
|
smartfile,
|
||||||
|
smartdelay,
|
||||||
|
smartpromise,
|
||||||
|
smartpath,
|
||||||
|
smartpuppeteer,
|
||||||
|
smartunique,
|
||||||
|
smartnetwork,
|
||||||
|
};
|
||||||
|
|
||||||
// tsclass scope
|
// tsclass scope
|
||||||
import * as tsclass from '@tsclass/tsclass';
|
import * as tsclass from '@tsclass/tsclass';
|
||||||
|
|
||||||
export {
|
export { tsclass };
|
||||||
tsclass
|
|
||||||
}
|
|
||||||
|
|
||||||
// thirdparty
|
// thirdparty
|
||||||
import pdfMerger from 'pdf-merger-js';
|
|
||||||
// @ts-ignore
|
|
||||||
import pdf2json from 'pdf2json';
|
|
||||||
import express from 'express';
|
import express from 'express';
|
||||||
|
import pdf2json from 'pdf2json';
|
||||||
|
import pdf2pic from 'pdf2pic';
|
||||||
|
import pdfLib from 'pdf-lib';
|
||||||
|
|
||||||
export { pdfMerger, pdf2json, express };
|
export { express, pdf2json, pdf2pic, pdfLib, };
|
||||||
|
@ -1,9 +1,14 @@
|
|||||||
{
|
{
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"experimentalDecorators": true,
|
"experimentalDecorators": true,
|
||||||
|
"useDefineForClassFields": false,
|
||||||
"target": "ES2022",
|
"target": "ES2022",
|
||||||
"module": "ES2022",
|
"module": "NodeNext",
|
||||||
"moduleResolution": "nodenext",
|
"moduleResolution": "NodeNext",
|
||||||
"allowSyntheticDefaultImports": true
|
"esModuleInterop": true,
|
||||||
}
|
"verbatimModuleSyntax": true
|
||||||
|
},
|
||||||
|
"exclude": [
|
||||||
|
"dist_*/**/*.d.ts"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user