feat(hey-api): improve compatibility

packages/hey-api/src/to-orpc-client.test-d.ts

@@ -9,23 +9,23 @@ describe('toORPCClient', () => {
     somethingElse: 123,
   })
 
-  const c = sdk.listPlanets()
+  const c = sdk.planetList()
 
   it('satisfies nested client', () => {
     const _b: NestedClient<Record<never, never>> = client
   })
 
   it('inputs', async () => {
-    client.listPlanets()
+    client.planetList()
 
-    client.listPlanets({
+    client.planetList({
       query: {
         limit: 10,
         offset: 0,
       },
     })
 
-    client.listPlanets({
+    client.planetList({
       query: {
         // @ts-expect-error - invalid type
         limit: 'invalid',
@@ -40,8 +40,8 @@ describe('toORPCClient', () => {
   })
 
   it('outputs', async () => {
-    expectTypeOf(await client.listPlanets()).toEqualTypeOf<{ body: Planet[], request: Request, response: Response }>()
+    expectTypeOf(await client.planetList()).toEqualTypeOf<{ body: Planet[], request: Request, response: Response }>()
     expectTypeOf(await client.getPlanet({ path: { planetId: 'earth' } })).toEqualTypeOf<{ body: Planet, request: Request, response: Response }>()
-    expectTypeOf(await client.createPlanet({ body: { name: 'Earth' } })).toEqualTypeOf<{ body: Planet, request: Request, response: Response }>()
+    expectTypeOf(await client.planetCreate({ body: { name: 'Earth' } })).toEqualTypeOf<{ body: Planet | { id: string }, request: Request, response: Response }>()
   })
 })

packages/hey-api/src/to-orpc-client.test.ts

@@ -47,7 +47,7 @@ describe('toORPCClient', () => {
   })
 
   it('works', async () => {
-    const result = await client.listPlanets()
+    const result = await client.planetList()
     expect(result).toEqual({
       body: [{ id: 'earth', name: 'Earth' }],
       request: expect.any(Request),
@@ -56,7 +56,7 @@ describe('toORPCClient', () => {
   })
 
   it('with lastEventId', async () => {
-    const result = await client.listPlanets({
+    const result = await client.planetList({
       headers: {
         'x-something': 'value',
         'last-event-id': '123',
@@ -69,7 +69,7 @@ describe('toORPCClient', () => {
   })
 
   it('with query', async () => {
-    const result = await client.listPlanets({
+    const result = await client.planetList({
       query: {
         limit: 10,
         offset: 0,
@@ -90,7 +90,7 @@ describe('toORPCClient', () => {
   })
 
   it('with body', async () => {
-    const result = await client.createPlanet({
+    const result = await client.planetCreate({
       body: { name: 'Bob' },
     })
 
@@ -102,7 +102,7 @@ describe('toORPCClient', () => {
       const controller1 = new AbortController()
       const controller2 = new AbortController()
 
-      const result = await client.createPlanet({
+      const result = await client.planetCreate({
         body: { name: 'Bob' },
         signal: controller1.signal,
       }, { signal: controller2.signal })
@@ -116,7 +116,7 @@ describe('toORPCClient', () => {
       const controller1 = new AbortController()
       const controller2 = new AbortController()
 
-      const result = await client.createPlanet({
+      const result = await client.planetCreate({
         body: { name: 'Bob' },
         signal: controller1.signal,
       }, { signal: controller2.signal })
@@ -132,7 +132,7 @@ describe('toORPCClient', () => {
       controller1.abort()
 
       await expect(
-        client.createPlanet({
+        client.planetCreate({
           body: { name: 'Bob' },
           signal: controller1.signal,
         }, { signal: controller2.signal }),
@@ -145,7 +145,7 @@ describe('toORPCClient', () => {
       controller2.abort()
 
       await expect(
-        client.createPlanet({
+        client.planetCreate({
           body: { name: 'Bob' },
           signal: controller1.signal,
         }, { signal: controller2.signal }),
@@ -154,6 +154,6 @@ describe('toORPCClient', () => {
   })
 
   it('throws on error', async () => {
-    await expect(client.listPlanets({ query: { throwOnError: 1 } as any })).rejects.toThrowError()
+    await expect(client.planetList({ query: { throwOnError: 1 } as any })).rejects.toThrowError()
   })
 })

packages/hey-api/src/to-orpc-client.ts

@@ -2,14 +2,16 @@ import type { Client, ThrowableError } from '@orpc/client'
 
 export type experimental_ToORPCClientResult<T extends Record<string, any>> = {
   [K in keyof T]:
-  T[K] extends (options: infer UInput extends Record<any, any> | undefined)
+  T[K] extends (options: infer UInput)
   => Promise<infer UResult>
     ? Client<Record<never, never>, UInput, {
       body: UResult extends { data: infer USuccess } ? Exclude<USuccess, undefined> : never
       request: Request
       response: Response
     }, ThrowableError>
-    : never
+    : T[K] extends Record<string, any>
+      ? experimental_ToORPCClientResult<T[K]>
+      : never
 }
 
 /**

packages/hey-api/tests/client/sdk.gen.ts

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
-import type { ListPlanetsData, ListPlanetsResponses, CreatePlanetData, CreatePlanetResponses, GetPlanetData, GetPlanetResponses, GetPlanetErrors } from './types.gen';
+import type { PlanetListData, PlanetListResponses, PlanetCreateData, PlanetCreateResponses, GetPlanetData, GetPlanetResponses, GetPlanetErrors } from './types.gen';
 import { client as _heyApiClient } from './client.gen';
 
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
@@ -18,15 +18,15 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
     meta?: Record<string, unknown>;
 };
 
-export const listPlanets = <ThrowOnError extends boolean = false>(options?: Options<ListPlanetsData, ThrowOnError>) => {
-    return (options?.client ?? _heyApiClient).get<ListPlanetsResponses, unknown, ThrowOnError>({
+export const planetList = <ThrowOnError extends boolean = false>(options?: Options<PlanetListData, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).get<PlanetListResponses, unknown, ThrowOnError>({
         url: '/planets',
         ...options
     });
 };
 
-export const createPlanet = <ThrowOnError extends boolean = false>(options: Options<CreatePlanetData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).post<CreatePlanetResponses, unknown, ThrowOnError>({
+export const planetCreate = <ThrowOnError extends boolean = false>(options: Options<PlanetCreateData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).post<PlanetCreateResponses, unknown, ThrowOnError>({
         url: '/planets',
         ...options,
         headers: {

packages/hey-api/tests/client/types.gen.ts

@@ -9,7 +9,11 @@ export type NewPlanet = {
     name: string;
 };
 
-export type ListPlanetsData = {
+export type UpdatedPlanet = {
+    id: string;
+};
+
+export type PlanetListData = {
     body?: never;
     path?: never;
     query?: {
@@ -19,30 +23,34 @@ export type ListPlanetsData = {
     url: '/planets';
 };
 
-export type ListPlanetsResponses = {
+export type PlanetListResponses = {
     /**
      * A list of planets
      */
     200: Array<Planet>;
 };
 
-export type ListPlanetsResponse = ListPlanetsResponses[keyof ListPlanetsResponses];
+export type PlanetListResponse = PlanetListResponses[keyof PlanetListResponses];
 
-export type CreatePlanetData = {
+export type PlanetCreateData = {
     body: NewPlanet;
     path?: never;
     query?: never;
     url: '/planets';
 };
 
-export type CreatePlanetResponses = {
+export type PlanetCreateResponses = {
+    /**
+     * A updated planet
+     */
+    200: UpdatedPlanet;
     /**
      * A created planet
      */
     201: Planet;
 };
 
-export type CreatePlanetResponse = CreatePlanetResponses[keyof CreatePlanetResponses];
+export type PlanetCreateResponse = PlanetCreateResponses[keyof PlanetCreateResponses];
 
 export type GetPlanetData = {
     body?: never;

packages/hey-api/tests/spec.json

@@ -7,7 +7,7 @@
   "paths": {
     "/planets": {
       "get": {
-        "operationId": "listPlanets",
+        "operationId": "planet/list",
         "parameters": [
           {
             "name": "limit",
@@ -52,7 +52,7 @@
         }
       },
       "post": {
-        "operationId": "createPlanet",
+        "operationId": "planet.create",
         "requestBody": {
           "content": {
             "application/json": {
@@ -73,6 +73,16 @@
                 }
               }
             }
+          },
+          "200": {
+            "description": "An updated planet",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UpdatedPlanet"
+                }
+              }
+            }
           }
         }
       }
@@ -137,6 +147,15 @@
           }
         },
         "required": ["name"]
+      },
+      "UpdatedPlanet": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          }
+        },
+        "required": ["id"]
       }
     }
   }