@atlaskit/prosemirror-input-rules 2.1.0 → 2.1.3

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @atlaskit/prosemirror-input-rules
 
+## 2.1.3
+
+### Patch Changes
+
+- Updated dependencies
+
+## 2.1.2
+
+### Patch Changes
+
+- [`4e6fbaf5898`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4e6fbaf5898) - ED-14117 Change EditorState.apply type to receive readonly transaction
+
+  Transactions should not be mutated after being dispatched as it can lead to
+  unexpected behaviour. This change patches the relevant types declared in
+  prosemirror-state as a compile-time safeguard.
+
+- Updated dependencies
+
+## 2.1.1
+
+### Patch Changes
+
+- [`19d72473dfb`](https://bitbucket.org/atlassian/atlassian-frontend/commits/19d72473dfb) - ED-13025 Bump prosemirror-view 1.23.1 -> 1.23.2
+
 ## 2.1.0
 
 ### Minor Changes

package/dist/cjs/constants.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.MAX_REGEX_MATCH = exports.TEXT_INPUT_RULE_TRANSACTION_KEY = exports.leafNodeReplacementCharacter = void 0;
+exports.leafNodeReplacementCharacter = exports.TEXT_INPUT_RULE_TRANSACTION_KEY = exports.MAX_REGEX_MATCH = void 0;
 // ProseMirror uses the Unicode Character 'OBJECT REPLACEMENT CHARACTER' (U+FFFC) as text representation for
 // leaf nodes, i.e. nodes that don't have any content or text property (e.g. hardBreak, emoji, mention, rule)
 // It was introduced because of https://github.com/ProseMirror/prosemirror/issues/262

package/dist/cjs/handler.js

@@ -11,9 +11,9 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 
 var _constants = require("./constants");
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
 var createInputEventHandler = function createInputEventHandler(_ref) {
   var rules = _ref.rules,

package/dist/cjs/index.js

@@ -3,10 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "leafNodeReplacementCharacter", {
+Object.defineProperty(exports, "MAX_REGEX_MATCH", {
   enumerable: true,
   get: function get() {
-    return _constants.leafNodeReplacementCharacter;
+    return _constants.MAX_REGEX_MATCH;
   }
 });
 Object.defineProperty(exports, "TEXT_INPUT_RULE_TRANSACTION_KEY", {
@@ -15,16 +15,16 @@ Object.defineProperty(exports, "TEXT_INPUT_RULE_TRANSACTION_KEY", {
     return _constants.TEXT_INPUT_RULE_TRANSACTION_KEY;
   }
 });
-Object.defineProperty(exports, "MAX_REGEX_MATCH", {
+Object.defineProperty(exports, "createInputRulePlugin", {
   enumerable: true,
   get: function get() {
-    return _constants.MAX_REGEX_MATCH;
+    return _plugin.createInputRulePlugin;
   }
 });
-Object.defineProperty(exports, "createInputRulePlugin", {
+Object.defineProperty(exports, "leafNodeReplacementCharacter", {
   enumerable: true,
   get: function get() {
-    return _plugin.createInputRulePlugin;
+    return _constants.leafNodeReplacementCharacter;
   }
 });
 

package/dist/cjs/plugin.js

@@ -7,6 +7,8 @@ exports.createInputRulePlugin = createInputRulePlugin;
 
 var _prosemirrorState = require("prosemirror-state");
 
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+
 var _constants = require("./constants");
 
 var _handler = require("./handler");
@@ -24,7 +26,7 @@ function createInputRulePlugin(pluginName, rules) {
     onInputEvent: onInputEvent,
     onBeforeRegexMatch: onBeforeRegexMatch
   });
-  var plugin = new _prosemirrorState.Plugin({
+  var plugin = new _safePlugin.SafePlugin({
     key: pluginKey,
     state: {
       init: function init() {

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/prosemirror-input-rules",
-	"version": "2.1.0",
+	"version": "2.1.3",
 	"sideEffects": false
 }

package/dist/es2019/plugin.js

@@ -1,4 +1,5 @@
-import { Plugin, PluginKey, TextSelection } from 'prosemirror-state';
+import { PluginKey, TextSelection } from 'prosemirror-state';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { TEXT_INPUT_RULE_TRANSACTION_KEY } from './constants';
 import { createInputEventHandler } from './handler';
 export function createInputRulePlugin(pluginName, rules, options = {}) {
@@ -13,7 +14,7 @@ export function createInputRulePlugin(pluginName, rules, options = {}) {
     onInputEvent,
     onBeforeRegexMatch
   });
-  const plugin = new Plugin({
+  const plugin = new SafePlugin({
     key: pluginKey,
     state: {
       init() {

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/prosemirror-input-rules",
-	"version": "2.1.0",
+	"version": "2.1.3",
 	"sideEffects": false
 }

package/dist/esm/handler.js

@@ -1,8 +1,8 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
 import { leafNodeReplacementCharacter, MAX_REGEX_MATCH, TEXT_INPUT_RULE_TRANSACTION_KEY } from './constants';
 export var createInputEventHandler = function createInputEventHandler(_ref) {

package/dist/esm/plugin.js

@@ -1,4 +1,5 @@
-import { Plugin, PluginKey, TextSelection } from 'prosemirror-state';
+import { PluginKey, TextSelection } from 'prosemirror-state';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { TEXT_INPUT_RULE_TRANSACTION_KEY } from './constants';
 import { createInputEventHandler } from './handler';
 export function createInputRulePlugin(pluginName, rules) {
@@ -14,7 +15,7 @@ export function createInputRulePlugin(pluginName, rules) {
     onInputEvent: onInputEvent,
     onBeforeRegexMatch: onBeforeRegexMatch
   });
-  var plugin = new Plugin({
+  var plugin = new SafePlugin({
     key: pluginKey,
     state: {
       init: function init() {

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/prosemirror-input-rules",
-	"version": "2.1.0",
+	"version": "2.1.3",
 	"sideEffects": false
 }

package/dist/types/plugin.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/prosemirror-input-rules",
-  "version": "2.1.0",
+  "version": "2.1.3",
   "description": "A package that contains helpers to create autoformatting rules for ProseMirror",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -19,18 +19,19 @@
     "releaseModel": "scheduled"
   },
   "dependencies": {
+    "@atlaskit/editor-common": "^65.0.0",
     "@babel/runtime": "^7.0.0",
     "prosemirror-state": "1.3.4"
   },
   "devDependencies": {
-    "@atlaskit/adf-schema": "^20.0.0",
-    "@atlaskit/editor-test-helpers": "^15.6.0",
+    "@atlaskit/adf-schema": "^22.0.0",
+    "@atlaskit/editor-test-helpers": "^16.1.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/prosemirror-history": "^1.0.1",
     "@types/prosemirror-model": "^1.11.0",
     "@types/prosemirror-state": "^1.2.0",
     "@types/prosemirror-view": "^1.9.0",
-    "prosemirror-view": "1.23.1"
+    "prosemirror-view": "1.23.2"
   },
   "techstack": {
     "@atlassian/frontend": {

package/src/__tests__/unit/plugin.ts

@@ -1,6 +1,7 @@
-import { EditorState, Plugin } from 'prosemirror-state';
+import { EditorState } from 'prosemirror-state';
 import { EditorView } from 'prosemirror-view';
 
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { createEditorState } from '@atlaskit/editor-test-helpers/create-editor-state';
 import { doc, DocBuilder, p } from '@atlaskit/editor-test-helpers/doc-builder';
 
@@ -20,7 +21,7 @@ describe('input-tule/plugin/createInputRulePlugin', () => {
     view.someProp('handleTextInput', (f) => f(view, $from.pos, $to.pos, text));
   }
 
-  function createEditorView(lol: DocBuilder, customInputRule: Plugin) {
+  function createEditorView(lol: DocBuilder, customInputRule: SafePlugin) {
     const editorState = createEditorState(lol, customInputRule);
 
     return new EditorView(editorViewElement, {

package/src/plugin.ts

@@ -1,4 +1,6 @@
-import { Plugin, PluginKey, TextSelection } from 'prosemirror-state';
+import { PluginKey, TextSelection } from 'prosemirror-state';
+
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 
 import { TEXT_INPUT_RULE_TRANSACTION_KEY } from './constants';
 import { createInputEventHandler } from './handler';
@@ -19,7 +21,7 @@ export function createInputRulePlugin(
   pluginName: string,
   rules: InputRuleWrapper[],
   options: Options = {},
-): Plugin {
+): SafePlugin {
   const onInputEvent = options?.onInputEvent;
   const onBeforeRegexMatch = options?.onBeforeRegexMatch;
   const allowInsertTextOnDocument = Boolean(options?.allowInsertTextOnDocument);
@@ -33,7 +35,7 @@ export function createInputRulePlugin(
     onBeforeRegexMatch,
   });
 
-  const plugin: Plugin = new Plugin<InputRulePluginState>({
+  const plugin = new SafePlugin<InputRulePluginState>({
     key: pluginKey,
     state: {
       init() {