@atlaskit/editor-plugin-block-type 3.0.24 → 3.0.25

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @atlaskit/editor-plugin-block-type
 
+## 3.0.25
+
+### Patch 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
+
+- Updated dependencies
+
 ## 3.0.24
 
 ### Patch Changes

package/dist/cjs/plugin/pm-plugins/input-rule.js

@@ -8,6 +8,7 @@ exports.default = void 0;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _commands = require("@atlaskit/editor-common/commands");
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _utils = require("@atlaskit/editor-common/utils");
 var _prosemirrorInputRules = require("@atlaskit/prosemirror-input-rules");
 var _utils2 = require("../utils");
@@ -37,7 +38,7 @@ function blockQuoteRule(nodeType) {
 function getHeadingRules(editorAnalyticsAPI, schema) {
   // '# ' for h1, '## ' for h2 and etc
   var hashRule = headingRule(schema.nodes.heading, MAX_HEADING_LEVEL);
-  var leftNodeReplacementHashRule = (0, _prosemirrorInputRules.createRule)(new RegExp("".concat(_prosemirrorInputRules.leafNodeReplacementCharacter, "(#{1,6})\\s$")), function (state, match, start, end) {
+  var leftNodeReplacementHashRule = (0, _utils.createRule)(new RegExp("".concat(_prosemirrorInputRules.leafNodeReplacementCharacter, "(#{1,6})\\s$")), function (state, match, start, end) {
     var level = match[1].length;
     return (0, _commands.insertBlock)(state, schema.nodes.heading, start, end, {
       level: level
@@ -69,7 +70,7 @@ function getHeadingRules(editorAnalyticsAPI, schema) {
 function getBlockQuoteRules(editorAnalyticsAPI, schema) {
   // '> ' for blockquote
   var greatherThanRule = blockQuoteRule(schema.nodes.blockquote);
-  var leftNodeReplacementGreatherRule = (0, _prosemirrorInputRules.createRule)(new RegExp("".concat(_prosemirrorInputRules.leafNodeReplacementCharacter, "\\s*>\\s$")), function (state, _match, start, end) {
+  var leftNodeReplacementGreatherRule = (0, _utils.createRule)(new RegExp("".concat(_prosemirrorInputRules.leafNodeReplacementCharacter, "\\s*>\\s$")), function (state, _match, start, end) {
     return (0, _commands.insertBlock)(state, schema.nodes.blockquote, start, end);
   });
 
@@ -94,9 +95,9 @@ function inputRulePlugin(editorAnalyticsAPI, schema, featureFlags) {
     rules.push.apply(rules, (0, _toConsumableArray2.default)(getBlockQuoteRules(editorAnalyticsAPI, schema)));
   }
   if (rules.length !== 0) {
-    return (0, _prosemirrorInputRules.createPlugin)('block-type', rules, {
+    return new _safePlugin.SafePlugin((0, _prosemirrorInputRules.createPlugin)('block-type', rules, {
       isBlockNodeRule: true
-    });
+    }));
   }
   return;
 }

package/dist/cjs/plugin/utils.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.areBlockTypesDisabled = areBlockTypesDisabled;
 exports.isNodeAWrappingBlockNode = exports.createWrappingTextBlockRule = exports.createJoinNodesRule = void 0;
 var _utils = require("@atlaskit/editor-common/utils");
-var _prosemirrorInputRules = require("@atlaskit/prosemirror-input-rules");
 var _blockTypes = require("./block-types");
 var isNodeAWrappingBlockNode = exports.isNodeAWrappingBlockNode = function isNodeAWrappingBlockNode(node) {
   if (!node) {
@@ -40,7 +39,7 @@ var createWrappingTextBlockRule = exports.createWrappingTextBlockRule = function
     }
     return state.tr.delete(fixedStart, end).setBlockType(fixedStart, fixedStart, nodeType, attrs);
   };
-  return (0, _prosemirrorInputRules.createRule)(match, handler);
+  return (0, _utils.createRule)(match, handler);
 };
 
 /**

package/dist/es2019/plugin/pm-plugins/input-rule.js

@@ -1,7 +1,8 @@
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { insertBlock } from '@atlaskit/editor-common/commands';
-import { inputRuleWithAnalytics } from '@atlaskit/editor-common/utils';
-import { createPlugin, createRule, leafNodeReplacementCharacter } from '@atlaskit/prosemirror-input-rules';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { createRule, inputRuleWithAnalytics } from '@atlaskit/editor-common/utils';
+import { createPlugin, leafNodeReplacementCharacter } from '@atlaskit/prosemirror-input-rules';
 import { createJoinNodesRule, createWrappingTextBlockRule } from '../utils';
 const MAX_HEADING_LEVEL = 6;
 function getHeadingLevel(match) {
@@ -84,9 +85,9 @@ function inputRulePlugin(editorAnalyticsAPI, schema, featureFlags) {
     rules.push(...getBlockQuoteRules(editorAnalyticsAPI, schema));
   }
   if (rules.length !== 0) {
-    return createPlugin('block-type', rules, {
+    return new SafePlugin(createPlugin('block-type', rules, {
       isBlockNodeRule: true
-    });
+    }));
   }
   return;
 }

package/dist/es2019/plugin/utils.js

@@ -1,5 +1,4 @@
-import { createWrappingJoinRule } from '@atlaskit/editor-common/utils';
-import { createRule } from '@atlaskit/prosemirror-input-rules';
+import { createRule, createWrappingJoinRule } from '@atlaskit/editor-common/utils';
 import { WRAPPER_BLOCK_TYPES } from './block-types';
 export const isNodeAWrappingBlockNode = node => {
   if (!node) {

package/dist/esm/plugin/pm-plugins/input-rule.js

@@ -1,8 +1,9 @@
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { insertBlock } from '@atlaskit/editor-common/commands';
-import { inputRuleWithAnalytics } from '@atlaskit/editor-common/utils';
-import { createPlugin, createRule, leafNodeReplacementCharacter } from '@atlaskit/prosemirror-input-rules';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { createRule, inputRuleWithAnalytics } from '@atlaskit/editor-common/utils';
+import { createPlugin, leafNodeReplacementCharacter } from '@atlaskit/prosemirror-input-rules';
 import { createJoinNodesRule, createWrappingTextBlockRule } from '../utils';
 var MAX_HEADING_LEVEL = 6;
 function getHeadingLevel(match) {
@@ -87,9 +88,9 @@ function inputRulePlugin(editorAnalyticsAPI, schema, featureFlags) {
     rules.push.apply(rules, _toConsumableArray(getBlockQuoteRules(editorAnalyticsAPI, schema)));
   }
   if (rules.length !== 0) {
-    return createPlugin('block-type', rules, {
+    return new SafePlugin(createPlugin('block-type', rules, {
       isBlockNodeRule: true
-    });
+    }));
   }
   return;
 }

package/dist/esm/plugin/utils.js

@@ -1,5 +1,4 @@
-import { createWrappingJoinRule } from '@atlaskit/editor-common/utils';
-import { createRule } from '@atlaskit/prosemirror-input-rules';
+import { createRule, createWrappingJoinRule } from '@atlaskit/editor-common/utils';
 import { WRAPPER_BLOCK_TYPES } from './block-types';
 export var isNodeAWrappingBlockNode = function isNodeAWrappingBlockNode(node) {
   if (!node) {

package/dist/types/plugin/pm-plugins/input-rule.d.ts

@@ -1,5 +1,5 @@
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { FeatureFlags } from '@atlaskit/editor-common/types';
 import type { Schema } from '@atlaskit/editor-prosemirror/model';
 declare function inputRulePlugin(editorAnalyticsAPI: EditorAnalyticsAPI | undefined, schema: Schema, featureFlags: FeatureFlags): SafePlugin | undefined;

package/dist/types/plugin/utils.d.ts

@@ -1,6 +1,6 @@
+import type { InputRuleWrapper } from '@atlaskit/editor-common/types';
 import type { NodeType, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-import type { InputRuleWrapper } from '@atlaskit/prosemirror-input-rules';
 export declare const isNodeAWrappingBlockNode: (node?: PMNode | null) => boolean;
 export declare const createJoinNodesRule: (match: RegExp, nodeType: NodeType) => InputRuleWrapper;
 type WrappingTextRuleProps = {

package/dist/types-ts4.5/plugin/pm-plugins/input-rule.d.ts

@@ -1,5 +1,5 @@
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { FeatureFlags } from '@atlaskit/editor-common/types';
 import type { Schema } from '@atlaskit/editor-prosemirror/model';
 declare function inputRulePlugin(editorAnalyticsAPI: EditorAnalyticsAPI | undefined, schema: Schema, featureFlags: FeatureFlags): SafePlugin | undefined;

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

@@ -1,6 +1,6 @@
+import type { InputRuleWrapper } from '@atlaskit/editor-common/types';
 import type { NodeType, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-import type { InputRuleWrapper } from '@atlaskit/prosemirror-input-rules';
 export declare const isNodeAWrappingBlockNode: (node?: PMNode | null) => boolean;
 export declare const createJoinNodesRule: (match: RegExp, nodeType: NodeType) => InputRuleWrapper;
 type WrappingTextRuleProps = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-block-type",
-  "version": "3.0.24",
+  "version": "3.0.25",
   "description": "BlockType plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -36,16 +36,16 @@
   },
   "dependencies": {
     "@atlaskit/adf-schema": "^35.5.1",
-    "@atlaskit/editor-common": "^78.0.0",
+    "@atlaskit/editor-common": "^78.4.0",
     "@atlaskit/editor-plugin-analytics": "^1.0.0",
     "@atlaskit/editor-prosemirror": "3.0.0",
     "@atlaskit/editor-shared-styles": "^2.9.0",
     "@atlaskit/editor-tables": "^2.5.0",
-    "@atlaskit/icon": "^22.0.0",
+    "@atlaskit/icon": "^22.1.0",
     "@atlaskit/platform-feature-flags": "^0.2.5",
-    "@atlaskit/prosemirror-input-rules": "^2.4.0",
+    "@atlaskit/prosemirror-input-rules": "^3.0.0",
     "@atlaskit/theme": "^12.6.0",
-    "@atlaskit/tokens": "^1.37.0",
+    "@atlaskit/tokens": "^1.38.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1"
   },