@trpc/server 9.20.3 → 9.23.0

package/src/internals/middlewares.ts

@@ -1,5 +1,5 @@
-import { ProcedureType } from '../router';
 import { TRPCError } from '../TRPCError';
+import { ProcedureType } from '../router';
 
 export const middlewareMarker = Symbol('middlewareMarker');
 interface MiddlewareResultBase<TContext> {
@@ -27,11 +27,12 @@ export type MiddlewareResult<TContext> =
   | MiddlewareOKResult<TContext>
   | MiddlewareErrorResult<TContext>;
 
-export type MiddlewareFunction<TInputContext, TContext> = (opts: {
+export type MiddlewareFunction<TInputContext, TContext, TMeta> = (opts: {
   ctx: TInputContext;
   type: ProcedureType;
   path: string;
   rawInput: unknown;
+  meta?: TMeta;
   next: {
     (): Promise<MiddlewareResult<TInputContext>>;
     <T>(opts: { ctx: T }): Promise<MiddlewareResult<T>>;

package/src/internals/procedure.ts

@@ -1,51 +1,56 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
+import { TRPCError } from '../TRPCError';
 import { assertNotBrowser } from '../assertNotBrowser';
 import { ProcedureType } from '../router';
-import { TRPCError } from '../TRPCError';
+import { InferLast } from '../types';
 import { getErrorFromUnknown } from './errors';
 import { MiddlewareFunction, middlewareMarker } from './middlewares';
 import { wrapCallSafe } from './wrapCallSafe';
+
 assertNotBrowser();
 
-export type ProcedureInputParserZodEsque<TInput, TParsedInput> = {
+export type ProcedureParserZodEsque<TInput, TOutput> = {
   _input: TInput;
-  _output: TParsedInput;
+  _output: TOutput;
 };
 
-export type ProcedureInputParserMyZodEsque<TInput> = {
-  parse: (input: any) => TInput;
+export type ProcedureParserMyZodEsque<T> = {
+  parse: (input: any) => T;
 };
 
-export type ProcedureInputParserSuperstructEsque<TInput> = {
-  create: (input: unknown) => TInput;
+export type ProcedureParserSuperstructEsque<T> = {
+  create: (input: unknown) => T;
 };
 
-export type ProcedureInputParserCustomValidatorEsque<TInput> = (
+export type ProcedureParserCustomValidatorEsque<T> = (
   input: unknown,
-) => TInput | Promise<TInput>;
+) => T | Promise<T>;
 
-export type ProcedureInputParserYupEsque<TInput> = {
-  validateSync: (input: unknown) => TInput;
+export type ProcedureParserYupEsque<T> = {
+  validateSync: (input: unknown) => T;
 };
-export type ProcedureInputParser<TInput> =
-  | ProcedureInputParserYupEsque<TInput>
-  | ProcedureInputParserSuperstructEsque<TInput>
-  | ProcedureInputParserCustomValidatorEsque<TInput>
-  | ProcedureInputParserMyZodEsque<TInput>;
 
-export type ProcedureInputParserWithInputOutput<TInput, TParsedInput> =
-  ProcedureInputParserZodEsque<TInput, TParsedInput>;
+export type ProcedureParserWithInputOutput<TInput, TOutput> =
+  ProcedureParserZodEsque<TInput, TOutput>;
 
-export type ProcedureResolver<TContext, TParsedInput, TOutput> = (opts: {
+export type ProcedureParser<T> =
+  | ProcedureParserYupEsque<T>
+  | ProcedureParserSuperstructEsque<T>
+  | ProcedureParserCustomValidatorEsque<T>
+  | ProcedureParserMyZodEsque<T>;
+
+export type ProcedureResolver<TContext, TInput, TOutput> = (opts: {
   ctx: TContext;
-  input: TParsedInput;
+  input: TInput;
   type: ProcedureType;
 }) => Promise<TOutput> | TOutput;
 
-interface ProcedureOptions<TContext, TParsedInput, TOutput> {
-  middlewares: Array<MiddlewareFunction<any, any>>;
-  resolver: ProcedureResolver<TContext, TParsedInput, TOutput>;
-  inputParser: ProcedureInputParser<TParsedInput>;
+interface ProcedureOptions<TContext, TMeta, TInput, TOutput, TParsedOutput> {
+  middlewares: Array<MiddlewareFunction<any, any, any>>;
+  resolver: ProcedureResolver<TContext, TInput, TOutput>;
+  inputParser: ProcedureParser<TInput>;
+  outputParser: ProcedureParser<TParsedOutput>;
+  meta: TMeta;
 }
 
 /**
@@ -58,36 +63,33 @@ export interface ProcedureCallOptions<TContext> {
   type: ProcedureType;
 }
 
-type ParseFn<TParsedInput> = (
-  value: unknown,
-) => TParsedInput | Promise<TParsedInput>;
-function getParseFn<TParsedInput>(
-  inputParser: ProcedureInputParser<TParsedInput>,
-): ParseFn<TParsedInput> {
-  const parser = inputParser as any;
+type ParseFn<T> = (value: unknown) => T | Promise<T>;
+
+function getParseFn<T>(procedureParser: ProcedureParser<T>): ParseFn<T> {
+  const parser = procedureParser as any;
 
   if (typeof parser === 'function') {
-    // ProcedureInputParserCustomValidatorEsque
+    // ProcedureParserCustomValidatorEsque
     return parser;
   }
 
   if (typeof parser.parseAsync === 'function') {
-    // ProcedureInputParserZodEsque
+    // ProcedureParserZodEsque
     return parser.parseAsync.bind(parser);
   }
 
   if (typeof parser.parse === 'function') {
-    // ProcedureInputParserZodEsque
+    // ProcedureParserZodEsque
     return parser.parse.bind(parser);
   }
 
   if (typeof parser.validateSync === 'function') {
-    // ProcedureInputParserYupEsque
+    // ProcedureParserYupEsque
     return parser.validateSync.bind(parser);
   }
 
   if (typeof parser.create === 'function') {
-    // ProcedureInputParserSuperstructEsque
+    // ProcedureParserSuperstructEsque
     return parser.create.bind(parser);
   }
 
@@ -97,22 +99,45 @@ function getParseFn<TParsedInput>(
 /**
  * @internal
  */
-export class Procedure<TInputContext, TContext, TInput, TParsedInput, TOutput> {
-  private middlewares: Readonly<Array<MiddlewareFunction<any, any>>>;
+export class Procedure<
+  TInputContext,
+  TContext,
+  TMeta,
+  TInput,
+  TParsedInput,
+  TOutput,
+  TParsedOutput,
+  TFinalOutput = unknown extends TParsedOutput ? TOutput : TParsedOutput,
+> {
+  private middlewares: Readonly<Array<MiddlewareFunction<any, any, any>>>;
   private resolver: ProcedureResolver<TContext, TParsedInput, TOutput>;
-  private readonly inputParser: ProcedureInputParser<TParsedInput>;
-  private parse: ParseFn<TParsedInput>;
+  private readonly inputParser: ProcedureParser<TParsedInput>;
+  private parseInputFn: ParseFn<TParsedInput>;
+  private readonly outputParser: ProcedureParser<TFinalOutput>;
+  private parseOutputFn: ParseFn<TFinalOutput>;
+  public readonly meta: TMeta;
 
-  constructor(opts: ProcedureOptions<TContext, TParsedInput, TOutput>) {
+  constructor(
+    opts: ProcedureOptions<
+      TContext,
+      TMeta,
+      TParsedInput,
+      TOutput,
+      TFinalOutput
+    >,
+  ) {
     this.middlewares = opts.middlewares;
     this.resolver = opts.resolver;
     this.inputParser = opts.inputParser;
-    this.parse = getParseFn(this.inputParser);
+    this.parseInputFn = getParseFn(this.inputParser);
+    this.outputParser = opts.outputParser;
+    this.parseOutputFn = getParseFn(this.outputParser);
+    this.meta = opts.meta;
   }
 
   private async parseInput(rawInput: unknown): Promise<TParsedInput> {
     try {
-      return await this.parse(rawInput);
+      return await this.parseInputFn(rawInput);
     } catch (cause) {
       throw new TRPCError({
         code: 'BAD_REQUEST',
@@ -121,18 +146,35 @@ export class Procedure<TInputContext, TContext, TInput, TParsedInput, TOutput> {
     }
   }
 
+  private async parseOutput(rawOutput: TOutput): Promise<TFinalOutput> {
+    try {
+      return await this.parseOutputFn(rawOutput);
+    } catch (cause) {
+      throw new TRPCError({
+        code: 'INTERNAL_SERVER_ERROR',
+        cause,
+        message: 'Output validation failed',
+      });
+    }
+  }
+
   /**
-   * Trigger middlewares in order, parse raw input & call resolver
+   * Trigger middlewares in order, parse raw input, call resolver & parse raw output
    * @internal
    */
   public async call(
     opts: ProcedureCallOptions<TInputContext>,
-  ): Promise<TOutput> {
+  ): Promise<TFinalOutput> {
     // wrap the actual resolver and treat as the last "middleware"
     const middlewaresWithResolver = this.middlewares.concat([
       async ({ ctx }: { ctx: TContext }) => {
         const input = await this.parseInput(opts.rawInput);
-        const data = await this.resolver({ ...opts, ctx, input });
+        const rawOutput = await this.resolver({
+          ...opts,
+          ctx,
+          input,
+        });
+        const data = await this.parseOutput(rawOutput);
         return {
           marker: middlewareMarker,
           ok: true,
@@ -151,6 +193,7 @@ export class Procedure<TInputContext, TContext, TInput, TParsedInput, TOutput> {
             type: opts.type,
             path: opts.path,
             rawInput: opts.rawInput,
+            meta: this.meta,
             next: nextFns[index + 1],
           }),
         );
@@ -178,7 +221,7 @@ export class Procedure<TInputContext, TContext, TInput, TParsedInput, TOutput> {
       throw result.error;
     }
 
-    return result.data as TOutput;
+    return result.data as TFinalOutput;
   }
 
   /**
@@ -186,15 +229,25 @@ export class Procedure<TInputContext, TContext, TInput, TParsedInput, TOutput> {
    * @param middlewares
    */
   public inheritMiddlewares(
-    middlewares: MiddlewareFunction<TInputContext, TContext>[],
+    middlewares: MiddlewareFunction<TInputContext, TContext, TMeta>[],
   ): this {
     const Constructor: {
-      new (opts: ProcedureOptions<TContext, TParsedInput, TOutput>): Procedure<
+      new (
+        opts: ProcedureOptions<
+          TContext,
+          TMeta,
+          TParsedInput,
+          TOutput,
+          TFinalOutput
+        >,
+      ): Procedure<
         TInputContext,
         TContext,
+        TMeta,
         TInput,
         TParsedInput,
-        TOutput
+        TOutput,
+        TParsedOutput
       >;
     } = (this as any).constructor;
 
@@ -202,48 +255,92 @@ export class Procedure<TInputContext, TContext, TInput, TParsedInput, TOutput> {
       middlewares: [...middlewares, ...this.middlewares],
       resolver: this.resolver,
       inputParser: this.inputParser,
+      outputParser: this.outputParser,
+      meta: this.meta,
     });
 
     return instance as any;
   }
 }
 
-export type CreateProcedureWithInput<TContext, TInput, TParsedInput, TOutput> =
-  {
-    input: ProcedureInputParser<TInput>;
-    resolve: ProcedureResolver<TContext, TParsedInput, TOutput>;
-  };
+export type CreateProcedureWithInput<TContext, TMeta, TInput, TOutput> = {
+  input: ProcedureParser<TInput>;
+  output?: ProcedureParser<TOutput>;
+  meta?: TMeta;
+  resolve: ProcedureResolver<TContext, TInput, InferLast<TOutput>>;
+};
+
 export type CreateProcedureWithInputOutputParser<
   TContext,
+  TMeta,
   TInput,
   TParsedInput,
   TOutput,
+  TParsedOutput,
 > = {
-  input: ProcedureInputParserWithInputOutput<TInput, TParsedInput>;
-  resolve: ProcedureResolver<TContext, TParsedInput, TOutput>;
+  input: ProcedureParserWithInputOutput<TInput, TParsedInput>;
+  output?: ProcedureParserWithInputOutput<TOutput, TParsedOutput>;
+  meta?: TMeta;
+  resolve: ProcedureResolver<TContext, TParsedInput, InferLast<TOutput>>;
 };
-export type CreateProcedureWithoutInput<TContext, TOutput> = {
-  resolve: ProcedureResolver<TContext, undefined, TOutput>;
+
+export type CreateProcedureWithoutInput<
+  TContext,
+  TMeta,
+  TOutput,
+  TParsedOutput,
+> = {
+  output?:
+    | ProcedureParserWithInputOutput<TOutput, TParsedOutput>
+    | ProcedureParser<TOutput>;
+  meta?: TMeta;
+  resolve: ProcedureResolver<TContext, undefined, InferLast<TOutput>>;
 };
 
 export type CreateProcedureOptions<
   TContext,
+  TMeta = undefined,
   TInput = undefined,
   TParsedInput = undefined,
   TOutput = undefined,
+  TParsedOutput = undefined,
 > =
-  | CreateProcedureWithInput<TContext, TInput, TParsedInput, TOutput>
   | CreateProcedureWithInputOutputParser<
       TContext,
+      TMeta,
       TInput,
       TParsedInput,
-      TOutput
+      TOutput,
+      TParsedOutput
     >
-  | CreateProcedureWithoutInput<TContext, TOutput>;
+  | CreateProcedureWithInput<TContext, TMeta, TInput, TOutput>
+  | CreateProcedureWithoutInput<TContext, TMeta, TOutput, TParsedOutput>;
 
-export function createProcedure<TContext, TInput, TParsedInput, TOutput>(
-  opts: CreateProcedureOptions<TContext, TInput, TParsedInput, TOutput>,
-): Procedure<unknown, TContext, TInput, TParsedInput, TOutput> {
+export function createProcedure<
+  TContext,
+  TMeta,
+  TInput,
+  TParsedInput,
+  TOutput,
+  TParsedOutput,
+>(
+  opts: CreateProcedureOptions<
+    TContext,
+    TMeta,
+    TInput,
+    TParsedInput,
+    TOutput,
+    TParsedOutput
+  >,
+): Procedure<
+  unknown,
+  TContext,
+  TMeta,
+  TInput,
+  TParsedInput,
+  TOutput,
+  TParsedOutput
+> {
   const inputParser =
     'input' in opts
       ? opts.input
@@ -257,27 +354,38 @@ export function createProcedure<TContext, TInput, TParsedInput, TOutput>(
           return undefined;
         };
 
+  const outputParser =
+    'output' in opts && opts.output
+      ? opts.output
+      : (output: unknown) => output as TOutput;
+
   return new Procedure({
     inputParser: inputParser as any,
     resolver: opts.resolve as any,
     middlewares: [],
+    outputParser: outputParser as any,
+    meta: opts.meta as any,
   });
 }
 
 export type inferProcedureFromOptions<
   TInputContext,
-  TOptions extends CreateProcedureOptions<any, any, any, any>,
+  TOptions extends CreateProcedureOptions<any, any, any, any, any, any>,
 > = TOptions extends CreateProcedureOptions<
   infer TContext,
+  infer TMeta,
   infer TInput,
   infer TParsedInput,
-  infer TOutput
+  infer TOutput,
+  infer TParsedOutput
 >
   ? Procedure<
       TInputContext,
       TContext,
+      TMeta,
       unknown extends TInput ? undefined : TInput,
       unknown extends TParsedInput ? undefined : TParsedInput,
-      TOutput
+      TOutput,
+      TParsedOutput
     >
   : never;