@novu/js 2.0.1 → 2.1.1

package/dist/cjs/ui/index.d.ts

@@ -0,0 +1,145 @@
+import { t as Notification, s as NovuOptions, b as Novu } from '../novu-04KlkBy4.js';
+import * as solid_js from 'solid-js';
+import { ComponentProps } from 'solid-js';
+import { MountableElement } from 'solid-js/web';
+import '@novu/client';
+
+declare const defaultLocalization: {
+    readonly locale: "en-US";
+    readonly 'inbox.filters.dropdownOptions.unread': "Unread only";
+    readonly 'inbox.filters.dropdownOptions.default': "Unread & read";
+    readonly 'inbox.filters.dropdownOptions.archived': "Archived";
+    readonly 'inbox.filters.labels.unread': "Unread";
+    readonly 'inbox.filters.labels.default': "Inbox";
+    readonly 'inbox.filters.labels.archived': "Archived";
+    readonly 'notifications.emptyNotice': "No notifications";
+    readonly 'notifications.actions.readAll': "Mark all as read";
+    readonly 'notifications.actions.archiveAll': "Archive all";
+    readonly 'notifications.actions.archiveRead': "Archive read";
+    readonly 'notifications.newNotifications': ({ notificationCount }: {
+        notificationCount: number;
+    }) => string;
+    readonly 'notification.actions.read.tooltip': "Mark as read";
+    readonly 'notification.actions.unread.tooltip': "Mark as unread";
+    readonly 'notification.actions.archive.tooltip': "Archive";
+    readonly 'notification.actions.unarchive.tooltip': "Unarchive";
+    readonly 'preferences.title': "Notification Preferences";
+    readonly 'preferences.global': "Global Preferences";
+    readonly 'preferences.workflow.disabled.notice': "Contact admin to enable subscription management for this critical notification.";
+    readonly 'preferences.workflow.disabled.tooltip': "Contact admin to edit";
+};
+
+declare const appearanceKeys: readonly ["button", "popoverContent", "popoverTrigger", "dropdownContent", "dropdownTrigger", "dropdownItem", "dropdownItemLabel", "dropdownItemLabelContainer", "dropdownItemLeftIcon", "dropdownItemRightIcon", "tooltipContent", "tooltipTrigger", "back__button", "skeletonText", "skeletonAvatar", "tabsRoot", "tabsList", "tabsContent", "tabsTrigger", "dots", "root", "bellIcon", "bellContainer", "bellDot", "preferences__button", "preferencesContainer", "inboxHeader", "loading", "inboxContent", "inbox__popoverTrigger", "inbox__popoverContent", "notificationListContainer", "notificationList", "notificationListEmptyNoticeContainer", "notificationListEmptyNotice", "notificationListEmptyNoticeIcon", "notificationListNewNotificationsNotice__button", "notification", "notificationDot", "notificationSubject", "notificationSubject__strong", "notificationBody", "notificationBody__strong", "notificationBodyContainer", "notificationImage", "notificationDate", "notificationDefaultActions", "notificationCustomActions", "notificationPrimaryAction__button", "notificationSecondaryAction__button", "notificationRead__button", "notificationUnread__button", "notificationArchive__button", "notificationUnarchive__button", "notificationsTabs__tabsRoot", "notificationsTabs__tabsList", "notificationsTabs__tabsContent", "notificationsTabs__tabsTrigger", "notificationsTabsTriggerLabel", "notificationsTabsTriggerCount", "inboxStatus__title", "inboxStatus__dropdownTrigger", "inboxStatus__dropdownContent", "inboxStatus__dropdownItem", "inboxStatus__dropdownItemLabel", "inboxStatus__dropdownItemLabelContainer", "inboxStatus__dropdownItemLeft__icon", "inboxStatus__dropdownItemRight__icon", "moreActionsContainer", "moreActions__dropdownTrigger", "moreActions__dropdownContent", "moreActions__dropdownItem", "moreActions__dropdownItemLabel", "moreActions__dropdownItemLeft__icon", "moreActions__dots", "moreTabs__button", "moreTabs__dots", "moreTabs__dropdownTrigger", "moreTabs__dropdownContent", "moreTabs__dropdownItem", "moreTabs__dropdownItemLabel", "moreTabs__dropdownItemRight__icon", "workflowContainer", "workflowLabel", "workflowLabelContainer", "workflowContainerDisabledNotice", "workflowLabelDisabled__icon", "workflowContainerRight__icon", "workflowArrow__icon", "channelContainer", "channelsContainer", "channelLabel", "channelLabelContainer", "channelDescription", "channelName", "channelSwitchContainer", "channelSwitch", "channelSwitchThumb", "preferencesHeader", "preferencesHeader__back__button", "preferencesHeader__title", "preferencesLoadingContainer", "strong"];
+
+type LocalizationKey = keyof typeof defaultLocalization;
+type Localization = {
+    [K in LocalizationKey]?: (typeof defaultLocalization)[K] extends (...args: infer P) => any ? ((...args: P) => ReturnType<(typeof defaultLocalization)[K]>) | string : string;
+} & {
+    dynamic?: Record<string, string>;
+};
+
+type NotificationClickHandler = (notification: Notification) => void;
+type NotificationActionClickHandler = (notification: Notification) => void;
+type NotificationRenderer = (el: HTMLDivElement, notification: Notification) => () => void;
+type BellRenderer = (el: HTMLDivElement, unreadCount: number) => () => void;
+type RouterPush = (path: string) => void;
+type Tab = {
+    label: string;
+    value: Array<string>;
+};
+type CSSProperties = {
+    [key: string]: string | number;
+};
+type ElementStyles = string | CSSProperties;
+type Variables = {
+    colorBackground?: string;
+    colorForeground?: string;
+    colorPrimary?: string;
+    colorPrimaryForeground?: string;
+    colorSecondary?: string;
+    colorSecondaryForeground?: string;
+    colorCounter?: string;
+    colorCounterForeground?: string;
+    colorNeutral?: string;
+    fontSize?: string;
+    borderRadius?: string;
+};
+type AppearanceKey = (typeof appearanceKeys)[number];
+type Elements = Partial<Record<AppearanceKey, ElementStyles>>;
+type Theme = {
+    variables?: Variables;
+    elements?: Elements;
+};
+type Appearance = Theme & {
+    baseTheme?: Theme | Theme[];
+};
+type BaseNovuProviderProps = {
+    appearance?: Appearance;
+    localization?: Localization;
+    options: NovuOptions;
+    tabs?: Array<Tab>;
+    routerPush?: RouterPush;
+    novu?: Novu;
+};
+type NovuProviderProps = BaseNovuProviderProps & {
+    renderNotification?: NotificationRenderer;
+    renderBell?: BellRenderer;
+};
+declare enum NotificationStatus {
+    UNREAD_READ = "unreadRead",
+    UNREAD = "unread",
+    ARCHIVED = "archived"
+}
+
+type InboxProps = {
+    open?: boolean;
+    renderNotification?: NotificationRenderer;
+    renderBell?: BellRenderer;
+    onNotificationClick?: NotificationClickHandler;
+    onPrimaryActionClick?: NotificationActionClickHandler;
+    onSecondaryActionClick?: NotificationActionClickHandler;
+};
+declare enum InboxPage {
+    Notifications = "notifications",
+    Preferences = "preferences"
+}
+type InboxContentProps = {
+    renderNotification?: NotificationRenderer;
+    onNotificationClick?: NotificationClickHandler;
+    onPrimaryActionClick?: NotificationActionClickHandler;
+    onSecondaryActionClick?: NotificationActionClickHandler;
+    initialPage?: InboxPage;
+    hideNav?: boolean;
+};
+
+declare const novuComponents: {
+    Inbox: (props: InboxProps) => solid_js.JSX.Element;
+    Bell: solid_js.Component<{
+        renderBell?: BellRenderer | undefined;
+    }>;
+    Notifications: (props: Omit<InboxContentProps, 'hideNav' | 'initialPage'>) => solid_js.JSX.Element;
+    Preferences: (props: Omit<InboxContentProps, 'hideNav' | 'initialPage'>) => solid_js.JSX.Element;
+};
+type NovuComponentName = keyof typeof novuComponents;
+
+type NovuUIOptions = NovuProviderProps;
+type BaseNovuUIOptions = BaseNovuProviderProps;
+declare class NovuUI {
+    #private;
+    id: string;
+    constructor(props: NovuProviderProps);
+    mountComponent<T extends NovuComponentName>({ name, element, props: componentProps, }: {
+        name: T;
+        element: MountableElement;
+        props?: ComponentProps<(typeof novuComponents)[T]>;
+    }): void;
+    unmountComponent(element: MountableElement): void;
+    updateAppearance(appearance?: Appearance): void;
+    updateLocalization(localization?: Localization): void;
+    updateOptions(options: NovuOptions): void;
+    updateTabs(tabs?: Array<Tab>): void;
+    updateRouterPush(routerPush?: RouterPush): void;
+    unmount(): void;
+}
+
+export { type Appearance, type AppearanceKey, type BaseNovuProviderProps, type BaseNovuUIOptions, type BellRenderer, type CSSProperties, type ElementStyles, type Elements, InboxPage, type InboxProps, type Localization, type LocalizationKey, Notification, type NotificationActionClickHandler, type NotificationClickHandler, type NotificationRenderer, NotificationStatus, type NovuProviderProps, NovuUI, type NovuUIOptions, type RouterPush, type Tab, type Theme, type Variables };