@carto/ps-react-ui 4.3.9 → 4.4.0-chat-ui.0

package/dist/types/chat/types.d.ts

@@ -0,0 +1,99 @@
+import { ReactNode } from 'react';
+import { ButtonBaseProps, SxProps, Theme } from '@mui/material';
+export interface ChatSxProps {
+    sx?: SxProps<Theme>;
+}
+export interface ChatErrorAction {
+    label: string;
+    onClick: () => void;
+}
+export interface ChatUserMessageProps extends ChatSxProps {
+    children: ReactNode;
+    /** enabled to render text with a lighter color for indicating things like an error sending the message */
+    muted?: boolean;
+    /** content to render on top of the message for user attachments */
+    topContext?: ReactNode;
+}
+export interface ChatAgentMessageProps extends ChatSxProps {
+    children: ReactNode;
+}
+export interface ChatErrorMessageProps extends ChatSxProps {
+    errors: string[];
+    icon?: ReactNode;
+    actions?: ChatErrorAction[];
+}
+export interface ChatSuggestionButtonProps extends ChatSxProps, Omit<ButtonBaseProps, 'children'> {
+    label: ReactNode;
+    color?: string;
+}
+export interface ChatThinkingProps extends ChatSxProps {
+    duration?: number;
+    children?: ReactNode;
+}
+export interface ChatLoaderProps extends ChatSxProps {
+    size?: number;
+    labels?: {
+        loading?: string;
+    };
+}
+export interface ChatContentProps extends ChatSxProps {
+    children: ReactNode;
+    labels?: {
+        jumpToLatest?: string;
+    };
+}
+export interface ChatHeaderProps extends ChatSxProps {
+    leftSlot?: ReactNode;
+    title: ReactNode;
+    rightSlot?: ReactNode;
+    onClose?: () => void;
+}
+export interface ChatFooterProps extends ChatSxProps {
+    value: string;
+    onChange: (value: string) => void;
+    onSend: () => void;
+    onStop?: () => void;
+    isGenerating?: boolean;
+    disabled?: boolean;
+    placeholder?: string;
+    labels?: {
+        send?: string;
+        stop?: string;
+    };
+    caption?: ReactNode;
+}
+export interface ChatStarterItem {
+    label: string;
+    color?: string;
+}
+export interface ChatStarterProps extends ChatSxProps {
+    icon?: ReactNode;
+    title?: ReactNode;
+    description?: ReactNode;
+    items: string[] | ChatStarterItem[];
+    size?: 'small' | 'medium';
+    onSelect?: (prompt: string) => void;
+}
+export interface ChatActionsContainerProps extends ChatSxProps {
+    children: ReactNode;
+}
+export interface ChatRatingActionProps {
+    onRatingChange?: (rating: 'up' | 'down' | null) => void;
+    rating?: 'up' | 'down' | null;
+    labels?: {
+        thumbUp?: string;
+        thumbDown?: string;
+    };
+}
+export interface ChatToolItem {
+    id: string;
+    name: string;
+    status: 'loading' | 'thinking' | 'complete' | 'error';
+    content?: ReactNode;
+}
+export interface ChatToolsProps extends ChatSxProps {
+    tools: ChatToolItem[];
+    labels?: {
+        title?: string;
+    };
+}

package/dist/types/components/copy-button/copy-button.d.ts

@@ -0,0 +1,2 @@
+import { CopyButtonProps } from './types';
+export declare function CopyButton({ copyText, onSuccess, onError, 'aria-label': ariaLabel, ...props }: CopyButtonProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/copy-button/types.d.ts

@@ -0,0 +1,6 @@
+import { IconButtonProps } from '@mui/material/IconButton';
+export interface CopyButtonProps extends Omit<IconButtonProps, 'onError' | 'onClick'> {
+    copyText: string;
+    onSuccess?: () => void;
+    onError?: (err: Error) => void;
+}

package/dist/types/components/index.d.ts

@@ -18,3 +18,5 @@ export { BasemapsUI } from './basemaps/basemaps';
 export type { BasemapsUIProps } from './basemaps/types';
 export { Tooltip, setTooltipEnterDelay } from './tooltip/tooltip';
 export { SmartTooltip } from './smart-tooltip/smart-tooltip';
+export type { CopyButtonProps } from './copy-button/types';
+export { CopyButton } from './copy-button/copy-button';

package/dist/types/widgets/_shared/chart-config/option-builders.d.ts

@@ -8,7 +8,7 @@ import { CallbackDataParams, TopLevelFormatterParams } from '../../../../node_mo
  * Rounds a value up to the nearest "nice" number.
  * A nice number is a multiple of 10^floor(log10(value)).
  *
- * Examples: 547 → 600, 200 → 200, 1200 → 2000, 18 → 20, 5 → 5
+ * Examples: 547 → 600, 200 → 200, 1200 → 2000, 18 → 20, 5 → 5, -547 → -500
  */
 export declare function niceNum(value: number): number;
 /**

package/dist/types/widgets/category/config.d.ts

@@ -1,16 +1,9 @@
 import { DownloadItem } from '../actions';
 import { ConfigProps } from '../loader/types';
-import { CategoryWidgetConfig, CategoryWidgetData, CategorySeriesConfig, CategoryLabels } from './types';
-export interface CategoryDownloadConfigProps extends ConfigProps {
+import { CategoryWidgetConfig, CategoryWidgetData, CategorySeriesConfig } from './types';
+interface CategoryDownloadConfigProps extends ConfigProps {
     series?: CategorySeriesConfig[];
 }
-export interface CategoryConfigProps {
-    data?: CategoryWidgetData;
-    series?: CategorySeriesConfig[];
-    formatter?: (value: number) => string;
-    maxItems?: number;
-    labels?: CategoryLabels;
-    max?: number;
-}
 export declare function categoryDownloadConfig({ refUI, series, }: CategoryDownloadConfigProps): DownloadItem<CategoryWidgetData>[];
 export declare function categoryConfig(): CategoryWidgetConfig;
+export {};

package/dist/types/widgets/range/config.d.ts

@@ -1,6 +1,2 @@
 import { RangeWidgetConfig } from './types';
-export interface RangeConfigProps {
-    formatter?: (value: number) => string;
-    onChange?: (value: number[], index: number) => void;
-}
 export declare function rangeConfig(): RangeWidgetConfig;

package/dist/types/widgets/spread/config.d.ts

@@ -1,10 +1,5 @@
 import { DownloadItem } from '../actions';
 import { ConfigProps } from '../loader/types';
 import { SpreadWidgetConfig, SpreadWidgetData } from './types';
-import { SeriesConfig } from '../formula/types';
-export interface SpreadConfigProps {
-    formatter?: (value: number) => string;
-    series?: SeriesConfig[];
-}
 export declare function spreadDownloadConfig({ refUI, }: ConfigProps): DownloadItem<SpreadWidgetData>[];
 export declare function spreadConfig(): SpreadWidgetConfig;

package/dist/types/widgets/table/config.d.ts

@@ -1,6 +1,5 @@
 import { ConfigProps } from '../loader/types';
-import { TableDownloadConfig, TableWidgetConfig, TableColumn, Mode, SortDirection } from './types';
-export declare const DEFAULT_MODE: Mode;
+import { TableDownloadConfig, TableWidgetConfig, TableColumn, SortDirection } from './types';
 export declare const DEFAULT_PAGE = 0;
 export declare const DEFAULT_ROWS_PER_PAGE = 10;
 export declare const DEFAULT_ROWS_PER_PAGE_OPTIONS: number[];

package/dist/types/widgets/table/table-ui.d.ts

@@ -4,7 +4,7 @@ import { TableUIProps } from './types';
 /**
  * Props for the base Table component
  */
-export interface TableComponentProps extends MuiTableProps {
+interface TableComponentProps extends MuiTableProps {
     /** Table element ref */
     ref?: Ref<HTMLTableElement>;
 }

package/dist/types/widgets/wrapper/components/options.d.ts

@@ -1,2 +1,2 @@
 import { WrapperOptionsProps } from '../types';
-export declare function Options({ labels, options }: WrapperOptionsProps): import("react/jsx-runtime").JSX.Element;
+export declare function Options({ labels, options, }: WrapperOptionsProps): import("react/jsx-runtime").JSX.Element;