effect 4.0.0-beta.66 → 4.0.0-beta.68

package/dist/unstable/eventlog/Event.d.ts

@@ -1,25 +1,34 @@
 import * as Schema from "../../Schema.ts";
 import * as Msgpack from "../encoding/Msgpack.ts";
 /**
+ * Unique type identifier used to mark event log event definitions.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category type ids
  */
 export type TypeId = "~effect/eventlog/Event";
 /**
+ * Runtime type identifier used to mark event log event definitions.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category type ids
  */
 export declare const TypeId: TypeId;
 /**
- * @since 4.0.0
+ * Returns `true` when a value is an event log event definition.
+ *
  * @category guards
+ * @since 4.0.0
  */
 export declare const isEvent: (u: unknown) => u is Event<any, any, any, any>;
 /**
- * Represents an event in an EventLog.
+ * Definition of an event type that can be written to an `EventLog`.
+ *
+ * An event definition contains its tag, primary-key function, payload schema,
+ * MessagePack payload schema, success schema, and error schema.
  *
- * @since 4.0.0
  * @category models
+ * @since 4.0.0
  */
 export interface Event<out Tag extends string, in out Payload extends Schema.Top = typeof Schema.Void, in out Success extends Schema.Top = typeof Schema.Void, in out Error extends Schema.Top = typeof Schema.Never> {
     readonly [TypeId]: TypeId;
@@ -31,16 +40,26 @@ export interface Event<out Tag extends string, in out Payload extends Schema.Top
     readonly error: Error;
 }
 /**
- * @since 4.0.0
+ * Marker service associated with the handler for an event tag.
+ *
+ * `ToService` derives this service from an `Event` so handler layers can expose
+ * which events they implement.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface EventHandler<in out Tag extends string> {
     readonly _: unique symbol;
     readonly tag: Tag;
 }
 /**
- * @since 4.0.0
+ * Type-erased event log event definition.
+ *
+ * It preserves the runtime tag, primary-key function, payload schema, success
+ * schema, and error schema without retaining the original type parameters.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface Any {
     readonly [TypeId]: TypeId;
@@ -52,121 +71,182 @@ export interface Any {
     readonly error: Schema.Top;
 }
 /**
- * @since 4.0.0
+ * Type-erased event definition with its runtime properties available
+ * structurally.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface AnyWithProps extends Any {
 }
 /**
- * @since 4.0.0
+ * Derives the handler service marker for an event definition.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ToService<A> = A extends Event<infer _Tag, infer _Payload, infer _Success, infer _Error> ? EventHandler<_Tag> : never;
 /**
- * @since 4.0.0
+ * Extracts the tag string from an event definition.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Tag<A> = A extends Event<infer _Tag, infer _Payload, infer _Success, infer _Error> ? _Tag : never;
 /**
- * @since 4.0.0
+ * Extracts the error schema from an event definition.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ErrorSchema<A extends Any> = A extends Event<infer _Tag, infer _Payload, infer _Success, infer _Error> ? _Error : never;
 /**
- * @since 4.0.0
+ * Decoded error value type for an event definition.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Error<A extends Any> = Schema.Schema.Type<ErrorSchema<A>>;
 /**
- * @since 4.0.0
+ * Returns an event definition type whose error schema also includes the provided
+ * error schema.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type AddError<A extends Any, Error extends Schema.Top> = A extends Event<infer _Tag, infer _Payload, infer _Success, infer _Error> ? Event<_Tag, _Payload, _Success, _Error | Error> : never;
 /**
- * @since 4.0.0
+ * Extracts the payload schema from an event definition.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type PayloadSchema<A extends Any> = A extends Event<infer _Tag, infer _Payload, infer _Success, infer _Error> ? _Payload : never;
 /**
- * @since 4.0.0
+ * Extracts the payload schema for the event in a union with the specified tag.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type PayloadSchemaWithTag<A extends Any, Tag extends string> = A extends Event<Tag, infer _Payload, infer _Success, infer _Error> ? _Payload : never;
 /**
- * @since 4.0.0
+ * Decoded payload value type for an event definition.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Payload<A extends Any> = Schema.Schema.Type<PayloadSchema<A>>;
 /**
- * @since 4.0.0
+ * Tagged payload value for an event definition.
+ *
+ * The result contains `_tag` set to the event tag and `payload` set to the
+ * decoded payload value.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type TaggedPayload<A extends Any> = A extends Event<infer _Tag, infer _Payload, infer _Success, infer _Error> ? {
     readonly _tag: _Tag;
     readonly payload: Schema.Schema.Type<_Payload>;
 } : never;
 /**
- * @since 4.0.0
+ * Extracts the success schema from an event definition.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type SuccessSchema<A extends Any> = A extends Event<infer _Tag, infer _Payload, infer _Success, infer _Error> ? _Success : never;
 /**
- * @since 4.0.0
+ * Decoded success value type for an event definition.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Success<A extends Any> = Schema.Schema.Type<SuccessSchema<A>>;
 /**
- * @since 4.0.0
+ * Schema services required by a client for an event definition.
+ *
+ * This includes payload encoding services plus success and error decoding
+ * services.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ServicesClient<A> = A extends Event<infer _Tag, infer _Payload, infer _Success, infer _Error> ? _Payload["EncodingServices"] | _Success["DecodingServices"] | _Error["DecodingServices"] : never;
 /**
- * @since 4.0.0
+ * Schema services required by a server for an event definition.
+ *
+ * This includes payload decoding services plus success and error encoding
+ * services.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ServicesServer<A> = A extends Event<infer _Tag, infer _Payload, infer _Success, infer _Error> ? _Payload["DecodingServices"] | _Success["EncodingServices"] | _Error["EncodingServices"] : never;
 /**
- * @since 4.0.0
+ * All schema services required to encode and decode the payload, success, and
+ * error schemas for an event definition.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Services<A> = A extends Event<infer _Tag, infer _Payload, infer _Success, infer _Error> ? _Payload["DecodingServices"] | _Success["EncodingServices"] | _Error["EncodingServices"] | _Payload["EncodingServices"] | _Success["DecodingServices"] | _Error["DecodingServices"] : never;
 /**
- * @since 4.0.0
+ * Extracts the event definition with the specified tag from an event union.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type WithTag<Events extends Any, Tag extends string> = Extract<Events, {
     readonly tag: Tag;
 }>;
 /**
- * @since 4.0.0
+ * Removes event definitions with the specified tag from an event union.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ExcludeTag<Events extends Any, Tag extends string> = Exclude<Events, {
     readonly tag: Tag;
 }>;
 /**
- * @since 4.0.0
+ * Decoded payload value type for the event in a union with the specified tag.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type PayloadWithTag<Events extends Any, Tag extends string> = Payload<WithTag<Events, Tag>>;
 /**
- * @since 4.0.0
+ * Decoded success value type for the event in a union with the specified tag.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type SuccessWithTag<Events extends Any, Tag extends string> = Success<WithTag<Events, Tag>>;
 /**
- * @since 4.0.0
+ * Decoded error value type for the event in a union with the specified tag.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ErrorWithTag<Events extends Any, Tag extends string> = Error<WithTag<Events, Tag>>;
 /**
- * @since 4.0.0
+ * Client-side schema services required for the event in a union with the specified
+ * tag.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ServicesClientWithTag<Events extends Any, Tag extends string> = ServicesClient<WithTag<Events, Tag>>;
 /**
- * @since 4.0.0
+ * Creates an event log event definition.
+ *
+ * If omitted, the payload and success schemas default to `Schema.Void`, the error
+ * schema defaults to `Schema.Never`, and the MessagePack payload schema is derived
+ * from the payload schema.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export declare function make<Tag extends string, Payload extends Schema.Top = typeof Schema.Void, Success extends Schema.Top = typeof Schema.Void, Error extends Schema.Top = typeof Schema.Never>(options: {
     readonly tag: Tag;
@@ -176,8 +256,13 @@ export declare function make<Tag extends string, Payload extends Schema.Top = ty
     readonly error?: Error | undefined;
 }): Event<Tag, Payload, Success, Error>;
 /**
- * @since 4.0.0
+ * Adds another error schema to an event definition.
+ *
+ * The returned event keeps the same tag, primary key, payload, and success schema
+ * while replacing the error schema with a union of the existing and new errors.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export declare function addError<A extends Any, Error2 extends Schema.Top>(event: A, error: Error2): AddError<A, Error2>;
 //# sourceMappingURL=Event.d.ts.map

package/dist/unstable/eventlog/Event.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Event.d.ts","sourceRoot":"","sources":["../../../src/unstable/eventlog/Event.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,OAAO,MAAM,wBAAwB,CAAA;AAEjD;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,wBAAwB,CAAA;AAE7C;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE,MAAiC,CAAA;AAEtD;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAqC,CAAA;AAEvG;;;;;GAKG;AACH,MAAM,WAAW,KAAK,CACpB,GAAG,CAAC,GAAG,SAAS,MAAM,EACtB,EAAE,CAAC,GAAG,CAAC,OAAO,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,EACtD,EAAE,CAAC,GAAG,CAAC,OAAO,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,EACtD,EAAE,CAAC,GAAG,CAAC,KAAK,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,KAAK;IAErD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;IACjB,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,MAAM,CAAA;IACrE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAChD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,MAAM;IACrD,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM,CAAA;IACzB,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,MAAM,CAAA;IAC7C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA;IAC5B,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACnD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA;IAC5B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAA;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,GAAG;CAAG;AAE5C;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CACxC,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG,YAAY,CAAC,IAAI,CAAC,GACpB,KAAK,CAAA;AAEP;;;GAGG;AACH,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAClC,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG,IAAI,GACN,KAAK,CAAA;AAEP;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,KAAK,CACtD,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG,MAAM,GACN,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;AAErE;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,SAAS,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,KAAK,CAC7E,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC,GAC/C,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,KAAK,CACxD,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG,QAAQ,GACR,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,GAAG,EAAE,GAAG,SAAS,MAAM,IAAI,CAAC,SAAS,KAAK,CACnF,GAAG,EACH,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG,QAAQ,GACR,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;AAEzE;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,KAAK,CACxD,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG;IACA,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;IACnB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;CAC/C,GACC,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,KAAK,CACxD,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG,QAAQ,GACR,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;AAEzE;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAC7C,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GACK,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,MAAM,CAAC,kBAAkB,CAAC,GAC5B,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAC7C,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GACK,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,MAAM,CAAC,kBAAkB,CAAC,GAC5B,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CACvC,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GACK,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,MAAM,CAAC,kBAAkB,CAAC,GAC1B,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,MAAM,CAAC,kBAAkB,CAAC,GAC5B,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,MAAM,SAAS,GAAG,EAAE,GAAG,SAAS,MAAM,IAAI,OAAO,CAAC,MAAM,EAAE;IAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;CAAE,CAAC,CAAA;AAEpG;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,MAAM,SAAS,GAAG,EAAE,GAAG,SAAS,MAAM,IAAI,OAAO,CAAC,MAAM,EAAE;IAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;CAAE,CAAC,CAAA;AAEvG;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,GAAG,EAAE,GAAG,SAAS,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;AAElG;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,GAAG,EAAE,GAAG,SAAS,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;AAElG;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,MAAM,SAAS,GAAG,EAAE,GAAG,SAAS,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;AAE9F;;;GAGG;AACH,MAAM,MAAM,qBAAqB,CAAC,MAAM,SAAS,GAAG,EAAE,GAAG,SAAS,MAAM,IAAI,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;AAShH;;;GAGG;AACH,wBAAgB,IAAI,CAClB,GAAG,SAAS,MAAM,EAClB,OAAO,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,EAC/C,OAAO,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,EAC/C,KAAK,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,KAAK,EAC9C,OAAO,EAAE;IACT,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;IACjB,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,MAAM,CAAA;IACrE,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;CACnC,GAAG,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;AAqBvC;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,GAAG,EAAE,MAAM,SAAS,MAAM,CAAC,GAAG,EAC/D,KAAK,EAAE,CAAC,EACR,KAAK,EAAE,MAAM,GACZ,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA"}
+{"version":3,"file":"Event.d.ts","sourceRoot":"","sources":["../../../src/unstable/eventlog/Event.ts"],"names":[],"mappings":"AAqBA,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,OAAO,MAAM,wBAAwB,CAAA;AAEjD;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG,wBAAwB,CAAA;AAE7C;;;;;GAKG;AACH,eAAO,MAAM,MAAM,EAAE,MAAiC,CAAA;AAEtD;;;;;GAKG;AACH,eAAO,MAAM,OAAO,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAqC,CAAA;AAEvG;;;;;;;;GAQG;AACH,MAAM,WAAW,KAAK,CACpB,GAAG,CAAC,GAAG,SAAS,MAAM,EACtB,EAAE,CAAC,GAAG,CAAC,OAAO,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,EACtD,EAAE,CAAC,GAAG,CAAC,OAAO,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,EACtD,EAAE,CAAC,GAAG,CAAC,KAAK,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,KAAK;IAErD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;IACjB,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,MAAM,CAAA;IACrE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAChD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,MAAM;IACrD,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM,CAAA;IACzB,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,MAAM,CAAA;IAC7C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA;IAC5B,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACnD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA;IAC5B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAA;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAa,SAAQ,GAAG;CAAG;AAE5C;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CACxC,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG,YAAY,CAAC,IAAI,CAAC,GACpB,KAAK,CAAA;AAEP;;;;;GAKG;AACH,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAClC,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG,IAAI,GACN,KAAK,CAAA;AAEP;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,KAAK,CACtD,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG,MAAM,GACN,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;AAErE;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,SAAS,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,KAAK,CAC7E,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC,GAC/C,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,KAAK,CACxD,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG,QAAQ,GACR,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,GAAG,EAAE,GAAG,SAAS,MAAM,IAAI,CAAC,SAAS,KAAK,CACnF,GAAG,EACH,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG,QAAQ,GACR,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;AAEzE;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,KAAK,CACxD,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG;IACA,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;IACnB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;CAC/C,GACC,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,KAAK,CACxD,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GAAG,QAAQ,GACR,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;AAEzE;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAC7C,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GACK,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,MAAM,CAAC,kBAAkB,CAAC,GAC5B,KAAK,CAAA;AAET;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAC7C,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GACK,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,MAAM,CAAC,kBAAkB,CAAC,GAC5B,KAAK,CAAA;AAET;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CACvC,MAAM,IAAI,EACV,MAAM,QAAQ,EACd,MAAM,QAAQ,EACd,MAAM,MAAM,CACb,GACK,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,MAAM,CAAC,kBAAkB,CAAC,GAC1B,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,MAAM,CAAC,kBAAkB,CAAC,GAC5B,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,MAAM,SAAS,GAAG,EAAE,GAAG,SAAS,MAAM,IAAI,OAAO,CAAC,MAAM,EAAE;IAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;CAAE,CAAC,CAAA;AAEpG;;;;;GAKG;AACH,MAAM,MAAM,UAAU,CAAC,MAAM,SAAS,GAAG,EAAE,GAAG,SAAS,MAAM,IAAI,OAAO,CAAC,MAAM,EAAE;IAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;CAAE,CAAC,CAAA;AAEvG;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,GAAG,EAAE,GAAG,SAAS,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;AAElG;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,GAAG,EAAE,GAAG,SAAS,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;AAElG;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CAAC,MAAM,SAAS,GAAG,EAAE,GAAG,SAAS,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;AAE9F;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,CAAC,MAAM,SAAS,GAAG,EAAE,GAAG,SAAS,MAAM,IAAI,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;AAShH;;;;;;;;;GASG;AACH,wBAAgB,IAAI,CAClB,GAAG,SAAS,MAAM,EAClB,OAAO,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,EAC/C,OAAO,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,EAC/C,KAAK,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,KAAK,EAC9C,OAAO,EAAE;IACT,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;IACjB,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,MAAM,CAAA;IACrE,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;CACnC,GAAG,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;AAqBvC;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,GAAG,EAAE,MAAM,SAAS,MAAM,CAAC,GAAG,EAC/D,KAAK,EAAE,CAAC,EACR,KAAK,EAAE,MAAM,GACZ,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA"}

package/dist/unstable/eventlog/Event.js

@@ -1,4 +1,20 @@
 /**
+ * Defines typed event-log events for use with `EventLog` and event groups.
+ *
+ * An event definition names a durable domain event with a tag, derives the
+ * aggregate or entity primary key from the payload, and records the schemas used
+ * to encode the payload and decode handler success or failure values. These
+ * definitions are the shared contract between clients that write events and
+ * servers that register handlers, so they are useful for command-style writes,
+ * replicated logs, audit trails, and workflows that need replayable domain
+ * facts.
+ *
+ * Payloads are serialized with MessagePack, while success and error values are
+ * described separately for the handler result. Keep payload schemas stable once
+ * events have been persisted or replicated, prefer explicit versioned event tags
+ * or backward-compatible schemas for changes, and make primary keys deterministic
+ * so related entries are grouped consistently across stores and remotes.
+ *
  * @since 4.0.0
  */
 import { pipeArguments } from "../../Pipeable.js";
@@ -6,13 +22,17 @@ import * as Predicate from "../../Predicate.js";
 import * as Schema from "../../Schema.js";
 import * as Msgpack from "../encoding/Msgpack.js";
 /**
+ * Runtime type identifier used to mark event log event definitions.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category type ids
  */
 export const TypeId = "~effect/eventlog/Event";
 /**
- * @since 4.0.0
+ * Returns `true` when a value is an event log event definition.
+ *
  * @category guards
+ * @since 4.0.0
  */
 export const isEvent = u => Predicate.hasProperty(u, TypeId);
 const Proto = {

package/dist/unstable/eventlog/Event.js.map

@@ -1 +1 @@
-{"version":3,"file":"Event.js","names":["pipeArguments","Predicate","Schema","Msgpack","TypeId","isEvent","u","hasProperty","Proto","pipe","arguments","make","options","payload","Void","success","error","Never","Object","assign","create","tag","primaryKey","payloadMsgPack","schema","addError","event","Union"],"sources":["../../../src/unstable/eventlog/Event.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,SAASA,aAAa,QAAQ,mBAAmB;AACjD,OAAO,KAAKC,SAAS,MAAM,oBAAoB;AAC/C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,OAAO,MAAM,wBAAwB;AAQjD;;;;AAIA,OAAO,MAAMC,MAAM,GAAW,wBAAwB;AAEtD;;;;AAIA,OAAO,MAAMC,OAAO,GAAIC,CAAU,IAAqCL,SAAS,CAACM,WAAW,CAACD,CAAC,EAAEF,MAAM,CAAC;AA6PvG,MAAMI,KAAK,GAAG;EACZ,CAACJ,MAAM,GAAGA,MAAM;EAChBK,IAAIA,CAAA;IACF,OAAOT,aAAa,CAAC,IAAI,EAAEU,SAAS,CAAC;EACvC;CACD;AAkBD,OAAM,SAAUC,IAAIA,CAACC,OAMpB;EACC,MAAMC,OAAO,GAAGD,OAAO,CAACC,OAAO,IAAIX,MAAM,CAACY,IAAI;EAC9C,MAAMC,OAAO,GAAGH,OAAO,CAACG,OAAO,IAAIb,MAAM,CAACY,IAAI;EAC9C,MAAME,KAAK,GAAGJ,OAAO,CAACI,KAAK,IAAId,MAAM,CAACe,KAAK;EAC3C,OAAOC,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACZ,KAAK,CAAC,EAAE;IACzCa,GAAG,EAAET,OAAO,CAACS,GAAG;IAChBC,UAAU,EAAEV,OAAO,CAACU,UAAU;IAC9BT,OAAO;IACPU,cAAc,EAAEpB,OAAO,CAACqB,MAAM,CAACX,OAAO,CAAC;IACvCE,OAAO;IACPC;GACD,CAAC;AACJ;AAUA,OAAM,SAAUS,QAAQA,CAACC,KAAU,EAAEV,KAAiB;EACpD,OAAOL,IAAI,CAAC;IACVU,GAAG,EAAEK,KAAK,CAACL,GAAG;IACdC,UAAU,EAAEI,KAAK,CAACJ,UAAU;IAC5BT,OAAO,EAAEa,KAAK,CAACb,OAAO;IACtBE,OAAO,EAAEW,KAAK,CAACX,OAAO;IACtBC,KAAK,EAAEd,MAAM,CAACyB,KAAK,CAAC,CAACD,KAAK,CAACV,KAAK,EAAEA,KAAK,CAAC;GACzC,CAAC;AACJ","ignoreList":[]}
+{"version":3,"file":"Event.js","names":["pipeArguments","Predicate","Schema","Msgpack","TypeId","isEvent","u","hasProperty","Proto","pipe","arguments","make","options","payload","Void","success","error","Never","Object","assign","create","tag","primaryKey","payloadMsgPack","schema","addError","event","Union"],"sources":["../../../src/unstable/eventlog/Event.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;AAmBA,SAASA,aAAa,QAAQ,mBAAmB;AACjD,OAAO,KAAKC,SAAS,MAAM,oBAAoB;AAC/C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,OAAO,MAAM,wBAAwB;AAUjD;;;;;;AAMA,OAAO,MAAMC,MAAM,GAAW,wBAAwB;AAEtD;;;;;;AAMA,OAAO,MAAMC,OAAO,GAAIC,CAAU,IAAqCL,SAAS,CAACM,WAAW,CAACD,CAAC,EAAEF,MAAM,CAAC;AAiUvG,MAAMI,KAAK,GAAG;EACZ,CAACJ,MAAM,GAAGA,MAAM;EAChBK,IAAIA,CAAA;IACF,OAAOT,aAAa,CAAC,IAAI,EAAEU,SAAS,CAAC;EACvC;CACD;AAwBD,OAAM,SAAUC,IAAIA,CAACC,OAMpB;EACC,MAAMC,OAAO,GAAGD,OAAO,CAACC,OAAO,IAAIX,MAAM,CAACY,IAAI;EAC9C,MAAMC,OAAO,GAAGH,OAAO,CAACG,OAAO,IAAIb,MAAM,CAACY,IAAI;EAC9C,MAAME,KAAK,GAAGJ,OAAO,CAACI,KAAK,IAAId,MAAM,CAACe,KAAK;EAC3C,OAAOC,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACZ,KAAK,CAAC,EAAE;IACzCa,GAAG,EAAET,OAAO,CAACS,GAAG;IAChBC,UAAU,EAAEV,OAAO,CAACU,UAAU;IAC9BT,OAAO;IACPU,cAAc,EAAEpB,OAAO,CAACqB,MAAM,CAACX,OAAO,CAAC;IACvCE,OAAO;IACPC;GACD,CAAC;AACJ;AAeA,OAAM,SAAUS,QAAQA,CAACC,KAAU,EAAEV,KAAiB;EACpD,OAAOL,IAAI,CAAC;IACVU,GAAG,EAAEK,KAAK,CAACL,GAAG;IACdC,UAAU,EAAEI,KAAK,CAACJ,UAAU;IAC5BT,OAAO,EAAEa,KAAK,CAACb,OAAO;IACtBE,OAAO,EAAEW,KAAK,CAACX,OAAO;IACtBC,KAAK,EAAEd,MAAM,CAACyB,KAAK,CAAC,CAACD,KAAK,CAACV,KAAK,EAAEA,KAAK,CAAC;GACzC,CAAC;AACJ","ignoreList":[]}

package/dist/unstable/eventlog/EventGroup.d.ts

@@ -1,4 +1,19 @@
 /**
+ * Defines typed groups of event-log event definitions.
+ *
+ * Event groups describe the events that belong to one event-log domain, such as
+ * commands for an aggregate, application workflow, or synced local store. Start
+ * from `empty`, add event tags with their payload, success, and error schemas,
+ * then use the group with `EventLog.group` to provide the handlers that execute
+ * and commit those events.
+ *
+ * Each event tag becomes the key in the group's events record, so tags should be
+ * unique within a group. The `primaryKey` function is part of the event
+ * definition and should derive the stable partition key from the decoded
+ * payload. Omitted schemas default to `Schema.Void` for payload and success, and
+ * `Schema.Never` for errors; use `addError` when every event in the group shares
+ * an additional error schema.
+ *
  * @since 4.0.0
  */
 import { type Pipeable } from "../../Pipeable.ts";
@@ -6,28 +21,35 @@ import * as Record from "../../Record.ts";
 import type * as Schema from "../../Schema.ts";
 import * as Event from "./Event.ts";
 /**
+ * Unique type identifier used to mark event log event groups.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category type ids
  */
 export type TypeId = "~effect/eventlog/EventGroup";
 /**
+ * Runtime type identifier used to mark event log event groups.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category type ids
  */
 export declare const TypeId: TypeId;
 /**
- * @since 4.0.0
+ * Returns `true` when a value is an event log event group.
+ *
  * @category guards
+ * @since 4.0.0
  */
 export declare const isEventGroup: (u: unknown) => u is Any;
 /**
- * An `EventGroup` is a collection of `Event`s. You can use an `EventGroup` to
- * represent a portion of your domain.
+ * Typed collection of event definitions that represents a portion of an event log
+ * domain.
  *
- * The events can be implemented later using the `EventLogBuilder.group` api.
+ * Build groups from `empty.add(...)`, then provide implementations for the events
+ * with `EventLog.group`.
  *
- * @since 4.0.0
  * @category models
+ * @since 4.0.0
  */
 export interface EventGroup<out Events extends Event.Any = Event.Any> extends Pipeable {
     readonly [TypeId]: TypeId;
@@ -48,45 +70,56 @@ export interface EventGroup<out Events extends Event.Any = Event.Any> extends Pi
     addError<Error extends Schema.Top>(error: Error): EventGroup<Event.AddError<Events, Error>>;
 }
 /**
- * @since 4.0.0
+ * Type-erased marker for an event log event group.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface Any {
     readonly [TypeId]: TypeId;
 }
 /**
- * @since 4.0.0
+ * Type-erased event group with its events record available structurally.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type AnyWithProps = EventGroup<Event.Any>;
 /**
- * @since 4.0.0
+ * Derives the handler service markers required for all events in an event group.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ToService<A> = A extends EventGroup<infer _Events> ? Event.ToService<_Events> : never;
 /**
- * @since 4.0.0
+ * Extracts the union of event definitions contained in an event group.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Events<Group> = Group extends EventGroup<infer _Events> ? _Events : never;
 /**
- * @since 4.0.0
+ * Client-side schema services required by all events in an event group.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ServicesClient<Group> = Event.ServicesClient<Events<Group>>;
 /**
- * @since 4.0.0
+ * Server-side schema services required by all events in an event group.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ServicesServer<Group> = Event.ServicesServer<Events<Group>>;
 /**
- * An `EventGroup` is a collection of `Event`s. You can use an `EventGroup` to
- * represent a portion of your domain.
+ * Empty event group used as the starting point for defining a group.
  *
- * The events can be implemented later using the `EventLog.group` api.
+ * Call `.add(...)` to add event definitions and build a typed `EventGroup`.
  *
- * @since 4.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export declare const empty: EventGroup<never>;
 //# sourceMappingURL=EventGroup.d.ts.map

package/dist/unstable/eventlog/EventGroup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EventGroup.d.ts","sourceRoot":"","sources":["../../../src/unstable/eventlog/EventGroup.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,mBAAmB,CAAA;AAEhE,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,6BAA6B,CAAA;AAElD;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE,MAAsC,CAAA;AAE3D;;;GAGG;AACH,eAAO,MAAM,YAAY,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,GAAuC,CAAA;AAEtF;;;;;;;;GAQG;AACH,MAAM,WAAW,UAAU,CACzB,GAAG,CAAC,MAAM,SAAS,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CACxC,SAAQ,QAAQ;IAChB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAEtD;;OAEG;IACH,GAAG,CACD,GAAG,SAAS,MAAM,EAClB,OAAO,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,EAC/C,OAAO,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,EAC/C,KAAK,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,KAAK,EAC9C,OAAO,EAAE;QACT,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;QACjB,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,MAAM,CAAA;QACrE,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;QAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;QAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAA;KACvB,GAAG,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;IAElE;;OAEG;IACH,QAAQ,CAAC,KAAK,SAAS,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAA;CAC5F;AAED;;;GAGG;AACH,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;AAEhD;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,CAAC,MAAM,OAAO,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,GACrF,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,MAAM,CAAC,KAAK,IAAI,KAAK,SAAS,UAAU,CAAC,MAAM,OAAO,CAAC,GAAG,OAAO,GACzE,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,IAAI,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;AAEvE;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,IAAI,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;AAkDvE;;;;;;;;GAQG;AACH,eAAO,MAAM,KAAK,EAAE,UAAU,CAAC,KAAK,CAAyC,CAAA"}
+{"version":3,"file":"EventGroup.d.ts","sourceRoot":"","sources":["../../../src/unstable/eventlog/EventGroup.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,mBAAmB,CAAA;AAEhE,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG,6BAA6B,CAAA;AAElD;;;;;GAKG;AACH,eAAO,MAAM,MAAM,EAAE,MAAsC,CAAA;AAE3D;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,GAAuC,CAAA;AAEtF;;;;;;;;;GASG;AACH,MAAM,WAAW,UAAU,CACzB,GAAG,CAAC,MAAM,SAAS,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CACxC,SAAQ,QAAQ;IAChB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAEtD;;OAEG;IACH,GAAG,CACD,GAAG,SAAS,MAAM,EAClB,OAAO,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,EAC/C,OAAO,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,EAC/C,KAAK,SAAS,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,KAAK,EAC9C,OAAO,EAAE;QACT,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;QACjB,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,MAAM,CAAA;QACrE,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;QAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;QAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAA;KACvB,GAAG,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;IAElE;;OAEG;IACH,QAAQ,CAAC,KAAK,SAAS,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAA;CAC5F;AAED;;;;;GAKG;AACH,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;AAEhD;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,CAAC,MAAM,OAAO,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,GACrF,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,MAAM,CAAC,KAAK,IAAI,KAAK,SAAS,UAAU,CAAC,MAAM,OAAO,CAAC,GAAG,OAAO,GACzE,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,IAAI,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;AAEvE;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,IAAI,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;AAkDvE;;;;;;;GAOG;AACH,eAAO,MAAM,KAAK,EAAE,UAAU,CAAC,KAAK,CAAyC,CAAA"}

package/dist/unstable/eventlog/EventGroup.js

@@ -1,4 +1,19 @@
 /**
+ * Defines typed groups of event-log event definitions.
+ *
+ * Event groups describe the events that belong to one event-log domain, such as
+ * commands for an aggregate, application workflow, or synced local store. Start
+ * from `empty`, add event tags with their payload, success, and error schemas,
+ * then use the group with `EventLog.group` to provide the handlers that execute
+ * and commit those events.
+ *
+ * Each event tag becomes the key in the group's events record, so tags should be
+ * unique within a group. The `primaryKey` function is part of the event
+ * definition and should derive the stable partition key from the decoded
+ * payload. Omitted schemas default to `Schema.Void` for payload and success, and
+ * `Schema.Never` for errors; use `addError` when every event in the group shares
+ * an additional error schema.
+ *
  * @since 4.0.0
  */
 import { pipeArguments } from "../../Pipeable.js";
@@ -6,13 +21,17 @@ import * as Predicate from "../../Predicate.js";
 import * as Record from "../../Record.js";
 import * as Event from "./Event.js";
 /**
+ * Runtime type identifier used to mark event log event groups.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category type ids
  */
 export const TypeId = "~effect/eventlog/EventGroup";
 /**
- * @since 4.0.0
+ * Returns `true` when a value is an event log event group.
+ *
  * @category guards
+ * @since 4.0.0
  */
 export const isEventGroup = u => Predicate.hasProperty(u, TypeId);
 const makeProto = options => {
@@ -41,13 +60,12 @@ const makeProto = options => {
   return group;
 };
 /**
- * An `EventGroup` is a collection of `Event`s. You can use an `EventGroup` to
- * represent a portion of your domain.
+ * Empty event group used as the starting point for defining a group.
  *
- * The events can be implemented later using the `EventLog.group` api.
+ * Call `.add(...)` to add event definitions and build a typed `EventGroup`.
  *
- * @since 4.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export const empty = /*#__PURE__*/makeProto({
   events: /*#__PURE__*/Record.empty()

package/dist/unstable/eventlog/EventGroup.js.map

@@ -1 +1 @@
-{"version":3,"file":"EventGroup.js","names":["pipeArguments","Predicate","Record","Event","TypeId","isEventGroup","u","hasProperty","makeProto","options","EventGroupClass","_","group","Object","assign","events","add","addOptions","tag","make","addError","error","map","event","pipe","arguments","empty"],"sources":["../../../src/unstable/eventlog/EventGroup.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,SAAwBA,aAAa,QAAQ,mBAAmB;AAChE,OAAO,KAAKC,SAAS,MAAM,oBAAoB;AAC/C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAEzC,OAAO,KAAKC,KAAK,MAAM,YAAY;AAQnC;;;;AAIA,OAAO,MAAMC,MAAM,GAAW,6BAA6B;AAE3D;;;;AAIA,OAAO,MAAMC,YAAY,GAAIC,CAAU,IAAeL,SAAS,CAACM,WAAW,CAACD,CAAC,EAAEF,MAAM,CAAC;AA+EtF,MAAMI,SAAS,GAEbC,OAED,IAAwB;EACvB,MAAMC,eAAe,GAAIC,CAAQ,IAAI,CAAE,CAAC;EACxC,MAAMC,KAAK,GAAGC,MAAM,CAACC,MAAM,CAACJ,eAAe,EAAE;IAC3C,CAACN,MAAM,GAAGA,MAAM;IAChBW,MAAM,EAAEN,OAAO,CAACM,MAAM;IACtBC,GAAGA,CAODC,UAMC;MAED,OAAOT,SAAS,CAAC;QACfO,MAAM,EAAE;UACN,GAAG,IAAI,CAACA,MAAM;UACd,CAACE,UAAU,CAACC,GAAG,GAAGf,KAAK,CAACgB,IAAI,CAACF,UAAU;;OAE1C,CAAC;IACJ,CAAC;IACDG,QAAQA,CAENC,KAAY;MAEZ,MAAMN,MAAM,GAAGb,MAAM,CAACoB,GAAG,CACvB,IAAI,CAACP,MAAM,EACVQ,KAAK,IAAKpB,KAAK,CAACiB,QAAQ,CAACG,KAAK,EAAEF,KAAK,CAAC,CACxC;MACD,OAAOb,SAAS,CAAC;QAAEO;MAAM,CAAE,CAAC;IAC9B,CAAC;IACDS,IAAIA,CAAA;MACF,OAAOxB,aAAa,CAAC,IAAI,EAAEyB,SAAS,CAAC;IACvC;GACD,CAAC;EACF,OAAOb,KAAK;AACd,CAAC;AAED;;;;;;;;;AASA,OAAO,MAAMc,KAAK,gBAAsBlB,SAAS,CAAC;EAAEO,MAAM,eAAEb,MAAM,CAACwB,KAAK;AAAE,CAAE,CAAC","ignoreList":[]}
+{"version":3,"file":"EventGroup.js","names":["pipeArguments","Predicate","Record","Event","TypeId","isEventGroup","u","hasProperty","makeProto","options","EventGroupClass","_","group","Object","assign","events","add","addOptions","tag","make","addError","error","map","event","pipe","arguments","empty"],"sources":["../../../src/unstable/eventlog/EventGroup.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;AAkBA,SAAwBA,aAAa,QAAQ,mBAAmB;AAChE,OAAO,KAAKC,SAAS,MAAM,oBAAoB;AAC/C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAEzC,OAAO,KAAKC,KAAK,MAAM,YAAY;AAUnC;;;;;;AAMA,OAAO,MAAMC,MAAM,GAAW,6BAA6B;AAE3D;;;;;;AAMA,OAAO,MAAMC,YAAY,GAAIC,CAAU,IAAeL,SAAS,CAACM,WAAW,CAACD,CAAC,EAAEF,MAAM,CAAC;AA4FtF,MAAMI,SAAS,GAEbC,OAED,IAAwB;EACvB,MAAMC,eAAe,GAAIC,CAAQ,IAAI,CAAE,CAAC;EACxC,MAAMC,KAAK,GAAGC,MAAM,CAACC,MAAM,CAACJ,eAAe,EAAE;IAC3C,CAACN,MAAM,GAAGA,MAAM;IAChBW,MAAM,EAAEN,OAAO,CAACM,MAAM;IACtBC,GAAGA,CAODC,UAMC;MAED,OAAOT,SAAS,CAAC;QACfO,MAAM,EAAE;UACN,GAAG,IAAI,CAACA,MAAM;UACd,CAACE,UAAU,CAACC,GAAG,GAAGf,KAAK,CAACgB,IAAI,CAACF,UAAU;;OAE1C,CAAC;IACJ,CAAC;IACDG,QAAQA,CAENC,KAAY;MAEZ,MAAMN,MAAM,GAAGb,MAAM,CAACoB,GAAG,CACvB,IAAI,CAACP,MAAM,EACVQ,KAAK,IAAKpB,KAAK,CAACiB,QAAQ,CAACG,KAAK,EAAEF,KAAK,CAAC,CACxC;MACD,OAAOb,SAAS,CAAC;QAAEO;MAAM,CAAE,CAAC;IAC9B,CAAC;IACDS,IAAIA,CAAA;MACF,OAAOxB,aAAa,CAAC,IAAI,EAAEyB,SAAS,CAAC;IACvC;GACD,CAAC;EACF,OAAOb,KAAK;AACd,CAAC;AAED;;;;;;;;AAQA,OAAO,MAAMc,KAAK,gBAAsBlB,SAAS,CAAC;EAAEO,MAAM,eAAEb,MAAM,CAACwB,KAAK;AAAE,CAAE,CAAC","ignoreList":[]}