fiberx-backend-toolkit 0.0.57 → 0.0.58

package/dist/code_templates/email_enqueue_code_template.d.ts

@@ -0,0 +1,4 @@
+declare const GENERATE_NOTIFICATION_CODE_TYPE: (interface_name: string, static_obj: any, db_obj: any, code: string) => string;
+declare const GENERATE_UTIL_METHOD_CODE: (interface_name: string, method_name: string, code: string) => string;
+declare const GENERATE_UTIL_CLASS_CODE: (types_file_name: string, generated_content: string) => string;
+export { GENERATE_NOTIFICATION_CODE_TYPE, GENERATE_UTIL_METHOD_CODE, GENERATE_UTIL_CLASS_CODE };

package/dist/code_templates/email_enqueue_code_template.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GENERATE_UTIL_CLASS_CODE = exports.GENERATE_UTIL_METHOD_CODE = exports.GENERATE_NOTIFICATION_CODE_TYPE = void 0;
+const objectToType = (obj, indent) => {
+    const spacing = " ".repeat(indent);
+    return Object.entries(obj)
+        .map(([key, value]) => {
+        if (value === "string") {
+            return `${spacing}${key}: string;`;
+        }
+        return `${spacing}${key}: {\n${objectToType(value, indent + 4)}\n${spacing}};`;
+    })
+        .join("\n");
+};
+const GENERATE_NOTIFICATION_CODE_TYPE = (interface_name, static_obj, db_obj, code) => {
+    return `
+/**
+ * @generated-notification-code: ${code}
+ */
+export interface ${interface_name} {
+    static_data: {
+${objectToType(static_obj, 8)}
+    };
+    db_data: {
+${objectToType(db_obj, 8)}
+    };
+}
+`;
+};
+exports.GENERATE_NOTIFICATION_CODE_TYPE = GENERATE_NOTIFICATION_CODE_TYPE;
+const GENERATE_UTIL_METHOD_CODE = (interface_name, method_name, code) => {
+    return `
+/**
+ * @generated-notification-code: ${code}
+ */
+public static async ${method_name}(params: {
+    recipient_email: string;
+    created_by?: number | null;
+    payload: ${interface_name};
+}) {
+    return EmailQueueService.enqueueEmail<${interface_name}>({
+        notification_code: "${code}",
+        recipient_email: params.recipient_email,
+        created_by: params.created_by ?? null,
+        payload: params.payload,
+    });
+}
+`;
+};
+exports.GENERATE_UTIL_METHOD_CODE = GENERATE_UTIL_METHOD_CODE;
+const GENERATE_UTIL_CLASS_CODE = (types_file_name, generated_content) => {
+    return `
+import { EmailQueueService } from "@/services/email_queue_service";
+import * as Types from "@/${types_file_name}";
+
+class GeneratedEmailEnqueueUtil {
+${generated_content}
+}
+
+export default GeneratedEmailEnqueueUtil;
+`;
+};
+exports.GENERATE_UTIL_CLASS_CODE = GENERATE_UTIL_CLASS_CODE;

package/dist/config/constants.d.ts

@@ -6,6 +6,7 @@ export declare const SCHEMA_SNAPSHOTS_DIR: string;
 export declare const MODELS_DIR: string;
 export declare const MIGRATIONS_DIR: string;
 export declare const SEEDERS_DIR: string;
+export declare const EMAIL_ENQUEUE_DIR: string;
 export declare const SEQUELIZE_META_TABLE_NAME = "sequelize_database_tables_meta";
 export declare const SEQUELIZE_SEEDER_META_TABLE_NAME = "sequelize_database_table_seeder_meta";
 export declare const REQUEST_ID_COOKIE_MAX_AGE: number;
@@ -30,3 +31,5 @@ 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 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";

package/dist/config/constants.js

@@ -3,9 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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.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.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.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.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"));
-// Database constants
 exports.BASE_DIR = process.cwd();
 exports.LOG_DIR = path_1.default.join(exports.BASE_DIR, "logs");
 exports.ENV_VAR_DIR = path_1.default.join(exports.BASE_DIR, "environment_varaiables");
@@ -14,6 +13,7 @@ exports.SCHEMA_SNAPSHOTS_DIR = path_1.default.join(exports.BASE_DIR, "src/databa
 exports.MODELS_DIR = path_1.default.join(exports.BASE_DIR, "src/database/models");
 exports.MIGRATIONS_DIR = path_1.default.join(exports.BASE_DIR, "src/database/migrations");
 exports.SEEDERS_DIR = path_1.default.join(exports.BASE_DIR, "src/database/seeders");
+exports.EMAIL_ENQUEUE_DIR = path_1.default.join(exports.BASE_DIR, "src/");
 exports.SEQUELIZE_META_TABLE_NAME = "sequelize_database_tables_meta";
 exports.SEQUELIZE_SEEDER_META_TABLE_NAME = "sequelize_database_table_seeder_meta";
 exports.REQUEST_ID_COOKIE_MAX_AGE = (1000 * 60 * 60 * 24 * 30); // 7 days
@@ -40,3 +40,5 @@ 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.EMAIL_ENQUEUE_TYPES_FILE_NAME = "types/email_enqueue_type.generated.ts";
+exports.EMAIL_ENQUEUE_UTIL_FILE_NAME = "utils/email_enqueue_util.generated.ts";

package/dist/mailer/generators/email_enqueue_generator.d.ts

@@ -0,0 +1,21 @@
+import { EmailEnqueueGeneratorOptions, EmailEnqueueDataProvider } from "../../types/mailer_type";
+declare class EmailEnqueueGenerator<TTemplate, TNotification> {
+    private readonly provider;
+    private static instance;
+    readonly name: string;
+    private readonly logger;
+    private readonly output_dir;
+    private readonly types_file_path;
+    private readonly util_file_path;
+    private readonly batch_size;
+    private readonly options;
+    private constructor();
+    static initialize<TTemplate, TNotification>(provider: EmailEnqueueDataProvider<TTemplate, TNotification>, options: EmailEnqueueGeneratorOptions): EmailEnqueueGenerator<TTemplate, TNotification>;
+    static getInstance<TTemplate, TNotification>(): EmailEnqueueGenerator<TTemplate, TNotification>;
+    private extractExistingNotificationCodes;
+    private appendType;
+    private appendUtilMethod;
+    private generateForTemplate;
+    generate(): Promise<void>;
+}
+export default EmailEnqueueGenerator;

package/dist/mailer/generators/email_enqueue_generator.js

@@ -0,0 +1,157 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const constants_1 = require("../../config/constants");
+const main_1 = require("../../utils/main");
+const email_enqueue_code_template_1 = require("../../code_templates/email_enqueue_code_template");
+class EmailEnqueueGenerator {
+    provider;
+    static instance = null;
+    name = "email_enqueue_generator";
+    logger = new main_1.LoggerUtil(this.name);
+    output_dir;
+    types_file_path;
+    util_file_path;
+    batch_size;
+    options;
+    constructor(provider, options) {
+        this.provider = provider;
+        this.options = options;
+        this.output_dir = options.output_dir ?? constants_1.EMAIL_ENQUEUE_DIR;
+        this.batch_size = options.batch_size ?? 200;
+        this.types_file_path = path_1.default.join(this.output_dir, options.types_file_name ?? constants_1.EMAIL_ENQUEUE_TYPES_FILE_NAME);
+        this.util_file_path = path_1.default.join(this.output_dir, options.util_file_name ?? constants_1.EMAIL_ENQUEUE_UTIL_FILE_NAME);
+    }
+    // ===============================
+    // SINGLETON
+    // ===============================
+    static initialize(provider, options) {
+        if (this.instance) {
+            throw new Error("EmailEnqueueGenerator already initialized.");
+        }
+        this.instance = new EmailEnqueueGenerator(provider, options);
+        return this.instance;
+    }
+    static getInstance() {
+        if (!this.instance) {
+            throw new Error("EmailEnqueueGeneratorUtil not initialized.");
+        }
+        return this.instance;
+    }
+    // Method to extrace exisitng rendered code from class methods
+    extractExistingNotificationCodes() {
+        try {
+            if (!fs_1.default.existsSync(this.types_file_path)) {
+                this.logger.info("📂 Types file not found. No existing codes detected.");
+                return new Set();
+            }
+            const content = fs_1.default.readFileSync(this.types_file_path, "utf8");
+            const regex = /@generated-notification-code:\s*(\w+)/g;
+            const codes = new Set();
+            let match;
+            while ((match = regex.exec(content)) !== null) {
+                codes.add(match[1]);
+            }
+            this.logger.info(`🔎 Found ${codes.size} existing generated notification codes.`);
+            return codes;
+        }
+        catch (error) {
+            this.logger.error("❌ Failed to extract existing notification codes.", { error });
+            throw error;
+        }
+    }
+    // Method to append generated to type to output file type
+    appendType(interface_name, static_obj, db_obj, code) {
+        try {
+            const content = (0, email_enqueue_code_template_1.GENERATE_NOTIFICATION_CODE_TYPE)(interface_name, static_obj, db_obj, code);
+            fs_1.default.appendFileSync(this.types_file_path, content);
+            this.logger.info(`🧩 Type generated → ${interface_name} (${code})`);
+            return true;
+        }
+        catch (error) {
+            this.logger.error(`❌ Failed generating type for ${code}`, { error });
+            return false;
+        }
+    }
+    appendUtilMethod(interface_name, method_name, code) {
+        try {
+            const content = (0, email_enqueue_code_template_1.GENERATE_UTIL_METHOD_CODE)(interface_name, method_name, code);
+            // First time creation
+            if (!fs_1.default.existsSync(this.util_file_path)) {
+                const type_file_name = this.options.types_file_name ?? constants_1.EMAIL_ENQUEUE_TYPES_FILE_NAME;
+                const full_class_content = (0, email_enqueue_code_template_1.GENERATE_UTIL_CLASS_CODE)(type_file_name, content);
+                fs_1.default.writeFileSync(this.util_file_path, full_class_content);
+                this.logger.info(`📦 Created new util file and added method → ${method_name}`);
+                return true;
+            }
+            // Append inside existing class
+            const existing = fs_1.default.readFileSync(this.util_file_path, "utf8");
+            if (!existing.trim().endsWith("}")) {
+                this.logger.error("❌ Util file malformed — missing closing class bracket.");
+                return false;
+            }
+            const updated = existing.replace(/}\s*$/, `${content}\n}`);
+            fs_1.default.writeFileSync(this.util_file_path, updated);
+            this.logger.info(`⚙️ Appended method → ${method_name}`);
+            return true;
+        }
+        catch (error) {
+            this.logger.error(`❌ Failed generating util method for ${code}`, { error });
+            return false;
+        }
+    }
+    // Method to generate template code
+    async generateForTemplate(template) {
+        try {
+            const notification = this.provider.getNotificationFromTemplate(template);
+            const code = this.provider.getNotificationCode(notification);
+            const interface_name = main_1.InputTransformerUtil.toPascalCase(code) + "EmailPayload";
+            const method_name = "send" + main_1.InputTransformerUtil.toPascalCase(code);
+            const placeholders = this.provider.getRequiredPlaceholders(template) ?? {};
+            const static_obj = main_1.InputTransformerUtil.buildNestedObject(placeholders.static_data ?? []);
+            const db_obj = main_1.InputTransformerUtil.buildNestedObject(placeholders.db_data ?? []);
+            this.logger.info(`🚀 Generating email enqueue code for → ${code}`);
+            const type_success = this.appendType(interface_name, static_obj, db_obj, code);
+            const method_success = this.appendUtilMethod(interface_name, method_name, code);
+            if (type_success && method_success) {
+                this.logger.success?.(`✅ Successfully generated enqueue method for code → ${code}`);
+            }
+            else {
+                this.logger.alert?.(`⚠️ Partial generation of enqueue method for code  → ${code}`);
+            }
+        }
+        catch (error) {
+            this.logger.error("❌ Failed generating template code.", { error });
+            throw error;
+        }
+    }
+    // ===============================
+    // PUBLIC GENERATE
+    // ===============================
+    async generate() {
+        try {
+            this.logger.info("📧 Starting email enqueue code generation...");
+            main_1.InputValidatorUtil.dirExists(this.output_dir, true);
+            const existing_codes = this.extractExistingNotificationCodes();
+            const templates = await this.provider.fetchActiveTemplates(Array.from(existing_codes), this.batch_size);
+            if (!templates.length) {
+                this.logger.info("✨ No new templates to generate.");
+                return;
+            }
+            this.logger.info(`📝 ${templates.length} new template(s) detected.`);
+            for (const template of templates) {
+                await this.generateForTemplate(template);
+            }
+            this.logger.info(`🎉 Generation complete. ${templates.length} notification(s) processed.`);
+        }
+        catch (error) {
+            this.logger.error("🔥 Email enqueue generation failed.", { error });
+            throw error;
+        }
+    }
+}
+exports.default = EmailEnqueueGenerator;

package/dist/mailer/main.js

@@ -0,0 +1 @@
+"use strict";

package/dist/types/mailer_type.d.ts

@@ -0,0 +1,16 @@
+export interface EmailEnqueueGeneratorOptions {
+    output_dir: string;
+    types_file_name?: string;
+    util_file_name?: string;
+    batch_size?: number;
+}
+export interface EmailTemplatePlaceholders {
+    static_data?: string[];
+    db_data?: string[];
+}
+export interface EmailEnqueueDataProvider<TTemplate, TNotification> {
+    fetchActiveTemplates(exclude_codes: string[], limit: number): Promise<TTemplate[]>;
+    getNotificationFromTemplate(template: TTemplate): TNotification;
+    getNotificationCode(notification: TNotification): string;
+    getRequiredPlaceholders(template: TTemplate): EmailTemplatePlaceholders | null;
+}

package/dist/types/mailer_type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/input_transformer_util.d.ts

@@ -111,5 +111,6 @@ declare class InputTransformerUtil {
      * Normalize social links object keys
      */
     static formatLinksObject(links: Record<string, string>): Record<string, string>;
+    static buildNestedObject(paths: string[]): any;
 }
 export default InputTransformerUtil;

package/dist/utils/input_transformer_util.js

@@ -310,5 +310,22 @@ class InputTransformerUtil {
         }
         return formatted_links;
     }
+    // Method to build nested object from dotted pats
+    static buildNestedObject(paths) {
+        const root = {};
+        for (const p of paths) {
+            const parts = p.split(".");
+            let current = root;
+            for (let i = 0; i < parts.length; i++) {
+                const key = parts[i];
+                if (!current[key]) {
+                    current[key] =
+                        i === parts.length - 1 ? "string" : {};
+                }
+                current = current[key];
+            }
+        }
+        return root;
+    }
 }
 exports.default = InputTransformerUtil;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fiberx-backend-toolkit",
-    "version": "0.0.57",
+    "version": "0.0.58",
     "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",