feat(schema, api-client): Migrate auth types to @keyshade/schema

[muntaxir4]

User description

Description

@keyshade/schema:

• Add schemas for auth.
• Update workspace's deleteResponse schema to have void type and add a test for it. Also add id's to GlobalSearchRespone Schema and update corresponding tests.
• Export types for auth, workspace and pagination from index.types.ts.
• Migrate existing index.types.d.ts to index.types.ts due to typescript ignoring .d.ts.

@keyshade/api-client:

• Import new auth schema types from @keyshade/schema
• Change imports for existing workspace and pagination types to @keyshade/schema
• Remove existing index.types and auth.types from api-client'
• Modify tsconfig for external module imports.
  

Related to #519

Dependencies

Mention any dependencies/packages used

Future Improvements

Mention any improvements to be done in future related to any file/feature

Mentions

Mention and tag the people

Screenshots of relevant screens

Add screenshots of relevant screens

Developer's checklist

• My PR follows the style guidelines of this project
• I have performed a self-check on my work

If changes are made in the code:

• I have followed the coding guidelines
• My changes in code generate no new warnings
• My changes are breaking another fix/feature of the project
• I have added test cases to show that my feature works
• I have added relevant screenshots in my PR
• There are no UI/UX issues

Documentation Update

• This PR requires an update to the documentation at docs.keyshade.xyz
• I have made the necessary updates to the documentation, or no documentation changes are required.

---

PR Type

enhancement, tests

---

Description

• Migrated auth types to @keyshade/schema and updated all relevant imports in the api-client package.
• Added ResendOTPRequestSchema and ResendOTPResponseSchema in the schema package using zod.
• Removed deprecated type definitions from api-client and replaced them with imports from @keyshade/schema.
• Added tests for new auth schemas to ensure validation correctness.
• Updated workspace schema to use z.void() for DeleteWorkspaceResponseSchema and added id fields to various response schemas.

---

Changes walkthrough 📝

	Relevant files
Enhancement	19 files auth.ts Update auth controller to use schema package                          packages/api-client/src/controllers/auth.ts Updated imports to use @keyshade/schema for ResendOTPRequest and ResendOTPResponse. Removed deprecated imports from @api-client/types. +2/-5      environment.ts Update environment controller to use schema package            packages/api-client/src/controllers/environment.ts Updated import for ClientResponse to use @keyshade/schema. +1/-1      event.ts Update event controller to use schema package                        packages/api-client/src/controllers/event.ts Updated import for ClientResponse to use @keyshade/schema. +1/-1      integration.ts Update integration controller to use schema package            packages/api-client/src/controllers/integration.ts Updated import for ClientResponse to use @keyshade/schema. +1/-1      project.ts Update project controller to use schema package                    packages/api-client/src/controllers/project.ts Updated import for ClientResponse to use @keyshade/schema. +1/-1      secret.ts Update secret controller to use schema package                      packages/api-client/src/controllers/secret.ts Updated import for ClientResponse to use @keyshade/schema. +1/-1      user.ts Update user controller to use schema package                          packages/api-client/src/controllers/user.ts Updated import for ClientResponse to use @keyshade/schema. +1/-1      variable.ts Update variable controller to use schema package                  packages/api-client/src/controllers/variable.ts Updated import for ClientResponse to use @keyshade/schema. +1/-1      workspace-membership.ts Update workspace membership controller to use schema package packages/api-client/src/controllers/workspace-membership.ts Updated import for ClientResponse to use @keyshade/schema. +1/-1      workspace-role.ts Update workspace role controller to use schema package      packages/api-client/src/controllers/workspace-role.ts Updated import for ClientResponse to use @keyshade/schema. +1/-1      pagination-parser.ts Update pagination parser to use schema package                      packages/api-client/src/core/pagination-parser.ts Updated import for PageRequest to use @keyshade/schema. +1/-1      response-parser.ts Update response parser to use schema package                          packages/api-client/src/core/response-parser.ts Updated imports for ClientResponse and ResponseError to use @keyshade/schema. +1/-1      auth.types.ts Remove deprecated auth types                                                          packages/api-client/src/types/auth.types.ts Removed ResendOTPRequest and ResendOTPResponse interfaces. +0/-4      index.types.ts Remove deprecated index types                                                        packages/api-client/src/types/index.types.ts Removed all type definitions, now imported from @keyshade/schema. +0/-36    auth.ts Add auth schemas using zod                                                              packages/schema/src/auth/auth.ts Added ResendOTPRequestSchema and ResendOTPResponseSchema using zod. +5/-0      auth.types.ts Add auth type exports                                                                        packages/schema/src/auth/auth.types.ts Added type exports for ResendOTPRequest and ResendOTPResponse. +6/-0      index.ts Export auth schemas and types                                                        packages/schema/src/index.ts Exported auth schemas and types. +4/-0      index.types.d.ts Add T-prefixed type exports for auth and workspace              packages/schema/src/index.types.d.ts Added T-prefixed type exports for auth and workspace types. +49/-7    workspace.ts Update workspace schemas and add id fields                              packages/schema/src/workspace/workspace.ts Updated DeleteWorkspaceResponseSchema to use z.void(). Added id field to various response schemas. +5/-1
Tests	2 files auth.spec.ts Add tests for auth schemas                                                              packages/schema/tests/auth.spec.ts Added tests for ResendOTPRequestSchema and ResendOTPResponseSchema. +37/-0    workspace.spec.ts Add test for workspace delete response schema                        packages/schema/tests/workspace.spec.ts Added test for DeleteWorkspaceResponseSchema. +6/-0

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis 🔶 519 - Partially compliant Fully compliant requirements: Created auth module folder with auth.ts and auth.types.ts Moved auth types from api-client to schema package Updated api-client to use types from schema package Not compliant requirements: Still need to implement for remaining modules: User, Project, Environment, Secret, Variable, Event, Integration

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Type Validation Verify that ResendOTPRequestSchema email validation is sufficient - currently only validates string type without email format check Schema Consistency Verify that adding id fields to response schemas aligns with API contract and other module schemas

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Possible issue	✅ Add validation to ensure email addresses are properly formatted Add email format validation to ensure the userEmail is a valid email address. packages/schema/src/auth/auth.ts [3] -export const ResendOTPRequestSchema = z.object({ userEmail: z.string() }) +export const ResendOTPRequestSchema = z.object({ userEmail: z.string().email() }) [Suggestion has been applied] Suggestion importance[1-10]: 9 Why: Email validation is essential for security and data integrity. Without proper validation, invalid email addresses could cause issues with OTP delivery and authentication.	9
Best practice	Add input validation constraints to prevent performance issues from unbounded search queries Add validation for the search query length in GlobalSearchRequestSchema to prevent overly long search queries that could impact performance. packages/schema/src/workspace/workspace.ts [115-118] export const GlobalSearchRequestSchema = z.object({ workspaceSlug: z.string(), - search: z.string() + search: z.string().min(1).max(100) }) Apply this suggestion Suggestion importance[1-10]: 8 Why: Adding length constraints to search queries is crucial for preventing performance degradation and potential DoS attacks. The suggestion helps protect the API from resource exhaustion.	8

💡 Need additional feedback ? start a PR chat

[rajdip-b]

The test is failing. Did you try to implement the fix you talked about? Rest looks good.

[muntaxir4]

The test is failing. Did you try to implement the fix you talked about? Rest looks good.

Yeah, the fix is almost done.

[rajdip-b]

All the changes LGTM