@atlaskit/editor-plugin-base 2.0.12 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-plugin-base
 
+## 2.1.0
+
+### Minor Changes
+
+- [#97984](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/97984)
+  [`8ffeab9aaf1ab`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/8ffeab9aaf1ab) -
+  [ux] [ED-23573] Added new actions (resolveMarks and registerMarks) to basePlugin. Callbacks added
+  to mentions, card, emoji and base plugins to handle conversion to inline code. Deprecated code
+  removed from editor-common.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 2.0.12
 
 ### Patch Changes

package/dist/cjs/basePlugin.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+exports.resolveCallbacks = resolveCallbacks;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _adfSchema = require("@atlaskit/adf-schema");
 var _keymaps = require("@atlaskit/editor-common/keymaps");
@@ -25,11 +26,63 @@ var _getKeyboardHeight = require("./pm-plugins/scroll-gutter/util/get-keyboard-h
 var _inputTrackingConfig = require("./pm-plugins/utils/inputTrackingConfig");
 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; }
+// eslint-disable-next-line @typescript-eslint/max-params
+function resolveCallbacks(from, to, tr, callbacks) {
+  var doc = tr.doc;
+  doc.nodesBetween(from, to, function (node, pos) {
+    callbacks.forEach(function (cb) {
+      return cb({
+        tr: tr,
+        node: node,
+        pos: pos,
+        from: from,
+        to: to
+      });
+    });
+  });
+}
+var SMART_TO_ASCII = {
+  '…': '...',
+  '→': '->',
+  '←': '<-',
+  '–': '--',
+  '“': '"',
+  '”': '"',
+  '‘': "'",
+  '’': "'"
+};
+
+// eslint-disable-next-line require-unicode-regexp
+var FIND_SMART_CHAR = new RegExp("[".concat(Object.keys(SMART_TO_ASCII).join(''), "]"), 'g');
 var basePlugin = function basePlugin(_ref) {
-  var _api$featureFlags;
+  var _api$featureFlags, _api$base;
   var options = _ref.config,
     api = _ref.api;
   var featureFlags = (api === null || api === void 0 || (_api$featureFlags = api.featureFlags) === null || _api$featureFlags === void 0 ? void 0 : _api$featureFlags.sharedState.currentState()) || {};
+  var callbacks = [];
+  api === null || api === void 0 || (_api$base = api.base) === null || _api$base === void 0 || _api$base.actions.registerMarks(function (_ref2) {
+    var tr = _ref2.tr,
+      node = _ref2.node,
+      pos = _ref2.pos,
+      from = _ref2.from,
+      to = _ref2.to;
+    var doc = tr.doc;
+    var schema = doc.type.schema;
+    var textNodeType = schema.nodes.text;
+    if (node.type === textNodeType && node.text) {
+      // Find a valid start and end position because the text may be partially selected.
+      var startPositionInSelection = Math.max(pos, from);
+      var endPositionInSelection = Math.min(pos + node.nodeSize, to);
+      var textForReplacing = doc.textBetween(startPositionInSelection, endPositionInSelection);
+      var newText = textForReplacing.replace(FIND_SMART_CHAR, function (match) {
+        var _SMART_TO_ASCII$match;
+        return (_SMART_TO_ASCII$match = SMART_TO_ASCII[match]) !== null && _SMART_TO_ASCII$match !== void 0 ? _SMART_TO_ASCII$match : match;
+      });
+      var currentStartPos = tr.mapping.map(startPositionInSelection);
+      var currentEndPos = tr.mapping.map(endPositionInSelection);
+      tr.replaceWith(currentStartPos, currentEndPos, schema.text(newText, node.marks));
+    }
+  });
   return {
     name: 'base',
     getSharedState: function getSharedState(editorState) {
@@ -38,13 +91,19 @@ var basePlugin = function basePlugin(_ref) {
       };
     },
     actions: {
-      setKeyboardHeight: _setKeyboardHeight.setKeyboardHeight
+      setKeyboardHeight: _setKeyboardHeight.setKeyboardHeight,
+      resolveMarks: function resolveMarks(from, to, tr) {
+        return resolveCallbacks(from, to, tr, callbacks);
+      },
+      registerMarks: function registerMarks(callback) {
+        callbacks.push(callback);
+      }
     },
     pmPlugins: function pmPlugins() {
       var plugins = [{
         name: 'filterStepsPlugin',
-        plugin: function plugin(_ref2) {
-          var dispatchAnalyticsEvent = _ref2.dispatchAnalyticsEvent;
+        plugin: function plugin(_ref3) {
+          var dispatchAnalyticsEvent = _ref3.dispatchAnalyticsEvent;
           return (0, _filterSteps.default)(dispatchAnalyticsEvent);
         }
       }];
@@ -81,8 +140,8 @@ var basePlugin = function basePlugin(_ref) {
         plugin: _newlinePreserveMarks.default
       }, {
         name: 'frozenEditor',
-        plugin: function plugin(_ref3) {
-          var dispatchAnalyticsEvent = _ref3.dispatchAnalyticsEvent;
+        plugin: function plugin(_ref4) {
+          var dispatchAnalyticsEvent = _ref4.dispatchAnalyticsEvent;
           return (0, _frozenEditor.default)(api === null || api === void 0 ? void 0 : api.contextIdentifier)(dispatchAnalyticsEvent, _inputTrackingConfig.inputTracking, undefined);
         }
       }, {

package/dist/es2019/basePlugin.js

@@ -15,12 +15,72 @@ import scrollGutter from './pm-plugins/scroll-gutter/plugin';
 import scrollGutterNext from './pm-plugins/scroll-gutter/plugin-next';
 import { getKeyboardHeight } from './pm-plugins/scroll-gutter/util/get-keyboard-height';
 import { inputTracking } from './pm-plugins/utils/inputTrackingConfig';
+
+// eslint-disable-next-line @typescript-eslint/max-params
+export function resolveCallbacks(from, to, tr, callbacks) {
+  const {
+    doc
+  } = tr;
+  doc.nodesBetween(from, to, (node, pos) => {
+    callbacks.forEach(cb => cb({
+      tr,
+      node,
+      pos,
+      from,
+      to
+    }));
+  });
+}
+const SMART_TO_ASCII = {
+  '…': '...',
+  '→': '->',
+  '←': '<-',
+  '–': '--',
+  '“': '"',
+  '”': '"',
+  '‘': "'",
+  '’': "'"
+};
+
+// eslint-disable-next-line require-unicode-regexp
+const FIND_SMART_CHAR = new RegExp(`[${Object.keys(SMART_TO_ASCII).join('')}]`, 'g');
 const basePlugin = ({
   config: options,
   api
 }) => {
-  var _api$featureFlags;
+  var _api$featureFlags, _api$base;
   const featureFlags = (api === null || api === void 0 ? void 0 : (_api$featureFlags = api.featureFlags) === null || _api$featureFlags === void 0 ? void 0 : _api$featureFlags.sharedState.currentState()) || {};
+  const callbacks = [];
+  api === null || api === void 0 ? void 0 : (_api$base = api.base) === null || _api$base === void 0 ? void 0 : _api$base.actions.registerMarks(({
+    tr,
+    node,
+    pos,
+    from,
+    to
+  }) => {
+    const {
+      doc
+    } = tr;
+    const {
+      schema
+    } = doc.type;
+    const {
+      text: textNodeType
+    } = schema.nodes;
+    if (node.type === textNodeType && node.text) {
+      // Find a valid start and end position because the text may be partially selected.
+      const startPositionInSelection = Math.max(pos, from);
+      const endPositionInSelection = Math.min(pos + node.nodeSize, to);
+      const textForReplacing = doc.textBetween(startPositionInSelection, endPositionInSelection);
+      const newText = textForReplacing.replace(FIND_SMART_CHAR, match => {
+        var _SMART_TO_ASCII$match;
+        return (_SMART_TO_ASCII$match = SMART_TO_ASCII[match]) !== null && _SMART_TO_ASCII$match !== void 0 ? _SMART_TO_ASCII$match : match;
+      });
+      const currentStartPos = tr.mapping.map(startPositionInSelection);
+      const currentEndPos = tr.mapping.map(endPositionInSelection);
+      tr.replaceWith(currentStartPos, currentEndPos, schema.text(newText, node.marks));
+    }
+  });
   return {
     name: 'base',
     getSharedState(editorState) {
@@ -29,7 +89,11 @@ const basePlugin = ({
       };
     },
     actions: {
-      setKeyboardHeight
+      setKeyboardHeight,
+      resolveMarks: (from, to, tr) => resolveCallbacks(from, to, tr, callbacks),
+      registerMarks: callback => {
+        callbacks.push(callback);
+      }
     },
     pmPlugins() {
       const plugins = [{

package/dist/esm/basePlugin.js

@@ -18,11 +18,64 @@ import scrollGutter from './pm-plugins/scroll-gutter/plugin';
 import scrollGutterNext from './pm-plugins/scroll-gutter/plugin-next';
 import { getKeyboardHeight } from './pm-plugins/scroll-gutter/util/get-keyboard-height';
 import { inputTracking } from './pm-plugins/utils/inputTrackingConfig';
+
+// eslint-disable-next-line @typescript-eslint/max-params
+export function resolveCallbacks(from, to, tr, callbacks) {
+  var doc = tr.doc;
+  doc.nodesBetween(from, to, function (node, pos) {
+    callbacks.forEach(function (cb) {
+      return cb({
+        tr: tr,
+        node: node,
+        pos: pos,
+        from: from,
+        to: to
+      });
+    });
+  });
+}
+var SMART_TO_ASCII = {
+  '…': '...',
+  '→': '->',
+  '←': '<-',
+  '–': '--',
+  '“': '"',
+  '”': '"',
+  '‘': "'",
+  '’': "'"
+};
+
+// eslint-disable-next-line require-unicode-regexp
+var FIND_SMART_CHAR = new RegExp("[".concat(Object.keys(SMART_TO_ASCII).join(''), "]"), 'g');
 var basePlugin = function basePlugin(_ref) {
-  var _api$featureFlags;
+  var _api$featureFlags, _api$base;
   var options = _ref.config,
     api = _ref.api;
   var featureFlags = (api === null || api === void 0 || (_api$featureFlags = api.featureFlags) === null || _api$featureFlags === void 0 ? void 0 : _api$featureFlags.sharedState.currentState()) || {};
+  var callbacks = [];
+  api === null || api === void 0 || (_api$base = api.base) === null || _api$base === void 0 || _api$base.actions.registerMarks(function (_ref2) {
+    var tr = _ref2.tr,
+      node = _ref2.node,
+      pos = _ref2.pos,
+      from = _ref2.from,
+      to = _ref2.to;
+    var doc = tr.doc;
+    var schema = doc.type.schema;
+    var textNodeType = schema.nodes.text;
+    if (node.type === textNodeType && node.text) {
+      // Find a valid start and end position because the text may be partially selected.
+      var startPositionInSelection = Math.max(pos, from);
+      var endPositionInSelection = Math.min(pos + node.nodeSize, to);
+      var textForReplacing = doc.textBetween(startPositionInSelection, endPositionInSelection);
+      var newText = textForReplacing.replace(FIND_SMART_CHAR, function (match) {
+        var _SMART_TO_ASCII$match;
+        return (_SMART_TO_ASCII$match = SMART_TO_ASCII[match]) !== null && _SMART_TO_ASCII$match !== void 0 ? _SMART_TO_ASCII$match : match;
+      });
+      var currentStartPos = tr.mapping.map(startPositionInSelection);
+      var currentEndPos = tr.mapping.map(endPositionInSelection);
+      tr.replaceWith(currentStartPos, currentEndPos, schema.text(newText, node.marks));
+    }
+  });
   return {
     name: 'base',
     getSharedState: function getSharedState(editorState) {
@@ -31,13 +84,19 @@ var basePlugin = function basePlugin(_ref) {
       };
     },
     actions: {
-      setKeyboardHeight: setKeyboardHeight
+      setKeyboardHeight: setKeyboardHeight,
+      resolveMarks: function resolveMarks(from, to, tr) {
+        return resolveCallbacks(from, to, tr, callbacks);
+      },
+      registerMarks: function registerMarks(callback) {
+        callbacks.push(callback);
+      }
     },
     pmPlugins: function pmPlugins() {
       var plugins = [{
         name: 'filterStepsPlugin',
-        plugin: function plugin(_ref2) {
-          var dispatchAnalyticsEvent = _ref2.dispatchAnalyticsEvent;
+        plugin: function plugin(_ref3) {
+          var dispatchAnalyticsEvent = _ref3.dispatchAnalyticsEvent;
           return filterStepsPlugin(dispatchAnalyticsEvent);
         }
       }];
@@ -74,8 +133,8 @@ var basePlugin = function basePlugin(_ref) {
         plugin: newlinePreserveMarksPlugin
       }, {
         name: 'frozenEditor',
-        plugin: function plugin(_ref3) {
-          var dispatchAnalyticsEvent = _ref3.dispatchAnalyticsEvent;
+        plugin: function plugin(_ref4) {
+          var dispatchAnalyticsEvent = _ref4.dispatchAnalyticsEvent;
           return frozenEditor(api === null || api === void 0 ? void 0 : api.contextIdentifier)(dispatchAnalyticsEvent, inputTracking, undefined);
         }
       }, {

package/dist/types/basePlugin.d.ts

@@ -1,3 +1,5 @@
-import { type BasePlugin } from './basePluginType';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { BasePlugin, Callback } from './basePluginType';
+export declare function resolveCallbacks(from: number, to: number, tr: Transaction, callbacks: Callback[]): void;
 declare const basePlugin: BasePlugin;
 export default basePlugin;

package/dist/types/basePluginType.d.ts

@@ -1,6 +1,8 @@
 import type { BrowserFreezetracking, InputTracking, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { ContextIdentifierPlugin } from '@atlaskit/editor-plugin-context-identifier';
 import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import { type setKeyboardHeight } from './editor-commands/set-keyboard-height';
 import type { ScrollGutterPluginOptions } from './pm-plugins/scroll-gutter/plugin';
 export interface BasePluginOptions {
@@ -25,5 +27,14 @@ export type BasePlugin = NextEditorPlugin<'base', {
     sharedState: BasePluginState;
     actions: {
         setKeyboardHeight: typeof setKeyboardHeight;
+        registerMarks: (callback: Callback) => void;
+        resolveMarks: (from: number, to: number, tr: Transaction) => void;
     };
 }>;
+export type Callback = ({ node, tr, pos, from, to, }: {
+    node: PMNode;
+    tr: Transaction;
+    pos: number;
+    from: number;
+    to: number;
+}) => void;

package/dist/types-ts4.5/basePlugin.d.ts

@@ -1,3 +1,5 @@
-import { type BasePlugin } from './basePluginType';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { BasePlugin, Callback } from './basePluginType';
+export declare function resolveCallbacks(from: number, to: number, tr: Transaction, callbacks: Callback[]): void;
 declare const basePlugin: BasePlugin;
 export default basePlugin;

package/dist/types-ts4.5/basePluginType.d.ts

@@ -1,6 +1,8 @@
 import type { BrowserFreezetracking, InputTracking, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { ContextIdentifierPlugin } from '@atlaskit/editor-plugin-context-identifier';
 import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import { type setKeyboardHeight } from './editor-commands/set-keyboard-height';
 import type { ScrollGutterPluginOptions } from './pm-plugins/scroll-gutter/plugin';
 export interface BasePluginOptions {
@@ -28,5 +30,14 @@ export type BasePlugin = NextEditorPlugin<'base', {
     sharedState: BasePluginState;
     actions: {
         setKeyboardHeight: typeof setKeyboardHeight;
+        registerMarks: (callback: Callback) => void;
+        resolveMarks: (from: number, to: number, tr: Transaction) => void;
     };
 }>;
+export type Callback = ({ node, tr, pos, from, to, }: {
+    node: PMNode;
+    tr: Transaction;
+    pos: number;
+    from: number;
+    to: number;
+}) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-base",
-	"version": "2.0.12",
+	"version": "2.1.0",
 	"description": "Base plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,12 +32,12 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^46.1.0",
-		"@atlaskit/editor-common": "^98.0.0",
+		"@atlaskit/editor-common": "^99.0.0",
 		"@atlaskit/editor-plugin-context-identifier": "^1.3.0",
 		"@atlaskit/editor-plugin-feature-flags": "^1.2.0",
 		"@atlaskit/editor-prosemirror": "6.2.1",
 		"@atlaskit/platform-feature-flags": "^0.3.0",
-		"@atlaskit/tmp-editor-statsig": "^2.31.0",
+		"@atlaskit/tmp-editor-statsig": "^2.33.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"techstack": {