@trpc/server 10.0.0-alpha.3 → 10.0.0-alpha.32

package/src/{router.ts → deprecated/router.ts}

@@ -1,56 +1,78 @@
 /* eslint-disable @typescript-eslint/ban-types */
+
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { assertNotBrowser } from './assertNotBrowser';
-import { getHTTPStatusCodeFromError } from './http/internals/getHTTPStatusCode';
+import { assertNotBrowser } from '../assertNotBrowser';
+import { TRPCError } from '../error/TRPCError';
+import { defaultFormatter } from '../error/formatter';
+import { getHTTPStatusCodeFromError } from '../http/internals/getHTTPStatusCode';
+import { Observable, inferObservableValue } from '../observable';
+import {
+  TRPCErrorShape,
+  TRPC_ERROR_CODES_BY_KEY,
+  TRPC_ERROR_CODE_KEY,
+  TRPC_ERROR_CODE_NUMBER,
+} from '../rpc';
+import {
+  CombinedDataTransformer,
+  DataTransformerOptions,
+  defaultTransformer,
+} from '../transformer';
+import { Prefixer, ThenArg, flatten } from '../types';
 import { MiddlewareFunction } from './internals/middlewares';
 import {
-  createProcedure,
   CreateProcedureOptions,
   CreateProcedureWithInput,
   CreateProcedureWithInputOutputParser,
   CreateProcedureWithoutInput,
-  inferProcedureFromOptions,
   Procedure,
   ProcedureCallOptions,
+  createProcedure,
+  inferProcedureFromOptions,
 } from './internals/procedure';
-import {
-  TRPCErrorShape,
-  TRPC_ERROR_CODES_BY_KEY,
-  TRPC_ERROR_CODE_KEY,
-  TRPC_ERROR_CODE_NUMBER,
-} from './rpc';
-import { Subscription } from './subscription';
-import { CombinedDataTransformer, DataTransformerOptions } from './transformer';
-import { TRPCError } from './TRPCError';
-import { flatten, Prefixer, ThenArg } from './types';
+import { MigrateRouter, migrateRouter } from './interop';
 
 assertNotBrowser();
 
+export type { Procedure } from './internals/procedure';
+
 /**
  * @public
+ * @deprecated
  */
 export type ProcedureType = 'query' | 'mutation' | 'subscription';
 
 /**
  * @internal
+ * @deprecated
  */
 export type ProcedureRecord<
   TInputContext = any,
   TContext = any,
+  TMeta = any,
   TInput = any,
   TParsedInput = any,
   TOutput = any,
+  TParsedOutput = any,
 > = Record<
   string,
-  Procedure<TInputContext, TContext, TInput, TParsedInput, TOutput>
+  Procedure<
+    TInputContext,
+    TContext,
+    TMeta,
+    TInput,
+    TParsedInput,
+    TOutput,
+    TParsedOutput
+  >
 >;
 
 /**
  * @public
+ * @deprecated
  */
 export type inferProcedureInput<
-  TProcedure extends Procedure<any, any, any, any, any>,
-> = TProcedure extends Procedure<any, any, infer Input, any, any>
+  TProcedure extends Procedure<any, any, any, any, any, any, any>,
+> = TProcedure extends Procedure<any, any, any, infer Input, any, any, any>
   ? undefined extends Input
     ? Input | null | void // void is necessary to allow procedures with nullish input to be called without an input
     : Input
@@ -58,28 +80,29 @@ export type inferProcedureInput<
 
 /**
  * @public
+ * @deprecated
  */
 export type inferAsyncReturnType<TFunction extends (...args: any) => any> =
   ThenArg<ReturnType<TFunction>>;
 
 /**
  * @public
+ * @deprecated
  */
 export type inferProcedureOutput<
-  TProcedure extends Procedure<any, any, any, any, any>,
+  TProcedure extends Procedure<any, any, any, any, any, any, any>,
 > = inferAsyncReturnType<TProcedure['call']>;
 
 /**
  * @public
  * @beta
+ * @deprecated
  */
 export type inferSubscriptionOutput<
   TRouter extends AnyRouter,
   TPath extends keyof TRouter['_def']['subscriptions'],
-> = ReturnType<
-  inferAsyncReturnType<
-    TRouter['_def']['subscriptions'][TPath]['call']
-  >['output']
+> = inferObservableValue<
+  inferAsyncReturnType<TRouter['_def']['subscriptions'][TPath]['call']>
 >;
 
 function getDataTransformer(
@@ -92,10 +115,11 @@ function getDataTransformer(
 }
 /**
  * @internal
+ * @deprecated
  */
 export type inferHandlerInput<
-  TProcedure extends Procedure<any, any, any, any, any>,
-> = TProcedure extends Procedure<any, any, infer TInput, any, any>
+  TProcedure extends Procedure<any, any, any, any, any, any, any>,
+> = TProcedure extends Procedure<any, any, any, infer TInput, any, any, any>
   ? undefined extends TInput // ? is input optional
     ? unknown extends TInput // ? is input unset
       ? [(null | undefined)?] // -> there is no input
@@ -113,13 +137,30 @@ type inferHandlerFn<TProcedures extends ProcedureRecord> = <
 
 /**
  * @internal
+ * @deprecated
  */
 export type inferRouterContext<TRouter extends AnyRouter> = Parameters<
   TRouter['createCaller']
 >[0];
 
+/**
+ * @internal
+ */
+export type inferRouterMeta<TRouter extends AnyRouter> = TRouter extends Router<
+  any,
+  any,
+  infer TMeta,
+  any,
+  any,
+  any,
+  any
+>
+  ? TMeta
+  : {};
+
 /**
  * @public
+ * @deprecated
  */
 export type AnyRouter<TContext = any> = Router<
   any,
@@ -127,11 +168,13 @@ export type AnyRouter<TContext = any> = Router<
   any,
   any,
   any,
+  any,
   any
 >;
 
 /**
  * @internal
+ * @deprecated
  */
 export type inferRouterError<TRouter extends AnyRouter> = ReturnType<
   TRouter['getErrorShape']
@@ -147,6 +190,7 @@ const PROCEDURE_DEFINITION_MAP: Record<
 
 /**
  * @internal
+ * @deprecated
  */
 export type ErrorFormatter<TContext, TShape extends TRPCErrorShape<number>> = ({
   error,
@@ -168,6 +212,7 @@ type DefaultErrorData = {
 
 /**
  * @internal
+ * @deprecated
  */
 export interface DefaultErrorShape
   extends TRPCErrorShape<TRPC_ERROR_CODE_NUMBER, DefaultErrorData> {
@@ -192,34 +237,32 @@ function safeObject<TObj1, TObj2>(obj1: TObj1, obj2: TObj2): TObj1 & TObj2;
 function safeObject(...args: unknown[]) {
   return Object.assign(Object.create(null), ...args);
 }
-const defaultFormatter: ErrorFormatter<any, any> = ({
-  shape,
-}: {
-  shape: DefaultErrorShape;
-}) => {
-  return shape;
-};
-const defaultTransformer: CombinedDataTransformer = {
-  input: { serialize: (obj) => obj, deserialize: (obj) => obj },
-  output: { serialize: (obj) => obj, deserialize: (obj) => obj },
-};
-
 type SwapProcedureContext<
-  TProcedure extends Procedure<any, any, any, any, any>,
+  TProcedure extends Procedure<any, any, any, any, any, any, any>,
   TNewContext,
 > = TProcedure extends Procedure<
   infer TInputContext,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   infer _TOldContext,
+  infer TMeta,
   infer TInput,
   infer TParsedInput,
-  infer TOutput
+  infer TOutput,
+  infer TParsedOutput
 >
-  ? Procedure<TInputContext, TNewContext, TInput, TParsedInput, TOutput>
+  ? Procedure<
+      TInputContext,
+      TNewContext,
+      TMeta,
+      TInput,
+      TParsedInput,
+      TOutput,
+      TParsedOutput
+    >
   : never;
 
 type SwapContext<
-  TObj extends ProcedureRecord<any, any, any, any>,
+  TObj extends ProcedureRecord<any, any, any, any, any, any>,
   TNewContext,
 > = {
   [P in keyof TObj]: SwapProcedureContext<TObj[P], TNewContext>;
@@ -227,17 +270,38 @@ type SwapContext<
 
 /**
  * @internal The type signature of this class may change without warning.
+ * @deprecated
  */
 export class Router<
   TInputContext,
   TContext,
-  TQueries extends ProcedureRecord<TInputContext, TContext>,
-  TMutations extends ProcedureRecord<TInputContext, TContext>,
+  TMeta extends Record<string, any>,
+  TQueries extends ProcedureRecord<
+    TInputContext,
+    TContext,
+    any,
+    any,
+    any,
+    any,
+    any
+  >,
+  TMutations extends ProcedureRecord<
+    TInputContext,
+    TContext,
+    any,
+    any,
+    any,
+    any,
+    any
+  >,
   TSubscriptions extends ProcedureRecord<
     TInputContext,
     TContext,
     unknown,
-    Subscription<unknown>
+    unknown,
+    Observable<unknown, unknown>,
+    unknown,
+    unknown
   >,
   TErrorShape extends TRPCErrorShape<number>,
 > {
@@ -245,7 +309,7 @@ export class Router<
     queries: TQueries;
     mutations: TMutations;
     subscriptions: TSubscriptions;
-    middlewares: MiddlewareFunction<TInputContext, TContext>[];
+    middlewares: MiddlewareFunction<TInputContext, TContext, TMeta>[];
     errorFormatter: ErrorFormatter<TContext, TErrorShape>;
     transformer: CombinedDataTransformer;
   };
@@ -254,7 +318,7 @@ export class Router<
     queries?: TQueries;
     mutations?: TMutations;
     subscriptions?: TSubscriptions;
-    middlewares?: MiddlewareFunction<TInputContext, TContext>[];
+    middlewares?: MiddlewareFunction<TInputContext, TContext, TMeta>[];
     errorFormatter?: ErrorFormatter<TContext, TErrorShape>;
     transformer?: CombinedDataTransformer;
   }) {
@@ -279,29 +343,40 @@ export class Router<
     return eps as any;
   }
 
-  public query<TPath extends string, TInput, TParsedInput, TOutput>(
+  public query<
+    TPath extends string,
+    TInput,
+    TParsedInput,
+    TOutput,
+    TParsedOutput,
+  >(
     path: TPath,
     procedure: CreateProcedureWithInputOutputParser<
       TContext,
+      TMeta,
       TInput,
       TParsedInput,
-      TOutput
+      TOutput,
+      TParsedOutput
     >,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries &
       Record<TPath, inferProcedureFromOptions<TInputContext, typeof procedure>>,
     TMutations,
     TSubscriptions,
     TErrorShape
   >;
+
   public query<TPath extends string, TInput, TOutput>(
     path: TPath,
-    procedure: CreateProcedureWithInput<TContext, TInput, TInput, TOutput>,
+    procedure: CreateProcedureWithInput<TContext, TMeta, TInput, TOutput>,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries &
       Record<TPath, inferProcedureFromOptions<TInputContext, typeof procedure>>,
     TMutations,
@@ -309,12 +384,18 @@ export class Router<
     TErrorShape
   >;
 
-  public query<TPath extends string, TOutput>(
+  public query<TPath extends string, TOutput, TParsedOutput>(
     path: TPath,
-    procedure: CreateProcedureWithoutInput<TContext, TOutput>,
+    procedure: CreateProcedureWithoutInput<
+      TContext,
+      TMeta,
+      TOutput,
+      TParsedOutput
+    >,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries &
       Record<TPath, inferProcedureFromOptions<TInputContext, typeof procedure>>,
     TMutations,
@@ -324,9 +405,9 @@ export class Router<
 
   query(
     path: string,
-    procedure: CreateProcedureOptions<TContext, any, any, any>,
+    procedure: CreateProcedureOptions<TContext, TMeta, any, any, any, any>,
   ) {
-    const router = new Router<TContext, TContext, any, {}, {}, any>({
+    const router = new Router<TContext, TContext, TMeta, any, {}, {}, any>({
       queries: safeObject({
         [path]: createProcedure(procedure),
       }),
@@ -335,29 +416,40 @@ export class Router<
     return this.merge(router);
   }
 
-  public mutation<TPath extends string, TInput, TParsedInput, TOutput>(
+  public mutation<
+    TPath extends string,
+    TInput,
+    TParsedInput,
+    TOutput,
+    TParsedOutput,
+  >(
     path: TPath,
     procedure: CreateProcedureWithInputOutputParser<
       TContext,
+      TMeta,
       TInput,
       TParsedInput,
-      TOutput
+      TOutput,
+      TParsedOutput
     >,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries,
     TMutations &
       Record<TPath, inferProcedureFromOptions<TInputContext, typeof procedure>>,
     TSubscriptions,
     TErrorShape
   >;
+
   public mutation<TPath extends string, TInput, TOutput>(
     path: TPath,
-    procedure: CreateProcedureWithInput<TContext, TInput, TInput, TOutput>,
+    procedure: CreateProcedureWithInput<TContext, TMeta, TInput, TOutput>,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries,
     TMutations &
       Record<TPath, inferProcedureFromOptions<TInputContext, typeof procedure>>,
@@ -365,12 +457,18 @@ export class Router<
     TErrorShape
   >;
 
-  public mutation<TPath extends string, TOutput>(
+  public mutation<TPath extends string, TOutput, TParsedOutput>(
     path: TPath,
-    procedure: CreateProcedureWithoutInput<TContext, TOutput>,
+    procedure: CreateProcedureWithoutInput<
+      TContext,
+      TMeta,
+      TOutput,
+      TParsedOutput
+    >,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries,
     TMutations &
       Record<TPath, inferProcedureFromOptions<TInputContext, typeof procedure>>,
@@ -380,9 +478,9 @@ export class Router<
 
   public mutation(
     path: string,
-    procedure: CreateProcedureOptions<TContext, any, any, any>,
+    procedure: CreateProcedureOptions<TContext, TMeta, any, any, any, any>,
   ) {
-    const router = new Router<TContext, TContext, {}, any, {}, any>({
+    const router = new Router<TContext, TContext, TMeta, {}, any, {}, any>({
       mutations: safeObject({
         [path]: createProcedure(procedure),
       }),
@@ -398,18 +496,24 @@ export class Router<
     TPath extends string,
     TInput,
     TParsedInput,
-    TOutput extends Subscription<unknown>,
+    TOutput extends Observable<unknown, unknown>,
   >(
     path: TPath,
-    procedure: CreateProcedureWithInputOutputParser<
-      TContext,
-      TInput,
-      TParsedInput,
-      TOutput
+    procedure: Omit<
+      CreateProcedureWithInputOutputParser<
+        TContext,
+        TMeta,
+        TInput,
+        TParsedInput,
+        TOutput,
+        unknown
+      >,
+      'output'
     >,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries,
     TMutations,
     TSubscriptions &
@@ -423,13 +527,17 @@ export class Router<
   public subscription<
     TPath extends string,
     TInput,
-    TOutput extends Subscription<unknown>,
+    TOutput extends Observable<unknown, unknown>,
   >(
     path: TPath,
-    procedure: CreateProcedureWithInput<TContext, TInput, TInput, TOutput>,
+    procedure: Omit<
+      CreateProcedureWithInput<TContext, TMeta, TInput, TOutput>,
+      'output'
+    >,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries,
     TMutations,
     TSubscriptions &
@@ -442,13 +550,17 @@ export class Router<
    */
   public subscription<
     TPath extends string,
-    TOutput extends Subscription<unknown>,
+    TOutput extends Observable<unknown, unknown>,
   >(
     path: TPath,
-    procedure: CreateProcedureWithoutInput<TContext, TOutput>,
+    procedure: Omit<
+      CreateProcedureWithoutInput<TContext, TMeta, TOutput, unknown>,
+      'output'
+    >,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries,
     TMutations,
     TSubscriptions &
@@ -458,9 +570,12 @@ export class Router<
 
   public subscription(
     path: string,
-    procedure: CreateProcedureOptions<TContext, any, any, any>,
+    procedure: Omit<
+      CreateProcedureOptions<TContext, TMeta, any, any, any, any>,
+      'output'
+    >,
   ) {
-    const router = new Router<TContext, TContext, {}, {}, any, any>({
+    const router = new Router<TContext, TContext, TMeta, {}, {}, any, any>({
       subscriptions: safeObject({
         [path]: createProcedure(procedure),
       }),
@@ -473,11 +588,14 @@ export class Router<
    * Merge router with other router
    * @param router
    */
-  public merge<TChildRouter extends Router<TContext, any, any, any, any, any>>(
+  public merge<
+    TChildRouter extends Router<TContext, any, TMeta, any, any, any, any>,
+  >(
     router: TChildRouter,
   ): Router<
     TInputContext,
     inferRouterContext<TChildRouter>,
+    TMeta,
     TQueries & TChildRouter['_def']['queries'],
     TMutations & TChildRouter['_def']['mutations'],
     TSubscriptions & TChildRouter['_def']['subscriptions'],
@@ -491,13 +609,14 @@ export class Router<
    */
   public merge<
     TPath extends string,
-    TChildRouter extends Router<TContext, any, any, any, any, any>,
+    TChildRouter extends Router<TContext, any, TMeta, any, any, any, any>,
   >(
     prefix: TPath,
     router: TChildRouter,
   ): Router<
     TInputContext,
     inferRouterContext<TChildRouter>,
+    TMeta,
     TQueries & Prefixer<TChildRouter['_def']['queries'], `${TPath}`>,
     TMutations & Prefixer<TChildRouter['_def']['mutations'], `${TPath}`>,
     TSubscriptions &
@@ -550,7 +669,7 @@ export class Router<
       return Router.prefixProcedures(newDefs, prefix);
     };
 
-    return new Router<TInputContext, any, any, any, any, TErrorShape>({
+    return new Router<TInputContext, any, TMeta, any, any, any, TErrorShape>({
       ...this._def,
       queries: safeObject(
         this._def.queries,
@@ -577,7 +696,7 @@ export class Router<
     const defTarget = PROCEDURE_DEFINITION_MAP[type];
     const defs = this._def[defTarget];
     const procedure = defs[path] as
-      | Procedure<TInputContext, TContext, any, any, any>
+      | Procedure<TInputContext, TContext, TMeta, any, any, any, any>
       | undefined;
 
     if (!procedure) {
@@ -628,10 +747,11 @@ export class Router<
    * @link https://trpc.io/docs/middlewares
    */
   public middleware<TNewContext>(
-    middleware: MiddlewareFunction<TContext, TNewContext>,
+    middleware: MiddlewareFunction<TContext, TNewContext, TMeta>,
   ): Router<
     TInputContext,
     TNewContext,
+    TMeta,
     SwapContext<TQueries, TNewContext>,
     SwapContext<TMutations, TNewContext>,
     SwapContext<TSubscriptions, TNewContext>,
@@ -658,6 +778,7 @@ export class Router<
     return new Router<
       TInputContext,
       TContext,
+      TMeta,
       TQueries,
       TMutations,
       TSubscriptions,
@@ -712,6 +833,7 @@ export class Router<
     return new Router<
       TInputContext,
       TContext,
+      TMeta,
       TQueries,
       TMutations,
       TSubscriptions,
@@ -731,6 +853,7 @@ export class Router<
   public flat(): Router<
     TInputContext,
     TContext,
+    TMeta,
     flatten<{}, TQueries>,
     flatten<{}, TMutations>,
     flatten<{}, TSubscriptions>,
@@ -738,33 +861,26 @@ export class Router<
   > {
     return this as any;
   }
+
+  /**
+   * Interop mode for v9.x -> v10.x
+   */
+  public interop(): MigrateRouter<
+    TInputContext,
+    TContext,
+    TMeta,
+    TQueries,
+    TMutations,
+    TSubscriptions,
+    TErrorShape
+  > {
+    return migrateRouter(this);
+  }
 }
 
 /**
- * Subclass of `VNextRouter` with `TInputContext` and `TContext` set to the same type, for backcompat.
- *
  * @deprecated
  */
-export class LegacyRouter<
-  TContext,
-  TQueries extends ProcedureRecord<TContext, TContext>,
-  TMutations extends ProcedureRecord<TContext, TContext>,
-  TSubscriptions extends ProcedureRecord<
-    TContext,
-    TContext,
-    unknown,
-    Subscription<unknown>
-  >,
-  TErrorShape extends TRPCErrorShape<number>,
-> extends Router<
-  TContext,
-  TContext,
-  TQueries,
-  TMutations,
-  TSubscriptions,
-  TErrorShape
-> {}
-
-export function router<TContext>() {
-  return new Router<TContext, TContext, {}, {}, {}, DefaultErrorShape>();
+export function router<TContext, TMeta extends Record<string, any> = {}>() {
+  return new Router<TContext, TContext, TMeta, {}, {}, {}, DefaultErrorShape>();
 }