@orpc/contract 0.0.0-next.f22c7ec → 0.0.0-next.f4d410a

package/dist/src/builder.d.ts

@@ -1,23 +0,0 @@
-import type { ErrorMap, ErrorMapGuard, ErrorMapSuggestions, StrictErrorMap } from './error-map';
-import type { RouteOptions } from './procedure';
-import type { ContractRouter } from './router';
-import type { AdaptedContractRouter } from './router-builder';
-import type { HTTPPath, Schema, SchemaInput, SchemaOutput } from './types';
-import { DecoratedContractProcedure } from './procedure-decorated';
-import { ContractRouterBuilder } from './router-builder';
-export type ContractBuilderDef<TErrorMap extends ErrorMap> = {
-    errorMap: TErrorMap;
-};
-export declare class ContractBuilder<TErrorMap extends ErrorMap> {
-    '~type': "ContractBuilder";
-    '~orpc': ContractBuilderDef<TErrorMap>;
-    constructor(def: ContractBuilderDef<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

@@ -1,5 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

@@ -1,36 +0,0 @@
-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

@@ -1,58 +0,0 @@
-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

@@ -1,109 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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,18 +0,0 @@
-/** 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<Record<never, never>>;
-//# sourceMappingURL=index.d.ts.map

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

@@ -1,6 +0,0 @@
-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,14 +0,0 @@
-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, 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,83 +0,0 @@
-import type { ErrorMap } from './error-map';
-import type { HTTPMethod, HTTPPath, InputStructure, OutputStructure, Schema, SchemaOutput } from './types';
-export interface RouteOptions {
-    method?: HTTPMethod;
-    path?: HTTPPath;
-    summary?: string;
-    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, 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, TErrorMap extends ErrorMap> {
-    '~type': "ContractProcedure";
-    '~orpc': ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap>;
-    constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap>);
-}
-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,23 +0,0 @@
-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<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<TErrorMap extends ErrorMap> {
-    prefix?: HTTPPath;
-    tags?: string[];
-    errorMap: TErrorMap;
-}
-export declare class ContractRouterBuilder<TErrorMap extends ErrorMap> {
-    '~type': "ContractProcedure";
-    '~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

@@ -1,7 +0,0 @@
-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,13 +0,0 @@
-import type { ErrorMap } from './error-map';
-import type { ContractProcedure } from './procedure';
-import type { SchemaInput, SchemaOutput } from './types';
-export type ContractRouter<T extends ErrorMap> = ContractProcedure<any, any, T> | {
-    [k: string]: ContractRouter<T>;
-};
-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<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,11 +0,0 @@
-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