@atlaskit/editor-common 110.18.4 → 110.18.5

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-common
 
+## 110.18.5
+
+### Patch Changes
+
+- [`822ed20eeca65`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/822ed20eeca65) -
+  Clean up platform_editor_fix_unsubscribe_of_provider
+- [`7aff1e36b43e1`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7aff1e36b43e1) -
+  Improve editor selection toolbar experience tracking
+- [`3cbddf575e48e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3cbddf575e48e) -
+  platform_editor_ai_open_chat_general_ai_fg clean up
+
 ## 110.18.4
 
 ### Patch Changes

package/dist/cjs/experiences/Experience.js

@@ -5,10 +5,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.Experience = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _ufo = require("@atlaskit/ufo");
 var _ExperienceCheckComposite = require("./ExperienceCheckComposite");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var PROGRESS_STATES = [_ufo.UFOExperienceState.STARTED.id, _ufo.UFOExperienceState.IN_PROGRESS.id];
 var Experience = exports.Experience = /*#__PURE__*/function () {
   function Experience(id) {
@@ -38,11 +41,18 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
       var _this = this;
       this.stopCheck();
       this.check.start(function (result) {
+        var metadata = result.metadata;
         if (result.status === 'success') {
-          _this.success();
-        } else {
+          _this.success({
+            metadata: metadata
+          });
+        } else if (result.status === 'abort') {
+          _this.abort({
+            metadata: metadata
+          });
+        } else if (result.status === 'failure') {
           _this.failure({
-            reason: result.reason
+            metadata: metadata
           });
         }
       });
@@ -57,13 +67,28 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
     value: function isInProgress() {
       return PROGRESS_STATES.includes(this.ufoExperience.state.id);
     }
+  }, {
+    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
+      };
+    }
 
     /**
-     * Starts UFO experience tracking and starts all checks which monitor for completion of the experience.
+     * Starts tracking the experience and all checks which monitor for completion.
+     *
+     * If the experience is already in progress, this will restart the checks.
+     * Metadata from options will be merged with any end state metadata.
+     *
+     * @param options - Configuration for starting the experience
+     * @param options.metadata - Optional metadata attached to all subsequent events for this started experience
      */
   }, {
     key: "start",
-    value: function start() {
+    value: function start(options) {
+      this.startOptions = options === null || options === void 0 ? void 0 : options.metadata;
       this.ufoExperience.start();
       if (this.isInProgress()) {
         this.startCheck();
@@ -71,43 +96,58 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
     }
 
     /**
-     * Manually mark the experience as successful and stop any ongoing checks.
+     * Marks the experience as successful and stops any ongoing checks.
+     *
+     * Use this when the experience completes as expected.
+     *
+     * @param options - Configuration for the success event
+     * @param options.metadata - Optional metadata attached to the success event
      */
   }, {
     key: "success",
-    value: function success() {
+    value: function success(options) {
       this.stopCheck();
-      this.ufoExperience.success();
+      this.ufoExperience.success(this.getEndStateConfig(options));
+      this.startOptions = undefined;
     }
 
     /**
-     * Manually abort the experience and stop any ongoing checks.
+     * Aborts the experience and stops any ongoing checks.
+     *
+     * Use this when a started experience terminates early due to user action or context change
+     * (e.g., component unmount, navigation). This is neither success nor failure.
      *
-     * Typically used when the experience did not complete due to user action and should not be marked as success or failure,
-     * for example on unmount or when navigating away from a page.
+     * @param options - Configuration for the abort event
+     * @param options.metadata - Optional metadata attached to the abort event
+     *
+     * @example
+     * // Abort on component unmount
+     * useEffect(() => {
+     *   return () => experience.abort({ metadata: { reason: 'unmount' } });
+     * }, []);
      */
   }, {
     key: "abort",
-    value: function abort() {
+    value: function abort(options) {
       this.stopCheck();
-      this.ufoExperience.abort();
+      this.ufoExperience.abort(this.getEndStateConfig(options));
+      this.startOptions = undefined;
     }
 
     /**
-     * Manually mark the experience as failed and stop any ongoing checks.
+     * Manually marks the experience as failed and stops any ongoing checks.
+     *
+     * 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
      */
   }, {
     key: "failure",
-    value: function failure() {
-      var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-        _ref$reason = _ref.reason,
-        reason = _ref$reason === void 0 ? 'error' : _ref$reason;
+    value: function failure(options) {
       this.stopCheck();
-      this.ufoExperience.failure({
-        metadata: {
-          reason: reason
-        }
-      });
+      this.ufoExperience.failure(this.getEndStateConfig(options));
+      this.startOptions = undefined;
     }
   }]);
 }();

package/dist/cjs/experiences/ExperienceCheck.js

@@ -1 +1,5 @@
-"use strict";
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/cjs/experiences/ExperienceCheckDomMutation.js

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

package/dist/cjs/experiences/ExperienceCheckTimeout.js

@@ -7,27 +7,43 @@ Object.defineProperty(exports, "__esModule", {
 exports.ExperienceCheckTimeout = void 0;
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _consts = require("./consts");
+var DEFAULT_FAILURE_RESULT = {
+  status: 'failure',
+  metadata: {
+    reason: _consts.EXPERIENCE_FAILURE_REASON.TIMEOUT
+  }
+};
+
 /**
  * Check for the completion of an experience based on a timeout
  *
- * Will always result in failure after the timeout duration
+ * By default, will result in failure with reason 'timeout' after the specified duration.
+ *
+ * Can be customized for different results on timeout via the onTimeout callback.
  */
 var ExperienceCheckTimeout = exports.ExperienceCheckTimeout = /*#__PURE__*/function () {
-  function ExperienceCheckTimeout(maxDurationMs) {
+  function ExperienceCheckTimeout(_ref) {
+    var durationMs = _ref.durationMs,
+      _ref$onTimeout = _ref.onTimeout,
+      onTimeout = _ref$onTimeout === void 0 ? function () {
+        return DEFAULT_FAILURE_RESULT;
+      } : _ref$onTimeout;
     (0, _classCallCheck2.default)(this, ExperienceCheckTimeout);
-    this.maxDurationMs = maxDurationMs;
+    (0, _defineProperty2.default)(this, "durationMs", 0);
+    this.durationMs = durationMs;
+    this.onTimeout = onTimeout;
   }
   return (0, _createClass2.default)(ExperienceCheckTimeout, [{
     key: "start",
     value: function start(callback) {
+      var _this = this;
       this.stop();
       this.timeoutId = setTimeout(function () {
-        callback({
-          status: 'failure',
-          reason: _consts.EXPERIENCE_FAILURE_REASON.TIMEOUT
-        });
-      }, this.maxDurationMs);
+        var result = _this.onTimeout() || DEFAULT_FAILURE_RESULT;
+        callback(result);
+      }, this.durationMs);
     }
   }, {
     key: "stop",

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.18.3";
+var packageVersion = "110.18.4";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/provider-factory/with-providers.js

@@ -12,7 +12,6 @@ var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/ge
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = require("react");
-var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
@@ -71,7 +70,7 @@ var WithProviders = exports.WithProviders = /*#__PURE__*/function (_PureComponen
         providers = _this$props.providers,
         providerFactory = _this$props.providerFactory;
       providers.forEach(function (name) {
-        providerFactory.unsubscribe(name, (0, _platformFeatureFlags.fg)('platform_editor_fix_unsubscribe_of_provider') ? _this2.handleProviderIfMounted : _this2.handleProvider);
+        providerFactory.unsubscribe(name, _this2.handleProviderIfMounted);
       });
     }
   }, {

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.18.3";
+var packageVersion = "110.18.4";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/es2019/experiences/Experience.js

@@ -22,11 +22,20 @@ export class Experience {
   startCheck() {
     this.stopCheck();
     this.check.start(result => {
+      const {
+        metadata
+      } = result;
       if (result.status === 'success') {
-        this.success();
-      } else {
+        this.success({
+          metadata
+        });
+      } else if (result.status === 'abort') {
+        this.abort({
+          metadata
+        });
+      } else if (result.status === 'failure') {
         this.failure({
-          reason: result.reason
+          metadata
         });
       }
     });
@@ -37,11 +46,27 @@ export class Experience {
   isInProgress() {
     return PROGRESS_STATES.includes(this.ufoExperience.state.id);
   }
+  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
+    };
+  }
 
   /**
-   * Starts UFO experience tracking and starts all checks which monitor for completion of the experience.
+   * Starts tracking the experience and all checks which monitor for completion.
+   *
+   * If the experience is already in progress, this will restart the checks.
+   * Metadata from options will be merged with any end state metadata.
+   *
+   * @param options - Configuration for starting the experience
+   * @param options.metadata - Optional metadata attached to all subsequent events for this started experience
    */
-  start() {
+  start(options) {
+    this.startOptions = options === null || options === void 0 ? void 0 : options.metadata;
     this.ufoExperience.start();
     if (this.isInProgress()) {
       this.startCheck();
@@ -49,35 +74,51 @@ export class Experience {
   }
 
   /**
-   * Manually mark the experience as successful and stop any ongoing checks.
+   * Marks the experience as successful and stops any ongoing checks.
+   *
+   * Use this when the experience completes as expected.
+   *
+   * @param options - Configuration for the success event
+   * @param options.metadata - Optional metadata attached to the success event
    */
-  success() {
+  success(options) {
     this.stopCheck();
-    this.ufoExperience.success();
+    this.ufoExperience.success(this.getEndStateConfig(options));
+    this.startOptions = undefined;
   }
 
   /**
-   * Manually abort the experience and stop any ongoing checks.
+   * Aborts the experience and stops any ongoing checks.
    *
-   * Typically used when the experience did not complete due to user action and should not be marked as success or failure,
-   * for example on unmount or when navigating away from a page.
+   * Use this when a started experience terminates early due to user action or context change
+   * (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
+   *
+   * @example
+   * // Abort on component unmount
+   * useEffect(() => {
+   *   return () => experience.abort({ metadata: { reason: 'unmount' } });
+   * }, []);
    */
-  abort() {
+  abort(options) {
     this.stopCheck();
-    this.ufoExperience.abort();
+    this.ufoExperience.abort(this.getEndStateConfig(options));
+    this.startOptions = undefined;
   }
 
   /**
-   * Manually mark the experience as failed and stop any ongoing checks.
+   * Manually marks the experience as failed and stops any ongoing checks.
+   *
+   * 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
    */
-  failure({
-    reason = 'error'
-  } = {}) {
+  failure(options) {
     this.stopCheck();
-    this.ufoExperience.failure({
-      metadata: {
-        reason
-      }
-    });
+    this.ufoExperience.failure(this.getEndStateConfig(options));
+    this.startOptions = undefined;
   }
 }

package/dist/es2019/experiences/ExperienceCheck.js

@@ -0,0 +1 @@
+export {};

package/dist/es2019/experiences/ExperienceCheckDomMutation.js

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

package/dist/es2019/experiences/ExperienceCheckTimeout.js

@@ -1,21 +1,34 @@
+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
+  }
+};
+
 /**
  * Check for the completion of an experience based on a timeout
  *
- * Will always result in failure after the timeout duration
+ * By default, will result in failure with reason 'timeout' after the specified duration.
+ *
+ * Can be customized for different results on timeout via the onTimeout callback.
  */
 export class ExperienceCheckTimeout {
-  constructor(maxDurationMs) {
-    this.maxDurationMs = maxDurationMs;
+  constructor({
+    durationMs,
+    onTimeout = () => DEFAULT_FAILURE_RESULT
+  }) {
+    _defineProperty(this, "durationMs", 0);
+    this.durationMs = durationMs;
+    this.onTimeout = onTimeout;
   }
   start(callback) {
     this.stop();
     this.timeoutId = setTimeout(() => {
-      callback({
-        status: 'failure',
-        reason: EXPERIENCE_FAILURE_REASON.TIMEOUT
-      });
-    }, this.maxDurationMs);
+      const result = this.onTimeout() || DEFAULT_FAILURE_RESULT;
+      callback(result);
+    }, this.durationMs);
   }
   stop() {
     if (this.timeoutId) {

package/dist/es2019/monitoring/error.js

@@ -1,7 +1,7 @@
 import { isFedRamp } from './environment';
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "110.18.3";
+const packageVersion = "110.18.4";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/es2019/provider-factory/with-providers.js

@@ -1,7 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 /* eslint-disable @repo/internal/react/no-class-components */
 import { PureComponent } from 'react';
-import { fg } from '@atlaskit/platform-feature-flags';
 // Ignored via go/ees005
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export class WithProviders extends PureComponent {
@@ -52,7 +51,7 @@ export class WithProviders extends PureComponent {
       providerFactory
     } = this.props;
     providers.forEach(name => {
-      providerFactory.unsubscribe(name, fg('platform_editor_fix_unsubscribe_of_provider') ? this.handleProviderIfMounted : this.handleProvider);
+      providerFactory.unsubscribe(name, this.handleProviderIfMounted);
     });
   }
   render() {

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

@@ -14,7 +14,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "110.18.3";
+const packageVersion = "110.18.4";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

package/dist/esm/experiences/Experience.js

@@ -1,5 +1,8 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { ExperiencePerformanceTypes, ExperienceTypes, UFOExperience, UFOExperienceState } from '@atlaskit/ufo';
 import { ExperienceCheckComposite } from './ExperienceCheckComposite';
 var PROGRESS_STATES = [UFOExperienceState.STARTED.id, UFOExperienceState.IN_PROGRESS.id];
@@ -31,11 +34,18 @@ export var Experience = /*#__PURE__*/function () {
       var _this = this;
       this.stopCheck();
       this.check.start(function (result) {
+        var metadata = result.metadata;
         if (result.status === 'success') {
-          _this.success();
-        } else {
+          _this.success({
+            metadata: metadata
+          });
+        } else if (result.status === 'abort') {
+          _this.abort({
+            metadata: metadata
+          });
+        } else if (result.status === 'failure') {
           _this.failure({
-            reason: result.reason
+            metadata: metadata
           });
         }
       });
@@ -50,13 +60,28 @@ export var Experience = /*#__PURE__*/function () {
     value: function isInProgress() {
       return PROGRESS_STATES.includes(this.ufoExperience.state.id);
     }
+  }, {
+    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
+      };
+    }
 
     /**
-     * Starts UFO experience tracking and starts all checks which monitor for completion of the experience.
+     * Starts tracking the experience and all checks which monitor for completion.
+     *
+     * If the experience is already in progress, this will restart the checks.
+     * Metadata from options will be merged with any end state metadata.
+     *
+     * @param options - Configuration for starting the experience
+     * @param options.metadata - Optional metadata attached to all subsequent events for this started experience
      */
   }, {
     key: "start",
-    value: function start() {
+    value: function start(options) {
+      this.startOptions = options === null || options === void 0 ? void 0 : options.metadata;
       this.ufoExperience.start();
       if (this.isInProgress()) {
         this.startCheck();
@@ -64,43 +89,58 @@ export var Experience = /*#__PURE__*/function () {
     }
 
     /**
-     * Manually mark the experience as successful and stop any ongoing checks.
+     * Marks the experience as successful and stops any ongoing checks.
+     *
+     * Use this when the experience completes as expected.
+     *
+     * @param options - Configuration for the success event
+     * @param options.metadata - Optional metadata attached to the success event
      */
   }, {
     key: "success",
-    value: function success() {
+    value: function success(options) {
       this.stopCheck();
-      this.ufoExperience.success();
+      this.ufoExperience.success(this.getEndStateConfig(options));
+      this.startOptions = undefined;
     }
 
     /**
-     * Manually abort the experience and stop any ongoing checks.
+     * Aborts the experience and stops any ongoing checks.
+     *
+     * Use this when a started experience terminates early due to user action or context change
+     * (e.g., component unmount, navigation). This is neither success nor failure.
      *
-     * Typically used when the experience did not complete due to user action and should not be marked as success or failure,
-     * for example on unmount or when navigating away from a page.
+     * @param options - Configuration for the abort event
+     * @param options.metadata - Optional metadata attached to the abort event
+     *
+     * @example
+     * // Abort on component unmount
+     * useEffect(() => {
+     *   return () => experience.abort({ metadata: { reason: 'unmount' } });
+     * }, []);
      */
   }, {
     key: "abort",
-    value: function abort() {
+    value: function abort(options) {
       this.stopCheck();
-      this.ufoExperience.abort();
+      this.ufoExperience.abort(this.getEndStateConfig(options));
+      this.startOptions = undefined;
     }
 
     /**
-     * Manually mark the experience as failed and stop any ongoing checks.
+     * Manually marks the experience as failed and stops any ongoing checks.
+     *
+     * 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
      */
   }, {
     key: "failure",
-    value: function failure() {
-      var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-        _ref$reason = _ref.reason,
-        reason = _ref$reason === void 0 ? 'error' : _ref$reason;
+    value: function failure(options) {
       this.stopCheck();
-      this.ufoExperience.failure({
-        metadata: {
-          reason: reason
-        }
-      });
+      this.ufoExperience.failure(this.getEndStateConfig(options));
+      this.startOptions = undefined;
     }
   }]);
 }();

package/dist/esm/experiences/ExperienceCheck.js

@@ -0,0 +1 @@
+export {};