@factorialco/f0-react 1.237.0 → 1.238.1

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';
@@ -1350,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;
 };
@@ -1363,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
@@ -2518,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
@@ -2555,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;
@@ -2637,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"> & {
@@ -4352,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?: ({
@@ -4942,12 +4988,71 @@ 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;
@@ -5205,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>;
     /**