@acvl/frontend-components 0.0.93 → 0.0.94

package/dist/index.d.ts

@@ -3384,6 +3384,142 @@ declare function PollingCountdownChip({ pollingInterval, isFetching, onRefresh,
  */
 declare function ServerGrid(props: ServerGridProps): react_jsx_runtime.JSX.Element;
 
+/** Lo que vale un estado en el filtro: el entero de un `choices` o su clave de texto. */
+type EstadoDeFiltro = string | number;
+interface EstadoTabConfig {
+    value: string;
+    label: string;
+    /**
+     * Estado —o estados— por los que filtra la pestaña. Si se omite, la pestaña muestra todo.
+     *
+     * Un arreglo agrupa varios en una sola pestaña ("En curso" = sin iniciar + en progreso). Lo
+     * que tiene que corresponder es el `estadoField`: `estado` para uno solo, `estado__in`
+     * cuando la pestaña es un grupo.
+     */
+    estado?: EstadoDeFiltro | EstadoDeFiltro[];
+    /** Icono de la pestaña (p. ej. un contador). */
+    icon?: ReactNode;
+    /** Columnas específicas de esta pestaña (sobrescribe las columnas por defecto). */
+    columns?: GridColDefPropsOverrides[];
+    /**
+     * Lo que esta pestaña le cambia al modo edición: casi siempre sus columnas, cuando la grilla
+     * las sirve desde `api.edit` y no desde `dataGridProps`. Se mezcla sobre el `edit` de arriba;
+     * sin ninguno de los dos no hay capa de edición.
+     */
+    edit?: Partial<ServerGridEditApi>;
+    /** Habilita el borrado en esta pestaña (sobrescribe el valor por defecto). */
+    withDelete?: boolean;
+    /** Campo de ordenamiento de esta pestaña (sobrescribe el valor por defecto). */
+    sortField?: string;
+    /** Dirección de ordenamiento de esta pestaña (sobrescribe el valor por defecto). */
+    sortDirection?: "asc" | "desc";
+    /**
+     * Habilita el botón de crear en esta pestaña, aunque no haya carga por CSV ni opciones
+     * extra (sobrescribe el valor por defecto).
+     */
+    create?: boolean;
+    /** Habilita la carga por CSV en esta pestaña (sobrescribe el valor por defecto). */
+    csvUpload?: boolean;
+    /** Opciones extra del menú de carga por CSV de esta pestaña. */
+    csvUploadOptions?: CSVMenuOptionProps[];
+    /** Opciones extra del botón de crear de esta pestaña (sobrescribe el valor por defecto). */
+    createExtraOptions?: ExtraCreateOptionProps[];
+    /** Props adicionales del DataGrid, combinadas con las generadas (columnas, ordenamiento…). */
+    dataGridProps?: Partial<MyDataGridProps>;
+    /** `slotProps` del `<ServerGrid_v2>` de esta pestaña. */
+    slotProps?: ServerGridProps["slotProps"];
+    /** Filtros propios del panel de esta pestaña (sobrescribe el valor por defecto). */
+    customFilters?: CustomFilterDef[];
+    /** Elemento(s) renderizados junto al `<ServerGrid_v2>` dentro de la pestaña (p. ej. un drawer). */
+    before?: ReactNode;
+}
+interface BuildEstadoTabsOptions {
+    pathname: string;
+    /** Configuración de cada pestaña. */
+    tabs: EstadoTabConfig[];
+    /** Hook lazy-query de RTK Query usado por todas las pestañas. */
+    query: any;
+    /**
+     * El filtro con el que se le pide el estado al recurso. Es el nombre del parámetro tal como
+     * lo declara el `FilterSet`, no el campo del modelo: `estado` para el `exact` de siempre,
+     * `estado__in` cuando la pestaña agrupa estados — y cuando la columna de estado ya filtra por
+     * ese mismo nombre, para que `protectFilters` cierre la misma llave que el panel escribiría.
+     *
+     * @default "estado"
+     */
+    estadoField?: string;
+    /** Columnas por defecto cuando una pestaña no define las suyas. */
+    columns?: GridColDefPropsOverrides[];
+    /**
+     * Modo edición por defecto, para las grillas que sirven sus columnas desde `api.edit`. Con
+     * `disabled: true` es además la forma de tener las columnas ahí sin ofrecer la edición.
+     */
+    edit?: ServerGridEditApi;
+    /** Campo de ordenamiento inicial por defecto. */
+    sortField: string;
+    /** Dirección de ordenamiento inicial por defecto. Por defecto "asc". */
+    sortDirection?: "asc" | "desc";
+    /** Mutación de borrado; se aplica a las pestañas con `withDelete`. */
+    deleteMutation?: any;
+    /** Valor por defecto de `withDelete` para las pestañas que no lo especifican. */
+    withDelete?: boolean;
+    /**
+     * Valor por defecto del botón de crear para las pestañas que no lo especifican.
+     * Úsalo cuando solo se quiere la opción "Manual", sin carga por CSV.
+     */
+    create?: boolean;
+    /**
+     * Valor por defecto de la carga por CSV para las pestañas que no lo especifican. Sólo surte
+     * efecto con `importacion`: sin diálogo que abrir no se ofrece.
+     */
+    csvUpload?: boolean;
+    /**
+     * El diálogo de importación del listado, tal como lo arma la página (con el permiso del
+     * modelo y lo demás que el diálogo necesita). Va aquí y no se arma adentro porque
+     * `buildEstadoTabs` no es un hook: corre en el render, pero una llamada condicional —por
+     * pestaña, según `csvUpload`— rompería el orden de los hooks.
+     */
+    importacion?: NonNullable<ServerGridCreateApi["csv_upload"]>;
+    /** Opciones extra del menú de carga por CSV, por defecto para todas las pestañas. */
+    csvUploadOptions?: CSVMenuOptionProps[];
+    /** Opciones extra del botón de crear, por defecto para todas las pestañas. */
+    createExtraOptions?: ExtraCreateOptionProps[];
+    /**
+     * Filtros que el panel de filtros no puede sacar de las columnas —"Mis órdenes de envío" y
+     * demás—, por defecto para todas las pestañas.
+     *
+     * Tiene que ser un arreglo estable (memoizado): `<ServerGrid_v2>` lo tiene como dependencia
+     * de un `useMemo`, igual que los `args`.
+     */
+    customFilters?: CustomFilterDef[];
+    /**
+     * Menú de exportar, el mismo en todas las pestañas. Se arma con `menuDeExportacion` cuando
+     * el listado ofrece además las descargas de sus hijos (los bultos de estas transferencias).
+     *
+     * Va aquí y no pestaña por pestaña porque el juego de descargas es del recurso, no del
+     * estado: repetirlo en cada pestaña es donde se cuela la que se quedó sin actualizar.
+     */
+    exportMenu?: Record<string, any>;
+}
+
+/**
+ * Construye las pestañas (`MyTab[]`) de un listado filtrado por estado, cada una renderizando un
+ * `<ServerGrid_v2>` con el filtro de estado, el ordenamiento y las acciones (edición / borrado /
+ * crear) ya cableados. Cada pestaña puede sobrescribir los valores por defecto del listado y
+ * aportar props adicionales del DataGrid; qué decide cada llave está en `props.ts`.
+ *
+ * **El estado de la pestaña no se puede quitar desde el panel de filtros** (`protectFilters`): es
+ * lo que la pestaña *es*, no un filtro que el usuario haya puesto. Por eso las pestañas de un
+ * estado concreto suelen ir sin la columna de estado —dentro de "Nuevos" esa columna dice siempre
+ * lo mismo— y la de "Todos" sí la lleva, que es donde el filtro vuelve a tener sentido.
+ *
+ * Cada pestaña recuerda por separado sus filtros, su orden y sus columnas: `Tabs` le inyecta a su
+ * hijo el `slotProps.tab` de la pestaña y de ahí sale la llave de persistencia. Una pestaña con
+ * `before` envuelve al grid en un fragmento, así que ahí la inyección no llega y la llave se pone
+ * a mano (`slotProps: { tab }`).
+ */
+declare function buildEstadoTabs(opciones: BuildEstadoTabsOptions): MyTab[];
+
 interface ExportCSVProps {
     handleClick: () => void;
     filterModel: MyGridFilterModel;
@@ -4776,5 +4912,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, 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_FORM_BREAKPOINTS, DEFAULT_PAGINATION, 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, FORM_CONTAINER_NAME, GlobalSearch, GrillaHastaElFondo, HEADER_CONTAINER, HEADER_NARROW, 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, PageActionsHostContext, PageBadgeHostContext, PageInfo, PageInfoHostContext, Panel, PollingCountdownChip, PulseDot, RESPONSIVE_ACTION_MODES, ResponsiveActions, SIDE_PANEL_WIDTH_VAR, SaveCancelButton, ServerGrid as ServerGrid_v2, SidePanelHostContext, StatusBadge, StickyPageHeaderContext, StyledMenu, TEXTOS, Tabs, Transitions, TrueFalse, UncontrolledText, aplicarLocaleDeDayjs, changeTitle, closeProgressSnack, columnasDeCatalogo, composeGridProps, crearFabricaDeCatalogos, deleteColumn$1 as deleteColumn, deleteColumn as deleteColumn_v2, editColumn, filterQuery, 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, useDetailForm, useHasPermission, useHasPermission_v2, useKeyboardShortcut, useLocale, useMutationHandler, useNavigation, usePageActionsHost, usePageBadgeHost, usePageInfoHost, useServerGrid, useSidePanelHost, useStickyPageHeader, useStickyPageHeaderHost, useTextos, valueLabel };
-export type { APIcontextProps, AccountMenuContentProps, AccountMenuItem, AddressValue, AppTheme, AutocompleteOption, 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, ExportCSVProps as ExportCSVProps_v2, FieldFilter, FieldProps$1 as FieldProps, FieldValidationProps, FilterInput, FormBreakpoint, FormGridSxOptions, GlobalSearchOption, GlobalSearchProps, GridArgs, GridColDefPropsOverrides, GridLayerContribution, GridLayerId, GridLayerMap, GrillaHastaElFondoProps, 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, 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_FORM_BREAKPOINTS, DEFAULT_PAGINATION, 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, FORM_CONTAINER_NAME, GlobalSearch, GrillaHastaElFondo, HEADER_CONTAINER, HEADER_NARROW, 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, PageActionsHostContext, PageBadgeHostContext, PageInfo, PageInfoHostContext, Panel, PollingCountdownChip, PulseDot, RESPONSIVE_ACTION_MODES, ResponsiveActions, SIDE_PANEL_WIDTH_VAR, SaveCancelButton, ServerGrid as ServerGrid_v2, SidePanelHostContext, StatusBadge, StickyPageHeaderContext, StyledMenu, TEXTOS, Tabs, Transitions, TrueFalse, UncontrolledText, aplicarLocaleDeDayjs, buildEstadoTabs, changeTitle, closeProgressSnack, columnasDeCatalogo, composeGridProps, crearFabricaDeCatalogos, deleteColumn$1 as deleteColumn, deleteColumn as deleteColumn_v2, editColumn, filterQuery, 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, useDetailForm, useHasPermission, useHasPermission_v2, useKeyboardShortcut, useLocale, useMutationHandler, useNavigation, 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, 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 };

package/package.json

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