@relaybus/core 0.3.0 → 0.4.0

package/dist/event-DCRTuYKI.d.cts

@@ -1,142 +0,0 @@
-/** Source of the current time. Replace it in tests to control retries and leases. */
-interface Clock {
-    now(): Date;
-    /**
-     * Runs `task.run` after `task.delayMs` milliseconds, again every `delayMs` when `repeat` is set, and
-     * returns a function that cancels it. `unref` marks a timer that must not keep the process alive.
-     * Optional: without it relaybus uses the platform timers. Implement it to control timers in tests
-     * (`FakeClock` does with `controlTimers: true`).
-     */
-    schedule?(task: {
-        readonly run: () => void;
-        readonly delayMs: number;
-        readonly repeat?: boolean;
-        readonly unref?: boolean;
-    }): () => void;
-}
-declare const systemClock: Clock;
-
-/**
- * The Standard Schema interface (https://standardschema.dev), copied as the
- * specification recommends so relaybus needs no runtime dependency. Zod,
- * Valibot, ArkType and other libraries implement it.
- */
-interface StandardSchemaV1<Input = unknown, Output = Input> {
-    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
-}
-declare namespace StandardSchemaV1 {
-    interface Props<Input = unknown, Output = Input> {
-        readonly version: 1;
-        readonly vendor: string;
-        readonly validate: (value: unknown) => Result<Output> | Promise<Result<Output>>;
-        readonly types?: Types<Input, Output> | undefined;
-    }
-    type Result<Output> = SuccessResult<Output> | FailureResult;
-    interface SuccessResult<Output> {
-        readonly value: Output;
-        readonly issues?: undefined;
-    }
-    interface FailureResult {
-        readonly issues: ReadonlyArray<Issue>;
-    }
-    interface Issue {
-        readonly message: string;
-        readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
-    }
-    interface PathSegment {
-        readonly key: PropertyKey;
-    }
-    interface Types<Input = unknown, Output = Input> {
-        readonly input: Input;
-        readonly output: Output;
-    }
-    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
-    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
-}
-
-/** String metadata carried with an event, such as `traceparent`. */
-type EventHeaders = Readonly<Record<string, string>>;
-/**
- * An event as stored and delivered. Field names follow CloudEvents where they
- * overlap (`id`, `type`, `source`, `time` as `occurredAt`, `subject` as `key`).
- */
-interface EventEnvelope<TPayload = unknown> {
-    /** Globally unique id. Handlers and transports deduplicate on it. */
-    readonly id: string;
-    /** Event type, for example `order.created.v1`. */
-    readonly type: string;
-    /** Logical name of the publishing service. */
-    readonly source: string;
-    /** Ordering and partition key. Events sharing a key are handled in publish order. */
-    readonly key: string | null;
-    readonly payload: TPayload;
-    readonly headers: EventHeaders;
-    /** Id shared by every event of one business flow. */
-    readonly correlationId: string | null;
-    /** Id of the event whose handler published this one. */
-    readonly causationId: string | null;
-    readonly occurredAt: Date;
-}
-/** An instance of a class created with {@link defineEvent}. */
-interface DomainEvent<TPayload = unknown> {
-    readonly type: string;
-    readonly payload: TPayload;
-}
-/**
- * Derives the ordering key of an event from its validated payload. Declared bivariantly so an
- * event class stays assignable wherever its payload type is widened.
- */
-type EventKeyFunction<TPayload> = {
-    bivarianceHack(payload: TPayload): string;
-}['bivarianceHack'];
-/** A class created with {@link defineEvent}. */
-interface EventClass<TPayload = unknown> {
-    new (payload: TPayload): DomainEvent<TPayload>;
-    readonly type: string;
-    readonly schema: StandardSchemaV1<unknown, TPayload> | undefined;
-    /** The `key` given to {@link defineEvent}; undefined for events without one. */
-    readonly key?: EventKeyFunction<TPayload> | undefined;
-}
-/** Payload type of an event class: `PayloadOf<typeof OrderPlaced>`. */
-type PayloadOf<TEvent> = TEvent extends EventClass<infer TPayload> ? TPayload : never;
-/** Anything that names an event type: an event class or the type string itself. */
-type EventReference = {
-    readonly type: string;
-} | string;
-interface DefineEventOptions<TSchema extends StandardSchemaV1> {
-    /** Validates the payload on publish and before every handler call. */
-    readonly schema: TSchema;
-    /** Ordering key of every event of this type, from its validated payload. See {@link DefineEventKeyOptions}. */
-    readonly key?: (payload: StandardSchemaV1.InferOutput<TSchema>) => string;
-}
-interface DefineEventKeyOptions<TPayload> {
-    /**
-     * Ordering key of every event of this type, from its payload: `(payload) => payload.orderId`.
-     * Typed from the payload, so a missing field or a non-string fails to compile. `publish` uses it
-     * when it is given no `key`; an explicit `key` option wins (for `publishAll`, the one key of the
-     * call applies to every event). It must return a non-empty string.
-     */
-    readonly key: (payload: TPayload) => string;
-}
-declare function assertEventType(type: string): void;
-/**
- * Defines an event type. Extend the returned class to name it:
- *
- * ```ts
- * export class OrderPlaced extends defineEvent<{ orderId: string }>('order.placed.v1') {}
- * export class OrderShipped extends defineEvent('order.shipped.v1', { schema: orderShippedSchema }) {}
- * export class OrderPaid extends defineEvent('order.paid.v1', {
- *   schema: orderPaidSchema,
- *   key: (payload) => payload.orderId,
- * }) {}
- * export class OrderCancelled extends defineEvent<{ orderId: string }>('order.cancelled.v1', {
- *   key: (payload) => payload.orderId,
- * }) {}
- * ```
- */
-declare function defineEvent<TSchema extends StandardSchemaV1>(type: string, options: DefineEventOptions<TSchema>): EventClass<StandardSchemaV1.InferOutput<TSchema>>;
-declare function defineEvent<TPayload>(type: string, options?: DefineEventKeyOptions<TPayload>): EventClass<TPayload>;
-/** Runs a Standard Schema and returns its output, or throws {@link EventValidationError}. */
-declare function validatePayload<TPayload>(type: string, schema: StandardSchemaV1<unknown, TPayload> | undefined, payload: unknown): Promise<TPayload>;
-
-export { type Clock as C, type DomainEvent as D, type EventEnvelope as E, type PayloadOf as P, StandardSchemaV1 as S, type EventHeaders as a, type EventReference as b, type EventClass as c, type DefineEventKeyOptions as d, type DefineEventOptions as e, type EventKeyFunction as f, assertEventType as g, defineEvent as h, systemClock as s, validatePayload as v };

package/dist/event-DCRTuYKI.d.ts

@@ -1,142 +0,0 @@
-/** Source of the current time. Replace it in tests to control retries and leases. */
-interface Clock {
-    now(): Date;
-    /**
-     * Runs `task.run` after `task.delayMs` milliseconds, again every `delayMs` when `repeat` is set, and
-     * returns a function that cancels it. `unref` marks a timer that must not keep the process alive.
-     * Optional: without it relaybus uses the platform timers. Implement it to control timers in tests
-     * (`FakeClock` does with `controlTimers: true`).
-     */
-    schedule?(task: {
-        readonly run: () => void;
-        readonly delayMs: number;
-        readonly repeat?: boolean;
-        readonly unref?: boolean;
-    }): () => void;
-}
-declare const systemClock: Clock;
-
-/**
- * The Standard Schema interface (https://standardschema.dev), copied as the
- * specification recommends so relaybus needs no runtime dependency. Zod,
- * Valibot, ArkType and other libraries implement it.
- */
-interface StandardSchemaV1<Input = unknown, Output = Input> {
-    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
-}
-declare namespace StandardSchemaV1 {
-    interface Props<Input = unknown, Output = Input> {
-        readonly version: 1;
-        readonly vendor: string;
-        readonly validate: (value: unknown) => Result<Output> | Promise<Result<Output>>;
-        readonly types?: Types<Input, Output> | undefined;
-    }
-    type Result<Output> = SuccessResult<Output> | FailureResult;
-    interface SuccessResult<Output> {
-        readonly value: Output;
-        readonly issues?: undefined;
-    }
-    interface FailureResult {
-        readonly issues: ReadonlyArray<Issue>;
-    }
-    interface Issue {
-        readonly message: string;
-        readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
-    }
-    interface PathSegment {
-        readonly key: PropertyKey;
-    }
-    interface Types<Input = unknown, Output = Input> {
-        readonly input: Input;
-        readonly output: Output;
-    }
-    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
-    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
-}
-
-/** String metadata carried with an event, such as `traceparent`. */
-type EventHeaders = Readonly<Record<string, string>>;
-/**
- * An event as stored and delivered. Field names follow CloudEvents where they
- * overlap (`id`, `type`, `source`, `time` as `occurredAt`, `subject` as `key`).
- */
-interface EventEnvelope<TPayload = unknown> {
-    /** Globally unique id. Handlers and transports deduplicate on it. */
-    readonly id: string;
-    /** Event type, for example `order.created.v1`. */
-    readonly type: string;
-    /** Logical name of the publishing service. */
-    readonly source: string;
-    /** Ordering and partition key. Events sharing a key are handled in publish order. */
-    readonly key: string | null;
-    readonly payload: TPayload;
-    readonly headers: EventHeaders;
-    /** Id shared by every event of one business flow. */
-    readonly correlationId: string | null;
-    /** Id of the event whose handler published this one. */
-    readonly causationId: string | null;
-    readonly occurredAt: Date;
-}
-/** An instance of a class created with {@link defineEvent}. */
-interface DomainEvent<TPayload = unknown> {
-    readonly type: string;
-    readonly payload: TPayload;
-}
-/**
- * Derives the ordering key of an event from its validated payload. Declared bivariantly so an
- * event class stays assignable wherever its payload type is widened.
- */
-type EventKeyFunction<TPayload> = {
-    bivarianceHack(payload: TPayload): string;
-}['bivarianceHack'];
-/** A class created with {@link defineEvent}. */
-interface EventClass<TPayload = unknown> {
-    new (payload: TPayload): DomainEvent<TPayload>;
-    readonly type: string;
-    readonly schema: StandardSchemaV1<unknown, TPayload> | undefined;
-    /** The `key` given to {@link defineEvent}; undefined for events without one. */
-    readonly key?: EventKeyFunction<TPayload> | undefined;
-}
-/** Payload type of an event class: `PayloadOf<typeof OrderPlaced>`. */
-type PayloadOf<TEvent> = TEvent extends EventClass<infer TPayload> ? TPayload : never;
-/** Anything that names an event type: an event class or the type string itself. */
-type EventReference = {
-    readonly type: string;
-} | string;
-interface DefineEventOptions<TSchema extends StandardSchemaV1> {
-    /** Validates the payload on publish and before every handler call. */
-    readonly schema: TSchema;
-    /** Ordering key of every event of this type, from its validated payload. See {@link DefineEventKeyOptions}. */
-    readonly key?: (payload: StandardSchemaV1.InferOutput<TSchema>) => string;
-}
-interface DefineEventKeyOptions<TPayload> {
-    /**
-     * Ordering key of every event of this type, from its payload: `(payload) => payload.orderId`.
-     * Typed from the payload, so a missing field or a non-string fails to compile. `publish` uses it
-     * when it is given no `key`; an explicit `key` option wins (for `publishAll`, the one key of the
-     * call applies to every event). It must return a non-empty string.
-     */
-    readonly key: (payload: TPayload) => string;
-}
-declare function assertEventType(type: string): void;
-/**
- * Defines an event type. Extend the returned class to name it:
- *
- * ```ts
- * export class OrderPlaced extends defineEvent<{ orderId: string }>('order.placed.v1') {}
- * export class OrderShipped extends defineEvent('order.shipped.v1', { schema: orderShippedSchema }) {}
- * export class OrderPaid extends defineEvent('order.paid.v1', {
- *   schema: orderPaidSchema,
- *   key: (payload) => payload.orderId,
- * }) {}
- * export class OrderCancelled extends defineEvent<{ orderId: string }>('order.cancelled.v1', {
- *   key: (payload) => payload.orderId,
- * }) {}
- * ```
- */
-declare function defineEvent<TSchema extends StandardSchemaV1>(type: string, options: DefineEventOptions<TSchema>): EventClass<StandardSchemaV1.InferOutput<TSchema>>;
-declare function defineEvent<TPayload>(type: string, options?: DefineEventKeyOptions<TPayload>): EventClass<TPayload>;
-/** Runs a Standard Schema and returns its output, or throws {@link EventValidationError}. */
-declare function validatePayload<TPayload>(type: string, schema: StandardSchemaV1<unknown, TPayload> | undefined, payload: unknown): Promise<TPayload>;
-
-export { type Clock as C, type DomainEvent as D, type EventEnvelope as E, type PayloadOf as P, StandardSchemaV1 as S, type EventHeaders as a, type EventReference as b, type EventClass as c, type DefineEventKeyOptions as d, type DefineEventOptions as e, type EventKeyFunction as f, assertEventType as g, defineEvent as h, systemClock as s, validatePayload as v };