fastapi-rtk 0.2.6 → 0.2.8

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

@@ -1,67 +1,421 @@
-export function useApi(): {
+export function useApi(options: SafeContextOptions): ApiContext;
+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;
+    /**
+     * - 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;
+    /**
+     * - 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 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: Record<string, any>;
+};
+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 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 = {
+    /**
+     * - An array of column names to be included in the response.
+     */
+    columns: string[];
+    /**
+     * - An array of filters to apply to the query.
+     */
+    filters: APIQueryParamsFilter[];
+    /**
+     * - The column name to order the results by.
+     */
+    order_column?: string;
+    /**
+     * - The direction of the order ('asc' or 'desc').
+     */
+    order_direction?: "asc" | "desc";
+    /**
+     * - The page number for pagination.
+     */
+    page: number;
+    /**
+     * - The number of items per page for pagination.
+     */
+    page_size: number;
+    /**
+     * - A global filter string to apply to the query.
+     */
+    global_filter?: string;
+};
+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: () => void;
+};
+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;
-    data: {
-        count: number;
-        description_columns: Record<string, string>;
-        ids: number[] | string[];
-        label_columns: Record<string, string>;
-        list_columns: string[];
-        list_title: string;
-        order_columns: string[];
-        result: Record<string, any>[];
-        path: string;
-        queryParams: Record<string, any>;
-    } | null;
-    info: {
-        add_columns: import('../../Wrappers/ApiProvider/Contexts/ApiContext').ColumnInfo[];
-        add_title: string;
-        add_schema: Record<string, any>;
-        add_uischema: Record<string, any>;
-        edit_columns: import('../../Wrappers/ApiProvider/Contexts/ApiContext').ColumnInfo[];
-        edit_title: string;
-        edit_schema: Record<string, any>;
-        edit_uischema: Record<string, any>;
-        filter_options: Record<string, any>;
-        filters: Record<string, import('../../Wrappers/ApiProvider/Contexts/ApiContext').Filter>;
-        permissions: string[];
-        relations: string[] | null;
-        path: string;
-    } | null;
-    queryParams: {
-        columns: string[];
-        filters: {
-            col: string;
-            opr: string;
-            value: Any;
-        }[];
-        order_column: string | undefined;
-        order_direction: string | undefined;
-        page: number;
-        page_size: number;
-        global_filter: string | undefined;
-    } | null;
+    /**
+     * - 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;
-    error: {
+    /**
+     * - An error object if the API request failed.
+     */
+    error?: {
         message: string;
         originalError: Error;
-    } | null;
-    streaming: {
-        data: Record<string, Record<string, any>[]>;
-        isEnd: boolean;
-        fetch: () => void;
     };
-    specialKey: {
-        all: string;
-        actions: string;
-    };
-    setQueryParams: (partialQueryParams: any) => any;
-    refetch: (options: any) => Promise<any>;
-    refetchInfo: (options: any) => Promise<any>;
-    getEntry: (id: any) => Promise<{}>;
-    addEntry: (item: any) => Promise<{}>;
-    updateEntry: (id: any, item: any) => Promise<{}>;
-    deleteEntry: (id: any) => Promise<{}>;
-    download: (label: any, { export_mode, delimiter, quotechar }?: {}) => Promise<any>;
-    upload: (file: any, { delimiter, quotechar }?: {}) => Promise<{}>;
-    resetError: () => 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 reset the error state.
+     */
+    resetError: () => void;
+};
+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;
 };

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

@@ -1,11 +1,28 @@
-export function useBulkActions(): {
-    bulkActions: {
-        selectedIds: any[];
-        setSelectedIds: () => any;
-    };
-    dispatchBulkActions: (handler: any, data: any) => Promise<void>;
-    error: {
+export function useBulkActions(options: SafeContextOptions): BulkActionsContext;
+export type SafeContextOptions = {
+    /**
+     * - Whether to throw an error if the context is not provided.
+     */
+    throwOnError?: boolean;
+    /**
+     * - The default value to return if the context is not provided.
+     */
+    defaultValue?: any;
+};
+export type BulkActionsContext = {
+    /**
+     * - An array containing the selected IDs and a function to set them.
+     */
+    bulkActions: [Array<string | number>, () => void | ((prev: Array<string | number>) => void)];
+    /**
+     * - A function to dispatch bulk actions with a handler and optional data. If data is not provided, it uses the currently selected IDs.
+     */
+    dispatchBulkActions: (handler: string, data?: Array<string | number>) => Promise<Record<string, any>>;
+    /**
+     * - An error object if the bulk action failed.
+     */
+    error?: {
         message: string;
         originalError: Error;
-    } | null;
+    };
 };

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

@@ -1,15 +1,74 @@
-export function useForms(type?: "add" | "edit"): {
+export function useForms(type: any, options: SafeContextOptions): FormsContext;
+export type SafeContextOptions = {
+    /**
+     * - Whether to throw an error if the context is not provided.
+     */
+    throwOnError?: boolean;
+    /**
+     * - The default value to return if the context is not provided.
+     */
+    defaultValue?: any;
+};
+export type FormsContext = {
+    /**
+     * - Indicates whether the form is currently opened.
+     */
     opened: boolean;
-    getOpened: () => never;
-    setOpened: () => never;
-    view: number;
-    getView: () => never;
-    setView: () => never;
-    state: any;
-    getState: () => never;
-    setState: () => never;
-    reset: () => never;
-    item: any;
-    getItem: () => never;
-    setItem: () => never;
+    /**
+     * - A function to get the current opened state of the form.
+     */
+    getOpened: () => boolean;
+    /**
+     * - A function to set the opened state of the form.
+     */
+    setOpened: (newOpened: boolean) => void;
+    /**
+     * - The current view mode of the form. See `VIEW_MODE` from `@fastapi-rtk/constants` for more details.
+     */
+    view: "normal" | "fullScreen" | "overlay";
+    /**
+     * - A function to get the current view mode of the form.
+     */
+    getView: () => "normal" | "fullScreen" | "overlay";
+    /**
+     * - A function to set the view mode of the form.
+     */
+    setView: (newView: "normal" | "fullScreen" | "overlay") => void;
+    /**
+     * - The current state of the form, including errors and data.
+     */
+    state: {
+        errors: Record<string, any>[];
+        data: Record<string, any> | undefined;
+    };
+    /**
+     * - A function to get the current state of the form.
+     */
+    getState: () => {
+        errors: Record<string, any>[];
+        data: Record<string, any> | undefined;
+    };
+    /**
+     * - A function to set the state of the form.
+     */
+    setState: (newState: {
+        errors: Record<string, any>[];
+        data: Record<string, any> | undefined;
+    }) => void;
+    /**
+     * - A function to reset the form state to its initial state.
+     */
+    reset: () => void;
+    /**
+     * - The current item being edited in the form, if applicable.
+     */
+    item: Record<string, any> | undefined;
+    /**
+     * - A function to get the current item in the form.
+     */
+    getItem: () => Record<string, any> | undefined;
+    /**
+     * - A function to set the current item in the form.
+     */
+    setItem: (newItem: Record<string, any> | undefined) => void;
 };