Function createArvoContract

createArvoContract<
    TUri extends string,
    TType extends string,
    TVersions extends
        Record<
            `${number}.${number}.${number}`,
            { accepts: ZodTypeAny; emits: Record<string, z.ZodTypeAny> },
        >,
    TMetaData extends Record<string, any> = Record<string, any>,
>(
    contract: {
        description?: string;
        domain?: string;
        metadata?: TMetaData;
        type: TType;
        uri: TUri;
        versions: TVersions;
    },
): ArvoContract<TUri, TType, TVersions, TMetaData>
Creates a validated ArvoContract instance with full control over event types and schemas.
Type Parameters
- TUri extends string
- TType extends string
- TVersions extends Record<
  `${number}.${number}.${number}`,
  { accepts: ZodTypeAny; emits: Record<string, z.ZodTypeAny> },
  >
- TMetaData extends Record<string, any> = Record<string, any>
Parameters
- contract: {
      description?: string;
      domain?: string;
      metadata?: TMetaData;
      type: TType;
      uri: TUri;
      versions: TVersions;
  }
  Contract specification object
Returns ArvoContract<TUri, TType, TVersions, TMetaData>
A fully typed and validated ArvoContract instance
Throws
If the event types contain reserved prefix (ArvoOrchestratorEventTypeGen)

Throws
If any of the ArvoContract's internal validations fail. See ArvoContract
Example
```
const contract = createArvoContract({
  uri: 'com.example.contract',
  type: 'input.event',
  description: "Some example contract",
  metadata: {
    owner: 'team-a',
    priority: 'high'
  },
  versions: {
    '1.0.0': {
      accepts: z.object({ data: z.string() }),
      emits: {
        'output.event': z.object({ result: z.number() })
      }
    }
  }
});
```
- Defined in src/ArvoContract/helpers.ts:38

Function createArvoContract

Type Parameters

Parameters

Returns ArvoContract<TUri, TType, TVersions, TMetaData>

Throws

Throws

Example

Settings