@alwaysmeticulous/api 2.242.6 → 2.248.0
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/index.d.ts +2 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/replay/test-run.types.d.ts +14 -0
- package/dist/replay/test-run.types.js.map +1 -1
- package/dist/sdk-bundle-api/sdk-to-bundle/event-source-data.d.ts +36 -0
- package/dist/sdk-bundle-api/sdk-to-bundle/event-source-data.js +3 -0
- package/dist/sdk-bundle-api/sdk-to-bundle/event-source-data.js.map +1 -0
- package/dist/sdk-bundle-api/sdk-to-bundle/network-stubbing.d.ts +2 -1
- package/dist/sdk-bundle-api/sdk-to-bundle/session-data.d.ts +5 -0
- package/dist/sdk-bundle-api/sdk-to-bundle/session-data.js.map +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
export { Organization } from "./organization.types";
|
|
2
2
|
export { Project, ProjectSettingsScreenshottingOptions } from "./project.types";
|
|
3
3
|
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";
|
|
4
|
-
export { SessionRelevance, isPrAuthorRelevance, TestCase, TestCaseReplayOptions, TestRunStatus, TestCaseResult, TestCaseResultStatus, } from "./replay/test-run.types";
|
|
4
|
+
export { SessionRelevance, isPrAuthorRelevance, TestCase, TestCaseReplayOptions, TestRunStatus, TestCaseResult, TestCaseResultStatus, TestRunDataLocations, } from "./replay/test-run.types";
|
|
5
5
|
export { TestRunChunkStatus } from "./replay/test-run-chunk.types";
|
|
6
6
|
export * from "./sdk-bundle-api/sdk-to-bundle/test-run-environment";
|
|
7
7
|
export { ReplayableEvent } from "./sdk-bundle-api/bidirectional/replayable-event";
|
|
8
8
|
export { HarEntry, HarLog, HarRequest, HarResponse, } from "./sdk-bundle-api/sdk-to-bundle/har-log";
|
|
9
9
|
export { Cookie, SessionData, UrlHistoryEvent, WindowData, ApplicationSpecificData, StorageEntry, EarlyRequest, SerializedIDBValidKey, IDBObjectStoreMetadata, IDBObjectStoreSnapshot, IDBObjectStoreWithEntries, IDBIndexSnapshot, CustomDataSingletonInternalKey, CustomDataSingletonInternalValues, CustomData, CustomUserEvent, SessionContext, ExpiringImage, } from "./sdk-bundle-api/sdk-to-bundle/session-data";
|
|
10
10
|
export { SequenceNumber, WebSocketConnectionData, WebSocketConnectionEvent, WebSocketConnectionCreatedEvent, WebSocketConnectionOpenedEvent, EncodedArrayBuffer, EncodedBlob, WebSocketConnectionMessageEvent, WebSocketConnectionErrorEvent, WebSocketConnectionClosedEvent, } from "./sdk-bundle-api/sdk-to-bundle/websocket-data";
|
|
11
|
+
export * from "./sdk-bundle-api/sdk-to-bundle/event-source-data";
|
|
11
12
|
export { Replay } from "./replay/replay.types";
|
|
12
13
|
export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, ScreenshottingEnabledOptions, StoryboardOptions, ScreenshotDiffOptions, ElementToIgnore, CSSSelectorToIgnore, } from "./sdk-bundle-api/sdk-to-bundle/screenshotting-options";
|
|
13
14
|
export { NetworkStubbingMode, StubAllRequests, StubNonSSRRequests, NoStubbing, CustomStubbing, RequestFilter, CustomTransformation, CustomTransformationWhere, } from "./sdk-bundle-api/sdk-to-bundle/network-stubbing";
|
package/dist/index.js
CHANGED
|
@@ -21,4 +21,5 @@ Object.defineProperty(exports, "isPrAuthorRelevance", { enumerable: true, get: f
|
|
|
21
21
|
__exportStar(require("./sdk-bundle-api/sdk-to-bundle/test-run-environment"), exports);
|
|
22
22
|
var session_data_1 = require("./sdk-bundle-api/sdk-to-bundle/session-data");
|
|
23
23
|
Object.defineProperty(exports, "CustomDataSingletonInternalKey", { enumerable: true, get: function () { return session_data_1.CustomDataSingletonInternalKey; } });
|
|
24
|
+
__exportStar(require("./sdk-bundle-api/sdk-to-bundle/event-source-data"), exports);
|
|
24
25
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAsBA,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAsBA,0DASiC;AAR/B,kHAAA,gBAAgB,OAAA;AAChB,qHAAA,mBAAmB,OAAA;AASrB,sFAAoE;AAQpE,4EAmBqD;AANnD,8HAAA,8BAA8B,OAAA;AAmBhC,mFAAiE"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { S3Location } from "../s3.types";
|
|
1
2
|
import { ScreenshotDiffOptions } from "../sdk-bundle-api/sdk-to-bundle/screenshotting-options";
|
|
2
3
|
/**
|
|
3
4
|
* Relevance of a session
|
|
@@ -57,3 +58,16 @@ export interface TestCaseResult extends TestCase {
|
|
|
57
58
|
*/
|
|
58
59
|
result: TestCaseResultStatus;
|
|
59
60
|
}
|
|
61
|
+
export interface TestRunDataLocations {
|
|
62
|
+
coverage: S3Location;
|
|
63
|
+
coverageStats: S3Location;
|
|
64
|
+
coveragePr: S3Location;
|
|
65
|
+
coverageStatsPr: S3Location;
|
|
66
|
+
coverageReplaysByFile?: S3Location;
|
|
67
|
+
coverageReplaysByFileUnmapped?: S3Location;
|
|
68
|
+
coverageScreenshotReplaysByFile?: S3Location;
|
|
69
|
+
coverageScreenshotReplaysByFileUnmapped?: S3Location;
|
|
70
|
+
coverageByReplayPr?: S3Location;
|
|
71
|
+
diversityByReplay?: S3Location;
|
|
72
|
+
relevantReplayContexts: S3Location;
|
|
73
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"test-run.types.js","sourceRoot":"","sources":["../../src/replay/test-run.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"test-run.types.js","sourceRoot":"","sources":["../../src/replay/test-run.types.ts"],"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,GAAhB,wBAAgB,KAAhB,wBAAgB,QAQ3B;AAEM,MAAM,mBAAmB,GAAG,CACjC,SAA8C,EACrC,EAAE;IACX,IAAI,CAAC,SAAS,EAAE;QACd,OAAO,KAAK,CAAC;KACd;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"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { SequenceNumber } from "./websocket-data";
|
|
2
|
+
export interface EventSourceConnectionData {
|
|
3
|
+
id: SequenceNumber;
|
|
4
|
+
url: string;
|
|
5
|
+
withCredentials: boolean;
|
|
6
|
+
events: EventSourceConnectionEvent[];
|
|
7
|
+
}
|
|
8
|
+
export type EventSourceConnectionEvent = EventSourceConnectionCreatedEvent | EventSourceConnectionOpenedEvent | EventSourceConnectionMessageEvent | EventSourceConnectionErrorEvent | EventSourceConnectionClosedEvent;
|
|
9
|
+
export interface EventSourceConnectionGenericEvent {
|
|
10
|
+
/** Timestamp in milliseconds since session start (performance.now()) */
|
|
11
|
+
timestamp: number;
|
|
12
|
+
type: unknown;
|
|
13
|
+
}
|
|
14
|
+
export interface EventSourceConnectionCreatedEvent extends EventSourceConnectionGenericEvent {
|
|
15
|
+
type: "created";
|
|
16
|
+
}
|
|
17
|
+
export interface EventSourceConnectionOpenedEvent extends EventSourceConnectionGenericEvent {
|
|
18
|
+
type: "opened";
|
|
19
|
+
}
|
|
20
|
+
export interface EventSourceConnectionMessageEvent extends EventSourceConnectionGenericEvent {
|
|
21
|
+
type: "message-received";
|
|
22
|
+
data: {
|
|
23
|
+
/** The event type (e.g., "message" for unnamed events, or custom event names) */
|
|
24
|
+
eventType: string;
|
|
25
|
+
/** The data payload from the SSE message */
|
|
26
|
+
data: string;
|
|
27
|
+
/** Optional last event ID from the SSE stream */
|
|
28
|
+
lastEventId?: string;
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
export interface EventSourceConnectionErrorEvent extends EventSourceConnectionGenericEvent {
|
|
32
|
+
type: "error";
|
|
33
|
+
}
|
|
34
|
+
export interface EventSourceConnectionClosedEvent extends EventSourceConnectionGenericEvent {
|
|
35
|
+
type: "closed";
|
|
36
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"event-source-data.js","sourceRoot":"","sources":["../../../src/sdk-bundle-api/sdk-to-bundle/event-source-data.ts"],"names":[],"mappings":""}
|
|
@@ -40,7 +40,7 @@ export interface RequestFilter {
|
|
|
40
40
|
* Any JS regex that passes https://github.com/tjenkinson/redos-detector is supported.
|
|
41
41
|
*/
|
|
42
42
|
urlRegex: string;
|
|
43
|
-
/** Defaults to `{ fetch: true, xhr: true, webSockets: true }` */
|
|
43
|
+
/** Defaults to `{ fetch: true, xhr: true, webSockets: true, eventSources: true }` */
|
|
44
44
|
connectionTypes?: ConnectionTypesFilter;
|
|
45
45
|
}
|
|
46
46
|
export interface NoStubbing {
|
|
@@ -50,6 +50,7 @@ export interface ConnectionTypesFilter {
|
|
|
50
50
|
fetch: boolean;
|
|
51
51
|
xhr: boolean;
|
|
52
52
|
webSockets: boolean;
|
|
53
|
+
eventSources: boolean;
|
|
53
54
|
}
|
|
54
55
|
type TransformableRequestData = Pick<Request, "body" | "method" | "url">;
|
|
55
56
|
interface CustomTransformationBase {
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { ReplayableEvent } from "../bidirectional/replayable-event";
|
|
2
|
+
import { EventSourceConnectionData } from "./event-source-data";
|
|
2
3
|
import { HarLog } from "./har-log";
|
|
3
4
|
import { WebSocketConnectionData } from "./websocket-data";
|
|
4
5
|
export interface SessionData {
|
|
@@ -41,6 +42,10 @@ export interface SessionData {
|
|
|
41
42
|
* Only present on recordings since ~March 2024
|
|
42
43
|
*/
|
|
43
44
|
webSocketData?: WebSocketConnectionData[];
|
|
45
|
+
/**
|
|
46
|
+
* Only present on recordings since ~Oct 2025
|
|
47
|
+
*/
|
|
48
|
+
eventSourceData?: EventSourceConnectionData[];
|
|
44
49
|
cookies: Cookie[];
|
|
45
50
|
urlHistory: UrlHistoryEvent[];
|
|
46
51
|
rrwebEvents: unknown[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"session-data.js","sourceRoot":"","sources":["../../../src/sdk-bundle-api/sdk-to-bundle/session-data.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"session-data.js","sourceRoot":"","sources":["../../../src/sdk-bundle-api/sdk-to-bundle/session-data.ts"],"names":[],"mappings":";;;AA8PA,IAAY,8BAmCX;AAnCD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,gGAA8D,CAAA;IAE9D;;;;;OAKG;IACH,oEAAkC,CAAA;IAElC;;;;;OAKG;IACH,6DAA2B,CAAA;IAE3B;;;OAGG;IACH,8DAA4B,CAAA;IAE5B;;;;OAIG;IACH,8GAA4E,CAAA;AAC9E,CAAC,EAnCW,8BAA8B,GAA9B,sCAA8B,KAA9B,sCAA8B,QAmCzC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alwaysmeticulous/api",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.248.0",
|
|
4
4
|
"description": "Meticulous API types",
|
|
5
5
|
"license": "ISC",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -35,5 +35,5 @@
|
|
|
35
35
|
"bugs": {
|
|
36
36
|
"url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
|
|
37
37
|
},
|
|
38
|
-
"gitHead": "
|
|
38
|
+
"gitHead": "4e429238d3540b21e3007f4c752ce8942f0a60e4"
|
|
39
39
|
}
|