add error classes for http errors

Author: svozza

packages/event-handler/src/rest/constants.ts

@@ -10,6 +10,18 @@ export const HttpVerbs = {
   OPTIONS: 'OPTIONS',
 } as const;
 
+export const HttpErrorCodes = {
+  BAD_REQUEST: 400,
+  UNAUTHORIZED: 401,
+  FORBIDDEN: 403,
+  NOT_FOUND: 404,
+  METHOD_NOT_ALLOWED: 405,
+  REQUEST_TIMEOUT: 408,
+  REQUEST_ENTITY_TOO_LARGE: 413,
+  INTERNAL_SERVER_ERROR: 500,
+  SERVICE_UNAVAILABLE: 503,
+} as const;
+
 export const PARAM_PATTERN = /:([a-zA-Z_]\w*)(?=\/|$)/g;
 
 export const SAFE_CHARS = "-._~()'!*:@,;=+&$";

packages/event-handler/src/rest/errors.ts

@@ -1,3 +1,6 @@
+import type { ErrorResponse } from '../types/rest.js';
+import { HttpErrorCodes } from './constants.js';
+
 export class RouteMatchingError extends Error {
   constructor(
     message: string,
@@ -15,3 +18,145 @@ export class ParameterValidationError extends RouteMatchingError {
     this.name = 'ParameterValidationError';
   }
 }
+
+abstract class ServiceError extends Error {
+  abstract readonly statusCode: number;
+  abstract readonly errorType: string;
+  public readonly details?: Record<string, unknown>;
+
+  constructor(
+    message: string,
+    options?: ErrorOptions,
+    details?: Record<string, unknown>
+  ) {
+    super(message, options);
+    this.name = 'ServiceError';
+    this.details = details;
+  }
+
+  toJSON(): ErrorResponse {
+    return {
+      statusCode: this.statusCode,
+      error: this.errorType,
+      message: this.message,
+      ...(this.details && { details: this.details }),
+    };
+  }
+}
+
+export class BadRequestError extends ServiceError {
+  readonly statusCode = HttpErrorCodes.BAD_REQUEST;
+  readonly errorType = 'BadRequestError';
+
+  constructor(
+    message?: string,
+    options?: ErrorOptions,
+    details?: Record<string, unknown>
+  ) {
+    super(message ?? 'Bad request', options, details);
+  }
+}
+
+export class UnauthorizedError extends ServiceError {
+  readonly statusCode = HttpErrorCodes.UNAUTHORIZED;
+  readonly errorType = 'UnauthorizedError';
+
+  constructor(
+    message?: string,
+    options?: ErrorOptions,
+    details?: Record<string, unknown>
+  ) {
+    super(message ?? 'Unauthorized', options, details);
+  }
+}
+
+export class ForbiddenError extends ServiceError {
+  readonly statusCode = HttpErrorCodes.FORBIDDEN;
+  readonly errorType = 'ForbiddenError';
+
+  constructor(
+    message?: string,
+    options?: ErrorOptions,
+    details?: Record<string, unknown>
+  ) {
+    super(message ?? 'Forbidden', options, details);
+  }
+}
+
+export class NotFoundError extends ServiceError {
+  readonly statusCode = HttpErrorCodes.NOT_FOUND;
+  readonly errorType = 'NotFoundError';
+
+  constructor(
+    message?: string,
+    options?: ErrorOptions,
+    details?: Record<string, unknown>
+  ) {
+    super(message ?? 'Not found', options, details);
+  }
+}
+
+export class MethodNotAllowedError extends ServiceError {
+  readonly statusCode = HttpErrorCodes.METHOD_NOT_ALLOWED;
+  readonly errorType = 'MethodNotAllowedError';
+
+  constructor(
+    message?: string,
+    options?: ErrorOptions,
+    details?: Record<string, unknown>
+  ) {
+    super(message ?? 'Method not allowed', options, details);
+  }
+}
+
+export class RequestTimeoutError extends ServiceError {
+  readonly statusCode = HttpErrorCodes.REQUEST_TIMEOUT;
+  readonly errorType = 'RequestTimeoutError';
+
+  constructor(
+    message?: string,
+    options?: ErrorOptions,
+    details?: Record<string, unknown>
+  ) {
+    super(message ?? 'Request timeout', options, details);
+  }
+}
+
+export class RequestEntityTooLargeError extends ServiceError {
+  readonly statusCode = HttpErrorCodes.REQUEST_ENTITY_TOO_LARGE;
+  readonly errorType = 'RequestEntityTooLargeError';
+
+  constructor(
+    message?: string,
+    options?: ErrorOptions,
+    details?: Record<string, unknown>
+  ) {
+    super(message ?? 'Request entity too large', options, details);
+  }
+}
+
+export class InternalServerError extends ServiceError {
+  readonly statusCode = HttpErrorCodes.INTERNAL_SERVER_ERROR;
+  readonly errorType = 'InternalServerError';
+
+  constructor(
+    message?: string,
+    options?: ErrorOptions,
+    details?: Record<string, unknown>
+  ) {
+    super(message ?? 'Internal server error', options, details);
+  }
+}
+
+export class ServiceUnavailableError extends ServiceError {
+  readonly statusCode = HttpErrorCodes.SERVICE_UNAVAILABLE;
+  readonly errorType = 'ServiceUnavailableError';
+
+  constructor(
+    message?: string,
+    options?: ErrorOptions,
+    details?: Record<string, unknown>
+  ) {
+    super(message ?? 'Service unavailable', options, details);
+  }
+}

packages/event-handler/src/types/rest.ts

@@ -3,6 +3,12 @@ import type { BaseRouter } from '../rest/BaseRouter.js';
 import type { HttpVerbs } from '../rest/constants.js';
 import type { Route } from '../rest/Route.js';
 
+type ErrorResponse = {
+  statusCode: number;
+  error: string;
+  message: string;
+};
+
 /**
  * Options for the {@link BaseRouter} class
  */
@@ -59,6 +65,7 @@ type ValidationResult = {
 export type {
   CompiledRoute,
   DynamicRoute,
+  ErrorResponse,
   HttpMethod,
   Path,
   RouterOptions,