@trpc/server 10.0.0-alpha.20 → 10.0.0-alpha.23

package/src/router.ts

@@ -15,13 +15,13 @@ import {
   createProcedure,
   inferProcedureFromOptions,
 } from './internals/procedure';
+import { Observable, inferObservableValue } from './observable';
 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 { Prefixer, ThenArg, flatten } from './types';
 
@@ -38,6 +38,7 @@ export type ProcedureType = 'query' | 'mutation' | 'subscription';
 export type ProcedureRecord<
   TInputContext = any,
   TContext = any,
+  TMeta = any,
   TInput = any,
   TParsedInput = any,
   TOutput = any,
@@ -47,6 +48,7 @@ export type ProcedureRecord<
   Procedure<
     TInputContext,
     TContext,
+    TMeta,
     TInput,
     TParsedInput,
     TOutput,
@@ -58,8 +60,8 @@ export type ProcedureRecord<
  * @public
  */
 export type inferProcedureInput<
-  TProcedure extends Procedure<any, any, any, any, any, any>,
-> = TProcedure extends Procedure<any, any, infer Input, any, 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
@@ -75,7 +77,7 @@ export type inferAsyncReturnType<TFunction extends (...args: any) => any> =
  * @public
  */
 export type inferProcedureOutput<
-  TProcedure extends Procedure<any, any, any, any, any, any>,
+  TProcedure extends Procedure<any, any, any, any, any, any, any>,
 > = inferAsyncReturnType<TProcedure['call']>;
 
 /**
@@ -85,10 +87,8 @@ export type inferProcedureOutput<
 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(
@@ -103,8 +103,8 @@ function getDataTransformer(
  * @internal
  */
 export type inferHandlerInput<
-  TProcedure extends Procedure<any, any, any, any, any, any>,
-> = TProcedure extends Procedure<any, any, infer TInput, any, 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
@@ -127,6 +127,21 @@ 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
  */
@@ -136,6 +151,7 @@ export type AnyRouter<TContext = any> = Router<
   any,
   any,
   any,
+  any,
   any
 >;
 
@@ -214,12 +230,13 @@ const defaultTransformer: CombinedDataTransformer = {
 };
 
 type SwapProcedureContext<
-  TProcedure extends Procedure<any, 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,
@@ -228,6 +245,7 @@ type SwapProcedureContext<
   ? Procedure<
       TInputContext,
       TNewContext,
+      TMeta,
       TInput,
       TParsedInput,
       TOutput,
@@ -248,13 +266,23 @@ type SwapContext<
 export class Router<
   TInputContext,
   TContext,
-  TQueries extends ProcedureRecord<TInputContext, TContext, any, any, any, any>,
+  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<
@@ -262,7 +290,8 @@ export class Router<
     TContext,
     unknown,
     unknown,
-    Subscription<unknown>,
+    Observable<unknown, unknown>,
+    unknown,
     unknown
   >,
   TErrorShape extends TRPCErrorShape<number>,
@@ -271,7 +300,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;
   };
@@ -280,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;
   }) {
@@ -315,6 +344,7 @@ export class Router<
     path: TPath,
     procedure: CreateProcedureWithInputOutputParser<
       TContext,
+      TMeta,
       TInput,
       TParsedInput,
       TOutput,
@@ -323,6 +353,7 @@ export class Router<
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries &
       Record<TPath, inferProcedureFromOptions<TInputContext, typeof procedure>>,
     TMutations,
@@ -332,10 +363,11 @@ export class Router<
 
   public query<TPath extends string, TInput, TOutput>(
     path: TPath,
-    procedure: CreateProcedureWithInput<TContext, TInput, TOutput>,
+    procedure: CreateProcedureWithInput<TContext, TMeta, TInput, TOutput>,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries &
       Record<TPath, inferProcedureFromOptions<TInputContext, typeof procedure>>,
     TMutations,
@@ -345,10 +377,16 @@ export class Router<
 
   public query<TPath extends string, TOutput, TParsedOutput>(
     path: TPath,
-    procedure: CreateProcedureWithoutInput<TContext, TOutput, TParsedOutput>,
+    procedure: CreateProcedureWithoutInput<
+      TContext,
+      TMeta,
+      TOutput,
+      TParsedOutput
+    >,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries &
       Record<TPath, inferProcedureFromOptions<TInputContext, typeof procedure>>,
     TMutations,
@@ -358,9 +396,9 @@ export class Router<
 
   query(
     path: string,
-    procedure: CreateProcedureOptions<TContext, any, 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),
       }),
@@ -379,6 +417,7 @@ export class Router<
     path: TPath,
     procedure: CreateProcedureWithInputOutputParser<
       TContext,
+      TMeta,
       TInput,
       TParsedInput,
       TOutput,
@@ -387,6 +426,7 @@ export class Router<
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries,
     TMutations &
       Record<TPath, inferProcedureFromOptions<TInputContext, typeof procedure>>,
@@ -396,10 +436,11 @@ export class Router<
 
   public mutation<TPath extends string, TInput, TOutput>(
     path: TPath,
-    procedure: CreateProcedureWithInput<TContext, TInput, TOutput>,
+    procedure: CreateProcedureWithInput<TContext, TMeta, TInput, TOutput>,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries,
     TMutations &
       Record<TPath, inferProcedureFromOptions<TInputContext, typeof procedure>>,
@@ -409,10 +450,16 @@ export class Router<
 
   public mutation<TPath extends string, TOutput, TParsedOutput>(
     path: TPath,
-    procedure: CreateProcedureWithoutInput<TContext, TOutput, TParsedOutput>,
+    procedure: CreateProcedureWithoutInput<
+      TContext,
+      TMeta,
+      TOutput,
+      TParsedOutput
+    >,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries,
     TMutations &
       Record<TPath, inferProcedureFromOptions<TInputContext, typeof procedure>>,
@@ -422,9 +469,9 @@ export class Router<
 
   public mutation(
     path: string,
-    procedure: CreateProcedureOptions<TContext, any, 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),
       }),
@@ -440,12 +487,13 @@ export class Router<
     TPath extends string,
     TInput,
     TParsedInput,
-    TOutput extends Subscription<unknown>,
+    TOutput extends Observable<unknown, unknown>,
   >(
     path: TPath,
     procedure: Omit<
       CreateProcedureWithInputOutputParser<
         TContext,
+        TMeta,
         TInput,
         TParsedInput,
         TOutput,
@@ -456,6 +504,7 @@ export class Router<
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries,
     TMutations,
     TSubscriptions &
@@ -469,16 +518,17 @@ export class Router<
   public subscription<
     TPath extends string,
     TInput,
-    TOutput extends Subscription<unknown>,
+    TOutput extends Observable<unknown, unknown>,
   >(
     path: TPath,
     procedure: Omit<
-      CreateProcedureWithInput<TContext, TInput, TOutput>,
+      CreateProcedureWithInput<TContext, TMeta, TInput, TOutput>,
       'output'
     >,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries,
     TMutations,
     TSubscriptions &
@@ -491,16 +541,17 @@ export class Router<
    */
   public subscription<
     TPath extends string,
-    TOutput extends Subscription<unknown>,
+    TOutput extends Observable<unknown, unknown>,
   >(
     path: TPath,
     procedure: Omit<
-      CreateProcedureWithoutInput<TContext, TOutput, unknown>,
+      CreateProcedureWithoutInput<TContext, TMeta, TOutput, unknown>,
       'output'
     >,
   ): Router<
     TInputContext,
     TContext,
+    TMeta,
     TQueries,
     TMutations,
     TSubscriptions &
@@ -511,11 +562,11 @@ export class Router<
   public subscription(
     path: string,
     procedure: Omit<
-      CreateProcedureOptions<TContext, any, any, any, any>,
+      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),
       }),
@@ -528,11 +579,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'],
@@ -546,13 +600,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 &
@@ -605,7 +660,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,
@@ -632,7 +687,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, any>
+      | Procedure<TInputContext, TContext, TMeta, any, any, any, any>
       | undefined;
 
     if (!procedure) {
@@ -683,10 +738,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>,
@@ -713,6 +769,7 @@ export class Router<
     return new Router<
       TInputContext,
       TContext,
+      TMeta,
       TQueries,
       TMutations,
       TSubscriptions,
@@ -767,6 +824,7 @@ export class Router<
     return new Router<
       TInputContext,
       TContext,
+      TMeta,
       TQueries,
       TMutations,
       TSubscriptions,
@@ -786,6 +844,7 @@ export class Router<
   public flat(): Router<
     TInputContext,
     TContext,
+    TMeta,
     flatten<{}, TQueries>,
     flatten<{}, TMutations>,
     flatten<{}, TSubscriptions>,
@@ -795,6 +854,6 @@ export class Router<
   }
 }
 
-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>();
 }

package/src/rpc/codes.ts

@@ -28,6 +28,7 @@ export const TRPC_ERROR_CODES_BY_KEY = {
   NOT_FOUND: -32004, // 404
   METHOD_NOT_SUPPORTED: -32005, // 405
   TIMEOUT: -32008, // 408
+  CONFLICT: -32009, // 409
   PRECONDITION_FAILED: -32012, // 412
   PAYLOAD_TOO_LARGE: -32013, // 413
   CLIENT_CLOSED_REQUEST: -32099, // 499

package/src/rpc/envelopes.ts

@@ -1,31 +1,10 @@
+/* eslint-disable @typescript-eslint/no-namespace */
 import { ProcedureType } from '../router';
 import { TRPC_ERROR_CODE_NUMBER } from './codes';
 
-type JSONRPC2RequestId = number | string | null;
-
 /**
- * All requests/responses extends this shape
+ * Error response
  */
-interface JSONRPC2BaseEnvelope {
-  id: JSONRPC2RequestId;
-  jsonrpc?: '2.0';
-}
-
-interface JSONRPC2BaseRequest<TMethod extends string = string>
-  extends JSONRPC2BaseEnvelope {
-  method: TMethod;
-}
-interface JSONRPC2Request<TMethod extends string = string, TParams = unknown>
-  extends JSONRPC2BaseRequest<TMethod> {
-  params: TParams;
-}
-
-interface JSONRPC2ResultResponse<TResult = unknown>
-  extends JSONRPC2BaseEnvelope {
-  result: TResult;
-}
-
-// inner types
 export interface TRPCErrorShape<
   TCode extends number = TRPC_ERROR_CODE_NUMBER,
   TData extends Record<string, unknown> = Record<string, unknown>,
@@ -36,74 +15,114 @@ export interface TRPCErrorShape<
 }
 
 /**
- * The result data wrapped
+ * JSON-RPC 2.0 Specification
  */
-export type TRPCResult<TData = unknown> =
-  | {
-      type: 'data';
-      data: TData;
-    }
-  | {
-      type: 'started';
-    }
-  | {
-      type: 'stopped';
-    };
+export namespace JSONRPC2 {
+  export type RequestId = number | string | null;
+
+  /**
+   * All requests/responses extends this shape
+   */
+  export interface BaseEnvelope {
+    id?: RequestId;
+    jsonrpc?: '2.0';
+  }
+
+  export interface BaseRequest<TMethod extends string = string>
+    extends BaseEnvelope {
+    method: TMethod;
+  }
+
+  export interface Request<TMethod extends string = string, TParams = unknown>
+    extends BaseRequest<TMethod> {
+    params: TParams;
+  }
+
+  export interface ResultResponse<TResult = unknown> extends BaseEnvelope {
+    result: TResult;
+  }
+
+  export interface ErrorResponse<TError extends TRPCErrorShape = TRPCErrorShape>
+    extends BaseEnvelope {
+    error: TError;
+  }
+}
 
 /**
- * Request envelope
+ * TRPC HTTP Envelopes
  */
-export type TRPCRequest =
-  | JSONRPC2Request<'subscription.stop'>
-  | JSONRPC2Request<
-      ProcedureType,
-      {
-        path: string;
-        input: unknown;
-      }
-    >;
+
+export type TRPCRequest = JSONRPC2.Request<
+  ProcedureType,
+  { path: string; input: unknown }
+>;
+
+export type TRPCResult<TData = unknown> = { data: TData };
+
+export type TRPCErrorResponse<TError extends TRPCErrorShape = TRPCErrorShape> =
+  JSONRPC2.ErrorResponse<TError>;
+
+export type TRPCResponse<
+  TResult = unknown,
+  TError extends TRPCErrorShape = TRPCErrorShape,
+> = JSONRPC2.ResultResponse<TRPCResult<TResult>> | TRPCErrorResponse<TError>;
 
 /**
- * OK response
+ * HTTP WS Envelopes
  */
-export type TRPCResultResponse<TData = unknown> = JSONRPC2ResultResponse<
-  TRPCResult<TData>
->;
+
+export type TRPCRequestMessage = {
+  id: JSONRPC2.RequestId;
+} & TRPCRequest;
 
 /**
- * Generic response wrapper that is either a result or error
+ * The client asked the server to unsubscribe
  */
-export type TRPCResponse<
-  TData = unknown,
-  TError extends TRPCErrorShape = TRPCErrorShape,
-> = TRPCResultResponse<TData> | TRPCErrorResponse<TError>;
+export type TRPCSubscriptionStopNotification = {
+  id: null;
+} & JSONRPC2.BaseRequest<'subscription.stop'>;
 
 /**
- * Error response
+ * The client's outgoing request types
  */
-export interface TRPCErrorResponse<
+export type TRPCClientOutgoingRequest = TRPCSubscriptionStopNotification;
+
+/**
+ * The client's sent messages shape
+ */
+export type TRPCClientOutgoingMessage =
+  | TRPCRequestMessage
+  | ({ id: JSONRPC2.RequestId } & JSONRPC2.BaseRequest<'subscription.stop'>);
+
+export type TRPCResultMessage<TData = unknown> =
+  | ({ type: 'data' } & TRPCResult<TData>)
+  | { type: 'started' }
+  | { type: 'stopped' };
+
+export type TRPCResponseMessage<
+  TResult = unknown,
   TError extends TRPCErrorShape = TRPCErrorShape,
-> extends JSONRPC2BaseEnvelope {
-  error: TError;
-}
+> = { id: JSONRPC2.RequestId } & (
+  | JSONRPC2.ResultResponse<TRPCResultMessage<TResult>>
+  | TRPCErrorResponse<TError>
+);
 
 /**
  * The server asked the client to reconnect - useful when restarting/redeploying service
  */
-export interface TRPCReconnectNotification
-  extends JSONRPC2BaseRequest<'reconnect'> {
-  id: null;
-}
+export type TRPCReconnectNotification = {
+  id: JSONRPC2.RequestId;
+} & JSONRPC2.BaseRequest<'reconnect'>;
 
 /**
  * The client's incoming request types
  */
-export type TRPCClientIncomingRequest =
-  TRPCReconnectNotification /* could be extended in future */;
+export type TRPCClientIncomingRequest = TRPCReconnectNotification;
 
 /**
  * The client's received messages shape
  */
-export type TRPCClientIncomingMessage =
-  | TRPCResponse
-  | TRPCClientIncomingRequest;
+export type TRPCClientIncomingMessage<
+  TResult = unknown,
+  TError extends TRPCErrorShape = TRPCErrorShape,
+> = TRPCResponseMessage<TResult, TError> | TRPCClientIncomingRequest;