@alwaysmeticulous/client 2.262.1 → 2.264.0

package/dist/api/agent.api.d.ts

@@ -0,0 +1,62 @@
+import { MeticulousClient } from "../types/client.types";
+export interface DiffsSummaryOptions {
+    includeDomDiffGroups?: boolean;
+    includeImageDiffHashes?: boolean;
+    includeJsCoverageGroups?: boolean;
+    includeCssCoverageGroups?: boolean;
+    showAll?: boolean;
+}
+export interface DiffsSummaryScreenshot {
+    screenshotName: string;
+    index: number;
+    total: number;
+    outcome: string;
+    userVisibleOutcome: string;
+    mismatchFraction: number | null;
+    domDiffIds: string;
+    imageDiffId?: string;
+    jsCoverageGroupId?: string;
+    cssCoverageGroupId?: string;
+}
+export interface DiffsSummaryReplayDiff {
+    replayDiffId: string;
+    screenshots: DiffsSummaryScreenshot[];
+}
+export interface DiffsSummaryResponse {
+    jobId: string;
+    status: "pending" | "processing" | "complete" | "error";
+    progress?: string;
+    error?: string;
+    data?: DiffsSummaryReplayDiff[];
+}
+export interface ScreenshotDomDiffResponse {
+    diffs: Array<{
+        index: number;
+        content: string;
+    }>;
+    totalDiffs: number;
+}
+export interface ScreenshotUrlsResponse {
+    outcome: string;
+    screenshot?: string;
+    before?: string;
+    after?: string;
+    diffImage?: string;
+}
+export interface TimelineDiffEntry {
+    status: "identical" | "removed" | "added" | "changed";
+    timeMs: number;
+    eventKind: string;
+    description: string;
+    mismatchFraction?: number | null;
+}
+export interface TimelineDiffResponse {
+    baseReplayId: string;
+    headReplayId: string;
+    entries: TimelineDiffEntry[];
+}
+export declare const triggerTestRunDiffsSummary: (client: MeticulousClient, testRunId: string, options: DiffsSummaryOptions) => Promise<DiffsSummaryResponse>;
+export declare const getTestRunDiffsSummaryStatus: (client: MeticulousClient, testRunId: string, jobId: string) => Promise<DiffsSummaryResponse>;
+export declare const getScreenshotDomDiff: (client: MeticulousClient, replayDiffId: string, screenshotName: string, index?: number) => Promise<ScreenshotDomDiffResponse>;
+export declare const getScreenshotUrls: (client: MeticulousClient, replayDiffId: string, screenshotName: string) => Promise<ScreenshotUrlsResponse>;
+export declare const getTimelineDiff: (client: MeticulousClient, replayDiffId: string) => Promise<TimelineDiffResponse>;

package/dist/api/agent.api.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTimelineDiff = exports.getScreenshotUrls = exports.getScreenshotDomDiff = exports.getTestRunDiffsSummaryStatus = exports.triggerTestRunDiffsSummary = void 0;
+const errors_1 = require("../errors");
+// ---------------------------------------------------------------------------
+// API methods
+// ---------------------------------------------------------------------------
+const triggerTestRunDiffsSummary = async (client, testRunId, options) => {
+    const { data } = await client
+        .post(`agent/test-runs/${testRunId}/diffs-summary`, options)
+        .catch((error) => {
+        throw (0, errors_1.maybeEnrichFetchError)(error);
+    });
+    return data;
+};
+exports.triggerTestRunDiffsSummary = triggerTestRunDiffsSummary;
+const getTestRunDiffsSummaryStatus = async (client, testRunId, jobId) => {
+    const { data } = await client
+        .get(`agent/test-runs/${testRunId}/diffs-summary/${jobId}`)
+        .catch((error) => {
+        throw (0, errors_1.maybeEnrichFetchError)(error);
+    });
+    return data;
+};
+exports.getTestRunDiffsSummaryStatus = getTestRunDiffsSummaryStatus;
+const getScreenshotDomDiff = async (client, replayDiffId, screenshotName, index) => {
+    const params = { screenshotName };
+    if (index != null) {
+        params.index = String(index);
+    }
+    const { data } = await client
+        .get(`agent/replay-diffs/${replayDiffId}/screenshot-dom-diff`, { params })
+        .catch((error) => {
+        throw (0, errors_1.maybeEnrichFetchError)(error);
+    });
+    return data;
+};
+exports.getScreenshotDomDiff = getScreenshotDomDiff;
+const getScreenshotUrls = async (client, replayDiffId, screenshotName) => {
+    const { data } = await client
+        .get(`agent/replay-diffs/${replayDiffId}/screenshot-urls`, {
+        params: { screenshotName },
+    })
+        .catch((error) => {
+        throw (0, errors_1.maybeEnrichFetchError)(error);
+    });
+    return data;
+};
+exports.getScreenshotUrls = getScreenshotUrls;
+const getTimelineDiff = async (client, replayDiffId) => {
+    const { data } = await client
+        .get(`agent/replay-diffs/${replayDiffId}/timeline-diff`)
+        .catch((error) => {
+        throw (0, errors_1.maybeEnrichFetchError)(error);
+    });
+    return data;
+};
+exports.getTimelineDiff = getTimelineDiff;
+//# sourceMappingURL=agent.api.js.map

package/dist/api/agent.api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.api.js","sourceRoot":"","sources":["../../src/api/agent.api.ts"],"names":[],"mappings":";;;AAAA,sCAAkD;AAgFlD,8EAA8E;AAC9E,cAAc;AACd,8EAA8E;AAEvE,MAAM,0BAA0B,GAAG,KAAK,EAC7C,MAAwB,EACxB,SAAiB,EACjB,OAA4B,EACG,EAAE;IACjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM;SAC1B,IAAI,CAAC,mBAAmB,SAAS,gBAAgB,EAAE,OAAO,CAAC;SAC3D,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,IAAA,8BAAqB,EAAC,KAAK,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IACL,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAXW,QAAA,0BAA0B,8BAWrC;AAEK,MAAM,4BAA4B,GAAG,KAAK,EAC/C,MAAwB,EACxB,SAAiB,EACjB,KAAa,EACkB,EAAE;IACjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM;SAC1B,GAAG,CAAC,mBAAmB,SAAS,kBAAkB,KAAK,EAAE,CAAC;SAC1D,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,IAAA,8BAAqB,EAAC,KAAK,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IACL,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAXW,QAAA,4BAA4B,gCAWvC;AAEK,MAAM,oBAAoB,GAAG,KAAK,EACvC,MAAwB,EACxB,YAAoB,EACpB,cAAsB,EACtB,KAAc,EACsB,EAAE;IACtC,MAAM,MAAM,GAA2B,EAAE,cAAc,EAAE,CAAC;IAC1D,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IACD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM;SAC1B,GAAG,CAAC,sBAAsB,YAAY,sBAAsB,EAAE,EAAE,MAAM,EAAE,CAAC;SACzE,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,IAAA,8BAAqB,EAAC,KAAK,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IACL,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAhBW,QAAA,oBAAoB,wBAgB/B;AAEK,MAAM,iBAAiB,GAAG,KAAK,EACpC,MAAwB,EACxB,YAAoB,EACpB,cAAsB,EACW,EAAE;IACnC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM;SAC1B,GAAG,CAAC,sBAAsB,YAAY,kBAAkB,EAAE;QACzD,MAAM,EAAE,EAAE,cAAc,EAAE;KAC3B,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,IAAA,8BAAqB,EAAC,KAAK,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IACL,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAbW,QAAA,iBAAiB,qBAa5B;AAEK,MAAM,eAAe,GAAG,KAAK,EAClC,MAAwB,EACxB,YAAoB,EACW,EAAE;IACjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM;SAC1B,GAAG,CAAC,sBAAsB,YAAY,gBAAgB,CAAC;SACvD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,IAAA,8BAAqB,EAAC,KAAK,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IACL,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAVW,QAAA,eAAe,mBAU1B"}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export { DiffsSummaryOptions, DiffsSummaryScreenshot, DiffsSummaryReplayDiff, DiffsSummaryResponse, ScreenshotDomDiffResponse, ScreenshotUrlsResponse, TimelineDiffEntry, TimelineDiffResponse, triggerTestRunDiffsSummary, getTestRunDiffsSummaryStatus, getScreenshotDomDiff, getScreenshotUrls, getTimelineDiff, } from "./api/agent.api";
 export * from "./api/github-cloud-replay.api";
 export { WhoamiResponse, getWhoami } from "./api/oauth.api";
 export { getProject, getRepoUrl } from "./api/project.api";

package/dist/index.js

@@ -14,7 +14,13 @@ 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.getRelevantSessions = exports.isFetchError = exports.getRegistryAuth = exports.getContainerDeployment = exports.downloadProjectDeployment = exports.completeContainerUpload = exports.completeAssetUpload = exports.requestGitDiffUpload = exports.requestUploadPart = exports.requestMultipartAssetUpload = exports.requestAssetUpload = exports.getProxyAgent = exports.clearOAuthTokens = exports.getValidAccessToken = exports.performOAuthLogin = exports.makeRequest = exports.isInteractiveContext = exports.createClientWithOAuth = exports.createClient = exports.getAuthToken = exports.getApiToken = exports.IN_PROGRESS_TEST_RUN_STATUS = exports.getIsLocked = exports.emitTelemetry = exports.getLatestTestRunResults = exports.getTestRunReplayDiffs = exports.getTestRunData = exports.getTestRun = exports.executeSecureTunnelTestRun = exports.getPrDiff = exports.getReplayDiff = exports.postSessionIdNotification = exports.getRecordingCommandId = exports.getRecordedSessionData = exports.getRecordedSession = exports.getReplayV3DownloadUrls = exports.getReplayDownloadUrl = exports.getReplay = exports.getRepoUrl = exports.getProject = exports.getWhoami = void 0;
+exports.getRelevantSessions = exports.isFetchError = exports.getRegistryAuth = exports.getContainerDeployment = exports.downloadProjectDeployment = exports.completeContainerUpload = exports.completeAssetUpload = exports.requestGitDiffUpload = exports.requestUploadPart = exports.requestMultipartAssetUpload = exports.requestAssetUpload = exports.getProxyAgent = exports.clearOAuthTokens = exports.getValidAccessToken = exports.performOAuthLogin = exports.makeRequest = exports.isInteractiveContext = exports.createClientWithOAuth = exports.createClient = exports.getAuthToken = exports.getApiToken = exports.IN_PROGRESS_TEST_RUN_STATUS = exports.getIsLocked = exports.emitTelemetry = exports.getLatestTestRunResults = exports.getTestRunReplayDiffs = exports.getTestRunData = exports.getTestRun = exports.executeSecureTunnelTestRun = exports.getPrDiff = exports.getReplayDiff = exports.postSessionIdNotification = exports.getRecordingCommandId = exports.getRecordedSessionData = exports.getRecordedSession = exports.getReplayV3DownloadUrls = exports.getReplayDownloadUrl = exports.getReplay = exports.getRepoUrl = exports.getProject = exports.getWhoami = exports.getTimelineDiff = exports.getScreenshotUrls = exports.getScreenshotDomDiff = exports.getTestRunDiffsSummaryStatus = exports.triggerTestRunDiffsSummary = void 0;
+var agent_api_1 = require("./api/agent.api");
+Object.defineProperty(exports, "triggerTestRunDiffsSummary", { enumerable: true, get: function () { return agent_api_1.triggerTestRunDiffsSummary; } });
+Object.defineProperty(exports, "getTestRunDiffsSummaryStatus", { enumerable: true, get: function () { return agent_api_1.getTestRunDiffsSummaryStatus; } });
+Object.defineProperty(exports, "getScreenshotDomDiff", { enumerable: true, get: function () { return agent_api_1.getScreenshotDomDiff; } });
+Object.defineProperty(exports, "getScreenshotUrls", { enumerable: true, get: function () { return agent_api_1.getScreenshotUrls; } });
+Object.defineProperty(exports, "getTimelineDiff", { enumerable: true, get: function () { return agent_api_1.getTimelineDiff; } });
 __exportStar(require("./api/github-cloud-replay.api"), exports);
 var oauth_api_1 = require("./api/oauth.api");
 Object.defineProperty(exports, "getWhoami", { enumerable: true, get: function () { return oauth_api_1.getWhoami; } });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,gEAA8C;AAC9C,6CAA4D;AAAnC,sGAAA,SAAS,OAAA;AAClC,iDAA2D;AAAlD,yGAAA,UAAU,OAAA;AAAE,yGAAA,UAAU,OAAA;AAK/B,+CAK0B;AAHxB,uGAAA,SAAS,OAAA;AACT,kHAAA,oBAAoB,OAAA;AACpB,qHAAA,uBAAuB,OAAA;AAEzB,iDAK2B;AAJzB,iHAAA,kBAAkB,OAAA;AAClB,qHAAA,sBAAsB,OAAA;AACtB,oHAAA,qBAAqB,OAAA;AACrB,wHAAA,yBAAyB,OAAA;AAE3B,yDAA0E;AAA7C,gHAAA,aAAa,OAAA;AAC1C,yDAAkD;AAAzC,4GAAA,SAAS,OAAA;AAClB,mDAU4B;AAR1B,0HAAA,0BAA0B,OAAA;AAC1B,0GAAA,UAAU,OAAA;AACV,8GAAA,cAAc,OAAA;AACd,qHAAA,qBAAqB,OAAA;AAErB,uHAAA,uBAAuB,OAAA;AAEvB,6GAAA,aAAa,OAAA;AAEf,iEAA4E;AAA/C,kHAAA,WAAW,OAAA;AACxC,+DAAuE;AAA9D,iIAAA,2BAA2B,OAAA;AACpC,qDAA8D;AAArD,8GAAA,WAAW,OAAA;AAAE,+GAAA,YAAY,OAAA;AAClC,mCAMkB;AAJhB,sGAAA,YAAY,OAAA;AACZ,+GAAA,qBAAqB,OAAA;AACrB,8GAAA,oBAAoB,OAAA;AACpB,qGAAA,WAAW,OAAA;AAEb,mDAAwD;AAA/C,gHAAA,iBAAiB,OAAA;AAC1B,uDAA4D;AAAnD,oHAAA,mBAAmB,OAAA;AAC5B,+DAA6D;AAApD,qHAAA,gBAAgB,OAAA;AAEzB,2DAAwD;AAA/C,gHAAA,aAAa,OAAA;AACtB,yEAwBuC;AArBrC,6HAAA,kBAAkB,OAAA;AAClB,sIAAA,2BAA2B,OAAA;AAI3B,4HAAA,iBAAiB,OAAA;AAGjB,+HAAA,oBAAoB,OAAA;AAGpB,8HAAA,mBAAmB,OAAA;AAGnB,kIAAA,uBAAuB,OAAA;AAGvB,oIAAA,yBAAyB,OAAA;AAEzB,iIAAA,sBAAsB,OAAA;AAGxB,mDAA8E;AAA5C,+GAAA,eAAe,OAAA;AACjD,mCAAwC;AAA/B,sGAAA,YAAY,OAAA;AACrB,6DAMiC;AAD/B,wHAAA,mBAAmB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,6CAcyB;AALvB,uHAAA,0BAA0B,OAAA;AAC1B,yHAAA,4BAA4B,OAAA;AAC5B,iHAAA,oBAAoB,OAAA;AACpB,8GAAA,iBAAiB,OAAA;AACjB,4GAAA,eAAe,OAAA;AAEjB,gEAA8C;AAC9C,6CAA4D;AAAnC,sGAAA,SAAS,OAAA;AAClC,iDAA2D;AAAlD,yGAAA,UAAU,OAAA;AAAE,yGAAA,UAAU,OAAA;AAK/B,+CAK0B;AAHxB,uGAAA,SAAS,OAAA;AACT,kHAAA,oBAAoB,OAAA;AACpB,qHAAA,uBAAuB,OAAA;AAEzB,iDAK2B;AAJzB,iHAAA,kBAAkB,OAAA;AAClB,qHAAA,sBAAsB,OAAA;AACtB,oHAAA,qBAAqB,OAAA;AACrB,wHAAA,yBAAyB,OAAA;AAE3B,yDAA0E;AAA7C,gHAAA,aAAa,OAAA;AAC1C,yDAAkD;AAAzC,4GAAA,SAAS,OAAA;AAClB,mDAU4B;AAR1B,0HAAA,0BAA0B,OAAA;AAC1B,0GAAA,UAAU,OAAA;AACV,8GAAA,cAAc,OAAA;AACd,qHAAA,qBAAqB,OAAA;AAErB,uHAAA,uBAAuB,OAAA;AAEvB,6GAAA,aAAa,OAAA;AAEf,iEAA4E;AAA/C,kHAAA,WAAW,OAAA;AACxC,+DAAuE;AAA9D,iIAAA,2BAA2B,OAAA;AACpC,qDAA8D;AAArD,8GAAA,WAAW,OAAA;AAAE,+GAAA,YAAY,OAAA;AAClC,mCAMkB;AAJhB,sGAAA,YAAY,OAAA;AACZ,+GAAA,qBAAqB,OAAA;AACrB,8GAAA,oBAAoB,OAAA;AACpB,qGAAA,WAAW,OAAA;AAEb,mDAAwD;AAA/C,gHAAA,iBAAiB,OAAA;AAC1B,uDAA4D;AAAnD,oHAAA,mBAAmB,OAAA;AAC5B,+DAA6D;AAApD,qHAAA,gBAAgB,OAAA;AAEzB,2DAAwD;AAA/C,gHAAA,aAAa,OAAA;AACtB,yEAwBuC;AArBrC,6HAAA,kBAAkB,OAAA;AAClB,sIAAA,2BAA2B,OAAA;AAI3B,4HAAA,iBAAiB,OAAA;AAGjB,+HAAA,oBAAoB,OAAA;AAGpB,8HAAA,mBAAmB,OAAA;AAGnB,kIAAA,uBAAuB,OAAA;AAGvB,oIAAA,yBAAyB,OAAA;AAEzB,iIAAA,sBAAsB,OAAA;AAGxB,mDAA8E;AAA5C,+GAAA,eAAe,OAAA;AACjD,mCAAwC;AAA/B,sGAAA,YAAY,OAAA;AACrB,6DAMiC;AAD/B,wHAAA,mBAAmB,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/client",
-  "version": "2.262.1",
+  "version": "2.264.0",
   "description": "Helper methods for using the Meticulous backend API",
   "license": "ISC",
   "main": "dist/index.js",
@@ -19,8 +19,8 @@
     "depcheck": "depcheck --ignore-patterns=dist"
   },
   "dependencies": {
-    "@alwaysmeticulous/api": "2.262.0",
-    "@alwaysmeticulous/common": "2.262.1",
+    "@alwaysmeticulous/api": "2.264.0",
+    "@alwaysmeticulous/common": "2.264.0",
     "loglevel": "^1.8.0",
     "node-fetch": "^2.6.9",
     "proxy-agent": "^6.4.0"
@@ -45,5 +45,5 @@
   "devDependencies": {
     "@types/node-fetch": "^2.6.13"
   },
-  "gitHead": "e10f7d08b09a5c68d3a15f9c85646bb8e255348e"
+  "gitHead": "6296ae8e1b450b160eef2c0b84134a35a9fff8db"
 }