feat(server): short-hand routers and spread support

[KATT]

• Allow for creating routers that are just objects
• Will simplify .d.ts-files for people who use satisfies TRPCRouterRecord

Closes #3630

Could help make #4129 easier

How it looks like

This will allow you to define routers like this:

const post = {
  byId: t.procedure.query(() => '..'),
} satisfies RouterRecord; // <--  ✨ using satisfies for sub-routers could(?) be less heavy for the compiler and `.d.ts`-files



const appRouter = t.router({
  post,
  // ✨ short-cut routers by doing a `{}`
  deeply: {
    nested: {
      greeting: t.query(() => '...'),
    },
  },
});

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
next-prisma-starter	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 29, 2024 1:30pm
og-image	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 29, 2024 1:30pm
trpc-next-app-dir	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 29, 2024 1:30pm
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 29, 2024 1:30pm

[juliusmarminge]

why do you need this extends infer here?

[KATT]

I just think it makes the "looping" clearer

[KATT]

Only need to grab TRecord[Key] once, it's like a declaring a variable

[juliusmarminge]

Only need to grab TRecord[Key] once, it's like a declaring a variable

aah i see, how is the compiler performance comparatively?

[KATT]

No idea tbh 🙈

[juliusmarminge]

niceee - can we deprecate this monstosity then?

https://github.com/trpc/trpc/blob/next/packages/server/src/unstable-core-do-not-import/router.ts#L272-L309

or maybe just make it an alias?

[KATT]

yes that'd be nice

[KATT]

we could alias it

[juliusmarminge]

Great work, only nitpick I'd point out is that there's a lot of these:

  TRouter['_def']['_config']['$types'],
  TRouter['_def']['record']

don't we have inference helpers for those?

  inferRootTypes<TRouter>
  ...

?

[KATT]

Great work, only nitpick I'd point out is that there's a lot of these:

  TRouter['_def']['_config']['$types'],
  TRouter['_def']['record']

don't we have inference helpers for those?

  inferRootTypes<TRouter>
  ...

?

I'd be fine to change that, I'd also be happy if we changed the router so the grabbing would just be e.g.

• TRouter['_def']['$types']
• TRouter['_def']['_config']['$types']
• TRouter[RootTypesSymbol]
• TRouter['_config']['$types']

I think that sort of approach would be even nicer than using a helper - it feels like an unnecessary abstraction

[juliusmarminge]

i see that you can't spread actual routers:

// router/post.ts
import { createTRPCRouter, protectedProcedure, publicProcedure } from "../trpc";

export const authRouter = createTRPCRouter({
  getSession: publicProcedure.query(({ ctx }) => {
    return ctx.session;
  }),
  getSecretMessage: protectedProcedure.query(() => {
    // testing type validation of overridden next-auth Session in @acme/auth package
    return "you can see this secret message!";
  }),
});

// root.ts
import { authRouter } from "./router/auth";
import { postRouter } from "./router/post";
import { createTRPCRouter } from "./trpc";

export const appRouter = createTRPCRouter({
  auth: authRouter,
  post: postRouter,
  ...authRouter, // <-- doesn't work
});

// export type definition of API
export type AppRouter = typeof appRouter;

how do you make the typesystem / proxy understand spread? if we to alias mergeRouters to this implementation we should support spreading routers and not just records?

[KATT]

i see that you can't spread actual routers:

// router/post.ts
import { createTRPCRouter, protectedProcedure, publicProcedure } from "../trpc";

export const authRouter = createTRPCRouter({
  getSession: publicProcedure.query(({ ctx }) => {
    return ctx.session;
  }),
  getSecretMessage: protectedProcedure.query(() => {
    // testing type validation of overridden next-auth Session in @acme/auth package
    return "you can see this secret message!";
  }),
});

// root.ts
import { authRouter } from "./router/auth";
import { postRouter } from "./router/post";
import { createTRPCRouter } from "./trpc";

export const appRouter = createTRPCRouter({
  auth: authRouter,
  post: postRouter,
  ...authRouter, // <-- doesn't work
});

// export type definition of API
export type AppRouter = typeof appRouter;

how do you make the typesystem / proxy understand spread? if we to alias mergeRouters to this implementation we should support spreading routers and not just records?

No idea, but I think most people use sub-routers with the other way, so might be a non-issue

[github-actions]

This pull request has been locked because we are very unlikely to see comments on closed issues. If you think, this PR is still necessary, create a new one with the same branch. Thank you.