@d-zero/puppeteer-page-scan 4.0.4 → 4.1.0

package/README.md

@@ -1,6 +1,6 @@
 # `@d-zero/puppeteer-page-scan`
 
-PuppeteerでスクリーンショットやDOMスキャンする際に必要なヘルパー関数を提供します。
+PuppeteerでスクリーンショットやDOMスキャンする際に必要なヘルパー関数とデバイス設定を提供します。
 
 ## インストール
 
@@ -10,6 +10,36 @@ yarn install @d-zero/puppeteer-page-scan
 
 ## 使い方
 
+### デバイスプリセット
+
+複数のデバイスサイズ用のプリセットが利用可能です：
+
+```ts
+import {
+	devicePresets,
+	createSizesFromDevices,
+	parseDevicesOption,
+} from '@d-zero/puppeteer-page-scan';
+
+// 利用可能なデバイスプリセット
+console.log(devicePresets);
+// {
+//   desktop: { width: 1400 },
+//   tablet: { width: 768 },
+//   mobile: { width: 375, resolution: 2 },
+//   'desktop-hd': { width: 1920 },
+//   'desktop-compact': { width: 1280 },
+//   'mobile-large': { width: 414, resolution: 3 },
+//   'mobile-small': { width: 320, resolution: 2 }
+// }
+
+// プリセット名からSizesオブジェクトを生成
+const sizes = createSizesFromDevices(['desktop', 'mobile']);
+
+// CLI用のパーサー（コンマ区切りの文字列から）
+const parsedSizes = parseDevicesOption(['desktop', 'tablet']);
+```
+
 ### `beforePageScan`
 
 - ビューポートの設定

package/dist/default-sizes.d.ts

@@ -1,3 +1,4 @@
+import type { Sizes } from './types.js';
 export declare const defaultSizes: {
     readonly desktop: {
         readonly width: 1400;
@@ -10,3 +11,41 @@ export declare const defaultSizes: {
         readonly resolution: 2;
     };
 };
+export declare const devicePresets: {
+    readonly desktop: {
+        readonly width: 1400;
+    };
+    readonly tablet: {
+        readonly width: 768;
+    };
+    readonly mobile: {
+        readonly width: 375;
+        readonly resolution: 2;
+    };
+    readonly 'desktop-hd': {
+        readonly width: 1920;
+    };
+    readonly 'desktop-compact': {
+        readonly width: 1280;
+    };
+    readonly 'mobile-large': {
+        readonly width: 414;
+        readonly resolution: 3;
+    };
+    readonly 'mobile-small': {
+        readonly width: 320;
+        readonly resolution: 2;
+    };
+};
+/**
+ * Create sizes from device preset names
+ * @param deviceNames Array of device preset names
+ * @returns Sizes object
+ */
+export declare function createSizesFromDevices(deviceNames: string[]): Sizes;
+/**
+ * Parse device names and return device presets
+ * @param deviceNames Array of device names or undefined
+ * @returns Sizes object or undefined
+ */
+export declare function parseDevicesOption(deviceNames?: string[]): Sizes | undefined;

package/dist/default-sizes.js

@@ -3,3 +3,40 @@ export const defaultSizes = {
     tablet: { width: 768 },
     mobile: { width: 375, resolution: 2 },
 };
+export const devicePresets = {
+    desktop: { width: 1400 },
+    tablet: { width: 768 },
+    mobile: { width: 375, resolution: 2 },
+    'desktop-hd': { width: 1920 },
+    'desktop-compact': { width: 1280 },
+    'mobile-large': { width: 414, resolution: 3 },
+    'mobile-small': { width: 320, resolution: 2 },
+};
+/**
+ * Create sizes from device preset names
+ * @param deviceNames Array of device preset names
+ * @returns Sizes object
+ */
+export function createSizesFromDevices(deviceNames) {
+    const sizes = {};
+    for (const name of deviceNames) {
+        if (name in devicePresets) {
+            sizes[name] = devicePresets[name];
+        }
+        else {
+            throw new Error(`Unknown device preset: ${name}. Available presets: ${Object.keys(devicePresets).join(', ')}`);
+        }
+    }
+    return sizes;
+}
+/**
+ * Parse device names and return device presets
+ * @param deviceNames Array of device names or undefined
+ * @returns Sizes object or undefined
+ */
+export function parseDevicesOption(deviceNames) {
+    if (deviceNames && deviceNames.length > 0) {
+        return createSizesFromDevices(deviceNames);
+    }
+    return undefined;
+}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { beforePageScan } from './before-page-scan.js';
-export { defaultSizes } from './default-sizes.js';
+export { defaultSizes, devicePresets, createSizesFromDevices, parseDevicesOption, } 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,5 +1,5 @@
 export { beforePageScan } from './before-page-scan.js';
-export { defaultSizes } from './default-sizes.js';
+export { defaultSizes, devicePresets, createSizesFromDevices, parseDevicesOption, } from './default-sizes.js';
 export { readPageHooks } from './read-page-hooks.js';
 export { pageScanListener, pageScanLoggers } from './page-scan-listener.js';
 export * from './types.js';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/puppeteer-page-scan",
-	"version": "4.0.4",
+	"version": "4.1.0",
 	"description": "Scanning page function for puppeteer",
 	"author": "D-ZERO",
 	"license": "MIT",
@@ -24,13 +24,13 @@
 	},
 	"dependencies": {
 		"@d-zero/puppeteer-general-actions": "1.2.1",
-		"@d-zero/puppeteer-scroll": "3.0.5"
+		"@d-zero/puppeteer-scroll": "3.0.6"
 	},
 	"devDependencies": {
-		"puppeteer": "24.17.1"
+		"puppeteer": "24.18.0"
 	},
 	"peerDependencies": {
-		"puppeteer": "24.17.1"
+		"puppeteer": "24.18.0"
 	},
-	"gitHead": "6fa0fd190c54351762a70039cd8dfcafc51caa0b"
+	"gitHead": "8081edac801400fed7c0b7ebeccc0ce66ccfe131"
 }