@d-zero/print 1.1.0 → 1.2.0

package/dist/png-to-pdf.d.ts

@@ -1,3 +1,9 @@
 import type { Page } from '@d-zero/puppeteer-page';
 import type { Screenshot } from '@d-zero/puppeteer-screenshot';
+/**
+ *
+ * @param page
+ * @param screenshots
+ * @param update
+ */
 export declare function pngToPdf(page: Page, screenshots: Record<string, Screenshot>, update: (log: string) => void): Promise<void>;

package/dist/png-to-pdf.js

@@ -2,6 +2,12 @@ import { rm } from 'node:fs/promises';
 import path from 'node:path';
 import c from 'ansi-colors';
 import { printPdfWithNote } from './print-pdf-with-note.js';
+/**
+ *
+ * @param page
+ * @param screenshots
+ * @param update
+ */
 export async function pngToPdf(page, screenshots, update) {
     for (const [sizeName, screenshot] of Object.entries(screenshots)) {
         if (!screenshot.filePath) {

package/dist/print-pdf-with-note.d.ts

@@ -1,3 +1,12 @@
 import type { Page } from '@d-zero/puppeteer-page';
 import type { Screenshot } from '@d-zero/puppeteer-screenshot';
+/**
+ *
+ * @param page
+ * @param root0
+ * @param root0.id
+ * @param root0.filePath
+ * @param root0.url
+ * @param root0.title
+ */
 export declare function printPdfWithNote(page: Page, { id, filePath, url, title }: Screenshot): Promise<void>;

package/dist/print-pdf-with-note.js

@@ -1,4 +1,13 @@
 import dayjs from 'dayjs';
+/**
+ *
+ * @param page
+ * @param root0
+ * @param root0.id
+ * @param root0.filePath
+ * @param root0.url
+ * @param root0.title
+ */
 export async function printPdfWithNote(page, { id, filePath, url, title }) {
     if (!filePath) {
         throw new Error(`No file path (ID: ${id}): ${url}`);

package/dist/print-pdf.d.ts

@@ -1,3 +1,11 @@
 import type { Page } from '@d-zero/puppeteer-page';
 import type { PageHook } from '@d-zero/puppeteer-page-scan';
+/**
+ *
+ * @param page
+ * @param url
+ * @param filePath
+ * @param update
+ * @param hooks
+ */
 export declare function printPdf(page: Page, url: string, filePath: string, update: (log: string) => void, hooks?: readonly PageHook[]): Promise<void>;

package/dist/print-pdf.js

@@ -1,4 +1,12 @@
 import { beforePageScan, pageScanListener } from '@d-zero/puppeteer-page-scan';
+/**
+ *
+ * @param page
+ * @param url
+ * @param filePath
+ * @param update
+ * @param hooks
+ */
 export async function printPdf(page, url, filePath, update, hooks) {
     await beforePageScan(page, url, {
         name: 'pdf',

package/dist/print-png.d.ts

@@ -1,3 +1,12 @@
 import type { Page } from '@d-zero/puppeteer-page';
 import type { PageHook } from '@d-zero/puppeteer-screenshot';
+/**
+ *
+ * @param page
+ * @param url
+ * @param fileId
+ * @param filePath
+ * @param update
+ * @param hooks
+ */
 export declare function printPng(page: Page, url: string, fileId: string, filePath: string, update: (log: string) => void, hooks?: readonly PageHook[]): Promise<Record<string, import("@d-zero/puppeteer-screenshot").Screenshot>>;

package/dist/print-png.js

@@ -1,4 +1,13 @@
 import { screenshot, screenshotListener } from '@d-zero/puppeteer-screenshot';
+/**
+ *
+ * @param page
+ * @param url
+ * @param fileId
+ * @param filePath
+ * @param update
+ * @param hooks
+ */
 export function printPng(page, url, fileId, filePath, update, hooks) {
     return screenshot(page, url, {
         id: fileId,

package/dist/print.d.ts

@@ -7,6 +7,11 @@ export interface PrintOptions {
     readonly verbose?: boolean;
     readonly hooks?: readonly PageHook[];
 }
+/**
+ *
+ * @param urlList
+ * @param options
+ */
 export declare function print(urlList: readonly (string | {
     id: string | null;
     url: string;

package/dist/print.js

@@ -5,6 +5,11 @@ import c from 'ansi-colors';
 import { pngToPdf } from './png-to-pdf.js';
 import { printPdf } from './print-pdf.js';
 import { printPng } from './print-png.js';
+/**
+ *
+ * @param urlList
+ * @param options
+ */
 export async function print(urlList, options) {
     const dir = path.resolve(process.cwd(), '.print');
     await mkdir(dir, { recursive: true }).catch(() => { });

package/dist/read-config.d.ts

@@ -1,3 +1,7 @@
+/**
+ *
+ * @param filePath
+ */
 export declare function readConfig(filePath: string): Promise<{
     urlList: {
         id: string | null;

package/dist/read-config.js

@@ -3,6 +3,10 @@ import path from 'node:path';
 import { readPageHooks } from '@d-zero/puppeteer-page-scan';
 import { toKvList } from '@d-zero/readtext/list';
 import fm from 'front-matter';
+/**
+ *
+ * @param filePath
+ */
 export async function readConfig(filePath) {
     const fileContent = await fs.readFile(filePath, 'utf8');
     const content = 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/print",
-	"version": "1.1.0",
+	"version": "1.2.0",
 	"description": "Print web pages to PDF or image files.",
 	"author": "D-ZERO",
 	"license": "MIT",
@@ -27,18 +27,18 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/html-distiller": "1.0.1",
-		"@d-zero/puppeteer-dealer": "0.2.0",
-		"@d-zero/puppeteer-page-scan": "2.0.0",
-		"@d-zero/puppeteer-screenshot": "2.0.0",
-		"@d-zero/readtext": "1.1.1",
+		"@d-zero/html-distiller": "1.0.2",
+		"@d-zero/puppeteer-dealer": "0.3.0",
+		"@d-zero/puppeteer-page-scan": "3.0.0",
+		"@d-zero/puppeteer-screenshot": "3.0.0",
+		"@d-zero/readtext": "1.1.2",
 		"ansi-colors": "4.1.3",
 		"dayjs": "1.11.13",
 		"front-matter": "4.0.2",
 		"minimist": "1.2.8"
 	},
 	"devDependencies": {
-		"@d-zero/puppeteer-page": "0.2.0"
+		"@d-zero/puppeteer-page": "0.3.0"
 	},
-	"gitHead": "1eb1c03400580040119121e11ffb33acd876fe1b"
+	"gitHead": "e4fd17857e31022d121527b00fd7f009dbdb2142"
 }

package/dist/label.d.ts

@@ -1,2 +0,0 @@
-import c from 'ansi-colors';
-export declare function label(str: string, color?: c.StyleFunction): string;

package/dist/label.js

@@ -1,4 +0,0 @@
-import c from 'ansi-colors';
-export function label(str, color = c.bgMagenta) {
-    return color(` ${str} `);
-}

package/dist/pdf.d.ts

@@ -1,6 +0,0 @@
-import type { Screenshot } from '@d-zero/puppeteer-screenshot';
-import type { Browser } from 'puppeteer';
-export declare function pngToPdf(browser: Browser, screenshots: Record<string, Screenshot>, options?: {
-    note?: boolean;
-    update?: (log: string) => void;
-}): Promise<void>;

package/dist/pdf.js

@@ -1,74 +0,0 @@
-import { rm } from 'node:fs/promises';
-import path from 'node:path';
-import dayjs from 'dayjs';
-import { label } from './label.js';
-export async function pngToPdf(browser, screenshots, options) {
-    const page = await browser.newPage();
-    page.setDefaultNavigationTimeout(0);
-    const note = options?.note ?? true;
-    const datetime = dayjs().format('YYYY-MM-DD HH:mm');
-    for (const [sizeName, { id, filePath, url, title }] of Object.entries(screenshots)) {
-        if (!filePath) {
-            continue;
-        }
-        const update = (log) => options?.update?.(`${label(sizeName)}: ${log}`);
-        update(`🖼  Open an image file`);
-        await page.goto(`file://${filePath}`, {
-            waitUntil: 'networkidle0',
-            timeout: 5 * 60 * 1000,
-        });
-        let noteSettings = {};
-        if (note) {
-            await page.evaluate(() => {
-                const style = document.createElement('style');
-                style.textContent = `
-						html, body { height: auto !important; }
-						html, body { margin: 0; padding: 0; }
-						img { width: 100% !important; height: auto !important; }
-					`;
-                document.body.setAttribute('style', 'margin: 0; padding: 0;');
-                document.head.append(style);
-            });
-            noteSettings = {
-                displayHeaderFooter: true,
-                margin: { top: '1.3cm', bottom: '1cm', left: '1cm', right: '5cm' },
-                headerTemplate: `
-						<div style="font-size: 2mm; width: 100%; display: flex; justify-content: space-between; margin: 0 1cm; font-family: sans-serif;">
-							<div>
-								<div>Title: ${title}</div>
-								<div style="font-size: 0.6em">Printed: ${datetime}</div>
-							</div>
-							<div>
-								<div style="font-size: 3mm; margin-bottom: 1mm; text-align: right;">[ID: ${id}]</div>
-								<div style="text-align: right; background-color: #000; color: #fff;">Note:</div>
-							</div>
-						</div>
-					`,
-                footerTemplate: `
-						<div style="font-size: 2mm; width: 100%; display: flex; justify-content: space-between; margin: 0 1cm; font-family: monospace;">
-							<div>
-								<span>[ID: ${id}] ${url}</span>
-							</div>
-							<div>
-								<span class="pageNumber"></span>/<span class="totalPages"></span>
-							</div>
-						</div>
-					`,
-            };
-        }
-        const dir = path.dirname(filePath);
-        const fileName = path.basename(filePath, path.extname(filePath));
-        const pdfPath = path.resolve(dir, `${fileName}.pdf`);
-        update('📝 Print as a PDF%dots%');
-        await page.pdf({
-            path: pdfPath,
-            timeout: 30_000 * 10, // Default * 10
-            format: 'A4',
-            printBackground: true,
-            margin: { top: '1cm', bottom: '1cm', left: '1cm', right: '1cm' },
-            ...noteSettings,
-        });
-        update('🚮 Remove the screenshot image');
-        await rm(filePath);
-    }
-}

package/dist/scan-listener.d.ts

@@ -1,2 +0,0 @@
-import type { Listener } from '@d-zero/puppeteer-screenshot';
-export declare function scanListener(update: (log: string) => void): Listener;

package/dist/scan-listener.js

@@ -1,43 +0,0 @@
-import path from 'node:path';
-import { label } from './label.js';
-export function scanListener(update) {
-    return (phase, data) => {
-        const sizeLabel = label(data.name);
-        switch (phase) {
-            case 'setViewport': {
-                const { width } = data;
-                update(`${sizeLabel} ↔️ Change viewport size to ${width}px`);
-                break;
-            }
-            case 'load': {
-                const { type } = data;
-                update(`${sizeLabel} %earth% ${type === 'open' ? 'Open' : 'Reload'} page`);
-                break;
-            }
-            case 'hook': {
-                const { message } = data;
-                update(`${sizeLabel} ${message}`);
-                break;
-            }
-            case 'scroll': {
-                update(`${sizeLabel} %propeller% Scroll the page`);
-                break;
-            }
-            case 'screenshotStart': {
-                update(`${sizeLabel} 📸 Take a screenshot`);
-                break;
-            }
-            case 'screenshotSaving': {
-                const { path: filePath } = data;
-                const name = path.basename(filePath);
-                update(`${sizeLabel} 🖼  Save a file ${name}`);
-                break;
-            }
-            case 'screenshotError': {
-                const { error } = data;
-                update(`${sizeLabel} ❌️ ${error.message}`);
-                break;
-            }
-        }
-    };
-}

package/dist/screenshot-listener.d.ts

@@ -1,2 +0,0 @@
-import type { ScreenshotListener } from '@d-zero/puppeteer-screenshot';
-export declare function screenshotListener(update: (log: string) => void): ScreenshotListener;

package/dist/screenshot-listener.js

@@ -1,43 +0,0 @@
-import path from 'node:path';
-import { label } from './label.js';
-export function screenshotListener(update) {
-    return (phase, data) => {
-        const sizeLabel = label(data.name);
-        switch (phase) {
-            case 'setViewport': {
-                const { width } = data;
-                update(`${sizeLabel} ↔️ Change viewport size to ${width}px`);
-                break;
-            }
-            case 'load': {
-                const { type } = data;
-                update(`${sizeLabel} %earth% ${type === 'open' ? 'Open' : 'Reload'} page`);
-                break;
-            }
-            case 'hook': {
-                const { message } = data;
-                update(`${sizeLabel} ${message}`);
-                break;
-            }
-            case 'scroll': {
-                update(`${sizeLabel} %propeller% Scroll the page`);
-                break;
-            }
-            case 'screenshotStart': {
-                update(`${sizeLabel} 📸 Take a screenshot`);
-                break;
-            }
-            case 'screenshotSaving': {
-                const { path: filePath } = data;
-                const name = path.basename(filePath);
-                update(`${sizeLabel} 🖼  Save a file ${name}`);
-                break;
-            }
-            case 'screenshotError': {
-                const { error } = data;
-                update(`${sizeLabel} ❌️ ${error.message}`);
-                break;
-            }
-        }
-    };
-}