@atlaskit/editor-plugin-paste 1.0.16 → 1.0.17

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-plugin-paste
 
+## 1.0.17
+
+### Patch Changes
+
+- [#92373](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/92373) [`6a480276c9b0`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/6a480276c9b0) - [ux] [ED-23043] Plain text content leading and trailing whitespace is now preserved on paste behind FF (`platform.editor.preserve-whitespace-clipboard-text-serialization`)
+
 ## 1.0.16
 
 ### Patch Changes

package/dist/cjs/pm-plugins/clipboard-text-serializer.js

@@ -4,18 +4,53 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.clipboardTextSerializer = clipboardTextSerializer;
+exports.clipboardTextSerializerSimplified = clipboardTextSerializerSimplified;
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 /**
  * Returns a plain text serialization of a given slice. This is used for populating the plain text
  * section of the clipboard on copy.
  * The current implementation is bare bones - only inlineCards, blockCards and mentions are tested (they
  * previously were empty on plain text copy).
- * Unknown nodes are passed to node.textBetween().
  *
  * By default (without this function passed to the editor), the editor uses
  * `slice.content.textBetween(0, slice.content.size, "\n\n")`
  * (see https://prosemirror.net/docs/ref/#view.EditorProps.clipboardTextSerializer)
  */
 function clipboardTextSerializer(slice) {
+  if (
+  // Enables bugfix - https://product-fabric.atlassian.net/browse/ED-23043
+  (0, _platformFeatureFlags.getBooleanFF)('platform.editor.preserve-whitespace-clipboard-text-serialization')) {
+    return clipboardTextSerializerSimplified(slice);
+  } else {
+    return clipboardTextSerializerLegacy(slice);
+  }
+}
+function clipboardTextSerializerSimplified(slice) {
+  var blockSeparator = '\n\n';
+  return slice.content.textBetween(0, slice.content.size, blockSeparator, function (leafNode) {
+    var _leafNode$text;
+    switch (leafNode.type.name) {
+      case 'hardBreak':
+        return '\n';
+      case 'text':
+        return leafNode.text;
+      case 'inlineCard':
+        return leafNode.attrs.url;
+      case 'blockCard':
+        return leafNode.attrs.url;
+      // Note: Due to relying on an async fetch of the Mention name by the Node's React component,
+      // pasting a mention does not actually work for the in-product Mention implementation.
+      // However, this is also true of the previous implementation.
+      // Bug ticket: https://product-fabric.atlassian.net/browse/ED-23076
+      case 'mention':
+        return leafNode.attrs.text;
+      default:
+        // Unsupported node
+        return (_leafNode$text = leafNode.text) !== null && _leafNode$text !== void 0 ? _leafNode$text : '';
+    }
+  });
+}
+function clipboardTextSerializerLegacy(slice) {
   var text = '';
   var blockSeparater = '\n\n';
   slice.content.nodesBetween(0, slice.content.size, function (node) {

package/dist/es2019/pm-plugins/clipboard-text-serializer.js

@@ -1,15 +1,50 @@
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
+
 /**
  * Returns a plain text serialization of a given slice. This is used for populating the plain text
  * section of the clipboard on copy.
  * The current implementation is bare bones - only inlineCards, blockCards and mentions are tested (they
  * previously were empty on plain text copy).
- * Unknown nodes are passed to node.textBetween().
  *
  * By default (without this function passed to the editor), the editor uses
  * `slice.content.textBetween(0, slice.content.size, "\n\n")`
  * (see https://prosemirror.net/docs/ref/#view.EditorProps.clipboardTextSerializer)
  */
 export function clipboardTextSerializer(slice) {
+  if (
+  // Enables bugfix - https://product-fabric.atlassian.net/browse/ED-23043
+  getBooleanFF('platform.editor.preserve-whitespace-clipboard-text-serialization')) {
+    return clipboardTextSerializerSimplified(slice);
+  } else {
+    return clipboardTextSerializerLegacy(slice);
+  }
+}
+export function clipboardTextSerializerSimplified(slice) {
+  const blockSeparator = '\n\n';
+  return slice.content.textBetween(0, slice.content.size, blockSeparator, leafNode => {
+    var _leafNode$text;
+    switch (leafNode.type.name) {
+      case 'hardBreak':
+        return '\n';
+      case 'text':
+        return leafNode.text;
+      case 'inlineCard':
+        return leafNode.attrs.url;
+      case 'blockCard':
+        return leafNode.attrs.url;
+      // Note: Due to relying on an async fetch of the Mention name by the Node's React component,
+      // pasting a mention does not actually work for the in-product Mention implementation.
+      // However, this is also true of the previous implementation.
+      // Bug ticket: https://product-fabric.atlassian.net/browse/ED-23076
+      case 'mention':
+        return leafNode.attrs.text;
+      default:
+        // Unsupported node
+        return (_leafNode$text = leafNode.text) !== null && _leafNode$text !== void 0 ? _leafNode$text : '';
+    }
+  });
+}
+function clipboardTextSerializerLegacy(slice) {
   let text = '';
   const blockSeparater = '\n\n';
   slice.content.nodesBetween(0, slice.content.size, node => {

package/dist/esm/pm-plugins/clipboard-text-serializer.js

@@ -1,15 +1,50 @@
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
+
 /**
  * Returns a plain text serialization of a given slice. This is used for populating the plain text
  * section of the clipboard on copy.
  * The current implementation is bare bones - only inlineCards, blockCards and mentions are tested (they
  * previously were empty on plain text copy).
- * Unknown nodes are passed to node.textBetween().
  *
  * By default (without this function passed to the editor), the editor uses
  * `slice.content.textBetween(0, slice.content.size, "\n\n")`
  * (see https://prosemirror.net/docs/ref/#view.EditorProps.clipboardTextSerializer)
  */
 export function clipboardTextSerializer(slice) {
+  if (
+  // Enables bugfix - https://product-fabric.atlassian.net/browse/ED-23043
+  getBooleanFF('platform.editor.preserve-whitespace-clipboard-text-serialization')) {
+    return clipboardTextSerializerSimplified(slice);
+  } else {
+    return clipboardTextSerializerLegacy(slice);
+  }
+}
+export function clipboardTextSerializerSimplified(slice) {
+  var blockSeparator = '\n\n';
+  return slice.content.textBetween(0, slice.content.size, blockSeparator, function (leafNode) {
+    var _leafNode$text;
+    switch (leafNode.type.name) {
+      case 'hardBreak':
+        return '\n';
+      case 'text':
+        return leafNode.text;
+      case 'inlineCard':
+        return leafNode.attrs.url;
+      case 'blockCard':
+        return leafNode.attrs.url;
+      // Note: Due to relying on an async fetch of the Mention name by the Node's React component,
+      // pasting a mention does not actually work for the in-product Mention implementation.
+      // However, this is also true of the previous implementation.
+      // Bug ticket: https://product-fabric.atlassian.net/browse/ED-23076
+      case 'mention':
+        return leafNode.attrs.text;
+      default:
+        // Unsupported node
+        return (_leafNode$text = leafNode.text) !== null && _leafNode$text !== void 0 ? _leafNode$text : '';
+    }
+  });
+}
+function clipboardTextSerializerLegacy(slice) {
   var text = '';
   var blockSeparater = '\n\n';
   slice.content.nodesBetween(0, slice.content.size, function (node) {

package/dist/types/pm-plugins/clipboard-text-serializer.d.ts

@@ -4,10 +4,10 @@ import type { Slice } from '@atlaskit/editor-prosemirror/model';
  * section of the clipboard on copy.
  * The current implementation is bare bones - only inlineCards, blockCards and mentions are tested (they
  * previously were empty on plain text copy).
- * Unknown nodes are passed to node.textBetween().
  *
  * By default (without this function passed to the editor), the editor uses
  * `slice.content.textBetween(0, slice.content.size, "\n\n")`
  * (see https://prosemirror.net/docs/ref/#view.EditorProps.clipboardTextSerializer)
  */
 export declare function clipboardTextSerializer(slice: Slice): string;
+export declare function clipboardTextSerializerSimplified(slice: Slice): string;

package/dist/types-ts4.5/pm-plugins/clipboard-text-serializer.d.ts

@@ -4,10 +4,10 @@ import type { Slice } from '@atlaskit/editor-prosemirror/model';
  * section of the clipboard on copy.
  * The current implementation is bare bones - only inlineCards, blockCards and mentions are tested (they
  * previously were empty on plain text copy).
- * Unknown nodes are passed to node.textBetween().
  *
  * By default (without this function passed to the editor), the editor uses
  * `slice.content.textBetween(0, slice.content.size, "\n\n")`
  * (see https://prosemirror.net/docs/ref/#view.EditorProps.clipboardTextSerializer)
  */
 export declare function clipboardTextSerializer(slice: Slice): string;
+export declare function clipboardTextSerializerSimplified(slice: Slice): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-paste",
-  "version": "1.0.16",
+  "version": "1.0.17",
   "description": "Paste plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -33,7 +33,7 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^78.28.0",
+    "@atlaskit/editor-common": "^78.30.0",
     "@atlaskit/editor-markdown-transformer": "^5.4.0",
     "@atlaskit/editor-plugin-analytics": "^1.0.0",
     "@atlaskit/editor-plugin-annotation": "^1.5.0",
@@ -141,6 +141,9 @@
     },
     "platform.editor.extractlistfromparagraphv2": {
       "type": "boolean"
+    },
+    "platform.editor.preserve-whitespace-clipboard-text-serialization": {
+      "type": "boolean"
     }
   }
 }