@atlaskit/prosemirror-input-rules 2.4.6 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @atlaskit/prosemirror-input-rules
 
+## 3.0.0
+
+### Major Changes
+
+- [#75482](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/75482) [`18b5a6fb910a`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/18b5a6fb910a) - # MAJOR CHANGE to `@atlaskit/prosemirror-input-rules` package.
+
+  ## WHY?
+
+  Removing editor-common dependencies from prosemirror-input-rules package.
+
+  This makes it easier for editor updates because it simplifies our dependency graph.
+
+  ## WHAT and HOW?
+
+  These are no longer available via `@atlaskit/prosemirror-input-rules` but are available from `@atlaskit/editor-common/types`:
+
+  - InputRuleWrapper
+  - InputRuleHandler
+  - OnHandlerApply
+  - createRule
+
+  These have changed from a `SafePlugin` to a `SafePluginSpec`. In order to update your code you need to instantiate a `SafePlugin` (ie. `new SafePlugin(createPlugin( ... ))`).
+
+  `SafePlugin` exists in `@atlaskit/editor-common/safe-plugin`.
+
+  - createPlugin
+  - createInputRulePlugin
+
 ## 2.4.6
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -17,9 +17,5 @@
         "../src/**/*.test.*",
         "../src/**/test.*"
     ],
-    "references": [
-        {
-            "path": "../../editor-common/afm-cc/tsconfig.json"
-        }
-    ]
+    "references": []
 }

package/dist/cjs/editor-common.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isGapCursorSelection = void 0;
+/**
+ * This file is to duplicate types that exist in editor-common
+ * so that input-rules does not depend on it.
+ *
+ * This simplifies our dependencies and makes adoption much easier.
+ */
+
+// This is to workaround requiring editor-common in this repository which
+// makes the dependency tree significantly more complex since editor-common
+// needs to be a singleton
+var isGapCursorSelection = exports.isGapCursorSelection = function isGapCursorSelection(selection) {
+  // @ts-expect-error
+  return Boolean(selection.jsonID === 'gapcursor');
+};

package/dist/cjs/handler.js

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.createInputEventHandler = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _selection = require("@atlaskit/editor-common/selection");
 var _constants = require("./constants");
+var _editorCommon = require("./editor-common");
 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; }
 var createInputEventHandler = exports.createInputEventHandler = function createInputEventHandler(_ref) {
@@ -77,7 +77,7 @@ function findMatchOnRules(_ref3) {
     // and `textBefore` contains the text in the previous block before the gap cursor.
     // Here is a workaround: if we inside a gap cursor, match the input rule only against the last typed character
     // (which may be a typeahead trigger) and ignore the rest.
-    var matchString = state.selection instanceof _selection.GapCursorSelection ? (_textBefore$at = textBefore.at(-1)) !== null && _textBefore$at !== void 0 ? _textBefore$at : '' : textBefore;
+    var matchString = (0, _editorCommon.isGapCursorSelection)(state.selection) ? (_textBefore$at = textBefore.at(-1)) !== null && _textBefore$at !== void 0 ? _textBefore$at : '' : textBefore;
     var match = rule.match.exec(matchString);
     if (!match) {
       continue;

package/dist/cjs/index.js

@@ -27,12 +27,6 @@ Object.defineProperty(exports, "createPlugin", {
     return _utils.createPlugin;
   }
 });
-Object.defineProperty(exports, "createRule", {
-  enumerable: true,
-  get: function get() {
-    return _utils.createRule;
-  }
-});
 Object.defineProperty(exports, "leafNodeReplacementCharacter", {
   enumerable: true,
   get: function get() {

package/dist/cjs/plugin.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createInputRulePlugin = createInputRulePlugin;
-var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _constants = require("./constants");
 var _handler = require("./handler");
@@ -21,7 +20,7 @@ function createInputRulePlugin(pluginName, rules) {
     onInputEvent: onInputEvent,
     onBeforeRegexMatch: onBeforeRegexMatch
   });
-  var plugin = new _safePlugin.SafePlugin({
+  return {
     key: pluginKey,
     state: {
       init: function init() {
@@ -91,6 +90,5 @@ function createInputRulePlugin(pluginName, rules) {
     // @ts-ignore This is used by prosemirror-view to apply input rules on text input event.
     // However, there is no typing ffor this, yet.
     isInputRules: true
-  });
-  return plugin;
+  };
 }

package/dist/cjs/utils.js

@@ -4,17 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createPlugin = void 0;
-Object.defineProperty(exports, "createRule", {
-  enumerable: true,
-  get: function get() {
-    return _utils.createRule;
-  }
-});
-var _selection = require("@atlaskit/editor-common/selection");
 var _history = require("@atlaskit/editor-prosemirror/history");
 var _state = require("@atlaskit/editor-prosemirror/state");
+var _editorCommon = require("./editor-common");
 var _plugin = require("./plugin");
-var _utils = require("@atlaskit/editor-common/utils");
 var hasUnsupportedMarks = function hasUnsupportedMarks(state, start, end, marksNameUnsupported) {
   var isUnsupportedMark = function isUnsupportedMark(node) {
     return (marksNameUnsupported || []).includes(node.type.name);
@@ -48,7 +41,7 @@ var createPlugin = exports.createPlugin = function createPlugin(pluginName, rule
       to = _ref.to;
     var unsupportedMarks = isBlockNodeRule ? ['code', 'link', 'typeAheadQuery'] : ['code'];
     var $from = state.selection.$from;
-    if ($from.parent.type.spec.code || !(state.selection instanceof _state.TextSelection) && !(state.selection instanceof _selection.GapCursorSelection) || hasUnsupportedMarks(state, from, to, unsupportedMarks) || isBlockNodeRule && isCursorInsideUnsupportedMarks(state, unsupportedMarks)) {
+    if ($from.parent.type.spec.code || !(state.selection instanceof _state.TextSelection) && !(0, _editorCommon.isGapCursorSelection)(state.selection) || hasUnsupportedMarks(state, from, to, unsupportedMarks) || isBlockNodeRule && isCursorInsideUnsupportedMarks(state, unsupportedMarks)) {
       return false;
     }
     return true;

package/dist/es2019/editor-common.js

@@ -0,0 +1,14 @@
+/**
+ * This file is to duplicate types that exist in editor-common
+ * so that input-rules does not depend on it.
+ *
+ * This simplifies our dependencies and makes adoption much easier.
+ */
+
+// This is to workaround requiring editor-common in this repository which
+// makes the dependency tree significantly more complex since editor-common
+// needs to be a singleton
+export const isGapCursorSelection = selection => {
+  // @ts-expect-error
+  return Boolean(selection.jsonID === 'gapcursor');
+};

package/dist/es2019/handler.js

@@ -1,5 +1,5 @@
-import { GapCursorSelection } from '@atlaskit/editor-common/selection';
 import { leafNodeReplacementCharacter, MAX_REGEX_MATCH, TEXT_INPUT_RULE_TRANSACTION_KEY } from './constants';
+import { isGapCursorSelection } from './editor-common';
 export const createInputEventHandler = ({
   rules,
   pluginKey,
@@ -68,7 +68,7 @@ function findMatchOnRules({
     // and `textBefore` contains the text in the previous block before the gap cursor.
     // Here is a workaround: if we inside a gap cursor, match the input rule only against the last typed character
     // (which may be a typeahead trigger) and ignore the rest.
-    const matchString = state.selection instanceof GapCursorSelection ? (_textBefore$at = textBefore.at(-1)) !== null && _textBefore$at !== void 0 ? _textBefore$at : '' : textBefore;
+    const matchString = isGapCursorSelection(state.selection) ? (_textBefore$at = textBefore.at(-1)) !== null && _textBefore$at !== void 0 ? _textBefore$at : '' : textBefore;
     const match = rule.match.exec(matchString);
     if (!match) {
       continue;

package/dist/es2019/index.js

@@ -1,3 +1,3 @@
 export { leafNodeReplacementCharacter, TEXT_INPUT_RULE_TRANSACTION_KEY, MAX_REGEX_MATCH } from './constants';
 export { createInputRulePlugin } from './plugin';
-export { createRule, createPlugin } from './utils';
+export { createPlugin } from './utils';

package/dist/es2019/plugin.js

@@ -1,4 +1,3 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { TEXT_INPUT_RULE_TRANSACTION_KEY } from './constants';
 import { createInputEventHandler } from './handler';
@@ -14,7 +13,7 @@ export function createInputRulePlugin(pluginName, rules, options = {}) {
     onInputEvent,
     onBeforeRegexMatch
   });
-  const plugin = new SafePlugin({
+  return {
     key: pluginKey,
     state: {
       init() {
@@ -88,6 +87,5 @@ export function createInputRulePlugin(pluginName, rules, options = {}) {
     // @ts-ignore This is used by prosemirror-view to apply input rules on text input event.
     // However, there is no typing ffor this, yet.
     isInputRules: true
-  });
-  return plugin;
+  };
 }

package/dist/es2019/utils.js

@@ -1,8 +1,7 @@
-import { GapCursorSelection } from '@atlaskit/editor-common/selection';
 import { closeHistory } from '@atlaskit/editor-prosemirror/history';
 import { TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { isGapCursorSelection } from './editor-common';
 import { createInputRulePlugin } from './plugin';
-export { createRule } from '@atlaskit/editor-common/utils';
 const hasUnsupportedMarks = (state, start, end, marksNameUnsupported) => {
   const isUnsupportedMark = node => (marksNameUnsupported || []).includes(node.type.name);
   const $from = state.doc.resolve(start);
@@ -36,7 +35,7 @@ export const createPlugin = (pluginName, rules, options = {}) => {
   }) => {
     const unsupportedMarks = isBlockNodeRule ? ['code', 'link', 'typeAheadQuery'] : ['code'];
     const $from = state.selection.$from;
-    if ($from.parent.type.spec.code || !(state.selection instanceof TextSelection) && !(state.selection instanceof GapCursorSelection) || hasUnsupportedMarks(state, from, to, unsupportedMarks) || isBlockNodeRule && isCursorInsideUnsupportedMarks(state, unsupportedMarks)) {
+    if ($from.parent.type.spec.code || !(state.selection instanceof TextSelection) && !isGapCursorSelection(state.selection) || hasUnsupportedMarks(state, from, to, unsupportedMarks) || isBlockNodeRule && isCursorInsideUnsupportedMarks(state, unsupportedMarks)) {
       return false;
     }
     return true;

package/dist/esm/editor-common.js

@@ -0,0 +1,14 @@
+/**
+ * This file is to duplicate types that exist in editor-common
+ * so that input-rules does not depend on it.
+ *
+ * This simplifies our dependencies and makes adoption much easier.
+ */
+
+// This is to workaround requiring editor-common in this repository which
+// makes the dependency tree significantly more complex since editor-common
+// needs to be a singleton
+export var isGapCursorSelection = function isGapCursorSelection(selection) {
+  // @ts-expect-error
+  return Boolean(selection.jsonID === 'gapcursor');
+};

package/dist/esm/handler.js

@@ -1,8 +1,8 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 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) { _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 { GapCursorSelection } from '@atlaskit/editor-common/selection';
 import { leafNodeReplacementCharacter, MAX_REGEX_MATCH, TEXT_INPUT_RULE_TRANSACTION_KEY } from './constants';
+import { isGapCursorSelection } from './editor-common';
 export var createInputEventHandler = function createInputEventHandler(_ref) {
   var rules = _ref.rules,
     pluginKey = _ref.pluginKey,
@@ -70,7 +70,7 @@ function findMatchOnRules(_ref3) {
     // and `textBefore` contains the text in the previous block before the gap cursor.
     // Here is a workaround: if we inside a gap cursor, match the input rule only against the last typed character
     // (which may be a typeahead trigger) and ignore the rest.
-    var matchString = state.selection instanceof GapCursorSelection ? (_textBefore$at = textBefore.at(-1)) !== null && _textBefore$at !== void 0 ? _textBefore$at : '' : textBefore;
+    var matchString = isGapCursorSelection(state.selection) ? (_textBefore$at = textBefore.at(-1)) !== null && _textBefore$at !== void 0 ? _textBefore$at : '' : textBefore;
     var match = rule.match.exec(matchString);
     if (!match) {
       continue;

package/dist/esm/index.js

@@ -1,3 +1,3 @@
 export { leafNodeReplacementCharacter, TEXT_INPUT_RULE_TRANSACTION_KEY, MAX_REGEX_MATCH } from './constants';
 export { createInputRulePlugin } from './plugin';
-export { createRule, createPlugin } from './utils';
+export { createPlugin } from './utils';

package/dist/esm/plugin.js

@@ -1,4 +1,3 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { TEXT_INPUT_RULE_TRANSACTION_KEY } from './constants';
 import { createInputEventHandler } from './handler';
@@ -15,7 +14,7 @@ export function createInputRulePlugin(pluginName, rules) {
     onInputEvent: onInputEvent,
     onBeforeRegexMatch: onBeforeRegexMatch
   });
-  var plugin = new SafePlugin({
+  return {
     key: pluginKey,
     state: {
       init: function init() {
@@ -85,6 +84,5 @@ export function createInputRulePlugin(pluginName, rules) {
     // @ts-ignore This is used by prosemirror-view to apply input rules on text input event.
     // However, there is no typing ffor this, yet.
     isInputRules: true
-  });
-  return plugin;
+  };
 }

package/dist/esm/utils.js

@@ -1,8 +1,7 @@
-import { GapCursorSelection } from '@atlaskit/editor-common/selection';
 import { closeHistory } from '@atlaskit/editor-prosemirror/history';
 import { TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { isGapCursorSelection } from './editor-common';
 import { createInputRulePlugin } from './plugin';
-export { createRule } from '@atlaskit/editor-common/utils';
 var hasUnsupportedMarks = function hasUnsupportedMarks(state, start, end, marksNameUnsupported) {
   var isUnsupportedMark = function isUnsupportedMark(node) {
     return (marksNameUnsupported || []).includes(node.type.name);
@@ -36,7 +35,7 @@ export var createPlugin = function createPlugin(pluginName, rules) {
       to = _ref.to;
     var unsupportedMarks = isBlockNodeRule ? ['code', 'link', 'typeAheadQuery'] : ['code'];
     var $from = state.selection.$from;
-    if ($from.parent.type.spec.code || !(state.selection instanceof TextSelection) && !(state.selection instanceof GapCursorSelection) || hasUnsupportedMarks(state, from, to, unsupportedMarks) || isBlockNodeRule && isCursorInsideUnsupportedMarks(state, unsupportedMarks)) {
+    if ($from.parent.type.spec.code || !(state.selection instanceof TextSelection) && !isGapCursorSelection(state.selection) || hasUnsupportedMarks(state, from, to, unsupportedMarks) || isBlockNodeRule && isCursorInsideUnsupportedMarks(state, unsupportedMarks)) {
       return false;
     }
     return true;

package/dist/types/editor-common.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file is to duplicate types that exist in editor-common
+ * so that input-rules does not depend on it.
+ *
+ * This simplifies our dependencies and makes adoption much easier.
+ */
+import type { EditorState, Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
+export type InputRuleHandler = (state: EditorState, matchResult: RegExpExecArray, start: number, end: number) => Transaction | null;
+export type OnHandlerApply = (state: EditorState, tr: Transaction, matchResult: RegExpExecArray) => void;
+export interface InputRuleWrapper {
+    match: RegExp;
+    handler: InputRuleHandler;
+    onHandlerApply?: OnHandlerApply;
+}
+export declare const isGapCursorSelection: (selection: Selection) => boolean;

package/dist/types/index.d.ts

@@ -1,18 +1,5 @@
-import type { InputRuleHandler, InputRuleWrapper, OnHandlerApply } from '@atlaskit/editor-common/types';
 import type { OnInputEvent } from './types';
 export { leafNodeReplacementCharacter, TEXT_INPUT_RULE_TRANSACTION_KEY, MAX_REGEX_MATCH, } from './constants';
 export { createInputRulePlugin } from './plugin';
-export type { 
-/**
- * @deprecated Please import this type from @atlaskit/editor-commmon/types
- */
-InputRuleWrapper, 
-/**
- * @deprecated Please import this type from @atlaskit/editor-commmon/types
- */
-InputRuleHandler, OnInputEvent, 
-/**
- * @deprecated Please import this type from @atlaskit/editor-commmon/types
- */
-OnHandlerApply, };
-export { createRule, createPlugin } from './utils';
+export type { OnInputEvent };
+export { createPlugin } from './utils';

package/dist/types/plugin.d.ts

@@ -1,9 +1,9 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { SafePluginSpec } from '@atlaskit/editor-prosemirror/state';
 import type { InputRuleWrapper, OnBeforeRegexMatch, OnInputEvent } from './types';
 type Options = {
     allowInsertTextOnDocument?: boolean;
     onInputEvent?: OnInputEvent;
     onBeforeRegexMatch?: OnBeforeRegexMatch;
 };
-export declare function createInputRulePlugin(pluginName: string, rules: InputRuleWrapper[], options?: Options): SafePlugin;
+export declare function createInputRulePlugin(pluginName: string, rules: InputRuleWrapper[], options?: Options): SafePluginSpec;
 export {};

package/dist/types/types.d.ts

@@ -1,6 +1,7 @@
-import type { InputRuleHandler, InputRuleWrapper, OnHandlerApply } from '@atlaskit/editor-common/types';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { InputRuleWrapper } from './editor-common';
+export type { InputRuleHandler, InputRuleWrapper, OnHandlerApply, } from './editor-common';
 export type HandleInputEvent = (props: {
     view: EditorView;
     from: number;
@@ -22,16 +23,3 @@ export type OnInputEvent = (props: {
     to: number;
 }) => boolean;
 export type OnBeforeRegexMatch = (tr: Transaction) => void;
-export type { 
-/**
- * @deprecated Please import this type from @atlaskit/editor-commmon/types
- */
-InputRuleHandler, 
-/**
- * @deprecated Please import this type from @atlaskit/editor-commmon/types
- */
-OnHandlerApply, 
-/**
- * @deprecated Please import this type from @atlaskit/editor-commmon/types
- */
-InputRuleWrapper, };

package/dist/types/utils.d.ts

@@ -1,8 +1,8 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { InputRuleWrapper } from '@atlaskit/editor-common/types';
-export { createRule } from '@atlaskit/editor-common/utils';
+import type { SafePluginSpec } from '@atlaskit/editor-prosemirror/state';
+import type { InputRuleWrapper } from './types';
 type Options = {
     isBlockNodeRule?: boolean;
     allowInsertTextOnDocument?: boolean;
 };
-export declare const createPlugin: (pluginName: string, rules: Array<InputRuleWrapper>, options?: Options) => SafePlugin;
+export declare const createPlugin: (pluginName: string, rules: Array<InputRuleWrapper>, options?: Options) => SafePluginSpec;
+export {};

package/dist/types-ts4.5/editor-common.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file is to duplicate types that exist in editor-common
+ * so that input-rules does not depend on it.
+ *
+ * This simplifies our dependencies and makes adoption much easier.
+ */
+import type { EditorState, Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
+export type InputRuleHandler = (state: EditorState, matchResult: RegExpExecArray, start: number, end: number) => Transaction | null;
+export type OnHandlerApply = (state: EditorState, tr: Transaction, matchResult: RegExpExecArray) => void;
+export interface InputRuleWrapper {
+    match: RegExp;
+    handler: InputRuleHandler;
+    onHandlerApply?: OnHandlerApply;
+}
+export declare const isGapCursorSelection: (selection: Selection) => boolean;

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

@@ -1,18 +1,5 @@
-import type { InputRuleHandler, InputRuleWrapper, OnHandlerApply } from '@atlaskit/editor-common/types';
 import type { OnInputEvent } from './types';
 export { leafNodeReplacementCharacter, TEXT_INPUT_RULE_TRANSACTION_KEY, MAX_REGEX_MATCH, } from './constants';
 export { createInputRulePlugin } from './plugin';
-export type { 
-/**
- * @deprecated Please import this type from @atlaskit/editor-commmon/types
- */
-InputRuleWrapper, 
-/**
- * @deprecated Please import this type from @atlaskit/editor-commmon/types
- */
-InputRuleHandler, OnInputEvent, 
-/**
- * @deprecated Please import this type from @atlaskit/editor-commmon/types
- */
-OnHandlerApply, };
-export { createRule, createPlugin } from './utils';
+export type { OnInputEvent };
+export { createPlugin } from './utils';

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

@@ -1,9 +1,9 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { SafePluginSpec } from '@atlaskit/editor-prosemirror/state';
 import type { InputRuleWrapper, OnBeforeRegexMatch, OnInputEvent } from './types';
 type Options = {
     allowInsertTextOnDocument?: boolean;
     onInputEvent?: OnInputEvent;
     onBeforeRegexMatch?: OnBeforeRegexMatch;
 };
-export declare function createInputRulePlugin(pluginName: string, rules: InputRuleWrapper[], options?: Options): SafePlugin;
+export declare function createInputRulePlugin(pluginName: string, rules: InputRuleWrapper[], options?: Options): SafePluginSpec;
 export {};

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

@@ -1,6 +1,7 @@
-import type { InputRuleHandler, InputRuleWrapper, OnHandlerApply } from '@atlaskit/editor-common/types';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { InputRuleWrapper } from './editor-common';
+export type { InputRuleHandler, InputRuleWrapper, OnHandlerApply, } from './editor-common';
 export type HandleInputEvent = (props: {
     view: EditorView;
     from: number;
@@ -22,16 +23,3 @@ export type OnInputEvent = (props: {
     to: number;
 }) => boolean;
 export type OnBeforeRegexMatch = (tr: Transaction) => void;
-export type { 
-/**
- * @deprecated Please import this type from @atlaskit/editor-commmon/types
- */
-InputRuleHandler, 
-/**
- * @deprecated Please import this type from @atlaskit/editor-commmon/types
- */
-OnHandlerApply, 
-/**
- * @deprecated Please import this type from @atlaskit/editor-commmon/types
- */
-InputRuleWrapper, };

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

@@ -1,8 +1,8 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { InputRuleWrapper } from '@atlaskit/editor-common/types';
-export { createRule } from '@atlaskit/editor-common/utils';
+import type { SafePluginSpec } from '@atlaskit/editor-prosemirror/state';
+import type { InputRuleWrapper } from './types';
 type Options = {
     isBlockNodeRule?: boolean;
     allowInsertTextOnDocument?: boolean;
 };
-export declare const createPlugin: (pluginName: string, rules: Array<InputRuleWrapper>, options?: Options) => SafePlugin;
+export declare const createPlugin: (pluginName: string, rules: Array<InputRuleWrapper>, options?: Options) => SafePluginSpec;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/prosemirror-input-rules",
-  "version": "2.4.6",
+  "version": "3.0.0",
   "description": "A package that contains helpers to create autoformatting rules for ProseMirror",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -28,11 +28,11 @@
     "releaseModel": "continuous"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^78.0.0",
     "@atlaskit/editor-prosemirror": "3.0.0",
     "@babel/runtime": "^7.0.0"
   },
   "devDependencies": {
+    "@atlaskit/editor-common": "^78.4.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1"
   },
   "techstack": {

package/src/__tests__/unit/plugin.ts

@@ -1,4 +1,4 @@
-import type { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { DocBuilder } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import { EditorView } from '@atlaskit/editor-prosemirror/view';
@@ -41,17 +41,19 @@ describe('input-tule/plugin/createInputRulePlugin', () => {
       });
 
       const INLINE_CODE_REGEX = /(\S*)(`[^\s][^`]*`)$/;
-      const myCustomInputRule = createInputRulePlugin(
-        'lol',
-        [
+      const myCustomInputRule = new SafePlugin(
+        createInputRulePlugin(
+          'lol',
+          [
+            {
+              match: INLINE_CODE_REGEX,
+              handler: handlerMock,
+            },
+          ],
           {
-            match: INLINE_CODE_REGEX,
-            handler: handlerMock,
+            allowInsertTextOnDocument: true,
           },
-        ],
-        {
-          allowInsertTextOnDocument: true,
-        },
+        ),
       );
 
       editorView = createEditorView(
@@ -112,17 +114,19 @@ describe('input-tule/plugin/createInputRulePlugin', () => {
       });
 
       const CODE_BLOCK_REGEX = /(?!\s)(`{3,})/;
-      const myCustomInputRule = createInputRulePlugin(
-        'lol',
-        [
+      const myCustomInputRule = new SafePlugin(
+        createInputRulePlugin(
+          'lol',
+          [
+            {
+              match: CODE_BLOCK_REGEX,
+              handler: handlerMock,
+            },
+          ],
           {
-            match: CODE_BLOCK_REGEX,
-            handler: handlerMock,
+            allowInsertTextOnDocument: true,
           },
-        ],
-        {
-          allowInsertTextOnDocument: true,
-        },
+        ),
       );
 
       editorView = createEditorView(doc(p('here {<>}')), myCustomInputRule);

package/src/editor-common.ts

@@ -0,0 +1,38 @@
+/**
+ * This file is to duplicate types that exist in editor-common
+ * so that input-rules does not depend on it.
+ *
+ * This simplifies our dependencies and makes adoption much easier.
+ */
+import type {
+  EditorState,
+  Selection,
+  Transaction,
+} from '@atlaskit/editor-prosemirror/state';
+
+export type InputRuleHandler = (
+  state: EditorState,
+  matchResult: RegExpExecArray,
+  start: number,
+  end: number,
+) => Transaction | null;
+
+export type OnHandlerApply = (
+  state: EditorState,
+  tr: Transaction,
+  matchResult: RegExpExecArray,
+) => void;
+
+export interface InputRuleWrapper {
+  match: RegExp;
+  handler: InputRuleHandler;
+  onHandlerApply?: OnHandlerApply;
+}
+
+// This is to workaround requiring editor-common in this repository which
+// makes the dependency tree significantly more complex since editor-common
+// needs to be a singleton
+export const isGapCursorSelection = (selection: Selection): boolean => {
+  // @ts-expect-error
+  return Boolean(selection.jsonID === 'gapcursor');
+};

package/src/handler.ts

@@ -1,4 +1,3 @@
-import { GapCursorSelection } from '@atlaskit/editor-common/selection';
 import type {
   EditorState,
   PluginKey,
@@ -10,6 +9,7 @@ import {
   MAX_REGEX_MATCH,
   TEXT_INPUT_RULE_TRANSACTION_KEY,
 } from './constants';
+import { isGapCursorSelection } from './editor-common';
 import type {
   HandleInputEvent,
   InputRulePluginState,
@@ -116,10 +116,9 @@ function findMatchOnRules({
     // and `textBefore` contains the text in the previous block before the gap cursor.
     // Here is a workaround: if we inside a gap cursor, match the input rule only against the last typed character
     // (which may be a typeahead trigger) and ignore the rest.
-    const matchString: string =
-      state.selection instanceof GapCursorSelection
-        ? textBefore.at(-1) ?? ''
-        : textBefore;
+    const matchString: string = isGapCursorSelection(state.selection)
+      ? textBefore.at(-1) ?? ''
+      : textBefore;
 
     const match = rule.match.exec(matchString);
     if (!match) {

package/src/index.ts

@@ -1,9 +1,3 @@
-import type {
-  InputRuleHandler,
-  InputRuleWrapper,
-  OnHandlerApply,
-} from '@atlaskit/editor-common/types';
-
 import type { OnInputEvent } from './types';
 
 export {
@@ -12,20 +6,6 @@ export {
   MAX_REGEX_MATCH,
 } from './constants';
 export { createInputRulePlugin } from './plugin';
-export type {
-  /**
-   * @deprecated Please import this type from @atlaskit/editor-commmon/types
-   */
-  InputRuleWrapper,
-  /**
-   * @deprecated Please import this type from @atlaskit/editor-commmon/types
-   */
-  InputRuleHandler,
-  OnInputEvent,
-  /**
-   * @deprecated Please import this type from @atlaskit/editor-commmon/types
-   */
-  OnHandlerApply,
-};
+export type { OnInputEvent };
 
-export { createRule, createPlugin } from './utils';
+export { createPlugin } from './utils';

package/src/plugin.ts

@@ -1,4 +1,4 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { SafePluginSpec } from '@atlaskit/editor-prosemirror/state';
 import { PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
 
 import { TEXT_INPUT_RULE_TRANSACTION_KEY } from './constants';
@@ -20,7 +20,7 @@ export function createInputRulePlugin(
   pluginName: string,
   rules: InputRuleWrapper[],
   options: Options = {},
-): SafePlugin {
+): SafePluginSpec {
   const onInputEvent = options?.onInputEvent;
   const onBeforeRegexMatch = options?.onBeforeRegexMatch;
   const allowInsertTextOnDocument = Boolean(options?.allowInsertTextOnDocument);
@@ -34,7 +34,7 @@ export function createInputRulePlugin(
     onBeforeRegexMatch,
   });
 
-  const plugin = new SafePlugin<InputRulePluginState>({
+  return {
     key: pluginKey,
     state: {
       init() {
@@ -118,7 +118,5 @@ export function createInputRulePlugin(
     // @ts-ignore This is used by prosemirror-view to apply input rules on text input event.
     // However, there is no typing ffor this, yet.
     isInputRules: true,
-  });
-
-  return plugin;
+  };
 }

package/src/types.ts

@@ -1,14 +1,17 @@
-import type {
-  InputRuleHandler,
-  InputRuleWrapper,
-  OnHandlerApply,
-} from '@atlaskit/editor-common/types';
 import type {
   EditorState,
   Transaction,
 } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 
+import type { InputRuleWrapper } from './editor-common';
+
+export type {
+  InputRuleHandler,
+  InputRuleWrapper,
+  OnHandlerApply,
+} from './editor-common';
+
 export type HandleInputEvent = (props: {
   view: EditorView;
   from: number;
@@ -34,18 +37,3 @@ export type OnInputEvent = (props: {
 }) => boolean;
 
 export type OnBeforeRegexMatch = (tr: Transaction) => void;
-
-export type {
-  /**
-   * @deprecated Please import this type from @atlaskit/editor-commmon/types
-   */
-  InputRuleHandler,
-  /**
-   * @deprecated Please import this type from @atlaskit/editor-commmon/types
-   */
-  OnHandlerApply,
-  /**
-   * @deprecated Please import this type from @atlaskit/editor-commmon/types
-   */
-  InputRuleWrapper,
-};

package/src/utils.ts

@@ -1,14 +1,14 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { GapCursorSelection } from '@atlaskit/editor-common/selection';
-import type { InputRuleWrapper } from '@atlaskit/editor-common/types';
 import { closeHistory } from '@atlaskit/editor-prosemirror/history';
-import { Mark as PMMark } from '@atlaskit/editor-prosemirror/model';
-import { EditorState, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import type { Mark as PMMark } from '@atlaskit/editor-prosemirror/model';
+import type {
+  EditorState,
+  SafePluginSpec,
+} from '@atlaskit/editor-prosemirror/state';
+import { TextSelection } from '@atlaskit/editor-prosemirror/state';
 
+import { isGapCursorSelection } from './editor-common';
 import { createInputRulePlugin } from './plugin';
-import type { OnInputEvent } from './types';
-
-export { createRule } from '@atlaskit/editor-common/utils';
+import type { InputRuleWrapper, OnInputEvent } from './types';
 
 const hasUnsupportedMarks = (
   state: EditorState,
@@ -50,7 +50,7 @@ export const createPlugin = (
   pluginName: string,
   rules: Array<InputRuleWrapper>,
   options: Options = {},
-): SafePlugin => {
+): SafePluginSpec => {
   const { isBlockNodeRule = false, allowInsertTextOnDocument = true } = options;
 
   const onInputEvent: OnInputEvent = ({ state, from, to }) => {
@@ -63,7 +63,7 @@ export const createPlugin = (
     if (
       $from.parent.type.spec.code ||
       (!(state.selection instanceof TextSelection) &&
-        !(state.selection instanceof GapCursorSelection)) ||
+        !isGapCursorSelection(state.selection)) ||
       hasUnsupportedMarks(state, from, to, unsupportedMarks) ||
       (isBlockNodeRule &&
         isCursorInsideUnsupportedMarks(state, unsupportedMarks))

package/tsconfig.app.json

@@ -31,9 +31,5 @@
     "composite": true,
     "outDir": "../../../tsDist/@atlaskit__prosemirror-input-rules/app"
   },
-  "references": [
-    {
-      "path": "../editor-common/tsconfig.app.json"
-    }
-  ]
+  "references": []
 }