@atlaskit/smart-card 25.4.4 → 25.5.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/smart-card
 
+## 25.5.0
+
+### Minor Changes
+
+- [`5329942b8aa`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5329942b8aa) - Deprecates analyticsHandler argument of useSmartLinkActions and useSmartLinkReload hooks.
+
 ## 25.4.4
 
 ### Patch Changes

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

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useDispatchAnalytics = void 0;
+var _react = require("react");
+var _analyticsNext = require("@atlaskit/analytics-next");
+var _analytics = require("../../utils/analytics");
+/**
+ * Hook designed to use a handler if provided (ideally not)
+ * Use this for the short-term to support deprecating `analyticsHandler`s that are being provided externally,
+ * but fallback to the dispatch provided by `useAnalyticsEvents`
+ *
+ * In future, potentially use this hook to feature flag the channel we are dispatching to
+ */
+var useDispatchAnalytics = function useDispatchAnalytics(handler) {
+  var _useAnalyticsEvents = (0, _analyticsNext.useAnalyticsEvents)(),
+    createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
+  return {
+    dispatchAnalytics: (0, _react.useMemo)(function () {
+      if (handler) {
+        return handler;
+      }
+      return function (payload) {
+        createAnalyticsEvent(payload).fire(_analytics.ANALYTICS_CHANNEL);
+      };
+    }, [handler, createAnalyticsEvent])
+  };
+};
+exports.useDispatchAnalytics = useDispatchAnalytics;

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

@@ -14,6 +14,7 @@ var _ufoExperiences = require("./ufoExperiences");
 var _helpers = require("../helpers");
 var _linkProvider = require("@atlaskit/link-provider");
 var _analytics2 = require("../../utils/analytics/analytics");
+var _useDispatchAnalytics2 = require("./useDispatchAnalytics");
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 var applyCommonAttributes = function applyCommonAttributes(event, commonAttributes) {
@@ -44,7 +45,9 @@ var applyCommonAttributes = function applyCommonAttributes(event, commonAttribut
  * @param defaultLocation location attribute to be used
  * @returns
  */
-var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytics, id, defaultLocation) {
+var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, _dispatchAnalytics, id, defaultLocation) {
+  var _useDispatchAnalytics = (0, _useDispatchAnalytics2.useDispatchAnalytics)(_dispatchAnalytics),
+    dispatchAnalytics = _useDispatchAnalytics.dispatchAnalytics;
   var defaultId = id || 'NULL';
   // We don't want to trigger a re-render by using useSmartCardState
   var _useSmartLinkContext = (0, _linkProvider.useSmartLinkContext)(),

package/dist/cjs/version.json

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

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

@@ -0,0 +1,25 @@
+import { useMemo } from 'react';
+import { useAnalyticsEvents } from '@atlaskit/analytics-next';
+import { ANALYTICS_CHANNEL } from '../../utils/analytics';
+/**
+ * Hook designed to use a handler if provided (ideally not)
+ * Use this for the short-term to support deprecating `analyticsHandler`s that are being provided externally,
+ * but fallback to the dispatch provided by `useAnalyticsEvents`
+ *
+ * In future, potentially use this hook to feature flag the channel we are dispatching to
+ */
+export const useDispatchAnalytics = handler => {
+  const {
+    createAnalyticsEvent
+  } = useAnalyticsEvents();
+  return {
+    dispatchAnalytics: useMemo(() => {
+      if (handler) {
+        return handler;
+      }
+      return payload => {
+        createAnalyticsEvent(payload).fire(ANALYTICS_CHANNEL);
+      };
+    }, [handler, createAnalyticsEvent])
+  };
+};

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

@@ -5,6 +5,7 @@ import { failUfoExperience, startUfoExperience, succeedUfoExperience } from './u
 import { getDefinitionId, getExtensionKey, getProduct, getResourceType, getSubproduct } from '../helpers';
 import { useSmartLinkContext } from '@atlaskit/link-provider';
 import { trackLinkUpdated, uiIframeDwelledEvent, uiIframeFocusedEvent } from '../../utils/analytics/analytics';
+import { useDispatchAnalytics } from './useDispatchAnalytics';
 const applyCommonAttributes = (event, commonAttributes) => {
   if (event && event.attributes) {
     for (const [key, value] of Object.entries(commonAttributes)) {
@@ -30,7 +31,10 @@ const applyCommonAttributes = (event, commonAttributes) => {
  * @param defaultLocation location attribute to be used
  * @returns
  */
-export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocation) => {
+export const useSmartLinkAnalytics = (url, _dispatchAnalytics, id, defaultLocation) => {
+  const {
+    dispatchAnalytics
+  } = useDispatchAnalytics(_dispatchAnalytics);
   const defaultId = id || 'NULL';
   // We don't want to trigger a re-render by using useSmartCardState
   const {

package/dist/es2019/version.json

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

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

@@ -0,0 +1,24 @@
+import { useMemo } from 'react';
+import { useAnalyticsEvents } from '@atlaskit/analytics-next';
+import { ANALYTICS_CHANNEL } from '../../utils/analytics';
+/**
+ * Hook designed to use a handler if provided (ideally not)
+ * Use this for the short-term to support deprecating `analyticsHandler`s that are being provided externally,
+ * but fallback to the dispatch provided by `useAnalyticsEvents`
+ *
+ * In future, potentially use this hook to feature flag the channel we are dispatching to
+ */
+export var useDispatchAnalytics = function useDispatchAnalytics(handler) {
+  var _useAnalyticsEvents = useAnalyticsEvents(),
+    createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
+  return {
+    dispatchAnalytics: useMemo(function () {
+      if (handler) {
+        return handler;
+      }
+      return function (payload) {
+        createAnalyticsEvent(payload).fire(ANALYTICS_CHANNEL);
+      };
+    }, [handler, createAnalyticsEvent])
+  };
+};

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

@@ -9,6 +9,7 @@ import { failUfoExperience, startUfoExperience, succeedUfoExperience } from './u
 import { getDefinitionId, getExtensionKey, getProduct, getResourceType, getSubproduct } from '../helpers';
 import { useSmartLinkContext } from '@atlaskit/link-provider';
 import { trackLinkUpdated, uiIframeDwelledEvent, uiIframeFocusedEvent } from '../../utils/analytics/analytics';
+import { useDispatchAnalytics } from './useDispatchAnalytics';
 var applyCommonAttributes = function applyCommonAttributes(event, commonAttributes) {
   if (event && event.attributes) {
     for (var _i = 0, _Object$entries = Object.entries(commonAttributes); _i < _Object$entries.length; _i++) {
@@ -37,7 +38,9 @@ var applyCommonAttributes = function applyCommonAttributes(event, commonAttribut
  * @param defaultLocation location attribute to be used
  * @returns
  */
-export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytics, id, defaultLocation) {
+export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, _dispatchAnalytics, id, defaultLocation) {
+  var _useDispatchAnalytics = useDispatchAnalytics(_dispatchAnalytics),
+    dispatchAnalytics = _useDispatchAnalytics.dispatchAnalytics;
   var defaultId = id || 'NULL';
   // We don't want to trigger a re-render by using useSmartCardState
   var _useSmartLinkContext = useSmartLinkContext(),

package/dist/esm/version.json

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

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

@@ -0,0 +1,11 @@
+import { AnalyticsHandler } from '../../';
+/**
+ * Hook designed to use a handler if provided (ideally not)
+ * Use this for the short-term to support deprecating `analyticsHandler`s that are being provided externally,
+ * but fallback to the dispatch provided by `useAnalyticsEvents`
+ *
+ * In future, potentially use this hook to feature flag the channel we are dispatching to
+ */
+export declare const useDispatchAnalytics: (handler?: AnalyticsHandler | undefined) => {
+    dispatchAnalytics: AnalyticsHandler;
+};

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

@@ -14,7 +14,7 @@ import { CommonEventProps, ConnectFailedEventProps, ConnectSucceededEventProps,
  * @param defaultLocation location attribute to be used
  * @returns
  */
-export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: AnalyticsHandler, id?: string | undefined, defaultLocation?: string | undefined) => {
+export declare const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: AnalyticsHandler | undefined, id?: string | undefined, defaultLocation?: string | undefined) => {
     ui: {
         /**
          * This fires an event that represents when a user clicks on the authentication

package/dist/types/state/hooks-external/useSmartLinkActions.d.ts

@@ -37,8 +37,11 @@ export interface UseSmartLinkActionsOpts {
     /**
      * Callback for sending analytics events.
      * @description Accepts an analytics payload and fires it to a system.
+     *
+     * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-2681 Internal documentation for deprecation (no external access)}
+     * Overriding the analytics dispatch method is deprecated. Please omit this property.
      */
-    analyticsHandler: AnalyticsHandler;
+    analyticsHandler?: AnalyticsHandler;
     /**
      * Platform on which actions are being invoked.
      * @default 'web'

package/dist/types/state/hooks-external/useSmartLinkReload.d.ts

@@ -8,8 +8,11 @@ export interface UseSmartLinkReloadOpts {
     /**
      * Callback for sending analytics events.
      * @description Accepts an analytics payload and fires it to a system.
+     *
+     * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-2681 Internal documentation for deprecation (no external access)}
+     * Overriding the analytics dispatch method is deprecated. Please omit this property.
      */
-    analyticsHandler: AnalyticsHandler;
+    analyticsHandler?: AnalyticsHandler;
 }
 /**
  * Exposes a programmatic way to reload the data being used to render a Smart Link.

package/package.json

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

package/report.api.md

@@ -955,7 +955,7 @@ type UiRenderSuccessEventProps = CommonEventProps & {
 // @public @deprecated
 export const useSmartLinkAnalytics: (
   url: string,
-  dispatchAnalytics: AnalyticsHandler,
+  _dispatchAnalytics?: AnalyticsHandler | undefined,
   id?: string | undefined,
   defaultLocation?: string | undefined,
 ) => {

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

@@ -816,7 +816,7 @@ type UiRenderSuccessEventProps = CommonEventProps & {
 };
 
 // @public @deprecated
-export const useSmartLinkAnalytics: (url: string, dispatchAnalytics: AnalyticsHandler, id?: string | undefined, defaultLocation?: string | undefined) => {
+export const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: AnalyticsHandler | undefined, id?: string | undefined, defaultLocation?: string | undefined) => {
     ui: {
         authEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiAuthEventProps) => void;
         authAlternateAccountEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiAuthAlternateAccountEventProps) => void;