better-supabase 0.8.0 → 0.10.0

package/dist/events-D1BOCll8.d.ts

@@ -1,551 +0,0 @@
-/// <reference lib="esnext.temporal" />
-import { b as DbError } from "./result-BchM1XZn.js";
-import { g as MutationKind, h as MutationIntent, v as Operation } from "./executor-Drzu3dBK.js";
-import { m as RequestContext } from "./plugin-CPK2HsbY.js";
-import { n as Logger } from "./logger-DWVYUmwi.js";
-//#region src/core/block-events.d.ts
-/** `support.*`: support sessions, where a platform admin views the app as a user. */
-interface SupportEventData {
-  /** Absent on `support.denied`. */
-  readonly sessionId?: string;
-  readonly adminId: string;
-  readonly targetUserId: string;
-  readonly reason?: string;
-  readonly readOnly?: boolean;
-  readonly expiresAt?: Temporal.Instant;
-  /** `support.denied`: which check refused it. */
-  readonly denial?: "authorize" | "permission" | "policy" | "store";
-  /** `support.ended`: who or what ended it. */
-  readonly endedBy?: "admin" | "expired" | "revoked";
-  /** The organization the session is scoped to, when it has one. */
-  readonly organizationId?: string | null;
-}
-/** `organization.*`: organizations and their members. */
-interface OrganizationEventData {
-  readonly organizationId: string;
-  /** The member the event is about. */
-  readonly userId?: string;
-  readonly role?: string;
-  readonly previousRole?: string;
-}
-/** `invitation.*`. The token is never part of the event. */
-interface InvitationEventData {
-  readonly invitationId: string;
-  /** Absent for a platform-scope invitation. */
-  readonly organizationId?: string;
-  readonly email?: string;
-  readonly role?: string;
-}
-/** `notification.*`. */
-interface NotificationEventData {
-  readonly notificationId: string;
-  readonly organizationId?: string | null;
-  readonly type: string;
-  readonly recipientIds?: readonly string[];
-  readonly channel?: string;
-  readonly error?: string;
-}
-/** `webhook.*`: outgoing webhooks. */
-interface WebhookEventData {
-  readonly endpointId: string;
-  readonly organizationId?: string;
-  /** `webhook.disabled`: when the endpoint started failing. */
-  readonly failingSince?: string;
-  readonly deliveryId?: string;
-  readonly eventType?: string;
-  /** The HTTP status of the attempt, when there was a response. */
-  readonly status?: number;
-  readonly attempt?: number;
-  readonly error?: string;
-}
-/** `billing.*`: Stripe customers, checkouts, subscriptions and seats. */
-interface BillingEventData {
-  readonly organizationId: string;
-  readonly customerId?: string;
-  readonly subscriptionId?: string;
-  /** The Stripe subscription status. */
-  readonly status?: string;
-  /** `billing.seats_synced`: the new and the previous quantity. */
-  readonly quantity?: number;
-  readonly previousQuantity?: number;
-  /** The Stripe event that caused it. */
-  readonly stripeEventId?: string;
-}
-/** `comment.*`, written to the outbox by the comments module. */
-interface CommentEventData {
-  readonly commentId: string;
-  readonly organizationId: string;
-  readonly subjectType: string;
-  readonly subjectId: string;
-  readonly authorId?: string;
-  readonly parentId?: string;
-  /** `comment.created`: every mention; `comment.mentioned`: the new ones. */
-  readonly mentionIds?: readonly string[];
-}
-/** `attachment.*`, written to the outbox by the attachments module. */
-interface AttachmentEventData {
-  readonly attachmentId: string;
-  readonly organizationId: string;
-  readonly uploadedBy?: string;
-  readonly subjectType?: string;
-  readonly subjectId?: string;
-  readonly mimeType?: string;
-  readonly size?: number;
-  /** `attachment.scanned`: `clean`, `infected` or `failed`. */
-  readonly status?: string;
-}
-/** `data_export.*`, written to the outbox by the data-lifecycle module. */
-interface DataExportEventData {
-  readonly exportId: string;
-  readonly subject: "user" | "organization";
-  readonly organizationId?: string;
-  readonly userId?: string;
-  readonly requestedBy?: string;
-  /** `data_export.completed`: the object paths and when they stop being served. */
-  readonly files?: readonly string[];
-  readonly expiresAt?: string;
-  /** `data_export.failed`. */
-  readonly error?: string;
-}
-/** `organization.deletion_*` and `organization.purged`, from the data-lifecycle module. */
-interface OrganizationDeletionEventData {
-  readonly organizationId: string;
-  /** Who requested or cancelled; absent for the purge. */
-  readonly userId?: string;
-  readonly purgeAfter?: string;
-}
-/** `organization.domain_*`, from the sso module. */
-interface OrganizationDomainEventData {
-  readonly organizationId: string;
-  readonly domainId?: string;
-  readonly domain: string;
-  /** The member who verified it, when the app passed one. */
-  readonly userId?: string | null;
-}
-/** `waitlist.*`, from the waitlist module. */
-interface WaitlistEventData {
-  readonly entryId: string;
-  readonly email: string;
-}
-/** `invite_code.*`, from the waitlist module. The code itself is never part of the event. */
-interface InviteCodeEventData {
-  readonly codeId: string;
-  readonly organizationId?: string | null;
-  readonly prefix: string;
-  readonly role?: string | null;
-}
-/** `sso_provider.*`, from the sso module. */
-interface SsoProviderEventData {
-  readonly organizationId: string;
-  readonly providerId: string;
-  readonly domains: readonly string[];
-  readonly userId?: string | null;
-}
-/** `scim_user.*` and `scim_group.*`, from the sso module. */
-interface ScimEventData {
-  readonly organizationId: string;
-  readonly scimUserId?: string;
-  readonly scimGroupId?: string;
-}
-/** `api_key.*`, from the api-keys module. The secret is never part of the event. */
-interface ApiKeyEventData {
-  readonly keyId: string;
-  readonly organizationId?: string | null;
-  readonly userId?: string | null;
-  readonly name: string;
-  readonly publicId: string;
-  /** `api_key.rotated`: the key it replaced. */
-  readonly previousKeyId?: string;
-}
-/** `organization_setting.*` and `platform_setting.*`, from the settings module. */
-interface SettingEventData {
-  readonly organizationId?: string;
-  readonly key: string;
-}
-/** `flag.*`, from the flags module. */
-interface FlagEventData {
-  readonly key: string;
-  /** `flag.override_set`: the variant, or `null` when the override was removed. */
-  readonly variant?: string | null;
-  readonly organizationId?: string | null;
-  readonly userId?: string | null;
-}
-/** `announcement.*`, from the announcements module. */
-interface AnnouncementEventData {
-  readonly announcementId: string;
-}
-/** `credential.*`, from the credentials module. The secret is never part of the event. */
-interface CredentialEventData {
-  readonly provider: string;
-  readonly name: string;
-}
-/** `connector.*` and `connector_grant.*`, from the connectors module. */
-interface ConnectorEventData {
-  readonly organizationId: string;
-  readonly serverId: string;
-  readonly name?: string;
-  /** `connector.fingerprint_decided`. */
-  readonly fingerprint?: string;
-  readonly approved?: boolean;
-  /** `connector_grant.*`. */
-  readonly grantId?: string;
-  readonly userId?: string;
-}
-/** `agent.*`, from the agents module. */
-interface AgentEventData {
-  readonly organizationId: string;
-  readonly agentId: string;
-  readonly slug?: string;
-  readonly visibility?: string;
-  /** `agent.installed` and `agent.uninstalled`: the member. */
-  readonly userId?: string;
-}
-/** `ai_provider_key.*`, from the ai-providers module. Only the credential reference is stored. */
-interface AiProviderKeyEventData {
-  readonly organizationId: string;
-  readonly keyId: string;
-  readonly provider: string;
-  readonly name: string;
-}
-/** `ai_tool_policy.set` and `ai_tool_approval.decided`, from the ai-chat module. */
-interface AiToolEventData {
-  readonly organizationId: string;
-  readonly tool: string;
-  readonly policy?: string | null;
-  readonly chatId?: string;
-  readonly approvalId?: string;
-  readonly decision?: string;
-}
-/** `incoming_webhook.*`, from the webhooks-in module. Secrets are never part of the event. */
-interface IncomingWebhookEventData {
-  readonly organizationId: string;
-  readonly endpointId: string;
-  readonly name?: string;
-  readonly verify?: string;
-  readonly enabled?: boolean;
-  /** `incoming_webhook.token_rotated`: whether the secret changed too. */
-  readonly secretRotated?: boolean;
-}
-/** `inbox_conversation.*` and `inbox_message.received`, from the inbox module. */
-interface InboxEventData {
-  readonly conversationId: string;
-  readonly organizationId: string;
-  readonly inboxId: string;
-  readonly contactId?: string | null;
-  readonly assigneeId?: string | null;
-  readonly previousAssigneeId?: string | null;
-  readonly status?: string;
-  /** `inbox_message.received`. */
-  readonly messageId?: string;
-}
-/** `push.*`, from the push module. */
-interface PushDeviceEventData {
-  readonly deviceId: string;
-  readonly userId: string;
-  readonly platform?: string;
-  readonly provider?: string;
-}
-/** `workflow_run.*`, from the workflows module. */
-interface WorkflowRunEventData {
-  readonly runId: string;
-  readonly organizationId?: string | null;
-  readonly engine: string;
-  readonly externalId?: string | null;
-  readonly definition?: string | null;
-  readonly status: string;
-  readonly error?: string | null;
-}
-/** `workflow.published` and `workflow_alert.triggered`, from the workflow-builder module. */
-interface WorkflowEventData {
-  readonly organizationId?: string | null;
-  readonly definitionId?: string;
-  readonly versionId?: string;
-  readonly version?: number;
-  /** `workflow_alert.triggered`. */
-  readonly alertId?: string;
-  readonly definition?: string;
-  readonly onEvent?: string;
-  readonly channel?: string;
-  readonly runId?: string;
-  readonly status?: string;
-  readonly error?: string | null;
-}
-/** `object.uploaded`, from the attachments module: a Storage object in a scanned bucket. */
-interface StorageObjectEventData {
-  readonly bucket: string;
-  readonly path: string;
-}
-/** `audit.revealed`, from the audit module: who looked at restricted details. */
-interface AuditRevealEventData {
-  readonly organizationId?: string | null;
-  readonly entries: readonly string[];
-}
-/** `ai_chat.*` and `ai_chat_message.completed`, written to the outbox by the ai-chat module. */
-interface AiChatEventData {
-  readonly chatId: string;
-  readonly organizationId: string;
-  readonly ownerId: string;
-  /** `ai_chat_message.completed`: the saved answer. */
-  readonly messageId?: string;
-  readonly model?: string;
-  /** `complete`, `aborted` or `error`. */
-  readonly status?: string;
-  /** `ai_chat.shared`: the share link and the message it ends at. */
-  readonly shareId?: string;
-  readonly leafId?: string;
-}
-/** Every block event type and its data. */
-interface BlockEventMap {
-  "support.started": SupportEventData;
-  "support.ended": SupportEventData;
-  "support.denied": SupportEventData;
-  "organization.created": OrganizationEventData;
-  "organization.updated": OrganizationEventData;
-  "organization.deleted": OrganizationEventData;
-  "organization.member_added": OrganizationEventData;
-  "organization.member_removed": OrganizationEventData;
-  "organization.member_left": OrganizationEventData;
-  "organization.member_suspended": OrganizationEventData;
-  "organization.member_resumed": OrganizationEventData;
-  "organization.role_changed": OrganizationEventData;
-  "organization.ownership_transferred": OrganizationEventData;
-  "organization.switched": OrganizationEventData;
-  "organization.domain_added": OrganizationDomainEventData;
-  "organization.domain_updated": OrganizationDomainEventData;
-  "organization.domain_verified": OrganizationDomainEventData;
-  "organization.domain_removed": OrganizationDomainEventData;
-  "sso_provider.registered": SsoProviderEventData;
-  "sso_provider.unregistered": SsoProviderEventData;
-  "scim_user.saved": ScimEventData;
-  "scim_user.deleted": ScimEventData;
-  "scim_group.saved": ScimEventData;
-  "scim_group.deleted": ScimEventData;
-  "waitlist.approved": WaitlistEventData;
-  "waitlist.rejected": WaitlistEventData;
-  "invite_code.created": InviteCodeEventData;
-  "invite_code.revoked": InviteCodeEventData;
-  "api_key.created": ApiKeyEventData;
-  "api_key.revoked": ApiKeyEventData;
-  "api_key.rotated": ApiKeyEventData;
-  "organization_setting.updated": SettingEventData;
-  "organization_setting.reset": SettingEventData;
-  "platform_setting.updated": SettingEventData;
-  "platform_setting.reset": SettingEventData;
-  "flag.saved": FlagEventData;
-  "flag.deleted": FlagEventData;
-  "flag.override_set": FlagEventData;
-  "announcement.saved": AnnouncementEventData;
-  "announcement.deleted": AnnouncementEventData;
-  "credential.set": CredentialEventData;
-  "credential.deleted": CredentialEventData;
-  "connector.saved": ConnectorEventData;
-  "connector.deleted": ConnectorEventData;
-  "connector.fingerprint_decided": ConnectorEventData;
-  "connector_grant.created": ConnectorEventData;
-  "connector_grant.revoked": ConnectorEventData;
-  "agent.saved": AgentEventData;
-  "agent.published": AgentEventData;
-  "agent.deleted": AgentEventData;
-  "agent.installed": AgentEventData;
-  "agent.uninstalled": AgentEventData;
-  "ai_provider_key.saved": AiProviderKeyEventData;
-  "ai_provider_key.deleted": AiProviderKeyEventData;
-  "ai_tool_policy.set": AiToolEventData;
-  "ai_tool_approval.decided": AiToolEventData;
-  "incoming_webhook.created": IncomingWebhookEventData;
-  "incoming_webhook.updated": IncomingWebhookEventData;
-  "incoming_webhook.enabled_set": IncomingWebhookEventData;
-  "incoming_webhook.token_rotated": IncomingWebhookEventData;
-  "incoming_webhook.secret_rotated": IncomingWebhookEventData;
-  "incoming_webhook.deleted": IncomingWebhookEventData;
-  "inbox_conversation.opened": InboxEventData;
-  "inbox_conversation.assigned": InboxEventData;
-  "inbox_conversation.resolved": InboxEventData;
-  "inbox_conversation.reopened": InboxEventData;
-  "inbox_message.received": InboxEventData;
-  "push.device_registered": PushDeviceEventData;
-  "push.device_unregistered": PushDeviceEventData;
-  "workflow_run.completed": WorkflowRunEventData;
-  "workflow_run.failed": WorkflowRunEventData;
-  "workflow_run.cancelled": WorkflowRunEventData;
-  "workflow.published": WorkflowEventData;
-  "workflow_alert.triggered": WorkflowEventData;
-  "audit.revealed": AuditRevealEventData;
-  "object.uploaded": StorageObjectEventData;
-  "invitation.created": InvitationEventData;
-  "invitation.resent": InvitationEventData;
-  "invitation.updated": InvitationEventData;
-  "invitation.accepted": InvitationEventData;
-  "invitation.declined": InvitationEventData;
-  "invitation.revoked": InvitationEventData;
-  "notification.created": NotificationEventData;
-  "notification.delivered": NotificationEventData;
-  "notification.failed": NotificationEventData;
-  "webhook.delivered": WebhookEventData;
-  "webhook.failed": WebhookEventData;
-  "webhook.disabled": WebhookEventData;
-  "webhook.secret_rotated": WebhookEventData;
-  "billing.customer_linked": BillingEventData;
-  "billing.checkout_completed": BillingEventData;
-  "billing.subscription_created": BillingEventData;
-  "billing.subscription_updated": BillingEventData;
-  "billing.subscription_deleted": BillingEventData;
-  "billing.seats_synced": BillingEventData;
-  "comment.created": CommentEventData;
-  "comment.mentioned": CommentEventData;
-  "comment.deleted": CommentEventData;
-  "attachment.uploaded": AttachmentEventData;
-  "attachment.scanned": AttachmentEventData;
-  "data_export.requested": DataExportEventData;
-  "data_export.completed": DataExportEventData;
-  "data_export.failed": DataExportEventData;
-  "organization.deletion_requested": OrganizationDeletionEventData;
-  "organization.deletion_cancelled": OrganizationDeletionEventData;
-  "organization.purged": OrganizationDeletionEventData;
-  "ai_chat_message.completed": AiChatEventData;
-  "ai_chat.shared": AiChatEventData;
-  "ai_chat.share_revoked": AiChatEventData;
-}
-type BlockEventType = keyof BlockEventMap;
-/**
- * Event types that changed name in 0.6, old to new, for sinks and consumers
- * that still receive the old ones (`BLOCK_EVENT_RENAMES[type] ?? type`).
- * `better-supabase codemod 0.6` rewrites the string literals.
- */
-declare const BLOCK_EVENT_RENAMES: Readonly<Record<string, BlockEventType>>;
-/** Where an event came from, beyond its data. */
-interface BlockEventMeta {
-  /** e.g. `organizations/<id>`; becomes the CloudEvents `subject`. */
-  readonly subject?: string;
-  readonly tenant?: string;
-  /** The user who caused it. */
-  readonly actorId?: string;
-  readonly context?: RequestContext;
-}
-/** A block event as `betterSupabase.on('block', handler)` receives it. */
-type BlockEvent<K extends BlockEventType = BlockEventType> = { readonly [T in K]: BlockEventMeta & {
-  readonly type: T;
-  /** A copy: changing it never changes what the block does (invariant 5). */
-  readonly data: BlockEventMap[T];
-  readonly time: Temporal.Instant;
-}; }[K];
-/** A type, or a `prefix.*` pattern such as `support.*`. */
-type BlockEventPattern = BlockEventType | `${BlockEventType extends `${infer P}.${string}` ? P : never}.*`;
-/** The event types a pattern matches. */
-type BlockEventsMatching<P extends BlockEventPattern> = P extends `${infer Prefix}.*` ? Extract<BlockEventType, `${Prefix}.${string}`> : Extract<P, BlockEventType>;
-/**
- * Fixed OpenTelemetry attribute names for block work, so dashboards and
- * queries can rely on them.
- */
-declare const BLOCK_ATTRIBUTES: {
-  readonly event: "better_supabase.block.event";
-  readonly tenant: "better_supabase.tenant";
-  readonly actor: "better_supabase.actor.id";
-  readonly supportSessionId: "better_supabase.support.session_id";
-  readonly organizationId: "better_supabase.organization.id";
-  readonly invitationId: "better_supabase.invitation.id";
-  readonly notificationType: "better_supabase.notification.type";
-  readonly webhookEndpointId: "better_supabase.webhook.endpoint_id";
-};
-/** The `BLOCK_ATTRIBUTES` an event carries. */
-declare function blockEventAttributes(event: BlockEvent): Record<string, string>;
-/**
- * Listens to the block events that match `pattern` (`'support.started'` or
- * `'support.*'`). Returns a function that stops listening.
- */
-declare function onBlockEvent<P extends BlockEventPattern>(betterSupabase: {
-  readonly events: EventHub;
-}, pattern: P, handler: (event: BlockEvent<BlockEventsMatching<P>>) => void): () => void;
-//#endregion
-//#region src/core/events.d.ts
-interface QueryEvent {
-  readonly table: string;
-  readonly operation: Operation["kind"];
-  readonly ok: boolean;
-  readonly durationMs: number;
-  readonly rows: number;
-  /**
-   * An unbounded read returned `maxRows` rows: PostgREST's `db-max-rows`
-   * probably cut it short. Add `limit` or use `paginate`.
-   */
-  readonly truncated: boolean;
-}
-interface MutationNotice {
-  readonly table: string;
-  readonly kind: MutationKind;
-  /** See `MutationEvent.intent`. */
-  readonly intent?: MutationIntent;
-  /** A copy of the returned rows: changing it never changes the result. */
-  readonly rows: readonly Readonly<Record<string, unknown>>[];
-  /** See `MutationEvent.keys`. */
-  readonly keys?: readonly Readonly<Record<string, unknown>>[];
-  /** See `MutationEvent.tenant`. */
-  readonly tenant?: string;
-  readonly context: RequestContext;
-}
-/** A successful RPC registered with `betterSupabase.defineRpc(name, { invalidates })`. */
-interface RpcNotice {
-  readonly name: string;
-  /** App keys of the tables the function changes. */
-  readonly invalidates: readonly string[];
-  readonly context: RequestContext;
-}
-interface ErrorEvent {
-  readonly table?: string;
-  readonly error: DbError;
-}
-interface AuthEvent {
-  readonly source: "bearer" | "cookie" | "none";
-  readonly ok: boolean;
-  readonly userId?: string;
-  /**
-   * Why there is no user: the anon reason (`expired`, `signed_out`, ...) or
-   * the invalid reason (`token`, `claims`, `actor`).
-   */
-  readonly reason?: "none" | "expired" | "signed_out" | "refresh_failed" | "token" | "claims" | "actor";
-  /** The user's `source` as the resolver set it, e.g. a custom resolver's name. */
-  readonly rawSource?: string;
-}
-interface RefreshEvent {
-  readonly ok: boolean;
-  readonly shared: boolean;
-  readonly durationMs: number;
-}
-interface BetterSupabaseEvents {
-  query: QueryEvent;
-  mutation: MutationNotice;
-  rpc: RpcNotice;
-  error: ErrorEvent;
-  auth: AuthEvent;
-  refresh: RefreshEvent;
-  /** Support sessions, organizations, invitations, notifications and webhooks. */
-  block: BlockEvent;
-}
-type EventName = keyof BetterSupabaseEvents;
-type EventHandler<K extends EventName> = (event: BetterSupabaseEvents[K]) => void;
-/**
- * Observers only: a handler that throws is reported to the logger and never
- * changes a result.
- */
-declare class EventHub {
-  #private;
-  readonly logger: Logger;
-  /** The definition's `now` option; block events take their `time` from it. */
-  readonly now: (() => Temporal.Instant) | undefined;
-  constructor(logger?: Logger, now?: () => Temporal.Instant);
-  on<K extends EventName>(name: K, handler: EventHandler<K>): () => void;
-  has(name: EventName): boolean;
-  /**
-   * Keeps async work a handler started (a sink send) until it settles, so
-   * adapters can hand it to `after()` or `waitUntil`. Its outcome is ignored:
-   * handlers report their own failures.
-   */
-  track(work: PromiseLike<unknown>): void;
-  /** Whether tracked work is still running. */
-  get pending(): boolean;
-  /** Resolves once the work tracked so far has settled. Never rejects. */
-  settled(): Promise<void>;
-  emit<K extends EventName>(name: K, event: BetterSupabaseEvents[K]): void;
-}
-//#endregion
-export { CredentialEventData as A, OrganizationEventData as B, BlockEventMap as C, BlockEventsMatching as D, BlockEventType as E, InvitationEventData as F, StorageObjectEventData as G, ScimEventData as H, InviteCodeEventData as I, WebhookEventData as J, SupportEventData as K, NotificationEventData as L, FlagEventData as M, InboxEventData as N, CommentEventData as O, IncomingWebhookEventData as P, onBlockEvent as Q, OrganizationDeletionEventData as R, BlockEvent as S, BlockEventPattern as T, SettingEventData as U, PushDeviceEventData as V, SsoProviderEventData as W, WorkflowRunEventData as X, WorkflowEventData as Y, blockEventAttributes as Z, AttachmentEventData as _, EventHub as a, BLOCK_EVENT_RENAMES as b, QueryEvent as c, AgentEventData as d, AiChatEventData as f, ApiKeyEventData as g, AnnouncementEventData as h, EventHandler as i, DataExportEventData as j, ConnectorEventData as k, RefreshEvent as l, AiToolEventData as m, BetterSupabaseEvents as n, EventName as o, AiProviderKeyEventData as p, WaitlistEventData as q, ErrorEvent as r, MutationNotice as s, AuthEvent as t, RpcNotice as u, AuditRevealEventData as v, BlockEventMeta as w, BillingEventData as x, BLOCK_ATTRIBUTES as y, OrganizationDomainEventData as z };