@acvl/frontend-components 0.0.106 → 0.0.107

package/dist/index.d.ts

@@ -4488,6 +4488,108 @@ interface DetailFormDialogProps {
  */
 declare function DetailFormDialog({ open, onClose, title, api, form, sections, pageType, permissionsPath, onSuccess, responsiveTo, containerBreakpoints, storageScope, historial, labels, slots, slotProps, }: DetailFormDialogProps): react_jsx_runtime.JSX.Element;
 
+/**
+ * La lógica del botón de volver de `PaginaLegal`, aparte del componente para poder probarla sin
+ * montar un router.
+ *
+ * Las páginas legales son públicas —son la URL que piden Google Play y App Store— pero también se
+ * abren con la sesión iniciada (el pie del menú). Por eso volver regresa a la página anterior si
+ * hay historial y, si se llegó directo por la URL, va al login o al inicio según haya sesión.
+ **/
+/** Las etiquetas del botón de volver: el corto va arriba, junto al logo; el largo, al pie. */
+interface TextosDePaginaLegal {
+    /** Botón de arriba con la sesión iniciada. */
+    cortoConSesion: string;
+    /** Botón de arriba sin sesión: lleva al login. */
+    cortoSinSesion: string;
+    /** Botón del pie con la sesión iniciada. */
+    largoConSesion: string;
+    /** Botón del pie sin sesión: lleva al login. */
+    largoSinSesion: string;
+}
+/** A dónde va volver cuando no hay historial. */
+interface RutasDePaginaLegal {
+    /** Con sesión. */
+    inicio: string;
+    /** Sin sesión. */
+    login: string;
+}
+
+/**
+ * El cascarón de los documentos públicos de una app (aviso de privacidad, términos de uso): logo,
+ * botón de volver, el documento y, al pie, el enlace al documento gemelo y otro botón de volver.
+ * Cada página sólo pone su contenido, armado con los bloques de `./bloques`.
+ *
+ * El botón de volver regresa a la página anterior si hay historial y, si se llegó directo por la
+ * URL, va al inicio o al login según haya sesión (ver `./volver`). La sesión la dice la app con
+ * `autenticado`: la librería no conoce su store.
+ *
+ * Lo que cambia de una app a otra entra por props: las etiquetas (`textos`, p. ej. en inglés), las
+ * rutas de inicio y login (`rutas`) y lo que va junto al botón de arriba (`acciones`, p. ej. un
+ * selector de idioma).
+ **/
+interface PaginaLegalProps {
+    children: ReactNode;
+    /** Si hay sesión iniciada. Decide a dónde va volver sin historial y qué dice el botón. */
+    autenticado: boolean;
+    /** El documento gemelo, enlazado al pie (de la privacidad a los términos, y al revés). */
+    gemelo: {
+        to: string;
+        texto: string;
+    };
+    /** Las etiquetas del botón de volver. Lo que no se pase queda en español. */
+    textos?: Partial<TextosDePaginaLegal>;
+    /** A dónde va volver sin historial. Por omisión, `/` con sesión y `/login` sin ella. */
+    rutas?: Partial<RutasDePaginaLegal>;
+    /** Lo que se pinta junto al botón de volver de arriba, a su izquierda. */
+    acciones?: ReactNode;
+}
+declare const PaginaLegal: ({ children, autenticado, gemelo, textos, rutas, acciones, }: PaginaLegalProps) => react_jsx_runtime.JSX.Element;
+
+/**
+ * Las piezas de presentación con las que se escribe el contenido de una `PaginaLegal`:
+ *
+ * ```tsx
+ * <Documento>
+ *     <Titulo>Aviso de Privacidad</Titulo>
+ *     <Dato>Última actualización: …</Dato>
+ *     <Divider sx={{ my: 3 }} />
+ *     <Seccion title="1. Responsable">
+ *         <Parrafo>…</Parrafo>
+ *         <Subtitulo>a) Datos de identidad</Subtitulo>
+ *         <Lista><li>…</li></Lista>
+ *     </Seccion>
+ * </Documento>
+ * ```
+ *
+ * Todo el texto va en `text.secondary` salvo los encabezados, y las listas toman el mismo color
+ * para que sus viñetas no destaquen sobre el párrafo.
+ **/
+interface ConHijos {
+    children: ReactNode;
+}
+/** El papel que enmarca el documento entero. */
+declare const Documento: ({ children }: ConHijos) => react_jsx_runtime.JSX.Element;
+/** El título del documento: el único `h1` de la página. */
+declare const Titulo: ({ children }: ConHijos) => react_jsx_runtime.JSX.Element;
+/** Un renglón de datos bajo el título: la fecha de actualización, la app, el titular. */
+declare const Dato: ({ children }: ConHijos) => react_jsx_runtime.JSX.Element;
+interface SeccionProps extends ConHijos {
+    /** El encabezado de la sección (`h2`), con su número si el documento los lleva. */
+    title: string;
+}
+/** Una sección numerada del documento; sus hijos van apilados. */
+declare const Seccion: ({ title, children }: SeccionProps) => react_jsx_runtime.JSX.Element;
+/** Un encabezado dentro de una sección: «a) Datos de identidad», «8.1 México». */
+declare const Subtitulo: ({ children }: ConHijos) => react_jsx_runtime.JSX.Element;
+declare const Parrafo: ({ children }: ConHijos) => react_jsx_runtime.JSX.Element;
+interface ListaProps extends ConHijos {
+    /** `ol` en vez de `ul`, con el mismo aspecto. */
+    numerada?: boolean;
+}
+/** Una lista de `<li>`. */
+declare const Lista: ({ children, numerada }: ListaProps) => 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
@@ -5241,5 +5343,5 @@ declare const mutationParams: (arg: any) => {
  */
 declare const mutationId: (arg: any) => any;
 
-export { APIContext, APIProvider, AccountMenuContent, ActiveCell, ActiveIcon, Base, ButtonWithDrawer, COLOR_SCHEME_SELECTOR, CSVUpload, CatalogoItem, CatalogoList, ChipCell, ConfirmDialog, ContentBorderRadiusContext, ContentLayout, ControlledAddressAutocomplete, ControlledAmountWithCurrency, ControlledAutocomplete, ControlledColor, ControlledDate$1 as ControlledDate, ControlledDate as ControlledDate_v2, ControlledDropdown, ControlledFileField$1 as ControlledFileField, ControlledFileField as ControlledFileField_v2, FileUploadBox as ControlledFileUploadBox, ControlledNumber, ControlledPhoneNumber, ControlledSelect$1 as ControlledSelect, ControlledSelect as ControlledSelect_v2, ControlledSlider as ControlledSimpleSlider, ControlledSlider$1 as ControlledSlider, ControlledSwitch, ControlledText, ControlledTimePicker, ControlledToggleButtons, CoverPage, CreateButtonBase, CreateButtonWithMenuOptions, CrudDropdown, CustomNoRows, DEFAULT_CONTENT_BORDER_RADIUS, DEFAULT_FORM_BREAKPOINTS, DEFAULT_PAGINATION, DRAWER_Z_INDEX, DeleteButton, DeleteConfirmationDialog, DetailFormDialog as DetailFormDialog_v2, DetailFormDrawer as DetailFormDrawer_v2, DetailForm as DetailForm_v2, DetailPage$1 as DetailPage, DetailPage as DetailPage_v2, DrawerGrid as DrawerGrid_v2, EditButton, ExportCSV$1 as ExportCSV, ExportCSV as ExportCSV_v2, ExtraButtons, FILTERS_DRAWER_GAP, FORM_CONTAINER_NAME, GlobalSearch, GrillaHastaElFondo, HEADER_CONTAINER, HEADER_NARROW, HiddenPageHeaderContext, HistorialDrawer, KpiCard, LAYER_ORDER, ListPage, Loadable, LoadingComponent, LocaleContext, LocaleProvider, Logo, MainDrawer, MainDrawer$1 as MainDrawer_v2, MainLayout, MenuItemWithLoading, ModuleCard, MoreOptions, MyGridEditSingleSelect, NavigationContext, NavigationProvider, NormalOrIcon, NotAllowed, NotFound, NotificationItem, NotificationsBell, ObjectProgressStack, OverModalContext, OverModalProvider, PageActionsHostContext, PageBadgeHostContext, PageInfo, PageInfoHostContext, Panel, PollingCountdownChip, PulseDot, RESPONSIVE_ACTION_MODES, ResponsiveActions, SIDE_PANEL_WIDTH_VAR, SaveCancelButton, ServerGrid as ServerGrid_v2, SidePanelHostContext, StatusBadge, StickyPageHeaderContext, StyledMenu, StyledToggleButtonGroup, TEXTOS, Tabs, Transitions, TrueFalse, UncontrolledText, aplicarLocaleDeDayjs, buildEstadoTabs, changeTitle, closeProgressSnack, columnasDeCatalogo, composeGridProps, crearFabricaDeCatalogos, deleteColumn$1 as deleteColumn, deleteColumn as deleteColumn_v2, drawerZIndex, editColumn, filterQuery, filtersPanelFrameSx, formContainerSx, formGridSx, formParser, headerContainerSx, _default as headerReducer, localeDeNumeros, localeTextDeMUI, localeTextDeToolpad, manualCacheRefresh, mergeSettings, mutationData, mutationId, mutationParams, openProgressSnack, pageSizeOptions, query, renderChipCell, renderEditCellWithErrorTooltip, resolveChipOption, resolveInitialState, resolveStatusColor, setErrors, singularizarPalabra, singularizarTitulo, _default$1 as snackProgressReducer, statusColors, tags, theme, togglableFields, updateProgressSnackData, useAPI, useColorMode, useContentBorderRadius, useDetailForm, useHasPermission, useHasPermission_v2, useHiddenPageHeader, useHiddenPageHeaderHost, useKeyboardShortcut, useLocale, useMutationHandler, useNavigation, useOverModal, usePageActionsHost, usePageBadgeHost, usePageInfoHost, useServerGrid, useSidePanelHost, useStickyPageHeader, useStickyPageHeaderHost, useTextos, valueLabel };
-export type { APIcontextProps, AccountMenuContentProps, AccountMenuItem, AddressValue, AppTheme, AutocompleteOption, BuildEstadoTabsOptions, CSVMenuOptionProps, CatalogoAPI, CatalogoItemProps, CatalogoListProps, ChipCellProps, ChipColor, ChipOption, ColorMode, ComoOpcionesProps, ConfirmDialogProps, ControlledAutocompleteProps, ControlledInput, CrearCatalogoAPI, CustomFilterDef, CustomToolbarProps, DefinicionDeCatalogo, DeleteGridColumnsProps$1 as DeleteGridColumnsProps, DetachedPage, DetailExtraButton, DetailFormApi, DetailFormConfig, DetailFormController, DetailFormDialogProps, DetailFormDrawerNavigation, DetailFormDrawerProps, DetailFormProps, DetailFormStatus, DetailPageV2Props, DetailRenderProps, DrawerGridDrawerConfig, DrawerGridEditConfig, DrawerGridProps, EditGridColumnsProps, EditReadOnlyFields, EstadoDeFiltro, EstadoTabConfig, ExportCSVProps as ExportCSVProps_v2, ExtraCreateOptionProps, FieldFilter, FieldProps$1 as FieldProps, FieldValidationProps, FilterInput, FormBreakpoint, FormGridSxOptions, GlobalSearchOption, GlobalSearchProps, GridArgs, GridColDefPropsOverrides, GridLayerContribution, GridLayerId, GridLayerMap, GrillaHastaElFondoProps, HiddenPageHeaderHost, InsigniaDeCatalogo, JSONFormProps, JSONParserProps, KeyboardShortcut, KpiCardProps, Locale, LocaleContextProps, LocaleProviderProps, MainDrawerV2Props, MainLayoutFooterConfig, MainLayoutPageHeaderProps, MainLayoutProps, MainLayoutSidebarFooterProps, MutationArgs, MyDataGridProps, MyGridFilterModel, MyTab, MyTabProps, NotificationItemProps, NotificationsApi, NotificationsBellProps, PageActionsHost, PageBadgeHost, PageInfoHost, PageInfoProps, PageType, PanelProps, PollingCountdownChipProps, ProgressStatusProps, PulseDotProps, ResponsiveAction, ResponsiveActionsMode, ResponsiveActionsProps, RowsSnapshot, ServerGridArgs, ServerGridCreateApi, ServerGridDataApi, ServerGridDeleteApi, ServerGridEditApi, ServerGridEditToggleApi, ServerGridHandle, ServerGridProps, ServerGridSnapshot, ServerGridState, SidePanelHost, StatusColor, StickyPageHeaderHost, Textos, UseColorModeResult, UseServerGridOptions };
+export { APIContext, APIProvider, AccountMenuContent, ActiveCell, ActiveIcon, Base, ButtonWithDrawer, COLOR_SCHEME_SELECTOR, CSVUpload, CatalogoItem, CatalogoList, ChipCell, ConfirmDialog, ContentBorderRadiusContext, ContentLayout, ControlledAddressAutocomplete, ControlledAmountWithCurrency, ControlledAutocomplete, ControlledColor, ControlledDate$1 as ControlledDate, ControlledDate as ControlledDate_v2, ControlledDropdown, ControlledFileField$1 as ControlledFileField, ControlledFileField as ControlledFileField_v2, FileUploadBox as ControlledFileUploadBox, ControlledNumber, ControlledPhoneNumber, ControlledSelect$1 as ControlledSelect, ControlledSelect as ControlledSelect_v2, ControlledSlider as ControlledSimpleSlider, ControlledSlider$1 as ControlledSlider, ControlledSwitch, ControlledText, ControlledTimePicker, ControlledToggleButtons, CoverPage, CreateButtonBase, CreateButtonWithMenuOptions, CrudDropdown, CustomNoRows, DEFAULT_CONTENT_BORDER_RADIUS, DEFAULT_FORM_BREAKPOINTS, DEFAULT_PAGINATION, DRAWER_Z_INDEX, Dato, DeleteButton, DeleteConfirmationDialog, DetailFormDialog as DetailFormDialog_v2, DetailFormDrawer as DetailFormDrawer_v2, DetailForm as DetailForm_v2, DetailPage$1 as DetailPage, DetailPage as DetailPage_v2, Documento, DrawerGrid as DrawerGrid_v2, EditButton, ExportCSV$1 as ExportCSV, ExportCSV as ExportCSV_v2, ExtraButtons, FILTERS_DRAWER_GAP, FORM_CONTAINER_NAME, GlobalSearch, GrillaHastaElFondo, HEADER_CONTAINER, HEADER_NARROW, HiddenPageHeaderContext, HistorialDrawer, KpiCard, LAYER_ORDER, ListPage, Lista, Loadable, LoadingComponent, LocaleContext, LocaleProvider, Logo, MainDrawer, MainDrawer$1 as MainDrawer_v2, MainLayout, MenuItemWithLoading, ModuleCard, MoreOptions, MyGridEditSingleSelect, NavigationContext, NavigationProvider, NormalOrIcon, NotAllowed, NotFound, NotificationItem, NotificationsBell, ObjectProgressStack, OverModalContext, OverModalProvider, PageActionsHostContext, PageBadgeHostContext, PageInfo, PageInfoHostContext, PaginaLegal, Panel, Parrafo, PollingCountdownChip, PulseDot, RESPONSIVE_ACTION_MODES, ResponsiveActions, SIDE_PANEL_WIDTH_VAR, SaveCancelButton, Seccion, ServerGrid as ServerGrid_v2, SidePanelHostContext, StatusBadge, StickyPageHeaderContext, StyledMenu, StyledToggleButtonGroup, Subtitulo, TEXTOS, Tabs, Titulo, Transitions, TrueFalse, UncontrolledText, aplicarLocaleDeDayjs, buildEstadoTabs, changeTitle, closeProgressSnack, columnasDeCatalogo, composeGridProps, crearFabricaDeCatalogos, deleteColumn$1 as deleteColumn, deleteColumn as deleteColumn_v2, drawerZIndex, editColumn, filterQuery, filtersPanelFrameSx, formContainerSx, formGridSx, formParser, headerContainerSx, _default as headerReducer, localeDeNumeros, localeTextDeMUI, localeTextDeToolpad, manualCacheRefresh, mergeSettings, mutationData, mutationId, mutationParams, openProgressSnack, pageSizeOptions, query, renderChipCell, renderEditCellWithErrorTooltip, resolveChipOption, resolveInitialState, resolveStatusColor, setErrors, singularizarPalabra, singularizarTitulo, _default$1 as snackProgressReducer, statusColors, tags, theme, togglableFields, updateProgressSnackData, useAPI, useColorMode, useContentBorderRadius, useDetailForm, useHasPermission, useHasPermission_v2, useHiddenPageHeader, useHiddenPageHeaderHost, useKeyboardShortcut, useLocale, useMutationHandler, useNavigation, useOverModal, usePageActionsHost, usePageBadgeHost, usePageInfoHost, useServerGrid, useSidePanelHost, useStickyPageHeader, useStickyPageHeaderHost, useTextos, valueLabel };
+export type { APIcontextProps, AccountMenuContentProps, AccountMenuItem, AddressValue, AppTheme, AutocompleteOption, BuildEstadoTabsOptions, CSVMenuOptionProps, CatalogoAPI, CatalogoItemProps, CatalogoListProps, ChipCellProps, ChipColor, ChipOption, ColorMode, ComoOpcionesProps, ConfirmDialogProps, ControlledAutocompleteProps, ControlledInput, CrearCatalogoAPI, CustomFilterDef, CustomToolbarProps, DefinicionDeCatalogo, DeleteGridColumnsProps$1 as DeleteGridColumnsProps, DetachedPage, DetailExtraButton, DetailFormApi, DetailFormConfig, DetailFormController, DetailFormDialogProps, DetailFormDrawerNavigation, DetailFormDrawerProps, DetailFormProps, DetailFormStatus, DetailPageV2Props, DetailRenderProps, DrawerGridDrawerConfig, DrawerGridEditConfig, DrawerGridProps, EditGridColumnsProps, EditReadOnlyFields, EstadoDeFiltro, EstadoTabConfig, ExportCSVProps as ExportCSVProps_v2, ExtraCreateOptionProps, FieldFilter, FieldProps$1 as FieldProps, FieldValidationProps, FilterInput, FormBreakpoint, FormGridSxOptions, GlobalSearchOption, GlobalSearchProps, GridArgs, GridColDefPropsOverrides, GridLayerContribution, GridLayerId, GridLayerMap, GrillaHastaElFondoProps, HiddenPageHeaderHost, InsigniaDeCatalogo, JSONFormProps, JSONParserProps, KeyboardShortcut, KpiCardProps, ListaProps, Locale, LocaleContextProps, LocaleProviderProps, MainDrawerV2Props, MainLayoutFooterConfig, MainLayoutPageHeaderProps, MainLayoutProps, MainLayoutSidebarFooterProps, MutationArgs, MyDataGridProps, MyGridFilterModel, MyTab, MyTabProps, NotificationItemProps, NotificationsApi, NotificationsBellProps, PageActionsHost, PageBadgeHost, PageInfoHost, PageInfoProps, PageType, PaginaLegalProps, PanelProps, PollingCountdownChipProps, ProgressStatusProps, PulseDotProps, ResponsiveAction, ResponsiveActionsMode, ResponsiveActionsProps, RowsSnapshot, RutasDePaginaLegal, SeccionProps, ServerGridArgs, ServerGridCreateApi, ServerGridDataApi, ServerGridDeleteApi, ServerGridEditApi, ServerGridEditToggleApi, ServerGridHandle, ServerGridProps, ServerGridSnapshot, ServerGridState, SidePanelHost, StatusColor, StickyPageHeaderHost, Textos, TextosDePaginaLegal, UseColorModeResult, UseServerGridOptions };

package/package.json

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