better-supabase 0.8.0 → 0.9.0

package/dist/block-hooks-BPNMIlLl.js

@@ -1,114 +0,0 @@
-import { n as dbError, o as isDbError } from "./errors-2M6CKMP4.js";
-import { r as err, t as AsyncResult } from "./result-DEqHCMKP.js";
-import { t as consoleLogger } from "./logger-glM28NVN.js";
-import { i as blockCall } from "./block-helpers-Cy3pB96I.js";
-//#region src/core/block-hooks.ts
-const isPlainObject = (value) => {
-	const proto = Object.getPrototypeOf(value);
-	return proto === Object.prototype || proto === null;
-};
-/** A copy of plain objects and arrays; class instances (Temporal values) are immutable and stay shared. */
-function copyOf(value) {
-	if (Array.isArray(value)) return value.map(copyOf);
-	if (typeof value === "object" && value !== null && isPlainObject(value)) return Object.fromEntries(Object.entries(value).map(([key, entry]) => [key, copyOf(entry)]));
-	return value;
-}
-/** A new client with the same methods: a spread for object literals, a child object otherwise. */
-function cloneClient(client) {
-	if (isPlainObject(client)) return { ...client };
-	return Object.create(client);
-}
-/** The client's method named `name`, or undefined when it has none. */
-function methodOf(client, name) {
-	const value = client[name];
-	if (typeof value !== "function") return void 0;
-	return value;
-}
-/**
-* Runs `hooks` around a block client's methods. Use it to add a rule the
-* block doesn't know (refuse `invite` above a seat limit), rewrite arguments
-* (fill a default), or observe results (metrics, an audit line). Methods
-* without hooks are unchanged.
-*
-* ```ts
-* const orgs = withBlockHooks(createOrganizations(options), {
-*   invite: { before: ([input]) => (input.role === "owner" ? dbError("forbidden", "Owners are added by support") : undefined) },
-* });
-* ```
-*/
-function withBlockHooks(client, hooks, options = {}) {
-	if (hooks === void 0) return client;
-	const block = options.block ?? "block";
-	const logger = options.logger ?? consoleLogger;
-	const wrapped = cloneClient(client);
-	for (const [method, hook] of Object.entries(hooks)) {
-		if (hook === void 0) continue;
-		const original = methodOf(client, method);
-		if (original === void 0) throw new TypeError(`better-supabase: ${block} has no method "${method}" to hook`);
-		const { before, after } = hook;
-		const info = {
-			block,
-			method
-		};
-		wrapped[method] = (...args) => AsyncResult.from(async () => {
-			let current = args;
-			if (before) {
-				const outcome = await before(current, info);
-				if (isDbError(outcome)) return err(outcome);
-				if (Array.isArray(outcome)) current = outcome;
-			}
-			const result = await original.apply(client, current);
-			if (after) try {
-				await after(copyOf(result), current, info);
-			} catch (cause) {
-				logger.error(`${block}.${method} after hook threw`, { cause });
-			}
-			return result;
-		});
-	}
-	return wrapped;
-}
-/**
-* Adds methods to a block client. The builder gets the base client, so a
-* new method can compose existing ones, and `call` for SQL functions the
-* app adds to the block's schema. Redefining a base method throws: wrap it
-* with `withBlockHooks` instead.
-*
-* ```ts
-* const orgs = extendBlock(createOrganizations(options), (base, { call }) => ({
-*   archive: (id: string) => call("archive_organization", { id }, () => undefined),
-* }), { transport: options.transport });
-* ```
-*/
-function extendBlock(client, build, options = {}) {
-	const { transport } = options;
-	const additions = build(client, { call: transport ? blockCall(transport, options.schema ?? "better_supabase", options.mappers ?? []) : () => AsyncResult.err(dbError("unsupported", "extendBlock needs the transport option to call SQL functions")) });
-	const taken = Object.keys(additions).filter((key) => key in client);
-	if (taken.length > 0) throw new TypeError(`better-supabase: extendBlock can't redefine ${taken.map((key) => `"${key}"`).join(", ")}; wrap a base method with withBlockHooks instead`);
-	return Object.assign(cloneClient(client), additions);
-}
-/** Fills in `apiVersion: 1`. */
-function defineTransportMiddleware(middleware) {
-	return {
-		...middleware,
-		apiVersion: 1
-	};
-}
-/**
-* A transport that runs `middleware` around `transport`, the first one
-* outermost. Throws when a middleware targets an API other than 1.
-*/
-function wrapTransport(transport, ...middleware) {
-	for (const entry of middleware) {
-		const version = entry.apiVersion;
-		if (version !== 1) throw new TypeError(`better-supabase: transport middleware "${entry.name}" targets API ${String(version)}; this better-supabase supports 1`);
-	}
-	const run = middleware.reduceRight((next, entry) => (request) => entry.call(request, next), (request) => transport.call(request.schema, request.fn, request.args));
-	return { call: (schema, fn, args) => run({
-		schema,
-		fn,
-		args
-	}) };
-}
-//#endregion
-export { wrapTransport as i, extendBlock as n, withBlockHooks as r, defineTransportMiddleware as t };

package/dist/block-hooks-DaOVC7SC.d.ts

@@ -1,107 +0,0 @@
-import { b as DbError, f as Result, t as AsyncResult, w as ErrorMapper } from "./result-BchM1XZn.js";
-import { t as BlockTransport } from "./block-transport-inD4fFq-.js";
-import { n as Logger } from "./logger-DWVYUmwi.js";
-import { t as BlockCall } from "./block-helpers-C0Xj8War.js";
-//#region src/core/block-hooks.d.ts
-/** A block method: anything that returns an `AsyncResult`. */
-type BlockMethod = (...args: never[]) => AsyncResult<unknown>;
-/** The names of a block client's methods that return an `AsyncResult`. */
-type BlockMethodName<C> = { [K in keyof C]: C[K] extends BlockMethod ? K : never; }[keyof C] & string;
-type ArgsOf<F> = F extends ((...args: infer A) => AsyncResult<unknown>) ? A : never;
-type DataOf<F> = F extends ((...args: never[]) => AsyncResult<infer T>) ? T : never;
-/** Which call a hook runs for. */
-interface BlockHookInfo {
-  /** The block, as `createBlocks` names it, or the name `withBlockHooks` got. */
-  readonly block: string;
-  readonly method: string;
-}
-/**
- * Hooks for one block method. `before` runs first: return nothing to keep
- * the arguments, a new argument list to replace them, or a `DbError` to
- * refuse the call, which then returns that error without reaching the
- * database. `after` observes a copy of the result and can't change it; when
- * it throws, the logger gets the error and the caller still gets the result.
- */
-interface BlockMethodHooks<A extends readonly unknown[], T> {
-  readonly before?: (args: A, info: BlockHookInfo) => Readonly<A> | DbError | void | Promise<Readonly<A> | DbError | void>;
-  readonly after?: (result: Result<T>, args: A, info: BlockHookInfo) => void | Promise<void>;
-}
-/** Hooks keyed by the block client's method names. */
-type BlockHooks<C> = { readonly [K in BlockMethodName<C>]?: BlockMethodHooks<ArgsOf<C[K]>, DataOf<C[K]>>; };
-interface WithBlockHooksOptions {
-  /** The block's name in `BlockHookInfo` and log messages. Default `block`. */
-  readonly block?: string;
-  /** Receives the errors `after` hooks throw. Default: `console`. */
-  readonly logger?: Logger;
-}
-/**
- * Runs `hooks` around a block client's methods. Use it to add a rule the
- * block doesn't know (refuse `invite` above a seat limit), rewrite arguments
- * (fill a default), or observe results (metrics, an audit line). Methods
- * without hooks are unchanged.
- *
- * ```ts
- * const orgs = withBlockHooks(createOrganizations(options), {
- *   invite: { before: ([input]) => (input.role === "owner" ? dbError("forbidden", "Owners are added by support") : undefined) },
- * });
- * ```
- */
-declare function withBlockHooks<C extends object>(client: C, hooks: BlockHooks<C> | undefined, options?: WithBlockHooksOptions): C;
-/** What `extendBlock` hands the builder besides the base client. */
-interface ExtendBlockTools {
-  /**
-   * Calls a SQL function in the block's schema over its transport and maps a
-   * rejection to a `DbError`, as the block's own methods do. Needs the
-   * `transport` option.
-   */
-  readonly call: BlockCall;
-}
-interface ExtendBlockOptions {
-  /** The transport `call` uses: the one the block was created with. */
-  readonly transport?: BlockTransport;
-  /** The schema `call` targets. Default `better_supabase`. */
-  readonly schema?: string;
-  /** Error mappers `call` runs before the built-in ones. */
-  readonly mappers?: readonly ErrorMapper[];
-}
-/**
- * Adds methods to a block client. The builder gets the base client, so a
- * new method can compose existing ones, and `call` for SQL functions the
- * app adds to the block's schema. Redefining a base method throws: wrap it
- * with `withBlockHooks` instead.
- *
- * ```ts
- * const orgs = extendBlock(createOrganizations(options), (base, { call }) => ({
- *   archive: (id: string) => call("archive_organization", { id }, () => undefined),
- * }), { transport: options.transport });
- * ```
- */
-declare function extendBlock<C extends object, X extends object>(client: C, build: (base: C, tools: ExtendBlockTools) => X, options?: ExtendBlockOptions): C & X;
-/** One transport call, as middleware sees it. */
-interface BlockTransportRequest {
-  readonly schema: string;
-  readonly fn: string;
-  readonly args: Readonly<Record<string, unknown>>;
-}
-/**
- * Runs around every call a transport makes: tracing, a statement timeout,
- * an extra argument every function takes. Pass a changed request to `next`
- * to rewrite it. Reject with the error `next` rejected with so the block
- * still maps it to a `DbError`.
- */
-interface BlockTransportMiddleware {
-  readonly apiVersion: 1;
-  readonly name: string;
-  call(request: BlockTransportRequest, next: (request: BlockTransportRequest) => Promise<unknown>): Promise<unknown>;
-}
-/** Fills in `apiVersion: 1`. */
-declare function defineTransportMiddleware(middleware: Omit<BlockTransportMiddleware, "apiVersion"> & {
-  readonly apiVersion?: 1;
-}): BlockTransportMiddleware;
-/**
- * A transport that runs `middleware` around `transport`, the first one
- * outermost. Throws when a middleware targets an API other than 1.
- */
-declare function wrapTransport(transport: BlockTransport, ...middleware: readonly BlockTransportMiddleware[]): BlockTransport;
-//#endregion
-export { BlockTransportMiddleware as a, ExtendBlockTools as c, extendBlock as d, withBlockHooks as f, BlockMethodName as i, WithBlockHooksOptions as l, BlockHooks as n, BlockTransportRequest as o, wrapTransport as p, BlockMethodHooks as r, ExtendBlockOptions as s, BlockHookInfo as t, defineTransportMiddleware as u };

package/dist/block-transport-bAKh-dGc.js

@@ -1,85 +0,0 @@
-import { t as DbException } from "./db-exception-CnWcYPxL.js";
-import { i as sqlIdent } from "./template-lPVh-EwW.js";
-//#region src/core/block-transport.ts
-/**
-* Calls the functions over Postgres, as the user `client` runs as:
-* `sqlTransport(postgres.asUser(ctx.auth.claims))`. Works for any schema.
-*/
-function sqlTransport(client) {
-	return { async call(schema, fn, args) {
-		const entries = Object.entries(args).filter(([, value]) => value !== void 0);
-		const params = entries.map(([, value]) => value !== null && typeof value === "object" && !Array.isArray(value) ? JSON.stringify(value) : value);
-		const list = entries.map(([name], index) => `${sqlIdent(name)} => $${String(index + 1)}`).join(", ");
-		const [row] = await client.queryRaw(`select ${sqlIdent(schema)}.${sqlIdent(fn)}(${list}) as value`, params);
-		return row?.value ?? null;
-	} };
-}
-/**
-* Calls the functions over the Data API with the user's session. Pass
-* `schema` with the API schema that `sql.modules.<module>.api` writes
-* wrappers into; without it the calls go to the module schema, which then
-* has to be exposed.
-*/
-function rpcTransport(client, options = {}) {
-	const untyped = client;
-	return { async call(schema, fn, args) {
-		const defined = Object.fromEntries(Object.entries(args).filter(([, value]) => value !== void 0));
-		const { data, error } = await untyped.schema(options.schema ?? schema).rpc(fn, defined);
-		if (error) {
-			const message = typeof error === "object" && "message" in error ? String(error.message) : String(error);
-			throw Object.assign(new Error(message), error);
-		}
-		return data;
-	} };
-}
-/**
-* Calls the functions through a `Db`'s executor, so a block runs wherever
-* the `Db` does: over PostgREST for `ctx.db` in a normal request, and over
-* direct Postgres as the target in a support session or for an API key.
-* Rejects with the raw database error, like the other transports, so the
-* block's error mappers see the same codes and hints.
-*/
-function dbTransport(db, options = {}) {
-	return { async call(schema, fn, args) {
-		const executor = db.$executor;
-		if (!executor.rpc) throw new TypeError(`dbTransport needs an executor with rpc(); the ${executor.name} executor has none`);
-		let raw;
-		const capture = (error) => {
-			raw = error;
-		};
-		const defined = Object.fromEntries(Object.entries(args).filter(([, value]) => value !== void 0));
-		const result = await executor.rpc(fn, defined, {
-			schema: options.schema ?? schema,
-			errorMappers: [capture]
-		});
-		if (result.ok) return result.data;
-		if (raw === void 0) throw new DbException(result.error);
-		throw Object.assign(new Error(raw.message ?? result.error.message), raw);
-	} };
-}
-const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
-/** The Postgres or PostgREST error a transport rejected with, if it is one. */
-function rawError(cause) {
-	if (!isRecord(cause)) return void 0;
-	const field = (key) => {
-		const value = cause[key];
-		return typeof value === "string" ? value : void 0;
-	};
-	if (field("code") === void 0) return void 0;
-	const raw = {};
-	for (const key of [
-		"message",
-		"code",
-		"details",
-		"hint",
-		"constraint"
-	]) {
-		const value = field(key);
-		if (value !== void 0) raw[key] = value;
-	}
-	const detail = field("detail");
-	if (raw["details"] === void 0 && detail !== void 0) raw["details"] = detail;
-	return raw;
-}
-//#endregion
-export { sqlTransport as i, rawError as n, rpcTransport as r, dbTransport as t };

package/dist/block-transport-inD4fFq-.d.ts

@@ -1,70 +0,0 @@
-import { r as Executor } from "./executor-Drzu3dBK.js";
-import { t as SqlClient } from "./executor-ngjKL_Pe.js";
-//#region src/core/block-transport.d.ts
-/**
- * Calls a block function as the current user and resolves with its result.
- * Rejects with the raw database error (a `pg` error or a PostgREST error
- * object), which the block maps to a `DbError`.
- */
-interface BlockTransport {
-  call(schema: string, fn: string, args: Readonly<Record<string, unknown>>): Promise<unknown>;
-}
-/**
- * Calls the functions over Postgres, as the user `client` runs as:
- * `sqlTransport(postgres.asUser(ctx.auth.claims))`. Works for any schema.
- */
-declare function sqlTransport(client: SqlClient): BlockTransport;
-interface RpcResponse {
-  readonly data: unknown;
-  readonly error: unknown;
-}
-/**
- * The part of a supabase-js client `rpcTransport` uses. The parameters are
- * `never` so a typed `SupabaseClient<Database>` fits too: its `schema` and
- * `rpc` only take the names its `Database` declares, which never include the
- * block functions of a schema the types leave out.
- */
-interface RpcClient {
-  schema(name: never): {
-    rpc(fn: never, args: never): PromiseLike<RpcResponse>;
-  };
-}
-/** Options for `rpcTransport`. */
-interface RpcTransportOptions {
-  /**
-   * The exposed schema that holds the block's entry points, such as `api`
-   * from `sql.modules.<module>.api`. Every call goes there instead of the
-   * module schema, which stays out of `[api] schemas` (doctor BS312).
-   */
-  readonly schema?: string;
-}
-/**
- * Calls the functions over the Data API with the user's session. Pass
- * `schema` with the API schema that `sql.modules.<module>.api` writes
- * wrappers into; without it the calls go to the module schema, which then
- * has to be exposed.
- */
-declare function rpcTransport(client: RpcClient, options?: RpcTransportOptions): BlockTransport;
-/** Options for `dbTransport`. */
-interface DbTransportOptions {
-  /**
-   * The schema every call goes to instead of the module schema, such as the
-   * API schema from `sql.modules.<module>.api`. Over PostgREST it has to be
-   * exposed; over Postgres any schema the caller may use works.
-   */
-  readonly schema?: string;
-}
-/** The part of a `Db` that `dbTransport` uses. */
-interface DbTransportSource {
-  readonly $executor: Executor;
-}
-/**
- * Calls the functions through a `Db`'s executor, so a block runs wherever
- * the `Db` does: over PostgREST for `ctx.db` in a normal request, and over
- * direct Postgres as the target in a support session or for an API key.
- * Rejects with the raw database error, like the other transports, so the
- * block's error mappers see the same codes and hints.
- */
-declare function dbTransport(db: DbTransportSource, options?: DbTransportOptions): BlockTransport;
-//#endregion
-export { dbTransport as a, RpcClient as i, DbTransportOptions as n, rpcTransport as o, DbTransportSource as r, sqlTransport as s, BlockTransport as t };