effect 4.0.0-beta.66 → 4.0.0-beta.68

package/dist/unstable/rpc/RpcMiddleware.d.ts

@@ -1,4 +1,30 @@
 /**
+ * The `RpcMiddleware` module defines middleware services that can wrap RPC
+ * handler execution on the server and request execution in generated clients.
+ *
+ * Use middleware to attach cross-cutting behavior to individual RPCs or whole
+ * `RpcGroup`s, such as authentication, authorization, request logging, tracing,
+ * metrics, rate limiting, header propagation, or adding request-scoped services
+ * to the handler context. A middleware service records the services it requires
+ * and provides, the schema for errors it can fail with, and whether clients must
+ * install a matching middleware via `layerClient`.
+ *
+ * Server middleware receives the target `rpc`, decoded `payload`, request
+ * `headers`, `requestId`, and `Rpc.ServerClient`, then wraps the handler effect.
+ * Its `provides` type removes services from the downstream handler requirement,
+ * while `requires` adds the services needed by the middleware implementation.
+ * Middleware errors must be declared with a `Schema` so they can be encoded as
+ * RPC failures, and any schema encoding or decoding services remain part of the
+ * generated RPC environments.
+ *
+ * Client middleware is installed with `layerClient`, captures the surrounding
+ * layer context, and can inspect, rewrite, retry, or short-circuit outgoing
+ * requests before calling `next`. Set `requiredForClient` when an RPC's typed
+ * client must require that `ForClient` layer; otherwise a client implementation
+ * is used only when one is present. `clientError` contributes only to the
+ * client-side call error channel, while the middleware `error` schema is shared
+ * with server failures.
+ *
  * @since 4.0.0
  */
 import * as Context from "../../Context.ts";
@@ -11,18 +37,26 @@ import type { Headers } from "../http/Headers.ts";
 import type * as Rpc from "./Rpc.ts";
 import type { Request, RequestId } from "./RpcMessage.ts";
 /**
+ * The literal type id used to identify RPC middleware service classes.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category Type IDs
  */
 export type TypeId = "~effect/rpc/RpcMiddleware";
 /**
+ * The runtime type id used to attach and inspect RPC middleware metadata.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category Type IDs
  */
 export declare const TypeId: TypeId;
 /**
- * @since 4.0.0
+ * The server-side RPC middleware function shape, wrapping a handler effect with
+ * access to request metadata and translating provided services into required
+ * services.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface RpcMiddleware<Provides, E, Requires> {
     (effect: Effect.Effect<SuccessValue, E | unhandled, Provides>, options: {
@@ -34,15 +68,21 @@ export interface RpcMiddleware<Provides, E, Requires> {
     }): Effect.Effect<SuccessValue, unhandled | E, Requires | Scope>;
 }
 /**
- * @since 4.0.0
+ * Marker success type used by RPC middleware to represent successful completion
+ * without exposing the handler's concrete success value.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface SuccessValue {
     readonly _: unique symbol;
 }
 /**
- * @since 4.0.0
+ * The client-side RPC middleware function shape, allowing outgoing requests to
+ * be inspected or modified before calling `next`.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface RpcMiddlewareClient<E, CE, R> {
     (options: {
@@ -52,16 +92,22 @@ export interface RpcMiddlewareClient<E, CE, R> {
     }): Effect.Effect<SuccessValue, unhandled | E | CE, R>;
 }
 /**
- * @since 4.0.0
+ * Marker service requirement indicating that a middleware has a client-side
+ * implementation available for an RPC client.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface ForClient<Id> {
     readonly _: unique symbol;
     readonly id: Id;
 }
 /**
- * @since 4.0.0
+ * An erased server-side RPC middleware function, useful when the concrete
+ * provided services, errors, and requirements are not needed.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface Any {
     (effect: Effect.Effect<SuccessValue, any, any>, options: {
@@ -73,8 +119,11 @@ export interface Any {
     }): Effect.Effect<SuccessValue, any, any>;
 }
 /**
- * @since 4.0.0
+ * A type-level carrier for RPC middleware metadata, including provided
+ * services, required services, error schema, and client error type.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface AnyId {
     readonly [TypeId]: {
@@ -85,8 +134,11 @@ export interface AnyId {
     };
 }
 /**
- * @since 4.0.0
+ * The `Context.Service` class shape created for an RPC middleware, including
+ * its error schema, service metadata, and client-side requirement marker.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface ServiceClass<Self, Name extends string, Provides, E extends Schema.Top, ClientError, Requires, RequiredForClient extends boolean> extends Context.Service<Self, RpcMiddleware<Provides, E["Type"], Requires>> {
     new (_: never): Context.ServiceClass.Shape<Name, RpcMiddleware<Provides, E["Type"], Requires>> & {
@@ -103,8 +155,10 @@ export interface ServiceClass<Self, Name extends string, Provides, E extends Sch
     readonly "~ClientError": ClientError;
 }
 /**
- * @since 4.0.0
+ * Extracts the services provided by an RPC middleware.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Provides<A> = A extends {
     readonly [TypeId]: {
@@ -112,8 +166,10 @@ export type Provides<A> = A extends {
     };
 } ? P : never;
 /**
- * @since 4.0.0
+ * Extracts the services required by an RPC middleware.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Requires<A> = A extends {
     readonly [TypeId]: {
@@ -121,13 +177,18 @@ export type Requires<A> = A extends {
     };
 } ? R : never;
 /**
- * @since 4.0.0
+ * Applies a middleware's service transformation to an RPC environment by
+ * removing services the middleware provides and adding services it requires.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ApplyServices<A, R> = Exclude<R, Provides<A>> | Requires<A>;
 /**
- * @since 4.0.0
+ * Extracts the error schema associated with an RPC middleware.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ErrorSchema<A> = A extends {
     readonly [TypeId]: {
@@ -135,23 +196,31 @@ export type ErrorSchema<A> = A extends {
     };
 } ? E extends Schema.Top ? E : never : never;
 /**
- * @since 4.0.0
+ * Extracts the decoded error type produced by an RPC middleware.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Error<A> = ErrorSchema<A>["Type"];
 /**
- * @since 4.0.0
+ * Extracts the encoding services required by a middleware's error schema.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ErrorServicesEncode<A> = ErrorSchema<A>["EncodingServices"];
 /**
- * @since 4.0.0
+ * Extracts the decoding services required by a middleware's error schema.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ErrorServicesDecode<A> = ErrorSchema<A>["DecodingServices"];
 /**
- * @since 4.0.0
+ * An erased RPC middleware context key carrying middleware metadata.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface AnyService extends Context.Key<any, any> {
     readonly [TypeId]: typeof TypeId;
@@ -160,8 +229,11 @@ export interface AnyService extends Context.Key<any, any> {
     readonly "~ClientError": any;
 }
 /**
- * @since 4.0.0
+ * An erased RPC middleware context key whose service value is a server-side
+ * middleware function.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface AnyServiceWithProps extends Context.Key<any, RpcMiddleware<any, any, any>> {
     readonly [TypeId]: typeof TypeId;
@@ -170,8 +242,12 @@ export interface AnyServiceWithProps extends Context.Key<any, RpcMiddleware<any,
     readonly "~ClientError": any;
 }
 /**
- * @since 4.0.0
+ * Creates a typed RPC middleware service class, with optional service
+ * requirements, provided services, error schema, and client-side requirement
+ * metadata.
+ *
  * @category tags
+ * @since 4.0.0
  */
 export declare const Service: <Self, Config extends {
     requires?: any;
@@ -186,8 +262,12 @@ export declare const Service: <Self, Config extends {
     readonly requiredForClient?: RequiredForClient | undefined;
 } | undefined) => ServiceClass<Self, Name, "provides" extends keyof Config ? Config["provides"] : never, Error, "clientError" extends keyof Config ? Config["clientError"] : never, "requires" extends keyof Config ? Config["requires"] : never, RequiredForClient>;
 /**
- * @since 4.0.0
+ * Provides the client-side implementation for an RPC middleware service,
+ * capturing the layer's environment and merging it into each middleware
+ * invocation.
+ *
  * @category client
+ * @since 4.0.0
  */
 export declare const layerClient: <Id extends AnyId, S, R, EX = never, RX = never>(tag: Context.Key<Id, S>, service: RpcMiddlewareClient<Id[TypeId]["error"]["Type"], Id[TypeId]["clientError"], R> | Effect.Effect<RpcMiddlewareClient<Id[TypeId]["error"]["Type"], Id[TypeId]["clientError"], R>, EX, RX>) => Layer.Layer<ForClient<Id>, EX, R | Exclude<RX, Scope>>;
 //# sourceMappingURL=RpcMiddleware.d.ts.map

package/dist/unstable/rpc/RpcMiddleware.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RpcMiddleware.d.ts","sourceRoot":"","sources":["../../../src/unstable/rpc/RpcMiddleware.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AACtC,OAAO,KAAK,EAAW,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,KAAK,KAAK,GAAG,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAEzD;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,2BAA2B,CAAA;AAEhD;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE,MAAoC,CAAA;AAEzD;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,QAAQ,EAAE,CAAC,EAAE,QAAQ;IAClD,CACE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,GAAG,SAAS,EAAE,QAAQ,CAAC,EAC5D,OAAO,EAAE;QACP,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,YAAY,CAAA;QACjC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;QAC7B,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,YAAY,CAAA;QAC9B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;QACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;KAC1B,GACA,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,GAAG,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC,CAAA;CAChE;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM,CAAA;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC;IAC3C,CAAC,OAAO,EAAE;QACR,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,YAAY,CAAA;QAC9B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAClC,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,GAAG,CAAC,CAAC,CAAA;KACzF,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAA;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,EAAE;IAC3B,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM,CAAA;IACzB,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAA;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,GAAG;IAClB,CACE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,EAAE,GAAG,CAAC,EAC7C,OAAO,EAAE;QACP,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,YAAY,CAAA;QACjC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;QAC7B,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,YAAY,CAAA;QAC9B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;QACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;KAC1B,GACA,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QACjB,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAA;QACtB,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAA;QACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAA;QAC1B,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAA;KAC1B,CAAA;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY,CAC3B,IAAI,EACJ,IAAI,SAAS,MAAM,EACnB,QAAQ,EACR,CAAC,SAAS,MAAM,CAAC,GAAG,EACpB,WAAW,EACX,QAAQ,EACR,iBAAiB,SAAS,OAAO,CACjC,SAAQ,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3E,KAAI,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC,GAAG;QAC9F,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;YACjB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;YACjB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;YAC3B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;YAC3B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAA;SAClC,CAAA;KACF,CAAA;IACD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;IACjB,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAA;IAC7C,QAAQ,CAAC,cAAc,EAAE,WAAW,CAAA;CACrC;AAED;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAA;AAErG;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAA;AAErG;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;AAEvE;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GACrF,CAAC,SAAS,MAAM,CAAC,GAAG,GAAG,CAAC,GAAG,KAAK,GAChC,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;AAE7C;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAEvE;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAEvE;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC;IACvD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAA;IAC1B,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAA;IACnC,QAAQ,CAAC,cAAc,EAAE,GAAG,CAAA;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IACzF,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAA;IAC1B,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAA;IACnC,QAAQ,CAAC,cAAc,EAAE,GAAG,CAAA;CAC7B;AAED;;;GAGG;AACH,eAAO,MAAM,OAAO,GAClB,IAAI,EACJ,MAAM,SAAS;IACb,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,WAAW,CAAC,EAAE,GAAG,CAAA;CAClB,GAAG;IACF,QAAQ,EAAE,KAAK,CAAA;IACf,QAAQ,EAAE,KAAK,CAAA;IACf,WAAW,EAAE,KAAK,CAAA;CACnB,OACE,CACH,KAAK,CAAC,IAAI,SAAS,MAAM,EACzB,KAAK,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,EACvC,KAAK,CAAC,iBAAiB,SAAS,OAAO,GAAG,KAAK,EAE/C,EAAE,EAAE,IAAI,EACR,OAAO,CAAC,EAAE;IACR,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;IAClC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAA;CAC3D,GAAG,SAAS,KACV,YAAY,CACf,IAAI,EACJ,IAAI,EACJ,UAAU,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,EAC5D,KAAK,EACL,aAAa,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,KAAK,EAClE,UAAU,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,EAC5D,iBAAiB,CA4BlB,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,EAAE,SAAS,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,KAAK,EAAE,EAAE,GAAG,KAAK,EACxE,KAAK,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EACvB,SACI,mBAAmB,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,GAC9E,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,KACxG,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAgBnD,CAAA"}
+{"version":3,"file":"RpcMiddleware.d.ts","sourceRoot":"","sources":["../../../src/unstable/rpc/RpcMiddleware.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AACtC,OAAO,KAAK,EAAW,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,KAAK,KAAK,GAAG,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAEzD;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG,2BAA2B,CAAA;AAEhD;;;;;GAKG;AACH,eAAO,MAAM,MAAM,EAAE,MAAoC,CAAA;AAEzD;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa,CAAC,QAAQ,EAAE,CAAC,EAAE,QAAQ;IAClD,CACE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,GAAG,SAAS,EAAE,QAAQ,CAAC,EAC5D,OAAO,EAAE;QACP,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,YAAY,CAAA;QACjC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;QAC7B,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,YAAY,CAAA;QAC9B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;QACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;KAC1B,GACA,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,GAAG,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC,CAAA;CAChE;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM,CAAA;CAC1B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC;IAC3C,CAAC,OAAO,EAAE;QACR,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,YAAY,CAAA;QAC9B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAClC,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,GAAG,CAAC,CAAC,CAAA;KACzF,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAA;CACvD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAS,CAAC,EAAE;IAC3B,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM,CAAA;IACzB,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAA;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,GAAG;IAClB,CACE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,EAAE,GAAG,CAAC,EAC7C,OAAO,EAAE;QACP,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,YAAY,CAAA;QACjC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;QAC7B,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,YAAY,CAAA;QAC9B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;QACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;KAC1B,GACA,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;CACzC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QACjB,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAA;QACtB,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAA;QACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAA;QAC1B,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAA;KAC1B,CAAA;CACF;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY,CAC3B,IAAI,EACJ,IAAI,SAAS,MAAM,EACnB,QAAQ,EACR,CAAC,SAAS,MAAM,CAAC,GAAG,EACpB,WAAW,EACX,QAAQ,EACR,iBAAiB,SAAS,OAAO,CACjC,SAAQ,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3E,KAAI,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC,GAAG;QAC9F,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;YACjB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;YACjB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;YAC3B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;YAC3B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAA;SAClC,CAAA;KACF,CAAA;IACD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;IACjB,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAA;IAC7C,QAAQ,CAAC,cAAc,EAAE,WAAW,CAAA;CACrC;AAED;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAA;AAErG;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAA;AAErG;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;AAEvE;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GACrF,CAAC,SAAS,MAAM,CAAC,GAAG,GAAG,CAAC,GAAG,KAAK,GAChC,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;AAE7C;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAEvE;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAEvE;;;;;GAKG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC;IACvD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAA;IAC1B,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAA;IACnC,QAAQ,CAAC,cAAc,EAAE,GAAG,CAAA;CAC7B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAoB,SAAQ,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IACzF,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAA;IAC1B,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAA;IACnC,QAAQ,CAAC,cAAc,EAAE,GAAG,CAAA;CAC7B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,GAClB,IAAI,EACJ,MAAM,SAAS;IACb,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,WAAW,CAAC,EAAE,GAAG,CAAA;CAClB,GAAG;IACF,QAAQ,EAAE,KAAK,CAAA;IACf,QAAQ,EAAE,KAAK,CAAA;IACf,WAAW,EAAE,KAAK,CAAA;CACnB,OACE,CACH,KAAK,CAAC,IAAI,SAAS,MAAM,EACzB,KAAK,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,EACvC,KAAK,CAAC,iBAAiB,SAAS,OAAO,GAAG,KAAK,EAE/C,EAAE,EAAE,IAAI,EACR,OAAO,CAAC,EAAE;IACR,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;IAClC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAA;CAC3D,GAAG,SAAS,KACV,YAAY,CACf,IAAI,EACJ,IAAI,EACJ,UAAU,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,EAC5D,KAAK,EACL,aAAa,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,KAAK,EAClE,UAAU,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,EAC5D,iBAAiB,CA4BlB,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,GAAI,EAAE,SAAS,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,KAAK,EAAE,EAAE,GAAG,KAAK,EACxE,KAAK,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EACvB,SACI,mBAAmB,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,GAC9E,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,KACxG,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAgBnD,CAAA"}

package/dist/unstable/rpc/RpcMiddleware.js

@@ -1,4 +1,30 @@
 /**
+ * The `RpcMiddleware` module defines middleware services that can wrap RPC
+ * handler execution on the server and request execution in generated clients.
+ *
+ * Use middleware to attach cross-cutting behavior to individual RPCs or whole
+ * `RpcGroup`s, such as authentication, authorization, request logging, tracing,
+ * metrics, rate limiting, header propagation, or adding request-scoped services
+ * to the handler context. A middleware service records the services it requires
+ * and provides, the schema for errors it can fail with, and whether clients must
+ * install a matching middleware via `layerClient`.
+ *
+ * Server middleware receives the target `rpc`, decoded `payload`, request
+ * `headers`, `requestId`, and `Rpc.ServerClient`, then wraps the handler effect.
+ * Its `provides` type removes services from the downstream handler requirement,
+ * while `requires` adds the services needed by the middleware implementation.
+ * Middleware errors must be declared with a `Schema` so they can be encoded as
+ * RPC failures, and any schema encoding or decoding services remain part of the
+ * generated RPC environments.
+ *
+ * Client middleware is installed with `layerClient`, captures the surrounding
+ * layer context, and can inspect, rewrite, retry, or short-circuit outgoing
+ * requests before calling `next`. Set `requiredForClient` when an RPC's typed
+ * client must require that `ForClient` layer; otherwise a client implementation
+ * is used only when one is present. `clientError` contributes only to the
+ * client-side call error channel, while the middleware `error` schema is shared
+ * with server failures.
+ *
  * @since 4.0.0
  */
 import * as Context from "../../Context.js";
@@ -7,13 +33,19 @@ import * as Layer from "../../Layer.js";
 import * as Schema from "../../Schema.js";
 import { Scope } from "../../Scope.js";
 /**
+ * The runtime type id used to attach and inspect RPC middleware metadata.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category Type IDs
  */
 export const TypeId = "~effect/rpc/RpcMiddleware";
 /**
- * @since 4.0.0
+ * Creates a typed RPC middleware service class, with optional service
+ * requirements, provided services, error schema, and client-side requirement
+ * metadata.
+ *
  * @category tags
+ * @since 4.0.0
  */
 export const Service = () => (id, options) => {
   const Err = globalThis.Error;
@@ -36,8 +68,12 @@ export const Service = () => (id, options) => {
   return ServiceClass;
 };
 /**
- * @since 4.0.0
+ * Provides the client-side implementation for an RPC middleware service,
+ * capturing the layer's environment and merging it into each middleware
+ * invocation.
+ *
  * @category client
+ * @since 4.0.0
  */
 export const layerClient = (tag, service) => Layer.effectContext(Effect.gen(function* () {
   const services = (yield* Effect.context()).pipe(Context.omit(Scope));

package/dist/unstable/rpc/RpcMiddleware.js.map

@@ -1 +1 @@
-{"version":3,"file":"RpcMiddleware.js","names":["Context","Effect","Layer","Schema","Scope","TypeId","Service","id","options","Err","globalThis","Error","limit","stackTraceLimit","creationError","ServiceClass","ServiceClass_","Object","setPrototypeOf","getPrototypeOf","key","defineProperty","get","stack","error","Never","requiredForClient","layerClient","tag","service","effectContext","gen","services","context","pipe","omit","middleware","isEffect","makeUnsafe","Map","updateContext","requestContext","merge"],"sources":["../../../src/unstable/rpc/RpcMiddleware.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,SAASC,KAAK,QAAQ,gBAAgB;AAYtC;;;;AAIA,OAAO,MAAMC,MAAM,GAAW,2BAA2B;AA2KzD;;;;AAIA,OAAO,MAAMC,OAAO,GAAGA,CAAA,KA8BvB,CACEC,EAAU,EACVC,OAGC,KACC;EACF,MAAMC,GAAG,GAAGC,UAAU,CAACC,KAAY;EACnC,MAAMC,KAAK,GAAGH,GAAG,CAACI,eAAe;EACjCJ,GAAG,CAACI,eAAe,GAAG,CAAC;EACvB,MAAMC,aAAa,GAAG,IAAIL,GAAG,EAAE;EAC/BA,GAAG,CAACI,eAAe,GAAGD,KAAK;EAE3B,SAASG,YAAYA,CAAA,GAAI;EACzB,MAAMC,aAAa,GAAGD,YAA0C;EAChEE,MAAM,CAACC,cAAc,CAACH,YAAY,EAAEE,MAAM,CAACE,cAAc,CAACnB,OAAO,CAACM,OAAO,CAAYC,EAAE,CAAC,CAAC,CAAC;EAC1FQ,YAAY,CAACK,GAAG,GAAGb,EAAE;EACrBU,MAAM,CAACI,cAAc,CAACN,YAAY,EAAE,OAAO,EAAE;IAC3CO,GAAGA,CAAA;MACD,OAAOR,aAAa,CAACS,KAAK;IAC5B;GACD,CAAC;EACFP,aAAa,CAACX,MAAM,CAAC,GAAGA,MAAM;EAC9BW,aAAa,CAACQ,KAAK,GAAGhB,OAAO,EAAEgB,KAAK,IAAIrB,MAAM,CAACsB,KAAK;EACpDT,aAAa,CAACU,iBAAiB,GAAGlB,OAAO,EAAEkB,iBAAiB,IAAI,KAAK;EACrE,OAAOX,YAAmB;AAC5B,CAAC;AAED;;;;AAIA,OAAO,MAAMY,WAAW,GAAGA,CACzBC,GAAuB,EACvBC,OAEyG,KAEzG3B,KAAK,CAAC4B,aAAa,CAAC7B,MAAM,CAAC8B,GAAG,CAAC,aAAS;EACtC,MAAMC,QAAQ,GAAG,CAAC,OAAO/B,MAAM,CAACgC,OAAO,EAAa,EAAEC,IAAI,CACxDlC,OAAO,CAACmC,IAAI,CAAC/B,KAAK,CAAC,CACE;EACvB,MAAMgC,UAAU,GAAGnC,MAAM,CAACoC,QAAQ,CAACR,OAAO,CAAC,GAAG,OAAOA,OAAO,GAAGA,OAAO;EACtE,OAAO7B,OAAO,CAACsC,UAAU,CACvB,IAAIC,GAAG,CAAC,CAAC,CACP,GAAGX,GAAG,CAACR,GAAG,SAAS,EAClBZ,OAAY,IACXP,MAAM,CAACuC,aAAa,CAClBJ,UAAU,CAAC5B,OAAO,CAAC,EAClBiC,cAAc,IAAKzC,OAAO,CAAC0C,KAAK,CAACV,QAAQ,EAAES,cAAc,CAAC,CAC5D,CACJ,CAAC,CAAC,CACJ;AACH,CAAC,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"RpcMiddleware.js","names":["Context","Effect","Layer","Schema","Scope","TypeId","Service","id","options","Err","globalThis","Error","limit","stackTraceLimit","creationError","ServiceClass","ServiceClass_","Object","setPrototypeOf","getPrototypeOf","key","defineProperty","get","stack","error","Never","requiredForClient","layerClient","tag","service","effectContext","gen","services","context","pipe","omit","middleware","isEffect","makeUnsafe","Map","updateContext","requestContext","merge"],"sources":["../../../src/unstable/rpc/RpcMiddleware.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,SAASC,KAAK,QAAQ,gBAAgB;AActC;;;;;;AAMA,OAAO,MAAMC,MAAM,GAAW,2BAA2B;AAqNzD;;;;;;;;AAQA,OAAO,MAAMC,OAAO,GAAGA,CAAA,KA8BvB,CACEC,EAAU,EACVC,OAGC,KACC;EACF,MAAMC,GAAG,GAAGC,UAAU,CAACC,KAAY;EACnC,MAAMC,KAAK,GAAGH,GAAG,CAACI,eAAe;EACjCJ,GAAG,CAACI,eAAe,GAAG,CAAC;EACvB,MAAMC,aAAa,GAAG,IAAIL,GAAG,EAAE;EAC/BA,GAAG,CAACI,eAAe,GAAGD,KAAK;EAE3B,SAASG,YAAYA,CAAA,GAAI;EACzB,MAAMC,aAAa,GAAGD,YAA0C;EAChEE,MAAM,CAACC,cAAc,CAACH,YAAY,EAAEE,MAAM,CAACE,cAAc,CAACnB,OAAO,CAACM,OAAO,CAAYC,EAAE,CAAC,CAAC,CAAC;EAC1FQ,YAAY,CAACK,GAAG,GAAGb,EAAE;EACrBU,MAAM,CAACI,cAAc,CAACN,YAAY,EAAE,OAAO,EAAE;IAC3CO,GAAGA,CAAA;MACD,OAAOR,aAAa,CAACS,KAAK;IAC5B;GACD,CAAC;EACFP,aAAa,CAACX,MAAM,CAAC,GAAGA,MAAM;EAC9BW,aAAa,CAACQ,KAAK,GAAGhB,OAAO,EAAEgB,KAAK,IAAIrB,MAAM,CAACsB,KAAK;EACpDT,aAAa,CAACU,iBAAiB,GAAGlB,OAAO,EAAEkB,iBAAiB,IAAI,KAAK;EACrE,OAAOX,YAAmB;AAC5B,CAAC;AAED;;;;;;;;AAQA,OAAO,MAAMY,WAAW,GAAGA,CACzBC,GAAuB,EACvBC,OAEyG,KAEzG3B,KAAK,CAAC4B,aAAa,CAAC7B,MAAM,CAAC8B,GAAG,CAAC,aAAS;EACtC,MAAMC,QAAQ,GAAG,CAAC,OAAO/B,MAAM,CAACgC,OAAO,EAAa,EAAEC,IAAI,CACxDlC,OAAO,CAACmC,IAAI,CAAC/B,KAAK,CAAC,CACE;EACvB,MAAMgC,UAAU,GAAGnC,MAAM,CAACoC,QAAQ,CAACR,OAAO,CAAC,GAAG,OAAOA,OAAO,GAAGA,OAAO;EACtE,OAAO7B,OAAO,CAACsC,UAAU,CACvB,IAAIC,GAAG,CAAC,CAAC,CACP,GAAGX,GAAG,CAACR,GAAG,SAAS,EAClBZ,OAAY,IACXP,MAAM,CAACuC,aAAa,CAClBJ,UAAU,CAAC5B,OAAO,CAAC,EAClBiC,cAAc,IAAKzC,OAAO,CAAC0C,KAAK,CAACV,QAAQ,EAAES,cAAc,CAAC,CAC5D,CACJ,CAAC,CAAC,CACJ;AACH,CAAC,CAAC,CAAC","ignoreList":[]}

package/dist/unstable/rpc/RpcSchema.d.ts

@@ -1,4 +1,26 @@
 /**
+ * The `RpcSchema` module contains the RPC-specific schema markers and cause
+ * annotations shared by the RPC declaration, client, and server layers. It is
+ * used when an RPC response is a `Stream`, and when server-side interruption
+ * logic needs to identify a client-initiated abort.
+ *
+ * Use {@link Stream} to mark an RPC success schema as a streamed response,
+ * {@link isStreamSchema} to detect that marker, and the stored success and
+ * error schemas to encode or decode stream chunks. Request payload schemas live
+ * on the `Rpc` definition itself; this module only describes the streamed
+ * response shape. For streaming RPCs, the success schema passed to
+ * `RpcSchema.Stream` is the stream element schema, while the error schema is
+ * the stream error schema. When the marker is installed by the `Rpc`
+ * constructor's `stream` option, the immediate RPC exit succeeds with `void`,
+ * the ordinary RPC error schema is set to `Schema.Never`, and the stream error
+ * schema is used for stream failures.
+ *
+ * Streaming schemas are not general-purpose codecs for arbitrary stream values:
+ * they are RPC metadata that lets the protocol distinguish one-shot successes
+ * from streamed elements and keep stream errors on the chunk stream. Use
+ * {@link ClientAbort} when annotating interruptions caused by a remote client
+ * closing or cancelling a request.
+ *
  * @since 4.0.0
  */
 import * as Cause from "../../Cause.ts";
@@ -8,13 +30,19 @@ import type * as AST from "../../SchemaAST.ts";
 import * as Stream_ from "../../Stream.ts";
 declare const StreamSchemaTypeId = "~effect/rpc/RpcSchema/StreamSchema";
 /**
- * @since 4.0.0
+ * Returns `true` when a schema is an RPC stream schema created by
+ * `RpcSchema.Stream`.
+ *
  * @category Stream
+ * @since 4.0.0
  */
 export declare function isStreamSchema(schema: Schema.Top): schema is Stream<Schema.Top, Schema.Top>;
 /**
- * @since 4.0.0
+ * A schema marker for RPC streaming responses, storing the success element
+ * schema and stream error schema used for encoding and decoding stream chunks.
+ *
  * @category Stream
+ * @since 4.0.0
  */
 export interface Stream<A extends Schema.Top, E extends Schema.Top> extends Schema.Bottom<Stream_.Stream<A["Type"], E["Type"]>, Stream_.Stream<A["Encoded"], E["Encoded"]>, A["DecodingServices"] | E["DecodingServices"], A["EncodingServices"] | E["EncodingServices"], AST.Declaration, Stream<A, E>> {
     readonly "Rebuild": Stream<A, E>;
@@ -23,14 +51,20 @@ export interface Stream<A extends Schema.Top, E extends Schema.Top> extends Sche
     readonly error: E;
 }
 /**
- * @since 4.0.0
+ * Creates an RPC stream schema from a stream element success schema and stream
+ * error schema.
+ *
  * @category Stream
+ * @since 4.0.0
  */
 export declare function Stream<A extends Schema.Top, E extends Schema.Top>(success: A, error: E): Stream<A, E>;
 declare const ClientAbort_base: Context.ServiceClass<ClientAbort, "effect/rpc/RpcSchema/ClientAbort", true>;
 /**
- * @since 4.0.0
+ * Cause annotation used to mark interruptions that originate from an RPC client
+ * abort.
+ *
  * @category Cause annotations
+ * @since 4.0.0
  */
 export declare class ClientAbort extends ClientAbort_base {
     static annotation: Context.Context<Cause.StackTrace | ClientAbort>;

package/dist/unstable/rpc/RpcSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RpcSchema.d.ts","sourceRoot":"","sources":["../../../src/unstable/rpc/RpcSchema.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAI3C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,OAAO,MAAM,iBAAiB,CAAA;AAE1C,QAAA,MAAM,kBAAkB,uCAAuC,CAAA;AAE/D;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,GAAG,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAE3F;AAeD;;;GAGG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,MAAM,CAAC,GAAG,CAAE,SAClE,MAAM,CAAC,MAAM,CACX,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EACpC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAC1C,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,kBAAkB,CAAC,EAC7C,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,kBAAkB,CAAC,EAC7C,GAAG,CAAC,WAAW,EACf,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CACb;IAED,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAChC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,EAAE,OAAO,kBAAkB,CAAA;IACxD,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;IACnB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAClB;AAID;;;GAGG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAErG;;AAED;;;GAGG;AACH,qBAAa,WAAY,SAAQ,gBAAwE;IACvG,MAAM,CAAC,UAAU,kDAMhB;CACF"}
+{"version":3,"file":"RpcSchema.d.ts","sourceRoot":"","sources":["../../../src/unstable/rpc/RpcSchema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAI3C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,OAAO,MAAM,iBAAiB,CAAA;AAE1C,QAAA,MAAM,kBAAkB,uCAAuC,CAAA;AAE/D;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,GAAG,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAE3F;AAeD;;;;;;GAMG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,MAAM,CAAC,GAAG,CAAE,SAClE,MAAM,CAAC,MAAM,CACX,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EACpC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAC1C,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,kBAAkB,CAAC,EAC7C,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,kBAAkB,CAAC,EAC7C,GAAG,CAAC,WAAW,EACf,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CACb;IAED,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAChC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,EAAE,OAAO,kBAAkB,CAAA;IACxD,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;IACnB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAClB;AAID;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAErG;;AAED;;;;;;GAMG;AACH,qBAAa,WAAY,SAAQ,gBAAwE;IACvG,MAAM,CAAC,UAAU,kDAMhB;CACF"}

package/dist/unstable/rpc/RpcSchema.js

@@ -1,4 +1,26 @@
 /**
+ * The `RpcSchema` module contains the RPC-specific schema markers and cause
+ * annotations shared by the RPC declaration, client, and server layers. It is
+ * used when an RPC response is a `Stream`, and when server-side interruption
+ * logic needs to identify a client-initiated abort.
+ *
+ * Use {@link Stream} to mark an RPC success schema as a streamed response,
+ * {@link isStreamSchema} to detect that marker, and the stored success and
+ * error schemas to encode or decode stream chunks. Request payload schemas live
+ * on the `Rpc` definition itself; this module only describes the streamed
+ * response shape. For streaming RPCs, the success schema passed to
+ * `RpcSchema.Stream` is the stream element schema, while the error schema is
+ * the stream error schema. When the marker is installed by the `Rpc`
+ * constructor's `stream` option, the immediate RPC exit succeeds with `void`,
+ * the ordinary RPC error schema is set to `Schema.Never`, and the stream error
+ * schema is used for stream failures.
+ *
+ * Streaming schemas are not general-purpose codecs for arbitrary stream values:
+ * they are RPC metadata that lets the protocol distinguish one-shot successes
+ * from streamed elements and keep stream errors on the chunk stream. Use
+ * {@link ClientAbort} when annotating interruptions caused by a remote client
+ * closing or cancelling a request.
+ *
  * @since 4.0.0
  */
 import * as Cause from "../../Cause.js";
@@ -10,8 +32,11 @@ import * as Schema from "../../Schema.js";
 import * as Stream_ from "../../Stream.js";
 const StreamSchemaTypeId = "~effect/rpc/RpcSchema/StreamSchema";
 /**
- * @since 4.0.0
+ * Returns `true` when a schema is an RPC stream schema created by
+ * `RpcSchema.Stream`.
+ *
  * @category Stream
+ * @since 4.0.0
  */
 export function isStreamSchema(schema) {
   return Predicate.hasProperty(schema, StreamSchemaTypeId);
@@ -25,8 +50,11 @@ export function getStreamSchemas(schema) {
 }
 const schema = /*#__PURE__*/Schema.declare(Stream_.isStream);
 /**
- * @since 4.0.0
+ * Creates an RPC stream schema from a stream element success schema and stream
+ * error schema.
+ *
  * @category Stream
+ * @since 4.0.0
  */
 export function Stream(success, error) {
   return Schema.make(schema.ast, {
@@ -36,8 +64,11 @@ export function Stream(success, error) {
   });
 }
 /**
- * @since 4.0.0
+ * Cause annotation used to mark interruptions that originate from an RPC client
+ * abort.
+ *
  * @category Cause annotations
+ * @since 4.0.0
  */
 export class ClientAbort extends /*#__PURE__*/Context.Service()("effect/rpc/RpcSchema/ClientAbort") {
   static annotation = /*#__PURE__*/this.context(true).pipe(/*#__PURE__*/Context.add(Cause.StackTrace, {

package/dist/unstable/rpc/RpcSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"RpcSchema.js","names":["Cause","Context","constUndefined","Option","Predicate","Schema","Stream_","StreamSchemaTypeId","isStreamSchema","schema","hasProperty","getStreamSchemas","some","success","error","none","declare","isStream","Stream","make","ast","ClientAbort","Service","annotation","context","pipe","add","StackTrace","name","stack","parent","undefined"],"sources":["../../../src/unstable/rpc/RpcSchema.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,OAAO,MAAM,kBAAkB;AAC3C,SAASC,cAAc,QAAQ,mBAAmB;AAClD,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,SAAS,MAAM,oBAAoB;AAC/C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAEzC,OAAO,KAAKC,OAAO,MAAM,iBAAiB;AAE1C,MAAMC,kBAAkB,GAAG,oCAAoC;AAE/D;;;;AAIA,OAAM,SAAUC,cAAcA,CAACC,MAAkB;EAC/C,OAAOL,SAAS,CAACM,WAAW,CAACD,MAAM,EAAEF,kBAAkB,CAAC;AAC1D;AAEA;AACA,OAAM,SAAUI,gBAAgBA,CAACF,MAAkB;EAIjD,OAAOD,cAAc,CAACC,MAAM,CAAC,GAC3BN,MAAM,CAACS,IAAI,CAAC;IACVC,OAAO,EAAEJ,MAAM,CAACI,OAAO;IACvBC,KAAK,EAAEL,MAAM,CAACK;GACf,CAAC,GACFX,MAAM,CAACY,IAAI,EAAE;AACjB;AAsBA,MAAMN,MAAM,gBAAGJ,MAAM,CAACW,OAAO,CAACV,OAAO,CAACW,QAAQ,CAAC;AAE/C;;;;AAIA,OAAM,SAAUC,MAAMA,CAA6CL,OAAU,EAAEC,KAAQ;EACrF,OAAOT,MAAM,CAACc,IAAI,CAACV,MAAM,CAACW,GAAG,EAAE;IAAE,CAACb,kBAAkB,GAAGA,kBAAkB;IAAEM,OAAO;IAAEC;EAAK,CAAE,CAAC;AAC9F;AAEA;;;;AAIA,OAAM,MAAOO,WAAY,sBAAQpB,OAAO,CAACqB,OAAO,EAAqB,CAAC,kCAAkC,CAAC;EACvG,OAAOC,UAAU,gBAAG,IAAI,CAACC,OAAO,CAAC,IAAI,CAAC,CAACC,IAAI,cACzCxB,OAAO,CAACyB,GAAG,CAAC1B,KAAK,CAAC2B,UAAU,EAAE;IAC5BC,IAAI,EAAE,aAAa;IACnBC,KAAK,EAAE3B,cAAc;IACrB4B,MAAM,EAAEC;GACT,CAAC,CACH","ignoreList":[]}
+{"version":3,"file":"RpcSchema.js","names":["Cause","Context","constUndefined","Option","Predicate","Schema","Stream_","StreamSchemaTypeId","isStreamSchema","schema","hasProperty","getStreamSchemas","some","success","error","none","declare","isStream","Stream","make","ast","ClientAbort","Service","annotation","context","pipe","add","StackTrace","name","stack","parent","undefined"],"sources":["../../../src/unstable/rpc/RpcSchema.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,KAAKA,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,OAAO,MAAM,kBAAkB;AAC3C,SAASC,cAAc,QAAQ,mBAAmB;AAClD,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,SAAS,MAAM,oBAAoB;AAC/C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAEzC,OAAO,KAAKC,OAAO,MAAM,iBAAiB;AAE1C,MAAMC,kBAAkB,GAAG,oCAAoC;AAE/D;;;;;;;AAOA,OAAM,SAAUC,cAAcA,CAACC,MAAkB;EAC/C,OAAOL,SAAS,CAACM,WAAW,CAACD,MAAM,EAAEF,kBAAkB,CAAC;AAC1D;AAEA;AACA,OAAM,SAAUI,gBAAgBA,CAACF,MAAkB;EAIjD,OAAOD,cAAc,CAACC,MAAM,CAAC,GAC3BN,MAAM,CAACS,IAAI,CAAC;IACVC,OAAO,EAAEJ,MAAM,CAACI,OAAO;IACvBC,KAAK,EAAEL,MAAM,CAACK;GACf,CAAC,GACFX,MAAM,CAACY,IAAI,EAAE;AACjB;AAyBA,MAAMN,MAAM,gBAAGJ,MAAM,CAACW,OAAO,CAACV,OAAO,CAACW,QAAQ,CAAC;AAE/C;;;;;;;AAOA,OAAM,SAAUC,MAAMA,CAA6CL,OAAU,EAAEC,KAAQ;EACrF,OAAOT,MAAM,CAACc,IAAI,CAACV,MAAM,CAACW,GAAG,EAAE;IAAE,CAACb,kBAAkB,GAAGA,kBAAkB;IAAEM,OAAO;IAAEC;EAAK,CAAE,CAAC;AAC9F;AAEA;;;;;;;AAOA,OAAM,MAAOO,WAAY,sBAAQpB,OAAO,CAACqB,OAAO,EAAqB,CAAC,kCAAkC,CAAC;EACvG,OAAOC,UAAU,gBAAG,IAAI,CAACC,OAAO,CAAC,IAAI,CAAC,CAACC,IAAI,cACzCxB,OAAO,CAACyB,GAAG,CAAC1B,KAAK,CAAC2B,UAAU,EAAE;IAC5BC,IAAI,EAAE,aAAa;IACnBC,KAAK,EAAE3B,cAAc;IACrB4B,MAAM,EAAEC;GACT,CAAC,CACH","ignoreList":[]}