@atlaskit/editor-plugin-hyperlink 2.4.2 → 2.5.1

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @atlaskit/editor-plugin-hyperlink
 
+## 2.5.1
+
+### Patch Changes
+
+- Updated dependencies
+
+## 2.5.0
+
+### Minor Changes
+
+- [#121606](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/121606)
+  [`fb55435295b55`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/fb55435295b55) -
+  Add on click callback to hyperlink plugin for live page
+- [#122895](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/122895)
+  [`49b8c7658f3b5`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/49b8c7658f3b5) -
+  [ED-24173] bump @atlaskit/adf-schema to 40.3.0 and @atlassian/adf-schema-json to 1.18.0
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 2.4.2
 
 ### Patch Changes

package/dist/cjs/plugin.js

@@ -100,10 +100,9 @@ var hyperlinkPlugin = exports.hyperlinkPlugin = function hyperlinkPlugin(_ref) {
         plugin: function plugin(_ref2) {
           var dispatch = _ref2.dispatch,
             getIntl = _ref2.getIntl;
-          return (
-            // @ts-ignore Temporary solution to check for Live Page editor.
-            (0, _main.plugin)(dispatch, getIntl(), options === null || options === void 0 ? void 0 : options.editorAppearance, api, options.__livePage)
-          );
+          return (0, _main.plugin)(dispatch, getIntl(), options === null || options === void 0 ? void 0 : options.editorAppearance, api, options === null || options === void 0 ? void 0 : options.onClickCallback,
+          // @ts-ignore Temporary solution to check for Live Page editor.
+          options.__livePage);
         }
       }, {
         name: 'fakeCursorToolbarPlugin',

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

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.stateKey = exports.plugin = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _uuid = _interopRequireDefault(require("uuid"));
+var _analytics = require("@atlaskit/editor-common/analytics");
 var _link3 = require("@atlaskit/editor-common/link");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _utils = require("@atlaskit/editor-common/utils");
@@ -158,7 +159,7 @@ var getActiveText = function getActiveText(selection) {
   return;
 };
 var stateKey = exports.stateKey = new _state.PluginKey('hyperlinkPlugin');
-var plugin = exports.plugin = function plugin(dispatch, intl, editorAppearance, pluginInjectionApi, __livePage) {
+var plugin = exports.plugin = function plugin(dispatch, intl, editorAppearance, pluginInjectionApi, onClickCallback, __livePage) {
   return new _safePlugin.SafePlugin({
     state: {
       init: function init(_, state) {
@@ -337,6 +338,38 @@ var plugin = exports.plugin = function plugin(dispatch, intl, editorAppearance,
               setTargetElementPos(undefined);
             }
           };
+          dom.onclick = function (event) {
+            if (isDirectTarget(event, dom)) {
+              var _pluginInjectionApi$a, _pluginInjectionApi$a2;
+              var url = mark.attrs.href;
+              pluginInjectionApi === null || pluginInjectionApi === void 0 || (_pluginInjectionApi$a = pluginInjectionApi.analytics) === null || _pluginInjectionApi$a === void 0 || (_pluginInjectionApi$a = _pluginInjectionApi$a.actions) === null || _pluginInjectionApi$a === void 0 || (_pluginInjectionApi$a2 = _pluginInjectionApi$a.fireAnalyticsEvent) === null || _pluginInjectionApi$a2 === void 0 || _pluginInjectionApi$a2.call(_pluginInjectionApi$a, {
+                action: _analytics.ACTION.VISITED,
+                actionSubject: _analytics.ACTION_SUBJECT.LINK,
+                eventType: _analytics.EVENT_TYPE.TRACK,
+                attributes: {
+                  platform: _analytics.PLATFORMS.WEB,
+                  mode: _analytics.MODE.EDITOR
+                }
+              });
+              if (url) {
+                try {
+                  onClickCallback === null || onClickCallback === void 0 || onClickCallback({
+                    event: event,
+                    url: url
+                  });
+                } catch (_unused) {}
+
+                /**
+                 * Links should navigate by default in live pages if:
+                 * - the link is the direct target of the click event
+                 * - default handling wasn't prevented with `event.preventDefault()`
+                 */
+                if (!event.defaultPrevented) {
+                  window.location.href = url;
+                }
+              }
+            }
+          };
           return {
             dom: dom
           };
@@ -347,4 +380,7 @@ var plugin = exports.plugin = function plugin(dispatch, intl, editorAppearance,
 };
 function isLinkDirectTarget(event) {
   return (event === null || event === void 0 ? void 0 : event.target) instanceof HTMLElement && event.target.tagName === 'A';
+}
+function isDirectTarget(event, element) {
+  return (event === null || event === void 0 ? void 0 : event.target) instanceof HTMLElement && event.target === element;
 }

package/dist/es2019/plugin.js

@@ -85,9 +85,9 @@ export const hyperlinkPlugin = ({
         plugin: ({
           dispatch,
           getIntl
-        }) =>
+        }) => plugin(dispatch, getIntl(), options === null || options === void 0 ? void 0 : options.editorAppearance, api, options === null || options === void 0 ? void 0 : options.onClickCallback,
         // @ts-ignore Temporary solution to check for Live Page editor.
-        plugin(dispatch, getIntl(), options === null || options === void 0 ? void 0 : options.editorAppearance, api, options.__livePage)
+        options.__livePage)
       }, {
         name: 'fakeCursorToolbarPlugin',
         plugin: () => fakeCursorToolbarPlugin

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

@@ -1,4 +1,5 @@
 import uuid from 'uuid';
+import { ACTION, ACTION_SUBJECT, EVENT_TYPE, MODE, PLATFORMS } from '@atlaskit/editor-common/analytics';
 import { InsertStatus, LinkAction } from '@atlaskit/editor-common/link';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { canLinkBeCreatedInRange, shallowEqual } from '@atlaskit/editor-common/utils';
@@ -159,7 +160,7 @@ const getActiveText = selection => {
   return;
 };
 export const stateKey = new PluginKey('hyperlinkPlugin');
-export const plugin = (dispatch, intl, editorAppearance, pluginInjectionApi, __livePage) => new SafePlugin({
+export const plugin = (dispatch, intl, editorAppearance, pluginInjectionApi, onClickCallback, __livePage) => new SafePlugin({
   state: {
     init(_, state) {
       const canInsertLink = canLinkBeCreatedInRange(state.selection.from, state.selection.to)(state);
@@ -351,6 +352,38 @@ export const plugin = (dispatch, intl, editorAppearance, pluginInjectionApi, __l
               setTargetElementPos(undefined);
             }
           };
+          dom.onclick = event => {
+            if (isDirectTarget(event, dom)) {
+              var _pluginInjectionApi$a, _pluginInjectionApi$a2, _pluginInjectionApi$a3;
+              const url = mark.attrs.href;
+              pluginInjectionApi === null || pluginInjectionApi === void 0 ? void 0 : (_pluginInjectionApi$a = pluginInjectionApi.analytics) === null || _pluginInjectionApi$a === void 0 ? void 0 : (_pluginInjectionApi$a2 = _pluginInjectionApi$a.actions) === null || _pluginInjectionApi$a2 === void 0 ? void 0 : (_pluginInjectionApi$a3 = _pluginInjectionApi$a2.fireAnalyticsEvent) === null || _pluginInjectionApi$a3 === void 0 ? void 0 : _pluginInjectionApi$a3.call(_pluginInjectionApi$a2, {
+                action: ACTION.VISITED,
+                actionSubject: ACTION_SUBJECT.LINK,
+                eventType: EVENT_TYPE.TRACK,
+                attributes: {
+                  platform: PLATFORMS.WEB,
+                  mode: MODE.EDITOR
+                }
+              });
+              if (url) {
+                try {
+                  onClickCallback === null || onClickCallback === void 0 ? void 0 : onClickCallback({
+                    event,
+                    url
+                  });
+                } catch {}
+
+                /**
+                 * Links should navigate by default in live pages if:
+                 * - the link is the direct target of the click event
+                 * - default handling wasn't prevented with `event.preventDefault()`
+                 */
+                if (!event.defaultPrevented) {
+                  window.location.href = url;
+                }
+              }
+            }
+          };
           return {
             dom: dom
           };
@@ -361,4 +394,7 @@ export const plugin = (dispatch, intl, editorAppearance, pluginInjectionApi, __l
 });
 function isLinkDirectTarget(event) {
   return (event === null || event === void 0 ? void 0 : event.target) instanceof HTMLElement && event.target.tagName === 'A';
+}
+function isDirectTarget(event, element) {
+  return (event === null || event === void 0 ? void 0 : event.target) instanceof HTMLElement && event.target === element;
 }

package/dist/esm/plugin.js

@@ -93,10 +93,9 @@ export var hyperlinkPlugin = function hyperlinkPlugin(_ref) {
         plugin: function plugin(_ref2) {
           var dispatch = _ref2.dispatch,
             getIntl = _ref2.getIntl;
-          return (
-            // @ts-ignore Temporary solution to check for Live Page editor.
-            _plugin(dispatch, getIntl(), options === null || options === void 0 ? void 0 : options.editorAppearance, api, options.__livePage)
-          );
+          return _plugin(dispatch, getIntl(), options === null || options === void 0 ? void 0 : options.editorAppearance, api, options === null || options === void 0 ? void 0 : options.onClickCallback,
+          // @ts-ignore Temporary solution to check for Live Page editor.
+          options.__livePage);
         }
       }, {
         name: 'fakeCursorToolbarPlugin',

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

@@ -2,6 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import uuid from 'uuid';
+import { ACTION, ACTION_SUBJECT, EVENT_TYPE, MODE, PLATFORMS } from '@atlaskit/editor-common/analytics';
 import { InsertStatus, LinkAction } from '@atlaskit/editor-common/link';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { canLinkBeCreatedInRange, shallowEqual } from '@atlaskit/editor-common/utils';
@@ -151,7 +152,7 @@ var getActiveText = function getActiveText(selection) {
   return;
 };
 export var stateKey = new PluginKey('hyperlinkPlugin');
-export var plugin = function plugin(dispatch, intl, editorAppearance, pluginInjectionApi, __livePage) {
+export var plugin = function plugin(dispatch, intl, editorAppearance, pluginInjectionApi, onClickCallback, __livePage) {
   return new SafePlugin({
     state: {
       init: function init(_, state) {
@@ -330,6 +331,38 @@ export var plugin = function plugin(dispatch, intl, editorAppearance, pluginInje
               setTargetElementPos(undefined);
             }
           };
+          dom.onclick = function (event) {
+            if (isDirectTarget(event, dom)) {
+              var _pluginInjectionApi$a, _pluginInjectionApi$a2;
+              var url = mark.attrs.href;
+              pluginInjectionApi === null || pluginInjectionApi === void 0 || (_pluginInjectionApi$a = pluginInjectionApi.analytics) === null || _pluginInjectionApi$a === void 0 || (_pluginInjectionApi$a = _pluginInjectionApi$a.actions) === null || _pluginInjectionApi$a === void 0 || (_pluginInjectionApi$a2 = _pluginInjectionApi$a.fireAnalyticsEvent) === null || _pluginInjectionApi$a2 === void 0 || _pluginInjectionApi$a2.call(_pluginInjectionApi$a, {
+                action: ACTION.VISITED,
+                actionSubject: ACTION_SUBJECT.LINK,
+                eventType: EVENT_TYPE.TRACK,
+                attributes: {
+                  platform: PLATFORMS.WEB,
+                  mode: MODE.EDITOR
+                }
+              });
+              if (url) {
+                try {
+                  onClickCallback === null || onClickCallback === void 0 || onClickCallback({
+                    event: event,
+                    url: url
+                  });
+                } catch (_unused) {}
+
+                /**
+                 * Links should navigate by default in live pages if:
+                 * - the link is the direct target of the click event
+                 * - default handling wasn't prevented with `event.preventDefault()`
+                 */
+                if (!event.defaultPrevented) {
+                  window.location.href = url;
+                }
+              }
+            }
+          };
           return {
             dom: dom
           };
@@ -340,4 +373,7 @@ export var plugin = function plugin(dispatch, intl, editorAppearance, pluginInje
 };
 function isLinkDirectTarget(event) {
   return (event === null || event === void 0 ? void 0 : event.target) instanceof HTMLElement && event.target.tagName === 'A';
+}
+function isDirectTarget(event, element) {
+  return (event === null || event === void 0 ? void 0 : event.target) instanceof HTMLElement && event.target === element;
 }

package/dist/types/pm-plugins/main.d.ts

@@ -1,4 +1,5 @@
 import { type IntlShape } from 'react-intl-next';
+import type { OnClickCallback } from '@atlaskit/editor-common/card';
 import type { Dispatch } from '@atlaskit/editor-common/event-dispatcher';
 import type { HyperlinkState } from '@atlaskit/editor-common/link';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
@@ -6,4 +7,4 @@ import type { EditorAppearance, ExtractInjectionAPI } from '@atlaskit/editor-com
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import type { HyperlinkPlugin } from '../plugin';
 export declare const stateKey: PluginKey<HyperlinkState>;
-export declare const plugin: (dispatch: Dispatch, intl: IntlShape, editorAppearance?: EditorAppearance, pluginInjectionApi?: ExtractInjectionAPI<HyperlinkPlugin> | undefined, __livePage?: boolean) => SafePlugin<HyperlinkState>;
+export declare const plugin: (dispatch: Dispatch, intl: IntlShape, editorAppearance?: EditorAppearance, pluginInjectionApi?: ExtractInjectionAPI<HyperlinkPlugin> | undefined, onClickCallback?: OnClickCallback, __livePage?: boolean) => SafePlugin<HyperlinkState>;

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

@@ -1,4 +1,5 @@
 import { type IntlShape } from 'react-intl-next';
+import type { OnClickCallback } from '@atlaskit/editor-common/card';
 import type { Dispatch } from '@atlaskit/editor-common/event-dispatcher';
 import type { HyperlinkState } from '@atlaskit/editor-common/link';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
@@ -6,4 +7,4 @@ import type { EditorAppearance, ExtractInjectionAPI } from '@atlaskit/editor-com
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import type { HyperlinkPlugin } from '../plugin';
 export declare const stateKey: PluginKey<HyperlinkState>;
-export declare const plugin: (dispatch: Dispatch, intl: IntlShape, editorAppearance?: EditorAppearance, pluginInjectionApi?: ExtractInjectionAPI<HyperlinkPlugin> | undefined, __livePage?: boolean) => SafePlugin<HyperlinkState>;
+export declare const plugin: (dispatch: Dispatch, intl: IntlShape, editorAppearance?: EditorAppearance, pluginInjectionApi?: ExtractInjectionAPI<HyperlinkPlugin> | undefined, onClickCallback?: OnClickCallback, __livePage?: boolean) => SafePlugin<HyperlinkState>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-hyperlink",
-	"version": "2.4.2",
+	"version": "2.5.1",
 	"description": "Hyperlink plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,11 +32,11 @@
 		".": "./src/index.ts"
 	},
 	"dependencies": {
-		"@atlaskit/adf-schema": "^39.0.3",
+		"@atlaskit/adf-schema": "^40.3.0",
 		"@atlaskit/analytics-next": "^9.3.0",
-		"@atlaskit/editor-common": "^86.4.0",
-		"@atlaskit/editor-plugin-analytics": "^1.4.0",
-		"@atlaskit/editor-plugin-card": "2.6.5",
+		"@atlaskit/editor-common": "^86.7.0",
+		"@atlaskit/editor-plugin-analytics": "^1.5.0",
+		"@atlaskit/editor-plugin-card": "2.7.1",
 		"@atlaskit/editor-plugin-editor-viewmode": "^2.0.0",
 		"@atlaskit/editor-prosemirror": "4.0.1",
 		"@atlaskit/icon": "^22.7.0",