effect-orpc 0.3.0 → 0.5.0

package/src/types/index.ts

@@ -24,15 +24,10 @@ import type {
   RouterBuilder,
 } from "@orpc/server";
 import type { MaybeOptionalOptions } from "@orpc/shared";
-import type {
-  Context as EffectContext,
-  Effect,
-  Layer,
-  ManagedRuntime,
-  Option,
-} from "effect";
+import type { Context as EffectContext, Effect, Layer, Option } from "effect";
 import type { YieldWrap } from "effect/Utils";
 
+import type { EffectRuntimeRunner } from "../runtime-source";
 import type {
   EffectErrorConstructorMap,
   EffectErrorMap,
@@ -54,7 +49,7 @@ type EffectBuilderDefBase<
   >;
 
 /**
- * Extended builder definition that includes the Effect ManagedRuntime.
+ * Extended builder definition that includes Effect execution state.
  */
 export interface EffectBuilderDef<
   TInputSchema extends AnySchema,
@@ -69,7 +64,7 @@ export interface EffectBuilderDef<
   TEffectErrorMap,
   TMeta
 > {
-  runtime: ManagedRuntime.ManagedRuntime<TRequirementsProvided, TRuntimeError>;
+  runner: EffectRuntimeRunner<TRequirementsProvided, TRuntimeError>;
   /**
    * Optional span configuration for Effect tracing.
    */
@@ -83,7 +78,7 @@ export interface EffectBuilderDef<
 }
 
 /**
- * Extended procedure definition that includes the Effect ManagedRuntime.
+ * Extended procedure definition that includes Effect execution state.
  */
 export interface EffectProcedureDef<
   TInitialContext extends Context,
@@ -102,7 +97,7 @@ export interface EffectProcedureDef<
   EffectErrorMapToErrorMap<TEffectErrorMap>,
   TMeta
 > {
-  runtime: ManagedRuntime.ManagedRuntime<TRequirementsProvided, TRuntimeError>;
+  runner: EffectRuntimeRunner<TRequirementsProvided, TRuntimeError>;
   effectErrorMap: TEffectErrorMap;
   effectSteps?: readonly EffectPipelineStep[];
   effectHandler?: EffectProcedureHandlerConfig;
@@ -140,18 +135,17 @@ export type EffectProcedureHandler<
     EffectErrorConstructorMap<TEffectErrorMap>,
     TMeta
   >,
-) => Generator<
-  YieldWrap<
-    Effect.Effect<
-      any,
-      | EffectErrorMapToUnion<TEffectErrorMap>
-      | ORPCError<ORPCErrorCode, unknown>,
+) =>
+  | Effect.Effect<
+      THandlerOutput,
+      EffectOperationError<TEffectErrorMap>,
       TRequirementsProvided
     >
-  >,
-  THandlerOutput,
-  never
->;
+  | EffectCallbackGenerator<
+      THandlerOutput,
+      TEffectErrorMap,
+      TRequirementsProvided
+    >;
 
 export interface EffectProcedureHandlerConfig {
   readonly effectFn: EffectProcedureHandler<any, any, any, any, any, any>;
@@ -162,6 +156,26 @@ export interface EffectProcedureHandlerConfig {
 type EffectTagService<T extends EffectContext.Tag<any, any>> =
   T extends EffectContext.Tag<any, infer S> ? S : never;
 
+type EffectOperationError<TEffectErrorMap extends EffectErrorMap> =
+  | EffectErrorMapToUnion<TEffectErrorMap>
+  | ORPCError<ORPCErrorCode, unknown>;
+
+type EffectCallbackGenerator<
+  TReturn,
+  TEffectErrorMap extends EffectErrorMap,
+  TRequirementsProvided,
+> = Generator<
+  YieldWrap<
+    Effect.Effect<
+      unknown,
+      EffectOperationError<TEffectErrorMap>,
+      TRequirementsProvided
+    >
+  >,
+  TReturn,
+  never
+>;
+
 export type EffectProvider<
   TCurrentContext extends Context,
   TInput,
@@ -176,11 +190,17 @@ export type EffectProvider<
     EffectErrorConstructorMap<TEffectErrorMap>,
     TMeta
   >,
-) => Effect.Effect<
-  EffectTagService<TTag>,
-  EffectErrorMapToUnion<TEffectErrorMap> | ORPCError<ORPCErrorCode, unknown>,
-  TRequirementsProvided
->;
+) =>
+  | Effect.Effect<
+      EffectTagService<TTag>,
+      EffectOperationError<TEffectErrorMap>,
+      TRequirementsProvided
+    >
+  | EffectCallbackGenerator<
+      EffectTagService<TTag>,
+      TEffectErrorMap,
+      TRequirementsProvided
+    >;
 
 export type EffectOptionalProvider<
   TCurrentContext extends Context,
@@ -196,11 +216,17 @@ export type EffectOptionalProvider<
     EffectErrorConstructorMap<TEffectErrorMap>,
     TMeta
   >,
-) => Effect.Effect<
-  Option.Option<EffectTagService<TTag>>,
-  EffectErrorMapToUnion<TEffectErrorMap> | ORPCError<ORPCErrorCode, unknown>,
-  TRequirementsProvided
->;
+) =>
+  | Effect.Effect<
+      Option.Option<EffectTagService<TTag>>,
+      EffectOperationError<TEffectErrorMap>,
+      TRequirementsProvided
+    >
+  | EffectCallbackGenerator<
+      Option.Option<EffectTagService<TTag>>,
+      TEffectErrorMap,
+      TRequirementsProvided
+    >;
 
 interface EffectMiddlewareNext<
   TOutput,
@@ -332,17 +358,16 @@ export type EffectOrORPCMiddleware<
 ) =>
   | MiddlewareResult<TOutContext, TOutput>
   | PromiseLike<MiddlewareResult<TOutContext, TOutput>>
-  | Generator<
-      YieldWrap<
-        Effect.Effect<
-          unknown,
-          | EffectErrorMapToUnion<TEffectErrorMap>
-          | ORPCError<ORPCErrorCode, unknown>,
-          TRequirementsProvided
-        >
-      >,
+  | void
+  | Effect.Effect<
+      EffectMiddlewareResult<TOutContext, TOutput> | void,
+      EffectOperationError<TEffectErrorMap>,
+      TRequirementsProvided
+    >
+  | EffectCallbackGenerator<
       EffectMiddlewareResult<TOutContext, TOutput> | void,
-      never
+      TEffectErrorMap,
+      TRequirementsProvided
     >;
 
 export type EffectMiddlewareOptions<
@@ -389,18 +414,18 @@ export type EffectMiddleware<
     TEffectErrorMap,
     TRequirementsProvided
   >,
-) => Generator<
-  YieldWrap<
-    Effect.Effect<
-      unknown,
-      | EffectErrorMapToUnion<TEffectErrorMap>
-      | ORPCError<ORPCErrorCode, unknown>,
+) =>
+  | Effect.Effect<
+      EffectMiddlewareResult<TOutContext, TOutput> | void,
+      EffectOperationError<TEffectErrorMap>,
       TRequirementsProvided
     >
-  >,
-  EffectMiddlewareResult<TOutContext, TOutput> | void,
-  never
->;
+  | EffectCallbackGenerator<
+      EffectMiddlewareResult<TOutContext, TOutput> | void,
+      TEffectErrorMap,
+      TRequirementsProvided
+    >
+  | void;
 
 type EffectProvideStep = {
   readonly _tag: "provide";

package/src/types/variants.ts

@@ -294,7 +294,7 @@ export interface EffectBuilderWithMiddlewares<
 
   /**
    * Defines the handler of the procedure using an Effect.
-   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The Effect is executed using the configured Effect runtime source.
    * The effect is automatically wrapped with `Effect.withSpan`.
    *
    * @see {@link https://orpc.dev/docs/procedure Procedure Docs}
@@ -648,7 +648,7 @@ export interface EffectProcedureBuilder<
 
   /**
    * Defines the handler of the procedure using an Effect.
-   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The Effect is executed using the configured Effect runtime source.
    * The effect is automatically wrapped with `Effect.withSpan`.
    *
    * @see {@link https://orpc.dev/docs/procedure Procedure Docs}
@@ -958,7 +958,7 @@ export interface EffectProcedureBuilderWithInput<
 
   /**
    * Defines the handler of the procedure using an Effect.
-   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The Effect is executed using the configured Effect runtime source.
    * The effect is automatically wrapped with `Effect.withSpan`.
    *
    * @see {@link https://orpc.dev/docs/procedure Procedure Docs}
@@ -1234,7 +1234,7 @@ export interface EffectProcedureBuilderWithOutput<
 
   /**
    * Defines the handler of the procedure using an Effect.
-   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The Effect is executed using the configured Effect runtime source.
    * The effect is automatically wrapped with `Effect.withSpan`.
    *
    * @see {@link https://orpc.dev/docs/procedure Procedure Docs}
@@ -1526,7 +1526,7 @@ export interface EffectProcedureBuilderWithInputOutput<
 
   /**
    * Defines the handler of the procedure using an Effect.
-   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The Effect is executed using the configured Effect runtime source.
    * The effect is automatically wrapped with `Effect.withSpan`.
    *
    * @see {@link https://orpc.dev/docs/procedure Procedure Docs}