@alwaysmeticulous/api 2.175.0 → 2.178.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
@@ -2,10 +2,11 @@ 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, } from "./sdk-bundle-api/bundle-to-sdk/screenshot-diff-result";
4
4
  export { TestCase, TestCaseReplayOptions, TestRunStatus, TestCaseResult, TestCaseResultStatus, } from "./replay/test-run.types";
5
+ export { TestRunChunkStatus } from "./replay/test-run-chunk.types";
5
6
  export * from "./sdk-bundle-api/sdk-to-bundle/test-run-environment";
6
7
  export { ReplayableEvent } from "./sdk-bundle-api/bidirectional/replayable-event";
7
8
  export { HarEntry, HarLog, HarRequest, HarResponse, } from "./sdk-bundle-api/sdk-to-bundle/har-log";
8
- export { Cookie, SessionData, UrlHistoryEvent, WindowData, ApplicationSpecificData, StorageEntry, EarlyRequest, SerializedIDBValidKey, IDBObjectStoreMetadata, IDBObjectStoreWithEntries, CustomData, CustomUserEvent, } from "./sdk-bundle-api/sdk-to-bundle/session-data";
9
+ export { Cookie, SessionData, UrlHistoryEvent, WindowData, ApplicationSpecificData, StorageEntry, EarlyRequest, SerializedIDBValidKey, IDBObjectStoreMetadata, IDBObjectStoreSnapshot, IDBIndexSnapshot, CustomData, CustomUserEvent, } from "./sdk-bundle-api/sdk-to-bundle/session-data";
9
10
  export { SequenceNumber, WebSocketConnectionData, WebSocketConnectionEvent, WebSocketConnectionCreatedEvent, WebSocketConnectionOpenedEvent, EncodedArrayBuffer, EncodedBlob, WebSocketConnectionMessageEvent, WebSocketConnectionErrorEvent, WebSocketConnectionClosedEvent, } from "./sdk-bundle-api/sdk-to-bundle/websocket-data";
10
11
  export { Replay } from "./replay/replay.types";
11
12
  export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, ScreenshottingEnabledOptions, StoryboardOptions, ScreenshotDiffOptions, ElementToIgnore, CSSSelectorToIgnore, } from "./sdk-bundle-api/sdk-to-bundle/screenshotting-options";
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AA4BA,sFAAoE"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AA6BA,sFAAoE"}
@@ -0,0 +1,7 @@
1
+ import { TestRunStatus } from "./test-run.types";
2
+ /**
3
+ * Execution of a chunk of a test run chunk.
4
+ *
5
+ * The values and their meanings are the same as for {@link TestRunStatus}.
6
+ */
7
+ export type TestRunChunkStatus = TestRunStatus;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=test-run-chunk.types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"test-run-chunk.types.js","sourceRoot":"","sources":["../../src/replay/test-run-chunk.types.ts"],"names":[],"mappings":""}
@@ -24,6 +24,12 @@ export interface TestCaseReplayOptions extends Partial<ScreenshotDiffOptions> {
24
24
  * into 'Running' in this case, if the worker retries it.
25
25
  */
26
26
  export type TestRunStatus = "Scheduled" | "Running" | "Success" | "Failure" | "ExecutionError";
27
+ /**
28
+ * Execution of a chunk of a test run chunk.
29
+ *
30
+ * The values and their meanings are the same as for {@link TestRunStatus}.
31
+ */
32
+ export type TestRunChunkStatus = TestRunStatus;
27
33
  export type TestCaseResultStatus = "pass" | "fail" | "flake";
28
34
  export interface TestCaseResult extends TestCase {
29
35
  headReplayId: string;
@@ -30,7 +30,7 @@ export interface SessionData {
30
30
  * Only present on recordings since ~Aug 2024
31
31
  */
32
32
  indexedDb?: {
33
- state: IDBObjectStoreWithEntries[];
33
+ state: IDBObjectStoreSnapshot[];
34
34
  };
35
35
  };
36
36
  /**
@@ -122,7 +122,7 @@ interface StringKey {
122
122
  type: "string";
123
123
  serializedKey: string;
124
124
  }
125
- export type IDBObjectStoreWithEntries = Omit<IDBObjectStoreMetadata, "serialize" | "deserialize"> & {
125
+ export type IDBObjectStoreSnapshot = Omit<IDBObjectStoreMetadata, "serialize" | "deserialize"> & {
126
126
  createObjectStoreOptions: IDBObjectStoreParameters;
127
127
  /**
128
128
  * Entry values are JSON stringified by default. JSON representable objects, arrays and primitives are supported.
@@ -133,6 +133,21 @@ export type IDBObjectStoreWithEntries = Omit<IDBObjectStoreMetadata, "serialize"
133
133
  key?: SerializedIDBValidKey;
134
134
  value: string;
135
135
  }[];
136
+ /**
137
+ * This is only present on IDB snapshots taken since ~Dec 2024.
138
+ * It contains the indexes of the object store. In particular, these are the arguments that need to be provided to
139
+ * the `createIndex` method on the IDBObjectStore object to re-create the indexes that existed at the time of the
140
+ * snapshot.
141
+ */
142
+ indexes?: IDBIndexSnapshot[];
143
+ };
144
+ export type IDBIndexSnapshot = {
145
+ name: string;
146
+ keyPath: string | string[];
147
+ options: {
148
+ unique: boolean;
149
+ multiEntry: boolean;
150
+ };
136
151
  };
137
152
  export type CustomUserEvent = {
138
153
  type: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alwaysmeticulous/api",
3
- "version": "2.175.0",
3
+ "version": "2.178.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": "600b5e17072eea1fb83d54e536dc644a7c95a87f"
38
+ "gitHead": "3762dc597f2c29590a4bef6e3ef6808d8c1924d2"
39
39
  }