Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

2.0 KB
Raw Blame
import { useMutation, useQueryClient, type UseMutationOptions } from '@tanstack/react-query'
import { toast } from 'sonner'

import { storageKeys } from '../keys'
import { del, handleError } from '@/data/fetchers'
import type { ResponseError } from '@/types'

export type ArchivedObjectRestoreVariables = {
  projectRef: string
  bucketId: string
  /** The delete marker's version id, which is what identifies an archived object. */
  archivedObjectId: string
  path: string
}

/** Removing the delete marker promotes the version underneath; nothing is copied. */
async function restoreArchivedObject({
  projectRef,
  bucketId,
  archivedObjectId,
  path,
}: ArchivedObjectRestoreVariables) {
  if (!projectRef) throw new Error('projectRef is required')
  if (!bucketId) throw new Error('bucketId is required')
  if (!archivedObjectId) throw new Error('archivedObjectId is required')
  if (!path) throw new Error('path is required')

  const { error } = await del('/platform/storage/{ref}/buckets/{id}/objects', {
    params: { path: { ref: projectRef, id: bucketId } },
    body: { paths: [{ path, versionId: archivedObjectId }] },
  })

  if (error) handleError(error)
}

export const useArchivedObjectRestoreMutation = ({
  onSuccess,
  onError,
  ...options
}: Omit<
  UseMutationOptions<void, ResponseError, ArchivedObjectRestoreVariables>,
  'mutationFn'
> = {}) => {
  const queryClient = useQueryClient()

  return useMutation<void, ResponseError, ArchivedObjectRestoreVariables>({
    mutationFn: restoreArchivedObject,
    async onSuccess(data, variables, context, mutationContext) {
      await queryClient.invalidateQueries({
        queryKey: storageKeys.archivedObjects(variables.projectRef, variables.bucketId),
      })
      await onSuccess?.(data, variables, context, mutationContext)
    },
    async onError(error, variables, context, mutationContext) {
      if (onError === undefined) toast.error(`Failed to restore file: ${error.message}`)
      else onError(error, variables, context, mutationContext)
    },
    ...options,
  })
}