@alwaysmeticulous/sdk-bundles-api 2.42.1 → 2.43.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.
@@ -1,4 +1,5 @@
1
1
  import { ScreenshotDiffOptions } from "@alwaysmeticulous/api";
2
+ import { LogLevelNumbers } from "loglevel";
2
3
  import { BeforeUserEventOptions } from "../../replay/bundle-to-sdk";
3
4
  import { BeforeUserEventResult } from "../bundle-to-sdk/execute-replay";
4
5
  export interface ReplayAndStoreResultsOptions {
@@ -12,6 +13,7 @@ export interface ReplayAndStoreResultsOptions {
12
13
  commitSha: string | null | undefined;
13
14
  sessionId: string;
14
15
  cookiesFile: string | null | undefined;
16
+ logLevel: LogLevelNumbers;
15
17
  /**
16
18
  * Called when the user or runner closes the page or browser window
17
19
  */
@@ -29,8 +31,11 @@ export interface ReplayAndStoreResultsOptions {
29
31
  * code to detect if it's being called by client that is not compatible with the latest version,
30
32
  * and if so throw an OutOfDateClientError. It is then up to the client to display a message to ask
31
33
  * the user to update to a newer version.
34
+ *
35
+ * Note: this is typed as a const of the latest known version, rather than a number, to ensure
36
+ * that all clients bump the version number passed when they upgrade to the types.
32
37
  */
33
- maxSemanticVersionSupported: number;
38
+ maxSemanticVersionSupported: 1;
34
39
  }
35
40
  /**
36
41
  * See {@link ReplayAndStoreResultsOptions.maxSemanticVersionSupported} for more details.
@@ -1,4 +1,5 @@
1
1
  import { ScreenshotAssertionsEnabledOptions, TestCaseResult, TestRunEnvironment } from "@alwaysmeticulous/api";
2
+ import { LogLevelNumbers } from "loglevel";
2
3
  import { RunningTestRunExecution } from "../bundle-to-sdk/execute-test-run";
3
4
  import { ReplayExecutionOptions } from "./execute-replay";
4
5
  export interface ExecuteTestRunOptions {
@@ -46,6 +47,7 @@ export interface ExecuteTestRunOptions {
46
47
  */
47
48
  environment?: TestRunEnvironment;
48
49
  baseTestRunId: string | null;
50
+ logLevel: LogLevelNumbers;
49
51
  onTestRunCreated?: (testRun: RunningTestRunExecution) => void;
50
52
  onTestFinished?: (testRun: RunningTestRunExecution) => void;
51
53
  /**
@@ -56,6 +58,9 @@ export interface ExecuteTestRunOptions {
56
58
  * code to detect if it's being called by client that is not compatible with the latest version,
57
59
  * and if so throw an OutOfDateClientError. It is then up to the client to display a message to ask
58
60
  * the user to update to a newer version.
61
+ *
62
+ * Note: this is typed as a const of the latest known version, rather than a number, to ensure
63
+ * that all clients bump the version number passed when they upgrade to the types.
59
64
  */
60
- maxSemanticVersionSupported: number;
65
+ maxSemanticVersionSupported: 1;
61
66
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alwaysmeticulous/sdk-bundles-api",
3
- "version": "2.42.1",
3
+ "version": "2.43.0",
4
4
  "description": "Meticulous common types",
5
5
  "license": "ISC",
6
6
  "main": "dist/index.js",
@@ -50,5 +50,5 @@
50
50
  "bugs": {
51
51
  "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
52
52
  },
53
- "gitHead": "6c08f6e79f34f7efdc2ebd0e8e4e09baffeb8f04"
53
+ "gitHead": "7664f4dfeed3b08e5523c0acb4d98d11eee4c9ff"
54
54
  }