@atlaskit/smart-card 32.7.8 → 32.7.9

package/dist/types-ts4.5/common/analytics/generated/analytics.types.d.ts

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::1e6835b50307a44a077c38d864a2c66e>>
+ * @codegen <<SignedSource::84c7074821df29c52dd13557dab19219>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen smart-card
  */
 export type PackageMetaDataContextType = {
@@ -126,6 +126,10 @@ export type SmartLinkQuickActionFailedAttributesType = {
 export type ConsentModalViewedAttributesType = {
     definitionId: string | null;
 };
+export type EmbedPreviewModalViewedAttributesType = {
+    origin: 'smartLinkCard' | 'smartLinkEmbed' | 'smartLinkInline' | 'smartLinkPreviewHoverCard' | null;
+    size: 'large' | 'small' | null;
+};
 export type SmartLinkConnectSucceededAttributesType = {
     definitionId: string | null;
 };
@@ -200,6 +204,11 @@ export type ConsentModalClosedAttributesType = {
     display: 'inline' | 'block' | 'embed' | 'embedPreview' | 'flexible' | 'hoverCardPreview';
     definitionId: string | null;
 };
+export type ModalClosedEmbedPreviewAttributesType = {
+    origin: 'smartLinkCard' | 'smartLinkEmbed' | 'smartLinkInline' | 'smartLinkPreviewHoverCard' | null;
+    previewTime: number | null;
+    size: 'large' | 'small' | null;
+};
 export type ButtonClickedLearnMoreAttributesType = {};
 export type ButtonClickedSmartLinkStatusLozengeAttributesType = {};
 export type ButtonClickedSmartLinkStatusListItemAttributesType = {};
@@ -214,7 +223,6 @@ export type ButtonClickedEmbedPreviewResizeAttributesType = {
 };
 export type SmartLinkRenderSuccessAttributesType = {
     display: 'inline' | 'block' | 'embed' | 'embedPreview' | 'flexible' | 'hoverCardPreview';
-    definitionId: string | null;
 };
 export type SmartLinkRenderFailedAttributesType = {
     display: 'inline' | 'block' | 'embed' | 'embedPreview' | 'flexible' | 'hoverCardPreview';
@@ -301,6 +309,9 @@ export type AnalyticsEventAttributes = {
     /**
      * fires an event which represents the connect account page being opened. */
     'screen.consentModal.viewed': ConsentModalViewedAttributesType;
+    /**
+     * Fires an event that represents when a user view a modal. */
+    'screen.embedPreviewModal.viewed': EmbedPreviewModalViewedAttributesType;
     /**
      * fires an event that represents an account successfully being connected via a Smart Link. */
     'operational.smartLink.connectSucceeded': SmartLinkConnectSucceededAttributesType;
@@ -343,6 +354,9 @@ export type AnalyticsEventAttributes = {
     /**
      * fires an event that represents when a user closed the authentication window without authenticating after opening it. */
     'ui.consentModal.closed': ConsentModalClosedAttributesType;
+    /**
+     * Fires an event that represents when a user close a modal. */
+    'ui.modal.closed.embedPreview': ModalClosedEmbedPreviewAttributesType;
     /**
      * fires an event that signifies that a "Learn More" link was clicked on an unauthenticated card */
     'ui.button.clicked.learnMore': ButtonClickedLearnMoreAttributesType;

package/dist/types-ts4.5/state/analytics/useSmartLinkAnalytics.d.ts

@@ -15,6 +15,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * This fires an event that represents when a user
          * click a button.
          * @param data A partial analytics event payload
+         * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
          */
         buttonClickedEvent: (data: Partial<AnalyticsPayload> & {
             actionSubjectId: Required<string>;
@@ -32,6 +33,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
         /**
          * This fires an event that represents when a user close a modal.
          * @param data A partial analytics event payload
+         * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
          */
         modalClosedEvent: (data: Partial<AnalyticsPayload> & {
             actionSubjectId: Required<string>;
@@ -44,6 +46,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param definitionId The definitionId of the Smart Link resolver invoked.
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @param canBeDatasource An indicator that shows that a smart link can be converted to a datasource
+         * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
          */
         renderSuccessEvent: ({ display, status, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, canBeDatasource, }: UiRenderSuccessEventProps) => void;
         /**
@@ -52,6 +55,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param id The unique ID for this Smart Link.
          * @param error: An error representing why the Smart Link render failed.
          * @param errorInfo: Additional details about the error including the stack trace.
+         * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
          */
         renderFailedEvent: ({ display, id, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => void;
     };
@@ -77,7 +81,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
     screen: {
         /**
          * This fires an event that represents when a user view a modal.
-         * @param data A partial analytics event payload
+         * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
          */
         modalViewedEvent: (data: Partial<AnalyticsPayload> & {
             name: Extract<AnalyticsName, 'embedPreviewModal'>;

package/dist/types-ts4.5/utils/analytics/SmartLinkAnalyticsContext.d.ts

@@ -1,4 +1,6 @@
 import React from 'react';
+import { getResolvedAttributes } from '@atlaskit/link-analytics/resolved-attributes';
+import { context } from './analytics';
 type SmartLinkAnalyticsContextProps = {
     url: string;
     display?: string;
@@ -6,6 +8,18 @@ type SmartLinkAnalyticsContextProps = {
     source?: string;
     children?: React.ReactNode;
 };
+type SmartLinkAnalyticsContextType = {
+    source?: string;
+    attributes?: typeof context & ReturnType<typeof getResolvedAttributes> & {
+        display?: string;
+        id?: string;
+    };
+};
+/**
+ * Provides an analytics context data to supply attributes to events based on a URL
+ * and the link state in the store
+ */
+export declare const useSmartLinkAnalyticsContext: ({ display, id, source, url, }: Exclude<SmartLinkAnalyticsContextProps, 'children'>) => SmartLinkAnalyticsContextType | undefined;
 /**
  * Provides an analytics context to supply attributes to events based on a URL
  * and the link state in the store

package/dist/types-ts4.5/view/EmbedModal/components/analytics/types.d.ts

@@ -3,5 +3,6 @@ import { type AnalyticsOrigin } from '../../../../utils/types';
 export type WithAnalytics = {
     analytics?: AnalyticsFacade;
     extensionKey?: string;
+    id?: string;
     origin?: AnalyticsOrigin;
 };

package/dist/types-ts4.5/view/HoverCard/components/HoverCardComponent.d.ts

@@ -1,3 +1,4 @@
 import { jsx } from '@emotion/react';
 import { type HoverCardComponentProps } from '../types';
+export declare const HOVER_CARD_SOURCE = "smartLinkPreviewHoverCard";
 export declare const HoverCardComponent: ({ children, url, id, canOpen, closeOnChildClick, actionOptions, allowEventPropagation, zIndex, noFadeDelay, hoverPreviewOptions, }: HoverCardComponentProps) => jsx.JSX.Element;

package/package.json

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