@cfast/ui 0.0.1

package/dist/types-BvAqMZhn.d.ts

@@ -0,0 +1,403 @@
+import { ReactNode, ComponentType } from 'react';
+import { ClientDescriptor, Serializable, ActionPermissionStatus } from '@cfast/actions';
+
+type UIPluginComponents = {
+    button: ComponentType<ButtonSlotProps>;
+    tooltip: ComponentType<TooltipSlotProps>;
+    confirmDialog: ComponentType<ConfirmDialogSlotProps>;
+    table: ComponentType<TableSlotProps>;
+    tableHead: ComponentType<TableSectionSlotProps>;
+    tableBody: ComponentType<TableSectionSlotProps>;
+    tableRow: ComponentType<TableRowSlotProps>;
+    tableCell: ComponentType<TableCellSlotProps>;
+    chip: ComponentType<ChipSlotProps>;
+    appShell: ComponentType<AppShellSlotProps>;
+    sidebar: ComponentType<SidebarSlotProps>;
+    pageContainer: ComponentType<PageContainerSlotProps>;
+    breadcrumb: ComponentType<BreadcrumbSlotProps>;
+    toast: ComponentType<ToastSlotProps>;
+    alert: ComponentType<AlertSlotProps>;
+    dropZone: ComponentType<DropZoneSlotProps>;
+};
+type UIPlugin = {
+    components: Partial<UIPluginComponents>;
+};
+type ButtonSlotProps = {
+    children: ReactNode;
+    onClick?: () => void;
+    disabled?: boolean;
+    loading?: boolean;
+    variant?: "solid" | "soft" | "outlined" | "plain";
+    color?: "primary" | "neutral" | "danger" | "success" | "warning";
+    size?: "sm" | "md" | "lg";
+    type?: "button" | "submit";
+    startDecorator?: ReactNode;
+};
+type TooltipSlotProps = {
+    title: string;
+    children: ReactNode;
+};
+type ConfirmDialogSlotProps = {
+    open: boolean;
+    onClose: () => void;
+    onConfirm: () => void;
+    title: string;
+    description?: string;
+    confirmLabel?: string;
+    cancelLabel?: string;
+    variant?: "default" | "danger";
+};
+type TableSlotProps = {
+    children: ReactNode;
+    hoverRow?: boolean;
+};
+type TableSectionSlotProps = {
+    children: ReactNode;
+};
+type TableRowSlotProps = {
+    children: ReactNode;
+    selected?: boolean;
+    onClick?: () => void;
+};
+type TableCellSlotProps = {
+    children: ReactNode;
+    header?: boolean;
+    sortable?: boolean;
+    sortDirection?: "asc" | "desc" | null;
+    onSort?: () => void;
+};
+type ChipSlotProps = {
+    children: ReactNode;
+    color?: "primary" | "neutral" | "danger" | "success" | "warning";
+    variant?: "solid" | "soft" | "outlined";
+    size?: "sm" | "md" | "lg";
+};
+type AppShellSlotProps = {
+    children: ReactNode;
+    sidebar?: ReactNode;
+    header?: ReactNode;
+};
+type SidebarSlotProps = {
+    children: ReactNode;
+    items: NavigationItem[];
+};
+type PageContainerSlotProps = {
+    children: ReactNode;
+    title?: string;
+    breadcrumb?: BreadcrumbItem[];
+    actions?: ReactNode;
+    tabs?: TabItem[];
+};
+type BreadcrumbSlotProps = {
+    items: BreadcrumbItem[];
+};
+type ToastSlotProps = {
+    children?: ReactNode;
+};
+type AlertSlotProps = {
+    children: ReactNode;
+    color?: "success" | "danger" | "warning" | "neutral";
+    variant?: "soft" | "solid" | "outlined";
+};
+type DropZoneSlotProps = {
+    children: ReactNode;
+    isDragOver: boolean;
+    isInvalid: boolean;
+    onDrop: (files: FileList) => void;
+    onDragOver: (e: React.DragEvent) => void;
+    onDragLeave: () => void;
+    onClick: () => void;
+    accept?: string;
+};
+type WhenForbidden = "hide" | "disable" | "show";
+type ColumnDef<T = unknown> = {
+    key: string;
+    label?: string;
+    sortable?: boolean;
+    render?: (value: unknown, row: T) => ReactNode;
+    width?: string | number;
+    priority?: number;
+};
+type ColumnShorthand<T = unknown> = string | ColumnDef<T>;
+type FilterType = "text" | "select" | "multiSelect" | "relation" | "dateRange" | "boolean" | "number";
+type FilterOption = {
+    label: string;
+    value: string | number | boolean;
+};
+type FilterDef = {
+    column: string;
+    type: FilterType;
+    label?: string;
+    options?: FilterOption[];
+    table?: unknown;
+    display?: string;
+    placeholder?: string;
+};
+type DataTableProps<T = unknown> = {
+    data: {
+        items: T[];
+        isLoading?: boolean;
+    };
+    table?: unknown;
+    columns?: ColumnShorthand<T>[];
+    actions?: ClientDescriptor;
+    selectable?: boolean;
+    selectedRows?: T[];
+    onSelectionChange?: (rows: T[]) => void;
+    onRowClick?: (row: T) => void;
+    getRowId?: (row: T) => string | number;
+    emptyMessage?: string;
+};
+type FilterBarProps = {
+    table?: unknown;
+    filters: FilterDef[];
+    searchable?: string[];
+    values?: Record<string, unknown>;
+    onChange?: (values: Record<string, unknown>) => void;
+};
+type ListViewProps<T = unknown> = {
+    title: string;
+    data: {
+        items: T[];
+        isLoading?: boolean;
+        total?: number;
+        totalPages?: number;
+        currentPage?: number;
+        goToPage?: (page: number) => void;
+        hasMore?: boolean;
+        loadMore?: () => void;
+    };
+    table?: unknown;
+    columns?: ColumnShorthand<T>[];
+    actions?: ClientDescriptor;
+    filters?: FilterDef[];
+    searchable?: string[];
+    createAction?: ClientDescriptor;
+    createLabel?: string;
+    selectable?: boolean;
+    bulkActions?: BulkAction[];
+    breadcrumb?: BreadcrumbItem[];
+};
+type DetailViewProps<T = unknown> = {
+    title: string;
+    table?: unknown;
+    record: T;
+    fields?: ColumnShorthand<T>[];
+    exclude?: string[];
+    actions?: ClientDescriptor;
+    breadcrumb?: BreadcrumbItem[];
+};
+type BaseFieldProps = {
+    label?: string;
+    className?: string;
+};
+type DateFieldProps = BaseFieldProps & {
+    value: Date | string | number | null | undefined;
+    format?: "short" | "long" | "relative" | "datetime";
+    locale?: string;
+};
+type BooleanFieldProps = BaseFieldProps & {
+    value: boolean | null | undefined;
+    trueLabel?: string;
+    falseLabel?: string;
+    trueColor?: string;
+    falseColor?: string;
+};
+type NumberFieldProps = BaseFieldProps & {
+    value: number | null | undefined;
+    locale?: string;
+    currency?: string;
+    decimals?: number;
+};
+type TextFieldProps = BaseFieldProps & {
+    value: string | null | undefined;
+    maxLength?: number;
+    copyable?: boolean;
+};
+type EmailFieldProps = BaseFieldProps & {
+    value: string | null | undefined;
+};
+type UrlFieldProps = BaseFieldProps & {
+    value: string | null | undefined;
+    truncate?: boolean;
+};
+type ImageFieldProps = BaseFieldProps & {
+    value: string | null | undefined;
+    storage?: unknown;
+    width?: number;
+    height?: number;
+    alt?: string;
+};
+type FileFieldProps = BaseFieldProps & {
+    value: string | null | undefined;
+    storage?: unknown;
+    fileName?: string;
+    fileSize?: number;
+};
+type RelationFieldProps = BaseFieldProps & {
+    value: unknown;
+    display?: string;
+    linkTo?: string;
+};
+type JsonFieldProps = BaseFieldProps & {
+    value: unknown;
+    collapsed?: boolean;
+};
+type ToastType = "success" | "error" | "info" | "warning";
+type ToastOptions = {
+    message: string;
+    type?: ToastType;
+    duration?: number;
+    description?: string;
+};
+type ToastApi = {
+    show: (options: ToastOptions) => void;
+    success: (message: string, description?: string) => void;
+    error: (message: string, description?: string) => void;
+    info: (message: string, description?: string) => void;
+    warning: (message: string, description?: string) => void;
+};
+type ConfirmOptions = {
+    title: string;
+    description?: string;
+    confirmLabel?: string;
+    cancelLabel?: string;
+    variant?: "default" | "danger";
+};
+type NavigationItem = {
+    label: string;
+    to: string;
+    icon?: ComponentType<{
+        className?: string;
+    }>;
+    action?: ClientDescriptor;
+    children?: NavigationItem[];
+};
+type BreadcrumbItem = {
+    label: string;
+    to?: string;
+};
+type TabItem = {
+    label: string;
+    to?: string;
+    value?: string;
+};
+type BulkAction = {
+    label: string;
+    action?: ClientDescriptor;
+    handler?: (rows: unknown[]) => void;
+    confirmation?: string;
+    icon?: ComponentType<{
+        className?: string;
+    }>;
+};
+type ActionButtonProps = {
+    action: ClientDescriptor;
+    actionName?: string;
+    input?: Record<string, Serializable>;
+    children: ReactNode;
+    whenForbidden?: WhenForbidden;
+    confirmation?: string | ConfirmOptions;
+    variant?: "solid" | "soft" | "outlined" | "plain";
+    color?: "primary" | "neutral" | "danger" | "success" | "warning";
+    size?: "sm" | "md" | "lg";
+    startDecorator?: ReactNode;
+};
+type PermissionGateProps = {
+    action: ClientDescriptor;
+    actionName?: string;
+    input?: Record<string, Serializable>;
+    children: ReactNode;
+    fallback?: ReactNode;
+};
+type ActionStatusResult = ActionPermissionStatus & {
+    submit: () => void;
+    pending: boolean;
+    data: unknown;
+    error: unknown;
+};
+type FormStatusData = {
+    success?: string;
+    error?: string;
+    fieldErrors?: Record<string, string[]>;
+};
+type FormStatusProps = {
+    data: FormStatusData | null | undefined;
+};
+type EmptyStateProps = {
+    title: string;
+    description?: string;
+    createAction?: ClientDescriptor;
+    createLabel?: string;
+    icon?: ComponentType<{
+        className?: string;
+    }>;
+};
+type AppShellProps = {
+    children: ReactNode;
+    sidebar?: ReactNode;
+    header?: ReactNode;
+};
+type UserMenuLink = {
+    label: string;
+    to: string;
+    action?: ClientDescriptor;
+};
+type UserMenuProps = {
+    links?: UserMenuLink[];
+    onSignOut?: () => void;
+};
+type DropZoneProps = {
+    upload: {
+        accept: string;
+        start: (file: File) => void;
+        progress: number;
+        isUploading: boolean;
+        result: unknown | null;
+        error: string | null;
+        validationError: string | null;
+        reset: () => void;
+    };
+    multiple?: boolean;
+    children?: ReactNode;
+};
+type ImagePreviewProps = {
+    fileKey?: string | null;
+    src?: string | null;
+    storage?: unknown;
+    getUrl?: (key: string) => string;
+    width?: number;
+    height?: number;
+    fallback?: ReactNode;
+    alt?: string;
+};
+type FileListFile = {
+    key: string;
+    name: string;
+    size?: number;
+    type?: string;
+    url?: string;
+};
+type FileListProps = {
+    files: FileListFile[];
+    storage?: unknown;
+    deleteAction?: ClientDescriptor;
+    onDownload?: (file: FileListFile) => void;
+};
+type AvatarWithInitialsProps = {
+    src?: string | null;
+    name: string;
+    size?: "sm" | "md" | "lg";
+};
+type RoleBadgeProps = {
+    role: string;
+    colors?: Record<string, string>;
+};
+type ImpersonationBannerProps = {
+    stopAction?: string;
+};
+type NavigationProgressProps = {
+    color?: string;
+};
+
+export type { TableSlotProps as $, ActionButtonProps as A, ButtonSlotProps as B, ConfirmDialogSlotProps as C, DataTableProps as D, EmailFieldProps as E, FormStatusProps as F, FilterType as G, FormStatusData as H, ImageFieldProps as I, ImagePreviewProps as J, ImpersonationBannerProps as K, JsonFieldProps as L, ListViewProps as M, NavigationItem as N, NavigationProgressProps as O, PermissionGateProps as P, NumberFieldProps as Q, PageContainerSlotProps as R, RelationFieldProps as S, ToastApi as T, UIPlugin as U, RoleBadgeProps as V, SidebarSlotProps as W, TabItem as X, TableCellSlotProps as Y, TableRowSlotProps as Z, TableSectionSlotProps as _, UIPluginComponents as a, TextFieldProps as a0, ToastOptions as a1, ToastSlotProps as a2, ToastType as a3, TooltipSlotProps as a4, UrlFieldProps as a5, UserMenuLink as a6, UserMenuProps as a7, WhenForbidden as a8, ActionStatusResult as b, ConfirmOptions as c, AlertSlotProps as d, AppShellProps as e, AppShellSlotProps as f, AvatarWithInitialsProps as g, BaseFieldProps as h, BooleanFieldProps as i, BreadcrumbItem as j, BreadcrumbSlotProps as k, BulkAction as l, ChipSlotProps as m, ColumnDef as n, ColumnShorthand as o, DateFieldProps as p, DetailViewProps as q, DropZoneProps as r, DropZoneSlotProps as s, EmptyStateProps as t, FileFieldProps as u, FileListFile as v, FileListProps as w, FilterBarProps as x, FilterDef as y, FilterOption as z };