fastapi-rtk 0.2.33 → 0.2.36

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

@@ -11,16 +11,16 @@ export function useProvideApi({ path, initialQueryParams, relation, fetchInfo, c
     throwOnError?: boolean;
     streaming?: boolean;
 }, api?: {
-    getItem: (path: any, id: any) => Promise<string | Record<string, any>>;
-    getItems: (path: string, queryParams: Record<string, any>, signal: AbortSignal) => Promise<Record<string, any> | string>;
-    createItem: (path: any, data: any) => Promise<string | Record<string, any>>;
-    updateItem: (path: any, id: any, data: any) => Promise<string | Record<string, any>>;
-    deleteItem: (path: any, id: any) => Promise<string | Record<string, any>>;
+    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, signal: AbortSignal) => Promise<Record<string, any>>;
-    formCreateItem: (path: any, data: any) => Promise<string | Record<string, any>>;
-    formUpdateItem: (path: any, id: any, data: any) => 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: unknown;
@@ -34,7 +34,11 @@ export function useProvideApi({ path, initialQueryParams, relation, fetchInfo, c
         page_size: number;
     };
     loading: boolean;
+    infoLoading: boolean;
+    dataLoading: boolean;
     error: undefined;
+    infoError: Error;
+    dataError: Error;
     streaming: {
         data: {};
         isEnd: boolean;

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

@@ -5,7 +5,7 @@ export namespace defaultBulk {
 export function useProvideBulk({ path }: {
     path: any;
 }, bulk?: {
-    postBulk: (path: any, handler: any, data: any) => Promise<string | Record<string, any>>;
+    postBulk: (path: any, handler: any, data: any, options: any) => Promise<string | Record<string, any>>;
 }): {
     bulkActions: {
         selectedIds: any[];

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

@@ -1 +1 @@
-export function createItem(path: any, data: any): Promise<string | Record<string, any>>;
+export function createItem(path: any, data: any, options: any): Promise<string | Record<string, any>>;

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

@@ -1 +1 @@
-export function deleteItem(path: any, id: any): Promise<string | Record<string, any>>;
+export function deleteItem(path: any, id: any, options: any): Promise<string | Record<string, any>>;

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

@@ -1 +1 @@
-export function formCreateItem(path: any, data: any): Promise<string | Record<string, any>>;
+export function formCreateItem(path: any, data: any, options: any): Promise<string | Record<string, any>>;

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

@@ -1 +1 @@
-export function formUpdateItem(path: any, id: any, data: any): Promise<string | Record<string, any>>;
+export function formUpdateItem(path: any, id: any, data: any, options: any): Promise<string | Record<string, any>>;

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

@@ -1 +1 @@
-export function getInfo(path: string, signal: AbortSignal): Promise<Record<string, any>>;
+export function getInfo(path: string, options: RequestInit): Promise<Record<string, any>>;

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

@@ -1 +1 @@
-export function getItem(path: any, id: any): Promise<string | Record<string, any>>;
+export function getItem(path: any, id: any, options: any): Promise<string | Record<string, any>>;

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

@@ -1 +1 @@
-export function getItems(path: string, queryParams: Record<string, any>, signal: AbortSignal): Promise<Record<string, any> | string>;
+export function getItems(path: string, queryParams: Record<string, any>, options: RequestInit): Promise<Record<string, any> | string>;

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

@@ -1 +1 @@
-export function updateItem(path: any, id: any, data: any): Promise<string | Record<string, any>>;
+export function updateItem(path: any, id: any, data: any, options: any): Promise<string | Record<string, any>>;

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

@@ -1 +1 @@
-export function postBulk(path: any, handler: any, data: any): Promise<string | Record<string, any>>;
+export function postBulk(path: any, handler: any, data: any, options: any): Promise<string | Record<string, any>>;

package/dist/core/lib/Wrappers/Provider/Contexts/LangContext.d.ts

@@ -0,0 +1,15 @@
+export const InnerInnerLangContextProvider: import('react').ComponentType<{
+    value: any;
+    children: any;
+}>;
+export const useLangProvider: (options?: SafeContextOptions) => any;
+export function InnerLangContextProvider({ children, MRTLocalization, ...props }: {
+    [x: string]: any;
+    children: any;
+    MRTLocalization: any;
+}): import("react").JSX.Element;
+export function LangContextProvider({ children, langProps, props }: {
+    children: any;
+    langProps: any;
+    props: any;
+}): import("react").JSX.Element;

package/dist/core/lib/Wrappers/Provider/Provider.d.ts

@@ -1,4 +1,32 @@
 export function Provider(props: ProviderProps): JSX.Element;
+export type GetI18nProps = {
+    /**
+     * - The props for `i18n.init`
+     */
+    initProps?: Record<string, any>;
+    /**
+     * - A function that takes the i18n instance and returns back a i18n instance
+     */
+    callback?: (i18n: Record<string, any>) => Record<string, any>;
+};
+export type LangProps = {
+    /**
+     * - The i18n instance to be used for translations. If not provided, it will use `getI18n` function from fastapi-rtk
+     */
+    i18n?: Record<string, any>;
+    /**
+     * - The props to pass to the `getI18n` function if `i18n` is not provided
+     */
+    getI18nProps?: GetI18nProps;
+    /**
+     * - The language to be used for translations. If not provided, defaults to language from local storage or `en`
+     */
+    lang?: string | ((i18n: Record<string, any>) => string);
+    /**
+     * - The localization resources for the MRT (Mantine React Table)
+     */
+    MRTLocalization?: Record<string, Record<string, string>>;
+};
 export type ProviderProps = {
     /**
      * - The base URL for the API
@@ -24,4 +52,8 @@ export type ProviderProps = {
      * - Whether to inherit the Mantine theme
      */
     inheritMantineTheme?: boolean;
+    /**
+     * - The props for the language context
+     */
+    langProps?: LangProps;
 };

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

@@ -349,6 +349,14 @@ export type ApiContext = {
      * - 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.
      */
@@ -356,6 +364,14 @@ export type ApiContext = {
         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.
      */

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

@@ -1,4 +1,4 @@
-export function useForms(type: any, options: SafeContextOptions): FormsContext;
+export function useForms(type: "add" | "edit" | "delete", options: SafeContextOptions): FormsContext;
 export type SafeContextOptions = {
     /**
      * - Whether to throw an error if the context is not provided.

package/dist/core/lib/hooks/lang/useLang.d.ts

@@ -0,0 +1,39 @@
+import { useTranslation } from 'react-i18next';
+export function useLang(options: SafeContextOptions): LangContext;
+export { useTranslation };
+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 LangContext = {
+    /**
+     * - The current language code (e.g., 'en', 'de').
+     */
+    currentLanguage: string;
+    /**
+     * - Function to change the current language.
+     */
+    setLanguage: (lng: string) => void;
+    /**
+     * - The translation object from `react-i18next`. Same as using `useTranslation` from `react-i18next`.
+     */
+    translation: Record<string, any>;
+    /**
+     * - `useTranslation` from `react-i18next`.
+     */
+    useTranslation: () => Record<string, any>;
+    /**
+     * - The language code stored in local storage.
+     */
+    localStorageLanguage: string;
+    /**
+     * - Function to set the language code in local storage.
+     */
+    setLocalStorageLanguage: (lng: string) => void;
+};

package/dist/core/lib/index.d.ts

@@ -12,6 +12,7 @@ export { useForms } from './hooks/api/useForms';
 export { useAuth } from './hooks/auth/useAuth';
 export { useInfo } from './hooks/auth/useInfo';
 export { UserMenu } from './Menu/UserMenu/UserMenu';
+export { LanguageSelector } from './Selectors/LanguageSelector';
 export { AddDialog } from './ActionIcons/Add/AddDialog';
 export { EditDialog } from './ActionIcons/Edit/EditDialog';
 export { CommonModal } from './ActionIcons/Modals/CommonModal';
@@ -21,6 +22,7 @@ export { InfiniteScroll } from './Wrappers/InfiniteScroll/InfiniteScroll';
 export { LazyLoadWrapper } from './Wrappers/LazyLoadWrapper/LazyLoadWrapper';
 export { Provider } from './Wrappers/Provider/Provider';
 export * from './sub-packages-exporter';
+export { useTranslation } from './hooks/lang/useLang';
 export { Filter } from './Tables/DataGrid/Toolbar/Filter/Filter';
 export { DataGrid, DataGrid as Datagrid } from './Tables/DataGrid/DataGrid';
 export { NextGenDataGrid, NextGenDataGrid as NextGenDatagrid, NextGenDataGrid as NextGendatagrid, NextGenDataGrid as Nextgendatagrid } from './Tables/NextGenDataGrid/NextGenDataGrid';

package/dist/core/lib/translations/de.d.ts

@@ -0,0 +1,18 @@
+declare const _default: {
+    View: string;
+    Add: string;
+    'Add Item': string;
+    Edit: string;
+    Delete: string;
+    Refresh: string;
+    Download: string;
+    Cancel: string;
+    Overlay: string;
+    'Exit overlay': string;
+    'Full screen': string;
+    'Exit full screen': string;
+    'Are you sure you want to delete this item?': string;
+    'No filters': string;
+    'Advanced Filters': string;
+};
+export default _default;

package/dist/utils/cjs/FastAPIRTKLogger/FastAPIRTKLogger.cjs

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const FastAPIRTKLogger = {
+  log: (...args) => console.log("fastapi-rtk:", ...args),
+  error: (...args) => console.error("fastapi-rtk:", ...args),
+  warn: (...args) => console.warn("fastapi-rtk:", ...args)
+};
+exports.FastAPIRTKLogger = FastAPIRTKLogger;

package/dist/utils/cjs/createFetchParams/createFetchParams.cjs

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const reactRouterDom = require("react-router-dom");
-function createFetchParams({ path, method, body = void 0, queryParams = void 0 }) {
+function createFetchParams({ path, method, body = void 0, queryParams = void 0, options: userOptions }) {
   const data = Object.entries(queryParams || {}).reduce((acc, [key, value]) => {
     if (Array.isArray(value) || typeof value === "object") {
       value = JSON.stringify(value);
@@ -15,12 +15,14 @@ function createFetchParams({ path, method, body = void 0, queryParams = void 0 }
     method,
     mode: "cors",
     credentials: "include",
-    headers: {
-      "Content-Type": "application/json"
-    },
     redirect: "follow",
     referrerPolicy: "no-referrer",
-    body: body ? JSON.stringify(body) : null
+    body: body ? JSON.stringify(body) : null,
+    ...userOptions,
+    headers: {
+      "Content-Type": "application/json",
+      ...userOptions == null ? void 0 : userOptions.headers
+    }
   };
   return { fetchPath: path, options };
 }

package/dist/utils/cjs/index.cjs

@@ -5,6 +5,7 @@ const convertToFormData = require("./convertToFormData/convertToFormData.cjs");
 const createFetchParams = require("./createFetchParams/createFetchParams.cjs");
 const createSafeContext = require("./createSafeContext/createSafeContext.cjs");
 const deepMerge = require("./deepMerge/deepMerge.cjs");
+const FastAPIRTKLogger = require("./FastAPIRTKLogger/FastAPIRTKLogger.cjs");
 const getByPath = require("./getByPath/getByPath.cjs");
 const getItemId = require("./getItemId/getItemId.cjs");
 const getItemName = require("./getItemName/getItemName.cjs");
@@ -21,6 +22,7 @@ exports.convertToFormData = convertToFormData.convertToFormData;
 exports.createFetchParams = createFetchParams.createFetchParams;
 exports.createSafeContext = createSafeContext.createSafeContext;
 exports.deepMerge = deepMerge.deepMerge;
+exports.FastAPIRTKLogger = FastAPIRTKLogger.FastAPIRTKLogger;
 exports.getByPath = getByPath.getByPath;
 exports.getItemId = getItemId.getItemId;
 exports.getItemName = getItemName.getItemName;

package/dist/utils/esm/FastAPIRTKLogger/FastAPIRTKLogger.mjs

@@ -0,0 +1,8 @@
+const FastAPIRTKLogger = {
+  log: (...args) => console.log("fastapi-rtk:", ...args),
+  error: (...args) => console.error("fastapi-rtk:", ...args),
+  warn: (...args) => console.warn("fastapi-rtk:", ...args)
+};
+export {
+  FastAPIRTKLogger
+};

package/dist/utils/esm/createFetchParams/createFetchParams.mjs

@@ -1,5 +1,5 @@
 import { createSearchParams } from "react-router-dom";
-function createFetchParams({ path, method, body = void 0, queryParams = void 0 }) {
+function createFetchParams({ path, method, body = void 0, queryParams = void 0, options: userOptions }) {
   const data = Object.entries(queryParams || {}).reduce((acc, [key, value]) => {
     if (Array.isArray(value) || typeof value === "object") {
       value = JSON.stringify(value);
@@ -13,12 +13,14 @@ function createFetchParams({ path, method, body = void 0, queryParams = void 0 }
     method,
     mode: "cors",
     credentials: "include",
-    headers: {
-      "Content-Type": "application/json"
-    },
     redirect: "follow",
     referrerPolicy: "no-referrer",
-    body: body ? JSON.stringify(body) : null
+    body: body ? JSON.stringify(body) : null,
+    ...userOptions,
+    headers: {
+      "Content-Type": "application/json",
+      ...userOptions == null ? void 0 : userOptions.headers
+    }
   };
   return { fetchPath: path, options };
 }

package/dist/utils/esm/index.mjs

@@ -3,6 +3,7 @@ import { convertToFormData } from "./convertToFormData/convertToFormData.mjs";
 import { createFetchParams } from "./createFetchParams/createFetchParams.mjs";
 import { createSafeContext } from "./createSafeContext/createSafeContext.mjs";
 import { deepMerge } from "./deepMerge/deepMerge.mjs";
+import { FastAPIRTKLogger } from "./FastAPIRTKLogger/FastAPIRTKLogger.mjs";
 import { getByPath } from "./getByPath/getByPath.mjs";
 import { getItemId } from "./getItemId/getItemId.mjs";
 import { getItemName } from "./getItemName/getItemName.mjs";
@@ -15,6 +16,7 @@ import { parseResponse } from "./parseResponse/parseResponse.mjs";
 import { parseValue } from "./parseValue/parseValue.mjs";
 import { normalize, urlJoin } from "./urlJoin/urlJoin.mjs";
 export {
+  FastAPIRTKLogger,
   convertId,
   convertToFormData,
   createFetchParams,

package/dist/utils/lib/FastAPIRTKLogger/FastAPIRTKLogger.d.ts

@@ -0,0 +1,5 @@
+export namespace FastAPIRTKLogger {
+    function log(...args: any[]): void;
+    function error(...args: any[]): void;
+    function warn(...args: any[]): void;
+}

package/dist/utils/lib/FastAPIRTKLogger/index.d.ts

@@ -0,0 +1 @@
+export * from './FastAPIRTKLogger';

package/dist/utils/lib/createFetchParams/createFetchParams.d.ts

@@ -1,19 +1,10 @@
-export function createFetchParams({ path, method, body, queryParams }: {
+export function createFetchParams({ path, method, body, queryParams, options: userOptions }: {
     path: any;
     method: any;
     body?: any;
     queryParams?: any;
+    options: any;
 }): {
     fetchPath: any;
-    options: {
-        method: any;
-        mode: string;
-        credentials: string;
-        headers: {
-            'Content-Type': string;
-        };
-        redirect: string;
-        referrerPolicy: string;
-        body: string;
-    };
+    options: any;
 };

package/dist/utils/lib/index.d.ts

@@ -3,6 +3,7 @@ export * from './convertToFormData/index';
 export * from './createFetchParams/index';
 export * from './createSafeContext/index';
 export * from './deepMerge/index';
+export * from './FastAPIRTKLogger/index';
 export * from './getByPath/index';
 export * from './getItemId/index';
 export * from './getItemName/index';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastapi-rtk",
-  "version": "0.2.33",
+  "version": "0.2.36",
   "private": false,
   "description": "A React component library for FastAPI in combination with FastAPI React Toolkit backend, built with Mantine, JsonForms, and Zustand.",
   "license": "MIT",

package/dist/core/cjs/Dialogs/AlertDialog/AlertDialog.cjs

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const jsxRuntime = require("react/jsx-runtime");
-const core = require("@mantine/core");
-function AlertDialog({ opened, onClose, handleAccept, handleReject }) {
-  return /* @__PURE__ */ jsxRuntime.jsxs(
-    core.Modal,
-    {
-      opened,
-      onClose,
-      "aria-labelledby": "alert-dialog-title",
-      "aria-describedby": "alert-dialog-description",
-      title: "Item löschen?",
-      centered: true,
-      children: [
-        "Sind Sie Sicher, dass Sie das Item löschen wollen?",
-        /* @__PURE__ */ jsxRuntime.jsxs(core.Group, { align: "right", mt: "xl", justify: "flex-end", children: [
-          /* @__PURE__ */ jsxRuntime.jsx(core.Button, { onClick: handleReject, variant: "default", children: "Abbrechen" }),
-          /* @__PURE__ */ jsxRuntime.jsx(core.Button, { onClick: handleAccept, color: "red", children: "Löschen" })
-        ] })
-      ]
-    }
-  );
-}
-exports.AlertDialog = AlertDialog;

package/dist/core/esm/Dialogs/AlertDialog/AlertDialog.mjs

@@ -1,25 +0,0 @@
-import { jsxs, jsx } from "react/jsx-runtime";
-import { Modal, Group, Button } from "@mantine/core";
-function AlertDialog({ opened, onClose, handleAccept, handleReject }) {
-  return /* @__PURE__ */ jsxs(
-    Modal,
-    {
-      opened,
-      onClose,
-      "aria-labelledby": "alert-dialog-title",
-      "aria-describedby": "alert-dialog-description",
-      title: "Item löschen?",
-      centered: true,
-      children: [
-        "Sind Sie Sicher, dass Sie das Item löschen wollen?",
-        /* @__PURE__ */ jsxs(Group, { align: "right", mt: "xl", justify: "flex-end", children: [
-          /* @__PURE__ */ jsx(Button, { onClick: handleReject, variant: "default", children: "Abbrechen" }),
-          /* @__PURE__ */ jsx(Button, { onClick: handleAccept, color: "red", children: "Löschen" })
-        ] })
-      ]
-    }
-  );
-}
-export {
-  AlertDialog
-};

package/dist/core/lib/Dialogs/AlertDialog/AlertDialog.d.ts

@@ -1,6 +0,0 @@
-export function AlertDialog({ opened, onClose, handleAccept, handleReject }: {
-    opened: any;
-    onClose: any;
-    handleAccept: any;
-    handleReject: any;
-}): import("react").JSX.Element;