@orpc/experimental-effect 2.0.0-beta.23 → 2.0.0-beta.25

package/README.md

@@ -44,6 +44,7 @@ You can read the documentation [here](https://orpc.dev).
 
 - [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub with memory, Redis, and Upstash adapters.
 - [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting with memory, Redis, and Upstash adapters.
+- [@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).
 - [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
 
 **Framework & ecosystem integrations**
@@ -114,6 +115,7 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
   </tr>
   <tr>
    <td align="center"><a href="https://github.com/itigoore01?ref=orpc" target="_blank" rel="noopener" title="shota"><img src="https://avatars.githubusercontent.com/u/11831107?u=c976a6dc7e055eb026304c46c99100ed22b0c8e0&amp;v=4" width="139" alt="shota"/><br />shota</a></td>
+   <td align="center"><a href="https://github.com/ellis-driscoll?ref=orpc" target="_blank" rel="noopener" title="Ellis Driscoll"><img src="https://avatars.githubusercontent.com/u/70685966?u=c5f95bc33b5991d9744abe00052542e4a2ed3cb9&amp;v=4" width="139" alt="Ellis Driscoll"/><br />Ellis Driscoll</a></td>
   </tr>
 </table>
 
@@ -139,8 +141,9 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
    <td align="center"><a href="https://github.com/mr-kelly?ref=orpc" target="_blank" rel="noopener" title="Kelly Peilin Chan"><img src="https://avatars.githubusercontent.com/u/520852?u=6b0f7105f694e7b5cacf410a3f04c7044b469dc8&amp;v=4" width="119" alt="Kelly Peilin Chan"/><br />Kelly Peilin Chan</a></td>
   </tr>
   <tr>
+   <td align="center"><a href="https://github.com/guyariely?ref=orpc" target="_blank" rel="noopener" title="Guy Ariely"><img src="https://avatars.githubusercontent.com/u/42813496?u=edb6b7f563bf28e160a290832e7da57c0506f8ca&amp;v=4" width="119" alt="Guy Ariely"/><br />Guy Ariely</a></td>
    <td align="center"><a href="https://github.com/piscis?ref=orpc" target="_blank" rel="noopener" title="Alex"><img src="https://avatars.githubusercontent.com/u/326163?u=b245f368bd940cf51d08c0b6bf55f8257f359437&amp;v=4" width="119" alt="Alex"/><br />Alex</a></td>
-   <td align="center"><a href="https://github.com/finom?ref=orpc" target="_blank" rel="noopener" title="Andrey Gubanov"><img src="https://avatars.githubusercontent.com/u/1082083?u=29e91400dbd4a9c217048a8f59562c4f740498e6&amp;v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
+   <td align="center"><a href="https://github.com/finom?ref=orpc" target="_blank" rel="noopener" title="Andrey Gubanov"><img src="https://avatars.githubusercontent.com/u/1082083?u=c5f2daf7ebece498e85c83367bb37b4e10e2649d&amp;v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
   </tr>
 </table>
 

package/dist/extensions/effect.d.mts

@@ -1,7 +1,7 @@
 import { ErrorMap, InferSchemaOutput, InitialInputSchema, Schema, AnySchema, InferSchemaInput } from '@orpc/contract';
 import { Context, ORPCErrorConstructorMap, DecoratedProcedure, AnyORPCError, MergedContext, ImplementedProcedure } from '@orpc/server';
 import { Effect } from 'effect';
-import { W as WithEffectContext, H as HandlerGen, I as InferYieldError } from '../shared/experimental-effect.Cw48Xdc-.mjs';
+import { W as WithEffectContext, H as HandlerGen, I as InferYieldError } from '../shared/experimental-effect.BupPDCRJ.mjs';
 
 declare module '@orpc/server' {
     interface Builder<TInitialContext extends Context, TErrorMap extends ErrorMap> {

package/dist/extensions/effect.d.ts

@@ -1,7 +1,7 @@
 import { ErrorMap, InferSchemaOutput, InitialInputSchema, Schema, AnySchema, InferSchemaInput } from '@orpc/contract';
 import { Context, ORPCErrorConstructorMap, DecoratedProcedure, AnyORPCError, MergedContext, ImplementedProcedure } from '@orpc/server';
 import { Effect } from 'effect';
-import { W as WithEffectContext, H as HandlerGen, I as InferYieldError } from '../shared/experimental-effect.Cw48Xdc-.js';
+import { W as WithEffectContext, H as HandlerGen, I as InferYieldError } from '../shared/experimental-effect.BupPDCRJ.js';
 
 declare module '@orpc/server' {
     interface Builder<TInitialContext extends Context, TErrorMap extends ErrorMap> {

package/dist/index.d.mts

@@ -1,15 +1,121 @@
-export { H as HandlerGen, I as InferYieldError, W as WithEffectContext, h as handlerGen } from './shared/experimental-effect.Cw48Xdc-.mjs';
+export { H as HandlerGen, I as InferYieldError, W as WithEffectContext, h as handlerGen } from './shared/experimental-effect.BupPDCRJ.mjs';
 import { AnySchema, Schema as Schema$1 } from '@orpc/contract';
 import { JsonSchemaConverter, JsonSchemaConverterDirection, JsonSchema } from '@orpc/json-schema';
+import { AnyORPCError, ORPCError, ORPCErrorCode } from '@orpc/server';
 import { Effect, Schema } from 'effect';
-import '@orpc/server';
 
+/**
+ * A JSON Schema converter for Effect Schema, built on top of
+ * [Effect Schema to JSON Schema](https://effect.website/docs/schema/json-schema/).
+ * Useful with tools such as the OpenAPI Generator.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/effect#json-schema-converter | Effect Integration - JSON Schema Converter}
+ */
 declare class EffectSchemaToJsonSchemaConverter implements JsonSchemaConverter {
     private readonly converter;
     condition(schema: AnySchema | undefined, _direction: JsonSchemaConverterDirection): boolean;
     convert(schema: AnySchema | undefined, direction: JsonSchemaConverterDirection): [jsonSchema: JsonSchema, optional: boolean];
 }
 
+/**
+ * Recovers from `ORPCError` failures in the error channel of an effect.
+ * Other failures re-fail with their original cause.
+ *
+ * Supports both data-first `catchORPCError(effect, handler)` and data-last
+ * `effect.pipe(catchORPCError(handler))` styles.
+ *
+ * @example
+ * ```ts
+ * declare const program: Effect.Effect<string, ORPCError<'NOT_FOUND', undefined> | TypeError>
+ *
+ * const recovered = program.pipe(
+ *   catchORPCError(error => Effect.succeed(`caught ${error.code}`)),
+ * )
+ * ```
+ *
+ * @see {@link https://orpc.dev/docs/integrations/effect#catching-orpcerrors | Effect Integration - Catching ORPCErrors}
+ */
+declare const catchORPCError: {
+    <E, A2, E2, R2>(f: (error: Extract<E, AnyORPCError>) => Effect.Effect<A2, E2, R2>): <A, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A | A2, E2 | Exclude<E, AnyORPCError>, R | R2>;
+    <A, E, R, A2, E2, R2>(self: Effect.Effect<A, E, R>, f: (error: Extract<E, AnyORPCError>) => Effect.Effect<A2, E2, R2>): Effect.Effect<A | A2, E2 | Exclude<E, AnyORPCError>, R | R2>;
+};
+/**
+ * Recovers from `ORPCError` failures with a matching code in the error channel of an effect.
+ * Other failures re-fail with their original cause. The `code` argument is
+ * suggested and restricted to the codes present in the error channel.
+ *
+ * Supports both data-first `catchORPCErrorCode(effect, code, handler)` and
+ * data-last `effect.pipe(catchORPCErrorCode(code, handler))` styles.
+ *
+ * @example
+ * ```ts
+ * declare const program: Effect.Effect<
+ *   string,
+ *   ORPCError<'NOT_FOUND', { id: string }> | ORPCError<'CONFLICT', undefined> | TypeError
+ * >
+ *
+ * const recovered = program.pipe(
+ *   catchORPCErrorCode('NOT_FOUND', error => Effect.succeed(error.data.id)),
+ * )
+ * ```
+ *
+ * @see {@link https://orpc.dev/docs/integrations/effect#catching-orpcerrors | Effect Integration - Catching ORPCErrors}
+ */
+declare const catchORPCErrorCode: {
+    <const TCode extends E extends ORPCError<infer TCode, any> ? TCode : never, E, A2, E2, R2>(code: TCode, f: (error: Extract<E, ORPCError<TCode, any>>) => Effect.Effect<A2, E2, R2>): <A, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A | A2, E2 | Exclude<E, ORPCError<TCode, any>>, R | R2>;
+    <A, E, R, const TCode extends E extends ORPCError<infer TCode, any> ? TCode : never, A2, E2, R2>(self: Effect.Effect<A, E, R>, code: TCode, f: (error: Extract<E, ORPCError<TCode, any>>) => Effect.Effect<A2, E2, R2>): Effect.Effect<A | A2, E2 | Exclude<E, ORPCError<TCode, any>>, R | R2>;
+};
+/**
+ * Recovers from `ORPCError` failures using a map of codes to handlers in the
+ * error channel of an effect. Other failures re-fail with their original
+ * cause. The keys are suggested and restricted to the codes present in the
+ * error channel.
+ *
+ * Supports both data-first `catchORPCErrorCodes(effect, cases)` and data-last
+ * `effect.pipe(catchORPCErrorCodes(cases))` styles.
+ *
+ * @example
+ * ```ts
+ * declare const program: Effect.Effect<
+ *   string,
+ *   ORPCError<'NOT_FOUND', { id: string }> | ORPCError<'CONFLICT', undefined> | TypeError
+ * >
+ *
+ * const recovered = program.pipe(
+ *   catchORPCErrorCodes({
+ *     NOT_FOUND: error => Effect.succeed(error.data.id),
+ *     CONFLICT: error => Effect.succeed(error.message),
+ *   }),
+ * )
+ * ```
+ *
+ * @see {@link https://orpc.dev/docs/integrations/effect#catching-orpcerrors | Effect Integration - Catching ORPCErrors}
+ */
+declare const catchORPCErrorCodes: {
+    <E, Cases extends {
+        [K in Extract<E, AnyORPCError>['code']]?: (error: Extract<E, ORPCError<K, any>>) => Effect.Effect<any, any, any>;
+    } & (unknown extends E ? object : {
+        [K in Exclude<keyof Cases, Extract<E, AnyORPCError>['code']>]: never;
+    })>(cases: Cases): <A, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A | {
+        [K in keyof Cases]: Cases[K] extends (...args: any[]) => Effect.Effect<infer A2, any, any> ? A2 : never;
+    }[keyof Cases], Exclude<E, ORPCError<keyof Cases & ORPCErrorCode, any>> | {
+        [K in keyof Cases]: Cases[K] extends (...args: any[]) => Effect.Effect<any, infer E2, any> ? E2 : never;
+    }[keyof Cases], R | {
+        [K in keyof Cases]: Cases[K] extends (...args: any[]) => Effect.Effect<any, any, infer R2> ? R2 : never;
+    }[keyof Cases]>;
+    <A, E, R, Cases extends {
+        [K in Extract<E, AnyORPCError>['code']]?: (error: Extract<E, ORPCError<K, any>>) => Effect.Effect<any, any, any>;
+    } & (unknown extends E ? object : {
+        [K in Exclude<keyof Cases, Extract<E, AnyORPCError>['code']>]: never;
+    })>(self: Effect.Effect<A, E, R>, cases: Cases): Effect.Effect<A | {
+        [K in keyof Cases]: Cases[K] extends (...args: any[]) => Effect.Effect<infer A2, any, any> ? A2 : never;
+    }[keyof Cases], Exclude<E, ORPCError<keyof Cases & ORPCErrorCode, any>> | {
+        [K in keyof Cases]: Cases[K] extends (...args: any[]) => Effect.Effect<any, infer E2, any> ? E2 : never;
+    }[keyof Cases], R | {
+        [K in keyof Cases]: Cases[K] extends (...args: any[]) => Effect.Effect<any, any, infer R2> ? R2 : never;
+    }[keyof Cases]>;
+};
+
 interface RunPromiseOptions {
     signal?: undefined | AbortSignal;
 }
@@ -20,5 +126,5 @@ declare function runPromise<T>(effect: Effect.Effect<T, unknown>, options?: RunP
 
 declare function toStandardSchema<S extends Schema.ConstraintDecoder<any>>(schema: S): Schema$1<S['Encoded'], S['Type']> & S;
 
-export { EffectSchemaToJsonSchemaConverter, runPromise, toStandardSchema };
+export { EffectSchemaToJsonSchemaConverter, catchORPCError, catchORPCErrorCode, catchORPCErrorCodes, runPromise, toStandardSchema };
 export type { RunPromiseOptions };

package/dist/index.d.ts

@@ -1,15 +1,121 @@
-export { H as HandlerGen, I as InferYieldError, W as WithEffectContext, h as handlerGen } from './shared/experimental-effect.Cw48Xdc-.js';
+export { H as HandlerGen, I as InferYieldError, W as WithEffectContext, h as handlerGen } from './shared/experimental-effect.BupPDCRJ.js';
 import { AnySchema, Schema as Schema$1 } from '@orpc/contract';
 import { JsonSchemaConverter, JsonSchemaConverterDirection, JsonSchema } from '@orpc/json-schema';
+import { AnyORPCError, ORPCError, ORPCErrorCode } from '@orpc/server';
 import { Effect, Schema } from 'effect';
-import '@orpc/server';
 
+/**
+ * A JSON Schema converter for Effect Schema, built on top of
+ * [Effect Schema to JSON Schema](https://effect.website/docs/schema/json-schema/).
+ * Useful with tools such as the OpenAPI Generator.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/effect#json-schema-converter | Effect Integration - JSON Schema Converter}
+ */
 declare class EffectSchemaToJsonSchemaConverter implements JsonSchemaConverter {
     private readonly converter;
     condition(schema: AnySchema | undefined, _direction: JsonSchemaConverterDirection): boolean;
     convert(schema: AnySchema | undefined, direction: JsonSchemaConverterDirection): [jsonSchema: JsonSchema, optional: boolean];
 }
 
+/**
+ * Recovers from `ORPCError` failures in the error channel of an effect.
+ * Other failures re-fail with their original cause.
+ *
+ * Supports both data-first `catchORPCError(effect, handler)` and data-last
+ * `effect.pipe(catchORPCError(handler))` styles.
+ *
+ * @example
+ * ```ts
+ * declare const program: Effect.Effect<string, ORPCError<'NOT_FOUND', undefined> | TypeError>
+ *
+ * const recovered = program.pipe(
+ *   catchORPCError(error => Effect.succeed(`caught ${error.code}`)),
+ * )
+ * ```
+ *
+ * @see {@link https://orpc.dev/docs/integrations/effect#catching-orpcerrors | Effect Integration - Catching ORPCErrors}
+ */
+declare const catchORPCError: {
+    <E, A2, E2, R2>(f: (error: Extract<E, AnyORPCError>) => Effect.Effect<A2, E2, R2>): <A, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A | A2, E2 | Exclude<E, AnyORPCError>, R | R2>;
+    <A, E, R, A2, E2, R2>(self: Effect.Effect<A, E, R>, f: (error: Extract<E, AnyORPCError>) => Effect.Effect<A2, E2, R2>): Effect.Effect<A | A2, E2 | Exclude<E, AnyORPCError>, R | R2>;
+};
+/**
+ * Recovers from `ORPCError` failures with a matching code in the error channel of an effect.
+ * Other failures re-fail with their original cause. The `code` argument is
+ * suggested and restricted to the codes present in the error channel.
+ *
+ * Supports both data-first `catchORPCErrorCode(effect, code, handler)` and
+ * data-last `effect.pipe(catchORPCErrorCode(code, handler))` styles.
+ *
+ * @example
+ * ```ts
+ * declare const program: Effect.Effect<
+ *   string,
+ *   ORPCError<'NOT_FOUND', { id: string }> | ORPCError<'CONFLICT', undefined> | TypeError
+ * >
+ *
+ * const recovered = program.pipe(
+ *   catchORPCErrorCode('NOT_FOUND', error => Effect.succeed(error.data.id)),
+ * )
+ * ```
+ *
+ * @see {@link https://orpc.dev/docs/integrations/effect#catching-orpcerrors | Effect Integration - Catching ORPCErrors}
+ */
+declare const catchORPCErrorCode: {
+    <const TCode extends E extends ORPCError<infer TCode, any> ? TCode : never, E, A2, E2, R2>(code: TCode, f: (error: Extract<E, ORPCError<TCode, any>>) => Effect.Effect<A2, E2, R2>): <A, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A | A2, E2 | Exclude<E, ORPCError<TCode, any>>, R | R2>;
+    <A, E, R, const TCode extends E extends ORPCError<infer TCode, any> ? TCode : never, A2, E2, R2>(self: Effect.Effect<A, E, R>, code: TCode, f: (error: Extract<E, ORPCError<TCode, any>>) => Effect.Effect<A2, E2, R2>): Effect.Effect<A | A2, E2 | Exclude<E, ORPCError<TCode, any>>, R | R2>;
+};
+/**
+ * Recovers from `ORPCError` failures using a map of codes to handlers in the
+ * error channel of an effect. Other failures re-fail with their original
+ * cause. The keys are suggested and restricted to the codes present in the
+ * error channel.
+ *
+ * Supports both data-first `catchORPCErrorCodes(effect, cases)` and data-last
+ * `effect.pipe(catchORPCErrorCodes(cases))` styles.
+ *
+ * @example
+ * ```ts
+ * declare const program: Effect.Effect<
+ *   string,
+ *   ORPCError<'NOT_FOUND', { id: string }> | ORPCError<'CONFLICT', undefined> | TypeError
+ * >
+ *
+ * const recovered = program.pipe(
+ *   catchORPCErrorCodes({
+ *     NOT_FOUND: error => Effect.succeed(error.data.id),
+ *     CONFLICT: error => Effect.succeed(error.message),
+ *   }),
+ * )
+ * ```
+ *
+ * @see {@link https://orpc.dev/docs/integrations/effect#catching-orpcerrors | Effect Integration - Catching ORPCErrors}
+ */
+declare const catchORPCErrorCodes: {
+    <E, Cases extends {
+        [K in Extract<E, AnyORPCError>['code']]?: (error: Extract<E, ORPCError<K, any>>) => Effect.Effect<any, any, any>;
+    } & (unknown extends E ? object : {
+        [K in Exclude<keyof Cases, Extract<E, AnyORPCError>['code']>]: never;
+    })>(cases: Cases): <A, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A | {
+        [K in keyof Cases]: Cases[K] extends (...args: any[]) => Effect.Effect<infer A2, any, any> ? A2 : never;
+    }[keyof Cases], Exclude<E, ORPCError<keyof Cases & ORPCErrorCode, any>> | {
+        [K in keyof Cases]: Cases[K] extends (...args: any[]) => Effect.Effect<any, infer E2, any> ? E2 : never;
+    }[keyof Cases], R | {
+        [K in keyof Cases]: Cases[K] extends (...args: any[]) => Effect.Effect<any, any, infer R2> ? R2 : never;
+    }[keyof Cases]>;
+    <A, E, R, Cases extends {
+        [K in Extract<E, AnyORPCError>['code']]?: (error: Extract<E, ORPCError<K, any>>) => Effect.Effect<any, any, any>;
+    } & (unknown extends E ? object : {
+        [K in Exclude<keyof Cases, Extract<E, AnyORPCError>['code']>]: never;
+    })>(self: Effect.Effect<A, E, R>, cases: Cases): Effect.Effect<A | {
+        [K in keyof Cases]: Cases[K] extends (...args: any[]) => Effect.Effect<infer A2, any, any> ? A2 : never;
+    }[keyof Cases], Exclude<E, ORPCError<keyof Cases & ORPCErrorCode, any>> | {
+        [K in keyof Cases]: Cases[K] extends (...args: any[]) => Effect.Effect<any, infer E2, any> ? E2 : never;
+    }[keyof Cases], R | {
+        [K in keyof Cases]: Cases[K] extends (...args: any[]) => Effect.Effect<any, any, infer R2> ? R2 : never;
+    }[keyof Cases]>;
+};
+
 interface RunPromiseOptions {
     signal?: undefined | AbortSignal;
 }
@@ -20,5 +126,5 @@ declare function runPromise<T>(effect: Effect.Effect<T, unknown>, options?: RunP
 
 declare function toStandardSchema<S extends Schema.ConstraintDecoder<any>>(schema: S): Schema$1<S['Encoded'], S['Type']> & S;
 
-export { EffectSchemaToJsonSchemaConverter, runPromise, toStandardSchema };
+export { EffectSchemaToJsonSchemaConverter, catchORPCError, catchORPCErrorCode, catchORPCErrorCodes, runPromise, toStandardSchema };
 export type { RunPromiseOptions };

package/dist/index.mjs

@@ -1,8 +1,8 @@
 import { StandardJsonSchemaConverter } from '@orpc/json-schema';
-import { Schema } from 'effect';
+import { Schema, Function, Effect } from 'effect';
+import { ORPCError } from '@orpc/server';
 export { h as handlerGen, r as runPromise } from './shared/experimental-effect.C9oJcd5q.mjs';
 export { t as toStandardSchema } from './shared/experimental-effect.YQKompVf.mjs';
-import '@orpc/server';
 import '@orpc/shared';
 import '@orpc/contract';
 
@@ -18,4 +18,26 @@ class EffectSchemaToJsonSchemaConverter {
   }
 }
 
-export { EffectSchemaToJsonSchemaConverter };
+const catchORPCError = Function.dual(
+  2,
+  (self, f) => self.pipe(
+    Effect.catchIf((error) => error instanceof ORPCError, f)
+  )
+);
+const catchORPCErrorCode = Function.dual(
+  3,
+  (self, code, f) => self.pipe(
+    Effect.catchIf((error) => error instanceof ORPCError && error.code === code, f)
+  )
+);
+const catchORPCErrorCodes = Function.dual(
+  2,
+  (self, cases) => self.pipe(
+    Effect.catchIf(
+      (error) => error instanceof ORPCError && typeof cases[error.code] === "function",
+      (error) => cases[error.code](error)
+    )
+  )
+);
+
+export { EffectSchemaToJsonSchemaConverter, catchORPCError, catchORPCErrorCode, catchORPCErrorCodes };

package/dist/shared/{experimental-effect.Cw48Xdc-.d.mts → experimental-effect.BupPDCRJ.d.mts}

@@ -1,6 +1,12 @@
 import { AnyProcedure, Context as Context$1, ORPCErrorConstructorMap, ProcedureHandlerOptions, ProcedureHandler, AnyORPCError } from '@orpc/server';
 import { Context, Effect } from 'effect';
 
+/**
+ * A context shape that provides Effect services to effectful handlers
+ * through the oRPC context in a typesafe way.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/effect#effect-services | Effect Integration - Effect Services}
+ */
 interface WithEffectContext<Services> {
     /**
      * A pre-built Effect context providing the services available within this oRPC context.
@@ -52,6 +58,13 @@ type InferYieldError<Eff> = [Eff] extends [never] ? never : [Eff] extends [Effec
 interface HandlerGen<TCurrentContext extends Context$1, TInput, TYield extends Effect.Effect<any, any, TCurrentContext extends WithEffectContext<infer S> ? S : never>, TReturn, TErrorConstructorMap extends ORPCErrorConstructorMap<any>> {
     (opts: ProcedureHandlerOptions<TCurrentContext, TInput, TErrorConstructorMap>, input: TInput): Generator<TYield, TReturn, never>;
 }
+/**
+ * Creates a procedure handler from an Effect generator function.
+ * Inside the generator you can yield Effect operations, and `handlerGen`
+ * handles the execution and error handling for you.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/effect#effectful-handlers | Effect Integration - Effectful Handlers}
+ */
 declare function handlerGen<TCurrentContext extends Context$1, TInput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>, TYield extends Effect.Effect<any, any, TCurrentContext extends WithEffectContext<infer S> ? S : never>, TReturn>(handler: HandlerGen<TCurrentContext, TInput, TYield, TReturn, TErrorConstructorMap>): ProcedureHandler<TCurrentContext, TInput, TReturn | Extract<InferYieldError<TYield>, AnyORPCError>, TErrorConstructorMap>;
 
 export { handlerGen as h };

package/dist/shared/{experimental-effect.Cw48Xdc-.d.ts → experimental-effect.BupPDCRJ.d.ts}

@@ -1,6 +1,12 @@
 import { AnyProcedure, Context as Context$1, ORPCErrorConstructorMap, ProcedureHandlerOptions, ProcedureHandler, AnyORPCError } from '@orpc/server';
 import { Context, Effect } from 'effect';
 
+/**
+ * A context shape that provides Effect services to effectful handlers
+ * through the oRPC context in a typesafe way.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/effect#effect-services | Effect Integration - Effect Services}
+ */
 interface WithEffectContext<Services> {
     /**
      * A pre-built Effect context providing the services available within this oRPC context.
@@ -52,6 +58,13 @@ type InferYieldError<Eff> = [Eff] extends [never] ? never : [Eff] extends [Effec
 interface HandlerGen<TCurrentContext extends Context$1, TInput, TYield extends Effect.Effect<any, any, TCurrentContext extends WithEffectContext<infer S> ? S : never>, TReturn, TErrorConstructorMap extends ORPCErrorConstructorMap<any>> {
     (opts: ProcedureHandlerOptions<TCurrentContext, TInput, TErrorConstructorMap>, input: TInput): Generator<TYield, TReturn, never>;
 }
+/**
+ * Creates a procedure handler from an Effect generator function.
+ * Inside the generator you can yield Effect operations, and `handlerGen`
+ * handles the execution and error handling for you.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/effect#effectful-handlers | Effect Integration - Effectful Handlers}
+ */
 declare function handlerGen<TCurrentContext extends Context$1, TInput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>, TYield extends Effect.Effect<any, any, TCurrentContext extends WithEffectContext<infer S> ? S : never>, TReturn>(handler: HandlerGen<TCurrentContext, TInput, TYield, TReturn, TErrorConstructorMap>): ProcedureHandler<TCurrentContext, TInput, TReturn | Extract<InferYieldError<TYield>, AnyORPCError>, TErrorConstructorMap>;
 
 export { handlerGen as h };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/experimental-effect",
   "type": "module",
-  "version": "2.0.0-beta.23",
+  "version": "2.0.0-beta.25",
   "license": "MIT",
   "homepage": "https://orpc.dev",
   "repository": {
@@ -42,10 +42,10 @@
     "effect": ">=4.0.0-beta.90"
   },
   "dependencies": {
-    "@orpc/contract": "2.0.0-beta.23",
-    "@orpc/json-schema": "2.0.0-beta.23",
-    "@orpc/server": "2.0.0-beta.23",
-    "@orpc/shared": "2.0.0-beta.23"
+    "@orpc/server": "2.0.0-beta.25",
+    "@orpc/contract": "2.0.0-beta.25",
+    "@orpc/shared": "2.0.0-beta.25",
+    "@orpc/json-schema": "2.0.0-beta.25"
   },
   "devDependencies": {
     "effect": "4.0.0-beta.101"