@orpc/contract 2.0.0-beta.3 → 2.0.0-beta.30

package/dist/index.mjs

@@ -1,7 +1,7 @@
-import { isTypescriptObject, toArray, set, get, ORPC_NAME, isAsyncIteratorObject, isPropertyKey } from '@orpc/shared';
-import { P as ProcedureContract, r as resolveMetaPlugins, m as mergeErrorMap, a as augmentContractRouter, V as ValidationError } from './shared/contract.CW-2wl1i.mjs';
-export { d as defineMeta, g as getProcedureContractOrThrow, b as getRouterContract, c as minifyRouterContract, e as reconcileORPCError } from './shared/contract.CW-2wl1i.mjs';
-import { createORPCClient, wrapEventIteratorPreservingMeta, ORPCError } from '@orpc/client';
+import { isTypescriptObject, toArray, get, set, isPropertyKey, ORPC_NAME, resolveMaybeOptionalOptions, isAsyncIteratorObject } from '@orpc/shared';
+import { P as ProcedureContract, r as resolveMetaPlugins, m as mergeErrorMap, a as augmentContractRouter, V as ValidationError } from './shared/contract.DjQcyGZi.mjs';
+export { d as defineMeta, g as getContractRouter, b as getProcedureContractOrThrow, g as getRouterContract, c as minifyContractRouter, c as minifyRouterContract, e as reconcileORPCError } from './shared/contract.DjQcyGZi.mjs';
+import { createORPCClient, ORPCError, wrapAsyncIteratorPreservingEventMeta } from '@orpc/client';
 
 const HIDDEN_META_PLUGINS_SYMBOL = Symbol.for("ORPC_HIDDEN_META_PLUGINS");
 function getHiddenMetaPlugins(container) {
@@ -22,12 +22,23 @@ class ContractBuilder extends ProcedureContract {
   constructor(definition) {
     super(definition);
   }
+  /**
+   * Creates a fresh contract builder with an empty definition.
+   * Prefer the exported `oc` instance over calling this directly.
+   *
+   * @see {@link https://orpc.dev/docs/contract/procedure | Procedure Contract}
+   */
   static create() {
     return new ContractBuilder({
       errorMap: {},
       meta: {}
     });
   }
+  /**
+   * Applies metadata plugins to contracts built from this builder.
+   *
+   * @see {@link https://orpc.dev/docs/contract/procedure#metadata | Procedure Contract - Metadata}
+   */
   meta(...plugins) {
     const [meta, metaPlugins] = resolveMetaPlugins(
       this["~orpc"].meta,
@@ -40,6 +51,11 @@ class ContractBuilder extends ProcedureContract {
       metaPlugins
     });
   }
+  /**
+   * Defines typesafe errors that implementations of this contract can throw.
+   *
+   * @see {@link https://orpc.dev/docs/contract/procedure#typesafe-errors | Procedure Contract - Typesafe Errors}
+   */
   errors(errors) {
     let result = new ContractBuilder({
       ...this["~orpc"],
@@ -51,6 +67,11 @@ class ContractBuilder extends ProcedureContract {
     }
     return result;
   }
+  /**
+   * Defines the input schema used to validate and type the procedure input.
+   *
+   * @see {@link https://orpc.dev/docs/contract/procedure#inputoutput-validation | Procedure Contract - Input/Output Validation}
+   */
   input(schema) {
     let result = new ContractBuilder({
       ...this["~orpc"],
@@ -62,6 +83,11 @@ class ContractBuilder extends ProcedureContract {
     }
     return result;
   }
+  /**
+   * Defines the output schema used to validate and type the procedure output.
+   *
+   * @see {@link https://orpc.dev/docs/contract/procedure#inputoutput-validation | Procedure Contract - Input/Output Validation}
+   */
   output(schema) {
     let result = new ContractBuilder({
       ...this["~orpc"],
@@ -73,6 +99,12 @@ class ContractBuilder extends ProcedureContract {
     }
     return result;
   }
+  /**
+   * Applies the builder's errors and metadata to every procedure contract in
+   * the given router contract.
+   *
+   * @see {@link https://orpc.dev/docs/contract/router#extending-router | Router Contract - Extending Router}
+   */
   router(router) {
     return augmentContractRouter(router, this["~orpc"]);
   }
@@ -95,41 +127,170 @@ const meta = {
 function getPathMeta(procedureOrLazy) {
   return procedureOrLazy["~orpc"].meta["~path"];
 }
-
-function createContractCaller(link, options = {}) {
-  return async (procedure, ...rest) => {
-    const path = getPathMeta(procedure);
+function resolveBasePathMeta(contract, currentPath = []) {
+  if (contract instanceof ProcedureContract) {
+    const path = getPathMeta(contract);
     if (!path) {
+      return void 0;
+    }
+    const base = path.slice(0, Math.max(0, path.length - currentPath.length));
+    if (currentPath.some((key, i) => path[base.length + i] !== key)) {
       throw new TypeError(
-        "ContractCaller: procedure contract must define `meta.path` that matches its path in the root router contract."
+        `Procedure contract at "${currentPath.join(".")}" defines meta.path "${path.join(".")}" that does not match its path inside the given router contract.`
       );
     }
-    if (options.contractRef) {
-      set(options.contractRef, [...path, "~orpc"], procedure["~orpc"]);
+    return base;
+  }
+  if (isTypescriptObject(contract)) {
+    for (const key in contract) {
+      const base = resolveBasePathMeta(contract[key], [...currentPath, key]);
+      if (base !== void 0) {
+        return base;
+      }
     }
-    const scoped = get(options.scoped, path);
-    if (scoped !== void 0 && (scoped === null || typeof scoped !== "object")) {
+  }
+  return void 0;
+}
+
+function createContractClientFactory(link, options = {}) {
+  const factory = (contract) => {
+    const path = resolveBasePathMeta(contract);
+    if (path === void 0) {
       throw new TypeError(
-        `ContractCaller: "scoped" at path "${path.join(".")}" must be an object or undefined, got "${scoped}".`
+        "ContractClientFactory: procedure contract must define `meta.path` that matches its path in the root router contract."
       );
     }
-    const client = createORPCClient(link, { path, interceptors: options.interceptors, scoped });
-    return client(...rest);
+    const contractRef = options.contractRef;
+    if (contractRef) {
+      const register = (contract2, path2) => {
+        if (contract2 instanceof ProcedureContract) {
+          set(contractRef, [...path2, "~orpc"], contract2["~orpc"]);
+          return;
+        }
+        if (isTypescriptObject(contract2)) {
+          for (const [key, value] of Object.entries(contract2)) {
+            register(value, [...path2, key]);
+          }
+        }
+      };
+      register(contract, path);
+    }
+    return createORPCClient(link, { ...options, scoped: get(options.scoped, path), path });
   };
+  return factory;
 }
 
-const EVENT_ITERATOR_SCHEMA_DETAILS_SYMBOL = Symbol.for("ORPC_EVENT_ITERATOR_SCHEMA_DETAILS");
-function eventIterator(yieldSchema, returnSchema) {
+function type(...[map]) {
   return {
     "~standard": {
-      [EVENT_ITERATOR_SCHEMA_DETAILS_SYMBOL]: { yieldSchema, returnSchema },
+      vendor: ORPC_NAME,
+      version: 1,
+      async validate(value) {
+        if (map) {
+          return { value: await map(value) };
+        }
+        return { value };
+      }
+    }
+  };
+}
+function isSchemaIssue(issue) {
+  if (!isTypescriptObject(issue) || typeof issue.message !== "string") {
+    return false;
+  }
+  if (issue.path !== void 0) {
+    if (!Array.isArray(issue.path)) {
+      return false;
+    }
+    if (!issue.path.every((segment) => isPropertyKey(segment) || isTypescriptObject(segment) && isPropertyKey(segment.key))) {
+      return false;
+    }
+  }
+  return true;
+}
+
+function error(code, { data: dataSchema, message } = {}) {
+  const validateData = (schema, value) => {
+    const result = schema["~standard"].validate(value);
+    if (result instanceof Promise) {
+      throw new TypeError(
+        `Error factory "${code}" does not support async data schemas.`
+      );
+    }
+    return result;
+  };
+  return class extends ORPCError {
+    static code = code;
+    static data = dataSchema ?? type();
+    static message = message;
+    constructor(...rest) {
+      const options = resolveMaybeOptionalOptions(rest);
+      let data = options.data;
+      if (dataSchema) {
+        const result = validateData(dataSchema, options.data);
+        if (result.issues) {
+          throw new ValidationError({
+            message: `Error factory "${code}" data validation failed`,
+            issues: result.issues,
+            invalidData: options.data
+          });
+        }
+        data = result.value;
+      }
+      super(code, { message, ...options, data });
+    }
+    static [Symbol.hasInstance](instance) {
+      if (!(instance instanceof ORPCError)) {
+        return false;
+      }
+      if (instance.code !== code) {
+        return false;
+      }
+      if (dataSchema && validateData(dataSchema, instance.data).issues) {
+        return false;
+      }
+      return true;
+    }
+  };
+}
+function createORPCErrorConstructorMap(errorMap) {
+  const proxy = new Proxy(errorMap, {
+    get(target, code) {
+      if (typeof code !== "string") {
+        return Reflect.get(target, code);
+      }
+      const item = (...rest) => {
+        const options = resolveMaybeOptionalOptions(rest);
+        const config = errorMap[code];
+        const error2 = new ORPCError(code, {
+          message: options.message ?? config?.message,
+          data: options.data,
+          cause: options.cause
+        });
+        if (config) {
+          error2.defined = true;
+          error2.inferable = true;
+        }
+        return error2;
+      };
+      return item;
+    }
+  });
+  return proxy;
+}
+
+const ASYNC_ITERATOR_OBJECT_SCHEMA_DETAILS_SYMBOL = Symbol.for("ORPC_ASYNC_ITERATOR_OBJECT_SCHEMA_DETAILS");
+function asyncIteratorObject(yieldSchema, returnSchema) {
+  return {
+    "~standard": {
+      [ASYNC_ITERATOR_OBJECT_SCHEMA_DETAILS_SYMBOL]: { yieldSchema, returnSchema },
       vendor: ORPC_NAME,
       version: 1,
       validate(iterator) {
         if (!isAsyncIteratorObject(iterator)) {
-          return { issues: [{ message: "Expect event iterator", path: [] }] };
+          return { issues: [{ message: "Expect AsyncIteratorObject", path: [] }] };
         }
-        const mapped = wrapEventIteratorPreservingMeta(iterator, {
+        const mapped = wrapAsyncIteratorPreservingEventMeta(iterator, {
           async mapResult(result) {
             const schema = result.done ? returnSchema : yieldSchema;
             if (!schema) {
@@ -137,11 +298,11 @@ function eventIterator(yieldSchema, returnSchema) {
             }
             const validated = await schema["~standard"].validate(result.value);
             if (validated.issues) {
-              throw new ORPCError("EVENT_ITERATOR_VALIDATION_FAILED", {
-                message: "Event iterator validation failed",
+              throw new ORPCError("ASYNC_ITERATOR_OBJECT_VALIDATION_FAILED", {
+                message: "AsyncIteratorObject validation failed",
                 cause: new ValidationError({
                   issues: validated.issues,
-                  message: "Event iterator validation failed",
+                  message: "AsyncIteratorObject validation failed",
                   invalidData: result.value
                 })
               });
@@ -154,40 +315,11 @@ function eventIterator(yieldSchema, returnSchema) {
     }
   };
 }
-function getEventIteratorSchemaDetails(schema) {
+function getAsyncIteratorObjectSchemaDetails(schema) {
   if (schema === void 0) {
     return void 0;
   }
-  return schema["~standard"][EVENT_ITERATOR_SCHEMA_DETAILS_SYMBOL];
-}
-
-function type(...[map]) {
-  return {
-    "~standard": {
-      vendor: ORPC_NAME,
-      version: 1,
-      async validate(value) {
-        if (map) {
-          return { value: await map(value) };
-        }
-        return { value };
-      }
-    }
-  };
-}
-function isSchemaIssue(issue) {
-  if (!isTypescriptObject(issue) || typeof issue.message !== "string") {
-    return false;
-  }
-  if (issue.path !== void 0) {
-    if (!Array.isArray(issue.path)) {
-      return false;
-    }
-    if (!issue.path.every((segment) => isPropertyKey(segment) || isTypescriptObject(segment) && isPropertyKey(segment.key))) {
-      return false;
-    }
-  }
-  return true;
+  return schema["~standard"][ASYNC_ITERATOR_OBJECT_SCHEMA_DETAILS_SYMBOL];
 }
 
-export { ContractBuilder, HIDDEN_META_PLUGINS_SYMBOL, ProcedureContract, ValidationError, augmentContractRouter, createContractCaller, eventIterator, getEventIteratorSchemaDetails, getHiddenMetaPlugins, getPathMeta, isSchemaIssue, mergeErrorMap, meta, oc, resolveMetaPlugins, setHiddenMetaPlugins, type };
+export { ContractBuilder, HIDDEN_META_PLUGINS_SYMBOL, ProcedureContract, ValidationError, asyncIteratorObject, augmentContractRouter, createContractClientFactory, createORPCErrorConstructorMap, error, asyncIteratorObject as eventIterator, getAsyncIteratorObjectSchemaDetails, getHiddenMetaPlugins, getPathMeta, isSchemaIssue, mergeErrorMap, meta, oc, resolveBasePathMeta, resolveMetaPlugins, setHiddenMetaPlugins, type };

package/dist/plugins/index.d.mts

@@ -1,6 +1,6 @@
 import { ClientContext } from '@orpc/client';
 import { StandardLinkPlugin, StandardLinkOptions } from '@orpc/client/standard';
-import { R as RouterContract } from '../shared/contract.Do92aRJ4.mjs';
+import { RouterContract } from '../index.mjs';
 import '@orpc/shared';
 import '@standard-schema/spec';
 
@@ -18,6 +18,9 @@ interface RequestValidationLinkPluginOptions<_T extends ClientContext> {
 }
 /**
  * Validates client request input against contract schemas before the request is encoded.
+ * This is useful when your application relies on server-side validation.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/request-validation | Request Validation Plugin}
  */
 declare class RequestValidationLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     private readonly contract;
@@ -27,6 +30,12 @@ declare class RequestValidationLinkPlugin<T extends ClientContext> implements St
     init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
 }
 
+/**
+ * Validates server responses against contract schemas before your application uses them.
+ * This helps ensure the data returned by the server matches the types defined in your contract.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/response-validation | Response Validation Plugin}
+ */
 declare class ResponseValidationLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     private readonly contract;
     name: string;
@@ -34,5 +43,5 @@ declare class ResponseValidationLinkPlugin<T extends ClientContext> implements S
     init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
 }
 
-export { RequestValidationLinkPlugin, ResponseValidationLinkPlugin };
+export { RequestValidationLinkPlugin, RequestValidationLinkPlugin as RequestValidationPlugin, ResponseValidationLinkPlugin, ResponseValidationLinkPlugin as ResponseValidationPlugin };
 export type { RequestValidationLinkPluginOptions };

package/dist/plugins/index.d.ts

@@ -1,6 +1,6 @@
 import { ClientContext } from '@orpc/client';
 import { StandardLinkPlugin, StandardLinkOptions } from '@orpc/client/standard';
-import { R as RouterContract } from '../shared/contract.Do92aRJ4.js';
+import { RouterContract } from '../index.js';
 import '@orpc/shared';
 import '@standard-schema/spec';
 
@@ -18,6 +18,9 @@ interface RequestValidationLinkPluginOptions<_T extends ClientContext> {
 }
 /**
  * Validates client request input against contract schemas before the request is encoded.
+ * This is useful when your application relies on server-side validation.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/request-validation | Request Validation Plugin}
  */
 declare class RequestValidationLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     private readonly contract;
@@ -27,6 +30,12 @@ declare class RequestValidationLinkPlugin<T extends ClientContext> implements St
     init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
 }
 
+/**
+ * Validates server responses against contract schemas before your application uses them.
+ * This helps ensure the data returned by the server matches the types defined in your contract.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/response-validation | Response Validation Plugin}
+ */
 declare class ResponseValidationLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     private readonly contract;
     name: string;
@@ -34,5 +43,5 @@ declare class ResponseValidationLinkPlugin<T extends ClientContext> implements S
     init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
 }
 
-export { RequestValidationLinkPlugin, ResponseValidationLinkPlugin };
+export { RequestValidationLinkPlugin, RequestValidationLinkPlugin as RequestValidationPlugin, ResponseValidationLinkPlugin, ResponseValidationLinkPlugin as ResponseValidationPlugin };
 export type { RequestValidationLinkPluginOptions };

package/dist/plugins/index.mjs

@@ -1,6 +1,6 @@
 import { ORPCError } from '@orpc/client';
-import { toArray } from '@orpc/shared';
-import { g as getProcedureContractOrThrow, V as ValidationError, e as reconcileORPCError } from '../shared/contract.CW-2wl1i.mjs';
+import { toArray, isPlainObject, mergeTwoLevels } from '@orpc/shared';
+import { b as getProcedureContractOrThrow, V as ValidationError, e as reconcileORPCError } from '../shared/contract.DjQcyGZi.mjs';
 
 class RequestValidationLinkPlugin {
   constructor(contract, options = {}) {
@@ -14,25 +14,26 @@ class RequestValidationLinkPlugin {
       ...options,
       interceptors: [...toArray(options.interceptors), async ({ next, ...interceptorOptions }) => {
         const procedure = getProcedureContractOrThrow(this.contract, interceptorOptions.path);
-        let currentInput = interceptorOptions.input;
-        if (procedure["~orpc"].inputSchemas) {
-          for (const schema of procedure["~orpc"].inputSchemas) {
-            const result = await schema["~standard"].validate(currentInput);
-            if (result.issues) {
-              throw new ORPCError("BAD_REQUEST", {
+        const inputSchemas = toArray(procedure["~orpc"].inputSchemas);
+        const originalInput = interceptorOptions.input;
+        let currentInput = originalInput;
+        for (const [index, schema] of inputSchemas.entries()) {
+          const validating = inputSchemas.length > 1 && isPlainObject(currentInput) ? originalInput : currentInput;
+          const result = await schema["~standard"].validate(validating);
+          if (result.issues) {
+            throw new ORPCError("BAD_REQUEST", {
+              message: "Input validation failed",
+              data: {
+                issues: result.issues
+              },
+              cause: new ValidationError({
                 message: "Input validation failed",
-                data: {
-                  issues: result.issues
-                },
-                cause: new ValidationError({
-                  message: "Input validation failed",
-                  issues: result.issues,
-                  invalidData: currentInput
-                })
-              });
-            }
-            currentInput = result.value;
+                issues: result.issues,
+                invalidData: validating
+              })
+            });
           }
+          currentInput = index !== 0 ? mergeTwoLevels(currentInput, result.value) : result.value;
         }
         return this.forwardValidatedInput ? next({ ...interceptorOptions, input: currentInput }) : next();
       }]
@@ -87,4 +88,4 @@ class ResponseValidationLinkPlugin {
   }
 }
 
-export { RequestValidationLinkPlugin, ResponseValidationLinkPlugin };
+export { RequestValidationLinkPlugin, RequestValidationLinkPlugin as RequestValidationPlugin, ResponseValidationLinkPlugin, ResponseValidationLinkPlugin as ResponseValidationPlugin };

package/dist/shared/{contract.Do92aRJ4.d.mts → contract.DUiXUlmP.d.mts}

@@ -6,28 +6,63 @@ import { StandardSchemaV1 } from '@standard-schema/spec';
  * TOutput default = TInput for better readability (shorter) in-case both TInput, TOutput is equal
  */
 type Schema<TInput, TOutput = TInput> = StandardSchemaV1<TInput, TOutput>;
+/**
+ * Any Standard Schema compatible schema, regardless of its input and output types.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/standard-schema | Standard Schema Integration}
+ */
 type AnySchema = Schema<any>;
 type SchemaIssue = StandardSchemaV1.Issue;
+/**
+ * Infers the input type of a schema.
+ *
+ * @see {@link https://orpc.dev/docs/metadata | Metadata}
+ */
 type InferSchemaInput<T extends AnySchema> = T extends StandardSchemaV1<infer UInput, any> ? UInput : never;
+/**
+ * Infers the output type of a schema.
+ *
+ * @see {@link https://orpc.dev/docs/metadata | Metadata}
+ */
 type InferSchemaOutput<T extends AnySchema> = T extends StandardSchemaV1<any, infer UOutput> ? UOutput : never;
 type MergedSchema<T extends AnySchema, U extends AnySchema> = T extends Schema<infer TInput, infer TOutput> ? U extends Schema<infer UInput, infer UOutput> ? Schema<TInput & UInput, TOutput & UOutput> : never : never;
 
-interface ErrorMapItem<TDataSchema extends AnySchema> {
-    message?: string;
-    data?: TDataSchema;
+interface ErrorMapItem {
+    /**
+     * Default message, can be overridden when constructing an error.
+     */
+    message?: undefined | string;
+    /**
+     * Schema used to type and validate the error data.
+     */
+    data?: undefined | AnySchema;
 }
+/**
+ * Map of error codes to their definitions, as passed to `.errors(...)`.
+ * Errors defined here remain properly typed on the client.
+ *
+ * @see {@link https://orpc.dev/docs/metadata | Metadata}
+ */
 type ErrorMap = {
-    [key in ORPCErrorCode]?: ErrorMapItem<AnySchema>;
+    [key in ORPCErrorCode]?: ErrorMapItem;
 };
 type ORPCErrorFromErrorMap<TErrorMap extends ErrorMap> = {
-    [K in keyof TErrorMap]: K extends string ? TErrorMap[K] extends ErrorMapItem<infer TDataSchema extends Schema<unknown>> ? ORPCError<K, InferSchemaOutput<TDataSchema>> : never : never;
+    [K in keyof TErrorMap]: TErrorMap[K] extends ErrorMapItem ? ORPCError<K & ORPCErrorCode, TErrorMap[K]['data'] extends AnySchema ? InferSchemaOutput<TErrorMap[K]['data']> : unknown> : never;
 }[keyof TErrorMap];
 interface ValidationErrorOptions extends ErrorOptions {
     message: string;
     issues: readonly SchemaIssue[];
     invalidData: unknown;
 }
+/**
+ * Error thrown when input, output, or error data fails schema validation,
+ * carrying the standard-schema `issues` and the invalid data.
+ * Usually found as the `cause` of an `ORPCError`.
+ *
+ * @see {@link https://orpc.dev/docs/advanced/validation-customization | Validation Customization}
+ */
 declare class ValidationError extends Error {
+    name: string;
     /**
      * This array is readonly because the upstream Standard Schema returns readonly issues.
      */
@@ -36,6 +71,12 @@ declare class ValidationError extends Error {
     constructor(options: ValidationErrorOptions);
 }
 
+/**
+ * Arbitrary metadata attached to a procedure.
+ * Middleware, plugins, and tooling can read it later to control behavior.
+ *
+ * @see {@link https://orpc.dev/docs/metadata | Metadata}
+ */
 interface Meta {
     [key: PropertyKey]: unknown;
 }
@@ -50,6 +91,12 @@ interface MetaPluginDefinition<TInputSchema extends AnySchema, TOutputSchema ext
         type: TErrorMap;
     };
 }
+/**
+ * A metadata plugin passed to `.meta(...)`.
+ * Defines how metadata is initialized and merged, and can infer or restrict procedure types.
+ *
+ * @see {@link https://orpc.dev/docs/metadata | Metadata}
+ */
 interface MetaPlugin<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
     /** This only for types, so it should be optional */
     '~orpc'?: MetaPluginDefinition<TInputSchema, TOutputSchema, TErrorMap> | undefined;
@@ -66,6 +113,12 @@ interface MetaPlugin<TInputSchema extends AnySchema, TOutputSchema extends AnySc
      */
     'apply'?: (meta: Meta) => Meta;
 }
+/**
+ * A `MetaPlugin` with all type parameters relaxed to `any`.
+ *
+ * @see {@link https://orpc.dev/docs/contract/procedure | Procedure Contract}
+ * @see {@link https://orpc.dev/docs/procedure | Procedure}
+ */
 type AnyMetaPlugin = MetaPlugin<any, any, any>;
 declare const HIDDEN_META_PLUGINS_SYMBOL: unique symbol;
 declare function getHiddenMetaPlugins(container: unknown): AnyMetaPlugin[] | undefined;
@@ -91,36 +144,60 @@ declare class ProcedureContract<TInputSchema extends AnySchema, TOutputSchema ex
     '~orpc': ProcedureContractDefinition<TInputSchema, TOutputSchema, TErrorMap>;
     constructor(def: ProcedureContractDefinition<TInputSchema, TOutputSchema, TErrorMap>);
     /**
-     * Checks if the given instance satisfies the {@see ProcedureContract} class/interface.
+     * Checks if the given instance satisfies the {@link ProcedureContract} class/interface.
      */
     static [Symbol.hasInstance](instance: unknown): boolean;
 }
 type AnyProcedureContract = ProcedureContract<any, any, any>;
 
+/**
+ * A router contract: a single procedure contract or a nested record of them.
+ *
+ * @see {@link https://orpc.dev/docs/advanced/scaling-large-projects | Scaling Large Projects}
+ */
 type RouterContract = AnyProcedureContract | {
     [k: string]: RouterContract;
 };
+/**
+ * Infer the input types for each procedure-contract, preserving the router-contract shape.
+ *
+ * @see {@link https://orpc.dev/docs/contract/router#infer-router-contract-inputs | Router Contract - Infer Router Contract Inputs}
+ */
 type InferRouterContractInputs<T extends RouterContract> = T extends ProcedureContract<infer UInputSchema, any, any> ? InferSchemaInput<UInputSchema> : {
     [K in keyof T]: T[K] extends RouterContract ? InferRouterContractInputs<T[K]> : never;
 };
+/**
+ * Infer the output types for each procedure-contract, preserving the router-contract shape.
+ *
+ * @see {@link https://orpc.dev/docs/contract/router#infer-router-contract-outputs | Router Contract - Infer Router Contract Outputs}
+ */
 type InferRouterContractOutputs<T extends RouterContract> = T extends ProcedureContract<any, infer UOutputSchema, any> ? InferSchemaOutput<UOutputSchema> : {
     [K in keyof T]: T[K] extends RouterContract ? InferRouterContractOutputs<T[K]> : never;
 };
+/**
+ * Infer the union of error maps defined across the entire router-contract.
+ *
+ * @see {@link https://orpc.dev/docs/contract/router#infer-router-contract-error-map | Router Contract - Infer Router Contract Error Map}
+ */
 type InferRouterContractErrorMap<T extends RouterContract> = T extends ProcedureContract<any, any, infer UErrorMap> ? UErrorMap : {
     [K in keyof T]: T[K] extends RouterContract ? InferRouterContractErrorMap<T[K]> : never;
 }[keyof T];
 /**
  * Infer the union of throwable errors for entire router-contract.
+ *
+ * @see {@link https://orpc.dev/docs/contract/router#infer-router-contract-error | Router Contract - Infer Router Contract Error}
  */
 type InferRouterContractError<T extends RouterContract> = T extends ProcedureContract<any, any, infer UErrorMap> ? ORPCErrorFromErrorMap<UErrorMap> | ThrowableError : {
     [K in keyof T]: T[K] extends RouterContract ? InferRouterContractError<T[K]> : never;
 }[keyof T];
 /**
  * Infer throwable errors for each procedure-contract, preserving the router-contract shape.
+ *
+ * @see {@link https://orpc.dev/docs/contract/router#infer-router-contract-errors | Router Contract - Infer Router Contract Errors}
  */
 type InferRouterContractErrors<T extends RouterContract> = T extends ProcedureContract<any, any, infer UErrorMap> ? ORPCErrorFromErrorMap<UErrorMap> | ThrowableError : {
     [K in keyof T]: T[K] extends RouterContract ? InferRouterContractErrors<T[K]> : never;
 };
 
 export { HIDDEN_META_PLUGINS_SYMBOL as H, ProcedureContract as P, ValidationError as V, getHiddenMetaPlugins as p, setHiddenMetaPlugins as s };
-export type { AnySchema as A, ErrorMap as E, InferSchemaInput as I, MetaPlugin as M, ORPCErrorFromErrorMap as O, RouterContract as R, Schema as S, MergedSchema as a, Meta as b, AnyMetaPlugin as c, AnyProcedureContract as d, InferSchemaOutput as e, SchemaIssue as f, ErrorMapItem as g, InferRouterContractError as h, InferRouterContractErrorMap as i, InferRouterContractErrors as j, InferRouterContractInputs as k, InferRouterContractOutputs as l, MetaPluginDefinition as m, ProcedureContractDefinition as n, ValidationErrorOptions as o };
+export type { AnySchema as A, ErrorMap as E, InferSchemaInput as I, MetaPlugin as M, ORPCErrorFromErrorMap as O, RouterContract as R, Schema as S, MergedSchema as a, Meta as b, AnyMetaPlugin as c, AnyProcedureContract as d, InferSchemaOutput as e, ErrorMapItem as f, SchemaIssue as g, InferRouterContractErrorMap as h, InferRouterContractInputs as i, InferRouterContractOutputs as j, InferRouterContractError as k, InferRouterContractErrors as l, MetaPluginDefinition as m, ProcedureContractDefinition as n, ValidationErrorOptions as o };