codeweaver 3.0.7 → 3.1.0

package/README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-**Codeweaver** is an unopinionated microframework built with `Express`, `TypeScript`, and `Zod` (v4), seamlessly integrated with `Swagger` for comprehensive API documentation. Its modular architecture for routers promotes scalability and organized development, making it easy to expand and maintain. Routers are automatically discovered and wired up through a conventional folder structure, simplifying project organization and reducing boilerplate. Routers can be nested, allowing you to compose complex route trees by placing sub-routers inside parent router folders. It also uses `utils-decorators`, a collection of middleware utilities (throttling, caching, and error handling) designed to strengthen application resilience.
+**Codeweaver** is an microframework built with `Express`, `TypeScript`, and `Zod` (v4), seamlessly integrated with `Swagger` for comprehensive API documentation. Its modular architecture for routers promotes scalability and organized development, making it easy to expand and maintain. Routers are automatically discovered and wired up through a conventional folder structure, simplifying project organization and reducing boilerplate. Routers can be nested, allowing you to compose complex route trees by placing sub-routers inside parent router folders. It also uses `utils-decorators`, a collection of middleware utilities (throttling, caching, and error handling) designed to strengthen application resilience.
 
 ## Features and Technologies Used
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeweaver",
-  "version": "3.0.7",
+  "version": "3.1.0",
   "main": "src/main.ts",
   "bin": {
     "codeweaver": "command.js"

package/src/config.ts

@@ -10,6 +10,7 @@ import {
 } from "./constants";
 import { SwaggerOptions } from "./swagger-options";
 import { stringToBoolean } from "./utilities/conversion";
+import { logger } from "./utilities/logger/logger.config";
 
 /**
  * Main application configuration
@@ -31,7 +32,7 @@ interface Config {
   cacheSize: number;
 }
 
-let config: Config = {
+export const config: Config = {
   devMode: process.env.NODE_ENV !== productionEnvironment,
   http: process.env.HTTP || http,
   port: Number(process.env.PORT) || port,
@@ -66,4 +67,4 @@ let config: Config = {
   cacheSize: Number(process.env.CACHE_SIZE) || cacheSize,
 };
 
-export default config;
+export const container = { logger };

package/src/main.ts

@@ -1,7 +1,7 @@
 import express, { NextFunction, Request, Response } from "express";
 import fs from "fs";
 import path from "path";
-import config from "./config";
+import { config } from "./config";
 import { ResponseError } from "./utilities/error-handling";
 import { resolve } from "./utilities/container";
 import { WinstonLoggerService } from "./utilities/logger/winston-logger.service";

package/src/routers/orders/order.controller.ts

@@ -2,7 +2,7 @@ import { memoizeAsync, onError, rateLimit, timeout } from "utils-decorators";
 import { OrderDto, OrderCreationDto, ZodOrderDto } from "./dto/order.dto";
 import { ResponseError } from "@/utilities/error-handling";
 import { convert, stringToInteger } from "@/utilities/conversion";
-import config from "@/config";
+import { config } from "@/config";
 import { orders } from "@/db";
 import { Order, ZodOrder } from "@/entities/order.entity";
 import { MapAsyncCache } from "@/utilities/cache/memory-cache";

package/src/routers/products/product.controller.ts

@@ -7,7 +7,7 @@ import {
 } from "./dto/product.dto";
 import { MapAsyncCache } from "@/utilities/cache/memory-cache";
 import { convert, stringToInteger } from "@/utilities/conversion";
-import config from "@/config";
+import { config } from "@/config";
 import { ResponseError } from "@/utilities/error-handling";
 import { products } from "@/db";
 import { Product, ZodProduct } from "@/entities/product.entity";

package/src/routers/users/dto/user.dto.ts

@@ -1,5 +1,4 @@
 import { ZodUser } from "@/entities/user.entity";
-import z from "zod";
 
 export const ZodUserCreationDto = ZodUser.omit({ id: true });
 export const ZodUserDto = ZodUser.omit({ password: true });

package/src/routers/users/user.controller.ts

@@ -2,7 +2,7 @@ import { UserCreationDto, UserDto, ZodUserDto } from "./dto/user.dto";
 import { memoizeAsync, onError, rateLimit, timeout } from "utils-decorators";
 import { ResponseError } from "@/utilities/error-handling";
 import { convert, stringToInteger } from "@/utilities/conversion";
-import config from "@/config";
+import { config } from "@/config";
 import { users } from "@/db";
 import { User, ZodUser } from "@/entities/user.entity";
 import { MapAsyncCache } from "@/utilities/cache/memory-cache";

package/src/utilities/logger/base-logger.interface.ts

@@ -1,11 +1,36 @@
 // src/logging/BaseLogger.ts
 
+/**
+ * The supported log levels for the logger.
+ * - fatal: an unrecoverable error that will terminate the process
+ * - error: a recoverable error that should be reported
+ * - warn: unexpected situation that is not an error
+ * - info: general operational information
+ * - debug: detailed information useful for debugging
+ * - trace: highly verbose information for tracing execution
+ */
 export type LogLevel = "fatal" | "error" | "warn" | "info" | "debug" | "trace";
 
+/**
+ * Arbitrary metadata attached to log entries.
+ * Keys are strings and values can be any serializable data.
+ */
 export interface Meta {
   [key: string]: unknown;
 }
 
+/**
+ * A minimal base logger interface that defines a single logging method.
+ * Implementations should route messages to the appropriate output (console, file, etc.)
+ * according to the provided log level, message, and optional metadata.
+ */
 export interface BaseLogger {
+  /**
+   * Log a message at the specified log level, with optional metadata.
+   *
+   * @param level - The severity of the log message. One of: "fatal", "error", "warn", "info", "debug", "trace".
+   * @param message - The human-readable log message to record.
+   * @param meta - Optional additional structured data to accompany the log entry.
+   */
   log(level: LogLevel, message: string, meta?: Meta): void;
 }

package/src/utilities/parallel/parallel.ts

@@ -9,7 +9,10 @@ import { WorkerPool } from "./worker-pool";
  * @param {T} source - The source value to which `destination` will be rebound when the returned function runs.
  * @returns {() => void} A function that, when called, rebinds the captured `destination` to `source`.
  */
-export function set<T extends object>(destination: T, source: T): () => void {
+export function set<T extends object>(
+  destination: keyof T,
+  source: keyof T
+): () => void {
   return () => {
     destination = source;
   };