feat(api-client): Get all workspace invitation

[Souvik9205]

User description

Description

Api client update to get all workspace invitation

Fixes #553

I am not too much sure about the changes, like for the URL, i take reference form #586 api-collection url -

get {
  url: {{BASE_URL}}/api/workspace/invitations?page=0&limit=10

etc. So I am open to changes :)

---

PR Type

Enhancement, Tests

---

Description

• Added a new API method getWorkspaceInvitations to fetch workspace invitations.

• Implemented query parameter handling for pagination, sorting, and searching.

• Added a test case to validate the getWorkspaceInvitations functionality.

• Ensured response parsing and metadata validation in the test case.

---

Changes walkthrough 📝

	Relevant files
Enhancement	workspace.ts Add `getWorkspaceInvitations` method in WorkspaceController packages/api-client/src/controllers/workspace.ts Added getWorkspaceInvitations method to fetch workspace invitations. Implemented query parameter handling for pagination and filtering. Integrated response parsing for the new API endpoint. +30/-1
Tests	workspace.spec.ts Add test case for `getWorkspaceInvitations` method              packages/api-client/tests/workspace.spec.ts Added a test case for getWorkspaceInvitations method. Validated response structure and metadata in the test. Ensured proper handling of empty invitation lists. +21/-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 🔶 553 - Partially compliant Compliant requirements: Add endpoint to fetch all workspace invitations of a user Add request in workspace.ts controller Add relevant tests in workspace.spec.ts Non-compliant requirements: Use types from ticket SCHEMA: Add "Get All Workspace Invitations" request and response types #552 (cannot verify since types file not shown in diff)

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

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Test Coverage Test only verifies empty invitation list case. Should add tests for non-empty lists and pagination/sorting functionality. it('should return list of invitations of the workshop', async () => { const invitations = ( await workspaceController.getWorkspaceInvitations( { page: 0, limit: 10 }, { 'x-e2e-user-email': email } ) ).data expect(invitations.items).toHaveLength(0) expect(invitations.metadata.totalCount).toEqual(0) expect(invitations.metadata.links.self).toBe( `/workspace/invitation?page=0&limit=10&sort=name&order=asc&search=` ) }) Error Handling No error handling or input validation for invalid pagination parameters or failed API responses. async getWorkspaceInvitations( request: GetWorkspaceInvitationsRequest, headers?: Record<string, string> ): Promise<ClientResponse<GetWorkspaceInvitationsResponse>> { const queryParams = new URLSearchParams({ page: request.page?.toString() || '0', limit: request.limit?.toString() || '10', sort: request.sort || '', order: request.order || '', search: request.search || '' }) ;[...queryParams.keys()].forEach((key) => { if (!queryParams.get(key)) { queryParams.delete(key) } }) const url = parsePaginationUrl( `/api/workspace/invitations?${queryParams.toString()}`, headers ) const response = await this.apiClient.get(url, headers) return await parseResponse<GetWorkspaceInvitationsResponse>(response) }

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Possible issue	Fix inconsistent API endpoint paths between implementation and test The test assertion URL doesn't match the actual API endpoint used in the controller. Update the test to match the correct endpoint path. packages/api-client/tests/workspace.spec.ts [53-54] expect(invitations.metadata.links.self).toBe( - `/workspace/invitation?page=0&limit=10&sort=name&order=asc&search=` + `/api/workspace/invitations?page=0&limit=10&sort=name&order=asc&search=` ) Apply this suggestion Suggestion importance[1-10]: 9 Why: This catches a critical mismatch between the implementation and test - the test is asserting against a different API path than what's actually used in the code.	9
	Add validation to prevent negative pagination parameters that could cause API errors Add input validation for page and limit parameters to ensure they are non-negative numbers. Currently negative values could cause API issues. packages/api-client/src/controllers/workspace.ts [119-125] +const page = Math.max(0, request.page ?? 0); +const limit = Math.max(1, request.limit ?? 10); const queryParams = new URLSearchParams({ - page: request.page?.toString() || '0', - limit: request.limit?.toString() || '10', + page: page.toString(), + limit: limit.toString(), sort: request.sort || '', order: request.order || '', search: request.search || '' }) Apply this suggestion Suggestion importance[1-10]: 8 Why: This is an important validation that prevents potential API errors and improves robustness. Negative page/limit values could cause unexpected behavior or server errors.	8
General	Validate sort order parameter to prevent invalid API requests Validate the order parameter to only accept 'asc' or 'desc' values to prevent invalid API requests. packages/api-client/src/controllers/workspace.ts [123] -order: request.order || '', +order: ['asc', 'desc'].includes(request.order?.toLowerCase() ?? '') ? request.order.toLowerCase() : 'asc', Apply this suggestion Suggestion importance[1-10]: 7 Why: Validating the order parameter to only accept valid values ('asc'/'desc') prevents invalid API requests and improves API reliability.	7

[rajdip-b]

🎉 This PR is included in version 2.9.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀