mirror of
https://github.com/FranP-code/Baileys.git
synced 2025-10-13 00:32:22 +00:00
chore: format everything
This commit is contained in:
canove
@@ -17,7 +17,12 @@ export type WAMessageKey = proto.IMessageKey
|
||||
export type WATextMessage = proto.Message.IExtendedTextMessage
|
||||
export type WAContextInfo = proto.IContextInfo
|
||||
export type WALocationMessage = proto.Message.ILocationMessage
|
||||
export type WAGenericMediaMessage = proto.Message.IVideoMessage | proto.Message.IImageMessage | proto.Message.IAudioMessage | proto.Message.IDocumentMessage | proto.Message.IStickerMessage
|
||||
export type WAGenericMediaMessage =
|
||||
| proto.Message.IVideoMessage
|
||||
| proto.Message.IImageMessage
|
||||
| proto.Message.IAudioMessage
|
||||
| proto.Message.IDocumentMessage
|
||||
| proto.Message.IStickerMessage
|
||||
export const WAMessageStubType = proto.WebMessageInfo.StubType
|
||||
export const WAMessageStatus = proto.WebMessageInfo.Status
|
||||
import { ILogger } from '../Utils/logger'
|
||||
@@ -27,235 +32,261 @@ export type WAMediaUpload = Buffer | WAMediaPayloadStream | WAMediaPayloadURL
|
||||
/** Set of message types that are supported by the library */
|
||||
export type MessageType = keyof proto.Message
|
||||
|
||||
export type DownloadableMessage = { mediaKey?: Uint8Array | null, directPath?: string | null, url?: string | null }
|
||||
export type DownloadableMessage = { mediaKey?: Uint8Array | null; directPath?: string | null; url?: string | null }
|
||||
|
||||
export type MessageReceiptType = 'read' | 'read-self' | 'hist_sync' | 'peer_msg' | 'sender' | 'inactive' | 'played' | undefined
|
||||
export type MessageReceiptType =
|
||||
| 'read'
|
||||
| 'read-self'
|
||||
| 'hist_sync'
|
||||
| 'peer_msg'
|
||||
| 'sender'
|
||||
| 'inactive'
|
||||
| 'played'
|
||||
| undefined
|
||||
|
||||
export type MediaConnInfo = {
|
||||
auth: string
|
||||
ttl: number
|
||||
hosts: { hostname: string, maxContentLengthBytes: number }[]
|
||||
fetchDate: Date
|
||||
auth: string
|
||||
ttl: number
|
||||
hosts: { hostname: string; maxContentLengthBytes: number }[]
|
||||
fetchDate: Date
|
||||
}
|
||||
|
||||
export interface WAUrlInfo {
|
||||
'canonical-url': string
|
||||
'matched-text': string
|
||||
title: string
|
||||
description?: string
|
||||
jpegThumbnail?: Buffer
|
||||
highQualityThumbnail?: proto.Message.IImageMessage
|
||||
originalThumbnailUrl?: string
|
||||
'canonical-url': string
|
||||
'matched-text': string
|
||||
title: string
|
||||
description?: string
|
||||
jpegThumbnail?: Buffer
|
||||
highQualityThumbnail?: proto.Message.IImageMessage
|
||||
originalThumbnailUrl?: string
|
||||
}
|
||||
|
||||
// types to generate WA messages
|
||||
type Mentionable = {
|
||||
/** list of jids that are mentioned in the accompanying text */
|
||||
mentions?: string[]
|
||||
/** list of jids that are mentioned in the accompanying text */
|
||||
mentions?: string[]
|
||||
}
|
||||
type Contextable = {
|
||||
/** add contextInfo to the message */
|
||||
contextInfo?: proto.IContextInfo
|
||||
/** add contextInfo to the message */
|
||||
contextInfo?: proto.IContextInfo
|
||||
}
|
||||
type ViewOnce = {
|
||||
viewOnce?: boolean
|
||||
viewOnce?: boolean
|
||||
}
|
||||
|
||||
type Editable = {
|
||||
edit?: WAMessageKey
|
||||
edit?: WAMessageKey
|
||||
}
|
||||
type WithDimensions = {
|
||||
width?: number
|
||||
height?: number
|
||||
width?: number
|
||||
height?: number
|
||||
}
|
||||
|
||||
export type PollMessageOptions = {
|
||||
name: string
|
||||
selectableCount?: number
|
||||
values: string[]
|
||||
/** 32 byte message secret to encrypt poll selections */
|
||||
messageSecret?: Uint8Array
|
||||
toAnnouncementGroup?: boolean
|
||||
name: string
|
||||
selectableCount?: number
|
||||
values: string[]
|
||||
/** 32 byte message secret to encrypt poll selections */
|
||||
messageSecret?: Uint8Array
|
||||
toAnnouncementGroup?: boolean
|
||||
}
|
||||
|
||||
type SharePhoneNumber = {
|
||||
sharePhoneNumber: boolean
|
||||
sharePhoneNumber: boolean
|
||||
}
|
||||
|
||||
type RequestPhoneNumber = {
|
||||
requestPhoneNumber: boolean
|
||||
requestPhoneNumber: boolean
|
||||
}
|
||||
|
||||
export type MediaType = keyof typeof MEDIA_HKDF_KEY_MAPPING
|
||||
export type AnyMediaMessageContent = (
|
||||
({
|
||||
image: WAMediaUpload
|
||||
caption?: string
|
||||
jpegThumbnail?: string
|
||||
} & Mentionable & Contextable & WithDimensions)
|
||||
| ({
|
||||
video: WAMediaUpload
|
||||
caption?: string
|
||||
gifPlayback?: boolean
|
||||
jpegThumbnail?: string
|
||||
/** if set to true, will send as a `video note` */
|
||||
ptv?: boolean
|
||||
} & Mentionable & Contextable & WithDimensions)
|
||||
| {
|
||||
audio: WAMediaUpload
|
||||
/** if set to true, will send as a `voice note` */
|
||||
ptt?: boolean
|
||||
/** optionally tell the duration of the audio */
|
||||
seconds?: number
|
||||
}
|
||||
| ({
|
||||
sticker: WAMediaUpload
|
||||
isAnimated?: boolean
|
||||
} & WithDimensions) | ({
|
||||
document: WAMediaUpload
|
||||
mimetype: string
|
||||
fileName?: string
|
||||
caption?: string
|
||||
} & Contextable))
|
||||
& { mimetype?: string } & Editable
|
||||
| ({
|
||||
image: WAMediaUpload
|
||||
caption?: string
|
||||
jpegThumbnail?: string
|
||||
} & Mentionable &
|
||||
Contextable &
|
||||
WithDimensions)
|
||||
| ({
|
||||
video: WAMediaUpload
|
||||
caption?: string
|
||||
gifPlayback?: boolean
|
||||
jpegThumbnail?: string
|
||||
/** if set to true, will send as a `video note` */
|
||||
ptv?: boolean
|
||||
} & Mentionable &
|
||||
Contextable &
|
||||
WithDimensions)
|
||||
| {
|
||||
audio: WAMediaUpload
|
||||
/** if set to true, will send as a `voice note` */
|
||||
ptt?: boolean
|
||||
/** optionally tell the duration of the audio */
|
||||
seconds?: number
|
||||
}
|
||||
| ({
|
||||
sticker: WAMediaUpload
|
||||
isAnimated?: boolean
|
||||
} & WithDimensions)
|
||||
| ({
|
||||
document: WAMediaUpload
|
||||
mimetype: string
|
||||
fileName?: string
|
||||
caption?: string
|
||||
} & Contextable)
|
||||
) & { mimetype?: string } & Editable
|
||||
|
||||
export type ButtonReplyInfo = {
|
||||
displayText: string
|
||||
id: string
|
||||
index: number
|
||||
displayText: string
|
||||
id: string
|
||||
index: number
|
||||
}
|
||||
|
||||
export type GroupInviteInfo = {
|
||||
inviteCode: string
|
||||
inviteExpiration: number
|
||||
text: string
|
||||
jid: string
|
||||
subject: string
|
||||
inviteCode: string
|
||||
inviteExpiration: number
|
||||
text: string
|
||||
jid: string
|
||||
subject: string
|
||||
}
|
||||
|
||||
export type WASendableProduct = Omit<proto.Message.ProductMessage.IProductSnapshot, 'productImage'> & {
|
||||
productImage: WAMediaUpload
|
||||
productImage: WAMediaUpload
|
||||
}
|
||||
|
||||
export type AnyRegularMessageContent = (
|
||||
({
|
||||
text: string
|
||||
linkPreview?: WAUrlInfo | null
|
||||
}
|
||||
& Mentionable & Contextable & Editable)
|
||||
| AnyMediaMessageContent
|
||||
| ({
|
||||
poll: PollMessageOptions
|
||||
} & Mentionable & Contextable & Editable)
|
||||
| {
|
||||
contacts: {
|
||||
displayName?: string
|
||||
contacts: proto.Message.IContactMessage[]
|
||||
}
|
||||
}
|
||||
| {
|
||||
location: WALocationMessage
|
||||
}
|
||||
| { react: proto.Message.IReactionMessage }
|
||||
| {
|
||||
buttonReply: ButtonReplyInfo
|
||||
type: 'template' | 'plain'
|
||||
}
|
||||
| {
|
||||
groupInvite: GroupInviteInfo
|
||||
}
|
||||
| {
|
||||
listReply: Omit<proto.Message.IListResponseMessage, 'contextInfo'>
|
||||
}
|
||||
| {
|
||||
pin: WAMessageKey
|
||||
type: proto.PinInChat.Type
|
||||
/**
|
||||
* 24 hours, 7 days, 30 days
|
||||
*/
|
||||
time?: 86400 | 604800 | 2592000
|
||||
}
|
||||
| {
|
||||
product: WASendableProduct
|
||||
businessOwnerJid?: string
|
||||
body?: string
|
||||
footer?: string
|
||||
} | SharePhoneNumber | RequestPhoneNumber
|
||||
) & ViewOnce
|
||||
| ({
|
||||
text: string
|
||||
linkPreview?: WAUrlInfo | null
|
||||
} & Mentionable &
|
||||
Contextable &
|
||||
Editable)
|
||||
| AnyMediaMessageContent
|
||||
| ({
|
||||
poll: PollMessageOptions
|
||||
} & Mentionable &
|
||||
Contextable &
|
||||
Editable)
|
||||
| {
|
||||
contacts: {
|
||||
displayName?: string
|
||||
contacts: proto.Message.IContactMessage[]
|
||||
}
|
||||
}
|
||||
| {
|
||||
location: WALocationMessage
|
||||
}
|
||||
| { react: proto.Message.IReactionMessage }
|
||||
| {
|
||||
buttonReply: ButtonReplyInfo
|
||||
type: 'template' | 'plain'
|
||||
}
|
||||
| {
|
||||
groupInvite: GroupInviteInfo
|
||||
}
|
||||
| {
|
||||
listReply: Omit<proto.Message.IListResponseMessage, 'contextInfo'>
|
||||
}
|
||||
| {
|
||||
pin: WAMessageKey
|
||||
type: proto.PinInChat.Type
|
||||
/**
|
||||
* 24 hours, 7 days, 30 days
|
||||
*/
|
||||
time?: 86400 | 604800 | 2592000
|
||||
}
|
||||
| {
|
||||
product: WASendableProduct
|
||||
businessOwnerJid?: string
|
||||
body?: string
|
||||
footer?: string
|
||||
}
|
||||
| SharePhoneNumber
|
||||
| RequestPhoneNumber
|
||||
) &
|
||||
ViewOnce
|
||||
|
||||
export type AnyMessageContent = AnyRegularMessageContent | {
|
||||
forward: WAMessage
|
||||
force?: boolean
|
||||
} | {
|
||||
/** Delete your message or anyone's message in a group (admin required) */
|
||||
delete: WAMessageKey
|
||||
} | {
|
||||
disappearingMessagesInChat: boolean | number
|
||||
}
|
||||
export type AnyMessageContent =
|
||||
| AnyRegularMessageContent
|
||||
| {
|
||||
forward: WAMessage
|
||||
force?: boolean
|
||||
}
|
||||
| {
|
||||
/** Delete your message or anyone's message in a group (admin required) */
|
||||
delete: WAMessageKey
|
||||
}
|
||||
| {
|
||||
disappearingMessagesInChat: boolean | number
|
||||
}
|
||||
|
||||
export type GroupMetadataParticipants = Pick<GroupMetadata, 'participants'>
|
||||
|
||||
type MinimalRelayOptions = {
|
||||
/** override the message ID with a custom provided string */
|
||||
messageId?: string
|
||||
/** should we use group metadata cache, or fetch afresh from the server; default assumed to be "true" */
|
||||
useCachedGroupMetadata?: boolean
|
||||
/** override the message ID with a custom provided string */
|
||||
messageId?: string
|
||||
/** should we use group metadata cache, or fetch afresh from the server; default assumed to be "true" */
|
||||
useCachedGroupMetadata?: boolean
|
||||
}
|
||||
|
||||
export type MessageRelayOptions = MinimalRelayOptions & {
|
||||
/** only send to a specific participant; used when a message decryption fails for a single user */
|
||||
participant?: { jid: string, count: number }
|
||||
/** additional attributes to add to the WA binary node */
|
||||
additionalAttributes?: { [_: string]: string }
|
||||
additionalNodes?: BinaryNode[]
|
||||
/** should we use the devices cache, or fetch afresh from the server; default assumed to be "true" */
|
||||
useUserDevicesCache?: boolean
|
||||
/** jid list of participants for status@broadcast */
|
||||
statusJidList?: string[]
|
||||
/** only send to a specific participant; used when a message decryption fails for a single user */
|
||||
participant?: { jid: string; count: number }
|
||||
/** additional attributes to add to the WA binary node */
|
||||
additionalAttributes?: { [_: string]: string }
|
||||
additionalNodes?: BinaryNode[]
|
||||
/** should we use the devices cache, or fetch afresh from the server; default assumed to be "true" */
|
||||
useUserDevicesCache?: boolean
|
||||
/** jid list of participants for status@broadcast */
|
||||
statusJidList?: string[]
|
||||
}
|
||||
|
||||
export type MiscMessageGenerationOptions = MinimalRelayOptions & {
|
||||
/** optional, if you want to manually set the timestamp of the message */
|
||||
/** optional, if you want to manually set the timestamp of the message */
|
||||
timestamp?: Date
|
||||
/** the message you want to quote */
|
||||
/** the message you want to quote */
|
||||
quoted?: WAMessage
|
||||
/** disappearing messages settings */
|
||||
ephemeralExpiration?: number | string
|
||||
/** timeout for media upload to WA server */
|
||||
mediaUploadTimeoutMs?: number
|
||||
/** jid list of participants for status@broadcast */
|
||||
statusJidList?: string[]
|
||||
/** backgroundcolor for status */
|
||||
backgroundColor?: string
|
||||
/** font type for status */
|
||||
font?: number
|
||||
/** if it is broadcast */
|
||||
broadcast?: boolean
|
||||
/** disappearing messages settings */
|
||||
ephemeralExpiration?: number | string
|
||||
/** timeout for media upload to WA server */
|
||||
mediaUploadTimeoutMs?: number
|
||||
/** jid list of participants for status@broadcast */
|
||||
statusJidList?: string[]
|
||||
/** backgroundcolor for status */
|
||||
backgroundColor?: string
|
||||
/** font type for status */
|
||||
font?: number
|
||||
/** if it is broadcast */
|
||||
broadcast?: boolean
|
||||
}
|
||||
export type MessageGenerationOptionsFromContent = MiscMessageGenerationOptions & {
|
||||
userJid: string
|
||||
}
|
||||
|
||||
export type WAMediaUploadFunction = (readStream: Readable, opts: { fileEncSha256B64: string, mediaType: MediaType, timeoutMs?: number }) => Promise<{ mediaUrl: string, directPath: string }>
|
||||
export type WAMediaUploadFunction = (
|
||||
readStream: Readable,
|
||||
opts: { fileEncSha256B64: string; mediaType: MediaType; timeoutMs?: number }
|
||||
) => Promise<{ mediaUrl: string; directPath: string }>
|
||||
|
||||
export type MediaGenerationOptions = {
|
||||
logger?: ILogger
|
||||
mediaTypeOverride?: MediaType
|
||||
upload: WAMediaUploadFunction
|
||||
/** cache media so it does not have to be uploaded again */
|
||||
mediaCache?: CacheStore
|
||||
mediaTypeOverride?: MediaType
|
||||
upload: WAMediaUploadFunction
|
||||
/** cache media so it does not have to be uploaded again */
|
||||
mediaCache?: CacheStore
|
||||
|
||||
mediaUploadTimeoutMs?: number
|
||||
mediaUploadTimeoutMs?: number
|
||||
|
||||
options?: AxiosRequestConfig
|
||||
options?: AxiosRequestConfig
|
||||
|
||||
backgroundColor?: string
|
||||
backgroundColor?: string
|
||||
|
||||
font?: number
|
||||
font?: number
|
||||
}
|
||||
export type MessageContentGenerationOptions = MediaGenerationOptions & {
|
||||
getUrlInfo?: (text: string) => Promise<WAUrlInfo | undefined>
|
||||
getProfilePicUrl?: (jid: string, type: 'image' | 'preview') => Promise<string | undefined>
|
||||
getProfilePicUrl?: (jid: string, type: 'image' | 'preview') => Promise<string | undefined>
|
||||
}
|
||||
export type MessageGenerationOptions = MessageContentGenerationOptions & MessageGenerationOptionsFromContent
|
||||
|
||||
@@ -268,16 +299,16 @@ export type MessageUpsertType = 'append' | 'notify'
|
||||
|
||||
export type MessageUserReceipt = proto.IUserReceipt
|
||||
|
||||
export type WAMessageUpdate = { update: Partial<WAMessage>, key: proto.IMessageKey }
|
||||
export type WAMessageUpdate = { update: Partial<WAMessage>; key: proto.IMessageKey }
|
||||
|
||||
export type WAMessageCursor = { before: WAMessageKey | undefined } | { after: WAMessageKey | undefined }
|
||||
|
||||
export type MessageUserReceiptUpdate = { key: proto.IMessageKey, receipt: MessageUserReceipt }
|
||||
export type MessageUserReceiptUpdate = { key: proto.IMessageKey; receipt: MessageUserReceipt }
|
||||
|
||||
export type MediaDecryptionKeyInfo = {
|
||||
iv: Buffer
|
||||
cipherKey: Buffer
|
||||
macKey?: Buffer
|
||||
iv: Buffer
|
||||
cipherKey: Buffer
|
||||
macKey?: Buffer
|
||||
}
|
||||
|
||||
export type MinimalMessage = Pick<proto.IWebMessageInfo, 'key' | 'messageTimestamp'>
|
||||
|
||||
Reference in New Issue
Block a user