@nathapp/nestjs-notification 2.1.4 → 3.0.0-rc.4

package/dist/interface/payload.interface.d.ts

@@ -0,0 +1,71 @@
+import { DeviceToken } from '../push-notification';
+import { EmailAttachment } from './message.interface';
+import { SendResult } from './result.interface';
+export interface EmailNotificationPayload {
+    email: string;
+    templateCode: string;
+    options?: {
+        locale?: string;
+        fallbackLocal?: string;
+        args?: any;
+    };
+    attachments?: EmailAttachment[];
+}
+export interface PushNotificationPayload {
+    userId?: string | number;
+    deviceToken?: DeviceToken;
+    templateCode: string;
+    options?: {
+        locale?: string;
+        fallbackLocal?: string;
+        args?: any;
+    };
+}
+export type NotificationChannel = 'email' | 'push' | 'sms' | 'whatsapp';
+export interface NotificationPayload {
+    templateCode: string;
+    channels: NotificationChannel[];
+    fallback?: NotificationChannel[];
+    options?: {
+        locale?: string;
+        fallbackLocale?: string;
+        args?: any;
+    };
+    email?: string;
+    userId?: string | number;
+    deviceToken?: DeviceToken;
+    phoneNumber?: string;
+    countryIso2?: string;
+    dialCode?: string;
+    whatsappTemplateName?: string;
+    mediaUrl?: string;
+    attachments?: EmailAttachment[];
+}
+export interface SmsNotificationPayload {
+    phoneNumber: string;
+    templateCode: string;
+    options?: {
+        locale?: string;
+        fallbackLocale?: string;
+        args?: any;
+    };
+    countryIso2?: string;
+    dialCode?: string;
+}
+export interface WhatsAppNotificationPayload {
+    phoneNumber: string;
+    templateCode: string;
+    options?: {
+        locale?: string;
+        fallbackLocale?: string;
+        args?: any;
+    };
+    whatsappTemplateName?: string;
+    mediaUrl?: string;
+}
+export interface NotificationResult {
+    results: Partial<Record<NotificationChannel, SendResult>>;
+    success: boolean;
+    fallbackAttempted?: NotificationChannel[];
+    fallbackSucceeded?: NotificationChannel;
+}

package/dist/{push-notification/push-notification-module.interface.js → interface/payload.interface.js}

@@ -1,4 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-;
-//# sourceMappingURL=push-notification-module.interface.js.map
+//# sourceMappingURL=payload.interface.js.map

package/dist/interface/payload.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.interface.js","sourceRoot":"","sources":["../../lib/interface/payload.interface.ts"],"names":[],"mappings":""}

package/dist/interface/result.interface.d.ts

@@ -2,7 +2,8 @@ export interface SendResult {
     success: boolean;
     message?: string;
     requestId?: string;
-    extra?: any;
+    error?: unknown;
+    extra?: unknown;
 }
 export interface BatchSendResult {
     results: SendResult[];

package/dist/notification/errors.d.ts

@@ -0,0 +1,3 @@
+export declare class NotificationConfigError extends Error {
+    constructor(service: string);
+}

package/dist/notification/errors.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationConfigError = void 0;
+class NotificationConfigError extends Error {
+    constructor(service) {
+        super(`${service} is not configured. Configure it in NotificationModule or set strict: false.`);
+        this.name = 'NotificationConfigError';
+    }
+}
+exports.NotificationConfigError = NotificationConfigError;
+//# sourceMappingURL=errors.js.map

package/dist/notification/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../lib/notification/errors.ts"],"names":[],"mappings":";;;AAAA,MAAa,uBAAwB,SAAQ,KAAK;IAChD,YAAY,OAAe;QACzB,KAAK,CAAC,GAAG,OAAO,8EAA8E,CAAC,CAAC;QAChG,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;IACxC,CAAC;CACF;AALD,0DAKC"}

package/dist/notification/index.d.ts

@@ -1,4 +1,8 @@
 import { NOTIFICATION_OPTIONS, NOTIFICATION_SERVICE, TEMPLATE_SERVICE } from "./constant";
-import { NotificationModule, NotificationModuleOptions } from "./notification.module";
+import { NotificationModule, NotificationModuleAsyncOptions, NotificationModuleOptions, NotificationModuleOptionsFactory } from "./notification.module";
 import { NotificationService } from "./notification.service";
-export { NOTIFICATION_OPTIONS, NOTIFICATION_SERVICE, TEMPLATE_SERVICE, NotificationModule, NotificationModuleOptions, NotificationService, };
+import { NotificationConfigError } from "./errors";
+import { NotificationInterceptor, NotificationContext, NOTIFICATION_INTERCEPTORS } from "./notification.interceptor";
+import { ProviderConfig, ChannelProviderMap } from "./provider-config";
+import { NotificationProviderFactory } from "./notification-provider.factory";
+export { NOTIFICATION_OPTIONS, NOTIFICATION_SERVICE, TEMPLATE_SERVICE, NotificationModule, NotificationModuleOptions, NotificationModuleAsyncOptions, NotificationModuleOptionsFactory, NotificationService, NotificationConfigError, NotificationInterceptor, NotificationContext, NOTIFICATION_INTERCEPTORS, ProviderConfig, ChannelProviderMap, NotificationProviderFactory, };

package/dist/notification/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotificationService = exports.NotificationModule = exports.TEMPLATE_SERVICE = exports.NOTIFICATION_SERVICE = exports.NOTIFICATION_OPTIONS = void 0;
+exports.NotificationProviderFactory = exports.NOTIFICATION_INTERCEPTORS = exports.NotificationConfigError = exports.NotificationService = exports.NotificationModule = exports.TEMPLATE_SERVICE = exports.NOTIFICATION_SERVICE = exports.NOTIFICATION_OPTIONS = void 0;
 const constant_1 = require("./constant");
 Object.defineProperty(exports, "NOTIFICATION_OPTIONS", { enumerable: true, get: function () { return constant_1.NOTIFICATION_OPTIONS; } });
 Object.defineProperty(exports, "NOTIFICATION_SERVICE", { enumerable: true, get: function () { return constant_1.NOTIFICATION_SERVICE; } });
@@ -9,4 +9,10 @@ const notification_module_1 = require("./notification.module");
 Object.defineProperty(exports, "NotificationModule", { enumerable: true, get: function () { return notification_module_1.NotificationModule; } });
 const notification_service_1 = require("./notification.service");
 Object.defineProperty(exports, "NotificationService", { enumerable: true, get: function () { return notification_service_1.NotificationService; } });
+const errors_1 = require("./errors");
+Object.defineProperty(exports, "NotificationConfigError", { enumerable: true, get: function () { return errors_1.NotificationConfigError; } });
+const notification_interceptor_1 = require("./notification.interceptor");
+Object.defineProperty(exports, "NOTIFICATION_INTERCEPTORS", { enumerable: true, get: function () { return notification_interceptor_1.NOTIFICATION_INTERCEPTORS; } });
+const notification_provider_factory_1 = require("./notification-provider.factory");
+Object.defineProperty(exports, "NotificationProviderFactory", { enumerable: true, get: function () { return notification_provider_factory_1.NotificationProviderFactory; } });
 //# sourceMappingURL=index.js.map

package/dist/notification/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/notification/index.ts"],"names":[],"mappings":";;;AAAA,yCAA0F;AAKxF,qGALO,+BAAoB,OAKP;AACpB,qGAN6B,+BAAoB,OAM7B;AACpB,iGAPmD,2BAAgB,OAOnD;AANlB,+DAAwJ;AAOtJ,mGAPO,wCAAkB,OAOP;AANpB,iEAA6D;AAU3D,oGAVO,0CAAmB,OAUP"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/notification/index.ts"],"names":[],"mappings":";;;AAAA,yCAA0F;AASxF,qGATO,+BAAoB,OASP;AACpB,qGAV6B,+BAAoB,OAU7B;AACpB,iGAXmD,2BAAgB,OAWnD;AAVlB,+DAAwJ;AAWtJ,mGAXO,wCAAkB,OAWP;AAVpB,iEAA6D;AAc3D,oGAdO,0CAAmB,OAcP;AAbrB,qCAAmD;AAcjD,wGAdO,gCAAuB,OAcP;AAbzB,yEAAqH;AAgBnH,0GAhBqD,oDAAyB,OAgBrD;AAd3B,mFAA8E;AAiB5E,4GAjBO,2DAA2B,OAiBP"}

package/dist/notification/notification-provider.factory.d.ts

@@ -0,0 +1,5 @@
+import { ProviderConfig, ChannelProviderMap } from './provider-config';
+export declare class NotificationProviderFactory {
+    private static readonly logger;
+    static create<C extends keyof ChannelProviderMap>(config: ProviderConfig<C>): ChannelProviderMap[C];
+}

package/dist/notification/notification-provider.factory.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationProviderFactory = void 0;
+const common_1 = require("@nestjs/common");
+const email_1 = require("../email");
+const push_notification_1 = require("../push-notification");
+const sms_1 = require("../sms");
+const whatsapp_1 = require("../whatsapp");
+const CHANNEL_BASE_CLASSES = {
+    email: email_1.EmailProvider,
+    push: push_notification_1.PushNotificationProvider,
+    sms: sms_1.SmsProvider,
+    whatsapp: whatsapp_1.WhatsAppProvider,
+};
+class NotificationProviderFactory {
+    static create(config) {
+        const { channel, provider, options } = config;
+        const baseClass = CHANNEL_BASE_CLASSES[channel];
+        if (!baseClass) {
+            throw new Error(`Unknown notification channel: ${channel}`);
+        }
+        const instance = new provider(options);
+        if (!(instance instanceof baseClass)) {
+            throw new Error(`${provider.name} is not a valid ${channel} provider. ` +
+                `Expected ${baseClass.name} subclass.`);
+        }
+        this.logger.log(`Created ${channel} provider: ${provider.name}`);
+        return instance;
+    }
+}
+exports.NotificationProviderFactory = NotificationProviderFactory;
+NotificationProviderFactory.logger = new common_1.Logger(NotificationProviderFactory.name);
+//# sourceMappingURL=notification-provider.factory.js.map

package/dist/notification/notification-provider.factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-provider.factory.js","sourceRoot":"","sources":["../../lib/notification/notification-provider.factory.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AAExC,oCAAyC;AACzC,4DAAgE;AAChE,gCAAqC;AACrC,0CAA+C;AAK/C,MAAM,oBAAoB,GAA6B;IACrD,KAAK,EAAE,qBAAa;IACpB,IAAI,EAAE,4CAAwB;IAC9B,GAAG,EAAE,iBAAW;IAChB,QAAQ,EAAE,2BAAgB;CAC3B,CAAC;AAKF,MAAa,2BAA2B;IAoBtC,MAAM,CAAC,MAAM,CACX,MAAyB;QAEzB,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC9C,MAAM,SAAS,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAEhD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,iCAAiC,OAAO,EAAE,CAAC,CAAC;QAC9D,CAAC;QAGD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC;QAGvC,IAAI,CAAC,CAAC,QAAQ,YAAY,SAAS,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CACb,GAAG,QAAQ,CAAC,IAAI,mBAAmB,OAAO,aAAa;gBACvD,YAAY,SAAS,CAAC,IAAI,YAAY,CACvC,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,OAAO,cAAc,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QACjE,OAAO,QAAiC,CAAC;IAC3C,CAAC;;AA3CH,kEA4CC;AA3CyB,kCAAM,GAAG,IAAI,eAAM,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC"}

package/dist/notification/notification.interceptor.d.ts

@@ -0,0 +1,18 @@
+import { SendResult, NotificationChannel } from "../interface";
+export interface NotificationContext {
+    channel: NotificationChannel;
+    templateCode: string;
+    recipient: string;
+    resolvedMessage?: {
+        subject?: string;
+        content: string;
+    };
+    isFallback?: boolean;
+    failedChannel?: NotificationChannel;
+}
+export interface NotificationInterceptor {
+    beforeSend?(context: NotificationContext): Promise<NotificationContext> | NotificationContext;
+    afterSend?(context: NotificationContext, result: SendResult): Promise<void> | void;
+    onError?(context: NotificationContext, error: Error): Promise<void> | void;
+}
+export declare const NOTIFICATION_INTERCEPTORS = "NOTIFICATION_INTERCEPTORS";

package/dist/notification/notification.interceptor.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NOTIFICATION_INTERCEPTORS = void 0;
+exports.NOTIFICATION_INTERCEPTORS = 'NOTIFICATION_INTERCEPTORS';
+//# sourceMappingURL=notification.interceptor.js.map

package/dist/notification/notification.interceptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.interceptor.js","sourceRoot":"","sources":["../../lib/notification/notification.interceptor.ts"],"names":[],"mappings":";;;AAmBa,QAAA,yBAAyB,GAAG,2BAA2B,CAAC"}

package/dist/notification/notification.module.d.ts

@@ -1,39 +1,52 @@
 import { DynamicModule, ModuleMetadata, Type } from '@nestjs/common';
-import { EmailModuleAsyncOptions, EmailModuleOptions } from '../email';
-import { TemplateLoader } from '../template';
+import { TemplateLoader, TemplateEngine } from '../template';
 import { TemplateService } from '../template/template.service';
 import { NotificationService } from './notification.service';
-import { PushNotificationModuleAsyncOptions, PushNotificationModuleOptions } from '../push-notification';
+import { ProviderConfig } from './provider-config';
+import { ProviderManager } from '../push-notification/push-notification-provider.manager';
+import { UserTokenStore } from '../push-notification/user-token.store';
 export declare class NotificationModule {
     static forRoot(options: NotificationModuleOptions): DynamicModule;
-    static forRootAsync(options: NotificationModuleAsyncOptions): Promise<DynamicModule>;
+    static forRootAsync(options: NotificationModuleAsyncOptions): DynamicModule;
+    private static createChannelProviders;
+    private static groupProvidersByChannel;
+    private static createInterceptorProviders;
+    private static createTemplateEngine;
     private static createTemplateLoader;
     private static createTemplateService;
     private static createNotificationService;
-    private static santitizeOptions;
-    private static isEmailModuleAsyncOption;
-    private static isPushNotificationModuleAsyncOption;
+    private static createProviderManagerAsync;
+    private static createUserTokenStoreAsync;
+    private static sanitizeOptions;
     private static createAsyncOptionsProviders;
     private static createAsyncOptionsProvider;
 }
 export interface NotificationModuleOptions {
-    emailOptions?: EmailModuleOptions | EmailModuleAsyncOptions;
-    pushNotificationOptions?: PushNotificationModuleOptions | PushNotificationModuleAsyncOptions;
-    templateLoader: Type<TemplateLoader>;
+    providers?: ProviderConfig[];
+    templateLoader: Type<TemplateLoader> | ProviderAsyncOptions<TemplateLoader>;
+    templateEngine?: Type<TemplateEngine>;
     templateService?: Type<TemplateService>;
     notificationService?: Type<NotificationService>;
+    interceptors?: Type<any>[];
+    strict?: boolean;
+    providerManager?: Type<ProviderManager>;
+    userTokenStore?: Type<UserTokenStore>;
 }
-export type NotificationModuleOptionsWithoutProvider = Omit<NotificationModuleOptions, 'templateLoader' | 'templateService' | 'notificationService'>;
 export interface NotificationModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
-    emailOptions?: EmailModuleOptions | EmailModuleAsyncOptions;
-    pushNotificationOptions?: PushNotificationModuleOptions | PushNotificationModuleAsyncOptions;
-    useExisting?: Type<NotificationModuleOptionsFactory>;
     useClass?: Type<NotificationModuleOptionsFactory>;
-    useFactory?: (...args: any[]) => Promise<NotificationModuleOptionsWithoutProvider> | NotificationModuleOptionsWithoutProvider;
+    useExisting?: Type<NotificationModuleOptionsFactory>;
+    useFactory?: (...args: any[]) => NotificationModuleOptions | Promise<NotificationModuleOptions>;
     inject?: any[];
-    templateLoader: Type<TemplateLoader> | ProviderAsyncOptions<TemplateLoader>;
+    templateEngine?: Type<TemplateEngine> | ProviderAsyncOptions<TemplateEngine>;
+    templateLoader?: Type<TemplateLoader> | ProviderAsyncOptions<TemplateLoader>;
     templateService?: Type<TemplateService> | ProviderAsyncOptions<TemplateService>;
     notificationService?: Type<NotificationService> | ProviderAsyncOptions<NotificationService>;
+    interceptors?: Type<any>[];
+    providerManager?: Type<ProviderManager> | ProviderAsyncOptions<ProviderManager>;
+    userTokenStore?: Type<UserTokenStore> | ProviderAsyncOptions<UserTokenStore>;
+}
+export interface NotificationModuleOptionsFactory {
+    createOptions(): NotificationModuleOptions | Promise<NotificationModuleOptions>;
 }
 export interface ProviderAsyncOptions<T = any> extends Pick<ModuleMetadata, 'imports'> {
     useExisting?: Type<T>;
@@ -41,6 +54,3 @@ export interface ProviderAsyncOptions<T = any> extends Pick<ModuleMetadata, 'imp
     useFactory?: (...args: any[]) => T | Promise<T>;
     inject?: any[];
 }
-export interface NotificationModuleOptionsFactory {
-    createOptions(): NotificationModuleOptionsWithoutProvider | Promise<NotificationModuleOptionsWithoutProvider>;
-}