@orpc/server 2.0.0-beta.24 → 2.0.0-beta.26

package/dist/index.d.mts

@@ -55,67 +55,327 @@ type UnlaziedRouter<T extends AnyRouter> = T extends AnyProcedure ? T : {
  */
 declare function unlazyRouter<T extends AnyRouter>(router: T): Promise<UnlaziedRouter<T>>;
 
+/**
+ * The builder variant returned after `.use` is called.
+ * `.$context` and `.$config` are no longer available once middleware is applied.
+ *
+ * @see {@link https://orpc.dev/docs/procedure | Procedure}
+ */
 interface BuilderWithMiddlewares<TInitialContext extends Context, TInjectedContext extends Context, TErrorMap extends ErrorMap> {
     '~orpc': BuilderDefinition<InitialInputSchema, InitialOutputSchema, TErrorMap>;
+    /**
+     * Applies metadata plugins to procedures built from this builder.
+     *
+     * @see {@link https://orpc.dev/docs/metadata | Metadata}
+     */
     'meta'(...plugins: MetaPlugin<InitialInputSchema, InitialOutputSchema, TErrorMap>[]): BuilderWithMiddlewares<TInitialContext, TInjectedContext, TErrorMap>;
+    /**
+     * Defines typesafe errors that procedures built from this builder can throw
+     * via the `errors` utility in handlers and middleware.
+     *
+     * @see {@link https://orpc.dev/docs/error-handling#typesafe-errors | Error Handling - Typesafe Errors}
+     */
     'errors'<T extends ErrorMap>(errors: T): BuilderWithMiddlewares<TInitialContext, TInjectedContext, MergedErrorMap<TErrorMap, T>>;
+    /**
+     * Applies a middleware that runs before the handler of every procedure
+     * built from this builder.
+     *
+     * @see {@link https://orpc.dev/docs/middleware | Middleware}
+     */
     'use'<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $ErrorMap extends ErrorMap = TErrorMap>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, InferSchemaOutput<InitialInputSchema>, InferSchemaInput<InitialOutputSchema>, $ErrorMap>): BuilderWithMiddlewares<MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>, MergedErrorMap<$ErrorMap, TErrorMap>>;
+    /**
+     * Creates a standalone middleware that can be composed and applied to any
+     * compatible builder or procedure with `.use`.
+     *
+     * @see {@link https://orpc.dev/docs/middleware | Middleware}
+     */
     'middleware'<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $Input, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $Output = any>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, $Input, $Output, TErrorMap>): DecoratedMiddleware<MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>, $Input, $Output, TErrorMap>;
+    /**
+     * Defines the input schema used to validate and type the procedure input.
+     *
+     * @see {@link https://orpc.dev/docs/procedure#inputoutput-validation | Procedure - Input/Output Validation}
+     */
     'input'<T extends AnySchema>(schema: T): BuilderWithInput<TInitialContext, TInjectedContext, T, TErrorMap>;
+    /**
+     * Defines the output schema used to validate and type the procedure output.
+     *
+     * @see {@link https://orpc.dev/docs/procedure#inputoutput-validation | Procedure - Input/Output Validation}
+     */
     'output'<T extends AnySchema>(schema: T): BuilderWithOutput<TInitialContext, TInjectedContext, T, TErrorMap>;
+    /**
+     * Defines the function that implements the procedure and completes the
+     * chain, returning a callable procedure.
+     *
+     * @see {@link https://orpc.dev/docs/procedure | Procedure}
+     */
     'handler'<T>(handler: ProcedureHandler<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<InitialInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, InitialInputSchema, Schema<Exclude<T, AnyORPCError>>, TErrorMap, Extract<T, AnyORPCError>>;
+    /**
+     * Applies the builder's middleware, errors, and metadata to every procedure
+     * in the given router.
+     *
+     * @see {@link https://orpc.dev/docs/router#extending-router | Router - Extending Router}
+     */
     'router'<T extends Router<MergedContext<TInitialContext, TInjectedContext>>>(router: T): AugmentedRouterWithMiddlewares<T, TInitialContext, TInjectedContext, TErrorMap>;
+    /**
+     * Like `.router`, but loads the router lazily on first access, which helps
+     * reduce startup time for large applications.
+     *
+     * @see {@link https://orpc.dev/docs/router#lazy-router | Router - Lazy Router}
+     */
     'lazy'<T extends Router<MergedContext<TInitialContext, TInjectedContext>>>(loader: () => Promise<{
         default: T;
     }>): Lazy<AugmentedRouterWithMiddlewares<T, TInitialContext, TInjectedContext, TErrorMap>>;
 }
+/**
+ * The builder variant returned after `.input` is called.
+ * Only procedure-level methods remain available once an input schema is defined.
+ *
+ * @see {@link https://orpc.dev/docs/procedure | Procedure}
+ */
 interface BuilderWithInput<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TErrorMap extends ErrorMap> {
     '~orpc': BuilderDefinition<TInputSchema, InitialOutputSchema, TErrorMap>;
+    /**
+     * Applies metadata plugins to procedures built from this builder.
+     *
+     * @see {@link https://orpc.dev/docs/metadata | Metadata}
+     */
     'meta'(...plugins: MetaPlugin<TInputSchema, InitialOutputSchema, TErrorMap>[]): BuilderWithInput<TInitialContext, TInjectedContext, TInputSchema, TErrorMap>;
+    /**
+     * Defines typesafe errors that procedures built from this builder can throw
+     * via the `errors` utility in handlers and middleware.
+     *
+     * @see {@link https://orpc.dev/docs/error-handling#typesafe-errors | Error Handling - Typesafe Errors}
+     */
     'errors'<T extends ErrorMap>(errors: T): BuilderWithInput<TInitialContext, TInjectedContext, TInputSchema, MergedErrorMap<TErrorMap, T>>;
+    /**
+     * Applies a middleware that runs before the handler and can access the
+     * validated input.
+     *
+     * @see {@link https://orpc.dev/docs/middleware | Middleware}
+     */
     'use'<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $ErrorMap extends ErrorMap = TErrorMap>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<InitialOutputSchema>, $ErrorMap>): BuilderWithInput<MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>, TInputSchema, MergedErrorMap<$ErrorMap, TErrorMap>>;
+    /**
+     * Adds an additional input schema, merged with the previously defined one.
+     *
+     * @see {@link https://orpc.dev/docs/procedure#multiple-schemas | Procedure - Multiple Schemas}
+     */
     'input'<T extends AnySchema>(schema: T): BuilderWithInput<TInitialContext, TInjectedContext, MergedSchema<T, TInputSchema>, TErrorMap>;
+    /**
+     * Defines the output schema used to validate and type the procedure output.
+     *
+     * @see {@link https://orpc.dev/docs/procedure#inputoutput-validation | Procedure - Input/Output Validation}
+     */
     'output'<T extends AnySchema>(schema: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, TInputSchema, T, TErrorMap>;
+    /**
+     * Defines the function that implements the procedure and completes the
+     * chain, returning a callable procedure.
+     *
+     * @see {@link https://orpc.dev/docs/procedure | Procedure}
+     */
     'handler'<T>(handler: ProcedureHandler<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, Schema<Exclude<T, AnyORPCError>>, TErrorMap, Extract<T, AnyORPCError>>;
 }
+/**
+ * The builder variant returned after `.output` is called.
+ * Only procedure-level methods remain available once an output schema is defined.
+ *
+ * @see {@link https://orpc.dev/docs/procedure | Procedure}
+ */
 interface BuilderWithOutput<TInitialContext extends Context, TInjectedContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
     '~orpc': BuilderDefinition<InitialInputSchema, TOutputSchema, TErrorMap>;
+    /**
+     * Applies metadata plugins to procedures built from this builder.
+     *
+     * @see {@link https://orpc.dev/docs/metadata | Metadata}
+     */
     'meta'(...plugins: MetaPlugin<InitialInputSchema, TOutputSchema, TErrorMap>[]): BuilderWithOutput<TInitialContext, TInjectedContext, TOutputSchema, TErrorMap>;
+    /**
+     * Defines typesafe errors that procedures built from this builder can throw
+     * via the `errors` utility in handlers and middleware.
+     *
+     * @see {@link https://orpc.dev/docs/error-handling#typesafe-errors | Error Handling - Typesafe Errors}
+     */
     'errors'<T extends ErrorMap>(errors: T): BuilderWithOutput<TInitialContext, TInjectedContext, TOutputSchema, MergedErrorMap<TErrorMap, T>>;
+    /**
+     * Applies a middleware that runs before the handler and can access the
+     * typed output.
+     *
+     * @see {@link https://orpc.dev/docs/middleware | Middleware}
+     */
     'use'<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $ErrorMap extends ErrorMap = TErrorMap>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, InferSchemaOutput<InitialInputSchema>, InferSchemaInput<TOutputSchema>, $ErrorMap>): BuilderWithOutput<MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>, TOutputSchema, MergedErrorMap<$ErrorMap, TErrorMap>>;
+    /**
+     * Defines the input schema used to validate and type the procedure input.
+     *
+     * @see {@link https://orpc.dev/docs/procedure#inputoutput-validation | Procedure - Input/Output Validation}
+     */
     'input'<T extends AnySchema>(schema: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, T, TOutputSchema, TErrorMap>;
+    /**
+     * Adds an additional output schema, merged with the previously defined one.
+     *
+     * @see {@link https://orpc.dev/docs/procedure#multiple-schemas | Procedure - Multiple Schemas}
+     */
     'output'<T extends AnySchema>(schema: T): BuilderWithOutput<TInitialContext, TInjectedContext, MergedSchema<T, TOutputSchema>, TErrorMap>;
+    /**
+     * Defines the function that implements the procedure and completes the
+     * chain, returning a callable procedure.
+     *
+     * @see {@link https://orpc.dev/docs/procedure | Procedure}
+     */
     'handler'<T extends InferSchemaInput<TOutputSchema> | AnyORPCError>(handler: ProcedureHandler<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<InitialInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, InitialInputSchema, TOutputSchema, TErrorMap, Extract<T, AnyORPCError>>;
 }
+/**
+ * The builder variant returned after both `.input` and `.output` are called.
+ * Only procedure-level methods remain available.
+ *
+ * @see {@link https://orpc.dev/docs/procedure | Procedure}
+ */
 interface BuilderWithInputOutput<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
     '~orpc': BuilderDefinition<TInputSchema, TOutputSchema, TErrorMap>;
+    /**
+     * Applies metadata plugins to procedures built from this builder.
+     *
+     * @see {@link https://orpc.dev/docs/metadata | Metadata}
+     */
     'meta'(...plugins: MetaPlugin<TInputSchema, TOutputSchema, TErrorMap>[]): BuilderWithInputOutput<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap>;
+    /**
+     * Defines typesafe errors that procedures built from this builder can throw
+     * via the `errors` utility in handlers and middleware.
+     *
+     * @see {@link https://orpc.dev/docs/error-handling#typesafe-errors | Error Handling - Typesafe Errors}
+     */
     'errors'<T extends ErrorMap>(errors: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, T>>;
+    /**
+     * Applies a middleware that runs before the handler and can access the
+     * validated input and typed output.
+     *
+     * @see {@link https://orpc.dev/docs/middleware | Middleware}
+     */
     'use'<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $ErrorMap extends ErrorMap = TErrorMap>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, $ErrorMap>): BuilderWithInputOutput<MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>, TInputSchema, TOutputSchema, MergedErrorMap<$ErrorMap, TErrorMap>>;
+    /**
+     * Adds an additional input schema, merged with the previously defined one.
+     *
+     * @see {@link https://orpc.dev/docs/procedure#multiple-schemas | Procedure - Multiple Schemas}
+     */
     'input'<T extends AnySchema>(schema: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, MergedSchema<T, TInputSchema>, TOutputSchema, TErrorMap>;
+    /**
+     * Adds an additional output schema, merged with the previously defined one.
+     *
+     * @see {@link https://orpc.dev/docs/procedure#multiple-schemas | Procedure - Multiple Schemas}
+     */
     'output'<T extends AnySchema>(schema: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, TInputSchema, MergedSchema<T, TOutputSchema>, TErrorMap>;
+    /**
+     * Defines the function that implements the procedure and completes the
+     * chain, returning a callable procedure.
+     *
+     * @see {@link https://orpc.dev/docs/procedure | Procedure}
+     */
     'handler'<T extends InferSchemaInput<TOutputSchema> | AnyORPCError>(handler: ProcedureHandler<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap, Extract<T, AnyORPCError>>;
 }
 
+/**
+ * The initial context type used when `.$context` is not called.
+ * Augment this interface with `declare module '@orpc/server'` to define
+ * a default initial context type globally.
+ *
+ * @see {@link https://orpc.dev/docs/context#default-initial-context | Context - Default Initial Context}
+ */
 interface DefaultInitialContext {
 }
 interface BuilderDefinition<TInputSchema extends AnySchema, TInjectedContext extends AnySchema, TErrorMap extends ErrorMap> extends ProcedureContractDefinition<TInputSchema, TInjectedContext, TErrorMap>, ProcedureConfig {
     orderedMiddlewares: OrderedMiddleware[];
 }
+/**
+ * The procedure builder behind `os`. Chain its methods to gradually define
+ * context, middleware, errors, schemas, and finally a handler or router.
+ *
+ * @see {@link https://orpc.dev/docs/procedure | Procedure}
+ */
 declare class Builder<TInitialContext extends Context, TErrorMap extends ErrorMap> {
     '~orpc': BuilderDefinition<InitialInputSchema, InitialOutputSchema, TErrorMap>;
+    /**
+     * Private constructor to prevent direct instantiation.
+     * Use the static `create` method to initialize a new instance with a safe initial definition.
+     */
     private constructor();
+    /**
+     * Creates a fresh builder with an empty definition.
+     * Prefer the exported `os` instance over calling this directly.
+     *
+     * @see {@link https://orpc.dev/docs/procedure | Procedure}
+     */
     static create<T extends Context = DefaultInitialContext>(): Builder<T & object, Record<never, never>>;
+    /**
+     * Declares the initial context type that must be provided when executing
+     * procedures built from this builder.
+     *
+     * @see {@link https://orpc.dev/docs/context#initial-context | Context - Initial Context}
+     */
     $context<T extends Context = DefaultInitialContext>(): Builder<T & object, TErrorMap>;
+    /**
+     * Overrides the procedure configuration, such as disabling runtime
+     * input/output validation.
+     *
+     * @see {@link https://orpc.dev/docs/advanced/validation-customization | Validation Customization}
+     */
     $config(config: ProcedureConfig): Builder<TInitialContext, TErrorMap>;
+    /**
+     * Applies metadata plugins to procedures built from this builder.
+     *
+     * @see {@link https://orpc.dev/docs/metadata | Metadata}
+     */
     meta(...plugins: MetaPlugin<InitialInputSchema, InitialOutputSchema, TErrorMap>[]): Builder<TInitialContext, TErrorMap>;
+    /**
+     * Defines typesafe errors that procedures built from this builder can throw
+     * via the `errors` utility in handlers and middleware.
+     *
+     * @see {@link https://orpc.dev/docs/error-handling#typesafe-errors | Error Handling - Typesafe Errors}
+     */
     errors<U extends ErrorMap>(errors: U): Builder<TInitialContext, MergedErrorMap<TErrorMap, U>>;
+    /**
+     * Applies a middleware that runs before the handler of every procedure
+     * built from this builder.
+     *
+     * @see {@link https://orpc.dev/docs/middleware | Middleware}
+     */
     use<$OutContext extends IntersectPick<TInitialContext, $OutContext>, $InContext extends Context = TInitialContext, $ErrorMap extends ErrorMap = TErrorMap>(middleware: Middleware<$InContext | TInitialContext, $OutContext, InferSchemaOutput<InitialInputSchema>, InferSchemaInput<InitialOutputSchema>, $ErrorMap>): BuilderWithMiddlewares<MergedInitialContext<TInitialContext, object, $InContext>, $OutContext, MergedErrorMap<$ErrorMap, TErrorMap>>;
+    /**
+     * Creates a standalone middleware that can be composed and applied to any
+     * compatible builder or procedure with `.use`.
+     *
+     * @see {@link https://orpc.dev/docs/middleware | Middleware}
+     */
     middleware<$OutContext extends IntersectPick<TInitialContext, $OutContext>, $Input, $Output = any>(middleware: Middleware<TInitialContext, $OutContext, $Input, $Output, TErrorMap>): DecoratedMiddleware<TInitialContext, $OutContext, $Input, $Output, TErrorMap>;
+    /**
+     * Defines the input schema used to validate and type the procedure input.
+     *
+     * @see {@link https://orpc.dev/docs/procedure#inputoutput-validation | Procedure - Input/Output Validation}
+     */
     input<$ extends AnySchema>(schema: $): BuilderWithInput<TInitialContext, object, $, TErrorMap>;
+    /**
+     * Defines the output schema used to validate and type the procedure output.
+     *
+     * @see {@link https://orpc.dev/docs/procedure#inputoutput-validation | Procedure - Input/Output Validation}
+     */
     output<$ extends AnySchema>(schema: $): BuilderWithOutput<TInitialContext, object, $, TErrorMap>;
+    /**
+     * Defines the function that implements the procedure and completes the
+     * chain, returning a callable procedure.
+     *
+     * @see {@link https://orpc.dev/docs/procedure | Procedure}
+     */
     handler<T>(handler: ProcedureHandler<TInitialContext, InferSchemaOutput<InitialInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, object, InitialInputSchema, Schema<Exclude<T, AnyORPCError>>, TErrorMap, Extract<T, AnyORPCError>>;
+    /**
+     * Applies the builder's middleware, errors, and metadata to every procedure
+     * in the given router.
+     *
+     * @see {@link https://orpc.dev/docs/router#extending-router | Router - Extending Router}
+     */
     router<T extends AnyRouter>(router: T): AugmentedRouter<T, TErrorMap>;
+    /**
+     * Like `.router`, but loads the router lazily on first access, which helps
+     * reduce startup time for large applications.
+     *
+     * @see {@link https://orpc.dev/docs/router#lazy-router | Router - Lazy Router}
+     */
     lazy<T extends AnyRouter>(loader: () => Promise<{
         default: T;
     }>): Lazy<AugmentedRouter<T, TErrorMap>>;