feat(schema, api-client): Migrate user types and schemas to @keyshade/schema

[muntaxir4]

User description

Description

@keyshade/schema

• Add schemas and types for user.
• Add tests for user schemas.
• Export user schemas from index and its types from index.types

@keyshade/api-client

• Remove existing user.types.
• Change imports for user types to @keyshade/schema.
  

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 user types and schemas from api-client to @keyshade/schema.
• Updated UserController in api-client to use types from @keyshade/schema.
• Removed user type definitions from api-client.
• Added Zod schemas and inferred types for user-related data in @keyshade/schema.
• Added comprehensive tests for user schemas in @keyshade/schema.

---

Changes walkthrough 📝

	Relevant files
Enhancement	user.ts Update user controller to use schema package                          packages/api-client/src/controllers/user.ts Updated import statements to use @keyshade/schema. Removed imports from @api-client/types/user.types. +1/-1      user.types.d.ts Remove user types from api-client                                                packages/api-client/src/types/user.types.d.ts Removed all user-related type definitions. +0/-33    index.ts Export user schemas from schema index                                        packages/schema/src/index.ts Added export for user schemas. +5/-2      index.types.ts Export user types from schema index                                            packages/schema/src/index.types.ts Added export for user types. +3/-0      user.ts Add user schemas to schema package                                              packages/schema/src/user/user.ts Added Zod schemas for user-related requests and responses. +42/-0    user.types.ts Add user types to schema package                                                  packages/schema/src/user/user.types.ts Added inferred types from user schemas. +38/-0
Tests	user.spec.ts Add tests for user schemas                                                              packages/schema/tests/user.spec.ts Added tests for user-related schemas. +181/-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 - Fully compliant Compliant requirements: Created user folder in schema package Added user.ts with zod schemas Added user.types.ts with inferred types Updated index.ts exports Updated api-client to use schema types

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

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Schema Validation Verify that the email validation in GetSelfResponseSchema and UpdateSelfRequestSchema follows security best practices and handles all edge cases

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Enhancement	✅ Add length validation constraints to string fields to ensure data integrity Add minimum and maximum length constraints to the OTP string validation to ensure it matches your application's OTP format requirements. packages/schema/src/user/user.ts [31-33] export const ValidateEmailChangeOTPRequestSchema = z.object({ - otp: z.string() + otp: z.string().min(6).max(6) }) [Suggestion has been applied] Suggestion importance[1-10]: 8 Why: Adding specific length constraints for OTP validation is crucial for security and data integrity, as it ensures the OTP matches the expected format and prevents potential validation bypass.	8
Possible issue	Add URL format validation to ensure valid URL inputs Add URL validation for the profilePictureUrl field to ensure it contains a valid URL format. packages/schema/src/user/user.ts [16-21] export const UpdateSelfRequestSchema = z.object({ name: z.string().optional(), - profilePictureUrl: z.string().optional(), + profilePictureUrl: z.string().url().optional(), isOnboardingFinished: z.boolean().optional(), email: z.string().email().optional() }) Apply this suggestion Suggestion importance[1-10]: 8 Why: Adding URL validation for profile picture URLs is essential for preventing invalid data and potential security issues related to malformed URLs.	8
Best practice	Add input validation constraints to prevent invalid data lengths Add string length constraints to the name field to prevent extremely long or empty names. packages/schema/src/user/user.ts [16-21] export const UpdateSelfRequestSchema = z.object({ - name: z.string().optional(), + name: z.string().min(1).max(100).optional(), profilePictureUrl: z.string().optional(), isOnboardingFinished: z.boolean().optional(), email: z.string().email().optional() }) Apply this suggestion Suggestion importance[1-10]: 7 Why: Adding length constraints for the name field is important to prevent data issues and potential abuse, ensuring the stored names are reasonable and manageable.	7

💡 Need additional feedback ? start a PR chat