@stonecrop/schema 0.13.14 → 0.14.0

package/README.md

@@ -10,7 +10,7 @@ Schema definitions and validation for Stonecrop doctypes, fields, and workflows.
 - **Doctype definitions** (`DoctypeMeta`) - Complete document type schemas
 - **Workflows** (`WorkflowMeta`) - State machines and action definitions
 - **Validation** - Runtime schema validation with detailed error reporting
-- **DDL Conversion** - PostgreSQL DDL to Stonecrop schema transformation
+- **GraphQL Conversion** - GraphQL schema (SDL, introspection, or live endpoint) to Stonecrop doctype generation
 
 This package is schema-only and has no UI dependencies - it can be used in both frontend and backend contexts.
 
@@ -26,36 +26,40 @@ pnpm add @stonecrop/schema
 
 ## Core Concepts
 
-### Field Types
+### Fields and Components
 
-Stonecrop uses semantic field types that remain consistent whether rendered in a form or table:
+Every field declares a `component` — the Vue widget that renders it. `component` is the primary axis: it decides how the field looks and, for links, how it behaves. `componentCategory()` maps a component to a semantic category that drives table formatting, filtering, and record-initialization defaults; `CANONICAL_COMPONENTS` is the set the framework ships:
 
 ```typescript
-import { StonecropFieldType } from '@stonecrop/schema'
-
-// Field types include:
-// Text: Data, Text
-// Numeric: Int, Float, Decimal, Currency, Quantity
-// Boolean: Check
-// Date/Time: Date, Time, Datetime, Duration, DateRange
-// Structured: JSON, Code
-// Relational: Link, Doctype
-// Files: Attach
-// Selection: Select
+import { CANONICAL_COMPONENTS, componentCategory } from '@stonecrop/schema'
+
+// Components by value category (componentCategory):
+// text:     ATextInput, ATextarea, ADuration
+// number:   ANumericInput
+// boolean:  ACheckbox
+// date:     ADate, ADatePicker, ADateSelection, ADateRange
+// datetime: ADateTime
+// code:     ACodeEditor        (pair with `language: 'json' | 'javascript' | …`)
+// select:   ADropdown
+// link:     AFormLink          (inline picker)
+// attach:   AFileAttach
+// Link containers (no value category): AForm (1:1 expand), ATable (1:many expand)
+
+componentCategory('ANumericInput') // 'number'
 ```
 
 ### Field Definitions
 
 `DoctypeField` is a discriminated union of three structural variants:
 
-- **`ValueField`** — a scalar or link field; has `fieldtype`
+- **`ValueField`** — a scalar or link field; has `component`
 - **`FieldsetField`** — a layout container grouping other fields; has `schema: DoctypeField[]`
 - **`TableField`** — an inline table with column definitions; has `columns: ColumnSchema[]`
 
 **In authored JSON** (doctype files), `kind` is inferred from structure automatically — you only write the properties that define what the field is:
 
 ```json
-{ "fieldname": "customer_name", "fieldtype": "Data", "label": "Customer Name", "required": true }
+{ "fieldname": "customer_name", "component": "ATextInput", "label": "Customer Name", "required": true }
 { "fieldname": "details", "label": "Details", "schema": [...] }
 { "fieldname": "line_items", "label": "Line Items", "columns": [...] }
 ```
@@ -68,7 +72,7 @@ import type { ValueField, FieldsetField, DoctypeField } from '@stonecrop/schema'
 const field: ValueField = {
   kind: 'field',
   fieldname: 'customer_name',
-  fieldtype: 'Data',
+  component: 'ATextInput',
   label: 'Customer Name',
   required: true,
   readOnly: false,
@@ -80,15 +84,15 @@ const field: ValueField = {
 const linkField: ValueField = {
   kind: 'field',
   fieldname: 'customer',
-  fieldtype: 'Link',
+  component: 'AFormLink',
   label: 'Customer',
-  options: 'customer', // Target doctype slug
+  doctype: 'customer', // Target doctype slug
 }
 
 const selectField: ValueField = {
   kind: 'field',
   fieldname: 'status',
-  fieldtype: 'Select',
+  component: 'ADropdown',
   label: 'Status',
   options: ['Draft', 'Submitted', 'Cancelled'], // Choices array
 }
@@ -96,7 +100,7 @@ const selectField: ValueField = {
 const decimalField: ValueField = {
   kind: 'field',
   fieldname: 'price',
-  fieldtype: 'Decimal',
+  component: 'ANumericInput',
   label: 'Price',
   options: { precision: 10, scale: 2 }, // Config object
 }
@@ -116,17 +120,17 @@ const doctype: DoctypeMeta = {
     {
       kind: 'field',
       fieldname: 'customer',
-      fieldtype: 'Link',
+      component: 'AFormLink',
       label: 'Customer',
-      options: 'customer',
+      doctype: 'customer',
       required: true,
     },
     {
       kind: 'field',
       fieldname: 'items',
-      fieldtype: 'Link',
+      component: 'ATable',
       label: 'Items',
-      options: 'sales-order-item',
+      doctype: 'sales-order-item',
     },
   ],
   links: {
@@ -142,7 +146,7 @@ const doctype: DoctypeMeta = {
     actions: {
       submit: {
         label: 'Submit',
-        handler: 'submitOrder',
+        nextState: 'Submitted',
         requiredFields: ['customer', 'items'],
         allowedStates: ['Draft'],
       },
@@ -192,16 +196,14 @@ const workflow: WorkflowMeta = {
   actions: {
     submit: {
       label: 'Submit for Approval',
-      handler: 'handleSubmit',
+      nextState: 'Pending Approval',
       requiredFields: ['title', 'description'],
       allowedStates: ['Draft'],
-      confirm: true,
     },
     approve: {
       label: 'Approve',
-      handler: 'handleApprove',
+      nextState: 'Approved',
       allowedStates: ['Pending Approval'],
-      args: { notifyUser: true },
     },
   },
 }
@@ -247,7 +249,7 @@ import { validateField, validateDoctype } from '@stonecrop/schema'
 // Validate a field definition
 const fieldResult = validateField({
   fieldname: 'email',
-  fieldtype: 'Data',
+  component: 'ATextInput',
   label: 'Email',
 })
 
@@ -343,8 +345,8 @@ a JSON mapping file:
 
 ```json
 {
-  "BigFloat": { "component": "ADecimalInput", "fieldtype": "Decimal" },
-  "Datetime": { "component": "ADatetimeInput", "fieldtype": "Datetime" }
+  "BigFloat": { "component": "ANumericInput" },
+  "Datetime": { "component": "ADateTime" }
 }
 ```
 
@@ -360,7 +362,7 @@ Override the generated field definition for specific types and fields:
 ```json
 {
   "SalesOrder": {
-    "totalAmount": { "fieldtype": "Currency", "component": "ACurrencyInput" }
+    "totalAmount": { "component": "ANumericInput" }
   }
 }
 ```
@@ -370,49 +372,7 @@ stonecrop-schema generate -e http://localhost:3000/graphql -o ./app/doctypes \
   --overrides overrides.json
 ```
 
-## DDL Conversion
-
-Convert PostgreSQL DDL statements to Stonecrop doctype schemas:
-
-```typescript
-import { convertSchema, type ConversionOptions } from '@stonecrop/schema'
-
-const ddl = `
-CREATE TABLE customers (
-  id SERIAL PRIMARY KEY,
-  name VARCHAR(255) NOT NULL,
-  email VARCHAR(255) UNIQUE,
-  created_at TIMESTAMP DEFAULT NOW()
-);
-
-CREATE TABLE sales_orders (
-  id SERIAL PRIMARY KEY,
-  customer_id INTEGER REFERENCES customers(id),
-  status VARCHAR(20) DEFAULT 'Draft',
-  total_amount DECIMAL(10, 2)
-);
-`
-
-const options: ConversionOptions = {
-  inheritanceMode: 'flatten', // or 'reference'
-  useCamelCase: true, // Convert snake_case to camelCase
-  includeUnmappedMeta: false, // Include unmapped metadata
-  schema: 'public', // Filter by schema
-  exclude: ['migrations'], // Exclude tables
-  typeOverrides: {
-    status: { fieldtype: 'Select', options: ['Draft', 'Submitted'] },
-  },
-}
-
-const doctypes = convertSchema(ddl, options)
-
-doctypes.forEach(doctype => {
-  console.log(`Doctype: ${doctype.name}`)
-  console.log(`Fields: ${doctype.fields.length}`)
-})
-```
-
-### Naming Utilities
+## Naming Utilities
 
 Convert between different naming conventions:
 
@@ -427,20 +387,6 @@ toPascalCase('customer_name') // 'CustomerName'
 toSlug('Customer Name') // 'customer-name'
 ```
 
-## API
-
-### Field Type Mapping
-
-```typescript
-import { TYPE_MAP, getDefaultComponent } from '@stonecrop/schema'
-
-// Get default component for a field type
-const component = getDefaultComponent('Data') // 'ATextInput'
-
-// Access full type map
-console.log(TYPE_MAP['Link']) // { component: 'ALink', fieldtype: 'Link' }
-```
-
 ## Usage in Stonecrop
 
 This package provides the type system used throughout Stonecrop:
@@ -481,7 +427,7 @@ import type { ValueField, DoctypeField, DoctypeMeta } from '@stonecrop/schema'
 const field: ValueField = {
   kind: 'field',
   fieldname: 'title',
-  fieldtype: 'Data',
+  component: 'ATextInput',
   // TypeScript will catch typos and missing required fields
 }
 

package/dist/cli.js

@@ -3,7 +3,7 @@ import { readFileSync as u, existsSync as S, mkdirSync as w, writeFileSync as x
 import { resolve as c, join as O } from "node:path";
 import { parseArgs as $ } from "node:util";
 import { getIntrospectionQuery as N } from "graphql";
-import { g as P, v as j } from "./index-D66L9JNw.js";
+import { i as P, v as j } from "./index-rozX0Luh.js";
 async function C(e, m) {
   const t = await fetch(e, {
     method: "POST",
@@ -69,15 +69,15 @@ async function E() {
     const s = `${o.slug}.json`, d = O(r, s), v = JSON.stringify(o, null, "	");
     x(d, v + `
 `, "utf-8");
-    const y = j(o);
-    if (y.success) {
-      const n = o.fields.filter((g) => g._unmapped);
+    const g = j(o);
+    if (g.success) {
+      const n = o.fields.filter((y) => y._unmapped);
       n.length > 0 && (h++, console.warn(
-        `  WARN: ${s} has ${n.length} unmapped field(s): ${n.map((g) => g.fieldname).join(", ")}`
+        `  WARN: ${s} has ${n.length} unmapped field(s): ${n.map((y) => y.fieldname).join(", ")}`
       ));
     } else {
       p++, console.error(`  ERROR: ${s} failed validation:`);
-      for (const n of y.errors)
+      for (const n of g.errors)
         console.error(`    ${n.path.join(".")}: ${n.message}`);
     }
   }