@platform-x/hep-push-notification-client 1.0.0 → 1.0.1

package/README.md

@@ -1,10 +1,44 @@
-#@platform-x/hep-push-notification-client
+# @platform-x/hep-push-notification-client
 Provide module to push notifications to the users.
 
-How to install and use
+## Installation
 
+```bash
 npm install @platform-x/hep-push-notification-client
+```
 
-import the modules and implement.
- const fcmClient: any = new pushNotificationProvider(sitename);
- await fcmClient.fetchTopics(type);
+## Quick Start
+
+```typescript
+import { 
+  initPushNotificationWithExternalMongo, 
+  initPushNotificationSecrets,
+  pushNotificationManager 
+} from '@platform-x/hep-push-notification-client';
+import mongoose from 'mongoose';
+
+// Initialize with your existing mongoose connection
+initPushNotificationWithExternalMongo(mongoose);
+
+// Initialize secrets
+initPushNotificationSecrets(yourSecretService);
+
+// Use the notification manager
+const manager = new pushNotificationManager();
+const client = await manager.pushNotificationProvider('sitename');
+await client.fetchTopics(type);
+```
+
+## MongoDB Integration
+
+**Important**: This package requires MongoDB connection initialization to avoid duplicate connections when used in services that already have MongoDB setup.
+
+📖 **See [MONGODB_INTEGRATION.md](./MONGODB_INTEGRATION.md) for detailed MongoDB integration guide**
+
+## Usage
+
+import the modules and implement:
+```typescript
+const fcmClient: any = new pushNotificationProvider(sitename);
+await fcmClient.fetchTopics(type);
+```

package/dist/src/PushNotificationManager.d.ts

@@ -1,9 +1,9 @@
-/**
- * Push Notification Manager - supports multiple providers
- * Currently implemented: FCM
- * Future providers: SAP_EMARSYS
- */
-export declare class pushNotificationManager {
-    private notificationProvider;
-    pushNotificationProvider(sitename: string): Promise<any>;
-}
+/**
+ * Push Notification Manager - supports multiple providers
+ * Currently implemented: FCM
+ * Future providers: SAP_EMARSYS
+ */
+export declare class pushNotificationManager {
+    private notificationProvider;
+    pushNotificationProvider(sitename: string): Promise<any>;
+}

package/dist/src/PushNotificationManager.js

@@ -1,56 +1,56 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pushNotificationManager = void 0;
-const logger_1 = require("./common/util/logger");
-const constants_1 = require("./platform-x/constants");
-const fcmservices_1 = require("./platform-x/services/fcmservices");
-const site_domain_dao_1 = __importDefault(require("./platform-x/database/dao/site_domain.dao"));
-/**
- * Push Notification Manager - supports multiple providers
- * Currently implemented: FCM
- * Future providers: SAP_EMARSYS
- */
-class pushNotificationManager {
-    pushNotificationProvider(sitename) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
-            try {
-                logger_1.Logger.info('pushNotificationManager: Reached pushNotificationProvider', 'pushNotificationProvider');
-                let pushConfig = yield new site_domain_dao_1.default().details({ sitename });
-                let pushNotifyProvider = (_c = (_b = (_a = pushConfig === null || pushConfig === void 0 ? void 0 : pushConfig.providers) === null || _a === void 0 ? void 0 : _a.notification) === null || _b === void 0 ? void 0 : _b.active) !== null && _c !== void 0 ? _c : constants_1.PROVIDERS.FCM;
-                logger_1.Logger.info(`pushNotificationManager: Initializing the provider for client ${sitename}`, '');
-                switch (pushNotifyProvider) {
-                    case constants_1.PROVIDERS.FCM:
-                        this.notificationProvider = yield fcmservices_1.FcmClient.fcmClientObject(sitename);
-                        logger_1.Logger.info('pushNotificationManager: Initialized with FCM provider', 'constructor');
-                        break;
-                    case constants_1.PROVIDERS.SAP_EMARSYS:
-                        // Implement the SAP emarsys client initialization here
-                        logger_1.Logger.info('pushNotificationManager: Initialized with SAP_EMARSYS provider', 'constructor');
-                        break;
-                    default:
-                        throw new Error(`Unsupported provider: ${pushNotifyProvider}. Supported providers: ${Object.values(constants_1.PROVIDERS).join(', ')}`);
-                }
-                return this.notificationProvider;
-            }
-            catch (err) {
-                logger_1.Logger.error('pushNotificationManager: Error in pushNotificationManager', 'pushNotificationManager', err);
-                throw err;
-            }
-        });
-    }
-}
-exports.pushNotificationManager = pushNotificationManager;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pushNotificationManager = void 0;
+const logger_1 = require("./common/util/logger");
+const constants_1 = require("./platform-x/constants");
+const fcmservices_1 = require("./platform-x/services/fcmservices");
+const site_domain_dao_1 = __importDefault(require("./platform-x/database/dao/site_domain.dao"));
+/**
+ * Push Notification Manager - supports multiple providers
+ * Currently implemented: FCM
+ * Future providers: SAP_EMARSYS
+ */
+class pushNotificationManager {
+    pushNotificationProvider(sitename) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            try {
+                logger_1.Logger.info('pushNotificationManager: Reached pushNotificationProvider', 'pushNotificationProvider');
+                let pushConfig = yield new site_domain_dao_1.default().details({ sitename });
+                let pushNotifyProvider = (_c = (_b = (_a = pushConfig === null || pushConfig === void 0 ? void 0 : pushConfig.providers) === null || _a === void 0 ? void 0 : _a.notification) === null || _b === void 0 ? void 0 : _b.active) !== null && _c !== void 0 ? _c : constants_1.PROVIDERS.FCM;
+                logger_1.Logger.info(`pushNotificationManager: Initializing the provider for client ${sitename}`, '');
+                switch (pushNotifyProvider) {
+                    case constants_1.PROVIDERS.FCM:
+                        this.notificationProvider = yield fcmservices_1.FcmClient.fcmClientObject(sitename);
+                        logger_1.Logger.info('pushNotificationManager: Initialized with FCM provider', 'constructor');
+                        break;
+                    case constants_1.PROVIDERS.SAP_EMARSYS:
+                        // Implement the SAP emarsys client initialization here
+                        logger_1.Logger.info('pushNotificationManager: Initialized with SAP_EMARSYS provider', 'constructor');
+                        break;
+                    default:
+                        throw new Error(`Unsupported provider: ${pushNotifyProvider}. Supported providers: ${Object.values(constants_1.PROVIDERS).join(', ')}`);
+                }
+                return this.notificationProvider;
+            }
+            catch (err) {
+                logger_1.Logger.error('pushNotificationManager: Error in pushNotificationManager', 'pushNotificationManager', err);
+                throw err;
+            }
+        });
+    }
+}
+exports.pushNotificationManager = pushNotificationManager;
 //# sourceMappingURL=PushNotificationManager.js.map

package/dist/src/common/util/commonUtil.d.ts

@@ -1,6 +1,12 @@
-/**
- * base64ToString - to convert base64 into string
- * @param {string} toDecode- string base64 request
- */
-export declare const base64ToString: (toDecode: string) => string;
-export declare function getDynamicSecretdata(sitename: any, providerName: any, secretKey: any): Promise<string>;
+/**
+ * base64ToString - to convert base64 into string
+ * @param {string} toDecode- string base64 request
+ */
+export declare const base64ToString: (toDecode: string) => string;
+export declare function getDynamicSecretdata(sitename: any, providerName: any, secretKey: any): Promise<string>;
+/**
+ * Validate that MongoDB connection is properly initialized for server startup
+ * If no external MongoDB connection is found, it will initialize its own connection
+ * Call this during your server startup to ensure proper MongoDB configuration
+ */
+export declare const validateMongoInitialization: () => Promise<boolean>;

package/dist/src/common/util/commonUtil.js

@@ -1,43 +1,68 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.base64ToString = void 0;
-exports.getDynamicSecretdata = getDynamicSecretdata;
-const __1 = require("../..");
-const constants_1 = require("../../platform-x/constants");
-const logger_1 = require("./logger");
-/**
- * base64ToString - to convert base64 into string
- * @param {string} toDecode- string base64 request
- */
-const base64ToString = (toDecode) => {
-    return Buffer.from(toDecode, 'base64').toString('ascii');
-};
-exports.base64ToString = base64ToString;
-function getDynamicSecretdata(sitename, providerName, secretKey) {
-    return __awaiter(this, void 0, void 0, function* () {
-        logger_1.Logger.info(`commonUtils.ts : getDynamicSecretdata reached  ${{ sitename, providerName, secretKey }}`, 'getDynamicSecretdata');
-        const secretValue = yield (0, __1.getPushNotificationSecrets)();
-        const defaultData = constants_1.DynamicValues === null || constants_1.DynamicValues === void 0 ? void 0 : constants_1.DynamicValues.DEFAULT;
-        const targetKey = `${sitename}_${providerName}_${secretKey}`.toUpperCase();
-        const fallbackKey = `${defaultData}_${providerName}_${secretKey}`.toUpperCase();
-        logger_1.Logger.info('Target Key: ', 'getDynamicSecretdata');
-        logger_1.Logger.info('Fallback Key: ', 'getDynamicSecretdata');
-        let finalValue = secretValue.hasOwnProperty(targetKey) ? secretValue[targetKey] : secretValue[fallbackKey];
-        if (!finalValue || finalValue == '') {
-            logger_1.Logger.info(`Target Key not found, using fallback key: ${fallbackKey}`, 'getDynamicSecretdata');
-            finalValue = secretValue[fallbackKey];
-        }
-        logger_1.Logger.info('Final Value fetched', 'getDynamicSecretdata');
-        return finalValue;
-    });
-}
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateMongoInitialization = exports.base64ToString = void 0;
+exports.getDynamicSecretdata = getDynamicSecretdata;
+const __1 = require("../..");
+const constants_1 = require("../../platform-x/constants");
+const logger_1 = require("./logger");
+const connection_1 = __importDefault(require("../../platform-x/database/connection"));
+/**
+ * base64ToString - to convert base64 into string
+ * @param {string} toDecode- string base64 request
+ */
+const base64ToString = (toDecode) => {
+    return Buffer.from(toDecode, 'base64').toString('ascii');
+};
+exports.base64ToString = base64ToString;
+function getDynamicSecretdata(sitename, providerName, secretKey) {
+    return __awaiter(this, void 0, void 0, function* () {
+        logger_1.Logger.info(`commonUtils.ts : getDynamicSecretdata reached  ${{ sitename, providerName, secretKey }}`, 'getDynamicSecretdata');
+        const secretValue = yield (0, __1.getPushNotificationSecrets)();
+        const defaultData = constants_1.DynamicValues === null || constants_1.DynamicValues === void 0 ? void 0 : constants_1.DynamicValues.DEFAULT;
+        const targetKey = `${sitename}_${providerName}_${secretKey}`.toUpperCase();
+        const fallbackKey = `${defaultData}_${providerName}_${secretKey}`.toUpperCase();
+        logger_1.Logger.info('Target Key: ', 'getDynamicSecretdata');
+        logger_1.Logger.info('Fallback Key: ', 'getDynamicSecretdata');
+        let finalValue = secretValue.hasOwnProperty(targetKey) ? secretValue[targetKey] : secretValue[fallbackKey];
+        if (!finalValue || finalValue == '') {
+            logger_1.Logger.info(`Target Key not found, using fallback key: ${fallbackKey}`, 'getDynamicSecretdata');
+            finalValue = secretValue[fallbackKey];
+        }
+        logger_1.Logger.info('Final Value fetched', 'getDynamicSecretdata');
+        return finalValue;
+    });
+}
+/**
+ * Validate that MongoDB connection is properly initialized for server startup
+ * If no external MongoDB connection is found, it will initialize its own connection
+ * Call this during your server startup to ensure proper MongoDB configuration
+ */
+const validateMongoInitialization = () => __awaiter(void 0, void 0, void 0, function* () {
+    // Check if MongoDB connection exists and is connected
+    if (!connection_1.default.database || connection_1.default.database.readyState !== 1) {
+        // If no external connection, try to initialize own connection
+        if (!connection_1.default.isUsingExternalConnection()) {
+            logger_1.Logger.info('Push Notification Package: No external MongoDB connection found, initializing own connection', 'validatePackageInitialization');
+            yield connection_1.default.connect();
+        }
+        else {
+            throw new Error('Push Notification Package: MongoDB connection not initialized. Please call initPushNotificationWithExternalMongo() or initPushNotificationWithOwnMongo() before starting the server.');
+        }
+    }
+    logger_1.Logger.info('Push Notification Package: MongoDB validation passed - package is properly initialized', 'validatePackageInitialization');
+    return true;
+});
+exports.validateMongoInitialization = validateMongoInitialization;
 //# sourceMappingURL=commonUtil.js.map

package/dist/src/common/util/errorHandler.d.ts

@@ -1,41 +1,41 @@
-export declare const enum HTTP_STATUS_CODE {
-    INTERNAL_SERVER_ERROR = 500
-}
-export declare const HTTP_STATUS_MAP: Map<number, string>;
-export declare const enum HTTP_STATUS_TYPE {
-    INTERNAL_SERVER_ERROR = "Internal Server Error"
-}
-export declare class CommonErrorTemplate extends Error {
-    code: number;
-    type: string;
-    constructor(msg: string, code?: number);
-    toJSON(): {
-        code: number;
-        type: string;
-        message: string;
-    };
-}
-export declare class ApiError extends CommonErrorTemplate {
-    constructor(msg: string, code?: number);
-}
-export declare class CustomError {
-    code: number | undefined;
-    type: string | undefined;
-    message: string | undefined;
-    stack: string | undefined;
-    errorObj: Error | undefined | null;
-    constructor(errObj?: any, code?: number, type?: string, message?: string, stack?: string);
-    toJSON(): {
-        code: number | undefined;
-        type: string | undefined;
-        message: string | undefined;
-    };
-}
-/**
- * errorMapper - to map error object to custom error
- */
-export declare const errorMapper: (err: any, statusCode?: number, type?: string) => any;
-/**
- * throwError - to throw custome error
- */
-export declare const throwError: (err: any, statusCode?: number, type?: string) => never;
+export declare const enum HTTP_STATUS_CODE {
+    INTERNAL_SERVER_ERROR = 500
+}
+export declare const HTTP_STATUS_MAP: Map<number, string>;
+export declare const enum HTTP_STATUS_TYPE {
+    INTERNAL_SERVER_ERROR = "Internal Server Error"
+}
+export declare class CommonErrorTemplate extends Error {
+    code: number;
+    type: string;
+    constructor(msg: string, code?: number);
+    toJSON(): {
+        code: number;
+        type: string;
+        message: string;
+    };
+}
+export declare class ApiError extends CommonErrorTemplate {
+    constructor(msg: string, code?: number);
+}
+export declare class CustomError {
+    code: number | undefined;
+    type: string | undefined;
+    message: string | undefined;
+    stack: string | undefined;
+    errorObj: Error | undefined | null;
+    constructor(errObj?: any, code?: number, type?: string, message?: string, stack?: string);
+    toJSON(): {
+        code: number | undefined;
+        type: string | undefined;
+        message: string | undefined;
+    };
+}
+/**
+ * errorMapper - to map error object to custom error
+ */
+export declare const errorMapper: (err: any, statusCode?: number, type?: string) => any;
+/**
+ * throwError - to throw custome error
+ */
+export declare const throwError: (err: any, statusCode?: number, type?: string) => never;

package/dist/src/common/util/errorHandler.js

@@ -1,81 +1,81 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.throwError = exports.errorMapper = exports.CustomError = exports.ApiError = exports.CommonErrorTemplate = exports.HTTP_STATUS_MAP = void 0;
-exports.HTTP_STATUS_MAP = new Map([
-    [500, 'Internal Server Error']
-]);
-class CommonErrorTemplate extends Error {
-    constructor(msg, code) {
-        super(msg);
-        this.code = code || 500 /* HTTP_STATUS_CODE.INTERNAL_SERVER_ERROR */;
-        this.type =
-            exports.HTTP_STATUS_MAP.get(this.code) || "Internal Server Error" /* HTTP_STATUS_TYPE.INTERNAL_SERVER_ERROR */;
-    }
-    toJSON() {
-        return {
-            code: this.code,
-            type: this.type,
-            message: this.message,
-        };
-    }
-}
-exports.CommonErrorTemplate = CommonErrorTemplate;
-class ApiError extends CommonErrorTemplate {
-    constructor(msg, code) {
-        super(msg, code);
-        this.name = 'ApiError';
-        Error.captureStackTrace(this, ApiError);
-    }
-}
-exports.ApiError = ApiError;
-class CustomError {
-    constructor(errObj, code, type, message, stack) {
-        this.code = code;
-        this.type = type;
-        this.message = message;
-        this.stack = stack;
-        this.errorObj = errObj;
-    }
-    toJSON() {
-        // NOSONAR
-        return {
-            code: this.code,
-            type: this.type,
-            message: this.message,
-        };
-    }
-}
-exports.CustomError = CustomError;
-/**
- * errorMapper - to map error object to custom error
- */
-const errorMapper = (err, statusCode, type) => {
-    let error;
-    let customError;
-    let code = statusCode || 500 /* HTTP_STATUS_CODE.INTERNAL_SERVER_ERROR */;
-    let errorType = type || exports.HTTP_STATUS_MAP.get(code) || "Internal Server Error" /* HTTP_STATUS_TYPE.INTERNAL_SERVER_ERROR */;
-    if (typeof err === 'string') {
-        error = new Error(err);
-        customError = new CustomError(null, code, errorType, error.message, error.stack);
-        return customError;
-    }
-    else if (err.stack &&
-        err.message &&
-        !(err instanceof CustomError) &&
-        !err.toJSON) {
-        customError = new CustomError(null, code, errorType, err.message, err.stack);
-        return customError;
-    }
-    else {
-        return err;
-    }
-};
-exports.errorMapper = errorMapper;
-/**
- * throwError - to throw custome error
- */
-const throwError = (err, statusCode, type) => {
-    throw (0, exports.errorMapper)(err, statusCode, type);
-};
-exports.throwError = throwError;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwError = exports.errorMapper = exports.CustomError = exports.ApiError = exports.CommonErrorTemplate = exports.HTTP_STATUS_MAP = void 0;
+exports.HTTP_STATUS_MAP = new Map([
+    [500, 'Internal Server Error']
+]);
+class CommonErrorTemplate extends Error {
+    constructor(msg, code) {
+        super(msg);
+        this.code = code || 500 /* HTTP_STATUS_CODE.INTERNAL_SERVER_ERROR */;
+        this.type =
+            exports.HTTP_STATUS_MAP.get(this.code) || "Internal Server Error" /* HTTP_STATUS_TYPE.INTERNAL_SERVER_ERROR */;
+    }
+    toJSON() {
+        return {
+            code: this.code,
+            type: this.type,
+            message: this.message,
+        };
+    }
+}
+exports.CommonErrorTemplate = CommonErrorTemplate;
+class ApiError extends CommonErrorTemplate {
+    constructor(msg, code) {
+        super(msg, code);
+        this.name = 'ApiError';
+        Error.captureStackTrace(this, ApiError);
+    }
+}
+exports.ApiError = ApiError;
+class CustomError {
+    constructor(errObj, code, type, message, stack) {
+        this.code = code;
+        this.type = type;
+        this.message = message;
+        this.stack = stack;
+        this.errorObj = errObj;
+    }
+    toJSON() {
+        // NOSONAR
+        return {
+            code: this.code,
+            type: this.type,
+            message: this.message,
+        };
+    }
+}
+exports.CustomError = CustomError;
+/**
+ * errorMapper - to map error object to custom error
+ */
+const errorMapper = (err, statusCode, type) => {
+    let error;
+    let customError;
+    let code = statusCode || 500 /* HTTP_STATUS_CODE.INTERNAL_SERVER_ERROR */;
+    let errorType = type || exports.HTTP_STATUS_MAP.get(code) || "Internal Server Error" /* HTTP_STATUS_TYPE.INTERNAL_SERVER_ERROR */;
+    if (typeof err === 'string') {
+        error = new Error(err);
+        customError = new CustomError(null, code, errorType, error.message, error.stack);
+        return customError;
+    }
+    else if (err.stack &&
+        err.message &&
+        !(err instanceof CustomError) &&
+        !err.toJSON) {
+        customError = new CustomError(null, code, errorType, err.message, err.stack);
+        return customError;
+    }
+    else {
+        return err;
+    }
+};
+exports.errorMapper = errorMapper;
+/**
+ * throwError - to throw custome error
+ */
+const throwError = (err, statusCode, type) => {
+    throw (0, exports.errorMapper)(err, statusCode, type);
+};
+exports.throwError = throwError;
 //# sourceMappingURL=errorHandler.js.map