@atlaskit/smart-card 22.0.0 → 22.1.0

package/package.json

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

package/report.api.md

@@ -115,12 +115,16 @@ export declare type AnalyticsActionSubject =
   | 'applicationAccount'
   | 'button'
   | 'consentModal'
-  | 'hoverCard';
+  | 'hoverCard'
+  | 'modal'
+  | 'embedPreviewModal';
 
 declare type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;
 
 export declare type AnalyticsHandler = (event: AnalyticsPayload) => void;
 
+declare type AnalyticsName = 'embedPreviewModal';
+
 export declare type AnalyticsPayload = GasPayload & {
   action?: AnalyticsAction;
   actionSubject: AnalyticsActionSubject;
@@ -278,8 +282,8 @@ export declare const Card: React_2.ForwardRefExoticComponent<
     | 'key'
     | 'url'
     | 'ui'
-    | 'showHoverPreview'
     | 'showActions'
+    | 'showHoverPreview'
     | 'onResolve'
     | 'platform'
     | 'isFrameVisible'
@@ -1129,6 +1133,16 @@ export declare const useSmartLinkAnalytics: (
       destinationSubproduct,
       location,
     }: UiAuthAlternateAccountEventProps) => void;
+    /**
+     * This fires an event that represents when a user
+     * click a button.
+     * @param data A partial analytics event payload
+     */
+    buttonClickedEvent: (
+      data: Partial<AnalyticsPayload> & {
+        actionSubjectId: Required<string>;
+      },
+    ) => void;
     /**
      * This fires an event that represents when a user clicks on a Smart Link.
      * @param id The unique ID for this Smart Link.
@@ -1208,6 +1222,15 @@ export declare const useSmartLinkAnalytics: (
       destinationSubproduct,
       location,
     }: UiClosedAuthEventProps) => void;
+    /**
+     * This fires an event that represents when a user close a modal.
+     * @param data A partial analytics event payload
+     */
+    modalClosedEvent: (
+      data: Partial<AnalyticsPayload> & {
+        actionSubjectId: Required<string>;
+      },
+    ) => void;
     /**
      * This fires an event that represents when a Smart Link was rendered successfully.
      * Note: this fires even if the Smart Link request errored out.
@@ -1410,6 +1433,15 @@ export declare const useSmartLinkAnalytics: (
       destinationSubproduct,
       location,
     }: ScreenAuthPopupEventProps) => void;
+    /**
+     * This fires an event that represents when a user view a modal.
+     * @param data A partial analytics event payload
+     */
+    modalViewedEvent: (
+      data: Partial<AnalyticsPayload> & {
+        name: Extract<AnalyticsName, 'embedPreviewModal'>;
+      },
+    ) => void;
   };
 };