@atlaskit/editor-plugin-media 0.8.0 → 0.8.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/editor-plugin-media
 
+## 0.8.1
+
+### Patch Changes
+
+- [#63388](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/63388) [`999a8302f404`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/999a8302f404) - add analytics for changing media inline to media single
+- [#63608](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/63608) [`bfb98fe84eae`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/bfb98fe84eae) - [ux] EDF-93: Report and resolve existing duplicate i18n message descriptor keys/IDs in editor, as precursor work to adding CI check
+
 ## 0.8.0
 
 ### Minor Changes

package/dist/cjs/pm-plugins/mediaResizeAnnouncerMess.js

@@ -22,7 +22,7 @@ var mediaResizeAnnouncerMess = exports.mediaResizeAnnouncerMess = (0, _reactIntl
     description: 'Media width {action} to {newMediaWidth} pixels.'
   },
   IncreasedAction: {
-    id: 'fabric.editor.media.decreased',
+    id: 'fabric.editor.media.increased',
     defaultMessage: 'increased',
     description: 'Increased action'
   },

package/dist/cjs/utils/analytics.js

@@ -3,8 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getMediaResizeAnalyticsEvent = exports.getMediaInputResizeAnalyticsEvent = void 0;
+exports.findChangeFromLocation = findChangeFromLocation;
+exports.getMediaResizeAnalyticsEvent = exports.getMediaInputResizeAnalyticsEvent = exports.getChangeMediaAnalytics = void 0;
 var _analytics = require("@atlaskit/editor-common/analytics");
+var _utils = require("@atlaskit/editor-prosemirror/utils");
 var getMediaResizeAnalyticsEvent = exports.getMediaResizeAnalyticsEvent = function getMediaResizeAnalyticsEvent(type, attributes) {
   if (!attributes) {
     return;
@@ -54,4 +56,25 @@ var getMediaInputResizeAnalyticsEvent = exports.getMediaInputResizeAnalyticsEven
     },
     eventType: _analytics.EVENT_TYPE.UI
   };
-};
+};
+var getChangeMediaAnalytics = exports.getChangeMediaAnalytics = function getChangeMediaAnalytics(previousType, newType, changeFromLocation) {
+  return {
+    action: _analytics.ACTION.CHANGED_TYPE,
+    actionSubject: _analytics.ACTION_SUBJECT.MEDIA,
+    eventType: _analytics.EVENT_TYPE.TRACK,
+    attributes: {
+      newType: newType,
+      previousType: previousType,
+      changeFromLocation: changeFromLocation
+    }
+  };
+};
+function findChangeFromLocation(selection) {
+  var _selection$$from$doc$ = selection.$from.doc.type,
+    schema = _selection$$from$doc$.schema,
+    name = _selection$$from$doc$.name;
+  var parentNodeInfo = (0, _utils.findParentNode)(function (node) {
+    return node.type !== schema.nodes.paragraph;
+  })(selection);
+  return parentNodeInfo ? parentNodeInfo.node.type.name : name;
+}

package/dist/cjs/utils/media-single.js

@@ -18,6 +18,7 @@ var _model = require("@atlaskit/editor-prosemirror/model");
 var _utils2 = require("@atlaskit/editor-prosemirror/utils");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _mediaCommon = require("../utils/media-common");
+var _analytics2 = require("./analytics");
 var _isType = require("./is-type");
 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; }
@@ -45,7 +46,9 @@ function insertNodesWithOptionalParagraph(nodes) {
       schema = state.schema;
     var paragraph = schema.nodes.paragraph;
     var inputMethod = analyticsAttributes.inputMethod,
-      fileExtension = analyticsAttributes.fileExtension;
+      fileExtension = analyticsAttributes.fileExtension,
+      newType = analyticsAttributes.newType,
+      previousType = analyticsAttributes.previousType;
     var openEnd = 0;
     if (shouldAddParagraph(state)) {
       nodes.push(paragraph.create());
@@ -55,6 +58,9 @@ function insertNodesWithOptionalParagraph(nodes) {
     if (inputMethod) {
       editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(getInsertMediaAnalytics(inputMethod, fileExtension))(tr);
     }
+    if (newType && previousType) {
+      editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent((0, _analytics2.getChangeMediaAnalytics)(previousType, newType, (0, _analytics2.findChangeFromLocation)(state.selection)))(tr);
+    }
     if (dispatch) {
       dispatch(tr);
     }
@@ -163,7 +169,9 @@ var changeFromMediaInlineToMediaSingleNode = exports.changeFromMediaInlineToMedi
     content: node
   })) {
     return insertNodesWithOptionalParagraph([node], {
-      fileExtension: fileExtension
+      fileExtension: fileExtension,
+      newType: _analytics.ACTION_SUBJECT_ID.MEDIA_SINGLE,
+      previousType: _analytics.ACTION_SUBJECT_ID.MEDIA_INLINE
     }, editorAnalyticsAPI)(state, dispatch);
   } else {
     var nodePos = state.tr.doc.resolve(state.selection.from).end();
@@ -174,7 +182,7 @@ var changeFromMediaInlineToMediaSingleNode = exports.changeFromMediaInlineToMedi
       var content = shouldAddParagraph(view.state) ? _model.Fragment.fromArray([node, state.schema.nodes.paragraph.create()]) : node;
       tr = (0, _utils2.safeInsert)(content, undefined, true)(state.tr);
     }
-    // TODO: add analytics specifically for change mediaInline to mediaSingle later
+    editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent((0, _analytics2.getChangeMediaAnalytics)(_analytics.ACTION_SUBJECT_ID.MEDIA_INLINE, _analytics.ACTION_SUBJECT_ID.MEDIA_SINGLE, (0, _analytics2.findChangeFromLocation)(state.selection)))(tr);
     dispatch(tr);
   }
   return true;

package/dist/es2019/pm-plugins/mediaResizeAnnouncerMess.js

@@ -16,7 +16,7 @@ export const mediaResizeAnnouncerMess = defineMessages({
     description: 'Media width {action} to {newMediaWidth} pixels.'
   },
   IncreasedAction: {
-    id: 'fabric.editor.media.decreased',
+    id: 'fabric.editor.media.increased',
     defaultMessage: 'increased',
     description: 'Increased action'
   },

package/dist/es2019/utils/analytics.js

@@ -1,4 +1,5 @@
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+import { findParentNode } from '@atlaskit/editor-prosemirror/utils';
 export const getMediaResizeAnalyticsEvent = (type, attributes) => {
   if (!attributes) {
     return;
@@ -52,4 +53,22 @@ export const getMediaInputResizeAnalyticsEvent = (type, attributes) => {
     },
     eventType: EVENT_TYPE.UI
   };
-};
+};
+export const getChangeMediaAnalytics = (previousType, newType, changeFromLocation) => ({
+  action: ACTION.CHANGED_TYPE,
+  actionSubject: ACTION_SUBJECT.MEDIA,
+  eventType: EVENT_TYPE.TRACK,
+  attributes: {
+    newType,
+    previousType,
+    changeFromLocation
+  }
+});
+export function findChangeFromLocation(selection) {
+  const {
+    schema,
+    name
+  } = selection.$from.doc.type;
+  const parentNodeInfo = findParentNode(node => node.type !== schema.nodes.paragraph)(selection);
+  return parentNodeInfo ? parentNodeInfo.node.type.name : name;
+}

package/dist/es2019/utils/media-single.js

@@ -8,6 +8,7 @@ import { Fragment, Slice } from '@atlaskit/editor-prosemirror/model';
 import { safeInsert as pmSafeInsert, removeSelectedNode } from '@atlaskit/editor-prosemirror/utils';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import { copyOptionalAttrsFromMediaState } from '../utils/media-common';
+import { findChangeFromLocation, getChangeMediaAnalytics } from './analytics';
 import { isImage } from './is-type';
 const getInsertMediaAnalytics = (inputMethod, fileExtension) => ({
   action: ACTION.INSERTED,
@@ -34,7 +35,9 @@ function insertNodesWithOptionalParagraph(nodes, analyticsAttributes = {}, edito
     } = schema.nodes;
     const {
       inputMethod,
-      fileExtension
+      fileExtension,
+      newType,
+      previousType
     } = analyticsAttributes;
     let openEnd = 0;
     if (shouldAddParagraph(state)) {
@@ -45,6 +48,9 @@ function insertNodesWithOptionalParagraph(nodes, analyticsAttributes = {}, edito
     if (inputMethod) {
       editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 ? void 0 : editorAnalyticsAPI.attachAnalyticsEvent(getInsertMediaAnalytics(inputMethod, fileExtension))(tr);
     }
+    if (newType && previousType) {
+      editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 ? void 0 : editorAnalyticsAPI.attachAnalyticsEvent(getChangeMediaAnalytics(previousType, newType, findChangeFromLocation(state.selection)))(tr);
+    }
     if (dispatch) {
       dispatch(tr);
     }
@@ -160,7 +166,9 @@ export const changeFromMediaInlineToMediaSingleNode = (view, fromNode, widthPlug
     content: node
   })) {
     return insertNodesWithOptionalParagraph([node], {
-      fileExtension
+      fileExtension,
+      newType: ACTION_SUBJECT_ID.MEDIA_SINGLE,
+      previousType: ACTION_SUBJECT_ID.MEDIA_INLINE
     }, editorAnalyticsAPI)(state, dispatch);
   } else {
     const nodePos = state.tr.doc.resolve(state.selection.from).end();
@@ -171,7 +179,7 @@ export const changeFromMediaInlineToMediaSingleNode = (view, fromNode, widthPlug
       const content = shouldAddParagraph(view.state) ? Fragment.fromArray([node, state.schema.nodes.paragraph.create()]) : node;
       tr = pmSafeInsert(content, undefined, true)(state.tr);
     }
-    // TODO: add analytics specifically for change mediaInline to mediaSingle later
+    editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 ? void 0 : editorAnalyticsAPI.attachAnalyticsEvent(getChangeMediaAnalytics(ACTION_SUBJECT_ID.MEDIA_INLINE, ACTION_SUBJECT_ID.MEDIA_SINGLE, findChangeFromLocation(state.selection)))(tr);
     dispatch(tr);
   }
   return true;

package/dist/esm/pm-plugins/mediaResizeAnnouncerMess.js

@@ -16,7 +16,7 @@ export var mediaResizeAnnouncerMess = defineMessages({
     description: 'Media width {action} to {newMediaWidth} pixels.'
   },
   IncreasedAction: {
-    id: 'fabric.editor.media.decreased',
+    id: 'fabric.editor.media.increased',
     defaultMessage: 'increased',
     description: 'Increased action'
   },

package/dist/esm/utils/analytics.js

@@ -1,4 +1,5 @@
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+import { findParentNode } from '@atlaskit/editor-prosemirror/utils';
 export var getMediaResizeAnalyticsEvent = function getMediaResizeAnalyticsEvent(type, attributes) {
   if (!attributes) {
     return;
@@ -48,4 +49,25 @@ export var getMediaInputResizeAnalyticsEvent = function getMediaInputResizeAnaly
     },
     eventType: EVENT_TYPE.UI
   };
-};
+};
+export var getChangeMediaAnalytics = function getChangeMediaAnalytics(previousType, newType, changeFromLocation) {
+  return {
+    action: ACTION.CHANGED_TYPE,
+    actionSubject: ACTION_SUBJECT.MEDIA,
+    eventType: EVENT_TYPE.TRACK,
+    attributes: {
+      newType: newType,
+      previousType: previousType,
+      changeFromLocation: changeFromLocation
+    }
+  };
+};
+export function findChangeFromLocation(selection) {
+  var _selection$$from$doc$ = selection.$from.doc.type,
+    schema = _selection$$from$doc$.schema,
+    name = _selection$$from$doc$.name;
+  var parentNodeInfo = findParentNode(function (node) {
+    return node.type !== schema.nodes.paragraph;
+  })(selection);
+  return parentNodeInfo ? parentNodeInfo.node.type.name : name;
+}

package/dist/esm/utils/media-single.js

@@ -11,6 +11,7 @@ import { Fragment, Slice } from '@atlaskit/editor-prosemirror/model';
 import { safeInsert as pmSafeInsert, removeSelectedNode } from '@atlaskit/editor-prosemirror/utils';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import { copyOptionalAttrsFromMediaState } from '../utils/media-common';
+import { findChangeFromLocation, getChangeMediaAnalytics } from './analytics';
 import { isImage } from './is-type';
 var getInsertMediaAnalytics = function getInsertMediaAnalytics(inputMethod, fileExtension) {
   return {
@@ -36,7 +37,9 @@ function insertNodesWithOptionalParagraph(nodes) {
       schema = state.schema;
     var paragraph = schema.nodes.paragraph;
     var inputMethod = analyticsAttributes.inputMethod,
-      fileExtension = analyticsAttributes.fileExtension;
+      fileExtension = analyticsAttributes.fileExtension,
+      newType = analyticsAttributes.newType,
+      previousType = analyticsAttributes.previousType;
     var openEnd = 0;
     if (shouldAddParagraph(state)) {
       nodes.push(paragraph.create());
@@ -46,6 +49,9 @@ function insertNodesWithOptionalParagraph(nodes) {
     if (inputMethod) {
       editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(getInsertMediaAnalytics(inputMethod, fileExtension))(tr);
     }
+    if (newType && previousType) {
+      editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(getChangeMediaAnalytics(previousType, newType, findChangeFromLocation(state.selection)))(tr);
+    }
     if (dispatch) {
       dispatch(tr);
     }
@@ -154,7 +160,9 @@ export var changeFromMediaInlineToMediaSingleNode = function changeFromMediaInli
     content: node
   })) {
     return insertNodesWithOptionalParagraph([node], {
-      fileExtension: fileExtension
+      fileExtension: fileExtension,
+      newType: ACTION_SUBJECT_ID.MEDIA_SINGLE,
+      previousType: ACTION_SUBJECT_ID.MEDIA_INLINE
     }, editorAnalyticsAPI)(state, dispatch);
   } else {
     var nodePos = state.tr.doc.resolve(state.selection.from).end();
@@ -165,7 +173,7 @@ export var changeFromMediaInlineToMediaSingleNode = function changeFromMediaInli
       var content = shouldAddParagraph(view.state) ? Fragment.fromArray([node, state.schema.nodes.paragraph.create()]) : node;
       tr = pmSafeInsert(content, undefined, true)(state.tr);
     }
-    // TODO: add analytics specifically for change mediaInline to mediaSingle later
+    editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(getChangeMediaAnalytics(ACTION_SUBJECT_ID.MEDIA_INLINE, ACTION_SUBJECT_ID.MEDIA_SINGLE, findChangeFromLocation(state.selection)))(tr);
     dispatch(tr);
   }
   return true;

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

@@ -1,3 +1,6 @@
-import type { MediaEventPayload, MediaInputResizeTrackAction, MediaResizeTrackAction } from '@atlaskit/editor-common/analytics';
+import type { MediaEventPayload, MediaInputResizeTrackAction, MediaResizeTrackAction, MediaSwitchType } from '@atlaskit/editor-common/analytics';
+import type { Selection } from '@atlaskit/editor-prosemirror/state';
 export declare const getMediaResizeAnalyticsEvent: <T extends MediaResizeTrackAction>(type: string, attributes: T["attributes"]) => MediaEventPayload | void;
 export declare const getMediaInputResizeAnalyticsEvent: <T extends MediaInputResizeTrackAction>(type: string, attributes: T["attributes"]) => MediaEventPayload | void;
+export declare const getChangeMediaAnalytics: (previousType: MediaSwitchType, newType: MediaSwitchType, changeFromLocation?: string) => MediaEventPayload;
+export declare function findChangeFromLocation(selection: Selection): string;

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

@@ -1,3 +1,6 @@
-import type { MediaEventPayload, MediaInputResizeTrackAction, MediaResizeTrackAction } from '@atlaskit/editor-common/analytics';
+import type { MediaEventPayload, MediaInputResizeTrackAction, MediaResizeTrackAction, MediaSwitchType } from '@atlaskit/editor-common/analytics';
+import type { Selection } from '@atlaskit/editor-prosemirror/state';
 export declare const getMediaResizeAnalyticsEvent: <T extends MediaResizeTrackAction>(type: string, attributes: T["attributes"]) => MediaEventPayload | void;
 export declare const getMediaInputResizeAnalyticsEvent: <T extends MediaInputResizeTrackAction>(type: string, attributes: T["attributes"]) => MediaEventPayload | void;
+export declare const getChangeMediaAnalytics: (previousType: MediaSwitchType, newType: MediaSwitchType, changeFromLocation?: string) => MediaEventPayload;
+export declare function findChangeFromLocation(selection: Selection): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-media",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "Media plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -65,7 +65,7 @@
     "@atlaskit/platform-feature-flags": "^0.2.0",
     "@atlaskit/textfield": "^6.0.0",
     "@atlaskit/theme": "^12.6.0",
-    "@atlaskit/tokens": "^1.31.0",
+    "@atlaskit/tokens": "^1.32.0",
     "@atlaskit/tooltip": "^18.1.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",