Api Keys

[bazumo]

---

Important

Introduces API key management for users and teams, integrating with existing project configurations and permissions, and adds comprehensive tests and examples.

• API Key Management:
  • Introduces ProjectApiKey model in schema.prisma for managing API keys.
  • Adds createApiKeyHandlers in handlers.tsx to handle API key CRUD operations.
  • Implements API key creation, revocation, and validation logic.
• Permissions and Configurations:
  • Adds allowUserApiKeys and allowTeamApiKeys to ProjectConfig in schema.prisma.
  • Updates TeamSystemPermission enum to include MANAGE_API_KEYS.
  • Ensures API key operations respect project configurations and user/team permissions.
• Testing and Examples:
  • Adds extensive tests in api-keys.test.ts to cover various API key scenarios.
  • Updates example projects to demonstrate API key usage.
• Miscellaneous:
  • Refactors existing code to integrate API key functionalities.
  • Updates documentation and type definitions to reflect new API key features.

^{This description was created by for 96f60c5. It will automatically update as commits are pushed.}

[vercel]

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	Apr 4, 2025 7:03pm
stack-dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 4, 2025 7:03pm
stack-demo	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 4, 2025 7:03pm

[recurseml]

⚠️ Only 50 files will be analyzed due to processing limits.

[recurseml]

😱 Found 7 issues. 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.

📚 Relevant Docs

• 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')

📚 Relevant Docs

• 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.

📚 Relevant Docs

• '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.

📚 Relevant Docs

• 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.

📚 Relevant Docs

[fomalhautb]

Did finish reviewing everything, but left some comments now

[fomalhautb]

Can you add e2e tests for client library?

[bazumo]

@fomalhautb can you think of any tests that are missing?

[N2D4]

I like about this PR that 2/3s of its LOC are tests

@fomalhautb waiting for your review too, but after fixing the comments here LGTM