hono-ban 0.2.4 → 0.2.6

package/src/middleware/ban-middleware.ts

@@ -1,77 +0,0 @@
-/**
- * Error handling middleware
- * @module hono-ban/middleware/ban-middleware
- */
-
-import type { MiddlewareHandler } from "hono";
-import { convertToBanError, formatError, createErrorResponse } from "../core";
-import { defaultFormatter } from "../formatters";
-import type { BanMiddlewareOptions } from "../types";
-
-/**
- * Default middleware options
- */
-const DEFAULT_OPTIONS: Required<BanMiddlewareOptions> = {
-  formatter: defaultFormatter,
-  sanitize: [],
-  includeStackTrace: false,
-  headers: {},
-};
-
-/**
- * Create error handling middleware
- * @param options - Middleware configuration options
- *
- * @example
- * // Simple usage
- * app.use(ban());
- *
- * @example
- * // Advanced usage
- * app.use(ban({
- *   formatter: customFormatter,
- *   sanitize: ['password', 'token'],
- *   includeStackTrace: process.env.NODE_ENV !== 'production'
- * }));
- */
-export function ban(options: BanMiddlewareOptions = {}): MiddlewareHandler {
-  const resolvedOptions: Required<BanMiddlewareOptions> = {
-    ...DEFAULT_OPTIONS,
-    ...options,
-    formatter: options.formatter
-      ? options.formatter
-      : DEFAULT_OPTIONS.formatter,
-    headers: {
-      ...DEFAULT_OPTIONS.headers,
-      ...options.headers,
-    },
-    sanitize: [...DEFAULT_OPTIONS.sanitize, ...(options.sanitize || [])],
-  };
-
-  // Return the middleware function that uses the pre-merged options
-  return async (_, next) => {
-    try {
-      await next();
-    } catch (err) {
-      // Get the pre-resolved formatter instance
-      const formatter = resolvedOptions.formatter;
-
-      const error = convertToBanError(err, {
-        formatter,
-        headers: resolvedOptions.headers,
-        sanitize: resolvedOptions.sanitize,
-        includeStackTrace: resolvedOptions.includeStackTrace,
-      });
-
-      // Format the error using pre-resolved options
-      const formatted = formatError(error, formatter, {
-        headers: resolvedOptions.headers,
-        sanitize: resolvedOptions.sanitize,
-        includeStackTrace: resolvedOptions.includeStackTrace,
-      });
-
-      // Create and return response
-      return createErrorResponse(error, formatted);
-    }
-  };
-}

package/src/middleware/index.ts

@@ -1,6 +0,0 @@
-/**
- * Middleware exports
- * @module hono-ban/middleware
- */
-
-export { ban } from "./ban-middleware";

package/src/types/common.ts

@@ -1,14 +0,0 @@
-/**
- * Common shared types
- * @module hono-ban/types/common
- */
-
-/**
- * Type for HTTP headers
- */
-export type Headers = Record<string, string>;
-
-/**
- * Type for allowed HTTP methods
- */
-export type AllowedMethods = string | string[];

package/src/types/error.ts

@@ -1,46 +0,0 @@
-/**
- * Error type definitions
- * @module hono-ban/types/error
- */
-
-import type {
-  ClientErrorStatusCode,
-  ServerErrorStatusCode,
-} from "hono/utils/http-status";
-
-/**
- * Valid HTTP error status codes (4xx and 5xx)
- */
-export type ErrorStatusCode = ClientErrorStatusCode | ServerErrorStatusCode;
-
-/**
- * Core error object interface
- */
-export interface BanError<T = unknown> {
-  /** HTTP error status code */
-  status: ErrorStatusCode;
-
-  /** Error message */
-  message: string;
-
-  /** Additional error context data */
-  data?: T;
-
-  /** Response headers */
-  headers?: Record<string, string>;
-
-  /** Allowed HTTP methods for 405 errors */
-  allow?: readonly string[];
-
-  /** Stack trace if available */
-  stack?: string;
-
-  /** Original error if this wraps another error */
-  cause?: unknown;
-
-  /** Stack trace of the cause error */
-  causeStack?: string;
-
-  /** Type guard identifier */
-  readonly isBan: true;
-}

package/src/types/formatter.ts

@@ -1,61 +0,0 @@
-/**
- * Formatter type definitions
- * @module hono-ban/types/formatter
- */
-
-import type { BanError } from "./error";
-import type { Headers } from "./common";
-
-/**
- * Default error output structure
- */
-export interface DefaultErrorOutput {
-  /** HTTP status code */
-  statusCode: number;
-
-  /** Formatted error payload */
-  payload: {
-    /** HTTP status code */
-    statusCode: number;
-
-    /** Error name from status code */
-    error: string;
-
-    /** Error message if provided */
-    message?: string;
-
-    /** Stack trace if enabled */
-    stack?: string;
-
-    /** Cause stack trace if available */
-    causeStack?: string;
-
-    /** Additional error data */
-    data?: unknown;
-
-    /** Any other properties */
-    [key: string]: unknown;
-  };
-}
-
-/**
- * Error formatter interface
- */
-export interface ErrorFormatter<T = unknown> {
-  /** Response content type */
-  readonly contentType: string;
-
-  /**
-   * Format an error into the desired structure
-   * @param error - Error to format
-   * @param headers - Additional headers (used for HTTP headers, not included in response body)
-   * @param sanitize - Fields to remove
-   * @param includeStackTrace - Include stack trace
-   */
-  format(
-    error: BanError,
-    headers?: Headers,
-    sanitize?: readonly string[],
-    includeStackTrace?: boolean
-  ): T;
-}

package/src/types/index.ts

@@ -1,11 +0,0 @@
-/**
- * Core type definitions for the hono-ban library
- * @module hono-ban/types
- */
-
-// Export all types from their respective files
-export * from "./error";
-export * from "./options";
-export * from "./formatter";
-export * from "./common";
-export * from "./rfc7807";

package/src/types/options.ts

@@ -1,71 +0,0 @@
-/**
- * Options type definitions
- * @module hono-ban/types/options
- */
-
-import type { ErrorStatusCode } from "./error";
-import type { Headers, AllowedMethods } from "./common";
-import type { ErrorFormatter } from "./formatter";
-
-/**
- * Options for creating errors
- */
-export interface BanOptions<T = unknown> {
-  /** HTTP status code */
-  statusCode?: ErrorStatusCode;
-
-  /** Error message */
-  message?: string;
-
-  /** Additional error data */
-  data?: T;
-
-  /** HTTP response headers (not included in response body) */
-  headers?: Headers;
-
-  /** Allowed HTTP methods */
-  allow?: AllowedMethods;
-
-  /** Original error cause */
-  cause?: Error | unknown;
-
-  /** Custom error formatter */
-  formatter?: ErrorFormatter;
-
-  /** Fields to remove from output */
-  sanitize?: readonly string[];
-
-  /** Whether to include stack trace */
-  includeStackTrace?: boolean;
-}
-
-/**
- * Options for formatting errors
- */
-export interface FormatOptions {
-  /** Additional headers for HTTP response (not included in response body) */
-  headers?: Headers;
-
-  /** Fields to remove from output */
-  sanitize?: readonly string[];
-
-  /** Whether to include stack trace */
-  includeStackTrace?: boolean;
-}
-
-/**
- * Middleware configuration options
- */
-export interface BanMiddlewareOptions {
-  /** Custom error formatter or formatter name */
-  formatter?: ErrorFormatter;
-
-  /** Fields to remove from output */
-  sanitize?: readonly string[];
-
-  /** Whether to include stack trace */
-  includeStackTrace?: boolean;
-
-  /** Default headers for HTTP response (not included in response body) */
-  headers?: Headers;
-}

package/src/types/rfc7807.ts

@@ -1,93 +0,0 @@
-/**
- * Type definitions for RFC 7807 Problem Details format.
- *
- * This module provides type definitions for the RFC 7807 Problem Details format,
- * including interfaces and types for validation parameters, constraint violations,
- * and the complete problem details structure.
- *
- * @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.
- *
- * @type RFC7807ValidationParam
- * @property {string} name - The name of the parameter that failed validation
- * @property {string} reason - The reason why the parameter failed validation
- */
-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.
- *
- * @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 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.
- *
- * @type RFC7807ErrorData
- * @property {RFC7807ValidationParam[]} [invalid-params] - Array of validation errors
- * @property {RFC7807ConstraintViolation[]} [violations] - Array of constraint violations
- */
-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.
- *
- * @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
- */
-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 RFC7807DetailsHook
- * @param {RFC7807Details} details - The problem details object to modify
- * @returns {RFC7807Details} The modified problem details object
- */
-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 {RFC7807DetailsHook[]} [hooks=[]] - Array of hooks for customizing problem details
- */
-export interface RFC7807FormatterOptions {
-  baseUrl?: string;
-  hooks?: RFC7807DetailsHook[];
-}

package/src/utils/index.ts

@@ -1,7 +0,0 @@
-/**
- * Utility functions exports
- * @module hono-ban/utils
- */
-
-export * from "./sanitize";
-export * from "./validate";

package/src/utils/sanitize.ts

@@ -1,34 +0,0 @@
-/**
- * Sanitization utilities
- * @module hono-ban/utils/sanitize
- */
-
-/**
- * Recursively sanitize an object by removing specified keys
- * @param obj - Object to sanitize
- * @param keysToRemove - Keys to remove from object
- */
-export function sanitizeObject(
-  obj: unknown,
-  keysToRemove: readonly string[]
-): unknown {
-  if (!keysToRemove.length) {
-    return obj;
-  }
-
-  if (Array.isArray(obj)) {
-    return obj.map((item) => sanitizeObject(item, keysToRemove));
-  }
-
-  if (obj !== null && typeof obj === "object") {
-    return Object.entries(obj).reduce((acc, [key, value]) => {
-      if (keysToRemove.includes(key)) {
-        return acc;
-      }
-      acc[key] = sanitizeObject(value, keysToRemove);
-      return acc;
-    }, {} as Record<string, unknown>);
-  }
-
-  return obj;
-}

package/src/utils/validate.ts

@@ -1,24 +0,0 @@
-/**
- * Validation utilities
- * @module hono-ban/utils/validate
- */
-
-import type { ErrorStatusCode } from "../types/error";
-
-/**
- * Validate and normalize HTTP error status code
- * @param code - Status code to validate
- */
-export function validateStatusCode(code: number): ErrorStatusCode {
-  // Handle invalid inputs
-  if (typeof code !== "number" || isNaN(code)) {
-    return 500;
-  }
-
-  // Ensure code is in error range
-  if (code < 400 || code >= 600) {
-    return 500;
-  }
-
-  return code as ErrorStatusCode;
-}