@atlaskit/smart-card 26.34.1 → 26.34.3

package/dist/types-ts4.5/model/invoke-opts.d.ts

@@ -1,17 +0,0 @@
-import { InvokePayload, ServerActionOpts } from '@atlaskit/linking-common';
-import { CardInnerAppearance } from '../view/Card/types';
-export type InvokeType = 'server' | 'client';
-export type InvokeOpts<T> = {
-    type: InvokeType;
-    source?: CardInnerAppearance;
-} & InvokePayload<T>;
-export type InvokeClientOpts = InvokeOpts<ClientActionOpts> & {
-    type: 'client';
-};
-export type InvokeServerOpts = InvokeOpts<ServerActionOpts> & {
-    type: 'server';
-};
-export interface ClientActionOpts {
-    type: string;
-    promise: () => Promise<void>;
-}

package/dist/types-ts4.5/ssr.d.ts

@@ -1,6 +0,0 @@
-import { FC } from 'react';
-import type { CardProps } from './types';
-export type CardSSRProps = CardProps & {
-    url: string;
-};
-export declare const CardSSR: FC<CardSSRProps>;

package/dist/types-ts4.5/state/actions/constants.d.ts

@@ -1,6 +0,0 @@
-export declare const ANALYTICS_RESOLVING = "resolving";
-export declare const ANALYTICS_ERROR = "errored";
-export declare const ANALYTICS_FALLBACK = "fallback";
-export declare const ERROR_MESSAGE_OAUTH = "Provider.authFlow is not set to OAuth2.";
-export declare const ERROR_MESSAGE_FATAL = "Fatal error resolving URL";
-export declare const ERROR_MESSAGE_METADATA = "Error resolving metadata.";

package/dist/types-ts4.5/state/actions/index.d.ts

@@ -1,11 +0,0 @@
-import { JsonLd } from 'json-ld-types';
-import { InvokeServerOpts, InvokeClientOpts } from '../../model/invoke-opts';
-import { AnalyticsFacade } from '../analytics';
-import { CardInnerAppearance } from '../../view/Card/types';
-export declare const useSmartCardActions: (id: string, url: string, analytics: AnalyticsFacade) => {
-    register: () => Promise<void>;
-    reload: () => void;
-    authorize: (appearance: CardInnerAppearance) => void;
-    invoke: (opts: InvokeClientOpts | InvokeServerOpts, appearance: CardInnerAppearance) => Promise<JsonLd.Response | void>;
-    loadMetadata: () => Promise<void> | undefined;
-};

package/dist/types-ts4.5/state/actions/types.d.ts

@@ -1,2 +0,0 @@
-import { CardActionType } from '@atlaskit/linking-common';
-export type { CardActionType };

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

@@ -1,3 +0,0 @@
-export { startUfoExperience, succeedUfoExperience, failUfoExperience, addMetadataToExperience, } from './ufoExperiences';
-export { useSmartLinkAnalytics } from './useSmartLinkAnalytics';
-export type { AnalyticsFacade } from './useSmartLinkAnalytics';

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

@@ -1,9 +0,0 @@
-import { DestinationSubproduct, DestinationProduct } from '../../utils/analytics/types';
-export interface CommonEventProps {
-    definitionId?: string;
-    extensionKey?: string;
-    resourceType?: string;
-    destinationSubproduct?: DestinationSubproduct | string;
-    destinationProduct?: DestinationProduct | string;
-    location?: string;
-}

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

@@ -1,7 +0,0 @@
-import { CustomData } from '@atlaskit/ufo';
-type UfoExperienceName = 'smart-link-rendered' | 'smart-link-authenticated' | 'smart-link-action-invocation';
-export declare const startUfoExperience: (experienceName: UfoExperienceName, id: string, properties?: CustomData) => void;
-export declare const succeedUfoExperience: (experienceName: UfoExperienceName, id: string, properties?: CustomData) => void;
-export declare const failUfoExperience: (experienceName: UfoExperienceName, id: string, properties?: CustomData) => void;
-export declare const addMetadataToExperience: (experienceName: UfoExperienceName, id: string, properties: CustomData) => void;
-export {};

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

@@ -1,11 +0,0 @@
-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) => {
-    dispatchAnalytics: AnalyticsHandler;
-};

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

@@ -1,8 +0,0 @@
-/// <reference types="react" />
-export declare enum ClickButton {
-    Left = 0,
-    Middle = 1,
-    Right = 2
-}
-export declare const useLinkClicked: <T extends import("react").MouseEventHandler<Element>>(handler?: T | undefined, predicate?: ((event: React.MouseEvent) => boolean) | undefined) => (...args: Parameters<T>) => void;
-export declare const useMouseDownEvent: <T extends import("react").MouseEventHandler<Element>>(onMouseDown?: T | undefined) => (...args: Parameters<T>) => void;

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

@@ -1,292 +0,0 @@
-import { AnalyticsHandler, AnalyticsName, AnalyticsPayload } from '../../utils/types';
-import { ConnectFailedEventProps, ConnectSucceededEventProps, InstrumentEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiIframeDwelledEventProps, UiIframeFocusedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps, UiServerActionClickedEventProps } from '../../utils/analytics/types';
-import { TrackQuickActionFailureReason, TrackQuickActionType } from '../../utils/analytics/analytics';
-import { SmartLinkActionType } from '@atlaskit/linking-types';
-/**
- * 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
- * @param defaultLocation location attribute to be used
- * @returns
- */
-export declare const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: AnalyticsHandler, id?: string, defaultLocation?: string) => {
-    ui: {
-        /**
-         * This fires an event that represents when a user clicks on the authentication
-         * call to action with no current authenticated account. (i.e. Connect to Preview).
-         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @returns
-         */
-        authEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiAuthEventProps) => void;
-        /**
-         * This fires an event that represents when a user clicks on the authentication
-         * call to action with a forbidden authenticated account. (i.e. Try another account).
-         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @returns
-         */
-        authAlternateAccountEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, 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.
-         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-         * @param status What status the Smart Link is currently in (e.g. resolved, unresolved)
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param isModifierKeyPressed Whether a modifier key was pressed when clicking the Smart Link.
-         * @param location Where the Smart Link is currently rendered.
-         * @param destinationProduct The product the Smart Link is linked to.
-         * @returns
-         */
-        cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: UiCardClickedEventProps) => void;
-        /**
-         * This fires an event that represents when a user dwells their cursor on a Smart Link's iframe.
-         * @param id The unique ID for this Smart Link.
-         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-         * @param status What status the Smart Link is currently in (e.g. resolved, unresolved)
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param location Where the Smart Link is currently rendered.
-         * @param destinationProduct The product the Smart Link is linked to.
-         * @param dwellTime Total seconds that the user has dwelled on this iframe
-         * @param dwellPercentVisible Percentage element was visible at end of dwell
-         * @returns
-         */
-        iframeDwelledEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, dwellTime, dwellPercentVisible, }: UiIframeDwelledEventProps) => void;
-        /**
-         * This fires an event that represents when a user clicks or tabs into a Smart Link's iframe.
-         * @param id The unique ID for this Smart Link.
-         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-         * @param status What status the Smart Link is currently in (e.g. resolved, unresolved)
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param location Where the Smart Link is currently rendered.
-         * @param destinationProduct The product the Smart Link is linked to.
-         * @returns
-         */
-        iframeFocusedEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, }: UiIframeFocusedEventProps) => void;
-        /**
-         * This fires an event that represents when a user clicks on a Smart Link action.
-         * Note: This also starts the UFO smart-link-action-invocation experience.
-         * @param id The unique ID for this Smart Link.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param actionType The type of the action that was clicked, e.g. PreviewAction
-         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-         * @param invokeType @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-2681 Internal documentation for deprecation (no external access)}
-         * @returns
-         */
-        actionClickedEvent: ({ id, actionType, display, extensionKey: overrideExtensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiActionClickedEventProps) => void;
-        /**
-         * This fires an event that represents when a user clicks on a hover preview's "navigate to link" button.
-         * https://product-fabric.atlassian.net/wiki/spaces/EM/pages/3206743323/Analytics+Metrics+-+Hover+Previews
-         * @param previewDisplay What format the preview is in.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param previewInvokeMethod How the preview was triggered.
-         */
-        hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardOpenLinkClickedEventProps) => void;
-        /**
-         * This fires an event that represents when a user closed the authentication window without authenticating after opening it.
-         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @returns
-         */
-        closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, 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.
-         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-         * @param id The unique ID for this Smart Link.
-         * @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
-         */
-        renderSuccessEvent: ({ display, status, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, canBeDatasource, }: UiRenderSuccessEventProps) => void;
-        /**
-         * This fires an event that represents when a Smart Link renders unsuccessfuly.
-         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-         * @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.
-         */
-        renderFailedEvent: ({ display, id, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => void;
-        /**
-         * This fires an event that represents a hover preview being opened.
-         * @param hoverDisplay Whether the hover preview was displayed as a card or embed.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param previewInvokeMethod How the preview was triggered.
-         * @returns
-         */
-        hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: UiHoverCardViewedEventProps) => void;
-        /**
-         * This fires an event that represents a hover preview being dismissed.
-         * @param hoverDisplay Whether the hover preview was displayed as a card or embed.
-         * @param hoverTime The duration that the user hovered over a Smart Link before the preview was dismissed.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resolver invoked.
-         * @param previewInvokeMethod How the preview was triggered.
-         * @returns
-         */
-        hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: UiHoverCardDismissedEventProps) => void;
-        /**
-         * Fires an event that signifies that a "Learn More" link was clicked on an unauthenticated card
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param location The location where a link is displayed (jiraWebLinks, confluencePages etc)
-         */
-        learnMoreClickedEvent: () => void;
-        /**
-         * Fires an event that represent a click was performed on a Status Lozenge
-         */
-        smartLinkLozengeActionClickedEvent: () => void;
-        /**
-         * Fires an event that represent a click was performed on a Status Lozenge's dropdown item
-         */
-        smartLinkLozengeActionListItemClickedEvent: () => void;
-        /**
-         * Fires an event that represent a click was performed on a Status Lozenge open preview button
-         */
-        smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
-        smartLinkServerActionClickedEvent: (props: UiServerActionClickedEventProps) => void;
-    };
-    operational: {
-        /**
-         * This fires an event that represents an action being successfully invoked.
-         * @param id The unique ID for this Smart Link.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param actionType The type of action invoked, e.g. PreviewAction
-         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-         */
-        invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeSucceededEventProps) => void;
-        /**
-         * This fires an event that represents an action being unsuccessfully invoked.
-         * @param id The unique ID for this Smart Link.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param actionType The type of action invoked, e.g. PreviewAction
-         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-         * @param reason The reason the invocation failed.
-         */
-        invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeFailedEventProps) => void;
-        /**
-         * This fires an event that represents an account successfully being connected via a Smart Link.
-         * @param id The unique ID for this Smart Link.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         */
-        connectSucceededEvent: ({ id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ConnectSucceededEventProps) => void;
-        /**
-         * This fires an event that represents an account unsuccessfully being connected.
-         * @param id The unique ID for this Smart Link.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param reason The reason why the Smart Link connect account failed.
-         */
-        connectFailedEvent: ({ id, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ConnectFailedEventProps) => void;
-        /**
-         * This fires an event which represents a Smart Link request succeeding or failing based on the status.
-         * @param id The unique ID for this Smart Link.
-         * @param status The status of the Smart Link.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param resourceType The type of resource that was invoked. This is provider specific (e.g. File, PullRequest).
-         * @param error An error representing why the Smart Link request failed.
-         */
-        instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: InstrumentEventProps) => void;
-        /**
-         * This fires an event that represents when a Smart Link renders unsuccessfuly.
-         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-         * @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.
-         */
-        chunkloadFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => void;
-    };
-    track: {
-        /**
-         * This fires an event which represents a user connecting their account to view a Smart Link.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @returns
-         */
-        appAccountConnected: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: TrackAppAccountConnectedProps) => void;
-        /**
-         * This fires an event which represents a user starting the Smart Link connect account process.
-         * @param location a location where the Smart Link auth action was initiated.
-         * @param extensionKey The extensionKey of the Smart Link resolver invoked.
-         * @returns
-         */
-        appAccountAuthStarted: ({ extensionKey, location, }: TrackAppAccountConnectedProps) => void;
-        /**
-         * Removed in EDM-5153: This is an even from an experiment.
-         * @deprecated
-         */
-        linkUpdated: () => void;
-        /**
-         * This fires a tracking event before an action invoke api call is made
-         */
-        smartLinkQuickActionStarted: (props: {
-            smartLinkActionType: SmartLinkActionType | TrackQuickActionType;
-        }) => void;
-        /**
-         * This fires a tracking event after an action invoke api call is successful
-         */
-        smartLinkQuickActionSuccess: (props: {
-            smartLinkActionType: SmartLinkActionType | TrackQuickActionType;
-        }) => void;
-        /**
-         * This fires a tracking event after an action invoke api call has failed
-         */
-        smartLinkQuickActionFailed: (props: {
-            smartLinkActionType: SmartLinkActionType | TrackQuickActionType;
-            reason?: TrackQuickActionFailureReason;
-            step?: string;
-        }) => void;
-        /**
-         * Fires a track event when we call loadMetadata() to get information for a hover card
-         */
-        hoverCardResolutionStarted: () => void;
-    };
-    screen: {
-        /**
-         * This fires an event which represents the connect account page being opened.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @returns
-         */
-        authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, 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;
-    };
-};
-export type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;

package/dist/types-ts4.5/state/config/index.d.ts

@@ -1,2 +0,0 @@
-import { CardContext } from '@atlaskit/link-provider';
-export declare const useSmartLinkConfig: () => CardContext['config'] | undefined;

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

@@ -1,21 +0,0 @@
-/// <reference types="react" />
-import type { FlexibleAnalyticsContextType, FlexibleUiDataContext } from './types';
-import { FlexibleUiOptions } from '../../view/FlexibleCard/types';
-/**
- * This provides the data that will be used by Smart Links Flexible UI to populate it's
- * underlying elements.
- */
-export declare const FlexibleUiContext: import("react").Context<FlexibleUiDataContext | undefined>;
-export declare const useFlexibleUiContext: () => FlexibleUiDataContext | undefined;
-/**
- * This provides the data that will be used by Smart Links Flexible UI to populate it's
- * underlying elements.
- */
-export declare const FlexibleUiAnalyticsContext: import("react").Context<FlexibleAnalyticsContextType | undefined>;
-export declare const useFlexibleUiAnalyticsContext: () => FlexibleAnalyticsContextType | undefined;
-/**
- * This provides the ui options that will be used by Smart Links Flexible UI
- * to render its underlying elements.
- */
-export declare const FlexibleUiOptionContext: import("react").Context<FlexibleUiOptions | undefined>;
-export declare const useFlexibleUiOptionContext: () => FlexibleUiOptions | undefined;