Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ instead of fanning out).

```typescript
const buses = createBroadcastSubscribers({
adapter: () => new NatsAdapter({ servers, stream: 'orders' }),
adapter: () => NatsAdapter({ servers, stream: 'orders' }),
reactors: [
{ group: 'pricing', routes: [pricingRoutes] },
{ group: 'audit', routes: [auditRoutes] },
Expand Down
6 changes: 6 additions & 0 deletions en/api/@connectum/events/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ Re-exports [EventAdapter](types/interfaces/EventAdapter.md)

***

### EventAdapterFactory

Re-exports [EventAdapterFactory](types/type-aliases/EventAdapterFactory.md)

***

### EventBus

Re-exports [EventBus](types/interfaces/EventBus.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Options for [createBroadcastSubscribers](../functions/createBroadcastSubscribers

### adapter

> `readonly` **adapter**: [`EventAdapter`](../types/interfaces/EventAdapter.md) \| (() => [`EventAdapter`](../types/interfaces/EventAdapter.md))
> `readonly` **adapter**: [`EventAdapter`](../types/interfaces/EventAdapter.md) \| [`EventAdapterFactory`](../types/type-aliases/EventAdapterFactory.md)

Defined in: [packages/events/src/broadcast.ts:40](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/broadcast.ts#L40)

Expand Down
1 change: 1 addition & 0 deletions en/api/@connectum/events/types/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Type definitions for the event adapter layer.

## Type Aliases

- [EventAdapterFactory](type-aliases/EventAdapterFactory.md)
- [EventMiddleware](type-aliases/EventMiddleware.md)
- [EventMiddlewareNext](type-aliases/EventMiddlewareNext.md)
- [EventRoute](type-aliases/EventRoute.md)
Expand Down
6 changes: 3 additions & 3 deletions en/api/@connectum/events/types/interfaces/DlqOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: DlqOptions

Defined in: [packages/events/src/types.ts:282](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L282)
Defined in: [packages/events/src/types.ts:297](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L297)

Dead letter queue middleware options

Expand All @@ -12,7 +12,7 @@ Dead letter queue middleware options

> `optional` **errorSerializer?**: (`error`) => `string`

Defined in: [packages/events/src/types.ts:291](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L291)
Defined in: [packages/events/src/types.ts:306](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L306)

Custom error serializer for DLQ metadata.
Defaults to `error.name` only (e.g. "TypeError") to prevent credential leaks.
Expand All @@ -35,6 +35,6 @@ For production, provide a custom serializer that redacts sensitive data

> **topic**: `string`

Defined in: [packages/events/src/types.ts:284](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L284)
Defined in: [packages/events/src/types.ts:299](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L299)

DLQ topic name
8 changes: 4 additions & 4 deletions en/api/@connectum/events/types/interfaces/EventBus.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: EventBus

Defined in: [packages/events/src/types.ts:399](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L399)
Defined in: [packages/events/src/types.ts:414](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L414)

EventBus interface -- manages adapter, routes, and middleware

Expand All @@ -12,7 +12,7 @@ EventBus interface -- manages adapter, routes, and middleware

> **publish**\<`Desc`\>(`schema`, `data`, `options?`): `Promise`\<`void`\>

Defined in: [packages/events/src/types.ts:413](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L413)
Defined in: [packages/events/src/types.ts:428](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L428)

Publish a typed event

Expand Down Expand Up @@ -46,7 +46,7 @@ Publish a typed event

> **start**(`options?`): `Promise`\<`void`\>

Defined in: [packages/events/src/types.ts:409](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L409)
Defined in: [packages/events/src/types.ts:424](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L424)

Start the event bus: connect adapter, set up subscriptions.

Expand Down Expand Up @@ -74,7 +74,7 @@ shutdown or per-event timeout will abort in-flight processing.

> **stop**(): `Promise`\<`void`\>

Defined in: [packages/events/src/types.ts:411](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L411)
Defined in: [packages/events/src/types.ts:426](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L426)

Stop the event bus: drain subscriptions, disconnect adapter

Expand Down
22 changes: 11 additions & 11 deletions en/api/@connectum/events/types/interfaces/EventBusOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: EventBusOptions

Defined in: [packages/events/src/types.ts:309](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L309)
Defined in: [packages/events/src/types.ts:324](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L324)

EventBus configuration options for createEventBus()

Expand All @@ -12,7 +12,7 @@ EventBus configuration options for createEventBus()

> **adapter**: [`EventAdapter`](EventAdapter.md)

Defined in: [packages/events/src/types.ts:311](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L311)
Defined in: [packages/events/src/types.ts:326](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L326)

Adapter instance (e.g., NatsAdapter, KafkaAdapter, MemoryAdapter)

Expand All @@ -22,7 +22,7 @@ Adapter instance (e.g., NatsAdapter, KafkaAdapter, MemoryAdapter)

> `optional` **drainPublishTimeout?**: `number`

Defined in: [packages/events/src/types.ts:379](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L379)
Defined in: [packages/events/src/types.ts:394](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L394)

Opt-in symmetric publish drain during `stop()`: maximum time in
milliseconds to wait for in-flight `publish()` promises (started BEFORE
Expand Down Expand Up @@ -55,7 +55,7 @@ in-flight publishes race the adapter disconnect exactly as before.

> `optional` **drainTimeout?**: `number`

Defined in: [packages/events/src/types.ts:352](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L352)
Defined in: [packages/events/src/types.ts:367](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L367)

Maximum time in milliseconds to wait for in-flight event handlers
to complete during shutdown. After this timeout, remaining handlers
Expand All @@ -69,7 +69,7 @@ Default: 30000 (30 seconds). Set to 0 for immediate abort.

> `optional` **group?**: `string`

Defined in: [packages/events/src/types.ts:327](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L327)
Defined in: [packages/events/src/types.ts:342](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L342)

Consumer group name

Expand All @@ -79,7 +79,7 @@ Consumer group name

> `optional` **handlerTimeout?**: `number`

Defined in: [packages/events/src/types.ts:344](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L344)
Defined in: [packages/events/src/types.ts:359](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L359)

Per-event handler timeout in milliseconds.

Expand All @@ -92,7 +92,7 @@ this duration. Default: 30000 (30 seconds).

> `optional` **middleware?**: [`MiddlewareConfig`](MiddlewareConfig.md)

Defined in: [packages/events/src/types.ts:329](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L329)
Defined in: [packages/events/src/types.ts:344](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L344)

Middleware configuration

Expand All @@ -102,7 +102,7 @@ Middleware configuration

> `optional` **publishes?**: `DescService`[]

Defined in: [packages/events/src/types.ts:325](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L325)
Defined in: [packages/events/src/types.ts:340](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L340)

Event service descriptors this bus publishes to (publish-only, no subscription).

Expand All @@ -120,7 +120,7 @@ hand-maintaining raw topic strings. Subscribers still register via `routes`.

> `optional` **routes?**: [`EventRoute`](../type-aliases/EventRoute.md)[]

Defined in: [packages/events/src/types.ts:313](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L313)
Defined in: [packages/events/src/types.ts:328](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L328)

Event routes to register

Expand All @@ -130,7 +130,7 @@ Event routes to register

> `optional` **signal?**: `AbortSignal`

Defined in: [packages/events/src/types.ts:337](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L337)
Defined in: [packages/events/src/types.ts:352](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L352)

Abort signal for graceful shutdown.

Expand All @@ -144,7 +144,7 @@ Automatically set when used with `createServer({ eventBus })`.

> `optional` **strictTopics?**: `boolean`

Defined in: [packages/events/src/types.ts:393](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L393)
Defined in: [packages/events/src/types.ts:408](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L408)

Reject a `publish()` whose topic cannot be resolved instead of silently
falling back to the message `typeName`.
Expand Down
18 changes: 9 additions & 9 deletions en/api/@connectum/events/types/interfaces/EventContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: EventContext

Defined in: [packages/events/src/types.ts:146](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L146)
Defined in: [packages/events/src/types.ts:161](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L161)

Per-event context with explicit ack/nack control.

Expand All @@ -16,7 +16,7 @@ without calling either, the event is automatically acknowledged.

> `readonly` **attempt**: `number`

Defined in: [packages/events/src/types.ts:156](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L156)
Defined in: [packages/events/src/types.ts:171](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L171)

Delivery attempt number (1-based)

Expand All @@ -26,7 +26,7 @@ Delivery attempt number (1-based)

> `readonly` **eventId**: `string`

Defined in: [packages/events/src/types.ts:150](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L150)
Defined in: [packages/events/src/types.ts:165](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L165)

Unique event identifier

Expand All @@ -36,7 +36,7 @@ Unique event identifier

> `readonly` **eventType**: `string`

Defined in: [packages/events/src/types.ts:152](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L152)
Defined in: [packages/events/src/types.ts:167](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L167)

Event type / topic name

Expand All @@ -46,7 +46,7 @@ Event type / topic name

> `readonly` **metadata**: `ReadonlyMap`\<`string`, `string`\>

Defined in: [packages/events/src/types.ts:158](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L158)
Defined in: [packages/events/src/types.ts:173](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L173)

Event metadata (headers)

Expand All @@ -56,7 +56,7 @@ Event metadata (headers)

> `readonly` **publishedAt**: `Date`

Defined in: [packages/events/src/types.ts:154](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L154)
Defined in: [packages/events/src/types.ts:169](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L169)

When the event was published

Expand All @@ -66,7 +66,7 @@ When the event was published

> `readonly` **signal**: `AbortSignal`

Defined in: [packages/events/src/types.ts:148](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L148)
Defined in: [packages/events/src/types.ts:163](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L163)

Abort signal (aborted when server is shutting down)

Expand All @@ -76,7 +76,7 @@ Abort signal (aborted when server is shutting down)

> **ack**(): `Promise`\<`void`\>

Defined in: [packages/events/src/types.ts:160](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L160)
Defined in: [packages/events/src/types.ts:175](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L175)

Acknowledge successful processing

Expand All @@ -90,7 +90,7 @@ Acknowledge successful processing

> **nack**(`requeue?`): `Promise`\<`void`\>

Defined in: [packages/events/src/types.ts:162](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L162)
Defined in: [packages/events/src/types.ts:177](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L177)

Negative acknowledge -- request redelivery or send to DLQ

Expand Down
10 changes: 5 additions & 5 deletions en/api/@connectum/events/types/interfaces/EventContextInit.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: EventContextInit

Defined in: [packages/events/src/types.ts:168](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L168)
Defined in: [packages/events/src/types.ts:183](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L183)

Initialization data for creating an EventContext

Expand All @@ -12,7 +12,7 @@ Initialization data for creating an EventContext

> `readonly` **onAck**: () => `Promise`\<`void`\>

Defined in: [packages/events/src/types.ts:171](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L171)
Defined in: [packages/events/src/types.ts:186](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L186)

#### Returns

Expand All @@ -24,7 +24,7 @@ Defined in: [packages/events/src/types.ts:171](https://github.com/Connectum-Fram

> `readonly` **onNack**: (`requeue`) => `Promise`\<`void`\>

Defined in: [packages/events/src/types.ts:172](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L172)
Defined in: [packages/events/src/types.ts:187](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L187)

#### Parameters

Expand All @@ -42,12 +42,12 @@ Defined in: [packages/events/src/types.ts:172](https://github.com/Connectum-Fram

> `readonly` **raw**: [`RawEvent`](RawEvent.md)

Defined in: [packages/events/src/types.ts:169](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L169)
Defined in: [packages/events/src/types.ts:184](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L184)

***

### signal

> `readonly` **signal**: `AbortSignal`

Defined in: [packages/events/src/types.ts:170](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L170)
Defined in: [packages/events/src/types.ts:185](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L185)
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: EventHandlerConfig\<I\>

Defined in: [packages/events/src/types.ts:191](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L191)
Defined in: [packages/events/src/types.ts:206](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L206)

Per-handler middleware configuration.

Expand All @@ -22,7 +22,7 @@ and only the per-handler middleware array is applied.

> `readonly` **handler**: [`TypedEventHandler`](../type-aliases/TypedEventHandler.md)\<`I`\>

Defined in: [packages/events/src/types.ts:193](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L193)
Defined in: [packages/events/src/types.ts:208](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L208)

Event handler function

Expand All @@ -32,6 +32,6 @@ Event handler function

> `readonly` `optional` **middleware?**: [`EventMiddleware`](../type-aliases/EventMiddleware.md)[]

Defined in: [packages/events/src/types.ts:195](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L195)
Defined in: [packages/events/src/types.ts:210](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L210)

Per-handler middleware array (overrides global middleware for this handler)
10 changes: 5 additions & 5 deletions en/api/@connectum/events/types/interfaces/EventRouteEntry.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: EventRouteEntry

Defined in: [packages/events/src/types.ts:212](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L212)
Defined in: [packages/events/src/types.ts:227](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L227)

Registered event route (internal use)

Expand All @@ -12,7 +12,7 @@ Registered event route (internal use)

> `readonly` **handler**: [`TypedEventHandler`](../type-aliases/TypedEventHandler.md)\<`unknown`\>

Defined in: [packages/events/src/types.ts:218](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L218)
Defined in: [packages/events/src/types.ts:233](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L233)

Typed handler function

Expand All @@ -22,7 +22,7 @@ Typed handler function

> `readonly` **method**: `DescMethod`

Defined in: [packages/events/src/types.ts:216](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L216)
Defined in: [packages/events/src/types.ts:231](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L231)

Method descriptor for deserialization

Expand All @@ -32,7 +32,7 @@ Method descriptor for deserialization

> `readonly` `optional` **middleware?**: [`EventMiddleware`](../type-aliases/EventMiddleware.md)[]

Defined in: [packages/events/src/types.ts:220](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L220)
Defined in: [packages/events/src/types.ts:235](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L235)

Per-handler middleware (overrides global when present)

Expand All @@ -42,6 +42,6 @@ Per-handler middleware (overrides global when present)

> `readonly` **topic**: `string`

Defined in: [packages/events/src/types.ts:214](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L214)
Defined in: [packages/events/src/types.ts:229](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L229)

Topic pattern to subscribe to
Loading
Loading