deploy-bbc 1.3.0 → 1.3.2

package/README.md

@@ -198,24 +198,38 @@ During setup, you'll be asked:
 
 ### Usage
 
-If you selected to dockerize your databases:
+When you enable Docker during setup, a convenient `docker:dev` script is automatically added to your `package.json`.
+
+#### Quick Start
 
 ```bash
-# Start only databases
+# Start all Docker services (databases and/or backend)
+bun run docker:dev
+```
+
+This script runs `docker-compose up`, starting all services defined in your `docker-compose.yml`.
+
+#### Manual Control
+
+You can also use docker-compose directly for more control:
+
+```bash
+# Start only specific services (e.g., databases only)
 docker-compose up postgres redis -d
 
 # Run your app locally
 bun run dev
 ```
 
-If you dockerized both databases and backend:
-
 ```bash
-# Start everything
-docker-compose up
-
-# Or in detached mode
+# Start everything in detached mode
 docker-compose up -d
+
+# View logs
+docker-compose logs -f
+
+# Stop services
+docker-compose down
 ```
 
 ### SQLite with Docker

package/dist/index.js

@@ -16800,7 +16800,7 @@ async function init_git(projectDir) {
 }
 
 // src/helpers/log-next-steps.ts
-function log_next_steps(options, _cliResults) {
+function log_next_steps(options, cliResults) {
   const { appName, packages, projectDir } = options;
   const isCurrentDirectory = projectDir === process.cwd();
   console.log(`
@@ -16820,10 +16820,10 @@ function log_next_steps(options, _cliResults) {
   console.log(`   ${source_default.gray("# Edit .env with your configuration")}`);
   console.log();
   stepNumber++;
-  const hasDocker = packages.includes("postgres" /* postgres */) || packages.includes("mysql" /* mysql */) || packages.includes("mongodb" /* mongodb */) || packages.includes("redis" /* redis */);
+  const hasDocker = cliResults.flags.dockerizeDb || cliResults.flags.dockerizeBackend;
   if (hasDocker) {
     console.log(source_default.cyan(`${stepNumber}.`) + " Start Docker services:");
-    console.log(`   ${source_default.gray("docker-compose up -d")}`);
+    console.log(`   ${source_default.gray("bun run docker:dev")}`);
     console.log();
     stepNumber++;
   }
@@ -16851,6 +16851,22 @@ function render_title(title) {
 ` + source_default.bold.cyan(`▸ ${title}`));
 }
 
+// src/utils/add-package-scripts.ts
+var import_fs_extra18 = __toESM(require_lib(), 1);
+import path24 from "path";
+async function add_package_scripts(projectDir, scripts) {
+  const packageJsonPath = path24.join(projectDir, "package.json");
+  const packageJson = await import_fs_extra18.default.readJson(packageJsonPath);
+  if (!packageJson.scripts) {
+    packageJson.scripts = {};
+  }
+  packageJson.scripts = {
+    ...packageJson.scripts,
+    ...scripts
+  };
+  await import_fs_extra18.default.writeJson(packageJsonPath, packageJson, { spaces: 2 });
+}
+
 // src/helpers/create-project.ts
 async function create_project(cliResults) {
   try {
@@ -16877,6 +16893,9 @@ async function create_project(cliResults) {
       }
       if (cliResults.flags.dockerizeDb || cliResults.flags.dockerizeBackend) {
         await generate_docker_compose(installerOptions);
+        await add_package_scripts(projectDir, {
+          "docker:dev": "docker-compose up"
+        });
       }
     }
     if (!cliResults.flags.noInstall) {

package/dist/templates/templates/base-express/src/index.ts

@@ -1,8 +1,9 @@
 import express from "express";
 import { logger as loggerMiddleware } from "./middleware/logger.js";
-import { errorHandler } from "./middleware/error.js";
+import {error_handler} from "./middleware/error-handler.js";
 import routes from "./routes/index.js";
 import { config } from "./config/index.js";
+import { success_handler } from "./middleware/succcess-handler.js";
 
 const app = express();
 
@@ -10,6 +11,7 @@ const app = express();
 app.use(express.json());
 app.use(express.urlencoded({ extended: true }));
 app.use(loggerMiddleware);
+app.use(success_handler)
 
 // Routes
 app.use("/", routes);
@@ -20,7 +22,7 @@ app.get("/health", (req, res) => {
 });
 
 // Error handler (must be last)
-app.use(errorHandler);
+app.use(error_handler);
 
 app.listen(config.port, () => {
   console.log(`🚀 Server running on http://localhost:${config.port}`);

package/dist/templates/templates/base-express/src/middleware/error-handler.ts

@@ -0,0 +1,42 @@
+import type { Request, Response, NextFunction } from "express";
+import CustomError from "../utils/CustomError";
+
+type TSendErrorAsResponse = {
+  error: Error | CustomError;
+  req: Request;
+  res: Response;
+}
+
+type TErrorResponse = {
+  message: string;
+  status_code: number;
+  stack?: string;
+}
+
+export const error_handler = (
+  err: Error | CustomError,
+  req: Request,
+  res: Response,
+  _next: NextFunction
+) => {
+
+  console.error(`Error: ${err.message}`, err);
+//TODO: Update error handler based on type of database and type of validator
+  send_error_as_response({error:err,req,res})
+};
+
+
+
+
+const send_error_as_response =(
+  {error,req,res}: TSendErrorAsResponse
+) => {
+//TODO: update send_error_as_response based on type of logger
+  const error_response: TErrorResponse = {
+    message: error.message,
+    status_code: error instanceof CustomError ? error.status_code : 500,
+    stack: error instanceof Error ? error.stack : undefined,
+  };
+
+  res.status(error_response.status_code).json(error_response);
+};

package/dist/templates/templates/base-express/src/middleware/succcess-handler.ts

@@ -0,0 +1,20 @@
+import { NextFunction, Request, Response} from 'express'
+
+type TSuccessHandler= {
+    req: Request,
+    res: Response,
+    next: NextFunction
+}
+
+export const success_handler = (
+    {req, res, next} :  TSuccessHandler)=>{
+
+        const original_json = res.json
+
+        res.json = function (json: any): Response {
+            //TODO: logic to have logger and other success resposne parsing
+            return original_json.call(this,json)
+        }
+
+        next();
+}

package/dist/templates/templates/base-express/src/types/common/api-response.types.ts

@@ -2,29 +2,24 @@
  * Common API response types
  */
 
-export interface ApiResponse<T = unknown> {
-  success: boolean;
-  data?: T;
-  error?: string;
-  message?: string;
-}
 
-export interface PaginatedResponse<T> extends ApiResponse<T[]> {
-  pagination: {
-    page: number;
-    limit: number;
-    total: number;
-    totalPages: number;
-  };
+export type TApiSuccess<T =unknown> = {
+  data?: T;
+  message: string;
+  pagination?: TPaginationResponse
 }
 
-export interface ValidationError {
-  field: string;
+export type TApiError = {
+  status_code: number;
   message: string;
 }
 
-export interface ApiError {
-  success: false;
-  error: string;
-  details?: ValidationError[];
+export type TApiResponse<T = unknown> = TApiSuccess<T> | TApiError
+
+export type TPaginationResponse = {
+  page: number;
+  limit: number;
+  total_pages: number;
+  total_count: number;
 }
+

package/dist/templates/templates/base-express/src/types/common/mongodb.types.ts

@@ -0,0 +1,5 @@
+export type TDocument<Tid = string> = {
+    _id: Tid
+    createdAt: Date
+    updatedAt: Date
+} 

package/dist/templates/templates/base-express/src/types/models/user.types.ts

@@ -2,25 +2,17 @@
  * User model types
  */
 
-export interface User {
-  id: string;
-  email: string;
-  name: string;
-  createdAt: Date;
-  updatedAt: Date;
-}
+import { TDocument } from "../common/mongodb.types";
+
 
-export interface CreateUserInput {
+
+export type TUser<Tid= string> = TDocument<Tid> & {
   email: string;
   name: string;
 }
 
-export interface UpdateUserInput {
-  email?: string;
-  name?: string;
-}
+export type TCreateUserInput = Pick<TUser, 'email' | 'name'>
+
+export type TUpdateUserInput = Partial<Pick<TUser, 'email' | 'name'>>
 
-export type UserResponse = Omit<User, "createdAt" | "updatedAt"> & {
-  createdAt: string;
-  updatedAt: string;
-};
+export type TUserResponse = Omit<TUser, "createdAt" | "updatedAt"> & Pick<TDocument, 'createdAt' | 'updatedAt'>

package/dist/templates/templates/base-express/src/utils/CustomError.ts

@@ -0,0 +1,17 @@
+class CustomError extends Error {
+    status_code: number;
+
+    constructor(
+        message: string = 'Internal Server Error',
+        status_code: number = 500
+    ){
+        super(message);
+        this.status_code = status_code;
+
+        Object.setPrototypeOf(this, CustomError.prototype);
+
+        Error.captureStackTrace(this, this.constructor);
+    }
+}
+
+export default CustomError;

package/dist/templates/templates/base-express/src/utils/env.ts

@@ -1,5 +1,12 @@
-import { config as dotenvConfig } from "dotenv";
+import dotenv from 'dotenv'
+import path from 'path'
 
-export function load_env(): void {
-  dotenvConfig();
+dotenv.config({path: path.resolve(__dirname, '../../.env')})
+
+export type TEnv = {
+  port: number
 }
+
+export const env: TEnv = {
+  port: parseInt(process.env.PORT || '8000');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "deploy-bbc",
-    "version": "1.3.0",
+    "version": "1.3.2",
     "description": "CLI to bootstrap production-ready backends with Bun (Best Backend Code)",
     "type": "module",
     "bin": {