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

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

@@ -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 };

package/dist/shared/{contract.CW-2wl1i.mjs → contract.DjQcyGZi.mjs}

@@ -82,7 +82,7 @@ class ProcedureContract {
     this["~orpc"] = def;
   }
   /**
-   * 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) {
     if (this !== ProcedureContract) {
@@ -165,6 +165,7 @@ function minifyRouterContract(router) {
 }
 
 class ValidationError extends Error {
+  name = "ValidationError";
   /**
    * This array is readonly because the upstream Standard Schema returns readonly issues.
    */
@@ -177,4 +178,4 @@ class ValidationError extends Error {
   }
 }
 
-export { ProcedureContract as P, ValidationError as V, augmentContractRouter as a, getRouterContract as b, minifyRouterContract as c, defineMeta as d, reconcileORPCError as e, getProcedureContractOrThrow as g, mergeErrorMap as m, resolveMetaPlugins as r };
+export { ProcedureContract as P, ValidationError as V, augmentContractRouter as a, getProcedureContractOrThrow as b, minifyRouterContract as c, defineMeta as d, reconcileORPCError as e, getRouterContract as g, mergeErrorMap as m, resolveMetaPlugins as r };

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "@orpc/contract",
   "type": "module",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.0-beta.30",
+  "description": "Define typesafe API contracts as the single source of truth for oRPC, powered by Standard Schema",
   "license": "MIT",
+  "funding": [
+    "https://github.com/sponsors/dinwwwh",
+    "https://opencollective.com/middleapi"
+  ],
   "homepage": "https://orpc.dev",
   "repository": {
     "type": "git",
@@ -10,7 +15,15 @@
     "directory": "packages/contract"
   },
   "keywords": [
-    "orpc"
+    "orpc",
+    "rpc",
+    "api",
+    "typescript",
+    "typesafe",
+    "contract",
+    "contract-first",
+    "standard-schema",
+    "openapi"
   ],
   "sideEffects": false,
   "exports": {
@@ -31,12 +44,12 @@
   ],
   "dependencies": {
     "@standard-schema/spec": "^1.1.0",
-    "@orpc/shared": "2.0.0-beta.3",
-    "@orpc/client": "2.0.0-beta.3"
+    "@orpc/client": "2.0.0-beta.30",
+    "@orpc/shared": "2.0.0-beta.30"
   },
   "devDependencies": {
-    "arktype": "^2.1.29",
-    "valibot": "^1.2.0",
+    "arktype": "^2.2.1",
+    "valibot": "^1.4.1",
     "zod": "^4.4.3"
   },
   "scripts": {