32443/DOCUMENTATION.MD

Template Cheat Sheet

1. Global objects injected into every .erb

Variable	Type	Meaning
@schema	Hash	Full JSON project skeleton.
@entities	Array<Hash>	Shortcut for @schema['entities'].
@migrations, @seeds	Array	Raw migration / seed arrays.
@project_with_web_site	Boolean	true if the project includes a public web-site.
@component_types	Array<String>	Unique list of component types used by the web-site.

---

2. Extra objects available when the file/dir name contains ((name)), {{Name}}, etc.

Variable	Type	Meaning
@name	String	Current entity name (snake_case).
@entity	Hash	Full entity record.
@fields	Array<Hash>	Shortcut for @entity['fields'].
@all_fields	Array<Hash>	All fields from all entities; each field has field['entity_name'].

---

3. Single field structure

field = {
  '@name'     => 'firstName',
  '@name_cap' => 'FirstName',
  '@type'     => 'string',
  '@ref'      => 'users',          # present only for relations
  'title'     => 'First Name',
  'unique'    => false,
  # …plus any other keys from the schema
}

4. Placeholder macros

Macro	Replaced by
((name)) / {{name}}	users
((Name)) / {{Name}}	Users
((NAME))	USERS
{{migration-timestamp}}	Epoch ms of the migration
{{seed-timestamp}}	YYYYMMDDHHMMSS of the seed

Any path that contains one of these tokens is cloned for each entity.

---

6. Worked example

form_fields = @fields.select { |f| f['@type'] == 'relation_one' }
form_fields.each do |f|
  await ((name)).set<%= f['@name_cap'] %>(data.<%= f['@name'] %> || null, { transaction })
end

More ERB-style snippets

A. Simple sidebar route list

export const routes = [
<% @entities.each_with_index do |e, i| %>
  { path: '/<%= e['@name'] %>', label: '<%= e['@name_cap'] %>' }<%= ',' unless i == @entities.size - 1 %>
<% end %>
];

Sequelize model attributes (primitive fields only)

  attributes: {
<% @fields.select { |f| %w[string int decimal boolean date datetime enum].include?(f['@type']) }.each do |f| %>
  <%= f['@name'] %>: {
    type: DataTypes.<%= get_sequelize_field_type(f['@type']) %>,
  },
<% end %>
},

TypeScript enums for every enum field in every entity

<!-- enums.ts -->
<% @entities.each do |e| %>
    <% e['fields'].select { |f| f['@type'] == 'enum' }.each do |f| %>
    export enum <%= e['@name_cap'] %><%= f['@name_cap'] %>Enum {
        <% f['options'].each do |o| %>
          <%= o.upcase %> = '<%= o %>',
        <% end %>
    }
    <% end %>
<% end %>

Generating a REST-style URL map (all entities → list & detail)

# migration_log.md
<% @migrations.each do |m| %>
### <%= Time.at(m['time'] / 1000).utc.strftime('%Y-%m-%d %H:%M:%S') %>

<% m['changes'].each do |ch| %>
- **<%= ch['type'] %>** on **<%= ch.dig('payload','table') || ch['tables'] %>**
<% end %>

<% end %>