Message Types

type AnyMessageContent =
  | AnyRegularMessageContent
  | { forward: WAMessage; force?: boolean }
  | { delete: WAMessageKey }
  | { disappearingMessagesInChat: boolean | number }
  | { limitSharing: boolean }

type AnyRegularMessageContent = (
  | TextMessageContent
  | AnyMediaMessageContent
  | { event: EventMessageOptions }
  | PollMessageContent
  | ContactsMessageContent
  | LocationMessageContent
  | { react: proto.Message.IReactionMessage }
  | ButtonReplyMessageContent
  | GroupInviteMessageContent
  | ListReplyMessageContent
  | PinMessageContent
  | ProductMessageContent
  | SharePhoneNumber
  | RequestPhoneNumber
) & ViewOnce

type TextMessageContent = {
  text: string
  linkPreview?: WAUrlInfo | null
} & Mentionable & Contextable & Editable

type AnyMediaMessageContent = (
  | ImageMessageContent
  | VideoMessageContent
  | AudioMessageContent
  | StickerMessageContent
  | DocumentMessageContent
) & { mimetype?: string } & Editable

type ImageMessageContent = {
  image: WAMediaUpload
  caption?: string
  jpegThumbnail?: string
} & Mentionable & Contextable & WithDimensions

type VideoMessageContent = {
  video: WAMediaUpload
  caption?: string
  gifPlayback?: boolean
  jpegThumbnail?: string
  ptv?: boolean
} & Mentionable & Contextable & WithDimensions

type AudioMessageContent = {
  audio: WAMediaUpload
  ptt?: boolean
  seconds?: number
}

type StickerMessageContent = {
  sticker: WAMediaUpload
  isAnimated?: boolean
} & WithDimensions

type DocumentMessageContent = {
  document: WAMediaUpload
  mimetype: string
  fileName?: string
  caption?: string
} & Contextable

type PollMessageContent = {
  poll: PollMessageOptions
} & Mentionable & Contextable & Editable

type PollMessageOptions = {
  name: string
  selectableCount?: number
  values: string[]
  messageSecret?: Uint8Array
  toAnnouncementGroup?: boolean
}

type EventMessageOptions = {
  name: string
  description?: string
  startDate: Date
  endDate?: Date
  location?: WALocationMessage
  call?: 'audio' | 'video'
  isCancelled?: boolean
  isScheduleCall?: boolean
  extraGuestsAllowed?: boolean
  messageSecret?: Uint8Array
}

type ReactionMessage = {
  react: proto.Message.IReactionMessage
}

type ContactsMessageContent = {
  contacts: {
    displayName?: string
    contacts: proto.Message.IContactMessage[]
  }
}

type LocationMessageContent = {
  location: WALocationMessage
}

type WALocationMessage = proto.Message.ILocationMessage

type ProductMessageContent = {
  product: WASendableProduct
  businessOwnerJid?: string
  body?: string
  footer?: string
}

type WASendableProduct = Omit<proto.Message.ProductMessage.IProductSnapshot, 'productImage'> & {
  productImage: WAMediaUpload
}

type ButtonReplyMessageContent = {
  buttonReply: ButtonReplyInfo
  type: 'template' | 'plain'
}

type ButtonReplyInfo = {
  displayText: string
  id: string
  index: number
}

type ListReplyMessageContent = {
  listReply: Omit<proto.Message.IListResponseMessage, 'contextInfo'>
}

type GroupInviteMessageContent = {
  groupInvite: GroupInviteInfo
}

type GroupInviteInfo = {
  inviteCode: string
  inviteExpiration: number
  text: string
  jid: string
  subject: string
}

type ForwardMessage = {
  forward: WAMessage
  force?: boolean
}

type DeleteMessage = {
  delete: WAMessageKey
}

type PinMessage = {
  pin: WAMessageKey
  type: proto.PinInChat.Type
  time?: 86400 | 604800 | 2592000
}

type DisappearingMessagesToggle = {
  disappearingMessagesInChat: boolean | number
}

type LimitSharingToggle = {
  limitSharing: boolean
}

type SharePhoneNumber = {
  sharePhoneNumber: boolean
}

type RequestPhoneNumber = {
  requestPhoneNumber: boolean
}

type ViewOnce = {
  viewOnce?: boolean
}

type Mentionable = {
  mentions?: string[]
}

type Contextable = {
  contextInfo?: proto.IContextInfo
}

type Editable = {
  edit?: WAMessageKey
}

type WithDimensions = {
  width?: number
  height?: number
}