better-supabase 0.12.0 → 0.14.0

package/dist/blocks/collections/index.d.ts

@@ -1,15 +1,15 @@
 /// <reference lib="esnext.temporal" />
-import { T as ErrorMapper, t as AsyncResult } from "../../result-BREt7qOh.js";
-import { wt as Events } from "../../events-P3raDX2E.js";
-import { m as CollectionEventData, p as CollectionEntryEventData } from "../../index-BpyBH5O2.js";
+import { T as ErrorMapper, t as AsyncResult } from "../../result-C6jDfedy.js";
+import { t as StandardSchemaV1 } from "../../standard-DbQsD2xZ.js";
+import { r as FieldsOf } from "../../block-fields-3w4MZr8U.js";
+import { Ct as Events } from "../../events-DbLjvxDX.js";
+import { C as SavedItemEventData, a as CollectionEventData, i as CollectionEntryEventData } from "../../block-events-records-BGVyoz57.js";
 import { n as Logger } from "../../logger-DWVYUmwi.js";
-import { t as StandardSchemaV1 } from "../../standard-BcUQuUgu.js";
-import { a as dbTransport, i as RpcClient, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-DezJPPA0.js";
-import { i as CursorPageOptions } from "../../block-helpers-CjcQM1yA.js";
-import { a as BlockTransportMiddleware, d as extendBlock, f as withBlockHooks, n as BlockHooks, p as wrapTransport } from "../../block-hooks-DcPJHztl.js";
-import { r as FieldsOf } from "../../block-fields-DnaDbgZS.js";
-import { s as BlockOf } from "../../define-block-BHxLHLys.js";
-import { t as RankNeighbors } from "../../rank-result-BcYfDA0x.js";
+import { i as CursorPageOptions } from "../../block-helpers-BaugZlJV.js";
+import { a as dbTransport, i as RpcClient, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-d53POsem.js";
+import { a as BlockTransportMiddleware, d as extendBlock, f as withBlockHooks, n as BlockHooks, p as wrapTransport } from "../../block-hooks-CmjPKqQ_.js";
+import { _ as Notifier, c as BlockOf } from "../../define-block-COpcS6aT.js";
+import { t as RankNeighbors } from "../../rank-result-DwR0FawB.js";
 //#region src/blocks/collections/collections.d.ts
 /** Who sees a collection: its owner, a team, or the whole organization. */
 export declare const COLLECTION_SCOPES: readonly ["user", "team", "tenant"];
@@ -68,6 +68,44 @@ interface Star {
   readonly title?: string;
   readonly url?: string;
 }
+/**
+ * A record the caller saved for later, with its title and URL from
+ * `config.subjects`.
+ */
+interface SavedItem {
+  readonly id: string;
+  readonly organizationId: string;
+  /** The member who saved it. */
+  readonly userId: string;
+  readonly subjectType: string;
+  readonly subjectId: string;
+  readonly note?: string;
+  /** When to remind the member. */
+  readonly remindAt?: Temporal.Instant;
+  /** When `remindDue` sent the reminder. */
+  readonly remindedAt?: Temporal.Instant;
+  readonly completed: boolean;
+  readonly completedAt?: Temporal.Instant;
+  readonly createdAt: Temporal.Instant;
+  readonly title?: string;
+  readonly url?: string;
+}
+interface SaveForLaterInput {
+  /** At most 1000 characters. */
+  readonly note?: string;
+  /** A future time to remind the member, sent by `remindDue`. */
+  readonly remindAt?: Temporal.Instant;
+}
+/** Where a page of saved items stops: the last item's save time and id. */
+interface SavedItemCursor {
+  readonly createdAt: Temporal.Instant;
+  readonly id: string;
+}
+interface SavedItemPage {
+  readonly items: readonly SavedItem[];
+  /** Pass as `cursor` for the next page; `undefined` on the last page. */
+  readonly next?: SavedItemCursor;
+}
 interface CreateCollectionInput {
   readonly name: string;
   /** A type in `config.subjects` with a tenant column. */
@@ -103,8 +141,8 @@ interface Collections<F extends object = Record<never, never>> {
   /** The collections the caller sees, by name. */
   list(organizationId: string, options?: CollectionListOptions): AsyncResult<(Collection & F)[]>;
   /**
-   * Adds records to the end of a collection, in the given order (at most
-   * 1000). Ids already in it are skipped; resolves to the ids added.
+   * Adds records to the end of a collection, in the given order (at most 1000).
+   * Ids already in it are skipped; resolves to the ids added.
    */
   add(id: string, subjectIds: readonly string[]): AsyncResult<{
     readonly added: readonly string[];
@@ -115,7 +153,10 @@ interface Collections<F extends object = Record<never, never>> {
   reorder(id: string, subjectId: string, neighbors: RankNeighbors): AsyncResult<string>;
   /** A page of entries in rank order (default 50, at most 200). */
   entries(id: string, options?: CursorPageOptions<CollectionEntryCursor>): AsyncResult<CollectionEntryPage>;
-  /** The ids of the records in a collection, in rank order (default 500, at most 1000). */
+  /**
+   * The ids of the records in a collection, in rank order (default 500, at most
+   * 1000).
+   */
   subjectIds(id: string, options?: {
     readonly max?: number;
   }): AsyncResult<string[]>;
@@ -141,28 +182,62 @@ interface Collections<F extends object = Record<never, never>> {
   }): AsyncResult<Star[]>;
   /** Moves a star between its neighbours' rank keys. Resolves to its new key. */
   reorderStar(subject: CollectionSubject, neighbors: RankNeighbors): AsyncResult<string>;
+  /**
+   * Saves a record for later. Saving it again replaces the note and reminder
+   * and reopens a completed item.
+   */
+  saveForLater(organizationId: string, subject: CollectionSubject, input?: SaveForLaterInput): AsyncResult<SavedItem>;
+  /** Marks a saved item done, or open again with `completed: false`. */
+  completeSaved(id: string, completed?: boolean): AsyncResult<boolean>;
+  /** Resolves to `false` when the caller has no such saved item. */
+  removeSaved(id: string): AsyncResult<boolean>;
+  /**
+   * A page of the caller's saved items, the newest first (default 50, at most
+   * 200): the open ones, or the completed ones with `completed: true`.
+   */
+  saved(organizationId: string, options?: CursorPageOptions<SavedItemCursor> & {
+    readonly completed?: boolean;
+  }): AsyncResult<SavedItemPage>;
+  /**
+   * Service role. Claims the open saved items whose reminder time has passed
+   * (default 100, at most 500), records `saved_item.reminded` for each and
+   * sends `notification` through `notifier` to the member who saved it. Each
+   * reminder is sent at most once.
+   */
+  remindDue(options?: {
+    readonly limit?: number;
+  }): AsyncResult<SavedItem[]>;
 }
 interface CollectionsOptions<S extends StandardSchemaV1 | undefined = undefined> {
   readonly transport: BlockTransport;
-  /** The module schema, or its API schema: `defineBlocks` passes it from `blocks.generated.ts`. */
+  /**
+   * The module schema, or its API schema: `defineBlocks` passes it from
+   * `blocks.generated.ts`.
+   */
   readonly schema?: string;
   /**
    * A Standard Schema for the collection columns the app adds
-   * (`blocks.collections.options.extraColumns`), keyed by column name. It
-   * types and parses them on `create`, `rename` and `list`, and validates
-   * them on `create` and `rename`, which return a `validation` error for a
-   * bad value.
+   * (`blocks.collections.options.extraColumns`), keyed by column name. It types
+   * and parses them on `create`, `rename` and `list`, and validates them on
+   * `create` and `rename`, which return a `validation` error for a bad value.
    */
   readonly fields?: S;
   /** `withBlockHooks` hooks around the client's methods. */
   readonly hooks?: NoInfer<BlockHooks<Collections<FieldsOf<S>>>>;
   readonly logger?: Logger;
   readonly mappers?: readonly ErrorMapper[];
+  /** The `notifier` port: the `notifications` block, from `createBlocks`. */
+  readonly notifier?: Notifier;
+  /**
+   * The notification type `remindDue` sends for a due saved item, about the
+   * saved record. Its data is `{ savedItemId, note }`.
+   */
+  readonly notification?: string;
 }
 /**
- * The collections block: favorites (a member's starred records, ranked for
- * a sidebar) and lists (named, static collections of one subject type owned
- * by a user, a team or the organization) on any record in `config.subjects`.
+ * The collections block: favorites (a member's starred records, ranked for a
+ * sidebar) and lists (named, static collections of one subject type owned by a
+ * user, a team or the organization) on any record in `config.subjects`.
  */
 export declare function createCollections<S extends StandardSchemaV1 | undefined = undefined>(options: CollectionsOptions<S>): Collections<FieldsOf<S>>;
 //#endregion
@@ -173,12 +248,15 @@ type CollectionsEvents = {
   readonly "collection.archived": CollectionEventData;
   readonly "collection.entry_added": CollectionEntryEventData;
   readonly "collection.entry_removed": CollectionEntryEventData;
+  readonly "saved_item.reminded": SavedItemEventData;
 };
 /** The `collections` block's event types, for its manifest and `onBlockEvent`. */
 export declare const collectionsEvents: Events<CollectionsEvents>;
 //#endregion
 //#region src/blocks/collections/manifest.d.ts
 /** The `collections` block's manifest (ADR 0029). */
-export declare const collectionsBlock: BlockOf<"collections", typeof createCollections, CollectionsEvents>;
+export declare const collectionsBlock: BlockOf<"collections", typeof createCollections, CollectionsEvents, {
+  readonly notifier: "optional";
+}>;
 //#endregion
-export { type BlockHooks, type BlockTransport, type BlockTransportMiddleware, type Collection, type CollectionEntry, type CollectionEntryCursor, type CollectionEntryPage, type CollectionListOptions, type CollectionScope, type CollectionSubject, type Collections, type CollectionsEvents, type CollectionsOptions, type CreateCollectionInput, type RenameCollectionInput, type RpcClient, type Star, dbTransport, extendBlock, rpcTransport, sqlTransport, withBlockHooks, wrapTransport };
+export { type BlockHooks, type BlockTransport, type BlockTransportMiddleware, type Collection, type CollectionEntry, type CollectionEntryCursor, type CollectionEntryPage, type CollectionListOptions, type CollectionScope, type CollectionSubject, type Collections, type CollectionsEvents, type CollectionsOptions, type CreateCollectionInput, type RenameCollectionInput, type RpcClient, type SaveForLaterInput, type SavedItem, type SavedItemCursor, type SavedItemPage, type Star, dbTransport, extendBlock, rpcTransport, sqlTransport, withBlockHooks, wrapTransport };

package/dist/blocks/collections/index.js

@@ -1,13 +1,13 @@
-import { t as AsyncResult } from "../../result-DIeYscA3.js";
+import { o as isDbError } from "../../errors-03ysrOt4.js";
+import { a as ok, r as err, t as AsyncResult } from "../../result-B3m7xtRY.js";
 import { n as isRecord } from "../../guards-6F2bCtQR.js";
 import { t as collectionsSqlOptions } from "../../options-BOOEzor9.js";
-import { n as event, t as defineEvents } from "../../event-map-Dy2vKHai.js";
-import { i as sqlTransport, r as rpcTransport, t as dbTransport } from "../../block-transport-J7ZepTq2.js";
-import { A as requiredInstant, C as optionalText, D as recordOf, F as stringsOf, I as textOf, S as optionalInstant, b as oneOf, k as recordsOf, o as blockCall, w as pageOf } from "../../block-helpers-DkVZNDrj.js";
-import { i as wrapTransport, n as extendBlock, r as withBlockHooks } from "../../block-hooks-C22vuIUd.js";
-import { c as withFields, i as extraOf, n as blockFields, r as extraFieldsArg, t as allWithFields } from "../../block-fields-Bv1hV855.js";
-import { n as defineBlock } from "../../define-block-B6Gjs57G.js";
-import { t as rankBetweenResult } from "../../rank-result-DtQuIvob.js";
+import { A as requiredInstant, B as dbTransport, C as optionalText, D as recordOf, F as stringsOf, H as rpcTransport, I as textOf, S as optionalInstant, U as sqlTransport, b as oneOf, k as recordsOf, m as instantArg, o as blockCall, w as pageOf } from "../../block-helpers-CiKtrb6g.js";
+import { i as wrapTransport, n as extendBlock, r as withBlockHooks } from "../../block-hooks-BymdcD0V.js";
+import { n as event, t as defineEvents } from "../../event-map-CtPFhcOp.js";
+import { c as withFields, i as extraOf, n as blockFields, r as extraFieldsArg, t as allWithFields } from "../../block-fields-DBSJSeaO.js";
+import { n as defineBlock } from "../../define-block-Dze77QTw.js";
+import { t as rankBetweenResult } from "../../rank-result-C_sHjkiz.js";
 //#region src/blocks/collections/collections.ts
 /** Who sees a collection: its owner, a team, or the whole organization. */
 const COLLECTION_SCOPES = [
@@ -75,6 +75,35 @@ function starOf(value) {
 		...optional("url", optionalText(row["url"]))
 	};
 }
+function savedItemOf(value) {
+	const row = recordOf(value, "saved item");
+	const completedAt = optionalInstant(row["completedAt"]);
+	return {
+		id: textOf(row["id"]),
+		organizationId: textOf(row["organizationId"]),
+		userId: textOf(row["userId"]),
+		subjectType: textOf(row["subjectType"]),
+		subjectId: textOf(row["subjectId"]),
+		completed: completedAt !== void 0,
+		createdAt: requiredInstant(row["createdAt"], "createdAt"),
+		...optional("note", optionalText(row["note"])),
+		...optional("remindAt", optionalInstant(row["remindAt"])),
+		...optional("remindedAt", optionalInstant(row["remindedAt"])),
+		...optional("completedAt", completedAt),
+		...optional("title", optionalText(row["title"])),
+		...optional("url", optionalText(row["url"]))
+	};
+}
+function savedPage(rows, limit) {
+	const last = rows.at(-1);
+	return rows.length === (limit ?? 50) && last !== void 0 ? {
+		items: rows,
+		next: {
+			createdAt: last.createdAt,
+			id: last.id
+		}
+	} : { items: rows };
+}
 function entryPage(rows, limit) {
 	const last = rows.at(-1);
 	return rows.length === (limit ?? 50) && last !== void 0 ? {
@@ -86,9 +115,9 @@ function entryPage(rows, limit) {
 	} : { items: rows };
 }
 /**
-* The collections block: favorites (a member's starred records, ranked for
-* a sidebar) and lists (named, static collections of one subject type owned
-* by a user, a team or the organization) on any record in `config.subjects`.
+* The collections block: favorites (a member's starred records, ranked for a
+* sidebar) and lists (named, static collections of one subject type owned by a
+* user, a team or the organization) on any record in `config.subjects`.
 */
 function createCollections(options) {
 	const call = blockCall(options.transport, options.schema, options.mappers);
@@ -101,6 +130,27 @@ function createCollections(options) {
 		collection: id,
 		max_ids: max ?? null
 	}, (value) => [...stringsOf(value)]);
+	const { notifier, notification } = options;
+	/** Sends the due reminders one by one; the first failed send fails the call. */
+	const notifyDue = (items) => AsyncResult.from(async () => {
+		if (notifier !== void 0 && notification !== void 0) for (const item of items) {
+			const outcome = await notifier.send(notification, {
+				recipients: [item.userId],
+				tenant: item.organizationId,
+				key: `saved_item:${item.id}:${String(item.remindAt)}`,
+				subject: {
+					type: item.subjectType,
+					id: item.subjectId
+				},
+				data: {
+					savedItemId: item.id,
+					note: item.note ?? null
+				}
+			});
+			if (isRecord(outcome) && outcome["ok"] === false && isDbError(outcome["error"])) return err(outcome["error"]);
+		}
+		return ok([...items]);
+	});
 	return withBlockHooks({
 		create: (organizationId, input) => saved("create_collection", {
 			tenant: organizationId,
@@ -178,7 +228,30 @@ function createCollections(options) {
 				subject_id: subject.id,
 				rank: key.data
 			}, () => key.data);
-		}
+		},
+		saveForLater: (organizationId, subject, input = {}) => call("save_for_later", {
+			tenant: organizationId,
+			subject_type: subject.type,
+			subject_id: subject.id,
+			note: input.note ?? null,
+			remind_at: instantArg(input.remindAt) ?? null
+		}, savedItemOf),
+		completeSaved: (id, completed = true) => call("complete_saved_item", {
+			item: id,
+			completed
+		}, (value) => value === true),
+		removeSaved: (id) => call("remove_saved_item", { item: id }, (value) => value === true),
+		saved: (organizationId, savedOptions = {}) => {
+			const { limit, cursor } = pageOf(savedOptions);
+			return call("list_saved_items", {
+				tenant: organizationId,
+				completed: savedOptions.completed ?? false,
+				before: instantArg(cursor?.createdAt) ?? null,
+				before_id: cursor?.id ?? null,
+				max_rows: limit ?? null
+			}, (value) => savedPage(recordsOf(value, "list_saved_items").map(savedItemOf), limit));
+		},
+		remindDue: (dueOptions = {}) => call("remind_due_saved_items", { max_rows: dueOptions.limit ?? null }, (value) => recordsOf(value, "remind_due_saved_items").map(savedItemOf)).andThen(notifyDue)
 	}, options.hooks, {
 		block: "collections",
 		...options.logger ? { logger: options.logger } : {}
@@ -191,7 +264,8 @@ const collectionsEvents = defineEvents({
 	"collection.created": event(),
 	"collection.archived": event(),
 	"collection.entry_added": event(),
-	"collection.entry_removed": event()
+	"collection.entry_removed": event(),
+	"saved_item.reminded": event()
 });
 //#endregion
 //#region src/blocks/collections/manifest.ts
@@ -201,6 +275,7 @@ const collectionsBlock = defineBlock({
 	sql: ["collections"],
 	options: { collections: collectionsSqlOptions },
 	events: collectionsEvents,
+	consumes: { notifier: "optional" },
 	create: createCollections,
 	category: "work"
 });

package/dist/blocks/comments/index.d.ts

@@ -1,53 +1,54 @@
-import { j as CommentEventData, wt as Events } from "../../events-P3raDX2E.js";
-import { a as dbTransport, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-DezJPPA0.js";
-import { s as BlockOf } from "../../define-block-BHxLHLys.js";
-import { C as mentionsIn, S as createComments, _ as CommentsOptions, a as CommentsSnapshot, b as activityListQuery, c as ActivityEntry, d as ActivitySinkOptions, f as ActivitySort, g as Comments, h as CommentEdit, i as CommentsControllerOptions, l as ActivityFacet, m as Comment, n as CommentsActions, o as createCommentsController, p as ActivitySource, r as CommentsController, s as ActivityDescription, t as CommentDraft, u as ActivityHistoryOptions, v as ListCommentsOptions, x as activitySink, y as NewComment } from "../../client-BMcjLG0V.js";
-//#region src/sql/subjects.d.ts
+import { a as dbTransport, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-d53POsem.js";
+import { O as CommentsSqlOptions } from "../../authorization-BuT26_sR.js";
+import { t as Author } from "../../block-authors-DzXLUiIq.js";
+import { a as isFileAnchor, i as fileAnchor, n as FileAnchor, o as conversationTopic, r as FileAnchorAt, t as AnchorRegion } from "../../anchors-7F34QyHa.js";
+import { c as MessageEdit } from "../../messaging-CZ6aWb10.js";
+import { Gt as SectionWrite, Lt as Section, Wt as SectionRowInput, c as BlockOf, rn as EntitySchema } from "../../define-block-COpcS6aT.js";
+import { a as CommentsSnapshot, c as CommentAssignment, d as CommentsOptions, f as ListCommentsOptions, h as mentionsIn, i as CommentsControllerOptions, l as CommentEdit, m as createComments, n as CommentsActions, o as createCommentsController, p as NewComment, r as CommentsController, s as Comment, t as CommentDraft, u as Comments } from "../../client-CA6KuLDu.js";
+//#region src/blocks/comments/section.d.ts
+/** A pending write to a thread, for `useOptimistic`. */
+type CommentsOptimisticAction = {
+  readonly type: "add";
+  readonly comment: Comment;
+} | {
+  readonly type: "edit";
+  readonly id: string;
+  readonly body: string;
+} | {
+  readonly type: "remove";
+  readonly id: string;
+};
 /**
- * One subject type a module's rows belong to (`options.subjects`): the
- * table its ids point at, and who may read it.
+ * The thread with a pending write applied: `add` appends (or replaces the
+ * comment with the same id), `edit` changes the body, `remove` takes it out.
  */
-interface Subject {
-  /** `schema.table`, or a table in `public`. */
-  readonly table: string;
-  /** Default `id`. */
-  readonly id?: string;
-  /**
-   * The id column's type, such as `uuid` or `bigint`. With it, the stored
-   * text id is cast to that type, so the lookup uses the subject table's
-   * primary key; without it the column is cast to text, which can't.
-   */
-  readonly idType?: string;
-  /**
-   * The subject's tenant column, default `organization_id`. `false` for a
-   * subject without a tenant (a user's own records), where the subject
-   * table's policies alone decide, in modules that allow it.
-   */
-  readonly tenant?: string | false;
-  /** A permission the caller also needs in the tenant, e.g. `projects.read`. */
-  readonly permission?: string;
-  /** Delete the module's rows for a subject when the subject row is deleted. */
-  readonly cascade?: boolean;
-  /** The module's own keys, such as a bucket per subject. */
-  readonly extra: Readonly<Record<string, unknown>>;
-}
-//#endregion
-//#region src/sql/modules/comments.d.ts
-/** One commentable subject type: its table, and who may read it. */
-type CommentSubject = Omit<Subject, "extra">;
-//#endregion
-//#region src/blocks/comments/events.d.ts
-/** The events of the `comments` block: type to data. */
-type CommentsEvents = {
-  readonly "comment.created": CommentEventData;
-  readonly "comment.mentioned": CommentEventData;
-  readonly "comment.deleted": CommentEventData;
+export declare function commentsOptimistic(state: readonly Comment[], action: CommentsOptimisticAction): readonly Comment[];
+/** The writes of the comments section. */
+type CommentsWrites = {
+  /** Adds a comment to the record's thread. */
+  readonly add: SectionWrite<Comments, NewComment, Comment>;
+  /** Removes one comment; its author or a moderator. */
+  readonly remove: SectionWrite<Comments, SectionRowInput, boolean>;
 };
-/** The `comments` block's event types, for its manifest and `onBlockEvent`. */
-export declare const commentsEvents: Events<CommentsEvents>;
+/**
+ * A record's comment thread, oldest first. The messaging events make it stale:
+ * a record conversation's messages carry `conversationKind: "subject"`.
+ */
+export declare const commentsSection: Section<Comments, readonly Comment[], ListCommentsOptions, CommentsOptimisticAction, CommentsWrites>;
 //#endregion
 //#region src/blocks/comments/manifest.d.ts
-/** The `comments` block's manifest (ADR 0029). */
-export declare const commentsBlock: BlockOf<"comments", typeof createComments, CommentsEvents>;
+/** The `comments` block's manifest (ADR 0029, ADR 0062). */
+export declare const commentsBlock: BlockOf<"comments", typeof createComments, Record<never, never>, Record<never, never>, never, {
+  readonly comments: typeof commentsSection;
+}>;
+//#endregion
+//#region src/blocks/comments/schemas.d.ts
+/**
+ * What `create` takes after the subject. The body's length limit is
+ * `blocks.messaging.options.maxBodyLength`, so the SQL checks it.
+ */
+export declare const commentInputSchema: EntitySchema<NewComment>;
+/** What `edit` takes: a message edit. */
+export declare const commentChangeSchema: EntitySchema<CommentEdit>;
 //#endregion
-export { type ActivityDescription, type ActivityEntry, type ActivityFacet, type ActivityHistoryOptions, type ActivitySinkOptions, type ActivitySort, type ActivitySource, type BlockTransport, type Comment, type CommentDraft, type CommentEdit, type CommentSubject, type Comments, type CommentsActions, type CommentsController, type CommentsControllerOptions, type CommentsEvents, type CommentsOptions, type CommentsSnapshot, type ListCommentsOptions, type NewComment, activityListQuery, activitySink, createComments, createCommentsController, dbTransport, mentionsIn, rpcTransport, sqlTransport };
+export { type AnchorRegion, type Author, type BlockTransport, type Comment, type CommentAssignment, type CommentDraft, type CommentEdit, type Comments, type CommentsActions, type CommentsController, type CommentsControllerOptions, type CommentsOptimisticAction, type CommentsOptions, type CommentsSnapshot, type CommentsSqlOptions, type CommentsWrites, type FileAnchor, type FileAnchorAt, type ListCommentsOptions, type MessageEdit, type NewComment, conversationTopic, createComments, createCommentsController, dbTransport, fileAnchor, isFileAnchor, mentionsIn, rpcTransport, sqlTransport };

package/dist/blocks/comments/index.js

@@ -1,27 +1,124 @@
-import { t as commentsSqlOptions } from "../../options-C1HR4UZd.js";
-import { n as event, t as defineEvents } from "../../event-map-Dy2vKHai.js";
-import { i as sqlTransport, r as rpcTransport, t as dbTransport } from "../../block-transport-J7ZepTq2.js";
-import { n as defineBlock } from "../../define-block-B6Gjs57G.js";
-import { t as createCommentsController } from "../../client-DyfWYU8S.js";
-import { i as mentionsIn, n as activitySink, r as createComments, t as activityListQuery } from "../../comments-CV5O8q50.js";
-//#region src/blocks/comments/events.ts
-/** The `comments` block's event types, for its manifest and `onBlockEvent`. */
-const commentsEvents = defineEvents({
-	"comment.created": event(),
-	"comment.mentioned": event(),
-	"comment.deleted": event()
+import { t as commentsSqlOptions } from "../../options-DrSkIBCD.js";
+import { B as dbTransport, H as rpcTransport, U as sqlTransport } from "../../block-helpers-CiKtrb6g.js";
+import { n as entitySchema } from "../../entity-schema-BXXC1NnT.js";
+import { r as sectionRowInput, t as defineSection } from "../../sections-DjxYmpu-.js";
+import { n as defineBlock } from "../../define-block-Dze77QTw.js";
+import { t as conversationTopic } from "../../rows-Bb0EPupt.js";
+import { i as isFileAnchor, r as fileAnchor, t as messageChangeSchema } from "../../schemas-9Ci3K0Hk.js";
+import { t as createCommentsController } from "../../client-B1cjaIfv.js";
+import { n as mentionsIn, t as createComments } from "../../comments-CB8pFSV1.js";
+//#region src/blocks/comments/schemas.ts
+/**
+* What `create` takes after the subject. The body's length limit is
+* `blocks.messaging.options.maxBodyLength`, so the SQL checks it.
+*/
+const commentInputSchema = entitySchema({
+	title: "NewComment",
+	fields: {
+		body: { kind: "string" },
+		document: {
+			kind: "unknown",
+			optional: true,
+			description: "A rich-text document (any JSON)."
+		},
+		anchor: {
+			kind: "unknown",
+			optional: true,
+			description: "Where on the record the comment points."
+		},
+		mentionIds: {
+			kind: "uuid",
+			optional: true,
+			array: true
+		},
+		parentId: {
+			kind: "uuid",
+			optional: true
+		},
+		attachmentIds: {
+			kind: "uuid",
+			optional: true,
+			array: true
+		},
+		fields: {
+			kind: "json",
+			optional: true,
+			description: "The extra columns to set, keyed by database name."
+		}
+	}
+});
+/** What `edit` takes: a message edit. */
+const commentChangeSchema = messageChangeSchema;
+//#endregion
+//#region src/blocks/comments/section.ts
+/**
+* The thread with a pending write applied: `add` appends (or replaces the
+* comment with the same id), `edit` changes the body, `remove` takes it out.
+*/
+function commentsOptimistic(state, action) {
+	switch (action.type) {
+		case "add": return [...state.filter((comment) => comment.id !== action.comment.id), action.comment];
+		case "edit": return state.map((comment) => comment.id === action.id ? {
+			...comment,
+			body: action.body
+		} : comment);
+		case "remove": return state.filter((comment) => comment.id !== action.id);
+		default: return action;
+	}
+}
+/**
+* A record's comment thread, oldest first. The messaging events make it stale:
+* a record conversation's messages carry `conversationKind: "subject"`.
+*/
+const commentsSection = defineSection({
+	permissions: {
+		read: "read",
+		write: "create"
+	},
+	load: (client, subject, options) => client.list(subject, options),
+	count: (client, subjects) => client.counts(subjects),
+	timeline: (comments) => comments.flatMap((comment) => comment.sentAt === void 0 ? [] : [{
+		id: comment.id,
+		kind: "comment",
+		at: comment.sentAt,
+		...comment.authorId === void 0 ? {} : { actor: comment.authorId },
+		row: comment
+	}]),
+	events: [
+		"message.sent",
+		"message.edited",
+		"message.deleted",
+		"message.pinned",
+		"message.resolved"
+	],
+	optimistic: commentsOptimistic,
+	writes: {
+		add: {
+			input: commentInputSchema,
+			run: (client, subject, input) => client.create(subject, input)
+		},
+		remove: {
+			input: sectionRowInput,
+			run: (client, _subject, { id }) => client.remove(id)
+		}
+	}
 });
 //#endregion
 //#region src/blocks/comments/manifest.ts
-/** The `comments` block's manifest (ADR 0029). */
+/** The `comments` block's manifest (ADR 0029, ADR 0062). */
 const commentsBlock = defineBlock({
 	name: "comments",
 	sql: ["comments"],
 	options: { comments: commentsSqlOptions },
-	events: commentsEvents,
 	create: createComments,
+	sections: { comments: commentsSection },
 	category: "collaboration",
-	recipes: ["comment-thread", "record-page"]
+	recipes: [
+		"comment-thread",
+		"record-page",
+		"my-work",
+		"subject-timeline"
+	]
 });
 //#endregion
-export { activityListQuery, activitySink, commentsBlock, commentsEvents, createComments, createCommentsController, dbTransport, mentionsIn, rpcTransport, sqlTransport };
+export { commentChangeSchema, commentInputSchema, commentsBlock, commentsOptimistic, commentsSection, conversationTopic, createComments, createCommentsController, dbTransport, fileAnchor, isFileAnchor, mentionsIn, rpcTransport, sqlTransport };

package/dist/blocks/comments/react/index.d.ts

@@ -1,25 +1,30 @@
-import { a as CommentsSnapshot, n as CommentsActions, t as CommentDraft } from "../../../client-BMcjLG0V.js";
+import { dt as SubjectRef } from "../../../executor-CPyrQdjh.js";
+import { a as CommentsSnapshot, n as CommentsActions, t as CommentDraft } from "../../../client-CA6KuLDu.js";
 //#region src/blocks/comments/react/index.d.ts
 export interface UseCommentsOptions {
-  /** The organization; the thread waits without one. */
-  readonly organizationId: string | null | undefined;
-  readonly subjectType: string;
-  readonly subjectId: string;
-  /** A private topic whose messages load the thread again; default none. */
+  /** The subject whose thread to show; the thread waits without one. */
+  readonly subject: SubjectRef | null | undefined;
+  /**
+   * The messaging topic prefix the record conversation's pings arrive on;
+   * default `blocks.messaging.options.topic` (`messages`). `null` turns
+   * Realtime off.
+   */
   readonly topic?: string | null;
   /** The most comments to load, default 100, at most 500. */
   readonly limit?: number;
-  /** The schema the calls go to: the module schema (default `better_supabase`), or the API schema from `blocks.<module>.api`. */
-  readonly schema?: string;
 }
 export interface CommentsState extends CommentsSnapshot, CommentsActions {}
 /**
- * One subject's comment thread through the browser client, kept current
- * after `add`, `edit` and `remove`. The same hook runs in React DOM and
- * React Native.
+ * One subject's comment thread through the browser client, kept current after
+ * its own writes and live on the record conversation's topic. It acts in the
+ * client's tenant and calls the schema and function names in the client's
+ * `blocks` config, and waits while there is no tenant. The same hook runs in
+ * React DOM and React Native.
  *
  * ```tsx
- * const { comments, add } = useComments({ organizationId, subjectType: "customer", subjectId });
+ * const { comments, add } = useComments({
+ *   subject: { type: "customer", id: customerId },
+ * });
  * ```
  */
 export declare function useComments(options: UseCommentsOptions): CommentsState;