@seip/blue-bird 0.3.3 → 0.3.4

package/core/logger.js

@@ -1,80 +1,80 @@
-import fs from "node:fs";
-import path from "node:path";
-import Config from "./config.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, "logs");
-        if (!fs.existsSync(this.folder)) {
-            fs.mkdirSync(this.folder, { recursive: true });
-        }
-    }
-
-    /**
-     * Ensures and returns the path to the log folder for the current day.
-     * @returns {string} The absolute path to the current day's log folder.
-     */
-    nowFolder() {
-        const folder = path.join(this.folder, this.now());
-
-        if (!fs.existsSync(folder)) {
-            fs.mkdirSync(folder, { recursive: true });
-        }
-        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];
-    }
-
-    /**
-     * Appends an informational message to the info.log file.
-     * @param {string} message - The message to log.
-     */
-    info(message) {
-        const logFile = path.join(this.nowFolder(), 'info.log');
-        fs.appendFileSync(logFile, `${message}\n`);
-    }
-
-    /**
-     * Appends an error message to the error.log file.
-     * @param {string} message - The error message to log.
-     */
-    error(message) {
-        const logFile = path.join(this.nowFolder(), 'error.log');
-        fs.appendFileSync(logFile, `${message}\n`);
-    }
-
-    /**
-     * Appends a warning message to the warn.log file.
-     * @param {string} message - The warning message to log.
-     */
-    warning(message) {
-        const logFile = path.join(this.nowFolder(), 'warn.log');
-        fs.appendFileSync(logFile, `${message}\n`);
-    }
-
-    /**
-     * Appends a debug message to the debug.log file.
-     * @param {string} message - The debug message to log.
-     */
-    debug(message) {
-        const logFile = path.join(this.nowFolder(), 'debug.log');
-        fs.appendFileSync(logFile, `${message}\n`);
-    }
-}
-
-export default Logger;
+import fs from "node:fs";
+import path from "node:path";
+import Config from "./config.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, "logs");
+        if (!fs.existsSync(this.folder)) {
+            fs.mkdirSync(this.folder, { recursive: true });
+        }
+    }
+
+    /**
+     * Ensures and returns the path to the log folder for the current day.
+     * @returns {string} The absolute path to the current day's log folder.
+     */
+    nowFolder() {
+        const folder = path.join(this.folder, this.now());
+
+        if (!fs.existsSync(folder)) {
+            fs.mkdirSync(folder, { recursive: true });
+        }
+        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];
+    }
+
+    /**
+     * Appends an informational message to the info.log file.
+     * @param {string} message - The message to log.
+     */
+    info(message) {
+        const logFile = path.join(this.nowFolder(), 'info.log');
+        fs.appendFileSync(logFile, `${message}\n`);
+    }
+
+    /**
+     * Appends an error message to the error.log file.
+     * @param {string} message - The error message to log.
+     */
+    error(message) {
+        const logFile = path.join(this.nowFolder(), 'error.log');
+        fs.appendFileSync(logFile, `${message}\n`);
+    }
+
+    /**
+     * Appends a warning message to the warn.log file.
+     * @param {string} message - The warning message to log.
+     */
+    warning(message) {
+        const logFile = path.join(this.nowFolder(), 'warn.log');
+        fs.appendFileSync(logFile, `${message}\n`);
+    }
+
+    /**
+     * Appends a debug message to the debug.log file.
+     * @param {string} message - The debug message to log.
+     */
+    debug(message) {
+        const logFile = path.join(this.nowFolder(), 'debug.log');
+        fs.appendFileSync(logFile, `${message}\n`);
+    }
+}
+
+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,135 +1,135 @@
-import express from "express";
-import Config from "./config.js";
-
-const __dirname = Config.dirname()
-const props = Config.props()
-
-/**
- * Router wrapper class for handling Express routing logic.
- */
-class Router {
-    /**
-     * Creates a new Router instance.
-     * @param {string} [path="/"] - The base path for this router.
-     * @example
-     * const router = new Router("/api")
-     * router.get("/", (req, res) => {
-     *     res.json({ message: "Hello World!" })
-     * })
-     */
-    constructor(path = "/") {
-        this.router = express.Router()
-        this.path = path
-    }
-
-    /**
-     * Registers a GET route handler.
-     * @param {string} path - The relative path for the GET route.
-     * @param {...Function} callback - One or more handler functions (middlewares and controller).
-     * @example
-     * router.get("/users", (req, res) => {
-     *     const users = [
-     *         {
-     *             name: "John Doe",
-     *             email: "john.doe@example.com",
-     *         },
-     *         {
-     *             name: "Jane Doe2",
-     *             email: "jane.doe2@example.com",
-     *         },
-     *     ]
-     *     res.json(users)
-     * })
-     */
-    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) => {
-     *  return 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", (req, res) => {
-     *  return 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", (req, res) => {
-     *  return 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", (req, res) => {
-     *  return 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).
-     * @example
-     * router.options("/users", (req, res) => {
-     *  return res.json({ message: "User options successfully" })
-     * })
-     */
-    options(path, ...callback) {
-        this.router.options(path, callback)
-    }
-
-    /**
-     * Returns the underlying Express router instance.
-     * @returns {import('express').Router} The Express router object.
-     */
-    getRouter() {
-        return this.router
-    }
-
-    /**
-     * Returns the base path associated with this router.
-     * @returns {string} The router path.
-     */
-    getPath() {
-        return this.path
-    }
-}
+import express from "express";
+import Config from "./config.js";
+
+const __dirname = Config.dirname()
+const props = Config.props()
+
+/**
+ * Router wrapper class for handling Express routing logic.
+ */
+class Router {
+    /**
+     * Creates a new Router instance.
+     * @param {string} [path="/"] - The base path for this router.
+     * @example
+     * const router = new Router("/api")
+     * router.get("/", (req, res) => {
+     *     res.json({ message: "Hello World!" })
+     * })
+     */
+    constructor(path = "/") {
+        this.router = express.Router()
+        this.path = path
+    }
+
+    /**
+     * Registers a GET route handler.
+     * @param {string} path - The relative path for the GET route.
+     * @param {...Function} callback - One or more handler functions (middlewares and controller).
+     * @example
+     * router.get("/users", (req, res) => {
+     *     const users = [
+     *         {
+     *             name: "John Doe",
+     *             email: "john.doe@example.com",
+     *         },
+     *         {
+     *             name: "Jane Doe2",
+     *             email: "jane.doe2@example.com",
+     *         },
+     *     ]
+     *     res.json(users)
+     * })
+     */
+    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) => {
+     *  return 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", (req, res) => {
+     *  return 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", (req, res) => {
+     *  return 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", (req, res) => {
+     *  return 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).
+     * @example
+     * router.options("/users", (req, res) => {
+     *  return res.json({ message: "User options successfully" })
+     * })
+     */
+    options(path, ...callback) {
+        this.router.options(path, callback)
+    }
+
+    /**
+     * Returns the underlying Express router instance.
+     * @returns {import('express').Router} The Express router object.
+     */
+    getRouter() {
+        return this.router
+    }
+
+    /**
+     * Returns the base path associated with this router.
+     * @returns {string} The router path.
+     */
+    getPath() {
+        return this.path
+    }
+}
 export default Router;

package/core/swagger.js

@@ -1,25 +1,25 @@
-import swaggerUi from "swagger-ui-express";
-import swaggerJSDoc from "swagger-jsdoc";
-
-class Swagger {
-
-    static init(app, options) {
-
-        const optionsJsDoc = {
-            definition: {
-                openapi: "3.0.0",
-                info: options.info,
-                servers: [
-                    { url: options.url }
-                ]
-            },
-            apis: ["./backend/routes/*.js"]
-        };
-
-        const specs = swaggerJSDoc(optionsJsDoc);
-
-        app.use("/docs", swaggerUi.serve, swaggerUi.setup(specs));
-    }
-}
-
+import swaggerUi from "swagger-ui-express";
+import swaggerJSDoc from "swagger-jsdoc";
+
+class Swagger {
+
+    static init(app, options) {
+
+        const optionsJsDoc = {
+            definition: {
+                openapi: "3.0.0",
+                info: options.info,
+                servers: [
+                    { url: options.url }
+                ]
+            },
+            apis: ["./backend/routes/*.js"]
+        };
+
+        const specs = swaggerJSDoc(optionsJsDoc);
+
+        app.use("/docs", swaggerUi.serve, swaggerUi.setup(specs));
+    }
+}
+
 export default Swagger;