@orpc/experimental-effect 2.0.0-beta.32 → 2.0.0-beta.34
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 +44 -29
- package/dist/extensions/effect.d.mts +8 -8
- package/dist/extensions/effect.d.ts +8 -8
- package/dist/extensions/effect.mjs +1 -1
- package/dist/index.d.mts +28 -5
- package/dist/index.d.ts +28 -5
- package/dist/index.mjs +24 -3
- package/dist/shared/{experimental-effect.BupPDCRJ.d.mts → experimental-effect.D0zFxpKr.d.mts} +12 -6
- package/dist/shared/{experimental-effect.BupPDCRJ.d.ts → experimental-effect.D0zFxpKr.d.ts} +12 -6
- package/dist/shared/{experimental-effect.C9oJcd5q.mjs → experimental-effect._sKLzweg.mjs} +1 -3
- package/package.json +6 -7
package/README.md
CHANGED
|
@@ -29,44 +29,54 @@ You can read the documentation [here](https://orpc.dev).
|
|
|
29
29
|
|
|
30
30
|
**Core**
|
|
31
31
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
32
|
+
| Package | Purpose | Docs |
|
|
33
|
+
| -------------------------------------------------------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
34
|
+
| [@orpc/contract](https://www.npmjs.com/package/@orpc/contract) | Define API contract as the single source of truth. | [Procedure Contract](https://orpc.dev/docs/contract/procedure), [Contract Router](https://orpc.dev/docs/contract/router), [Implementation](https://orpc.dev/docs/contract/implementation), [Generate from OpenAPI](https://orpc.dev/docs/contract/generate-from-openapi) |
|
|
35
|
+
| [@orpc/server](https://www.npmjs.com/package/@orpc/server) | Build APIs or implement contracts. | [Procedure](https://orpc.dev/docs/procedure), [Router](https://orpc.dev/docs/router), [Middleware](https://orpc.dev/docs/middleware), [Context](https://orpc.dev/docs/context), [RPC Handler](https://orpc.dev/docs/rpc/handler) |
|
|
36
|
+
| [@orpc/client](https://www.npmjs.com/package/@orpc/client) | Consume APIs with end-to-end type safety. | [Client-Side Clients](https://orpc.dev/docs/client/client-side), [Server-Side Clients](https://orpc.dev/docs/client/server-side), [RPC Link](https://orpc.dev/docs/rpc/link), [Error Handling](https://orpc.dev/docs/client/error-handling) |
|
|
37
|
+
| [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi) | Add OpenAPI compatibility to APIs. | [OpenAPI Handler](https://orpc.dev/docs/openapi/handler), [OpenAPI Link](https://orpc.dev/docs/openapi/link), [Specification](https://orpc.dev/docs/openapi/specification), [Scalar](https://orpc.dev/docs/openapi/scalar) |
|
|
36
38
|
|
|
37
39
|
**Schema validation**
|
|
38
40
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
41
|
+
| Package | Purpose | Docs |
|
|
42
|
+
| ------------------------------------------------------------ | ----------------------------------------------- | ----------------------------------------------------- |
|
|
43
|
+
| [@orpc/zod](https://www.npmjs.com/package/@orpc/zod) | Integrate with [Zod](https://zod.dev/). | [Zod](https://orpc.dev/docs/integrations/zod) |
|
|
44
|
+
| [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot) | Integrate with [Valibot](https://valibot.dev/). | [Valibot](https://orpc.dev/docs/integrations/valibot) |
|
|
45
|
+
| [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype) | Integrate with [ArkType](https://arktype.io/). | [ArkType](https://orpc.dev/docs/integrations/arktype) |
|
|
42
46
|
|
|
43
47
|
**Built-in features**
|
|
44
48
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
+
| Package | Purpose | Docs |
|
|
50
|
+
| -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
|
|
51
|
+
| [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher) | Pub/Sub with memory, Redis, and Upstash adapters. | [Publisher](https://orpc.dev/docs/helpers/publisher) |
|
|
52
|
+
| [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit) | Rate limiting with memory, Redis, and Upstash adapters. | [Rate Limit](https://orpc.dev/docs/helpers/ratelimit) |
|
|
53
|
+
| [@orpc/hibernation](https://www.npmjs.com/package/@orpc/hibernation) | Leverage Hibernation APIs like [Cloudflare's Hibernation WebSocket](https://developers.cloudflare.com/durable-objects/best-practices/websockets/#durable-objects-hibernation-websocket-api). | [Hibernation](https://orpc.dev/docs/integrations/hibernation) |
|
|
54
|
+
| [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema) | Smart coercion for OpenAPI requests. | [Smart Coercion](https://orpc.dev/docs/plugins/smart-coercion) |
|
|
49
55
|
|
|
50
56
|
**Framework & ecosystem integrations**
|
|
51
57
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
58
|
+
| Package | Purpose | Docs |
|
|
59
|
+
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
60
|
+
| [@orpc/next](https://www.npmjs.com/package/@orpc/next) | Integrate with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data). | [Next.js](https://orpc.dev/docs/integrations/next) |
|
|
61
|
+
| [@orpc/ai-sdk](https://www.npmjs.com/package/@orpc/ai-sdk) | Turn contracts and procedures into [AI SDK](https://ai-sdk.dev/) tools. | [AI SDK](https://orpc.dev/docs/integrations/ai-sdk) |
|
|
62
|
+
| [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query) | Integrate with [TanStack Query](https://tanstack.com/query/latest). | [TanStack Query](https://orpc.dev/docs/integrations/tanstack-query) |
|
|
63
|
+
| [@orpc/pinia-colada](https://www.npmjs.com/package/@orpc/pinia-colada) | Integrate with [Pinia Colada](https://pinia-colada.esm.dev/). | [Pinia Colada](https://orpc.dev/docs/integrations/pinia-colada) |
|
|
64
|
+
| [@orpc/swr](https://www.npmjs.com/package/@orpc/swr) | Integrate with [SWR](https://swr.vercel.app/). | [SWR](https://orpc.dev/docs/integrations/swr) |
|
|
65
|
+
| [@orpc/experimental-msw](https://www.npmjs.com/package/@orpc/experimental-msw) | Mock procedures with [Mock Service Worker](https://mswjs.io/). | [MSW](https://orpc.dev/docs/integrations/msw) |
|
|
66
|
+
| [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect) | Integrate with [Effect](https://effect.website/). | [Effect](https://orpc.dev/docs/integrations/effect) |
|
|
67
|
+
| [@orpc/nest](https://www.npmjs.com/package/@orpc/nest) | Implement your contract with [NestJS](https://nestjs.com/). | [NestJS](https://orpc.dev/docs/integrations/nest) |
|
|
68
|
+
| [@orpc/node](https://www.npmjs.com/package/@orpc/node) | [Node.js](https://nodejs.org/) plugins for static file serving and large uploads. | [Static File](https://orpc.dev/docs/plugins/static-file), [Tmp File Upload](https://orpc.dev/docs/plugins/tmp-file-upload), [Batch Response Compression](https://orpc.dev/docs/plugins/batch-response-compression) |
|
|
69
|
+
| [@orpc/bun](https://www.npmjs.com/package/@orpc/bun) | Adapters for [Bun's Redis](https://bun.sh/). | [Publisher](https://orpc.dev/docs/helpers/publisher), [Rate Limit](https://orpc.dev/docs/helpers/ratelimit) |
|
|
70
|
+
| [@orpc/cloudflare](https://www.npmjs.com/package/@orpc/cloudflare) | Adapters for [Cloudflare's RateLimit and Durable Objects](https://developers.cloudflare.com/workers/). | [Publisher](https://orpc.dev/docs/helpers/publisher), [Rate Limit](https://orpc.dev/docs/helpers/ratelimit) |
|
|
71
|
+
| [@orpc/trpc](https://www.npmjs.com/package/@orpc/trpc) | Reuse existing [tRPC](https://trpc.io/) routers within oRPC. | [tRPC](https://orpc.dev/docs/integrations/trpc) |
|
|
64
72
|
|
|
65
73
|
**Observability**
|
|
66
74
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
75
|
+
| Package | Purpose | Docs |
|
|
76
|
+
| ------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
|
77
|
+
| [@orpc/opentelemetry](https://www.npmjs.com/package/@orpc/opentelemetry) | Integrate with [OpenTelemetry](https://opentelemetry.io/) for distributed tracing. | [OpenTelemetry](https://orpc.dev/docs/integrations/opentelemetry) |
|
|
78
|
+
| [@orpc/pino](https://www.npmjs.com/package/@orpc/pino) | Integrate with [Pino](https://getpino.io/) for logging. | [Pino](https://orpc.dev/docs/integrations/pino) |
|
|
79
|
+
| [@orpc/evlog](https://www.npmjs.com/package/@orpc/evlog) | Integrate with [Evlog](https://evlog.dev/) for logging. | [Evlog](https://orpc.dev/docs/integrations/evlog) |
|
|
70
80
|
|
|
71
81
|
## Sponsors
|
|
72
82
|
|
|
@@ -76,6 +86,9 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
76
86
|
<tr>
|
|
77
87
|
<td width="2000"><a href="https://screenshotone.com/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener" title="The screenshot API for developers"><img src="https://avatars.githubusercontent.com/u/97035603?v=4" width="64" align="left" hspace="12" alt="ScreenshotOne.com"/><b>ScreenshotOne.com</b></a><br /><sub>The screenshot API for developers</sub></td>
|
|
78
88
|
</tr>
|
|
89
|
+
<tr>
|
|
90
|
+
<td width="2000"><a href="https://yuzu.health/careers?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="We're hiring NYC based engineers"><img src="https://avatars.githubusercontent.com/u/102488956?v=4" width="64" align="left" hspace="12" alt="Yuzu"/><b>Yuzu</b></a><br /><sub>We're hiring NYC based engineers</sub></td>
|
|
91
|
+
</tr>
|
|
79
92
|
<tr>
|
|
80
93
|
<td width="2000"><a href="https://misskey.io/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Decentralized microblogging SNS born on Earth"><img src="https://github.com/MisskeyIO.png" width="64" align="left" hspace="12" alt="MisskeyHQ"/><b>MisskeyHQ</b></a><br /><sub>Decentralized microblogging SNS born on Earth</sub></td>
|
|
81
94
|
</tr>
|
|
@@ -122,30 +135,32 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
122
135
|
<table>
|
|
123
136
|
<tr>
|
|
124
137
|
<td align="center"><a href="https://github.com/rhinodavid?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="David Walsh"><img src="https://avatars.githubusercontent.com/u/5778036?u=b5521f07d2f88c3db2a0dae62b5f2f8357214af0&v=4" width="119" alt="David Walsh"/><br />David Walsh</a></td>
|
|
138
|
+
<td align="center"><a href="https://github.com/IPv4Addr?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="IPv4Addr"><img src="https://avatars.githubusercontent.com/u/100147665?u=59996b72f69bb53063cb7e9ff8b8f898616cd94d&v=4" width="119" alt="IPv4Addr"/><br />IPv4Addr</a></td>
|
|
125
139
|
<td align="center"><a href="https://robbevaes.be/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Robbe Vaes"><img src="https://avatars.githubusercontent.com/u/44748019?u=e0232402c045ad4eac7cbd217f1f47e083103b89&v=4" width="119" alt="Robbe Vaes"/><br />Robbe Vaes</a></td>
|
|
126
140
|
<td align="center"><a href="https://github.com/aidansunbury?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Aidan Sunbury"><img src="https://avatars.githubusercontent.com/u/64103161?v=4" width="119" alt="Aidan Sunbury"/><br />Aidan Sunbury</a></td>
|
|
127
141
|
<td align="center"><a href="https://github.com/soonoo?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="soonoo"><img src="https://avatars.githubusercontent.com/u/5436405?u=5d0b4aa955c87e30e6bda7f0cccae5402da99528&v=4" width="119" alt="soonoo"/><br />soonoo</a></td>
|
|
128
142
|
<td align="center"><a href="https://kevinporten.dev/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Kevin Porten"><img src="https://avatars.githubusercontent.com/u/1839345?u=dc2263d5cfe0d927ce1a0be04a1d55dd6b55405c&v=4" width="119" alt="Kevin Porten"/><br />Kevin Porten</a></td>
|
|
129
143
|
<td align="center"><a href="https://github.com/pumpkinlink?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Denis"><img src="https://avatars.githubusercontent.com/u/11864620?u=5f47bbe6c65d0f6f5cf011021490238e4b0593d0&v=4" width="119" alt="Denis"/><br />Denis</a></td>
|
|
130
|
-
<td align="center"><a href="https://github.com/christopher-kapic?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Christopher Kapic"><img src="https://avatars.githubusercontent.com/u/59740769?u=e7ad4b72b5bf6c9eb1644c26dbf3332a8f987377&v=4" width="119" alt="Christopher Kapic"/><br />Christopher Kapic</a></td>
|
|
131
144
|
</tr>
|
|
132
145
|
<tr>
|
|
146
|
+
<td align="center"><a href="https://github.com/christopher-kapic?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Christopher Kapic"><img src="https://avatars.githubusercontent.com/u/59740769?u=e7ad4b72b5bf6c9eb1644c26dbf3332a8f987377&v=4" width="119" alt="Christopher Kapic"/><br />Christopher Kapic</a></td>
|
|
133
147
|
<td align="center"><a href="http://ballingt.com/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Tom Ballinger"><img src="https://avatars.githubusercontent.com/u/458879?u=4b045ac75d721b6ac2b42a74d7d37f61f0414031&v=4" width="119" alt="Tom Ballinger"/><br />Tom Ballinger</a></td>
|
|
134
148
|
<td align="center"><a href="https://lee-sam.com/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Sam"><img src="https://avatars.githubusercontent.com/u/102863520?u=3c89611f549d5070be232eb4532f690c8f2e7a65&v=4" width="119" alt="Sam"/><br />Sam</a></td>
|
|
135
149
|
<td align="center"><a href="https://github.com/Titoine?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Titoine"><img src="https://avatars.githubusercontent.com/u/3514286?u=1bb1e86b0c99c8a1121372e56d51a177eea12191&v=4" width="119" alt="Titoine"/><br />Titoine</a></td>
|
|
136
150
|
<td align="center"><a href="https://rigtch.fm/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Igor Makowski"><img src="https://avatars.githubusercontent.com/u/56691628?u=ee8c879478f7c151b9156aef6c74243fa3e247a8&v=4" width="119" alt="Igor Makowski"/><br />Igor Makowski</a></td>
|
|
137
151
|
<td align="center"><a href="https://blog.cwang.io/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="hanayashiki"><img src="https://avatars.githubusercontent.com/u/26056783?u=06c3b9205a16fd41a871e82da1cc2a09306d53f5&v=4" width="119" alt="hanayashiki"/><br />hanayashiki</a></td>
|
|
138
152
|
<td align="center"><a href="https://dubinets.io/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Lev Dubinets"><img src="https://avatars.githubusercontent.com/u/3114081?u=f547f5d5012cab54851f1b1ad72d10e537f78fc2&v=4" width="119" alt="Lev Dubinets"/><br />Lev Dubinets</a></td>
|
|
139
|
-
<td align="center"><a href="https://kellychan.im/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Kelly Peilin Chan"><img src="https://avatars.githubusercontent.com/u/520852?u=6b0f7105f694e7b5cacf410a3f04c7044b469dc8&v=4" width="119" alt="Kelly Peilin Chan"/><br />Kelly Peilin Chan</a></td>
|
|
140
153
|
</tr>
|
|
141
154
|
<tr>
|
|
155
|
+
<td align="center"><a href="https://kellychan.im/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Kelly Peilin Chan"><img src="https://avatars.githubusercontent.com/u/520852?u=6b0f7105f694e7b5cacf410a3f04c7044b469dc8&v=4" width="119" alt="Kelly Peilin Chan"/><br />Kelly Peilin Chan</a></td>
|
|
142
156
|
<td align="center"><a href="https://guyariely.com/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Guy Ariely"><img src="https://avatars.githubusercontent.com/u/42813496?u=edb6b7f563bf28e160a290832e7da57c0506f8ca&v=4" width="119" alt="Guy Ariely"/><br />Guy Ariely</a></td>
|
|
157
|
+
<td align="center"><a href="https://paulsenon.com/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="PaulSenon"><img src="https://avatars.githubusercontent.com/u/19531087?u=6385741eb91d200b8c513ec6045482e301767ca6&v=4" width="119" alt="PaulSenon"/><br />PaulSenon</a></td>
|
|
143
158
|
<td align="center"><a href="https://piscis.dev/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Alex"><img src="https://avatars.githubusercontent.com/u/326163?u=b245f368bd940cf51d08c0b6bf55f8257f359437&v=4" width="119" alt="Alex"/><br />Alex</a></td>
|
|
144
159
|
<td align="center"><a href="https://opensource.gubanov.eu/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Andrey Gubanov"><img src="https://avatars.githubusercontent.com/u/1082083?u=c5f2daf7ebece498e85c83367bb37b4e10e2649d&v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
|
|
145
160
|
</tr>
|
|
146
161
|
</table>
|
|
147
162
|
|
|
148
|
-
With thanks to [
|
|
163
|
+
With thanks to [36 past sponsors](https://htmlpreview.github.io/?https://github.com/middleapi/static/blob/main/sponsors.svg) who helped get oRPC here.
|
|
149
164
|
|
|
150
165
|
## References
|
|
151
166
|
|
|
@@ -1,25 +1,25 @@
|
|
|
1
1
|
import { ErrorMap, InferSchemaOutput, InitialInputSchema, Schema, AnySchema, InferSchemaInput } from '@orpc/contract';
|
|
2
|
-
import { Context, ORPCErrorConstructorMap, DecoratedProcedure,
|
|
2
|
+
import { Context, ORPCErrorConstructorMap, DecoratedProcedure, MergedContext, ImplementedProcedure } from '@orpc/server';
|
|
3
3
|
import { Effect } from 'effect';
|
|
4
|
-
import {
|
|
4
|
+
import { InferEffectServices, HandlerGen } from '../index.mjs';
|
|
5
5
|
|
|
6
6
|
declare module '@orpc/server' {
|
|
7
7
|
interface Builder<TInitialContext extends Context, TErrorMap extends ErrorMap> {
|
|
8
|
-
effect<TYield extends Effect.Effect<any, any, TInitialContext
|
|
8
|
+
effect<TYield extends Effect.Effect<any, any, InferEffectServices<TInitialContext>>, TReturn>(handler: HandlerGen<TInitialContext, InferSchemaOutput<InitialInputSchema>, TYield, TReturn, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, object, InitialInputSchema, Schema<TReturn>, TErrorMap>;
|
|
9
9
|
}
|
|
10
10
|
interface BuilderWithMiddlewares<TInitialContext extends Context, TInjectedContext extends Context, TErrorMap extends ErrorMap> {
|
|
11
|
-
effect<TYield extends Effect.Effect<any, any, MergedContext<TInitialContext, TInjectedContext
|
|
11
|
+
effect<TYield extends Effect.Effect<any, any, InferEffectServices<MergedContext<TInitialContext, TInjectedContext>>>, TReturn>(handler: HandlerGen<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<InitialInputSchema>, TYield, TReturn, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, InitialInputSchema, Schema<TReturn>, TErrorMap>;
|
|
12
12
|
}
|
|
13
13
|
interface BuilderWithInput<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
14
|
-
effect<TYield extends Effect.Effect<any, any, MergedContext<TInitialContext, TInjectedContext
|
|
14
|
+
effect<TYield extends Effect.Effect<any, any, InferEffectServices<MergedContext<TInitialContext, TInjectedContext>>>, TReturn>(handler: HandlerGen<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, TYield, TReturn, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, Schema<TReturn>, TErrorMap>;
|
|
15
15
|
}
|
|
16
16
|
interface BuilderWithOutput<TInitialContext extends Context, TInjectedContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
17
|
-
effect<TYield extends Effect.Effect<any, any, MergedContext<TInitialContext, TInjectedContext
|
|
17
|
+
effect<TYield extends Effect.Effect<any, any, InferEffectServices<MergedContext<TInitialContext, TInjectedContext>>>, TReturn extends InferSchemaInput<TOutputSchema>>(handler: HandlerGen<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<InitialInputSchema>, TYield, TReturn, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, InitialInputSchema, TOutputSchema, TErrorMap>;
|
|
18
18
|
}
|
|
19
19
|
interface BuilderWithInputOutput<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
20
|
-
effect<TYield extends Effect.Effect<any, any, MergedContext<TInitialContext, TInjectedContext
|
|
20
|
+
effect<TYield extends Effect.Effect<any, any, InferEffectServices<MergedContext<TInitialContext, TInjectedContext>>>, TReturn extends InferSchemaInput<TOutputSchema>>(handler: HandlerGen<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, TYield, TReturn, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
21
21
|
}
|
|
22
22
|
interface ProcedureImplementer<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
23
|
-
effect(handler: HandlerGen<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, Effect.Effect<any, any, MergedContext<TInitialContext, TInjectedContext
|
|
23
|
+
effect(handler: HandlerGen<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, Effect.Effect<any, any, InferEffectServices<MergedContext<TInitialContext, TInjectedContext>>>, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>>): ImplementedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
24
24
|
}
|
|
25
25
|
}
|
|
@@ -1,25 +1,25 @@
|
|
|
1
1
|
import { ErrorMap, InferSchemaOutput, InitialInputSchema, Schema, AnySchema, InferSchemaInput } from '@orpc/contract';
|
|
2
|
-
import { Context, ORPCErrorConstructorMap, DecoratedProcedure,
|
|
2
|
+
import { Context, ORPCErrorConstructorMap, DecoratedProcedure, MergedContext, ImplementedProcedure } from '@orpc/server';
|
|
3
3
|
import { Effect } from 'effect';
|
|
4
|
-
import {
|
|
4
|
+
import { InferEffectServices, HandlerGen } from '../index.js';
|
|
5
5
|
|
|
6
6
|
declare module '@orpc/server' {
|
|
7
7
|
interface Builder<TInitialContext extends Context, TErrorMap extends ErrorMap> {
|
|
8
|
-
effect<TYield extends Effect.Effect<any, any, TInitialContext
|
|
8
|
+
effect<TYield extends Effect.Effect<any, any, InferEffectServices<TInitialContext>>, TReturn>(handler: HandlerGen<TInitialContext, InferSchemaOutput<InitialInputSchema>, TYield, TReturn, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, object, InitialInputSchema, Schema<TReturn>, TErrorMap>;
|
|
9
9
|
}
|
|
10
10
|
interface BuilderWithMiddlewares<TInitialContext extends Context, TInjectedContext extends Context, TErrorMap extends ErrorMap> {
|
|
11
|
-
effect<TYield extends Effect.Effect<any, any, MergedContext<TInitialContext, TInjectedContext
|
|
11
|
+
effect<TYield extends Effect.Effect<any, any, InferEffectServices<MergedContext<TInitialContext, TInjectedContext>>>, TReturn>(handler: HandlerGen<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<InitialInputSchema>, TYield, TReturn, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, InitialInputSchema, Schema<TReturn>, TErrorMap>;
|
|
12
12
|
}
|
|
13
13
|
interface BuilderWithInput<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
14
|
-
effect<TYield extends Effect.Effect<any, any, MergedContext<TInitialContext, TInjectedContext
|
|
14
|
+
effect<TYield extends Effect.Effect<any, any, InferEffectServices<MergedContext<TInitialContext, TInjectedContext>>>, TReturn>(handler: HandlerGen<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, TYield, TReturn, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, Schema<TReturn>, TErrorMap>;
|
|
15
15
|
}
|
|
16
16
|
interface BuilderWithOutput<TInitialContext extends Context, TInjectedContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
17
|
-
effect<TYield extends Effect.Effect<any, any, MergedContext<TInitialContext, TInjectedContext
|
|
17
|
+
effect<TYield extends Effect.Effect<any, any, InferEffectServices<MergedContext<TInitialContext, TInjectedContext>>>, TReturn extends InferSchemaInput<TOutputSchema>>(handler: HandlerGen<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<InitialInputSchema>, TYield, TReturn, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, InitialInputSchema, TOutputSchema, TErrorMap>;
|
|
18
18
|
}
|
|
19
19
|
interface BuilderWithInputOutput<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
20
|
-
effect<TYield extends Effect.Effect<any, any, MergedContext<TInitialContext, TInjectedContext
|
|
20
|
+
effect<TYield extends Effect.Effect<any, any, InferEffectServices<MergedContext<TInitialContext, TInjectedContext>>>, TReturn extends InferSchemaInput<TOutputSchema>>(handler: HandlerGen<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, TYield, TReturn, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
21
21
|
}
|
|
22
22
|
interface ProcedureImplementer<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
23
|
-
effect(handler: HandlerGen<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, Effect.Effect<any, any, MergedContext<TInitialContext, TInjectedContext
|
|
23
|
+
effect(handler: HandlerGen<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, Effect.Effect<any, any, InferEffectServices<MergedContext<TInitialContext, TInjectedContext>>>, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>>): ImplementedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
24
24
|
}
|
|
25
25
|
}
|
package/dist/index.d.mts
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
import { AnyNestedClient, Client, ClientRest } from '@orpc/client';
|
|
2
2
|
import { Effect, Schema } from 'effect';
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
import { I as InferEffectServices } from './shared/experimental-effect.D0zFxpKr.mjs';
|
|
4
|
+
export { H as HandlerGen, a as InferYieldError, W as WithEffectContext, h as handlerGen } from './shared/experimental-effect.D0zFxpKr.mjs';
|
|
5
|
+
import { AnySchema, ErrorMap, Schema as Schema$1 } from '@orpc/contract';
|
|
5
6
|
import { JsonSchemaConverter, JsonSchemaConverterDirection, JsonSchema } from '@orpc/json-schema';
|
|
6
|
-
import { AnyORPCError, ORPCError, ORPCErrorCode } from '@orpc/server';
|
|
7
|
+
import { AnyORPCError, ORPCError, ORPCErrorCode, Context, ORPCErrorConstructorMap, MiddlewareOptions, MiddlewareNextOptions, MiddlewareResult, MiddlewareDone, Middleware } from '@orpc/server';
|
|
8
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
|
7
9
|
|
|
8
10
|
type EffectClient<T extends AnyNestedClient> = T extends Client<infer UContext, infer UInput, infer UOutput, infer UError> ? (...rest: ClientRest<UContext, UInput>) => Effect.Effect<UOutput, UError> : {
|
|
9
11
|
[K in keyof T]: T[K] extends AnyNestedClient ? EffectClient<T[K]> : never;
|
|
@@ -135,6 +137,27 @@ declare const catchORPCErrorCodes: {
|
|
|
135
137
|
}[keyof Cases]>;
|
|
136
138
|
};
|
|
137
139
|
|
|
140
|
+
interface MiddlewareGenNext<TOutput> {
|
|
141
|
+
<U extends Context = object>(...rest: MaybeOptionalOptions<MiddlewareNextOptions<U>>): Effect.Effect<Awaited<MiddlewareResult<U, TOutput>>, unknown>;
|
|
142
|
+
}
|
|
143
|
+
interface MiddlewareGenOptions<TInContext extends Context, TOutput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>> extends Omit<MiddlewareOptions<TInContext, TOutput, TErrorConstructorMap>, 'next'> {
|
|
144
|
+
next: MiddlewareGenNext<TOutput>;
|
|
145
|
+
}
|
|
146
|
+
interface MiddlewareGen<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TYield extends Effect.Effect<any, any, InferEffectServices<TInContext>>, TErrorConstructorMap extends ORPCErrorConstructorMap<any>> {
|
|
147
|
+
(opts: MiddlewareGenOptions<TInContext, TOutput, TErrorConstructorMap>, input: TInput, done: MiddlewareDone<TOutput>): Generator<TYield, MiddlewareResult<TOutContext, TOutput>, never>;
|
|
148
|
+
}
|
|
149
|
+
type AnyMiddlewareGen = MiddlewareGen<any, any, any, any, any, any>;
|
|
150
|
+
/**
|
|
151
|
+
* Creates an oRPC middleware from an Effect generator function.
|
|
152
|
+
* Inside the generator you can yield Effect operations and `yield* next()`
|
|
153
|
+
* to continue the chain, and `middlewareGen` handles the execution and
|
|
154
|
+
* error handling for you.
|
|
155
|
+
*
|
|
156
|
+
* @see {@link https://orpc.dev/docs/integrations/effect#effectful-middleware | Effect Integration - Effectful Middleware}
|
|
157
|
+
*/
|
|
158
|
+
declare function middlewareGen<TInContext extends Context, TOutContext extends Context = object, TInput = unknown, TOutput = any, // TOutput = any by default is important to make middleware can be used in any output by default
|
|
159
|
+
TErrorMap extends ErrorMap = Record<never, never>, TYield extends Effect.Effect<any, any, InferEffectServices<TInContext>> = Effect.Effect<any, any, InferEffectServices<TInContext>>>(middleware: MiddlewareGen<TInContext, TOutContext, TInput, TOutput, TYield, ORPCErrorConstructorMap<TErrorMap>>): Middleware<TInContext, TOutContext, TInput, TOutput, TErrorMap>;
|
|
160
|
+
|
|
138
161
|
interface RunPromiseOptions {
|
|
139
162
|
signal?: undefined | AbortSignal;
|
|
140
163
|
}
|
|
@@ -145,5 +168,5 @@ declare function runPromise<T>(effect: Effect.Effect<T, unknown>, options?: RunP
|
|
|
145
168
|
|
|
146
169
|
declare function toStandardSchema<S extends Schema.ConstraintDecoder<any>>(schema: S): Schema$1<S['Encoded'], S['Type']> & S;
|
|
147
170
|
|
|
148
|
-
export { EffectSchemaToJsonSchemaConverter, catchORPCError, catchORPCErrorCode, catchORPCErrorCodes, createEffectClient, runPromise, toStandardSchema };
|
|
149
|
-
export type { EffectClient, RunPromiseOptions };
|
|
171
|
+
export { EffectSchemaToJsonSchemaConverter, InferEffectServices, catchORPCError, catchORPCErrorCode, catchORPCErrorCodes, createEffectClient, middlewareGen, runPromise, toStandardSchema };
|
|
172
|
+
export type { AnyMiddlewareGen, EffectClient, MiddlewareGen, MiddlewareGenNext, MiddlewareGenOptions, RunPromiseOptions };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
import { AnyNestedClient, Client, ClientRest } from '@orpc/client';
|
|
2
2
|
import { Effect, Schema } from 'effect';
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
import { I as InferEffectServices } from './shared/experimental-effect.D0zFxpKr.js';
|
|
4
|
+
export { H as HandlerGen, a as InferYieldError, W as WithEffectContext, h as handlerGen } from './shared/experimental-effect.D0zFxpKr.js';
|
|
5
|
+
import { AnySchema, ErrorMap, Schema as Schema$1 } from '@orpc/contract';
|
|
5
6
|
import { JsonSchemaConverter, JsonSchemaConverterDirection, JsonSchema } from '@orpc/json-schema';
|
|
6
|
-
import { AnyORPCError, ORPCError, ORPCErrorCode } from '@orpc/server';
|
|
7
|
+
import { AnyORPCError, ORPCError, ORPCErrorCode, Context, ORPCErrorConstructorMap, MiddlewareOptions, MiddlewareNextOptions, MiddlewareResult, MiddlewareDone, Middleware } from '@orpc/server';
|
|
8
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
|
7
9
|
|
|
8
10
|
type EffectClient<T extends AnyNestedClient> = T extends Client<infer UContext, infer UInput, infer UOutput, infer UError> ? (...rest: ClientRest<UContext, UInput>) => Effect.Effect<UOutput, UError> : {
|
|
9
11
|
[K in keyof T]: T[K] extends AnyNestedClient ? EffectClient<T[K]> : never;
|
|
@@ -135,6 +137,27 @@ declare const catchORPCErrorCodes: {
|
|
|
135
137
|
}[keyof Cases]>;
|
|
136
138
|
};
|
|
137
139
|
|
|
140
|
+
interface MiddlewareGenNext<TOutput> {
|
|
141
|
+
<U extends Context = object>(...rest: MaybeOptionalOptions<MiddlewareNextOptions<U>>): Effect.Effect<Awaited<MiddlewareResult<U, TOutput>>, unknown>;
|
|
142
|
+
}
|
|
143
|
+
interface MiddlewareGenOptions<TInContext extends Context, TOutput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>> extends Omit<MiddlewareOptions<TInContext, TOutput, TErrorConstructorMap>, 'next'> {
|
|
144
|
+
next: MiddlewareGenNext<TOutput>;
|
|
145
|
+
}
|
|
146
|
+
interface MiddlewareGen<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TYield extends Effect.Effect<any, any, InferEffectServices<TInContext>>, TErrorConstructorMap extends ORPCErrorConstructorMap<any>> {
|
|
147
|
+
(opts: MiddlewareGenOptions<TInContext, TOutput, TErrorConstructorMap>, input: TInput, done: MiddlewareDone<TOutput>): Generator<TYield, MiddlewareResult<TOutContext, TOutput>, never>;
|
|
148
|
+
}
|
|
149
|
+
type AnyMiddlewareGen = MiddlewareGen<any, any, any, any, any, any>;
|
|
150
|
+
/**
|
|
151
|
+
* Creates an oRPC middleware from an Effect generator function.
|
|
152
|
+
* Inside the generator you can yield Effect operations and `yield* next()`
|
|
153
|
+
* to continue the chain, and `middlewareGen` handles the execution and
|
|
154
|
+
* error handling for you.
|
|
155
|
+
*
|
|
156
|
+
* @see {@link https://orpc.dev/docs/integrations/effect#effectful-middleware | Effect Integration - Effectful Middleware}
|
|
157
|
+
*/
|
|
158
|
+
declare function middlewareGen<TInContext extends Context, TOutContext extends Context = object, TInput = unknown, TOutput = any, // TOutput = any by default is important to make middleware can be used in any output by default
|
|
159
|
+
TErrorMap extends ErrorMap = Record<never, never>, TYield extends Effect.Effect<any, any, InferEffectServices<TInContext>> = Effect.Effect<any, any, InferEffectServices<TInContext>>>(middleware: MiddlewareGen<TInContext, TOutContext, TInput, TOutput, TYield, ORPCErrorConstructorMap<TErrorMap>>): Middleware<TInContext, TOutContext, TInput, TOutput, TErrorMap>;
|
|
160
|
+
|
|
138
161
|
interface RunPromiseOptions {
|
|
139
162
|
signal?: undefined | AbortSignal;
|
|
140
163
|
}
|
|
@@ -145,5 +168,5 @@ declare function runPromise<T>(effect: Effect.Effect<T, unknown>, options?: RunP
|
|
|
145
168
|
|
|
146
169
|
declare function toStandardSchema<S extends Schema.ConstraintDecoder<any>>(schema: S): Schema$1<S['Encoded'], S['Type']> & S;
|
|
147
170
|
|
|
148
|
-
export { EffectSchemaToJsonSchemaConverter, catchORPCError, catchORPCErrorCode, catchORPCErrorCodes, createEffectClient, runPromise, toStandardSchema };
|
|
149
|
-
export type { EffectClient, RunPromiseOptions };
|
|
171
|
+
export { EffectSchemaToJsonSchemaConverter, InferEffectServices, catchORPCError, catchORPCErrorCode, catchORPCErrorCodes, createEffectClient, middlewareGen, runPromise, toStandardSchema };
|
|
172
|
+
export type { AnyMiddlewareGen, EffectClient, MiddlewareGen, MiddlewareGenNext, MiddlewareGenOptions, RunPromiseOptions };
|
package/dist/index.mjs
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import { RECURSIVE_CLIENT_UNWRAP_KEYS, resolveClientRest } from '@orpc/client';
|
|
2
2
|
import { isTypescriptObject, anyAbortSignal, getOwn } from '@orpc/shared';
|
|
3
|
-
import { Effect, Schema, Function } from 'effect';
|
|
3
|
+
import { Effect, Schema, Function, Context } from 'effect';
|
|
4
4
|
import { StandardJsonSchemaConverter } from '@orpc/json-schema';
|
|
5
5
|
import { ORPCError } from '@orpc/server';
|
|
6
|
-
|
|
6
|
+
import { r as runPromise } from './shared/experimental-effect._sKLzweg.mjs';
|
|
7
|
+
export { h as handlerGen } from './shared/experimental-effect._sKLzweg.mjs';
|
|
7
8
|
export { t as toStandardSchema } from './shared/experimental-effect.YQKompVf.mjs';
|
|
8
9
|
import '@orpc/contract';
|
|
9
10
|
|
|
@@ -73,4 +74,24 @@ const catchORPCErrorCodes = Function.dual(
|
|
|
73
74
|
)
|
|
74
75
|
);
|
|
75
76
|
|
|
76
|
-
|
|
77
|
+
function middlewareGen(middleware) {
|
|
78
|
+
const mid = (opts, input, done) => {
|
|
79
|
+
const next = (...rest) => Effect.tryPromise({
|
|
80
|
+
try: async () => opts.next(...rest),
|
|
81
|
+
catch: (error) => error
|
|
82
|
+
});
|
|
83
|
+
let ef = Effect.gen(() => middleware({ ...opts, next }, input, done));
|
|
84
|
+
if (Context.isContext(opts.context["effect/context"])) {
|
|
85
|
+
ef = ef.pipe(Effect.provide(opts.context["effect/context"]));
|
|
86
|
+
}
|
|
87
|
+
if (typeof opts.context["effect/wrap"] === "function") {
|
|
88
|
+
const intercept = opts.context["effect/wrap"];
|
|
89
|
+
ef = intercept(ef, opts);
|
|
90
|
+
}
|
|
91
|
+
return runPromise(ef, { signal: opts.signal });
|
|
92
|
+
};
|
|
93
|
+
Object.defineProperty(mid, "name", { value: middleware.name });
|
|
94
|
+
return mid;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
export { EffectSchemaToJsonSchemaConverter, catchORPCError, catchORPCErrorCode, catchORPCErrorCodes, createEffectClient, middlewareGen, runPromise };
|
package/dist/shared/{experimental-effect.BupPDCRJ.d.mts → experimental-effect.D0zFxpKr.d.mts}
RENAMED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { Context, Effect } from 'effect';
|
|
1
|
+
import { Context, AnyProcedure, ORPCErrorConstructorMap, ProcedureHandlerOptions, ProcedureHandler } from '@orpc/server';
|
|
2
|
+
import { Context as Context$1, Effect } from 'effect';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* A context shape that provides Effect services to effectful handlers
|
|
@@ -25,7 +25,7 @@ interface WithEffectContext<Services> {
|
|
|
25
25
|
* }
|
|
26
26
|
* ```
|
|
27
27
|
*/
|
|
28
|
-
['effect/context']: Context.Context<Services>;
|
|
28
|
+
['effect/context']: Context$1.Context<Services>;
|
|
29
29
|
/**
|
|
30
30
|
* An optional hook to wrap any effect before it is executed within this oRPC context.
|
|
31
31
|
* Useful for adding observability, tracing, or error handling.
|
|
@@ -53,9 +53,15 @@ interface WithEffectContext<Services> {
|
|
|
53
53
|
signal?: undefined | AbortSignal;
|
|
54
54
|
}) => Effect.Effect<A, E>;
|
|
55
55
|
}
|
|
56
|
+
/**
|
|
57
|
+
* Infers the Effect services available in an oRPC context that extends `WithEffectContext`.
|
|
58
|
+
*
|
|
59
|
+
* @see {@link https://orpc.dev/docs/integrations/effect#effect-services | Effect Integration - Effect Services}
|
|
60
|
+
*/
|
|
61
|
+
type InferEffectServices<T extends Context> = T extends WithEffectContext<infer Services> ? Services : never;
|
|
56
62
|
|
|
57
63
|
type InferYieldError<Eff> = [Eff] extends [never] ? never : [Eff] extends [Effect.Effect<infer _A, infer E, infer _R>] ? E : never;
|
|
58
|
-
interface HandlerGen<TCurrentContext extends Context
|
|
64
|
+
interface HandlerGen<TCurrentContext extends Context, TInput, TYield extends Effect.Effect<any, any, InferEffectServices<TCurrentContext>>, TReturn, TErrorConstructorMap extends ORPCErrorConstructorMap<any>> {
|
|
59
65
|
(opts: ProcedureHandlerOptions<TCurrentContext, TInput, TErrorConstructorMap>, input: TInput): Generator<TYield, TReturn, never>;
|
|
60
66
|
}
|
|
61
67
|
/**
|
|
@@ -65,7 +71,7 @@ interface HandlerGen<TCurrentContext extends Context$1, TInput, TYield extends E
|
|
|
65
71
|
*
|
|
66
72
|
* @see {@link https://orpc.dev/docs/integrations/effect#effectful-handlers | Effect Integration - Effectful Handlers}
|
|
67
73
|
*/
|
|
68
|
-
declare function handlerGen<TCurrentContext extends Context
|
|
74
|
+
declare function handlerGen<TCurrentContext extends Context, TInput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>, TYield extends Effect.Effect<any, any, InferEffectServices<TCurrentContext>>, TReturn>(handler: HandlerGen<TCurrentContext, TInput, TYield, TReturn, TErrorConstructorMap>): ProcedureHandler<TCurrentContext, TInput, TReturn, TErrorConstructorMap>;
|
|
69
75
|
|
|
70
76
|
export { handlerGen as h };
|
|
71
|
-
export type { HandlerGen as H,
|
|
77
|
+
export type { HandlerGen as H, InferEffectServices as I, WithEffectContext as W, InferYieldError as a };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { Context, Effect } from 'effect';
|
|
1
|
+
import { Context, AnyProcedure, ORPCErrorConstructorMap, ProcedureHandlerOptions, ProcedureHandler } from '@orpc/server';
|
|
2
|
+
import { Context as Context$1, Effect } from 'effect';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* A context shape that provides Effect services to effectful handlers
|
|
@@ -25,7 +25,7 @@ interface WithEffectContext<Services> {
|
|
|
25
25
|
* }
|
|
26
26
|
* ```
|
|
27
27
|
*/
|
|
28
|
-
['effect/context']: Context.Context<Services>;
|
|
28
|
+
['effect/context']: Context$1.Context<Services>;
|
|
29
29
|
/**
|
|
30
30
|
* An optional hook to wrap any effect before it is executed within this oRPC context.
|
|
31
31
|
* Useful for adding observability, tracing, or error handling.
|
|
@@ -53,9 +53,15 @@ interface WithEffectContext<Services> {
|
|
|
53
53
|
signal?: undefined | AbortSignal;
|
|
54
54
|
}) => Effect.Effect<A, E>;
|
|
55
55
|
}
|
|
56
|
+
/**
|
|
57
|
+
* Infers the Effect services available in an oRPC context that extends `WithEffectContext`.
|
|
58
|
+
*
|
|
59
|
+
* @see {@link https://orpc.dev/docs/integrations/effect#effect-services | Effect Integration - Effect Services}
|
|
60
|
+
*/
|
|
61
|
+
type InferEffectServices<T extends Context> = T extends WithEffectContext<infer Services> ? Services : never;
|
|
56
62
|
|
|
57
63
|
type InferYieldError<Eff> = [Eff] extends [never] ? never : [Eff] extends [Effect.Effect<infer _A, infer E, infer _R>] ? E : never;
|
|
58
|
-
interface HandlerGen<TCurrentContext extends Context
|
|
64
|
+
interface HandlerGen<TCurrentContext extends Context, TInput, TYield extends Effect.Effect<any, any, InferEffectServices<TCurrentContext>>, TReturn, TErrorConstructorMap extends ORPCErrorConstructorMap<any>> {
|
|
59
65
|
(opts: ProcedureHandlerOptions<TCurrentContext, TInput, TErrorConstructorMap>, input: TInput): Generator<TYield, TReturn, never>;
|
|
60
66
|
}
|
|
61
67
|
/**
|
|
@@ -65,7 +71,7 @@ interface HandlerGen<TCurrentContext extends Context$1, TInput, TYield extends E
|
|
|
65
71
|
*
|
|
66
72
|
* @see {@link https://orpc.dev/docs/integrations/effect#effectful-handlers | Effect Integration - Effectful Handlers}
|
|
67
73
|
*/
|
|
68
|
-
declare function handlerGen<TCurrentContext extends Context
|
|
74
|
+
declare function handlerGen<TCurrentContext extends Context, TInput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>, TYield extends Effect.Effect<any, any, InferEffectServices<TCurrentContext>>, TReturn>(handler: HandlerGen<TCurrentContext, TInput, TYield, TReturn, TErrorConstructorMap>): ProcedureHandler<TCurrentContext, TInput, TReturn, TErrorConstructorMap>;
|
|
69
75
|
|
|
70
76
|
export { handlerGen as h };
|
|
71
|
-
export type { HandlerGen as H,
|
|
77
|
+
export type { HandlerGen as H, InferEffectServices as I, WithEffectContext as W, InferYieldError as a };
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { ORPCError } from '@orpc/server';
|
|
2
1
|
import { Effect, Exit, Cause, Context } from 'effect';
|
|
3
2
|
import { AbortError } from '@orpc/shared';
|
|
4
3
|
|
|
@@ -16,10 +15,9 @@ async function runPromise(effect, options = {}) {
|
|
|
16
15
|
throw Cause.squash(exit.cause);
|
|
17
16
|
}
|
|
18
17
|
|
|
19
|
-
const succeedOnORPCError = Effect.catch((error) => error instanceof ORPCError ? Effect.succeed(error) : Effect.fail(error));
|
|
20
18
|
function handlerGen(handler) {
|
|
21
19
|
return (opts, input) => {
|
|
22
|
-
let ef = Effect.gen(() => handler(opts, input))
|
|
20
|
+
let ef = Effect.gen(() => handler(opts, input));
|
|
23
21
|
if (Context.isContext(opts.context["effect/context"])) {
|
|
24
22
|
ef = ef.pipe(Effect.provide(opts.context["effect/context"]));
|
|
25
23
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/experimental-effect",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "2.0.0-beta.
|
|
4
|
+
"version": "2.0.0-beta.34",
|
|
5
5
|
"description": "Effect integration for oRPC: build typesafe procedures with Effect",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"funding": [
|
|
@@ -51,17 +51,16 @@
|
|
|
51
51
|
"effect": ">=4.0.0-beta.90"
|
|
52
52
|
},
|
|
53
53
|
"dependencies": {
|
|
54
|
-
"@orpc/client": "2.0.0-beta.
|
|
55
|
-
"@orpc/contract": "2.0.0-beta.
|
|
56
|
-
"@orpc/json-schema": "2.0.0-beta.
|
|
57
|
-
"@orpc/server": "2.0.0-beta.
|
|
58
|
-
"@orpc/shared": "2.0.0-beta.
|
|
54
|
+
"@orpc/client": "2.0.0-beta.34",
|
|
55
|
+
"@orpc/contract": "2.0.0-beta.34",
|
|
56
|
+
"@orpc/json-schema": "2.0.0-beta.34",
|
|
57
|
+
"@orpc/server": "2.0.0-beta.34",
|
|
58
|
+
"@orpc/shared": "2.0.0-beta.34"
|
|
59
59
|
},
|
|
60
60
|
"devDependencies": {
|
|
61
61
|
"effect": "4.0.0-rc.112"
|
|
62
62
|
},
|
|
63
63
|
"scripts": {
|
|
64
|
-
"build": "unbuild",
|
|
65
64
|
"type:check": "tsc -b"
|
|
66
65
|
}
|
|
67
66
|
}
|