fastapi-rtk 2.1.4 → 2.2.0

package/dist/core/lib/hooks/api/useBulkActions.d.ts

@@ -1,42 +1,9 @@
-export function useBulkActions(options: SafeContextOptions): BulkActionsContext;
-export type SafeContextOptions = {
-    /**
-     * - Whether to throw an error if the context is not provided.
-     */
-    throwOnError?: boolean;
-    /**
-     * - The default value to return if the context is not provided.
-     */
-    defaultValue?: any;
-};
-export type BulkActions = {
-    /**
-     * - An array of currently selected IDs for bulk actions.
-     */
-    selectedIds: Array<string | number>;
-    /**
-     * - A function to set the selected IDs.
-     */
-    setSelectedIds: Function;
-};
-export type BulkActionsContext = {
-    /**
-     * - An array containing the selected IDs and a function to set them.
-     */
-    bulkActions: BulkActions;
-    /**
-     * - A function to dispatch bulk actions with a handler and optional data. If data is not provided, it uses the currently selected IDs.
-     */
-    dispatchBulkActions: (handler: string, data?: Array<string | number>) => Promise<Record<string, any>>;
-    /**
-     * - An error object if the bulk action failed.
-     */
-    error?: {
-        message: string;
-        originalError: Error;
-    };
-    /**
-     * - A function to reset the error state.
-     */
-    resetError: () => void;
-};
+import { SafeContextOptions } from 'fastapi-rtk/utils';
+import { BulkActionsContextValue } from './types';
+/**
+ * Custom hook to access the bulk actions context.
+ *
+ * @param options - Options for the context hook.
+ * @returns The bulk actions context object.
+ */
+export declare const useBulkActions: (options?: SafeContextOptions<BulkActionsContextValue>) => BulkActionsContextValue;

package/dist/core/lib/hooks/api/useForms.d.ts

@@ -1,74 +1,16 @@
-export function useForms(type: "view" | "add" | "edit" | "delete", options: SafeContextOptions): FormsContext;
-export type SafeContextOptions = {
-    /**
-     * - Whether to throw an error if the context is not provided.
-     */
-    throwOnError?: boolean;
-    /**
-     * - The default value to return if the context is not provided.
-     */
-    defaultValue?: any;
-};
-export type FormsContext = {
-    /**
-     * - Indicates whether the form is currently opened.
-     */
-    opened: boolean;
-    /**
-     * - A function to get the current opened state of the form.
-     */
-    getOpened: () => boolean;
-    /**
-     * - A function to set the opened state of the form.
-     */
-    setOpened: (newOpened: boolean) => void;
-    /**
-     * - The current view mode of the form. See `VIEW_MODE` from `@fastapi-rtk/constants` for more details.
-     */
-    view: "normal" | "fullScreen" | "overlay";
-    /**
-     * - A function to get the current view mode of the form.
-     */
-    getView: () => "normal" | "fullScreen" | "overlay";
-    /**
-     * - A function to set the view mode of the form.
-     */
-    setView: (newView: "normal" | "fullScreen" | "overlay") => void;
-    /**
-     * - The current state of the form, including errors and data.
-     */
-    state: {
-        errors: Record<string, any>[];
-        data: Record<string, any> | undefined;
-    };
-    /**
-     * - A function to get the current state of the form.
-     */
-    getState: () => {
-        errors: Record<string, any>[];
-        data: Record<string, any> | undefined;
-    };
-    /**
-     * - A function to set the state of the form.
-     */
-    setState: (newState: {
-        errors: Record<string, any>[];
-        data: Record<string, any> | undefined;
-    }) => void;
-    /**
-     * - A function to reset the form state to its initial state.
-     */
-    reset: () => void;
-    /**
-     * - The current item being edited in the form, if applicable.
-     */
-    item: Record<string, any> | undefined;
-    /**
-     * - A function to get the current item in the form.
-     */
-    getItem: () => Record<string, any> | undefined;
-    /**
-     * - A function to set the current item in the form.
-     */
-    setItem: (newItem: Record<string, any> | undefined) => void;
-};
+import { PrimaryKey } from 'fastapi-rtk/api-types';
+import { SafeContextOptions } from 'fastapi-rtk/utils';
+import { FormsContextValue, FormType } from './types';
+/**
+ * Custom hook to access the forms context.
+ *
+ * The `'delete'` form stores the raw primary key of the row to delete, so its context is typed
+ * `FormsContextValue<PrimaryKey>` (`item` / `getItem` / `setItem` operate on the key); the other
+ * forms operate on a row object (`FormsContextValue<MRT_RowData>`).
+ *
+ * @param type - The type of form context to access. Can be 'view', 'add', 'edit', or 'delete'.
+ * @param options - Options for the context hook.
+ * @returns The forms context object.
+ */
+export declare function useForms(type: 'delete', options?: SafeContextOptions<FormsContextValue>): FormsContextValue<PrimaryKey>;
+export declare function useForms(type: FormType, options?: SafeContextOptions<FormsContextValue>): FormsContextValue;

package/dist/core/lib/hooks/auth/types.d.ts

@@ -0,0 +1,97 @@
+import { UseQueryResult } from '../../../../.external/lib/@tanstack/react-query';
+export interface AuthUser {
+    /** The unique identifier of the authenticated user. */
+    id: number;
+    /** The email of the authenticated user. */
+    email: string;
+    /** The username of the authenticated user. */
+    username: string;
+    /** The first name of the authenticated user. */
+    first_name?: string;
+    /** The last name of the authenticated user. */
+    last_name?: string;
+    /** Indicates whether the user account is active. */
+    active: boolean;
+    /** The timestamp of the user's last login. */
+    last_login: string;
+    /** The number of times the user has logged in. */
+    login_count: number;
+    /** The number of failed login attempts. */
+    fail_login_count: number;
+    /** The timestamp when the user account was created. */
+    created_on: string;
+    /** The timestamp when the user account was last changed. */
+    changed_on: string;
+    /** The full name of the authenticated user. */
+    full_name: string;
+    /** Indicates whether the user account is active. */
+    is_active: boolean;
+    /** Indicates whether the user's email is verified. */
+    is_verified: boolean;
+    /** Indicates whether the user has superuser privileges. */
+    is_superuser: boolean;
+    /** Indicates whether the user is anonymous. */
+    is_anonymous: boolean;
+    /** An array of permissions assigned to the user. */
+    permissions: string[];
+    /** An array of roles assigned to the user. */
+    roles: string[];
+}
+export interface AuthContextValue {
+    /** The raw React Query object used to fetch the authenticated user. */
+    query: UseQueryResult<AuthUser>;
+    /** The authenticated user object, or null if not authenticated. */
+    user: AuthUser | null;
+    /** Indicates whether the authentication state is currently loading. */
+    loading: boolean;
+    /** An error object if the authentication request failed. */
+    error: {
+        message: string;
+        originalError: Error;
+    } | null;
+    /** A function to sign in the user with a username and password. */
+    signin: (username: string, password: string) => Promise<void>;
+    /** A function to sign out the user. */
+    signout: () => Promise<void>;
+    /** A function to update the authenticated user's data. */
+    update: (data: Partial<AuthUser>) => Promise<AuthUser>;
+    /** A function to reset the user's password. */
+    resetPassword: (password: string) => Promise<void>;
+    /** Signs in the user via OAuth with the given provider; `popup` opens a popup window for the flow. */
+    oauth_signin: (provider: string, popup?: boolean) => Promise<void>;
+    /** A function to refetch the authenticated user's data. */
+    refetch: () => Promise<void>;
+    /** A function to reset the error state. */
+    resetError: () => void;
+}
+export interface Info {
+    /** The icon associated with the API. */
+    icon: string;
+    /** The level of the API. */
+    level: string;
+    /** The name of the API. */
+    name: string;
+    /** The path of the API. */
+    path: string;
+    /** The permission name associated with the API. */
+    permission_name: string;
+    /** The type of the API. */
+    type: string;
+}
+export interface InfoContextValue {
+    /** The base URL for the API. */
+    baseUrl: string;
+    /** The raw React Query object used to fetch info. */
+    query: UseQueryResult<Info[]>;
+    /** An array of Info objects or null if not available. */
+    info: Info[] | null;
+    /** Indicates whether the info is currently loading. */
+    loading: boolean;
+    /** An error object if the info request failed. */
+    error: {
+        message: string;
+        originalError: Error;
+    } | null;
+    /** Whether the app runs in fab-react-toolkit backward-compatibility mode. Set by `useProvideInfo`. */
+    fab?: boolean;
+}

package/dist/core/lib/hooks/auth/useAuth.d.ts

@@ -1,134 +1,9 @@
-export function useAuth(options: SafeContextOptions): AuthContext;
-export type SafeContextOptions = {
-    /**
-     * - Whether to throw an error if the context is not provided.
-     */
-    throwOnError?: boolean;
-    /**
-     * - The default value to return if the context is not provided.
-     */
-    defaultValue?: any;
-};
-export type AuthUser = {
-    /**
-     * - The unique identifier of the authenticated user.
-     */
-    id: number;
-    /**
-     * - The email of the authenticated user.
-     */
-    email: string;
-    /**
-     * - The username of the authenticated user.
-     */
-    username: string;
-    /**
-     * - The first name of the authenticated user.
-     */
-    first_name?: string;
-    /**
-     * - The last name of the authenticated user.
-     */
-    last_name?: string;
-    /**
-     * - Indicates whether the user account is active.
-     */
-    active: boolean;
-    /**
-     * - The timestamp of the user's last login.
-     */
-    last_login: string;
-    /**
-     * - The number of times the user has logged in.
-     */
-    login_count: number;
-    /**
-     * - The number of failed login attempts.
-     */
-    fail_login_count: number;
-    /**
-     * - The timestamp when the user account was created.
-     */
-    created_on: string;
-    /**
-     * - The timestamp when the user account was last changed.
-     */
-    changed_on: string;
-    /**
-     * - The full name of the authenticated user.
-     */
-    full_name: string;
-    /**
-     * - Indicates whether the user account is active.
-     */
-    is_active: boolean;
-    /**
-     * - Indicates whether the user's email is verified.
-     */
-    is_verified: boolean;
-    /**
-     * - Indicates whether the user has superuser privileges.
-     */
-    is_superuser: boolean;
-    /**
-     * - Indicates whether the user is anonymous.
-     */
-    is_anonymous: boolean;
-    /**
-     * - An array of permissions assigned to the user.
-     */
-    permissions: string[];
-    /**
-     * - An array of roles assigned to the user.
-     */
-    roles: string[];
-};
-export type AuthContext = {
-    /**
-     * - The raw React Query object used to fetch the authenticated user.
-     */
-    query: Record<string, any>;
-    /**
-     * - The authenticated user object, or null if not authenticated.
-     */
-    user: AuthUser | null;
-    /**
-     * - Indicates whether the authentication state is currently loading.
-     */
-    loading: boolean;
-    /**
-     * - An error object if the authentication request failed.
-     */
-    error: {
-        message: string;
-        originalError: Error;
-    } | null;
-    /**
-     * - A function to sign in the user with a username and password.
-     */
-    signin: (username: string, password: string) => Promise<void>;
-    /**
-     * - A function to sign out the user.
-     */
-    signout: () => Promise<void>;
-    /**
-     * - A function to update the authenticated user's data.
-     */
-    update: (data: Record<string, any>) => Promise<AuthUser>;
-    /**
-     * - A function to reset the user's password.
-     */
-    resetPassword: (password: string) => Promise<void>;
-    /**
-     * - A function to sign in the user using OAuth with a specified provider. If `popup` is true, it opens a popup window for the OAuth flow.
-     */
-    oauth_signin: (provider: string, popup?: boolean) => Promise<void>;
-    /**
-     * - A function to refetch the authenticated user's data.
-     */
-    refetch: () => Promise<void>;
-    /**
-     * - A function to reset the error state.
-     */
-    resetError: () => void;
-};
+import { SafeContextOptions } from 'fastapi-rtk/utils';
+import { AuthContextValue } from './types';
+/**
+ * Access the auth context.
+ *
+ * @param options - Options for the context hook.
+ * @returns The auth context object.
+ */
+export declare const useAuth: (options?: SafeContextOptions<AuthContextValue>) => AuthContextValue;

package/dist/core/lib/hooks/auth/useInfo.d.ts

@@ -1,62 +1,9 @@
-export function useInfo(options: SafeContextOptions): InfoContext;
-export type SafeContextOptions = {
-    /**
-     * - Whether to throw an error if the context is not provided.
-     */
-    throwOnError?: boolean;
-    /**
-     * - The default value to return if the context is not provided.
-     */
-    defaultValue?: any;
-};
-export type Info = {
-    /**
-     * - The icon associated with the API.
-     */
-    icon: string;
-    /**
-     * - The level of the API.
-     */
-    level: string;
-    /**
-     * - The name of the API.
-     */
-    name: string;
-    /**
-     * - The path of the API.
-     */
-    path: string;
-    /**
-     * - The permission name associated with the API.
-     */
-    permission_name: string;
-    /**
-     * - The type of the API.
-     */
-    type: string;
-};
-export type InfoContext = {
-    /**
-     * - The base URL for the API.
-     */
-    baseUrl: string;
-    /**
-     * - The raw React Query object used to fetch info.
-     */
-    query: Record<string, any>;
-    /**
-     * - An array of Info objects or null if not available.
-     */
-    info: Info[] | null;
-    /**
-     * - Indicates whether the info is currently loading.
-     */
-    loading: boolean;
-    /**
-     * - An error object if the info request failed.
-     */
-    error: {
-        message: string;
-        originalError: Error;
-    } | null;
-};
+import { SafeContextOptions } from 'fastapi-rtk/utils';
+import { InfoContextValue } from './types';
+/**
+ * Access the info context.
+ *
+ * @param options - Options for the context hook.
+ * @returns The info context object.
+ */
+export declare const useInfo: (options?: SafeContextOptions<InfoContextValue>) => InfoContextValue;

package/dist/core/lib/hooks/lang/useLang.d.ts

@@ -1,39 +1 @@
-import { useTranslation } from 'react-i18next';
-export function useLang(options: SafeContextOptions): LangContext;
-export { useTranslation };
-export type SafeContextOptions = {
-    /**
-     * - Whether to throw an error if the context is not provided.
-     */
-    throwOnError?: boolean;
-    /**
-     * - The default value to return if the context is not provided.
-     */
-    defaultValue?: any;
-};
-export type LangContext = {
-    /**
-     * - The current language code (e.g., 'en', 'de').
-     */
-    currentLanguage: string;
-    /**
-     * - Function to change the current language.
-     */
-    setLanguage: (lng: string) => void;
-    /**
-     * - The translation object from `react-i18next`. Same as using `useTranslation` from `react-i18next`.
-     */
-    translation: Record<string, any>;
-    /**
-     * - `useTranslation` from `react-i18next`.
-     */
-    useTranslation: () => Record<string, any>;
-    /**
-     * - The language code stored in local storage.
-     */
-    localStorageLanguage: string;
-    /**
-     * - Function to set the language code in local storage.
-     */
-    setLocalStorageLanguage: (lng: string) => void;
-};
+export { useLang, useTranslation } from 'fastapi-rtk/contexts';

package/dist/core/lib/index.d.ts

@@ -7,25 +7,28 @@ export { Refresh } from './ActionIcons/Refresh/Refresh';
 export { Upload } from './ActionIcons/Upload/Upload';
 export { View } from './ActionIcons/View/View';
 export * from './Dialogs';
-export * from './Inputs';
-export * from './Modals';
-export * from './sub-packages-exporter';
 export { useApi } from './hooks/api/useApi';
 export { useBulkActions } from './hooks/api/useBulkActions';
 export { useForms } from './hooks/api/useForms';
 export { useAuth } from './hooks/auth/useAuth';
 export { useInfo } from './hooks/auth/useInfo';
+export { useLang } from './hooks/lang/useLang';
+export { DateTimePicker, TimePicker } from 'fastapi-rtk/components';
 export { UserMenu } from './Menu/UserMenu/UserMenu';
 export { Filter } from './Tables/DataGrid/Toolbar/Filter/Filter';
 export { LanguageSelector } from './Selectors/LanguageSelector';
+export * from './Modals';
+export { DataGrid, DataGrid as Datagrid, } from './Tables/DataGrid/DataGrid';
+export { NextGenDataGrid, NextGenDataGrid as NextGenDatagrid, NextGenDataGrid as NextGendatagrid, NextGenDataGrid as Nextgendatagrid, } from './Tables/NextGenDataGrid/NextGenDataGrid';
+export { ApiProvider } from './Wrappers/ApiProvider/ApiProvider';
 export { InfiniteScroll } from './Wrappers/InfiniteScroll/InfiniteScroll';
 export { LazyLoadWrapper } from './Wrappers/LazyLoadWrapper/LazyLoadWrapper';
-export * as rq from '@tanstack/react-query';
-export * as mrt from 'mantine-react-table';
-export * as reactQuery from '@tanstack/react-query';
-export * as mantineReactTable from 'mantine-react-table';
-export { useLang, useTranslation } from './hooks/lang/useLang';
-export { DataGrid, DataGrid as Datagrid } from './Tables/DataGrid/DataGrid';
-export { NextGenDataGrid, NextGenDataGrid as NextGenDatagrid, NextGenDataGrid as NextGendatagrid, NextGenDataGrid as Nextgendatagrid } from './Tables/NextGenDataGrid/NextGenDataGrid';
-export { ApiProvider, withApiProvider } from './Wrappers/ApiProvider/ApiProvider';
-export { Provider, withProvider } from './Wrappers/Provider/Provider';
+export { Provider } from './Wrappers/Provider/Provider';
+export { withApiProvider } from './Wrappers/ApiProvider/ApiProvider';
+export { withProvider } from './Wrappers/Provider/Provider';
+export * from './sub-packages-exporter';
+export * as rq from '../../.external/lib/@tanstack/react-query';
+export * as mrt from '../../.external/lib/mantine-react-table';
+export * as reactQuery from '../../.external/lib/@tanstack/react-query';
+export * as mantineReactTable from '../../.external/lib/mantine-react-table';
+export { useTranslation } from './hooks/lang/useLang';

package/dist/core/lib/sub-packages-exporter.d.ts

@@ -1,4 +1,5 @@
 export * from 'fastapi-rtk/.bundled-jsonforms';
+export * from 'fastapi-rtk/api-types';
 export * from 'fastapi-rtk/constants';
 export * from 'fastapi-rtk/hooks';
 export * from 'fastapi-rtk/utils';

package/dist/core/lib/test-helpers/types.d.ts

@@ -0,0 +1,35 @@
+import { ApiContextValue, LangContextValue } from 'fastapi-rtk/contexts';
+import { i18n } from '../../../.external/lib/i18next';
+import { QueryClient } from '../../../.external/lib/@tanstack/react-query';
+import { BulkActionsContextValue, FormsContextValue } from '../hooks/api/types';
+import { AuthContextValue, InfoContextValue } from '../hooks/auth/types';
+/**
+ * Context overrides accepted by `uiWrap`. Each provider slot takes a (usually partial) mock
+ * value; only the slots that are present get their provider mounted. Test fixtures
+ * supplying simplified shapes (`vi.fn()` for typed signatures, backward-compat `fab` key,
+ * `info: null`) cast at the call site.
+ */
+export interface UiWrapCtx {
+    /** Override the i18next instance. */
+    i18n?: i18n;
+    /** LangContext value. */
+    lang?: LangContextValue;
+    /** Override the TanStack Query client. */
+    queryClient?: QueryClient;
+    /** ApiContext value. */
+    api?: Partial<ApiContextValue>;
+    /** FormContext (add) value. */
+    formAdd?: Partial<FormsContextValue>;
+    /** FormContext (edit) value. */
+    formEdit?: Partial<FormsContextValue>;
+    /** FormContext (view) value. */
+    formView?: Partial<FormsContextValue>;
+    /** FormContext (delete) value. */
+    formDelete?: Partial<FormsContextValue>;
+    /** BulkActionsContext value. */
+    bulk?: Partial<BulkActionsContextValue>;
+    /** AuthContext value. */
+    auth?: Partial<AuthContextValue>;
+    /** InfoContext value. */
+    info?: Partial<InfoContextValue>;
+}

package/dist/core/lib/test-helpers/uiWrap.d.ts

@@ -1,12 +1,10 @@
-export function uiWrap(ctx?: {
-    api?: object;
-    formAdd?: object;
-    formEdit?: object;
-    formView?: object;
-    formDelete?: object;
-    bulk?: object;
-    auth?: object;
-    info?: object;
-}): ({ children }: {
-    children: any;
-}) => import("react").JSX.Element;
+import { PropsWithChildren } from 'react';
+import { UiWrapCtx } from './types';
+/**
+ * Build a JSX wrapper that stacks Mantine + i18next + lang context + arbitrary
+ * fastapi-rtk contexts. Use as the `wrapper` option to render/renderHook.
+ *
+ * @param ctx - Context overrides; only the provided slots get their provider mounted.
+ * @returns A wrapper component for `render` / `renderHook`.
+ */
+export declare const uiWrap: (ctx?: UiWrapCtx) => (props: PropsWithChildren) => import("react/jsx-runtime").JSX.Element;