better-supabase 0.8.0 → 0.9.0

package/dist/client-01MAuqzW.js

@@ -0,0 +1,137 @@
+import { n as dbError } from "./errors-8i6tSICm.js";
+import { r as err } from "./result-BlgnMB0H.js";
+import { n as isRecord, t as isList } from "./guards-6F2bCtQR.js";
+import { n as whileSignedIn, t as defineController } from "./controller-D6NyNrlZ.js";
+//#region src/blocks/settings/client.ts
+const isConverter = (value) => isRecord(value) && typeof value["input"] === "function";
+const jsonSchemaOf = (entry) => {
+	const standard = entry.schema["~standard"];
+	const converter = isRecord(standard) ? standard["jsonSchema"] : void 0;
+	if (!isConverter(converter)) return;
+	try {
+		const converted = converter.input({ target: "draft-2020-12" });
+		return isRecord(converted) ? converted : void 0;
+	} catch {
+		return;
+	}
+};
+const kindOfValue = (value) => typeof value === "boolean" ? "boolean" : typeof value === "number" ? "number" : typeof value === "string" ? "text" : "json";
+const text = (value) => typeof value === "string" ? value : void 0;
+function fieldOf(key, entry) {
+	const schema = jsonSchemaOf(entry);
+	const values = schema?.["enum"];
+	const choices = isList(values) ? values.filter((value) => typeof value === "string" || typeof value === "number") : [];
+	const type = schema?.["type"];
+	return {
+		key,
+		kind: choices.length > 0 ? "choice" : type === "boolean" ? "boolean" : type === "number" || type === "integer" ? "number" : type === "string" ? "text" : type === void 0 ? kindOfValue(entry.default) : "json",
+		choices,
+		title: text(schema?.["title"]),
+		description: text(schema?.["description"]),
+		default: entry.default
+	};
+}
+/**
+* The form fields of one scope of a settings definition, in declaration
+* order: `settingFields(settings.schemas.organization)`.
+*/
+function settingFields(entries) {
+	const fields = [];
+	for (const key of Object.keys(entries)) {
+		const entry = entries[key];
+		if (!entry) continue;
+		fields.push(fieldOf(key, entry));
+	}
+	return fields;
+}
+function storeOf(options) {
+	const { user, organization } = options;
+	if (user) return {
+		get: () => user.getUser(),
+		set: (key, value) => user.setUser(key, value),
+		reset: (key) => user.resetUser(key)
+	};
+	if (!organization) throw new TypeError("better-supabase: createSettingsController needs `user` or `organization`");
+	const organizationId = options.organizationId ?? null;
+	if (organizationId === null) return;
+	return {
+		get: () => organization.getOrganization(organizationId),
+		set: (key, value) => organization.setOrganization(organizationId, key, value),
+		reset: (key) => organization.resetOrganization(organizationId, key)
+	};
+}
+/**
+* One scope of the app's settings for a settings page: the form fields
+* generated from the definition, the stored values over the defaults, and
+* `set` and `reset` per key.
+*/
+function createSettingsController(options) {
+	const store = storeOf(options);
+	return defineController({
+		fields: settingFields(options.entries),
+		values: void 0,
+		saving: void 0,
+		error: void 0
+	}, (state) => {
+		const refresh = async () => {
+			if (!store) return;
+			const run = state.run();
+			const result = await store.get();
+			if (run !== state.run()) return;
+			state.set(result.ok ? {
+				values: result.data,
+				error: void 0
+			} : { error: result.error });
+		};
+		const waiting = () => err(dbError("invalid_input", "No organization to save the setting for"));
+		const set = async (key, value) => {
+			if (!store) return waiting();
+			state.set({
+				saving: key,
+				error: void 0
+			});
+			const result = await store.set(key, value);
+			if (!result.ok) {
+				state.set({
+					saving: void 0,
+					error: result.error
+				});
+				return result;
+			}
+			state.set((current) => ({
+				saving: void 0,
+				...current.values === void 0 ? {} : { values: {
+					...current.values,
+					[key]: result.data
+				} }
+			}));
+			return result;
+		};
+		return {
+			actions: {
+				refresh,
+				set,
+				setField: (key, value) => set(key, value),
+				reset: async (key) => {
+					if (!store) return waiting();
+					state.set({
+						saving: key,
+						error: void 0
+					});
+					const result = await store.reset(key);
+					state.set(result.ok ? { saving: void 0 } : {
+						saving: void 0,
+						error: result.error
+					});
+					if (result.ok) await refresh();
+					return result;
+				}
+			},
+			start: () => store ? whileSignedIn(options.auth, () => {
+				refresh();
+			}) : void 0
+		};
+	});
+}
+//#endregion
+export { settingFields as n, createSettingsController as t };

package/dist/client-B7QVIrJS.d.ts

@@ -0,0 +1,263 @@
+/// <reference lib="esnext.temporal" />
+import { b as DbError, f as Result, t as AsyncResult, w as ErrorMapper } from "./result-Cj3yWhjH.js";
+import { a as AnyModels, i as AnyFunctions, z as TableKey } from "./types-YfwpIE-d.js";
+import { n as Logger } from "./logger-DWVYUmwi.js";
+import { t as StandardSchemaV1 } from "./standard-C3_AAF3g.js";
+import { t as BlockTransport } from "./block-transport-DaGGXjIw.js";
+import { i as CursorPageOptions, r as BlockTemporalOptions } from "./block-helpers-C86hPEjI.js";
+import { n as BlockHooks } from "./block-hooks-BLPWD3Jt.js";
+import { n as ExtraFields, r as FieldsOf } from "./block-fields-5UA84ZUg.js";
+import { i as EventSink, t as CloudEvent } from "./cloud-event-5rCEzIgK.js";
+import { t as BetterSupabase } from "./define-DxHHbNEb.js";
+import { p as SubscriptionStatus } from "./topic-cMS7UtM1.js";
+import { n as TopicPort } from "./watch-topic-EFpOIIDE.js";
+import { i as ListDefinition } from "./list-query-PvP3pPGQ.js";
+import { n as Controller, t as AuthPort } from "./controller-D845qKh2.js";
+//#region src/blocks/comments/comments.d.ts
+interface CommentsOptions<S extends StandardSchemaV1 | undefined = undefined> extends BlockTemporalOptions {
+  /**
+   * A Standard Schema for the comment's extra columns
+   * (`blocks.comments.options.extraColumns`), keyed by database name. It
+   * types and parses them on reads, and validates them on `create` and
+   * `edit`.
+   */
+  readonly fields?: S;
+  /** `withBlockHooks` hooks around the client's methods. */
+  readonly hooks?: NoInfer<BlockHooks<Comments<FieldsOf<S>>>>;
+  /** Receives the errors `after` hooks throw. Default: `console`. */
+  readonly logger?: Logger;
+  readonly transport: BlockTransport;
+  /** The module schema, or its API schema: `defineBlocks` passes it from `blocks.generated.ts`. Default `better_supabase`. */
+  readonly schema?: string;
+  readonly mappers?: readonly ErrorMapper[];
+  /**
+   * The user ids a comment mentions when the call passes no `mentions`,
+   * such as the mention nodes of a rich-text `document`. Default
+   * `mentionsIn(body)`.
+   */
+  readonly mentionsOf?: (comment: {
+    readonly body: string;
+    readonly document: unknown;
+  }) => readonly string[];
+}
+/** A comment. `F` types the extra columns the `fields` schema describes. */
+interface Comment<F extends object = Record<never, never>> {
+  readonly id: string;
+  readonly organizationId: string;
+  readonly subjectType: string;
+  readonly subjectId: string;
+  /** `undefined` once the author's account is deleted. */
+  readonly authorId: string | undefined;
+  /** Empty for a deleted comment. */
+  readonly body: string;
+  /** The rich-text document an editor wrote, next to `body` as its plain text. */
+  readonly document: unknown;
+  readonly mentions: readonly string[];
+  readonly parentId: string | undefined;
+  readonly createdAt: Temporal.Instant;
+  readonly editedAt: Temporal.Instant | undefined;
+  readonly deletedAt: Temporal.Instant | undefined;
+  /** The extra columns, keyed by database name. */
+  readonly fields: ExtraFields<F>;
+}
+interface NewComment<F extends object = Record<never, never>> {
+  readonly organizationId: string;
+  readonly subjectType: string;
+  readonly subjectId: string;
+  readonly body: string;
+  /** A rich-text document (any JSON); keep `body` as its plain text. */
+  readonly document?: unknown;
+  /** User ids; default `mentionsOf`, or the ids `mentionsIn(body)` finds. */
+  readonly mentions?: readonly string[];
+  /** A reply: the parent must be on the same subject. */
+  readonly parentId?: string;
+  /** The extra columns to set, keyed by database name. */
+  readonly fields?: Partial<F>;
+}
+interface CommentEdit<F extends object = Record<never, never>> {
+  readonly body: string;
+  /** A new document; `null` removes it, and leaving it out keeps the current one. */
+  readonly document?: unknown;
+  /** Default `mentionsOf`, or the ids `mentionsIn(body)` finds. */
+  readonly mentions?: readonly string[];
+  /** The extra columns to set, keyed by database name; others keep their value. */
+  readonly fields?: Partial<F>;
+}
+/**
+ * Where a timeline entry comes from: `event` for an `activity_entries` row
+ * that `activitySink()` wrote, `audit` for an audit log entry on the
+ * subject's row (with the `audit` and `subjects` modules), `delivery` for a
+ * notification delivery about the subject (with `notifications`) and `run`
+ * for a workflow run on it (with `workflows`).
+ */
+type ActivitySource = "event" | "audit" | "delivery" | "run";
+interface ActivityEntry {
+  /** An `activity_entries` id, or the audit entry's, delivery's or run's id. */
+  readonly id: string;
+  readonly source: ActivitySource;
+  readonly organizationId: string;
+  readonly type: string;
+  readonly actorId: string | undefined;
+  readonly subjectType: string | undefined;
+  readonly subjectId: string | undefined;
+  readonly summary: string | undefined;
+  readonly data: Readonly<Record<string, unknown>>;
+  readonly occurredAt: Temporal.Instant;
+}
+interface ActivityHistoryOptions extends CursorPageOptions<Temporal.Instant> {
+  /** Entries before this instant, for paging back. */
+  readonly cursor?: Temporal.Instant;
+  /** Default 50, at most 500. */
+  readonly limit?: number;
+  /** The kinds of entry to return; all of them when left out. */
+  readonly sources?: readonly ActivitySource[];
+}
+interface ListCommentsOptions extends CursorPageOptions<Temporal.Instant> {
+  /** Comments created after this instant, for polling a thread. */
+  readonly cursor?: Temporal.Instant;
+  /**
+   * The id of the last comment you have, next to `cursor`, so comments
+   * created in the same instant as it aren't skipped.
+   */
+  readonly cursorId?: string;
+  /** Default 100, at most 500. */
+  readonly limit?: number;
+  /** Comments to skip, for page-number paging. */
+  readonly offset?: number;
+}
+/** `F` is the extra fields `options.fields` describes. */
+interface Comments<F extends object = Record<never, never>> {
+  create(comment: NewComment<F>): AsyncResult<Comment<F>>;
+  /** Only the author edits; `not_found` when the caller can't see it. */
+  edit(id: string, edit: CommentEdit<F>): AsyncResult<Comment<F>>;
+  /** Soft-deletes (the author, or a member with `comments.moderate`). */
+  remove(id: string): AsyncResult<boolean>;
+  /** A subject's thread, oldest first, deleted comments as placeholders. */
+  list(organizationId: string, subjectType: string, subjectId: string, options?: ListCommentsOptions): AsyncResult<readonly Comment<F>[]>;
+  /**
+   * How many comments each subject has that the caller can read, deleted
+   * ones left out, such as for a counter on each row of a list. Subjects
+   * without comments are 0.
+   */
+  counts(organizationId: string, subjectType: string, subjectIds: readonly string[]): AsyncResult<Readonly<Record<string, number>>>;
+  /**
+   * Copies a subject's thread to another subject in the tenant, keeping
+   * authors, times and replies; returns how many comments it copied. Needs a
+   * service-role transport.
+   */
+  copy(organizationId: string, from: {
+    readonly type: string;
+    readonly id: string;
+  }, to: {
+    readonly type: string;
+    readonly id: string;
+  }): AsyncResult<number>;
+  /**
+   * The activity feed of a tenant, newest first, or one subject's timeline
+   * with `subject`. Members with `activity.read` see it. With the `subjects`
+   * module, an entry on a registered subject type needs `can_subject` read,
+   * and a subject's timeline also lists its audit log entries
+   * (`source: "audit"`) when `audit` is installed with its read policy, the
+   * deliveries of notifications about it (`source: "delivery"`, for members
+   * who also hold `notifications.send`) and its workflow runs
+   * (`source: "run"`, as the runs' read policy allows).
+   */
+  history(organizationId: string, subject?: {
+    readonly type: string;
+    readonly id: string;
+  }, options?: ActivityHistoryOptions): AsyncResult<readonly ActivityEntry[]>;
+}
+/**
+ * The user ids mentioned in a body written as `@[Ada](<user id>)`, the
+ * markup mention inputs produce, in order and without repeats.
+ */
+declare function mentionsIn(body: string): readonly string[];
+/** Comments over the `comments` module's functions, as the caller. */
+declare function createComments<S extends StandardSchemaV1 | undefined = undefined>(options: CommentsOptions<S>): Comments<FieldsOf<S>>;
+/** What an activity entry says about an event; `null` skips the event. */
+interface ActivityDescription {
+  readonly summary?: string;
+  readonly actorId?: string;
+  readonly subjectType?: string;
+  readonly subjectId?: string;
+  readonly data?: Readonly<Record<string, unknown>>;
+}
+interface ActivitySinkOptions {
+  /** A service-role transport: `record_activity()` is granted to `service_role` only. */
+  readonly transport: BlockTransport;
+  readonly schema?: string;
+  /** The outbox `typePrefix`, stripped from the stored type. Default `dev.better-supabase`. */
+  readonly typePrefix?: string;
+  /** Types to keep, exact or ending in `.*`. Default every event with a tenant. */
+  readonly types?: readonly string[];
+  /** Summarizes an event, or returns `null` to skip it. */
+  readonly describe?: (event: CloudEvent, type: string) => ActivityDescription | null | undefined;
+}
+/**
+ * An outbox sink that writes events into the activity feed:
+ * `outbox.relay('activity', activitySink({ transport }))`. Events without a
+ * tenant (`partitionkey`) are skipped, and a replayed event writes nothing.
+ */
+declare function activitySink(options: ActivitySinkOptions): EventSink;
+type ActivitySort = "newest" | "oldest";
+type ActivityFacet = "type" | "actor" | "subjectType" | "subjectId";
+/**
+ * A cursor-paged list over `activity_entries` (generate types for the
+ * `better_supabase` schema to get it in your models), newest first,
+ * filtered by type, actor and subject. Members with `activity.read` see
+ * their tenants' entries, less those on a registered subject that
+ * `can_subject` doesn't let them read (with the `subjects` module). It
+ * reads the table, so it lists no audit entries; `history()` does.
+ */
+declare function activityListQuery<M extends AnyModels, D, Fn extends AnyFunctions, E, T extends TableKey<M>>(betterSupabase: BetterSupabase<M, D, Fn, E>, table: T, options?: {
+  readonly pageSize?: number;
+  readonly maxPageSize?: number;
+}): ListDefinition<M, T, E, ActivitySort, ActivityFacet>;
+//#endregion
+//#region src/blocks/comments/client.d.ts
+interface CommentsControllerOptions {
+  readonly client: Pick<Comments, "list" | "create" | "edit" | "remove">;
+  readonly auth: AuthPort;
+  readonly ports: {
+    readonly topic: TopicPort;
+  };
+  /** The organization; the thread waits without one. */
+  readonly organizationId: string | null;
+  readonly subjectType: string;
+  readonly subjectId: string;
+  /**
+   * A private topic that hears of new comments on the subject, such as a
+   * `realtime-tables` topic on the comments table. Each message loads the
+   * thread again. Default `null`: the thread loads again after its own
+   * writes only.
+   */
+  readonly topic?: string | null;
+  /** The most comments to load, default 100, at most 500. */
+  readonly limit?: number;
+}
+interface CommentsSnapshot {
+  /** The thread, oldest first, deleted comments as placeholders; `undefined` until the first load. */
+  readonly comments: readonly Comment[] | undefined;
+  readonly status: SubscriptionStatus;
+  readonly error: DbError | undefined;
+}
+/** A reply, a rich-text document or explicit mentions for `add`. */
+type CommentDraft = Pick<NewComment, "document" | "mentions" | "parentId">;
+interface CommentsActions {
+  /** Posts a comment on the subject; a failure is also kept in `error`. */
+  readonly add: (body: string, draft?: CommentDraft) => Promise<Result<Comment>>;
+  /** Edits one of the caller's comments. */
+  readonly edit: (id: string, edit: CommentEdit) => Promise<Result<Comment>>;
+  /** Soft-deletes a comment: it stays in the thread as a placeholder. */
+  readonly remove: (id: string) => Promise<Result<boolean>>;
+  readonly refresh: () => Promise<void>;
+}
+type CommentsController = Controller<CommentsSnapshot, CommentsActions>;
+/**
+ * One subject's comment thread for the signed-in user: loads it, keeps it
+ * current after `add`, `edit` and `remove`, and loads it again for each
+ * message on `topic`.
+ */
+declare function createCommentsController(options: CommentsControllerOptions): CommentsController;
+//#endregion
+export { mentionsIn as C, createComments as S, CommentsOptions as _, CommentsSnapshot as a, activityListQuery as b, ActivityEntry as c, ActivitySinkOptions as d, ActivitySort as f, Comments as g, CommentEdit as h, CommentsControllerOptions as i, ActivityFacet as l, Comment as m, CommentsActions as n, createCommentsController as o, ActivitySource as p, CommentsController as r, ActivityDescription as s, CommentDraft as t, ActivityHistoryOptions as u, ListCommentsOptions as v, activitySink as x, NewComment as y };

package/dist/client-B9CqzgPO.js

@@ -0,0 +1,75 @@
+import { n as whileSignedIn, t as defineController } from "./controller-D6NyNrlZ.js";
+//#region src/blocks/audit/client.ts
+function listOptions(organizationId, filters, limit, cursor) {
+	const { actorId, eventType, search } = filters;
+	return {
+		organizationId,
+		order: "desc",
+		...actorId ? { actorId } : {},
+		...eventType ? { eventType } : {},
+		...search?.trim() ? { search: search.trim() } : {},
+		...limit === void 0 ? {} : { limit },
+		...cursor === void 0 ? {} : { cursor }
+	};
+}
+/**
+* One organization's audit trail for an audit table: the newest page as
+* the caller may read it, `setFilters` to narrow it by actor, action or
+* text, and `loadMore` for older pages.
+*/
+function createAuditLogController(options) {
+	const { client, organizationId, limit } = options;
+	return defineController({
+		entries: void 0,
+		filters: options.filters ?? {},
+		loading: false,
+		hasMore: false,
+		error: void 0
+	}, (state) => {
+		let ticket = 0;
+		let next;
+		const load = async (more) => {
+			if (organizationId === null) return;
+			if (more && next === void 0) return;
+			const request = ++ticket;
+			state.set({ loading: true });
+			const result = await client.list(listOptions(organizationId, state.get().filters, limit, more ? next : void 0));
+			if (request !== ticket) return;
+			if (!result.ok) {
+				state.set({
+					loading: false,
+					error: result.error
+				});
+				return;
+			}
+			next = result.data.next;
+			state.set((current) => ({
+				loading: false,
+				error: void 0,
+				hasMore: next !== void 0,
+				entries: more ? [...current.entries ?? [], ...result.data.entries] : result.data.entries
+			}));
+		};
+		const refresh = () => load(false);
+		return {
+			actions: {
+				refresh,
+				loadMore: () => load(true),
+				setFilters: (filters) => {
+					next = void 0;
+					state.set({
+						filters,
+						entries: void 0,
+						hasMore: false
+					});
+					return refresh();
+				}
+			},
+			start: () => organizationId === null ? void 0 : whileSignedIn(options.auth, () => {
+				refresh();
+			})
+		};
+	});
+}
+//#endregion
+export { createAuditLogController as t };

package/dist/client-BAcILZOf.d.ts

@@ -0,0 +1,122 @@
+/// <reference lib="esnext.temporal" />
+import { b as DbError, t as AsyncResult, w as ErrorMapper } from "./result-Cj3yWhjH.js";
+import { n as Logger } from "./logger-DWVYUmwi.js";
+import { t as StandardSchemaV1 } from "./standard-C3_AAF3g.js";
+import { t as BlockTransport } from "./block-transport-DaGGXjIw.js";
+import { r as BlockTemporalOptions } from "./block-helpers-C86hPEjI.js";
+import { n as BlockHooks } from "./block-hooks-BLPWD3Jt.js";
+import { r as FieldsOf } from "./block-fields-5UA84ZUg.js";
+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/announcements/announcements.d.ts
+type AnnouncementSeverity = "info" | "success" | "warning" | "critical";
+/**
+ * Who sees it: everyone, members of some tenants, members with some roles,
+ * or tenants on some plans (entitlement lookup keys, with the entitlements
+ * module).
+ */
+type AnnouncementAudience = {
+  readonly type: "all";
+} | {
+  readonly type: "tenant";
+  readonly organizationIds: readonly string[];
+} | {
+  readonly type: "role";
+  readonly roles: readonly string[];
+} | {
+  readonly type: "plan";
+  readonly plans: readonly string[];
+};
+interface Announcement {
+  readonly id: string;
+  readonly title: string;
+  readonly body: string;
+  readonly severity: AnnouncementSeverity;
+  readonly href: string | undefined;
+  readonly startsAt: Temporal.Instant;
+  readonly endsAt: Temporal.Instant | undefined;
+  readonly dismissible: boolean;
+  readonly createdAt: Temporal.Instant;
+  readonly updatedAt: Temporal.Instant;
+}
+/** An announcement as staff see it, with its audience. */
+interface ManagedAnnouncement extends Announcement {
+  readonly audience: AnnouncementAudience;
+  readonly createdBy: string | undefined;
+}
+interface AnnouncementInput {
+  readonly title: string;
+  /** Plain text or Markdown; the app renders it. */
+  readonly body?: string;
+  readonly severity?: AnnouncementSeverity;
+  /** A link for "Learn more": `https://` or a path. */
+  readonly href?: string | null;
+  readonly audience?: AnnouncementAudience;
+  readonly startsAt?: Temporal.Instant;
+  readonly endsAt?: Temporal.Instant | null;
+  readonly dismissible?: boolean;
+}
+interface AnnouncementsOptions<S extends StandardSchemaV1 | undefined = undefined> extends BlockTemporalOptions {
+  /**
+   * A Standard Schema for the announcement columns the app adds
+   * (`blocks.announcements.options.extraColumns`), keyed by column name. It
+   * types and parses them on every read, and validates them on `publish`
+   * and `update`, which return a `validation` error for a bad value.
+   */
+  readonly fields?: S;
+  /** `withBlockHooks` hooks around the client's methods. */
+  readonly hooks?: NoInfer<BlockHooks<Announcements<FieldsOf<S>>>>;
+  /** Receives the errors `after` hooks throw. Default: `console`. */
+  readonly logger?: Logger;
+  readonly transport: BlockTransport;
+  /** The module schema, or its API schema: `defineBlocks` passes it from `blocks.generated.ts`. Default `better_supabase`. */
+  readonly schema?: string;
+  readonly mappers?: readonly ErrorMapper[];
+}
+/** `F` is the extra fields `options.fields` describes. */
+interface Announcements<F extends object = Record<never, never>> {
+  /** The caller's live, undismissed announcements; pass the active tenant for tenant, role and plan audiences. */
+  listActive(organizationId?: string | null): AsyncResult<readonly (Announcement & F)[]>;
+  /** Hides one for the caller; `false` when it was hidden already. */
+  dismiss(announcementId: string): AsyncResult<boolean>;
+  /** Every announcement; needs `announcements.manage` on the platform. */
+  list(): AsyncResult<readonly (ManagedAnnouncement & F)[]>;
+  /** Keys besides the input's own are the announcement's extra columns. */
+  publish(input: AnnouncementInput & Partial<F>): AsyncResult<ManagedAnnouncement & F>;
+  update(announcementId: string, input: Partial<AnnouncementInput> & Partial<F>): AsyncResult<ManagedAnnouncement & F>;
+  remove(announcementId: string): AsyncResult<boolean>;
+}
+declare function createAnnouncements<S extends StandardSchemaV1 | undefined = undefined>(options: AnnouncementsOptions<S>): Announcements<FieldsOf<S>>;
+//#endregion
+//#region src/blocks/announcements/client.d.ts
+interface AnnouncementsControllerOptions {
+  readonly client: Pick<Announcements, "listActive" | "dismiss">;
+  readonly auth: AuthPort;
+  readonly ports: {
+    readonly topic: TopicPort;
+  };
+  /** The active tenant, for tenant, role and plan audiences. */
+  readonly organizationId?: string | null;
+  /** The topic the module broadcasts to (`blockConfig.announcements.options.topic` from `blocks.generated.ts`); `null` loads once. */
+  readonly topic?: string | null;
+}
+interface AnnouncementsSnapshot {
+  /** `undefined` until the first load. */
+  readonly items: readonly Announcement[] | undefined;
+  readonly status: SubscriptionStatus;
+  readonly error: DbError | undefined;
+}
+interface AnnouncementsActions {
+  /** Hides one for the user, then drops it from `items`. */
+  readonly dismiss: (announcementId: string) => Promise<void>;
+  readonly refresh: () => Promise<void>;
+}
+type AnnouncementsController = Controller<AnnouncementsSnapshot, AnnouncementsActions>;
+/**
+ * The signed-in user's live announcements, loaded again whenever staff
+ * publish, change or remove one.
+ */
+declare function createAnnouncementsController(options: AnnouncementsControllerOptions): AnnouncementsController;
+//#endregion
+export { createAnnouncementsController as a, AnnouncementInput as c, AnnouncementsOptions as d, ManagedAnnouncement as f, AnnouncementsSnapshot as i, AnnouncementSeverity as l, AnnouncementsController as n, Announcement as o, createAnnouncements as p, AnnouncementsControllerOptions as r, AnnouncementAudience as s, AnnouncementsActions as t, Announcements as u };