@orpc/contract 0.0.0-next.f538070 → 0.0.0-next.f81b4a2

package/dist/index.d.mts

@@ -10,12 +10,23 @@ type SchemaIssue = StandardSchemaV1.Issue;
 type InferSchemaInput<T extends AnySchema> = T extends StandardSchemaV1<infer UInput, any> ? UInput : never;
 type InferSchemaOutput<T extends AnySchema> = T extends StandardSchemaV1<any, infer UOutput> ? UOutput : never;
 type TypeRest<TInput, TOutput> = [map: (input: TInput) => Promisable<TOutput>] | (IsEqual<TInput, TOutput> extends true ? [] : never);
+/**
+ * The schema for things can be trust without validation.
+ * If the TInput and TOutput are different, you need pass a map function.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/procedure#type-utility Type Utility Docs}
+ */
 declare function type<TInput, TOutput = TInput>(...[map]: TypeRest<TInput, TOutput>): Schema<TInput, TOutput>;
 
 interface ValidationErrorOptions extends ErrorOptions {
     message: string;
     issues: readonly SchemaIssue[];
 }
+/**
+ * This errors usually used for ORPCError.cause when the error is a validation error.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/advanced/validation-errors Validation Errors Docs}
+ */
 declare class ValidationError extends Error {
     readonly issues: readonly SchemaIssue[];
     constructor(options: ValidationErrorOptions);
@@ -41,21 +52,61 @@ declare function mergeMeta<T extends Meta>(meta1: T, meta2: T): T;
 type InputStructure = 'compact' | 'detailed';
 type OutputStructure = 'compact' | 'detailed';
 interface Route {
+    /**
+     * The HTTP method of the procedure.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     */
     method?: HTTPMethod;
+    /**
+     * The HTTP path of the procedure.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     */
     path?: HTTPPath;
+    /**
+     * The summary of the procedure.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
+     */
     summary?: string;
+    /**
+     * The description of the procedure.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
+     */
     description?: string;
+    /**
+     * Marks the procedure as deprecated.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
+     */
     deprecated?: boolean;
+    /**
+     * The tags of the procedure.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
+     */
     tags?: readonly string[];
     /**
      * The status code of the response when the procedure is successful.
+     * This option is typically relevant when integrating with OpenAPI.
      *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
      * @default 200
      */
     successStatus?: number;
     /**
      * The description of the response when the procedure is successful.
+     *  This option is typically relevant when integrating with OpenAPI.
      *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
      * @default 'OK'
      */
     successDescription?: string;
@@ -78,6 +129,7 @@ interface Route {
      * }
      * ```
      *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
      * @default 'compact'
      */
     inputStructure?: InputStructure;
@@ -100,6 +152,7 @@ interface Route {
      * };
      * ```
      *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
      * @default 'compact'
      */
     outputStructure?: OutputStructure;
@@ -122,23 +175,55 @@ interface ContractProcedureDef<TInputSchema extends AnySchema, TOutputSchema ext
     outputSchema?: TOutputSchema;
     errorMap: TErrorMap;
 }
+/**
+ * This class represents a contract procedure.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#procedure-contract Contract Procedure Docs}
+ */
 declare class ContractProcedure<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
+    /**
+     * This property holds the defined options for the contract procedure.
+     */
     '~orpc': ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
     constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
 }
 type AnyContractProcedure = ContractProcedure<any, any, any, any>;
 declare function isContractProcedure(item: unknown): item is AnyContractProcedure;
 
+/**
+ * Represents a contract router, which defines a hierarchical structure of contract procedures.
+ *
+ * @info A contract procedure is a contract router too.
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#contract-router Contract Router Docs}
+ */
 type ContractRouter<TMeta extends Meta> = ContractProcedure<any, any, any, TMeta> | {
     [k: string]: ContractRouter<TMeta>;
 };
 type AnyContractRouter = ContractRouter<any>;
+/**
+ * Infer all inputs of the contract router.
+ *
+ * @info A contract procedure is a contract router too.
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
+ */
 type InferContractRouterInputs<T extends AnyContractRouter> = T extends ContractProcedure<infer UInputSchema, any, any, any> ? InferSchemaInput<UInputSchema> : {
     [K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterInputs<T[K]> : never;
 };
+/**
+ * Infer all outputs of the contract router.
+ *
+ * @info A contract procedure is a contract router too.
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
+ */
 type InferContractRouterOutputs<T extends AnyContractRouter> = T extends ContractProcedure<any, infer UOutputSchema, any, any> ? InferSchemaOutput<UOutputSchema> : {
     [K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterOutputs<T[K]> : never;
 };
+/**
+ * Infer all errors of the contract router.
+ *
+ * @info A contract procedure is a contract router too.
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
+ */
 type InferContractRouterErrorMap<T extends AnyContractRouter> = T extends ContractProcedure<any, any, infer UErrorMap, any> ? UErrorMap : {
     [K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterErrorMap<T[K]> : never;
 }[keyof T];
@@ -154,57 +239,243 @@ interface EnhanceContractRouterOptions<TErrorMap extends ErrorMap> extends Enhan
 declare function enhanceContractRouter<T extends AnyContractRouter, TErrorMap extends ErrorMap>(router: T, options: EnhanceContractRouterOptions<TErrorMap>): EnhancedContractRouter<T, TErrorMap>;
 
 interface ContractProcedureBuilder<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
+    /**
+     * Adds type-safe custom errors to the contract.
+     * The provided errors are spared-merged with any existing errors in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
+     */
     errors<U extends ErrorMap>(errors: U): ContractProcedureBuilder<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
+    /**
+     * Sets or updates the metadata for the contract.
+     * The provided metadata is spared-merged with any existing metadata in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
+     */
     meta(meta: TMeta): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Sets or updates the route definition for the contract.
+     * The provided route is spared-merged with any existing route in the contract.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
+     */
     route(route: Route): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Defines the input validation schema for the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
+     */
     input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInput<U, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Defines the output validation schema for the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
+     */
     output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithOutput<TInputSchema, U, TErrorMap, TMeta>;
 }
 interface ContractProcedureBuilderWithInput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
+    /**
+     * Adds type-safe custom errors to the contract.
+     * The provided errors are spared-merged with any existing errors in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
+     */
     errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
+    /**
+     * Sets or updates the metadata for the contract.
+     * The provided metadata is spared-merged with any existing metadata in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
+     */
     meta(meta: TMeta): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Sets or updates the route definition for the contract.
+     * The provided route is spared-merged with any existing route in the contract.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
+     */
     route(route: Route): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Defines the output validation schema for the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
+     */
     output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInputOutput<TInputSchema, U, TErrorMap, TMeta>;
 }
 interface ContractProcedureBuilderWithOutput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
+    /**
+     * Adds type-safe custom errors to the contract.
+     * The provided errors are spared-merged with any existing errors in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
+     */
     errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
+    /**
+     * Sets or updates the metadata for the contract.
+     * The provided metadata is spared-merged with any existing metadata in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
+     */
     meta(meta: TMeta): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Sets or updates the route definition for the contract.
+     * The provided route is spared-merged with any existing route in the contract.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
+     */
     route(route: Route): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Defines the input validation schema for the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
+     */
     input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInputOutput<U, TOutputSchema, TErrorMap, TMeta>;
 }
 interface ContractProcedureBuilderWithInputOutput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
+    /**
+     * Adds type-safe custom errors to the contract.
+     * The provided errors are spared-merged with any existing errors in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
+     */
     errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
+    /**
+     * Sets or updates the metadata for the contract.
+     * The provided metadata is spared-merged with any existing metadata in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
+     */
     meta(meta: TMeta): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Sets or updates the route definition for the contract.
+     * The provided route is spared-merged with any existing route in the contract.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
+     */
     route(route: Route): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
 }
 interface ContractRouterBuilder<TErrorMap extends ErrorMap, TMeta extends Meta> {
+    /**
+     * This property holds the defined options for the contract router.
+     */
     '~orpc': EnhanceContractRouterOptions<TErrorMap>;
+    /**
+     * Adds type-safe custom errors to the contract.
+     * The provided errors are spared-merged with any existing errors in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
+     */
     'errors'<U extends ErrorMap>(errors: U): ContractRouterBuilder<MergedErrorMap<TErrorMap, U>, TMeta>;
+    /**
+     * Prefixes all procedures in the contract router.
+     * The provided prefix is post-appended to any existing router prefix.
+     *
+     * @note This option does not affect procedures that do not define a path in their route definition.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
+     */
     'prefix'(prefix: HTTPPath): ContractRouterBuilder<TErrorMap, TMeta>;
+    /**
+     * Adds tags to all procedures in the contract router.
+     * This helpful when you want to group procedures together in the OpenAPI specification.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
+     */
     'tag'(...tags: string[]): ContractRouterBuilder<TErrorMap, TMeta>;
+    /**
+     * Applies all of the previously defined options to the specified contract router.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
+     */
     'router'<T extends ContractRouter<TMeta>>(router: T): EnhancedContractRouter<T, TErrorMap>;
 }
 
 interface ContractBuilderDef<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>, EnhanceContractRouterOptions<TErrorMap> {
 }
 declare class ContractBuilder<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
+    /**
+     * This property holds the defined options for the contract.
+     */
     '~orpc': ContractBuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
     constructor(def: ContractBuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
     /**
-     * Reset initial meta
+     * Sets or overrides the initial meta.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
      */
     $meta<U extends Meta>(initialMeta: U): ContractBuilder<TInputSchema, TOutputSchema, TErrorMap, U & Record<never, never>>;
     /**
-     * Reset initial route
+     * Sets or overrides the initial route.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
      */
     $route(initialRoute: Route): ContractBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Adds type-safe custom errors to the contract.
+     * The provided errors are spared-merged with any existing errors in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
+     */
     errors<U extends ErrorMap>(errors: U): ContractBuilder<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
+    /**
+     * Sets or updates the metadata for the contract.
+     * The provided metadata is spared-merged with any existing metadata in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
+     */
     meta(meta: TMeta): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Sets or updates the route definition for the contract.
+     * The provided route is spared-merged with any existing route in the contract.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
+     */
     route(route: Route): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Defines the input validation schema for the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
+     */
     input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInput<U, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Defines the output validation schema for the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
+     */
     output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithOutput<TInputSchema, U, TErrorMap, TMeta>;
+    /**
+     * Prefixes all procedures in the contract router.
+     * The provided prefix is post-appended to any existing router prefix.
+     *
+     * @note This option does not affect procedures that do not define a path in their route definition.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
+     */
     prefix(prefix: HTTPPath): ContractRouterBuilder<TErrorMap, TMeta>;
+    /**
+     * Adds tags to all procedures in the contract router.
+     * This helpful when you want to group procedures together in the OpenAPI specification.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
+     */
     tag(...tags: string[]): ContractRouterBuilder<TErrorMap, TMeta>;
+    /**
+     * Applies all of the previously defined options to the specified contract router.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
+     */
     router<T extends ContractRouter<TMeta>>(router: T): EnhancedContractRouter<T, TErrorMap>;
 }
 declare const oc: ContractBuilder<Schema<unknown, unknown>, Schema<unknown, unknown>, Record<never, never>, Record<never, never>>;
@@ -222,6 +493,11 @@ interface EventIteratorSchemaDetails {
     yields: AnySchema;
     returns?: AnySchema;
 }
+/**
+ * Define schema for an event iterator.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/event-iterator#validate-event-iterator Validate Event Iterator Docs}
+ */
 declare function eventIterator<TYieldIn, TYieldOut, TReturnIn = unknown, TReturnOut = unknown>(yields: Schema<TYieldIn, TYieldOut>, returns?: Schema<TReturnIn, TReturnOut>): Schema<AsyncIteratorObject<TYieldIn, TReturnIn, void>, AsyncIteratorObject<TYieldOut, TReturnOut, void>>;
 declare function getEventIteratorSchemaDetails(schema: AnySchema | undefined): undefined | EventIteratorSchemaDetails;
 
@@ -231,4 +507,5 @@ type ContractRouterClient<TRouter extends AnyContractRouter, TClientContext exte
     [K in keyof TRouter]: TRouter[K] extends AnyContractRouter ? ContractRouterClient<TRouter[K], TClientContext> : never;
 };
 
-export { type AnyContractProcedure, type AnyContractRouter, type AnySchema, ContractBuilder, type ContractBuilderDef, type ContractConfig, ContractProcedure, type ContractProcedureBuilder, type ContractProcedureBuilderWithInput, type ContractProcedureBuilderWithInputOutput, type ContractProcedureBuilderWithOutput, type ContractProcedureClient, type ContractProcedureDef, type ContractRouter, type ContractRouterBuilder, type ContractRouterClient, type EnhanceContractRouterOptions, type EnhanceRouteOptions, type EnhancedContractRouter, type ErrorFromErrorMap, type ErrorMap, type ErrorMapItem, type EventIteratorSchemaDetails, type InferContractRouterErrorMap, type InferContractRouterInputs, type InferContractRouterMeta, type InferContractRouterOutputs, type InferSchemaInput, type InferSchemaOutput, type InputStructure, type MergedErrorMap, type Meta, type ORPCErrorFromErrorMap, type OutputStructure, type Route, type Schema, type SchemaIssue, type TypeRest, ValidationError, type ValidationErrorOptions, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, isContractProcedure, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, oc, prefixRoute, type, unshiftTagRoute };
+export { ContractBuilder, ContractProcedure, ValidationError, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, isContractProcedure, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, oc, prefixRoute, type, unshiftTagRoute };
+export type { AnyContractProcedure, AnyContractRouter, AnySchema, ContractBuilderDef, ContractConfig, ContractProcedureBuilder, ContractProcedureBuilderWithInput, ContractProcedureBuilderWithInputOutput, ContractProcedureBuilderWithOutput, ContractProcedureClient, ContractProcedureDef, ContractRouter, ContractRouterBuilder, ContractRouterClient, EnhanceContractRouterOptions, EnhanceRouteOptions, EnhancedContractRouter, ErrorFromErrorMap, ErrorMap, ErrorMapItem, EventIteratorSchemaDetails, InferContractRouterErrorMap, InferContractRouterInputs, InferContractRouterMeta, InferContractRouterOutputs, InferSchemaInput, InferSchemaOutput, InputStructure, MergedErrorMap, Meta, ORPCErrorFromErrorMap, OutputStructure, Route, Schema, SchemaIssue, TypeRest, ValidationErrorOptions };

package/dist/index.d.ts

@@ -10,12 +10,23 @@ type SchemaIssue = StandardSchemaV1.Issue;
 type InferSchemaInput<T extends AnySchema> = T extends StandardSchemaV1<infer UInput, any> ? UInput : never;
 type InferSchemaOutput<T extends AnySchema> = T extends StandardSchemaV1<any, infer UOutput> ? UOutput : never;
 type TypeRest<TInput, TOutput> = [map: (input: TInput) => Promisable<TOutput>] | (IsEqual<TInput, TOutput> extends true ? [] : never);
+/**
+ * The schema for things can be trust without validation.
+ * If the TInput and TOutput are different, you need pass a map function.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/procedure#type-utility Type Utility Docs}
+ */
 declare function type<TInput, TOutput = TInput>(...[map]: TypeRest<TInput, TOutput>): Schema<TInput, TOutput>;
 
 interface ValidationErrorOptions extends ErrorOptions {
     message: string;
     issues: readonly SchemaIssue[];
 }
+/**
+ * This errors usually used for ORPCError.cause when the error is a validation error.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/advanced/validation-errors Validation Errors Docs}
+ */
 declare class ValidationError extends Error {
     readonly issues: readonly SchemaIssue[];
     constructor(options: ValidationErrorOptions);
@@ -41,21 +52,61 @@ declare function mergeMeta<T extends Meta>(meta1: T, meta2: T): T;
 type InputStructure = 'compact' | 'detailed';
 type OutputStructure = 'compact' | 'detailed';
 interface Route {
+    /**
+     * The HTTP method of the procedure.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     */
     method?: HTTPMethod;
+    /**
+     * The HTTP path of the procedure.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     */
     path?: HTTPPath;
+    /**
+     * The summary of the procedure.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
+     */
     summary?: string;
+    /**
+     * The description of the procedure.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
+     */
     description?: string;
+    /**
+     * Marks the procedure as deprecated.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
+     */
     deprecated?: boolean;
+    /**
+     * The tags of the procedure.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
+     */
     tags?: readonly string[];
     /**
      * The status code of the response when the procedure is successful.
+     * This option is typically relevant when integrating with OpenAPI.
      *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
      * @default 200
      */
     successStatus?: number;
     /**
      * The description of the response when the procedure is successful.
+     *  This option is typically relevant when integrating with OpenAPI.
      *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
      * @default 'OK'
      */
     successDescription?: string;
@@ -78,6 +129,7 @@ interface Route {
      * }
      * ```
      *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
      * @default 'compact'
      */
     inputStructure?: InputStructure;
@@ -100,6 +152,7 @@ interface Route {
      * };
      * ```
      *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
      * @default 'compact'
      */
     outputStructure?: OutputStructure;
@@ -122,23 +175,55 @@ interface ContractProcedureDef<TInputSchema extends AnySchema, TOutputSchema ext
     outputSchema?: TOutputSchema;
     errorMap: TErrorMap;
 }
+/**
+ * This class represents a contract procedure.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#procedure-contract Contract Procedure Docs}
+ */
 declare class ContractProcedure<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
+    /**
+     * This property holds the defined options for the contract procedure.
+     */
     '~orpc': ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
     constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
 }
 type AnyContractProcedure = ContractProcedure<any, any, any, any>;
 declare function isContractProcedure(item: unknown): item is AnyContractProcedure;
 
+/**
+ * Represents a contract router, which defines a hierarchical structure of contract procedures.
+ *
+ * @info A contract procedure is a contract router too.
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#contract-router Contract Router Docs}
+ */
 type ContractRouter<TMeta extends Meta> = ContractProcedure<any, any, any, TMeta> | {
     [k: string]: ContractRouter<TMeta>;
 };
 type AnyContractRouter = ContractRouter<any>;
+/**
+ * Infer all inputs of the contract router.
+ *
+ * @info A contract procedure is a contract router too.
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
+ */
 type InferContractRouterInputs<T extends AnyContractRouter> = T extends ContractProcedure<infer UInputSchema, any, any, any> ? InferSchemaInput<UInputSchema> : {
     [K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterInputs<T[K]> : never;
 };
+/**
+ * Infer all outputs of the contract router.
+ *
+ * @info A contract procedure is a contract router too.
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
+ */
 type InferContractRouterOutputs<T extends AnyContractRouter> = T extends ContractProcedure<any, infer UOutputSchema, any, any> ? InferSchemaOutput<UOutputSchema> : {
     [K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterOutputs<T[K]> : never;
 };
+/**
+ * Infer all errors of the contract router.
+ *
+ * @info A contract procedure is a contract router too.
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
+ */
 type InferContractRouterErrorMap<T extends AnyContractRouter> = T extends ContractProcedure<any, any, infer UErrorMap, any> ? UErrorMap : {
     [K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterErrorMap<T[K]> : never;
 }[keyof T];
@@ -154,57 +239,243 @@ interface EnhanceContractRouterOptions<TErrorMap extends ErrorMap> extends Enhan
 declare function enhanceContractRouter<T extends AnyContractRouter, TErrorMap extends ErrorMap>(router: T, options: EnhanceContractRouterOptions<TErrorMap>): EnhancedContractRouter<T, TErrorMap>;
 
 interface ContractProcedureBuilder<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
+    /**
+     * Adds type-safe custom errors to the contract.
+     * The provided errors are spared-merged with any existing errors in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
+     */
     errors<U extends ErrorMap>(errors: U): ContractProcedureBuilder<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
+    /**
+     * Sets or updates the metadata for the contract.
+     * The provided metadata is spared-merged with any existing metadata in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
+     */
     meta(meta: TMeta): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Sets or updates the route definition for the contract.
+     * The provided route is spared-merged with any existing route in the contract.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
+     */
     route(route: Route): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Defines the input validation schema for the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
+     */
     input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInput<U, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Defines the output validation schema for the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
+     */
     output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithOutput<TInputSchema, U, TErrorMap, TMeta>;
 }
 interface ContractProcedureBuilderWithInput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
+    /**
+     * Adds type-safe custom errors to the contract.
+     * The provided errors are spared-merged with any existing errors in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
+     */
     errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
+    /**
+     * Sets or updates the metadata for the contract.
+     * The provided metadata is spared-merged with any existing metadata in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
+     */
     meta(meta: TMeta): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Sets or updates the route definition for the contract.
+     * The provided route is spared-merged with any existing route in the contract.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
+     */
     route(route: Route): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Defines the output validation schema for the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
+     */
     output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInputOutput<TInputSchema, U, TErrorMap, TMeta>;
 }
 interface ContractProcedureBuilderWithOutput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
+    /**
+     * Adds type-safe custom errors to the contract.
+     * The provided errors are spared-merged with any existing errors in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
+     */
     errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
+    /**
+     * Sets or updates the metadata for the contract.
+     * The provided metadata is spared-merged with any existing metadata in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
+     */
     meta(meta: TMeta): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Sets or updates the route definition for the contract.
+     * The provided route is spared-merged with any existing route in the contract.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
+     */
     route(route: Route): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Defines the input validation schema for the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
+     */
     input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInputOutput<U, TOutputSchema, TErrorMap, TMeta>;
 }
 interface ContractProcedureBuilderWithInputOutput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
+    /**
+     * Adds type-safe custom errors to the contract.
+     * The provided errors are spared-merged with any existing errors in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
+     */
     errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
+    /**
+     * Sets or updates the metadata for the contract.
+     * The provided metadata is spared-merged with any existing metadata in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
+     */
     meta(meta: TMeta): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Sets or updates the route definition for the contract.
+     * The provided route is spared-merged with any existing route in the contract.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
+     */
     route(route: Route): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
 }
 interface ContractRouterBuilder<TErrorMap extends ErrorMap, TMeta extends Meta> {
+    /**
+     * This property holds the defined options for the contract router.
+     */
     '~orpc': EnhanceContractRouterOptions<TErrorMap>;
+    /**
+     * Adds type-safe custom errors to the contract.
+     * The provided errors are spared-merged with any existing errors in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
+     */
     'errors'<U extends ErrorMap>(errors: U): ContractRouterBuilder<MergedErrorMap<TErrorMap, U>, TMeta>;
+    /**
+     * Prefixes all procedures in the contract router.
+     * The provided prefix is post-appended to any existing router prefix.
+     *
+     * @note This option does not affect procedures that do not define a path in their route definition.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
+     */
     'prefix'(prefix: HTTPPath): ContractRouterBuilder<TErrorMap, TMeta>;
+    /**
+     * Adds tags to all procedures in the contract router.
+     * This helpful when you want to group procedures together in the OpenAPI specification.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
+     */
     'tag'(...tags: string[]): ContractRouterBuilder<TErrorMap, TMeta>;
+    /**
+     * Applies all of the previously defined options to the specified contract router.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
+     */
     'router'<T extends ContractRouter<TMeta>>(router: T): EnhancedContractRouter<T, TErrorMap>;
 }
 
 interface ContractBuilderDef<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>, EnhanceContractRouterOptions<TErrorMap> {
 }
 declare class ContractBuilder<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
+    /**
+     * This property holds the defined options for the contract.
+     */
     '~orpc': ContractBuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
     constructor(def: ContractBuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
     /**
-     * Reset initial meta
+     * Sets or overrides the initial meta.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
      */
     $meta<U extends Meta>(initialMeta: U): ContractBuilder<TInputSchema, TOutputSchema, TErrorMap, U & Record<never, never>>;
     /**
-     * Reset initial route
+     * Sets or overrides the initial route.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
      */
     $route(initialRoute: Route): ContractBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Adds type-safe custom errors to the contract.
+     * The provided errors are spared-merged with any existing errors in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
+     */
     errors<U extends ErrorMap>(errors: U): ContractBuilder<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
+    /**
+     * Sets or updates the metadata for the contract.
+     * The provided metadata is spared-merged with any existing metadata in the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
+     */
     meta(meta: TMeta): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Sets or updates the route definition for the contract.
+     * The provided route is spared-merged with any existing route in the contract.
+     * This option is typically relevant when integrating with OpenAPI.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+     * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
+     */
     route(route: Route): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Defines the input validation schema for the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
+     */
     input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInput<U, TOutputSchema, TErrorMap, TMeta>;
+    /**
+     * Defines the output validation schema for the contract.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
+     */
     output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithOutput<TInputSchema, U, TErrorMap, TMeta>;
+    /**
+     * Prefixes all procedures in the contract router.
+     * The provided prefix is post-appended to any existing router prefix.
+     *
+     * @note This option does not affect procedures that do not define a path in their route definition.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
+     */
     prefix(prefix: HTTPPath): ContractRouterBuilder<TErrorMap, TMeta>;
+    /**
+     * Adds tags to all procedures in the contract router.
+     * This helpful when you want to group procedures together in the OpenAPI specification.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
+     */
     tag(...tags: string[]): ContractRouterBuilder<TErrorMap, TMeta>;
+    /**
+     * Applies all of the previously defined options to the specified contract router.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
+     */
     router<T extends ContractRouter<TMeta>>(router: T): EnhancedContractRouter<T, TErrorMap>;
 }
 declare const oc: ContractBuilder<Schema<unknown, unknown>, Schema<unknown, unknown>, Record<never, never>, Record<never, never>>;
@@ -222,6 +493,11 @@ interface EventIteratorSchemaDetails {
     yields: AnySchema;
     returns?: AnySchema;
 }
+/**
+ * Define schema for an event iterator.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/event-iterator#validate-event-iterator Validate Event Iterator Docs}
+ */
 declare function eventIterator<TYieldIn, TYieldOut, TReturnIn = unknown, TReturnOut = unknown>(yields: Schema<TYieldIn, TYieldOut>, returns?: Schema<TReturnIn, TReturnOut>): Schema<AsyncIteratorObject<TYieldIn, TReturnIn, void>, AsyncIteratorObject<TYieldOut, TReturnOut, void>>;
 declare function getEventIteratorSchemaDetails(schema: AnySchema | undefined): undefined | EventIteratorSchemaDetails;
 
@@ -231,4 +507,5 @@ type ContractRouterClient<TRouter extends AnyContractRouter, TClientContext exte
     [K in keyof TRouter]: TRouter[K] extends AnyContractRouter ? ContractRouterClient<TRouter[K], TClientContext> : never;
 };
 
-export { type AnyContractProcedure, type AnyContractRouter, type AnySchema, ContractBuilder, type ContractBuilderDef, type ContractConfig, ContractProcedure, type ContractProcedureBuilder, type ContractProcedureBuilderWithInput, type ContractProcedureBuilderWithInputOutput, type ContractProcedureBuilderWithOutput, type ContractProcedureClient, type ContractProcedureDef, type ContractRouter, type ContractRouterBuilder, type ContractRouterClient, type EnhanceContractRouterOptions, type EnhanceRouteOptions, type EnhancedContractRouter, type ErrorFromErrorMap, type ErrorMap, type ErrorMapItem, type EventIteratorSchemaDetails, type InferContractRouterErrorMap, type InferContractRouterInputs, type InferContractRouterMeta, type InferContractRouterOutputs, type InferSchemaInput, type InferSchemaOutput, type InputStructure, type MergedErrorMap, type Meta, type ORPCErrorFromErrorMap, type OutputStructure, type Route, type Schema, type SchemaIssue, type TypeRest, ValidationError, type ValidationErrorOptions, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, isContractProcedure, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, oc, prefixRoute, type, unshiftTagRoute };
+export { ContractBuilder, ContractProcedure, ValidationError, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, isContractProcedure, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, oc, prefixRoute, type, unshiftTagRoute };
+export type { AnyContractProcedure, AnyContractRouter, AnySchema, ContractBuilderDef, ContractConfig, ContractProcedureBuilder, ContractProcedureBuilderWithInput, ContractProcedureBuilderWithInputOutput, ContractProcedureBuilderWithOutput, ContractProcedureClient, ContractProcedureDef, ContractRouter, ContractRouterBuilder, ContractRouterClient, EnhanceContractRouterOptions, EnhanceRouteOptions, EnhancedContractRouter, ErrorFromErrorMap, ErrorMap, ErrorMapItem, EventIteratorSchemaDetails, InferContractRouterErrorMap, InferContractRouterInputs, InferContractRouterMeta, InferContractRouterOutputs, InferSchemaInput, InferSchemaOutput, InputStructure, MergedErrorMap, Meta, ORPCErrorFromErrorMap, OutputStructure, Route, Schema, SchemaIssue, TypeRest, ValidationErrorOptions };

package/dist/index.mjs

@@ -18,6 +18,9 @@ function mergeMeta(meta1, meta2) {
 }
 
 class ContractProcedure {
+  /**
+   * This property holds the defined options for the contract procedure.
+   */
   "~orpc";
   constructor(def) {
     if (def.route?.successStatus && isORPCErrorStatus(def.route.successStatus)) {
@@ -108,7 +111,9 @@ class ContractBuilder extends ContractProcedure {
     this["~orpc"].tags = def.tags;
   }
   /**
-   * Reset initial meta
+   * Sets or overrides the initial meta.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
    */
   $meta(initialMeta) {
     return new ContractBuilder({
@@ -117,7 +122,11 @@ class ContractBuilder extends ContractProcedure {
     });
   }
   /**
-   * Reset initial route
+   * Sets or overrides the initial route.
+   * This option is typically relevant when integrating with OpenAPI.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+   * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
    */
   $route(initialRoute) {
     return new ContractBuilder({
@@ -125,48 +134,97 @@ class ContractBuilder extends ContractProcedure {
       route: initialRoute
     });
   }
+  /**
+   * Adds type-safe custom errors to the contract.
+   * The provided errors are spared-merged with any existing errors in the contract.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
+   */
   errors(errors) {
     return new ContractBuilder({
       ...this["~orpc"],
       errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
     });
   }
+  /**
+   * Sets or updates the metadata for the contract.
+   * The provided metadata is spared-merged with any existing metadata in the contract.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
+   */
   meta(meta) {
     return new ContractBuilder({
       ...this["~orpc"],
       meta: mergeMeta(this["~orpc"].meta, meta)
     });
   }
+  /**
+   * Sets or updates the route definition for the contract.
+   * The provided route is spared-merged with any existing route in the contract.
+   * This option is typically relevant when integrating with OpenAPI.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+   * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
+   */
   route(route) {
     return new ContractBuilder({
       ...this["~orpc"],
       route: mergeRoute(this["~orpc"].route, route)
     });
   }
+  /**
+   * Defines the input validation schema for the contract.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
+   */
   input(schema) {
     return new ContractBuilder({
       ...this["~orpc"],
       inputSchema: schema
     });
   }
+  /**
+   * Defines the output validation schema for the contract.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
+   */
   output(schema) {
     return new ContractBuilder({
       ...this["~orpc"],
       outputSchema: schema
     });
   }
+  /**
+   * Prefixes all procedures in the contract router.
+   * The provided prefix is post-appended to any existing router prefix.
+   *
+   * @note This option does not affect procedures that do not define a path in their route definition.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
+   */
   prefix(prefix) {
     return new ContractBuilder({
       ...this["~orpc"],
       prefix: mergePrefix(this["~orpc"].prefix, prefix)
     });
   }
+  /**
+   * Adds tags to all procedures in the contract router.
+   * This helpful when you want to group procedures together in the OpenAPI specification.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
+   */
   tag(...tags) {
     return new ContractBuilder({
       ...this["~orpc"],
       tags: mergeTags(this["~orpc"].tags, tags)
     });
   }
+  /**
+   * Applies all of the previously defined options to the specified contract router.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
+   */
   router(router) {
     return enhanceContractRouter(router, this["~orpc"]);
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/contract",
   "type": "module",
-  "version": "0.0.0-next.f538070",
+  "version": "0.0.0-next.f81b4a2",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -25,12 +25,12 @@
   ],
   "dependencies": {
     "@standard-schema/spec": "^1.0.0",
-    "@orpc/client": "0.0.0-next.f538070",
-    "@orpc/shared": "0.0.0-next.f538070"
+    "@orpc/client": "0.0.0-next.f81b4a2",
+    "@orpc/shared": "0.0.0-next.f81b4a2"
   },
   "devDependencies": {
-    "arktype": "2.0.0-rc.26",
-    "valibot": "1.0.0-beta.9",
+    "arktype": "2.1.19",
+    "valibot": "1.0.0",
     "zod": "^3.24.2"
   },
   "scripts": {