effect 4.0.0-beta.98 → 4.0.0-rc.108

package/src/unstable/rpc/RpcMessage.ts

@@ -20,7 +20,7 @@ import type { RpcClientError } from "./RpcClientError.ts"
 /**
  * Decoded messages that can be sent from an RPC client to a server.
  *
- * @category request
+ * @category models
  * @since 4.0.0
  */
 export type FromClient<A extends Rpc.Any> = Request<A> | Ack | Interrupt | Eof
@@ -28,7 +28,7 @@ export type FromClient<A extends Rpc.Any> = Request<A> | Ack | Interrupt | Eof
 /**
  * Transport-encoded messages that can be sent from an RPC client to a server.
  *
- * @category request
+ * @category models
  * @since 4.0.0
  */
 export type FromClientEncoded = RequestEncoded | AckEncoded | InterruptEncoded | Ping | Eof
@@ -37,7 +37,7 @@ export type FromClientEncoded = RequestEncoded | AckEncoded | InterruptEncoded |
  * A branded request identifier used to correlate RPC requests, responses,
  * chunks, acknowledgements, and interrupts.
  *
- * @category request
+ * @category models
  * @since 4.0.0
  */
 export type RequestId = Branded<string | number, "~effect/rpc/RpcMessage/RequestId">
@@ -45,7 +45,7 @@ export type RequestId = Branded<string | number, "~effect/rpc/RpcMessage/Request
 /**
  * Converts a bigint or string request id into the branded `RequestId` type.
  *
- * @category request
+ * @category constructors
  * @since 4.0.0
  */
 export const RequestId = (id: string | number): RequestId => id as RequestId
@@ -54,7 +54,7 @@ export const RequestId = (id: string | number): RequestId => id as RequestId
  * The transport-encoded RPC request envelope, including the string request id,
  * RPC tag, encoded payload, headers, and optional trace context.
  *
- * @category request
+ * @category models
  * @since 4.0.0
  */
 export interface RequestEncoded {
@@ -63,6 +63,7 @@ export interface RequestEncoded {
   readonly tag: string
   readonly payload: unknown
   readonly headers: ReadonlyArray<[string, string]>
+  readonly isNotification?: true
   readonly traceId?: string
   readonly spanId?: string
   readonly sampled?: boolean
@@ -72,7 +73,7 @@ export interface RequestEncoded {
  * 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
+ * @category models
  * @since 4.0.0
  */
 export interface Request<A extends Rpc.Any> {
@@ -89,7 +90,7 @@ export interface Request<A extends Rpc.Any> {
 /**
  * A decoded acknowledgement for a streamed RPC response chunk.
  *
- * @category request
+ * @category models
  * @since 4.0.0
  */
 export interface Ack {
@@ -101,7 +102,7 @@ export interface Ack {
  * A decoded request to interrupt an in-flight RPC, carrying the request id and
  * interrupting fiber ids.
  *
- * @category request
+ * @category models
  * @since 4.0.0
  */
 export interface Interrupt {
@@ -113,7 +114,7 @@ export interface Interrupt {
 /**
  * The transport-encoded acknowledgement for a streamed RPC response chunk.
  *
- * @category request
+ * @category models
  * @since 4.0.0
  */
 export interface AckEncoded {
@@ -124,7 +125,7 @@ export interface AckEncoded {
 /**
  * The transport-encoded request to interrupt an in-flight RPC.
  *
- * @category request
+ * @category models
  * @since 4.0.0
  */
 export interface InterruptEncoded {
@@ -136,7 +137,7 @@ export interface InterruptEncoded {
  * A client-to-server message indicating that the client has finished sending
  * input for the current connection or request batch.
  *
- * @category request
+ * @category models
  * @since 4.0.0
  */
 export interface Eof {
@@ -147,7 +148,7 @@ export interface Eof {
  * A client-to-server keepalive message used by protocols that monitor
  * connection liveness.
  *
- * @category request
+ * @category models
  * @since 4.0.0
  */
 export interface Ping {
@@ -157,7 +158,7 @@ export interface Ping {
 /**
  * Represents the reusable `Eof` message value.
  *
- * @category request
+ * @category constants
  * @since 4.0.0
  */
 export const constEof: Eof = { _tag: "Eof" }
@@ -165,7 +166,7 @@ export const constEof: Eof = { _tag: "Eof" }
 /**
  * Represents the reusable `Ping` message value.
  *
- * @category request
+ * @category constants
  * @since 4.0.0
  */
 export const constPing: Ping = { _tag: "Ping" }
@@ -173,7 +174,7 @@ export const constPing: Ping = { _tag: "Ping" }
 /**
  * Decoded messages that can be sent from an RPC server to a client.
  *
- * @category response
+ * @category models
  * @since 4.0.0
  */
 export type FromServer<A extends Rpc.Any> =
@@ -185,7 +186,7 @@ export type FromServer<A extends Rpc.Any> =
 /**
  * Transport-encoded messages that can be sent from an RPC server to a client.
  *
- * @category response
+ * @category models
  * @since 4.0.0
  */
 export type FromServerEncoded =
@@ -214,7 +215,7 @@ export type ResponseIdTypeId = typeof ResponseIdTypeId
 /**
  * A branded numeric identifier for server responses.
  *
- * @category response
+ * @category models
  * @since 4.0.0
  */
 export type ResponseId = Branded<number, ResponseIdTypeId>
@@ -223,7 +224,7 @@ export type ResponseId = Branded<number, ResponseIdTypeId>
  * The transport-encoded response message containing a non-empty batch of stream
  * chunk values for a request.
  *
- * @category response
+ * @category models
  * @since 4.0.0
  */
 export interface ResponseChunkEncoded {
@@ -236,7 +237,7 @@ export interface ResponseChunkEncoded {
  * The decoded response message containing a non-empty batch of stream chunk
  * values for a specific client and request.
  *
- * @category response
+ * @category models
  * @since 4.0.0
  */
 export interface ResponseChunk<A extends Rpc.Any> {
@@ -250,7 +251,7 @@ export interface ResponseChunk<A extends Rpc.Any> {
  * The transport representation of an RPC `Exit`, encoding success values or a
  * failure cause made of failures, defects, and interrupts.
  *
- * @category response
+ * @category models
  * @since 4.0.0
  */
 export type ExitEncoded<A, E> = {
@@ -276,7 +277,7 @@ export type ExitEncoded<A, E> = {
  * The transport-encoded terminal response for a request, carrying the encoded
  * `Exit`.
  *
- * @category response
+ * @category models
  * @since 4.0.0
  */
 export interface ResponseExitEncoded {
@@ -289,7 +290,7 @@ export interface ResponseExitEncoded {
  * A server-to-client protocol message reporting a client protocol error to all
  * affected in-flight requests.
  *
- * @category response
+ * @category models
  * @since 4.0.0
  */
 export interface ClientProtocolError {
@@ -301,7 +302,7 @@ export interface ClientProtocolError {
  * The decoded terminal response for a request, carrying the typed `Rpc.Exit`
  * for the RPC.
  *
- * @category response
+ * @category models
  * @since 4.0.0
  */
 export interface ResponseExit<A extends Rpc.Any> {
@@ -315,7 +316,7 @@ export interface ResponseExit<A extends Rpc.Any> {
  * The transport-encoded server defect message used for protocol-level defects
  * that affect the client connection.
  *
- * @category response
+ * @category models
  * @since 4.0.0
  */
 export interface ResponseDefectEncoded {
@@ -329,7 +330,7 @@ const encodeDefect = Schema.encodeSync(Schema.Defect())
  * Creates an encoded terminal response for a request whose exit is a defect
  * encoded with `Schema.Defect()`.
  *
- * @category response
+ * @category constructors
  * @since 4.0.0
  */
 export const ResponseExitDieEncoded = (options: {
@@ -351,7 +352,7 @@ export const ResponseExitDieEncoded = (options: {
  * Creates a transport-encoded defect response by encoding the input with
  * `Schema.Defect()`.
  *
- * @category response
+ * @category constructors
  * @since 4.0.0
  */
 export const ResponseDefectEncoded = (input: unknown): ResponseDefectEncoded => ({
@@ -362,7 +363,7 @@ export const ResponseDefectEncoded = (input: unknown): ResponseDefectEncoded =>
 /**
  * The decoded server defect message for a client connection.
  *
- * @category response
+ * @category models
  * @since 4.0.0
  */
 export interface ResponseDefect {
@@ -374,7 +375,7 @@ export interface ResponseDefect {
 /**
  * A server message indicating that the client connection has ended.
  *
- * @category response
+ * @category models
  * @since 4.0.0
  */
 export interface ClientEnd {
@@ -385,7 +386,7 @@ export interface ClientEnd {
 /**
  * A server-to-client keepalive response to a `Ping` message.
  *
- * @category response
+ * @category models
  * @since 4.0.0
  */
 export interface Pong {
@@ -395,7 +396,7 @@ export interface Pong {
 /**
  * Represents the reusable `Pong` message value.
  *
- * @category response
+ * @category constants
  * @since 4.0.0
  */
 export const constPong: Pong = { _tag: "Pong" }

package/src/unstable/rpc/RpcMiddleware.ts

@@ -119,7 +119,7 @@ export interface Any {
  * A type-level carrier for RPC middleware metadata, including provided
  * services, required services, error schema, and client error type.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export interface AnyId {
@@ -135,7 +135,7 @@ export interface AnyId {
  * The `Context.Service` class shape created for an RPC middleware, including
  * its error schema, service metadata, and client-side requirement marker.
  *
- * @category models
+ * @category services
  * @since 4.0.0
  */
 export interface ServiceClass<
@@ -164,7 +164,7 @@ export interface ServiceClass<
 /**
  * Extracts the services provided by an RPC middleware.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Provides<A> = A extends { readonly [TypeId]: { readonly provides: infer P } } ? P : never
@@ -172,7 +172,7 @@ export type Provides<A> = A extends { readonly [TypeId]: { readonly provides: in
 /**
  * Extracts the services required by an RPC middleware.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Requires<A> = A extends { readonly [TypeId]: { readonly requires: infer R } } ? R : never
@@ -181,7 +181,7 @@ export type Requires<A> = A extends { readonly [TypeId]: { readonly requires: in
  * Applies a middleware's service transformation to an RPC environment by
  * removing services the middleware provides and adding services it requires.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ApplyServices<A, R> = Exclude<R, Provides<A>> | Requires<A>
@@ -189,7 +189,7 @@ export type ApplyServices<A, R> = Exclude<R, Provides<A>> | Requires<A>
 /**
  * Extracts the error schema associated with an RPC middleware.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ErrorSchema<A> = A extends { readonly [TypeId]: { readonly error: infer E } }
@@ -199,7 +199,7 @@ export type ErrorSchema<A> = A extends { readonly [TypeId]: { readonly error: in
 /**
  * Extracts the decoded error type produced by an RPC middleware.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Error<A> = ErrorSchema<A>["Type"]
@@ -207,7 +207,7 @@ export type Error<A> = ErrorSchema<A>["Type"]
 /**
  * Extracts the encoding services required by a middleware's error schema.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ErrorServicesEncode<A> = ErrorSchema<A>["EncodingServices"]
@@ -215,7 +215,7 @@ export type ErrorServicesEncode<A> = ErrorSchema<A>["EncodingServices"]
 /**
  * Extracts the decoding services required by a middleware's error schema.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ErrorServicesDecode<A> = ErrorSchema<A>["DecodingServices"]
@@ -318,7 +318,7 @@ export const Service = <
  * capturing the layer's environment and merging it into each middleware
  * invocation.
  *
- * @category client
+ * @category layers
  * @since 4.0.0
  */
 export const layerClient = <Id extends AnyId, S, R, EX = never, RX = never>(

package/src/unstable/rpc/RpcSchema.ts

@@ -23,7 +23,7 @@ const StreamSchemaTypeId = "~effect/rpc/RpcSchema/StreamSchema"
  * Returns `true` when a schema is an RPC stream schema created by
  * `RpcSchema.Stream`.
  *
- * @category streams
+ * @category guards
  * @since 4.0.0
  */
 export function isStreamSchema(schema: Schema.Constraint): schema is Stream<Schema.Top, Schema.Top> {
@@ -47,7 +47,7 @@ export function getStreamSchemas(schema: Schema.Constraint): Option.Option<{
  * A schema marker for RPC streaming responses, storing the success element
  * schema and stream error schema used for encoding and decoding stream chunks.
  *
- * @category streams
+ * @category models
  * @since 4.0.0
  */
 export interface Stream<A extends Schema.Constraint, E extends Schema.Constraint> extends
@@ -75,7 +75,7 @@ const schema = Schema.declare(Stream_.isStream)
  * Creates an RPC stream schema from a stream element success schema and stream
  * error schema.
  *
- * @category streams
+ * @category constructors
  * @since 4.0.0
  */
 export function Stream<A extends Schema.Constraint, E extends Schema.Constraint>(success: A, error: E): Stream<A, E> {
@@ -86,7 +86,7 @@ export function Stream<A extends Schema.Constraint, E extends Schema.Constraint>
  * Annotation that marks interruptions that originate from an RPC client
  * abort.
  *
- * @category Cause annotations
+ * @category services
  * @since 4.0.0
  */
 export class ClientAbort extends Context.Service<ClientAbort, true>()("effect/rpc/RpcSchema/ClientAbort") {