@atlaskit/smart-card 22.2.0 → 22.2.1

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

@@ -0,0 +1,195 @@
+import { AnalyticsHandler, AnalyticsName, AnalyticsPayload } from '../../utils/types';
+import { ConnectFailedEventProps, ConnectSucceededEventProps, InstrumentEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps } from '../../utils/analytics/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.
+ * @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 | undefined, defaultLocation?: string | undefined) => {
+    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 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 Whether the action invoked made a call to a server.
+         * @returns
+         */
+        actionClickedEvent: ({ id, actionType, display, invokeType, extensionKey, 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.
+         */
+        renderSuccessEvent: ({ display, status, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: 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, }: 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 resovler invoked.
+         * @param previewInvokeMethod How the preview was triggered.
+         * @returns
+         */
+        hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiHoverCardDismissedEventProps) => 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;
+    };
+    track: {
+        /**
+         * This fires an event which represents a user starting the Smart Link connect account process.
+         * @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;
+    };
+    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 declare type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;

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

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

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

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { FlexibleUiDataContext } from './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;

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

@@ -0,0 +1,159 @@
+import { LinkLozenge } from '../../extractors/common/lozenge/types';
+import { LinkPerson } from '@atlaskit/linking-common/extractors';
+import { IconType, MediaType } from '../../constants';
+/**
+ * This provides the data that will be used by Smart Links Flexible UI to populate it's
+ * underlying elements.
+ */
+export declare type FlexibleUiDataContext = {
+    /**
+     * An array containing data used to populate the AuthorGroup element.
+     * @see AvatarGroup
+     */
+    authorGroup?: LinkPerson[];
+    /**
+     * An array containing a @type {LinkPerson} used to populate the CollaboratorGroup element.
+     * @see CollaboratorGroup
+     */
+    collaboratorGroup?: LinkPerson[];
+    /**
+     * Contains the number of comments of the linked resource.
+     * @type number
+     * @see CommentCount
+     */
+    commentCount?: number;
+    /**
+     * Contains the ISO timestamp of when the resource was due.
+     * This value is mapped to JsonLD endTime.
+     * @type string - ISO Timestamp
+     * @see DueOn
+     */
+    dueOn?: string;
+    /**
+     * Contains the number of views of the linked resource.
+     * @type number
+     * @see ViewCount
+     */
+    viewCount?: number;
+    /**
+     * Contains the number of react of the linked resource.
+     * @type number
+     * @see ReactCount
+     */
+    reactCount?: number;
+    /**
+     * Contains the number of votes of the linked resource.
+     * @type number
+     * @see VoteCount
+     */
+    voteCount?: number;
+    /**
+     * Contains the name of the entity that created the resource.
+     * @type string
+     * @see CreatedBy
+     */
+    createdBy?: string;
+    /**
+     * Contains the ISO timestamp of when the resource was created.
+     * @type string - ISO Timestamp
+     * @see CreatedOn
+     */
+    createdOn?: string;
+    /**
+     * Contains the information about the latest commit in the repository
+     */
+    latestCommit?: string;
+    /**
+     * Contains the favicon of the resource.
+     * @type Icon
+     * @see LinkIcon
+     */
+    linkIcon?: Icon;
+    /**
+     * Contains the name of the entity that last modified the resource.
+     * @type string
+     * @see ModifiedBy
+     */
+    modifiedBy?: string;
+    /**
+     * Contains the ISO timestamp of when the resource was last modified.
+     * @type string - ISO Timestamp
+     * @see ModifiedOn
+     */
+    modifiedOn?: string;
+    /**
+     * Contains the preview (typically the thumbnail) of the resource.
+     * @type Media
+     * @see Preview
+     */
+    preview?: Media;
+    /**
+     * Contains the priority icon of the resource.
+     * @type Icon
+     * @see Priority
+     */
+    priority?: Icon;
+    /**
+     * Contains the programming language of the resource.
+     * @type string
+     * @see ProgrammingLanguage
+     */
+    programmingLanguage?: string;
+    /**
+     * Contains the provider icon of the linked resource.
+     * @type Icon
+     * @see Provider
+     */
+    provider?: Icon;
+    /**
+     * Contains the snippet of the resource.
+     * @type string
+     * @see Snippet
+     */
+    snippet?: string;
+    /**
+     * Contains the source branch name of the link typed pull request.
+     * @type string
+     * @see SourceBranch
+     */
+    sourceBranch?: string;
+    /**
+     * Contains the number of subscribers of the linked resource.
+     * @type number
+     * @see SubscriberCount
+     */
+    subscriberCount?: number;
+    /**
+     * Contains the number of subscribers of the linked resource.
+     * @type number
+     * @see SubscriberCount
+     */
+    state?: LinkLozenge;
+    /**
+     * Contains the target branch name of the link typed pull request.
+     * @type string
+     * @see TargetBranch
+     */
+    targetBranch?: string;
+    /**
+     * Contains the Title of the linked resource.
+     * @type string
+     * @see Title
+     */
+    title?: string;
+    /**
+     * Contains the url of the linked resource.
+     * @type string
+     * @see Title
+     */
+    url?: string;
+};
+export declare type Icon = {
+    icon?: IconType;
+    label?: string;
+    url?: string;
+};
+export declare type Media = {
+    type: MediaType;
+    url: string;
+};

package/dist/types-ts4.0/state/helpers.d.ts

@@ -0,0 +1,16 @@
+import { JsonLd } from 'json-ld-types';
+import { CardType, CardStore } from '@atlaskit/linking-common';
+import { DestinationProduct, DestinationSubproduct } from '../utils/analytics/types';
+export declare const getByDefinitionId: (definitionId: string | undefined, store: CardStore) => string[];
+export declare const getClickUrl: (url: string, jsonLd?: JsonLd.Response<JsonLd.Data.BaseData> | undefined) => string;
+export declare const getDefinitionId: (details?: JsonLd.Response<JsonLd.Data.BaseData> | undefined) => string | undefined;
+export declare const getExtensionKey: (details?: JsonLd.Response<JsonLd.Data.BaseData> | undefined) => string | undefined;
+export declare const getResourceType: (details?: JsonLd.Response<JsonLd.Data.BaseData> | undefined) => string | undefined;
+export declare const getProduct: (details?: JsonLd.Response<JsonLd.Data.BaseData> | undefined) => DestinationProduct | string | undefined;
+export declare const getSubproduct: (details?: JsonLd.Response<JsonLd.Data.BaseData> | undefined) => DestinationSubproduct | string | undefined;
+export declare const getServices: (details?: JsonLd.Response<JsonLd.Data.BaseData> | undefined) => JsonLd.Primitives.AuthService[];
+export declare const hasResolved: (details?: JsonLd.Response<JsonLd.Data.BaseData> | undefined) => boolean | undefined;
+export declare const isAccessible: ({ meta: { access } }: JsonLd.Response) => boolean;
+export declare const isVisible: ({ meta: { visibility } }: JsonLd.Response) => boolean;
+export declare const getStatus: ({ meta }: JsonLd.Response) => CardType;
+export declare const isFinalState: (status: CardType) => boolean;

package/dist/types-ts4.0/state/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export { usePrefetch } from './usePrefetch';
+export { useSmartLink } from './useSmartLink';

package/dist/types-ts4.0/state/hooks/usePrefetch.d.ts

@@ -0,0 +1 @@
+export declare function usePrefetch(url: string): () => Promise<void>;

package/dist/types-ts4.0/state/hooks/useSmartLink.d.ts

@@ -0,0 +1,50 @@
+import { AnalyticsHandler } from '../../utils/types';
+export declare function useSmartLink(id: string, url: string, dispatchAnalytics: AnalyticsHandler): {
+    state: import("@atlaskit/linking-common").CardState;
+    actions: {
+        register: () => Promise<void>;
+        reload: () => void;
+        authorize: (appearance: import("@atlaskit/linking-common").CardAppearance) => void;
+        invoke: (opts: import("../../model/invoke-opts").InvokeClientOpts | import("../../model/invoke-opts").InvokeServerOpts, appearance: import("../../view/Card/types").CardInnerAppearance) => Promise<void | import("json-ld-types").JsonLd.Response<import("json-ld-types").JsonLd.Data.BaseData>>;
+        loadMetadata: () => Promise<void> | undefined;
+    };
+    config: (import("@atlaskit/link-provider").CardProviderCacheOpts & import("@atlaskit/link-provider").CardAuthFlowOpts) | undefined;
+    analytics: {
+        ui: {
+            authEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiAuthEventProps) => void;
+            authAlternateAccountEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiAuthAlternateAccountEventProps) => void;
+            buttonClickedEvent: (data: Partial<import("../../utils/types").AnalyticsPayload> & {
+                actionSubjectId: string;
+            }) => void;
+            cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: import("../../utils/analytics/types").UiCardClickedEventProps) => void;
+            actionClickedEvent: ({ id, actionType, display, invokeType, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiActionClickedEventProps) => void;
+            hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: import("../../utils/analytics/types").UiHoverCardOpenLinkClickedEventProps) => void;
+            closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiClosedAuthEventProps) => void;
+            modalClosedEvent: (data: Partial<import("../../utils/types").AnalyticsPayload> & {
+                actionSubjectId: string;
+            }) => void;
+            renderSuccessEvent: ({ display, status, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiRenderSuccessEventProps) => void;
+            renderFailedEvent: ({ display, id, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiRenderFailedEventProps) => void;
+            hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiHoverCardViewedEventProps) => void;
+            hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiHoverCardDismissedEventProps) => void;
+        };
+        operational: {
+            invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").InvokeSucceededEventProps) => void;
+            invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").InvokeFailedEventProps) => void;
+            connectSucceededEvent: ({ id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").ConnectSucceededEventProps) => void;
+            connectFailedEvent: ({ id, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").ConnectFailedEventProps) => void;
+            instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: import("../../utils/analytics/types").InstrumentEventProps) => void;
+        };
+        track: {
+            appAccountConnected: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").CommonEventProps) => void;
+        };
+        screen: {
+            authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").CommonEventProps) => void;
+            modalViewedEvent: (data: Partial<import("../../utils/types").AnalyticsPayload> & {
+                name: "embedPreviewModal";
+            }) => void;
+        };
+    };
+    renderers: import("@atlaskit/link-provider").CardProviderRenderers | undefined;
+    error: Error | null;
+};

package/dist/types-ts4.0/state/hooks-external/useSmartLinkActions.d.ts

@@ -0,0 +1,49 @@
+/// <reference types="react" />
+import { JsonLd } from 'json-ld-types';
+import type { AnalyticsHandler, AnalyticsOrigin } from '../../utils/types';
+import type { CardInnerAppearance } from '../../view/Card/types';
+export interface LinkAction {
+    /**
+     * Unique ID for the action.
+     * @example `delete-action`
+     */
+    id: string;
+    /**
+     * Text to render for the action.
+     * @description Use this in tooltips and UI.
+     * @example `Delete`.
+     */
+    text: React.ReactNode;
+    /**
+     * Promise to invoke on triggering this action.
+     * @example Clicking on `Delete` leading to deletion of content.
+     */
+    invoke: () => Promise<any>;
+}
+export interface UseSmartLinkActionsOpts {
+    /**
+     * Smart Link URL for which actions will be invoked.
+     * @example https://start.atlassian.com
+     */
+    url: string;
+    /**
+     * Appearance under which these actions will be invoked.
+     * @example `block` for card views.
+     */
+    appearance: CardInnerAppearance;
+    /**
+     * Callback for sending analytics events.
+     * @description Accepts an analytics payload and fires it to a system.
+     */
+    analyticsHandler: AnalyticsHandler;
+    /**
+     * Platform on which actions are being invoked.
+     * @default 'web'
+     */
+    platform?: JsonLd.Primitives.Platforms;
+    /**
+     * Smart link origin that the action being invoked from.
+     */
+    origin?: AnalyticsOrigin;
+}
+export declare function useSmartLinkActions({ url, appearance, analyticsHandler, platform, origin, }: UseSmartLinkActionsOpts): LinkAction[];

package/dist/types-ts4.0/state/hooks-external/useSmartLinkReload.d.ts

@@ -0,0 +1,19 @@
+import type { AnalyticsHandler } from '../../utils/types';
+export interface UseSmartLinkReloadOpts {
+    /**
+     * Smart Link URL for which the reload will be invoked.
+     * @example https://start.atlassian.com
+     */
+    url: string;
+    /**
+     * Callback for sending analytics events.
+     * @description Accepts an analytics payload and fires it to a system.
+     */
+    analyticsHandler: AnalyticsHandler;
+}
+/**
+ * Exposes a programmatic way to reload the data being used to render a Smart Link.
+ * @param
+ * @returns
+ */
+export declare function useSmartLinkReload({ url, analyticsHandler, }: UseSmartLinkReloadOpts): () => void;

package/dist/types-ts4.0/state/index.d.ts

@@ -0,0 +1,5 @@
+export { SmartCardContext, SmartCardProvider, useSmartLinkContext, } from '@atlaskit/link-provider';
+export type { CardContext, ProviderProps } from '@atlaskit/link-provider';
+export type { CardType } from '@atlaskit/linking-common';
+export { useSmartLink, usePrefetch } from './hooks';
+export { useSmartLinkAnalytics } from './analytics';

package/dist/types-ts4.0/state/reducers/types.d.ts

@@ -0,0 +1,4 @@
+import { Reducer } from 'react';
+import { CardAction, CardActionType } from '@atlaskit/linking-common';
+export declare type CardReducerMap<StateType, ActionType> = Record<CardActionType, CardReducer<StateType, ActionType>>;
+export declare type CardReducer<StateType, ActionType> = Reducer<StateType, CardAction<ActionType>>;

package/dist/types-ts4.0/state/renderers/index.d.ts

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

package/dist/types-ts4.0/state/store/index.d.ts

@@ -0,0 +1,3 @@
+import { CardState } from '@atlaskit/linking-common';
+export type { CardType } from '@atlaskit/linking-common';
+export declare function useSmartCardState(url: string): CardState;

package/dist/types-ts4.0/state/types.d.ts

@@ -0,0 +1 @@
+export type { CardStore, CardState } from '@atlaskit/linking-common';

package/dist/types-ts4.0/types.d.ts

@@ -0,0 +1,20 @@
+import { JsonLd } from 'json-ld-types';
+import { RequestAccessMessageKey } from './messages';
+export type { CardContext } from '@atlaskit/link-provider';
+import { AccessContext } from './view/types';
+import { ActionProps } from './view/BlockCard/components/Action';
+export declare type ResolveResponse = JsonLd.Response;
+export type { ProviderProps, CardType } from './state';
+export type { CardProps, CardAppearance, CardPlatform, } from './view/Card/types';
+export interface RequestAccessContextProps extends AccessContext {
+    action?: ActionProps;
+    callToActionMessageKey?: RequestAccessMessageKey;
+    descriptiveMessageKey?: RequestAccessMessageKey;
+}
+export declare type InlinePreloaderStyle = 'on-left-with-skeleton' | 'on-right-without-skeleton';
+export declare type LozengeColor = 'default' | 'success' | 'removed' | 'inprogress' | 'new' | 'moved';
+export interface LozengeProps {
+    text: string;
+    appearance?: LozengeColor;
+    isBold?: boolean;
+}

package/dist/types-ts4.0/utils/analytics/__mocks__/analytics.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

package/dist/types-ts4.0/utils/analytics/analytics.d.ts

@@ -0,0 +1,32 @@
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { AnalyticsPayload } from '../types';
+import { CardInnerAppearance } from '../../view/Card/types';
+import { ConnectFailedEventProps, ConnectSucceededEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ResolvedEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps, UnresolvedEventProps } from './types';
+export declare const ANALYTICS_CHANNEL = "media";
+export declare const context: {
+    componentName: string;
+    packageName: any;
+    packageVersion: any;
+};
+export declare class SmartLinkEvents {
+    insertSmartLink(url: string, type: CardInnerAppearance, createAnalyticsEvent?: CreateUIAnalyticsEvent): void;
+}
+export declare const fireSmartLinkEvent: (payload: AnalyticsPayload, createAnalyticsEvent?: CreateUIAnalyticsEvent | undefined) => void;
+export declare const resolvedEvent: (props: ResolvedEventProps) => AnalyticsPayload;
+export declare const unresolvedEvent: ({ id, definitionId, extensionKey, resourceType, destinationSubproduct, destinationProduct, error, status, location, }: UnresolvedEventProps) => AnalyticsPayload;
+export declare const invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: InvokeSucceededEventProps) => AnalyticsPayload;
+export declare const invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: InvokeFailedEventProps) => AnalyticsPayload;
+export declare const connectSucceededEvent: ({ definitionId, extensionKey, destinationProduct, destinationSubproduct, location, }: ConnectSucceededEventProps) => AnalyticsPayload;
+export declare const connectFailedEvent: ({ definitionId, extensionKey, destinationProduct, destinationSubproduct, location, reason, }: ConnectFailedEventProps) => AnalyticsPayload;
+export declare const trackAppAccountConnected: ({ definitionId, extensionKey, destinationProduct, destinationSubproduct, location, }: TrackAppAccountConnectedProps) => AnalyticsPayload;
+export declare const uiAuthEvent: ({ definitionId, extensionKey, destinationProduct, destinationSubproduct, location, display, }: UiAuthEventProps) => AnalyticsPayload;
+export declare const uiAuthAlternateAccountEvent: ({ definitionId, extensionKey, destinationProduct, destinationSubproduct, location, display, }: UiAuthAlternateAccountEventProps) => AnalyticsPayload;
+export declare const uiCardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: UiCardClickedEventProps) => AnalyticsPayload;
+export declare const uiActionClickedEvent: ({ id, actionType, extensionKey, display, definitionId, destinationProduct, destinationSubproduct, location, }: UiActionClickedEventProps) => AnalyticsPayload;
+export declare const uiClosedAuthEvent: ({ display, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: UiClosedAuthEventProps) => AnalyticsPayload;
+export declare const screenAuthPopupEvent: ({ extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: ScreenAuthPopupEventProps) => AnalyticsPayload;
+export declare const uiRenderSuccessEvent: ({ display, status, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: UiRenderSuccessEventProps) => AnalyticsPayload;
+export declare const uiRenderFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => AnalyticsPayload;
+export declare const uiHoverCardViewedEvent: ({ id, previewDisplay, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardViewedEventProps) => AnalyticsPayload;
+export declare const uiHoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardDismissedEventProps) => AnalyticsPayload;
+export declare const uiHoverCardOpenLinkClickedEvent: ({ id, previewDisplay, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardOpenLinkClickedEventProps) => AnalyticsPayload;

package/dist/types-ts4.0/utils/analytics/index.d.ts

@@ -0,0 +1,4 @@
+import { AnalyticsPayload } from '../types';
+import { InstrumentEventProps } from './types';
+export { ANALYTICS_CHANNEL, context, fireSmartLinkEvent, resolvedEvent, unresolvedEvent, invokeSucceededEvent, invokeFailedEvent, connectSucceededEvent, connectFailedEvent, trackAppAccountConnected, uiAuthEvent, uiAuthAlternateAccountEvent, uiCardClickedEvent, uiActionClickedEvent, uiClosedAuthEvent, screenAuthPopupEvent, uiRenderSuccessEvent, uiRenderFailedEvent, uiHoverCardViewedEvent, uiHoverCardDismissedEvent, uiHoverCardOpenLinkClickedEvent, } from './analytics';
+export declare const instrumentEvent: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: InstrumentEventProps) => AnalyticsPayload | undefined;