@d-zero/puppeteer-page-scan 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 D-ZERO Co., Ltd.
+
+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.

package/README.md

@@ -0,0 +1,47 @@
+# `@d-zero/puppeteer-page-scan`
+
+PuppeteerでスクリーンショットやDOMスキャンする際に必要なヘルパー関数を提供します。
+
+## インストール
+
+```sh
+yarn install @d-zero/puppeteer-page-scan
+```
+
+## 使い方
+
+### `beforePageScan`
+
+- ビューポートの設定
+- ページのリロード
+- 任意のフック処理
+  - ログインなどの事前処理
+- ページ全体をスクロール
+
+などを行い、スキャンに必要な状態を整えるためのヘルパー関数です。
+
+```ts
+import { beforePageScan } from '@d-zero/puppeteer-page-scan';
+
+const browser = await puppeteer.launch();
+const page = await browser.newPage();
+
+await beforePageScan(page, 'https://example.com', {
+	name: 'desktop',
+	width: 1200,
+	resolution: 1,
+	listeners: {
+		setViewport() {},
+		hook() {},
+		load() {},
+		scroll() {},
+	},
+	hooks: [
+		async (page) => {
+			await page.type('#username', 'user');
+			await page.type('#password', 'password');
+			await page.click('button[type="submit"]');
+		},
+	],
+});
+```

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

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

package/dist/before-page-scan.js

@@ -0,0 +1,33 @@
+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);
+}

package/dist/default-sizes.d.ts

@@ -0,0 +1,12 @@
+export declare const defaultSizes: {
+    readonly desktop: {
+        readonly width: 1400;
+    };
+    readonly tablet: {
+        readonly width: 768;
+    };
+    readonly mobile: {
+        readonly width: 375;
+        readonly resolution: 2;
+    };
+};

package/dist/default-sizes.js

@@ -0,0 +1,5 @@
+export const defaultSizes = {
+    desktop: { width: 1400 },
+    tablet: { width: 768 },
+    mobile: { width: 375, resolution: 2 },
+};

package/dist/index.d.ts

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

package/dist/index.js

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

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

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

package/dist/read-page-hooks.js

@@ -0,0 +1,19 @@
+import path from 'node:path';
+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);
+        const { default: mod } = await import(hookAbsPath).catch((error) => {
+            if (error instanceof Error &&
+                'code' in error &&
+                error.code === 'ERR_MODULE_NOT_FOUND') {
+                throw new Error(`Hook: ${hook} not found`, { cause: error });
+            }
+            throw error;
+        });
+        if (typeof mod !== 'function') {
+            throw new TypeError(`Hook ${hook} is not a function`);
+        }
+        return mod;
+    }));
+    return pageHooks;
+}

package/dist/types.d.ts

@@ -0,0 +1,29 @@
+import type { Page } from 'puppeteer';
+export type Listener<P> = (phase: keyof P, data: P[keyof P]) => void;
+export type Sizes = Record<string, Size>;
+export type Size = {
+    width: number;
+    resolution?: number;
+};
+export type PageHook = (page: Page, size: Size & {
+    name: string;
+    log: (message: string) => void;
+}) => Promise<void>;
+export type Phase = {
+    setViewport: {
+        name: string;
+        width: number;
+        resolution?: number;
+    };
+    hook: {
+        name: string;
+        message: string;
+    };
+    load: {
+        name: string;
+        type: 'open' | 'reaload';
+    };
+    scroll: {
+        name: string;
+    };
+};

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,32 @@
+{
+	"name": "@d-zero/puppeteer-page-scan",
+	"version": "1.0.0",
+	"description": "Scanning page function for puppeteer",
+	"author": "D-ZERO",
+	"license": "MIT",
+	"private": false,
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"types": "./dist/index.d.ts"
+		}
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsc",
+		"clean": "tsc --build --clean"
+	},
+	"dependencies": {
+		"@d-zero/puppeteer-scroll": "1.0.5"
+	},
+	"devDependencies": {
+		"puppeteer": "23.5.0"
+	},
+	"gitHead": "e8f65086bf7c316dda6667f1173da8585a5ef19c"
+}