snap-on-openapi 1.0.5 → 1.0.7

package/dist/OpenApi.d.ts

@@ -49,10 +49,12 @@ export declare class OpenApi<TRouteTypes extends string, TErrorCodes extends str
     processRootRoute(originalReq: Request): Promise<{
         status: number;
         body: unknown;
+        headers: Record<string, string>;
     }>;
     protected handleError(e: unknown, req: Request): {
         status: number;
         body: z.TypeOf<import("./index.js").OpenApiErrorConfigMap<TErrorCodes>[TErrorCodes]["responseValidator"]>;
+        headers: {};
     };
     protected static getBuilder(): ConfigBuilder<SampleRouteType, ErrorCode, DefaultErrorMap, DefaultRouteParamsMap, DefaultRouteContextMap, DefaultRouteMap, DefaultConfig>;
 }

package/dist/OpenApi.js

@@ -235,12 +235,17 @@ export class OpenApi {
                     }
                 });
             }
-            const validated = route.validators.response.safeParse(response);
+            const finalResponse = route.validators.responseHeaders ? response : { body: response, headers: {} };
+            const finalResponseValidator = z.object({
+                body: route.validators.response,
+                headers: route.validators.responseHeaders?.strict() ?? z.object({}),
+            });
+            const validated = finalResponseValidator.safeParse(finalResponse);
             if (!validated.success) {
                 throw new ValidationError(validated.error, ValidationLocation.Response);
             }
             this.logger.info('Response: 200', validated.data);
-            return { status: 200, body: validated.data };
+            return { status: 200, body: validated.data.body, headers: validated.data.headers };
         }
         catch (e) {
             return this.handleError(e, originalReq);
@@ -256,12 +261,12 @@ export class OpenApi {
                 throw new Error("Error response haven't passed validation");
             }
             this.logger.info(`Response: '${status}'`, response.body);
-            return { status: Number(status), body: response.body };
+            return { status: Number(status), body: response.body, headers: {} };
         }
         catch (e) {
             this.logger.error('Error during error handling', e);
             const status = this.config.errors[this.config.defaultError.code].status;
-            return { status: Number(status), body: this.config.defaultError.body };
+            return { status: Number(status), body: this.config.defaultError.body, headers: {} };
         }
     }
     static getBuilder() {

package/dist/services/ExpressWrapper/ExpressWrapper.d.ts

@@ -1,4 +1,5 @@
 import { ExpressApp } from './types/ExpressApp.js';
+import { ExpressRequest } from './types/ExpressRequest.js';
 import { DevelopmentUtils } from '../DevelopmentUtils/DevelopmentUtils.js';
 import { OpenApi } from '../../OpenApi.js';
 import { AnyConfig } from '../../types/config/AnyConfig.js';
@@ -8,6 +9,7 @@ export declare class ExpressWrapper<TRouteTypes extends string, TErrorCodes exte
     protected developmentUtils: DevelopmentUtils;
     protected schemaRoute: RoutePath;
     constructor(openApi: OpenApi<TRouteTypes, TErrorCodes, TConfig>);
+    requestBodyToString(req: ExpressRequest): Promise<string | undefined>;
     createStoplightRoute(route: RoutePath, expressApp: ExpressApp): void;
     createSwaggerRoute(route: RoutePath, expressApp: ExpressApp): void;
     createSchemaRoute(route: RoutePath, expressApp: ExpressApp): void;

package/dist/services/ExpressWrapper/ExpressWrapper.js

@@ -8,6 +8,25 @@ export class ExpressWrapper {
         this.service = openApi;
         this.developmentUtils = new DevelopmentUtils();
     }
+    async requestBodyToString(req) {
+        if (!['POST', 'PUT', 'PATCH', 'DELETE'].includes(req.method)) {
+            return undefined;
+        }
+        return new Promise((resolve, reject) => {
+            const chunks = [];
+            req.on('data', (chunk) => {
+                chunks.push(chunk);
+            });
+            req.on('end', () => {
+                const bodyBuffer = Buffer.concat(chunks);
+                const bodyString = bodyBuffer.toString();
+                resolve(bodyString);
+            });
+            req.on('error', (error) => {
+                reject(error);
+            });
+        });
+    }
     createStoplightRoute(route, expressApp) {
         const handler = async (req, res) => {
             const body = this.developmentUtils.getStoplightHtml(this.schemaRoute);
@@ -50,13 +69,19 @@ export class ExpressWrapper {
                 host: req.host,
                 pathname: req.originalUrl,
             });
+            const body = await this.requestBodyToString(req);
             const openApiRequest = new Request(url, {
-                body: req.body,
                 headers: headers,
                 method: req.method,
+                body: body,
             });
             const result = await this.service.processRootRoute(openApiRequest);
-            res.status(result.status).header('Content-Type', 'application/json').json(result.body);
+            res.status(result.status);
+            res.header('Content-Type', 'application/json');
+            for (const header of Object.entries(result.headers)) {
+                res.header(header[0], header[1]);
+            }
+            res.json(result.body);
         };
         const regex = new RegExp(`${route}.*`);
         expressApp.get(regex, handler);

package/dist/services/ExpressWrapper/types/ExpressRequest.d.ts

@@ -5,4 +5,7 @@ export interface ExpressRequest {
     protocol: string;
     originalUrl: string;
     host: string;
+    on(event: 'data', listener: (chunk: Buffer) => void): this;
+    on(event: 'end', listener: () => void): this;
+    on(event: 'error', listener: (error: Error) => void): this;
 }

package/dist/services/RoutingFactory/RoutingFactory.d.ts

@@ -6,5 +6,5 @@ import { RouteExtraProps } from '../../types/config/RouteExtraProps.js';
 export declare class RoutingFactory<TRouteTypes extends string, TErrorCodes extends string, TConfig extends AnyConfig<TRouteTypes, TErrorCodes>> {
     protected map: TConfig;
     constructor(map: TConfig);
-    createRoute<TType extends TRouteTypes, TMethod extends Method, TResponseValidator extends ZodFirstPartySchemaTypes, TQueryValidator extends ZodObject<ZodRawShape> | undefined = undefined, TPathValidator extends ZodObject<ZodRawShape> | undefined = undefined, TBodyValidator extends ZodObject<ZodRawShape> | undefined = undefined>(params: Route<TType, Awaited<ReturnType<TConfig['routes'][TType]['contextFactory']>>, TResponseValidator, TPathValidator, TQueryValidator, TBodyValidator, TMethod> & (RouteExtraProps<TConfig['routes'][TType]['extraProps']>)): Route<TType, Awaited<ReturnType<TConfig['routes'][TType]['contextFactory']>>, TResponseValidator, TPathValidator, TQueryValidator, TBodyValidator>;
+    createRoute<TType extends TRouteTypes, TMethod extends Method, TResponseValidator extends ZodFirstPartySchemaTypes, TQueryValidator extends ZodObject<ZodRawShape> | undefined = undefined, TPathValidator extends ZodObject<ZodRawShape> | undefined = undefined, TBodyValidator extends ZodObject<ZodRawShape> | undefined = undefined, TResponseHeadersValidator extends ZodObject<ZodRawShape> | undefined = undefined>(params: Route<TType, Awaited<ReturnType<TConfig['routes'][TType]['contextFactory']>>, TResponseValidator, TPathValidator, TQueryValidator, TBodyValidator, TResponseHeadersValidator, TMethod> & (RouteExtraProps<TConfig['routes'][TType]['extraProps']>)): Route<TType, Awaited<ReturnType<TConfig['routes'][TType]['contextFactory']>>, TResponseValidator, TPathValidator, TQueryValidator, TBodyValidator, TResponseHeadersValidator>;
 }

package/dist/services/RoutingFactory/RoutingFactory.js

@@ -14,6 +14,7 @@ export class RoutingFactory {
                 query: params.validators.query,
                 path: params.validators.path,
                 response: params.validators.response,
+                responseHeaders: params.validators.responseHeaders,
                 body: params.validators.body,
             },
             handler: params.handler,

package/dist/services/TanstackStartWrapper/TanstackStartWrapper.js

@@ -53,6 +53,7 @@ export class TanstackStartWrapper {
             const response = await this.service.processRootRoute(ctx.request);
             const res = new Response(JSON.stringify(response.body), {
                 status: response.status,
+                headers: response.headers,
             });
             return res;
         };

package/dist/types/AnyRoute.d.ts

@@ -1,3 +1,3 @@
 import { ZodObject, ZodRawShape, ZodFirstPartySchemaTypes } from 'zod';
 import { Route } from './Route.js';
-export type AnyRoute<TRouteType extends string> = Route<TRouteType, any, ZodFirstPartySchemaTypes, ZodObject<ZodRawShape> | undefined, ZodObject<ZodRawShape> | undefined, ZodObject<ZodRawShape> | undefined>;
+export type AnyRoute<TRouteType extends string> = Route<TRouteType, any, ZodFirstPartySchemaTypes, ZodObject<ZodRawShape> | undefined, ZodObject<ZodRawShape> | undefined, ZodObject<ZodRawShape> | undefined, ZodObject<ZodRawShape> | undefined>;

package/dist/types/Route.d.ts

@@ -1,7 +1,13 @@
 import { z, ZodFirstPartySchemaTypes, ZodObject, ZodRawShape } from 'zod';
 import { Method } from '../enums/Methods.js';
 import { RoutePath } from './RoutePath.js';
-export interface Route<TType extends string, TContext extends object, TResponseValidator extends ZodFirstPartySchemaTypes, TPathValidator extends ZodObject<ZodRawShape> | undefined, TQueryValidator extends ZodObject<ZodRawShape> | undefined, TBodyValidator extends ZodObject<ZodRawShape> | undefined, TMethod extends Method = Method> {
+type BodyHandlerResponse<T extends ZodFirstPartySchemaTypes> = Promise<z.infer<T>>;
+type FullHandlerRespnse<T extends ZodFirstPartySchemaTypes, THeaders extends ZodObject<ZodRawShape>> = Promise<{
+    body: z.infer<T>;
+    headers: z.infer<THeaders>;
+}>;
+type HandlerResponse<T extends ZodFirstPartySchemaTypes, TH extends ZodObject<ZodRawShape> | undefined> = TH extends undefined ? BodyHandlerResponse<T> : FullHandlerRespnse<T, Exclude<TH, undefined>>;
+export interface Route<TType extends string, TContext extends object, TResponseValidator extends ZodFirstPartySchemaTypes, TPathValidator extends ZodObject<ZodRawShape> | undefined, TQueryValidator extends ZodObject<ZodRawShape> | undefined, TBodyValidator extends ZodObject<ZodRawShape> | undefined, TResponseHeadersValidator extends ZodObject<ZodRawShape> | undefined, TMethod extends Method = Method> {
     type: TType;
     method: TMethod;
     path: RoutePath;
@@ -11,6 +17,7 @@ export interface Route<TType extends string, TContext extends object, TResponseV
         path?: TPathValidator;
         body?: TMethod extends 'GET' ? never : TBodyValidator;
         response: TResponseValidator;
+        responseHeaders?: TResponseHeadersValidator;
     };
     handler: (context: {
         params: {
@@ -18,5 +25,6 @@ export interface Route<TType extends string, TContext extends object, TResponseV
             query: TQueryValidator extends ZodObject<ZodRawShape> ? z.infer<TQueryValidator> : object;
             path: TPathValidator extends ZodObject<ZodRawShape> ? z.infer<TPathValidator> : object;
         };
-    } & TContext) => Promise<z.infer<TResponseValidator>>;
+    } & TContext) => HandlerResponse<TResponseValidator, TResponseHeadersValidator>;
 }
+export {};

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

@@ -1,5 +1,6 @@
 import { Logger } from '../../services/Logger/Logger.js';
 import { LogLevel } from '../../services/Logger/types/LogLevel.js';
+import { AnyRoute } from '../AnyRoute.js';
 import { RoutePath } from '../RoutePath.js';
 import { ErrorConfigMap } from './ErrorConfigMap.js';
 import { ErrorResponse } from './ErrorResponse.js';
@@ -18,4 +19,9 @@ export type Config<TRouteTypes extends string, TErrorCodes extends string, TErro
     servers?: Server[];
     logLevel?: LogLevel;
     handleError?: (e: unknown, req: Request) => ErrorResponse<TErrorCodes, TErrorConfigMap>;
+    middleware?: <T extends TRouteTypes>(route: AnyRoute<T>, ctx: Awaited<ReturnType<TRouteContextMap[T]>>) => Promise<{
+        body?: unknown;
+        status?: number;
+        headers?: Record<string, string>;
+    }>;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "snap-on-openapi",
   "author": "Alex Sarychev",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Swiftly build type-checked OpenAPI applications with Zod and TypeScript",
   "type": "module",
   "license": "ISC",
@@ -16,7 +16,7 @@
   },
   "scripts": {
     "build": "rm -rf dist && tsc && tsc-alias && cp -R ./assets ./dist && cp ./README.md ./dist",
-    "check": "npm run test:typecheck && npm run lint && npm run test",
+    "check": "npm run test:typecheck && npm run lint",
     "test": "vitest --run",
     "test:gha": "npx vitest --run --coverage --reporter=verbose",
     "test:typecheck": "tsc  -p tsconfig.test.json",