@alwaysmeticulous/api 2.221.0 → 2.223.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,7 +1,7 @@
1
1
  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, RedactedScreenshotsComparison, } from "./sdk-bundle-api/bundle-to-sdk/screenshot-diff-result";
4
- export { SessionRelevance, TestCase, TestCaseReplayOptions, TestRunStatus, TestCaseResult, TestCaseResultStatus, } from "./replay/test-run.types";
4
+ export { SessionRelevance, isPrAuthorRelevance, TestCase, TestCaseReplayOptions, TestRunStatus, TestCaseResult, TestCaseResultStatus, } from "./replay/test-run.types";
5
5
  export { TestRunChunkStatus } from "./replay/test-run-chunk.types";
6
6
  export * from "./sdk-bundle-api/sdk-to-bundle/test-run-environment";
7
7
  export { ReplayableEvent } from "./sdk-bundle-api/bidirectional/replayable-event";
package/dist/index.js CHANGED
@@ -14,9 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- exports.CustomDataSingletonInternalKey = exports.SessionRelevance = void 0;
17
+ exports.CustomDataSingletonInternalKey = exports.isPrAuthorRelevance = exports.SessionRelevance = void 0;
18
18
  var test_run_types_1 = require("./replay/test-run.types");
19
19
  Object.defineProperty(exports, "SessionRelevance", { enumerable: true, get: function () { return test_run_types_1.SessionRelevance; } });
20
+ Object.defineProperty(exports, "isPrAuthorRelevance", { enumerable: true, get: function () { return test_run_types_1.isPrAuthorRelevance; } });
20
21
  __exportStar(require("./sdk-bundle-api/sdk-to-bundle/test-run-environment"), exports);
21
22
  var session_data_1 = require("./sdk-bundle-api/sdk-to-bundle/session-data");
22
23
  Object.defineProperty(exports, "CustomDataSingletonInternalKey", { enumerable: true, get: function () { return session_data_1.CustomDataSingletonInternalKey; } });
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAsBA,0DAOiC;AAN/B,kHAAA,gBAAgB,OAAA;AAQlB,sFAAoE;AAQpE,4EAkBqD;AALnD,8HAAA,8BAA8B,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAsBA,0DAQiC;AAP/B,kHAAA,gBAAgB,OAAA;AAChB,qHAAA,mBAAmB,OAAA;AAQrB,sFAAoE;AAQpE,4EAkBqD;AALnD,8HAAA,8BAA8B,OAAA"}
@@ -16,4 +16,4 @@ export interface Project {
16
16
  };
17
17
  experimentValues: Record<string, string>;
18
18
  }
19
- export type ProjectSettingsScreenshottingOptions = Partial<Pick<ScreenshottingEnabledOptions, "waitBeforeScreenshotsMs" | "captureFullPage" | "elementsToIgnore" | "waitForBaseToMatch">>;
19
+ export type ProjectSettingsScreenshottingOptions = Partial<Pick<ScreenshottingEnabledOptions, "waitBeforeScreenshotsMs" | "captureFullPage" | "elementsToIgnore">>;
@@ -4,10 +4,13 @@ import { ScreenshotDiffOptions } from "../sdk-bundle-api/sdk-to-bundle/screensho
4
4
  */
5
5
  export declare enum SessionRelevance {
6
6
  IsPrAuthor = "is-pr-author",
7
+ IsPrAuthorRelevant = "is-pr-author-relevant",
8
+ IsPrAuthorNotRelevant = "is-pr-author-not-relevant",
7
9
  IsRelevant = "is-relevant",
8
10
  NotRelevant = "not-relevant",
9
11
  MaybeRelevant = "maybe-relevant"
10
12
  }
13
+ export declare const isPrAuthorRelevance: (relevance: SessionRelevance | null | undefined) => boolean;
11
14
  export interface TestCase {
12
15
  sessionId: string;
13
16
  relevanceToPR?: SessionRelevance;
@@ -1,14 +1,25 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SessionRelevance = void 0;
3
+ exports.isPrAuthorRelevance = exports.SessionRelevance = void 0;
4
4
  /**
5
5
  * Relevance of a session
6
6
  */
7
7
  var SessionRelevance;
8
8
  (function (SessionRelevance) {
9
9
  SessionRelevance["IsPrAuthor"] = "is-pr-author";
10
+ SessionRelevance["IsPrAuthorRelevant"] = "is-pr-author-relevant";
11
+ SessionRelevance["IsPrAuthorNotRelevant"] = "is-pr-author-not-relevant";
10
12
  SessionRelevance["IsRelevant"] = "is-relevant";
11
13
  SessionRelevance["NotRelevant"] = "not-relevant";
12
14
  SessionRelevance["MaybeRelevant"] = "maybe-relevant";
13
15
  })(SessionRelevance = exports.SessionRelevance || (exports.SessionRelevance = {}));
16
+ const isPrAuthorRelevance = (relevance) => {
17
+ if (!relevance) {
18
+ return false;
19
+ }
20
+ return (relevance === SessionRelevance.IsPrAuthor ||
21
+ relevance === SessionRelevance.IsPrAuthorRelevant ||
22
+ relevance === SessionRelevance.IsPrAuthorNotRelevant);
23
+ };
24
+ exports.isPrAuthorRelevance = isPrAuthorRelevance;
14
25
  //# sourceMappingURL=test-run.types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"test-run.types.js","sourceRoot":"","sources":["../../src/replay/test-run.types.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,8CAA0B,CAAA;IAC1B,gDAA4B,CAAA;IAC5B,oDAAgC,CAAA;AAClC,CAAC,EALW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAK3B"}
1
+ {"version":3,"file":"test-run.types.js","sourceRoot":"","sources":["../../src/replay/test-run.types.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,gEAA4C,CAAA;IAC5C,uEAAmD,CAAA;IACnD,8CAA0B,CAAA;IAC1B,gDAA4B,CAAA;IAC5B,oDAAgC,CAAA;AAClC,CAAC,EAPW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAO3B;AAEM,MAAM,mBAAmB,GAAG,CACjC,SAA8C,EACrC,EAAE;IACX,IAAI,CAAC,SAAS,EAAE;QACd,OAAO,KAAK,CAAC;KACd;IAED,OAAO,CACL,SAAS,KAAK,gBAAgB,CAAC,UAAU;QACzC,SAAS,KAAK,gBAAgB,CAAC,kBAAkB;QACjD,SAAS,KAAK,gBAAgB,CAAC,qBAAqB,CACrD,CAAC;AACJ,CAAC,CAAC;AAZW,QAAA,mBAAmB,uBAY9B"}
@@ -15,7 +15,6 @@ export interface ScreenshottingEnabledOptions {
15
15
  elementsToIgnore?: ElementToIgnore[];
16
16
  waitBeforeScreenshotsMs?: number;
17
17
  captureFullPage?: boolean;
18
- waitForBaseToMatch?: boolean;
19
18
  }
20
19
  export declare type StoryboardOptions = {
21
20
  enabled: false;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alwaysmeticulous/api",
3
- "version": "2.221.0",
3
+ "version": "2.223.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": "87f598857d832acb593e1c3f1fd08aa02bd12426"
38
+ "gitHead": "188a6f4ca991635721e66514cb62b7be847b0d0c"
39
39
  }