3.0.14

.gitlab-ci.yml

@@ -12,40 +12,36 @@ stages:
   - release
   - metadata
 
+before_script:
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
+
+# ====================
+# security stage
+# ====================
 # ====================
 # 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
+     - npmci command npm config set registry https://registry.npmjs.org
+     - npmci command pnpm audit --audit-level=high --prod
   tags:
+    - lossless
     - docker
+  allow_failure: true
 
 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
+    - npmci command pnpm audit --audit-level=high --dev
   tags:
+    - lossless
     - docker
   allow_failure: true
 
@@ -56,7 +52,6 @@ auditDevDependencies:
 testStable:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
@@ -67,7 +62,6 @@ testStable:
 testBuild:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci command npm run build
@@ -96,10 +90,9 @@ codequality:
   only:
     - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -119,11 +112,9 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
+    - npmci node install stable
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

.vscode/launch.json

@@ -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"
     }
   ]
 }

license

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Push.Rocks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

npmextra.json

@@ -9,7 +9,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartpdf",
-      "shortDescription": "Create PDFs fast and smoothly",
+      "description": "Create PDFs fast and smoothly",
       "npmPackagename": "@pushrocks/smartpdf",
       "license": "MIT"
     }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartpdf",
-  "version": "3.0.3",
+  "version": "3.0.14",
   "private": false,
   "description": "create pdfs on the fly",
   "main": "dist_ts/index.js",
@@ -10,24 +10,28 @@
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web --allowimplicitany)"
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.61",
-    "@gitzone/tsrun": "^1.2.32",
-    "@gitzone/tstest": "^1.0.69",
-    "@pushrocks/tapbundle": "^5.0.3",
-    "@types/node": "^17.0.23"
+    "@gitzone/tsbuild": "^2.1.65",
+    "@gitzone/tsdoc": "^1.1.12",
+    "@gitzone/tsrun": "^1.2.35",
+    "@gitzone/tstest": "^1.0.73",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.7.18"
   },
   "dependencies": {
-    "@pushrocks/smartfile": "^9.0.6",
+    "@pushrocks/smartdelay": "^2.0.13",
+    "@pushrocks/smartfile": "^10.0.5",
     "@pushrocks/smartnetwork": "^3.0.0",
     "@pushrocks/smartpath": "^5.0.5",
     "@pushrocks/smartpromise": "^3.1.7",
-    "@pushrocks/smartpuppeteer": "^2.0.0",
+    "@pushrocks/smartpuppeteer": "^2.0.2",
     "@pushrocks/smartunique": "^3.0.3",
-    "@types/express": "^4.17.13",
-    "express": "^4.17.3",
+    "@tsclass/tsclass": "^4.0.21",
+    "@types/express": "^4.17.14",
+    "express": "^4.18.1",
     "pdf-merger-js": "^3.4.0",
     "pdf2json": "^2.0.0"
   },

test/test.ts

@@ -37,19 +37,21 @@ tap.test('should create a valid PDFResult', async () => {
     if (!fs.existsSync('.nogit/')) {
       fs.mkdirSync('.nogit/');
     }
-    fs.writeFileSync(`.nogit/${fileName}`, pdfResult.buffer);
+    fs.writeFileSync(`.nogit/${fileName}`, pdfResult.buffer as Buffer);
   };
-  await writePDfToDisk('https://maintainedby.lossless.com/', '1.pdf')
-  await writePDfToDisk('https://rendertron.lossless.one/render/https://fitnessloft.de/impressum/', '2.pdf')
+  await writePDfToDisk('https://maintainedby.lossless.com/', '1.pdf');
+  await writePDfToDisk('https://rendertron.lossless.one/render/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]));
-
-})
+  const pdf1 = await testSmartPdf.readFileToPdfObject('.nogit/1.pdf');
+  const pdf2 = await testSmartPdf.readFileToPdfObject('.nogit/2.pdf');
+  fs.writeFileSync(
+    `.nogit/combined.pdf`,
+    (await testSmartPdf.mergePdfs([pdf1, pdf2])).buffer as Buffer
+  );
+});
 
 tap.test('should be able to close properly', async () => {
   await testSmartPdf.stop();

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@pushrocks/smartpdf',
-  version: '3.0.3',
+  version: '3.0.14',
   description: 'create pdfs on the fly'
 }

ts/index.ts

@@ -6,5 +6,4 @@ declare global {
 }
 
 // normal
-export * from './interfaces/index.js';
 export * from './smartpdf.classes.smartpdf.js';

ts/interfaces/index.ts

@@ -1 +0,0 @@
-export * from './interface.pdfresult.js';

ts/interfaces/interface.pdfresult.ts

@@ -1,8 +0,0 @@
-export interface IPdfResult {
-  name: string;
-  id: string;
-  metadata: {
-    textExtraction: string;
-  };
-  buffer: Buffer;
-}

ts/smartpdf.classes.pdfcandidate.ts

@@ -1,7 +1,7 @@
 /*
-* pdf candidate is a construct used internally for mapping html
-* to pdf buffers delivered by puppeteer
-*/
+ * 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 {

ts/smartpdf.classes.smartpdf.ts

@@ -2,12 +2,18 @@ import * as plugins from './smartpdf.plugins.js';
 import * as paths from './smartpdf.paths.js';
 import { Server } from 'http';
 import { PdfCandidate } from './smartpdf.classes.pdfcandidate.js';
+import { IPdf } from '@tsclass/tsclass/dist_ts/business/pdf.js';
 
 declare const document: any;
 
-import * as interfaces from './interfaces/index.js';
-
 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 +26,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
@@ -43,7 +50,9 @@ export class SmartPdf {
     this.htmlServerInstance.listen(3210, 'localhost');
     this.htmlServerInstance.on('listening', () => {
       this._readyDeferred.resolve();
+      done.resolve();
     });
+    await done.promise;
   }
 
   // stop
@@ -63,7 +72,7 @@ export class SmartPdf {
   /**
    * 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;
@@ -75,6 +84,7 @@ export class SmartPdf {
     const response = await page.goto(`http://localhost:3210/${pdfCandidate.pdfId}`, {
       waitUntil: 'networkidle2',
     });
+    // await plugins.smartdelay.delayFor(1000);
     const headers = response.headers();
     if (headers['pdf-id'] !== pdfCandidate.pdfId) {
       console.log('Error! Headers do not match. For security reasons no pdf is being emitted!');
@@ -103,7 +113,7 @@ export class SmartPdf {
     };
   }
 
-  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,
@@ -135,7 +145,7 @@ export class SmartPdf {
     };
   }
 
-  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,
@@ -160,7 +170,7 @@ export class SmartPdf {
       printBackground: true,
       displayHeaderFooter: false,
       scale: 1,
-      pageRanges: '1'
+      pageRanges: '1',
     });
     await page.close();
     return {
@@ -173,26 +183,43 @@ export class SmartPdf {
     };
   }
 
-  public async mergePdfBuffers(pdfBuffers: Buffer[]): Promise<Buffer> {
+  public async mergePdfs(pdfArrayArg: plugins.tsclass.business.IPdf[]): Promise<IPdf> {
     const merger = new plugins.pdfMerger();
-    for (const buffer of pdfBuffers) {
-      merger.add(buffer);
+    for (const pdf of pdfArrayArg) {
+      merger.add(Buffer.from(pdf.buffer));
     }
-    return merger.saveAsBuffer();
+    const resultBuffer = await merger.saveAsBuffer();
+    return {
+      name: 'mergedPdf',
+      buffer: resultBuffer,
+      id: null,
+      metadata: null,
+    };
+  }
+
+  public async readFileToPdfObject(pathArg: string): Promise<plugins.tsclass.business.IPdf> {
+    const path = plugins.smartpath.transform.makeAbsolute(pathArg);
+    const parsedPath = plugins.path.parse(path);
+    const buffer = await plugins.smartfile.fs.toBuffer(path);
+    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);
     });

ts/smartpdf.paths.ts

@@ -1,3 +1,6 @@
 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),
+  '../'
+);

ts/smartpdf.plugins.ts

@@ -6,13 +6,27 @@ export { http, path };
 
 // @pushrocks
 import * as smartfile from '@pushrocks/smartfile';
+import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartpath from '@pushrocks/smartpath';
 import * as smartpuppeteer from '@pushrocks/smartpuppeteer';
 import * as smartnetwork from '@pushrocks/smartnetwork';
 import * as smartunique from '@pushrocks/smartunique';
 
-export { smartfile, smartpromise, smartpath, smartpuppeteer, smartunique, smartnetwork };
+export {
+  smartfile,
+  smartdelay,
+  smartpromise,
+  smartpath,
+  smartpuppeteer,
+  smartunique,
+  smartnetwork,
+};
+
+// tsclass scope
+import * as tsclass from '@tsclass/tsclass';
+
+export { tsclass };
 
 // thirdparty
 import pdfMerger from 'pdf-merger-js';

tsconfig.json

@@ -3,6 +3,7 @@
     "experimentalDecorators": true,
     "target": "ES2022",
     "module": "ES2022",
-    "moduleResolution": "nodenext"
+    "moduleResolution": "nodenext",
+    "allowSyntheticDefaultImports": true
   }
 }