feat(server): deprecate .createCaller() in favor of `t.createCaller…

…Factory()` (#5213)

examples/.experimental/next-formdata/src/server/trpc.ts

@@ -4,8 +4,8 @@
  * - We export only the functionality that we use so we can enforce which base procedures should be used
  *
  * Learn how to create protected base procedures and other things below:
- * @see https://trpc.io/docs/v10/router
- * @see https://trpc.io/docs/v10/procedures
+ * @see https://trpc.io/docs/router
+ * @see https://trpc.io/docs/procedures
  */
 import { initTRPC } from '@trpc/server';
 import * as trpcNext from '@trpc/server/adapters/next';

examples/.test/internal-types-export/src/server.ts

@@ -7,7 +7,7 @@ const someMiddleware = t.middleware(({ next }) => {
   return next();
 });
 
-export function genericRouter<S extends (value: any) => unknown>(schema: S) {
+export function genericRouter<TSchema extends (value: any) => unknown>(schema: TSchema) {
   return t.router({
     foo: t.procedure.output(schema).query(() => 'bar'),
   });

examples/.test/ssg/src/server/trpc.ts

@@ -4,32 +4,32 @@
  * - We export only the functionality that we use so we can enforce which base procedures should be used
  *
  * Learn how to create protected base procedures and other things below:
- * @see https://trpc.io/docs/v10/router
- * @see https://trpc.io/docs/v10/procedures
+ * @see https://trpc.io/docs/router
+ * @see https://trpc.io/docs/procedures
  */
 import { initTRPC } from '@trpc/server';
 import superjson from 'superjson';
 
 const t = initTRPC.create({
   /**
-   * @see https://trpc.io/docs/v10/data-transformers
+   * @see https://trpc.io/docs/data-transformers
    */
   transformer: superjson,
 });
 
 /**
  * Create a router
- * @see https://trpc.io/docs/v10/router
+ * @see https://trpc.io/docs/router
  */
 export const router = t.router;
 
 /**
  * Create an unprotected procedure
- * @see https://trpc.io/docs/v10/procedures
+ * @see https://trpc.io/docs/procedures
  **/
 export const publicProcedure = t.procedure;
 
 /**
- * @see https://trpc.io/docs/v10/middlewares
+ * @see https://trpc.io/docs/middlewares
  */
 export const middleware = t.middleware;

examples/next-edge-runtime/src/server/trpc.ts

@@ -4,8 +4,8 @@
  * - We export only the functionality that we use so we can enforce which base procedures should be used
  *
  * Learn how to create protected base procedures and other things below:
- * @see https://trpc.io/docs/v10/router
- * @see https://trpc.io/docs/v10/procedures
+ * @see https://trpc.io/docs/router
+ * @see https://trpc.io/docs/procedures
  */
 import { initTRPC } from '@trpc/server';
 

examples/next-minimal-starter/src/server/trpc.ts

@@ -4,8 +4,8 @@
  * - We export only the functionality that we use so we can enforce which base procedures should be used
  *
  * Learn how to create protected base procedures and other things below:
- * @see https://trpc.io/docs/v10/router
- * @see https://trpc.io/docs/v10/procedures
+ * @see https://trpc.io/docs/router
+ * @see https://trpc.io/docs/procedures
  */
 import { initTRPC } from '@trpc/server';
 

examples/next-prisma-starter/.github/workflows/main.yml

@@ -49,6 +49,9 @@ jobs:
       - run: pnpm build
       - run: pnpm test-e2e
 
+      - name: Check types
+        run: pnpm tsc
+
       - name: Upload test results
         if: ${{ always() }}
         uses: actions/upload-artifact@v2

examples/next-prisma-starter/src/server/routers/_app.ts

@@ -1,7 +1,7 @@
 /**
  * This file contains the root router of your tRPC-backend
  */
-import { publicProcedure, router } from '../trpc';
+import { createCallerFactory, publicProcedure, router } from '../trpc';
 import { postRouter } from './post';
 
 export const appRouter = router({
@@ -10,4 +10,6 @@ export const appRouter = router({
   post: postRouter,
 });
 
+export const createCaller = createCallerFactory(appRouter);
+
 export type AppRouter = typeof appRouter;

examples/next-prisma-starter/src/server/routers/post.test.ts

@@ -1,13 +1,13 @@
 /**
  * Integration test example for the `post` router
  */
-import { createContextInner } from '../context';
-import { AppRouter, appRouter } from './_app';
 import { inferProcedureInput } from '@trpc/server';
+import { createContextInner } from '../context';
+import { AppRouter, createCaller } from './_app';
 
 test('add and get post', async () => {
   const ctx = await createContextInner({});
-  const caller = appRouter.createCaller(ctx);
+  const caller = createCaller(ctx);
 
   const input: inferProcedureInput<AppRouter['post']['add']> = {
     text: 'hello test',

examples/next-prisma-starter/src/server/trpc.ts

@@ -4,8 +4,8 @@
  * - We export only the functionality that we use so we can enforce which base procedures should be used
  *
  * Learn how to create protected base procedures and other things below:
- * @see https://trpc.io/docs/v10/router
- * @see https://trpc.io/docs/v10/procedures
+ * @see https://trpc.io/docs/router
+ * @see https://trpc.io/docs/procedures
  */
 
 import { initTRPC } from '@trpc/server';
@@ -14,11 +14,11 @@ import { Context } from './context';
 
 const t = initTRPC.context<Context>().create({
   /**
-   * @see https://trpc.io/docs/v10/data-transformers
+   * @see https://trpc.io/docs/data-transformers
    */
   transformer,
   /**
-   * @see https://trpc.io/docs/v10/error-formatting
+   * @see https://trpc.io/docs/error-formatting
    */
   errorFormatter({ shape }) {
     return shape;
@@ -27,22 +27,29 @@ const t = initTRPC.context<Context>().create({
 
 /**
  * Create a router
- * @see https://trpc.io/docs/v10/router
+ * @see https://trpc.io/docs/router
  */
 export const router = t.router;
 
 /**
  * Create an unprotected procedure
- * @see https://trpc.io/docs/v10/procedures
+ * @see https://trpc.io/docs/procedures
  **/
 export const publicProcedure = t.procedure;
 
 /**
- * @see https://trpc.io/docs/v10/middlewares
+ * @see https://trpc.io/docs/middlewares
  */
 export const middleware = t.middleware;
 
 /**
- * @see https://trpc.io/docs/v10/merging-routers
+ * Merge multiple routers together
+ * @see https://trpc.io/docs/merging-routers
  */
 export const mergeRouters = t.mergeRouters;
+
+/**
+ * Create a server-side caller
+ * @see https://trpc.io/docs/server/server-side-calls
+ */
+export const createCallerFactory = t.createCallerFactory;

examples/next-prisma-websockets-starter/src/server/trpc.ts

@@ -4,8 +4,8 @@
  * - We export only the functionality that we use so we can enforce which base procedures should be used
  *
  * Learn how to create protected base procedures and other things below:
- * @see https://trpc.io/docs/v10/router
- * @see https://trpc.io/docs/v10/procedures
+ * @see https://trpc.io/docs/router
+ * @see https://trpc.io/docs/procedures
  */
 
 import { Context } from './context';
@@ -14,11 +14,11 @@ import superjson from 'superjson';
 
 const t = initTRPC.context<Context>().create({
   /**
-   * @see https://trpc.io/docs/v10/data-transformers
+   * @see https://trpc.io/docs/data-transformers
    */
   transformer: superjson,
   /**
-   * @see https://trpc.io/docs/v10/error-formatting
+   * @see https://trpc.io/docs/error-formatting
    */
   errorFormatter({ shape }) {
     return shape;
@@ -27,23 +27,23 @@ const t = initTRPC.context<Context>().create({
 
 /**
  * Create a router
- * @see https://trpc.io/docs/v10/router
+ * @see https://trpc.io/docs/router
  */
 export const router = t.router;
 
 /**
  * Create an unprotected procedure
- * @see https://trpc.io/docs/v10/procedures
+ * @see https://trpc.io/docs/procedures
  **/
 export const publicProcedure = t.procedure;
 
 /**
- * @see https://trpc.io/docs/v10/middlewares
+ * @see https://trpc.io/docs/middlewares
  */
 export const middleware = t.middleware;
 
 /**
- * @see https://trpc.io/docs/v10/merging-routers
+ * @see https://trpc.io/docs/merging-routers
  */
 export const mergeRouters = t.mergeRouters;
 

examples/soa/server-lib/index.ts

@@ -8,22 +8,22 @@ const t = initTRPC.context<Context>().create();
 
 /**
  * Create a router
- * @see https://trpc.io/docs/v10/router
+ * @see https://trpc.io/docs/router
  */
 export const router = t.router;
 
 /**
  * Create an unprotected procedure
- * @see https://trpc.io/docs/v10/procedures
+ * @see https://trpc.io/docs/procedures
  **/
 export const publicProcedure = t.procedure;
 
 /**
- * @see https://trpc.io/docs/v10/middlewares
+ * @see https://trpc.io/docs/middlewares
  */
 export const middleware = t.middleware;
 
 /**
- * @see https://trpc.io/docs/v10/merging-routers
+ * @see https://trpc.io/docs/merging-routers
  */
 export const mergeRouters = t.mergeRouters;

package.json

@@ -38,7 +38,7 @@
     "current-branch": "echo \"$(git rev-parse --abbrev-ref HEAD)\" | sed -E 's/refs\\/heads\\///' | sed -E 's/\\W|_/-/g' | sed -e 's/\\//-/'",
     "publish-canary": "lerna publish --force-publish --canary --preid alpha-$(pnpm --silent canary-preid) --dist-tag $(pnpm --silent current-branch)",
     "publish-prerelease": "pnpm install && lerna publish prerelease --force-publish --dist-tag next --no-push && sleep 60 && git push --follow-tags",
-    "merge-main": "git checkout main && git pull && git checkout next && git pull && git checkout -b next-merge-$(date '+%Y-%m-%d--%H-%M') next && git merge --ff main"
+    "merge-main": "git checkout main && git pull && git checkout next && git pull && git checkout -b next-merge-$(date '+%Y-%m-%d--%H-%M') next && git merge --ff-only main"
   },
   "dependencies": {
     "@changesets/changelog-github": "^0.5.0",

packages/server/src/core/index.ts

@@ -4,8 +4,10 @@ export type {
   ProcedureRouterRecord,
   CreateRouterInner,
   Router,
+  RouterCaller,
+  AnyRouterDef,
 } from './router';
-export { callProcedure } from './router';
+export { callProcedure, createCallerFactory } from './router';
 export type {
   Procedure,
   AnyProcedure,

packages/server/src/core/initTRPC.ts

@@ -23,7 +23,7 @@ import { mergeRouters } from './internals/mergeRouters';
 import { createBuilder } from './internals/procedureBuilder';
 import { Overwrite, PickFirstDefined, ValidateShape } from './internals/utils';
 import { createMiddlewareFactory } from './middleware';
-import { createRouterFactory } from './router';
+import { createCallerFactory, createRouterFactory } from './router';
 
 type PartialRootConfigTypes = Partial<RootConfigTypes>;
 
@@ -148,22 +148,31 @@ function createTRPCInner<TParams extends PartialRootConfigTypes>() {
       _config: config,
       /**
        * Builder object for creating procedures
+       * @see https://trpc.io/docs/server/procedures
        */
       procedure: createBuilder<$Config>({
         meta: runtime?.defaultMeta,
       }),
       /**
        * Create reusable middlewares
+       * @see https://trpc.io/docs/server/middlewares
        */
       middleware: createMiddlewareFactory<$Config>(),
       /**
        * Create a router
+       * @see https://trpc.io/docs/server/routers
        */
       router: createRouterFactory<$Config>(config),
       /**
        * Merge Routers
+       * @see https://trpc.io/docs/server/merging-routers
        */
       mergeRouters,
+      /**
+       * Create a server-side caller for a router
+       * @see https://trpc.io/docs/server/server-side-calls
+       */
+      createCallerFactory: createCallerFactory<$Config>(),
     };
   };
 }

packages/server/src/core/internals/procedureBuilder.ts

@@ -316,14 +316,8 @@ export interface ProcedureCallOptions {
 }
 
 const codeblock = `
-If you want to call this function on the server, you do the following:
 This is a client-only function.
-
-const caller = appRouter.createCaller({
-  /* ... your context */
-});
-
-const result = await caller.call('myProcedure', input);
+If you want to call this function on the server, see https://trpc.io/docs/server/server-side-calls
 `.trim();
 
 function createProcedureCaller(_def: AnyProcedureBuilderDef): AnyProcedure {