better-supabase 0.7.1 → 0.9.0

package/dist/config-D44Y7PAv.d.ts

@@ -1,984 +0,0 @@
-/// <reference lib="esnext.temporal" />
-import { P as SchemaMeta, U as BucketLifecycle, c as Casing, s as BucketPolicyName, t as AccessBucketPolicy } from "./types-6BdhkmZe.js";
-import { s as ModulesConfig } from "./modules-DpPwzC7E.js";
-import { i as AuthorizationProvider } from "./authorization-BFCqamMs.js";
-//#region src/config/generator-metadata.d.ts
-/**
- * A copy of `@supabase/postgrest-typegen`'s `GeneratorMetadata` contract
- * (version 1), so the published types don't reference the package: it is an
- * optional peer that only the CLI loads. `tests/config/generator-metadata.test-d.ts`
- * checks the copy against the pinned version.
- */
-interface PostgresColumn {
-  table_id: number;
-  schema: string;
-  table: string;
-  id: string;
-  ordinal_position: number;
-  name: string;
-  default_value: unknown;
-  data_type: string;
-  format: string;
-  type_schema: string;
-  is_identity: boolean;
-  identity_generation: "ALWAYS" | "BY DEFAULT" | null;
-  is_generated: boolean;
-  is_nullable: boolean;
-  is_updatable: boolean;
-  is_unique: boolean;
-  enums: string[];
-  check: string | null;
-  comment: string | null;
-}
-interface PostgresFunctionArg {
-  mode: "in" | "inout" | "out" | "table" | "variadic";
-  name: string;
-  type_id: number;
-  has_default: boolean | null;
-}
-interface PostgresFunction {
-  id: number;
-  schema: string;
-  name: string;
-  language: string;
-  definition: string;
-  complete_statement: string;
-  args: PostgresFunctionArg[];
-  argument_types: string;
-  identity_argument_types: string;
-  return_type_id: number;
-  return_type: string;
-  return_type_relation_id: number | null;
-  is_set_returning_function: boolean;
-  prorows: number | null;
-  behavior: "IMMUTABLE" | "STABLE" | "VOLATILE";
-  security_definer: boolean;
-  config_params: {
-    [x: string]: string;
-  } | null;
-}
-interface GeneratorMetadata {
-  version: 1;
-  schemas: {
-    id: number;
-    name: string;
-    owner: string;
-  }[];
-  tables: {
-    bytes: number;
-    comment: string | null;
-    dead_rows_estimate: number;
-    id: number;
-    live_rows_estimate: number;
-    name: string;
-    replica_identity: "DEFAULT" | "FULL" | "INDEX" | "NOTHING";
-    rls_enabled: boolean;
-    rls_forced: boolean;
-    schema: string;
-    size: string;
-  }[];
-  foreignTables: {
-    comment: string | null;
-    id: number;
-    name: string;
-    schema: string;
-  }[];
-  views: {
-    comment: string | null;
-    id: number;
-    is_insert_enabled?: boolean | undefined;
-    is_updatable: boolean;
-    is_update_enabled?: boolean | undefined;
-    name: string;
-    schema: string;
-  }[];
-  materializedViews: {
-    comment: string | null;
-    id: number;
-    is_populated: boolean;
-    name: string;
-    schema: string;
-  }[];
-  columns: PostgresColumn[];
-  primaryKeys: {
-    schema: string;
-    table_name: string;
-    name: string;
-    table_id: number;
-  }[];
-  relationships: {
-    foreign_key_name: string;
-    schema: string;
-    relation: string;
-    columns: string[];
-    is_one_to_one: boolean;
-    referenced_schema: string;
-    referenced_relation: string;
-    referenced_columns: string[];
-  }[];
-  functions: PostgresFunction[];
-  types: {
-    id: number;
-    name: string;
-    schema: string;
-    format: string;
-    enums: string[];
-    attributes: {
-      name: string;
-      type_id: number;
-    }[];
-    comment: string | null;
-    type_relation_id: number | null;
-  }[];
-}
-//#endregion
-//#region src/config/snapshot.d.ts
-/**
- * What `better-supabase introspect` reads from Postgres. `generator` is the
- * `@supabase/postgrest-typegen` contract (the same metadata behind
- * `supabase gen types`); `extras` holds what that contract leaves out.
- * Codegen and doctor both work from this snapshot, so either can run offline
- * from a saved file.
- */
-interface Snapshot {
-  readonly $schema?: string;
-  readonly version: 2;
-  /** Every schema that was read, including helper schemas for doctor. */
-  readonly schemas: readonly string[];
-  readonly generator: GeneratorMetadata;
-  readonly extras: SnapshotExtras;
-}
-/** Catalog details `GeneratorMetadata` does not carry. */
-interface SnapshotExtras {
-  readonly tables: readonly ExtrasTable[];
-  readonly buckets: readonly SnapshotBucket[];
-  /** Tables in the `supabase_realtime` publication, as `schema.table`. */
-  readonly realtime: readonly string[];
-  /**
-   * `alter role ... set` values for the Data API roles (`authenticator`),
-   * such as `pgrst.db_aggregates_enabled`. Absent in older snapshots.
-   */
-  readonly roleSettings?: Readonly<Record<string, Readonly<Record<string, string>>>>;
-  /**
-   * Functions that policies in the read schemas call, plus functions in
-   * those schemas with `set` options. Absent in older snapshots.
-   */
-  readonly functions?: readonly ExtrasFunction[];
-  /**
-   * The Postgres functions `supabase/config.toml` configures as Auth hooks,
-   * in any schema. Absent in older snapshots and without a `config.toml`.
-   */
-  readonly hooks?: readonly ExtrasHook[];
-  /**
-   * Set when the snapshot comes from a `GeneratorMetadata` document alone
-   * (`gen --metadata`): unique keys, checks and foreign keys are inferred from
-   * the columns and relationships, and the rest is empty, so doctor skips
-   * the rules that read it.
-   */
-  readonly fromMetadata?: true;
-}
-/** An `[auth.hook.<name>]` with a `pg-functions://` URI. */
-interface ExtrasHook {
-  /** `custom_access_token`, `send_email`, ... */
-  readonly hook: string;
-  readonly schema: string;
-  readonly name: string;
-  /** Every overload with that name; empty when the function does not exist. */
-  readonly functions: readonly ExtrasHookFunction[];
-}
-interface ExtrasHookFunction extends ExtrasFunction {
-  /**
-   * Of `supabase_auth_admin`, `authenticated` and `anon`, the roles that may
-   * execute it (directly or through `public`).
-   */
-  readonly execute: readonly string[];
-  /** Whether `public` may execute it (the default until revoked). */
-  readonly publicExecute: boolean;
-  /** Of the same roles, those with `usage` on its schema. */
-  readonly schemaUsage: readonly string[];
-  /** The function body (`pg_proc.prosrc`). Absent in snapshots that predate it. */
-  readonly source?: string;
-}
-/** A function as doctor needs it for RLS checks, in any schema. */
-interface ExtrasFunction {
-  readonly schema: string;
-  readonly name: string;
-  /** Identity arguments, e.g. `organization uuid`. */
-  readonly signature: string;
-  /** `sql`, `plpgsql`, `c`, ... */
-  readonly language: string;
-  readonly volatility: "immutable" | "stable" | "volatile";
-  readonly securityDefiner: boolean;
-  /** `set` options, e.g. `{ statement_timeout: '5s' }`. */
-  readonly settings: Readonly<Record<string, string>>;
-  /** Which of `anon` and `authenticated` may execute it. Absent in older snapshots. */
-  readonly execute?: readonly string[];
-}
-interface ExtrasTable {
-  /** Table oid, matching `GeneratorMetadata.tables[].id`. */
-  readonly id: number;
-  readonly schema: string;
-  readonly name: string;
-  /** Primary key columns in key order. */
-  readonly primaryKey: readonly string[];
-  readonly uniques: readonly CatalogUnique[];
-  readonly foreignKeys: readonly {
-    readonly name: string;
-    readonly onDelete: ForeignKeyAction;
-    readonly onUpdate: ForeignKeyAction;
-  }[];
-  readonly checks: readonly CatalogCheck[];
-  readonly indexes: readonly CatalogIndex[];
-  readonly policies: readonly CatalogPolicy[];
-  readonly triggers: readonly CatalogTrigger[];
-  readonly grants: readonly CatalogGrant[];
-  /** Absent in snapshots taken before column grants were introspected. */
-  readonly columnGrants?: readonly CatalogColumnGrant[];
-  /** Postgres estimates at least `LARGE_TABLE_ROWS` rows; the `unbounded-read` lint reads it. */
-  readonly large?: true;
-}
-type ForeignKeyAction = "no action" | "restrict" | "cascade" | "set null" | "set default";
-interface CatalogUnique {
-  readonly name: string;
-  readonly columns: readonly string[];
-}
-interface CatalogCheck {
-  readonly name: string;
-  readonly definition: string;
-}
-interface CatalogIndex {
-  readonly name: string;
-  readonly columns: readonly string[];
-  readonly unique: boolean;
-  readonly primary: boolean;
-  readonly partial: boolean;
-  /** Access method (`btree`, `gin`, `gist`, ...). Absent in older snapshots. */
-  readonly method?: string;
-  /** The `where` of a partial index, as Postgres prints it. Absent in older snapshots. */
-  readonly predicate?: string | null;
-}
-interface CatalogPolicy {
-  readonly name: string;
-  readonly command: "all" | "select" | "insert" | "update" | "delete";
-  readonly roles: readonly string[];
-  readonly permissive: boolean;
-  readonly using: string | null;
-  readonly check: string | null;
-  /**
-   * Functions the policy expressions call, as `schema.name`, from
-   * `pg_depend`. Absent in older snapshots.
-   */
-  readonly functions?: readonly string[];
-}
-interface CatalogTrigger {
-  readonly name: string;
-  readonly timing: "before" | "after" | "instead of";
-  readonly events: readonly ("insert" | "update" | "delete" | "truncate")[];
-  readonly level: "row" | "statement";
-  readonly function: string;
-}
-interface CatalogGrant {
-  readonly role: string;
-  readonly privileges: readonly string[];
-}
-/** A column-level `insert` or `update` grant to `anon` or `authenticated`. */
-interface CatalogColumnGrant {
-  readonly column: string;
-  readonly role: string;
-  readonly privileges: readonly string[];
-}
-interface SnapshotBucket {
-  readonly id: string;
-  readonly public: boolean;
-  readonly fileSizeLimit: number | null;
-  readonly allowedMimeTypes: readonly string[] | null;
-  /** `versioning_status`; absent when Storage has no versioning. */
-  readonly versioning?: "DISABLED" | "ENABLED" | "SUSPENDED" | null;
-  /** `lifecycle_configuration`; absent when Storage has no lifecycles. */
-  readonly lifecycle?: unknown;
-}
-/**
- * The snapshot joined into one record per table, function and enum. Codegen
- * and doctor read this view rather than the raw snapshot.
- */
-interface Catalog {
-  readonly schemas: readonly string[];
-  readonly tables: readonly CatalogTable[];
-  readonly enums: readonly CatalogEnum[];
-  readonly functions: readonly CatalogFunction[];
-  readonly buckets: readonly SnapshotBucket[];
-  readonly realtime: readonly string[];
-}
-interface CatalogTable {
-  readonly id: number;
-  readonly schema: string;
-  readonly name: string;
-  /** Materialized views count as views; foreign tables as tables. */
-  readonly kind: "table" | "view";
-  readonly rls: boolean;
-  readonly forceRls: boolean;
-  readonly replicaIdentity: "DEFAULT" | "INDEX" | "FULL" | "NOTHING" | null;
-  /** Inserts work (always true for tables). */
-  readonly insertable: boolean;
-  /** Updates work (always true for tables). */
-  readonly updatable: boolean;
-  readonly comment: string | null;
-  readonly columns: readonly CatalogColumn[];
-  readonly primaryKey: readonly string[];
-  readonly uniques: readonly CatalogUnique[];
-  readonly foreignKeys: readonly CatalogForeignKey[];
-  readonly checks: readonly CatalogCheck[];
-  readonly indexes: readonly CatalogIndex[];
-  readonly policies: readonly CatalogPolicy[];
-  readonly triggers: readonly CatalogTrigger[];
-  readonly grants: readonly CatalogGrant[];
-  /** Absent in snapshots taken before column grants were introspected. */
-  readonly columnGrants?: readonly CatalogColumnGrant[];
-}
-interface CatalogColumn {
-  readonly name: string;
-  /** Type name; the element type for arrays (`uuid`, `int8`, `note_kind`). */
-  readonly udt: string;
-  /** Raw type name as Postgres reports it (`_text` for `text[]`). */
-  readonly format: string;
-  readonly typeSchema: string;
-  readonly isArray: boolean;
-  readonly isEnum: boolean;
-  readonly nullable: boolean;
-  readonly hasDefault: boolean;
-  readonly default: string | null;
-  readonly identity: "always" | "by default" | null;
-  readonly generated: boolean;
-  readonly updatable: boolean;
-  readonly comment: string | null;
-}
-interface CatalogForeignKey {
-  readonly name: string;
-  readonly columns: readonly string[];
-  readonly refSchema: string;
-  readonly refTable: string;
-  readonly refColumns: readonly string[];
-  readonly oneToOne: boolean;
-  readonly onDelete: ForeignKeyAction;
-  readonly onUpdate: ForeignKeyAction;
-}
-interface CatalogEnum {
-  readonly schema: string;
-  readonly name: string;
-  readonly values: readonly string[];
-}
-interface CatalogFunction {
-  readonly schema: string;
-  readonly name: string;
-  /** Signature that tells overloads apart, e.g. `a integer, b text`. */
-  readonly signature: string;
-  readonly args: readonly CatalogFunctionArg[];
-  /** Columns for `returns table (...)` functions. */
-  readonly returnsTable: readonly {
-    readonly name: string;
-    readonly udt: string;
-    /** Schema of the column's type, when typegen knows it. */
-    readonly typeSchema?: string;
-  }[] | null;
-  /** Return type name (`int4`, `_text`, a table's row type). */
-  readonly returns: string;
-  /** Schema of the return type, when typegen knows it. */
-  readonly returnsSchema?: string;
-  /** `schema.table` when the function returns rows of a table or view. */
-  readonly returnsRelation: string | null;
-  readonly returnsSet: boolean;
-  readonly volatility: "immutable" | "stable" | "volatile";
-  readonly securityDefiner: boolean;
-  readonly language: string;
-  /** `search_path` from `SET search_path`, or `null` when unset. */
-  readonly searchPath: string | null;
-}
-interface CatalogFunctionArg {
-  readonly name: string;
-  readonly udt: string;
-  /** Schema of the argument's type, when typegen knows it. */
-  readonly typeSchema?: string;
-  readonly isArray: boolean;
-  readonly hasDefault: boolean;
-}
-//#endregion
-//#region src/config/config.d.ts
-/**
- * Where codegen reads the database from. Without any of these, `$DATABASE_URL`
- * and then the local stack (`supabase start`) are used.
- */
-interface SourceConfig {
-  /** Postgres connection string. */
-  readonly dbUrl?: string;
-  /**
-   * Hosted project ref. Read through the Management API's read-only SQL
-   * endpoint, so no database password is needed.
-   */
-  readonly projectRef?: string;
-  /**
-   * Management API token for `projectRef`. Defaults to
-   * `$SUPABASE_ACCESS_TOKEN`; prefer the env var over committing a token.
-   */
-  readonly accessToken?: string;
-  /** Read a saved `better-supabase introspect` snapshot instead of connecting. */
-  readonly snapshot?: string;
-}
-/**
- * A JSON Schema object, or a Standard JSON Schema value (zod 4, valibot,
- * arktype, ...) that can produce one.
- */
-type JsonSchemaSource = Readonly<Record<string, unknown>> | {
-  readonly "~standard": {
-    readonly jsonSchema: {
-      readonly input: (options: {
-        readonly target: string;
-      }) => Record<string, unknown>;
-    };
-  };
-};
-type JsonTypeConfig = ({
-  readonly import: string;
-} | {
-  readonly type: string;
-}) & {
-  /** Enforced in the database by `sql add jsonb-schemas` (pg_jsonschema). */
-  readonly schema?: JsonSchemaSource;
-};
-/** The JSON Schema document for a `json[...].schema` entry. */
-declare function resolveJsonSchema(source: JsonSchemaSource): Readonly<Record<string, unknown>>;
-interface TableConfig {
-  readonly casing?: Casing;
-  /** Leave the table out of the generated models. */
-  readonly exclude?: boolean;
-  /**
-   * Keep the table off the Data API on purpose: only `service_role` reaches
-   * it. The models are still generated for admin clients, and doctor (BS106)
-   * checks that `anon` and `authenticated` have no grants instead of
-   * requiring them.
-   */
-  readonly serviceRole?: boolean;
-  /** Rename generated relations: `{ primaryContact: 'contact' }`. */
-  readonly relations?: Readonly<Record<string, string>>;
-  /**
-   * Database names of not-null columns an insert may leave out because the
-   * database fills them, for example from a `before insert` trigger. `gen`
-   * makes them optional in `InsertOf` and the insert validators.
-   */
-  readonly insertOptional?: readonly string[];
-}
-interface FunctionConfig {
-  /** `true`, or the `returns table` columns (database names) that are never null. */
-  readonly notNull?: true | readonly string[];
-}
-interface TimestampsConfig {
-  readonly createdAt?: string;
-  readonly updatedAt?: string;
-}
-interface SoftDeleteConfig {
-  readonly column?: string;
-}
-interface TenantConfig {
-  readonly column?: string;
-}
-/** Claim names shared by the SQL modules, codegen and the runtime defaults. */
-interface ClaimsConfig {
-  /** Top-level claim holding the active tenant id. Defaults to `tenant_id`. */
-  readonly tenant?: string;
-  /** `scope` of the tenant entries `membership_claims()` writes. Defaults to `tenant`. */
-  readonly scope?: string;
-  /** Claim holding plan features per tenant (`{ [tenantId]: string[] }`). Defaults to `features`. */
-  readonly features?: string;
-  /** Claim the memberships hook (`membership_claims()` or the provider's) writes. Defaults to `memberships`. */
-  readonly memberships?: string;
-}
-interface ActorConfig {
-  readonly createdBy?: string;
-  readonly updatedBy?: string;
-  /** Defaults to `impersonated_by`, the column the SQL modules' `track_actor` fills. */
-  readonly impersonatedBy?: string;
-}
-interface PluginFlagsConfig {
-  readonly timestamps?: boolean | TimestampsConfig;
-  readonly softDelete?: boolean | SoftDeleteConfig;
-  readonly tenant?: boolean | TenantConfig;
-  readonly actor?: boolean | ActorConfig;
-}
-interface BucketConfig {
-  readonly id?: string;
-  readonly public?: boolean;
-  /**
-   * Path template with `{placeholders}`, e.g. `{organizationId}/{customerId}/logo.webp`,
-   * or several when the bucket stores objects in more than one layout. A last
-   * segment `{...rest}` matches one or more segments.
-   */
-  readonly path: string | readonly [string, ...string[]];
-  /** Generated storage policy, or an access contract policy (`{ access }`). */
-  readonly policy?: BucketPolicyName | AccessBucketPolicy;
-  readonly fileSizeLimit?: string;
-  readonly allowedMimeTypes?: readonly string[];
-  /** Keep earlier object versions. `bucket.apply()` sets it; doctor (BS302) compares it. */
-  readonly versioning?: boolean;
-  /** When noncurrent versions expire. Needs `versioning: true`. */
-  readonly lifecycle?: BucketLifecycle;
-}
-interface SqlConfig {
-  /** Directory declarative schema files are written to. */
-  readonly dir?: string;
-  /** File name prefix, so generated files sort after yours. */
-  readonly prefix?: string;
-  /** Directory pgTAP files (the `pgtap` module) are written to. */
-  readonly testsDir?: string;
-  /**
-   * The SQL modules to keep in sync (`better-supabase sql add`): a list of
-   * names, or an object keyed by module name whose values set each module's
-   * mode, schema, table and column names, permission keys and options.
-   */
-  readonly modules?: readonly string[] | ModulesConfig;
-}
-/** `sql` with defaults applied: settings per module, and their names in order. */
-interface ResolvedSqlConfig {
-  readonly dir: string;
-  readonly prefix: string;
-  readonly testsDir: string;
-  readonly modules: ModulesConfig;
-  readonly moduleNames: readonly string[];
-}
-interface SeedConfig {
-  /** Module exporting `defineSeed(...)` as `seed` or default. */
-  readonly entry?: string;
-  /** SQL file `better-supabase seed` writes. Add it to `[db.seed] sql_paths`. */
-  readonly output?: string;
-}
-interface OpenApiConfig {
-  /** Module exporting the document (or a function returning it) as `openapi` or default. */
-  readonly entry?: string;
-  /** JSON file `better-supabase openapi emit` writes. */
-  readonly output?: string;
-}
-interface DoctorConfig {
-  /** Finding codes to skip, e.g. `['BS204']`. */
-  readonly ignore?: readonly string[];
-  /** Treat warnings as errors. */
-  readonly strict?: boolean;
-  /**
-   * App source files doctor scans for API use (BS210). Globs relative to the
-   * root. Defaults to `['src/**\/*.{ts,tsx}']`.
-   */
-  readonly sources?: readonly string[];
-  /**
-   * How many policies a security definer helper may appear in before BS206
-   * asks for an inlinable `language sql stable` function. Defaults to 5.
-   */
-  readonly policyHelperLimit?: number;
-  /**
-   * The BS405 limit in bytes. When the authorization provider's token hook
-   * has a budget, it replaces that budget and the whole token keeps 2048.
-   * Otherwise it limits the whole token's claims (default 2048).
-   */
-  readonly claimsLimit?: number;
-}
-/**
- * Runtime types for columns whose JSON form loses information. Defaults
- * match `supabase gen types`: timestamps as ISO strings, `int8` and
- * `numeric` as numbers.
- */
-interface CodecsConfig {
-  /**
-   * `'instant'` decodes `timestamptz` columns to `Temporal.Instant` and
-   * `timestamp` columns to `Temporal.PlainDateTime`.
-   */
-  readonly timestamptz?: "string" | "instant";
-  /** `'bigint'` or `'string'` read `int8` exactly (above 2^53). */
-  readonly int8?: "number" | "string" | "bigint";
-  /** `'string'` reads `numeric` exactly. */
-  readonly numeric?: "number" | "string";
-}
-interface GeneratedFile {
-  /** Path relative to the project root. */
-  readonly path: string;
-  readonly contents: string;
-}
-interface GeneratorInput {
-  readonly meta: SchemaMeta;
-  /**
-   * The `@supabase/postgrest-typegen` metadata for the configured schemas,
-   * the same contract `supabase gen types` is built on.
-   */
-  readonly introspection: GeneratorMetadata;
-  /** Constraints, indexes, policies, triggers and grants typegen leaves out. */
-  readonly extras: SnapshotExtras;
-  readonly config: ResolvedConfig;
-  /** Absolute path of the main generated module. */
-  readonly output: string;
-  /** Import path from `from` (a generated file) to `to`, with extension. */
-  readonly importPath: (from: string, to: string) => string;
-  /**
-   * The tables and enums `gen` emits, with the TypeScript type it wrote for
-   * each column (after `json` overrides, codecs and enum unions). Frozen.
-   */
-  readonly model: GeneratorModel;
-}
-interface GeneratorColumn {
-  /** Name in rows, after casing. */
-  readonly app: string;
-  /** Database name. */
-  readonly db: string;
-  /** TypeScript type without `| null`. */
-  readonly tsType: string;
-  readonly nullable: boolean;
-  /** Optional on insert. */
-  readonly optional: boolean;
-  /** Generated or identity always: never written. */
-  readonly readonly: boolean;
-  /** Enum or check-constraint values, when the column has a closed set. */
-  readonly values: readonly string[] | undefined;
-  readonly json: boolean;
-}
-interface GeneratorTable {
-  /** Key in `schema.tables` and on the client. */
-  readonly key: string;
-  readonly schema: string;
-  readonly name: string;
-  readonly casing: Casing;
-  readonly columns: readonly GeneratorColumn[];
-}
-interface GeneratorModel {
-  readonly tables: readonly GeneratorTable[];
-  readonly enums: readonly {
-    readonly schema: string;
-    readonly name: string;
-    readonly values: readonly string[];
-  }[];
-}
-/**
- * Codegen extension point. First-party generators: `zod()`, `valibot()`,
- * `jsonSchema()`. Prove custom ones with `testGenerator`.
- */
-interface Generator {
-  /** The generator contract it targets. `gen` refuses versions it doesn't know. */
-  readonly apiVersion?: 1;
-  readonly name: string;
-  generate(input: GeneratorInput): readonly GeneratedFile[] | Promise<readonly GeneratedFile[]>;
-}
-interface RealtimeConfig {
-  /**
-   * Tables that broadcast a change signal for live queries (`table` or
-   * `schema.table`). Tenant tables broadcast per tenant. Install the
-   * triggers with `better-supabase sql add realtime-tables`.
-   */
-  readonly tables?: readonly string[];
-  /**
-   * Tables in `tables` without a tenant column. They broadcast on one topic
-   * every signed-in user receives. With the `tenant` plugin, a table that
-   * lacks the tenant column and is not listed here fails to install.
-   */
-  readonly global?: readonly string[];
-  /**
-   * Tables in `tables` whose rows belong to one user: table to its user
-   * column (`{ notifications: "user_id" }`). They broadcast on a topic per
-   * user, `bs:t:<schema>.<table>:u:<user id>`, which only that user
-   * receives, instead of the tenant's topic.
-   */
-  readonly users?: Readonly<Record<string, string>>;
-  /**
-   * Writes the `realtime.messages` policies of the topics that `from`
-   * exports (`defineTopic`) to `output`, a file in `supabase/schemas`, on
-   * `better-supabase sql sync`; `sql sync --check` fails when it is stale.
-   */
-  readonly policies?: TopicPoliciesConfig;
-}
-/** `realtime.policies`: where topic policies come from and go. */
-interface TopicPoliciesConfig {
-  /** Modules that export `defineTopic` results. Node imports them. */
-  readonly from: readonly string[];
-  /** The SQL file to write, such as `supabase/schemas/905_topics.sql`. */
-  readonly output: string;
-}
-interface EntitlementsConfig {
-  /**
-   * `table.column` (or `schema.table.column`) holding each tenant's Stripe
-   * customer id, read by the `entitlements` SQL module. Required
-   * without the `organizations` module; with it, defaults to the
-   * `stripe_customer_id` column that module adds.
-   */
-  readonly customer?: string;
-  /** The tenant id column of that table. Defaults to `id`. */
-  readonly key?: string;
-  /**
-   * Where `has_entitlement` and `feature_claims` read memberships from.
-   * `"provider"` calls the authorization provider's `memberIds` and
-   * `memberIdsFor` functions; `"tenant"` reads `better_supabase.memberships`.
-   * Defaults to `"provider"` when `authorization` is set, else `"tenant"`.
-   */
-  readonly memberships?: "tenant" | "provider";
-  /**
-   * Where each tenant's entitlements come from. `"stripe-sync"` (the
-   * default) reads the Stripe Sync Engine's `stripe.active_entitlements`
-   * through `customer`. `{ plans }` reads a plan catalog: the tenant's
-   * active subscription and the features its plan includes. `"custom"`
-   * leaves `better_supabase.tenant_entitlements(tenant)` to you; the module
-   * writes the checks and the claim over it.
-   */
-  readonly source?: "stripe-sync" | "custom" | EntitlementPlansSource;
-  /**
-   * The shape of the features claim `feature_claims` writes, which every
-   * token carries. `false` writes `{}` (check entitlements in SQL with
-   * `has_entitlement` only); `maxTenants` keeps at most that many tenants;
-   * `keys` writes short codes instead of the feature keys. Pass the same
-   * `keys` to `hasEntitlement`.
-   */
-  readonly claim?: false | {
-    readonly maxTenants?: number;
-    readonly keys?: Readonly<Record<string, string>>;
-  };
-}
-/** `entitlements.source.plans`: a plan catalog in your own tables. */
-interface EntitlementPlansSource {
-  readonly plans: {
-    readonly subscriptions: {
-      /** `table` or `schema.table`. */
-      readonly table: string;
-      /** The tenant id column. */
-      readonly tenant: string;
-      /** The plan key column. */
-      readonly plan: string;
-      /** A status column; with it, only rows in `activeStatuses` count. */
-      readonly status?: string;
-      /** Defaults to `["active", "trialing"]`. */
-      readonly activeStatuses?: readonly string[];
-    };
-    readonly features: {
-      /** `table` or `schema.table`. */
-      readonly table: string;
-      /** The plan key column. */
-      readonly plan: string;
-      /** The feature key column: what `has_entitlement` and the claim name. */
-      readonly feature: string;
-      /** A boolean column; with it, only included features count. */
-      readonly included?: string;
-      /**
-       * A column with the feature's value (a number, text or jsonb), such as
-       * a limit, that `tenant_entitlement_value` returns.
-       */
-      readonly value?: string;
-    };
-  };
-}
-/** pgvector distance: `<=>` (cosine), `<->` (l2) or `<#>` (negative inner product). */
-type VectorDistance = "cosine" | "l2" | "inner_product";
-/** The embedding column, or the column and its distance (default `cosine`). */
-type VectorSearchConfig = string | {
-  readonly column: string;
-  readonly distance?: VectorDistance;
-  /** The column's pgvector type. Defaults to `vector`. */
-  readonly type?: "vector" | "halfvec";
-  /** The primary key column `db.$search({ score: true })` merges by. Defaults to `id`. */
-  readonly key?: string;
-  /**
-   * Fuses a full-text ranking over a `tsvector` column with the vector
-   * ranking (reciprocal rank fusion), for `db.$search({ text })`.
-   */
-  readonly hybrid?: {
-    readonly tsvector: string;
-    /** The query's text search configuration. Defaults to `simple`. */
-    readonly config?: string;
-    /** The RRF constant. Defaults to 60. */
-    readonly k?: number;
-  };
-  /** A SQL expression over the row `t` the score is multiplied by, such as `t.priority`. */
-  readonly boost?: string;
-  /** Columns `db.$search({ filter })` narrows before ranking. */
-  readonly prefilter?: readonly string[];
-  /**
-   * A SQL condition over the row `t` every candidate must meet, applied
-   * before ranking: ranges, a parent row, such as
-   * `t.expires_at > now() and exists (select 1 from public.folders f where f.id = t.folder_id and not f.disabled)`.
-   */
-  readonly predicate?: string;
-  /** How `boost` combines with the score: `multiply` (default) or `add`. */
-  readonly boostMode?: "multiply" | "add";
-  /** A SQL `order by` list over the row `t` that breaks score ties, such as `t.created_at desc`. */
-  readonly order?: string;
-};
-/** A privilege the Data API roles can be granted on a table or view. */
-type Privilege = "select" | "insert" | "update" | "delete";
-type ColumnPrivilege = `${"select" | "insert" | "update"}(${string})`;
-type ExposePrivilege = Privilege | ColumnPrivilege;
-/** A role the `grants` module writes privileges for. */
-type ExposeRole = "anon" | "authenticated" | "service_role";
-/**
- * Data API grants for one table: privileges for `authenticated`, or per
- * role. `serviceRole` defaults to every privilege. For a function, keyed by
- * its signature (`search_notes(text, integer)`), `execute` lists the roles
- * that may call it; `service_role` is added unless `serviceRole` is false.
- */
-type ExposeConfig = readonly ExposePrivilege[] | {
-  readonly anon?: readonly ExposePrivilege[];
-  readonly authenticated?: readonly ExposePrivilege[];
-  readonly serviceRole?: readonly ExposePrivilege[];
-} | {
-  readonly execute: readonly ("anon" | "authenticated")[];
-  readonly serviceRole?: boolean;
-};
-/** Resolved grants for one table. */
-interface ResolvedExpose {
-  readonly anon: readonly ExposePrivilege[];
-  readonly authenticated: readonly ExposePrivilege[];
-  readonly serviceRole: readonly ExposePrivilege[];
-}
-interface RelationsConfig {
-  /**
-   * Type a to-one include as `| null` when the related table has row level
-   * security, even over a `not null` foreign key, since a policy can hide
-   * the related row. `required: true` on the include keeps it non-null.
-   * Defaults to `false`.
-   */
-  readonly nullableUnderRls?: boolean;
-}
-interface BetterSupabaseConfig {
-  readonly $schema?: string;
-  readonly source?: SourceConfig;
-  /** Postgres schemas to generate. Defaults to `['public']`. */
-  readonly schemas?: readonly string[];
-  /** Casing of generated models and returned rows. Defaults to `'snake'`. */
-  readonly casing?: Casing;
-  readonly tables?: Readonly<Record<string, TableConfig>>;
-  /**
-   * Main generated module. Defaults to `src/lib/supabase/generated.ts`;
-   * `database.types.ts` is written next to it.
-   */
-  readonly output?: string;
-  /**
-   * PostgREST major version, written to `__InternalSupabase` in
-   * `database.types.ts` so `createClient` picks matching behavior.
-   * Defaults to `'13'`.
-   */
-  readonly postgrestVersion?: string;
-  /** Types for jsonb columns, keyed by `table.column`. */
-  readonly json?: Readonly<Record<string, JsonTypeConfig>>;
-  readonly codecs?: CodecsConfig;
-  readonly relations?: RelationsConfig;
-  /**
-   * Columns that must not be read by accident (`table.column` or
-   * `schema.table.column`, database names), for the `noSensitiveSelect` rule.
-   */
-  readonly sensitive?: readonly string[];
-  /**
-   * Text columns that hold an object path, keyed by `table.column` or
-   * `schema.table.column` (database names), with the bucket as the value (a
-   * `buckets` key or a bucket id). Generated rows type them as
-   * `StoragePath<'bucket-id'>`.
-   */
-  readonly storagePaths?: Readonly<Record<string, string>>;
-  /**
-   * Function results `gen` may type as not null, keyed by function name.
-   * Results are `| null` by default, since Postgres can't promise a function
-   * returns a value. `notNull: true` covers the whole result (each element
-   * of a set, each column of `returns table`); a list names the
-   * `returns table` columns that are never null.
-   */
-  readonly functions?: Readonly<Record<string, FunctionConfig>>;
-  /**
-   * Data API grants, keyed by `table` or `schema.table`, and function
-   * `execute` grants, keyed by `name(argument types)` or
-   * `schema.name(argument types)`. Supabase no longer grants new tables to
-   * `anon` and `authenticated` automatically; the `grants` SQL module writes
-   * these as the complete privilege set (it revokes what is not listed), and
-   * doctor (BS106) checks them. Tables not listed need `select, insert,
-   * update, delete` for `authenticated` (`select` for views).
-   */
-  readonly expose?: Readonly<Record<string, ExposeConfig>>;
-  /**
-   * Modules that export `defineReadSet` results. `gen` compiles each set to
-   * a function in the `read-sets` SQL module. Node imports them, so
-   * relative imports need their `.ts` extension.
-   */
-  readonly readSets?: readonly string[];
-  readonly generators?: readonly Generator[];
-  /** Enables plugin flags in the generated metadata. */
-  readonly plugins?: PluginFlagsConfig;
-  readonly claims?: ClaimsConfig;
-  readonly buckets?: Readonly<Record<string, BucketConfig>>;
-  /** Realtime topic templates: `{ notifications: 'organization:{organizationId}:notifications' }`. */
-  readonly topics?: Readonly<Record<string, string>>;
-  readonly realtime?: RealtimeConfig;
-  readonly entitlements?: EntitlementsConfig;
-  /**
-   * An authorization system the SQL modules, policies and doctor delegate
-   * to: the `provider` access model, `entitlements.memberships` and the
-   * hook and policy checks.
-   */
-  readonly authorization?: AuthorizationProvider;
-  /**
-   * Embedding columns, keyed by `table` or `schema.table`. The
-   * `vector-search` SQL module writes `search_<table>(query, k)` for each,
-   * which `db.$search(table, { vector, k })` calls.
-   */
-  readonly vectorSearch?: Readonly<Record<string, VectorSearchConfig>>;
-  readonly sql?: SqlConfig;
-  readonly seed?: SeedConfig;
-  readonly openapi?: OpenApiConfig;
-  readonly doctor?: DoctorConfig;
-}
-/** The config with defaults applied. */
-interface ResolvedConfig {
-  readonly root: string;
-  readonly source: SourceConfig;
-  readonly schemas: readonly string[];
-  readonly casing: Casing;
-  readonly tables: Readonly<Record<string, TableConfig>>;
-  readonly output: string;
-  /** `database.types.ts` next to `output`. */
-  readonly databaseTypesOutput: string;
-  readonly postgrestVersion: string;
-  readonly json: Readonly<Record<string, JsonTypeConfig>>;
-  readonly codecs: Required<CodecsConfig>;
-  readonly relations: Required<RelationsConfig>;
-  readonly sensitive: readonly string[];
-  readonly storagePaths: Readonly<Record<string, string>>;
-  readonly functions: Readonly<Record<string, FunctionConfig>>;
-  /** The table entries of `expose`. */
-  readonly expose: Readonly<Record<string, ResolvedExpose>>;
-  /** The function entries of `expose`: the roles that may execute each one. */
-  readonly exposeFunctions: Readonly<Record<string, readonly ExposeRole[]>>;
-  readonly readSets: readonly string[];
-  readonly generators: readonly Generator[];
-  readonly plugins: {
-    readonly timestamps: Required<TimestampsConfig> | undefined;
-    readonly softDelete: Required<SoftDeleteConfig> | undefined;
-    readonly tenant: Required<TenantConfig> | undefined;
-    readonly actor: Required<ActorConfig> | undefined;
-  };
-  readonly claims: Required<ClaimsConfig>;
-  readonly buckets: Readonly<Record<string, BucketConfig>>;
-  readonly entitlements: {
-    /** Unset without `entitlements.customer`. */
-    readonly table?: string;
-    readonly column?: string;
-    readonly key: string;
-    readonly memberships: "tenant" | "provider";
-    readonly source: NonNullable<EntitlementsConfig["source"]>;
-    readonly claim?: NonNullable<EntitlementsConfig["claim"]>;
-  };
-  readonly authorization?: AuthorizationProvider;
-  readonly vectorSearch: readonly ({
-    readonly table: string;
-    readonly column: string;
-    readonly distance: VectorDistance;
-  } & Omit<Exclude<VectorSearchConfig, string>, "column" | "distance">)[];
-  readonly topics: Readonly<Record<string, string>>;
-  readonly realtime: Required<Omit<RealtimeConfig, "policies">> & {
-    readonly policies?: TopicPoliciesConfig;
-  };
-  readonly sql: ResolvedSqlConfig;
-  readonly seed: Required<SeedConfig>;
-  readonly openapi: Required<OpenApiConfig>;
-  readonly doctor: Required<Omit<DoctorConfig, "claimsLimit">> & Pick<DoctorConfig, "claimsLimit">;
-}
-declare const CONFIG_SCHEMA_URL = "https://unpkg.com/better-supabase/schemas/config-v1.json";
-/** Identity helper that types `better-supabase.config.ts`. */
-declare function defineConfig(config: BetterSupabaseConfig): BetterSupabaseConfig;
-/** Applies defaults. Paths stay relative to `root`. */
-declare function resolveConfig(config: BetterSupabaseConfig, root: string): ResolvedConfig;
-//#endregion
-export { CatalogTable as $, SeedConfig as A, resolveConfig as B, PluginFlagsConfig as C, ResolvedConfig as D, RelationsConfig as E, TenantConfig as F, CatalogColumnGrant as G, Catalog as H, TimestampsConfig as I, CatalogFunction as J, CatalogEnum as K, VectorDistance as L, SourceConfig as M, SqlConfig as N, ResolvedExpose as O, TableConfig as P, CatalogPolicy as Q, VectorSearchConfig as R, OpenApiConfig as S, RealtimeConfig as T, CatalogCheck as U, resolveJsonSchema as V, CatalogColumn as W, CatalogGrant as X, CatalogFunctionArg as Y, CatalogIndex as Z, GeneratorInput as _, ClaimsConfig as a, ExtrasTable as at, JsonSchemaSource as b, DoctorConfig as c, SnapshotBucket as ct, ExposeConfig as d, PostgresColumn as dt, CatalogTrigger as et, ExposePrivilege as f, PostgresFunction as ft, GeneratorColumn as g, Generator as h, CONFIG_SCHEMA_URL as i, ExtrasHookFunction as it, SoftDeleteConfig as j, ResolvedSqlConfig as k, EntitlementPlansSource as l, SnapshotExtras as lt, GeneratedFile as m, BetterSupabaseConfig as n, ExtrasFunction as nt, CodecsConfig as o, ForeignKeyAction as ot, ExposeRole as p, PostgresFunctionArg as pt, CatalogForeignKey as q, BucketConfig as r, ExtrasHook as rt, ColumnPrivilege as s, Snapshot as st, ActorConfig as t, CatalogUnique as tt, EntitlementsConfig as u, GeneratorMetadata as ut, GeneratorModel as v, Privilege as w, JsonTypeConfig as x, GeneratorTable as y, defineConfig as z };