@alwaysmeticulous/cli 2.39.0 → 2.40.4

package/dist/commands/screenshot-diff/screenshot-diff.command.js

@@ -1,182 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.screenshotDiffCommand = exports.logDifferences = exports.diffScreenshots = void 0;
-const path_1 = require("path");
-const common_1 = require("@alwaysmeticulous/common");
-const fast_json_stable_stringify_1 = __importDefault(require("fast-json-stable-stringify"));
-const loglevel_1 = __importDefault(require("loglevel"));
-const client_1 = require("../../api/client");
-const command_builder_1 = require("../../command-utils/command-builder");
-const common_options_1 = require("../../command-utils/common-options");
-const diff_utils_1 = require("../../image/diff.utils");
-const io_utils_1 = require("../../image/io.utils");
-const replays_1 = require("../../local-data/replays");
-const screenshot_diffs_1 = require("../../local-data/screenshot-diffs");
-const has_notable_differences_1 = require("./utils/has-notable-differences");
-const diffScreenshots = async ({ headReplayId, baseReplayId, baseScreenshotsDir, headScreenshotsDir, baseReplayScreenshots, headReplayScreenshots, diffOptions, }) => {
-    const { diffThreshold, diffPixelThreshold } = diffOptions;
-    const headReplayScreenshotsByIdentifier = new Map(headReplayScreenshots.map((screenshot) => [
-        (0, fast_json_stable_stringify_1.default)(screenshot.identifier),
-        screenshot,
-    ]));
-    const baseReplayScreenshotsByIdentifier = new Map(baseReplayScreenshots.map((screenshot) => [
-        (0, fast_json_stable_stringify_1.default)(screenshot.identifier),
-        screenshot,
-    ]));
-    const missingHeadImages = new Set(baseReplayScreenshots.filter((file) => !headReplayScreenshotsByIdentifier.has((0, fast_json_stable_stringify_1.default)(file.identifier))));
-    const missingHeadImagesResults = Array.from(missingHeadImages).flatMap(({ identifier, fileName }) => {
-        return [
-            {
-                identifier,
-                outcome: "missing-head",
-                baseScreenshotFile: `screenshots/${fileName}`,
-            },
-        ];
-    });
-    const diffAgainstBase = async (headScreenshot) => {
-        const baseScreenshot = baseReplayScreenshotsByIdentifier.get((0, fast_json_stable_stringify_1.default)(headScreenshot.identifier));
-        if (baseScreenshot == null) {
-            return [
-                {
-                    identifier: headScreenshot.identifier,
-                    outcome: "missing-base",
-                    headScreenshotFile: `screenshots/${headScreenshot.fileName}`,
-                },
-            ];
-        }
-        const baseScreenshotFile = (0, path_1.join)(baseScreenshotsDir, baseScreenshot.fileName);
-        const headScreenshotFile = (0, path_1.join)(headScreenshotsDir, headScreenshot.fileName);
-        const baseScreenshotContents = await (0, io_utils_1.readPng)(baseScreenshotFile);
-        const headScreenshotContents = await (0, io_utils_1.readPng)(headScreenshotFile);
-        if (baseScreenshotContents.width !== headScreenshotContents.width ||
-            baseScreenshotContents.height !== headScreenshotContents.height) {
-            return [
-                {
-                    identifier: headScreenshot.identifier,
-                    outcome: "different-size",
-                    baseScreenshotFile: `screenshots/${baseScreenshot.fileName}`,
-                    headScreenshotFile: `screenshots/${headScreenshot.fileName}`,
-                    baseWidth: baseScreenshotContents.width,
-                    baseHeight: baseScreenshotContents.height,
-                    headWidth: headScreenshotContents.width,
-                    headHeight: headScreenshotContents.height,
-                },
-            ];
-        }
-        const comparisonResult = (0, diff_utils_1.compareImages)({
-            base: baseScreenshotContents,
-            head: headScreenshotContents,
-            pixelThreshold: diffPixelThreshold,
-        });
-        await (0, screenshot_diffs_1.writeScreenshotDiff)({
-            baseReplayId,
-            headReplayId,
-            screenshotFileName: headScreenshot.fileName,
-            diff: comparisonResult.diff,
-        });
-        return [
-            {
-                identifier: headScreenshot.identifier,
-                outcome: comparisonResult.mismatchFraction > diffThreshold
-                    ? "diff"
-                    : "no-diff",
-                baseScreenshotFile: `screenshots/${baseScreenshot.fileName}`,
-                headScreenshotFile: `screenshots/${headScreenshot.fileName}`,
-                width: baseScreenshotContents.width,
-                height: baseScreenshotContents.height,
-                mismatchPixels: comparisonResult.mismatchPixels,
-                mismatchFraction: comparisonResult.mismatchFraction,
-            },
-        ];
-    };
-    const headDiffResults = (await Promise.all(headReplayScreenshots.map(diffAgainstBase))).flat();
-    return [...missingHeadImagesResults, ...headDiffResults];
-};
-exports.diffScreenshots = diffScreenshots;
-const logDifferences = ({ results, diffOptions, logger, }) => {
-    const missingHeadImagesResults = results.flatMap((result) => result.outcome === "missing-head" ? [result] : []);
-    if (missingHeadImagesResults.length) {
-        const message = `Head replay is missing screenshots: ${missingHeadImagesResults
-            .map(({ baseScreenshotFile }) => (0, path_1.basename)(baseScreenshotFile))
-            .sort()} => FAIL!`;
-        logger.info(message);
-    }
-    const missingBaseImagesResults = results.flatMap((result) => result.outcome === "missing-base" ? [result] : []);
-    if (missingHeadImagesResults.length) {
-        const message = `Notice: Base replay is missing screenshots: ${missingBaseImagesResults
-            .map(({ headScreenshotFile }) => (0, path_1.basename)(headScreenshotFile))
-            .sort()}`;
-        logger.info(message);
-    }
-    results.forEach((result) => {
-        const { outcome } = result;
-        if (outcome === "different-size") {
-            const message = `Screenshots ${(0, path_1.basename)(result.headScreenshotFile)} have different sizes => FAIL!`;
-            logger.info(message);
-        }
-        if (outcome === "diff" || outcome === "no-diff") {
-            const mismatch = (result.mismatchFraction * 100).toFixed(3);
-            const threshold = (diffOptions.diffThreshold * 100).toFixed(3);
-            const message = `${mismatch}% pixel mismatch for screenshot ${(0, path_1.basename)(result.headScreenshotFile)} (threshold is ${threshold}%) => ${outcome === "no-diff" ? "PASS" : "FAIL!"}`;
-            logger.info(message);
-        }
-    });
-};
-exports.logDifferences = logDifferences;
-const handler = async ({ apiToken, baseSimulationId: baseReplayId, headSimulationId: headReplayId, threshold, pixelThreshold, }) => {
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    const client = (0, client_1.createClient)({ apiToken });
-    await (0, replays_1.getOrFetchReplay)(client, baseReplayId);
-    await (0, replays_1.getOrFetchReplayArchive)(client, baseReplayId);
-    await (0, replays_1.getOrFetchReplay)(client, headReplayId);
-    await (0, replays_1.getOrFetchReplayArchive)(client, headReplayId);
-    const baseScreenshotsDir = (0, replays_1.getScreenshotsDir)((0, replays_1.getReplayDir)(baseReplayId));
-    const headScreenshotsDir = (0, replays_1.getScreenshotsDir)((0, replays_1.getReplayDir)(headReplayId));
-    const diffOptions = {
-        diffThreshold: threshold,
-        diffPixelThreshold: pixelThreshold,
-    };
-    const baseReplayScreenshots = await (0, replays_1.getScreenshotFiles)(baseScreenshotsDir);
-    const headReplayScreenshots = await (0, replays_1.getScreenshotFiles)(headScreenshotsDir);
-    const results = await (0, exports.diffScreenshots)({
-        baseReplayId,
-        headReplayId,
-        baseScreenshotsDir,
-        headScreenshotsDir,
-        baseReplayScreenshots,
-        headReplayScreenshots,
-        diffOptions,
-    });
-    logger.debug(results);
-    (0, exports.logDifferences)({
-        results,
-        diffOptions,
-        logger,
-    });
-    if ((0, has_notable_differences_1.hasNotableDifferences)(results)) {
-        process.exit(1);
-    }
-};
-exports.screenshotDiffCommand = (0, command_builder_1.buildCommand)("screenshot-diff")
-    .details({ describe: "Diff two replay screenshots" })
-    .options({
-    apiToken: {
-        string: true,
-    },
-    baseSimulationId: {
-        string: true,
-        demandOption: true,
-        alias: "baseReplayId",
-    },
-    headSimulationId: {
-        string: true,
-        demandOption: true,
-        alias: "headReplayId",
-    },
-    threshold: common_options_1.SCREENSHOT_DIFF_OPTIONS.diffThreshold,
-    pixelThreshold: common_options_1.SCREENSHOT_DIFF_OPTIONS.diffPixelThreshold,
-})
-    .handler(handler);

package/dist/commands/screenshot-diff/utils/get-screenshot-filename.d.ts

@@ -1,2 +0,0 @@
-import { ScreenshotIdentifier } from "@alwaysmeticulous/api";
-export declare const getScreenshotFilename: (identifier: ScreenshotIdentifier) => string;

package/dist/commands/screenshot-diff/utils/get-screenshot-filename.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getScreenshotFilename = void 0;
-// Note: ideally this should match the filenames produced by the screenshotting code
-// in replay-node, and in https://github.com/alwaysmeticulous/meticulous-sdk/blob/395af4394dc51d9b51ba1136fc26b23fcbba5604/packages/replayer/src/screenshot.utils.ts#L42
-const getScreenshotFilename = (identifier) => {
-    if (identifier.type === "end-state") {
-        return "final-state.png";
-    }
-    else if (identifier.type === "after-event") {
-        const eventIndexStr = identifier.eventNumber.toString().padStart(5, "0");
-        return `screenshot-after-event-${eventIndexStr}.png`;
-    }
-    else {
-        throw new Error("Unexpected screenshot identifier: " + JSON.stringify(identifier));
-    }
-};
-exports.getScreenshotFilename = getScreenshotFilename;

package/dist/commands/screenshot-diff/utils/get-screenshot-identifier.d.ts

@@ -1,2 +0,0 @@
-import { ScreenshotIdentifier } from "@alwaysmeticulous/api";
-export declare const getScreenshotIdentifier: (filename: string) => ScreenshotIdentifier | undefined;

package/dist/commands/screenshot-diff/utils/get-screenshot-identifier.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getScreenshotIdentifier = void 0;
-const path_1 = require("path");
-const getScreenshotIdentifier = (filename) => {
-    const name = (0, path_1.basename)(filename);
-    if (name === "final-state.png") {
-        return {
-            type: "end-state",
-        };
-    }
-    if (name.startsWith("screenshot-after-event")) {
-        const match = name.match(/^(?:.*)-(\d+)[.]png$/);
-        const eventNumber = match ? parseInt(match[1], 10) : undefined;
-        if (match && eventNumber != null && !isNaN(eventNumber)) {
-            return {
-                type: "after-event",
-                eventNumber,
-            };
-        }
-    }
-    return undefined;
-};
-exports.getScreenshotIdentifier = getScreenshotIdentifier;

package/dist/commands/screenshot-diff/utils/has-notable-differences.d.ts

@@ -1,2 +0,0 @@
-import { ScreenshotDiffResult } from "@alwaysmeticulous/api";
-export declare const hasNotableDifferences: (screenshotDiffResults: ScreenshotDiffResult[]) => boolean;

package/dist/commands/screenshot-diff/utils/has-notable-differences.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasNotableDifferences = void 0;
-const hasNotableDifferences = (screenshotDiffResults) => {
-    // Note: we ignore flakes & missing-bases here
-    return screenshotDiffResults.some((diff) => diff.outcome === "diff" ||
-        diff.outcome === "missing-head" ||
-        diff.outcome === "different-size");
-};
-exports.hasNotableDifferences = hasNotableDifferences;

package/dist/commands/serve/serve.command.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="yargs" />
-export declare const serveCommand: import("yargs").CommandModule<unknown, import("yargs").InferredOptionTypes<{
-    apiToken: {
-        string: true;
-    };
-    replayId: {
-        string: true;
-        demandOption: true;
-    };
-}>>;

package/dist/commands/serve/serve.command.js

@@ -1,31 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serveCommand = void 0;
-const common_1 = require("@alwaysmeticulous/common");
-const loglevel_1 = __importDefault(require("loglevel"));
-const client_1 = require("../../api/client");
-const command_builder_1 = require("../../command-utils/command-builder");
-const serve_assets_from_simulation_1 = require("../../local-data/serve-assets-from-simulation");
-const handler = async ({ apiToken, replayId, }) => {
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    const client = (0, client_1.createClient)({ apiToken });
-    const { url } = await (0, serve_assets_from_simulation_1.serveAssetsFromSimulation)(client, replayId);
-    logger.info(`Serving assets at url ${url}`);
-};
-exports.serveCommand = (0, command_builder_1.buildCommand)("serve")
-    .details({
-    describe: "Spin up a localhost server to serve the assets that were snapshotted when running a particular replay",
-})
-    .options({
-    apiToken: {
-        string: true,
-    },
-    replayId: {
-        string: true,
-        demandOption: true,
-    },
-})
-    .handler(handler);

package/dist/commands/update-tests/update-tests.command.d.ts

@@ -1,21 +0,0 @@
-/// <reference types="yargs" />
-export declare const updateTestsCommand: import("yargs").CommandModule<unknown, import("yargs").InferredOptionTypes<{
-    apiToken: {
-        string: true;
-    };
-    testRunId: {
-        string: true;
-        demandOption: true;
-        description: string;
-    };
-    accept: {
-        string: true;
-        array: true;
-        description: string;
-    };
-    acceptAll: {
-        boolean: true;
-        description: string;
-        conflicts: string;
-    };
-}>>;

package/dist/commands/update-tests/update-tests.command.js

@@ -1,96 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateTestsCommand = void 0;
-const common_1 = require("@alwaysmeticulous/common");
-const loglevel_1 = __importDefault(require("loglevel"));
-const client_1 = require("../../api/client");
-const test_run_api_1 = require("../../api/test-run.api");
-const command_builder_1 = require("../../command-utils/command-builder");
-const config_1 = require("../../config/config");
-const handler = async ({ apiToken, testRunId, accept: accept_, acceptAll: acceptAll_, }) => {
-    var _a;
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    const client = (0, client_1.createClient)({ apiToken });
-    const config = await (0, config_1.readConfig)();
-    const testCases = config.testCases || [];
-    if (!testCases.length) {
-        logger.error("Error! No test case defined");
-        process.exit(1);
-    }
-    const testRun = await (0, test_run_api_1.getTestRun)({ client, testRunId });
-    if (!testRun) {
-        logger.error("Error: Could not retrieve test run. Is the API token correct?");
-        process.exit(1);
-    }
-    if (testRun.status === "Success") {
-        logger.info("Test run successful, no tests to updates");
-        return;
-    }
-    if (testRun.status === "Running") {
-        logger.error("Error: Tests are still running");
-        process.exit(1);
-    }
-    const testRunResults = ((_a = testRun.resultData) === null || _a === void 0 ? void 0 : _a.results) || [];
-    const accept = accept_ || [];
-    const acceptAll = acceptAll_ || false;
-    if (!acceptAll && !accept.length) {
-        throw new Error("One of --accept or --acceptAll needs to be specified.");
-    }
-    const testRunResultsBySessionId = new Map();
-    testRunResults.forEach((result) => {
-        testRunResultsBySessionId.set(result.sessionId, result);
-    });
-    const newTestCases = testCases.map((testCase) => {
-        const { sessionId } = testCase;
-        const matched = testRunResultsBySessionId.get(sessionId);
-        if (!matched) {
-            logger.warn(`WARNING: ${sessionId} not found in test run`);
-            return testCase;
-        }
-        if (matched.result === "pass" ||
-            (!acceptAll &&
-                !accept.find((replayId) => replayId === matched.headReplayId))) {
-            return testCase;
-        }
-        const headReplayId = matched.headReplayId || "";
-        if (!headReplayId) {
-            logger.warn(`WARNING: ${sessionId} has no new replay id`);
-            return testCase;
-        }
-        const newTestCase = { ...testCase, baseReplayId: headReplayId };
-        return newTestCase;
-    });
-    const newConfig = {
-        ...config,
-        testCases: newTestCases,
-    };
-    await (0, config_1.saveConfig)(newConfig);
-};
-exports.updateTestsCommand = (0, command_builder_1.buildCommand)("update-tests")
-    .details({
-    describe: "Updates test cases",
-})
-    .options({
-    apiToken: {
-        string: true,
-    },
-    testRunId: {
-        string: true,
-        demandOption: true,
-        description: "Test run id to fix",
-    },
-    accept: {
-        string: true,
-        array: true,
-        description: "Replay ids to accept as valid",
-    },
-    acceptAll: {
-        boolean: true,
-        description: "Accept all failing tests as valid",
-        conflicts: "accept",
-    },
-})
-    .handler(handler);

package/dist/config/config.d.ts

@@ -1,3 +0,0 @@
-import { MeticulousCliConfig } from "./config.types";
-export declare const readConfig: (configFilePath?: string) => Promise<MeticulousCliConfig>;
-export declare const saveConfig: (config: MeticulousCliConfig) => Promise<void>;

package/dist/config/config.js

@@ -1,70 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.saveConfig = exports.readConfig = void 0;
-const promises_1 = require("fs/promises");
-const path_1 = require("path");
-const process_1 = require("process");
-const cosmiconfig_1 = require("cosmiconfig");
-const METICULOUS_CONFIG_FILE = "meticulous.json";
-const findConfig = async () => {
-    const explorer = (0, cosmiconfig_1.cosmiconfig)("meticulous", {
-        searchPlaces: [METICULOUS_CONFIG_FILE],
-    });
-    const loaded = await explorer.search((0, process_1.cwd)());
-    return (loaded === null || loaded === void 0 ? void 0 : loaded.filepath) || "";
-};
-let configFilePath = "";
-const getConfigFilePath = async () => {
-    if (configFilePath) {
-        return configFilePath;
-    }
-    configFilePath = (await findConfig()) || (0, path_1.join)((0, process_1.cwd)(), METICULOUS_CONFIG_FILE);
-    return configFilePath;
-};
-const validateReplayOptions = (prevOptions) => {
-    const { appUrl, screenshotSelector, diffThreshold, diffPixelThreshold, moveBeforeClick, simulationIdForAssets, } = prevOptions;
-    return {
-        ...(appUrl != null ? { appUrl } : {}),
-        ...(screenshotSelector != null ? { screenshotSelector } : {}),
-        ...(diffThreshold != null ? { diffThreshold } : {}),
-        ...(diffPixelThreshold != null ? { diffPixelThreshold } : {}),
-        ...(moveBeforeClick != null ? { moveBeforeClick } : {}),
-        ...(simulationIdForAssets != null ? { simulationIdForAssets } : {}),
-    };
-};
-const validateConfig = (prevConfig) => {
-    const { testCases, ...rest } = prevConfig;
-    const nextTestCases = (testCases || [])
-        .map(({ title, sessionId, options }) => ({
-        title: typeof title === "string" ? title : "",
-        sessionId: typeof sessionId === "string" ? sessionId : "",
-        ...(options ? { options: validateReplayOptions(options) } : {}),
-    }))
-        .map(({ title, ...rest }) => ({
-        title: title || `${rest.sessionId}`,
-        ...rest,
-    }))
-        .filter(({ sessionId }) => sessionId);
-    return { ...rest, testCases: nextTestCases };
-};
-const readConfig = async (configFilePath) => {
-    const filePath = configFilePath !== null && configFilePath !== void 0 ? configFilePath : (await getConfigFilePath());
-    const configStr = await (0, promises_1.readFile)(filePath, "utf-8").catch((error) => {
-        // Use an empty config object if there is no config file
-        if (configFilePath == null &&
-            error instanceof Error &&
-            error.code === "ENOENT") {
-            return "{}";
-        }
-        throw error;
-    });
-    const config = JSON.parse(configStr);
-    return validateConfig(config);
-};
-exports.readConfig = readConfig;
-const saveConfig = async (config) => {
-    const filePath = await getConfigFilePath();
-    const configStr = JSON.stringify(config, null, 2);
-    await (0, promises_1.writeFile)(filePath, configStr);
-};
-exports.saveConfig = saveConfig;

package/dist/config/config.types.d.ts

@@ -1,16 +0,0 @@
-import { ScreenshotDiffResult, TestCase } from "@alwaysmeticulous/api";
-export interface MeticulousCliConfig {
-    testCases?: TestCase[];
-}
-export interface TestCaseResult extends TestCase {
-    headReplayId: string;
-    /**
-     * A test case is marked as a flake if there were screenshot comparison failures,
-     * but for every one of those failures regenerating the screenshot on head sometimes gave
-     * a different screenshot to the original screenshot taken on head.
-     */
-    result: "pass" | "fail" | "flake";
-}
-export interface DetailedTestCaseResult extends TestCaseResult {
-    screenshotDiffResultsByBaseReplayId: Record<string, ScreenshotDiffResult[]>;
-}

package/dist/config/config.types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/config/snippets.d.ts

@@ -1 +0,0 @@
-export declare const getSnippetsBaseUrl: () => string;

package/dist/config/snippets.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSnippetsBaseUrl = void 0;
-const common_1 = require("@alwaysmeticulous/common");
-const config_1 = require("../errors/config");
-const getSnippetsBaseUrl = () => {
-    const baseUrl = process.env["METICULOUS_SNIPPETS_BASE_URL"] || common_1.BASE_SNIPPETS_URL;
-    try {
-        return new URL(baseUrl).href;
-    }
-    catch (e) {
-        if (e instanceof TypeError) {
-            throw new config_1.ConfigurationError(`Invalid base snippets URL: ${baseUrl}`);
-        }
-        throw e;
-    }
-};
-exports.getSnippetsBaseUrl = getSnippetsBaseUrl;

package/dist/errors/config.d.ts

@@ -1,3 +0,0 @@
-export declare class ConfigurationError extends Error {
-    constructor(message: string);
-}

package/dist/errors/config.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigurationError = void 0;
-class ConfigurationError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = "ConfigurationError";
-    }
-}
-exports.ConfigurationError = ConfigurationError;

package/dist/image/diff.utils.d.ts

@@ -1,19 +0,0 @@
-import { PNG } from "pngjs";
-export interface CompareImageOptions {
-    base: PNG;
-    head: PNG;
-    /**
-     * Maximum colour distance a given pixel is allowed to differ before counting two
-     * pixels as different.
-     *
-     * Measure is based on "Measuring perceived color difference using YIQ NTSC transmission color space
-     * in mobile applications" by Y. Kotsarenko and F. Ramos
-     */
-    pixelThreshold: number;
-}
-export interface CompareImageResult {
-    mismatchPixels: number;
-    mismatchFraction: number;
-    diff: PNG;
-}
-export declare const compareImages: (options: CompareImageOptions) => CompareImageResult;

package/dist/image/diff.utils.js

@@ -1,25 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compareImages = void 0;
-const pixelmatch_1 = __importDefault(require("pixelmatch"));
-const pngjs_1 = require("pngjs");
-const compareImages = ({ base, head, pixelThreshold }) => {
-    if (base.width !== head.width || base.height !== head.height) {
-        throw new Error("Cannot handle different size yet");
-    }
-    const { width, height } = base;
-    const diff = new pngjs_1.PNG({ width, height });
-    const mismatchPixels = (0, pixelmatch_1.default)(base.data, head.data, diff.data, width, height, {
-        threshold: pixelThreshold,
-    });
-    const mismatchFraction = mismatchPixels / (width * height);
-    return {
-        mismatchPixels,
-        mismatchFraction,
-        diff,
-    };
-};
-exports.compareImages = compareImages;

package/dist/image/io.utils.d.ts

@@ -1,3 +0,0 @@
-import { PNG } from "pngjs";
-export declare const readPng: (path: string) => Promise<PNG>;
-export declare const writePng: (png: PNG, path: string) => Promise<void>;

package/dist/image/io.utils.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.writePng = exports.readPng = void 0;
-const fs_1 = require("fs");
-const pngjs_1 = require("pngjs");
-const readPng = async (path) => {
-    return new Promise((resolve, reject) => {
-        const png = new pngjs_1.PNG();
-        (0, fs_1.createReadStream)(path)
-            .pipe(png)
-            .on("parsed", () => {
-            resolve(png);
-        })
-            .on("error", (error) => reject(error));
-    });
-};
-exports.readPng = readPng;
-const writePng = async (png, path) => {
-    return new Promise((resolve, reject) => {
-        const str = (0, fs_1.createWriteStream)(path);
-        png.pack().pipe(str);
-        str.on("close", () => resolve()).on("error", (error) => reject(error));
-    });
-};
-exports.writePng = writePng;

package/dist/local-data/local-data.utils.d.ts

@@ -1,20 +0,0 @@
-export declare const sanitizeFilename: (filename: string) => string;
-type ReleaseLock = () => Promise<void>;
-export interface LoadOrDownloadJsonFileOptions<T> {
-    filePath: string;
-    downloadJson: () => Promise<T | null>;
-    /**
-     * For debug messages e.g. 'session' or 'session data'
-     */
-    dataDescription: string;
-}
-/**
- * Returns the JSON.parse'd contents of the file at the given path. If the file
- * doesn't exist yet then it downloads the object, writes it to the file, and returns it.
- *
- * Handles concurrent processes trying to download to the same file at the same time.
- */
-export declare const getOrDownloadJsonFile: <T>({ filePath, downloadJson, dataDescription, }: LoadOrDownloadJsonFileOptions<T>) => Promise<T | null>;
-export declare const fileExists: (filePath: string) => Promise<boolean>;
-export declare const waitToAcquireLockOnDirectory: (directoryPath: string) => Promise<ReleaseLock>;
-export {};