Files
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

89 lines
3.0 KiB
TypeScript

import type { components } from 'api-types'
import { createContext, PropsWithChildren, useContext, useMemo, useState } from 'react'
import type { Installation, PrivateApp } from './PrivateApps.types'
import { usePlatformAppInstallationsQuery } from '@/data/platform-apps/platform-app-installations-query'
import { usePlatformAppsQuery } from '@/data/platform-apps/platform-apps-query'
import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'
export type { Installation, PrivateApp } from './PrivateApps.types'
interface PrivateAppsContextValue {
slug: string | undefined
apps: PrivateApp[]
isLoading: boolean
isLoadingInstallations: boolean
installations: Installation[]
addInstallation: (
data: components['schemas']['InstallPlatformAppResponse_Output'],
projectScope: 'all' | string[]
) => void
removeInstallation: (id: string) => void
removeInstallationsByAppId: (appId: string) => void
}
const PrivateAppsContext = createContext<PrivateAppsContextValue | null>(null)
export function PrivateAppsProvider({ children }: PropsWithChildren) {
const { data: org } = useSelectedOrganizationQuery()
const slug = org?.slug
const { data: appsData, isLoading } = usePlatformAppsQuery({ slug })
const {
data: installationsData,
isLoading: isLoadingInstallations,
isError: installationsError,
} = usePlatformAppInstallationsQuery({ slug }, { retry: false })
// Local state fallback when GET installations endpoint is unavailable
const [localInstallations, setLocalInstallations] = useState<Installation[]>([])
const installations = useMemo<Installation[]>(() => {
if (!installationsError && installationsData?.installations) {
return installationsData.installations.map((inst) => ({
...(inst as components['schemas']['InstallPlatformAppResponse_Output']),
projectScope: 'all' as const,
}))
}
return localInstallations
}, [installationsData, installationsError, localInstallations])
function addInstallation(
data: components['schemas']['InstallPlatformAppResponse_Output'],
projectScope: 'all' | string[]
) {
setLocalInstallations((prev) => [...prev, { ...data, projectScope }])
}
function removeInstallation(id: string) {
setLocalInstallations((prev) => prev.filter((i) => i.id !== id))
}
function removeInstallationsByAppId(appId: string) {
setLocalInstallations((prev) => prev.filter((i) => i.app_id !== appId))
}
return (
<PrivateAppsContext.Provider
value={{
slug,
apps: appsData?.apps ?? [],
isLoading: isLoading || !slug,
isLoadingInstallations: isLoadingInstallations || !slug,
installations,
addInstallation,
removeInstallation,
removeInstallationsByAppId,
}}
>
{children}
</PrivateAppsContext.Provider>
)
}
export function usePrivateApps() {
const ctx = useContext(PrivateAppsContext)
if (!ctx) throw new Error('usePrivateApps must be used within PrivateAppsProvider')
return ctx
}