@novu/js 2.6.6 → 3.0.0-canary.1

package/dist/cjs/index.d.ts

@@ -1,5 +1,5 @@
-import { N as NotificationFilter } from './novu-DbpFmjhC.js';
-export { k as Action, A as ActionTypeEnum, m as ChannelPreference, f as ChannelType, C as CtaType, E as EventHandler, a as Events, F as FiltersCountResponse, q as IPreferenceOverride, I as InboxNotification, L as ListNotificationsResponse, i as MessageAction, M as MessageButton, u as Notification, e as NotificationActionStatus, d as NotificationButton, c as NotificationStatus, b as Novu, w as NovuError, s as NovuOptions, n as PaginatedResponse, v as Preference, P as PreferenceLevel, g as PreferenceOverrideSource, p as PreferenceOverrideSourceEnum, o as PreferencesResponse, t as Prettify, R as Redirect, r as Result, h as Session, S as SocketEventNames, j as Subscriber, T as TODO, W as WebSocketEvent, l as Workflow } from './novu-DbpFmjhC.js';
+import { N as NotificationFilter } from './novu-C2hAbM3b.js';
+export { k as Action, A as ActionTypeEnum, m as ChannelPreference, f as ChannelType, C as CtaType, E as EventHandler, a as Events, F as FiltersCountResponse, q as IPreferenceOverride, I as InboxNotification, L as ListNotificationsResponse, i as MessageAction, M as MessageButton, u as Notification, e as NotificationActionStatus, d as NotificationButton, c as NotificationStatus, b as Novu, w as NovuError, s as NovuOptions, n as PaginatedResponse, v as Preference, P as PreferenceLevel, g as PreferenceOverrideSource, p as PreferenceOverrideSourceEnum, o as PreferencesResponse, t as Prettify, R as Redirect, r as Result, h as Session, S as SocketEventNames, j as Subscriber, T as TODO, W as WebSocketEvent, l as Workflow } from './novu-C2hAbM3b.js';
 
 declare const areTagsEqual: (tags1?: string[], tags2?: string[]) => boolean;
 declare const isSameFilter: (filter1: NotificationFilter, filter2: NotificationFilter) => boolean;

package/dist/cjs/index.js

@@ -1,59 +1,59 @@
 'use strict';
 
-var chunkZ4XIR64I_js = require('./chunk-Z4XIR64I.js');
+var chunkZA235BHP_js = require('./chunk-ZA235BHP.js');
 require('./chunk-7B52C2XE.js');
 
 
 
 Object.defineProperty(exports, "ActionTypeEnum", {
   enumerable: true,
-  get: function () { return chunkZ4XIR64I_js.ActionTypeEnum; }
+  get: function () { return chunkZA235BHP_js.ActionTypeEnum; }
 });
 Object.defineProperty(exports, "ChannelType", {
   enumerable: true,
-  get: function () { return chunkZ4XIR64I_js.ChannelType; }
+  get: function () { return chunkZA235BHP_js.ChannelType; }
 });
 Object.defineProperty(exports, "CtaType", {
   enumerable: true,
-  get: function () { return chunkZ4XIR64I_js.CtaType; }
+  get: function () { return chunkZA235BHP_js.CtaType; }
 });
 Object.defineProperty(exports, "NotificationActionStatus", {
   enumerable: true,
-  get: function () { return chunkZ4XIR64I_js.NotificationActionStatus; }
+  get: function () { return chunkZA235BHP_js.NotificationActionStatus; }
 });
 Object.defineProperty(exports, "NotificationButton", {
   enumerable: true,
-  get: function () { return chunkZ4XIR64I_js.NotificationButton; }
+  get: function () { return chunkZA235BHP_js.NotificationButton; }
 });
 Object.defineProperty(exports, "NotificationStatus", {
   enumerable: true,
-  get: function () { return chunkZ4XIR64I_js.NotificationStatus; }
+  get: function () { return chunkZA235BHP_js.NotificationStatus; }
 });
 Object.defineProperty(exports, "Novu", {
   enumerable: true,
-  get: function () { return chunkZ4XIR64I_js.Novu; }
+  get: function () { return chunkZA235BHP_js.Novu; }
 });
 Object.defineProperty(exports, "PreferenceLevel", {
   enumerable: true,
-  get: function () { return chunkZ4XIR64I_js.PreferenceLevel; }
+  get: function () { return chunkZA235BHP_js.PreferenceLevel; }
 });
 Object.defineProperty(exports, "PreferenceOverrideSource", {
   enumerable: true,
-  get: function () { return chunkZ4XIR64I_js.PreferenceOverrideSource; }
+  get: function () { return chunkZA235BHP_js.PreferenceOverrideSource; }
 });
 Object.defineProperty(exports, "PreferenceOverrideSourceEnum", {
   enumerable: true,
-  get: function () { return chunkZ4XIR64I_js.PreferenceOverrideSourceEnum; }
+  get: function () { return chunkZA235BHP_js.PreferenceOverrideSourceEnum; }
 });
 Object.defineProperty(exports, "WebSocketEvent", {
   enumerable: true,
-  get: function () { return chunkZ4XIR64I_js.WebSocketEvent; }
+  get: function () { return chunkZA235BHP_js.WebSocketEvent; }
 });
 Object.defineProperty(exports, "areTagsEqual", {
   enumerable: true,
-  get: function () { return chunkZ4XIR64I_js.areTagsEqual; }
+  get: function () { return chunkZA235BHP_js.areTagsEqual; }
 });
 Object.defineProperty(exports, "isSameFilter", {
   enumerable: true,
-  get: function () { return chunkZ4XIR64I_js.isSameFilter; }
+  get: function () { return chunkZA235BHP_js.isSameFilter; }
 });

package/dist/{esm/novu-DbpFmjhC.d.mts → cjs/novu-C2hAbM3b.d.ts}

@@ -9,6 +9,7 @@ type ListPreferencesArgs = {
 type UpdatePreferencesArgs = {
     workflowId?: string;
     channels: ChannelPreference;
+    /** @deprecated Use channels instead */
     channelPreferences?: ChannelPreference;
     preference?: {
         level: PreferenceLevel;
@@ -44,7 +45,9 @@ declare class Preference {
         cache: PreferencesCache;
         useCache: boolean;
     });
-    update({ channels, channelPreferences, }: Prettify<Pick<UpdatePreferencesArgs, 'channels' | 'channelPreferences'>>): Result<Preference>;
+    update({ channels, 
+    /** @deprecated Use channels instead */
+    channelPreferences, }: Prettify<Pick<UpdatePreferencesArgs, 'channels' | 'channelPreferences'>>): Result<Preference>;
 }
 
 declare enum NotificationStatus {
@@ -192,13 +195,12 @@ type NovuOptions = {
     applicationIdentifier: string;
     subscriberId: string;
     subscriberHash?: string;
+    /** @deprecated Use apiUrl instead  */
     backendUrl?: string;
     apiUrl?: string;
     socketUrl?: string;
     useCache?: boolean;
-    /**
-     * @internal Should be used internally
-     */
+    /** @internal Should be used internally for testing purposes */
     __userAgent?: string;
 };
 type Prettify<T> = {
@@ -538,10 +540,24 @@ declare class Preferences extends BaseModule {
     list(args?: ListPreferencesArgs): Result<Preference[]>;
 }
 
+declare class Socket extends BaseModule {
+    #private;
+    constructor({ socketUrl, inboxServiceInstance, eventEmitterInstance, }: {
+        socketUrl?: string;
+        inboxServiceInstance: InboxService;
+        eventEmitterInstance: NovuEventEmitter;
+    });
+    protected onSessionSuccess({ token }: Session): void;
+    isSocketEvent(eventName: string): eventName is SocketEventNames;
+    connect(): Result<void>;
+    disconnect(): Result<void>;
+}
+
 declare class Novu implements Pick<NovuEventEmitter, 'on'> {
     #private;
     readonly notifications: Notifications;
     readonly preferences: Preferences;
+    readonly socket: Socket;
     on: <Key extends EventNames>(eventName: Key, listener: EventHandler<Events[Key]>) => () => void;
     /**
      * @deprecated

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

@@ -1,5 +1,5 @@
-import { g as Theme } from '../types-B8jOWXQS.js';
-import '../novu-DbpFmjhC.js';
+import { h as Theme } from '../types-CKkldJh0.js';
+import '../novu-C2hAbM3b.js';
 
 declare const dark: Theme;
 

package/dist/cjs/themes/index.js

@@ -6,11 +6,12 @@ require('../chunk-7B52C2XE.js');
 var dark = {
   variables: {
     colorNeutral: "white",
-    colorBackground: "#161618",
+    colorBackground: "#1A1A1A",
     colorForeground: "#EDEDEF",
-    colorSecondary: "#7E7D86",
+    colorSecondary: "#383838",
     colorSecondaryForeground: "#EDEDEF",
-    colorShadow: "black"
+    colorShadow: "black",
+    colorRing: "#E1E4EA"
   }
 };
 

package/dist/cjs/types-CKkldJh0.d.ts

@@ -0,0 +1,102 @@
+import { u as Notification, N as NotificationFilter, s as NovuOptions, b as Novu } from './novu-C2hAbM3b.js';
+
+declare const appearanceKeys: readonly ["button", "icon", "popoverContent", "popoverTrigger", "dropdownContent", "dropdownTrigger", "dropdownItem", "dropdownItemLabel", "dropdownItemLabelContainer", "dropdownItemLeft__icon", "dropdownItemRight__icon", "dropdownItem__icon", "collapsible", "tooltipContent", "tooltipTrigger", "back__button", "skeletonText", "skeletonAvatar", "skeletonSwitch", "skeletonSwitchThumb", "tabsRoot", "tabsList", "tabsContent", "tabsTrigger", "dots", "root", "bellIcon", "bellContainer", "bellDot", "preferences__button", "preferencesContainer", "inboxHeader", "loading", "inboxContent", "inbox__popoverTrigger", "inbox__popoverContent", "notificationListContainer", "notificationList", "notificationListEmptyNoticeContainer", "notificationListEmptyNoticeOverlay", "notificationListEmptyNoticeIcon", "notificationListEmptyNotice", "notificationList__skeleton", "notificationList__skeletonContent", "notificationList__skeletonItem", "notificationList__skeletonAvatar", "notificationList__skeletonText", "notificationListNewNotificationsNotice__button", "notification", "notificationContent", "notificationTextContainer", "notificationDot", "notificationSubject", "notificationSubject__strong", "notificationBody", "notificationBody__strong", "notificationBodyContainer", "notificationImage", "notificationImageLoadingFallback", "notificationDate", "notificationDateActionsContainer", "notificationDefaultActions", "notificationCustomActions", "notificationPrimaryAction__button", "notificationSecondaryAction__button", "notificationRead__button", "notificationUnread__button", "notificationArchive__button", "notificationUnarchive__button", "notificationRead__icon", "notificationUnread__icon", "notificationArchive__icon", "notificationUnarchive__icon", "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", "inboxStatus__dropdownItem__icon", "inboxStatus__dropdownItemCheck__icon", "moreActionsContainer", "moreActions__dropdownTrigger", "moreActions__dropdownContent", "moreActions__dropdownItem", "moreActions__dropdownItemLabel", "moreActions__dropdownItemLeft__icon", "moreActions__dots", "moreTabs__button", "moreTabs__icon", "moreTabs__dropdownTrigger", "moreTabs__dropdownContent", "moreTabs__dropdownItem", "moreTabs__dropdownItemLabel", "moreTabs__dropdownItemRight__icon", "workflowContainer", "workflowLabel", "workflowLabelHeader", "workflowLabelContainer", "workflowContainerDisabledNotice", "workflowLabelDisabled__icon", "workflowContainerRight__icon", "workflowArrow__icon", "workflowDescription", "channelContainer", "channelIconContainer", "channel__icon", "channelsContainerCollapsible", "channelsContainer", "channelLabel", "channelLabelContainer", "channelName", "channelSwitchContainer", "channelSwitch", "channelSwitchThumb", "preferencesHeader", "preferencesHeader__back__button", "preferencesHeader__back__button__icon", "preferencesHeader__title", "preferencesHeader__icon", "preferencesListEmptyNoticeContainer", "preferencesListEmptyNotice", "preferencesList__skeleton", "preferencesList__skeletonContent", "preferencesList__skeletonItem", "preferencesList__skeletonIcon", "preferencesList__skeletonSwitch", "preferencesList__skeletonSwitchThumb", "preferencesList__skeletonText", "strong"];
+
+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': "Quiet for now. Check back later.";
+    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': "Preferences";
+    readonly 'preferences.emptyNotice': "No notification specific preferences yet.";
+    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";
+};
+
+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 SubjectRenderer = (el: HTMLDivElement, notification: Notification) => () => void;
+type BodyRenderer = (el: HTMLDivElement, notification: Notification) => () => void;
+type BellRenderer = (el: HTMLDivElement, unreadCount: number) => () => void;
+type RouterPush = (path: string) => void;
+type Tab = {
+    label: string;
+    /**
+     * @deprecated Use `filter` instead
+     */
+    value?: Array<string>;
+    filter?: Pick<NotificationFilter, 'tags'>;
+};
+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;
+    colorShadow?: string;
+    colorRing?: string;
+    fontSize?: string;
+    borderRadius?: string;
+};
+type AppearanceKey = (typeof appearanceKeys)[number];
+type Elements = Partial<Record<AppearanceKey, ElementStyles>>;
+type Theme = {
+    variables?: Variables;
+    elements?: Elements;
+    animations?: boolean;
+};
+type Appearance = Theme & {
+    baseTheme?: Theme | Theme[];
+};
+type BaseNovuProviderProps = {
+    appearance?: Appearance;
+    localization?: Localization;
+    options: NovuOptions;
+    tabs?: Array<Tab>;
+    preferencesFilter?: PreferencesFilter;
+    routerPush?: RouterPush;
+    novu?: Novu;
+};
+type NovuProviderProps = BaseNovuProviderProps & {
+    renderNotification?: NotificationRenderer;
+    renderBell?: BellRenderer;
+};
+declare enum NotificationStatus {
+    UNREAD_READ = "unreadRead",
+    UNREAD = "unread",
+    ARCHIVED = "archived"
+}
+type PreferencesFilter = Pick<NotificationFilter, 'tags'>;
+
+export { type Appearance as A, type BellRenderer as B, type CSSProperties as C, type ElementStyles as E, type Localization as L, type NotificationClickHandler as N, type PreferencesFilter as P, type RouterPush as R, type SubjectRenderer as S, type Tab as T, type Variables as V, type NotificationActionClickHandler as a, type NotificationRenderer as b, type BodyRenderer as c, type NovuProviderProps as d, type BaseNovuProviderProps as e, type AppearanceKey as f, type Elements as g, type Theme as h, NotificationStatus as i, type LocalizationKey as j };

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

@@ -1,34 +1,47 @@
-import { s as NovuOptions } from '../novu-DbpFmjhC.js';
-export { u as Notification } from '../novu-DbpFmjhC.js';
-import { N as NotificationRenderer, B as BellRenderer, a as NotificationClickHandler, b as NotificationActionClickHandler, c as NovuProviderProps, d as BaseNovuProviderProps, A as Appearance, L as Localization, T as Tab, P as PreferencesFilter, R as RouterPush } from '../types-B8jOWXQS.js';
-export { e as AppearanceKey, C as CSSProperties, E as ElementStyles, f as Elements, i as LocalizationKey, h as NotificationStatus, g as Theme, V as Variables } from '../types-B8jOWXQS.js';
+import { s as NovuOptions } from '../novu-C2hAbM3b.js';
+export { u as Notification } from '../novu-C2hAbM3b.js';
+import { B as BellRenderer, N as NotificationClickHandler, a as NotificationActionClickHandler, b as NotificationRenderer, S as SubjectRenderer, c as BodyRenderer, d as NovuProviderProps, e as BaseNovuProviderProps, A as Appearance, L as Localization, T as Tab, P as PreferencesFilter, R as RouterPush } from '../types-CKkldJh0.js';
+export { f as AppearanceKey, C as CSSProperties, E as ElementStyles, g as Elements, j as LocalizationKey, i as NotificationStatus, h as Theme, V as Variables } from '../types-CKkldJh0.js';
 import { Placement, OffsetOptions } from '@floating-ui/dom';
 import * as solid_js from 'solid-js';
 import { ComponentProps } from 'solid-js';
 import { MountableElement } from 'solid-js/web';
 
+type NotificationRendererProps = {
+    renderNotification: NotificationRenderer;
+    renderSubject?: never;
+    renderBody?: never;
+};
+type SubjectBodyRendererProps = {
+    renderNotification?: never;
+    renderSubject?: SubjectRenderer;
+    renderBody?: BodyRenderer;
+};
+type NoRendererProps = {
+    renderNotification?: undefined;
+    renderSubject?: undefined;
+    renderBody?: undefined;
+};
 type InboxProps = {
     open?: boolean;
-    renderNotification?: NotificationRenderer;
     renderBell?: BellRenderer;
     onNotificationClick?: NotificationClickHandler;
     onPrimaryActionClick?: NotificationActionClickHandler;
     onSecondaryActionClick?: NotificationActionClickHandler;
     placement?: Placement;
     placementOffset?: OffsetOptions;
-};
+} & (NotificationRendererProps | SubjectBodyRendererProps | NoRendererProps);
 declare enum InboxPage {
     Notifications = "notifications",
     Preferences = "preferences"
 }
 type InboxContentProps = {
-    renderNotification?: NotificationRenderer;
     onNotificationClick?: NotificationClickHandler;
     onPrimaryActionClick?: NotificationActionClickHandler;
     onSecondaryActionClick?: NotificationActionClickHandler;
     initialPage?: InboxPage;
     hideNav?: boolean;
-};
+} & (NotificationRendererProps | SubjectBodyRendererProps | NoRendererProps);
 
 declare const novuComponents: {
     Inbox: (props: InboxProps) => solid_js.JSX.Element;
@@ -62,4 +75,4 @@ declare class NovuUI {
     unmount(): void;
 }
 
-export { Appearance, BaseNovuProviderProps, type BaseNovuUIOptions, BellRenderer, InboxPage, type InboxProps, Localization, NotificationActionClickHandler, NotificationClickHandler, NotificationRenderer, NovuProviderProps, NovuUI, type NovuUIOptions, PreferencesFilter, RouterPush, Tab };
+export { Appearance, BaseNovuProviderProps, type BaseNovuUIOptions, BellRenderer, BodyRenderer, InboxPage, type InboxProps, Localization, NotificationActionClickHandler, NotificationClickHandler, NotificationRenderer, NovuProviderProps, NovuUI, type NovuUIOptions, PreferencesFilter, RouterPush, SubjectRenderer, Tab };