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

[muntaxir4]

User description

Description

@keyshade/schema

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

@keyshade/api-client

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

Related to #519

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 secret types and schemas from api-client to @keyshade/schema.
• Removed secret type definitions from api-client.
• Added new secret schema definitions in @keyshade/schema using zod.
• Updated import statements in api-client to use @keyshade/schema for secret types.
• Added comprehensive tests for the new secret schemas.

---

Changes walkthrough 📝

	Relevant files
Enhancement	secret.ts Update import statements for secret types                                packages/api-client/src/controllers/secret.ts Updated import statements to use @keyshade/schema for secret types. +1/-1      secret.types.d.ts Remove secret type definitions                                                      packages/api-client/src/types/secret.types.d.ts Removed all secret-related type definitions. +0/-124  index.ts Update export for secret schemas                                                  packages/schema/src/index.ts Updated export statement for secret schemas. +2/-1      index.types.ts Update secret type exports                                                              packages/schema/src/index.types.ts Removed direct export of secret schemas. Added export for secret types from secret.types.ts. +2/-3      secret.ts Remove old secret schema definitions                                          packages/schema/src/secret.ts Removed old secret schema definitions. +0/-16    secret.ts Add new secret schema definitions                                                packages/schema/src/secret/secret.ts Added new secret schema definitions using zod. +141/-0  secret.types.ts Add secret type definitions                                                            packages/schema/src/secret/secret.types.ts Added type definitions inferred from secret schemas. +62/-0
Tests	secret.spec.ts Add tests for secret schemas                                                          packages/schema/tests/secret.spec.ts Added comprehensive tests for secret schemas. +490/-22

---

💡 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 secret folder in schema package Added secret.ts with zod schemas Added secret.types.ts with inferred types Updated index.ts exports Updated api-client to use schema types

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

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Schema Validation The SecretSchema allows null values for rotateAt and note fields but doesn't validate their format when non-null. Should add validation for date format and note content. Type Safety The RollBackSecretResponseSchema expects count as string but it represents a numeric value. Consider using number type instead for better type safety.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Security	Add length validation constraints for secret values to enforce security requirements Add validation for minimum length and maximum length constraints on the secret value field to ensure secrets meet security requirements and prevent oversized secrets. packages/schema/src/secret/secret.ts [22] -value: z.string(), +value: z.string().min(1).max(4096), Apply this suggestion Suggestion importance[1-10]: 9 Why: Adding length constraints for secret values is crucial for security and system stability. This prevents empty secrets and oversized values that could cause system issues.	9
	Add validation rules for secret names to prevent sensitive data exposure Add validation to ensure the secret name doesn't contain sensitive information by restricting special characters and enforcing a maximum length. packages/schema/src/secret/secret.ts [7] -name: z.string(), +name: z.string().regex(/^[a-zA-Z0-9_-]+$/).max(64), Apply this suggestion Suggestion importance[1-10]: 8 Why: Restricting secret names to alphanumeric characters and reasonable length prevents accidental exposure of sensitive data and ensures consistent naming conventions.	8
Best practice	Add maximum length constraint for note field to prevent abuse Add validation to ensure the note field has a reasonable maximum length to prevent potential abuse. packages/schema/src/secret/secret.ts [12] -note: z.string().nullable(), +note: z.string().max(1000).nullable(), Apply this suggestion Suggestion importance[1-10]: 6 Why: Setting a maximum length for the note field prevents potential abuse and ensures database efficiency, while still allowing sufficient space for meaningful documentation.	6

💡 Need additional feedback ? start a PR chat