Resolves $extends inheritance in a config map.

Examples

iex> config = %{"colors" => %{
...>   "base" => %{"$value" => "#f00"},
...>   "extended" => %{"$extends" => "colors.base"}
...> }}
iex> resolved = Jetons.DTCG.apply_extends(config)
iex> resolved["colors"]["extended"]["$value"]
"#f00"

Extracts $deprecated values from a raw config map.

Returns a map of %{path => true | String.t()} for all tokens that are deprecated. $deprecated is inherited from parent groups — a child can override with false to opt out.

Examples

iex> Jetons.DTCG.deprecated(%{"colors" => %{"old" => %{"$value" => "#f00", "$deprecated" => true}}})
%{"colors.old" => true}

iex> Jetons.DTCG.deprecated(%{"colors" => %{"old" => %{"$value" => "#f00", "$deprecated" => "Use new instead"}}})
%{"colors.old" => "Use new instead"}

Extracts $description values from a raw config map.

Returns a map of %{path => description} for all tokens that have a $description key. Unlike $type, descriptions are NOT inherited by children.

Examples

iex> Jetons.DTCG.descriptions(%{"colors" => %{"red" => %{"$value" => "#f00", "$description" => "Red color"}}})
%{"colors.red" => "Red color"}

iex> Jetons.DTCG.descriptions(%{"colors" => %{"red" => %{"$value" => "#f00"}}})
%{}

Flattens a nested token map into {path, value} tuples.

Examples

iex> Jetons.DTCG.flatten(%{"red" => %{"$value" => "#f00"}, "blue" => %{"$value" => "#00f"}}, "colors") |> Enum.sort()
[{"colors.blue", "#00f"}, {"colors.red", "#f00"}]

Extracts a map of {path => type} from a config, inheriting $type from parents.

Examples

iex> Jetons.DTCG.type_map(%{"colors" => %{"$type" => "color", "red" => %{"$value" => "#f00"}}})
%{"colors.red" => "color"}