Compare commits
21 Commits
Author | SHA1 | Date | |
---|---|---|---|
86d2fc2c5b | |||
f97866fe82 | |||
5c0b8c4df0 | |||
8da88be5e8 | |||
4f0164965c | |||
63f4321b04 | |||
e4287e9943 | |||
337c299a5e | |||
4ac4d8d049 | |||
5e8abaa5b4 | |||
d8fd7f9956 | |||
1711aadb6b | |||
06b9385e97 | |||
94386b0e02 | |||
36fea0b0f2 | |||
437d56e54d | |||
1537705cde | |||
bb7cb4a6ab | |||
bda43bf5e7 | |||
58d923b14c | |||
e981d61a54 |
3
.gitignore
vendored
3
.gitignore
vendored
@ -19,4 +19,5 @@ dist_web/
|
|||||||
dist_serve/
|
dist_serve/
|
||||||
dist_ts_web/
|
dist_ts_web/
|
||||||
|
|
||||||
# custom
|
# custom
|
||||||
|
assets/pdfdir
|
||||||
|
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
873
package-lock.json
generated
873
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
18
package.json
18
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartpdf",
|
"name": "@pushrocks/smartpdf",
|
||||||
"version": "1.0.5",
|
"version": "1.0.14",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "create pdfs on the fly",
|
"description": "create pdfs on the fly",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
@ -13,21 +13,21 @@
|
|||||||
"build": "(tsbuild)"
|
"build": "(tsbuild)"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.8",
|
"@gitzone/tsbuild": "^2.1.11",
|
||||||
"@gitzone/tsrun": "^1.2.5",
|
"@gitzone/tsrun": "^1.2.6",
|
||||||
"@gitzone/tstest": "^1.0.20",
|
"@gitzone/tstest": "^1.0.24",
|
||||||
"@pushrocks/tapbundle": "^3.0.9",
|
"@pushrocks/tapbundle": "^3.0.9",
|
||||||
"@types/node": "^11.13.2"
|
"@types/node": "^12.0.3"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/smartfile": "^7.0.2",
|
"@pushrocks/smartfile": "^7.0.2",
|
||||||
"@pushrocks/smartnetwork": "^1.1.0",
|
"@pushrocks/smartnetwork": "^1.1.6",
|
||||||
"@pushrocks/smartpromise": "^3.0.2",
|
"@pushrocks/smartpromise": "^3.0.2",
|
||||||
"@pushrocks/smartunique": "^3.0.1",
|
"@pushrocks/smartunique": "^3.0.1",
|
||||||
"@types/express": "^4.16.1",
|
"@types/express": "^4.16.1",
|
||||||
"@types/puppeteer": "^1.12.3",
|
"@types/puppeteer": "^1.12.4",
|
||||||
"express": "^4.16.4",
|
"express": "^4.17.1",
|
||||||
"puppeteer": "^1.14.0"
|
"puppeteer": "^1.17.0"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/*",
|
"ts/*",
|
||||||
|
17
test/test.ts
17
test/test.ts
@ -8,16 +8,29 @@ tap.test('should create a valid instance of smartpdf', async () => {
|
|||||||
expect(testSmartPdf).to.be.instanceof(smartpdf.SmartPdf);
|
expect(testSmartPdf).to.be.instanceof(smartpdf.SmartPdf);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
tap.test('should start the instance', async () => {
|
||||||
|
await testSmartPdf.start();
|
||||||
|
});
|
||||||
|
|
||||||
tap.test('should create a pdf from html string', async () => {
|
tap.test('should create a pdf from html string', async () => {
|
||||||
await testSmartPdf.getPdfForHtmlString('hi');
|
await testSmartPdf.getPdfForHtmlString('hi');
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('should create a pdf from website', async () => {
|
tap.test('should create a pdf from website as A4', async () => {
|
||||||
await testSmartPdf.getPdfForWebsite('https://maintainedby.lossless.com');
|
await testSmartPdf.getPdfForWebsite('https://maintainedby.lossless.com');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
tap.test('should create a pdf from website as single page PDF', async () => {
|
||||||
|
await testSmartPdf.getFullWebsiteAsSinglePdf('https://maintainedby.lossless.com');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should create a valid PDFResult', async () => {
|
||||||
|
const pdfResult = await testSmartPdf.getFullWebsiteAsSinglePdf('https://maintainedby.lossless.com');
|
||||||
|
expect(pdfResult.buffer).to.be.instanceOf(Buffer);
|
||||||
|
});
|
||||||
|
|
||||||
tap.test('should be able to close properly', async () => {
|
tap.test('should be able to close properly', async () => {
|
||||||
await testSmartPdf.close();
|
await testSmartPdf.stop();
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.start();
|
tap.start();
|
||||||
|
1
ts/interfaces/index.ts
Normal file
1
ts/interfaces/index.ts
Normal file
@ -0,0 +1 @@
|
|||||||
|
export * from './interface.pdfresult';
|
5
ts/interfaces/interface.pdfresult.ts
Normal file
5
ts/interfaces/interface.pdfresult.ts
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
export interface IPdfResult {
|
||||||
|
name: string,
|
||||||
|
id: string,
|
||||||
|
buffer: Buffer;
|
||||||
|
}
|
@ -3,21 +3,36 @@ import * as paths from './smartpdf.paths';
|
|||||||
import { Server } from 'http';
|
import { Server } from 'http';
|
||||||
import { PdfCandidate } from './smartpdf.classes.pdfcandidate';
|
import { PdfCandidate } from './smartpdf.classes.pdfcandidate';
|
||||||
|
|
||||||
|
declare const document;
|
||||||
|
|
||||||
|
import { IPdfResult } from './interfaces';
|
||||||
|
|
||||||
export class SmartPdf {
|
export class SmartPdf {
|
||||||
htmlServerInstance: Server;
|
htmlServerInstance: Server;
|
||||||
serverPort: number;
|
serverPort: number;
|
||||||
headlessBrowser: plugins.puppeteer.Browser;
|
headlessBrowser: plugins.puppeteer.Browser;
|
||||||
|
externalBrowser: boolean = false;
|
||||||
private _readyDeferred: plugins.smartpromise.Deferred<void>;
|
private _readyDeferred: plugins.smartpromise.Deferred<void>;
|
||||||
private _candidates: { [key: string]: PdfCandidate } = {};
|
private _candidates: { [key: string]: PdfCandidate } = {};
|
||||||
|
|
||||||
constructor() {
|
constructor(headlessBrowserArg?) {
|
||||||
|
this.headlessBrowser = headlessBrowserArg
|
||||||
this._readyDeferred = new plugins.smartpromise.Deferred();
|
this._readyDeferred = new plugins.smartpromise.Deferred();
|
||||||
this.init();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async init() {
|
async start() {
|
||||||
// setup puppeteer
|
// setup puppeteer
|
||||||
this.headlessBrowser = await plugins.puppeteer.launch();
|
if (!this.headlessBrowser) {
|
||||||
|
let chromeArgs: string[] = [];
|
||||||
|
if(process.env.CI) {
|
||||||
|
chromeArgs = chromeArgs.concat(['--no-sandbox', '--disable-setuid-sandbox'])
|
||||||
|
}
|
||||||
|
this.headlessBrowser = await plugins.puppeteer.launch({
|
||||||
|
args: chromeArgs
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
this.externalBrowser = true;
|
||||||
|
}
|
||||||
|
|
||||||
// setup server
|
// setup server
|
||||||
const app = plugins.express();
|
const app = plugins.express();
|
||||||
@ -34,19 +49,23 @@ export class SmartPdf {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
async close() {
|
async stop() {
|
||||||
const done = plugins.smartpromise.defer<void>();
|
const done = plugins.smartpromise.defer<void>();
|
||||||
this.htmlServerInstance.close(() => {
|
this.htmlServerInstance.close(() => {
|
||||||
done.resolve();
|
done.resolve();
|
||||||
});
|
});
|
||||||
await this.headlessBrowser.close();
|
|
||||||
|
if (!this.externalBrowser) {
|
||||||
|
await this.headlessBrowser.close();
|
||||||
|
}
|
||||||
|
|
||||||
await done.promise;
|
await done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* returns a pdf for a given html string;
|
* returns a pdf for a given html string;
|
||||||
*/
|
*/
|
||||||
async getPdfForHtmlString(htmlStringArg: string) {
|
async getPdfForHtmlString(htmlStringArg: string): Promise<IPdfResult> {
|
||||||
await this._readyDeferred.promise;
|
await this._readyDeferred.promise;
|
||||||
const pdfCandidate = new PdfCandidate(htmlStringArg);
|
const pdfCandidate = new PdfCandidate(htmlStringArg);
|
||||||
this._candidates[pdfCandidate.pdfId] = pdfCandidate;
|
this._candidates[pdfCandidate.pdfId] = pdfCandidate;
|
||||||
@ -62,27 +81,62 @@ export class SmartPdf {
|
|||||||
console.log(`id security check passed for ${pdfCandidate.pdfId}`);
|
console.log(`id security check passed for ${pdfCandidate.pdfId}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
await page.pdf({
|
const pdfBuffer = await page.pdf({
|
||||||
path: plugins.path.join(paths.pdfDir, `${pdfCandidate.pdfId}.pdf`),
|
|
||||||
format: 'A4'
|
format: 'A4'
|
||||||
});
|
});
|
||||||
await page.close();
|
await page.close();
|
||||||
delete this._candidates[pdfCandidate.pdfId];
|
delete this._candidates[pdfCandidate.pdfId];
|
||||||
pdfCandidate.doneDeferred.resolve();
|
pdfCandidate.doneDeferred.resolve();
|
||||||
await pdfCandidate.doneDeferred.promise;
|
await pdfCandidate.doneDeferred.promise;
|
||||||
|
return {
|
||||||
|
id: pdfCandidate.pdfId,
|
||||||
|
name: `${pdfCandidate.pdfId}.js`,
|
||||||
|
buffer: pdfBuffer
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
async getPdfForWebsite(websiteUrl: string) {
|
async getPdfForWebsite(websiteUrl: string): Promise<IPdfResult> {
|
||||||
const page = await this.headlessBrowser.newPage();
|
const page = await this.headlessBrowser.newPage();
|
||||||
|
page.emulateMedia('screen');
|
||||||
const response = await page.goto(websiteUrl, { waitUntil: 'networkidle2' });
|
const response = await page.goto(websiteUrl, { waitUntil: 'networkidle2' });
|
||||||
const pdfId = plugins.smartunique.shortId();
|
const pdfId = plugins.smartunique.shortId();
|
||||||
await page.pdf({
|
const pdfBuffer = await page.pdf({
|
||||||
path: plugins.path.join(paths.pdfDir, `${pdfId}.pdf`),
|
|
||||||
format: 'A4',
|
format: 'A4',
|
||||||
printBackground: true,
|
printBackground: true,
|
||||||
displayHeaderFooter: false,
|
displayHeaderFooter: false,
|
||||||
preferCSSPageSize: true
|
preferCSSPageSize: true
|
||||||
});
|
});
|
||||||
await page.close();
|
await page.close();
|
||||||
|
return {
|
||||||
|
id: pdfId,
|
||||||
|
name: `${pdfId}.js`,
|
||||||
|
buffer: pdfBuffer
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async getFullWebsiteAsSinglePdf(websiteUrl: string) {
|
||||||
|
const page = await this.headlessBrowser.newPage();
|
||||||
|
page.emulateMedia('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({
|
||||||
|
height: documentWidth,
|
||||||
|
width: documentWidth,
|
||||||
|
printBackground: true,
|
||||||
|
displayHeaderFooter: false,
|
||||||
|
preferCSSPageSize: true
|
||||||
|
});
|
||||||
|
await page.close();
|
||||||
|
return {
|
||||||
|
id: pdfId,
|
||||||
|
name: `${pdfId}.js`,
|
||||||
|
buffer: pdfBuffer
|
||||||
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -13,7 +13,7 @@ import * as smartunique from '@pushrocks/smartunique';
|
|||||||
export { smartfile, smartpromise, smartunique, smartnetwork };
|
export { smartfile, smartpromise, smartunique, smartnetwork };
|
||||||
|
|
||||||
// thirdparty
|
// thirdparty
|
||||||
import * as express from 'express';
|
import express from 'express';
|
||||||
import * as puppeteer from 'puppeteer';
|
import puppeteer from 'puppeteer';
|
||||||
|
|
||||||
export { express, puppeteer };
|
export { express, puppeteer };
|
||||||
|
Reference in New Issue
Block a user