fastapi-rtk 2.1.5 → 2.2.0

package/dist/core/lib/Wrappers/ApiProvider/hooks/types.d.ts

@@ -0,0 +1,90 @@
+import { convertId } from 'fastapi-rtk/utils';
+import { InfiniteData, QueryKey, UseInfiniteQueryOptions, UseInfiniteQueryResult, UseQueryOptions, UseQueryResult } from '../../../../../.external/lib/@tanstack/react-query';
+import { RefObject } from 'react';
+import { createItem } from '../utils/api/createItem';
+import { deleteItem } from '../utils/api/deleteItem';
+import { downloadItems } from '../utils/api/downloadItems';
+import { formCreateItem } from '../utils/api/formCreateItem';
+import { formUpdateItem } from '../utils/api/formUpdateItem';
+import { getInfo } from '../utils/api/getInfo';
+import { getItem } from '../utils/api/getItem';
+import { getItems } from '../utils/api/getItems';
+import { updateItem } from '../utils/api/updateItem';
+import { uploadItems } from '../utils/api/uploadItems';
+import { postBulk } from '../utils/bulkActions/postBulkAction';
+import { DataPage, PrimaryKey, StreamingPage } 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;
+    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;
+}

package/dist/core/lib/Wrappers/ApiProvider/hooks/useProvideApi.d.ts

@@ -1,72 +1,3 @@
-export function useProvideApi({ path, initialQueryParams, relation, fetchInfo, clearInfoOnRefetch, clearDataOnRefetch, refetchInfoBasedOnLang, refetchDataBasedOnLang, resetQueryParamsOnPathChange, infoQueryProps, dataQueryProps, streamingQueryProps, streaming: streamingMode, }: {
-    path: any;
-    initialQueryParams: any;
-    relation: any;
-    fetchInfo?: boolean;
-    clearInfoOnRefetch?: boolean;
-    clearDataOnRefetch?: boolean;
-    refetchInfoBasedOnLang?: boolean;
-    refetchDataBasedOnLang?: boolean;
-    resetQueryParamsOnPathChange?: boolean;
-    infoQueryProps: any;
-    dataQueryProps: any;
-    streamingQueryProps: any;
-    streaming?: boolean;
-}, api?: {
-    getItem: (path: any, id: any, options: any) => Promise<string | Record<string, any>>;
-    getItems: (path: string, queryParams: Record<string, any>, options: RequestInit) => Promise<Record<string, any> | string>;
-    createItem: (path: any, data: any, options: any) => Promise<string | Record<string, any>>;
-    updateItem: (path: any, id: any, data: any, options: any) => Promise<string | Record<string, any>>;
-    deleteItem: (path: any, id: any, options: any) => Promise<string | Record<string, any>>;
-    downloadItems: (path: any, queryParams: any, { label, export_mode, delimiter, quotechar }?: {}) => Promise<void>;
-    uploadItems: (path: any, file: any, { delimiter, quotechar }?: {}) => Promise<string | Record<string, any>>;
-    getInfo: (path: string, options: RequestInit) => Promise<Record<string, any>>;
-    formCreateItem: (path: any, data: any, options: any) => Promise<string | Record<string, any>>;
-    formUpdateItem: (path: any, id: any, data: any, options: any) => Promise<string | Record<string, any>>;
-}): {
-    path: any;
-    data: any;
-    info: unknown;
-    queryParams: {
-        filters?: any[];
-    } | {
-        filters: any[];
-        page: number;
-        page_size: number;
-        columns: any[];
-    };
-    loading: any;
-    infoLoading: boolean;
-    dataLoading: any;
-    error: undefined;
-    infoError: Error;
-    dataError: any;
-    infoQuery: import('@tanstack/react-query').DefinedUseQueryResult<unknown, Error>;
-    dataQuery: any;
-    streamingQuery: import('@tanstack/react-query').DefinedUseInfiniteQueryResult<import('@tanstack/react-query').InfiniteData<any, unknown>, Error>;
-    streaming: {
-        data: any;
-        isEnd: boolean;
-        fetch: () => any;
-        reset: ({ refetch }?: {
-            refetch?: boolean;
-        }) => Promise<any>;
-    };
-    specialKey: {
-        all: string;
-        actions: string;
-    };
-    setQueryParams: (partialQueryParams: any) => void;
-    refetch: () => any;
-    refetchInfo: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<unknown, Error>>;
-    getEntry: (id: any) => Promise<any>;
-    addEntry: (item: any) => Promise<any>;
-    updateEntry: (id: any, item: any) => Promise<any>;
-    deleteEntry: (id: any) => Promise<any>;
-    download: (label: any, { export_mode, delimiter, quotechar }?: {}) => Promise<any>;
-    upload: (file: any, { delimiter, quotechar }?: {}) => Promise<any>;
-    getFileURL: (item: any) => string;
-    getImageURL: (item: any) => string;
-    setError: import('react').Dispatch<(prevState: undefined) => undefined>;
-    resetError: () => void;
-};
+import { ApiContextValue } from 'fastapi-rtk/contexts';
+import { ApiFunctions, UseProvideApiParams } from './types';
+export declare function useProvideApi(params: UseProvideApiParams, api?: ApiFunctions): ApiContextValue;

package/dist/core/lib/Wrappers/ApiProvider/hooks/useProvideBulk.d.ts

@@ -1,17 +1,8 @@
-import { postBulk } from '../utils/bulkActions/postBulkAction';
-export namespace defaultBulk {
-    export { postBulk };
-}
-export function useProvideBulk({ path }: {
-    path: any;
-}, bulk?: {
-    postBulk: (path: any, handler: any, data: any, options: any) => Promise<string | Record<string, any>>;
-}): {
-    bulkActions: {
-        selectedIds: any[];
-        setSelectedIds: import('react').Dispatch<import('react').SetStateAction<any[]>>;
-    };
-    dispatchBulkActions: (handler: any, data: any) => Promise<string | Record<string, any>>;
-    error: undefined;
-    resetError: () => void;
+import { BulkActionsContextValue } from '../../../hooks/api/types';
+import { BulkFunctions } from './types';
+export declare const defaultBulk: {
+    postBulk: (path: string, handler: string, data: import('../utils/bulkActions/types').BulkActionPayload, options?: import('../utils/api/types').FetchOptions) => Promise<import('../utils/bulkActions/types').BulkActionResponse>;
 };
+export declare const useProvideBulk: (params: {
+    path: string;
+}, bulk?: BulkFunctions) => BulkActionsContextValue;

package/dist/core/lib/Wrappers/ApiProvider/hooks/useProvideForm.d.ts

@@ -1 +1,2 @@
-export function useProvideForm(): import('zustand').UseBoundStore<import('zustand').StoreApi<any>>;
+import { FormsContextValue } from '../../../hooks/api/types';
+export declare const useProvideForm: () => import('../../../../../.external/lib/zustand').UseBoundStore<import('../../../../../.external/lib/zustand').StoreApi<FormsContextValue<import('../../../../../.external/lib/mantine-react-table').MRT_RowData>>>;

package/dist/core/lib/Wrappers/ApiProvider/hooks/utils/useApiActions.d.ts

@@ -1,16 +1,11 @@
-export function useApiActions({ api, path, pathRef, infoRef, queryParamsRef, currentLanguage }: {
-    api: any;
-    path: any;
-    pathRef: any;
-    infoRef: any;
-    queryParamsRef: any;
-    currentLanguage: any;
-}): {
-    getEntry: (id: any) => Promise<any>;
-    addEntry: (item: any) => Promise<any>;
-    updateEntry: (id: any, item: any) => Promise<any>;
-    deleteEntry: (id: any) => Promise<any>;
-    download: (label: any, { export_mode, delimiter, quotechar }?: {}) => Promise<any>;
-    upload: (file: any, { delimiter, quotechar }?: {}) => Promise<any>;
-    getItemURL: (type: any, item: any) => string;
+import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
+import { DownloadActionOptions, EntryId, UploadActionOptions, UseApiActionsParams } from '../types';
+export declare const useApiActions: (params: UseApiActionsParams) => {
+    getEntry: (id: EntryId) => Promise<MRT_RowData>;
+    addEntry: (item: MRT_RowData) => Promise<MRT_RowData>;
+    updateEntry: (id: EntryId, item: MRT_RowData) => Promise<MRT_RowData>;
+    deleteEntry: (id: EntryId) => Promise<MRT_RowData>;
+    download: (label?: string, { export_mode, delimiter, quotechar }?: DownloadActionOptions) => Promise<void>;
+    upload: (file: File, { delimiter, quotechar }?: UploadActionOptions) => Promise<MRT_RowData>;
+    getItemURL: (type: string, item: string | File) => string;
 };

package/dist/core/lib/Wrappers/ApiProvider/hooks/utils/useLatest.d.ts

@@ -1 +1 @@
-export function useLatest(value: any): import('react').RefObject<any>;
+export declare const useLatest: <T>(value: T) => import('react').RefObject<T>;

package/dist/core/lib/Wrappers/ApiProvider/hooks/utils/useStreamingData.d.ts

@@ -1,21 +1,198 @@
-export function useStreamingData({ streamingMode, dataQuery, streamingQuery, streamingQueryKey }: {
-    streamingMode: any;
-    dataQuery: any;
-    streamingQuery: any;
-    streamingQueryKey: any;
-}): {
-    streamingPages: any;
-    activeDataQuery: any;
-    fetchStreamingPage: () => any;
+import { InfiniteData } from '../../../../../../.external/lib/@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> | {
+        data: StreamingPage | null;
+        error: Error;
+        isError: true;
+        isPending: false;
+        isLoading: false;
+        isLoadingError: false;
+        isRefetchError: true;
+        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>>;
+        hasNextPage: boolean;
+        hasPreviousPage: boolean;
+        isFetchNextPageError: boolean;
+        isFetchingNextPage: boolean;
+        isFetchPreviousPageError: boolean;
+        isFetchingPreviousPage: boolean;
+        dataUpdatedAt: number;
+        errorUpdatedAt: number;
+        failureCount: number;
+        failureReason: Error | null;
+        errorUpdateCount: number;
+        isFetched: boolean;
+        isFetchedAfterMount: boolean;
+        isFetching: boolean;
+        isInitialLoading: boolean;
+        isPaused: boolean;
+        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;
+        promise: Promise<InfiniteData<StreamingPage | null, unknown>>;
+    } | {
+        data: StreamingPage | null;
+        error: null;
+        isError: false;
+        isPending: false;
+        isLoading: false;
+        isLoadingError: false;
+        isRefetchError: false;
+        isFetchNextPageError: false;
+        isFetchPreviousPageError: false;
+        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>>;
+        hasNextPage: boolean;
+        hasPreviousPage: boolean;
+        isFetchingNextPage: boolean;
+        isFetchingPreviousPage: boolean;
+        dataUpdatedAt: number;
+        errorUpdatedAt: number;
+        failureCount: number;
+        failureReason: Error | null;
+        errorUpdateCount: number;
+        isFetched: boolean;
+        isFetchedAfterMount: boolean;
+        isFetching: boolean;
+        isInitialLoading: boolean;
+        isPaused: boolean;
+        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;
+        promise: Promise<InfiniteData<StreamingPage | null, unknown>>;
+    } | {
+        data: StreamingPage | null;
+        error: Error;
+        isError: true;
+        isPending: false;
+        isLoading: false;
+        isLoadingError: true;
+        isRefetchError: false;
+        isFetchNextPageError: false;
+        isFetchPreviousPageError: false;
+        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>>;
+        hasNextPage: boolean;
+        hasPreviousPage: boolean;
+        isFetchingNextPage: boolean;
+        isFetchingPreviousPage: boolean;
+        dataUpdatedAt: number;
+        errorUpdatedAt: number;
+        failureCount: number;
+        failureReason: Error | null;
+        errorUpdateCount: number;
+        isFetched: boolean;
+        isFetchedAfterMount: boolean;
+        isFetching: boolean;
+        isInitialLoading: boolean;
+        isPaused: boolean;
+        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;
+        promise: Promise<InfiniteData<StreamingPage | null, unknown>>;
+    } | {
+        data: StreamingPage | null;
+        error: null;
+        isError: false;
+        isPending: true;
+        isLoadingError: false;
+        isRefetchError: false;
+        isFetchNextPageError: false;
+        isFetchPreviousPageError: false;
+        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>>;
+        hasNextPage: boolean;
+        hasPreviousPage: boolean;
+        isFetchingNextPage: boolean;
+        isFetchingPreviousPage: boolean;
+        dataUpdatedAt: number;
+        errorUpdatedAt: number;
+        failureCount: number;
+        failureReason: Error | null;
+        errorUpdateCount: number;
+        isFetched: boolean;
+        isFetchedAfterMount: boolean;
+        isFetching: boolean;
+        isLoading: boolean;
+        isInitialLoading: boolean;
+        isPaused: boolean;
+        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;
+        promise: Promise<InfiniteData<StreamingPage | null, unknown>>;
+    } | {
+        data: StreamingPage | null;
+        isError: false;
+        error: null;
+        isPending: false;
+        isLoading: false;
+        isLoadingError: false;
+        isRefetchError: false;
+        isSuccess: true;
+        isPlaceholderData: true;
+        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>>;
+        hasNextPage: boolean;
+        hasPreviousPage: boolean;
+        isFetchingNextPage: boolean;
+        isFetchingPreviousPage: boolean;
+        dataUpdatedAt: number;
+        errorUpdatedAt: number;
+        failureCount: number;
+        failureReason: Error | null;
+        errorUpdateCount: number;
+        isFetched: boolean;
+        isFetchedAfterMount: boolean;
+        isFetching: boolean;
+        isInitialLoading: boolean;
+        isPaused: boolean;
+        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;
+        promise: Promise<InfiniteData<StreamingPage | null, unknown>>;
+    };
+    fetchStreamingPage: () => Promise<import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>> | null;
     resetStreamingPages: ({ refetch }?: {
         refetch?: boolean;
-    }) => Promise<any>;
+    }) => 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>;
     streaming: {
-        data: any;
+        data: {};
+        isEnd: boolean;
+        fetch: () => Promise<null>;
+        reset: () => Promise<null>;
+    } | {
+        data: Record<number, import('fastapi-rtk/api-types').ResultRow[]>;
         isEnd: boolean;
-        fetch: () => any;
+        fetch: () => Promise<import('../../../../../../.external/lib/@tanstack/react-query').QueryObserverResult<InfiniteData<StreamingPage | null, unknown>, Error>> | null;
         reset: ({ refetch }?: {
             refetch?: boolean;
-        }) => Promise<any>;
+        }) => 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>;
     };
 };

package/dist/core/lib/Wrappers/ApiProvider/types.d.ts

@@ -0,0 +1,41 @@
+import { DataPage, StreamingPage } from 'fastapi-rtk/api-types';
+import { InfiniteData, QueryKey, UseInfiniteQueryOptions, UseQueryOptions } from '../../../../.external/lib/@tanstack/react-query';
+import { PropsWithChildren } from 'react';
+import { InfoQueryData, RelationParam } from './hooks/types';
+import { QueryParams } from './utils/types';
+/** Props accepted by the `ApiProvider` component. */
+export type ApiProviderProps = 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. */
+    initialQueryParams?: QueryParams;
+    /** 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;
+}>;
+/** 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/ApiProvider/utils/api/createItem.d.ts

@@ -1 +1,3 @@
-export function createItem(path: any, data: any, options: any): Promise<string | Record<string, any>>;
+import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
+import { FetchOptions } from './types';
+export declare const createItem: (path: string, data: MRT_RowData, options?: FetchOptions) => Promise<MRT_RowData>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/deleteItem.d.ts

@@ -1 +1,3 @@
-export function deleteItem(path: any, id: any, options: any): Promise<string | Record<string, any>>;
+import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
+import { FetchOptions, ItemId } from './types';
+export declare const deleteItem: (path: string, id: ItemId, options?: FetchOptions) => Promise<MRT_RowData>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/downloadItems.d.ts

@@ -1 +1,3 @@
-export function downloadItems(path: any, queryParams: any, { label, export_mode, delimiter, quotechar }?: {}): Promise<void>;
+import { QueryParams } from 'fastapi-rtk/api-types';
+import { DownloadOptions } from './types';
+export declare const downloadItems: (path: string, queryParams?: QueryParams, { label, export_mode, delimiter, quotechar }?: DownloadOptions) => Promise<void>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/formCreateItem.d.ts

@@ -1 +1,3 @@
-export function formCreateItem(path: any, data: any, options: any): Promise<string | Record<string, any>>;
+import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
+import { FetchOptions } from './types';
+export declare const formCreateItem: (path: string, data: MRT_RowData, options?: FetchOptions) => Promise<MRT_RowData>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/formUpdateItem.d.ts

@@ -1 +1,3 @@
-export function formUpdateItem(path: any, id: any, data: any, options: any): Promise<string | Record<string, any>>;
+import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
+import { FetchOptions, ItemId } from './types';
+export declare const formUpdateItem: (path: string, id: ItemId, data: MRT_RowData, options?: FetchOptions) => Promise<MRT_RowData>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/getInfo.d.ts

@@ -1 +1,10 @@
-export function getInfo(path: string, options: RequestInit): Promise<Record<string, any>>;
+import { FetchOptions } from './types';
+/**
+ * Fetches information from the given path using a GET request.
+ *
+ * @param path - The path to fetch information from.
+ * @param options - Additional fetch options such as headers.
+ * @returns The data fetched from the given path.
+ * @throws {Error} If the response is not ok, throws an error with the response detail.
+ */
+export declare const getInfo: (path: string, options?: FetchOptions) => Promise<string | object>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/getItem.d.ts

@@ -1 +1,3 @@
-export function getItem(path: any, id: any, options: any): Promise<string | Record<string, any>>;
+import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
+import { FetchOptions, ItemId } from './types';
+export declare const getItem: (path: string, id: ItemId, options?: FetchOptions) => Promise<MRT_RowData>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/getItems.d.ts

@@ -1 +1,12 @@
-export function getItems(path: string, queryParams: Record<string, any>, options: RequestInit): Promise<Record<string, any> | string>;
+import { QueryParams } from 'fastapi-rtk/api-types';
+import { FetchOptions } from './types';
+/**
+ * Fetches items from the specified path.
+ *
+ * @param path - The API endpoint path to fetch items from.
+ * @param queryParams - An object containing query parameters to be sent with the request.
+ * @param options - Additional fetch options such as headers.
+ * @returns A promise that resolves to the fetched data, either as a JSON object or a text string.
+ * @throws {Error} - Throws an error if the response is not ok or if there is an issue with the fetch request.
+ */
+export declare const getItems: (path: string, queryParams?: QueryParams, options?: FetchOptions) => Promise<string | object>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/types.d.ts

@@ -0,0 +1,23 @@
+import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
+/** Additional fetch options accepted by the API helper functions. */
+export type FetchOptions = Omit<RequestInit, 'headers'> & {
+    headers?: {
+        [name: string]: string;
+    };
+};
+/** An item identifier accepted by the single-item API helpers. */
+export type ItemId = string | number;
+/** Options for the download helper. */
+export interface DownloadOptions {
+    label?: string;
+    export_mode?: string;
+    delimiter?: string;
+    quotechar?: string;
+}
+/** Options for the upload helper. */
+export interface UploadOptions {
+    delimiter?: string;
+    quotechar?: string;
+}
+/** The CRUD row returned by the upload endpoint; model-driven at runtime. */
+export type UploadResponse = MRT_RowData;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/updateItem.d.ts

@@ -1 +1,3 @@
-export function updateItem(path: any, id: any, data: any, options: any): Promise<string | Record<string, any>>;
+import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
+import { FetchOptions, ItemId } from './types';
+export declare const updateItem: (path: string, id: ItemId, data: MRT_RowData, options?: FetchOptions) => Promise<MRT_RowData>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/uploadItems.d.ts

@@ -1 +1,2 @@
-export function uploadItems(path: any, file: any, { delimiter, quotechar }?: {}): Promise<string | Record<string, any>>;
+import { UploadOptions, UploadResponse } from './types';
+export declare const uploadItems: (path: string, file: File, { delimiter, quotechar }?: UploadOptions) => Promise<UploadResponse>;

package/dist/core/lib/Wrappers/ApiProvider/utils/bulkActions/postBulkAction.d.ts

@@ -1 +1,3 @@
-export function postBulk(path: any, handler: any, data: any, options: any): Promise<string | Record<string, any>>;
+import { FetchOptions } from '../api/types';
+import { BulkActionPayload, BulkActionResponse } from './types';
+export declare const postBulk: (path: string, handler: string, data: BulkActionPayload, options?: FetchOptions) => Promise<BulkActionResponse>;

package/dist/core/lib/Wrappers/ApiProvider/utils/bulkActions/types.d.ts

@@ -0,0 +1,13 @@
+import { PrimaryKey } from 'fastapi-rtk/api-types';
+import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
+/**
+ * Payload accepted by a bulk handler: either a flat list of primary keys
+ * (the common "ids only" case) or a handler-specific dynamic object whose
+ * keys/values are not known statically.
+ */
+export type BulkActionPayload = PrimaryKey[] | MRT_RowData;
+/**
+ * Response returned by a bulk handler. The exact shape is handler-defined
+ * and model-driven at runtime.
+ */
+export type BulkActionResponse = MRT_RowData;

package/dist/core/lib/Wrappers/ApiProvider/utils/convertInfo.d.ts

@@ -1 +1,9 @@
-export function convertInfo(info: Record<string, any>): Record<string, any> | null;
+import { InfoResponse } from 'fastapi-rtk/api-types';
+import { CoreConvertedInfo } from './types';
+/**
+ * Restructures the info object and derives add/edit schemas and default values.
+ *
+ * @param info - The information object to be converted.
+ * @returns The converted info object with additional properties for add and edit operations, or null if the input is falsy.
+ */
+export declare const convertInfo: (info: InfoResponse | null | undefined) => CoreConvertedInfo | null;