better-supabase 0.12.0 → 0.14.0

package/dist/options-Dm-2crCx.d.ts

@@ -0,0 +1,273 @@
+import { h as MutationIntent, lt as SchemaMeta } from "./executor-CPyrQdjh.js";
+import { bt as EventMap } from "./events-DbLjvxDX.js";
+import { n as AnyPlugin } from "./plugin-Ar5546xh.js";
+import { C as ModelWebhook, E as OperationSource, O as SecurityRequirement, S as ModelTag, a as JsonSchema, b as ModelServer, d as ModelInfo, f as ModelMessage, i as JsonObject, m as ModelOperation, n as DataApiOperation, p as ModelMessageTrait, r as HttpMethod, s as ModelChannel, t as ApiModel, v as ModelSecurityProfileRequirement, w as ModelWorkflow, y as ModelSecurityScheme } from "./model-Btl8X9cs.js";
+import { c as SpecDiagnostic } from "./format-AYHceC2m.js";
+import { o as Authorizer } from "./authorizer-DFP3gHv8.js";
+import { a as ResourcePlan, o as StandardLike, r as ResourceDescription, t as ErrorResponse } from "./resource-DYDEnww-.js";
+import { t as RealtimeStatus } from "./realtime-status-BhNkb-Ow.js";
+import { n as CloudEventOptions } from "./cloud-event-SPyXMdcd.js";
+import { StandardSchemaV1 } from "@standard-schema/spec";
+//#region src/spec/presets.d.ts
+/** JSON Schema for RFC 9457 Problem Details as better-supabase sends them. */
+declare const PROBLEM_SCHEMA: Record<string, unknown>;
+/** The default error responses: today's Problem Details answers, 400 to 422. */
+declare const DEFAULT_ERRORS: readonly ErrorResponse[];
+/** A security scheme of your own, with the scopes its requirement asks for. */
+interface CustomSecurity {
+  /** The component name of the scheme. */
+  readonly name: string;
+  readonly scheme: ModelSecurityScheme;
+  readonly scopes?: readonly string[];
+}
+/**
+ * `bearer`: a Supabase access token (`supabaseJwt`). `oauth2`: the Supabase
+ * OAuth 2.1 server (`supabaseOAuth`, needs `supabaseUrl`). `apiKey`: the
+ * project's publishable key in the `apikey` header (`supabaseApiKey`). Each
+ * preset is one alternative requirement.
+ */
+type SecurityPreset = "bearer" | "oauth2" | "apiKey" | CustomSecurity;
+//#endregion
+//#region src/spec/data-api.d.ts
+/** Which tables and functions the Data API (PostgREST) section documents. */
+interface DataApiOptions {
+  /** Tables and views by app key, or `true` for all of them. */
+  readonly tables?: true | readonly string[];
+  /** Functions by key, or `true` for all of them, as `POST /rest/v1/rpc/<name>`. */
+  readonly functions?: true | readonly string[];
+  /**
+   * The operations per table, by app key. Defaults to all four for a table and
+   * to the ones its columns allow for a view.
+   */
+  readonly operations?: Readonly<Record<string, readonly DataApiOperation[]>>;
+  /** The tag of every Data API operation. Defaults to `Data API`. */
+  readonly tag?: string;
+}
+//#endregion
+//#region src/spec/events.d.ts
+/** A schema for a block event's data, checked against the block's event map. */
+type BlockEventSchema<T> = StandardSchemaV1<unknown, T>;
+/**
+ * Data schemas for block events, by event type, typed by an event map such as
+ * `EventMapOf<typeof messagingEvents>`. `true` documents the event with an open
+ * payload. A block can export its own map of this type.
+ */
+type BlockEventSchemas<M extends EventMap = EventMap> = { readonly [K in keyof M & string]?: true | BlockEventSchema<M[K]>; };
+/**
+ * A Realtime broadcast topic. A `defineTopic()` result fits as it is, with its
+ * event and presence schemas, `send` and `permission`; `topicsFrom()` collects
+ * them from a module.
+ */
+interface TopicInput<Ref = string> {
+  readonly template: string;
+  readonly name?: string;
+  readonly private?: boolean;
+  readonly presence?: boolean;
+  /** The schema of each tracked presence state; open when unset. */
+  readonly presenceSchema?: StandardLike | undefined;
+  /** Payload schema per broadcast event; `true` for an open payload. */
+  readonly events?: Readonly<Record<string, StandardLike | true>>;
+  /**
+   * Clients may broadcast on the topic, not only receive. Only `true` counts,
+   * so a `defineTopic()` result's `send` method is ignored.
+   */
+  readonly send?: boolean | ((...args: never[]) => unknown);
+  /** The same as `send: true`; what a `defineTopic()` result carries. */
+  readonly clientSend?: boolean;
+  readonly permission?: Ref | undefined;
+  /** Supabase's status for the topic's features. Defaults from `private`. */
+  readonly status?: RealtimeStatus;
+  readonly summary?: string;
+  readonly description?: string;
+}
+/**
+ * The `defineTopic()` results in modules or arrays, for `events.topics`. A
+ * module's topics are keyed by export name; a topic in an array by its `name`.
+ * Other values are skipped, and a topic reached twice is kept once.
+ *
+ * ```ts
+ * import * as topics from "../realtime/topics";
+ * defineApi(betterSupabase, {
+ *   info,
+ *   events: { topics: topicsFrom(topics) },
+ * });
+ * ```
+ */
+declare function topicsFrom(...sources: readonly (Readonly<Record<string, unknown>> | readonly unknown[])[]): Readonly<Record<string, TopicInput>>;
+/** CloudEvents the app sends (`forwardMutations`, `forwardBlockEvents`). */
+interface CloudEventsInput extends Pick<CloudEventOptions, "source" | "typePrefix" | "dataschema"> {
+  /** The sink's address. Defaults to `events`. */
+  readonly address?: string;
+  /** Row events for these tables (`true` for every table). Defaults to none. */
+  readonly rows?: boolean | readonly string[];
+  /** Which row events. Defaults to insert, update and delete. */
+  readonly intents?: readonly MutationIntent[];
+  /** Block events and their data schemas. */
+  readonly blocks?: BlockEventSchemas;
+}
+/** Channels and messages for AsyncAPI, built from the schema and the app. */
+interface EventsOptions<Ref = string> {
+  /**
+   * Table change signals (`bs:t:<schema>.<table>`) for the tables in
+   * `realtime.tables`: `true` for all, or app keys. Defaults to `true`.
+   */
+  readonly tables?: boolean | readonly string[];
+  /** Realtime broadcast topics, by key. */
+  readonly topics?: Readonly<Record<string, TopicInput<Ref>>>;
+  readonly cloudEvents?: CloudEventsInput;
+}
+/** The CloudEvents attributes in HTTP binary mode (`ce-*` headers). */
+declare const CLOUD_EVENT_TRAIT: ModelMessageTrait;
+//#endregion
+//#region src/spec/options.d.ts
+/** What `defineApi` reads from a `defineSupabase()` result. */
+interface ApiSource {
+  readonly meta: SchemaMeta;
+  readonly plugins?: readonly AnyPlugin[];
+}
+/**
+ * A resource: its description, `true` for the defaults, or a handler that
+ * carries its plan.
+ */
+type ResourceInput<Ref = string> = ResourceDescription<Ref> | true | {
+  readonly plan: ResourcePlan<Ref>;
+};
+/** A custom route, documented from its Standard Schemas (Standard JSON Schema). */
+interface RouteSpec<Ref = string> {
+  readonly method: HttpMethod | Uppercase<HttpMethod>;
+  /** Relative to `basePath`, with `{name}` path parameters. */
+  readonly path: string;
+  readonly operationId?: string;
+  readonly summary?: string;
+  readonly description?: string;
+  readonly tags?: readonly string[];
+  readonly deprecated?: boolean;
+  /** The path parameters, as an object schema. Unlisted ones are strings. */
+  readonly params?: StandardLike;
+  /** The query parameters, as an object schema. */
+  readonly query?: StandardLike;
+  /** The JSON body. */
+  readonly input?: StandardLike;
+  /** The JSON response. Without it (and without `stream`) the route answers 204. */
+  readonly output?: StandardLike;
+  /**
+   * A stream response: each item's schema (`itemSchema`), by default as
+   * `text/event-stream`.
+   */
+  readonly stream?: {
+    readonly item: StandardLike;
+    readonly contentType?: string;
+  };
+  /** Success status. Defaults to 200 with an output or stream, 204 without. */
+  readonly status?: number;
+  /** Overrides the API's security; `[]` makes the route public. */
+  readonly security?: readonly SecurityRequirement[];
+  readonly permission?: Ref;
+  /** The shared error responses. Defaults to the API's `errors`. */
+  readonly errors?: readonly ErrorResponse[];
+  /** Deep-merged into the rendered operation. */
+  readonly extend?: JsonObject;
+}
+interface OperationIdContext {
+  readonly source: OperationSource;
+  readonly method: HttpMethod;
+  readonly path: string;
+  /** The id better-supabase would use, e.g. `listCustomers`. */
+  readonly defaultId: string;
+}
+type ComponentNameContext = {
+  readonly kind: "table";
+  readonly table: string;
+  readonly variant: "Row" | "Insert" | "Update" | "Page";
+  readonly defaultName: string;
+} | {
+  readonly kind: "schema";
+  /** The name from the schema's own `$id` or `id` metadata. */
+  readonly id: string | undefined;
+  readonly schema: JsonSchema;
+  readonly role: "input" | "output" | "item";
+  readonly operationId: string;
+};
+/**
+ * Version-neutral hooks on the model. Return a replacement, or nothing to keep
+ * it.
+ */
+interface EnrichHooks {
+  readonly operation?: (operation: ModelOperation) => ModelOperation | undefined;
+  readonly schema?: (schema: JsonSchema, context: {
+    readonly name: string;
+  }) => JsonSchema | undefined;
+  readonly channel?: (channel: ModelChannel) => ModelChannel | undefined;
+  readonly message?: (message: ModelMessage, context: {
+    readonly id: string;
+  }) => ModelMessage | undefined;
+  readonly workflow?: (workflow: ModelWorkflow) => ModelWorkflow | undefined;
+}
+interface ApiOptions<Ref = string> {
+  readonly info: ModelInfo;
+  /** The document's own URL (`$self`). */
+  readonly self?: string;
+  readonly servers?: readonly ModelServer[];
+  /** Prefix for every path, e.g. `/api`. */
+  readonly basePath?: string;
+  /** Tags listed before the resource tags, with summaries and parents. */
+  readonly tags?: readonly ModelTag[];
+  /** Tables to publish, by app key. */
+  readonly resources?: Readonly<Record<string, ResourceInput<Ref>>>;
+  readonly routes?: readonly RouteSpec<Ref>[];
+  /**
+   * Tables and functions to document as the Supabase Data API (`/rest/v1`),
+   * with database names.
+   */
+  readonly dataApi?: DataApiOptions;
+  /** Parsed OpenAPI fragments, merged over the generated document. */
+  readonly fragments?: readonly JsonObject[];
+  /** Defaults to `['bearer']`. */
+  readonly security?: readonly SecurityPreset[];
+  /** The project URL, for the `oauth2` preset. */
+  readonly supabaseUrl?: string;
+  /** Shared error responses. Defaults to `DEFAULT_ERRORS`. */
+  readonly errors?: readonly ErrorResponse[];
+  readonly operationId?: (context: OperationIdContext) => string;
+  /**
+   * Names a component; `undefined` keeps the default (tables) or inlines it
+   * (schemas).
+   */
+  readonly componentName?: (context: ComponentNameContext) => string | undefined;
+  /** Prefix of generated `x-` fields. Defaults to `x-better-supabase-`. */
+  readonly extensionPrefix?: string;
+  /** Example rows per table (app-cased), set as the Row schema's `examples`. */
+  readonly examples?: Readonly<Record<string, readonly JsonObject[]>>;
+  readonly enrich?: EnrichHooks;
+  /** Resolves permission references to keys (`key()`) and `permissions: true`. */
+  readonly authorizer?: Authorizer<Ref>;
+  /** Report `permission-missing` for writes that declare no permission. */
+  readonly requirePermissions?: boolean;
+  /** `keys`: each permission key is also an OAuth scope of the `oauth2` preset. */
+  readonly permissionScopes?: "keys";
+  /** Security Profile Requirements (preview; only `3.3-preview` renders them). */
+  readonly securityProfileRequirements?: Readonly<Record<string, ModelSecurityProfileRequirement>>;
+  /** The Realtime websocket URL, for AsyncAPI. */
+  readonly realtimeUrl?: string;
+  readonly channels?: readonly ModelChannel[];
+  readonly messages?: Readonly<Record<string, ModelMessage>>;
+  /** Realtime tables, topics and CloudEvents, as channels and messages. */
+  readonly events?: EventsOptions<Ref>;
+  readonly webhooks?: readonly ModelWebhook[];
+  /**
+   * Workflows, or functions that build them from the operations (the Arazzo
+   * built-ins).
+   */
+  readonly workflows?: readonly (ModelWorkflow | WorkflowSource)[];
+  /** Tables with a JSON column typed in `better-supabase.config.ts`. */
+  readonly json?: Readonly<Record<string, unknown>>;
+}
+/** Builds workflows from the model's operations, after enrich hooks ran on them. */
+type WorkflowSource = (operations: readonly ModelOperation[]) => readonly ModelWorkflow[];
+interface BuiltModel {
+  readonly model: ApiModel;
+  /** Findings while building: permissions, components, schemas, plugins. */
+  readonly diagnostics: readonly SpecDiagnostic[];
+}
+//#endregion
+export { DataApiOptions as _, EnrichHooks as a, PROBLEM_SCHEMA as b, RouteSpec as c, BlockEventSchemas as d, CLOUD_EVENT_TRAIT as f, topicsFrom as g, TopicInput as h, ComponentNameContext as i, WorkflowSource as l, EventsOptions as m, ApiSource as n, OperationIdContext as o, CloudEventsInput as p, BuiltModel as r, ResourceInput as s, ApiOptions as t, BlockEventSchema as u, CustomSecurity as v, SecurityPreset as x, DEFAULT_ERRORS as y };

package/dist/options-DrSkIBCD.js

@@ -0,0 +1,9 @@
+import { n as blockOptions, r as option } from "./options-BMjcVuaI.js";
+//#region src/blocks/comments/options.ts
+const commentsSqlOptions = blockOptions({
+	follow: option.boolean({ default: true }),
+	mentionGroups: option.unknown(),
+	notify: option.boolean({ default: true })
+});
+//#endregion
+export { commentsSqlOptions as t };

package/dist/options-DujalSfR.js

@@ -0,0 +1,10 @@
+import { n as blockOptions, r as option } from "./options-BMjcVuaI.js";
+//#region src/blocks/engagements/options.ts
+const engagementsSqlOptions = blockOptions({
+	types: option.strings(),
+	extraColumns: option.unknown(),
+	recordings: option.boolean({ default: false }),
+	bookings: option.boolean()
+});
+//#endregion
+export { engagementsSqlOptions as t };

package/dist/options-Dz3hJxUw.d.ts

@@ -0,0 +1,10 @@
+import { t as BlockOptionsSchema } from "./options-289GJc2l.js";
+//#region src/blocks/courses/options.d.ts
+/** `blocks.courses.options`. */
+type CoursesSqlOptions = {
+  /** Extra columns on the courses table: column name to SQL type. */
+  readonly extraColumns?: unknown;
+};
+declare const coursesSqlOptions: BlockOptionsSchema<CoursesSqlOptions>;
+//#endregion
+export { coursesSqlOptions as n, CoursesSqlOptions as t };

package/dist/options-E7KcmHQv.js

@@ -0,0 +1,8 @@
+import { n as blockOptions, r as option } from "./options-BMjcVuaI.js";
+//#region src/blocks/contracts/options.ts
+const contractsSqlOptions = blockOptions({
+	reminderDays: option.number({ default: 14 }),
+	extraColumns: option.unknown()
+});
+//#endregion
+export { contractsSqlOptions as t };

package/dist/options-IHPg8ZoA.js

@@ -0,0 +1,5 @@
+import { n as blockOptions, r as option } from "./options-BMjcVuaI.js";
+//#region src/blocks/shipments/options.ts
+const shipmentsSqlOptions = blockOptions({ extraColumns: option.unknown() });
+//#endregion
+export { shipmentsSqlOptions as t };

package/dist/options-MQfTGMgP.d.ts

@@ -0,0 +1,14 @@
+import { t as BlockOptionsSchema } from "./options-289GJc2l.js";
+//#region src/blocks/dispatch/options.d.ts
+/** `blocks.dispatch.options`. */
+type DispatchSqlOptions = {
+  /** Extra columns on the work orders table, as `extraColumns` elsewhere. */
+  readonly extraColumns?: unknown;
+  /** The IANA zone a work order's `day` and the board's days are in. */
+  readonly timeZone?: string;
+  /** A slot's length when only its start is given, as a Postgres interval. */
+  readonly defaultDuration?: string;
+};
+declare const dispatchSqlOptions: BlockOptionsSchema<DispatchSqlOptions>;
+//#endregion
+export { dispatchSqlOptions as n, DispatchSqlOptions as t };

package/dist/options-OMAUVcKK.d.ts

@@ -0,0 +1,10 @@
+import { t as BlockOptionsSchema } from "./options-289GJc2l.js";
+//#region src/blocks/segments/options.d.ts
+/** `blocks.segments.options`. */
+type SegmentsSqlOptions = {
+  /** At most this many records in one segment. Default: 10000. */
+  readonly maxMembers?: number;
+};
+declare const segmentsSqlOptions: BlockOptionsSchema<SegmentsSqlOptions>;
+//#endregion
+export { segmentsSqlOptions as n, SegmentsSqlOptions as t };

package/dist/options-a-28mlYT.js

@@ -0,0 +1,9 @@
+import { n as blockOptions, r as option } from "./options-BMjcVuaI.js";
+//#region src/blocks/access/options.ts
+const accessSqlOptions = blockOptions({
+	platformRoleScope: option.string({ default: "platform" }),
+	scope: option.string({ default: "organization" }),
+	tenantRoleScope: option.string({ default: "tenant" })
+});
+//#endregion
+export { accessSqlOptions as t };

package/dist/options-o2kfYU2x.js

@@ -0,0 +1,8 @@
+import { n as blockOptions, r as option } from "./options-BMjcVuaI.js";
+//#region src/blocks/bookings/options.ts
+const bookingsSqlOptions = blockOptions({
+	extraColumns: option.unknown(),
+	recurring: option.boolean({ default: false })
+});
+//#endregion
+export { bookingsSqlOptions as t };

package/dist/options-t_O5ldT6.js

@@ -0,0 +1,5 @@
+import { n as blockOptions, r as option } from "./options-BMjcVuaI.js";
+//#region src/blocks/donations/options.ts
+const donationsSqlOptions = blockOptions({ extraColumns: option.unknown() });
+//#endregion
+export { donationsSqlOptions as t };

package/dist/options-te6d5-yz.d.ts

@@ -0,0 +1,19 @@
+import { t as BlockOptionsSchema } from "./options-289GJc2l.js";
+//#region src/blocks/passes/options.d.ts
+/** `blocks.passes.options`. */
+type PassesSqlOptions = {
+  /** How long before a booking starts its ticket admits, as a Postgres interval. */
+  readonly checkInOpens?: string;
+  /** How long a drop-in counts against a resource's capacity. */
+  readonly dropInLength?: string;
+  /**
+   * Lets a pass with a number of uses pay for bookings. Needs bookings. Off by
+   * default.
+   */
+  readonly credits?: boolean;
+  /** How long before a class a cancellation still refunds its credit. */
+  readonly creditRefundBefore?: string;
+};
+declare const passesSqlOptions: BlockOptionsSchema<PassesSqlOptions>;
+//#endregion
+export { passesSqlOptions as n, PassesSqlOptions as t };

package/dist/options-xD4_FRUq.js

@@ -0,0 +1,10 @@
+import { n as blockOptions, r as option } from "./options-BMjcVuaI.js";
+//#region src/blocks/passes/options.ts
+const passesSqlOptions = blockOptions({
+	checkInOpens: option.string({ default: "1 hour" }),
+	dropInLength: option.string({ default: "2 hours" }),
+	credits: option.boolean({ default: false }),
+	creditRefundBefore: option.string({ default: "12 hours" })
+});
+//#endregion
+export { passesSqlOptions as t };

package/dist/options-zkyhM3qi.js

@@ -0,0 +1,8 @@
+import { n as blockOptions, r as option } from "./options-BMjcVuaI.js";
+//#region src/blocks/mail-sync/options.ts
+const mailSyncSqlOptions = blockOptions({
+	engagementType: option.string(),
+	matchDomains: option.boolean()
+});
+//#endregion
+export { mailSyncSqlOptions as t };