snap-on-openapi 1.0.21 → 1.0.23

package/dist/OpenApi.d.ts

@@ -21,10 +21,10 @@ import { InitialBuilder } from './types/InitialBuilder.js';
 import { DefaultRouteContextMap } from './services/ConfigBuilder/types/DefaultRouteContextMap.js';
 import { DefaultRouteParamsMap } from './services/ConfigBuilder/types/DefaultRouteParamsMap.js';
 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';
+import { RouteContextMap } from './types/config/RouteContextMap.js';
+import { OnResponseEventData } from './types/events/OnResponseEventData.js';
 export declare class OpenApi<TRouteTypes extends string, TErrorCodes extends string, TConfig extends AnyConfig<TRouteTypes, TErrorCodes>> {
     static readonly builder: InitialBuilder;
     readonly validators: ValidationUtils;
@@ -50,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'], RouteContext<TRouteTypes, TConfig>>>): Promise<{
+    protected handleError(e: unknown, req: Request, eventPieces?: Partial<OnResponseEventData<TRouteTypes, TConfig['routes'][TRouteTypes]['extraProps'], RouteContextMap<TRouteTypes, TConfig['routes'][TRouteTypes]['extraProps']>>>): 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 = {};
@@ -185,8 +186,9 @@ export class OpenApi {
                 body: body,
             };
             onRoute = {
+                routeType: route.type,
                 request: originalReq,
-                logger: this.logger,
+                logger,
                 path: urlPath,
                 method: originalReq.method,
                 params: pathParams,
@@ -219,7 +221,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,
@@ -253,7 +255,7 @@ export class OpenApi {
             const response = await wrapper(handler, {
                 route: route,
                 request: originalReq,
-                logger: this.logger,
+                logger,
                 params: {
                     query: query.data,
                     path: path.data,
@@ -297,8 +299,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, object>) => Promise<void>;
-    onError?: (e: OnErrorEvent<SampleRouteType, DefaultRouteParamsMap, object>) => Promise<ErrorResponse<ErrorCode, DefaultErrorMap>>;
+    onResponse?: (e: OnResponseEvent<SampleRouteType, DefaultRouteParamsMap, DefaultRouteContextMap>) => Promise<void>;
+    onError?: (e: OnErrorEvent<SampleRouteType, DefaultRouteParamsMap, DefaultRouteContextMap>) => Promise<ErrorResponse<ErrorCode, DefaultErrorMap>>;
     skipDescriptionsCheck?: boolean;
 }

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, 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>>;
+    onHandler?: (e: OnHandlerEvent<TRouteTypes, TRouteParamMap, TRouteContextMap>) => Promise<void>;
+    onResponse?: (e: OnResponseEvent<TRouteTypes, TRouteParamMap, TRouteContextMap>) => Promise<void>;
+    onError?: (e: OnErrorEvent<TRouteTypes, TRouteParamMap, TRouteContextMap>) => Promise<ErrorResponse<TErrorCodes, TErrorConfigMap>>;
 };

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

@@ -1,8 +1,6 @@
-import { ILogger } from '../../services/Logger/types/ILogger.js';
+import { RouteContextMap } from '../config/RouteContextMap.js';
 import { RouteExtraPropsMap } from '../config/RouteExtraPropsMap.js';
-import { OnResponseEvent } from './OnResponseEvent.js';
-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;
-}
+import { OnErrorEventData } from './OnErrorEventData.js';
+export type OnErrorEvent<TRouteType extends string, TExtraPropsMap extends RouteExtraPropsMap<TRouteType>, TContext extends RouteContextMap<TRouteType, TExtraPropsMap>> = {
+    [key in TRouteType]: OnErrorEventData<key, TExtraPropsMap, TContext>;
+}[TRouteType];

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

@@ -0,0 +1,9 @@
+import { ILogger } from '../../services/Logger/types/ILogger.js';
+import { RouteContextMap } from '../config/RouteContextMap.js';
+import { RouteExtraPropsMap } from '../config/RouteExtraPropsMap.js';
+import { OnResponseEventData } from './OnResponseEventData.js';
+export interface OnErrorEventData<TRouteType extends string, TExtraPropsMap extends RouteExtraPropsMap<TRouteType>, TContext extends RouteContextMap<TRouteType, TExtraPropsMap>> extends Partial<OnResponseEventData<TRouteType, TExtraPropsMap, TContext>> {
+    request: Request;
+    logger: ILogger;
+    error: unknown;
+}

package/dist/types/events/OnErrorEventData.js

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

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

@@ -1,10 +1,6 @@
+import { RouteContextMap } from '../config/RouteContextMap.js';
 import { RouteExtraPropsMap } from '../config/RouteExtraPropsMap.js';
-import { OnRouteEvent } from './OnRouteEvent.js';
-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;
-}
+import { OnHandlerEventData } from './OnHandlerEventData.js';
+export type OnHandlerEvent<TRouteType extends string, TExtraPropsMap extends RouteExtraPropsMap<TRouteType>, TContext extends RouteContextMap<TRouteType, TExtraPropsMap>> = {
+    [key in TRouteType]: OnHandlerEventData<key, TExtraPropsMap, TContext>;
+}[TRouteType];

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

@@ -0,0 +1,11 @@
+import { RouteContextMap } from '../config/RouteContextMap.js';
+import { RouteExtraPropsMap } from '../config/RouteExtraPropsMap.js';
+import { OnRouteEventData } from './OnRouteEventData.js';
+export interface OnHandlerEventData<TRouteType extends string, TExtraPropsMap extends RouteExtraPropsMap<TRouteType>, TContext extends RouteContextMap<TRouteType, TExtraPropsMap>> extends OnRouteEventData<TRouteType, TExtraPropsMap> {
+    validated: {
+        query: Record<string, unknown>;
+        path: Record<string, unknown>;
+        body: unknown;
+    };
+    context: Awaited<ReturnType<TContext[TRouteType]>>;
+}

package/dist/types/events/OnHandlerEventData.js

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

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

@@ -1,6 +1,6 @@
+import { RouteContextMap } from '../config/RouteContextMap.js';
 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>, TContext extends object> extends OnHandlerEvent<TRouteType, TContextMap, TContext> {
-    response: RouteResponse;
-}
+import { OnResponseEventData } from './OnResponseEventData.js';
+export type OnResponseEvent<TRouteType extends string, TExtraPropsMap extends RouteExtraPropsMap<TRouteType>, TContextMap extends RouteContextMap<TRouteType, TExtraPropsMap>> = {
+    [key in TRouteType]: OnResponseEventData<key, TExtraPropsMap, TContextMap>;
+}[TRouteType];

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

@@ -0,0 +1,7 @@
+import { RouteContextMap } from '../config/RouteContextMap.js';
+import { RouteExtraPropsMap } from '../config/RouteExtraPropsMap.js';
+import { RouteResponse } from '../RouteResponse.js';
+import { OnHandlerEventData } from './OnHandlerEventData.js';
+export interface OnResponseEventData<TRouteType extends string, TExtraPropsMap extends RouteExtraPropsMap<TRouteType>, TContext extends RouteContextMap<TRouteType, TExtraPropsMap>> extends OnHandlerEventData<TRouteType, TExtraPropsMap, TContext> {
+    response: RouteResponse;
+}

package/dist/types/events/OnResponseEventData.js

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

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

@@ -1,12 +1,5 @@
-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, 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<TExtraPropsMap[TRouteType]>;
-}
+import { OnRouteEventData } from './OnRouteEventData.js';
+export type OnRouteEvent<TRouteType extends string, TExtraPropsMap extends RouteExtraPropsMap<TRouteType>> = {
+    [key in TRouteType]: OnRouteEventData<key, TExtraPropsMap>;
+}[TRouteType];

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

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

package/dist/types/events/OnRouteEventData.js

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

package/package.json

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