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

package/dist/unstable/cluster/SingletonAddress.d.ts

@@ -1,4 +1,18 @@
 /**
+ * The `SingletonAddress` module defines the address used by cluster sharding to
+ * identify a registered singleton. A singleton address combines the singleton
+ * name with the `ShardId` that owns it, giving the runtime a stable key for
+ * registration events, equality checks, hashing, and runner-local fiber
+ * tracking.
+ *
+ * Use this module when observing singleton registrations or working with
+ * sharding internals that need to tell which shard currently owns a singleton.
+ * The shard id is derived from the singleton name and shard group at
+ * registration time, so changing either value changes ownership and routing.
+ * Ownership can also move as shard locks are acquired or released, so an address
+ * identifies the target shard rather than guaranteeing that a particular runner
+ * is currently executing the singleton.
+ *
  * @since 4.0.0
  */
 import * as Equal from "../../Equal.ts";
@@ -13,19 +27,25 @@ declare const SingletonAddress_base: Schema.Class<SingletonAddress, Schema.Struc
 /**
  * Represents the unique address of an singleton within the cluster.
  *
- * @since 4.0.0
  * @category Address
+ * @since 4.0.0
  */
 export declare class SingletonAddress extends SingletonAddress_base {
     /**
+     * Marks this value as a cluster singleton address for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [TypeId] = "~effect/cluster/SingletonAddress";
     /**
+     * Computes a structural hash from the singleton name and shard id.
+     *
      * @since 4.0.0
      */
     [Hash.symbol](): number;
     /**
+     * Compares singleton addresses by name and shard id.
+     *
      * @since 4.0.0
      */
     [Equal.symbol](that: SingletonAddress): boolean;

package/dist/unstable/cluster/SingletonAddress.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SingletonAddress.d.ts","sourceRoot":"","sources":["../../../src/unstable/cluster/SingletonAddress.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,IAAI,MAAM,eAAe,CAAA;AACrC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAEtC,QAAA,MAAM,MAAM,qCAAqC,CAAA;;;;;AAEjD;;;;;GAKG;AACH,qBAAa,gBAAiB,SAAQ,qBAGpC;IACA;;OAEG;IACH,QAAQ,CAAC,CAAC,MAAM,CAAC,sCAAU;IAC3B;;OAEG;IACH,CAAC,IAAI,CAAC,MAAM,CAAC;IAGb;;OAEG;IACH,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO;CAGhD"}
+{"version":3,"file":"SingletonAddress.d.ts","sourceRoot":"","sources":["../../../src/unstable/cluster/SingletonAddress.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,IAAI,MAAM,eAAe,CAAA;AACrC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAEtC,QAAA,MAAM,MAAM,qCAAqC,CAAA;;;;;AAEjD;;;;;GAKG;AACH,qBAAa,gBAAiB,SAAQ,qBAGpC;IACA;;;;OAIG;IACH,QAAQ,CAAC,CAAC,MAAM,CAAC,sCAAU;IAC3B;;;;OAIG;IACH,CAAC,IAAI,CAAC,MAAM,CAAC;IAGb;;;;OAIG;IACH,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO;CAGhD"}

package/dist/unstable/cluster/SingletonAddress.js

@@ -1,4 +1,18 @@
 /**
+ * The `SingletonAddress` module defines the address used by cluster sharding to
+ * identify a registered singleton. A singleton address combines the singleton
+ * name with the `ShardId` that owns it, giving the runtime a stable key for
+ * registration events, equality checks, hashing, and runner-local fiber
+ * tracking.
+ *
+ * Use this module when observing singleton registrations or working with
+ * sharding internals that need to tell which shard currently owns a singleton.
+ * The shard id is derived from the singleton name and shard group at
+ * registration time, so changing either value changes ownership and routing.
+ * Ownership can also move as shard locks are acquired or released, so an address
+ * identifies the target shard rather than guaranteeing that a particular runner
+ * is currently executing the singleton.
+ *
  * @since 4.0.0
  */
 import * as Equal from "../../Equal.js";
@@ -9,24 +23,30 @@ const TypeId = "~effect/cluster/SingletonAddress";
 /**
  * Represents the unique address of an singleton within the cluster.
  *
- * @since 4.0.0
  * @category Address
+ * @since 4.0.0
  */
 export class SingletonAddress extends /*#__PURE__*/Schema.Class(TypeId)({
   shardId: ShardId,
   name: Schema.String
 }) {
   /**
+   * Marks this value as a cluster singleton address for runtime guards.
+   *
    * @since 4.0.0
    */
   [TypeId] = TypeId;
   /**
+   * Computes a structural hash from the singleton name and shard id.
+   *
    * @since 4.0.0
    */
   [Hash.symbol]() {
     return Hash.string(`${this.name}:${this.shardId.toString()}`);
   }
   /**
+   * Compares singleton addresses by name and shard id.
+   *
    * @since 4.0.0
    */
   [Equal.symbol](that) {

package/dist/unstable/cluster/SingletonAddress.js.map

@@ -1 +1 @@
-{"version":3,"file":"SingletonAddress.js","names":["Equal","Hash","Schema","ShardId","TypeId","SingletonAddress","Class","shardId","name","String","symbol","string","toString","that","equals"],"sources":["../../../src/unstable/cluster/SingletonAddress.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,SAASC,OAAO,QAAQ,cAAc;AAEtC,MAAMC,MAAM,GAAG,kCAAkC;AAEjD;;;;;;AAMA,OAAM,MAAOC,gBAAiB,sBAAQH,MAAM,CAACI,KAAK,CAAmBF,MAAM,CAAC,CAAC;EAC3EG,OAAO,EAAEJ,OAAO;EAChBK,IAAI,EAAEN,MAAM,CAACO;CACd,CAAC;EACA;;;EAGS,CAACL,MAAM,IAAIA,MAAM;EAC1B;;;EAGA,CAACH,IAAI,CAACS,MAAM,IAAC;IACX,OAAOT,IAAI,CAACU,MAAM,CAAC,GAAG,IAAI,CAACH,IAAI,IAAI,IAAI,CAACD,OAAO,CAACK,QAAQ,EAAE,EAAE,CAAC;EAC/D;EACA;;;EAGA,CAACZ,KAAK,CAACU,MAAM,EAAEG,IAAsB;IACnC,OAAO,IAAI,CAACL,IAAI,KAAKK,IAAI,CAACL,IAAI,IAAIR,KAAK,CAACc,MAAM,CAAC,IAAI,CAACP,OAAO,EAAEM,IAAI,CAACN,OAAO,CAAC;EAC5E","ignoreList":[]}
+{"version":3,"file":"SingletonAddress.js","names":["Equal","Hash","Schema","ShardId","TypeId","SingletonAddress","Class","shardId","name","String","symbol","string","toString","that","equals"],"sources":["../../../src/unstable/cluster/SingletonAddress.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;AAiBA,OAAO,KAAKA,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,SAASC,OAAO,QAAQ,cAAc;AAEtC,MAAMC,MAAM,GAAG,kCAAkC;AAEjD;;;;;;AAMA,OAAM,MAAOC,gBAAiB,sBAAQH,MAAM,CAACI,KAAK,CAAmBF,MAAM,CAAC,CAAC;EAC3EG,OAAO,EAAEJ,OAAO;EAChBK,IAAI,EAAEN,MAAM,CAACO;CACd,CAAC;EACA;;;;;EAKS,CAACL,MAAM,IAAIA,MAAM;EAC1B;;;;;EAKA,CAACH,IAAI,CAACS,MAAM,IAAC;IACX,OAAOT,IAAI,CAACU,MAAM,CAAC,GAAG,IAAI,CAACH,IAAI,IAAI,IAAI,CAACD,OAAO,CAACK,QAAQ,EAAE,EAAE,CAAC;EAC/D;EACA;;;;;EAKA,CAACZ,KAAK,CAACU,MAAM,EAAEG,IAAsB;IACnC,OAAO,IAAI,CAACL,IAAI,KAAKK,IAAI,CAACL,IAAI,IAAIR,KAAK,CAACc,MAAM,CAAC,IAAI,CAACP,OAAO,EAAEM,IAAI,CAACN,OAAO,CAAC;EAC5E","ignoreList":[]}

package/dist/unstable/cluster/Snowflake.d.ts

@@ -1,4 +1,22 @@
 /**
+ * The `Snowflake` module provides compact, sortable identifiers for cluster
+ * resources and events. A snowflake id is a branded `bigint` made from a
+ * millisecond timestamp, a machine id, and a per-machine sequence number.
+ *
+ * **Common use cases**
+ *
+ * - Creating ids without coordinating through a central database
+ * - Ordering cluster events, entity ids, or log records by generation time
+ * - Encoding ids as strings at service boundaries with {@link SnowflakeFromString}
+ * - Decoding a generated id into timestamp, machine id, and sequence parts with {@link toParts}
+ *
+ * **Gotchas**
+ *
+ * - Uniqueness depends on each concurrent generator using a distinct machine id
+ * - Generated ids are time-sortable, but they are not random or secret values
+ * - The default generator prevents local clock drift from moving ids backward
+ * - More than 4096 ids in the same millisecond advance the logical timestamp
+ *
  * @since 4.0.0
  */
 import type * as Brand from "../../Brand.ts";
@@ -9,31 +27,45 @@ import * as Layer from "../../Layer.ts";
 import * as Schema from "../../Schema.ts";
 import type { MachineId } from "./MachineId.ts";
 /**
+ * Runtime brand identifier for cluster snowflake ids.
+ *
  * @since 4.0.0
  */
 export declare const TypeId = "~effect/cluster/Snowflake";
 /**
+ * Type-level representation of the cluster snowflake brand identifier.
+ *
  * @since 4.0.0
  */
 export type TypeId = typeof TypeId;
 /**
- * @since 4.0.0
+ * Branded bigint identifier composed from a timestamp, machine id, and per-machine
+ * sequence number.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export type Snowflake = Brand.Branded<bigint, TypeId>;
 /**
- * @since 4.0.0
+ * Constructs a branded `Snowflake` from a bigint or bigint-compatible string.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export declare const Snowflake: (input: string | bigint) => Snowflake;
 /**
- * @since 4.0.0
+ * Namespace containing support types for snowflake parts and generators.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export declare namespace Snowflake {
     /**
-     * @since 4.0.0
+     * Decoded components of a snowflake id: Unix timestamp milliseconds, machine id,
+     * and sequence number.
+     *
      * @category Models
+     * @since 4.0.0
      */
     interface Parts {
         readonly timestamp: number;
@@ -41,8 +73,11 @@ export declare namespace Snowflake {
         readonly sequence: number;
     }
     /**
-     * @since 4.0.0
+     * Stateful generator for runner-local snowflake ids, exposing an unsafe
+     * synchronous `nextUnsafe` operation and an effectful machine id setter.
+     *
      * @category Models
+     * @since 4.0.0
      */
     interface Generator {
         readonly nextUnsafe: () => Snowflake;
@@ -50,35 +85,50 @@ export declare namespace Snowflake {
     }
 }
 /**
- * @since 4.0.0
+ * Schema type for snowflake ids represented as branded bigints.
+ *
  * @category Schemas
+ * @since 4.0.0
  */
 export interface SnowflakeFromBigInt extends Schema.brand<Schema.BigInt, TypeId> {
 }
 /**
- * @since 4.0.0
+ * Schema for snowflake ids represented as branded bigints.
+ *
  * @category Schemas
+ * @since 4.0.0
  */
 export declare const SnowflakeFromBigInt: SnowflakeFromBigInt;
 /**
- * @since 4.0.0
+ * Schema type for snowflake ids decoded from strings into branded bigints.
+ *
  * @category Schemas
+ * @since 4.0.0
  */
 export interface SnowflakeFromString extends Schema.decodeTo<SnowflakeFromBigInt, Schema.String> {
 }
 /**
- * @since 4.0.0
+ * Schema that decodes snowflake ids from strings into branded bigints and encodes
+ * them back to strings.
+ *
  * @category Schemas
+ * @since 4.0.0
  */
 export declare const SnowflakeFromString: SnowflakeFromString;
 /**
- * @since 4.0.0
+ * Custom snowflake epoch in Unix milliseconds, set to January 1, 2025 UTC.
+ *
  * @category Epoch
+ * @since 4.0.0
  */
 export declare const constEpochMillis: number;
 /**
- * @since 4.0.0
+ * Packs a timestamp, machine id, and sequence number into a branded snowflake id,
+ * using the custom snowflake epoch and 10-bit machine id and 12-bit sequence
+ * fields.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export declare const make: (options: {
     readonly machineId: MachineId;
@@ -86,45 +136,65 @@ export declare const make: (options: {
     readonly timestamp: number;
 }) => Snowflake;
 /**
- * @since 4.0.0
+ * Extracts the Unix timestamp in milliseconds from a snowflake id.
+ *
  * @category Parts
+ * @since 4.0.0
  */
 export declare const timestamp: (snowflake: Snowflake) => number;
 /**
- * @since 4.0.0
+ * Extracts the timestamp from a snowflake id as a `DateTime.Utc`.
+ *
  * @category Parts
+ * @since 4.0.0
  */
 export declare const dateTime: (snowflake: Snowflake) => DateTime.Utc;
 /**
- * @since 4.0.0
+ * Extracts the machine id component from a snowflake id.
+ *
  * @category Parts
+ * @since 4.0.0
  */
 export declare const machineId: (snowflake: Snowflake) => MachineId;
 /**
- * @since 4.0.0
+ * Extracts the per-machine sequence component from a snowflake id.
+ *
  * @category Parts
+ * @since 4.0.0
  */
 export declare const sequence: (snowflake: Snowflake) => number;
 /**
- * @since 4.0.0
+ * Decomposes a snowflake id into its timestamp, machine id, and sequence parts.
+ *
  * @category Parts
+ * @since 4.0.0
  */
 export declare const toParts: (snowflake: Snowflake) => Snowflake.Parts;
 /**
- * @since 4.0.0
+ * Creates a stateful snowflake generator using `Clock`.
+ *
+ * The generator starts with a random machine id, never moves generated timestamps
+ * backward, resets the sequence each millisecond, and advances the timestamp when
+ * more than 4096 ids are requested in the same millisecond.
+ *
  * @category Generator
+ * @since 4.0.0
  */
 export declare const makeGenerator: Effect.Effect<Snowflake.Generator>;
 declare const Generator_base: Context.ServiceClass<Generator, "effect/cluster/Snowflake/Generator", Snowflake.Generator>;
 /**
- * @since 4.0.0
+ * Context service for a stateful snowflake id generator.
+ *
  * @category Generator
+ * @since 4.0.0
  */
 export declare class Generator extends Generator_base {
 }
 /**
- * @since 4.0.0
+ * Layer that provides the default snowflake `Generator` service.
+ *
  * @category Generator
+ * @since 4.0.0
  */
 export declare const layerGenerator: Layer.Layer<Generator>;
 export {};

package/dist/unstable/cluster/Snowflake.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Snowflake.d.ts","sourceRoot":"","sources":["../../../src/unstable/cluster/Snowflake.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAE5C,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAA;AAC7C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAEzC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAEzC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C;;GAEG;AACH,eAAO,MAAM,MAAM,8BAA8B,CAAA;AAEjD;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAA;AAElC;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAErD;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,OAAO,MAAM,GAAG,MAAM,KAAG,SAC0B,CAAA;AAE7E;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC;;;OAGG;IACH,UAAiB,KAAK;QACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;QAC1B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;QAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;KAC1B;IAED;;;OAGG;IACH,UAAiB,SAAS;QACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,SAAS,CAAA;QACpC,QAAQ,CAAC,YAAY,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;KACrE;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAAG;AAEnF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,mBAA8D,CAAA;AAEhG;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,MAAM,CAAC;CAAG;AAEnG;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,mBAEjC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAA6B,CAAA;AAQ5D;;;GAGG;AACH,eAAO,MAAM,IAAI,GAAI,SAAS;IAC5B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;CAC3B,KAAG,SAG+C,CAAA;AAEnD;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,WAAW,SAAS,KAAG,MAA6D,CAAA;AAE9G;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,WAAW,SAAS,KAAG,QAAQ,CAAC,GAAgD,CAAA;AAEzG;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,WAAW,SAAS,KAAG,SACoB,CAAA;AAErE;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,WAAW,SAAS,KAAG,MAA6C,CAAA;AAE7F;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,WAAW,SAAS,KAAG,SAAS,CAAC,KAIvD,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAoC3D,CAAA;;AAEF;;;GAGG;AACH,qBAAa,SAAU,SAAQ,cAGU;CAAG;AAE5C;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,CAA0C,CAAA"}
+{"version":3,"file":"Snowflake.d.ts","sourceRoot":"","sources":["../../../src/unstable/cluster/Snowflake.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,KAAK,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAE5C,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAA;AAC7C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAEzC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAEzC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C;;;;GAIG;AACH,eAAO,MAAM,MAAM,8BAA8B,CAAA;AAEjD;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAA;AAElC;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAErD;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,OAAO,MAAM,GAAG,MAAM,KAAG,SAC0B,CAAA;AAE7E;;;;;GAKG;AACH,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC;;;;;;OAMG;IACH,UAAiB,KAAK;QACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;QAC1B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;QAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;KAC1B;IAED;;;;;;OAMG;IACH,UAAiB,SAAS;QACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,SAAS,CAAA;QACpC,QAAQ,CAAC,YAAY,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;KACrE;CACF;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAAG;AAEnF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,EAAE,mBAA8D,CAAA;AAEhG;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,MAAM,CAAC;CAAG;AAEnG;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,EAAE,mBAEjC,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAA6B,CAAA;AAQ5D;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,GAAI,SAAS;IAC5B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;CAC3B,KAAG,SAG+C,CAAA;AAEnD;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,WAAW,SAAS,KAAG,MAA6D,CAAA;AAE9G;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,WAAW,SAAS,KAAG,QAAQ,CAAC,GAAgD,CAAA;AAEzG;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,WAAW,SAAS,KAAG,SACoB,CAAA;AAErE;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,WAAW,SAAS,KAAG,MAA6C,CAAA;AAE7F;;;;;GAKG;AACH,eAAO,MAAM,OAAO,GAAI,WAAW,SAAS,KAAG,SAAS,CAAC,KAIvD,CAAA;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAoC3D,CAAA;;AAEF;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,cAGU;CAAG;AAE5C;;;;;GAKG;AACH,eAAO,MAAM,cAAc,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,CAA0C,CAAA"}

package/dist/unstable/cluster/Snowflake.js

@@ -7,27 +7,38 @@ import * as Layer from "../../Layer.js";
 import * as Schema from "../../Schema.js";
 import * as Transformation from "../../SchemaTransformation.js";
 /**
+ * Runtime brand identifier for cluster snowflake ids.
+ *
  * @since 4.0.0
  */
 export const TypeId = "~effect/cluster/Snowflake";
 /**
- * @since 4.0.0
+ * Constructs a branded `Snowflake` from a bigint or bigint-compatible string.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export const Snowflake = input => typeof input === "string" ? BigInt(input) : input;
 /**
- * @since 4.0.0
+ * Schema for snowflake ids represented as branded bigints.
+ *
  * @category Schemas
+ * @since 4.0.0
  */
 export const SnowflakeFromBigInt = /*#__PURE__*/Schema.BigInt.pipe(/*#__PURE__*/Schema.brand(TypeId));
 /**
- * @since 4.0.0
+ * Schema that decodes snowflake ids from strings into branded bigints and encodes
+ * them back to strings.
+ *
  * @category Schemas
+ * @since 4.0.0
  */
 export const SnowflakeFromString = /*#__PURE__*/Schema.String.pipe(/*#__PURE__*/Schema.decodeTo(SnowflakeFromBigInt, Transformation.bigintFromString));
 /**
- * @since 4.0.0
+ * Custom snowflake epoch in Unix milliseconds, set to January 1, 2025 UTC.
+ *
  * @category Epoch
+ * @since 4.0.0
  */
 export const constEpochMillis = /*#__PURE__*/Date.UTC(2025, 0, 1);
 const sinceUnixEpoch = constEpochMillis - /*#__PURE__*/Date.UTC(1970, 0, 1);
@@ -36,33 +47,47 @@ const constBigInt22 = /*#__PURE__*/BigInt(22);
 const constBigInt1024 = /*#__PURE__*/BigInt(1024);
 const constBigInt4096 = /*#__PURE__*/BigInt(4096);
 /**
- * @since 4.0.0
+ * Packs a timestamp, machine id, and sequence number into a branded snowflake id,
+ * using the custom snowflake epoch and 10-bit machine id and 12-bit sequence
+ * fields.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const make = options => BigInt(options.timestamp - constEpochMillis) << constBigInt22 | BigInt(options.machineId % 1024) << constBigInt12 | BigInt(options.sequence % 4096);
 /**
- * @since 4.0.0
+ * Extracts the Unix timestamp in milliseconds from a snowflake id.
+ *
  * @category Parts
+ * @since 4.0.0
  */
 export const timestamp = snowflake => Number(snowflake >> constBigInt22) + sinceUnixEpoch;
 /**
- * @since 4.0.0
+ * Extracts the timestamp from a snowflake id as a `DateTime.Utc`.
+ *
  * @category Parts
+ * @since 4.0.0
  */
 export const dateTime = snowflake => DateTime.makeUnsafe(timestamp(snowflake));
 /**
- * @since 4.0.0
+ * Extracts the machine id component from a snowflake id.
+ *
  * @category Parts
+ * @since 4.0.0
  */
 export const machineId = snowflake => Number((snowflake >> constBigInt12) % constBigInt1024);
 /**
- * @since 4.0.0
+ * Extracts the per-machine sequence component from a snowflake id.
+ *
  * @category Parts
+ * @since 4.0.0
  */
 export const sequence = snowflake => Number(snowflake % constBigInt4096);
 /**
- * @since 4.0.0
+ * Decomposes a snowflake id into its timestamp, machine id, and sequence parts.
+ *
  * @category Parts
+ * @since 4.0.0
  */
 export const toParts = snowflake => ({
   timestamp: timestamp(snowflake),
@@ -70,8 +95,14 @@ export const toParts = snowflake => ({
   sequence: sequence(snowflake)
 });
 /**
- * @since 4.0.0
+ * Creates a stateful snowflake generator using `Clock`.
+ *
+ * The generator starts with a random machine id, never moves generated timestamps
+ * backward, resets the sequence each millisecond, and advances the timestamp when
+ * more than 4096 ids are requested in the same millisecond.
+ *
  * @category Generator
+ * @since 4.0.0
  */
 export const makeGenerator = /*#__PURE__*/Effect.gen(function* () {
   let machineId = Math.floor(Math.random() * 1024);
@@ -106,13 +137,17 @@ export const makeGenerator = /*#__PURE__*/Effect.gen(function* () {
   });
 });
 /**
- * @since 4.0.0
+ * Context service for a stateful snowflake id generator.
+ *
  * @category Generator
+ * @since 4.0.0
  */
 export class Generator extends /*#__PURE__*/Context.Service()("effect/cluster/Snowflake/Generator") {}
 /**
- * @since 4.0.0
+ * Layer that provides the default snowflake `Generator` service.
+ *
  * @category Generator
+ * @since 4.0.0
  */
 export const layerGenerator = /*#__PURE__*/Layer.effect(Generator)(makeGenerator);
 //# sourceMappingURL=Snowflake.js.map

package/dist/unstable/cluster/Snowflake.js.map

@@ -1 +1 @@
-{"version":3,"file":"Snowflake.js","names":["Clock","Context","DateTime","Effect","identity","Layer","Schema","Transformation","TypeId","Snowflake","input","BigInt","SnowflakeFromBigInt","pipe","brand","SnowflakeFromString","String","decodeTo","bigintFromString","constEpochMillis","Date","UTC","sinceUnixEpoch","constBigInt12","constBigInt22","constBigInt1024","constBigInt4096","make","options","timestamp","machineId","sequence","snowflake","Number","dateTime","makeUnsafe","toParts","makeGenerator","gen","Math","floor","random","clock","sequenceAt","currentTimeMillisUnsafe","setMachineId","newMachineId","sync","nextUnsafe","now","Generator","Service","layerGenerator","effect"],"sources":["../../../src/unstable/cluster/Snowflake.ts"],"sourcesContent":[null],"mappings":"AAIA,SAASA,KAAK,QAAQ,gBAAgB;AACtC,OAAO,KAAKC,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,QAAQ,MAAM,mBAAmB;AAC7C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,SAASC,QAAQ,QAAQ,mBAAmB;AAC5C,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,cAAc,MAAM,+BAA+B;AAG/D;;;AAGA,OAAO,MAAMC,MAAM,GAAG,2BAA2B;AAajD;;;;AAIA,OAAO,MAAMC,SAAS,GAAIC,KAAsB,IAC9C,OAAOA,KAAK,KAAK,QAAQ,GAAGC,MAAM,CAACD,KAAK,CAAc,GAAGA,KAAkB;AAiC7E;;;;AAIA,OAAO,MAAME,mBAAmB,gBAAwBN,MAAM,CAACK,MAAM,CAACE,IAAI,cAACP,MAAM,CAACQ,KAAK,CAACN,MAAM,CAAC,CAAC;AAQhG;;;;AAIA,OAAO,MAAMO,mBAAmB,gBAAwBT,MAAM,CAACU,MAAM,CAACH,IAAI,cACxEP,MAAM,CAACW,QAAQ,CAACL,mBAAmB,EAAEL,cAAc,CAACW,gBAAgB,CAAC,CACtE;AAED;;;;AAIA,OAAO,MAAMC,gBAAgB,gBAAWC,IAAI,CAACC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;AAE5D,MAAMC,cAAc,GAAGH,gBAAgB,gBAAGC,IAAI,CAACC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;AAC9D,MAAME,aAAa,gBAAGZ,MAAM,CAAC,EAAE,CAAC;AAChC,MAAMa,aAAa,gBAAGb,MAAM,CAAC,EAAE,CAAC;AAChC,MAAMc,eAAe,gBAAGd,MAAM,CAAC,IAAI,CAAC;AACpC,MAAMe,eAAe,gBAAGf,MAAM,CAAC,IAAI,CAAC;AAEpC;;;;AAIA,OAAO,MAAMgB,IAAI,GAAIC,OAIpB,IACEjB,MAAM,CAACiB,OAAO,CAACC,SAAS,GAAGV,gBAAgB,CAAC,IAAIK,aAAa,GACzDb,MAAM,CAACiB,OAAO,CAACE,SAAS,GAAG,IAAI,CAAC,IAAIP,aAAc,GACnDZ,MAAM,CAACiB,OAAO,CAACG,QAAQ,GAAG,IAAI,CAAe;AAEnD;;;;AAIA,OAAO,MAAMF,SAAS,GAAIG,SAAoB,IAAaC,MAAM,CAACD,SAAS,IAAIR,aAAa,CAAC,GAAGF,cAAc;AAE9G;;;;AAIA,OAAO,MAAMY,QAAQ,GAAIF,SAAoB,IAAmB9B,QAAQ,CAACiC,UAAU,CAACN,SAAS,CAACG,SAAS,CAAC,CAAC;AAEzG;;;;AAIA,OAAO,MAAMF,SAAS,GAAIE,SAAoB,IAC5CC,MAAM,CAAC,CAACD,SAAS,IAAIT,aAAa,IAAIE,eAAe,CAAc;AAErE;;;;AAIA,OAAO,MAAMM,QAAQ,GAAIC,SAAoB,IAAaC,MAAM,CAACD,SAAS,GAAGN,eAAe,CAAC;AAE7F;;;;AAIA,OAAO,MAAMU,OAAO,GAAIJ,SAAoB,KAAuB;EACjEH,SAAS,EAAEA,SAAS,CAACG,SAAS,CAAC;EAC/BF,SAAS,EAAEA,SAAS,CAACE,SAAS,CAAC;EAC/BD,QAAQ,EAAEA,QAAQ,CAACC,SAAS;CAC7B,CAAC;AAEF;;;;AAIA,OAAO,MAAMK,aAAa,gBAAuClC,MAAM,CAACmC,GAAG,CAAC,aAAS;EACnF,IAAIR,SAAS,GAAGS,IAAI,CAACC,KAAK,CAACD,IAAI,CAACE,MAAM,EAAE,GAAG,IAAI,CAAc;EAC7D,MAAMC,KAAK,GAAG,OAAO1C,KAAK;EAE1B,IAAI+B,QAAQ,GAAG,CAAC;EAChB,IAAIY,UAAU,GAAGJ,IAAI,CAACC,KAAK,CAACE,KAAK,CAACE,uBAAuB,EAAE,CAAC;EAE5D,OAAOxC,QAAQ,CAAsB;IACnCyC,YAAY,EAAGC,YAAY,IACzB3C,MAAM,CAAC4C,IAAI,CAAC,MAAK;MACfjB,SAAS,GAAGgB,YAAY;IAC1B,CAAC,CAAC;IACJE,UAAUA,CAAA;MACR,IAAIC,GAAG,GAAGV,IAAI,CAACC,KAAK,CAACE,KAAK,CAACE,uBAAuB,EAAE,CAAC;MAErD;MACA,IAAIK,GAAG,GAAGN,UAAU,EAAE;QACpBM,GAAG,GAAGN,UAAU;MAClB,CAAC,MAAM,IAAIM,GAAG,GAAGN,UAAU,EAAE;QAC3B;QACAZ,QAAQ,GAAG,CAAC;QACZY,UAAU,GAAGM,GAAG;MAClB,CAAC,MAAM,IAAIlB,QAAQ,IAAI,IAAI,EAAE;QAC3B;QACA;QACAY,UAAU,EAAE;QACZZ,QAAQ,GAAG,CAAC;MACd;MAEA,OAAOJ,IAAI,CAAC;QACVG,SAAS;QACTC,QAAQ,EAAEA,QAAQ,EAAE;QACpBF,SAAS,EAAEc;OACZ,CAAC;IACJ;GACD,CAAC;AACJ,CAAC,CAAC;AAEF;;;;AAIA,OAAM,MAAOO,SAAU,sBAAQjD,OAAO,CAACkD,OAAO,EAG3C,CAAC,oCAAoC,CAAC;AAEzC;;;;AAIA,OAAO,MAAMC,cAAc,gBAA2B/C,KAAK,CAACgD,MAAM,CAACH,SAAS,CAAC,CAACb,aAAa,CAAC","ignoreList":[]}
+{"version":3,"file":"Snowflake.js","names":["Clock","Context","DateTime","Effect","identity","Layer","Schema","Transformation","TypeId","Snowflake","input","BigInt","SnowflakeFromBigInt","pipe","brand","SnowflakeFromString","String","decodeTo","bigintFromString","constEpochMillis","Date","UTC","sinceUnixEpoch","constBigInt12","constBigInt22","constBigInt1024","constBigInt4096","make","options","timestamp","machineId","sequence","snowflake","Number","dateTime","makeUnsafe","toParts","makeGenerator","gen","Math","floor","random","clock","sequenceAt","currentTimeMillisUnsafe","setMachineId","newMachineId","sync","nextUnsafe","now","Generator","Service","layerGenerator","effect"],"sources":["../../../src/unstable/cluster/Snowflake.ts"],"sourcesContent":[null],"mappings":"AAsBA,SAASA,KAAK,QAAQ,gBAAgB;AACtC,OAAO,KAAKC,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,QAAQ,MAAM,mBAAmB;AAC7C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,SAASC,QAAQ,QAAQ,mBAAmB;AAC5C,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,cAAc,MAAM,+BAA+B;AAG/D;;;;;AAKA,OAAO,MAAMC,MAAM,GAAG,2BAA2B;AAkBjD;;;;;;AAMA,OAAO,MAAMC,SAAS,GAAIC,KAAsB,IAC9C,OAAOA,KAAK,KAAK,QAAQ,GAAGC,MAAM,CAACD,KAAK,CAAc,GAAGA,KAAkB;AA2C7E;;;;;;AAMA,OAAO,MAAME,mBAAmB,gBAAwBN,MAAM,CAACK,MAAM,CAACE,IAAI,cAACP,MAAM,CAACQ,KAAK,CAACN,MAAM,CAAC,CAAC;AAUhG;;;;;;;AAOA,OAAO,MAAMO,mBAAmB,gBAAwBT,MAAM,CAACU,MAAM,CAACH,IAAI,cACxEP,MAAM,CAACW,QAAQ,CAACL,mBAAmB,EAAEL,cAAc,CAACW,gBAAgB,CAAC,CACtE;AAED;;;;;;AAMA,OAAO,MAAMC,gBAAgB,gBAAWC,IAAI,CAACC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;AAE5D,MAAMC,cAAc,GAAGH,gBAAgB,gBAAGC,IAAI,CAACC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;AAC9D,MAAME,aAAa,gBAAGZ,MAAM,CAAC,EAAE,CAAC;AAChC,MAAMa,aAAa,gBAAGb,MAAM,CAAC,EAAE,CAAC;AAChC,MAAMc,eAAe,gBAAGd,MAAM,CAAC,IAAI,CAAC;AACpC,MAAMe,eAAe,gBAAGf,MAAM,CAAC,IAAI,CAAC;AAEpC;;;;;;;;AAQA,OAAO,MAAMgB,IAAI,GAAIC,OAIpB,IACEjB,MAAM,CAACiB,OAAO,CAACC,SAAS,GAAGV,gBAAgB,CAAC,IAAIK,aAAa,GACzDb,MAAM,CAACiB,OAAO,CAACE,SAAS,GAAG,IAAI,CAAC,IAAIP,aAAc,GACnDZ,MAAM,CAACiB,OAAO,CAACG,QAAQ,GAAG,IAAI,CAAe;AAEnD;;;;;;AAMA,OAAO,MAAMF,SAAS,GAAIG,SAAoB,IAAaC,MAAM,CAACD,SAAS,IAAIR,aAAa,CAAC,GAAGF,cAAc;AAE9G;;;;;;AAMA,OAAO,MAAMY,QAAQ,GAAIF,SAAoB,IAAmB9B,QAAQ,CAACiC,UAAU,CAACN,SAAS,CAACG,SAAS,CAAC,CAAC;AAEzG;;;;;;AAMA,OAAO,MAAMF,SAAS,GAAIE,SAAoB,IAC5CC,MAAM,CAAC,CAACD,SAAS,IAAIT,aAAa,IAAIE,eAAe,CAAc;AAErE;;;;;;AAMA,OAAO,MAAMM,QAAQ,GAAIC,SAAoB,IAAaC,MAAM,CAACD,SAAS,GAAGN,eAAe,CAAC;AAE7F;;;;;;AAMA,OAAO,MAAMU,OAAO,GAAIJ,SAAoB,KAAuB;EACjEH,SAAS,EAAEA,SAAS,CAACG,SAAS,CAAC;EAC/BF,SAAS,EAAEA,SAAS,CAACE,SAAS,CAAC;EAC/BD,QAAQ,EAAEA,QAAQ,CAACC,SAAS;CAC7B,CAAC;AAEF;;;;;;;;;;AAUA,OAAO,MAAMK,aAAa,gBAAuClC,MAAM,CAACmC,GAAG,CAAC,aAAS;EACnF,IAAIR,SAAS,GAAGS,IAAI,CAACC,KAAK,CAACD,IAAI,CAACE,MAAM,EAAE,GAAG,IAAI,CAAc;EAC7D,MAAMC,KAAK,GAAG,OAAO1C,KAAK;EAE1B,IAAI+B,QAAQ,GAAG,CAAC;EAChB,IAAIY,UAAU,GAAGJ,IAAI,CAACC,KAAK,CAACE,KAAK,CAACE,uBAAuB,EAAE,CAAC;EAE5D,OAAOxC,QAAQ,CAAsB;IACnCyC,YAAY,EAAGC,YAAY,IACzB3C,MAAM,CAAC4C,IAAI,CAAC,MAAK;MACfjB,SAAS,GAAGgB,YAAY;IAC1B,CAAC,CAAC;IACJE,UAAUA,CAAA;MACR,IAAIC,GAAG,GAAGV,IAAI,CAACC,KAAK,CAACE,KAAK,CAACE,uBAAuB,EAAE,CAAC;MAErD;MACA,IAAIK,GAAG,GAAGN,UAAU,EAAE;QACpBM,GAAG,GAAGN,UAAU;MAClB,CAAC,MAAM,IAAIM,GAAG,GAAGN,UAAU,EAAE;QAC3B;QACAZ,QAAQ,GAAG,CAAC;QACZY,UAAU,GAAGM,GAAG;MAClB,CAAC,MAAM,IAAIlB,QAAQ,IAAI,IAAI,EAAE;QAC3B;QACA;QACAY,UAAU,EAAE;QACZZ,QAAQ,GAAG,CAAC;MACd;MAEA,OAAOJ,IAAI,CAAC;QACVG,SAAS;QACTC,QAAQ,EAAEA,QAAQ,EAAE;QACpBF,SAAS,EAAEc;OACZ,CAAC;IACJ;GACD,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;AAMA,OAAM,MAAOO,SAAU,sBAAQjD,OAAO,CAACkD,OAAO,EAG3C,CAAC,oCAAoC,CAAC;AAEzC;;;;;;AAMA,OAAO,MAAMC,cAAc,gBAA2B/C,KAAK,CAACgD,MAAM,CAACH,SAAS,CAAC,CAACb,aAAa,CAAC","ignoreList":[]}

package/dist/unstable/cluster/SocketRunner.d.ts

@@ -8,13 +8,19 @@ import type * as RunnerStorage from "./RunnerStorage.ts";
 import type * as Sharding from "./Sharding.ts";
 import type { ShardingConfig } from "./ShardingConfig.ts";
 /**
- * @since 4.0.0
+ * Layer that runs a cluster runner over the socket RPC protocol, providing
+ * `Sharding` and `Runners` clients and logging the socket listen address.
+ *
  * @category Layers
+ * @since 4.0.0
  */
 export declare const layer: Layer.Layer<Sharding.Sharding | Runners.Runners, never, Runners.RpcClientProtocol | ShardingConfig | RpcSerialization.RpcSerialization | SocketServer | MessageStorage | RunnerStorage.RunnerStorage | RunnerHealth>;
 /**
- * @since 4.0.0
+ * Client-only socket runner layer that provides `Sharding` and `Runners` clients
+ * without starting a runner server or receiving shard assignments.
+ *
  * @category Layers
+ * @since 4.0.0
  */
 export declare const layerClientOnly: Layer.Layer<Sharding.Sharding | Runners.Runners, never, Runners.RpcClientProtocol | ShardingConfig | MessageStorage | RunnerStorage.RunnerStorage>;
 //# sourceMappingURL=SocketRunner.d.ts.map

package/dist/unstable/cluster/SocketRunner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SocketRunner.d.ts","sourceRoot":"","sources":["../../../src/unstable/cluster/SocketRunner.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,KAAK,gBAAgB,MAAM,4BAA4B,CAAA;AAEnE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAE5C,OAAO,KAAK,KAAK,aAAa,MAAM,oBAAoB,CAAA;AACxD,OAAO,KAAK,KAAK,QAAQ,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAczD;;;GAGG;AACH,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CAC7B,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,EACnC,KAAK,EACH,OAAO,CAAC,iBAAiB,GACzB,cAAc,GACd,gBAAgB,CAAC,gBAAgB,GACjC,YAAY,GACZ,cAAc,GACd,aAAa,CAAC,aAAa,GAC3B,YAAY,CAIf,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,KAAK,CAAC,KAAK,CACvC,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,EACnC,KAAK,EACL,OAAO,CAAC,iBAAiB,GAAG,cAAc,GAAG,cAAc,GAAG,aAAa,CAAC,aAAa,CAC3D,CAAA"}
+{"version":3,"file":"SocketRunner.d.ts","sourceRoot":"","sources":["../../../src/unstable/cluster/SocketRunner.ts"],"names":[],"mappings":"AAyBA,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,KAAK,gBAAgB,MAAM,4BAA4B,CAAA;AAEnE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAE5C,OAAO,KAAK,KAAK,aAAa,MAAM,oBAAoB,CAAA;AACxD,OAAO,KAAK,KAAK,QAAQ,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAczD;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CAC7B,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,EACnC,KAAK,EACH,OAAO,CAAC,iBAAiB,GACzB,cAAc,GACd,gBAAgB,CAAC,gBAAgB,GACjC,YAAY,GACZ,cAAc,GACd,aAAa,CAAC,aAAa,GAC3B,YAAY,CAIf,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,EAAE,KAAK,CAAC,KAAK,CACvC,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,EACnC,KAAK,EACL,OAAO,CAAC,iBAAiB,GAAG,cAAc,GAAG,cAAc,GAAG,aAAa,CAAC,aAAa,CAC3D,CAAA"}

package/dist/unstable/cluster/SocketRunner.js

@@ -1,4 +1,25 @@
 /**
+ * The `SocketRunner` module wires cluster runner RPCs to socket transports. It
+ * provides a complete runner layer that serves RPC handlers on a `SocketServer`
+ * and installs `Sharding` and `Runners` clients for talking to other runners
+ * through the socket RPC protocol.
+ *
+ * **Common tasks**
+ *
+ * - Run a cluster worker over TCP or Unix sockets with {@link layer}
+ * - Connect to other runners while exposing `Sharding` and `Runners` clients
+ * - Embed a client-only cluster participant with {@link layerClientOnly} when
+ *   the process should send messages but not receive shard assignments
+ *
+ * **Transport gotchas**
+ *
+ * - The server listen address comes from the provided `SocketServer` and is
+ *   logged when {@link layer} starts
+ * - TCP addresses are logged as `hostname:port`, while Unix socket addresses
+ *   are logged as their filesystem path
+ * - The client-only layer does not start a socket server; provide the full
+ *   layer when the process must accept runner RPCs
+ *
  * @since 4.0.0
  */
 import * as Effect from "../../Effect.js";
@@ -15,13 +36,19 @@ const withLogAddress = layer => Layer.effectDiscard(Effect.gen(function* () {
   });
 })).pipe(Layer.provideMerge(layer));
 /**
- * @since 4.0.0
+ * Layer that runs a cluster runner over the socket RPC protocol, providing
+ * `Sharding` and `Runners` clients and logging the socket listen address.
+ *
  * @category Layers
+ * @since 4.0.0
  */
 export const layer = /*#__PURE__*/RunnerServer.layerWithClients.pipe(withLogAddress, /*#__PURE__*/Layer.provide(RpcServer.layerProtocolSocketServer));
 /**
- * @since 4.0.0
+ * Client-only socket runner layer that provides `Sharding` and `Runners` clients
+ * without starting a runner server or receiving shard assignments.
+ *
  * @category Layers
+ * @since 4.0.0
  */
 export const layerClientOnly = RunnerServer.layerClientOnly;
 //# sourceMappingURL=SocketRunner.js.map

package/dist/unstable/cluster/SocketRunner.js.map

@@ -1 +1 @@
-{"version":3,"file":"SocketRunner.js","names":["Effect","Layer","RpcServer","SocketServer","RunnerServer","withLogAddress","layer","effectDiscard","gen","server","address","_tag","path","hostname","port","annotateLogs","logInfo","package","service","pipe","provideMerge","layerWithClients","provide","layerProtocolSocketServer","layerClientOnly"],"sources":["../../../src/unstable/cluster/SocketRunner.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AAEvC,OAAO,KAAKC,SAAS,MAAM,qBAAqB;AAChD,SAASC,YAAY,QAAQ,2BAA2B;AAIxD,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAKjD,MAAMC,cAAc,GAAaC,KAA2B,IAC1DL,KAAK,CAACM,aAAa,CAACP,MAAM,CAACQ,GAAG,CAAC,aAAS;EACtC,MAAMC,MAAM,GAAG,OAAON,YAAY;EAClC,MAAMO,OAAO,GAAGD,MAAM,CAACC,OAAO,CAACC,IAAI,KAAK,aAAa,GACjDF,MAAM,CAACC,OAAO,CAACE,IAAI,GACnB,GAAGH,MAAM,CAACC,OAAO,CAACG,QAAQ,IAAIJ,MAAM,CAACC,OAAO,CAACI,IAAI,EAAE;EACvD,OAAOd,MAAM,CAACe,YAAY,CAACf,MAAM,CAACgB,OAAO,CAAC,iBAAiBN,OAAO,EAAE,CAAC,EAAE;IACrEO,OAAO,EAAE,iBAAiB;IAC1BC,OAAO,EAAE;GACV,CAAC;AACJ,CAAC,CAAC,CAAC,CAACC,IAAI,CAAClB,KAAK,CAACmB,YAAY,CAACd,KAAK,CAAC,CAAC;AAErC;;;;AAIA,OAAO,MAAMA,KAAK,gBAUdF,YAAY,CAACiB,gBAAgB,CAACF,IAAI,CACpCd,cAAc,eACdJ,KAAK,CAACqB,OAAO,CAACpB,SAAS,CAACqB,yBAAyB,CAAC,CACnD;AAED;;;;AAIA,OAAO,MAAMC,eAAe,GAIxBpB,YAAY,CAACoB,eAAe","ignoreList":[]}
+{"version":3,"file":"SocketRunner.js","names":["Effect","Layer","RpcServer","SocketServer","RunnerServer","withLogAddress","layer","effectDiscard","gen","server","address","_tag","path","hostname","port","annotateLogs","logInfo","package","service","pipe","provideMerge","layerWithClients","provide","layerProtocolSocketServer","layerClientOnly"],"sources":["../../../src/unstable/cluster/SocketRunner.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,OAAO,KAAKA,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AAEvC,OAAO,KAAKC,SAAS,MAAM,qBAAqB;AAChD,SAASC,YAAY,QAAQ,2BAA2B;AAIxD,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAKjD,MAAMC,cAAc,GAAaC,KAA2B,IAC1DL,KAAK,CAACM,aAAa,CAACP,MAAM,CAACQ,GAAG,CAAC,aAAS;EACtC,MAAMC,MAAM,GAAG,OAAON,YAAY;EAClC,MAAMO,OAAO,GAAGD,MAAM,CAACC,OAAO,CAACC,IAAI,KAAK,aAAa,GACjDF,MAAM,CAACC,OAAO,CAACE,IAAI,GACnB,GAAGH,MAAM,CAACC,OAAO,CAACG,QAAQ,IAAIJ,MAAM,CAACC,OAAO,CAACI,IAAI,EAAE;EACvD,OAAOd,MAAM,CAACe,YAAY,CAACf,MAAM,CAACgB,OAAO,CAAC,iBAAiBN,OAAO,EAAE,CAAC,EAAE;IACrEO,OAAO,EAAE,iBAAiB;IAC1BC,OAAO,EAAE;GACV,CAAC;AACJ,CAAC,CAAC,CAAC,CAACC,IAAI,CAAClB,KAAK,CAACmB,YAAY,CAACd,KAAK,CAAC,CAAC;AAErC;;;;;;;AAOA,OAAO,MAAMA,KAAK,gBAUdF,YAAY,CAACiB,gBAAgB,CAACF,IAAI,CACpCd,cAAc,eACdJ,KAAK,CAACqB,OAAO,CAACpB,SAAS,CAACqB,yBAAyB,CAAC,CACnD;AAED;;;;;;;AAOA,OAAO,MAAMC,eAAe,GAIxBpB,YAAY,CAACoB,eAAe","ignoreList":[]}

package/dist/unstable/cluster/SqlMessageStorage.d.ts

@@ -5,20 +5,28 @@ import * as MessageStorage from "./MessageStorage.ts";
 import type { ShardingConfig } from "./ShardingConfig.ts";
 import * as Snowflake from "./Snowflake.ts";
 /**
- * @since 4.0.0
+ * Creates a SQL-backed `MessageStorage` implementation, running its migrations
+ * and using the optional table prefix.
+ *
  * @category Constructors
+ * @since 4.0.0
  */
 export declare const make: (options?: {
     readonly prefix?: string | undefined;
 }) => Effect.Effect<MessageStorage.MessageStorage["Service"], never, SqlClient.SqlClient | Snowflake.Generator>;
 /**
- * @since 4.0.0
+ * Layer that provides SQL-backed `MessageStorage` using the default table prefix
+ * and the default snowflake generator.
+ *
  * @category Layers
+ * @since 4.0.0
  */
 export declare const layer: Layer.Layer<MessageStorage.MessageStorage, never, SqlClient.SqlClient | ShardingConfig>;
 /**
- * @since 4.0.0
+ * Layer that provides SQL-backed `MessageStorage` using a custom table prefix.
+ *
  * @category Layers
+ * @since 4.0.0
  */
 export declare const layerWith: (options: {
     readonly prefix?: string | undefined;

package/dist/unstable/cluster/SqlMessageStorage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SqlMessageStorage.d.ts","sourceRoot":"","sources":["../../../src/unstable/cluster/SqlMessageStorage.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAIvC,OAAO,KAAK,SAAS,MAAM,qBAAqB,CAAA;AAKhD,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAIrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAI3C;;;GAGG;AACH,eAAO,MAAM,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACrC,KAAK,MAAM,CAAC,MAAM,CACjB,cAAc,CAAC,cAAc,CAAC,SAAS,CAAC,EACxC,KAAK,EACL,SAAS,CAAC,SAAS,GAAG,SAAS,CAAC,SAAS,CAyjBrB,CAAA;AAEtB;;;GAGG;AACH,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CAC7B,cAAc,CAAC,cAAc,EAC7B,KAAK,EACL,SAAS,CAAC,SAAS,GAAG,cAAc,CAGrC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,SAAS;IACjC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACrC,KAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,cAAc,EAAE,KAAK,EAAE,SAAS,CAAC,SAAS,GAAG,cAAc,CAGvF,CAAA"}
+{"version":3,"file":"SqlMessageStorage.d.ts","sourceRoot":"","sources":["../../../src/unstable/cluster/SqlMessageStorage.ts"],"names":[],"mappings":"AAqBA,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAIvC,OAAO,KAAK,SAAS,MAAM,qBAAqB,CAAA;AAKhD,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAIrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAI3C;;;;;;GAMG;AACH,eAAO,MAAM,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACrC,KAAK,MAAM,CAAC,MAAM,CACjB,cAAc,CAAC,cAAc,CAAC,SAAS,CAAC,EACxC,KAAK,EACL,SAAS,CAAC,SAAS,GAAG,SAAS,CAAC,SAAS,CAyjBrB,CAAA;AAEtB;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CAC7B,cAAc,CAAC,cAAc,EAC7B,KAAK,EACL,SAAS,CAAC,SAAS,GAAG,cAAc,CAGrC,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,SAAS;IACjC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACrC,KAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,cAAc,EAAE,KAAK,EAAE,SAAS,CAAC,SAAS,GAAG,cAAc,CAGvF,CAAA"}