How to configure dot notation pattern with hey-api integration ?

[wellington-vell]

using orpc with a ts backend i could do this

  health: {
    v1: (() => {
      const router = os.prefix("/v1").router({
        handler: publicProcedure
          .route({
            method: "GET",
            path: "/check",
            tags: ["Health"],
            summary: "v1",
          })
      });
      return router.handler;
    })(),

and that would would generate a nice dot notation pattern to use

const query = useQuery(orpc.health.v1.queryOptions())

now i have a backend with another language, and want a similar behavior..

the closer i got was what @mrlubos suggest me on https://github.com/orgs/hey-api/discussions/3439

is this possible ?

[dosubot[bot]]

oRPC has a @orpc/hey-api package that converts Hey API generated clients into oRPC clients with dot notation support.

The workflow is:

1. Generate your Hey API client from your OpenAPI spec:

npx @hey-api/openapi-ts -i ./your-openapi-spec.json -o src/client

2. Convert the SDK to an oRPC client using experimental_toORPCClient:

import { experimental_toORPCClient } from '@orpc/hey-api'
import * as sdk from 'src/client/sdk.gen'

export const client = experimental_toORPCClient(sdk)

The conversion function recursively transforms Hey API functions, so if your Hey API client has nested structure (via operations.nesting as @mrlubos suggested), it should preserve that hierarchy in the resulting oRPC client.

For TanStack Query, oRPC provides its own query option builders:

const query = useQuery(client.health.v1.queryOptions())

That said, the oRPC integration doesn't directly configure Hey API's operations.nesting — it just wraps whatever structure Hey API generates. So you'd configure nesting on the Hey API side, then convert the result.

Note: This integration is marked as experimental since Hey API is still evolving.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}

   

[mrlubos]

@wellington-vell Can you share your spec?

[wellington-vell]

if you prefer the repo that i am experimenting is this https://github.com/wellington-vell/e2e-ts-rs

{
  "openapi": "3.1.0",
  "info": {
    "title": "server",
    "description": "",
    "license": {
      "name": ""
    },
    "version": "0.1.0"
  },
  "paths": {
    "/api/v1/health": {
      "get": {
        "tags": [
          "Health"
        ],
        "operationId": "check",
        "responses": {
          "200": {
            "description": "Service is healthy",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HealthResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/todos": {
      "get": {
        "tags": [
          "Todo"
        ],
        "operationId": "get_all",
        "responses": {
          "200": {
            "description": "List all todos",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Todo"
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Todo"
        ],
        "operationId": "create",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateTodo"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Create a new todo",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Todo"
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/todos/{id}": {
      "get": {
        "tags": [
          "Todo"
        ],
        "operationId": "get_by_id",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Todo ID",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Get a todo by id",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Todo"
                }
              }
            }
          },
          "404": {
            "description": "Todo not found"
          }
        }
      },
      "put": {
        "tags": [
          "Todo"
        ],
        "operationId": "update",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Todo ID",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateTodo"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Update a todo",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Todo"
                }
              }
            }
          },
          "404": {
            "description": "Todo not found"
          }
        }
      },
      "delete": {
        "tags": [
          "Todo"
        ],
        "operationId": "destroy",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Todo ID",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Delete a todo"
          },
          "404": {
            "description": "Todo not found"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CreateTodo": {
        "type": "object",
        "required": [
          "title"
        ],
        "properties": {
          "title": {
            "type": "string",
            "maxLength": 255,
            "minLength": 5
          }
        }
      },
      "HealthResponse": {
        "type": "object",
        "required": [
          "status"
        ],
        "properties": {
          "status": {
            "type": "string"
          },
          "version": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      },
      "Todo": {
        "type": "object",
        "required": [
          "id",
          "title",
          "completed"
        ],
        "properties": {
          "completed": {
            "type": "boolean"
          },
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "title": {
            "type": "string"
          }
        }
      },
      "UpdateTodo": {
        "type": "object",
        "properties": {
          "completed": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "title": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    }
  }
}

[unnoq]

Currently, oRPC does not support the Hey API nested client. We need to expand the logic here to support it:
https://github.com/middleapi/orpc/blob/main/packages/hey-api/src/to-orpc-client.ts#L29

A PR is welcome. If possible, could you also guide me on how to generate a nested client with Hey API by extending this spec:
https://github.com/middleapi/orpc/blob/main/packages/hey-api/tests/spec.json

That would help me validate and add support for this feature soon.

[wellington-vell]

wellington-vell@500672b

This probably isn't the best implementation, but I hope it helps you understand where I'm going with this.

[wellington-vell]

one thing to keep in mind would be the integration with Tanstack query, with the current setup we can just

import { experimental_toORPCClient } from "@orpc/hey-api";
import { createTanstackQueryUtils } from "@orpc/tanstack-query";
import * as sdk from "@/lib/api/sdk.gen";

const apiClient = experimental_toORPCClient(sdk);

export const orpc = createTanstackQueryUtils(apiClient);

and use it normally

const query = useQuery(orpc.planetV1List.queryOptions())

but i dont know if this change would make this complicated