@atlaskit/editor-plugin-list 1.3.7 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @atlaskit/editor-plugin-list
 
+## 1.4.0
+
+### Minor Changes
+
+- [#56675](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/56675) [`772ad8f687be`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/772ad8f687be) - [ux] [ED-20249] If `platform.editor.ordered-list-auto-join-improvements_mrlv5`` is enabled only auto-join lists together if the order numbers match up.
+
+  Eg.
+
+  1. A list item
+
+  -
+
+  50. Another list item
+
+  Should NOT auto join to be 1 & 2 in a single list however...
+
+  49. A list item
+
+  -
+
+  50. Another list item
+
+  Should join to be 49 & 50 in a single list.
+
+  This also only applies when the `restartNumberedLists` feature flag is enabled.
+
 ## 1.3.7
 
 ### Patch Changes

package/dist/cjs/pm-plugins/input-rules/wrapping-join-rule.js

@@ -7,6 +7,7 @@ exports.createWrappingJoinRule = void 0;
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _transform = require("@atlaskit/editor-prosemirror/transform");
 var _utils = require("@atlaskit/editor-prosemirror/utils");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _prosemirrorInputRules = require("@atlaskit/prosemirror-input-rules");
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 
@@ -35,12 +36,24 @@ var createWrappingJoinRule = exports.createWrappingJoinRule = function createWra
       tr.setNodeMarkup(parentNodePosMapped, parentNode.type, parentNode.attrs, allowedMarks);
     }
     tr.wrap(range, wrapping);
+
+    // if an orderedList node would be inserted by the input rule match, and
+    // that orderedList node is being added directly after another orderedList
     if (featureFlags !== null && featureFlags !== void 0 && featureFlags.restartNumberedLists && nodeType === state.schema.nodes.orderedList) {
-      // if an orderedList node would be inserted by the input rule match, and
-      // that orderedList node is being added directly before another orderedList
-      // node, then join those nodes
       var $end = tr.doc.resolve(tr.mapping.map(end));
       var _node = (0, _utils.findParentNodeOfTypeClosestToPos)($end, nodeType);
+      if ((0, _platformFeatureFlags.getBooleanFF)('platform.editor.ordered-list-auto-join-improvements_mrlv5')) {
+        // if there's a list before & the new list has an order property that does
+        // not match to follow the last number on the first list then do NOT merge the lists
+        var nodeBeforeSelection = tr.doc.resolve(parentNodePosMapped).nodeBefore;
+        var nextExpectedNumberAfterListBefore = (nodeBeforeSelection === null || nodeBeforeSelection === void 0 ? void 0 : nodeBeforeSelection.type.name) === 'orderedList' ? (nodeBeforeSelection === null || nodeBeforeSelection === void 0 ? void 0 : nodeBeforeSelection.attrs.order) + (nodeBeforeSelection === null || nodeBeforeSelection === void 0 ? void 0 : nodeBeforeSelection.childCount) : undefined;
+        var listBeforeDoesNotMatchWithNewList = nodeBeforeSelection && typeof attrs.order === 'number' && nextExpectedNumberAfterListBefore && attrs.order !== nextExpectedNumberAfterListBefore;
+        if (nodeBeforeSelection && listBeforeDoesNotMatchWithNewList) {
+          return tr;
+        }
+      }
+
+      // otherwise join the lists
       if (_node) {
         var nodeEnd = _node.pos + _node.node.nodeSize;
         var after = tr.doc.resolve(nodeEnd).nodeAfter;

package/dist/es2019/pm-plugins/input-rules/wrapping-join-rule.js

@@ -1,6 +1,7 @@
 import { JOIN_SCENARIOS_WHEN_TYPING_TO_INSERT_LIST } from '@atlaskit/editor-common/analytics';
 import { canJoin, findWrapping } from '@atlaskit/editor-prosemirror/transform';
 import { findParentNodeOfTypeClosestToPos } from '@atlaskit/editor-prosemirror/utils';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import { createRule } from '@atlaskit/prosemirror-input-rules';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -31,12 +32,24 @@ export const createWrappingJoinRule = ({
       tr.setNodeMarkup(parentNodePosMapped, parentNode.type, parentNode.attrs, allowedMarks);
     }
     tr.wrap(range, wrapping);
+
+    // if an orderedList node would be inserted by the input rule match, and
+    // that orderedList node is being added directly after another orderedList
     if (featureFlags !== null && featureFlags !== void 0 && featureFlags.restartNumberedLists && nodeType === state.schema.nodes.orderedList) {
-      // if an orderedList node would be inserted by the input rule match, and
-      // that orderedList node is being added directly before another orderedList
-      // node, then join those nodes
       const $end = tr.doc.resolve(tr.mapping.map(end));
       const node = findParentNodeOfTypeClosestToPos($end, nodeType);
+      if (getBooleanFF('platform.editor.ordered-list-auto-join-improvements_mrlv5')) {
+        // if there's a list before & the new list has an order property that does
+        // not match to follow the last number on the first list then do NOT merge the lists
+        const nodeBeforeSelection = tr.doc.resolve(parentNodePosMapped).nodeBefore;
+        const nextExpectedNumberAfterListBefore = (nodeBeforeSelection === null || nodeBeforeSelection === void 0 ? void 0 : nodeBeforeSelection.type.name) === 'orderedList' ? (nodeBeforeSelection === null || nodeBeforeSelection === void 0 ? void 0 : nodeBeforeSelection.attrs.order) + (nodeBeforeSelection === null || nodeBeforeSelection === void 0 ? void 0 : nodeBeforeSelection.childCount) : undefined;
+        const listBeforeDoesNotMatchWithNewList = nodeBeforeSelection && typeof attrs.order === 'number' && nextExpectedNumberAfterListBefore && attrs.order !== nextExpectedNumberAfterListBefore;
+        if (nodeBeforeSelection && listBeforeDoesNotMatchWithNewList) {
+          return tr;
+        }
+      }
+
+      // otherwise join the lists
       if (node) {
         const nodeEnd = node.pos + node.node.nodeSize;
         const after = tr.doc.resolve(nodeEnd).nodeAfter;

package/dist/esm/pm-plugins/input-rules/wrapping-join-rule.js

@@ -1,6 +1,7 @@
 import { JOIN_SCENARIOS_WHEN_TYPING_TO_INSERT_LIST } from '@atlaskit/editor-common/analytics';
 import { canJoin, findWrapping } from '@atlaskit/editor-prosemirror/transform';
 import { findParentNodeOfTypeClosestToPos } from '@atlaskit/editor-prosemirror/utils';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import { createRule } from '@atlaskit/prosemirror-input-rules';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -30,12 +31,24 @@ export var createWrappingJoinRule = function createWrappingJoinRule(_ref) {
       tr.setNodeMarkup(parentNodePosMapped, parentNode.type, parentNode.attrs, allowedMarks);
     }
     tr.wrap(range, wrapping);
+
+    // if an orderedList node would be inserted by the input rule match, and
+    // that orderedList node is being added directly after another orderedList
     if (featureFlags !== null && featureFlags !== void 0 && featureFlags.restartNumberedLists && nodeType === state.schema.nodes.orderedList) {
-      // if an orderedList node would be inserted by the input rule match, and
-      // that orderedList node is being added directly before another orderedList
-      // node, then join those nodes
       var $end = tr.doc.resolve(tr.mapping.map(end));
       var _node = findParentNodeOfTypeClosestToPos($end, nodeType);
+      if (getBooleanFF('platform.editor.ordered-list-auto-join-improvements_mrlv5')) {
+        // if there's a list before & the new list has an order property that does
+        // not match to follow the last number on the first list then do NOT merge the lists
+        var nodeBeforeSelection = tr.doc.resolve(parentNodePosMapped).nodeBefore;
+        var nextExpectedNumberAfterListBefore = (nodeBeforeSelection === null || nodeBeforeSelection === void 0 ? void 0 : nodeBeforeSelection.type.name) === 'orderedList' ? (nodeBeforeSelection === null || nodeBeforeSelection === void 0 ? void 0 : nodeBeforeSelection.attrs.order) + (nodeBeforeSelection === null || nodeBeforeSelection === void 0 ? void 0 : nodeBeforeSelection.childCount) : undefined;
+        var listBeforeDoesNotMatchWithNewList = nodeBeforeSelection && typeof attrs.order === 'number' && nextExpectedNumberAfterListBefore && attrs.order !== nextExpectedNumberAfterListBefore;
+        if (nodeBeforeSelection && listBeforeDoesNotMatchWithNewList) {
+          return tr;
+        }
+      }
+
+      // otherwise join the lists
       if (_node) {
         var nodeEnd = _node.pos + _node.node.nodeSize;
         var after = tr.doc.resolve(nodeEnd).nodeAfter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-list",
-  "version": "1.3.7",
+  "version": "1.4.0",
   "description": "List plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -32,10 +32,11 @@
   },
   "dependencies": {
     "@atlaskit/adf-schema": "^34.0.1",
-    "@atlaskit/editor-common": "^76.23.0",
+    "@atlaskit/editor-common": "^76.24.0",
     "@atlaskit/editor-plugin-analytics": "^0.3.0",
     "@atlaskit/editor-plugin-feature-flags": "^1.0.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
+    "@atlaskit/platform-feature-flags": "^0.2.0",
     "@atlaskit/prosemirror-input-rules": "^2.4.0",
     "@babel/runtime": "^7.0.0"
   },
@@ -86,5 +87,10 @@
       ]
     }
   },
-  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0",
+  "platform-feature-flags": {
+    "platform.editor.ordered-list-auto-join-improvements_mrlv5": {
+      "type": "boolean"
+    }
+  }
 }