@d-zero/puppeteer-page-scan 4.3.5 → 4.4.1

package/README.md

@@ -38,6 +38,14 @@ const sizes = createSizesFromDevices(['desktop', 'mobile']);
 
 // CLI用のパーサー（コンマ区切りの文字列から）
 const parsedSizes = parseDevicesOption(['desktop', 'tablet']);
+
+// デフォルトサイズ定数（desktop、tablet、mobileの3種類）
+console.log(defaultSizes);
+// {
+//   desktop: { width: 1400 },
+//   tablet: { width: 768 },
+//   mobile: { width: 375, resolution: 2 }
+// }
 ```
 
 ### `beforePageScan`
@@ -46,6 +54,11 @@ const parsedSizes = parseDevicesOption(['desktop', 'tablet']);
 - ページのリロード
 - 任意のフック処理
   - ログインなどの事前処理
+- disclosure要素の展開（オプション）
+  - すべての`<details>`要素を開き、すべての`button[aria-expanded="false"]`要素をクリック
+  - 新しい要素が見つからなくなるまで繰り返し処理（最大1000回）
+  - 各イテレーション後に500ms待機
+  - 最大イテレーション数に達した場合はErrorを投げる
 - ページ全体をスクロール
 
 などを行い、スキャンに必要な状態を整えるためのヘルパー関数です。
@@ -73,5 +86,129 @@ await beforePageScan(page, 'https://example.com', {
 			await page.click('button[type="submit"]');
 		},
 	],
+	openDisclosures: true, // オプション: disclosure要素を展開（<details>とbutton[aria-expanded="false"]）
+});
+```
+
+### `readPageHooks`
+
+ファイルパスの配列からPageHookモジュールを読み込むヘルパー関数です。各パスはESモジュールとしてインポートされ、デフォルトエクスポートを`PageHook`関数として返します。
+
+```ts
+import { readPageHooks } from '@d-zero/puppeteer-page-scan';
+
+// hookファイルのパスからPageHook関数の配列を取得
+const hooks = await readPageHooks(
+	['./hooks/login.js', '/absolute/path/to/hook.js'],
+	process.cwd(), // 相対パスの基準ディレクトリ
+);
+
+// beforePageScanで使用
+await beforePageScan(page, 'https://example.com', {
+	name: 'desktop',
+	width: 1200,
+	hooks,
+});
+```
+
+**パラメータ:**
+
+- `hooks`: 読み込むhookファイルのパスの配列（絶対パスまたは相対パス）
+- `baseDir`: 相対パスを解決するための基準ディレクトリ
+
+**戻り値:**
+
+- `Promise<PageHook[]>`: PageHook関数の配列
+
+**エラー:**
+
+- モジュールが見つからない場合は`Error`を投げます
+- デフォルトエクスポートが関数でない場合は`TypeError`を投げます
+
+### `pageScanListener` と `pageScanLoggers`
+
+ページスキャン処理中の各フェーズ（ビューポート設定、ページ読み込み、フック実行、スクロール）のログを出力するためのリスナー関数とロガー設定です。
+
+```ts
+import { pageScanListener, pageScanLoggers } from '@d-zero/puppeteer-page-scan';
+
+// リスナーを使用（@d-zero/puppeteer-general-actionsのcreateListenerで作成済み）
+const listeners = pageScanListener((message) => {
+	console.log(message);
 });
+
+await beforePageScan(page, 'https://example.com', {
+	name: 'desktop',
+	width: 1200,
+	listeners,
+});
+
+// カスタムロガーを作成する場合
+import { createListener } from '@d-zero/puppeteer-general-actions';
+
+const customListeners = createListener((log) => {
+	const loggers = pageScanLoggers(log);
+	return {
+		...loggers,
+		// 特定のフェーズをカスタマイズ
+		setViewport({ width }) {
+			log(`カスタム: ビューポート幅を${width}pxに変更`);
+		},
+	};
+});
+```
+
+**ログ出力内容:**
+
+- `setViewport`: ビューポートサイズ変更のログ
+- `load`: ページ読み込み（初回/リロード）とタイムアウト情報
+- `hook`: フック実行時のメッセージ
+- `scroll`: スクロール位置と進捗状況（パーセンテージ）
+
+## 型のエクスポート
+
+### `Sizes`
+
+デバイスサイズのマップ型です。キーはデバイス名、値は`Size`オブジェクトです。
+
+```typescript
+type Sizes = Record<string, Size>;
+```
+
+### `Size`
+
+単一デバイスのサイズ設定です。
+
+```typescript
+type Size = {
+	width: number; // ビューポート幅（ピクセル）
+	resolution?: number; // デバイスピクセル比（省略時は1）
+};
+```
+
+### `PageHook`
+
+ページスキャン前に実行されるフック関数の型です。
+
+```typescript
+type PageHook = (
+	page: Page,
+	size: Size & {
+		name: string; // デバイス名
+		log: (message: string) => void; // ログ出力関数
+	},
+) => Promise<void>;
+```
+
+### `PageScanPhase`
+
+ページスキャン処理の各フェーズを表す型です。リスナーのコールバックで使用されます。
+
+```typescript
+type PageScanPhase = {
+	setViewport: { name: string; width: number; resolution?: number };
+	hook: { name: string; message: string };
+	load: { name: string; type: 'open' | 'reload'; timeout: number; id: string };
+	scroll: { name: string; scrollY: number; scrollHeight: number; message: string };
+};
 ```

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

@@ -6,6 +6,7 @@ type Options = {
     hooks?: readonly PageHook[];
     listener?: Listener<PageScanPhase>;
     timeout?: number;
+    openDisclosures?: boolean;
 } & Size;
 /**
  *

package/dist/before-page-scan.js

@@ -1,4 +1,54 @@
 import { scrollAllOver } from '@d-zero/puppeteer-scroll';
+/**
+ * Open all disclosure elements on the page
+ * This function loops until all disclosure elements are expanded,
+ * including nested elements and dynamically-created buttons.
+ * @param page
+ * @returns The total number of elements opened (details + buttons)
+ * @throws {Error} if the maximum iterations (1000) is reached
+ */
+async function openAllDisclosures(page) {
+    const maxIterations = 1000; // Maximum iterations to prevent infinite loops
+    let totalDetails = 0;
+    let totalButtons = 0;
+    let iteration = 0;
+    while (iteration < maxIterations) {
+        const result = await page.evaluate(() => {
+            // Open all <details> elements
+            const detailsElements = document.querySelectorAll('details:not([open])');
+            for (const details of detailsElements) {
+                details.open = true;
+            }
+            // Click all collapsed buttons
+            const collapsedButtons = document.querySelectorAll('button[aria-expanded="false"]');
+            for (const button of collapsedButtons) {
+                button.click();
+            }
+            return {
+                details: detailsElements.length,
+                buttons: collapsedButtons.length,
+            };
+        });
+        totalDetails += result.details;
+        totalButtons += result.buttons;
+        // If no elements were opened in this iteration, we're done
+        if (result.details === 0 && result.buttons === 0) {
+            break;
+        }
+        // Wait for animations and content rendering before next iteration
+        await new Promise((resolve) => setTimeout(resolve, 500));
+        iteration++;
+    }
+    // If we reached the max iterations, throw an error
+    if (iteration === maxIterations) {
+        throw new Error(`openAllDisclosures: Reached maximum iterations (${maxIterations}). ` +
+            `This may indicate an infinite loop caused by dynamically generated disclosure elements.`);
+    }
+    return {
+        details: totalDetails,
+        buttons: totalButtons,
+    };
+}
 /**
  *
  * @param page
@@ -21,7 +71,7 @@ export async function beforePageScan(page, url, options) {
         deviceScaleFactor: resolution ?? 1,
     });
     if (page.url() === url) {
-        listener?.('load', { name, type: 'reaload', timeout, id: countDownId });
+        listener?.('load', { name, type: 'reload', timeout, id: countDownId });
         await navigateWithFallback(page, url, timeout, true, listener, name);
     }
     else {
@@ -36,6 +86,14 @@ export async function beforePageScan(page, url, options) {
             log: (message) => listener?.('hook', { name, message }),
         });
     }
+    if (options?.openDisclosures) {
+        listener?.('hook', { name, message: 'Opening all disclosures...' });
+        const result = await openAllDisclosures(page);
+        listener?.('hook', {
+            name,
+            message: `Opened ${result.details} <details> elements and clicked ${result.buttons} [aria-expanded="false"] buttons`,
+        });
+    }
     listener?.('scroll', {
         name,
         scrollY: 0,

package/dist/types.d.ts

@@ -20,7 +20,7 @@ export type PageScanPhase = {
     };
     load: {
         name: string;
-        type: 'open' | 'reaload';
+        type: 'open' | 'reload';
         timeout: number;
         id: string;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/puppeteer-page-scan",
-	"version": "4.3.5",
+	"version": "4.4.1",
 	"description": "Scanning page function for puppeteer",
 	"author": "D-ZERO",
 	"license": "MIT",
@@ -23,14 +23,14 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/puppeteer-general-actions": "1.2.1",
-		"@d-zero/puppeteer-scroll": "3.1.7"
+		"@d-zero/puppeteer-general-actions": "1.2.2",
+		"@d-zero/puppeteer-scroll": "3.1.9"
 	},
 	"devDependencies": {
-		"puppeteer": "24.34.0"
+		"puppeteer": "24.37.1"
 	},
 	"peerDependencies": {
-		"puppeteer": "24.34.0"
+		"puppeteer": "24.37.1"
 	},
-	"gitHead": "9aa03b3928e271d45865c6e2eff4c89041fe20a2"
+	"gitHead": "008ea25926579b061e36c1f5f4f4fc7e15cb782e"
 }