@quickback-dev/cli 0.66.0 → 0.66.2
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/README.md +7 -4
- package/dist/commands/build.d.ts +51 -0
- package/dist/commands/build.d.ts.map +1 -0
- package/dist/commands/build.js +793 -0
- package/dist/commands/build.js.map +1 -0
- package/dist/commands/build.test.d.ts +2 -0
- package/dist/commands/build.test.d.ts.map +1 -0
- package/dist/commands/build.test.js +150 -0
- package/dist/commands/build.test.js.map +1 -0
- package/dist/commands/check.d.ts +2 -2
- package/dist/commands/check.js +4 -4
- package/dist/commands/check.js.map +1 -1
- package/dist/commands/create.d.ts +1 -1
- package/dist/commands/create.js +7 -7
- package/dist/commands/create.js.map +1 -1
- package/dist/commands/deploy.d.ts +6 -6
- package/dist/commands/deploy.js +23 -23
- package/dist/commands/deploy.js.map +1 -1
- package/dist/commands/example.js +1 -1
- package/dist/commands/example.js.map +1 -1
- package/dist/commands/mcp.js +1 -1
- package/dist/commands/mcp.js.map +1 -1
- package/dist/commands/migrate.d.ts +1 -1
- package/dist/commands/migrate.js +3 -3
- package/dist/commands/migrate.js.map +1 -1
- package/dist/commands/migrations.js +2 -2
- package/dist/commands/migrations.js.map +1 -1
- package/dist/commands/push.js +1 -1
- package/dist/commands/push.js.map +1 -1
- package/dist/commands/start.js +1 -1
- package/dist/commands/start.js.map +1 -1
- package/dist/cursor/quickback.mdc +1 -1
- package/dist/index.js +18 -15
- package/dist/index.js.map +1 -1
- package/dist/lib/auth.js +1 -1
- package/dist/lib/auth.js.map +1 -1
- package/dist/lib/compiler-floor.d.ts +1 -1
- package/dist/lib/compiler-floor.js +1 -1
- package/dist/lib/file-loader.js +2 -2
- package/dist/lib/file-loader.js.map +1 -1
- package/dist/lib/file-writer.d.ts +2 -0
- package/dist/lib/file-writer.d.ts.map +1 -1
- package/dist/lib/file-writer.js +16 -0
- package/dist/lib/file-writer.js.map +1 -1
- package/dist/lib/file-writer.test.js +16 -0
- package/dist/lib/file-writer.test.js.map +1 -1
- package/dist/lib/migrations/file-envelopes.js +3 -3
- package/dist/lib/migrations/file-envelopes.js.map +1 -1
- package/dist/lib/prepare-output.test.js +1 -1
- package/dist/lib/prepare-output.test.js.map +1 -1
- package/dist/lib/schema-sync/index.js +1 -1
- package/dist/lib/schema-sync/index.test.js +1 -1
- package/dist/lib/schema-sync/index.test.js.map +1 -1
- package/dist/lib/wrangler-resources.d.ts.map +1 -1
- package/dist/lib/wrangler-resources.js +5 -2
- package/dist/lib/wrangler-resources.js.map +1 -1
- package/dist/lib/wrangler-resources.test.js +6 -0
- package/dist/lib/wrangler-resources.test.js.map +1 -1
- package/dist/skill/SKILL.md +24 -9
- package/dist/skill/docs/api/crud.md +7 -0
- package/dist/skill/docs/api/index.md +1 -1
- package/dist/skill/docs/api/openapi.md +1 -1
- package/dist/skill/docs/changelog/index.md +27 -1
- package/dist/skill/docs/configure/agents.md +1 -1
- package/dist/skill/docs/configure/domains.md +1 -1
- package/dist/skill/docs/configure/index.md +11 -5
- package/dist/skill/docs/configure/providers.md +6 -3
- package/dist/skill/docs/configure/single-tenant.md +7 -3
- package/dist/skill/docs/configure/variables.md +3 -3
- package/dist/skill/docs/define/access.md +10 -0
- package/dist/skill/docs/define/actions/defining.md +35 -7
- package/dist/skill/docs/define/actions/index.md +1 -1
- package/dist/skill/docs/define/actions/record-and-standalone.md +7 -4
- package/dist/skill/docs/define/actions/scoped-db.md +68 -21
- package/dist/skill/docs/define/areas.md +1 -1
- package/dist/skill/docs/define/diagnostics.md +1 -0
- package/dist/skill/docs/define/encryption.md +1 -1
- package/dist/skill/docs/define/feature.md +17 -8
- package/dist/skill/docs/define/firewall.md +2 -0
- package/dist/skill/docs/define/guards.md +27 -3
- package/dist/skill/docs/define/index.md +1 -1
- package/dist/skill/docs/define/relationships.md +7 -0
- package/dist/skill/docs/define/schema.md +44 -14
- package/dist/skill/docs/define/security.md +1 -1
- package/dist/skill/docs/define/transitions.md +35 -4
- package/dist/skill/docs/define/triggers.md +14 -3
- package/dist/skill/docs/define/views.md +33 -0
- package/dist/skill/docs/index.md +2 -2
- package/dist/skill/docs/platform/auth/api-keys.md +2 -2
- package/dist/skill/docs/platform/auth/using-auth.md +37 -0
- package/dist/skill/docs/platform/database/d1.md +15 -3
- package/dist/skill/docs/platform/database/neon.md +4 -4
- package/dist/skill/docs/platform/email/index.md +1 -1
- package/dist/skill/docs/platform/queues/handlers.md +1 -1
- package/dist/skill/docs/platform/queues/using-queues.md +1 -1
- package/dist/skill/docs/platform/realtime/using-realtime.md +6 -4
- package/dist/skill/docs/platform/schedules/index.md +1 -1
- package/dist/skill/docs/platform/storage/index.md +3 -3
- package/dist/skill/docs/platform/storage/r2.md +87 -37
- package/dist/skill/docs/platform/storage/using-r2.md +99 -19
- package/dist/skill/docs/platform/webhooks/inbound.md +40 -0
- package/dist/skill/docs/start/deploy-browser.md +40 -45
- package/dist/skill/docs/start/deploy-owner-access.md +60 -52
- package/dist/skill/docs/start/deploy.md +4 -4
- package/dist/skill/docs/start/first-api.md +2 -2
- package/dist/skill/docs/start/hand-crafted.md +3 -3
- package/dist/skill/docs/start/index.md +3 -3
- package/dist/skill/docs/start/patterns.md +17 -2
- package/dist/skill/docs/start/quickstart.md +3 -3
- package/dist/skill/docs/start/template-blog.md +2 -2
- package/dist/skill/docs/start/template-cloudflare.md +3 -3
- package/dist/skill/docs/start/template-empty.md +1 -1
- package/dist/skill/docs/start/templates.md +1 -1
- package/dist/skill/docs/tooling/claude-skill.md +1 -1
- package/dist/skill/docs/tooling/cli.md +21 -16
- package/dist/skill/docs/tooling/cloud-compiler/authentication.md +2 -2
- package/dist/skill/docs/tooling/cloud-compiler/endpoints.md +5 -3
- package/dist/skill/docs/tooling/cloud-compiler/index.md +1 -1
- package/dist/skill/docs/tooling/cloud-compiler/local-compiler.md +2 -2
- package/dist/skill/docs/tooling/cloud-compiler/troubleshooting.md +74 -1
- package/dist/skill/docs/tooling/output.md +23 -2
- package/dist/skill/docs/tooling/troubleshooting.md +1 -1
- package/dist/skill/docs/ui/account/customization.md +1 -1
- package/dist/skill/docs/ui/account/environment-variables.md +2 -2
- package/dist/skill/docs/ui/account/features/admin.md +1 -1
- package/dist/skill/docs/ui/account/features/api-keys.md +10 -8
- package/dist/skill/docs/ui/account/features/avatars.md +24 -8
- package/dist/skill/docs/ui/account/features/index.md +16 -11
- package/dist/skill/docs/ui/account/features/organizations.md +3 -2
- package/dist/skill/docs/ui/account/hooks.md +2 -0
- package/dist/skill/docs/ui/account/index.md +10 -5
- package/dist/skill/docs/ui/account/with-quickback.md +2 -2
- package/dist/skill/docs/ui/admin/actions.md +97 -3
- package/dist/skill/docs/ui/admin/components.md +4 -6
- package/dist/skill/docs/ui/admin/connecting.md +15 -3
- package/dist/skill/docs/ui/admin/index.md +71 -6
- package/dist/skill/docs/ui/admin/inline-editing.md +38 -4
- package/dist/skill/docs/ui/admin/record-layouts.md +22 -21
- package/dist/skill/docs/ui/admin/schema-format.md +39 -2
- package/dist/skill/docs/ui/admin/schema-registry.md +107 -7
- package/dist/skill/docs/ui/admin/security.md +19 -4
- package/dist/skill/docs/ui/admin/table-views.md +59 -12
- package/package.json +1 -1
- package/src/cursor/quickback.mdc +1 -1
- package/src/skill/SKILL.md +24 -9
- package/src/skill/docs/api/crud.md +7 -0
- package/src/skill/docs/api/index.md +1 -1
- package/src/skill/docs/api/openapi.md +1 -1
- package/src/skill/docs/changelog/index.md +27 -1
- package/src/skill/docs/configure/agents.md +1 -1
- package/src/skill/docs/configure/domains.md +1 -1
- package/src/skill/docs/configure/index.md +11 -5
- package/src/skill/docs/configure/providers.md +6 -3
- package/src/skill/docs/configure/single-tenant.md +7 -3
- package/src/skill/docs/configure/variables.md +3 -3
- package/src/skill/docs/define/access.md +10 -0
- package/src/skill/docs/define/actions/defining.md +35 -7
- package/src/skill/docs/define/actions/index.md +1 -1
- package/src/skill/docs/define/actions/record-and-standalone.md +7 -4
- package/src/skill/docs/define/actions/scoped-db.md +68 -21
- package/src/skill/docs/define/areas.md +1 -1
- package/src/skill/docs/define/diagnostics.md +1 -0
- package/src/skill/docs/define/encryption.md +1 -1
- package/src/skill/docs/define/feature.md +17 -8
- package/src/skill/docs/define/firewall.md +2 -0
- package/src/skill/docs/define/guards.md +27 -3
- package/src/skill/docs/define/index.md +1 -1
- package/src/skill/docs/define/relationships.md +7 -0
- package/src/skill/docs/define/schema.md +44 -14
- package/src/skill/docs/define/security.md +1 -1
- package/src/skill/docs/define/transitions.md +35 -4
- package/src/skill/docs/define/triggers.md +14 -3
- package/src/skill/docs/define/views.md +33 -0
- package/src/skill/docs/index.md +2 -2
- package/src/skill/docs/platform/auth/api-keys.md +2 -2
- package/src/skill/docs/platform/auth/using-auth.md +37 -0
- package/src/skill/docs/platform/database/d1.md +15 -3
- package/src/skill/docs/platform/database/neon.md +4 -4
- package/src/skill/docs/platform/email/index.md +1 -1
- package/src/skill/docs/platform/queues/handlers.md +1 -1
- package/src/skill/docs/platform/queues/using-queues.md +1 -1
- package/src/skill/docs/platform/realtime/using-realtime.md +6 -4
- package/src/skill/docs/platform/schedules/index.md +1 -1
- package/src/skill/docs/platform/storage/index.md +3 -3
- package/src/skill/docs/platform/storage/r2.md +87 -37
- package/src/skill/docs/platform/storage/using-r2.md +99 -19
- package/src/skill/docs/platform/webhooks/inbound.md +40 -0
- package/src/skill/docs/start/deploy-browser.md +40 -45
- package/src/skill/docs/start/deploy-owner-access.md +60 -52
- package/src/skill/docs/start/deploy.md +4 -4
- package/src/skill/docs/start/first-api.md +2 -2
- package/src/skill/docs/start/hand-crafted.md +3 -3
- package/src/skill/docs/start/index.md +3 -3
- package/src/skill/docs/start/patterns.md +17 -2
- package/src/skill/docs/start/quickstart.md +3 -3
- package/src/skill/docs/start/template-blog.md +2 -2
- package/src/skill/docs/start/template-cloudflare.md +3 -3
- package/src/skill/docs/start/template-empty.md +1 -1
- package/src/skill/docs/start/templates.md +1 -1
- package/src/skill/docs/tooling/claude-skill.md +1 -1
- package/src/skill/docs/tooling/cli.md +21 -16
- package/src/skill/docs/tooling/cloud-compiler/authentication.md +2 -2
- package/src/skill/docs/tooling/cloud-compiler/endpoints.md +5 -3
- package/src/skill/docs/tooling/cloud-compiler/index.md +1 -1
- package/src/skill/docs/tooling/cloud-compiler/local-compiler.md +2 -2
- package/src/skill/docs/tooling/cloud-compiler/troubleshooting.md +74 -1
- package/src/skill/docs/tooling/output.md +23 -2
- package/src/skill/docs/tooling/troubleshooting.md +1 -1
- package/src/skill/docs/ui/account/customization.md +1 -1
- package/src/skill/docs/ui/account/environment-variables.md +2 -2
- package/src/skill/docs/ui/account/features/admin.md +1 -1
- package/src/skill/docs/ui/account/features/api-keys.md +10 -8
- package/src/skill/docs/ui/account/features/avatars.md +24 -8
- package/src/skill/docs/ui/account/features/index.md +16 -11
- package/src/skill/docs/ui/account/features/organizations.md +3 -2
- package/src/skill/docs/ui/account/hooks.md +2 -0
- package/src/skill/docs/ui/account/index.md +10 -5
- package/src/skill/docs/ui/account/with-quickback.md +2 -2
- package/src/skill/docs/ui/admin/actions.md +97 -3
- package/src/skill/docs/ui/admin/components.md +4 -6
- package/src/skill/docs/ui/admin/connecting.md +15 -3
- package/src/skill/docs/ui/admin/index.md +71 -6
- package/src/skill/docs/ui/admin/inline-editing.md +38 -4
- package/src/skill/docs/ui/admin/record-layouts.md +22 -21
- package/src/skill/docs/ui/admin/schema-format.md +39 -2
- package/src/skill/docs/ui/admin/schema-registry.md +107 -7
- package/src/skill/docs/ui/admin/security.md +19 -4
- package/src/skill/docs/ui/admin/table-views.md +59 -12
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# CLI Reference
|
|
2
2
|
|
|
3
|
-
The Quickback CLI is the fastest way to create,
|
|
3
|
+
The Quickback CLI is the fastest way to create, build, and manage your backend projects.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -25,7 +25,7 @@ Interactive onboarding designed for new users. No flags required.
|
|
|
25
25
|
- Prompts for a template (`cloudflare`, `todos`, `blog`, `empty`)
|
|
26
26
|
- Prompts for a project name (defaults to the current directory's name if empty)
|
|
27
27
|
- Auto-detects whether to scaffold in-place or create a `./<name>/` subdirectory
|
|
28
|
-
- Defers login until just before the
|
|
28
|
+
- Defers login until just before the build step — cancel at the auth prompt and the scaffold stays on disk, ready for `quickback build` later
|
|
29
29
|
|
|
30
30
|
**Example:**
|
|
31
31
|
```bash
|
|
@@ -58,14 +58,19 @@ This scaffolds a complete project with:
|
|
|
58
58
|
|
|
59
59
|
See the [Templates](/start/templates) page for a deeper guide on choosing between them.
|
|
60
60
|
|
|
61
|
-
###
|
|
61
|
+
### Build Your API
|
|
62
62
|
|
|
63
63
|
```bash
|
|
64
|
-
quickback
|
|
64
|
+
quickback build
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
|
|
68
|
-
|
|
67
|
+
> `quickback compile` is the former name of this command and still works as an
|
|
68
|
+
> alias — existing scripts and CI pipelines keep running unchanged. `build` is
|
|
69
|
+
> the name used throughout the docs.
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
Use `quickback build --verbose` when a remote build fails and you need the
|
|
73
|
+
underlying command, exit code, stderr/stdout tail, and suggested fixes.
|
|
69
74
|
|
|
70
75
|
Reads your definitions and generates:
|
|
71
76
|
- Database migrations (Drizzle)
|
|
@@ -126,8 +131,8 @@ no server: this is your editor's view of the source, on demand.
|
|
|
126
131
|
|
|
127
132
|
Exit codes: `0` clean · `1` type errors · `2` setup missing. A fresh clone
|
|
128
133
|
(or a project that has never compiled) exits `2` with a pointer at
|
|
129
|
-
`quickback
|
|
130
|
-
resolves against. Re-run `quickback
|
|
134
|
+
`quickback build`, which generates the tsconfig and helpers the check
|
|
135
|
+
resolves against. Re-run `quickback build` after schema changes so the
|
|
131
136
|
helpers track your tables.
|
|
132
137
|
|
|
133
138
|
### Synchronize Managed Columns
|
|
@@ -325,7 +330,7 @@ cd my-app
|
|
|
325
330
|
npm run dev
|
|
326
331
|
|
|
327
332
|
# 3. Recompile after editing definitions
|
|
328
|
-
quickback
|
|
333
|
+
quickback build
|
|
329
334
|
```
|
|
330
335
|
|
|
331
336
|
## Options
|
|
@@ -352,7 +357,7 @@ The CLI parses your feature files with the TypeScript compiler API, and falls ba
|
|
|
352
357
|
Set `QUICKBACK_STRICT_PARSE=1` in CI so a regex-parsed build fails the pipeline instead of shipping:
|
|
353
358
|
|
|
354
359
|
```bash
|
|
355
|
-
QUICKBACK_STRICT_PARSE=1 quickback
|
|
360
|
+
QUICKBACK_STRICT_PARSE=1 quickback build
|
|
356
361
|
```
|
|
357
362
|
|
|
358
363
|
Having no `typescript` installed at all is a supported setup and stays silent — the fallback is the intended path there.
|
|
@@ -363,16 +368,16 @@ Use an API key instead of interactive login. Useful for CI/CD pipelines and auto
|
|
|
363
368
|
|
|
364
369
|
```bash
|
|
365
370
|
# Pass API key for a single command
|
|
366
|
-
QUICKBACK_API_KEY=your_api_key quickback
|
|
371
|
+
QUICKBACK_API_KEY=your_api_key quickback build
|
|
367
372
|
|
|
368
373
|
# Or export for the session
|
|
369
374
|
export QUICKBACK_API_KEY=your_api_key
|
|
370
|
-
quickback
|
|
375
|
+
quickback build
|
|
371
376
|
```
|
|
372
377
|
|
|
373
378
|
The API key takes precedence over stored credentials from `quickback login`.
|
|
374
379
|
|
|
375
|
-
You can create API keys from your [Quickback account](https://account.quickback.dev/
|
|
380
|
+
You can create API keys from your [Quickback account](https://account.quickback.dev/api-keys). Each key is scoped to your organization.
|
|
376
381
|
|
|
377
382
|
### Custom Compiler URL
|
|
378
383
|
|
|
@@ -380,11 +385,11 @@ Point the CLI to a different compiler (local or custom):
|
|
|
380
385
|
|
|
381
386
|
```bash
|
|
382
387
|
# Use a local compiler
|
|
383
|
-
QUICKBACK_API_URL=http://localhost:3000 quickback
|
|
388
|
+
QUICKBACK_API_URL=http://localhost:3000 quickback build
|
|
384
389
|
|
|
385
390
|
# Or export for the session
|
|
386
391
|
export QUICKBACK_API_URL=http://localhost:3000
|
|
387
|
-
quickback
|
|
392
|
+
quickback build
|
|
388
393
|
```
|
|
389
394
|
|
|
390
395
|
See [Local Compiler](/tooling/cloud-compiler/local-compiler) for running the compiler locally with Docker.
|
|
@@ -407,7 +412,7 @@ npx @quickback-dev/cli start
|
|
|
407
412
|
|
|
408
413
|
1. Check your `quickback.config.ts` exists and is valid
|
|
409
414
|
2. Ensure all tables in `quickback/features/` have valid exports
|
|
410
|
-
3. Run `quickback
|
|
415
|
+
3. Run `quickback build` with `--verbose` for detailed output
|
|
411
416
|
4. For rename-related Drizzle failures in CI/headless runs, configure `compiler.migrations.renames` in `quickback.config.ts`
|
|
412
417
|
|
|
413
418
|
### Authentication issues
|
|
@@ -19,10 +19,10 @@ Credentials are stored at `~/.quickback/credentials.json` and include your sessi
|
|
|
19
19
|
For non-interactive environments (CI/CD, scripts), use an API key:
|
|
20
20
|
|
|
21
21
|
```bash
|
|
22
|
-
QUICKBACK_API_KEY=your_api_key quickback
|
|
22
|
+
QUICKBACK_API_KEY=your_api_key quickback build
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Create API keys from your [Quickback account](https://account.quickback.dev/
|
|
25
|
+
Create API keys from your [Quickback account](https://account.quickback.dev/api-keys). Each key is scoped to your organization.
|
|
26
26
|
|
|
27
27
|
The API key takes precedence over stored credentials from `quickback login`.
|
|
28
28
|
|
|
@@ -33,7 +33,7 @@ The `/compile` endpoint requires either a session token (from `quickback login`)
|
|
|
33
33
|
}
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
The map uses project-root-relative paths and follows the same layout `quickback
|
|
36
|
+
The map uses project-root-relative paths and follows the same layout `quickback build` reads from disk: `quickback/quickback.config.ts`, `quickback/features/**`, `quickback/services/**`, `quickback/{lib,hooks,plugins,middlewares,email-templates}/**`, plus `quickback/drizzle/**/meta/**` and `wrangler.toml` for incremental builds.
|
|
37
37
|
|
|
38
38
|
Two constraints, both fail-closed:
|
|
39
39
|
|
|
@@ -56,7 +56,9 @@ The response header `X-Quickback-Compile-Backend` says which backend answered:
|
|
|
56
56
|
| `container-fallback` | Edge is enabled but failed (5xx/unreachable); the container answered instead |
|
|
57
57
|
| _(absent)_ | Edge routing is not enabled; the container answered, as before |
|
|
58
58
|
|
|
59
|
-
Complete compiles (`?complete=true`, the default) always run in the container — they need the CLI toolchain (drizzle-kit, prebuilt SPA assets). The edge Worker rejects
|
|
59
|
+
Complete compiles (`?complete=true`, the default) always run in the container — they need the CLI toolchain (drizzle-kit, prebuilt SPA assets). For Cloudflare projects they also run `wrangler deploy --dry-run` as a bundle check (the same command package-mode deploy uses, without collecting a deployment artifact), so missing named exports and unresolved imports fail here instead of at deploy. The edge Worker rejects complete compiles with a 400 pointing at the container endpoint.
|
|
60
|
+
|
|
61
|
+
Validation compiles (`?complete=false`) still skip that bundle check — they may run on the edge Worker, which has no Wrangler.
|
|
60
62
|
|
|
61
63
|
## Environment Variables
|
|
62
64
|
|
|
@@ -70,7 +72,7 @@ Complete compiles (`?complete=true`, the default) always run in the container
|
|
|
70
72
|
Point the CLI to a different compiler (local or custom):
|
|
71
73
|
|
|
72
74
|
```bash
|
|
73
|
-
QUICKBACK_API_URL=http://localhost:3000 quickback
|
|
75
|
+
QUICKBACK_API_URL=http://localhost:3000 quickback build
|
|
74
76
|
```
|
|
75
77
|
|
|
76
78
|
See [Local Compiler](/tooling/cloud-compiler/local-compiler) for running the compiler locally with Docker.
|
|
@@ -91,7 +91,7 @@ npx @quickback-dev/cli start
|
|
|
91
91
|
npm install -g @quickback-dev/cli
|
|
92
92
|
quickback create cloudflare my-app
|
|
93
93
|
cd my-app
|
|
94
|
-
quickback
|
|
94
|
+
quickback build # prompts for login on the first run
|
|
95
95
|
```
|
|
96
96
|
|
|
97
97
|
## Existing Databases
|
|
@@ -35,14 +35,14 @@ bash dev.sh 3001
|
|
|
35
35
|
Point the CLI to your local compiler:
|
|
36
36
|
|
|
37
37
|
```bash
|
|
38
|
-
QUICKBACK_API_URL=http://localhost:3000 quickback
|
|
38
|
+
QUICKBACK_API_URL=http://localhost:3000 quickback build
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
Or export it for the session:
|
|
42
42
|
|
|
43
43
|
```bash
|
|
44
44
|
export QUICKBACK_API_URL=http://localhost:3000
|
|
45
|
-
quickback
|
|
45
|
+
quickback build
|
|
46
46
|
```
|
|
47
47
|
|
|
48
48
|
The supported launcher does not require `quickback login`. It opts the compiler
|
|
@@ -29,7 +29,7 @@ npx @quickback-dev/cli create cloudflare my-app
|
|
|
29
29
|
|
|
30
30
|
1. Check your `quickback.config.ts` exists and is valid
|
|
31
31
|
2. Ensure all tables in `quickback/features/` have valid exports
|
|
32
|
-
3. Run `quickback
|
|
32
|
+
3. Run `quickback build` with `--verbose` for detailed output
|
|
33
33
|
|
|
34
34
|
## Drizzle rename prompts in CI/headless compile
|
|
35
35
|
|
|
@@ -67,6 +67,79 @@ If a hint is missing, compile now fails loudly with the exact key path to add, f
|
|
|
67
67
|
- `Expected hint key: compiler.migrations.renames.tables["events_v2"]`
|
|
68
68
|
- `Expected hint key: compiler.migrations.renames.columns["events"]["summary_text"]`
|
|
69
69
|
|
|
70
|
+
## `Critical command failed: Generate features database migrations`
|
|
71
|
+
|
|
72
|
+
drizzle-kit could not load the generated **features** schema. The usual cause on
|
|
73
|
+
D1 (`splitDatabases: true`) is a feature column that `.references()` a Better
|
|
74
|
+
Auth table:
|
|
75
|
+
|
|
76
|
+
{/* doc-compile: skip — illegal one-liner, not a host feature */}
|
|
77
|
+
```typescript
|
|
78
|
+
userId: q.text().required().references(() => users.id, { onDelete: 'cascade' }) // illegal
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
`users` / `user` / `organization` / `member` live in `AUTH_DB`. Features live in
|
|
82
|
+
`DB`. SQLite cannot FK across them, and drizzle-kit cannot resolve `users` when
|
|
83
|
+
generating features migrations.
|
|
84
|
+
|
|
85
|
+
A Start chat compile (`complete=false`) still succeeds — it never runs
|
|
86
|
+
drizzle-kit. The complete compile (`complete=true` — Generated Backend, or
|
|
87
|
+
`quickback compile`) is the first time that command runs.
|
|
88
|
+
|
|
89
|
+
## `complete compile: wrangler bundle failed`
|
|
90
|
+
|
|
91
|
+
The complete compile bundles the generated Worker with
|
|
92
|
+
`wrangler deploy --dry-run`. A typical cause is a named import the generated
|
|
93
|
+
`define-action` helper does not re-export:
|
|
94
|
+
|
|
95
|
+
```
|
|
96
|
+
No matching export in "src/features/tables/.quickback/define-action.ts" for import "reservations"
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
The helper re-exports every table in **that feature only**. If `reservations`
|
|
100
|
+
is another table inside `tables`, import it from the action's own
|
|
101
|
+
`../.quickback/define-action` helper. If it belongs to a separate
|
|
102
|
+
`reservations` feature, keep `defineAction` from the action's own feature and
|
|
103
|
+
import only the external table from
|
|
104
|
+
`../../reservations/.quickback/define-action` (or the generated
|
|
105
|
+
`../../reservations/reservations` table module). Import query operators as `q`
|
|
106
|
+
from project `../../../lib/q`; neither feature helper owns them. This is the
|
|
107
|
+
same rule for any waitlist/reservations-style cross-feature action: the local
|
|
108
|
+
helper supplies the bound action context, and each external feature supplies
|
|
109
|
+
its own tables.
|
|
110
|
+
|
|
111
|
+
Current compilers validate named imports from generated action helpers before
|
|
112
|
+
code generation. Start's definition-validation build (`complete=false`)
|
|
113
|
+
therefore rejects this source immediately with `Invalid generated
|
|
114
|
+
action-helper import(s)` and names the owning feature, available table exports,
|
|
115
|
+
and corrective import. If an older compiler or an already-generated project
|
|
116
|
+
reaches Wrangler first, apply the same fix above and rebuild Generated Backend
|
|
117
|
+
before Deploy.
|
|
118
|
+
|
|
119
|
+
The compile sandbox has no network and bundles against the compiler image's
|
|
120
|
+
own dependencies, so anything you declare in
|
|
121
|
+
[`build.dependencies`](/configure#custom-dependencies) is not installed there.
|
|
122
|
+
Rather than fail on `Could not resolve "yjs"`, the compiler **skips** the
|
|
123
|
+
bundle check for those projects and says so in the compile warnings:
|
|
124
|
+
|
|
125
|
+
```
|
|
126
|
+
Skipped the Worker bundle check — build.dependencies not installed in the
|
|
127
|
+
compiler image: yjs, y-prosemirror
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
The compile still succeeds and the generated output is unchanged; unresolved
|
|
131
|
+
imports and missing named exports surface at `wrangler deploy` instead.
|
|
132
|
+
|
|
133
|
+
Store the Better Auth id as plain text:
|
|
134
|
+
|
|
135
|
+
{/* doc-compile: skip — one-liner, not a host feature */}
|
|
136
|
+
```typescript
|
|
137
|
+
userId: q.text().required()
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
`.references()` is only for another feature table in `DB`. See
|
|
141
|
+
[Schema → References](/define/schema).
|
|
142
|
+
|
|
70
143
|
## "Could not load organizations"
|
|
71
144
|
|
|
72
145
|
This can happen if your session token expired or if the API is temporarily unavailable. Re-login:
|
|
@@ -36,6 +36,7 @@ src/
|
|
|
36
36
|
│ ├── types.ts # Runtime type definitions
|
|
37
37
|
│ ├── masks.ts # Field masking utilities
|
|
38
38
|
│ ├── services.ts # Service layer
|
|
39
|
+
│ ├── q.ts # Generated Drizzle query-operator namespace for actions
|
|
39
40
|
│ ├── audit-wrapper.ts # Stamps the managed audit columns on write
|
|
40
41
|
│ └── security-audit.ts # Unsafe cross-tenant audit logger (when needed)
|
|
41
42
|
└── middleware/
|
|
@@ -74,6 +75,13 @@ Not every per-feature file is always emitted:
|
|
|
74
75
|
- `schema.ts`, `{feature}.ts`, and `{feature}.resource.ts` are skipped for tableless features.
|
|
75
76
|
- A multi-table feature gets one alias file per table (`{feature}.ts`, `{other_table}.ts`) alongside the single `schema.ts`.
|
|
76
77
|
|
|
78
|
+
Each `.quickback/define-action.ts` helper is scoped to its feature: it exports
|
|
79
|
+
that feature's bound `defineAction` and tables, but no tables from sibling
|
|
80
|
+
features. A cross-feature action imports the external table from the sibling
|
|
81
|
+
feature's generated helper or table module. From a normal
|
|
82
|
+
`src/features/{feature}/actions/` file, import query operators with
|
|
83
|
+
`import { q } from "../../../lib/q"`.
|
|
84
|
+
|
|
77
85
|
## Spec Blobs Are Assets, Not Bundle
|
|
78
86
|
|
|
79
87
|
`openapi.json`, `asyncapi.json` and `schema-registry.json` are **not** written
|
|
@@ -163,6 +171,19 @@ unrecoverable while a missed one is only untidy:
|
|
|
163
171
|
|
|
164
172
|
Nothing under `src/` is ever listed: the wipe already covers it.
|
|
165
173
|
|
|
174
|
+
## Root files you own
|
|
175
|
+
|
|
176
|
+
A recompile rewrites `src/` wholesale, but three root files are merged rather
|
|
177
|
+
than replaced:
|
|
178
|
+
|
|
179
|
+
- **`package.json`** — compiler-owned scripts and dependencies converge on every
|
|
180
|
+
compile; scripts and fields the compiler does not emit are kept. Because owned
|
|
181
|
+
scripts converge, a hand-deleted `db:migrate:auth:*` step comes back — declare
|
|
182
|
+
[`authMigrations: 'external'`](/configure/providers#cloudflare-d1) instead.
|
|
183
|
+
- **`.gitignore`** — a union: your entries stay, missing compiler entries are
|
|
184
|
+
appended.
|
|
185
|
+
- **`README.md`** — written once; an existing README is never touched.
|
|
186
|
+
|
|
166
187
|
## Generated Package Dependency Security
|
|
167
188
|
|
|
168
189
|
For projects using Better Auth, the generated `package.json` keeps the stable
|
|
@@ -210,11 +231,11 @@ records the patched transitive version. Use `npm audit --omit=dev` when
|
|
|
210
231
|
evaluating the production dependency tree; development-tool advisories are a
|
|
211
232
|
separate review surface.
|
|
212
233
|
|
|
213
|
-
For Better Auth projects, `quickback
|
|
234
|
+
For Better Auth projects, `quickback build` owns auth-schema generation.
|
|
214
235
|
The generated `build` script runs TypeScript only and never rewrites
|
|
215
236
|
`src/auth/schema.ts`, so build and deployment preflight checks preserve a clean
|
|
216
237
|
generated worktree. `auth:schema` remains an explicit diagnostic command; run
|
|
217
|
-
`quickback
|
|
238
|
+
`quickback build` afterward to restore canonical generated bytes.
|
|
218
239
|
|
|
219
240
|
On recompilation, Quickback replaces commands for script names it generates,
|
|
220
241
|
including `build`, with the current compiler output. Scripts with other names
|
|
@@ -102,7 +102,7 @@ Quickback now adds a D1-specific safety pass around Drizzle-generated migrations
|
|
|
102
102
|
2. **Drop-only cleanup migrations** are reordered child-first when foreign keys require it.
|
|
103
103
|
3. **All D1 migration directories** generated by the compiler are replayed against SQLite during compile, so a D1-breaking migration fails before deploy.
|
|
104
104
|
|
|
105
|
-
If `quickback
|
|
105
|
+
If `quickback build` now fails with a D1 replay error, treat that as a real migration problem instead of a deploy-time surprise. The generated SQL needs manual intervention or a schema change that Drizzle can express more safely.
|
|
106
106
|
|
|
107
107
|
## Runtime Issues
|
|
108
108
|
|
|
@@ -93,7 +93,7 @@ setAppConfig({
|
|
|
93
93
|
| `privacy` | "Privacy Policy" | Footer link text |
|
|
94
94
|
| `support` | "Contact Support" | Footer link text |
|
|
95
95
|
| `company` | (from `VITE_COMPANY_NAME`) | Footer company name |
|
|
96
|
-
| `organizations` | "Organizations" | Navigation and page titles |
|
|
96
|
+
| `organizations` | "Organizations" | Navigation and page titles. Profile and the user menu prefix this as **Manage …** (`Manage Organizations`). |
|
|
97
97
|
|
|
98
98
|
## Custom Messages
|
|
99
99
|
|
|
@@ -281,11 +281,11 @@ VITE_DISABLE_EMAIL_STATUS_CHECK=false
|
|
|
281
281
|
The Account UI has no standalone deploy path — the compiler ships a generic prebuilt bundle (built once per compiler release) into your Worker. In a compiled project you normally set none of the variables on this page by hand:
|
|
282
282
|
|
|
283
283
|
1. Declare the values in `quickback.config.ts` under `account` (name, branding, URLs, `auth` feature flags).
|
|
284
|
-
2. `quickback
|
|
284
|
+
2. `quickback build` stages the prebuilt Account assets and bakes the values into the generated worker.
|
|
285
285
|
3. The worker injects them into every served Account shell as `window.__QUICKBACK_RUNTIME`, which the SPA prefers over baked `VITE_*` values. This runtime blob is the only per-project configuration channel — no per-project Vite build runs.
|
|
286
286
|
|
|
287
287
|
```bash
|
|
288
|
-
quickback
|
|
288
|
+
quickback build
|
|
289
289
|
npx wrangler deploy
|
|
290
290
|
```
|
|
291
291
|
|
|
@@ -85,7 +85,7 @@ The admin domain serves the same Account SPA at root (`/`). The SPA's client-sid
|
|
|
85
85
|
|
|
86
86
|
## CMS Access Control
|
|
87
87
|
|
|
88
|
-
When both CMS and Account UI are enabled, the
|
|
88
|
+
When both CMS and Account UI are enabled, the Account profile shows a CMS action. It opens the sole organization directly or lets a multi-organization user choose one first. You can restrict this to the sysadmin tier only:
|
|
89
89
|
|
|
90
90
|
```typescript
|
|
91
91
|
cms: { domain: "cms.example.com", access: "sysadmin" },
|
|
@@ -1,21 +1,23 @@
|
|
|
1
1
|
# API Key Management
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
API keys are a user credential. Manage them at `/api-keys`, linked from `/profile`. The `apiKey` plugin is on by default.
|
|
4
4
|
|
|
5
5
|
## Creating API Keys
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
-
|
|
7
|
+
- Custom name
|
|
8
|
+
- Shown once at creation — copy it then
|
|
9
|
+
- Scoped to an organization via `metadata.organizationId` so the key inherits your role in that tenant
|
|
10
|
+
- One organization: stamped automatically
|
|
11
|
+
- Several organizations: pick one when creating
|
|
12
12
|
|
|
13
13
|
## Managing Keys
|
|
14
14
|
|
|
15
|
-
-
|
|
16
|
-
- See last-used timestamp
|
|
15
|
+
- List every key you own (not filtered to the current org)
|
|
16
|
+
- See last-used timestamp and which organization the key is scoped to
|
|
17
17
|
- Revoke individual keys
|
|
18
18
|
|
|
19
|
+
`/$slug/api-keys` redirects here so old bookmarks still work.
|
|
20
|
+
|
|
19
21
|
## Related
|
|
20
22
|
|
|
21
23
|
- [API Keys Auth](/platform/auth/api-keys) — Server-side API key authentication
|
|
@@ -1,35 +1,51 @@
|
|
|
1
1
|
# Avatars
|
|
2
2
|
|
|
3
|
-
When file uploads are enabled, Account UI provides avatar
|
|
3
|
+
When file uploads are enabled, Account UI provides avatar and organization logo
|
|
4
|
+
upload. Both POST to `/storage/v1/object` and **only work with valid R2
|
|
5
|
+
credentials**.
|
|
4
6
|
|
|
5
7
|
## Enabling
|
|
6
8
|
|
|
7
|
-
|
|
9
|
+
Off by default. Start apps leave it off — a `workers.dev` deploy can create
|
|
10
|
+
the R2 bucket, but it cannot mint the API-token secrets presigning and the
|
|
11
|
+
storage routes need.
|
|
8
12
|
|
|
9
13
|
```ts
|
|
10
14
|
account: {
|
|
11
15
|
fileUploads: true,
|
|
12
16
|
// ...
|
|
13
17
|
}
|
|
18
|
+
|
|
19
|
+
providers: {
|
|
20
|
+
fileStorage: defineFileStorage("cloudflare-r2", { managed: true }),
|
|
21
|
+
}
|
|
14
22
|
```
|
|
15
23
|
|
|
16
|
-
The compiler emits `VITE_ENABLE_FILE_UPLOADS=true`
|
|
24
|
+
The compiler emits `VITE_ENABLE_FILE_UPLOADS=true` only when **both** are set.
|
|
25
|
+
`account.fileUploads: true` without managed R2 does not turn the UI on — the
|
|
26
|
+
dialogs would 404.
|
|
27
|
+
|
|
28
|
+
Set the Worker secrets `R2_ACCOUNT_ID`, `R2_ACCESS_KEY_ID`, and
|
|
29
|
+
`R2_SECRET_ACCESS_KEY`. See [R2 Setup](/platform/storage/r2).
|
|
17
30
|
|
|
18
31
|
## Upload Flow
|
|
19
32
|
|
|
20
|
-
1. User clicks their profile picture
|
|
33
|
+
1. User clicks their profile picture (or **Upload Logo** on org settings)
|
|
21
34
|
2. Image picker opens (supports JPG, PNG, WebP)
|
|
22
35
|
3. Image is cropped to square
|
|
23
|
-
4. Uploaded to R2
|
|
24
|
-
5. Profile updated with new
|
|
36
|
+
4. Uploaded to R2 via `/storage/v1/object`
|
|
37
|
+
5. Profile / organization updated with the new URL
|
|
25
38
|
|
|
26
39
|
## Requirements
|
|
27
40
|
|
|
28
41
|
- `account.fileUploads: true`
|
|
29
|
-
- R2
|
|
30
|
-
-
|
|
42
|
+
- Managed R2 — `defineFileStorage("cloudflare-r2", { managed: true })`
|
|
43
|
+
- Valid R2 credentials on the Worker (`R2_ACCOUNT_ID`, `R2_ACCESS_KEY_ID`,
|
|
44
|
+
`R2_SECRET_ACCESS_KEY`)
|
|
45
|
+
- Upload endpoints available (`/storage/v1/*`)
|
|
31
46
|
|
|
32
47
|
## Related
|
|
33
48
|
|
|
34
49
|
- [R2 Storage](/platform/storage/r2) — File storage setup
|
|
35
50
|
- [Environment Variables](/ui/account/environment-variables)
|
|
51
|
+
- [Admin UI](/ui/admin) — the CMS does not host these uploads
|
|
@@ -171,10 +171,10 @@ VITE_ENABLE_GOOGLE_OAUTH=false # default: false
|
|
|
171
171
|
|
|
172
172
|
**When enabled:**
|
|
173
173
|
- "Continue with Google" button on the login and signup pages
|
|
174
|
-
- Google row
|
|
174
|
+
- Google row on `/connected-accounts` (linked from **Manage Connected Accounts** on `/profile`)
|
|
175
175
|
|
|
176
176
|
**When disabled:**
|
|
177
|
-
- No social sign-in button, no Connected Accounts
|
|
177
|
+
- No social sign-in button, no **Manage Connected Accounts** link, no `/connected-accounts` page
|
|
178
178
|
|
|
179
179
|
**Requirements:**
|
|
180
180
|
- Google OAuth credentials configured on the Better Auth side
|
|
@@ -187,14 +187,14 @@ VITE_ENABLE_CLOUDFLARE_OAUTH=false # default: false
|
|
|
187
187
|
|
|
188
188
|
**When enabled:**
|
|
189
189
|
- "Continue with Cloudflare" button on the login and signup pages
|
|
190
|
-
- Cloudflare rows
|
|
190
|
+
- Cloudflare rows on `/connected-accounts` — unlike
|
|
191
191
|
Google, more than one Cloudflare identity can be linked to the same user
|
|
192
192
|
(**Connect another Cloudflare account**), and every linked identity signs
|
|
193
193
|
in to this user. Link work and personal Cloudflare logins here so each one
|
|
194
194
|
doesn't mint its own separate account.
|
|
195
195
|
|
|
196
196
|
**When disabled:**
|
|
197
|
-
- No Cloudflare sign-in button, no Connected Accounts
|
|
197
|
+
- No Cloudflare sign-in button, no **Manage Connected Accounts** link, no `/connected-accounts` page
|
|
198
198
|
|
|
199
199
|
**Requirements:**
|
|
200
200
|
- `socialProviders.cloudflare.enabled` in the auth config (Cloudflare rides
|
|
@@ -211,16 +211,20 @@ VITE_ENABLE_FILE_UPLOADS=false # default: false
|
|
|
211
211
|
|
|
212
212
|
**When enabled:**
|
|
213
213
|
- Avatar/profile picture upload
|
|
214
|
+
- Organization logo upload
|
|
214
215
|
- Image cropping and editing
|
|
215
|
-
- File upload to R2
|
|
216
|
+
- File upload to R2
|
|
216
217
|
|
|
217
218
|
**When disabled:**
|
|
218
|
-
- No file upload
|
|
219
|
-
- Users can only use default avatars
|
|
219
|
+
- No file upload UI (default, including Start apps)
|
|
220
|
+
- Users can only use default avatars / initials
|
|
220
221
|
|
|
221
222
|
**Requirements:**
|
|
222
|
-
-
|
|
223
|
-
-
|
|
223
|
+
- `account.fileUploads: true`
|
|
224
|
+
- Managed R2 (`defineFileStorage("cloudflare-r2", { managed: true })`)
|
|
225
|
+
- Valid R2 credentials: `R2_ACCOUNT_ID`, `R2_ACCESS_KEY_ID`, `R2_SECRET_ACCESS_KEY`
|
|
226
|
+
|
|
227
|
+
The compiler will not emit `VITE_ENABLE_FILE_UPLOADS=true` without managed R2 — otherwise the picker 404s. See [Avatars](/ui/account/features/avatars).
|
|
224
228
|
|
|
225
229
|
### Subscriptions
|
|
226
230
|
|
|
@@ -256,10 +260,11 @@ VITE_ENABLE_ORGANIZATIONS=false # default: false
|
|
|
256
260
|
```
|
|
257
261
|
|
|
258
262
|
**When enabled:**
|
|
259
|
-
-
|
|
260
|
-
- Organization management pages
|
|
263
|
+
- `/dashboard` lists organizations and pending invitations
|
|
264
|
+
- Organization management pages (`/$slug`)
|
|
261
265
|
- Member invitations and roles
|
|
262
266
|
- `/organizations/*` routes
|
|
267
|
+
- Sign-in still lands on `/profile`; **Manage Organizations** opens `/dashboard`
|
|
263
268
|
|
|
264
269
|
**When disabled:**
|
|
265
270
|
- Single-user mode only
|
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
# Organizations
|
|
2
2
|
|
|
3
|
-
Account UI provides a complete organization management interface when `VITE_ENABLE_ORGANIZATIONS=true`. Teams are a separate opt-in (`VITE_ENABLE_ORG_TEAMS`), surfaced when the compiler detects `organization({ teams: { enabled: true } })` in the Better Auth config.
|
|
3
|
+
Account UI provides a complete organization management interface when `VITE_ENABLE_ORGANIZATIONS=true`. `/dashboard` is that surface: the organizations you belong to and pending invitations. **Manage Organizations** on `/profile` (and in the user menu) opens it. Personal account settings live on `/profile`. The profile **Go to…** picker opens the tenant app using `account.appUrl` and `account.tenantPattern` — see [Customization](/ui/account/customization#tenant-url-patterns). When CMS is enabled, the profile also offers an access-aware CMS action: one membership opens directly, several memberships produce a picker, and the selected organization is made active before navigation. A pinned project targets only its configured organization; it never labels another membership as the CMS destination. Teams are a separate opt-in (`VITE_ENABLE_ORG_TEAMS`), surfaced when the compiler detects `organization({ teams: { enabled: true } })` in the Better Auth config.
|
|
4
4
|
|
|
5
5
|
## Organization CRUD
|
|
6
6
|
|
|
7
7
|
- Create new organizations, with `checkSlug` debounce on the slug field
|
|
8
|
-
- Update name, **slug** (rename navigates to the new URL), **metadata** (JSON object)
|
|
8
|
+
- Update name, **slug** (rename navigates to the new URL), and **metadata** (JSON object)
|
|
9
|
+
- **Logo upload** only when `account.fileUploads: true` **and** managed R2 is configured with valid credentials (`R2_ACCOUNT_ID`, `R2_ACCESS_KEY_ID`, `R2_SECRET_ACCESS_KEY`). Start apps leave this off. See [Avatars](/ui/account/features/avatars).
|
|
9
10
|
- Delete organizations — gated on the `organization:delete` permission (default: owner)
|
|
10
11
|
|
|
11
12
|
## Member Management
|
|
@@ -219,6 +219,8 @@ type HookCtx = {
|
|
|
219
219
|
|
|
220
220
|
`authDb` is the load-bearing piece: hooks must write to the auth DB via Drizzle directly. See the [CSRF caveat](#csrf-caveat-server-side-org-create) below. `authSchema` is the namespace export of the generated auth schema module; destructure the tables you need.
|
|
221
221
|
|
|
222
|
+
This injection is unique to account hooks. Actions reach AUTH_DB via `c.get("authDb")` ([Scoped DB](/define/actions/scoped-db#reaching-better-auth-tables-authdb)). Trigger handlers on a table file get neither — use `ctx` for the acting user, and do not import `../../auth/schema` from the table file.
|
|
223
|
+
|
|
222
224
|
The atomic email-OTP hook additionally receives `db` (the transaction-bound
|
|
223
225
|
full application Drizzle client), `schema` (the full generated application
|
|
224
226
|
schema), and `atomicRoute: "emailOtpSignIn"`. In a single-database Neon project,
|
|
@@ -8,13 +8,17 @@ Account UI is a single React SPA that contains three distinct sections:
|
|
|
8
8
|
|
|
9
9
|
### Account (every user)
|
|
10
10
|
|
|
11
|
-
Login, signup, profile editing, password management, device sessions, email changes, and account deletion. This is what every user interacts with.
|
|
11
|
+
Login, signup, profile editing, password management, device sessions, email changes, and account deletion. This is what every user interacts with. After sign-in, Account UI lands on `/profile`.
|
|
12
|
+
|
|
13
|
+
When organizations are enabled, `/profile` has **Manage Organizations** (the `/dashboard` org list and invites) and a **Go to…** control that opens the tenant app. The URL is `account.appUrl` plus `account.tenantPattern` with the org slug substituted (the same `getTenantUrl` used on the org dashboard). One org is a single button; several orgs is a picker. The control is hidden when those config values cannot produce a URL.
|
|
14
|
+
|
|
15
|
+
When the project also enables the CMS, the profile has a separate CMS action. One membership opens that organization directly; several memberships produce an organization picker. Account UI makes the selected organization active before navigating, so the CMS cannot inherit a different active organization from an earlier session. The action follows `cms.access`: membership is required in `"member"` mode, while only `user.role === "sysadmin"` sees it in `"sysadmin"` mode. A zero-membership sysadmin opens the tenant picker only when `cms.sysadmin: true` explicitly enables cross-tenant scope. When `features.pinnedOrganizationId` is set, the profile targets only that fixed organization and never offers the caller's other memberships.
|
|
12
16
|
|
|
13
17
|
Served on its own domain (e.g., `auth.example.com`) or at `/account/` when embedded alongside the CMS.
|
|
14
18
|
|
|
15
19
|
### Organization Management (multi-tenant)
|
|
16
20
|
|
|
17
|
-
|
|
21
|
+
`/dashboard` is org management — org list, pending invitations, and the path into org settings (`/$slug`). Personal account settings stay on `/profile`. Only available when `auth.organizations` is enabled.
|
|
18
22
|
|
|
19
23
|
### Admin Panel (admin users only)
|
|
20
24
|
|
|
@@ -44,7 +48,7 @@ export default {
|
|
|
44
48
|
```
|
|
45
49
|
|
|
46
50
|
```bash
|
|
47
|
-
quickback
|
|
51
|
+
quickback build
|
|
48
52
|
npx wrangler deploy
|
|
49
53
|
```
|
|
50
54
|
|
|
@@ -86,7 +90,7 @@ Auth feature flags control which pages are included in the bundle:
|
|
|
86
90
|
| `auth.password` | Password login, inline password change on profile |
|
|
87
91
|
| `auth.emailOTP` | Email OTP login flow, email-based password reset |
|
|
88
92
|
| `auth.passkey` | Passkey setup and management |
|
|
89
|
-
| `auth.organizations` |
|
|
93
|
+
| `auth.organizations` | `/dashboard` (org list + invitations), org creation, member management |
|
|
90
94
|
| `auth.admin` | Admin panel (user management) |
|
|
91
95
|
|
|
92
96
|
When a flag is `false`, the corresponding routes **guard themselves at runtime** — each feature route checks its flag from the worker-injected `window.__QUICKBACK_RUNTIME` config in `beforeLoad` and redirects away, and navigation entries for it are hidden. The Account SPA ships as one generic prebuilt bundle; flags decide which surfaces exist for your project.
|
|
@@ -95,9 +99,10 @@ When a flag is `false`, the corresponding routes **guard themselves at runtime**
|
|
|
95
99
|
|
|
96
100
|
- **Authentication** — Email/password, passkeys (WebAuthn), email OTP, magic links, email verification, password reset
|
|
97
101
|
- **Account Management** — Profile editing, avatar upload, password changes, device/session management, account deletion
|
|
102
|
+
- **Connected Accounts** — Link Google and Cloudflare logins from `/connected-accounts` (linked from profile)
|
|
98
103
|
- **Organizations** — Multi-tenant org management with owner/admin/member roles, invitations, and org settings
|
|
99
104
|
- **Admin Panel** — User management dashboard with search, create, ban/unban, password reset, and session viewing
|
|
100
|
-
- **API Keys** — Generate and manage API keys
|
|
105
|
+
- **API Keys** — Generate and manage API keys from `/api-keys` (linked from profile)
|
|
101
106
|
- **CLI Authorization** — Device authorization flow for `quickback login`
|
|
102
107
|
|
|
103
108
|
## Next Steps
|
|
@@ -28,7 +28,7 @@ export default {
|
|
|
28
28
|
Then compile and deploy:
|
|
29
29
|
|
|
30
30
|
```bash
|
|
31
|
-
quickback
|
|
31
|
+
quickback build
|
|
32
32
|
npx wrangler deploy
|
|
33
33
|
```
|
|
34
34
|
|
|
@@ -68,7 +68,7 @@ auth: {
|
|
|
68
68
|
password: true, // Email/password login + inline password change
|
|
69
69
|
emailOTP: false, // Email OTP login flow
|
|
70
70
|
passkey: true, // WebAuthn passkey setup + management
|
|
71
|
-
organizations: true, //
|
|
71
|
+
organizations: true, // /dashboard org list, org management, invitations
|
|
72
72
|
admin: true, // Admin panel (user management)
|
|
73
73
|
}
|
|
74
74
|
```
|