@atlaskit/editor-common 111.0.2 → 111.0.3

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/editor-common
 
+## 111.0.3
+
+### Patch Changes
+
+- [`496cc8412a7dc`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/496cc8412a7dc) -
+  ED-29616 Experience tracking tests and docs
+
 ## 111.0.2
 
 ### Patch Changes

package/dist/cjs/experiences/Experience.js

@@ -100,9 +100,10 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
     }
   }, {
     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) {
+    value: function getEndStateMetadata() {
+      var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      var metadata = _objectSpread({}, options.metadata);
+      if (options.reason) {
         metadata.experienceEndReason = options.reason;
       }
       return metadata;
@@ -192,7 +193,8 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
      */
   }, {
     key: "start",
-    value: function start(options) {
+    value: function start() {
+      var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       if (options.forceRestart && this.currentState === 'started') {
         this.abort({
           reason: _consts.EXPERIENCE_ABORT_REASON.RESTARTED
@@ -213,7 +215,8 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
      */
   }, {
     key: "success",
-    value: function success(options) {
+    value: function success() {
+      var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       var metadata = this.getEndStateMetadata(options);
       return this.transitionTo('succeeded', metadata);
     }
@@ -238,7 +241,8 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
      */
   }, {
     key: "abort",
-    value: function abort(options) {
+    value: function abort() {
+      var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       var metadata = this.getEndStateMetadata(options);
       return this.transitionTo('aborted', metadata);
     }
@@ -255,7 +259,8 @@ var Experience = exports.Experience = /*#__PURE__*/function () {
      */
   }, {
     key: "failure",
-    value: function failure(options) {
+    value: function failure() {
+      var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       var metadata = this.getEndStateMetadata(options);
       return this.transitionTo('failed', metadata);
     }

package/dist/es2019/experiences/Experience.js

@@ -83,11 +83,11 @@ export class Experience {
   stopCheck() {
     this.check.stop();
   }
-  getEndStateMetadata(options) {
+  getEndStateMetadata(options = {}) {
     const metadata = {
-      ...(options === null || options === void 0 ? void 0 : options.metadata)
+      ...options.metadata
     };
-    if (options !== null && options !== void 0 && options.reason) {
+    if (options.reason) {
       metadata.experienceEndReason = options.reason;
     }
     return metadata;
@@ -174,7 +174,7 @@ export class 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) {
+  start(options = {}) {
     if (options.forceRestart && this.currentState === 'started') {
       this.abort({
         reason: EXPERIENCE_ABORT_REASON.RESTARTED
@@ -194,7 +194,7 @@ export class Experience {
    * @param options.reason - Optional reason for success
    * @returns false if transition to success state was not valid
    */
-  success(options) {
+  success(options = {}) {
     const metadata = this.getEndStateMetadata(options);
     return this.transitionTo('succeeded', metadata);
   }
@@ -217,7 +217,7 @@ export class Experience {
    *
    * @returns false if transition to aborted state was not valid
    */
-  abort(options) {
+  abort(options = {}) {
     const metadata = this.getEndStateMetadata(options);
     return this.transitionTo('aborted', metadata);
   }
@@ -232,7 +232,7 @@ export class Experience {
    * @param options.reason - Optional reason for failure
    * @returns false if transition to failed state was not valid
    */
-  failure(options) {
+  failure(options = {}) {
     const metadata = this.getEndStateMetadata(options);
     return this.transitionTo('failed', metadata);
   }

package/dist/esm/experiences/Experience.js

@@ -93,9 +93,10 @@ export var Experience = /*#__PURE__*/function () {
     }
   }, {
     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) {
+    value: function getEndStateMetadata() {
+      var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      var metadata = _objectSpread({}, options.metadata);
+      if (options.reason) {
         metadata.experienceEndReason = options.reason;
       }
       return metadata;
@@ -185,7 +186,8 @@ export var Experience = /*#__PURE__*/function () {
      */
   }, {
     key: "start",
-    value: function start(options) {
+    value: function start() {
+      var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       if (options.forceRestart && this.currentState === 'started') {
         this.abort({
           reason: EXPERIENCE_ABORT_REASON.RESTARTED
@@ -206,7 +208,8 @@ export var Experience = /*#__PURE__*/function () {
      */
   }, {
     key: "success",
-    value: function success(options) {
+    value: function success() {
+      var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       var metadata = this.getEndStateMetadata(options);
       return this.transitionTo('succeeded', metadata);
     }
@@ -231,7 +234,8 @@ export var Experience = /*#__PURE__*/function () {
      */
   }, {
     key: "abort",
-    value: function abort(options) {
+    value: function abort() {
+      var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       var metadata = this.getEndStateMetadata(options);
       return this.transitionTo('aborted', metadata);
     }
@@ -248,7 +252,8 @@ export var Experience = /*#__PURE__*/function () {
      */
   }, {
     key: "failure",
-    value: function failure(options) {
+    value: function failure() {
+      var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       var metadata = this.getEndStateMetadata(options);
       return this.transitionTo('failed', metadata);
     }

package/dist/types/experiences/Experience.d.ts

@@ -134,7 +134,7 @@ export declare class 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: ExperienceStartOptions): boolean;
+    start(options?: ExperienceStartOptions): boolean;
     /**
      * Marks the experience as successful and stops any ongoing checks.
      *

package/dist/types-ts4.5/experiences/Experience.d.ts

@@ -134,7 +134,7 @@ export declare class 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: ExperienceStartOptions): boolean;
+    start(options?: ExperienceStartOptions): boolean;
     /**
      * Marks the experience as successful and stops any ongoing checks.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "111.0.2",
+	"version": "111.0.3",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"