@alwaysmeticulous/api 2.267.0 → 2.273.0

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 export { Organization } from "./organization.types";
 export { Project, ProjectSettingsScreenshottingOptions } from "./project.types";
 export { EndStateScreenshot, ScreenshotAfterEvent, ScreenshotDiffResult, ScreenshotDiffResultCompared, ScreenshotDiffResultDifferentSize, ScreenshotDiffResultMissingBase, ScreenshotDiffResultMissingBaseAndHead, ScreenshotDiffResultMissingHead, ScreenshotDiffResultDifference, ScreenshotDiffResultNoDifference, ScreenshotIdentifier, ScreenshotVariant, SingleTryScreenshotDiffResult, ScreenshotDiffRetryResult, SingleTryScreenshotDiffRetryResult, RedactedScreenshotIncompatible, RedactedScreenshotsCompared, RedactedScreenshotsComparison, } from "./sdk-bundle-api/bundle-to-sdk/screenshot-diff-result";
-export { SessionRelevance, isPrAuthorRelevance, TestCase, TestCaseReplayOptions, TestRunStatus, TestCaseResult, TestCaseResultStatus, AppContainerLogsLocations, TestRunDataLocations, } from "./replay/test-run.types";
+export { SessionRelevance, isPrAuthorRelevance, TestCase, TestCaseReplayOptions, TestRunStatus, TestCaseResult, TestCaseResultStatus, AppContainerLogsLocations, TestRunDataLocations, TestRun, ExecuteSecureTunnelTestRunOptions, ExecuteSecureTunnelTestRunResponse, } from "./replay/test-run.types";
+export { BaseResolutionDetails, FailedForOtherReason, RequiredNewWorkflowRunButFailedDueToNewCommitToBaseBranch, SuitableTestRunAlreadyExisted, TestRunTriggerDebugContext, TriggeredNewWorkflowRunSuccessfully, WaitedForExistingWorkflowRun, } from "./replay/test-run-debug-context.types";
 export { TestRunChunkStatus } from "./replay/test-run-chunk.types";
 export * from "./sdk-bundle-api/sdk-to-bundle/test-run-environment";
 export { ReplayableEvent } from "./sdk-bundle-api/bidirectional/replayable-event";

package/dist/index.js

@@ -1,5 +1,5 @@
 "use strict";
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="997f0734-7bff-5d3a-acd6-bcd8d79f321a")}catch(e){}}();
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="241d0bfa-4ceb-5286-b3c4-2a8e60fcaee0")}catch(e){}}();
 
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -25,4 +25,4 @@ var session_data_1 = require("./sdk-bundle-api/sdk-to-bundle/session-data");
 Object.defineProperty(exports, "CustomDataSingletonInternalKey", { enumerable: true, get: function () { return session_data_1.CustomDataSingletonInternalKey; } });
 __exportStar(require("./sdk-bundle-api/sdk-to-bundle/event-source-data"), exports);
 //# sourceMappingURL=index.js.map
-//# debugId=997f0734-7bff-5d3a-acd6-bcd8d79f321a
+//# debugId=241d0bfa-4ceb-5286-b3c4-2a8e60fcaee0

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourceRoot":"","names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAsBA,0DAUiC;AAT/B,kHAAA,gBAAgB,OAAA;AAChB,qHAAA,mBAAmB,OAAA;AAUrB,sFAAoE;AAQpE,4EAoBqD;AAPnD,8HAAA,8BAA8B,OAAA;AAoBhC,mFAAiE","debugId":"997f0734-7bff-5d3a-acd6-bcd8d79f321a"}
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourceRoot":"","names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAsBA,0DAaiC;AAZ/B,kHAAA,gBAAgB,OAAA;AAChB,qHAAA,mBAAmB,OAAA;AAsBrB,sFAAoE;AAQpE,4EAoBqD;AAPnD,8HAAA,8BAA8B,OAAA;AAoBhC,mFAAiE","debugId":"241d0bfa-4ceb-5286-b3c4-2a8e60fcaee0"}

package/dist/replay/test-run-debug-context.types.d.ts

@@ -0,0 +1,51 @@
+export interface TestRunTriggerDebugContext {
+    baseResolutionDetails?: BaseResolutionDetails;
+}
+/**
+ * We sometimes need to re-run the CI job for the base commit to (re-)compute Meticulous results for the base commit.
+ *
+ * The caller can optionally provide information on whether this happened or was required, and was successful or not.
+ *
+ * This is useful for debugging -- for example if the base isn't available.
+ */
+export type BaseResolutionDetails = SuitableTestRunAlreadyExisted | WaitedForExistingWorkflowRun | RequiredNewWorkflowRunButFailedDueToNewCommitToBaseBranch | TriggeredNewWorkflowRunSuccessfully | FailedForOtherReason;
+export type SuitableTestRunAlreadyExisted = {
+    type: "suitable-test-run-already-existed";
+    testRunId: string;
+};
+/**
+ * We waited for the CI workflow to complete before calling this function, and it completed successfully.
+ */
+export type WaitedForExistingWorkflowRun = {
+    type: "waited-for-existing-workflow-run";
+    workflowId: string;
+    baseCommitSha: string;
+    msTaken: number;
+};
+/**
+ * No suitable existing Meticulous results existed for the target base commit, and no existing CI workflow was running, and we were
+ * not able to trigger a new CI workflow because the base branch had been updated to a new commit, and the CI system only supports
+ * triggering new runs on the latest commit on the base branch.
+ */
+export type RequiredNewWorkflowRunButFailedDueToNewCommitToBaseBranch = {
+    type: "required-new-workflow-run-but-failed-due-to-new-commit-to-base-branch";
+    baseRef: string;
+    targetBaseCommitSha: string;
+    currentLastestBaseCommitSha: string;
+};
+/**
+ * No suitable existing Meticulous results existed for the target base commit, and no existing CI workflow was running,
+ * so we triggered a new CI workflow, waited for it to complete, and it completed successfully.
+ */
+export type TriggeredNewWorkflowRunSuccessfully = {
+    type: "triggered-new-workflow-run-successfully";
+    workflowId: string;
+    msTaken: number;
+};
+/**
+ * A catch all for more exceptional failures
+ */
+export type FailedForOtherReason = {
+    type: "failed-for-other-reason";
+    message: string;
+};

package/dist/replay/test-run-debug-context.types.js

@@ -0,0 +1,6 @@
+"use strict";
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="ece528ed-5148-5cbc-ac24-fef3be6baf51")}catch(e){}}();
+
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=test-run-debug-context.types.js.map
+//# debugId=ece528ed-5148-5cbc-ac24-fef3be6baf51

package/dist/replay/test-run-debug-context.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-run-debug-context.types.js","sources":["../../src/replay/test-run-debug-context.types.ts"],"sourceRoot":"","names":[],"mappings":"","debugId":"ece528ed-5148-5cbc-ac24-fef3be6baf51"}

package/dist/replay/test-run.types.d.ts

@@ -1,5 +1,8 @@
+import { Project } from "../project.types";
 import { S3Location } from "../s3.types";
+import { CompanionAssetsInfo } from "../sdk-bundle-api/sdk-to-bundle/companion-assets";
 import { ScreenshotDiffOptions } from "../sdk-bundle-api/sdk-to-bundle/screenshotting-options";
+import type { TestRunTriggerDebugContext } from "./test-run-debug-context.types";
 /**
  * Relevance of a session
  */
@@ -84,3 +87,32 @@ export interface TestRunDataLocations {
     relevantReplayContexts: S3Location;
     appContainerLogs?: AppContainerLogsLocations;
 }
+export interface TestRun {
+    id: string;
+    status: TestRunStatus;
+    project: Project;
+    configData: {
+        testCases?: TestCase[];
+    };
+    resultData?: {
+        results?: TestCaseResult[];
+    };
+    url: string;
+}
+export interface ExecuteSecureTunnelTestRunOptions {
+    headSha: string;
+    tunnelUrl: string;
+    basicAuthUser: string;
+    basicAuthPassword: string;
+    environment: string;
+    isLockable: boolean;
+    companionAssetsInfo?: CompanionAssetsInfo;
+    pullRequestHostingProviderId?: string;
+    postComment?: boolean;
+    debugContext?: TestRunTriggerDebugContext;
+}
+export interface ExecuteSecureTunnelTestRunResponse {
+    testRun?: TestRun;
+    deploymentId: string;
+    message?: string;
+}

package/dist/replay/test-run.types.js

@@ -1,5 +1,5 @@
 "use strict";
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="ce911e58-445b-52ee-8918-2c7e74c317c4")}catch(e){}}();
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="eb3b2b0d-be93-5eab-b9e7-ddd3cd69022c")}catch(e){}}();
 
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isPrAuthorRelevance = exports.SessionRelevance = void 0;
@@ -26,4 +26,4 @@ const isPrAuthorRelevance = (relevance) => {
 };
 exports.isPrAuthorRelevance = isPrAuthorRelevance;
 //# sourceMappingURL=test-run.types.js.map
-//# debugId=ce911e58-445b-52ee-8918-2c7e74c317c4
+//# debugId=eb3b2b0d-be93-5eab-b9e7-ddd3cd69022c

package/dist/replay/test-run.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"test-run.types.js","sources":["../../src/replay/test-run.types.ts"],"sourceRoot":"","names":[],"mappings":";;;;;AAGA;;GAEG;AACH,IAAY,gBAQX;AARD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,gEAA4C,CAAA;IAC5C,uEAAmD,CAAA;IACnD,uDAAmC,CAAA;IACnC,8CAA0B,CAAA;IAC1B,gDAA4B,CAAA;IAC5B,oDAAgC,CAAA;AAClC,CAAC,EARW,gBAAgB,gCAAhB,gBAAgB,QAQ3B;AAEM,MAAM,mBAAmB,GAAG,CACjC,SAA8C,EACrC,EAAE;IACX,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CACL,SAAS,KAAK,gBAAgB,CAAC,UAAU;QACzC,SAAS,KAAK,gBAAgB,CAAC,kBAAkB;QACjD,SAAS,KAAK,gBAAgB,CAAC,qBAAqB,CACrD,CAAC;AACJ,CAAC,CAAC;AAZW,QAAA,mBAAmB,uBAY9B","debugId":"ce911e58-445b-52ee-8918-2c7e74c317c4"}
+{"version":3,"file":"test-run.types.js","sources":["../../src/replay/test-run.types.ts"],"sourceRoot":"","names":[],"mappings":";;;;;AAMA;;GAEG;AACH,IAAY,gBAQX;AARD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,gEAA4C,CAAA;IAC5C,uEAAmD,CAAA;IACnD,uDAAmC,CAAA;IACnC,8CAA0B,CAAA;IAC1B,gDAA4B,CAAA;IAC5B,oDAAgC,CAAA;AAClC,CAAC,EARW,gBAAgB,gCAAhB,gBAAgB,QAQ3B;AAEM,MAAM,mBAAmB,GAAG,CACjC,SAA8C,EACrC,EAAE;IACX,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CACL,SAAS,KAAK,gBAAgB,CAAC,UAAU;QACzC,SAAS,KAAK,gBAAgB,CAAC,kBAAkB;QACjD,SAAS,KAAK,gBAAgB,CAAC,qBAAqB,CACrD,CAAC;AACJ,CAAC,CAAC;AAZW,QAAA,mBAAmB,uBAY9B","debugId":"eb3b2b0d-be93-5eab-b9e7-ddd3cd69022c"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.267.0",
+  "version": "2.273.0",
   "description": "Meticulous API types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -35,5 +35,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "a29aa1a86ad6fa6f9e6ab6abf53dd64c2efd9ac1"
+  "gitHead": "a359e47f23aaf6606936babaaf9b12576bad188a"
 }