codeweaver 1.0.14 → 1.1.0

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

@@ -1,33 +1,161 @@
-import { Validate, ZodInput } from "ts-zod-decorators";
-import { CreateUserDto, CreateUser } from "./dto/user.dto";
-import { onError, rateLimit, throttle } from "utils-decorators";
+import { User, ZodUserCreationDto, UserCreationDto } from "./dto/user.dto";
+import { onError, rateLimit, timeout } from "utils-decorators";
+import { Validate, ZodInput } from "@pkg/ts-zod-decorators";
+import { ResponseError } from "@/types";
+import { tryParseId } from "@/utilities";
+
+// Array to store users (as a mock database)
+const users = [
+  {
+    id: 1,
+    username: "johndoe",
+    email: "johndoe@gmail.com",
+    password: "S3cur3P@ssw0rd",
+  },
+  {
+    id: 2,
+    username: "janesmith",
+    email: "janesmith@yahoo.com",
+    password: "P@ssw0rd2024",
+  },
+  {
+    id: 3,
+    username: "michael89",
+    email: "michael89@hotmail.com",
+    password: "M1chael!2024",
+  },
+  {
+    id: 4,
+    username: "lisa.wong",
+    email: "lisa.wong@example.com",
+    password: "L1saW0ng!2024",
+  },
+  {
+    id: 5,
+    username: "alex_k",
+    email: "alex.k@gmail.com",
+    password: "A1ex#Key2024",
+  },
+  {
+    id: 6,
+    username: "emilyj",
+    email: "emilyj@hotmail.com",
+    password: "Em!ly0101",
+  },
+  {
+    id: 7,
+    username: "davidparker",
+    email: "david.parker@yahoo.com",
+    password: "D@v!d2024",
+  },
+  {
+    id: 8,
+    username: "sophia_m",
+    email: "sophia.m@gmail.com",
+    password: "Sophi@2024",
+  },
+  {
+    id: 9,
+    username: "chrisw",
+    email: "chrisw@outlook.com",
+    password: "Chri$Wong21",
+  },
+  {
+    id: 10,
+    username: "natalie_b",
+    email: "natalie_b@gmail.com",
+    password: "N@talie#B2024",
+  },
+];
 
 function exceedHandler() {
-  throw new Error("Too much call in allowed window");
+  const message = "Too much call in allowed window";
+
+  throw new Error(message, {
+    cause: { status: 500, message } satisfies ResponseError,
+  });
 }
 
-function errorHandler(e: Error): void {
-  console.error(e);
+function getUserErrorHandler(e: Error) {
+  const message = "User not found.";
+
+  throw new Error(message, {
+    cause: { status: 404, message, details: e.message } satisfies ResponseError,
+  });
 }
 
+/**
+ * Controller for handling user-related operations
+ * @class UserController
+ * @desc Provides methods for user management including CRUD operations
+ */
 export default class UserController {
-  //constructor(private readonly userService: UserService) { }
+  // constructor(private readonly userService: UserService) { }
 
-  // Throttle the createUser method to 1 request per 200 milliseconds
   @rateLimit({
     timeSpanMs: 60000,
     allowedCalls: 300,
     exceedHandler,
   })
+  @Validate
+  /**
+   * Create a new user
+   * @param {UserCreationDto} user - User creation data validated by Zod schema
+   * @returns {Promise<void>}
+   * @throws {ResponseError} 500 - When rate limit exceeded
+   * @throws {ResponseError} 400 - Invalid input data
+   */
+  public async create(@ZodInput(ZodUserCreationDto) user: UserCreationDto) {
+    users.push({ ...user, id: users.length + 1 } satisfies User);
+  }
+
   @onError({
-    func: errorHandler,
+    func: getUserErrorHandler,
   })
-  @Validate
-  public async createUser(
-    @ZodInput(CreateUserDto) data: CreateUser
-  ): Promise<string> {
-    // Here you can include logic to save user to database
-    console.log("Creating user:", data);
-    return "User created successfully";
+  @rateLimit({
+    timeSpanMs: 60000,
+    allowedCalls: 300,
+    exceedHandler,
+  })
+  /**
+   * Get user by ID
+   * @param {string} id - User ID as string
+   * @returns {Promise<User | ResponseError>} User details or error object
+   * @throws {ResponseError} 404 - User not found
+   * @throws {ResponseError} 400 - Invalid ID format
+   */
+  public async get(id: string): Promise<User | ResponseError> {
+    const userId = tryParseId(id);
+    if (typeof userId != "number") return userId satisfies ResponseError;
+    const user = users.find((user) => user.id === userId);
+
+    if (!user)
+      return {
+        status: 404,
+        message: "User dose not exist.",
+      } satisfies ResponseError;
+
+    return user satisfies User;
+  }
+
+  @timeout(20000)
+  @rateLimit({
+    timeSpanMs: 60000,
+    allowedCalls: 300,
+    exceedHandler,
+  })
+  /**
+   * Get all users with masked passwords
+   * @returns {Promise<User[]>} List of users with hidden password fields
+   * @throws {ResponseError} 500 - When rate limit exceeded
+   */
+  public async getAll(): Promise<User[]> {
+    return users.map(
+      (user) =>
+        ({
+          ...user,
+          password: "?",
+        } satisfies User)
+    );
   }
 }

package/src/types.ts

@@ -0,0 +1,16 @@
+/**
+ * Represents a standardized error response structure for API endpoints
+ * @interface
+ * @property {number} status - HTTP status code
+ * @property {string} [name] - Error name/type
+ * @property {string} message - Human-readable error message
+ * @property {string} [stack] - Error stack trace (development only)
+ * @property {string} [details] - Additional error details
+ */
+export interface ResponseError {
+  status: number;
+  name?: string;
+  message: string;
+  stack?: string;
+  details?: string;
+}

package/src/utilities.ts

@@ -0,0 +1,47 @@
+import { Response } from "express";
+import { ResponseError } from "./types";
+
+/**
+ * Sends a standardized error response
+ * @param {Response} res - Express response object
+ * @param {ResponseError} error - Error details object
+ */
+export function sendError(res: Response, error: ResponseError): void {
+  res.status(error.status).json(error);
+}
+
+/**
+ * Parses and validates ID parameter from string to number
+ * @param {string} input - Input string to parse
+ * @returns {number|ResponseError} Parsed number or error object
+ */
+export function tryParseId(input: string): number | ResponseError {
+  try {
+    return parseInt(input) satisfies number;
+  } catch {
+    return {
+      status: 400,
+      message: "wrong input",
+      details: "The id parameter must be an integer number.",
+    } satisfies ResponseError;
+  }
+}
+
+/**
+ * Checks if the provided object is a ResponseError.
+ *
+ * A ResponseError is an object that contains at least the properties:
+ * - message: string
+ * - status: number
+ *
+ * @param obj - The object to check.
+ * @returns true if the object is a ResponseError, false otherwise.
+ */
+export function isResponseError(obj: unknown): boolean {
+  return (
+    obj != null &&
+    typeof obj === "object" &&
+    "message" in obj &&
+    "status" in obj
+  );
+}

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "ESNext",
+    "target": "ES2023",
     "module": "commonjs",
     "outDir": "./dist",
     "strict": true,
@@ -8,8 +8,14 @@
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
     "experimentalDecorators": true,
-    "emitDecoratorMetadata": true
+    "emitDecoratorMetadata": true,
+    "baseUrl": ".",
+    "paths": {
+      "@pkg/*": ["src/packages/*"],
+      "@r/*": ["src/routers/*"],
+      "@/*": ["src/*"]
+    }
   },
-  "include": ["src/**/*.ts", "src/**/*.js", "command.js"],
+  "include": ["**/*.ts", "**/*.js"],
   "exclude": ["node_modules"]
 }

package/tsconfig.paths.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@pkg/*": ["dist/packages/*"],
+      "@r/*": ["dist/routers/*"],
+      "@/*": ["dist/*"]
+    }
+  }
+}