Get the FREE Ultimate OpenClaw Setup Guide →

supabase-ts

npx machina-cli add skill BjornMelin/dev-skills/supabase-ts --openclaw
Files (1)
SKILL.md
10.3 KB

Supabase TypeScript

Production patterns for Supabase in Next.js/React/Vercel applications with TypeScript and Zod v4.

Quick Reference

Server Client (Next.js App Router)

// src/lib/supabase/server.ts
import "server-only";
import { cookies } from "next/headers";
import { createServerClient } from "@supabase/ssr";
import type { Database } from "./database.types";

export async function createServerSupabase() {
  const cookieStore = await cookies();
  return createServerClient<Database>(
    process.env.NEXT_PUBLIC_SUPABASE_URL!,
    process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,
    {
      cookies: {
        getAll: () => cookieStore.getAll(),
        setAll: (cookiesToSet) => {
          cookiesToSet.forEach(({ name, value, options }) => {
            cookieStore.set(name, value, options);
          });
        },
      },
    }
  );
}

Browser Client (React)

// src/lib/supabase/client.ts
import { createBrowserClient } from "@supabase/ssr";
import type { Database } from "./database.types";

let client: ReturnType<typeof createBrowserClient<Database>> | null = null;

export function getBrowserClient() {
  if (client) return client;
  if (typeof window === "undefined") return null;

  client = createBrowserClient<Database>(
    process.env.NEXT_PUBLIC_SUPABASE_URL!,
    process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!
  );
  return client;
}

Middleware Client

// middleware.ts
import { createServerClient } from "@supabase/ssr";
import { NextResponse, type NextRequest } from "next/server";

export async function middleware(request: NextRequest) {
  const response = NextResponse.next({ request });
  const supabase = createServerClient(
    process.env.NEXT_PUBLIC_SUPABASE_URL!,
    process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,
    {
      cookies: {
        getAll: () => request.cookies.getAll(),
        setAll: (cookiesToSet) => {
          cookiesToSet.forEach(({ name, value, options }) => {
            response.cookies.set(name, value, options);
          });
        },
      },
    }
  );

  const { data: { user } } = await supabase.auth.getUser();
  if (!user && request.nextUrl.pathname.startsWith("/dashboard")) {
    return NextResponse.redirect(new URL("/login", request.url));
  }
  return response;
}

Decision Framework

ContextClientWhy
Server ComponentcreateServerSupabase()Async cookies, server-only
Route HandlercreateServerSupabase()SSR context with cookies
MiddlewareInline createServerClientEdge runtime, request/response cookies
Client ComponentgetBrowserClient()Singleton, SSR-safe (null check)
Server ActioncreateServerSupabase()Server context

Core Patterns

Auth: Always Use getUser()

// CORRECT: Validates JWT with auth server
const { data: { user } } = await supabase.auth.getUser();

// WRONG: Only reads from cookie, can be spoofed
const { data: { session } } = await supabase.auth.getSession();

RLS: Use Subquery Wrapper

-- CORRECT: Subquery prevents multiple auth.uid() calls
create policy "Users view own data"
on public.items for select
to authenticated
using ((select auth.uid()) = user_id);

-- WRONG: Direct call, inefficient
using (auth.uid() = user_id);

Realtime: Prefer Broadcast

// Broadcast: Low latency, no DB polling
const channel = supabase.channel("room:123", { config: { private: true } });
channel.send({ type: "broadcast", event: "cursor", payload: { x, y } });

// postgres_changes: Higher latency, DB trigger required
channel.on("postgres_changes", { event: "*", schema: "public", table: "messages" }, handler);

Storage: Signed URLs for Private Files

// Public bucket: Direct URL
const { data } = supabase.storage.from("public-bucket").getPublicUrl("file.jpg");

// Private bucket: Time-limited signed URL
const { data } = await supabase.storage
  .from("private-bucket")
  .createSignedUrl("file.jpg", 3600); // 1 hour

Zod v4 Integration

import { z } from "zod";

// Use top-level string helpers (Zod v4)
const UserSchema = z.strictObject({
  id: z.uuid(),
  email: z.email(),
  created_at: z.iso.datetime(),
  metadata: z.looseObject({
    avatar_url: z.url().optional(),
  }),
});

// Unified error option (Zod v4)
const InsertSchema = z.strictObject({
  title: z.string().min(1, { error: "Title required" }),
  user_id: z.uuid({ error: "Invalid user ID" }),
});

// Parse Supabase response
const { data, error } = await supabase.from("items").select("*");
if (error) throw error;
const parsed = z.array(ItemSchema).parse(data);

Anti-Patterns

Anti-PatternCorrect Approach
getSession() for auth validationUse getUser() - validates JWT
auth.uid() directly in RLSWrap in (select auth.uid())
Module-scope Supabase clientCreate inside request handler
Service role key on clientServer-only, never expose
postgres_changes for chatUse broadcast channels
Caching auth responses ('use cache')Keep auth routes dynamic

CLI Quick Reference

# Setup
supabase login
supabase link --project-ref <ref>

# Type generation
supabase gen types typescript --project-id <ref> --schema public > database.types.ts

# Migrations
supabase migration new <name>
supabase db push        # Push local migrations to remote
supabase db pull        # Pull remote schema to local
supabase db diff        # Show schema differences
supabase db reset       # Reset local database

# Edge Functions
supabase functions serve           # Local development
supabase functions deploy <name>   # Deploy to production

Reference Documentation

Navigate to detailed guides based on task:

Core Setup & Operations

Authentication & Security

  • Auth SSR: @supabase/ssr setup, PKCE, OAuth, middleware
  • RLS Cookbook: Policy patterns, team access, storage RLS

Data & Features

  • Storage: Buckets, uploads, transformations, signed URLs
  • Realtime: Broadcast, presence, authorization
  • AI Vectors: pgvector, embeddings, semantic search
  • Edge Functions: Deno runtime, deployment, CORS

Templates

Migration Template

-- supabase/migrations/YYYYMMDDHHmmss_description.sql

-- Enable required extensions
create extension if not exists "uuid-ossp";

-- Create table with RLS
create table public.items (
  id uuid primary key default uuid_generate_v4(),
  user_id uuid not null references auth.users(id) on delete cascade,
  title text not null,
  created_at timestamptz not null default now()
);

-- Enable RLS (mandatory)
alter table public.items enable row level security;

-- Policies
create policy "Users view own items"
on public.items for select
to authenticated
using ((select auth.uid()) = user_id);

create policy "Users insert own items"
on public.items for insert
to authenticated
with check ((select auth.uid()) = user_id);

-- Indexes
create index items_user_id_idx on public.items(user_id);

comment on table public.items is 'User items with RLS';

Edge Function Template

// supabase/functions/my-function/index.ts
import "jsr:@supabase/functions-js/edge-runtime.d.ts";
import { createClient } from "npm:@supabase/supabase-js@2";

const corsHeaders = {
  "Access-Control-Allow-Origin": "*",
  "Access-Control-Allow-Methods": "POST, OPTIONS",
  "Access-Control-Allow-Headers": "Content-Type, Authorization",
};

Deno.serve(async (req) => {
  if (req.method === "OPTIONS") {
    return new Response(null, { headers: corsHeaders });
  }

  try {
    const authHeader = req.headers.get("Authorization");
    const supabase = createClient(
      Deno.env.get("SUPABASE_URL")!,
      Deno.env.get("SUPABASE_ANON_KEY")!,
      { global: { headers: { Authorization: authHeader! } } }
    );

    const { data: { user } } = await supabase.auth.getUser();
    if (!user) {
      return new Response(JSON.stringify({ error: "Unauthorized" }), {
        status: 401,
        headers: { ...corsHeaders, "Content-Type": "application/json" },
      });
    }

    const body = await req.json();
    // Process request...

    return new Response(JSON.stringify({ success: true }), {
      headers: { ...corsHeaders, "Content-Type": "application/json" },
    });
  } catch (error) {
    return new Response(JSON.stringify({ error: error.message }), {
      status: 500,
      headers: { ...corsHeaders, "Content-Type": "application/json" },
    });
  }
});

GitHub Actions Type Generation

# .github/workflows/supabase-types.yml
name: Generate Supabase Types
on:
  push:
    paths: ["supabase/migrations/**"]
    branches: [main]

jobs:
  generate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: supabase/setup-cli@v1
      - run: |
          supabase gen types typescript \
            --project-id ${{ secrets.SUPABASE_PROJECT_REF }} \
            --schema public \
            > src/lib/supabase/database.types.ts
        env:
          SUPABASE_ACCESS_TOKEN: ${{ secrets.SUPABASE_ACCESS_TOKEN }}
      - uses: peter-evans/create-pull-request@v5
        with:
          commit-message: "chore: update database types"
          title: "Update Supabase Database Types"
          branch: update-db-types

Source

git clone https://github.com/BjornMelin/dev-skills/blob/main/skills/supabase-ts/SKILL.mdView on GitHub

Overview

Supabase-ts provides production-ready integration patterns for Next.js, React, and TypeScript apps. It covers SSR authentication with @supabase/ssr, database operations and migrations, Row Level Security (RLS) policies, storage buckets and file uploads, realtime channels and presence, Edge Functions with Deno, pgvector embeddings for semantic search, Vercel deployment with pooling, and CLI workflows. Triggers on common events like client setup, auth, RLS, storage uploads, realtime subscriptions, Edge Functions, vector search, and Vercel deployments.

How This Skill Works

The patterns define server, browser, and middleware clients using @supabase/ssr (createServerClient and createBrowserClient) for type-safe, SSR-friendly access. It explains when to use each client in different runtime contexts and how to wire up auth, RLS, storage, and realtime events across Next.js routes, middleware, and Edge Functions. It also covers advanced use cases like vector search with pgvector and deployment considerations on Vercel.

When to Use It

  • SSR authentication with @supabase/ssr
  • Database operations and migrations
  • Row Level Security (RLS) policies
  • Storage buckets and file uploads
  • Realtime channels and presence

Quick Start

  1. Step 1: Install dependencies and set env vars (NEXT_PUBLIC_SUPABASE_URL and NEXT_PUBLIC_SUPABASE_ANON_KEY)
  2. Step 2: Create server.ts with createServerClient and server-side cookie handling
  3. Step 3: Create browser client with createBrowserClient and a getBrowserClient singleton

Best Practices

  • Always use getUser() to validate JWT on the server for secure auth checks
  • Use a Subquery Wrapper for RLS policies to avoid extra auth.uid() calls
  • Prefer the server-side client in server components, route handlers, and middleware
  • Use a singleton browser client on the client to preserve state and avoid re-instantiation
  • Follow the framework’s decision framework to pick the right client for SSR, routing, and edge contexts

Example Use Cases

  • Server-side client setup in src/lib/supabase/server.ts using createServerClient and cookie syncing
  • Browser client singleton in src/lib/supabase/client.ts using createBrowserClient
  • Middleware guard that enforces SSR auth and redirects unauthenticated users
  • Using supabase.auth.getUser() in server routes to validate the current user
  • RLS policy example using a subquery wrapper to scope data access

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers