@atlaskit/prosemirror-input-rules 2.2.4 → 2.3.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/prosemirror-input-rules
 
+## 2.3.0
+
+### Minor Changes
+
+- [`8b891bf3590`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8b891bf3590) - This change introduces `editor-plugin-hyperlink` which separates the hyperlink plugin from `editor-core`. In order to enable this change there are now new entry points on `editor-common` (such as `/link`, `/quick-insert`) in order to separate common code. Further `prosemirror-input-rules` now has new exports of `createPlugin` and `createRule` which are used in many plugins in `editor-core`.
+
+### Patch Changes
+
+- Updated dependencies
+
+## 2.2.5
+
+### Patch Changes
+
+- [`5f5ba16de66`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5f5ba16de66) - [ED-13910] Fix prosemirror types
+
 ## 2.2.4
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -21,6 +21,18 @@ Object.defineProperty(exports, "createInputRulePlugin", {
     return _plugin.createInputRulePlugin;
   }
 });
+Object.defineProperty(exports, "createPlugin", {
+  enumerable: true,
+  get: function get() {
+    return _utils.createPlugin;
+  }
+});
+Object.defineProperty(exports, "createRule", {
+  enumerable: true,
+  get: function get() {
+    return _utils.createRule;
+  }
+});
 Object.defineProperty(exports, "leafNodeReplacementCharacter", {
   enumerable: true,
   get: function get() {
@@ -28,4 +40,5 @@ Object.defineProperty(exports, "leafNodeReplacementCharacter", {
   }
 });
 var _constants = require("./constants");
-var _plugin = require("./plugin");
+var _plugin = require("./plugin");
+var _utils = require("./utils");

package/dist/cjs/utils.js

@@ -0,0 +1,67 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createRule = exports.createPlugin = void 0;
+var _prosemirrorHistory = require("prosemirror-history");
+var _prosemirrorState = require("prosemirror-state");
+var _selection = require("@atlaskit/editor-common/selection");
+var _plugin = require("./plugin");
+var createRule = function createRule(match, handler) {
+  return {
+    match: match,
+    handler: handler,
+    onHandlerApply: function onHandlerApply(state, tr) {
+      (0, _prosemirrorHistory.closeHistory)(tr);
+    }
+  };
+};
+exports.createRule = createRule;
+var hasUnsupportedMarks = function hasUnsupportedMarks(state, start, end, marksNameUnsupported) {
+  var isUnsupportedMark = function isUnsupportedMark(node) {
+    return (marksNameUnsupported || []).includes(node.type.name);
+  };
+  var $from = state.doc.resolve(start);
+  var $to = state.doc.resolve(end);
+  var marksInSelection = start === end ? $from.marks() : $from.marksAcross($to);
+  return (marksInSelection || []).some(isUnsupportedMark);
+};
+var isCursorInsideUnsupportedMarks = function isCursorInsideUnsupportedMarks(state, marksNameUnsupported) {
+  var _$cursor$nodeBefore, _$cursor$nodeBefore$m;
+  var selection = state.selection;
+  if (!(selection instanceof _prosemirrorState.TextSelection)) {
+    return false;
+  }
+  var $cursor = selection.$cursor;
+  var isUnsupportedMark = function isUnsupportedMark(node) {
+    return marksNameUnsupported.includes(node.type.name);
+  };
+  return Boolean($cursor === null || $cursor === void 0 ? void 0 : (_$cursor$nodeBefore = $cursor.nodeBefore) === null || _$cursor$nodeBefore === void 0 ? void 0 : (_$cursor$nodeBefore$m = _$cursor$nodeBefore.marks) === null || _$cursor$nodeBefore$m === void 0 ? void 0 : _$cursor$nodeBefore$m.some(isUnsupportedMark));
+};
+var createPlugin = function createPlugin(pluginName, rules) {
+  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  var _options$isBlockNodeR = options.isBlockNodeRule,
+    isBlockNodeRule = _options$isBlockNodeR === void 0 ? false : _options$isBlockNodeR,
+    _options$allowInsertT = options.allowInsertTextOnDocument,
+    allowInsertTextOnDocument = _options$allowInsertT === void 0 ? true : _options$allowInsertT;
+  var onInputEvent = function onInputEvent(_ref) {
+    var state = _ref.state,
+      from = _ref.from,
+      to = _ref.to;
+    var unsupportedMarks = isBlockNodeRule ? ['code', 'link', 'typeAheadQuery'] : ['code'];
+    var $from = state.selection.$from;
+    if ($from.parent.type.spec.code || !(state.selection instanceof _prosemirrorState.TextSelection) && !(state.selection instanceof _selection.GapCursorSelection) || hasUnsupportedMarks(state, from, to, unsupportedMarks) || isBlockNodeRule && isCursorInsideUnsupportedMarks(state, unsupportedMarks)) {
+      return false;
+    }
+    return true;
+  };
+  return (0, _plugin.createInputRulePlugin)(pluginName, rules, {
+    allowInsertTextOnDocument: allowInsertTextOnDocument,
+    onInputEvent: onInputEvent,
+    onBeforeRegexMatch: function onBeforeRegexMatch(tr) {
+      (0, _prosemirrorHistory.closeHistory)(tr);
+    }
+  });
+};
+exports.createPlugin = createPlugin;

package/dist/cjs/version.json

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

package/dist/es2019/index.js

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

package/dist/es2019/utils.js

@@ -0,0 +1,59 @@
+import { closeHistory } from 'prosemirror-history';
+import { TextSelection } from 'prosemirror-state';
+import { GapCursorSelection } from '@atlaskit/editor-common/selection';
+import { createInputRulePlugin } from './plugin';
+export const createRule = (match, handler) => {
+  return {
+    match,
+    handler,
+    onHandlerApply: (state, tr) => {
+      closeHistory(tr);
+    }
+  };
+};
+const hasUnsupportedMarks = (state, start, end, marksNameUnsupported) => {
+  const isUnsupportedMark = node => (marksNameUnsupported || []).includes(node.type.name);
+  const $from = state.doc.resolve(start);
+  const $to = state.doc.resolve(end);
+  const marksInSelection = start === end ? $from.marks() : $from.marksAcross($to);
+  return (marksInSelection || []).some(isUnsupportedMark);
+};
+const isCursorInsideUnsupportedMarks = (state, marksNameUnsupported) => {
+  var _$cursor$nodeBefore, _$cursor$nodeBefore$m;
+  const {
+    selection
+  } = state;
+  if (!(selection instanceof TextSelection)) {
+    return false;
+  }
+  const {
+    $cursor
+  } = selection;
+  const isUnsupportedMark = node => marksNameUnsupported.includes(node.type.name);
+  return Boolean($cursor === null || $cursor === void 0 ? void 0 : (_$cursor$nodeBefore = $cursor.nodeBefore) === null || _$cursor$nodeBefore === void 0 ? void 0 : (_$cursor$nodeBefore$m = _$cursor$nodeBefore.marks) === null || _$cursor$nodeBefore$m === void 0 ? void 0 : _$cursor$nodeBefore$m.some(isUnsupportedMark));
+};
+export const createPlugin = (pluginName, rules, options = {}) => {
+  const {
+    isBlockNodeRule = false,
+    allowInsertTextOnDocument = true
+  } = options;
+  const onInputEvent = ({
+    state,
+    from,
+    to
+  }) => {
+    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)) {
+      return false;
+    }
+    return true;
+  };
+  return createInputRulePlugin(pluginName, rules, {
+    allowInsertTextOnDocument,
+    onInputEvent,
+    onBeforeRegexMatch: tr => {
+      closeHistory(tr);
+    }
+  });
+};

package/dist/es2019/version.json

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

package/dist/esm/index.js

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

package/dist/esm/utils.js

@@ -0,0 +1,59 @@
+import { closeHistory } from 'prosemirror-history';
+import { TextSelection } from 'prosemirror-state';
+import { GapCursorSelection } from '@atlaskit/editor-common/selection';
+import { createInputRulePlugin } from './plugin';
+export var createRule = function createRule(match, handler) {
+  return {
+    match: match,
+    handler: handler,
+    onHandlerApply: function onHandlerApply(state, tr) {
+      closeHistory(tr);
+    }
+  };
+};
+var hasUnsupportedMarks = function hasUnsupportedMarks(state, start, end, marksNameUnsupported) {
+  var isUnsupportedMark = function isUnsupportedMark(node) {
+    return (marksNameUnsupported || []).includes(node.type.name);
+  };
+  var $from = state.doc.resolve(start);
+  var $to = state.doc.resolve(end);
+  var marksInSelection = start === end ? $from.marks() : $from.marksAcross($to);
+  return (marksInSelection || []).some(isUnsupportedMark);
+};
+var isCursorInsideUnsupportedMarks = function isCursorInsideUnsupportedMarks(state, marksNameUnsupported) {
+  var _$cursor$nodeBefore, _$cursor$nodeBefore$m;
+  var selection = state.selection;
+  if (!(selection instanceof TextSelection)) {
+    return false;
+  }
+  var $cursor = selection.$cursor;
+  var isUnsupportedMark = function isUnsupportedMark(node) {
+    return marksNameUnsupported.includes(node.type.name);
+  };
+  return Boolean($cursor === null || $cursor === void 0 ? void 0 : (_$cursor$nodeBefore = $cursor.nodeBefore) === null || _$cursor$nodeBefore === void 0 ? void 0 : (_$cursor$nodeBefore$m = _$cursor$nodeBefore.marks) === null || _$cursor$nodeBefore$m === void 0 ? void 0 : _$cursor$nodeBefore$m.some(isUnsupportedMark));
+};
+export var createPlugin = function createPlugin(pluginName, rules) {
+  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  var _options$isBlockNodeR = options.isBlockNodeRule,
+    isBlockNodeRule = _options$isBlockNodeR === void 0 ? false : _options$isBlockNodeR,
+    _options$allowInsertT = options.allowInsertTextOnDocument,
+    allowInsertTextOnDocument = _options$allowInsertT === void 0 ? true : _options$allowInsertT;
+  var onInputEvent = function onInputEvent(_ref) {
+    var state = _ref.state,
+      from = _ref.from,
+      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)) {
+      return false;
+    }
+    return true;
+  };
+  return createInputRulePlugin(pluginName, rules, {
+    allowInsertTextOnDocument: allowInsertTextOnDocument,
+    onInputEvent: onInputEvent,
+    onBeforeRegexMatch: function onBeforeRegexMatch(tr) {
+      closeHistory(tr);
+    }
+  });
+};

package/dist/esm/version.json

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

package/dist/types/index.d.ts

@@ -2,3 +2,4 @@ import type { InputRuleHandler, InputRuleWrapper, OnHandlerApply, OnInputEvent }
 export { leafNodeReplacementCharacter, TEXT_INPUT_RULE_TRANSACTION_KEY, MAX_REGEX_MATCH, } from './constants';
 export { createInputRulePlugin } from './plugin';
 export type { InputRuleWrapper, InputRuleHandler, OnInputEvent, OnHandlerApply, };
+export { createRule, createPlugin } from './utils';

package/dist/types/utils.d.ts

@@ -0,0 +1,9 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { InputRuleHandler, InputRuleWrapper } from './types';
+export declare const createRule: (match: RegExp, handler: InputRuleHandler) => InputRuleWrapper;
+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

@@ -2,3 +2,4 @@ import type { InputRuleHandler, InputRuleWrapper, OnHandlerApply, OnInputEvent }
 export { leafNodeReplacementCharacter, TEXT_INPUT_RULE_TRANSACTION_KEY, MAX_REGEX_MATCH, } from './constants';
 export { createInputRulePlugin } from './plugin';
 export type { InputRuleWrapper, InputRuleHandler, OnInputEvent, OnHandlerApply, };
+export { createRule, createPlugin } from './utils';

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

@@ -0,0 +1,9 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { InputRuleHandler, InputRuleWrapper } from './types';
+export declare const createRule: (match: RegExp, handler: InputRuleHandler) => InputRuleWrapper;
+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.2.4",
+  "version": "2.3.0",
   "description": "A package that contains helpers to create autoformatting rules for ProseMirror",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -28,17 +28,15 @@
     "releaseModel": "continuous"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^74.9.0",
+    "@atlaskit/editor-common": "^74.20.0",
     "@babel/runtime": "^7.0.0",
+    "prosemirror-history": "^1.1.3",
+    "prosemirror-model": "1.16.0",
     "prosemirror-state": "1.3.4"
   },
   "devDependencies": {
-    "@atlaskit/editor-test-helpers": "^18.7.0",
+    "@atlaskit/editor-test-helpers": "^18.10.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.7"
   },
   "techstack": {

package/report.api.md

@@ -26,6 +26,19 @@ export function createInputRulePlugin(
   options?: Options,
 ): SafePlugin;
 
+// @public (undocumented)
+export const createPlugin: (
+  pluginName: string,
+  rules: Array<InputRuleWrapper>,
+  options?: Options_2,
+) => SafePlugin;
+
+// @public (undocumented)
+export const createRule: (
+  match: RegExp,
+  handler: InputRuleHandler,
+) => InputRuleWrapper;
+
 // @public (undocumented)
 export type InputRuleHandler = (
   state: EditorState,
@@ -74,6 +87,12 @@ type Options = {
   onBeforeRegexMatch?: OnBeforeRegexMatch;
 };
 
+// @public (undocumented)
+type Options_2 = {
+  isBlockNodeRule?: boolean;
+  allowInsertTextOnDocument?: boolean;
+};
+
 // @public (undocumented)
 export const TEXT_INPUT_RULE_TRANSACTION_KEY = 'input_rule_plugin_transaction';
 

package/src/__tests__/unit/handler.ts

@@ -27,7 +27,7 @@ describe('input-tule/handles/createInputEventHandler', () => {
 
   beforeEach(() => {
     initialEditorState = createEditorState(doc(p('before{<>}')));
-    editorView = new EditorView(undefined, {
+    editorView = new EditorView(null, {
       state: initialEditorState,
     });
 
@@ -52,7 +52,7 @@ describe('input-tule/handles/createInputEventHandler', () => {
     let inputHandleResult: boolean;
     beforeEach(() => {
       const newEditorState = createEditorState(doc(code_block()('before{<>}')));
-      editorView = new EditorView(undefined, {
+      editorView = new EditorView(null, {
         state: newEditorState,
       });
 

package/src/index.ts

@@ -17,3 +17,5 @@ export type {
   OnInputEvent,
   OnHandlerApply,
 };
+
+export { createRule, createPlugin } from './utils';

package/src/utils.ts

@@ -0,0 +1,95 @@
+import { closeHistory } from 'prosemirror-history';
+import { Mark as PMMark } from 'prosemirror-model';
+import { EditorState, TextSelection } from 'prosemirror-state';
+
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { GapCursorSelection } from '@atlaskit/editor-common/selection';
+
+import { createInputRulePlugin } from './plugin';
+import type { InputRuleHandler, InputRuleWrapper, OnInputEvent } from './types';
+
+export const createRule = (
+  match: RegExp,
+  handler: InputRuleHandler,
+): InputRuleWrapper => {
+  return {
+    match,
+    handler,
+    onHandlerApply: (state, tr) => {
+      closeHistory(tr);
+    },
+  };
+};
+
+const hasUnsupportedMarks = (
+  state: EditorState,
+  start: number,
+  end: number,
+  marksNameUnsupported: string[],
+) => {
+  const isUnsupportedMark = (node: PMMark) =>
+    (marksNameUnsupported || []).includes(node.type.name);
+
+  const $from = state.doc.resolve(start);
+  const $to = state.doc.resolve(end);
+  const marksInSelection =
+    start === end ? $from.marks() : $from.marksAcross($to);
+
+  return (marksInSelection || []).some(isUnsupportedMark);
+};
+
+const isCursorInsideUnsupportedMarks = (
+  state: EditorState,
+  marksNameUnsupported: string[],
+): boolean => {
+  const { selection } = state;
+  if (!(selection instanceof TextSelection)) {
+    return false;
+  }
+  const { $cursor } = selection;
+  const isUnsupportedMark = (node: PMMark) =>
+    marksNameUnsupported.includes(node.type.name);
+
+  return Boolean($cursor?.nodeBefore?.marks?.some(isUnsupportedMark));
+};
+
+type Options = {
+  isBlockNodeRule?: boolean;
+  allowInsertTextOnDocument?: boolean;
+};
+export const createPlugin = (
+  pluginName: string,
+  rules: Array<InputRuleWrapper>,
+  options: Options = {},
+): SafePlugin => {
+  const { isBlockNodeRule = false, allowInsertTextOnDocument = true } = options;
+
+  const onInputEvent: OnInputEvent = ({ state, from, to }) => {
+    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))
+    ) {
+      return false;
+    }
+
+    return true;
+  };
+
+  return createInputRulePlugin(pluginName, rules, {
+    allowInsertTextOnDocument,
+    onInputEvent,
+    onBeforeRegexMatch: (tr) => {
+      closeHistory(tr);
+    },
+  });
+};

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

@@ -1,58 +0,0 @@
-## API Report File for "@atlaskit/prosemirror-input-rules"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import type { EditorState } from 'prosemirror-state';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { Transaction } from 'prosemirror-state';
-
-// @public (undocumented)
-export function createInputRulePlugin(pluginName: string, rules: InputRuleWrapper[], options?: Options): SafePlugin;
-
-// @public (undocumented)
-export type InputRuleHandler = (state: EditorState, matchResult: RegExpExecArray, start: number, end: number) => Transaction | null;
-
-// @public (undocumented)
-export interface InputRuleWrapper {
-    // (undocumented)
-    handler: InputRuleHandler;
-    // (undocumented)
-    match: RegExp;
-    // (undocumented)
-    onHandlerApply?: OnHandlerApply;
-}
-
-// @public (undocumented)
-export const leafNodeReplacementCharacter = "\uFFFC";
-
-// @public (undocumented)
-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;
-
-// @public (undocumented)
-export type OnInputEvent = (props: {
-    state: EditorState;
-    from: number;
-    to: number;
-}) => boolean;
-
-// @public (undocumented)
-type Options = {
-    allowInsertTextOnDocument?: boolean;
-    onInputEvent?: OnInputEvent;
-    onBeforeRegexMatch?: OnBeforeRegexMatch;
-};
-
-// @public (undocumented)
-export const TEXT_INPUT_RULE_TRANSACTION_KEY = "input_rule_plugin_transaction";
-
-// (No @packageDocumentation comment for this package)
-
-```