Compare commits
68 Commits
Author | SHA1 | Date | |
---|---|---|---|
f535eacd97 | |||
9908897aa2 | |||
29d3cbb0b6 | |||
babc20649a | |||
1188643c4b | |||
6b74301588 | |||
168527573c | |||
3d7bb37849 | |||
12a581ced9 | |||
857e1717a5 | |||
186bfb9d12 | |||
c5bc354f65 | |||
c48bb0428f | |||
46fbb615a0 | |||
3df4e103f9 | |||
addff418c6 | |||
14d653e701 | |||
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 | |||
f4141bf201 | |||
5a46028053 | |||
18d26647e1 | |||
0b5ec86780 | |||
5e15729045 | |||
c98a5f1ac3 | |||
7f02146a0e | |||
5dab8c7351 | |||
505e0e9a30 | |||
9e3510955a | |||
c006d4fbc7 | |||
5e02c44647 | |||
47f7cb18b5 | |||
3faf065c66 | |||
dfffd03790 |
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
|
9
.snyk
9
.snyk
@ -1,9 +0,0 @@
|
||||
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
|
||||
version: v1.13.5
|
||||
# ignores vulnerabilities until expiry date; change duration by modifying expiry date
|
||||
ignore:
|
||||
SNYK-JS-LODASH-450202:
|
||||
- '@pushrocks/smartnetwork > portscanner > async > lodash':
|
||||
reason: None given
|
||||
expires: '2019-09-13T09:39:26.276Z'
|
||||
patch: {}
|
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@ -2,28 +2,10 @@
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"${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"
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
131
changelog.md
Normal file
131
changelog.md
Normal file
@ -0,0 +1,131 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-02-25 - 3.2.2 - fix(SmartPdf)
|
||||
Fix buffer handling for PDF conversion and text extraction
|
||||
|
||||
- Ensure Uint8Array is converted to Node Buffer for PDF conversion.
|
||||
- Correct the PDF page viewport handling by using document dimensions.
|
||||
- Fix extractTextFromPdfBuffer argument type from Uint8Array to Buffer.
|
||||
|
||||
## 2025-02-25 - 3.2.1 - fix(SmartPdf)
|
||||
Fix type for extractTextFromPdfBuffer function
|
||||
|
||||
- Corrected the parameter type from Buffer to Uint8Array for extractTextFromPdfBuffer function.
|
||||
|
||||
## 2025-02-25 - 3.2.0 - feat(smartpdf)
|
||||
Improve dependency versions and optimize PDF to PNG conversion.
|
||||
|
||||
- Update several dependencies to newer versions for better stability and performance.
|
||||
- Refactor tests to enhance readability and add directory creation validations.
|
||||
- Optimize PDF to PNG conversion by switching to a more efficient Puppeteer and PDF.js-based method.
|
||||
- Add checks for presence of required dependencies (GraphicsMagick and Ghostscript).
|
||||
- Fix media emulation issue by properly awaiting the emulateMediaType function.
|
||||
|
||||
## 2024-11-30 - 3.1.8 - fix(core)
|
||||
Fix candidate handling in PDF generation
|
||||
|
||||
- Added error handling for missing PDF candidates in server requests.
|
||||
- Updated devDependencies and dependencies to latest versions for better stability and new features.
|
||||
- Patched header retrieval logic during PDF generation for security check.
|
||||
|
||||
## 2024-09-27 - 3.1.7 - fix(dependencies)
|
||||
Update dependencies to latest versions
|
||||
|
||||
- Updated @git.zone/tsbuild to version ^2.1.84
|
||||
- Updated @git.zone/tsdoc to version ^1.3.12
|
||||
- Updated @git.zone/tsrun to version ^1.2.49
|
||||
- Updated @push.rocks/tapbundle to version ^5.3.0
|
||||
- Updated @types/node to version ^22.7.4
|
||||
- Updated @push.rocks/smartfile to version ^11.0.21
|
||||
- Updated @push.rocks/smartpromise to version ^4.0.4
|
||||
- Updated @tsclass/tsclass to version ^4.1.2
|
||||
- Updated express to version ^4.21.0
|
||||
- Updated pdf2pic to version ^3.1.3
|
||||
|
||||
## 2024-05-29 - 3.1.6 - Core
|
||||
Updated description
|
||||
|
||||
- Minor changes to documentation and internal text.
|
||||
|
||||
## 2024-04-25 to 2024-04-30 - 3.1.0 to 3.1.5 - Core
|
||||
Fix updates in core functionality
|
||||
|
||||
- Fixes and updates in core function in versions 3.1.0 to 3.1.5.
|
||||
|
||||
## 2024-04-25 - 3.0.17 - Feature
|
||||
Now supports PDF to JPG conversion
|
||||
|
||||
- Added support for converting PDF files to JPG format.
|
||||
|
||||
## 2024-03-19 to 2024-04-14 - 3.0.17 - Maintenance
|
||||
Various updates to project configuration files
|
||||
|
||||
- Updated `tsconfig`.
|
||||
- Updated `npmextra.json`.
|
||||
|
||||
## 2023-07-11 to 2024-03-19 - 3.0.15 to 3.0.16 - Organization
|
||||
Switch to new organization scheme and core updates
|
||||
|
||||
- Switched to new organization scheme.
|
||||
- Applied core updates and bug fixes.
|
||||
|
||||
## 2022-11-07 to 2023-07-10 - 3.0.13 to 3.0.14 - Core
|
||||
Fixes and updates to core functionality
|
||||
|
||||
- Various minor bug fixes and updates to core components.
|
||||
|
||||
## 2022-09-13 to 2022-11-07 - 3.0.10 to 3.0.12 - Core
|
||||
Ongoing core updates and maintenance
|
||||
|
||||
- Regular fixes and operational improvements in core functionalities.
|
||||
|
||||
## 2022-06-12 to 2022-09-13 - 3.0.7 to 3.0.9 - Core
|
||||
Continued focus on high-priority bug fixes and core functionalities
|
||||
|
||||
- Regular fixes for critical bugs and enhancements.
|
||||
|
||||
## 2022-03-24 to 2022-06-29 - 3.0.3 to 3.0.6 - Core
|
||||
Further optimization and maintenance releases
|
||||
|
||||
- Further improvements and refinements of issues in core functionalities.
|
||||
|
||||
## 2022-01-05 to 2022-03-25 - 3.0.0 to 3.0.2 - Major Version Release
|
||||
Major release for version 3.0.x, including core fixes
|
||||
|
||||
- Increased version from 2.x to 3.0. New significant changes and fixes.
|
||||
|
||||
## 2022-01-05 to 2022-03-24 - 2.0.13 to 2.0.19 - Core
|
||||
Routine core updates and bug fixes
|
||||
|
||||
- Regular bug fixes in core components.
|
||||
|
||||
## 2019-11-19 to 2022-01-06 - 2.0.0 to 2.0.11 - Core
|
||||
Multiple core updates and a few performance improvements
|
||||
|
||||
- Some performance enhancements and multiple bug fixes.
|
||||
|
||||
## 2019-11-16 to 2019-11-19 - 1.0.27 to 1.0.29 - API
|
||||
Breaking change in API
|
||||
|
||||
- Naming PDF results to better represent their content.
|
||||
|
||||
## 2019-05-29 to 2019-11-15 - 1.0.13 to 1.0.26 - Core
|
||||
Core functional updates and some major restructuring
|
||||
|
||||
- Introduced multiple updates to the core, addressing bugs and improving stability.
|
||||
|
||||
## 2019-04-10 to 2019-05-28 - 1.0.4 to 1.0.12 - Core
|
||||
Fixes and updates in the core
|
||||
|
||||
- Implementation of multiple essential fixes for core components.
|
||||
|
||||
## 2018-10-06 - 1.0.1 to 1.0.3 - Core and Typings
|
||||
Initial implementation and core fixes
|
||||
|
||||
- Initial implementation of the project.
|
||||
- Fixed compilation problems in typings.
|
||||
|
||||
## 2016-01-29 - unknown - Initial
|
||||
Initial commit
|
||||
|
||||
- Initial commit for the project setup.
|
@ -6,12 +6,29 @@
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartpdf",
|
||||
"shortDescription": "Create PDFs fast and smoothly",
|
||||
"npmPackagename": "@pushrocks/smartpdf",
|
||||
"license": "MIT"
|
||||
"description": "A library for creating PDFs dynamically from HTML or websites with additional features like merging PDFs.",
|
||||
"npmPackagename": "@push.rocks/smartpdf",
|
||||
"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"
|
||||
}
|
||||
}
|
26994
package-lock.json
generated
26994
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
66
package.json
66
package.json
@ -1,35 +1,40 @@
|
||||
{
|
||||
"name": "@pushrocks/smartpdf",
|
||||
"version": "2.0.18",
|
||||
"name": "@push.rocks/smartpdf",
|
||||
"version": "3.2.2",
|
||||
"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",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/ --web)",
|
||||
"build": "(tsbuild --web)"
|
||||
"build": "(tsbuild --web --allowimplicitany)",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.28",
|
||||
"@gitzone/tsrun": "^1.2.18",
|
||||
"@gitzone/tstest": "^1.0.60",
|
||||
"@pushrocks/tapbundle": "^3.2.15",
|
||||
"@types/node": "^17.0.8",
|
||||
"tslint": "^6.1.3",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
"@git.zone/tsbuild": "^2.2.1",
|
||||
"@git.zone/tsdoc": "^1.4.3",
|
||||
"@git.zone/tsrun": "^1.3.3",
|
||||
"@git.zone/tstest": "^1.0.96",
|
||||
"@push.rocks/tapbundle": "^5.5.6",
|
||||
"@types/node": "^22.13.5"
|
||||
},
|
||||
"dependencies": {
|
||||
"@pushrocks/smartfile": "^9.0.5",
|
||||
"@pushrocks/smartnetwork": "^2.0.10",
|
||||
"@pushrocks/smartpromise": "^3.1.6",
|
||||
"@pushrocks/smartpuppeteer": "^1.0.36",
|
||||
"@pushrocks/smartunique": "^3.0.3",
|
||||
"@types/express": "^4.17.13",
|
||||
"express": "^4.17.2",
|
||||
"pdf-merger-js": "^3.2.1",
|
||||
"pdf2json": "^2.0.0"
|
||||
"@push.rocks/smartbuffer": "^3.0.4",
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
"@push.rocks/smartfile": "^11.2.0",
|
||||
"@push.rocks/smartnetwork": "^3.0.0",
|
||||
"@push.rocks/smartpath": "^5.0.18",
|
||||
"@push.rocks/smartpromise": "^4.2.3",
|
||||
"@push.rocks/smartpuppeteer": "^2.0.5",
|
||||
"@push.rocks/smartunique": "^3.0.9",
|
||||
"@tsclass/tsclass": "^4.4.0",
|
||||
"@types/express": "^5.0.0",
|
||||
"express": "^4.21.2",
|
||||
"pdf-lib": "^1.17.1",
|
||||
"pdf2json": "3.1.5"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
@ -45,5 +50,24 @@
|
||||
],
|
||||
"browserslist": [
|
||||
"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"
|
||||
],
|
||||
"homepage": "https://code.foss.global/push.rocks/smartpdf",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://code.foss.global/push.rocks/smartpdf.git"
|
||||
}
|
||||
}
|
||||
|
10821
pnpm-lock.yaml
generated
Normal file
10821
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
|
||||
Create PDFs fast and smoothly
|
||||
# @push.rocks/smartpdf
|
||||
Create PDFs on the fly
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartpdf)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartpdf)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartpdf)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartpdf/)
|
||||
## Install
|
||||
To install `@push.rocks/smartpdf`, use the following command with npm:
|
||||
|
||||
## Status for master
|
||||
```bash
|
||||
npm install @push.rocks/smartpdf --save
|
||||
```
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
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)
|
||||
Or with yarn:
|
||||
|
||||
```bash
|
||||
yarn add @push.rocks/smartpdf
|
||||
```
|
||||
|
||||
## 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)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
#### A4 PDF from a Website
|
||||
|
||||
[](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.
|
||||
|
99
test/test.ts
99
test/test.ts
@ -1,58 +1,85 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import * as smartpdf from '../ts/index';
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import * as smartpdf from '../ts/index.js';
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
|
||||
let testSmartPdf: smartpdf.SmartPdf;
|
||||
|
||||
tap.test('should create a valid instance of smartpdf', async () => {
|
||||
/**
|
||||
* Ensures that a directory exists.
|
||||
* @param dirPath - The directory path to ensure.
|
||||
*/
|
||||
function ensureDir(dirPath: string): void {
|
||||
if (!fs.existsSync(dirPath)) {
|
||||
fs.mkdirSync(dirPath, { recursive: true });
|
||||
}
|
||||
}
|
||||
|
||||
tap.test('should create a valid instance of SmartPdf', async () => {
|
||||
testSmartPdf = new smartpdf.SmartPdf();
|
||||
expect(testSmartPdf).to.be.instanceof(smartpdf.SmartPdf);
|
||||
expect(testSmartPdf).toBeInstanceOf(smartpdf.SmartPdf);
|
||||
});
|
||||
|
||||
tap.test('should start the instance', async () => {
|
||||
tap.test('should start the SmartPdf instance', async () => {
|
||||
await testSmartPdf.start();
|
||||
});
|
||||
|
||||
tap.test('should create a pdf from html string', async () => {
|
||||
await testSmartPdf.getA4PdfResultForHtmlString('hi');
|
||||
tap.test('should create PDFs from HTML string', async () => {
|
||||
const pdf1 = await testSmartPdf.getA4PdfResultForHtmlString('hi');
|
||||
const pdf2 = await testSmartPdf.getA4PdfResultForHtmlString('hello');
|
||||
expect(pdf1.buffer).toBeInstanceOf(Buffer);
|
||||
expect(pdf2.buffer).toBeInstanceOf(Buffer);
|
||||
});
|
||||
|
||||
tap.test('should create a pdf from html string', async () => {
|
||||
await testSmartPdf.getA4PdfResultForHtmlString('hi');
|
||||
tap.test('should create PDFs from websites', async () => {
|
||||
const pdfA4 = await testSmartPdf.getPdfResultForWebsite('https://www.wikipedia.org');
|
||||
const pdfSingle = await testSmartPdf.getFullWebsiteAsSinglePdf('https://www.wikipedia.org');
|
||||
expect(pdfA4.buffer).toBeInstanceOf(Buffer);
|
||||
expect(pdfSingle.buffer).toBeInstanceOf(Buffer);
|
||||
});
|
||||
|
||||
tap.test('should create a pdf from website as A4', async () => {
|
||||
await testSmartPdf.getPdfResultForWebsite('https://www.wikipedia.org');
|
||||
});
|
||||
|
||||
tap.test('should create a pdf from website as single page PDF', async () => {
|
||||
await testSmartPdf.getFullWebsiteAsSinglePdf('https://www.wikipedia.org');
|
||||
});
|
||||
|
||||
tap.test('should create a valid PDFResult', async () => {
|
||||
const writePDfToDisk = async (urlArg: string, fileName: string) => {
|
||||
tap.test('should create valid PDF results and write them to disk', async () => {
|
||||
const writePdfToDisk = async (urlArg: string, fileName: string) => {
|
||||
const pdfResult = await testSmartPdf.getFullWebsiteAsSinglePdf(urlArg);
|
||||
expect(pdfResult.buffer).to.be.instanceOf(Buffer);
|
||||
const fs = await import('fs');
|
||||
|
||||
if (!fs.existsSync('.nogit/')) {
|
||||
fs.mkdirSync('.nogit/');
|
||||
}
|
||||
fs.writeFileSync(`.nogit/${fileName}`, pdfResult.buffer);
|
||||
expect(pdfResult.buffer).toBeInstanceOf(Buffer);
|
||||
ensureDir('.nogit');
|
||||
fs.writeFileSync(path.join('.nogit', fileName), pdfResult.buffer as Buffer);
|
||||
};
|
||||
await writePDfToDisk('https://maintainedby.lossless.com/', '1.pdf')
|
||||
await writePDfToDisk('https://rendertron.lossless.one/render/https://lossless.com', '2.pdf')
|
||||
await writePdfToDisk('https://lossless.com/', '1.pdf');
|
||||
await writePdfToDisk('https://layer.io', '2.pdf');
|
||||
});
|
||||
|
||||
tap.test('should combine pdfs', async () => {
|
||||
const fs = await import('fs');
|
||||
const buffer1 = fs.readFileSync('.nogit/1.pdf');
|
||||
const buffer2 = fs.readFileSync('.nogit/2.pdf');
|
||||
fs.writeFileSync(`.nogit/combined.pdf`, await testSmartPdf.mergePdfBuffers([buffer1, buffer2]));
|
||||
tap.test('should merge PDFs into a combined PDF', async () => {
|
||||
const pdf1 = await testSmartPdf.readFileToPdfObject('.nogit/1.pdf');
|
||||
const pdf2 = await testSmartPdf.readFileToPdfObject('.nogit/2.pdf');
|
||||
const mergedBuffer = await testSmartPdf.mergePdfs([pdf1.buffer, pdf2.buffer]);
|
||||
ensureDir('.nogit');
|
||||
fs.writeFileSync(path.join('.nogit', 'combined.pdf'), mergedBuffer);
|
||||
});
|
||||
|
||||
})
|
||||
tap.test('should create PNG images from combined PDF using Puppeteer conversion', async () => {
|
||||
const pdfObject = await testSmartPdf.readFileToPdfObject('.nogit/combined.pdf');
|
||||
const images = await testSmartPdf.convertPDFToPngBytes(pdfObject.buffer);
|
||||
expect(images.length).toBeGreaterThan(0);
|
||||
console.log('Puppeteer-based conversion image sizes:', images.map(img => img.length));
|
||||
});
|
||||
|
||||
tap.test('should be able to close properly', async () => {
|
||||
tap.test('should store PNG results from both conversion functions in .nogit/testresults', async () => {
|
||||
const testResultsDir = path.join('.nogit', 'testresults');
|
||||
ensureDir(testResultsDir);
|
||||
|
||||
const pdfObject = await testSmartPdf.readFileToPdfObject('.nogit/combined.pdf');
|
||||
|
||||
// Convert using Puppeteer-based function and store images
|
||||
const imagesPuppeteer = await testSmartPdf.convertPDFToPngBytes(pdfObject.buffer);
|
||||
imagesPuppeteer.forEach((img, index) => {
|
||||
const filePath = path.join(testResultsDir, `puppeteer_method_page_${index + 1}.png`);
|
||||
fs.writeFileSync(filePath, Buffer.from(img));
|
||||
});
|
||||
});
|
||||
|
||||
tap.test('should close the SmartPdf instance properly', async () => {
|
||||
await testSmartPdf.stop();
|
||||
});
|
||||
|
||||
tap.start();
|
||||
tap.start();
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartpdf',
|
||||
version: '3.2.2',
|
||||
description: 'A library for creating PDFs dynamically from HTML or websites with additional features like merging PDFs.'
|
||||
}
|
@ -6,4 +6,10 @@ declare global {
|
||||
}
|
||||
|
||||
// normal
|
||||
export * from './smartpdf.classes.smartpdf';
|
||||
export * from './smartpdf.classes.smartpdf.js';
|
||||
|
||||
// additional types
|
||||
import type * as tsclassTypes from '@tsclass/tsclass';
|
||||
type IPdf = tsclassTypes.business.IPdf;
|
||||
|
||||
export type { IPdf };
|
||||
|
@ -1 +0,0 @@
|
||||
export * from './interface.pdfresult';
|
@ -1,8 +0,0 @@
|
||||
export interface IPdfResult {
|
||||
name: string;
|
||||
id: string;
|
||||
metadata: {
|
||||
textExtraction: string;
|
||||
};
|
||||
buffer: Buffer;
|
||||
}
|
@ -1,4 +1,8 @@
|
||||
import * as plugins from './smartpdf.plugins';
|
||||
/*
|
||||
* pdf candidate is a construct used internally for mapping html
|
||||
* to pdf buffers delivered by puppeteer
|
||||
*/
|
||||
import * as plugins from './smartpdf.plugins.js';
|
||||
|
||||
export class PdfCandidate {
|
||||
public htmlString: string;
|
||||
|
@ -1,13 +1,20 @@
|
||||
import * as plugins from './smartpdf.plugins';
|
||||
import * as paths from './smartpdf.paths';
|
||||
import * as plugins from './smartpdf.plugins.js';
|
||||
import * as paths from './smartpdf.paths.js';
|
||||
import { Server } from 'http';
|
||||
import { PdfCandidate } from './smartpdf.classes.pdfcandidate';
|
||||
import { PdfCandidate } from './smartpdf.classes.pdfcandidate.js';
|
||||
import { type IPdf } from '@tsclass/tsclass/dist_ts/business/pdf.js';
|
||||
import { execFile } from 'child_process';
|
||||
|
||||
declare const document: any;
|
||||
|
||||
import * as interfaces from './interfaces';
|
||||
|
||||
export class SmartPdf {
|
||||
// STATIC
|
||||
public static async create() {
|
||||
const smartpdfInstance = new SmartPdf();
|
||||
return smartpdfInstance;
|
||||
}
|
||||
|
||||
// INSTANCE
|
||||
htmlServerInstance: Server;
|
||||
serverPort: number;
|
||||
headlessBrowser: plugins.smartpuppeteer.puppeteer.Browser;
|
||||
@ -20,6 +27,7 @@ export class SmartPdf {
|
||||
}
|
||||
|
||||
async start(headlessBrowserArg?: plugins.smartpuppeteer.puppeteer.Browser) {
|
||||
const done = plugins.smartpromise.defer();
|
||||
// lets set the external browser in case one is provided
|
||||
this.headlessBrowser = headlessBrowserArg;
|
||||
// setup puppeteer
|
||||
@ -27,15 +35,20 @@ export class SmartPdf {
|
||||
this.externalBrowserBool = true;
|
||||
} else {
|
||||
this.headlessBrowser = await plugins.smartpuppeteer.getEnvAwareBrowserInstance({
|
||||
forceNoSandbox: true,
|
||||
forceNoSandbox: false,
|
||||
});
|
||||
}
|
||||
|
||||
// setup server
|
||||
const app = plugins.express();
|
||||
app.get('/:pdfId', (req, res) => {
|
||||
res.setHeader('PDF-ID', this._candidates[req.params.pdfId].pdfId);
|
||||
res.send(this._candidates[req.params.pdfId].htmlString);
|
||||
const wantedCandidate = this._candidates[req.params.pdfId];
|
||||
if (!wantedCandidate) {
|
||||
console.log(`${req.url} not attached to a candidate`);
|
||||
return;
|
||||
}
|
||||
res.setHeader('pdf-id', wantedCandidate.pdfId);
|
||||
res.send(wantedCandidate.htmlString);
|
||||
});
|
||||
this.htmlServerInstance = plugins.http.createServer(app);
|
||||
const smartnetworkInstance = new plugins.smartnetwork.SmartNetwork();
|
||||
@ -43,7 +56,9 @@ export class SmartPdf {
|
||||
this.htmlServerInstance.listen(3210, 'localhost');
|
||||
this.htmlServerInstance.on('listening', () => {
|
||||
this._readyDeferred.resolve();
|
||||
done.resolve();
|
||||
});
|
||||
await done.promise;
|
||||
}
|
||||
|
||||
// stop
|
||||
@ -61,9 +76,9 @@ export class SmartPdf {
|
||||
}
|
||||
|
||||
/**
|
||||
* returns a pdf for a given html string;
|
||||
* Returns a PDF for a given HTML string.
|
||||
*/
|
||||
async getA4PdfResultForHtmlString(htmlStringArg: string): Promise<interfaces.IPdfResult> {
|
||||
async getA4PdfResultForHtmlString(htmlStringArg: string): Promise<plugins.tsclass.business.IPdf> {
|
||||
await this._readyDeferred.promise;
|
||||
const pdfCandidate = new PdfCandidate(htmlStringArg);
|
||||
this._candidates[pdfCandidate.pdfId] = pdfCandidate;
|
||||
@ -89,6 +104,8 @@ export class SmartPdf {
|
||||
printBackground: true,
|
||||
displayHeaderFooter: false,
|
||||
});
|
||||
// Convert Uint8Array to Node Buffer
|
||||
const nodePdfBuffer = Buffer.from(pdfBuffer);
|
||||
await page.close();
|
||||
delete this._candidates[pdfCandidate.pdfId];
|
||||
pdfCandidate.doneDeferred.resolve();
|
||||
@ -97,13 +114,13 @@ export class SmartPdf {
|
||||
id: pdfCandidate.pdfId,
|
||||
name: `${pdfCandidate.pdfId}.js`,
|
||||
metadata: {
|
||||
textExtraction: await this.extractTextFromPdfBuffer(pdfBuffer),
|
||||
textExtraction: await this.extractTextFromPdfBuffer(nodePdfBuffer),
|
||||
},
|
||||
buffer: pdfBuffer,
|
||||
buffer: nodePdfBuffer,
|
||||
};
|
||||
}
|
||||
|
||||
async getPdfResultForWebsite(websiteUrl: string): Promise<interfaces.IPdfResult> {
|
||||
async getPdfResultForWebsite(websiteUrl: string): Promise<plugins.tsclass.business.IPdf> {
|
||||
const page = await this.headlessBrowser.newPage();
|
||||
await page.setViewport({
|
||||
width: 1980,
|
||||
@ -124,32 +141,42 @@ export class SmartPdf {
|
||||
printBackground: true,
|
||||
displayHeaderFooter: false,
|
||||
});
|
||||
// Convert Uint8Array to Node Buffer
|
||||
const nodePdfBuffer = Buffer.from(pdfBuffer);
|
||||
await page.close();
|
||||
return {
|
||||
id: pdfId,
|
||||
name: `${pdfId}.js`,
|
||||
metadata: {
|
||||
textExtraction: await this.extractTextFromPdfBuffer(pdfBuffer),
|
||||
textExtraction: await this.extractTextFromPdfBuffer(nodePdfBuffer),
|
||||
},
|
||||
buffer: pdfBuffer,
|
||||
buffer: nodePdfBuffer,
|
||||
};
|
||||
}
|
||||
|
||||
async getFullWebsiteAsSinglePdf(websiteUrl: string): Promise<interfaces.IPdfResult> {
|
||||
async getFullWebsiteAsSinglePdf(websiteUrl: string): Promise<plugins.tsclass.business.IPdf> {
|
||||
const page = await this.headlessBrowser.newPage();
|
||||
await page.setViewport({
|
||||
width: 1920,
|
||||
height: 1200,
|
||||
});
|
||||
page.emulateMediaType('screen');
|
||||
await page.emulateMediaType('screen');
|
||||
const response = await page.goto(websiteUrl, { waitUntil: 'networkidle2' });
|
||||
const pdfId = plugins.smartunique.shortId();
|
||||
// Use both document.body and document.documentElement to ensure we have a valid height and width.
|
||||
const { documentHeight, documentWidth } = await page.evaluate(() => {
|
||||
return {
|
||||
documentHeight: document.body.scrollHeight,
|
||||
documentWidth: document.body.clientWidth,
|
||||
documentHeight: Math.max(
|
||||
document.body.scrollHeight,
|
||||
document.documentElement.scrollHeight
|
||||
) || 1200,
|
||||
documentWidth: Math.max(
|
||||
document.body.clientWidth,
|
||||
document.documentElement.clientWidth
|
||||
) || 1920,
|
||||
};
|
||||
});
|
||||
// Update viewport height to the full document height.
|
||||
await page.setViewport({
|
||||
width: 1920,
|
||||
height: documentHeight,
|
||||
@ -160,43 +187,166 @@ export class SmartPdf {
|
||||
printBackground: true,
|
||||
displayHeaderFooter: false,
|
||||
scale: 1,
|
||||
pageRanges: '1'
|
||||
pageRanges: '1',
|
||||
});
|
||||
// Convert Uint8Array to Node Buffer
|
||||
const nodePdfBuffer = Buffer.from(pdfBuffer);
|
||||
await page.close();
|
||||
return {
|
||||
id: pdfId,
|
||||
name: `${pdfId}.js`,
|
||||
metadata: {
|
||||
textExtraction: await this.extractTextFromPdfBuffer(pdfBuffer),
|
||||
textExtraction: await this.extractTextFromPdfBuffer(nodePdfBuffer),
|
||||
},
|
||||
buffer: pdfBuffer,
|
||||
buffer: nodePdfBuffer,
|
||||
};
|
||||
}
|
||||
|
||||
public async mergePdfBuffers(pdfBuffers: Buffer[]): Promise<Buffer> {
|
||||
const merger = new plugins.pdfMerger();
|
||||
for (const buffer of pdfBuffers) {
|
||||
merger.add(buffer);
|
||||
public async mergePdfs(inputPdfBuffers: Uint8Array[]): Promise<Uint8Array> {
|
||||
const mergedPdf = await plugins.pdfLib.PDFDocument.create();
|
||||
for (const pdfBytes of inputPdfBuffers) {
|
||||
const pdfDoc = await plugins.pdfLib.PDFDocument.load(pdfBytes);
|
||||
const pages = await mergedPdf.copyPages(pdfDoc, pdfDoc.getPageIndices());
|
||||
pages.forEach((page) => mergedPdf.addPage(page));
|
||||
}
|
||||
return merger.saveAsBuffer();
|
||||
|
||||
const mergedPdfBytes = await mergedPdf.save();
|
||||
return mergedPdfBytes;
|
||||
}
|
||||
|
||||
public async readFileToPdfObject(pathArg: string): Promise<plugins.tsclass.business.IPdf> {
|
||||
const absolutePath = plugins.smartpath.transform.makeAbsolute(pathArg);
|
||||
const parsedPath = plugins.path.parse(absolutePath);
|
||||
const buffer = await plugins.smartfile.fs.toBuffer(absolutePath);
|
||||
return {
|
||||
name: parsedPath.base,
|
||||
buffer,
|
||||
id: null,
|
||||
metadata: null,
|
||||
};
|
||||
}
|
||||
|
||||
public async extractTextFromPdfBuffer(pdfBufferArg: Buffer): Promise<string> {
|
||||
const deferred = plugins.smartpromise.defer<string>();
|
||||
const pdfParser: any = new plugins.pdf2json();
|
||||
pdfParser.on('pdfParser_dataReady', (pdfData: any) => {
|
||||
let finalText = ''
|
||||
let finalText = '';
|
||||
for (const page of pdfData.Pages) {
|
||||
for(const text of page.Texts) {
|
||||
for (const text of page.Texts) {
|
||||
for (const letter of text.R) {
|
||||
finalText = finalText + letter.T;
|
||||
}
|
||||
|
||||
};
|
||||
}
|
||||
}
|
||||
deferred.resolve(finalText);
|
||||
});
|
||||
pdfParser.parseBuffer(pdfBufferArg);
|
||||
return deferred.promise;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks for the presence of required dependencies: GraphicsMagick and Ghostscript.
|
||||
*/
|
||||
private async checkDependencies(): Promise<void> {
|
||||
await Promise.all([
|
||||
this.checkCommandExists('gm', ['version']),
|
||||
this.checkCommandExists('gs', ['--version']),
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a given command exists by trying to execute it.
|
||||
*/
|
||||
private checkCommandExists(command: string, args: string[]): Promise<void> {
|
||||
return new Promise((resolve, reject) => {
|
||||
execFile(command, args, (error, stdout, stderr) => {
|
||||
if (error) {
|
||||
reject(new Error(`Dependency check failed: ${command} is not installed or not in the PATH. ${error.message}`));
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a PDF to PNG bytes for each page using Puppeteer and PDF.js.
|
||||
* This method creates a temporary HTML page that loads PDF.js from a CDN,
|
||||
* renders each PDF page to a canvas, and then screenshots each canvas element.
|
||||
*/
|
||||
public async convertPDFToPngBytes(
|
||||
pdfBytes: Uint8Array,
|
||||
options: { width?: number; height?: number; quality?: number } = {}
|
||||
): Promise<Uint8Array[]> {
|
||||
// Note: options.width, options.height, and options.quality are not applied here,
|
||||
// as the rendered canvas size is determined by the PDF page dimensions.
|
||||
|
||||
// Create a new page using the headless browser.
|
||||
const page = await this.headlessBrowser.newPage();
|
||||
|
||||
// Prepare PDF data as a base64 string.
|
||||
const base64Pdf: string = Buffer.from(pdfBytes).toString('base64');
|
||||
|
||||
// HTML template that loads PDF.js and renders the PDF.
|
||||
const htmlTemplate: string = `
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>PDF to PNG Converter</title>
|
||||
<style>
|
||||
body { margin: 0; }
|
||||
canvas { display: block; margin: 10px auto; }
|
||||
</style>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/pdf.js/2.16.105/pdf.min.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<script>
|
||||
(async function() {
|
||||
pdfjsLib.GlobalWorkerOptions.workerSrc = 'https://cdnjs.cloudflare.com/ajax/libs/pdf.js/2.16.105/pdf.worker.min.js';
|
||||
const pdfData = "__PDF_DATA__";
|
||||
const raw = atob(pdfData);
|
||||
const pdfArray = new Uint8Array([...raw].map(c => c.charCodeAt(0)));
|
||||
const loadingTask = pdfjsLib.getDocument({data: pdfArray});
|
||||
const pdf = await loadingTask.promise;
|
||||
const numPages = pdf.numPages;
|
||||
for (let pageNum = 1; pageNum <= numPages; pageNum++) {
|
||||
const page = await pdf.getPage(pageNum);
|
||||
const viewport = page.getViewport({ scale: 1.0 });
|
||||
const canvas = document.createElement('canvas');
|
||||
const context = canvas.getContext('2d');
|
||||
canvas.width = viewport.width;
|
||||
canvas.height = viewport.height;
|
||||
await page.render({ canvasContext: context, viewport: viewport }).promise;
|
||||
document.body.appendChild(canvas);
|
||||
}
|
||||
window.renderComplete = true;
|
||||
})();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
`;
|
||||
|
||||
// Replace the placeholder with the actual base64 PDF data.
|
||||
const htmlContent: string = htmlTemplate.replace("__PDF_DATA__", base64Pdf);
|
||||
|
||||
// Set the page content.
|
||||
await page.setContent(htmlContent, { waitUntil: 'networkidle0' });
|
||||
|
||||
// Wait until the PDF.js rendering is complete.
|
||||
await page.waitForFunction(() => (window as any).renderComplete === true, { timeout: 30000 });
|
||||
|
||||
// Query all canvas elements (each representing a rendered PDF page).
|
||||
const canvasElements = await page.$$('canvas');
|
||||
const pngBuffers: Uint8Array[] = [];
|
||||
|
||||
for (const canvasElement of canvasElements) {
|
||||
// Screenshot the canvas element. The screenshot will be a PNG buffer.
|
||||
const screenshotBuffer = (await canvasElement.screenshot({ encoding: 'binary' })) as Buffer;
|
||||
pngBuffers.push(new Uint8Array(screenshotBuffer));
|
||||
}
|
||||
|
||||
await page.close();
|
||||
return pngBuffers;
|
||||
}
|
||||
}
|
@ -1,3 +1,6 @@
|
||||
import * as plugins from './smartpdf.plugins';
|
||||
import * as plugins from './smartpdf.plugins.js';
|
||||
|
||||
export const packageDir = plugins.path.join(__dirname, '../');
|
||||
export const packageDir = plugins.path.join(
|
||||
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
|
||||
'../'
|
||||
);
|
||||
|
@ -5,18 +5,34 @@ import * as path from 'path';
|
||||
export { http, path };
|
||||
|
||||
// @pushrocks
|
||||
import * as smartfile from '@pushrocks/smartfile';
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as smartpuppeteer from '@pushrocks/smartpuppeteer';
|
||||
import * as smartnetwork from '@pushrocks/smartnetwork';
|
||||
import * as smartunique from '@pushrocks/smartunique';
|
||||
import * as smartbuffer from '@push.rocks/smartbuffer';
|
||||
import * as smartfile from '@push.rocks/smartfile';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
import * as smartpath from '@push.rocks/smartpath';
|
||||
import * as smartpuppeteer from '@push.rocks/smartpuppeteer';
|
||||
import * as smartnetwork from '@push.rocks/smartnetwork';
|
||||
import * as smartunique from '@push.rocks/smartunique';
|
||||
|
||||
export { smartfile, smartpromise, smartpuppeteer, smartunique, smartnetwork };
|
||||
export {
|
||||
smartbuffer,
|
||||
smartfile,
|
||||
smartdelay,
|
||||
smartpromise,
|
||||
smartpath,
|
||||
smartpuppeteer,
|
||||
smartunique,
|
||||
smartnetwork,
|
||||
};
|
||||
|
||||
// tsclass scope
|
||||
import * as tsclass from '@tsclass/tsclass';
|
||||
|
||||
export { tsclass };
|
||||
|
||||
// thirdparty
|
||||
import pdfMerger from 'pdf-merger-js';
|
||||
// @ts-ignore
|
||||
import pdf2json from 'pdf2json';
|
||||
import express from 'express';
|
||||
import pdf2json from 'pdf2json';
|
||||
import pdfLib from 'pdf-lib';
|
||||
|
||||
export { pdfMerger, pdf2json, express };
|
||||
export { express, pdf2json, pdfLib, };
|
||||
|
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@ -0,0 +1,14 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
17
tslint.json
17
tslint.json
@ -1,17 +0,0 @@
|
||||
{
|
||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||
"rules": {
|
||||
"semicolon": [true, "always"],
|
||||
"no-console": false,
|
||||
"ordered-imports": false,
|
||||
"object-literal-sort-keys": false,
|
||||
"member-ordering": {
|
||||
"options":{
|
||||
"order": [
|
||||
"static-method"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"defaultSeverity": "warning"
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user