@quickback-dev/cli 0.18.0 → 0.34.1

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 (93) hide show
  1. package/dist/commands/compile.d.ts.map +1 -1
  2. package/dist/commands/compile.js +25 -1
  3. package/dist/commands/compile.js.map +1 -1
  4. package/dist/commands/migrations.d.ts +17 -0
  5. package/dist/commands/migrations.d.ts.map +1 -0
  6. package/dist/commands/migrations.js +328 -0
  7. package/dist/commands/migrations.js.map +1 -0
  8. package/dist/docs/content.d.ts.map +1 -1
  9. package/dist/docs/content.js +33 -63
  10. package/dist/docs/content.js.map +1 -1
  11. package/dist/index.js +7 -1
  12. package/dist/index.js.map +1 -1
  13. package/dist/lib/api-client.d.ts +17 -0
  14. package/dist/lib/api-client.d.ts.map +1 -1
  15. package/dist/lib/api-client.js.map +1 -1
  16. package/dist/lib/file-loader.d.ts +39 -0
  17. package/dist/lib/file-loader.d.ts.map +1 -1
  18. package/dist/lib/file-loader.js +73 -0
  19. package/dist/lib/file-loader.js.map +1 -1
  20. package/dist/lib/file-loader.test.js +22 -1
  21. package/dist/lib/file-loader.test.js.map +1 -1
  22. package/dist/skill/docs/changelog.md +1118 -1
  23. package/dist/skill/docs/compiler/config/domains.md +70 -10
  24. package/dist/skill/docs/compiler/config/index.md +74 -3
  25. package/dist/skill/docs/compiler/config/output.md +1 -1
  26. package/dist/skill/docs/compiler/config/providers.md +6 -12
  27. package/dist/skill/docs/compiler/config/single-tenant.md +1 -1
  28. package/dist/skill/docs/compiler/config/variables.md +0 -30
  29. package/dist/skill/docs/compiler/definitions/access.md +357 -3
  30. package/dist/skill/docs/compiler/definitions/actions.md +85 -8
  31. package/dist/skill/docs/compiler/definitions/schema.md +6 -10
  32. package/dist/skill/docs/compiler/index.md +15 -34
  33. package/dist/skill/docs/compiler/targets/hono-api/cloudflare.md +1 -2
  34. package/dist/skill/docs/compiler/targets/hono-api/database/neon.md +0 -1
  35. package/dist/skill/docs/compiler/targets/hono-api/using-the-api/actions-api.md +19 -0
  36. package/dist/skill/docs/compiler/targets/hono-api/using-the-api/batch-operations.md +1 -1
  37. package/dist/skill/docs/compiler/targets/index.md +6 -34
  38. package/dist/skill/docs/index.md +2 -5
  39. package/dist/skill/docs/stack/account-ui/customization.md +2 -14
  40. package/dist/skill/docs/stack/account-ui/environment-variables.md +7 -1
  41. package/dist/skill/docs/stack/account-ui/features/admin.md +2 -2
  42. package/dist/skill/docs/stack/account-ui/features/avatars.md +2 -4
  43. package/dist/skill/docs/stack/account-ui/features/index.md +1 -1
  44. package/dist/skill/docs/stack/account-ui/features/organizations.md +31 -11
  45. package/dist/skill/docs/stack/account-ui/hooks.md +4 -0
  46. package/dist/skill/docs/stack/account-ui/index.md +5 -43
  47. package/dist/skill/docs/stack/account-ui/with-quickback.md +2 -75
  48. package/dist/skill/docs/stack/auth/plugins/aws-ses.md +60 -0
  49. package/dist/skill/docs/stack/auth/plugins/aws-sns.md +169 -0
  50. package/dist/skill/docs/stack/auth/plugins/index.md +106 -0
  51. package/package.json +1 -1
  52. package/src/skill/docs/changelog.md +1057 -0
  53. package/src/skill/docs/compiler/config/domains.md +26 -0
  54. package/src/skill/docs/compiler/config/index.md +74 -3
  55. package/src/skill/docs/compiler/config/providers.md +6 -12
  56. package/src/skill/docs/compiler/config/single-tenant.md +1 -1
  57. package/src/skill/docs/compiler/config/variables.md +0 -30
  58. package/src/skill/docs/compiler/definitions/access.md +357 -3
  59. package/src/skill/docs/compiler/definitions/actions.md +85 -8
  60. package/src/skill/docs/compiler/definitions/schema.md +6 -10
  61. package/src/skill/docs/compiler/index.md +15 -34
  62. package/src/skill/docs/compiler/targets/hono-api/cloudflare.md +1 -2
  63. package/src/skill/docs/compiler/targets/hono-api/database/neon.md +0 -1
  64. package/src/skill/docs/compiler/targets/hono-api/using-the-api/actions-api.md +19 -0
  65. package/src/skill/docs/compiler/targets/hono-api/using-the-api/batch-operations.md +1 -1
  66. package/src/skill/docs/compiler/targets/index.md +6 -34
  67. package/src/skill/docs/index.md +2 -5
  68. package/src/skill/docs/stack/account-ui/customization.md +2 -14
  69. package/src/skill/docs/stack/account-ui/environment-variables.md +7 -1
  70. package/src/skill/docs/stack/account-ui/features/admin.md +2 -2
  71. package/src/skill/docs/stack/account-ui/features/avatars.md +2 -4
  72. package/src/skill/docs/stack/account-ui/features/index.md +1 -1
  73. package/src/skill/docs/stack/account-ui/features/organizations.md +31 -11
  74. package/src/skill/docs/stack/account-ui/hooks.md +4 -0
  75. package/src/skill/docs/stack/account-ui/index.md +5 -43
  76. package/src/skill/docs/stack/account-ui/with-quickback.md +2 -75
  77. package/src/skill/docs/stack/auth/plugins/aws-ses.md +60 -0
  78. package/src/skill/docs/stack/auth/plugins/aws-sns.md +169 -0
  79. package/src/skill/docs/stack/auth/plugins/index.md +32 -0
  80. package/dist/skill/docs/compiler/targets/supabase-rls/index.md +0 -55
  81. package/dist/skill/docs/compiler/targets/supabase-rls/limitations.md +0 -48
  82. package/dist/skill/docs/compiler/targets/supabase-rls/mappings.md +0 -99
  83. package/dist/skill/docs/compiler/targets/supabase-rls/setup.md +0 -88
  84. package/dist/skill/docs/stack/account-ui/library-usage.md +0 -257
  85. package/dist/skill/docs/stack/account-ui/standalone.md +0 -149
  86. package/dist/skill/docs/stack/account-ui/worker.md +0 -362
  87. package/src/skill/docs/compiler/targets/supabase-rls/index.md +0 -55
  88. package/src/skill/docs/compiler/targets/supabase-rls/limitations.md +0 -48
  89. package/src/skill/docs/compiler/targets/supabase-rls/mappings.md +0 -99
  90. package/src/skill/docs/compiler/targets/supabase-rls/setup.md +0 -88
  91. package/src/skill/docs/stack/account-ui/library-usage.md +0 -257
  92. package/src/skill/docs/stack/account-ui/standalone.md +0 -149
  93. package/src/skill/docs/stack/account-ui/worker.md +0 -362
@@ -1,257 +0,0 @@
1
- # Library Usage
2
-
3
- Instead of cloning the template, you can install Account UI as an npm package. This gives you automatic updates via `npm update` while configuring the UI through `setAppConfig()`.
4
-
5
- > **When to use library mode**
6
- >
7
- > Use library mode when you want to embed Account UI into an existing React application without owning the source. For full control over the source code, use the [standalone template](/stack/account-ui/standalone) instead.
8
-
9
-
10
- ## Installation
11
-
12
- ```bash
13
- npm install quickback-better-auth-account-ui
14
- ```
15
-
16
- ### Peer Dependencies
17
-
18
- Account UI expects these packages in your app:
19
-
20
- ```bash
21
- npm install react react-dom react-router-dom @tanstack/react-query
22
- ```
23
-
24
- ## Basic Setup
25
-
26
- ### 1. Import and Configure
27
-
28
- ```tsx title="src/main.tsx"
29
- import React from 'react';
30
- import ReactDOM from 'react-dom/client';
31
- import { BrowserRouter } from 'react-router-dom';
32
- import { AuthApp, setAppConfig } from 'quickback-better-auth-account-ui';
33
- import 'quickback-better-auth-account-ui/styles.css';
34
-
35
- setAppConfig({
36
- authRoute: 'quickback', // or 'better-auth' for standalone Better Auth
37
- name: 'My App',
38
- companyName: 'My Company Inc.',
39
- tagline: 'Build faster, ship sooner',
40
- description: 'My app description',
41
- });
42
-
43
- ReactDOM.createRoot(document.getElementById('root')!).render(
44
- <React.StrictMode>
45
- <BrowserRouter>
46
- <AuthApp />
47
- </BrowserRouter>
48
- </React.StrictMode>
49
- );
50
- ```
51
-
52
- ### 2. Set API URLs
53
-
54
- The library reads API URLs from `globalThis` variables. Set these before importing the library:
55
-
56
- ```tsx title="src/main.tsx"
57
- // Single catch-all: API + Account + CMS URLs are all derived from this origin.
58
- (globalThis as any).__QUICKBACK_URL__ = 'https://secure.example.com';
59
- (globalThis as any).__QUICKBACK_APP_URL__ = 'https://app.example.com';
60
-
61
- // Then import dynamically to ensure globals are set first
62
- const { AuthApp, setAppConfig } = await import('quickback-better-auth-account-ui');
63
- await import('quickback-better-auth-account-ui/styles.css');
64
- ```
65
-
66
- If your API lives on a different subdomain, set `__QUICKBACK_API_URL__` explicitly instead (or alongside) — it takes precedence over the catch-all:
67
-
68
- ```tsx
69
- (globalThis as any).__QUICKBACK_URL__ = 'https://secure.example.com'; // catch-all
70
- (globalThis as any).__QUICKBACK_API_URL__ = 'https://api.example.com'; // explicit override
71
- ```
72
-
73
- Or with Vite environment variables:
74
-
75
- ```tsx title="src/main.tsx"
76
- (globalThis as any).__QUICKBACK_URL__ = import.meta.env.VITE_QUICKBACK_URL;
77
- (globalThis as any).__QUICKBACK_API_URL__ = import.meta.env.VITE_QUICKBACK_API_URL;
78
- (globalThis as any).__QUICKBACK_APP_URL__ = import.meta.env.VITE_QUICKBACK_APP_URL;
79
-
80
- Promise.all([
81
- import('quickback-better-auth-account-ui'),
82
- import('quickback-better-auth-account-ui/styles.css'),
83
- ]).then(([{ AuthApp, setAppConfig }]) => {
84
- setAppConfig({
85
- authRoute: 'quickback',
86
- name: import.meta.env.VITE_APP_NAME || 'My App',
87
- companyName: import.meta.env.VITE_COMPANY_NAME || 'My Company',
88
- tagline: import.meta.env.VITE_APP_TAGLINE || 'Welcome',
89
- });
90
-
91
- ReactDOM.createRoot(document.getElementById('root')!).render(
92
- <React.StrictMode>
93
- <BrowserRouter>
94
- <AuthApp />
95
- </BrowserRouter>
96
- </React.StrictMode>
97
- );
98
- });
99
- ```
100
-
101
- ## Cloudflare Worker
102
-
103
- The library exports a Cloudflare Worker entry point for SPA routing and static asset serving:
104
-
105
- ```ts title="src/worker.ts"
106
- export { default } from 'quickback-better-auth-account-ui/worker';
107
- ```
108
-
109
- Or extend it with custom logic:
110
-
111
- ```ts title="src/worker.ts"
112
- import { createAuthWorker } from 'quickback-better-auth-account-ui/worker';
113
-
114
- export default createAuthWorker();
115
- ```
116
-
117
- ## Configuration via `setAppConfig()`
118
-
119
- In library mode, all configuration happens through `setAppConfig()` instead of environment variables.
120
-
121
- ### Auth Route Mode
122
-
123
- ```ts
124
- setAppConfig({
125
- authRoute: 'quickback', // Quickback API: /auth/v1, /api/v1, /storage/v1
126
- // or
127
- authRoute: 'better-auth', // Better Auth default: /api/auth
128
- });
129
- ```
130
-
131
- ### Branding
132
-
133
- ```ts
134
- setAppConfig({
135
- name: 'Acme SaaS',
136
- companyName: 'Acme Corporation',
137
- tagline: 'Build faster, ship sooner',
138
- description: 'The complete platform for modern web applications',
139
- branding: {
140
- primaryColor: '#3b82f6',
141
- logoUrl: '/logo.png',
142
- faviconUrl: '/favicon.ico',
143
- },
144
- });
145
- ```
146
-
147
- ### Labels and Messages
148
-
149
- ```ts
150
- setAppConfig({
151
- labels: {
152
- organizations: 'Workspaces',
153
- terms: 'Terms and Conditions',
154
- privacy: 'Privacy Notice',
155
- },
156
- messages: {
157
- noOrganizations: "You haven't joined any workspaces yet.",
158
- createOrganization: 'Create Workspace',
159
- },
160
- });
161
- ```
162
-
163
- ### Routes
164
-
165
- ```ts
166
- setAppConfig({
167
- routes: {
168
- public: {
169
- login: '/sign-in',
170
- signup: '/sign-up',
171
- },
172
- organizations: {
173
- list: '/workspaces',
174
- create: '/workspaces/new',
175
- },
176
- },
177
- });
178
- ```
179
-
180
- ### Password and Session
181
-
182
- ```ts
183
- setAppConfig({
184
- auth: {
185
- passwordRequirements: {
186
- minLength: 12,
187
- requireSymbols: true,
188
- },
189
- sessionDuration: 7 * 24 * 60 * 60, // 7 days
190
- },
191
- });
192
- ```
193
-
194
- See [Customization](/stack/account-ui/customization) for the full reference of all configurable options.
195
-
196
- ## Exports
197
-
198
- The library provides the following exports:
199
-
200
- ### Main Entry (`quickback-better-auth-account-ui`)
201
-
202
- | Export | Type | Description |
203
- |--------|------|-------------|
204
- | `AuthApp` | Component | The main React application component |
205
- | `authClient` | Object | Pre-configured Better Auth client |
206
- | `appConfig` | Object | Current app configuration |
207
- | `setAppConfig` | Function | Set app configuration overrides |
208
- | `createAppConfig` | Function | Create a new config object |
209
- | `getApiBase` | Function | Get the current API base URL |
210
- | `setApiBase` | Function | Override the API base URL |
211
- | `getAuthApiUrl` | Function | Get the auth API URL |
212
- | `getDataApiUrl` | Function | Get the data API URL |
213
- | `getStorageApiUrl` | Function | Get the storage API URL |
214
-
215
- ### Styles (`quickback-better-auth-account-ui/styles.css`)
216
-
217
- The compiled CSS for the Account UI. Must be imported for the UI to render correctly.
218
-
219
- ### Worker (`quickback-better-auth-account-ui/worker`)
220
-
221
- | Export | Type | Description |
222
- |--------|------|-------------|
223
- | `default` | Worker | Cloudflare Worker with SPA routing |
224
- | `createAuthWorker` | Function | Factory for creating a worker instance |
225
-
226
- ## Custom Styles
227
-
228
- Override styles by importing your CSS after the library styles:
229
-
230
- ```ts
231
- import 'quickback-better-auth-account-ui/styles.css';
232
- import './my-overrides.css';
233
- ```
234
-
235
- ```css title="my-overrides.css"
236
- :root {
237
- --primary: 59 130 246;
238
- --primary-foreground: 255 255 255;
239
- }
240
- ```
241
-
242
- ## Updating
243
-
244
- Update to the latest version:
245
-
246
- ```bash
247
- npm update quickback-better-auth-account-ui
248
- ```
249
-
250
- The library follows semantic versioning. Check the [changelog](https://github.com/Kardoe-com/quickback-better-auth-account-ui/releases) for breaking changes.
251
-
252
- ## Next Steps
253
-
254
- - **[Customization](/stack/account-ui/customization)** — Full configuration reference
255
- - **[Feature Flags](/stack/account-ui/features)** — Enable and disable features
256
- - **[Worker Setup](/stack/account-ui/worker)** — Deploy to Cloudflare Workers
257
- - **[With Quickback](/stack/account-ui/with-quickback)** — Quickback-specific configuration
@@ -1,149 +0,0 @@
1
- # Standalone Usage
2
-
3
- Account UI can be used with **any Better Auth-powered backend**, not just Quickback-compiled projects. This makes it a drop-in authentication frontend for any app using Better Auth.
4
-
5
- > **Prefer npm install?**
6
- >
7
- > If you'd rather import Account UI as a library into an existing React app instead of cloning the template, see [Library Usage](/stack/account-ui/library-usage).
8
-
9
-
10
- ## Requirements
11
-
12
- - A backend running [Better Auth](https://better-auth.com) with API endpoints
13
- - Node.js 18+ and npm/pnpm/bun
14
- - A Cloudflare account (for deployment)
15
-
16
- ## Setup
17
-
18
- ### 1. Clone or Install the Account UI
19
-
20
- ```bash
21
- npx degit Kardoe-com/quickback-better-auth-account-ui my-account-app
22
- cd my-account-app
23
- npm install
24
- ```
25
-
26
- ### 2. Configure the Auth Route Mode
27
-
28
- The key difference from Quickback mode is the `VITE_AUTH_ROUTE` variable. Set it to `better-auth` to use Better Auth's default API paths:
29
-
30
- ```bash title=".env"
31
- # Auth route mode — use 'better-auth' for standalone
32
- VITE_AUTH_ROUTE=better-auth
33
-
34
- # Your Better Auth backend URL (single catch-all — see below)
35
- VITE_QUICKBACK_URL=https://secure.example.com
36
-
37
- # Where this Account UI is hosted
38
- VITE_ACCOUNT_APP_URL=https://account.example.com
39
- ```
40
-
41
- `VITE_QUICKBACK_URL` is the recommended one-variable setup. If your API lives on a separate subdomain, set `VITE_QUICKBACK_API_URL` explicitly — it takes precedence.
42
-
43
- This configures the auth client to use `/api/auth` as the base path (Better Auth's default), instead of Quickback's `/auth/v1`.
44
-
45
- ### 3. Configure Your App
46
-
47
- ```bash title=".env"
48
- # App identity
49
- VITE_APP_NAME=My App
50
- VITE_APP_TAGLINE=Welcome to My App
51
-
52
- # Redirect after login
53
- VITE_QUICKBACK_APP_URL=https://app.example.com
54
-
55
- # Feature flags
56
- ENABLE_SIGNUP=true
57
- ENABLE_ORGANIZATIONS=true
58
- ENABLE_PASSKEY=true
59
- ENABLE_EMAIL_OTP=true
60
- ```
61
-
62
- See [Environment Variables](/stack/account-ui/environment-variables) for the complete reference.
63
-
64
- ### 4. Build and Deploy
65
-
66
- ```bash
67
- npm run build
68
- npx wrangler deploy
69
- ```
70
-
71
- ## Auth Route Modes
72
-
73
- Account UI supports three routing modes, controlled by `VITE_AUTH_ROUTE`:
74
-
75
- | Mode | Value | Auth Path | Data Path | Storage Path |
76
- |------|-------|-----------|-----------|--------------|
77
- | Better Auth | `better-auth` | `/api/auth` | — | — |
78
- | Quickback | `quickback` | `/auth/v1` | `/api/v1` | `/storage/v1` |
79
- | Custom | `custom` | Custom | Custom | Custom |
80
-
81
- ### Better Auth Mode (Default)
82
-
83
- Routes all auth requests to `/api/auth/*` — the standard Better Auth convention:
84
-
85
- ```bash
86
- VITE_AUTH_ROUTE=better-auth
87
- ```
88
-
89
- ### Custom Mode
90
-
91
- For non-standard setups, use custom mode with explicit paths:
92
-
93
- ```bash
94
- VITE_AUTH_ROUTE=custom
95
- VITE_AUTH_BASE_PATH=/my-auth
96
- VITE_DATA_BASE_PATH=/my-api
97
- VITE_STORAGE_BASE_PATH=/my-storage
98
- ```
99
-
100
- ## Backend Requirements
101
-
102
- Your Better Auth backend must have the following plugins enabled for full Account UI functionality:
103
-
104
- | Feature | Required Plugin | Required For |
105
- |---------|----------------|--------------|
106
- | Organizations | `organization` | Multi-tenant org management |
107
- | Admin panel | `admin` | User management dashboard |
108
- | API keys | `apiKey` | API key generation UI |
109
- | Passkeys | `@better-auth/passkey` | WebAuthn authentication |
110
- | Email OTP | `emailOTP` | One-time password login |
111
- | CLI login | `deviceAuthorization` | `quickback login` flow |
112
-
113
- Only enable the features that match your backend's plugin configuration. Disable features for plugins you haven't installed:
114
-
115
- ```bash
116
- # If your backend doesn't have the organization plugin:
117
- ENABLE_ORGANIZATIONS=false
118
-
119
- # If you haven't set up passkeys:
120
- ENABLE_PASSKEYS=false
121
- ```
122
-
123
- ## CORS Configuration
124
-
125
- Your Better Auth backend must allow requests from the Account UI's domain. Configure CORS to include:
126
-
127
- ```typescript
128
- // In your Better Auth config
129
- trustedOrigins: [
130
- "https://account.example.com", // Account UI domain
131
- ],
132
- ```
133
-
134
- ## Differences from Quickback Mode
135
-
136
- | Aspect | Standalone | With Quickback |
137
- |--------|-----------|----------------|
138
- | Auth routes | `/api/auth/*` | `/auth/v1/*` |
139
- | Data API | Not used | `/api/v1/*` |
140
- | Storage API | Not used | `/storage/v1/*` |
141
- | File uploads | Manual setup | Auto-configured |
142
- | Backend | Any Better Auth app | Quickback-compiled |
143
-
144
- ## Next Steps
145
-
146
- - [Environment Variables](/stack/account-ui/environment-variables) — Complete configuration reference
147
- - [Customization](/stack/account-ui/customization) — Branding, labels, and theming
148
- - [Worker Setup](/stack/account-ui/worker) — Cloudflare Workers deployment
149
- - [Feature Flags](/stack/account-ui/features) — Enable and disable features