fastapi-rtk 0.2.11 → 0.2.13

package/dist/core/cjs/ActionIcons/Modals/CommonModal.cjs

@@ -25,6 +25,7 @@ function CommonModal({
   buttonText,
   buttonLoading,
   withTitleOptions = true,
+  titleOptions,
   ...props
 }) {
   var _a;
@@ -59,8 +60,9 @@ function CommonModal({
       title: /* @__PURE__ */ jsxRuntime.jsxs(jsxRuntime.Fragment, { children: [
         props.title,
         !fab && withTitleOptions && //* Backward compatibility to fab-react-toolkit
-        /* @__PURE__ */ jsxRuntime.jsx(core.Group, { children: /* @__PURE__ */ jsxRuntime.jsxs(core.Group, { gap: "xs", pr: "xs", children: [
-          /* @__PURE__ */ jsxRuntime.jsx(
+        /* @__PURE__ */ jsxRuntime.jsxs(core.Group, { gap: "xs", pr: "xs", children: [
+          utils.parseFromValuesOrFunc(titleOptions == null ? void 0 : titleOptions.left, { view, setView }),
+          !(titleOptions == null ? void 0 : titleOptions.hideOverlay) && /* @__PURE__ */ jsxRuntime.jsx(
             core.CloseButton,
             {
               onClick: () => setView(view !== constants.VIEW_MODE.OVERLAY ? constants.VIEW_MODE.OVERLAY : constants.VIEW_MODE.NORMAL),
@@ -74,7 +76,7 @@ function CommonModal({
               )
             }
           ),
-          /* @__PURE__ */ jsxRuntime.jsx(
+          !(titleOptions == null ? void 0 : titleOptions.hideFullScreen) && /* @__PURE__ */ jsxRuntime.jsx(
             core.CloseButton,
             {
               onClick: () => setView(view !== constants.VIEW_MODE.FULL_SCREEN ? constants.VIEW_MODE.FULL_SCREEN : constants.VIEW_MODE.NORMAL),
@@ -87,8 +89,9 @@ function CommonModal({
                 }
               )
             }
-          )
-        ] }) })
+          ),
+          utils.parseFromValuesOrFunc(titleOptions == null ? void 0 : titleOptions.right, { view, setView })
+        ] })
       ] }),
       classNames: { content: "mrt-table-container" },
       styles: utils.deepMerge(props.styles, {

package/dist/core/esm/ActionIcons/Modals/CommonModal.mjs

@@ -1,7 +1,7 @@
 import { jsx, jsxs, Fragment } from "react/jsx-runtime";
 import { JsonFormsWithCustomizer } from "fastapi-rtk/.bundled-jsonforms";
 import { VIEW_MODE } from "fastapi-rtk/constants";
-import { deepMerge } from "fastapi-rtk/utils";
+import { deepMerge, parseFromValuesOrFunc } from "fastapi-rtk/utils";
 import { Icon } from "../../../../.external/esm/@iconify_react@6.0.0_react@18.3.1/@iconify/react/dist/iconify.mjs";
 import { Modal, Box, Stack, Group, Button, CloseButton } from "@mantine/core";
 import { useForm, yupResolver } from "@mantine/form";
@@ -23,6 +23,7 @@ function CommonModal({
   buttonText,
   buttonLoading,
   withTitleOptions = true,
+  titleOptions,
   ...props
 }) {
   var _a;
@@ -57,8 +58,9 @@ function CommonModal({
       title: /* @__PURE__ */ jsxs(Fragment, { children: [
         props.title,
         !fab && withTitleOptions && //* Backward compatibility to fab-react-toolkit
-        /* @__PURE__ */ jsx(Group, { children: /* @__PURE__ */ jsxs(Group, { gap: "xs", pr: "xs", children: [
-          /* @__PURE__ */ jsx(
+        /* @__PURE__ */ jsxs(Group, { gap: "xs", pr: "xs", children: [
+          parseFromValuesOrFunc(titleOptions == null ? void 0 : titleOptions.left, { view, setView }),
+          !(titleOptions == null ? void 0 : titleOptions.hideOverlay) && /* @__PURE__ */ jsx(
             CloseButton,
             {
               onClick: () => setView(view !== VIEW_MODE.OVERLAY ? VIEW_MODE.OVERLAY : VIEW_MODE.NORMAL),
@@ -72,7 +74,7 @@ function CommonModal({
               )
             }
           ),
-          /* @__PURE__ */ jsx(
+          !(titleOptions == null ? void 0 : titleOptions.hideFullScreen) && /* @__PURE__ */ jsx(
             CloseButton,
             {
               onClick: () => setView(view !== VIEW_MODE.FULL_SCREEN ? VIEW_MODE.FULL_SCREEN : VIEW_MODE.NORMAL),
@@ -85,8 +87,9 @@ function CommonModal({
                 }
               )
             }
-          )
-        ] }) })
+          ),
+          parseFromValuesOrFunc(titleOptions == null ? void 0 : titleOptions.right, { view, setView })
+        ] })
       ] }),
       classNames: { content: "mrt-table-container" },
       styles: deepMerge(props.styles, {

package/dist/core/lib/ActionIcons/Add/AddDialog.d.ts

@@ -1,4 +1,122 @@
-export function AddDialog({ jsonForms: __jsonForms, ...props }: {
-    [x: string]: any;
-    jsonForms: any;
-}): import("react").JSX.Element;
+/**
+ * @typedef {Object} CommonModalTitleOptionsProps
+ * @property {React.ReactNode | ((props: { view: string; setView: (view: string) => void }) => React.ReactNode)} left - Content or function to render on the left side of the title.
+ * @property {React.ReactNode | ((props: { view: string; setView: (view: string) => void }) => React.ReactNode)} right - Content or function to render on the right side of the title.
+ * @property {boolean} [hideOverlay=false] - If true, hides the overlay toggle button.
+ * @property {boolean} [hideFullScreen=false] - If true, hides the full screen toggle button.
+ */
+/**
+ * @typedef {Object} CommonModalProps
+ * @property {Record<string, any>} fabSchema - Schema for backward compatibility with fab-react-toolkit that includes defaultValues and validation schema.
+ * @property {Record<string, any>} schema - JSON Schema used by JsonFormsWithCustomizer.
+ * @property {Record<string, any>} uischema - UI schema for customizing the form layout.
+ * @property {Record<string, any>} state - State object containing the form data.
+ * @property {Function} setState - Function to update the state containing form data.
+ * @property {string} view - Current view mode (e.g., VIEW_MODE.NORMAL, VIEW_MODE.FULL_SCREEN, VIEW_MODE.OVERLAY).
+ * @property {Function} setView - Function to update the view mode.
+ * @property {Record<string, any>} jsonForms - Customizer configuration or additional properties for JsonFormsWithCustomizer.
+ * @property {Function} onSubmit - Callback function triggered on form submission.
+ * @property {Record<string, any>} boxProps - Additional properties to be passed to the Box component wrapping the form.
+ * @property {string} buttonText - Text displayed on the submit button.
+ * @property {boolean} buttonLoading - Indicates whether the submit button should display a loading state.
+ * @property {boolean} [withTitleOptions=true] - Flag to determine if title options (e.g., full screen, overlay toggles) should be displayed.
+ * @property {CommonModalTitleOptionsProps} [titleOptions] - Options for customizing the title area, such as toggles for full screen and overlay modes.
+ * @property {Record<string, any>} rest - Additional props to be passed to the Modal component.
+ */
+/**
+ * AddDialog is a component that renders a modal dialog for adding a new entry.
+ *
+ * It integrates with the application's API to add entries and manages form state,
+ * view modes, and loading state via custom hooks. The component also manages the merge
+ * of default JSON Forms settings with any additional props provided.
+ *
+ * @param {CommonModalProps} props - The properties passed to the AddDialog component.
+ * @returns {JSX.Element} The rendered modal dialog component for adding an entry.
+ */
+export function AddDialog({ jsonForms: __jsonForms, ...props }: CommonModalProps): JSX.Element;
+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;
+};
+export type CommonModalProps = {
+    /**
+     * - Schema for backward compatibility with fab-react-toolkit that includes defaultValues and validation schema.
+     */
+    fabSchema: Record<string, any>;
+    /**
+     * - JSON Schema used by JsonFormsWithCustomizer.
+     */
+    schema: Record<string, any>;
+    /**
+     * - UI schema for customizing the form layout.
+     */
+    uischema: Record<string, any>;
+    /**
+     * - State object containing the form data.
+     */
+    state: Record<string, any>;
+    /**
+     * - Function to update the state containing form data.
+     */
+    setState: Function;
+    /**
+     * - 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;
+    /**
+     * - Customizer configuration or additional properties for JsonFormsWithCustomizer.
+     */
+    jsonForms: Record<string, any>;
+    /**
+     * - 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 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;
+    /**
+     * - Options for customizing the title area, such as toggles for full screen and overlay modes.
+     */
+    titleOptions?: CommonModalTitleOptionsProps;
+    /**
+     * - Additional props to be passed to the Modal component.
+     */
+    rest: Record<string, any>;
+};

package/dist/core/lib/ActionIcons/Edit/EditDialog.d.ts

@@ -1,4 +1,124 @@
-export function EditDialog({ jsonForms: __jsonForms, ...props }: {
-    [x: string]: any;
-    jsonForms: any;
-}): import("react").JSX.Element;
+/**
+ * @typedef {Object} CommonModalTitleOptionsProps
+ * @property {React.ReactNode | ((props: { view: string; setView: (view: string) => void }) => React.ReactNode)} left - Content or function to render on the left side of the title.
+ * @property {React.ReactNode | ((props: { view: string; setView: (view: string) => void }) => React.ReactNode)} right - Content or function to render on the right side of the title.
+ * @property {boolean} [hideOverlay=false] - If true, hides the overlay toggle button.
+ * @property {boolean} [hideFullScreen=false] - If true, hides the full screen toggle button.
+ */
+/**
+ * @typedef {Object} CommonModalProps
+ * @property {Record<string, any>} fabSchema - Schema for backward compatibility with fab-react-toolkit that includes defaultValues and validation schema.
+ * @property {Record<string, any>} schema - JSON Schema used by JsonFormsWithCustomizer.
+ * @property {Record<string, any>} uischema - UI schema for customizing the form layout.
+ * @property {Record<string, any>} state - State object containing the form data.
+ * @property {Function} setState - Function to update the state containing form data.
+ * @property {string} view - Current view mode (e.g., VIEW_MODE.NORMAL, VIEW_MODE.FULL_SCREEN, VIEW_MODE.OVERLAY).
+ * @property {Function} setView - Function to update the view mode.
+ * @property {Record<string, any>} jsonForms - Customizer configuration or additional properties for JsonFormsWithCustomizer.
+ * @property {Function} onSubmit - Callback function triggered on form submission.
+ * @property {Record<string, any>} boxProps - Additional properties to be passed to the Box component wrapping the form.
+ * @property {string} buttonText - Text displayed on the submit button.
+ * @property {boolean} buttonLoading - Indicates whether the submit button should display a loading state.
+ * @property {boolean} [withTitleOptions=true] - Flag to determine if title options (e.g., full screen, overlay toggles) should be displayed.
+ * @property {CommonModalTitleOptionsProps} [titleOptions] - Options for customizing the title area, such as toggles for full screen and overlay modes.
+ * @property {Record<string, any>} rest - Additional props to be passed to the Modal component.
+ */
+/**
+ * EditDialog component renders a modal dialog for editing an entry.
+ *
+ * This component leverages various hooks to manage form state, API interactions, and UI transitions.
+ * It initializes the form state based on the provided item's result and handles form submission by
+ * sending only changed data to update the corresponding entry. Upon a successful update, it triggers
+ * a refetch of data and related information.
+ *
+ * @component
+ * @param {CommonModalProps} props - The component props.
+ * @returns {JSX.Element} The rendered EditDialog component.
+ */
+export function EditDialog({ jsonForms: __jsonForms, ...props }: CommonModalProps): JSX.Element;
+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;
+};
+export type CommonModalProps = {
+    /**
+     * - Schema for backward compatibility with fab-react-toolkit that includes defaultValues and validation schema.
+     */
+    fabSchema: Record<string, any>;
+    /**
+     * - JSON Schema used by JsonFormsWithCustomizer.
+     */
+    schema: Record<string, any>;
+    /**
+     * - UI schema for customizing the form layout.
+     */
+    uischema: Record<string, any>;
+    /**
+     * - State object containing the form data.
+     */
+    state: Record<string, any>;
+    /**
+     * - Function to update the state containing form data.
+     */
+    setState: Function;
+    /**
+     * - 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;
+    /**
+     * - Customizer configuration or additional properties for JsonFormsWithCustomizer.
+     */
+    jsonForms: Record<string, any>;
+    /**
+     * - 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 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;
+    /**
+     * - Options for customizing the title area, such as toggles for full screen and overlay modes.
+     */
+    titleOptions?: CommonModalTitleOptionsProps;
+    /**
+     * - Additional props to be passed to the Modal component.
+     */
+    rest: Record<string, any>;
+};

package/dist/core/lib/ActionIcons/Modals/CommonModal.d.ts

@@ -1,38 +1,122 @@
+import { Modal } from '@mantine/core';
+/**
+ * @typedef {Object} CommonModalTitleOptionsProps
+ * @property {React.ReactNode | ((props: { view: string; setView: (view: string) => void }) => React.ReactNode)} left - Content or function to render on the left side of the title.
+ * @property {React.ReactNode | ((props: { view: string; setView: (view: string) => void }) => React.ReactNode)} right - Content or function to render on the right side of the title.
+ * @property {boolean} [hideOverlay=false] - If true, hides the overlay toggle button.
+ * @property {boolean} [hideFullScreen=false] - If true, hides the full screen toggle button.
+ */
+/**
+ * @typedef {Object} CommonModalProps
+ * @property {Record<string, any>} fabSchema - Schema for backward compatibility with fab-react-toolkit that includes defaultValues and validation schema.
+ * @property {Record<string, any>} schema - JSON Schema used by JsonFormsWithCustomizer.
+ * @property {Record<string, any>} uischema - UI schema for customizing the form layout.
+ * @property {Record<string, any>} state - State object containing the form data.
+ * @property {Function} setState - Function to update the state containing form data.
+ * @property {string} view - Current view mode (e.g., VIEW_MODE.NORMAL, VIEW_MODE.FULL_SCREEN, VIEW_MODE.OVERLAY).
+ * @property {Function} setView - Function to update the view mode.
+ * @property {Record<string, any>} jsonForms - Customizer configuration or additional properties for JsonFormsWithCustomizer.
+ * @property {Function} onSubmit - Callback function triggered on form submission.
+ * @property {Record<string, any>} boxProps - Additional properties to be passed to the Box component wrapping the form.
+ * @property {string} buttonText - Text displayed on the submit button.
+ * @property {boolean} buttonLoading - Indicates whether the submit button should display a loading state.
+ * @property {boolean} [withTitleOptions=true] - Flag to determine if title options (e.g., full screen, overlay toggles) should be displayed.
+ * @property {CommonModalTitleOptionsProps} [titleOptions] - Options for customizing the title area, such as toggles for full screen and overlay modes.
+ * @property {Record<string, any>} rest - Additional props to be passed to the Modal component.
+ * @typedef {CommonModalProps & React.ComponentProps<typeof Modal>} CommonModalComponentProps
+ */
 /**
  * CommonModal component renders a modal with a form.
  *
  * @component
- * @param {Object} props - The component props.
- * @param {Record<string, any>} props.fabSchema - Schema for backward compatibility with fab-react-toolkit that includes defaultValues and validation schema.
- * @param {Record<string, any>} props.schema - JSON Schema used by JsonFormsWithCustomizer.
- * @param {Record<string, any>} props.uischema - UI schema for customizing the form layout.
- * @param {Record<string, any>} props.state - State object containing the form data.
- * @param {Function} props.setState - Function to update the state containing form data.
- * @param {string} props.view - Current view mode (e.g., VIEW_MODE.NORMAL, VIEW_MODE.FULL_SCREEN, VIEW_MODE.OVERLAY).
- * @param {Function} props.setView - Function to update the view mode.
- * @param {Record<string, any>} props.jsonForms - Customizer configuration or additional properties for JsonFormsWithCustomizer.
- * @param {Function} props.onSubmit - Callback function triggered on form submission.
- * @param {Record<string, any>} props.boxProps - Additional properties to be passed to the Box component wrapping the form.
- * @param {string} props.buttonText - Text displayed on the submit button.
- * @param {boolean} props.buttonLoading - Indicates whether the submit button should display a loading state.
- * @param {boolean} [props.withTitleOptions=true] - Flag to determine if title options (e.g., full screen, overlay toggles) should be displayed.
- * @param {Record<string, any>} props.rest - Additional props to be passed to the Modal component.
- *
+ * @param {CommonModalComponentProps} props - The properties for the CommonModal component.
  * @returns - A rendered Modal component with an embedded form and optional title controls.
  */
-export function CommonModal({ fabSchema, schema, uischema, state, setState, view, setView, jsonForms, onSubmit, boxProps, buttonText, buttonLoading, withTitleOptions, ...props }: {
+export function CommonModal({ fabSchema, schema, uischema, state, setState, view, setView, jsonForms, onSubmit, boxProps, buttonText, buttonLoading, withTitleOptions, titleOptions, ...props }: CommonModalComponentProps): import("react").JSX.Element;
+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;
+};
+export type CommonModalProps = {
+    /**
+     * - Schema for backward compatibility with fab-react-toolkit that includes defaultValues and validation schema.
+     */
     fabSchema: Record<string, any>;
+    /**
+     * - JSON Schema used by JsonFormsWithCustomizer.
+     */
     schema: Record<string, any>;
+    /**
+     * - UI schema for customizing the form layout.
+     */
     uischema: Record<string, any>;
+    /**
+     * - State object containing the form data.
+     */
     state: Record<string, any>;
+    /**
+     * - Function to update the state containing form data.
+     */
     setState: Function;
+    /**
+     * - 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;
+    /**
+     * - Customizer configuration or additional properties for JsonFormsWithCustomizer.
+     */
     jsonForms: Record<string, any>;
+    /**
+     * - 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 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;
+    /**
+     * - Options for customizing the title area, such as toggles for full screen and overlay modes.
+     */
+    titleOptions?: CommonModalTitleOptionsProps;
+    /**
+     * - Additional props to be passed to the Modal component.
+     */
     rest: Record<string, any>;
-}): import("react").JSX.Element;
+};
+export type CommonModalComponentProps = CommonModalProps & React.ComponentProps<typeof Modal>;

package/package.json

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