SupabaseRepository

Abstract base class for Supabase-backed repositories.

Extend this class and set tableName to implement a Mantle Repository<T> backed by a Supabase (PostgreSQL) table via the Supabase JS client.

Example

class UserRepository extends SupabaseRepository<User> {
  readonly tableName = "users";

  async findByEmail(email: string): Promise<User | null> {
    const { data, error } = await this.db.select("*").eq("email", email).maybeSingle();
    if (error) throw this.wrapError(error);
    return data ?? null;
  }
}

Type Parameters

T

T extends Record<string, unknown>

D

D = Partial<T>

Implements

Repository<T, D>

Constructors

Constructor

new SupabaseRepository<T, D>(app): SupabaseRepository<T, D>

Defined in: supabase-repository.ts:89

Parameters

app

MantleApplication

Returns

SupabaseRepository<T, D>

Properties

app

protected readonly app: MantleApplication

Defined in: supabase-repository.ts:61

client

protected readonly client: SupabaseClient

Defined in: supabase-repository.ts:60

listenToChanges

readonly listenToChanges: boolean = false

Defined in: supabase-repository.ts:87

When true, subscribes to Postgres Changes for this table and re-emits direct DB mutations (PostgREST, migrations, Supabase Studio) as Mantle service:event emissions on the app event bus. These emissions carry { external: true } as their params so consumers can distinguish them from hook-pipeline events; external UPDATEs always map to "patched".

Default

false

primaryKey

readonly primaryKey: string = "id"

Defined in: supabase-repository.ts:70

The primary key column name.

Default

"id"

tableName

abstract readonly tableName: string

Defined in: supabase-repository.ts:64

Supabase table name.

timestamps

readonly timestamps: boolean = true

Defined in: supabase-repository.ts:77

When true, save / saveAll / updateById / patchById automatically write created_at and updated_at ISO-8601 timestamps.

Default

true

Accessors

db

Get Signature

get protected db(): AnyQuery

Defined in: supabase-repository.ts:153

Returns a query builder scoped to this repository’s table. Useful for writing custom queries in subclasses.

Returns

AnyQuery

Methods

applyParams()

protected applyParams(query, params?): AnyQuery

Defined in: supabase-repository.ts:176

Apply QueryParams filters, sorting, and pagination to a query builder. Subclasses may call this to re-use the standard filter logic in custom queries.