fastapi-rtk 2.1.5 → 2.2.0

package/dist/core/lib/Tables/DataGrid/FormField/Inputs/FormSelect.d.ts

@@ -1,6 +1,2 @@
-export function FormSelect({ form, name, items, ...props }: {
-    [x: string]: any;
-    form: any;
-    name: any;
-    items: any;
-}): import("react").JSX.Element;
+import { FormSelectProps } from '../types';
+export declare function FormSelect(props: FormSelectProps): import("react/jsx-runtime").JSX.Element;

package/dist/core/lib/Tables/DataGrid/FormField/Inputs/FormTextField.d.ts

@@ -1,5 +1,2 @@
-export function FormTextField({ form, name, ...props }: {
-    [x: string]: any;
-    form: any;
-    name: any;
-}): import("react").JSX.Element;
+import { FormTextFieldProps } from '../types';
+export declare function FormTextField(props: FormTextFieldProps): import("react/jsx-runtime").JSX.Element;

package/dist/core/lib/Tables/DataGrid/FormField/types.d.ts

@@ -0,0 +1,55 @@
+import { AnyColumnInfo, RelInfo } from 'fastapi-rtk/api-types';
+import { AutocompleteProps, ComboboxItem, JsonInputProps, MultiSelectProps, SelectProps, TextInputProps } from '@mantine/core';
+import { DateInputProps, DateTimePickerProps } from '@mantine/dates';
+import { UseFormReturnType } from '@mantine/form';
+/** Mantine form backing every DataGrid input; untyped over its values because they are model-driven. */
+export type FormFieldForm = UseFormReturnType<{
+    [field: string]: any;
+}>;
+/** Column metadata describing the field to render (an `/_info` column, possibly enum- or relation-backed). */
+export type FormFieldSchema = AnyColumnInfo;
+/** Keys this layer redefines that also exist as native attributes on Mantine input props. */
+type OwnKeys = 'form' | 'name' | 'items' | 'filter' | 'schema';
+/** Fields every DataGrid form input shares. */
+export interface FormInputBaseProps {
+    form: FormFieldForm;
+    name: string;
+}
+export interface FormFieldProps {
+    form: FormFieldForm;
+    name: string;
+    schema: FormFieldSchema;
+    filter?: boolean;
+    withinPortal?: boolean;
+}
+export type FormTextFieldProps = Omit<Partial<TextInputProps>, OwnKeys> & FormInputBaseProps;
+export type FormSelectProps = Omit<Partial<SelectProps>, OwnKeys> & FormInputBaseProps & {
+    items: (ComboboxItem | string | number)[];
+};
+export type FormAutocompleteProps = Omit<Partial<AutocompleteProps>, OwnKeys> & FormInputBaseProps & {
+    items: (ComboboxItem | string)[];
+};
+export type FormRelatedSelectProps = Omit<Partial<SelectProps>, OwnKeys> & FormInputBaseProps & {
+    items: RelInfo[];
+    filter?: boolean;
+};
+export type FormRelatedListSelectProps = Omit<Partial<MultiSelectProps>, OwnKeys> & FormInputBaseProps & {
+    items: RelInfo[];
+};
+export type FormDatePickerProps = Omit<Partial<DateInputProps>, OwnKeys> & FormInputBaseProps & {
+    schema?: FormFieldSchema;
+};
+export type FormDateTimePickerProps = Omit<Partial<DateTimePickerProps>, OwnKeys> & FormInputBaseProps & {
+    schema?: FormFieldSchema;
+};
+export type FormJsonFieldProps = Omit<Partial<JsonInputProps>, OwnKeys> & FormInputBaseProps & {
+    filter?: boolean;
+};
+export interface FormGeometryFieldProps {
+    form: FormFieldForm;
+    name: string;
+    filter?: boolean;
+    label?: string;
+    description?: string;
+}
+export {};

package/dist/core/lib/Tables/DataGrid/Main/Body/Body.d.ts

@@ -1,11 +1,2 @@
-export function Body({ data, loading, hideActions, hideCheckbox, selection, toggleRow, onClickEntry, bodyCustomizer, bodySeparator, }: {
-    data: any;
-    loading: any;
-    hideActions: any;
-    hideCheckbox: any;
-    selection: any;
-    toggleRow: any;
-    onClickEntry: any;
-    bodyCustomizer: any;
-    bodySeparator: any;
-}): import("react").JSX.Element;
+import { BodyProps } from '../types';
+export declare function Body(props: BodyProps): import("react/jsx-runtime").JSX.Element;

package/dist/core/lib/Tables/DataGrid/Main/Body/Field/Field.d.ts

@@ -1,2 +1,3 @@
 import { default as React } from 'react';
-export const Field: React.NamedExoticComponent<object>;
+import { FieldProps } from '../../types';
+export declare const Field: React.MemoExoticComponent<(props: FieldProps) => import("react/jsx-runtime").JSX.Element>;

package/dist/core/lib/Tables/DataGrid/Main/Body/Row/Row.d.ts

@@ -1,5 +1,2 @@
-export function Row({ entry, selected, children }: {
-    entry: any;
-    selected: any;
-    children: any;
-}): import("react").JSX.Element;
+import { RowProps } from '../../types';
+export declare function Row(props: RowProps): import("react/jsx-runtime").JSX.Element;

package/dist/core/lib/Tables/DataGrid/Main/Header/FieldTitle/FieldTitle.d.ts

@@ -1,12 +1,2 @@
-export function FieldTitle({ column, label, orderColumn, related, toggleAll, allChecked, classNames, styles, customElement, ...props }: {
-    [x: string]: any;
-    column: any;
-    label: any;
-    orderColumn: any;
-    related: any;
-    toggleAll: any;
-    allChecked: any;
-    classNames: any;
-    styles: any;
-    customElement: any;
-}): import("react").JSX.Element;
+import { FieldTitleProps } from '../../types';
+export declare function FieldTitle(props: FieldTitleProps): import("react/jsx-runtime").JSX.Element;

package/dist/core/lib/Tables/DataGrid/Main/Header/Header.d.ts

@@ -1 +1,2 @@
-export const Header: import('react').NamedExoticComponent<object>;
+import { HeaderProps } from '../types';
+export declare const Header: import('react').MemoExoticComponent<(props: HeaderProps) => import("react/jsx-runtime").JSX.Element>;

package/dist/core/lib/Tables/DataGrid/Main/Main.d.ts

@@ -1,13 +1,2 @@
-export function Main({ bulkActions, hideActions, loading, onSelectCheckbox, onClickEntry, hideCheckbox, hideDownload, headerCustomizer, bodyCustomizer, bodySeparator, ...props }: {
-    [x: string]: any;
-    bulkActions: any;
-    hideActions: any;
-    loading: any;
-    onSelectCheckbox: any;
-    onClickEntry: any;
-    hideCheckbox: any;
-    hideDownload: any;
-    headerCustomizer: any;
-    bodyCustomizer: any;
-    bodySeparator: any;
-}): import("react").JSX.Element;
+import { MainProps } from './types';
+export declare function Main(props: MainProps): import("react/jsx-runtime").JSX.Element;

package/dist/core/lib/Tables/DataGrid/Main/resolveCustomizerEntry.d.ts

@@ -0,0 +1,11 @@
+import { MRT_RowData } from '../../../../../.external/lib/mantine-react-table';
+import { ReactNode } from 'react';
+import { GridCustomizerEntry } from './types';
+/**
+ * Resolve a `GridCustomizerEntry` (node | factory | `{ component }` wrapper) to a `ReactNode`.
+ *
+ * The deprecated DataGrid customizer accepts three shapes per slot: a ready-made node, a factory
+ * called with the row (body) or column label (header), or the NextGenDataGrid object form
+ * carrying either of the first two under `.component`.
+ */
+export declare const resolveCustomizerEntry: (entry: GridCustomizerEntry | undefined, arg: MRT_RowData | string) => ReactNode;

package/dist/core/lib/Tables/DataGrid/Main/selection.d.ts

@@ -0,0 +1,3 @@
+import { RowId } from './types';
+export declare function isSelected(selection: RowId[], id: RowId): boolean;
+export declare function toggleSelection(selection: RowId[], id: RowId): RowId[];

package/dist/core/lib/Tables/DataGrid/Main/selection.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/core/lib/Tables/DataGrid/Main/types.d.ts

@@ -0,0 +1,98 @@
+import { PrimaryKey } from 'fastapi-rtk/api-types';
+import { APIData, APIInfo } from 'fastapi-rtk/contexts';
+import { ClassNames, FactoryPayload, Styles, TableProps } from '@mantine/core';
+import { MRT_RowData } from '../../../../../.external/lib/mantine-react-table';
+import { Dispatch, ReactNode, SetStateAction } from 'react';
+import { ActionIconId } from '../../../ActionIcons/utils/types';
+import { BulkActions } from '../../../hooks/api/types';
+/** Minimal Mantine factory payload for `useStyles` over a CSS-module: required `stylesNames` string, inherits the dynamic `props` bag from Mantine's `FactoryPayload`. */
+export interface StylesPayload extends FactoryPayload {
+    stylesNames: string;
+}
+/** Factory form of a customizer slot, invoked with the row (body) or column label (header). */
+export type GridCustomizerFactory = (arg?: MRT_RowData | string) => ReactNode;
+/** Single customizer slot: a node, a factory, or the NextGen object form carrying the same under `.component`. */
+export type GridCustomizerEntry = ReactNode | GridCustomizerFactory | {
+    component?: ReactNode | GridCustomizerFactory;
+};
+/** Map of column name to a customizer slot. */
+export type GridCustomizer = {
+    [column: string]: GridCustomizerEntry;
+};
+/** Map of column name to the string used to split that column's value into multiple lines. */
+export type BodySeparator = {
+    [column: string]: string;
+};
+/** An identifier for a single grid row; matches the backend `PrimaryKey`, including composite keys. */
+export type RowId = PrimaryKey;
+/** Callback fired when a row is clicked, receiving its id and the row data. */
+export type OnClickEntry = (id: RowId, entry: MRT_RowData) => void;
+/** Callback fired when the row selection changes. */
+export type OnSelectCheckbox = (selection: RowId[]) => void;
+export interface MainProps extends Partial<TableProps> {
+    bulkActions?: BulkActions | null;
+    hideActions?: boolean;
+    loading?: boolean;
+    onSelectCheckbox?: OnSelectCheckbox | null;
+    onClickEntry?: OnClickEntry | null;
+    hideCheckbox?: boolean;
+    hideDownload?: boolean;
+    headerCustomizer?: GridCustomizer;
+    bodyCustomizer?: GridCustomizer;
+    bodySeparator?: BodySeparator;
+}
+export interface HeaderProps {
+    data: APIData;
+    info: APIInfo;
+    hideActions?: boolean;
+    hideCheckbox?: boolean;
+    allChecked: boolean;
+    setSelection?: Dispatch<SetStateAction<RowId[]>>;
+    toggleAll: () => void;
+    headerCustomizer?: GridCustomizer;
+}
+export interface FieldTitleProps {
+    data?: APIData;
+    column: string;
+    label?: string;
+    orderColumn?: string;
+    related?: boolean;
+    toggleAll?: () => void;
+    allChecked?: boolean;
+    classNames?: ClassNames<StylesPayload>;
+    styles?: Styles<StylesPayload>;
+    customElement?: ReactNode;
+}
+export interface BodyProps {
+    data: APIData;
+    loading?: boolean;
+    hideActions?: boolean;
+    hideCheckbox?: boolean;
+    selection: RowId[];
+    setSelection?: Dispatch<SetStateAction<RowId[]>>;
+    toggleRow: (id: RowId) => void;
+    onClickEntry?: OnClickEntry | null;
+    bodyCustomizer?: GridCustomizer;
+    bodySeparator?: BodySeparator;
+}
+export interface ActionCustomElementProps {
+    bodyCustomizer?: GridCustomizer;
+    actionColumn: string;
+    id: ActionIconId;
+    entry: MRT_RowData;
+}
+export interface FieldProps {
+    id?: RowId;
+    entry?: MRT_RowData;
+    loading?: boolean;
+    rightBorder?: boolean;
+    children?: ReactNode;
+    onClickEntry?: OnClickEntry | null;
+    customElement?: ReactNode;
+    sanitize?: boolean;
+}
+export interface RowProps {
+    entry: MRT_RowData;
+    selected?: boolean;
+    children?: ReactNode;
+}

package/dist/core/lib/Tables/DataGrid/Pagination/Pagination.d.ts

@@ -1 +1,2 @@
-export const Pagination: import('react').NamedExoticComponent<object>;
+import { PaginationProps } from './types';
+export declare const Pagination: import('react').MemoExoticComponent<(props: PaginationProps) => import("react/jsx-runtime").JSX.Element>;

package/dist/core/lib/Tables/DataGrid/Pagination/types.d.ts

@@ -0,0 +1,4 @@
+import { PaginationProps as MantinePaginationProps } from '@mantine/core';
+export interface PaginationProps extends Partial<MantinePaginationProps> {
+    counter?: boolean;
+}

package/dist/core/lib/Tables/DataGrid/Toolbar/Filter/Filter.d.ts

@@ -1 +1,2 @@
-export function Filter(...props: any[]): import("react").JSX.Element;
+import { ActionIconProps } from '@mantine/core';
+export declare function Filter(...props: Partial<ActionIconProps>[]): import("react/jsx-runtime").JSX.Element;

package/dist/core/lib/Tables/DataGrid/Toolbar/Filter/FilterMenu.d.ts

@@ -1,4 +1,2 @@
-export function FilterMenu({ onClose, ...props }: {
-    [x: string]: any;
-    onClose: any;
-}): import("react").JSX.Element;
+import { FilterMenuProps } from '../types';
+export declare function FilterMenu(props: FilterMenuProps): import("react/jsx-runtime").JSX.Element;

package/dist/core/lib/Tables/DataGrid/Toolbar/Filter/FormFilterField.d.ts

@@ -1,8 +1,3 @@
+import { FormFilterFieldProps } from '../types';
+declare function FormFilterField(props: FormFilterFieldProps): import("react/jsx-runtime").JSX.Element;
 export default FormFilterField;
-declare function FormFilterField({ form, name, items, onChange, ...props }: {
-    [x: string]: any;
-    form: any;
-    name: any;
-    items: any;
-    onChange: any;
-}): import("react").JSX.Element;

package/dist/core/lib/Tables/DataGrid/Toolbar/Filter/FormFilterIn.d.ts

@@ -1,7 +1,2 @@
-export function FormFilterIn({ form, name, label, comboboxProps, ...props }: {
-    [x: string]: any;
-    form: any;
-    name: any;
-    label: any;
-    comboboxProps: any;
-}): import("react").JSX.Element;
+import { FormFilterInProps } from '../types';
+export declare function FormFilterIn(props: FormFilterInProps): import("react/jsx-runtime").JSX.Element;

package/dist/core/lib/Tables/DataGrid/Toolbar/Filter/FormOperatorField.d.ts

@@ -1,8 +1,3 @@
+import { FormFilterFieldProps } from '../types';
+declare function FormFilterField(props: FormFilterFieldProps): import("react/jsx-runtime").JSX.Element;
 export default FormFilterField;
-declare function FormFilterField({ form, name, items, onChange, ...props }: {
-    [x: string]: any;
-    form: any;
-    name: any;
-    items: any;
-    onChange: any;
-}): import("react").JSX.Element;

package/dist/core/lib/Tables/DataGrid/Toolbar/Settings/Settings.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/core/lib/Tables/DataGrid/Toolbar/Toolbar.d.ts

@@ -1 +1,2 @@
-export const Toolbar: import('react').NamedExoticComponent<object>;
+import { ToolbarProps } from './types';
+export declare const Toolbar: import('react').MemoExoticComponent<(props: ToolbarProps) => import("react/jsx-runtime").JSX.Element>;

package/dist/core/lib/Tables/DataGrid/Toolbar/types.d.ts

@@ -0,0 +1,39 @@
+import { ActionIconProps, ComboboxProps, SelectProps } from '@mantine/core';
+import { ReactNode } from 'react';
+import { FormFieldForm } from '../FormField/types';
+export interface ToolbarProps {
+    hideAdd?: boolean;
+    hideFilter?: boolean;
+    hideSettings?: boolean;
+    hideDownload?: boolean;
+    toolbarCustomizer: {
+        [toolbarSlot: string]: ReactNode | (() => ReactNode);
+    };
+}
+export interface FilterMenuProps extends Partial<ActionIconProps> {
+    onClose: () => void;
+}
+export type FormFilterFieldProps = Omit<Partial<SelectProps>, 'form' | 'name' | 'items' | 'onChange'> & {
+    form: FormFieldForm;
+    name: string;
+    items: SelectProps['data'];
+    onChange?: SelectProps['onChange'];
+};
+export interface FormFilterInProps {
+    form: FormFieldForm;
+    name: string;
+    label?: ReactNode;
+    comboboxProps?: Partial<ComboboxProps>;
+}
+/** A single in-progress filter row in the filter menu form. */
+export interface FilterMenuFilterItem {
+    col: string;
+    opr: string;
+    value: any;
+    key?: string;
+    id?: string | number;
+}
+/** Values backing the filter menu's Mantine form. */
+export interface FilterMenuFormValues {
+    filters: FilterMenuFilterItem[];
+}

package/dist/core/lib/Tables/DataGrid/types.d.ts

@@ -0,0 +1,42 @@
+import { CSSProperties } from 'react';
+import { AddDialogOwnProps } from '../../Dialogs/types';
+import { BulkActions, FormViewMode } from '../../hooks/api/types';
+import { BodySeparator, GridCustomizer, OnClickEntry, OnSelectCheckbox } from './Main/types';
+import { ToolbarProps } from './Toolbar/types';
+/** A node in the error-dialog message tree: a scalar leaf, a list, or a keyed object. */
+export type ErrorMessageValue = string | number | boolean | null | ErrorMessageValue[] | {
+    [key: string]: ErrorMessageValue;
+};
+export interface MessageRendererProps {
+    message: ErrorMessageValue;
+}
+/** Per-kind form configuration passed through to the Add/Edit dialogs, plus an optional initial display mode. */
+export type DataGridFormConfig = NonNullable<AddDialogOwnProps['jsonForms']> & {
+    initialView?: FormViewMode;
+};
+/** Add/Edit form configuration for the grid's dialogs. */
+export interface DataGridForm {
+    add?: DataGridFormConfig;
+    edit?: DataGridFormConfig;
+}
+export interface DataGridProps {
+    hideToolbar?: boolean;
+    hideFilter?: boolean;
+    hideAdd?: boolean;
+    hideSettings?: boolean;
+    hideActions?: boolean;
+    hidePagination?: boolean;
+    hideError?: boolean;
+    hideDownload?: boolean;
+    onSelectCheckbox?: OnSelectCheckbox | null;
+    onClickEntry?: OnClickEntry | null;
+    fetchOnMount?: boolean;
+    bulkActions?: BulkActions | null;
+    styles?: CSSProperties;
+    headerCustomizer?: GridCustomizer;
+    bodyCustomizer?: GridCustomizer;
+    toolbarCustomizer?: ToolbarProps['toolbarCustomizer'];
+    counter?: boolean;
+    bodySeparator?: BodySeparator;
+    form?: DataGridForm;
+}

package/dist/core/lib/Tables/NextGenDataGrid/FallbackWrapper.d.ts

@@ -1,12 +1,5 @@
+import { FallbackWrapperProps } from './types';
 /**
- * A React component that wraps its children with a fallback element if necessary.
- *
- * @param {Object} props - The properties object.
- * @param {React.ReactNode} props.fallback - The fallback element to render if children are not provided.
- * @param {Array} props.functionProps - The arguments to pass to the children function if it is a function.
- * @param {React.ReactNode|function} props.children - The children to render, which can be a React node or a function.
- * @param {React.Ref} ref - The ref to forward to the resulting element.
- *
- * @returns {React.ReactNode} The rendered children or fallback element.
+ * Wraps children with a fallback element when there are no resolved children.
  */
-export const FallbackWrapper: import('react').ForwardRefExoticComponent<import('react').RefAttributes<any>>;
+export declare const FallbackWrapper: import('react').ForwardRefExoticComponent<FallbackWrapperProps & import('react').RefAttributes<HTMLElement>>;

package/dist/core/lib/Tables/NextGenDataGrid/HooksComponent.d.ts

@@ -1,7 +1,20 @@
-export function HooksComponent({ useOnLoadProps, useViewProps, useTableSelectionProps, useTableOptimizationsProps, useQueryOnlyVisibleColumnsProps, }: {
-    useOnLoadProps: any;
-    useViewProps: any;
-    useTableSelectionProps: any;
-    useTableOptimizationsProps: any;
-    useQueryOnlyVisibleColumnsProps: any;
-}): void;
+import { MRT_RowData, MRT_TableInstance } from '../../../../.external/lib/mantine-react-table';
+import { useOnLoad } from './hooks/useOnLoad';
+import { useTableOptimizations } from './hooks/useOptimizations';
+import { useQueryOnlyVisibleColumns } from './hooks/useQueryOnlyVisibleColumns';
+import { useTableSelection } from './hooks/useSelection/useSelection';
+import { useView } from './hooks/useView';
+export type UseTableSelectionProps = Parameters<typeof useTableSelection>;
+export type UseTableOptimizationsProps = Parameters<typeof useTableOptimizations>;
+export type UseQueryOnlyVisibleColumnsProps = Parameters<typeof useQueryOnlyVisibleColumns>;
+interface HooksComponentProps {
+    /** The MantineReactTable instance; passed for identity but the hooks read it from their own prop tuples. */
+    table: MRT_TableInstance<MRT_RowData>;
+    useOnLoadProps: Parameters<typeof useOnLoad>[0];
+    useViewProps: Parameters<typeof useView>[0];
+    useTableSelectionProps: UseTableSelectionProps;
+    useTableOptimizationsProps: UseTableOptimizationsProps;
+    useQueryOnlyVisibleColumnsProps: UseQueryOnlyVisibleColumnsProps;
+}
+export declare const HooksComponent: (props: HooksComponentProps) => null;
+export {};