effect-orpc 0.2.0 → 0.2.1

package/src/types/index.ts

@@ -4,12 +4,10 @@ import type {
   ErrorMap,
   ErrorMapItem,
   Meta,
-  Route,
   Schema,
 } from "@orpc/contract";
 import type {
   Builder,
-  BuilderConfig,
   BuilderDef,
   BuilderWithMiddlewares,
   Context,
@@ -32,6 +30,19 @@ import type {
   ORPCTaggedErrorInstance,
 } from "../tagged-error";
 
+type EffectBuilderDefBase<
+  TInputSchema extends AnySchema,
+  TOutputSchema extends AnySchema,
+  TEffectErrorMap extends EffectErrorMap,
+  TMeta extends Meta,
+> = EnhanceRouterOptions<EffectErrorMapToErrorMap<TEffectErrorMap>> &
+  BuilderDef<
+    TInputSchema,
+    TOutputSchema,
+    EffectErrorMapToErrorMap<TEffectErrorMap>,
+    TMeta
+  >;
+
 /**
  * Extended builder definition that includes the Effect ManagedRuntime.
  */
@@ -42,14 +53,12 @@ export interface EffectBuilderDef<
   TMeta extends Meta,
   TRequirementsProvided,
   TRuntimeError,
-> extends EnhanceRouterOptions<EffectErrorMapToErrorMap<TEffectErrorMap>> {
-  inputValidationIndex: number;
-  outputValidationIndex: number;
-  config: BuilderConfig;
-  meta: TMeta;
-  route: Route;
-  inputSchema?: TInputSchema;
-  outputSchema?: TOutputSchema;
+> extends EffectBuilderDefBase<
+  TInputSchema,
+  TOutputSchema,
+  TEffectErrorMap,
+  TMeta
+> {
   runtime: ManagedRuntime.ManagedRuntime<TRequirementsProvided, TRuntimeError>;
   /**
    * Optional span configuration for Effect tracing.
@@ -413,4 +422,7 @@ export type InferBuilderMeta<T> =
                 ? TMeta
                 : Meta;
 
+export type { EffectBuilderSurface } from "./effect-builder-surface";
+export type { EffectDecoratedProcedureSurface } from "./effect-procedure-surface";
+
 export * from "./variants";

package/src/types/variants.ts

@@ -220,6 +220,13 @@ export interface EffectBuilderWithMiddlewares<
     TRuntimeError
   >;
 
+  /**
+   * Defines the handler of the procedure using an Effect.
+   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The effect is automatically wrapped with `Effect.withSpan`.
+   *
+   * @see {@link https://orpc.dev/docs/procedure Procedure Docs}
+   */
   "effect"<UFuncOutput>(
     effectFn: EffectProcedureHandler<
       TCurrentContext,
@@ -240,6 +247,14 @@ export interface EffectBuilderWithMiddlewares<
     TRuntimeError
   >;
 
+  /**
+   * Adds a traceable span to the procedure for telemetry.
+   * The span name is used for Effect tracing via `Effect.withSpan`.
+   * Stack trace is captured at the call site for better error reporting.
+   *
+   * @param spanName - The name of the span for telemetry (e.g., 'users.getUser')
+   * @returns A traced procedure builder
+   */
   "traced"(
     spanName: string,
   ): EffectProcedureBuilderWithInput<
@@ -494,6 +509,13 @@ export interface EffectProcedureBuilder<
     TRuntimeError
   >;
 
+  /**
+   * Defines the handler of the procedure using an Effect.
+   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The effect is automatically wrapped with `Effect.withSpan`.
+   *
+   * @see {@link https://orpc.dev/docs/procedure Procedure Docs}
+   */
   "effect"<UFuncOutput>(
     effectFn: EffectProcedureHandler<
       TCurrentContext,
@@ -514,6 +536,14 @@ export interface EffectProcedureBuilder<
     TRuntimeError
   >;
 
+  /**
+   * Adds a traceable span to the procedure for telemetry.
+   * The span name is used for Effect tracing via `Effect.withSpan`.
+   * Stack trace is captured at the call site for better error reporting.
+   *
+   * @param spanName - The name of the span for telemetry (e.g., 'users.getUser')
+   * @returns A traced procedure builder
+   */
   "traced"(
     spanName: string,
   ): EffectProcedureBuilder<
@@ -724,6 +754,13 @@ export interface EffectProcedureBuilderWithInput<
     TRuntimeError
   >;
 
+  /**
+   * Defines the handler of the procedure using an Effect.
+   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The effect is automatically wrapped with `Effect.withSpan`.
+   *
+   * @see {@link https://orpc.dev/docs/procedure Procedure Docs}
+   */
   "effect"<UFuncOutput>(
     effectFn: EffectProcedureHandler<
       TCurrentContext,
@@ -744,6 +781,14 @@ export interface EffectProcedureBuilderWithInput<
     TRuntimeError
   >;
 
+  /**
+   * Adds a traceable span to the procedure for telemetry.
+   * The span name is used for Effect tracing via `Effect.withSpan`.
+   * Stack trace is captured at the call site for better error reporting.
+   *
+   * @param spanName - The name of the span for telemetry (e.g., 'users.getUser')
+   * @returns A traced procedure builder
+   */
   "traced"(
     spanName: string,
   ): EffectProcedureBuilderWithInput<
@@ -920,6 +965,13 @@ export interface EffectProcedureBuilderWithOutput<
     TRuntimeError
   >;
 
+  /**
+   * Defines the handler of the procedure using an Effect.
+   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The effect is automatically wrapped with `Effect.withSpan`.
+   *
+   * @see {@link https://orpc.dev/docs/procedure Procedure Docs}
+   */
   "effect"(
     effectFn: EffectProcedureHandler<
       TCurrentContext,
@@ -940,6 +992,14 @@ export interface EffectProcedureBuilderWithOutput<
     TRuntimeError
   >;
 
+  /**
+   * Adds a traceable span to the procedure for telemetry.
+   * The span name is used for Effect tracing via `Effect.withSpan`.
+   * Stack trace is captured at the call site for better error reporting.
+   *
+   * @param spanName - The name of the span for telemetry (e.g., 'users.getUser')
+   * @returns A traced procedure builder
+   */
   "traced"(
     spanName: string,
   ): EffectProcedureBuilderWithInput<
@@ -1132,6 +1192,13 @@ export interface EffectProcedureBuilderWithInputOutput<
     TRuntimeError
   >;
 
+  /**
+   * Defines the handler of the procedure using an Effect.
+   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The effect is automatically wrapped with `Effect.withSpan`.
+   *
+   * @see {@link https://orpc.dev/docs/procedure Procedure Docs}
+   */
   "effect"(
     effectFn: EffectProcedureHandler<
       TCurrentContext,
@@ -1152,6 +1219,14 @@ export interface EffectProcedureBuilderWithInputOutput<
     TRuntimeError
   >;
 
+  /**
+   * Adds a traceable span to the procedure for telemetry.
+   * The span name is used for Effect tracing via `Effect.withSpan`.
+   * Stack trace is captured at the call site for better error reporting.
+   *
+   * @param spanName - The name of the span for telemetry (e.g., 'users.getUser')
+   * @returns A traced procedure builder
+   */
   "traced"(
     spanName: string,
   ): EffectProcedureBuilderWithInput<