@atlaskit/smart-card 32.7.0 → 32.7.1

package/dist/types-ts4.5/state/flexible-ui-context/types.d.ts

@@ -1,8 +1,10 @@
 import { type LinkPerson } from '@atlaskit/link-extractors';
 import { type ActionName, type IconType, type InternalActionName, type MediaType } from '../../constants';
 import { type LinkLozenge } from '../../extractors/common/lozenge/types';
-import type { CardInnerAppearance } from '../../view/Card/types';
-import type { AnalyticsFacade } from '../analytics';
+import { type AnalyticsOrigin } from '../../utils/types';
+import { type CardInnerAppearance } from '../../view/Card/types';
+import { type AnalyticsFacade } from '../analytics';
+import { type InvokeClientActionProps } from '../hooks/use-invoke-client-action/types';
 import { type InvokeRequestWithCardDetails } from '../hooks/use-invoke/types';
 /**
  * This provides the data that will be used by Smart Links Flexible UI to populate it's
@@ -250,9 +252,11 @@ export type FlexibleUiActions = {
     [InternalActionName.ViewRelatedLinksAction]?: ViewRelatedLinksActionData;
 };
 export type PreviewActionData = {
+    invokeAction?: InvokeClientActionProps;
     downloadUrl?: string;
     linkIcon?: Icon;
     providerName?: string;
+    origin?: AnalyticsOrigin;
     src?: string;
     title?: string;
     url?: string;
@@ -263,10 +267,12 @@ export type ViewActionData = {
     viewUrl?: string;
 };
 export type DownloadActionData = {
+    invokeAction?: InvokeClientActionProps;
     downloadUrl?: string;
 };
 export type CopyLinkActionData = {
-    url: string;
+    invokeAction?: InvokeClientActionProps;
+    url?: string;
 };
 export type AISummaryActionData = {
     url: string;

package/dist/types-ts4.5/state/hooks/use-invoke/types.d.ts

@@ -1,5 +1,6 @@
-import type { InvokeRequest } from '@atlaskit/linking-types/smart-link-actions';
+import { type InvokeRequest } from '@atlaskit/linking-types/smart-link-actions';
 import { type PreviewActionData } from '../../flexible-ui-context/types';
+import type { InvokeClientActionProps } from '../use-invoke-client-action/types';
 /**
  * Additional details for invoke function that may be required for component
  */
@@ -8,12 +9,17 @@ export type CardDetails = {
      * An identifier for Smart Link analytics
      */
     id?: string;
+    /**
+     * A open embed modal action to invoke with useInvokeClientAction
+     */
+    invokePreviewAction?: InvokeClientActionProps;
     /**
      * The URL of the Smart Link
      */
     url?: string;
     /**
      * Preview Modal information. If present, will be used to render an embed modal on an error link click
+     * TODO: Remove on cleanup of platform-smart-card-migrate-embed-modal-analytics
      */
     previewData?: PreviewActionData | null;
 };

package/dist/types-ts4.5/state/hooks/use-invoke-client-action/index.d.ts

@@ -1,6 +1,6 @@
-import type { InvokeClientActionHandler, UseInvokeClientActionProps } from './types';
+import { type InvokeClientActionHandler, type UseInvokeClientActionProps } from './types';
 /**
  * Invoke client action such as preview, download and open link
  */
-declare const useInvokeClientAction: ({ analytics, }: UseInvokeClientActionProps) => InvokeClientActionHandler;
+declare const useInvokeClientAction: ({ analytics, fireEvent: fireEventProp, }: UseInvokeClientActionProps) => InvokeClientActionHandler;
 export default useInvokeClientAction;

package/dist/types-ts4.5/state/hooks/use-invoke-client-action/types.d.ts

@@ -1,20 +1,34 @@
-import type { CardInnerAppearance } from '../../../view/Card/types';
-import type { AnalyticsFacade } from '../../analytics';
+import { type FireEventFunction } from '../../../common/analytics/types';
+import { type CardInnerAppearance } from '../../../view/Card/types';
+import { type AnalyticsFacade } from '../../analytics';
 export type UseInvokeClientActionProps = {
     /**
      * Analytics object
      */
     analytics?: AnalyticsFacade;
+    /**
+     * A function to dispatch analytics events.
+     */
+    fireEvent?: FireEventFunction;
 };
+export type InvokeClientActionSubjectId = 'copyLink' | 'downloadDocument' | 'invokePreviewScreen' | 'shortcutGoToLink';
 export type InvokeClientActionProps = {
     /**
      * Invoke action to execute.
      */
     actionFn: () => Promise<void>;
+    /**
+     * Invoke action subject id for analytics purposes.
+     */
+    actionSubjectId?: InvokeClientActionSubjectId;
     /**
      * Invoke action type for analytics purposes.
      */
     actionType: string;
+    /**
+     * Definition id for analytics purposes.
+     */
+    definitionId?: string;
     /**
      * Smart card display type
      * This value should already be set in analytics context.
@@ -27,5 +41,13 @@ export type InvokeClientActionProps = {
      * useSmartLinkAnalytics() and/or into the analytic context.
      */
     extensionKey?: string;
+    /**
+     * ID for analytics purposes.
+     */
+    id?: string;
+    /**
+     * Resource type for analytics purposes.
+     */
+    resourceType?: string;
 };
 export type InvokeClientActionHandler = (opts: InvokeClientActionProps) => Promise<void>;

package/dist/types-ts4.5/state/hooks/use-resolve/index.d.ts

@@ -1,2 +1,3 @@
 declare const useResolve: () => (url: string, isReloading?: any, isMetadataRequest?: any, id?: any) => Promise<void>;
 export default useResolve;
+export type ResolveFunction = ReturnType<typeof useResolve>;

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

@@ -2,10 +2,18 @@ import React from 'react';
 import { EmbedModalSize } from './types';
 declare const _default: (props: {
     download?: string | undefined;
+    fireEvent?: (<K extends keyof import("../../common/analytics/generated/analytics.types").AnalyticsEventAttributes>(eventKey: K, ...params_1: undefined extends import("../../common/analytics/generated/analytics.types").AnalyticsEventAttributes[K] ? [
+        param?: import("../../common/analytics/generated/analytics.types").AnalyticsEventAttributes[K] | undefined
+    ] : [
+        param: import("../../common/analytics/generated/analytics.types").AnalyticsEventAttributes[K]
+    ]) => void) | undefined;
     icon?: import("../common/Icon").IconProps | undefined;
+    invokeDownloadAction?: import("../../state/hooks/use-invoke-client-action/types").InvokeClientActionProps | undefined;
+    invokeViewAction?: import("../../state/hooks/use-invoke-client-action/types").InvokeClientActionProps | undefined;
     iframeName: string;
     isTrusted?: boolean | undefined;
     isSupportTheming?: boolean | undefined;
+    linkIcon?: import("../../state/flexible-ui-context/types").Icon | undefined;
     onClose: (context: import("./types").EmbedModalContext) => void;
     onOpen?: ((context: import("./types").EmbedModalContext) => void) | undefined;
     onOpenFailed?: ((error: Error, errorInfo: React.ErrorInfo) => void) | undefined;

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

@@ -1,4 +1,7 @@
 import { type ErrorInfo } from 'react';
+import { type FireEventFunction } from '../../common/analytics/types';
+import { type Icon } from '../../state/flexible-ui-context/types';
+import { type InvokeClientActionProps } from '../../state/hooks/use-invoke-client-action/types';
 import { type IconProps } from '../common/Icon';
 import { type WithAnalytics } from './components/analytics/types';
 export declare enum EmbedModalSize {
@@ -11,10 +14,14 @@ export type EmbedModalContext = {
 };
 export type EmbedModalProps = {
     download?: string;
+    fireEvent?: FireEventFunction;
     icon?: IconProps;
+    invokeDownloadAction?: InvokeClientActionProps;
+    invokeViewAction?: InvokeClientActionProps;
     iframeName: string;
     isTrusted?: boolean;
     isSupportTheming?: boolean;
+    linkIcon?: Icon;
     onClose: (context: EmbedModalContext) => void;
     onOpen?: (context: EmbedModalContext) => void;
     onOpenFailed?: (error: Error, errorInfo: ErrorInfo) => void;

package/dist/types-ts4.5/view/FlexibleCard/components/elements/lozenge/lozenge-action/lozenge-action-error/index.d.ts

@@ -1,4 +1,4 @@
 import { jsx } from '@emotion/react';
 import type { LozengeActionErrorProps } from './types';
-declare const LozengeActionError: ({ errorMessage, testId, maxLineNumber, url, previewData, }: LozengeActionErrorProps) => jsx.JSX.Element;
+declare const LozengeActionError: ({ errorMessage, testId, maxLineNumber, invokePreviewAction, url, previewData, }: LozengeActionErrorProps) => jsx.JSX.Element;
 export default LozengeActionError;

package/dist/types-ts4.5/view/FlexibleCard/components/elements/lozenge/lozenge-action/lozenge-action-error/types.d.ts

@@ -1,10 +1,15 @@
 import { type PreviewActionData } from '../../../../../../../state/flexible-ui-context/types';
+import { type InvokeClientActionProps } from '../../../../../../../state/hooks/use-invoke-client-action/types';
 import { type MessageProps } from '../../../../types';
 export type LozengeActionErrorProps = {
     /**
      * Error message to be displayed inside the dropdown
      */
     errorMessage: string | MessageProps;
+    /**
+     * A preview link action to invoke with useInvokeClientAction
+     */
+    invokePreviewAction?: InvokeClientActionProps;
     /**
      * Data test id used for testing purposes
      */
@@ -19,6 +24,7 @@ export type LozengeActionErrorProps = {
     url?: string;
     /**
      * Preview Modal information. If present, will be used to render an embed modal on an error link click
+     * TODO: Remove on cleanup of platform-smart-card-migrate-embed-modal-analytics
      */
     previewData?: PreviewActionData | null;
 };

package/dist/types-ts4.5/view/FlexibleCard/components/utils.d.ts

@@ -29,4 +29,7 @@ export declare const getPrimitivesInlineSpaceBySize: (size: SmartLinkSize) => Sp
 export declare const getPrimitivesPaddingSpaceBySize: (size: SmartLinkSize) => Space;
 export declare const getTruncateStyles: (maxLines: number, lineHeight?: string, wordBreak?: 'break-word' | 'break-all') => SerializedStyles;
 export declare const hasWhiteSpace: (str: string) => boolean;
+/**
+ * TODO: Remove on cleanup of platform-smart-card-migrate-embed-modal-analytics
+ */
 export declare const openEmbedModalWithFlexibleUiIcon: ({ linkIcon, ...props }: Partial<EmbedModalProps> & Pick<PreviewActionData, 'linkIcon'>) => Promise<void>;

package/dist/types-ts4.5/view/FlexibleCard/index.d.ts

@@ -6,5 +6,5 @@ import { type FlexibleCardProps } from './types';
  * Note: TitleBlock is mandatory for a Flexible Card to render.
  * @see Container
  */
-declare const FlexibleCard: ({ analytics, appearance, cardState, children, id, onAuthorize, onClick, onError, onResolve, renderers, showAuthTooltip, showHoverPreview, hoverPreviewOptions, actionOptions, testId, ui, url, }: FlexibleCardProps) => JSX.Element;
+declare const FlexibleCard: ({ analytics, appearance, cardState, children, id, onAuthorize, onClick, onError, onResolve, origin, renderers, showAuthTooltip, showHoverPreview, hoverPreviewOptions, actionOptions, testId, ui, url, }: FlexibleCardProps) => JSX.Element;
 export default FlexibleCard;

package/dist/types-ts4.5/view/FlexibleCard/types.d.ts

@@ -1,12 +1,15 @@
 /// <reference types="react" />
-import type { JsonLd } from 'json-ld-types';
+import { type JsonLd } from 'json-ld-types';
 import { type MessageDescriptor } from 'react-intl-next';
 import { type CardProviderRenderers } from '@atlaskit/link-provider';
 import { type CardState, type LinkingPlatformFeatureFlags } from '@atlaskit/linking-common';
+import { type FireEventFunction } from '../../common/analytics/types';
 import { type SmartLinkSize, type SmartLinkStatus, type SmartLinkTheme } from '../../constants';
 import { type AnalyticsFacade } from '../../state/analytics';
 import { type AISummaryConfig } from '../../state/hooks/use-ai-summary-config/types';
-import type { CardActionOptions, CardInnerAppearance, OnResolveCallback } from '../Card/types';
+import { type ResolveFunction } from '../../state/hooks/use-resolve';
+import { type AnalyticsOrigin } from '../../utils/types';
+import { type CardActionOptions, type CardInnerAppearance, type OnResolveCallback } from '../Card/types';
 import { type HoverPreviewOptions } from '../HoverCard/types';
 import { type OnErrorCallback } from '../types';
 export type FlexibleCardProps = {
@@ -53,6 +56,10 @@ export type FlexibleCardProps = {
      * function to be called after a flexible card has rendered its resolved state
      */
     onResolve?: OnResolveCallback;
+    /**
+     * Smart links origin for analytics purposes
+     */
+    origin?: AnalyticsOrigin;
     /**
      * Any additional renderers required by Flexible UI. Currently used by icon
      * to render Emoji.
@@ -142,9 +149,11 @@ export type RetryOptions = {
      */
     values?: Record<string, string>;
 };
-export type ExtractFlexibleUiDataContextParams = Pick<FlexibleCardProps, 'id' | 'actionOptions' | 'renderers' | 'url'> & {
+export type ExtractFlexibleUiDataContextParams = Pick<FlexibleCardProps, 'appearance' | 'id' | 'actionOptions' | 'origin' | 'renderers' | 'url'> & {
+    fireEvent?: FireEventFunction;
     status?: SmartLinkStatus;
     response?: JsonLd.Response;
+    resolve?: ResolveFunction;
     featureFlags?: Partial<LinkingPlatformFeatureFlags>;
     aiSummaryConfig?: AISummaryConfig;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "32.7.0",
+	"version": "32.7.1",
 	"description": "Smart card component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -177,6 +177,9 @@
 		"smart_links_for_plans_platform": {
 			"type": "boolean"
 		},
+		"platform-smart-card-migrate-embed-modal-analytics": {
+			"type": "boolean"
+		},
 		"platform_editor_hyperlink_underline": {
 			"type": "boolean"
 		}