fastapi-rtk 2.1.4 → 2.2.0

package/dist/core/lib/fab-react-toolkit-patch/auth/hooks/useProvideInfo.d.ts

@@ -1,5 +1,5 @@
 import { authInfo } from '../utils/authFetch';
-export namespace defaultInfo {
-    export { authInfo as getInfo };
-    export let fab: boolean;
-}
+export declare const defaultInfo: {
+    getInfo: typeof authInfo;
+    fab: boolean;
+};

package/dist/core/lib/fab-react-toolkit-patch/auth/utils/authFetch.d.ts

@@ -1,53 +1,50 @@
+import { AppApiInfo } from 'fastapi-rtk/api-types';
+import { SigninCredentials } from '../../../Wrappers/Provider/hooks/types';
 /**
  * Sign in a user using the provided credentials.
  *
- * @param {string} baseUrl - The base URL of the authentication endpoint.
- * @param {Object} credentials - The user's sign in credentials.
- * @param {string} credentials.username - The username of the user.
- * @param {string} credentials.password - The password of the user.
- * @returns {Promise<void>} Resolves when the user is signed in.
+ * @param baseUrl - The base URL of the authentication endpoint.
+ * @param credentials - The user's sign in credentials.
+ * @returns Resolves when the user is signed in.
  * @throws {Error} Throws an error if the sign in fails.
  */
-export function authSignin(baseUrl: string, { username, password }: {
-    username: string;
-    password: string;
-}): Promise<void>;
+export declare function authSignin(baseUrl: string, { username, password }: SigninCredentials): Promise<void>;
 /**
  * Sign out the current user.
  *
- * @param {string} baseUrl - The base URL of the authentication endpoint.
- * @returns {Promise<void>} Resolves when the user is logged out.
+ * @param baseUrl - The base URL of the authentication endpoint.
+ * @returns Resolves when the user is logged out.
  * @throws {Error} Throws an error if the sign out fails.
  */
-export function authSignout(baseUrl: string): Promise<void>;
+export declare function authSignout(baseUrl: string): Promise<void>;
 /**
  * Resets the user's password by first requesting a reset token and then using it to set a new password.
  *
- * @param {string} baseUrl - The base URL of the API.
- * @param {string} newPassword - The new password to set.
- * @param {Record<string, any>} param - An object containing the user's email.
- * @param {string} param.email - The email of the user requesting the password reset.
+ * @param baseUrl - The base URL of the API.
+ * @param newPassword - The new password to set.
+ * @param param - An object containing the user's email.
  * @throws Will throw an error if the request for the reset token or the password reset fails.
- * @returns {Promise<void>} - A promise that resolves when the password has been successfully reset.
+ * @returns A promise that resolves when the password has been successfully reset.
  */
-export function authResetPassword(baseUrl: string, newPassword: string, { email }: Record<string, any>): Promise<void>;
+export declare function authResetPassword(baseUrl: string, newPassword: string, { email }: {
+    email: string;
+}): Promise<void>;
 /**
  * Initiates an OAuth sign-in process with the specified provider.
  *
- * @param {string} baseUrl - The base URL of the authentication server.
- * @param {string} provider - The OAuth provider to use for sign-in (e.g., 'google', 'facebook').
- * @param {boolean} popup - Whether to use a popup window for the sign-in process.
- * @param {function} [afterSigninPopup] - Optional callback function to be called after the popup is closed.
- *
- * @returns {void} Redirects the user to the OAuth provider's sign-in page or opens a popup window for the sign-in process.
+ * @param baseUrl - The base URL of the authentication server.
+ * @param provider - The OAuth provider to use for sign-in (e.g., 'google', 'facebook').
+ * @param popup - Whether to use a popup window for the sign-in process.
+ * @param afterSigninPopup - Optional callback function to be called after the popup is closed.
+ * @returns Redirects the user to the OAuth provider's sign-in page or opens a popup window for the sign-in process.
  */
-export function authOAuthSignin(baseUrl: string, provider: string, popup: boolean, afterSigninPopup?: Function): void;
+export declare function authOAuthSignin(baseUrl: string, provider: string, popup: boolean, afterSigninPopup?: () => void): void;
 /**
  * Fetches authentication information for the user.
  *
- * @param {string} baseUrl - The base URL of the API.
- * @param {AbortSignal} signal - An AbortSignal to allow aborting the fetch request.
- * @returns {Promise<Record<string, any>} The authentication information of the user.
+ * @param baseUrl - The base URL of the API.
+ * @param signal - An AbortSignal to allow aborting the fetch request.
+ * @returns The authentication information of the user.
  * @throws {Error} If the fetch request fails or the response is not ok.
  */
-export function authInfo(baseUrl: string, signal: AbortSignal): Promise<Record<string, any>>;
+export declare function authInfo(baseUrl: string, signal?: AbortSignal): Promise<AppApiInfo[]>;

package/dist/core/lib/fab-react-toolkit-patch/auth/utils/userCRUD.d.ts

@@ -1,18 +1,19 @@
+import { AuthUser } from '../../../hooks/auth/types';
 /**
  * Fetches the current user's information.
  *
- * @param {string} baseUrl - The base URL of the user endpoint.
- * @param {AbortSignal} signal - The signal to use for the fetch request.
- * @returns {Promise<Record<string, any>>} The user's information as a JSON object.
+ * @param baseUrl - The base URL of the user endpoint.
+ * @param signal - The signal to use for the fetch request.
+ * @returns The user's information as a JSON object.
  * @throws {Error} Throws an error if fetching the user information fails.
  */
-export function getUser(baseUrl: string, signal: AbortSignal): Promise<Record<string, any>>;
+export declare function getUser(baseUrl: string, signal?: AbortSignal): Promise<AuthUser>;
 /**
  * Updates the current user's information.
  *
- * @param {string} baseUrl - The base URL of the user endpoint.
- * @param {Object} userData - The new user data to update.
- * @returns {Promise<Record<string, any>>} The updated user's information as a JSON object.
+ * @param baseUrl - The base URL of the user endpoint.
+ * @param userData - The new user data to update.
+ * @returns The updated user's information as a JSON object.
  * @throws {Error} Throws an error if updating the user information fails.
  */
-export function updateUser(baseUrl: string, userData: any): Promise<Record<string, any>>;
+export declare function updateUser(baseUrl: string, userData: Partial<AuthUser>): Promise<AuthUser>;

package/dist/core/lib/fab-react-toolkit-patch/utils/convertToFormInputs.d.ts

@@ -1,9 +1,10 @@
+import { AnyColumnInfo } from 'fastapi-rtk/api-types';
+import { MRT_RowData } from '../../../../.external/lib/mantine-react-table';
 /**
- * Converts an item object to a form inputs object based on the provided columns.
+ * Converts an item object to a form inputs object.
  *
- * @param {Object} item - The item object to be converted.
- * @param {Record<string, any>[]} columns - The columns to be used for conversion.
- * @param {Record<string, any>} schema.properties - The properties of the schema.
+ * @param item - The item object to be converted.
+ * @param columns - The columns to be used for conversion.
  * @returns The converted form inputs object.
  */
-export function convertToFormInputs(item: any, columns: Record<string, any>[]): {};
+export declare function convertToFormInputs(item: MRT_RowData, columns: AnyColumnInfo[]): MRT_RowData;

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

@@ -0,0 +1,59 @@
+import { ValidationError } from 'fastapi-rtk/api-types';
+import { MRT_RowData } from '../../../../.external/lib/mantine-react-table';
+import { BulkActionResponse } from '../../Wrappers/ApiProvider/utils/bulkActions/types';
+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: MRT_RowData | undefined;
+}
+export interface FormsContextValue<TItem = MRT_RowData> {
+    /** 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/core/lib/hooks/api/useApi.d.ts

@@ -1,499 +1 @@
-export function useApi(options: SafeContextOptions): ApiContext;
-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 APIColumnInfo = {
-    /**
-     * - The description of the column.
-     */
-    description: string;
-    /**
-     * - The label of the column.
-     */
-    label: string;
-    /**
-     * - The name of the column.
-     */
-    name: string;
-    /**
-     * - Whether the column is required.
-     */
-    required: boolean;
-    /**
-     * - The type of the column.
-     */
-    type: string;
-    /**
-     * - Whether the column is unique.
-     */
-    unique: boolean;
-};
-export type APIColumnRelationInfo = {
-    /**
-     * - The description of the column.
-     */
-    description: string;
-    /**
-     * - The label of the column.
-     */
-    label: string;
-    /**
-     * - The name of the column.
-     */
-    name: string;
-    /**
-     * - Whether the column is required.
-     */
-    required: boolean;
-    /**
-     * - The type of the column.
-     */
-    type: string;
-    /**
-     * - Whether the column is unique.
-     */
-    unique: boolean;
-    /**
-     * - The count of items in the column.
-     */
-    count: number;
-    /**
-     * - The values of the column.
-     */
-    values: {
-        id: number | string;
-        value: string;
-    }[];
-};
-export type APIColumnFilter = {
-    /**
-     * - The name of the column to filter.
-     */
-    name: string;
-    /**
-     * - The operator to use for filtering (e.g., 'eq', 'ne', 'gt', 'lt').
-     */
-    operator: string;
-};
-export type APIFilter = {
-    /**
-     * - An array of filters to apply.
-     */
-    filters: APIColumnFilter[];
-    /**
-     * - The label for the filter.
-     */
-    label: string;
-    /**
-     * - The schema of the filter, containing column information.
-     */
-    schema: APIColumnInfo | APIColumnRelationInfo;
-};
-export type APIJSONFormsSchema = {
-    /**
-     * - The type of the schema, typically 'object'.
-     */
-    type: string;
-    /**
-     * - The properties of the schema.
-     */
-    properties: Record<string, any>;
-    /**
-     * - An array of required properties.
-     */
-    required?: string[];
-};
-export type APIJSONFormsUISchemaElement = {
-    /**
-     * - The type of the UI schema element (e.g., 'Control', 'Group', 'List', etc.).
-     */
-    type: string;
-    /**
-     * - The JSON pointer to the schema property this element is associated with.
-     */
-    scope: string;
-    /**
-     * - The label for the UI schema element.
-     */
-    label?: string;
-    /**
-     * - The description for the UI schema element.
-     */
-    description?: string;
-    /**
-     * - Additional options for the UI schema element.
-     */
-    options?: Record<string, any>;
-    /**
-     * - A rule for conditional rendering of the UI schema element.
-     */
-    rule?: Record<string, any>;
-};
-export type APIJSONFormsUISchema = {
-    /**
-     * - The type of the UI schema, typically 'VerticalLayout' or 'HorizontalLayout'.
-     */
-    type: string;
-    /**
-     * - An array of UI schema elements.
-     */
-    elements: Array<APIJSONFormsUISchemaElement | APIJSONFormsUISchema>;
-    /**
-     * - The label for the UI schema.
-     */
-    label?: string;
-    /**
-     * - The description for the UI schema.
-     */
-    description?: string;
-    /**
-     * - Additional options for the UI schema.
-     */
-    options?: Record<string, any>;
-    /**
-     * - A rule for conditional rendering of the UI schema.
-     */
-    rule?: Record<string, any>;
-};
-export type APIInfo = {
-    /**
-     * - The title for the add modal or section.
-     */
-    add_title: string;
-    /**
-     * - List of columns that can be added.
-     */
-    add_columns: Array<APIColumnInfo | APIColumnRelationInfo>;
-    /**
-     * - JSONForms schema for adding items.
-     */
-    add_schema: APIJSONFormsSchema;
-    /**
-     * - JSONForms UI schema for adding items.
-     */
-    add_uischema?: APIJSONFormsUISchema;
-    /**
-     * - Translations for the add form.
-     */
-    add_translations?: Record<string, Record<string, string>>;
-    /**
-     * - The title for the edit modal or section.
-     */
-    edit_title: string;
-    /**
-     * - List of columns that can be edited.
-     */
-    edit_columns: Array<APIColumnInfo | APIColumnRelationInfo>;
-    /**
-     * - JSONForms schema for editing items.
-     */
-    edit_schema: APIJSONFormsSchema;
-    /**
-     * - JSONForms UI schema for editing items.
-     */
-    edit_uischema?: APIJSONFormsUISchema;
-    /**
-     * - Translations for the edit form.
-     */
-    edit_translations?: Record<string, Record<string, string>>;
-    /**
-     * - A mapping of filter names to filter definitions.
-     */
-    filters: Record<string, APIFilter>;
-    /**
-     * - Additional options for filters specified in the API.
-     */
-    filter_options?: Record<string, any>;
-    /**
-     * - List of permissions for the API (e.g., 'can_post', 'can_put', 'can_delete').
-     */
-    permissions: string[];
-};
-export type APIData = {
-    /**
-     * - The total count of items existing in the database for the given query parameters.
-     */
-    count: number;
-    /**
-     * - The title of the list.
-     */
-    list_title: string;
-    /**
-     * - An array of IDs for the items.
-     */
-    ids: number[] | string[];
-    /**
-     * - A mapping of column names to their labels.
-     */
-    label_columns: Record<string, string>;
-    /**
-     * - A mapping of column names to their descriptions.
-     */
-    description_columns: Record<string, string>;
-    /**
-     * - An array of column names to be displayed in the list.
-     */
-    list_columns: string[];
-    /**
-     * - An array of column names to be used for ordering.
-     */
-    order_columns: string[];
-    /**
-     * - An array of objects representing the API response data.
-     */
-    result: Record<string, any>[];
-    /**
-     * - The API path.
-     */
-    path: string;
-    /**
-     * - The query parameters used in the API request.
-     */
-    queryParams: APIQueryParams;
-};
-export type APIQueryParamsFilter = {
-    /**
-     * - The column name to filter on.
-     */
-    col: string;
-    /**
-     * - The operator to use for filtering (e.g., 'eq', 'ne', 'gt', 'lt').
-     */
-    opr: string;
-    /**
-     * - The value to filter by.
-     */
-    value: any;
-};
-export type APIQueryParamsOprFilter = {
-    /**
-     * - The operator to use for filtering (e.g., 'is_null', 'is_not_null').
-     */
-    opr: string;
-    /**
-     * - The value to filter by.
-     */
-    value: any;
-};
-export type APISpecialKey = {
-    /**
-     * - The key to be used when retrieving general props for `NextGenDataGrid`. Typically `all`. but can be `_all` if `all` is in the list of columns.
-     */
-    all: string;
-    /**
-     * - The key to be used when retrieving actions for `NextGenDataGrid`. Typically `actions`, but can be `_actions` if `actions` is in the list of columns.
-     */
-    actions: string;
-};
-export type APIQueryParams = {
-    /**
-     * - The page number for pagination.
-     */
-    page: number;
-    /**
-     * - The number of items per page for pagination.
-     */
-    page_size: number;
-    /**
-     * - The column name to order the results by.
-     */
-    order_column?: string;
-    /**
-     * - The direction of the order ('asc' or 'desc').
-     */
-    order_direction?: "asc" | "desc";
-    /**
-     * - An array of column names to be included in the response.
-     */
-    columns: string[];
-    /**
-     * - An array of filters to apply to the query.
-     */
-    filters: APIQueryParamsFilter[];
-    /**
-     * - An array of opr filters to apply to the query.
-     */
-    opr_filters?: APIQueryParamsOprFilter[];
-    /**
-     * - A global filter string to apply to the query.
-     */
-    global_filter?: string;
-    /**
-     * - Whether to include the total count of items in the response.
-     */
-    with_count?: boolean;
-};
-export type APIStreaming = {
-    /**
-     * - The streaming data, organized by the page number.
-     */
-    data: Record<string, Record<string, any>[]>;
-    /**
-     * - Indicates whether the streaming has ended.
-     */
-    isEnd: boolean;
-    /**
-     * - A function to fetch the next page of streaming data.
-     */
-    fetch: () => Promise<any>;
-    /**
-     * - A function to reset the streaming data and start over.
-     */
-    reset: () => Promise<any>;
-};
-export type APIDownloadOptions = {
-    /**
-     * - Whether to export the data in basic or detailed mode.
-     */
-    export_mode?: "basic" | "detailed";
-    /**
-     * - The delimiter to use in the exported file (e.g., ',', ';'). Default is `,`.
-     */
-    delimiter?: string;
-    /**
-     * - The character to use for quoting in the exported file. Default is `"`.
-     */
-    quotechar?: string;
-};
-export type APIUploadOptions = {
-    /**
-     * - The delimiter used in the uploaded file (e.g., ',', ';'). Default is `,`.
-     */
-    delimiter?: string;
-    /**
-     * - The character used for quoting in the uploaded file. Default is `"`.
-     */
-    quotechar?: string;
-};
-export type ApiContext = {
-    /**
-     * - The API path.
-     */
-    path: string;
-    /**
-     * - Information about the API, including schemas and UI schemas.
-     */
-    info?: APIInfo;
-    /**
-     * - The data returned by the API.
-     */
-    data?: APIData;
-    /**
-     * - The query parameters used in the API request.
-     */
-    queryParams?: APIQueryParams;
-    /**
-     * - Indicates whether the API request is currently loading.
-     */
-    loading: boolean;
-    /**
-     * - Indicates whether the API info request is currently loading.
-     */
-    infoLoading: boolean;
-    /**
-     * - Indicates whether the API data request is currently loading.
-     */
-    dataLoading: boolean;
-    /**
-     * - An error object if the API request failed.
-     */
-    error?: {
-        message: string;
-        originalError: Error;
-    };
-    /**
-     * - An error object if the API info request failed.
-     */
-    infoError?: Error;
-    /**
-     * - An error object if the API data request failed.
-     */
-    dataError?: Error;
-    /**
-     * - The raw React Query object for the info request.
-     */
-    infoQuery: Record<string, any>;
-    /**
-     * - The raw React Query object for the data request.
-     */
-    dataQuery: Record<string, any>;
-    /**
-     * - The raw React Query infinite query object for streaming requests.
-     */
-    streamingQuery: Record<string, any>;
-    /**
-     * - An object containing streaming data and a function to fetch more data. Only available when the `ApiProvider` is configured for streaming.
-     */
-    streaming: APIStreaming;
-    /**
-     * - An object containing special keys for the API query, such as 'all' and 'actions'.
-     */
-    specialKey: APISpecialKey;
-    /**
-     * - A function to update the query parameters.
-     */
-    setQueryParams: (partialQueryParams: Partial<APIQueryParams> | ((prev: APIQueryParams) => Partial<APIQueryParams>)) => void;
-    /**
-     * - A function to refetch the data from the API.
-     */
-    refetch: (options?: {
-        force?: boolean;
-    }) => Promise<void>;
-    /**
-     * - A function to refetch the API information.
-     */
-    refetchInfo: (options?: {
-        force?: boolean;
-    }) => Promise<void>;
-    /**
-     * - A function to retrieve a specific entry by ID.
-     */
-    getEntry: (id: number | string) => Promise<Record<string, any>>;
-    /**
-     * - A function to add a new entry to the API.
-     */
-    addEntry: (item: Record<string, any>) => Promise<Record<string, any>>;
-    /**
-     * - A function to edit an existing entry in the API.
-     */
-    updateEntry: (id: number | string, item: Record<string, any>) => Promise<Record<string, any>>;
-    /**
-     * - A function to delete an entry from the API.
-     */
-    deleteEntry: (id: number | string) => Promise<Record<string, any>>;
-    /**
-     * - A function to download data from the API.
-     */
-    download: (label: string, options?: APIDownloadOptions) => Promise<void>;
-    /**
-     * - A function to upload a file to the API.
-     */
-    upload: (file: File, options?: APIUploadOptions) => Promise<Record<string, any>>;
-    /**
-     * - A function to get the URL for a file item, which can be either a string (representing the file name) or a File object.
-     */
-    getFileURL: (item: string | File) => string;
-    /**
-     * - A function to get the URL for an image item, which can be either a string (representing the image name) or a File object.
-     */
-    getImageURL: (item: string | File) => string;
-    /**
-     * - A function to set the error state. Useful when handling errors thrown by the action functions (`addEntry`, `updateEntry`, ...) and surfacing them through the shared `ErrorDialog`.
-     */
-    setError: (error: {
-        message: string;
-        originalError: Error;
-        data?: Record<string, any>;
-    } | undefined) => void;
-    /**
-     * - A function to reset the error state.
-     */
-    resetError: () => void;
-};
+export { useApi } from 'fastapi-rtk/contexts';