better-supabase 0.7.0 → 0.8.0

package/dist/sql/index.d.ts

@@ -1,9 +1,9 @@
-import { n as AccessPolicySql, u as ClaimsMeta } from "../types-6BdhkmZe.js";
-import { K as ReadSet } from "../define-CJJkkr1-.js";
+import { n as AccessPolicySql, u as ClaimsMeta } from "../types-CoE5Zwy4.js";
+import { q as ReadSet } from "../define-DmcfoNXB.js";
 import { i as DisabledRow, o as ModuleMode, s as ModulesConfig } from "../modules-DpPwzC7E.js";
 import { n as AuthorizationMembership, o as AuthorizationRoleSource, t as AuthorizationFunctions } from "../authorization-BFCqamMs.js";
-import { a as ModuleAudit, c as ModuleEmit, d as ModuleTableSpec, f as contractSignature, i as ModuleAction, l as ModuleIdType, m as moduleIdType, n as AuditCategory, o as ModuleContext, p as isModuleIdType, r as MODULE_ID_TYPES, s as ModuleContractFunction, t as AUDIT_CATEGORIES, u as ModuleNames } from "../context-BCrWe7ow.js";
-import { D as ResolvedConfig, l as EntitlementPlansSource } from "../config-D44Y7PAv.js";
+import { a as ModuleAudit, c as ModuleEmit, d as ModuleTableSpec, f as contractSignature, i as ModuleAction, l as ModuleIdType, m as moduleIdType, n as AuditCategory, o as ModuleContext, p as isModuleIdType, r as MODULE_ID_TYPES, s as ModuleContractFunction, t as AUDIT_CATEGORIES, u as ModuleNames } from "../context-DsV2SueA.js";
+import { B as ResolvedConfig, Q as EntitlementPlansSource } from "../index-Ba1SI-uO.js";
 //#region src/sql/shared.d.ts
 /** A `pg_jsonschema` check on a jsonb column, for the `jsonb-schemas` module and key-value tables. */
 interface JsonSchemaCheck {
@@ -38,7 +38,76 @@ export declare function auditRegistrations(files: readonly {
   readonly text: string;
 }[]): AuditedTable[];
 //#endregion
-//#region src/sql/registry.d.ts
+//#region src/sql/modules/entitlements-checks.d.ts
+/** `entitlements.claim`: what `feature_claims` puts in the token. */
+type FeatureClaimOption = false | {
+  /** At most this many tenants, the lowest ids first. */
+  readonly maxTenants?: number;
+  /** Short codes written instead of the feature keys: `{ exports: "x" }`. */
+  readonly keys?: Readonly<Record<string, string>>;
+};
+//#endregion
+//#region src/sql/modules/entitlements-source.d.ts
+/** The table holding each tenant's Stripe customer id. */
+interface EntitlementsSource {
+  /** `table` or `schema.table`; unset uses the `organizations` module's. */
+  readonly table?: string;
+  /** Column with the Stripe customer id (`cus_...`). */
+  readonly column?: string;
+  /** Column with the tenant id. */
+  readonly key: string;
+  /** Where entitlements come from; the customer lookups are for `stripe-sync` only. */
+  readonly source?: "stripe-sync" | "custom" | EntitlementPlansSource;
+  readonly claim?: FeatureClaimOption;
+}
+//#endregion
+//#region src/sql/modules/grants.d.ts
+/** Privileges one role gets on a table or view. */
+interface TableGrant {
+  /** `table` or `schema.table`. */
+  readonly table: string;
+  readonly role: "anon" | "authenticated" | "service_role";
+  readonly privileges: readonly string[];
+}
+/** The roles that may execute a function. */
+interface FunctionGrant {
+  /** `name(argument types)` or `schema.name(argument types)`. */
+  readonly function: string;
+  readonly roles: readonly ("anon" | "authenticated" | "service_role")[];
+}
+//#endregion
+//#region src/sql/modules/vector-search.d.ts
+/** 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 column's type: pgvector's `vector` (default) or `halfvec`. */
+  readonly type?: "vector" | "halfvec";
+  /** The primary key column the scores function returns. Defaults to `id`. */
+  readonly key?: string;
+  /** Full-text ranking fused with the vector ranking (reciprocal rank fusion). */
+  readonly hybrid?: {
+    readonly tsvector: string;
+    /** The text search configuration of the query. 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 `filter` narrows before ranking, such as `organization_id`. */
+  readonly prefilter?: readonly string[];
+  /** A SQL condition over the row `t` every candidate must meet. */
+  readonly predicate?: string;
+  /** How `boost` combines with the score. Defaults to `multiply`. */
+  readonly boostMode?: "multiply" | "add";
+  /** A SQL `order by` list over the row `t` that breaks score ties. */
+  readonly order?: string;
+}
+//#endregion
+//#region src/sql/module-types.d.ts
 /** The step from one module version to the next, for `sql upgrade`. */
 interface ModuleUpgrade {
   /** The installed version this step upgrades from. */
@@ -112,6 +181,12 @@ interface SqlModule {
   readonly contract?: (ctx: ModuleContext) => readonly ModuleContractFunction[];
   /** Renders the module for a layout; takes precedence over `render`. */
   readonly build?: (ctx: ModuleContext, layout: ModuleLayout) => string;
+  /**
+   * SQL appended after the module's body that depends on the whole layout, for
+   * example the grants for the tables in `expose`. Unlike `build`, it stays out
+   * of what `api` wrappers and extension scans read.
+   */
+  readonly extras?: (ctx: ModuleContext, layout: ModuleLayout) => string;
   readonly upgrades?: readonly ModuleUpgrade[];
   readonly deprecated?: readonly ModuleDeprecation[];
   /**
@@ -138,17 +213,6 @@ interface ModuleTestFile {
   readonly sql: string;
 }
 export declare const moduleVersion: (module: SqlModule) => number;
-/** `entitlements.claim`: what `feature_claims` puts in the token. */
-type FeatureClaimOption = false | {
-  /** At most this many tenants, the lowest ids first. */
-  readonly maxTenants?: number;
-  /** Short codes written instead of the feature keys: `{ exports: "x" }`. */
-  readonly keys?: Readonly<Record<string, 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?: ModuleLayout): SqlModule[];
 interface ModuleFile {
   readonly module: string;
   /** `schema` and `test` files are diffed; `data` files go in a migration too. */
@@ -247,106 +311,10 @@ interface ModuleAccessProvider {
     readonly distinctApprover?: boolean;
   };
 }
-/** 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 column's type: pgvector's `vector` (default) or `halfvec`. */
-  readonly type?: "vector" | "halfvec";
-  /** The primary key column the scores function returns. Defaults to `id`. */
-  readonly key?: string;
-  /** Full-text ranking fused with the vector ranking (reciprocal rank fusion). */
-  readonly hybrid?: {
-    readonly tsvector: string;
-    /** The text search configuration of the query. 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 `filter` narrows before ranking, such as `organization_id`. */
-  readonly prefilter?: readonly string[];
-  /** A SQL condition over the row `t` every candidate must meet. */
-  readonly predicate?: string;
-  /** How `boost` combines with the score. Defaults to `multiply`. */
-  readonly boostMode?: "multiply" | "add";
-  /** A SQL `order by` list over the row `t` that breaks score ties. */
-  readonly order?: string;
-}
-/** The table holding each tenant's Stripe customer id. */
-interface EntitlementsSource {
-  /** `table` or `schema.table`; unset uses the `organizations` module's. */
-  readonly table?: string;
-  /** Column with the Stripe customer id (`cus_...`). */
-  readonly column?: string;
-  /** Column with the tenant id. */
-  readonly key: string;
-  /** Where entitlements come from; the customer lookups are for `stripe-sync` only. */
-  readonly source?: "stripe-sync" | "custom" | EntitlementPlansSource;
-  readonly claim?: FeatureClaimOption;
-}
-/** Privileges one role gets on a table or view. */
-interface TableGrant {
-  /** `table` or `schema.table`. */
-  readonly table: string;
-  readonly role: "anon" | "authenticated" | "service_role";
-  readonly privileges: readonly string[];
-}
-/** The roles that may execute a function. */
-interface FunctionGrant {
-  /** `name(argument types)` or `schema.name(argument types)`. */
-  readonly function: string;
-  readonly roles: readonly ("anon" | "authenticated" | "service_role")[];
-}
-/** Whether an installed file matches, ignoring the version stamped in its header and line endings. */
-export declare function sameModuleFile(current: string | undefined, expected: string): boolean;
-/** The installed version of a module file, from its `@bs-module` line. */
-export declare function moduleFileVersion(contents: string): {
-  readonly module: string;
-  readonly version: number;
-} | undefined;
+//#endregion
+//#region src/sql/render.d.ts
 /** A module's SQL for `layout`, without header; `undefined` in custom mode. */
 export declare function moduleBody(name: string, layout?: ModuleLayout): string | undefined;
-/**
- * The schema or test file `renderModules` writes for each of `names` and the
- * modules they pull in, without rendering: modules in custom mode have none.
- */
-export declare function moduleFilePaths(names: readonly string[], layout?: ModuleLayout): ReadonlyMap<string, string>;
-/** A permission key a SQL module checks, from `modulePermissionKeys`. */
-interface ModulePermissionKey {
-  readonly module: string;
-  /** The action in `sql.modules.<module>.permissions` that overrides the key. */
-  readonly action: string;
-  readonly key: string;
-  /**
-   * `tenant` for keys checked in a tenant (`member_can`, `can`,
-   * `tenant_ids_with`), `platform` for `is_platform` and `platform_can`.
-   */
-  readonly scope: "tenant" | "platform";
-}
-/**
- * Every permission key the modules `names` install (with what they pull
- * in) check, after `sql.modules.<module>.permissions` overrides. Modules in custom
- * mode are skipped, and so is `invitations.invitePlatform` without platform
- * roles.
- */
-export declare function modulePermissionKeys(config: ModulesConfig, names: readonly string[]): ModulePermissionKey[];
-interface ModuleExtension {
-  readonly name: string;
-  readonly statement: string;
-}
-export declare const moduleSchemaExtensions: (files: readonly ModuleFile[]) => ModuleExtension[];
-/**
- * The event triggers each of these modules creates, as its default file
- * renders them, for doctor's check of a database.
- */
-export declare function moduleEventTriggers(names: readonly string[], modules?: Readonly<Record<string, SqlModule>>): {
-  readonly module: string;
-  readonly name: string;
-}[];
 /**
  * The files `sql add` writes for these modules. Modules in `custom` mode
  * write nothing: the app implements their contract. A schema module's rows,
@@ -360,6 +328,15 @@ interface ModuleTopic {
   readonly topic: string;
 }
 export declare function moduleTopics(names: readonly string[], layout?: ModuleLayout): ModuleTopic[];
+/** The contract functions of the modules in `custom` mode, for doctor. */
+export declare function customContracts(names: readonly string[], layout?: ModuleLayout): {
+  readonly module: string;
+  readonly schema: string;
+  readonly idType: ModuleIdType;
+  readonly functions: readonly ModuleContractFunction[];
+}[];
+//#endregion
+//#region src/sql/upgrade.d.ts
 /** An installed module, from its file's `@bs-module` line or `modules`. */
 interface InstalledModule {
   readonly module: string;
@@ -386,14 +363,63 @@ export declare function upgradePlan(installed: readonly InstalledModule[], layou
 export declare function moduleDeprecations(modules?: Readonly<Record<string, SqlModule>>): readonly (ModuleDeprecation & {
   readonly module: string;
 })[];
-/** The contract functions of the modules in `custom` mode, for doctor. */
-export declare function customContracts(names: readonly string[], layout?: ModuleLayout): {
+//#endregion
+//#region src/sql/paths.d.ts
+/**
+ * The schema or test file `renderModules` writes for each of `names` and the
+ * modules they pull in, without rendering: modules in custom mode have none.
+ */
+export declare function moduleFilePaths(names: readonly string[], layout?: ModuleLayout): ReadonlyMap<string, string>;
+//#endregion
+//#region src/sql/markers.d.ts
+/** The installed version of a module file, from its `@bs-module` line. */
+export declare function moduleFileVersion(contents: string): {
   readonly module: string;
-  readonly schema: string;
-  readonly idType: ModuleIdType;
-  readonly functions: readonly ModuleContractFunction[];
+  readonly version: number;
+} | undefined;
+/** Whether an installed file matches, ignoring the version stamped in its header and line endings. */
+export declare function sameModuleFile(current: string | undefined, expected: string): boolean;
+//#endregion
+//#region src/sql/introspect.d.ts
+/** A permission key a SQL module checks, from `modulePermissionKeys`. */
+interface ModulePermissionKey {
+  readonly module: string;
+  /** The action in `sql.modules.<module>.permissions` that overrides the key. */
+  readonly action: string;
+  readonly key: string;
+  /**
+   * `tenant` for keys checked in a tenant (`member_can`, `can`,
+   * `tenant_ids_with`), `platform` for `is_platform` and `platform_can`.
+   */
+  readonly scope: "tenant" | "platform";
+}
+/**
+ * Every permission key the modules `names` install (with what they pull
+ * in) check, after `sql.modules.<module>.permissions` overrides. Modules in custom
+ * mode are skipped, and so is `invitations.invitePlatform` without platform
+ * roles.
+ */
+export declare function modulePermissionKeys(config: ModulesConfig, names: readonly string[]): ModulePermissionKey[];
+interface ModuleExtension {
+  readonly name: string;
+  readonly statement: string;
+}
+export declare const moduleSchemaExtensions: (files: readonly ModuleFile[]) => ModuleExtension[];
+/**
+ * The event triggers each of these modules creates, as its default file
+ * renders them, for doctor's check of a database.
+ */
+export declare function moduleEventTriggers(names: readonly string[], modules?: Readonly<Record<string, SqlModule>>): {
+  readonly module: string;
+  readonly name: string;
 }[];
 //#endregion
+//#region src/sql/registry.d.ts
+/** 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?: ModuleLayout): SqlModule[];
+//#endregion
 //#region src/sql/adopted-columns.d.ts
 /**
  * Adopt-mode modules that default an optional column to its physical name