@atlaskit/prosemirror-input-rules 2.3.1 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/prosemirror-input-rules
 
+## 2.4.0
+
+### Minor Changes
+
+- [`1944b35b538`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1944b35b538) - move common utilities to editor-common, to help with decoupling block-type plugin
+
+### Patch Changes
+
+- Updated dependencies
+
+## 2.3.2
+
+### Patch Changes
+
+- [`d2ecb6bf1a3`](https://bitbucket.org/atlassian/atlassian-frontend/commits/d2ecb6bf1a3) - [ED-19203] Moved input rule types to editor-common to avoid circular dependencies
+- Updated dependencies
+
 ## 2.3.1
 
 ### Patch Changes

package/dist/cjs/utils.js

@@ -3,21 +3,18 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createRule = exports.createPlugin = void 0;
+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 _plugin = require("./plugin");
-var createRule = function createRule(match, handler) {
-  return {
-    match: match,
-    handler: handler,
-    onHandlerApply: function onHandlerApply(state, tr) {
-      (0, _history.closeHistory)(tr);
-    }
-  };
-};
-exports.createRule = createRule;
+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);

package/dist/cjs/version.json

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

package/dist/es2019/utils.js

@@ -2,15 +2,7 @@ import { GapCursorSelection } from '@atlaskit/editor-common/selection';
 import { closeHistory } from '@atlaskit/editor-prosemirror/history';
 import { TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { createInputRulePlugin } from './plugin';
-export const createRule = (match, handler) => {
-  return {
-    match,
-    handler,
-    onHandlerApply: (state, tr) => {
-      closeHistory(tr);
-    }
-  };
-};
+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);

package/dist/es2019/version.json

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

package/dist/esm/utils.js

@@ -2,15 +2,7 @@ import { GapCursorSelection } from '@atlaskit/editor-common/selection';
 import { closeHistory } from '@atlaskit/editor-prosemirror/history';
 import { TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { createInputRulePlugin } from './plugin';
-export var createRule = function createRule(match, handler) {
-  return {
-    match: match,
-    handler: handler,
-    onHandlerApply: function onHandlerApply(state, tr) {
-      closeHistory(tr);
-    }
-  };
-};
+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);

package/dist/esm/version.json

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

package/dist/types/index.d.ts

@@ -1,5 +1,18 @@
-import type { InputRuleHandler, InputRuleWrapper, OnHandlerApply, OnInputEvent } from './types';
+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 { InputRuleWrapper, InputRuleHandler, OnInputEvent, OnHandlerApply, };
+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';

package/dist/types/types.d.ts

@@ -1,6 +1,6 @@
+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';
-export type InputRuleHandler = (state: EditorState, matchResult: RegExpExecArray, start: number, end: number) => Transaction | null;
 export type HandleInputEvent = (props: {
     view: EditorView;
     from: number;
@@ -13,12 +13,6 @@ export type InputRulePluginState = {
     to: number;
     textInserted: string;
 } | null;
-export type OnHandlerApply = (state: EditorState, tr: Transaction, matchResult: RegExpExecArray) => void;
-export interface InputRuleWrapper {
-    match: RegExp;
-    handler: InputRuleHandler;
-    onHandlerApply?: OnHandlerApply;
-}
 export type MatchedRule = InputRuleWrapper & {
     result: RegExpExecArray;
 };
@@ -28,3 +22,16 @@ 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,9 +1,8 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { InputRuleHandler, InputRuleWrapper } from './types';
-export declare const createRule: (match: RegExp, handler: InputRuleHandler) => InputRuleWrapper;
+import type { InputRuleWrapper } from '@atlaskit/editor-common/types';
+export { createRule } from '@atlaskit/editor-common/utils';
 type Options = {
     isBlockNodeRule?: boolean;
     allowInsertTextOnDocument?: boolean;
 };
 export declare const createPlugin: (pluginName: string, rules: Array<InputRuleWrapper>, options?: Options) => SafePlugin;
-export {};

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

@@ -1,5 +1,18 @@
-import type { InputRuleHandler, InputRuleWrapper, OnHandlerApply, OnInputEvent } from './types';
+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 { InputRuleWrapper, InputRuleHandler, OnInputEvent, OnHandlerApply, };
+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';

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

@@ -1,6 +1,6 @@
+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';
-export type InputRuleHandler = (state: EditorState, matchResult: RegExpExecArray, start: number, end: number) => Transaction | null;
 export type HandleInputEvent = (props: {
     view: EditorView;
     from: number;
@@ -13,12 +13,6 @@ export type InputRulePluginState = {
     to: number;
     textInserted: string;
 } | null;
-export type OnHandlerApply = (state: EditorState, tr: Transaction, matchResult: RegExpExecArray) => void;
-export interface InputRuleWrapper {
-    match: RegExp;
-    handler: InputRuleHandler;
-    onHandlerApply?: OnHandlerApply;
-}
 export type MatchedRule = InputRuleWrapper & {
     result: RegExpExecArray;
 };
@@ -28,3 +22,16 @@ 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,9 +1,8 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { InputRuleHandler, InputRuleWrapper } from './types';
-export declare const createRule: (match: RegExp, handler: InputRuleHandler) => InputRuleWrapper;
+import type { InputRuleWrapper } from '@atlaskit/editor-common/types';
+export { createRule } from '@atlaskit/editor-common/utils';
 type Options = {
     isBlockNodeRule?: boolean;
     allowInsertTextOnDocument?: boolean;
 };
 export declare const createPlugin: (pluginName: string, rules: Array<InputRuleWrapper>, options?: Options) => SafePlugin;
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/prosemirror-input-rules",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "A package that contains helpers to create autoformatting rules for ProseMirror",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -28,7 +28,7 @@
     "releaseModel": "continuous"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^74.29.0",
+    "@atlaskit/editor-common": "^74.34.0",
     "@atlaskit/editor-prosemirror": "1.0.2",
     "@babel/runtime": "^7.0.0"
   },

package/report.api.md

@@ -15,7 +15,11 @@
 <!--SECTION START: Main Entry Types-->
 
 ```ts
+import { createRule } from '@atlaskit/editor-common/utils';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { InputRuleHandler } from '@atlaskit/editor-common/types';
+import type { InputRuleWrapper } from '@atlaskit/editor-common/types';
+import type { OnHandlerApply } from '@atlaskit/editor-common/types';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 
@@ -33,29 +37,11 @@ export const createPlugin: (
   options?: Options_2,
 ) => SafePlugin;
 
-// @public (undocumented)
-export const createRule: (
-  match: RegExp,
-  handler: InputRuleHandler,
-) => InputRuleWrapper;
+export { createRule };
 
-// @public (undocumented)
-export type InputRuleHandler = (
-  state: EditorState,
-  matchResult: RegExpExecArray,
-  start: number,
-  end: number,
-) => Transaction | null;
+export { InputRuleHandler };
 
-// @public (undocumented)
-export interface InputRuleWrapper {
-  // (undocumented)
-  handler: InputRuleHandler;
-  // (undocumented)
-  match: RegExp;
-  // (undocumented)
-  onHandlerApply?: OnHandlerApply;
-}
+export { InputRuleWrapper };
 
 // @public (undocumented)
 export const leafNodeReplacementCharacter = '\uFFFC';
@@ -66,12 +52,7 @@ export const MAX_REGEX_MATCH = 500;
 // @public (undocumented)
 type OnBeforeRegexMatch = (tr: Transaction) => void;
 
-// @public (undocumented)
-export type OnHandlerApply = (
-  state: EditorState,
-  tr: Transaction,
-  matchResult: RegExpExecArray,
-) => void;
+export { OnHandlerApply };
 
 // @public (undocumented)
 export type OnInputEvent = (props: {

package/src/index.ts

@@ -2,8 +2,9 @@ import type {
   InputRuleHandler,
   InputRuleWrapper,
   OnHandlerApply,
-  OnInputEvent,
-} from './types';
+} from '@atlaskit/editor-common/types';
+
+import type { OnInputEvent } from './types';
 
 export {
   leafNodeReplacementCharacter,
@@ -12,9 +13,18 @@ export {
 } 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,
 };
 

package/src/types.ts

@@ -1,16 +1,14 @@
+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';
 
-export type InputRuleHandler = (
-  state: EditorState,
-  matchResult: RegExpExecArray,
-  start: number,
-  end: number,
-) => Transaction | null;
-
 export type HandleInputEvent = (props: {
   view: EditorView;
   from: number;
@@ -25,18 +23,6 @@ export type InputRulePluginState = {
   textInserted: string;
 } | null;
 
-export type OnHandlerApply = (
-  state: EditorState,
-  tr: Transaction,
-  matchResult: RegExpExecArray,
-) => void;
-
-export interface InputRuleWrapper {
-  match: RegExp;
-  handler: InputRuleHandler;
-  onHandlerApply?: OnHandlerApply;
-}
-
 export type MatchedRule = InputRuleWrapper & {
   result: RegExpExecArray;
 };
@@ -48,3 +34,18 @@ 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,24 +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 { createInputRulePlugin } from './plugin';
-import type { InputRuleHandler, InputRuleWrapper, OnInputEvent } from './types';
+import type { OnInputEvent } from './types';
 
-export const createRule = (
-  match: RegExp,
-  handler: InputRuleHandler,
-): InputRuleWrapper => {
-  return {
-    match,
-    handler,
-    onHandlerApply: (state, tr) => {
-      closeHistory(tr);
-    },
-  };
-};
+export { createRule } from '@atlaskit/editor-common/utils';
 
 const hasUnsupportedMarks = (
   state: EditorState,

package/tmp/api-report-tmp.d.ts

@@ -4,7 +4,11 @@
 
 ```ts
 
+import { createRule } from '@atlaskit/editor-common/utils';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { InputRuleHandler } from '@atlaskit/editor-common/types';
+import type { InputRuleWrapper } from '@atlaskit/editor-common/types';
+import type { OnHandlerApply } from '@atlaskit/editor-common/types';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 
@@ -14,21 +18,11 @@ export function createInputRulePlugin(pluginName: string, rules: InputRuleWrappe
 // @public (undocumented)
 export const createPlugin: (pluginName: string, rules: Array<InputRuleWrapper>, options?: Options_2) => SafePlugin;
 
-// @public (undocumented)
-export const createRule: (match: RegExp, handler: InputRuleHandler) => InputRuleWrapper;
+export { createRule }
 
-// @public (undocumented)
-export type InputRuleHandler = (state: EditorState, matchResult: RegExpExecArray, start: number, end: number) => Transaction | null;
+export { InputRuleHandler }
 
-// @public (undocumented)
-export interface InputRuleWrapper {
-    // (undocumented)
-    handler: InputRuleHandler;
-    // (undocumented)
-    match: RegExp;
-    // (undocumented)
-    onHandlerApply?: OnHandlerApply;
-}
+export { InputRuleWrapper }
 
 // @public (undocumented)
 export const leafNodeReplacementCharacter = "\uFFFC";
@@ -39,8 +33,7 @@ export const MAX_REGEX_MATCH = 500;
 // @public (undocumented)
 type OnBeforeRegexMatch = (tr: Transaction) => void;
 
-// @public (undocumented)
-export type OnHandlerApply = (state: EditorState, tr: Transaction, matchResult: RegExpExecArray) => void;
+export { OnHandlerApply }
 
 // @public (undocumented)
 export type OnInputEvent = (props: {