finalize multi-device

src/Types/index.ts

@@ -2,134 +2,56 @@ export * from './Auth'
 export * from './GroupMetadata'
 export * from './Chat'
 export * from './Contact'
-export * from './Store'
+export * from './State'
 export * from './Message'
 
 import type EventEmitter from "events"
 import type { Agent } from "https"
 import type { Logger } from "pino"
 import type { URL } from "url"
-import type BinaryNode from "../BinaryNode"
-import { AnyAuthenticationCredentials, AuthenticationCredentials } from './Auth'
+
+import { AuthenticationState } from './Auth'
 import { Chat, PresenceData } from './Chat'
 import { Contact } from './Contact'
-import { ConnectionState } from './Store'
+import { ConnectionState } from './State'
 
 import { GroupMetadata, ParticipantAction } from './GroupMetadata'
-import { MessageInfo, MessageInfoUpdate, MessageUpdateType, WAMessage, WAMessageKey, WAMessageUpdate } from './Message'
-import { proto } from '../../WAMessage'
-
-/** used for binary messages */
-export enum WAMetric {
-    debugLog = 1,
-    queryResume = 2,
-    liveLocation = 3,
-    queryMedia = 4,
-    queryChat = 5,
-    queryContact = 6,
-    queryMessages = 7,
-    presence = 8,
-    presenceSubscribe = 9,
-    group = 10,
-    read = 11,
-    chat = 12,
-    received = 13,
-    picture = 14,
-    status = 15,
-    message = 16,
-    queryActions = 17,
-    block = 18,
-    queryGroup = 19,
-    queryPreview = 20,
-    queryEmoji = 21,
-    queryRead = 22,
-    queryVCard = 29,
-    queryStatus = 30,
-    queryStatusUpdate = 31,
-    queryLiveLocation = 33,
-    queryLabel = 36,
-    queryQuickReply = 39
-}
-
-/** used for binary messages */
-export enum WAFlag {
-    available = 160,
-    other = 136, // don't know this one
-    ignore = 1 << 7,
-    acknowledge = 1 << 6,
-    unavailable = 1 << 4,
-    expires = 1 << 3,
-    composing = 1 << 2,
-    recording = 1 << 2,
-    paused = 1 << 2
-}
-
-/** Tag used with binary queries */
-export type WATag = [WAMetric, WAFlag]
-
-export type SocketSendMessageOptions = {
-	json: BinaryNode | any[]
-	binaryTag?: WATag
-	tag?: string
-	longTag?: boolean
-}
+import { MessageInfoUpdate, MessageUpdateType, WAMessage, WAMessageUpdate } from './Message'
 
 export type WAVersion = [number, number, number]
 export type WABrowserDescription = [string, string, string]
 export type ReconnectMode = 'no-reconnects' | 'on-any-error' | 'on-connection-error'
 
 export type SocketConfig = {
+    /** provide an auth state object to maintain the auth state */
+    auth?: AuthenticationState
     /** the WS url to connect to WA */
     waWebSocketUrl: string | URL 
-    /** Fails the connection if the connection times out in this time interval or no data is received */
+    /** Fails the connection if the socket times out in this interval */
 	connectTimeoutMs: number
-    /** max time for the phone to respond to a connectivity test */
-	phoneResponseTimeMs: number
     /** ping-pong interval for WS connection */
     keepAliveIntervalMs: number
-
-    expectResponseTimeout: number
     /** proxy agent */
 	agent?: Agent
+    /** pino logger */
 	logger: Logger
-
+    /** version to connect with */
     version: WAVersion
+    /** override browser config */
 	browser: WABrowserDescription
-	/** maximum attempts to connect */
-	maxRetries: number
-	connectCooldownMs: number
 	/** agent used for fetch requests -- uploading/downloading media */
 	fetchAgent?: Agent
-    /** credentials used to sign back in */
-    credentials?: AnyAuthenticationCredentials | string
-	/** 
-	 * Sometimes WA does not send the chats, 
-	 * this keeps pinging the phone to send the chats over
-	 * */
-	queryChatsTillReceived?: boolean
-	/**  */
-	pendingRequestTimeoutMs: number
-	reconnectMode: ReconnectMode
-    maxQRCodes: number
     /** should the QR be printed in the terminal */
     printQRInTerminal: boolean
-
-    phoneConnectionChanged: (connected: boolean) => void
-}
-
-export type SocketQueryOptions = SocketSendMessageOptions & {
-	timeoutMs?: number
-	expect200?: boolean
-	requiresPhoneConnection?: boolean
 }
 
 export enum DisconnectReason {
 	connectionClosed = 428,
-    connectionReplaced = 440,
 	connectionLost = 408,
     timedOut = 408,
-	credentialsInvalidated = 401,
-    badSession = 500
+	loggedOut = 401,
+    badSession = 500,
+    restartRequired = 410
 }
 
 export type WAInitResponse = {
@@ -160,36 +82,40 @@ export type WABusinessProfile = {
     wid?: string
 }
 
-export type QueryOptions = SocketQueryOptions & {
-	waitForOpen?: boolean
-	maxRetries?: number
-	startDebouncedTimeout?: boolean
-}
 export type CurveKeyPair = { private: Uint8Array; public: Uint8Array }
 
 export type BaileysEventMap = {
+    /** connection state has been updated -- WS closed, opened, connecting etc. */
 	'connection.update': Partial<ConnectionState>
-    'credentials.update': AuthenticationCredentials
-
-    'chats.set': { chats: Chat[] }
+    /** auth state updated -- some pre keys, or identity keys etc. */
+    'auth-state.update': AuthenticationState
+    /** set chats (history sync), messages are reverse chronologically sorted */
+    'chats.set': { chats: Chat[], messages: WAMessage[] }
+    /** upsert chats */
     'chats.upsert': Chat[]
+    /** update the given chats */
     'chats.update': Partial<Chat>[]
+    /** delete chats with given ID */
     'chats.delete': string[]
+    /** presence of contact in a chat updated */
+    'presence.update': { id: string, presences: { [participant: string]: PresenceData }  }
 
-    'presence.update': { jid: string, presences: { [participant: string]: PresenceData }  }
-
-    'contacts.set': { contacts: Contact[] }
     'contacts.upsert': Contact[]
     'contacts.update': Partial<Contact>[] 
     
     'messages.delete': { jid: string, ids: string[] } | { jid: string, all: true }
     'messages.update': WAMessageUpdate[]
+    /** 
+     * add/update the given messages. If they were received while the connection was online, 
+     * the update will have type: "notify"
+     *  */
     'messages.upsert': { messages: WAMessage[], type: MessageUpdateType }
 
     'message-info.update': MessageInfoUpdate[]
 
     'groups.update': Partial<GroupMetadata>[]
-    'group-participants.update': { jid: string, participants: string[], action: ParticipantAction }
+    /** apply an action to participants in a group */
+    'group-participants.update': { id: string, participants: string[], action: ParticipantAction }
 
     'blocklist.set': { blocklist: string[] }
     'blocklist.update': { blocklist: string[], type: 'add' | 'remove' }