Files
supabase/apps/studio/data/projects/org-projects-infinite-query.ts
Gildas GarciaandAlaister Young 737b8595f2 Update API types (#50234)
## 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>
2026-09-11 12:17:49 +08:00

109 lines
3.5 KiB
TypeScript

import { InfiniteData, useInfiniteQuery, useQueryClient } from '@tanstack/react-query'
import { platformComponents as components } from 'api-types'
import { useCallback } from 'react'
import { INFINITE_PROJECTS_KEY_PREFIX, projectKeys } from './keys'
import { get, handleError } from '@/data/fetchers'
import { useProfile } from '@/lib/profile'
import type { ResponseError, UseCustomInfiniteQueryOptions } from '@/types'
// [Joshen] Try to keep this value a multiple of 6 (common denominator of 2 and 3) to fit the cards view
// So that the last row will always be a full row of cards while there's a next page
// API max rows is 100, I'm just choosing 96 here as the highest value thats a multiple of 6
const DEFAULT_LIMIT = 96
interface GetOrgProjectsInfiniteVariables {
slug?: string
limit?: number
sort?: 'name_asc' | 'name_desc' | 'created_asc' | 'created_desc'
search?: string
page?: number
statuses?: string[]
}
export type OrgProjectsResponse = components['schemas']['OrganizationProjectsResponse_Output']
export type OrgProject = OrgProjectsResponse['projects'][number]
export async function getOrganizationProjects(
{
slug,
limit = DEFAULT_LIMIT,
page = 0,
sort = 'name_asc',
search: _search = '',
statuses: _statuses = [],
}: GetOrgProjectsInfiniteVariables,
signal?: AbortSignal,
headers?: Record<string, string>
) {
if (!slug) throw new Error('Slug is required')
const offset = page * limit
const search = _search.length === 0 ? undefined : _search
const statuses = _statuses.length === 0 ? undefined : _statuses.join(',')
const { data, error } = await get('/platform/organizations/{slug}/projects', {
params: { path: { slug }, query: { limit, offset, sort, search, statuses } },
signal,
headers,
})
if (error) handleError(error)
return data
}
export type OrgProjectsInfiniteData = Awaited<ReturnType<typeof getOrganizationProjects>>
export type OrgProjectsInfiniteError = ResponseError
export const useOrgProjectsInfiniteQuery = <TData = OrgProjectsInfiniteData>(
{
slug,
limit = DEFAULT_LIMIT,
sort = 'name_asc',
search,
statuses = [],
}: GetOrgProjectsInfiniteVariables,
{
enabled = true,
...options
}: UseCustomInfiniteQueryOptions<
OrgProjectsInfiniteData,
OrgProjectsInfiniteError,
InfiniteData<TData>,
readonly unknown[],
number | undefined
> = {}
) => {
const { profile } = useProfile()
return useInfiniteQuery({
queryKey: projectKeys.infiniteListByOrg(slug, { limit, sort, search, statuses }),
queryFn: ({ signal, pageParam }) =>
getOrganizationProjects({ slug, limit, page: pageParam, sort, search, statuses }, signal),
enabled: enabled && profile !== undefined && typeof slug !== 'undefined',
staleTime: 30 * 60 * 1000, // 30 minutes
initialPageParam: 0,
getNextPageParam(lastPage, pages) {
const page = pages.length
const currentTotalCount = page * limit
const totalCount = lastPage.pagination.count
if (currentTotalCount >= totalCount) return undefined
return page
},
...options,
})
}
export const getComputeSize = (project: OrgProject) => {
const primaryDatabase = project.databases.find((db) => db.identifier === project.ref)
return primaryDatabase?.infra_compute_size
}
export const useInvalidateProjectsInfiniteQuery = () => {
const queryClient = useQueryClient()
const invalidateProjectsQuery = useCallback(() => {
return queryClient.invalidateQueries({ queryKey: [INFINITE_PROJECTS_KEY_PREFIX] })
}, [queryClient])
return { invalidateProjectsQuery }
}