@atlaskit/editor-plugin-clipboard 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/editor-plugin-clipboard
 
+## 1.1.0
+
+### Minor Changes
+
+- [#91934](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/91934) [`b76a78c6a199`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/b76a78c6a199) - bumped editor-prosemirror version to 4.0.0
+
+### Patch Changes
+
+- Updated dependencies
+
+## 1.0.3
+
+### Patch Changes
+
+- [#91894](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/91894) [`37320d5b95e8`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/37320d5b95e8) - [ED-22945] Don't copy paste comments on media nodes
+
 ## 1.0.2
 
 ### Patch Changes

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

@@ -4,14 +4,14 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createPlugin = exports.createClipboardSerializer = void 0;
+exports.createPlugin = exports.createClipboardSerializer = exports.ClipboardEventType = void 0;
 Object.defineProperty(exports, "getAnalyticsPayload", {
   enumerable: true,
   get: function get() {
     return _clipboard.getAnalyticsPayload;
   }
 });
-exports.sendClipboardAnalytics = void 0;
+exports.setLastEventType = exports.sendClipboardAnalytics = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _clipboard = require("@atlaskit/editor-common/clipboard");
@@ -21,6 +21,12 @@ var _utils = require("@atlaskit/editor-prosemirror/utils");
 var _pluginKey = require("../plugin-key");
 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 ClipboardEventType = exports.ClipboardEventType = /*#__PURE__*/function (ClipboardEventType) {
+  ClipboardEventType["CUT"] = "CUT";
+  ClipboardEventType["COPY"] = "COPY";
+  return ClipboardEventType;
+}({});
+var lastEventType = null;
 var createPlugin = exports.createPlugin = function createPlugin(_ref) {
   var dispatchAnalyticsEvent = _ref.dispatchAnalyticsEvent,
     schema = _ref.schema;
@@ -41,9 +47,11 @@ var createPlugin = exports.createPlugin = function createPlugin(_ref) {
     props: {
       handleDOMEvents: {
         cut: function cut(view) {
+          setLastEventType(ClipboardEventType.CUT);
           return sendClipboardAnalytics(view, dispatchAnalyticsEvent, _analytics.ACTION.CUT);
         },
         copy: function copy(view) {
+          setLastEventType(ClipboardEventType.COPY);
           return sendClipboardAnalytics(view, dispatchAnalyticsEvent, _analytics.ACTION.COPIED);
         }
       },
@@ -63,7 +71,7 @@ var createClipboardSerializer = exports.createClipboardSerializer = function cre
   var newSerializer = new _model.DOMSerializer(oldSerializer.nodes, oldSerializer.marks);
   var originalSerializeFragment = newSerializer.serializeFragment.bind(newSerializer);
   newSerializer.serializeFragment = function (content) {
-    var _content$firstChild;
+    var _content$firstChild, _content$firstChild2;
     var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
     var target = arguments.length > 2 ? arguments[2] : undefined;
     var editorView = getEditorView();
@@ -106,7 +114,20 @@ var createClipboardSerializer = exports.createClipboardSerializer = function cre
       return originalSerializeFragment(newContent, options, target);
     }
 
-    // If we're not copying any rows, just run default serializeFragment function.
+    // Remove annotations from media nodes when copying to clipboard, only do this for copy operations
+    if (lastEventType === ClipboardEventType.COPY && ((_content$firstChild2 = content.firstChild) === null || _content$firstChild2 === void 0 ? void 0 : _content$firstChild2.type.name) === 'media') {
+      var _mediaNode$marks;
+      var mediaNode = content.firstChild;
+      var strippedMediaNode = schema.nodes.media.createChecked(mediaNode.attrs, mediaNode.content, (_mediaNode$marks = mediaNode.marks) === null || _mediaNode$marks === void 0 ? void 0 : _mediaNode$marks.filter(function (mark) {
+        return mark.type.name !== 'annotation';
+      }));
+      var _newContent = _model.Fragment.from(strippedMediaNode);
+      // Currently incorrectly typed, see comment above
+      //@ts-ignore
+      return originalSerializeFragment(_newContent, options, target);
+    }
+
+    // If we're not copying any rows or media nodes, just run default serializeFragment function.
     // Currently incorrectly typed in @Types. See this GitHub thread: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/57668
     //@ts-ignore
     return originalSerializeFragment(content, options, target);
@@ -121,4 +142,7 @@ var sendClipboardAnalytics = exports.sendClipboardAnalytics = function sendClipb
   // return false so we don't block any other plugins' cut or copy handlers
   // from running just because we are sending an analytics event
   return false;
+};
+var setLastEventType = exports.setLastEventType = function setLastEventType(eventType) {
+  return lastEventType = eventType;
 };

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

@@ -4,6 +4,12 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { DOMSerializer, Fragment } from '@atlaskit/editor-prosemirror/model';
 import { findParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
 import { clipboardPluginKey } from '../plugin-key';
+export let ClipboardEventType = /*#__PURE__*/function (ClipboardEventType) {
+  ClipboardEventType["CUT"] = "CUT";
+  ClipboardEventType["COPY"] = "COPY";
+  return ClipboardEventType;
+}({});
+let lastEventType = null;
 export const createPlugin = ({
   dispatchAnalyticsEvent,
   schema
@@ -22,8 +28,14 @@ export const createPlugin = ({
     },
     props: {
       handleDOMEvents: {
-        cut: view => sendClipboardAnalytics(view, dispatchAnalyticsEvent, ACTION.CUT),
-        copy: view => sendClipboardAnalytics(view, dispatchAnalyticsEvent, ACTION.COPIED)
+        cut: view => {
+          setLastEventType(ClipboardEventType.CUT);
+          return sendClipboardAnalytics(view, dispatchAnalyticsEvent, ACTION.CUT);
+        },
+        copy: view => {
+          setLastEventType(ClipboardEventType.COPY);
+          return sendClipboardAnalytics(view, dispatchAnalyticsEvent, ACTION.COPIED);
+        }
       },
       clipboardSerializer: createClipboardSerializer(schema, getEditorView)
     }
@@ -41,7 +53,7 @@ export const createClipboardSerializer = (schema, getEditorView) => {
   const newSerializer = new DOMSerializer(oldSerializer.nodes, oldSerializer.marks);
   const originalSerializeFragment = newSerializer.serializeFragment.bind(newSerializer);
   newSerializer.serializeFragment = (content, options = {}, target) => {
-    var _content$firstChild;
+    var _content$firstChild, _content$firstChild2;
     const editorView = getEditorView();
     const selection = editorView.state.selection;
 
@@ -83,7 +95,18 @@ export const createClipboardSerializer = (schema, getEditorView) => {
       return originalSerializeFragment(newContent, options, target);
     }
 
-    // If we're not copying any rows, just run default serializeFragment function.
+    // Remove annotations from media nodes when copying to clipboard, only do this for copy operations
+    if (lastEventType === ClipboardEventType.COPY && ((_content$firstChild2 = content.firstChild) === null || _content$firstChild2 === void 0 ? void 0 : _content$firstChild2.type.name) === 'media') {
+      var _mediaNode$marks;
+      const mediaNode = content.firstChild;
+      const strippedMediaNode = schema.nodes.media.createChecked(mediaNode.attrs, mediaNode.content, (_mediaNode$marks = mediaNode.marks) === null || _mediaNode$marks === void 0 ? void 0 : _mediaNode$marks.filter(mark => mark.type.name !== 'annotation'));
+      const newContent = Fragment.from(strippedMediaNode);
+      // Currently incorrectly typed, see comment above
+      //@ts-ignore
+      return originalSerializeFragment(newContent, options, target);
+    }
+
+    // If we're not copying any rows or media nodes, just run default serializeFragment function.
     // Currently incorrectly typed in @Types. See this GitHub thread: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/57668
     //@ts-ignore
     return originalSerializeFragment(content, options, target);
@@ -99,4 +122,5 @@ export const sendClipboardAnalytics = (view, dispatchAnalyticsEvent, action) =>
   // from running just because we are sending an analytics event
   return false;
 };
+export const setLastEventType = eventType => lastEventType = eventType;
 export { getAnalyticsPayload };

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

@@ -7,6 +7,12 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { DOMSerializer, Fragment } from '@atlaskit/editor-prosemirror/model';
 import { findParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
 import { clipboardPluginKey } from '../plugin-key';
+export var ClipboardEventType = /*#__PURE__*/function (ClipboardEventType) {
+  ClipboardEventType["CUT"] = "CUT";
+  ClipboardEventType["COPY"] = "COPY";
+  return ClipboardEventType;
+}({});
+var lastEventType = null;
 export var createPlugin = function createPlugin(_ref) {
   var dispatchAnalyticsEvent = _ref.dispatchAnalyticsEvent,
     schema = _ref.schema;
@@ -27,9 +33,11 @@ export var createPlugin = function createPlugin(_ref) {
     props: {
       handleDOMEvents: {
         cut: function cut(view) {
+          setLastEventType(ClipboardEventType.CUT);
           return sendClipboardAnalytics(view, dispatchAnalyticsEvent, ACTION.CUT);
         },
         copy: function copy(view) {
+          setLastEventType(ClipboardEventType.COPY);
           return sendClipboardAnalytics(view, dispatchAnalyticsEvent, ACTION.COPIED);
         }
       },
@@ -49,7 +57,7 @@ export var createClipboardSerializer = function createClipboardSerializer(schema
   var newSerializer = new DOMSerializer(oldSerializer.nodes, oldSerializer.marks);
   var originalSerializeFragment = newSerializer.serializeFragment.bind(newSerializer);
   newSerializer.serializeFragment = function (content) {
-    var _content$firstChild;
+    var _content$firstChild, _content$firstChild2;
     var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
     var target = arguments.length > 2 ? arguments[2] : undefined;
     var editorView = getEditorView();
@@ -92,7 +100,20 @@ export var createClipboardSerializer = function createClipboardSerializer(schema
       return originalSerializeFragment(newContent, options, target);
     }
 
-    // If we're not copying any rows, just run default serializeFragment function.
+    // Remove annotations from media nodes when copying to clipboard, only do this for copy operations
+    if (lastEventType === ClipboardEventType.COPY && ((_content$firstChild2 = content.firstChild) === null || _content$firstChild2 === void 0 ? void 0 : _content$firstChild2.type.name) === 'media') {
+      var _mediaNode$marks;
+      var mediaNode = content.firstChild;
+      var strippedMediaNode = schema.nodes.media.createChecked(mediaNode.attrs, mediaNode.content, (_mediaNode$marks = mediaNode.marks) === null || _mediaNode$marks === void 0 ? void 0 : _mediaNode$marks.filter(function (mark) {
+        return mark.type.name !== 'annotation';
+      }));
+      var _newContent = Fragment.from(strippedMediaNode);
+      // Currently incorrectly typed, see comment above
+      //@ts-ignore
+      return originalSerializeFragment(_newContent, options, target);
+    }
+
+    // If we're not copying any rows or media nodes, just run default serializeFragment function.
     // Currently incorrectly typed in @Types. See this GitHub thread: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/57668
     //@ts-ignore
     return originalSerializeFragment(content, options, target);
@@ -108,4 +129,7 @@ export var sendClipboardAnalytics = function sendClipboardAnalytics(view, dispat
   // from running just because we are sending an analytics event
   return false;
 };
+export var setLastEventType = function setLastEventType(eventType) {
+  return lastEventType = eventType;
+};
 export { getAnalyticsPayload };

package/dist/types/pm-plugins/main.d.ts

@@ -6,6 +6,10 @@ import type { PMPluginFactoryParams } from '@atlaskit/editor-common/types';
 import { DOMSerializer } from '@atlaskit/editor-prosemirror/model';
 import type { Schema } from '@atlaskit/editor-prosemirror/model';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+export declare enum ClipboardEventType {
+    CUT = "CUT",
+    COPY = "COPY"
+}
 export declare const createPlugin: ({ dispatchAnalyticsEvent, schema, }: PMPluginFactoryParams) => SafePlugin<any>;
 /**
  * Overrides Prosemirror's default clipboardSerializer, in order to fix table row copy/paste bug raised in ED-13003.
@@ -15,4 +19,5 @@ export declare const createPlugin: ({ dispatchAnalyticsEvent, schema, }: PMPlugi
  */
 export declare const createClipboardSerializer: (schema: Schema, getEditorView: () => EditorView) => DOMSerializer;
 export declare const sendClipboardAnalytics: (view: EditorView, dispatchAnalyticsEvent: DispatchAnalyticsEvent, action: ACTION.CUT | ACTION.COPIED) => boolean;
+export declare const setLastEventType: (eventType: ClipboardEventType) => ClipboardEventType;
 export { getAnalyticsPayload };

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -6,6 +6,10 @@ import type { PMPluginFactoryParams } from '@atlaskit/editor-common/types';
 import { DOMSerializer } from '@atlaskit/editor-prosemirror/model';
 import type { Schema } from '@atlaskit/editor-prosemirror/model';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+export declare enum ClipboardEventType {
+    CUT = "CUT",
+    COPY = "COPY"
+}
 export declare const createPlugin: ({ dispatchAnalyticsEvent, schema, }: PMPluginFactoryParams) => SafePlugin<any>;
 /**
  * Overrides Prosemirror's default clipboardSerializer, in order to fix table row copy/paste bug raised in ED-13003.
@@ -15,4 +19,5 @@ export declare const createPlugin: ({ dispatchAnalyticsEvent, schema, }: PMPlugi
  */
 export declare const createClipboardSerializer: (schema: Schema, getEditorView: () => EditorView) => DOMSerializer;
 export declare const sendClipboardAnalytics: (view: EditorView, dispatchAnalyticsEvent: DispatchAnalyticsEvent, action: ACTION.CUT | ACTION.COPIED) => boolean;
+export declare const setLastEventType: (eventType: ClipboardEventType) => ClipboardEventType;
 export { getAnalyticsPayload };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-clipboard",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Clipboard plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -32,8 +32,8 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^78.17.0",
-    "@atlaskit/editor-prosemirror": "3.0.0",
+    "@atlaskit/editor-common": "^78.31.0",
+    "@atlaskit/editor-prosemirror": "4.0.0",
     "@babel/runtime": "^7.0.0"
   },
   "peerDependencies": {