@d-zero/archaeologist 1.1.2 → 2.0.0

package/dist/analyze-child-process.d.ts

@@ -0,0 +1,9 @@
+import type { URLPair } from './types.js';
+import type { PageHook } from '@d-zero/puppeteer-page-scan';
+export type ChildProcessParams = {
+    list: readonly URLPair[];
+    dir: string;
+    useOldMode: boolean;
+    htmlDiffOnly: boolean;
+    hooks?: readonly PageHook[];
+};

package/dist/{analyze.js → analyze-child-process.js}

@@ -1,22 +1,16 @@
-import { writeFile, mkdir } from 'node:fs/promises';
+import { writeFile } from 'node:fs/promises';
 import path from 'node:path';
-import { deal } from '@d-zero/puppeteer-dealer';
+import { createChildProcess } from '@d-zero/puppeteer-dealer';
+import { delay } from '@d-zero/shared/delay';
 import c from 'ansi-colors';
-import { analyzeUrlList } from './analize-url.js';
-import { diffImages } from './diff-images.js';
-import { diffTree } from './diff-tree.js';
-import { getData } from './get-data.js';
-import { score } from './output-utils.js';
-export async function analyze(list, options) {
-    const results = [];
-    const dir = path.resolve(process.cwd(), '.archaeologist');
-    await mkdir(dir, { recursive: true }).catch(() => { });
-    const urlInfo = analyzeUrlList(list);
-    const useOldMode = urlInfo.hasAuth || urlInfo.hasNoSSL;
-    await deal(list.map(([urlA]) => ({ id: null, url: urlA })), (_, done, total) => {
-        return `${c.bold.magenta('🕵️  Archaeologist')} ${done}/${total}`;
-    }, {
-        async deal(page, _, urlA, logger, index) {
+import { diffImages } from './modules/diff-images.js';
+import { diffTree } from './modules/diff-tree.js';
+import { getData } from './modules/get-data.js';
+import { score } from './utils.js';
+createChildProcess((param) => {
+    const { list, dir, htmlDiffOnly } = param;
+    return {
+        async eachPage({ page, url: urlA, index }, logger) {
             const urlPair = list.find(([url]) => url === urlA);
             if (!urlPair) {
                 throw new Error(`Failed to find urlPair: ${urlA}`);
@@ -24,7 +18,7 @@ export async function analyze(list, options) {
             const dataPair = [];
             for (const url of urlPair) {
                 const data = await getData(page, url, {
-                    ...options,
+                    htmlDiffOnly,
                 }, logger);
                 dataPair.push(data);
                 await delay(600);
@@ -89,14 +83,7 @@ export async function analyze(list, options) {
                 target: [a.url, b.url],
                 screenshots: screenshotResult,
             };
-            results.push(result);
+            return result;
         },
-    }, {
-        ...options,
-        headless: useOldMode ? 'shell' : true,
-    });
-    return results;
-}
-function delay(ms) {
-    return new Promise((resolve) => setTimeout(resolve, ms));
-}
+    };
+});

package/dist/analyze-main-process.d.ts

@@ -0,0 +1,7 @@
+import type { AnalyzeOptions, URLPair } from './types.js';
+/**
+ *
+ * @param list
+ * @param options
+ */
+export declare function analyze(list: readonly URLPair[], options?: AnalyzeOptions): Promise<void>;

package/dist/analyze-main-process.js

@@ -0,0 +1,46 @@
+import { mkdir } from 'node:fs/promises';
+import path from 'node:path';
+import { createProcess, deal } from '@d-zero/puppeteer-dealer';
+import c from 'ansi-colors';
+import { analyzeUrlList } from './modules/analize-url.js';
+import { score } from './utils.js';
+/**
+ *
+ * @param list
+ * @param options
+ */
+export async function analyze(list, options) {
+    const results = [];
+    const dir = path.resolve(process.cwd(), '.archaeologist');
+    await mkdir(dir, { recursive: true }).catch(() => { });
+    const urlInfo = analyzeUrlList(list);
+    const useOldMode = urlInfo.hasAuth || urlInfo.hasNoSSL;
+    await deal(list.map(([urlA]) => ({ id: null, url: urlA })), (_, done, total) => {
+        return `${c.bold.magenta('🕵️  Archaeologist')} ${done}/${total}`;
+    }, () => {
+        return createProcess(path.resolve(import.meta.dirname, 'analyze-child-process.js'), {
+            list,
+            dir,
+            useOldMode,
+            htmlDiffOnly: options?.htmlDiffOnly ?? false,
+            hooks: options?.hooks ?? [],
+        }, {
+            ...options,
+            headless: useOldMode ? 'shell' : true,
+        });
+    }, (result) => {
+        results.push(result);
+    });
+    const output = [];
+    for (const result of results) {
+        output.push(c.gray(`${result.target.join(' vs ')}`));
+        for (const [sizeName, { image, dom }] of Object.entries(result.screenshots)) {
+            if (image) {
+                const { matches, file } = image;
+                output.push(`  ${c.bgMagenta(` ${sizeName} `)} ${score(matches, 0.9)} ${file}`);
+            }
+            output.push(`  ${c.bgBlueBright(' HTML ')}: ${score(dom.matches, 0.995)} ${dom.file}`);
+        }
+    }
+    process.stdout.write(output.join('\n') + '\n');
+}

package/dist/cli.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 import minimist from 'minimist';
-import { archaeologist } from './archaeologist.js';
+import { analyze } from './analyze-main-process.js';
+import { freeze } from './freeze-main-process.js';
 import { readConfig } from './read-config.js';
 const cli = minimist(process.argv.slice(2), {
     alias: {
@@ -9,7 +10,7 @@ const cli = minimist(process.argv.slice(2), {
 });
 if (cli.listfile?.length) {
     const { pairList, hooks } = await readConfig(cli.listfile);
-    await archaeologist(pairList, {
+    await analyze(pairList, {
         hooks,
         limit: cli.limit ? Number.parseInt(cli.limit) : undefined,
         debug: !!cli.debug,
@@ -17,5 +18,15 @@ if (cli.listfile?.length) {
     });
     process.exit(0);
 }
+if (cli.freeze) {
+    const { pairList, hooks } = await readConfig(cli.freeze);
+    const list = pairList.map(([urlA]) => urlA);
+    await freeze(list, {
+        hooks,
+        limit: cli.limit ? Number.parseInt(cli.limit) : undefined,
+        debug: !!cli.debug,
+    });
+    process.exit(0);
+}
 process.stderr.write('Usage: archaeologist -f <listfile> [--limit <number>]\n');
 process.exit(1);

package/dist/freeze-child-process.d.ts

@@ -0,0 +1,3 @@
+export type ChildProcessParams = {
+    dir: string;
+};

package/dist/freeze-child-process.js

@@ -0,0 +1,22 @@
+import { writeFile } from 'node:fs/promises';
+import path from 'node:path';
+import { createChildProcess } from '@d-zero/puppeteer-dealer';
+import { delay } from '@d-zero/shared/delay';
+import { getData } from './modules/get-data.js';
+createChildProcess((param) => {
+    const { dir } = param;
+    return {
+        async eachPage({ page, id, url }, logger) {
+            const data = await getData(page, url, {}, logger);
+            await delay(600);
+            for (const size of Object.values(data.screenshots)) {
+                const jsonFile = path.resolve(dir, `${id}_${size.id}.html`);
+                const ssFile = path.resolve(dir, `${id}_${size.id}.png`);
+                await writeFile(jsonFile, size.dom, 'utf8');
+                if (size.binary) {
+                    await writeFile(ssFile, size.binary);
+                }
+            }
+        },
+    };
+});

package/dist/freeze-main-process.d.ts

@@ -0,0 +1,7 @@
+import type { FreezeOptions } from './types.js';
+/**
+ *
+ * @param list
+ * @param options
+ */
+export declare function freeze(list: readonly string[], options?: FreezeOptions): Promise<string>;

package/dist/freeze-main-process.js

@@ -0,0 +1,34 @@
+import { mkdir, writeFile } from 'node:fs/promises';
+import path from 'node:path';
+import { zip } from '@d-zero/fs/zip';
+import { createProcess, deal } from '@d-zero/puppeteer-dealer';
+import { timestamp } from '@d-zero/shared/timestamp';
+import c from 'ansi-colors';
+import { analyzeUrlList } from './modules/analize-url.js';
+/**
+ *
+ * @param list
+ * @param options
+ */
+export async function freeze(list, options) {
+    const name = `${timestamp('YYYYMMDD')}.archae`;
+    const dir = path.resolve(process.cwd(), `.${name}`);
+    await mkdir(dir, { recursive: true }).catch(() => { });
+    const urlInfo = analyzeUrlList(list);
+    const useOldMode = urlInfo.hasAuth || urlInfo.hasNoSSL;
+    await deal(list.map((url) => ({ id: null, url })), (_, done, total) => {
+        return `${c.bold.magenta('🕵️  Archaeologist Freeze❄️')} ${done}/${total}`;
+    }, () => {
+        return createProcess(path.resolve(import.meta.dirname, 'freeze-child-process.js'), {
+            dir,
+        }, {
+            ...options,
+            headless: useOldMode ? 'shell' : true,
+        });
+    });
+    const urlListPath = path.resolve(dir, '_URL_LIST.json');
+    await writeFile(urlListPath, JSON.stringify(list, null, '\t'), 'utf8');
+    const zipPath = path.resolve(process.cwd(), `${name}.zip`);
+    await zip(zipPath, dir);
+    return zipPath;
+}

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { archaeologist } from './archaeologist.js';
+export { analyze as archaeologist } from './analyze-main-process.js';
 export * from './types.js';

package/dist/index.js

@@ -1,2 +1,2 @@
-export { archaeologist } from './archaeologist.js';
+export { analyze as archaeologist } from './analyze-main-process.js';
 export * from './types.js';

package/dist/modules/analize-url.d.ts

@@ -0,0 +1,11 @@
+import type { URLPair } from '../types.js';
+type AnalyzedUrlList = {
+    hasAuth: boolean;
+    hasNoSSL: boolean;
+};
+/**
+ *
+ * @param list
+ */
+export declare function analyzeUrlList(list: readonly (URLPair | string)[]): AnalyzedUrlList;
+export {};

package/dist/{analize-url.js → modules/analize-url.js}

@@ -1,9 +1,23 @@
+/**
+ *
+ * @param list
+ */
 export function analyzeUrlList(list) {
     const result = {
         hasAuth: false,
         hasNoSSL: false,
     };
     for (const urlPair of list) {
+        if (typeof urlPair === 'string') {
+            const urlObj = new URL(urlPair);
+            if (urlObj.username || urlObj.password) {
+                result.hasAuth = true;
+            }
+            if (urlObj.protocol === 'http:') {
+                result.hasNoSSL = true;
+            }
+            continue;
+        }
         for (const url of urlPair) {
             const urlObj = new URL(url);
             if (urlObj.username || urlObj.password) {

package/dist/{diff-images.d.ts → modules/diff-images.d.ts}

@@ -16,12 +16,18 @@ export type DiffImagesPhase = {
     };
 };
 type DiffImagesListener = (phase: keyof DiffImagesPhase, data: DiffImagesPhase[keyof DiffImagesPhase]) => void;
+/**
+ *
+ * @param dataA
+ * @param dataB
+ * @param listener
+ */
 export declare function diffImages(dataA: Screenshot, dataB: Screenshot, listener: DiffImagesListener): Promise<{
     matches: number;
     images: {
-        a: Buffer;
-        b: Buffer;
-        diff: Buffer;
+        a: Buffer<ArrayBufferLike>;
+        b: Buffer<ArrayBufferLike>;
+        diff: Buffer<ArrayBufferLike>;
     };
 } | null>;
 export {};

package/dist/{diff-images.js → modules/diff-images.js}

@@ -1,6 +1,12 @@
 import { Jimp, HorizontalAlign, VerticalAlign, JimpMime } from 'jimp';
 import pixelmatch from 'pixelmatch';
 import { PNG } from 'pngjs';
+/**
+ *
+ * @param dataA
+ * @param dataB
+ * @param listener
+ */
 export async function diffImages(dataA, dataB, listener) {
     if (!dataA.binary || !dataB.binary) {
         return null;
@@ -31,6 +37,12 @@ export async function diffImages(dataA, dataB, listener) {
         },
     };
 }
+/**
+ *
+ * @param bin
+ * @param width
+ * @param height
+ */
 async function resizeImg(bin, width, height) {
     const img = await Jimp.read(bin);
     img.contain({

package/dist/{diff-tree.d.ts → modules/diff-tree.d.ts}

@@ -1,3 +1,10 @@
+/**
+ *
+ * @param urlA
+ * @param urlB
+ * @param dataA
+ * @param dataB
+ */
 export declare function diffTree(urlA: string, urlB: string, dataA: string, dataB: string): {
     changed: boolean;
     maxLine: number;

package/dist/{diff-tree.js → modules/diff-tree.js}

@@ -1,5 +1,12 @@
 import { createTwoFilesPatch } from 'diff';
 import parse from 'parse-diff';
+/**
+ *
+ * @param urlA
+ * @param urlB
+ * @param dataA
+ * @param dataB
+ */
 export function diffTree(urlA, urlB, dataA, dataB) {
     const result = createTwoFilesPatch(urlA, urlB, dataA, dataB);
     const info = parse(result)[0];

package/dist/{get-data.d.ts → modules/get-data.d.ts}

@@ -1,8 +1,15 @@
-import type { PageData } from './types.js';
-import type { Page } from '@d-zero/puppeteer-page';
+import type { PageData } from '../types.js';
 import type { PageHook } from '@d-zero/puppeteer-screenshot';
+import type { Page } from 'puppeteer';
 export interface GetDataOptions {
     readonly hooks?: readonly PageHook[];
     readonly htmlDiffOnly?: boolean;
 }
+/**
+ *
+ * @param page
+ * @param url
+ * @param options
+ * @param update
+ */
 export declare function getData(page: Page, url: string, options: GetDataOptions, update: (log: string) => void): Promise<PageData>;

package/dist/{get-data.js → modules/get-data.js}

@@ -1,5 +1,12 @@
 import { distill } from '@d-zero/html-distiller';
 import { screenshotListener, screenshot } from '@d-zero/puppeteer-screenshot';
+/**
+ *
+ * @param page
+ * @param url
+ * @param options
+ * @param update
+ */
 export async function getData(page, url, options, update) {
     const htmlDiffOnly = options.htmlDiffOnly ?? false;
     const screenshots = await screenshot(page, url, {

package/dist/read-config.d.ts

@@ -1,3 +1,7 @@
+/**
+ *
+ * @param filePath
+ */
 export declare function readConfig(filePath: string): Promise<{
     pairList: [string, string][];
     hooks: import("@d-zero/puppeteer-page-scan").PageHook[];

package/dist/read-config.js

@@ -3,6 +3,10 @@ import path from 'node:path';
 import { readPageHooks } from '@d-zero/puppeteer-page-scan';
 import { toList } from '@d-zero/readtext/list';
 import fm from 'front-matter';
+/**
+ *
+ * @param filePath
+ */
 export async function readConfig(filePath) {
     const fileContent = await fs.readFile(filePath, 'utf8');
     const content = 

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 export type { PageHook } from '@d-zero/puppeteer-screenshot';
-import type { Screenshot } from '@d-zero/puppeteer-screenshot';
+import type { PageHook, Screenshot } from '@d-zero/puppeteer-screenshot';
 export type PageData = {
     url: string;
     screenshots: Record<string, Screenshot & {
@@ -24,3 +24,15 @@ export type DOMResult = {
     diff: string | null;
     file: string;
 };
+export interface ArchaeologistOptions extends AnalyzeOptions {
+}
+export interface AnalyzeOptions extends GeneralOptions {
+    readonly htmlDiffOnly?: boolean;
+}
+export interface FreezeOptions extends GeneralOptions {
+}
+interface GeneralOptions {
+    readonly hooks: readonly PageHook[];
+    readonly limit?: number;
+    readonly debug?: boolean;
+}

package/dist/utils.d.ts

@@ -1 +1,6 @@
+/**
+ *
+ * @param matches
+ * @param threshold
+ */
 export declare function score(matches: number, threshold: number): string;

package/dist/utils.js

@@ -1,4 +1,9 @@
 import c from 'ansi-colors';
+/**
+ *
+ * @param matches
+ * @param threshold
+ */
 export function score(matches, threshold) {
     const color = matches > threshold ? c.green : c.red;
     const num = (matches * 100).toFixed(1);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/archaeologist",
-	"version": "1.1.2",
+	"version": "2.0.0",
 	"description": "Uncover visual and HTML differences in web pages with precision",
 	"author": "D-ZERO",
 	"license": "MIT",
@@ -27,25 +27,27 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/html-distiller": "1.0.1",
-		"@d-zero/puppeteer-dealer": "0.2.0",
-		"@d-zero/puppeteer-page-scan": "2.0.0",
-		"@d-zero/puppeteer-screenshot": "2.0.0",
-		"@d-zero/readtext": "1.1.1",
+		"@d-zero/fs": "0.2.0",
+		"@d-zero/html-distiller": "1.0.3",
+		"@d-zero/puppeteer-dealer": "0.4.0",
+		"@d-zero/puppeteer-page-scan": "4.0.0",
+		"@d-zero/puppeteer-screenshot": "3.0.1",
+		"@d-zero/readtext": "1.1.3",
+		"@d-zero/shared": "0.8.0",
 		"ansi-colors": "4.1.3",
-		"diff": "7.0.0",
+		"diff": "8.0.1",
 		"front-matter": "4.0.2",
 		"jimp": "1.6.0",
 		"minimist": "1.2.8",
 		"parse-diff": "0.11.1",
-		"pixelmatch": "6.0.0",
-		"pngjs": "7.0.0"
+		"pixelmatch": "7.1.0",
+		"pngjs": "7.0.0",
+		"puppeteer": "24.9.0"
 	},
 	"devDependencies": {
-		"@d-zero/puppeteer-page": "0.2.0",
-		"@types/diff": "6.0.0",
+		"@types/diff": "8.0.0",
 		"@types/pixelmatch": "5.2.6",
 		"@types/pngjs": "6.0.5"
 	},
-	"gitHead": "1eb1c03400580040119121e11ffb33acd876fe1b"
+	"gitHead": "4e9cc7b87e0fef91b6f2d4edfb66ca9134b2491b"
 }

package/dist/analize-url.d.ts

@@ -1,7 +0,0 @@
-import type { URLPair } from './types.js';
-type AnalyzedUrlList = {
-    hasAuth: boolean;
-    hasNoSSL: boolean;
-};
-export declare function analyzeUrlList(list: readonly URLPair[]): AnalyzedUrlList;
-export {};

package/dist/analyze.d.ts

@@ -1,9 +0,0 @@
-import type { Result, URLPair } from './types.js';
-import type { PageHook } from '@d-zero/puppeteer-screenshot';
-export interface AnalyzeOptions {
-    readonly hooks: readonly PageHook[];
-    readonly htmlDiffOnly?: boolean;
-    readonly limit?: number;
-    readonly debug?: boolean;
-}
-export declare function analyze(list: readonly URLPair[], options?: AnalyzeOptions): Promise<Result[]>;

package/dist/archaeologist.d.ts

@@ -1,5 +0,0 @@
-import type { AnalyzeOptions } from './analyze.js';
-import type { URLPair } from './types.js';
-export interface ArchaeologistOptions extends AnalyzeOptions {
-}
-export declare function archaeologist(list: readonly URLPair[], options?: ArchaeologistOptions): Promise<void>;

package/dist/archaeologist.js

@@ -1,18 +0,0 @@
-import c from 'ansi-colors';
-import { analyze } from './analyze.js';
-import { score } from './output-utils.js';
-export async function archaeologist(list, options) {
-    const results = await analyze(list, options);
-    const output = [];
-    for (const result of results) {
-        output.push(c.gray(`${result.target.join(' vs ')}`));
-        for (const [sizeName, { image, dom }] of Object.entries(result.screenshots)) {
-            if (image) {
-                const { matches, file } = image;
-                output.push(`  ${c.bgMagenta(` ${sizeName} `)} ${score(matches, 0.9)} ${file}`);
-            }
-            output.push(`  ${c.bgBlueBright(' HTML ')}: ${score(dom.matches, 0.995)} ${dom.file}`);
-        }
-    }
-    process.stdout.write(output.join('\n') + '\n');
-}

package/dist/diff-tree-color.d.ts

@@ -1 +0,0 @@
-export declare function diffTreeColor(diff: string): string;

package/dist/diff-tree-color.js

@@ -1,15 +0,0 @@
-import c from 'ansi-colors';
-export function diffTreeColor(diff) {
-    return diff
-        .split('\n')
-        .map((line) => {
-        if (line.startsWith('+')) {
-            return c.green(line);
-        }
-        if (line.startsWith('-')) {
-            return c.red(line);
-        }
-        return c.gray(line);
-    })
-        .join('\n');
-}

package/dist/output-utils.d.ts

@@ -1 +0,0 @@
-export declare function score(matches: number, threshold: number): string;

package/dist/output-utils.js

@@ -1,6 +0,0 @@
-import c from 'ansi-colors';
-export function score(matches, threshold) {
-    const color = matches > threshold ? c.green : c.red;
-    const num = (matches * 100).toFixed(1);
-    return c.bold(color(`${num}%`));
-}

package/dist/read-hooks.d.ts

@@ -1,2 +0,0 @@
-import type { PageHook } from '@d-zero/puppeteer-screenshot';
-export declare function readHooks(hooks: readonly string[], listfile: string): Promise<PageHook[]>;

package/dist/read-hooks.js

@@ -1,20 +0,0 @@
-import path from 'node:path';
-export async function readHooks(hooks, listfile) {
-    const listfileDir = path.dirname(listfile);
-    const pageHooks = await Promise.all(hooks.map(async (hook) => {
-        const hookAbsPath = path.isAbsolute(hook) ? hook : path.resolve(listfileDir, 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;
-}