@openmarket/rooms-client 0.6.0 → 0.7.1

package/src/social-types.ts

@@ -1,4 +1,9 @@
-import type { RoomLedgerSecretPayload } from "./shared/rooms-protocol.js";
+import type {
+  RoomLedgerSecretPayload,
+  RoomPollSummary,
+  RoomTopicAttention,
+  RoomUnfurl,
+} from "./shared/rooms-protocol.js";
 
 export interface RoomSocialConfig {
   apiUrl: string;
@@ -234,6 +239,175 @@ export interface RoomNotificationInboxResult {
   lastCursorId: string | null;
 }
 
+/** One of the caller's user blocks, wire names verbatim from the store's
+ *  block rows: the row id, the BLOCKED user's id, and when the block was
+ *  created (ISO string). Blocks are directional; the blocker is always the
+ *  verified caller and never appears on the row. */
+export interface RoomUserBlock {
+  id: string;
+  blockedId: string;
+  createdAt: string;
+}
+
+/** A newest-first page of the caller's blocks plus the composite cursor
+ *  (same paging contract as the notification inbox: feed lastCursor and
+ *  lastCursorId back together; both null on an empty page). */
+export interface RoomUserBlocksResult {
+  blocks: RoomUserBlock[];
+  hasMore: boolean;
+  lastCursor: string | null;
+  lastCursorId: string | null;
+}
+
+/** The row echoed by a bookmark save. `createdAt` is null only when a
+ *  concurrent remove raced the save (the save still happened). */
+export interface RoomBookmarkSaved {
+  roomId: string;
+  seq: number;
+  createdAt: string | null;
+}
+
+/** The store's REST poll summary: the ledger-entry wire shape plus the
+ *  store's monotonic ordering revision (create = 0, bumped per mutation).
+ *  The relay strips revision before entries reach the WS surface, so only
+ *  REST consumers see it; use it to refuse applying a stale mutation echo
+ *  over newer state. Optional because rows written before the field read
+ *  without it. */
+export type RoomRestPollSummary = RoomPollSummary & {
+  revision?: number | undefined;
+};
+
+/**
+ * A persisted room event as the store's REST surfaces return it: the stored
+ * row with its wire names verbatim (roomId/senderId/sender/createdAt, store
+ * event kinds like 'message'), minus the server-internal fields the store's
+ * publicRoomEvent projection strips. This is NOT the relay's mapped
+ * RoomLedgerEntry (room/handle/ts, type 'post'); the two shapes never mix.
+ * Only the identity core is guaranteed: non-visible bookmark targets arrive
+ * as content-free tombstones, and older rows predate newer columns.
+ */
+export interface RoomRestEvent {
+  roomId: string;
+  seq: number;
+  /** The store's event kinds, not the relay's mapped entry types. */
+  type: "message" | "system_market" | "moderation" | "secret";
+  senderId: string;
+  /** Write-time sender snapshot (denormalized; never re-resolved). */
+  sender: {
+    userId: string;
+    username: string;
+    handle: string;
+    isAgent: boolean;
+    role?: string | null | undefined;
+  };
+  createdAt: string;
+  updatedAt: string;
+  /** Absent on content-free tombstones. */
+  text?: string | undefined;
+  /** The store's body blob. Room attachments live at body.attachments
+   *  (sanitized for the viewer), never top-level like the ledger entry's. */
+  body?: Record<string, unknown> | undefined;
+  secret?: RoomLedgerSecretPayload | null | undefined;
+  cashtags?: string[] | undefined;
+  entities?: string[] | undefined;
+  reactions?: Array<{ emoji: string; count: number }> | undefined;
+  /** Counts-only poll summary (additive; the same wire shape the ledger
+   *  entry carries plus the store's ordering revision). */
+  poll?: RoomRestPollSummary | null | undefined;
+  /** Server-rendered link unfurl cards (additive). */
+  unfurls?: RoomUnfurl[] | undefined;
+  replyToSeq?: number | null | undefined;
+  topicId?: string | null | undefined;
+  replyCount?: number | undefined;
+  lastReplyAt?: string | null | undefined;
+  pinned?: boolean | undefined;
+  visibility?: "visible" | "soft_deleted" | "hidden" | "held" | undefined;
+  /** Present only when the viewer holds view-audit on the room. */
+  moderationState?: "clean" | "flagged" | "reported" | "actioned" | undefined;
+  clientMsgId?: string | null | undefined;
+  editedAt?: string | null | undefined;
+  deletedAt?: string | null | undefined;
+  deletedBy?: string | null | undefined;
+}
+
+/** One saved message on the cross-room bookmark list, with the bookmarked
+ *  event hydrated server-side in the store's public row shape (non-visible
+ *  targets arrive as content-free tombstones, exactly like the room's own
+ *  read surfaces). */
+export interface RoomBookmark {
+  roomId: string;
+  seq: number;
+  createdAt: string;
+  event: RoomRestEvent;
+}
+
+/** A newest-first bookmark page plus the composite cursor. `total` is the
+ *  raw row count capped server-side: a bounded hint, not an exact readable
+ *  total (rows in rooms the caller can no longer read are subtracted from
+ *  pages but still count). */
+export interface RoomBookmarksResult {
+  bookmarks: RoomBookmark[];
+  hasMore: boolean;
+  lastCursor: string | null;
+  lastCursorId: string | null;
+  total: number;
+}
+
+/** Voter identities for one poll option, fetched on demand (the entry's
+ *  poll summary carries counts only). */
+export interface RoomPollOptionVoters {
+  optionId: string;
+  users: Array<{ userId: string; handle: string }>;
+  count: number;
+}
+
+export interface RoomPollVotersResult {
+  room: string;
+  seq: number;
+  voters: RoomPollOptionVoters[];
+  /** The authenticated caller's own current ballot, from an exact point
+   *  read: independent of the bounded voter-identity window and of any
+   *  optionId filter. Empty when the caller holds no ballot. This is the
+   *  reload/recovery source of truth for rendering one's own vote. */
+  viewerOptionIds: string[];
+}
+
+/** Recipient-local daily push-suppression window (notify settings). */
+export interface RoomNotifyQuietHours {
+  enabled: boolean;
+  /** Minutes after local midnight, 0..1439. */
+  startMinutes: number;
+  /** Minutes after local midnight, 0..1439. May wrap past midnight. */
+  endMinutes: number;
+  /** IANA time zone name, 1..64 chars (server-probed against Intl). */
+  tz: string;
+}
+
+/** Per-space override entry on the rooms notification settings. */
+export interface RoomSpaceNotificationOverride {
+  suppressMassMentions?: boolean | undefined;
+  attention?: RoomTopicAttention | undefined;
+  /** Timed-mute expiry (ISO date). Meaningful only beside attention 'mute';
+   *  normalization drops it otherwise. The settings surface echoes the
+   *  CONFIGURED expiry, lapsed or not (a configuration read, not an
+   *  effective-state read). */
+  muteUntil?: string | undefined;
+}
+
+/** The store-owned `user_settings.notificationSettings.rooms` shape behind
+ *  GET/PUT /users/notification-settings. PUT is always the FULL object;
+ *  absent fields take their contract defaults. */
+export interface RoomsNotificationSettings {
+  dm: boolean;
+  mention: boolean;
+  reply: boolean;
+  /** Case-insensitive word-boundary keywords, capped at 50. */
+  keywords: string[];
+  spaceOverrides: Record<string, RoomSpaceNotificationOverride>;
+  /** Absent means no quiet-hours window is configured. */
+  quietHours?: RoomNotifyQuietHours | undefined;
+}
+
 /** A living markdown doc scoped to a space (head state; content on demand). */
 export interface RoomDoc {
   docId: string;

package/src/types.ts

@@ -44,6 +44,8 @@ export type {
   RoomModerateMemberPayload,
   RoomMutedPayload,
   RoomPinsPayload,
+  RoomPollOption,
+  RoomPollSummary,
   RoomPresenceDeltaPayload,
   RoomPresencePayload,
   RoomReactorsPayload,
@@ -80,6 +82,7 @@ export type {
   RoomTopicsResultPayload,
   RoomTopicUpdatedPayload,
   RoomTypingPayload,
+  RoomUnfurl,
   RoomUserStatus,
   RoomWhoPayload,
 } from "./shared/rooms-protocol.js";