@seip/blue-bird 0.7.6 → 0.8.0

package/core/logger.js

@@ -1,115 +1,115 @@
-import fs from "node:fs";
-import path from "node:path";
-import Config from "./config.js";
-import { getRedisClient } from "./cache.js";
-
-const __dirname = Config.dirname();
-
-/**
- * Logger class for managing application logs by creating dated folders and log files.
- */
-class Logger {
-  /**
-   * Initializes the Logger instance and ensures the logs directory exists.
-   */
-  constructor() {
-    this.folder = path.join(__dirname, "backend", "logs");
-    this._currentDay = null;
-    this._currentDayFolder = null;
-    if (!fs.existsSync(this.folder)) {
-      fs.mkdirSync(this.folder, { recursive: true });
-    }
-  }
-
-  /**
-   * Ensures and returns the path to the log folder for the current day.
-   * Caches the folder path for the current day to avoid repeated fs checks.
-   * @returns {string} The absolute path to the current day's log folder.
-   */
-  nowFolder() {
-    const today = this.now();
-
-    if (this._currentDay === today && this._currentDayFolder) {
-      return this._currentDayFolder;
-    }
-
-    const folder = path.join(this.folder, today);
-
-    if (!fs.existsSync(folder)) {
-      fs.mkdirSync(folder, { recursive: true });
-    }
-
-    this._currentDay = today;
-    this._currentDayFolder = folder;
-    return folder;
-  }
-
-  /**
-   * Gets the current date formatted as YYYY-MM-DD.
-   * @returns {string} The formatted date string.
-   */
-  now() {
-    return new Date().toISOString().split("T")[0];
-  }
-
-  /**
-   * Logs a message to the specified log file or Redis list.
-   * @private
-   * @param {string} file - The file name to log to.
-   * @param {string} level - The log level (e.g. info, error, warn, debug).
-   * @param {string} message - The log message.
-   */
-  async _log(file, level, message) {
-    const redisClient = getRedisClient();
-    if (redisClient) {
-      try {
-        await redisClient.lPush(`bluebird:logs:${level}`, message);
-        return;
-      } catch (err) {
-        console.error(
-          `[LOGGER ERROR] Failed to write to Redis logs (${level}):`,
-          err.message,
-        );
-      }
-    }
-
-    const logFile = path.join(this.nowFolder(), file);
-    fs.appendFile(logFile, `${message}\n`, (err) => {
-      if (err) console.error("Logger write error:", err.message);
-    });
-  }
-
-  /**
-   * Appends an informational message.
-   * @param {string} message - The message to log.
-   */
-  info(message) {
-    this._log("info.log", "info", message);
-  }
-
-  /**
-   * Appends an error message.
-   * @param {string} message - The error message to log.
-   */
-  error(message) {
-    this._log("error.log", "error", message);
-  }
-
-  /**
-   * Appends a warning message.
-   * @param {string} message - The warning message to log.
-   */
-  warning(message) {
-    this._log("warn.log", "warn", message);
-  }
-
-  /**
-   * Appends a debug message.
-   * @param {string} message - The debug message to log.
-   */
-  debug(message) {
-    this._log("debug.log", "debug", message);
-  }
-}
-
-export default Logger;
+import fs from "node:fs";
+import path from "node:path";
+import Config from "./config.js";
+import { getRedisClient } from "./cache.js";
+
+const __dirname = Config.dirname();
+
+/**
+ * Logger class for managing application logs by creating dated folders and log files.
+ */
+class Logger {
+  /**
+   * Initializes the Logger instance and ensures the logs directory exists.
+   */
+  constructor() {
+    this.folder = path.join(__dirname, "backend", "logs");
+    this._currentDay = null;
+    this._currentDayFolder = null;
+    if (!fs.existsSync(this.folder)) {
+      fs.mkdirSync(this.folder, { recursive: true });
+    }
+  }
+
+  /**
+   * Ensures and returns the path to the log folder for the current day.
+   * Caches the folder path for the current day to avoid repeated fs checks.
+   * @returns {string} The absolute path to the current day's log folder.
+   */
+  nowFolder() {
+    const today = this.now();
+
+    if (this._currentDay === today && this._currentDayFolder) {
+      return this._currentDayFolder;
+    }
+
+    const folder = path.join(this.folder, today);
+
+    if (!fs.existsSync(folder)) {
+      fs.mkdirSync(folder, { recursive: true });
+    }
+
+    this._currentDay = today;
+    this._currentDayFolder = folder;
+    return folder;
+  }
+
+  /**
+   * Gets the current date formatted as YYYY-MM-DD.
+   * @returns {string} The formatted date string.
+   */
+  now() {
+    return new Date().toISOString().split("T")[0];
+  }
+
+  /**
+   * Logs a message to the specified log file or Redis list.
+   * @private
+   * @param {string} file - The file name to log to.
+   * @param {string} level - The log level (e.g. info, error, warn, debug).
+   * @param {string} message - The log message.
+   */
+  async _log(file, level, message) {
+    const redisClient = getRedisClient();
+    if (redisClient) {
+      try {
+        await redisClient.lPush(`bluebird:logs:${level}`, message);
+        return;
+      } catch (err) {
+        console.error(
+          `[LOGGER ERROR] Failed to write to Redis logs (${level}):`,
+          err.message,
+        );
+      }
+    }
+
+    const logFile = path.join(this.nowFolder(), file);
+    fs.appendFile(logFile, `${message}\n`, (err) => {
+      if (err) console.error("Logger write error:", err.message);
+    });
+  }
+
+  /**
+   * Appends an informational message.
+   * @param {string} message - The message to log.
+   */
+  info(message) {
+    this._log("info.log", "info", message);
+  }
+
+  /**
+   * Appends an error message.
+   * @param {string} message - The error message to log.
+   */
+  error(message) {
+    this._log("error.log", "error", message);
+  }
+
+  /**
+   * Appends a warning message.
+   * @param {string} message - The warning message to log.
+   */
+  warning(message) {
+    this._log("warn.log", "warn", message);
+  }
+
+  /**
+   * Appends a debug message.
+   * @param {string} message - The debug message to log.
+   */
+  debug(message) {
+    this._log("debug.log", "debug", message);
+  }
+}
+
+export default Logger;

package/core/middleware.js

@@ -1,27 +1,27 @@
-import Auth from "./auth.js";
-
-/**
- * Common middlewares for the Blue Bird framework.
- */
-const Middleware = {
-    /**
-     * Authentication protection middleware.
-     * @type {Function}
-     */
-    auth: Auth.protect(),
-
-    /**
-     * Web authentication protection middleware (redirects to home if fails).
-     * @type {Function}
-     */
-    webAuth: Auth.protect({ redirect: "/" }),
-
-    /**
-     * Logging middleware (can be extended).
-     */
-    logger: (req, res, next) => {
-        next();
-    }
-};
-
-export default Middleware;
+import Auth from "./auth.js";
+
+/**
+ * Common middlewares for the Blue Bird framework.
+ */
+const Middleware = {
+    /**
+     * Authentication protection middleware.
+     * @type {Function}
+     */
+    auth: Auth.protect(),
+
+    /**
+     * Web authentication protection middleware (redirects to home if fails).
+     * @type {Function}
+     */
+    webAuth: Auth.protect({ redirect: "/" }),
+
+    /**
+     * Logging middleware (can be extended).
+     */
+    logger: (req, res, next) => {
+        next();
+    }
+};
+
+export default Middleware;

package/core/router.js

@@ -1,144 +1,144 @@
-import express from "express";
-import Config from "./config.js";
-
-
-const props = Config.props();
-
-/**
- * Router wrapper class for handling Express routing logic.
- * When created with { seo: true }, all GET routes registered on this router
- * are automatically included in the generated sitemap.xml and robots.txt.
- */
-class Router {
-  /**
-   * Creates a new Router instance.
-   * @param {string} [path="/"] - The base path for this router.
-   * @param {Object} [options={}] - Router configuration options.
-   * @param {boolean} [options.seo=false] - When true, GET routes on this router are included in sitemap/robots.txt.
-   * @param {string[]} [options.languages=[]] - Language prefixes for SEO route generation (e.g., ["en", "es"]).
-   * @example
-   * const router = new Router("/", { seo: true, languages: ["en", "es"] });
-   * router.get("/", (req, res) => {
-   *     Template.render(res, "index", { metaTags: { titleMeta: "Home" } });
-   * });
-   */
-  constructor(path = "/", options = {}) {
-    this.router = express.Router();
-    this.path = path;
-    this._seo = options.seo ?? false;
-    this._languages = options.languages || [];
-  }
-
-  /**
-   * Registers a middleware on this router.
-   * @param {...Function} middleware - Middleware functions.
-   * @example
-   * router.use(Auth.protect());
-   * router.use(App.helmet());
-   */
-  use(...middleware) {
-    this.router.use(...middleware);
-  }
-
-  /**
-   * Registers a GET route handler.
-   * If this router was created with { seo: true }, the route path is automatically
-   * registered for sitemap.xml and robots.txt generation.
-   * @param {string} path - The relative path for the GET route.
-   * @param {...Function} callback - One or more handler functions (middlewares and controller).
-   * @example
-   * router.get("/about", (req, res) => {
-   *     Template.render(res, "about", {
-   *         metaTags: { titleMeta: "About Us" }
-   *     });
-   * });
-   */
-  get(path, ...callback) {
-    if (path === "/*" || path === "*") {
-      path = /.*/;
-    }
-
-    this.router.get(path, callback);
-  }
-
-  /**
-   * Registers a POST route handler.
-   * @param {string} path - The relative path for the POST route.
-   * @param {...Function} callback - One or more handler functions (middlewares and controller).
-   * @example
-   * router.post("/users", (req, res) => {
-   *     res.json({ message: "User created successfully" })
-   * })
-   */
-  post(path, ...callback) {
-    if (path === "/*" || path === "*") {
-      path = /.*/;
-    }
-    this.router.post(path, callback);
-  }
-
-  /**
-   * Registers a PUT route handler.
-   * @param {string} path - The relative path for the PUT route.
-   * @param {...Function} callback - One or more handler functions (middlewares and controller).
-   * @example
-   * router.put("/users/:id", (req, res) => {
-   *     res.json({ message: "User updated successfully" })
-   * })
-   */
-  put(path, ...callback) {
-    this.router.put(path, callback);
-  }
-
-  /**
-   * Registers a DELETE route handler.
-   * @param {string} path - The relative path for the DELETE route.
-   * @param {...Function} callback - One or more handler functions (middlewares and controller).
-   * @example
-   * router.delete("/users/:id", (req, res) => {
-   *     res.json({ message: "User deleted successfully" })
-   * })
-   */
-  delete(path, ...callback) {
-    this.router.delete(path, callback);
-  }
-
-  /**
-   * Registers a PATCH route handler.
-   * @param {string} path - The relative path for the PATCH route.
-   * @param {...Function} callback - One or more handler functions (middlewares and controller).
-   * @example
-   * router.patch("/users/:id", (req, res) => {
-   *     res.json({ message: "User patched successfully" })
-   * })
-   */
-  patch(path, ...callback) {
-    this.router.patch(path, callback);
-  }
-
-  /**
-   * Registers an OPTIONS route handler.
-   * @param {string} path - The relative path for the OPTIONS route.
-   * @param {...Function} callback - One or more handler functions (middlewares and controller).
-   */
-  options(path, ...callback) {
-    this.router.options(path, callback);
-  }
-
-  /**
-   * Returns the underlying Express router instance.
-   * @returns {import('express').Router}
-   */
-  getRouter() {
-    return this.router;
-  }
-
-  /**
-   * Returns the base path associated with this router.
-   * @returns {string}
-   */
-  getPath() {
-    return this.path;
-  }
-}
-export default Router;
+import express from "express";
+import Config from "./config.js";
+
+
+const props = Config.props();
+
+/**
+ * Router wrapper class for handling Express routing logic.
+ * When created with { seo: true }, all GET routes registered on this router
+ * are automatically included in the generated sitemap.xml and robots.txt.
+ */
+class Router {
+  /**
+   * Creates a new Router instance.
+   * @param {string} [path="/"] - The base path for this router.
+   * @param {Object} [options={}] - Router configuration options.
+   * @param {boolean} [options.seo=false] - When true, GET routes on this router are included in sitemap/robots.txt.
+   * @param {string[]} [options.languages=[]] - Language prefixes for SEO route generation (e.g., ["en", "es"]).
+   * @example
+   * const router = new Router("/", { seo: true, languages: ["en", "es"] });
+   * router.get("/", (req, res) => {
+   *     Template.render(res, "index", { metaTags: { titleMeta: "Home" } });
+   * });
+   */
+  constructor(path = "/", options = {}) {
+    this.router = express.Router();
+    this.path = path;
+    this._seo = options.seo ?? false;
+    this._languages = options.languages || [];
+  }
+
+  /**
+   * Registers a middleware on this router.
+   * @param {...Function} middleware - Middleware functions.
+   * @example
+   * router.use(Auth.protect());
+   * router.use(App.helmet());
+   */
+  use(...middleware) {
+    this.router.use(...middleware);
+  }
+
+  /**
+   * Registers a GET route handler.
+   * If this router was created with { seo: true }, the route path is automatically
+   * registered for sitemap.xml and robots.txt generation.
+   * @param {string} path - The relative path for the GET route.
+   * @param {...Function} callback - One or more handler functions (middlewares and controller).
+   * @example
+   * router.get("/about", (req, res) => {
+   *     Template.render(res, "about", {
+   *         metaTags: { titleMeta: "About Us" }
+   *     });
+   * });
+   */
+  get(path, ...callback) {
+    if (path === "/*" || path === "*") {
+      path = /.*/;
+    }
+
+    this.router.get(path, callback);
+  }
+
+  /**
+   * Registers a POST route handler.
+   * @param {string} path - The relative path for the POST route.
+   * @param {...Function} callback - One or more handler functions (middlewares and controller).
+   * @example
+   * router.post("/users", (req, res) => {
+   *     res.json({ message: "User created successfully" })
+   * })
+   */
+  post(path, ...callback) {
+    if (path === "/*" || path === "*") {
+      path = /.*/;
+    }
+    this.router.post(path, callback);
+  }
+
+  /**
+   * Registers a PUT route handler.
+   * @param {string} path - The relative path for the PUT route.
+   * @param {...Function} callback - One or more handler functions (middlewares and controller).
+   * @example
+   * router.put("/users/:id", (req, res) => {
+   *     res.json({ message: "User updated successfully" })
+   * })
+   */
+  put(path, ...callback) {
+    this.router.put(path, callback);
+  }
+
+  /**
+   * Registers a DELETE route handler.
+   * @param {string} path - The relative path for the DELETE route.
+   * @param {...Function} callback - One or more handler functions (middlewares and controller).
+   * @example
+   * router.delete("/users/:id", (req, res) => {
+   *     res.json({ message: "User deleted successfully" })
+   * })
+   */
+  delete(path, ...callback) {
+    this.router.delete(path, callback);
+  }
+
+  /**
+   * Registers a PATCH route handler.
+   * @param {string} path - The relative path for the PATCH route.
+   * @param {...Function} callback - One or more handler functions (middlewares and controller).
+   * @example
+   * router.patch("/users/:id", (req, res) => {
+   *     res.json({ message: "User patched successfully" })
+   * })
+   */
+  patch(path, ...callback) {
+    this.router.patch(path, callback);
+  }
+
+  /**
+   * Registers an OPTIONS route handler.
+   * @param {string} path - The relative path for the OPTIONS route.
+   * @param {...Function} callback - One or more handler functions (middlewares and controller).
+   */
+  options(path, ...callback) {
+    this.router.options(path, callback);
+  }
+
+  /**
+   * Returns the underlying Express router instance.
+   * @returns {import('express').Router}
+   */
+  getRouter() {
+    return this.router;
+  }
+
+  /**
+   * Returns the base path associated with this router.
+   * @returns {string}
+   */
+  getPath() {
+    return this.path;
+  }
+}
+export default Router;

package/core/swagger.js

@@ -1,40 +1,40 @@
-import { execSync } from "node:child_process";
-
-class SwaggerCli {
-    install() {
-        const dependencies = this.checkDependencies();
-        if (dependencies.missingDependencies.length > 0) {
-            console.log("Installing dependencies...");
-            console.log(`Installing swagger-jsdoc...`);
-            execSync(`npm install swagger-jsdoc@6.2.8`, { stdio: "inherit" });
-            console.log(`Installing swagger-ui-express...`);
-            execSync(`npm install swagger-ui-express@5.0.1`, { stdio: "inherit" });
-        }
-    }
-    checkDependencies() {
-        const dependencies = [
-            "swagger-jsdoc",
-            "swagger-ui-express"
-        ];
-        const missingDependencies = [];
-        dependencies.forEach(dependency => {
-            if (!this.checkDependency(dependency)) {
-                missingDependencies.push(dependency);
-            }
-        });
-        return {
-            missingDependencies
-        };
-    }
-    checkDependency(dependency) {
-        try {
-            require.resolve(dependency);
-            return true;
-        } catch (error) {
-            return false;
-        }
-    }
-}
-
-const swaggerExecutor = new SwaggerCli();
-swaggerExecutor.install();
+import { execSync } from "node:child_process";
+
+class SwaggerCli {
+    install() {
+        const dependencies = this.checkDependencies();
+        if (dependencies.missingDependencies.length > 0) {
+            console.log("Installing dependencies...");
+            console.log(`Installing swagger-jsdoc...`);
+            execSync(`npm install swagger-jsdoc@6.2.8`, { stdio: "inherit" });
+            console.log(`Installing swagger-ui-express...`);
+            execSync(`npm install swagger-ui-express@5.0.1`, { stdio: "inherit" });
+        }
+    }
+    checkDependencies() {
+        const dependencies = [
+            "swagger-jsdoc",
+            "swagger-ui-express"
+        ];
+        const missingDependencies = [];
+        dependencies.forEach(dependency => {
+            if (!this.checkDependency(dependency)) {
+                missingDependencies.push(dependency);
+            }
+        });
+        return {
+            missingDependencies
+        };
+    }
+    checkDependency(dependency) {
+        try {
+            require.resolve(dependency);
+            return true;
+        } catch (error) {
+            return false;
+        }
+    }
+}
+
+const swaggerExecutor = new SwaggerCli();
+swaggerExecutor.install();