@atlaskit/smart-card 26.58.0 → 26.59.0

package/dist/types/extractors/common/icon/prioritiseIcon.d.ts

@@ -0,0 +1,40 @@
+import { type IconType } from '../../../constants';
+/**
+ * Represents an icon. Should either contain a label and url, or a an icon type and label.
+ */
+export type IconDescriptor = {
+    icon?: IconType;
+    label?: string;
+    url?: string;
+};
+/**
+ * Options required to prioritise which icon to show
+ */
+export type IconPriorityOpts<T> = {
+    /**
+     * The '@id' field of the JSON-LD generator object
+     */
+    providerId: string | undefined;
+    /**
+     * Icon choice corresponding to the file format (based on MIME type) for the object.
+     */
+    fileFormatIcon: T | undefined;
+    /**
+     * Icon choice corresponding to the document type for the object.
+     */
+    documentTypeIcon: T | undefined;
+    /**
+     * The icon choice extracted from the icon property of the JSON-LD data object.
+     */
+    urlIcon: T | undefined;
+    /**
+     * The icon choice extracted from the generator object (provider) of the
+     * JSON-LD data object.
+     */
+    providerIcon: T | undefined;
+};
+/**
+ * Reusable priority function for choosing which icon to show.
+ * Generic so it can be used to prioritise strings, or React components depending on the usage.
+ */
+export declare function prioritiseIcon<T>({ providerId, fileFormatIcon, documentTypeIcon, urlIcon, providerIcon, }: IconPriorityOpts<T>): T | undefined;

package/dist/types/extractors/common/icon/priority.d.ts

@@ -1,4 +1,7 @@
 import { JsonLd } from 'json-ld-types';
 type JsonLdType = JsonLd.Primitives.ObjectType | 'atlassian:Template';
+/**
+ * Preference more detailed object types over less detailed ones (like 'Document' or 'Object').
+ */
 export declare const extractorPriorityMap: Record<JsonLdType, number>;
 export {};

package/dist/types/extractors/common/lozenge/types.d.ts

@@ -1,10 +1,13 @@
+import { LozengeProps as AtlaskitLozengeProps } from '@atlaskit/lozenge';
 import { InvokeActions } from '../../../state/hooks/use-invoke/types';
 export type LinkLozengeColor = 'default' | 'success' | 'removed' | 'inprogress' | 'new' | 'moved';
+export type AccentShortName = 'blue' | 'gray' | 'green' | 'lime' | 'magenta' | 'orange' | 'purple' | 'red' | 'teal' | 'yellow';
 export type LinkLozengeInvokeActions = InvokeActions;
 export interface LinkLozenge {
     action?: LinkLozengeInvokeActions;
     text: string;
     appearance?: LinkLozengeColor;
+    style?: AtlaskitLozengeProps['style'];
 }
 export type LinkDocumentState = 'archived' | 'draft' | 'current';
 export type LinkPullRequestState = 'open' | 'merged' | 'declined' | 'closed';

package/dist/types/extractors/flexible/icon/extract-document-type-icon.d.ts

@@ -1,3 +1,3 @@
-import { IconDescriptor } from './types';
+import { type IconDescriptor } from './types';
 declare const extractDocumentTypeIcon: (documentType: string, label?: string) => IconDescriptor | undefined;
 export default extractDocumentTypeIcon;

package/dist/types/extractors/flexible/icon/extract-jsonld-data-icon.d.ts

@@ -1,4 +1,7 @@
-import { JsonLd } from 'json-ld-types';
-import { IconDescriptor } from './types';
+import { type JsonLd } from 'json-ld-types';
+import { type IconDescriptor } from './types';
+/**
+ * Return the icon object given a JSON-LD data object.
+ */
 declare const extractJsonldDataIcon: (data: JsonLd.Data.BaseData) => IconDescriptor | undefined;
 export default extractJsonldDataIcon;

package/dist/types/extractors/flexible/icon/extract-provider-icon.d.ts

@@ -1,4 +1,14 @@
 import { JsonLd } from 'json-ld-types';
 import { IconDescriptor } from './types';
+/**
+ * Extracts the provider icon and label from the given JSON-LD data.
+ *
+ * If the data is from Confluence, the icon will be the Confluence icon and the label will be 'Confluence'.
+ * If the data is from Jira, the icon will be the Jira icon and the label will be 'Jira'.
+ * If the data is from another provider, the icon and label will be extracted from the generator object.
+ *
+ * @param data - The JSON-LD data to extract the provider icon and label from.
+ * @returns IconDescriptor with optional icon string name, url and label, or `undefined` if the data is not provided.
+ */
 declare const extractProviderIcon: (data?: JsonLd.Data.BaseData) => IconDescriptor | undefined;
 export default extractProviderIcon;

package/dist/types/extractors/flexible/icon/extract-url-icon.d.ts

@@ -1,4 +1,11 @@
 import { JsonLd } from 'json-ld-types';
 import { IconDescriptor } from './types';
+/**
+ * Extracts the URL icon from the given icon or link object.
+ *
+ * @param icon - The icon or link object from which to extract the URL icon.
+ * @param label - The label for the URL icon.
+ * @returns IconDescriptor, which will contain label and url, or undefined
+ */
 declare const extractUrlIcon: (icon?: JsonLd.Primitives.Image | JsonLd.Primitives.Link, label?: string) => IconDescriptor | undefined;
 export default extractUrlIcon;

package/dist/types/extractors/flexible/icon/types.d.ts

@@ -1,4 +1,7 @@
 import { IconType } from '../../../constants';
+/**
+ * Represents an icon. Should either contain a label and url, or a an icon type and label.
+ */
 export type IconDescriptor = {
     icon?: IconType;
     label?: string;

package/dist/types/types.d.ts

@@ -1,6 +1,7 @@
 import { JsonLd } from 'json-ld-types';
 import { RequestAccessMessageKey } from './messages';
 export type { CardContext } from '@atlaskit/link-provider';
+import type { LozengeProps as AtlaskitLozengeProps } from '@atlaskit/lozenge';
 import { AccessContext } from './view/types';
 import { ActionProps } from './view/BlockCard/components/Action';
 export type ResolveResponse = JsonLd.Response;
@@ -16,5 +17,6 @@ export type LozengeColor = 'default' | 'success' | 'removed' | 'inprogress' | 'n
 export interface LozengeProps {
     text: string;
     appearance?: LozengeColor;
+    style?: AtlaskitLozengeProps['style'];
     isBold?: boolean;
 }

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

@@ -1,4 +1,5 @@
-/// <reference types="react" />
-import { ActionBlockProps } from './types';
-declare const ActionBlock: ({ blockRef, onClick: onClickCallback, size, spaceInline, testId, }: ActionBlockProps) => JSX.Element | null;
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+import { type ActionBlockProps } from './types';
+declare const ActionBlock: ({ blockRef, onClick: onClickCallback, size, spaceInline, testId, }: ActionBlockProps) => jsx.JSX.Element | null;
 export default ActionBlock;

package/dist/types/view/FlexibleCard/components/elements/lozenge/types.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="react" />
+import { LozengeProps as AtlaskitLozengeProps } from '@atlaskit/lozenge';
 import { ElementProps } from '../types';
 import type { LinkLozengeInvokeActions } from '../../../../../extractors/common/lozenge/types';
 export type LozengeAppearance = 'default' | 'inprogress' | 'moved' | 'new' | 'removed' | 'success';
@@ -11,6 +12,10 @@ export type LozengeProps = ElementProps & {
      * Determines the appearance of the Atlaskit lozenge.
      */
     appearance?: LozengeAppearance;
+    /**
+     * Determines the custom styles of the Atlaskit lozenge.
+     */
+    style?: AtlaskitLozengeProps['style'];
     /**
      * The text to display within the lozenge.
      */

package/dist/types-ts4.5/extractors/common/icon/extractIcon.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
-import { JsonLd } from 'json-ld-types';
-import { LinkProvider } from '@atlaskit/link-extractors';
-import { LinkTaskType } from '../lozenge/extractTaskType';
+import { type JsonLd } from 'json-ld-types';
+import { type LinkProvider } from '@atlaskit/link-extractors';
+import { type LinkTaskType } from '../lozenge/extractTaskType';
 export type IconPriority = 'type' | 'provider';
 export interface IconOpts {
     title?: string;

package/dist/types-ts4.5/extractors/common/icon/extractIconFromDocument.d.ts

@@ -1,4 +1,11 @@
 import React from 'react';
-import { IconOpts } from './extractIcon';
+import { type IconOpts } from './extractIcon';
 export type DocumentType = 'Document' | 'schema:BlogPosting' | 'schema:DigitalDocument' | 'schema:TextDigitalDocument' | 'schema:PresentationDigitalDocument' | 'schema:SpreadsheetDigitalDocument' | 'atlassian:Template' | 'atlassian:UndefinedLink';
+/**
+ * Extracts an icon for a document pbject
+ *
+ * @param type - The type of the document.
+ * @param opts - The options for extracting the icon.
+ * @returns The React node representing the extracted icon, or `undefined` if no icon is found.
+ */
 export declare const extractIconFromDocument: (type: DocumentType, opts: IconOpts) => React.ReactNode | undefined;

package/dist/types-ts4.5/extractors/common/icon/extractIconFromTask.d.ts

@@ -1,3 +1,11 @@
 import React from 'react';
 import { IconOpts } from './extractIcon';
+/**
+ * Chooses an icon for a task based on the provided options.
+ *
+ * Chooses icon based on variety of Jira task types, based on opts.taskType.id
+ *
+ * @param opts - The options for extracting the icon.
+ * @returns The React node representing the extracted icon, or `undefined` if no icon is found.
+ */
 export declare const extractIconFromTask: (opts: IconOpts) => React.ReactNode | undefined;

package/dist/types-ts4.5/extractors/common/icon/prioritiseIcon.d.ts

@@ -0,0 +1,40 @@
+import { type IconType } from '../../../constants';
+/**
+ * Represents an icon. Should either contain a label and url, or a an icon type and label.
+ */
+export type IconDescriptor = {
+    icon?: IconType;
+    label?: string;
+    url?: string;
+};
+/**
+ * Options required to prioritise which icon to show
+ */
+export type IconPriorityOpts<T> = {
+    /**
+     * The '@id' field of the JSON-LD generator object
+     */
+    providerId: string | undefined;
+    /**
+     * Icon choice corresponding to the file format (based on MIME type) for the object.
+     */
+    fileFormatIcon: T | undefined;
+    /**
+     * Icon choice corresponding to the document type for the object.
+     */
+    documentTypeIcon: T | undefined;
+    /**
+     * The icon choice extracted from the icon property of the JSON-LD data object.
+     */
+    urlIcon: T | undefined;
+    /**
+     * The icon choice extracted from the generator object (provider) of the
+     * JSON-LD data object.
+     */
+    providerIcon: T | undefined;
+};
+/**
+ * Reusable priority function for choosing which icon to show.
+ * Generic so it can be used to prioritise strings, or React components depending on the usage.
+ */
+export declare function prioritiseIcon<T>({ providerId, fileFormatIcon, documentTypeIcon, urlIcon, providerIcon, }: IconPriorityOpts<T>): T | undefined;

package/dist/types-ts4.5/extractors/common/icon/priority.d.ts

@@ -1,4 +1,7 @@
 import { JsonLd } from 'json-ld-types';
 type JsonLdType = JsonLd.Primitives.ObjectType | 'atlassian:Template';
+/**
+ * Preference more detailed object types over less detailed ones (like 'Document' or 'Object').
+ */
 export declare const extractorPriorityMap: Record<JsonLdType, number>;
 export {};

package/dist/types-ts4.5/extractors/common/lozenge/types.d.ts

@@ -1,10 +1,13 @@
+import { LozengeProps as AtlaskitLozengeProps } from '@atlaskit/lozenge';
 import { InvokeActions } from '../../../state/hooks/use-invoke/types';
 export type LinkLozengeColor = 'default' | 'success' | 'removed' | 'inprogress' | 'new' | 'moved';
+export type AccentShortName = 'blue' | 'gray' | 'green' | 'lime' | 'magenta' | 'orange' | 'purple' | 'red' | 'teal' | 'yellow';
 export type LinkLozengeInvokeActions = InvokeActions;
 export interface LinkLozenge {
     action?: LinkLozengeInvokeActions;
     text: string;
     appearance?: LinkLozengeColor;
+    style?: AtlaskitLozengeProps['style'];
 }
 export type LinkDocumentState = 'archived' | 'draft' | 'current';
 export type LinkPullRequestState = 'open' | 'merged' | 'declined' | 'closed';

package/dist/types-ts4.5/extractors/flexible/icon/extract-document-type-icon.d.ts

@@ -1,3 +1,3 @@
-import { IconDescriptor } from './types';
+import { type IconDescriptor } from './types';
 declare const extractDocumentTypeIcon: (documentType: string, label?: string) => IconDescriptor | undefined;
 export default extractDocumentTypeIcon;

package/dist/types-ts4.5/extractors/flexible/icon/extract-jsonld-data-icon.d.ts

@@ -1,4 +1,7 @@
-import { JsonLd } from 'json-ld-types';
-import { IconDescriptor } from './types';
+import { type JsonLd } from 'json-ld-types';
+import { type IconDescriptor } from './types';
+/**
+ * Return the icon object given a JSON-LD data object.
+ */
 declare const extractJsonldDataIcon: (data: JsonLd.Data.BaseData) => IconDescriptor | undefined;
 export default extractJsonldDataIcon;

package/dist/types-ts4.5/extractors/flexible/icon/extract-provider-icon.d.ts

@@ -1,4 +1,14 @@
 import { JsonLd } from 'json-ld-types';
 import { IconDescriptor } from './types';
+/**
+ * Extracts the provider icon and label from the given JSON-LD data.
+ *
+ * If the data is from Confluence, the icon will be the Confluence icon and the label will be 'Confluence'.
+ * If the data is from Jira, the icon will be the Jira icon and the label will be 'Jira'.
+ * If the data is from another provider, the icon and label will be extracted from the generator object.
+ *
+ * @param data - The JSON-LD data to extract the provider icon and label from.
+ * @returns IconDescriptor with optional icon string name, url and label, or `undefined` if the data is not provided.
+ */
 declare const extractProviderIcon: (data?: JsonLd.Data.BaseData) => IconDescriptor | undefined;
 export default extractProviderIcon;

package/dist/types-ts4.5/extractors/flexible/icon/extract-url-icon.d.ts

@@ -1,4 +1,11 @@
 import { JsonLd } from 'json-ld-types';
 import { IconDescriptor } from './types';
+/**
+ * Extracts the URL icon from the given icon or link object.
+ *
+ * @param icon - The icon or link object from which to extract the URL icon.
+ * @param label - The label for the URL icon.
+ * @returns IconDescriptor, which will contain label and url, or undefined
+ */
 declare const extractUrlIcon: (icon?: JsonLd.Primitives.Image | JsonLd.Primitives.Link, label?: string) => IconDescriptor | undefined;
 export default extractUrlIcon;

package/dist/types-ts4.5/extractors/flexible/icon/types.d.ts

@@ -1,4 +1,7 @@
 import { IconType } from '../../../constants';
+/**
+ * Represents an icon. Should either contain a label and url, or a an icon type and label.
+ */
 export type IconDescriptor = {
     icon?: IconType;
     label?: string;

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

@@ -1,6 +1,7 @@
 import { JsonLd } from 'json-ld-types';
 import { RequestAccessMessageKey } from './messages';
 export type { CardContext } from '@atlaskit/link-provider';
+import type { LozengeProps as AtlaskitLozengeProps } from '@atlaskit/lozenge';
 import { AccessContext } from './view/types';
 import { ActionProps } from './view/BlockCard/components/Action';
 export type ResolveResponse = JsonLd.Response;
@@ -16,5 +17,6 @@ export type LozengeColor = 'default' | 'success' | 'removed' | 'inprogress' | 'n
 export interface LozengeProps {
     text: string;
     appearance?: LozengeColor;
+    style?: AtlaskitLozengeProps['style'];
     isBold?: boolean;
 }

package/dist/types-ts4.5/view/FlexibleCard/components/blocks/action-block/index.d.ts

@@ -1,4 +1,5 @@
-/// <reference types="react" />
-import { ActionBlockProps } from './types';
-declare const ActionBlock: ({ blockRef, onClick: onClickCallback, size, spaceInline, testId, }: ActionBlockProps) => JSX.Element | null;
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+import { type ActionBlockProps } from './types';
+declare const ActionBlock: ({ blockRef, onClick: onClickCallback, size, spaceInline, testId, }: ActionBlockProps) => jsx.JSX.Element | null;
 export default ActionBlock;

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

@@ -1,4 +1,5 @@
 /// <reference types="react" />
+import { LozengeProps as AtlaskitLozengeProps } from '@atlaskit/lozenge';
 import { ElementProps } from '../types';
 import type { LinkLozengeInvokeActions } from '../../../../../extractors/common/lozenge/types';
 export type LozengeAppearance = 'default' | 'inprogress' | 'moved' | 'new' | 'removed' | 'success';
@@ -11,6 +12,10 @@ export type LozengeProps = ElementProps & {
      * Determines the appearance of the Atlaskit lozenge.
      */
     appearance?: LozengeAppearance;
+    /**
+     * Determines the custom styles of the Atlaskit lozenge.
+     */
+    style?: AtlaskitLozengeProps['style'];
     /**
      * The text to display within the lozenge.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/smart-card",
-  "version": "26.58.0",
+  "version": "26.59.0",
   "description": "Smart card component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -32,31 +32,31 @@
     "@atlaskit/analytics-next": "^9.3.0",
     "@atlaskit/avatar": "^21.5.0",
     "@atlaskit/avatar-group": "^9.5.0",
-    "@atlaskit/badge": "^16.0.0",
+    "@atlaskit/badge": "^16.1.0",
     "@atlaskit/button": "^17.14.0",
     "@atlaskit/dropdown-menu": "^12.9.0",
     "@atlaskit/frontend-utilities": "^2.7.0",
     "@atlaskit/icon": "^22.1.0",
     "@atlaskit/icon-file-type": "^6.4.0",
-    "@atlaskit/icon-object": "^6.3.0",
+    "@atlaskit/icon-object": "^6.4.0",
     "@atlaskit/icon-priority": "^6.3.0",
     "@atlaskit/in-product-testing": "^0.2.0",
     "@atlaskit/link-analytics": "^8.3.0",
     "@atlaskit/link-client-extension": "^1.8.0",
-    "@atlaskit/link-extractors": "^1.3.0",
+    "@atlaskit/link-extractors": "^1.4.0",
     "@atlaskit/linking-common": "^5.6.0",
     "@atlaskit/linking-types": "^8.8.0",
     "@atlaskit/logo": "^13.15.0",
     "@atlaskit/lozenge": "^11.7.0",
-    "@atlaskit/modal-dialog": "^12.11.0",
+    "@atlaskit/modal-dialog": "^12.13.0",
     "@atlaskit/outbound-auth-flow-client": "^3.4.0",
     "@atlaskit/platform-feature-flags": "^0.2.1",
-    "@atlaskit/popup": "^1.14.0",
-    "@atlaskit/primitives": "^5.6.0",
-    "@atlaskit/spinner": "^16.0.0",
+    "@atlaskit/popup": "^1.15.0",
+    "@atlaskit/primitives": "^5.7.0",
+    "@atlaskit/spinner": "^16.1.0",
     "@atlaskit/theme": "^12.7.0",
-    "@atlaskit/tokens": "^1.43.0",
-    "@atlaskit/tooltip": "^18.2.0",
+    "@atlaskit/tokens": "^1.44.0",
+    "@atlaskit/tooltip": "^18.3.0",
     "@atlaskit/ufo": "^0.2.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
@@ -173,6 +173,9 @@
     },
     "platform.linking-platform.smart-card.enable-theme-state-url": {
       "type": "boolean"
+    },
+    "platform.linking-platform.smart-card.standardise-smart-link-icon-behaviour": {
+      "type": "boolean"
     }
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"