codeweaver 2.2.0 → 2.3.0

package/.env.example

@@ -0,0 +1,20 @@
+# Environment
+NODE_ENV=development              # or "production" depending on your deployment
+
+# Server
+HTTP=http://localhost:3000
+PORT=3000
+
+# Feature flags
+SWAGGER=true
+
+# Timeouts and limits
+TIMEOUT=30
+
+# Rate limiting (separate vars)
+RATE_LIMIT_TIME_SPAN=60
+RATE_LIMIT_ALLOWED_CALLS=100
+
+# Memoization and cache
+MEMOIZE_TIME=300
+CACHE_SIZE=1000

package/README.md

@@ -10,10 +10,14 @@
 - **Express**: A lightweight web framework for building server-side applications in Node.js.
 - **TypeScript**: Adds strong typing for enhanced development experience and reduced runtime errors.
 - **Modular Router Structure**: Automates importing and mounting routers, ensuring a clean separation of endpoints and logic for easier scalability.
+- **Dependency resolver**: A simple dependency resolver that uses a lightweight container to manage and inject dependencies at runtime.
 - **Swagger Integration**: Automatically generates interactive API documentation, facilitating easier understanding of available endpoints for developers and consumers.
 - **Async Handlers**: Utilizes async/await syntax for cleaner, more maintainable asynchronous code without callback nesting.
 - **Zod**: Implements schema validation for input data.
-- **utils-decorators**: A collection of middleware utilities (throttling, caching, and error handling) designed to strengthen application resilience.
+- **Utils-decorators**: A collection of middleware utilities utils-decorators (throttling, caching, and error handling) designed to strengthen application resilience.
+- **Logger**: A Winston-based logger (with LogForm) that provides scalable, leveled logging, structured JSON output, and pluggable transports (console and file)
+
+Here's a revised Installation section that explicitly supports pnpm in addition to npm. I kept the formatting and steps intact, adding clear pnpm equivalents.
 
 ## Installation
 
@@ -29,9 +33,19 @@ To get started with the project, follow these steps:
 
 2. **Install dependencies**:
 
-   ```bash
-   npm install
-   ```
+   Choose your package manager and install:
+
+   - Using npm:
+
+     ```bash
+     npm install
+     ```
+
+   - Using pnpm:
+
+     ```bash
+     pnpm install
+     ```
 
 3. **Run the application**:
 
@@ -39,14 +53,29 @@ To get started with the project, follow these steps:
    npm start
    ```
 
+   Or, if you used pnpm:
+
+   ```bash
+   pnpm start
+   ```
+
 4. **Visit the Swagger UI**: Open your browser and go to `http://localhost:3000/api-docs` to view the automatically generated API documentation.
 
 5. **Build**: Compile the TypeScript files for the production environment:
 
-   ```bash
-   npm run build
-   npm run serve
-   ```
+   - Using npm:
+
+     ```bash
+     npm run build
+     npm run serve
+     ```
+
+   - Using pnpm:
+
+     ```bash
+     pnpm run build
+     pnpm run serve
+     ```
 
 ## Sample Project Structure
 
@@ -89,9 +118,10 @@ Example of a basic router:
 import { Router, Request, Response } from "express";
 import asyncHandler from "express-async-handler";
 import UserController from "./user.controller";
+import { resolve } from "@/utilities/container";
 
 const router = Router();
-const userController = new UserController();
+const userController = resolve(UserController);
 
 /**
  * @swagger
@@ -210,17 +240,13 @@ import config from "@/config";
 import { users } from "@/db";
 import { User } from "@/entities/user.entity";
 import { MapAsyncCache } from "@/utilities/cache/memory-cache";
+import { Injectable } from "@/utilities/container";
 
 function exceedHandler() {
   const message = "Too much call in allowed window";
   throw new ResponseError(message, 429);
 }
 
-function userNotFoundHandler(e: ResponseError) {
-  const message = "User not found.";
-  throw new ResponseError(message, 404, e?.message);
-}
-
 function invalidInputHandler(e: ResponseError) {
   const message = "Invalid input";
   throw new ResponseError(message, 400, e?.message);
@@ -229,6 +255,7 @@ function invalidInputHandler(e: ResponseError) {
 const usersCache = new MapAsyncCache<UserDto[]>(config.cacheSize);
 const userCache = new MapAsyncCache<UserDto>(config.cacheSize);
 
+@Injectable()
 /**
  * Controller for handling user-related operations
  * @class UserController

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeweaver",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "main": "src/main.ts",
   "bin": {
     "create-codeweaver-app": "./command.js"

package/src/config.ts

@@ -4,8 +4,9 @@ import {
   rateLimitTimeSpan,
   rateLimitAllowedCalls,
   timeout,
-  portNumber,
+  port,
   cacheSize,
+  http,
 } from "./constants";
 import { SwaggerOptions } from "./swagger-options";
 import { stringToBoolean } from "./utilities/conversion";
@@ -19,6 +20,7 @@ import { stringToBoolean } from "./utilities/conversion";
  */
 interface Config {
   devMode: boolean;
+  http: string;
   port: number;
   swagger: boolean;
   swaggerOptions: SwaggerOptions;
@@ -29,11 +31,10 @@ interface Config {
   cacheSize: number;
 }
 
-const port = Number(process.env.PORT) || portNumber;
-
 let config: Config = {
   devMode: process.env.NODE_ENV !== productionEnvironment,
-  port,
+  http: process.env.HTTP || http,
+  port: Number(process.env.PORT) || port,
   swagger: stringToBoolean(process.env.SWAGGER || "true"),
   swaggerOptions: {
     swaggerDefinition: {
@@ -57,9 +58,10 @@ let config: Config = {
     ], // Path to the API docs
   },
   timeout: Number(process.env.TIMEOUT) || timeout,
-  rateLimitTimeSpan: Number(process.env.RATE_LIMIT) || rateLimitTimeSpan,
+  rateLimitTimeSpan:
+    Number(process.env.RATE_LIMIT_TIME_SPAN) || rateLimitTimeSpan,
   rateLimitAllowedCalls:
-    Number(process.env.RATE_LIMIT) || rateLimitAllowedCalls,
+    Number(process.env.RATE_LIMIT_ALLOWED_CALLS) || rateLimitAllowedCalls,
   memoizeTime: Number(process.env.MEMOIZE_TIME) || memoizeTime,
   cacheSize: Number(process.env.CACHE_SIZE) || cacheSize,
 };

package/src/constants.ts

@@ -1,7 +1,12 @@
+export const http = "http://localhost";
+export const port = 3000;
 export const timeout = 20000;
 export const rateLimitTimeSpan = 60000;
 export const rateLimitAllowedCalls = 300;
 export const memoizeTime = 1000 * 60 * 60;
 export const cacheSize = 1000;
 export const productionEnvironment = "production";
-export const portNumber = 3000;
+export const swaggerPath = "/api-docs";
+export const routerDir = "/routers";
+export const routerExtension = ".router";
+export const defaultRouter = "index";

package/src/main.ts

@@ -5,6 +5,14 @@ import config from "./config";
 import { ResponseError } from "./utilities/error-handling";
 import { resolve } from "./utilities/container";
 import { WinstonLoggerService } from "./utilities/logger/winston-logger.service";
+import "dotenv/config";
+import {
+  defaultRouter,
+  routerDir,
+  routerExtension,
+  swaggerPath,
+} from "./constants";
+//import cors from "cors";
 
 /**
  * Recursively loads Express routers from directory
@@ -30,17 +38,20 @@ function loadRouters(routerPath: string, basePath: string = "") {
 
     // Only handle router files
     if (
-      !entry.name.endsWith(".router.ts") &&
-      !entry.name.endsWith(".router.js")
+      !entry.name.endsWith(`${routerExtension}.ts`) &&
+      !entry.name.endsWith(`${routerExtension}.js`)
     ) {
       continue;
     }
 
     // Build route path safely
     const routePath = path
-      .join(basePath, entry.name.replace(/\.router\.[tj]s$/, ""))
+      .join(
+        basePath,
+        entry.name.replace(new RegExp(`\\${routerExtension}\\.([tj]s)$`), "")
+      )
       .replace(/\\/g, "/")
-      .replace(/\/?index$/g, "");
+      .replace(new RegExp(`\\/?${defaultRouter}$`), "");
 
     // Optional: skip if the target path would be empty (maps to /)
     const mountPath = "/" + (routePath || "");
@@ -53,11 +64,12 @@ function loadRouters(routerPath: string, basePath: string = "") {
 }
 
 const app = express();
+//app.use(cors());
 app.use(express.json());
 app.use(express.urlencoded({ extended: true }));
 
 // Automatically import all routers from the /src/routers directory
-const routersPath = path.join(__dirname, "/routers");
+const routersPath = path.join(__dirname, routerDir);
 loadRouters(routersPath);
 
 // Swagger setup
@@ -65,7 +77,7 @@ if (config.swagger) {
   const swaggerJsDoc = require("swagger-jsdoc");
   const swaggerUi = require("swagger-ui-express");
   const swaggerDocs = swaggerJsDoc(config.swaggerOptions);
-  app.use("/api-docs", swaggerUi.serve, swaggerUi.setup(swaggerDocs));
+  app.use(swaggerPath, swaggerUi.serve, swaggerUi.setup(swaggerDocs));
 }
 
 const logger = resolve(WinstonLoggerService);
@@ -74,21 +86,33 @@ const logger = resolve(WinstonLoggerService);
 app.use(
   (error: ResponseError, req: Request, res: Response, next: NextFunction) => {
     const status = error.status ?? 500;
+    const errorObject = {
+      status,
+      code: error.code,
+      input: error.input,
+      stack: error.stack,
+      cause: error.cause,
+    };
+
     res.status(status).json(error);
     if (status < 500) {
-      logger.warn(error.message, "Invalid request", error.details);
+      logger.warn(error.message, "Invalid request", error.details, errorObject);
     } else {
-      logger.error(error.message, "Server error", error.details);
+      if (status == 401 || status == 403) {
+        logger.fatal(error.message, "Forbidden", error.details, errorObject);
+      } else {
+        logger.error(error.message, "Server error", error.details, errorObject);
+      }
     }
   }
 );
 
 // Start the server
 app.listen(config.port, () => {
-  console.log(`Server is running on http://localhost:${config.port}`);
+  console.log(`Server is running on ${config.http}:${config.port}`);
   if (config.devMode) {
     console.log(
-      `Swagger UI is available at http://localhost:${config.port}/api-docs`
+      `Swagger UI is available at ${config.http}:${config.port}${swaggerPath}`
     );
   }
 });

package/.vscode/settings.json

@@ -1,3 +0,0 @@
-{
-  "cSpell.words": ["microframework"]
-}