ts-typed-api 0.2.16 → 0.2.17

package/dist/handler.js

@@ -347,6 +347,12 @@ middlewares) {
                         });
                     }
                 };
+                typedExpressRes.respondContentType = (status, data, contentType) => {
+                    // Set the content type header
+                    typedExpressRes.setHeader('Content-Type', contentType);
+                    // Send the raw data without JSON wrapping or validation
+                    typedExpressRes.status(status).send(data);
+                };
                 typedExpressRes.setHeader = (name, value) => {
                     // Call the original Express setHeader method to avoid recursion
                     Object.getPrototypeOf(expressRes).setHeader.call(expressRes, name, value);

package/dist/hono-cloudflare-workers.js

@@ -330,6 +330,13 @@ function registerHonoRouteHandlers(app, apiDefinition, routeHandlers, middleware
                 };
                 const fakeRes = {
                     respond: c.respond,
+                    respondContentType: (status, data, contentType) => {
+                        // For Hono, set the response directly
+                        c.__response = new Response(data, {
+                            status: status,
+                            headers: { 'Content-Type': contentType }
+                        });
+                    },
                     setHeader: (name, value) => {
                         c.header(name, value);
                         return fakeRes;

package/dist/router.d.ts

@@ -14,6 +14,7 @@ type ResponseDataForStatus<TDef extends ApiDefinitionSchema, TDomain extends key
 type RespondFunction<TDef extends ApiDefinitionSchema, TDomain extends keyof TDef['endpoints'], TRouteName extends keyof TDef['endpoints'][TDomain]> = <TStatusLocal extends keyof TDef['endpoints'][TDomain][TRouteName]['responses'] & number>(status: TStatusLocal, data: ResponseDataForStatus<TDef, TDomain, TRouteName, TStatusLocal>) => void;
 export interface TypedResponse<TDef extends ApiDefinitionSchema, TDomain extends keyof TDef['endpoints'], TRouteName extends keyof TDef['endpoints'][TDomain], L extends Record<string, any> = Record<string, any>> extends express.Response<any, L> {
     respond: RespondFunction<TDef, TDomain, TRouteName>;
+    respondContentType: (status: number, data: any, contentType: string) => void;
     setHeader: (name: string, value: string) => this;
     json: <B = any>(body: B) => this;
 }

package/examples/simple/definitions.ts

@@ -30,6 +30,9 @@ export const PublicApiDefinition = CreateApiDefinition({
             ping: {
                 method: 'GET',
                 path: '/ping',
+                query: z.object({
+                    format: z.enum(["json", "html"]).optional()
+                }),
                 responses: CreateResponses({
                     200: z.enum(["pong"]),
                 })

package/examples/simple/server.ts

@@ -1,6 +1,6 @@
 import express from 'express';
 import { PrivateApiDefinition, PublicApiDefinition } from './definitions';
-import { RegisterHandlers, EndpointMiddleware, createTypedHandler } from '../../src';
+import { RegisterHandlers, EndpointMiddleware } from '../../src';
 const app = express();
 const port = 3001;
 app.set('etag', false);
@@ -39,7 +39,16 @@ RegisterHandlers(app, PublicApiDefinition, {
         // TypeScript will give you type errors if this handler is missing
         ping: async (req, res) => {
             // req and res are fully typed based on the API definition
-            res.respond(200, "pong");
+            if (req.query.format === 'html') {
+                res.respondContentType(200, "<h1>pong</h1>", "text/html");
+            } else {
+                res.respond(200, "pong");
+            }
+        },
+        customHeaders: async (req, res) => {
+            res.setHeader('x-custom-test', 'test-value');
+            res.setHeader('x-another-header', 'another-value');
+            res.respond(200, { message: "headers set" });
         }
     },
     status: {
@@ -59,10 +68,10 @@ RegisterHandlers(app, PublicApiDefinition, {
 // Add another api definition
 RegisterHandlers(app, PrivateApiDefinition, {
     user: {
-        get: createTypedHandler(async (req, res) => {
+        get: async (req, res) => {
             console.log('Fetching user', req.params.id);
             res.respond(200, "ok");
-        })
+        }
     }
 }, [loggingMiddlewareTyped, authMiddleware]);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-typed-api",
-  "version": "0.2.16",
+  "version": "0.2.17",
   "description": "A lightweight, type-safe RPC library for TypeScript with Zod validation",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/handler.ts

@@ -408,6 +408,13 @@ export function registerRouteHandlers<TDef extends ApiDefinitionSchema>(
                     }
                 };
 
+                typedExpressRes.respondContentType = (status: number, data: any, contentType: string) => {
+                    // Set the content type header
+                    typedExpressRes.setHeader('Content-Type', contentType);
+                    // Send the raw data without JSON wrapping or validation
+                    typedExpressRes.status(status).send(data);
+                };
+
                 typedExpressRes.setHeader = (name: string, value: string) => {
                     // Call the original Express setHeader method to avoid recursion
                     Object.getPrototypeOf(expressRes).setHeader.call(expressRes, name, value);

package/src/hono-cloudflare-workers.ts

@@ -408,6 +408,13 @@ export function registerHonoRouteHandlers<
 
                 const fakeRes = {
                     respond: (c as any).respond,
+                    respondContentType: (status: number, data: any, contentType: string) => {
+                        // For Hono, set the response directly
+                        (c as any).__response = new Response(data, {
+                            status: status,
+                            headers: { 'Content-Type': contentType }
+                        });
+                    },
                     setHeader: (name: string, value: string) => {
                         c.header(name, value);
                         return fakeRes;

package/src/router.ts

@@ -59,6 +59,7 @@ export interface TypedResponse<
     L extends Record<string, any> = Record<string, any>
 > extends express.Response<any, L> {
     respond: RespondFunction<TDef, TDomain, TRouteName>;
+    respondContentType: (status: number, data: any, contentType: string) => void;
     setHeader: (name: string, value: string) => this;
     json: <B = any>(body: B) => this; // Keep original json
 }

package/tests/setup.ts

@@ -13,7 +13,11 @@ import { EndpointMiddlewareCtx } from '../src/object-handlers';
 const simplePublicHandlers = {
     common: {
         ping: async (req: any, res: any) => {
-            res.respond(200, "pong");
+            if (req.query?.format === 'html') {
+                res.respondContentType(200, "<h1>pong</h1>", "text/html");
+            } else {
+                res.respond(200, "pong");
+            }
         },
         customHeaders: async (req: any, res: any) => {
             res.setHeader('X-Custom-Test', 'test-value');

package/tests/simple-api.test.ts

@@ -27,6 +27,19 @@ describe.each([
             expect(result).toBe('pong');
         });
 
+        test('should ping successfully with HTML format', async () => {
+            const response = await fetch(`${baseUrl}/api/v1/public/ping?format=html`);
+            expect(response.status).toBe(200);
+            const contentType = response.headers.get('content-type');
+            if (serverName === 'Express') {
+                expect(contentType).toBe('text/html; charset=utf-8');
+            } else {
+                expect(contentType).toBe('text/html');
+            }
+            const html = await response.text();
+            expect(html).toBe('<h1>pong</h1>');
+        });
+
         test('should handle probe1 with match=true', async () => {
             const result = await client.callApi('status', 'probe1', {
                 query: { match: true }