effect 4.0.0-beta.67 → 4.0.0-beta.69

package/src/unstable/cluster/HttpRunner.ts

@@ -53,7 +53,7 @@ import type * as ShardingConfig from "./ShardingConfig.ts"
  * The configured path is appended to each runner address, and `https` switches
  * the generated URL from `http` to `https`.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerClientProtocolHttp = (options: {
@@ -84,7 +84,7 @@ export const layerClientProtocolHttp = (options: {
 /**
  * Default HTTP runner client protocol layer using path `/`.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerClientProtocolHttpDefault: Layer.Layer<
@@ -100,7 +100,7 @@ export const layerClientProtocolHttpDefault: Layer.Layer<
  * The configured path is appended to each runner address, and `https` switches
  * the generated URL from `ws` to `wss`.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerClientProtocolWebsocket = (options: {
@@ -133,7 +133,7 @@ export const layerClientProtocolWebsocket = (options: {
 /**
  * Default WebSocket runner client protocol layer using path `/`.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerClientProtocolWebsocketDefault: Layer.Layer<
@@ -188,7 +188,7 @@ export const toHttpEffectWebsocket: Effect.Effect<
  * Layer that provides `Sharding` and `Runners` using the configured runner RPC
  * client protocol and storage services.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerClient: Layer.Layer<
@@ -203,7 +203,7 @@ export const layerClient: Layer.Layer<
  * A HTTP layer for the `Runners` services, that adds a route to the provided
  * `HttpRouter`.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerHttpOptions = (options: {
@@ -227,7 +227,7 @@ export const layerHttpOptions = (options: {
  * WebSocket layer for the `Runners` services that adds a route to the provided
  * `HttpRouter`.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerWebsocketOptions = (options: {
@@ -253,7 +253,7 @@ export const layerWebsocketOptions = (options: {
  * It serves runner routes at `/` and configures runner clients to communicate
  * over HTTP.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerHttp: Layer.Layer<
@@ -276,7 +276,7 @@ export const layerHttp: Layer.Layer<
  * It configures runner clients to communicate over HTTP without serving runner
  * HTTP routes.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerHttpClientOnly: Layer.Layer<
@@ -297,7 +297,7 @@ export const layerHttpClientOnly: Layer.Layer<
  * It serves runner routes at `/` and configures runner clients to communicate
  * over WebSocket.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerWebsocket: Layer.Layer<
@@ -320,7 +320,7 @@ export const layerWebsocket: Layer.Layer<
  * It configures runner clients to communicate over WebSocket without serving
  * runner WebSocket routes.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerWebsocketClientOnly: Layer.Layer<

package/src/unstable/cluster/K8sHttpClient.ts

@@ -52,7 +52,7 @@ export class K8sHttpClient extends Context.Service<
  * bearer token when available, requires successful HTTP statuses, and retries
  * transient failures.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer: Layer.Layer<
@@ -83,7 +83,7 @@ export const layer: Layer.Layer<
  * The request can be limited by namespace and label selector, and the result is a
  * map keyed by pod IP address.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const makeGetPods: (
@@ -130,7 +130,7 @@ export const makeGetPods: (
  * The pod defaults to the `default` namespace and is deleted when the surrounding
  * scope closes.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const makeCreatePod = Effect.gen(function*() {
@@ -234,7 +234,7 @@ export const makeCreatePod = Effect.gen(function*() {
 /**
  * Schema for the subset of Kubernetes Pod status used by cluster helpers.
  *
- * @category Schemas
+ * @category schemas
  * @since 4.0.0
  */
 export class PodStatus extends Schema.Class<PodStatus>("@effect/cluster/K8sHttpClient/PodStatus")({
@@ -253,7 +253,7 @@ export class PodStatus extends Schema.Class<PodStatus>("@effect/cluster/K8sHttpC
  *
  * The model exposes readiness helpers derived from the pod status conditions.
  *
- * @category Schemas
+ * @category schemas
  * @since 4.0.0
  */
 export class Pod extends Schema.Class<Pod>("@effect/cluster/K8sHttpClient/Pod")({

package/src/unstable/cluster/MachineId.ts

@@ -42,7 +42,7 @@ export type MachineId = typeof MachineId.Type
 /**
  * Brands a number as a `MachineId`.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make = (id: number): MachineId => id as MachineId

package/src/unstable/cluster/MessageStorage.ts

@@ -211,7 +211,6 @@ export const SaveResultEncoded = Data.taggedEnum<SaveResult.Encoded>()
 /**
  * Variants and helper types for `SaveResult`.
  *
- * @category SaveResult
  * @since 4.0.0
  */
 export declare namespace SaveResult {
@@ -752,7 +751,7 @@ export const makeEncoded: (encoded: Encoded) => Effect.Effect<
 /**
  * No-op `MessageStorage` service that does not persist messages or replies.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const noop: MessageStorage["Service"] = Effect.runSync(make({

package/src/unstable/cluster/Runner.ts

@@ -116,7 +116,7 @@ export class Runner extends Schema.Class<Runner>(TypeId)({
  * Constructs a `Runner` from its network address, shard groups, and relative
  * shard-assignment weight.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make = (props: {

package/src/unstable/cluster/RunnerHealth.ts

@@ -64,7 +64,7 @@ export const layerNoop = Layer.succeed(RunnerHealth, {
  * failed pings on a short schedule and treating a successful ping within the
  * timeout as healthy.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const makePing: Effect.Effect<
@@ -104,7 +104,7 @@ export const layerPing: Layer.Layer<
  *
  * If the Kubernetes API check fails, the runner is treated as healthy.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const makeK8s = Effect.fnUntraced(function*(options?: {

package/src/unstable/cluster/RunnerServer.ts

@@ -49,7 +49,7 @@ const constVoid = constant(Effect.void)
  * Layer of RPC handlers for the runner protocol, forwarding ping, notify, effect,
  * stream, and envelope requests to `Sharding` and `MessageStorage`.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerHandlers = Runners.Rpcs.toLayer(Effect.gen(function*() {
@@ -161,7 +161,7 @@ const constWaitUntilRead = { waitUntilRead: true } as const
  *
  * It also responds to `Ping` requests.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer: Layer.Layer<
@@ -176,7 +176,7 @@ export const layer: Layer.Layer<
 /**
  * A `RunnerServer` layer that includes the `Runners` & `Sharding` clients.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerWithClients: Layer.Layer<
@@ -200,7 +200,7 @@ export const layerWithClients: Layer.Layer<
  * so this layer can be used to embed a cluster client inside another effect
  * application.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerClientOnly: Layer.Layer<

package/src/unstable/cluster/Runners.ts

@@ -150,7 +150,7 @@ export class Runners extends Context.Service<Runners, {
  * message persistence, duplicate request handling, optional local serialization
  * simulation, and polling for persisted replies.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make: (options: Omit<Runners["Service"], "sendLocal" | "notifyLocal">) => Effect.Effect<
@@ -440,7 +440,7 @@ export const makeNoop: Effect.Effect<
  * Layer that provides the no-op `Runners` service, using the default snowflake
  * generator.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerNoop: Layer.Layer<
@@ -663,7 +663,7 @@ export const makeRpc: Effect.Effect<
  * Layer that provides an RPC-backed `Runners` service using `RpcClientProtocol`,
  * message storage, sharding configuration, and the default snowflake generator.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerRpc: Layer.Layer<

package/src/unstable/cluster/ShardId.ts

@@ -37,7 +37,7 @@ const TypeId = "~effect/cluster/ShardId"
  * Identifier for a shard within a shard group, with equality, hashing, and primary
  * key behavior based on the `group:id` string form.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface ShardId extends Equal.Equal, Hash.Hash, PrimaryKey.PrimaryKey {
@@ -49,7 +49,7 @@ export interface ShardId extends Equal.Equal, Hash.Hash, PrimaryKey.PrimaryKey {
 /**
  * Returns `true` when the value carries the `ShardId` runtime marker.
  *
- * @category Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isShardId = (u: unknown): u is ShardId => hasProperty(u, TypeId)
@@ -58,7 +58,7 @@ export const isShardId = (u: unknown): u is ShardId => hasProperty(u, TypeId)
  * Schema for `ShardId` values encoded as `{ group, id }` objects and decoded via
  * `make`.
  *
- * @category Schema
+ * @category schemas
  * @since 4.0.0
  */
 export const ShardId = S.declare(isShardId, {
@@ -79,7 +79,7 @@ export const ShardId = S.declare(isShardId, {
  * Creates or reuses the cached `ShardId` for the specified shard group and numeric
  * id.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make = (group: string, id: number): ShardId => {
@@ -120,7 +120,7 @@ const ShardIdProto = {
 /**
  * Formats a shard identifier as `group:id`.
  *
- * @category Conversions
+ * @category converting
  * @since 4.0.0
  */
 export const toString = (shardId: {
@@ -135,6 +135,7 @@ export const toString = (shardId: {
  * Throws an `Error` when the string has no colon separator or the id segment is
  * not numeric.
  *
+ * @category decoding
  * @since 4.0.0
  */
 export function fromStringEncoded(s: string): {
@@ -159,6 +160,7 @@ export function fromStringEncoded(s: string): {
  * Throws an `Error` when the string has no colon separator or the id segment is
  * not numeric.
  *
+ * @category decoding
  * @since 4.0.0
  */
 export function fromString(s: string): ShardId {

package/src/unstable/cluster/Sharding.ts

@@ -8,7 +8,7 @@
  * transparency for stateful entities, singleton workloads that should run once
  * per shard group, or durable message processing backed by cluster storage.
  * Registered entity handlers are started on demand for shards owned by the
- * current runner, while clients produced by {@link Sharding.makeClient} route
+ * current runner, while clients produced by the {@link Sharding} service route
  * requests through the sharding service instead of calling handlers directly.
  *
  * **Gotchas**

package/src/unstable/cluster/ShardingConfig.ts

@@ -180,7 +180,7 @@ export const defaults: ShardingConfig["Service"] = {
  * Creates a `ShardingConfig` layer by merging the provided partial options over
  * `defaults`.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer = (options?: Partial<ShardingConfig["Service"]>): Layer.Layer<ShardingConfig> =>
@@ -317,7 +317,7 @@ export const configFromEnv = config.pipe(
  * Layer that loads `ShardingConfig` from environment variables and, when options
  * are provided, overlays those options on top of the loaded values.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerFromEnv = (options?: Partial<ShardingConfig["Service"]> | undefined): Layer.Layer<

package/src/unstable/cluster/SingleRunner.ts

@@ -39,7 +39,7 @@ import * as SqlRunnerStorage from "./SqlRunnerStorage.ts"
  * A sql backed single-node cluster, that can be used for running durable
  * entities and workflows.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer = (options?: {

package/src/unstable/cluster/Snowflake.ts

@@ -33,6 +33,7 @@ import type { MachineId } from "./MachineId.ts"
 /**
  * Runtime brand identifier for cluster snowflake ids.
  *
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId = "~effect/cluster/Snowflake"
@@ -40,6 +41,7 @@ export const TypeId = "~effect/cluster/Snowflake"
 /**
  * Type-level representation of the cluster snowflake brand identifier.
  *
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = typeof TypeId
@@ -48,7 +50,7 @@ export type TypeId = typeof TypeId
  * Branded bigint identifier composed from a timestamp, machine id, and per-machine
  * sequence number.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Snowflake = Brand.Branded<bigint, TypeId>
@@ -56,7 +58,7 @@ export type Snowflake = Brand.Branded<bigint, TypeId>
 /**
  * Constructs a branded `Snowflake` from a bigint or bigint-compatible string.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export const Snowflake = (input: string | bigint): Snowflake =>
@@ -65,7 +67,6 @@ export const Snowflake = (input: string | bigint): Snowflake =>
 /**
  * Namespace containing support types for snowflake parts and generators.
  *
- * @category Models
  * @since 4.0.0
  */
 export declare namespace Snowflake {
@@ -73,7 +74,7 @@ export declare namespace Snowflake {
    * Decoded components of a snowflake id: Unix timestamp milliseconds, machine id,
    * and sequence number.
    *
-   * @category Models
+   * @category models
    * @since 4.0.0
    */
   export interface Parts {
@@ -86,7 +87,7 @@ export declare namespace Snowflake {
    * Stateful generator for runner-local snowflake ids, exposing an unsafe
    * synchronous `nextUnsafe` operation and an effectful machine id setter.
    *
-   * @category Models
+   * @category models
    * @since 4.0.0
    */
   export interface Generator {
@@ -98,7 +99,7 @@ export declare namespace Snowflake {
 /**
  * Schema type for snowflake ids represented as branded bigints.
  *
- * @category Schemas
+ * @category schemas
  * @since 4.0.0
  */
 export interface SnowflakeFromBigInt extends Schema.brand<Schema.BigInt, TypeId> {}
@@ -106,7 +107,7 @@ export interface SnowflakeFromBigInt extends Schema.brand<Schema.BigInt, TypeId>
 /**
  * Schema for snowflake ids represented as branded bigints.
  *
- * @category Schemas
+ * @category schemas
  * @since 4.0.0
  */
 export const SnowflakeFromBigInt: SnowflakeFromBigInt = Schema.BigInt.pipe(Schema.brand(TypeId))
@@ -114,7 +115,7 @@ export const SnowflakeFromBigInt: SnowflakeFromBigInt = Schema.BigInt.pipe(Schem
 /**
  * Schema type for snowflake ids decoded from strings into branded bigints.
  *
- * @category Schemas
+ * @category schemas
  * @since 4.0.0
  */
 export interface SnowflakeFromString extends Schema.decodeTo<SnowflakeFromBigInt, Schema.String> {}
@@ -123,7 +124,7 @@ export interface SnowflakeFromString extends Schema.decodeTo<SnowflakeFromBigInt
  * Schema that decodes snowflake ids from strings into branded bigints and encodes
  * them back to strings.
  *
- * @category Schemas
+ * @category schemas
  * @since 4.0.0
  */
 export const SnowflakeFromString: SnowflakeFromString = Schema.String.pipe(

package/src/unstable/cluster/SocketRunner.ts

@@ -51,7 +51,7 @@ const withLogAddress = <A, E, R>(layer: Layer.Layer<A, E, R>): Layer.Layer<A, E,
  * Layer that runs a cluster runner over the socket RPC protocol, providing
  * `Sharding` and `Runners` clients and logging the socket listen address.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer: Layer.Layer<
@@ -73,7 +73,7 @@ export const layer: Layer.Layer<
  * Client-only socket runner layer that provides `Sharding` and `Runners` clients
  * without starting a runner server or receiving shard assignments.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerClientOnly: Layer.Layer<

package/src/unstable/cluster/SqlMessageStorage.ts

@@ -42,7 +42,7 @@ const withTracerDisabled = Effect.withTracerEnabled(false)
  * Creates a SQL-backed `MessageStorage` implementation, running its migrations
  * and using the optional table prefix.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make: (options?: {
@@ -625,7 +625,7 @@ export const make: (options?: {
  * Layer that provides SQL-backed `MessageStorage` using the default table prefix
  * and the default snowflake generator.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer: Layer.Layer<
@@ -639,7 +639,7 @@ export const layer: Layer.Layer<
 /**
  * Layer that provides SQL-backed `MessageStorage` using a custom table prefix.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerWith = (options: {

package/src/unstable/cluster/SqlRunnerStorage.ts

@@ -51,7 +51,7 @@ const withTracerDisabled = Effect.withTracerEnabled(false)
  * shard locks, using the configured table prefix and advisory locks where
  * supported and enabled.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make = Effect.fnUntraced(function*(options: {
@@ -680,7 +680,7 @@ export const make = Effect.fnUntraced(function*(options: {
 /**
  * Layer that provides SQL-backed `RunnerStorage` using the default table prefix.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer: Layer.Layer<
@@ -692,7 +692,7 @@ export const layer: Layer.Layer<
 /**
  * Layer that provides SQL-backed `RunnerStorage` using a custom table prefix.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerWith = (options: {

package/src/unstable/cluster/TestRunner.ts

@@ -32,7 +32,7 @@ import * as ShardingConfig from "./ShardingConfig.ts"
  * MessageStorage is backed by an in-memory driver, and RunnerStorage is backed
  * by an in-memory driver.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer: Layer.Layer<