demo_schema.erl

-module(demo_schema).

-include_lib("typerefl/include/types.hrl").
-define(DESC(Module, Id), {desc, Module, Id}).
-define(DESC(Id), ?DESC(?MODULE, Id)).

-behaviour(hocon_schema).

-type duration() :: integer().
-type percent() :: float().

-typerefl_from_string({duration/0, emqx_schema, to_duration}).
-typerefl_from_string({percent/0, emqx_schema, to_percent}).

-reflect_type([duration/0, percent/0]).

-export([roots/0, fields/1, translations/0, translation/1, namespace/0]).

-define(FIELD(NAME, TYPE), hoconsc:mk(TYPE, #{mapping => NAME})).

namespace() -> "demo".
roots() -> [foo, {"a_b", hoconsc:mk(hoconsc:ref("a_b"), #{importance => hidden})}, "b", person, "vm"].
translations() -> ["app_foo"].

fields(foo) ->
    #{fields => [ {setting, fun setting/1}
                , {endpoint, fun endpoint/1}
                , {greet, fun greet/1}
                , {numbers, fun numbers/1}
                , {ref_x_y, fun ref_x_y/1}
                , {ref_j_k, fun ref_j_k/1}
                , {min, integer()}
                , {max, integer()}
                ],
      desc => "foo doc"};

fields("a_b") ->
    [ {"some_int", hoconsc:mk(integer(), #{mapping => "a_b.some_int",
                                           importance => hidden
                                          })}
    , {"some_percent", fun some_percent/1}
    ];

fields("b") ->
    [ {"u", fun (type) -> hoconsc:union(["priv.bool", "priv.int"]);
                (mapping) -> "app_foo.u";
                (_) -> undefined end}
    , {"arr", fun (type) -> hoconsc:array("priv.int");
                  (mapping) -> "app_foo.arr";
                  (_) -> undefined end}
    , {"ua", hoconsc:mk(hoconsc:array(hoconsc:union(["priv.int", "priv.bool"])),
                        #{mapping => "app_foo.ua"})}
    ];

fields("priv.bool") ->
    [ {"val", fun priv_bool/1}
    ];

fields("priv.int") ->
    [ {"val", integer()}
    ];

fields("x.y") ->
    [ {"some_int", integer()}
    , {"some_dur", fun priv_duration/1}
    ];

fields("j.k") ->
    [ {"some_int", integer()}
    ];

fields(person) ->
    [{id, ?FIELD("person.id", "id")}];

fields("id") ->
    [{id, ?FIELD("num", integer())}];

fields("vm") ->
    [ {"name", fun nodename/1}
    , {"max_ports", fun max_ports/1}
    ].

translation("app_foo") ->
    [ {"range", fun range/1} ].

setting(mapping) -> "app_foo.setting";
setting(sensitive) -> true;
setting(type) -> string();
setting(default) -> "default";
setting(_) -> undefined.

range(Conf) ->
    Min = hocon_maps:get("foo.min", Conf),
    Max = hocon_maps:get("foo.max", Conf),
    case Min < Max of
        true ->
            {Min, Max};
        _ ->
            undefined
    end.

endpoint(mapping) -> "app_foo.endpoint";
endpoint(type) -> typerefl:ip4_address();
endpoint(_) -> undefined.

greet(mapping) -> "app_foo.greet";
greet(type) -> typerefl:regexp_string("^hello$");
greet(desc) -> ?DESC("greetings");
greet(_) -> undefined.

numbers(mapping) -> "app_foo.numbers";
numbers(type) -> list(integer());
numbers(desc) -> "list of numbers";
numbers(_) -> undefined.

priv_duration(type) -> duration();
priv_duration(_) -> undefined.

some_percent(type) -> percent();
some_percent(mapping) -> "a_b.some_percent";
some_percent(_) -> undefined.

priv_bool(type) -> boolean();
priv_bool(_) -> undefined.

ref_x_y(mapping) -> undefined;
ref_x_y(type) -> "x.y";
ref_x_y(_) -> undefined.

ref_j_k(mapping) -> "app_foo.refjk";
ref_j_k(type) -> "j.k";
ref_j_k(_) -> undefined.

nodename(mapping) -> "vm_args.-name";
nodename(type) -> string();
nodename(_) -> undefined.

max_ports(mapping) -> "vm_args.-env ERL_MAX_PORTS";
max_ports(type) -> integer();
max_ports(_) -> undefined.