@alwaysmeticulous/api 2.70.0 → 2.73.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
@@ -1,5 +1,5 @@
1
1
  export { Organization } from "./organization.types";
2
- export { Project, ProjectConfigurationData } from "./project.types";
2
+ export { Project, ProjectConfigurationData, ProjectSettingsScreenshottingOptions, } from "./project.types";
3
3
  export { EndStateScreenshot, ScreenshotAfterEvent, ScreenshotDiffResult, ScreenshotDiffResultCompared, ScreenshotDiffResultDifferentSize, ScreenshotDiffResultMissingBase, ScreenshotDiffResultMissingBaseAndHead, ScreenshotDiffResultMissingHead, ScreenshotIdentifier, SingleTryScreenshotDiffResult, } from "./sdk-bundle-api/bundle-to-sdk/screenshot-diff-result";
4
4
  export { TestCase, TestCaseReplayOptions, TestRunStatus, TestCaseResult, TestCaseResultStatus, } from "./replay/test-run.types";
5
5
  export { TestRunEnvironment, TestRunGitHubContext, TestRunGitHubPullRequestContext, TestRunGitHubPushContext, TestRunGitHubWorkflowDispatchContext, TestRunGitLabContext, TestRunGitLabMergeRequestContext, TestRunGitLabPushContext, } from "./sdk-bundle-api/sdk-to-bundle/test-run-environment";
@@ -9,3 +9,4 @@ export { Cookie, SessionData, UrlHistoryEvent, WindowData, ApplicationSpecificDa
9
9
  export { Replay } from "./replay/replay.types";
10
10
  export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, ScreenshottingEnabledOptions, StoryboardOptions, ScreenshotDiffOptions, } from "./sdk-bundle-api/sdk-to-bundle/screenshotting-options";
11
11
  export { NetworkStubbingMode, StubAllRequests, StubNonSSRRequests, NoStubbing, CustomStubbing, RequestFilter, } from "./sdk-bundle-api/sdk-to-bundle/network-stubbing";
12
+ export { ConsoleMessageWithStackTracePointer, VirtualTimeChange, MeticulousConsoleMessage, ApplicationConsoleMessage, ConsoleMessageCoreData, ConsoleMessageType, ConsoleMessageLocation, } from "./sdk-bundle-api/bundle-to-sdk/console-message";
@@ -1,6 +1,7 @@
1
1
  import { Organization } from "./organization.types";
2
2
  import { TestCase } from "./replay/test-run.types";
3
3
  import { NetworkStubbingMode } from "./sdk-bundle-api/sdk-to-bundle/network-stubbing";
4
+ import { ScreenshottingEnabledOptions } from "./sdk-bundle-api/sdk-to-bundle/screenshotting-options";
4
5
  export interface Project {
5
6
  id: string;
6
7
  organization: Organization;
@@ -12,8 +13,10 @@ export interface Project {
12
13
  isGitHubIntegrationActive?: boolean;
13
14
  settings: {
14
15
  networkStubbingMode?: NetworkStubbingMode;
16
+ defaultScreenshottingOptions?: ProjectSettingsScreenshottingOptions;
15
17
  };
16
18
  }
19
+ export type ProjectSettingsScreenshottingOptions = Partial<Pick<ScreenshottingEnabledOptions, "waitBeforeScreenshotsMs" | "captureFullPage">>;
17
20
  export interface ProjectConfigurationData {
18
21
  testCases?: TestCase[];
19
22
  }
@@ -0,0 +1,36 @@
1
+ /**
2
+ * logs.ndjson contains one ConsoleMessageWithStackTracePointer in JSON format per line
3
+ */
4
+ export type ConsoleMessageWithStackTracePointer = MeticulousConsoleMessage | ApplicationConsoleMessage | VirtualTimeChange;
5
+ export interface VirtualTimeChange {
6
+ type: "virtual-time-change";
7
+ virtualTime: number;
8
+ }
9
+ export interface MeticulousConsoleMessage extends ConsoleMessageCoreData {
10
+ source: "meticulous";
11
+ realTime: number;
12
+ }
13
+ export interface ApplicationConsoleMessage extends ConsoleMessageCoreData {
14
+ source: "application";
15
+ }
16
+ export interface ConsoleMessageCoreData {
17
+ type: ConsoleMessageType;
18
+ message: string;
19
+ repetitionCount?: number;
20
+ stackTraceId: number;
21
+ }
22
+ export type ConsoleMessageType = "log" | "debug" | "info" | "error" | "warning" | "dir" | "dirxml" | "table" | "trace" | "clear" | "startGroup" | "startGroupCollapsed" | "endGroup" | "assert" | "profile" | "profileEnd" | "count" | "timeEnd" | "verbose";
23
+ export interface ConsoleMessageLocation {
24
+ /**
25
+ * URL of the resource if known or `undefined` otherwise.
26
+ */
27
+ url?: string;
28
+ /**
29
+ * 0-based line number in the resource if known or `undefined` otherwise.
30
+ */
31
+ lineNumber?: number;
32
+ /**
33
+ * 0-based column number in the resource if known or `undefined` otherwise.
34
+ */
35
+ columnNumber?: number;
36
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=console-message.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"console-message.js","sourceRoot":"","sources":["../../../src/sdk-bundle-api/bundle-to-sdk/console-message.ts"],"names":[],"mappings":""}
@@ -12,6 +12,8 @@ export interface ScreenshotAssertionsEnabledOptions extends ScreenshottingEnable
12
12
  export interface ScreenshottingEnabledOptions {
13
13
  enabled: true;
14
14
  storyboardOptions: StoryboardOptions;
15
+ waitBeforeScreenshotsMs?: number;
16
+ captureFullPage?: boolean;
15
17
  }
16
18
  export declare type StoryboardOptions = {
17
19
  enabled: false;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alwaysmeticulous/api",
3
- "version": "2.70.0",
3
+ "version": "2.73.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": "f6b1b6f2e2f513d53c3cb427644bbb2afa928741"
38
+ "gitHead": "a26ecc580c2922d8dcbb9200ef4593e8b68e15ee"
39
39
  }