transit-kit 0.4.4 → 0.5.0

package/dist/cli/generateOpenApi.spec.js

@@ -20,11 +20,11 @@ describe("translateToOpenAPIPathItem", () => {
                     dataSchema: z.string(),
                 },
             },
-        }, async (req) => {
+        }, async ({ request }) => {
             return {
                 code: 200,
                 dataType: "application/json",
-                json: req.params.id,
+                json: request.params.id,
             };
         });
         const [path, pathItem] = translateToOpenAPIPathItem(definition);

package/dist/server/handlers/api/EndpointHandler.d.ts

@@ -1,7 +1,9 @@
-import { Request } from "express";
+import { Request, Response } from "express";
 import { HttpStatusCodes } from "../../constants/HttpStatusCodes";
 import { GenericResponse } from "./responses";
-export type ApiEndpointHandler<PathParams extends Record<string, string> = {}, RequestBody = unknown, Query = unknown, Responses extends GenericResponse = never, Caller = unknown> = (request: Request<PathParams, unknown, RequestBody, Query, Record<string, unknown>>, extractedRequestData: {
+export type ApiEndpointHandler<PathParams extends Record<string, string> = {}, RequestBody = unknown, Query = unknown, Responses extends GenericResponse = never, Caller = unknown> = (typedRequestData: {
+    request: Request<PathParams, unknown, RequestBody, Query, Record<string, unknown>>;
+    response: Response<unknown>;
     parameters: PathParams;
     query: Query;
     body: RequestBody;

package/dist/server/handlers/api/createApiHandler.js

@@ -8,14 +8,14 @@ export function createApiEndpointHandler(definition, handler) {
 }
 export function buildApiEndpointHandler(handler) {
     return expressAsyncHandler(async (request, response) => {
-        const caller = response.locals.caller;
-        const extractedRequestData = {
+        const result = await handler({
+            request,
+            response,
             parameters: request.params,
             query: request.query,
             body: request.body,
-            caller,
-        };
-        const result = await handler(request, extractedRequestData);
+            caller: response.locals.caller,
+        });
         if (isJsonResponse(result)) {
             response.status(result.code).json(result.json);
         }

package/dist/server/handlers/api/responses/emptyResponse.spec.d.ts

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

package/dist/server/handlers/api/responses/emptyResponse.spec.js

@@ -0,0 +1,9 @@
+import { describe, expectTypeOf, it } from "vitest";
+describe("empty response", () => {
+    it("can correctly infer the response type from schema", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+    it("can correctly identify a literal with the type", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+});

package/dist/server/handlers/api/responses/jsonResponse.spec.d.ts

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

package/dist/server/handlers/api/responses/jsonResponse.spec.js

@@ -0,0 +1,39 @@
+import { describe, expect, expectTypeOf, it } from "vitest";
+import z from "zod";
+import { isJsonResponse, isJsonResponseSchema, } from "./jsonResponse";
+describe("empty response", () => {
+    it("can correctly infer the response type from schema", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+    it("can correctly identify a literal with the type", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+    it("can correctly validate if a response is of type", () => {
+        const res = {
+            dataType: "application/json",
+            json: "string",
+        };
+        expect(isJsonResponse(res)).toBe(true);
+    });
+    it("can correctly validate if a response is not of type", () => {
+        const res = {
+            dataType: "application/data", //<=== Wrong
+            json: "string",
+        };
+        expect(isJsonResponse(res)).toBe(false);
+    });
+    it("can correctly validate if a response schema is of type", () => {
+        const res = {
+            dataType: "application/json",
+            dataSchema: z.string(),
+        };
+        expect(isJsonResponseSchema(res)).toBe(true);
+    });
+    it("can correctly validate if a response schema is not of type", () => {
+        const res = {
+            dataType: "application/data", // <=== Wrong
+            dataSchema: z.string(),
+        };
+        expect(isJsonResponseSchema(res)).toBe(false);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "transit-kit",
-  "version": "0.4.4",
+  "version": "0.5.0",
   "description": "A declarative TypeScript framework for building type-safe Express.js APIs with automatic OpenAPI generation",
   "keywords": [
     "express",