fastapi-rtk 2.8.0 → 2.9.0

package/dist/api/lib/ApiProvider/hooks/types.d.ts

@@ -0,0 +1,150 @@
+import { convertId } from 'fastapi-rtk/utils';
+import { EntryRow } from 'fastapi-rtk/contexts';
+import { InfiniteData, QueryKey, UseInfiniteQueryOptions, UseInfiniteQueryResult, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
+import { RefObject } from 'react';
+import { Adapters } from '../../adapters/types';
+import { createItem } from '../../fetchers/createItem';
+import { deleteItem } from '../../fetchers/deleteItem';
+import { downloadItems } from '../../fetchers/downloadItems';
+import { formCreateItem } from '../../fetchers/formCreateItem';
+import { formUpdateItem } from '../../fetchers/formUpdateItem';
+import { getInfo } from '../../fetchers/getInfo';
+import { getItem } from '../../fetchers/getItem';
+import { getItems } from '../../fetchers/getItems';
+import { updateItem } from '../../fetchers/updateItem';
+import { uploadItems } from '../../fetchers/uploadItems';
+import { postBulk } from '../../fetchers/postBulkAction';
+import { BulkActionResponse } from '../../fetchers/bulkActions.types';
+import { DataPage, PrimaryKey, StreamingPage, ValidationError } from 'fastapi-rtk/api-types';
+import { CoreConvertedInfo, QueryParams } from '../utils/types';
+export type { DataPage, StreamingPage };
+/** An entry identifier as accepted by the action functions before conversion. */
+export type EntryId = Parameters<typeof convertId>[0];
+/** The converted `/_info` data as held by the info query, tagged with the resource path. */
+export type InfoQueryData = CoreConvertedInfo & {
+    path: string;
+};
+/** The set of API functions the provider hooks dispatch through. */
+export interface ApiFunctions {
+    getItem: typeof getItem;
+    getItems: typeof getItems;
+    createItem: typeof createItem;
+    updateItem: typeof updateItem;
+    deleteItem: typeof deleteItem;
+    downloadItems: typeof downloadItems;
+    uploadItems: typeof uploadItems;
+    getInfo: typeof getInfo;
+    formCreateItem: typeof formCreateItem;
+    formUpdateItem: typeof formUpdateItem;
+}
+/** The set of bulk-action functions the bulk provider dispatches through. */
+export interface BulkFunctions {
+    postBulk: typeof postBulk;
+}
+/** A relation reference seeded into the query filters by the provider. */
+export interface RelationParam {
+    foreign_key?: string;
+    type?: string;
+    id?: PrimaryKey | null;
+    id_?: PrimaryKey | null;
+}
+/** The arguments accepted by `useApiActions`. */
+export interface UseApiActionsParams {
+    api: ApiFunctions;
+    adapters: Adapters;
+    path: string;
+    pathRef: RefObject<string>;
+    infoRef: RefObject<InfoQueryData | undefined>;
+    queryParamsRef: RefObject<QueryParams | null>;
+    currentLanguage: string;
+}
+/** The options accepted by the provider's download action. */
+export interface DownloadActionOptions {
+    export_mode?: string;
+    delimiter?: string;
+    quotechar?: string;
+}
+/** The options accepted by the provider's upload action. */
+export interface UploadActionOptions {
+    delimiter?: string;
+    quotechar?: string;
+}
+/** The arguments accepted by `useStreamingData`. */
+export interface UseStreamingDataParams {
+    streamingMode: boolean;
+    dataQuery: UseQueryResult<DataPage | null>;
+    streamingQuery: UseInfiniteQueryResult<InfiniteData<StreamingPage | null>>;
+    streamingQueryKey: QueryKey;
+}
+/** The configuration object accepted by `useProvideApi`. */
+export interface UseProvideApiParams {
+    path: string;
+    initialQueryParams?: QueryParams;
+    relation?: RelationParam;
+    fetchInfo?: boolean;
+    clearInfoOnRefetch?: boolean;
+    clearDataOnRefetch?: boolean;
+    refetchInfoBasedOnLang?: boolean;
+    refetchDataBasedOnLang?: boolean;
+    resetQueryParamsOnPathChange?: boolean;
+    infoQueryProps?: Partial<UseQueryOptions<InfoQueryData>>;
+    dataQueryProps?: Partial<UseQueryOptions<DataPage | null>>;
+    streamingQueryProps?: Partial<UseInfiniteQueryOptions<StreamingPage | null, Error, InfiniteData<StreamingPage | null>, QueryKey, number>>;
+    streaming?: boolean;
+}
+export interface BulkActions {
+    /** An array of currently selected IDs for bulk actions. */
+    selectedIds: Array<string | number>;
+    /** A function to set the selected IDs. */
+    setSelectedIds: (ids: Array<string | number>) => void;
+}
+export interface BulkActionsContextValue {
+    /** An object containing the selected IDs and a function to set them. */
+    bulkActions: BulkActions;
+    /**
+     * Dispatches a bulk action; falls back to the currently selected IDs when `data` is omitted.
+     * Resolves to `undefined` when the action throws (the error is surfaced via `error`).
+     */
+    dispatchBulkActions: (handler: string, data?: Array<string | number>) => Promise<BulkActionResponse | undefined>;
+    /** An error object if the bulk action failed. */
+    error?: {
+        message: string;
+        originalError: Error;
+    };
+    /** A function to reset the error state. */
+    resetError: () => void;
+}
+export type FormType = 'view' | 'add' | 'edit' | 'delete';
+export type FormViewMode = 'normal' | 'fullScreen' | 'overlay';
+export interface FormState {
+    errors: ValidationError[];
+    data: EntryRow | undefined;
+}
+export interface FormsContextValue<TItem = EntryRow> {
+    /** 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: FormViewMode;
+    /** A function to get the current view mode of the form. */
+    getView: () => FormViewMode;
+    /** A function to set the view mode of the form. */
+    setView: (newView: FormViewMode) => void;
+    /** The current state of the form, including errors and data. */
+    state: FormState;
+    /** A function to get the current state of the form. */
+    getState: () => FormState;
+    /** A function to set the state of the form. */
+    setState: (newState: FormState) => 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: TItem | undefined;
+    /** A function to get the current item in the form. */
+    getItem: () => TItem | undefined;
+    /** A function to set the current item in the form. */
+    setItem: (newItem: TItem | undefined) => void;
+}

package/dist/api/lib/ApiProvider/hooks/useProvideBulk.d.ts

@@ -0,0 +1,7 @@
+import { BulkActionsContextValue, BulkFunctions } from './types';
+export declare const defaultBulk: {
+    postBulk: (adapters: import('../..').Adapters, path: string, handler: string, data: import('../..').BulkActionPayload, options?: import('../..').FetchOptions) => Promise<import('../..').BulkActionResponse>;
+};
+export declare const useProvideBulk: (params: {
+    path: string;
+}, bulk?: BulkFunctions) => BulkActionsContextValue;

package/dist/api/lib/ApiProvider/hooks/useProvideForm.d.ts

@@ -0,0 +1,2 @@
+import { FormsContextValue } from './types';
+export declare const useProvideForm: () => import('../../../../.external/lib/zustand').UseBoundStore<import('../../../../.external/lib/zustand').StoreApi<FormsContextValue<import('fastapi-rtk/api-types').ResultRow>>>;

package/dist/api/lib/ApiProvider/hooks/utils/useApiActions.d.ts

@@ -0,0 +1,11 @@
+import { EntryRow } from 'fastapi-rtk/contexts';
+import { DownloadActionOptions, EntryId, UploadActionOptions, UseApiActionsParams } from '../types';
+export declare const useApiActions: (params: UseApiActionsParams) => {
+    getEntry: (id: EntryId) => Promise<import('fastapi-rtk/api-types').ResultRow>;
+    addEntry: (item: EntryRow) => Promise<import('fastapi-rtk/api-types').ResultRow>;
+    updateEntry: (id: EntryId, item: EntryRow) => Promise<import('fastapi-rtk/api-types').ResultRow>;
+    deleteEntry: (id: EntryId) => Promise<import('fastapi-rtk/api-types').ResultRow | null>;
+    download: (label?: string, { export_mode, delimiter, quotechar }?: DownloadActionOptions) => Promise<void>;
+    upload: (file: File, { delimiter, quotechar }?: UploadActionOptions) => Promise<import('../../..').UploadResponse>;
+    getItemURL: (type: string, item: string | File) => string;
+};

package/dist/{core/lib/Wrappers → api/lib}/ApiProvider/hooks/utils/useStreamingData.d.ts

@@ -1,8 +1,8 @@
-import { InfiniteData } from '../../../../../../.external/lib/@tanstack/react-query';
+import { InfiniteData } from '@tanstack/react-query';
 import { StreamingPage, UseStreamingDataParams } from '../types';
 export declare const useStreamingData: (params: UseStreamingDataParams) => {
     streamingPages: (StreamingPage | null)[];
-    activeDataQuery: import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverRefetchErrorResult<import('fastapi-rtk/api-types').DataPage | null, Error> | import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverSuccessResult<import('fastapi-rtk/api-types').DataPage | null, Error> | import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverLoadingErrorResult<import('fastapi-rtk/api-types').DataPage | null, Error> | import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverPendingResult<import('fastapi-rtk/api-types').DataPage | null, Error> | import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverPlaceholderResult<import('fastapi-rtk/api-types').DataPage | null, Error> | {
+    activeDataQuery: import('@tanstack/react-query').QueryObserverRefetchErrorResult<import('fastapi-rtk/api-types').DataPage | null, Error> | import('@tanstack/react-query').QueryObserverSuccessResult<import('fastapi-rtk/api-types').DataPage | null, Error> | import('@tanstack/react-query').QueryObserverLoadingErrorResult<import('fastapi-rtk/api-types').DataPage | null, Error> | import('@tanstack/react-query').QueryObserverPendingResult<import('fastapi-rtk/api-types').DataPage | null, Error> | import('@tanstack/react-query').QueryObserverPlaceholderResult<import('fastapi-rtk/api-types').DataPage | null, Error> | {
         data: StreamingPage | null;
         error: Error;
         isError: true;
@@ -13,8 +13,8 @@ export declare const useStreamingData: (params: UseStreamingDataParams) => {
         isSuccess: false;
         isPlaceholderData: false;
         status: "error";
-        fetchNextPage: (options?: import('../../../../../../.external/lib/@tanstack/react-query').FetchNextPageOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
-        fetchPreviousPage: (options?: import('../../../../../../.external/lib/@tanstack/react-query').FetchPreviousPageOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchNextPage: (options?: import('@tanstack/react-query').FetchNextPageOptions) => Promise<import('@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchPreviousPage: (options?: import('@tanstack/react-query').FetchPreviousPageOptions) => Promise<import('@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
         hasNextPage: boolean;
         hasPreviousPage: boolean;
         isFetchNextPageError: boolean;
@@ -34,8 +34,8 @@ export declare const useStreamingData: (params: UseStreamingDataParams) => {
         isRefetching: boolean;
         isStale: boolean;
         isEnabled: boolean;
-        refetch: (options?: import('../../../../../../.external/lib/@tanstack/react-query').RefetchOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
-        fetchStatus: import('../../../../../../.external/lib/@tanstack/react-query').FetchStatus;
+        refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchStatus: import('@tanstack/react-query').FetchStatus;
         promise: Promise<InfiniteData<StreamingPage | null, unknown>>;
     } | {
         data: StreamingPage | null;
@@ -50,8 +50,8 @@ export declare const useStreamingData: (params: UseStreamingDataParams) => {
         isSuccess: true;
         isPlaceholderData: false;
         status: "success";
-        fetchNextPage: (options?: import('../../../../../../.external/lib/@tanstack/react-query').FetchNextPageOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
-        fetchPreviousPage: (options?: import('../../../../../../.external/lib/@tanstack/react-query').FetchPreviousPageOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchNextPage: (options?: import('@tanstack/react-query').FetchNextPageOptions) => Promise<import('@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchPreviousPage: (options?: import('@tanstack/react-query').FetchPreviousPageOptions) => Promise<import('@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
         hasNextPage: boolean;
         hasPreviousPage: boolean;
         isFetchingNextPage: boolean;
@@ -69,8 +69,8 @@ export declare const useStreamingData: (params: UseStreamingDataParams) => {
         isRefetching: boolean;
         isStale: boolean;
         isEnabled: boolean;
-        refetch: (options?: import('../../../../../../.external/lib/@tanstack/react-query').RefetchOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
-        fetchStatus: import('../../../../../../.external/lib/@tanstack/react-query').FetchStatus;
+        refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchStatus: import('@tanstack/react-query').FetchStatus;
         promise: Promise<InfiniteData<StreamingPage | null, unknown>>;
     } | {
         data: StreamingPage | null;
@@ -85,8 +85,8 @@ export declare const useStreamingData: (params: UseStreamingDataParams) => {
         isSuccess: false;
         isPlaceholderData: false;
         status: "error";
-        fetchNextPage: (options?: import('../../../../../../.external/lib/@tanstack/react-query').FetchNextPageOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
-        fetchPreviousPage: (options?: import('../../../../../../.external/lib/@tanstack/react-query').FetchPreviousPageOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchNextPage: (options?: import('@tanstack/react-query').FetchNextPageOptions) => Promise<import('@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchPreviousPage: (options?: import('@tanstack/react-query').FetchPreviousPageOptions) => Promise<import('@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
         hasNextPage: boolean;
         hasPreviousPage: boolean;
         isFetchingNextPage: boolean;
@@ -104,8 +104,8 @@ export declare const useStreamingData: (params: UseStreamingDataParams) => {
         isRefetching: boolean;
         isStale: boolean;
         isEnabled: boolean;
-        refetch: (options?: import('../../../../../../.external/lib/@tanstack/react-query').RefetchOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
-        fetchStatus: import('../../../../../../.external/lib/@tanstack/react-query').FetchStatus;
+        refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchStatus: import('@tanstack/react-query').FetchStatus;
         promise: Promise<InfiniteData<StreamingPage | null, unknown>>;
     } | {
         data: StreamingPage | null;
@@ -119,8 +119,8 @@ export declare const useStreamingData: (params: UseStreamingDataParams) => {
         isSuccess: false;
         isPlaceholderData: false;
         status: "pending";
-        fetchNextPage: (options?: import('../../../../../../.external/lib/@tanstack/react-query').FetchNextPageOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
-        fetchPreviousPage: (options?: import('../../../../../../.external/lib/@tanstack/react-query').FetchPreviousPageOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchNextPage: (options?: import('@tanstack/react-query').FetchNextPageOptions) => Promise<import('@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchPreviousPage: (options?: import('@tanstack/react-query').FetchPreviousPageOptions) => Promise<import('@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
         hasNextPage: boolean;
         hasPreviousPage: boolean;
         isFetchingNextPage: boolean;
@@ -139,8 +139,8 @@ export declare const useStreamingData: (params: UseStreamingDataParams) => {
         isRefetching: boolean;
         isStale: boolean;
         isEnabled: boolean;
-        refetch: (options?: import('../../../../../../.external/lib/@tanstack/react-query').RefetchOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
-        fetchStatus: import('../../../../../../.external/lib/@tanstack/react-query').FetchStatus;
+        refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchStatus: import('@tanstack/react-query').FetchStatus;
         promise: Promise<InfiniteData<StreamingPage | null, unknown>>;
     } | {
         data: StreamingPage | null;
@@ -155,8 +155,8 @@ export declare const useStreamingData: (params: UseStreamingDataParams) => {
         isFetchNextPageError: false;
         isFetchPreviousPageError: false;
         status: "success";
-        fetchNextPage: (options?: import('../../../../../../.external/lib/@tanstack/react-query').FetchNextPageOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
-        fetchPreviousPage: (options?: import('../../../../../../.external/lib/@tanstack/react-query').FetchPreviousPageOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchNextPage: (options?: import('@tanstack/react-query').FetchNextPageOptions) => Promise<import('@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchPreviousPage: (options?: import('@tanstack/react-query').FetchPreviousPageOptions) => Promise<import('@tanstack/react-query').InfiniteQueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
         hasNextPage: boolean;
         hasPreviousPage: boolean;
         isFetchingNextPage: boolean;
@@ -174,20 +174,20 @@ export declare const useStreamingData: (params: UseStreamingDataParams) => {
         isRefetching: boolean;
         isStale: boolean;
         isEnabled: boolean;
-        refetch: (options?: import('../../../../../../.external/lib/@tanstack/react-query').RefetchOptions) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
-        fetchStatus: import('../../../../../../.external/lib/@tanstack/react-query').FetchStatus;
+        refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>>;
+        fetchStatus: import('@tanstack/react-query').FetchStatus;
         promise: Promise<InfiniteData<StreamingPage | null, unknown>>;
     };
-    fetchStreamingPage: () => Promise<import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>> | null;
+    fetchStreamingPage: () => Promise<import('@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>> | null;
     resetStreamingPages: ({ refetch }?: {
         refetch?: boolean;
-    }) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverRefetchErrorResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverSuccessResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverLoadingErrorResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverPendingResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverPlaceholderResult<InfiniteData<StreamingPage | null, unknown>, Error> | null>;
+    }) => Promise<import('@tanstack/react-query').QueryObserverRefetchErrorResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('@tanstack/react-query').QueryObserverSuccessResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('@tanstack/react-query').QueryObserverLoadingErrorResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('@tanstack/react-query').QueryObserverPendingResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('@tanstack/react-query').QueryObserverPlaceholderResult<InfiniteData<StreamingPage | null, unknown>, Error> | null>;
     streaming: {
         data: Record<number, import('fastapi-rtk/api-types').ResultRow[]>;
         isEnd: boolean;
-        fetch: () => Promise<import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>> | null;
+        fetch: () => Promise<import('@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>> | null;
         reset: ({ refetch }?: {
             refetch?: boolean;
-        }) => Promise<import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverRefetchErrorResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverSuccessResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverLoadingErrorResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverPendingResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverPlaceholderResult<InfiniteData<StreamingPage | null, unknown>, Error> | null>;
+        }) => Promise<import('@tanstack/react-query').QueryObserverRefetchErrorResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('@tanstack/react-query').QueryObserverSuccessResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('@tanstack/react-query').QueryObserverLoadingErrorResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('@tanstack/react-query').QueryObserverPendingResult<InfiniteData<StreamingPage | null, unknown>, Error> | import('@tanstack/react-query').QueryObserverPlaceholderResult<InfiniteData<StreamingPage | null, unknown>, Error> | null>;
     } | undefined;
 };

package/dist/api/lib/ApiProvider/types.d.ts

@@ -0,0 +1,51 @@
+import { DataPage, StreamingPage } from 'fastapi-rtk/api-types';
+import { InfiniteData, QueryKey, UseInfiniteQueryOptions, UseQueryOptions } from '@tanstack/react-query';
+import { PropsWithChildren } from 'react';
+import { ApiFunctions, BulkFunctions, InfoQueryData, RelationParam } from './hooks/types';
+import { QueryParams } from './utils/types';
+/**
+ * Props accepted by the `ApiProvider` component.
+ *
+ * @typeParam TQuery - Custom query-param keys forwarded to the backend (read off `request.query_params`).
+ *   Surfaced typed on `initialQueryParams`; pass the same shape to `useApi<…, TQuery>()` to type `queryParams` /
+ *   `setQueryParams` (React context cannot carry the Provider's type param to a distant `useApi` call).
+ */
+export type ApiProviderProps<TQuery extends object = object> = PropsWithChildren<{
+    /** The name of the resource to be used in the API path. */
+    resource_name?: string;
+    /** The initial query parameters to be used in the API requests. May include custom keys (typed via `TQuery`) forwarded to the backend. */
+    initialQueryParams?: QueryParams & Partial<TQuery>;
+    /** The relation to be used in the API requests. */
+    relation?: RelationParam;
+    /** Whether to fetch the `info` for the API requests when the component mounts. */
+    fetchInfo?: boolean;
+    /** Whether to clear the `info` on refetch. */
+    clearInfoOnRefetch?: boolean;
+    /** Whether to clear the `data` on refetch. */
+    clearDataOnRefetch?: boolean;
+    /** Whether to refetch the `info` when the language changes. Defaults to true. */
+    refetchInfoBasedOnLang?: boolean;
+    /** Whether to refetch the `data` when the language changes. Defaults to true. */
+    refetchDataBasedOnLang?: boolean;
+    /** Whether to reset the `queryParams` on path change. */
+    resetQueryParamsOnPathChange?: boolean;
+    /** The react-query props for the info query. */
+    infoQueryProps?: Partial<UseQueryOptions<InfoQueryData>>;
+    /** The react-query props for the data query. */
+    dataQueryProps?: Partial<UseQueryOptions<DataPage | null>>;
+    /** The react-query props for the streaming (infinite) query. */
+    streamingQueryProps?: Partial<UseInfiniteQueryOptions<StreamingPage | null, Error, InfiniteData<StreamingPage | null>, QueryKey, number>>;
+    /** Whether to enable streaming for the API requests. */
+    streaming?: boolean;
+    /** Overrides for the API dependency functions. */
+    apiParams?: ApiFunctions;
+    /** Overrides for the bulk-action dependency functions. */
+    bulkParams?: BulkFunctions;
+}>;
+/** Additional options for the `withApiProvider` HOC. */
+export interface WithApiProviderOptions {
+    /** The display name for the wrapped component. */
+    displayName?: string;
+    /** Whether to forward refs to the wrapped component. */
+    forwardRef?: boolean;
+}

package/dist/{core/lib/Wrappers → api/lib}/ApiProvider/utils/getDefaultValues.d.ts

@@ -1,3 +1,3 @@
 import { AnyColumnInfo } from 'fastapi-rtk/api-types';
-import { MRT_RowData } from '../../../../../.external/lib/mantine-react-table';
-export declare const getDefaultValues: (columns: AnyColumnInfo[]) => MRT_RowData;
+import { EntryRow } from 'fastapi-rtk/contexts';
+export declare const getDefaultValues: (columns: AnyColumnInfo[]) => EntryRow;

package/dist/{core/lib/Wrappers → api/lib}/ApiProvider/utils/getValidationSchema.d.ts

@@ -1,5 +1,5 @@
 import { AnyColumnInfo } from 'fastapi-rtk/api-types';
-import * as yup from '../../../../../.external/lib/yup';
+import * as yup from '../../../../.external/lib/yup';
 export declare const getValidationSchema: (columns: AnyColumnInfo[]) => yup.ObjectSchema<{
     [x: string]: unknown;
 }, yup.AnyObject, {

package/dist/{core/lib/Wrappers → api/lib}/Provider/Contexts/AuthContext.d.ts

@@ -1,2 +1,2 @@
-import { AuthContextValue } from '../../../hooks/auth/types';
+import { AuthContextValue } from '../../hooks/auth/types';
 export declare const AuthContextProvider: import('react').Provider<AuthContextValue | null>, useAuthProvider: (options?: import('fastapi-rtk/utils').SafeContextOptions<AuthContextValue>) => AuthContextValue;

package/dist/{core/lib/Wrappers → api/lib}/Provider/Contexts/InfoContext.d.ts

@@ -1,2 +1,2 @@
-import { InfoContextValue } from '../../../hooks/auth/types';
+import { InfoContextValue } from '../../hooks/auth/types';
 export declare const InfoContextProvider: import('react').Provider<InfoContextValue | null>, useInfoProvider: (options?: import('fastapi-rtk/utils').SafeContextOptions<InfoContextValue>) => InfoContextValue;

package/dist/{core/lib/Wrappers → api/lib}/Provider/Contexts/types.d.ts

@@ -1,10 +1,11 @@
 import { LangContextValue } from 'fastapi-rtk/contexts';
-import { i18n, InitOptions } from '../../../../../.external/lib/i18next';
-import { MRT_Localization } from '../../../../../.external/lib/mantine-react-table';
+import { i18n, InitOptions } from '../../../../.external/lib/i18next';
 import { PropsWithChildren, ProviderProps } from 'react';
-/** A map of MRT (Mantine React Table) localization resources keyed by language code. */
+/** A single MRT (Mantine React Table) localization resource: a flat map of localization keys to translated strings. Local so `api` has no `mantine-react-table` type dependency; the web grid re-types it to `MRT_Localization` at the consumer boundary. */
+export type MRTLocalization = Record<string, string>;
+/** A map of MRT localization resources keyed by language code. */
 export type MRTLocalizationMap = {
-    [locale: string]: Partial<MRT_Localization>;
+    [locale: string]: Partial<MRTLocalization>;
 };
 export interface GetI18nProps {
     /** The props for `i18n.init`. */

package/dist/api/lib/Provider/Provider.d.ts

@@ -0,0 +1,14 @@
+import { InnerProviderProps, WithProvider } from './types';
+/**
+ * Wraps the application with auth and info hooks for use with the fastapi-rtk python backend library.
+ */
+export declare const Provider: (props: InnerProviderProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * Higher-order component to wrap a component with Provider.
+ *
+ * @param providerProps - The props passed to the Provider, or a function that returns them.
+ * @param Component - The component to wrap.
+ * @param options - Additional options for the HOC.
+ * @returns The wrapped component.
+ */
+export declare const withProvider: WithProvider;

package/dist/api/lib/Provider/hooks/types.d.ts

@@ -0,0 +1,22 @@
+import { AppApiInfo } from 'fastapi-rtk/api-types';
+import { Adapters, SigninCredentials } from '../../adapters/types';
+import { AuthUser } from '../../auth/types';
+export type { SigninCredentials };
+export interface AuthDependencies {
+    getUser: (adapters: Adapters, baseUrl: string, signal?: AbortSignal) => Promise<AuthUser>;
+    update: (adapters: Adapters, baseUrl: string, userData: Partial<AuthUser>) => Promise<AuthUser>;
+    signin: (adapters: Adapters, baseUrl: string, credentials: SigninCredentials) => Promise<void>;
+    signout: (adapters: Adapters, baseUrl: string) => Promise<void>;
+    resetPassword: (adapters: Adapters, baseUrl: string, newPassword: string, user: {
+        email: string;
+    }) => Promise<void>;
+    oauthSignin: (adapters: Adapters, baseUrl: string, provider: string, popup: boolean, afterSigninPopup?: () => void) => Promise<void>;
+}
+export interface InfoDependencies {
+    getInfo: (adapters: Adapters, baseUrl: string, signal?: AbortSignal) => Promise<AppApiInfo[]>;
+    fab?: boolean;
+}
+export interface ProvideAuthError {
+    message: string;
+    originalError: Error;
+}

package/dist/api/lib/Provider/hooks/useProvideAuth.d.ts

@@ -0,0 +1,17 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import { AuthUser } from '../../auth/types';
+import { AuthDependencies, SigninCredentials } from './types';
+export declare function useProvideAuth(baseURL: string, authQueryProps?: Partial<UseQueryOptions<AuthUser>>, auth?: AuthDependencies): {
+    user: AuthUser | null | undefined;
+    loading: boolean;
+    error: string | null;
+    query: import('@tanstack/react-query').UseQueryResult<AuthUser, Error>;
+    signin: ({ username, password }: SigninCredentials) => Promise<void>;
+    signout: () => Promise<void>;
+    update: (data: Partial<AuthUser>) => Promise<void>;
+    resetPassword: (password: string) => Promise<void>;
+    oauthSignin: (provider: string, popup: boolean) => Promise<void>;
+    refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<AuthUser, Error>>;
+    resetError: () => void;
+    oauth_signin: (provider: string, popup: boolean) => Promise<void>;
+};

package/dist/{core/lib/Wrappers → api/lib}/Provider/hooks/useProvideInfo.d.ts

@@ -1,4 +1,4 @@
-import { AuthUser } from '../../../hooks/auth/types';
+import { AuthUser } from '../../auth/types';
 import { InfoDependencies } from './types';
 export declare function useProvideInfo(baseUrl: string, auth: {
     user?: Partial<AuthUser> | null;
@@ -8,5 +8,5 @@ export declare function useProvideInfo(baseUrl: string, auth: {
     loading: boolean;
     error: Error | null;
     fab: boolean | undefined;
-    query: import('../../../../../.external/lib/@tanstack/react-query').UseQueryResult<import('fastapi-rtk/api-types').AppApiInfo[], Error>;
+    query: import('@tanstack/react-query').UseQueryResult<import('fastapi-rtk/api-types').AppApiInfo[], Error>;
 };

package/dist/{core/lib/Wrappers → api/lib}/Provider/hooks/useProvideLang.d.ts

@@ -1,10 +1,9 @@
 import { LangContextValue } from 'fastapi-rtk/contexts';
-import { UseSetStateCallback } from '@mantine/hooks';
 import { MRTLocalizationMap } from '../Contexts/types';
 type ProvideLangValue = LangContextValue & {
     currentMRTLocalization: MRTLocalizationMap[string] | undefined;
     MRTLocalization: MRTLocalizationMap;
-    setMRTLocalization: UseSetStateCallback<MRTLocalizationMap>;
+    setMRTLocalization: (partial: Partial<MRTLocalizationMap>) => void;
 };
 export declare const useProvideLang: (baseMRTLocalization?: MRTLocalizationMap) => ProvideLangValue;
 export {};

package/dist/api/lib/Provider/types.d.ts

@@ -0,0 +1,35 @@
+import { QueryClientConfig, UseQueryOptions } from '@tanstack/react-query';
+import { ComponentType, PropsWithChildren } from 'react';
+import { Adapters } from '../adapters/types';
+import { AuthUser } from '../auth/types';
+import { LangProps } from './Contexts/types';
+import { AuthDependencies, InfoDependencies } from './hooks/types';
+export interface ProviderProps {
+    /** The platform adapters (storage, network, auth transport, file download, OAuth opener, form data) provided to the app. */
+    adapters: Adapters;
+    /** The base URL for the API. */
+    baseUrl?: string;
+    /** The props for the QueryClient. See here `https://tanstack.com/query/latest/docs/reference/QueryClient`. */
+    queryClientProps?: QueryClientConfig;
+    /** The react-query props for the auth. See here `https://tanstack.com/query/latest/docs/framework/react/reference/useQuery`. */
+    authQueryProps?: Partial<UseQueryOptions<AuthUser>>;
+    /** Overrides for the auth dependency functions. */
+    authParams?: AuthDependencies;
+    /** Overrides for the info dependency functions. */
+    infoParams?: InfoDependencies;
+    /** Whether to inherit the Mantine theme. */
+    inheritMantineTheme?: boolean;
+    /** The props for the language context. */
+    langProps?: LangProps;
+    /** Whether to enable debug mode, which logs additional information to the console. */
+    debug?: boolean;
+}
+export interface WithProviderOptions {
+    /** The display name for the wrapped component. */
+    displayName?: string;
+    /** Whether to forward refs to the wrapped component. */
+    forwardRef?: boolean;
+}
+export type WithProviderProps<P> = ProviderProps | ((props: P) => ProviderProps);
+export type WithProvider = <P>(providerProps: WithProviderProps<P>, Component: ComponentType<P>, options?: WithProviderOptions) => ComponentType<P>;
+export type InnerProviderProps = PropsWithChildren<ProviderProps>;

package/dist/api/lib/adapters/AdaptersContext.d.ts

@@ -0,0 +1,10 @@
+import { SafeContextOptions } from 'fastapi-rtk/utils';
+import { Adapters } from './types';
+export declare const AdaptersProvider: import('react').Provider<Adapters | null>, useAdaptersProvider: (options?: SafeContextOptions<Adapters>) => Adapters;
+/**
+ * Access the platform adapters supplied to the top-level Provider.
+ *
+ * @param options - Options for the context hook.
+ * @returns The active adapters ({ storage, network, authTransport, fileDownload, oauthOpener, formData }).
+ */
+export declare const useAdapters: (options?: SafeContextOptions<Adapters>) => Adapters;

package/dist/api/lib/adapters/types.d.ts

@@ -0,0 +1,69 @@
+import { ParseableResponse } from '../utils/parseResponse/parseResponse';
+export type RequestOptions = Omit<RequestInit, 'headers'> & {
+    headers: {
+        [name: string]: string;
+    };
+};
+/**
+ * Login credentials. Lives here (not auth/types) because AuthTransport.buildLoginBody references
+ * it and adapters/types must not import from auth/types (that would cycle with AuthDependencies'
+ * Adapters reference). auth/types.ts re-exports it.
+ */
+export interface SigninCredentials {
+    username: string;
+    password: string;
+}
+export interface StorageAdapter {
+    get(key: string): Promise<string | null> | string | null;
+    set(key: string, value: string): Promise<void> | void;
+    remove(key: string): Promise<void> | void;
+    /** Optional reactivity. Web: the `storage` event. RN: an event emitter, or omitted. Returns an unsubscribe fn. */
+    subscribe?(key: string, cb: (value: string | null) => void): () => void;
+}
+export interface NetworkAdapter {
+    /** Perform the request. Web: global `fetch`. Returns the DOM-free ParseableResponse (a raw Response satisfies it structurally). */
+    request(path: string, options: RequestOptions): Promise<ParseableResponse>;
+}
+export interface AuthTransport {
+    /** Path segment appended after `auth/`: 'login' (cookie) or 'jwt/login' (bearer). */
+    loginPath: string;
+    /** Build the login request body. Both transports send urlencoded form today. */
+    buildLoginBody(creds: SigninCredentials): BodyInit;
+    /** Cookie: set `credentials:'include'`. Bearer: add the Authorization header from the storage it was constructed with. */
+    decorateRequest(options: RequestOptions): RequestOptions | Promise<RequestOptions>;
+    /** Bearer: read + store the JWT from the login response. Cookie: no-op. */
+    persistLogin(response: ParseableResponse): Promise<void> | void;
+    /** Bearer: drop the persisted JWT. Cookie: no-op. */
+    clearLogin(): Promise<void> | void;
+}
+export interface FileDownloadAdapter {
+    /** Web: anchor-navigate to `url` (cookie auth). RN: fetch the bytes with `headers`, then write/share as `filename`. */
+    save(source: {
+        url: string;
+        filename?: string;
+        headers?: Record<string, string>;
+    }): Promise<void>;
+    /** Web: URL.createObjectURL. RN: a content/file uri. */
+    objectUrl(file: unknown): string;
+}
+export interface OAuthOpenerAdapter {
+    /** Web: window.open (popup) / window.location (redirect) + a setInterval close-poll that calls onClose. */
+    open(url: string, opts: {
+        popup: boolean;
+        onClose?: () => void;
+    }): void | Promise<void>;
+}
+export interface FormDataAdapter {
+    /** Web: `value instanceof File`. RN: shape check `{ uri, name, type }`. */
+    isFilePart(value: unknown): boolean;
+    /** Append a file part. Web: `fd.append(key, file as File)`. */
+    appendFile(fd: FormData, key: string, file: unknown): void;
+}
+export interface Adapters {
+    storage: StorageAdapter;
+    network: NetworkAdapter;
+    authTransport: AuthTransport;
+    fileDownload: FileDownloadAdapter;
+    oauthOpener: OAuthOpenerAdapter;
+    formData: FormDataAdapter;
+}