How to use .prefix with contract first development?

[valerii15298]

https://orpc.unnoq.com/docs/openapi/routing#route-prefixes

I did not see it documented anywhere for contract first development, so not sure if it is even supported...

I tried this:

import { oc } from "@orpc/contract";

const usersContract = oc.prefix("/users");

// Property 'route' does not exist on type 'ContractRouterBuilder<Record<never, never>, Record<never, never>>'
const getUsersContract = usersContract.route;

But it does not work: I am getting typescript error above

[unnoq]

Almost the same as the link you mentioned, just with .router after that:

const userRouter = os.prefix('/users').router({
  get: getUsersContract,
})

[zacharyhansen]

Sorry if I am confused but doing it like this forces the router use the contract like a route instead which means the final implemention on the server and client end up mismatched.

For example lets say the getUsersContract looks something like this

export const usersContract = populateContractRouterPaths({
  findOne: oc
    .route({
      method: 'GET',
      path: '/{userId}',
      tags: ['Dataset'],
      description: 'Get dataset by ID',
    })
    .input(z.object({ userId: z.string().min(1).describe('userId') }))
    .output(z.any()),
  another: oc
    .route({
      method: 'POST',
      path: '/another',
      tags: ['Dataset'],
    })
    .input(z.object({ userId: z.string() }))
    .output(z.any()),
});

Defining the router as you have it forces the definition of a client to use ContractRouterClient which ends up using the contract keys as the route path instead of the path definition.

While the server implementation is expecting to consume the path definition (/users/{userId}).

I end up with a client that is sending request to /users/findOne instead of /users/{datasetId}'.

Let me know if I am missing something - thanks in advance and its a great library!

[unnoq]

Sorry, but it seems I don't understand your issue.

• populateContractRouterPaths only fills in procedures that don't have a defined path.
• If you implement and create a client using the same contract, it should work and correctly resolve the connect path.

[am-hades]

Hi @unnoq — your suggestion doesn’t seem to work when trying to add a prefix to an Implementer.
Using:

const os = implement(contract);
export const router = os.prefix('/users').router(...)

results in the following TypeScript error:

Property 'prefix' does not exist on type 'Implementer<...>'.

Is this expected behavior, or am I missing something?

[unnoq]

@am-hades You cannot change the contract, this is expected behavior