Class ArvoContract<TUri, TType, TVersions, TMetaData>

Represents a contract with defined input and output schemas for event-driven architectures. The ArvoContract class provides type-safe validation and versioning capabilities for event handling, ensuring consistency in message passing between different parts of the system.

Example

const contract = createArvoContract({
  uri: '#/my/service/data',
  type: 'com.process.data',
  description: 'An example contract',
  metadata: {
    visibility: "public"
  }
  versions: {
    '1.0.0': {
      accepts: z.object({ data: z.string() }),
      emits: {
        'data.processed': z.object({ result: z.string() })
      }
    },
    '2.0.0': {
      accepts: z.object({ data: z.number() }),
      emits: {
        'data.processed': z.object({ result: z.number() })
      }
    }
  }
});

Type Parameters

  • TUri extends string = string
  • TType extends string = string
  • TVersions extends Record<ArvoSemanticVersion, {
        accepts: z.ZodTypeAny;
        emits: Record<string, z.ZodTypeAny>;
    }> = Record<ArvoSemanticVersion, {
        accepts: z.ZodTypeAny;
        emits: Record<string, z.ZodTypeAny>;
    }>
  • TMetaData extends Record<string, any> = Record<string, any>

Constructors

constructor

Properties

_description _domain _metadata _type _uri _versions

Accessors

description domain metadata systemError type uri versions

Methods

export getSortedVersionNumbers toJsonSchema version

Constructors

constructor

  • new ArvoContract<TUri, TType, TVersions, TMetaData>(params): ArvoContract<TUri, TType, TVersions, TMetaData>

  • Creates a new ArvoContract instance with validated parameters.

    Type Parameters

    • TUri extends string = string
    • TType extends string = string
    • TVersions extends Record<`${number}.${number}.${number}`, {
          accepts: ZodTypeAny;
          emits: Record<string, ZodTypeAny>;
      }> = Record<`${number}.${number}.${number}`, {
          accepts: ZodTypeAny;
          emits: Record<string, ZodTypeAny>;
      }>
    • TMetaData extends Record<string, any> = Record<string, any>

    Parameters

    Returns ArvoContract<TUri, TType, TVersions, TMetaData>

    Throws

    When URI format is invalid

    Throws

    When event type format is invalid

    Throws

    When version string is not valid semantic version

    Throws

    When version is a reserved wildcard version

    Throws

    When emit type format is invalid

    Throws

    When no versions are provided

    Throws

    When domain does not have follow the condition Domain must contain only lowercase letters, numbers, and dots

Properties

Protected Readonly_description

_description: null | string

Protected Readonly_domain

_domain: null | string

Protected Readonly_metadata

_metadata: TMetaData

Protected Readonly_type

_type: TType

Protected Readonly_uri

_uri: TUri

Protected Readonly_versions

_versions: TVersions

Accessors

description

domain

metadata

systemError

  • get systemError(): ArvoContractRecord<`sys.${TType}.error`, ZodObject<{
        errorMessage: ZodString;
        errorName: ZodString;
        errorStack: ZodNullable<ZodString>;
    }, "strip", ZodTypeAny, {
        errorMessage: string;
        errorName: string;
        errorStack: null | string;
    }, {
        errorMessage: string;
        errorName: string;
        errorStack: null | string;
    }>>

  • Gets the system error event specification for this contract. System errors follow a standardized format to handle exceptional conditions and failures in a consistent way across all contracts.

    The error schema includes:

    • errorName: The name/type of the error
    • errorMessage: A descriptive message about what went wrong
    • errorStack: Optional stack trace information (null if not available)

    System errors are special events that:

    • Are automatically prefixed with 'sys.' and suffixed with '.error'
    • Use a standardized schema across all contracts
    • Can capture error details, messages, and stack traces
    • Are version-independent (work the same across all contract versions)

    Returns ArvoContractRecord<`sys.${TType}.error`, ZodObject<{
        errorMessage: ZodString;
        errorName: ZodString;
        errorStack: ZodNullable<ZodString>;
    }, "strip", ZodTypeAny, {
        errorMessage: string;
        errorName: string;
        errorStack: null | string;
    }, {
        errorMessage: string;
        errorName: string;
        errorStack: null | string;
    }>>

type

uri

versions

Methods

export

getSortedVersionNumbers

  • getSortedVersionNumbers(ordering): `${number}.${number}.${number}`[]

  • Retrieves version numbers in sorted order based on semantic versioning rules.

    Parameters

    • ordering: "ASC" | "DESC"

    Returns `${number}.${number}.${number}`[]

    Array of semantic versions sorted according to specified ordering

toJsonSchema

version

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods