@alwaysmeticulous/api 2.33.0 → 2.34.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 CHANGED
@@ -3,6 +3,6 @@ export { Project, ProjectConfigurationData } from "./project.types";
3
3
  export { EndStateScreenshot, ReplayDiff, ReplayDiffData, ScreenshotAfterEvent, ScreenshotAssertionsEnabledOptions, ScreenshotAssertionsOptions, ScreenshotDiffOptions, ScreenshotDiffResult, ScreenshotDiffResultCompared, ScreenshotDiffResultDifferentSize, ScreenshotDiffResultMissingBase, ScreenshotDiffResultMissingBaseAndHead, ScreenshotDiffResultMissingHead, ScreenshotIdentifier, ScreenshottingEnabledOptions, SingleTryScreenshotDiffResult, StoryboardOptions, } from "./replay/replay-diff.types";
4
4
  export { TestCase, TestCaseReplayOptions, TestRunArguments, TestRunConfigData, TestRunEnvironment, } from "./replay/test-run.types";
5
5
  export { ReplayableEvent } from "./sdk-bundle-api/bidirectional/replayable-event";
6
- export { ErrorTimelineEntry, FailedFindEntryFnEvent, JsReplayReachedMaxDurationEvent, JsReplaySimulateEvent, JsReplayTimelineEntry, PollyTimelineEntry, ReplayTimelineData, ReplayTimelineEntry, SuccessfulFindEntryFnEvent, UrlChangeTimelineEntry, } from "./sdk-bundle-api/bundle-to-sdk/timeline.types";
6
+ export { SDKReplayTimelineEntry, SDKReplayTimelineData, } from "./sdk-bundle-api/bundle-to-sdk/timeline.types";
7
7
  export { HarEntry, HarLog, HarRequest, HarResponse, } from "./sdk-bundle-api/sdk-to-bundle/har-log";
8
8
  export { Cookie, SessionData, UrlHistoryEvent, WindowData, } from "./sdk-bundle-api/sdk-to-bundle/session-data";
@@ -1,4 +1,3 @@
1
- import { ReplayableEvent } from "../bidirectional/replayable-event";
2
1
  interface GenericReplayTimelineEntry {
3
2
  kind: unknown;
4
3
  /**
@@ -13,15 +12,6 @@ interface GenericReplayTimelineEntry {
13
12
  virtualTimeEnd?: number;
14
13
  data: unknown;
15
14
  }
16
- export interface ErrorTimelineEntry extends GenericReplayTimelineEntry {
17
- kind: "error";
18
- data: {
19
- message: string;
20
- fileName: string;
21
- lineNumber: number;
22
- stack: string | null;
23
- };
24
- }
25
15
  /**
26
16
  * An error that cut the replay short.
27
17
  */
@@ -33,66 +23,11 @@ export interface FatalErrorTimelineEntry extends GenericReplayTimelineEntry {
33
23
  };
34
24
  }
35
25
  /**
36
- * Timed out waiting for something but continued anyway. This means the replay was still successful, but may be flakey.
26
+ * ReplayTimelineEntry types used by Meticulous SDK.
27
+ *
28
+ * The Meticulous BE code internally uses additional timeline entries, but these
29
+ * types are stored seperately.
37
30
  */
38
- export interface TimeoutTimelineEntry extends GenericReplayTimelineEntry {
39
- kind: "timeoutError";
40
- data: {
41
- timeoutInMs: number;
42
- message: string | null;
43
- stack: string | null;
44
- };
45
- }
46
- export interface FontsTimeoutTimelineEntry extends TimeoutTimelineEntry {
47
- data: {
48
- waitedFor: "fonts";
49
- } & TimeoutTimelineEntry["data"];
50
- }
51
- export interface NetworkResponsesTimeoutTimelineEntry extends TimeoutTimelineEntry {
52
- data: {
53
- waitedFor: "network-responses";
54
- /**
55
- * The urls we timed out waiting for.
56
- */
57
- urls?: string[];
58
- } & TimeoutTimelineEntry["data"];
59
- }
60
- export interface UrlChangeTimelineEntry extends GenericReplayTimelineEntry {
61
- kind: "urlChange";
62
- data: {
63
- url: string;
64
- timestamp: number;
65
- };
66
- }
67
- export interface PollyTimelineEntry extends GenericReplayTimelineEntry {
68
- kind: "pollyReplay";
69
- data: SuccessfulFindEntryFnEvent | FailedFindEntryFnEvent;
70
- }
71
- export interface SuccessfulFindEntryFnEvent {
72
- event: "findEntryFn";
73
- result: "success";
74
- pollyRequest: unknown;
75
- matchedRequest: unknown;
76
- }
77
- export interface FailedFindEntryFnEvent {
78
- event: "findEntryFn";
79
- result: "failure";
80
- pollyRequest: unknown;
81
- matchedRequest: null;
82
- }
83
- export interface JsReplayTimelineEntry extends GenericReplayTimelineEntry {
84
- kind: "jsReplay";
85
- data: JsReplayReachedMaxDurationEvent | JsReplaySimulateEvent;
86
- }
87
- export interface JsReplayReachedMaxDurationEvent {
88
- event: "reached maxDurationMs";
89
- maxDurationMs: number;
90
- }
91
- export interface JsReplaySimulateEvent {
92
- event: "simulate";
93
- userEvent: ReplayableEvent;
94
- result: "success" | "failed" | "unknownEvent";
95
- }
96
- export type ReplayTimelineEntry = ErrorTimelineEntry | FatalErrorTimelineEntry | FontsTimeoutTimelineEntry | NetworkResponsesTimeoutTimelineEntry | UrlChangeTimelineEntry | PollyTimelineEntry | JsReplayTimelineEntry;
97
- export type ReplayTimelineData = ReplayTimelineEntry[];
31
+ export type SDKReplayTimelineEntry = FatalErrorTimelineEntry | unknown;
32
+ export type SDKReplayTimelineData = SDKReplayTimelineEntry[];
98
33
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alwaysmeticulous/api",
3
- "version": "2.33.0",
3
+ "version": "2.34.0",
4
4
  "description": "Meticulous API types",
5
5
  "license": "ISC",
6
6
  "main": "dist/index.js",
@@ -34,5 +34,5 @@
34
34
  "bugs": {
35
35
  "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
36
36
  },
37
- "gitHead": "59fcb43a3781892cc3d2e9ce8c3340de8e246108"
37
+ "gitHead": "239b51bf54a4114e6134d1a4d38bb1f992284af4"
38
38
  }