mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 09:55:06 +03:00
Gildas GarciaandAlaister Young
737b8595f2
## Problem platform, v1 and v2 have been already completely migrated and introduced some changes. Some types have been renamed, some outputs and inputs updated. ## Solution - Update the API types - Fix the TS errors ## Update Taking this over to unblock #50134, which needs the new scoped token permission ids from the regenerated types. - Merged `master`. - Regenerated `api-v2.d.ts` from the production spec. The previous files came from a local API that exposed a webhook events endpoint production doesn't have yet. Production has since added standardized 400 error responses on the v2 organization endpoints. `api-v1.d.ts` and `platform.d.ts` already matched production. - Fixed `verify-production-types`. It formatted the regenerated files in a temp directory outside the repository, so Prettier fell back to its defaults and the comparison could never match the committed files. It now passes the repository config explicitly. `pnpm api:verify-types` passes on this branch. - Verified locally: `pnpm typecheck`, `pnpm api:verify-types`, Studio unit tests. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Bug Fixes** * Preserved descriptions when saving, sharing, moving, or unsharing notebooks, reports, SQL snippets, and saved queries. * Improved handling of empty or null values across notebook descriptions, billing usage, pooler settings, and infrastructure fields. * Improved read-replica connection handling, including read-only connection strings. * Updated storage configuration and capability handling to match current settings. * **API and Compatibility** * Updated organization, project, storage, OAuth, billing, and infrastructure data handling to match current API responses. * OAuth app creation and updates now require scopes. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
81 lines
2.5 KiB
TypeScript
81 lines
2.5 KiB
TypeScript
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_Output']['entitlements'][number]['feature']['key']
|
|
|
|
export type EntitlementsVariables = {
|
|
slug: string
|
|
}
|
|
|
|
export type EntitlementConfig =
|
|
components['schemas']['ListEntitlementsResponse_Output']['entitlements'][0]['config']
|
|
export type Entitlement =
|
|
components['schemas']['ListEntitlementsResponse_Output']['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,
|
|
})
|
|
}
|