@atlaskit/editor-common 111.0.1 → 111.0.3

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @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
+
+- [`7b54da3c92435`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7b54da3c92435) -
+  EDITOR-3993 Add analytics measure timings for transformNode function with operational events
+  tracking duration, node count, and source/target node types
+
 ## 111.0.1
 
 ### Patch Changes

package/dist/cjs/analytics/types/enums.js

@@ -186,6 +186,7 @@ var ACTION = exports.ACTION = /*#__PURE__*/function (ACTION) {
   ACTION["UPLOAD_SUCCEEDED"] = "uploadSucceeded";
   ACTION["UPLOAD_FAILED"] = "uploadFailed";
   ACTION["TOGGLE_CODE_BLOCK_WRAP"] = "toggleCodeBlockWrap";
+  ACTION["TRANSFORMED"] = "transformed";
   ACTION["RESIZED"] = "resized";
   ACTION["RESIZED_PERF_SAMPLING"] = "resizedPerfSampling";
   ACTION["BLOCKS_DRAG_INIT"] = "blocksDragInit";

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/cjs/monitoring/error.js

@@ -19,7 +19,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 = "111.0.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 = "111.0.0";
+var packageVersion = "0.0.0-development";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/es2019/analytics/types/enums.js

@@ -180,6 +180,7 @@ export let ACTION = /*#__PURE__*/function (ACTION) {
   ACTION["UPLOAD_SUCCEEDED"] = "uploadSucceeded";
   ACTION["UPLOAD_FAILED"] = "uploadFailed";
   ACTION["TOGGLE_CODE_BLOCK_WRAP"] = "toggleCodeBlockWrap";
+  ACTION["TRANSFORMED"] = "transformed";
   ACTION["RESIZED"] = "resized";
   ACTION["RESIZED_PERF_SAMPLING"] = "resizedPerfSampling";
   ACTION["BLOCKS_DRAG_INIT"] = "blocksDragInit";

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/es2019/monitoring/error.js

@@ -4,7 +4,7 @@ import { isFedRamp } from './environment';
 import { normaliseSentryBreadcrumbs, SERIALIZABLE_ATTRIBUTES } from './normalise-sentry-breadcrumbs';
 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 = "111.0.0";
+const packageVersion = "0.0.0-development";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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 = "111.0.0";
+const packageVersion = "0.0.0-development";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

package/dist/esm/analytics/types/enums.js

@@ -180,6 +180,7 @@ export var ACTION = /*#__PURE__*/function (ACTION) {
   ACTION["UPLOAD_SUCCEEDED"] = "uploadSucceeded";
   ACTION["UPLOAD_FAILED"] = "uploadFailed";
   ACTION["TOGGLE_CODE_BLOCK_WRAP"] = "toggleCodeBlockWrap";
+  ACTION["TRANSFORMED"] = "transformed";
   ACTION["RESIZED"] = "resized";
   ACTION["RESIZED_PERF_SAMPLING"] = "resizedPerfSampling";
   ACTION["BLOCKS_DRAG_INIT"] = "blocksDragInit";

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/esm/monitoring/error.js

@@ -10,7 +10,7 @@ import { isFedRamp } from './environment';
 import { normaliseSentryBreadcrumbs, SERIALIZABLE_ATTRIBUTES } from './normalise-sentry-breadcrumbs';
 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 = "111.0.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/esm/ui/DropList/index.js

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

package/dist/types/analytics/types/block-menu-events.d.ts

@@ -33,5 +33,15 @@ interface ElementTransformErrorAttr {
     triggeredFrom: INPUT_METHOD.MOUSE | INPUT_METHOD.KEYBOARD;
 }
 export type ElementTransformErrorAEP = OperationalAEP<ACTION.ERRORED, ACTION_SUBJECT.ELEMENT, ACTION_SUBJECT_ID.TRANSFORM, ElementTransformErrorAttr>;
-export type BlockMenuEventPayload = BlockMenuOpenedAEP | BlockMenuItemClickedAEP | ElementConvertedAEP | ElementTransformErrorAEP;
+interface ElementTransformPerformanceAttr {
+    duration: number;
+    isList: boolean;
+    isNested: boolean;
+    nodeCount: number;
+    sourceNodeTypes: Record<string, number>;
+    startTime: number;
+    targetNodeType: string;
+}
+export type ElementTransformPerformanceAEP = OperationalAEP<ACTION.TRANSFORMED, ACTION_SUBJECT.ELEMENT, ACTION_SUBJECT_ID.TRANSFORM, ElementTransformPerformanceAttr>;
+export type BlockMenuEventPayload = BlockMenuOpenedAEP | BlockMenuItemClickedAEP | ElementConvertedAEP | ElementTransformErrorAEP | ElementTransformPerformanceAEP;
 export {};

package/dist/types/analytics/types/enums.d.ts

@@ -179,6 +179,7 @@ export declare enum ACTION {
     UPLOAD_SUCCEEDED = "uploadSucceeded",
     UPLOAD_FAILED = "uploadFailed",
     TOGGLE_CODE_BLOCK_WRAP = "toggleCodeBlockWrap",
+    TRANSFORMED = "transformed",
     RESIZED = "resized",
     RESIZED_PERF_SAMPLING = "resizedPerfSampling",
     BLOCKS_DRAG_INIT = "blocksDragInit",

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/analytics/types/block-menu-events.d.ts

@@ -33,5 +33,15 @@ interface ElementTransformErrorAttr {
     triggeredFrom: INPUT_METHOD.MOUSE | INPUT_METHOD.KEYBOARD;
 }
 export type ElementTransformErrorAEP = OperationalAEP<ACTION.ERRORED, ACTION_SUBJECT.ELEMENT, ACTION_SUBJECT_ID.TRANSFORM, ElementTransformErrorAttr>;
-export type BlockMenuEventPayload = BlockMenuOpenedAEP | BlockMenuItemClickedAEP | ElementConvertedAEP | ElementTransformErrorAEP;
+interface ElementTransformPerformanceAttr {
+    duration: number;
+    isList: boolean;
+    isNested: boolean;
+    nodeCount: number;
+    sourceNodeTypes: Record<string, number>;
+    startTime: number;
+    targetNodeType: string;
+}
+export type ElementTransformPerformanceAEP = OperationalAEP<ACTION.TRANSFORMED, ACTION_SUBJECT.ELEMENT, ACTION_SUBJECT_ID.TRANSFORM, ElementTransformPerformanceAttr>;
+export type BlockMenuEventPayload = BlockMenuOpenedAEP | BlockMenuItemClickedAEP | ElementConvertedAEP | ElementTransformErrorAEP | ElementTransformPerformanceAEP;
 export {};

package/dist/types-ts4.5/analytics/types/enums.d.ts

@@ -179,6 +179,7 @@ export declare enum ACTION {
     UPLOAD_SUCCEEDED = "uploadSucceeded",
     UPLOAD_FAILED = "uploadFailed",
     TOGGLE_CODE_BLOCK_WRAP = "toggleCodeBlockWrap",
+    TRANSFORMED = "transformed",
     RESIZED = "resized",
     RESIZED_PERF_SAMPLING = "resizedPerfSampling",
     BLOCKS_DRAG_INIT = "blocksDragInit",

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.1",
+	"version": "111.0.3",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"