feat(api-client): Added workspace role controller

[rajdip-b]

User description

Description

Fixes #355

---

PR Type

Enhancement, Tests

---

Description

• Implemented a new WorkspaceRoleController to manage workspace roles, including methods for creating, updating, deleting, and fetching roles.
• Defined TypeScript types for workspace role operations, ensuring type safety and clarity in API interactions.
• Added comprehensive tests for the WorkspaceRoleController, covering all CRUD operations and role existence checks.
• Updated Jest configuration to focus on workspace role tests, ensuring targeted and efficient test execution.

---

Changes walkthrough 📝

	Relevant files
Enhancement	workspace-role.ts Implement Workspace Role Controller with CRUD operations  packages/api-client/src/controllers/workspace-role.ts Added WorkspaceRoleController class for managing workspace roles. Implemented methods for creating, updating, deleting, and fetching workspace roles. Included method to check if a workspace role exists. +102/-0  workspace-role.types.d.ts Define Types for Workspace Role Operations                              packages/api-client/src/types/workspace-role.types.d.ts Defined types for workspace role requests and responses. Included interfaces for creating, updating, and deleting workspace roles. Added interfaces for checking existence and fetching workspace roles. +68/-0
Tests	workspace-role.spec.ts Add Tests for Workspace Role Controller                                    packages/api-client/tests/workspace-role.spec.ts Added tests for WorkspaceRoleController methods. Tested CRUD operations and existence check for workspace roles. Ensured proper setup and teardown of test data. +180/-0
Configuration changes	jest.config.ts Update Jest Configuration for Workspace Role Tests              packages/api-client/jest.config.ts Updated test match pattern to focus on workspace role tests. +1/-1

---

💡 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: 3 🔵🔵🔵⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Key issues to review Error Handling The controller methods don't include explicit error handling. Consider adding try-catch blocks or error handling middleware to manage potential API errors gracefully. Code Duplication The API endpoint construction is repeated in each method. Consider extracting this logic into a separate method to improve maintainability. Test Data Management The test suite creates and deletes test data in beforeAll/afterAll hooks. Consider using a separate test database or mocking the API calls to avoid potential side effects.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Maintainability	✅ Correct the typo in the type name for consistency Suggestion Impact: The typo in the type name CheckWOrkspaceRoleExistsRequest was corrected to CheckWorkspaceRoleExistsRequest. code diff: - CheckWOrkspaceRoleExistsRequest + CheckWorkspaceRoleExistsRequest } from '@api-client/types/workspace-role.types' export default class WorkspaceRoleController { @@ -62,7 +63,7 @@ } async checkWorkspaceRoleExists( - request: CheckWOrkspaceRoleExistsRequest, + request: CheckWorkspaceRoleExistsRequest, The checkWorkspaceRoleExists method has a typo in the type name CheckWOrkspaceRoleExistsRequest. This should be corrected to maintain consistency and avoid potential issues. packages/api-client/src/controllers/workspace-role.ts [64-67] async checkWorkspaceRoleExists( - request: CheckWOrkspaceRoleExistsRequest, + request: CheckWorkspaceRoleExistsRequest, headers?: Record<string, string> ): Promise<ClientResponse<CheckWorkspaceRoleExistsResponse>> { Apply this suggestion Suggestion importance[1-10]: 9 Why: Correcting the typo in the type name is crucial for consistency and avoiding potential bugs, making this a high-priority fix.	9
Best practice	✅ Use a more robust method for constructing URLs with query parameters The getWorkspaceRolesOfWorkspace method constructs the URL manually, which can be error-prone. Consider using a URL builder library or a helper function to construct the URL with query parameters more safely and efficiently. packages/api-client/src/controllers/workspace-role.ts [92-98] -let url = `/api/workspace-role/${request.workspaceSlug}/all?` -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 queryParams = new URLSearchParams({ + ...(request.page && { page: request.page.toString() }), + ...(request.limit && { limit: request.limit.toString() }), + ...(request.sort && { sort: request.sort }), + ...(request.order && { order: request.order }), + ...(request.search && { search: request.search }), +}); +const url = `/api/workspace-role/${request.workspaceSlug}/all?${queryParams}`; const response = await this.apiClient.get(url, headers) [Suggestion has been applied] Suggestion importance[1-10]: 8 Why: Using a URL builder library or helper function reduces the risk of errors in URL construction, improving code reliability and readability. This is a significant improvement in best practices.	8
	✅ Improve null value handling in test suite Suggestion Impact: The non-null assertion was removed from the workspaceSlug assignment, which aligns with the suggestion to handle potential null values more robustly. code diff: - workspaceSlug: workspaceSlug!, + workspaceSlug, The test suite is using non-null assertions (!) frequently. Consider using a more robust approach to handle potential null values, such as conditional checks or throwing meaningful errors if the values are unexpectedly null. packages/api-client/tests/workspace-role.spec.ts [38-45] +if (!workspaceSlug) { + throw new Error('Workspace slug is null or undefined'); +} const createWorkspaceRoleRequest: CreateWorkspaceRoleRequest = { - workspaceSlug: workspaceSlug!, + workspaceSlug: workspaceSlug, name: 'Developer', description: 'Role for developers', colorCode: '#FF0000', authorities: ['READ_WORKSPACE', 'READ_PROJECT'], projectSlugs: [] } Apply this suggestion Suggestion importance[1-10]: 6 Why: This suggestion enhances the robustness of the test suite by handling potential null values more explicitly, which is a good practice but not critical for the test's functionality.	6
Error handling	Implement more specific error handling for API responses Consider using a more specific error handling mechanism instead of relying on the generic parseResponse function. This could involve creating custom error classes for different types of API errors and handling them explicitly in the controller methods. packages/api-client/src/controllers/workspace-role.ts [36] -return await parseResponse<CreateWorkspaceRoleResponse>(response) +try { + return await parseResponse<CreateWorkspaceRoleResponse>(response); +} catch (error) { + if (error instanceof ApiError) { + // Handle specific API errors + throw new WorkspaceRoleError(error.message); + } + throw error; +} Apply this suggestion Suggestion importance[1-10]: 7 Why: This suggestion improves error handling by introducing specific error classes, which enhances code robustness and maintainability. However, it is not critical for functionality, hence a moderate score.	7

[rajdip-b]

🎉 This PR is included in version 2.5.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀