@d-zero/puppeteer-page-scan 1.0.0 → 3.0.0

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

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

package/dist/before-page-scan.js

@@ -1,4 +1,10 @@
 import { scrollAllOver } from '@d-zero/puppeteer-scroll';
+/**
+ *
+ * @param page
+ * @param url
+ * @param options
+ */
 export async function beforePageScan(page, url, options) {
     const listener = options?.listener;
     const name = options?.name ?? 'default';
@@ -12,7 +18,7 @@ export async function beforePageScan(page, url, options) {
         width > 1000 ? Math.floor(width * 0.75) : Math.floor(width * 1.5),
         deviceScaleFactor: resolution ?? 1,
     });
-    if (page.url() === url) {
+    if ((await page.url()) === url) {
         listener?.('load', { name, type: 'reaload' });
         await page.reload({ waitUntil: 'networkidle0' });
     }
@@ -28,6 +34,13 @@ export async function beforePageScan(page, url, options) {
             log: (message) => listener?.('hook', { name, message }),
         });
     }
-    listener?.('scroll', { name });
-    await scrollAllOver(page);
+    listener?.('scroll', {
+        name,
+        scrollY: 0,
+        scrollHeight: Number.NaN,
+        message: 'Start scrolling',
+    });
+    await scrollAllOver(page, {
+        logger: (scrollY, scrollHeight, message) => listener?.('scroll', { name, scrollY, scrollHeight, message }),
+    });
 }

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { beforePageScan } from './before-page-scan.js';
 export { defaultSizes } from './default-sizes.js';
 export { readPageHooks } from './read-page-hooks.js';
+export { pageScanListener, pageScanLoggers } from './page-scan-listener.js';
 export * from './types.js';

package/dist/index.js

@@ -1,4 +1,5 @@
 export { beforePageScan } from './before-page-scan.js';
 export { defaultSizes } from './default-sizes.js';
 export { readPageHooks } from './read-page-hooks.js';
+export { pageScanListener, pageScanLoggers } from './page-scan-listener.js';
 export * from './types.js';

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

@@ -0,0 +1,4 @@
+import type { PageScanPhase } from './types.js';
+import type { Loggers } from '@d-zero/puppeteer-general-actions';
+export declare const pageScanLoggers: Loggers<PageScanPhase>;
+export declare const pageScanListener: (log: (log: string) => void) => import("@d-zero/puppeteer-general-actions").Listener<PageScanPhase>;

package/dist/page-scan-listener.js

@@ -0,0 +1,22 @@
+import { createListener } from '@d-zero/puppeteer-general-actions';
+export const pageScanLoggers = (log) => ({
+    setViewport: ({ width }) => {
+        log(`↔️ Change viewport size to ${width}px`);
+    },
+    load({ type }) {
+        log(`%earth% ${type === 'open' ? 'Open' : 'Reload'} page`);
+    },
+    hook({ message }) {
+        log(message);
+    },
+    scroll({ scrollY, scrollHeight, message }) {
+        if (Number.isNaN(scrollHeight)) {
+            log(`%propeller% ${message}`);
+            return;
+        }
+        log(`%propeller% ${scrollY}px/${scrollHeight}px (${Math.round((scrollY / scrollHeight) * 100)}%) ${message}`);
+    },
+});
+export const pageScanListener = createListener((log) => {
+    return pageScanLoggers(log);
+});

package/dist/read-page-hooks.d.ts

@@ -1,2 +1,7 @@
 import type { PageHook } from './types.js';
+/**
+ *
+ * @param hooks
+ * @param baseDir
+ */
 export declare function readPageHooks(hooks: readonly string[], baseDir: string): Promise<PageHook[]>;

package/dist/read-page-hooks.js

@@ -1,4 +1,9 @@
 import path from 'node:path';
+/**
+ *
+ * @param hooks
+ * @param baseDir
+ */
 export async function readPageHooks(hooks, baseDir) {
     const pageHooks = await Promise.all(hooks.map(async (hook) => {
         const hookAbsPath = path.isAbsolute(hook) ? hook : path.resolve(baseDir, hook);

package/dist/types.d.ts

@@ -1,5 +1,4 @@
-import type { Page } from 'puppeteer';
-export type Listener<P> = (phase: keyof P, data: P[keyof P]) => void;
+import type { Page } from '@d-zero/puppeteer-page';
 export type Sizes = Record<string, Size>;
 export type Size = {
     width: number;
@@ -9,7 +8,7 @@ export type PageHook = (page: Page, size: Size & {
     name: string;
     log: (message: string) => void;
 }) => Promise<void>;
-export type Phase = {
+export type PageScanPhase = {
     setViewport: {
         name: string;
         width: number;
@@ -25,5 +24,8 @@ export type Phase = {
     };
     scroll: {
         name: string;
+        scrollY: number;
+        scrollHeight: number;
+        message: string;
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/puppeteer-page-scan",
-	"version": "1.0.0",
+	"version": "3.0.0",
 	"description": "Scanning page function for puppeteer",
 	"author": "D-ZERO",
 	"license": "MIT",
@@ -20,13 +20,15 @@
 	],
 	"scripts": {
 		"build": "tsc",
+		"watch": "tsc --watch",
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/puppeteer-scroll": "1.0.5"
+		"@d-zero/puppeteer-general-actions": "1.2.0",
+		"@d-zero/puppeteer-scroll": "3.0.0"
 	},
 	"devDependencies": {
-		"puppeteer": "23.5.0"
+		"@d-zero/puppeteer-page": "0.3.0"
 	},
-	"gitHead": "e8f65086bf7c316dda6667f1173da8585a5ef19c"
+	"gitHead": "e4fd17857e31022d121527b00fd7f009dbdb2142"
 }