effect 4.0.0-beta.101 → 4.0.0-beta.103

package/src/unstable/rpc/Rpc.ts

@@ -47,7 +47,7 @@ export const isRpc = (u: unknown): u is Rpc<any, any, any> => Predicate.hasPrope
  * Defect schemas decode and encode without services and can be constructed from
  * `null`, `undefined`, or an object value.
  *
- * @category models
+ * @category schemas
  * @since 4.0.0
  */
 export interface DefectSchema extends Schema.Top {
@@ -260,7 +260,7 @@ export interface AnyWithProps extends Pipeable {
 /**
  * Extracts the tag string from an `Rpc`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Tag<R> = R extends Rpc<
@@ -276,7 +276,7 @@ export type Tag<R> = R extends Rpc<
 /**
  * Extracts the success schema from an `Rpc`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type SuccessSchema<R> = R extends Rpc<
@@ -292,7 +292,7 @@ export type SuccessSchema<R> = R extends Rpc<
 /**
  * Extracts the decoded success value type from an `Rpc`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Success<R> = SuccessSchema<R>["Type"]
@@ -300,7 +300,7 @@ export type Success<R> = SuccessSchema<R>["Type"]
 /**
  * Extracts the encoded success value type from an `Rpc`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type SuccessEncoded<R> = R extends Rpc<
@@ -321,7 +321,7 @@ export type SuccessEncoded<R> = R extends Rpc<
  * For streaming RPCs, this is the stream element schema; otherwise it is the
  * RPC success schema.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type SuccessExitSchema<R> = SuccessSchema<R> extends RpcSchema.Stream<infer _A, infer _E> ? _A : SuccessSchema<R>
@@ -334,7 +334,7 @@ export type SuccessExitSchema<R> = SuccessSchema<R> extends RpcSchema.Stream<inf
  * For streaming RPCs, the immediate exit success is `void` because stream
  * elements are delivered separately.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type SuccessExit<R> = Success<R> extends infer T ? T extends Stream<infer _A, infer _E, infer _Env> ? void : T
@@ -344,7 +344,7 @@ export type SuccessExit<R> = Success<R> extends infer T ? T extends Stream<infer
  * Extracts the decoded stream element type from a streaming RPC, or `never` for
  * non-streaming RPCs.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type SuccessChunk<R> = Success<R> extends Stream<infer _A, infer _E, infer _Env> ? _A : never
@@ -353,7 +353,7 @@ export type SuccessChunk<R> = Success<R> extends Stream<infer _A, infer _E, infe
  * Extracts the RPC error schema, including error schemas contributed by
  * middleware.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ErrorSchema<R> = R extends Rpc<
@@ -370,7 +370,7 @@ export type ErrorSchema<R> = R extends Rpc<
  * Extracts the decoded error value type from an `Rpc`, including middleware
  * errors.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Error<R> = Schema.Schema.Type<ErrorSchema<R>>
@@ -383,7 +383,7 @@ export type Error<R> = Schema.Schema.Type<ErrorSchema<R>>
  * For streaming RPCs, this includes both the stream error schema and the RPC
  * error schema; otherwise it is the RPC error schema.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ErrorExitSchema<R> = SuccessSchema<R> extends RpcSchema.Stream<infer _A, infer _E> ? _E | ErrorSchema<R>
@@ -396,7 +396,7 @@ export type ErrorExitSchema<R> = SuccessSchema<R> extends RpcSchema.Stream<infer
  *
  * For streaming RPCs, this includes both stream errors and RPC errors.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ErrorExit<R> = Success<R> extends Stream<infer _A, infer _E, infer _Env> ? _E | Error<R> : Error<R>
@@ -405,7 +405,7 @@ export type ErrorExit<R> = Success<R> extends Stream<infer _A, infer _E, infer _
  * The `Exit` type produced for an RPC, using the RPC's exit success and exit
  * error types.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Exit<R> = Exit_<SuccessExit<R>, ErrorExit<R>>
@@ -414,7 +414,7 @@ export type Exit<R> = Exit_<SuccessExit<R>, ErrorExit<R>>
  * Extracts the payload constructor input type accepted by the RPC payload
  * schema.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type PayloadConstructor<R> = R extends Rpc<
@@ -430,7 +430,7 @@ export type PayloadConstructor<R> = R extends Rpc<
 /**
  * Extracts the decoded payload type from an `Rpc`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Payload<R> = R extends Rpc<
@@ -447,7 +447,7 @@ export type Payload<R> = R extends Rpc<
  * Extracts all schema services required to encode or decode an RPC's payload,
  * success, error, and middleware error schemas.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Services<R> = R extends Rpc<
@@ -476,7 +476,7 @@ export type Services<R> = R extends Rpc<
  * This includes payload encoding services and success, error, and middleware
  * error decoding services.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ServicesClient<R> = R extends Rpc<
@@ -501,7 +501,7 @@ export type ServicesClient<R> = R extends Rpc<
  * This includes payload decoding services and success, error, and middleware
  * error encoding services.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ServicesServer<R> = R extends Rpc<
@@ -521,7 +521,7 @@ export type ServicesServer<R> = R extends Rpc<
 /**
  * Extracts the service identifiers for middleware attached to an `Rpc`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Middleware<R> = R extends Rpc<
@@ -538,7 +538,7 @@ export type Middleware<R> = R extends Rpc<
  * Extracts client-side middleware service requirements for middleware marked as
  * required on the client.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type MiddlewareClient<R> = R extends Rpc<
@@ -556,7 +556,7 @@ export type MiddlewareClient<R> = R extends Rpc<
  * Returns an RPC type with an additional error schema unioned into its error
  * channel.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type AddError<R extends Any, Error extends Schema.Top> = R extends Rpc<
@@ -580,7 +580,7 @@ export type AddError<R extends Any, Error extends Schema.Top> = R extends Rpc<
  * Returns an RPC type with additional middleware and the corresponding
  * middleware service requirements applied.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type AddMiddleware<R extends Any, Middleware extends RpcMiddleware.AnyService> = R extends Rpc<
@@ -603,7 +603,7 @@ export type AddMiddleware<R extends Any, Middleware extends RpcMiddleware.AnySer
 /**
  * Converts an RPC definition into the corresponding `Handler` type.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ToHandler<R extends Any> = R extends Rpc<
@@ -624,7 +624,7 @@ export type ToHandler<R extends Any> = R extends Rpc<
  * The function receives the decoded payload and request metadata, and returns
  * the RPC result shape, optionally wrapped with `Wrapper` options.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ToHandlerFn<Current extends Any, R = any> = (
@@ -641,7 +641,7 @@ export type ToHandlerFn<Current extends Any, R = any> = (
  * Returns `true` when the RPC with the specified tag has a streaming success
  * schema, or `never` otherwise.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type IsStream<R extends Any, Tag extends string> = R extends Rpc<
@@ -657,7 +657,7 @@ export type IsStream<R extends Any, Tag extends string> = R extends Rpc<
 /**
  * Extracts the RPC with the specified tag from an RPC union.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ExtractTag<R extends Any, Tag extends string> = R extends Rpc<
@@ -674,7 +674,7 @@ export type ExtractTag<R extends Any, Tag extends string> = R extends Rpc<
  * Extracts the services provided by middleware on the RPC with the specified
  * tag.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ExtractProvides<R extends Any, Tag extends string> = R extends Rpc<
@@ -690,7 +690,7 @@ export type ExtractProvides<R extends Any, Tag extends string> = R extends Rpc<
 /**
  * Extracts the service requirements of the RPC with the specified tag.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ExtractRequires<R extends Any, Tag extends string> = R extends Rpc<
@@ -707,7 +707,7 @@ export type ExtractRequires<R extends Any, Tag extends string> = R extends Rpc<
  * Removes the services provided by middleware for the specified RPC tag from an
  * environment type.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ExcludeProvides<Env, R extends Any, Tag extends string> = Exclude<
@@ -724,7 +724,7 @@ export type ExcludeProvides<Env, R extends Any, Tag extends string> = Exclude<
  * RPCs return an effect that succeeds with the success value or a deferred
  * success value.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type ResultFrom<R extends Any, Services> = R extends Rpc<
@@ -756,7 +756,7 @@ export type ResultFrom<R extends Any, Services> = R extends Rpc<
  * Returns an RPC type with the specified string prefix added to its tag while
  * preserving its payload, success, error, middleware, and requirements.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Prefixed<Rpcs extends Any, Prefix extends string> = Rpcs extends Rpc<
@@ -956,7 +956,7 @@ export const make = <
  *
  * **Example** (Defining a paginated RPC constructor)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Schema } from "effect"
  * import { Rpc } from "effect/unstable/rpc"
  *
@@ -992,6 +992,8 @@ export const make = <
  * export const listAllRpc = makePaginated("listAll", {
  *   success: Schema.String
  * })
+ *
+ * const result = [listAllRpc._tag, Schema.isSchema(listAllRpc.successSchema)] // => ["listAll", true]
  * ```
  *
  * @category constructors
@@ -1178,7 +1180,7 @@ export type WrapperOr<A> = A | Wrapper<A>
 /**
  * Returns `true` when the value is an RPC `Wrapper`.
  *
- * @category wrapping
+ * @category guards
  * @since 4.0.0
  */
 export const isWrapper = (u: object): u is Wrapper<any> => WrapperTypeId in u

package/src/unstable/rpc/RpcClient.ts

@@ -18,6 +18,7 @@ import * as Effect from "../../Effect.ts"
 import * as Exit from "../../Exit.ts"
 import * as Fiber from "../../Fiber.ts"
 import { constVoid, dual, flow, identity } from "../../Function.ts"
+import * as InternalRecord from "../../internal/record.ts"
 import * as Latch from "../../Latch.ts"
 import * as Layer from "../../Layer.ts"
 import * as Option from "../../Option.ts"
@@ -54,7 +55,7 @@ import { withRunClient } from "./Utils.ts"
  * The object-shaped client generated from a union of RPC definitions, with one
  * method per RPC tag.
  *
- * @category client
+ * @category utility types
  * @since 4.0.0
  */
 export type RpcClient<Rpcs extends Rpc.Any, E = never> = Struct.Simplify<RpcClient.From<Rpcs, E>>
@@ -71,7 +72,7 @@ export declare namespace RpcClient {
    * method that accepts the RPC payload and returns either an `Effect` or
    * `Stream` based on the RPC success schema.
    *
-   * @category client
+   * @category utility types
    * @since 4.0.0
    */
   export type From<Rpcs extends Rpc.Any, E = never> = {
@@ -136,7 +137,7 @@ export declare namespace RpcClient {
    * Builds a flattened RPC client function that accepts an RPC tag and payload,
    * returning the corresponding `Effect` or `Stream` for that RPC.
    *
-   * @category client
+   * @category utility types
    * @since 4.0.0
    */
   export type Flat<Rpcs extends Rpc.Any, E = never> = <
@@ -199,7 +200,7 @@ export declare namespace RpcClient {
  * Derives the object-shaped RPC client type for all RPCs contained in an
  * `RpcGroup`.
  *
- * @category client
+ * @category utility types
  * @since 4.0.0
  */
 export type FromGroup<Group, E = never> = RpcClient<RpcGroup.Rpcs<Group>, E>
@@ -211,7 +212,7 @@ let requestIdCounter = 0
  * client API together with a `write` function for delivering server messages
  * back to the client.
  *
- * @category client
+ * @category constructors
  * @since 4.0.0
  */
 export const makeNoSerialization: <Rpcs extends Rpc.Any, E, const Flatten extends boolean = false>(
@@ -608,7 +609,7 @@ export const makeNoSerialization: <Rpcs extends Rpc.Any, E, const Flatten extend
   } else {
     client = {}
     group.requests.forEach((rpc) => {
-      client[rpc._tag] = onRequest(rpc as any)
+      InternalRecord.assignProperty(client, rpc._tag, onRequest(rpc as any))
     })
   }
 
@@ -621,7 +622,7 @@ let clientIdCounter = 0
  * Creates a schema-aware RPC client for a group using the current client
  * `Protocol`, encoding requests and decoding server responses.
  *
- * @category client
+ * @category constructors
  * @since 4.0.0
  */
 export const make: <Rpcs extends Rpc.Any, const Flatten extends boolean = false>(
@@ -806,7 +807,7 @@ const rpcSchemas = (rpc: Rpc.AnyWithProps) => {
  * Use to set request headers that should be automatically merged into outgoing
  * RPC client messages.
  *
- * @category headers
+ * @category services
  * @since 4.0.0
  */
 export const CurrentHeaders = Context.Reference<Headers.Headers>("effect/rpc/RpcClient/CurrentHeaders", {
@@ -852,7 +853,7 @@ export const withHeaders: {
  * Use to provide the transport boundary for RPC clients over HTTP, WebSocket,
  * workers, sockets, or custom protocols.
  *
- * @category protocols
+ * @category services
  * @since 4.0.0
  */
 export class Protocol extends Context.Service<Protocol, {
@@ -993,7 +994,7 @@ export const makeProtocolHttp = (client: HttpClient.HttpClient): Effect.Effect<
  * Provides a client `Protocol` backed by `HttpClient`, targeting the configured
  * URL and optionally transforming the client before use.
  *
- * @category protocols
+ * @category layers
  * @since 4.0.0
  */
 export const layerProtocolHttp = (options: {
@@ -1062,11 +1063,12 @@ export const makeProtocolSocket = (options?: {
                 pinger.onPong()
                 return Effect.void
               }
-              if ("requestId" in response) {
-                const clientId = requestClientMap.get(response.requestId)
+              if (Object.hasOwn(response, "requestId")) {
+                const requestId = (response as FromServerEncoded & { readonly requestId: string | number }).requestId
+                const clientId = requestClientMap.get(requestId)
                 if (clientId !== undefined) {
                   if (response._tag === "Exit") {
-                    requestClientMap.delete(response.requestId)
+                    requestClientMap.delete(requestId)
                   }
                   return writeResponse(clientId, response)
                 }
@@ -1183,7 +1185,7 @@ const makePinger = Effect.fnUntraced(function*<A, E, R>(writePing: Effect.Effect
  * Provides a client `Protocol` backed by the current `Socket` and
  * `RpcSerialization` services.
  *
- * @category protocols
+ * @category layers
  * @since 4.0.0
  */
 export const layerProtocolSocket = (options?: {
@@ -1364,7 +1366,7 @@ export const makeProtocolWorker = (
  * Provides a client `Protocol` backed by a worker pool using the current worker
  * platform and spawner services.
  *
- * @category protocols
+ * @category layers
  * @since 4.0.0
  */
 export const layerProtocolWorker: (
@@ -1394,7 +1396,7 @@ export const layerProtocolWorker: (
  * Use to run setup or cleanup effects when an RPC client transport opens or
  * closes.
  *
- * @category connection hooks
+ * @category services
  * @since 4.0.0
  */
 export class ConnectionHooks extends Context.Service<ConnectionHooks, {

package/src/unstable/rpc/RpcGroup.ts

@@ -29,7 +29,7 @@ const TypeId = "~effect/rpc/RpcGroup"
  * A collection of RPC definitions that can be composed, annotated, and
  * converted into server handlers or layers.
  *
- * @category groups
+ * @category models
  * @since 4.0.0
  */
 export interface RpcGroup<in out R extends Rpc.Any> extends Pipeable {
@@ -170,7 +170,7 @@ export interface RpcGroup<in out R extends Rpc.Any> extends Pipeable {
  * An erased `RpcGroup` type for APIs that only need to know that a value is an
  * RPC group.
  *
- * @category groups
+ * @category utility types
  * @since 4.0.0
  */
 export interface Any {
@@ -181,7 +181,7 @@ export interface Any {
  * Builds the object type of server handler functions required to implement each
  * RPC in a union.
  *
- * @category groups
+ * @category utility types
  * @since 4.0.0
  */
 export type HandlersFrom<Rpc extends Rpc.Any> = {
@@ -192,7 +192,7 @@ export type HandlersFrom<Rpc extends Rpc.Any> = {
  * Extracts the server handler function type for a specific RPC tag from an RPC
  * union.
  *
- * @category groups
+ * @category utility types
  * @since 4.0.0
  */
 export type HandlerFrom<Rpc extends Rpc.Any, Tag extends Rpc["_tag"]> = Extract<Rpc, { readonly _tag: Tag }> extends
@@ -202,7 +202,7 @@ export type HandlerFrom<Rpc extends Rpc.Any, Tag extends Rpc["_tag"]> = Extract<
  * Computes the services required by all handlers in a handler object for an RPC
  * union.
  *
- * @category groups
+ * @category utility types
  * @since 4.0.0
  */
 export type HandlersServices<Rpcs extends Rpc.Any, Handlers> = keyof Handlers extends infer K ?
@@ -213,7 +213,7 @@ export type HandlersServices<Rpcs extends Rpc.Any, Handlers> = keyof Handlers ex
  * Computes the services required by a single RPC handler, excluding services
  * provided by middleware and `Scope` where the server supplies it.
  *
- * @category groups
+ * @category utility types
  * @since 4.0.0
  */
 export type HandlerServices<Rpcs extends Rpc.Any, K extends Rpcs["_tag"], Handler> = true extends
@@ -242,7 +242,7 @@ export type HandlerServices<Rpcs extends Rpc.Any, K extends Rpcs["_tag"], Handle
 /**
  * Extracts the union of RPC definitions from an `RpcGroup`.
  *
- * @category groups
+ * @category utility types
  * @since 4.0.0
  */
 export type Rpcs<Group> = Group extends RpcGroup<infer R> ? string extends R["_tag"] ? never : R : never
@@ -396,7 +396,7 @@ const makeProto = <Rpcs extends Rpc.Any>(options: {
 /**
  * Creates an `RpcGroup` from one or more RPC definitions.
  *
- * @category groups
+ * @category constructors
  * @since 4.0.0
  */
 export const make = <const Rpcs extends ReadonlyArray<Rpc.Any>>(