Layered Phase 6 - Misc

[yamcodes]

Description

Misc refactor to Layered Architecture

Closes #168

---

PR Checklist

• Read the Developer's Guide in CONTRIBUTING.md
• Use a concise title to represent the changes introduced in this PR
• Provide a detailed description of the changes introduced in this PR, and, if necessary, some screenshots
• Reference an issue or discussion where the feature or changes have been previously discussed
• Add a failing test that passes with the changes introduced in this PR, or explain why it's not feasible
• Add documentation for the feature or changes introduced in this PR to the docs; you can run them with bun docs

Summary by CodeRabbit

• New Features

  • Introduced standardized error handling with a new RealWorldError class and structured error responses.
  • Added utility modules for error formatting, date operations, and validation tasks.
  • Added reusable interface types for API responses, pagination, and common entities.
  • Centralized and expanded constants for pagination and error messages.

• Refactor

  • Unified and simplified error handling across services, replacing custom error classes with standardized errors and HTTP status codes.
  • Updated import paths throughout the codebase for consistency using a single alias pattern.
  • Reorganized and clarified project structure documentation and code organization.
  • Improved and centralized constants and utility exports for easier access.

• Bug Fixes

  • Fixed broken Markdown links and standardized code block formatting in documentation.

• Chores

  • Simplified TypeScript path aliases in configuration.
  • Cleaned up whitespace and improved formatting in all documentation files.

• Documentation

  • Expanded and clarified project structure, usage guidelines, and added new documentation for utilities and interfaces.

[aruaycodes]

this is such a cool code. I want to able to write code like this

[aruaycodes]

why do we need so many types of errors?

[yamcodes]

We want to be able to throw an error and not think about its formatting.

We need to follow the RealWorld error handling format:

{
  "errors":{
    "body": [
      "can't be empty"
    ]
  }
}

Reference

So now, in your code, you can do this:

throw new RealWorldError(StatusCodes.UNAUTHORIZED, {
  Authorization: ['is missing'],
});

Instead of this:

throw new Error({
  statusCode: StatusCodes.UNAUTHORIZED,
  errors: {
    "Authorization":['is missing']
}

And more things are "figured out" for you, like remembering the errors field.

Also, some errors are automatically thrown by Elysia, like ValidationError, so this is a way to format them to this structure. There are also NotFoundError which are built in Elysia errors, that we can throw easily:

throw new NotFoundError('article');

Which will output:

{
  "errors":{
    "article": [
      "not found"
    ]
  }
}

This is all thanks to the error handler in app.module.ts.