Files
supabase/apps/studio/data/organizations/organization-members-query.ts
Ivan Vasilov 8b657165b5 chore: Migrate to use custom type for ReactQuery queries and mutations (#40073)
* Add custom types for queries, mutations and infinite queries.

* Migrate all queries to use the new type.

* Migrate all infinite queries to useCustomInfiniteQueryOptions.

* Migrate all mutations to use useCustomMutationOptions.

* Add type to all imports in `types` folder.
2025-11-03 13:18:13 +01:00

69 lines
2.2 KiB
TypeScript

import { useQuery } from '@tanstack/react-query'
import type { components } from 'data/api'
import { get, handleError } from 'data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from 'types'
import { organizationKeys } from './keys'
export type OrganizationMembersVariables = {
slug?: string
}
export type Member = components['schemas']['Member']
export interface OrganizationMember extends Member {
invited_at?: string
invited_id?: number
}
export async function getOrganizationMembers(
{ slug }: OrganizationMembersVariables,
signal?: AbortSignal
) {
if (!slug) throw new Error('slug is required')
const [members, invites] = await Promise.all([
get('/platform/organizations/{slug}/members', { params: { path: { slug } }, signal }),
get('/platform/organizations/{slug}/members/invitations', {
params: { path: { slug } },
signal,
}),
])
const { data: orgMembers, error: orgMembersError } = members
const { data: orgInvites, error: orgInvitesError } = invites
if (orgMembersError) handleError(orgMembersError)
if (orgInvitesError) handleError(orgInvitesError)
// Remap invite data to look like existing members data
const invitedMembers = orgInvites.invitations.map((invite) => {
const member = {
invited_at: invite.invited_at,
invited_id: invite.id,
mfa_enabled: false,
username: invite.invited_email.slice(0, 1),
primary_email: invite.invited_email,
}
return { ...member, role_ids: [invite.role_id] }
})
return [...orgMembers, ...invitedMembers] as OrganizationMember[]
}
export type OrganizationMembersData = Awaited<ReturnType<typeof getOrganizationMembers>>
export type OrganizationMembersError = ResponseError
export const useOrganizationMembersQuery = <TData = OrganizationMembersData>(
{ slug }: OrganizationMembersVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<OrganizationMembersData, OrganizationMembersError, TData> = {}
) =>
useQuery<OrganizationMembersData, OrganizationMembersError, TData>({
queryKey: organizationKeys.members(slug),
queryFn: ({ signal }) => getOrganizationMembers({ slug }, signal),
enabled: enabled && typeof slug !== 'undefined',
...options,
})