@alwaysmeticulous/cli 2.5.2 → 2.5.5

package/dist/command-utils/command-builder.d.ts

@@ -0,0 +1,10 @@
+import { ArgumentsCamelCase, CommandModule, InferredOptionTypes, Options } from "yargs";
+export declare const buildCommand: (command: string) => {
+    details: (details: Omit<CommandModule, "command" | "builder" | "handler">) => {
+        options: <O extends {
+            [key: string]: Options;
+        }>(options: O) => {
+            handler: (unwrappedHandler: (args: ArgumentsCamelCase<InferredOptionTypes<O>>) => Promise<void>) => CommandModule<unknown, InferredOptionTypes<O>>;
+        };
+    };
+};

package/dist/command-utils/command-builder.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildCommand = void 0;
+const sentry_utils_1 = require("../utils/sentry.utils");
+const buildCommand = (command) => {
+    return {
+        details: (details) => ({
+            options: (options) => ({
+                handler: (unwrappedHandler) => ({
+                    command,
+                    ...details,
+                    builder: options,
+                    handler: (0, sentry_utils_1.wrapHandler)(unwrappedHandler),
+                }),
+            }),
+        }),
+    };
+};
+exports.buildCommand = buildCommand;

package/dist/command-utils/common-options.d.ts

@@ -1,71 +1,71 @@
 export declare const OPTIONS: {
-    apiToken: {
-        string: boolean;
-    };
-    commitSha: {
-        string: boolean;
-    };
-    headless: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
-    };
-    devTools: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
-    };
-    bypassCSP: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
-    };
-    padTime: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
-    };
-    shiftTime: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
-    };
-    networkStubbing: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
-    };
-    skipPauses: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
-    };
-    moveBeforeClick: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
-    };
-    diffThreshold: {
-        number: boolean;
-        description: string;
-        default: number;
-    };
-    diffPixelThreshold: {
-        number: boolean;
-        description: string;
-        default: number;
+    readonly apiToken: {
+        readonly string: true;
+    };
+    readonly commitSha: {
+        readonly string: true;
+    };
+    readonly headless: {
+        readonly boolean: true;
+        readonly description: "Start browser in headless mode";
+        readonly default: false;
+    };
+    readonly devTools: {
+        readonly boolean: true;
+        readonly description: "Open Chrome Dev Tools";
+        readonly default: false;
+    };
+    readonly bypassCSP: {
+        readonly boolean: true;
+        readonly description: "Enables bypass CSP in the browser (danger: this could mean you tests hit your production backend)";
+        readonly default: false;
+    };
+    readonly padTime: {
+        readonly boolean: true;
+        readonly description: "Pad replay time according to recording duration. Please note this option will be ignored if running with the '--skipPauses' option.";
+        readonly default: true;
+    };
+    readonly shiftTime: {
+        readonly boolean: true;
+        readonly description: "Shift time during simulation to be set as the recording time";
+        readonly default: true;
+    };
+    readonly networkStubbing: {
+        readonly boolean: true;
+        readonly description: "Stub network requests during replay";
+        readonly default: true;
+    };
+    readonly skipPauses: {
+        readonly boolean: true;
+        readonly description: "Fast forward through any pauses to replay as fast as possible. Warning: this option is experimental and may be deprecated";
+        readonly default: false;
+    };
+    readonly moveBeforeClick: {
+        readonly boolean: true;
+        readonly description: "Simulate mouse movement before clicking";
+        readonly default: false;
+    };
+    readonly diffThreshold: {
+        readonly number: true;
+        readonly description: "Acceptable maximum proportion of changed pixels, between 0 and 1. If this proportion is exceeded then the test will fail.";
+        readonly default: 0.01;
+    };
+    readonly diffPixelThreshold: {
+        readonly number: true;
+        readonly description: "A number between 0 and 1. Color/brightness differences in individual pixels will be ignored if the difference is less than this threshold. A value of 1.0 would accept any difference in color, while a value of 0.0 would accept no difference in color.";
+        readonly default: 0.01;
     };
 };
 export declare const SCREENSHOT_DIFF_OPTIONS: {
     diffThreshold: {
-        number: boolean;
-        description: string;
-        default: number;
+        readonly number: true;
+        readonly description: "Acceptable maximum proportion of changed pixels, between 0 and 1. If this proportion is exceeded then the test will fail.";
+        readonly default: 0.01;
     };
     diffPixelThreshold: {
-        number: boolean;
-        description: string;
-        default: number;
+        readonly number: true;
+        readonly description: "A number between 0 and 1. Color/brightness differences in individual pixels will be ignored if the difference is less than this threshold. A value of 1.0 would accept any difference in color, while a value of 0.0 would accept no difference in color.";
+        readonly default: 0.01;
     };
 };
 /**
@@ -73,38 +73,38 @@ export declare const SCREENSHOT_DIFF_OPTIONS: {
  */
 export declare const COMMON_REPLAY_OPTIONS: {
     headless: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
+        readonly boolean: true;
+        readonly description: "Start browser in headless mode";
+        readonly default: false;
     };
     devTools: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
+        readonly boolean: true;
+        readonly description: "Open Chrome Dev Tools";
+        readonly default: false;
     };
     bypassCSP: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
+        readonly boolean: true;
+        readonly description: "Enables bypass CSP in the browser (danger: this could mean you tests hit your production backend)";
+        readonly default: false;
     };
     padTime: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
+        readonly boolean: true;
+        readonly description: "Pad replay time according to recording duration. Please note this option will be ignored if running with the '--skipPauses' option.";
+        readonly default: true;
     };
     shiftTime: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
+        readonly boolean: true;
+        readonly description: "Shift time during simulation to be set as the recording time";
+        readonly default: true;
     };
     networkStubbing: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
+        readonly boolean: true;
+        readonly description: "Stub network requests during replay";
+        readonly default: true;
     };
     skipPauses: {
-        boolean: boolean;
-        description: string;
-        default: boolean;
+        readonly boolean: true;
+        readonly description: "Fast forward through any pauses to replay as fast as possible. Warning: this option is experimental and may be deprecated";
+        readonly default: false;
     };
 };

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

@@ -1,4 +1,2 @@
-import { CommandModule } from "yargs";
-declare type Options = Record<string, unknown>;
-export declare const bootstrap: CommandModule<unknown, Options>;
-export {};
+/// <reference types="yargs" />
+export declare const bootstrap: import("yargs").CommandModule<unknown, import("yargs").InferredOptionTypes<{}>>;

package/dist/commands/bootstrap/bootstrap.command.js

@@ -7,9 +7,9 @@ exports.bootstrap = void 0;
 const common_1 = require("@alwaysmeticulous/common");
 const chalk_1 = __importDefault(require("chalk"));
 const loglevel_1 = __importDefault(require("loglevel"));
+const command_builder_1 = require("../../command-utils/command-builder");
 const config_1 = require("../../config/config");
 const npm_set_script_utils_1 = require("../../utils/npm-set-script.utils");
-const sentry_utils_1 = require("../../utils/sentry.utils");
 const handler = async () => {
     const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
     logger.info(`Setting up ${chalk_1.default.green("meticulous.json")}...`);
@@ -25,9 +25,9 @@ const handler = async () => {
         command: "meticulous run-all-tests --headless --parallelize --deflake",
     });
 };
-exports.bootstrap = {
-    command: "bootstrap",
+exports.bootstrap = (0, command_builder_1.buildCommand)("bootstrap")
+    .details({
     describe: "Bootstrap your project to use Meticulous",
-    builder: {},
-    handler: (0, sentry_utils_1.wrapHandler)(handler),
-};
+})
+    .options({})
+    .handler(handler);

package/dist/commands/create-test/create-test.command.d.ts

@@ -1,7 +1,76 @@
-import { CommandModule } from "yargs";
-import { RecordCommandHandlerOptions } from "../record/record.command";
-import { RawReplayCommandHandlerOptions } from "../replay/replay.command";
-interface Options extends Omit<RecordCommandHandlerOptions, "devTools" | "bypassCSP">, RawReplayCommandHandlerOptions {
-}
-export declare const createTest: CommandModule<unknown, Options>;
-export {};
+/// <reference types="yargs" />
+export declare const createTest: import("yargs").CommandModule<unknown, import("yargs").InferredOptionTypes<{
+    headless: {
+        default: boolean;
+        boolean: true;
+        description: "Start browser in headless mode";
+    };
+    skipPauses: {
+        description: string;
+        boolean: true;
+        default: false;
+    };
+    devTools: {
+        readonly boolean: true;
+        readonly description: "Open Chrome Dev Tools";
+        readonly default: false;
+    };
+    bypassCSP: {
+        readonly boolean: true;
+        readonly description: "Enables bypass CSP in the browser (danger: this could mean you tests hit your production backend)";
+        readonly default: false;
+    };
+    padTime: {
+        readonly boolean: true;
+        readonly description: "Pad replay time according to recording duration. Please note this option will be ignored if running with the '--skipPauses' option.";
+        readonly default: true;
+    };
+    shiftTime: {
+        readonly boolean: true;
+        readonly description: "Shift time during simulation to be set as the recording time";
+        readonly default: true;
+    };
+    networkStubbing: {
+        readonly boolean: true;
+        readonly description: "Stub network requests during replay";
+        readonly default: true;
+    };
+    apiToken: {
+        readonly string: true;
+    };
+    commitSha: {
+        readonly string: true;
+    };
+    width: {
+        number: true;
+    };
+    height: {
+        number: true;
+    };
+    uploadIntervalMs: {
+        number: true;
+        description: string;
+    };
+    incognito: {
+        boolean: true;
+        description: string;
+        default: boolean;
+    };
+    trace: {
+        boolean: true;
+        description: string;
+    };
+    screenshotSelector: {
+        string: true;
+        description: string;
+    };
+    moveBeforeClick: {
+        readonly boolean: true;
+        readonly description: "Simulate mouse movement before clicking";
+        readonly default: false;
+    };
+    cookiesFile: {
+        string: true;
+        description: string;
+    };
+}>>;

package/dist/commands/create-test/create-test.command.js

@@ -8,9 +8,9 @@ const common_1 = require("@alwaysmeticulous/common");
 const chalk_1 = __importDefault(require("chalk"));
 const inquirer_1 = require("inquirer");
 const loglevel_1 = __importDefault(require("loglevel"));
+const command_builder_1 = require("../../command-utils/command-builder");
 const common_options_1 = require("../../command-utils/common-options");
 const config_utils_1 = require("../../utils/config.utils");
-const sentry_utils_1 = require("../../utils/sentry.utils");
 const record_command_1 = require("../record/record.command");
 const replay_command_1 = require("../replay/replay.command");
 const handleTestCreation = async (replay, sessionId) => {
@@ -119,55 +119,52 @@ headless, screenshotSelector, padTime, shiftTime, networkStubbing, moveBeforeCli
     const replay = await (0, replay_command_1.rawReplayCommandHandler)(replayOptions);
     await handleTestCreation(replay, lastSessionId);
 };
-exports.createTest = {
-    command: "create-test",
+exports.createTest = (0, command_builder_1.buildCommand)("create-test")
+    .details({
     describe: "Create a new test",
-    builder: {
-        // Common options
-        apiToken: common_options_1.OPTIONS.apiToken,
-        commitSha: common_options_1.OPTIONS.commitSha,
-        // Record options
-        width: {
-            number: true,
-        },
-        height: {
-            number: true,
-        },
-        uploadIntervalMs: {
-            number: true,
-            description: "Meticulous recording upload interval (in milliseconds)",
-        },
-        incognito: {
-            boolean: true,
-            description: "Use an incognito browsing context",
-            default: true,
-        },
-        trace: {
-            boolean: true,
-            description: "Enable verbose logging",
-        },
-        // Replay options
-        screenshotSelector: {
-            string: true,
-            description: "Query selector to screenshot a specific DOM element instead of the whole page",
-        },
-        moveBeforeClick: {
-            boolean: true,
-            description: "Simulate mouse movement before clicking",
-        },
-        cookiesFile: {
-            string: true,
-            description: "Path to cookies to inject before simulation",
-        },
-        ...common_options_1.COMMON_REPLAY_OPTIONS,
-        headless: {
-            ...common_options_1.COMMON_REPLAY_OPTIONS.headless,
-            default: true,
-        },
-        skipPauses: {
-            ...common_options_1.COMMON_REPLAY_OPTIONS.skipPauses,
-            description: "Fast forward through any pauses to replay as fast as possible when replaying for the first time to create the test. Warning: this option is experimental and may be deprecated",
-        },
+})
+    .options({
+    // Common options
+    apiToken: common_options_1.OPTIONS.apiToken,
+    commitSha: common_options_1.OPTIONS.commitSha,
+    // Record options
+    width: {
+        number: true,
     },
-    handler: (0, sentry_utils_1.wrapHandler)(handler),
-};
+    height: {
+        number: true,
+    },
+    uploadIntervalMs: {
+        number: true,
+        description: "Meticulous recording upload interval (in milliseconds)",
+    },
+    incognito: {
+        boolean: true,
+        description: "Use an incognito browsing context",
+        default: true,
+    },
+    trace: {
+        boolean: true,
+        description: "Enable verbose logging",
+    },
+    // Replay options
+    screenshotSelector: {
+        string: true,
+        description: "Query selector to screenshot a specific DOM element instead of the whole page",
+    },
+    moveBeforeClick: common_options_1.OPTIONS.moveBeforeClick,
+    cookiesFile: {
+        string: true,
+        description: "Path to cookies to inject before simulation",
+    },
+    ...common_options_1.COMMON_REPLAY_OPTIONS,
+    headless: {
+        ...common_options_1.COMMON_REPLAY_OPTIONS.headless,
+        default: true,
+    },
+    skipPauses: {
+        ...common_options_1.COMMON_REPLAY_OPTIONS.skipPauses,
+        description: "Fast forward through any pauses to replay as fast as possible when replaying for the first time to create the test. Warning: this option is experimental and may be deprecated",
+    },
+})
+    .handler(handler);

package/dist/commands/debug-replay/debug-replay.command.d.ts

@@ -1,13 +1,35 @@
-import { CommandModule } from "yargs";
-interface Options {
-    apiToken?: string | null | undefined;
-    sessionId: string;
-    appUrl?: string | null | undefined;
-    devTools?: boolean | null | undefined;
-    shiftTime: boolean;
-    networkStubbing: boolean;
-    moveBeforeClick?: boolean | null | undefined;
-    cookiesFile?: string | null | undefined;
-}
-export declare const debugReplay: CommandModule<unknown, Options>;
-export {};
+/// <reference types="yargs" />
+export declare const debugReplay: import("yargs").CommandModule<unknown, import("yargs").InferredOptionTypes<{
+    apiToken: {
+        string: true;
+    };
+    sessionId: {
+        string: true;
+        demandOption: true;
+    };
+    appUrl: {
+        string: true;
+    };
+    devTools: {
+        boolean: true;
+        description: string;
+    };
+    shiftTime: {
+        boolean: true;
+        description: string;
+        default: boolean;
+    };
+    networkStubbing: {
+        boolean: true;
+        description: string;
+        default: boolean;
+    };
+    moveBeforeClick: {
+        boolean: true;
+        description: string;
+    };
+    cookiesFile: {
+        string: true;
+        description: string;
+    };
+}>>;

package/dist/commands/debug-replay/debug-replay.command.js

@@ -7,9 +7,9 @@ exports.debugReplay = 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 replay_assets_1 = require("../../local-data/replay-assets");
 const sessions_1 = require("../../local-data/sessions");
-const sentry_utils_1 = require("../../utils/sentry.utils");
 const handler = async ({ apiToken, sessionId, appUrl, devTools, shiftTime, networkStubbing, moveBeforeClick, cookiesFile, }) => {
     const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
     const client = (0, client_1.createClient)({ apiToken });
@@ -58,43 +58,43 @@ const handler = async ({ apiToken, sessionId, appUrl, devTools, shiftTime, netwo
     };
     await createReplayer(createReplayerParams);
 };
-exports.debugReplay = {
-    command: "debug-simulation",
+exports.debugReplay = (0, command_builder_1.buildCommand)("debug-simulation")
+    .details({
     aliases: ["debug-replay"],
     describe: "Replay and debug a recorded session",
-    builder: {
-        apiToken: {
-            string: true,
-        },
-        sessionId: {
-            string: true,
-            demandOption: true,
-        },
-        appUrl: {
-            string: true,
-        },
-        devTools: {
-            boolean: true,
-            description: "Open Chrome Dev Tools",
-        },
-        shiftTime: {
-            boolean: true,
-            description: "Shift time during simulation to be set as the recording time",
-            default: true,
-        },
-        networkStubbing: {
-            boolean: true,
-            description: "Stub network requests during replay",
-            default: true,
-        },
-        moveBeforeClick: {
-            boolean: true,
-            description: "Simulate mouse movement before clicking",
-        },
-        cookiesFile: {
-            string: true,
-            description: "Path to cookies to inject before replay",
-        },
+})
+    .options({
+    apiToken: {
+        string: true,
     },
-    handler: (0, sentry_utils_1.wrapHandler)(handler),
-};
+    sessionId: {
+        string: true,
+        demandOption: true,
+    },
+    appUrl: {
+        string: true,
+    },
+    devTools: {
+        boolean: true,
+        description: "Open Chrome Dev Tools",
+    },
+    shiftTime: {
+        boolean: true,
+        description: "Shift time during simulation to be set as the recording time",
+        default: true,
+    },
+    networkStubbing: {
+        boolean: true,
+        description: "Stub network requests during replay",
+        default: true,
+    },
+    moveBeforeClick: {
+        boolean: true,
+        description: "Simulate mouse movement before clicking",
+    },
+    cookiesFile: {
+        string: true,
+        description: "Path to cookies to inject before replay",
+    },
+})
+    .handler(handler);

package/dist/commands/download-replay/download-replay.command.d.ts

@@ -1,7 +1,10 @@
-import { CommandModule } from "yargs";
-interface Options {
-    apiToken?: string | null | undefined;
-    replayId: string;
-}
-export declare const downloadReplay: CommandModule<unknown, Options>;
-export {};
+/// <reference types="yargs" />
+export declare const downloadReplay: import("yargs").CommandModule<unknown, import("yargs").InferredOptionTypes<{
+    apiToken: {
+        string: true;
+    };
+    replayId: {
+        string: true;
+        demandOption: true;
+    };
+}>>;

package/dist/commands/download-replay/download-replay.command.js

@@ -2,25 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.downloadReplay = void 0;
 const client_1 = require("../../api/client");
+const command_builder_1 = require("../../command-utils/command-builder");
 const replays_1 = require("../../local-data/replays");
-const sentry_utils_1 = require("../../utils/sentry.utils");
 const handler = async ({ apiToken, replayId, }) => {
     const client = (0, client_1.createClient)({ apiToken });
     await (0, replays_1.getOrFetchReplay)(client, replayId);
     await (0, replays_1.getOrFetchReplayArchive)(client, replayId);
 };
-exports.downloadReplay = {
-    command: "download-simulation",
+exports.downloadReplay = (0, command_builder_1.buildCommand)("download-simulation")
+    .details({
     aliases: ["download-replay"],
     describe: "Download a simulation from Meticulous",
-    builder: {
-        apiToken: {
-            string: true,
-        },
-        replayId: {
-            string: true,
-            demandOption: true,
-        },
+})
+    .options({
+    apiToken: {
+        string: true,
     },
-    handler: (0, sentry_utils_1.wrapHandler)(handler),
-};
+    replayId: {
+        string: true,
+        demandOption: true,
+    },
+})
+    .handler(handler);