better-supabase 0.5.1 → 0.6.1

package/dist/index-DmXSxbLi.d.ts

@@ -1,62 +0,0 @@
-import { n as AnyFunctions, r as AnyModels } from "./types-Dnf_wRDz.js";
-import { t as BetterSupabase, y as Db } from "./define-Bp_BZa5h.js";
-import { l as PublicEnv } from "./index-CLg87OBW.js";
-import { r as BetterQueries } from "./index-DgILJRXj.js";
-import { SupabaseClient } from "@supabase/supabase-js";
-//#region src/client/index.d.ts
-interface ClientOptions {
-  /** URL and publishable key. Not needed when `client` is given. */
-  readonly env?: PublicEnv;
-  /** Bring your own supabase-js client (React Native, custom storage). */
-  readonly client?: SupabaseClient;
-  /**
-   * `cookies` (default) shares the session with the server through
-   * `@supabase/ssr`; `local` keeps it in localStorage for SPAs without a server.
-   */
-  readonly storage?: "cookies" | "local";
-}
-interface AuthUser {
-  readonly id: string;
-  readonly email?: string;
-  readonly role?: string;
-}
-/** What the UI needs to know. Claims are decoded, not verified: RLS enforces access. */
-type AuthSnapshot = {
-  readonly status: "loading";
-  readonly user: null;
-  readonly claims: null;
-} | {
-  readonly status: "signed-out";
-  readonly user: null;
-  readonly claims: null;
-} | {
-  readonly status: "signed-in";
-  readonly user: AuthUser;
-  readonly claims: Readonly<Record<string, unknown>>;
-};
-interface ClientAuth {
-  readonly current: () => AuthSnapshot;
-  /** `useSyncExternalStore`-compatible. */
-  readonly subscribe: (listener: () => void) => () => void;
-}
-interface BetterClient<M extends AnyModels, F extends AnyFunctions, E, C = unknown, P = unknown> {
-  /** The definition the client was created from (schema metadata, specs, live queries). */
-  readonly betterSupabase: BetterSupabase<M, unknown, F, E, C, P>;
-  readonly supabase: SupabaseClient;
-  /** Repositories with the current session's actor and claims. */
-  readonly db: Db<M, F, E, SupabaseClient>;
-  /** TanStack Query option factories over `db`. */
-  readonly queries: BetterQueries<M, E, F>;
-  readonly auth: ClientAuth;
-}
-/**
- * The browser side: a supabase-js client, repositories that follow the
- * session, TanStack Query options and an auth store for UI state.
- *
- * ```ts
- * export const bs = createClient(betterSupabase, { env: { url, publishableKey } });
- * ```
- */
-declare function createClient$1<M extends AnyModels, D, F extends AnyFunctions, E, C = unknown, P = unknown>(betterSupabase: BetterSupabase<M, D, F, E, C, P>, options?: ClientOptions): BetterClient<M, F, E, C, P>;
-//#endregion
-export { ClientOptions as a, ClientAuth as i, AuthUser as n, createClient$1 as o, BetterClient as r, AuthSnapshot as t };

package/dist/index-Dp2VDwog.d.ts

@@ -1,161 +0,0 @@
-import { _ as DbError } from "./executor-BunPOO-k.js";
-import { Z as QuerySpec } from "./define-Bp_BZa5h.js";
-import { i as ClientAuth, t as AuthSnapshot } from "./index-DmXSxbLi.js";
-import { n as TemplateValues } from "./template-mbvlysOo.js";
-import { t as AuthSession } from "./view-CbgObAeb.js";
-import { a as LiveSource, g as Topic, h as SubscriptionStatus, p as SubscribeOptions, r as LiveCountSeed, u as EventSchemas, v as TopicHandlers, y as TopicMessage } from "./live-D9W2M5aO.js";
-import { SupabaseClient } from "@supabase/supabase-js";
-import { ReactNode } from "react";
-import { StandardSchemaV1 } from "@standard-schema/spec";
-import { QueryClient } from "@tanstack/query-core";
-//#region src/react/hooks.d.ts
-/** The parts of `createClient()` the provider needs. */
-interface ClientLike {
-  readonly betterSupabase: LiveSource;
-  readonly supabase: SupabaseClient;
-  readonly auth: ClientAuth;
-  readonly db: object;
-  readonly queries: object;
-}
-interface BetterSupabaseProviderProps {
-  readonly client: ClientLike;
-  /** better-supabase queries are removed when the user signs out or changes. */
-  readonly queryClient?: QueryClient;
-  readonly children?: ReactNode;
-}
-/** Provides the better-supabase client to the hooks. */
-declare function BetterSupabaseProvider(props: BetterSupabaseProviderProps): ReactNode;
-/** The session state for UI: `loading`, `signed-out` or `signed-in` with the user and claims. */
-declare function useAuth(): AuthSnapshot;
-declare function useSupabase(): SupabaseClient;
-interface BetterHooks<B extends ClientLike> {
-  /** Repositories bound to the current session. Re-renders when the user changes. */
-  readonly useDb: () => B["db"];
-  /** TanStack Query option factories: `useQuery(useQueries().customers.findMany())`. */
-  readonly useQueries: () => B["queries"];
-  readonly useSupabase: () => SupabaseClient;
-  readonly useAuth: () => AuthSnapshot;
-  /** `useSession()` typed by the client's `betterSupabase.claims(schema)` and `betterSupabase.userMetadata(schema)`. */
-  readonly useSession: () => AuthSession<ClaimsOf<B>, ProfileOf<B>>;
-}
-/** The claims type of a client's `betterSupabase.claims(schema)`, `unknown` without one. */
-type ClaimsOf<B extends ClientLike> = B["betterSupabase"] extends {
-  readonly claimsSchema: StandardSchemaV1<unknown, infer C> | undefined;
-} ? C : unknown;
-/** The profile type of a client's `betterSupabase.userMetadata(schema)`, `unknown` without one. */
-type ProfileOf<B extends ClientLike> = B["betterSupabase"] extends {
-  readonly userMetadataSchema: StandardSchemaV1<unknown, infer P> | undefined;
-} ? P : unknown;
-/**
- * Hooks typed for your schema.
- *
- * ```ts
- * export const { useDb, useQueries, useAuth } = createHooks<typeof bs>();
- * ```
- */
-declare function createHooks<B extends ClientLike>(): BetterHooks<B>;
-interface BroadcastOptions extends Omit<SubscribeOptions, "onStatus"> {
-  /**
-   * Refetch after each message: table keys (every query that read one of
-   * them), or a function returning query keys. Needs `queryClient` on the
-   * provider.
-   */
-  readonly invalidate?: readonly string[] | ((message: TopicMessage) => readonly (readonly unknown[])[]);
-}
-/**
- * Subscribes to a topic while mounted. Pass `null` values to pause. It
- * resubscribes when the topic or the signed-in user changes.
- *
- * ```ts
- * useBroadcast(customersTopic, orgId ? { orgId } : null, {}, { invalidate: ['customers'] });
- * ```
- */
-declare function useBroadcast<P extends string, E extends EventSchemas>(topic: Topic<P, E>, values: TemplateValues<P> | null | undefined, handlers?: TopicHandlers<E>, options?: BroadcastOptions): SubscriptionStatus;
-interface LiveQueryHookOptions {
-  /**
-   * Tenant for tenant-scoped tables. Defaults to the `config.claims.tenant`
-   * claim (`tenant_id`, top-level or in `app_metadata`).
-   */
-  readonly tenant?: string;
-  /** Defaults to 100 ms. */
-  readonly debounceMs?: number;
-}
-/**
- * Keeps a query fresh: invalidates every cached query that read a table the
- * spec touches whenever one of them changes. Pass `null` to pause. It
- * resubscribes when the spec, tenant or user changes.
- *
- * ```ts
- * const spec = betterSupabase.spec.customers.findMany({ include: { notes: true } });
- * const { data } = useQuery(q.$spec(spec));
- * useLiveQuery(spec);
- * ```
- */
-declare function useLiveQuery(spec: QuerySpec | null | undefined, options?: LiveQueryHookOptions): SubscriptionStatus;
-interface LiveCountHookOptions extends LiveQueryHookOptions {
-  /** The count to show before the first fetch, e.g. from the server. */
-  readonly initial?: number;
-}
-interface LiveCount {
-  /** `undefined` until the first count arrives. */
-  readonly count: number | undefined;
-  readonly status: SubscriptionStatus;
-  /** The last failed refetch; the previous count stays. */
-  readonly error: DbError | undefined;
-}
-/**
- * A count that stays current: refetches only the `count` spec (a HEAD
- * request) after each debounced change to a table it reads, and after the
- * channel rejoins. Takes a spec or a `bs.liveCount()` seed; pass `null` to
- * pause. Doesn't need a `QueryClient`.
- *
- * ```tsx
- * const { count } = useLiveCount(seed); // seed = await bs.liveCount(spec)
- * ```
- */
-declare function useLiveCount(source: QuerySpec<string, "count", number> | LiveCountSeed | null | undefined, options?: LiveCountHookOptions): LiveCount;
-//#endregion
-//#region src/react/notifications.d.ts
-/** Loads one list of items, e.g. a server action that calls `notifications.list()`. */
-type NotificationSource<T> = () => Promise<readonly T[]>;
-interface UseNotificationsOptions<T> {
-  /**
-   * The private topic the `notifications` module broadcasts to, e.g.
-   * `notifications:${userId}` (`kits.notifications.options.topic`). `null`
-   * loads once without realtime.
-   */
-  readonly topic: string | null;
-  /** The notifications, newest first. */
-  readonly load: NotificationSource<T>;
-  /** More items merged in, such as running jobs or pending approvals. */
-  readonly sources?: readonly NotificationSource<T>[];
-  /** Orders the merged list. Defaults to the order the sources return. */
-  readonly sort?: (a: T, b: T) => number;
-  /** The badge number. Defaults to the items without a `readAt`. */
-  readonly count?: (items: readonly T[]) => number;
-  /** Runs for each broadcast, e.g. to show a toast for `notification_created`. */
-  readonly onMessage?: (event: string, payload: unknown) => void;
-}
-interface NotificationsState<T> {
-  /** `undefined` until the first load. */
-  readonly items: readonly T[] | undefined;
-  readonly count: number;
-  readonly status: SubscriptionStatus;
-  readonly error: unknown;
-  /** Loads again, e.g. after marking items read. */
-  readonly refresh: () => Promise<void>;
-}
-/**
- * The signed-in user's notifications, kept current: loads them, then loads
- * again after each broadcast on `topic` and after the channel rejoins.
- *
- * ```tsx
- * const { items, count } = useNotifications({
- *   topic: `org:${orgId}:notifications:${userId}`,
- *   load: () => listNotifications(orgId),
- * });
- * ```
- */
-declare function useNotifications<T>(options: UseNotificationsOptions<T>): NotificationsState<T>;
-//#endregion
-export { useBroadcast as _, BetterHooks as a, useSupabase as b, BroadcastOptions as c, LiveCount as d, LiveCountHookOptions as f, useAuth as g, createHooks as h, useNotifications as i, ClaimsOf as l, ProfileOf as m, NotificationsState as n, BetterSupabaseProvider as o, LiveQueryHookOptions as p, UseNotificationsOptions as r, BetterSupabaseProviderProps as s, NotificationSource as t, ClientLike as u, useLiveCount as v, useLiveQuery as y };

package/dist/jobs/index.d.ts

@@ -1,226 +0,0 @@
-/// <reference lib="esnext.temporal" />
-import { _ as DbError, a as AsyncResult, u as Result } from "../executor-BunPOO-k.js";
-import { t as SqlClient } from "../executor-Cghdstwu.js";
-import { r as EventSink, t as CloudEvent } from "../index-DOESKG27.js";
-import { C as sqlQueueBackend, S as pgmqPublicBackend, _ as QueueSchemas, a as DrainRouteResult, b as WorkOptions, c as FailOptions, d as JobHandler, f as Jobs, g as QueueRpcClient, h as QueueMessageRow, i as DrainRouteOptions, l as Job, m as QueueMessageBody, n as DrainOptions, o as DueSchedule, p as QueueBackend, r as DrainResult, s as EnqueueOptions, t as ClaimOptions, u as JobContext, v as RunSchedulesOptions, x as createJobs, y as ScheduleOptions } from "../queue-BYUCjr59.js";
-//#region src/jobs/cron.d.ts
-/**
- * Throws a `TypeError` unless `expression` is a schedule `nextCronRun`
- * understands: five cron fields, a macro such as `@daily`, or an interval
- * such as `30 seconds`.
- */
-export declare function assertCron(expression: string): void;
-/**
- * The first run of `expression` after `after`, in `timeZone`.
- *
- * Accepts five cron fields (lists, ranges and steps; a restricted day of
- * month and day of week match either, as in cron), the macros `@hourly`,
- * `@daily`, `@weekly`, `@monthly` and `@yearly`, and intervals such as
- * `30 seconds`, `5 minutes` or `2 hours`, counted from `after`. A local time
- * that a DST change skips runs at the same offset after the gap.
- */
-export declare function nextCronRun(expression: string, timeZone: string, after: Temporal.Instant): Temporal.Instant;
-//#endregion
-//#region src/jobs/jobs.d.ts
-interface IdempotencyOptions {
-  /**
-   * Separates keys of different callers, endpoints or tenants. Defaults to a
-   * hash of the caller's credentials (the `Authorization` header or the
-   * Supabase auth cookies), so one caller never replays another's response.
-   * Pass the verified user id to keep keys across token refreshes.
-   */
-  readonly scope?: string | ((request: Request) => string);
-  /** How long a completed response is replayed. Defaults to `24 hours`. */
-  readonly ttl?: number | string;
-  /** How long a running request holds the key. Defaults to `1 minute`. */
-  readonly lock?: number | string;
-  /** Answer 400 when the header is missing. Defaults to false (run without a key). */
-  readonly required?: boolean;
-  /** Defaults to `Idempotency-Key`. */
-  readonly header?: string;
-}
-type IdempotencyState = "started" | "replay" | "running" | "mismatch";
-interface Idempotency {
-  /**
-   * Runs `handler` at most once per key: retries with the same key and body
-   * get the stored response (with `Idempotency-Replayed: true`).
-   */
-  handle(request: Request, handler: (request: Request) => Promise<Response> | Response): Promise<Response>;
-  /** The lower-level protocol, for non-HTTP callers. */
-  begin(key: string, fingerprint: string, scope?: string): AsyncResult<{
-    state: IdempotencyState;
-    status: number | null;
-    body: unknown;
-  }>;
-  complete(key: string, status: number, body: unknown, scope?: string): AsyncResult<void>;
-  release(key: string, scope?: string): AsyncResult<void>;
-}
-/** HTTP idempotency keys (IETF `Idempotency-Key` header) over the `idempotency` SQL kit module. */
-export declare function createIdempotency(sql: SqlClient, options?: IdempotencyOptions): Idempotency;
-interface InboxMessage<T = unknown> {
-  readonly id: number;
-  readonly source: string;
-  readonly messageId: string;
-  readonly type: string | null;
-  readonly payload: T;
-  readonly headers: Readonly<Record<string, string>>;
-  readonly attempts: number;
-  readonly receivedAt: Temporal.Instant;
-}
-interface InboxOptions {
-  /** Name of the sender, e.g. `stripe` or `supabase-auth`. */
-  readonly source: string;
-  /** Standard Webhooks secrets; the signature is verified before storing. */
-  readonly secrets?: string | readonly string[];
-  /** Custom verification for senders that don't use Standard Webhooks. */
-  readonly verify?: (request: Request, body: string) => Promise<Result<{
-    id: string;
-    payload: unknown;
-  }>>;
-  /** Event type from the payload. Defaults to `payload.type`. */
-  readonly typeOf?: (payload: unknown) => string | null;
-  /** Headers kept with the message. Defaults to none. */
-  readonly keepHeaders?: readonly string[];
-  readonly worker?: string;
-}
-interface Inbox {
-  /** Verifies and stores a webhook; answers 202, or 200 for a duplicate delivery. */
-  receive(request: Request): Promise<Response>;
-  /** Processes stored messages until none are ready. */
-  process<T = unknown>(handler: (message: InboxMessage<T>) => unknown, options?: {
-    readonly batch?: number;
-    readonly lease?: number | string;
-  }): Promise<DrainResult>;
-}
-/** Store-then-process webhooks: acknowledge fast, process with retries, never twice. */
-export declare function createInbox(sql: SqlClient, options: InboxOptions): Inbox;
-/** The Stripe event sent when a customer's active entitlements change. */
-export declare const ENTITLEMENTS_UPDATED = "entitlements.active_entitlement_summary.updated";
-/**
- * Users whose `memberships` claim carries the entitlements of the Stripe
- * customer in an `entitlements.active_entitlement_summary.updated` event, so
- * a job can invalidate their sessions. Empty for other payloads.
- */
-export declare function entitlementMembers(sql: SqlClient, payload: unknown): AsyncResult<readonly string[]>;
-interface PurgeAuditLogOptions {
-  /** How long entries are kept when `retention` has no answer. Defaults to `1 year`. */
-  readonly olderThan?: number | string;
-  /** The most entries deleted per tenant in one call. Defaults to 10000. */
-  readonly batch?: number;
-  /**
-   * Days a tenant keeps its entries (a plan's retention, say); `undefined`
-   * uses `olderThan`. Called with `null` for entries without a tenant.
-   * Retention shorter than a day is not supported.
-   */
-  readonly retention?: (tenant: string | null) => number | undefined | Promise<number | undefined>;
-}
-/**
- * Deletes audit entries past their retention and returns how many. Without
- * `retention` it is one `purge_audit_log` call (which honours an
- * `audit_retention` SQL hook); with it, each tenant is purged with its own
- * interval. Run it from a schedule until it returns 0.
- */
-export declare function purgeAuditLog(sql: SqlClient, options?: PurgeAuditLogOptions): AsyncResult<number>;
-//#endregion
-//#region src/jobs/outbox.d.ts
-/** One row of the outbox, as `outbox_claim` and `outbox_history` return it. */
-interface OutboxEvent {
-  /** The cursor value: increases with every event. */
-  readonly position: number;
-  readonly id: string;
-  readonly type: string;
-  readonly payload: unknown;
-  /** The module or function that wrote it, e.g. `better-supabase/organizations`. */
-  readonly source: string | null;
-  readonly subject: string | null;
-  readonly tenant: string | null;
-  readonly key: string | null;
-  readonly actorId: string | null;
-  readonly createdAt: Temporal.Instant;
-}
-interface EmitOptions {
-  readonly subject?: string;
-  readonly tenant?: string;
-  /** With a key, emitting again (per tenant) returns the first event. */
-  readonly key?: string;
-  readonly source?: string;
-}
-interface OutboxOptions {
-  /** The schema of the `outbox` module. Defaults to `better_supabase`. */
-  readonly schema?: string;
-  /** CloudEvents `source` of the relayed events, e.g. `https://crm.example.com`. */
-  readonly source: string;
-  /** Prepended to each type with a dot when relaying, e.g. `com.example`. Defaults to `dev.better-supabase`. */
-  readonly typePrefix?: string;
-}
-interface RegisterOptions {
-  /** Type patterns such as `org.*` or `invoice.paid`. Defaults to every event. */
-  readonly types?: readonly string[];
-  /** Start at the first kept event instead of after the latest one. */
-  readonly fromStart?: boolean;
-}
-interface RelayOptions {
-  /** Events per claim and per `sink.send`. Defaults to 100. */
-  readonly batch?: number;
-  /** How long a claim holds the consumer. Defaults to `1 minute`. */
-  readonly lease?: string;
-  /** Stops claiming after this many milliseconds. */
-  readonly budgetMs?: number;
-  /** Identifies this worker in the lease. Defaults to a random id. */
-  readonly owner?: string;
-}
-interface RelayResult {
-  readonly delivered: number;
-  /** Set when the sink threw: the batch stays unacknowledged for the next run. */
-  readonly error?: DbError;
-}
-interface OutboxRouteOptions extends Omit<RelayOptions, "owner"> {
-  /** The bearer secret, such as `process.env.CRON_SECRET`. */
-  readonly secret: string | undefined;
-  /** Consumer name to the sink its events go to. */
-  readonly consumers: Readonly<Record<string, EventSink>>;
-  readonly onError?: (error: DbError, consumer: string) => void;
-}
-interface OutboxRouteResult {
-  readonly consumers: Readonly<Record<string, RelayResult>>;
-  readonly budgetExhausted: boolean;
-}
-interface HistoryFilter {
-  readonly subject?: string;
-  readonly type?: string;
-  /** Only events after this position. */
-  readonly after?: number;
-  readonly limit?: number;
-}
-interface Outbox {
-  /** Writes an event in the current transaction and returns its id. */
-  emit(type: string, payload?: unknown, options?: EmitOptions): AsyncResult<string>;
-  /** Creates the consumer, or changes its types. Returns its cursor position. */
-  register(consumer: string, options?: RegisterOptions): AsyncResult<number>;
-  /** Removes the consumer, so purges stop waiting for it. */
-  unregister(consumer: string): AsyncResult<boolean>;
-  /**
-   * Claims the consumer's next events, sends them to `sink` as CloudEvents and
-   * moves the cursor, until none are left or the budget runs out. A sink that
-   * throws leaves the batch for the next run, so delivery is at least once.
-   */
-  relay(consumer: string, sink: EventSink, options?: RelayOptions): Promise<RelayResult>;
-  /** A `GET`/`POST` handler for a cron that relays every consumer in turn. */
-  relayRoute(options: OutboxRouteOptions): (request: Request) => Promise<Response>;
-  history(filter?: HistoryFilter): AsyncResult<readonly OutboxEvent[]>;
-  /**
-   * Deletes up to `batch` events (default 10,000) older than `olderThan` that
-   * every consumer has passed. Call it again while it returns `batch`.
-   */
-  purge(olderThan?: string, batch?: number): AsyncResult<number>;
-}
-/**
- * The CloudEvent for an outbox row: the row id as `id` (stable, so receivers
- * can deduplicate), the payload as `data`, the tenant as `partitionkey` and
- * the writing module as `producer`. The actor stays out of the context
- * attributes, which must not carry personal data.
- */
-export declare function outboxCloudEvent(event: OutboxEvent, options: Pick<OutboxOptions, "source" | "typePrefix">): CloudEvent;
-export declare function createOutbox(sql: SqlClient, options: OutboxOptions): Outbox;
-//#endregion
-export { type ClaimOptions, type DrainOptions, type DrainResult, type DrainRouteOptions, type DrainRouteResult, type DueSchedule, type EmitOptions, type EnqueueOptions, type FailOptions, type HistoryFilter, type Idempotency, type IdempotencyOptions, type IdempotencyState, type Inbox, type InboxMessage, type InboxOptions, type Job, type JobContext, type JobHandler, type Jobs, type Outbox, type OutboxEvent, type OutboxOptions, type OutboxRouteOptions, type OutboxRouteResult, type PurgeAuditLogOptions, type QueueBackend, type QueueMessageBody, type QueueMessageRow, type QueueRpcClient, type QueueSchemas, type RegisterOptions, type RelayOptions, type RelayResult, type RunSchedulesOptions, type ScheduleOptions, type SqlClient, type WorkOptions, createJobs, pgmqPublicBackend, sqlQueueBackend };