feat(openapi): override success response status

Author: unnoq

packages/contract/src/procedure.test.ts

@@ -1,6 +1,20 @@
 import { z } from 'zod'
 import { ContractProcedure, isContractProcedure } from './procedure'
 
+describe('contractProcedure', () => {
+  it('throws error when route.successStatus is not between 200 and 299', () => {
+    expect(
+      () => new ContractProcedure({ InputSchema: undefined, OutputSchema: undefined, route: { successStatus: 100 } }),
+    ).toThrowError()
+    expect(
+      () => new ContractProcedure({ InputSchema: undefined, OutputSchema: undefined, route: { successStatus: 300 } }),
+    ).toThrowError()
+    expect(
+      () => new ContractProcedure({ InputSchema: undefined, OutputSchema: undefined, route: { successStatus: 299 } }),
+    ).not.toThrowError()
+  })
+})
+
 describe('isContractProcedure', () => {
   it('works', () => {
     expect(new ContractProcedure({ InputSchema: undefined, OutputSchema: undefined })).toSatisfy(isContractProcedure)

packages/contract/src/procedure.ts

@@ -12,6 +12,7 @@ export interface RouteOptions {
   description?: string
   deprecated?: boolean
   tags?: readonly string[]
+  successStatus?: number
 }
 
 export interface ContractProcedureDef<TInputSchema extends Schema, TOutputSchema extends Schema> {
@@ -27,6 +28,10 @@ export class ContractProcedure<TInputSchema extends Schema, TOutputSchema extend
   '~orpc': ContractProcedureDef<TInputSchema, TOutputSchema>
 
   constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema>) {
+    if (def.route?.successStatus && (def.route.successStatus < 200 || def.route?.successStatus > 299)) {
+      throw new Error('[ContractProcedure] The successStatus must be between 200 and 299')
+    }
+
     this['~orpc'] = def
   }
 }

packages/openapi/src/fetch/openapi-handler.test.ts

@@ -220,4 +220,29 @@ describe.each(hono)('openAPIHandler: %s', (_, hono) => {
     expect(vi.mocked(createProcedureClient).mock.results[0]?.value).toBeCalledTimes(1)
     expect(vi.mocked(createProcedureClient).mock.results[0]?.value).toBeCalledWith('__mocked__', { signal: undefined })
   })
+
+  it('custom success status', async () => {
+    const router = {
+      ping: new Procedure({
+        contract: new ContractProcedure({
+          route: {
+            method: 'GET',
+            path: '/ping',
+            successStatus: 298,
+          },
+          InputSchema: undefined,
+          OutputSchema: undefined,
+        }),
+        handler: vi.fn(),
+      }),
+    }
+
+    const handler = new OpenAPIHandler(hono, router)
+
+    const mockRequest = new Request('https://example.com/ping')
+
+    const response = await handler.fetch(mockRequest)
+
+    expect(response?.status).toBe(298)
+  })
 })

packages/openapi/src/fetch/openapi-handler.ts

@@ -87,7 +87,10 @@ export class OpenAPIHandler<T extends Context> implements ConditionalFetchHandle
 
       const { body, headers } = this.payloadCodec.encode(output)
 
-      return new Response(body, { headers })
+      return new Response(body, {
+        headers,
+        status: match.procedure['~orpc'].contract['~orpc'].route?.successStatus ?? 200,
+      })
     }
 
     try {

packages/openapi/src/openapi-generator.ts

@@ -180,7 +180,7 @@ export class OpenAPIGenerator {
         parameters: parameters.length ? parameters : undefined,
         requestBody,
         responses: {
-          200: successResponse,
+          [def.route?.successStatus ?? 200]: successResponse,
         },
       }