@quickback-dev/cli 0.16.5 → 0.18.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.
Files changed (127) hide show
  1. package/README.md +7 -3
  2. package/dist/commands/compile.d.ts.map +1 -1
  3. package/dist/commands/compile.js +12 -48
  4. package/dist/commands/compile.js.map +1 -1
  5. package/dist/commands/create.d.ts +20 -0
  6. package/dist/commands/create.d.ts.map +1 -1
  7. package/dist/commands/create.js +216 -151
  8. package/dist/commands/create.js.map +1 -1
  9. package/dist/commands/login.d.ts +4 -2
  10. package/dist/commands/login.d.ts.map +1 -1
  11. package/dist/commands/login.js +25 -17
  12. package/dist/commands/login.js.map +1 -1
  13. package/dist/commands/start.d.ts +20 -0
  14. package/dist/commands/start.d.ts.map +1 -0
  15. package/dist/commands/start.js +163 -0
  16. package/dist/commands/start.js.map +1 -0
  17. package/dist/commands/whoami.d.ts.map +1 -1
  18. package/dist/commands/whoami.js +5 -4
  19. package/dist/commands/whoami.js.map +1 -1
  20. package/dist/docs/content.js +42 -42
  21. package/dist/docs/content.js.map +1 -1
  22. package/dist/index.js +27 -10
  23. package/dist/index.js.map +1 -1
  24. package/dist/lib/api-client.js +1 -1
  25. package/dist/lib/api-client.js.map +1 -1
  26. package/dist/lib/api-client.test.js +15 -0
  27. package/dist/lib/api-client.test.js.map +1 -1
  28. package/dist/lib/auth.d.ts +39 -3
  29. package/dist/lib/auth.d.ts.map +1 -1
  30. package/dist/lib/auth.js +57 -3
  31. package/dist/lib/auth.js.map +1 -1
  32. package/dist/lib/drizzle-meta-routing.test.js +16 -3
  33. package/dist/lib/drizzle-meta-routing.test.js.map +1 -1
  34. package/dist/lib/file-loader.d.ts +6 -4
  35. package/dist/lib/file-loader.d.ts.map +1 -1
  36. package/dist/lib/file-loader.js +30 -27
  37. package/dist/lib/file-loader.js.map +1 -1
  38. package/dist/lib/file-loader.test.js +16 -7
  39. package/dist/lib/file-loader.test.js.map +1 -1
  40. package/dist/skill/docs/changelog.md +429 -1100
  41. package/dist/skill/docs/compiler/cloud-compiler/cli.md +54 -33
  42. package/dist/skill/docs/compiler/cloud-compiler/index.md +9 -9
  43. package/dist/skill/docs/compiler/config/providers.md +87 -0
  44. package/dist/skill/docs/compiler/config/single-tenant.md +5 -11
  45. package/dist/skill/docs/compiler/definitions/access.md +43 -57
  46. package/dist/skill/docs/compiler/definitions/feature.md +7 -11
  47. package/dist/skill/docs/compiler/definitions/firewall.md +2 -4
  48. package/dist/skill/docs/compiler/definitions/guards.md +16 -18
  49. package/dist/skill/docs/compiler/definitions/index.md +10 -14
  50. package/dist/skill/docs/compiler/definitions/masking.md +6 -6
  51. package/dist/skill/docs/compiler/definitions/read.md +6 -11
  52. package/dist/skill/docs/compiler/definitions/schema.md +18 -18
  53. package/dist/skill/docs/compiler/definitions/views.md +3 -5
  54. package/dist/skill/docs/compiler/getting-started/full-example.md +6 -8
  55. package/dist/skill/docs/compiler/getting-started/hand-crafted.md +3 -5
  56. package/dist/skill/docs/compiler/getting-started/index.md +23 -20
  57. package/dist/skill/docs/compiler/getting-started/patterns.md +19 -31
  58. package/dist/skill/docs/compiler/getting-started/template-blog.md +6 -10
  59. package/dist/skill/docs/compiler/getting-started/template-cloudflare.md +49 -56
  60. package/dist/skill/docs/compiler/getting-started/template-empty.md +3 -5
  61. package/dist/skill/docs/compiler/getting-started/templates.md +58 -56
  62. package/dist/skill/docs/compiler/targets/hono-api/using-the-api/batch-operations.md +29 -23
  63. package/dist/skill/docs/compiler/targets/hono-api/using-the-api/crud.md +12 -14
  64. package/dist/skill/docs/compiler/targets/hono-api/using-the-api/openapi.md +5 -2
  65. package/dist/skill/docs/compiler/targets/hono-api/using-the-api/query-params.md +5 -7
  66. package/dist/skill/docs/compiler/troubleshooting.md +10 -0
  67. package/dist/skill/docs/index.md +9 -0
  68. package/dist/skill/docs/stack/auth/security.md +69 -0
  69. package/dist/skill/docs/stack/cms/actions.md +28 -0
  70. package/dist/skill/docs/stack/cms/connecting.md +2 -2
  71. package/dist/skill/docs/stack/cms/index.md +2 -2
  72. package/dist/skill/docs/stack/cms/record-layouts.md +19 -19
  73. package/dist/skill/docs/stack/cms/schema-format.md +33 -3
  74. package/dist/skill/docs/stack/cms/schema-registry.md +22 -2
  75. package/dist/skill/docs/stack/cms/security.md +10 -12
  76. package/dist/skill/docs/stack/cms/table-views.md +1 -1
  77. package/dist/skill/docs/stack/index.md +8 -4
  78. package/dist/skill/docs/stack/realtime/durable-objects.md +46 -5
  79. package/dist/skill/docs/stack/realtime/index.md +20 -3
  80. package/dist/skill/docs/stack/realtime/using-realtime.md +8 -6
  81. package/dist/skill/docs/stack/vector/embeddings.md +7 -6
  82. package/package.json +1 -1
  83. package/src/skill/docs/changelog.md +486 -1097
  84. package/src/skill/docs/compiler/cloud-compiler/cli.md +54 -33
  85. package/src/skill/docs/compiler/cloud-compiler/index.md +9 -9
  86. package/src/skill/docs/compiler/config/domains.md +44 -10
  87. package/src/skill/docs/compiler/config/output.md +1 -1
  88. package/src/skill/docs/compiler/config/providers.md +87 -0
  89. package/src/skill/docs/compiler/config/single-tenant.md +5 -11
  90. package/src/skill/docs/compiler/definitions/access.md +43 -57
  91. package/src/skill/docs/compiler/definitions/feature.md +7 -11
  92. package/src/skill/docs/compiler/definitions/firewall.md +2 -4
  93. package/src/skill/docs/compiler/definitions/guards.md +16 -18
  94. package/src/skill/docs/compiler/definitions/index.md +10 -14
  95. package/src/skill/docs/compiler/definitions/masking.md +6 -6
  96. package/src/skill/docs/compiler/definitions/read.md +6 -11
  97. package/src/skill/docs/compiler/definitions/schema.md +18 -18
  98. package/src/skill/docs/compiler/definitions/views.md +3 -5
  99. package/src/skill/docs/compiler/getting-started/full-example.md +6 -8
  100. package/src/skill/docs/compiler/getting-started/hand-crafted.md +3 -5
  101. package/src/skill/docs/compiler/getting-started/index.md +23 -20
  102. package/src/skill/docs/compiler/getting-started/patterns.md +19 -31
  103. package/src/skill/docs/compiler/getting-started/template-blog.md +6 -10
  104. package/src/skill/docs/compiler/getting-started/template-cloudflare.md +49 -56
  105. package/src/skill/docs/compiler/getting-started/template-empty.md +3 -5
  106. package/src/skill/docs/compiler/getting-started/templates.md +58 -56
  107. package/src/skill/docs/compiler/targets/hono-api/using-the-api/batch-operations.md +29 -23
  108. package/src/skill/docs/compiler/targets/hono-api/using-the-api/crud.md +12 -14
  109. package/src/skill/docs/compiler/targets/hono-api/using-the-api/openapi.md +5 -2
  110. package/src/skill/docs/compiler/targets/hono-api/using-the-api/query-params.md +5 -7
  111. package/src/skill/docs/compiler/troubleshooting.md +10 -0
  112. package/src/skill/docs/index.md +9 -0
  113. package/src/skill/docs/stack/auth/plugins/index.md +74 -0
  114. package/src/skill/docs/stack/auth/security.md +69 -0
  115. package/src/skill/docs/stack/cms/actions.md +28 -0
  116. package/src/skill/docs/stack/cms/connecting.md +2 -2
  117. package/src/skill/docs/stack/cms/index.md +2 -2
  118. package/src/skill/docs/stack/cms/record-layouts.md +19 -19
  119. package/src/skill/docs/stack/cms/schema-format.md +33 -3
  120. package/src/skill/docs/stack/cms/schema-registry.md +22 -2
  121. package/src/skill/docs/stack/cms/security.md +10 -12
  122. package/src/skill/docs/stack/cms/table-views.md +1 -1
  123. package/src/skill/docs/stack/index.md +8 -4
  124. package/src/skill/docs/stack/realtime/durable-objects.md +46 -5
  125. package/src/skill/docs/stack/realtime/index.md +20 -3
  126. package/src/skill/docs/stack/realtime/using-realtime.md +8 -6
  127. package/src/skill/docs/stack/vector/embeddings.md +7 -6
@@ -341,10 +341,8 @@ export default defineTable(jobs, {
341
341
  // via record-level access conditions on /:id
342
342
  access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] },
343
343
  },
344
- crud: {
345
- // Use record conditions to allow public jobs OR owned jobs on GET /:id
346
- // (single-record GET inherits read.access, with optional record-level overrides)
347
- },
344
+ // Use record conditions to allow public jobs OR owned jobs on GET /:id
345
+ // (single-record GET inherits read.access, with optional record-level overrides)
348
346
  // ...
349
347
  });
350
348
  ```
@@ -29,9 +29,9 @@ export default defineTable(applications, {
29
29
  },
30
30
  immutable: ["appliedAt", "candidateId", "jobId"],
31
31
  },
32
- crud: {
33
- // ...
34
- },
32
+ create: { /* ... */ },
33
+ update: { /* ... */ },
34
+ delete: { /* ... */ },
35
35
  });
36
36
  ```
37
37
 
@@ -59,7 +59,7 @@ guards: {
59
59
  |------|------------------|
60
60
  | `createable` | Fields allowed in create (POST) request body |
61
61
  | `updatable` | Fields allowed in update (PATCH) request body |
62
- | `protected` | Fields blocked from CRUD, only modifiable via named actions |
62
+ | `protected` | Fields blocked from direct writes, only modifiable via named actions |
63
63
  | `immutable` | Fields allowed on create, blocked on all updates |
64
64
 
65
65
  **Combining lists:**
@@ -130,21 +130,21 @@ guards: {
130
130
  guards: false // Only system fields protected
131
131
  ```
132
132
 
133
- When `guards: false` is set, all user-defined fields become writable via CRUD operations. This is useful for:
133
+ When `guards: false` is set, all user-defined fields become writable via direct create/update/upsert operations. This is useful for:
134
134
  - External sync scenarios where you need full field control
135
135
  - Batch upsert operations where field restrictions would be limiting
136
136
  - Simple tables where field-level protection isn't needed
137
137
 
138
- ## PUT/Upsert with External IDs
138
+ ## Upsert with External IDs
139
139
 
140
- When you disable guards AND use client-provided IDs, you unlock PUT (upsert) operations. This is designed for **syncing data from external systems**.
140
+ When you disable guards AND use client-provided IDs, you unlock upsert operations. This is designed for **syncing data from external systems**.
141
141
 
142
- ### Requirements for PUT
142
+ ### Requirements for Upsert
143
143
 
144
144
  1. `generateId: false` in database config (client provides IDs)
145
145
  2. `guards: false` in resource definition
146
146
 
147
- ### How PUT Works
147
+ ### How Upsert Works
148
148
 
149
149
  ```
150
150
  PUT /resource/:id
@@ -158,7 +158,7 @@ PUT /resource/:id
158
158
  // quickback.config.ts
159
159
  export default {
160
160
  database: {
161
- generateId: false, // Client provides IDs (enables PUT)
161
+ generateId: false, // Client provides IDs (enables upsert)
162
162
  // Other options: 'uuid' | 'cuid' | 'nanoid' | 'short' | 'prefixed' | 'serial'
163
163
  }
164
164
  };
@@ -171,10 +171,8 @@ export default {
171
171
  export default defineTable(atsImports, {
172
172
  firewall: [{ field: 'organizationId', equals: 'ctx.activeOrgId' }],
173
173
  guards: false, // Disables field restrictions
174
- crud: {
175
- put: {
176
- access: { roles: ['hiring-manager', 'sync-service'] }
177
- }
174
+ upsert: {
175
+ access: { roles: ['hiring-manager', 'sync-service'] }
178
176
  },
179
177
  });
180
178
  ```
@@ -192,7 +190,7 @@ So `guards: false` only opens up user-defined business fields. Tenant scope and
192
190
 
193
191
  ## Ownership Auto-Population
194
192
 
195
- When PUT creates a new record, ownership fields are auto-set from context:
193
+ When upsert creates a new record, ownership fields are auto-set from context:
196
194
 
197
195
  ```typescript
198
196
  // Client sends: PUT /ats-imports/ext-123 { candidateName: "Jane Doe" }
@@ -208,9 +206,9 @@ When PUT creates a new record, ownership fields are auto-set from context:
208
206
  }
209
207
  ```
210
208
 
211
- ## Use Cases for PUT/External IDs
209
+ ## Use Cases for Upsert/External IDs
212
210
 
213
- | Use Case | Why PUT? |
211
+ | Use Case | Why upsert? |
214
212
  |----------|----------|
215
213
  | External API sync | External system controls the ID |
216
214
  | Webhook handlers | Events come with their own IDs |
@@ -220,7 +218,7 @@ When PUT creates a new record, ownership fields are auto-set from context:
220
218
 
221
219
  ## ID Generation Options
222
220
 
223
- | `generateId` | PUT Available? | Notes |
221
+ | `generateId` | Upsert Available? | Notes |
224
222
  |--------------|----------------|-------|
225
223
  | `'uuid'` | No | Server generates UUID |
226
224
  | `'cuid'` | No | Server generates CUID |
@@ -59,24 +59,22 @@ export default defineTable(candidates, {
59
59
  read: {
60
60
  access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] },
61
61
  },
62
- crud: {
63
- create: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
64
- update: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
65
- delete: { access: { roles: ["owner", "hiring-manager"] } },
66
- },
62
+ create: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
63
+ update: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
64
+ delete: { access: { roles: ["owner", "hiring-manager"] } },
67
65
  });
68
66
 
69
67
  export type Candidate = typeof candidates.$inferSelect;
70
68
  ```
71
69
 
72
70
  **Key points:**
73
- - Tables with `export default defineTable(...)` → CRUD routes generated
71
+ - Tables with `export default defineTable(...)` → resource routes generated
74
72
  - Tables without default export → internal/junction tables (no routes)
75
73
  - Route path derived from filename: `applications.ts` → `/api/v1/applications`
76
74
 
77
75
  > **1 Resource = 1 Security Boundary**
78
76
  >
79
- > Each `defineTable()` defines its own complete security boundary — its own firewall (who sees the data), access rules (role requirements), guards (field validation), and masking (redaction). These are compiled into a single resource file that wraps all CRUD routes for that table.
77
+ > Each `defineTable()` defines its own complete security boundary — its own firewall (who sees the data), access rules (role requirements), guards (field validation), and masking (redaction). These are compiled into a single resource file that wraps all generated routes for that table.
80
78
  >
81
79
  > A table **without** `defineTable()` is a supporting table — used internally by actions or handlers, but never exposed as its own API endpoint. See [Internal Tables](/compiler/definitions/schema#internal-tables-no-routes) for details.
82
80
 
@@ -116,17 +114,15 @@ For relationship-based row visibility (e.g. "user can see this event because the
116
114
 
117
115
  ### 2. Access (CRUD Permissions)
118
116
 
119
- Access controls **which operations** a user can perform. It checks roles and record conditions. Reads (`GET /` and `GET /:id`) live under `read:`; writes live under `crud:`.
117
+ Access controls **which operations** a user can perform. It checks roles and record conditions. Reads (`GET /` and `GET /:id`) live under `read:`; writes live under top-level `create:`, `update:`, `delete:`, and `upsert:`.
120
118
 
121
119
  ```typescript
122
120
  read: {
123
121
  access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] },
124
122
  },
125
- crud: {
126
- create: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
127
- update: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
128
- delete: { access: { roles: ["owner", "hiring-manager"] } },
129
- }
123
+ create: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
124
+ update: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
125
+ delete: { access: { roles: ["owner", "hiring-manager"] } },
130
126
  ```
131
127
 
132
128
  [Learn more about Access →](/compiler/definitions/access)
@@ -213,7 +209,7 @@ All options are optional — omit them and Quickback uses sensible defaults (aut
213
209
 
214
210
  1. [Database Schema](/compiler/definitions/schema) — Define your tables
215
211
  2. [Firewall](/compiler/definitions/firewall) — Set up data isolation
216
- 3. [Access](/compiler/definitions/access) — Configure CRUD permissions
212
+ 3. [Access](/compiler/definitions/access) — Configure read and write permissions
217
213
  4. [Guards](/compiler/definitions/guards) — Control field modifications
218
214
  5. [Masking](/compiler/definitions/masking) — Hide sensitive data
219
215
  6. [Views](/compiler/definitions/views) — Column-level security
@@ -84,7 +84,9 @@ export default feature('candidates', {
84
84
  phone: { type: 'phone', show: { roles: ['owner', 'hiring-manager', 'recruiter'] } },
85
85
  },
86
86
  read: { access: { roles: ['owner', 'hiring-manager', 'recruiter', 'interviewer'] } },
87
- crud: { /* ... */ },
87
+ create: { /* ... */ },
88
+ update: { /* ... */ },
89
+ delete: { /* ... */ },
88
90
  });
89
91
  ```
90
92
 
@@ -243,10 +245,8 @@ export default feature('candidates', {
243
245
  },
244
246
  },
245
247
  },
246
- crud: {
247
- create: { access: { roles: ['admin+'] } },
248
- update: { access: { roles: ['admin+'] } },
249
- delete: { access: { roles: ['owner'] }, mode: 'soft' },
250
- },
248
+ create: { access: { roles: ['admin+'] } },
249
+ update: { access: { roles: ['admin+'] } },
250
+ delete: { access: { roles: ['owner'] }, mode: 'soft' },
251
251
  });
252
252
  ```
@@ -39,11 +39,9 @@ export default defineTable(customers, {
39
39
  },
40
40
  },
41
41
  },
42
- crud: {
43
- create: { access: { roles: ['admin'] } },
44
- update: { access: { roles: ['admin'] } },
45
- delete: { access: { roles: ['admin'] }, mode: 'soft' },
46
- },
42
+ create: { access: { roles: ['admin'] } },
43
+ update: { access: { roles: ['admin'] } },
44
+ delete: { access: { roles: ['admin'] }, mode: 'soft' },
47
45
  });
48
46
  ```
49
47
 
@@ -190,9 +188,7 @@ read: {
190
188
  },
191
189
  },
192
190
  }
193
- crud: {
194
- create: { access: { roles: ['admin'] } },
195
- }
191
+ create: { access: { roles: ['admin'] } }
196
192
  ```
197
193
 
198
194
  Clients that previously hit `GET /:id` to retrieve only summary fields now
@@ -202,14 +198,13 @@ full masked record.
202
198
 
203
199
  ## Read-Only Resources
204
200
 
205
- A resource that exposes only reads is valid with an empty `crud` block (or
206
- no `crud` block at all):
201
+ A resource that exposes only reads is valid with no write-operation blocks at all:
207
202
 
208
203
  ```typescript
209
204
  export default defineTable(balanceSnapshots, {
210
205
  firewall: [{ field: 'organizationId', equals: 'ctx.activeOrgId' }],
211
206
  read: { access: { roles: ['member', 'admin'] } },
212
- // no crud — no writes
207
+ // no create/update/delete/upsert — no writes
213
208
  });
214
209
  ```
215
210
 
@@ -28,14 +28,12 @@ export default feature('jobs', {
28
28
  createable: ["title", "department", "status", "salaryMin", "salaryMax"],
29
29
  updatable: ["title", "department", "status"],
30
30
  },
31
- crud: {
32
- create: { access: { roles: ["owner", "hiring-manager"] } },
33
- update: { access: { roles: ["owner", "hiring-manager"] } },
34
- delete: { access: { roles: ["owner", "hiring-manager"] } },
35
- },
36
31
  read: {
37
32
  access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] },
38
33
  },
34
+ create: { access: { roles: ["owner", "hiring-manager"] } },
35
+ update: { access: { roles: ["owner", "hiring-manager"] } },
36
+ delete: { access: { roles: ["owner", "hiring-manager"] } },
39
37
  });
40
38
  ```
41
39
 
@@ -59,8 +57,10 @@ export const jobs = q.table('jobs', {
59
57
 
60
58
  export default defineTable(jobs, {
61
59
  guards: { /* ... */ },
62
- crud: { /* ... */ },
63
60
  read: { /* ... */ },
61
+ create: { /* ... */ },
62
+ update: { /* ... */ },
63
+ delete: { /* ... */ },
64
64
  });
65
65
 
66
66
  export type Job = typeof jobs.$infer;
@@ -182,7 +182,9 @@ export default defineTable(jobs, {
182
182
  createable: ["title", "department", "status", "salaryMin", "salaryMax"],
183
183
  updatable: ["title", "department", "status"],
184
184
  },
185
- crud: { /* ... */ },
185
+ create: { /* ... */ },
186
+ update: { /* ... */ },
187
+ delete: { /* ... */ },
186
188
  });
187
189
 
188
190
  export type Job = typeof jobs.$inferSelect;
@@ -253,13 +255,13 @@ quickback/
253
255
  ```
254
256
 
255
257
  **Key points:**
256
- - Tables with `export default defineTable(...)` get CRUD routes generated
258
+ - Tables with `export default defineTable(...)` get resource routes generated
257
259
  - Tables without a default export are internal (no routes, used for joins/relations)
258
260
  - Route paths are derived from filenames: `applications.ts` → `/api/v1/applications`
259
261
 
260
262
  ### defineTable vs defineResource
261
263
 
262
- - **`defineTable`** — The standard function for defining tables with CRUD routes
264
+ - **`defineTable`** — The standard function for defining tables with generated API routes
263
265
  - **`defineResource`** — Deprecated. Still works but emits a warning during compilation. Use `defineTable` instead.
264
266
 
265
267
  ```typescript
@@ -269,7 +271,7 @@ export default defineTable(jobs, { /* config */ });
269
271
 
270
272
  ## 1 Resource = 1 Security Boundary
271
273
 
272
- Each `defineTable()` call defines a complete, self-contained security boundary. The security config you write — firewall, access, guards, and masking — is compiled into a single resource file that wraps all CRUD routes for that table.
274
+ Each `defineTable()` call defines a complete, self-contained security boundary. The security config you write — firewall, access, guards, and masking — is compiled into a single resource file that wraps all generated routes for that table.
273
275
 
274
276
  This is a deliberate design choice. Mixing two resources with different security rules in one configuration would create ambiguity about which firewall, access, or masking rules apply to which table. By keeping it 1:1, there's never any question.
275
277
 
@@ -287,7 +289,7 @@ For junction tables or internal data structures that shouldn't have API routes,
287
289
  ```typescript
288
290
  // quickback/features/jobs/interview-scores.ts
289
291
 
290
- // @quickback-internal — child table, no CRUD routes intentionally.
292
+ // @quickback-internal — child table, no routes intentionally.
291
293
  import { sqliteTable, text, integer } from 'drizzle-orm/sqlite-core';
292
294
 
293
295
  export const interviewScores = sqliteTable('interview_scores', {
@@ -297,7 +299,7 @@ export const interviewScores = sqliteTable('interview_scores', {
297
299
  organizationId: text('organization_id').notNull(), // Scope junction tables for cascade soft-deletes
298
300
  });
299
301
 
300
- // No default export = no CRUD routes generated
302
+ // No default export = no routes generated
301
303
  ```
302
304
 
303
305
  These internal tables still participate in the database schema and migrations — they just don't get API routes or security configuration. Without the `@quickback-internal` marker the compiler emits a warning per table, since the missing `defineTable` is more often a bug than a deliberate choice.
@@ -314,8 +316,6 @@ The compiler automatically injects the four **[audit fields](#audit-fields)** (`
314
316
  > Unlike audit fields, the `id` column is your responsibility today. The CRUD/action route generators, FK probing, access checks, and OpenAPI emission all assume every queryable table has a single string-typed `id` column. Tables that omit it — or use a non-`id` single PK (`userId.primaryKey()`) or a compound `primaryKey({ columns: [...] })` constraint — parse fine but produce broken generated code downstream.
315
317
  >
316
318
  > Use `q.id()` (preferred) or `id: text("id").primaryKey()` / `id: integer("id").primaryKey({ autoIncrement: true })` on every table that participates in routes. For internal tables marked `// @quickback-internal`, the constraint doesn't apply.
317
- >
318
- > This asymmetry is being closed in **v0.14.8** — `injectIdField` will run unconditionally alongside audit injection, including on junction tables. See the [v0.14.7 changelog](/docs/changelog#coming-next--id-field-auto-injection-v0148) for the migration plan.
319
319
 
320
320
 
321
321
  ## Audit Fields
@@ -415,14 +415,14 @@ This turns off both layers — schema injection and the runtime wrapper.
415
415
  | `deletedAt` | timestamp | Set when the record is soft-deleted |
416
416
  | `deletedBy` | text | Actor that performed the soft delete (`ctx.userId`) |
417
417
 
418
- The compiler injects them only when the resource uses soft delete — i.e. when neither `crud.delete.mode` nor `crud.batchDelete.mode` is explicitly `'hard'`. Soft is the default, so most tables get the columns. Tables with both delete paths set to `'hard'` skip them entirely, which also drops the `isNull(deletedAt)` predicate from the firewall WHERE clause.
418
+ The compiler injects them only when the resource uses soft delete — i.e. when neither `delete.mode` nor `delete.batch.mode` is explicitly `'hard'`. Soft is the default, so most tables get the columns. Tables with both delete paths set to `'hard'` skip them entirely, which also drops the `isNull(deletedAt)` predicate from the firewall WHERE clause.
419
419
 
420
420
  ```typescript
421
421
  // soft delete (default) — table gets deletedAt + deletedBy
422
- crud: { delete: {} }
422
+ delete: {}
423
423
 
424
424
  // hard delete — no deletedAt/deletedBy columns, no soft-delete predicate
425
- crud: { delete: { mode: 'hard' }, batchDelete: { mode: 'hard' } }
425
+ delete: { mode: 'hard', batch: { mode: 'hard' } }
426
426
  ```
427
427
 
428
428
  ### Caller contract
@@ -701,6 +701,6 @@ export const jobs = pgTable('jobs', {
701
701
  ## Next Steps
702
702
 
703
703
  - [Configure the firewall](/compiler/definitions/firewall) for data isolation
704
- - [Set up access control](/compiler/definitions/access) for CRUD operations
704
+ - [Set up access control](/compiler/definitions/access) for read and write operations
705
705
  - [Define guards](/compiler/definitions/guards) for field modification rules
706
706
  - [Add custom actions](/compiler/definitions/actions) for business logic
@@ -371,10 +371,8 @@ export default defineTable(jobs, {
371
371
  },
372
372
  },
373
373
 
374
- crud: {
375
- create: { access: { roles: ['owner', 'hiring-manager'] } },
376
- update: { access: { roles: ['owner', 'hiring-manager'] } },
377
- delete: { access: { roles: ['owner', 'hiring-manager'] } },
378
- },
374
+ create: { access: { roles: ['owner', 'hiring-manager'] } },
375
+ update: { access: { roles: ['owner', 'hiring-manager'] } },
376
+ delete: { access: { roles: ['owner', 'hiring-manager'] } },
379
377
  });
380
378
  ```
@@ -6,7 +6,7 @@ This example shows a complete resource definition using all five security layers
6
6
 
7
7
  A `candidates` resource for a multi-tenant recruitment application with:
8
8
  - Organization-level data isolation
9
- - Role-based CRUD permissions
9
+ - Role-based write permissions
10
10
  - Field-level write protection
11
11
  - PII masking for sensitive fields
12
12
  - Column-level views for different access levels
@@ -57,12 +57,10 @@ export default feature('candidates', {
57
57
  },
58
58
  },
59
59
 
60
- // CRUD — Write operations
61
- crud: {
62
- create: { access: { roles: ['hiring-manager', 'recruiter'] } },
63
- update: { access: { roles: ['hiring-manager', 'recruiter'] } },
64
- delete: { access: { roles: ['hiring-manager'] }, mode: 'hard' },
65
- },
60
+ // WRITE OPERATIONS
61
+ create: { access: { roles: ['hiring-manager', 'recruiter'] } },
62
+ update: { access: { roles: ['hiring-manager', 'recruiter'] } },
63
+ delete: { access: { roles: ['hiring-manager'] }, mode: 'hard' },
66
64
  });
67
65
  ```
68
66
 
@@ -211,7 +209,7 @@ export function maskCandidates<T extends Record<string, any>>(
211
209
  return records.map(r => maskCandidate(r, ctx));
212
210
  }
213
211
 
214
- // CRUD Access configuration (write operations only)
212
+ // Write access configuration (internal normalized shape)
215
213
  export const CRUD_ACCESS = {
216
214
  create: { access: { roles: ['hiring-manager', 'recruiter'] } },
217
215
  update: { access: { roles: ['hiring-manager', 'recruiter'] } },
@@ -89,11 +89,9 @@ export default defineTable(candidates, {
89
89
  read: {
90
90
  access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] },
91
91
  },
92
- crud: {
93
- create: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
94
- update: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
95
- delete: { access: { roles: ["owner", "hiring-manager"] }, mode: "soft" },
96
- },
92
+ create: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
93
+ update: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
94
+ delete: { access: { roles: ["owner", "hiring-manager"] }, mode: "soft" },
97
95
  });
98
96
  ```
99
97
 
@@ -2,29 +2,34 @@
2
2
 
3
3
  Get started with Quickback in minutes. This guide shows you how to define a complete table with security configuration.
4
4
 
5
- ## Install the CLI
5
+ ## Start a Project
6
6
 
7
7
  ```bash
8
- npm install -g @quickback-dev/cli
8
+ mkdir my-app && cd my-app
9
+ npx @quickback-dev/cli start
9
10
  ```
10
11
 
11
- ## Create a Project
12
+ `quickback start` is interactive — it asks for a template and project name, scaffolds the project on disk, and only prompts for an account just before compiling. If you cancel at the login prompt the scaffold stays put; finish later with `quickback login && quickback compile`.
13
+
14
+ Prefer a scriptable form?
12
15
 
13
16
  ```bash
17
+ npm install -g @quickback-dev/cli
14
18
  quickback create cloudflare my-app
15
19
  cd my-app
16
20
  ```
17
21
 
18
- This scaffolds a complete project with:
22
+ Both paths scaffold the same project:
19
23
  - `quickback.config.ts` — Project configuration
20
24
  - `quickback/features/` — Your table definitions
21
- - Example feature with full security configuration
25
+ - Working example feature with full security configuration (when you pick `todos`/`blog`/`saas`)
22
26
 
23
27
  **Available templates:**
24
- - `cloudflare` — Cloudflare Workers + D1 + Better Auth (free)
25
- - `blog` — Single-tenant blog (PUBLIC reads, admin writes) (free)
28
+ - `cloudflare` — Cloudflare Workers + D1 + Better Auth, bare scaffold (free)
29
+ - `todos` — Working CRUD example with masking + actions (free)
30
+ - `blog` — Single-tenant blog, PUBLIC reads, admin writes (free)
26
31
  - `empty` — Cloudflare scaffold, no example features (free)
27
- - `multi-tenant` — Full SaaS with orgs, teams, billing (pro)
32
+ - `saas` — Full B2B SaaS with orgs, R2 file storage, webhooks (pro)
28
33
 
29
34
  ## File Structure
30
35
 
@@ -77,16 +82,14 @@ export default feature('jobs', {
77
82
  pageSize: 25,
78
83
  },
79
84
 
80
- // 4. CRUD — Write operations
81
- crud: {
82
- create: { access: { roles: ["owner", "hiring-manager"] } },
83
- update: { access: { roles: ["owner", "hiring-manager"] } },
84
- delete: { access: { roles: ["owner", "hiring-manager"] }, mode: "soft" },
85
- },
85
+ // 4. WRITE OPERATIONS
86
+ create: { access: { roles: ["owner", "hiring-manager"] } },
87
+ update: { access: { roles: ["owner", "hiring-manager"] } },
88
+ delete: { access: { roles: ["owner", "hiring-manager"] }, mode: "soft" },
86
89
  });
87
90
  ```
88
91
 
89
- One import, one export, every security layer declared in one place. Secure by default — no CRUD routes ship until you opt in with `crud: { … }`.
92
+ One import, one export, every security layer declared in one place. Secure by default — no write routes ship until you opt in with top-level `create`, `update`, `delete`, or `upsert`.
90
93
 
91
94
  ### Alternatives — same result, different shape
92
95
 
@@ -117,21 +120,21 @@ See [feature() — single-export sugar](/compiler/definitions/feature) and [Sche
117
120
 
118
121
  1. **Firewall**: Automatically adds `WHERE organizationId = ?` to every query. Users in Org A can never see Org B's data.
119
122
  2. **Guards**: Controls which fields can be modified — `createable` for POST, `updatable` for PATCH, `protected` for action-only fields.
120
- 3. **CRUD Access**: Role-based access control for each operation. All roles can read, only hiring managers can write.
123
+ 3. **Write Access**: Role-based access control for each operation. All roles can read, only hiring managers can write.
121
124
 
122
125
  ## Compile and Run
123
126
 
124
127
  ```bash
125
- # Log in (first time only)
126
- quickback login
127
-
128
- # Compile your definitions
128
+ # Compile your definitions — prompts you to sign in or sign up
129
+ # if you haven't already (no separate `quickback login` step needed)
129
130
  quickback compile
130
131
 
131
132
  # Run locally
132
133
  npm run dev
133
134
  ```
134
135
 
136
+ The first compile prompts for an account; subsequent compiles re-use the stored session.
137
+
135
138
  ## Generated Endpoints
136
139
 
137
140
  Quickback generates these endpoints from the example above:
@@ -17,11 +17,9 @@ export default defineTable(jobs, {
17
17
  read: {
18
18
  access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] },
19
19
  },
20
- crud: {
21
- create: { access: { roles: ["owner", "hiring-manager"] } },
22
- update: { access: { roles: ["owner", "hiring-manager"] } },
23
- delete: { access: { roles: ["owner", "hiring-manager"] } },
24
- },
20
+ create: { access: { roles: ["owner", "hiring-manager"] } },
21
+ update: { access: { roles: ["owner", "hiring-manager"] } },
22
+ delete: { access: { roles: ["owner", "hiring-manager"] } },
25
23
  });
26
24
  ```
27
25
 
@@ -54,11 +52,9 @@ export default defineTable(interviewNotes, {
54
52
  read: {
55
53
  access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] },
56
54
  },
57
- crud: {
58
- create: { access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] } },
59
- update: { access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] } },
60
- delete: { access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] } },
61
- },
55
+ create: { access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] } },
56
+ update: { access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] } },
57
+ delete: { access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] } },
62
58
  });
63
59
  ```
64
60
 
@@ -79,11 +75,9 @@ export default defineTable(applications, {
79
75
  read: {
80
76
  access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] },
81
77
  },
82
- crud: {
83
- create: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
84
- update: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
85
- delete: { access: { roles: ["owner", "hiring-manager"] } },
86
- },
78
+ create: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
79
+ update: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
80
+ delete: { access: { roles: ["owner", "hiring-manager"] } },
87
81
  });
88
82
  ```
89
83
 
@@ -138,11 +132,9 @@ export default defineTable(applications, {
138
132
  read: {
139
133
  access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] },
140
134
  },
141
- crud: {
142
- create: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
143
- update: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
144
- delete: { access: { roles: ["hiring-manager"] } },
145
- },
135
+ create: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
136
+ update: { access: { roles: ["owner", "hiring-manager", "recruiter"] } },
137
+ delete: { access: { roles: ["hiring-manager"] } },
146
138
  });
147
139
  ```
148
140
 
@@ -181,11 +173,9 @@ export default defineTable(candidates, {
181
173
  read: {
182
174
  access: { roles: ["owner", "hiring-manager", "recruiter", "interviewer"] },
183
175
  },
184
- crud: {
185
- create: { access: { roles: ["hiring-manager", "recruiter"] } },
186
- update: { access: { roles: ["hiring-manager", "recruiter"] } },
187
- delete: { access: { roles: ["hiring-manager"] } },
188
- },
176
+ create: { access: { roles: ["hiring-manager", "recruiter"] } },
177
+ update: { access: { roles: ["hiring-manager", "recruiter"] } },
178
+ delete: { access: { roles: ["hiring-manager"] } },
189
179
  });
190
180
  ```
191
181
 
@@ -197,7 +187,7 @@ export default defineTable(candidates, {
197
187
 
198
188
  ## External System Sync
199
189
 
200
- An import table for syncing candidates from an external ATS via PUT/upsert:
190
+ An import table for syncing candidates from an external ATS via upsert:
201
191
 
202
192
  ```typescript
203
193
  // quickback/features/ats-imports/ats-imports.ts
@@ -210,11 +200,9 @@ export default defineTable(atsImports, {
210
200
  read: {
211
201
  access: { roles: ["owner", "hiring-manager"] },
212
202
  },
213
- crud: {
214
- create: { access: { roles: ["owner", "hiring-manager"] } },
215
- update: { access: { roles: ["owner", "hiring-manager"] } },
216
- delete: { access: { roles: ["owner"] } },
217
- },
203
+ create: { access: { roles: ["owner", "hiring-manager"] } },
204
+ update: { access: { roles: ["owner", "hiring-manager"] } },
205
+ delete: { access: { roles: ["owner"] } },
218
206
  });
219
207
  ```
220
208
 
@@ -84,11 +84,9 @@ export default defineTable(posts, {
84
84
  read: {
85
85
  access: { roles: ["PUBLIC"] },
86
86
  },
87
- crud: {
88
- create: { access: { roles: ["admin"] } },
89
- update: { access: { roles: ["admin"] } },
90
- delete: { access: { roles: ["admin"] }, mode: "soft" },
91
- },
87
+ create: { access: { roles: ["admin"] } },
88
+ update: { access: { roles: ["admin"] } },
89
+ delete: { access: { roles: ["admin"] }, mode: "soft" },
92
90
  });
93
91
  ```
94
92
 
@@ -248,11 +246,9 @@ export default defineTable(pages, {
248
246
  read: {
249
247
  access: { roles: ["PUBLIC"] },
250
248
  },
251
- crud: {
252
- create: { access: { roles: ["admin"] } },
253
- update: { access: { roles: ["admin"] } },
254
- delete: { access: { roles: ["admin"] } },
255
- },
249
+ create: { access: { roles: ["admin"] } },
250
+ update: { access: { roles: ["admin"] } },
251
+ delete: { access: { roles: ["admin"] } },
256
252
  });
257
253
  ```
258
254