hyperbuilder

DSL-style builder tool for defining hyperschema, hyperdb and hyperdispatch specs. Favors terseness over flexibility.

npm install hyperbuilder --save-dev

const { schema, collection, dispatch } = require("hyperbuilder")("./spec");

// define a standalone schema
schema("@hello/full-name", (s) => {
  s.string("first-name");
  s.string("last-name");
});

// create a collection with inline schema
collection("@hello/users", (c) => {
  c.key("id")
  c.uint("id");
  c.uint("age");
  c.struct("name", "@hello/full-name"); // struct with schema reference
  c.struct("address", (s) => { // struct with nested inline schema (@hello/users/address)
    s.string("city");
    s.string("country");
  });
});

// dispatch with schema reference
dispatch("@hello/change-name", "@hello/full-name");

// dispatch with inline schema
dispatch("@hello/change-address", (d) => {
  d.string("city");
  d.string("country");
});

Conventions & patterns

• Define your schemas, collections and dispatch fully namespaced. The builder will create the namespace automatically.
• You can define the schema for a collection inline. The builder will create the schema using the same name.
• Structs: s.struct(name, "@ns/other") references an existing schema FQN; s.struct(name, (sub) => { ... }) creates a nested inline schema.
• Schemas are not compact by default. Use schema.compact(true) otherwise.