@alwaysmeticulous/client 2.264.0 → 2.264.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/agent.api.d.ts +16 -1
- package/dist/api/agent.api.js +16 -9
- package/dist/api/agent.api.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/dist/api/agent.api.d.ts
CHANGED
|
@@ -4,6 +4,7 @@ export interface DiffsSummaryOptions {
|
|
|
4
4
|
includeImageDiffHashes?: boolean;
|
|
5
5
|
includeJsCoverageGroups?: boolean;
|
|
6
6
|
includeCssCoverageGroups?: boolean;
|
|
7
|
+
includeReplayIds?: boolean;
|
|
7
8
|
showAll?: boolean;
|
|
8
9
|
}
|
|
9
10
|
export interface DiffsSummaryScreenshot {
|
|
@@ -20,6 +21,8 @@ export interface DiffsSummaryScreenshot {
|
|
|
20
21
|
}
|
|
21
22
|
export interface DiffsSummaryReplayDiff {
|
|
22
23
|
replayDiffId: string;
|
|
24
|
+
baseReplayId?: string;
|
|
25
|
+
headReplayId?: string;
|
|
23
26
|
screenshots: DiffsSummaryScreenshot[];
|
|
24
27
|
}
|
|
25
28
|
export interface DiffsSummaryResponse {
|
|
@@ -29,6 +32,17 @@ export interface DiffsSummaryResponse {
|
|
|
29
32
|
error?: string;
|
|
30
33
|
data?: DiffsSummaryReplayDiff[];
|
|
31
34
|
}
|
|
35
|
+
export interface DiffsSummaryJob {
|
|
36
|
+
jobId: string;
|
|
37
|
+
testRunId: string;
|
|
38
|
+
status: "pending" | "processing" | "complete" | "error";
|
|
39
|
+
progress?: string;
|
|
40
|
+
error?: string;
|
|
41
|
+
createdAt: number;
|
|
42
|
+
}
|
|
43
|
+
export interface DiffsSummaryJobsResponse {
|
|
44
|
+
jobs: DiffsSummaryJob[];
|
|
45
|
+
}
|
|
32
46
|
export interface ScreenshotDomDiffResponse {
|
|
33
47
|
diffs: Array<{
|
|
34
48
|
index: number;
|
|
@@ -55,8 +69,9 @@ export interface TimelineDiffResponse {
|
|
|
55
69
|
headReplayId: string;
|
|
56
70
|
entries: TimelineDiffEntry[];
|
|
57
71
|
}
|
|
72
|
+
export declare const getDiffsSummaryJobs: (client: MeticulousClient) => Promise<DiffsSummaryJobsResponse>;
|
|
58
73
|
export declare const triggerTestRunDiffsSummary: (client: MeticulousClient, testRunId: string, options: DiffsSummaryOptions) => Promise<DiffsSummaryResponse>;
|
|
59
|
-
export declare const getTestRunDiffsSummaryStatus: (client: MeticulousClient,
|
|
74
|
+
export declare const getTestRunDiffsSummaryStatus: (client: MeticulousClient, jobId: string) => Promise<DiffsSummaryResponse>;
|
|
60
75
|
export declare const getScreenshotDomDiff: (client: MeticulousClient, replayDiffId: string, screenshotName: string, index?: number) => Promise<ScreenshotDomDiffResponse>;
|
|
61
76
|
export declare const getScreenshotUrls: (client: MeticulousClient, replayDiffId: string, screenshotName: string) => Promise<ScreenshotUrlsResponse>;
|
|
62
77
|
export declare const getTimelineDiff: (client: MeticulousClient, replayDiffId: string) => Promise<TimelineDiffResponse>;
|
package/dist/api/agent.api.js
CHANGED
|
@@ -1,22 +1,31 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.getTimelineDiff = exports.getScreenshotUrls = exports.getScreenshotDomDiff = exports.getTestRunDiffsSummaryStatus = exports.triggerTestRunDiffsSummary = void 0;
|
|
3
|
+
exports.getTimelineDiff = exports.getScreenshotUrls = exports.getScreenshotDomDiff = exports.getTestRunDiffsSummaryStatus = exports.triggerTestRunDiffsSummary = exports.getDiffsSummaryJobs = void 0;
|
|
4
4
|
const errors_1 = require("../errors");
|
|
5
5
|
// ---------------------------------------------------------------------------
|
|
6
6
|
// API methods
|
|
7
7
|
// ---------------------------------------------------------------------------
|
|
8
|
+
const getDiffsSummaryJobs = async (client) => {
|
|
9
|
+
const { data } = await client
|
|
10
|
+
.get("agent/test-runs/diffs-summary-jobs")
|
|
11
|
+
.catch((error) => {
|
|
12
|
+
throw (0, errors_1.maybeEnrichFetchError)(error);
|
|
13
|
+
});
|
|
14
|
+
return data;
|
|
15
|
+
};
|
|
16
|
+
exports.getDiffsSummaryJobs = getDiffsSummaryJobs;
|
|
8
17
|
const triggerTestRunDiffsSummary = async (client, testRunId, options) => {
|
|
9
18
|
const { data } = await client
|
|
10
|
-
.post(
|
|
19
|
+
.post("agent/test-runs/diffs-summary-jobs", { testRunId, ...options })
|
|
11
20
|
.catch((error) => {
|
|
12
21
|
throw (0, errors_1.maybeEnrichFetchError)(error);
|
|
13
22
|
});
|
|
14
23
|
return data;
|
|
15
24
|
};
|
|
16
25
|
exports.triggerTestRunDiffsSummary = triggerTestRunDiffsSummary;
|
|
17
|
-
const getTestRunDiffsSummaryStatus = async (client,
|
|
26
|
+
const getTestRunDiffsSummaryStatus = async (client, jobId) => {
|
|
18
27
|
const { data } = await client
|
|
19
|
-
.get(`agent/test-runs
|
|
28
|
+
.get(`agent/test-runs/diffs-summary-jobs/${jobId}`)
|
|
20
29
|
.catch((error) => {
|
|
21
30
|
throw (0, errors_1.maybeEnrichFetchError)(error);
|
|
22
31
|
});
|
|
@@ -24,12 +33,12 @@ const getTestRunDiffsSummaryStatus = async (client, testRunId, jobId) => {
|
|
|
24
33
|
};
|
|
25
34
|
exports.getTestRunDiffsSummaryStatus = getTestRunDiffsSummaryStatus;
|
|
26
35
|
const getScreenshotDomDiff = async (client, replayDiffId, screenshotName, index) => {
|
|
27
|
-
const params = {
|
|
36
|
+
const params = {};
|
|
28
37
|
if (index != null) {
|
|
29
38
|
params.index = String(index);
|
|
30
39
|
}
|
|
31
40
|
const { data } = await client
|
|
32
|
-
.get(`agent/replay-diffs/${replayDiffId}/
|
|
41
|
+
.get(`agent/replay-diffs/${replayDiffId}/screenshots/${encodeURIComponent(screenshotName)}/dom-diff`, { params })
|
|
33
42
|
.catch((error) => {
|
|
34
43
|
throw (0, errors_1.maybeEnrichFetchError)(error);
|
|
35
44
|
});
|
|
@@ -38,9 +47,7 @@ const getScreenshotDomDiff = async (client, replayDiffId, screenshotName, index)
|
|
|
38
47
|
exports.getScreenshotDomDiff = getScreenshotDomDiff;
|
|
39
48
|
const getScreenshotUrls = async (client, replayDiffId, screenshotName) => {
|
|
40
49
|
const { data } = await client
|
|
41
|
-
.get(`agent/replay-diffs/${replayDiffId}/
|
|
42
|
-
params: { screenshotName },
|
|
43
|
-
})
|
|
50
|
+
.get(`agent/replay-diffs/${replayDiffId}/screenshots/${encodeURIComponent(screenshotName)}/image-urls`)
|
|
44
51
|
.catch((error) => {
|
|
45
52
|
throw (0, errors_1.maybeEnrichFetchError)(error);
|
|
46
53
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"agent.api.js","sourceRoot":"","sources":["../../src/api/agent.api.ts"],"names":[],"mappings":";;;AAAA,sCAAkD;
|
|
1
|
+
{"version":3,"file":"agent.api.js","sourceRoot":"","sources":["../../src/api/agent.api.ts"],"names":[],"mappings":";;;AAAA,sCAAkD;AAoGlD,8EAA8E;AAC9E,cAAc;AACd,8EAA8E;AAEvE,MAAM,mBAAmB,GAAG,KAAK,EACtC,MAAwB,EACW,EAAE;IACrC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM;SAC1B,GAAG,CAAC,oCAAoC,CAAC;SACzC,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;AATW,QAAA,mBAAmB,uBAS9B;AAEK,MAAM,0BAA0B,GAAG,KAAK,EAC7C,MAAwB,EACxB,SAAiB,EACjB,OAA4B,EACG,EAAE;IACjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM;SAC1B,IAAI,CAAC,oCAAoC,EAAE,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,CAAC;SACrE,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,KAAa,EACkB,EAAE;IACjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM;SAC1B,GAAG,CAAC,sCAAsC,KAAK,EAAE,CAAC;SAClD,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,4BAA4B,gCAUvC;AAEK,MAAM,oBAAoB,GAAG,KAAK,EACvC,MAAwB,EACxB,YAAoB,EACpB,cAAsB,EACtB,KAAc,EACsB,EAAE;IACtC,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,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,CACF,sBAAsB,YAAY,gBAAgB,kBAAkB,CAAC,cAAc,CAAC,WAAW,EAC/F,EAAE,MAAM,EAAE,CACX;SACA,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;AAnBW,QAAA,oBAAoB,wBAmB/B;AAEK,MAAM,iBAAiB,GAAG,KAAK,EACpC,MAAwB,EACxB,YAAoB,EACpB,cAAsB,EACW,EAAE;IACnC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM;SAC1B,GAAG,CACF,sBAAsB,YAAY,gBAAgB,kBAAkB,CAAC,cAAc,CAAC,aAAa,CAClG;SACA,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
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { DiffsSummaryOptions, DiffsSummaryScreenshot, DiffsSummaryReplayDiff, DiffsSummaryResponse, ScreenshotDomDiffResponse, ScreenshotUrlsResponse, TimelineDiffEntry, TimelineDiffResponse, triggerTestRunDiffsSummary, getTestRunDiffsSummaryStatus, getScreenshotDomDiff, getScreenshotUrls, getTimelineDiff, } from "./api/agent.api";
|
|
1
|
+
export { DiffsSummaryOptions, DiffsSummaryScreenshot, DiffsSummaryReplayDiff, DiffsSummaryResponse, DiffsSummaryJob, DiffsSummaryJobsResponse, getDiffsSummaryJobs, ScreenshotDomDiffResponse, ScreenshotUrlsResponse, TimelineDiffEntry, TimelineDiffResponse, triggerTestRunDiffsSummary, getTestRunDiffsSummaryStatus, getScreenshotDomDiff, getScreenshotUrls, getTimelineDiff, } from "./api/agent.api";
|
|
2
2
|
export * from "./api/github-cloud-replay.api";
|
|
3
3
|
export { WhoamiResponse, getWhoami } from "./api/oauth.api";
|
|
4
4
|
export { getProject, getRepoUrl } from "./api/project.api";
|
package/dist/index.js
CHANGED
|
@@ -14,8 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
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;
|
|
17
|
+
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 = exports.getDiffsSummaryJobs = void 0;
|
|
18
18
|
var agent_api_1 = require("./api/agent.api");
|
|
19
|
+
Object.defineProperty(exports, "getDiffsSummaryJobs", { enumerable: true, get: function () { return agent_api_1.getDiffsSummaryJobs; } });
|
|
19
20
|
Object.defineProperty(exports, "triggerTestRunDiffsSummary", { enumerable: true, get: function () { return agent_api_1.triggerTestRunDiffsSummary; } });
|
|
20
21
|
Object.defineProperty(exports, "getTestRunDiffsSummaryStatus", { enumerable: true, get: function () { return agent_api_1.getTestRunDiffsSummaryStatus; } });
|
|
21
22
|
Object.defineProperty(exports, "getScreenshotDomDiff", { enumerable: true, get: function () { return agent_api_1.getScreenshotDomDiff; } });
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,6CAiByB;AAVvB,gHAAA,mBAAmB,OAAA;AAKnB,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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alwaysmeticulous/client",
|
|
3
|
-
"version": "2.264.
|
|
3
|
+
"version": "2.264.1",
|
|
4
4
|
"description": "Helper methods for using the Meticulous backend API",
|
|
5
5
|
"license": "ISC",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -45,5 +45,5 @@
|
|
|
45
45
|
"devDependencies": {
|
|
46
46
|
"@types/node-fetch": "^2.6.13"
|
|
47
47
|
},
|
|
48
|
-
"gitHead": "
|
|
48
|
+
"gitHead": "90b491b91254cc779bcfc966efe28a5e547e6264"
|
|
49
49
|
}
|