npm - @atlaskit/smart-card - Versions diffs - 27.5.4 → 27.6.1 - Mend

@atlaskit/smart-card 27.5.4 → 27.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (447) hide show

package/dist/esm/view/common/ai-summary/ulist.js CHANGED Viewed

@@ -3,6 +3,7 @@ import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProper
 var _excluded = ["children"];
 /** @jsx jsx */
 import React from 'react';
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 import { css, jsx } from '@emotion/react';
 var listStyles = css({
   paddingLeft: "var(--ds-space-250, 20px)",

package/dist/types/extractors/flexible/actions/extract-ai-summary-action.d.ts CHANGED Viewed

@@ -2,4 +2,4 @@ import { type JsonLd } from 'json-ld-types';
 import { type CardActionOptions } from '../../../view/Card/types';
 import { type AISummaryActionData } from '../../../state/flexible-ui-context/types';
 import { type AISummaryConfig } from '../../../state/hooks/use-ai-summary-config/types';
-export declare const extractAISummaryAction: (response: JsonLd.Response, url?: string, actionOptions?: CardActionOptions, aiSummaryConfig?: AISummaryConfig) => AISummaryActionData | undefined;
+export declare const extractAISummaryAction: (response: JsonLd.Response, url?: string, actionOptions?: CardActionOptions, aiSummaryConfig?: Pick<AISummaryConfig, 'isAdminHubAIEnabled'>) => AISummaryActionData | undefined;

package/dist/types/extractors/flexible/index.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
 import { type FlexibleUiDataContext } from '../../state/flexible-ui-context/types';
 import { type ExtractFlexibleUiDataContextParams } from '../../view/FlexibleCard/types';
-declare const extractFlexibleUiContext: ({ id, renderers, actionOptions, response, aiSummaryConfig, }?: Partial<ExtractFlexibleUiDataContextParams>) => FlexibleUiDataContext | undefined;
+declare const extractFlexibleUiContext: ({ id, renderers, actionOptions, response, aiSummaryConfig, ...props }?: Partial<ExtractFlexibleUiDataContextParams>) => FlexibleUiDataContext | undefined;
 export default extractFlexibleUiContext;

package/dist/types/state/flexible-ui-context/types.d.ts CHANGED Viewed

@@ -4,7 +4,6 @@ import { type ActionName, type IconType, type InternalActionName, type MediaType
 import { type InvokeRequestWithCardDetails } from '../hooks/use-invoke/types';
 import type { CardInnerAppearance } from '../../view/Card/types';
 import type { AnalyticsFacade } from '../analytics';
-import type { ProductType } from '@atlaskit/linking-common';
 /**
  * This provides the data that will be used by Smart Links Flexible UI to populate it's
  * underlying elements.
@@ -269,8 +268,6 @@ export type CopyLinkActionData = {
     url: string;
 };
 export type AISummaryActionData = {
-    ari?: string;
-    product: ProductType;
     url: string;
 };
 export type AutomationActionData = {

package/dist/types/state/hooks/use-ai-summary/ai-summary-service/types.d.ts CHANGED Viewed

@@ -7,7 +7,6 @@ export interface AISummaryServiceInt {
 }
 export type AISummaryServiceProps = {
     baseUrl?: string;
-    headers?: Record<string, string>;
     onError?: (id: string, reason?: string) => void;
     onStart?: (id: string) => void;
     onSuccess?: (id: string) => void;

package/dist/types/state/hooks/use-ai-summary/index.d.ts CHANGED Viewed

@@ -1,4 +1,8 @@
 import type { AISummaryServiceProps, AISummaryState } from './ai-summary-service/types';
+/**
+ * Stream AI summary for an url.
+ * For hook specific to AI summary on as a smart link, please see useAISummaryAction.
+ */
 export declare const useAISummary: (props: AISummaryServiceProps) => {
     summariseUrl: () => Promise<AISummaryState> | undefined;
     state: AISummaryState;

package/dist/types/state/hooks/use-ai-summary-action/index.d.ts ADDED Viewed

@@ -0,0 +1,5 @@
+declare const useAISummaryAction: (url: string) => {
+    summariseUrl: () => Promise<import("../use-ai-summary/ai-summary-service/types").AISummaryState> | undefined;
+    state: import("../use-ai-summary/ai-summary-service/types").AISummaryState;
+};
+export default useAISummaryAction;

package/dist/types/state/hooks/use-ai-summary-config/types.d.ts CHANGED Viewed

@@ -1,5 +1,7 @@
-import { type ProductType } from '@atlaskit/linking-common';
+import { type EnvironmentsKeys, type ProductType } from '@atlaskit/linking-common';
 export type AISummaryConfig = {
+    baseUrl?: string;
+    envKey?: EnvironmentsKeys;
     product?: ProductType;
     isAdminHubAIEnabled?: boolean;
 };

package/dist/types/utils/mocks.d.ts CHANGED Viewed

@@ -29,9 +29,12 @@ export declare const mocks: {
         };
     };
     analytics: {
-        status: string;
+        status: "resolved";
         details: {
             meta: {
+                visibility: "public";
+                access: "granted";
+                auth: never[];
                 definitionId: string;
                 key: string;
                 resourceType: string;

package/dist/types/view/FlexibleCard/components/actions/action/action-stack-item/action-button.d.ts CHANGED Viewed

@@ -3,7 +3,7 @@ import type { ActionStackItemProps } from './types';
 import type { TriggerProps } from '@atlaskit/tooltip';
 declare const ActionButton: ({ content, icon: iconOption, isDisabled, isLoading, onClick: onClickCallback, size, space: spaceOption, testId, tooltipProps, xcss, }: import("../types").ActionProps & {
     size: import("../../../../../..").SmartLinkSize;
-    space?: "space.0" | "space.025" | "space.050" | "space.075" | "space.100" | "space.150" | "space.200" | "space.250" | "space.300" | "space.400" | "space.500" | "space.600" | "space.800" | "space.1000" | undefined;
+    space?: "space.050" | "space.0" | "space.025" | "space.075" | "space.100" | "space.150" | "space.200" | "space.250" | "space.300" | "space.400" | "space.500" | "space.600" | "space.800" | "space.1000" | undefined;
     tooltipOnHide?: ((analyticsEvent: import("@atlaskit/analytics-next").UIAnalyticsEvent) => any) | undefined;
     hideTooltipOnMouseDown?: boolean | undefined;
 } & {

package/dist/types/view/FlexibleCard/components/actions/ai-summary-action/ai-summarise-action.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
 import type { AISummaryState, AISummaryStatus } from '../../../../../state/hooks/use-ai-summary/ai-summary-service/types';
 import type { AISummaryActionData } from '../../../../../state/flexible-ui-context/types';
 import type { AISummaryActionProps } from './types';
-export declare function AISummariseAction({ url, ari, product, onClick: onClickCallback, onError: onErrorCallback, testId, status, summariseUrl, ...props }: AISummaryActionProps & AISummaryActionData & {
+export declare function AISummariseAction({ url, onClick: onClickCallback, onError: onErrorCallback, testId, status, summariseUrl, ...props }: AISummaryActionProps & AISummaryActionData & {
     status: AISummaryStatus;
     summariseUrl: () => Promise<AISummaryState> | undefined;
 }): JSX.Element;

package/dist/types/view/FlexibleCard/components/actions/ai-summary-action/copy-summary-action.d.ts CHANGED Viewed

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import type { AISummaryActionData } from '../../../../../state/flexible-ui-context/types';
 import type { AISummaryActionProps } from './types';
-export declare function CopySummaryAction({ url, ari, product, onClick: onClickCallback, testId, content, ...props }: AISummaryActionProps & AISummaryActionData & {
+export declare function CopySummaryAction({ url, onClick: onClickCallback, testId, content, ...props }: AISummaryActionProps & AISummaryActionData & {
     content: string;
 }): JSX.Element;

package/dist/types/view/FlexibleCard/components/actions/view-related-links-action/index.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
 /** @jsx jsx */
 import { jsx } from '@emotion/react';
 import { type ViewRelatedLinksActionProps } from './types';
-declare const ViewRelatedLinksAction: (props: ViewRelatedLinksActionProps) => jsx.JSX.Element | null;
+declare const ViewRelatedLinksAction: ({ onClick: onClickCallback, ...props }: ViewRelatedLinksActionProps) => jsx.JSX.Element | null;
 export default ViewRelatedLinksAction;

package/dist/types/view/FlexibleCard/components/blocks/ai-footer-block/resolved/ai-footer-metadata.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
 /// <reference types="react" />
 import type { AISummaryActionData } from '../../../../../../state/flexible-ui-context/types';
-export declare const AIFooterMetadata: ({ testId, url, ari, product, }: AISummaryActionData & {
+export declare const AIFooterMetadata: ({ testId, url }: AISummaryActionData & {
     testId?: string | undefined;
 }) => JSX.Element | null;

package/dist/types/view/FlexibleCard/components/blocks/ai-summary-block/index.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
-import React from 'react';
+/// <reference types="react" />
 import { type AISummaryBlockProps } from './types';
 /**
  * Represents an AISummaryBlock, designed to summarising link resource
@@ -7,5 +7,5 @@ import { type AISummaryBlockProps } from './types';
  * @param {AISummaryBlockProps} AISummaryBlock
  * @see Block
  */
-declare const AISummaryBlock: React.FC<AISummaryBlockProps>;
+declare const AISummaryBlock: ({ status, testId, ...props }: AISummaryBlockProps) => JSX.Element | null;
 export default AISummaryBlock;

package/dist/types/view/FlexibleCard/components/blocks/ai-summary-block/resolved/index.d.ts CHANGED Viewed

@@ -10,5 +10,11 @@ export declare const AISummaryBlockStatusIndicator: ({ showStatusIndicator, meta
     showStatusIndicator: boolean;
     status: AISummaryStatus;
 } & Pick<AISummaryBlockProps, "metadata" | "testId">) => JSX.Element;
-declare const AISummaryBlockResolvedView: (props: AISummaryBlockProps) => JSX.Element;
+type AISummaryBlockResolvedViewProps = AISummaryBlockProps & {
+    /**
+     * URL to be summarised
+     */
+    url: string;
+};
+declare const AISummaryBlockResolvedView: (props: AISummaryBlockResolvedViewProps) => JSX.Element;
 export default AISummaryBlockResolvedView;

package/dist/types/view/HoverCard/components/CustomPopupContainer.d.ts CHANGED Viewed

@@ -6,5 +6,5 @@ import { type PopupComponentProps } from '@atlaskit/popup';
  * HoverCard border implementation is in ContentContainer where it can
  * change between the default border and prism border during runtime.
  */
-declare const CustomPopupContainer: React.ForwardRefExoticComponent<Pick<PopupComponentProps, "children" | "style" | "id" | "tabIndex" | "role" | "data-testid" | "shouldRenderToParent" | "data-placement"> & React.RefAttributes<HTMLDivElement>>;
+declare const CustomPopupContainer: React.ForwardRefExoticComponent<Pick<PopupComponentProps, "children" | "style" | "id" | "tabIndex" | "role" | "data-testid" | "shouldFitContainer" | "shouldRenderToParent" | "data-placement"> & React.RefAttributes<HTMLDivElement>>;
 export default CustomPopupContainer;

package/dist/types/view/RelatedLinksModal/index.d.ts ADDED Viewed

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { type RelatedLinksModalProps } from './types';
+declare const RelatedLinksModal: ({ onClose, showModal, url }: RelatedLinksModalProps) => JSX.Element;
+export default RelatedLinksModal;

package/dist/types/view/RelatedLinksModal/types.d.ts ADDED Viewed

@@ -0,0 +1,5 @@
+export type RelatedLinksModalProps = {
+    url: string;
+    onClose: () => void;
+    showModal: boolean;
+};

package/dist/types-ts4.5/extractors/flexible/actions/extract-ai-summary-action.d.ts CHANGED Viewed

@@ -2,4 +2,4 @@ import { type JsonLd } from 'json-ld-types';
 import { type CardActionOptions } from '../../../view/Card/types';
 import { type AISummaryActionData } from '../../../state/flexible-ui-context/types';
 import { type AISummaryConfig } from '../../../state/hooks/use-ai-summary-config/types';
-export declare const extractAISummaryAction: (response: JsonLd.Response, url?: string, actionOptions?: CardActionOptions, aiSummaryConfig?: AISummaryConfig) => AISummaryActionData | undefined;
+export declare const extractAISummaryAction: (response: JsonLd.Response, url?: string, actionOptions?: CardActionOptions, aiSummaryConfig?: Pick<AISummaryConfig, 'isAdminHubAIEnabled'>) => AISummaryActionData | undefined;

package/dist/types-ts4.5/extractors/flexible/index.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
 import { type FlexibleUiDataContext } from '../../state/flexible-ui-context/types';
 import { type ExtractFlexibleUiDataContextParams } from '../../view/FlexibleCard/types';
-declare const extractFlexibleUiContext: ({ id, renderers, actionOptions, response, aiSummaryConfig, }?: Partial<ExtractFlexibleUiDataContextParams>) => FlexibleUiDataContext | undefined;
+declare const extractFlexibleUiContext: ({ id, renderers, actionOptions, response, aiSummaryConfig, ...props }?: Partial<ExtractFlexibleUiDataContextParams>) => FlexibleUiDataContext | undefined;
 export default extractFlexibleUiContext;

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

@@ -4,7 +4,6 @@ import { type ActionName, type IconType, type InternalActionName, type MediaType
 import { type InvokeRequestWithCardDetails } from '../hooks/use-invoke/types';
 import type { CardInnerAppearance } from '../../view/Card/types';
 import type { AnalyticsFacade } from '../analytics';
-import type { ProductType } from '@atlaskit/linking-common';
 /**
  * This provides the data that will be used by Smart Links Flexible UI to populate it's
  * underlying elements.
@@ -269,8 +268,6 @@ export type CopyLinkActionData = {
     url: string;
 };
 export type AISummaryActionData = {
-    ari?: string;
-    product: ProductType;
     url: string;
 };
 export type AutomationActionData = {

package/dist/types-ts4.5/state/hooks/use-ai-summary/ai-summary-service/types.d.ts CHANGED Viewed

@@ -7,7 +7,6 @@ export interface AISummaryServiceInt {
 }
 export type AISummaryServiceProps = {
     baseUrl?: string;
-    headers?: Record<string, string>;
     onError?: (id: string, reason?: string) => void;
     onStart?: (id: string) => void;
     onSuccess?: (id: string) => void;

package/dist/types-ts4.5/state/hooks/use-ai-summary/index.d.ts CHANGED Viewed

@@ -1,4 +1,8 @@
 import type { AISummaryServiceProps, AISummaryState } from './ai-summary-service/types';
+/**
+ * Stream AI summary for an url.
+ * For hook specific to AI summary on as a smart link, please see useAISummaryAction.
+ */
 export declare const useAISummary: (props: AISummaryServiceProps) => {
     summariseUrl: () => Promise<AISummaryState> | undefined;
     state: AISummaryState;

package/dist/types-ts4.5/state/hooks/use-ai-summary-action/index.d.ts ADDED Viewed

@@ -0,0 +1,5 @@
+declare const useAISummaryAction: (url: string) => {
+    summariseUrl: () => Promise<import("../use-ai-summary/ai-summary-service/types").AISummaryState> | undefined;
+    state: import("../use-ai-summary/ai-summary-service/types").AISummaryState;
+};
+export default useAISummaryAction;

package/dist/types-ts4.5/state/hooks/use-ai-summary-config/types.d.ts CHANGED Viewed

@@ -1,5 +1,7 @@
-import { type ProductType } from '@atlaskit/linking-common';
+import { type EnvironmentsKeys, type ProductType } from '@atlaskit/linking-common';
 export type AISummaryConfig = {
+    baseUrl?: string;
+    envKey?: EnvironmentsKeys;
     product?: ProductType;
     isAdminHubAIEnabled?: boolean;
 };

package/dist/types-ts4.5/utils/mocks.d.ts CHANGED Viewed

@@ -29,9 +29,12 @@ export declare const mocks: {
         };
     };
     analytics: {
-        status: string;
+        status: "resolved";
         details: {
             meta: {
+                visibility: "public";
+                access: "granted";
+                auth: never[];
                 definitionId: string;
                 key: string;
                 resourceType: string;

package/dist/types-ts4.5/view/FlexibleCard/components/actions/action/action-stack-item/action-button.d.ts CHANGED Viewed

@@ -3,7 +3,7 @@ import type { ActionStackItemProps } from './types';
 import type { TriggerProps } from '@atlaskit/tooltip';
 declare const ActionButton: ({ content, icon: iconOption, isDisabled, isLoading, onClick: onClickCallback, size, space: spaceOption, testId, tooltipProps, xcss, }: import("../types").ActionProps & {
     size: import("../../../../../..").SmartLinkSize;
-    space?: "space.0" | "space.025" | "space.050" | "space.075" | "space.100" | "space.150" | "space.200" | "space.250" | "space.300" | "space.400" | "space.500" | "space.600" | "space.800" | "space.1000" | undefined;
+    space?: "space.050" | "space.0" | "space.025" | "space.075" | "space.100" | "space.150" | "space.200" | "space.250" | "space.300" | "space.400" | "space.500" | "space.600" | "space.800" | "space.1000" | undefined;
     tooltipOnHide?: ((analyticsEvent: import("@atlaskit/analytics-next").UIAnalyticsEvent) => any) | undefined;
     hideTooltipOnMouseDown?: boolean | undefined;
 } & {

package/dist/types-ts4.5/view/FlexibleCard/components/actions/ai-summary-action/ai-summarise-action.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
 import type { AISummaryState, AISummaryStatus } from '../../../../../state/hooks/use-ai-summary/ai-summary-service/types';
 import type { AISummaryActionData } from '../../../../../state/flexible-ui-context/types';
 import type { AISummaryActionProps } from './types';
-export declare function AISummariseAction({ url, ari, product, onClick: onClickCallback, onError: onErrorCallback, testId, status, summariseUrl, ...props }: AISummaryActionProps & AISummaryActionData & {
+export declare function AISummariseAction({ url, onClick: onClickCallback, onError: onErrorCallback, testId, status, summariseUrl, ...props }: AISummaryActionProps & AISummaryActionData & {
     status: AISummaryStatus;
     summariseUrl: () => Promise<AISummaryState> | undefined;
 }): JSX.Element;

package/dist/types-ts4.5/view/FlexibleCard/components/actions/ai-summary-action/copy-summary-action.d.ts CHANGED Viewed

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import type { AISummaryActionData } from '../../../../../state/flexible-ui-context/types';
 import type { AISummaryActionProps } from './types';
-export declare function CopySummaryAction({ url, ari, product, onClick: onClickCallback, testId, content, ...props }: AISummaryActionProps & AISummaryActionData & {
+export declare function CopySummaryAction({ url, onClick: onClickCallback, testId, content, ...props }: AISummaryActionProps & AISummaryActionData & {
     content: string;
 }): JSX.Element;

package/dist/types-ts4.5/view/FlexibleCard/components/actions/view-related-links-action/index.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
 /** @jsx jsx */
 import { jsx } from '@emotion/react';
 import { type ViewRelatedLinksActionProps } from './types';
-declare const ViewRelatedLinksAction: (props: ViewRelatedLinksActionProps) => jsx.JSX.Element | null;
+declare const ViewRelatedLinksAction: ({ onClick: onClickCallback, ...props }: ViewRelatedLinksActionProps) => jsx.JSX.Element | null;
 export default ViewRelatedLinksAction;

package/dist/types-ts4.5/view/FlexibleCard/components/blocks/ai-footer-block/resolved/ai-footer-metadata.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
 /// <reference types="react" />
 import type { AISummaryActionData } from '../../../../../../state/flexible-ui-context/types';
-export declare const AIFooterMetadata: ({ testId, url, ari, product, }: AISummaryActionData & {
+export declare const AIFooterMetadata: ({ testId, url }: AISummaryActionData & {
     testId?: string | undefined;
 }) => JSX.Element | null;

package/dist/types-ts4.5/view/FlexibleCard/components/blocks/ai-summary-block/index.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
-import React from 'react';
+/// <reference types="react" />
 import { type AISummaryBlockProps } from './types';
 /**
  * Represents an AISummaryBlock, designed to summarising link resource
@@ -7,5 +7,5 @@ import { type AISummaryBlockProps } from './types';
  * @param {AISummaryBlockProps} AISummaryBlock
  * @see Block
  */
-declare const AISummaryBlock: React.FC<AISummaryBlockProps>;
+declare const AISummaryBlock: ({ status, testId, ...props }: AISummaryBlockProps) => JSX.Element | null;
 export default AISummaryBlock;

package/dist/types-ts4.5/view/FlexibleCard/components/blocks/ai-summary-block/resolved/index.d.ts CHANGED Viewed

@@ -10,5 +10,11 @@ export declare const AISummaryBlockStatusIndicator: ({ showStatusIndicator, meta
     showStatusIndicator: boolean;
     status: AISummaryStatus;
 } & Pick<AISummaryBlockProps, "metadata" | "testId">) => JSX.Element;
-declare const AISummaryBlockResolvedView: (props: AISummaryBlockProps) => JSX.Element;
+type AISummaryBlockResolvedViewProps = AISummaryBlockProps & {
+    /**
+     * URL to be summarised
+     */
+    url: string;
+};
+declare const AISummaryBlockResolvedView: (props: AISummaryBlockResolvedViewProps) => JSX.Element;
 export default AISummaryBlockResolvedView;

package/dist/types-ts4.5/view/HoverCard/components/CustomPopupContainer.d.ts CHANGED Viewed

@@ -6,5 +6,5 @@ import { type PopupComponentProps } from '@atlaskit/popup';
  * HoverCard border implementation is in ContentContainer where it can
  * change between the default border and prism border during runtime.
  */
-declare const CustomPopupContainer: React.ForwardRefExoticComponent<Pick<PopupComponentProps, "children" | "style" | "id" | "tabIndex" | "role" | "data-testid" | "shouldRenderToParent" | "data-placement"> & React.RefAttributes<HTMLDivElement>>;
+declare const CustomPopupContainer: React.ForwardRefExoticComponent<Pick<PopupComponentProps, "children" | "style" | "id" | "tabIndex" | "role" | "data-testid" | "shouldFitContainer" | "shouldRenderToParent" | "data-placement"> & React.RefAttributes<HTMLDivElement>>;
 export default CustomPopupContainer;

package/dist/types-ts4.5/view/RelatedLinksModal/index.d.ts ADDED Viewed

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { type RelatedLinksModalProps } from './types';
+declare const RelatedLinksModal: ({ onClose, showModal, url }: RelatedLinksModalProps) => JSX.Element;
+export default RelatedLinksModal;

package/dist/types-ts4.5/view/RelatedLinksModal/types.d.ts ADDED Viewed

@@ -0,0 +1,5 @@
+export type RelatedLinksModalProps = {
+    url: string;
+    onClose: () => void;
+    showModal: boolean;
+};