Class EventDataschemaUtil

Manages event dataschema strings for versioned contracts. Handles creation and parsing of dataschema identifiers.

Index

Constructors

Methods

build create createWithWildCardVersion isValid parse

Constructors

constructor

new EventDataschemaUtil(): EventDataschemaUtil
Returns EventDataschemaUtil

Methods

`Static`build

build<TUri, TVersion>(uri, version): `${TUri}/${TVersion}`
Type Parameters
- TUri extends string
- TVersion extends `${number}.${number}.${number}`
Parameters
- uri: TUri
- version: TVersion
Returns `${TUri}/${TVersion}`
- Defined in src/utils.ts:135

`Static`create

create<T>(contract): `${T["uri"]}/${T["version"]}`
Creates a dataschema string from a versioned contract. Format: {contract.uri}/{contract.version}
Type Parameters
- T extends VersionedArvoContract<any, any>
Parameters
- contract: T
  Versioned contract instance
Returns `${T["uri"]}/${T["version"]}`
Formatted dataschema string
Example
```
const schema = EventDataschema.create(versionedContract);
// Returns: "my-contract/1.0.0"
```
- Defined in src/utils.ts:152

`Static`createWithWildCardVersion

createWithWildCardVersion<T>(contract): `${T["uri"]}/0.0.0`
Creates dataschema string with wildcard version.
Type Parameters
- T extends VersionedArvoContract<any, any>
Parameters
- contract: T
  Versioned contract
Returns `${T["uri"]}/0.0.0`
{contract.uri}/{WildCardArvoSemanticVersion}
- Defined in src/utils.ts:161

`Static`isValid

isValid(data): boolean
Validates if a given ArvoEvent or dataschema string represents a valid dataschema. A valid dataschema must:
- Follow the format {uri}/{version}
- Have a valid semantic version component
- Contain a non-empty URI
Parameters
- data: string | ArvoEvent<Record<string, any>, Record<string,
      | null
      | string
      | number
      | boolean>, string>
  ArvoEvent object or dataschema string to validate
Returns boolean
boolean - True if dataschema is valid, false otherwise
- Defined in src/utils.ts:212

`Static`parse

parse(data): null | {
uri: string;
version: `${number}.${number}.${number}`;
}
Extracts URI and version from dataschema string.
Parameters
- data: string | ArvoEvent<Record<string, any>, Record<string,
      | null
      | string
      | number
      | boolean>, string>
  Event object or dataschema string
Returns null | {
uri: string;
version: `${number}.${number}.${number}`;
}
Parsed URI and version, or null if invalid
Example
```
const result = EventDataschema.parse("my-contract/1.0.0");
// Returns: { uri: "my-contract", version: "1.0.0" }

const invalid = EventDataschema.parse("invalid-schema");
// Returns: null
```
- Defined in src/utils.ts:183