@atlaskit/smart-card 25.3.3 → 25.4.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/smart-card
 
+## 25.4.1
+
+### Patch Changes
+
+- [`ae2cba07a9a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ae2cba07a9a) - Removes prevented as a clickOutcome analytics attribute value and adds defaultPrevented as a replacement attribute.
+
+## 25.4.0
+
+### Minor Changes
+
+- [`65b0490a5dc`](https://bitbucket.org/atlassian/atlassian-frontend/commits/65b0490a5dc) - Deprecates the export of useSmartLinkAnalytics hook and analyticsEvents prop.
+
 ## 25.3.3
 
 ### Patch Changes

package/dist/cjs/state/analytics/useSmartLinkAnalytics.js

@@ -33,6 +33,11 @@ var applyCommonAttributes = function applyCommonAttributes(event, commonAttribut
 /**
  * This hook provides usage of Smart Link analytics outside of the Card component.
  * Can be provided to Card via the analyticsEvents prop to change the analytics events.
+ *
+ * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-2681 Internal documentation for deprecation (no external access)}
+ * This hook's external use is deprecated and may no longer be exported from this package in future releases.
+ * Please avoid using it in conjunction with the `analyticsEvents` prop.
+ *
  * @param url URL of the link
  * @param dispatchAnalytics dispatchAnalytics function
  * @param id fallback id of the events sent if no id is available

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

@@ -26,9 +26,7 @@ function getLinkClickOutcome(e, clickType) {
   var _browser = (0, _userAgent.browser)(),
     mac = _browser.mac,
     safari = _browser.safari;
-  if (e.defaultPrevented) {
-    return 'prevented';
-  }
+
   /**
    * If the link/parent is content editable then left click won't have typical effect
    */
@@ -76,12 +74,13 @@ function getLinkClickOutcome(e, clickType) {
         return 'contextMenu';
       }
   }
-  return '_unknown';
+  return 'unknown';
 }
 var linkClickedEvent = function linkClickedEvent(_ref) {
   var clickType = _ref.clickType,
     clickOutcome = _ref.clickOutcome,
-    keysHeld = _ref.keysHeld;
+    keysHeld = _ref.keysHeld,
+    defaultPrevented = _ref.defaultPrevented;
   return {
     action: 'clicked',
     actionSubject: 'link',
@@ -89,7 +88,8 @@ var linkClickedEvent = function linkClickedEvent(_ref) {
     attributes: {
       clickType: clickType,
       clickOutcome: clickOutcome,
-      keysHeld: keysHeld
+      keysHeld: keysHeld,
+      defaultPrevented: defaultPrevented
     }
   };
 };
@@ -100,10 +100,12 @@ var createLinkClickedPayload = function createLinkClickedPayload(event) {
   }
   var clickOutcome = getLinkClickOutcome(event, clickType);
   var keysHeld = getKeys(event);
+  var defaultPrevented = event.defaultPrevented;
   return linkClickedEvent({
     clickType: clickType,
     clickOutcome: clickOutcome,
-    keysHeld: keysHeld
+    keysHeld: keysHeld,
+    defaultPrevented: defaultPrevented
   });
 };
 exports.createLinkClickedPayload = createLinkClickedPayload;

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "25.3.3",
+	"version": "25.4.1",
 	"sideEffects": false
 }

package/dist/es2019/state/analytics/useSmartLinkAnalytics.js

@@ -19,6 +19,11 @@ const applyCommonAttributes = (event, commonAttributes) => {
 /**
  * This hook provides usage of Smart Link analytics outside of the Card component.
  * Can be provided to Card via the analyticsEvents prop to change the analytics events.
+ *
+ * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-2681 Internal documentation for deprecation (no external access)}
+ * This hook's external use is deprecated and may no longer be exported from this package in future releases.
+ * Please avoid using it in conjunction with the `analyticsEvents` prop.
+ *
  * @param url URL of the link
  * @param dispatchAnalytics dispatchAnalytics function
  * @param id fallback id of the events sent if no id is available

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

@@ -12,9 +12,7 @@ export function getLinkClickOutcome(e, clickType) {
     mac,
     safari
   } = browser();
-  if (e.defaultPrevented) {
-    return 'prevented';
-  }
+
   /**
    * If the link/parent is content editable then left click won't have typical effect
    */
@@ -62,12 +60,13 @@ export function getLinkClickOutcome(e, clickType) {
         return 'contextMenu';
       }
   }
-  return '_unknown';
+  return 'unknown';
 }
 const linkClickedEvent = ({
   clickType,
   clickOutcome,
-  keysHeld
+  keysHeld,
+  defaultPrevented
 }) => ({
   action: 'clicked',
   actionSubject: 'link',
@@ -75,7 +74,8 @@ const linkClickedEvent = ({
   attributes: {
     clickType,
     clickOutcome,
-    keysHeld
+    keysHeld,
+    defaultPrevented
   }
 });
 export const createLinkClickedPayload = event => {
@@ -85,10 +85,12 @@ export const createLinkClickedPayload = event => {
   }
   const clickOutcome = getLinkClickOutcome(event, clickType);
   const keysHeld = getKeys(event);
+  const defaultPrevented = event.defaultPrevented;
   return linkClickedEvent({
     clickType,
     clickOutcome,
-    keysHeld
+    keysHeld,
+    defaultPrevented
   });
 };
 export const fireLinkClickedEvent = createAnalyticsEvent => (event, overrides = {}) => {

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "25.3.3",
+	"version": "25.4.1",
 	"sideEffects": false
 }

package/dist/esm/state/analytics/useSmartLinkAnalytics.js

@@ -26,6 +26,11 @@ var applyCommonAttributes = function applyCommonAttributes(event, commonAttribut
 /**
  * This hook provides usage of Smart Link analytics outside of the Card component.
  * Can be provided to Card via the analyticsEvents prop to change the analytics events.
+ *
+ * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-2681 Internal documentation for deprecation (no external access)}
+ * This hook's external use is deprecated and may no longer be exported from this package in future releases.
+ * Please avoid using it in conjunction with the `analyticsEvents` prop.
+ *
  * @param url URL of the link
  * @param dispatchAnalytics dispatchAnalytics function
  * @param id fallback id of the events sent if no id is available

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

@@ -16,9 +16,7 @@ export function getLinkClickOutcome(e, clickType) {
   var _browser = browser(),
     mac = _browser.mac,
     safari = _browser.safari;
-  if (e.defaultPrevented) {
-    return 'prevented';
-  }
+
   /**
    * If the link/parent is content editable then left click won't have typical effect
    */
@@ -66,12 +64,13 @@ export function getLinkClickOutcome(e, clickType) {
         return 'contextMenu';
       }
   }
-  return '_unknown';
+  return 'unknown';
 }
 var linkClickedEvent = function linkClickedEvent(_ref) {
   var clickType = _ref.clickType,
     clickOutcome = _ref.clickOutcome,
-    keysHeld = _ref.keysHeld;
+    keysHeld = _ref.keysHeld,
+    defaultPrevented = _ref.defaultPrevented;
   return {
     action: 'clicked',
     actionSubject: 'link',
@@ -79,7 +78,8 @@ var linkClickedEvent = function linkClickedEvent(_ref) {
     attributes: {
       clickType: clickType,
       clickOutcome: clickOutcome,
-      keysHeld: keysHeld
+      keysHeld: keysHeld,
+      defaultPrevented: defaultPrevented
     }
   };
 };
@@ -90,10 +90,12 @@ export var createLinkClickedPayload = function createLinkClickedPayload(event) {
   }
   var clickOutcome = getLinkClickOutcome(event, clickType);
   var keysHeld = getKeys(event);
+  var defaultPrevented = event.defaultPrevented;
   return linkClickedEvent({
     clickType: clickType,
     clickOutcome: clickOutcome,
-    keysHeld: keysHeld
+    keysHeld: keysHeld,
+    defaultPrevented: defaultPrevented
   });
 };
 export var fireLinkClickedEvent = function fireLinkClickedEvent(createAnalyticsEvent) {

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "25.3.3",
+	"version": "25.4.1",
 	"sideEffects": false
 }

package/dist/types/state/analytics/useSmartLinkAnalytics.d.ts

@@ -3,6 +3,11 @@ import { CommonEventProps, ConnectFailedEventProps, ConnectSucceededEventProps,
 /**
  * This hook provides usage of Smart Link analytics outside of the Card component.
  * Can be provided to Card via the analyticsEvents prop to change the analytics events.
+ *
+ * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-2681 Internal documentation for deprecation (no external access)}
+ * This hook's external use is deprecated and may no longer be exported from this package in future releases.
+ * Please avoid using it in conjunction with the `analyticsEvents` prop.
+ *
  * @param url URL of the link
  * @param dispatchAnalytics dispatchAnalytics function
  * @param id fallback id of the events sent if no id is available

package/dist/types/utils/analytics/click.d.ts

@@ -16,6 +16,7 @@ export declare const fireLinkClickedEvent: (createAnalyticsEvent: (payload: Anal
         clickType?: ClickType | undefined;
         clickOutcome?: ClickOutcome | undefined;
         keysHeld?: ("meta" | "alt" | "shift" | "ctrl" | undefined)[] | undefined;
+        defaultPrevented?: boolean | undefined;
     } | undefined;
 } | undefined) => void;
 export {};

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

@@ -106,7 +106,7 @@ export declare type InstrumentEventProps = CommonEventProps & {
     id: string;
 };
 export declare type ClickType = 'left' | 'middle' | 'right' | 'none';
-export declare type ClickOutcome = 'prevented' | 'clickThrough' | 'clickThroughNewTabOrWindow' | 'contextMenu' | 'alt' | 'contentEditable' | '_unknown';
+export declare type ClickOutcome = 'prevented' | 'clickThrough' | 'clickThroughNewTabOrWindow' | 'contextMenu' | 'alt' | 'contentEditable' | 'unknown';
 export declare type UiLinkClickedEventProps = {
     /**
      * Whether the click occurred with the left, middle or right mouse button
@@ -114,10 +114,16 @@ export declare type UiLinkClickedEventProps = {
     clickType: ClickType;
     /**
      * The user outcome for clicking the link as far as can be reasonably be determined
+     * This ignores any programmatic cancellation of the outcome (ie e.preventDefault()) and
+     * thus this represents the user intent, not necessarily the actual outcome
      */
     clickOutcome: ClickOutcome;
     /**
      * The keys held by the user at the time of clicking the link (which influence `clickOutcome`)
      */
     keysHeld: ('alt' | 'ctrl' | 'meta' | 'shift')[];
+    /**
+     * Whether the browser's default behaviour was prevented programmatically
+     */
+    defaultPrevented: boolean;
 };

package/dist/types/view/Card/types.d.ts

@@ -55,6 +55,11 @@ export interface CardProps extends WithAnalyticsEventsProps {
     children?: React.ReactNode;
     showHoverPreview?: boolean;
     showAuthTooltip?: boolean;
+    /**
+     * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-2681 Internal documentation for deprecation (no external access)}
+     * The use of `useSmartLinkAnalytics` external use in conjunction with `analyticsEvents` prop is deprecated and may be removed in future releases.
+     * Please avoid using this prop.
+     */
     analyticsEvents?: AnalyticsFacade;
     placeholder?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/smart-card",
-  "version": "25.3.3",
+  "version": "25.4.1",
   "description": "Smart card component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/report.api.md

@@ -283,7 +283,7 @@ export { CardPlatform };
 
 // @public (undocumented)
 export interface CardProps extends WithAnalyticsEventsProps {
-  // (undocumented)
+  // @deprecated (undocumented)
   analyticsEvents?: AnalyticsFacade;
   // (undocumented)
   appearance: CardAppearance;
@@ -952,7 +952,7 @@ type UiRenderSuccessEventProps = CommonEventProps & {
   status: CardType;
 };
 
-// @public
+// @public @deprecated
 export const useSmartLinkAnalytics: (
   url: string,
   dispatchAnalytics: AnalyticsHandler,

package/tmp/api-report-tmp.d.ts

@@ -193,7 +193,7 @@ export { CardPlatform }
 
 // @public (undocumented)
 export interface CardProps extends WithAnalyticsEventsProps {
-    // (undocumented)
+    // @deprecated (undocumented)
     analyticsEvents?: AnalyticsFacade;
     // (undocumented)
     appearance: CardAppearance;
@@ -815,7 +815,7 @@ type UiRenderSuccessEventProps = CommonEventProps & {
     status: CardType;
 };
 
-// @public
+// @public @deprecated
 export const useSmartLinkAnalytics: (url: string, dispatchAnalytics: AnalyticsHandler, id?: string | undefined, defaultLocation?: string | undefined) => {
     ui: {
         authEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiAuthEventProps) => void;