Socket types

export type WASocket = ReturnType<typeof makeWASocket>

sendMessage(
  jid: string,
  content: AnyMessageContent,
  options?: MiscMessageGenerationOptions
): Promise<WAMessage>

// Send text message
await sock.sendMessage('[email protected]', { 
  text: 'Hello!' 
})

// Send image with caption
await sock.sendMessage('[email protected]', {
  image: { url: './photo.jpg' },
  caption: 'Check this out!'
})

// Reply to a message
await sock.sendMessage('[email protected]', 
  { text: 'Thanks!' },
  { quoted: messageObj }
)

relayMessage(
  jid: string,
  message: proto.IMessage,
  options: MessageRelayOptions
): Promise<string>

sendReceipt(
  jid: string,
  participant: string | undefined,
  messageIds: string[],
  type: MessageReceiptType
): Promise<void>

readMessages(keys: WAMessageKey[]): Promise<void>

await sock.readMessages([message.key])

groupCreate(
  subject: string,
  participants: string[]
): Promise<GroupMetadata>

const group = await sock.groupCreate('My Group', [
  '[email protected]',
  '[email protected]'
])
console.log('Created group:', group.id)

groupMetadata(jid: string): Promise<GroupMetadata>

const metadata = await sock.groupMetadata('[email protected]')
console.log('Group subject:', metadata.subject)
console.log('Participants:', metadata.participants.length)

groupUpdateSubject(jid: string, subject: string): Promise<void>

groupUpdateDescription(
  jid: string,
  description?: string
): Promise<void>

groupParticipantsUpdate(
  jid: string,
  participants: string[],
  action: ParticipantAction
): Promise<Array<{ status: string; jid: string }>>

// Add participants
await sock.groupParticipantsUpdate(
  '[email protected]',
  ['[email protected]'],
  'add'
)

// Make admin
await sock.groupParticipantsUpdate(
  '[email protected]',
  ['[email protected]'],
  'promote'
)

groupSettingUpdate(
  jid: string,
  setting: 'announcement' | 'not_announcement' | 'locked' | 'unlocked'
): Promise<void>

groupLeave(id: string): Promise<void>

groupInviteCode(jid: string): Promise<string>

groupRevokeInvite(jid: string): Promise<string>

groupAcceptInvite(code: string): Promise<string>

groupGetInviteInfo(code: string): Promise<GroupMetadata>

groupToggleEphemeral(
  jid: string,
  ephemeralExpiration: number
): Promise<void>

groupFetchAllParticipating(): Promise<{ [jid: string]: GroupMetadata }>

groupRequestParticipantsList(jid: string): Promise<any[]>

groupRequestParticipantsUpdate(
  jid: string,
  participants: string[],
  action: 'approve' | 'reject'
): Promise<Array<{ status: string; jid: string }>>

groupMemberAddMode(
  jid: string,
  mode: 'admin_add' | 'all_member_add'
): Promise<void>

groupJoinApprovalMode(
  jid: string,
  mode: 'on' | 'off'
): Promise<void>

communityCreate(
  subject: string,
  body: string
): Promise<GroupMetadata | null>

communityMetadata(jid: string): Promise<GroupMetadata>

communityFetchLinkedGroups(jid: string): Promise<{
  communityJid: string
  isCommunity: boolean
  linkedGroups: Array<{
    id?: string
    subject: string
    creation?: number
    owner?: string
    size?: number
  }>
}>

communityLinkGroup(
  groupJid: string,
  parentCommunityJid: string
): Promise<void>

communityUnlinkGroup(
  groupJid: string,
  parentCommunityJid: string
): Promise<void>

communityAcceptInvite(code: string): Promise<string>

communityInviteCode(jid: string): Promise<string>

newsletterCreate(
  name: string,
  description?: string
): Promise<NewsletterMetadata>

newsletterMetadata(
  type: 'invite' | 'jid',
  key: string
): Promise<NewsletterMetadata | null>

newsletterFollow(jid: string): Promise<any>

newsletterUnfollow(jid: string): Promise<any>

newsletterUpdateName(jid: string, name: string): Promise<any>

newsletterUpdateDescription(
  jid: string,
  description: string
): Promise<any>

newsletterUpdatePicture(
  jid: string,
  content: WAMediaUpload
): Promise<any>

newsletterReactMessage(
  jid: string,
  serverId: string,
  reaction?: string
): Promise<void>

newsletterFetchMessages(
  jid: string,
  count: number,
  since: number,
  after: number
): Promise<BinaryNode>

updateProfilePicture(
  jid: string,
  content: WAMediaUpload
): Promise<void>

removeProfilePicture(jid: string): Promise<void>

updateProfileName(name: string): Promise<void>

updateProfileStatus(status: string): Promise<void>

profilePictureUrl(
  jid: string,
  type?: 'image' | 'preview'
): Promise<string | undefined>

fetchStatus(jid: string): Promise<{ status: string; setAt: Date }>

updateLastSeenPrivacy(
  value: WAPrivacyValue
): Promise<void>

updateOnlinePrivacy(
  value: WAPrivacyOnlineValue
): Promise<void>

updateProfilePicturePrivacy(
  value: WAPrivacyValue
): Promise<void>

updateStatusPrivacy(
  value: WAPrivacyValue
): Promise<void>

updateReadReceiptsPrivacy(
  value: WAReadReceiptsValue
): Promise<void>

updateGroupsAddPrivacy(
  value: WAPrivacyGroupAddValue
): Promise<void>

fetchPrivacySettings(
  force?: boolean
): Promise<{ [_: string]: string }>

getCatalog(options: GetCatalogOptions): Promise<{
  products: Product[]
  nextCursor?: string
}>

productCreate(product: ProductCreate): Promise<Product>

productUpdate(
  productId: string,
  update: ProductUpdate
): Promise<Product>

productDelete(productIds: string[]): Promise<void>

updateBussinesProfile(
  args: UpdateBussinesProfileProps
): Promise<BinaryNode>

getPrivacyTokens(jids: string[]): Promise<BinaryNode>

assertSessions(
  jids: string[],
  force?: boolean
): Promise<boolean>

refreshMediaConn(forceGet?: boolean): Promise<MediaConnInfo>

waUploadToServer: WAMediaUploadFunction

query(node: BinaryNode): Promise<BinaryNode>

sendNode(node: BinaryNode): Promise<void>

logout(): Promise<void>

end(error?: Error): void

sendPresenceUpdate(
  type: WAPresence,
  toJid?: string
): Promise<void>

// Set online
await sock.sendPresenceUpdate('available')

// Show typing in a chat
await sock.sendPresenceUpdate('composing', '[email protected]')

// Stop typing
await sock.sendPresenceUpdate('paused', '[email protected]')

presenceSubscribe(jid: string): Promise<void>

updateBlockStatus(
  jid: string,
  action: 'block' | 'unblock'
): Promise<void>

fetchBlocklist(): Promise<string[]>

chatModify(
  modification: ChatModification,
  jid: string
): Promise<void>

// Archive chat
await sock.chatModify({ archive: true }, '[email protected]')

// Pin chat
await sock.chatModify({ pin: true }, '[email protected]')

// Mute chat for 8 hours
await sock.chatModify(
  { mute: Date.now() + 8 * 60 * 60 * 1000 },
  '[email protected]'
)