effect 4.0.0-beta.65 → 4.0.0-beta.67

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

@@ -1,4 +1,21 @@
 /**
+ * Defines the protocol message envelopes shared by unstable RPC clients,
+ * servers, and transports.
+ *
+ * This module is used when implementing or testing RPC transports, codecs, and
+ * protocol handlers. It separates decoded messages, which carry typed RPC tags,
+ * payloads, headers, exits, and branded request identifiers, from encoded
+ * messages, which are suitable for transport boundaries where request ids and
+ * payloads have already been serialized.
+ *
+ * Request identifiers are the correlation point for requests, response chunks,
+ * terminal exits, acknowledgements, and interrupts, so transports must preserve
+ * them across the encoded string form and the decoded branded form. Streaming
+ * responses can send one or more `Chunk` batches before a terminal `Exit`; use
+ * `Ack` messages only for transports that require backpressure, treat `Eof` as
+ * the end of client input, and reserve `Ping`/`Pong` for connection liveness
+ * rather than RPC completion.
+ *
  * @since 4.0.0
  */
 import type { NonEmptyReadonlyArray } from "../../Array.ts";
@@ -7,28 +24,40 @@ import type { Headers } from "../http/Headers.ts";
 import type * as Rpc from "./Rpc.ts";
 import type { RpcClientError } from "./RpcClientError.ts";
 /**
- * @since 4.0.0
+ * Decoded messages that can be sent from an RPC client to a server.
+ *
  * @category request
+ * @since 4.0.0
  */
 export type FromClient<A extends Rpc.Any> = Request<A> | Ack | Interrupt | Eof;
 /**
- * @since 4.0.0
+ * Transport-encoded messages that can be sent from an RPC client to a server.
+ *
  * @category request
+ * @since 4.0.0
  */
 export type FromClientEncoded = RequestEncoded | AckEncoded | InterruptEncoded | Ping | Eof;
 /**
- * @since 4.0.0
+ * A branded request identifier used to correlate RPC requests, responses,
+ * chunks, acknowledgements, and interrupts.
+ *
  * @category request
+ * @since 4.0.0
  */
 export type RequestId = Branded<bigint, "~effect/rpc/RpcMessage/RequestId">;
 /**
- * @since 4.0.0
+ * Converts a bigint or string request id into the branded `RequestId` type.
+ *
  * @category request
+ * @since 4.0.0
  */
 export declare const RequestId: (id: bigint | string) => RequestId;
 /**
- * @since 4.0.0
+ * The transport-encoded RPC request envelope, including the string request id,
+ * RPC tag, encoded payload, headers, and optional trace context.
+ *
  * @category request
+ * @since 4.0.0
  */
 export interface RequestEncoded {
     readonly _tag: "Request";
@@ -41,8 +70,11 @@ export interface RequestEncoded {
     readonly sampled?: boolean;
 }
 /**
- * @since 4.0.0
+ * The decoded RPC request envelope for an RPC union, carrying a branded request
+ * id, typed RPC tag, decoded payload, headers, and optional trace context.
+ *
  * @category request
+ * @since 4.0.0
  */
 export interface Request<A extends Rpc.Any> {
     readonly _tag: "Request";
@@ -55,16 +87,21 @@ export interface Request<A extends Rpc.Any> {
     readonly sampled?: boolean;
 }
 /**
- * @since 4.0.0
+ * A decoded acknowledgement for a streamed RPC response chunk.
+ *
  * @category request
+ * @since 4.0.0
  */
 export interface Ack {
     readonly _tag: "Ack";
     readonly requestId: RequestId;
 }
 /**
- * @since 4.0.0
+ * A decoded request to interrupt an in-flight RPC, carrying the request id and
+ * interrupting fiber ids.
+ *
  * @category request
+ * @since 4.0.0
  */
 export interface Interrupt {
     readonly _tag: "Interrupt";
@@ -72,73 +109,100 @@ export interface Interrupt {
     readonly interruptors: ReadonlyArray<number>;
 }
 /**
- * @since 4.0.0
+ * The transport-encoded acknowledgement for a streamed RPC response chunk.
+ *
  * @category request
+ * @since 4.0.0
  */
 export interface AckEncoded {
     readonly _tag: "Ack";
     readonly requestId: string;
 }
 /**
- * @since 4.0.0
+ * The transport-encoded request to interrupt an in-flight RPC.
+ *
  * @category request
+ * @since 4.0.0
  */
 export interface InterruptEncoded {
     readonly _tag: "Interrupt";
     readonly requestId: string;
 }
 /**
- * @since 4.0.0
+ * A client-to-server message indicating that the client has finished sending
+ * input for the current connection or request batch.
+ *
  * @category request
+ * @since 4.0.0
  */
 export interface Eof {
     readonly _tag: "Eof";
 }
 /**
- * @since 4.0.0
+ * A client-to-server keepalive message used by protocols that monitor
+ * connection liveness.
+ *
  * @category request
+ * @since 4.0.0
  */
 export interface Ping {
     readonly _tag: "Ping";
 }
 /**
- * @since 4.0.0
+ * The reusable `Eof` message value.
+ *
  * @category request
+ * @since 4.0.0
  */
 export declare const constEof: Eof;
 /**
- * @since 4.0.0
+ * The reusable `Ping` message value.
+ *
  * @category request
+ * @since 4.0.0
  */
 export declare const constPing: Ping;
 /**
- * @since 4.0.0
+ * Decoded messages that can be sent from an RPC server to a client.
+ *
  * @category response
+ * @since 4.0.0
  */
 export type FromServer<A extends Rpc.Any> = ResponseChunk<A> | ResponseExit<A> | ResponseDefect | ClientEnd;
 /**
- * @since 4.0.0
+ * Transport-encoded messages that can be sent from an RPC server to a client.
+ *
  * @category response
+ * @since 4.0.0
  */
 export type FromServerEncoded = ResponseChunkEncoded | ResponseExitEncoded | ResponseDefectEncoded | Pong | ClientProtocolError;
 /**
- * @since 4.0.0
+ * The brand identifier used by the `ResponseId` type.
+ *
  * @category response
+ * @since 4.0.0
  */
 export declare const ResponseIdTypeId = "~effect//rpc/RpcServer/ResponseId";
 /**
- * @since 4.0.0
+ * The literal type of the `ResponseId` brand identifier.
+ *
  * @category response
+ * @since 4.0.0
  */
 export type ResponseIdTypeId = typeof ResponseIdTypeId;
 /**
- * @since 4.0.0
+ * A branded numeric identifier for server responses.
+ *
  * @category response
+ * @since 4.0.0
  */
 export type ResponseId = Branded<number, ResponseIdTypeId>;
 /**
- * @since 4.0.0
+ * The transport-encoded response message containing a non-empty batch of stream
+ * chunk values for a request.
+ *
  * @category response
+ * @since 4.0.0
  */
 export interface ResponseChunkEncoded {
     readonly _tag: "Chunk";
@@ -146,8 +210,11 @@ export interface ResponseChunkEncoded {
     readonly values: NonEmptyReadonlyArray<unknown>;
 }
 /**
- * @since 4.0.0
+ * The decoded response message containing a non-empty batch of stream chunk
+ * values for a specific client and request.
+ *
  * @category response
+ * @since 4.0.0
  */
 export interface ResponseChunk<A extends Rpc.Any> {
     readonly _tag: "Chunk";
@@ -156,8 +223,11 @@ export interface ResponseChunk<A extends Rpc.Any> {
     readonly values: NonEmptyReadonlyArray<Rpc.SuccessChunk<A>>;
 }
 /**
- * @since 4.0.0
+ * The transport representation of an RPC `Exit`, encoding success values or a
+ * failure cause made of failures, defects, and interrupts.
+ *
  * @category response
+ * @since 4.0.0
  */
 export type ExitEncoded<A, E> = {
     readonly _tag: "Success";
@@ -176,8 +246,11 @@ export type ExitEncoded<A, E> = {
     }>;
 };
 /**
- * @since 4.0.0
+ * The transport-encoded terminal response for a request, carrying the encoded
+ * `Exit`.
+ *
  * @category response
+ * @since 4.0.0
  */
 export interface ResponseExitEncoded {
     readonly _tag: "Exit";
@@ -185,16 +258,22 @@ export interface ResponseExitEncoded {
     readonly exit: ExitEncoded<unknown, unknown>;
 }
 /**
- * @since 4.0.0
+ * A server-to-client protocol message reporting a client protocol error to all
+ * affected in-flight requests.
+ *
  * @category response
+ * @since 4.0.0
  */
 export interface ClientProtocolError {
     readonly _tag: "ClientProtocolError";
     readonly error: RpcClientError;
 }
 /**
- * @since 4.0.0
+ * The decoded terminal response for a request, carrying the typed `Rpc.Exit`
+ * for the RPC.
+ *
  * @category response
+ * @since 4.0.0
  */
 export interface ResponseExit<A extends Rpc.Any> {
     readonly _tag: "Exit";
@@ -203,29 +282,40 @@ export interface ResponseExit<A extends Rpc.Any> {
     readonly exit: Rpc.Exit<A>;
 }
 /**
- * @since 4.0.0
+ * The transport-encoded server defect message used for protocol-level defects
+ * that affect the client connection.
+ *
  * @category response
+ * @since 4.0.0
  */
 export interface ResponseDefectEncoded {
     readonly _tag: "Defect";
     readonly defect: unknown;
 }
 /**
- * @since 4.0.0
+ * Creates an encoded terminal response for a request whose exit is a defect
+ * encoded with `Schema.Defect`.
+ *
  * @category response
+ * @since 4.0.0
  */
 export declare const ResponseExitDieEncoded: (options: {
     readonly requestId: RequestId;
     readonly defect: unknown;
 }) => ResponseExitEncoded;
 /**
- * @since 4.0.0
+ * Creates a transport-encoded defect response by encoding the input with
+ * `Schema.Defect`.
+ *
  * @category response
+ * @since 4.0.0
  */
 export declare const ResponseDefectEncoded: (input: unknown) => ResponseDefectEncoded;
 /**
- * @since 4.0.0
+ * The decoded server defect message for a client connection.
+ *
  * @category response
+ * @since 4.0.0
  */
 export interface ResponseDefect {
     readonly _tag: "Defect";
@@ -233,23 +323,29 @@ export interface ResponseDefect {
     readonly defect: unknown;
 }
 /**
- * @since 4.0.0
+ * A server message indicating that the client connection has ended.
+ *
  * @category response
+ * @since 4.0.0
  */
 export interface ClientEnd {
     readonly _tag: "ClientEnd";
     readonly clientId: number;
 }
 /**
- * @since 4.0.0
+ * A server-to-client keepalive response to a `Ping` message.
+ *
  * @category response
+ * @since 4.0.0
  */
 export interface Pong {
     readonly _tag: "Pong";
 }
 /**
- * @since 4.0.0
+ * The reusable `Pong` message value.
+ *
  * @category response
+ * @since 4.0.0
  */
 export declare const constPong: Pong;
 //# sourceMappingURL=RpcMessage.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"RpcMessage.d.ts","sourceRoot":"","sources":["../../../src/unstable/rpc/RpcMessage.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAE7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,KAAK,KAAK,GAAG,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEzD;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,SAAS,GAAG,GAAG,CAAA;AAE9E;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,cAAc,GAAG,UAAU,GAAG,gBAAgB,GAAG,IAAI,GAAG,GAAG,CAAA;AAE3F;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,kCAAkC,CAAC,CAAA;AAE3E;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,IAAI,MAAM,GAAG,MAAM,KAAG,SACoB,CAAA;AAEpE;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG;IACxC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAA;IACtB,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACxB,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IAChC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;IACpB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AAED;;;GAGG;AACH,eAAO,MAAM,QAAQ,EAAE,GAAqB,CAAA;AAE5C;;;GAGG;AACH,eAAO,MAAM,SAAS,EAAE,IAAuB,CAAA;AAE/C;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG,IACpC,aAAa,CAAC,CAAC,CAAC,GAChB,YAAY,CAAC,CAAC,CAAC,GACf,cAAc,GACd,SAAS,CAAA;AAEb;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GACzB,oBAAoB,GACpB,mBAAmB,GACnB,qBAAqB,GACrB,IAAI,GACJ,mBAAmB,CAAA;AAEvB;;;GAGG;AACH,eAAO,MAAM,gBAAgB,sCAAsC,CAAA;AAEnE;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAA;AAEtD;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;AAE1D;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC,OAAO,CAAC,CAAA;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG;IAC9C,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5D;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI;IAC9B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAClB,GAAG;IACF,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB,QAAQ,CAAC,KAAK,EAAE,aAAa,CAC3B;QACE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;KAClB,GAAG;QACF,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;QACpB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;KACzB,GAAG;QACF,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;QAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;KACrC,CACF,CAAA;CACF,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,qBAAqB,CAAA;IACpC,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAA;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG;IAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;CACzB;AAID;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GAAI,SAAS;IAC9C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;CACzB,KAAG,mBAUF,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,GAAI,OAAO,OAAO,KAAG,qBAGrD,CAAA;AAEF;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AAED;;;GAGG;AACH,eAAO,MAAM,SAAS,EAAE,IAAuB,CAAA"}
+{"version":3,"file":"RpcMessage.d.ts","sourceRoot":"","sources":["../../../src/unstable/rpc/RpcMessage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAE7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,KAAK,KAAK,GAAG,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEzD;;;;;GAKG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,SAAS,GAAG,GAAG,CAAA;AAE9E;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,cAAc,GAAG,UAAU,GAAG,gBAAgB,GAAG,IAAI,GAAG,GAAG,CAAA;AAE3F;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,kCAAkC,CAAC,CAAA;AAE3E;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,IAAI,MAAM,GAAG,MAAM,KAAG,SACoB,CAAA;AAEpE;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG;IACxC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAA;IACtB,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACxB,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IAChC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAC3B;AAED;;;;;GAKG;AACH,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;IACpB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;CAC9B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;CAC7C;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;CAC3B;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AAED;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,EAAE,GAAqB,CAAA;AAE5C;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE,IAAuB,CAAA;AAE/C;;;;;GAKG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG,IACpC,aAAa,CAAC,CAAC,CAAC,GAChB,YAAY,CAAC,CAAC,CAAC,GACf,cAAc,GACd,SAAS,CAAA;AAEb;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GACzB,oBAAoB,GACpB,mBAAmB,GACnB,qBAAqB,GACrB,IAAI,GACJ,mBAAmB,CAAA;AAEvB;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,sCAAsC,CAAA;AAEnE;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAA;AAEtD;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;AAE1D;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC,OAAO,CAAC,CAAA;CAChD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG;IAC9C,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5D;AAED;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI;IAC9B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAClB,GAAG;IACF,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB,QAAQ,CAAC,KAAK,EAAE,aAAa,CAC3B;QACE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;KAClB,GAAG;QACF,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;QACpB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;KACzB,GAAG;QACF,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;QAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;KACrC,CACF,CAAA;CACF,CAAA;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;CAC7C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,qBAAqB,CAAA;IACpC,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAA;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG;IAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;CACzB;AAID;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,GAAI,SAAS;IAC9C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;CACzB,KAAG,mBAUF,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAAI,OAAO,OAAO,KAAG,qBAGrD,CAAA;AAEF;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE,IAAuB,CAAA"}

package/dist/unstable/rpc/RpcMessage.js

@@ -1,32 +1,43 @@
 import * as Schema from "../../Schema.js";
 /**
- * @since 4.0.0
+ * Converts a bigint or string request id into the branded `RequestId` type.
+ *
  * @category request
+ * @since 4.0.0
  */
 export const RequestId = id => typeof id === "bigint" ? id : BigInt(id);
 /**
- * @since 4.0.0
+ * The reusable `Eof` message value.
+ *
  * @category request
+ * @since 4.0.0
  */
 export const constEof = {
   _tag: "Eof"
 };
 /**
- * @since 4.0.0
+ * The reusable `Ping` message value.
+ *
  * @category request
+ * @since 4.0.0
  */
 export const constPing = {
   _tag: "Ping"
 };
 /**
- * @since 4.0.0
+ * The brand identifier used by the `ResponseId` type.
+ *
  * @category response
+ * @since 4.0.0
  */
 export const ResponseIdTypeId = "~effect//rpc/RpcServer/ResponseId";
 const encodeDefect = /*#__PURE__*/Schema.encodeSync(Schema.Defect);
 /**
- * @since 4.0.0
+ * Creates an encoded terminal response for a request whose exit is a defect
+ * encoded with `Schema.Defect`.
+ *
  * @category response
+ * @since 4.0.0
  */
 export const ResponseExitDieEncoded = options => ({
   _tag: "Exit",
@@ -40,16 +51,21 @@ export const ResponseExitDieEncoded = options => ({
   }
 });
 /**
- * @since 4.0.0
+ * Creates a transport-encoded defect response by encoding the input with
+ * `Schema.Defect`.
+ *
  * @category response
+ * @since 4.0.0
  */
 export const ResponseDefectEncoded = input => ({
   _tag: "Defect",
   defect: encodeDefect(input)
 });
 /**
- * @since 4.0.0
+ * The reusable `Pong` message value.
+ *
  * @category response
+ * @since 4.0.0
  */
 export const constPong = {
   _tag: "Pong"

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

@@ -1 +1 @@
-{"version":3,"file":"RpcMessage.js","names":["Schema","RequestId","id","BigInt","constEof","_tag","constPing","ResponseIdTypeId","encodeDefect","encodeSync","Defect","ResponseExitDieEncoded","options","requestId","toString","exit","cause","defect","ResponseDefectEncoded","input","constPong"],"sources":["../../../src/unstable/rpc/RpcMessage.ts"],"sourcesContent":[null],"mappings":"AAKA,OAAO,KAAKA,MAAM,MAAM,iBAAiB;AAuBzC;;;;AAIA,OAAO,MAAMC,SAAS,GAAIC,EAAmB,IAC3C,OAAOA,EAAE,KAAK,QAAQ,GAAGA,EAAe,GAAGC,MAAM,CAACD,EAAE,CAAc;AAqFpE;;;;AAIA,OAAO,MAAME,QAAQ,GAAQ;EAAEC,IAAI,EAAE;AAAK,CAAE;AAE5C;;;;AAIA,OAAO,MAAMC,SAAS,GAAS;EAAED,IAAI,EAAE;AAAM,CAAE;AAuB/C;;;;AAIA,OAAO,MAAME,gBAAgB,GAAG,mCAAmC;AAiGnE,MAAMC,YAAY,gBAAGR,MAAM,CAACS,UAAU,CAACT,MAAM,CAACU,MAAM,CAAC;AAErD;;;;AAIA,OAAO,MAAMC,sBAAsB,GAAIC,OAGtC,KAA2B;EAC1BP,IAAI,EAAE,MAAM;EACZQ,SAAS,EAAED,OAAO,CAACC,SAAS,CAACC,QAAQ,EAAE;EACvCC,IAAI,EAAE;IACJV,IAAI,EAAE,SAAS;IACfW,KAAK,EAAE,CAAC;MACNX,IAAI,EAAE,KAAK;MACXY,MAAM,EAAET,YAAY,CAACI,OAAO,CAACK,MAAM;KACpC;;CAEJ,CAAC;AAEF;;;;AAIA,OAAO,MAAMC,qBAAqB,GAAIC,KAAc,KAA6B;EAC/Ed,IAAI,EAAE,QAAQ;EACdY,MAAM,EAAET,YAAY,CAACW,KAAK;CAC3B,CAAC;AA6BF;;;;AAIA,OAAO,MAAMC,SAAS,GAAS;EAAEf,IAAI,EAAE;AAAM,CAAE","ignoreList":[]}
+{"version":3,"file":"RpcMessage.js","names":["Schema","RequestId","id","BigInt","constEof","_tag","constPing","ResponseIdTypeId","encodeDefect","encodeSync","Defect","ResponseExitDieEncoded","options","requestId","toString","exit","cause","defect","ResponseDefectEncoded","input","constPong"],"sources":["../../../src/unstable/rpc/RpcMessage.ts"],"sourcesContent":[null],"mappings":"AAsBA,OAAO,KAAKA,MAAM,MAAM,iBAAiB;AA8BzC;;;;;;AAMA,OAAO,MAAMC,SAAS,GAAIC,EAAmB,IAC3C,OAAOA,EAAE,KAAK,QAAQ,GAAGA,EAAe,GAAGC,MAAM,CAACD,EAAE,CAAc;AA0GpE;;;;;;AAMA,OAAO,MAAME,QAAQ,GAAQ;EAAEC,IAAI,EAAE;AAAK,CAAE;AAE5C;;;;;;AAMA,OAAO,MAAMC,SAAS,GAAS;EAAED,IAAI,EAAE;AAAM,CAAE;AA2B/C;;;;;;AAMA,OAAO,MAAME,gBAAgB,GAAG,mCAAmC;AA0HnE,MAAMC,YAAY,gBAAGR,MAAM,CAACS,UAAU,CAACT,MAAM,CAACU,MAAM,CAAC;AAErD;;;;;;;AAOA,OAAO,MAAMC,sBAAsB,GAAIC,OAGtC,KAA2B;EAC1BP,IAAI,EAAE,MAAM;EACZQ,SAAS,EAAED,OAAO,CAACC,SAAS,CAACC,QAAQ,EAAE;EACvCC,IAAI,EAAE;IACJV,IAAI,EAAE,SAAS;IACfW,KAAK,EAAE,CAAC;MACNX,IAAI,EAAE,KAAK;MACXY,MAAM,EAAET,YAAY,CAACI,OAAO,CAACK,MAAM;KACpC;;CAEJ,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAMC,qBAAqB,GAAIC,KAAc,KAA6B;EAC/Ed,IAAI,EAAE,QAAQ;EACdY,MAAM,EAAET,YAAY,CAACW,KAAK;CAC3B,CAAC;AAmCF;;;;;;AAMA,OAAO,MAAMC,SAAS,GAAS;EAAEf,IAAI,EAAE;AAAM,CAAE","ignoreList":[]}