@fishka/express 0.9.6 → 0.9.7

package/dist/esm/http-status-codes.js

@@ -0,0 +1,224 @@
+/** The request has succeeded (200) */
+export const HTTP_OK = 200;
+/** The request has been fulfilled, and a new resource is created (201) */
+export const HTTP_CREATED = 201;
+/** The request has been accepted for processing, but the processing is not yet complete (202) */
+export const HTTP_ACCEPTED = 202;
+/** The server successfully processed the request, and is not returning any content (204) */
+export const HTTP_NO_CONTENT = 204;
+/** The request has been successfully processed, but is returning no content (205) */
+export const HTTP_RESET_CONTENT = 205;
+/** The server is delivering only part of the resource due to a range header sent by the client (206) */
+export const HTTP_PARTIAL_CONTENT = 206;
+/** The IM used the server processed a request successfully, but the response is transformed (226) */
+export const HTTP_IM_USED = 226;
+/** The resource has been moved permanently to a new URL (301) */
+export const HTTP_MOVED_PERMANENTLY = 301;
+/** The resource is available at a different URL (302) */
+export const HTTP_FOUND = 302;
+/** The resource has not been modified since the last request (304) */
+export const HTTP_NOT_MODIFIED = 304;
+/** The server could not understand the request due to invalid syntax (400) */
+export const HTTP_BAD_REQUEST = 400;
+/** The client must authenticate itself to get the requested response (401) */
+export const HTTP_UNAUTHORIZED = 401;
+/** The client does not have access rights to the content (403) */
+export const HTTP_FORBIDDEN = 403;
+/** The server cannot find the requested resource (404) */
+export const HTTP_NOT_FOUND = 404;
+/** The request method is known by the server but is not supported by the target resource (405) */
+export const HTTP_METHOD_NOT_ALLOWED = 405;
+/** The client must authenticate using a proxy (407) */
+export const HTTP_PROXY_AUTHENTICATION_REQUIRED = 407;
+/** The server timed out waiting for the request (408) */
+export const HTTP_REQUEST_TIMEOUT = 408;
+/** The request conflicts with the current state of the server (409) */
+export const HTTP_CONFLICT = 409;
+/** The resource requested is no longer available and will not be available again (410) */
+export const HTTP_GONE = 410;
+/** The request does not meet the preconditions that the server requires (412) */
+export const HTTP_PRECONDITION_FAILED = 412;
+/** The client sent a request that is too large for the server to process (413) */
+export const HTTP_PAYLOAD_TOO_LARGE = 413;
+/** The URI requested by the client is too long for the server to process (414) */
+export const HTTP_URI_TOO_LONG = 414;
+/** The media format of the requested data is not supported by the server (415) */
+export const HTTP_UNSUPPORTED_MEDIA_TYPE = 415;
+/** The range specified by the client cannot be fulfilled (416) */
+export const HTTP_RANGE_NOT_SATISFIABLE = 416;
+/** The expectation given in the request header could not be met by the server (417) */
+export const HTTP_EXPECTATION_FAILED = 417;
+/** The server refuses to brew coffee because it is a teapot (418) - an Easter egg from RFC 2324 */
+export const HTTP_IM_A_TEAPOT = 418;
+/** The request was well-formed but was unable to be followed due to semantic errors (422) */
+export const HTTP_UNPROCESSABLE_ENTITY = 422;
+/** The resource that is being accessed is locked (423) */
+export const HTTP_LOCKED = 423;
+/** The resource requested is dependent on another resource that has failed (424) */
+export const HTTP_FAILED_DEPENDENCY = 424;
+/** The server is unwilling to risk processing a request that might be replayed (425) */
+export const HTTP_TOO_EARLY = 425;
+/** The client needs to upgrade its protocol (426) */
+export const HTTP_UPGRADE_REQUIRED = 426;
+/** The server requires the request to be conditional (428) */
+export const HTTP_PRECONDITION_REQUIRED = 428;
+/** The client has sent too many requests in a given amount of time (429) */
+export const HTTP_TOO_MANY_REQUESTS = 429;
+/** The request header fields are too large (431) */
+export const HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431;
+/** The client closed the connection with the server before the request was completed (444) */
+export const HTTP_CONNECTION_CLOSED_WITHOUT_RESPONSE = 444;
+/** The client requested an unavailable legal action (451) */
+export const HTTP_UNAVAILABLE_FOR_LEGAL_REASONS = 451;
+/** The server encountered an internal error and was unable to complete the request (500) */
+export const HTTP_INTERNAL_SERVER_ERROR = 500;
+/** The request method is not supported by the server and cannot be handled (501) */
+export const HTTP_NOT_IMPLEMENTED = 501;
+/** The server, while acting as a gateway or proxy, received an invalid response from the upstream server (502) */
+export const HTTP_BAD_GATEWAY = 502;
+/** The server is not ready to handle the request, typically due to temporary overload or maintenance (503) */
+export const HTTP_SERVICE_UNAVAILABLE = 503;
+/** The server, while acting as a gateway or proxy, did not get a response in time from the upstream server (504) */
+export const HTTP_GATEWAY_TIMEOUT = 504;
+/**
+ * An object containing common HTTP status codes.
+ * These constants can be used to improve code readability and maintainability.
+ * @deprecated Use individual HTTP_* constants for better tree-shaking
+ */
+export const HttpStatusCode = {
+    /** The request has succeeded (200) */
+    OK: HTTP_OK,
+    /** The request has been fulfilled, and a new resource is created (201) */
+    CREATED: HTTP_CREATED,
+    /** The request has been accepted for processing, but the processing is not yet complete (202) */
+    ACCEPTED: HTTP_ACCEPTED,
+    /** The server successfully processed the request, and is not returning any content (204) */
+    NO_CONTENT: HTTP_NO_CONTENT,
+    /** The request has been successfully processed, but is returning no content (205) */
+    RESET_CONTENT: HTTP_RESET_CONTENT,
+    /** The server is delivering only part of the resource due to a range header sent by the client (206) */
+    PARTIAL_CONTENT: HTTP_PARTIAL_CONTENT,
+    /** The IM used the server processed a request successfully, but the response is transformed (226) */
+    IM_USED: HTTP_IM_USED,
+    /** The resource has been moved permanently to a new URL (301) */
+    MOVED_PERMANENTLY: HTTP_MOVED_PERMANENTLY,
+    /** The resource is available at a different URL (302) */
+    FOUND: HTTP_FOUND,
+    /** The resource has not been modified since the last request (304) */
+    NOT_MODIFIED: HTTP_NOT_MODIFIED,
+    /** The server could not understand the request due to invalid syntax (400) */
+    BAD_REQUEST: HTTP_BAD_REQUEST,
+    /** The client must authenticate itself to get the requested response (401) */
+    UNAUTHORIZED: HTTP_UNAUTHORIZED,
+    /** The client does not have access rights to the content (403) */
+    FORBIDDEN: HTTP_FORBIDDEN,
+    /** The server cannot find the requested resource (404) */
+    NOT_FOUND: HTTP_NOT_FOUND,
+    /** The request method is known by the server but is not supported by the target resource (405) */
+    METHOD_NOT_ALLOWED: HTTP_METHOD_NOT_ALLOWED,
+    /** The client must authenticate using a proxy (407) */
+    PROXY_AUTHENTICATION_REQUIRED: HTTP_PROXY_AUTHENTICATION_REQUIRED,
+    /** The server timed out waiting for the request (408) */
+    REQUEST_TIMEOUT: HTTP_REQUEST_TIMEOUT,
+    /** The request conflicts with the current state of the server (409) */
+    CONFLICT: HTTP_CONFLICT,
+    /** The resource requested is no longer available and will not be available again (410) */
+    GONE: HTTP_GONE,
+    /** The request does not meet the preconditions that the server requires (412) */
+    PRECONDITION_FAILED: HTTP_PRECONDITION_FAILED,
+    /** The client sent a request that is too large for the server to process (413) */
+    PAYLOAD_TOO_LARGE: HTTP_PAYLOAD_TOO_LARGE,
+    /** The URI requested by the client is too long for the server to process (414) */
+    URI_TOO_LONG: HTTP_URI_TOO_LONG,
+    /** The media format of the requested data is not supported by the server (415) */
+    UNSUPPORTED_MEDIA_TYPE: HTTP_UNSUPPORTED_MEDIA_TYPE,
+    /** The range specified by the client cannot be fulfilled (416) */
+    RANGE_NOT_SATISFIABLE: HTTP_RANGE_NOT_SATISFIABLE,
+    /** The expectation given in the request header could not be met by the server (417) */
+    EXPECTATION_FAILED: HTTP_EXPECTATION_FAILED,
+    /** The server refuses to brew coffee because it is a teapot (418) - an Easter egg from RFC 2324 */
+    IM_A_TEAPOT: HTTP_IM_A_TEAPOT,
+    /** The request was well-formed but was unable to be followed due to semantic errors (422) */
+    UNPROCESSABLE_ENTITY: HTTP_UNPROCESSABLE_ENTITY,
+    /** The resource that is being accessed is locked (423) */
+    LOCKED: HTTP_LOCKED,
+    /** The resource requested is dependent on another resource that has failed (424) */
+    FAILED_DEPENDENCY: HTTP_FAILED_DEPENDENCY,
+    /** The server is unwilling to risk processing a request that might be replayed (425) */
+    TOO_EARLY: HTTP_TOO_EARLY,
+    /** The client needs to upgrade its protocol (426) */
+    UPGRADE_REQUIRED: HTTP_UPGRADE_REQUIRED,
+    /** The server requires the request to be conditional (428) */
+    PRECONDITION_REQUIRED: HTTP_PRECONDITION_REQUIRED,
+    /** The client has sent too many requests in a given amount of time (429) */
+    TOO_MANY_REQUESTS: HTTP_TOO_MANY_REQUESTS,
+    /** The request header fields are too large (431) */
+    REQUEST_HEADER_FIELDS_TOO_LARGE: HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE,
+    /** The client closed the connection with the server before the request was completed (444) */
+    CONNECTION_CLOSED_WITHOUT_RESPONSE: HTTP_CONNECTION_CLOSED_WITHOUT_RESPONSE,
+    /** The client requested an unavailable legal action (451) */
+    UNAVAILABLE_FOR_LEGAL_REASONS: HTTP_UNAVAILABLE_FOR_LEGAL_REASONS,
+    /** The server encountered an internal error and was unable to complete the request (500) */
+    INTERNAL_SERVER_ERROR: HTTP_INTERNAL_SERVER_ERROR,
+    /** The request method is not supported by the server and cannot be handled (501) */
+    NOT_IMPLEMENTED: HTTP_NOT_IMPLEMENTED,
+    /** The server, while acting as a gateway or proxy, received an invalid response from the upstream server (502) */
+    BAD_GATEWAY: HTTP_BAD_GATEWAY,
+    /** The server is not ready to handle the request, typically due to temporary overload or maintenance (503) */
+    SERVICE_UNAVAILABLE: HTTP_SERVICE_UNAVAILABLE,
+    /** The server, while acting as a gateway or proxy, did not get a response in time from the upstream server (504) */
+    GATEWAY_TIMEOUT: HTTP_GATEWAY_TIMEOUT,
+};
+/**
+ * Returns the reason phrase corresponding to the given HTTP status code.
+ * This is useful for converting status codes into human-readable messages.
+ *
+ * @param statusCode - The HTTP status code for which to get the reason phrase.
+ * @returns The reason phrase associated with the given status code, or "Unknown Status Code" if the status code is not recognized.
+ */
+export const getHttpStatusCodeReasonPhrase = (statusCode) => {
+    const phrases = {
+        200: 'OK',
+        201: 'Created',
+        202: 'Accepted',
+        204: 'No Content',
+        205: 'Reset Content',
+        206: 'Partial Content',
+        226: 'IM Used',
+        301: 'Moved Permanently',
+        302: 'Found',
+        304: 'Not Modified',
+        400: 'Bad Request',
+        401: 'Unauthorized',
+        403: 'Forbidden',
+        404: 'Not Found',
+        405: 'Method Not Allowed',
+        407: 'Proxy Authentication Required',
+        408: 'Request Timeout',
+        409: 'Conflict',
+        410: 'Gone',
+        412: 'Precondition Failed',
+        413: 'Payload Too Large',
+        414: 'URI Too Long',
+        415: 'Unsupported Media Type',
+        416: 'Range Not Satisfiable',
+        417: 'Expectation Failed',
+        418: "I'm a teapot",
+        422: 'Unprocessable Entity',
+        423: 'Locked',
+        424: 'Failed Dependency',
+        425: 'Too Early',
+        426: 'Upgrade Required',
+        428: 'Precondition Required',
+        429: 'Too Many Requests',
+        431: 'Request Header Fields Too Large',
+        444: 'Connection Closed Without Response',
+        451: 'Unavailable For Legal Reasons',
+        500: 'Internal Server Error',
+        501: 'Not Implemented',
+        502: 'Bad Gateway',
+        503: 'Service Unavailable',
+        504: 'Gateway Timeout',
+    };
+    return phrases[statusCode] || 'Unknown Status Code';
+};

package/dist/esm/index.d.ts

@@ -5,7 +5,7 @@ export * from './auth/auth.utils';
 export * from './auth/bearer-auth-strategy';
 export * from './config';
 export * from './error-handling';
-export * from './http.types';
+export * from './http-status-codes';
 export * from './rate-limit/in-memory-rate-limiter';
 export * from './rate-limit/rate-limit.types';
 export * from './route-table';

package/dist/esm/index.js

@@ -5,7 +5,7 @@ export * from './auth/auth.utils';
 export * from './auth/bearer-auth-strategy';
 export * from './config';
 export * from './error-handling';
-export * from './http.types';
+export * from './http-status-codes';
 export * from './rate-limit/in-memory-rate-limiter';
 export * from './rate-limit/rate-limit.types';
 export * from './route-table';

package/dist/esm/router.js

@@ -1,7 +1,7 @@
 import { assertTruthy, callValueAssertion, getMessageFromError, validateObject, } from '@fishka/assertions';
 import * as url from 'url';
-import { HttpError, URL_PARAMETER_INFO } from './api.types';
-import { BAD_REQUEST_STATUS, OK_STATUS } from './http.types';
+import { HttpError, URL_PARAMETER_INFO, assertHttp } from './api.types';
+import { HTTP_BAD_REQUEST, HTTP_OK } from './http-status-codes';
 import { catchRouteErrors } from './error-handling';
 import { getRequestLocalStorage } from './thread-local/thread-local-storage';
 import { wrapAsApiResponse } from './utils/conversion.utils';
@@ -61,7 +61,7 @@ function createRouteHandler(method, endpoint) {
         if (tls?.requestId) {
             response.requestId = tls.requestId;
         }
-        response.status = response.status || OK_STATUS;
+        response.status = response.status || HTTP_OK;
         res.status(response.status);
         res.send(response);
     };
@@ -77,12 +77,12 @@ function validateUrlParameters(req, { $path, $query, }) {
             // Run Global Validation if registered.
             const globalValidator = URL_PARAMETER_INFO[key]?.validator;
             if (globalValidator) {
-                callValueAssertion(value, globalValidator, `${BAD_REQUEST_STATUS}`);
+                callValueAssertion(value, globalValidator, `${HTTP_BAD_REQUEST}`);
             }
             // Run Local Validation.
             const validator = $path?.[key];
             if (validator) {
-                callValueAssertion(value, validator, `${BAD_REQUEST_STATUS}`);
+                callValueAssertion(value, validator, `${HTTP_BAD_REQUEST}`);
             }
         }
         const parsedUrl = url.parse(req.url, true);
@@ -94,16 +94,16 @@ function validateUrlParameters(req, { $path, $query, }) {
                 // Query params can be string | string[] | undefined. Global validators usually expect string.
                 // We only validate if it's a single value or handle array in validator.
                 // For simplicity, we pass value as is (unknown) to assertion.
-                callValueAssertion(value, globalValidator, `${BAD_REQUEST_STATUS}`);
+                callValueAssertion(value, globalValidator, `${HTTP_BAD_REQUEST}`);
             }
             const validator = $query?.[key];
             if (validator) {
-                callValueAssertion(value, validator, `${BAD_REQUEST_STATUS}`);
+                callValueAssertion(value, validator, `${HTTP_BAD_REQUEST}`);
             }
         }
     }
     catch (error) {
-        throw new HttpError(BAD_REQUEST_STATUS, getMessageFromError(error));
+        throw new HttpError(HTTP_BAD_REQUEST, getMessageFromError(error));
     }
 }
 /**
@@ -136,23 +136,23 @@ async function executeBodyEndpoint(route, req, res) {
         // Handle validation based on whether validator is an object or function
         if (typeof validator === 'function') {
             // It's a ValueAssertion (function)
-            callValueAssertion(apiRequest, validator, `${BAD_REQUEST_STATUS}: request body`);
+            callValueAssertion(apiRequest, validator, `${HTTP_BAD_REQUEST}: request body`);
         }
         else {
             // It's an ObjectAssertion - use validateObject
             // We strictly assume it is an object because of the type definition (function | object)
             const objectValidator = validator;
             const isEmptyValidator = Object.keys(objectValidator).length === 0;
-            const error = validateObject(apiRequest, objectValidator, `${BAD_REQUEST_STATUS}: request body`, {
+            const errorMessage = validateObject(apiRequest, objectValidator, `${HTTP_BAD_REQUEST}: request body`, {
                 failOnUnknownFields: !isEmptyValidator,
             });
-            assertTruthy(!error, error);
+            assertHttp(!errorMessage, HTTP_BAD_REQUEST, errorMessage || 'Request body validation failed');
         }
     }
     catch (error) {
         if (error instanceof HttpError)
             throw error;
-        throw new HttpError(BAD_REQUEST_STATUS, getMessageFromError(error));
+        throw new HttpError(HTTP_BAD_REQUEST, getMessageFromError(error));
     }
     const requestContext = newRequestContext(apiRequest, req, res);
     validateUrlParameters(req, { $path: route.$path, $query: route.$query });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fishka/express",
-  "version": "0.9.6",
+  "version": "0.9.7",
   "description": "Express.js extension with built-in validation, and type safety",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",

package/dist/cjs/http.types.d.ts

@@ -1,35 +0,0 @@
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export declare const INTERNAL_ERROR_STATUS = 500;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export declare const BAD_REQUEST_STATUS = 400;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export declare const UNAUTHORIZED_STATUS = 401;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export declare const FORBIDDEN_STATUS = 403;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export declare const NOT_FOUND_STATUS = 404;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export declare const OK_STATUS = 200;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export declare const TOO_MANY_REQUESTS_STATUS = 429;

package/dist/cjs/http.types.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TOO_MANY_REQUESTS_STATUS = exports.OK_STATUS = exports.NOT_FOUND_STATUS = exports.FORBIDDEN_STATUS = exports.UNAUTHORIZED_STATUS = exports.BAD_REQUEST_STATUS = exports.INTERNAL_ERROR_STATUS = void 0;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-exports.INTERNAL_ERROR_STATUS = 500;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-exports.BAD_REQUEST_STATUS = 400;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-exports.UNAUTHORIZED_STATUS = 401;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-exports.FORBIDDEN_STATUS = 403;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-exports.NOT_FOUND_STATUS = 404;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-exports.OK_STATUS = 200;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-exports.TOO_MANY_REQUESTS_STATUS = 429;

package/dist/esm/http.types.d.ts

@@ -1,35 +0,0 @@
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export declare const INTERNAL_ERROR_STATUS = 500;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export declare const BAD_REQUEST_STATUS = 400;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export declare const UNAUTHORIZED_STATUS = 401;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export declare const FORBIDDEN_STATUS = 403;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export declare const NOT_FOUND_STATUS = 404;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export declare const OK_STATUS = 200;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export declare const TOO_MANY_REQUESTS_STATUS = 429;

package/dist/esm/http.types.js

@@ -1,35 +0,0 @@
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export const INTERNAL_ERROR_STATUS = 500;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export const BAD_REQUEST_STATUS = 400;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export const UNAUTHORIZED_STATUS = 401;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export const FORBIDDEN_STATUS = 403;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export const NOT_FOUND_STATUS = 404;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export const OK_STATUS = 200;
-/**
- * Common HTTP status codes as numbers.
- * @Internal
- */
-export const TOO_MANY_REQUESTS_STATUS = 429;