@alwaysmeticulous/api 2.290.0 → 2.291.2

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.
@@ -22,6 +22,13 @@ export interface Snapshot<T = unknown> {
22
22
  */
23
23
  stageDuringSession: string;
24
24
  data: T;
25
+ /**
26
+ * Version number the snapshot was recorded with (see
27
+ * `recordCustomSnapshot`). Defaults to 0 for snapshots recorded without one
28
+ * (including all built-in snapshots). When the version differs between the
29
+ * base and head snapshots, a failing check can be caveated in the UI.
30
+ */
31
+ versionNumber?: number;
25
32
  }
26
33
  /** The base and head snapshots passed to a custom check. */
27
34
  export interface CustomCheckInput {
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
- !function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="14a4ab8a-ebd9-5fd7-ba2b-b93055c8f39f")}catch(e){}}();
2
+ !function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="8ef65cd4-8945-57ad-89ea-063f84e905ee")}catch(e){}}();
3
3
 
4
4
  Object.defineProperty(exports, "__esModule", { value: true });
5
5
  exports.CUSTOM_CHECK_RESULTS_STATUSES = exports.NETWORK_REQUESTS_SNAPSHOT_TYPE = exports.CUSTOM_CHECK_SUMMARY_MAX_LENGTH = void 0;
@@ -27,4 +27,4 @@ exports.CUSTOM_CHECK_RESULTS_STATUSES = [
27
27
  "execution-error",
28
28
  ];
29
29
  //# sourceMappingURL=custom-checks.types.js.map
30
- //# debugId=14a4ab8a-ebd9-5fd7-ba2b-b93055c8f39f
30
+ //# debugId=8ef65cd4-8945-57ad-89ea-063f84e905ee
@@ -1 +1 @@
1
- {"version":3,"file":"custom-checks.types.js","sources":["../src/custom-checks.types.ts"],"sourceRoot":"","names":[],"mappings":";;;;;AAoDA;;;;GAIG;AACU,QAAA,+BAA+B,GAAG,GAAG,CAAC;AA4DnD;;;GAGG;AACU,QAAA,8BAA8B,GAAG,kBAAkB,CAAC;AAyBjE;;;;;;;GAOG;AACU,QAAA,6BAA6B,GAAG;IAC3C,UAAU;IACV,iBAAiB;CACT,CAAC","debugId":"14a4ab8a-ebd9-5fd7-ba2b-b93055c8f39f"}
1
+ {"version":3,"file":"custom-checks.types.js","sources":["../src/custom-checks.types.ts"],"sourceRoot":"","names":[],"mappings":";;;;;AA4DA;;;;GAIG;AACU,QAAA,+BAA+B,GAAG,GAAG,CAAC;AA4DnD;;;GAGG;AACU,QAAA,8BAA8B,GAAG,kBAAkB,CAAC;AAyBjE;;;;;;;GAOG;AACU,QAAA,6BAA6B,GAAG;IAC3C,UAAU;IACV,iBAAiB;CACT,CAAC","debugId":"8ef65cd4-8945-57ad-89ea-063f84e905ee"}
package/dist/index.d.ts CHANGED
@@ -16,7 +16,7 @@ export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, Screen
16
16
  export { NetworkStubbingMode, StubAllRequests, StubNonSSRRequests, PassthroughAppRequests, NoStubbing, CustomStubbing, RequestFilter, CustomTransformation, CustomTransformationWhere, } from "./sdk-bundle-api/sdk-to-bundle/network-stubbing";
17
17
  export { ConsoleMessageWithStackTracePointer, VirtualTimeChange, MeticulousConsoleMessage, ApplicationConsoleMessage, ConsoleMessageCoreData, ConsoleMessageType, ConsoleMessageLocation, } from "./sdk-bundle-api/bundle-to-sdk/console-message";
18
18
  export { InjectableRequestHeader, StaticHeaderValue, DynamicHeaderValue, AllRequests, AppUrlRequestsOnly, CustomRequests, } from "./sdk-bundle-api/sdk-to-bundle/header-injection";
19
- export { ConsoleErrorDivergenceIndicator, Divergence, DivergenceConsoleError, DivergenceIndicator, InitialNavigationDivergenceIndicator, NetworkActivityDivergenceIndicator, ScreenshotDivergenceIdentifier, UrlChangeEventDivergenceIndicator, UserEventDivergenceIndicator, } from "./sdk-bundle-api/bundle-to-sdk/replay-divergence";
19
+ export { ConsoleErrorDivergenceIndicator, Divergence, DivergenceConsoleError, DivergenceIndicator, GraphQLWebSocketActivityDivergenceIndicator, InitialNavigationDivergenceIndicator, NetworkActivityDivergenceIndicator, ScreenshotDivergenceIdentifier, UrlChangeEventDivergenceIndicator, UserEventDivergenceIndicator, } from "./sdk-bundle-api/bundle-to-sdk/replay-divergence";
20
20
  export { AssetUploadMetadata } from "./sdk-bundle-api/sdk-to-bundle/asset-upload-metadata";
21
21
  export { S3Location } from "./s3.types";
22
22
  export { CompanionAssetsInfo } from "./sdk-bundle-api/sdk-to-bundle/companion-assets";
package/dist/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
- !function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="fd6dbc11-c00d-5240-9c3d-1ca64e77b08e")}catch(e){}}();
2
+ !function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="9bf7f317-42bb-584e-a02f-e30f0faf5333")}catch(e){}}();
3
3
 
4
4
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
5
5
  if (k2 === undefined) k2 = k;
@@ -29,4 +29,4 @@ Object.defineProperty(exports, "NETWORK_REQUESTS_SNAPSHOT_TYPE", { enumerable: t
29
29
  Object.defineProperty(exports, "CUSTOM_CHECK_SUMMARY_MAX_LENGTH", { enumerable: true, get: function () { return custom_checks_types_1.CUSTOM_CHECK_SUMMARY_MAX_LENGTH; } });
30
30
  Object.defineProperty(exports, "CUSTOM_CHECK_RESULTS_STATUSES", { enumerable: true, get: function () { return custom_checks_types_1.CUSTOM_CHECK_RESULTS_STATUSES; } });
31
31
  //# sourceMappingURL=index.js.map
32
- //# debugId=fd6dbc11-c00d-5240-9c3d-1ca64e77b08e
32
+ //# debugId=9bf7f317-42bb-584e-a02f-e30f0faf5333
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sources":["../src/index.ts"],"sourceRoot":"","names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAuBA,0DAaiC;AAZ/B,kHAAA,gBAAgB,OAAA;AAChB,qHAAA,mBAAmB,OAAA;AAsBrB,sFAAoE;AAQpE,4EAsBqD;AATnD,8HAAA,8BAA8B,OAAA;AAsBhC,mFAAiE;AA0DjE,6DAiB+B;AAN7B,qIAAA,8BAA8B,OAAA;AAC9B,sIAAA,+BAA+B,OAAA;AAC/B,oIAAA,6BAA6B,OAAA","debugId":"fd6dbc11-c00d-5240-9c3d-1ca64e77b08e"}
1
+ {"version":3,"file":"index.js","sources":["../src/index.ts"],"sourceRoot":"","names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAuBA,0DAaiC;AAZ/B,kHAAA,gBAAgB,OAAA;AAChB,qHAAA,mBAAmB,OAAA;AAsBrB,sFAAoE;AAQpE,4EAsBqD;AATnD,8HAAA,8BAA8B,OAAA;AAsBhC,mFAAiE;AA2DjE,6DAiB+B;AAN7B,qIAAA,8BAA8B,OAAA;AAC9B,sIAAA,+BAA+B,OAAA;AAC/B,oIAAA,6BAA6B,OAAA","debugId":"9bf7f317-42bb-584e-a02f-e30f0faf5333"}
@@ -1,5 +1,5 @@
1
1
  import { ScreenshotDiffResult } from "./screenshot-diff-result";
2
- export type DivergenceIndicator = UserEventDivergenceIndicator | UrlChangeEventDivergenceIndicator | NetworkActivityDivergenceIndicator | InitialNavigationDivergenceIndicator | ConsoleErrorDivergenceIndicator;
2
+ export type DivergenceIndicator = UserEventDivergenceIndicator | UrlChangeEventDivergenceIndicator | NetworkActivityDivergenceIndicator | GraphQLWebSocketActivityDivergenceIndicator | InitialNavigationDivergenceIndicator | ConsoleErrorDivergenceIndicator;
3
3
  export interface UserEventDivergenceIndicator {
4
4
  type: "user-event";
5
5
  beforeEventIdx: number;
@@ -16,6 +16,19 @@ export interface NetworkActivityDivergenceIndicator {
16
16
  afterEventIndices: number[];
17
17
  kind: "completed-requests" | "pending-requests";
18
18
  }
19
+ /**
20
+ * Indicates that one or more GraphQL-over-websocket subscriptions degraded
21
+ * between the base and head replays (e.g. a subscribe frame that matched a
22
+ * recorded response exactly in the base now only matches by a relaxed strategy,
23
+ * or no longer matches at all). The event indices reference `graphQLWebSocket`
24
+ * timeline entries. Analogous to {@link NetworkActivityDivergenceIndicator} for
25
+ * HTTP requests.
26
+ */
27
+ export interface GraphQLWebSocketActivityDivergenceIndicator {
28
+ type: "graphql-websocket-activity";
29
+ beforeEventIndices?: number[] | undefined;
30
+ afterEventIndices: number[];
31
+ }
19
32
  export interface InitialNavigationDivergenceIndicator {
20
33
  type: "initial-navigation";
21
34
  beforeEventIdx: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alwaysmeticulous/api",
3
- "version": "2.290.0",
3
+ "version": "2.291.2",
4
4
  "description": "Meticulous API types",
5
5
  "license": "ISC",
6
6
  "main": "dist/index.js",