better-supabase 0.8.0 → 0.9.0

package/dist/client-hyP_nS5R.d.ts

@@ -0,0 +1,218 @@
+/// <reference lib="esnext.temporal" />
+import { b as DbError, t as AsyncResult } from "./result-Cj3yWhjH.js";
+import { n as Logger } from "./logger-DWVYUmwi.js";
+import { t as StandardSchemaV1 } from "./standard-C3_AAF3g.js";
+import { n as BlockOptions } from "./block-helpers-C86hPEjI.js";
+import { n as BlockHooks } from "./block-hooks-BLPWD3Jt.js";
+import { r as FieldsOf } from "./block-fields-5UA84ZUg.js";
+import { g as JobHandler } from "./types-CdP0z5tS.js";
+import { n as Controller } from "./controller-D845qKh2.js";
+import { t as VisibleRange } from "./range-p5V4rBhZ.js";
+//#region src/blocks/bookings/bookings.d.ts
+interface BookingsOptions<S extends StandardSchemaV1 | undefined = undefined> extends BlockOptions {
+  /**
+   * A Standard Schema for the booking columns the app adds
+   * (`blocks.bookings.options.extraColumns`), keyed by column name. The
+   * customer object of `hold` and `public.hold` carries them; the schema
+   * validates them there, which returns a `validation` error for a bad
+   * value, and types and parses them on every booking read.
+   */
+  readonly fields?: S;
+  /** `withBlockHooks` hooks around the client's methods. */
+  readonly hooks?: NoInfer<BlockHooks<Bookings<FieldsOf<S>>>>;
+  /** Receives the errors `after` hooks throw. Default: `console`. */
+  readonly logger?: Logger;
+}
+/** The queue each hold enqueues a job on, to expire it when its time is up. */
+declare const BOOKING_EXPIRE_QUEUE = "bookings.expire-holds";
+/** A duration as a `Temporal.Duration` or an ISO 8601 / Postgres interval string. */
+type BookingDuration = Temporal.Duration | string;
+interface BookingRange {
+  readonly from: Temporal.Instant;
+  readonly until: Temporal.Instant;
+}
+interface BookingResourceInput {
+  readonly id?: string;
+  readonly name?: string;
+  /** What the resource is, matched against a service's `resourceKinds`. Default `staff`. */
+  readonly kind?: string;
+  /** How many bookings can overlap: seats in a class, desks in a room. Default 1. */
+  readonly capacity?: number;
+  /** The IANA zone its weekly hours are in. Default `UTC`. */
+  readonly tz?: string;
+  /** The calendar confirmed bookings are copied into, when the calendar block is installed. */
+  readonly calendarId?: string | null;
+  readonly active?: boolean;
+}
+/** Weekly opening hours: `weekday` 1 is Monday, times are `HH:MM` in the resource's zone. */
+interface WeeklyHours {
+  readonly weekday: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+  readonly start: string;
+  readonly end: string;
+}
+interface BookingExceptionInput {
+  readonly startsAt: Temporal.Instant;
+  readonly endsAt: Temporal.Instant;
+  /** `true` opens the resource outside its hours. Default `false`, which closes it. */
+  readonly available?: boolean;
+  readonly reason?: string;
+}
+interface BookingServiceInput {
+  readonly id?: string;
+  readonly name?: string;
+  readonly duration?: BookingDuration;
+  readonly bufferBefore?: BookingDuration;
+  readonly bufferAfter?: BookingDuration;
+  /** The resource kinds that can serve it; empty means every resource. */
+  readonly resourceKinds?: readonly string[];
+  /** The distance between slot starts. Default the duration. */
+  readonly step?: BookingDuration | null;
+  /** How far ahead a slot must start. */
+  readonly minNotice?: BookingDuration;
+  /** How long a hold keeps the slot. Default 10 minutes. */
+  readonly holdFor?: BookingDuration;
+  /** Minutes before the start that reminders go out. Default one day. */
+  readonly reminderOffsets?: readonly number[];
+  readonly active?: boolean;
+}
+interface BookingSlot {
+  readonly resourceId: string;
+  readonly startsAt: Temporal.Instant;
+  readonly endsAt: Temporal.Instant;
+  /** The start as wall-clock time in the zone asked for, else the resource's. */
+  readonly localStart: Temporal.PlainDateTime;
+  /** Free seats at this time. */
+  readonly seats: number;
+}
+interface BookingCustomer {
+  readonly name?: string;
+  readonly email?: string;
+  /** Only managers can book for another user. */
+  readonly userId?: string;
+  readonly notes?: string;
+}
+type BookingStatus = "hold" | "confirmed" | "cancelled";
+interface Booking {
+  readonly id: string;
+  readonly resourceId: string;
+  readonly serviceId: string;
+  readonly seat: number;
+  readonly startsAt: Temporal.Instant;
+  readonly endsAt: Temporal.Instant;
+  readonly status: BookingStatus;
+  readonly holdExpiresAt?: Temporal.Instant;
+  readonly customerName?: string;
+  readonly customerEmail?: string;
+  readonly customerUserId?: string;
+  readonly notes?: string;
+  readonly createdAt?: Temporal.Instant;
+  readonly cancelledAt?: Temporal.Instant;
+  readonly cancelReason?: string;
+}
+/** A new booking with the token that confirms or cancels it without signing in. Shown once. */
+interface PlacedBooking extends Booking {
+  readonly accessToken: string;
+}
+interface PublicBookingService {
+  readonly id: string;
+  readonly name: string;
+  /** The duration as Postgres prints an interval, such as `00:30:00`. */
+  readonly duration: string;
+  readonly resources: readonly {
+    readonly id: string;
+    readonly name: string;
+    readonly kind: string;
+    readonly tz: string;
+  }[];
+}
+/** The payload a hold enqueues on `bookings.expire-holds`. */
+interface BookingExpirePayload {
+  readonly bookingId?: string;
+}
+/** `F` is the extra booking fields `options.fields` describes. */
+interface Bookings<F extends object = Record<never, never>> {
+  saveResource(organizationId: string, input: BookingResourceInput): AsyncResult<{
+    readonly id: string;
+  }>;
+  /** Replaces a resource's weekly hours. Resolves to the number of rows. */
+  setAvailability(resourceId: string, hours: readonly WeeklyHours[]): AsyncResult<number>;
+  addException(resourceId: string, exception: BookingExceptionInput): AsyncResult<{
+    readonly id: string;
+  }>;
+  deleteException(id: string): AsyncResult<boolean>;
+  saveService(organizationId: string, input: BookingServiceInput): AsyncResult<{
+    readonly id: string;
+  }>;
+  /** The open slots of a service, at most 62 days at a time. */
+  availableSlots(serviceId: string, range: BookingRange, options?: {
+    readonly tz?: string;
+    readonly resourceId?: string;
+  }): AsyncResult<BookingSlot[]>;
+  /** Holds a slot for the service's `holdFor`, or books it with `confirm`. */
+  hold(serviceId: string, resourceId: string, startsAt: Temporal.Instant, customer?: BookingCustomer & Partial<F>, options?: {
+    readonly confirm?: boolean;
+  }): AsyncResult<PlacedBooking & F>;
+  confirm(bookingId: string): AsyncResult<Booking & F>;
+  cancel(bookingId: string, reason?: string): AsyncResult<Booking & F>;
+  /** The bookings that overlap the range, as the caller's policies allow. */
+  list(organizationId: string, range: BookingRange, options?: {
+    readonly resourceId?: string;
+  }): AsyncResult<(Booking & F)[]>;
+  /** Cancels every hold whose time is up. Service only. */
+  expireHolds(): AsyncResult<number>;
+  /** The handler for the `bookings.expire-holds` queue. */
+  readonly job: JobHandler<unknown>;
+  /** The public side, through a share link to a service (`subjectType: "booking_service"`). */
+  readonly public: {
+    service(token: string): AsyncResult<PublicBookingService>;
+    slots(token: string, range: BookingRange, options?: {
+      readonly tz?: string;
+    }): AsyncResult<BookingSlot[]>;
+    /** Holds a slot for a guest, who must give a name and an email. */
+    hold(token: string, resourceId: string, startsAt: Temporal.Instant, customer: BookingCustomer & Partial<F> & {
+      readonly name: string;
+      readonly email: string;
+    }): AsyncResult<PlacedBooking & F>;
+    confirm(bookingId: string, accessToken: string): AsyncResult<Booking & F>;
+    cancel(bookingId: string, accessToken: string): AsyncResult<Booking & F>;
+  };
+}
+/** A booking row as `hold_booking`, `list_bookings` and the others return it. */
+declare function bookingOf(value: unknown): Booking;
+declare function createBookings<S extends StandardSchemaV1 | undefined = undefined>(options: BookingsOptions<S>): Bookings<FieldsOf<S>>;
+//#endregion
+//#region src/blocks/bookings/client.d.ts
+interface AvailableSlotsOptions {
+  readonly client: Pick<Bookings, "availableSlots" | "hold"> & {
+    readonly public: Pick<Bookings["public"], "slots" | "hold">;
+  };
+  readonly serviceId: string;
+  /** The visible range; `setRange` changes it. */
+  readonly range: VisibleRange;
+  /** The zone slot times are shown in. Default each resource's. */
+  readonly tz?: string;
+  readonly resourceId?: string;
+  /** A share-link token: loads and holds slots as a guest. */
+  readonly token?: string;
+}
+interface AvailableSlotsSnapshot {
+  /** `undefined` until the first load. */
+  readonly slots: readonly BookingSlot[] | undefined;
+  /** The slots by local date (`YYYY-MM-DD`), for a day-by-day picker. */
+  readonly days: ReadonlyMap<string, readonly BookingSlot[]>;
+  readonly error: DbError | undefined;
+  /** True until the slots of the current range arrive. */
+  readonly loading: boolean;
+}
+interface AvailableSlotsActions {
+  readonly refresh: () => Promise<void>;
+  /** Holds a slot, then loads the range again. With a token, `customer` needs a name and an email. */
+  readonly hold: (slot: BookingSlot, customer?: BookingCustomer) => Promise<PlacedBooking | undefined>;
+  /** Shows another range; the current slots stay until its slots arrive. */
+  readonly setRange: (range: VisibleRange) => void;
+}
+type AvailableSlotsController = Controller<AvailableSlotsSnapshot, AvailableSlotsActions>;
+/** The open slots of a service in the visible range, for a headless date and time picker. */
+declare function createAvailableSlotsController(options: AvailableSlotsOptions): AvailableSlotsController;
+//#endregion
+export { createBookings as C, bookingOf as S, Bookings as _, createAvailableSlotsController as a, PublicBookingService as b, BookingCustomer as c, BookingExpirePayload as d, BookingRange as f, BookingStatus as g, BookingSlot as h, AvailableSlotsSnapshot as i, BookingDuration as l, BookingServiceInput as m, AvailableSlotsController as n, BOOKING_EXPIRE_QUEUE as o, BookingResourceInput as p, AvailableSlotsOptions as r, Booking as s, AvailableSlotsActions as t, BookingExceptionInput as u, BookingsOptions as v, WeeklyHours as x, PlacedBooking as y };

package/dist/client-i8glKhxh.js

@@ -0,0 +1,67 @@
+import { a as ok, r as err, s as toDbError } from "./result-BlgnMB0H.js";
+import { n as whileSignedIn, t as defineController } from "./controller-D6NyNrlZ.js";
+//#region src/blocks/billing/client.ts
+/**
+* The plans with the tenant's current one, for a plan picker: `choose`
+* starts Checkout through the injected server action and opens the URL it
+* returns.
+*/
+function createPlanPickerController(options) {
+	return defineController({
+		plans: options.initial?.plans,
+		current: options.initial?.current,
+		pending: void 0,
+		error: void 0
+	}, (state) => {
+		let ticket = 0;
+		let seeded = options.initial !== void 0;
+		const refresh = async () => {
+			const request = ++ticket;
+			try {
+				const catalog = await options.load();
+				if (request === ticket) state.set({
+					plans: catalog.plans,
+					current: catalog.current,
+					error: void 0
+				});
+			} catch (cause) {
+				if (request === ticket) state.set({ error: toDbError(cause) });
+			}
+		};
+		return {
+			actions: {
+				refresh,
+				choose: async (plan) => {
+					if (plan === state.get().current) return ok({ url: void 0 });
+					state.set({
+						pending: plan,
+						error: void 0
+					});
+					let started;
+					try {
+						started = await options.checkout(plan);
+						if (started.ok && started.data.url !== void 0) await options.open(started.data.url);
+					} catch (cause) {
+						started = err(toDbError(cause));
+					}
+					if (!started.ok) {
+						state.set({
+							pending: void 0,
+							error: started.error
+						});
+						return started;
+					}
+					state.set({ pending: void 0 });
+					if (started.data.url === void 0) await refresh();
+					return started;
+				}
+			},
+			start: () => whileSignedIn(options.auth, () => {
+				if (seeded) seeded = false;
+				else refresh();
+			})
+		};
+	});
+}
+//#endregion
+export { createPlanPickerController as t };

package/dist/client-iDLLvGR4.d.ts

@@ -0,0 +1,52 @@
+import { p as SubscriptionStatus } from "./topic-cMS7UtM1.js";
+import { n as TopicPort } from "./watch-topic-EFpOIIDE.js";
+import { n as Controller, t as AuthPort } from "./controller-D845qKh2.js";
+//#region src/blocks/notifications/client.d.ts
+/** Loads one list of items, e.g. a server action that calls `notifications.list()`. */
+type NotificationSource<T> = () => Promise<readonly T[]>;
+interface NotificationFeedOptions<T> {
+  /**
+   * The private topic the `notifications` module broadcasts to:
+   * `fillTopic(blockConfig.notifications.options.topic, { userId })` with
+   * the template from `blocks.generated.ts`. `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 NotificationsControllerOptions<T> extends NotificationFeedOptions<T> {
+  readonly auth: AuthPort;
+  readonly ports: {
+    readonly topic: TopicPort;
+  };
+}
+interface NotificationsSnapshot<T> {
+  /** `undefined` until the first load. */
+  readonly items: readonly T[] | undefined;
+  readonly count: number;
+  readonly status: SubscriptionStatus;
+  readonly error: unknown;
+}
+interface NotificationsActions {
+  /** Loads again, e.g. after marking items read. */
+  readonly refresh: () => Promise<void>;
+}
+type NotificationsController<T> = Controller<NotificationsSnapshot<T>, NotificationsActions>;
+/** The default badge number: the items whose `readAt` is `null`. */
+declare const unreadCount: (items: readonly unknown[]) => number;
+/**
+ * The signed-in user's notifications, kept current: loads them, then loads
+ * again after each broadcast on `topic` and after the channel rejoins.
+ */
+declare function createNotificationsController<T>(options: NotificationsControllerOptions<T>): NotificationsController<T>;
+//#endregion
+export { NotificationsControllerOptions as a, unreadCount as c, NotificationsController as i, NotificationSource as n, NotificationsSnapshot as o, NotificationsActions as r, createNotificationsController as s, NotificationFeedOptions as t };