feat: add extra to HttpError instances

Author: Lordfirespeed

.changeset/cold-poets-serve.md

@@ -0,0 +1,5 @@
+---
+"@otterhttp/errors": minor
+---
+
+feat: add `extra` to HttpError instances, intended for adding additional fields to JSON response payloads

packages/errors/src/index.ts

@@ -3,19 +3,23 @@ import ModuleError from "module-error"
 
 import { HttpStatus, type StatusCode, isValidStatusCode, statusMessages } from "./status-codes"
 
+type ExtraLiteral = string | number | boolean | null | undefined | { [property: string]: ExtraLiteral } | ExtraLiteral[]
+
 type ModuleErrorOptions = ConstructorParameters<typeof ModuleError>[1]
 export type HttpErrorOptions = ModuleErrorOptions & {
   statusCode?: StatusCode
   statusMessage?: string
   exposeMessage?: boolean
   headers?: OutgoingHttpHeaders
+  extra?: Record<string, ExtraLiteral>
 }
 
 export abstract class HttpError extends ModuleError {
   statusCode: StatusCode
   statusMessage: string
   exposeMessage: boolean
   headers: OutgoingHttpHeaders
+  extra: Record<string, ExtraLiteral>
 
   static {
     HttpError.prototype.name = "HttpError"
@@ -36,12 +40,14 @@ export abstract class HttpError extends ModuleError {
       if (options.statusMessage != null) this.statusMessage = options.statusMessage
       if (options.exposeMessage != null) this.exposeMessage = options.exposeMessage
       if (options.headers != null) this.headers = options.headers
+      if (options.extra != null) this.extra = options.extra
     }
 
     this.statusCode ??= HttpStatus.InternalServerError
     this.statusMessage ??= statusMessages[this.statusCode]
     this.exposeMessage ??= this.statusCode < 500
     this.headers ??= {}
+    this.extra ??= {}
   }
 }