Files
supabase/apps/studio/data/storage/bucket-objects-list-mutation.ts
T
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

67 lines
1.8 KiB
TypeScript

import { useMutation } from '@tanstack/react-query'
import { toast } from 'sonner'
import { components } from '@/data/api'
import { handleError, post } from '@/data/fetchers'
import type { ResponseError, UseCustomMutationOptions } from '@/types'
type ListBucketObjectsParams = {
projectRef: string
bucketId?: string
path: string
options: components['schemas']['GetObjectsBody']['options']
}
export type StorageObject = components['schemas']['StorageObject_Output']
// [Joshen] Ideally we transform this into a query that uses a POST i think
export const listBucketObjects = async (
{ projectRef, bucketId, path, options }: ListBucketObjectsParams,
signal?: AbortSignal
) => {
if (!bucketId) throw new Error('bucketId is required')
const { data, error } = await post('/platform/storage/{ref}/buckets/{id}/objects/list', {
params: {
path: {
ref: projectRef,
id: bucketId,
},
},
body: {
path,
options,
},
signal,
})
if (error) handleError(error)
return data
}
type ListBucketObjectsData = Awaited<ReturnType<typeof listBucketObjects>>
export const useGetSignBucketObjectMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseCustomMutationOptions<ListBucketObjectsData, ResponseError, ListBucketObjectsParams>,
'mutationFn'
> = {}) => {
return useMutation<ListBucketObjectsData, ResponseError, ListBucketObjectsParams>({
mutationFn: (vars) => listBucketObjects(vars),
async onSuccess(data, variables, context) {
await onSuccess?.(data, variables, context)
},
async onError(data, variables, context) {
if (onError === undefined) {
toast.error(`Failed to list bucket objects: ${data.message}`)
} else {
onError(data, variables, context)
}
},
...options,
})
}