better-supabase 0.12.0 → 0.13.0

package/dist/plugin-D-95Q0w0.d.ts

@@ -1,190 +0,0 @@
-/// <reference lib="esnext.temporal" />
-import { T as ErrorMapper } from "./result-BREt7qOh.js";
-import { F as SchemaMeta, V as TableMeta, a as AnyModels, z as TableFlags } from "./types-BrpW5ixT.js";
-import { _ as MutationOp, g as MutationKind, h as MutationIntent, r as Executor, v as Operation } from "./executor-BnMC0lj3.js";
-//#region src/core/plugin.d.ts
-/** Who is making the request. */
-interface Actor {
-  readonly id: string;
-  readonly kind: "user" | "service" | "anon";
-  readonly role?: string;
-  readonly email?: string;
-  /** The admin acting as this user (the `act` claim's `sub`). */
-  readonly impersonator?: string;
-}
-/**
- * Per-connection context. Server adapters fill it from the verified JWT;
- * plugins read it (`tenant()` reads `tenant`, `actor()` reads `actor`).
- */
-interface RequestContext {
-  readonly actor?: Actor;
-  readonly tenant?: string;
-  readonly claims?: Readonly<Record<string, unknown>>;
-  readonly [key: string]: unknown;
-}
-/** Plugin-specific per-call options (`withDeleted`, `hard`, ...). */
-type CallOptions = Readonly<Record<string, unknown>>;
-interface HookArgs {
-  readonly table: TableMeta;
-  readonly schema: SchemaMeta;
-  readonly context: RequestContext;
-  readonly options: CallOptions;
-  readonly now: () => Temporal.Instant;
-  /** The caller's `signal`, when it passed one. Hooks that do I/O should honor it. */
-  readonly signal?: AbortSignal;
-}
-interface MutationEvent {
-  readonly table: TableMeta;
-  /** The statement that ran. */
-  readonly kind: MutationKind;
-  /** What the caller asked for; differs from `kind` when a plugin rewrote the mutation. */
-  readonly intent?: MutationIntent;
-  /** App-cased rows returned by the mutation. A copy: changing it never changes the result. */
-  readonly rows: readonly Readonly<Record<string, unknown>>[];
-  /**
-   * App-cased primary keys of the changed rows, when they are known: from
-   * the returned rows, or from a `where` on the primary key when nothing is
-   * returned (soft deletes, `returning: false`).
-   */
-  readonly keys?: readonly Readonly<Record<string, unknown>>[];
-  /** The tenant of the write: `context.tenant`, which `tenant()` fills from the claims. */
-  readonly tenant?: string;
-  readonly context: RequestContext;
-}
-/** Runtime handle passed to `Plugin.repository`. */
-interface RepositoryApi {
-  readonly table: TableMeta;
-  readonly base: Readonly<Record<string, (...args: never[]) => unknown>>;
-}
-/**
- * Type-level repository extension, applied per table. Implement it as an
- * interface that reads `this['M']` and `this['T']`:
- *
- * ```ts
- * interface RestoreExtension extends RepositoryExtension {
- *   readonly methods: HasFlag<this['M'], this['T'], 'softDelete'> extends true
- *     ? { restore(id: string): AsyncResult<unknown> }
- *     : unknown;
- * }
- * ```
- */
-interface RepositoryExtension {
-  readonly M: AnyModels;
-  readonly T: string;
-  readonly methods: unknown;
-  readonly findArgs: unknown;
-  readonly deleteArgs: unknown;
-}
-/**
- * Applies the extensions in `E` to table `T`. `E` is a tuple of extensions (as
- * built by `use()`) or a single extension. Each is applied on its own because
- * indexing an intersection of `this`-typed interfaces overflows TS < 7.
- */
-/** Default extension of plugins that add no repository types. */
-interface NoExtension extends RepositoryExtension {
-  readonly "~none": true;
-}
-type ApplyExtension<E, M extends AnyModels, T extends keyof M, K extends "methods" | "findArgs" | "deleteArgs"> = E extends readonly [infer Head, ...infer Rest] ? ApplyOne<Head, M, T, K> & ApplyExtension<Rest, M, T, K> : ApplyOne<E, M, T, K>;
-type ApplyOne<E, M extends AnyModels, T extends keyof M, K extends "methods" | "findArgs" | "deleteArgs"> = E extends RepositoryExtension ? (E & {
-  readonly M: M;
-  readonly T: T;
-})[K] : unknown;
-/** True when table `T` has the flag set by codegen. */
-type HasFlag<M, T, F extends string> = M extends AnyModels ? T extends keyof M ? M[T]["Flags"] extends { readonly [K in F]: unknown; } ? true : false : false : false;
-/** A parameter a plugin adds to the operations of a table in the API spec. */
-interface DescribeParameter {
-  readonly name: string;
-  readonly in: "query" | "header" | "cookie";
-  readonly required?: boolean;
-  readonly description?: string;
-  /** JSON Schema 2020-12. */
-  readonly schema: Readonly<Record<string, unknown>>;
-}
-/**
- * What `Plugin.describe` can change in the API model `defineApi` builds.
- * Every method ignores tables and columns the API does not serve.
- */
-interface PluginDescribeApi {
-  readonly schema: SchemaMeta;
-  /** Prefix of generated `x-` fields, e.g. `x-better-supabase-`. */
-  readonly extensionPrefix: string;
-  /** The served tables, with the names of their operations and actions. */
-  readonly resources: readonly {
-    readonly table: TableMeta;
-    readonly operations: readonly string[];
-  }[];
-  /** Adds a parameter to the table's operations, or to the named ones. */
-  addParameter(table: string, parameter: DescribeParameter, operations?: readonly string[]): void;
-  /**
-   * Marks a column `readOnly` in the table's schemas and drops it from the
-   * required fields of request bodies. `description` is used when the
-   * column has none.
-   */
-  markReadOnly(table: string, column: string, description?: string): void;
-  /** Deep-merges JSON Schema fields into the column's schemas. */
-  describeColumn(table: string, column: string, patch: Readonly<Record<string, unknown>>): void;
-}
-declare const PLUGIN_API_VERSION = 1;
-/**
- * Plugin API v1. Every hook is optional. Hooks run in `use()` order.
- */
-interface Plugin<Name extends string = string, Ext extends RepositoryExtension = NoExtension> {
-  readonly apiVersion: 1;
-  readonly name: Name;
-  /**
-   * Hook order: `first`, then `pre`, then unmarked plugins, then `post`;
-   * plugins at the same level keep `use()` order. `first` is for plugins
-   * that check the query as the caller wrote it, before a `pre` plugin
-   * rewrites it (`rules()`). Validation is `post` so it sees columns other
-   * plugins fill.
-   */
-  readonly enforce?: "first" | "pre" | "post";
-  /**
-   * The table flags whose tables this plugin's `transformQuery` filters
-   * (`tenant()` declares `['tenant']`). Read sets warn when they read such a
-   * table, because their generated SQL function runs without the plugin.
-   * `[]` means the plugin only inspects queries. A plugin with
-   * `transformQuery` that leaves this out is assumed to filter every table.
-   */
-  readonly scopes?: readonly (keyof TableFlags)[];
-  /**
-   * `context`: derive values from the connection's context once per
-   * `connect()` and `$with()`, so `db.$context` carries them (`tenant()`
-   * adds the tenant it resolved). Runs in hook order on the context the
-   * caller passed. A throw is logged and leaves the context unchanged.
-   */
-  readonly context?: (context: RequestContext, args: {
-    readonly schema: SchemaMeta;
-  }) => RequestContext;
-  /** `ir`: rewrite an operation before it runs (filters, defaults). */
-  readonly transformQuery?: (op: Operation, args: HookArgs) => Operation;
-  /** `mutation`: rewrite a mutation or reject it by throwing a `DbException`. */
-  readonly beforeMutation?: (op: MutationOp, args: HookArgs) => MutationOp | Promise<MutationOp>;
-  /** `mutation`: observe a finished mutation. Cannot change the result. */
-  readonly afterMutation?: (event: MutationEvent) => void | Promise<void>;
-  /** `execute`: wrap the executor for tracing, caching or retries. */
-  readonly wrapExecutor?: (executor: Executor) => Executor;
-  /** `errors`: map custom SQLSTATE or hint codes to `DbError`s. */
-  readonly mapError?: ErrorMapper;
-  /** `repository`: add methods to the repositories of matching tables. */
-  readonly repository?: (api: RepositoryApi) => Readonly<Record<string, (...args: never[]) => unknown>> | undefined;
-  /**
-   * `spec`: describe what the plugin does to the served tables in the API
-   * model (`defineApi`, `createOpenApi`): parameters it reads, columns it
-   * manages. A throw is reported as `plugin-describe-failed`.
-   */
-  readonly describe?: (api: PluginDescribeApi) => void;
-  /** Phantom carrying the repository extension type. */
-  readonly "~ext"?: Ext;
-}
-type AnyPlugin = Plugin<string, any>;
-/** The plugin's repository extension; `unknown` for plugins that add none. */
-type ExtensionOf<P> = P extends Plugin<string, infer E> ? E extends NoExtension ? unknown : E : never;
-/** `E` with extension `X` appended, as a tuple. */
-type WithExtension<E, X> = unknown extends X ? E : E extends readonly unknown[] ? readonly [...E, X] : unknown extends E ? readonly [X] : readonly [E, X];
-/** Identity helper that fixes `apiVersion` and infers the plugin types. */
-declare function definePlugin<const Name extends string, Ext extends RepositoryExtension = NoExtension>(plugin: Omit<Plugin<Name, Ext>, "apiVersion"> & {
-  readonly apiVersion?: 1;
-}): Plugin<Name, Ext>;
-//#endregion
-export { ExtensionOf as a, MutationEvent as c, Plugin as d, RepositoryApi as f, definePlugin as g, WithExtension as h, CallOptions as i, NoExtension as l, RequestContext as m, AnyPlugin as n, HasFlag as o, RepositoryExtension as p, ApplyExtension as r, HookArgs as s, Actor as t, PLUGIN_API_VERSION as u };

package/dist/plugin-tfXW1-qO.js

@@ -1,45 +0,0 @@
-//#region src/core/plugin.ts
-const PLUGIN_API_VERSION = 1;
-const RANK = {
-	first: 0,
-	pre: 1,
-	normal: 2,
-	post: 3
-};
-function rankOf(plugin) {
-	return RANK[plugin.enforce ?? "normal"];
-}
-/**
-* Plugins in hook order: `first`, `pre`, unmarked, then `post`, each level
-* in `use()` order.
-*/
-function orderPlugins(plugins) {
-	return plugins.map((plugin, index) => ({
-		plugin,
-		index
-	})).sort((a, b) => rankOf(a.plugin) - rankOf(b.plugin) || a.index - b.index).map(({ plugin }) => plugin);
-}
-/** Identity helper that fixes `apiVersion` and infers the plugin types. */
-function definePlugin(plugin) {
-	return {
-		...plugin,
-		apiVersion: 1
-	};
-}
-/**
-* A symbol key, so JSON, claims and spread request data can't set it, while
-* `$with` copies it to the derived context.
-*/
-const ALL_TENANTS = Symbol("better-supabase.allTenants");
-/** `context`, marked so `tenant()` and tenant buckets skip their tenant scope. */
-function allTenantsContext(context) {
-	return {
-		...context,
-		[ALL_TENANTS]: true
-	};
-}
-function spansAllTenants(context) {
-	return Object.hasOwn(context, ALL_TENANTS);
-}
-//#endregion
-export { spansAllTenants as a, orderPlugins as i, allTenantsContext as n, definePlugin as r, PLUGIN_API_VERSION as t };

package/dist/pool-cM3rpOQr.d.ts

@@ -1,117 +0,0 @@
-import { r as Executor } from "./executor-BnMC0lj3.js";
-import { o as EventHub } from "./events-P3raDX2E.js";
-import { n as Logger } from "./logger-DWVYUmwi.js";
-import { n as SqlClient } from "./executor-D1hECPGG.js";
-//#region src/postgres/pool.d.ts
-/** The part of a `pg` pool client `createPostgres` uses. */
-interface PgPoolClient {
-  query(text: string, values?: unknown[]): Promise<{
-    rows: unknown[];
-  }>;
-  release(): void;
-}
-/** The part of a `pg.Pool` `createPostgres` uses. */
-interface PgPool {
-  connect(): Promise<PgPoolClient>;
-  end(): Promise<void>;
-  /** `pg.Pool` reports errors of idle connections here. */
-  on?(event: "error", listener: (error: Error) => void): unknown;
-}
-/** Statement timeouts in milliseconds by the role a transaction runs as. */
-interface PostgresTimeouts {
-  /** The connection-string role (`admin` and `transaction` without claims). Unset by default. */
-  readonly admin?: number;
-  /** Defaults to 8000, Supabase's setting for the role. */
-  readonly authenticated?: number;
-  /** Defaults to 3000, Supabase's setting for the role. */
-  readonly anon?: number;
-}
-interface PostgresOptions {
-  /**
-   * Defaults to `$SUPABASE_DB_URL`, `$DATABASE_URL`, `$POSTGRES_URL`, then
-   * `$POSTGRES_URL_NON_POOLING`, the first one set.
-   */
-  readonly connectionString?: string;
-  /** An existing pool to run on instead of opening one. `end()` ends it. */
-  readonly pool?: PgPool;
-  readonly max?: number;
-  /**
-   * Statement timeout in milliseconds, applied per transaction: one value
-   * for every role, or one per role. `set role` doesn't apply the role's own
-   * `statement_timeout`, so `authenticated` and `anon` get Supabase's 8 s
-   * and 3 s unless you set them.
-   */
-  readonly statementTimeout?: number | PostgresTimeouts;
-  /**
-   * Ends a session that stays idle inside a transaction this long, in
-   * milliseconds, so `transaction(fn)` can't hold a connection while `fn`
-   * waits on something else. Defaults to 15000; `0` turns it off. Statements
-   * outside a transaction don't set it.
-   */
-  readonly idleInTransactionTimeout?: number;
-  /** How long `connect` waits for a connection, in milliseconds. Defaults to 10000. */
-  readonly connectionTimeout?: number;
-  /** How long an unused connection stays open, in milliseconds. Defaults to 10000. */
-  readonly idleTimeout?: number;
-  /**
-   * `betterSupabase.events`: an error on an idle pooled connection arrives as
-   * an `error` event instead of crashing the process.
-   */
-  readonly events?: EventHub;
-  /** Where idle-connection errors go without `error` handlers. Defaults to the console. */
-  readonly logger?: Logger;
-}
-/** JWT claims to run as. `role` must be `authenticated` or `anon`. */
-interface SqlClaims {
-  readonly sub?: string;
-  readonly role?: string;
-  readonly [claim: string]: unknown;
-}
-/** What every transaction of a user session sets besides the claims and role. */
-interface SessionOptions {
-  /**
-   * Transaction-local settings, e.g. `{ 'better_supabase.tenant': id }`.
-   * Names need a dot (custom settings); `role` and `request.jwt.claims` are
-   * set from the claims.
-   */
-  readonly settings?: Readonly<Record<string, string>>;
-  /** Runs every transaction with `begin read only`: writes fail with 25006. */
-  readonly readOnly?: boolean;
-  /**
-   * Statement timeout in milliseconds for this session's transactions,
-   * instead of the role's `statementTimeout` from `createPostgres`.
-   */
-  readonly statementTimeout?: number;
-}
-interface BetterPostgres {
-  /** Connects as the connection-string role. On Supabase that bypasses RLS. */
-  readonly admin: SqlClient;
-  /** Runs every query as the given user, with RLS, like PostgREST does. */
-  asUser(claims: SqlClaims, options?: SessionOptions): SqlClient;
-  /** Runs every query as `anon`. */
-  readonly anon: SqlClient;
-  /**
-   * Repositories' executor as the given user (`postgresExecutor(asUser(claims))`).
-   * `createServer` calls it for `ctx.sql`, so only apps that pass `postgres`
-   * bundle the SQL compiler.
-   */
-  executorFor(claims: SqlClaims, options?: SessionOptions): Executor;
-  /**
-   * Runs `fn` in one transaction. Pass claims to run it as a user; the
-   * session options apply with or without them.
-   */
-  transaction<T>(fn: (client: SqlClient) => Promise<T>, options?: {
-    readonly claims?: SqlClaims;
-  } & SessionOptions): Promise<T>;
-  end(): Promise<void>;
-  [Symbol.asyncDispose](): Promise<void>;
-}
-/**
- * A pooled Postgres connection for jobs, scripts and tests. Each query (or
- * transaction) runs in its own transaction; claims and role are
- * transaction-local, so nothing leaks back into the pool. An `admin` query
- * with no timeout to set runs on its own, without `begin` and `commit`.
- */
-declare function createPostgres(options?: PostgresOptions): BetterPostgres;
-//#endregion
-export { PostgresTimeouts as a, createPostgres as c, PostgresOptions as i, PgPool as n, SessionOptions as o, PgPoolClient as r, SqlClaims as s, BetterPostgres as t };

package/dist/pool-errors-CGqvTQOC.js

@@ -1,27 +0,0 @@
-import { c as mapDbError } from "./errors-BV1SKTVs.js";
-import { s as toDbError } from "./result-DIeYscA3.js";
-import { t as consoleLogger } from "./logger-glM28NVN.js";
-import { n as errorEvent } from "./events-xbpHkcK9.js";
-import { t as fromPgError } from "./pg-error-BV_X8Isq.js";
-//#region src/postgres/pool-errors.ts
-/**
-* Listens for errors on idle pooled connections, such as a server restart or
-* an ended session. `pg.Pool` emits them as an `error` event, and Node exits
-* on an `error` event nobody listens to. The listener reports the error and
-* never throws.
-*/
-function watchPoolErrors(pool, options) {
-	pool.on?.("error", (cause) => {
-		try {
-			const raw = fromPgError(cause);
-			const error = raw ? mapDbError(raw, []) : toDbError(cause);
-			if (options.events?.has("error")) {
-				options.events.emit("error", errorEvent(error));
-				return;
-			}
-			(options.logger ?? options.events?.logger ?? consoleLogger).error("an idle Postgres connection failed", { error });
-		} catch {}
-	});
-}
-//#endregion
-export { watchPoolErrors as t };

package/dist/ports-BCDIbC_U.d.ts

@@ -1,86 +0,0 @@
-import { t as AsyncResult } from "./result-BREt7qOh.js";
-import { n as TopicPort } from "./watch-topic-C79ZW5-R.js";
-import { SupabaseClient } from "@supabase/supabase-js";
-//#region src/client/ports.d.ts
-/**
- * A string store: `localStorage` on the web (`webStorage()`), AsyncStorage,
- * MMKV or SecureStore on React Native (`nativeStorage()`).
- */
-interface StoragePort {
-  readonly get: (key: string) => Promise<string | null>;
-  readonly set: (key: string, value: string) => Promise<void>;
-  readonly remove: (key: string) => Promise<void>;
-}
-/** A key combination. `mod` is Cmd on macOS and Ctrl elsewhere. */
-interface Shortcut {
-  readonly key: string;
-  readonly mod?: boolean;
-  readonly shift?: boolean;
-  readonly alt?: boolean;
-}
-/** Runs `run` on each press of `shortcut` until the returned function is called. */
-type KeyboardPort = (shortcut: Shortcut, run: () => void) => () => void;
-/** A file the user picked, readable on every platform. */
-interface PickedFile {
-  readonly name: string;
-  /** The MIME type, when the platform reports one. */
-  readonly type: string | undefined;
-  readonly size: number | undefined;
-  /** The local URI on React Native; `undefined` on the web. */
-  readonly uri: string | undefined;
-  /** The bytes: a `Blob` on the web, an `ArrayBuffer` on React Native. */
-  readonly read: () => Promise<Blob | ArrayBuffer>;
-}
-interface PickFilesOptions {
-  /** MIME types or extensions, such as `image/*` or `.pdf`. */
-  readonly accept?: readonly string[];
-  readonly multiple?: boolean;
-}
-/** Opens the platform's file picker; resolves with no files when the user cancels. */
-type FilePickerPort = (options?: PickFilesOptions) => Promise<readonly PickedFile[]>;
-interface UploadDestination {
-  readonly bucket: string;
-  readonly path: string;
-  readonly upsert?: boolean;
-}
-/** Uploads a picked file and resolves with its stored path. */
-type UploadPort = (file: PickedFile, to: UploadDestination) => AsyncResult<{
-  readonly path: string;
-}>;
-/** The device's push token for the platform's push service. */
-interface PushTokenPort {
-  /** The push provider the token belongs to, such as `expo` or `webpush`. */
-  readonly provider: string;
-  /**
-   * The token, asking for permission first unless `request` is false.
-   * Resolves with `null` when the user denies it or the platform has none.
-   */
-  readonly token: (options?: {
-    readonly request?: boolean;
-  }) => Promise<string | null>;
-}
-/** The URL the app opened with, and the ones it opens later. */
-interface DeepLinkPort {
-  readonly initial: () => Promise<string | null>;
-  readonly subscribe: (listener: (url: string) => void) => () => void;
-}
-/**
- * The platform services block controllers use. `createClient` from
- * `better-supabase/client` fills the web ports, and `nativePorts()` from
- * `better-supabase/client/native` the React Native ones.
- */
-interface ClientPorts {
-  readonly topic?: TopicPort;
-  readonly storage?: StoragePort;
-  readonly keyboard?: KeyboardPort;
-  readonly files?: FilePickerPort;
-  readonly upload?: UploadPort;
-  readonly push?: PushTokenPort;
-  readonly links?: DeepLinkPort;
-}
-/** A storage port that keeps values in memory, for tests and server renders. */
-declare function memoryStorage(initial?: Readonly<Record<string, string>>): StoragePort;
-/** The upload port over Supabase Storage, for web and native picked files alike. */
-declare function storageUpload(supabase: Pick<SupabaseClient, "storage">): UploadPort;
-//#endregion
-export { PickFilesOptions as a, Shortcut as c, UploadPort as d, memoryStorage as f, KeyboardPort as i, StoragePort as l, DeepLinkPort as n, PickedFile as o, storageUpload as p, FilePickerPort as r, PushTokenPort as s, ClientPorts as t, UploadDestination as u };