Variable ArvoEventSchemaConst

Type Declaration

• ArvoDataSchema: ZodEffects<
      ZodRecord<ZodString, ZodAny>,
      Record<string, any>,
      Record<string, any>,
  >

  Zod schema for validating the data payload of an Arvo event. The data must be a JSON serializable object.

• ArvoExtensionSchema: ZodObject<
      {
          accesscontrol: ZodNullable<ZodString>;
          domain: ZodNullable<ZodString>;
          executionunits: ZodNullable<ZodNumber>;
          parentid: ZodNullable<ZodString>;
          redirectto: ZodNullable<ZodEffects<ZodString, string, string>>;
          to: ZodNullable<ZodEffects<ZodString, string, string>>;
      },
      "strip",
      ZodTypeAny,
      {
          accesscontrol: string
          | null;
          domain: string | null;
          executionunits: number | null;
          parentid: string | null;
          redirectto: string | null;
          to: string | null;
      },
      {
          accesscontrol: string
          | null;
          domain: string | null;
          executionunits: number | null;
          parentid: string | null;
          redirectto: string | null;
          to: string | null;
      },
  >

  Zod schema for validating Arvo-specific extensions to the CloudEvent. This schema defines additional fields used by Arvo for event routing, access control, and execution metrics.

• CloudEventContextSchema: ZodObject<
      {
          datacontenttype: ZodDefault<ZodEffects<ZodString, string, string>>;
          dataschema: ZodNullable<ZodEffects<ZodString, string, string>>;
          id: ZodString;
          source: ZodEffects<ZodString, string, string>;
          specversion: ZodEffects<ZodString, "1.0", string>;
          subject: ZodEffects<ZodString, string, string>;
          time: ZodString;
          type: ZodString;
      },
      "strip",
      ZodTypeAny,
      {
          datacontenttype: string;
          dataschema: string
          | null;
          id: string;
          source: string;
          specversion: "1.0";
          subject: string;
          time: string;
          type: string;
      },
      {
          datacontenttype?: string;
          dataschema: string
          | null;
          id: string;
          source: string;
          specversion: string;
          subject: string;
          time: string;
          type: string;
      },
  >

  Zod schema for validating the core properties of a CloudEvent. This schema defines the structure and validation rules for the mandatory and optional attributes of a CloudEvent as per the CloudEvents specification.

• CloudEventExtensionSchema: ZodRecord<ZodString, ZodUnion<[ZodString, ZodBoolean, ZodNumber, ZodNull]>>

  Zod schema for validating custom CloudEvent extensions. This schema allows for additional custom fields in the CloudEvent, following the CloudEvents specification for extension attributes.

• OpenTelemetryExtensionSchema: ZodObject<
      {
          traceparent: ZodNullable<ZodString>;
          tracestate: ZodNullable<ZodString>;
      },
      "strip",
      ZodTypeAny,
      { traceparent: string
      | null; tracestate: string | null },
      { traceparent: string | null; tracestate: string | null },
  >

  Zod schema for validating OpenTelemetry extensions to the CloudEvent. This schema includes fields for distributed tracing as per the OpenTelemetry specification.

• OrchestrationInitEventBaseSchema: ZodObject<
      { parentSubject$$: ZodNullable<ZodString> },
      "strip",
      ZodTypeAny,
      { parentSubject$$: string | null },
      { parentSubject$$: string | null },
  >

  Defines the base schema for orchestrator acceptance in the context of ArvoEvents. This schema is used to validate and type-check the minimal required fields for an orchestrator to accept a task or event.