supabase/apps/studio/data/entitlements/entitlements-query.ts

import { useQuery } from '@tanstack/react-query'
import type { components } from 'api-types'

import { get, handleError } from '@/data/fetchers'
import { organizationKeys } from '@/data/organizations/keys'
import { EMPTY_ARR } from '@/lib/void'
import { UseCustomQueryOptions } from '@/types'
import { ResponseError } from '@/types/base'

export type FeatureKey =
  components['schemas']['ListEntitlementsResponse']['entitlements'][number]['feature']['key']

export type EntitlementsVariables = {
  slug: string
}

export type EntitlementConfig =
  components['schemas']['ListEntitlementsResponse']['entitlements'][0]['config']
export type Entitlement = components['schemas']['ListEntitlementsResponse']['entitlements'][0]
export type EntitlementType = Entitlement['type']

export async function getEntitlements(
  { slug }: EntitlementsVariables,
  signal?: AbortSignal,
  headers?: HeadersInit
) {
  if (!slug) throw new Error('slug is required')

  const { data, error } = await get('/platform/organizations/{slug}/entitlements', {
    params: { path: { slug } },
    signal,
    ...(headers && { headers }),
  })
  if (error) handleError(error)

  return {
    ...data,
    entitlements: Array.isArray(data?.entitlements) ? data.entitlements : EMPTY_ARR,
  }
}

export type EntitlementsData = Awaited<ReturnType<typeof getEntitlements>>
export type EntitlementsError = ResponseError

/**
 * Helper to check a specific entitlement for an organization
 * For client-side components, please using useCheckEntitlements hook instead
 */
export async function checkEntitlement(
  slug: string,
  featureKey: string,
  signal?: AbortSignal,
  headers?: HeadersInit
): Promise<{ hasAccess: boolean; entitlement?: Entitlement }> {
  const entitlements = await getEntitlements({ slug }, signal, headers)

  const entitlement = entitlements.entitlements.find((e) => e.feature.key === (featureKey as any))

  return {
    hasAccess: entitlement?.hasAccess ?? false,
    entitlement,
  }
}

export const useEntitlementsQuery = <TData = EntitlementsData>(
  { slug }: EntitlementsVariables,
  {
    enabled = true,
    ...options
  }: UseCustomQueryOptions<EntitlementsData, EntitlementsError, TData> = {}
) => {
  return useQuery<EntitlementsData, EntitlementsError, TData>({
    queryKey: organizationKeys.entitlements(slug),
    queryFn: ({ signal }) => getEntitlements({ slug }, signal),
    enabled: enabled && typeof slug !== 'undefined',
    ...options,
    staleTime: 30 * 60 * 1000,
  })
}