@orpc/contract 0.0.0-next.c12be86 → 0.0.0-next.c4a591c

package/dist/index.js

@@ -6,6 +6,9 @@ var ContractProcedure = class {
     if (def.route?.successStatus && (def.route.successStatus < 200 || def.route?.successStatus > 299)) {
       throw new Error("[ContractProcedure] The successStatus must be between 200 and 299");
     }
+    if (Object.values(def.errorMap ?? {}).some((val) => val && val.status && (val.status < 400 || val.status > 599))) {
+      throw new Error("[ContractProcedure] The error status code must be in the 400-599 range.");
+    }
     this["~orpc"] = def;
   }
 };
@@ -13,7 +16,7 @@ function isContractProcedure(item) {
   if (item instanceof ContractProcedure) {
     return true;
   }
-  return (typeof item === "object" || typeof item === "function") && item !== null && "~type" in item && item["~type"] === "ContractProcedure" && "~orpc" in item && typeof item["~orpc"] === "object" && item["~orpc"] !== null && "InputSchema" in item["~orpc"] && "OutputSchema" in item["~orpc"];
+  return (typeof item === "object" || typeof item === "function") && item !== null && "~type" in item && item["~type"] === "ContractProcedure" && "~orpc" in item && typeof item["~orpc"] === "object" && item["~orpc"] !== null && "InputSchema" in item["~orpc"] && "OutputSchema" in item["~orpc"] && "errorMap" in item["~orpc"];
 }
 
 // src/procedure-decorated.ts
@@ -27,7 +30,10 @@ var DecoratedContractProcedure = class _DecoratedContractProcedure extends Contr
   route(route) {
     return new _DecoratedContractProcedure({
       ...this["~orpc"],
-      route
+      route: {
+        ...this["~orpc"].route,
+        ...route
+      }
     });
   }
   prefix(prefix) {
@@ -67,6 +73,15 @@ var DecoratedContractProcedure = class _DecoratedContractProcedure extends Contr
       outputExample: example
     });
   }
+  errors(errors) {
+    return new _DecoratedContractProcedure({
+      ...this["~orpc"],
+      errorMap: {
+        ...this["~orpc"].errorMap,
+        ...errors
+      }
+    });
+  }
 };
 
 // src/router-builder.ts
@@ -88,6 +103,15 @@ var ContractRouterBuilder = class _ContractRouterBuilder {
       tags: [...this["~orpc"].tags ?? [], ...tags]
     });
   }
+  errors(errors) {
+    return new _ContractRouterBuilder({
+      ...this["~orpc"],
+      errorMap: {
+        ...this["~orpc"].errorMap,
+        ...errors
+      }
+    });
+  }
   router(router) {
     if (isContractProcedure(router)) {
       let decorated = DecoratedContractProcedure.decorate(router);
@@ -97,6 +121,7 @@ var ContractRouterBuilder = class _ContractRouterBuilder {
       if (this["~orpc"].prefix) {
         decorated = decorated.prefix(this["~orpc"].prefix);
       }
+      decorated = decorated.errors(this["~orpc"].errorMap);
       return decorated;
     }
     const adapted = {};
@@ -108,51 +133,271 @@ var ContractRouterBuilder = class _ContractRouterBuilder {
 };
 
 // src/builder.ts
-var ContractBuilder = class {
+var ContractBuilder = class _ContractBuilder extends ContractProcedure {
+  errors(errors) {
+    return new _ContractBuilder({
+      ...this["~orpc"],
+      errorMap: {
+        ...this["~orpc"].errorMap,
+        ...errors
+      }
+    });
+  }
   prefix(prefix) {
     return new ContractRouterBuilder({
-      prefix
+      prefix,
+      errorMap: this["~orpc"].errorMap
     });
   }
   tag(...tags) {
     return new ContractRouterBuilder({
-      tags
+      tags,
+      errorMap: this["~orpc"].errorMap
     });
   }
   route(route) {
     return new DecoratedContractProcedure({
       route,
       InputSchema: void 0,
-      OutputSchema: void 0
+      OutputSchema: void 0,
+      errorMap: this["~orpc"].errorMap
     });
   }
   input(schema, example) {
     return new DecoratedContractProcedure({
       InputSchema: schema,
       inputExample: example,
-      OutputSchema: void 0
+      OutputSchema: void 0,
+      errorMap: this["~orpc"].errorMap
     });
   }
   output(schema, example) {
     return new DecoratedContractProcedure({
       OutputSchema: schema,
       outputExample: example,
-      InputSchema: void 0
+      InputSchema: void 0,
+      errorMap: this["~orpc"].errorMap
     });
   }
   router(router) {
-    return router;
+    return new ContractRouterBuilder({
+      errorMap: this["~orpc"].errorMap
+    }).router(router);
+  }
+};
+
+// src/error-orpc.ts
+import { isPlainObject } from "@orpc/shared";
+var COMMON_ORPC_ERROR_DEFS = {
+  BAD_REQUEST: {
+    status: 400,
+    message: "Bad Request"
+  },
+  UNAUTHORIZED: {
+    status: 401,
+    message: "Unauthorized"
+  },
+  FORBIDDEN: {
+    status: 403,
+    message: "Forbidden"
+  },
+  NOT_FOUND: {
+    status: 404,
+    message: "Not Found"
+  },
+  METHOD_NOT_SUPPORTED: {
+    status: 405,
+    message: "Method Not Supported"
+  },
+  NOT_ACCEPTABLE: {
+    status: 406,
+    message: "Not Acceptable"
+  },
+  TIMEOUT: {
+    status: 408,
+    message: "Request Timeout"
+  },
+  CONFLICT: {
+    status: 409,
+    message: "Conflict"
+  },
+  PRECONDITION_FAILED: {
+    status: 412,
+    message: "Precondition Failed"
+  },
+  PAYLOAD_TOO_LARGE: {
+    status: 413,
+    message: "Payload Too Large"
+  },
+  UNSUPPORTED_MEDIA_TYPE: {
+    status: 415,
+    message: "Unsupported Media Type"
+  },
+  UNPROCESSABLE_CONTENT: {
+    status: 422,
+    message: "Unprocessable Content"
+  },
+  TOO_MANY_REQUESTS: {
+    status: 429,
+    message: "Too Many Requests"
+  },
+  CLIENT_CLOSED_REQUEST: {
+    status: 499,
+    message: "Client Closed Request"
+  },
+  INTERNAL_SERVER_ERROR: {
+    status: 500,
+    message: "Internal Server Error"
+  },
+  NOT_IMPLEMENTED: {
+    status: 501,
+    message: "Not Implemented"
+  },
+  BAD_GATEWAY: {
+    status: 502,
+    message: "Bad Gateway"
+  },
+  SERVICE_UNAVAILABLE: {
+    status: 503,
+    message: "Service Unavailable"
+  },
+  GATEWAY_TIMEOUT: {
+    status: 504,
+    message: "Gateway Timeout"
+  }
+};
+function fallbackORPCErrorStatus(code, status) {
+  return status ?? COMMON_ORPC_ERROR_DEFS[code]?.status ?? 500;
+}
+function fallbackORPCErrorMessage(code, message) {
+  return message || COMMON_ORPC_ERROR_DEFS[code]?.message || code;
+}
+var ORPCError = class extends Error {
+  defined;
+  code;
+  status;
+  data;
+  constructor(options) {
+    if (options.status && (options.status < 400 || options.status >= 600)) {
+      throw new Error("[ORPCError] The error status code must be in the 400-599 range.");
+    }
+    const message = fallbackORPCErrorMessage(options.code, options.message);
+    super(message, options);
+    this.code = options.code;
+    this.status = fallbackORPCErrorStatus(options.code, options.status);
+    this.defined = options.defined ?? false;
+    this.data = options.data;
+  }
+  toJSON() {
+    return {
+      defined: this.defined,
+      code: this.code,
+      status: this.status,
+      message: this.message,
+      data: this.data
+    };
+  }
+  static isValidJSON(json) {
+    return isPlainObject(json) && "defined" in json && typeof json.defined === "boolean" && "code" in json && typeof json.code === "string" && "status" in json && typeof json.status === "number" && "message" in json && typeof json.message === "string";
+  }
+};
+function isDefinedError(error) {
+  return error instanceof ORPCError && error.defined;
+}
+async function validateORPCError(map, error) {
+  const { code, status, message, data, cause, defined } = error;
+  const config = map?.[error.code];
+  if (!config || fallbackORPCErrorStatus(error.code, config.status) !== error.status) {
+    return defined ? new ORPCError({ defined: false, code, status, message, data, cause }) : error;
+  }
+  if (!config.data) {
+    return defined ? error : new ORPCError({ defined: true, code, status, message, data, cause });
+  }
+  const validated = await config.data["~standard"].validate(error.data);
+  if (validated.issues) {
+    return defined ? new ORPCError({ defined: false, code, status, message, data, cause }) : error;
+  }
+  return new ORPCError({
+    defined: true,
+    code,
+    status,
+    message,
+    data: validated.value,
+    cause
+  });
+}
+
+// src/client-utils.ts
+async function safe(promise) {
+  try {
+    const output = await promise;
+    return [output, void 0, false];
+  } catch (e) {
+    const error = e;
+    if (isDefinedError(error)) {
+      return [void 0, error, true];
+    }
+    return [void 0, error, false];
+  }
+}
+
+// src/config.ts
+var DEFAULT_CONFIG = {
+  defaultMethod: "POST",
+  defaultSuccessStatus: 200,
+  defaultSuccessDescription: "OK",
+  defaultInputStructure: "compact",
+  defaultOutputStructure: "compact"
+};
+var GLOBAL_CONFIG_REF = { value: DEFAULT_CONFIG };
+function configGlobal(config) {
+  if (config.defaultSuccessStatus !== void 0 && (config.defaultSuccessStatus < 200 || config.defaultSuccessStatus > 299)) {
+    throw new Error("[configGlobal] The defaultSuccessStatus must be between 200 and 299");
+  }
+  GLOBAL_CONFIG_REF.value = config;
+}
+function fallbackToGlobalConfig(key, value) {
+  if (value === void 0) {
+    const fallback = GLOBAL_CONFIG_REF.value[key];
+    if (fallback === void 0) {
+      return DEFAULT_CONFIG[key];
+    }
+    return fallback;
+  }
+  return value;
+}
+
+// src/error.ts
+var ValidationError = class extends Error {
+  issues;
+  constructor(options) {
+    super(options.message, options);
+    this.issues = options.issues;
   }
 };
 
 // src/index.ts
-var oc = new ContractBuilder();
+var oc = new ContractBuilder({
+  errorMap: {},
+  InputSchema: void 0,
+  OutputSchema: void 0
+});
 export {
+  COMMON_ORPC_ERROR_DEFS,
   ContractBuilder,
   ContractProcedure,
   ContractRouterBuilder,
   DecoratedContractProcedure,
+  ORPCError,
+  ValidationError,
+  configGlobal,
+  fallbackORPCErrorMessage,
+  fallbackORPCErrorStatus,
+  fallbackToGlobalConfig,
   isContractProcedure,
-  oc
+  isDefinedError,
+  oc,
+  safe,
+  validateORPCError
 };
 //# sourceMappingURL=index.js.map

package/dist/src/builder.d.ts

@@ -1,14 +1,20 @@
-import type { RouteOptions } from './procedure';
+import type { ErrorMap, ErrorMapGuard, ErrorMapSuggestions, StrictErrorMap } from './error-map';
 import type { ContractRouter } from './router';
+import type { AdaptedContractRouter } from './router-builder';
 import type { HTTPPath, Schema, SchemaInput, SchemaOutput } from './types';
+import { ContractProcedure, type RouteOptions } from './procedure';
 import { DecoratedContractProcedure } from './procedure-decorated';
 import { ContractRouterBuilder } from './router-builder';
-export declare class ContractBuilder {
-    prefix(prefix: HTTPPath): ContractRouterBuilder;
-    tag(...tags: string[]): ContractRouterBuilder;
-    route(route: RouteOptions): DecoratedContractProcedure<undefined, undefined>;
-    input<U extends Schema = undefined>(schema: U, example?: SchemaInput<U>): DecoratedContractProcedure<U, undefined>;
-    output<U extends Schema = undefined>(schema: U, example?: SchemaOutput<U>): DecoratedContractProcedure<undefined, U>;
-    router<T extends ContractRouter>(router: T): T;
+export type ContractBuilderDef<TErrorMap extends ErrorMap> = {
+    errorMap: TErrorMap;
+};
+export declare class ContractBuilder<TErrorMap extends ErrorMap> extends ContractProcedure<undefined, undefined, TErrorMap> {
+    errors<const U extends ErrorMap & ErrorMapGuard<TErrorMap> & ErrorMapSuggestions>(errors: U): ContractBuilder<U & TErrorMap>;
+    prefix(prefix: HTTPPath): ContractRouterBuilder<TErrorMap>;
+    tag(...tags: string[]): ContractRouterBuilder<TErrorMap>;
+    route(route: RouteOptions): DecoratedContractProcedure<undefined, undefined, TErrorMap>;
+    input<U extends Schema>(schema: U, example?: SchemaInput<U>): DecoratedContractProcedure<U, undefined, TErrorMap>;
+    output<U extends Schema>(schema: U, example?: SchemaOutput<U>): DecoratedContractProcedure<undefined, U, TErrorMap>;
+    router<T extends ContractRouter<ErrorMap & Partial<StrictErrorMap<TErrorMap>>>>(router: T): AdaptedContractRouter<T, TErrorMap>;
 }
 //# sourceMappingURL=builder.d.ts.map

package/dist/src/client-utils.d.ts

@@ -0,0 +1,5 @@
+import type { ClientPromiseResult } from './client';
+import { type ORPCError } from './error-orpc';
+export type SafeResult<TOutput, TError extends Error> = [output: TOutput, error: undefined, isDefinedError: false] | [output: undefined, error: TError, isDefinedError: false] | [output: undefined, error: Extract<TError, ORPCError<any, any>>, isDefinedError: true];
+export declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
+//# sourceMappingURL=client-utils.d.ts.map

package/dist/src/client.d.ts

@@ -0,0 +1,19 @@
+import type { AbortSignal } from './types';
+export type ClientOptions<TClientContext> = {
+    signal?: AbortSignal;
+} & (undefined extends TClientContext ? {
+    context?: TClientContext;
+} : {
+    context: TClientContext;
+});
+export type ClientRest<TClientContext, TInput> = [input: TInput, options: ClientOptions<TClientContext>] | (undefined extends TInput & TClientContext ? [] : never) | (undefined extends TClientContext ? [input: TInput] : never);
+export type ClientPromiseResult<TOutput, TError extends Error> = Promise<TOutput> & {
+    __typeError?: TError;
+};
+export interface Client<TClientContext, TInput, TOutput, TError extends Error> {
+    (...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
+}
+export type NestedClient<TClientContext> = Client<TClientContext, any, any, any> | {
+    [k: string]: NestedClient<TClientContext>;
+};
+//# sourceMappingURL=client.d.ts.map

package/dist/src/config.d.ts

@@ -0,0 +1,36 @@
+import type { HTTPMethod, InputStructure } from './types';
+export interface ORPCConfig {
+    /**
+     * @default 'POST'
+     */
+    defaultMethod?: HTTPMethod;
+    /**
+     *
+     * @default 200
+     */
+    defaultSuccessStatus?: number;
+    /**
+     *
+     * @default 'OK'
+     */
+    defaultSuccessDescription?: string;
+    /**
+     *
+     * @default 'compact'
+     */
+    defaultInputStructure?: InputStructure;
+    /**
+     *
+     * @default 'compact'
+     */
+    defaultOutputStructure?: InputStructure;
+}
+/**
+ * Set the global configuration, this configuration can effect entire project
+ */
+export declare function configGlobal(config: ORPCConfig): void;
+/**
+ * Fallback the value to the global config if it is undefined
+ */
+export declare function fallbackToGlobalConfig<T extends keyof ORPCConfig>(key: T, value: ORPCConfig[T]): Exclude<ORPCConfig[T], undefined>;
+//# sourceMappingURL=config.d.ts.map

package/dist/src/error-map.d.ts

@@ -0,0 +1,58 @@
+import type { CommonORPCErrorCode } from './error-orpc';
+import type { Schema } from './types';
+export type ErrorMapItem<TDataSchema extends Schema> = {
+    /**
+     *
+     * @default 500
+     */
+    status?: number;
+    message?: string;
+    description?: string;
+    data?: TDataSchema;
+};
+export interface ErrorMap {
+    [k: string]: ErrorMapItem<Schema>;
+}
+/**
+ * const U extends ErrorMap & ErrorMapGuard<TErrorMap> & ErrorMapSuggestions
+ *
+ * Purpose:
+ * - Helps `U` suggest `CommonORPCErrorCode` to the user when typing.
+ *
+ * Why not replace `ErrorMap` with `ErrorMapSuggestions`?
+ * - `ErrorMapSuggestions` has a drawback: it allows `undefined` values for items.
+ * - `ErrorMapGuard<TErrorMap>` uses `Partial`, which can introduce `undefined` values.
+ *
+ * This could lead to unintended behavior where `undefined` values override `TErrorMap`,
+ * potentially resulting in a `never` type after merging.
+ *
+ * Recommendation:
+ * - Use `ErrorMapSuggestions` to assist users in typing correctly but do not replace `ErrorMap`.
+ * - Ensure `ErrorMapGuard<TErrorMap>` is adjusted to prevent `undefined` values.
+ */
+export type ErrorMapSuggestions = {
+    [key in CommonORPCErrorCode | (string & {})]?: ErrorMapItem<Schema>;
+};
+/**
+ * `U` extends `ErrorMap` & `ErrorMapGuard<TErrorMap>`
+ *
+ * `ErrorMapGuard` is a utility type that ensures `U` cannot redefine the structure of `TErrorMap`.
+ * It achieves this by setting each key in `TErrorMap` to `never`, effectively preventing any redefinition.
+ *
+ * Why not just use `Partial<TErrorMap>`?
+ * - Allowing users to redefine existing error map items would require using `StrictErrorMap`.
+ * - However, I prefer not to use `StrictErrorMap` frequently, due to perceived performance concerns,
+ *   though this has not been benchmarked and is based on personal preference.
+ *
+ */
+export type ErrorMapGuard<TErrorMap extends ErrorMap> = {
+    [K in keyof TErrorMap]?: never;
+};
+/**
+ * Since `undefined` has a specific meaning (it use default value),
+ * we ensure all additional properties in each item of the ErrorMap are explicitly set to `undefined`.
+ */
+export type StrictErrorMap<T extends ErrorMap> = {
+    [K in keyof T]: T[K] & Partial<Record<Exclude<keyof ErrorMapItem<any>, keyof T[K]>, undefined>>;
+};
+//# sourceMappingURL=error-map.d.ts.map

package/dist/src/error-orpc.d.ts

@@ -0,0 +1,109 @@
+import type { ErrorMap, ErrorMapItem } from './error-map';
+import type { SchemaOutput } from './types';
+export type ORPCErrorFromErrorMap<TErrorMap extends ErrorMap> = {
+    [K in keyof TErrorMap]: K extends string ? TErrorMap[K] extends ErrorMapItem<infer TDataSchema> ? ORPCError<K, SchemaOutput<TDataSchema>> : never : never;
+}[keyof TErrorMap];
+export declare const COMMON_ORPC_ERROR_DEFS: {
+    readonly BAD_REQUEST: {
+        readonly status: 400;
+        readonly message: "Bad Request";
+    };
+    readonly UNAUTHORIZED: {
+        readonly status: 401;
+        readonly message: "Unauthorized";
+    };
+    readonly FORBIDDEN: {
+        readonly status: 403;
+        readonly message: "Forbidden";
+    };
+    readonly NOT_FOUND: {
+        readonly status: 404;
+        readonly message: "Not Found";
+    };
+    readonly METHOD_NOT_SUPPORTED: {
+        readonly status: 405;
+        readonly message: "Method Not Supported";
+    };
+    readonly NOT_ACCEPTABLE: {
+        readonly status: 406;
+        readonly message: "Not Acceptable";
+    };
+    readonly TIMEOUT: {
+        readonly status: 408;
+        readonly message: "Request Timeout";
+    };
+    readonly CONFLICT: {
+        readonly status: 409;
+        readonly message: "Conflict";
+    };
+    readonly PRECONDITION_FAILED: {
+        readonly status: 412;
+        readonly message: "Precondition Failed";
+    };
+    readonly PAYLOAD_TOO_LARGE: {
+        readonly status: 413;
+        readonly message: "Payload Too Large";
+    };
+    readonly UNSUPPORTED_MEDIA_TYPE: {
+        readonly status: 415;
+        readonly message: "Unsupported Media Type";
+    };
+    readonly UNPROCESSABLE_CONTENT: {
+        readonly status: 422;
+        readonly message: "Unprocessable Content";
+    };
+    readonly TOO_MANY_REQUESTS: {
+        readonly status: 429;
+        readonly message: "Too Many Requests";
+    };
+    readonly CLIENT_CLOSED_REQUEST: {
+        readonly status: 499;
+        readonly message: "Client Closed Request";
+    };
+    readonly INTERNAL_SERVER_ERROR: {
+        readonly status: 500;
+        readonly message: "Internal Server Error";
+    };
+    readonly NOT_IMPLEMENTED: {
+        readonly status: 501;
+        readonly message: "Not Implemented";
+    };
+    readonly BAD_GATEWAY: {
+        readonly status: 502;
+        readonly message: "Bad Gateway";
+    };
+    readonly SERVICE_UNAVAILABLE: {
+        readonly status: 503;
+        readonly message: "Service Unavailable";
+    };
+    readonly GATEWAY_TIMEOUT: {
+        readonly status: 504;
+        readonly message: "Gateway Timeout";
+    };
+};
+export type CommonORPCErrorCode = keyof typeof COMMON_ORPC_ERROR_DEFS;
+export type ORPCErrorOptions<TCode extends string, TData> = ErrorOptions & {
+    defined?: boolean;
+    code: TCode;
+    status?: number;
+    message?: string;
+} & (undefined extends TData ? {
+    data?: TData;
+} : {
+    data: TData;
+});
+export declare function fallbackORPCErrorStatus(code: CommonORPCErrorCode | (string & {}), status: number | undefined): number;
+export declare function fallbackORPCErrorMessage(code: CommonORPCErrorCode | (string & {}), message: string | undefined): string;
+export declare class ORPCError<TCode extends CommonORPCErrorCode | (string & {}), TData> extends Error {
+    readonly defined: boolean;
+    readonly code: TCode;
+    readonly status: number;
+    readonly data: TData;
+    constructor(options: ORPCErrorOptions<TCode, TData>);
+    toJSON(): ORPCErrorJSON<TCode, TData>;
+    static isValidJSON(json: unknown): json is ORPCErrorJSON<string, unknown>;
+}
+export type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
+export declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
+export declare function validateORPCError(map: ErrorMap, error: ORPCError<any, any>): Promise<ORPCError<string, unknown>>;
+//# sourceMappingURL=error-orpc.d.ts.map

package/dist/src/error.d.ts

@@ -0,0 +1,13 @@
+import type { StandardSchemaV1 } from '@standard-schema/spec';
+import type { ErrorMap } from './error-map';
+import type { ORPCErrorFromErrorMap } from './error-orpc';
+export type ErrorFromErrorMap<TErrorMap extends ErrorMap> = Error | ORPCErrorFromErrorMap<TErrorMap>;
+export interface ValidationErrorOptions extends ErrorOptions {
+    message: string;
+    issues: readonly StandardSchemaV1.Issue[];
+}
+export declare class ValidationError extends Error {
+    readonly issues: readonly StandardSchemaV1.Issue[];
+    constructor(options: ValidationErrorOptions);
+}
+//# sourceMappingURL=error.d.ts.map

package/dist/src/index.d.ts

@@ -1,10 +1,18 @@
 /** unnoq */
 import { ContractBuilder } from './builder';
 export * from './builder';
+export * from './client';
+export * from './client-utils';
+export * from './config';
+export * from './error';
+export * from './error-map';
+export * from './error-orpc';
 export * from './procedure';
+export * from './procedure-client';
 export * from './procedure-decorated';
 export * from './router';
 export * from './router-builder';
+export * from './router-client';
 export * from './types';
-export declare const oc: ContractBuilder;
+export declare const oc: ContractBuilder<Record<never, never>>;
 //# sourceMappingURL=index.d.ts.map

package/dist/src/procedure-client.d.ts

@@ -0,0 +1,6 @@
+import type { Client } from './client';
+import type { ErrorFromErrorMap } from './error';
+import type { ErrorMap } from './error-map';
+import type { Schema, SchemaInput, SchemaOutput } from './types';
+export type ContractProcedureClient<TClientContext, TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap> = Client<TClientContext, SchemaInput<TInputSchema>, SchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
+//# sourceMappingURL=procedure-client.d.ts.map

package/dist/src/procedure-decorated.d.ts

@@ -1,12 +1,14 @@
+import type { ErrorMap, ErrorMapGuard, ErrorMapSuggestions } from './error-map';
 import type { RouteOptions } from './procedure';
 import type { HTTPPath, Schema, SchemaInput, SchemaOutput } from './types';
 import { ContractProcedure } from './procedure';
-export declare class DecoratedContractProcedure<TInputSchema extends Schema, TOutputSchema extends Schema> extends ContractProcedure<TInputSchema, TOutputSchema> {
-    static decorate<UInputSchema extends Schema = undefined, UOutputSchema extends Schema = undefined>(procedure: ContractProcedure<UInputSchema, UOutputSchema>): DecoratedContractProcedure<UInputSchema, UOutputSchema>;
-    route(route: RouteOptions): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
-    prefix(prefix: HTTPPath): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
-    unshiftTag(...tags: string[]): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
-    input<U extends Schema = undefined>(schema: U, example?: SchemaInput<U>): DecoratedContractProcedure<U, TOutputSchema>;
-    output<U extends Schema = undefined>(schema: U, example?: SchemaOutput<U>): DecoratedContractProcedure<TInputSchema, U>;
+export declare class DecoratedContractProcedure<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap> {
+    static decorate<UInputSchema extends Schema, UOutputSchema extends Schema, TErrorMap extends ErrorMap>(procedure: ContractProcedure<UInputSchema, UOutputSchema, TErrorMap>): DecoratedContractProcedure<UInputSchema, UOutputSchema, TErrorMap>;
+    route(route: RouteOptions): DecoratedContractProcedure<TInputSchema, TOutputSchema, TErrorMap>;
+    prefix(prefix: HTTPPath): DecoratedContractProcedure<TInputSchema, TOutputSchema, TErrorMap>;
+    unshiftTag(...tags: string[]): DecoratedContractProcedure<TInputSchema, TOutputSchema, TErrorMap>;
+    input<U extends Schema>(schema: U, example?: SchemaInput<U>): DecoratedContractProcedure<U, TOutputSchema, TErrorMap>;
+    output<U extends Schema>(schema: U, example?: SchemaOutput<U>): DecoratedContractProcedure<TInputSchema, U, TErrorMap>;
+    errors<const U extends ErrorMap & ErrorMapGuard<TErrorMap> & ErrorMapSuggestions>(errors: U): DecoratedContractProcedure<TInputSchema, TOutputSchema, TErrorMap & U>;
 }
 //# sourceMappingURL=procedure-decorated.d.ts.map

package/dist/src/procedure.d.ts

@@ -1,4 +1,5 @@
-import type { HTTPMethod, HTTPPath, Schema, SchemaOutput } from './types';
+import type { ErrorMap } from './error-map';
+import type { HTTPMethod, HTTPPath, InputStructure, OutputStructure, Schema, SchemaOutput } from './types';
 export interface RouteOptions {
     method?: HTTPMethod;
     path?: HTTPPath;
@@ -6,21 +7,77 @@ export interface RouteOptions {
     description?: string;
     deprecated?: boolean;
     tags?: readonly string[];
+    /**
+     * The status code of the response when the procedure is successful.
+     *
+     * @default 200
+     */
     successStatus?: number;
+    /**
+     * The description of the response when the procedure is successful.
+     *
+     * @default 'OK'
+     */
+    successDescription?: string;
+    /**
+     * Determines how the input should be structured based on `params`, `query`, `headers`, and `body`.
+     *
+     * @option 'compact'
+     * Combines `params` and either `query` or `body` (depending on the HTTP method) into a single object.
+     *
+     * @option 'detailed'
+     * Keeps each part of the request (`params`, `query`, `headers`, and `body`) as separate fields in the input object.
+     *
+     * Example:
+     * ```ts
+     * const input = {
+     *   params: { id: 1 },
+     *   query: { search: 'hello' },
+     *   headers: { 'Content-Type': 'application/json' },
+     *   body: { name: 'John' },
+     * }
+     * ```
+     *
+     * @default 'compact'
+     */
+    inputStructure?: InputStructure;
+    /**
+     * Determines how the response should be structured based on the output.
+     *
+     * @option 'compact'
+     * Includes only the body data, encoded directly in the response.
+     *
+     * @option 'detailed'
+     * Separates the output into `headers` and `body` fields.
+     * - `headers`: Custom headers to merge with the response headers.
+     * - `body`: The response data.
+     *
+     * Example:
+     * ```ts
+     * const output = {
+     *   headers: { 'x-custom-header': 'value' },
+     *   body: { message: 'Hello, world!' },
+     * };
+     * ```
+     *
+     * @default 'compact'
+     */
+    outputStructure?: OutputStructure;
 }
-export interface ContractProcedureDef<TInputSchema extends Schema, TOutputSchema extends Schema> {
+export interface ContractProcedureDef<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap> {
     route?: RouteOptions;
     InputSchema: TInputSchema;
     inputExample?: SchemaOutput<TInputSchema>;
     OutputSchema: TOutputSchema;
     outputExample?: SchemaOutput<TOutputSchema>;
+    errorMap: TErrorMap;
 }
-export declare class ContractProcedure<TInputSchema extends Schema, TOutputSchema extends Schema> {
+export declare class ContractProcedure<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap> {
     '~type': "ContractProcedure";
-    '~orpc': ContractProcedureDef<TInputSchema, TOutputSchema>;
-    constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema>);
+    '~orpc': ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap>;
+    constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap>);
 }
-export type ANY_CONTRACT_PROCEDURE = ContractProcedure<any, any>;
-export type WELL_CONTRACT_PROCEDURE = ContractProcedure<Schema, Schema>;
+export type ANY_CONTRACT_PROCEDURE = ContractProcedure<any, any, any>;
+export type WELL_CONTRACT_PROCEDURE = ContractProcedure<Schema, Schema, ErrorMap>;
 export declare function isContractProcedure(item: unknown): item is ANY_CONTRACT_PROCEDURE;
 //# sourceMappingURL=procedure.d.ts.map

package/dist/src/router-builder.d.ts

@@ -1,20 +1,23 @@
+import type { ErrorMap, ErrorMapGuard, ErrorMapSuggestions, StrictErrorMap } from './error-map';
 import type { ContractProcedure } from './procedure';
 import type { ContractRouter } from './router';
 import type { HTTPPath } from './types';
 import { DecoratedContractProcedure } from './procedure-decorated';
-export type AdaptedContractRouter<TContract extends ContractRouter> = {
-    [K in keyof TContract]: TContract[K] extends ContractProcedure<infer UInputSchema, infer UOutputSchema> ? DecoratedContractProcedure<UInputSchema, UOutputSchema> : TContract[K] extends ContractRouter ? AdaptedContractRouter<TContract[K]> : never;
+export type AdaptedContractRouter<TContract extends ContractRouter<any>, TErrorMapExtra extends ErrorMap> = {
+    [K in keyof TContract]: TContract[K] extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrors> ? DecoratedContractProcedure<UInputSchema, UOutputSchema, UErrors & TErrorMapExtra> : TContract[K] extends ContractRouter<any> ? AdaptedContractRouter<TContract[K], TErrorMapExtra> : never;
 };
-export interface ContractRouterBuilderDef {
+export interface ContractRouterBuilderDef<TErrorMap extends ErrorMap> {
     prefix?: HTTPPath;
     tags?: string[];
+    errorMap: TErrorMap;
 }
-export declare class ContractRouterBuilder {
+export declare class ContractRouterBuilder<TErrorMap extends ErrorMap> {
     '~type': "ContractProcedure";
-    '~orpc': ContractRouterBuilderDef;
-    constructor(def: ContractRouterBuilderDef);
-    prefix(prefix: HTTPPath): ContractRouterBuilder;
-    tag(...tags: string[]): ContractRouterBuilder;
-    router<T extends ContractRouter>(router: T): AdaptedContractRouter<T>;
+    '~orpc': ContractRouterBuilderDef<TErrorMap>;
+    constructor(def: ContractRouterBuilderDef<TErrorMap>);
+    prefix(prefix: HTTPPath): ContractRouterBuilder<TErrorMap>;
+    tag(...tags: string[]): ContractRouterBuilder<TErrorMap>;
+    errors<const U extends ErrorMap & ErrorMapGuard<TErrorMap> & ErrorMapSuggestions>(errors: U): ContractRouterBuilder<U & TErrorMap>;
+    router<T extends ContractRouter<ErrorMap & Partial<StrictErrorMap<TErrorMap>>>>(router: T): AdaptedContractRouter<T, TErrorMap>;
 }
 //# sourceMappingURL=router-builder.d.ts.map

package/dist/src/router-client.d.ts

@@ -0,0 +1,7 @@
+import type { ContractProcedure } from './procedure';
+import type { ContractProcedureClient } from './procedure-client';
+import type { ContractRouter } from './router';
+export type ContractRouterClient<TRouter extends ContractRouter<any>, TClientContext> = TRouter extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap> ? ContractProcedureClient<TClientContext, UInputSchema, UOutputSchema, UErrorMap> : {
+    [K in keyof TRouter]: TRouter[K] extends ContractRouter<any> ? ContractRouterClient<TRouter[K], TClientContext> : never;
+};
+//# sourceMappingURL=router-client.d.ts.map

package/dist/src/router.d.ts

@@ -1,12 +1,13 @@
-import type { ANY_CONTRACT_PROCEDURE, ContractProcedure } from './procedure';
+import type { ErrorMap } from './error-map';
+import type { ContractProcedure } from './procedure';
 import type { SchemaInput, SchemaOutput } from './types';
-export type ContractRouter = ANY_CONTRACT_PROCEDURE | {
-    [k: string]: ContractRouter;
+export type ContractRouter<T extends ErrorMap> = ContractProcedure<any, any, T> | {
+    [k: string]: ContractRouter<T>;
 };
-export type InferContractRouterInputs<T extends ContractRouter> = T extends ContractProcedure<infer UInputSchema, any> ? SchemaInput<UInputSchema> : {
-    [K in keyof T]: T[K] extends ContractRouter ? InferContractRouterInputs<T[K]> : never;
+export type InferContractRouterInputs<T extends ContractRouter<any>> = T extends ContractProcedure<infer UInputSchema, any, any> ? SchemaInput<UInputSchema> : {
+    [K in keyof T]: T[K] extends ContractRouter<any> ? InferContractRouterInputs<T[K]> : never;
 };
-export type InferContractRouterOutputs<T extends ContractRouter> = T extends ContractProcedure<any, infer UOutputSchema> ? SchemaOutput<UOutputSchema> : {
-    [K in keyof T]: T[K] extends ContractRouter ? InferContractRouterOutputs<T[K]> : never;
+export type InferContractRouterOutputs<T extends ContractRouter<any>> = T extends ContractProcedure<any, infer UOutputSchema, any> ? SchemaOutput<UOutputSchema> : {
+    [K in keyof T]: T[K] extends ContractRouter<any> ? InferContractRouterOutputs<T[K]> : never;
 };
 //# sourceMappingURL=router.d.ts.map

package/dist/src/types.d.ts

@@ -1,7 +1,11 @@
+import type { FindGlobalInstanceType } from '@orpc/shared';
 import type { StandardSchemaV1 } from '@standard-schema/spec';
 export type HTTPPath = `/${string}`;
 export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+export type InputStructure = 'compact' | 'detailed';
+export type OutputStructure = 'compact' | 'detailed';
 export type Schema = StandardSchemaV1 | undefined;
 export type SchemaInput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferInput<TSchema> : TFallback;
 export type SchemaOutput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TSchema> : TFallback;
+export type AbortSignal = FindGlobalInstanceType<'AbortSignal'>;
 //# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/contract",
   "type": "module",
-  "version": "0.0.0-next.c12be86",
+  "version": "0.0.0-next.c4a591c",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -30,7 +30,7 @@
   ],
   "dependencies": {
     "@standard-schema/spec": "1.0.0-beta.4",
-    "@orpc/shared": "0.0.0-next.c12be86"
+    "@orpc/shared": "0.0.0-next.c4a591c"
   },
   "devDependencies": {
     "arktype": "2.0.0-rc.26",