@aklinker1/zeta 1.0.2 → 1.1.0

package/README.md

@@ -1,8 +1,8 @@
 # Zeta
 
-[![JSR](https://jsr.io/badges/@aklinker1/zeta)](https://jsr.io/@aklinker1/zeta) [![Docs](https://img.shields.io/badge/Docs-blue?logo=readme&logoColor=white)](https://jsr.io/@aklinker1/zeta) [![API Reference](https://img.shields.io/badge/API%20Reference-blue?logo=readme&logoColor=white)](https://jsr.io/@aklinker1/zeta/doc) [![License](https://img.shields.io/github/license/aklinker1/zeta)](https://github.com/aklinker1/zeta/blob/main/LICENSE) [![Changelog](https://img.shields.io/badge/Changelog-blue?logo=github&logoColor=white)](https://github.com/aklinker1/zeta/blob/main/CHANGELOG.md)
+[![JSR](https://jsr.io/badges/@aklinker1/zeta)](https://jsr.io/@aklinker1/zeta) [![NPM Version](https://img.shields.io/npm/v/%40aklinker1%2Fzeta?logo=npm&labelColor=red&color=white)](https://www.npmjs.com/package/@aklinker1/zeta) [![Docs](https://img.shields.io/badge/Docs-blue?logo=readme&logoColor=white)](https://jsr.io/@aklinker1/zeta) [![API Reference](https://img.shields.io/badge/API%20Reference-blue?logo=readme&logoColor=white)](https://jsr.io/@aklinker1/zeta/doc) [![License](https://img.shields.io/github/license/aklinker1/zeta)](https://github.com/aklinker1/zeta/blob/main/LICENSE) [![Changelog](https://img.shields.io/badge/Changelog-blue?logo=github&logoColor=white)](https://github.com/aklinker1/zeta/blob/main/CHANGELOG.md)
 
-Personal alternative to [Elysia](https://elysiajs.com/) with better validation support.
+Composable, testable, OpenAPI-first backend framework with validation built-in.
 
 **Features**
 
@@ -268,7 +268,9 @@ When a response schema(s) are defined, the return value from the function is typ
 
 #### Custom Content Types
 
-By default, Zeta will use `application/json` as the content type in the OpenAPI docs. you can override this by setting the `contentType` metadata on your schema:
+By default, Zeta will use `application/json` as the content type in the OpenAPI docs and infer the content type of the response at runtime based on the response type.
+
+You can override both the docs and the response content type by setting the `contentType` metadata on your schema:
 
 ```ts
 app.get(
@@ -282,24 +284,6 @@ app.get(
 );
 ```
 
-> [!WARNING]
->
-> Zeta ignores this metadata when building the response. Make sure to set the `Content-Type` header in your handler:
->
-> ```ts
-> app.get(
->   "/csv",
->   {
->     responses: z.string().meta({ contentType: "text/csv" }),
->   },
->   ({ set }) => {
->     // ...
->     set.headers["Content-Type"] = "text/csv";
->     return "...";
->   },
-> );
-> ```
-
 ## Life Cycle Hooks
 
 ## `App#decorate`

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@aklinker1/zeta",
-  "version": "1.0.2",
+  "description": "Composable, testable, OpenAPI-first backend framework with validation built-in",
+  "version": "1.1.0",
   "type": "module",
   "license": "MIT",
   "packageManager": "bun@1.2.17",
@@ -24,13 +25,18 @@
   "repository": {
     "url": "https://github.com/aklinker1/zeta"
   },
+  "keywords": [
+    "backend",
+    "server",
+    "validation",
+    "openapi"
+  ],
   "scripts": {
     "dev": "bun test --watch",
     "build": "echo 'Noop - nothing to build.'",
     "bench": "bun run src/__tests__/bench.ts",
     "example": "bun --watch run example.ts",
     "example:prod": "NODE_ENV=production bun run example",
-    "publish": "bun run scripts/publish.ts",
     "docs:dev": "vitepress dev docs",
     "docs:build": "vitepress build docs",
     "docs:preview": "vitepress preview docs"

package/src/adapters/zod-schema-adapter.ts

@@ -21,7 +21,7 @@ const { z } = await import(zod);
 export const zodSchemaAdapter: SchemaAdapter = {
   toJsonSchema: (schema) => {
     if (!("_zod" in schema)) throw Error("input schema is not a Zod schema");
-    const res = z.toJSONSchema(schema, { target: "draft-7" });
+    const res = z.toJSONSchema(schema, { target: "openapi-3.0" });
     delete res.$schema;
     return res;
   },

package/src/app.ts

@@ -168,7 +168,11 @@ export function createApp<TPrefix extends BasePrefix = "">(
             return onGlobalRequestResponse;
           }
 
-          const response = await callHandler(ctx, getRoute);
+          const response = await callHandler(
+            ctx,
+            getRoute,
+            options?.schemaAdapter,
+          );
           ctx.response = response;
 
           return response;

package/src/internal/call-handler.ts

@@ -1,5 +1,5 @@
 import type { MatchedRoute } from "rou3";
-import type { RouterData } from "../types";
+import type { RouterData, SchemaAdapter } from "../types";
 import { NotFoundHttpError } from "../errors";
 import {
   callCtxModifierHooks,
@@ -18,6 +18,7 @@ export async function callHandler(
     method: string,
     path: string,
   ) => MatchedRoute<RouterData> | undefined,
+  schemaAdapter: SchemaAdapter | undefined,
 ): Promise<Response> {
   const route = getRoute(ctx.method, ctx.path);
   if (route == null) {
@@ -69,10 +70,12 @@ export async function callHandler(
     body,
   });
 
-  let response: any = route.data.handler(ctx);
-  if (response instanceof Promise) response = await response;
+  {
+    let response: any = route.data.handler(ctx);
+    if (response instanceof Promise) response = await response;
 
-  ctx.response = response;
+    ctx.response = response;
+  }
 
   for (const hook of route.data.hooks.onAfterHandle) {
     let res = hook.callback(ctx);
@@ -81,6 +84,7 @@ export async function callHandler(
     ctx.response = res;
   }
 
+  let responseMeta: Record<string, any> | undefined;
   if (!(ctx.response instanceof Response)) {
     if (route.data.def?.responses) {
       if ("~standard" in route.data.def.responses) {
@@ -88,10 +92,11 @@ export async function callHandler(
           route.data.def.responses,
           ctx.response,
         );
+        responseMeta = schemaAdapter?.getMeta(route.data.def.responses);
       } else {
         if (!ctx.response || !isStatusResult(ctx.response)) {
           throw new Error(
-            "When `responses` is a record of schemas, you must return a value from `ctx.status()`.",
+            "When `responses` is a record of schemas, you must return a value from `ctx.status(...)`.",
           );
         }
         const { status, body } = ctx.response;
@@ -102,11 +107,12 @@ export async function callHandler(
         }
         ctx.set.status = status;
         ctx.response = validateOutputSchema(schema, body);
+        responseMeta = schemaAdapter?.getMeta(schema);
       }
     }
   }
 
-  if (response instanceof Response) return response;
+  if (ctx.response instanceof Response) return ctx.response;
 
   for (const hook of route.data.hooks.onMapResponse) {
     let res = hook.callback(ctx);
@@ -125,7 +131,7 @@ export async function callHandler(
   return new Response(resBody.serialized, {
     status: ctx.set.status,
     headers: {
-      "Content-Type": resBody.contentType,
+      "Content-Type": responseMeta?.contentType ?? resBody.contentType,
       ...ctx.set.headers,
     },
   });