@talkjs/core 1.5.3 → 1.5.5

package/dist/talkSession.d.ts

@@ -8,16 +8,16 @@
  * @public
  */
 export declare interface ActionButtonNode {
-    type: "actionButton";
+    readonly type: "actionButton";
     /**
      * The name of the custom action to invoke when the button is clicked.
      */
-    action: string;
+    readonly action: string;
     /**
      * The parameters to pass to the custom action when the button is clicked.
      */
-    params: Record<string, string>;
-    children: TextNode[];
+    readonly params: Record<string, string>;
+    readonly children: TextNode[];
 }
 
 /**
@@ -30,16 +30,16 @@ export declare interface ActionButtonNode {
  * @public
  */
 export declare interface ActionLinkNode {
-    type: "actionLink";
+    readonly type: "actionLink";
     /**
      * The name of the custom action to invoke when the link is clicked.
      */
-    action: string;
+    readonly action: string;
     /**
      * The parameters to pass to the custom action when the link is clicked.
      */
-    params: Record<string, string>;
-    children: TextNode[];
+    readonly params: Record<string, string>;
+    readonly children: TextNode[];
 }
 
 /**
@@ -60,28 +60,28 @@ export declare interface ActionLinkNode {
  * @public
  */
 export declare interface AudioBlock {
-    type: "file";
-    subtype: "audio";
+    readonly type: "file";
+    readonly subtype: "audio";
     /**
      * An encoded identifier for this file. Use in {@link SendFileBlock} to send this file in another message.
      */
-    fileToken: FileToken;
+    readonly fileToken: FileToken;
     /**
      * The URL where you can fetch the file
      */
-    url: string;
+    readonly url: string;
     /**
      * The size of the file in bytes
      */
-    size: number;
+    readonly size: number;
     /**
      * The name of the audio file, including file extension
      */
-    filename: string;
+    readonly filename: string;
     /**
      * The duration of the audio in seconds, if known
      */
-    duration?: number;
+    readonly duration?: number;
 }
 
 export declare interface AudioFileMetadata {
@@ -130,15 +130,15 @@ export declare interface AudioFileMetadata {
  * @public
  */
 export declare interface AutoLinkNode {
-    type: "autoLink";
+    readonly type: "autoLink";
     /**
      * The URL to open when a user clicks this node.
      */
-    url: string;
+    readonly url: string;
     /**
      * The text to display in the link.
      */
-    text: string;
+    readonly text: string;
 }
 
 /**
@@ -150,8 +150,8 @@ export declare interface AutoLinkNode {
  * @public
  */
 export declare interface BulletListNode {
-    type: "bulletList";
-    children: TextNode[];
+    readonly type: "bulletList";
+    readonly children: TextNode[];
 }
 
 /**
@@ -163,8 +163,8 @@ export declare interface BulletListNode {
  * @public
  */
 export declare interface BulletPointNode {
-    type: "bulletPoint";
-    children: TextNode[];
+    readonly type: "bulletPoint";
+    readonly children: TextNode[];
 }
 
 /**
@@ -176,8 +176,8 @@ export declare interface BulletPointNode {
  * @public
  */
 export declare interface CodeSpanNode {
-    type: "codeSpan";
-    text: string;
+    readonly type: "codeSpan";
+    readonly text: string;
 }
 
 /**
@@ -207,11 +207,11 @@ export declare type ContentBlock = TextBlock | FileBlock | LocationBlock;
  * @public
  */
 export declare interface ConversationActiveState {
-    type: "active";
+    readonly type: "active";
     /**
      * The most recently received snapshot for the conversation, or `null` if you are not a participant in the conversation (including when the conversation does not exist).
      */
-    latestSnapshot: ConversationSnapshot | null;
+    readonly latestSnapshot: ConversationSnapshot | null;
 }
 
 /**
@@ -220,16 +220,16 @@ export declare interface ConversationActiveState {
  * @public
  */
 export declare interface ConversationListActiveState {
-    type: "active";
+    readonly type: "active";
     /**
      * The most recently received snapshot for the conversations
      */
-    latestSnapshot: ConversationSnapshot[];
+    readonly latestSnapshot: ConversationSnapshot[];
     /**
      * True if `latestSnapshot` contains all conversations you are in.
      * Use {@link ConversationListSubscription.loadMore} to load more.
      */
-    loadedAll: boolean;
+    readonly loadedAll: boolean;
 }
 
 /**
@@ -275,14 +275,14 @@ export declare interface ConversationListSubscription {
      *
      * The promise rejects if the subscription is terminated before it connects.
      */
-    connected: Promise<ConversationListActiveState>;
+    readonly connected: Promise<ConversationListActiveState>;
     /**
      * Resolves when the subscription permanently stops receiving updates from the server.
      *
      * @remarks
      * This is either because you unsubscribed or because the subscription encountered an unrecoverable error.
      */
-    terminated: Promise<UnsubscribedState | ErrorState>;
+    readonly terminated: Promise<UnsubscribedState | ErrorState>;
     /**
      * Expand the window to include older conversations
      *
@@ -307,12 +307,19 @@ export declare interface ConversationListSubscription {
 }
 
 /**
- * References the conversation with a given conversation ID, from the perspective of the current user.
+ * References the current user's view of the conversation with a given conversation ID.
  *
  * @remarks
  * Used in all Data API operations affecting that conversation, such as fetching or updating conversation attributes.
  * Created via {@link Session.conversation|Session.conversation()}.
  *
+ * Important note: ConversationRef is a reference to *the current user's view* of the conversation.
+ *
+ * If they are not a participant, "their view" of the conversation does not exist.
+ * This means that {@link ConversationRef.get|ConversationRef.get()} will return null.
+ * Additionally, it means that {@link ConversationRef.set|set()} and {@link ConversationRef.createIfNotExists|createIfNotExists()} will add the current user as a participant, in order to create "their view" of the conversation.
+ * For more details, see the documentation for those methods.
+ *
  * @public
  */
 export declare interface ConversationRef {
@@ -358,6 +365,7 @@ export declare interface ConversationRef {
      * @remarks
      * Use this if you need to fetch, delete, or edit a specific message in this conversation, and you know its message ID.
      * To fetch the most recent messages in this conversation, use {@link ConversationRef.subscribeMessages} instead.
+     * To send a message, use {@link ConversationRef.send}.
      *
      * @param id - The ID of the message that you want to reference
      * @returns A {@linkcode MessageRef} for the message with that ID in this conversation
@@ -375,11 +383,12 @@ export declare interface ConversationRef {
      */
     get(): Promise<ConversationSnapshot | null>;
     /**
-     * Sets properties of this conversation and your participation in it.
+     * Sets properties of this conversation and the current user's participation.
      *
      * @remarks
-     * The conversation is created if a conversation with this ID doesn't already exist.
-     * You are added as a participant if you are not already a participant in the conversation.
+     * If this conversation does not already exist, it will be created.
+     *
+     * If the user is not currently a participant in this conversation, they will be added.
      *
      * @returns A promise that resolves when the operation completes.
      * When client-side conversation syncing is disabled, you must already be a participant and you cannot set anything except the `notify` property.
@@ -587,39 +596,43 @@ export declare interface ConversationSnapshot {
     /**
      * The ID of the conversation
      */
-    id: string;
+    readonly id: string;
     /**
      * Contains the conversation subject, or `null` if the conversation does not have a subject specified.
      */
-    subject: string | null;
+    readonly subject: string | null;
     /**
      * Contains the URL of a photo to represent the topic of the conversation or `null` if the conversation does not have a photo specified.
      */
-    photoUrl: string | null;
+    readonly photoUrl: string | null;
     /**
-     * One or more welcome messages that will display to the user as a SystemMessage
+     * One or more welcome messages that will be rendered at the start of this conversation as system messages.
+     *
+     * @remarks
+     * Welcome messages are rendered in the UI as messages, but they are not real messages.
+     * This means they do not appear when you list messages using the REST API or JS Data API, and you cannot reply or react to them.
      */
-    welcomeMessages: string[];
+    readonly welcomeMessages: string[];
     /**
      * Custom metadata you have set on the conversation
      */
-    custom: Record<string, string>;
+    readonly custom: Record<string, string>;
     /**
      * The date that the conversation was created, as a unix timestamp in milliseconds.
      */
-    createdAt: number;
+    readonly createdAt: number;
     /**
      * The date that the current user joined the conversation, as a unix timestamp in milliseconds.
      */
-    joinedAt: number;
+    readonly joinedAt: number;
     /**
      * The last message sent in this conversation, or null if no messages have been sent.
      */
-    lastMessage: MessageSnapshot | null;
+    readonly lastMessage: MessageSnapshot | null;
     /**
      * The number of messages in this conversation that the current user hasn't read.
      */
-    unreadMessageCount: number;
+    readonly unreadMessageCount: number;
     /**
      * The most recent date that the current user read the conversation.
      *
@@ -628,7 +641,7 @@ export declare interface ConversationSnapshot {
      *
      * Any messages sent after this timestamp are unread messages.
      */
-    readUntil: number;
+    readonly readUntil: number;
     /**
      * Everyone in the conversation has read any messages sent on or before this date.
      *
@@ -639,25 +652,25 @@ export declare interface ConversationSnapshot {
      * This value will rarely change in very large conversations.
      * If just one person stops checking their messages, `everyoneReadUntil` will never update.
      */
-    everyoneReadUntil: number;
+    readonly everyoneReadUntil: number;
     /**
      * Whether the conversation should be considered unread.
      *
      * @remarks
      * This can be true even when `unreadMessageCount` is zero, if the user has manually marked the conversation as unread.
      */
-    isUnread: boolean;
+    readonly isUnread: boolean;
     /**
      * The current user's permission level in this conversation.
      */
-    access: "Read" | "ReadWrite";
+    readonly access: "Read" | "ReadWrite";
     /**
      * The current user's notification settings for this conversation.
      *
      * @remarks
      * `false` means no notifications, `true` means notifications for all messages, and `"MentionsOnly"` means that the user will only be notified when they are mentioned with an `@`.
      */
-    notify: boolean | "MentionsOnly";
+    readonly notify: boolean | "MentionsOnly";
 }
 
 /**
@@ -688,14 +701,14 @@ export declare interface ConversationSubscription {
     /**
      * Resolves when the subscription starts receiving updates from the server.
      */
-    connected: Promise<ConversationActiveState>;
+    readonly connected: Promise<ConversationActiveState>;
     /**
      * Resolves when the subscription permanently stops receiving updates from the server.
      *
      * @remarks
      * This is either because you unsubscribed or because the subscription encountered an unrecoverable error.
      */
-    terminated: Promise<UnsubscribedState | ErrorState>;
+    readonly terminated: Promise<UnsubscribedState | ErrorState>;
     /**
      * Unsubscribe from this resource and stop receiving updates.
      *
@@ -726,6 +739,10 @@ export declare interface CreateConversationParams {
     /**
      * System messages which are sent at the beginning of a conversation.
      * Default = no messages.
+     *
+     * @remarks
+     * Welcome messages are rendered in the UI as messages, but they are not real messages.
+     * This means they do not appear when you list messages using the REST API or JS Data API, and you cannot reply or react to them.
      */
     welcomeMessages?: string[];
     /**
@@ -807,6 +824,10 @@ export declare interface CreateUserParams {
     /**
      * The default message a person sees when starting a chat with this user.
      * Default = no welcome message
+     *
+     * @remarks
+     * Welcome messages are rendered in the UI as messages, but they are not real messages.
+     * This means they do not appear when you list messages using the REST API or JS Data API, and you cannot reply or react to them.
      */
     welcomeMessage?: string;
     /**
@@ -837,11 +858,11 @@ export declare interface CreateUserParams {
  * @public
  */
 export declare interface CustomEmojiNode {
-    type: "customEmoji";
+    readonly type: "customEmoji";
     /**
      * The name (including colons at the start and end) of the custom emoji to show.
      */
-    text: string;
+    readonly text: string;
 }
 
 /**
@@ -909,11 +930,11 @@ export declare interface EditTextMessageParams {
  * @public
  */
 export declare interface ErrorState {
-    type: "error";
+    readonly type: "error";
     /**
      * The error that caused the subscription to be terminated
      */
-    error: Error;
+    readonly error: Error;
 }
 
 /**
@@ -926,7 +947,7 @@ export declare interface FewTypingSnapshot {
      * @remarks
      * When `false`, you can see the list of users who are typing in the `users` property.
      */
-    many: false;
+    readonly many: false;
     /**
      * The users who are currently typing in this conversation.
      *
@@ -934,7 +955,7 @@ export declare interface FewTypingSnapshot {
      * The list is in chronological order, starting with the users who have been typing the longest.
      * The current user is never contained in the list, only other users.
      */
-    users: UserSnapshot[];
+    readonly users: UserSnapshot[];
 }
 
 /**
@@ -997,7 +1018,7 @@ export declare type FileBlock = VideoBlock | ImageBlock | AudioBlock | VoiceBloc
  * @public
  */
 export declare type FileToken = string & {
-    __tag: Record<"TalkJS Encoded File Token", true>;
+    readonly __tag: Record<"TalkJS Encoded File Token", true>;
 };
 
 /**
@@ -1025,27 +1046,27 @@ export declare type FileToken = string & {
  * @public
  */
 export declare interface GenericFileBlock {
-    type: "file";
+    readonly type: "file";
     /**
      * Never set for generic file blocks.
      */
-    subtype?: never;
+    readonly subtype?: never;
     /**
      * An encoded identifier for this file. Use in {@link SendFileBlock} to send this file in another message.
      */
-    fileToken: FileToken;
+    readonly fileToken: FileToken;
     /**
      * The URL where you can fetch the file
      */
-    url: string;
+    readonly url: string;
     /**
      * The size of the file in bytes
      */
-    size: number;
+    readonly size: number;
     /**
      * The name of the file, including file extension
      */
-    filename: string;
+    readonly filename: string;
 }
 
 export declare interface GenericFileMetadata {
@@ -1081,32 +1102,32 @@ export declare function getTalkSession(options: TalkSessionOptions): TalkSession
  * @public
  */
 export declare interface ImageBlock {
-    type: "file";
-    subtype: "image";
+    readonly type: "file";
+    readonly subtype: "image";
     /**
      * An encoded identifier for this file. Use in {@link SendFileBlock} to send this image in another message.
      */
-    fileToken: FileToken;
+    readonly fileToken: FileToken;
     /**
      * The URL where you can fetch the file.
      */
-    url: string;
+    readonly url: string;
     /**
      * The size of the file in bytes.
      */
-    size: number;
+    readonly size: number;
     /**
      * The name of the image file, including file extension.
      */
-    filename: string;
+    readonly filename: string;
     /**
      * The width of the image in pixels, if known.
      */
-    width?: number;
+    readonly width?: number;
     /**
      * The height of the image in pixels, if known.
      */
-    height?: number;
+    readonly height?: number;
 }
 
 export declare interface ImageFileMetadata {
@@ -1133,12 +1154,12 @@ export declare interface ImageFileMetadata {
  * @public
  */
 export declare interface LinkNode {
-    type: "link";
+    readonly type: "link";
     /**
      * The URL to open when the node is clicked.
      */
-    url: string;
-    children: TextNode[];
+    readonly url: string;
+    readonly children: TextNode[];
 }
 
 /**
@@ -1151,7 +1172,7 @@ export declare interface LinkNode {
  * @public
  */
 export declare interface LocationBlock {
-    type: "location";
+    readonly type: "location";
     /**
      * The north-south coordinate of the location.
      *
@@ -1160,7 +1181,7 @@ export declare interface LocationBlock {
      *
      * Must be a number between -90 and 90
      */
-    latitude: number;
+    readonly latitude: number;
     /**
      * The east-west coordinate of the location.
      *
@@ -1169,7 +1190,7 @@ export declare interface LocationBlock {
      *
      * Must be a number between -180 and 180
      */
-    longitude: number;
+    readonly longitude: number;
 }
 
 /**
@@ -1183,7 +1204,7 @@ export declare interface ManyTypingSnapshot {
      * When `true`, you do not receive a list of users who are typing.
      * You should show a message like "several people are typing" instead.
      */
-    many: true;
+    readonly many: true;
 }
 
 /**
@@ -1201,8 +1222,8 @@ export declare interface MarkupNode {
      *
      * - `type: "strikethrough"` is used when users type `~text~` and is rendered with HTML `<s>`
      */
-    type: "bold" | "italic" | "strikethrough";
-    children: TextNode[];
+    readonly type: "bold" | "italic" | "strikethrough";
+    readonly children: TextNode[];
 }
 
 /**
@@ -1214,15 +1235,15 @@ export declare interface MarkupNode {
  * @public
  */
 export declare interface MentionNode {
-    type: "mention";
+    readonly type: "mention";
     /**
      * The ID of the user who is mentioned.
      */
-    id: string;
+    readonly id: string;
     /**
      * The name of the user who is mentioned.
      */
-    text: string;
+    readonly text: string;
 }
 
 /**
@@ -1231,16 +1252,16 @@ export declare interface MentionNode {
  * @public
  */
 export declare interface MessageActiveState {
-    type: "active";
+    readonly type: "active";
     /**
      * The most recently received snapshot for the messages, or `null` if you're not a participant in the conversation.
      */
-    latestSnapshot: MessageSnapshot[] | null;
+    readonly latestSnapshot: MessageSnapshot[] | null;
     /**
      * True if `latestSnapshot` contains all messages in the conversation.
      * Use {@link MessageSubscription.loadMore} to load more.
      */
-    loadedAll: boolean;
+    readonly loadedAll: boolean;
 }
 
 /**
@@ -1295,9 +1316,6 @@ export declare interface MessageRef {
     /**
      * Fetches a snapshot of the message.
      *
-     * @remarks
-     * Supports {@link https://talkjs.com/docs/Reference/JavaScript_Data_API/Performance/#cached-fetch | Cached Fetch}
-     *
      * @returns A snapshot of the message's attributes, or null if the message doesn't exist, the conversation doesn't exist, or you're not a participant in the conversation.
      */
     get(): Promise<MessageSnapshot | null>;
@@ -1332,32 +1350,32 @@ export declare interface MessageSnapshot {
     /**
      * The unique ID that is used to identify the message in TalkJS
      */
-    id: string;
+    readonly id: string;
     /**
      * Whether this message was "from a user" or a general system message without a specific sender.
      *
      * The `sender` property is always present for "UserMessage" messages and never present for "SystemMessage" messages.
      */
-    type: "UserMessage" | "SystemMessage";
+    readonly type: "UserMessage" | "SystemMessage";
     /**
      * A snapshot of the user who sent the message, or null if it is a system message.
      * The user's attributes may have been updated since they sent the message, in which case this snapshot contains the updated data.
      * It is not a historical snapshot.
      */
-    sender: UserSnapshot | null;
+    readonly sender: UserSnapshot | null;
     /**
      * Custom metadata you have set on the message
      */
-    custom: Record<string, string>;
+    readonly custom: Record<string, string>;
     /**
      * Time at which the message was sent, as a unix timestamp in milliseconds
      */
-    createdAt: number;
+    readonly createdAt: number;
     /**
      * Time at which the message was last edited, as a unix timestamp in milliseconds.
      * `null` if the message has never been edited.
      */
-    editedAt: number | null;
+    readonly editedAt: number | null;
     /**
      * A snapshot of the message that this message is a reply to, or null if this message is not a reply.
      *
@@ -1367,7 +1385,7 @@ export declare interface MessageSnapshot {
      * Instead, it has `referencedMessageId`.
      * This prevents TalkJS fetching an unlimited number of messages in a long chain of replies.
      */
-    referencedMessage: ReferencedMessageSnapshot | null;
+    readonly referencedMessage: ReferencedMessageSnapshot | null;
     /**
      * Where this message originated from:
      *
@@ -1379,23 +1397,23 @@ export declare interface MessageSnapshot {
      *
      * - "email" = Message sent by replying to an email notification
      */
-    origin: "web" | "rest" | "import" | "email";
+    readonly origin: "web" | "rest" | "import" | "email";
     /**
      * The contents of the message, as a plain text string without any formatting or attachments.
      * Useful for showing in a conversation list or in notifications.
      */
-    plaintext: string;
+    readonly plaintext: string;
     /**
      * The main body of the message, as a list of blocks that are rendered top-to-bottom.
      */
-    content: ContentBlock[];
+    readonly content: ContentBlock[];
     /**
      * All the emoji reactions that have been added to this message.
      *
      * @remarks
      * There can be up to 50 different reactions on each message.
      */
-    reactions: ReactionSnapshot[];
+    readonly reactions: ReactionSnapshot[];
 }
 
 /**
@@ -1439,14 +1457,14 @@ export declare interface MessageSubscription {
      *
      * The promise rejects if the subscription is terminated before it connects.
      */
-    connected: Promise<MessageActiveState>;
+    readonly connected: Promise<MessageActiveState>;
     /**
      * Resolves when the subscription permanently stops receiving updates from the server.
      *
      * @remarks
      * This is either because you unsubscribed or because the subscription encountered an unrecoverable error.
      */
-    terminated: Promise<UnsubscribedState | ErrorState>;
+    readonly terminated: Promise<UnsubscribedState | ErrorState>;
     /**
      * Expand the window to include older messages
      *
@@ -1475,16 +1493,16 @@ export declare interface MessageSubscription {
  * @public
  */
 export declare interface ParticipantActiveState {
-    type: "active";
+    readonly type: "active";
     /**
      * The most recently received snapshot for the participants, or `null` if you are not a participant in that conversation.
      */
-    latestSnapshot: ParticipantSnapshot[] | null;
+    readonly latestSnapshot: ParticipantSnapshot[] | null;
     /**
      * True if `latestSnapshot` contains all participants in the conversation.
      * Use {@link ParticipantSubscription.loadMore} to load more.
      */
-    loadedAll: boolean;
+    readonly loadedAll: boolean;
 }
 
 /**
@@ -1523,9 +1541,6 @@ export declare interface ParticipantRef {
     /**
      * Sets properties of this participant. If the user is not already a participant in the conversation, they will be added.
      *
-     * @remarks
-     * Supports {@link https://talkjs.com/docs/Reference/JavaScript_Data_API/Performance/#automatic-batching | Automatic Batching}
-     *
      * @returns A promise that resolves when the operation completes.
      * When client-side conversation syncing is disabled, you must already be a participant and you cannot set anything except the `notify` property.
      * Everything else requires client-side conversation syncing to be enabled, and will cause the promise to reject.
@@ -1534,9 +1549,6 @@ export declare interface ParticipantRef {
     /**
      * Edits properties of a pre-existing participant. If the user is not already a participant in the conversation, the promise will reject.
      *
-     * @remarks
-     * Supports {@link https://talkjs.com/docs/Reference/JavaScript_Data_API/Performance/#automatic-batching | Automatic Batching}
-     *
      * @returns A promise that resolves when the operation completes.
      * When client-side conversation syncing is disabled, you must already be a participant and you cannot set anything except the `notify` property.
      * Everything else requires client-side conversation syncing to be enabled, and will cause the promise to reject.
@@ -1548,8 +1560,6 @@ export declare interface ParticipantRef {
      * @remarks
      * If the participant already exists, this operation is still considered successful and the promise will still resolve.
      *
-     * Supports {@link https://talkjs.com/docs/Reference/JavaScript_Data_API/Performance/#automatic-batching | Automatic Batching}
-     *
      * @returns A promise that resolves when the operation completes. The promise will reject if client-side conversation syncing is disabled and the user is not already a participant.
      */
     createIfNotExists(params?: CreateParticipantParams): Promise<void>;
@@ -1578,22 +1588,22 @@ export declare interface ParticipantSnapshot {
     /**
      * The user who this participant snapshot is referring to
      */
-    user: UserSnapshot;
+    readonly user: UserSnapshot;
     /**
      * The level of access this participant has in the conversation.
      */
-    access: "ReadWrite" | "Read";
+    readonly access: "ReadWrite" | "Read";
     /**
      * When the participant will be notified about new messages in this conversation.
      *
      * @remarks
      * `false` means no notifications, `true` means notifications for all messages, and `"MentionsOnly"` means that the user will only be notified when they are mentioned with an `@`.
      */
-    notify: boolean | "MentionsOnly";
+    readonly notify: boolean | "MentionsOnly";
     /**
      * The date that this user joined the conversation, as a unix timestamp in milliseconds.
      */
-    joinedAt: number;
+    readonly joinedAt: number;
 }
 
 /**
@@ -1638,14 +1648,14 @@ export declare interface ParticipantSubscription {
      *
      * The promise rejects if the subscription is terminated before it connects.
      */
-    connected: Promise<ParticipantActiveState>;
+    readonly connected: Promise<ParticipantActiveState>;
     /**
      * Resolves when the subscription permanently stops receiving updates from the server.
      *
      * @remarks
      * This is either because you unsubscribed or because the subscription encountered an unrecoverable error.
      */
-    terminated: Promise<UnsubscribedState | ErrorState>;
+    readonly terminated: Promise<UnsubscribedState | ErrorState>;
     /**
      * Expand the window to include older participants
      *
@@ -1674,7 +1684,7 @@ export declare interface ParticipantSubscription {
  * @public
  */
 export declare interface PendingState {
-    type: "pending";
+    readonly type: "pending";
 }
 
 /**
@@ -1776,15 +1786,15 @@ export declare interface ReactionSnapshot {
      * @example Custom emoji
      * ":cat-roomba:"
      */
-    emoji: string;
+    readonly emoji: string;
     /**
      * The number of times this emoji has been added to the message.
      */
-    count: number;
+    readonly count: number;
     /**
      * Whether the current user has reacted to the message with this emoji.
      */
-    currentUserReacted: boolean;
+    readonly currentUserReacted: boolean;
 }
 
 /**
@@ -1803,11 +1813,11 @@ export declare interface ReferencedMessageSnapshot {
     /**
      * The unique ID that is used to identify the message in TalkJS
      */
-    id: string;
+    readonly id: string;
     /**
      * Referenced messages are always "UserMessage" because you cannot reply to a system message.
      */
-    type: "UserMessage";
+    readonly type: "UserMessage";
     /**
      * A snapshot of the user who sent the message.
      * The user's attributes may have been updated since they sent the message, in which case this snapshot contains the updated data.
@@ -1816,20 +1826,20 @@ export declare interface ReferencedMessageSnapshot {
      * @remarks
      * Guaranteed to be set, unlike in MessageSnapshot, because you cannot reference a SystemMessage
      */
-    sender: UserSnapshot;
+    readonly sender: UserSnapshot;
     /**
      * Custom metadata you have set on the message
      */
-    custom: Record<string, string>;
+    readonly custom: Record<string, string>;
     /**
      * Time at which the message was sent, as a unix timestamp in milliseconds
      */
-    createdAt: number;
+    readonly createdAt: number;
     /**
      * Time at which the message was last edited, as a unix timestamp in milliseconds.
      * `null` if the message has never been edited.
      */
-    editedAt: number | null;
+    readonly editedAt: number | null;
     /**
      * The ID of the message that this message is a reply to, or null if this message is not a reply.
      *
@@ -1837,7 +1847,7 @@ export declare interface ReferencedMessageSnapshot {
      * Since this is a snapshot of a referenced message, we do not automatically expand its referenced message.
      * The ID of its referenced message is provided here instead.
      */
-    referencedMessageId: string | null;
+    readonly referencedMessageId: string | null;
     /**
      * Where this message originated from:
      *
@@ -1849,20 +1859,20 @@ export declare interface ReferencedMessageSnapshot {
      *
      * - "email" = Message sent by replying to an email notification
      */
-    origin: "web" | "rest" | "import" | "email";
+    readonly origin: "web" | "rest" | "import" | "email";
     /**
      * The contents of the message, as a plain text string without any formatting or attachments.
      * Useful for showing in a conversation list or in notifications.
      */
-    plaintext: string;
+    readonly plaintext: string;
     /**
      * The main body of the message, as a list of blocks that are rendered top-to-bottom.
      */
-    content: ContentBlock[];
+    readonly content: ContentBlock[];
     /**
      * All the emoji reactions that have been added to this message.
      */
-    reactions: ReactionSnapshot[];
+    readonly reactions: ReactionSnapshot[];
 }
 
 export declare function registerPolyfills({ WebSocket }: {
@@ -2005,6 +2015,10 @@ export declare interface SetConversationParams {
     /**
      * System messages which are sent at the beginning of a conversation.
      * Default = no messages.
+     *
+     * @remarks
+     * Welcome messages are rendered in the UI as messages, but they are not real messages.
+     * This means they do not appear when you list messages using the REST API or JS Data API, and you cannot reply or react to them.
      */
     welcomeMessages?: string[] | null;
     /**
@@ -2090,6 +2104,10 @@ export declare interface SetUserParams {
     /**
      * The default message a person sees when starting a chat with this user.
      * Default = no welcome message
+     *
+     * @remarks
+     * Welcome messages are rendered in the UI as messages, but they are not real messages.
+     * This means they do not appear when you list messages using the REST API or JS Data API, and you cannot reply or react to them.
      */
     welcomeMessage?: string | null;
     /**
@@ -2347,8 +2365,8 @@ export declare interface TalkSessionOptions {
  * @public
  */
 export declare interface TextBlock {
-    type: "text";
-    children: TextNode[];
+    readonly type: "text";
+    readonly children: TextNode[];
 }
 
 /**
@@ -2395,11 +2413,11 @@ export declare type TextNode = string | MarkupNode | BulletListNode | BulletPoin
  * @public
  */
 export declare interface TypingActiveState {
-    type: "active";
+    readonly type: "active";
     /**
      * The most recently received typing indicator snapshot, or `null` if you are not a participant in the conversation (including when the conversation does not exist).
      */
-    latestSnapshot: TypingSnapshot | null;
+    readonly latestSnapshot: TypingSnapshot | null;
 }
 
 /**
@@ -2474,14 +2492,14 @@ export declare interface TypingSubscription {
      *
      * The promise rejects if the subscription is terminated before it connects.
      */
-    connected: Promise<TypingActiveState>;
+    readonly connected: Promise<TypingActiveState>;
     /**
      * Resolves when the subscription permanently stops receiving updates from the server.
      *
      * @remarks
      * This is either because you unsubscribed or because the subscription encountered an unrecoverable error.
      */
-    terminated: Promise<UnsubscribedState | ErrorState>;
+    readonly terminated: Promise<UnsubscribedState | ErrorState>;
     /**
      * Unsubscribe from this resource and stop receiving updates.
      *
@@ -2497,7 +2515,7 @@ export declare interface TypingSubscription {
  * @public
  */
 export declare interface UnsubscribedState {
-    type: "unsubscribed";
+    readonly type: "unsubscribed";
 }
 
 /**
@@ -2506,11 +2524,11 @@ export declare interface UnsubscribedState {
  * @public
  */
 export declare interface UserActiveState {
-    type: "active";
+    readonly type: "active";
     /**
      * The most recently received snapshot for the user, or `null` if the user does not exist yet.
      */
-    latestSnapshot: UserSnapshot | null;
+    readonly latestSnapshot: UserSnapshot | null;
 }
 
 /**
@@ -2519,11 +2537,11 @@ export declare interface UserActiveState {
  * @public
  */
 export declare interface UserOnlineActiveState {
-    type: "active";
+    readonly type: "active";
     /**
      * The most recently received snapshot
      */
-    latestSnapshot: UserOnlineSnapshot | null;
+    readonly latestSnapshot: UserOnlineSnapshot | null;
 }
 
 /**
@@ -2538,7 +2556,7 @@ export declare interface UserOnlineSnapshot {
     /**
      * The user this snapshot relates to
      */
-    user: UserSnapshot;
+    readonly user: UserSnapshot;
     /**
      * Whether the user is connected right now
      *
@@ -2553,7 +2571,7 @@ export declare interface UserOnlineSnapshot {
      *
      * People using the {@link https://talkjs.com/docs/Reference/JavaScript_Chat_SDK/ | JavaScript SDK}, {@link https://talkjs.com/docs/Reference/React_SDK/Installation/ | React SDK}, {@link https://talkjs.com/docs/Reference/React_Native_SDK/Installation/ | React Native SDK}, or {@link https://talkjs.com/docs/Reference/Flutter_SDK/Installation/ | Flutter SDK} are considered connected whenever they have an active `Session` object.
      */
-    isConnected: boolean;
+    readonly isConnected: boolean;
 }
 
 /**
@@ -2589,14 +2607,14 @@ export declare interface UserOnlineSubscription {
      *
      * The promise rejects if the subscription is terminated before it connects.
      */
-    connected: Promise<UserOnlineActiveState>;
+    readonly connected: Promise<UserOnlineActiveState>;
     /**
      * Resolves when the subscription permanently stops receiving updates from the server.
      *
      * @remarks
      * This is either because you unsubscribed or because the subscription encountered an unrecoverable error.
      */
-    terminated: Promise<UnsubscribedState | ErrorState>;
+    readonly terminated: Promise<UnsubscribedState | ErrorState>;
     /**
      * Unsubscribe from this resource and stop receiving updates.
      *
@@ -2631,8 +2649,6 @@ export declare interface UserRef {
      * Fetching a user snapshot doesn't require any permissions. You can read the public information of any user.
      * Private information, such as email addresses and phone numbers, aren't included in the response.
      *
-     * Supports {@link https://talkjs.com/docs/Reference/JavaScript_Data_API/Performance/#automatic-batching | Automatic Batching} and {@link https://talkjs.com/docs/Reference/JavaScript_Data_API/Performance/#cached-fetch | Cached Fetch}
-     *
      * @returns A snapshot of the user's public attributes, or null if the user doesn't exist.
      */
     get(): Promise<UserSnapshot | null>;
@@ -2692,35 +2708,39 @@ export declare interface UserSnapshot {
     /**
      * The unique ID that is used to identify the user in TalkJS
      */
-    id: string;
+    readonly id: string;
     /**
      * The user's name, which is displayed on the TalkJS UI
      */
-    name: string;
+    readonly name: string;
     /**
      * Custom metadata you have set on the user
      */
-    custom: Record<string, string>;
+    readonly custom: Record<string, string>;
     /**
      * An {@link https://www.w3.org/International/articles/language-tags/ | IETF language tag}.
      * For more information, see: {@link https://talkjs.com/docs/Features/Language_Support/Localization.html | Localization}.
      *
      * When `locale` is null, the app's default locale will be used
      */
-    locale: string | null;
+    readonly locale: string | null;
     /**
      * An optional URL to a photo that is displayed as the user's avatar
      */
-    photoUrl: string | null;
+    readonly photoUrl: string | null;
     /**
      * TalkJS supports multiple sets of settings for users, called "roles". Roles allow you to change the behavior of TalkJS for different users.
      * You have full control over which user gets which configuration.
      */
-    role: string;
+    readonly role: string;
     /**
      * The default message a person sees when starting a chat with this user
+     *
+     * @remarks
+     * Welcome messages are rendered in the UI as messages, but they are not real messages.
+     * This means they do not appear when you list messages using the REST API or JS Data API, and you cannot reply or react to them.
      */
-    welcomeMessage: string | null;
+    readonly welcomeMessage: string | null;
 }
 
 /**
@@ -2750,14 +2770,14 @@ export declare interface UserSubscription {
     /**
      * Resolves when the subscription starts receiving updates from the server.
      */
-    connected: Promise<UserActiveState>;
+    readonly connected: Promise<UserActiveState>;
     /**
      * Resolves when the subscription permanently stops receiving updates from the server.
      *
      * @remarks
      * This is either because you unsubscribed or because the subscription encountered an unrecoverable error.
      */
-    terminated: Promise<UnsubscribedState | ErrorState>;
+    readonly terminated: Promise<UnsubscribedState | ErrorState>;
     /**
      * Unsubscribe from this resource and stop receiving updates.
      *
@@ -2782,36 +2802,36 @@ export declare interface UserSubscription {
  * @public
  */
 export declare interface VideoBlock {
-    type: "file";
-    subtype: "video";
+    readonly type: "file";
+    readonly subtype: "video";
     /**
      * An encoded identifier for this file. Use in {@link SendFileBlock} to send this video in another message.
      */
-    fileToken: FileToken;
+    readonly fileToken: FileToken;
     /**
      * The URL where you can fetch the file.
      */
-    url: string;
+    readonly url: string;
     /**
      * The size of the file in bytes.
      */
-    size: number;
+    readonly size: number;
     /**
      * The name of the video file, including file extension.
      */
-    filename: string;
+    readonly filename: string;
     /**
      * The width of the video in pixels, if known.
      */
-    width?: number;
+    readonly width?: number;
     /**
      * The height of the video in pixels, if known.
      */
-    height?: number;
+    readonly height?: number;
     /**
      * The duration of the video in seconds, if known.
      */
-    duration?: number;
+    readonly duration?: number;
 }
 
 export declare interface VideoFileMetadata {
@@ -2853,28 +2873,28 @@ export declare interface VideoFileMetadata {
  * @public
  */
 export declare interface VoiceBlock {
-    type: "file";
-    subtype: "voice";
+    readonly type: "file";
+    readonly subtype: "voice";
     /**
      * An encoded identifier for this file. Use in {@link SendFileBlock} to send this voice recording in another message.
      */
-    fileToken: FileToken;
+    readonly fileToken: FileToken;
     /**
      * The URL where you can fetch the file
      */
-    url: string;
+    readonly url: string;
     /**
      * The size of the file in bytes
      */
-    size: number;
+    readonly size: number;
     /**
      * The name of the file, including file extension
      */
-    filename: string;
+    readonly filename: string;
     /**
      * The duration of the voice recording in seconds, if known
      */
-    duration?: number;
+    readonly duration?: number;
 }
 
 export declare interface VoiceRecordingFileMetadata {