snap-on-openapi 1.0.20 → 1.0.22

package/dist/OpenApi.d.ts

@@ -24,6 +24,7 @@ import z from 'zod';
 import { OnResponseEvent } from './types/events/OnResponseEvent.js';
 import { RouteResponse } from './types/RouteResponse.js';
 import { ILogger } from './services/Logger/types/ILogger.js';
+import { RouteContext } from './types/config/RouteContext.js';
 export declare class OpenApi<TRouteTypes extends string, TErrorCodes extends string, TConfig extends AnyConfig<TRouteTypes, TErrorCodes>> {
     static readonly builder: InitialBuilder;
     readonly validators: ValidationUtils;
@@ -49,7 +50,7 @@ export declare class OpenApi<TRouteTypes extends string, TErrorCodes extends str
     addServer(url: string, description: string): void;
     protected getRouteForPath(path: string, method: string): AnyRoute<TRouteTypes> | null;
     processRootRoute(originalReq: Request): Promise<RouteResponse>;
-    protected handleError(e: unknown, req: Request, eventPieces?: Partial<OnResponseEvent<TRouteTypes, TConfig['routes'][TRouteTypes]['extraProps']>>): Promise<{
+    protected handleError(e: unknown, req: Request, eventPieces?: Partial<OnResponseEvent<TRouteTypes, TConfig['routes'][TRouteTypes]['extraProps'], RouteContext<TRouteTypes, TConfig>>>): Promise<{
         status: number;
         body: z.TypeOf<import("./index.js").OpenApiErrorConfigMap<TErrorCodes>[TErrorCodes]["responseValidator"]>;
         headers: {};

package/dist/OpenApi.js

@@ -133,8 +133,9 @@ export class OpenApi {
         let onResponse;
         let onHandler;
         try {
+            const logger = await this.config.requestLogger?.(originalReq) ?? this.logger;
             if (this.config.onRequest) {
-                onRequest = { request: originalReq, logger: this.logger };
+                onRequest = { request: originalReq, logger };
                 await this.config.onRequest(onRequest);
             }
             const url = new URL(originalReq.url);
@@ -142,7 +143,7 @@ export class OpenApi {
             const urlPath = url.pathname.replace(basePath, '');
             const route = this.getRouteForPath(urlPath, originalReq.method);
             if (!route) {
-                this.logger.info(`Route for ${originalReq.method}:${urlPath} not found`);
+                logger.info(`Route for ${originalReq.method}:${urlPath} not found`);
                 throw new BuiltInError(ErrorCode.NotFound);
             }
             const pathParams = {};
@@ -186,7 +187,7 @@ export class OpenApi {
             };
             onRoute = {
                 request: originalReq,
-                logger: this.logger,
+                logger,
                 path: urlPath,
                 method: originalReq.method,
                 params: pathParams,
@@ -219,7 +220,7 @@ export class OpenApi {
             const context = await this.config.routes[route.type].contextFactory({
                 route: route,
                 request: originalReq,
-                logger: this.logger,
+                logger,
                 params: {
                     query: query.data,
                     path: path.data,
@@ -228,6 +229,7 @@ export class OpenApi {
             });
             onHandler = {
                 ...onRoute,
+                context,
                 validated: {
                     query: query.data,
                     path: path.data,
@@ -246,10 +248,13 @@ export class OpenApi {
                 });
                 return response;
             };
+            if (this.config.onHandler) {
+                await this.config.onHandler(onHandler);
+            }
             const response = await wrapper(handler, {
                 route: route,
                 request: originalReq,
-                logger: this.logger,
+                logger,
                 params: {
                     query: query.data,
                     path: path.data,
@@ -293,8 +298,8 @@ export class OpenApi {
         try {
             const event = {
                 ...eventPieces,
+                logger: eventPieces?.logger ?? this.logger,
                 request: req,
-                logger: this.logger,
                 error: e,
             };
             const response = this.config.onError ? await this.config.onError(event) : this.config.defaultError;

package/dist/services/ConfigBuilder/types/DefaultConfig.d.ts

@@ -23,7 +23,7 @@ export declare class DefaultConfig implements Config<SampleRouteType, ErrorCode,
     onRequest?: () => Promise<void>;
     onRoute?: (e: OnRouteEvent<SampleRouteType, DefaultRouteParamsMap>) => Promise<void>;
     onHandler?: () => Promise<void>;
-    onResponse?: (e: OnResponseEvent<SampleRouteType, DefaultRouteParamsMap>) => Promise<void>;
-    onError?: (e: OnErrorEvent<SampleRouteType, DefaultRouteParamsMap>) => Promise<ErrorResponse<ErrorCode, DefaultErrorMap>>;
+    onResponse?: (e: OnResponseEvent<SampleRouteType, DefaultRouteParamsMap, object>) => Promise<void>;
+    onError?: (e: OnErrorEvent<SampleRouteType, DefaultRouteParamsMap, object>) => Promise<ErrorResponse<ErrorCode, DefaultErrorMap>>;
     skipDescriptionsCheck?: boolean;
 }

package/dist/services/TestUtils/utils/TestLogger.d.ts

@@ -6,5 +6,10 @@ export declare class TestLogger extends Logger {
         level: string;
         data?: object;
     } | undefined;
+    popMessage(): {
+        message: string;
+        level: string;
+        data?: object;
+    } | undefined;
     protected log(message: string, level: string, data?: object): void;
 }

package/dist/services/TestUtils/utils/TestLogger.js

@@ -4,6 +4,9 @@ export class TestLogger extends Logger {
     shiftMessage() {
         return this.messages.shift();
     }
+    popMessage() {
+        return this.messages.pop();
+    }
     log(message, level, data) {
         this.messages.push({ message, level, data });
     }

package/dist/types/config/Config.d.ts

@@ -16,6 +16,7 @@ import { ILogger } from '../../services/Logger/types/ILogger.js';
 export type Config<TRouteTypes extends string, TErrorCodes extends string, TErrorConfigMap extends ErrorConfigMap<TErrorCodes>, TRouteParamMap extends RouteExtraPropsMap<TRouteTypes>, TRouteContextMap extends RouteContextMap<TRouteTypes, TRouteParamMap>, TRouteConfigMap extends RouteConfigMap<TRouteTypes, TErrorCodes, TRouteParamMap, TRouteContextMap>> = {
     disableResponseValidation?: boolean;
     logger?: ILogger;
+    requestLogger?: (req: Request) => Promise<ILogger>;
     basePath: RoutePath;
     routes: TRouteConfigMap;
     generator?: {
@@ -34,7 +35,7 @@ export type Config<TRouteTypes extends string, TErrorCodes extends string, TErro
     logLevel?: LogLevel;
     onRequest?: (e: OnRequestEvent) => Promise<void>;
     onRoute?: (e: OnRouteEvent<TRouteTypes, TRouteParamMap>) => Promise<void>;
-    onHandler?: (e: OnHandlerEvent<TRouteTypes, TRouteParamMap>) => Promise<void>;
-    onResponse?: (e: OnResponseEvent<TRouteTypes, TRouteParamMap>) => Promise<void>;
-    onError?: (e: OnErrorEvent<TRouteTypes, TRouteParamMap>) => Promise<ErrorResponse<TErrorCodes, TErrorConfigMap>>;
+    onHandler?: (e: OnHandlerEvent<TRouteTypes, TRouteParamMap, Awaited<ReturnType<TRouteContextMap[TRouteTypes]>>>) => Promise<void>;
+    onResponse?: (e: OnResponseEvent<TRouteTypes, TRouteParamMap, Awaited<ReturnType<TRouteContextMap[TRouteTypes]>>>) => Promise<void>;
+    onError?: (e: OnErrorEvent<TRouteTypes, TRouteParamMap, Awaited<ReturnType<TRouteContextMap[TRouteTypes]>>>) => Promise<ErrorResponse<TErrorCodes, TErrorConfigMap>>;
 };

package/dist/types/config/RouteContext.d.ts

@@ -0,0 +1,2 @@
+import { AnyConfig } from './AnyConfig.js';
+export type RouteContext<TRouteType extends string, TConfig extends AnyConfig<TRouteType, string>> = Awaited<ReturnType<TConfig['routes'][TRouteType]['contextFactory']>>;

package/dist/types/config/RouteContext.js

@@ -0,0 +1 @@
+export {};

package/dist/types/events/OnErrorEvent.d.ts

@@ -1,7 +1,7 @@
 import { ILogger } from '../../services/Logger/types/ILogger.js';
 import { RouteExtraPropsMap } from '../config/RouteExtraPropsMap.js';
 import { OnResponseEvent } from './OnResponseEvent.js';
-export interface OnErrorEvent<TRouteType extends string, TContextMap extends RouteExtraPropsMap<TRouteType>> extends Partial<OnResponseEvent<TRouteType, TContextMap>> {
+export interface OnErrorEvent<TRouteType extends string, TContextMap extends RouteExtraPropsMap<TRouteType>, TContext extends object> extends Partial<OnResponseEvent<TRouteType, TContextMap, TContext>> {
     request: Request;
     logger: ILogger;
     error: unknown;

package/dist/types/events/OnHandlerEvent.d.ts

@@ -1,9 +1,10 @@
 import { RouteExtraPropsMap } from '../config/RouteExtraPropsMap.js';
 import { OnRouteEvent } from './OnRouteEvent.js';
-export interface OnHandlerEvent<TRouteType extends string, TContextMap extends RouteExtraPropsMap<TRouteType>> extends OnRouteEvent<TRouteType, TContextMap> {
+export interface OnHandlerEvent<TRouteType extends string, TContextMap extends RouteExtraPropsMap<TRouteType>, TContext extends object> extends OnRouteEvent<TRouteType, TContextMap> {
     validated: {
         query: Record<string, unknown>;
         path: Record<string, unknown>;
         body: unknown;
     };
+    context: TContext;
 }

package/dist/types/events/OnResponseEvent.d.ts

@@ -1,6 +1,6 @@
 import { RouteExtraPropsMap } from '../config/RouteExtraPropsMap.js';
 import { RouteResponse } from '../RouteResponse.js';
 import { OnHandlerEvent } from './OnHandlerEvent.js';
-export interface OnResponseEvent<TRouteType extends string, TContextMap extends RouteExtraPropsMap<TRouteType>> extends OnHandlerEvent<TRouteType, TContextMap> {
+export interface OnResponseEvent<TRouteType extends string, TContextMap extends RouteExtraPropsMap<TRouteType>, TContext extends object> extends OnHandlerEvent<TRouteType, TContextMap, TContext> {
     response: RouteResponse;
 }

package/dist/types/events/OnRouteEvent.d.ts

@@ -2,11 +2,11 @@ import { AnyRoute } from '../AnyRoute.js';
 import { RouteExtraProps } from '../config/RouteExtraProps.js';
 import { RouteExtraPropsMap } from '../config/RouteExtraPropsMap.js';
 import { OnRequestEvent } from './OnRequestEvent.js';
-export interface OnRouteEvent<TRouteType extends string, TContextMap extends RouteExtraPropsMap<TRouteType>> extends OnRequestEvent {
+export interface OnRouteEvent<TRouteType extends string, TExtraPropsMap extends RouteExtraPropsMap<TRouteType>> extends OnRequestEvent {
     path: string;
     method: string;
     params: Record<string, string>;
     query: Record<string, string | string[]>;
     body: unknown;
-    route: AnyRoute<TRouteType> & RouteExtraProps<TContextMap[TRouteType]>;
+    route: AnyRoute<TRouteType> & RouteExtraProps<TExtraPropsMap[TRouteType]>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "snap-on-openapi",
   "author": "Alex Sarychev",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "description": "Swiftly build type-checked OpenAPI applications with Zod and TypeScript",
   "type": "module",
   "license": "ISC",