@atlaskit/editor-plugin-find-replace 2.10.6 → 3.0.1

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # @atlaskit/editor-plugin-find-replace
 
+## 3.0.1
+
+### Patch Changes
+
+- [#180340](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/180340)
+  [`3cf803e05d3b9`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3cf803e05d3b9) -
+  [ux] ED-28366 set active match to closest match to selection rather than first following selection
+- Updated dependencies
+
+## 3.0.0
+
+### Major Changes
+
+- [#181024](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/181024)
+  [`8e80c487ca307`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8e80c487ca307) - ##
+  Make `@atlaskit/editor-common` a peer dependency
+
+  **WHAT:** `@atlaskit/editor-common` has been moved from `dependencies` to `peerDependencies` in
+  all editor plugin packages.
+
+  **WHY:** This change ensures that only a single version of `@atlaskit/editor-common` is used in
+  consuming applications, preventing issues caused by multiple versions of singleton libraries (such
+  as context mismatches or duplicated state). This is especially important for packages that rely on
+  shared context or singletons.
+
+  **HOW TO ADJUST:**
+
+  - Consumers must now explicitly install `@atlaskit/editor-common` in their own project if they use
+    any of these editor plugins.
+  - Ensure the version you install matches the version required by the plugins.
+  - You can use the
+    [`check-peer-dependencies`](https://www.npmjs.com/package/check-peer-dependencies) package to
+    verify that all required peer dependencies are installed and compatible.
+  - Example install command:
+    ```
+    npm install @atlaskit/editor-common
+    ```
+    or
+    ```
+    yarn add @atlaskit/editor-common
+    ```
+
+  **Note:** This is a breaking change. If `@atlaskit/editor-common` is not installed at the
+  application level, you may see errors or unexpected behavior.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 2.10.6
 
 ### Patch Changes

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

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.toggleMatchCase = exports.replaceAll = exports.replace = exports.removeDecorations = exports.findPrevious = exports.findNext = exports.find = exports.cancelSearch = exports.blur = exports.addDecorations = exports.activate = void 0;
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _view = require("@atlaskit/editor-prosemirror/view");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _actions = require("./actions");
 var _pluginFactory = require("./plugin-factory");
@@ -34,7 +35,7 @@ var activate = exports.activate = function activate() {
         getIntl: getIntl,
         api: api
       });
-      index = (0, _utils.findSearchIndex)(selection.from, matches);
+      index = (0, _expValEquals.expValEquals)('platform_editor_find_and_replace_improvements', 'isEnabled', true) && (0, _platformFeatureFlags.fg)('platform_editor_find_and_replace_improvements_1') ? (0, _utils.findClosestMatch)(selection.from, matches) : (0, _utils.findSearchIndex)(selection.from, matches);
     }
     return {
       type: _actions.FindReplaceActionTypes.ACTIVATE,
@@ -58,7 +59,7 @@ var find = exports.find = function find(editorView, containerElement, keyword) {
       getIntl: getIntl,
       api: api
     }) : [];
-    var index = (0, _utils.findSearchIndex)(selection.from, matches);
+    var index = (0, _expValEquals.expValEquals)('platform_editor_find_and_replace_improvements', 'isEnabled', true) && (0, _platformFeatureFlags.fg)('platform_editor_find_and_replace_improvements_1') ? (0, _utils.findClosestMatch)(selection.from, matches) : (0, _utils.findSearchIndex)(selection.from, matches);
 
     // we can't just apply all the decorations to highlight the search results at once
     // as if there are a lot ProseMirror cries :'(
@@ -87,7 +88,7 @@ var find = exports.find = function find(editorView, containerElement, keyword) {
       api: api
     }) : [];
     if (matches.length > 0) {
-      var index = (0, _utils.findSearchIndex)(selection.from, matches);
+      var index = (0, _expValEquals.expValEquals)('platform_editor_find_and_replace_improvements', 'isEnabled', true) && (0, _platformFeatureFlags.fg)('platform_editor_find_and_replace_improvements_1') ? (0, _utils.findClosestMatch)(selection.from, matches) : (0, _utils.findSearchIndex)(selection.from, matches);
       return tr.setSelection((0, _utils.getSelectionForMatch)(tr.selection, tr.doc, index, matches));
     }
     return tr;

package/dist/cjs/pm-plugins/plugin-factory.js

@@ -9,6 +9,8 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _utils = require("@atlaskit/editor-common/utils");
 var _view = require("@atlaskit/editor-prosemirror/view");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _main = require("./main");
 var _pluginKey = require("./plugin-key");
 var _reducer = _interopRequireDefault(require("./reducer"));
@@ -101,7 +103,7 @@ var handleDocChanged = function handleDocChanged(tr, pluginState) {
     });
   }
   if (newIndex === undefined || newIndex === -1) {
-    newIndex = (0, _utils2.findSearchIndex)(tr.selection.from, newMatches);
+    newIndex = (0, _expValEquals.expValEquals)('platform_editor_find_and_replace_improvements', 'isEnabled', true) && (0, _platformFeatureFlags.fg)('platform_editor_find_and_replace_improvements_1') ? (0, _utils2.findClosestMatch)(tr.selection.from, newMatches) : (0, _utils2.findSearchIndex)(tr.selection.from, newMatches);
   }
   var newSelectedMatch = newMatches[newIndex];
   decorationSet = (0, _utils2.removeMatchesFromSet)(decorationSet, [selectedMatch, newSelectedMatch], tr.doc);

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

@@ -4,7 +4,9 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.findLostAdjacentDecorations = exports.findIndexBeforePosition = exports.findDecorationFromMatch = exports.createDecorations = exports.createDecoration = void 0;
+exports.createDecorations = exports.createDecoration = void 0;
+exports.findClosestMatch = findClosestMatch;
+exports.findLostAdjacentDecorations = exports.findIndexBeforePosition = exports.findDecorationFromMatch = void 0;
 exports.findMatches = findMatches;
 exports.findSearchIndex = findSearchIndex;
 exports.getSelectedText = getSelectedText;
@@ -247,6 +249,22 @@ function findMatches(_ref2) {
   }
   return matches;
 }
+function findClosestMatch(selectionPos, matches) {
+  var forwardMatchIndex = Math.max(matches.findIndex(function (match) {
+    return match.start >= selectionPos;
+  }), 0);
+  if (forwardMatchIndex === 0) {
+    return forwardMatchIndex;
+  }
+  var backwardMatchIndex = forwardMatchIndex - 1;
+  var forwardMatchPos = matches[forwardMatchIndex].start;
+  var backwardMatchPos = matches[backwardMatchIndex].end;
+  if (forwardMatchPos - selectionPos < selectionPos - backwardMatchPos) {
+    return forwardMatchIndex;
+  } else {
+    return backwardMatchIndex;
+  }
+}
 
 /**
  * Finds index of first item in matches array that comes after user's cursor pos.

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

@@ -1,9 +1,10 @@
 import { TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { FindReplaceActionTypes } from './actions';
 import { createCommand, getPluginState } from './plugin-factory';
-import { createDecoration, findDecorationFromMatch, findMatches, findSearchIndex, getSelectedText, getSelectionForMatch, nextIndex, prevIndex, removeDecorationsFromSet, removeMatchesFromSet } from './utils';
+import { createDecoration, findClosestMatch, findDecorationFromMatch, findMatches, findSearchIndex, getSelectedText, getSelectionForMatch, nextIndex, prevIndex, removeDecorationsFromSet, removeMatchesFromSet } from './utils';
 import batchDecorations from './utils/batch-decorations';
 import { withScrollIntoView } from './utils/commands';
 export const activate = () => createCommand(state => {
@@ -29,7 +30,7 @@ export const activate = () => createCommand(state => {
       getIntl,
       api
     });
-    index = findSearchIndex(selection.from, matches);
+    index = expValEquals('platform_editor_find_and_replace_improvements', 'isEnabled', true) && fg('platform_editor_find_and_replace_improvements_1') ? findClosestMatch(selection.from, matches) : findSearchIndex(selection.from, matches);
   }
   return {
     type: FindReplaceActionTypes.ACTIVATE,
@@ -54,7 +55,7 @@ export const find = (editorView, containerElement, keyword) => withScrollIntoVie
     getIntl,
     api
   }) : [];
-  const index = findSearchIndex(selection.from, matches);
+  const index = expValEquals('platform_editor_find_and_replace_improvements', 'isEnabled', true) && fg('platform_editor_find_and_replace_improvements_1') ? findClosestMatch(selection.from, matches) : findSearchIndex(selection.from, matches);
 
   // we can't just apply all the decorations to highlight the search results at once
   // as if there are a lot ProseMirror cries :'(
@@ -82,7 +83,7 @@ export const find = (editorView, containerElement, keyword) => withScrollIntoVie
     api
   }) : [];
   if (matches.length > 0) {
-    const index = findSearchIndex(selection.from, matches);
+    const index = expValEquals('platform_editor_find_and_replace_improvements', 'isEnabled', true) && fg('platform_editor_find_and_replace_improvements_1') ? findClosestMatch(selection.from, matches) : findSearchIndex(selection.from, matches);
     return tr.setSelection(getSelectionForMatch(tr.selection, tr.doc, index, matches));
   }
   return tr;

package/dist/es2019/pm-plugins/plugin-factory.js

@@ -1,9 +1,11 @@
 import { pluginFactory, stepHasSlice } from '@atlaskit/editor-common/utils';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { initialState } from './main';
 import { findReplacePluginKey } from './plugin-key';
 import reducer from './reducer';
-import { createDecorations, findDecorationFromMatch, findMatches, findSearchIndex, isMatchAffectedByStep, removeDecorationsFromSet, removeMatchesFromSet } from './utils';
+import { createDecorations, findClosestMatch, findDecorationFromMatch, findMatches, findSearchIndex, isMatchAffectedByStep, removeDecorationsFromSet, removeMatchesFromSet } from './utils';
 import { findUniqueItemsIn } from './utils/array'; // TODO: ED-26959 - move into index export
 
 const handleDocChanged = (tr, pluginState) => {
@@ -81,7 +83,7 @@ const handleDocChanged = (tr, pluginState) => {
     newIndex = newMatches.findIndex(match => match.start === selectedMatch.start);
   }
   if (newIndex === undefined || newIndex === -1) {
-    newIndex = findSearchIndex(tr.selection.from, newMatches);
+    newIndex = expValEquals('platform_editor_find_and_replace_improvements', 'isEnabled', true) && fg('platform_editor_find_and_replace_improvements_1') ? findClosestMatch(tr.selection.from, newMatches) : findSearchIndex(tr.selection.from, newMatches);
   }
   const newSelectedMatch = newMatches[newIndex];
   decorationSet = removeMatchesFromSet(decorationSet, [selectedMatch, newSelectedMatch], tr.doc);

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

@@ -246,6 +246,20 @@ export function findMatches({
   }
   return matches;
 }
+export function findClosestMatch(selectionPos, matches) {
+  const forwardMatchIndex = Math.max(matches.findIndex(match => match.start >= selectionPos), 0);
+  if (forwardMatchIndex === 0) {
+    return forwardMatchIndex;
+  }
+  const backwardMatchIndex = forwardMatchIndex - 1;
+  const forwardMatchPos = matches[forwardMatchIndex].start;
+  const backwardMatchPos = matches[backwardMatchIndex].end;
+  if (forwardMatchPos - selectionPos < selectionPos - backwardMatchPos) {
+    return forwardMatchIndex;
+  } else {
+    return backwardMatchIndex;
+  }
+}
 
 /**
  * Finds index of first item in matches array that comes after user's cursor pos.

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

@@ -1,9 +1,10 @@
 import { TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { FindReplaceActionTypes } from './actions';
 import { createCommand, getPluginState } from './plugin-factory';
-import { createDecoration, findDecorationFromMatch, findMatches, findSearchIndex, getSelectedText, getSelectionForMatch, nextIndex, prevIndex, removeDecorationsFromSet, removeMatchesFromSet } from './utils';
+import { createDecoration, findClosestMatch, findDecorationFromMatch, findMatches, findSearchIndex, getSelectedText, getSelectionForMatch, nextIndex, prevIndex, removeDecorationsFromSet, removeMatchesFromSet } from './utils';
 import batchDecorations from './utils/batch-decorations';
 import { withScrollIntoView } from './utils/commands';
 export var activate = function activate() {
@@ -27,7 +28,7 @@ export var activate = function activate() {
         getIntl: getIntl,
         api: api
       });
-      index = findSearchIndex(selection.from, matches);
+      index = expValEquals('platform_editor_find_and_replace_improvements', 'isEnabled', true) && fg('platform_editor_find_and_replace_improvements_1') ? findClosestMatch(selection.from, matches) : findSearchIndex(selection.from, matches);
     }
     return {
       type: FindReplaceActionTypes.ACTIVATE,
@@ -51,7 +52,7 @@ export var find = function find(editorView, containerElement, keyword) {
       getIntl: getIntl,
       api: api
     }) : [];
-    var index = findSearchIndex(selection.from, matches);
+    var index = expValEquals('platform_editor_find_and_replace_improvements', 'isEnabled', true) && fg('platform_editor_find_and_replace_improvements_1') ? findClosestMatch(selection.from, matches) : findSearchIndex(selection.from, matches);
 
     // we can't just apply all the decorations to highlight the search results at once
     // as if there are a lot ProseMirror cries :'(
@@ -80,7 +81,7 @@ export var find = function find(editorView, containerElement, keyword) {
       api: api
     }) : [];
     if (matches.length > 0) {
-      var index = findSearchIndex(selection.from, matches);
+      var index = expValEquals('platform_editor_find_and_replace_improvements', 'isEnabled', true) && fg('platform_editor_find_and_replace_improvements_1') ? findClosestMatch(selection.from, matches) : findSearchIndex(selection.from, matches);
       return tr.setSelection(getSelectionForMatch(tr.selection, tr.doc, index, matches));
     }
     return tr;

package/dist/esm/pm-plugins/plugin-factory.js

@@ -4,10 +4,12 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 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 { pluginFactory, stepHasSlice } from '@atlaskit/editor-common/utils';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { initialState } from './main';
 import { findReplacePluginKey } from './plugin-key';
 import reducer from './reducer';
-import { createDecorations, findDecorationFromMatch, findMatches, findSearchIndex, isMatchAffectedByStep, removeDecorationsFromSet, removeMatchesFromSet } from './utils';
+import { createDecorations, findClosestMatch, findDecorationFromMatch, findMatches, findSearchIndex, isMatchAffectedByStep, removeDecorationsFromSet, removeMatchesFromSet } from './utils';
 import { findUniqueItemsIn } from './utils/array'; // TODO: ED-26959 - move into index export
 
 var handleDocChanged = function handleDocChanged(tr, pluginState) {
@@ -93,7 +95,7 @@ var handleDocChanged = function handleDocChanged(tr, pluginState) {
     });
   }
   if (newIndex === undefined || newIndex === -1) {
-    newIndex = findSearchIndex(tr.selection.from, newMatches);
+    newIndex = expValEquals('platform_editor_find_and_replace_improvements', 'isEnabled', true) && fg('platform_editor_find_and_replace_improvements_1') ? findClosestMatch(tr.selection.from, newMatches) : findSearchIndex(tr.selection.from, newMatches);
   }
   var newSelectedMatch = newMatches[newIndex];
   decorationSet = removeMatchesFromSet(decorationSet, [selectedMatch, newSelectedMatch], tr.doc);

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

@@ -236,6 +236,22 @@ export function findMatches(_ref2) {
   }
   return matches;
 }
+export function findClosestMatch(selectionPos, matches) {
+  var forwardMatchIndex = Math.max(matches.findIndex(function (match) {
+    return match.start >= selectionPos;
+  }), 0);
+  if (forwardMatchIndex === 0) {
+    return forwardMatchIndex;
+  }
+  var backwardMatchIndex = forwardMatchIndex - 1;
+  var forwardMatchPos = matches[forwardMatchIndex].start;
+  var backwardMatchPos = matches[backwardMatchIndex].end;
+  if (forwardMatchPos - selectionPos < selectionPos - backwardMatchPos) {
+    return forwardMatchIndex;
+  } else {
+    return backwardMatchIndex;
+  }
+}
 
 /**
  * Finds index of first item in matches array that comes after user's cursor pos.

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

@@ -20,6 +20,7 @@ type FindMatchesType = {
     api?: ExtractInjectionAPI<FindReplacePlugin>;
 };
 export declare function findMatches({ content, searchText, shouldMatchCase, contentIndex, getIntl, api, }: FindMatchesType): Match[];
+export declare function findClosestMatch(selectionPos: number, matches: Match[]): number;
 /**
  * Finds index of first item in matches array that comes after user's cursor pos.
  * If `backward` is `true`, finds index of first item that comes before instead.

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

@@ -20,6 +20,7 @@ type FindMatchesType = {
     api?: ExtractInjectionAPI<FindReplacePlugin>;
 };
 export declare function findMatches({ content, searchText, shouldMatchCase, contentIndex, getIntl, api, }: FindMatchesType): Match[];
+export declare function findClosestMatch(selectionPos: number, matches: Match[]): number;
 /**
  * Finds index of first item in matches array that comes after user's cursor pos.
  * If `backward` is `true`, finds index of first item that comes before instead.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-find-replace",
-	"version": "2.10.6",
+	"version": "3.0.1",
 	"description": "find replace plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,22 +33,21 @@
 	},
 	"dependencies": {
 		"@atlaskit/button": "^23.2.0",
-		"@atlaskit/editor-common": "^107.6.0",
-		"@atlaskit/editor-plugin-analytics": "^2.3.0",
-		"@atlaskit/editor-plugin-card": "^6.8.0",
-		"@atlaskit/editor-plugin-mentions": "^4.7.0",
-		"@atlaskit/editor-plugin-primary-toolbar": "^3.2.0",
+		"@atlaskit/editor-plugin-analytics": "^3.0.0",
+		"@atlaskit/editor-plugin-card": "^7.0.0",
+		"@atlaskit/editor-plugin-mentions": "^5.1.0",
+		"@atlaskit/editor-plugin-primary-toolbar": "^4.0.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.4.0",
 		"@atlaskit/form": "^12.0.0",
-		"@atlaskit/icon": "^27.2.0",
+		"@atlaskit/icon": "^27.3.0",
 		"@atlaskit/icon-lab": "^5.1.0",
 		"@atlaskit/mention": "^24.2.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^14.10.0",
 		"@atlaskit/textfield": "^8.0.0",
 		"@atlaskit/theme": "^18.0.0",
-		"@atlaskit/tmp-editor-statsig": "^8.7.0",
+		"@atlaskit/tmp-editor-statsig": "^9.0.0",
 		"@atlaskit/tokens": "^5.4.0",
 		"@atlaskit/tooltip": "^20.3.0",
 		"@babel/runtime": "^7.0.0",
@@ -59,8 +58,8 @@
 	},
 	"devDependencies": {
 		"@af/visual-regression": "workspace:^",
-		"@atlaskit/editor-plugin-block-type": "^5.2.0",
-		"@atlaskit/editor-plugin-text-formatting": "^2.4.0",
+		"@atlaskit/editor-plugin-block-type": "^6.0.0",
+		"@atlaskit/editor-plugin-text-formatting": "^3.0.0",
 		"@testing-library/react": "^13.4.0",
 		"@testing-library/user-event": "^14.4.3",
 		"mockdate": "^3.0.5",
@@ -68,6 +67,7 @@
 		"react-dom": "^18.2.0"
 	},
 	"peerDependencies": {
+		"@atlaskit/editor-common": "^107.7.0",
 		"react": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},