@factorialco/f0-react 1.236.4 → 1.238.0

package/dist/experimental.d.ts

@@ -63,6 +63,7 @@ import { ReactElement } from 'react';
 import { ReactNode } from 'react';
 import * as RechartsPrimitive from 'recharts';
 import { RefAttributes } from 'react';
+import { RefObject } from 'react';
 import { ScrollAreaProps } from '@radix-ui/react-scroll-area';
 import { StatusCellValue } from './types/status.tsx';
 import { StatusCellValue as StatusCellValue_2 } from '../../value-display/types/status';
@@ -117,6 +118,15 @@ export declare interface ActionItemProps {
 }
 
 declare type ActionProps = {
+    buttonType: "gradient" | "internal";
+    label: string;
+    onClick: () => void;
+    isLoading: boolean;
+    buttonVariant?: ButtonVariant;
+    icon?: IconType;
+};
+
+declare type ActionProps_2 = {
     /**
      * The label of the action
      */
@@ -309,6 +319,64 @@ declare interface AiChatState {
     onThumbsDown?: (message: AIMessage, threadId: string) => void;
 }
 
+/**
+ * @experimental This is an experimental component use it at your own risk
+ */
+export declare const AiPromotionChat: () => JSX_2.Element | null;
+
+export declare const AiPromotionChatProvider: ({ enabled, greeting, title, description, benefits, actions, onShow, onHide, children, }: AiPromotionChatProviderProps) => JSX_2.Element;
+
+export declare type AiPromotionChatProviderProps = {
+    enabled?: boolean;
+    greeting?: string;
+    title?: string;
+    description?: string;
+    benefits?: {
+        noBoldText: string;
+        boldText: string;
+    }[];
+    actions?: ActionProps[];
+    onShow?: () => void;
+    onHide?: () => void;
+    children: React.ReactNode;
+};
+
+declare type AiPromotionChatProviderReturnValue = {
+    enabled: boolean;
+    setEnabled: React.Dispatch<React.SetStateAction<boolean>>;
+    open: boolean;
+    setOpen: React.Dispatch<React.SetStateAction<boolean>>;
+    shouldPlayEntranceAnimation: boolean;
+    setShouldPlayEntranceAnimation: React.Dispatch<React.SetStateAction<boolean>>;
+    /**
+     * Set the amount of minutes after which the chat will be cleared automatically
+     * Set `null` to disable auto-clearing
+     *
+     * @default 15
+     */
+    setAutoClearMinutes: React.Dispatch<React.SetStateAction<number | null>>;
+    autoClearMinutes: number | null;
+    /**
+     * Clear/reset the chat conversation
+     */
+    clear: () => void;
+    /* Excluded from this release type: setClearFunction */
+} & Pick<AiPromotionChatState, "greeting" | "title" | "description" | "benefits" | "actions" | "onShow" | "onHide">;
+
+declare interface AiPromotionChatState {
+    enabled: boolean;
+    greeting?: string;
+    title?: string;
+    description?: string;
+    benefits?: {
+        noBoldText: string;
+        boldText: string;
+    }[];
+    actions?: ActionProps[];
+    onShow?: () => void;
+    onHide?: () => void;
+}
+
 export declare const Alert: React_2.ForwardRefExoticComponent<Omit<React_2.HTMLAttributes<HTMLDivElement> & VariantProps<(props?: ({
     variant?: "info" | "warning" | "positive" | "destructive" | undefined;
 } & ({
@@ -370,10 +438,11 @@ declare const alertVariants: (props?: ({
     className?: ClassValue;
 })) | undefined) => string;
 
-export declare function ApplicationFrame({ children, sidebar, banner, ai, }: ApplicationFrameProps): JSX_2.Element;
+export declare function ApplicationFrame({ children, sidebar, banner, ai, aiPromotion, }: ApplicationFrameProps): JSX_2.Element;
 
 export declare interface ApplicationFrameProps {
     ai?: Omit<AiChatProviderProps, "children">;
+    aiPromotion?: Omit<AiPromotionChatProviderProps, "children">;
     banner?: React.ReactNode;
     sidebar: React.ReactNode;
     children: React.ReactNode;
@@ -813,7 +882,7 @@ declare interface ButtonProps_2 extends React_2.ButtonHTMLAttributes<HTMLButtonE
 
 declare type ButtonSize = (typeof sizes)[number];
 
-declare type ButtonVariant = (typeof variants_3)[number];
+declare type ButtonVariant = (typeof variants)[number];
 
 declare const buttonVariants: (props?: ({
     disabled?: boolean | undefined;
@@ -882,7 +951,7 @@ declare interface CalloutSkeletonProps {
     variant?: CalloutVariant;
 }
 
-declare type CalloutVariant = (typeof variants)[number];
+declare type CalloutVariant = (typeof variants_2)[number];
 
 declare type CardAvatarVariant = AvatarVariant | {
     type: "emoji";
@@ -1027,7 +1096,7 @@ declare type ChartConfig_2 = {
 
 declare const ChartContainer: React_2.ForwardRefExoticComponent<Omit<ChartContainerComponentProps, "ref"> & React_2.RefAttributes<HTMLDivElement>>;
 
-declare interface ChartContainerComponentProps extends React_2.ComponentProps<"div">, VariantProps<typeof variants_2> {
+declare interface ChartContainerComponentProps extends React_2.ComponentProps<"div">, VariantProps<typeof variants_3> {
     config: ChartConfig_2;
     children: React_2.ComponentProps<typeof RechartsPrimitive.ResponsiveContainer>["children"];
 }
@@ -1282,6 +1351,15 @@ export declare type CurrentFilters<F extends FilterOptions<string>> = F extends
 
 declare type CustomEmptyStates = Partial<Record<EmptyStateType, Partial<EmptyState>>>;
 
+export declare type CustomVisualizationProps<Source extends {
+    dataAdapter: DataCollectionDataAdapter<any, any, any>;
+}> = {
+    onSelectItems: OnSelectItemsCallback<InferRecord<Source>, InferFilters<Source>>;
+    onLoadData: OnLoadDataCallback<InferRecord<Source>, InferFilters<Source>>;
+    onLoadError: OnLoadErrorCallback;
+    source: Source;
+};
+
 export declare const Dashboard: ForwardRefExoticComponent<DashboardProps & RefAttributes<HTMLDivElement>> & {
     Skeleton: () => JSX_2.Element;
 };
@@ -1295,6 +1373,12 @@ declare type DashboardProps_2 = {
     children: ReactNode[];
 };
 
+declare type Data<R extends RecordType> = {
+    records: WithGroupId<R>[];
+    type: "grouped" | "flat";
+    groups: GroupRecord<R>[];
+};
+
 /**
  * Combined type for all possible data adapter configurations
  * @template R - The type of records in the collection
@@ -1916,7 +2000,7 @@ declare type EmptyState = {
     emoji?: string;
     title: string;
     description?: string;
-    actions?: ActionProps[];
+    actions?: ActionProps_2[];
 };
 
 declare const emptyStatesTypes: readonly ["no-data", "no-results", "error"];
@@ -2450,6 +2534,11 @@ export declare const granularityDefinitions: Record<string, GranularityDefinitio
 
 export declare type GranularityDefinitionSimple = Pick<GranularityDefinition, "toRangeString" | "toString">;
 
+/**
+ * Symbol used to identify the groupId in the data
+ */
+declare const GROUP_ID_SYMBOL: unique symbol;
+
 /**
  * Defines the structure and configuration of a grouping options for a data source.
  * @template RecordType - The type of records in the collection
@@ -2487,6 +2576,13 @@ export declare type GroupingState<R extends RecordType, Grouping extends Groupin
     order?: SortOrder;
 } | undefined;
 
+declare type GroupRecord<RecordType> = {
+    key: string;
+    label: string | Promise<string>;
+    itemCount: number | undefined | Promise<number | undefined>;
+    records: RecordType[];
+};
+
 declare type HeaderProps = {
     module: {
         id: ModuleId;
@@ -2569,6 +2665,19 @@ export declare interface IndicatorsListProps {
     items: ComponentProps<typeof Indicator>[];
 }
 
+declare type InferFilters<S> = S extends {
+    dataAdapter: DataCollectionDataAdapter<any, infer F, any>;
+} ? F : never;
+
+/**
+ * Returns the custom visualization props based on the data collection source.
+ *
+ * @template Source - The data collection source
+ */
+declare type InferRecord<S> = S extends {
+    dataAdapter: DataCollectionDataAdapter<infer R, any, any>;
+} ? R : never;
+
 declare type InferSchema<T extends SchemaType> = z.infer<T>;
 
 declare type InFilterDefinition<T = unknown> = BaseFilterDefinition<"in"> & {
@@ -3383,7 +3492,7 @@ declare type OneEmptyStateProps = {
      * and can include a label, click handler, optional icon, and button variant.
      * @optional
      */
-    actions?: ActionProps[];
+    actions?: ActionProps_2[];
 } & ({
     /**
      * The variant of the empty state
@@ -4284,6 +4393,11 @@ declare interface SidebarProps {
 
 declare type SidebarState = "locked" | "unlocked" | "hidden";
 
+/**
+ * Response structure for non-paginated data
+ */
+declare type SimpleResult<T> = T[];
+
 declare const sizes: readonly ["sm", "md", "lg"];
 
 declare const skeletonVariants: (props?: ({
@@ -4863,7 +4977,7 @@ declare type Type = "bar-chart" | "line-chart";
 
 declare namespace Types {
     export {
-        ActionProps,
+        ActionProps_2 as ActionProps,
         OneEmptyStateProps
     }
 }
@@ -4872,12 +4986,73 @@ declare type URL_2 = string;
 
 export declare function useAiChat(): AiChatProviderReturnValue;
 
+export declare function useAiPromotionChat(): AiPromotionChatProviderReturnValue;
+
+export declare type UseDataCollectionData<R extends RecordType> = UseDataCollectionDataReturn<R> & {
+    summaries?: R;
+};
+
+export declare function useDataCollectionData<R extends RecordType, Filters extends FiltersDefinition, Sortings extends SortingsDefinition, Summaries extends SummariesDefinition, NavigationFilters extends NavigationFiltersDefinition, Grouping extends GroupingDefinition<R>>(source: DataCollectionSource<R, Filters, Sortings, Summaries, ItemActionsDefinition<R>, NavigationFilters, Grouping>, options?: UseDataOptions<R, Filters>): UseDataCollectionData<R>;
+
+/**
+ * Hook return type for useData
+ */
+declare type UseDataCollectionDataReturn<R extends RecordType> = UseDataReturn<R> & {
+    summaries?: R;
+};
+
 export declare const useDataCollectionSource: <R extends RecordType = RecordType, FiltersSchema extends FiltersDefinition = FiltersDefinition, Sortings extends SortingsDefinition = SortingsDefinition, Summaries extends SummariesDefinition = SummariesDefinition, ItemActions extends ItemActionsDefinition<R> = ItemActionsDefinition<R>, NavigationFilters extends NavigationFiltersDefinition = NavigationFiltersDefinition, Grouping extends GroupingDefinition<R> = GroupingDefinition<R>>(source: DataCollectionSourceDefinition<R, FiltersSchema, Sortings, Summaries, ItemActions, NavigationFilters, Grouping>, deps?: ReadonlyArray<unknown>) => DataCollectionSource<R, FiltersSchema, Sortings, Summaries, ItemActions, NavigationFilters, Grouping>;
 
+/**
+ * Hook options for useData
+ */
+declare interface UseDataOptions<R extends RecordType, Filters extends FiltersDefinition> {
+    filters?: Partial<FiltersState<Filters>>;
+    /**
+     * A function that is called when an error occurs during data fetching.
+     * It is called with the error object.
+     * @param error - The error object.
+     */
+    onError?: (error: DataError) => void;
+    /**
+     * A function that provides the fetch parameters for the data source.
+     * It is called before each fetch request and can be used to modify the fetch parameters.
+     * @param options - The fetch parameters for the data source.
+     * @returns The fetch parameters for the data source.
+     */
+    fetchParamsProvider?: <O extends BaseFetchOptions<Filters>>(options: O) => O;
+    /**
+     * A function that is called when the data is fetched successfully.
+     * It is called with the response data.
+     * @param response - The response data.
+     */
+    onResponse?: (response: PaginatedResponse<R> | SimpleResult<R>) => void;
+}
+
+/**
+ * Hook return type for useData
+ */
+declare interface UseDataReturn<R extends RecordType> {
+    data: Data<R>;
+    isInitialLoading: boolean;
+    isLoading: boolean;
+    isLoadingMore: boolean;
+    error: DataError | null;
+    paginationInfo: PaginationInfo | null;
+    setPage: (page: number) => void;
+    loadMore: () => void;
+    totalItems: number | undefined;
+    mergedFilters: FiltersState<FiltersDefinition>;
+}
+
 export { useForm }
 
 export declare function useFormSchema<Schema extends SchemaType, FormData extends InferSchema<Schema>>(schema: Schema, options: UseFormProps<FormData>, onSubmit: OnSubmitHandler<FormData>): FormType<Schema, FormData>;
 
+export declare const useInfiniteScrollPagination: (paginationInfo: PaginationInfo | null, isLoading: boolean, isLoadingMore: boolean, loadMore: () => void) => {
+    loadingIndicatorRef: RefObject<HTMLTableCellElement>;
+};
+
 export declare interface User {
     id: string;
     fullname: string;
@@ -4930,9 +5105,11 @@ declare type ValueDisplayVisualizationType = "table" | "card" | "list" | (string
 
 declare type Variant = "neutral" | "info" | "positive" | "warning" | "critical";
 
-declare const variants: readonly ["ai", "critical", "positive", "info", "warning"];
+declare const variants: readonly ["default", "outline", "critical", "neutral", "ghost", "promote", "outlinePromote"];
 
-declare const variants_2: (props?: ({
+declare const variants_2: readonly ["ai", "critical", "positive", "info", "warning"];
+
+declare const variants_3: (props?: ({
     aspect?: "small" | "square" | "wide" | undefined;
 } & ({
     class?: ClassValue;
@@ -4942,8 +5119,6 @@ declare const variants_2: (props?: ({
     className?: ClassValue;
 })) | undefined) => string;
 
-declare const variants_3: readonly ["default", "outline", "critical", "neutral", "ghost", "promote", "outlinePromote"];
-
 export declare const VerticalBarChartWidget: ForwardRefExoticComponent<Omit<WidgetProps_2 & {
 chart: VerticalBarChartProps;
 } & RefAttributes<HTMLDivElement>, "ref"> & RefAttributes<HTMLElement | SVGElement>>;
@@ -5135,6 +5310,10 @@ export declare const WidgetStrip: ForwardRefExoticComponent<DashboardProps_2 & R
 
 declare type WidgetWidth = "sm" | "md" | "lg";
 
+declare type WithGroupId<RecordType> = RecordType & {
+    [GROUP_ID_SYMBOL]: unknown | undefined;
+};
+
 declare type WithOptionalSorting<R extends RecordType, Sortings extends SortingsDefinition> = Omit<PropertyDefinition_2<R>, "hide"> & {
     sorting?: SortingKey<Sortings>;
     /**
@@ -5191,11 +5370,6 @@ declare module "@tiptap/core" {
 }
 
 
-declare namespace Calendar {
-    var displayName: string;
-}
-
-
 declare module "@tiptap/core" {
     interface Commands<ReturnType> {
         moodTracker: {
@@ -5203,3 +5377,8 @@ declare module "@tiptap/core" {
         };
     }
 }
+
+
+declare namespace Calendar {
+    var displayName: string;
+}