hono-ban 0.2.0 → 0.2.4

package/dist/esm/index.js.map

@@ -0,0 +1,16 @@
+{
+  "version": 3,
+  "sources": ["../../src/core/convert-error.ts", "../../src/core/format-error.ts", "../../src/utils/sanitize.ts", "../../src/formatters/default/index.ts", "../../src/factories/server-errors.ts", "../../src/middleware/ban-middleware.ts", "../../src/index.ts"],
+  "sourcesContent": [
+    "/**\n * Error conversion utilities\n * @module hono-ban/core/convert-error\n */\n\nimport type { BanError, BanOptions } from \"../types\";\nimport { createError } from \"./create-error\";\n\n/**\n * Type guard to check if a value is a BanError\n * @param err - Value to check\n * @param statusCode - Optional status code to match\n */\nexport function isBanError(err: unknown, statusCode?: number): err is BanError {\n  return (\n    typeof err === \"object\" &&\n    err !== null &&\n    \"isBan\" in err &&\n    err.isBan === true &&\n    (!statusCode || (err as BanError).status === statusCode)\n  );\n}\n\n/**\n * Convert any error into a BanError\n * @param err - Error to convert\n * @param options - Additional options\n */\nexport function convertToBanError<T = unknown>(\n  err: unknown,\n  options: BanOptions<T> = {}\n): BanError<T> {\n  // If already a BanError, merge options\n  if (isBanError(err)) {\n    const merged: BanError<T> = {\n      status: options.statusCode ?? err.status,\n      message: options.message ?? err.message,\n      isBan: true,\n      data: (options.data !== undefined ? options.data : err.data) as\n        | T\n        | undefined,\n      headers: {\n        ...err.headers,\n        ...options.headers,\n      },\n      allow: options.allow\n        ? Array.isArray(options.allow)\n          ? [...options.allow]\n          : [options.allow]\n        : err.allow,\n      cause: options.cause ?? err.cause,\n      stack: err.stack,\n    };\n\n    return merged;\n  }\n\n  // Convert Error instance\n  if (err instanceof Error) {\n    return createError<T>({\n      ...options,\n      message: options.message ?? err.message,\n      cause: err,\n    });\n  }\n\n  // Handle unknown error types\n  return createError<T>({\n    ...options,\n    message:\n      options.message ?? (typeof err === \"string\" ? err : \"Unknown error\"),\n    cause: err,\n  });\n}\n",
+    "/**\n * Error formatting utilities\n * @module hono-ban/core/format-error\n */\n\nimport { STATUS_CODES } from \"../constants\";\nimport type { BanError, ErrorFormatter, FormatOptions } from \"../types\";\n\n/**\n * Format an error using the provided formatter\n * @param error - Error to format\n * @param formatter - Formatter to use\n * @param options - Formatting options\n */\nexport function formatError(\n  error: BanError,\n  formatter: ErrorFormatter,\n  options: FormatOptions = {}\n): unknown {\n  // Directly format the error without caching\n  return formatter.format(\n    error,\n    options.headers,\n    options.sanitize,\n    options.includeStackTrace\n  );\n}\n\n/**\n * Create a Response object from a formatted error\n * @param error - Error to create response from\n * @param formatted - Formatted error output\n */\nexport function createErrorResponse(\n  error: BanError,\n  formatted: unknown\n): Response {\n  const headers = new Headers({\n    \"Content-Type\": \"application/json\",\n    ...error.headers,\n  });\n\n  if (error.allow?.length) {\n    headers.set(\"Allow\", error.allow.join(\", \"));\n  }\n\n  // Check if this is a developer error in production\n  const isDeveloperError =\n    error.data &&\n    typeof error.data === \"object\" &&\n    \"isDeveloperError\" in error.data &&\n    error.data.isDeveloperError === true;\n\n  // Sanitize developer errors in production\n  if (isDeveloperError && process.env.NODE_ENV === \"production\") {\n    // Create a sanitized version without sensitive data\n    const sanitizedFormatted = {\n      statusCode: error.status,\n      payload: {\n        statusCode: error.status,\n        error: STATUS_CODES[error.status],\n        message: \"An internal server error occurred\",\n      },\n    };\n\n    return new Response(JSON.stringify(sanitizedFormatted), {\n      status: error.status,\n      headers,\n    });\n  }\n\n  return new Response(JSON.stringify(formatted), {\n    status: error.status,\n    headers,\n  });\n}\n",
+    "/**\n * Sanitization utilities\n * @module hono-ban/utils/sanitize\n */\n\n/**\n * Recursively sanitize an object by removing specified keys\n * @param obj - Object to sanitize\n * @param keysToRemove - Keys to remove from object\n */\nexport function sanitizeObject(\n  obj: unknown,\n  keysToRemove: readonly string[]\n): unknown {\n  if (!keysToRemove.length) {\n    return obj;\n  }\n\n  if (Array.isArray(obj)) {\n    return obj.map((item) => sanitizeObject(item, keysToRemove));\n  }\n\n  if (obj !== null && typeof obj === \"object\") {\n    return Object.entries(obj).reduce((acc, [key, value]) => {\n      if (keysToRemove.includes(key)) {\n        return acc;\n      }\n      acc[key] = sanitizeObject(value, keysToRemove);\n      return acc;\n    }, {} as Record<string, unknown>);\n  }\n\n  return obj;\n}\n",
+    "/**\n * Default error formatter implementation\n * @module hono-ban/formatters/default\n */\n\nimport { STATUS_CODES } from \"../../constants\";\nimport type { BanError, DefaultErrorOutput, Headers } from \"../../types\";\nimport { sanitizeObject } from \"../../utils\";\n\n/**\n * Default JSON formatter maintaining backward compatibility\n */\nexport const defaultFormatter = {\n  contentType: \"application/json\",\n\n  /**\n   * Format an error into a standardized output structure\n   * @param error - Error to format\n   * @param headers - Headers for HTTP response (not included in response body)\n   * @param sanitize - Fields to remove from output\n   * @param includeStackTrace - Whether to include stack traces\n   */\n  format(\n    error: BanError,\n    headers: Headers = {}, // Headers are used for HTTP headers, not included in response body\n    sanitize: readonly string[] = [],\n    includeStackTrace = false\n  ): DefaultErrorOutput {\n    const { status, message, data } = error;\n\n    // Build base payload\n    const payload: DefaultErrorOutput[\"payload\"] = {\n      statusCode: status,\n      error: STATUS_CODES[status] || \"Unknown Error\",\n    };\n\n    // Add optional fields\n    if (typeof message === \"string\") {\n      payload.message = message;\n    }\n\n    const isDeveloperError =\n      data &&\n      typeof data === \"object\" &&\n      \"isDeveloperError\" in data &&\n      data.isDeveloperError === true;\n\n    if (includeStackTrace || isDeveloperError) {\n      if (error.stack) {\n        payload.stack = error.stack;\n      }\n      if (error.causeStack) {\n        payload.causeStack = error.causeStack;\n      }\n    }\n\n    if (data !== undefined) {\n      payload.data = data;\n    }\n\n    // Create output structure\n    const output: DefaultErrorOutput = {\n      statusCode: status,\n      payload: sanitizeObject(\n        payload,\n        sanitize\n      ) as DefaultErrorOutput[\"payload\"],\n    };\n\n    return output;\n  },\n};\n",
+    "/**\n * Server error factory functions (5xx)\n * @module hono-ban/factories/server-errors\n */\n\nimport type { BanError, BanOptions, ErrorStatusCode } from \"../types\";\nimport { createError } from \"../core\";\n\n/**\n * Helper function to reduce duplication\n * @param statusCode - HTTP status code\n * @param messageOrOptions - Error message or options\n * @param options - Additional options\n */\nfunction createErrorWithStatus<T>(\n  statusCode: ErrorStatusCode,\n  messageOrOptions?: string | Partial<BanOptions<T>>,\n  options?: Partial<BanOptions<T>>\n): BanError<T> {\n  if (typeof messageOrOptions === \"string\") {\n    return createError<T>({\n      ...options,\n      statusCode,\n      message: messageOrOptions,\n    });\n  }\n  return createError<T>({ ...messageOrOptions, ...options, statusCode });\n}\n\n/**\n * Create a 500 Internal Server Error\n * @param messageOrOptions - Error message or options\n * @param options - Additional options\n */\nexport function internal<T = unknown>(\n  messageOrOptions?: string | Partial<BanOptions<T>>,\n  options?: Partial<BanOptions<T>>\n): BanError<T> {\n  return createErrorWithStatus(\n    500 as ErrorStatusCode,\n    messageOrOptions,\n    options\n  );\n}\n\n/**\n * Create a 501 Not Implemented error\n * @param messageOrOptions - Error message or options\n * @param options - Additional options\n */\nexport function notImplemented<T = unknown>(\n  messageOrOptions?: string | Partial<BanOptions<T>>,\n  options?: Partial<BanOptions<T>>\n): BanError<T> {\n  return createErrorWithStatus(\n    501 as ErrorStatusCode,\n    messageOrOptions,\n    options\n  );\n}\n\n/**\n * Create a 502 Bad Gateway error\n * @param messageOrOptions - Error message or options\n * @param options - Additional options\n */\nexport function badGateway<T = unknown>(\n  messageOrOptions?: string | Partial<BanOptions<T>>,\n  options?: Partial<BanOptions<T>>\n): BanError<T> {\n  return createErrorWithStatus(\n    502 as ErrorStatusCode,\n    messageOrOptions,\n    options\n  );\n}\n\n/**\n * Create a 503 Service Unavailable error\n * @param messageOrOptions - Error message or options\n * @param options - Additional options\n */\nexport function serverUnavailable<T = unknown>(\n  messageOrOptions?: string | Partial<BanOptions<T>>,\n  options?: Partial<BanOptions<T>>\n): BanError<T> {\n  return createErrorWithStatus(\n    503 as ErrorStatusCode,\n    messageOrOptions,\n    options\n  );\n}\n\n/**\n * Create a 504 Gateway Timeout error\n * @param messageOrOptions - Error message or options\n * @param options - Additional options\n */\nexport function gatewayTimeout<T = unknown>(\n  messageOrOptions?: string | Partial<BanOptions<T>>,\n  options?: Partial<BanOptions<T>>\n): BanError<T> {\n  return createErrorWithStatus(\n    504 as ErrorStatusCode,\n    messageOrOptions,\n    options\n  );\n}\n\n/**\n * Create a 505 HTTP Version Not Supported error\n * @param messageOrOptions - Error message or options\n * @param options - Additional options\n */\nexport function httpVersionNotSupported<T = unknown>(\n  messageOrOptions?: string | Partial<BanOptions<T>>,\n  options?: Partial<BanOptions<T>>\n): BanError<T> {\n  return createErrorWithStatus(\n    505 as ErrorStatusCode,\n    messageOrOptions,\n    options\n  );\n}\n\n/**\n * Create a 506 Variant Also Negotiates error\n * @param messageOrOptions - Error message or options\n * @param options - Additional options\n */\nexport function variantAlsoNegotiates<T = unknown>(\n  messageOrOptions?: string | Partial<BanOptions<T>>,\n  options?: Partial<BanOptions<T>>\n): BanError<T> {\n  return createErrorWithStatus(\n    506 as ErrorStatusCode,\n    messageOrOptions,\n    options\n  );\n}\n\n/**\n * Create a 507 Insufficient Storage error\n * @param messageOrOptions - Error message or options\n * @param options - Additional options\n */\nexport function insufficientStorage<T = unknown>(\n  messageOrOptions?: string | Partial<BanOptions<T>>,\n  options?: Partial<BanOptions<T>>\n): BanError<T> {\n  return createErrorWithStatus(\n    507 as ErrorStatusCode,\n    messageOrOptions,\n    options\n  );\n}\n\n/**\n * Create a 508 Loop Detected error\n * @param messageOrOptions - Error message or options\n * @param options - Additional options\n */\nexport function loopDetected<T = unknown>(\n  messageOrOptions?: string | Partial<BanOptions<T>>,\n  options?: Partial<BanOptions<T>>\n): BanError<T> {\n  return createErrorWithStatus(\n    508 as ErrorStatusCode,\n    messageOrOptions,\n    options\n  );\n}\n\n/**\n * Create a 510 Not Extended error\n * @param messageOrOptions - Error message or options\n * @param options - Additional options\n */\nexport function notExtended<T = unknown>(\n  messageOrOptions?: string | Partial<BanOptions<T>>,\n  options?: Partial<BanOptions<T>>\n): BanError<T> {\n  return createErrorWithStatus(\n    510 as ErrorStatusCode,\n    messageOrOptions,\n    options\n  );\n}\n\n/**\n * Create a 511 Network Authentication Required error\n * @param messageOrOptions - Error message or options\n * @param options - Additional options\n */\nexport function networkAuthRequired<T = unknown>(\n  messageOrOptions?: string | Partial<BanOptions<T>>,\n  options?: Partial<BanOptions<T>>\n): BanError<T> {\n  return createErrorWithStatus(\n    511 as ErrorStatusCode,\n    messageOrOptions,\n    options\n  );\n}\n\n/**\n * Create a 500 Internal Server Error marked as a developer error\n * @param messageOrOptions - Error message or options\n * @param options - Additional options\n */\nexport function badImplementation<T = unknown>(\n  messageOrOptions?: string | Partial<BanOptions<T>>,\n  options?: Partial<BanOptions<T>>\n): BanError<T> {\n  const mergedOptions =\n    typeof messageOrOptions === \"string\"\n      ? { ...options, message: messageOrOptions }\n      : { ...messageOrOptions, ...options };\n\n  const mergedData = {\n    isDeveloperError: true,\n    ...((mergedOptions.data as Record<string, unknown>) || {}),\n  } as unknown as T;\n\n  return createError<T>({\n    ...mergedOptions,\n    statusCode: 500 as ErrorStatusCode,\n    data: mergedData,\n  });\n}\n",
+    "/**\n * Error handling middleware\n * @module hono-ban/middleware/ban-middleware\n */\n\nimport type { MiddlewareHandler } from \"hono\";\nimport { convertToBanError, formatError, createErrorResponse } from \"../core\";\nimport { defaultFormatter } from \"../formatters\";\nimport type { BanMiddlewareOptions } from \"../types\";\n\n/**\n * Default middleware options\n */\nconst DEFAULT_OPTIONS: Required<BanMiddlewareOptions> = {\n  formatter: defaultFormatter,\n  sanitize: [],\n  includeStackTrace: false,\n  headers: {},\n};\n\n/**\n * Create error handling middleware\n * @param options - Middleware configuration options\n *\n * @example\n * // Simple usage\n * app.use(ban());\n *\n * @example\n * // Advanced usage\n * app.use(ban({\n *   formatter: customFormatter,\n *   sanitize: ['password', 'token'],\n *   includeStackTrace: process.env.NODE_ENV !== 'production'\n * }));\n */\nexport function ban(options: BanMiddlewareOptions = {}): MiddlewareHandler {\n  const resolvedOptions: Required<BanMiddlewareOptions> = {\n    ...DEFAULT_OPTIONS,\n    ...options,\n    formatter: options.formatter\n      ? options.formatter\n      : DEFAULT_OPTIONS.formatter,\n    headers: {\n      ...DEFAULT_OPTIONS.headers,\n      ...options.headers,\n    },\n    sanitize: [...DEFAULT_OPTIONS.sanitize, ...(options.sanitize || [])],\n  };\n\n  // Return the middleware function that uses the pre-merged options\n  return async (_, next) => {\n    try {\n      await next();\n    } catch (err) {\n      // Get the pre-resolved formatter instance\n      const formatter = resolvedOptions.formatter;\n\n      const error = convertToBanError(err, {\n        formatter,\n        headers: resolvedOptions.headers,\n        sanitize: resolvedOptions.sanitize,\n        includeStackTrace: resolvedOptions.includeStackTrace,\n      });\n\n      // Format the error using pre-resolved options\n      const formatted = formatError(error, formatter, {\n        headers: resolvedOptions.headers,\n        sanitize: resolvedOptions.sanitize,\n        includeStackTrace: resolvedOptions.includeStackTrace,\n      });\n\n      // Create and return response\n      return createErrorResponse(error, formatted);\n    }\n  };\n}\n",
+    "/**\n * Main entry point for hono-ban\n * @module hono-ban\n */\n\n// Export core functionality\nexport * from \"./core\";\n\n// Export formatters\nexport * from \"./formatters\";\n\n// Export error factories\nexport * from \"./factories\";\n\n// Export constants\nexport * from \"./constants\";\n\n// Export types\nexport * from \"./types\";\n\n// Export middleware as default\nimport { ban } from \"./middleware\";\nexport default ban;\n"
+  ],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAaO,SAAS,UAAU,CAAC,KAAc,YAAsC;AAAA,EAC7E,OACE,OAAO,QAAQ,YACf,QAAQ,QACR,WAAW,OACX,IAAI,UAAU,UACZ,cAAe,IAAiB,WAAW;AAAA;AAS1C,SAAS,iBAA8B,CAC5C,KACA,UAAyB,CAAC,GACb;AAAA,EAEb,IAAI,WAAW,GAAG,GAAG;AAAA,IACnB,MAAM,SAAsB;AAAA,MAC1B,QAAQ,QAAQ,cAAc,IAAI;AAAA,MAClC,SAAS,QAAQ,WAAW,IAAI;AAAA,MAChC,OAAO;AAAA,MACP,MAAO,QAAQ,SAAS,YAAY,QAAQ,OAAO,IAAI;AAAA,MAGvD,SAAS;AAAA,WACJ,IAAI;AAAA,WACJ,QAAQ;AAAA,MACb;AAAA,MACA,OAAO,QAAQ,QACX,MAAM,QAAQ,QAAQ,KAAK,IACzB,CAAC,GAAG,QAAQ,KAAK,IACjB,CAAC,QAAQ,KAAK,IAChB,IAAI;AAAA,MACR,OAAO,QAAQ,SAAS,IAAI;AAAA,MAC5B,OAAO,IAAI;AAAA,IACb;AAAA,IAEA,OAAO;AAAA,EACT;AAAA,EAGA,IAAI,eAAe,OAAO;AAAA,IACxB,OAAO,YAAe;AAAA,SACjB;AAAA,MACH,SAAS,QAAQ,WAAW,IAAI;AAAA,MAChC,OAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA,EAGA,OAAO,YAAe;AAAA,OACjB;AAAA,IACH,SACE,QAAQ,YAAY,OAAO,QAAQ,WAAW,MAAM;AAAA,IACtD,OAAO;AAAA,EACT,CAAC;AAAA;;;AC1DI,SAAS,WAAW,CACzB,OACA,WACA,UAAyB,CAAC,GACjB;AAAA,EAET,OAAO,UAAU,OACf,OACA,QAAQ,SACR,QAAQ,UACR,QAAQ,iBACV;AAAA;AAQK,SAAS,mBAAmB,CACjC,OACA,WACU;AAAA,EACV,MAAM,UAAU,IAAI,QAAQ;AAAA,IAC1B,gBAAgB;AAAA,OACb,MAAM;AAAA,EACX,CAAC;AAAA,EAED,IAAI,MAAM,OAAO,QAAQ;AAAA,IACvB,QAAQ,IAAI,SAAS,MAAM,MAAM,KAAK,IAAI,CAAC;AAAA,EAC7C;AAAA,EAGA,MAAM,mBACJ,MAAM,QACN,OAAO,MAAM,SAAS,YACtB,sBAAsB,MAAM,QAC5B,MAAM,KAAK,qBAAqB;AAAA,EAGlC,IAAI,oBAAoB,OAAuC;AAAA,EAe/D;AAAA,EAEA,OAAO,IAAI,SAAS,KAAK,UAAU,SAAS,GAAG;AAAA,IAC7C,QAAQ,MAAM;AAAA,IACd;AAAA,EACF,CAAC;AAAA;;AChEI,SAAS,cAAc,CAC5B,KACA,cACS;AAAA,EACT,KAAK,aAAa,QAAQ;AAAA,IACxB,OAAO;AAAA,EACT;AAAA,EAEA,IAAI,MAAM,QAAQ,GAAG,GAAG;AAAA,IACtB,OAAO,IAAI,IAAI,CAAC,SAAS,eAAe,MAAM,YAAY,CAAC;AAAA,EAC7D;AAAA,EAEA,IAAI,QAAQ,QAAQ,OAAO,QAAQ,UAAU;AAAA,IAC3C,OAAO,OAAO,QAAQ,GAAG,EAAE,OAAO,CAAC,MAAM,KAAK,WAAW;AAAA,MACvD,IAAI,aAAa,SAAS,GAAG,GAAG;AAAA,QAC9B,OAAO;AAAA,MACT;AAAA,MACA,IAAI,OAAO,eAAe,OAAO,YAAY;AAAA,MAC7C,OAAO;AAAA,OACN,CAAC,CAA4B;AAAA,EAClC;AAAA,EAEA,OAAO;AAAA;;;ACpBF,IAAM,mBAAmB;AAAA,EAC9B,aAAa;AAAA,EASb,MAAM,CACJ,OACA,UAAmB,CAAC,GACpB,WAA8B,CAAC,GAC/B,oBAAoB,OACA;AAAA,IACpB,QAAQ,QAAQ,SAAS,SAAS;AAAA,IAGlC,MAAM,UAAyC;AAAA,MAC7C,YAAY;AAAA,MACZ,OAAO,aAAa,WAAW;AAAA,IACjC;AAAA,IAGA,IAAI,OAAO,YAAY,UAAU;AAAA,MAC/B,QAAQ,UAAU;AAAA,IACpB;AAAA,IAEA,MAAM,mBACJ,QACA,OAAO,SAAS,YAChB,sBAAsB,QACtB,KAAK,qBAAqB;AAAA,IAE5B,IAAI,qBAAqB,kBAAkB;AAAA,MACzC,IAAI,MAAM,OAAO;AAAA,QACf,QAAQ,QAAQ,MAAM;AAAA,MACxB;AAAA,MACA,IAAI,MAAM,YAAY;AAAA,QACpB,QAAQ,aAAa,MAAM;AAAA,MAC7B;AAAA,IACF;AAAA,IAEA,IAAI,SAAS,WAAW;AAAA,MACtB,QAAQ,OAAO;AAAA,IACjB;AAAA,IAGA,MAAM,SAA6B;AAAA,MACjC,YAAY;AAAA,MACZ,SAAS,eACP,SACA,QACF;AAAA,IACF;AAAA,IAEA,OAAO;AAAA;AAEX;;;ACzDA,SAAS,qBAAwB,CAC/B,YACA,kBACA,SACa;AAAA,EACb,IAAI,OAAO,qBAAqB,UAAU;AAAA,IACxC,OAAO,YAAe;AAAA,SACjB;AAAA,MACH;AAAA,MACA,SAAS;AAAA,IACX,CAAC;AAAA,EACH;AAAA,EACA,OAAO,YAAe,KAAK,qBAAqB,SAAS,WAAW,CAAC;AAAA;AAQhE,SAAS,QAAqB,CACnC,kBACA,SACa;AAAA,EACb,OAAO,sBACL,KACA,kBACA,OACF;AAAA;AAQK,SAAS,cAA2B,CACzC,kBACA,SACa;AAAA,EACb,OAAO,sBACL,KACA,kBACA,OACF;AAAA;AAQK,SAAS,UAAuB,CACrC,kBACA,SACa;AAAA,EACb,OAAO,sBACL,KACA,kBACA,OACF;AAAA;AAQK,SAAS,iBAA8B,CAC5C,kBACA,SACa;AAAA,EACb,OAAO,sBACL,KACA,kBACA,OACF;AAAA;AAQK,SAAS,cAA2B,CACzC,kBACA,SACa;AAAA,EACb,OAAO,sBACL,KACA,kBACA,OACF;AAAA;AAQK,SAAS,uBAAoC,CAClD,kBACA,SACa;AAAA,EACb,OAAO,sBACL,KACA,kBACA,OACF;AAAA;AAQK,SAAS,qBAAkC,CAChD,kBACA,SACa;AAAA,EACb,OAAO,sBACL,KACA,kBACA,OACF;AAAA;AAQK,SAAS,mBAAgC,CAC9C,kBACA,SACa;AAAA,EACb,OAAO,sBACL,KACA,kBACA,OACF;AAAA;AAQK,SAAS,YAAyB,CACvC,kBACA,SACa;AAAA,EACb,OAAO,sBACL,KACA,kBACA,OACF;AAAA;AAQK,SAAS,WAAwB,CACtC,kBACA,SACa;AAAA,EACb,OAAO,sBACL,KACA,kBACA,OACF;AAAA;AAQK,SAAS,mBAAgC,CAC9C,kBACA,SACa;AAAA,EACb,OAAO,sBACL,KACA,kBACA,OACF;AAAA;AAQK,SAAS,iBAA8B,CAC5C,kBACA,SACa;AAAA,EACb,MAAM,gBACJ,OAAO,qBAAqB,WACxB,KAAK,SAAS,SAAS,iBAAiB,IACxC,KAAK,qBAAqB,QAAQ;AAAA,EAExC,MAAM,aAAa;AAAA,IACjB,kBAAkB;AAAA,OACb,cAAc,QAAoC,CAAC;AAAA,EAC1D;AAAA,EAEA,OAAO,YAAe;AAAA,OACjB;AAAA,IACH,YAAY;AAAA,IACZ,MAAM;AAAA,EACR,CAAC;AAAA;;ACvNH,IAAM,kBAAkD;AAAA,EACtD,WAAW;AAAA,EACX,UAAU,CAAC;AAAA,EACX,mBAAmB;AAAA,EACnB,SAAS,CAAC;AACZ;AAkBO,SAAS,GAAG,CAAC,UAAgC,CAAC,GAAsB;AAAA,EACzE,MAAM,kBAAkD;AAAA,OACnD;AAAA,OACA;AAAA,IACH,WAAW,QAAQ,YACf,QAAQ,YACR,gBAAgB;AAAA,IACpB,SAAS;AAAA,SACJ,gBAAgB;AAAA,SAChB,QAAQ;AAAA,IACb;AAAA,IACA,UAAU,CAAC,GAAG,gBAAgB,UAAU,GAAI,QAAQ,YAAY,CAAC,CAAE;AAAA,EACrE;AAAA,EAGA,OAAO,OAAO,GAAG,SAAS;AAAA,IACxB,IAAI;AAAA,MACF,MAAM,KAAK;AAAA,MACX,OAAO,KAAK;AAAA,MAEZ,MAAM,YAAY,gBAAgB;AAAA,MAElC,MAAM,QAAQ,kBAAkB,KAAK;AAAA,QACnC;AAAA,QACA,SAAS,gBAAgB;AAAA,QACzB,UAAU,gBAAgB;AAAA,QAC1B,mBAAmB,gBAAgB;AAAA,MACrC,CAAC;AAAA,MAGD,MAAM,YAAY,YAAY,OAAO,WAAW;AAAA,QAC9C,SAAS,gBAAgB;AAAA,QACzB,UAAU,gBAAgB;AAAA,QAC1B,mBAAmB,gBAAgB;AAAA,MACrC,CAAC;AAAA,MAGD,OAAO,oBAAoB,OAAO,SAAS;AAAA;AAAA;AAAA;;ACnDjD,IAAe;",
+  "debugId": "4A7C3F0FCA1780B264756E2164756E21",
+  "names": []
+}

package/dist/types/formatters/rfc7807/formatter.d.ts

@@ -4,7 +4,7 @@
  */
 import { z } from "@hono/zod-openapi";
 import type { ErrorFormatter } from "../../types";
-import type { ValidationParam, RFC7807FormatterOptions as RFC7807Options } from "../../types";
+import type { RFC7807ValidationParam, RFC7807FormatterOptions as RFC7807Options } from "../../types";
 /**
  * Create an RFC 7807 Problem Details formatter
  */
@@ -12,7 +12,7 @@ export declare function createRFC7807Formatter(options?: RFC7807Options): ErrorF
 /**
  * Create validation error data in RFC 7807 format
  */
-export declare function createValidationError(params: ValidationParam[]): {
+export declare function createRFC7807ValidationError(params: RFC7807ValidationParam[]): {
     "invalid-params": {
         name: string;
         reason: string;
@@ -21,7 +21,7 @@ export declare function createValidationError(params: ValidationParam[]): {
 /**
  * Convert Zod validation errors to RFC 7807 format
  */
-export declare function createZodValidationError(error: z.ZodError): {
+export declare function createRFC7807ZodValidationError(error: z.ZodError): {
     "invalid-params": {
         name: string;
         reason: string;
@@ -30,7 +30,7 @@ export declare function createZodValidationError(error: z.ZodError): {
 /**
  * Create constraint violation data in RFC 7807 format
  */
-export declare function createConstraintViolation(name: string, reason: string, resource: string, constraint?: string): {
+export declare function createRFC7807ConstraintViolation(name: string, reason: string, resource: string, constraint?: string): {
     violations: {
         name: string;
         reason: string;

package/dist/types/formatters/rfc7807/hooks.d.ts

@@ -4,12 +4,37 @@
  */
 import { Hook } from "@hono/zod-openapi";
 import { Env } from "hono";
-import type { RFC7807FormatterOptions as RFC7807Options } from "../../types";
+import type { RFC7807FormatterOptions as RFC7807Options, BanOptions } from "../../types";
 /**
  * Create a Hono hook that formats validation errors using RFC 7807
+ *
+ * This hook throws a badRequest error that will be caught and processed by the ban middleware.
+ * You can provide options to override the default behavior of the middleware.
+ *
+ * @example
+ * // Basic usage - inherits all settings from middleware
+ * app.openapi(route, handler, { onError: createRFC7807Hook() });
+ *
+ * @example
+ * // With custom message
+ * app.openapi(route, handler, {
+ *   onError: createRFC7807Hook({ message: "Custom validation error" })
+ * });
+ *
+ * @example
+ * // With custom formatter and sanitization
+ * app.openapi(route, handler, {
+ *   onError: createRFC7807Hook({
+ *     formatter: customFormatter,
+ *     sanitize: ['password', 'token']
+ *   })
+ * });
  */
-export declare function createRFC7807Hook(options?: RFC7807Options): Hook<any, Env, any, any>;
+export declare function createRFC7807Hook<E extends Env = Env>(options?: RFC7807Options & Partial<BanOptions>): Hook<any, E, any, any>;
 /**
  * Pre-configured RFC 7807 hook with default options
+ *
+ * This is a convenience export that uses the default options.
+ * It will throw a badRequest error that will be caught and processed by the ban middleware.
  */
 export declare const rfc7807Hook: Hook<any, Env, any, any>;

package/dist/types/formatters/rfc7807/index.d.ts

@@ -2,6 +2,6 @@
  * RFC 7807 Problem Details implementation for Hono Ban
  * @module hono-ban/formatters/rfc7807
  */
-export { createRFC7807Formatter, createValidationError, createZodValidationError, createConstraintViolation, } from "./formatter";
+export { createRFC7807Formatter, createRFC7807ValidationError, createRFC7807ZodValidationError, createRFC7807ConstraintViolation, } from "./formatter";
 export { createRFC7807Hook, rfc7807Hook } from "./hooks";
-export { ValidationParamSchema, ConstraintViolationSchema, ProblemErrorDataSchema, ProblemDetailsSchema, } from "./schemas";
+export { RFC7807ValidationParamSchema, RFC7807ConstraintViolationSchema, RFC7807ErrorDataSchema, RFC7807DetailsSchema, } from "./schemas";

package/dist/types/formatters/rfc7807/schemas.d.ts

@@ -4,9 +4,9 @@
  */
 import { z } from "@hono/zod-openapi";
 /**
- * Schema for validation error parameters
+ * Schema for RFC 7807 validation error parameters
  */
-export declare const ValidationParamSchema: z.ZodObject<{
+export declare const RFC7807ValidationParamSchema: z.ZodObject<{
     name: z.ZodString;
     reason: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -17,9 +17,9 @@ export declare const ValidationParamSchema: z.ZodObject<{
     reason: string;
 }>;
 /**
- * Schema for constraint violations
+ * Schema for RFC 7807 constraint violations
  */
-export declare const ConstraintViolationSchema: z.ZodObject<{
+export declare const RFC7807ConstraintViolationSchema: z.ZodObject<{
     name: z.ZodString;
     reason: z.ZodString;
     resource: z.ZodString;
@@ -36,9 +36,9 @@ export declare const ConstraintViolationSchema: z.ZodObject<{
     constraint: string;
 }>;
 /**
- * Schema for additional error data in problem details
+ * Schema for additional error data in RFC 7807 problem details
  */
-export declare const ProblemErrorDataSchema: z.ZodObject<{
+export declare const RFC7807ErrorDataSchema: z.ZodObject<{
     "invalid-params": z.ZodOptional<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         reason: z.ZodString;
@@ -91,13 +91,13 @@ export declare const ProblemErrorDataSchema: z.ZodObject<{
 /**
  * Schema for complete RFC 7807 problem details
  */
-export declare const ProblemDetailsSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const RFC7807DetailsSchema: z.ZodObject<z.objectUtil.extendShape<{
     type: z.ZodString;
     title: z.ZodString;
     status: z.ZodNumber;
-    detail: z.ZodString;
-    instance: z.ZodString;
-    timestamp: z.ZodString;
+    detail: z.ZodOptional<z.ZodString>;
+    instance: z.ZodOptional<z.ZodString>;
+    timestamp: z.ZodOptional<z.ZodString>;
 }, {
     "invalid-params": z.ZodOptional<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
@@ -129,9 +129,6 @@ export declare const ProblemDetailsSchema: z.ZodObject<z.objectUtil.extendShape<
     type: string;
     title: string;
     status: number;
-    detail: string;
-    instance: string;
-    timestamp: string;
     "invalid-params"?: {
         name: string;
         reason: string;
@@ -142,13 +139,13 @@ export declare const ProblemDetailsSchema: z.ZodObject<z.objectUtil.extendShape<
         resource: string;
         constraint: string;
     }[] | undefined;
+    detail?: string | undefined;
+    instance?: string | undefined;
+    timestamp?: string | undefined;
 }, {
     type: string;
     title: string;
     status: number;
-    detail: string;
-    instance: string;
-    timestamp: string;
     "invalid-params"?: {
         name: string;
         reason: string;
@@ -159,4 +156,7 @@ export declare const ProblemDetailsSchema: z.ZodObject<z.objectUtil.extendShape<
         resource: string;
         constraint: string;
     }[] | undefined;
+    detail?: string | undefined;
+    instance?: string | undefined;
+    timestamp?: string | undefined;
 }>;

package/dist/types/types/rfc7807.d.ts

@@ -8,87 +8,70 @@
  * @module hono-ban/types/rfc7807
  * @see {@link https://datatracker.ietf.org/doc/html/rfc7807} RFC 7807 Problem Details
  */
+import { z } from "@hono/zod-openapi";
+import { RFC7807ValidationParamSchema, RFC7807ConstraintViolationSchema, RFC7807ErrorDataSchema, RFC7807DetailsSchema } from "../formatters/rfc7807/schemas";
 /**
  * Represents a validation error parameter in an RFC 7807 problem details object.
  * Used to indicate specific validation failures in request parameters.
  *
- * @interface ValidationParam
+ * @type RFC7807ValidationParam
  * @property {string} name - The name of the parameter that failed validation
  * @property {string} reason - The reason why the parameter failed validation
  */
-export interface ValidationParam {
-    name: string;
-    reason: string;
-}
+export type RFC7807ValidationParam = z.infer<typeof RFC7807ValidationParamSchema>;
 /**
  * Represents a constraint violation in an RFC 7807 problem details object.
  * Used to indicate violations of business rules or data constraints.
  *
- * @interface ConstraintViolation
+ * @type RFC7807ConstraintViolation
  * @property {string} name - The name of the violated constraint
  * @property {string} reason - The reason why the constraint was violated
  * @property {string} resource - The resource or entity where the violation occurred
  * @property {string} constraint - The specific constraint that was violated
  */
-export interface ConstraintViolation {
-    name: string;
-    reason: string;
-    resource: string;
-    constraint: string;
-}
+export type RFC7807ConstraintViolation = z.infer<typeof RFC7807ConstraintViolationSchema>;
 /**
  * Additional error data that can be included in an RFC 7807 problem details object.
  * This interface extends the standard problem details with validation and constraint information.
  *
- * @interface ProblemErrorData
- * @property {ValidationParam[]} [invalid-params] - Array of validation errors
- * @property {ConstraintViolation[]} [violations] - Array of constraint violations
+ * @type RFC7807ErrorData
+ * @property {RFC7807ValidationParam[]} [invalid-params] - Array of validation errors
+ * @property {RFC7807ConstraintViolation[]} [violations] - Array of constraint violations
  */
-export interface ProblemErrorData {
-    "invalid-params"?: ValidationParam[];
-    violations?: ConstraintViolation[];
-}
+export type RFC7807ErrorData = z.infer<typeof RFC7807ErrorDataSchema>;
 /**
  * Complete RFC 7807 problem details object structure.
  * This interface represents the full problem details format as defined in RFC 7807,
  * with additional properties for validation and constraint violation data.
  *
- * @interface ProblemDetails
- * @extends ProblemErrorData
+ * @type RFC7807Details
  * @property {string} type - URI reference that identifies the problem type
  * @property {string} title - Short, human-readable summary of the problem
  * @property {number} status - HTTP status code (400-599)
- * @property {string} detail - Human-readable explanation specific to this occurrence
- * @property {string} instance - URI reference that identifies the specific occurrence
- * @property {string} timestamp - ISO 8601 datetime when the error occurred
+ * @property {string} [detail] - Human-readable explanation specific to this occurrence
+ * @property {string} [instance] - URI reference that identifies the specific occurrence
+ * @property {string} [timestamp] - ISO 8601 datetime when the error occurred
  */
-export interface ProblemDetails extends ProblemErrorData {
-    type: string;
-    title: string;
-    status: number;
-    detail: string;
-    instance: string;
-    timestamp: string;
-}
+export type RFC7807Details = z.infer<typeof RFC7807DetailsSchema>;
 /**
  * Hook function for customizing RFC 7807 problem details before formatting.
  * This type represents a function that can modify the problem details object
  * before it is serialized into the final response.
  *
- * @callback ProblemDetailsHook
- * @param {ProblemDetails} details - The problem details object to modify
- * @returns {ProblemDetails} The modified problem details object
+ * @callback RFC7807DetailsHook
+ * @param {RFC7807Details} details - The problem details object to modify
+ * @returns {RFC7807Details} The modified problem details object
  */
-export type ProblemDetailsHook = (details: ProblemDetails) => ProblemDetails;
+export type RFC7807DetailsHook = (details: RFC7807Details) => RFC7807Details;
 /**
  * Configuration options for the RFC 7807 formatter.
  * These options control how problem details are generated and formatted.
  *
  * @interface RFC7807FormatterOptions
  * @property {string} [baseUrl="https://api.example.com/problems"] - Base URL for problem type URIs
- * @property {ProblemDetailsHook[]} [hooks=[]] - Array of hooks for customizing problem details
+ * @property {RFC7807DetailsHook[]} [hooks=[]] - Array of hooks for customizing problem details
  */
 export interface RFC7807FormatterOptions {
     baseUrl?: string;
-    hooks?: ProblemDetailsHook[];
+    hooks?: RFC7807DetailsHook[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono-ban",
-  "version": "0.2.0",
+  "version": "0.2.4",
   "description": "HTTP-friendly error objects for Hono, inspired by Boom",
   "type": "module",
   "main": "dist/cjs/index.js",
@@ -37,11 +37,11 @@
   "sideEffects": false,
   "scripts": {
     "build": "bun run build:esm && bun run build:cjs && bun run build:declaration",
-    "build:esm": "bun build --target=node ./src/index.ts --outfile=dist/esm/index.js --format=esm --external hono --external @hono/zod-openapi",
-    "build:cjs": "bun build --target=node ./src/index.ts --outfile=dist/cjs/index.js --format=cjs --external hono --external @hono/zod-openapi",
+    "build:esm": "bun build --target=node --format=esm --packages=external --outdir=dist/esm --sourcemap=linked --splitting ./src/index.ts ./src/formatters/rfc7807/index.ts",
+    "build:cjs": "bun build --target=node --format=cjs --packages=external --outdir=dist/cjs --sourcemap=linked --splitting ./src/index.ts ./src/formatters/rfc7807/index.ts",
     "build:declaration": "tsc --emitDeclarationOnly --project tsconfig.types.json",
     "postbuild": "rimraf tsconfig.types.tsbuildinfo",
-    "dev": "bun build src/index.ts --outdir dist --target node --watch",
+    "dev": "bun build --target=node --packages=external --outdir=dist --watch ./src/index.ts ./src/formatters/rfc7807/index.ts",
     "test": "bun test",
     "test:watch": "bun test --watch",
     "test:coverage": "bun test --coverage",

package/src/formatters/rfc7807/formatter.ts

@@ -7,15 +7,15 @@ import { z } from "@hono/zod-openapi";
 import { STATUS_CODES } from "../../constants";
 import type { BanError, ErrorFormatter } from "../../types";
 import type {
-  ProblemDetails,
-  ProblemErrorData,
-  ValidationParam,
+  RFC7807Details,
+  RFC7807ErrorData,
+  RFC7807ValidationParam,
   RFC7807FormatterOptions as RFC7807Options,
 } from "../../types";
 import {
-  ConstraintViolationSchema,
-  ProblemDetailsSchema,
-  ValidationParamSchema,
+  RFC7807ConstraintViolationSchema,
+  RFC7807DetailsSchema,
+  RFC7807ValidationParamSchema,
 } from "./schemas";
 
 /**
@@ -29,7 +29,7 @@ export function createRFC7807Formatter(
   return {
     contentType: "application/problem+json",
 
-    format<T extends ProblemErrorData>(error: BanError<T>): ProblemDetails {
+    format<T extends RFC7807ErrorData>(error: BanError<T>): RFC7807Details {
       const base = {
         type: `${baseUrl}/${error.status}`,
         title: STATUS_CODES[error.status] || "Unknown Error",
@@ -41,7 +41,7 @@ export function createRFC7807Formatter(
 
       // Handle validation errors
       if (error.data?.["invalid-params"]) {
-        return ProblemDetailsSchema.parse({
+        return RFC7807DetailsSchema.parse({
           ...base,
           "invalid-params": error.data["invalid-params"],
         });
@@ -49,13 +49,13 @@ export function createRFC7807Formatter(
 
       // Handle constraint violations
       if (error.data?.violations) {
-        return ProblemDetailsSchema.parse({
+        return RFC7807DetailsSchema.parse({
           ...base,
           violations: error.data.violations,
         });
       }
 
-      return ProblemDetailsSchema.parse(base);
+      return RFC7807DetailsSchema.parse(base);
     },
   };
 }
@@ -63,18 +63,18 @@ export function createRFC7807Formatter(
 /**
  * Create validation error data in RFC 7807 format
  */
-export function createValidationError(params: ValidationParam[]) {
+export function createRFC7807ValidationError(params: RFC7807ValidationParam[]) {
   return {
-    "invalid-params": ValidationParamSchema.array().parse(params),
+    "invalid-params": RFC7807ValidationParamSchema.array().parse(params),
   };
 }
 
 /**
  * Convert Zod validation errors to RFC 7807 format
  */
-export function createZodValidationError(error: z.ZodError) {
+export function createRFC7807ZodValidationError(error: z.ZodError) {
   return {
-    "invalid-params": ValidationParamSchema.array().parse(
+    "invalid-params": RFC7807ValidationParamSchema.array().parse(
       error.errors.map((e) => ({
         name: e.path.join("."),
         reason: e.message,
@@ -86,14 +86,14 @@ export function createZodValidationError(error: z.ZodError) {
 /**
  * Create constraint violation data in RFC 7807 format
  */
-export function createConstraintViolation(
+export function createRFC7807ConstraintViolation(
   name: string,
   reason: string,
   resource: string,
   constraint: string = "unique"
 ) {
   return {
-    violations: ConstraintViolationSchema.array().parse([
+    violations: RFC7807ConstraintViolationSchema.array().parse([
       {
         name,
         reason,

package/src/formatters/rfc7807/hooks.ts

@@ -7,41 +7,67 @@ import { ZodError } from "zod";
 import { Hook } from "@hono/zod-openapi";
 import { Env } from "hono";
 import { badRequest } from "../../factories";
-import { formatError, createErrorResponse } from "../../core";
-import type { RFC7807FormatterOptions as RFC7807Options } from "../../types";
-
-import { createRFC7807Formatter } from "./formatter";
-import { createZodValidationError } from "./formatter";
+import type {
+  RFC7807FormatterOptions as RFC7807Options,
+  BanOptions,
+} from "../../types";
+import { createRFC7807ZodValidationError } from "./formatter";
 
 /**
  * Create a Hono hook that formats validation errors using RFC 7807
+ *
+ * This hook throws a badRequest error that will be caught and processed by the ban middleware.
+ * You can provide options to override the default behavior of the middleware.
+ *
+ * @example
+ * // Basic usage - inherits all settings from middleware
+ * app.openapi(route, handler, { onError: createRFC7807Hook() });
+ *
+ * @example
+ * // With custom message
+ * app.openapi(route, handler, {
+ *   onError: createRFC7807Hook({ message: "Custom validation error" })
+ * });
+ *
+ * @example
+ * // With custom formatter and sanitization
+ * app.openapi(route, handler, {
+ *   onError: createRFC7807Hook({
+ *     formatter: customFormatter,
+ *     sanitize: ['password', 'token']
+ *   })
+ * });
  */
-export function createRFC7807Hook(
-  options?: RFC7807Options
-): Hook<any, Env, any, any> {
-  const formatter = createRFC7807Formatter(options);
-
+export function createRFC7807Hook<E extends Env = Env>(
+  options?: RFC7807Options & Partial<BanOptions>
+): Hook<any, E, any, any> {
   return (result, c) => {
     if (
       !result.success &&
       "error" in result &&
       result.error instanceof ZodError
     ) {
-      // Create the error
-      const error = badRequest("Validation Error", {
-        data: createZodValidationError(result.error),
-      });
+      // Create the validation error data
+      const validationData = createRFC7807ZodValidationError(result.error);
 
-      // Format the error using RFC7807
-      const formatted = formatError(error, formatter);
-
-      // Create and return the response
-      return createErrorResponse(error, formatted);
+      // Throw badRequest with both the validation data and any override options
+      throw badRequest({
+        message: options?.message || "Validation Error",
+        data: validationData,
+        // Pass through any override options
+        formatter: options?.formatter,
+        headers: options?.headers,
+        sanitize: options?.sanitize,
+        includeStackTrace: options?.includeStackTrace,
+      });
     }
   };
 }
 
 /**
  * Pre-configured RFC 7807 hook with default options
+ *
+ * This is a convenience export that uses the default options.
+ * It will throw a badRequest error that will be caught and processed by the ban middleware.
  */
-export const rfc7807Hook = createRFC7807Hook();
+export const rfc7807Hook = createRFC7807Hook<Env>();

package/src/formatters/rfc7807/index.ts

@@ -5,16 +5,16 @@
 
 export {
   createRFC7807Formatter,
-  createValidationError,
-  createZodValidationError,
-  createConstraintViolation,
+  createRFC7807ValidationError,
+  createRFC7807ZodValidationError,
+  createRFC7807ConstraintViolation,
 } from "./formatter";
 
 export { createRFC7807Hook, rfc7807Hook } from "./hooks";
 
 export {
-  ValidationParamSchema,
-  ConstraintViolationSchema,
-  ProblemErrorDataSchema,
-  ProblemDetailsSchema,
+  RFC7807ValidationParamSchema,
+  RFC7807ConstraintViolationSchema,
+  RFC7807ErrorDataSchema,
+  RFC7807DetailsSchema,
 } from "./schemas";