@quickback-dev/cli 0.10.16 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/commands/compile.d.ts.map +1 -1
- package/dist/commands/compile.js +40 -2
- package/dist/commands/compile.js.map +1 -1
- package/dist/docs/content.d.ts.map +1 -1
- package/dist/docs/content.js +15 -10
- package/dist/docs/content.js.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/skill/SKILL.md +142 -1051
- package/dist/skill/agents/quickback-specialist/AGENT.md +36 -0
- package/dist/skill/docs/changelog.md +1225 -0
- package/dist/skill/docs/compiler/claude-code-skill.md +312 -0
- package/dist/skill/docs/compiler/cloud-compiler/authentication.md +63 -0
- package/dist/skill/docs/compiler/cloud-compiler/cli.md +307 -0
- package/dist/skill/docs/compiler/cloud-compiler/endpoints.md +78 -0
- package/dist/skill/docs/compiler/cloud-compiler/index.md +65 -0
- package/dist/skill/docs/compiler/cloud-compiler/local-compiler.md +115 -0
- package/dist/skill/docs/compiler/cloud-compiler/troubleshooting.md +76 -0
- package/dist/skill/docs/compiler/config/agents.md +144 -0
- package/dist/skill/docs/compiler/config/auth.md +109 -0
- package/dist/skill/docs/compiler/config/bindings.md +176 -0
- package/dist/skill/docs/compiler/config/domains.md +149 -0
- package/dist/skill/docs/compiler/config/index.md +419 -0
- package/dist/skill/docs/compiler/config/output.md +338 -0
- package/dist/skill/docs/compiler/config/providers.md +248 -0
- package/dist/skill/docs/compiler/config/security.md +255 -0
- package/dist/skill/docs/compiler/config/single-tenant.md +128 -0
- package/dist/skill/docs/compiler/config/variables.md +157 -0
- package/dist/skill/docs/compiler/definitions/access.md +445 -0
- package/dist/skill/docs/compiler/definitions/actions.md +884 -0
- package/dist/skill/docs/compiler/definitions/concepts.md +52 -0
- package/dist/skill/docs/compiler/definitions/feature.md +164 -0
- package/dist/skill/docs/compiler/definitions/firewall.md +285 -0
- package/dist/skill/docs/compiler/definitions/guards.md +241 -0
- package/dist/skill/docs/compiler/definitions/index.md +219 -0
- package/dist/skill/docs/compiler/definitions/masking.md +241 -0
- package/dist/skill/docs/compiler/definitions/read.md +220 -0
- package/dist/skill/docs/compiler/definitions/schema.md +697 -0
- package/dist/skill/docs/compiler/definitions/validation.md +35 -0
- package/dist/skill/docs/compiler/definitions/views.md +292 -0
- package/dist/skill/docs/compiler/getting-started/claude-code.md +126 -0
- package/dist/skill/docs/compiler/getting-started/full-example.md +431 -0
- package/dist/skill/docs/compiler/getting-started/hand-crafted.md +178 -0
- package/dist/skill/docs/compiler/getting-started/index.md +192 -0
- package/dist/skill/docs/compiler/getting-started/patterns.md +225 -0
- package/dist/skill/docs/compiler/getting-started/template-blog.md +280 -0
- package/dist/skill/docs/compiler/getting-started/template-cloudflare.md +260 -0
- package/dist/skill/docs/compiler/getting-started/template-empty.md +112 -0
- package/dist/skill/docs/compiler/getting-started/templates.md +111 -0
- package/dist/skill/docs/compiler/index.md +85 -0
- package/dist/skill/docs/compiler/targets/hono-api/cloudflare.md +94 -0
- package/dist/skill/docs/compiler/targets/hono-api/database/d1.md +246 -0
- package/dist/skill/docs/compiler/targets/hono-api/database/index.md +16 -0
- package/dist/skill/docs/compiler/targets/hono-api/database/neon.md +144 -0
- package/dist/skill/docs/compiler/targets/hono-api/database/using-d1.md +39 -0
- package/dist/skill/docs/compiler/targets/hono-api/index.md +37 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/actions-api.md +323 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/batch-operations.md +357 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/caching.md +105 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/crud.md +652 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/errors.md +224 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/index.md +37 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/openapi.md +203 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/query-params.md +199 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/views-api.md +161 -0
- package/dist/skill/docs/compiler/targets/index.md +47 -0
- package/dist/skill/docs/compiler/targets/supabase-rls/index.md +55 -0
- package/dist/skill/docs/compiler/targets/supabase-rls/limitations.md +48 -0
- package/dist/skill/docs/compiler/targets/supabase-rls/mappings.md +99 -0
- package/dist/skill/docs/compiler/targets/supabase-rls/setup.md +88 -0
- package/dist/skill/docs/compiler/troubleshooting.md +120 -0
- package/dist/skill/docs/index.md +77 -0
- package/dist/skill/docs/stack/account-ui/customization.md +378 -0
- package/dist/skill/docs/stack/account-ui/environment-variables.md +325 -0
- package/dist/skill/docs/stack/account-ui/features/admin.md +76 -0
- package/dist/skill/docs/stack/account-ui/features/api-keys.md +22 -0
- package/dist/skill/docs/stack/account-ui/features/avatars.md +37 -0
- package/dist/skill/docs/stack/account-ui/features/cli-authorize.md +21 -0
- package/dist/skill/docs/stack/account-ui/features/index.md +291 -0
- package/dist/skill/docs/stack/account-ui/features/organizations.md +29 -0
- package/dist/skill/docs/stack/account-ui/features/passkeys.md +31 -0
- package/dist/skill/docs/stack/account-ui/features/passwordless.md +28 -0
- package/dist/skill/docs/stack/account-ui/features/sessions.md +20 -0
- package/dist/skill/docs/stack/account-ui/hooks.md +209 -0
- package/dist/skill/docs/stack/account-ui/index.md +147 -0
- package/dist/skill/docs/stack/account-ui/library-usage.md +257 -0
- package/dist/skill/docs/stack/account-ui/standalone.md +149 -0
- package/dist/skill/docs/stack/account-ui/with-quickback.md +160 -0
- package/dist/skill/docs/stack/account-ui/worker.md +362 -0
- package/dist/skill/docs/stack/auth/api-keys.md +15 -0
- package/dist/skill/docs/stack/auth/device-auth.md +14 -0
- package/dist/skill/docs/stack/auth/index.md +64 -0
- package/dist/skill/docs/stack/auth/jwt-optimization.md +245 -0
- package/dist/skill/docs/stack/auth/plugins/aws-ses.md +127 -0
- package/dist/skill/docs/stack/auth/plugins/combo-auth.md +74 -0
- package/dist/skill/docs/stack/auth/plugins/index.md +340 -0
- package/dist/skill/docs/stack/auth/plugins/upgrade-anonymous.md +155 -0
- package/dist/skill/docs/stack/auth/security.md +455 -0
- package/dist/skill/docs/stack/auth/using-auth.md +39 -0
- package/dist/skill/docs/stack/cms/actions.md +199 -0
- package/dist/skill/docs/stack/cms/components.md +479 -0
- package/dist/skill/docs/stack/cms/connecting.md +199 -0
- package/dist/skill/docs/stack/cms/dashboard.md +39 -0
- package/dist/skill/docs/stack/cms/index.md +158 -0
- package/dist/skill/docs/stack/cms/inline-editing.md +136 -0
- package/dist/skill/docs/stack/cms/pages.md +275 -0
- package/dist/skill/docs/stack/cms/record-layouts.md +151 -0
- package/dist/skill/docs/stack/cms/schema-format.md +437 -0
- package/dist/skill/docs/stack/cms/schema-registry.md +200 -0
- package/dist/skill/docs/stack/cms/security.md +203 -0
- package/dist/skill/docs/stack/cms/table-views.md +142 -0
- package/dist/skill/docs/stack/index.md +65 -0
- package/dist/skill/docs/stack/queues/handlers.md +317 -0
- package/dist/skill/docs/stack/queues/index.md +56 -0
- package/dist/skill/docs/stack/queues/using-queues.md +192 -0
- package/dist/skill/docs/stack/realtime/durable-objects.md +488 -0
- package/dist/skill/docs/stack/realtime/index.md +73 -0
- package/dist/skill/docs/stack/realtime/partyserver-rooms.md +146 -0
- package/dist/skill/docs/stack/realtime/using-realtime.md +211 -0
- package/dist/skill/docs/stack/storage/index.md +17 -0
- package/dist/skill/docs/stack/storage/kv.md +204 -0
- package/dist/skill/docs/stack/storage/r2.md +232 -0
- package/dist/skill/docs/stack/storage/using-kv.md +70 -0
- package/dist/skill/docs/stack/storage/using-r2.md +55 -0
- package/dist/skill/docs/stack/vector/embeddings.md +554 -0
- package/dist/skill/docs/stack/vector/index.md +44 -0
- package/dist/skill/docs/stack/vector/using-embeddings.md +186 -0
- package/dist/skill/docs/stack/webhooks/inbound.md +186 -0
- package/dist/skill/docs/stack/webhooks/index.md +36 -0
- package/dist/skill/docs/stack/webhooks/outbound.md +281 -0
- package/package.json +1 -1
- package/src/skill/SKILL.md +142 -1051
- package/src/skill/agents/quickback-specialist/AGENT.md +36 -0
- package/src/skill/docs/changelog.md +1225 -0
- package/src/skill/docs/compiler/claude-code-skill.md +312 -0
- package/src/skill/docs/compiler/cloud-compiler/authentication.md +63 -0
- package/src/skill/docs/compiler/cloud-compiler/cli.md +307 -0
- package/src/skill/docs/compiler/cloud-compiler/endpoints.md +78 -0
- package/src/skill/docs/compiler/cloud-compiler/index.md +65 -0
- package/src/skill/docs/compiler/cloud-compiler/local-compiler.md +115 -0
- package/src/skill/docs/compiler/cloud-compiler/troubleshooting.md +76 -0
- package/src/skill/docs/compiler/config/agents.md +144 -0
- package/src/skill/docs/compiler/config/auth.md +109 -0
- package/src/skill/docs/compiler/config/bindings.md +176 -0
- package/src/skill/docs/compiler/config/domains.md +149 -0
- package/src/skill/docs/compiler/config/index.md +419 -0
- package/src/skill/docs/compiler/config/output.md +338 -0
- package/src/skill/docs/compiler/config/providers.md +248 -0
- package/src/skill/docs/compiler/config/security.md +255 -0
- package/src/skill/docs/compiler/config/single-tenant.md +128 -0
- package/src/skill/docs/compiler/config/variables.md +157 -0
- package/src/skill/docs/compiler/definitions/access.md +445 -0
- package/src/skill/docs/compiler/definitions/actions.md +884 -0
- package/src/skill/docs/compiler/definitions/concepts.md +52 -0
- package/src/skill/docs/compiler/definitions/feature.md +164 -0
- package/src/skill/docs/compiler/definitions/firewall.md +285 -0
- package/src/skill/docs/compiler/definitions/guards.md +241 -0
- package/src/skill/docs/compiler/definitions/index.md +219 -0
- package/src/skill/docs/compiler/definitions/masking.md +241 -0
- package/src/skill/docs/compiler/definitions/read.md +220 -0
- package/src/skill/docs/compiler/definitions/schema.md +697 -0
- package/src/skill/docs/compiler/definitions/validation.md +35 -0
- package/src/skill/docs/compiler/definitions/views.md +292 -0
- package/src/skill/docs/compiler/getting-started/claude-code.md +126 -0
- package/src/skill/docs/compiler/getting-started/full-example.md +431 -0
- package/src/skill/docs/compiler/getting-started/hand-crafted.md +178 -0
- package/src/skill/docs/compiler/getting-started/index.md +192 -0
- package/src/skill/docs/compiler/getting-started/patterns.md +225 -0
- package/src/skill/docs/compiler/getting-started/template-blog.md +280 -0
- package/src/skill/docs/compiler/getting-started/template-cloudflare.md +260 -0
- package/src/skill/docs/compiler/getting-started/template-empty.md +112 -0
- package/src/skill/docs/compiler/getting-started/templates.md +111 -0
- package/src/skill/docs/compiler/index.md +85 -0
- package/src/skill/docs/compiler/targets/hono-api/cloudflare.md +94 -0
- package/src/skill/docs/compiler/targets/hono-api/database/d1.md +246 -0
- package/src/skill/docs/compiler/targets/hono-api/database/index.md +16 -0
- package/src/skill/docs/compiler/targets/hono-api/database/neon.md +144 -0
- package/src/skill/docs/compiler/targets/hono-api/database/using-d1.md +39 -0
- package/src/skill/docs/compiler/targets/hono-api/index.md +37 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/actions-api.md +323 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/batch-operations.md +357 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/caching.md +105 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/crud.md +652 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/errors.md +224 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/index.md +37 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/openapi.md +203 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/query-params.md +199 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/views-api.md +161 -0
- package/src/skill/docs/compiler/targets/index.md +47 -0
- package/src/skill/docs/compiler/targets/supabase-rls/index.md +55 -0
- package/src/skill/docs/compiler/targets/supabase-rls/limitations.md +48 -0
- package/src/skill/docs/compiler/targets/supabase-rls/mappings.md +99 -0
- package/src/skill/docs/compiler/targets/supabase-rls/setup.md +88 -0
- package/src/skill/docs/compiler/troubleshooting.md +120 -0
- package/src/skill/docs/index.md +77 -0
- package/src/skill/docs/stack/account-ui/customization.md +378 -0
- package/src/skill/docs/stack/account-ui/environment-variables.md +325 -0
- package/src/skill/docs/stack/account-ui/features/admin.md +76 -0
- package/src/skill/docs/stack/account-ui/features/api-keys.md +22 -0
- package/src/skill/docs/stack/account-ui/features/avatars.md +37 -0
- package/src/skill/docs/stack/account-ui/features/cli-authorize.md +21 -0
- package/src/skill/docs/stack/account-ui/features/index.md +291 -0
- package/src/skill/docs/stack/account-ui/features/organizations.md +29 -0
- package/src/skill/docs/stack/account-ui/features/passkeys.md +31 -0
- package/src/skill/docs/stack/account-ui/features/passwordless.md +28 -0
- package/src/skill/docs/stack/account-ui/features/sessions.md +20 -0
- package/src/skill/docs/stack/account-ui/hooks.md +209 -0
- package/src/skill/docs/stack/account-ui/index.md +147 -0
- package/src/skill/docs/stack/account-ui/library-usage.md +257 -0
- package/src/skill/docs/stack/account-ui/standalone.md +149 -0
- package/src/skill/docs/stack/account-ui/with-quickback.md +160 -0
- package/src/skill/docs/stack/account-ui/worker.md +362 -0
- package/src/skill/docs/stack/auth/api-keys.md +15 -0
- package/src/skill/docs/stack/auth/device-auth.md +14 -0
- package/src/skill/docs/stack/auth/index.md +64 -0
- package/src/skill/docs/stack/auth/jwt-optimization.md +245 -0
- package/src/skill/docs/stack/auth/plugins/aws-ses.md +127 -0
- package/src/skill/docs/stack/auth/plugins/combo-auth.md +74 -0
- package/src/skill/docs/stack/auth/plugins/index.md +340 -0
- package/src/skill/docs/stack/auth/plugins/upgrade-anonymous.md +155 -0
- package/src/skill/docs/stack/auth/security.md +455 -0
- package/src/skill/docs/stack/auth/using-auth.md +39 -0
- package/src/skill/docs/stack/cms/actions.md +199 -0
- package/src/skill/docs/stack/cms/components.md +479 -0
- package/src/skill/docs/stack/cms/connecting.md +199 -0
- package/src/skill/docs/stack/cms/dashboard.md +39 -0
- package/src/skill/docs/stack/cms/index.md +158 -0
- package/src/skill/docs/stack/cms/inline-editing.md +136 -0
- package/src/skill/docs/stack/cms/pages.md +275 -0
- package/src/skill/docs/stack/cms/record-layouts.md +151 -0
- package/src/skill/docs/stack/cms/schema-format.md +437 -0
- package/src/skill/docs/stack/cms/schema-registry.md +200 -0
- package/src/skill/docs/stack/cms/security.md +203 -0
- package/src/skill/docs/stack/cms/table-views.md +142 -0
- package/src/skill/docs/stack/index.md +65 -0
- package/src/skill/docs/stack/queues/handlers.md +317 -0
- package/src/skill/docs/stack/queues/index.md +56 -0
- package/src/skill/docs/stack/queues/using-queues.md +192 -0
- package/src/skill/docs/stack/realtime/durable-objects.md +488 -0
- package/src/skill/docs/stack/realtime/index.md +73 -0
- package/src/skill/docs/stack/realtime/partyserver-rooms.md +146 -0
- package/src/skill/docs/stack/realtime/using-realtime.md +211 -0
- package/src/skill/docs/stack/storage/index.md +17 -0
- package/src/skill/docs/stack/storage/kv.md +204 -0
- package/src/skill/docs/stack/storage/r2.md +232 -0
- package/src/skill/docs/stack/storage/using-kv.md +70 -0
- package/src/skill/docs/stack/storage/using-r2.md +55 -0
- package/src/skill/docs/stack/vector/embeddings.md +554 -0
- package/src/skill/docs/stack/vector/index.md +44 -0
- package/src/skill/docs/stack/vector/using-embeddings.md +186 -0
- package/src/skill/docs/stack/webhooks/inbound.md +186 -0
- package/src/skill/docs/stack/webhooks/index.md +36 -0
- package/src/skill/docs/stack/webhooks/outbound.md +281 -0
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
# Record Layouts
|
|
2
|
+
|
|
3
|
+
The CMS record detail page groups fields into collapsible sections. By default, fields are auto-grouped by naming heuristics (Identity, Contact Info, Financial, etc.). With **record layouts**, you control the exact grouping.
|
|
4
|
+
|
|
5
|
+
There are two layers:
|
|
6
|
+
|
|
7
|
+
1. **Code-defined layouts** — developers configure named layouts in `defineTable()`
|
|
8
|
+
2. **User-created views** — end-users create and save custom views via the CMS UI
|
|
9
|
+
|
|
10
|
+
## Code-Defined Layouts
|
|
11
|
+
|
|
12
|
+
Add a `layouts` property to your `defineTable()` config:
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
export default defineTable(contacts, {
|
|
16
|
+
firewall: [{ field: 'organizationId', equals: 'ctx.activeOrgId' }],
|
|
17
|
+
crud: { /* ... */ },
|
|
18
|
+
layouts: {
|
|
19
|
+
default: {
|
|
20
|
+
sections: [
|
|
21
|
+
{ label: "Contact Info", columns: 2, fields: ["name", "email", "phone", "mobile"] },
|
|
22
|
+
{ label: "Address", columns: 2, fields: ["address1", "address2", "city", "state", "zip"] },
|
|
23
|
+
{ label: "Internal Notes", collapsed: true, fields: ["notes", "internalNotes"] }
|
|
24
|
+
]
|
|
25
|
+
},
|
|
26
|
+
compact: {
|
|
27
|
+
sections: [
|
|
28
|
+
{ label: "Summary", fields: ["name", "status", "email"] }
|
|
29
|
+
]
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
});
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Each layout has an ordered list of sections. Each section specifies:
|
|
36
|
+
|
|
37
|
+
| Property | Type | Default | Description |
|
|
38
|
+
|----------|------|---------|-------------|
|
|
39
|
+
| `label` | string | required | Section header text |
|
|
40
|
+
| `fields` | string[] | required | Column names to display |
|
|
41
|
+
| `columns` | `1 \| 2` | `1` | Number of columns for field layout |
|
|
42
|
+
| `collapsed` | boolean | `false` | Whether the section starts collapsed |
|
|
43
|
+
|
|
44
|
+
Fields not assigned to any section are collected into an "Other Fields" section at the bottom.
|
|
45
|
+
|
|
46
|
+
### Layout Switcher
|
|
47
|
+
|
|
48
|
+
When a table has multiple named layouts, a dropdown appears in the record detail header. Selections persist per table using `localStorage`.
|
|
49
|
+
|
|
50
|
+
If only one layout is defined, it's used automatically without showing a dropdown.
|
|
51
|
+
|
|
52
|
+
## User-Created Custom Views
|
|
53
|
+
|
|
54
|
+
End-users can create their own record layouts via the CMS UI. These are stored in the database and can be shared with other organization members.
|
|
55
|
+
|
|
56
|
+
### Creating a View
|
|
57
|
+
|
|
58
|
+
1. Open any record detail page
|
|
59
|
+
2. Click the **+ View** button in the header
|
|
60
|
+
3. In the view builder dialog:
|
|
61
|
+
- Name your view
|
|
62
|
+
- Add sections and assign fields from a dropdown
|
|
63
|
+
- Set columns (1 or 2) and collapsed state per section
|
|
64
|
+
- Optionally share with your organization
|
|
65
|
+
4. Click **Create View**
|
|
66
|
+
|
|
67
|
+
The new view appears in the layout dropdown alongside code-defined layouts.
|
|
68
|
+
|
|
69
|
+
### Editing and Deleting Views
|
|
70
|
+
|
|
71
|
+
- Click the **gear icon** next to the dropdown to edit the current custom view
|
|
72
|
+
- Click the **trash icon** to delete it (with confirmation)
|
|
73
|
+
- Code-defined layouts cannot be edited or deleted from the CMS
|
|
74
|
+
|
|
75
|
+
### Access Control
|
|
76
|
+
|
|
77
|
+
| Operation | Who Can Do It |
|
|
78
|
+
|-----------|---------------|
|
|
79
|
+
| Create a view | Any member, admin, or owner |
|
|
80
|
+
| Edit/delete own views | The creator |
|
|
81
|
+
| Edit/delete any view | Admins and owners |
|
|
82
|
+
| View shared views | All organization members |
|
|
83
|
+
|
|
84
|
+
### Setting Up the Custom View Feature
|
|
85
|
+
|
|
86
|
+
To enable user-created views, add a `customView` table to your Quickback project:
|
|
87
|
+
|
|
88
|
+
```typescript
|
|
89
|
+
// quickback/features/cms/custom-view.ts
|
|
90
|
+
import { sqliteTable, text, integer } from "drizzle-orm/sqlite-core";
|
|
91
|
+
import { defineTable } from "@quickback/compiler";
|
|
92
|
+
|
|
93
|
+
export const customView = sqliteTable("custom_view", {
|
|
94
|
+
id: text("id").primaryKey(),
|
|
95
|
+
organizationId: text("organization_id").notNull(),
|
|
96
|
+
tableName: text("table_name").notNull(),
|
|
97
|
+
name: text("name").notNull(),
|
|
98
|
+
description: text("description"),
|
|
99
|
+
layoutConfig: text("layout_config").notNull(),
|
|
100
|
+
isShared: integer("is_shared", { mode: "boolean" }).default(false),
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
export default defineTable(customView, {
|
|
104
|
+
displayColumn: "name",
|
|
105
|
+
firewall: [{ field: 'organizationId', equals: 'ctx.activeOrgId' }],
|
|
106
|
+
read: {
|
|
107
|
+
access: { roles: ["owner", "admin", "member"] },
|
|
108
|
+
},
|
|
109
|
+
crud: {
|
|
110
|
+
create: { access: { roles: ["owner", "admin", "member"] } },
|
|
111
|
+
update: {
|
|
112
|
+
access: {
|
|
113
|
+
or: [
|
|
114
|
+
{ roles: ["owner", "admin"] },
|
|
115
|
+
{ roles: ["member"], record: { createdBy: { equals: "$userId" } } }
|
|
116
|
+
]
|
|
117
|
+
}
|
|
118
|
+
},
|
|
119
|
+
delete: {
|
|
120
|
+
access: {
|
|
121
|
+
or: [
|
|
122
|
+
{ roles: ["owner", "admin"] },
|
|
123
|
+
{ roles: ["member"], record: { createdBy: { equals: "$userId" } } }
|
|
124
|
+
]
|
|
125
|
+
},
|
|
126
|
+
mode: "hard"
|
|
127
|
+
}
|
|
128
|
+
},
|
|
129
|
+
guards: {
|
|
130
|
+
createable: ["tableName", "name", "description", "layoutConfig", "isShared"],
|
|
131
|
+
updatable: ["name", "description", "layoutConfig", "isShared"]
|
|
132
|
+
}
|
|
133
|
+
});
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
Compile your project to generate the API endpoints. The CMS will automatically detect the `customView` table and enable the view builder UI.
|
|
137
|
+
|
|
138
|
+
## Fallback Behavior
|
|
139
|
+
|
|
140
|
+
| Scenario | Result |
|
|
141
|
+
|----------|--------|
|
|
142
|
+
| No `layouts` config, no custom views | Auto-grouping by naming heuristics |
|
|
143
|
+
| `layouts` config defined | Uses "default" layout or first available |
|
|
144
|
+
| Multiple layouts | Dropdown for switching, persisted per table |
|
|
145
|
+
| Custom views created | Appear in dropdown below code-defined layouts |
|
|
146
|
+
|
|
147
|
+
## Next Steps
|
|
148
|
+
|
|
149
|
+
- **[Table Views](/stack/cms/table-views)** — Column projections for list views
|
|
150
|
+
- **[Schema Format](/stack/cms/schema-format)** — Full TypeScript type reference
|
|
151
|
+
- **[Database Schema](/compiler/definitions/schema)** — defineTable() configuration reference
|
|
@@ -0,0 +1,437 @@
|
|
|
1
|
+
# Schema Format Reference
|
|
2
|
+
|
|
3
|
+
The schema registry is a JSON file with a well-defined structure. Below are the complete TypeScript type definitions used by both the compiler (to generate) and the CMS (to consume).
|
|
4
|
+
|
|
5
|
+
## SchemaRegistry
|
|
6
|
+
|
|
7
|
+
The top-level type:
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
interface SchemaRegistry {
|
|
11
|
+
generatedAt: string;
|
|
12
|
+
generatedBy: string;
|
|
13
|
+
version: string;
|
|
14
|
+
singleTenant?: boolean;
|
|
15
|
+
features: Record<string, string[]>;
|
|
16
|
+
tables: Record<string, TableMeta>;
|
|
17
|
+
tablesByFeature: Record<string, string[]>;
|
|
18
|
+
pages: Record<string, PageMeta>;
|
|
19
|
+
pagesByFeature: Record<string, string[]>;
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
| Field | Description |
|
|
24
|
+
|-------|-------------|
|
|
25
|
+
| `generatedAt` | ISO 8601 timestamp of when the registry was generated |
|
|
26
|
+
| `generatedBy` | Always `"quickback-compiler"` |
|
|
27
|
+
| `version` | Compiler version string |
|
|
28
|
+
| `singleTenant` | When `true`, project has no organization layer (single-tenant mode) |
|
|
29
|
+
| `features` | Map of feature name to array of source file names |
|
|
30
|
+
| `tables` | Map of camelCase table name to full table metadata |
|
|
31
|
+
| `tablesByFeature` | Map of feature name to array of table names in that feature |
|
|
32
|
+
| `pages` | Map of page slug to full page metadata |
|
|
33
|
+
| `pagesByFeature` | Map of feature name to array of page slugs in that feature |
|
|
34
|
+
|
|
35
|
+
## TableMeta
|
|
36
|
+
|
|
37
|
+
Full metadata for a single table:
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
interface TableMeta {
|
|
41
|
+
name: string;
|
|
42
|
+
dbName: string;
|
|
43
|
+
feature: string;
|
|
44
|
+
columns: ColumnMeta[];
|
|
45
|
+
firewall: Record<string, unknown>;
|
|
46
|
+
crud: Record<string, CrudConfig>;
|
|
47
|
+
guards: GuardsConfig;
|
|
48
|
+
masking: Record<string, MaskingRule>;
|
|
49
|
+
views: Record<string, ViewConfig>;
|
|
50
|
+
validation: Record<string, ValidationRule>;
|
|
51
|
+
actions: ActionMeta[];
|
|
52
|
+
displayColumn?: string;
|
|
53
|
+
defaultSort?: { field: string; order: 'asc' | 'desc' };
|
|
54
|
+
inputHints?: Record<string, string>;
|
|
55
|
+
layouts?: Record<string, CmsLayout>;
|
|
56
|
+
internal?: boolean;
|
|
57
|
+
}
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
| Field | Description |
|
|
61
|
+
|-------|-------------|
|
|
62
|
+
| `name` | camelCase table name (e.g., `"accountCode"`) |
|
|
63
|
+
| `dbName` | Snake_case SQL table name (e.g., `"account_code"`) |
|
|
64
|
+
| `feature` | Parent feature name (e.g., `"accounting"`) |
|
|
65
|
+
| `columns` | Ordered array of column metadata |
|
|
66
|
+
| `firewall` | Tenant isolation config (organization, owner, softDelete, exception) |
|
|
67
|
+
| `crud` | Per-operation (create, read, update, delete) access config |
|
|
68
|
+
| `guards` | Field-level create/update/immutable/protected rules |
|
|
69
|
+
| `masking` | Per-field masking rules keyed by column name |
|
|
70
|
+
| `views` | Named column projections keyed by view name |
|
|
71
|
+
| `validation` | Per-field validation rules keyed by column name |
|
|
72
|
+
| `actions` | Array of action definitions for this table |
|
|
73
|
+
| `displayColumn` | Column used as human-readable label (auto-detected or explicit) |
|
|
74
|
+
| `defaultSort` | Default sort for CMS table list view (e.g., `{ field: "createdAt", order: "desc" }`) |
|
|
75
|
+
| `inputHints` | Map of column name to preferred CMS input type (e.g., `"richtext"`, `"select"`, `"textarea"`, `"checkbox"`) |
|
|
76
|
+
| `layouts` | Named record page layouts keyed by layout name (see CmsLayout below) |
|
|
77
|
+
| `internal` | When `true`, table is hidden from CMS sidebar |
|
|
78
|
+
|
|
79
|
+
## ColumnMeta
|
|
80
|
+
|
|
81
|
+
Metadata for a single column:
|
|
82
|
+
|
|
83
|
+
```typescript
|
|
84
|
+
interface ColumnMeta {
|
|
85
|
+
name: string;
|
|
86
|
+
dbName: string;
|
|
87
|
+
type: "text" | "integer" | "real" | "blob";
|
|
88
|
+
mode?: "boolean";
|
|
89
|
+
primaryKey: boolean;
|
|
90
|
+
notNull: boolean;
|
|
91
|
+
defaultValue?: string | number | boolean;
|
|
92
|
+
fkTarget?: string;
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
| Field | Description |
|
|
97
|
+
|-------|-------------|
|
|
98
|
+
| `name` | camelCase property name |
|
|
99
|
+
| `dbName` | Snake_case SQL column name |
|
|
100
|
+
| `type` | SQLite storage type |
|
|
101
|
+
| `mode` | When `"boolean"`, an integer column represents true/false |
|
|
102
|
+
| `primaryKey` | Whether this column is the primary key |
|
|
103
|
+
| `notNull` | Whether the column has a NOT NULL constraint |
|
|
104
|
+
| `defaultValue` | Static default value (strings, numbers, or booleans) |
|
|
105
|
+
| `fkTarget` | Target table name for FK columns (e.g., `"contact"` for a `vendorId` column) |
|
|
106
|
+
|
|
107
|
+
## CRUDConfig
|
|
108
|
+
|
|
109
|
+
Per-operation access control:
|
|
110
|
+
|
|
111
|
+
```typescript
|
|
112
|
+
interface CrudConfig {
|
|
113
|
+
access?: AccessRule;
|
|
114
|
+
mode?: string;
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
interface AccessRule {
|
|
118
|
+
roles?: string[];
|
|
119
|
+
or?: Array<{
|
|
120
|
+
roles?: string[];
|
|
121
|
+
record?: Record<string, unknown>;
|
|
122
|
+
}>;
|
|
123
|
+
record?: Record<string, unknown>;
|
|
124
|
+
}
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
| Field | Description |
|
|
128
|
+
|-------|-------------|
|
|
129
|
+
| `access.roles` | Array of roles allowed for this operation |
|
|
130
|
+
| `access.or` | Alternative access conditions (any must match) |
|
|
131
|
+
| `access.record` | Record-level conditions for access |
|
|
132
|
+
| `mode` | Operation mode (e.g., `"batch"` for bulk create) |
|
|
133
|
+
|
|
134
|
+
## GuardsConfig
|
|
135
|
+
|
|
136
|
+
Field-level control for create and update operations:
|
|
137
|
+
|
|
138
|
+
```typescript
|
|
139
|
+
interface GuardsConfig {
|
|
140
|
+
createable: string[];
|
|
141
|
+
updatable: string[];
|
|
142
|
+
immutable: string[];
|
|
143
|
+
protected: Record<string, string[]>;
|
|
144
|
+
}
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
| Field | Description |
|
|
148
|
+
|-------|-------------|
|
|
149
|
+
| `createable` | Fields that can be set during record creation |
|
|
150
|
+
| `updatable` | Fields that can be modified on existing records |
|
|
151
|
+
| `immutable` | Fields that can be set on create but never changed |
|
|
152
|
+
| `protected` | Fields only modifiable via named actions (field name to action names) |
|
|
153
|
+
|
|
154
|
+
## ActionMeta
|
|
155
|
+
|
|
156
|
+
Metadata for a custom action:
|
|
157
|
+
|
|
158
|
+
```typescript
|
|
159
|
+
interface ActionMeta {
|
|
160
|
+
name: string;
|
|
161
|
+
description: string;
|
|
162
|
+
inputFields: ActionInputField[];
|
|
163
|
+
access?: {
|
|
164
|
+
roles: string[];
|
|
165
|
+
record?: Record<string, unknown>;
|
|
166
|
+
};
|
|
167
|
+
standalone?: boolean;
|
|
168
|
+
path?: string;
|
|
169
|
+
method?: string;
|
|
170
|
+
responseType?: string;
|
|
171
|
+
sideEffects?: string;
|
|
172
|
+
cms?: CmsConfig;
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
interface CmsConfig {
|
|
176
|
+
label?: string;
|
|
177
|
+
icon?: string;
|
|
178
|
+
confirm?: string | boolean;
|
|
179
|
+
destructive?: boolean;
|
|
180
|
+
category?: string;
|
|
181
|
+
hidden?: boolean;
|
|
182
|
+
successMessage?: string;
|
|
183
|
+
onSuccess?: 'refresh' | 'redirect:list' | 'close';
|
|
184
|
+
order?: number;
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
interface ActionInputField {
|
|
188
|
+
name: string;
|
|
189
|
+
type: string;
|
|
190
|
+
required: boolean;
|
|
191
|
+
default?: unknown;
|
|
192
|
+
}
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
| Field | Description |
|
|
196
|
+
|-------|-------------|
|
|
197
|
+
| `name` | Action identifier (e.g., `"approve"`, `"applyPayment"`) |
|
|
198
|
+
| `description` | Human-readable description shown in dialog |
|
|
199
|
+
| `inputFields` | Array of input field definitions |
|
|
200
|
+
| `access.roles` | Roles allowed to execute this action |
|
|
201
|
+
| `access.record` | Record conditions (e.g., `{ status: { equals: "pending" } }`) |
|
|
202
|
+
| `standalone` | When `true`, action is not tied to a specific record |
|
|
203
|
+
| `path` | Custom API path (overrides default) |
|
|
204
|
+
| `method` | HTTP method (defaults to POST) |
|
|
205
|
+
| `responseType` | `"file"` for download responses |
|
|
206
|
+
| `sideEffects` | `"sync"` for actions with synchronous side effects |
|
|
207
|
+
| `cms` | Optional CMS rendering metadata (label, icon, confirm, destructive, category, hidden, successMessage, onSuccess, order) |
|
|
208
|
+
|
|
209
|
+
### ActionInputField
|
|
210
|
+
|
|
211
|
+
| Field | Description |
|
|
212
|
+
|-------|-------------|
|
|
213
|
+
| `name` | Field identifier |
|
|
214
|
+
| `type` | Zod type string: `"string"`, `"number"`, `"boolean"`, `"array<string>"` |
|
|
215
|
+
| `required` | Whether the field must be provided |
|
|
216
|
+
| `default` | Default value pre-filled in the form |
|
|
217
|
+
|
|
218
|
+
## ViewConfig
|
|
219
|
+
|
|
220
|
+
Named column projection with access control:
|
|
221
|
+
|
|
222
|
+
```typescript
|
|
223
|
+
interface ViewConfig {
|
|
224
|
+
fields: string[];
|
|
225
|
+
access: AccessRule;
|
|
226
|
+
}
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
| Field | Description |
|
|
230
|
+
|-------|-------------|
|
|
231
|
+
| `fields` | Array of column names to include in this view |
|
|
232
|
+
| `access` | Role-based access rules (same shape as CrudConfig access) |
|
|
233
|
+
|
|
234
|
+
## CmsLayout
|
|
235
|
+
|
|
236
|
+
Named record page layout with ordered sections:
|
|
237
|
+
|
|
238
|
+
```typescript
|
|
239
|
+
interface CmsLayout {
|
|
240
|
+
sections: CmsLayoutSection[];
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
interface CmsLayoutSection {
|
|
244
|
+
label: string;
|
|
245
|
+
fields: string[];
|
|
246
|
+
columns?: 1 | 2;
|
|
247
|
+
collapsed?: boolean;
|
|
248
|
+
}
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
| Field | Description |
|
|
252
|
+
|-------|-------------|
|
|
253
|
+
| `sections` | Ordered array of field sections |
|
|
254
|
+
|
|
255
|
+
### CmsLayoutSection
|
|
256
|
+
|
|
257
|
+
| Field | Description |
|
|
258
|
+
|-------|-------------|
|
|
259
|
+
| `label` | Section header text |
|
|
260
|
+
| `fields` | Array of column names to display in this section |
|
|
261
|
+
| `columns` | `1` (default) or `2` for two-column field layout |
|
|
262
|
+
| `collapsed` | When `true`, section starts collapsed with a toggle to expand |
|
|
263
|
+
|
|
264
|
+
Fields not assigned to any section in the active layout are collected into an "Other Fields" section.
|
|
265
|
+
|
|
266
|
+
## MaskingRule
|
|
267
|
+
|
|
268
|
+
Per-field data masking:
|
|
269
|
+
|
|
270
|
+
```typescript
|
|
271
|
+
interface MaskingRule {
|
|
272
|
+
type: "email" | "phone" | "ssn" | "redact";
|
|
273
|
+
show: {
|
|
274
|
+
roles: string[];
|
|
275
|
+
or?: string;
|
|
276
|
+
};
|
|
277
|
+
}
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
| Field | Description |
|
|
281
|
+
|-------|-------------|
|
|
282
|
+
| `type` | Masking pattern to apply |
|
|
283
|
+
| `show.roles` | Roles that see the unmasked value |
|
|
284
|
+
| `show.or` | Alternative condition for showing unmasked value |
|
|
285
|
+
|
|
286
|
+
### Masking Patterns
|
|
287
|
+
|
|
288
|
+
| Type | Input | Output |
|
|
289
|
+
|------|-------|--------|
|
|
290
|
+
| `email` | `john@acme.com` | `j***@acme.com` |
|
|
291
|
+
| `phone` | `(555) 123-4567` | `***-***-4567` |
|
|
292
|
+
| `ssn` | `123-45-6789` | `***-**-6789` |
|
|
293
|
+
| `redact` | Any string | `------` |
|
|
294
|
+
|
|
295
|
+
## ValidationRule
|
|
296
|
+
|
|
297
|
+
Per-field validation constraints:
|
|
298
|
+
|
|
299
|
+
```typescript
|
|
300
|
+
interface ValidationRule {
|
|
301
|
+
minLength?: number;
|
|
302
|
+
maxLength?: number;
|
|
303
|
+
min?: number;
|
|
304
|
+
max?: number;
|
|
305
|
+
enum?: string[];
|
|
306
|
+
email?: boolean;
|
|
307
|
+
}
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
| Field | Description |
|
|
311
|
+
|-------|-------------|
|
|
312
|
+
| `minLength` | Minimum string length |
|
|
313
|
+
| `maxLength` | Maximum string length |
|
|
314
|
+
| `min` | Minimum numeric value |
|
|
315
|
+
| `max` | Maximum numeric value |
|
|
316
|
+
| `enum` | Array of allowed string values |
|
|
317
|
+
| `email` | When `true`, validates email format |
|
|
318
|
+
|
|
319
|
+
## PageMeta
|
|
320
|
+
|
|
321
|
+
Full metadata for a custom page:
|
|
322
|
+
|
|
323
|
+
```typescript
|
|
324
|
+
interface PageMeta {
|
|
325
|
+
slug: string;
|
|
326
|
+
title: string;
|
|
327
|
+
description?: string;
|
|
328
|
+
icon?: string;
|
|
329
|
+
feature: string;
|
|
330
|
+
access?: { roles: string[] };
|
|
331
|
+
dataSources: Record<string, PageDataSource>;
|
|
332
|
+
layout: PageLayout;
|
|
333
|
+
matching?: PageMatching;
|
|
334
|
+
pageActions?: Record<string, PageAction>;
|
|
335
|
+
}
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
| Field | Description |
|
|
339
|
+
|-------|-------------|
|
|
340
|
+
| `slug` | URL-safe page identifier |
|
|
341
|
+
| `title` | Display title |
|
|
342
|
+
| `description` | Human-readable description |
|
|
343
|
+
| `icon` | Icon name for sidebar |
|
|
344
|
+
| `feature` | Parent feature name |
|
|
345
|
+
| `access` | Role-based access control |
|
|
346
|
+
| `dataSources` | Named data source bindings |
|
|
347
|
+
| `layout` | Layout configuration |
|
|
348
|
+
| `matching` | Matching/reconciliation rules |
|
|
349
|
+
| `pageActions` | Actions triggered from the page |
|
|
350
|
+
|
|
351
|
+
### PageDataSource
|
|
352
|
+
|
|
353
|
+
```typescript
|
|
354
|
+
interface PageDataSource {
|
|
355
|
+
table: string;
|
|
356
|
+
defaultFilters?: Record<string, unknown>;
|
|
357
|
+
defaultSort?: { field: string; order: 'asc' | 'desc' };
|
|
358
|
+
displayColumns?: string[];
|
|
359
|
+
}
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
### PageLayout
|
|
363
|
+
|
|
364
|
+
```typescript
|
|
365
|
+
interface PageLayout {
|
|
366
|
+
type: 'split-panel';
|
|
367
|
+
panels: PagePanel[];
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
interface PagePanel {
|
|
371
|
+
id: string;
|
|
372
|
+
title: string;
|
|
373
|
+
dataSource: string;
|
|
374
|
+
position: 'left' | 'right';
|
|
375
|
+
features?: string[];
|
|
376
|
+
}
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
Panel `features` can include `"drag-source"` and `"drop-target"` for drag-and-drop interactions.
|
|
380
|
+
|
|
381
|
+
### PageMatching
|
|
382
|
+
|
|
383
|
+
```typescript
|
|
384
|
+
interface PageMatching {
|
|
385
|
+
enabled: boolean;
|
|
386
|
+
rules: MatchingRule[];
|
|
387
|
+
confidenceThreshold?: number;
|
|
388
|
+
}
|
|
389
|
+
|
|
390
|
+
interface MatchingRule {
|
|
391
|
+
name: string;
|
|
392
|
+
weight: number;
|
|
393
|
+
condition: {
|
|
394
|
+
left: string;
|
|
395
|
+
right: string;
|
|
396
|
+
operator: 'abs-equals' | 'within-days' | 'fuzzy-match';
|
|
397
|
+
value?: number;
|
|
398
|
+
};
|
|
399
|
+
}
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
| Field | Description |
|
|
403
|
+
|-------|-------------|
|
|
404
|
+
| `enabled` | Whether matching is active |
|
|
405
|
+
| `rules` | Array of matching rules with weights (0-1) |
|
|
406
|
+
| `confidenceThreshold` | Minimum score to display a match suggestion (0-1, default 0.5) |
|
|
407
|
+
| `condition.left` | Left field reference (`dataSourceName.fieldName`) |
|
|
408
|
+
| `condition.right` | Right field reference |
|
|
409
|
+
| `condition.operator` | Comparison operator |
|
|
410
|
+
| `condition.value` | Operator parameter (e.g., max days for `within-days`) |
|
|
411
|
+
|
|
412
|
+
### PageAction
|
|
413
|
+
|
|
414
|
+
```typescript
|
|
415
|
+
interface PageAction {
|
|
416
|
+
table: string;
|
|
417
|
+
action: string;
|
|
418
|
+
inputMapping: Record<string, string>;
|
|
419
|
+
label?: string;
|
|
420
|
+
icon?: string;
|
|
421
|
+
confirm?: string;
|
|
422
|
+
}
|
|
423
|
+
```
|
|
424
|
+
|
|
425
|
+
| Field | Description |
|
|
426
|
+
|-------|-------------|
|
|
427
|
+
| `table` | Target table for the action |
|
|
428
|
+
| `action` | Action name on that table |
|
|
429
|
+
| `inputMapping` | Maps action input fields to data source field references (`"dataSourceName.$fieldName"`) |
|
|
430
|
+
| `label` | Button label (defaults to action name) |
|
|
431
|
+
| `icon` | Button icon name |
|
|
432
|
+
| `confirm` | Confirmation prompt shown before execution |
|
|
433
|
+
|
|
434
|
+
## Next Steps
|
|
435
|
+
|
|
436
|
+
- **[Schema Registry](/stack/cms/schema-registry)** — How the registry is generated and used
|
|
437
|
+
- **[Components Reference](/stack/cms/components)** — All CMS React components
|