@adatechnology/notification-ui 0.1.0-rc.1 → 0.1.0-rc.3

package/dist/index.d.ts

@@ -1,6 +1,7 @@
-export { DEFAULT_LOCALE, NOTIFICATION_QUERY_KEYS, NotificationContextValue, NotificationLocale, NotificationMessages, NotificationProvider, NotificationProviderProps, NotificationTheme, UseNotificationStreamOptions, UseNotificationsOptions, flattenNotificationPages, resolveMessages, useDeleteNotification, useMarkAllAsRead, useMarkAsRead, useNotificationContext, useNotificationStream, useNotifications, usePreferences, useTemplates, useUnreadCount, useUpdatePreferences } from './headless.js';
+export { DEFAULT_LOCALE, NOTIFICATION_QUERY_KEYS, NotificationContextValue, NotificationLocale, NotificationMessages, NotificationProvider, NotificationProviderProps, NotificationTheme, TemplateDraft, UseNotificationStreamOptions, UseNotificationsOptions, UseTemplateEditorParams, UseTemplateEditorResult, flattenNotificationPages, formatNotificationTime, formatNotificationTimestamp, resolveMessages, useDeleteNotification, useMarkAllAsRead, useMarkAsRead, useNotificationContext, useNotificationStream, useNotifications, usePreferences, useTemplateEditor, useTemplates, useUnreadCount, useUpdatePreferences, useUpsertTemplate } from './headless.js';
 import * as react from 'react';
-import { NotificationSummary } from '@adatechnology/notification-contracts';
+import { ReactNode } from 'react';
+import { NotificationSummary, NotificationTemplate } from '@adatechnology/notification-contracts';
 import '@adatechnology/notification-client';
 import '@tanstack/react-query';
 
@@ -13,7 +14,7 @@ type NotificationBellProps = {
     /** Acima disso o badge mostra `99+`; um número de 4 dígitos estoura o desenho do badge. */
     readonly maxBadgeCount?: number;
 };
-declare function NotificationBell({ onClick, className, maxBadgeCount }: NotificationBellProps): react.JSX.Element;
+declare function NotificationBell({ onClick, className, maxBadgeCount, }: NotificationBellProps): react.JSX.Element;
 
 type NotificationItemProps = {
     readonly notification: NotificationSummary;
@@ -26,12 +27,17 @@ type NotificationListProps = {
     readonly category?: string;
     readonly onSelect?: (notification: NotificationSummary) => void;
     readonly className?: string;
+    /**
+     * Substitui o vazio padrão. Quem decide se está vazio é a lista — o host que desenhava o próprio
+     * vazio ao lado dela mostrava "nada por aqui" embaixo das notificações que estavam ali.
+     */
+    readonly renderEmpty?: () => ReactNode;
     /** Slot: o host troca a linha sem reimplementar a lista (regra §4.3, slots e overrides). */
     readonly components?: {
         readonly Item?: typeof NotificationItem;
     };
 };
-declare function NotificationList({ category, onSelect, className, components }: NotificationListProps): react.JSX.Element;
+declare function NotificationList({ category, onSelect, className, renderEmpty, components }: NotificationListProps): react.JSX.Element;
 
 /**
  * Copyright (c) 2026 Ada Technology. MIT License.
@@ -41,4 +47,79 @@ type PreferencesPanelProps = {
 };
 declare function PreferencesPanel({ className }: PreferencesPanelProps): react.JSX.Element;
 
-export { NotificationBell, type NotificationBellProps, NotificationItem, type NotificationItemProps, NotificationList, type NotificationListProps, PreferencesPanel, type PreferencesPanelProps };
+type NotificationsWorkspaceProps = {
+    /** Sobrescreve textos pontuais sem trocar o locale inteiro. */
+    readonly labels?: Partial<Record<string, string>>;
+    /** Filtra a inbox por assunto. Ausente, mostra tudo. */
+    readonly category?: string;
+    /**
+     * Coluna de preferências ao lado da inbox.
+     *
+     * Ligada por padrão porque é o caso comum; um produto que gerencia preferência noutra tela passa
+     * `false` e fica só com a inbox, em largura cheia.
+     */
+    readonly showPreferences?: boolean;
+    /** Ausente, o link de configuração não aparece — o produto pode não ter essa tela. */
+    readonly settingsHref?: string | undefined;
+    /** Clique numa notificação. Ausente, a linha não é clicável. */
+    readonly onSelectNotification?: (notification: NotificationSummary) => void;
+    /**
+     * Substitui o cabeçalho padrão inteiro.
+     *
+     * O workspace desenha um `<h1>` porque ele é a tela; a página que já tem o título dela passava a
+     * ter dois `<h1>` dizendo a mesma palavra, e para leitor de tela duas primeiras manchetes é o
+     * mesmo que nenhuma. Ausente, o padrão continua desenhando — slot é substituição, não interruptor.
+     */
+    readonly renderHeader?: () => ReactNode;
+    /** Ações do produto no cabeçalho, ao lado do link de configuração. */
+    readonly renderHeaderActions?: () => ReactNode;
+    /** Aviso ou filtro do produto, entre o cabeçalho e a lista. */
+    readonly renderAboveList?: () => ReactNode;
+    /** Substitui o vazio padrão — útil quando o produto sabe explicar por que está vazio. */
+    readonly renderEmpty?: () => ReactNode;
+    readonly className?: string;
+};
+declare function NotificationsWorkspace({ labels: labelsOverride, category, showPreferences, settingsHref, onSelectNotification, renderHeader, renderHeaderActions, renderAboveList, renderEmpty, className, }: NotificationsWorkspaceProps): react.JSX.Element;
+
+type NotificationChannelOption = {
+    readonly id: string;
+    readonly label: string;
+    /** O custo do canal, em uma linha. É o que faz alguém decidir em vez de chutar. */
+    readonly hint?: string;
+};
+type NotificationCategoryOption = {
+    readonly id: string;
+    readonly label: string;
+    readonly hint?: string;
+};
+type NotificationSettingsWorkspaceProps = {
+    readonly labels?: Partial<Record<string, string>>;
+    /** Os canais que ESTE produto oferece — o pacote despacha em cinco e não opina sobre quais usar. */
+    readonly channels: readonly NotificationChannelOption[];
+    /** Os assuntos que este produto dispara. */
+    readonly categories: readonly NotificationCategoryOption[];
+    /**
+     * Valores de exemplo do preview, por assunto do template. Ausente, o preview mostra campo vazio —
+     * que é honesto, mas menos útil para quem está escrevendo o texto.
+     */
+    readonly previewPayload?: Readonly<Record<string, unknown>>;
+    /** Traduz `order.status.preparing` no rótulo que o produto usa. Ausente, mostra a chave crua. */
+    readonly templateLabelOf?: (template: NotificationTemplate) => string;
+    /**
+     * Campo extra por canal — é onde entra o nome do template aprovado na Meta, que só o WhatsApp tem.
+     * Ausente, nenhum campo extra aparece.
+     */
+    readonly renderChannelFields?: (params: {
+        readonly channel: string;
+        readonly value: string;
+        readonly onChange: (value: string) => void;
+    }) => ReactNode;
+    /** Substitui o cabeçalho padrão — a página que já tem título próprio evita o segundo `<h1>`. */
+    readonly renderHeader?: () => ReactNode;
+    /** Ações do produto no cabeçalho. */
+    readonly renderHeaderActions?: () => ReactNode;
+    readonly className?: string;
+};
+declare function NotificationSettingsWorkspace({ labels: labelsOverride, channels, categories, previewPayload, templateLabelOf, renderChannelFields, renderHeader, renderHeaderActions, className, }: NotificationSettingsWorkspaceProps): react.JSX.Element;
+
+export { NotificationBell, type NotificationBellProps, type NotificationCategoryOption, type NotificationChannelOption, NotificationItem, type NotificationItemProps, NotificationList, type NotificationListProps, NotificationSettingsWorkspace, type NotificationSettingsWorkspaceProps, NotificationsWorkspace, type NotificationsWorkspaceProps, PreferencesPanel, type PreferencesPanelProps };