@atlaskit/editor-plugin-hyperlink 1.0.1 → 1.0.2

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @atlaskit/editor-plugin-hyperlink
 
+## 1.0.2
+
+### 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
+
 ## 1.0.1
 
 ### Patch Changes

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

@@ -10,12 +10,13 @@ exports.default = void 0;
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _card = require("@atlaskit/editor-common/card");
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _utils = require("@atlaskit/editor-common/utils");
 var _prosemirrorInputRules = require("@atlaskit/prosemirror-input-rules");
 var _toolbarButtons = require("./toolbar-buttons");
 function createLinkInputRule(regexp, editorAnalyticsApi) {
   // Plain typed text (eg, typing 'www.google.com') should convert to a hyperlink
-  return (0, _prosemirrorInputRules.createRule)(regexp, function (state, match, start, end) {
+  return (0, _utils.createRule)(regexp, function (state, match, start, end) {
     var _toolbarKey$getState$, _toolbarKey$getState;
     var schema = state.schema;
     if (state.doc.rangeHasMark(start, end, schema.marks.link)) {
@@ -67,7 +68,7 @@ function createInputRulePlugin(schema, editorAnalyticsApi) {
   var urlWithASpaceRule = createLinkInputRule(_utils.LinkMatcher.create(), editorAnalyticsApi);
 
   // [something](link) should convert to a hyperlink
-  var markdownLinkRule = (0, _prosemirrorInputRules.createRule)(/(^|[^!])\[(.*?)\]\((\S+)\)$/, function (state, match, start, end) {
+  var markdownLinkRule = (0, _utils.createRule)(/(^|[^!])\[(.*?)\]\((\S+)\)$/, function (state, match, start, end) {
     var _toolbarKey$getState$2, _toolbarKey$getState2;
     var schema = state.schema;
     var _match = (0, _slicedToArray2.default)(match, 4),
@@ -89,6 +90,6 @@ function createInputRulePlugin(schema, editorAnalyticsApi) {
     editorAnalyticsApi === null || editorAnalyticsApi === void 0 || editorAnalyticsApi.attachAnalyticsEvent((0, _utils.getLinkCreationAnalyticsEvent)(_analytics.INPUT_METHOD.FORMATTING, url))(tr);
     return tr;
   });
-  return (0, _prosemirrorInputRules.createPlugin)('hyperlink', [urlWithASpaceRule, markdownLinkRule]);
+  return new _safePlugin.SafePlugin((0, _prosemirrorInputRules.createPlugin)('hyperlink', [urlWithASpaceRule, markdownLinkRule]));
 }
 var _default = exports.default = createInputRulePlugin;

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

@@ -1,7 +1,8 @@
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { addLinkMetadata } from '@atlaskit/editor-common/card';
-import { findFilepaths, getLinkCreationAnalyticsEvent, isLinkInMatches, LinkMatcher, normalizeUrl } from '@atlaskit/editor-common/utils';
-import { createPlugin, createRule } from '@atlaskit/prosemirror-input-rules';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { createRule, findFilepaths, getLinkCreationAnalyticsEvent, isLinkInMatches, LinkMatcher, normalizeUrl } from '@atlaskit/editor-common/utils';
+import { createPlugin } from '@atlaskit/prosemirror-input-rules';
 import { toolbarKey } from './toolbar-buttons';
 export function createLinkInputRule(regexp, editorAnalyticsApi) {
   // Plain typed text (eg, typing 'www.google.com') should convert to a hyperlink
@@ -80,6 +81,6 @@ export function createInputRulePlugin(schema, editorAnalyticsApi) {
     editorAnalyticsApi === null || editorAnalyticsApi === void 0 ? void 0 : editorAnalyticsApi.attachAnalyticsEvent(getLinkCreationAnalyticsEvent(INPUT_METHOD.FORMATTING, url))(tr);
     return tr;
   });
-  return createPlugin('hyperlink', [urlWithASpaceRule, markdownLinkRule]);
+  return new SafePlugin(createPlugin('hyperlink', [urlWithASpaceRule, markdownLinkRule]));
 }
 export default createInputRulePlugin;

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

@@ -1,8 +1,9 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { addLinkMetadata } from '@atlaskit/editor-common/card';
-import { findFilepaths, getLinkCreationAnalyticsEvent, isLinkInMatches, LinkMatcher, normalizeUrl } from '@atlaskit/editor-common/utils';
-import { createPlugin, createRule } from '@atlaskit/prosemirror-input-rules';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { createRule, findFilepaths, getLinkCreationAnalyticsEvent, isLinkInMatches, LinkMatcher, normalizeUrl } from '@atlaskit/editor-common/utils';
+import { createPlugin } from '@atlaskit/prosemirror-input-rules';
 import { toolbarKey } from './toolbar-buttons';
 export function createLinkInputRule(regexp, editorAnalyticsApi) {
   // Plain typed text (eg, typing 'www.google.com') should convert to a hyperlink
@@ -80,6 +81,6 @@ export function createInputRulePlugin(schema, editorAnalyticsApi) {
     editorAnalyticsApi === null || editorAnalyticsApi === void 0 || editorAnalyticsApi.attachAnalyticsEvent(getLinkCreationAnalyticsEvent(INPUT_METHOD.FORMATTING, url))(tr);
     return tr;
   });
-  return createPlugin('hyperlink', [urlWithASpaceRule, markdownLinkRule]);
+  return new SafePlugin(createPlugin('hyperlink', [urlWithASpaceRule, markdownLinkRule]));
 }
 export default createInputRulePlugin;

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

@@ -1,7 +1,7 @@
 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 { InputRuleWrapper } from '@atlaskit/editor-common/types';
 import type { Schema } from '@atlaskit/editor-prosemirror/model';
-import type { InputRuleWrapper } from '@atlaskit/prosemirror-input-rules';
 export declare function createLinkInputRule(regexp: RegExp, editorAnalyticsApi: EditorAnalyticsAPI | undefined): InputRuleWrapper;
 export declare function createInputRulePlugin(schema: Schema, editorAnalyticsApi: EditorAnalyticsAPI | undefined): SafePlugin | undefined;
 export default createInputRulePlugin;

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

@@ -1,7 +1,7 @@
 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 { InputRuleWrapper } from '@atlaskit/editor-common/types';
 import type { Schema } from '@atlaskit/editor-prosemirror/model';
-import type { InputRuleWrapper } from '@atlaskit/prosemirror-input-rules';
 export declare function createLinkInputRule(regexp: RegExp, editorAnalyticsApi: EditorAnalyticsAPI | undefined): InputRuleWrapper;
 export declare function createInputRulePlugin(schema: Schema, editorAnalyticsApi: EditorAnalyticsAPI | undefined): SafePlugin | undefined;
 export default createInputRulePlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-hyperlink",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Hyperlink plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -34,11 +34,11 @@
   "dependencies": {
     "@atlaskit/adf-schema": "^35.5.1",
     "@atlaskit/analytics-next": "^9.2.0",
-    "@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/icon": "^22.0.0",
-    "@atlaskit/prosemirror-input-rules": "^2.4.0",
+    "@atlaskit/icon": "^22.1.0",
+    "@atlaskit/prosemirror-input-rules": "^3.0.0",
     "@babel/runtime": "^7.0.0",
     "uuid": "^3.1.0"
   },