mirror of
https://github.com/supabase/supabase.git
synced 2026-10-07 02:15:05 +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>
66 lines
2.1 KiB
TypeScript
66 lines
2.1 KiB
TypeScript
import { useQuery } from '@tanstack/react-query'
|
|
import type { components } from 'api-types'
|
|
|
|
import { realtimeKeys } from './keys'
|
|
import { get, handleError } from '@/data/fetchers'
|
|
import { IS_PLATFORM } from '@/lib/constants'
|
|
import type { ResponseError, UseCustomQueryOptions } from '@/types'
|
|
|
|
type RealtimeConfigResponse = components['schemas']['RealtimeConfigResponse_Output']
|
|
|
|
export type RealtimeConfigurationVariables = {
|
|
projectRef?: string
|
|
}
|
|
|
|
export const REALTIME_DEFAULT_CONFIG = {
|
|
private_only: false,
|
|
connection_pool: 2,
|
|
postgres_changes_pool: 2,
|
|
max_concurrent_users: 200,
|
|
max_events_per_second: 100,
|
|
max_bytes_per_second: 100000,
|
|
max_channels_per_client: 100,
|
|
max_joins_per_second: 100,
|
|
max_presence_events_per_second: 100,
|
|
max_payload_size_in_kb: 100,
|
|
suspend: false,
|
|
presence_enabled: true,
|
|
} as const satisfies RealtimeConfigResponse
|
|
|
|
export async function getRealtimeConfiguration(
|
|
{ projectRef }: RealtimeConfigurationVariables,
|
|
signal?: AbortSignal
|
|
) {
|
|
if (!projectRef) throw new Error('Project ref is required')
|
|
|
|
const { data, error } = await get(`/platform/projects/{ref}/config/realtime`, {
|
|
params: { path: { ref: projectRef } },
|
|
signal,
|
|
})
|
|
if (error) {
|
|
if ((error as ResponseError).message === 'Custom realtime config for a project not found') {
|
|
return REALTIME_DEFAULT_CONFIG
|
|
} else {
|
|
handleError(error)
|
|
}
|
|
}
|
|
return data
|
|
}
|
|
|
|
export type RealtimeConfigurationData = Awaited<ReturnType<typeof getRealtimeConfiguration>>
|
|
export type RealtimeConfigurationError = ResponseError
|
|
|
|
export const useRealtimeConfigurationQuery = <TData = RealtimeConfigurationData>(
|
|
{ projectRef }: RealtimeConfigurationVariables,
|
|
{
|
|
enabled = true,
|
|
...options
|
|
}: UseCustomQueryOptions<RealtimeConfigurationData, RealtimeConfigurationError, TData> = {}
|
|
) =>
|
|
useQuery<RealtimeConfigurationData, RealtimeConfigurationError, TData>({
|
|
queryKey: realtimeKeys.configuration(projectRef),
|
|
queryFn: ({ signal }) => getRealtimeConfiguration({ projectRef }, signal),
|
|
enabled: enabled && IS_PLATFORM && typeof projectRef !== 'undefined',
|
|
...options,
|
|
})
|