fiberx-backend-toolkit 0.0.77 → 0.0.78

package/dist/config/constants.d.ts

@@ -60,6 +60,8 @@ export declare const DEFAULT_TOTP_DIGITS = 6;
 export declare const DEFAULT_TOTP_WINDOW = 1;
 export declare const DEFAULT_RBAC_CACHE_KEY = "RBAC_SNAPSHOT";
 export declare const DEFAULT_RBAC_CACHE_TTL: number;
+export declare const DEFAULT_MAILER_CACHE_KEY = "MAILER_SNAPSHOT";
+export declare const DEFAULT_MAILER_CACHE_TTL: number;
 export declare const EMAIL_ENQUEUE_TYPES_FILE_NAME = "types/email_enqueue_type.generated.ts";
 export declare const EMAIL_ENQUEUE_UTIL_FILE_NAME = "utils/email_enqueue_util.generated.ts";
 export declare const CONTENT_CACHE_TTL_KEY = "CONTENT_CACHE_TTL";

package/dist/config/constants.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_CONTENT_CACHE_TTL = exports.DEFAULT_CONTENT_LANG = exports.DEFAULT_CONTENT_URL = exports.CONTENT_LANG_KEY = exports.CONTENT_URL_KEY = exports.CONTENT_CACHE_TTL_KEY = exports.EMAIL_ENQUEUE_UTIL_FILE_NAME = exports.EMAIL_ENQUEUE_TYPES_FILE_NAME = exports.DEFAULT_RBAC_CACHE_TTL = exports.DEFAULT_RBAC_CACHE_KEY = exports.DEFAULT_TOTP_WINDOW = exports.DEFAULT_TOTP_DIGITS = exports.DEFAULT_TOTP_STEP = exports.ALPHABET_CORPUS = exports.CHARACTER_CORPUS = exports.REQUEST_RATE_LIMITTER_OPTIONS = exports.CORS_MAX_AGE_IN_MICRO_SECONDS = exports.CORS_MAX_AGE_IN_SECONDS = exports.CORS_ALLOWED_HEADERS = exports.HEADERS_KEY_NAME = exports.CORS_ALLOWED_METHODS = exports.DEVICE_ID_HEADERS_NAME = exports.DEVICE_ID_COOKIE_NAME = exports.DEVICE_ID_COOKIE_MAX_AGE = exports.REQUEST_ID_HEADERS_NAME = exports.REQUEST_ID_COOKIE_NAME = exports.REQUEST_ID_COOKIE_MAX_AGE = exports.SEQUELIZE_SEEDER_META_TABLE_NAME = exports.SEQUELIZE_META_TABLE_NAME = exports.EMAIL_ENQUEUE_DIR = exports.SEEDERS_DIR = exports.MIGRATIONS_DIR = exports.MODELS_DIR = exports.SCHEMA_SNAPSHOTS_DIR = exports.SCHEMAS_DIR = exports.ENV_VAR_DIR = exports.LOG_DIR = exports.BASE_DIR = void 0;
+exports.DEFAULT_CONTENT_CACHE_TTL = exports.DEFAULT_CONTENT_LANG = exports.DEFAULT_CONTENT_URL = exports.CONTENT_LANG_KEY = exports.CONTENT_URL_KEY = exports.CONTENT_CACHE_TTL_KEY = exports.EMAIL_ENQUEUE_UTIL_FILE_NAME = exports.EMAIL_ENQUEUE_TYPES_FILE_NAME = exports.DEFAULT_MAILER_CACHE_TTL = exports.DEFAULT_MAILER_CACHE_KEY = exports.DEFAULT_RBAC_CACHE_TTL = exports.DEFAULT_RBAC_CACHE_KEY = exports.DEFAULT_TOTP_WINDOW = exports.DEFAULT_TOTP_DIGITS = exports.DEFAULT_TOTP_STEP = exports.ALPHABET_CORPUS = exports.CHARACTER_CORPUS = exports.REQUEST_RATE_LIMITTER_OPTIONS = exports.CORS_MAX_AGE_IN_MICRO_SECONDS = exports.CORS_MAX_AGE_IN_SECONDS = exports.CORS_ALLOWED_HEADERS = exports.HEADERS_KEY_NAME = exports.CORS_ALLOWED_METHODS = exports.DEVICE_ID_HEADERS_NAME = exports.DEVICE_ID_COOKIE_NAME = exports.DEVICE_ID_COOKIE_MAX_AGE = exports.REQUEST_ID_HEADERS_NAME = exports.REQUEST_ID_COOKIE_NAME = exports.REQUEST_ID_COOKIE_MAX_AGE = exports.SEQUELIZE_SEEDER_META_TABLE_NAME = exports.SEQUELIZE_META_TABLE_NAME = exports.EMAIL_ENQUEUE_DIR = exports.SEEDERS_DIR = exports.MIGRATIONS_DIR = exports.MODELS_DIR = exports.SCHEMA_SNAPSHOTS_DIR = exports.SCHEMAS_DIR = exports.ENV_VAR_DIR = exports.LOG_DIR = exports.BASE_DIR = void 0;
 const path_1 = __importDefault(require("path"));
 exports.BASE_DIR = process.cwd();
 exports.LOG_DIR = path_1.default.join(exports.BASE_DIR, "logs");
@@ -109,6 +109,8 @@ exports.DEFAULT_TOTP_DIGITS = 6;
 exports.DEFAULT_TOTP_WINDOW = 1;
 exports.DEFAULT_RBAC_CACHE_KEY = "RBAC_SNAPSHOT";
 exports.DEFAULT_RBAC_CACHE_TTL = (1000 * 60 * 60 * 24); // 24 hours
+exports.DEFAULT_MAILER_CACHE_KEY = "MAILER_SNAPSHOT";
+exports.DEFAULT_MAILER_CACHE_TTL = (1000 * 60 * 60 * 24); // 24 hours
 exports.EMAIL_ENQUEUE_TYPES_FILE_NAME = "types/email_enqueue_type.generated.ts";
 exports.EMAIL_ENQUEUE_UTIL_FILE_NAME = "utils/email_enqueue_util.generated.ts";
 exports.CONTENT_CACHE_TTL_KEY = "CONTENT_CACHE_TTL";

package/dist/mailer/main.d.ts

@@ -1,3 +1,4 @@
 import EmailEnqueueGenerator from "./generators/email_enqueue_generator";
 import EmailEnqueueProcessor from "./processors/email_enqueue_processor";
-export { EmailEnqueueGenerator, EmailEnqueueProcessor };
+import MailerDataLoaderUtil from "./utils/mailer_data_loader_util";
+export { EmailEnqueueGenerator, EmailEnqueueProcessor, MailerDataLoaderUtil };

package/dist/mailer/main.js

@@ -3,8 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmailEnqueueProcessor = exports.EmailEnqueueGenerator = void 0;
+exports.MailerDataLoaderUtil = exports.EmailEnqueueProcessor = exports.EmailEnqueueGenerator = void 0;
 const email_enqueue_generator_1 = __importDefault(require("./generators/email_enqueue_generator"));
 exports.EmailEnqueueGenerator = email_enqueue_generator_1.default;
 const email_enqueue_processor_1 = __importDefault(require("./processors/email_enqueue_processor"));
 exports.EmailEnqueueProcessor = email_enqueue_processor_1.default;
+const mailer_data_loader_util_1 = __importDefault(require("./utils/mailer_data_loader_util"));
+exports.MailerDataLoaderUtil = mailer_data_loader_util_1.default;

package/dist/mailer/utils/mailer_data_loader_util.d.ts

@@ -0,0 +1,38 @@
+import { MailerDataLoaderProvider, MailerDataLoaderOptionsInterface } from "../../types/mailer_type";
+declare class MailerDataLoaderUtil<TMailerConfig, TBaseTemplate, TNotificationType, TEmailContentTempltae> {
+    private readonly provider;
+    private static instance;
+    private readonly logger;
+    private readonly cache;
+    private readonly CACHE_KEY;
+    private readonly DEFAULT_TTL;
+    private loading_promise;
+    private constructor();
+    /**
+     * ===============================
+     * BUILD SNAPSHOT
+     * ===============================
+     */
+    private buildSnapshot;
+    static initialize<TMailerConfig, TBaseTemplate, TNotificationType, TEmailContentTempltae>(provider: MailerDataLoaderProvider<TMailerConfig, TBaseTemplate, TNotificationType, TEmailContentTempltae>, options?: MailerDataLoaderOptionsInterface): MailerDataLoaderUtil<TMailerConfig, TBaseTemplate, TNotificationType, TEmailContentTempltae>;
+    static getInstance<TMailerConfig, TBaseTemplate, TNotificationType, TEmailContentTempltae>(): MailerDataLoaderUtil<TMailerConfig, TBaseTemplate, TNotificationType, TEmailContentTempltae>;
+    /**
+     * ===============================
+     * LOAD Mailer
+     * ===============================
+     */
+    load(force_refresh?: boolean): Promise<void>;
+    /**
+    * ===============================
+    * ACCESSORS
+    * ===============================
+    */
+    private getSnapshot;
+    getMailerConfig(): TMailerConfig | null;
+    getBaseTemplate(): TBaseTemplate | null;
+    getNotificationTypes(): TNotificationType[];
+    getEmailTemplates(): TEmailContentTempltae[];
+    getTemplateByNotificationCode(code: string): Promise<TEmailContentTempltae | null>;
+    refresh(): Promise<void>;
+}
+export default MailerDataLoaderUtil;

package/dist/mailer/utils/mailer_data_loader_util.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const main_1 = require("../../utils/main");
+const constants_1 = require("../../config/constants");
+class MailerDataLoaderUtil {
+    provider;
+    static instance = null;
+    logger = new main_1.LoggerUtil("mailer_data_loader_util");
+    cache = new main_1.InMemoryCacheUtil();
+    CACHE_KEY;
+    DEFAULT_TTL;
+    loading_promise = null;
+    constructor(provider, options) {
+        this.provider = provider;
+        this.CACHE_KEY = options?.cache_key ?? constants_1.DEFAULT_MAILER_CACHE_KEY;
+        this.DEFAULT_TTL = options?.cache_ttl ?? constants_1.DEFAULT_MAILER_CACHE_TTL;
+    }
+    /**
+     * ===============================
+     * BUILD SNAPSHOT
+     * ===============================
+     */
+    async buildSnapshot() {
+        const mailer_config = await this.provider.fetchMailerConfig();
+        const base_template = await this.provider.fetchBaseTemplate();
+        const notification_types = await this.provider.fetchNotificationTypes();
+        const email_contents = await this.provider.fetchEmailContentTemplates();
+        const notification_by_code = new Map();
+        const templates_by_notification_code = new Map();
+        // RolePermissions
+        for (const notification of notification_types) {
+            const notification_code = this.provider.getNotificaionCodeFromNotification(notification);
+            notification_by_code.set(notification_code, notification);
+        }
+        for (const template of email_contents) {
+            const notification_code = this.provider.getNotificaionCodeFromTemplate(template);
+            templates_by_notification_code.set(notification_code, template);
+        }
+        return {
+            mailer_config,
+            base_template,
+            notification_types,
+            email_contents,
+            notification_by_code,
+            templates_by_notification_code
+        };
+    }
+    // Method to Initialize singleton (MUST be called once)
+    static initialize(provider, options) {
+        if (this.instance) {
+            throw new Error("MailerDataLoaderUtil already initialized.");
+        }
+        this.instance = new MailerDataLoaderUtil(provider, options);
+        return this.instance;
+    }
+    // Method to Get singleton instance
+    static getInstance() {
+        if (!this.instance) {
+            throw new Error("RBACLoaderUtil not initialized.");
+        }
+        return this.instance;
+    }
+    /**
+     * ===============================
+     * LOAD Mailer
+     * ===============================
+     */
+    async load(force_refresh = false) {
+        if (!force_refresh && this.cache.has(this.CACHE_KEY)) {
+            return;
+        }
+        if (this.loading_promise) {
+            return this.loading_promise;
+        }
+        this.loading_promise = (async () => {
+            try {
+                const snapshot = await this.buildSnapshot();
+                this.cache.set(this.CACHE_KEY, snapshot, this.DEFAULT_TTL);
+            }
+            catch (error) {
+                this.logger.error("Failed to load Mailer snapshot", { error });
+                throw error;
+            }
+            finally {
+                this.loading_promise = null;
+            }
+        })();
+        return this.loading_promise;
+    }
+    /**
+    * ===============================
+    * ACCESSORS
+    * ===============================
+    */
+    getSnapshot() {
+        const snapshot = this.cache.get(this.CACHE_KEY);
+        if (!snapshot) {
+            throw new Error("Mailer Data Loader Util snapshot not loaded. Call load() first.");
+        }
+        return snapshot;
+    }
+    getMailerConfig() {
+        return this.getSnapshot().mailer_config;
+    }
+    getBaseTemplate() {
+        return this.getSnapshot().base_template;
+    }
+    getNotificationTypes() {
+        return this.getSnapshot().notification_types;
+    }
+    getEmailTemplates() {
+        return this.getSnapshot().email_contents;
+    }
+    async getTemplateByNotificationCode(code) {
+        const templates_by_notification_code = this.getSnapshot().templates_by_notification_code;
+        if (templates_by_notification_code.has(code)) {
+            return templates_by_notification_code.get(code) ?? null;
+        }
+        return await this.provider.fetchEmailContentTemplateByNotificationcode(code);
+    }
+    // --------------------------
+    // Refresh
+    // --------------------------
+    async refresh() {
+        await this.load(true);
+    }
+}
+exports.default = MailerDataLoaderUtil;

package/dist/types/mailer_type.d.ts

@@ -39,3 +39,24 @@ export interface EmailQueueAdapter<TQueueEntity, TNotification, TTemplate, TMail
         created_by?: number | null;
     }): Promise<TQueueEntity>;
 }
+export interface MailerDataLoaderProvider<TMailerConfig, TBaseTemplate, TNotificationType, TEmailContentTempltae> {
+    fetchMailerConfig(): Promise<TMailerConfig | null>;
+    fetchBaseTemplate(): Promise<TBaseTemplate | null>;
+    fetchNotificationTypes(): Promise<TNotificationType[]>;
+    fetchEmailContentTemplates(): Promise<TEmailContentTempltae[]>;
+    fetchEmailContentTemplateByNotificationcode(code: string): Promise<TEmailContentTempltae | null>;
+    getNotificaionCodeFromNotification(notification: TNotificationType): string;
+    getNotificaionCodeFromTemplate(email_content_template: TEmailContentTempltae): string;
+}
+export interface MailerDataLoaderSnapshot<TMailerConfig, TBaseTemplate, TNotificationType, TEmailContentTempltae> {
+    mailer_config: TMailerConfig | null;
+    base_template: TBaseTemplate | null;
+    notification_types: TNotificationType[];
+    email_contents: TEmailContentTempltae[];
+    notification_by_code: Map<string, TNotificationType>;
+    templates_by_notification_code: Map<string, TEmailContentTempltae>;
+}
+export interface MailerDataLoaderOptionsInterface {
+    cache_key?: string;
+    cache_ttl?: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fiberx-backend-toolkit",
-    "version": "0.0.77",
+    "version": "0.0.78",
     "description": "A TypeScript backend toolkit providing shared domain logic, infrastructure helpers, and utilities for FiberX server-side applications and services.",
     "type": "commonjs",
     "main": "./dist/index.js",