@cnc-ti/layout-basic 8.4.0 → 8.5.0

package/dist/index.d.ts

@@ -68,6 +68,24 @@ interface HeaderContainerProps extends HTMLAttributes<HTMLDivElement> {
      */
     logoLink?: string;
     container?: boolean;
+    /**
+     * Conteúdo opcional exibido à esquerda dos `children` do cabeçalho — a área
+     * reservada para o sino de notificações.
+     *
+     * Não é renderizado quando omitido, então nenhum consumidor atual é afetado.
+     * O uso previsto é o componente `HeaderNotifications`, mas qualquer nó React
+     * é aceito.
+     *
+     * @example
+     * <HeaderContainer
+     *   onOpenMenu={toggleSidebar}
+     *   isOpen={collapsed}
+     *   notifications={<HeaderNotifications items={notificacoes} />}
+     * >
+     *   <HeaderProfileHeader user={usuario}>...</HeaderProfileHeader>
+     * </HeaderContainer>
+     */
+    notifications?: ReactNode;
 }
 declare const HeaderContainer: React.FC<HeaderContainerProps>;
 interface ProfileProps extends HTMLAttributes<HTMLDivElement> {
@@ -619,4 +637,191 @@ interface CardListProps<T> {
 }
 declare function CardList<T>({ items, renderCard, emptyMessage, minItemWidth, className, gap, getKey, isLoading, skeletonCount, }: CardListProps<T>): react_jsx_runtime.JSX.Element;
 
-export { AplicationsHeader, type AppInput, type AppItem, AppsMenu, type AppsMenuProps, Badge, type BadgeSize, type BadgeVariant, Button, type ButtonProps, Card, CardContent, CardFooter, CardFooterItem, CardHeader, CardList, type CardListProps, Checkbox, type CheckboxProps, Collapsible, AnimatedCollapsibleContent as CollapsibleContent, CollapsibleTrigger, Combobox, type ComboboxProps, Command, CommandDialog, CommandEmpty, CommandGroup, CommandInput, CommandItem, CommandList, CommandSeparator, CommandShortcut, Dialog, DialogClose, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogOverlay, DialogPortal, DialogTitle, DialogTrigger, DropdownMenu, DropdownMenuCheckboxItem, DropdownMenuContent, DropdownMenuGroup, DropdownMenuItem, DropdownMenuLabel, DropdownMenuPortal, DropdownMenuRadioGroup, DropdownMenuRadioItem, DropdownMenuSeparator, DropdownMenuShortcut, DropdownMenuSub, DropdownMenuSubContent, DropdownMenuSubTrigger, DropdownMenuTrigger, Filter, type FilterField, type FilterFieldType, type FilterProps, type FilterValues, Header, HeaderContainer, HeaderProfileHeader, HeaderProfileItem, type HeaderProps, Input, type InputProps, type ItemOption, Modal, ModalEntidade, ModalMudancaEntidade, type ModalProps, PageHeader, PageHeaderActionsContainer, PageHeaderTitle, PageHeaderTitleContent, Popover, PopoverContent, PopoverTrigger, Select, SelectContent, SelectGroup, SelectItem, SelectLabel, SelectPortal, SelectScrollDownButton, SelectScrollUpButton, SelectSeparator, SelectTrigger, SelectValue, SelectViewport, Sidebar, SidebarContainer, type SidebarContainerProps, SidebarImageBrand, type SidebarImageBrandProps, SidebarNavCollapse, type SidebarNavCollapseProps, SidebarNavLink, type SidebarNavLinkProps, type SidebarProps, Switch, type SwitchProps, Tabs, TabsContent, TabsList, TabsTrigger, Title, availableApps, buttonVariants };
+type StatusNotificacao = "PENDENTE" | "AGENDADO" | "ENVIADO" | "PROCESSADO" | "FALHOU" | "CANCELADO" | "CONCLUIDO";
+type StatusLeitura = "NAO_LIDO" | "ENTREGUE" | "LIDO";
+/** Registro devolvido por `GET {baseUrl}/notificacoes`. */
+interface Notificacao {
+    id: string | number;
+    sistema: string;
+    titulo: string;
+    mensagem?: string | null;
+    dataReferencia: string;
+    destinatarioEmail?: string | null;
+    status: StatusNotificacao;
+    statusLeitura: StatusLeitura;
+    metadados?: Record<string, unknown> | null;
+    lembrarNoDia?: boolean;
+    diasAntes?: number | null;
+    alertasDiasAntes?: number[] | null;
+    dataLembrete?: string | null;
+    disparado?: boolean;
+    criadoEm?: string | null;
+    criadoPor?: string | null;
+    disparadoEm?: string | null;
+    entregueEm?: string | null;
+    lidoEm?: string | null;
+    canceladoEm?: string | null;
+    concluidoEm?: string | null;
+    motivoCancelamento?: string | null;
+}
+interface HeaderNotificationItem {
+    /** Identificador único. Usado como `key` da lista. */
+    id: string | number;
+    /** Título da notificação. */
+    title: string;
+    /** Texto complementar, limitado a duas linhas. */
+    message?: string;
+    /** Data já formatada, ex.: "há 5 minutos". */
+    date?: string;
+    /** Quando `false` ou ausente, o item conta no badge e fica destacado. */
+    read?: boolean;
+    /** Destino sugerido, para a aplicação usar no `onSelect`. Não navega sozinho. */
+    href?: string;
+}
+interface HeaderNotificationsBaseProps {
+    /** Quantidade de skeletons durante o loading. @defaultValue 3 */
+    skeletonCount?: number;
+    /** Título do painel. @defaultValue "Notificações" */
+    title?: string;
+    /** Mensagem do estado vazio. @defaultValue "Nenhuma notificação" */
+    emptyMessage?: string;
+    /** A partir deste valor o badge exibe "N+". @defaultValue 9 */
+    maxCount?: number;
+    /**
+     * Ação extra no clique, além de marcar como lida. Só com ela o painel fecha
+     * e só com ela há navegação — o componente nunca navega por conta própria.
+     * Use `item.href`, preenchido por `getHref`, para decidir o destino.
+     */
+    onSelect?: (item: HeaderNotificationItem) => void;
+    /** Clique em uma notificação não lida, chamada antes de `onSelect`. */
+    onMarkAsRead?: (item: HeaderNotificationItem) => void;
+    /**
+     * Habilita o botão de marcar como não lida em cada item. No modo conectado o
+     * componente já faz a chamada; aqui a aplicação só é avisada.
+     */
+    onMarkAsUnread?: (item: HeaderNotificationItem) => void;
+    /**
+     * Habilita a lixeira em cada item. No modo conectado o componente já exclui
+     * na API; aqui a aplicação só é avisada. **A exclusão é definitiva.**
+     */
+    onDelete?: (item: HeaderNotificationItem) => void;
+    /** "Marcar todas como lidas", exibida só quando há não lidas. */
+    onMarkAllAsRead?: () => void;
+    /** Abertura e fechamento do painel. */
+    onOpenChange?: (open: boolean) => void;
+    /** Rodapé customizado. Substitui os botões padrão do rodapé. */
+    footer?: React$1.ReactNode;
+    /** Alinhamento do painel em relação ao sino. @defaultValue "end" */
+    align?: "start" | "center" | "end";
+    /** Classes adicionais do botão do sino. */
+    className?: string;
+    /** Classes adicionais do painel. */
+    contentClassName?: string;
+}
+/** Modo controlado: a aplicação busca e formata, o componente só exibe. */
+interface HeaderNotificationsControladoProps extends HeaderNotificationsBaseProps {
+    /** Notificações exibidas no painel. */
+    items?: HeaderNotificationItem[];
+    /** Quando `true`, exibe skeletons no lugar da lista. */
+    isLoading?: boolean;
+    /** Contagem do badge. Quando omitida, é derivada de `items`. */
+    unreadCount?: number;
+    email?: never;
+    sistema?: never;
+    baseUrl?: never;
+    getHref?: never;
+    filtros?: never;
+    intervaloAtualizacao?: never;
+    limite?: never;
+    onErro?: never;
+    alertarLembretes?: never;
+    tituloLembretes?: never;
+    rotuloDispensarLembretes?: never;
+}
+/** Modo conectado: o componente busca no serviço de notificações sozinho. */
+interface HeaderNotificationsConectadoProps extends HeaderNotificationsBaseProps {
+    /** E-mail do destinatário. Vira `?email=` no GET. */
+    email: string;
+    /** Identificador do sistema chamador, ex.: "gestao-demandas". */
+    sistema: string;
+    /**
+     * Raiz da API já versionada, ex.: `https://.../v1`. Quando omitida, usa
+     * `URL_PADRAO_NOTIFICACOES`, que aponta para o **ambiente de
+     * desenvolvimento** — em produção passe explicitamente.
+     */
+    baseUrl?: string;
+    /**
+     * Preenche `item.href` a partir de `metadados`. **Não navega sozinho** — só
+     * serve para o `onSelect` da aplicação saber para onde ir. Sem `onSelect`, o
+     * clique apenas marca como lida.
+     */
+    getHref?: (notificacao: Notificacao) => string | undefined;
+    /** Filtros de metadado enviados na query, ex.: `{ demandaId: "123" }`. */
+    filtros?: Record<string, string>;
+    /** Intervalo do polling em ms. `0` desliga. @defaultValue 60000 */
+    intervaloAtualizacao?: number;
+    /** Corte client-side — a API não pagina. @defaultValue 20 */
+    limite?: number;
+    /** Recebe falhas de rede em vez de deixá-las silenciosas. */
+    onErro?: (erro: Error) => void;
+    /**
+     * Abre um modal ao carregar quando existe lembrete vencido — notificação com
+     * `lembrarNoDia` ligado e `dataLembrete` já vencido. Fechar o modal marca
+     * esses lembretes como lidos. @defaultValue false
+     */
+    alertarLembretes?: boolean;
+    /** Título do modal de lembretes. Por padrão varia com a quantidade. */
+    tituloLembretes?: string;
+    /** Texto do botão que dispensa o modal. @defaultValue "Entendi" */
+    rotuloDispensarLembretes?: string;
+    items?: never;
+    isLoading?: never;
+    unreadCount?: never;
+}
+type HeaderNotificationsProps = HeaderNotificationsControladoProps | HeaderNotificationsConectadoProps;
+
+/**
+ * Usada quando `baseUrl` não é informada. Aponta para o ambiente de
+ * desenvolvimento — em produção passe a prop explicitamente, senão a aplicação
+ * lê e grava no dev.
+ */
+declare const URL_PADRAO_NOTIFICACOES = "https://dev-apinotificacoes-b5feekb4bdfyb7c2.eastus2-01.azurewebsites.net/v1";
+declare class ErroNotificacoes extends Error {
+    readonly status?: number;
+    constructor(mensagem: string, status?: number);
+}
+
+/**
+ * Sino de notificações do cabeçalho: badge de não lidas, painel com a lista,
+ * estados de loading e vazio, marcar todas como lidas e atalho para a tela
+ * completa.
+ *
+ * Opera em dois modos, mutuamente exclusivos pelo tipo:
+ *
+ * **Conectado** — recebe `email` e `sistema` e cuida sozinho de buscar,
+ * formatar a data, filtrar o que já aconteceu e marcar como lida. `baseUrl` é
+ * opcional e cai em `URL_PADRAO_NOTIFICACOES`, que aponta para o ambiente de
+ * desenvolvimento — em produção passe a prop.
+ *
+ * **Controlado** — recebe `items` já prontos e devolve as interações por
+ * callback, sem fazer nenhuma requisição.
+ *
+ * @example
+ * <HeaderContainer
+ *   onOpenMenu={toggleSidebar}
+ *   isOpen={collapsed}
+ *   notifications={
+ *     <HeaderNotifications
+ *       email={sessao.user.email}
+ *       sistema="gestao-demandas"
+ *       getHref={(n) => `/demandas/${n.metadados?.demandaId}`}
+ *       onViewAll={() => router.push("/notificacoes")}
+ *     />
+ *   }
+ * >
+ *   <HeaderProfileHeader user={usuario}>...</HeaderProfileHeader>
+ * </HeaderContainer>
+ */
+declare function HeaderNotifications(props: HeaderNotificationsProps): react_jsx_runtime.JSX.Element;
+
+export { AplicationsHeader, type AppInput, type AppItem, AppsMenu, type AppsMenuProps, Badge, type BadgeSize, type BadgeVariant, Button, type ButtonProps, Card, CardContent, CardFooter, CardFooterItem, CardHeader, CardList, type CardListProps, Checkbox, type CheckboxProps, Collapsible, AnimatedCollapsibleContent as CollapsibleContent, CollapsibleTrigger, Combobox, type ComboboxProps, Command, CommandDialog, CommandEmpty, CommandGroup, CommandInput, CommandItem, CommandList, CommandSeparator, CommandShortcut, Dialog, DialogClose, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogOverlay, DialogPortal, DialogTitle, DialogTrigger, DropdownMenu, DropdownMenuCheckboxItem, DropdownMenuContent, DropdownMenuGroup, DropdownMenuItem, DropdownMenuLabel, DropdownMenuPortal, DropdownMenuRadioGroup, DropdownMenuRadioItem, DropdownMenuSeparator, DropdownMenuShortcut, DropdownMenuSub, DropdownMenuSubContent, DropdownMenuSubTrigger, DropdownMenuTrigger, ErroNotificacoes, Filter, type FilterField, type FilterFieldType, type FilterProps, type FilterValues, Header, HeaderContainer, type HeaderNotificationItem, HeaderNotifications, type HeaderNotificationsBaseProps, type HeaderNotificationsConectadoProps, type HeaderNotificationsControladoProps, type HeaderNotificationsProps, HeaderProfileHeader, HeaderProfileItem, type HeaderProps, Input, type InputProps, type ItemOption, Modal, ModalEntidade, ModalMudancaEntidade, type ModalProps, type Notificacao, PageHeader, PageHeaderActionsContainer, PageHeaderTitle, PageHeaderTitleContent, Popover, PopoverContent, PopoverTrigger, Select, SelectContent, SelectGroup, SelectItem, SelectLabel, SelectPortal, SelectScrollDownButton, SelectScrollUpButton, SelectSeparator, SelectTrigger, SelectValue, SelectViewport, Sidebar, SidebarContainer, type SidebarContainerProps, SidebarImageBrand, type SidebarImageBrandProps, SidebarNavCollapse, type SidebarNavCollapseProps, SidebarNavLink, type SidebarNavLinkProps, type SidebarProps, type StatusLeitura, type StatusNotificacao, Switch, type SwitchProps, Tabs, TabsContent, TabsList, TabsTrigger, Title, URL_PADRAO_NOTIFICACOES, availableApps, buttonVariants };