transit-kit 0.2.0 → 0.2.1

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

@@ -1,6 +1,6 @@
 import { Request } from "express";
 import { HttpStatusCodes } from "../../constants/HttpStatusCodes";
 import { GenericResponse } from "./responses";
-export type ApiEndpointHandler<PathParams extends Record<string, string> | undefined = {}, RequestBody = unknown, Query = unknown, Responses extends GenericResponse = never> = (request: Request<PathParams, unknown, RequestBody, Query, Record<string, unknown>>) => Promise<Responses | {
+export type ApiEndpointHandler<PathParams extends Record<string, string> = {}, RequestBody = unknown, Query = unknown, Responses extends GenericResponse = never> = (request: Request<PathParams, unknown, RequestBody, Query, Record<string, unknown>>) => Promise<Responses | {
     code: (typeof HttpStatusCodes)["InternalServerError_500"];
 }>;

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

@@ -2,4 +2,4 @@ export type ExtractPathParams<Path extends string> = Path extends `${string}:${i
     [K in Param | keyof ExtractPathParams<Rest>]: string;
 } : Path extends `${string}:${infer Param}` ? {
     [K in Param]: string;
-} : undefined;
+} : {};

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

@@ -3,10 +3,9 @@ import { HttpMethod } from "../../constants/HttpMethods";
 import { ApiEndpointDefinition } from "./EndpointDefinition";
 import { ApiEndpointHandler } from "./EndpointHandler";
 import { HandlerForDefinition } from "./HandlerFromDefinition";
-import { GenericResponseSchemaMap } from "./responses";
+import { GenericResponse, GenericResponseSchemaMap } from "./responses";
 export declare function createApiEndpointHandler<const ResponsesMap extends GenericResponseSchemaMap, const Path extends string, const Method extends HttpMethod, const RequestBody extends z.ZodType | undefined = undefined, const Query extends z.ZodType | undefined = undefined>(definition: ApiEndpointDefinition<Path, Method, RequestBody, Query, ResponsesMap>, handler: HandlerForDefinition<Path, RequestBody, Query, ResponsesMap>): {
-    type: string;
     definition: ApiEndpointDefinition<Path, Method, RequestBody, Query, ResponsesMap>;
     handler: HandlerForDefinition<Path, RequestBody, Query, ResponsesMap>;
 };
-export declare function buildApiEndpointHandler(handler: ApiEndpointHandler): import("express").RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+export declare function buildApiEndpointHandler(handler: ApiEndpointHandler<Record<string, string>, unknown, unknown, GenericResponse>): import("express").RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;

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

@@ -2,7 +2,6 @@ import expressAsyncHandler from "express-async-handler";
 import { isJsonResponse } from "./responses/jsonResponse";
 export function createApiEndpointHandler(definition, handler) {
     return {
-        type: "__API_ENDPOINT_DEFINITION__",
         definition,
         handler,
     };

package/dist/server/handlers/api/createApiHandler.spec.d.ts

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

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

@@ -0,0 +1,31 @@
+import { describe, it } from "vitest";
+import { createServer } from "../../server";
+import { createApiEndpointHandler } from "./createApiHandler";
+import testRequest from "supertest";
+describe("createApiHandler", () => {
+    it("can create an API handler", () => {
+        const endpoint = createApiEndpointHandler({
+            meta: {
+                name: "",
+                description: "",
+                group: "",
+            },
+            method: "get",
+            path: "/test",
+            responseSchemas: {
+                200: {},
+            },
+        }, async () => {
+            return {
+                code: 200,
+            };
+        });
+        const server = createServer({
+            inDevMode: true,
+            port: 3000,
+            logger: false,
+            endpoints: [endpoint],
+        });
+        testRequest(server.expressApp).get("/test").expect(200);
+    });
+});

package/dist/server/server.d.ts

@@ -3,20 +3,21 @@ import z from "zod";
 import { HttpMethod } from "./constants/HttpMethods";
 import { ApiEndpointDefinition } from "./handlers/api/EndpointDefinition";
 import { ApiEndpointHandler } from "./handlers/api/EndpointHandler";
+import { GenericResponse, GenericResponseSchemaMap } from "./handlers/api/responses";
 import { Logger } from "./utils/logging";
 export interface ServerConfig {
     inDevMode: boolean;
     port: number;
     logger: Logger | boolean;
     endpoints: Array<{
-        endpointHandler: ApiEndpointHandler;
-        endpointDefinition: ApiEndpointDefinition<string, HttpMethod, z.ZodType, z.ZodType, {}>;
+        handler: ApiEndpointHandler<Record<string, string>, any, any, GenericResponse>;
+        definition: ApiEndpointDefinition<string, HttpMethod, z.ZodType | undefined, z.ZodType | undefined, GenericResponseSchemaMap>;
     }>;
 }
 export interface Server {
     expressApp: Application;
     logger: Logger | boolean;
-    endpointDefinitions: ApiEndpointDefinition<string, HttpMethod, z.ZodType, z.ZodType, {}>[];
+    endpointDefinitions: ApiEndpointDefinition<string, HttpMethod, z.ZodType | undefined, z.ZodType | undefined, GenericResponseSchemaMap>[];
     start: () => void;
 }
 export declare function createServer(config: ServerConfig): Server;

package/dist/server/server.js

@@ -30,13 +30,13 @@ export function createServer(config) {
     app.use(cookieParser());
     app.use(buildRequestLogger(logger, inDevMode));
     app.use(buildResponseLogger(logger, inDevMode));
-    endpoints.forEach(({ endpointDefinition, endpointHandler }) => {
-        registerApiEndpoint(app, endpointDefinition, endpointHandler);
+    endpoints.forEach(({ definition, handler }) => {
+        registerApiEndpoint(app, definition, handler);
     });
     return {
         expressApp: app,
         logger: logger,
-        endpointDefinitions: endpoints.map((e) => e.endpointDefinition),
+        endpointDefinitions: endpoints.map((e) => e.definition),
         start: () => {
             app.listen(port);
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "transit-kit",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A declarative TypeScript framework for building type-safe Express.js APIs with automatic OpenAPI generation",
   "keywords": [
     "express",
@@ -42,6 +42,7 @@
   "devDependencies": {
     "@types/cookie-parser": "^1.4.9",
     "@types/express": "^5.0.0",
+    "@types/supertest": "^6.0.3",
     "@vitest/coverage-v8": "^4.0.15",
     "@vitest/eslint-plugin": "^1.5.2",
     "eslint": "^9.39.1",
@@ -49,6 +50,7 @@
     "eslint-plugin-prettier": "^5.5.4",
     "jiti": "^2.6.1",
     "prettier": "^3.7.4",
+    "supertest": "^7.1.4",
     "tslib": "2.8.1",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.49.0",