fastapi-rtk 2.1.4 → 2.2.0

package/dist/core/lib/Tables/NextGenDataGrid/NextGenDataGrid.d.ts

@@ -1,1387 +1,2 @@
-/**
- * @type {React.ForwardRefExoticComponent<NextGenDataGridProps>}
- */
-export const NextGenDataGrid: React.ForwardRefExoticComponent<NextGenDataGridProps>;
-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 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: () => 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;
-    /**
-     * - 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;
-    /**
-     * - 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 reset the error state.
-     */
-    resetError: () => void;
-};
-export type BulkActions = {
-    /**
-     * - An array of currently selected IDs for bulk actions.
-     */
-    selectedIds: Array<string | number>;
-    /**
-     * - A function to set the selected IDs.
-     */
-    setSelectedIds: Function;
-};
-export type BulkActionsContext = {
-    /**
-     * - An array containing the selected IDs and a function to set them.
-     */
-    bulkActions: BulkActions;
-    /**
-     * - A function to dispatch bulk actions with a handler and optional data. If data is not provided, it uses the currently selected IDs.
-     */
-    dispatchBulkActions: (handler: string, data?: Array<string | number>) => Promise<Record<string, any>>;
-    /**
-     * - An error object if the bulk action failed.
-     */
-    error?: {
-        message: string;
-        originalError: Error;
-    };
-    /**
-     * - A function to reset the error state.
-     */
-    resetError: () => void;
-};
-export type AuthUser = {
-    /**
-     * - The unique identifier of the authenticated user.
-     */
-    id: number;
-    /**
-     * - The email of the authenticated user.
-     */
-    email: string;
-    /**
-     * - The username of the authenticated user.
-     */
-    username: string;
-    /**
-     * - The first name of the authenticated user.
-     */
-    first_name?: string;
-    /**
-     * - The last name of the authenticated user.
-     */
-    last_name?: string;
-    /**
-     * - Indicates whether the user account is active.
-     */
-    active: boolean;
-    /**
-     * - The timestamp of the user's last login.
-     */
-    last_login: string;
-    /**
-     * - The number of times the user has logged in.
-     */
-    login_count: number;
-    /**
-     * - The number of failed login attempts.
-     */
-    fail_login_count: number;
-    /**
-     * - The timestamp when the user account was created.
-     */
-    created_on: string;
-    /**
-     * - The timestamp when the user account was last changed.
-     */
-    changed_on: string;
-    /**
-     * - The full name of the authenticated user.
-     */
-    full_name: string;
-    /**
-     * - Indicates whether the user account is active.
-     */
-    is_active: boolean;
-    /**
-     * - Indicates whether the user's email is verified.
-     */
-    is_verified: boolean;
-    /**
-     * - Indicates whether the user has superuser privileges.
-     */
-    is_superuser: boolean;
-    /**
-     * - Indicates whether the user is anonymous.
-     */
-    is_anonymous: boolean;
-    /**
-     * - An array of permissions assigned to the user.
-     */
-    permissions: string[];
-    /**
-     * - An array of roles assigned to the user.
-     */
-    roles: string[];
-};
-export type AuthContext = {
-    /**
-     * - The authenticated user object, or null if not authenticated.
-     */
-    user: AuthUser | null;
-    /**
-     * - Indicates whether the authentication state is currently loading.
-     */
-    loading: boolean;
-    /**
-     * - An error object if the authentication request failed.
-     */
-    error: {
-        message: string;
-        originalError: Error;
-    } | null;
-    /**
-     * - A function to sign in the user with a username and password.
-     */
-    signin: (username: string, password: string) => Promise<void>;
-    /**
-     * - A function to sign out the user.
-     */
-    signout: () => Promise<void>;
-    /**
-     * - A function to update the authenticated user's data.
-     */
-    update: (data: Record<string, any>) => Promise<AuthUser>;
-    /**
-     * - A function to reset the user's password.
-     */
-    resetPassword: (password: string) => Promise<void>;
-    /**
-     * - A function to sign in the user using OAuth with a specified provider. If `popup` is true, it opens a popup window for the OAuth flow.
-     */
-    oauth_signin: (provider: string, popup?: boolean) => Promise<void>;
-    /**
-     * - A function to refetch the authenticated user's data.
-     */
-    refetch: () => Promise<void>;
-    /**
-     * - A function to reset the error state.
-     */
-    resetError: () => void;
-};
-export type CommonModalTitleOptionsProps = {
-    /**
-     * - Content or function to render on the left side of the title.
-     */
-    left: React.ReactNode | ((props: {
-        view: string;
-        setView: (view: string) => void;
-    }) => React.ReactNode);
-    /**
-     * - Content or function to render on the right side of the title.
-     */
-    right: React.ReactNode | ((props: {
-        view: string;
-        setView: (view: string) => void;
-    }) => React.ReactNode);
-    /**
-     * - If true, hides the overlay toggle button.
-     */
-    hideOverlay?: boolean;
-    /**
-     * - If true, hides the full screen toggle button.
-     */
-    hideFullScreen?: boolean;
-    /**
-     * - Additional props to be passed to the overlay toggle button.
-     */
-    overlayButtonProps?: Record<string, any> | ((props: {
-        view: string;
-        setView: (view: string) => void;
-    }) => Record<string, any>);
-    /**
-     * - Additional props to be passed to the full screen toggle button.
-     */
-    fullScreenButtonProps?: Record<string, any> | ((props: {
-        view: string;
-        setView: (view: string) => void;
-    }) => Record<string, any>);
-};
-export type CommonModalActionButtonsProps = {
-    /**
-     * - Additional properties to be passed to the Group component wrapping the buttons.
-     */
-    groupProps?: Record<string, any>;
-    /**
-     * - Flag to determine if the reset button should be displayed.
-     */
-    withResetButton?: boolean;
-    /**
-     * - Flag to determine if the submit button should be displayed.
-     */
-    withSubmitButton?: boolean;
-    /**
-     * - Additional properties to be passed to the reset Button component.
-     */
-    resetButtonProps?: Record<string, any>;
-    /**
-     * - Additional properties to be passed to the submit Button component.
-     */
-    submitButtonProps?: Record<string, any>;
-};
-export type CommonModalProps = {
-    /**
-     * - The content to be rendered inside the modal.
-     */
-    children: React.ReactNode;
-    /**
-     * - Current view mode (e.g., VIEW_MODE.NORMAL, VIEW_MODE.FULL_SCREEN, VIEW_MODE.OVERLAY).
-     */
-    view: string;
-    /**
-     * - Function to update the view mode.
-     */
-    setView: Function;
-    /**
-     * - Callback function triggered on form reset.
-     */
-    onReset: Function;
-    /**
-     * - Callback function triggered on form submission.
-     */
-    onSubmit: Function;
-    /**
-     * - Additional properties to be passed to the Box component wrapping the form.
-     */
-    boxProps: Record<string, any>;
-    /**
-     * - Text displayed on the reset button.
-     */
-    resetButtonText: string;
-    /**
-     * - Text displayed on the submit button.
-     */
-    buttonText: string;
-    /**
-     * - Indicates whether the submit button should display a loading state.
-     */
-    buttonLoading: boolean;
-    /**
-     * - Flag to determine if title options (e.g., full screen, overlay toggles) should be displayed.
-     */
-    withTitleOptions?: boolean;
-    /**
-     * - Flag to determine if action buttons (e.g., submit button) should be displayed.
-     */
-    withButtons?: boolean;
-    /**
-     * - Options for customizing the title area, such as toggles for full screen and overlay modes.
-     */
-    titleOptions?: CommonModalTitleOptionsProps;
-    /**
-     * - Options for customizing the action buttons area.
-     */
-    actionButtons?: CommonModalActionButtonsProps;
-    /**
-     * - Additional props to be passed to the Modal component.
-     */
-    rest: Record<string, any>;
-};
-export type AddDialogProps = {
-    /**
-     * - Additional JSON Forms customization options.
-     */
-    jsonForms?: Record<string, any>;
-    /**
-     * - Callback function triggered on successful form submission.
-     */
-    onSuccess?: (result: Record<string, any> | null) => void;
-    /**
-     * - Callback function triggered on form submission error.
-     */
-    onError?: (error: any) => void;
-    /**
-     * - Optional translations for internationalization.
-     */
-    translations?: Record<string, Record<string, string>>;
-    /**
-     * - Whether to hide missing translation warnings. Can be a boolean, a specific language code, an object mapping languages to booleans, or an array of language codes.
-     */
-    hideWarnings?: boolean | string | Record<string, boolean> | string[];
-    /**
-     * - Additional props to be passed to the JsonFormsWithCustomizer component.
-     */
-    jsonFormsProps?: Record<string, any>;
-};
-export type JSONFormsProps = {
-    /**
-     * - The label for the form control.
-     */
-    label?: string;
-    /**
-     * - The description for the form control.
-     */
-    description?: string;
-    /**
-     * - Indicates whether the form control is required.
-     */
-    required?: boolean;
-    /**
-     * - Indicates whether the form control is enabled.
-     */
-    enabled?: boolean;
-    /**
-     * - The data for the form control.
-     */
-    data?: any;
-    /**
-     * - Callback function triggered when the form control value changes.
-     */
-    handleChange?: (path: string, value: any) => void;
-    /**
-     * - The JSON pointer path to the form control in the data.
-     */
-    path?: string;
-    /**
-     * - Validation errors for the form control.
-     */
-    errors?: string;
-    /**
-     * - The JSON schema for the form control.
-     */
-    schema?: Record<string, any>;
-    /**
-     * - The UI schema for the form control.
-     */
-    uischema?: Record<string, any>;
-};
-export type JSONFormsCustomizerParameters = {
-    /**
-     * - The props passed to the JSON Forms component.
-     */
-    jsonFormsProps: JSONFormsProps;
-    /**
-     * - The props for the custom component.
-     */
-    componentProps: Record<string, any>;
-};
-export type JSONFormsCustomizerProps = {
-    /**
-     * - Props passed down to the Mantine Input component.
-     */
-    props: Record<string, any> | ((props: JSONFormsCustomizerParameters) => Record<string, any>);
-    /**
-     * - Component to override the default input component.
-     */
-    component: React.ReactNode | ((props: JSONFormsCustomizerParameters) => React.ReactNode);
-};
-export type NextGenDataGridChildrenProps = {
-    /**
-     * - MantineReactTable instance
-     */
-    table: import('mantine-react-table').MRT_TableInstance<import('mantine-react-table').MRT_RowData>;
-};
-export type NextGenDataGridFilterStateProps = {
-    /**
-     * - Filter value. When provided, the value will be synchronized with the inner filter state.
-     */
-    value?: any;
-    /**
-     * - Callback when the inner filter value changes.
-     */
-    onChange: (value: any) => void;
-    /**
-     * - Callback when the operator changes.
-     */
-    onOprChange?: ({ value: any, opr: string }: any) => void;
-};
-export type NextGenDataGridFilterSyncProps = {
-    /**
-     * - Function to compare values for synchronization. Defaults to strict equality (`===`).
-     */
-    equals?: (a: any, b: any) => boolean;
-    /**
-     * - Debounce delay in milliseconds for synchronization. Defaults to `DEBOUNCE_DELAY`.
-     */
-    delay?: number;
-};
-export type NextGenDataGridMRTProps = {
-    /**
-     * - The cell object
-     */
-    cell: import('mantine-react-table').MRT_Cell<import('mantine-react-table').TData, import('mantine-react-table').TValue>;
-    /**
-     * - The column object
-     */
-    column: import('mantine-react-table').MRT_Column<import('mantine-react-table').TData, import('mantine-react-table').TValue>;
-    /**
-     * - The rendered cell value
-     */
-    renderedCellValue: number | React.ReactNode | string;
-    /**
-     * - The rendered column index
-     */
-    renderedColumnIndex?: number;
-    /**
-     * - The rendered row index
-     */
-    renderedRowIndex?: number;
-    /**
-     * - The row object
-     */
-    row: import('mantine-react-table').MRT_Row<import('mantine-react-table').TData>;
-    /**
-     * - The row ref
-     */
-    rowRef?: React.RefObject<HTMLTableRowElement>;
-    /**
-     * - The MantineReactTable instance
-     */
-    table: import('mantine-react-table').MRT_TableInstance<import('mantine-react-table').TData>;
-};
-export type NextGenDataGridBodyCellHighlightProps = {
-    /**
-     * - API instance
-     */
-    api: ApiContext;
-    /**
-     * - Auth instance
-     */
-    auth: AuthContext;
-    /**
-     * - Row data
-     */
-    data: Record<string, any>;
-    /**
-     * - Column properties
-     */
-    colProps: NextGenDataGridBodyProps;
-    /**
-     * - MantineReactTable props
-     */
-    mrtProps: NextGenDataGridMRTProps;
-};
-export type NextGenDataGridBodyCellTruncateProps = {
-    /**
-     * - The original value before truncation. An array of strings if the value is separated by a separator
-     */
-    original: string | string[];
-    /**
-     * - The truncated value. An array of strings if the value is separated by a separator. Null if no truncation is applied
-     */
-    truncated?: string | string[] | null;
-};
-export type NextGenDataGridBodyCellCellProps = {
-    /**
-     * - The value of the cell, either `string` or `string[]`
-     */
-    value: string | string[];
-    /**
-     * - The truncate object containing the original and truncated value
-     */
-    truncate: NextGenDataGridBodyCellTruncateProps;
-    /**
-     * - The highlight keywords to highlight in the cell value
-     */
-    highlight: string[];
-};
-export type NextGenDataGridBodyCellComponentProps = {
-    /**
-     * - The value of the cell, either `string` or `string[]`
-     */
-    value: string | string[];
-};
-export type NextGenDataGridBodyCellProps = {
-    /**
-     * - API instance
-     */
-    api: ApiContext;
-    /**
-     * - Auth instance
-     */
-    auth: AuthContext;
-    /**
-     * - Row data
-     */
-    data: Record<string, any>;
-    /**
-     * - Column properties
-     */
-    colProps: NextGenDataGridBodyProps;
-    /**
-     * - MantineReactTable props
-     */
-    mrtProps: NextGenDataGridMRTProps;
-    /**
-     * - Array of highlight keywords
-     */
-    highlights: string[];
-    /**
-     * - The cell object containing the value, truncate and highlight
-     */
-    cell: NextGenDataGridBodyCellCellProps;
-    /**
-     * - Props for the cell component
-     */
-    componentProps: NextGenDataGridBodyCellComponentProps;
-};
-export type NextGenDataGridQuickFiltersComponentComponentProps = {
-    /**
-     * - The current quick filter value
-     */
-    value: string;
-    /**
-     * - Callback when the quick filter value changes
-     */
-    onChange: (value: string) => void;
-    /**
-     * - The quick filters data
-     */
-    data: {
-        label: string;
-        value: any;
-    }[];
-};
-export type NextGenDataGridQuickFiltersComponentProps = {
-    /**
-     * - API instance
-     */
-    api: ApiContext;
-    /**
-     * - Auth instance
-     */
-    auth: AuthContext;
-    /**
-     * - MantineReactTable props
-     */
-    mrtProps: NextGenDataGridMRTProps;
-    /**
-     * - Props for the quick filters component
-     */
-    componentProps: NextGenDataGridQuickFiltersComponentComponentProps;
-};
-export type NextGenDataGridHeaderParameters = {
-    /**
-     * - API instance
-     */
-    api: ApiContext;
-    /**
-     * - Auth instance
-     */
-    auth: AuthContext;
-    /**
-     * - MantineReactTable props
-     */
-    mrtProps: NextGenDataGridMRTProps;
-};
-export type NextGenDataGridHeaderFilterComponentParameters = {
-    /**
-     * - API instance
-     */
-    api: ApiContext;
-    /**
-     * - Auth instance
-     */
-    auth: AuthContext;
-    /**
-     * - MantineReactTable props
-     */
-    mrtProps: NextGenDataGridMRTProps;
-    /**
-     * - Props for the filter component
-     */
-    componentProps: Record<string, any>;
-};
-export type NextGenDataGridHeaderFilterMenuPropsParameters = {
-    /**
-     * - The header label
-     */
-    label: string;
-    /**
-     * - Whether the filter is disabled
-     */
-    disabled: boolean;
-    /**
-     * - The number of active filters
-     */
-    indicator: number;
-    /**
-     * - Props for the action icon
-     */
-    actionIconProps: any;
-    /**
-     * - Callback when the filter menu icon is clicked
-     */
-    onClick: (event: React.MouseEvent<HTMLElement>) => void;
-};
-export type NextGenDataGridHeaderFilterMenuParameters = {
-    /**
-     * - API instance
-     */
-    api: ApiContext;
-    /**
-     * - Auth instance
-     */
-    auth: AuthContext;
-    /**
-     * - MantineReactTable props
-     */
-    mrtProps: NextGenDataGridMRTProps;
-    /**
-     * - Props for the filter menu component
-     */
-    componentProps: NextGenDataGridHeaderFilterMenuPropsParameters;
-};
-export type NextGenDataGridHeaderFilterModeDescriptionParameters = {
-    /**
-     * - API instance
-     */
-    api: ApiContext;
-    /**
-     * - Auth instance
-     */
-    auth: AuthContext;
-    /**
-     * - MantineReactTable props
-     */
-    mrtProps: NextGenDataGridMRTProps;
-    /**
-     * - Props for the filter mode description component
-     */
-    componentProps: {
-        value: string;
-    };
-};
-export type NextGenDataGridHeaderProps = {
-    /**
-     * - Customize the header that is shown above the filter
-     */
-    component?: React.ReactNode | ((props: NextGenDataGridHeaderParameters) => React.ReactNode);
-    /**
-     * - Enables the filter menu that can change the filter mode. Located on the right side of the filter
-     */
-    enableFilterModes?: boolean;
-    /**
-     * - Customize the filter component. When `enableFilterModes` is enabled, this will be a key-value pair object where the key is the filter operator and the value is the filter component
-     */
-    filterComponent?: React.ReactNode | ((props: NextGenDataGridHeaderFilterComponentParameters) => React.ReactNode | Record<string, React.ReactNode | ((props: NextGenDataGridHeaderFilterComponentParameters) => React.ReactNode)>);
-    /**
-     * - Props for the filter component. When `enableFilterModes` is enabled, this will be a key-value pair object where the key is the filter operator and the value is the filter component props
-     */
-    filterProps?: Record<string, any> | ((props: NextGenDataGridHeaderParameters) => Record<string, any> | Record<string, Record<string, any> | ((props: NextGenDataGridHeaderParameters) => Record<string, any>)>);
-    /**
-     * - Manage filter state externally
-     */
-    filterState?: NextGenDataGridFilterStateProps;
-    /**
-     * - Options for synchronizing filter state with other components. Defaults to:
-     * - `equals`: A function to compare values, defaults to strict equality (`===`).
-     * - `delay`: A debounce delay in milliseconds, defaults to `DEBOUNCE_DELAY`. It is recommended to use the default value for `delay` to avoid performance issues.
-     */
-    filterSync?: NextGenDataGridFilterSyncProps;
-    /**
-     * - Customize the filter menu action icon beside the filter. Defaults to `Filter Menu` with icon `IconFilterCog`
-     */
-    filterMenu?: React.ReactNode | ((props: NextGenDataGridHeaderFilterMenuParameters) => React.ReactNode);
-    /**
-     * - Customize the description below the filter when `enableFilterModes` is enabled. Defaults to `Filter Mode: {Filter name}`
-     */
-    filterModeDescription?: React.ReactNode | ((props: NextGenDataGridHeaderFilterModeDescriptionParameters) => React.ReactNode);
-    /**
-     * - Whether to update the query params when the filter is applied. Default is true
-     */
-    updateQueryParams?: boolean;
-    /**
-     * - Whether to store the filter state in local storage. Defaults to false
-     */
-    withLocalStorage?: boolean;
-    /**
-     * - The key to use for local storage when `withLocalStorage` is enabled. Defaults to `nextgen-datagrid-${path}-${column}` where `path` is the API path and `column` is the column name
-     */
-    localStorageKey?: string;
-    /**
-     * - Sets the default operator for the filter. The filter componenet may change based on the operator
-     */
-    defaultOpr?: string;
-};
-export type NextGenDataGridBodyProps = {
-    /**
-     * - Customize the component within the body
-     */
-    component?: React.ReactNode | ((props: NextGenDataGridBodyCellProps) => React.ReactNode);
-    /**
-     * - Separate the value of a column into multiple rows
-     */
-    separator?: string;
-    /**
-     * - Truncate the value of a column to a certain length. Will be shown as `...` when it exceeds the length with a tooltip containing the full value
-     */
-    truncate?: number;
-    /**
-     * - Additional highlight keywords to highlight in the cell value. Can be a string, an array of strings, or a function that returns a string or an array of strings
-     */
-    highlight?: string | string[] | ((props: NextGenDataGridBodyCellHighlightProps) => string | string[]);
-    /**
-     * - Props for the tooltip component that is shown when the value is truncated. The `value` is the value of the cell, either `string` or `string[]`, `data` is the row data, and `cellObj` is the cell object containing the value, truncate and highlight
-     */
-    tooltipProps?: import('@mantine/core').TooltipProps | ((props: NextGenDataGridBodyCellProps & NextGenDataGridBodyCellComponentProps) => import('@mantine/core').TooltipProps);
-    /**
-     * - Props for the highlight component. The `value` is the value of the cell, either `string` or `string[]`, `data` is the row data, and `cellObj` is the cell object containing the value, truncate and highlight
-     */
-    highlightProps?: import('@mantine/core').HighlightProps | ((props: NextGenDataGridBodyCellProps & NextGenDataGridBodyCellComponentProps) => import('@mantine/core').HighlightProps);
-    /**
-     * - Only applies to the `actions` special key. Props forwarded to the default row `View` action icon
-     */
-    viewProps?: Record<string, any>;
-    /**
-     * - Only applies to the `actions` special key. Props forwarded to the default row `Edit` action icon
-     */
-    editProps?: Record<string, any>;
-    /**
-     * - Only applies to the `actions` special key. Props forwarded to the default row `Delete` action icon
-     */
-    deleteProps?: Record<string, any>;
-};
-export type NextGenDataGridFormProps = {
-    /**
-     * - Initial view mode for the form. Can be `normal`, `fullScreen`, or `overlay`. Defaults to `normal`
-     */
-    initialView?: "normal" | "fullScreen" | "overlay";
-    /**
-     * - Props for the JsonFormsDialog component
-     */
-    dialogProps?: CommonModalProps & AddDialogProps;
-};
-/**
- * Either a component that fully replaces the built-in toolbar button, or `{ component, props }` to replace the component while forwarding `props` to the original fallback. Pass `null` to hide the button.
- */
-export type NextGenDataGridToolbarCustomizerEntry = React.ReactNode | {
-    component: React.ReactNode;
-    props: Record<string, any>;
-};
-export type NextGenDataGridToolbarProps = {
-    /**
-     * - Overrides for the built-in toolbar buttons, keyed by button name. Pass `null` for a key to hide that button
-     */
-    customizer?: Partial<Record<"toggleGlobalFilter" | "filter" | "refresh" | "add" | "download" | "showHideColumns" | "toggleDensePadding" | "toggleFullScreen", NextGenDataGridToolbarCustomizerEntry>>;
-    /**
-     * - Extra components inserted into the internal (right-side) toolbar. Keys are 1-based string positions (e.g. `'1'`, `'3'`); out-of-range keys are appended
-     */
-    custom?: Record<string, React.ReactNode>;
-    /**
-     * - Custom components rendered on the left of the top toolbar. Uses the same 1-based position keys as `custom`. Mutually exclusive with `quickFilters`
-     */
-    leftToolbar?: {
-        custom?: Record<string, React.ReactNode>;
-    };
-    /**
-     * - Custom components rendered in the center of the top toolbar. Uses the same 1-based position keys as `custom`
-     */
-    centerToolbar?: {
-        custom?: Record<string, React.ReactNode>;
-    };
-    /**
-     * - Props forwarded to the selection / grouped alert banner shown below the toolbar
-     */
-    alertBanner?: Record<string, any>;
-};
-export type NextGenDataGridOptimizationProps = {
-    /**
-     * - Whether to optimize for selection. When enabled, selection column will be replaced with a custom one that is optimized for performance.
-     */
-    selection?: boolean;
-    /**
-     * - Ref for the selection value to synchronize with external components when `selection` optimization is enabled.
-     */
-    selectionValueRef?: React.RefObject<string[]>;
-    /**
-     * - Whether to optimize for loading state. When enabled, the table body will not render any cells when in loading state. This will break features that rely on the cells being rendered in loading state, such as skeletons and custom loading indicators, but will improve performance when dealing with large data sets. Defaults to `true`
-     */
-    loading?: boolean;
-};
-export type NextGenDataGridProps = {
-    /**
-     * - Children to render inside the DataGrid
-     * DataGrid props
-     */
-    children?: (props: NextGenDataGridChildrenProps) => React.ReactNode | any;
-    /**
-     * - Whether to fetch data on mount. Default is true
-     */
-    fetchOnMount?: boolean;
-    /**
-     * - Whether to hide the toolbar
-     */
-    hideToolbar?: boolean;
-    /**
-     * - Whether to hide the per-row actions column (edit / view / delete buttons). Disables MRT's `enableEditing` when true
-     */
-    hideActions?: boolean;
-    /**
-     * - Whether to hide the pagination
-     */
-    hidePagination?: boolean;
-    /**
-     * - Whether to hide the error dialog
-     */
-    hideError?: boolean;
-    /**
-     * - Callback for checkbox selection
-     */
-    onSelectCheckbox?: (ids: string[]) => void;
-    /**
-     * - Callback for row click
-     */
-    onClickEntry?: (id: string | number, data: Record<string, any>) => void;
-    /**
-     * - Bulk actions object
-     * NextGenDataGrid props
-     */
-    bulkActions?: BulkActions;
-    /**
-     * - MantineReactTable props. See more [here](https://v2.mantine-react-table.com/docs/api/table-options)
-     */
-    table?: import('mantine-react-table').MRT_TableOptions<import('mantine-react-table').MRT_RowData> | ((props: import('mantine-react-table').MRT_TableOptions<import('mantine-react-table').MRT_RowData>) => import('mantine-react-table').MRT_TableOptions<import('mantine-react-table').MRT_RowData>);
-    /**
-     * - Quick filters shown in the top-left of the toolbar as a `SegmentedControl`. Each entry is `{ name, value }` where `name` is the displayed label and `value` is an array of `{col, opr, value}` filter clauses applied when the segment is selected. An implicit `All` segment (empty filter) is prepended. Mutually exclusive with `toolbar.leftToolbar`
-     */
-    quickFilters?: {
-        name: string;
-        value: {
-            col: string;
-            opr: string;
-            value: any;
-        }[];
-    }[];
-    /**
-     * - Custom quick filters component
-     */
-    quickFiltersComponent?: React.ReactNode | ((props: NextGenDataGridQuickFiltersComponentProps) => React.ReactNode);
-    /**
-     * - Whether to render a border around the table's Mantine `Paper` wrapper. Disables the default shadow when false
-     */
-    withBorder?: boolean;
-    /**
-     * - Column props for the table. See more [here](https://v2.mantine-react-table.com/docs/api/column-options)
-     */
-    columnProps?: Record<string, import('mantine-react-table').MRT_ColumnDef<import('mantine-react-table').MRT_RowData, unknown> | ((props: import('mantine-react-table').MRT_ColumnDef<import('mantine-react-table').MRT_RowData, unknown>) => import('mantine-react-table').MRT_ColumnDef<import('mantine-react-table').MRT_RowData, unknown>)>;
-    /**
-     * - Header props for the table
-     */
-    header?: Record<string, NextGenDataGridHeaderProps>;
-    /**
-     * - Body props for the table
-     */
-    body?: Record<string, NextGenDataGridBodyProps>;
-    /**
-     * - Form props for the table
-     */
-    form?: {
-        add: NextGenDataGridFormProps & JSONFormsCustomizerProps;
-        edit: NextGenDataGridFormProps & JSONFormsCustomizerProps;
-    };
-    /**
-     * - Toolbar configuration for the table
-     */
-    toolbar?: NextGenDataGridToolbarProps;
-    /**
-     * - Text filter separator for the table. Default is ';'
-     */
-    textFilterSeparator?: string;
-    /**
-     * - Enables the advanced filters that allow multiple filters per column
-     */
-    enableAdvancedFilters?: boolean;
-    /**
-     * - Props forwarded to the outer Mantine `Box` that wraps the whole table (defaults: `pos="relative"`, `h="100%"`, `w="100%"`, `mih={0}`, `flex={1}`). Use it to override sizing or layout of the grid's container
-     */
-    wrapperProps?: import('@mantine/core').BoxProps;
-    /**
-     * - Whether to memoize the filters and body cells. If `true`, both filters and body cells will be memoized. If `'filters'`, only filters will be memoized. If `'cells'`, only body cells will be memoized. Defaults to `false` (no memoization)
-     */
-    memo?: boolean | "filters" | "cells";
-    /**
-     * - Whether to only query the visible columns from the backend. When enabled, it modifies the `columns` from the `queryParams` to only include the visible columns. Defaults to `false`
-     */
-    queryOnlyVisibleColumns?: boolean;
-    /**
-     * - Optimization options for the table
-     * Deprecated props
-     */
-    optimizations?: NextGenDataGridOptimizationProps;
-    /**
-     * - Body separator for the table
-     */
-    bodySeparator?: Record<string, any>;
-    /**
-     * - Body truncate for the table
-     */
-    bodyTruncate?: Record<string, any>;
-    /**
-     * - Header customizer for the table
-     */
-    headerCustomizer?: Record<string, any>;
-    /**
-     * - Body customizer for the table
-     */
-    bodyCustomizer?: Record<string, any>;
-    /**
-     * - Toolbar customizer for the table
-     */
-    toolbarCustomizer?: Record<string, any>;
-    /**
-     * - Hide add button for the table
-     */
-    hideAdd?: boolean;
-    /**
-     * - Hide download button for the table
-     */
-    hideDownload?: boolean;
-    /**
-     * - Hide filter button for the table
-     */
-    hideFilter?: boolean;
-};
+import { NextGenDataGridProps } from './types';
+export declare const NextGenDataGrid: import('react').ForwardRefExoticComponent<NextGenDataGridProps & import('react').RefAttributes<HTMLDivElement>>;