feat(schema, api-client): Migrate workspace-membership schemas and ty…

…pes to @keyshade/schema (#569) Co-authored-by: Rajdip Bhattacharya <[email protected]>
keyshade-xyz · Dec 3, 2024 · 4398969 · 4398969
1 parent 30f4f65
commit 4398969
Show file tree

Hide file tree

Showing 18 changed files with 739 additions and 177 deletions.
diff --git a/api-collection/Workspace Membership Controller/Remove users from workspace.bru b/api-collection/Workspace Membership Controller/Remove users from workspace.bru
@@ -10,6 +10,20 @@ delete {
   auth: none
 }
 
+params:query {
+  userEmails: [email protected],[email protected]
+}
+
 params:path {
   workspace_slug: workspace-1-cahli
 }
+
+docs {
+  ## Description
+
+  Remove one or more users from the workspace.
+
+  ### Request Query Params
+
+  The endpoint accepts a string of comma separated emails
+}
diff --git a/apps/api/src/workspace-membership/controller/workspace-membership.controller.ts b/apps/api/src/workspace-membership/controller/workspace-membership.controller.ts
@@ -53,12 +53,12 @@ export class WorkspaceMembershipController {
   async removeUsers(
     @CurrentUser() user: User,
     @Param('workspaceSlug') workspaceSlug: Workspace['slug'],
-    @Body() userEmails: User['email'][]
+    @Query('userEmails') userEmails: string = ''
   ) {
     return this.workspaceMembershipService.removeUsersFromWorkspace(
       user,
       workspaceSlug,
-      userEmails
+      userEmails.split(/\s*,\s*/)
     )
   }
 

diff --git a/apps/api/src/workspace-membership/workspace-membership.e2e.spec.ts b/apps/api/src/workspace-membership/workspace-membership.e2e.spec.ts
@@ -524,7 +524,9 @@ describe('Workspace Membership Controller Tests', () => {
           'x-e2e-user-email': user1.email
         },
         url: `/workspace-membership/${workspace1.slug}/remove-users`,
-        payload: [user2.id]
+        query: {
+          userEmails: user2.email
+        }
       })
 
       expect(response.statusCode).toBe(200)
@@ -548,7 +550,9 @@ describe('Workspace Membership Controller Tests', () => {
           'x-e2e-user-email': user1.email
         },
         url: `/workspace-membership/${workspace1.slug}/remove-users`,
-        payload: [user1.email]
+        query: {
+          userEmails: user1.email
+        }
       })
 
       expect(response.statusCode).toBe(400)

diff --git a/packages/api-client/src/controllers/workspace-membership.ts b/packages/api-client/src/controllers/workspace-membership.ts
@@ -22,7 +22,7 @@ import {
   IsMemberResponse,
   GetMembersRequest,
   GetMembersResponse
-} from '@api-client/types/workspace-membership.types'
+} from '@keyshade/schema'
 import { ClientResponse } from '@keyshade/schema'
 
 export default class WorkspaceMembershipController {
@@ -61,7 +61,7 @@ export default class WorkspaceMembershipController {
     headers?: Record<string, string>
   ): Promise<ClientResponse<RemoveUsersResponse>> {
     const response = await this.apiClient.delete(
-      `/api/workspace-membership/${request.workspaceSlug}/remove-users`,
+      `/api/workspace-membership/${request.workspaceSlug}/remove-users?userEmails=${request.userEmails}`,
       headers
     )
     return await parseResponse<RemoveUsersResponse>(response)

diff --git a/packages/api-client/src/core/client.ts b/packages/api-client/src/core/client.ts
@@ -71,9 +71,14 @@ export class APIClient {
    * Sends a DELETE request to the specified URL and returns a Promise that resolves to the response data.
    *
    * @param url - The URL to send the DELETE request to.
+   * @param headers - Optional headers to include in the request.
    * @returns A Promise that resolves to the response data.
    */
-  delete(url: string, headers?: Record<string, string>): Promise<Response> {
+  delete(
+    url: string,
+    headers?: Record<string, string>,
+    data?: any
+  ): Promise<Response> {
     return this.request(url, {
       method: 'DELETE',
       headers: {

diff --git a/packages/api-client/src/types/workspace-membership.types.d.ts b/packages/api-client/src/types/workspace-membership.types.d.ts
diff --git a/packages/api-client/tests/config/setup.ts b/packages/api-client/tests/config/setup.ts
@@ -31,7 +31,7 @@ function executeCommand(
 
 function startAPI(): Promise<void> {
   return new Promise((resolve) => {
-    const apiProcess = exec('cd ../../ && pnpm run start:api', {
+    const apiProcess = exec('pnpm run --filter=api start', {
       env: {
         PATH: process.env.PATH,
         DATABASE_URL: 'postgresql://prisma:prisma@localhost:5432/tests',

diff --git a/packages/api-client/tests/workspace-membership.spec.ts b/packages/api-client/tests/workspace-membership.spec.ts
@@ -58,7 +58,7 @@ describe('Workspace Membership Controller Tests', () => {
   it('should remove users', async () => {
     const request = {
       workspaceSlug: workspaceSlug!,
-      userEmails: ['[email protected]']
+      userEmails: '[email protected]'
     }
     const response = await workspaceMembershipController.removeUsers(request, {
       'x-e2e-user-email': userEmail

diff --git a/packages/eslint-config-custom/package.json b/packages/eslint-config-custom/package.json
@@ -1,11 +1,11 @@
 {
-	"name": "eslint-config-custom",
-	"license": "MIT",
-	"version": "0.0.0",
-	"private": true,
-	"devDependencies": {
-	  "@vercel/style-guide": "^5.0.0",
-	  "eslint-config-turbo": "^2.3.1",
-	  "typescript": "^4.5.3"
-	}
+  "name": "eslint-config-custom",
+  "license": "MIT",
+  "version": "0.0.0",
+  "private": true,
+  "devDependencies": {
+    "@vercel/style-guide": "^5.0.0",
+    "eslint-config-turbo": "^2.3.1",
+    "typescript": "^4.5.3"
+  }
 }
diff --git a/packages/schema/src/index.ts b/packages/schema/src/index.ts
@@ -14,3 +14,4 @@ export * from './workspace'
 export * from './workspace-role'
 export * from './event'
 export * from './api-key'
+export * from './workspace-membership'
diff --git a/packages/schema/src/index.types.ts b/packages/schema/src/index.types.ts
@@ -10,3 +10,4 @@ export * from './event/index.types'
 export * from './integration/index.types'
 export * from './api-key/index.types'
 export * from './workspace-role/index.types'
+export * from './workspace-membership/index.types'
diff --git a/packages/schema/src/user/index.ts b/packages/schema/src/user/index.ts
@@ -1,15 +1,18 @@
 import { z } from 'zod'
 import { WorkspaceSchema } from '@/workspace'
 
-export const GetSelfResponseSchema = z.object({
+export const UserSchema = z.object({
   id: z.string(),
   email: z.string().email(),
   name: z.string(),
   profilePictureUrl: z.string().nullable(),
   isActive: z.boolean(),
   isOnboardingFinished: z.boolean(),
   isAdmin: z.boolean(),
-  authProvider: z.string(),
+  authProvider: z.string()
+})
+
+export const GetSelfResponseSchema = UserSchema.extend({
   defaultWorkspace: WorkspaceSchema
 })
 
@@ -20,9 +23,7 @@ export const UpdateSelfRequestSchema = z.object({
   email: z.string().email().optional()
 })
 
-export const UpdateSelfResponseSchema = GetSelfResponseSchema.partial().omit({
-  defaultWorkspace: true
-})
+export const UpdateSelfResponseSchema = UserSchema
 
 export const DeleteSelfRequestSchema = z.void()
 
@@ -32,10 +33,7 @@ export const ValidateEmailChangeOTPRequestSchema = z.object({
   otp: z.string().min(6).max(6)
 })
 
-export const ValidateEmailChangeOTPResponseSchema =
-  GetSelfResponseSchema.partial().omit({
-    defaultWorkspace: true
-  })
+export const ValidateEmailChangeOTPResponseSchema = UserSchema
 
 export const ResendEmailChangeOTPRequestSchema = z.void()