better-supabase 0.14.0 → 0.15.0

package/dist/permissions-BetA_Fo_.js

@@ -1,34 +0,0 @@
-//#region src/blocks/access/permissions.ts
-/**
-* Whether a granted key covers a wanted one: the same rule as the SQL
-* `permission_matches`, where `*` grants every key and `prefix.*` every key
-* under `prefix`.
-*/
-function permissionMatches(granted, wanted) {
-	return granted === "*" || granted === wanted || granted.endsWith(".*") && wanted.startsWith(granted.slice(0, -1));
-}
-/**
-* Whether `set` holds `key`. UX only: RLS and the SQL functions check the key
-* again.
-*
-* ```ts
-* if (can(permissionSet, permissions.customers.write)) showEditButton();
-* ```
-*/
-function can(set, key) {
-	return set?.keys.some((granted) => permissionMatches(granted, key)) ?? false;
-}
-/**
-* One `can<Name>` boolean per entry of `flags`, for a payload query that
-* returns data and what the caller may do with it.
-*
-* ```ts
-* permissionFlags(set, { edit: permissions.customers.write });
-* // { canEdit: true }
-* ```
-*/
-function permissionFlags(set, flags) {
-	return Object.fromEntries(Object.entries(flags).map(([name, key]) => [`can${name.charAt(0).toUpperCase()}${name.slice(1)}`, can(set, key)]));
-}
-//#endregion
-export { permissionFlags as n, permissionMatches as r, can as t };

package/dist/plugin-Ar5546xh.d.ts

@@ -1,202 +0,0 @@
-/// <reference lib="esnext.temporal" />
-import { T as ErrorMapper } from "./result-C6jDfedy.js";
-import { N as AnyModels, _ as MutationOp, g as MutationKind, h as MutationIntent, ht as TableMeta, lt as SchemaMeta, pt as TableFlags, r as Executor, v as Operation } from "./executor-CPyrQdjh.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-D9bYbYli.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
-	})).toSorted((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/plugins/actor/index.d.ts

@@ -1,19 +0,0 @@
-import { d as Plugin, m as RequestContext } from "../../plugin-Ar5546xh.js";
-//#region src/plugins/actor/index.d.ts
-export interface ActorOptions {
-  /**
-   * Custom actor id resolution. Defaults to `context.actor.id` for users and
-   * services.
-   */
-  readonly resolve?: (context: RequestContext) => string | undefined;
-}
-/**
- * Stamps the columns generated as `Flags.actor`: `createdBy` on insert and
- * `updatedBy` on insert and update. Soft deletes are updates, so they record
- * who deleted the row. `impersonatedBy` gets `context.actor.impersonator` on an
- * impersonated insert or update and is left alone otherwise, so a user's own
- * update keeps the stamp, like the SQL modules' `track_actor`. Without an actor
- * (anonymous requests) nothing is set.
- */
-export declare function actor(options?: ActorOptions): Plugin<"actor">;
-//#endregion

package/dist/plugins/actor/index.js

@@ -1,57 +0,0 @@
-import { r as definePlugin } from "../../plugin-D9bYbYli.js";
-import { a as insertsOnly, c as withDefault, i as guardManaged, t as dbName } from "../../shared-LmlfYPv4.js";
-//#region src/plugins/actor/index.ts
-function defaultActor(context) {
-	const actor = context.actor;
-	return actor && actor.kind !== "anon" ? actor.id : void 0;
-}
-/**
-* Stamps the columns generated as `Flags.actor`: `createdBy` on insert and
-* `updatedBy` on insert and update. Soft deletes are updates, so they record
-* who deleted the row. `impersonatedBy` gets `context.actor.impersonator` on an
-* impersonated insert or update and is left alone otherwise, so a user's own
-* update keeps the stamp, like the SQL modules' `track_actor`. Without an actor
-* (anonymous requests) nothing is set.
-*/
-function actor(options = {}) {
-	const resolve = options.resolve ?? defaultActor;
-	return definePlugin({
-		name: "actor",
-		beforeMutation(op, { table, context, options }) {
-			const flags = table.flags.actor;
-			if (!flags) return op;
-			const created = dbName(table, flags.createdBy);
-			const updated = dbName(table, flags.updatedBy);
-			const impersonated = dbName(table, flags.impersonatedBy);
-			guardManaged(op, [
-				created,
-				updated,
-				impersonated
-			], "actor", options);
-			const id = resolve(context);
-			if (id === void 0) return op;
-			const impersonator = context.actor?.impersonator;
-			const stamp = (row) => {
-				const stamped = withDefault(row, updated, id);
-				return impersonator === void 0 ? stamped : withDefault(stamped, impersonated, impersonator);
-			};
-			switch (op.kind) {
-				case "insert": {
-					const stampCreated = insertsOnly(op);
-					return {
-						...op,
-						rows: op.rows.map((row) => stamp(stampCreated ? withDefault(row, created, id) : row))
-					};
-				}
-				case "update": return {
-					...op,
-					set: stamp(op.set)
-				};
-				case "delete": return op;
-				default: return op;
-			}
-		}
-	});
-}
-//#endregion
-export { actor };

package/dist/plugins/rules/index.d.ts

@@ -1,96 +0,0 @@
-import { v as Operation } from "../../executor-CPyrQdjh.js";
-import { d as Plugin, p as RepositoryExtension } from "../../plugin-Ar5546xh.js";
-//#region src/plugins/rules/index.d.ts
-export type RuleLevel = "off" | "warn" | "error";
-/** A level, or a level with the rule's option: `['error', 500]`. */
-export type RuleSetting<Option = never> = RuleLevel | ([Option] extends [never] ? never : readonly [RuleLevel, Option]);
-export interface RuleSet {
-  /** `findMany` without `limit` (reads the whole table). */
-  readonly noUnboundedFindMany?: RuleSetting;
-  /** `limit` above the given maximum (default 1000). */
-  readonly maxLimit?: RuleSetting<number>;
-  /**
-   * Paging (`offset`, or `limit` above 1) without `orderBy`: Postgres returns
-   * rows in no particular order, so pages overlap or skip rows. `findMany`
-   * orders by the primary key by default, so this only fires on views and
-   * tables without one.
-   */
-  readonly requireOrderByForCursor?: RuleSetting;
-  /** Includes nested deeper than the given depth (default 3). */
-  readonly maxIncludeDepth?: RuleSetting<number>;
-  /**
-   * Tenant tables queried without a tenant: neither `context.tenant` nor the
-   * given claim (default `config.claims.tenant`, `tenant_id`). Service
-   * connections are exempt.
-   */
-  readonly requireTenantContext?: RuleSetting<string>;
-  /** A service-role connection used where `window` and `document` exist. */
-  readonly noAdminInBrowser?: RuleSetting;
-  /**
-   * Reads of columns listed in `config.sensitive` without `sensitive: true` on
-   * the call.
-   */
-  readonly noSensitiveSelect?: RuleSetting;
-  /**
-   * Delete operations without `where`. The repository refuses `deleteMany`
-   * without `where` on its own, so this catches deletes built by plugins; the
-   * lint rule of the same name flags the call in the editor.
-   */
-  readonly noDeleteManyWithoutWhere?: RuleSetting;
-  /**
-   * `updateMany` and `deleteMany` without `maxAffected`, or with one above the
-   * given maximum (default 1000). With a bound, a `where` that matches more
-   * rows than intended fails with `max_affected` and writes nothing. Updates
-   * and deletes by key are exempt.
-   */
-  readonly requireMaxAffected?: RuleSetting<number>;
-  /**
-   * Storage objects written to `*_url` text columns: a column listed in
-   * `storagePaths`, or a value that is a Storage URL or matches a bucket's path
-   * template. Signed URLs expire and public URLs pin the project host, so store
-   * the path in a `*_path` column and build URLs when rendering.
-   */
-  readonly storagePathColumns?: RuleSetting;
-}
-export type RuleName = keyof RuleSet;
-export interface RuleViolation {
-  readonly rule: RuleName;
-  readonly level: "warn" | "error";
-  readonly table: string;
-  readonly operation: Operation["kind"];
-  readonly message: string;
-}
-export interface RulesOptions {
-  readonly rules?: RuleSet;
-  /**
-   * Called for every violation. Defaults to `console.warn` for warnings. Errors
-   * fail the call with `invalid_request` after reporting.
-   */
-  readonly report?: (violation: RuleViolation) => void;
-}
-export interface RulesFindArgs {
-  /** Allow reading `config.sensitive` columns in this call. */
-  readonly sensitive?: boolean;
-}
-export interface RulesExtension extends RepositoryExtension {
-  readonly findArgs: RulesFindArgs;
-}
-/** Catches data-exposure and correctness mistakes; everything else off. */
-export declare function safe(): RuleSet;
-/** `safe()` plus performance warnings. */
-export declare function recommended(): RuleSet;
-/** Every rule as an error. */
-export declare function strict(): RuleSet;
-/**
- * Runtime query rules, checked before each request is built:
- *
- * ```ts
- * defineSupabase(schema).use(rules({ rules: recommended() }));
- * ```
- *
- * Runs first (`enforce: 'first'`) so it sees the query as written, before
- * tenant or soft-delete filters are added. Pair with the static
- * `better-supabase/lint` plugin to catch the same mistakes in the editor.
- */
-export declare function rules(options?: RulesOptions): Plugin<"rules", RulesExtension>;
-//#endregion