codeweaver 3.1.0 → 3.1.2

package/.env.example

@@ -1,20 +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
+# 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

@@ -210,20 +210,16 @@ For example, in the provided `UserController`, the `createUser` method demonstra
 Here’s a brief breakdown of key components used in the `UserController`:
 
 ```typescript
-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 { 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";
@@ -270,8 +266,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({
@@ -288,7 +283,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");
   }
 
@@ -309,7 +303,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({
@@ -334,7 +331,7 @@ export default class UserController {
     if (user == null) {
       throw new ResponseError("Product not found");
     }
-    return convert(user!, ZodUserDto);
+    return convert(user, ZodUserDto);
   }
 }
 ```
@@ -351,7 +348,7 @@ Once the application is running, visit the Swagger UI at http://localhost:3000/a
 
 ### Decorators
 
-To prevent abuse of your API, you can utilize throttling, caching, and error handling decorators from the `utils-decorators` packages respectively. This packages provides decorators that can be applied directly to your service and controller classes.
+To prevent abuse of your API, you can utilize throttling, caching, and error handling decorators from the `utils-decorators` package. This package provides decorators that can be applied directly to your service and controller classes.
 
 ### Contributing
 

package/package.json

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

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

@@ -1,16 +1,42 @@
 import { ZodUser } from "@/entities/user.entity";
 
+/**
+ * DTO for a User.
+ * Derived from the full User schema.
+ */
+export const ZodUserDto = ZodUser;
+
+/**
+ * DTO for creating a User.
+ * Derived from the full User schema by omitting the system-generated id.
+ */
 export const ZodUserCreationDto = ZodUser.omit({ id: true });
-export const ZodUserDto = ZodUser.omit({ password: true });
 
+/**
+ * Data required to create a User.
+ */
 export type UserCreationDto = {
+  /** Username for the new user. */
   username: string;
+
+  /** Email address for the new user. */
   email: string;
+
+  /** Password for the new user. */
   password: string;
 };
 
+/**
+ * Data for a User returned by APIs (or stored for client consumption).
+ * Excludes sensitive information such as the password.
+ */
 export type UserDto = {
+  /** Unique identifier for the user. */
   id: number;
+
+  /** Username of the user. */
   username: string;
+
+  /** Email address of the user. */
   email: string;
 };

package/src/utilities/parallel/parallel.ts

@@ -4,15 +4,12 @@ import { WorkerPool } from "./worker-pool";
  * Creates a setter function that, when invoked, rebinds the captured
  * destination binding to the provided source value.
  *
- * @template T - The type of both `destination` and `source`, constrained to object types.
- * @param {T} destination - The destination value (captured by the closure).
- * @param {T} source - The source value to which `destination` will be rebound when the returned function runs.
+ * @template T - The type of both `destination` and `source`.
+ * @param {T} destination - The destination value.
+ * @param {T} source - The source value.
  * @returns {() => void} A function that, when called, rebinds the captured `destination` to `source`.
  */
-export function set<T extends object>(
-  destination: keyof T,
-  source: keyof T
-): () => void {
+export function set<T>(destination: T, source: T): () => void {
   return () => {
     destination = source;
   };

package/tsconfig.paths.json

@@ -1,8 +1,8 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "paths": {
-      "@/*": ["dist/*"]
-    }
-  }
-}
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["dist/*"]
+    }
+  }
+}