@alwaysmeticulous/api 2.288.2 → 2.290.0

package/dist/custom-checks.types.d.ts

@@ -29,12 +29,16 @@ export interface CustomCheckInput {
     headSnapshots: Snapshot[];
 }
 /**
+ * The outcome of comparing the base and head snapshots:
  * - `pass`: no regression; the check is green and no report is surfaced.
  * - `warn`: the check is green but its report is shown to the user.
  * - `fail`: the check is red.
- * - `execution-error`: the check failed to run.
+ *
+ * A check failing to *run* is not a verdict: an execution error applies to the
+ * custom check results as a whole (every check), not to an individual check, so
+ * it is reported at that level rather than as a per-check verdict.
  */
-export type CustomCheckVerdict = "pass" | "warn" | "fail" | "execution-error";
+export type CustomCheckVerdict = "pass" | "warn" | "fail";
 /**
  * Maximum length of a custom check `summary`. The summary is rendered inline in
  * the UI, so it is truncated to this many characters when displayed rather than
@@ -111,3 +115,33 @@ export interface NetworkRequestSnapshotData {
     /** Whether the request was matched to a recorded request and stubbed. */
     matched: boolean;
 }
+/**
+ * Status of the custom check results reported for a test run as a whole:
+ * - `complete`: the run finished and produced a verdict for every check.
+ * - `execution-error`: computing the custom checks failed (e.g. the script
+ *   threw before producing results). This is a property of the run as a whole,
+ *   not of any individual check — an individual check only ever has a
+ *   {@link CustomCheckVerdict}.
+ */
+export declare const CUSTOM_CHECK_RESULTS_STATUSES: readonly ["complete", "execution-error"];
+export type CustomCheckResultsStatus = (typeof CUSTOM_CHECK_RESULTS_STATUSES)[number];
+/**
+ * A single custom check's result: a {@link CustomCheckOutput} (verdict, summary
+ * and report) tagged with the check's id.
+ */
+export interface ReportedCustomCheckResult extends CustomCheckOutput {
+    /** Stable identifier of the check, e.g. "accessibility-check". */
+    checkId: string;
+}
+/**
+ * The custom check results computed for a test run, reported in a single call to
+ * `reportCustomCheckResults`. Either every check's result (`status: "complete"`),
+ * or a single execution error for the run as a whole (`status: "execution-error"`).
+ */
+export type ReportCustomCheckResultsRequest = {
+    status: "complete";
+    checks: ReportedCustomCheckResult[];
+} | {
+    status: "execution-error";
+    error: string;
+};

package/dist/custom-checks.types.js

@@ -1,8 +1,8 @@
 "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]="aaa133b4-907a-5e85-b83c-765d117cdeec")}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]="14a4ab8a-ebd9-5fd7-ba2b-b93055c8f39f")}catch(e){}}();
 
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NETWORK_REQUESTS_SNAPSHOT_TYPE = exports.CUSTOM_CHECK_SUMMARY_MAX_LENGTH = void 0;
+exports.CUSTOM_CHECK_RESULTS_STATUSES = exports.NETWORK_REQUESTS_SNAPSHOT_TYPE = exports.CUSTOM_CHECK_SUMMARY_MAX_LENGTH = void 0;
 /**
  * Maximum length of a custom check `summary`. The summary is rendered inline in
  * the UI, so it is truncated to this many characters when displayed rather than
@@ -14,5 +14,17 @@ exports.CUSTOM_CHECK_SUMMARY_MAX_LENGTH = 500;
  * consume it receive `Snapshot<NetworkRequestSnapshotData>` values.
  */
 exports.NETWORK_REQUESTS_SNAPSHOT_TYPE = "network-requests";
+/**
+ * Status of the custom check results reported for a test run as a whole:
+ * - `complete`: the run finished and produced a verdict for every check.
+ * - `execution-error`: computing the custom checks failed (e.g. the script
+ *   threw before producing results). This is a property of the run as a whole,
+ *   not of any individual check — an individual check only ever has a
+ *   {@link CustomCheckVerdict}.
+ */
+exports.CUSTOM_CHECK_RESULTS_STATUSES = [
+    "complete",
+    "execution-error",
+];
 //# sourceMappingURL=custom-checks.types.js.map
-//# debugId=aaa133b4-907a-5e85-b83c-765d117cdeec
+//# debugId=14a4ab8a-ebd9-5fd7-ba2b-b93055c8f39f

package/dist/custom-checks.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"custom-checks.types.js","sources":["../src/custom-checks.types.ts"],"sourceRoot":"","names":[],"mappings":";;;;;AAgDA;;;;GAIG;AACU,QAAA,+BAA+B,GAAG,GAAG,CAAC;AA4DnD;;;GAGG;AACU,QAAA,8BAA8B,GAAG,kBAAkB,CAAC","debugId":"aaa133b4-907a-5e85-b83c-765d117cdeec"}
+{"version":3,"file":"custom-checks.types.js","sources":["../src/custom-checks.types.ts"],"sourceRoot":"","names":[],"mappings":";;;;;AAoDA;;;;GAIG;AACU,QAAA,+BAA+B,GAAG,GAAG,CAAC;AA4DnD;;;GAGG;AACU,QAAA,8BAA8B,GAAG,kBAAkB,CAAC;AAyBjE;;;;;;;GAOG;AACU,QAAA,6BAA6B,GAAG;IAC3C,UAAU;IACV,iBAAiB;CACT,CAAC","debugId":"14a4ab8a-ebd9-5fd7-ba2b-b93055c8f39f"}

package/dist/index.d.ts

@@ -21,4 +21,4 @@ export { AssetUploadMetadata } from "./sdk-bundle-api/sdk-to-bundle/asset-upload
 export { S3Location } from "./s3.types";
 export { CompanionAssetsInfo } from "./sdk-bundle-api/sdk-to-bundle/companion-assets";
 export { DeploymentArchiveType } from "./sdk-bundle-api/sdk-to-bundle/deployment-archive-type";
-export { Snapshot, CustomCheckInput, CustomCheckVerdict, CustomCheckOutput, CustomCheckReport, MarkdownReport, CustomCheck, CustomCheckPluginManifest, PluginManifest, NetworkRequestSnapshotData, NETWORK_REQUESTS_SNAPSHOT_TYPE, CUSTOM_CHECK_SUMMARY_MAX_LENGTH, } from "./custom-checks.types";
+export { Snapshot, CustomCheckInput, CustomCheckVerdict, CustomCheckOutput, CustomCheckReport, MarkdownReport, CustomCheck, CustomCheckPluginManifest, PluginManifest, NetworkRequestSnapshotData, NETWORK_REQUESTS_SNAPSHOT_TYPE, CUSTOM_CHECK_SUMMARY_MAX_LENGTH, CUSTOM_CHECK_RESULTS_STATUSES, CustomCheckResultsStatus, ReportedCustomCheckResult, ReportCustomCheckResultsRequest, } from "./custom-checks.types";

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]="78889a89-65b0-5901-8866-651c405305a4")}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]="fd6dbc11-c00d-5240-9c3d-1ca64e77b08e")}catch(e){}}();
 
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -16,7 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CUSTOM_CHECK_SUMMARY_MAX_LENGTH = exports.NETWORK_REQUESTS_SNAPSHOT_TYPE = exports.CustomDataSingletonInternalKey = exports.isPrAuthorRelevance = exports.SessionRelevance = void 0;
+exports.CUSTOM_CHECK_RESULTS_STATUSES = exports.CUSTOM_CHECK_SUMMARY_MAX_LENGTH = exports.NETWORK_REQUESTS_SNAPSHOT_TYPE = exports.CustomDataSingletonInternalKey = exports.isPrAuthorRelevance = exports.SessionRelevance = void 0;
 var test_run_types_1 = require("./replay/test-run.types");
 Object.defineProperty(exports, "SessionRelevance", { enumerable: true, get: function () { return test_run_types_1.SessionRelevance; } });
 Object.defineProperty(exports, "isPrAuthorRelevance", { enumerable: true, get: function () { return test_run_types_1.isPrAuthorRelevance; } });
@@ -27,5 +27,6 @@ __exportStar(require("./sdk-bundle-api/sdk-to-bundle/event-source-data"), export
 var custom_checks_types_1 = require("./custom-checks.types");
 Object.defineProperty(exports, "NETWORK_REQUESTS_SNAPSHOT_TYPE", { enumerable: true, get: function () { return custom_checks_types_1.NETWORK_REQUESTS_SNAPSHOT_TYPE; } });
 Object.defineProperty(exports, "CUSTOM_CHECK_SUMMARY_MAX_LENGTH", { enumerable: true, get: function () { return custom_checks_types_1.CUSTOM_CHECK_SUMMARY_MAX_LENGTH; } });
+Object.defineProperty(exports, "CUSTOM_CHECK_RESULTS_STATUSES", { enumerable: true, get: function () { return custom_checks_types_1.CUSTOM_CHECK_RESULTS_STATUSES; } });
 //# sourceMappingURL=index.js.map
-//# debugId=78889a89-65b0-5901-8866-651c405305a4
+//# debugId=fd6dbc11-c00d-5240-9c3d-1ca64e77b08e

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourceRoot":"","names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAuBA,0DAaiC;AAZ/B,kHAAA,gBAAgB,OAAA;AAChB,qHAAA,mBAAmB,OAAA;AAsBrB,sFAAoE;AAQpE,4EAsBqD;AATnD,8HAAA,8BAA8B,OAAA;AAsBhC,mFAAiE;AA0DjE,6DAa+B;AAF7B,qIAAA,8BAA8B,OAAA;AAC9B,sIAAA,+BAA+B,OAAA","debugId":"78889a89-65b0-5901-8866-651c405305a4"}
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourceRoot":"","names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAuBA,0DAaiC;AAZ/B,kHAAA,gBAAgB,OAAA;AAChB,qHAAA,mBAAmB,OAAA;AAsBrB,sFAAoE;AAQpE,4EAsBqD;AATnD,8HAAA,8BAA8B,OAAA;AAsBhC,mFAAiE;AA0DjE,6DAiB+B;AAN7B,qIAAA,8BAA8B,OAAA;AAC9B,sIAAA,+BAA+B,OAAA;AAC/B,oIAAA,6BAA6B,OAAA","debugId":"fd6dbc11-c00d-5240-9c3d-1ca64e77b08e"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.288.2",
+  "version": "2.290.0",
   "description": "Meticulous API types",
   "license": "ISC",
   "main": "dist/index.js",