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

[muntaxir4]

User description

Description

@keyshade/schema

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

@keyshade/api-client

• Remove existing integration.types.d.ts.
• Change imports for integration 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 integration schemas and types to the @keyshade/schema package.
• Updated api-client to import integration types from @keyshade/schema.
• Removed deprecated integration.types.d.ts file from api-client.
• Added new integration schemas and types in the schema package.
• Implemented comprehensive tests for the new integration schemas.
• Refactored ProjectSchema to use a base schema for consistency.

---

Changes walkthrough 📝

	Relevant files
Enhancement	integration.ts Update integration type imports to use schema package        packages/api-client/src/controllers/integration.ts Updated import paths for integration types to use @keyshade/schema. +1/-1      integration.types.d.ts Remove deprecated integration types file                                  packages/api-client/src/types/integration.types.d.ts Removed the entire file as integration types are now in @keyshade/schema. +0/-89    index.types.ts Export integration types from new module                                  packages/schema/src/index.types.ts Exported integration types from the new integration module. +1/-4      index.ts Add integration schemas for requests and responses              packages/schema/src/integration/index.ts Added new integration schemas including request and response schemas. +64/-0    index.types.ts Add type definitions for integration schemas                          packages/schema/src/integration/index.types.ts Added type definitions inferred from integration schemas. +54/-0    index.ts Refactor ProjectSchema to use BaseProjectSchema                    packages/schema/src/project/index.ts Refactored ProjectSchema to use BaseProjectSchema. +22/-22
Bug fix	user.ts Correct URL path in validateEmailChangeOTP method                packages/api-client/src/controllers/user.ts Fixed URL path in validateEmailChangeOTP method. +1/-1
Tests	integration.spec.ts Add tests for integration schemas and types                            packages/schema/tests/integration.spec.ts Added comprehensive tests for integration schemas. Included validation tests for all integration schema types. +347/-10

---

💡 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 integration folder with schema and types files Added zod schemas for integration base type, requests and responses Added type exports in integration/index.types.ts Updated api-client to use types from schema package

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

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Schema Validation Verify that the metadata field validation in IntegrationSchema is sufficient for all integration types, as it currently accepts any string key-value pairs Type Safety The UpdateIntegrationRequestSchema makes all fields optional which could lead to empty update requests. Consider adding validation for minimum required fields

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Security	Move sensitive data from URL query parameters to request body Pass the OTP value in the request body instead of as a query parameter to avoid exposing sensitive data in URLs and server logs. packages/api-client/src/controllers/user.ts [48] const response = await this.apiClient.post( - `/api/user/validate-email-change-otp?otp=${request.otp}`, - request, + '/api/user/validate-email-change-otp', + { ...request, otp: request.otp }, headers ) Apply this suggestion Suggestion importance[1-10]: 9 Why: Moving OTP from URL query parameters to request body is a critical security improvement, as sensitive data in URLs can be exposed in logs and browser history.	9
General	Add validation to prevent empty string values in metadata records Add validation to ensure metadata values are not empty strings, as empty metadata values could cause issues with integrations. packages/schema/src/integration/index.ts [12] export const IntegrationSchema = z.object({ - metadata: z.record(z.string()), + metadata: z.record(z.string().min(1)), }) Apply this suggestion Suggestion importance[1-10]: 7 Why: Adding validation to prevent empty metadata values is important for data integrity and preventing potential integration issues. Empty strings could cause problems with integration functionality.	7

💡 Need additional feedback ? start a PR chat