better-supabase 0.2.0 → 0.4.0

package/dist/sql/index.d.ts

@@ -0,0 +1,139 @@
+import { s as ClaimsMeta } from "../types-DONv9SHN.js";
+import { B as ReadSet } from "../define-CRS2MRV3.js";
+import { b as ResolvedConfig } from "../config-C1CYcm6o.js";
+import { n as permdockKeys } from "../permdock-sql-DImJULY-.js";
+//#region src/sql/kit.d.ts
+/**
+ * SQL kit modules for `better-supabase sql add`. Every module is idempotent
+ * (`create or replace`, `if not exists`), so re-running it upgrades in place.
+ */
+interface SqlModule {
+  readonly name: string;
+  readonly title: string;
+  readonly description: string;
+  /** Modules this one needs, added along with it. */
+  readonly requires: readonly string[];
+  /** What it needs instead when the layout has `permdock`. */
+  readonly permdockRequires?: readonly string[];
+  /** `schema` files go with your schemas; `test` files go to `supabase/tests`. */
+  readonly target: "schema" | "test";
+  /** The module with the default claim names. */
+  readonly sql: string;
+  /** The module for configured claim names (`config.claims`), when it reads claims. */
+  readonly render?: (claims: ClaimsMeta, layout: KitLayout) => string;
+}
+/** New modules go at the end: the position is part of the file name. */
+export declare const SQL_MODULES: Readonly<Record<string, SqlModule>>;
+/** The modules to install for `names`, dependencies first. Throws on an unknown name. */
+export declare function resolveModules(names: readonly string[], layout?: KitLayout): SqlModule[];
+interface KitFile {
+  readonly module: string;
+  readonly path: string;
+  readonly contents: string;
+}
+interface KitLayout {
+  /** Directory for schema modules. Defaults to `supabase/schemas`. */
+  readonly dir?: string;
+  /** File prefix. Defaults to `900_better_supabase`. */
+  readonly prefix?: string;
+  /** Directory for pgTAP files. Defaults to `supabase/tests`. */
+  readonly testsDir?: string;
+  /** Version stamped into the header. */
+  readonly version?: string;
+  /** `config.realtime.tables`: registered at the end of the `realtime-tables` module. */
+  readonly realtimeTables?: readonly string[];
+  /** Tenant column passed to `track_realtime`; tables without it broadcast unscoped. */
+  readonly tenantColumn?: string;
+  /** Check constraints for the `jsonb-schemas` module. */
+  readonly jsonSchemas?: readonly JsonSchemaCheck[];
+  /** `config.expose`: the grants the `grants` module writes. */
+  readonly grants?: readonly TableGrant[];
+  /** `config.readSets`, compiled: the functions the `read-sets` module writes. */
+  readonly readSets?: readonly {
+    readonly name: string;
+    readonly sql: string;
+  }[];
+  /** `config.entitlements`: where the `entitlements` module finds each tenant's Stripe customer. */
+  readonly entitlements?: EntitlementsSource;
+  /** `config.vectorSearch`: the tables the `vector-search` module writes a search function for. */
+  readonly vectorSearch?: readonly VectorSearchTable[];
+  /** `config.claims`: claim names the modules read and write. */
+  readonly claims?: ClaimsMeta;
+  /** PermDock's helpers and membership sources, from its manifest: `entitlements` reads them instead of `tenant`. */
+  readonly permdock?: KitPermdock;
+}
+/** One PermDock membership source, from the manifest's `memberships`. */
+interface KitMembershipSource {
+  /** `schema.table`. */
+  readonly table: string;
+  readonly userColumn: string;
+  readonly scope: {
+    readonly column: string;
+  } | {
+    readonly value: string;
+  };
+  readonly idColumn: string;
+}
+/** Where PermDock's `member_<scope>_ids` helpers live, and the tables behind them. */
+interface KitPermdock {
+  /** PermDock's `rls.schema`. */
+  readonly schema: string;
+  /** The PermDock scope tenants map to, e.g. `organization`. */
+  readonly scope: string;
+  readonly memberships: readonly KitMembershipSource[];
+}
+/** An embedding column `db.$search` can query. */
+interface VectorSearchTable {
+  /** `table` or `schema.table`. */
+  readonly table: string;
+  readonly column: string;
+  readonly distance: "cosine" | "l2" | "inner_product";
+}
+/** The table holding each tenant's Stripe customer id. */
+interface EntitlementsSource {
+  /** `table` or `schema.table`. */
+  readonly table: string;
+  /** Column with the Stripe customer id (`cus_...`). */
+  readonly column: string;
+  /** Column with the tenant id. */
+  readonly key: string;
+}
+/** Privileges one Data API role gets on a table or view. */
+interface TableGrant {
+  /** `table` or `schema.table`. */
+  readonly table: string;
+  readonly role: "anon" | "authenticated";
+  readonly privileges: readonly ("select" | "insert" | "update" | "delete")[];
+}
+/** A jsonb column and the JSON Schema its values must match. */
+interface JsonSchemaCheck {
+  /** `table` or `schema.table`. */
+  readonly table: string;
+  readonly column: string;
+  readonly schema: Readonly<Record<string, unknown>>;
+}
+/** Whether an installed file matches, ignoring the version stamped in its header. */
+export declare function sameKitFile(current: string | undefined, expected: string): boolean;
+/** The files `sql add` writes for these modules. */
+export declare function renderKit(names: readonly string[], layout?: KitLayout): KitFile[];
+//#endregion
+//#region src/sql/layout.d.ts
+/** Where and how `sql add` writes kit files for this config. */
+export declare function kitLayout(config: ResolvedConfig, testsDir?: string, readSets?: KitLayout["readSets"], permdock?: KitPermdock): KitLayout;
+//#endregion
+//#region src/sql/read-sets.d.ts
+/** A read set compiled to the SQL of its function. */
+interface CompiledReadSet {
+  readonly name: string;
+  readonly sql: string;
+}
+/**
+ * The function for a read set: `stable`, `security invoker` (RLS applies to
+ * the caller) and with an empty `search_path`. Parameters are read from the
+ * `p jsonb` argument; nothing is built dynamically.
+ */
+export declare function compileReadSet(set: ReadSet): Promise<CompiledReadSet>;
+/** Compiles every set, sorted by name. Throws on a duplicate name. */
+export declare function compileReadSets(sets: readonly ReadSet[]): Promise<CompiledReadSet[]>;
+//#endregion
+export { type CompiledReadSet, type KitFile, type KitLayout, type KitPermdock, type SqlModule, permdockKeys };