Class VersionedArvoContract<TContract, TVersion>

Implements a version-specific view of an ArvoContract with type-safe schema validation and JSON Schema generation capabilities.

Type Parameters

TContract extends ArvoContract
TVersion extends ArvoSemanticVersion & keyof TContract["versions"]

Index

Constructors

constructor

new VersionedArvoContract<
    TContract extends
        ArvoContract<
            string,
            string,
            Record<
                `${number}.${number}.${number}`,
                { accepts: ZodTypeAny; emits: Record<string, z.ZodTypeAny> },
            >,
            Record<string, any>,
        >,
    TVersion extends `${number}.${number}.${number}`,
>(
    param: VersionedArvoContractParam<TContract, TVersion>,
): VersionedArvoContract<TContract, TVersion>
Type Parameters
- TContract extends ArvoContract<
      string,
      string,
      Record<
          `${number}.${number}.${number}`,
          { accepts: ZodTypeAny; emits: Record<string, z.ZodTypeAny> },
      >,
      Record<string, any>,
  >
- TVersion extends `${number}.${number}.${number}`
Parameters
- param: VersionedArvoContractParam<TContract, TVersion>
Returns VersionedArvoContract<TContract, TVersion>
- Defined in src/ArvoContract/VersionedArvoContract/index.ts:61

Properties

`Protected` `Readonly`_accepts

_accepts: ArvoContractRecord<
TContract["type"],
TContract["versions"][TVersion]["accepts"],
>

`Protected` `Readonly`_contract

_contract: TContract

`Protected` `Readonly`_emitList

_emitList: {
    [K in string]: ArvoContractRecord<
        K,
        TContract["versions"][TVersion]["emits"][K],
    >
}[keyof TContract["versions"][TVersion]["emits"] & string][]

`Protected` `Readonly`_emits

_emits: TContract["versions"][TVersion]["emits"]

`Protected` `Readonly`_version

_version: TVersion

Accessors

accepts

get accepts(): ArvoContractRecord<
TContract["type"],
TContract["versions"][TVersion]["accepts"],
>
Returns ArvoContractRecord<
TContract["type"],
TContract["versions"][TVersion]["accepts"],
>
- Defined in src/ArvoContract/VersionedArvoContract/index.ts:45

dataschema

get dataschema(): `${TContract["uri"]}/${TVersion}`
Returns `${TContract["uri"]}/${TVersion}`
- Defined in src/ArvoContract/VersionedArvoContract/index.ts:54

description

get description(): TContract["description"]
Returns TContract["description"]
- Defined in src/ArvoContract/VersionedArvoContract/index.ts:31

domain

get domain(): string | null
Returns string | null
- Defined in src/ArvoContract/VersionedArvoContract/index.ts:57

emitList

get emitList(): {
    [K in string]: ArvoContractRecord<
        K,
        TContract["versions"][TVersion]["emits"][K],
    >
}[keyof TContract["versions"][TVersion]["emits"] & string][]
Returns {
    [K in string]: ArvoContractRecord<
        K,
        TContract["versions"][TVersion]["emits"][K],
    >
}[keyof TContract["versions"][TVersion]["emits"] & string][]
- Defined in src/ArvoContract/VersionedArvoContract/index.ts:51

emits

get emits(): TContract["versions"][TVersion]["emits"]
Returns TContract["versions"][TVersion]["emits"]
- Defined in src/ArvoContract/VersionedArvoContract/index.ts:48

metadata

get metadata(): TContract["metadata"]
Returns TContract["metadata"]
- Defined in src/ArvoContract/VersionedArvoContract/index.ts:34

systemError

get systemError(): TContract["systemError"] & {
dataschema: `${TContract["uri"]}/0.0.0`;
}
Returns TContract["systemError"] & { dataschema: `${TContract["uri"]}/0.0.0` }
- Defined in src/ArvoContract/VersionedArvoContract/index.ts:37

uri

get uri(): TContract["uri"]
Returns TContract["uri"]
- Defined in src/ArvoContract/VersionedArvoContract/index.ts:25

version

get version(): TVersion
Returns TVersion
- Defined in src/ArvoContract/VersionedArvoContract/index.ts:28

Methods

toJsonSchema

toJsonSchema(): VersionedArvoContractJSONSchema
Converts the contract to JSON Schema format

Returns VersionedArvoContractJSONSchema
Contract specification in JSON Schema format for documentation/serialization
- Defined in src/ArvoContract/VersionedArvoContract/index.ts:76

Class VersionedArvoContract<TContract, TVersion>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns VersionedArvoContract<TContract, TVersion>

Properties

Protected Readonly_accepts

Protected Readonly_contract

Protected Readonly_emitList

Protected Readonly_emits

Protected Readonly_version

Accessors

accepts

Returns ArvoContractRecord< TContract["type"], TContract["versions"][TVersion]["accepts"],>

dataschema

Returns `${TContract["uri"]}/${TVersion}`

description

Returns TContract["description"]

domain

Returns string | null

emitList

Returns { [K in string]: ArvoContractRecord< K, TContract["versions"][TVersion]["emits"][K], >}[keyof TContract["versions"][TVersion]["emits"] & string][]

emits

Returns TContract["versions"][TVersion]["emits"]

metadata

Returns TContract["metadata"]

systemError

Returns TContract["systemError"] & { dataschema: `${TContract["uri"]}/0.0.0` }

uri

Returns TContract["uri"]

version

Returns TVersion

Methods

toJsonSchema

Returns VersionedArvoContractJSONSchema

Settings

On This Page

`Protected` `Readonly`_accepts

`Protected` `Readonly`_contract

`Protected` `Readonly`_emitList

`Protected` `Readonly`_emits

`Protected` `Readonly`_version

Returns ArvoContractRecord<
TContract["type"],
TContract["versions"][TVersion]["accepts"],
>

Returns {
[K in string]: ArvoContractRecord<
K,
TContract["versions"][TVersion]["emits"][K],
>
}[keyof TContract["versions"][TVersion]["emits"] & string][]