@atlaskit/editor-plugin-media 9.6.4 → 9.7.1

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/editor-plugin-media
 
+## 9.7.1
+
+### Patch Changes
+
+- Updated dependencies
+
+## 9.7.0
+
+### Minor Changes
+
+- [`27de3457c3a79`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/27de3457c3a79) -
+  EDITOR-5532 add context to media error events
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 9.6.4
 
 ### Patch Changes

package/dist/cjs/mediaPlugin.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.mediaPlugin = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = _interopRequireWildcard(require("react"));
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _hooks = require("@atlaskit/editor-common/hooks");
@@ -16,6 +17,7 @@ var _toolbarFlagCheck = require("@atlaskit/editor-common/toolbar-flag-check");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _mediaCommon = require("@atlaskit/media-common");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _lazyMediaGroup = require("./nodeviews/lazy-media-group");
 var _lazyMediaInline = require("./nodeviews/lazy-media-inline");
 var _mediaNodeView = require("./nodeviews/mediaNodeView");
@@ -41,6 +43,8 @@ var _PortalWrapper = require("./ui/MediaViewer/PortalWrapper");
 var _toolbar = require("./ui/toolbar");
 var _ToolbarMedia = _interopRequireDefault(require("./ui/ToolbarMedia"));
 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); }
+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 selector = function selector(states) {
   var _states$mediaState, _states$mediaState2;
   return {
@@ -122,22 +126,26 @@ var mediaPlugin = exports.mediaPlugin = function mediaPlugin(_ref3) {
       return _pluginKey.stateKey.getState(editorState) || null;
     },
     actions: {
-      handleMediaNodeRenderError: function handleMediaNodeRenderError(node, reason) {
+      handleMediaNodeRenderError: function handleMediaNodeRenderError(node, reason, nestedUnder) {
         var _api$analytics;
-        // Only fire the errored event once per media node
-        if (mediaErrorLocalIds.has(node.attrs.localId)) {
-          return;
+        if (!(0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+          // Only fire the errored event once per media node
+          if (mediaErrorLocalIds.has(node.attrs.localId)) {
+            return;
+          }
+          mediaErrorLocalIds.add(node.attrs.localId);
         }
-        mediaErrorLocalIds.add(node.attrs.localId);
         api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || _api$analytics.actions.fireAnalyticsEvent({
           action: _analytics.ACTION.ERRORED,
           actionSubject: _analytics.ACTION_SUBJECT.EDITOR,
           actionSubjectId: _analytics.ACTION_SUBJECT_ID.MEDIA,
           eventType: _analytics.EVENT_TYPE.UI,
-          attributes: {
+          attributes: _objectSpread({
             reason: reason,
             external: node.attrs.__external
-          }
+          }, nestedUnder && (0, _expValEquals.expValEquals)('platform_synced_block', 'isEnabled', true) && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5') ? {
+            nestedUnder: nestedUnder
+          } : {})
         });
       },
       insertMediaAsMediaSingle: function insertMediaAsMediaSingle(view, node, inputMethod, insertMediaVia) {

package/dist/cjs/nodeviews/mediaNodeView/media.js

@@ -21,6 +21,7 @@ var _analyticsNamespacedContext = require("@atlaskit/analytics-namespaced-contex
 var _analyticsNext = require("@atlaskit/analytics-next");
 var _toolbarFlagCheck = require("@atlaskit/editor-common/toolbar-flag-check");
 var _utils = require("@atlaskit/editor-common/utils");
+var _utils2 = require("@atlaskit/editor-prosemirror/utils");
 var _cellSelection = require("@atlaskit/editor-tables/cell-selection");
 var _mediaCard = require("@atlaskit/media-card");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
@@ -121,7 +122,31 @@ var MediaNode = exports.MediaNode = /*#__PURE__*/function (_Component) {
     }));
     (0, _defineProperty2.default)(_this, "onError", function (reason) {
       var _this$props$api;
-      (_this$props$api = _this.props.api) === null || _this$props$api === void 0 || _this$props$api.media.actions.handleMediaNodeRenderError(_this.props.node, reason);
+      var nestedUnder = (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5') ? _this.getNestedUnder() : undefined;
+      (_this$props$api = _this.props.api) === null || _this$props$api === void 0 || _this$props$api.media.actions.handleMediaNodeRenderError(_this.props.node, reason, nestedUnder);
+    });
+    /**
+     * This function checks if the media node is nested under a certain nodes, and if so,
+     * returns the name of the parent node type. This is used for providing more context in media render errors.
+     * @returns
+     */
+    (0, _defineProperty2.default)(_this, "getNestedUnder", function () {
+      var pos = _this.props.getPos();
+      if (typeof pos !== 'number') {
+        return undefined;
+      }
+      var _this$props$view$stat = _this.props.view.state,
+        doc = _this$props$view$stat.doc,
+        schema = _this$props$view$stat.schema;
+      var bodiedSyncBlock = schema.nodes.bodiedSyncBlock;
+      if (!bodiedSyncBlock) {
+        return undefined;
+      }
+      var resolvedPos = doc.resolve(pos);
+      var bodiedSyncBlockNode = (0, _utils2.findParentNodeClosestToPos)(resolvedPos, function (currentNode) {
+        return currentNode.type === bodiedSyncBlock;
+      });
+      return bodiedSyncBlockNode === null || bodiedSyncBlockNode === void 0 ? void 0 : bodiedSyncBlockNode.node.type.name;
     });
     (0, _defineProperty2.default)(_this, "onFullscreenChange", function (fullscreen) {
       var _this$mediaPluginStat;

package/dist/es2019/mediaPlugin.js

@@ -8,6 +8,7 @@ import { areToolbarFlagsEnabled } from '@atlaskit/editor-common/toolbar-flag-che
 import { NodeSelection, PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { getMediaFeatureFlag } from '@atlaskit/media-common';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { lazyMediaGroupView } from './nodeviews/lazy-media-group';
 import { lazyMediaInlineView } from './nodeviews/lazy-media-inline';
 import { ReactMediaNode } from './nodeviews/mediaNodeView';
@@ -117,13 +118,15 @@ export const mediaPlugin = ({
       return stateKey.getState(editorState) || null;
     },
     actions: {
-      handleMediaNodeRenderError: (node, reason) => {
+      handleMediaNodeRenderError: (node, reason, nestedUnder) => {
         var _api$analytics;
-        // Only fire the errored event once per media node
-        if (mediaErrorLocalIds.has(node.attrs.localId)) {
-          return;
+        if (!fg('platform_synced_block_patch_5')) {
+          // Only fire the errored event once per media node
+          if (mediaErrorLocalIds.has(node.attrs.localId)) {
+            return;
+          }
+          mediaErrorLocalIds.add(node.attrs.localId);
         }
-        mediaErrorLocalIds.add(node.attrs.localId);
         api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions.fireAnalyticsEvent({
           action: ACTION.ERRORED,
           actionSubject: ACTION_SUBJECT.EDITOR,
@@ -131,7 +134,10 @@ export const mediaPlugin = ({
           eventType: EVENT_TYPE.UI,
           attributes: {
             reason,
-            external: node.attrs.__external
+            external: node.attrs.__external,
+            ...(nestedUnder && expValEquals('platform_synced_block', 'isEnabled', true) && fg('platform_synced_block_patch_5') ? {
+              nestedUnder
+            } : {})
           }
         });
       },

package/dist/es2019/nodeviews/mediaNodeView/media.js

@@ -6,6 +6,7 @@ import { MEDIA_CONTEXT } from '@atlaskit/analytics-namespaced-context';
 import { AnalyticsContext } from '@atlaskit/analytics-next';
 import { areToolbarFlagsEnabled } from '@atlaskit/editor-common/toolbar-flag-check';
 import { setNodeSelection, setTextSelection, withImageLoader } from '@atlaskit/editor-common/utils';
+import { findParentNodeClosestToPos } from '@atlaskit/editor-prosemirror/utils';
 import { CellSelection } from '@atlaskit/editor-tables/cell-selection';
 import { Card, CardLoading } from '@atlaskit/media-card';
 import { fg } from '@atlaskit/platform-feature-flags';
@@ -92,7 +93,32 @@ export class MediaNode extends Component {
     })));
     _defineProperty(this, "onError", reason => {
       var _this$props$api;
-      (_this$props$api = this.props.api) === null || _this$props$api === void 0 ? void 0 : _this$props$api.media.actions.handleMediaNodeRenderError(this.props.node, reason);
+      const nestedUnder = fg('platform_synced_block_patch_5') ? this.getNestedUnder() : undefined;
+      (_this$props$api = this.props.api) === null || _this$props$api === void 0 ? void 0 : _this$props$api.media.actions.handleMediaNodeRenderError(this.props.node, reason, nestedUnder);
+    });
+    /**
+     * This function checks if the media node is nested under a certain nodes, and if so,
+     * returns the name of the parent node type. This is used for providing more context in media render errors.
+     * @returns
+     */
+    _defineProperty(this, "getNestedUnder", () => {
+      const pos = this.props.getPos();
+      if (typeof pos !== 'number') {
+        return undefined;
+      }
+      const {
+        doc,
+        schema
+      } = this.props.view.state;
+      const {
+        bodiedSyncBlock
+      } = schema.nodes;
+      if (!bodiedSyncBlock) {
+        return undefined;
+      }
+      const resolvedPos = doc.resolve(pos);
+      const bodiedSyncBlockNode = findParentNodeClosestToPos(resolvedPos, currentNode => currentNode.type === bodiedSyncBlock);
+      return bodiedSyncBlockNode === null || bodiedSyncBlockNode === void 0 ? void 0 : bodiedSyncBlockNode.node.type.name;
     });
     _defineProperty(this, "onFullscreenChange", fullscreen => {
       var _this$mediaPluginStat;

package/dist/esm/mediaPlugin.js

@@ -1,3 +1,6 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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 React, { useMemo } from 'react';
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks';
@@ -8,6 +11,7 @@ import { areToolbarFlagsEnabled } from '@atlaskit/editor-common/toolbar-flag-che
 import { NodeSelection, PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { getMediaFeatureFlag } from '@atlaskit/media-common';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { lazyMediaGroupView } from './nodeviews/lazy-media-group';
 import { lazyMediaInlineView } from './nodeviews/lazy-media-inline';
 import { ReactMediaNode } from './nodeviews/mediaNodeView';
@@ -113,22 +117,26 @@ export var mediaPlugin = function mediaPlugin(_ref3) {
       return stateKey.getState(editorState) || null;
     },
     actions: {
-      handleMediaNodeRenderError: function handleMediaNodeRenderError(node, reason) {
+      handleMediaNodeRenderError: function handleMediaNodeRenderError(node, reason, nestedUnder) {
         var _api$analytics;
-        // Only fire the errored event once per media node
-        if (mediaErrorLocalIds.has(node.attrs.localId)) {
-          return;
+        if (!fg('platform_synced_block_patch_5')) {
+          // Only fire the errored event once per media node
+          if (mediaErrorLocalIds.has(node.attrs.localId)) {
+            return;
+          }
+          mediaErrorLocalIds.add(node.attrs.localId);
         }
-        mediaErrorLocalIds.add(node.attrs.localId);
         api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || _api$analytics.actions.fireAnalyticsEvent({
           action: ACTION.ERRORED,
           actionSubject: ACTION_SUBJECT.EDITOR,
           actionSubjectId: ACTION_SUBJECT_ID.MEDIA,
           eventType: EVENT_TYPE.UI,
-          attributes: {
+          attributes: _objectSpread({
             reason: reason,
             external: node.attrs.__external
-          }
+          }, nestedUnder && expValEquals('platform_synced_block', 'isEnabled', true) && fg('platform_synced_block_patch_5') ? {
+            nestedUnder: nestedUnder
+          } : {})
         });
       },
       insertMediaAsMediaSingle: function insertMediaAsMediaSingle(view, node, inputMethod, insertMediaVia) {

package/dist/esm/nodeviews/mediaNodeView/media.js

@@ -15,6 +15,7 @@ import { MEDIA_CONTEXT } from '@atlaskit/analytics-namespaced-context';
 import { AnalyticsContext } from '@atlaskit/analytics-next';
 import { areToolbarFlagsEnabled } from '@atlaskit/editor-common/toolbar-flag-check';
 import { setNodeSelection, setTextSelection, withImageLoader } from '@atlaskit/editor-common/utils';
+import { findParentNodeClosestToPos } from '@atlaskit/editor-prosemirror/utils';
 import { CellSelection } from '@atlaskit/editor-tables/cell-selection';
 import { Card, CardLoading } from '@atlaskit/media-card';
 import { fg } from '@atlaskit/platform-feature-flags';
@@ -113,7 +114,31 @@ export var MediaNode = /*#__PURE__*/function (_Component) {
     }));
     _defineProperty(_this, "onError", function (reason) {
       var _this$props$api;
-      (_this$props$api = _this.props.api) === null || _this$props$api === void 0 || _this$props$api.media.actions.handleMediaNodeRenderError(_this.props.node, reason);
+      var nestedUnder = fg('platform_synced_block_patch_5') ? _this.getNestedUnder() : undefined;
+      (_this$props$api = _this.props.api) === null || _this$props$api === void 0 || _this$props$api.media.actions.handleMediaNodeRenderError(_this.props.node, reason, nestedUnder);
+    });
+    /**
+     * This function checks if the media node is nested under a certain nodes, and if so,
+     * returns the name of the parent node type. This is used for providing more context in media render errors.
+     * @returns
+     */
+    _defineProperty(_this, "getNestedUnder", function () {
+      var pos = _this.props.getPos();
+      if (typeof pos !== 'number') {
+        return undefined;
+      }
+      var _this$props$view$stat = _this.props.view.state,
+        doc = _this$props$view$stat.doc,
+        schema = _this$props$view$stat.schema;
+      var bodiedSyncBlock = schema.nodes.bodiedSyncBlock;
+      if (!bodiedSyncBlock) {
+        return undefined;
+      }
+      var resolvedPos = doc.resolve(pos);
+      var bodiedSyncBlockNode = findParentNodeClosestToPos(resolvedPos, function (currentNode) {
+        return currentNode.type === bodiedSyncBlock;
+      });
+      return bodiedSyncBlockNode === null || bodiedSyncBlockNode === void 0 ? void 0 : bodiedSyncBlockNode.node.type.name;
     });
     _defineProperty(_this, "onFullscreenChange", function (fullscreen) {
       var _this$mediaPluginStat;

package/dist/types/mediaPluginType.d.ts

@@ -50,7 +50,7 @@ export type MediaNextEditorPluginType = NextEditorPlugin<'media', {
         /**
          * Callback to be called when there is an error rendering a media node.
          */
-        handleMediaNodeRenderError: (node: PMNode, reason: string) => void;
+        handleMediaNodeRenderError: (node: PMNode, reason: string, nestedUnder?: string) => void;
         /**
          * @private
          * @deprecated Use the command `insertMediaSingle` instead which is decoupled from EditorView

package/dist/types/nodeviews/mediaNodeView/media.d.ts

@@ -49,6 +49,12 @@ export declare class MediaNode extends Component<MediaNodeProps, MediaNodeState>
     private selectMediaSingle;
     private getMediaSettings;
     private onError;
+    /**
+     * This function checks if the media node is nested under a certain nodes, and if so,
+     * returns the name of the parent node type. This is used for providing more context in media render errors.
+     * @returns
+     */
+    private getNestedUnder;
     render(): React.JSX.Element;
     private onFullscreenChange;
     private handleNewNode;

package/dist/types-ts4.5/mediaPluginType.d.ts

@@ -50,7 +50,7 @@ export type MediaNextEditorPluginType = NextEditorPlugin<'media', {
         /**
          * Callback to be called when there is an error rendering a media node.
          */
-        handleMediaNodeRenderError: (node: PMNode, reason: string) => void;
+        handleMediaNodeRenderError: (node: PMNode, reason: string, nestedUnder?: string) => void;
         /**
          * @private
          * @deprecated Use the command `insertMediaSingle` instead which is decoupled from EditorView

package/dist/types-ts4.5/nodeviews/mediaNodeView/media.d.ts

@@ -49,6 +49,12 @@ export declare class MediaNode extends Component<MediaNodeProps, MediaNodeState>
     private selectMediaSingle;
     private getMediaSettings;
     private onError;
+    /**
+     * This function checks if the media node is nested under a certain nodes, and if so,
+     * returns the name of the parent node type. This is used for providing more context in media render errors.
+     * @returns
+     */
+    private getNestedUnder;
     render(): React.JSX.Element;
     private onFullscreenChange;
     private handleNewNode;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-media",
-	"version": "9.6.4",
+	"version": "9.7.1",
 	"description": "Media plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -29,10 +29,10 @@
 	],
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-schema": "^52.0.0",
+		"@atlaskit/adf-schema": "^52.1.0",
 		"@atlaskit/analytics-namespaced-context": "^7.2.0",
 		"@atlaskit/analytics-next": "^11.1.0",
-		"@atlaskit/button": "^23.9.0",
+		"@atlaskit/button": "^23.10.0",
 		"@atlaskit/editor-palette": "^2.1.0",
 		"@atlaskit/editor-plugin-analytics": "^7.0.0",
 		"@atlaskit/editor-plugin-annotation": "^7.1.0",
@@ -65,8 +65,8 @@
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^18.0.0",
 		"@atlaskit/textfield": "^8.2.0",
-		"@atlaskit/theme": "^21.0.0",
-		"@atlaskit/tmp-editor-statsig": "^32.2.0",
+		"@atlaskit/theme": "^22.0.0",
+		"@atlaskit/tmp-editor-statsig": "^32.6.0",
 		"@atlaskit/tokens": "^11.0.0",
 		"@atlaskit/tooltip": "^20.14.0",
 		"@babel/runtime": "^7.0.0",
@@ -78,7 +78,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^111.20.0",
+		"@atlaskit/editor-common": "^111.23.0",
 		"@atlaskit/media-core": "^37.0.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
@@ -160,6 +160,9 @@
 		"platform_editor_media_insert_check": {
 			"type": "boolean"
 		},
+		"platform_synced_block_patch_5": {
+			"type": "boolean"
+		},
 		"confluence_fe_create_inline_comment_exp_coverage_2": {
 			"type": "boolean"
 		}