@seip/blue-bird 1.1.0 → 1.1.2

package/core/upload.js

@@ -1,4 +1,3 @@
-import multer from "multer";
 import path from "node:path";
 import fs from "node:fs";
 import Config from "./config.js";
@@ -6,72 +5,99 @@ import Config from "./config.js";
 const __dirname = Config.dirname();
 const props = Config.props();
 
+let multer = null;
+try {
+  multer = (await import("multer")).default || (await import("multer"));
+} catch {
+  // multer not installed
+}
+
 /**
  * Upload helper to manage file uploads using multer.
  */
 class Upload {
-    /**
-     * Configures storage for uploaded files.
-     * @param {string} folder - The destination folder within the static path.
-     * @returns {import('multer').StorageEngine}
-     * @example
-     * const storage = Upload.storage("uploads");
-     */
-    static storage(folder = "uploads") {
-        const dest = path.join(__dirname, props.static.path, folder);
+  /**
+   * Asserts that the multer package is available.
+   * @private
+   */
+  static _ensureMulter() {
+    if (!multer) {
+      throw new Error(
+        "[UPLOAD ERROR] 'multer' package is not installed. Install it with: npm install multer or npx blue-bird add upload",
+      );
+    }
+  }
 
-        if (!fs.existsSync(dest)) {
-            fs.mkdirSync(dest, { recursive: true });
-        }
+  /**
+   * Configures storage for uploaded files.
+   * @param {string} folder - The destination folder within the static path.
+   * @returns {import('multer').StorageEngine}
+   * @example
+   * const storage = Upload.storage("uploads");
+   */
+  static storage(folder = "uploads") {
+    this._ensureMulter();
+    const dest = path.join(__dirname, props.static.path, folder);
 
-        return multer.diskStorage({
-            destination: (req, file, cb) => {
-                cb(null, dest);
-            },
-            filename: (req, file, cb) => {
-                const uniqueSuffix = Date.now() + "-" + Math.round(Math.random() * 1e9);
-                cb(null, uniqueSuffix + path.extname(file.originalname));
-            }
-        });
+    if (!fs.existsSync(dest)) {
+      fs.mkdirSync(dest, { recursive: true });
     }
 
-    /**
-     * Returns a multer instance for single or multiple file uploads.
-     * @param {Object} options - Multer options.
-     * @param {string} [options.folder='uploads'] - Destination folder.
-     * @param {number} [options.fileSize=5000000] - Max file size in bytes (default 5MB).
-     * @param {Array<string>} [options.allowedTypes=[]] - Allowed mime types (e.g. ['image/png', 'image/jpeg']).
-     * @returns {import('multer').Multer}
-     * @example
-     * const upload = Upload.disk({ folder: "uploads", fileSize: 5000000, allowedTypes: ["image/png", "image/jpeg"] });
-     */
-    static disk(options = {}) {
-        const { folder = "uploads", fileSize = 5000000, allowedTypes = [] } = options;
+    return multer.diskStorage({
+      destination: (req, file, cb) => {
+        cb(null, dest);
+      },
+      filename: (req, file, cb) => {
+        const uniqueSuffix =
+          Date.now() + "-" + Math.round(Math.random() * 1e9);
+        cb(null, uniqueSuffix + path.extname(file.originalname));
+      },
+    });
+  }
 
-        return multer({
-            storage: this.storage(folder),
-            limits: { fileSize },
-            fileFilter: (req, file, cb) => {
-                if (allowedTypes.length > 0 && !allowedTypes.includes(file.mimetype)) {
-                    return cb(new Error("File type not allowed"), false);
-                }
-                cb(null, true);
-            }
-        });
-    }
+  /**
+   * Returns a multer instance for single or multiple file uploads.
+   * @param {Object} options - Multer options.
+   * @param {string} [options.folder='uploads'] - Destination folder.
+   * @param {number} [options.fileSize=5000000] - Max file size in bytes (default 5MB).
+   * @param {Array<string>} [options.allowedTypes=[]] - Allowed mime types (e.g. ['image/png', 'image/jpeg']).
+   * @returns {import('multer').Multer}
+   * @example
+   * const upload = Upload.disk({ folder: "uploads", fileSize: 5000000, allowedTypes: ["image/png", "image/jpeg"] });
+   */
+  static disk(options = {}) {
+    this._ensureMulter();
+    const {
+      folder = "uploads",
+      fileSize = 5000000,
+      allowedTypes = [],
+    } = options;
 
-    /**
-     * Helper to get the public URL of an uploaded file.
-     * @param {string} filename - The name of the file.
-     * @param {string} [folder='uploads'] - The folder where the file is stored.
-     * @returns {string} The full public URL.
-     * @example
-     * const url = Upload.url("file.jpg", "uploads");
-     */
-    static url(filename, folder = "uploads") {
-        const appUrl = props.appUrl ?? `${props.host}:${props.port}`;
-        return `${appUrl}/${folder}/${filename}`;
-    }
+    return multer({
+      storage: this.storage(folder),
+      limits: { fileSize },
+      fileFilter: (req, file, cb) => {
+        if (allowedTypes.length > 0 && !allowedTypes.includes(file.mimetype)) {
+          return cb(new Error("File type not allowed"), false);
+        }
+        cb(null, true);
+      },
+    });
+  }
+
+  /**
+   * Helper to get the public URL of an uploaded file.
+   * @param {string} filename - The name of the file.
+   * @param {string} [folder='uploads'] - The folder where the file is stored.
+   * @returns {string} The full public URL.
+   * @example
+   * const url = Upload.url("file.jpg", "uploads");
+   */
+  static url(filename, folder = "uploads") {
+    const appUrl = props.appUrl ?? `${props.host}:${props.port}`;
+    return `${appUrl}/${folder}/${filename}`;
+  }
 }
 
 export default Upload;
+

package/core/ws.js

@@ -1,4 +1,14 @@
-import { WebSocketServer, WebSocket } from "ws";
+let WebSocketServer = null;
+let WebSocket = null;
+
+try {
+  const wsModule = await import("ws");
+  WebSocketServer = wsModule.WebSocketServer || wsModule.default?.WebSocketServer;
+  WebSocket = wsModule.WebSocket || wsModule.default?.WebSocket;
+} catch {
+  // ws not installed
+}
+
 import { getRedisClient } from "./cache.js";
 import Auth from "./auth.js";
 
@@ -15,6 +25,12 @@ class WebSocketManager {
    * @param {boolean} [options.auth=false] - Require valid Auth JWT token on connection.
    */
   constructor(server, options = {}) {
+    if (!WebSocketServer || !WebSocket) {
+      throw new Error(
+        "[WS ERROR] 'ws' package is not installed. Install it with: npm install ws or npx blue-bird add ws",
+      );
+    }
+
     this.server = server;
     this.path = options.path || "/ws";
     this.requireAuth = options.auth ?? false;
@@ -31,6 +47,7 @@ class WebSocketManager {
     this._setupRedisPubSub();
   }
 
+
   /**
    * Attaches the HTTP Upgrade listener to the Express HTTP server instance.
    * @private

package/docker/Dockerfile

@@ -4,10 +4,14 @@ ENV NODE_ENV=production
 
 WORKDIR /app
 
+# Install native build tools for C++ addons (better-sqlite3, bcrypt)
+RUN apk add --no-cache python3 make g++
+
 COPY package*.json ./
 
 RUN npm ci --omit=dev && npm install -g pm2
 
+
 COPY . .
 
 EXPOSE 3000

package/docker/docker-compose.sqlite.yml

@@ -0,0 +1,69 @@
+services:
+  app:
+    build:
+      context: .
+      dockerfile: docker/Dockerfile
+    container_name: ${TITLE:-bluebird}-app
+    restart: unless-stopped
+    expose:
+      - "3000"
+    volumes:
+      - .:/app
+      - /app/node_modules
+      - ./database:/app/database
+    env_file:
+      - .env
+    environment:
+      - NODE_ENV=production
+      - DEBUG=false
+      - DB_TYPE=sqlite
+      - DB_FILE=${DB_FILE:-database/blue_bird.db}
+      - DATABASE_URL=${DATABASE_URL:-sqlite:database/blue_bird.db}
+      - REDIS_HOST=redis
+      - REDIS_PORT=6379
+      - PORT=3000
+    depends_on:
+      redis:
+        condition: service_healthy
+    networks:
+      - bluebird_net
+    profiles:
+      - prod
+
+  nginx:
+    image: nginx:1.27-alpine
+    container_name: ${TITLE:-bluebird}-nginx
+    restart: unless-stopped
+    ports:
+      - "${PORT:-3000}:80"
+    volumes:
+      - .:/app:ro
+      - ./docker/nginx.conf:/etc/nginx/nginx.conf:ro
+    networks:
+      - bluebird_net
+    profiles:
+      - prod
+
+  redis:
+    image: redis:7-alpine
+    container_name: ${TITLE:-bluebird}-redis
+    restart: unless-stopped
+    ports:
+      - "${REDIS_PORT:-6379}:6379"
+    volumes:
+      - redis_data:/data
+    networks:
+      - bluebird_net
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 5s
+      timeout: 3s
+      retries: 5
+
+volumes:
+  redis_data:
+
+networks:
+  bluebird_net:
+    name: ${TITLE:-bluebird}_network
+    driver: bridge

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seip/blue-bird",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Express opinionated API framework with built-in JWT auth, validation, and caching",
   "type": "module",
   "types": "core/index.d.ts",
@@ -34,7 +34,8 @@
     "init": "node core/cli/init.js",
     "route": "node core/cli/route.js",
     "swagger-install": "node core/cli/swagger.js",
-    "docker": "node core/cli/init.js docker"
+    "docker": "node core/cli/init.js docker",
+    "test": "node test/test_suite.js"
   },
   "publishConfig": {
     "access": "public"
@@ -49,6 +50,7 @@
     ".env_example"
   ],
   "dependencies": {
+    "better-sqlite3": "^13.0.3",
     "chalk": "^5.6.2",
     "compression": "^1.8.1",
     "cookie-parser": "^1.4.7",