Class ArvoEventFactory<TContract>

Factory class for creating and validating events based on a versioned Arvo contract. Handles event creation, validation, and OpenTelemetry integration for a specific contract version.

Example

const contract = createArvoContract({
  uri: 'example/api',
  type: 'user.create',
  versions: { '1.0.0': { ... } }
});

const factory = createArvoEventFactory(contract.version('1.0.0'));

Type Parameters

TContract extends VersionedArvoContract<any, any>

Hierarchy (View Summary)

ArvoEventFactory
- ArvoOrchestratorEventFactory

Index

Constructors

constructor

new ArvoEventFactory<TContract extends VersionedArvoContract<any, any>>(
contract: TContract,
): ArvoEventFactory<TContract>
Creates an ArvoEventFactory instance for a specific version of a contract.
Type Parameters
- TContract extends VersionedArvoContract<any, any>
Parameters
- contract: TContract
  The versioned contract to use for event creation and validation
Returns ArvoEventFactory<TContract>
- Defined in src/ArvoEventFactory/index.ts:37

Properties

`Protected` `Readonly`_name

_name: string = 'EventFactory'

`Protected` `Readonly`contract

contract: TContract

Methods

accepts

accepts<TExtension extends Record<string, any>>(
    event: Omit<
        CreateArvoEvent<
            input<TContract["accepts"]["schema"]>,
            TContract["accepts"]["type"],
        >,
        "type" | "subject" | "datacontenttype" | "dataschema" | "domain",
    > & { domain?: string | null; subject?: string },
    extensions?: TExtension,
): ArvoEvent<
    TypeOf<TContract["accepts"]["schema"]>,
    TExtension,
    TContract["accepts"]["type"],
>
Creates and validates an event matching the contract's accept specification.
Type Parameters
- TExtension extends Record<string, any>
Parameters
- event: Omit<
      CreateArvoEvent<
          input<TContract["accepts"]["schema"]>,
          TContract["accepts"]["type"],
      >,
      "type" | "subject" | "datacontenttype" | "dataschema" | "domain",
  > & { domain?: string | null; subject?: string }
  The event configuration object
- Optionalextensions: TExtension
  Optional additional properties for the event
Returns ArvoEvent<
    TypeOf<TContract["accepts"]["schema"]>,
    TExtension,
    TContract["accepts"]["type"],
>
A validated ArvoEvent matching the contract's accept specification
Throws
If validation fails or OpenTelemetry operations fail
Example
```
const event = factory.accepts({
  source: 'api/users',
  data: { name: 'John', email: 'john@example.com' }
});
```
- Defined in src/ArvoEventFactory/index.ts:59

emits

emits<U extends string, TExtension extends Record<string, any>>(
    event: Omit<
        CreateArvoEvent<input<TContract["emits"][U]>, U>,
        "subject" | "datacontenttype" | "dataschema" | "domain",
    > & { domain?: string | null; subject?: string },
    extensions?: TExtension,
): ArvoEvent<TypeOf<TContract["emits"][U]>, TExtension, U>
Creates and validates an event matching one of the contract's emit specifications.
Type Parameters
- U extends string
- TExtension extends Record<string, any>
Parameters
- event: Omit<
  CreateArvoEvent<input<TContract["emits"][U]>, U>,
  "subject" | "datacontenttype" | "dataschema" | "domain",
  > & { domain?: string | null; subject?: string }
  The event configuration object
- Optionalextensions: TExtension
  Optional additional properties for the event
Returns ArvoEvent<TypeOf<TContract["emits"][U]>, TExtension, U>
A validated ArvoEvent matching the specified emit type
Throws
If validation fails, emit type doesn't exist, or OpenTelemetry operations fail
Example
```
const event = factory.emits({
  type: 'user.created',
  source: 'api/users',
  data: { id: '123', timestamp: new Date() }
});
```
- Defined in src/ArvoEventFactory/index.ts:133

systemError

systemError<TExtension extends Record<string, any>>(
    event: Omit<
        CreateArvoEvent<any, any>,
        "type" | "subject" | "datacontenttype" | "dataschema" | "domain" | "data",
    > & { domain?: string | null; error: Error; subject?: string },
    extensions?: TExtension,
): ArvoEvent<
    { errorMessage: string; errorName: string; errorStack: string
    | null },
    TExtension,
    TContract["systemError"]["type"],
>
Creates a system error event for error reporting and handling.
Type Parameters
- TExtension extends Record<string, any>
Parameters
- event: Omit<
  CreateArvoEvent<any, any>,
  "type" | "subject" | "datacontenttype" | "dataschema" | "domain" | "data",
  > & { domain?: string | null; error: Error; subject?: string }
  The error event configuration
  - error
    The Error instance to convert to an event
  - Optionaldomain?: string | null
  - error: Error
    The Error instance to convert to an event
  - Optionalsubject?: string
- Optionalextensions: TExtension
  Optional additional properties for the event
Returns ArvoEvent<
    { errorMessage: string; errorName: string; errorStack: string
    | null },
    TExtension,
    TContract["systemError"]["type"],
>
A system error ArvoEvent
Throws
If event creation or OpenTelemetry operations fail
Example
```
const errorEvent = factory.systemError({
  error: new Error('Validation failed'),
  source: 'api/validation'
});
```
- Defined in src/ArvoEventFactory/index.ts:207

Class ArvoEventFactory<TContract>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ArvoEventFactory<TContract>

Properties

Protected Readonly_name

Protected Readonlycontract

Methods

accepts

Type Parameters

Parameters

Returns ArvoEvent< TypeOf<TContract["accepts"]["schema"]>, TExtension, TContract["accepts"]["type"],>

Throws

Example

emits

Type Parameters

Parameters

Returns ArvoEvent<TypeOf<TContract["emits"][U]>, TExtension, U>

Throws

Example

systemError

Type Parameters

Parameters

error

Optionaldomain?: string | null

error: Error

Optionalsubject?: string

Returns ArvoEvent< { errorMessage: string; errorName: string; errorStack: string | null }, TExtension, TContract["systemError"]["type"],>

Throws

Example

Settings

On This Page

`Protected` `Readonly`_name

`Protected` `Readonly`contract

Returns ArvoEvent<
TypeOf<TContract["accepts"]["schema"]>,
TExtension,
TContract["accepts"]["type"],
>

`Optional`domain?: string | null

`Optional`subject?: string

Returns ArvoEvent<
{ errorMessage: string; errorName: string; errorStack: string
| null },
TExtension,
TContract["systemError"]["type"],
>