@factorialco/f0-react 1.289.0 → 1.291.0

package/dist/experimental.d.ts

@@ -31,6 +31,7 @@ import { DotTagCellValue } from './types/dotTag';
 import { DotTagCellValue as DotTagCellValue_2 } from '../../value-display/types/dotTag';
 import * as DropdownMenuPrimitive from '@radix-ui/react-dropdown-menu';
 import { Editor } from '@tiptap/react';
+import { F0SelectProps as F0SelectProps_2 } from './types';
 import { f1Colors } from '@factorialco/f0-core';
 import { FC } from 'react';
 import { FieldPath } from 'react-hook-form';
@@ -216,7 +217,9 @@ declare type ActionLinkProps = ActionBaseProps & {
     className?: string;
 };
 
-declare type ActionProps = {
+declare type ActionProps = ActionLinkProps | ActionButtonProps;
+
+declare type ActionProps_2 = {
     buttonType: "gradient" | "internal";
     label: string;
     onClick: () => void;
@@ -225,8 +228,6 @@ declare type ActionProps = {
     icon?: IconType;
 };
 
-declare type ActionProps_2 = ActionLinkProps | ActionButtonProps;
-
 declare type ActionProps_3 = {
     /**
      * The label of the action
@@ -464,7 +465,7 @@ export declare type AiPromotionChatProviderProps = {
         noBoldText: string;
         boldText: string;
     }[];
-    actions?: ActionProps[];
+    actions?: ActionProps_2[];
     onShow?: () => void;
     onHide?: () => void;
     children: React.ReactNode;
@@ -501,7 +502,7 @@ declare interface AiPromotionChatState {
         noBoldText: string;
         boldText: string;
     }[];
-    actions?: ActionProps[];
+    actions?: ActionProps_2[];
     onShow?: () => void;
     onHide?: () => void;
 }
@@ -939,18 +940,20 @@ export declare type BreadcrumbSelectItemType = BreadcrumbBaseItemType & {
     externalSearch?: boolean;
     onChange: BreadcrumbSelectProps<string, RecordType>["onChange"];
     value?: string;
-    defaultItem?: SelectItemObject<string, RecordType>;
+    defaultItem?: F0SelectItemObject<string, RecordType>;
 } & ({
     source: DataSourceDefinition<RecordType, FiltersDefinition, SortingsDefinition, GroupingDefinition<RecordType>>;
-    mapOptions: (item: RecordType) => SelectItemProps<string>;
+    mapOptions: (item: RecordType) => F0SelectItemProps<string>;
     options?: never;
 } | {
     source?: never;
     mapOptions?: never;
-    options: SelectItemProps<string, RecordType>[];
+    options: F0SelectItemProps<string, RecordType>[];
 });
 
-export declare type BreadcrumbSelectProps<T extends string, R = unknown> = SelectProps<T, R>;
+export declare type BreadcrumbSelectProps<T extends string, R = unknown> = F0SelectProps<T, R> & {
+    multiple?: false;
+};
 
 export declare interface BreadcrumbsProps {
     /** Array of breadcrumb items to display */
@@ -1039,7 +1042,7 @@ declare type ButtonDropdownItem<T = string> = {
     description?: string;
 };
 
-declare type ButtonInternalProps = Pick<ActionProps_2, "size" | "disabled" | "className" | "pressed" | "compact" | "variant" | "tooltip"> & DataAttributes & {
+declare type ButtonInternalProps = Pick<ActionProps, "size" | "disabled" | "className" | "pressed" | "compact" | "variant" | "tooltip"> & DataAttributes & {
     /**
      * The aria-label of the button if not provided title or label will be used.
      */
@@ -1353,7 +1356,9 @@ export declare const ChartWidgetEmptyState: ForwardRefExoticComponent<Props_5 &
 
 export declare type ChatWidgetEmptyStateProps = Props_5;
 
-declare type ChildrenResponse<R extends RecordType> = BaseResponse<R> | R[] | NestedResponseWithType<R>;
+declare type ChildrenPaginationInfo<R extends RecordType> = Omit<InfiniteScrollPaginatedResponse<R>, "type" | "records">;
+
+declare type ChildrenResponse<R extends RecordType> = NestedResponseWithType<R>;
 
 declare type ChipLabel = {
     label: string;
@@ -1905,11 +1910,11 @@ export declare type DataSourceDefinition<R extends RecordType = RecordType, Filt
     currentGrouping?: GroupingState<R, Grouping>;
     /*******************************************************/
     /***** NESTED RECORDS ***************************************************/
-    fetchChildren?: (item: R, filters?: FiltersState<FiltersDefinition>) => Promise<ChildrenResponse<R>>;
+    fetchChildren?: (item: R, filters?: FiltersState<FiltersDefinition>, pagination?: ChildrenPaginationInfo<R>) => Promise<ChildrenResponse<R>>;
     /** Function to determine if an item has children */
     itemsWithChildren?: (item: R) => boolean;
     /** Function to get the number of children for an item */
-    childrenCount?: (item: R) => number | undefined;
+    childrenCount?: (item: R, pagination?: ChildrenPaginationInfo<R>) => number | undefined;
 };
 
 export declare type DateFilterDefinition = BaseFilterDefinition<"date"> & {
@@ -2191,6 +2196,7 @@ declare const defaultTranslations: {
         readonly other: "Other actions";
         readonly toggle: "Toggle";
         readonly toggleDropdownMenu: "Toggle dropdown menu";
+        readonly selectAll: "Select all";
     };
     readonly status: {
         readonly selected: {
@@ -2199,6 +2205,13 @@ declare const defaultTranslations: {
         };
     };
     readonly filters: {
+        readonly searchPlaceholder: "Search filters...";
+        readonly inFilter: {
+            readonly searchPlaceholder: "Search options...";
+        };
+        readonly activeFilters: "Active filters: {{filters}}";
+        readonly filteringBy: "Filtering by {{label}}";
+        readonly availableFilters: "Available filters";
         readonly label: "Filters";
         readonly applyFilters: "Apply filters";
         readonly applySelection: "Apply selection";
@@ -2842,6 +2855,78 @@ declare interface F0IconProps extends SVGProps<SVGSVGElement>, VariantProps<type
     color?: "default" | "currentColor" | `#${string}` | Lowercase<NestedKeyOf<typeof f1Colors.icon>>;
 }
 
+declare type F0SelectItemObject<T, R = unknown> = {
+    type?: "item";
+    value: T;
+    label: string;
+    description?: string;
+    avatar?: AvatarVariant;
+    tag?: string;
+    icon?: IconType;
+    item?: R;
+    disabled?: boolean;
+};
+export { F0SelectItemObject }
+export { F0SelectItemObject as SelectItemObject }
+
+declare type F0SelectItemProps<T, R = unknown> = F0SelectItemObject<T, R> | {
+    type: "separator";
+};
+export { F0SelectItemProps }
+export { F0SelectItemProps as SelectItemProps }
+
+/**
+ * Select component for choosing from a list of options.
+ *
+ * @template T - The type of the emitted  value
+ * @template R - The type of the record/item data (used with data source)
+ *
+ */
+declare type F0SelectProps<T extends string, R = unknown> = {
+    onChangeSelectedOption?: (option: F0SelectItemObject<T, ResolvedRecordType<R>> | undefined, checked: boolean) => void;
+    children?: React.ReactNode;
+    open?: boolean;
+    showSearchBox?: boolean;
+    searchBoxPlaceholder?: string;
+    onSearchChange?: (value: string) => void;
+    searchValue?: string;
+    onOpenChange?: (open: boolean) => void;
+    searchEmptyMessage?: string;
+    className?: string;
+    selectContentClassName?: string;
+    actions?: Action[];
+    portalContainer?: HTMLElement | null;
+} & ({
+    clearable?: false;
+    multiple?: false;
+    value?: T;
+    defaultItem?: F0SelectItemObject<T, ResolvedRecordType<R>>;
+    onChange?: (value: T, originalItem?: ResolvedRecordType<R> | undefined, option?: F0SelectItemObject<T, ResolvedRecordType<R>>) => void;
+} | {
+    clearable: true;
+    multiple?: false;
+    value?: T;
+    defaultItem?: F0SelectItemObject<T, ResolvedRecordType<R>>;
+    onChange?: (value: T, originalItem?: ResolvedRecordType<R> | undefined, option?: F0SelectItemObject<T, ResolvedRecordType<R>>) => void;
+} | {
+    multiple: true;
+    clearable?: boolean;
+    value?: T[];
+    defaultItem?: F0SelectItemObject<T, ResolvedRecordType<R>>[];
+    onChange?: (value: T[], originalItems: ResolvedRecordType<R>[], options: F0SelectItemObject<T, ResolvedRecordType<R>>[]) => void;
+}) & ({
+    source: DataSourceDefinition<ResolvedRecordType<R>, FiltersDefinition, SortingsDefinition, GroupingDefinition<ResolvedRecordType<R>>>;
+    mapOptions: (item: ResolvedRecordType<R>) => F0SelectItemProps<T, ResolvedRecordType<R>>;
+    options?: never;
+} | {
+    source?: never;
+    mapOptions?: never;
+    searchFn?: (option: F0SelectItemProps<T, unknown>, search?: string) => boolean | undefined;
+    options: F0SelectItemProps<T, unknown>[];
+}) & Pick<InputFieldProps<T>, "required" | "loading" | "hideLabel" | "labelIcon" | "size" | "label" | "icon" | "placeholder" | "disabled" | "name" | "error" | "status" | "hint">;
+export { F0SelectProps }
+export { F0SelectProps as SelectProps }
+
 export declare function F0TableOfContent(props: TOCProps): JSX_2.Element;
 
 declare const F0TagAlert: ForwardRefExoticComponent<Props_8 & RefAttributes<HTMLDivElement>>;
@@ -3962,6 +4047,7 @@ declare type NestedKeyOf<T> = {
 declare type NestedResponseWithType<R extends RecordType> = {
     records: R[];
     type?: NestedVariant;
+    paginationInfo?: ChildrenPaginationInfo<R>;
 };
 
 declare type NestedVariant = "basic" | "detailed";
@@ -5090,7 +5176,10 @@ declare type SectionProps_2 = {
     onItemVisible?: (id: string) => void;
 };
 
-export declare const Select: <T extends string = string, R = unknown>(props: SelectProps<T, R> & {
+/**
+ * @experimental This is an experimental component use it at your own risk
+ */
+export declare const Select: <T extends string = string, R = unknown>(props: F0SelectProps_2<T, R> & {
     ref?: React.Ref<HTMLButtonElement>;
 }) => React.ReactElement;
 
@@ -5126,57 +5215,6 @@ export declare type SelectedItemsState = {
     }>;
 };
 
-export declare type SelectItemObject<T, R = unknown> = {
-    type?: "item";
-    value: T;
-    label: string;
-    description?: string;
-    avatar?: AvatarVariant;
-    tag?: string;
-    icon?: IconType;
-    item?: R;
-    disabled?: boolean;
-};
-
-export declare type SelectItemProps<T, R = unknown> = SelectItemObject<T, R> | {
-    type: "separator";
-};
-
-/**
- * Select component for choosing from a list of options.
- *
- * @template T - The type of the emitted  value
- * @template R - The type of the record/item data (used with data source)
- *
- */
-export declare type SelectProps<T extends string, R = unknown> = {
-    onChange: (value: T, originalItem?: ResolvedRecordType<R>, option?: SelectItemObject<T, ResolvedRecordType<R>>) => void;
-    onChangeSelectedOption?: (option: SelectItemObject<T, ResolvedRecordType<R>> | undefined) => void;
-    value?: T;
-    defaultItem?: SelectItemObject<T, ResolvedRecordType<R>>;
-    children?: React.ReactNode;
-    open?: boolean;
-    showSearchBox?: boolean;
-    searchBoxPlaceholder?: string;
-    onSearchChange?: (value: string) => void;
-    searchValue?: string;
-    onOpenChange?: (open: boolean) => void;
-    searchEmptyMessage?: string;
-    className?: string;
-    selectContentClassName?: string;
-    actions?: Action[];
-    portalContainer?: HTMLElement | null;
-} & ({
-    source: DataSourceDefinition<ResolvedRecordType<R>, FiltersDefinition, SortingsDefinition, GroupingDefinition<ResolvedRecordType<R>>>;
-    mapOptions: (item: ResolvedRecordType<R>) => SelectItemProps<T, ResolvedRecordType<R>>;
-    options?: never;
-} | {
-    source?: never;
-    mapOptions?: never;
-    searchFn?: (option: SelectItemProps<T, unknown>, search?: string) => boolean | undefined;
-    options: SelectItemProps<T, unknown>[];
-}) & Pick<InputFieldProps<T>, "required" | "loading" | "hideLabel" | "clearable" | "labelIcon" | "size" | "label" | "icon" | "placeholder" | "disabled" | "name" | "error" | "status" | "hint">;
-
 export declare type SelectQuestionOption = {
     id?: string;
     value: string;
@@ -6229,6 +6267,31 @@ declare global {
 }
 
 
+declare module "gridstack" {
+    interface GridStackWidget {
+        id?: string;
+        allowedSizes?: Array<{
+            w: number;
+            h: number;
+        }>;
+        renderFn?: () => React.ReactElement | null;
+        meta?: Record<string, unknown>;
+    }
+    interface GridStackNode {
+        id?: string;
+        w?: number;
+        h?: number;
+        x?: number;
+        y?: number;
+        allowedSizes?: Array<{
+            w: number;
+            h: number;
+        }>;
+        renderFn?: () => React.ReactElement | null;
+    }
+}
+
+
 declare module "@tiptap/core" {
     interface Commands<ReturnType> {
         aiBlock: {
@@ -6256,31 +6319,6 @@ declare module "@tiptap/core" {
 }
 
 
-declare module "gridstack" {
-    interface GridStackWidget {
-        id?: string;
-        allowedSizes?: Array<{
-            w: number;
-            h: number;
-        }>;
-        renderFn?: () => React.ReactElement | null;
-        meta?: Record<string, unknown>;
-    }
-    interface GridStackNode {
-        id?: string;
-        w?: number;
-        h?: number;
-        x?: number;
-        y?: number;
-        allowedSizes?: Array<{
-            w: number;
-            h: number;
-        }>;
-        renderFn?: () => React.ReactElement | null;
-    }
-}
-
-
 declare namespace Calendar {
     var displayName: string;
 }