@quickback-dev/cli 0.10.16 → 0.10.20
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.js +6 -6
- package/dist/docs/content.js.map +1 -1
- package/dist/index.js +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 +1192 -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 +228 -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 +67 -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 +1192 -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 +228 -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 +67 -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,275 @@
|
|
|
1
|
+
# Custom Pages
|
|
2
|
+
|
|
3
|
+
Custom pages extend the CMS beyond standard table views. Define split-panel layouts, matching rules for record reconciliation, drag-and-drop interactions, and page-level actions — all from a single `definePage()` call.
|
|
4
|
+
|
|
5
|
+
## Defining a Page
|
|
6
|
+
|
|
7
|
+
Pages are defined in your feature directory under a `pages/` folder:
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
quickback/definitions/features/
|
|
11
|
+
banking/
|
|
12
|
+
bank-accounts.ts # One table per file — any filename
|
|
13
|
+
bank-transactions.ts
|
|
14
|
+
actions.ts
|
|
15
|
+
pages/
|
|
16
|
+
bank-reconciliation.ts
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Each page file exports a `definePage()` call:
|
|
20
|
+
|
|
21
|
+
```typescript title="features/banking/pages/bank-reconciliation.ts"
|
|
22
|
+
import { definePage } from '@quickback/compiler';
|
|
23
|
+
|
|
24
|
+
export default definePage({
|
|
25
|
+
slug: 'bank-reconciliation',
|
|
26
|
+
title: 'Bank Reconciliation',
|
|
27
|
+
description: 'Match bank transactions to ledger entries',
|
|
28
|
+
icon: 'landmark',
|
|
29
|
+
feature: 'banking',
|
|
30
|
+
|
|
31
|
+
access: { roles: ['owner', 'admin'] },
|
|
32
|
+
|
|
33
|
+
dataSources: {
|
|
34
|
+
bankTransactions: {
|
|
35
|
+
table: 'bankTransaction',
|
|
36
|
+
defaultSort: { field: 'date', order: 'desc' },
|
|
37
|
+
displayColumns: ['date', 'description', 'amount'],
|
|
38
|
+
},
|
|
39
|
+
ledgerEntries: {
|
|
40
|
+
table: 'ledgerEntry',
|
|
41
|
+
defaultSort: { field: 'date', order: 'desc' },
|
|
42
|
+
displayColumns: ['date', 'memo', 'amount'],
|
|
43
|
+
},
|
|
44
|
+
},
|
|
45
|
+
|
|
46
|
+
layout: {
|
|
47
|
+
type: 'split-panel',
|
|
48
|
+
panels: [
|
|
49
|
+
{
|
|
50
|
+
id: 'bank',
|
|
51
|
+
title: 'Bank Transactions',
|
|
52
|
+
dataSource: 'bankTransactions',
|
|
53
|
+
position: 'left',
|
|
54
|
+
features: ['drag-source'],
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
id: 'ledger',
|
|
58
|
+
title: 'Ledger Entries',
|
|
59
|
+
dataSource: 'ledgerEntries',
|
|
60
|
+
position: 'right',
|
|
61
|
+
features: ['drop-target'],
|
|
62
|
+
},
|
|
63
|
+
],
|
|
64
|
+
},
|
|
65
|
+
|
|
66
|
+
matching: {
|
|
67
|
+
enabled: true,
|
|
68
|
+
confidenceThreshold: 0.5,
|
|
69
|
+
rules: [
|
|
70
|
+
{
|
|
71
|
+
name: 'Amount Match',
|
|
72
|
+
weight: 0.5,
|
|
73
|
+
condition: {
|
|
74
|
+
left: 'bankTransactions.amount',
|
|
75
|
+
right: 'ledgerEntries.amount',
|
|
76
|
+
operator: 'abs-equals',
|
|
77
|
+
},
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
name: 'Date Proximity',
|
|
81
|
+
weight: 0.3,
|
|
82
|
+
condition: {
|
|
83
|
+
left: 'bankTransactions.date',
|
|
84
|
+
right: 'ledgerEntries.date',
|
|
85
|
+
operator: 'within-days',
|
|
86
|
+
value: 7,
|
|
87
|
+
},
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
name: 'Description Match',
|
|
91
|
+
weight: 0.2,
|
|
92
|
+
condition: {
|
|
93
|
+
left: 'bankTransactions.description',
|
|
94
|
+
right: 'ledgerEntries.memo',
|
|
95
|
+
operator: 'fuzzy-match',
|
|
96
|
+
},
|
|
97
|
+
},
|
|
98
|
+
],
|
|
99
|
+
},
|
|
100
|
+
|
|
101
|
+
pageActions: {
|
|
102
|
+
reconcile: {
|
|
103
|
+
table: 'bankTransaction',
|
|
104
|
+
action: 'reconcile',
|
|
105
|
+
label: 'Reconcile',
|
|
106
|
+
icon: 'check-circle',
|
|
107
|
+
confirm: 'Match this bank transaction to the selected ledger entry?',
|
|
108
|
+
inputMapping: {
|
|
109
|
+
transactionId: 'bankTransactions.$id',
|
|
110
|
+
ledgerEntryId: 'ledgerEntries.$id',
|
|
111
|
+
amount: 'bankTransactions.$amount',
|
|
112
|
+
},
|
|
113
|
+
},
|
|
114
|
+
},
|
|
115
|
+
});
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Data Sources
|
|
119
|
+
|
|
120
|
+
Each page declares one or more named data sources that bind to tables in your schema:
|
|
121
|
+
|
|
122
|
+
```typescript
|
|
123
|
+
dataSources: {
|
|
124
|
+
bankTransactions: {
|
|
125
|
+
table: 'bankTransaction', // Table name from your schema
|
|
126
|
+
defaultFilters: { status: 'pending' }, // Applied on load
|
|
127
|
+
defaultSort: { field: 'date', order: 'desc' },
|
|
128
|
+
displayColumns: ['date', 'description', 'amount'],
|
|
129
|
+
},
|
|
130
|
+
}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
| Field | Type | Description |
|
|
134
|
+
|-------|------|-------------|
|
|
135
|
+
| `table` | `string` | Table name to query (required) |
|
|
136
|
+
| `defaultFilters` | `Record<string, unknown>` | Filters applied on initial load |
|
|
137
|
+
| `defaultSort` | `{ field, order }` | Default sort column and direction |
|
|
138
|
+
| `displayColumns` | `string[]` | Columns shown in the panel (defaults to `["id"]`) |
|
|
139
|
+
|
|
140
|
+
## Layout
|
|
141
|
+
|
|
142
|
+
Pages use a layout configuration to arrange panels. Currently the only layout type is `split-panel`:
|
|
143
|
+
|
|
144
|
+
```typescript
|
|
145
|
+
layout: {
|
|
146
|
+
type: 'split-panel',
|
|
147
|
+
panels: [
|
|
148
|
+
{ id: 'bank', title: 'Bank Txs', dataSource: 'bankTransactions', position: 'left', features: ['drag-source'] },
|
|
149
|
+
{ id: 'ledger', title: 'Ledger', dataSource: 'ledgerEntries', position: 'right', features: ['drop-target'] },
|
|
150
|
+
],
|
|
151
|
+
}
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### Panel Features
|
|
155
|
+
|
|
156
|
+
Panels can enable interactive features:
|
|
157
|
+
|
|
158
|
+
| Feature | Description |
|
|
159
|
+
|---------|-------------|
|
|
160
|
+
| `drag-source` | Rows in this panel can be dragged |
|
|
161
|
+
| `drop-target` | Rows in this panel accept drops |
|
|
162
|
+
|
|
163
|
+
When a row is dragged from one panel and dropped onto a row in the other panel, the first page action is triggered with both records as context.
|
|
164
|
+
|
|
165
|
+
## Matching Engine
|
|
166
|
+
|
|
167
|
+
The matching engine compares records across two panels and computes confidence scores for potential matches. Matched rows display a colored confidence badge.
|
|
168
|
+
|
|
169
|
+
### Rules
|
|
170
|
+
|
|
171
|
+
Each rule defines a comparison between fields from two data sources:
|
|
172
|
+
|
|
173
|
+
```typescript
|
|
174
|
+
matching: {
|
|
175
|
+
enabled: true,
|
|
176
|
+
confidenceThreshold: 0.5, // Minimum score to show (0-1)
|
|
177
|
+
rules: [
|
|
178
|
+
{
|
|
179
|
+
name: 'Amount Match',
|
|
180
|
+
weight: 0.5, // Weight in final score (0-1)
|
|
181
|
+
condition: {
|
|
182
|
+
left: 'bankTransactions.amount', // dataSourceName.fieldName
|
|
183
|
+
right: 'ledgerEntries.amount',
|
|
184
|
+
operator: 'abs-equals',
|
|
185
|
+
},
|
|
186
|
+
},
|
|
187
|
+
],
|
|
188
|
+
}
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### Operators
|
|
192
|
+
|
|
193
|
+
| Operator | Description | Returns |
|
|
194
|
+
|----------|-------------|---------|
|
|
195
|
+
| `abs-equals` | Absolute values are equal | `1.0` if match, `0` otherwise |
|
|
196
|
+
| `within-days` | Dates are within N days | `1 - (daysDiff / maxDays)`, clamped to 0 |
|
|
197
|
+
| `fuzzy-match` | Word overlap between strings | Overlap ratio (0-1) |
|
|
198
|
+
|
|
199
|
+
The `within-days` operator uses the `value` parameter to set the maximum number of days (defaults to 7).
|
|
200
|
+
|
|
201
|
+
### Confidence Scoring
|
|
202
|
+
|
|
203
|
+
The final confidence score is the weighted average of all rule scores:
|
|
204
|
+
|
|
205
|
+
```
|
|
206
|
+
score = sum(ruleScore * ruleWeight) / sum(ruleWeights)
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
Only matches above `confidenceThreshold` are shown. Confidence badges are color-coded:
|
|
210
|
+
|
|
211
|
+
| Score | Color |
|
|
212
|
+
|-------|-------|
|
|
213
|
+
| 80%+ | Green |
|
|
214
|
+
| 50-79% | Yellow |
|
|
215
|
+
| Below 50% | Orange |
|
|
216
|
+
|
|
217
|
+
## Page Actions
|
|
218
|
+
|
|
219
|
+
Page actions trigger table actions using data from both the source (dragged) and target (dropped-on) records:
|
|
220
|
+
|
|
221
|
+
```typescript
|
|
222
|
+
pageActions: {
|
|
223
|
+
reconcile: {
|
|
224
|
+
table: 'bankTransaction', // Target table for the action
|
|
225
|
+
action: 'reconcile', // Action name on that table
|
|
226
|
+
label: 'Reconcile',
|
|
227
|
+
icon: 'check-circle',
|
|
228
|
+
confirm: 'Match this transaction?',
|
|
229
|
+
inputMapping: {
|
|
230
|
+
transactionId: 'bankTransactions.$id',
|
|
231
|
+
ledgerEntryId: 'ledgerEntries.$id',
|
|
232
|
+
amount: 'bankTransactions.$amount',
|
|
233
|
+
},
|
|
234
|
+
},
|
|
235
|
+
}
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
### Input Mapping
|
|
239
|
+
|
|
240
|
+
Input mapping resolves field references from the source and target records into the action's input fields. The format is `"dataSourceName.$fieldName"`:
|
|
241
|
+
|
|
242
|
+
- `bankTransactions.$id` — resolves to the `id` field of the dragged record from the `bankTransactions` data source
|
|
243
|
+
- `ledgerEntries.$amount` — resolves to the `amount` field of the drop-target record from the `ledgerEntries` data source
|
|
244
|
+
|
|
245
|
+
The `$` prefix denotes a field reference on the record. The data source name determines which record (source or target) to read from.
|
|
246
|
+
|
|
247
|
+
## Access Control
|
|
248
|
+
|
|
249
|
+
Restrict page access by role:
|
|
250
|
+
|
|
251
|
+
```typescript
|
|
252
|
+
access: { roles: ['owner', 'admin'] }
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
When set, only users with the specified roles can view the page. The page link is hidden from the sidebar for unauthorized users.
|
|
256
|
+
|
|
257
|
+
## Sidebar Navigation
|
|
258
|
+
|
|
259
|
+
Custom pages appear in the CMS sidebar under their feature group. Each page is listed alongside the feature's tables, making them easily discoverable.
|
|
260
|
+
|
|
261
|
+
## Validation
|
|
262
|
+
|
|
263
|
+
The compiler validates page definitions at compile time:
|
|
264
|
+
|
|
265
|
+
- `slug` must start with a lowercase letter and contain only lowercase letters, digits, and hyphens
|
|
266
|
+
- At least one data source is required
|
|
267
|
+
- Every panel's `dataSource` must reference a declared data source
|
|
268
|
+
- Matching rule weights must be between 0 and 1
|
|
269
|
+
- `confidenceThreshold` must be between 0 and 1
|
|
270
|
+
|
|
271
|
+
## Next Steps
|
|
272
|
+
|
|
273
|
+
- **[Dashboard](/stack/cms/dashboard)** — The CMS home page with schema stats
|
|
274
|
+
- **[Components Reference](/stack/cms/components)** — Page-related component details
|
|
275
|
+
- **[Schema Format Reference](/stack/cms/schema-format)** — PageMeta type definition
|
|
@@ -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
|