@alwaysmeticulous/api 2.288.0 → 2.289.1

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

@@ -0,0 +1,117 @@
+import { HarRequest, HarResponse } from "./sdk-bundle-api/sdk-to-bundle/har-log";
+/**
+ * Types for authoring custom checks. A custom check compares the snapshots
+ * captured during the base and head replays of a test run and returns a verdict
+ * plus a report that is surfaced in the Meticulous UI.
+ */
+/**
+ * A piece of data captured at a point during a replay, to be compared by a
+ * custom check. A check may receive multiple snapshots sharing the same `type`,
+ * `sessionId` and `stageDuringSession`; it should align the base and head
+ * snapshots and base its verdict only on the differences (pre-existing issues
+ * are ignored, consistent with Meticulous's semantics).
+ */
+export interface Snapshot<T = unknown> {
+    /** The snapshot kind, e.g. "network-requests" or a customer-defined type. */
+    type: string;
+    /** The recorded session the snapshot was captured during. */
+    sessionId: string;
+    /**
+     * Where in the session the snapshot was captured, identified by the screenshot
+     * taken at that point (e.g. "screenshot-after-event-2", "final-state").
+     */
+    stageDuringSession: string;
+    data: T;
+}
+/** The base and head snapshots passed to a custom check. */
+export interface CustomCheckInput {
+    baseSnapshots: Snapshot[];
+    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.
+ *
+ * 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";
+/**
+ * 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
+ * relying on plugin authors to keep it short.
+ */
+export declare const CUSTOM_CHECK_SUMMARY_MAX_LENGTH = 500;
+/** The result a custom check returns after comparing the snapshots. */
+export interface CustomCheckOutput {
+    verdict: CustomCheckVerdict;
+    /**
+     * A short summary shown inline in the UI, e.g. "+30mb inc bundle size".
+     * Truncated to {@link CUSTOM_CHECK_SUMMARY_MAX_LENGTH} characters when displayed.
+     */
+    summary?: string;
+    report: CustomCheckReport;
+}
+/** A report rendered in the UI when the check is opened. Markdown for now. */
+export type CustomCheckReport = MarkdownReport;
+export interface MarkdownReport {
+    type: "markdown";
+    markdown: string;
+}
+/**
+ * The contract a custom check implements: `execute` compares the base and head
+ * snapshots and returns a verdict and report.
+ */
+export interface CustomCheck {
+    execute: (input: CustomCheckInput) => Promise<CustomCheckOutput>;
+}
+/**
+ * Manifest describing a custom check plugin to Meticulous. It sits alongside the
+ * built entrypoint and is loaded (without executing the check) so the check can
+ * be discovered ahead of time.
+ */
+export interface CustomCheckPluginManifest {
+    /** Stable identifier for the check, e.g. "accessibility-check". */
+    id: string;
+    type: "custom-check";
+    /** Plugin version, e.g. "1.0.0". */
+    version: string;
+    configuration: {
+        /** Name shown in the UI, e.g. "Accessibility". */
+        displayName: string;
+        /** The snapshot types this check consumes, e.g. ["network-requests"]. */
+        handlesSnapshotTypes: string[];
+        /** Path to the built entrypoint, relative to the manifest, e.g. "./entrypoint.js". */
+        entryPoint: string;
+    };
+}
+/** A Meticulous plugin manifest. Only custom checks are supported today. */
+export type PluginManifest = CustomCheckPluginManifest;
+/**
+ * The snapshot `type` of the built-in network requests snapshot. Checks that
+ * consume it receive `Snapshot<NetworkRequestSnapshotData>` values.
+ */
+export declare const NETWORK_REQUESTS_SNAPSHOT_TYPE = "network-requests";
+/**
+ * `data` of a built-in "network-requests" snapshot: a single xhr/fetch request
+ * captured during the replay, with the stubbed response that was served.
+ *
+ * `requestBody`/`responseBody` may be truncated (large bodies are ellipsized
+ * with an MD5 of the remainder, so body changes are still detectable); url,
+ * method, status and headers are captured in full.
+ */
+export interface NetworkRequestSnapshotData {
+    url: string;
+    method: string;
+    requestHeaders: HarRequest["headers"];
+    requestBody?: string;
+    /** Status of the response served, or null if the request was not matched. */
+    status: number | null;
+    responseHeaders: HarResponse["headers"];
+    responseBody?: string;
+    /** Whether the request was matched to a recorded request and stubbed. */
+    matched: boolean;
+}

package/dist/custom-checks.types.js

@@ -0,0 +1,18 @@
+"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]="ead46771-c69a-5d16-8a48-a04e6e5098b8")}catch(e){}}();
+
+Object.defineProperty(exports, "__esModule", { value: true });
+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
+ * relying on plugin authors to keep it short.
+ */
+exports.CUSTOM_CHECK_SUMMARY_MAX_LENGTH = 500;
+/**
+ * The snapshot `type` of the built-in network requests snapshot. Checks that
+ * consume it receive `Snapshot<NetworkRequestSnapshotData>` values.
+ */
+exports.NETWORK_REQUESTS_SNAPSHOT_TYPE = "network-requests";
+//# sourceMappingURL=custom-checks.types.js.map
+//# debugId=ead46771-c69a-5d16-8a48-a04e6e5098b8

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

@@ -0,0 +1 @@
+{"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","debugId":"ead46771-c69a-5d16-8a48-a04e6e5098b8"}

package/dist/index.d.ts

@@ -21,3 +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";

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]="9e91b78d-59c2-5275-9eb5-0d4021984eb6")}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]="78889a89-65b0-5901-8866-651c405305a4")}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.CustomDataSingletonInternalKey = exports.isPrAuthorRelevance = exports.SessionRelevance = void 0;
+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; } });
@@ -24,5 +24,8 @@ __exportStar(require("./sdk-bundle-api/sdk-to-bundle/test-run-environment"), exp
 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);
+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; } });
 //# sourceMappingURL=index.js.map
-//# debugId=9e91b78d-59c2-5275-9eb5-0d4021984eb6
+//# debugId=78889a89-65b0-5901-8866-651c405305a4

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","debugId":"9e91b78d-59c2-5275-9eb5-0d4021984eb6"}
+{"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"}

package/package.json

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