@alwaysmeticulous/api 2.109.0 → 2.113.0

package/dist/index.d.ts

@@ -5,7 +5,7 @@ export { TestCase, TestCaseReplayOptions, TestRunStatus, TestCaseResult, TestCas
 export { TestRunEnvironment, TestRunGitHubContext, TestRunGitHubPullRequestContext, TestRunGitHubPushContext, TestRunGitHubWorkflowDispatchContext, TestRunGitLabContext, TestRunGitLabMergeRequestContext, TestRunGitLabPushContext, } from "./sdk-bundle-api/sdk-to-bundle/test-run-environment";
 export { ReplayableEvent } from "./sdk-bundle-api/bidirectional/replayable-event";
 export { HarEntry, HarLog, HarRequest, HarResponse, } from "./sdk-bundle-api/sdk-to-bundle/har-log";
-export { Cookie, SessionData, UrlHistoryEvent, WindowData, ApplicationSpecificData, StorageEntry, EarlyRequest, } from "./sdk-bundle-api/sdk-to-bundle/session-data";
+export { Cookie, SessionData, UrlHistoryEvent, WindowData, ApplicationSpecificData, StorageEntry, EarlyRequest, WebSocketConnectionData, WebSocketConnectionEvent, } from "./sdk-bundle-api/sdk-to-bundle/session-data";
 export { Replay } from "./replay/replay.types";
 export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, ScreenshottingEnabledOptions, StoryboardOptions, ScreenshotDiffOptions, ElementToIgnore, CSSSelectorToIgnore, } from "./sdk-bundle-api/sdk-to-bundle/screenshotting-options";
 export { NetworkStubbingMode, StubAllRequests, StubNonSSRRequests, NoStubbing, CustomStubbing, RequestFilter, } from "./sdk-bundle-api/sdk-to-bundle/network-stubbing";

package/dist/sdk-bundle-api/bundle-to-sdk/screenshot-diff-result.d.ts

@@ -68,9 +68,6 @@ export interface ScreenshotDiffResultCompared {
     height: number;
     mismatchPixels: number;
     mismatchFraction: number;
-}
-export interface ScreenshotDiffResultNoDifference extends ScreenshotDiffResultCompared {
-    outcome: "no-diff";
     /**
      * The result of comparing the redacted screenshots (i.e. screenshots taken after elements
      * to ignore have been hidden/removed).
@@ -80,6 +77,9 @@ export interface ScreenshotDiffResultNoDifference extends ScreenshotDiffResultCo
      */
     redactedScreenshotsComparisonResult?: RedactedScreenshotsCompared | RedactedScreenshotIncompatible;
 }
+export interface ScreenshotDiffResultNoDifference extends ScreenshotDiffResultCompared {
+    outcome: "no-diff";
+}
 /**
  * The result of comparing the redacted screenshots. Note that due to thresholds even
  * 'no-diff' results may have some differing pixels.

package/dist/sdk-bundle-api/sdk-to-bundle/network-stubbing.d.ts

@@ -25,7 +25,14 @@ export interface RequestFilter {
      * Any JS regex that passes https://github.com/tjenkinson/redos-detector is supported.
      */
     urlRegex: string;
+    /** Defaults to `{ fetch: true, xhr: true, webSockets: true }` */
+    connectionTypes?: ConnectionTypesFilter;
 }
 export interface NoStubbing {
     type: "no-stubbing";
 }
+export interface ConnectionTypesFilter {
+    fetch: boolean;
+    xhr: boolean;
+    webSockets: boolean;
+}

package/dist/sdk-bundle-api/sdk-to-bundle/session-data.d.ts

@@ -26,6 +26,10 @@ export interface SessionData {
             state: StorageEntry[];
         };
     };
+    /**
+     * Only present on recordings since ~March 2024
+     */
+    webSocketData?: WebSocketConnectionData[];
     cookies: Cookie[];
     urlHistory: UrlHistoryEvent[];
     rrwebEvents: unknown[];
@@ -87,3 +91,22 @@ export interface EarlyRequest {
     startTime: number;
     duration: number;
 }
+export type SequenceNumber = number;
+export interface WebSocketConnectionData {
+    id: SequenceNumber;
+    url: string;
+    events: WebSocketConnectionEvent[];
+}
+export interface WebSocketConnectionEvent {
+    /**
+     * The time in milliseconds since the start of the session.
+     *
+     * During simulations, we consider the "created" event to have been replayed whenever the browser calls
+     * `new WebSocket()` and all other events are replayed at a time relative to the "created" event's timestamp.
+     *
+     * E.g. the "opened" event is replayed at ("opened".timestamp - "created".timestamp) milliseconds after the browser calls `new WebSocket()`.
+     */
+    timestamp: number;
+    type: "created" | "opened" | "message-sent" | "message-received" | "closed" | "error";
+    data?: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.109.0",
+  "version": "2.113.0",
   "description": "Meticulous API types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -35,5 +35,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "80f4a08d29a9f3acbdb0900a102564bbad2220b9"
+  "gitHead": "ca4248ace17d3de4b930f3c6a1d39fda9f93bd76"
 }