feat(api-client): Create controller for Integration module

[vr-varad]

User description

Description

Api-client Controller for Integration

Fixes #353

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

---

Description

• Created IntegrationController class in integration.ts with static methods for creating, updating, retrieving, and deleting integrations.
• Added TypeScript interfaces in integrayion.types.d.ts for request and response types related to integration operations.

---

Changes walkthrough 📝

Relevant files

Enhancement

integration.ts Added IntegrationController with CRUD methods                        packages/api-client/src/controllers/integration/integration.ts Created IntegrationController class with static methods for CRUD operations. Imported client from '../../client'. +11/-0    integrayion.types.d.ts Added TypeScript interfaces for integration operations      packages/api-client/src/types/integrayion.types.d.ts Defined interfaces for request and response types for integration operations. +19/-0

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review Empty Methods The methods createIntegration, updateIntegration, getIntegration, getAllIntegrations, and deleteIntegration are defined but not implemented. This could be intentional for a stub implementation, but it's important to either implement these or provide a clear TODO comment if they are to be completed in the future.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	✅ Define method parameters and return types for better type safety Suggestion Impact: The commit added method parameters and return types to the methods in IntegrationController, enhancing type safety and clarifying the expected inputs and outputs. code diff: - static async createIntegration() {} - static async updateIntegration() {} - static async getIntegration() {} - static async getAllIntegrations() {} - static async deleteIntegration() {} + static async createIntegration( + request: CreateIntegrationRequest, + headers?: Record<string, string> + ): Promise<CreateIntegrationResponse> { + return this.apiClient.post( + `api/integration/${request.workspaceId}`, + request, + headers + ) + } + + static async updateIntegration( + request: UpdateIntegrationRequest, + headers?: Record<string, string> + ): Promise<UpdateIntegrationResponse> { + return this.apiClient.put( + `/api/integration/${request.workspaceId}`, + request, + headers + ) + } + + static async getIntegration( + request: GetIntegrationRequest, + headers?: Record<string, string> + ): Promise<GetIntegrationResponse> { + return this.apiClient.get( + `/api/integration/${request.integrationId}`, + headers + ) + } + + static async getAllIntegrations( + request: GetAllIntegrationRequest, + headers?: Record<string, string> + ): Promise<GetAllIntegrationResponse> { + let url = `/api/integration/all/${request.workspaceId}` + request.page && (url += `page=${request.page}&`) + request.limit && (url += `limit=${request.limit}&`) + request.sort && (url += `sort=${request.sort}&`) + request.order && (url += `order=${request.order}&`) + request.search && (url += `search=${request.search}&`) + + return this.apiClient.get(url, headers) + } + + static async deleteIntegration( + request: DeleteIntegrationRequest, + headers?: Record<string, string> + ): Promise<DeleteIntegrationResponse> { + return this.apiClient.delete( + `/api/integration/${request.integrationId}`, + headers + ) + } Consider adding method parameters and return types to the methods in IntegrationController to enhance type safety and clarify the expected inputs and outputs. packages/api-client/src/controllers/integration/integration.ts [6-10] -static async createIntegration() {} -static async updateIntegration() {} -static async getIntegration() {} -static async getAllIntegrations() {} -static async deleteIntegration() {} +static async createIntegration(data: CreateIntegrationRequest): Promise<CreateIntegrationResponse> {} +static async updateIntegration(data: UpdateIntegrationRequest): Promise<UpdateIntegrationResponse> {} +static async getIntegration(id: string): Promise<GetIntegrationResponse> {} +static async getAllIntegrations(): Promise<GetAllIntegrationResponse[]> {} +static async deleteIntegration(id: string): Promise<DeleteIntegrationResponse> {} Apply this suggestion Suggestion importance[1-10]: 9 Why: Adding method parameters and return types enhances type safety and clarifies the expected inputs and outputs, significantly improving code robustness and readability.	9
Possible bug	✅ Add initialization check for apiClient Suggestion Impact: The suggestion led to the initialization of the apiClient within the constructor of the IntegrationController class, ensuring it is properly set up before use. code diff: - private static apiClient = client + private apiClient: APIClient - static async createIntegration() {} - static async updateIntegration() {} - static async getIntegration() {} - static async getAllIntegrations() {} - static async deleteIntegration() {} + constructor(private readonly backendUrl: string) { + this.apiClient = new APIClient(this.backendUrl) Ensure that the apiClient is properly initialized before using it in the IntegrationController methods to avoid runtime errors. packages/api-client/src/controllers/integration/integration.ts [4] -private static apiClient = client +private static apiClient = client || throw new Error('ApiClient is not initialized'); Apply this suggestion Suggestion importance[1-10]: 8 Why: Ensuring apiClient is properly initialized before use can prevent potential runtime errors, which is crucial for the stability of the application.	8
Maintainability	Add implementation or placeholder comments to empty methods Consider implementing actual logic inside the methods of IntegrationController or at least adding a placeholder comment to indicate that implementation is pending. This will help other developers understand that these methods are not yet functional. packages/api-client/src/controllers/integration/integration.ts [6-10] -static async createIntegration() {} -static async updateIntegration() {} -static async getIntegration() {} -static async getAllIntegrations() {} -static async deleteIntegration() {} +static async createIntegration() { + // TODO: Implement this method +} +static async updateIntegration() { + // TODO: Implement this method +} +static async getIntegration() { + // TODO: Implement this method +} +static async getAllIntegrations() { + // TODO: Implement this method +} +static async deleteIntegration() { + // TODO: Implement this method +} Apply this suggestion Suggestion importance[1-10]: 7 Why: Adding placeholder comments helps other developers understand that the methods are not yet implemented, improving code maintainability and clarity.	7
Best practice	✅ Convert static methods to instance methods for better flexibility Suggestion Impact: The static methods in the IntegrationController were converted to instance methods, aligning with the suggestion to use instance methods for better flexibility. code diff: export default class IntegrationController { - private static apiClient = client + private apiClient: APIClient - static async createIntegration() {} - static async updateIntegration() {} - static async getIntegration() {} - static async getAllIntegrations() {} - static async deleteIntegration() {} + constructor(private readonly backendUrl: string) { + this.apiClient = new APIClient(this.backendUrl) + } + + async createIntegration( + request: CreateIntegrationRequest, + headers?: Record<string, string> + ): Promise<ClientResponse<CreateIntegrationResponse>> { + const response = await this.apiClient.post( + `/api/integration/${request.workspaceId}`, + request, + headers + ) + return await parseResponse<CreateIntegrationResponse>(response) + } + + async updateIntegration( + request: UpdateIntegrationRequest, + headers?: Record<string, string> + ): Promise<ClientResponse<UpdateIntegrationResponse>> { + const response = await this.apiClient.put( + `/api/integration/${request.integrationId}`, + request, + headers + ) + return await parseResponse<UpdateIntegrationResponse>(response) + } + + async getIntegration( + request: GetIntegrationRequest, + headers?: Record<string, string> + ): Promise<ClientResponse<GetIntegrationResponse>> { + const response = await this.apiClient.get( + `/api/integration/${request.integrationId}`, + headers + ) + return await parseResponse<GetIntegrationResponse>(response) + } + + async getAllIntegrations( + request: GetAllIntegrationRequest, + headers?: Record<string, string> + ): Promise<ClientResponse<GetAllIntegrationResponse>> { + let url = `/api/integration/all/${request.workspaceId}` + request.page && (url += `page=${request.page}&`) + request.limit && (url += `limit=${request.limit}&`) + request.sort && (url += `sort=${request.sort}&`) + request.order && (url += `order=${request.order}&`) + request.search && (url += `search=${request.search}&`) + + const response = await this.apiClient.get(url, headers) + return await parseResponse<GetAllIntegrationResponse>(response) + } + + async deleteIntegration( + request: DeleteIntegrationRequest, + headers?: Record<string, string> + ): Promise<ClientResponse<DeleteIntegrationResponse>> { + const response = await this.apiClient.delete( + `/api/integration/${request.integrationId}`, + headers + ) + return await parseResponse<DeleteIntegrationResponse>(response) + } It is recommended to use instance methods rather than static methods for the IntegrationController unless there is a specific reason to prefer static methods. This allows easier management of state and dependencies if needed in the future. packages/api-client/src/controllers/integration/integration.ts [6-10] -static async createIntegration() {} -static async updateIntegration() {} -static async getIntegration() {} -static async getAllIntegrations() {} -static async deleteIntegration() {} +async createIntegration() {} +async updateIntegration() {} +async getIntegration() {} +async getAllIntegrations() {} +async deleteIntegration() {} Apply this suggestion Suggestion importance[1-10]: 6 Why: Using instance methods can provide better flexibility for managing state and dependencies, but the necessity depends on the specific use case of the controller.	6

[rajdip-b]

I found quite a few type errors in your code. Please refer to the DTOs of the specific controllers and get them fixed in the input. as for the output, we dont have postman updated for this, so you would need to test it.

[rajdip-b]

Include the IntegrationController in index.ts exports list

[rajdip-b]

@vr-varad Hey bro, any updates?