@poolse/sdk 2.0.2 → 2.0.5

package/dist/index.d.cts

@@ -38,6 +38,18 @@ interface Conversation {
     settings: Record<string, unknown>;
     /** Most recent message's `inserted_at`; null until first message. */
     last_message_at: IsoDateTime | null;
+    /**
+     * Plaintext preview of the most recent message body, truncated to
+     * 80 chars. Updated server-side by `send_message`. Null when the
+     * conversation has no messages, or when the last message had no
+     * body (in which case `"📎 Attachment"` etc is returned).
+     *
+     * Note: stored unencrypted on the server (deliberate denorm so
+     * the conversation list doesn't pay a per-row decrypt). Apps with
+     * full at-rest-encryption requirements should ignore this field
+     * and render their own preview client-side.
+     */
+    last_message_preview: string | null;
     /** Monotonic per-conversation sequence counter (last message's `sequence`). */
     last_sequence: number;
     /**
@@ -47,6 +59,15 @@ interface Conversation {
      * conversation is fetched via other paths.
      */
     unread_count?: number;
+    /**
+     * Tenant `external_id`s of every member, in no particular order.
+     * Populated by code paths that preload the memberships
+     * (`chat.conversations.list()`); may be `[]` on responses where
+     * memberships weren't preloaded (webhook payloads, some create
+     * responses). Use this to render the other-party name on a direct
+     * conversation row without a separate `useMembers` call.
+     */
+    member_external_ids?: string[];
     inserted_at: IsoDateTime;
     updated_at: IsoDateTime;
 }
@@ -489,6 +510,21 @@ interface MentionEvent {
  * full conversation row.
  */
 type ConversationCreatedEvent = Conversation;
+/**
+ * Pushed on `user:<id>` whenever a conversation's surface state
+ * changes — currently fires after every `send_message`. Lets the
+ * conversation-list view update `last_message_preview` /
+ * `last_message_at` / `last_sequence` and bump the unread badge
+ * without a refetch.
+ *
+ * `by_user_id` is the message sender's internal id, so clients can
+ * leave their own unread at 0 (the server already advanced their
+ * read cursor in the same transaction).
+ */
+interface ConversationUpdatedEvent {
+    conversation: Conversation;
+    by_user_id: Uuid | null;
+}
 /** Phoenix Presence list shape. */
 type PresenceSnapshot = Record<Uuid, {
     metas: Array<{
@@ -617,8 +653,10 @@ declare class UserChannel {
     private readonly channel;
     private readonly mentionListeners;
     private readonly conversationCreatedListeners;
+    private readonly conversationUpdatedListeners;
     private mentionBound;
     private conversationCreatedBound;
+    private conversationUpdatedBound;
     constructor(userId: string, channel: Channel);
     onMention(fn: (evt: MentionEvent) => void): Unsubscribe;
     /**
@@ -630,6 +668,17 @@ declare class UserChannel {
      * prepend it to a local list without a refetch.
      */
     onConversationCreated(fn: (conv: ConversationCreatedEvent) => void): Unsubscribe;
+    /**
+     * Subscribe to "an existing conversation changed" notifications —
+     * fires after every `send_message` in any conversation you're a
+     * member of. Use this to update the conversation-list row's last
+     * message preview, timestamp, and unread badge without polling.
+     *
+     * Compare `evt.by_user_id` to your own user id to decide whether
+     * to increment a local unread counter; the server already keeps
+     * your own outbound messages out of your unread count.
+     */
+    onConversationUpdated(fn: (evt: ConversationUpdatedEvent) => void): Unsubscribe;
     /** @internal */
     _join(): void;
     /** @internal */
@@ -1020,4 +1069,4 @@ declare const version = "2.0.2";
 
 declare function safeUuid(): string;
 
-export { type AddMemberOptions, ApiError, type Attachment, type AttachmentDownloadResponse, AttachmentHandle, type AttachmentOptions, type AttachmentProgressEvent, type AttachmentStatus, type AttachmentUploadInput, type AttachmentUploadRequest, type AttachmentUploadResponse, AttachmentsResource, AuthError, type Conversation, ConversationChannel, type ConversationCreateRequest, type ConversationCreatedEvent, ConversationHandle, type ConversationList, ConversationMessages, type ConversationType, type ConversationUpdateRequest, ConversationsResource, type ErrorEnvelope, type IsoDateTime, type Me, MeResource, type MemberReadEvent, type MemberRole, type Membership, type MembershipCreateRequest, type MembershipList, type MentionEvent, type Message, type MessageCreateRequest, type MessageDeletedEvent, MessageHandle, type MessageList, type MessageNewEvent, type MessageType, type MessageUpdateRequest, type MessageUpdatedEvent, MessagesResource, NetworkError, POOLSE_API_URL, Poolse, type PoolseConfig, PoolseError, PoolseRealtime, type PoolseUserProfile, type PresenceSnapshot, type QuotedMessagePreview, RateLimitedError, type ReactionEvent, type ReactionRequest, type ReadRequest, type RealtimeStatus, type TypingEvent, type Unsubscribe, UserChannel, UsersResource, type Uuid, safeUuid, version };
+export { type AddMemberOptions, ApiError, type Attachment, type AttachmentDownloadResponse, AttachmentHandle, type AttachmentOptions, type AttachmentProgressEvent, type AttachmentStatus, type AttachmentUploadInput, type AttachmentUploadRequest, type AttachmentUploadResponse, AttachmentsResource, AuthError, type Conversation, ConversationChannel, type ConversationCreateRequest, type ConversationCreatedEvent, ConversationHandle, type ConversationList, ConversationMessages, type ConversationType, type ConversationUpdateRequest, type ConversationUpdatedEvent, ConversationsResource, type ErrorEnvelope, type IsoDateTime, type Me, MeResource, type MemberReadEvent, type MemberRole, type Membership, type MembershipCreateRequest, type MembershipList, type MentionEvent, type Message, type MessageCreateRequest, type MessageDeletedEvent, MessageHandle, type MessageList, type MessageNewEvent, type MessageType, type MessageUpdateRequest, type MessageUpdatedEvent, MessagesResource, NetworkError, POOLSE_API_URL, Poolse, type PoolseConfig, PoolseError, PoolseRealtime, type PoolseUserProfile, type PresenceSnapshot, type QuotedMessagePreview, RateLimitedError, type ReactionEvent, type ReactionRequest, type ReadRequest, type RealtimeStatus, type TypingEvent, type Unsubscribe, UserChannel, UsersResource, type Uuid, safeUuid, version };

package/dist/index.d.ts

@@ -38,6 +38,18 @@ interface Conversation {
     settings: Record<string, unknown>;
     /** Most recent message's `inserted_at`; null until first message. */
     last_message_at: IsoDateTime | null;
+    /**
+     * Plaintext preview of the most recent message body, truncated to
+     * 80 chars. Updated server-side by `send_message`. Null when the
+     * conversation has no messages, or when the last message had no
+     * body (in which case `"📎 Attachment"` etc is returned).
+     *
+     * Note: stored unencrypted on the server (deliberate denorm so
+     * the conversation list doesn't pay a per-row decrypt). Apps with
+     * full at-rest-encryption requirements should ignore this field
+     * and render their own preview client-side.
+     */
+    last_message_preview: string | null;
     /** Monotonic per-conversation sequence counter (last message's `sequence`). */
     last_sequence: number;
     /**
@@ -47,6 +59,15 @@ interface Conversation {
      * conversation is fetched via other paths.
      */
     unread_count?: number;
+    /**
+     * Tenant `external_id`s of every member, in no particular order.
+     * Populated by code paths that preload the memberships
+     * (`chat.conversations.list()`); may be `[]` on responses where
+     * memberships weren't preloaded (webhook payloads, some create
+     * responses). Use this to render the other-party name on a direct
+     * conversation row without a separate `useMembers` call.
+     */
+    member_external_ids?: string[];
     inserted_at: IsoDateTime;
     updated_at: IsoDateTime;
 }
@@ -489,6 +510,21 @@ interface MentionEvent {
  * full conversation row.
  */
 type ConversationCreatedEvent = Conversation;
+/**
+ * Pushed on `user:<id>` whenever a conversation's surface state
+ * changes — currently fires after every `send_message`. Lets the
+ * conversation-list view update `last_message_preview` /
+ * `last_message_at` / `last_sequence` and bump the unread badge
+ * without a refetch.
+ *
+ * `by_user_id` is the message sender's internal id, so clients can
+ * leave their own unread at 0 (the server already advanced their
+ * read cursor in the same transaction).
+ */
+interface ConversationUpdatedEvent {
+    conversation: Conversation;
+    by_user_id: Uuid | null;
+}
 /** Phoenix Presence list shape. */
 type PresenceSnapshot = Record<Uuid, {
     metas: Array<{
@@ -617,8 +653,10 @@ declare class UserChannel {
     private readonly channel;
     private readonly mentionListeners;
     private readonly conversationCreatedListeners;
+    private readonly conversationUpdatedListeners;
     private mentionBound;
     private conversationCreatedBound;
+    private conversationUpdatedBound;
     constructor(userId: string, channel: Channel);
     onMention(fn: (evt: MentionEvent) => void): Unsubscribe;
     /**
@@ -630,6 +668,17 @@ declare class UserChannel {
      * prepend it to a local list without a refetch.
      */
     onConversationCreated(fn: (conv: ConversationCreatedEvent) => void): Unsubscribe;
+    /**
+     * Subscribe to "an existing conversation changed" notifications —
+     * fires after every `send_message` in any conversation you're a
+     * member of. Use this to update the conversation-list row's last
+     * message preview, timestamp, and unread badge without polling.
+     *
+     * Compare `evt.by_user_id` to your own user id to decide whether
+     * to increment a local unread counter; the server already keeps
+     * your own outbound messages out of your unread count.
+     */
+    onConversationUpdated(fn: (evt: ConversationUpdatedEvent) => void): Unsubscribe;
     /** @internal */
     _join(): void;
     /** @internal */
@@ -1020,4 +1069,4 @@ declare const version = "2.0.2";
 
 declare function safeUuid(): string;
 
-export { type AddMemberOptions, ApiError, type Attachment, type AttachmentDownloadResponse, AttachmentHandle, type AttachmentOptions, type AttachmentProgressEvent, type AttachmentStatus, type AttachmentUploadInput, type AttachmentUploadRequest, type AttachmentUploadResponse, AttachmentsResource, AuthError, type Conversation, ConversationChannel, type ConversationCreateRequest, type ConversationCreatedEvent, ConversationHandle, type ConversationList, ConversationMessages, type ConversationType, type ConversationUpdateRequest, ConversationsResource, type ErrorEnvelope, type IsoDateTime, type Me, MeResource, type MemberReadEvent, type MemberRole, type Membership, type MembershipCreateRequest, type MembershipList, type MentionEvent, type Message, type MessageCreateRequest, type MessageDeletedEvent, MessageHandle, type MessageList, type MessageNewEvent, type MessageType, type MessageUpdateRequest, type MessageUpdatedEvent, MessagesResource, NetworkError, POOLSE_API_URL, Poolse, type PoolseConfig, PoolseError, PoolseRealtime, type PoolseUserProfile, type PresenceSnapshot, type QuotedMessagePreview, RateLimitedError, type ReactionEvent, type ReactionRequest, type ReadRequest, type RealtimeStatus, type TypingEvent, type Unsubscribe, UserChannel, UsersResource, type Uuid, safeUuid, version };
+export { type AddMemberOptions, ApiError, type Attachment, type AttachmentDownloadResponse, AttachmentHandle, type AttachmentOptions, type AttachmentProgressEvent, type AttachmentStatus, type AttachmentUploadInput, type AttachmentUploadRequest, type AttachmentUploadResponse, AttachmentsResource, AuthError, type Conversation, ConversationChannel, type ConversationCreateRequest, type ConversationCreatedEvent, ConversationHandle, type ConversationList, ConversationMessages, type ConversationType, type ConversationUpdateRequest, type ConversationUpdatedEvent, ConversationsResource, type ErrorEnvelope, type IsoDateTime, type Me, MeResource, type MemberReadEvent, type MemberRole, type Membership, type MembershipCreateRequest, type MembershipList, type MentionEvent, type Message, type MessageCreateRequest, type MessageDeletedEvent, MessageHandle, type MessageList, type MessageNewEvent, type MessageType, type MessageUpdateRequest, type MessageUpdatedEvent, MessagesResource, NetworkError, POOLSE_API_URL, Poolse, type PoolseConfig, PoolseError, PoolseRealtime, type PoolseUserProfile, type PresenceSnapshot, type QuotedMessagePreview, RateLimitedError, type ReactionEvent, type ReactionRequest, type ReadRequest, type RealtimeStatus, type TypingEvent, type Unsubscribe, UserChannel, UsersResource, type Uuid, safeUuid, version };

package/dist/index.js

@@ -356,8 +356,10 @@ var UserChannel = class {
   channel;
   mentionListeners = /* @__PURE__ */ new Set();
   conversationCreatedListeners = /* @__PURE__ */ new Set();
+  conversationUpdatedListeners = /* @__PURE__ */ new Set();
   mentionBound = false;
   conversationCreatedBound = false;
+  conversationUpdatedBound = false;
   constructor(userId, channel) {
     this.userId = userId;
     this.channel = channel;
@@ -394,6 +396,28 @@ var UserChannel = class {
       this.conversationCreatedListeners.delete(fn);
     };
   }
+  /**
+   * Subscribe to "an existing conversation changed" notifications —
+   * fires after every `send_message` in any conversation you're a
+   * member of. Use this to update the conversation-list row's last
+   * message preview, timestamp, and unread badge without polling.
+   *
+   * Compare `evt.by_user_id` to your own user id to decide whether
+   * to increment a local unread counter; the server already keeps
+   * your own outbound messages out of your unread count.
+   */
+  onConversationUpdated(fn) {
+    if (!this.conversationUpdatedBound) {
+      this.conversationUpdatedBound = true;
+      this.channel.on("conversation:updated", (payload) => {
+        this.conversationUpdatedListeners.forEach((l) => l(payload));
+      });
+    }
+    this.conversationUpdatedListeners.add(fn);
+    return () => {
+      this.conversationUpdatedListeners.delete(fn);
+    };
+  }
   /** @internal */
   _join() {
     this.channel.join();
@@ -402,6 +426,7 @@ var UserChannel = class {
   _destroy() {
     this.mentionListeners.clear();
     this.conversationCreatedListeners.clear();
+    this.conversationUpdatedListeners.clear();
     this.channel.leave();
   }
 };