@orpc/contract 0.0.0-next.b15d206 → 0.0.0-next.b2e67f7
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 +101 -0
- package/dist/index.js +223 -129
- package/dist/src/builder-variants.d.ts +38 -0
- package/dist/src/builder.d.ts +30 -11
- package/dist/src/config.d.ts +10 -0
- package/dist/src/error.d.ts +27 -0
- package/dist/src/event-iterator.d.ts +8 -0
- package/dist/src/index.d.ts +10 -5
- package/dist/src/meta.d.ts +3 -0
- package/dist/src/procedure-client.d.ts +5 -0
- package/dist/src/procedure.d.ts +15 -43
- package/dist/src/route.d.ts +79 -0
- package/dist/src/router-client.d.ts +8 -0
- package/dist/src/router.d.ts +25 -12
- package/dist/src/schema.d.ts +8 -0
- package/package.json +15 -14
- package/dist/index.js.map +0 -1
- package/dist/src/builder.d.ts.map +0 -1
- package/dist/src/constants.d.ts +0 -3
- package/dist/src/constants.d.ts.map +0 -1
- package/dist/src/index.d.ts.map +0 -1
- package/dist/src/procedure.d.ts.map +0 -1
- package/dist/src/router-builder.d.ts +0 -16
- package/dist/src/router-builder.d.ts.map +0 -1
- package/dist/src/router.d.ts.map +0 -1
- package/dist/src/types.d.ts +0 -8
- package/dist/src/types.d.ts.map +0 -1
- package/dist/src/utils.d.ts +0 -4
- package/dist/src/utils.d.ts.map +0 -1
- package/dist/tsconfig.tsbuildinfo +0 -1
- package/src/builder.test.ts +0 -179
- package/src/builder.ts +0 -52
- package/src/constants.ts +0 -2
- package/src/index.ts +0 -12
- package/src/procedure.test.ts +0 -99
- package/src/procedure.ts +0 -125
- package/src/router-builder.test.ts +0 -70
- package/src/router-builder.ts +0 -46
- package/src/router.test-d.ts +0 -63
- package/src/router.test.ts +0 -24
- package/src/router.ts +0 -55
- package/src/types.test-d.ts +0 -16
- package/src/types.ts +0 -25
- package/src/utils.test.ts +0 -18
- package/src/utils.ts +0 -17
package/README.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
|
|
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), 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/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
59
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
|
60
|
+
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
61
|
+
|
|
62
|
+
## `@orpc/contract`
|
|
63
|
+
|
|
64
|
+
Build your API contract. Read the [documentation](https://orpc.unnoq.com/docs/contract-first/define-contract) for more information.
|
|
65
|
+
|
|
66
|
+
```ts
|
|
67
|
+
export const PlanetSchema = z.object({
|
|
68
|
+
id: z.number().int().min(1),
|
|
69
|
+
name: z.string(),
|
|
70
|
+
description: z.string().optional(),
|
|
71
|
+
})
|
|
72
|
+
|
|
73
|
+
export const listPlanetContract = oc
|
|
74
|
+
.input(
|
|
75
|
+
z.object({
|
|
76
|
+
limit: z.number().int().min(1).max(100).optional(),
|
|
77
|
+
cursor: z.number().int().min(0).default(0),
|
|
78
|
+
}),
|
|
79
|
+
)
|
|
80
|
+
.output(z.array(PlanetSchema))
|
|
81
|
+
|
|
82
|
+
export const findPlanetContract = oc
|
|
83
|
+
.input(PlanetSchema.pick({ id: true }))
|
|
84
|
+
.output(PlanetSchema)
|
|
85
|
+
|
|
86
|
+
export const createPlanetContract = oc
|
|
87
|
+
.input(PlanetSchema.omit({ id: true }))
|
|
88
|
+
.output(PlanetSchema)
|
|
89
|
+
|
|
90
|
+
export const contract = {
|
|
91
|
+
planet: {
|
|
92
|
+
list: listPlanetContract,
|
|
93
|
+
find: findPlanetContract,
|
|
94
|
+
create: createPlanetContract,
|
|
95
|
+
},
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## License
|
|
100
|
+
|
|
101
|
+
Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
|
package/dist/index.js
CHANGED
|
@@ -1,176 +1,270 @@
|
|
|
1
|
+
// src/error.ts
|
|
2
|
+
var ValidationError = class extends Error {
|
|
3
|
+
issues;
|
|
4
|
+
constructor(options) {
|
|
5
|
+
super(options.message, options);
|
|
6
|
+
this.issues = options.issues;
|
|
7
|
+
}
|
|
8
|
+
};
|
|
9
|
+
function mergeErrorMap(errorMap1, errorMap2) {
|
|
10
|
+
return { ...errorMap1, ...errorMap2 };
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
// src/meta.ts
|
|
14
|
+
function mergeMeta(meta1, meta2) {
|
|
15
|
+
return { ...meta1, ...meta2 };
|
|
16
|
+
}
|
|
17
|
+
|
|
1
18
|
// src/procedure.ts
|
|
2
19
|
var ContractProcedure = class {
|
|
3
|
-
|
|
4
|
-
|
|
20
|
+
"~orpc";
|
|
21
|
+
constructor(def) {
|
|
22
|
+
if (def.route?.successStatus && (def.route.successStatus < 200 || def.route?.successStatus > 299)) {
|
|
23
|
+
throw new Error("[ContractProcedure] The successStatus must be between 200 and 299");
|
|
24
|
+
}
|
|
25
|
+
if (Object.values(def.errorMap).some((val) => val && val.status && (val.status < 400 || val.status > 599))) {
|
|
26
|
+
throw new Error("[ContractProcedure] The error status code must be in the 400-599 range.");
|
|
27
|
+
}
|
|
28
|
+
this["~orpc"] = def;
|
|
5
29
|
}
|
|
6
30
|
};
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
return cp;
|
|
11
|
-
return new _DecoratedContractProcedure(cp.zz$cp);
|
|
12
|
-
}
|
|
13
|
-
route(opts) {
|
|
14
|
-
return new _DecoratedContractProcedure({
|
|
15
|
-
...this.zz$cp,
|
|
16
|
-
...opts,
|
|
17
|
-
method: opts.method,
|
|
18
|
-
path: opts.path
|
|
19
|
-
});
|
|
31
|
+
function isContractProcedure(item) {
|
|
32
|
+
if (item instanceof ContractProcedure) {
|
|
33
|
+
return true;
|
|
20
34
|
}
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
35
|
+
return (typeof item === "object" || typeof item === "function") && item !== null && "~orpc" in item && typeof item["~orpc"] === "object" && item["~orpc"] !== null && "inputSchema" in item["~orpc"] && "outputSchema" in item["~orpc"] && "errorMap" in item["~orpc"] && "route" in item["~orpc"] && "meta" in item["~orpc"];
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// src/route.ts
|
|
39
|
+
function mergeRoute(a, b) {
|
|
40
|
+
return { ...a, ...b };
|
|
41
|
+
}
|
|
42
|
+
function prefixRoute(route, prefix) {
|
|
43
|
+
if (!route.path) {
|
|
44
|
+
return route;
|
|
28
45
|
}
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
46
|
+
return {
|
|
47
|
+
...route,
|
|
48
|
+
path: `${prefix}${route.path}`
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
function unshiftTagRoute(route, tags) {
|
|
52
|
+
return {
|
|
53
|
+
...route,
|
|
54
|
+
tags: [...tags, ...route.tags ?? []]
|
|
55
|
+
};
|
|
56
|
+
}
|
|
57
|
+
function mergePrefix(a, b) {
|
|
58
|
+
return a ? `${a}${b}` : b;
|
|
59
|
+
}
|
|
60
|
+
function mergeTags(a, b) {
|
|
61
|
+
return a ? [...a, ...b] : b;
|
|
62
|
+
}
|
|
63
|
+
function adaptRoute(route, options) {
|
|
64
|
+
let router = route;
|
|
65
|
+
if (options.prefix) {
|
|
66
|
+
router = prefixRoute(router, options.prefix);
|
|
36
67
|
}
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
...this.zz$cp,
|
|
40
|
-
InputSchema: schema,
|
|
41
|
-
inputExample: example
|
|
42
|
-
});
|
|
68
|
+
if (options.tags) {
|
|
69
|
+
router = unshiftTagRoute(router, options.tags);
|
|
43
70
|
}
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
71
|
+
return router;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
// src/router.ts
|
|
75
|
+
function adaptContractRouter(contract, options) {
|
|
76
|
+
if (isContractProcedure(contract)) {
|
|
77
|
+
const adapted2 = new ContractProcedure({
|
|
78
|
+
...contract["~orpc"],
|
|
79
|
+
errorMap: mergeErrorMap(options.errorMap, contract["~orpc"].errorMap),
|
|
80
|
+
route: adaptRoute(contract["~orpc"].route, options)
|
|
49
81
|
});
|
|
82
|
+
return adapted2;
|
|
50
83
|
}
|
|
51
|
-
};
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
return
|
|
84
|
+
const adapted = {};
|
|
85
|
+
for (const key in contract) {
|
|
86
|
+
adapted[key] = adaptContractRouter(contract[key], options);
|
|
87
|
+
}
|
|
88
|
+
return adapted;
|
|
56
89
|
}
|
|
57
90
|
|
|
58
|
-
// src/
|
|
59
|
-
var
|
|
60
|
-
constructor(
|
|
61
|
-
|
|
91
|
+
// src/builder.ts
|
|
92
|
+
var ContractBuilder = class _ContractBuilder extends ContractProcedure {
|
|
93
|
+
constructor(def) {
|
|
94
|
+
super(def);
|
|
95
|
+
this["~orpc"].prefix = def.prefix;
|
|
96
|
+
this["~orpc"].tags = def.tags;
|
|
62
97
|
}
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
98
|
+
/**
|
|
99
|
+
* Reset initial meta
|
|
100
|
+
*/
|
|
101
|
+
$meta(initialMeta) {
|
|
102
|
+
return new _ContractBuilder({
|
|
103
|
+
...this["~orpc"],
|
|
104
|
+
meta: initialMeta
|
|
67
105
|
});
|
|
68
106
|
}
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
107
|
+
/**
|
|
108
|
+
* Reset initial route
|
|
109
|
+
*/
|
|
110
|
+
$route(initialRoute) {
|
|
111
|
+
return new _ContractBuilder({
|
|
112
|
+
...this["~orpc"],
|
|
113
|
+
route: initialRoute
|
|
75
114
|
});
|
|
76
115
|
}
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
const decorated = DecoratedContractProcedure.decorate(item).addTags(
|
|
83
|
-
...this.zz$crb.tags ?? []
|
|
84
|
-
);
|
|
85
|
-
handled[key] = this.zz$crb.prefix ? decorated.prefix(this.zz$crb.prefix) : decorated;
|
|
86
|
-
} else {
|
|
87
|
-
handled[key] = this.router(item);
|
|
88
|
-
}
|
|
89
|
-
}
|
|
90
|
-
return handled;
|
|
116
|
+
errors(errors) {
|
|
117
|
+
return new _ContractBuilder({
|
|
118
|
+
...this["~orpc"],
|
|
119
|
+
errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
|
|
120
|
+
});
|
|
91
121
|
}
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
prefix(prefix) {
|
|
97
|
-
return new ContractRouterBuilder({
|
|
98
|
-
prefix
|
|
122
|
+
meta(meta) {
|
|
123
|
+
return new _ContractBuilder({
|
|
124
|
+
...this["~orpc"],
|
|
125
|
+
meta: mergeMeta(this["~orpc"].meta, meta)
|
|
99
126
|
});
|
|
100
127
|
}
|
|
101
|
-
|
|
102
|
-
return new
|
|
103
|
-
|
|
128
|
+
route(route) {
|
|
129
|
+
return new _ContractBuilder({
|
|
130
|
+
...this["~orpc"],
|
|
131
|
+
route: mergeRoute(this["~orpc"].route, route)
|
|
104
132
|
});
|
|
105
133
|
}
|
|
106
|
-
|
|
107
|
-
return new
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
...opts
|
|
134
|
+
input(schema) {
|
|
135
|
+
return new _ContractBuilder({
|
|
136
|
+
...this["~orpc"],
|
|
137
|
+
inputSchema: schema
|
|
111
138
|
});
|
|
112
139
|
}
|
|
113
|
-
|
|
114
|
-
return new
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
OutputSchema: void 0
|
|
140
|
+
output(schema) {
|
|
141
|
+
return new _ContractBuilder({
|
|
142
|
+
...this["~orpc"],
|
|
143
|
+
outputSchema: schema
|
|
118
144
|
});
|
|
119
145
|
}
|
|
120
|
-
|
|
121
|
-
return new
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
146
|
+
prefix(prefix) {
|
|
147
|
+
return new _ContractBuilder({
|
|
148
|
+
...this["~orpc"],
|
|
149
|
+
prefix: mergePrefix(this["~orpc"].prefix, prefix)
|
|
150
|
+
});
|
|
151
|
+
}
|
|
152
|
+
tag(...tags) {
|
|
153
|
+
return new _ContractBuilder({
|
|
154
|
+
...this["~orpc"],
|
|
155
|
+
tags: mergeTags(this["~orpc"].tags, tags)
|
|
125
156
|
});
|
|
126
157
|
}
|
|
127
158
|
router(router) {
|
|
128
|
-
return router;
|
|
159
|
+
return adaptContractRouter(router, this["~orpc"]);
|
|
129
160
|
}
|
|
130
161
|
};
|
|
162
|
+
var oc = new ContractBuilder({
|
|
163
|
+
errorMap: {},
|
|
164
|
+
inputSchema: void 0,
|
|
165
|
+
outputSchema: void 0,
|
|
166
|
+
route: {},
|
|
167
|
+
meta: {}
|
|
168
|
+
});
|
|
131
169
|
|
|
132
|
-
// src/
|
|
133
|
-
var
|
|
134
|
-
|
|
170
|
+
// src/config.ts
|
|
171
|
+
var DEFAULT_CONFIG = {
|
|
172
|
+
defaultMethod: "POST",
|
|
173
|
+
defaultSuccessStatus: 200,
|
|
174
|
+
defaultSuccessDescription: "OK",
|
|
175
|
+
defaultInputStructure: "compact",
|
|
176
|
+
defaultOutputStructure: "compact"
|
|
177
|
+
};
|
|
178
|
+
function fallbackContractConfig(key, value) {
|
|
179
|
+
if (value === void 0) {
|
|
180
|
+
return DEFAULT_CONFIG[key];
|
|
181
|
+
}
|
|
182
|
+
return value;
|
|
183
|
+
}
|
|
135
184
|
|
|
136
|
-
// src/
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
185
|
+
// src/event-iterator.ts
|
|
186
|
+
import { mapEventIterator, ORPCError } from "@orpc/client";
|
|
187
|
+
import { isAsyncIteratorObject } from "@orpc/standard-server";
|
|
188
|
+
var EVENT_ITERATOR_SCHEMA_SYMBOL = Symbol("ORPC_EVENT_ITERATOR_SCHEMA");
|
|
189
|
+
function eventIterator(yields, returns) {
|
|
190
|
+
return {
|
|
191
|
+
"~standard": {
|
|
192
|
+
[EVENT_ITERATOR_SCHEMA_SYMBOL]: { yields, returns },
|
|
193
|
+
vendor: "orpc",
|
|
194
|
+
version: 1,
|
|
195
|
+
validate(iterator) {
|
|
196
|
+
if (!isAsyncIteratorObject(iterator)) {
|
|
197
|
+
return { issues: [{ message: "Expect event source iterator", path: [] }] };
|
|
198
|
+
}
|
|
199
|
+
const mapped = mapEventIterator(iterator, {
|
|
200
|
+
async value(value, done) {
|
|
201
|
+
const schema = done ? returns : yields;
|
|
202
|
+
if (!schema) {
|
|
203
|
+
return value;
|
|
204
|
+
}
|
|
205
|
+
const result = await schema["~standard"].validate(value);
|
|
206
|
+
if (result.issues) {
|
|
207
|
+
throw new ORPCError("EVENT_ITERATOR_VALIDATION_FAILED", {
|
|
208
|
+
message: "Event source iterator validation failed",
|
|
209
|
+
cause: new ValidationError({
|
|
210
|
+
issues: result.issues,
|
|
211
|
+
message: "Event source iterator validation failed"
|
|
212
|
+
})
|
|
213
|
+
});
|
|
214
|
+
}
|
|
215
|
+
return result.value;
|
|
216
|
+
},
|
|
217
|
+
error: async (error) => error
|
|
218
|
+
});
|
|
219
|
+
return { value: mapped };
|
|
220
|
+
}
|
|
144
221
|
}
|
|
222
|
+
};
|
|
223
|
+
}
|
|
224
|
+
function getEventIteratorSchemaDetails(schema) {
|
|
225
|
+
if (schema === void 0) {
|
|
226
|
+
return void 0;
|
|
145
227
|
}
|
|
228
|
+
return schema["~standard"][EVENT_ITERATOR_SCHEMA_SYMBOL];
|
|
146
229
|
}
|
|
147
230
|
|
|
148
|
-
// src/
|
|
149
|
-
function
|
|
150
|
-
return
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
231
|
+
// src/schema.ts
|
|
232
|
+
function type(...[map]) {
|
|
233
|
+
return {
|
|
234
|
+
"~standard": {
|
|
235
|
+
vendor: "custom",
|
|
236
|
+
version: 1,
|
|
237
|
+
async validate(value) {
|
|
238
|
+
if (map) {
|
|
239
|
+
return { value: await map(value) };
|
|
240
|
+
}
|
|
241
|
+
return { value };
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
};
|
|
160
245
|
}
|
|
161
246
|
|
|
162
247
|
// src/index.ts
|
|
163
|
-
|
|
248
|
+
import { ORPCError as ORPCError2 } from "@orpc/client";
|
|
164
249
|
export {
|
|
165
250
|
ContractBuilder,
|
|
166
251
|
ContractProcedure,
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
252
|
+
ORPCError2 as ORPCError,
|
|
253
|
+
ValidationError,
|
|
254
|
+
adaptContractRouter,
|
|
255
|
+
adaptRoute,
|
|
256
|
+
eventIterator,
|
|
257
|
+
fallbackContractConfig,
|
|
258
|
+
getEventIteratorSchemaDetails,
|
|
171
259
|
isContractProcedure,
|
|
260
|
+
mergeErrorMap,
|
|
261
|
+
mergeMeta,
|
|
262
|
+
mergePrefix,
|
|
263
|
+
mergeRoute,
|
|
264
|
+
mergeTags,
|
|
172
265
|
oc,
|
|
173
|
-
|
|
174
|
-
|
|
266
|
+
prefixRoute,
|
|
267
|
+
type,
|
|
268
|
+
unshiftTagRoute
|
|
175
269
|
};
|
|
176
270
|
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,38 @@
|
|
|
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
CHANGED
|
@@ -1,13 +1,32 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
output<USchema extends Schema>(schema: USchema, example?: SchemaOutput<USchema>): DecoratedContractProcedure<undefined, USchema>;
|
|
11
|
-
router<T extends ContractRouter>(router: T): T;
|
|
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> {
|
|
12
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, {}, {}>;
|
|
13
32
|
//# sourceMappingURL=builder.d.ts.map
|
|
@@ -0,0 +1,10 @@
|
|
|
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
|
|
@@ -0,0 +1,27 @@
|
|
|
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
|
|
@@ -0,0 +1,8 @@
|
|
|
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
CHANGED
|
@@ -1,10 +1,15 @@
|
|
|
1
1
|
/** unnoq */
|
|
2
|
-
import { ContractBuilder } from './builder';
|
|
3
2
|
export * from './builder';
|
|
4
|
-
export * from './
|
|
3
|
+
export * from './builder-variants';
|
|
4
|
+
export * from './config';
|
|
5
|
+
export * from './error';
|
|
6
|
+
export * from './event-iterator';
|
|
7
|
+
export * from './meta';
|
|
5
8
|
export * from './procedure';
|
|
9
|
+
export * from './procedure-client';
|
|
10
|
+
export * from './route';
|
|
6
11
|
export * from './router';
|
|
7
|
-
export * from './
|
|
8
|
-
export * from './
|
|
9
|
-
export
|
|
12
|
+
export * from './router-client';
|
|
13
|
+
export * from './schema';
|
|
14
|
+
export { ORPCError } from '@orpc/client';
|
|
10
15
|
//# sourceMappingURL=index.d.ts.map
|