@d-zero/puppeteer-screenshot 1.2.0 → 3.0.0

package/dist/get-binary.d.ts

@@ -1,2 +1,6 @@
-import type { Page } from 'puppeteer';
-export declare function getBinary(page: Page): Promise<Uint8Array>;
+import type { Page } from '@d-zero/puppeteer-page';
+/**
+ *
+ * @param page
+ */
+export declare function getBinary(page: Page): Promise<Uint8Array<ArrayBufferLike>>;

package/dist/get-binary.js

@@ -1,3 +1,7 @@
+/**
+ *
+ * @param page
+ */
 export async function getBinary(page) {
     const buffer = await page.screenshot({
         fullPage: true,

package/dist/screenshot-listener.d.ts

@@ -1,2 +1,2 @@
-import type { ScreenshotListener } from './types.js';
-export declare function screenshotListener(update: (log: string) => void): ScreenshotListener;
+import type { ScreenshotPhase } from './types.js';
+export declare const screenshotListener: (log: (log: string) => void) => import("@d-zero/puppeteer-general-actions").Listener<ScreenshotPhase>;

package/dist/screenshot-listener.js

@@ -1,43 +1,18 @@
 import path from 'node:path';
-import c from 'ansi-colors';
-export function screenshotListener(update) {
-    return (phase, data) => {
-        const sizeLabel = c.bgMagenta(` ${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;
-            }
-        }
+import { createListener } from '@d-zero/puppeteer-general-actions';
+import { pageScanLoggers } from '@d-zero/puppeteer-page-scan';
+export const screenshotListener = createListener((log) => {
+    return {
+        ...pageScanLoggers(log),
+        screenshotStart() {
+            log(`📸 Take a screenshot`);
+        },
+        screenshotSaving({ path: filePath }) {
+            const name = path.basename(filePath);
+            log(`🖼  Save a file ${name}`);
+        },
+        screenshotError({ error }) {
+            log(`❌️ ${error.message}`);
+        },
     };
-}
+});

package/dist/screenshot.d.ts

@@ -1,17 +1,17 @@
-import type { Screenshot, ScreenshotListener } from './types.js';
+import type { Screenshot, ScreenshotPhase } from './types.js';
+import type { Listener } from '@d-zero/puppeteer-general-actions';
+import type { Page } from '@d-zero/puppeteer-page';
 import type { PageHook, Sizes } from '@d-zero/puppeteer-page-scan';
-import type { Page } from 'puppeteer';
 type Options = {
     id?: string;
     sizes?: Sizes;
     hooks?: readonly PageHook[];
-    listener?: ScreenshotListener;
+    listener?: Listener<ScreenshotPhase>;
     domOnly?: boolean;
     path?: string;
 };
 /**
  * Takes screenshots of a web page at different sizes and resolutions.
- *
  * @param page - The Puppeteer page object.
  * @param url - The URL of the web page to take screenshots of.
  * @param options - Optional settings for the screenshot process.

package/dist/screenshot.js

@@ -3,7 +3,6 @@ import { urlToFileName } from '@d-zero/shared/url-to-file-name';
 import { getBinary } from './get-binary.js';
 /**
  * Takes screenshots of a web page at different sizes and resolutions.
- *
  * @param page - The Puppeteer page object.
  * @param url - The URL of the web page to take screenshots of.
  * @param options - Optional settings for the screenshot process.
@@ -21,6 +20,9 @@ export async function screenshot(page, url, options) {
             name,
             width,
             resolution,
+            listener(phase, data) {
+                listener?.(phase, data);
+            },
         });
         let binary = null;
         const filePath = options?.path?.replace(/\.png$/i, `@${name}.png`) ?? null;

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 export type { PageHook } from '@d-zero/puppeteer-page-scan';
-import type { Listener as ScanListener, Phase as ScanPhase, Size } from '@d-zero/puppeteer-page-scan';
+import type { Listener as GeneralListener } from '@d-zero/puppeteer-general-actions';
+import type { PageScanPhase, Size } from '@d-zero/puppeteer-page-scan';
 export type Screenshot = {
     id: string;
     filePath: string | null;
@@ -31,8 +32,11 @@ export type ScreenshotPhase = {
         name: string;
         dom: string;
     };
-} & ScanPhase;
-export type ScreenshotListener = ScanListener<ScreenshotPhase>;
+} & PageScanPhase;
+/**
+ * @deprecated
+ */
+export type ScreenshotListener = GeneralListener<ScreenshotPhase>;
 /**
  * @deprecated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/puppeteer-screenshot",
-	"version": "1.2.0",
+	"version": "3.0.0",
 	"description": "Screenshot utility for puppeteer",
 	"author": "D-ZERO",
 	"license": "MIT",
@@ -20,16 +20,16 @@
 	],
 	"scripts": {
 		"build": "tsc",
+		"watch": "tsc --watch",
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/puppeteer-page-scan": "1.0.0",
-		"@d-zero/puppeteer-scroll": "1.0.5",
-		"@d-zero/shared": "0.5.0",
-		"ansi-colors": "4.1.3"
+		"@d-zero/puppeteer-general-actions": "1.2.0",
+		"@d-zero/puppeteer-page-scan": "3.0.0",
+		"@d-zero/shared": "0.7.0"
 	},
 	"devDependencies": {
-		"puppeteer": "23.5.0"
+		"@d-zero/puppeteer-page": "0.3.0"
 	},
-	"gitHead": "e8f65086bf7c316dda6667f1173da8585a5ef19c"
+	"gitHead": "e4fd17857e31022d121527b00fd7f009dbdb2142"
 }

package/dist/before-page-scan.d.ts

@@ -1,9 +0,0 @@
-import type { Listener, PageHook, Size } from './types.js';
-import type { Page } from 'puppeteer';
-type Options = {
-    name: string;
-    hooks?: readonly PageHook[];
-    listener?: Listener;
-} & Size;
-export declare function beforePageScan(page: Page, url: string, options?: Options): Promise<void>;
-export {};

package/dist/before-page-scan.js

@@ -1,33 +0,0 @@
-import { scrollAllOver } from '@d-zero/puppeteer-scroll';
-export async function beforePageScan(page, url, options) {
-    const listener = options?.listener;
-    const name = options?.name ?? 'default';
-    const width = options?.width ?? 1400;
-    const resolution = options?.resolution;
-    listener?.('setViewport', { name, width, resolution });
-    await page.setViewport({
-        width,
-        height: 
-        // Landscape or portrait
-        width > 1000 ? Math.floor(width * 0.75) : Math.floor(width * 1.5),
-        deviceScaleFactor: resolution ?? 1,
-    });
-    if (page.url() === url) {
-        listener?.('load', { name, type: 'reaload' });
-        await page.reload({ waitUntil: 'networkidle0' });
-    }
-    else {
-        listener?.('load', { name, type: 'open' });
-        await page.goto(url, { waitUntil: 'networkidle0' });
-    }
-    for (const hook of options?.hooks ?? []) {
-        await hook(page, {
-            name,
-            width,
-            resolution,
-            log: (message) => listener?.('hook', { name, message }),
-        });
-    }
-    listener?.('scroll', { name });
-    await scrollAllOver(page);
-}