@atlaskit/editor-common 74.7.2 → 74.7.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-common
 
+## 74.7.3
+
+### Patch Changes
+
+- [`1259df9a9ef`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1259df9a9ef) - converted some of block-type's analytics to use new EditorAnalyticsAPI
+
 ## 74.7.2
 
 ### Patch Changes

package/dist/cjs/editor-analytics/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "withAnalytics", {
+  enumerable: true,
+  get: function get() {
+    return _withAnalytics.withAnalytics;
+  }
+});
+var _withAnalytics = require("./withAnalytics");

package/dist/cjs/editor-analytics/withAnalytics.js

@@ -0,0 +1,55 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.withAnalytics = withAnalytics;
+/**
+ * Callback accepts EditorState
+ *
+ * @remarks
+ * The plugin using the Analytics may using an Optional<Analytics> dependency
+ * It can be undefined during testing, we may not have included analytics
+ * Also in cases where Analytics fails to load, the editor doesn't crash.
+ *
+ * @param state - EditorState, passed to the callback
+ */
+
+/**
+ * Analytics API
+ * @example
+ * ```
+ * withAnalytics({
+ * eventType: EVENT_TYPE.TRACK,
+ * action: ACTION.REPLACED_ONE,
+ *  actionSubject: ACTION_SUBJECT.TEXT,
+ *   attributes: {
+ *    triggerMethod,
+ *  },
+ * })(replace(replaceText))
+ * ```
+ *
+ * @param analyticsApi - EditorAnalyticsAPI, undefined in tests or if analytics fails to load
+ * @param payload - AnalyticsEventPayload | AnalyticsEventPayloadCallback - payload to be attached to the transaction
+ * @param channel - string - channel to be used for analytics
+ */
+function withAnalytics(analyticsApi, payload, channel) {
+  return function (command) {
+    return function (state, dispatch, view) {
+      return command(state, function (tr) {
+        if (dispatch) {
+          if (payload instanceof Function) {
+            var dynamicPayload = payload(state);
+            if (dynamicPayload) {
+              analyticsApi === null || analyticsApi === void 0 ? void 0 : analyticsApi.attachAnalyticsEvent(dynamicPayload, channel)(tr);
+              dispatch(tr);
+            }
+          } else {
+            analyticsApi === null || analyticsApi === void 0 ? void 0 : analyticsApi.attachAnalyticsEvent(payload, channel)(tr);
+            dispatch(tr);
+          }
+        }
+      }, view);
+    };
+  };
+}

package/dist/cjs/monitoring/error.js

@@ -16,7 +16,7 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 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 = "74.7.2";
+var packageVersion = "74.7.3";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

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

@@ -24,7 +24,7 @@ var _templateObject, _templateObject2, _templateObject3;
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } } /** @jsx jsx */
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "74.7.2";
+var packageVersion = "74.7.3";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "74.7.2",
+	"version": "74.7.3",
 	"sideEffects": false
 }

package/dist/es2019/editor-analytics/index.js

@@ -0,0 +1 @@
+export { withAnalytics } from './withAnalytics';

package/dist/es2019/editor-analytics/withAnalytics.js

@@ -0,0 +1,45 @@
+/**
+ * Callback accepts EditorState
+ *
+ * @remarks
+ * The plugin using the Analytics may using an Optional<Analytics> dependency
+ * It can be undefined during testing, we may not have included analytics
+ * Also in cases where Analytics fails to load, the editor doesn't crash.
+ *
+ * @param state - EditorState, passed to the callback
+ */
+
+/**
+ * Analytics API
+ * @example
+ * ```
+ * withAnalytics({
+ * eventType: EVENT_TYPE.TRACK,
+ * action: ACTION.REPLACED_ONE,
+ *  actionSubject: ACTION_SUBJECT.TEXT,
+ *   attributes: {
+ *    triggerMethod,
+ *  },
+ * })(replace(replaceText))
+ * ```
+ *
+ * @param analyticsApi - EditorAnalyticsAPI, undefined in tests or if analytics fails to load
+ * @param payload - AnalyticsEventPayload | AnalyticsEventPayloadCallback - payload to be attached to the transaction
+ * @param channel - string - channel to be used for analytics
+ */
+export function withAnalytics(analyticsApi, payload, channel) {
+  return command => (state, dispatch, view) => command(state, tr => {
+    if (dispatch) {
+      if (payload instanceof Function) {
+        const dynamicPayload = payload(state);
+        if (dynamicPayload) {
+          analyticsApi === null || analyticsApi === void 0 ? void 0 : analyticsApi.attachAnalyticsEvent(dynamicPayload, channel)(tr);
+          dispatch(tr);
+        }
+      } else {
+        analyticsApi === null || analyticsApi === void 0 ? void 0 : analyticsApi.attachAnalyticsEvent(payload, channel)(tr);
+        dispatch(tr);
+      }
+    }
+  }, view);
+}

package/dist/es2019/monitoring/error.js

@@ -1,6 +1,6 @@
 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 = "74.7.2";
+const packageVersion = "74.7.3";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

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

@@ -8,7 +8,7 @@ import { themed } from '@atlaskit/theme/components';
 import { borderRadius } from '@atlaskit/theme/constants';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "74.7.2";
+const packageVersion = "74.7.3";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 class DropList extends Component {

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "74.7.2",
+	"version": "74.7.3",
 	"sideEffects": false
 }

package/dist/esm/editor-analytics/index.js

@@ -0,0 +1 @@
+export { withAnalytics } from './withAnalytics';

package/dist/esm/editor-analytics/withAnalytics.js

@@ -0,0 +1,49 @@
+/**
+ * Callback accepts EditorState
+ *
+ * @remarks
+ * The plugin using the Analytics may using an Optional<Analytics> dependency
+ * It can be undefined during testing, we may not have included analytics
+ * Also in cases where Analytics fails to load, the editor doesn't crash.
+ *
+ * @param state - EditorState, passed to the callback
+ */
+
+/**
+ * Analytics API
+ * @example
+ * ```
+ * withAnalytics({
+ * eventType: EVENT_TYPE.TRACK,
+ * action: ACTION.REPLACED_ONE,
+ *  actionSubject: ACTION_SUBJECT.TEXT,
+ *   attributes: {
+ *    triggerMethod,
+ *  },
+ * })(replace(replaceText))
+ * ```
+ *
+ * @param analyticsApi - EditorAnalyticsAPI, undefined in tests or if analytics fails to load
+ * @param payload - AnalyticsEventPayload | AnalyticsEventPayloadCallback - payload to be attached to the transaction
+ * @param channel - string - channel to be used for analytics
+ */
+export function withAnalytics(analyticsApi, payload, channel) {
+  return function (command) {
+    return function (state, dispatch, view) {
+      return command(state, function (tr) {
+        if (dispatch) {
+          if (payload instanceof Function) {
+            var dynamicPayload = payload(state);
+            if (dynamicPayload) {
+              analyticsApi === null || analyticsApi === void 0 ? void 0 : analyticsApi.attachAnalyticsEvent(dynamicPayload, channel)(tr);
+              dispatch(tr);
+            }
+          } else {
+            analyticsApi === null || analyticsApi === void 0 ? void 0 : analyticsApi.attachAnalyticsEvent(payload, channel)(tr);
+            dispatch(tr);
+          }
+        }
+      }, view);
+    };
+  };
+}

package/dist/esm/monitoring/error.js

@@ -6,7 +6,7 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 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 = "74.7.2";
+var packageVersion = "74.7.3";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

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

@@ -18,7 +18,7 @@ import { themed } from '@atlaskit/theme/components';
 import { borderRadius } from '@atlaskit/theme/constants';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "74.7.2";
+var packageVersion = "74.7.3";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "74.7.2",
+	"version": "74.7.3",
 	"sideEffects": false
 }

package/dist/types/editor-analytics/index.d.ts

@@ -0,0 +1 @@
+export { withAnalytics } from './withAnalytics';

package/dist/types/editor-analytics/withAnalytics.d.ts

@@ -0,0 +1,34 @@
+import type { EditorState } from 'prosemirror-state';
+import type { AnalyticsEventPayload, EditorAnalyticsAPI } from '../analytics';
+import type { HigherOrderCommand } from '../types';
+/**
+ * Callback accepts EditorState
+ *
+ * @remarks
+ * The plugin using the Analytics may using an Optional<Analytics> dependency
+ * It can be undefined during testing, we may not have included analytics
+ * Also in cases where Analytics fails to load, the editor doesn't crash.
+ *
+ * @param state - EditorState, passed to the callback
+ */
+type AnalyticsEventPayloadCallback = (state: EditorState) => AnalyticsEventPayload | undefined;
+/**
+ * Analytics API
+ * @example
+ * ```
+ * withAnalytics({
+ * eventType: EVENT_TYPE.TRACK,
+ * action: ACTION.REPLACED_ONE,
+ *  actionSubject: ACTION_SUBJECT.TEXT,
+ *   attributes: {
+ *    triggerMethod,
+ *  },
+ * })(replace(replaceText))
+ * ```
+ *
+ * @param analyticsApi - EditorAnalyticsAPI, undefined in tests or if analytics fails to load
+ * @param payload - AnalyticsEventPayload | AnalyticsEventPayloadCallback - payload to be attached to the transaction
+ * @param channel - string - channel to be used for analytics
+ */
+export declare function withAnalytics(analyticsApi: EditorAnalyticsAPI | undefined, payload: AnalyticsEventPayload | AnalyticsEventPayloadCallback, channel?: string): HigherOrderCommand;
+export {};

package/dist/types-ts4.5/editor-analytics/index.d.ts

@@ -0,0 +1 @@
+export { withAnalytics } from './withAnalytics';

package/dist/types-ts4.5/editor-analytics/withAnalytics.d.ts

@@ -0,0 +1,34 @@
+import type { EditorState } from 'prosemirror-state';
+import type { AnalyticsEventPayload, EditorAnalyticsAPI } from '../analytics';
+import type { HigherOrderCommand } from '../types';
+/**
+ * Callback accepts EditorState
+ *
+ * @remarks
+ * The plugin using the Analytics may using an Optional<Analytics> dependency
+ * It can be undefined during testing, we may not have included analytics
+ * Also in cases where Analytics fails to load, the editor doesn't crash.
+ *
+ * @param state - EditorState, passed to the callback
+ */
+type AnalyticsEventPayloadCallback = (state: EditorState) => AnalyticsEventPayload | undefined;
+/**
+ * Analytics API
+ * @example
+ * ```
+ * withAnalytics({
+ * eventType: EVENT_TYPE.TRACK,
+ * action: ACTION.REPLACED_ONE,
+ *  actionSubject: ACTION_SUBJECT.TEXT,
+ *   attributes: {
+ *    triggerMethod,
+ *  },
+ * })(replace(replaceText))
+ * ```
+ *
+ * @param analyticsApi - EditorAnalyticsAPI, undefined in tests or if analytics fails to load
+ * @param payload - AnalyticsEventPayload | AnalyticsEventPayloadCallback - payload to be attached to the transaction
+ * @param channel - string - channel to be used for analytics
+ */
+export declare function withAnalytics(analyticsApi: EditorAnalyticsAPI | undefined, payload: AnalyticsEventPayload | AnalyticsEventPayloadCallback, channel?: string): HigherOrderCommand;
+export {};

package/editor-analytics/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/editor-common/editor-analytics",
+  "main": "../dist/cjs/editor-analytics/index.js",
+  "module": "../dist/esm/editor-analytics/index.js",
+  "module:es2019": "../dist/es2019/editor-analytics/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/editor-analytics/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "../dist/types-ts4.5/editor-analytics/index.d.ts"
+      ]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-common",
-  "version": "74.7.2",
+  "version": "74.7.3",
   "description": "A package that contains common classes and components for editor and renderer",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -66,7 +66,8 @@
     "./hooks": "./src/hooks/index.ts",
     "./monitoring": "./src/monitoring/index.ts",
     "./paste": "./src/paste/index.ts",
-    "./resizer": "./src/resizer/index.ts"
+    "./resizer": "./src/resizer/index.ts",
+    "./editor-analytics": "./src/editor-analytics/index.ts"
   },
   "dependencies": {
     "@atlaskit/activity-provider": "^2.4.0",