@alwaysmeticulous/sdk-bundles-api 2.171.0 → 2.173.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.
@@ -59,6 +59,10 @@ export interface ReplayAndStoreResultsOptions {
59
59
  * If present, requests for assets during simulation will be proxied through this URL
60
60
  */
61
61
  simulationProxyUrl?: string;
62
+ /**
63
+ * If set to true, capture snapshots of assets.
64
+ */
65
+ snapshotAssets?: boolean;
62
66
  }
63
67
  export interface BeforeUserEventOptions {
64
68
  /**
@@ -31,6 +31,10 @@ export interface MeticulousPublicReplayApi {
31
31
  * Call this method to retrieve an array of custom data that was recorded during the test run.
32
32
  */
33
33
  retrieveCustomDataArray(arrayId: string): string[];
34
+ /**
35
+ * Call this method to add a listener for a custom event that was recorded during the test run.
36
+ */
37
+ addCustomEventListener(type: string, callback: (serializedData: string) => void | Promise<void>): void;
34
38
  }
35
39
  export interface MeticulousPublicRecordApi {
36
40
  /**
@@ -48,4 +52,12 @@ export interface MeticulousPublicRecordApi {
48
52
  pushToCustomDataArray(arrayId: string, valueToAppend: string): {
49
53
  success: boolean;
50
54
  };
55
+ /**
56
+ * Call this method to record a custom event to replay when replaying this session
57
+ * at the same timestamp as when it was recorde. To listen for these events at replay
58
+ * time see the addCustomEventListener method in the replay API.
59
+ */
60
+ recordCustomEvent(type: string, serializedData: string): {
61
+ success: boolean;
62
+ };
51
63
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alwaysmeticulous/sdk-bundles-api",
3
- "version": "2.171.0",
3
+ "version": "2.173.0",
4
4
  "description": "Meticulous common types",
5
5
  "license": "ISC",
6
6
  "main": "dist/index.js",
@@ -19,7 +19,7 @@
19
19
  "depcheck": "depcheck --ignore-patterns=dist"
20
20
  },
21
21
  "devDependencies": {
22
- "@alwaysmeticulous/api": "^2.171.0"
22
+ "@alwaysmeticulous/api": "^2.173.0"
23
23
  },
24
24
  "peerDependencies": {
25
25
  "loglevel": "^1.8.0"
@@ -46,5 +46,5 @@
46
46
  "bugs": {
47
47
  "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
48
48
  },
49
- "gitHead": "7ee0cece08afd7373f57e808098b7a8e73172c7c"
49
+ "gitHead": "4aa9b139353dae57284d22afa2b879eebd2487f3"
50
50
  }