Compare commits
39 Commits
Author | SHA1 | Date | |
---|---|---|---|
b8387458db | |||
04aed2556b | |||
4cde3a7fe0 | |||
466d6d47ba | |||
fa99b7f068 | |||
3e865b6c92 | |||
94dd576d3b | |||
9c19b4a3e4 | |||
1155656c2b | |||
5cf23c1134 | |||
67e9fdd10a | |||
b0e388c50d | |||
f37c9d8375 | |||
18c8ef9606 | |||
6766a3d0dc | |||
d16f447048 | |||
37c752c2ae | |||
b088d26e6f | |||
425f11a334 | |||
5ddbea1a5a | |||
42c5121784 | |||
d960d85539 | |||
ca60217a18 | |||
16f2829785 | |||
0381022b68 | |||
aae8ec0ee1 | |||
ec4768e1cc | |||
3308895b3b | |||
37e47fc33f | |||
b4a3a36b07 | |||
baf26dc492 | |||
30e4b4665c | |||
74a0a27fc1 | |||
59eed53644 | |||
473aaa004a | |||
ecfd4115a1 | |||
0fbbfaac7c | |||
86d2fc2c5b | |||
f97866fe82 |
3
.gitignore
vendored
3
.gitignore
vendored
@ -19,5 +19,4 @@ dist_web/
|
||||
dist_serve/
|
||||
dist_ts_web/
|
||||
|
||||
# custom
|
||||
assets/pdfdir
|
||||
# custom
|
109
.gitlab-ci.yml
109
.gitlab-ci.yml
@ -1,16 +1,16 @@
|
||||
# gitzone standard
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
# gitzone ci_default
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
|
||||
cache:
|
||||
paths:
|
||||
- .npmci_cache/
|
||||
key: "$CI_BUILD_STAGE"
|
||||
- .npmci_cache/
|
||||
key: '$CI_BUILD_STAGE'
|
||||
|
||||
stages:
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- metadata
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- metadata
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
@ -18,102 +18,103 @@ stages:
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
- npmci git mirror
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
snyk:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install -g snyk
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command npm ci --ignore-scripts
|
||||
- npmci command snyk test
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
# ====================
|
||||
|
||||
testLTS:
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install lts
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
testSTABLE:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# metadata stage
|
||||
# ====================
|
||||
codequality:
|
||||
stage: metadata
|
||||
image: docker:stable
|
||||
allow_failure: true
|
||||
services:
|
||||
- docker:stable-dind
|
||||
script:
|
||||
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
|
||||
- docker run
|
||||
--env SOURCE_CODE="$PWD"
|
||||
--volume "$PWD":/code
|
||||
--volume /var/run/docker.sock:/var/run/docker.sock
|
||||
"registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
|
||||
artifacts:
|
||||
paths: [codeclimate.json]
|
||||
- npmci command npm install -g tslint typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||
tags:
|
||||
- docker
|
||||
- priv
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
trigger:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
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:
|
||||
@ -121,5 +122,5 @@ pages:
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
- public
|
||||
allow_failure: true
|
||||
|
9
.snyk
Normal file
9
.snyk
Normal file
@ -0,0 +1,9 @@
|
||||
# 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: {}
|
@ -5,7 +5,7 @@
|
||||
},
|
||||
"gitzone": {
|
||||
"module": {
|
||||
"githost": "gitlab.om",
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"gitrepo": "smartpdf",
|
||||
"shortDescription": "Create PDFs fast and smoothly",
|
||||
|
10637
package-lock.json
generated
10637
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
40
package.json
40
package.json
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@pushrocks/smartpdf",
|
||||
"version": "1.0.13",
|
||||
"version": "2.0.3",
|
||||
"private": false,
|
||||
"description": "create pdfs on the fly",
|
||||
"main": "dist/index.js",
|
||||
@ -13,28 +13,30 @@
|
||||
"build": "(tsbuild)"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.11",
|
||||
"@gitzone/tsrun": "^1.2.6",
|
||||
"@gitzone/tstest": "^1.0.24",
|
||||
"@pushrocks/tapbundle": "^3.0.9",
|
||||
"@types/node": "^12.0.3"
|
||||
"@gitzone/tsbuild": "^2.1.25",
|
||||
"@gitzone/tsrun": "^1.2.12",
|
||||
"@gitzone/tstest": "^1.0.52",
|
||||
"@pushrocks/tapbundle": "^3.2.14",
|
||||
"@types/node": "^14.14.31",
|
||||
"tslint": "^6.1.3",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@pushrocks/smartfile": "^7.0.2",
|
||||
"@pushrocks/smartnetwork": "^1.1.6",
|
||||
"@pushrocks/smartpromise": "^3.0.2",
|
||||
"@pushrocks/smartunique": "^3.0.1",
|
||||
"@types/express": "^4.16.1",
|
||||
"@types/puppeteer": "^1.12.4",
|
||||
"express": "^4.17.1",
|
||||
"puppeteer": "^1.17.0"
|
||||
"@pushrocks/smartfile": "^8.0.8",
|
||||
"@pushrocks/smartnetwork": "^1.1.22",
|
||||
"@pushrocks/smartpromise": "^3.1.3",
|
||||
"@pushrocks/smartpuppeteer": "^1.0.21",
|
||||
"@pushrocks/smartunique": "^3.0.3",
|
||||
"@types/express": "^4.17.11",
|
||||
"express": "^4.17.1"
|
||||
},
|
||||
"files": [
|
||||
"ts/*",
|
||||
"ts_web/*",
|
||||
"dist/*",
|
||||
"dist_web/*",
|
||||
"assets/*",
|
||||
"ts/**/*",
|
||||
"ts_web/**/*",
|
||||
"dist/**/*",
|
||||
"dist_web/**/*",
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
|
15
readme.md
15
readme.md
@ -3,13 +3,13 @@ Create PDFs fast and smoothly
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartpdf)
|
||||
* [gitlab.com (source)](https://gitlab.om/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/)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.om/pushrocks/smartpdf/commits/master)
|
||||
[](https://gitlab.om/pushrocks/smartpdf/commits/master)
|
||||
[](https://gitlab.com/pushrocks/smartpdf/commits/master)
|
||||
[](https://gitlab.com/pushrocks/smartpdf/commits/master)
|
||||
[](https://www.npmjs.com/package/@pushrocks/smartpdf)
|
||||
[](https://snyk.io/test/npm/@pushrocks/smartpdf)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
@ -18,9 +18,14 @@ Create PDFs fast and smoothly
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
## Contribution
|
||||
|
||||
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). :)
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
[](https://maintainedby.lossless.com)
|
||||
|
16
test/test.ts
16
test/test.ts
@ -13,20 +13,28 @@ tap.test('should start the instance', async () => {
|
||||
});
|
||||
|
||||
tap.test('should create a pdf from html string', async () => {
|
||||
await testSmartPdf.getPdfForHtmlString('hi');
|
||||
await testSmartPdf.getPdfResultForHtmlString('hi');
|
||||
});
|
||||
|
||||
tap.test('should create a pdf from website as A4', async () => {
|
||||
await testSmartPdf.getPdfForWebsite('https://maintainedby.lossless.com');
|
||||
await testSmartPdf.getPdfResultForWebsite('https://www.wikipedia.org');
|
||||
});
|
||||
|
||||
tap.test('should create a pdf from website as single page PDF', async () => {
|
||||
await testSmartPdf.getFullWebsiteAsSinglePdf('https://maintainedby.lossless.com');
|
||||
await testSmartPdf.getFullWebsiteAsSinglePdf('https://www.wikipedia.org');
|
||||
});
|
||||
|
||||
tap.test('should create a valid PDFResult', async () => {
|
||||
const pdfResult = await testSmartPdf.getFullWebsiteAsSinglePdf('https://maintainedby.lossless.com');
|
||||
const pdfResult = await testSmartPdf.getFullWebsiteAsSinglePdf(
|
||||
'https://maintainedby.lossless.com'
|
||||
);
|
||||
expect(pdfResult.buffer).to.be.instanceOf(Buffer);
|
||||
const fs = await import('fs');
|
||||
|
||||
if (!fs.existsSync('.nogit/')) {
|
||||
fs.mkdirSync('.nogit/');
|
||||
}
|
||||
fs.writeFileSync('.nogit/sample.pdf', pdfResult.buffer);
|
||||
});
|
||||
|
||||
tap.test('should be able to close properly', async () => {
|
||||
|
@ -1 +1 @@
|
||||
export * from './interface.pdfresult';
|
||||
export * from './interface.pdfresult';
|
||||
|
@ -1,5 +1,5 @@
|
||||
export interface IPdfResult {
|
||||
name: string,
|
||||
id: string,
|
||||
name: string;
|
||||
id: string;
|
||||
buffer: Buffer;
|
||||
}
|
||||
|
@ -5,27 +5,30 @@ import { PdfCandidate } from './smartpdf.classes.pdfcandidate';
|
||||
|
||||
declare const document;
|
||||
|
||||
import { IPdfResult } from './interfaces';
|
||||
import * as interfaces from './interfaces';
|
||||
|
||||
export class SmartPdf {
|
||||
htmlServerInstance: Server;
|
||||
serverPort: number;
|
||||
headlessBrowser: plugins.puppeteer.Browser;
|
||||
externalBrowser: boolean = false;
|
||||
headlessBrowser: plugins.smartpuppeteer.puppeteer.Browser;
|
||||
externalBrowserBool: boolean = false;
|
||||
private _readyDeferred: plugins.smartpromise.Deferred<void>;
|
||||
private _candidates: { [key: string]: PdfCandidate } = {};
|
||||
|
||||
constructor(headlessBrowserArg?) {
|
||||
this.headlessBrowser = headlessBrowserArg
|
||||
constructor() {
|
||||
this._readyDeferred = new plugins.smartpromise.Deferred();
|
||||
}
|
||||
|
||||
async start() {
|
||||
async start(headlessBrowserArg?) {
|
||||
// lets set the external browser in case one is provided
|
||||
this.headlessBrowser = headlessBrowserArg;
|
||||
// setup puppeteer
|
||||
if (!this.headlessBrowser) {
|
||||
this.headlessBrowser = await plugins.puppeteer.launch();
|
||||
if (this.headlessBrowser) {
|
||||
this.externalBrowserBool = true;
|
||||
} else {
|
||||
this.externalBrowser = true;
|
||||
this.headlessBrowser = await plugins.smartpuppeteer.getEnvAwareBrowserInstance({
|
||||
forceNoSandbox: true
|
||||
});
|
||||
}
|
||||
|
||||
// setup server
|
||||
@ -43,13 +46,14 @@ export class SmartPdf {
|
||||
});
|
||||
}
|
||||
|
||||
// stop
|
||||
async stop() {
|
||||
const done = plugins.smartpromise.defer<void>();
|
||||
this.htmlServerInstance.close(() => {
|
||||
done.resolve();
|
||||
});
|
||||
|
||||
if (!this.externalBrowser) {
|
||||
|
||||
if (!this.externalBrowserBool) {
|
||||
await this.headlessBrowser.close();
|
||||
}
|
||||
|
||||
@ -59,7 +63,7 @@ export class SmartPdf {
|
||||
/**
|
||||
* returns a pdf for a given html string;
|
||||
*/
|
||||
async getPdfForHtmlString(htmlStringArg: string): Promise<IPdfResult> {
|
||||
async getPdfResultForHtmlString(htmlStringArg: string): Promise<interfaces.IPdfResult> {
|
||||
await this._readyDeferred.promise;
|
||||
const pdfCandidate = new PdfCandidate(htmlStringArg);
|
||||
this._candidates[pdfCandidate.pdfId] = pdfCandidate;
|
||||
@ -76,7 +80,10 @@ export class SmartPdf {
|
||||
}
|
||||
|
||||
const pdfBuffer = await page.pdf({
|
||||
format: 'A4'
|
||||
format: 'A4',
|
||||
printBackground: true,
|
||||
displayHeaderFooter: false,
|
||||
preferCSSPageSize: true
|
||||
});
|
||||
await page.close();
|
||||
delete this._candidates[pdfCandidate.pdfId];
|
||||
@ -89,13 +96,21 @@ export class SmartPdf {
|
||||
};
|
||||
}
|
||||
|
||||
async getPdfForWebsite(websiteUrl: string): Promise<IPdfResult> {
|
||||
async getPdfResultForWebsite(websiteUrl: string): Promise<interfaces.IPdfResult> {
|
||||
const page = await this.headlessBrowser.newPage();
|
||||
page.emulateMedia('screen');
|
||||
await page.emulateMediaType('screen');
|
||||
const response = await page.goto(websiteUrl, { waitUntil: 'networkidle2' });
|
||||
const pdfId = plugins.smartunique.shortId();
|
||||
const { documentHeight, documentWidth } = await page.evaluate(() => {
|
||||
return {
|
||||
documentHeight: document.height,
|
||||
documentWidth: document.width
|
||||
};
|
||||
});
|
||||
const pdfBuffer = await page.pdf({
|
||||
format: 'A4',
|
||||
height: documentWidth,
|
||||
width: documentWidth,
|
||||
printBackground: true,
|
||||
displayHeaderFooter: false,
|
||||
preferCSSPageSize: true
|
||||
@ -110,7 +125,7 @@ export class SmartPdf {
|
||||
|
||||
async getFullWebsiteAsSinglePdf(websiteUrl: string) {
|
||||
const page = await this.headlessBrowser.newPage();
|
||||
page.emulateMedia('screen');
|
||||
page.emulateMediaType('screen');
|
||||
const response = await page.goto(websiteUrl, { waitUntil: 'networkidle2' });
|
||||
const pdfId = plugins.smartunique.shortId();
|
||||
const { documentHeight, documentWidth } = await page.evaluate(() => {
|
||||
@ -120,6 +135,7 @@ export class SmartPdf {
|
||||
};
|
||||
});
|
||||
const pdfBuffer = await page.pdf({
|
||||
format: 'A4',
|
||||
height: documentWidth,
|
||||
width: documentWidth,
|
||||
printBackground: true,
|
||||
|
@ -1,6 +1,3 @@
|
||||
import * as plugins from './smartpdf.plugins';
|
||||
|
||||
export const packageDir = plugins.path.join(__dirname, '../');
|
||||
export const pdfDir = plugins.path.join(packageDir, 'assets/pdfdir');
|
||||
|
||||
plugins.smartfile.fs.ensureDirSync(pdfDir);
|
||||
|
@ -7,13 +7,13 @@ 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';
|
||||
|
||||
export { smartfile, smartpromise, smartunique, smartnetwork };
|
||||
export { smartfile, smartpromise, smartpuppeteer, smartunique, smartnetwork };
|
||||
|
||||
// thirdparty
|
||||
import express from 'express';
|
||||
import puppeteer from 'puppeteer';
|
||||
|
||||
export { express, puppeteer };
|
||||
export { express };
|
||||
|
Reference in New Issue
Block a user