bro-framework 1.2.8 → 2.0.1

package/README.md

@@ -5,6 +5,7 @@
     <strong>The zero-boilerplate Node.js framework that actually has your back.</strong>
   </p>
   <p align="center">
+    <a href="https://www.npmjs.com/package/bro-framework"><img src="https://img.shields.io/npm/v/bro-framework.svg?style=flat-square&color=e11d48" alt="npm version"></a>
     <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" alt="License: MIT">
     <img src="https://img.shields.io/badge/Node.js-%3E%3D%2018-green.svg?style=flat-square" alt="Node.js: >= 18">
     <img src="https://img.shields.io/badge/Architecture-Pure%20ESM-orange.svg?style=flat-square" alt="Architecture: Pure ESM">
@@ -16,7 +17,6 @@
     <a href="https://brojs.yessindevs.me">Documentation Website</a>
   </p>
 </p>
-
 ---
 
 > "NestJS wants four decorators, three modules, and an existential crisis just to handle a GET request. Express makes you write the same 40 lines of CORS, JSON parsing, and auth middleware for every project. bro.js gives you file routing, auto-validation, JWT auth, WebSockets, and live docs out of the box. Be honest: you just want to return an object."
@@ -25,6 +25,7 @@
 
 ## Table of Contents
 
+- [Getting Started](#getting-started)
 - [The Core Experience](#the-core-experience)
 - [Deep-Dive Features](#deep-dive-features)
 - [Architecture & Request Lifecycle](#architecture--request-lifecycle)
@@ -34,6 +35,20 @@
 
 ---
 
+## Getting Started
+
+Bootstrapping a new `bro.js` project is incredibly simple. We recommend using our official scaffolding tool to set everything up instantly (with your choice of JavaScript or TypeScript):
+
+```bash
+npx create-bro-framework@latest my-api
+cd my-api
+npm run dev
+```
+
+That's it! Your zero-boilerplate backend is now running with hot-reloading enabled.
+
+---
+
 ## The Core Experience
 
 In `bro.js`, everything you need is handed to you instantly. No setup, no middleware wrangling, no manual `req/res` handling. You define your route, set your validation, and return an object. 

package/bin/bro.js

@@ -3,6 +3,10 @@
 import path from 'path';
 import fs from 'fs';
 import { pathToFileURL } from 'url';
+import { register } from 'tsx/esm/api';
+
+register();
+
 import { createServer } from '../src/server.js';
 import { colors, printBanner, printRoute, printHotReload } from '../src/logger.js';
 import { scanTasks } from '../src/tasks.js';
@@ -44,6 +48,13 @@ export default defineConfig({
     max: 100 // limit each IP to 100 requests per windowMs
   },
 
+  // WebSockets Setup
+  sockets: async (io, db) => {
+    io.on('connection', (socket) => {
+      console.log('Client connected:', socket.id);
+    });
+  },
+
   // Database Context Injection
   // This instance will be injected into every route's ctx.db (if defined)
   db: async () => {
@@ -63,13 +74,6 @@ export default defineConfig({
     // return mongoose.connection; 
     // --------------------------
     return null;
-  },
-  
-  // WebSockets Setup
-  sockets: async (io, db) => {
-    io.on('connection', (socket) => {
-      console.log('Client connected:', socket.id);
-    });
   }
 });
 `;
@@ -118,10 +122,10 @@ if (command === 'init') {
 
 if (['sdk', 'generate-client', 'client'].includes(command)) {
   generateSDK().then(() => {
-    console.log(`\n  ${colors.green}✨ bro-client.js generated successfully!${colors.reset}\n`);
+    console.log(`\n  ${colors.green} bro-client.js generated successfully!${colors.reset}\n`);
     process.exit(0);
   }).catch(err => {
-    console.error(`\n  ${colors.red}❌ Error generating SDK:${colors.reset}`, err.message);
+    console.error(`\n  ${colors.red} Error generating SDK:${colors.reset}`, err.message);
     process.exit(1);
   });
 }
@@ -171,7 +175,7 @@ async function bootstrap() {
   if (globalConfig.env) {
     const envResult = globalConfig.env.safeParse(process.env);
     if (!envResult.success) {
-      console.error(`\n  ${colors.red}❌ Environment Validation Failed${colors.reset}`);
+      console.error(`\n  ${colors.red} Environment Validation Failed${colors.reset}`);
       envResult.error.errors.forEach(err => {
         console.error(`  ${colors.dim}-${colors.reset} ${colors.bold}${err.path.join('.')}${colors.reset}: ${err.message}`);
       });
@@ -218,7 +222,7 @@ async function bootstrap() {
       const watcher = chokidar.watch(routesDir, { ignoreInitial: true });
       
       watcher.on('all', async (event, filepath) => {
-        if (!filepath.endsWith('.js')) return;
+        if (!filepath.endsWith('.js') && !filepath.endsWith('.ts')) return;
         
         try {
           const reloadStartTime = performance.now();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bro-framework",
-  "version": "1.2.8",
+  "version": "2.0.1",
   "description": "The No-BS Backend Framework for Node.js",
   "repository": {
     "type": "git",
@@ -10,9 +10,13 @@
   "author": "Yessindevs",
   "license": "MIT",
   "main": "src/index.js",
+  "types": "src/index.d.ts",
   "type": "module",
   "exports": {
-    ".": "./src/index.js"
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    }
   },
   "bin": {
     "bro": "./bin/bro.js"
@@ -32,6 +36,7 @@
     "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"
   },

package/src/index.d.ts

@@ -1,9 +1,11 @@
-import { ZodType } from 'zod';
+import { z, ZodTypeAny } from 'zod';
 
-export interface BroContext {
-  body?: any;
-  params?: any;
-  query?: any;
+type InferZod<T> = T extends ZodTypeAny ? z.infer<T> : any;
+
+export interface BroContext<Body = any, Params = any, Query = any> {
+  body: InferZod<Body>;
+  params: InferZod<Params>;
+  query: InferZod<Query>;
   user?: any;
   db?: any;
   io?: any;
@@ -11,24 +13,26 @@ export interface BroContext {
   error?: any;
 }
 
-export interface RouteConfig {
+export interface RouteConfig<Body = any, Params = any, Query = any> {
   auth?: boolean;
   upload?: boolean;
-  body?: ZodType<any, any, any>;
-  params?: ZodType<any, any, any>;
-  query?: ZodType<any, any, any>;
+  body?: Body;
+  params?: Params;
+  query?: Query;
   rateLimit?: {
     windowMs: number;
     max: number;
   };
   summary?: string;
-  handler: (ctx: BroContext) => Promise<any> | any;
+  handler: (ctx: BroContext<Body, Params, Query>) => Promise<any> | any;
 }
 
-export function defineRoute(config: RouteConfig): RouteConfig;
+export function defineRoute<Body = any, Params = any, Query = any>(
+  config: RouteConfig<Body, Params, Query>
+): RouteConfig<Body, Params, Query>;
 
 export interface BroConfig {
-  env?: ZodType<any, any, any>;
+  env?: ZodTypeAny;
   server?: {
     port?: number;
     cors?: boolean | object;

package/src/logger.js

@@ -25,17 +25,29 @@ export function formatMethod(method) {
 
 export function printBanner(port, durationMs) {
   const time = durationMs.toFixed(0);
-  const version = "1.0.0";
-  
+  const version = "2.0.1";
+  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(`${colors.green}╭───────────────────────────────────────────────╮${colors.reset}`);
-  console.log(`${colors.green}│${colors.reset}                                               ${colors.green}│${colors.reset}`);
-  console.log(`${colors.green}│${colors.reset}   ${colors.bold}bro.js${colors.reset} v${version}                           ${colors.green}│${colors.reset}`);
-  console.log(`${colors.green}│${colors.reset}                                               ${colors.green}│${colors.reset}`);
-  console.log(`${colors.green}│${colors.reset}   ➜  ${colors.bold}Local:${colors.reset}   ${colors.cyan}http://localhost:${port}${colors.reset}         ${colors.green}│${colors.reset}`);
-  console.log(`${colors.green}│${colors.reset}   ➜  ${colors.bold}Ready in:${colors.reset} ${colors.yellow}${time}ms${colors.reset}                         ${colors.green}│${colors.reset}`);
-  console.log(`${colors.green}│${colors.reset}                                               ${colors.green}│${colors.reset}`);
-  console.log(`${colors.green}╰───────────────────────────────────────────────╯${colors.reset}`);
+  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("");
 }
 

package/src/router.js

@@ -18,7 +18,7 @@ export function scanDir(dir, fileList = []) {
     const filePath = path.join(dir, file);
     if (fs.statSync(filePath).isDirectory()) {
       scanDir(filePath, fileList);
-    } else if (filePath.endsWith('.js')) {
+    } else if (filePath.endsWith('.js') || filePath.endsWith('.ts')) {
       fileList.push(filePath);
     }
   }