codeweaver 2.3.1 → 3.0.1

package/README.md

@@ -31,51 +31,34 @@ To get started with the project, follow these steps:
    cd my-app
    ```
 
-2. **Install dependencies**:
+2. **Clone the repository**:
 
-   Choose your package manager and install:
+   Using pnpm:
 
-   - Using npm:
-
-     ```bash
-     npm install
-     ```
-
-   - Using pnpm:
-
-     ```bash
-     pnpm install
-     ```
+   ```bash
+   pnpm install
+   ```
 
-3. **Run the application**:
+   Using npm:
 
    ```bash
-   npm start
+   npm install
    ```
 
-   Or, if you used pnpm:
+3. **Run the application**:
 
    ```bash
-   pnpm start
+   npm 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:
 
-   - Using npm:
-
-     ```bash
-     npm run build
-     npm run serve
-     ```
-
-   - Using pnpm:
-
-     ```bash
-     pnpm run build
-     pnpm run serve
-     ```
+   ```bash
+   npm run build
+   npm run serve
+   ```
 
 ## Sample Project Structure
 

package/command.js

@@ -1,37 +1,41 @@
 #!/usr/bin/env node
 
 const fs = require("fs");
-const { exec } = require("child_process");
 const path = require("path");
-const { version } = require("os");
-const { object } = require("zod");
+const { exec: _exec } = require("child_process");
+const { promisify } = require("util");
 
-// Get the project name from command-line arguments or use a default name
-const projectName = process.argv[2] || "my-app";
+const exec = promisify(_exec);
+const readFile = promisify(fs.readFile);
+const writeFile = promisify(fs.writeFile);
+const access = promisify(fs.access);
 
-// Set the URL of the GitHub repository
-const repoUrl = "https://github.com/js-code-crafter/codeweaver.git";
+(async () => {
+  try {
+    // Get the project name from command-line arguments or use a default name
+    const projectName = process.argv[2] || "my-app";
 
-// Clone the repository into the specified project name
-exec(`git clone ${repoUrl} ${projectName}`, (error) => {
-  if (error) {
-    console.error(`Error cloning repository: ${error.message}`);
-    return;
-  }
+    // Set the URL of the GitHub repository
+    const repoUrl = "https://github.com/js-code-crafter/codeweaver.git";
 
-  // Path to the cloned package.json file
-  const packageJsonPath = path.join(projectName, "package.json");
+    // Clone the repository into the specified project name
+    await exec(`git clone ${repoUrl} ${projectName}`);
+    console.log(`Cloned repository into ${projectName}`);
 
-  // Update the package.json file
-  fs.readFile(packageJsonPath, "utf8", (readError, data) => {
-    if (readError) {
-      console.error(`Error reading package.json: ${readError.message}`);
-      return;
-    }
+    // Path to the cloned package.json file
+    const packageJsonPath = path.join(projectName, "package.json");
+
+    // Ensure package.json exists before trying to read
+    await access(packageJsonPath);
 
-    // Parse the package.json content and update the name
-    const { bin, ...packageJson } = JSON.parse(data);
+    // Read and parse package.json
+    const data = await readFile(packageJsonPath, "utf8");
+    const parsed = JSON.parse(data);
 
+    // Remove the bin field if it exists (as in your original logic)
+    const { bin, ...packageJson } = parsed;
+
+    // Update fields as requested
     Object.assign(packageJson, {
       name: projectName,
       version: "1.0.0",
@@ -42,35 +46,29 @@ exec(`git clone ${repoUrl} ${projectName}`, (error) => {
     });
 
     // Write the updated package.json back to the file
-    fs.writeFile(
-      packageJsonPath,
-      JSON.stringify(packageJson, null, 2),
-      (writeError) => {
-        if (writeError) {
-          console.error(`Error writing package.json: ${writeError.message}`);
-          return;
-        }
-
-        // Remove the command.js file
-        exec(`rm -f ${path.join(projectName, "command.js")}`, (rmError) => {
-          if (rmError) {
-            console.error(`Error removing command.js file: ${rmError.message}`);
-            return;
-          }
+    await writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2));
 
-          // Remove the .git folder
-          exec(`rm -rf ${path.join(projectName, ".git")}`, (rm2Error) => {
-            if (rm2Error) {
-              console.error(`Error removing .git folder: ${rm2Error.message}`);
-              return;
-            }
-
-            console.log(
-              `Successfully cloned codeweaver into ${path.resolve(projectName)}`
-            );
-          });
-        });
+    // Remove the command.js file if it exists
+    const commandJsPath = path.join(projectName, "command.js");
+    try {
+      await exec(`rm -f ${commandJsPath}`);
+    } catch (err) {
+      // If removal fails because the file doesn't exist, ignore
+      // Otherwise, log the error
+      if (err && err.code !== 1) {
+        console.error(`Error removing command.js file: ${err.message}`);
+        // Continue anyway
       }
-    );
-  });
-});
+    }
+
+    // Remove the .git folder
+    try {
+      await exec(`rm -rf ${path.join(projectName, ".git")}`);
+    } catch (err) {
+      console.error(`Error removing .git folder: ${err.message}`);
+      // continue anyway
+    }
+  } catch (error) {
+    console.error(`Error: ${error.message}`);
+  }
+})();

package/package.json

@@ -1,10 +1,7 @@
 {
   "name": "codeweaver",
-  "version": "2.3.1",
+  "version": "3.0.1",
   "main": "src/main.ts",
-  "bin": {
-    "create-codeweaver-app": "./command.js"
-  },
   "scripts": {
     "start": "nodemon -r tsconfig-paths/register src/main.ts",
     "dev": "nodemon -r tsconfig-paths/register src/main.ts",
@@ -12,26 +9,19 @@
     "serve": "cross-env TSCONFIG_PATH=tsconfig.paths.json node -r tsconfig-paths/register dist/main.js"
   },
   "keywords": [
-    "codeweaver",
-    "node framework",
-    "js framework",
-    "javascript",
-    "typescript",
-    "code",
-    "weaver",
     "framework",
-    "boilerplate",
-    "bootstrap",
     "lightweight",
-    "nested routers",
+    "node",
+    "Express",
+    "boilerplate",
+    "utility",
     "decorator",
-    "swagger",
-    "zod",
-    "utils-decorators"
+    "controller",
+    "microframework"
   ],
-  "author": "js-code-crafter",
+  "author": "@js-code-crafter - Ehsan Afzali",
   "license": "MIT",
-  "description": "A lightweight framework built on top of Express and TypeScript",
+  "description": "An unopinionated microframework built with Express, TypeScript, Zod, Swagger",
   "dependencies": {
     "cors": "^2.8.5",
     "dotenv": "^17.2.3",

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

@@ -1,5 +1,11 @@
 import { ZodOrder } from "@/entities/order.entity";
 
+/**
+ * DTO for an order.
+ * This is derived from the full Order schema.
+ */
+export const ZodOrderDto = ZodOrder;
+
 /**
  * DTO for creating an order.
  * This is derived from the full Order schema by omitting fields

package/src/routers/orders/index.router.ts

@@ -127,8 +127,8 @@ router.patch(
   "/:id/cancel",
   asyncHandler(async (req: Request, res: Response) => {
     const id = await orderController.validateId(req.params.id);
-    const order = await orderController.cancel(id);
-    res.json(order);
+    await orderController.cancel(id);
+    res.status(200).send();
   })
 );
 
@@ -154,8 +154,8 @@ router.patch(
   "/:id/deliver",
   asyncHandler(async (req: Request, res: Response) => {
     const id = await orderController.validateId(req.params.id);
-    const order = await orderController.deliver(id);
-    res.json(order);
+    await orderController.deliver(id);
+    res.status(200).send();
   })
 );
 

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

@@ -1,9 +1,5 @@
 import { memoizeAsync, onError, rateLimit, timeout } from "utils-decorators";
-import {
-  OrderDto,
-  OrderCreationDto,
-  ZodOrderCreationDto,
-} from "./dto/order.dto";
+import { OrderDto, OrderCreationDto, ZodOrderDto } from "./dto/order.dto";
 import { ResponseError } from "@/utilities/error-handling";
 import { convert, stringToInteger } from "@/utilities/conversion";
 import config from "@/config";
@@ -11,6 +7,7 @@ import { orders } from "@/db";
 import { Order, ZodOrder } from "@/entities/order.entity";
 import { MapAsyncCache } from "@/utilities/cache/memory-cache";
 import { Injectable } from "@/utilities/container";
+import { parallelMap } from "@/utilities/parallel/parallel";
 
 function exceedHandler() {
   const message = "Too much call in allowed window";
@@ -59,13 +56,14 @@ export default class OrderController {
   public async validateOrderCreationDto(
     order: OrderCreationDto
   ): Promise<Order> {
-    const newOrder = await ZodOrderCreationDto.parseAsync(order);
-    return {
-      ...newOrder,
+    const newOrder: Order = {
+      ...order,
       id: orders.length + 1,
       status: "Processing",
       createdAt: new Date(),
     };
+
+    return convert(newOrder, ZodOrder);
   }
 
   @rateLimit({
@@ -82,7 +80,6 @@ export default class OrderController {
    */
   public async create(order: Order): Promise<void> {
     orders.push(order);
-    await orderCache.set(order.id.toString(), order as OrderDto);
     await ordersCache.delete("key");
   }
 
@@ -102,7 +99,10 @@ export default class OrderController {
    * @returns List of orders
    */
   public async getAll(): Promise<OrderDto[]> {
-    return orders as OrderDto[];
+    return await parallelMap(
+      orders,
+      async (order) => await convert(order, ZodOrderDto)
+    );
   }
 
   @memoizeAsync({
@@ -125,7 +125,7 @@ export default class OrderController {
     if (order == null) {
       throw new ResponseError("Order not found");
     }
-    return convert(order!, ZodOrder);
+    return await convert(order, ZodOrder);
   }
 
   @rateLimit({
@@ -140,7 +140,7 @@ export default class OrderController {
    * @throws {ResponseError} 404 - Order not found
    * @throws {ResponseError} 400 - Invalid ID format or invalid status for cancellation
    */
-  public async cancel(id: number): Promise<OrderDto> {
+  public async cancel(id: number): Promise<void> {
     let order = await this.get(id);
     if (order.status != "Processing") {
       throw new ResponseError(
@@ -151,9 +151,8 @@ export default class OrderController {
     order.status = "Canceled";
     order.deliveredAt = new Date();
 
-    await orderCache.set(id.toString(), order);
+    await orderCache.delete(id.toString());
     await ordersCache.delete("key");
-    return order;
   }
 
   @rateLimit({
@@ -168,7 +167,7 @@ export default class OrderController {
    * @throws {ResponseError} 404 - Order not found
    * @throws {ResponseError} 400 - Invalid ID format or invalid status for delivery
    */
-  public async deliver(id: number): Promise<OrderDto> {
+  public async deliver(id: number): Promise<void> {
     let order = await this.get(id);
     if (order.status != "Processing") {
       throw new ResponseError(
@@ -179,8 +178,7 @@ export default class OrderController {
     order.status = "Delivered";
     order.deliveredAt = new Date();
 
-    await orderCache.set(id.toString(), order);
+    await orderCache.delete(id.toString());
     await ordersCache.delete("key");
-    return order;
   }
 }

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

@@ -1,5 +1,10 @@
 import { ZodProduct } from "@/entities/product.entity";
-import z from "zod";
+
+/**
+ * DTO for a Product.
+ * Derived from the full Product schema.
+ */
+export const ZodProductDto = ZodProduct;
 
 /**
  * DTO for creating a Product.
@@ -11,7 +16,7 @@ export const ZodProductCreationDto = ZodProduct.omit({ id: true });
  * DTO for updating a Product.
  * All fields are optional to support partial updates (PATCH semantics).
  */
-export const ZodProductUpdateDto = ZodProductCreationDto.partial();
+export const ZodProductUpdateDto = ZodProductDto.partial();
 
 /**
  * Product categories supported by the system.
@@ -44,7 +49,7 @@ export type ProductCreationDto = {
   stock: number;
 
   /** Optional product description. */
-  description?: string | undefined;
+  description?: string;
 };
 
 /**
@@ -52,20 +57,23 @@ export type ProductCreationDto = {
  * All fields are optional to support partial updates.
  */
 export type ProductUpdateDto = {
+  /** Product ID */
+  id: number;
+
   /** Optional product name. */
-  name?: string | undefined;
+  name?: string;
 
   /** Optional product price. */
-  price?: number | undefined;
+  price?: number;
 
   /** Optional product description. */
-  description?: string | undefined;
+  description?: string;
 
   /** Optional product category. Must be one of the predefined categories if provided. */
-  category?: ProductCategory | undefined;
+  category?: ProductCategory;
 
   /** Optional stock count in inventory. */
-  stock?: number | undefined;
+  stock?: number;
 };
 
 /**
@@ -88,5 +96,5 @@ export type ProductDto = {
   stock: number;
 
   /** Optional product description. */
-  description?: string | undefined;
+  description?: string;
 };

package/src/routers/products/index.router.ts

@@ -170,8 +170,9 @@ router.put(
   "/:id",
   asyncHandler(async (req: Request, res: Response) => {
     const id = await productController.validateId(req.params.id);
-    const product = await productController.update(id, req.body);
-    res.json(product);
+    const product = await productController.validateProductUpdateDto(req.body);
+    await productController.update(id, product);
+    res.status(200).send();
   })
 );
 
@@ -199,8 +200,7 @@ router.delete(
   "/:id",
   asyncHandler(async (req: Request, res: Response) => {
     const id = await productController.validateId(req.params.id);
-    const product = await productController.delete(id);
-    res.json(product);
+    await productController.delete(id);
   })
 );
 

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

@@ -1,16 +1,9 @@
-import {
-  memoizeAsync,
-  onError,
-  rateLimit,
-  timeout,
-  before,
-} from "utils-decorators";
+import { memoizeAsync, onError, rateLimit, timeout } from "utils-decorators";
 import {
   ProductCreationDto,
   ProductDto,
   ProductUpdateDto,
-  ZodProductCreationDto,
-  ZodProductUpdateDto,
+  ZodProductDto,
 } from "./dto/product.dto";
 import { MapAsyncCache } from "@/utilities/cache/memory-cache";
 import { convert, stringToInteger } from "@/utilities/conversion";
@@ -19,6 +12,8 @@ import { ResponseError } from "@/utilities/error-handling";
 import { products } from "@/db";
 import { Product, ZodProduct } from "@/entities/product.entity";
 import { Injectable } from "@/utilities/container";
+import assign from "@/utilities/assignment";
+import { parallelMap } from "@/utilities/parallel/parallel";
 
 function exceedHandler() {
   const message = "Too much call in allowed window";
@@ -67,8 +62,7 @@ export default class ProductController {
   public async validateProductCreationDto(
     product: ProductCreationDto
   ): Promise<Product> {
-    const newProduct = await ZodProductCreationDto.parseAsync(product);
-    return { ...newProduct, id: products.length + 1 };
+    return await convert({ ...product, id: products.length + 1 }, ZodProduct);
   }
 
   @onError({
@@ -81,11 +75,9 @@ export default class ProductController {
    * @returns {Product} A fully formed Product object ready for persistence.
    */
   public async validateProductUpdateDto(
-    product: ProductCreationDto
+    product: ProductUpdateDto
   ): Promise<Product> {
-    const productDto = await ZodProductUpdateDto.parseAsync(product);
-    let updatedProduct: Product = convert(productDto, ZodProduct);
-    return { ...updatedProduct, id: products.length + 1 };
+    return await convert(product, ZodProduct);
   }
 
   @rateLimit({
@@ -101,13 +93,7 @@ export default class ProductController {
    * @throws {ResponseError} 400 - Invalid input data
    */
   public async create(product: Product): Promise<void> {
-    const newProduct: Product = {
-      ...product,
-      id: products.length + 1,
-    };
-
-    products.push(newProduct);
-    await productCache.set(newProduct.id.toString(), newProduct as ProductDto);
+    products.push(product);
     await productsCache.delete("key");
   }
 
@@ -127,7 +113,10 @@ export default class ProductController {
    * @returns List of products with summarized descriptions
    */
   public async getAll(): Promise<ProductDto[]> {
-    return products as ProductDto[];
+    return await parallelMap(
+      products,
+      async (product) => await convert(product, ZodProductDto)
+    );
   }
 
   @memoizeAsync({
@@ -150,7 +139,7 @@ export default class ProductController {
     if (product == null) {
       throw new ResponseError("Product not found");
     }
-    return convert(product!, ZodProduct);
+    return await convert(product, ZodProduct);
   }
 
   @rateLimit({
@@ -166,20 +155,18 @@ export default class ProductController {
    * @throws {ResponseError} 404 - Product not found
    * @throws {ResponseError} 400 - Invalid ID format or update data
    */
-  public async update(
-    id: number,
-    updateData: ProductUpdateDto
-  ): Promise<ProductDto> {
+  public async update(id: number, updateData: Product): Promise<void> {
+    if (id != updateData.id) {
+      throw new ResponseError("Product ID is immutable.", 400);
+    }
     const product = await this.get(id);
     if (product != null) {
-      Object.assign(product, updateData);
-      await productCache.set(id.toString(), product);
+      await assign(updateData, product, ZodProduct);
+      await productCache.delete(updateData.id.toString());
       await productsCache.delete("key");
     } else {
       throw new ResponseError("Product dose not exist.", 404);
     }
-
-    return product;
   }
 
   @rateLimit({
@@ -194,13 +181,13 @@ export default class ProductController {
    * @throws {ResponseError} 404 - Product not found
    * @throws {ResponseError} 400 - Invalid ID format
    */
-  public async delete(id: number): Promise<ProductDto> {
+  public async delete(id: number): Promise<void> {
     const index = products.findIndex((product) => product.id === id);
     if (index == -1) {
       throw new ResponseError("Product dose not exist.", 404);
     }
     await productCache.delete(id.toString());
     await productsCache.delete("key");
-    return products.splice(index, 1)[0];
+    products.splice(index, 1)[0];
   }
 }

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

@@ -1,17 +1,13 @@
-import {
-  ZodUserCreationDto,
-  UserCreationDto,
-  UserDto,
-  ZodUserDto,
-} from "./dto/user.dto";
+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 { users } from "@/db";
-import { User } from "@/entities/user.entity";
+import { User, ZodUser } from "@/entities/user.entity";
 import { MapAsyncCache } from "@/utilities/cache/memory-cache";
 import { Injectable } from "@/utilities/container";
+import { parallelMap } from "@/utilities/parallel/parallel";
 
 function exceedHandler() {
   const message = "Too much call in allowed window";
@@ -58,8 +54,7 @@ export default class UserController {
    * @returns {User} A fully formed User object ready for persistence.
    */
   public async validateUserCreationDto(user: UserCreationDto): Promise<User> {
-    const newUser = await ZodUserCreationDto.parseAsync(user);
-    return { ...newUser, id: users.length + 1 };
+    return await convert(user, ZodUser);
   }
 
   @rateLimit({
@@ -76,7 +71,6 @@ export default class UserController {
    */
   public async create(user: User): Promise<void> {
     users.push(user);
-    await userCache.set(user.id.toString(), user as User);
     await usersCache.delete("key");
   }
 
@@ -97,7 +91,10 @@ export default class UserController {
    * @throws {ResponseError} 500 - When rate limit exceeded
    */
   public async getAll(): Promise<UserDto[]> {
-    return users as UserDto[];
+    return await parallelMap(
+      users,
+      async (user) => await convert(user, ZodUserDto)
+    );
   }
 
   @memoizeAsync({
@@ -122,6 +119,6 @@ export default class UserController {
     if (user == null) {
       throw new ResponseError("Product not found");
     }
-    return convert(user!, ZodUserDto);
+    return convert(user, ZodUserDto);
   }
 }