Class ArvoEvent<TData, TExtension, TType>

constructor

• new ArvoEvent<
      TData extends Record<string, any> = Record<string, any>,
      TExtension extends
          Record<string, string | number | boolean | null> = Record<
          string,
          string
          | number
          | boolean
          | null,
      >,
      TType extends string = string,
  >(
      context: {
          datacontenttype: string;
          dataschema: string | null;
          id: string;
          source: string;
          specversion: "1.0";
          subject: string;
          time: string;
          type: string;
      } & {
          accesscontrol: string
          | null;
          domain: string | null;
          executionunits: number | null;
          parentid: string | null;
          redirectto: string | null;
          to: string | null;
      } & { traceparent: string
      | null; tracestate: string | null },
      data: TData,
      extensions?: TExtension,
  ): ArvoEvent<TData, TExtension, TType>

  Creates an instance of ArvoEvent with CloudEvent context, data, and optional extensions.

  Type Parameters

  • TData extends Record<string, any> = Record<string, any>
  • TExtension extends Record<string, string | number | boolean | null> = Record<string, string | number | boolean | null>
  • TType extends string = string

  Parameters

  • context: {
        datacontenttype: string;
        dataschema: string | null;
        id: string;
        source: string;
        specversion: "1.0";
        subject: string;
        time: string;
        type: string;
    } & {
        accesscontrol: string
        | null;
        domain: string | null;
        executionunits: number | null;
        parentid: string | null;
        redirectto: string | null;
        to: string | null;
    } & { traceparent: string
    | null; tracestate: string | null }

    The CloudEvent context combined with required Arvo and OpenTelemetry extensions

  • data: TData

    The event data payload (must be JSON serializable)

  • Optionalextensions: TExtension

    Optional additional custom extensions with lowercase alphanumeric keys

  Returns ArvoEvent<TData, TExtension, TType>

  Throws

  If datacontenttype is "application/cloudevents+json;charset=UTF-8;profile=arvo" but the 'to' field is not defined

  Throws

  If any validation fails according to the respective schemas

  Example

  const event = new ArvoEvent(
    {
      id: 'event-123',
      source: 'https://example.com/service',
      type: 'com.example.user.created',
      subject: 'https://example.com/users/123',
      time: new Date().toISOString(),
      specversion: '1.0',
      datacontenttype: 'application/cloudevents+json;charset=UTF-8;profile=arvo',
      dataschema: null,
      to: 'com.example.user.processor',
      accesscontrol: 'role:admin;department:hr',
      redirectto: null,
      executionunits: 10,
      parentid: 'parent-event-456',
      domain: 'analytics',
      traceparent: '00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01',
      tracestate: 'vendor=trace-data'
    },
    { userId: '123', name: 'John Doe' }
  );
  Copy

Readonlydata

Readonlydatacontenttype

Readonlydataschema

Readonlyid

Readonlysource

Readonlyspecversion

Readonlysubject

Readonlytime

Readonlytype

accesscontrol

• get accesscontrol(): string | null

  Gets the access control information for the event. Can contain:

  • A UserID (valid UUID)
  • An encrypted base64 string with access control data
  • Key-value pairs (semicolon-separated, colon-delimited) Example: "role:admin;department:finance;clearance:top-secret"

  Returns string | null

cloudevent

• get cloudevent(): {
      default: {
          data: TData;
          datacontenttype: string;
          dataschema: string
          | null;
          id: string;
          source: string;
          specversion: string;
          subject: string;
          time: string;
          type: TType;
      };
      extensions: TExtension & {
          accesscontrol: string
          | null;
          domain: string | null;
          executionunits: number | null;
          parentid: string | null;
          redirectto: string | null;
          to: string | null;
      } & { traceparent: string
      | null; tracestate: string | null };
  }

  Gets the CloudEvent-specified fields separated into default attributes and extensions.

  Returns {
      default: {
          data: TData;
          datacontenttype: string;
          dataschema: string | null;
          id: string;
          source: string;
          specversion: string;
          subject: string;
          time: string;
          type: TType;
      };
      extensions: TExtension & {
          accesscontrol: string
          | null;
          domain: string | null;
          executionunits: number | null;
          parentid: string | null;
          redirectto: string | null;
          to: string | null;
      } & { traceparent: string
      | null; tracestate: string | null };
  }

  An object containing:

  • default: Standard CloudEvent attributes (id, source, specversion, type, subject, datacontenttype, dataschema, data, time)
  • extensions: All extension attributes including:
    • Arvo extensions
    • OpenTelemetry extensions
    • Custom extensions

  Example

  const { default: defaults, extensions } = event.cloudevent;
  console.log(defaults.id); // Event ID
  console.log(extensions.to); // Arvo 'to' field
  Copy

domain

• get domain(): string | null

  Gets the processing domain for event routing and workflow orchestration.

  Returns string | null

executionunits

• get executionunits(): number | null

  Gets the execution units representing the cost associated with generating this event. Used for tracking financial impact and resource utilization in cloud-based systems.

  Returns number | null

extensions

• get extensions(): TExtension

  Gets only the custom extensions (TExtension) added to the ArvoEvent, excluding the standard Arvo and OpenTelemetry extensions.

  Returns TExtension

  The custom extensions object with Arvo and OpenTelemetry fields removed

  Remarks

  For accessing all extensions including Arvo and OpenTelemetry, use cloudevent.extensions. For accessing basic CloudEvent fields, use cloudevent.default. Custom extension keys must follow lowercase alphanumeric naming (a-z, 0-9 only).

otelAttributes

• get otelAttributes(): {
      "cloudevents.arvo.event_domain": string;
      "cloudevents.arvo.event_executionunits": string
      | number;
      "cloudevents.arvo.event_parentid": string;
      "cloudevents.arvo.event_redirectto": string;
      "cloudevents.arvo.event_to": string;
      "cloudevents.event_datacontenttype": string;
      "cloudevents.event_dataschema": string;
      "cloudevents.event_id": string;
      "cloudevents.event_source": string;
      "cloudevents.event_spec_version": string;
      "cloudevents.event_subject": string;
      "cloudevents.event_time": string;
      "cloudevents.event_type": string | TType;
  }

  Gets OpenTelemetry attributes derived from the ArvoEvent for distributed tracing.

  Returns {
      "cloudevents.arvo.event_domain": string;
      "cloudevents.arvo.event_executionunits": string | number;
      "cloudevents.arvo.event_parentid": string;
      "cloudevents.arvo.event_redirectto": string;
      "cloudevents.arvo.event_to": string;
      "cloudevents.event_datacontenttype": string;
      "cloudevents.event_dataschema": string;
      "cloudevents.event_id": string;
      "cloudevents.event_source": string;
      "cloudevents.event_spec_version": string;
      "cloudevents.event_subject": string;
      "cloudevents.event_time": string;
      "cloudevents.event_type": string | TType;
  }

  An object containing OpenTelemetry semantic convention attributes:

  • Standard CloudEvent attributes prefixed with 'cloudevents.event_*'
  • Arvo-specific attributes prefixed with 'cloudevents.arvo.*'
  • Uses 'N/A' for undefined/null values to maintain telemetry consistency

  Remarks

  The attributes follow the OpenTelemetry semantic conventions for CloudEvents as specified in the official documentation: https://opentelemetry.io/docs/specs/semconv/attributes-registry/cloudevents/

parentid

• get parentid(): string | null

  Gets the unique identifier of the event that directly triggered the creation of this event within the Arvo ecosystem. Establishes direct causal relationships for event lineage tracking. Null indicates an initiating event or generation outside direct causation.

  Returns string | null

redirectto

• get redirectto(): string | null

  Gets the alternative recipient or destination for dynamic routing. Enables complex workflows and conditional event routing.

  Returns string | null

to

• get to(): string | null

  Gets the target consumer machine for event routing.

  Returns string | null

traceparent

• get traceparent(): string | null

  Gets the OpenTelemetry traceparent header containing trace context information including trace ID, parent span ID, and trace flags for distributed tracing across services.

  Returns string | null

tracestate

• get tracestate(): string | null

  Gets the OpenTelemetry tracestate header containing vendor-specific trace information as key-value pairs propagated alongside traceparent in distributed tracing scenarios.

  Returns string | null

toJSON

• toJSON(): InferArvoEvent<ArvoEvent<TData, TExtension, TType>>

  Converts the ArvoEvent to a JSON-serializable object by combining all CloudEvent default fields with all extensions into a single flat object.

  Returns InferArvoEvent<ArvoEvent<TData, TExtension, TType>>

  A flat object containing all CloudEvent fields and extensions, suitable for JSON serialization and network transmission

  Remarks

  This method creates a flattened representation where both standard CloudEvent fields and all extensions (Arvo, OpenTelemetry, and custom) are at the same level. For separated access to defaults and extensions, use the cloudevent getter instead.

  Example

  const jsonObj = event.toJSON();
  // Contains: id, source, type, subject, data, time, to, traceparent, etc.
  Copy

toString

• toString(spacing?: number): string

  Converts the ArvoEvent to a JSON string representation.

  Parameters

  • spacing: number = 0

    The number of spaces to use for indentation (default: 0 for compact output)

  Returns string

  A JSON string representation of the complete ArvoEvent

  Example

  const compactJson = event.toString(); // Compact JSON
  const prettyJson = event.toString(2); // Pretty-printed with 2-space indentation
  Copy