@atlaskit/editor-plugin-hyperlink 1.3.1 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/editor-plugin-hyperlink
 
+## 1.4.0
+
+### Minor Changes
+
+- [#84430](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/84430) [`2981b2835973`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/2981b2835973) - [ux] EDM-9111 Prevent linkification of links with suspicious tlds
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 1.3.1
 
 ### Patch Changes

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

@@ -12,8 +12,12 @@ 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 _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _prosemirrorInputRules = require("@atlaskit/prosemirror-input-rules");
 var _toolbarButtons = require("./toolbar-buttons");
+/**
+ * Called when space after link, but not on enter
+ */
 function createLinkInputRule(regexp, editorAnalyticsApi) {
   // Plain typed text (eg, typing 'www.google.com') should convert to a hyperlink
   return (0, _utils.createRule)(regexp, function (state, match, start, end) {
@@ -23,7 +27,27 @@ function createLinkInputRule(regexp, editorAnalyticsApi) {
       return null;
     }
     var link = match;
-    var url = (0, _utils.normalizeUrl)(link.url);
+    var url;
+    if ((0, _platformFeatureFlags.getBooleanFF)('platform.linking-platform.prevent-suspicious-linkification')) {
+      // Property 'url' does not exist on type 'RegExpExecArray', the type of `match`.
+      // This check is in case the match is not a Linkify match, which has a url property.
+      if (link.url === undefined) {
+        return null;
+      }
+      if (!(0, _utils.shouldAutoLinkifyMatch)(link)) {
+        return null;
+      }
+      url = (0, _utils.normalizeUrl)(link.url);
+
+      // Not previously handled; don't create a link if the URL is empty.
+      // This will only happen if the `regexp` matches more links than the normalizeUrl validation;
+      // if they both use the same linkify instance this shouldn't happen.
+      if (url === '') {
+        return null;
+      }
+    } else {
+      url = (0, _utils.normalizeUrl)(link.url);
+    }
     var markType = schema.mark('link', {
       href: url
     });
@@ -74,6 +98,10 @@ function createInputRulePlugin(schema, editorAnalyticsApi) {
       prefix = _match[1],
       linkText = _match[2],
       linkUrl = _match[3];
+
+    // We don't filter this match here by shouldAutoLinkifyMatch
+    // because the intent of creating a link is clear
+
     var url = (0, _utils.normalizeUrl)(linkUrl).trim();
     var markType = schema.mark('link', {
       href: url

package/dist/cjs/pm-plugins/keymap.js

@@ -11,6 +11,7 @@ var _card = require("@atlaskit/editor-common/card");
 var _keymaps = require("@atlaskit/editor-common/keymaps");
 var _utils = require("@atlaskit/editor-common/utils");
 var _keymap = require("@atlaskit/editor-prosemirror/keymap");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _commands = require("../commands");
 var _main = require("../pm-plugins/main");
 var _toolbarButtons = require("./toolbar-buttons");
@@ -32,6 +33,10 @@ function createKeymapPlugin(editorAnalyticsApi) {
   }, list);
   return (0, _keymap.keymap)(list);
 }
+
+/**
+ * Convert the last word before the selection to a hyperlink if it's a valid URL with a tld we want to linkify
+ */
 var mayConvertLastWordToHyperlink = function mayConvertLastWordToHyperlink(editorAnalyticsApi) {
   return function (state, dispatch) {
     var _toolbarKey$getState$, _toolbarKey$getState;
@@ -44,6 +49,11 @@ var mayConvertLastWordToHyperlink = function mayConvertLastWordToHyperlink(edito
     var lastWord = words[words.length - 1];
     var match = (0, _adfSchema.getLinkMatch)(lastWord);
     if (match) {
+      if ((0, _platformFeatureFlags.getBooleanFF)('platform.linking-platform.prevent-suspicious-linkification')) {
+        if (!(0, _utils.shouldAutoLinkifyMatch)(match)) {
+          return false;
+        }
+      }
       var hyperlinkedText = match.raw;
       var start = state.selection.$from.pos - hyperlinkedText.length;
       var end = state.selection.$from.pos;

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

@@ -1,9 +1,14 @@
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { addLinkMetadata } from '@atlaskit/editor-common/card';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { createRule, findFilepaths, getLinkCreationAnalyticsEvent, isLinkInMatches, LinkMatcher, normalizeUrl } from '@atlaskit/editor-common/utils';
+import { createRule, findFilepaths, getLinkCreationAnalyticsEvent, isLinkInMatches, LinkMatcher, normalizeUrl, shouldAutoLinkifyMatch } from '@atlaskit/editor-common/utils';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import { createPlugin } from '@atlaskit/prosemirror-input-rules';
 import { toolbarKey } from './toolbar-buttons';
+
+/**
+ * Called when space after link, but not on enter
+ */
 export function createLinkInputRule(regexp, editorAnalyticsApi) {
   // Plain typed text (eg, typing 'www.google.com') should convert to a hyperlink
   return createRule(regexp, (state, match, start, end) => {
@@ -15,7 +20,27 @@ export function createLinkInputRule(regexp, editorAnalyticsApi) {
       return null;
     }
     const link = match;
-    const url = normalizeUrl(link.url);
+    let url;
+    if (getBooleanFF('platform.linking-platform.prevent-suspicious-linkification')) {
+      // Property 'url' does not exist on type 'RegExpExecArray', the type of `match`.
+      // This check is in case the match is not a Linkify match, which has a url property.
+      if (link.url === undefined) {
+        return null;
+      }
+      if (!shouldAutoLinkifyMatch(link)) {
+        return null;
+      }
+      url = normalizeUrl(link.url);
+
+      // Not previously handled; don't create a link if the URL is empty.
+      // This will only happen if the `regexp` matches more links than the normalizeUrl validation;
+      // if they both use the same linkify instance this shouldn't happen.
+      if (url === '') {
+        return null;
+      }
+    } else {
+      url = normalizeUrl(link.url);
+    }
     const markType = schema.mark('link', {
       href: url
     });
@@ -65,6 +90,10 @@ export function createInputRulePlugin(schema, editorAnalyticsApi) {
       schema
     } = state;
     const [, prefix, linkText, linkUrl] = match;
+
+    // We don't filter this match here by shouldAutoLinkifyMatch
+    // because the intent of creating a link is clear
+
     const url = normalizeUrl(linkUrl).trim();
     const markType = schema.mark('link', {
       href: url

package/dist/es2019/pm-plugins/keymap.js

@@ -2,8 +2,9 @@ import { getLinkMatch } from '@atlaskit/adf-schema';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { addLinkMetadata } from '@atlaskit/editor-common/card';
 import { addLink, bindKeymapWithCommand, bindKeymapWithEditorCommand, enter, escape, insertNewLine } from '@atlaskit/editor-common/keymaps';
-import { findFilepaths, getLinkCreationAnalyticsEvent, isLinkInMatches } from '@atlaskit/editor-common/utils';
+import { findFilepaths, getLinkCreationAnalyticsEvent, isLinkInMatches, shouldAutoLinkifyMatch } from '@atlaskit/editor-common/utils';
 import { keymap } from '@atlaskit/editor-prosemirror/keymap';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import { hideLinkToolbar, showLinkToolbar } from '../commands';
 import { stateKey } from '../pm-plugins/main';
 import { toolbarKey } from './toolbar-buttons';
@@ -25,6 +26,10 @@ export function createKeymapPlugin(editorAnalyticsApi) {
   }, list);
   return keymap(list);
 }
+
+/**
+ * Convert the last word before the selection to a hyperlink if it's a valid URL with a tld we want to linkify
+ */
 const mayConvertLastWordToHyperlink = editorAnalyticsApi => {
   return function (state, dispatch) {
     var _toolbarKey$getState$, _toolbarKey$getState;
@@ -37,6 +42,11 @@ const mayConvertLastWordToHyperlink = editorAnalyticsApi => {
     const lastWord = words[words.length - 1];
     const match = getLinkMatch(lastWord);
     if (match) {
+      if (getBooleanFF('platform.linking-platform.prevent-suspicious-linkification')) {
+        if (!shouldAutoLinkifyMatch(match)) {
+          return false;
+        }
+      }
       const hyperlinkedText = match.raw;
       const start = state.selection.$from.pos - hyperlinkedText.length;
       const end = state.selection.$from.pos;

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

@@ -2,9 +2,14 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { addLinkMetadata } from '@atlaskit/editor-common/card';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { createRule, findFilepaths, getLinkCreationAnalyticsEvent, isLinkInMatches, LinkMatcher, normalizeUrl } from '@atlaskit/editor-common/utils';
+import { createRule, findFilepaths, getLinkCreationAnalyticsEvent, isLinkInMatches, LinkMatcher, normalizeUrl, shouldAutoLinkifyMatch } from '@atlaskit/editor-common/utils';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import { createPlugin } from '@atlaskit/prosemirror-input-rules';
 import { toolbarKey } from './toolbar-buttons';
+
+/**
+ * Called when space after link, but not on enter
+ */
 export function createLinkInputRule(regexp, editorAnalyticsApi) {
   // Plain typed text (eg, typing 'www.google.com') should convert to a hyperlink
   return createRule(regexp, function (state, match, start, end) {
@@ -14,7 +19,27 @@ export function createLinkInputRule(regexp, editorAnalyticsApi) {
       return null;
     }
     var link = match;
-    var url = normalizeUrl(link.url);
+    var url;
+    if (getBooleanFF('platform.linking-platform.prevent-suspicious-linkification')) {
+      // Property 'url' does not exist on type 'RegExpExecArray', the type of `match`.
+      // This check is in case the match is not a Linkify match, which has a url property.
+      if (link.url === undefined) {
+        return null;
+      }
+      if (!shouldAutoLinkifyMatch(link)) {
+        return null;
+      }
+      url = normalizeUrl(link.url);
+
+      // Not previously handled; don't create a link if the URL is empty.
+      // This will only happen if the `regexp` matches more links than the normalizeUrl validation;
+      // if they both use the same linkify instance this shouldn't happen.
+      if (url === '') {
+        return null;
+      }
+    } else {
+      url = normalizeUrl(link.url);
+    }
     var markType = schema.mark('link', {
       href: url
     });
@@ -65,6 +90,10 @@ export function createInputRulePlugin(schema, editorAnalyticsApi) {
       prefix = _match[1],
       linkText = _match[2],
       linkUrl = _match[3];
+
+    // We don't filter this match here by shouldAutoLinkifyMatch
+    // because the intent of creating a link is clear
+
     var url = normalizeUrl(linkUrl).trim();
     var markType = schema.mark('link', {
       href: url

package/dist/esm/pm-plugins/keymap.js

@@ -2,8 +2,9 @@ import { getLinkMatch } from '@atlaskit/adf-schema';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { addLinkMetadata } from '@atlaskit/editor-common/card';
 import { addLink, bindKeymapWithCommand, bindKeymapWithEditorCommand, enter, escape, insertNewLine } from '@atlaskit/editor-common/keymaps';
-import { findFilepaths, getLinkCreationAnalyticsEvent, isLinkInMatches } from '@atlaskit/editor-common/utils';
+import { findFilepaths, getLinkCreationAnalyticsEvent, isLinkInMatches, shouldAutoLinkifyMatch } from '@atlaskit/editor-common/utils';
 import { keymap } from '@atlaskit/editor-prosemirror/keymap';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import { hideLinkToolbar, showLinkToolbar } from '../commands';
 import { stateKey } from '../pm-plugins/main';
 import { toolbarKey } from './toolbar-buttons';
@@ -25,6 +26,10 @@ export function createKeymapPlugin(editorAnalyticsApi) {
   }, list);
   return keymap(list);
 }
+
+/**
+ * Convert the last word before the selection to a hyperlink if it's a valid URL with a tld we want to linkify
+ */
 var mayConvertLastWordToHyperlink = function mayConvertLastWordToHyperlink(editorAnalyticsApi) {
   return function (state, dispatch) {
     var _toolbarKey$getState$, _toolbarKey$getState;
@@ -37,6 +42,11 @@ var mayConvertLastWordToHyperlink = function mayConvertLastWordToHyperlink(edito
     var lastWord = words[words.length - 1];
     var match = getLinkMatch(lastWord);
     if (match) {
+      if (getBooleanFF('platform.linking-platform.prevent-suspicious-linkification')) {
+        if (!shouldAutoLinkifyMatch(match)) {
+          return false;
+        }
+      }
       var hyperlinkedText = match.raw;
       var start = state.selection.$from.pos - hyperlinkedText.length;
       var end = state.selection.$from.pos;

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

@@ -2,6 +2,9 @@ import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { InputRuleWrapper } from '@atlaskit/editor-common/types';
 import type { Schema } from '@atlaskit/editor-prosemirror/model';
+/**
+ * Called when space after link, but not on enter
+ */
 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

@@ -2,6 +2,9 @@ import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { InputRuleWrapper } from '@atlaskit/editor-common/types';
 import type { Schema } from '@atlaskit/editor-prosemirror/model';
+/**
+ * Called when space after link, but not on enter
+ */
 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.3.1",
+  "version": "1.4.0",
   "description": "Hyperlink plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -34,10 +34,11 @@
   "dependencies": {
     "@atlaskit/adf-schema": "^35.8.0",
     "@atlaskit/analytics-next": "^9.2.0",
-    "@atlaskit/editor-common": "^78.22.0",
+    "@atlaskit/editor-common": "^78.23.0",
     "@atlaskit/editor-plugin-analytics": "^1.0.0",
     "@atlaskit/editor-prosemirror": "3.0.0",
     "@atlaskit/icon": "^22.1.0",
+    "@atlaskit/platform-feature-flags": "^0.2.5",
     "@atlaskit/prosemirror-input-rules": "^3.0.0",
     "@babel/runtime": "^7.0.0",
     "uuid": "^3.1.0"
@@ -91,5 +92,9 @@
     }
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0",
-  "platform-feature-flags": {}
+  "platform-feature-flags": {
+    "platform.linking-platform.prevent-suspicious-linkification": {
+      "type": "boolean"
+    }
+  }
 }