@xylabs/express 5.0.80 → 5.0.82

package/README.md

@@ -29,6 +29,7 @@ SDK for base code for Api repos that use express and deploy on AWS ECS
 
 ## Interfaces
 
+- [RouteDefinition](#interfaces/RouteDefinition)
 - [Empty](#interfaces/Empty)
 - [LoggerOptions](#interfaces/LoggerOptions)
 - [ExpressError](#interfaces/ExpressError)
@@ -48,6 +49,7 @@ SDK for base code for Api repos that use express and deploy on AWS ECS
 
 ## Type Aliases
 
+- [HttpMethod](#type-aliases/HttpMethod)
 - [NoReqParams](#type-aliases/NoReqParams)
 - [NoResBody](#type-aliases/NoResBody)
 - [NoReqBody](#type-aliases/NoReqBody)
@@ -68,6 +70,9 @@ SDK for base code for Api repos that use express and deploy on AWS ECS
 ## Variables
 
 - [notImplemented](#variables/notImplemented)
+- [EmptyParamsZod](#variables/EmptyParamsZod)
+- [EmptyQueryParamsZod](#variables/EmptyQueryParamsZod)
+- [ValidateRequestDefaults](#variables/ValidateRequestDefaults)
 - [DefaultJsonBodyParserOptionsLimit](#variables/DefaultJsonBodyParserOptionsLimit)
 - [DefaultJsonBodyParserOptionsTypes](#variables/DefaultJsonBodyParserOptionsTypes)
 - [DefaultJsonBodyParserOptions](#variables/DefaultJsonBodyParserOptions)
@@ -76,15 +81,15 @@ SDK for base code for Api repos that use express and deploy on AWS ECS
 
 ## Functions
 
+- [addRouteDefinitions](#functions/addRouteDefinitions)
 - [asyncHandler](#functions/asyncHandler)
 - [errorToJsonHandler](#functions/errorToJsonHandler)
 - [getHttpHeader](#functions/getHttpHeader)
 - [getDefaultLogger](#functions/getDefaultLogger)
 - [getLogger](#functions/getLogger)
 - [compactObject](#functions/compactObject)
-- [tryParse](#functions/tryParse)
-- [tryParseFloat](#functions/tryParseFloat)
-- [tryParseInt](#functions/tryParseInt)
+- [~~tryParse~~](#functions/tryParse)
+- [requestHandlerValidator](#functions/requestHandlerValidator)
 - [enableCaseSensitiveRouting](#functions/enableCaseSensitiveRouting)
 - [disableCaseSensitiveRouting](#functions/disableCaseSensitiveRouting)
 - [enableExpressDefaultPoweredByHeader](#functions/enableExpressDefaultPoweredByHeader)
@@ -133,7 +138,7 @@ static counters: Record<string, number> = {};
 ### inc()
 
 ```ts
-static inc(name, count): void;
+static inc(name, count?): void;
 ```
 
 ### Parameters
@@ -142,7 +147,7 @@ static inc(name, count): void;
 
 `string`
 
-#### count
+#### count?
 
 `number` = `1`
 
@@ -373,6 +378,30 @@ Logger.warn
 
 ### functions
 
+  ### <a id="addRouteDefinitions"></a>addRouteDefinitions
+
+[**@xylabs/express**](#../README)
+
+***
+
+```ts
+function addRouteDefinitions(app, routeDefinitions): void;
+```
+
+## Parameters
+
+### app
+
+`Express`
+
+### routeDefinitions
+
+[`RouteDefinition`](#../interfaces/RouteDefinition)\<`RequestHandler`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>\>[]
+
+## Returns
+
+`void`
+
   ### <a id="asyncHandler"></a>asyncHandler
 
 [**@xylabs/express**](#../README)
@@ -380,7 +409,7 @@ Logger.warn
 ***
 
 ```ts
-function asyncHandler<P, ResBody, ReqBody, ReqQuery, Locals>(fn): (req, res, next) => Promise<void>;
+function asyncHandler<P, ResBody, ReqBody, ReqQuery, Locals>(fn): (req, res, next) => Promise<unknown>;
 ```
 
 ## Type Parameters
@@ -417,7 +446,7 @@ function asyncHandler<P, ResBody, ReqBody, ReqQuery, Locals>(fn): (req, res, nex
 (
    req, 
    res, 
-next): Promise<void>;
+next): Promise<unknown>;
 ```
 
 ### Parameters
@@ -436,7 +465,7 @@ next): Promise<void>;
 
 ### Returns
 
-`Promise`\<`void`\>
+`Promise`\<`unknown`\>
 
   ### <a id="clearRawResponseFormat"></a>clearRawResponseFormat
 
@@ -677,7 +706,7 @@ function getDefaultLogger(): Logger;
 ***
 
 ```ts
-function getHttpHeader(header, req): undefined | string;
+function getHttpHeader(header, req): string | undefined;
 ```
 
 Since there can be multiple of certain HTTP headers or
@@ -701,7 +730,7 @@ The received HTTP request (with headers)
 
 ## Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 The first or only occurrence of the specified HTTP header
 
@@ -712,14 +741,14 @@ The first or only occurrence of the specified HTTP header
 ***
 
 ```ts
-function getJsonBodyParser(options): NextHandleFunction;
+function getJsonBodyParser(options?): NextHandleFunction;
 ```
 
 Get a JSON Body Parser connect middleware handler
 
 ## Parameters
 
-### options
+### options?
 
 `OptionsJson` = `DefaultJsonBodyParserOptions`
 
@@ -766,12 +795,12 @@ precedence over the default
 ***
 
 ```ts
-function getLogger(minVerbosity): Logger;
+function getLogger(minVerbosity?): Logger;
 ```
 
 ## Parameters
 
-### minVerbosity
+### minVerbosity?
 
 [`LoggerVerbosity`](#../type-aliases/LoggerVerbosity) = `'info'`
 
@@ -825,6 +854,75 @@ body to the client
 
 True if there are any flags on the response, false otherwise
 
+  ### <a id="requestHandlerValidator"></a>requestHandlerValidator
+
+[**@xylabs/express**](#../README)
+
+***
+
+```ts
+function requestHandlerValidator<TParams, TQuery, TBody, TResponse>(schemas?): (handler) => RequestHandler;
+```
+
+Factory for Express middleware that validates request and response objects using Zod schemas.
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* 
+  \| `ZodObject`\<\{
+\}, `$catchall`\<`ZodUnion`\<readonly \[`ZodString`, `ZodArray`\<`ZodString`\>\]\>\>\>
+  \| `ZodType`\<`Record`\<`string`, `string`\>, `unknown`, `$ZodTypeInternals`\<`Record`\<`string`, `string`\>, `unknown`\>\> = `ZodObject`\<\{
+\}, `$catchall`\<`ZodUnion`\<readonly \[`ZodString`, `ZodArray`\<`ZodString`\>\]\>\>\>
+
+### TQuery
+
+`TQuery` *extends* 
+  \| `ZodObject`\<\{
+\}, `$catchall`\<`ZodUnion`\<readonly \[`ZodString`, `ZodArray`\<`ZodString`\>\]\>\>\>
+  \| `ZodType`\<`Record`\<`string`, `string` \| `string`[]\>, `unknown`, `$ZodTypeInternals`\<`Record`\<`string`, `string` \| `string`[]\>, `unknown`\>\> = `ZodObject`\<\{
+\}, `$catchall`\<`ZodUnion`\<readonly \[`ZodString`, `ZodArray`\<`ZodString`\>\]\>\>\>
+
+### TBody
+
+`TBody` *extends* `ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> = `ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>
+
+### TResponse
+
+`TResponse` *extends* `ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> = `ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>
+
+## Parameters
+
+### schemas?
+
+`Partial`\<\{
+  `body`: `TBody`;
+  `params`: `TParams`;
+  `query`: `TQuery`;
+  `response`: `TResponse`;
+\}\>
+
+The Zod schemas to use for validation.
+
+## Returns
+
+A middleware function for validating requests and responses.
+
+```ts
+(handler): RequestHandler;
+```
+
+### Parameters
+
+### handler
+
+(`req`, `res`, `next`) => `unknown`
+
+### Returns
+
+`RequestHandler`
+
   ### <a id="responseProfiler"></a>responseProfiler
 
 [**@xylabs/express**](#../README)
@@ -917,7 +1015,7 @@ function standardErrors(
 
 ### err
 
-`undefined` | [`ExpressError`](#../interfaces/ExpressError)
+[`ExpressError`](#../interfaces/ExpressError) | `undefined`
 
 ### req
 
@@ -942,7 +1040,7 @@ function standardErrors(
 ***
 
 ```ts
-function tryParse<T>(func, value?): undefined | T & object;
+function tryParse<T>(func, value?): T & object | undefined;
 ```
 
 ## Type Parameters
@@ -963,47 +1061,11 @@ function tryParse<T>(func, value?): undefined | T & object;
 
 ## Returns
 
-`undefined` \| `T` & `object`
-
-  ### <a id="tryParseFloat"></a>tryParseFloat
-
-[**@xylabs/express**](#../README)
-
-***
-
-```ts
-function tryParseFloat(value?): undefined | number;
-```
-
-## Parameters
-
-### value?
-
-`string`
-
-## Returns
-
-`undefined` \| `number`
-
-  ### <a id="tryParseInt"></a>tryParseInt
-
-[**@xylabs/express**](#../README)
-
-***
-
-```ts
-function tryParseInt(value?): undefined | number;
-```
-
-## Parameters
+`T` & `object` \| `undefined`
 
-### value?
-
-`string`
-
-## Returns
+## Deprecated
 
-`undefined` \| `number`
+use zod instead
 
   ### <a id="useRequestCounters"></a>useRequestCounters
 
@@ -1539,6 +1601,42 @@ optional defaultMeta: LoggerMeta;
 
 ```ts
 optional level: LoggerVerbosity;
+```
+
+  ### <a id="RouteDefinition"></a>RouteDefinition
+
+[**@xylabs/express**](#../README)
+
+***
+
+## Type Parameters
+
+### H
+
+`H` *extends* `RequestHandler` = `RequestHandler`
+
+## Properties
+
+### handlers
+
+```ts
+handlers: H | H[];
+```
+
+***
+
+### method
+
+```ts
+method: HttpMethod;
+```
+
+***
+
+### path
+
+```ts
+path: string | RegExp;
 ```
 
   ### <a id="Source"></a>Source
@@ -1610,6 +1708,16 @@ type ApiResponse<T> =
 
 `T` *extends* [`ApiResourceIdentifierObject`](#../interfaces/ApiResourceIdentifierObject)
 
+  ### <a id="HttpMethod"></a>HttpMethod
+
+[**@xylabs/express**](#../README)
+
+***
+
+```ts
+type HttpMethod = "get" | "post" | "put" | "patch" | "delete" | "options" | "head";
+```
+
   ### <a id="LogFunction"></a>LogFunction
 
 [**@xylabs/express**](#../README)
@@ -1820,6 +1928,72 @@ const DefaultJsonBodyParserOptionsTypes: string[];
 
 The default MIME types for the JSON Body Parser
 
+  ### <a id="EmptyParamsZod"></a>EmptyParamsZod
+
+[**@xylabs/express**](#../README)
+
+***
+
+```ts
+const EmptyParamsZod: ZodObject<{
+}, $catchall<ZodString>>;
+```
+
+Empty Zod schema for requests with no parameters.
+
+  ### <a id="EmptyQueryParamsZod"></a>EmptyQueryParamsZod
+
+[**@xylabs/express**](#../README)
+
+***
+
+```ts
+const EmptyQueryParamsZod: ZodObject<{
+}, $catchall<ZodUnion<readonly [ZodString, ZodArray<ZodString>]>>>;
+```
+
+Empty Zod schema for requests with no query parameters.
+
+  ### <a id="ValidateRequestDefaults"></a>ValidateRequestDefaults
+
+[**@xylabs/express**](#../README)
+
+***
+
+```ts
+const ValidateRequestDefaults: object;
+```
+
+Default validation schemas for request handler validator.
+
+## Type Declaration
+
+### params
+
+```ts
+params: ZodObject<{
+}, $catchall<ZodString>> = EmptyParamsZod;
+```
+
+### query
+
+```ts
+query: ZodObject<{
+}, $catchall<ZodUnion<readonly [ZodString, ZodArray<ZodString>]>>> = EmptyQueryParamsZod;
+```
+
+### body
+
+```ts
+body: ZodOptional<ZodJSONSchema>;
+```
+
+### response
+
+```ts
+response: ZodOptional<ZodJSONSchema>;
+```
+
   ### <a id="jsonBodyParser"></a>jsonBodyParser
 
 [**@xylabs/express**](#../README)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/express",
-  "version": "5.0.80",
+  "version": "5.0.82",
   "description": "SDK for base code for Api repos that use express and deploy on AWS ECS",
   "keywords": [
     "xylabs",
@@ -32,7 +32,6 @@
     ".": {
       "node": {
         "types": "./dist/node/index.d.ts",
-        "source": "./src/index.ts",
         "default": "./dist/node/index.mjs"
       }
     },
@@ -40,11 +39,9 @@
     "./README.md": "./README.md"
   },
   "module": "./dist/node/index.mjs",
-  "source": "./src/index.ts",
   "types": "./dist/node/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*"
@@ -55,13 +52,14 @@
   "dependencies": {
     "@types/connect": "~3.4.38",
     "@types/express-serve-static-core": "~5.1.1",
-    "@xylabs/assert": "~5.0.80",
-    "@xylabs/logger": "~5.0.80",
-    "@xylabs/typeof": "~5.0.80",
+    "@xylabs/assert": "~5.0.82",
+    "@xylabs/logger": "~5.0.82",
+    "@xylabs/typeof": "~5.0.82",
+    "@xylabs/vitest-extended": "~5.0.82",
     "body-parser": "~2.2.2",
     "express-mung": "~0.5.1",
     "http-status-codes": "~2.3.0",
-    "rollbar": "~2.26.5",
+    "rollbar": "~3.0.0",
     "winston": "~3.19.0",
     "winston-transport": "~4.9.0"
   },
@@ -69,16 +67,14 @@
     "@types/body-parser": "~1.19.6",
     "@types/express": "~5.0.6",
     "@types/express-mung": "~0.5.5",
-    "@types/node": "~25.2.3",
-    "@xylabs/ts-scripts-yarn3": "~7.3.2",
-    "@xylabs/tsconfig": "~7.3.2",
-    "@xylabs/vitest-extended": "~5.0.80",
+    "@types/node": "~25.4.0",
+    "@xylabs/ts-scripts-yarn3": "~7.4.11",
+    "@xylabs/tsconfig": "~7.4.11",
     "body-parser": "~2.2.2",
     "express": "~5.2.1",
     "express-mung": "~0.5.1",
     "http-status-codes": "~2.3.0",
-    "node-cache": "~5.1.2",
-    "rollbar": "~2.26.5",
+    "rollbar": "~3.0.0",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18",
     "vitest-mock-extended": "~3.1.0",

package/src/Handler/RouteDefinition/RouteDefinition.ts

@@ -1,18 +0,0 @@
-import type { RequestHandler } from 'express'
-
-export type HttpMethod
-  = | 'get'
-    | 'post'
-    | 'put'
-    | 'patch'
-    | 'delete'
-    | 'options'
-    | 'head'
-
-export interface RouteDefinition<
-  H extends RequestHandler = RequestHandler,
-> {
-  handlers: H[] | H
-  method: HttpMethod
-  path: string | RegExp
-}

package/src/Handler/RouteDefinition/addRouteDefinitions.ts

@@ -1,9 +0,0 @@
-import type { Express } from 'express'
-
-import type { RouteDefinition } from './RouteDefinition.ts'
-
-export const addRouteDefinitions = (app: Express, routeDefinitions: RouteDefinition[]) => {
-  for (const definition of routeDefinitions) {
-    app[definition.method](definition.path, definition.handlers)
-  }
-}

package/src/Handler/RouteDefinition/index.ts

@@ -1,2 +0,0 @@
-export * from './addRouteDefinitions.ts'
-export * from './RouteDefinition.ts'

package/src/Handler/StatusCodeHandlers/index.ts

@@ -1 +0,0 @@
-export * from './notImplemented.ts'

package/src/Handler/StatusCodeHandlers/notImplemented.ts

@@ -1,6 +0,0 @@
-import type { RequestHandler } from 'express'
-import { ReasonPhrases, StatusCodes } from 'http-status-codes'
-
-export const notImplemented: RequestHandler = (_req, _res, next) => {
-  next({ message: ReasonPhrases.NOT_IMPLEMENTED, statusCode: StatusCodes.NOT_IMPLEMENTED })
-}

package/src/Handler/asyncHandler.ts

@@ -1,21 +0,0 @@
-import type {
-  NextFunction, Request, RequestHandler, Response,
-} from 'express'
-import type { ParamsDictionary, Query } from 'express-serve-static-core'
-
-export function asyncHandler<P = NoReqParams, ResBody = NoResBody, ReqBody = NoReqBody, ReqQuery = NoReqQuery, Locals extends NoLocals = NoLocals>(
-  fn: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals>,
-) {
-  return (req: Request<P, ResBody, ReqBody, ReqQuery, Locals>, res: Response<ResBody, Locals>, next: NextFunction) => {
-    return Promise.resolve(fn(req, res, next)).catch(next)
-  }
-}
-
-export interface Empty {}
-
-export type NoReqParams = ParamsDictionary
-export type NoResBody = Empty
-export type NoReqBody = Empty
-export type NoReqQuery = Query
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type NoLocals = Record<string, any>

package/src/Handler/errorToJsonHandler.ts

@@ -1,16 +0,0 @@
-import { isError, isNumber } from '@xylabs/typeof'
-import type {
-  NextFunction, Request, Response,
-} from 'express'
-
-import { getDefaultLogger } from '../Logger/index.ts'
-import type { ExpressError } from '../Model/index.ts'
-
-export const errorToJsonHandler = (error: ExpressError, req: Request, res: Response, next: NextFunction) => {
-  if (isError(error)) {
-    getDefaultLogger().error(error.message)
-    if (!isNumber(error.statusCode)) error.statusCode = 500
-    res.status(error.statusCode).send({ error: error.message })
-  }
-  next(error)
-}

package/src/Handler/index.ts

@@ -1,4 +0,0 @@
-export * from './asyncHandler.ts'
-export * from './errorToJsonHandler.ts'
-export * from './RouteDefinition/index.ts'
-export * from './StatusCodeHandlers/index.ts'

package/src/HttpUtil/getHttpHeader.ts

@@ -1,27 +0,0 @@
-import { isDefined } from '@xylabs/typeof'
-import type { Request } from 'express-serve-static-core'
-
-/**
- * Since there can be multiple of certain HTTP headers or
- * to prevent ugliness if someone did send us multiple
- * instances of a header we only expect one of, this
- * method grabs the 1st/only one of the desired header
- * @param header The header to find
- * @param req The received HTTP request (with headers)
- * @returns The first or only occurrence of the specified HTTP header
- */
-export const getHttpHeader = (header: string, req: Request): string | undefined => {
-  const headerValue = req.headers[header]
-  const value
-    // If the header exists
-    = isDefined(headerValue)
-      // If there's multiple of the same header
-      ? Array.isArray(headerValue)
-        // Grab the first one
-        ? (headerValue as string[]).shift()
-        // Otherwise grab the only one
-        : (headerValue as string)
-      // Otherwise undefined
-      : undefined
-  return value
-}

package/src/HttpUtil/index.ts

@@ -1 +0,0 @@
-export * from './getHttpHeader.ts'

package/src/Logger/LogFormats/LocalDev/index.ts

@@ -1 +0,0 @@
-export * from './logFormatLocalDev.ts'

package/src/Logger/LogFormats/LocalDev/logFormatLocalDev.ts

@@ -1,11 +0,0 @@
-import { format } from 'winston'
-
-const {
-  colorize, combine, timestamp, printf,
-} = format
-
-export const logFormatLocalDev = combine(
-  colorize(),
-  timestamp(),
-  printf(info => `[${info.timestamp} ${info.level}] ${info.message}`),
-)

package/src/Logger/LogFormats/Rollbar/index.ts

@@ -1 +0,0 @@
-export * from './logFormatRollbar.ts'

package/src/Logger/LogFormats/Rollbar/logFormatRollbar.ts

@@ -1,5 +0,0 @@
-import { format } from 'winston'
-
-const { simple } = format
-
-export const logFormatRollbar = simple()

package/src/Logger/LogFormats/Structured/index.ts

@@ -1 +0,0 @@
-export * from './logFormatStructured.ts'

package/src/Logger/LogFormats/Structured/logFormatStructured.ts

@@ -1,7 +0,0 @@
-import { format } from 'winston'
-
-const {
-  combine, timestamp, json,
-} = format
-
-export const logFormatStructured = combine(timestamp(), json())

package/src/Logger/LogFormats/index.ts

@@ -1,3 +0,0 @@
-export * from './LocalDev/index.ts'
-export * from './Rollbar/index.ts'
-export * from './Structured/index.ts'

package/src/Logger/LoggerMeta.ts

@@ -1 +0,0 @@
-export type LoggerMeta = Record<string, string | number>

package/src/Logger/LoggerOptions.ts

@@ -1,7 +0,0 @@
-import type { LoggerMeta } from './LoggerMeta.ts'
-import type { LoggerVerbosity } from './LoggerVerbosity.ts'
-
-export interface LoggerOptions {
-  defaultMeta?: LoggerMeta
-  level?: LoggerVerbosity
-}

package/src/Logger/LoggerVerbosity.ts

@@ -1 +0,0 @@
-export type LoggerVerbosity = 'error' | 'warn' | 'info' | 'debug' | 'all'