@atlaskit/editor-common 110.29.1 → 110.30.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/editor-common
 
+## 110.30.0
+
+### Minor Changes
+
+- [`42bd907443147`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/42bd907443147) -
+  NO-ISSUE Ensures INP metrics and other analytics account for max appearance
+
+### Patch Changes
+
+- Updated dependencies
+
+## 110.29.2
+
+### Patch Changes
+
+- [`76e788fce7750`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/76e788fce7750) -
+  ED-29665 experience tracking updates
+- Updated dependencies
+
 ## 110.29.1
 
 ### Patch Changes

package/afm-jira/tsconfig.json

@@ -3,7 +3,7 @@
 	"compilerOptions": {
 		"declaration": true,
 		"target": "es5",
-		"outDir": "../../../../../tsDist/@atlaskit__editor-common/app",
+		"outDir": "../../../../../jira/tsDist/@atlaskit__editor-common/app",
 		"rootDir": "../",
 		"composite": true
 	},

package/dist/cjs/experiences/Experience.js

@@ -23,14 +23,45 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
    * Ensures that every tracked start has corresponding abort/fail/success tracked.
    */
 
+  /**
+   * Timestamp (in milliseconds) when the experience transitioned to 'started' state.
+   *
+   * Used to calculate experience duration. Set via Date.now() when experience starts.
+   */
+
+  /**
+   * Metadata provided at experience start time to merge into subsequent events.
+   *
+   * Used to retain experienceStartMethod and other start-specific metadata.
+   */
+
+  /**
+   * Creates a new Experience instance for tracking user experiences.
+   *
+   * @param id - Unique identifier for the experience
+   * @param options - Configuration options for the experience
+   * @param options.checks - Experience checks to monitor for completion
+   * @param options.dispatchAnalyticsEvent - Function to dispatch analytics events
+   * @param options.sampleRate - Sample rate for experienceSampled events
+   * @param options.metadata - Global metadata to attach to all events
+   * @param options.action - Optional sub identifier for the specific experience action
+   */
   function Experience(id, options) {
     var _options$sampleRate;
     (0, _classCallCheck2.default)(this, Experience);
     (0, _defineProperty2.default)(this, "currentState", 'pending');
+    /**
+     * Set of experience states that have been seen in the current session.
+     *
+     * Used to determine if experienceStatusFirstSeen flag should be set in events.
+     */
     (0, _defineProperty2.default)(this, "statesSeen", new Set());
     this.id = id;
     this.dispatchAnalyticsEvent = options.dispatchAnalyticsEvent;
     this.sampleRate = (_options$sampleRate = options.sampleRate) !== null && _options$sampleRate !== void 0 ? _options$sampleRate : _consts.DEFAULT_EXPERIENCE_SAMPLE_RATE;
+    this.globalMetadata = _objectSpread(_objectSpread({}, options.metadata), {}, {
+      experienceAction: options.action
+    });
     this.check = new _ExperienceCheckComposite.ExperienceCheckComposite(options.checks || []);
   }
   return (0, _createClass2.default)(Experience, [{
@@ -40,17 +71,21 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
       this.stopCheck();
       this.check.start(function (_ref) {
         var status = _ref.status,
+          reason = _ref.reason,
           metadata = _ref.metadata;
         if (status === 'success') {
           _this.success({
+            reason: reason,
             metadata: metadata
           });
         } else if (status === 'abort') {
           _this.abort({
+            reason: reason,
             metadata: metadata
           });
         } else if (status === 'failure') {
           _this.failure({
+            reason: reason,
             metadata: metadata
           });
         }
@@ -62,12 +97,13 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
       this.check.stop();
     }
   }, {
-    key: "getEndStateConfig",
-    value: function getEndStateConfig(options) {
-      var _this$startOptions, _this$startOptions2;
-      return {
-        metadata: options !== null && options !== void 0 && options.metadata || (_this$startOptions = this.startOptions) !== null && _this$startOptions !== void 0 && _this$startOptions.metadata ? _objectSpread(_objectSpread({}, (_this$startOptions2 = this.startOptions) === null || _this$startOptions2 === void 0 ? void 0 : _this$startOptions2.metadata), options === null || options === void 0 ? void 0 : options.metadata) : undefined
-      };
+    key: "getEndStateMetadata",
+    value: function getEndStateMetadata(options) {
+      var metadata = _objectSpread({}, options === null || options === void 0 ? void 0 : options.metadata);
+      if (options !== null && options !== void 0 && options.reason) {
+        metadata.experienceEndReason = options.reason;
+      }
+      return metadata;
     }
 
     /**
@@ -87,12 +123,20 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
       if (!(0, _experienceState.canTransition)(this.currentState, toState)) {
         return false;
       }
-      this.statesSeen.add(toState);
       this.currentState = toState;
       if (toState === 'started') {
         this.isSampledTrackingEnabled = Math.random() < this.sampleRate;
+        this.startTimeMs = Date.now();
+        this.startMetadata = metadata;
       }
       this.trackTransition(toState, metadata);
+      if (toState === 'started') {
+        this.startCheck();
+      } else {
+        this.stopCheck();
+        this.startMetadata = undefined;
+      }
+      this.statesSeen.add(toState);
       return true;
     }
 
@@ -107,11 +151,13 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
   }, {
     key: "trackTransition",
     value: function trackTransition(toState, metadata) {
-      var attributes = _objectSpread({
+      var attributes = _objectSpread(_objectSpread(_objectSpread({
         experienceKey: this.id,
         experienceStatus: toState,
-        firstInSession: !this.statesSeen.has(toState)
-      }, metadata);
+        experienceStatusFirstSeen: !this.statesSeen.has(toState),
+        experienceStartTime: this.startTimeMs || 0,
+        experienceDuration: this.startTimeMs ? Date.now() - this.startTimeMs : 0
+      }, this.globalMetadata), this.startMetadata), metadata);
       var experienceMeasuredEvent = {
         action: _analytics.ACTION.EXPERIENCE_MEASURED,
         actionSubject: _analytics.ACTION_SUBJECT.EDITOR,
@@ -138,31 +184,36 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
      * Metadata from options will be merged with metadata provided in subsequent events.
      *
      * @param options - Configuration for starting the experience
-     * @param options.metadata - Optional metadata attached to all subsequent events for this started experience
+     * @param options.metadata - Optional custom metadata attached to all subsequent events for this started experience
+     * @param options.forceRestart - If true and experience already in progress will abort and restart
+     * @param options.method - Optional method for experience start, e.g., how the experience was initiated
      */
   }, {
     key: "start",
     value: function start(options) {
-      this.startOptions = options;
-      if (this.transitionTo('started', options === null || options === void 0 ? void 0 : options.metadata)) {
-        this.startCheck();
+      if (options.forceRestart && this.currentState === 'started') {
+        this.abort({
+          reason: _consts.EXPERIENCE_ABORT_REASON.RESTARTED
+        });
       }
+      return this.transitionTo('started', _objectSpread({
+        experienceStartMethod: options.method
+      }, options.metadata));
     }
 
     /**
      * Marks the experience as successful and stops any ongoing checks.
      *
      * @param options - Configuration for the success event
-     * @param options.metadata - Optional metadata attached to the success event
+     * @param options.metadata - Optional custom metadata attached to the success event
+     * @param options.reason - Optional reason for success
+     * @returns false if transition to success state was not valid
      */
   }, {
     key: "success",
     value: function success(options) {
-      var mergedConfig = this.getEndStateConfig(options);
-      if (this.transitionTo('succeeded', mergedConfig.metadata)) {
-        this.stopCheck();
-        this.startOptions = undefined;
-      }
+      var metadata = this.getEndStateMetadata(options);
+      return this.transitionTo('succeeded', metadata);
     }
 
     /**
@@ -172,22 +223,22 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
      * (e.g., component unmount, navigation). This is neither success nor failure.
      *
      * @param options - Configuration for the abort event
-     * @param options.metadata - Optional metadata attached to the abort event
+     * @param options.metadata - Optional custom metadata attached to the abort event
+     * @param options.reason - Optional reason for abort
      *
      * @example
      * // Abort on component unmount
      * useEffect(() => {
-     *   return () => experience.abort({ metadata: { reason: 'unmount' } });
+     *   return () => experience.abort({ reason: 'unmount', metadata: { someKey: 'someValue' } });
      * }, []);
+     *
+     * @returns false if transition to aborted state was not valid
      */
   }, {
     key: "abort",
     value: function abort(options) {
-      var mergedConfig = this.getEndStateConfig(options);
-      if (this.transitionTo('aborted', mergedConfig.metadata)) {
-        this.stopCheck();
-        this.startOptions = undefined;
-      }
+      var metadata = this.getEndStateMetadata(options);
+      return this.transitionTo('aborted', metadata);
     }
 
     /**
@@ -196,16 +247,15 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
      * Use this for actual failures in the experience flow (e.g., timeout, error conditions).
      *
      * @param options - Configuration for the failure event
-     * @param options.metadata - Optional metadata attached to the failure event
+     * @param options.metadata - Optional custom metadata attached to the failure event
+     * @param options.reason - Optional reason for failure
+     * @returns false if transition to failed state was not valid
      */
   }, {
     key: "failure",
     value: function failure(options) {
-      var mergedConfig = this.getEndStateConfig(options);
-      if (this.transitionTo('failed', mergedConfig.metadata)) {
-        this.stopCheck();
-        this.startOptions = undefined;
-      }
+      var metadata = this.getEndStateMetadata(options);
+      return this.transitionTo('failed', metadata);
     }
   }]);
 }();

package/dist/cjs/experiences/ExperienceCheckDomMutation.js

@@ -33,9 +33,7 @@ var ExperienceCheckDomMutation = exports.ExperienceCheckDomMutation = /*#__PURE_
       if (!(config !== null && config !== void 0 && config.target)) {
         callback({
           status: 'failure',
-          metadata: {
-            reason: _consts.EXPERIENCE_FAILURE_REASON.DOM_MUTATION_TARGET_NOT_FOUND
-          }
+          reason: _consts.EXPERIENCE_FAILURE_REASON.DOM_MUTATION_TARGET_NOT_FOUND
         });
         return;
       }
@@ -50,9 +48,7 @@ var ExperienceCheckDomMutation = exports.ExperienceCheckDomMutation = /*#__PURE_
         } catch (error) {
           callback({
             status: 'failure',
-            metadata: {
-              reason: _consts.EXPERIENCE_FAILURE_REASON.DOM_MUTATION_CHECK_ERROR
-            }
+            reason: _consts.EXPERIENCE_FAILURE_REASON.DOM_MUTATION_CHECK_ERROR
           });
         }
       });

package/dist/cjs/experiences/ExperienceCheckTimeout.js

@@ -11,9 +11,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _consts = require("./consts");
 var DEFAULT_FAILURE_RESULT = {
   status: 'failure',
-  metadata: {
-    reason: _consts.EXPERIENCE_FAILURE_REASON.TIMEOUT
-  }
+  reason: _consts.EXPERIENCE_FAILURE_REASON.TIMEOUT
 };
 
 /**

package/dist/cjs/experiences/consts.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.EXPERIENCE_FAILURE_REASON = exports.DEFAULT_EXPERIENCE_SAMPLE_RATE = void 0;
+exports.EXPERIENCE_FAILURE_REASON = exports.EXPERIENCE_ABORT_REASON = exports.DEFAULT_EXPERIENCE_SAMPLE_RATE = void 0;
 /**
  * Built-in failure reasons for experience checks
  *
@@ -25,13 +25,27 @@ var EXPERIENCE_FAILURE_REASON = exports.EXPERIENCE_FAILURE_REASON = {
   DOM_MUTATION_CHECK_ERROR: 'dom-mutation-check-error'
 };
 
+/**
+ * Built-in abort reasons for experiences.
+ *
+ * These may be used by various ExperienceCheck implementations to
+ * provide consistent, well-known abort reasons for analytics and debugging.
+ */
+var EXPERIENCE_ABORT_REASON = exports.EXPERIENCE_ABORT_REASON = {
+  /**
+   * Experience was aborted because it was restarted while already in progress
+   */
+  RESTARTED: 'restarted'
+};
+
 /**
  * Default sample rate for experienceSampled events.
  * Set to 1 in 1000 (0.001) to balance data collection with event volume.
  *
  * Newly defined experiences should use this default unless they have data
- * to justify a different rate. The expectation is that measurements will be
- * gathered after initial instrumentation, then the sample rate can be tuned
- * up to a safe threshold.
+ * to justify a different rate.
+ *
+ * The expectation is that measurements will be gathered after initial
+ * instrumentation, then the sample rate can be tuned up to a safe threshold.
  */
 var DEFAULT_EXPERIENCE_SAMPLE_RATE = exports.DEFAULT_EXPERIENCE_SAMPLE_RATE = 0.001;

package/dist/cjs/experiences/experience-state.js

@@ -4,10 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.canTransition = exports.EXPERIENCE_STATE_TRANSITIONS = void 0;
-/**
- * Represents the state of an experience throughout its lifecycle.
- */
-
 /**
  * State transition map defining valid state transitions.
  */

package/dist/cjs/experiences/index.js

@@ -3,6 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "EXPERIENCE_ABORT_REASON", {
+  enumerable: true,
+  get: function get() {
+    return _consts.EXPERIENCE_ABORT_REASON;
+  }
+});
 Object.defineProperty(exports, "EXPERIENCE_FAILURE_REASON", {
   enumerable: true,
   get: function get() {

package/dist/cjs/experiences/types.js

@@ -0,0 +1 @@
+"use strict";

package/dist/cjs/monitoring/error.js

@@ -16,7 +16,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "110.29.0";
+var packageVersion = "0.0.0-development";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/ui/DropList/index.js

@@ -24,7 +24,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * @jsx jsx
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "110.29.0";
+var packageVersion = "0.0.0-development";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/cjs/utils/analytics.js

@@ -22,6 +22,8 @@ var getAnalyticsAppearance = exports.getAnalyticsAppearance = function getAnalyt
       return _FabricEditorAnalyticsContext.EDITOR_APPEARANCE_CONTEXT.CHROMELESS;
     case 'mobile':
       return _FabricEditorAnalyticsContext.EDITOR_APPEARANCE_CONTEXT.MOBILE;
+    case 'max':
+      return _FabricEditorAnalyticsContext.EDITOR_APPEARANCE_CONTEXT.MAX;
   }
 };
 var getAnalyticsEditorAppearance = exports.getAnalyticsEditorAppearance = function getAnalyticsEditorAppearance(editorAppearance) {

package/dist/es2019/experiences/Experience.js

@@ -1,6 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '../analytics';
-import { DEFAULT_EXPERIENCE_SAMPLE_RATE } from './consts';
+import { DEFAULT_EXPERIENCE_SAMPLE_RATE, EXPERIENCE_ABORT_REASON } from './consts';
 import { canTransition } from './experience-state';
 import { ExperienceCheckComposite } from './ExperienceCheckComposite';
 export class Experience {
@@ -12,31 +12,67 @@ export class Experience {
    * Ensures that every tracked start has corresponding abort/fail/success tracked.
    */
 
+  /**
+   * Timestamp (in milliseconds) when the experience transitioned to 'started' state.
+   *
+   * Used to calculate experience duration. Set via Date.now() when experience starts.
+   */
+
+  /**
+   * Metadata provided at experience start time to merge into subsequent events.
+   *
+   * Used to retain experienceStartMethod and other start-specific metadata.
+   */
+
+  /**
+   * Creates a new Experience instance for tracking user experiences.
+   *
+   * @param id - Unique identifier for the experience
+   * @param options - Configuration options for the experience
+   * @param options.checks - Experience checks to monitor for completion
+   * @param options.dispatchAnalyticsEvent - Function to dispatch analytics events
+   * @param options.sampleRate - Sample rate for experienceSampled events
+   * @param options.metadata - Global metadata to attach to all events
+   * @param options.action - Optional sub identifier for the specific experience action
+   */
   constructor(id, options) {
     var _options$sampleRate;
     _defineProperty(this, "currentState", 'pending');
+    /**
+     * Set of experience states that have been seen in the current session.
+     *
+     * Used to determine if experienceStatusFirstSeen flag should be set in events.
+     */
     _defineProperty(this, "statesSeen", new Set());
     this.id = id;
     this.dispatchAnalyticsEvent = options.dispatchAnalyticsEvent;
     this.sampleRate = (_options$sampleRate = options.sampleRate) !== null && _options$sampleRate !== void 0 ? _options$sampleRate : DEFAULT_EXPERIENCE_SAMPLE_RATE;
+    this.globalMetadata = {
+      ...options.metadata,
+      experienceAction: options.action
+    };
     this.check = new ExperienceCheckComposite(options.checks || []);
   }
   startCheck() {
     this.stopCheck();
     this.check.start(({
       status,
+      reason,
       metadata
     }) => {
       if (status === 'success') {
         this.success({
+          reason,
           metadata
         });
       } else if (status === 'abort') {
         this.abort({
+          reason,
           metadata
         });
       } else if (status === 'failure') {
         this.failure({
+          reason,
           metadata
         });
       }
@@ -45,14 +81,14 @@ export class Experience {
   stopCheck() {
     this.check.stop();
   }
-  getEndStateConfig(options) {
-    var _this$startOptions, _this$startOptions2;
-    return {
-      metadata: options !== null && options !== void 0 && options.metadata || (_this$startOptions = this.startOptions) !== null && _this$startOptions !== void 0 && _this$startOptions.metadata ? {
-        ...((_this$startOptions2 = this.startOptions) === null || _this$startOptions2 === void 0 ? void 0 : _this$startOptions2.metadata),
-        ...(options === null || options === void 0 ? void 0 : options.metadata)
-      } : undefined
+  getEndStateMetadata(options) {
+    const metadata = {
+      ...(options === null || options === void 0 ? void 0 : options.metadata)
     };
+    if (options !== null && options !== void 0 && options.reason) {
+      metadata.experienceEndReason = options.reason;
+    }
+    return metadata;
   }
 
   /**
@@ -70,12 +106,20 @@ export class Experience {
     if (!canTransition(this.currentState, toState)) {
       return false;
     }
-    this.statesSeen.add(toState);
     this.currentState = toState;
     if (toState === 'started') {
       this.isSampledTrackingEnabled = Math.random() < this.sampleRate;
+      this.startTimeMs = Date.now();
+      this.startMetadata = metadata;
     }
     this.trackTransition(toState, metadata);
+    if (toState === 'started') {
+      this.startCheck();
+    } else {
+      this.stopCheck();
+      this.startMetadata = undefined;
+    }
+    this.statesSeen.add(toState);
     return true;
   }
 
@@ -91,7 +135,11 @@ export class Experience {
     const attributes = {
       experienceKey: this.id,
       experienceStatus: toState,
-      firstInSession: !this.statesSeen.has(toState),
+      experienceStatusFirstSeen: !this.statesSeen.has(toState),
+      experienceStartTime: this.startTimeMs || 0,
+      experienceDuration: this.startTimeMs ? Date.now() - this.startTimeMs : 0,
+      ...this.globalMetadata,
+      ...this.startMetadata,
       ...metadata
     };
     const experienceMeasuredEvent = {
@@ -120,27 +168,33 @@ export class Experience {
    * Metadata from options will be merged with metadata provided in subsequent events.
    *
    * @param options - Configuration for starting the experience
-   * @param options.metadata - Optional metadata attached to all subsequent events for this started experience
+   * @param options.metadata - Optional custom metadata attached to all subsequent events for this started experience
+   * @param options.forceRestart - If true and experience already in progress will abort and restart
+   * @param options.method - Optional method for experience start, e.g., how the experience was initiated
    */
   start(options) {
-    this.startOptions = options;
-    if (this.transitionTo('started', options === null || options === void 0 ? void 0 : options.metadata)) {
-      this.startCheck();
+    if (options.forceRestart && this.currentState === 'started') {
+      this.abort({
+        reason: EXPERIENCE_ABORT_REASON.RESTARTED
+      });
     }
+    return this.transitionTo('started', {
+      experienceStartMethod: options.method,
+      ...options.metadata
+    });
   }
 
   /**
    * Marks the experience as successful and stops any ongoing checks.
    *
    * @param options - Configuration for the success event
-   * @param options.metadata - Optional metadata attached to the success event
+   * @param options.metadata - Optional custom metadata attached to the success event
+   * @param options.reason - Optional reason for success
+   * @returns false if transition to success state was not valid
    */
   success(options) {
-    const mergedConfig = this.getEndStateConfig(options);
-    if (this.transitionTo('succeeded', mergedConfig.metadata)) {
-      this.stopCheck();
-      this.startOptions = undefined;
-    }
+    const metadata = this.getEndStateMetadata(options);
+    return this.transitionTo('succeeded', metadata);
   }
 
   /**
@@ -150,20 +204,20 @@ export class Experience {
    * (e.g., component unmount, navigation). This is neither success nor failure.
    *
    * @param options - Configuration for the abort event
-   * @param options.metadata - Optional metadata attached to the abort event
+   * @param options.metadata - Optional custom metadata attached to the abort event
+   * @param options.reason - Optional reason for abort
    *
    * @example
    * // Abort on component unmount
    * useEffect(() => {
-   *   return () => experience.abort({ metadata: { reason: 'unmount' } });
+   *   return () => experience.abort({ reason: 'unmount', metadata: { someKey: 'someValue' } });
    * }, []);
+   *
+   * @returns false if transition to aborted state was not valid
    */
   abort(options) {
-    const mergedConfig = this.getEndStateConfig(options);
-    if (this.transitionTo('aborted', mergedConfig.metadata)) {
-      this.stopCheck();
-      this.startOptions = undefined;
-    }
+    const metadata = this.getEndStateMetadata(options);
+    return this.transitionTo('aborted', metadata);
   }
 
   /**
@@ -172,13 +226,12 @@ export class Experience {
    * Use this for actual failures in the experience flow (e.g., timeout, error conditions).
    *
    * @param options - Configuration for the failure event
-   * @param options.metadata - Optional metadata attached to the failure event
+   * @param options.metadata - Optional custom metadata attached to the failure event
+   * @param options.reason - Optional reason for failure
+   * @returns false if transition to failed state was not valid
    */
   failure(options) {
-    const mergedConfig = this.getEndStateConfig(options);
-    if (this.transitionTo('failed', mergedConfig.metadata)) {
-      this.stopCheck();
-      this.startOptions = undefined;
-    }
+    const metadata = this.getEndStateMetadata(options);
+    return this.transitionTo('failed', metadata);
   }
 }

package/dist/es2019/experiences/ExperienceCheckDomMutation.js

@@ -21,9 +21,7 @@ export class ExperienceCheckDomMutation {
     if (!(config !== null && config !== void 0 && config.target)) {
       callback({
         status: 'failure',
-        metadata: {
-          reason: EXPERIENCE_FAILURE_REASON.DOM_MUTATION_TARGET_NOT_FOUND
-        }
+        reason: EXPERIENCE_FAILURE_REASON.DOM_MUTATION_TARGET_NOT_FOUND
       });
       return;
     }
@@ -38,9 +36,7 @@ export class ExperienceCheckDomMutation {
       } catch (error) {
         callback({
           status: 'failure',
-          metadata: {
-            reason: EXPERIENCE_FAILURE_REASON.DOM_MUTATION_CHECK_ERROR
-          }
+          reason: EXPERIENCE_FAILURE_REASON.DOM_MUTATION_CHECK_ERROR
         });
       }
     });

package/dist/es2019/experiences/ExperienceCheckTimeout.js

@@ -2,9 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { EXPERIENCE_FAILURE_REASON } from './consts';
 const DEFAULT_FAILURE_RESULT = {
   status: 'failure',
-  metadata: {
-    reason: EXPERIENCE_FAILURE_REASON.TIMEOUT
-  }
+  reason: EXPERIENCE_FAILURE_REASON.TIMEOUT
 };
 
 /**