meta-to-blocks

meta-to-blocks

Lower Constructive _meta database metadata into blocks-schema UI documents: generated form, list, and detail screens with no hand-authored JSON. Columns lower through JSON Schema, so this shares the widget-rule pipeline with json-schema-to-blocks. Pure functions, no React.

Install

pnpm add meta-to-blocks blocks-schema

Built with makage and published from dist, so deep imports resolve without an exports map:

import { tableToFormDocument } from 'meta-to-blocks';
import { tableToSchema } from 'meta-to-blocks/schema';

Usage

import { tableToFormDocument, tableToListDocument, tableToDetailDocument } from 'meta-to-blocks';

const form = tableToFormDocument(table); // Page > Form > field nodes
const list = tableToListDocument(table); // Page > DataTable
const detail = tableToDetailDocument(table); // Page > DetailPanel > RelationList*

Create forms omit the columns the database fills in (primary keys, audit timestamps); mode: 'update' includes them and disables the primary key.

Customization

tableToFormDocument(table, {
  title: 'New post',
  mode: 'create',
  omitFields: ['search_vector'],
  fieldOrder: ['title', 'body'],
  fields: {
    body: { widget: 'MarkdownEditor', label: 'Post body' },
    author_id: { description: 'Who wrote it' }
  },
  rules: [(schema) => (schema.format === 'uuid' ? { type: 'Input' } : undefined)]
});

Custom rules run ahead of the JSON Schema defaults unless replaceDefaultRules is set.

Lowering

API

tableToFormDocument(table, options?): UIDocument
tableToListDocument(table, options?): UIDocument
tableToDetailDocument(table, options?): UIDocument
tableToNodes(table, options?): UINode[]
tableToSchema(table, options?): JSONSchema
fieldToSchema(table, field, override?): JSONSchema
typeToSchema(type): JSONSchema
selectFields(table, options?): MetaField[]
isSystemField(field): boolean
titleize(name): string

License

MIT — see the repository LICENSE.