Files
simstudioai--sim/apps/sim/hooks/queries/invitations.ts
T
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

286 lines
8.5 KiB
TypeScript

import { keepPreviousData, useMutation, useQuery, useQueryClient } from '@tanstack/react-query'
import { requestJson } from '@/lib/api/client/request'
import type { ContractBodyInput } from '@/lib/api/contracts'
import {
type BatchInvitationResult as BatchInvitationResultContract,
batchWorkspaceInvitationsContract,
cancelInvitationContract,
listWorkspaceInvitationsContract,
type PendingInvitationRow,
removeWorkspaceMemberContract,
resendInvitationContract,
} from '@/lib/api/contracts/invitations'
import { updateWorkspacePermissionsContract } from '@/lib/api/contracts/workspaces'
import { organizationKeys } from '@/hooks/queries/organization'
import { workspaceCredentialKeys } from '@/hooks/queries/utils/credential-keys'
import { workspaceKeys } from '@/hooks/queries/workspace'
export const invitationKeys = {
all: ['invitations'] as const,
lists: () => [...invitationKeys.all, 'list'] as const,
list: (workspaceId: string) => [...invitationKeys.lists(), workspaceId] as const,
}
export const WORKSPACE_INVITATION_LIST_STALE_TIME = 30 * 1000
export interface WorkspaceInvitation {
email: string
permissionType: 'admin' | 'write' | 'read'
isPendingInvitation: boolean
isExternal: boolean
invitationId?: string
token: string
}
async function fetchPendingInvitations(
workspaceId: string,
signal?: AbortSignal
): Promise<WorkspaceInvitation[]> {
const data = await requestJson(listWorkspaceInvitationsContract, { signal })
return (
data.invitations
?.filter(
(inv: PendingInvitationRow) => inv.status === 'pending' && inv.workspaceId === workspaceId
)
.map((inv: PendingInvitationRow) => ({
email: inv.email,
permissionType: inv.permission,
isPendingInvitation: true,
isExternal: inv.membershipIntent === 'external',
invitationId: inv.id,
token: inv.token,
})) || []
)
}
/**
* Fetches pending invitations for a workspace.
* @param workspaceId - The workspace ID to fetch invitations for
*/
export function usePendingInvitations(workspaceId: string | undefined) {
return useQuery({
queryKey: invitationKeys.list(workspaceId ?? ''),
queryFn: ({ signal }) => fetchPendingInvitations(workspaceId as string, signal),
enabled: Boolean(workspaceId),
staleTime: WORKSPACE_INVITATION_LIST_STALE_TIME,
placeholderData: keepPreviousData,
})
}
type BatchSendInvitationsParams = ContractBodyInput<typeof batchWorkspaceInvitationsContract> & {
organizationId?: string | null
}
type BatchInvitationResult = Pick<BatchInvitationResultContract, 'successful' | 'failed'> & {
added: string[]
}
/**
* Sends workspace invitations through the server-side batch endpoint.
* Returns results for each invitation indicating success or failure. Existing
* organization members are added directly (no acceptance) and reported in
* `added`; everyone else receives a pending invitation in `successful`.
*/
export function useBatchSendWorkspaceInvitations() {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async ({
workspaceId,
invitations,
}: BatchSendInvitationsParams): Promise<BatchInvitationResult> => {
const result = await requestJson(batchWorkspaceInvitationsContract, {
body: {
workspaceId,
invitations,
},
})
return {
successful: result.successful ?? [],
added: result.added ?? [],
failed: result.failed ?? [],
}
},
onSettled: (_data, _error, variables) => {
queryClient.invalidateQueries({
queryKey: invitationKeys.list(variables.workspaceId),
})
queryClient.invalidateQueries({
queryKey: workspaceKeys.permissions(variables.workspaceId),
})
queryClient.invalidateQueries({
queryKey: workspaceKeys.members(variables.workspaceId),
})
if (variables.organizationId) {
queryClient.invalidateQueries({
queryKey: organizationKeys.roster(variables.organizationId),
})
queryClient.invalidateQueries({
queryKey: organizationKeys.billing(variables.organizationId),
})
}
},
})
}
interface CancelInvitationParams {
invitationId: string
workspaceId: string
organizationId?: string | null
}
/**
* Cancels a pending workspace invitation.
* Invalidates the invitation list cache on success.
*/
export function useCancelWorkspaceInvitation() {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async ({ invitationId }: CancelInvitationParams) => {
return requestJson(cancelInvitationContract, {
params: { id: invitationId },
})
},
onSettled: (_data, _error, variables) => {
queryClient.invalidateQueries({
queryKey: invitationKeys.list(variables.workspaceId),
})
if (variables.organizationId) {
queryClient.invalidateQueries({
queryKey: organizationKeys.roster(variables.organizationId),
})
queryClient.invalidateQueries({
queryKey: organizationKeys.billing(variables.organizationId),
})
}
},
})
}
interface ResendInvitationParams {
invitationId: string
workspaceId: string
}
/**
* Resends a pending workspace invitation email.
* Invalidates the invitation list cache on success.
*/
export function useResendWorkspaceInvitation() {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async ({ invitationId }: ResendInvitationParams) => {
return requestJson(resendInvitationContract, {
params: { id: invitationId },
})
},
onSettled: (_data, _error, variables) => {
queryClient.invalidateQueries({
queryKey: invitationKeys.list(variables.workspaceId),
})
},
})
}
type RemoveMemberParams = ContractBodyInput<typeof removeWorkspaceMemberContract> & {
userId: string
organizationId?: string | null
}
/**
* Removes a member from a workspace.
* Invalidates the workspace permissions cache on success.
*/
export function useRemoveWorkspaceMember() {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async ({ userId, workspaceId }: RemoveMemberParams) => {
return requestJson(removeWorkspaceMemberContract, {
params: { id: userId },
body: { workspaceId },
})
},
onSettled: (_data, _error, variables) => {
queryClient.invalidateQueries({
queryKey: workspaceKeys.permissions(variables.workspaceId),
})
queryClient.invalidateQueries({
queryKey: workspaceKeys.members(variables.workspaceId),
})
queryClient.invalidateQueries({
queryKey: workspaceCredentialKeys.all,
})
if (variables.organizationId) {
queryClient.invalidateQueries({
queryKey: organizationKeys.roster(variables.organizationId),
})
}
},
})
}
type LeaveWorkspaceParams = ContractBodyInput<typeof removeWorkspaceMemberContract> & {
userId: string
}
/**
* Allows the current user to leave a workspace.
* Invalidates both permissions and workspace list caches on success.
*/
export function useLeaveWorkspace() {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async ({ userId, workspaceId }: LeaveWorkspaceParams) => {
return requestJson(removeWorkspaceMemberContract, {
params: { id: userId },
body: { workspaceId },
})
},
onSettled: (_data, _error, variables) => {
queryClient.invalidateQueries({
queryKey: workspaceKeys.permissions(variables.workspaceId),
})
queryClient.invalidateQueries({
queryKey: workspaceKeys.lists(),
})
queryClient.invalidateQueries({
queryKey: workspaceKeys.detail(variables.workspaceId),
})
},
})
}
type UpdatePermissionsParams = {
workspaceId: string
organizationId?: string
} & ContractBodyInput<typeof updateWorkspacePermissionsContract>
export function useUpdateWorkspacePermissions() {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async ({ workspaceId, updates }: UpdatePermissionsParams) => {
return requestJson(updateWorkspacePermissionsContract, {
params: { id: workspaceId },
body: { updates },
})
},
onSettled: (_data, _error, variables) => {
queryClient.invalidateQueries({
queryKey: workspaceKeys.permissions(variables.workspaceId),
})
if (variables.organizationId) {
queryClient.invalidateQueries({
queryKey: organizationKeys.roster(variables.organizationId),
})
}
},
})
}