storage

Storage Rules

Follow these rules when working with Supabase Storage.

It uses Supabase Storage for file uploads, downloads, and management.

General Rules

• Always use environment variables for bucket names to maintain consistency across environments
• Never hardcode bucket names in the application code
• Always handle file size limits and allowed file types at the application level
• Use the upsert method instead of upload when you want to replace existing files
• Always implement proper error handling for storage operations
• Use content-type headers when uploading files to ensure proper file handling

Organization

Buckets

• Name buckets in kebab-case: user-uploads, profile-images
• Create separate buckets for different types of files (e.g., profile-images, documents, attachments)
• Document bucket purposes in a central location
• Set appropriate bucket policies (public/private) based on access requirements
• Implement RLS (Row Level Security) policies for buckets that need user-specific access
• Make sure to let me know instructions for setting up RLS policies on Supabase since you can't do this yourself, including the SQL scripts I need to run in the editor

File Structure

• Organize files in folders based on their purpose and ownership
• Use predictable, collision-resistant naming patterns
• Structure: {bucket}/{userId}/{purpose}/{filename}
• Example: profile-images/123e4567-e89b/avatar/profile.jpg
• Include timestamps in filenames when version history is important
• Example: documents/123e4567-e89b/contracts/2024-02-13-contract.pdf

Actions

• When importing storage actions, use @/actions/storage
• Name files like example-storage-actions.ts
• Include Storage at the end of function names Ex: uploadFile -> uploadFileStorage
• Follow the same ActionState pattern as DB actions

Example of a storage action:

"use server"

import { createClientComponentClient } from "@supabase/auth-helpers-nextjs"
import { ActionState } from "@/types"

export async function uploadFileStorage(
  bucket: string,
  path: string,
  file: File
): Promise<ActionState<{ path: string }>> {
  try {
    const supabase = createClientComponentClient()
    
    const { data, error } = await supabase
      .storage
      .from(bucket)
      .upload(path, file, {
        upsert: false,
        contentType: file.type
      })

    if (error) throw error

    return {
      isSuccess: true,
      message: "File uploaded successfully",
      data: { path: data.path }
    }
  } catch (error) {
    console.error("Error uploading file:", error)
    return { isSuccess: false, message: "Failed to upload file" }
  }
}