@kipicore/dbcore 1.1.665 → 1.1.667

package/dist/configs/env.d.ts

@@ -59,4 +59,6 @@ export declare const ENV_VARIABLE: {
         API_KEY: any;
         ENDPOINT: any;
     };
+    REDIS_HOST: any;
+    DUMMY_EMAIL_DOMAIN: any;
 };

package/dist/configs/env.js

@@ -102,6 +102,8 @@ const envValidation = joi_1.default.object()
     PHONEPE_PASSWORD: joi_1.default.string().optional(),
     GOOGLEPAY_API_KEY: joi_1.default.string().optional(),
     GOOGLEPAY_ENDPOINT: joi_1.default.string().optional(),
+    REDIS_HOST: joi_1.default.string().optional(),
+    DUMMY_EMAIL_DOMAIN: joi_1.default.string().optional(),
 })
     .unknown();
 const { value: envVar, error } = envValidation.prefs({ errors: { label: 'key' } }).validate(process.env);
@@ -170,4 +172,6 @@ exports.ENV_VARIABLE = {
         API_KEY: envVar.GOOGLEPAY_API_KEY,
         ENDPOINT: envVar.GOOGLEPAY_ENDPOINT,
     },
+    REDIS_HOST: envVar.REDIS_HOST,
+    DUMMY_EMAIL_DOMAIN: envVar.DUMMY_EMAIL_DOMAIN,
 };

package/dist/configs/index.d.ts

@@ -1,2 +1,4 @@
 export * from './aws';
 export * from './env';
+export * from './logger';
+export * from './redisConfig';

package/dist/configs/index.js

@@ -16,3 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./aws"), exports);
 __exportStar(require("./env"), exports);
+__exportStar(require("./logger"), exports);
+__exportStar(require("./redisConfig"), exports);

package/dist/configs/logger.d.ts

@@ -0,0 +1,2 @@
+import winston from 'winston';
+export declare const logger: winston.Logger;

package/dist/configs/logger.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const winston_1 = __importDefault(require("winston"));
+const winston_daily_rotate_file_1 = __importDefault(require("winston-daily-rotate-file"));
+const env_1 = require("../configs/env");
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const enumerateErrorFormat = winston_1.default.format((info) => {
+    if (info.message instanceof Error) {
+        info.message = {
+            message: info.message.message,
+            stack: info.message.stack,
+            ...info.message,
+        };
+    }
+    if (info instanceof Error) {
+        return {
+            // message: info.message,
+            stack: info.stack,
+            ...info,
+        };
+    }
+    return info;
+});
+const transport = new winston_daily_rotate_file_1.default({
+    filename: env_1.ENV_VARIABLE.LOG_FOLDER + env_1.ENV_VARIABLE.LOG_FILE,
+    datePattern: 'YYYY-MM-DD',
+    zippedArchive: true,
+    maxSize: '20m',
+    maxFiles: '3',
+    // prepend: true,
+});
+exports.logger = winston_1.default.createLogger({
+    format: winston_1.default.format.combine(enumerateErrorFormat(), winston_1.default.format.json()),
+    transports: [
+        transport,
+        new winston_1.default.transports.Console({
+            level: 'info',
+        }),
+    ],
+});

package/dist/configs/redisConfig.d.ts

@@ -0,0 +1,4 @@
+import Redis from 'ioredis';
+declare const redisClient: Redis;
+export declare const connectRedis: () => Promise<void>;
+export default redisClient;

package/dist/configs/redisConfig.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.connectRedis = void 0;
+const ioredis_1 = __importDefault(require("ioredis"));
+const logger_1 = require("./logger");
+const env_1 = require("./env");
+// const redisClient = new Redis(ENV_VARIABLE.REDIS_URL, {
+//     maxRetriesPerRequest: null,
+// });
+const redisClient = new ioredis_1.default({
+    host: env_1.ENV_VARIABLE.REDIS_HOST || 'redis',
+    port: 6379,
+    maxRetriesPerRequest: null,
+});
+redisClient.on('error', err => {
+    console.error('Redis Client Error', err);
+    logger_1.logger.error(err);
+});
+const connectRedis = async () => {
+    // ioredis connects automatically, but we can check the status
+    if (redisClient.status === 'ready')
+        return;
+    return new Promise((resolve, reject) => {
+        redisClient.once('ready', () => resolve());
+        redisClient.once('error', err => reject(err));
+    });
+};
+exports.connectRedis = connectRedis;
+exports.default = redisClient;

package/dist/db/psql/migrations/20260721000002-change-uploaded-from-enum-to-string-in-file-storage.d.ts

@@ -0,0 +1,2 @@
+export function up(queryInterface: any, Sequelize: any): Promise<void>;
+export function down(queryInterface: any, Sequelize: any): Promise<void>;

package/dist/db/psql/migrations/20260721000002-change-uploaded-from-enum-to-string-in-file-storage.js

@@ -0,0 +1,42 @@
+'use strict';
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        const table = await queryInterface.describeTable('file_storage');
+        if (table.uploaded_from) {
+            // In PostgreSQL, changing from ENUM to VARCHAR requires a USING clause
+            try {
+                await queryInterface.sequelize.query('ALTER TABLE file_storage ALTER COLUMN uploaded_from TYPE VARCHAR(255) USING uploaded_from::varchar;');
+                await queryInterface.changeColumn('file_storage', 'uploaded_from', {
+                    type: Sequelize.STRING,
+                    allowNull: true,
+                });
+            }
+            catch (error) {
+                // Fallback if the raw query fails
+                await queryInterface.changeColumn('file_storage', 'uploaded_from', {
+                    type: Sequelize.STRING,
+                    allowNull: true,
+                });
+            }
+        }
+    },
+    down: async (queryInterface, Sequelize) => {
+        const table = await queryInterface.describeTable('file_storage');
+        if (table.uploaded_from) {
+            try {
+                await queryInterface.sequelize.query('ALTER TABLE file_storage ALTER COLUMN uploaded_from TYPE "enum_file_storage_uploaded_from" USING uploaded_from::text::"enum_file_storage_uploaded_from";');
+                await queryInterface.changeColumn('file_storage', 'uploaded_from', {
+                    type: Sequelize.ENUM('INSTITUTE_APP', 'SCHOOL_APP', 'GLOBAL_APP', 'STUDENT_APP', 'VENDOR_APP'),
+                    allowNull: false,
+                });
+            }
+            catch (error) {
+                // Fallback
+                await queryInterface.changeColumn('file_storage', 'uploaded_from', {
+                    type: Sequelize.ENUM('INSTITUTE_APP', 'SCHOOL_APP', 'GLOBAL_APP', 'STUDENT_APP', 'VENDOR_APP'),
+                    allowNull: false,
+                });
+            }
+        }
+    }
+};

package/dist/helpers/index.d.ts

@@ -1,2 +1,5 @@
 export * from './s3Uploader';
 export * from './utils';
+export * from './sendEmail';
+export * from './sendNotification';
+export * from './sendSMS';

package/dist/helpers/index.js

@@ -16,3 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./s3Uploader"), exports);
 __exportStar(require("./utils"), exports);
+__exportStar(require("./sendEmail"), exports);
+__exportStar(require("./sendNotification"), exports);
+__exportStar(require("./sendSMS"), exports);

package/dist/helpers/sendEmail.d.ts

@@ -0,0 +1,3 @@
+import { IEmailOptions } from '../index';
+export declare const sendEmailDirect: (emailOptions: IEmailOptions) => Promise<void>;
+export declare const sendEmail: (emailOptions: IEmailOptions) => Promise<void>;

package/dist/helpers/sendEmail.js

@@ -0,0 +1,117 @@
+"use strict";
+// import nodemailer, { Transporter } from 'nodemailer';
+// import { IEmailOptions } from '@kipicore/dbcore';
+// import { ENV_VARIABLE } from '../configs/env';
+// import { emailQueue } from '../queues/emailQueue';
+// import { logger } from '../configs/logger';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendEmail = exports.sendEmailDirect = void 0;
+// const hasDummyEmail = (to: string | string[]): boolean => {
+//     if (Array.isArray(to)) {
+//         return to.some(email => email.toLowerCase().endsWith(ENV_VARIABLE.DUMMY_EMAIL_DOMAIN));
+//     }
+//     return to.toLowerCase().endsWith(ENV_VARIABLE.DUMMY_EMAIL_DOMAIN);
+// };
+// export const sendEmailDirect = async (emailOptions: IEmailOptions): Promise<void> => {
+//     if (hasDummyEmail(emailOptions.to)) {
+//         logger.info(`Skipping email for dummy address: ${emailOptions.to}`);
+//         return;
+//     }
+//     // Configure the transporter with type annotations
+//     const transporter: Transporter = nodemailer.createTransport({
+//         host: ENV_VARIABLE.SMTP_SERVER, // e.g., 'smtp.gmail.com' for Gmail
+//         port: ENV_VARIABLE.SMTP_PORT,
+//         secure: true, // true for 465, false for other ports
+//         auth: {
+//             user: ENV_VARIABLE.SMTP_USER, // Your email address
+//             pass: ENV_VARIABLE.SMTP_PASS, // Your email password
+//         },
+//     });
+//     if (!emailOptions.from) emailOptions.from = ENV_VARIABLE.SMTP_EMAIL;
+//     try {
+//         // Send the email
+//         const info = await transporter.sendMail(emailOptions);
+//         return info;
+//     } catch (err) {
+//         // Handle errors
+//         console.error('Error sending email:', err);
+//         throw err;
+//     }
+// };
+// export const sendEmail = async (emailOptions: IEmailOptions): Promise<void> => {
+//     try {
+//         if (hasDummyEmail(emailOptions.to)) {
+//             logger.info(`Skipping email for dummy address: ${emailOptions.to}`);
+//             return;
+//         }
+//         await emailQueue.add('send-email', emailOptions);
+//         logger.info(`Email added to queue for: ${emailOptions.to}`);
+//     } catch (error) {
+//         logger.error('Error adding email to queue:', error);
+//         // Fallback to direct sending if queue fails (optional, but safer)
+//         await sendEmailDirect(emailOptions);
+//     }
+// };
+const client_ses_1 = require("@aws-sdk/client-ses");
+const index_1 = require("../index");
+const env_1 = require("../configs/env");
+const emailQueue_1 = require("../queues/emailQueue");
+const logger_1 = require("../configs/logger");
+const hasDummyEmail = (to) => {
+    if (Array.isArray(to)) {
+        return to.some(email => email.toLowerCase().endsWith(env_1.ENV_VARIABLE.DUMMY_EMAIL_DOMAIN));
+    }
+    return to.toLowerCase().endsWith(env_1.ENV_VARIABLE.DUMMY_EMAIL_DOMAIN);
+};
+const sendEmailDirect = async (emailOptions) => {
+    if (hasDummyEmail(emailOptions.to)) {
+        logger_1.logger.info(`Skipping email for dummy address: ${emailOptions.to}`);
+        return;
+    }
+    const ses = await index_1.awsClient.ses();
+    if (!emailOptions.from) {
+        emailOptions.from = env_1.ENV_VARIABLE.SMTP_EMAIL;
+    }
+    try {
+        const command = new client_ses_1.SendEmailCommand({
+            Source: emailOptions.from || 'kipiverseproject@gmail.com',
+            Destination: {
+                ToAddresses: Array.isArray(emailOptions.to) ? emailOptions.to : [emailOptions.to],
+                CcAddresses: (emailOptions.cc || []),
+                BccAddresses: (emailOptions.bcc || []),
+            },
+            Message: {
+                Subject: {
+                    Data: emailOptions.subject,
+                },
+                Body: {
+                    Html: emailOptions.html ? { Data: emailOptions.html } : undefined,
+                    Text: emailOptions.text ? { Data: emailOptions.text } : undefined,
+                },
+            },
+        });
+        await ses.send(command);
+        logger_1.logger.info(`Email sent via SES to: ${emailOptions.to}`);
+    }
+    catch (err) {
+        logger_1.logger.error('Error sending email via SES:', err);
+        throw err;
+    }
+};
+exports.sendEmailDirect = sendEmailDirect;
+const sendEmail = async (emailOptions) => {
+    try {
+        if (hasDummyEmail(emailOptions.to)) {
+            logger_1.logger.info(`Skipping email for dummy address: ${emailOptions.to}`);
+            return;
+        }
+        await emailQueue_1.emailQueue.add('send-email', emailOptions);
+        logger_1.logger.info(`Email added to queue for: ${emailOptions.to}`);
+    }
+    catch (error) {
+        logger_1.logger.error('Queue failed, fallback to SES:', error);
+        // fallback
+        await (0, exports.sendEmailDirect)(emailOptions);
+    }
+};
+exports.sendEmail = sendEmail;

package/dist/helpers/sendNotification.d.ts

@@ -0,0 +1,4 @@
+import { INotificationModelAttributes } from '../index';
+export declare const sendPushNotification: (deviceToken: string, notification: INotificationModelAttributes & {
+    counts?: Record<string, number>;
+}) => Promise<void | string>;

package/dist/helpers/sendNotification.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendPushNotification = void 0;
+const admin = require('firebase-admin');
+const env_1 = require("../configs/env");
+// Initialize Firebase if not already initialized
+if (!admin.apps.length) {
+    admin.initializeApp({
+        credential: admin.credential.cert({
+            projectId: env_1.ENV_VARIABLE.FIREBASE_PROJECT_ID,
+            clientEmail: env_1.ENV_VARIABLE.FIREBASE_CLIENT_EMAIL,
+            privateKey: env_1.ENV_VARIABLE.FIREBASE_PRIVATE_KEY.replace(/\\n/g, '\n'),
+        }),
+    });
+}
+const sendPushNotification = async (deviceToken, notification) => {
+    try {
+        const payload = {
+            notification: {
+                title: notification.title,
+                body: notification.message,
+            },
+            token: deviceToken,
+        };
+        const response = await admin.messaging().send(payload);
+        return response;
+    }
+    catch (error) {
+        console.error('Error sending push notification:', error);
+        return;
+        // throw error;
+    }
+};
+exports.sendPushNotification = sendPushNotification;

package/dist/helpers/sendSMS.d.ts

@@ -0,0 +1,5 @@
+export interface ISMSOptions {
+    to: string;
+    message: string;
+}
+export declare const sendSMSDirect: (smsOptions: ISMSOptions) => Promise<void>;

package/dist/helpers/sendSMS.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendSMSDirect = void 0;
+const client_sns_1 = require("@aws-sdk/client-sns");
+const index_1 = require("../index");
+const sendSMSDirect = async (smsOptions) => {
+    try {
+        const snsClient = await index_1.awsClient.sns();
+        // const command = new PublishCommand({
+        //     Message: smsOptions.message,
+        //     PhoneNumber: '+918469665568',
+        //     MessageAttributes: {
+        //         'AWS.SNS.SMS.SenderID': {
+        //             DataType: 'String',
+        //             StringValue: 'KIPI',
+        //         },
+        //         'AWS.SNS.SMS.SMSType': {
+        //             DataType: 'String',
+        //             StringValue: 'Transactional',
+        //         },
+        //     },
+        // });
+        const command = new client_sns_1.PublishCommand({
+            Message: smsOptions.message,
+            PhoneNumber: `+91${smsOptions.to}`,
+        });
+        await snsClient.send(command);
+    }
+    catch (error) {
+        console.error('SMS sending failed:', error);
+        // throw error;
+    }
+};
+exports.sendSMSDirect = sendSMSDirect;

package/dist/index.d.ts

@@ -17,3 +17,5 @@ export * from './models/psql/index';
 export * from './types/index';
 /************ validator ********** */
 export * from './commonValidator';
+/************ queues *************/
+export * from './queues/index';

package/dist/index.js

@@ -33,3 +33,5 @@ __exportStar(require("./models/psql/index"), exports);
 __exportStar(require("./types/index"), exports);
 /************ validator ********** */
 __exportStar(require("./commonValidator"), exports);
+/************ queues *************/
+__exportStar(require("./queues/index"), exports);

package/dist/models/psql/fileStorageModel.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const sequelize_1 = require("sequelize");
 const index_1 = require("./index");
-const app_1 = require("../../constants/app");
 class FileStorageModel extends sequelize_1.Model {
     static associate(models) {
         const { UserModel, UserDirectoryModel } = models;
@@ -72,9 +71,9 @@ FileStorageModel.init({
         allowNull: true,
     },
     uploadedFrom: {
-        type: sequelize_1.DataTypes.ENUM,
-        values: Object.values(app_1.APP_TYPE),
-        allowNull: false,
+        type: sequelize_1.DataTypes.STRING,
+        field: 'uploaded_from',
+        allowNull: true,
     },
     instituteId: {
         type: sequelize_1.DataTypes.UUID,

package/dist/queues/emailQueue.d.ts

@@ -0,0 +1,3 @@
+import { Queue } from 'bullmq';
+export declare const EMAIL_QUEUE_NAME = "email-queue";
+export declare const emailQueue: Queue<any, any, string, any, any, string>;

package/dist/queues/emailQueue.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emailQueue = exports.EMAIL_QUEUE_NAME = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const bullmq_1 = require("bullmq");
+const redisConfig_1 = __importDefault(require("../configs/redisConfig"));
+exports.EMAIL_QUEUE_NAME = 'email-queue';
+exports.emailQueue = new bullmq_1.Queue(exports.EMAIL_QUEUE_NAME, {
+    connection: redisConfig_1.default,
+    defaultJobOptions: {
+        attempts: 3,
+        backoff: {
+            type: 'exponential',
+            delay: 1000,
+        },
+        removeOnComplete: true,
+        removeOnFail: false,
+    },
+});

package/dist/queues/emailWorker.d.ts

@@ -0,0 +1,3 @@
+import { Worker } from 'bullmq';
+import { IEmailOptions } from '../index';
+export declare const emailWorker: Worker<IEmailOptions, any, string>;

package/dist/queues/emailWorker.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emailWorker = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const bullmq_1 = require("bullmq");
+const redisConfig_1 = __importDefault(require("../configs/redisConfig"));
+const sendEmail_1 = require("../helpers/sendEmail");
+const logger_1 = require("../configs/logger");
+const emailQueue_1 = require("./emailQueue");
+exports.emailWorker = new bullmq_1.Worker(emailQueue_1.EMAIL_QUEUE_NAME, async (job) => {
+    const emailOptions = job.data;
+    logger_1.logger.info(`Processing email job ${job.id} to ${emailOptions.to}`);
+    try {
+        await (0, sendEmail_1.sendEmailDirect)(emailOptions);
+        logger_1.logger.info(`Email job ${job.id} sent successfully`);
+    }
+    catch (error) {
+        logger_1.logger.error(`Failed to send email job ${job.id}:`, error);
+        throw error;
+    }
+}, {
+    connection: redisConfig_1.default,
+    concurrency: 5,
+});
+exports.emailWorker.on('completed', job => {
+    logger_1.logger.info(`Job ${job.id} completed successfully`);
+});
+exports.emailWorker.on('failed', (job, err) => {
+    logger_1.logger.error(`Job ${job?.id} failed with error: ${err.message}`);
+});

package/dist/queues/index.d.ts

@@ -0,0 +1,2 @@
+export * from './emailQueue';
+export * from './emailWorker';

package/dist/queues/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./emailQueue"), exports);
+__exportStar(require("./emailWorker"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kipicore/dbcore",
-    "version": "1.1.665",
+    "version": "1.1.667",
     "description": "Reusable DB core package with Postgres, MongoDB, models, services, interfaces, and types",
     "types": "dist/index.d.ts",
     "main": "dist/index.js",
@@ -44,20 +44,25 @@
         "@aws-sdk/client-sts": "^3.1017.0",
         "@aws-sdk/s3-request-presigner": "^3.895.0",
         "axios": "^1.12.2",
+        "bullmq": "^5.80.9",
         "date-fns": "^4.1.0",
         "dotenv": "^17.2.2",
+        "ejs": "^3.1.10",
+        "firebase-admin": "^14.2.0",
+        "ioredis": "^5.11.1",
         "joi": "^18.0.1",
         "mongoose": "^8.5.2",
         "pg": "^8.12.0",
         "sequelize": "^6.37.3",
-        "ejs": "^3.1.10",
-        "uuid": "^8.3.2"
+        "uuid": "^8.3.2",
+        "winston": "^3.19.0",
+        "winston-daily-rotate-file": "^5.0.0"
     },
     "devDependencies": {
         "@eslint/js": "^9.17.0",
+        "@types/ejs": "^3.1.5",
         "@types/express": "^5.0.6",
         "@types/mongoose": "^5.11.97",
-        "@types/ejs": "^3.1.5",
         "@types/node": "^24.5.2",
         "@types/sequelize": "^4.28.14",
         "country-state-city": "^3.2.1",
@@ -75,4 +80,4 @@
         "LICENSE",
         ".sequelizerc"
     ]
-}
+}