@acvl/frontend-components 0.0.47 → 0.0.49

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as _mui_material from '@mui/material';
-import { ButtonProps, ButtonGroupProps, IconButtonProps, MenuItemProps, AlertProps, BoxProps, AutocompleteProps, SliderProps, SwitchProps, GridProps, DrawerProps, MenuProps, PaletteColorOptions } from '@mui/material';
+import { ButtonProps, ButtonGroupProps, IconButtonProps, MenuItemProps, AlertProps, BoxProps, AutocompleteProps, SliderProps, SwitchProps, GridProps, DrawerProps, MenuProps, PaletteColorOptions, TextFieldProps as TextFieldProps$1, InputBaseProps } from '@mui/material';
 import * as React from 'react';
-import React__default, { ReactNode, Dispatch, SetStateAction, JSX, RefObject } from 'react';
+import React__default, { ReactNode, Dispatch, SetStateAction, JSX, RefObject, JSXElementConstructor, ElementType } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { GridRowId, GridRowSelectionModel, GridSortModel, GridFilterModel, GridRowModesModel, GridRenderEditCellParams, GridToolbarProps, DataGridProps as DataGridProps$1 } from '@mui/x-data-grid';
 import { DataGridProps, GridBaseColDef } from '@mui/x-data-grid/internals';
@@ -16,6 +16,9 @@ import * as redux from 'redux';
 import * as _reduxjs_toolkit from '@reduxjs/toolkit';
 import * as _emotion_styled from '@emotion/styled';
 import * as _mui_system from '@mui/system';
+import { Breadcrumb, PageHeaderProps, Navigation, Branding, Session, Authentication, DashboardHeaderProps } from '@toolpad/core';
+import { SidebarFooterProps } from '@toolpad/core/DashboardLayout';
+import { Theme } from '@mui/material/styles';
 import { UseFormReturn } from 'react-hook-form';
 
 interface NormalOrIconProps {
@@ -343,6 +346,8 @@ interface ExportCSVButtonProps extends Pick<ExportButtonProps, "filterModel" | "
 }
 declare const ExportCSV: React__default.FC<ExportCSVButtonProps>;
 
+declare const CustomNoRows: () => react_jsx_runtime.JSX.Element;
+
 interface ExtraActions {
     label: string;
     onClick: (rowSelectionModel: GridRowSelectionModel) => void;
@@ -778,7 +783,7 @@ declare const NotAllowed: () => react_jsx_runtime.JSX.Element;
 **/
 declare const NotFound: () => react_jsx_runtime.JSX.Element;
 
-declare function ContentLayout({ children, button, badge }: {
+declare function ContentLayout({ children, button, badge, }: {
     children: ReactNode;
     button: ReactNode;
     badge?: ReactNode;
@@ -926,12 +931,107 @@ declare module '@mui/material/styles' {
 }
 declare const theme: () => _mui_material.Theme;
 
+/**
+ * Forma JSON que se guarda en el formulario / se envía al backend.
+ * Para direcciones escritas a mano solo viene `formatted_address`.
+ */
+interface AddressValue {
+    formatted_address: string;
+    place_id?: string | null;
+    lat?: number | null;
+    lng?: number | null;
+    street_number?: string;
+    route?: string | null;
+    neighborhood?: string | null;
+    locality?: string | null;
+    administrative_area_level_1?: string | null;
+    postal_code?: string | null;
+    country?: string | null;
+    country_code?: string | null;
+}
+interface ControlledAddressAutocompleteProps {
+    name: string;
+    label?: string;
+    control: any;
+    fieldProps?: TextFieldProps$1;
+    extraProps?: {
+        /**
+         * API key de Google Maps. Si no se pasa, se intenta leer
+         * `VITE_GOOGLE_MAPS_API_KEY` de `import.meta.env`.
+         */
+        apiKey?: string;
+        /** Restringe los resultados a estos países, p.ej. ["mx", "us"]. */
+        countries?: string[];
+        /** Idioma de los resultados, p.ej. "es". */
+        language?: string;
+        /**
+         * Callback opcional con el `Place` resuelto (con addressComponents,
+         * location, etc.) por si la pantalla necesita autollenar otros campos.
+         */
+        onResolved?: (place: any) => void;
+    };
+}
+declare const ControlledAddressAutocomplete: {
+    ({ name, label, control, fieldProps, extraProps, }: ControlledAddressAutocompleteProps): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+
+/** Opción de un desplegable: `{ value, label }`. */
+interface Opciones {
+    value: string;
+    label: string;
+}
+interface ControlledAmountWithCurrencyProps {
+    /** Ruta del monto en el formulario, p.ej. "valores_de_factura.subtotal". */
+    name: string;
+    /** Control de react-hook-form (lo inyecta el `EditField` de la página). */
+    control?: any;
+    fieldProps?: Partial<NumericFormatProps<InputBaseProps>>;
+    extraProps?: {
+        /**
+         * Ruta de la moneda en el formulario. Por defecto `${name}_moneda`,
+         * de modo que "valores_de_factura.subtotal" usa
+         * "valores_de_factura.subtotal_moneda".
+         */
+        currencyName?: string;
+        /** Origen de las opciones de moneda (endpoint `como_opciones`). */
+        queryArgs?: ComoOpcionesProps;
+        /** Opciones estáticas de moneda (alternativa a `queryArgs`). */
+        options?: Opciones[];
+    };
+}
+/**
+ * Campo compuesto de monto + moneda que se muestra como una sola fila con
+ * borde: importe alineado a la derecha y un selector de moneda compacto al
+ * final.
+ *
+ * Está pensado para usarse como `type` de un campo de una página de detalle.
+ * La etiqueta la aporta el `Field` contenedor (no el propio campo):
+ *
+ * ```ts
+ * {
+ *     name: "valores_de_factura.subtotal",
+ *     label: "Subtotal",
+ *     type: ControlledAmountWithCurrency,
+ *     gridProps: { size: 12 },
+ * }
+ * ```
+ */
+declare const ControlledAmountWithCurrency: {
+    ({ name, control, fieldProps, extraProps, }: ControlledAmountWithCurrencyProps): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+
 interface FieldProps {
     pageType?: PageType;
     fieldData?: any;
+    /** Registro completo de la página; permite a los campos leer valores hermanos. */
+    data?: any;
     name: string;
     detail_name?: string;
     label: string;
+    /** Ubicación de la etiqueta respecto al campo. Por defecto `"top"`. */
+    labelPosition?: "top" | "left";
     type: any;
     gridProps?: GridProps;
     fieldProps?: object;
@@ -956,6 +1056,9 @@ interface SubsectionProps {
     title?: string;
     description?: string;
     first?: boolean;
+    slotProps?: {
+        parentGrid?: Partial<GridProps>;
+    };
     fields?: FieldProps[];
     arrayFields?: ArrayFieldProps[];
     content?: (data: any) => ReactNode;
@@ -1022,6 +1125,103 @@ interface DetailPageV2Props {
 }
 declare function DetailPage(props: DetailPageV2Props): react_jsx_runtime.JSX.Element;
 
+/**
+ * Encabezado por defecto del `PageContainer`: resuelve título y breadcrumbs a
+ * partir de `useActivePage`, con soporte para páginas "sueltas" (rutas que ya no
+ * viven en la navegación pero cuyo crear/editar/detalle sigue existiendo).
+ *
+ * El título se lee de `state.header.title` (slice `headerReducer` de la librería)
+ * cuando hay un id en la ruta; de lo contrario se deriva del título de la página.
+ **/
+/**
+ * Página sin entrada en la navegación de Toolpad. Como `useActivePage` no la
+ * resuelve, el proyecto puede declarar aquí su título y breadcrumbs.
+ **/
+interface DetachedPage {
+    title: string;
+    path: string;
+    breadcrumbs: Breadcrumb[];
+}
+interface MainLayoutPageHeaderProps extends PageHeaderProps {
+    fullScreen?: boolean;
+    detachedPages?: DetachedPage[];
+    documentTitleSuffix?: string;
+}
+
+/**
+ * Cascarón de la aplicación construido sobre Toolpad: barra superior, menú de
+ * navegación, alertas, tema y el `PageContainer` que renderiza el `Outlet`.
+ *
+ * Todo lo específico del proyecto (navegación, branding, sesión, autenticación,
+ * páginas sueltas, slots del header) se recibe por props. Reutiliza la
+ * infraestructura de la librería: `theme`, `ObjectProgressStack` y el slice
+ * `header` (leído por el `PageHeader` por defecto).
+ *
+ * Atajo Shift+F: alterna pantalla completa (oculta navegación y encabezados).
+ **/
+interface MainLayoutProps {
+    /** Definición de navegación de Toolpad (items del sidebar). */
+    navigation: Navigation;
+    /** Branding de Toolpad (logo, título, homeUrl). */
+    branding?: Branding | null;
+    /** Sesión activa; se pasa tal cual al `AppProvider`. */
+    session?: Session | null;
+    /** Handlers de inicio/cierre de sesión. */
+    authentication?: Authentication;
+    /** Tema MUI ya construido. Por defecto el tema de la librería. */
+    theme?: Theme;
+    /** Páginas fuera de la navegación cuyo título/breadcrumbs debe resolver el `PageHeader`. */
+    detachedPages?: DetachedPage[];
+    /** Sufijo del `document.title` (ej. "Embarques" => "Título | Embarques"). */
+    documentTitleSuffix?: string;
+    /** Configuración del pie del sidebar por defecto. */
+    footer?: {
+        version?: string;
+        copyright?: string;
+    };
+    /** Ancho del sidebar expandido. */
+    sidebarExpandedWidth?: number;
+    /**
+     * Color de fondo del área de contenido. Se aplica al scroll container
+     * (`<main>`) para que cubra toda la altura scrolleable y no se corte cuando
+     * la página es más larga que el viewport.
+     */
+    pageBackgroundColor?: string;
+    /** Overrides de slots del layout. */
+    slots?: {
+        /** Barra superior del dashboard. Por defecto la de Toolpad. */
+        header?: JSXElementConstructor<DashboardHeaderProps>;
+        /** Pie del sidebar. Por defecto muestra versión y copyright. */
+        sidebarFooter?: ElementType<SidebarFooterProps>;
+        /** Encabezado de página. Por defecto resuelve título/breadcrumbs. */
+        pageHeader?: ElementType;
+        /** Contenido de cada snack de progreso. Por defecto una barra de progreso. */
+        progressStatus?: (data: any) => ReactNode;
+    };
+    /** Contenido a renderizar; por defecto el `<Outlet />` del router. */
+    children?: ReactNode;
+}
+declare const MainLayout: (props: MainLayoutProps) => react_jsx_runtime.JSX.Element;
+
+/**
+ * Pie por defecto del sidebar: versión del sistema y aviso de copyright.
+ * La versión y el texto de copyright se reciben por props porque dependen
+ * del proyecto que consume el layout (no se leen de `import.meta.env` aquí).
+ **/
+interface MainLayoutSidebarFooterProps extends SidebarFooterProps {
+    version?: string;
+    copyright?: string;
+}
+
+/**
+ * Contenido por defecto de cada snack dentro de `ObjectProgressStack`.
+ * Muestra una barra de progreso (determinada si `progress` viene definido,
+ * indeterminada en caso contrario) y el porcentaje.
+ **/
+interface ProgressStatusProps {
+    progress?: number;
+}
+
 interface MutationHandlerOptions {
     mutationFn: (data: any) => {
         unwrap: () => Promise<any>;
@@ -1043,5 +1243,5 @@ declare const useMutationHandler: ({ mutationFn, form, onSuccess, onValidationEr
     }) => void;
 };
 
-export { APIContext, APIProvider, ActiveCell, ActiveIcon, Base, ButtonWithDrawer, CSVUpload, ContentLayout, ControlledDate, ControlledDropdown, ControlledFileField, FileUploadBox as ControlledFileUploadBox, ControlledNumber, ControlledPhoneNumber, ControlledSelect, ControlledSlider as ControlledSimpleSlider, ControlledSlider$1 as ControlledSlider, ControlledSwitch, ControlledText, ControlledTimePicker, ControlledToggleButtons, CoverPage, CreateButtonBase, CreateButtonWithMenuOptions, CrudDropdown, DeleteButton, DeleteConfirmationDialog, DetailPage$1 as DetailPage, DetailPage as DetailPage_v2, EditButton, ExportCSV, ExtraButtons, HistorialDrawer, ListPage, Loadable, LoadingComponent, Logo, MainDrawer, MenuItemWithLoading, ModuleCard, MoreOptions, MyGridEditSingleSelect, NavigationContext, NavigationProvider, NormalOrIcon, NotAllowed, NotFound, ObjectProgressStack, SaveCancelButton, StatusBadge, StyledMenu, Tabs, Transitions, UncontrolledText, changeTitle, closeProgressSnack, deleteColumn, editColumn, filterQuery, formParser, _default as headerReducer, manualCacheRefresh, mergeSettings, openProgressSnack, query, renderEditCellWithErrorTooltip, setErrors, _default$1 as snackProgressReducer, tags, theme, updateProgressSnackData, useAPI, useHasPermission, useMutationHandler, useNavigation, valueLabel };
-export type { APIcontextProps, ComoOpcionesProps, CustomToolbarProps, DeleteGridColumnsProps, EditGridColumnsProps, EditReadOnlyFields, FieldFilter, FieldProps$1 as FieldProps, FieldValidationProps, GridArgs, GridColDefPropsOverrides, JSONFormProps, JSONParserProps, MyDataGridProps, MyGridFilterModel, MyTab, MyTabProps, PageType };
+export { APIContext, APIProvider, ActiveCell, ActiveIcon, Base, ButtonWithDrawer, CSVUpload, ContentLayout, ControlledAddressAutocomplete, ControlledAmountWithCurrency, ControlledDate, ControlledDropdown, ControlledFileField, FileUploadBox as ControlledFileUploadBox, ControlledNumber, ControlledPhoneNumber, ControlledSelect, ControlledSlider as ControlledSimpleSlider, ControlledSlider$1 as ControlledSlider, ControlledSwitch, ControlledText, ControlledTimePicker, ControlledToggleButtons, CoverPage, CreateButtonBase, CreateButtonWithMenuOptions, CrudDropdown, CustomNoRows, DeleteButton, DeleteConfirmationDialog, DetailPage$1 as DetailPage, DetailPage as DetailPage_v2, EditButton, ExportCSV, ExtraButtons, HistorialDrawer, ListPage, Loadable, LoadingComponent, Logo, MainDrawer, MainLayout, MenuItemWithLoading, ModuleCard, MoreOptions, MyGridEditSingleSelect, NavigationContext, NavigationProvider, NormalOrIcon, NotAllowed, NotFound, ObjectProgressStack, SaveCancelButton, StatusBadge, StyledMenu, Tabs, Transitions, UncontrolledText, changeTitle, closeProgressSnack, deleteColumn, editColumn, filterQuery, formParser, _default as headerReducer, manualCacheRefresh, mergeSettings, openProgressSnack, query, renderEditCellWithErrorTooltip, setErrors, _default$1 as snackProgressReducer, tags, theme, updateProgressSnackData, useAPI, useHasPermission, useMutationHandler, useNavigation, valueLabel };
+export type { APIcontextProps, AddressValue, ComoOpcionesProps, CustomToolbarProps, DeleteGridColumnsProps, DetachedPage, EditGridColumnsProps, EditReadOnlyFields, FieldFilter, FieldProps$1 as FieldProps, FieldValidationProps, GridArgs, GridColDefPropsOverrides, JSONFormProps, JSONParserProps, MainLayoutPageHeaderProps, MainLayoutProps, MainLayoutSidebarFooterProps, MyDataGridProps, MyGridFilterModel, MyTab, MyTabProps, PageType, ProgressStatusProps };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@acvl/frontend-components",
-    "version": "0.0.47",
+    "version": "0.0.49",
     "description": "Component library for ACV frontend projects.",
     "homepage": "https://github.com/ACV-Logistics/acv-frontend-components#readme",
     "access": "public",