@orpc/contract 0.0.0-next.ff5907c → 0.0.0-next.ff68fdb
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +103 -0
- package/dist/index.d.mts +236 -0
- package/dist/index.d.ts +236 -0
- package/dist/{index.js → index.mjs} +57 -75
- package/package.json +9 -14
- package/dist/src/builder-variants.d.ts +0 -38
- package/dist/src/builder.d.ts +0 -32
- package/dist/src/config.d.ts +0 -10
- package/dist/src/error.d.ts +0 -27
- package/dist/src/event-iterator.d.ts +0 -8
- package/dist/src/index.d.ts +0 -15
- package/dist/src/meta.d.ts +0 -3
- package/dist/src/procedure-client.d.ts +0 -5
- package/dist/src/procedure.d.ts +0 -18
- package/dist/src/route.d.ts +0 -79
- package/dist/src/router-client.d.ts +0 -8
- package/dist/src/router.d.ts +0 -29
- package/dist/src/schema.d.ts +0 -8
package/README.md
ADDED
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
|
|
3
|
+
</div>
|
|
4
|
+
|
|
5
|
+
<h1></h1>
|
|
6
|
+
|
|
7
|
+
<div align="center">
|
|
8
|
+
<a href="https://codecov.io/gh/unnoq/orpc">
|
|
9
|
+
<img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
|
|
10
|
+
</a>
|
|
11
|
+
<a href="https://www.npmjs.com/package/@orpc/contract">
|
|
12
|
+
<img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fcontract?logo=npm" />
|
|
13
|
+
</a>
|
|
14
|
+
<a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
|
|
15
|
+
<img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
|
|
16
|
+
</a>
|
|
17
|
+
<a href="https://discord.gg/TXEbwRBvQn">
|
|
18
|
+
<img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
|
|
19
|
+
</a>
|
|
20
|
+
</div>
|
|
21
|
+
|
|
22
|
+
<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
|
|
23
|
+
|
|
24
|
+
**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## Highlights
|
|
29
|
+
|
|
30
|
+
- **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
|
|
31
|
+
- **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
|
|
32
|
+
- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
|
|
33
|
+
- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
|
|
34
|
+
- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
|
|
35
|
+
- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
|
|
36
|
+
- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
|
|
37
|
+
- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
|
|
38
|
+
- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
|
|
39
|
+
- **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
|
|
40
|
+
- **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
|
|
41
|
+
- **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
|
|
42
|
+
- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
|
|
43
|
+
- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
|
|
44
|
+
- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
|
|
45
|
+
- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
|
|
46
|
+
|
|
47
|
+
## Documentation
|
|
48
|
+
|
|
49
|
+
You can find the full documentation [here](https://orpc.unnoq.com).
|
|
50
|
+
|
|
51
|
+
## Packages
|
|
52
|
+
|
|
53
|
+
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
|
54
|
+
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
|
55
|
+
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
|
56
|
+
- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
|
|
57
|
+
- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
|
|
58
|
+
- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
|
|
59
|
+
- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
|
|
60
|
+
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
61
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
|
62
|
+
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
63
|
+
|
|
64
|
+
## `@orpc/contract`
|
|
65
|
+
|
|
66
|
+
Build your API contract. Read the [documentation](https://orpc.unnoq.com/docs/contract-first/define-contract) for more information.
|
|
67
|
+
|
|
68
|
+
```ts
|
|
69
|
+
export const PlanetSchema = z.object({
|
|
70
|
+
id: z.number().int().min(1),
|
|
71
|
+
name: z.string(),
|
|
72
|
+
description: z.string().optional(),
|
|
73
|
+
})
|
|
74
|
+
|
|
75
|
+
export const listPlanetContract = oc
|
|
76
|
+
.input(
|
|
77
|
+
z.object({
|
|
78
|
+
limit: z.number().int().min(1).max(100).optional(),
|
|
79
|
+
cursor: z.number().int().min(0).default(0),
|
|
80
|
+
}),
|
|
81
|
+
)
|
|
82
|
+
.output(z.array(PlanetSchema))
|
|
83
|
+
|
|
84
|
+
export const findPlanetContract = oc
|
|
85
|
+
.input(PlanetSchema.pick({ id: true }))
|
|
86
|
+
.output(PlanetSchema)
|
|
87
|
+
|
|
88
|
+
export const createPlanetContract = oc
|
|
89
|
+
.input(PlanetSchema.omit({ id: true }))
|
|
90
|
+
.output(PlanetSchema)
|
|
91
|
+
|
|
92
|
+
export const contract = {
|
|
93
|
+
planet: {
|
|
94
|
+
list: listPlanetContract,
|
|
95
|
+
find: findPlanetContract,
|
|
96
|
+
create: createPlanetContract,
|
|
97
|
+
},
|
|
98
|
+
}
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## License
|
|
102
|
+
|
|
103
|
+
Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
import { ORPCErrorCode, ORPCError, ClientContext, Client } from '@orpc/client';
|
|
2
|
+
export { ORPCError } from '@orpc/client';
|
|
3
|
+
import { Promisable, IsEqual } from '@orpc/shared';
|
|
4
|
+
import { StandardSchemaV1 } from '@standard-schema/spec';
|
|
5
|
+
|
|
6
|
+
type Schema<TInput, TOutput> = StandardSchemaV1<TInput, TOutput>;
|
|
7
|
+
type AnySchema = Schema<any, any>;
|
|
8
|
+
type SchemaIssue = StandardSchemaV1.Issue;
|
|
9
|
+
type InferSchemaInput<T extends AnySchema> = T extends StandardSchemaV1<infer UInput, any> ? UInput : never;
|
|
10
|
+
type InferSchemaOutput<T extends AnySchema> = T extends StandardSchemaV1<any, infer UOutput> ? UOutput : never;
|
|
11
|
+
type TypeRest<TInput, TOutput> = [map: (input: TInput) => Promisable<TOutput>] | (IsEqual<TInput, TOutput> extends true ? [] : never);
|
|
12
|
+
declare function type<TInput, TOutput = TInput>(...[map]: TypeRest<TInput, TOutput>): Schema<TInput, TOutput>;
|
|
13
|
+
|
|
14
|
+
interface ValidationErrorOptions extends ErrorOptions {
|
|
15
|
+
message: string;
|
|
16
|
+
issues: readonly SchemaIssue[];
|
|
17
|
+
}
|
|
18
|
+
declare class ValidationError extends Error {
|
|
19
|
+
readonly issues: readonly SchemaIssue[];
|
|
20
|
+
constructor(options: ValidationErrorOptions);
|
|
21
|
+
}
|
|
22
|
+
interface ErrorMapItem<TDataSchema extends AnySchema> {
|
|
23
|
+
status?: number;
|
|
24
|
+
message?: string;
|
|
25
|
+
description?: string;
|
|
26
|
+
data?: TDataSchema;
|
|
27
|
+
}
|
|
28
|
+
type ErrorMap = {
|
|
29
|
+
[key in ORPCErrorCode]?: ErrorMapItem<AnySchema>;
|
|
30
|
+
};
|
|
31
|
+
type MergedErrorMap<T1 extends ErrorMap, T2 extends ErrorMap> = Omit<T1, keyof T2> & T2;
|
|
32
|
+
declare function mergeErrorMap<T1 extends ErrorMap, T2 extends ErrorMap>(errorMap1: T1, errorMap2: T2): MergedErrorMap<T1, T2>;
|
|
33
|
+
type ORPCErrorFromErrorMap<TErrorMap extends ErrorMap> = {
|
|
34
|
+
[K in keyof TErrorMap]: K extends string ? TErrorMap[K] extends ErrorMapItem<infer TDataSchema extends Schema<unknown, unknown>> ? ORPCError<K, InferSchemaOutput<TDataSchema>> : never : never;
|
|
35
|
+
}[keyof TErrorMap];
|
|
36
|
+
type ErrorFromErrorMap<TErrorMap extends ErrorMap> = Error | ORPCErrorFromErrorMap<TErrorMap>;
|
|
37
|
+
|
|
38
|
+
type Meta = Record<string, any>;
|
|
39
|
+
declare function mergeMeta<T extends Meta>(meta1: T, meta2: T): T;
|
|
40
|
+
|
|
41
|
+
type HTTPPath = `/${string}`;
|
|
42
|
+
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
43
|
+
type InputStructure = 'compact' | 'detailed';
|
|
44
|
+
type OutputStructure = 'compact' | 'detailed';
|
|
45
|
+
interface Route {
|
|
46
|
+
method?: HTTPMethod;
|
|
47
|
+
path?: HTTPPath;
|
|
48
|
+
summary?: string;
|
|
49
|
+
description?: string;
|
|
50
|
+
deprecated?: boolean;
|
|
51
|
+
tags?: readonly string[];
|
|
52
|
+
/**
|
|
53
|
+
* The status code of the response when the procedure is successful.
|
|
54
|
+
*
|
|
55
|
+
* @default 200
|
|
56
|
+
*/
|
|
57
|
+
successStatus?: number;
|
|
58
|
+
/**
|
|
59
|
+
* The description of the response when the procedure is successful.
|
|
60
|
+
*
|
|
61
|
+
* @default 'OK'
|
|
62
|
+
*/
|
|
63
|
+
successDescription?: string;
|
|
64
|
+
/**
|
|
65
|
+
* Determines how the input should be structured based on `params`, `query`, `headers`, and `body`.
|
|
66
|
+
*
|
|
67
|
+
* @option 'compact'
|
|
68
|
+
* Combines `params` and either `query` or `body` (depending on the HTTP method) into a single object.
|
|
69
|
+
*
|
|
70
|
+
* @option 'detailed'
|
|
71
|
+
* Keeps each part of the request (`params`, `query`, `headers`, and `body`) as separate fields in the input object.
|
|
72
|
+
*
|
|
73
|
+
* Example:
|
|
74
|
+
* ```ts
|
|
75
|
+
* const input = {
|
|
76
|
+
* params: { id: 1 },
|
|
77
|
+
* query: { search: 'hello' },
|
|
78
|
+
* headers: { 'Content-Type': 'application/json' },
|
|
79
|
+
* body: { name: 'John' },
|
|
80
|
+
* }
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
83
|
+
* @default 'compact'
|
|
84
|
+
*/
|
|
85
|
+
inputStructure?: InputStructure;
|
|
86
|
+
/**
|
|
87
|
+
* Determines how the response should be structured based on the output.
|
|
88
|
+
*
|
|
89
|
+
* @option 'compact'
|
|
90
|
+
* Includes only the body data, encoded directly in the response.
|
|
91
|
+
*
|
|
92
|
+
* @option 'detailed'
|
|
93
|
+
* Separates the output into `headers` and `body` fields.
|
|
94
|
+
* - `headers`: Custom headers to merge with the response headers.
|
|
95
|
+
* - `body`: The response data.
|
|
96
|
+
*
|
|
97
|
+
* Example:
|
|
98
|
+
* ```ts
|
|
99
|
+
* const output = {
|
|
100
|
+
* headers: { 'x-custom-header': 'value' },
|
|
101
|
+
* body: { message: 'Hello, world!' },
|
|
102
|
+
* };
|
|
103
|
+
* ```
|
|
104
|
+
*
|
|
105
|
+
* @default 'compact'
|
|
106
|
+
*/
|
|
107
|
+
outputStructure?: OutputStructure;
|
|
108
|
+
}
|
|
109
|
+
declare function mergeRoute(a: Route, b: Route): Route;
|
|
110
|
+
declare function prefixRoute(route: Route, prefix: HTTPPath): Route;
|
|
111
|
+
declare function unshiftTagRoute(route: Route, tags: readonly string[]): Route;
|
|
112
|
+
declare function mergePrefix(a: HTTPPath | undefined, b: HTTPPath): HTTPPath;
|
|
113
|
+
declare function mergeTags(a: readonly string[] | undefined, b: readonly string[]): readonly string[];
|
|
114
|
+
interface EnhanceRouteOptions {
|
|
115
|
+
prefix?: HTTPPath;
|
|
116
|
+
tags?: readonly string[];
|
|
117
|
+
}
|
|
118
|
+
declare function enhanceRoute(route: Route, options: EnhanceRouteOptions): Route;
|
|
119
|
+
|
|
120
|
+
interface ContractProcedureDef<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
121
|
+
meta: TMeta;
|
|
122
|
+
route: Route;
|
|
123
|
+
inputSchema?: TInputSchema;
|
|
124
|
+
outputSchema?: TOutputSchema;
|
|
125
|
+
errorMap: TErrorMap;
|
|
126
|
+
}
|
|
127
|
+
declare class ContractProcedure<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
128
|
+
'~orpc': ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
129
|
+
constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
|
|
130
|
+
}
|
|
131
|
+
type AnyContractProcedure = ContractProcedure<any, any, any, any>;
|
|
132
|
+
declare function isContractProcedure(item: unknown): item is AnyContractProcedure;
|
|
133
|
+
|
|
134
|
+
type ContractRouter<TMeta extends Meta> = ContractProcedure<any, any, any, TMeta> | {
|
|
135
|
+
[k: string]: ContractRouter<TMeta>;
|
|
136
|
+
};
|
|
137
|
+
type AnyContractRouter = ContractRouter<any>;
|
|
138
|
+
type InferContractRouterInputs<T extends AnyContractRouter> = T extends ContractProcedure<infer UInputSchema, any, any, any> ? InferSchemaInput<UInputSchema> : {
|
|
139
|
+
[K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterInputs<T[K]> : never;
|
|
140
|
+
};
|
|
141
|
+
type InferContractRouterOutputs<T extends AnyContractRouter> = T extends ContractProcedure<any, infer UOutputSchema, any, any> ? InferSchemaOutput<UOutputSchema> : {
|
|
142
|
+
[K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterOutputs<T[K]> : never;
|
|
143
|
+
};
|
|
144
|
+
type InferContractRouterErrorMap<T extends AnyContractRouter> = T extends ContractProcedure<any, any, infer UErrorMap, any> ? UErrorMap : {
|
|
145
|
+
[K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterErrorMap<T[K]> : never;
|
|
146
|
+
}[keyof T];
|
|
147
|
+
type InferContractRouterMeta<T extends AnyContractRouter> = T extends ContractRouter<infer UMeta> ? UMeta : never;
|
|
148
|
+
|
|
149
|
+
declare function getContractRouter(router: AnyContractRouter, path: readonly string[]): AnyContractRouter | undefined;
|
|
150
|
+
type EnhancedContractRouter<T extends AnyContractRouter, TErrorMap extends ErrorMap> = T extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrors, infer UMeta> ? ContractProcedure<UInputSchema, UOutputSchema, MergedErrorMap<TErrorMap, UErrors>, UMeta> : {
|
|
151
|
+
[K in keyof T]: T[K] extends AnyContractRouter ? EnhancedContractRouter<T[K], TErrorMap> : never;
|
|
152
|
+
};
|
|
153
|
+
interface EnhanceContractRouterOptions<TErrorMap extends ErrorMap> extends EnhanceRouteOptions {
|
|
154
|
+
errorMap: TErrorMap;
|
|
155
|
+
}
|
|
156
|
+
declare function enhanceContractRouter<T extends AnyContractRouter, TErrorMap extends ErrorMap>(router: T, options: EnhanceContractRouterOptions<TErrorMap>): EnhancedContractRouter<T, TErrorMap>;
|
|
157
|
+
|
|
158
|
+
interface ContractProcedureBuilder<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
159
|
+
errors<U extends ErrorMap>(errors: U): ContractProcedureBuilder<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
160
|
+
meta(meta: TMeta): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
161
|
+
route(route: Route): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
162
|
+
input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInput<U, TOutputSchema, TErrorMap, TMeta>;
|
|
163
|
+
output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithOutput<TInputSchema, U, TErrorMap, TMeta>;
|
|
164
|
+
}
|
|
165
|
+
interface ContractProcedureBuilderWithInput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
166
|
+
errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
167
|
+
meta(meta: TMeta): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
168
|
+
route(route: Route): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
169
|
+
output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInputOutput<TInputSchema, U, TErrorMap, TMeta>;
|
|
170
|
+
}
|
|
171
|
+
interface ContractProcedureBuilderWithOutput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
172
|
+
errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
173
|
+
meta(meta: TMeta): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
174
|
+
route(route: Route): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
175
|
+
input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInputOutput<U, TOutputSchema, TErrorMap, TMeta>;
|
|
176
|
+
}
|
|
177
|
+
interface ContractProcedureBuilderWithInputOutput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
178
|
+
errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
179
|
+
meta(meta: TMeta): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
180
|
+
route(route: Route): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
181
|
+
}
|
|
182
|
+
interface ContractRouterBuilder<TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
183
|
+
'~orpc': EnhanceContractRouterOptions<TErrorMap>;
|
|
184
|
+
'errors'<U extends ErrorMap>(errors: U): ContractRouterBuilder<MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
185
|
+
'prefix'(prefix: HTTPPath): ContractRouterBuilder<TErrorMap, TMeta>;
|
|
186
|
+
'tag'(...tags: string[]): ContractRouterBuilder<TErrorMap, TMeta>;
|
|
187
|
+
'router'<T extends ContractRouter<TMeta>>(router: T): EnhancedContractRouter<T, TErrorMap>;
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
interface ContractBuilderDef<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>, EnhanceContractRouterOptions<TErrorMap> {
|
|
191
|
+
}
|
|
192
|
+
declare class ContractBuilder<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
193
|
+
'~orpc': ContractBuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
194
|
+
constructor(def: ContractBuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
|
|
195
|
+
/**
|
|
196
|
+
* Reset initial meta
|
|
197
|
+
*/
|
|
198
|
+
$meta<U extends Meta>(initialMeta: U): ContractBuilder<TInputSchema, TOutputSchema, TErrorMap, U>;
|
|
199
|
+
/**
|
|
200
|
+
* Reset initial route
|
|
201
|
+
*/
|
|
202
|
+
$route(initialRoute: Route): ContractBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
203
|
+
errors<U extends ErrorMap>(errors: U): ContractBuilder<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
204
|
+
meta(meta: TMeta): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
205
|
+
route(route: Route): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
206
|
+
input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInput<U, TOutputSchema, TErrorMap, TMeta>;
|
|
207
|
+
output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithOutput<TInputSchema, U, TErrorMap, TMeta>;
|
|
208
|
+
prefix(prefix: HTTPPath): ContractRouterBuilder<TErrorMap, TMeta>;
|
|
209
|
+
tag(...tags: string[]): ContractRouterBuilder<TErrorMap, TMeta>;
|
|
210
|
+
router<T extends ContractRouter<TMeta>>(router: T): EnhancedContractRouter<T, TErrorMap>;
|
|
211
|
+
}
|
|
212
|
+
declare const oc: ContractBuilder<Schema<unknown, unknown>, Schema<unknown, unknown>, Record<never, never>, Record<never, never>>;
|
|
213
|
+
|
|
214
|
+
interface ContractConfig {
|
|
215
|
+
defaultMethod: HTTPMethod;
|
|
216
|
+
defaultSuccessStatus: number;
|
|
217
|
+
defaultSuccessDescription: string;
|
|
218
|
+
defaultInputStructure: InputStructure;
|
|
219
|
+
defaultOutputStructure: OutputStructure;
|
|
220
|
+
}
|
|
221
|
+
declare function fallbackContractConfig<T extends keyof ContractConfig>(key: T, value: ContractConfig[T] | undefined): ContractConfig[T];
|
|
222
|
+
|
|
223
|
+
interface EventIteratorSchemaDetails {
|
|
224
|
+
yields: AnySchema;
|
|
225
|
+
returns?: AnySchema;
|
|
226
|
+
}
|
|
227
|
+
declare function eventIterator<TYieldIn, TYieldOut, TReturnIn = unknown, TReturnOut = unknown>(yields: Schema<TYieldIn, TYieldOut>, returns?: Schema<TReturnIn, TReturnOut>): Schema<AsyncIteratorObject<TYieldIn, TReturnIn, void>, AsyncIteratorObject<TYieldOut, TReturnOut, void>>;
|
|
228
|
+
declare function getEventIteratorSchemaDetails(schema: AnySchema | undefined): undefined | EventIteratorSchemaDetails;
|
|
229
|
+
|
|
230
|
+
type ContractProcedureClient<TClientContext extends ClientContext, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> = Client<TClientContext, InferSchemaInput<TInputSchema>, InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
|
|
231
|
+
|
|
232
|
+
type ContractRouterClient<TRouter extends AnyContractRouter, TClientContext extends ClientContext = Record<never, never>> = TRouter extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, any> ? ContractProcedureClient<TClientContext, UInputSchema, UOutputSchema, UErrorMap> : {
|
|
233
|
+
[K in keyof TRouter]: TRouter[K] extends AnyContractRouter ? ContractRouterClient<TRouter[K], TClientContext> : never;
|
|
234
|
+
};
|
|
235
|
+
|
|
236
|
+
export { type AnyContractProcedure, type AnyContractRouter, type AnySchema, ContractBuilder, type ContractBuilderDef, type ContractConfig, ContractProcedure, type ContractProcedureBuilder, type ContractProcedureBuilderWithInput, type ContractProcedureBuilderWithInputOutput, type ContractProcedureBuilderWithOutput, type ContractProcedureClient, type ContractProcedureDef, type ContractRouter, type ContractRouterBuilder, type ContractRouterClient, type EnhanceContractRouterOptions, type EnhanceRouteOptions, type EnhancedContractRouter, type ErrorFromErrorMap, type ErrorMap, type ErrorMapItem, type EventIteratorSchemaDetails, type HTTPMethod, type HTTPPath, type InferContractRouterErrorMap, type InferContractRouterInputs, type InferContractRouterMeta, type InferContractRouterOutputs, type InferSchemaInput, type InferSchemaOutput, type InputStructure, type MergedErrorMap, type Meta, type ORPCErrorFromErrorMap, type OutputStructure, type Route, type Schema, type SchemaIssue, type TypeRest, ValidationError, type ValidationErrorOptions, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, isContractProcedure, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, oc, prefixRoute, type, unshiftTagRoute };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
import { ORPCErrorCode, ORPCError, ClientContext, Client } from '@orpc/client';
|
|
2
|
+
export { ORPCError } from '@orpc/client';
|
|
3
|
+
import { Promisable, IsEqual } from '@orpc/shared';
|
|
4
|
+
import { StandardSchemaV1 } from '@standard-schema/spec';
|
|
5
|
+
|
|
6
|
+
type Schema<TInput, TOutput> = StandardSchemaV1<TInput, TOutput>;
|
|
7
|
+
type AnySchema = Schema<any, any>;
|
|
8
|
+
type SchemaIssue = StandardSchemaV1.Issue;
|
|
9
|
+
type InferSchemaInput<T extends AnySchema> = T extends StandardSchemaV1<infer UInput, any> ? UInput : never;
|
|
10
|
+
type InferSchemaOutput<T extends AnySchema> = T extends StandardSchemaV1<any, infer UOutput> ? UOutput : never;
|
|
11
|
+
type TypeRest<TInput, TOutput> = [map: (input: TInput) => Promisable<TOutput>] | (IsEqual<TInput, TOutput> extends true ? [] : never);
|
|
12
|
+
declare function type<TInput, TOutput = TInput>(...[map]: TypeRest<TInput, TOutput>): Schema<TInput, TOutput>;
|
|
13
|
+
|
|
14
|
+
interface ValidationErrorOptions extends ErrorOptions {
|
|
15
|
+
message: string;
|
|
16
|
+
issues: readonly SchemaIssue[];
|
|
17
|
+
}
|
|
18
|
+
declare class ValidationError extends Error {
|
|
19
|
+
readonly issues: readonly SchemaIssue[];
|
|
20
|
+
constructor(options: ValidationErrorOptions);
|
|
21
|
+
}
|
|
22
|
+
interface ErrorMapItem<TDataSchema extends AnySchema> {
|
|
23
|
+
status?: number;
|
|
24
|
+
message?: string;
|
|
25
|
+
description?: string;
|
|
26
|
+
data?: TDataSchema;
|
|
27
|
+
}
|
|
28
|
+
type ErrorMap = {
|
|
29
|
+
[key in ORPCErrorCode]?: ErrorMapItem<AnySchema>;
|
|
30
|
+
};
|
|
31
|
+
type MergedErrorMap<T1 extends ErrorMap, T2 extends ErrorMap> = Omit<T1, keyof T2> & T2;
|
|
32
|
+
declare function mergeErrorMap<T1 extends ErrorMap, T2 extends ErrorMap>(errorMap1: T1, errorMap2: T2): MergedErrorMap<T1, T2>;
|
|
33
|
+
type ORPCErrorFromErrorMap<TErrorMap extends ErrorMap> = {
|
|
34
|
+
[K in keyof TErrorMap]: K extends string ? TErrorMap[K] extends ErrorMapItem<infer TDataSchema extends Schema<unknown, unknown>> ? ORPCError<K, InferSchemaOutput<TDataSchema>> : never : never;
|
|
35
|
+
}[keyof TErrorMap];
|
|
36
|
+
type ErrorFromErrorMap<TErrorMap extends ErrorMap> = Error | ORPCErrorFromErrorMap<TErrorMap>;
|
|
37
|
+
|
|
38
|
+
type Meta = Record<string, any>;
|
|
39
|
+
declare function mergeMeta<T extends Meta>(meta1: T, meta2: T): T;
|
|
40
|
+
|
|
41
|
+
type HTTPPath = `/${string}`;
|
|
42
|
+
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
43
|
+
type InputStructure = 'compact' | 'detailed';
|
|
44
|
+
type OutputStructure = 'compact' | 'detailed';
|
|
45
|
+
interface Route {
|
|
46
|
+
method?: HTTPMethod;
|
|
47
|
+
path?: HTTPPath;
|
|
48
|
+
summary?: string;
|
|
49
|
+
description?: string;
|
|
50
|
+
deprecated?: boolean;
|
|
51
|
+
tags?: readonly string[];
|
|
52
|
+
/**
|
|
53
|
+
* The status code of the response when the procedure is successful.
|
|
54
|
+
*
|
|
55
|
+
* @default 200
|
|
56
|
+
*/
|
|
57
|
+
successStatus?: number;
|
|
58
|
+
/**
|
|
59
|
+
* The description of the response when the procedure is successful.
|
|
60
|
+
*
|
|
61
|
+
* @default 'OK'
|
|
62
|
+
*/
|
|
63
|
+
successDescription?: string;
|
|
64
|
+
/**
|
|
65
|
+
* Determines how the input should be structured based on `params`, `query`, `headers`, and `body`.
|
|
66
|
+
*
|
|
67
|
+
* @option 'compact'
|
|
68
|
+
* Combines `params` and either `query` or `body` (depending on the HTTP method) into a single object.
|
|
69
|
+
*
|
|
70
|
+
* @option 'detailed'
|
|
71
|
+
* Keeps each part of the request (`params`, `query`, `headers`, and `body`) as separate fields in the input object.
|
|
72
|
+
*
|
|
73
|
+
* Example:
|
|
74
|
+
* ```ts
|
|
75
|
+
* const input = {
|
|
76
|
+
* params: { id: 1 },
|
|
77
|
+
* query: { search: 'hello' },
|
|
78
|
+
* headers: { 'Content-Type': 'application/json' },
|
|
79
|
+
* body: { name: 'John' },
|
|
80
|
+
* }
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
83
|
+
* @default 'compact'
|
|
84
|
+
*/
|
|
85
|
+
inputStructure?: InputStructure;
|
|
86
|
+
/**
|
|
87
|
+
* Determines how the response should be structured based on the output.
|
|
88
|
+
*
|
|
89
|
+
* @option 'compact'
|
|
90
|
+
* Includes only the body data, encoded directly in the response.
|
|
91
|
+
*
|
|
92
|
+
* @option 'detailed'
|
|
93
|
+
* Separates the output into `headers` and `body` fields.
|
|
94
|
+
* - `headers`: Custom headers to merge with the response headers.
|
|
95
|
+
* - `body`: The response data.
|
|
96
|
+
*
|
|
97
|
+
* Example:
|
|
98
|
+
* ```ts
|
|
99
|
+
* const output = {
|
|
100
|
+
* headers: { 'x-custom-header': 'value' },
|
|
101
|
+
* body: { message: 'Hello, world!' },
|
|
102
|
+
* };
|
|
103
|
+
* ```
|
|
104
|
+
*
|
|
105
|
+
* @default 'compact'
|
|
106
|
+
*/
|
|
107
|
+
outputStructure?: OutputStructure;
|
|
108
|
+
}
|
|
109
|
+
declare function mergeRoute(a: Route, b: Route): Route;
|
|
110
|
+
declare function prefixRoute(route: Route, prefix: HTTPPath): Route;
|
|
111
|
+
declare function unshiftTagRoute(route: Route, tags: readonly string[]): Route;
|
|
112
|
+
declare function mergePrefix(a: HTTPPath | undefined, b: HTTPPath): HTTPPath;
|
|
113
|
+
declare function mergeTags(a: readonly string[] | undefined, b: readonly string[]): readonly string[];
|
|
114
|
+
interface EnhanceRouteOptions {
|
|
115
|
+
prefix?: HTTPPath;
|
|
116
|
+
tags?: readonly string[];
|
|
117
|
+
}
|
|
118
|
+
declare function enhanceRoute(route: Route, options: EnhanceRouteOptions): Route;
|
|
119
|
+
|
|
120
|
+
interface ContractProcedureDef<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
121
|
+
meta: TMeta;
|
|
122
|
+
route: Route;
|
|
123
|
+
inputSchema?: TInputSchema;
|
|
124
|
+
outputSchema?: TOutputSchema;
|
|
125
|
+
errorMap: TErrorMap;
|
|
126
|
+
}
|
|
127
|
+
declare class ContractProcedure<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
128
|
+
'~orpc': ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
129
|
+
constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
|
|
130
|
+
}
|
|
131
|
+
type AnyContractProcedure = ContractProcedure<any, any, any, any>;
|
|
132
|
+
declare function isContractProcedure(item: unknown): item is AnyContractProcedure;
|
|
133
|
+
|
|
134
|
+
type ContractRouter<TMeta extends Meta> = ContractProcedure<any, any, any, TMeta> | {
|
|
135
|
+
[k: string]: ContractRouter<TMeta>;
|
|
136
|
+
};
|
|
137
|
+
type AnyContractRouter = ContractRouter<any>;
|
|
138
|
+
type InferContractRouterInputs<T extends AnyContractRouter> = T extends ContractProcedure<infer UInputSchema, any, any, any> ? InferSchemaInput<UInputSchema> : {
|
|
139
|
+
[K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterInputs<T[K]> : never;
|
|
140
|
+
};
|
|
141
|
+
type InferContractRouterOutputs<T extends AnyContractRouter> = T extends ContractProcedure<any, infer UOutputSchema, any, any> ? InferSchemaOutput<UOutputSchema> : {
|
|
142
|
+
[K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterOutputs<T[K]> : never;
|
|
143
|
+
};
|
|
144
|
+
type InferContractRouterErrorMap<T extends AnyContractRouter> = T extends ContractProcedure<any, any, infer UErrorMap, any> ? UErrorMap : {
|
|
145
|
+
[K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterErrorMap<T[K]> : never;
|
|
146
|
+
}[keyof T];
|
|
147
|
+
type InferContractRouterMeta<T extends AnyContractRouter> = T extends ContractRouter<infer UMeta> ? UMeta : never;
|
|
148
|
+
|
|
149
|
+
declare function getContractRouter(router: AnyContractRouter, path: readonly string[]): AnyContractRouter | undefined;
|
|
150
|
+
type EnhancedContractRouter<T extends AnyContractRouter, TErrorMap extends ErrorMap> = T extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrors, infer UMeta> ? ContractProcedure<UInputSchema, UOutputSchema, MergedErrorMap<TErrorMap, UErrors>, UMeta> : {
|
|
151
|
+
[K in keyof T]: T[K] extends AnyContractRouter ? EnhancedContractRouter<T[K], TErrorMap> : never;
|
|
152
|
+
};
|
|
153
|
+
interface EnhanceContractRouterOptions<TErrorMap extends ErrorMap> extends EnhanceRouteOptions {
|
|
154
|
+
errorMap: TErrorMap;
|
|
155
|
+
}
|
|
156
|
+
declare function enhanceContractRouter<T extends AnyContractRouter, TErrorMap extends ErrorMap>(router: T, options: EnhanceContractRouterOptions<TErrorMap>): EnhancedContractRouter<T, TErrorMap>;
|
|
157
|
+
|
|
158
|
+
interface ContractProcedureBuilder<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
159
|
+
errors<U extends ErrorMap>(errors: U): ContractProcedureBuilder<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
160
|
+
meta(meta: TMeta): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
161
|
+
route(route: Route): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
162
|
+
input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInput<U, TOutputSchema, TErrorMap, TMeta>;
|
|
163
|
+
output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithOutput<TInputSchema, U, TErrorMap, TMeta>;
|
|
164
|
+
}
|
|
165
|
+
interface ContractProcedureBuilderWithInput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
166
|
+
errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
167
|
+
meta(meta: TMeta): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
168
|
+
route(route: Route): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
169
|
+
output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInputOutput<TInputSchema, U, TErrorMap, TMeta>;
|
|
170
|
+
}
|
|
171
|
+
interface ContractProcedureBuilderWithOutput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
172
|
+
errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
173
|
+
meta(meta: TMeta): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
174
|
+
route(route: Route): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
175
|
+
input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInputOutput<U, TOutputSchema, TErrorMap, TMeta>;
|
|
176
|
+
}
|
|
177
|
+
interface ContractProcedureBuilderWithInputOutput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
178
|
+
errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
179
|
+
meta(meta: TMeta): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
180
|
+
route(route: Route): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
181
|
+
}
|
|
182
|
+
interface ContractRouterBuilder<TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
183
|
+
'~orpc': EnhanceContractRouterOptions<TErrorMap>;
|
|
184
|
+
'errors'<U extends ErrorMap>(errors: U): ContractRouterBuilder<MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
185
|
+
'prefix'(prefix: HTTPPath): ContractRouterBuilder<TErrorMap, TMeta>;
|
|
186
|
+
'tag'(...tags: string[]): ContractRouterBuilder<TErrorMap, TMeta>;
|
|
187
|
+
'router'<T extends ContractRouter<TMeta>>(router: T): EnhancedContractRouter<T, TErrorMap>;
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
interface ContractBuilderDef<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>, EnhanceContractRouterOptions<TErrorMap> {
|
|
191
|
+
}
|
|
192
|
+
declare class ContractBuilder<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
193
|
+
'~orpc': ContractBuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
194
|
+
constructor(def: ContractBuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
|
|
195
|
+
/**
|
|
196
|
+
* Reset initial meta
|
|
197
|
+
*/
|
|
198
|
+
$meta<U extends Meta>(initialMeta: U): ContractBuilder<TInputSchema, TOutputSchema, TErrorMap, U>;
|
|
199
|
+
/**
|
|
200
|
+
* Reset initial route
|
|
201
|
+
*/
|
|
202
|
+
$route(initialRoute: Route): ContractBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
203
|
+
errors<U extends ErrorMap>(errors: U): ContractBuilder<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
204
|
+
meta(meta: TMeta): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
205
|
+
route(route: Route): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
206
|
+
input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInput<U, TOutputSchema, TErrorMap, TMeta>;
|
|
207
|
+
output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithOutput<TInputSchema, U, TErrorMap, TMeta>;
|
|
208
|
+
prefix(prefix: HTTPPath): ContractRouterBuilder<TErrorMap, TMeta>;
|
|
209
|
+
tag(...tags: string[]): ContractRouterBuilder<TErrorMap, TMeta>;
|
|
210
|
+
router<T extends ContractRouter<TMeta>>(router: T): EnhancedContractRouter<T, TErrorMap>;
|
|
211
|
+
}
|
|
212
|
+
declare const oc: ContractBuilder<Schema<unknown, unknown>, Schema<unknown, unknown>, Record<never, never>, Record<never, never>>;
|
|
213
|
+
|
|
214
|
+
interface ContractConfig {
|
|
215
|
+
defaultMethod: HTTPMethod;
|
|
216
|
+
defaultSuccessStatus: number;
|
|
217
|
+
defaultSuccessDescription: string;
|
|
218
|
+
defaultInputStructure: InputStructure;
|
|
219
|
+
defaultOutputStructure: OutputStructure;
|
|
220
|
+
}
|
|
221
|
+
declare function fallbackContractConfig<T extends keyof ContractConfig>(key: T, value: ContractConfig[T] | undefined): ContractConfig[T];
|
|
222
|
+
|
|
223
|
+
interface EventIteratorSchemaDetails {
|
|
224
|
+
yields: AnySchema;
|
|
225
|
+
returns?: AnySchema;
|
|
226
|
+
}
|
|
227
|
+
declare function eventIterator<TYieldIn, TYieldOut, TReturnIn = unknown, TReturnOut = unknown>(yields: Schema<TYieldIn, TYieldOut>, returns?: Schema<TReturnIn, TReturnOut>): Schema<AsyncIteratorObject<TYieldIn, TReturnIn, void>, AsyncIteratorObject<TYieldOut, TReturnOut, void>>;
|
|
228
|
+
declare function getEventIteratorSchemaDetails(schema: AnySchema | undefined): undefined | EventIteratorSchemaDetails;
|
|
229
|
+
|
|
230
|
+
type ContractProcedureClient<TClientContext extends ClientContext, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> = Client<TClientContext, InferSchemaInput<TInputSchema>, InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
|
|
231
|
+
|
|
232
|
+
type ContractRouterClient<TRouter extends AnyContractRouter, TClientContext extends ClientContext = Record<never, never>> = TRouter extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, any> ? ContractProcedureClient<TClientContext, UInputSchema, UOutputSchema, UErrorMap> : {
|
|
233
|
+
[K in keyof TRouter]: TRouter[K] extends AnyContractRouter ? ContractRouterClient<TRouter[K], TClientContext> : never;
|
|
234
|
+
};
|
|
235
|
+
|
|
236
|
+
export { type AnyContractProcedure, type AnyContractRouter, type AnySchema, ContractBuilder, type ContractBuilderDef, type ContractConfig, ContractProcedure, type ContractProcedureBuilder, type ContractProcedureBuilderWithInput, type ContractProcedureBuilderWithInputOutput, type ContractProcedureBuilderWithOutput, type ContractProcedureClient, type ContractProcedureDef, type ContractRouter, type ContractRouterBuilder, type ContractRouterClient, type EnhanceContractRouterOptions, type EnhanceRouteOptions, type EnhancedContractRouter, type ErrorFromErrorMap, type ErrorMap, type ErrorMapItem, type EventIteratorSchemaDetails, type HTTPMethod, type HTTPPath, type InferContractRouterErrorMap, type InferContractRouterInputs, type InferContractRouterMeta, type InferContractRouterOutputs, type InferSchemaInput, type InferSchemaOutput, type InputStructure, type MergedErrorMap, type Meta, type ORPCErrorFromErrorMap, type OutputStructure, type Route, type Schema, type SchemaIssue, type TypeRest, ValidationError, type ValidationErrorOptions, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, isContractProcedure, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, oc, prefixRoute, type, unshiftTagRoute };
|
|
@@ -1,22 +1,23 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
import { mapEventIterator, ORPCError } from '@orpc/client';
|
|
2
|
+
export { ORPCError } from '@orpc/client';
|
|
3
|
+
import { isAsyncIteratorObject } from '@orpc/shared';
|
|
4
|
+
|
|
5
|
+
class ValidationError extends Error {
|
|
3
6
|
issues;
|
|
4
7
|
constructor(options) {
|
|
5
8
|
super(options.message, options);
|
|
6
9
|
this.issues = options.issues;
|
|
7
10
|
}
|
|
8
|
-
}
|
|
11
|
+
}
|
|
9
12
|
function mergeErrorMap(errorMap1, errorMap2) {
|
|
10
13
|
return { ...errorMap1, ...errorMap2 };
|
|
11
14
|
}
|
|
12
15
|
|
|
13
|
-
// src/meta.ts
|
|
14
16
|
function mergeMeta(meta1, meta2) {
|
|
15
17
|
return { ...meta1, ...meta2 };
|
|
16
18
|
}
|
|
17
19
|
|
|
18
|
-
|
|
19
|
-
var ContractProcedure = class {
|
|
20
|
+
class ContractProcedure {
|
|
20
21
|
"~orpc";
|
|
21
22
|
constructor(def) {
|
|
22
23
|
if (def.route?.successStatus && (def.route.successStatus < 200 || def.route?.successStatus > 299)) {
|
|
@@ -27,15 +28,14 @@ var ContractProcedure = class {
|
|
|
27
28
|
}
|
|
28
29
|
this["~orpc"] = def;
|
|
29
30
|
}
|
|
30
|
-
}
|
|
31
|
+
}
|
|
31
32
|
function isContractProcedure(item) {
|
|
32
33
|
if (item instanceof ContractProcedure) {
|
|
33
34
|
return true;
|
|
34
35
|
}
|
|
35
|
-
return (typeof item === "object" || typeof item === "function") && item !== null && "~orpc" in item && typeof item["~orpc"] === "object" && item["~orpc"] !== null && "
|
|
36
|
+
return (typeof item === "object" || typeof item === "function") && item !== null && "~orpc" in item && typeof item["~orpc"] === "object" && item["~orpc"] !== null && "errorMap" in item["~orpc"] && "route" in item["~orpc"] && "meta" in item["~orpc"];
|
|
36
37
|
}
|
|
37
38
|
|
|
38
|
-
// src/route.ts
|
|
39
39
|
function mergeRoute(a, b) {
|
|
40
40
|
return { ...a, ...b };
|
|
41
41
|
}
|
|
@@ -60,36 +60,48 @@ function mergePrefix(a, b) {
|
|
|
60
60
|
function mergeTags(a, b) {
|
|
61
61
|
return a ? [...a, ...b] : b;
|
|
62
62
|
}
|
|
63
|
-
function
|
|
63
|
+
function enhanceRoute(route, options) {
|
|
64
64
|
let router = route;
|
|
65
65
|
if (options.prefix) {
|
|
66
66
|
router = prefixRoute(router, options.prefix);
|
|
67
67
|
}
|
|
68
|
-
if (options.tags) {
|
|
68
|
+
if (options.tags?.length) {
|
|
69
69
|
router = unshiftTagRoute(router, options.tags);
|
|
70
70
|
}
|
|
71
71
|
return router;
|
|
72
72
|
}
|
|
73
73
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
const
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
74
|
+
function getContractRouter(router, path) {
|
|
75
|
+
let current = router;
|
|
76
|
+
for (let i = 0; i < path.length; i++) {
|
|
77
|
+
const segment = path[i];
|
|
78
|
+
if (!current) {
|
|
79
|
+
return void 0;
|
|
80
|
+
}
|
|
81
|
+
if (isContractProcedure(current)) {
|
|
82
|
+
return void 0;
|
|
83
|
+
}
|
|
84
|
+
current = current[segment];
|
|
85
|
+
}
|
|
86
|
+
return current;
|
|
87
|
+
}
|
|
88
|
+
function enhanceContractRouter(router, options) {
|
|
89
|
+
if (isContractProcedure(router)) {
|
|
90
|
+
const enhanced2 = new ContractProcedure({
|
|
91
|
+
...router["~orpc"],
|
|
92
|
+
errorMap: mergeErrorMap(options.errorMap, router["~orpc"].errorMap),
|
|
93
|
+
route: enhanceRoute(router["~orpc"].route, options)
|
|
81
94
|
});
|
|
82
|
-
return
|
|
95
|
+
return enhanced2;
|
|
83
96
|
}
|
|
84
|
-
const
|
|
85
|
-
for (const key in
|
|
86
|
-
|
|
97
|
+
const enhanced = {};
|
|
98
|
+
for (const key in router) {
|
|
99
|
+
enhanced[key] = enhanceContractRouter(router[key], options);
|
|
87
100
|
}
|
|
88
|
-
return
|
|
101
|
+
return enhanced;
|
|
89
102
|
}
|
|
90
103
|
|
|
91
|
-
|
|
92
|
-
var ContractBuilder = class _ContractBuilder extends ContractProcedure {
|
|
104
|
+
class ContractBuilder extends ContractProcedure {
|
|
93
105
|
constructor(def) {
|
|
94
106
|
super(def);
|
|
95
107
|
this["~orpc"].prefix = def.prefix;
|
|
@@ -99,7 +111,7 @@ var ContractBuilder = class _ContractBuilder extends ContractProcedure {
|
|
|
99
111
|
* Reset initial meta
|
|
100
112
|
*/
|
|
101
113
|
$meta(initialMeta) {
|
|
102
|
-
return new
|
|
114
|
+
return new ContractBuilder({
|
|
103
115
|
...this["~orpc"],
|
|
104
116
|
meta: initialMeta
|
|
105
117
|
});
|
|
@@ -108,67 +120,64 @@ var ContractBuilder = class _ContractBuilder extends ContractProcedure {
|
|
|
108
120
|
* Reset initial route
|
|
109
121
|
*/
|
|
110
122
|
$route(initialRoute) {
|
|
111
|
-
return new
|
|
123
|
+
return new ContractBuilder({
|
|
112
124
|
...this["~orpc"],
|
|
113
125
|
route: initialRoute
|
|
114
126
|
});
|
|
115
127
|
}
|
|
116
128
|
errors(errors) {
|
|
117
|
-
return new
|
|
129
|
+
return new ContractBuilder({
|
|
118
130
|
...this["~orpc"],
|
|
119
131
|
errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
|
|
120
132
|
});
|
|
121
133
|
}
|
|
122
134
|
meta(meta) {
|
|
123
|
-
return new
|
|
135
|
+
return new ContractBuilder({
|
|
124
136
|
...this["~orpc"],
|
|
125
137
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
|
126
138
|
});
|
|
127
139
|
}
|
|
128
140
|
route(route) {
|
|
129
|
-
return new
|
|
141
|
+
return new ContractBuilder({
|
|
130
142
|
...this["~orpc"],
|
|
131
143
|
route: mergeRoute(this["~orpc"].route, route)
|
|
132
144
|
});
|
|
133
145
|
}
|
|
134
146
|
input(schema) {
|
|
135
|
-
return new
|
|
147
|
+
return new ContractBuilder({
|
|
136
148
|
...this["~orpc"],
|
|
137
149
|
inputSchema: schema
|
|
138
150
|
});
|
|
139
151
|
}
|
|
140
152
|
output(schema) {
|
|
141
|
-
return new
|
|
153
|
+
return new ContractBuilder({
|
|
142
154
|
...this["~orpc"],
|
|
143
155
|
outputSchema: schema
|
|
144
156
|
});
|
|
145
157
|
}
|
|
146
158
|
prefix(prefix) {
|
|
147
|
-
return new
|
|
159
|
+
return new ContractBuilder({
|
|
148
160
|
...this["~orpc"],
|
|
149
161
|
prefix: mergePrefix(this["~orpc"].prefix, prefix)
|
|
150
162
|
});
|
|
151
163
|
}
|
|
152
164
|
tag(...tags) {
|
|
153
|
-
return new
|
|
165
|
+
return new ContractBuilder({
|
|
154
166
|
...this["~orpc"],
|
|
155
167
|
tags: mergeTags(this["~orpc"].tags, tags)
|
|
156
168
|
});
|
|
157
169
|
}
|
|
158
170
|
router(router) {
|
|
159
|
-
return
|
|
171
|
+
return enhanceContractRouter(router, this["~orpc"]);
|
|
160
172
|
}
|
|
161
|
-
}
|
|
162
|
-
|
|
173
|
+
}
|
|
174
|
+
const oc = new ContractBuilder({
|
|
163
175
|
errorMap: {},
|
|
164
|
-
inputSchema: void 0,
|
|
165
|
-
outputSchema: void 0,
|
|
166
176
|
route: {},
|
|
167
177
|
meta: {}
|
|
168
178
|
});
|
|
169
179
|
|
|
170
|
-
|
|
171
|
-
var DEFAULT_CONFIG = {
|
|
180
|
+
const DEFAULT_CONFIG = {
|
|
172
181
|
defaultMethod: "POST",
|
|
173
182
|
defaultSuccessStatus: 200,
|
|
174
183
|
defaultSuccessDescription: "OK",
|
|
@@ -182,19 +191,16 @@ function fallbackContractConfig(key, value) {
|
|
|
182
191
|
return value;
|
|
183
192
|
}
|
|
184
193
|
|
|
185
|
-
|
|
186
|
-
import { mapEventIterator, ORPCError } from "@orpc/client";
|
|
187
|
-
import { isAsyncIteratorObject } from "@orpc/server-standard";
|
|
188
|
-
var EVENT_ITERATOR_SCHEMA_SYMBOL = Symbol("ORPC_EVENT_ITERATOR_SCHEMA");
|
|
194
|
+
const EVENT_ITERATOR_DETAILS_SYMBOL = Symbol("ORPC_EVENT_ITERATOR_DETAILS");
|
|
189
195
|
function eventIterator(yields, returns) {
|
|
190
196
|
return {
|
|
191
197
|
"~standard": {
|
|
192
|
-
[
|
|
198
|
+
[EVENT_ITERATOR_DETAILS_SYMBOL]: { yields, returns },
|
|
193
199
|
vendor: "orpc",
|
|
194
200
|
version: 1,
|
|
195
201
|
validate(iterator) {
|
|
196
202
|
if (!isAsyncIteratorObject(iterator)) {
|
|
197
|
-
return { issues: [{ message: "Expect event
|
|
203
|
+
return { issues: [{ message: "Expect event iterator", path: [] }] };
|
|
198
204
|
}
|
|
199
205
|
const mapped = mapEventIterator(iterator, {
|
|
200
206
|
async value(value, done) {
|
|
@@ -205,10 +211,10 @@ function eventIterator(yields, returns) {
|
|
|
205
211
|
const result = await schema["~standard"].validate(value);
|
|
206
212
|
if (result.issues) {
|
|
207
213
|
throw new ORPCError("EVENT_ITERATOR_VALIDATION_FAILED", {
|
|
208
|
-
message: "Event
|
|
214
|
+
message: "Event iterator validation failed",
|
|
209
215
|
cause: new ValidationError({
|
|
210
216
|
issues: result.issues,
|
|
211
|
-
message: "Event
|
|
217
|
+
message: "Event iterator validation failed"
|
|
212
218
|
})
|
|
213
219
|
});
|
|
214
220
|
}
|
|
@@ -225,10 +231,9 @@ function getEventIteratorSchemaDetails(schema) {
|
|
|
225
231
|
if (schema === void 0) {
|
|
226
232
|
return void 0;
|
|
227
233
|
}
|
|
228
|
-
return schema["~standard"][
|
|
234
|
+
return schema["~standard"][EVENT_ITERATOR_DETAILS_SYMBOL];
|
|
229
235
|
}
|
|
230
236
|
|
|
231
|
-
// src/schema.ts
|
|
232
237
|
function type(...[map]) {
|
|
233
238
|
return {
|
|
234
239
|
"~standard": {
|
|
@@ -244,27 +249,4 @@ function type(...[map]) {
|
|
|
244
249
|
};
|
|
245
250
|
}
|
|
246
251
|
|
|
247
|
-
|
|
248
|
-
import { ORPCError as ORPCError2 } from "@orpc/client";
|
|
249
|
-
export {
|
|
250
|
-
ContractBuilder,
|
|
251
|
-
ContractProcedure,
|
|
252
|
-
ORPCError2 as ORPCError,
|
|
253
|
-
ValidationError,
|
|
254
|
-
adaptContractRouter,
|
|
255
|
-
adaptRoute,
|
|
256
|
-
eventIterator,
|
|
257
|
-
fallbackContractConfig,
|
|
258
|
-
getEventIteratorSchemaDetails,
|
|
259
|
-
isContractProcedure,
|
|
260
|
-
mergeErrorMap,
|
|
261
|
-
mergeMeta,
|
|
262
|
-
mergePrefix,
|
|
263
|
-
mergeRoute,
|
|
264
|
-
mergeTags,
|
|
265
|
-
oc,
|
|
266
|
-
prefixRoute,
|
|
267
|
-
type,
|
|
268
|
-
unshiftTagRoute
|
|
269
|
-
};
|
|
270
|
-
//# sourceMappingURL=index.js.map
|
|
252
|
+
export { ContractBuilder, ContractProcedure, ValidationError, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, isContractProcedure, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, oc, prefixRoute, type, unshiftTagRoute };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/contract",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.0.0-next.
|
|
4
|
+
"version": "0.0.0-next.ff68fdb",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
|
7
7
|
"repository": {
|
|
@@ -15,32 +15,27 @@
|
|
|
15
15
|
],
|
|
16
16
|
"exports": {
|
|
17
17
|
".": {
|
|
18
|
-
"types": "./dist/
|
|
19
|
-
"import": "./dist/index.
|
|
20
|
-
"default": "./dist/index.
|
|
21
|
-
},
|
|
22
|
-
"./🔒/*": {
|
|
23
|
-
"types": "./dist/src/*.d.ts"
|
|
18
|
+
"types": "./dist/index.d.mts",
|
|
19
|
+
"import": "./dist/index.mjs",
|
|
20
|
+
"default": "./dist/index.mjs"
|
|
24
21
|
}
|
|
25
22
|
},
|
|
26
23
|
"files": [
|
|
27
|
-
"!**/*.map",
|
|
28
|
-
"!**/*.tsbuildinfo",
|
|
29
24
|
"dist"
|
|
30
25
|
],
|
|
31
26
|
"dependencies": {
|
|
32
|
-
"@orpc/server-standard": "^0.4.0",
|
|
33
27
|
"@standard-schema/spec": "^1.0.0",
|
|
34
|
-
"@orpc/client": "0.0.0-next.
|
|
35
|
-
"@orpc/shared": "0.0.0-next.
|
|
28
|
+
"@orpc/client": "0.0.0-next.ff68fdb",
|
|
29
|
+
"@orpc/shared": "0.0.0-next.ff68fdb",
|
|
30
|
+
"@orpc/standard-server": "0.0.0-next.ff68fdb"
|
|
36
31
|
},
|
|
37
32
|
"devDependencies": {
|
|
38
33
|
"arktype": "2.0.0-rc.26",
|
|
39
34
|
"valibot": "1.0.0-beta.9",
|
|
40
|
-
"zod": "^3.24.
|
|
35
|
+
"zod": "^3.24.2"
|
|
41
36
|
},
|
|
42
37
|
"scripts": {
|
|
43
|
-
"build": "
|
|
38
|
+
"build": "unbuild",
|
|
44
39
|
"build:watch": "pnpm run build --watch",
|
|
45
40
|
"type:check": "tsc -b"
|
|
46
41
|
}
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
import type { ErrorMap, MergedErrorMap } from './error';
|
|
2
|
-
import type { Meta } from './meta';
|
|
3
|
-
import type { ContractProcedure } from './procedure';
|
|
4
|
-
import type { HTTPPath, Route } from './route';
|
|
5
|
-
import type { AdaptContractRouterOptions, AdaptedContractRouter, ContractRouter } from './router';
|
|
6
|
-
import type { Schema } from './schema';
|
|
7
|
-
export interface ContractProcedureBuilder<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
8
|
-
errors<U extends ErrorMap>(errors: U): ContractProcedureBuilder<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
9
|
-
meta(meta: TMeta): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
10
|
-
route(route: Route): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
11
|
-
input<U extends Schema>(schema: U): ContractProcedureBuilderWithInput<U, TOutputSchema, TErrorMap, TMeta>;
|
|
12
|
-
output<U extends Schema>(schema: U): ContractProcedureBuilderWithOutput<TInputSchema, U, TErrorMap, TMeta>;
|
|
13
|
-
}
|
|
14
|
-
export interface ContractProcedureBuilderWithInput<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
15
|
-
errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
16
|
-
meta(meta: TMeta): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
17
|
-
route(route: Route): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
18
|
-
output<U extends Schema>(schema: U): ContractProcedureBuilderWithInputOutput<TInputSchema, U, TErrorMap, TMeta>;
|
|
19
|
-
}
|
|
20
|
-
export interface ContractProcedureBuilderWithOutput<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
21
|
-
errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
22
|
-
meta(meta: TMeta): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
23
|
-
route(route: Route): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
24
|
-
input<U extends Schema>(schema: U): ContractProcedureBuilderWithInputOutput<U, TOutputSchema, TErrorMap, TMeta>;
|
|
25
|
-
}
|
|
26
|
-
export interface ContractProcedureBuilderWithInputOutput<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
27
|
-
errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
28
|
-
meta(meta: TMeta): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
29
|
-
route(route: Route): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
30
|
-
}
|
|
31
|
-
export interface ContractRouterBuilder<TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
32
|
-
'~orpc': AdaptContractRouterOptions<TErrorMap>;
|
|
33
|
-
'errors'<U extends ErrorMap>(errors: U): ContractRouterBuilder<MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
34
|
-
'prefix'(prefix: HTTPPath): ContractRouterBuilder<TErrorMap, TMeta>;
|
|
35
|
-
'tag'(...tags: string[]): ContractRouterBuilder<TErrorMap, TMeta>;
|
|
36
|
-
'router'<T extends ContractRouter<TMeta>>(router: T): AdaptedContractRouter<T, TErrorMap>;
|
|
37
|
-
}
|
|
38
|
-
//# sourceMappingURL=builder-variants.d.ts.map
|
package/dist/src/builder.d.ts
DELETED
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
import type { ContractProcedureBuilder, ContractProcedureBuilderWithInput, ContractProcedureBuilderWithOutput, ContractRouterBuilder } from './builder-variants';
|
|
2
|
-
import type { ContractProcedureDef } from './procedure';
|
|
3
|
-
import type { AdaptContractRouterOptions, AdaptedContractRouter, ContractRouter } from './router';
|
|
4
|
-
import type { Schema } from './schema';
|
|
5
|
-
import { type ErrorMap, type MergedErrorMap } from './error';
|
|
6
|
-
import { type Meta } from './meta';
|
|
7
|
-
import { ContractProcedure } from './procedure';
|
|
8
|
-
import { type HTTPPath, type Route } from './route';
|
|
9
|
-
export interface ContractBuilderDef<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>, AdaptContractRouterOptions<TErrorMap> {
|
|
10
|
-
}
|
|
11
|
-
export declare class ContractBuilder<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
12
|
-
'~orpc': ContractBuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
13
|
-
constructor(def: ContractBuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
|
|
14
|
-
/**
|
|
15
|
-
* Reset initial meta
|
|
16
|
-
*/
|
|
17
|
-
$meta<U extends Meta>(initialMeta: U): ContractBuilder<TInputSchema, TOutputSchema, TErrorMap, U>;
|
|
18
|
-
/**
|
|
19
|
-
* Reset initial route
|
|
20
|
-
*/
|
|
21
|
-
$route(initialRoute: Route): ContractBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
22
|
-
errors<U extends ErrorMap>(errors: U): ContractBuilder<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
23
|
-
meta(meta: TMeta): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
24
|
-
route(route: Route): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
25
|
-
input<U extends Schema>(schema: U): ContractProcedureBuilderWithInput<U, TOutputSchema, TErrorMap, TMeta>;
|
|
26
|
-
output<U extends Schema>(schema: U): ContractProcedureBuilderWithOutput<TInputSchema, U, TErrorMap, TMeta>;
|
|
27
|
-
prefix(prefix: HTTPPath): ContractRouterBuilder<TErrorMap, TMeta>;
|
|
28
|
-
tag(...tags: string[]): ContractRouterBuilder<TErrorMap, TMeta>;
|
|
29
|
-
router<T extends ContractRouter<TMeta>>(router: T): AdaptedContractRouter<T, TErrorMap>;
|
|
30
|
-
}
|
|
31
|
-
export declare const oc: ContractBuilder<undefined, undefined, {}, {}>;
|
|
32
|
-
//# sourceMappingURL=builder.d.ts.map
|
package/dist/src/config.d.ts
DELETED
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import type { HTTPMethod, InputStructure } from './route';
|
|
2
|
-
export interface ContractConfig {
|
|
3
|
-
defaultMethod: HTTPMethod;
|
|
4
|
-
defaultSuccessStatus: number;
|
|
5
|
-
defaultSuccessDescription: string;
|
|
6
|
-
defaultInputStructure: InputStructure;
|
|
7
|
-
defaultOutputStructure: InputStructure;
|
|
8
|
-
}
|
|
9
|
-
export declare function fallbackContractConfig<T extends keyof ContractConfig>(key: T, value: ContractConfig[T] | undefined): ContractConfig[T];
|
|
10
|
-
//# sourceMappingURL=config.d.ts.map
|
package/dist/src/error.d.ts
DELETED
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
import type { ORPCError, ORPCErrorCode } from '@orpc/client';
|
|
2
|
-
import type { StandardSchemaV1 } from '@standard-schema/spec';
|
|
3
|
-
import type { Schema, SchemaOutput } from './schema';
|
|
4
|
-
export interface ValidationErrorOptions extends ErrorOptions {
|
|
5
|
-
message: string;
|
|
6
|
-
issues: readonly StandardSchemaV1.Issue[];
|
|
7
|
-
}
|
|
8
|
-
export declare class ValidationError extends Error {
|
|
9
|
-
readonly issues: readonly StandardSchemaV1.Issue[];
|
|
10
|
-
constructor(options: ValidationErrorOptions);
|
|
11
|
-
}
|
|
12
|
-
export type ErrorMapItem<TDataSchema extends Schema> = {
|
|
13
|
-
status?: number;
|
|
14
|
-
message?: string;
|
|
15
|
-
description?: string;
|
|
16
|
-
data?: TDataSchema;
|
|
17
|
-
};
|
|
18
|
-
export type ErrorMap = {
|
|
19
|
-
[key in ORPCErrorCode]?: ErrorMapItem<Schema>;
|
|
20
|
-
};
|
|
21
|
-
export type MergedErrorMap<T1 extends ErrorMap, T2 extends ErrorMap> = Omit<T1, keyof T2> & T2;
|
|
22
|
-
export declare function mergeErrorMap<T1 extends ErrorMap, T2 extends ErrorMap>(errorMap1: T1, errorMap2: T2): MergedErrorMap<T1, T2>;
|
|
23
|
-
export type ORPCErrorFromErrorMap<TErrorMap extends ErrorMap> = {
|
|
24
|
-
[K in keyof TErrorMap]: K extends string ? TErrorMap[K] extends ErrorMapItem<infer TDataSchema> ? ORPCError<K, SchemaOutput<TDataSchema>> : never : never;
|
|
25
|
-
}[keyof TErrorMap];
|
|
26
|
-
export type ErrorFromErrorMap<TErrorMap extends ErrorMap> = Error | ORPCErrorFromErrorMap<TErrorMap>;
|
|
27
|
-
//# sourceMappingURL=error.d.ts.map
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import type { StandardSchemaV1 } from '@standard-schema/spec';
|
|
2
|
-
import type { Schema } from './schema';
|
|
3
|
-
export declare function eventIterator<TYieldIn, TYieldOut, TReturnIn = unknown, TReturnOut = unknown>(yields: StandardSchemaV1<TYieldIn, TYieldOut>, returns?: StandardSchemaV1<TReturnIn, TReturnOut>): StandardSchemaV1<AsyncIteratorObject<TYieldIn, TReturnIn, void>, AsyncIteratorObject<TYieldOut, TReturnOut, void>>;
|
|
4
|
-
export declare function getEventIteratorSchemaDetails(schema: Schema): undefined | {
|
|
5
|
-
yields: Schema;
|
|
6
|
-
returns: Schema;
|
|
7
|
-
};
|
|
8
|
-
//# sourceMappingURL=event-iterator.d.ts.map
|
package/dist/src/index.d.ts
DELETED
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
/** unnoq */
|
|
2
|
-
export * from './builder';
|
|
3
|
-
export * from './builder-variants';
|
|
4
|
-
export * from './config';
|
|
5
|
-
export * from './error';
|
|
6
|
-
export * from './event-iterator';
|
|
7
|
-
export * from './meta';
|
|
8
|
-
export * from './procedure';
|
|
9
|
-
export * from './procedure-client';
|
|
10
|
-
export * from './route';
|
|
11
|
-
export * from './router';
|
|
12
|
-
export * from './router-client';
|
|
13
|
-
export * from './schema';
|
|
14
|
-
export { ORPCError } from '@orpc/client';
|
|
15
|
-
//# sourceMappingURL=index.d.ts.map
|
package/dist/src/meta.d.ts
DELETED
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import type { Client, ClientContext } from '@orpc/client';
|
|
2
|
-
import type { ErrorFromErrorMap, ErrorMap } from './error';
|
|
3
|
-
import type { Schema, SchemaInput, SchemaOutput } from './schema';
|
|
4
|
-
export type ContractProcedureClient<TClientContext extends ClientContext, TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap> = Client<TClientContext, SchemaInput<TInputSchema>, SchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
|
|
5
|
-
//# sourceMappingURL=procedure-client.d.ts.map
|
package/dist/src/procedure.d.ts
DELETED
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
import type { ErrorMap } from './error';
|
|
2
|
-
import type { Meta } from './meta';
|
|
3
|
-
import type { Route } from './route';
|
|
4
|
-
import type { Schema } from './schema';
|
|
5
|
-
export interface ContractProcedureDef<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
6
|
-
meta: TMeta;
|
|
7
|
-
route: Route;
|
|
8
|
-
inputSchema: TInputSchema;
|
|
9
|
-
outputSchema: TOutputSchema;
|
|
10
|
-
errorMap: TErrorMap;
|
|
11
|
-
}
|
|
12
|
-
export declare class ContractProcedure<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
13
|
-
'~orpc': ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
14
|
-
constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
|
|
15
|
-
}
|
|
16
|
-
export type AnyContractProcedure = ContractProcedure<any, any, any, any>;
|
|
17
|
-
export declare function isContractProcedure(item: unknown): item is AnyContractProcedure;
|
|
18
|
-
//# sourceMappingURL=procedure.d.ts.map
|
package/dist/src/route.d.ts
DELETED
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
export type HTTPPath = `/${string}`;
|
|
2
|
-
export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
3
|
-
export type InputStructure = 'compact' | 'detailed';
|
|
4
|
-
export type OutputStructure = 'compact' | 'detailed';
|
|
5
|
-
export interface Route {
|
|
6
|
-
method?: HTTPMethod;
|
|
7
|
-
path?: HTTPPath;
|
|
8
|
-
summary?: string;
|
|
9
|
-
description?: string;
|
|
10
|
-
deprecated?: boolean;
|
|
11
|
-
tags?: readonly string[];
|
|
12
|
-
/**
|
|
13
|
-
* The status code of the response when the procedure is successful.
|
|
14
|
-
*
|
|
15
|
-
* @default 200
|
|
16
|
-
*/
|
|
17
|
-
successStatus?: number;
|
|
18
|
-
/**
|
|
19
|
-
* The description of the response when the procedure is successful.
|
|
20
|
-
*
|
|
21
|
-
* @default 'OK'
|
|
22
|
-
*/
|
|
23
|
-
successDescription?: string;
|
|
24
|
-
/**
|
|
25
|
-
* Determines how the input should be structured based on `params`, `query`, `headers`, and `body`.
|
|
26
|
-
*
|
|
27
|
-
* @option 'compact'
|
|
28
|
-
* Combines `params` and either `query` or `body` (depending on the HTTP method) into a single object.
|
|
29
|
-
*
|
|
30
|
-
* @option 'detailed'
|
|
31
|
-
* Keeps each part of the request (`params`, `query`, `headers`, and `body`) as separate fields in the input object.
|
|
32
|
-
*
|
|
33
|
-
* Example:
|
|
34
|
-
* ```ts
|
|
35
|
-
* const input = {
|
|
36
|
-
* params: { id: 1 },
|
|
37
|
-
* query: { search: 'hello' },
|
|
38
|
-
* headers: { 'Content-Type': 'application/json' },
|
|
39
|
-
* body: { name: 'John' },
|
|
40
|
-
* }
|
|
41
|
-
* ```
|
|
42
|
-
*
|
|
43
|
-
* @default 'compact'
|
|
44
|
-
*/
|
|
45
|
-
inputStructure?: InputStructure;
|
|
46
|
-
/**
|
|
47
|
-
* Determines how the response should be structured based on the output.
|
|
48
|
-
*
|
|
49
|
-
* @option 'compact'
|
|
50
|
-
* Includes only the body data, encoded directly in the response.
|
|
51
|
-
*
|
|
52
|
-
* @option 'detailed'
|
|
53
|
-
* Separates the output into `headers` and `body` fields.
|
|
54
|
-
* - `headers`: Custom headers to merge with the response headers.
|
|
55
|
-
* - `body`: The response data.
|
|
56
|
-
*
|
|
57
|
-
* Example:
|
|
58
|
-
* ```ts
|
|
59
|
-
* const output = {
|
|
60
|
-
* headers: { 'x-custom-header': 'value' },
|
|
61
|
-
* body: { message: 'Hello, world!' },
|
|
62
|
-
* };
|
|
63
|
-
* ```
|
|
64
|
-
*
|
|
65
|
-
* @default 'compact'
|
|
66
|
-
*/
|
|
67
|
-
outputStructure?: OutputStructure;
|
|
68
|
-
}
|
|
69
|
-
export declare function mergeRoute(a: Route, b: Route): Route;
|
|
70
|
-
export declare function prefixRoute(route: Route, prefix: HTTPPath): Route;
|
|
71
|
-
export declare function unshiftTagRoute(route: Route, tags: readonly string[]): Route;
|
|
72
|
-
export declare function mergePrefix(a: HTTPPath | undefined, b: HTTPPath): HTTPPath;
|
|
73
|
-
export declare function mergeTags(a: readonly string[] | undefined, b: readonly string[]): readonly string[];
|
|
74
|
-
export interface AdaptRouteOptions {
|
|
75
|
-
prefix?: HTTPPath;
|
|
76
|
-
tags?: readonly string[];
|
|
77
|
-
}
|
|
78
|
-
export declare function adaptRoute(route: Route, options: AdaptRouteOptions): Route;
|
|
79
|
-
//# sourceMappingURL=route.d.ts.map
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import type { ClientContext } from '@orpc/client';
|
|
2
|
-
import type { ContractProcedure } from './procedure';
|
|
3
|
-
import type { ContractProcedureClient } from './procedure-client';
|
|
4
|
-
import type { AnyContractRouter } from './router';
|
|
5
|
-
export type ContractRouterClient<TRouter extends AnyContractRouter, TClientContext extends ClientContext = Record<never, never>> = TRouter extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, any> ? ContractProcedureClient<TClientContext, UInputSchema, UOutputSchema, UErrorMap> : {
|
|
6
|
-
[K in keyof TRouter]: TRouter[K] extends AnyContractRouter ? ContractRouterClient<TRouter[K], TClientContext> : never;
|
|
7
|
-
};
|
|
8
|
-
//# sourceMappingURL=router-client.d.ts.map
|
package/dist/src/router.d.ts
DELETED
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
import type { Meta } from './meta';
|
|
2
|
-
import type { SchemaInput, SchemaOutput } from './schema';
|
|
3
|
-
import { type ErrorMap, type MergedErrorMap } from './error';
|
|
4
|
-
import { ContractProcedure } from './procedure';
|
|
5
|
-
import { type HTTPPath } from './route';
|
|
6
|
-
export type ContractRouter<TMeta extends Meta> = ContractProcedure<any, any, any, TMeta> | {
|
|
7
|
-
[k: string]: ContractRouter<TMeta>;
|
|
8
|
-
};
|
|
9
|
-
export type AnyContractRouter = ContractRouter<any>;
|
|
10
|
-
export type AdaptedContractRouter<TContract extends AnyContractRouter, TErrorMap extends ErrorMap> = {
|
|
11
|
-
[K in keyof TContract]: TContract[K] extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrors, infer UMeta> ? ContractProcedure<UInputSchema, UOutputSchema, MergedErrorMap<TErrorMap, UErrors>, UMeta> : TContract[K] extends AnyContractRouter ? AdaptedContractRouter<TContract[K], TErrorMap> : never;
|
|
12
|
-
};
|
|
13
|
-
export interface AdaptContractRouterOptions<TErrorMap extends ErrorMap> {
|
|
14
|
-
errorMap: TErrorMap;
|
|
15
|
-
prefix?: HTTPPath;
|
|
16
|
-
tags?: readonly string[];
|
|
17
|
-
}
|
|
18
|
-
export declare function adaptContractRouter<TRouter extends ContractRouter<any>, TErrorMap extends ErrorMap>(contract: TRouter, options: AdaptContractRouterOptions<TErrorMap>): AdaptedContractRouter<TRouter, TErrorMap>;
|
|
19
|
-
export type InferContractRouterInputs<T extends AnyContractRouter> = T extends ContractProcedure<infer UInputSchema, any, any, any> ? SchemaInput<UInputSchema> : {
|
|
20
|
-
[K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterInputs<T[K]> : never;
|
|
21
|
-
};
|
|
22
|
-
export type InferContractRouterOutputs<T extends AnyContractRouter> = T extends ContractProcedure<any, infer UOutputSchema, any, any> ? SchemaOutput<UOutputSchema> : {
|
|
23
|
-
[K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterOutputs<T[K]> : never;
|
|
24
|
-
};
|
|
25
|
-
export type ContractRouterToErrorMap<T extends AnyContractRouter> = T extends ContractProcedure<any, any, infer UErrorMap, any> ? UErrorMap : {
|
|
26
|
-
[K in keyof T]: T[K] extends AnyContractRouter ? ContractRouterToErrorMap<T[K]> : never;
|
|
27
|
-
}[keyof T];
|
|
28
|
-
export type ContractRouterToMeta<T extends AnyContractRouter> = T extends ContractRouter<infer UMeta> ? UMeta : never;
|
|
29
|
-
//# sourceMappingURL=router.d.ts.map
|
package/dist/src/schema.d.ts
DELETED
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import type { IsEqual, Promisable } from '@orpc/shared';
|
|
2
|
-
import type { StandardSchemaV1 } from '@standard-schema/spec';
|
|
3
|
-
export type Schema = StandardSchemaV1 | undefined;
|
|
4
|
-
export type SchemaInput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferInput<TSchema> : TFallback;
|
|
5
|
-
export type SchemaOutput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TSchema> : TFallback;
|
|
6
|
-
export type TypeRest<TInput, TOutput> = [map: (input: TInput) => Promisable<TOutput>] | (IsEqual<TInput, TOutput> extends true ? [] : never);
|
|
7
|
-
export declare function type<TInput, TOutput = TInput>(...[map]: TypeRest<TInput, TOutput>): StandardSchemaV1<TInput, TOutput>;
|
|
8
|
-
//# sourceMappingURL=schema.d.ts.map
|