bro-framework 2.2.1 → 2.3.0

package/package.json

@@ -1,88 +1,88 @@
-{
-  "name": "bro-framework",
-  "version": "2.2.1",
-  "description": "The No-BS Backend Framework for Node.js",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/medyass1ne/bro.js"
-  },
-  "homepage": "https://brojs.yessindevs.me",
-  "author": "Yessindevs",
-  "license": "MIT",
-  "main": "src/index.js",
-  "types": "src/index.d.ts",
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./src/index.d.ts",
-      "default": "./src/index.js"
-    }
-  },
-  "bin": {
-    "bro": "./bin/bro.js"
-  },
-  "files": [
-    "src",
-    "bin"
-  ],
-  "dependencies": {
-    "@scalar/express-api-reference": "^0.10.18",
-    "chokidar": "^5.0.0",
-    "cors": "^2.8.6",
-    "dotenv": "^16.4.5",
-    "express": "^4.21.1",
-    "express-rate-limit": "^8.7.0",
-    "jsonwebtoken": "^9.0.2",
-    "multer": "^2.3.0",
-    "node-cron": "^4.6.0",
-    "socket.io": "^4.8.3",
-    "tsx": "^4.23.13",
-    "zod": "^3.23.8",
-    "zod-to-json-schema": "^3.25.2"
-  },
-  "keywords": [
-    "bro",
-    "brojs",
-    "bro-framework",
-    "framework",
-    "backend",
-    "api",
-    "server",
-    "node",
-    "nodejs",
-    "express",
-    "rest",
-    "zero-config",
-    "zero-boilerplate",
-    "file-based-routing",
-    "auto-routing",
-    "zod",
-    "validation",
-    "jwt",
-    "authentication",
-    "auth",
-    "websocket",
-    "websockets",
-    "socket.io",
-    "realtime",
-    "openapi",
-    "swagger",
-    "scalar",
-    "docs",
-    "auto-docs",
-    "sdk",
-    "sdk-generator",
-    "rpc",
-    "trpc-alternative",
-    "express-alternative",
-    "cron",
-    "scheduler",
-    "background-tasks",
-    "file-upload",
-    "rate-limit",
-    "esm",
-    "ai-friendly",
-    "developer-experience",
-    "dx"
-  ]
-}
+{
+  "name": "bro-framework",
+  "version": "2.3.0",
+  "description": "The No-BS Backend Framework for Node.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/medyass1ne/bro.js"
+  },
+  "homepage": "https://brojs.yessindevs.me",
+  "author": "Yessindevs",
+  "license": "MIT",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    }
+  },
+  "bin": {
+    "bro": "./bin/bro.js"
+  },
+  "files": [
+    "src",
+    "bin"
+  ],
+  "dependencies": {
+    "@scalar/express-api-reference": "^0.10.18",
+    "chokidar": "^5.0.0",
+    "cors": "^2.8.6",
+    "dotenv": "^16.4.5",
+    "express": "^4.21.1",
+    "express-rate-limit": "^8.7.0",
+    "jsonwebtoken": "^9.0.2",
+    "multer": "^2.3.0",
+    "node-cron": "^4.6.0",
+    "socket.io": "^4.8.3",
+    "tsx": "^4.23.13",
+    "zod": "^3.23.8",
+    "zod-to-json-schema": "^3.25.2"
+  },
+  "keywords": [
+    "bro",
+    "brojs",
+    "bro-framework",
+    "framework",
+    "backend",
+    "api",
+    "server",
+    "node",
+    "nodejs",
+    "express",
+    "rest",
+    "zero-config",
+    "zero-boilerplate",
+    "file-based-routing",
+    "auto-routing",
+    "zod",
+    "validation",
+    "jwt",
+    "authentication",
+    "auth",
+    "websocket",
+    "websockets",
+    "socket.io",
+    "realtime",
+    "openapi",
+    "swagger",
+    "scalar",
+    "docs",
+    "auto-docs",
+    "sdk",
+    "sdk-generator",
+    "rpc",
+    "trpc-alternative",
+    "express-alternative",
+    "cron",
+    "scheduler",
+    "background-tasks",
+    "file-upload",
+    "rate-limit",
+    "esm",
+    "ai-friendly",
+    "developer-experience",
+    "dx"
+  ]
+}

package/src/auth.js

@@ -1,33 +1,33 @@
-import jwt from 'jsonwebtoken';
-
-/**
- * Signs a JWT payload.
- * @param {Object} payload - The data to embed in the token.
- * @param {string} secret - The JWT secret key.
- * @param {jwt.SignOptions} [options] - jsonwebtoken sign options.
- * @returns {string} The signed JWT token.
- */
-export function signJwt(payload, secret, options = { expiresIn: '1d' }) {
-  return jwt.sign(payload, secret, options);
-}
-
-/**
- * Verifies and decodes a JWT token.
- * @param {string} token - The JWT token to verify.
- * @param {string} secret - The JWT secret key.
- * @returns {{ valid: boolean, payload?: any, error?: string }}
- */
-export function verifyJwt(token, secret) {
-  try {
-    const payload = jwt.verify(token, secret);
-    return { valid: true, payload };
-  } catch (error) {
-    let message = 'Invalid token';
-    if (error.name === 'TokenExpiredError') {
-      message = 'Token has expired';
-    } else if (error.name === 'JsonWebTokenError') {
-      message = 'Signature verification failed';
-    }
-    return { valid: false, error: message };
-  }
-}
+import jwt from 'jsonwebtoken';
+
+/**
+ * Signs a JWT payload.
+ * @param {Object} payload - The data to embed in the token.
+ * @param {string} secret - The JWT secret key.
+ * @param {jwt.SignOptions} [options] - jsonwebtoken sign options.
+ * @returns {string} The signed JWT token.
+ */
+export function signJwt(payload, secret, options = { expiresIn: '1d' }) {
+  return jwt.sign(payload, secret, options);
+}
+
+/**
+ * Verifies and decodes a JWT token.
+ * @param {string} token - The JWT token to verify.
+ * @param {string} secret - The JWT secret key.
+ * @returns {{ valid: boolean, payload?: any, error?: string }}
+ */
+export function verifyJwt(token, secret) {
+  try {
+    const payload = jwt.verify(token, secret);
+    return { valid: true, payload };
+  } catch (error) {
+    let message = 'Invalid token';
+    if (error.name === 'TokenExpiredError') {
+      message = 'Token has expired';
+    } else if (error.name === 'JsonWebTokenError') {
+      message = 'Signature verification failed';
+    }
+    return { valid: false, error: message };
+  }
+}

package/src/index.d.ts

@@ -1,66 +1,80 @@
-import { z, ZodTypeAny } from 'zod';
-
-type InferZod<T> = T extends ZodTypeAny ? z.infer<T> : any;
-
-export interface BroContext<Body = any, Params = any, Query = any> {
-  env?: any;
-  jwt?: { sign: (payload: any, options?: any) => string };
-  body: InferZod<Body>;
-  params: InferZod<Params>;
-  query: InferZod<Query>;
-  user?: any;
-  db?: any;
-  io?: any;
-  files?: any[];
-  error?: any;
-}
-
-export interface RouteConfig<Body = any, Params = any, Query = any> {
-  auth?: boolean;
-  upload?: boolean | { limits?: any, fields?: { name: string, maxCount?: number }[], single?: string, array?: string, fileFilter?: any, storage?: any };
-  schema?: { body?: Body; params?: Params; query?: Query; };
-  body?: Body;
-  params?: Params;
-  query?: Query;
-  rateLimit?: {
-    windowMs: number;
-    max: number;
-  };
-  summary?: string;
-  handler: (ctx: BroContext<Body, Params, Query>) => Promise<any> | any;
-}
-
-export function defineRoute<Body = any, Params = any, Query = any>(
-  config: RouteConfig<Body, Params, Query>
-): RouteConfig<Body, Params, Query>;
-
-export interface BroConfig {
-  env?: ZodTypeAny;
-  server?: {
-    port?: number;
-    cors?: boolean | object;
-  };
-  auth?: {
-    jwtSecret?: string;
-    expiresIn?: string | number;
-  };
-  docs?: boolean | { auth?: { user: string; pass: string } };
-  rateLimit?: {
-    windowMs: number;
-    max: number;
-  };
-  upload?: {
-    limits?: {
-      fileSize?: number;
-      files?: number;
-      fields?: number;
-      [key: string]: any;
-    };
-  };
-  db?: () => Promise<any> | any;
-  sockets?: (io: any, db: any) => Promise<void> | void;
-}
-
-export function defineConfig(config: BroConfig): BroConfig;
-
-export { z } from 'zod';
+import { z, ZodTypeAny } from 'zod';
+
+type InferZod<T> = T extends ZodTypeAny ? z.infer<T> : any;
+
+export interface BroContext<Body = any, Params = any, Query = any> {
+  env?: any;
+  jwt?: { sign: (payload: any, options?: any) => string };
+  body: InferZod<Body>;
+  params: InferZod<Params>;
+  query: InferZod<Query>;
+  user?: any;
+  db?: any;
+  io?: any;
+  files?: any[];
+  locale: string;
+  t: (key: string, values?: Record<string, unknown>) => string;
+  error?: any;
+}
+
+export interface RouteConfig<Body = any, Params = any, Query = any> {
+  auth?: boolean;
+  upload?: boolean | { limits?: any, fields?: { name: string, maxCount?: number }[], single?: string, array?: string, fileFilter?: any, storage?: any };
+  body?: Body;
+  params?: Params;
+  query?: Query;
+  response?: ZodTypeAny;
+  rateLimit?: {
+    windowMs: number;
+    max: number;
+  };
+  summary?: string;
+  handler: (ctx: BroContext<Body, Params, Query>) => Promise<any> | any;
+}
+
+export function defineRoute<Body = any, Params = any, Query = any>(
+  config: RouteConfig<Body, Params, Query>
+): RouteConfig<Body, Params, Query>;
+
+export function loadLocale(directory: string, options?: { defaultLocale?: string }): Promise<{
+  locales: string[];
+  defaultLocale: string;
+  resolveLocale: (request: any) => string;
+  translate: (locale: string, key: string, values?: Record<string, unknown>) => string;
+}>;
+
+export interface BroConfig {
+  env?: ZodTypeAny;
+  server?: {
+    port?: number;
+    cors?: boolean | object;
+  };
+  locale?: {
+    directory?: string;
+    defaultLocale?: string;
+  };
+  auth?: {
+    jwtSecret?: string;
+    expiresIn?: string | number;
+  };
+  docs?: boolean | { auth?: { user: string; pass: string } };
+  rateLimit?: {
+    windowMs: number;
+    max: number;
+  };
+  upload?: {
+    limits?: {
+      fileSize?: number;
+      files?: number;
+      fields?: number;
+      [key: string]: any;
+    };
+  };
+  db?: () => Promise<any> | any;
+  sockets?: (io: any, db: any) => Promise<void> | void;
+  onShutdown?: (db: any) => Promise<void> | void;
+}
+
+export function defineConfig(config: BroConfig): BroConfig;
+
+export { z } from 'zod';

package/src/index.js

@@ -26,3 +26,4 @@ export function defineConfig(config) {
 }
 
 export { z };
+export { loadLocale } from './locale.js';

package/src/locale.js

@@ -0,0 +1,118 @@
+import fs from 'fs';
+import path from 'path';
+import { pathToFileURL } from 'url';
+import crypto from 'node:crypto';
+
+const LOCALE_EXTENSIONS = new Set(['.js', '.mjs', '.ts']);
+
+function localeFromFilename(fileName) {
+	return path.basename(fileName, path.extname(fileName));
+}
+
+function normalizeLocale(locale) {
+	const normalized = String(locale || '').trim().replaceAll('_', '-').toLowerCase();
+	const aliases = {
+		english: 'en',
+		arabic: 'ar',
+		french: 'fr',
+		spanish: 'es',
+		german: 'de',
+		portuguese: 'pt',
+		italian: 'it',
+		japanese: 'ja',
+		korean: 'ko',
+		chinese: 'zh'
+	};
+	return aliases[normalized] || normalized;
+}
+
+function findLocale(locales, requestedLocale, fallbackLocale) {
+	const requested = normalizeLocale(requestedLocale);
+	const exact = locales.find(locale => normalizeLocale(locale) === requested);
+	if (exact) return exact;
+
+	const language = requested.split('-')[0];
+	const languageMatch = locales.find(locale => normalizeLocale(locale).split('-')[0] === language);
+	if (languageMatch) return languageMatch;
+
+	return fallbackLocale;
+}
+
+function readMessage(messages, key) {
+	return key.split('.').reduce((value, part) => value?.[part], messages);
+}
+
+function interpolate(message, values) {
+	return message.replace(/\{(\w+)\}/g, (_, name) => {
+		return values[name] === undefined ? `{${name}}` : String(values[name]);
+	});
+}
+
+function parseAcceptLanguage(header) {
+	return String(header || '')
+		.split(',')
+		.map(value => {
+			const [tag, qVal] = value.split(';').map(s => s.trim());
+			let q = 1;
+			if (qVal && qVal.startsWith('q=')) {
+				const parsedQ = parseFloat(qVal.slice(2));
+				if (!isNaN(parsedQ)) q = parsedQ;
+			}
+			return { tag, q };
+		})
+		.filter(item => item.tag && item.q > 0)
+		.sort((a, b) => b.q - a.q)
+		.map(item => item.tag);
+}
+
+/**
+ * Loads translation files from the application's locale directory.
+ * Each file name becomes a locale, for example locale/en-US.js.
+ * @param {string} directory
+ * @param {{ defaultLocale?: string }} [options]
+ */
+export async function loadLocale(directory, options = {}) {
+	const files = fs.existsSync(directory)
+		? fs.readdirSync(directory).filter(file => {
+			const fullPath = path.join(directory, file);
+			return fs.statSync(fullPath).isFile() && LOCALE_EXTENSIONS.has(path.extname(file));
+		})
+		: [];
+
+	const messages = {};
+	for (const file of files) {
+		const module = await import(`${pathToFileURL(path.join(directory, file)).href}?update=${crypto.randomUUID()}`);
+		const catalog = module.default || module.messages || module;
+		if (catalog && typeof catalog === 'object') {
+			messages[localeFromFilename(file)] = catalog;
+		}
+	}
+
+	const locales = Object.keys(messages);
+	const configuredDefault = options.defaultLocale;
+	const defaultLocale = findLocale(locales, configuredDefault, null)
+		|| locales.find(locale => ['en', 'en-us'].includes(normalizeLocale(locale)))
+		|| locales[0]
+		|| 'en';
+
+	function resolveLocale(request) {
+		const requestedLocales = parseAcceptLanguage(request?.headers?.['accept-language']);
+		for (const requested of requestedLocales) {
+			const match = findLocale(locales, requested, null);
+			if (match) return match;
+		}
+		return defaultLocale;
+	}
+
+	function translate(locale, key, values = {}) {
+		const selectedLocale = findLocale(locales, locale, defaultLocale);
+		const message = readMessage(messages[selectedLocale], key)
+			?? readMessage(messages[defaultLocale], key);
+
+		if (message === undefined) return key;
+		if (typeof message !== 'string') return message;
+		return interpolate(message, values);
+	}
+
+	return { locales, defaultLocale, resolveLocale, translate };
+}

package/src/logger.js

@@ -1,79 +1,79 @@
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-export const colors = {
-  reset: "\x1b[0m",
-  bold: "\x1b[1m",
-  dim: "\x1b[2m",
-  red: "\x1b[31m",
-  green: "\x1b[32m",
-  yellow: "\x1b[33m",
-  blue: "\x1b[34m",
-  magenta: "\x1b[35m",
-  cyan: "\x1b[36m",
-  white: "\x1b[37m"
-};
-
-export function formatMethod(method) {
-  const m = method.toUpperCase().padEnd(6);
-  switch(method.toUpperCase()) {
-    case 'GET': return `${colors.green}${colors.bold}${m}${colors.reset}`;
-    case 'POST': return `${colors.blue}${colors.bold}${m}${colors.reset}`;
-    case 'PUT': return `${colors.yellow}${colors.bold}${m}${colors.reset}`;
-    case 'DELETE': return `${colors.red}${colors.bold}${m}${colors.reset}`;
-    case 'PATCH': return `${colors.magenta}${colors.bold}${m}${colors.reset}`;
-    default: return `${colors.white}${colors.bold}${m}${colors.reset}`;
-  }
-}
-
-export function printBanner(port, durationMs) {
-  const time = durationMs.toFixed(0);
-  
-  let version = "2.2.0";
-  try {
-    const __filename = fileURLToPath(import.meta.url);
-    const __dirname = path.dirname(__filename);
-    const pkgPath = path.join(__dirname, '..', 'package.json');
-    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
-    version = pkg.version;
-  } catch(e) {}
-  
-  const innerWidth = 47;
-
-  const stripAnsi = (str) => str.replace(/\x1B\[[0-9;]*[a-zA-Z]/g, "");
-
-  const formatLine = (content = "") => {
-    const visibleLength = stripAnsi(content).length;
-    const padding = Math.max(0, innerWidth - visibleLength);
-    return `${colors.green}│${colors.reset}${content}${" ".repeat(padding)}${colors.green}│${colors.reset}`;
-  };
-
-  const borderTop = `${colors.green}╭${"─".repeat(innerWidth)}╮${colors.reset}`;
-  const borderBottom = `${colors.green}╰${"─".repeat(innerWidth)}╯${colors.reset}`;
-
-  console.log("");
-  console.log(borderTop);
-  console.log(formatLine());
-  console.log(formatLine(`   ${colors.bold}bro.js${colors.reset} v${version}`));
-  console.log(formatLine());
-  console.log(formatLine(`   ➜  ${colors.bold}Local:${colors.reset}   ${colors.cyan}http://localhost:${port}${colors.reset}`));
-  console.log(formatLine(`   ➜  ${colors.bold}Ready in:${colors.reset} ${colors.yellow}${time}ms${colors.reset}`));
-  console.log(formatLine());
-  console.log(borderBottom);
-  console.log("");
-}
-
-export function printRoute(method, routePath, hasAuth, isLast = false) {
-  const branch = isLast ? "╰──" : "├──";
-  const coloredMethod = formatMethod(method);
-  const authIcon = hasAuth ? " 🔒" : "";
-  
-  console.log(`  ${colors.dim}${branch}${colors.reset} ${coloredMethod} ${routePath}${authIcon}`);
-}
-
-export function printHotReload(fileName, event, reloadTimeMs) {
-  const time = typeof reloadTimeMs === 'number' ? reloadTimeMs.toFixed(0) : reloadTimeMs;
-  console.log(`\n  ${colors.cyan}Route updated:${colors.reset} ${colors.bold}${fileName}${colors.reset} ${colors.dim}(${event})${colors.reset}`);
-  console.log(`  ${colors.dim}Remapped in ${time}ms${colors.reset}\n`);
-}
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+export const colors = {
+  reset: "\x1b[0m",
+  bold: "\x1b[1m",
+  dim: "\x1b[2m",
+  red: "\x1b[31m",
+  green: "\x1b[32m",
+  yellow: "\x1b[33m",
+  blue: "\x1b[34m",
+  magenta: "\x1b[35m",
+  cyan: "\x1b[36m",
+  white: "\x1b[37m"
+};
+
+export function formatMethod(method) {
+  const m = method.toUpperCase().padEnd(6);
+  switch(method.toUpperCase()) {
+    case 'GET': return `${colors.green}${colors.bold}${m}${colors.reset}`;
+    case 'POST': return `${colors.blue}${colors.bold}${m}${colors.reset}`;
+    case 'PUT': return `${colors.yellow}${colors.bold}${m}${colors.reset}`;
+    case 'DELETE': return `${colors.red}${colors.bold}${m}${colors.reset}`;
+    case 'PATCH': return `${colors.magenta}${colors.bold}${m}${colors.reset}`;
+    default: return `${colors.white}${colors.bold}${m}${colors.reset}`;
+  }
+}
+
+export function printBanner(port, durationMs) {
+  const time = durationMs.toFixed(0);
+  
+  let version = "2.2.0";
+  try {
+    const __filename = fileURLToPath(import.meta.url);
+    const __dirname = path.dirname(__filename);
+    const pkgPath = path.join(__dirname, '..', 'package.json');
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
+    version = pkg.version;
+  } catch(e) {}
+  
+  const innerWidth = 47;
+
+  const stripAnsi = (str) => str.replace(/\x1B\[[0-9;]*[a-zA-Z]/g, "");
+
+  const formatLine = (content = "") => {
+    const visibleLength = stripAnsi(content).length;
+    const padding = Math.max(0, innerWidth - visibleLength);
+    return `${colors.green}│${colors.reset}${content}${" ".repeat(padding)}${colors.green}│${colors.reset}`;
+  };
+
+  const borderTop = `${colors.green}╭${"─".repeat(innerWidth)}╮${colors.reset}`;
+  const borderBottom = `${colors.green}╰${"─".repeat(innerWidth)}╯${colors.reset}`;
+
+  console.log("");
+  console.log(borderTop);
+  console.log(formatLine());
+  console.log(formatLine(`   ${colors.bold}bro.js${colors.reset} v${version}`));
+  console.log(formatLine());
+  console.log(formatLine(`   ➜  ${colors.bold}Local:${colors.reset}   ${colors.cyan}http://localhost:${port}${colors.reset}`));
+  console.log(formatLine(`   ➜  ${colors.bold}Ready in:${colors.reset} ${colors.yellow}${time}ms${colors.reset}`));
+  console.log(formatLine());
+  console.log(borderBottom);
+  console.log("");
+}
+
+export function printRoute(method, routePath, hasAuth, isLast = false) {
+  const branch = isLast ? "╰──" : "├──";
+  const coloredMethod = formatMethod(method);
+  const authIcon = hasAuth ? " 🔒" : "";
+  
+  console.log(`  ${colors.dim}${branch}${colors.reset} ${coloredMethod} ${routePath}${authIcon}`);
+}
+
+export function printHotReload(fileName, event, reloadTimeMs, resourceType = 'Route') {
+  const time = typeof reloadTimeMs === 'number' ? reloadTimeMs.toFixed(0) : reloadTimeMs;
+  console.log(`\n  ${colors.cyan}${resourceType} updated:${colors.reset} ${colors.bold}${fileName}${colors.reset} ${colors.dim}(${event})${colors.reset}`);
+  console.log(`  ${colors.dim}Remapped in ${time}ms${colors.reset}\n`);
+}