Type Alias ICreateArvoOrchestratorContract<TUri, TName, TVersions, TMetaData>

ICreateArvoOrchestratorContract<TUri, TName, TVersions, TMetaData>: {
    description?: string;
    domain?: string;
    metadata?: TMetaData;
    name: TName;
    uri: TUri;
    versions: TVersions;
}

Interface defining the configuration structure for creating an Arvo Orchestrator Contract. This interface specifies the required properties for initializing a new orchestrator contract.

Type Parameters

  • TUri extends string

    The URI type that uniquely identifies the contract

  • TName extends string
  • TVersions extends Record<ArvoSemanticVersion, {
        complete: z.ZodTypeAny;
        init: z.ZodTypeAny;
    }>

    Record of versioned schemas for init and complete events

  • TMetaData extends Record<string, any>

    The metadata of the contract

Template: TType

The base event type for the orchestrator

Remarks

  • The URI should be unique within your system
  • The type will be used to generate appropriate event type strings
  • Each version must conform to ArvoSemanticVersion format

Settings

Member Visibility