@twilio/conversations 3.0.0-canary.5 → 3.0.0-canary2.100

package/builds/lib.d.ts

@@ -1,8 +1,9 @@
+/// <reference types="node" />
 import { SyncClient, SyncDocument, SyncList } from "twilio-sync";
 import { LogLevelDesc } from "loglevel";
-import { Transport, TwilsockClient, InitRegistration, ConnectionError, TransportResult } from "twilsock";
-import { ConnectionState as TwilsockConnectionState } from "twilsock";
+import { TwilsockClient, InitRegistration, HttpResponse } from "twilsock";
 import { ReplayEventEmitter } from "@twilio/replay-event-emitter";
+import { JSONValue } from "@twilio/shared";
 import { ChannelType, Notifications } from "@twilio/notifications";
 import { Notifications as NotificationClient } from "@twilio/notifications";
 import { CancellablePromise, McsClient, MediaCategory, McsMedia } from "@twilio/mcs-client";
@@ -112,7 +113,7 @@ declare class Configuration {
     constructor(options: ClientOptions, configurationResponse: ConfigurationResponse, logger: Logger);
 }
 interface CommandExecutorServices {
-    transport: Transport;
+    transport: TwilsockClient;
 }
 declare class CommandExecutor {
     private _serviceUrl;
@@ -124,20 +125,6 @@ declare class CommandExecutor {
     fetchResource<REQ = void, RESP = void>(url: string, requestBody?: REQ): Promise<RESP>;
     mutateResource<REQ = void, RESP = void>(method: "post" | "delete", url: string, requestBody?: REQ): Promise<RESP>;
 }
-/**
- * Represents a JSON value.
- */
-type JSONValue = null | string | number | boolean | JSONObject | JSONArray;
-/**
- * Represents a JSON object.
- */
-type JSONObject = {
-    [x: string]: JSONValue;
-};
-/**
- * Represents a JSON array.
- */
-type JSONArray = JSONValue[];
 type UserEvents = {
     updated: (data: {
         user: User;
@@ -269,7 +256,7 @@ declare class Network {
     private cleanupCache;
     pokeTimer(): void;
     private executeWithRetry;
-    get<T>(url: string): Promise<TransportResult<T>>;
+    get<T>(url: string): Promise<HttpResponse>;
 }
 type UsersEvents = {
     userUpdated: (data: {
@@ -567,7 +554,7 @@ interface AggregatedDeliveryDescriptor {
  * Contains aggregated information about delivery statuses of a message across all participants
  * of a conversation.
  *
- * At any moment during the message delivery to a participant, the message can have zero or more of following
+ * At any moment during the message delivery to a participant, the message can have zero or more of the following
  * delivery statuses:
  * * Message is considered as **sent** to a participant if the nearest upstream carrier accepted the message.
  * * Message is considered as **delivered** to a participant if Twilio has received confirmation of message
@@ -731,8 +718,8 @@ interface MessageData {
     attributes?: JSONValue;
     dateUpdated: string;
     timestamp?: string;
-    medias?: Media[];
-    media?: Media;
+    medias: MediaState[] | null;
+    media: MediaState | null;
     memberSid?: string;
     delivery?: AggregatedDeliveryDescriptor;
 }
@@ -782,14 +769,15 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      */
     get dateUpdated(): Date | null;
     /**
-     * Index of the message in the conversation's messages list.
-     * By design of the Conversations system, the message indices may have arbitrary gaps between them,
+     * Index of this message in the conversation's list of messages.
+     *
+     * By design, the message indices may have arbitrary gaps between them,
      * that does not necessarily mean they were deleted or otherwise modified - just that
      * messages may have some non-contiguous indices even if they are being sent immediately one after another.
      *
      * Trying to use indices for some calculations is going to be unreliable.
      *
-     * To calculate the number of unread messages it is better to use the read horizon API.
+     * To calculate the number of unread messages, it is better to use the Read Horizon API.
      * See {@link Conversation.getUnreadMessagesCount} for details.
      */
     get index(): number;
@@ -872,7 +860,7 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      * Get content URLs for all media attachments in the given set using a single operation.
      * @param contentSet Set of media attachments to query content URLs.
      */
-    getTemporaryContentUrlsForMedia(contentSet: Media[] | null): CancellablePromise<Map<string, string>>;
+    getTemporaryContentUrlsForMedia(contentSet: Media[]): CancellablePromise<Map<string, string>>;
     /**
      * Get content URLs for all media attachments in the given set of media sids using a single operation.
      * @param mediaSids Set of media sids to query for the content URL.
@@ -1024,6 +1012,7 @@ interface MessageResponse {
     media: {
         sid: string;
         size: string;
+        category: string;
         content_type: string;
         filename: string;
     }[] | null;
@@ -1058,9 +1047,10 @@ declare class Messages extends ReplayEventEmitter<MessagesEvents> {
     constructor(conversation: Conversation, configuration: Configuration, services: MessagesServices);
     /**
      * Subscribe to the Messages Event Stream
-     * @param name - The name of Sync object for the Messages resource.
+     * @param arg - Name of the Sync object, or the SyncList itself, that
+     * represents the Messages resource.
      */
-    subscribe(name: string): Promise<SyncList>;
+    subscribe(arg: string | SyncList): Promise<SyncList>;
     unsubscribe(): Promise<void>;
     /**
      * Send a message to the conversation. The message could include text and multiple media attachments.
@@ -1092,7 +1082,7 @@ declare class Messages extends ReplayEventEmitter<MessagesEvents> {
      */
     getMessages(pageSize: number | undefined, anchor: number | "end" | undefined, direction?: "forward" | "backwards"): Promise<SyncPaginator<Message>>;
     private _wrapPaginator;
-    private _upsertMessage;
+    _upsertMessage(index: number, value: MessageData): Message;
     /**
      * Returns last messages from conversation
      * @param {Number} [pageSize] Number of messages to return in single chunk. By default it's 30.
@@ -1110,7 +1100,10 @@ declare class UnsentMessage {
     private messagesEntity;
     text?: string;
     attributes: JSONValue;
-    mediaContent: [MediaCategory, FormData | SendMediaOptions][];
+    mediaContent: [
+        MediaCategory,
+        FormData | SendMediaOptions
+    ][];
     emailOptions: SendEmailOptions;
     /**
      * @internal
@@ -1486,10 +1479,18 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * Messages entity.
      */
     private readonly _messagesEntity;
+    /**
+     * Sync list containing messages.
+     */
+    private _messagesList?;
     /**
      * Participants entity.
      */
     private readonly _participantsEntity;
+    /**
+     * Sync map containing participants.
+     */
+    private _participantsMap?;
     /**
      * Source of the most recent update.
      */
@@ -1660,7 +1661,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      */
     getMessagesCount(): Promise<number>;
     /**
-     * Get unread messages count for the user if they are a participant of this
+     * Get count of unread messages for the user if they are a participant of this
      * conversation. Rejects if the user is not a participant of the conversation.
      *
      * Use this method to obtain the number of unread messages together with
@@ -1668,12 +1669,19 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * message indices which may have gaps. See {@link Message.index} for details.
      *
      * This method is semi-realtime. This means that this data will be eventually
-     * correct, but will also be possibly incorrect for a few seconds. The
+     * correct, but it will also be possibly incorrect for a few seconds. The
      * Conversations system does not provide real time events for counter values
      * changes.
      *
      * This is useful for any UI badges, but it is not recommended to build any
      * core application logic based on these counters being accurate in real time.
+     *
+     * If the read horizon is not set, this function will return null. This could mean
+     * that all messages in the conversation are unread, or that the read horizon system
+     * is not being used. How to interpret this `null` value is up to the customer application.
+     *
+     * @return Number of unread messages based on the current read horizon set for
+     * the user or `null` if the read horizon is not set.
      */
     getUnreadMessagesCount(): Promise<number | null>;
     /**
@@ -1689,8 +1697,6 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * argument, it will assume that the string is an identity or SID.
      * @param participant Identity, SID or the participant object to remove.
      */
-    /* eslint-disable @typescript-eslint/ban-ts-comment */
-    // @ts-ignore TODO: fix validateTypesAsync typing
     removeParticipant(participant: string | Participant): Promise<void>;
     /**
      * Send a message to the conversation.
@@ -1701,7 +1707,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * @param emailOptions Email options for the message.
      * @return Index of the new message.
      */
-    sendMessage(message: null | string | FormData | SendMediaOptions, messageAttributes?: JSONValue, emailOptions?: SendEmailOptions): Promise<number>;
+    sendMessage(message: null | string | FormData | SendMediaOptions, messageAttributes?: JSONValue, emailOptions?: SendEmailOptions): Promise<Message>;
     /**
      * New interface to prepare for sending a message.
      * Use this instead of {@link Message.sendMessage}.
@@ -1716,7 +1722,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
     setAllMessagesRead(): Promise<number>;
     /**
      * Set all messages in the conversation unread.
-     * @return Resulting unread messages count in the conversation.
+     * @returns New count of unread messages after this update.
      */
     setAllMessagesUnread(): Promise<number>;
     /**
@@ -1745,7 +1751,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * Set the last read message index to the current read horizon.
      * @param index Message index to set as last read. If null is provided, then
      * the behavior is identical to {@link Conversation.setAllMessagesUnread}.
-     * @returns Resulting unread messages count in the conversation.
+     * @returns New count of unread messages after this update.
      */
     updateLastReadMessageIndex(index: number | null): Promise<number>;
     /**
@@ -1761,6 +1767,16 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * @internal
      */
     _subscribe(): Promise<SyncDocument>;
+    /**
+     * Fetch participants and messages of the conversation. This method needs to
+     * be called during conversation initialization to catch broken conversations
+     * (broken conversations are conversations that have essential Sync entities
+     * missing, i.e. the conversation document, the messages list or the
+     * participant map). In case of this conversation being broken, the method
+     * will throw an exception that will be caught and handled gracefully.
+     * @internal
+     */
+    _fetchStreams(): Promise<void>;
     /**
      * Load the attributes of this conversation and instantiate its participants
      * and messages. This or _subscribe will need to be called before any events
@@ -1833,7 +1849,7 @@ interface PushNotificationData {
      */
     media?: Media;
     /**
-     * Amount of the attached media of the message.
+     * Count of the attached media of the message.
      */
     mediaCount?: number;
 }
@@ -1909,11 +1925,11 @@ type ClientEvents = {
         user: User;
         updateReasons: UserUpdateReason[];
     }) => void;
-    stateChanged: ({ state, error }: {
-        state: State;
+    initialized: () => void;
+    initFailed: ({ error }: {
         error?: ConnectionError;
     }) => void;
-    connectionStateChanged: (state: TwilsockConnectionState) => void;
+    connectionStateChanged: (state: ConnectionState) => void;
     connectionError: (data: ConnectionError) => void;
 };
 /**
@@ -1926,7 +1942,7 @@ type ClientEvents = {
  * * `'denied'` - client connection is denied because of invalid JWT access
  * token. User must refresh token in order to proceed
  */
-type ConnectionState = TwilsockConnectionState;
+type ConnectionState = "disconnected" | "connecting" | "connected";
 /**
  * State of the client. Possible values are as follows:
  * * `'failed'` - the client failed to initialize
@@ -1954,7 +1970,7 @@ interface ClientOptions {
     region?: string;
     productId?: string;
     twilsockClient?: TwilsockClient;
-    transport?: Transport;
+    transport?: TwilsockClient;
     notificationsClient?: NotificationClient;
     syncClient?: SyncClient;
     typingIndicatorTimeoutOverride?: number;
@@ -1974,6 +1990,10 @@ interface ClientOptions {
     typingUri?: string;
     apiUri?: string;
 }
+type ConnectionError = {
+    terminal: boolean;
+    message: string;
+};
 /**
  * Options for {@link Client.createConversation}.
  */
@@ -2166,16 +2186,20 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      */
     static readonly userUpdated = "userUpdated";
     /**
-     * Fired when the state of the client has been changed.
+     * Fired when the client has completed initialization successfully.
+     * @event
+     */
+    static readonly initialized = "initialized";
+    /**
+     * Fired when the client initialization failed.
      *
      * Parameters:
      * 1. object `data` - info object provided with the event. It has the
-     * following properties:
-     *     * {@link State} `state` - the new client state
+     * following property:
      *     * Error? `error` - the initialization error if present
      * @event
      */
-    static readonly stateChanged = "stateChanged";
+    static readonly initFailed = "initFailed";
     /**
      * Fired when the connection state of the client has been changed.
      *
@@ -2220,7 +2244,7 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
     /**
      * Client connection state.
      */
-    connectionState: ConnectionState;
+    connectionState: ConnectionState | "unknown";
     /**
      * Promise that resolves on successful initialization.
      */
@@ -2284,26 +2308,6 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * initialization was completed.
      */
     get reachabilityEnabled(): boolean;
-    /**
-     * @deprecated Call constructor directly.
-     *
-     * Factory method to create a Conversations client instance.
-     *
-     * The factory method will automatically trigger connection.
-     * Do not use it if you need finer-grained control.
-     *
-     * Since this method returns an already-initialized client, some of the events
-     * will be lost because they happen *before* the initialization. It is
-     * recommended that `client.onWithReplay` is used as opposed to `client.on`
-     * for subscribing to client events. The `client.onWithReplay` will re-emit
-     * the most recent value for a given event if it emitted before the
-     * subscription.
-     *
-     * @param token Access token.
-     * @param options Options to customize the client.
-     * @returns Returns a fully initialized client.
-     */
-    static create(token: string, options?: ClientOptions | null): Promise<Client>;
     /**
      * Static method for push notification payload parsing. Returns parsed push as
      * a {@link PushNotification} object.
@@ -2339,7 +2343,7 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * @param conversationSid Conversation sid
      * @internal
      */
-    peekConversationBySid(conversationSid: string): Promise<Conversation>;
+    private peekConversationBySid;
     /**
      * Get a known conversation by its unique identifier name.
      * @param uniqueName The unique identifier name of the conversation.
@@ -2439,4 +2443,5 @@ declare class NotificationTypes {
     static readonly REMOVED_FROM_CONVERSATION = "twilio.conversations.removed_from_conversation";
     static readonly CONSUMPTION_UPDATE = "twilio.channel.consumption_update";
 }
-export { Conversation, ConversationBindings, ConversationEmailBinding, ConversationUpdateReason, ConversationStatus, NotificationLevel, ConversationState, ConversationUpdatedEventArgs, SendMediaOptions, SendEmailOptions, LastMessage, Participant, ParticipantUpdateReason, ParticipantType, ParticipantUpdatedEventArgs, ParticipantBindings, ParticipantEmailBinding, ParticipantEmailLevel, Message, MessageUpdateReason, MessageType, MessageUpdatedEventArgs, Media, MediaCategory$0 as MediaCategory, AggregatedDeliveryReceipt, DeliveryAmount, DetailedDeliveryReceipt, DeliveryStatus, RestPaginator, MessageBuilder, UnsentMessage, Paginator, ParticipantBindingOptions, User, UserUpdateReason, UserUpdatedEventArgs, PushNotification, PushNotificationType, PushNotificationDescriptor, PushNotificationData, NotificationTypes, Client, State, ConnectionState, NotificationsChannelType, ClientOptions, CreateConversationOptions, ConversationLimits, JSONValue, JSONObject, JSONArray };
+export { Conversation, ConversationBindings, ConversationEmailBinding, ConversationUpdateReason, ConversationStatus, NotificationLevel, ConversationState, ConversationUpdatedEventArgs, SendMediaOptions, SendEmailOptions, LastMessage, Participant, ParticipantUpdateReason, ParticipantType, ParticipantUpdatedEventArgs, ParticipantBindings, ParticipantEmailBinding, ParticipantEmailLevel, Message, MessageUpdateReason, MessageType, MessageUpdatedEventArgs, Media, MediaCategory$0 as MediaCategory, AggregatedDeliveryReceipt, DeliveryAmount, DetailedDeliveryReceipt, DeliveryStatus, RestPaginator, MessageBuilder, UnsentMessage, Paginator, ParticipantBindingOptions, User, UserUpdateReason, UserUpdatedEventArgs, PushNotification, PushNotificationType, PushNotificationDescriptor, PushNotificationData, NotificationTypes, Client, State, ConnectionState, NotificationsChannelType, ClientOptions, CreateConversationOptions, ConversationLimits, CancellablePromise };
+export { JSONValue, JSONObject, JSONArray } from "@twilio/shared";