@atlaskit/smart-card 23.4.1 → 23.4.2

package/dist/esm/view/FlexibleCard/components/blocks/index.js

@@ -2,4 +2,5 @@ export { default as FooterBlock } from './footer-block';
 export { default as MetadataBlock } from './metadata-block';
 export { default as PreviewBlock } from './preview-block';
 export { default as SnippetBlock } from './snippet-block';
-export { default as TitleBlock } from './title-block';
+export { default as TitleBlock } from './title-block';
+export { default as CustomBlock } from './block';

package/dist/esm/view/FlexibleCard/utils.js

@@ -6,6 +6,7 @@ import extractFlexibleLinkContext from '../../extractors/flexible';
 import { extractErrorIcon } from '../../extractors/flexible/icon';
 import { handleOnClick } from '../../utils';
 import { extractProvider } from '@atlaskit/linking-common/extractors';
+import extractProviderIcon from '../../extractors/flexible/icon/extract-provider-icon';
 export var getContextByStatus = function getContextByStatus(url, status, details, renderers) {
   switch (status) {
     case SmartLinkStatus.Pending:
@@ -25,10 +26,12 @@ export var getContextByStatus = function getContextByStatus(url, status, details
     case SmartLinkStatus.Fallback:
     default:
       var linkIcon = extractErrorIcon(details, status);
+      var provider = extractProviderIcon(details === null || details === void 0 ? void 0 : details.data);
       return {
         linkIcon: linkIcon,
         title: url,
-        url: url
+        url: url,
+        provider: provider
       };
   }
 };

package/dist/types/view/BlockCard/actions/flexible/AuthorizeAction.d.ts

@@ -0,0 +1,8 @@
+import { CustomActionItem } from '../../../FlexibleCard/components/blocks/types';
+/**
+ * Returns a CustomActionItem with a "Connect" default message
+ *
+ * @see CustomActionItem
+ * @param onAuthorize a function that will be called on the click of the button
+ */
+export declare const AuthorizeAction: (onAuthorize: () => void) => CustomActionItem;

package/dist/types/view/BlockCard/actions/flexible/ForbiddenAction.d.ts

@@ -0,0 +1,8 @@
+import { CustomActionItem } from '../../../FlexibleCard/components/blocks/types';
+/**
+ * Returns a CustomActionItem with a "Try Another Account" default message
+ *
+ * @see CustomActionItem
+ * @param onAuthorize a function that will be called on the click of the button
+ */
+export declare const ForbiddenAction: (onAuthorize: () => void) => CustomActionItem;

package/dist/types/view/BlockCard/actions/flexible/RetryAction.d.ts

@@ -0,0 +1,8 @@
+import { CustomActionItem } from '../../../FlexibleCard/components/blocks/types';
+/**
+ * Returns a CustomActionItem with a "Retry" default message
+ *
+ * @see CustomActionItem
+ * @param onRetry a function that will be called on the click of the "Retry" button
+ */
+export declare const RetryAction: (onRetry: () => void) => CustomActionItem;

package/dist/types/view/BlockCard/components/flexible/footer/index.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import { FooterBlockProps } from '../../../../FlexibleCard/components/blocks/footer-block/types';
+/**
+ * This Components is a footer that is used in a Block Card with Flexible UI.
+ * It contains a provider icon if provider is present and an actions list if one is passed.
+ * To be shown as a part of Flexible UI, needs to be wrapped inside of a CustomBlock
+ *
+ * @see CustomBlock
+ * @param props are the data required for the block, such as actions to be displayed.
+ */
+declare const Footer: React.FC<FooterBlockProps>;
+export default Footer;

package/dist/types/view/BlockCard/views/flexible/FlexibleErroredView.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { FlexibleBlockCardProps } from './types';
+/**
+ * This view represents a Block Card with an 'Errored' status.
+ *
+ * @see SmartLinkStatus
+ * @see FlexibleCardProps
+ */
+declare const FlexibleErroredView: ({ cardState, onAuthorize, onError, ui, url, onClick, testId, }: FlexibleBlockCardProps) => JSX.Element;
+export default FlexibleErroredView;

package/dist/types/view/BlockCard/views/flexible/FlexibleForbiddenView.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import { FlexibleBlockCardProps } from './types';
+/**
+ * This view represent a Block Card with the 'Forbidden' status.
+ * It should have a "Try another account" button that will allow a user to connect another account and view the block card.
+ *
+ * @see SmartLinkStatus
+ * @see FlexibleCardProps
+ */
+declare const FlexibleForbiddenView: ({ cardState, onAuthorize, onClick, onError, testId, ui, url, }: FlexibleBlockCardProps) => JSX.Element;
+export default FlexibleForbiddenView;

package/dist/types/view/BlockCard/views/flexible/FlexibleNotFoundView.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { FlexibleBlockCardProps } from './types';
+/**
+ * This view represents a Block Card with a 'Not_Found' status.
+ *
+ * @see SmartLinkStatus
+ * @see FlexibleCardProps
+ */
+declare const FlexibleNotFoundView: ({ cardState, onAuthorize, onError, ui, url, onClick, testId, }: FlexibleBlockCardProps) => JSX.Element;
+export default FlexibleNotFoundView;

package/dist/types/view/BlockCard/views/flexible/FlexibleUnauthorisedView.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import { FlexibleBlockCardProps } from './types';
+/**
+ * This view represents a Block card that has an 'Unauthorized' status .
+ * It should have a "Connect" button that will allow a user to connect their account and view the block card.
+ *
+ * @see SmartLinkStatus
+ * @see UnauthorisedViewProps
+ */
+declare const FlexibleUnauthorisedView: ({ cardState, providerName, onAuthorize, onClick, onError, testId, ui, url, }: FlexibleBlockCardProps) => JSX.Element;
+export default FlexibleUnauthorisedView;

package/dist/types/view/BlockCard/views/flexible/types.d.ts

@@ -0,0 +1,56 @@
+/// <reference types="react" />
+import { CardState } from '@atlaskit/linking-common';
+import { OnErrorCallback } from '../../../types';
+import { FlexibleUiOptions } from '../../../FlexibleCard/types';
+import { OnResolveCallback } from '../../../Card/types';
+import { CardProviderRenderers } from '@atlaskit/link-provider';
+export declare type FlexibleBlockCardProps = {
+    /**
+     * Determines the status and data of the Smart Link.
+     * @internal
+     */
+    cardState: CardState;
+    /**
+     * function to be called after a flexible card has rendered its resolved state
+     */
+    onResolve?: OnResolveCallback;
+    /**
+     * Any additional renderers required by Flexible UI. Currently used by icon
+     * to render Emoji.
+     */
+    renderers?: CardProviderRenderers;
+    /**
+     * An additional action that can be performed when link is not resolved, e.g.
+     * connect account to gain access to 403 link.
+     * @internal
+     */
+    onAuthorize?: () => void;
+    /**
+     * Determines the onClick behaviour of Flexible UI. This will proxy to the
+     * TitleBlock if supplied.
+     */
+    onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
+    /**
+     * function to be called after a flexible card has rendered its error states
+     */
+    onError?: OnErrorCallback;
+    /**
+     * A name of the provider, needed to specify to user which account has to be connected
+     */
+    providerName?: string;
+    /**
+     * A `testId` prop is provided for specified elements, which is a unique
+     * string that appears as a data attribute `data-testid` in the rendered code,
+     * serving as a hook for automated tests
+     */
+    testId?: string;
+    /**
+     * Determines the appearance of Flexible UI.
+     * @see FlexibleUiOptions
+     */
+    ui?: FlexibleUiOptions;
+    /**
+     * Determines the URL of the Smart Link.
+     */
+    url: string;
+};

package/dist/types/view/FlexibleCard/components/blocks/index.d.ts

@@ -3,3 +3,4 @@ export { default as MetadataBlock } from './metadata-block';
 export { default as PreviewBlock } from './preview-block';
 export { default as SnippetBlock } from './snippet-block';
 export { default as TitleBlock } from './title-block';
+export { default as CustomBlock } from './block';

package/package.json

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