effect-orpc 0.2.2 → 0.4.0

package/src/types/variants.ts

@@ -24,11 +24,15 @@ import type {
   ProcedureHandler,
   Router,
 } from "@orpc/server";
+import type { Context as EffectContext, Layer } from "effect";
 
 import type {
   EffectBuilderDef,
   EffectErrorMapToErrorMap,
+  EffectOptionalProvider,
+  EffectOrORPCMiddleware,
   EffectProcedureHandler,
+  EffectProvider,
 } from ".";
 import type {
   EffectDecoratedProcedure,
@@ -40,6 +44,9 @@ import type {
   MergedEffectErrorMap,
 } from "../tagged-error";
 
+type EffectTagIdentifier<T extends EffectContext.Tag<any, any>> =
+  T extends EffectContext.Tag<infer I, any> ? I : never;
+
 export interface EffectBuilderWithMiddlewares<
   TInitialContext extends Context,
   TCurrentContext extends Context,
@@ -101,12 +108,13 @@ export interface EffectBuilderWithMiddlewares<
     UOutContext extends IntersectPick<TCurrentContext, UOutContext>,
     UInContext extends Context = TCurrentContext,
   >(
-    middleware: Middleware<
+    middleware: EffectOrORPCMiddleware<
       UInContext | TCurrentContext,
       UOutContext,
       unknown,
       unknown,
-      EffectErrorConstructorMap<TEffectErrorMap>,
+      TEffectErrorMap,
+      TRequirementsProvided,
       TMeta
     >,
   ): EffectBuilderWithMiddlewares<
@@ -120,6 +128,70 @@ export interface EffectBuilderWithMiddlewares<
     TRuntimeError
   >;
 
+  /**
+   * Provides an Effect layer to downstream procedures.
+   */
+  "provide"<TLayerOut, TLayerError, TLayerIn extends TRequirementsProvided>(
+    layer: Layer.Layer<TLayerOut, TLayerError, TLayerIn>,
+  ): EffectBuilderWithMiddlewares<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided | TLayerOut,
+    TRuntimeError | TLayerError
+  >;
+
+  /**
+   * Provides a request-scoped Effect service to downstream procedures.
+   */
+  "provide"<TTag extends EffectContext.Tag<any, any>>(
+    tag: TTag,
+    provider: EffectProvider<
+      TCurrentContext,
+      InferSchemaOutput<TInputSchema>,
+      TEffectErrorMap,
+      TRequirementsProvided,
+      TMeta,
+      TTag
+    >,
+  ): EffectBuilderWithMiddlewares<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided | EffectTagIdentifier<TTag>,
+    TRuntimeError
+  >;
+
+  /**
+   * Optionally provides a request-scoped Effect service to downstream procedures.
+   */
+  "provideOptional"<TTag extends EffectContext.Tag<any, any>>(
+    tag: TTag,
+    provider: EffectOptionalProvider<
+      TCurrentContext,
+      InferSchemaOutput<TInputSchema>,
+      TEffectErrorMap,
+      TRequirementsProvided,
+      TMeta,
+      TTag
+    >,
+  ): EffectBuilderWithMiddlewares<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided,
+    TRuntimeError
+  >;
+
   /**
    * Sets or updates the metadata.
    * The provided metadata is spared-merged with any existing metadata.
@@ -222,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}
@@ -390,12 +462,13 @@ export interface EffectProcedureBuilder<
     UOutContext extends IntersectPick<TCurrentContext, UOutContext>,
     UInContext extends Context = TCurrentContext,
   >(
-    middleware: Middleware<
+    middleware: EffectOrORPCMiddleware<
       UInContext | TCurrentContext,
       UOutContext,
       unknown,
       unknown,
-      EffectErrorConstructorMap<TEffectErrorMap>,
+      TEffectErrorMap,
+      TRequirementsProvided,
       TMeta
     >,
   ): EffectProcedureBuilder<
@@ -409,6 +482,70 @@ export interface EffectProcedureBuilder<
     TRuntimeError
   >;
 
+  /**
+   * Provides an Effect layer to downstream procedures.
+   */
+  "provide"<TLayerOut, TLayerError, TLayerIn extends TRequirementsProvided>(
+    layer: Layer.Layer<TLayerOut, TLayerError, TLayerIn>,
+  ): EffectProcedureBuilder<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided | TLayerOut,
+    TRuntimeError | TLayerError
+  >;
+
+  /**
+   * Provides a request-scoped Effect service to downstream procedures.
+   */
+  "provide"<TTag extends EffectContext.Tag<any, any>>(
+    tag: TTag,
+    provider: EffectProvider<
+      TCurrentContext,
+      InferSchemaOutput<TInputSchema>,
+      TEffectErrorMap,
+      TRequirementsProvided,
+      TMeta,
+      TTag
+    >,
+  ): EffectProcedureBuilder<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided | EffectTagIdentifier<TTag>,
+    TRuntimeError
+  >;
+
+  /**
+   * Optionally provides a request-scoped Effect service to downstream procedures.
+   */
+  "provideOptional"<TTag extends EffectContext.Tag<any, any>>(
+    tag: TTag,
+    provider: EffectOptionalProvider<
+      TCurrentContext,
+      InferSchemaOutput<TInputSchema>,
+      TEffectErrorMap,
+      TRequirementsProvided,
+      TMeta,
+      TTag
+    >,
+  ): EffectProcedureBuilder<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided,
+    TRuntimeError
+  >;
+
   /**
    * Sets or updates the metadata.
    * The provided metadata is spared-merged with any existing metadata.
@@ -511,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}
@@ -620,12 +757,13 @@ export interface EffectProcedureBuilderWithInput<
     UOutContext extends IntersectPick<TCurrentContext, UOutContext>,
     UInContext extends Context = TCurrentContext,
   >(
-    middleware: Middleware<
+    middleware: EffectOrORPCMiddleware<
       UInContext | TCurrentContext,
       UOutContext,
+      InferSchemaOutput<TInputSchema>,
       unknown,
-      unknown,
-      EffectErrorConstructorMap<TEffectErrorMap>,
+      TEffectErrorMap,
+      TRequirementsProvided,
       TMeta
     >,
   ): EffectProcedureBuilderWithInput<
@@ -672,6 +810,70 @@ export interface EffectProcedureBuilderWithInput<
     TRuntimeError
   >;
 
+  /**
+   * Provides an Effect layer to downstream procedures.
+   */
+  "provide"<TLayerOut, TLayerError, TLayerIn extends TRequirementsProvided>(
+    layer: Layer.Layer<TLayerOut, TLayerError, TLayerIn>,
+  ): EffectProcedureBuilderWithInput<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided | TLayerOut,
+    TRuntimeError | TLayerError
+  >;
+
+  /**
+   * Provides a request-scoped Effect service to downstream procedures.
+   */
+  "provide"<TTag extends EffectContext.Tag<any, any>>(
+    tag: TTag,
+    provider: EffectProvider<
+      TCurrentContext,
+      InferSchemaOutput<TInputSchema>,
+      TEffectErrorMap,
+      TRequirementsProvided,
+      TMeta,
+      TTag
+    >,
+  ): EffectProcedureBuilderWithInput<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided | EffectTagIdentifier<TTag>,
+    TRuntimeError
+  >;
+
+  /**
+   * Optionally provides a request-scoped Effect service to downstream procedures.
+   */
+  "provideOptional"<TTag extends EffectContext.Tag<any, any>>(
+    tag: TTag,
+    provider: EffectOptionalProvider<
+      TCurrentContext,
+      InferSchemaOutput<TInputSchema>,
+      TEffectErrorMap,
+      TRequirementsProvided,
+      TMeta,
+      TTag
+    >,
+  ): EffectProcedureBuilderWithInput<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided,
+    TRuntimeError
+  >;
+
   /**
    * Sets or updates the metadata.
    * The provided metadata is spared-merged with any existing metadata.
@@ -756,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}
@@ -864,12 +1066,13 @@ export interface EffectProcedureBuilderWithOutput<
     UOutContext extends IntersectPick<TCurrentContext, UOutContext>,
     UInContext extends Context = TCurrentContext,
   >(
-    middleware: Middleware<
+    middleware: EffectOrORPCMiddleware<
       UInContext | TCurrentContext,
       UOutContext,
       unknown,
       InferSchemaInput<TOutputSchema>,
-      EffectErrorConstructorMap<TEffectErrorMap>,
+      TEffectErrorMap,
+      TRequirementsProvided,
       TMeta
     >,
   ): EffectProcedureBuilderWithOutput<
@@ -883,6 +1086,70 @@ export interface EffectProcedureBuilderWithOutput<
     TRuntimeError
   >;
 
+  /**
+   * Provides an Effect layer to downstream procedures.
+   */
+  "provide"<TLayerOut, TLayerError, TLayerIn extends TRequirementsProvided>(
+    layer: Layer.Layer<TLayerOut, TLayerError, TLayerIn>,
+  ): EffectProcedureBuilderWithOutput<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided | TLayerOut,
+    TRuntimeError | TLayerError
+  >;
+
+  /**
+   * Provides a request-scoped Effect service to downstream procedures.
+   */
+  "provide"<TTag extends EffectContext.Tag<any, any>>(
+    tag: TTag,
+    provider: EffectProvider<
+      TCurrentContext,
+      InferSchemaOutput<TInputSchema>,
+      TEffectErrorMap,
+      TRequirementsProvided,
+      TMeta,
+      TTag
+    >,
+  ): EffectProcedureBuilderWithOutput<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided | EffectTagIdentifier<TTag>,
+    TRuntimeError
+  >;
+
+  /**
+   * Optionally provides a request-scoped Effect service to downstream procedures.
+   */
+  "provideOptional"<TTag extends EffectContext.Tag<any, any>>(
+    tag: TTag,
+    provider: EffectOptionalProvider<
+      TCurrentContext,
+      InferSchemaOutput<TInputSchema>,
+      TEffectErrorMap,
+      TRequirementsProvided,
+      TMeta,
+      TTag
+    >,
+  ): EffectProcedureBuilderWithOutput<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided,
+    TRuntimeError
+  >;
+
   /**
    * Sets or updates the metadata.
    * The provided metadata is spared-merged with any existing metadata.
@@ -967,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}
@@ -1076,12 +1343,13 @@ export interface EffectProcedureBuilderWithInputOutput<
     UOutContext extends IntersectPick<TCurrentContext, UOutContext>,
     UInContext extends Context = TCurrentContext,
   >(
-    middleware: Middleware<
+    middleware: EffectOrORPCMiddleware<
       UInContext | TCurrentContext,
       UOutContext,
       InferSchemaOutput<TInputSchema>,
       InferSchemaInput<TOutputSchema>,
-      EffectErrorConstructorMap<TEffectErrorMap>,
+      TEffectErrorMap,
+      TRequirementsProvided,
       TMeta
     >,
   ): EffectProcedureBuilderWithInputOutput<
@@ -1128,6 +1396,70 @@ export interface EffectProcedureBuilderWithInputOutput<
     TRuntimeError
   >;
 
+  /**
+   * Provides an Effect layer to downstream procedures.
+   */
+  "provide"<TLayerOut, TLayerError, TLayerIn extends TRequirementsProvided>(
+    layer: Layer.Layer<TLayerOut, TLayerError, TLayerIn>,
+  ): EffectProcedureBuilderWithInputOutput<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided | TLayerOut,
+    TRuntimeError | TLayerError
+  >;
+
+  /**
+   * Provides a request-scoped Effect service to downstream procedures.
+   */
+  "provide"<TTag extends EffectContext.Tag<any, any>>(
+    tag: TTag,
+    provider: EffectProvider<
+      TCurrentContext,
+      InferSchemaOutput<TInputSchema>,
+      TEffectErrorMap,
+      TRequirementsProvided,
+      TMeta,
+      TTag
+    >,
+  ): EffectProcedureBuilderWithInputOutput<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided | EffectTagIdentifier<TTag>,
+    TRuntimeError
+  >;
+
+  /**
+   * Optionally provides a request-scoped Effect service to downstream procedures.
+   */
+  "provideOptional"<TTag extends EffectContext.Tag<any, any>>(
+    tag: TTag,
+    provider: EffectOptionalProvider<
+      TCurrentContext,
+      InferSchemaOutput<TInputSchema>,
+      TEffectErrorMap,
+      TRequirementsProvided,
+      TMeta,
+      TTag
+    >,
+  ): EffectProcedureBuilderWithInputOutput<
+    TInitialContext,
+    TCurrentContext,
+    TInputSchema,
+    TOutputSchema,
+    TEffectErrorMap,
+    TMeta,
+    TRequirementsProvided,
+    TRuntimeError
+  >;
+
   /**
    * Sets or updates the metadata.
    * The provided metadata is spared-merged with any existing metadata.
@@ -1194,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}
@@ -1282,12 +1614,13 @@ export interface EffectRouterBuilder<
     UOutContext extends IntersectPick<TCurrentContext, UOutContext>,
     UInContext extends Context = TCurrentContext,
   >(
-    middleware: Middleware<
+    middleware: EffectOrORPCMiddleware<
       UInContext | TCurrentContext,
       UOutContext,
       unknown,
       unknown,
-      EffectErrorConstructorMap<TEffectErrorMap>,
+      TEffectErrorMap,
+      TRequirementsProvided,
       TMeta
     >,
   ): EffectRouterBuilder<

package/dist/chunk-VOWRLWZZ.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/fiber-context-bridge.ts"],"sourcesContent":["import type { FiberRefs } from \"effect\";\n\nexport interface FiberContextBridge {\n  readonly getCurrentFiberRefs: () => FiberRefs.FiberRefs | undefined;\n}\n\nlet bridge: FiberContextBridge | undefined;\n\nexport function installFiberContextBridge(\n  nextBridge: FiberContextBridge | undefined,\n): void {\n  bridge = nextBridge;\n}\n\nexport function getCurrentFiberRefs(): FiberRefs.FiberRefs | undefined {\n  return bridge?.getCurrentFiberRefs();\n}\n"],"mappings":";AAMA,IAAI;AAEG,SAAS,0BACd,YACM;AACN,WAAS;AACX;AAEO,SAAS,sBAAuD;AACrE,SAAO,QAAQ,oBAAoB;AACrC;","names":[]}