@fishka/express 0.9.8 → 0.9.9

package/README.md

@@ -33,7 +33,7 @@ routes.get<Array<{ id: string; name: string }>>('users', async () => [
 
 // POST /users
 routes.post<{ name: string }, { id: string }>('users', {
-  $body: { name: v => assertString(v, '400: name required') },
+  $body: { name: v => assertString(v, 'name required') },
   run: async ctx => ({ id: '1' }),
 });
 
@@ -51,14 +51,14 @@ Global validation can be enforced for specific URL parameters (e.g., `:id`, `:or
 
 ```typescript
 import { registerUrlParameter } from '@fishka/express';
-import { assertString } from '@fishka/assertions';
+import { assertString, assertTruthy } from '@fishka/assertions';
 
 // Register parameters with optional validation
 registerUrlParameter('orgId', {
-  validator: (val) => {
+  validator: val => {
     assertString(val);
-    if (!val.startsWith('org-')) throw new Error('400: Invalid Organization ID');
-  }
+    assertTruthy(val.startsWith('org-'), 'Invalid Organization ID');
+  },
 });
 
 // Now /orgs/:orgId will automatically validate that orgId starts with 'org-'
@@ -95,19 +95,27 @@ app.use(
 );
 ```
 
+## HTTP Status Code in Validation
+
+For cases where you need specific HTTP status codes (like 401 for authentication, 404 for not found), use `assertHttp`:
+
+```typescript
+import { assertHttp, HTTP_UNAUTHORIZED, HTTP_NOT_FOUND } from '@fishka/express';
+
+// In a validator or route handler
+assertHttp(req.headers.authorization, HTTP_UNAUTHORIZED, 'Authorization required');
+assertHttp(user, HTTP_NOT_FOUND, 'User not found');
+assertHttp(user.isAdmin, HTTP_FORBIDDEN, 'Admin access required');
+```
+
 ## Complete Example
 
 Here is a full initialization including TLS context, global validation, and proper error handling.
 
 ```typescript
 import express from 'express';
-import { 
-  createRouteTable, 
-  createTlsMiddleware, 
-  catchAllMiddleware,
-  registerUrlParameter 
-} from '@fishka/express';
-import { assertString } from '@fishka/assertions';
+import { createRouteTable, createTlsMiddleware, catchAllMiddleware, registerUrlParameter } from '@fishka/express';
+import { assertString, assertTruthy } from '@fishka/assertions';
 
 const app = express();
 
@@ -119,7 +127,7 @@ app.use(createTlsMiddleware());
 
 // 3. Register global URL parameters
 registerUrlParameter('id', {
-  validator: (val) => assertString(val)
+  validator: val => assertString(val),
 });
 
 // 4. Define routes

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

@@ -6,10 +6,10 @@ export declare class HttpError extends Error {
     constructor(status: number, message: string, details?: Record<string, unknown> | undefined);
 }
 /**
- * Asserts that a condition is true, throwing an HttpError with the specified status code if false.
+ * Asserts that the value is truthy, throwing an HttpError with the specified status code if false.
  * This function is designed for HTTP-specific validation where you want to throw appropriate HTTP status codes.
  *
- * @param condition - The condition to check. If false, an HttpError will be thrown.
+ * @param value - The condition to check. If falsy, an HttpError will be thrown.
  * @param status - The HTTP status code to use in the HttpError (e.g., 400 for Bad Request, 404 for Not Found).
  * @param message - The error message to include in the HttpError.
  *
@@ -21,7 +21,7 @@ export declare class HttpError extends Error {
  * assertHttp(typeof userId === 'string', HTTP_BAD_REQUEST, 'User ID must be a string');
  *
  * // Validate resource existence
- * assertHttp(user !== null, HTTP_NOT_FOUND, 'User not found');
+ * assertHttp(user, HTTP_NOT_FOUND, 'User not found');
  *
  * // Validate authorization
  * assertHttp(user.isAdmin, HTTP_FORBIDDEN, 'Admin access required');
@@ -36,7 +36,7 @@ export declare class HttpError extends Error {
  * @see {@link HTTP_FORBIDDEN}
  * @see {@link HTTP_UNAUTHORIZED}
  */
-export declare function assertHttp(condition: boolean, status: number, message: string): asserts condition;
+export declare function assertHttp(value: unknown, status: number, message: string): asserts value;
 export interface ApiResponse<ResponseEntity = unknown> {
     /** Result of the call. A single entity for non-paginated ${by-id} requests or an array for list queries. */
     result: ResponseEntity;

package/dist/cjs/api.types.js

@@ -18,10 +18,10 @@ class HttpError extends Error {
 }
 exports.HttpError = HttpError;
 /**
- * Asserts that a condition is true, throwing an HttpError with the specified status code if false.
+ * Asserts that the value is truthy, throwing an HttpError with the specified status code if false.
  * This function is designed for HTTP-specific validation where you want to throw appropriate HTTP status codes.
  *
- * @param condition - The condition to check. If false, an HttpError will be thrown.
+ * @param value - The condition to check. If falsy, an HttpError will be thrown.
  * @param status - The HTTP status code to use in the HttpError (e.g., 400 for Bad Request, 404 for Not Found).
  * @param message - The error message to include in the HttpError.
  *
@@ -33,7 +33,7 @@ exports.HttpError = HttpError;
  * assertHttp(typeof userId === 'string', HTTP_BAD_REQUEST, 'User ID must be a string');
  *
  * // Validate resource existence
- * assertHttp(user !== null, HTTP_NOT_FOUND, 'User not found');
+ * assertHttp(user, HTTP_NOT_FOUND, 'User not found');
  *
  * // Validate authorization
  * assertHttp(user.isAdmin, HTTP_FORBIDDEN, 'Admin access required');
@@ -48,8 +48,8 @@ exports.HttpError = HttpError;
  * @see {@link HTTP_FORBIDDEN}
  * @see {@link HTTP_UNAUTHORIZED}
  */
-function assertHttp(condition, status, message) {
-    (0, assertions_1.assertTruthy)(condition, () => new HttpError(status, message));
+function assertHttp(value, status, message) {
+    (0, assertions_1.assertTruthy)(value, () => new HttpError(status, message));
 }
 /** Converts an API response value into a standardized ApiResponse structure. */
 function response(result) {
@@ -69,6 +69,6 @@ function registerUrlParameter(name, info) {
  * @Internal
  */
 function assertUrlParameter(name) {
-    (0, assertions_1.assertString)(name, 'Url parameter name must be a string');
-    assertHttp(exports.URL_PARAMETER_INFO[name] !== undefined, http_status_codes_1.HTTP_BAD_REQUEST, `Invalid URL parameter: '${name}'. Please register it using 'registerUrlParameter('${name}', ...)'`);
+    assertHttp(typeof name === 'string', http_status_codes_1.HTTP_BAD_REQUEST, 'Url parameter name must be a string');
+    assertHttp(exports.URL_PARAMETER_INFO[name], http_status_codes_1.HTTP_BAD_REQUEST, `Invalid URL parameter: '${name}'. Please register it using 'registerUrlParameter('${name}', ...)'`);
 }

package/dist/cjs/route-table.d.ts

@@ -1,5 +1,5 @@
-import { ExpressApplication } from './utils/express.utils';
 import { DeleteEndpoint, GetEndpoint, PatchEndpoint, PostEndpoint, PutEndpoint, RequestContext, ResponseOrValue } from './router';
+import { ExpressApplication } from './utils/express.utils';
 /**
  * Helper utility for organizing and mounting routes.
  * Provides a fluent interface for registering multiple handlers.

package/dist/cjs/router.js

@@ -38,8 +38,8 @@ exports.mount = mount;
 const assertions_1 = require("@fishka/assertions");
 const url = __importStar(require("url"));
 const api_types_1 = require("./api.types");
-const http_status_codes_1 = require("./http-status-codes");
 const error_handling_1 = require("./error-handling");
+const http_status_codes_1 = require("./http-status-codes");
 const thread_local_storage_1 = require("./thread-local/thread-local-storage");
 const conversion_utils_1 = require("./utils/conversion.utils");
 // ============================================================================
@@ -228,7 +228,7 @@ function newRequestContext(requestBody, req, res) {
         params: {
             get: (key) => {
                 const value = req.params[key];
-                (0, assertions_1.assertTruthy)(value, `Path parameter '${key}' not found`);
+                (0, api_types_1.assertHttp)(value, http_status_codes_1.HTTP_BAD_REQUEST, `Path parameter '${key}' not found`);
                 return value;
             },
             tryGet: (key) => req.params[key],

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

@@ -6,10 +6,10 @@ export declare class HttpError extends Error {
     constructor(status: number, message: string, details?: Record<string, unknown> | undefined);
 }
 /**
- * Asserts that a condition is true, throwing an HttpError with the specified status code if false.
+ * Asserts that the value is truthy, throwing an HttpError with the specified status code if false.
  * This function is designed for HTTP-specific validation where you want to throw appropriate HTTP status codes.
  *
- * @param condition - The condition to check. If false, an HttpError will be thrown.
+ * @param value - The condition to check. If falsy, an HttpError will be thrown.
  * @param status - The HTTP status code to use in the HttpError (e.g., 400 for Bad Request, 404 for Not Found).
  * @param message - The error message to include in the HttpError.
  *
@@ -21,7 +21,7 @@ export declare class HttpError extends Error {
  * assertHttp(typeof userId === 'string', HTTP_BAD_REQUEST, 'User ID must be a string');
  *
  * // Validate resource existence
- * assertHttp(user !== null, HTTP_NOT_FOUND, 'User not found');
+ * assertHttp(user, HTTP_NOT_FOUND, 'User not found');
  *
  * // Validate authorization
  * assertHttp(user.isAdmin, HTTP_FORBIDDEN, 'Admin access required');
@@ -36,7 +36,7 @@ export declare class HttpError extends Error {
  * @see {@link HTTP_FORBIDDEN}
  * @see {@link HTTP_UNAUTHORIZED}
  */
-export declare function assertHttp(condition: boolean, status: number, message: string): asserts condition;
+export declare function assertHttp(value: unknown, status: number, message: string): asserts value;
 export interface ApiResponse<ResponseEntity = unknown> {
     /** Result of the call. A single entity for non-paginated ${by-id} requests or an array for list queries. */
     result: ResponseEntity;

package/dist/esm/api.types.js

@@ -1,4 +1,4 @@
-import { assertString, assertTruthy } from '@fishka/assertions';
+import { assertTruthy } from '@fishka/assertions';
 import { HTTP_BAD_REQUEST } from './http-status-codes';
 export class HttpError extends Error {
     constructor(status, message, details) {
@@ -10,10 +10,10 @@ export class HttpError extends Error {
     }
 }
 /**
- * Asserts that a condition is true, throwing an HttpError with the specified status code if false.
+ * Asserts that the value is truthy, throwing an HttpError with the specified status code if false.
  * This function is designed for HTTP-specific validation where you want to throw appropriate HTTP status codes.
  *
- * @param condition - The condition to check. If false, an HttpError will be thrown.
+ * @param value - The condition to check. If falsy, an HttpError will be thrown.
  * @param status - The HTTP status code to use in the HttpError (e.g., 400 for Bad Request, 404 for Not Found).
  * @param message - The error message to include in the HttpError.
  *
@@ -25,7 +25,7 @@ export class HttpError extends Error {
  * assertHttp(typeof userId === 'string', HTTP_BAD_REQUEST, 'User ID must be a string');
  *
  * // Validate resource existence
- * assertHttp(user !== null, HTTP_NOT_FOUND, 'User not found');
+ * assertHttp(user, HTTP_NOT_FOUND, 'User not found');
  *
  * // Validate authorization
  * assertHttp(user.isAdmin, HTTP_FORBIDDEN, 'Admin access required');
@@ -40,8 +40,8 @@ export class HttpError extends Error {
  * @see {@link HTTP_FORBIDDEN}
  * @see {@link HTTP_UNAUTHORIZED}
  */
-export function assertHttp(condition, status, message) {
-    assertTruthy(condition, () => new HttpError(status, message));
+export function assertHttp(value, status, message) {
+    assertTruthy(value, () => new HttpError(status, message));
 }
 /** Converts an API response value into a standardized ApiResponse structure. */
 export function response(result) {
@@ -61,6 +61,6 @@ export function registerUrlParameter(name, info) {
  * @Internal
  */
 export function assertUrlParameter(name) {
-    assertString(name, 'Url parameter name must be a string');
-    assertHttp(URL_PARAMETER_INFO[name] !== undefined, HTTP_BAD_REQUEST, `Invalid URL parameter: '${name}'. Please register it using 'registerUrlParameter('${name}', ...)'`);
+    assertHttp(typeof name === 'string', HTTP_BAD_REQUEST, 'Url parameter name must be a string');
+    assertHttp(URL_PARAMETER_INFO[name], HTTP_BAD_REQUEST, `Invalid URL parameter: '${name}'. Please register it using 'registerUrlParameter('${name}', ...)'`);
 }

package/dist/esm/route-table.d.ts

@@ -1,5 +1,5 @@
-import { ExpressApplication } from './utils/express.utils';
 import { DeleteEndpoint, GetEndpoint, PatchEndpoint, PostEndpoint, PutEndpoint, RequestContext, ResponseOrValue } from './router';
+import { ExpressApplication } from './utils/express.utils';
 /**
  * Helper utility for organizing and mounting routes.
  * Provides a fluent interface for registering multiple handlers.

package/dist/esm/router.js

@@ -1,8 +1,8 @@
-import { assertTruthy, callValueAssertion, getMessageFromError, validateObject, } from '@fishka/assertions';
+import { callValueAssertion, getMessageFromError, validateObject, } from '@fishka/assertions';
 import * as url from 'url';
-import { HttpError, URL_PARAMETER_INFO, assertHttp } from './api.types';
-import { HTTP_BAD_REQUEST, HTTP_OK } from './http-status-codes';
+import { assertHttp, HttpError, URL_PARAMETER_INFO } from './api.types';
 import { catchRouteErrors } from './error-handling';
+import { HTTP_BAD_REQUEST, HTTP_OK } from './http-status-codes';
 import { getRequestLocalStorage } from './thread-local/thread-local-storage';
 import { wrapAsApiResponse } from './utils/conversion.utils';
 // ============================================================================
@@ -186,7 +186,7 @@ function newRequestContext(requestBody, req, res) {
         params: {
             get: (key) => {
                 const value = req.params[key];
-                assertTruthy(value, `Path parameter '${key}' not found`);
+                assertHttp(value, HTTP_BAD_REQUEST, `Path parameter '${key}' not found`);
                 return value;
             },
             tryGet: (key) => req.params[key],

package/package.json

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