@atlaskit/smart-card 25.3.3 → 25.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/smart-card
 
+## 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/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "25.3.3",
+	"version": "25.4.0",
 	"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/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "25.3.3",
+	"version": "25.4.0",
 	"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/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "25.3.3",
+	"version": "25.4.0",
 	"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/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.0",
   "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;