@atlaskit/smart-card 44.18.0 → 44.19.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/smart-card
 
+## 44.19.0
+
+### Minor Changes
+
+- [`2918b4d7371d7`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/2918b4d7371d7) -
+  Add XPC query parameter to smart links.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 44.18.0
 
 ### Minor Changes

package/dist/cjs/state/hooks/use-smart-link-cross-product-url-wrapper/index.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useSmartLinkCrossProductUrlWrapperGated = exports.getIsFirstPartyLink = void 0;
+var _react = require("react");
+var _useCrossProductUrlWrapper = require("@atlaskit/analytics-cross-product/useCrossProductUrlWrapper");
+var _linkProvider = require("@atlaskit/link-provider");
+var _platformFeatureFlagsReact = require("@atlaskit/platform-feature-flags-react");
+var SMART_LINKS_XPC_BRIDGE = 'smartLinks';
+var XPC_QUERY_PARAM = 'xpis';
+var getIsFirstPartyLink = exports.getIsFirstPartyLink = function getIsFirstPartyLink(details) {
+  var _is1PLink, _details$meta;
+  return ((_is1PLink = details === null || details === void 0 || (_details$meta = details.meta) === null || _details$meta === void 0 ? void 0 : _details$meta.is1PLink) !== null && _is1PLink !== void 0 ? _is1PLink : false) === true;
+};
+var identityUrlWrapper = function identityUrlWrapper(url) {
+  return url;
+};
+var useSmartLinkCrossProductUrlWrapperFallback = function useSmartLinkCrossProductUrlWrapperFallback(_args) {
+  return identityUrlWrapper;
+};
+var useSmartLinkCrossProductUrlWrapper = function useSmartLinkCrossProductUrlWrapper(_ref) {
+  var _product$toLowerCase;
+  var details = _ref.details;
+  var _useSmartLinkContext = (0, _linkProvider.useSmartLinkContext)(),
+    product = _useSmartLinkContext.product;
+  var wrapUrl = (0, _useCrossProductUrlWrapper.useCrossProductUrlWrapper)({
+    bridge: SMART_LINKS_XPC_BRIDGE,
+    product: (_product$toLowerCase = product === null || product === void 0 ? void 0 : product.toLowerCase()) !== null && _product$toLowerCase !== void 0 ? _product$toLowerCase : 'unknown'
+  });
+  return (0, _react.useCallback)(function (url) {
+    if (!getIsFirstPartyLink(details) || !product) {
+      return url;
+    }
+    var parsedUrl;
+    try {
+      parsedUrl = new URL(url);
+    } catch (_unused) {
+      return url;
+    }
+    if (parsedUrl.searchParams.has(XPC_QUERY_PARAM)) {
+      return url;
+    }
+    return wrapUrl(url);
+  }, [details, product, wrapUrl]);
+};
+var useSmartLinkCrossProductUrlWrapperGated = exports.useSmartLinkCrossProductUrlWrapperGated = (0, _platformFeatureFlagsReact.functionWithFG)('platform_smartlink_xpc_url_wrapping', useSmartLinkCrossProductUrlWrapper, useSmartLinkCrossProductUrlWrapperFallback);

package/dist/cjs/utils/analytics/analytics.js

@@ -11,7 +11,7 @@ var ANALYTICS_CHANNEL = exports.ANALYTICS_CHANNEL = 'media';
 var context = exports.context = {
   componentName: 'smart-cards',
   packageName: "@atlaskit/smart-card" || '',
-  packageVersion: "44.17.0" || ''
+  packageVersion: "44.18.0" || ''
 };
 var TrackQuickActionType = exports.TrackQuickActionType = /*#__PURE__*/function (TrackQuickActionType) {
   TrackQuickActionType["StatusUpdate"] = "StatusUpdate";

package/dist/cjs/view/CardWithUrl/component.js

@@ -20,6 +20,7 @@ var _state = require("../../state");
 var _analytics = require("../../state/analytics");
 var _helpers = require("../../state/helpers");
 var _useInlineActionNudgeExperiment = _interopRequireDefault(require("../../state/hooks/use-inline-action-nudge-experiment"));
+var _useSmartLinkCrossProductUrlWrapper = require("../../state/hooks/use-smart-link-cross-product-url-wrapper");
 var _modal = require("../../state/modal");
 var _utils = require("../../utils");
 var _combineActionOptions = require("../../utils/actions/combine-action-options");
@@ -93,6 +94,9 @@ function Component(_ref) {
   var services = (0, _helpers.getServices)(state.details);
   var thirdPartyARI = (0, _helpers.getThirdPartyARI)(state.details);
   var firstPartyIdentifier = (0, _helpers.getFirstPartyIdentifier)();
+  var wrapUrlWithCrossProductAnalytics = (0, _useSmartLinkCrossProductUrlWrapper.useSmartLinkCrossProductUrlWrapperGated)({
+    details: state.details
+  });
   var actionOptions = (0, _combineActionOptions.combineActionOptions)({
     actionOptions: actionOptionsProp,
     platform: platform
@@ -155,7 +159,12 @@ function Component(_ref) {
       // event by smart card internally
       // If it has been called then only then can `isSpecialEvent` be true.
       var target = (0, _utils.isSpecialEvent)(event) ? '_blank' : '_self';
-      window.open(clickUrl, target);
+      if ((0, _platformFeatureFlags.fg)('platform_smartlink_xpc_url_wrapping')) {
+        var wrappedUrl = wrapUrlWithCrossProductAnalytics(clickUrl);
+        window.open(wrappedUrl, target);
+      } else {
+        window.open(clickUrl, target);
+      }
       (0, _click.fireLinkClickedEvent)(createAnalyticsEvent)(event, {
         attributes: {
           clickOutcome: target === '_blank' ? 'clickThroughNewTabOrWindow' : 'clickThrough'
@@ -167,7 +176,7 @@ function Component(_ref) {
       }
       (0, _click.fireLinkClickedEvent)(createAnalyticsEvent)(event);
     }
-  }, [fireEvent, id, isFlexibleUi, appearance, definitionId, onClick, url, state.details, ari, name, fire3PClickEvent, shouldFire3PClickEvent, isPreviewPanelAvailable, openPreviewPanel, createAnalyticsEvent, disablePreviewPanel]);
+  }, [fireEvent, id, isFlexibleUi, appearance, definitionId, onClick, url, wrapUrlWithCrossProductAnalytics, state.details, ari, name, fire3PClickEvent, shouldFire3PClickEvent, isPreviewPanelAvailable, openPreviewPanel, createAnalyticsEvent, disablePreviewPanel]);
 
   // Exposure fires once per eligible mount; click-time reads use no-exposure variant.
   (0, _react.useEffect)(function () {

package/dist/cjs/view/LinkUrl/index.js

@@ -19,7 +19,7 @@ var _excluded = ["href", "children", "checkSafety", "onClick", "testId", "isLink
   _excluded2 = ["isLinkSafe", "showSafetyWarningModal"];
 var PACKAGE_DATA = {
   packageName: "@atlaskit/smart-card",
-  packageVersion: "44.17.0",
+  packageVersion: "44.18.0",
   componentName: 'linkUrl'
 };
 var LinkUrl = function LinkUrl(_ref) {

package/dist/es2019/state/hooks/use-smart-link-cross-product-url-wrapper/index.js

@@ -0,0 +1,40 @@
+import { useCallback } from 'react';
+import { useCrossProductUrlWrapper } from '@atlaskit/analytics-cross-product/useCrossProductUrlWrapper';
+import { useSmartLinkContext } from '@atlaskit/link-provider';
+import { functionWithFG } from '@atlaskit/platform-feature-flags-react';
+const SMART_LINKS_XPC_BRIDGE = 'smartLinks';
+const XPC_QUERY_PARAM = 'xpis';
+export const getIsFirstPartyLink = details => {
+  var _is1PLink, _details$meta;
+  return ((_is1PLink = details === null || details === void 0 ? void 0 : (_details$meta = details.meta) === null || _details$meta === void 0 ? void 0 : _details$meta.is1PLink) !== null && _is1PLink !== void 0 ? _is1PLink : false) === true;
+};
+const identityUrlWrapper = url => url;
+const useSmartLinkCrossProductUrlWrapperFallback = _args => identityUrlWrapper;
+const useSmartLinkCrossProductUrlWrapper = ({
+  details
+}) => {
+  var _product$toLowerCase;
+  const {
+    product
+  } = useSmartLinkContext();
+  const wrapUrl = useCrossProductUrlWrapper({
+    bridge: SMART_LINKS_XPC_BRIDGE,
+    product: (_product$toLowerCase = product === null || product === void 0 ? void 0 : product.toLowerCase()) !== null && _product$toLowerCase !== void 0 ? _product$toLowerCase : 'unknown'
+  });
+  return useCallback(url => {
+    if (!getIsFirstPartyLink(details) || !product) {
+      return url;
+    }
+    let parsedUrl;
+    try {
+      parsedUrl = new URL(url);
+    } catch {
+      return url;
+    }
+    if (parsedUrl.searchParams.has(XPC_QUERY_PARAM)) {
+      return url;
+    }
+    return wrapUrl(url);
+  }, [details, product, wrapUrl]);
+};
+export const useSmartLinkCrossProductUrlWrapperGated = functionWithFG('platform_smartlink_xpc_url_wrapping', useSmartLinkCrossProductUrlWrapper, useSmartLinkCrossProductUrlWrapperFallback);

package/dist/es2019/utils/analytics/analytics.js

@@ -2,7 +2,7 @@ export const ANALYTICS_CHANNEL = 'media';
 export const context = {
   componentName: 'smart-cards',
   packageName: "@atlaskit/smart-card" || '',
-  packageVersion: "44.17.0" || ''
+  packageVersion: "44.18.0" || ''
 };
 export let TrackQuickActionType = /*#__PURE__*/function (TrackQuickActionType) {
   TrackQuickActionType["StatusUpdate"] = "StatusUpdate";

package/dist/es2019/view/CardWithUrl/component.js

@@ -11,6 +11,7 @@ import { useSmartLink } from '../../state';
 import { succeedUfoExperience } from '../../state/analytics';
 import { getClickUrl, getDefinitionId, getExtensionKey, getFirstPartyIdentifier, getObjectAri, getObjectIconUrl, getObjectName, getResourceType, getServices, getThirdPartyARI, isFinalState } from '../../state/helpers';
 import useInlineActionNudgeExperiment from '../../state/hooks/use-inline-action-nudge-experiment';
+import { useSmartLinkCrossProductUrlWrapperGated } from '../../state/hooks/use-smart-link-cross-product-url-wrapper';
 import { SmartLinkModalProvider } from '../../state/modal';
 import { isSpecialClick, isSpecialEvent, isSpecialKey } from '../../utils';
 import { combineActionOptions } from '../../utils/actions/combine-action-options';
@@ -83,6 +84,9 @@ function Component({
   const services = getServices(state.details);
   const thirdPartyARI = getThirdPartyARI(state.details);
   const firstPartyIdentifier = getFirstPartyIdentifier();
+  const wrapUrlWithCrossProductAnalytics = useSmartLinkCrossProductUrlWrapperGated({
+    details: state.details
+  });
   const actionOptions = combineActionOptions({
     actionOptions: actionOptionsProp,
     platform
@@ -146,7 +150,12 @@ function Component({
       // event by smart card internally
       // If it has been called then only then can `isSpecialEvent` be true.
       const target = isSpecialEvent(event) ? '_blank' : '_self';
-      window.open(clickUrl, target);
+      if (fg('platform_smartlink_xpc_url_wrapping')) {
+        const wrappedUrl = wrapUrlWithCrossProductAnalytics(clickUrl);
+        window.open(wrappedUrl, target);
+      } else {
+        window.open(clickUrl, target);
+      }
       fireLinkClickedEvent(createAnalyticsEvent)(event, {
         attributes: {
           clickOutcome: target === '_blank' ? 'clickThroughNewTabOrWindow' : 'clickThrough'
@@ -158,7 +167,7 @@ function Component({
       }
       fireLinkClickedEvent(createAnalyticsEvent)(event);
     }
-  }, [fireEvent, id, isFlexibleUi, appearance, definitionId, onClick, url, state.details, ari, name, fire3PClickEvent, shouldFire3PClickEvent, isPreviewPanelAvailable, openPreviewPanel, createAnalyticsEvent, disablePreviewPanel]);
+  }, [fireEvent, id, isFlexibleUi, appearance, definitionId, onClick, url, wrapUrlWithCrossProductAnalytics, state.details, ari, name, fire3PClickEvent, shouldFire3PClickEvent, isPreviewPanelAvailable, openPreviewPanel, createAnalyticsEvent, disablePreviewPanel]);
 
   // Exposure fires once per eligible mount; click-time reads use no-exposure variant.
   useEffect(() => {

package/dist/es2019/view/EmbedModal/components/link-info/index.js

@@ -9,7 +9,7 @@ import VidFullScreenOnIcon from '@atlaskit/icon/core/fullscreen-enter';
 import FullscreenExitIcon from '@atlaskit/icon/core/fullscreen-exit';
 import ShortcutIcon from '@atlaskit/icon/core/link-external';
 import { CloseButton, useModal } from '@atlaskit/modal-dialog';
-import { fg } from "@atlaskit/platform-feature-flags";
+import { fg } from '@atlaskit/platform-feature-flags';
 import Tooltip from '@atlaskit/tooltip';
 import { messages } from '../../../../messages';
 import { Icon } from '../../../common/Icon';

package/dist/es2019/view/LinkUrl/index.js

@@ -9,7 +9,7 @@ import LinkWarningModal from './LinkWarningModal';
 import { useLinkWarningModal } from './LinkWarningModal/hooks/use-link-warning-modal';
 const PACKAGE_DATA = {
   packageName: "@atlaskit/smart-card",
-  packageVersion: "44.17.0",
+  packageVersion: "44.18.0",
   componentName: 'linkUrl'
 };
 const LinkUrl = ({

package/dist/esm/state/hooks/use-smart-link-cross-product-url-wrapper/index.js

@@ -0,0 +1,42 @@
+import { useCallback } from 'react';
+import { useCrossProductUrlWrapper } from '@atlaskit/analytics-cross-product/useCrossProductUrlWrapper';
+import { useSmartLinkContext } from '@atlaskit/link-provider';
+import { functionWithFG } from '@atlaskit/platform-feature-flags-react';
+var SMART_LINKS_XPC_BRIDGE = 'smartLinks';
+var XPC_QUERY_PARAM = 'xpis';
+export var getIsFirstPartyLink = function getIsFirstPartyLink(details) {
+  var _is1PLink, _details$meta;
+  return ((_is1PLink = details === null || details === void 0 || (_details$meta = details.meta) === null || _details$meta === void 0 ? void 0 : _details$meta.is1PLink) !== null && _is1PLink !== void 0 ? _is1PLink : false) === true;
+};
+var identityUrlWrapper = function identityUrlWrapper(url) {
+  return url;
+};
+var useSmartLinkCrossProductUrlWrapperFallback = function useSmartLinkCrossProductUrlWrapperFallback(_args) {
+  return identityUrlWrapper;
+};
+var useSmartLinkCrossProductUrlWrapper = function useSmartLinkCrossProductUrlWrapper(_ref) {
+  var _product$toLowerCase;
+  var details = _ref.details;
+  var _useSmartLinkContext = useSmartLinkContext(),
+    product = _useSmartLinkContext.product;
+  var wrapUrl = useCrossProductUrlWrapper({
+    bridge: SMART_LINKS_XPC_BRIDGE,
+    product: (_product$toLowerCase = product === null || product === void 0 ? void 0 : product.toLowerCase()) !== null && _product$toLowerCase !== void 0 ? _product$toLowerCase : 'unknown'
+  });
+  return useCallback(function (url) {
+    if (!getIsFirstPartyLink(details) || !product) {
+      return url;
+    }
+    var parsedUrl;
+    try {
+      parsedUrl = new URL(url);
+    } catch (_unused) {
+      return url;
+    }
+    if (parsedUrl.searchParams.has(XPC_QUERY_PARAM)) {
+      return url;
+    }
+    return wrapUrl(url);
+  }, [details, product, wrapUrl]);
+};
+export var useSmartLinkCrossProductUrlWrapperGated = functionWithFG('platform_smartlink_xpc_url_wrapping', useSmartLinkCrossProductUrlWrapper, useSmartLinkCrossProductUrlWrapperFallback);

package/dist/esm/utils/analytics/analytics.js

@@ -4,7 +4,7 @@ export var ANALYTICS_CHANNEL = 'media';
 export var context = {
   componentName: 'smart-cards',
   packageName: "@atlaskit/smart-card" || '',
-  packageVersion: "44.17.0" || ''
+  packageVersion: "44.18.0" || ''
 };
 export var TrackQuickActionType = /*#__PURE__*/function (TrackQuickActionType) {
   TrackQuickActionType["StatusUpdate"] = "StatusUpdate";

package/dist/esm/view/CardWithUrl/component.js

@@ -14,6 +14,7 @@ import { useSmartLink } from '../../state';
 import { succeedUfoExperience } from '../../state/analytics';
 import { getClickUrl, getDefinitionId, getExtensionKey, getFirstPartyIdentifier, getObjectAri, getObjectIconUrl, getObjectName, getResourceType, getServices, getThirdPartyARI, isFinalState } from '../../state/helpers';
 import useInlineActionNudgeExperiment from '../../state/hooks/use-inline-action-nudge-experiment';
+import { useSmartLinkCrossProductUrlWrapperGated } from '../../state/hooks/use-smart-link-cross-product-url-wrapper';
 import { SmartLinkModalProvider } from '../../state/modal';
 import { isSpecialClick, isSpecialEvent, isSpecialKey } from '../../utils';
 import { combineActionOptions } from '../../utils/actions/combine-action-options';
@@ -84,6 +85,9 @@ function Component(_ref) {
   var services = getServices(state.details);
   var thirdPartyARI = getThirdPartyARI(state.details);
   var firstPartyIdentifier = getFirstPartyIdentifier();
+  var wrapUrlWithCrossProductAnalytics = useSmartLinkCrossProductUrlWrapperGated({
+    details: state.details
+  });
   var actionOptions = combineActionOptions({
     actionOptions: actionOptionsProp,
     platform: platform
@@ -146,7 +150,12 @@ function Component(_ref) {
       // event by smart card internally
       // If it has been called then only then can `isSpecialEvent` be true.
       var target = isSpecialEvent(event) ? '_blank' : '_self';
-      window.open(clickUrl, target);
+      if (fg('platform_smartlink_xpc_url_wrapping')) {
+        var wrappedUrl = wrapUrlWithCrossProductAnalytics(clickUrl);
+        window.open(wrappedUrl, target);
+      } else {
+        window.open(clickUrl, target);
+      }
       fireLinkClickedEvent(createAnalyticsEvent)(event, {
         attributes: {
           clickOutcome: target === '_blank' ? 'clickThroughNewTabOrWindow' : 'clickThrough'
@@ -158,7 +167,7 @@ function Component(_ref) {
       }
       fireLinkClickedEvent(createAnalyticsEvent)(event);
     }
-  }, [fireEvent, id, isFlexibleUi, appearance, definitionId, onClick, url, state.details, ari, name, fire3PClickEvent, shouldFire3PClickEvent, isPreviewPanelAvailable, openPreviewPanel, createAnalyticsEvent, disablePreviewPanel]);
+  }, [fireEvent, id, isFlexibleUi, appearance, definitionId, onClick, url, wrapUrlWithCrossProductAnalytics, state.details, ari, name, fire3PClickEvent, shouldFire3PClickEvent, isPreviewPanelAvailable, openPreviewPanel, createAnalyticsEvent, disablePreviewPanel]);
 
   // Exposure fires once per eligible mount; click-time reads use no-exposure variant.
   useEffect(function () {

package/dist/esm/view/EmbedModal/components/link-info/index.js

@@ -9,7 +9,7 @@ import VidFullScreenOnIcon from '@atlaskit/icon/core/fullscreen-enter';
 import FullscreenExitIcon from '@atlaskit/icon/core/fullscreen-exit';
 import ShortcutIcon from '@atlaskit/icon/core/link-external';
 import { CloseButton, useModal } from '@atlaskit/modal-dialog';
-import { fg } from "@atlaskit/platform-feature-flags";
+import { fg } from '@atlaskit/platform-feature-flags';
 import Tooltip from '@atlaskit/tooltip';
 import { messages } from '../../../../messages';
 import { Icon } from '../../../common/Icon';

package/dist/esm/view/LinkUrl/index.js

@@ -12,7 +12,7 @@ import LinkWarningModal from './LinkWarningModal';
 import { useLinkWarningModal } from './LinkWarningModal/hooks/use-link-warning-modal';
 var PACKAGE_DATA = {
   packageName: "@atlaskit/smart-card",
-  packageVersion: "44.17.0",
+  packageVersion: "44.18.0",
   componentName: 'linkUrl'
 };
 var LinkUrl = function LinkUrl(_ref) {

package/dist/types/state/hooks/use-smart-link-cross-product-url-wrapper/index.d.ts

@@ -0,0 +1,8 @@
+import { type SmartLinkResponse } from '@atlaskit/linking-types';
+export declare const getIsFirstPartyLink: (details?: SmartLinkResponse) => boolean;
+type UseSmartLinkCrossProductUrlWrapperArgs = {
+    details?: SmartLinkResponse;
+};
+declare const useSmartLinkCrossProductUrlWrapper: ({ details, }: UseSmartLinkCrossProductUrlWrapperArgs) => ((url: string) => string);
+export declare const useSmartLinkCrossProductUrlWrapperGated: typeof useSmartLinkCrossProductUrlWrapper;
+export {};

package/dist/types-ts4.5/state/hooks/use-smart-link-cross-product-url-wrapper/index.d.ts

@@ -0,0 +1,8 @@
+import { type SmartLinkResponse } from '@atlaskit/linking-types';
+export declare const getIsFirstPartyLink: (details?: SmartLinkResponse) => boolean;
+type UseSmartLinkCrossProductUrlWrapperArgs = {
+    details?: SmartLinkResponse;
+};
+declare const useSmartLinkCrossProductUrlWrapper: ({ details, }: UseSmartLinkCrossProductUrlWrapperArgs) => ((url: string) => string);
+export declare const useSmartLinkCrossProductUrlWrapperGated: typeof useSmartLinkCrossProductUrlWrapper;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "44.18.0",
+	"version": "44.19.0",
 	"description": "Smart card component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -37,6 +37,7 @@
 	"dependencies": {
 		"@atlaskit/adf-utils": "^19.32.0",
 		"@atlaskit/afm-i18n-platform-linking-platform-smart-card": "2.6.0",
+		"@atlaskit/analytics-cross-product": "^1.2.0",
 		"@atlaskit/analytics-gas-types": "^5.1.0",
 		"@atlaskit/analytics-next": "^11.2.0",
 		"@atlaskit/avatar": "^25.15.0",
@@ -76,12 +77,12 @@
 		"@atlaskit/platform-feature-flags-react": "^0.5.0",
 		"@atlaskit/popup": "^4.23.0",
 		"@atlaskit/primitives": "^19.0.0",
-		"@atlaskit/react-ufo": "^6.4.0",
+		"@atlaskit/react-ufo": "^6.5.0",
 		"@atlaskit/rovo-triggers": "^6.5.0",
 		"@atlaskit/section-message": "^8.13.0",
 		"@atlaskit/select": "^21.12.0",
 		"@atlaskit/spinner": "^19.1.0",
-		"@atlaskit/tag": "^14.14.0",
+		"@atlaskit/tag": "^14.15.0",
 		"@atlaskit/textarea": "^8.3.0",
 		"@atlaskit/textfield": "^8.3.0",
 		"@atlaskit/theme": "^25.0.0",
@@ -204,6 +205,9 @@
 		"platform_smartlink_3pclick_analytics": {
 			"type": "boolean"
 		},
+		"platform_smartlink_xpc_url_wrapping": {
+			"type": "boolean"
+		},
 		"navx-1895-new-logo-design": {
 			"type": "boolean"
 		},