@alwaysmeticulous/cli 2.30.1 → 2.31.2

package/dist/api/test-run.api.d.ts

@@ -1,16 +1,7 @@
 import { TestRunConfigData } from "@alwaysmeticulous/api";
 import { AxiosInstance } from "axios";
 import { TestCaseResult } from "../config/config.types";
-export type TestRunStatus = "Running" | "Success" | "Failure";
-export interface TestRun {
-    id: string;
-    status: TestRunStatus;
-    resultData?: {
-        results: TestCaseResult[];
-        [key: string]: any;
-    };
-    [key: string]: any;
-}
+import { TestRun, TestRunStatus } from "./types";
 export declare const getTestRun: (options: {
     client: AxiosInstance;
     testRunId: string;
@@ -24,7 +15,7 @@ export declare const createTestRun: (options: {
 export declare const putTestRunResults: (options: {
     client: AxiosInstance;
     testRunId: string;
-    status: "Running" | "Success" | "Failure";
+    status: TestRunStatus;
     resultData: {
         [key: string]: any;
     };

package/dist/api/types.d.ts

@@ -0,0 +1,30 @@
+import { TestCaseResult } from "../config/config.types";
+interface Organization {
+    id: string;
+    name: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface Project {
+    id: string;
+    name: string;
+    recordingToken: string;
+    apiToken: string;
+    isGitHubIntegrationActive: boolean;
+    url: string;
+    organization: Organization;
+    createdAt: string;
+    updatedAt: string;
+}
+export type TestRunStatus = "Running" | "Success" | "Failure";
+export interface TestRun {
+    id: string;
+    status: TestRunStatus;
+    project: Project;
+    resultData?: {
+        results: TestCaseResult[];
+        [key: string]: any;
+    };
+    [key: string]: any;
+}
+export {};

package/dist/api/types.js

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

package/dist/config/config.js

@@ -22,8 +22,9 @@ const getConfigFilePath = async () => {
     return configFilePath;
 };
 const validateReplayOptions = (prevOptions) => {
-    const { screenshotSelector, diffThreshold, diffPixelThreshold, moveBeforeClick, simulationIdForAssets, } = prevOptions;
+    const { appUrl, screenshotSelector, diffThreshold, diffPixelThreshold, moveBeforeClick, simulationIdForAssets, } = prevOptions;
     return {
+        ...(appUrl != null ? { appUrl } : {}),
         ...(screenshotSelector != null ? { screenshotSelector } : {}),
         ...(diffThreshold != null ? { diffThreshold } : {}),
         ...(diffPixelThreshold != null ? { diffPixelThreshold } : {}),

package/dist/index.d.ts

@@ -9,6 +9,6 @@ export { runAllTestsCommand } from "./commands/run-all-tests/run-all-tests.comma
 export { screenshotDiffCommand } from "./commands/screenshot-diff/screenshot-diff.command";
 export { showProjectCommand } from "./commands/show-project/show-project.command";
 export { updateTestsCommand } from "./commands/update-tests/update-tests.command";
-export { runAllTests, RunAllTestsResult, TestRun, } from "./parallel-tests/run-all-tests";
+export { runAllTests, RunAllTestsResult, RunAllTestsTestRun as TestRun, RunAllTestsTestRun, } from "./parallel-tests/run-all-tests";
 export { initLogger, setLogLevel } from "./utils/logger.utils";
 export { initSentry } from "./utils/sentry.utils";

package/dist/parallel-tests/run-all-tests.d.ts

@@ -1,9 +1,13 @@
 import { TestRunEnvironment } from "@alwaysmeticulous/api";
 import { ReplayExecutionOptions } from "@alwaysmeticulous/common";
-import { TestRunStatus } from "../api/test-run.api";
+import { TestRun } from "../api/types";
 import { ScreenshotAssertionsEnabledOptions } from "../command-utils/common-types";
 import { DetailedTestCaseResult, TestCaseResult } from "../config/config.types";
 import { TestRunProgress } from "./run-all-tests.types";
+export type RunAllTestsTestRun = Pick<TestRun, "id" | "url" | "status" | "project"> & {
+    progress: TestRunProgress;
+    url: string;
+};
 export interface Options {
     testsFile: string | null;
     executionOptions: ReplayExecutionOptions;
@@ -40,25 +44,19 @@ export interface Options {
      * Captured environment for this run
      */
     environment?: TestRunEnvironment;
-    onTestRunCreated?: (testRun: TestRun & {
+    onTestRunCreated?: (testRun: RunAllTestsTestRun & {
         status: "Running";
     }) => void;
-    onTestFinished?: (testRun: TestRun & {
+    onTestFinished?: (testRun: RunAllTestsTestRun & {
         status: "Running";
     }) => void;
 }
 export interface RunAllTestsResult {
-    testRun: TestRun & {
+    testRun: RunAllTestsTestRun & {
         status: "Success" | "Failure";
     };
     testCaseResults: DetailedTestCaseResult[];
 }
-export interface TestRun {
-    id: string;
-    url: string;
-    status: TestRunStatus;
-    progress: TestRunProgress;
-}
 /**
  * Runs all the test cases in the provided file.
  * @returns The results of the tests that were executed (note that this does not include results from any cachedTestRunResults passed in)

package/dist/parallel-tests/run-all-tests.js

@@ -74,6 +74,7 @@ const runAllTests = async ({ testsFile, apiToken, commitSha, baseCommitSha, appU
     onTestRunCreated === null || onTestRunCreated === void 0 ? void 0 : onTestRunCreated({
         id: testRun.id,
         url: testRunUrl,
+        project: testRun.project,
         status: "Running",
         progress: {
             failedTestCases: 0,
@@ -115,6 +116,7 @@ const runAllTests = async ({ testsFile, apiToken, commitSha, baseCommitSha, appU
         onTestFinished_ === null || onTestFinished_ === void 0 ? void 0 : onTestFinished_({
             id: testRun.id,
             url: testRunUrl,
+            project: testRun.project,
             status: "Running",
             progress: {
                 ...progress,
@@ -189,12 +191,13 @@ const runAllTests = async ({ testsFile, apiToken, commitSha, baseCommitSha, appU
         logger.info(`${title} => ${result}`);
     });
     if (githubSummary) {
-        await (0, github_summary_utils_1.writeGitHubSummary)({ testRunUrl, results });
+        await (0, github_summary_utils_1.writeGitHubSummary)({ testRunUrl: testRunUrl, results });
     }
     return {
         testRun: {
             url: testRunUrl,
             id: testRun.id,
+            project: testRun.project,
             status: overallStatus,
             progress: {
                 flakedTestCases: sortedResults.filter(({ result }) => result === "flake").length,

package/dist/utils/config.utils.js

@@ -12,7 +12,7 @@ const addTestCase = async (testCase) => {
 };
 exports.addTestCase = addTestCase;
 const getReplayTargetForTestCase = ({ useAssetsSnapshottedInBaseSimulation, appUrl, testCase, }) => {
-    var _a, _b;
+    var _a, _b, _c;
     if (((_a = testCase.options) === null || _a === void 0 ? void 0 : _a.simulationIdForAssets) != null) {
         return {
             type: "snapshotted-assets",
@@ -28,6 +28,12 @@ const getReplayTargetForTestCase = ({ useAssetsSnapshottedInBaseSimulation, appU
             simulationIdForAssets: testCase.baseReplayId,
         };
     }
+    if ((_c = testCase.options) === null || _c === void 0 ? void 0 : _c.appUrl) {
+        if (appUrl) {
+            throw new Error(`Test cases "${testCase.title}" has an "appUrl" option but --appUrl is also provided.`);
+        }
+        return { type: "url", appUrl: testCase.options.appUrl };
+    }
     if (appUrl) {
         return { type: "url", appUrl };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/cli",
-  "version": "2.30.1",
+  "version": "2.31.2",
   "description": "The Meticulous CLI",
   "license": "ISC",
   "main": "dist/index.js",
@@ -93,5 +93,5 @@
     "coverageDirectory": "../coverage",
     "testEnvironment": "node"
   },
-  "gitHead": "e9b5274798b97abc5f83ba515a51164b2cf755ac"
+  "gitHead": "e0df9ee41f550013df780a27e55615d32188dc2b"
 }