A2UICore.Catalog.ValidationSchema (A2UICore v0.1.1)

Builds a catalog's validation schema: the self-contained JSON Schema messages are validated against (the reference's Catalog.validation_schema).

From the catalog's resolved schemas (references into its own $defs and peers written inline, references to common types kept):

the components, functions, own $defs and theme are assembled, with anyComponent / anyFunction listing the entries, and cleaned (A2UICore.Catalog.SchemaCleaner);
each component is flattened: its allOf mixins (ComponentCommon, Checkable, local $defs mixins) are merged into one properties / required object, its own properties winning, inside the canonical envelope (id, component); local mixins nothing references any more leave $defs;
a $ref to a common type without a description takes the type's description;
the common types the schema references, transitively, are bundled into $defs from the published common_types.json (a catalog without functions gets anyFunction: {"not": {}});
the declared protocolVersion is written in its bare form, and before v1.0 every function call schema is closed.

Summary

Types

input()

What the build needs from a catalog.

Functions

build(catalog)

The validation schema of a catalog.

common_names()

The names of the common types of every supported protocol version: the references a catalog keeps when it writes its own references inline.

component_union(names)

The anyComponent union of names: {"not": {}} when there are none.

function_union(names)

The anyFunction union of names: {"not": {}} when there are none.

published_defs(version)

The published common types $defs of a protocol version, with cross-document references made local. Empty for an unsupported version.

system_names(version)

The names of the system functions a protocol version supplies to every catalog (@index from v1.0 on).

Types

input()

(since 0.1.0)

@type input() :: %{
  :catalog_id => String.t(),
  :protocol_version => String.t(),
  :instructions => String.t() | nil,
  :declared_protocol_version => String.t() | nil,
  :defs => map(),
  :components => map(),
  :functions => map(),
  :resolved => map(),
  :component_order => [String.t()],
  :function_order => [String.t()],
  optional(atom()) => term()
}

What the build needs from a catalog.

Functions

build(catalog)

(since 0.1.0)

@spec build(input()) :: map()

The validation schema of a catalog.

common_names()

(since 0.1.0)

@spec common_names() :: MapSet.t(String.t())

The names of the common types of every supported protocol version: the references a catalog keeps when it writes its own references inline.

component_union(names)

(since 0.1.0)

@spec component_union([String.t()]) :: map()

The anyComponent union of names: {"not": {}} when there are none.

function_union(names)

(since 0.1.0)

@spec function_union([String.t()]) :: map()

The anyFunction union of names: {"not": {}} when there are none.

published_defs(version)

(since 0.1.0)

@spec published_defs(String.t()) :: map()

The published common types $defs of a protocol version, with cross-document references made local. Empty for an unsupported version.

system_names(version)

(since 0.1.0)

@spec system_names(String.t()) :: [String.t()]

The names of the system functions a protocol version supplies to every catalog (@index from v1.0 on).