@atlaskit/prosemirror-input-rules 2.1.1 → 2.1.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/prosemirror-input-rules
 
+## 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

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.1",
+	"version": "2.1.2",
 	"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.1",
+	"version": "2.1.2",
 	"sideEffects": false
 }

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.1",
+	"version": "2.1.2",
 	"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.1",
+  "version": "2.1.2",
   "description": "A package that contains helpers to create autoformatting rules for ProseMirror",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -19,12 +19,13 @@
     "releaseModel": "scheduled"
   },
   "dependencies": {
+    "@atlaskit/editor-common": "^64.0.0",
     "@babel/runtime": "^7.0.0",
     "prosemirror-state": "1.3.4"
   },
   "devDependencies": {
-    "@atlaskit/adf-schema": "^21.0.0",
-    "@atlaskit/editor-test-helpers": "^16.0.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",

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() {