@atlaskit/editor-plugin-tasks-and-decisions 6.2.0 → 6.2.2

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/editor-plugin-tasks-and-decisions
 
+## 6.2.2
+
+### Patch Changes
+
+- [#200845](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/200845)
+  [`4e3985a5a347d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4e3985a5a347d) -
+  EDITOR-1320 Ensure localID creation for blockTaskItem
+
+## 6.2.1
+
+### Patch Changes
+
+- [#200663](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/200663)
+  [`0899e8f2578b2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0899e8f2578b2) -
+  [ux] EDITOR-1271 Modifies paste behaviour of editor-plugin-tasks-and-decisions to prevent
+  blockTaskItems being created when pasting block content into taskItems
+- Updated dependencies
+
 ## 6.2.0
 
 ### Minor Changes

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

@@ -22,6 +22,7 @@ var _helpers = require("./helpers");
 var _pluginKey = require("./plugin-key");
 var _taskItemOnChange = require("./taskItemOnChange");
 var _types = require("./types");
+var _paste = require("./utils/paste");
 var _excluded = ["localId"];
 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; }
@@ -176,6 +177,12 @@ function createPlugin(portalProviderAPI, eventDispatcher, dispatch, api, getIntl
             return false;
           }
         }
+      },
+      transformPasted: function transformPasted(slice, view) {
+        if ((0, _expValEquals.expValEquals)('platform_editor_blocktaskitem_node', 'isEnabled', true)) {
+          slice = (0, _paste.tempTransformSliceToRemoveBlockTaskItem)(slice, view);
+        }
+        return slice;
       }
     },
     state: {
@@ -254,7 +261,7 @@ function createPlugin(portalProviderAPI, eventDispatcher, dispatch, api, getIntl
     /*
      * After each transaction, we search through the document for any decisionList/Item & taskList/Item nodes
      * that do not have the localId attribute set and generate a random UUID to use. This is to replace a previous
-     * Prosemirror capabibility where node attributes could be generated dynamically.
+     * Prosemirror capability where node attributes could be generated dynamically.
      * See https://discuss.prosemirror.net/t/release-0-23-0-possibly-to-be-1-0-0/959/17 for a discussion of this approach.
      *
      * Note: we currently do not handle the edge case where two nodes may have the same localId
@@ -273,8 +280,9 @@ function createPlugin(portalProviderAPI, eventDispatcher, dispatch, api, getIntl
             decisionList = _newState$schema$node.decisionList,
             decisionItem = _newState$schema$node.decisionItem,
             taskList = _newState$schema$node.taskList,
-            taskItem = _newState$schema$node.taskItem;
-          if (!!node.type && (node.type === decisionList || node.type === decisionItem || node.type === taskList || node.type === taskItem)) {
+            taskItem = _newState$schema$node.taskItem,
+            blockTaskItem = _newState$schema$node.blockTaskItem;
+          if (!!node.type && (node.type === decisionList || node.type === decisionItem || node.type === taskList || node.type === taskItem || blockTaskItem && node.type === blockTaskItem)) {
             var _node$attrs = node.attrs,
               localId = _node$attrs.localId,
               rest = (0, _objectWithoutProperties2.default)(_node$attrs, _excluded);

package/dist/cjs/pm-plugins/utils/paste.js

@@ -0,0 +1,78 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.tempTransformSliceToRemoveBlockTaskItem = void 0;
+var _adfSchema = require("@atlaskit/adf-schema");
+var _model = require("@atlaskit/editor-prosemirror/model");
+/**
+ * Transforms a paste slice to handle blockTaskItem nodes when pasting into task items.
+ *
+ * Initially we do not support user creation of blockTaskItem - it is intended primarily
+ * for TinyMCE migration purposes however that may change in the future.
+ * This function handles the behavior to work around Prosemirror behaviour which decides
+ * that blockTaskItem is the appropriate node to use here.
+ *
+ * @param slice - The slice being pasted
+ * @param view - The editor view where the paste is occurring
+ * @returns The transformed slice with blockTaskItems converted to taskItems when appropriate
+ *
+ * @example
+ * ```typescript
+ * const transformedSlice = tempTransformSliceToRemoveBlockTaskItem(pasteSlice, editorView);
+ * ```
+ *
+ * @see {@link https://hello.atlassian.net/wiki/spaces/EDITOR/pages/5626622054/Block+elements+in+task+-+Decision+log#Can-users-create-block-task-items%3F} for reasoning
+ */
+var tempTransformSliceToRemoveBlockTaskItem = exports.tempTransformSliceToRemoveBlockTaskItem = function tempTransformSliceToRemoveBlockTaskItem(slice, view) {
+  var schema = view.state.schema;
+  var _schema$nodes = schema.nodes,
+    taskItem = _schema$nodes.taskItem,
+    blockTaskItem = _schema$nodes.blockTaskItem,
+    paragraph = _schema$nodes.paragraph;
+
+  // Check if we're pasting into a taskItem
+  var $from = view.state.selection.$from;
+  var isInTaskItem = $from.node().type === taskItem;
+  if (isInTaskItem && blockTaskItem) {
+    // Transform the slice to replace blockTaskItems with taskItems
+    var transformedContent = [];
+    slice.content.forEach(function (node) {
+      if (node.type === blockTaskItem) {
+        // Check if blockTaskItem only contains paragraphs
+        var allChildrenAreParagraphs = true;
+        node.content.forEach(function (child) {
+          if (child.type !== paragraph) {
+            allChildrenAreParagraphs = false;
+          }
+        });
+        if (allChildrenAreParagraphs && node.childCount > 0) {
+          // Convert each paragraph to a taskItem
+          node.content.forEach(function (paragraphNode) {
+            var newTaskItem = taskItem.create({
+              localId: _adfSchema.uuid.generate(),
+              state: node.attrs.state || 'TODO'
+            }, paragraphNode.content);
+            transformedContent.push(newTaskItem);
+          });
+        } else {
+          // Keep the blockTaskItem as is if it doesn't only contain paragraphs
+          transformedContent.push(node);
+        }
+      } else {
+        // Keep other nodes as is
+        transformedContent.push(node);
+      }
+    });
+
+    // Create new slice with transformed content
+    if (transformedContent.length !== slice.content.childCount || transformedContent.some(function (node, idx) {
+      return node !== slice.content.child(idx);
+    })) {
+      var newFragment = _model.Fragment.from(transformedContent);
+      return new _model.Slice(newFragment, slice.openStart, slice.openEnd);
+    }
+  }
+  return slice;
+};

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

@@ -13,6 +13,7 @@ import { focusCheckbox, focusCheckboxAndUpdateSelection, getTaskItemDataAtPos, g
 import { stateKey } from './plugin-key';
 import { taskItemOnChange } from './taskItemOnChange';
 import { ACTIONS } from './types';
+import { tempTransformSliceToRemoveBlockTaskItem } from './utils/paste';
 function nodesBetweenChanged(tr, f, startPos) {
   const stepRange = getStepRange(tr);
   if (!stepRange) {
@@ -168,6 +169,12 @@ export function createPlugin(portalProviderAPI, eventDispatcher, dispatch, api,
             return false;
           }
         }
+      },
+      transformPasted: (slice, view) => {
+        if (expValEquals('platform_editor_blocktaskitem_node', 'isEnabled', true)) {
+          slice = tempTransformSliceToRemoveBlockTaskItem(slice, view);
+        }
+        return slice;
       }
     },
     state: {
@@ -250,7 +257,7 @@ export function createPlugin(portalProviderAPI, eventDispatcher, dispatch, api,
     /*
      * After each transaction, we search through the document for any decisionList/Item & taskList/Item nodes
      * that do not have the localId attribute set and generate a random UUID to use. This is to replace a previous
-     * Prosemirror capabibility where node attributes could be generated dynamically.
+     * Prosemirror capability where node attributes could be generated dynamically.
      * See https://discuss.prosemirror.net/t/release-0-23-0-possibly-to-be-1-0-0/959/17 for a discussion of this approach.
      *
      * Note: we currently do not handle the edge case where two nodes may have the same localId
@@ -269,9 +276,10 @@ export function createPlugin(portalProviderAPI, eventDispatcher, dispatch, api,
             decisionList,
             decisionItem,
             taskList,
-            taskItem
+            taskItem,
+            blockTaskItem
           } = newState.schema.nodes;
-          if (!!node.type && (node.type === decisionList || node.type === decisionItem || node.type === taskList || node.type === taskItem)) {
+          if (!!node.type && (node.type === decisionList || node.type === decisionItem || node.type === taskList || node.type === taskItem || blockTaskItem && node.type === blockTaskItem)) {
             const {
               localId,
               ...rest

package/dist/es2019/pm-plugins/utils/paste.js

@@ -0,0 +1,75 @@
+import { uuid } from '@atlaskit/adf-schema';
+import { Slice, Fragment } from '@atlaskit/editor-prosemirror/model';
+/**
+ * Transforms a paste slice to handle blockTaskItem nodes when pasting into task items.
+ *
+ * Initially we do not support user creation of blockTaskItem - it is intended primarily
+ * for TinyMCE migration purposes however that may change in the future.
+ * This function handles the behavior to work around Prosemirror behaviour which decides
+ * that blockTaskItem is the appropriate node to use here.
+ *
+ * @param slice - The slice being pasted
+ * @param view - The editor view where the paste is occurring
+ * @returns The transformed slice with blockTaskItems converted to taskItems when appropriate
+ *
+ * @example
+ * ```typescript
+ * const transformedSlice = tempTransformSliceToRemoveBlockTaskItem(pasteSlice, editorView);
+ * ```
+ *
+ * @see {@link https://hello.atlassian.net/wiki/spaces/EDITOR/pages/5626622054/Block+elements+in+task+-+Decision+log#Can-users-create-block-task-items%3F} for reasoning
+ */
+export const tempTransformSliceToRemoveBlockTaskItem = (slice, view) => {
+  const {
+    schema
+  } = view.state;
+  const {
+    taskItem,
+    blockTaskItem,
+    paragraph
+  } = schema.nodes;
+
+  // Check if we're pasting into a taskItem
+  const {
+    $from
+  } = view.state.selection;
+  const isInTaskItem = $from.node().type === taskItem;
+  if (isInTaskItem && blockTaskItem) {
+    // Transform the slice to replace blockTaskItems with taskItems
+    const transformedContent = [];
+    slice.content.forEach(node => {
+      if (node.type === blockTaskItem) {
+        // Check if blockTaskItem only contains paragraphs
+        let allChildrenAreParagraphs = true;
+        node.content.forEach(child => {
+          if (child.type !== paragraph) {
+            allChildrenAreParagraphs = false;
+          }
+        });
+        if (allChildrenAreParagraphs && node.childCount > 0) {
+          // Convert each paragraph to a taskItem
+          node.content.forEach(paragraphNode => {
+            const newTaskItem = taskItem.create({
+              localId: uuid.generate(),
+              state: node.attrs.state || 'TODO'
+            }, paragraphNode.content);
+            transformedContent.push(newTaskItem);
+          });
+        } else {
+          // Keep the blockTaskItem as is if it doesn't only contain paragraphs
+          transformedContent.push(node);
+        }
+      } else {
+        // Keep other nodes as is
+        transformedContent.push(node);
+      }
+    });
+
+    // Create new slice with transformed content
+    if (transformedContent.length !== slice.content.childCount || transformedContent.some((node, idx) => node !== slice.content.child(idx))) {
+      const newFragment = Fragment.from(transformedContent);
+      return new Slice(newFragment, slice.openStart, slice.openEnd);
+    }
+  }
+  return slice;
+};

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

@@ -18,6 +18,7 @@ import { focusCheckbox, focusCheckboxAndUpdateSelection, getTaskItemDataAtPos, g
 import { stateKey } from './plugin-key';
 import { taskItemOnChange } from './taskItemOnChange';
 import { ACTIONS } from './types';
+import { tempTransformSliceToRemoveBlockTaskItem } from './utils/paste';
 function nodesBetweenChanged(tr, f, startPos) {
   var stepRange = getStepRange(tr);
   if (!stepRange) {
@@ -169,6 +170,12 @@ export function createPlugin(portalProviderAPI, eventDispatcher, dispatch, api,
             return false;
           }
         }
+      },
+      transformPasted: function transformPasted(slice, view) {
+        if (expValEquals('platform_editor_blocktaskitem_node', 'isEnabled', true)) {
+          slice = tempTransformSliceToRemoveBlockTaskItem(slice, view);
+        }
+        return slice;
       }
     },
     state: {
@@ -247,7 +254,7 @@ export function createPlugin(portalProviderAPI, eventDispatcher, dispatch, api,
     /*
      * After each transaction, we search through the document for any decisionList/Item & taskList/Item nodes
      * that do not have the localId attribute set and generate a random UUID to use. This is to replace a previous
-     * Prosemirror capabibility where node attributes could be generated dynamically.
+     * Prosemirror capability where node attributes could be generated dynamically.
      * See https://discuss.prosemirror.net/t/release-0-23-0-possibly-to-be-1-0-0/959/17 for a discussion of this approach.
      *
      * Note: we currently do not handle the edge case where two nodes may have the same localId
@@ -266,8 +273,9 @@ export function createPlugin(portalProviderAPI, eventDispatcher, dispatch, api,
             decisionList = _newState$schema$node.decisionList,
             decisionItem = _newState$schema$node.decisionItem,
             taskList = _newState$schema$node.taskList,
-            taskItem = _newState$schema$node.taskItem;
-          if (!!node.type && (node.type === decisionList || node.type === decisionItem || node.type === taskList || node.type === taskItem)) {
+            taskItem = _newState$schema$node.taskItem,
+            blockTaskItem = _newState$schema$node.blockTaskItem;
+          if (!!node.type && (node.type === decisionList || node.type === decisionItem || node.type === taskList || node.type === taskItem || blockTaskItem && node.type === blockTaskItem)) {
             var _node$attrs = node.attrs,
               localId = _node$attrs.localId,
               rest = _objectWithoutProperties(_node$attrs, _excluded);

package/dist/esm/pm-plugins/utils/paste.js

@@ -0,0 +1,72 @@
+import { uuid } from '@atlaskit/adf-schema';
+import { Slice, Fragment } from '@atlaskit/editor-prosemirror/model';
+/**
+ * Transforms a paste slice to handle blockTaskItem nodes when pasting into task items.
+ *
+ * Initially we do not support user creation of blockTaskItem - it is intended primarily
+ * for TinyMCE migration purposes however that may change in the future.
+ * This function handles the behavior to work around Prosemirror behaviour which decides
+ * that blockTaskItem is the appropriate node to use here.
+ *
+ * @param slice - The slice being pasted
+ * @param view - The editor view where the paste is occurring
+ * @returns The transformed slice with blockTaskItems converted to taskItems when appropriate
+ *
+ * @example
+ * ```typescript
+ * const transformedSlice = tempTransformSliceToRemoveBlockTaskItem(pasteSlice, editorView);
+ * ```
+ *
+ * @see {@link https://hello.atlassian.net/wiki/spaces/EDITOR/pages/5626622054/Block+elements+in+task+-+Decision+log#Can-users-create-block-task-items%3F} for reasoning
+ */
+export var tempTransformSliceToRemoveBlockTaskItem = function tempTransformSliceToRemoveBlockTaskItem(slice, view) {
+  var schema = view.state.schema;
+  var _schema$nodes = schema.nodes,
+    taskItem = _schema$nodes.taskItem,
+    blockTaskItem = _schema$nodes.blockTaskItem,
+    paragraph = _schema$nodes.paragraph;
+
+  // Check if we're pasting into a taskItem
+  var $from = view.state.selection.$from;
+  var isInTaskItem = $from.node().type === taskItem;
+  if (isInTaskItem && blockTaskItem) {
+    // Transform the slice to replace blockTaskItems with taskItems
+    var transformedContent = [];
+    slice.content.forEach(function (node) {
+      if (node.type === blockTaskItem) {
+        // Check if blockTaskItem only contains paragraphs
+        var allChildrenAreParagraphs = true;
+        node.content.forEach(function (child) {
+          if (child.type !== paragraph) {
+            allChildrenAreParagraphs = false;
+          }
+        });
+        if (allChildrenAreParagraphs && node.childCount > 0) {
+          // Convert each paragraph to a taskItem
+          node.content.forEach(function (paragraphNode) {
+            var newTaskItem = taskItem.create({
+              localId: uuid.generate(),
+              state: node.attrs.state || 'TODO'
+            }, paragraphNode.content);
+            transformedContent.push(newTaskItem);
+          });
+        } else {
+          // Keep the blockTaskItem as is if it doesn't only contain paragraphs
+          transformedContent.push(node);
+        }
+      } else {
+        // Keep other nodes as is
+        transformedContent.push(node);
+      }
+    });
+
+    // Create new slice with transformed content
+    if (transformedContent.length !== slice.content.childCount || transformedContent.some(function (node, idx) {
+      return node !== slice.content.child(idx);
+    })) {
+      var newFragment = Fragment.from(transformedContent);
+      return new Slice(newFragment, slice.openStart, slice.openEnd);
+    }
+  }
+  return slice;
+};

package/dist/types/pm-plugins/utils/paste.d.ts

@@ -0,0 +1,22 @@
+import { Slice } from '@atlaskit/editor-prosemirror/model';
+import { type EditorView } from '@atlaskit/editor-prosemirror/view';
+/**
+ * Transforms a paste slice to handle blockTaskItem nodes when pasting into task items.
+ *
+ * Initially we do not support user creation of blockTaskItem - it is intended primarily
+ * for TinyMCE migration purposes however that may change in the future.
+ * This function handles the behavior to work around Prosemirror behaviour which decides
+ * that blockTaskItem is the appropriate node to use here.
+ *
+ * @param slice - The slice being pasted
+ * @param view - The editor view where the paste is occurring
+ * @returns The transformed slice with blockTaskItems converted to taskItems when appropriate
+ *
+ * @example
+ * ```typescript
+ * const transformedSlice = tempTransformSliceToRemoveBlockTaskItem(pasteSlice, editorView);
+ * ```
+ *
+ * @see {@link https://hello.atlassian.net/wiki/spaces/EDITOR/pages/5626622054/Block+elements+in+task+-+Decision+log#Can-users-create-block-task-items%3F} for reasoning
+ */
+export declare const tempTransformSliceToRemoveBlockTaskItem: (slice: Slice, view: EditorView) => Slice;

package/dist/types/ui/Task/RequestToEditPopup.d.ts

@@ -3,7 +3,6 @@
  * @jsxFrag jsx
  * @jsx jsx
  */
-/// <reference types="react" />
 import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';

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

@@ -0,0 +1,22 @@
+import { Slice } from '@atlaskit/editor-prosemirror/model';
+import { type EditorView } from '@atlaskit/editor-prosemirror/view';
+/**
+ * Transforms a paste slice to handle blockTaskItem nodes when pasting into task items.
+ *
+ * Initially we do not support user creation of blockTaskItem - it is intended primarily
+ * for TinyMCE migration purposes however that may change in the future.
+ * This function handles the behavior to work around Prosemirror behaviour which decides
+ * that blockTaskItem is the appropriate node to use here.
+ *
+ * @param slice - The slice being pasted
+ * @param view - The editor view where the paste is occurring
+ * @returns The transformed slice with blockTaskItems converted to taskItems when appropriate
+ *
+ * @example
+ * ```typescript
+ * const transformedSlice = tempTransformSliceToRemoveBlockTaskItem(pasteSlice, editorView);
+ * ```
+ *
+ * @see {@link https://hello.atlassian.net/wiki/spaces/EDITOR/pages/5626622054/Block+elements+in+task+-+Decision+log#Can-users-create-block-task-items%3F} for reasoning
+ */
+export declare const tempTransformSliceToRemoveBlockTaskItem: (slice: Slice, view: EditorView) => Slice;

package/dist/types-ts4.5/ui/Task/RequestToEditPopup.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 /**
  * @jsxRuntime classic
  * @jsxFrag jsx

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-tasks-and-decisions",
-	"version": "6.2.0",
+	"version": "6.2.2",
 	"description": "Tasks and decisions plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -43,20 +43,20 @@
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.6.0",
 		"@atlaskit/heading": "^5.2.0",
-		"@atlaskit/icon": "^27.10.0",
+		"@atlaskit/icon": "^27.12.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/popup": "^4.3.0",
 		"@atlaskit/primitives": "^14.11.0",
 		"@atlaskit/prosemirror-input-rules": "^3.4.0",
 		"@atlaskit/task-decision": "^19.2.0",
-		"@atlaskit/tmp-editor-statsig": "^9.26.0",
+		"@atlaskit/tmp-editor-statsig": "^9.27.0",
 		"@atlaskit/tokens": "^6.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.18.3",
 		"bind-event-listener": "^3.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.20.0",
+		"@atlaskit/editor-common": "^107.23.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
@@ -65,7 +65,7 @@
 		"@af/integration-testing": "workspace:^",
 		"@af/visual-regression": "workspace:^",
 		"@atlaskit/ssr": "workspace:^",
-		"@atlaskit/util-data-test": "^18.0.0",
+		"@atlaskit/util-data-test": "^18.1.0",
 		"@atlaskit/visual-regression": "workspace:^",
 		"@testing-library/react": "^13.4.0",
 		"wait-for-expect": "^1.2.0"