Better dashboard onboarding process
[!IMPORTANT] Enhance dashboard onboarding with setup instructions and metrics visualization, and update backend for setup code handling.
- Backend:
- Add
SETUPtoVerificationCodeTypeinschema.prisma.- Create
setup-code-handler.tsxfor generating setup codes withcreateVerificationCodeHandler.- Add
route.tsxandverify/route.tsxfor handling setup key requests.- Dashboard:
- Add
SetupPageinsetup-page.tsxfor onboarding new users with setup instructions.- Modify
MetricsPageinmetrics-page.tsxto display user metrics.- Use
useThemeWatcheringlobe.tsxfor theme-based globe rendering.- Add
globeImagesinutils.tsxfor light and dark mode globe images.- Update
PageClientinpage-client.tsxto conditionally renderSetupPageorMetricsPagebased on user count.- Update
layout.tsxto removeOnboardingDialog.- Init-Stack:
- Add
--api-urland--tokenoptions to CLI inindex.ts.- Implement
fetchKeysandwriteEnvVarsto handle API keys and environment variables.This description was created by
for 2bba7356835303b62bfb16ea76793df03ee22433. It will automatically update as commits are pushed.
The latest updates on your projects. Learn more about Vercel for Git ↗︎
| Name | Status | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| stack-backend | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Jun 6, 2025 6:24am |
| stack-dashboard | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Jun 6, 2025 6:24am |
| stack-demo | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Jun 6, 2025 6:24am |
⚠️ Only 5 files will be analyzed due to processing limits.
😱 Found 1 issue. Time to roll up your sleeves! 😱
🗒️ View all ignored comments in this repo
- The constraint 'TokenStoreType extends string' is too restrictive. It should likely be 'TokenStoreType extends string | object' to match the condition check in line 113 where TokenStoreType is checked against {}
- Return type mismatch - the interface declares useUsers() returning ServerUser[] but the Team interface that this extends declares useUsers() returning TeamUser[]
- There is a syntax error in the super constructor call due to the ellipsis operator used incorrectly. Objects aren't being merged correctly. This syntax usage can lead to runtime errors when trying to pass the merged object to 'super()'. Verify that the intended alterations to the object occur before or outside of the super() call if needed.
- Throwing an error when no active span is found is too aggressive. The log function should gracefully fallback to console.log or another logging mechanism when there's no active span, since not all execution contexts will have an active span. This makes the code less resilient and could break functionality in non-traced environments.
- Function sets backendContext with a new configuration but doesn't pass 'defaultProjectKeys'. Since defaultProjectKeys is required in the type definition and cannot be updated (throws error if tried to set), this will cause a type error.
- The schema is using array syntax for pick() which is incorrect for Yup schemas. The pick() method in Yup expects individual arguments, not an array. Should be changed to: emailConfigSchema.pick('type', 'host', 'port', 'username', 'sender_name', 'sender_email')
- Creating a refresh token with current timestamp as expiration means it expires immediately. Should set a future date for token expiration.
- The 'tools' object is initialized as an empty object, even though 'tools' is presumably expected to contain tool definitions. This could cause the server capabilities to lack necessary tool configurations, thus potentially impacting functionalities that depend on certain tool setups.
- 'STACK_SECRET_SERVER_KEY' is potentially being included in every request header without checking its existence again here. Although it's checked during initialization, this could lead to security issues as it's exposed in all communications where the header is logged or captured.
- When adding 'use client' directive at the beginning, it doesn't check if file.text already contains the 'use client' directive. This could lead to duplicate 'use client' directives if the file already has one.
Documentation Changes Required
-
packages/init-stack/README.md
- Update the Options section to include new command line options:
- `--api-url <url>`: Stack Auth API URL - `--token <token>`: Token to fetch Stack Auth keys - These new options allow programmatic access to fetch Stack Auth keys without manual intervention through the browser, which is relevant for automation scenarios.
- Update the Options section to include new command line options:
-
StackAdminApp Type
- Add a new method to the StackAdminApp type:
createSetupCode(): Promise<{ code: string }>
- Add a new method to the StackAdminApp type:
-
_StackAdminAppImplIncomplete
- Implement the new
createSetupCode()method that calls the interface'screateSetupCode()method and returns its response.
- Implement the new
-
Reordering of Imports
- In
packages/stack-ui/src/components/copy-button.tsx, move 'forwardRefIfNeeded' before other imports. - In files related to AdminProject* and AdminTeam*, reorder the imports (non-functional change).
- In
Note: Several files were analyzed and found to require no changes, including internal API endpoints, UI changes, and implementation details that don't affect public SDK or documentation.