better-supabase 0.10.0 → 0.12.0

package/dist/testing/index.d.ts

@@ -1,37 +1,37 @@
-import { P as SchemaMeta, W as Update, a as AnyModels, i as AnyFunctions, x as Insert, z as TableKey } from "../types-BO8lVTun.js";
-import { r as Executor } from "../executor-BicyP8Nl.js";
-import { m as RequestContext, n as AnyPlugin } from "../plugin-D5OIaP93.js";
-import { t as BetterSupabaseEnv } from "../index-CxmVzT-3.js";
-import { n as AuthResolver } from "../resolve-7atr-wWr.js";
-import { a as CredentialSubject, i as CredentialRef, r as CredentialProvider } from "../provider-CQ1SrhLa.js";
-import { n as SqlClient } from "../executor-DzJQVTE2.js";
-import { a as BlockTransportMiddleware } from "../block-hooks-C_WaodoA.js";
+import { B as TableKey, F as SchemaMeta, G as Update, N as Row, S as Insert, a as AnyModels, i as AnyFunctions } from "../types-BrpW5ixT.js";
+import { r as Executor } from "../executor-BnMC0lj3.js";
+import { m as RequestContext, n as AnyPlugin } from "../plugin-D-95Q0w0.js";
+import { c as InlineJwks, t as BetterSupabaseEnv } from "../index-CxmVzT-3.js";
+import { n as AuthResolver } from "../resolve-Ceft-18-.js";
+import { a as CredentialSubject, i as CredentialRef, r as CredentialProvider } from "../provider-DXgx5oSA.js";
+import { n as SqlClient } from "../executor-D1hECPGG.js";
+import { a as BlockTransportMiddleware } from "../block-hooks-DcPJHztl.js";
 import { a as SessionActor, o as SessionDelegation } from "../actor-BAhb-d1S.js";
-import { M as QueueBackend } from "../types-P1S1cj6N.js";
-import { n as Embedder } from "../knowledge-BYtgA52P.js";
-import { a as AuthorizationProvider } from "../authorization-CdJRoZgV.js";
-import { o as StreamStore } from "../store-B5qYKsTh.js";
+import { M as QueueBackend } from "../types-BEEFkNFY.js";
+import { n as Embedder } from "../knowledge-B5zdpDD-.js";
+import { a as AuthorizationProvider } from "../authorization-ClWBcXJi.js";
+import { o as StreamStore } from "../store-B18bIvKc.js";
 import { t as ApiModel } from "../model-lUafmeBQ.js";
 import { l as VersionOf, t as AnyDocumentFormat } from "../format-CNwSjXUU.js";
 import { o as Authorizer } from "../authorizer-eiOjo-3l.js";
-import { i as EventSink, t as CloudEvent } from "../cloud-event-bwsBwVNG.js";
-import { Wt as DbStats, _ as Db, s as CacheAdapter, t as BetterSupabase } from "../define-DXTC706J.js";
+import { i as EventSink, t as CloudEvent } from "../cloud-event-DXkNoI6v.js";
+import { Wt as DbStats, _ as Db, s as CacheAdapter, t as BetterSupabase } from "../define-DYZnvAbs.js";
 import { n as Impersonator } from "../impersonation-D5chOkrO.js";
-import { i as AuthorizationHooks } from "../authorization-hooks-Do5djkpz.js";
-import { t as BetterPostgres } from "../pool-BBi4mot3.js";
-import { R as SupportSessionStore, i as ServerContext, s as ServerOptions } from "../server-types-fXwJoFjt.js";
-import { r as GuardOptions } from "../respond-Cdg5ibH5.js";
-import { n as Controller } from "../controller-CCb9tHw_.js";
-import { i as AiTaskRun, o as AiTaskRunner, t as AiTask } from "../ai-tasks-Di0gmJOX.js";
-import { r as WebhookInput } from "../signatures-BMdJ7neI.js";
+import { i as AuthorizationHooks } from "../authorization-hooks-WDQMKIsc.js";
+import { t as BetterPostgres } from "../pool-cM3rpOQr.js";
+import { B as SupportSessionStore, a as ServerContext, c as ServerOptions } from "../server-types-fLdep4gb.js";
+import { r as GuardOptions } from "../respond-BSL36dQp.js";
+import { n as Controller } from "../controller-BZhiIb-N.js";
+import { i as AiTaskRun, o as AiTaskRunner, t as AiTask } from "../ai-tasks-ZvPnNudQ.js";
+import { r as WebhookInput } from "../signatures-BXlDXV3D.js";
 import { n as Money } from "../money-DFpWzQvk.js";
-import { a as Generator, c as GeneratorModel, s as GeneratorInput, x as ResolvedConfig } from "../codegen-2m4SKVdi.js";
+import { a as Generator, c as GeneratorModel, s as GeneratorInput, x as ResolvedConfig } from "../codegen-C64C0NZG.js";
 import { t as NotificationChannel } from "../channel-D-LHCY11.js";
 import { a as DeliveryTransport } from "../delivery-BeHgwS3k.js";
-import { C as PaymentProvider, l as TaxProvider, r as TaxAddress, y as Payment } from "../tax-DDZUB_oc.js";
-import { B as WorkflowGraph, c as GraphCompiler, i as BuilderStarter, r as BuilderStartCall } from "../types-DZj8CZMH.js";
-import { O as IncomingDestination, f as WebhookSecretStore, o as WebhookSigner, v as WebhookTransport } from "../signers-BjSgNAXP.js";
-import { t as EveDocumentBackend } from "../eve-BcEr_hPo.js";
+import { C as PaymentProvider, l as TaxProvider, r as TaxAddress, y as Payment } from "../tax-DMWDUzKt.js";
+import { B as WorkflowGraph, c as GraphCompiler, i as BuilderStarter, r as BuilderStartCall } from "../types-Bels39_u.js";
+import { O as IncomingDestination, f as WebhookSecretStore, o as WebhookSigner, v as WebhookTransport } from "../signers-BwKV-9S6.js";
+import { t as EveDocumentBackend } from "../eve-B6ru2Bt4.js";
 import { SupabaseClient } from "@supabase/supabase-js";
 import { Message, StateAdapter } from "chat";
 import { webcrypto } from "node:crypto";
@@ -57,9 +57,7 @@ export declare function signTestJwt(secret: string, claims: TestJwtClaims): Prom
 export declare function localAuth(secret: string): AuthResolver;
 interface TestSigner {
   /** Public JWKS; pass as `jwks` to `resolveAuth` / `createServer({ auth: { jwks } })`. */
-  readonly jwks: {
-    readonly keys: readonly webcrypto.JsonWebKey[];
-  };
+  readonly jwks: InlineJwks;
   sign(claims: TestJwtClaims): Promise<string>;
 }
 /** A private ES256 JWK, as `better-supabase keys` writes to `supabase/signing_keys.json`. */
@@ -110,10 +108,21 @@ interface LocalStack {
   readonly postgres?: BetterPostgres;
   /** `fetch` for the user's supabase-js client, e.g. `liteStack().fetch`. */
   readonly fetch?: typeof fetch;
+  /**
+   * supabase-js warns when its trace propagation option is on and the
+   * runtime has no OpenTelemetry. Test users switch it off; set `true` to
+   * keep it.
+   */
+  readonly tracePropagation?: boolean;
 }
 interface TestUser<M extends AnyModels, F extends AnyFunctions, E> {
   readonly token: string;
   readonly claims: TestJwtClaims;
+  /**
+   * The server `RequestContext` for this user (actor and claims), for tests
+   * that call a command or handler directly with `{ supabase, db, context }`.
+   */
+  readonly context: RequestContext;
   /** supabase-js signed in as the user (storage, realtime, functions). */
   readonly supabase: SupabaseClient;
   /** Repositories over PostgREST as the user; RLS applies. */
@@ -321,6 +330,101 @@ interface InstantExpectation {
  */
 export declare function expectInstant(page: InstantPage, expectation: InstantExpectation): Promise<readonly MeasuredRender[]>;
 //#endregion
+//#region src/testing/seed.d.ts
+/** Named rows per table, in app casing: `{ customers: { acme: { ... } } }`. */
+type SeedFixtures<M extends AnyModels> = { readonly [K in keyof M]?: Readonly<Record<string, M[K]["Insert"]>>; };
+/** Rejects columns that are not in the table's Insert type. */
+type ExactSeed<M extends AnyModels, S> = { readonly [K in keyof S]: K extends keyof M ? { readonly [N in keyof S[K]]: { readonly [C in keyof S[K][N]]: C extends keyof M[K]["Insert"] ? S[K][N][C] : never; }; } : never; };
+declare const SEED: unique symbol;
+interface Seed<S> {
+  readonly [SEED]: true;
+  /** The fixtures as given, so tests can reference `seed.rows.customers.acme.id`. */
+  readonly rows: S;
+  /** One `insert ... on conflict do nothing` per table, parents before children. */
+  statements(): string[];
+  sql(): string;
+  /** Inserts the fixtures, e.g. in a test's `beforeAll`. Needs a service-role client. */
+  insert(sql: SqlClient): Promise<void>;
+}
+export declare function isSeed(value: unknown): value is Seed<unknown>;
+/**
+ * Typed fixtures shared by `supabase/seeds` and your tests. Rows use app
+ * casing and Insert types; `better-supabase seed` renders them to SQL.
+ *
+ * ```ts
+ * export const seed = defineSeed(betterSupabase, {
+ *   organizations: { acme: { id: ACME, name: 'Acme' } },
+ *   customers: { first: { organizationId: ACME, name: 'First customer' } },
+ * });
+ * ```
+ */
+export declare function defineSeed<M extends AnyModels, D, F extends AnyFunctions, E, const S extends SeedFixtures<M>>(betterSupabase: BetterSupabase<M, D, F, E>, fixtures: S & ExactSeed<M, S>): Seed<S>;
+//#endregion
+//#region src/testing/scope.d.ts
+/** What a `scopedSeed` builder receives for one test. */
+interface Scope {
+  /** The id of this test's fresh tenant. */
+  readonly tenant: string;
+  /** A new UUID, for rows that other fixtures reference. */
+  id(): string;
+}
+/** The row that stands for the tenant, inserted before any fixture. */
+type ScopedTenant<M extends AnyModels> = { readonly [K in TableKey<M>]: {
+  readonly table: K;
+  readonly row: (id: string) => Insert<M, K>;
+}; }[TableKey<M>];
+interface ScopedSeedOptions<M extends AnyModels> {
+  /** The table and row for the tenant; leave it out when the tenant is only an id. */
+  readonly tenant?: ScopedTenant<M>;
+  /** Defaults to `$SUPABASE_URL` and `$SUPABASE_SECRET_KEY`. */
+  readonly stack?: LocalStack;
+}
+/** The rows a `scopedSeed` inserted, as the database returned them. */
+type ScopedRows<M extends AnyModels, S> = { readonly [K in keyof S & keyof M]: { readonly [N in keyof S[K]]: Row<M, K>; }; };
+interface ScopedSeed<M extends AnyModels, S> {
+  readonly tenant: string;
+  readonly rows: ScopedRows<M, S>;
+  /** Deletes the rows in reverse order of creation, the tenant row last. */
+  cleanup(): Promise<void>;
+  [Symbol.asyncDispose](): Promise<void>;
+}
+/**
+ * Fresh rows for one test, so tests that run at the same time never share
+ * data. It creates a new tenant id, inserts the fixtures that `build` returns
+ * through the service role (RLS and plugins don't apply), and hands back the
+ * inserted rows. Call `cleanup()` in `afterEach` (or `await using`) to delete
+ * them. A user from `asUser` then reads them over PostgREST like any other.
+ *
+ * ```ts
+ * const scope = await scopedSeed(
+ *   betterSupabase,
+ *   ({ tenant, id }) => ({
+ *     customers: { first: { organizationId: tenant, name: `first-${id()}` } },
+ *   }),
+ *   { tenant: { table: 'organizations', row: (id) => ({ id, name: id, slug: id }) } },
+ * );
+ * const alice = await asUser(betterSupabase, { sub: aliceId, tenant_id: scope.tenant });
+ * expect(await alice.db.customers.count().orThrow()).toBe(1);
+ * await scope.cleanup();
+ * ```
+ */
+export declare function scopedSeed<M extends AnyModels, D, F extends AnyFunctions, E, const S extends SeedFixtures<M>>(betterSupabase: BetterSupabase<M, D, F, E>, build: (scope: Scope) => S & ExactSeed<M, S>, options?: ScopedSeedOptions<M>): Promise<ScopedSeed<M, S>>;
+/**
+ * Runs `fn` as the user over direct Postgres inside one transaction and
+ * always rolls it back, so the test leaves no rows behind. `fn` gets the same
+ * repositories as `user.sql`. Only the `sql` path rolls back: `user.db` talks
+ * to PostgREST over HTTP and commits on its own.
+ *
+ * ```ts
+ * const alice = await asUser(betterSupabase, claims, { postgres });
+ * await withRollback(alice, async (db) => {
+ *   await db.customers.create({ organizationId, name: 'Temp' }).orThrow();
+ *   expect(await db.customers.count().orThrow()).toBe(1);
+ * });
+ * ```
+ */
+export declare function withRollback<M extends AnyModels, F extends AnyFunctions, E, T>(user: TestUser<M, F, E>, fn: (db: Db<M, F, E, unknown>) => Promise<T>): Promise<T>;
+//#endregion
 //#region src/testing/conformance.d.ts
 interface ConformanceCheck {
   readonly name: string;
@@ -449,36 +553,6 @@ type SupabaseInvalidClaimFixtureName = "legacySupportSession" | "supportReadOnly
  */
 export declare const supabaseInvalidClaimFixtures: Readonly<Record<SupabaseInvalidClaimFixtureName, SupabaseInvalidClaimFixture>>;
 //#endregion
-//#region src/testing/seed.d.ts
-/** Named rows per table, in app casing: `{ customers: { acme: { ... } } }`. */
-type SeedFixtures<M extends AnyModels> = { readonly [K in keyof M]?: Readonly<Record<string, M[K]["Insert"]>>; };
-/** Rejects columns that are not in the table's Insert type. */
-type ExactSeed<M extends AnyModels, S> = { readonly [K in keyof S]: K extends keyof M ? { readonly [N in keyof S[K]]: { readonly [C in keyof S[K][N]]: C extends keyof M[K]["Insert"] ? S[K][N][C] : never; }; } : never; };
-declare const SEED: unique symbol;
-interface Seed<S> {
-  readonly [SEED]: true;
-  /** The fixtures as given, so tests can reference `seed.rows.customers.acme.id`. */
-  readonly rows: S;
-  /** One `insert ... on conflict do nothing` per table, parents before children. */
-  statements(): string[];
-  sql(): string;
-  /** Inserts the fixtures, e.g. in a test's `beforeAll`. Needs a service-role client. */
-  insert(sql: SqlClient): Promise<void>;
-}
-export declare function isSeed(value: unknown): value is Seed<unknown>;
-/**
- * Typed fixtures shared by `supabase/seeds` and your tests. Rows use app
- * casing and Insert types; `better-supabase seed` renders them to SQL.
- *
- * ```ts
- * export const seed = defineSeed(betterSupabase, {
- *   organizations: { acme: { id: ACME, name: 'Acme' } },
- *   customers: { first: { organizationId: ACME, name: 'First customer' } },
- * });
- * ```
- */
-export declare function defineSeed<M extends AnyModels, D, F extends AnyFunctions, E, const S extends SeedFixtures<M>>(betterSupabase: BetterSupabase<M, D, F, E>, fixtures: S & ExactSeed<M, S>): Seed<S>;
-//#endregion
 //#region src/testing/kits/auth-resolver.d.ts
 interface TestAuthResolverOptions {
   /** Requests with credentials this resolver owns but that must not verify. */
@@ -1053,4 +1127,4 @@ interface ActCases {
  */
 export declare const actCases: ActCases;
 //#endregion
-export type { ActCase, ActCases, AdapterRun, BudgetPage, BudgetRequest, BudgetResponse, ConformanceCheck, ConformanceReport, ControllerBindingHarness, DbBudgetExpectation, ExactSeed, InstantBrowserContext, InstantExpectation, InstantLocator, InstantPage, IsolationTable, IsolationTables, IsolationTenant, LiteStack, LiteStackOptions, LocalStack, MeasuredRender, MountedBinding, ProbeActions, ProbeController, ProbeSnapshot, ReceivedDelivery, ResponseBudgetExpectation, ResponseDbStats, Seed, SeedFixtures, SigningJwk, StaticAuthorizerOptions, SupabaseClaimFixture, SupabaseClaimFixtureName, SupabaseInvalidClaimFixture, SupabaseInvalidClaimFixtureName, TenantIsolationOptions, TestAdapterOptions, TestAiTaskRunnerOptions, TestAuthResolverOptions, TestAuthorizerOptions, TestBuilderStarterOptions, TestChatStateOptions, TestCredentialProviderOptions, TestDeliveryTransportOptions, TestDocumentFormatOptions, TestEmbedderOptions, TestEveDocumentBackendOptions, TestEventSinkOptions, TestExecutorOptions, TestGeneratorOptions, TestGraphCompilerOptions, TestIncomingDestinationOptions, TestJwtClaims, TestNotificationChannelOptions, TestPaymentProviderOptions, TestPluginOptions, TestQueueBackendOptions, TestSigner, TestStreamStoreOptions, TestSupportSessionStoreOptions, TestTaxProviderOptions, TestUser, TestWebhookSecretStoreOptions, TestWebhookSignerOptions, TestWebhookTransportOptions };
+export type { ActCase, ActCases, AdapterRun, BudgetPage, BudgetRequest, BudgetResponse, ConformanceCheck, ConformanceReport, ControllerBindingHarness, DbBudgetExpectation, ExactSeed, InstantBrowserContext, InstantExpectation, InstantLocator, InstantPage, IsolationTable, IsolationTables, IsolationTenant, LiteStack, LiteStackOptions, LocalStack, MeasuredRender, MountedBinding, ProbeActions, ProbeController, ProbeSnapshot, ReceivedDelivery, ResponseBudgetExpectation, ResponseDbStats, Scope, ScopedRows, ScopedSeed, ScopedSeedOptions, ScopedTenant, Seed, SeedFixtures, SigningJwk, StaticAuthorizerOptions, SupabaseClaimFixture, SupabaseClaimFixtureName, SupabaseInvalidClaimFixture, SupabaseInvalidClaimFixtureName, TenantIsolationOptions, TestAdapterOptions, TestAiTaskRunnerOptions, TestAuthResolverOptions, TestAuthorizerOptions, TestBuilderStarterOptions, TestChatStateOptions, TestCredentialProviderOptions, TestDeliveryTransportOptions, TestDocumentFormatOptions, TestEmbedderOptions, TestEveDocumentBackendOptions, TestEventSinkOptions, TestExecutorOptions, TestGeneratorOptions, TestGraphCompilerOptions, TestIncomingDestinationOptions, TestJwtClaims, TestNotificationChannelOptions, TestPaymentProviderOptions, TestPluginOptions, TestQueueBackendOptions, TestSigner, TestStreamStoreOptions, TestSupportSessionStoreOptions, TestTaxProviderOptions, TestUser, TestWebhookSecretStoreOptions, TestWebhookSignerOptions, TestWebhookTransportOptions };