refactor: migrate collaborator api (Kong#9605)

CurryYangxx · web-flow · commit 405b3c0562ec · 2026-02-11T03:31:57.000Z
* refactor: migrate collaborator api

* fix: search collaborators query params undefined

* fix: comment
diff --git a/packages/insomnia-api/src/collaborators.ts b/packages/insomnia-api/src/collaborators.ts
@@ -0,0 +1,192 @@
+import { fetch } from './fetch';
+
+type CollaboratorType = 'invite' | 'member' | 'group';
+interface CollaboratorMetadata {
+  groupId?: string;
+  invitationId?: string;
+  roleId?: string;
+  email?: string;
+  userId?: string;
+  expiresAt?: string;
+  groupTotal?: number;
+}
+
+export interface Collaborator {
+  id: string;
+  picture: string;
+  type: CollaboratorType;
+  name: string;
+  createdAt?: string;
+  metadata: CollaboratorMetadata;
+}
+
+interface PaginatedList {
+  start: number;
+  limit: number;
+  length: number;
+  total: number;
+  next: string;
+}
+
+type CollaboratorsListResult = PaginatedList & {
+  collaborators: Collaborator[];
+};
+
+export const getCollaborators = ({
+  sessionId,
+  organizationId,
+  pageLimit = 25,
+  page,
+  filter,
+}: {
+  sessionId: string;
+  organizationId: string;
+  filter?: string;
+  pageLimit?: number;
+  page?: number;
+}) => {
+  const params = new URLSearchParams();
+  params.set('per_page', String(pageLimit));
+  if (page !== undefined) {
+    params.set('page', String(page));
+  }
+  if (filter !== undefined) {
+    params.set('filter', filter);
+  }
+  return fetch<CollaboratorsListResult>({
+    method: 'GET',
+    path: `/v1/desktop/organizations/${organizationId}/collaborators?${params.toString()}`,
+    sessionId,
+  });
+};
+
+interface CollaboratorSearchResultItem {
+  id: string;
+  picture: string;
+  type: CollaboratorType;
+  name: string;
+}
+
+export const searchCollaborators = ({
+  sessionId,
+  organizationId,
+  keyword,
+}: {
+  sessionId: string;
+  organizationId: string;
+  keyword: string;
+}) => {
+  return fetch<CollaboratorSearchResultItem[]>({
+    method: 'GET',
+    path: `/v1/desktop/organizations/${organizationId}/collaborators/search/${keyword}`,
+    sessionId,
+  });
+};
+
+interface CollaboratorInstructionItem {
+  accountId: string;
+  publicKey: string; // stringified JSON WEB KEY
+  autoLinked: boolean;
+}
+
+type CollaboratorInstruction = Record<string, CollaboratorInstructionItem>;
+
+export const startAddingCollaborators = ({
+  sessionId,
+  organizationId,
+  emails,
+  teamIds,
+}: {
+  sessionId: string;
+  organizationId: string;
+  emails: string[];
+  teamIds: string[];
+}) => {
+  return fetch<CollaboratorInstruction>({
+    method: 'POST',
+    path: `/v1/desktop/organizations/${organizationId}/collaborators/start-adding`,
+    data: { teamIds, emails },
+    sessionId,
+  });
+};
+
+interface CollaboratorInviteKey {
+  accountId: string;
+  projectId: string;
+  encKey: string;
+}
+
+export const finishAddingCollaborators = ({
+  sessionId,
+  organizationId,
+  teamIds,
+  keys,
+  accountIds,
+  roleId,
+}: {
+  sessionId: string;
+  organizationId: string;
+  teamIds: string[];
+  keys: Record<string, Record<string, CollaboratorInviteKey>>;
+  accountIds: string[];
+  roleId?: string;
+}) => {
+  return fetch({
+    method: 'POST',
+    path: `/v1/desktop/organizations/${organizationId}/collaborators/finish-adding`,
+    data: { teamIds, keys, accountIds, roleId },
+    sessionId,
+  });
+};
+
+export const unlinkCollaborator = ({
+  sessionId,
+  organizationId,
+  collaboratorId,
+}: {
+  sessionId: string;
+  organizationId: string;
+  collaboratorId: string;
+}) => {
+  return fetch({
+    method: 'DELETE',
+    path: `/v1/desktop/organizations/${organizationId}/collaborators/${collaboratorId}/unlink`,
+    sessionId,
+  });
+};
+
+export interface UserPresence {
+  acct: string;
+  avatar: string;
+  branch: string;
+  file: string;
+  firstName: string;
+  lastName: string;
+  project: string;
+  team: string;
+}
+
+export const getRealTimeCollaborators = ({
+  sessionId,
+  // this is sanitized organization id
+  organizationId,
+  projectRemoteId,
+  workspaceId,
+}: {
+  sessionId: string;
+  organizationId: string;
+  projectRemoteId: string;
+  workspaceId: string;
+}) => {
+  return fetch<{
+    data?: UserPresence[];
+  }>({
+    path: `/v1/organizations/${organizationId}/collaborators`,
+    method: 'POST',
+    sessionId,
+    data: {
+      project: projectRemoteId,
+      file: workspaceId,
+    },
+  });
+};
diff --git a/packages/insomnia-api/src/index.ts b/packages/insomnia-api/src/index.ts
@@ -3,6 +3,7 @@ export * from './vault';
 export * from './enterprise';
 export * from './trial';
 export * from './project';
+export * from './collaborators';
 export * from './invite';
 
 export { configureFetch, type FetchConfig, ResponseFailError, isApiError } from './fetch';
diff --git a/packages/insomnia/src/routes/organization.$organizationId.collaborators-search.tsx b/packages/insomnia/src/routes/organization.$organizationId.collaborators-search.tsx
@@ -1,20 +1,11 @@
+import { searchCollaborators } from 'insomnia-api';
 import { href } from 'react-router';
 
 import { userSession } from '~/models';
-import { insomniaFetch } from '~/ui/insomnia-fetch';
 import { createFetcherLoadHook } from '~/utils/router';
 
 import type { Route } from './+types/organization.$organizationId.collaborators-search';
 
-type CollaboratorType = 'invite' | 'member' | 'group';
-
-interface CollaboratorSearchResultItem {
-  id: string;
-  picture: string;
-  type: CollaboratorType;
-  name: string;
-}
-
 export async function clientLoader({ params, request }: Route.ClientLoaderArgs) {
   const { id: sessionId } = await userSession.get();
 
@@ -24,10 +15,10 @@ export async function clientLoader({ params, request }: Route.ClientLoaderArgs)
     const requestUrl = new URL(request.url);
     const searchParams = Object.fromEntries(requestUrl.searchParams.entries());
 
-    const collaboratorsSearchList = await insomniaFetch<CollaboratorSearchResultItem[]>({
-      method: 'GET',
-      path: `/v1/desktop/organizations/${organizationId}/collaborators/search/${searchParams.query}`,
+    const collaboratorsSearchList = await searchCollaborators({
       sessionId,
+      organizationId,
+      keyword: searchParams.query || '',
     });
 
     return collaboratorsSearchList;
@@ -40,7 +31,7 @@ export const useCollaboratorsSearchLoaderFetcher = createFetcherLoadHook(
   load =>
     ({ organizationId, query }: { organizationId: string; query?: string }) => {
       return load(
-        `${href(`/organization/:organizationId/collaborators-search`, { organizationId })}?${encodeURIComponent(query || '')}`,
+        `${href(`/organization/:organizationId/collaborators-search`, { organizationId })}?query=${encodeURIComponent(query || '')}`,
       );
     },
   clientLoader,
diff --git a/packages/insomnia/src/routes/organization.$organizationId.collaborators.tsx b/packages/insomnia/src/routes/organization.$organizationId.collaborators.tsx
@@ -1,46 +1,11 @@
+import { getCollaborators } from 'insomnia-api';
 import { href } from 'react-router';
 
 import { userSession } from '~/models';
-import { insomniaFetch } from '~/ui/insomnia-fetch';
 import { createFetcherLoadHook } from '~/utils/router';
 
 import type { Route } from './+types/organization.$organizationId.collaborators';
 
-interface PaginatedList {
-  start: number;
-  limit: number;
-  length: number;
-  total: number;
-  next: string;
-}
-
-export type CollaboratorType = 'invite' | 'member' | 'group';
-
-interface CollaboratorMetadata {
-  groupId?: string;
-  invitationId?: string;
-  roleId?: string;
-  email?: string;
-  userId?: string;
-  expiresAt?: string;
-  groupTotal?: number;
-}
-
-export interface Collaborator {
-  id: string;
-  picture: string;
-  type: CollaboratorType;
-  name: string;
-  createdAt?: string;
-  metadata: CollaboratorMetadata;
-}
-
-type CollaboratorsListResult =
-  | (PaginatedList & {
-      collaborators: Collaborator[];
-    })
-  | Error;
-
 export async function clientLoader({ params, request }: Route.ClientLoaderArgs) {
   const { id: sessionId } = await userSession.get();
 
@@ -50,22 +15,12 @@ export async function clientLoader({ params, request }: Route.ClientLoaderArgs)
     const requestUrl = new URL(request.url);
     const searchParams = Object.fromEntries(requestUrl.searchParams.entries());
 
-    // Construct the base path
-    let path = `/v1/desktop/organizations/${organizationId}/collaborators?per_page=${searchParams.per_page || 25}`;
-
-    // Append query parameters conditionally
-    if (searchParams.page) {
-      path += `&page=${searchParams.page}`;
-    }
-
-    if (searchParams.filter) {
-      path += `&filter=${searchParams.filter}`;
-    }
-
-    const collaboratorsList = await insomniaFetch<CollaboratorsListResult>({
-      method: 'GET',
-      path,
+    const collaboratorsList = await getCollaborators({
       sessionId,
+      organizationId,
+      pageLimit: Number(searchParams.per_page) || 25,
+      page: Number(searchParams.page) || 0,
+      filter: searchParams.filter,
     });
 
     return collaboratorsList;
diff --git a/packages/insomnia/src/ui/components/modals/invite-modal/encryption.ts b/packages/insomnia/src/ui/components/modals/invite-modal/encryption.ts
@@ -1,3 +1,5 @@
+import { finishAddingCollaborators, startAddingCollaborators } from 'insomnia-api';
+
 import { decryptRSAWithJWK, encryptRSAWithJWK } from '../../../../account/crypt';
 import { getCurrentSessionId, getPrivateKey } from '../../../../account/session';
 import { invariant } from '../../../../utils/invariant';
@@ -124,26 +126,17 @@ interface MemberProjectKey {
   encSymmetricKey: string;
 }
 
-interface CollaboratorInstructionItem {
-  accountId: string;
-  publicKey: string; // stringified JSON WEB KEY
-  autoLinked: boolean;
-}
-
-type CollaboratorInstruction = Record<string, CollaboratorInstructionItem>;
-
 export async function startInvite({ emails, teamIds, organizationId, roleId }: StartInviteParams) {
   const sessionId = await getCurrentSessionId();
   invariant(sessionId, 'Session ID is required');
 
   // we are merging these endpoints into one as it has grown onto several types over time.
   // this way, we can also offload the complex logic to the API
-  const instruction = await insomniaFetch<CollaboratorInstruction>({
-    method: 'POST',
-    path: `/v1/desktop/organizations/${organizationId}/collaborators/start-adding`,
-    data: { teamIds, emails },
+  const instruction = await startAddingCollaborators({
     sessionId,
-    onlyResolveOnSuccess: true,
+    organizationId,
+    emails,
+    teamIds,
   });
 
   const myKeysInfo = await insomniaFetch<ResponseGetMyProjectKeys>({
@@ -206,12 +199,12 @@ export async function startInvite({ emails, teamIds, organizationId, roleId }: S
       });
     }
   }
-
-  await insomniaFetch({
-    method: 'POST',
-    path: `/v1/desktop/organizations/${organizationId}/collaborators/finish-adding`,
-    data: { teamIds, keys, accountIds, roleId },
+  await finishAddingCollaborators({
     sessionId,
-    onlyResolveOnSuccess: true,
+    organizationId,
+    teamIds,
+    keys,
+    accountIds,
+    roleId,
   });
 }
diff --git a/packages/insomnia/src/ui/components/modals/invite-modal/invite-modal.tsx b/packages/insomnia/src/ui/components/modals/invite-modal/invite-modal.tsx
diff --git a/packages/insomnia/src/ui/context/app/insomnia-event-stream-context.tsx b/packages/insomnia/src/ui/context/app/insomnia-event-stream-context.tsx
