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

[muntaxir4]

User description

Description

@keyshade/schema

• Add schemas and types for workspace-membership.
• Add tests for workspace-membership schemas.
• Export workpsace-membership schemas from index and its types from index.types .

@keyshade/api-client

• Remove existing workspace-membership.types.d.ts.
• Change imports for workpsace-membership types to @keyshade/schema. And include userEmails for removeUsers.

api

• In workspace-membership.controller, moved userEmails from request body to query params in order to follow HTTP's DELETE standards.

api-collection

• Update docs for remove user from workspace.

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, documentation, dependencies

---

Description

• Migrated workspace-membership schemas and types to @keyshade/schema.
• Added comprehensive test cases for workspace-membership and UserSchema.
• Enhanced DELETE request method to support optional request body in api-client.
• Updated import paths in workspace-membership controller to use new schemas.
• Documented request body for removing users from workspace.
• Updated package dependencies and versions, including eslint-config-turbo.
• Exported workspace membership schemas and types from the main index.

---

Changes walkthrough 📝

	Relevant files
Tests	2 files workspace-membership.spec.ts Add tests for workspace membership schemas                              packages/schema/tests/workspace-membership.spec.ts Added comprehensive test cases for various workspace membership schemas. Validated both valid and invalid scenarios for each schema. Ensured coverage for all request and response schemas related to workspace membership. +431/-0  user.spec.ts Enhance user schema tests with additional cases                    packages/schema/tests/user.spec.ts Added tests for UserSchema validation. Included scenarios for valid, invalid, and missing fields in UserSchema. Updated existing tests to include new fields in user-related schemas. +68/-2
Enhancement	7 files index.ts Define workspace membership schemas using zod                        packages/schema/src/workspace-membership/index.ts Introduced new schemas for workspace membership operations. Defined request and response schemas for membership actions. Utilized zod for schema validation. +99/-0    index.types.ts Add TypeScript types for workspace membership schemas        packages/schema/src/workspace-membership/index.types.ts Added TypeScript types inferred from workspace membership schemas. Ensured type definitions align with the newly defined schemas. +89/-0    index.ts Introduce UserSchema and refactor related schemas                packages/schema/src/user/index.ts Introduced UserSchema for user-related data validation. Refactored existing schemas to extend from UserSchema. +7/-9      client.ts Enhance DELETE request method to support request body        packages/api-client/src/core/client.ts Modified DELETE request method to accept optional body data. Updated method signature to include data parameter. +8/-1      workspace-membership.ts Update workspace membership controller with new schema imports packages/api-client/src/controllers/workspace-membership.ts Updated import paths to use @keyshade/schema. Modified remove users method to include request body data. +3/-2      index.types.ts Export workspace membership types from index                          packages/schema/src/index.types.ts Exported workspace membership types from the main index. +1/-0      index.ts Export workspace membership schemas from index                      packages/schema/src/index.ts Exported workspace membership schemas from the main index. +1/-0
Configuration changes	2 files setup.ts Add delay in test setup for database migrations                    packages/api-client/tests/config/setup.ts Added a delay before deploying database migrations. Ensured proper setup timing for test environment. +1/-1      package.json Update scripts to use scoped package names                              package.json Updated lint and build scripts to use scoped package names. +4/-4
Dependencies	2 files package.json Update eslint-config-turbo version                                              packages/eslint-config-custom/package.json Updated eslint-config-turbo to a newer version. +10/-10  pnpm-lock.yaml Update package dependencies and versions in pnpm-lock.yaml pnpm-lock.yaml Removed @swc/helpers from various package dependencies. Updated turbo package versions from 1.13.4 to 2.3.3. Updated eslint-config-turbo package versions from 1.13.4 to 2.3.3. Adjusted TypeScript versions in some dependencies. +140/-278
Documentation	1 files Remove users from workspace.bru Document request body for removing users from workspace    api-collection/Workspace Membership Controller/Remove users from workspace.bru Added request body example for removing users from workspace. Documented the request body format and usage. +14/-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 ✅ 519 - Fully compliant Compliant requirements: Created workspace-membership folder with schema and types files Added zod schemas and inferred types for workspace-membership Updated api-client to use types from schema package Added exports to index files

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

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review API Change The removeUsers endpoint now accepts a request body. Verify this change is compatible with the API implementation and documented properly.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
General	✅ Move DELETE request payload from body to URL query parameters to follow HTTP standards The DELETE request to remove users should include the request body in the URL query parameters instead of the request body, as DELETE requests typically should not have a body according to HTTP standards. packages/api-client/src/controllers/workspace-membership.ts [63-67] const response = await this.apiClient.delete( - `/api/workspace-membership/${request.workspaceSlug}/remove-users`, - headers, - request.userEmails + `/api/workspace-membership/${request.workspaceSlug}/remove-users?emails=${request.userEmails.join(',')}`, + headers ) [Suggestion has been applied] Suggestion importance[1-10]: 9 Why: This suggestion addresses a significant architectural issue by moving the DELETE request payload from the body to query parameters, which is the standard HTTP practice and improves compatibility with servers and proxies.	9
	✅ Remove request body support from DELETE method to comply with HTTP standards Suggestion Impact: The commit removed the request body support from the DELETE method, aligning with the suggestion to comply with HTTP standards. code diff: - * @param data - Optional data to be sent in the request body. * @returns A Promise that resolves to the response data. */ delete( @@ -86,7 +85,6 @@ 'Content-Type': 'application/json', ...headers }, - body: JSON.stringify(data), The DELETE method should not accept a request body parameter as it violates HTTP standards and may cause compatibility issues with some servers and proxies. packages/api-client/src/core/client.ts [78-92] delete( url: string, - headers?: Record<string, string>, - data?: any + headers?: Record<string, string> ): Promise<Response> { return this.request(url, { method: 'DELETE', headers: { 'Content-Type': 'application/json', ...headers }, - body: JSON.stringify(data), credentials: 'include' }) } Suggestion importance[1-10]: 9 Why: The suggestion fixes a fundamental HTTP compliance issue by removing body support from DELETE requests, which could prevent compatibility issues with various servers and middleware.	9

💡 Need additional feedback ? start a PR chat

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.53%. Comparing base (ce50743) to head (04b4a6d).
Report is 233 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #569      +/-   ##
===========================================
- Coverage    91.71%   87.53%   -4.18%     
===========================================
  Files          111      106       -5     
  Lines         2510     2776     +266     
  Branches       469      416      -53     
===========================================
+ Hits          2302     2430     +128     
- Misses         208      346     +138     

Flag	Coverage Δ
api-e2e-tests	87.53% <100.00%> (-4.18%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.