@alwaysmeticulous/api 2.201.0 → 2.206.2

package/dist/replay/test-run.types.d.ts

@@ -1,6 +1,7 @@
 import { ScreenshotDiffOptions } from "../sdk-bundle-api/sdk-to-bundle/screenshotting-options";
 export interface TestCase {
     sessionId: string;
+    selected?: boolean;
     title?: string;
     options?: TestCaseReplayOptions;
 }

package/dist/sdk-bundle-api/sdk-to-bundle/session-data.d.ts

@@ -203,12 +203,24 @@ export declare enum CustomDataSingletonInternalKey {
      * https://datatracker.ietf.org/doc/html/rfc5646
      * Present on recordings since ~Feb 2025.
      */
-    Languages = "met-languages"
+    Languages = "met-languages",
+    /**
+     * The id of the logged in user (e.g. a user id from a database for the application Meticulous is testing).
+     * This must be set by the recording application by calling `window.Meticulous.record.recordUserId(userId)`.
+     */
+    UserId = "met-user-id",
+    /**
+     * The email address of the logged in user. This must be set by the recording application
+     * by calling `window.Meticulous.record.recordUserEmail(email)`.
+     */
+    UserEmail = "met-user-email"
 }
 export type CustomDataSingletonInternalValues = {
     [CustomDataSingletonInternalKey.SystemThemePreferredColor]: "light" | "dark";
     [CustomDataSingletonInternalKey.TimezoneName]: string;
     [CustomDataSingletonInternalKey.Languages]: string;
+    [CustomDataSingletonInternalKey.UserId]: string;
+    [CustomDataSingletonInternalKey.UserEmail]: string;
 };
 export type CustomData = {
     singletons: Record<string, string> & Partial<CustomDataSingletonInternalValues>;

package/dist/sdk-bundle-api/sdk-to-bundle/session-data.js

@@ -18,5 +18,15 @@ var CustomDataSingletonInternalKey;
      * Present on recordings since ~Feb 2025.
      */
     CustomDataSingletonInternalKey["Languages"] = "met-languages";
+    /**
+     * The id of the logged in user (e.g. a user id from a database for the application Meticulous is testing).
+     * This must be set by the recording application by calling `window.Meticulous.record.recordUserId(userId)`.
+     */
+    CustomDataSingletonInternalKey["UserId"] = "met-user-id";
+    /**
+     * The email address of the logged in user. This must be set by the recording application
+     * by calling `window.Meticulous.record.recordUserEmail(email)`.
+     */
+    CustomDataSingletonInternalKey["UserEmail"] = "met-user-email";
 })(CustomDataSingletonInternalKey = exports.CustomDataSingletonInternalKey || (exports.CustomDataSingletonInternalKey = {}));
 //# sourceMappingURL=session-data.js.map

package/dist/sdk-bundle-api/sdk-to-bundle/session-data.js.map

@@ -1 +1 @@
-{"version":3,"file":"session-data.js","sourceRoot":"","sources":["../../../src/sdk-bundle-api/sdk-to-bundle/session-data.ts"],"names":[],"mappings":";;;AAuNA,IAAY,8BAkBX;AAlBD,WAAY,8BAA8B;IACxC,gGAA8D,CAAA;IAE9D;;;;;OAKG;IACH,oEAAkC,CAAA;IAElC;;;;;OAKG;IACH,6DAA2B,CAAA;AAC7B,CAAC,EAlBW,8BAA8B,GAA9B,sCAA8B,KAA9B,sCAA8B,QAkBzC"}
+{"version":3,"file":"session-data.js","sourceRoot":"","sources":["../../../src/sdk-bundle-api/sdk-to-bundle/session-data.ts"],"names":[],"mappings":";;;AAuNA,IAAY,8BA8BX;AA9BD,WAAY,8BAA8B;IACxC,gGAA8D,CAAA;IAE9D;;;;;OAKG;IACH,oEAAkC,CAAA;IAElC;;;;;OAKG;IACH,6DAA2B,CAAA;IAE3B;;;OAGG;IACH,wDAAsB,CAAA;IAEtB;;;OAGG;IACH,8DAA4B,CAAA;AAC9B,CAAC,EA9BW,8BAA8B,GAA9B,sCAA8B,KAA9B,sCAA8B,QA8BzC"}

package/dist/sdk-bundle-api/sdk-to-bundle/test-run-environment.d.ts

@@ -15,11 +15,11 @@ export interface TestRunGitHubPullRequestContext {
     htmlUrl: string;
     /** Base commit hash */
     baseSha: string;
-    /** Base ref (usually /refs/head/<branch>) */
+    /** Base ref (usually /refs/heads/<branch>) */
     baseRef?: string;
     /** Head commit hash */
     headSha: string;
-    /** Head ref (usually /refs/head/<branch>) */
+    /** Head ref (usually /refs/heads/<branch>) */
     headRef?: string;
     /** GitHub Actions run ID that triggered this test run */
     runId?: number;
@@ -31,7 +31,7 @@ export interface TestRunGitHubPushContext {
     beforeSha: string;
     /** Commit hash after the push event */
     afterSha: string;
-    /** Git ref (usually /refs/head/<branch>) */
+    /** Git ref (usually /refs/heads/<branch>) */
     ref: string;
     /** GitHub Actions run ID that triggered this test run */
     runId?: number;
@@ -45,7 +45,7 @@ export interface TestRunGitHubPushContext {
 export interface TestRunGitHubWorkflowDispatchContext {
     type: "github";
     event: "workflow-dispatch";
-    /** Git ref (usually /refs/head/<branch>) */
+    /** Git ref (usually /refs/heads/<branch>) */
     ref: string;
     /** Workflow dispatch inputs */
     inputs: {
@@ -70,9 +70,9 @@ export interface TestRunGitLabMergeRequestContext {
     headSha: string;
     /** Merge request URL (web page) */
     webUrl: string;
-    /** Git ref for the target branch (/refs/head/<target_branch>). Not defined for merge requests prior to July 2024. */
+    /** Git ref for the target branch (/refs/heads/<target_branch>). Not defined for merge requests prior to July 2024. */
     baseRef?: string;
-    /** Git ref for the source branch (/refs/head/<source_branch>). Not defined for merge requests prior to July 2024. */
+    /** Git ref for the source branch (/refs/heads/<source_branch>). Not defined for merge requests prior to July 2024. */
     headRef?: string;
 }
 export interface TestRunGitLabPushContext {
@@ -82,7 +82,7 @@ export interface TestRunGitLabPushContext {
     beforeSha: string;
     /** Commit hash after the push event */
     afterSha: string;
-    /** Git ref for the branch (/refs/head/<branch>). Not defined for pushes prior to July 2024. */
+    /** Git ref for the branch (/refs/heads/<branch>). Not defined for pushes prior to July 2024. */
     ref?: string;
 }
 export type TestRunBitbucketContext = {
@@ -98,11 +98,11 @@ export interface TestRunBitbucketPullRequestContext {
     htmlUrl: string;
     /** Base commit hash */
     baseSha: string;
-    /** Base ref (usually /refs/head/<branch>) */
+    /** Base ref (usually /refs/heads/<branch>) */
     baseRef: string;
     /** Head commit hash */
     headSha: string;
-    /** Head ref (usually /refs/head/<branch>) */
+    /** Head ref (usually /refs/heads/<branch>) */
     headRef: string;
 }
 export interface TestRunBitbucketPushContext {
@@ -111,7 +111,7 @@ export interface TestRunBitbucketPushContext {
     beforeSha: string;
     /** Commit hash after the push event */
     afterSha: string;
-    /** Git ref for the branch (/refs/head/<branch>) */
+    /** Git ref for the branch (/refs/heads/<branch>) */
     ref: string;
 }
 export type ReasonPullRequestIsNotAvailable = "no-pull-requests-found-for-commit" | "multiple-pull-requests-for-same-commit" | "all-pull-requests-had-skip-meticulous-label" | "only-found-merged-pull-requests-for-which-commit-is-the-merge-commit" | "commit-is-already-on-base-branch";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.201.0",
+  "version": "2.206.2",
   "description": "Meticulous API types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -35,5 +35,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "febc97c342ee826171aff37a12df09e2a70a12bd"
+  "gitHead": "49f1744bf7100a39c45cb0c6ee3247e7d607330d"
 }