@talkjs/core 0.0.4 → 0.0.6

package/dist/talkSession.d.ts

@@ -9,17 +9,14 @@
  */
 export declare interface ActionButtonNode {
     type: "actionButton";
-
     /**
      * The name of the custom action to invoke when the button is clicked.
      */
     action: string;
-
     /**
      * The parameters to pass to the custom action when the button is clicked.
      */
     params: Record<string, string>;
-
     children: TextNode[];
 }
 
@@ -34,17 +31,14 @@ export declare interface ActionButtonNode {
  */
 export declare interface ActionLinkNode {
     type: "actionLink";
-
     /**
      * The name of the custom action to invoke when the link is clicked.
      */
     action: string;
-
     /**
      * The parameters to pass to the custom action when the link is clicked.
      */
     params: Record<string, string>;
-
     children: TextNode[];
 }
 
@@ -67,29 +61,23 @@ export declare interface ActionLinkNode {
  */
 export declare interface AudioBlock {
     type: "file";
-
     subtype: "audio";
-
     /**
      * An encoded identifier for this file. Use in {@link SendFileBlock} to send this file in another message.
      */
     fileToken: FileToken;
-
     /**
      * The URL where you can fetch the file
      */
     url: string;
-
     /**
      * The size of the file in bytes
      */
     size: number;
-
     /**
      * The name of the audio file, including file extension
      */
     filename: string;
-
     /**
      * The duration of the audio in seconds, if known
      */
@@ -143,12 +131,10 @@ declare interface AudioFileMetadata {
  */
 export declare interface AutoLinkNode {
     type: "autoLink";
-
     /**
      * The URL to open when a user clicks this node.
      */
     url: string;
-
     /**
      * The text to display in the link.
      */
@@ -222,7 +208,6 @@ export declare type ContentBlock = TextBlock | FileBlock | LocationBlock;
  */
 export declare interface ConversationActiveState {
     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).
      */
@@ -246,21 +231,18 @@ export declare interface ConversationRef {
      * Immutable: if you want to reference a different conversation, get a new ConversationRef instead.
      */
     readonly id: string;
-
     /**
      * Get a reference to a participant in this conversation
      *
      * @param user - the user's ID or a reference to the user
      */
     participant(user: string | UserRef): ParticipantRef;
-
     /**
      * Get a reference to a message in this conversation
      *
      * @param user - the message ID
      */
     message(id: string): MessageRef;
-
     /**
      * Fetches a snapshot of the conversation.
      *
@@ -270,7 +252,6 @@ export declare interface ConversationRef {
      * @returns A snapshot of the current user's view of the conversation, or null if the current user is not a participant (including if the conversation doesn't exist).
      */
     get(): Promise<ConversationSnapshot | null>;
-
     /**
      * Sets properties of this conversation and your participation in it.
      *
@@ -283,7 +264,6 @@ export declare interface ConversationRef {
      * Everything else requires client-side conversation syncing to be enabled, and will cause the promise to reject.
      */
     set(params: SetConversationParams): Promise<void>;
-
     /**
      * Creates this conversation if it does not already exist.
      * Adds you as a participant in this conversation, if you are not already a participant.
@@ -294,30 +274,24 @@ export declare interface ConversationRef {
      * @returns A promise that resolves when the operation completes. The promise rejects if you are not already a participant and client-side conversation syncing is disabled.
      */
     createIfNotExists(params?: CreateConversationParams): Promise<void>;
-
     /**
      * Marks the conversation as read.
      *
      * @returns A promise that resolves when the operation completes. The promise rejects if you are not a participant in the conversation.
      */
     markAsRead(): Promise<void>;
-
     /**
      * Marks the conversation as unread.
      *
      * @returns A promise that resolves when the operation completes. The promise rejects if you are not a participant in the conversation.
      */
     markAsUnread(): Promise<void>;
-
     /**
      * Sends a message in the conversation
      *
      * @returns A promise that resolves with a reference to the newly created message. The promise will reject if you do not have permission to send the message.
      */
-    send(
-    params: string | SendTextMessageParams | SendMessageParams,
-    ): Promise<MessageRef>;
-
+    send(params: string | SendTextMessageParams | SendMessageParams): Promise<MessageRef>;
     /**
      * Subscribes to the messages in the conversation.
      *
@@ -330,13 +304,7 @@ export declare interface ConversationRef {
      *
      * The snapshot is null if you are not a participant in the conversation (including when the conversation doesn't exist)
      */
-    subscribeMessages(
-    onSnapshot?: (
-    snapshot: MessageSnapshot[] | null,
-    loadedAll: boolean,
-    ) => void,
-    ): MessageSubscription;
-
+    subscribeMessages(onSnapshot?: (snapshot: MessageSnapshot[] | null, loadedAll: boolean) => void): MessageSubscription;
     /**
      * Subscribes to the conversation.
      *
@@ -346,9 +314,7 @@ export declare interface ConversationRef {
      *
      * The snapshot is null if you are not a participant in the conversation (including when the conversation doesn't exist)
      */
-    subscribe(
-    onSnapshot?: (snapshot: ConversationSnapshot | null) => void,
-    ): ConversationSubscription;
+    subscribe(onSnapshot?: (snapshot: ConversationSnapshot | null) => void): ConversationSubscription;
 }
 
 /**
@@ -366,50 +332,42 @@ export declare interface ConversationSnapshot {
      * The ID of the conversation
      */
     id: string;
-
     /**
      * Contains the conversation subject if it was set using {@link ConversationBuilder.subject}.
      */
     subject: string | null;
-
     /**
      * Contains the URL of a photo was set using {@link ConversationBuilder.subject}.
      */
     photoUrl: string | null;
-
     /**
      * One or more welcome messages that will display to the user as a SystemMessage
      */
     welcomeMessages: string[];
-
     /**
      * Custom metadata you have set on the conversation
      */
     custom: Record<string, string>;
-
     /**
      * The date that the conversation was created, as a unix timestamp in milliseconds.
      */
     createdAt: number;
-
     /**
      * The date that the current user joined the conversation, as a unix timestamp in milliseconds.
      */
     joinedAt: number;
-
     /**
      * The last message sent in this conversation, or null if no messages have been sent.
      */
     lastMessage: MessageSnapshot | null;
-
     /**
      * The number of messages in this conversation that the current user hasn't read.
      */
     unreadMessageCount: number;
-
-    // TODO-STEVEN everyoneReadUntil
-    // TODO-STEVEN readUntil
-
+    /**
+     * Timestamp of when the current user read a message
+     */
+    readUntil: number;
     /**
      * Whether the conversation should be considered unread.
      *
@@ -417,12 +375,10 @@ export declare interface ConversationSnapshot {
      * This can be true even when `unreadMessageCount` is zero, if the user has manually marked the conversation as unread.
      */
     isUnread: boolean;
-
     /**
      * The current user's permission level in this conversation.
      */
     access: "Read" | "ReadWrite";
-
     /**
      * The current user's notification settings for this conversation.
      *
@@ -454,17 +410,11 @@ export declare interface ConversationSubscription {
      *
      * When `type` is "error", includes the `error` field. It is a JS `Error` object explaining what caused the subscription to be terminated.
      */
-    state:
-    | PendingState
-    | ConversationActiveState
-    | UnsubscribedState
-    | ErrorState;
-
+    state: PendingState | ConversationActiveState | UnsubscribedState | ErrorState;
     /**
      * Resolves when the subscription starts receiving updates from the server.
      */
     connected: Promise<ConversationActiveState>;
-
     /**
      * Resolves when the subscription permanently stops receiving updates from the server.
      *
@@ -472,7 +422,6 @@ export declare interface ConversationSubscription {
      * This is either because you unsubscribed or because the subscription encountered an unrecoverable error.
      */
     terminated: Promise<UnsubscribedState | ErrorState>;
-
     /**
      * Unsubscribe from this resource and stop receiving updates.
      *
@@ -495,32 +444,27 @@ export declare interface CreateConversationParams {
      * Default = no subject, list participant names instead.
      */
     subject?: string;
-
     /**
      * The URL for the conversation photo to display in the chat header.
      * Default = no photo, show a placeholder image.
      */
     photoUrl?: string;
-
     /**
      * System messages which are sent at the beginning of a conversation.
      * Default = no messages.
      */
     welcomeMessages?: string[];
-
     /**
      * Custom metadata you have set on the conversation.
      * This value acts as a patch. Remove specific properties by setting them to `null`.
      * Default = no custom metadata
      */
     custom?: Record<string, string>;
-
     /**
      * Your access to the conversation.
      * Default = "ReadWrite" access.
      */
     access?: "Read" | "ReadWrite";
-
     /**
      * Your notification settings.
      * Default = `true`
@@ -542,7 +486,6 @@ export declare interface CreateParticipantParams {
      * Default = "ReadWrite" access.
      */
     access?: "ReadWrite" | "Read";
-
     /**
      * When the participant should be notified about new messages in this conversation.
      * Default = `true`
@@ -566,51 +509,43 @@ export declare interface CreateUserParams {
      * The user's name which is displayed on the TalkJS UI
      */
     name: string;
-
     /**
      * Custom metadata you have set on the user.
      * Default = no custom metadata
      */
     custom?: Record<string, string>;
-
     /**
      * An {@link https://www.w3.org/International/articles/language-tags/ | IETF language tag}.
      * See the {@link https://talkjs.com/docs/Features/Language_Support/Localization.html | localization documentation}
      * Default = the locale selected on the dashboard
      */
     locale?: string;
-
     /**
      * An optional URL to a photo that is displayed as the user's avatar.
      * Default = no photo
      */
     photoUrl?: string;
-
     /**
      * TalkJS supports multiple sets of settings, called "roles". These allow you to change the behavior of TalkJS for different users.
      * You have full control over which user gets which configuration.
      * Default = the `default` role
      */
     role?: string;
-
     /**
      * The default message a person sees when starting a chat with this user.
      * Default = no welcome message
      */
     welcomeMessage?: string;
-
     /**
-     * An array of email addresses associated with the user.
+     * A single email address or an array of email addresses associated with the user.
      * Default = no email addresses
      */
-    email?: string[];
-
+    email?: string | string[];
     /**
-     * An array of phone numbers associated with the user.
+     * A single phone number or an array of phone numbers associated with the user.
      * Default = no phone numbers
      */
-    phone?: string[];
-
+    phone?: string | string[];
     /**
      * An object of push registration tokens to use when notifying this user.
      *
@@ -630,7 +565,6 @@ export declare interface CreateUserParams {
  */
 export declare interface CustomEmojiNode {
     type: "customEmoji";
-
     /**
      * The name of the custom emoji to show.
      */
@@ -656,7 +590,6 @@ export declare interface EditMessageParams {
      * Default = no custom metadata
      */
     custom?: Record<string, string | null> | null;
-
     /**
      * The new content for the message.
      *
@@ -686,7 +619,6 @@ export declare interface EditTextMessageParams {
      * Default = no custom metadata
      */
     custom?: Record<string, string | null> | null;
-
     /**
      * The new text to set in the message body.
      *
@@ -705,7 +637,6 @@ export declare interface EditTextMessageParams {
  */
 export declare interface ErrorState {
     type: "error";
-
     /**
      * The error that caused the subscription to be terminated
      */
@@ -733,12 +664,7 @@ export declare interface ErrorState {
  *
  * @public
  */
-export declare type FileBlock =
-| VideoBlock
-| ImageBlock
-| AudioBlock
-| VoiceBlock
-| GenericFileBlock;
+export declare type FileBlock = VideoBlock | ImageBlock | AudioBlock | VoiceBlock | GenericFileBlock;
 
 /**
  * A token representing a file uploaded to TalkJS.
@@ -807,27 +733,22 @@ export declare type FileToken = string & {
  */
 export declare interface GenericFileBlock {
     type: "file";
-
     /**
      * Never set for generic file blocks.
      */
     subtype?: undefined;
-
     /**
      * An encoded identifier for this file. Use in {@link SendFileBlock} to send this file in another message.
      */
     fileToken: FileToken;
-
     /**
      * The URL where you can fetch the file
      */
     url: string;
-
     /**
      * The size of the file in bytes
      */
     size: number;
-
     /**
      * The name of the file, including file extension
      */
@@ -868,34 +789,27 @@ export declare function getTalkSession(options: TalkSessionOptions): TalkSession
  */
 export declare interface ImageBlock {
     type: "file";
-
     subtype: "image";
-
     /**
      * An encoded identifier for this file. Use in {@link SendFileBlock} to send this image in another message.
      */
     fileToken: FileToken;
-
     /**
      * The URL where you can fetch the file.
      */
     url: string;
-
     /**
      * The size of the file in bytes.
      */
     size: number;
-
     /**
      * The name of the image file, including file extension.
      */
     filename: string;
-
     /**
      * The width of the image in pixels, if known.
      */
     width?: number;
-
     /**
      * The height of the image in pixels, if known.
      */
@@ -927,12 +841,10 @@ declare interface ImageFileMetadata {
  */
 export declare interface LinkNode {
     type: "link";
-
     /**
      * The URL to open when the node is clicked.
      */
     url: string;
-
     children: TextNode[];
 }
 
@@ -947,7 +859,6 @@ export declare interface LinkNode {
  */
 export declare interface LocationBlock {
     type: "location";
-
     /**
      * The north-south coordinate of the location.
      *
@@ -957,7 +868,6 @@ export declare interface LocationBlock {
      * Must be a number between -90 and 90
      */
     latitude: number;
-
     /**
      * The east-west coordinate of the location.
      *
@@ -985,7 +895,6 @@ export declare interface MarkupNode {
      * - `type: "strikethrough"` is used when users type `~text~` and is rendered with HTML `<s>`
      */
     type: "bold" | "italic" | "strikethrough";
-
     children: TextNode[];
 }
 
@@ -999,12 +908,10 @@ export declare interface MarkupNode {
  */
 export declare interface MentionNode {
     type: "mention";
-
     /**
      * The ID of the user who is mentioned.
      */
     id: string;
-
     /**
      * The name of the user who is mentioned.
      */
@@ -1018,12 +925,10 @@ export declare interface MentionNode {
  */
 export declare interface MessageActiveState {
     type: "active";
-
     /**
      * The most recently received snapshot for the user, or `null` if the user does not exist yet.
      */
     latestSnapshot: MessageSnapshot[] | null;
-
     /**
      * True if `latestSnapshot` contains all messages in the conversation.
      * Use `MessageSubscription.loadMore` to load more.
@@ -1048,7 +953,6 @@ export declare interface MessageRef {
      * Immutable: if you want to reference a different message, get a new MessageRef instead.
      */
     readonly id: string;
-
     /**
      * The ID of the conversation that the referenced message belongs to.
      *
@@ -1056,7 +960,6 @@ export declare interface MessageRef {
      * Immutable: if you want to reference a message from a different conversation, get a new MessageRef from that conversation.
      */
     readonly conversationId: string;
-
     /**
      * Fetches a snapshot of the message.
      *
@@ -1066,16 +969,12 @@ export declare interface MessageRef {
      * @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>;
-
     /**
      * Edits this message.
      *
      * @returns A promise that resolves when the operation completes. The promise will reject if the request is invalid, the message doesn't exist, or you do not have permission to edit that message.
      */
-    edit(
-    params: string | EditTextMessageParams | EditMessageParams,
-    ): Promise<void>;
-
+    edit(params: string | EditTextMessageParams | EditMessageParams): Promise<void>;
     /**
      * Deletes this message, or does nothing if they are already not a participant.
      *
@@ -1102,37 +1001,31 @@ export declare interface MessageSnapshot {
      * The unique ID that is used to identify the message in TalkJS
      */
     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";
-
     /**
      * 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;
-
     /**
      * Custom metadata you have set on the message
      */
     custom: Record<string, string>;
-
     /**
      * Time at which the message was sent, as a unix timestamp in milliseconds
      */
     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;
-
     /**
      * A snapshot of the message that this message is a reply to, or null if this message is not a reply.
      *
@@ -1143,10 +1036,6 @@ export declare interface MessageSnapshot {
      * This prevents TalkJS fetching an unlimited number of messages in a long chain of replies.
      */
     referencedMessage: ReferencedMessageSnapshot | null;
-
-    // TODO-STEVEN `rest` also applies when messages are sent with DL, but that's not exposed yet
-    // TODO-STEVEN Add components here
-    // TODO-STEVEN we want to make this make more sense
     /**
      * Where this message originated from:
      *
@@ -1159,13 +1048,11 @@ export declare interface MessageSnapshot {
      * - "email" = Message sent by replying to an email notification
      */
     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;
-
     /**
      * The main body of the message, as a list of blocks that are rendered top-to-bottom.
      */
@@ -1203,7 +1090,6 @@ export declare interface MessageSubscription {
      * When `type` is "error", includes the `error` field. It is a JS `Error` object explaining what caused the subscription to be terminated.
      */
     state: PendingState | MessageActiveState | UnsubscribedState | ErrorState;
-
     /**
      * Resolves when the subscription starts receiving updates from the server.
      *
@@ -1213,7 +1099,6 @@ export declare interface MessageSubscription {
      * The promise rejects if the subscription is terminated before it connects.
      */
     connected: Promise<MessageActiveState>;
-
     /**
      * Resolves when the subscription permanently stops receiving updates from the server.
      *
@@ -1221,7 +1106,6 @@ export declare interface MessageSubscription {
      * This is either because you unsubscribed or because the subscription encountered an unrecoverable error.
      */
     terminated: Promise<UnsubscribedState | ErrorState>;
-
     /**
      * Expand the window to include older messages
      *
@@ -1232,7 +1116,6 @@ export declare interface MessageSubscription {
      * @returns A promise that resolves once the additional messages have loaded
      */
     loadMore: (count?: number) => Promise<void>;
-
     /**
      * Unsubscribe from this resource and stop receiving updates.
      *
@@ -1259,7 +1142,6 @@ export declare interface ParticipantRef {
      * Immutable: if you want to reference a different participant, get a new ParticipantRef instead.
      */
     readonly userId: string;
-
     /**
      * The ID of the conversation the user is participating in.
      *
@@ -1267,7 +1149,6 @@ export declare interface ParticipantRef {
      * Immutable: if you want to reference the user in a different conversation, get a new ParticipantRef instead.
      */
     readonly conversationId: string;
-
     /**
      * Fetches a snapshot of the participant.
      *
@@ -1277,7 +1158,6 @@ export declare interface ParticipantRef {
      * @returns A snapshot of the participant's attributes, or null if the user is not a participant. The promise will reject if you are not a participant and try to read information about someone else.
      */
     get(): Promise<ParticipantSnapshot | null>;
-
     /**
      * Sets properties of this participant. If the user is not already a participant in the conversation, they will be added.
      *
@@ -1289,7 +1169,6 @@ export declare interface ParticipantRef {
      * Everything else requires client-side conversation syncing to be enabled, and will cause the promise to reject.
      */
     set(params: SetParticipantParams): Promise<void>;
-
     /**
      * Edits properties of a pre-existing participant. If the user is not already a participant in the conversation, the promise will reject.
      *
@@ -1301,7 +1180,6 @@ export declare interface ParticipantRef {
      * Everything else requires client-side conversation syncing to be enabled, and will cause the promise to reject.
      */
     edit(params: SetParticipantParams): Promise<void>;
-
     /**
      * Adds the user as a participant, or does nothing if they are already a participant.
      *
@@ -1313,7 +1191,6 @@ export declare interface ParticipantRef {
      * @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>;
-
     /**
      * Removes the user as a participant, or does nothing if they are already not a participant.
      *
@@ -1340,12 +1217,10 @@ export declare interface ParticipantSnapshot {
      * The user who this participant snapshot is referring to
      */
     user: UserSnapshot;
-
     /**
      * The level of access this participant has in the conversation.
      */
     access: "ReadWrite" | "Read";
-
     /**
      * When the participant will be notified about new messages in this conversation.
      *
@@ -1353,13 +1228,10 @@ export declare interface ParticipantSnapshot {
      * `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";
-
     /**
      * The date that this user joined the conversation, as a unix timestamp in milliseconds.
      */
     joinedAt: number;
-
-    // TODO-STEVEN readUntil
 }
 
 /**
@@ -1388,12 +1260,10 @@ export declare interface ReferencedMessageSnapshot {
      * The unique ID that is used to identify the message in TalkJS
      */
     id: string;
-
     /**
      * Referenced messages are always "UserMessage" because you cannot reply to a system message.
      */
     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.
@@ -1403,23 +1273,19 @@ export declare interface ReferencedMessageSnapshot {
      * Guaranteed to be set, unlike in MessageSnapshot, because you cannot reference a SystemMessage
      */
     sender: UserSnapshot;
-
     /**
      * Custom metadata you have set on the message
      */
     custom: Record<string, string>;
-
     /**
      * Time at which the message was sent, as a unix timestamp in milliseconds
      */
     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;
-
     /**
      * The ID of the message that this message is a reply to, or null if this message is not a reply.
      *
@@ -1428,10 +1294,6 @@ export declare interface ReferencedMessageSnapshot {
      * The ID of its referenced message is provided here instead.
      */
     referencedMessageId: string | null;
-
-    // TODO-STEVEN `rest` also applies when messages are sent with DL, but that's not exposed yet
-    // TODO-STEVEN Add components here
-    // TODO-STEVEN we want to make this make more sense
     /**
      * Where this message originated from:
      *
@@ -1444,13 +1306,11 @@ export declare interface ReferencedMessageSnapshot {
      * - "email" = Message sent by replying to an email notification
      */
     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;
-
     /**
      * The main body of the message, as a list of blocks that are rendered top-to-bottom.
      */
@@ -1527,13 +1387,11 @@ export declare interface SendMessageParams {
      * Default = no custom metadata
      */
     custom?: Record<string, string>;
-
     /**
      * The message that you are replying to.
      * Default = not a reply
      */
     referencedMessage?: string | MessageRef;
-
     /**
      * The most important part of the message, either some text, a file attachment, or a location.
      *
@@ -1559,13 +1417,11 @@ export declare interface SendTextMessageParams {
      * Default = no custom metadata
      */
     custom?: Record<string, string>;
-
     /**
      * The message that you are replying to.
      * Default = not a reply
      */
     referencedMessage?: string | MessageRef;
-
     /**
      * The text to send in the message.
      *
@@ -1591,32 +1447,27 @@ export declare interface SetConversationParams {
      * Default = no subject, list participant names instead.
      */
     subject?: string | null;
-
     /**
      * The URL for the conversation photo to display in the chat header.
      * Default = no photo, show a placeholder image.
      */
     photoUrl?: string | null;
-
     /**
      * System messages which are sent at the beginning of a conversation.
      * Default = no messages.
      */
     welcomeMessages?: string[] | null;
-
     /**
      * Custom metadata you have set on the conversation.
      * This value acts as a patch. Remove specific properties by setting them to `null`.
      * Default = no custom metadata
      */
     custom?: Record<string, string | null> | null;
-
     /**
      * Your access to the conversation.
      * Default = "ReadWrite" access.
      */
     access?: "Read" | "ReadWrite" | null;
-
     /**
      * Your notification settings.
      * Default = `true`
@@ -1639,7 +1490,6 @@ export declare interface SetParticipantParams {
      * Default = "ReadWrite" access.
      */
     access?: "ReadWrite" | "Read" | null;
-
     /**
      * When the participant should be notified about new messages in this conversation.
      * Default = `ReadWrite` access.
@@ -1664,52 +1514,44 @@ export declare interface SetUserParams {
      * The user's name which will be displayed on the TalkJS UI
      */
     name?: string;
-
     /**
      * Custom metadata you have set on the user.
      * This value acts as a patch. Remove specific properties by setting them to `null`.
      * Default = no custom metadata
      */
     custom?: Record<string, string | null> | null;
-
     /**
      * An {@link https://www.w3.org/International/articles/language-tags/ | IETF language tag}.
      * See the {@link https://talkjs.com/docs/Features/Language_Support/Localization.html | localization documentation}
      * Default = the locale selected on the dashboard
      */
     locale?: string;
-
     /**
      * An optional URL to a photo which will be displayed as the user's avatar.
      * Default = no photo
      */
     photoUrl?: string | null;
-
     /**
      * TalkJS supports multiple sets of settings, called "roles". These allow you to change the behavior of TalkJS for different users.
      * You have full control over which user gets which configuration.
      * Default = the `default` role
      */
     role?: string | null;
-
     /**
      * The default message a person sees when starting a chat with this user.
      * Default = no welcome message
      */
     welcomeMessage?: string | null;
-
     /**
-     * An array of email addresses associated with the user.
+     * A single email address or an array of email addresses associated with the user.
      * Default = no email addresses
      */
-    email?: string[] | null;
-
+    email?: string | string[] | null;
     /**
-     * An array of phone numbers associated with the user.
+     * A single phone number or an array of phone numbers associated with the user.
      * Default = no phone numbers
      */
-    phone?: string[] | null;
-
+    phone?: string | string[] | null;
     /**
      * An object of push registration tokens to use when notifying this user.
      *
@@ -1788,7 +1630,7 @@ export declare interface TalkSession {
      * Upload an image with image-specific metadata.
      *
      * @remarks
-     * This is a variant of {@linkcode TalkSession.uploadFile} used for images.
+     * This is a variant of {@linkcode uploadFile} used for images.
      *
      * @param data The binary image data. Usually a {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/File | File}.
      * @param metadata Information about the image.
@@ -1799,7 +1641,7 @@ export declare interface TalkSession {
      * Upload a video with video-specific metadata.
      *
      * @remarks
-     * This is a variant of {@linkcode TalkSession.uploadFile} used for videos.
+     * This is a variant of {@linkcode uploadFile} used for videos.
      *
      * @param data The binary video data. Usually a {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/File | File}.
      * @param metadata Information about the video.
@@ -1810,7 +1652,7 @@ export declare interface TalkSession {
      * Upload an audio file with audio-specific metadata.
      *
      * @remarks
-     * This is a variant of {@linkcode TalkSession.uploadFile} used for audio files.
+     * This is a variant of {@linkcode uploadFile} used for audio files.
      *
      * @param data The binary audio data. Usually a {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/File | File}.
      * @param metadata Information about the audio file.
@@ -1821,7 +1663,7 @@ export declare interface TalkSession {
      * Upload a voice recording with voice-specific metadata.
      *
      * @remarks
-     * This is a variant of {@linkcode TalkSession.uploadFile} used for voice recordings.
+     * This is a variant of {@linkcode uploadFile} used for voice recordings.
      *
      * @param data The binary audio data. Usually a {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/File | File}.
      * @param metadata Information about the voice recording.
@@ -1917,18 +1759,7 @@ export declare interface TextBlock {
  *
  * @public
  */
-export declare type TextNode =
-| string
-| MarkupNode
-| BulletListNode
-| BulletPointNode
-| CodeSpanNode
-| LinkNode
-| AutoLinkNode
-| ActionLinkNode
-| ActionButtonNode
-| CustomEmojiNode
-| MentionNode;
+export declare type TextNode = string | MarkupNode | BulletListNode | BulletPointNode | CodeSpanNode | LinkNode | AutoLinkNode | ActionLinkNode | ActionButtonNode | CustomEmojiNode | MentionNode;
 
 /**
  * The state of a subscription after you have manually unsubscribed
@@ -1946,7 +1777,6 @@ export declare interface UnsubscribedState {
  */
 export declare interface UserActiveState {
     type: "active";
-
     /**
      * The most recently received snapshot for the user, or `null` if the user does not exist yet.
      */
@@ -1970,7 +1800,6 @@ export declare interface UserRef {
      * Immutable: if you want to reference a different user, get a new UserRef instead.
      */
     readonly id: string;
-
     /**
      * Fetches a snapshot of the user.
      *
@@ -1984,7 +1813,6 @@ export declare interface UserRef {
      * @returns A snapshot of the user's public attributes, or null if the user doesn't exist.
      */
     get(): Promise<UserSnapshot | null>;
-
     /**
      * Sets properties of this user. The user is created if a user with this ID doesn't already exist.
      *
@@ -1994,7 +1822,6 @@ export declare interface UserRef {
      * @returns A promise that resolves when the operation completes. The promise will reject if the request is invalid or if client-side user syncing is disabled.
      */
     set(params: SetUserParams): Promise<void>;
-
     /**
      * Creates a user with this ID, or does nothing if a user with this ID already exists.
      *
@@ -2004,7 +1831,6 @@ export declare interface UserRef {
      * @returns A promise that resolves when the operation completes. The promise will reject if client-side user syncing is disabled and the user does not already exist.
      */
     createIfNotExists(params: CreateUserParams): Promise<void>;
-
     /**
      * Subscribe to this user's state.
      *
@@ -2015,9 +1841,7 @@ export declare interface UserRef {
      *
      * @returns A subscription to the user
      */
-    subscribe(
-    onSnapshot?: (event: UserSnapshot | null) => void,
-    ): UserSubscription;
+    subscribe(onSnapshot?: (event: UserSnapshot | null) => void): UserSubscription;
 }
 
 /**
@@ -2035,17 +1859,14 @@ export declare interface UserSnapshot {
      * The unique ID that is used to identify the user in TalkJS
      */
     id: string;
-
     /**
      * The user's name, which is displayed on the TalkJS UI
      */
     name: string;
-
     /**
      * Custom metadata you have set on the user
      */
     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}.
@@ -2053,18 +1874,15 @@ export declare interface UserSnapshot {
      * When `locale` is null, the app's default locale will be used
      */
     locale: string | null;
-
     /**
      * An optional URL to a photo that is displayed as the user's avatar
      */
     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;
-
     /**
      * The default message a person sees when starting a chat with this user
      */
@@ -2093,12 +1911,10 @@ export declare interface UserSubscription {
      * When `type` is "error", includes the `error: Error` field. It is a JS `Error` object explaining what caused the subscription to be terminated.
      */
     state: PendingState | UserActiveState | UnsubscribedState | ErrorState;
-
     /**
      * Resolves when the subscription starts receiving updates from the server.
      */
     connected: Promise<UserActiveState>;
-
     /**
      * Resolves when the subscription permanently stops receiving updates from the server.
      *
@@ -2106,7 +1922,6 @@ export declare interface UserSubscription {
      * This is either because you unsubscribed or because the subscription encountered an unrecoverable error.
      */
     terminated: Promise<UnsubscribedState | ErrorState>;
-
     /**
      * Unsubscribe from this resource and stop receiving updates.
      *
@@ -2132,39 +1947,31 @@ export declare interface UserSubscription {
  */
 export declare interface VideoBlock {
     type: "file";
-
     subtype: "video";
-
     /**
      * An encoded identifier for this file. Use in {@link SendFileBlock} to send this video in another message.
      */
     fileToken: FileToken;
-
     /**
      * The URL where you can fetch the file.
      */
     url: string;
-
     /**
      * The size of the file in bytes.
      */
     size: number;
-
     /**
      * The name of the video file, including file extension.
      */
     filename: string;
-
     /**
      * The width of the video in pixels, if known.
      */
     width?: number;
-
     /**
      * The height of the video in pixels, if known.
      */
     height?: number;
-
     /**
      * The duration of the video in seconds, if known.
      */
@@ -2211,29 +2018,23 @@ declare interface VideoFileMetadata {
  */
 export declare interface VoiceBlock {
     type: "file";
-
     subtype: "voice";
-
     /**
      * An encoded identifier for this file. Use in {@link SendFileBlock} to send this voice recording in another message.
      */
     fileToken: FileToken;
-
     /**
      * The URL where you can fetch the file
      */
     url: string;
-
     /**
      * The size of the file in bytes
      */
     size: number;
-
     /**
      * The name of the file, including file extension
      */
     filename: string;
-
     /**
      * The duration of the voice recording in seconds, if known
      */