analytica-frontend-lib 1.1.35 → 1.1.37

package/dist/NotificationCard-IYDURfYp.d.mts

@@ -0,0 +1,402 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+/**
+ * Types for notification system
+ */
+/**
+ * Notification type enum
+ */
+type NotificationType = 'ACTIVITY' | 'TRAIL' | 'GOAL' | 'ANNOUNCEMENT' | 'GENERAL';
+/**
+ * Entity type for navigation
+ */
+declare enum NotificationEntityType {
+    ACTIVITY = "ACTIVITY",
+    TRAIL = "TRAIL",
+    GOAL = "GOAL"
+}
+/**
+ * Notification interface
+ */
+interface Notification {
+    /**
+     * Unique identifier for the notification
+     */
+    id: string;
+    /**
+     * Notification title
+     */
+    title: string;
+    /**
+     * Notification message content
+     */
+    message: string;
+    /**
+     * Type of notification
+     */
+    type: NotificationType;
+    /**
+     * Whether the notification has been read
+     */
+    isRead: boolean;
+    /**
+     * When the notification was created
+     */
+    createdAt: Date;
+    /**
+     * Type of entity this notification refers to (optional)
+     */
+    entityType?: NotificationEntityType | null;
+    /**
+     * ID of the entity this notification refers to (optional)
+     */
+    entityId?: string | null;
+    /**
+     * Sender information (optional)
+     */
+    sender?: {
+        id: string;
+        user: {
+            id: string;
+            name: string;
+            email: string;
+        };
+    } | null;
+    /**
+     * Activity information (optional)
+     */
+    activity?: {
+        id: string;
+        title: string;
+        type: string;
+    } | null;
+    /**
+     * Goal information (optional)
+     */
+    goal?: {
+        id: string;
+        title: string;
+    } | null;
+}
+/**
+ * Backend notification response from API
+ */
+interface BackendNotification {
+    id: string;
+    senderUserInstitutionId: string | null;
+    receiverUserInstitutionId: string;
+    title: string;
+    description: string;
+    entityType: string | null;
+    entityId: string | null;
+    read: boolean;
+    createdAt: string;
+    updatedAt: string;
+    sender?: {
+        id: string;
+        user: {
+            id: string;
+            name: string;
+            email: string;
+        };
+    } | null;
+    activity?: {
+        id: string;
+        title: string;
+        type: string;
+    } | null;
+    goal?: {
+        id: string;
+        title: string;
+    } | null;
+}
+/**
+ * API response for fetching notifications from backend
+ */
+interface BackendNotificationsResponse {
+    notifications: BackendNotification[];
+    pagination: {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+    };
+}
+/**
+ * API response for fetching notifications (frontend format)
+ */
+interface NotificationsResponse {
+    /**
+     * List of notifications
+     */
+    notifications: Notification[];
+    /**
+     * Total count of notifications
+     */
+    totalCount: number;
+    /**
+     * Count of unread notifications
+     */
+    unreadCount: number;
+    /**
+     * Whether there are more notifications to load
+     */
+    hasMore: boolean;
+}
+/**
+ * Parameters for fetching notifications
+ */
+interface FetchNotificationsParams {
+    /**
+     * Page number for pagination
+     */
+    page?: number;
+    /**
+     * Number of items per page
+     */
+    limit?: number;
+    /**
+     * Filter by read status
+     */
+    read?: boolean;
+    /**
+     * Filter by entity type
+     */
+    entityType?: string;
+}
+/**
+ * Notification grouped by time period
+ */
+interface NotificationGroup {
+    /**
+     * Group label (e.g., "Hoje", "Última semana")
+     */
+    label: string;
+    /**
+     * Notifications in this group
+     */
+    notifications: Notification[];
+}
+/**
+ * API client interface for dependency injection
+ */
+interface NotificationApiClient {
+    get: <T>(url: string, config?: {
+        params?: Record<string, unknown>;
+    }) => Promise<{
+        data: T;
+    }>;
+    patch: <T>(url: string, data?: Record<string, unknown>) => Promise<{
+        data: T;
+    }>;
+    delete: <T>(url: string) => Promise<{
+        data: T;
+    }>;
+}
+
+interface NotificationItem extends Omit<Notification, 'createdAt'> {
+    time: string;
+    createdAt: string | Date;
+}
+interface BaseNotificationProps {
+    /**
+     * Additional CSS classes
+     */
+    className?: string;
+    /**
+     * Empty state image path
+     */
+    emptyStateImage?: string;
+    /**
+     * Empty state title
+     */
+    emptyStateTitle?: string;
+    /**
+     * Empty state description
+     */
+    emptyStateDescription?: string;
+}
+interface SingleNotificationCardMode extends BaseNotificationProps {
+    /**
+     * Component mode - single card
+     */
+    mode: 'single';
+    /**
+     * The notification title
+     */
+    title: string;
+    /**
+     * The notification message content
+     */
+    message: string;
+    /**
+     * Time displayed (e.g., "Há 3h", "12 Fev")
+     */
+    time: string;
+    /**
+     * Whether the notification has been read
+     */
+    isRead: boolean;
+    /**
+     * Callback when user marks notification as read
+     */
+    onMarkAsRead: () => void;
+    /**
+     * Callback when user deletes notification
+     */
+    onDelete: () => void;
+    /**
+     * Optional callback for navigation action
+     */
+    onNavigate?: () => void;
+    /**
+     * Label for the action button (only shown if onNavigate is provided)
+     */
+    actionLabel?: string;
+}
+interface NotificationListMode extends BaseNotificationProps {
+    /**
+     * Component mode - list
+     */
+    mode: 'list';
+    /**
+     * Array of notifications for list mode
+     */
+    notifications?: NotificationItem[];
+    /**
+     * Array of grouped notifications
+     */
+    groupedNotifications?: NotificationGroup[];
+    /**
+     * Loading state for list mode
+     */
+    loading?: boolean;
+    /**
+     * Error state for list mode
+     */
+    error?: string | null;
+    /**
+     * Callback for retry when error occurs
+     */
+    onRetry?: () => void;
+    /**
+     * Callback when user marks a notification as read in list mode
+     */
+    onMarkAsReadById?: (id: string) => void;
+    /**
+     * Callback when user deletes a notification in list mode
+     */
+    onDeleteById?: (id: string) => void;
+    /**
+     * Callback when user navigates from a notification in list mode
+     */
+    onNavigateById?: (entityType?: NotificationEntityType, entityId?: string) => void;
+    /**
+     * Function to get action label for a notification
+     */
+    getActionLabel?: (entityType?: NotificationEntityType) => string | undefined;
+    /**
+     * Custom empty state component
+     */
+    renderEmpty?: () => ReactNode;
+}
+interface NotificationCenterMode extends BaseNotificationProps {
+    /**
+     * Component mode - center
+     */
+    mode: 'center';
+    /**
+     * Array of grouped notifications
+     */
+    groupedNotifications?: NotificationGroup[];
+    /**
+     * Loading state for center mode
+     */
+    loading?: boolean;
+    /**
+     * Error state for center mode
+     */
+    error?: string | null;
+    /**
+     * Callback for retry when error occurs
+     */
+    onRetry?: () => void;
+    /**
+     * Whether center mode is currently active (controls dropdown/modal visibility)
+     */
+    isActive?: boolean;
+    /**
+     * Callback when center mode is toggled
+     */
+    onToggleActive?: () => void;
+    /**
+     * Number of unread notifications for badge display
+     */
+    unreadCount?: number;
+    /**
+     * Callback when all notifications should be marked as read
+     */
+    onMarkAllAsRead?: () => void;
+    /**
+     * Callback to fetch notifications (called when center opens)
+     */
+    onFetchNotifications?: () => void;
+    /**
+     * Callback when user marks a notification as read in center mode
+     */
+    onMarkAsReadById?: (id: string) => void;
+    /**
+     * Callback when user deletes a notification in center mode
+     */
+    onDeleteById?: (id: string) => void;
+    /**
+     * Callback when user navigates from a notification in center mode
+     */
+    onNavigateById?: (entityType?: NotificationEntityType, entityId?: string) => void;
+    /**
+     * Function to get action label for a notification
+     */
+    getActionLabel?: (entityType?: NotificationEntityType) => string | undefined;
+}
+type NotificationCardProps = SingleNotificationCardMode | NotificationListMode | NotificationCenterMode;
+interface LegacyNotificationCardProps extends BaseNotificationProps {
+    title?: string;
+    message?: string;
+    time?: string;
+    isRead?: boolean;
+    onMarkAsRead?: () => void;
+    onDelete?: () => void;
+    onNavigate?: () => void;
+    actionLabel?: string;
+    notifications?: NotificationItem[];
+    groupedNotifications?: NotificationGroup[];
+    loading?: boolean;
+    error?: string | null;
+    onRetry?: () => void;
+    onMarkAsReadById?: (id: string) => void;
+    onDeleteById?: (id: string) => void;
+    onNavigateById?: (entityType?: NotificationEntityType, entityId?: string) => void;
+    getActionLabel?: (entityType?: NotificationEntityType) => string | undefined;
+    renderEmpty?: () => ReactNode;
+    variant?: 'card' | 'center';
+    isActive?: boolean;
+    onToggleActive?: () => void;
+    unreadCount?: number;
+    onMarkAllAsRead?: () => void;
+    onFetchNotifications?: () => void;
+}
+/**
+ * NotificationCard component - can display single notification, list of notifications, or center mode
+ *
+ * @param props - The notification card properties
+ * @returns JSX element representing the notification card, list, or center
+ */
+declare const NotificationCard: (props: NotificationCardProps) => react_jsx_runtime.JSX.Element;
+/**
+ * Legacy NotificationCard component for backward compatibility
+ * Automatically detects mode based on provided props
+ */
+declare const LegacyNotificationCard: (props: LegacyNotificationCardProps) => react_jsx_runtime.JSX.Element;
+
+export { type BackendNotification as B, type FetchNotificationsParams as F, type LegacyNotificationCardProps as L, type NotificationApiClient as N, type Notification as a, type NotificationGroup as b, NotificationCard as c, type NotificationItem as d, NotificationEntityType as e, type NotificationType as f, type BackendNotificationsResponse as g, type NotificationsResponse as h, type NotificationCardProps as i, LegacyNotificationCard as j };