Skip to content

Function: parseCanonicalModel()

Makaio Framework


Makaio Framework / contracts / parseCanonicalModel

parseCanonicalModel(input): CanonicalModelParseResult

Defined in: ../../../packages/contracts/src/canonical-model/parser.ts:54

Parse a canonical model string into a structured reference.

The grammar is:

canonical := "~" virtual_model_name
| routing "::" model_name
| model_name
routing := segment
| segment "/" segment
segment := [a-z0-9][a-z0-9._-]*
model_name := <any non-empty string>
virtual_model_name := [a-z0-9][a-z0-9_-]*

Routing segments are lowercased during parsing because they are case-insensitive for matching purposes. Model names are passed through verbatim as they are provider-defined and case-sensitive.

string

The canonical model string to parse

CanonicalModelParseResult

A parsed reference or a parse error