@sixcore/baileys 1.0.0 → 1.0.1

package/src/Types/Message.ts

@@ -1,424 +0,0 @@
-import type { Readable } from 'stream'
-import type { URL } from 'url'
-import { proto } from '../../WAProto/index.js'
-import type { MediaType } from '../Defaults'
-import type { BinaryNode } from '../WABinary'
-import type { GroupMetadata } from './GroupMetadata'
-import type { CacheStore } from './Socket'
-
-// export the WAMessage Prototypes
-export { proto as WAProto }
-export type WAMessage = proto.IWebMessageInfo & {
-	key: WAMessageKey
-	messageStubParameters?: any
-	category?: string
-	retryCount?: number
-}
-export type WAMessageContent = proto.IMessage
-export type WAContactMessage = proto.Message.IContactMessage
-export type WAContactsArrayMessage = proto.Message.IContactsArrayMessage
-export type WAMessageKey = proto.IMessageKey & {
-	remoteJidAlt?: string
-	participantAlt?: string
-	server_id?: string
-	addressingMode?: string
-	isViewOnce?: boolean // TODO: remove out of the message key, place in WebMessageInfo
-}
-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 const WAMessageStubType = proto.WebMessageInfo.StubType
-export const WAMessageStatus = proto.WebMessageInfo.Status
-import type { ILogger } from '../Utils/logger'
-export type WAMediaPayloadURL = { url: URL | string }
-export type WAMediaPayloadStream = { stream: Readable }
-export type WAMediaUpload = Buffer | WAMediaPayloadStream | WAMediaPayloadURL
-/** Set of message types that are supported by the library */
-export type MessageType = keyof proto.Message
-
-export enum WAMessageAddressingMode {
-	PN = 'pn',
-	LID = 'lid'
-}
-
-export type MessageWithContextInfo =
-	| 'imageMessage'
-	| 'contactMessage'
-	| 'locationMessage'
-	| 'extendedTextMessage'
-	| 'documentMessage'
-	| 'audioMessage'
-	| 'videoMessage'
-	| 'call'
-	| 'contactsArrayMessage'
-	| 'liveLocationMessage'
-	| 'templateMessage'
-	| 'stickerMessage'
-	| 'groupInviteMessage'
-	| 'templateButtonReplyMessage'
-	| 'productMessage'
-	| 'listMessage'
-	| 'orderMessage'
-	| 'listResponseMessage'
-	| 'buttonsMessage'
-	| 'buttonsResponseMessage'
-	| 'interactiveMessage'
-	| 'interactiveResponseMessage'
-	| 'pollCreationMessage'
-	| 'requestPhoneNumberMessage'
-	| 'messageHistoryBundle'
-	| 'eventMessage'
-	| 'newsletterAdminInviteMessage'
-	| 'albumMessage'
-	| 'stickerPackMessage'
-	| 'pollResultSnapshotMessage'
-	| 'messageHistoryNotice'
-
-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 MediaConnInfo = {
-	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
-}
-
-// types to generate WA messages
-type Mentionable = {
-	/** list of jids that are mentioned in the accompanying text */
-	mentions?: string[]
-}
-type Contextable = {
-	/** add contextInfo to the message */
-	contextInfo?: proto.IContextInfo
-}
-type ViewOnce = {
-	viewOnce?: boolean
-}
-
-type Editable = {
-	edit?: WAMessageKey
-}
-type WithDimensions = {
-	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
-}
-
-export type EventMessageOptions = {
-	name: string
-	description?: string
-	startDate: Date
-	endDate?: Date
-	location?: WALocationMessage
-	call?: 'audio' | 'video'
-	isCancelled?: boolean
-	isScheduleCall?: boolean
-	extraGuestsAllowed?: boolean
-	messageSecret?: Uint8Array<ArrayBufferLike>
-}
-
-type SharePhoneNumber = {
-	sharePhoneNumber: boolean
-}
-
-type RequestPhoneNumber = {
-	requestPhoneNumber: boolean
-}
-
-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
-
-export type ButtonReplyInfo = {
-	displayText: string
-	id: string
-	index: number
-}
-
-export type GroupInviteInfo = {
-	inviteCode: string
-	inviteExpiration: number
-	text: string
-	jid: string
-	subject: string
-}
-
-export type WASendableProduct = Omit<proto.Message.ProductMessage.IProductSnapshot, 'productImage'> & {
-	productImage: WAMediaUpload
-}
-
-export type AnyRegularMessageContent = (
-	| ({
-			text: string
-			linkPreview?: WAUrlInfo | null
-	  } & Mentionable &
-			Contextable &
-			Editable)
-	| AnyMediaMessageContent
-	| { event: EventMessageOptions }
-	| ({
-			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
-	| {
-			/** Botões simples (legacy buttonsMessage) */
-			buttons: {
-				text: string
-				footer?: string
-				title?: string
-				buttons: { id: string; text: string }[]
-			}
-		}
-	| {
-			/** Template Buttons: URL, call, quickReply */
-			templateButtons: {
-				text: string
-				footer?: string
-				title?: string
-				buttons: (
-					| { type: 'reply'; id: string; text: string }
-					| { type: 'url'; url: string; text: string }
-					| { type: 'call'; phone: string; text: string }
-				)[]
-			}
-		}
-	| {
-			/** List Message com seções */
-			list: {
-				title?: string
-				text: string
-				footer?: string
-				buttonText: string
-				sections: {
-					title?: string
-					rows: { id: string; title: string; description?: string }[]
-				}[]
-			}
-		}
-	| {
-			/** Interactive Message — novo protocolo MD 2024+ */
-			interactive: {
-				body: string
-				footer?: string
-				header?: string
-				nativeFlowButtons: { name: string; buttonParamsJson: string }[]
-			}
-		}
-) &
-	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
-	  }
-	| {
-			limitSharing: boolean
-	  }
-
-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
-}
-
-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[]
-}
-
-export type MiscMessageGenerationOptions = MinimalRelayOptions & {
-	/** optional, if you want to manually set the timestamp of the message */
-	timestamp?: Date
-	/** 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
-}
-export type MessageGenerationOptionsFromContent = MiscMessageGenerationOptions & {
-	userJid: string
-}
-
-export type WAMediaUploadFunction = (
-	encFilePath: string,
-	opts: { fileEncSha256B64: string; mediaType: MediaType; timeoutMs?: number }
-) => Promise<{ mediaUrl: string; directPath: string; meta_hmac?: string; ts?: number; fbid?: number }>
-
-export type MediaGenerationOptions = {
-	logger?: ILogger
-	mediaTypeOverride?: MediaType
-	upload: WAMediaUploadFunction
-	/** cache media so it does not have to be uploaded again */
-	mediaCache?: CacheStore
-
-	mediaUploadTimeoutMs?: number
-
-	options?: RequestInit
-
-	backgroundColor?: string
-
-	font?: number
-}
-export type MessageContentGenerationOptions = MediaGenerationOptions & {
-	getUrlInfo?: (text: string) => Promise<WAUrlInfo | undefined>
-	getProfilePicUrl?: (jid: string, type: 'image' | 'preview') => Promise<string | undefined>
-	getCallLink?: (type: 'audio' | 'video', event?: { startTime: number }) => Promise<string | undefined>
-	jid?: string
-}
-export type MessageGenerationOptions = MessageContentGenerationOptions & MessageGenerationOptionsFromContent
-
-/**
- * Type of message upsert
- * 1. notify => notify the user, this message was just received
- * 2. append => append the message to the chat history, no notification required
- */
-export type MessageUpsertType = 'append' | 'notify'
-
-export type MessageUserReceipt = proto.IUserReceipt
-
-export type WAMessageUpdate = { update: Partial<WAMessage>; key: WAMessageKey }
-
-export type WAMessageCursor = { before: WAMessageKey | undefined } | { after: WAMessageKey | undefined }
-
-export type MessageUserReceiptUpdate = { key: WAMessageKey; receipt: MessageUserReceipt }
-
-export type MediaDecryptionKeyInfo = {
-	iv: Buffer
-	cipherKey: Buffer
-	macKey?: Buffer
-}
-
-export type MinimalMessage = Pick<WAMessage, 'key' | 'messageTimestamp'>

package/src/Types/Newsletter.ts

@@ -1,98 +0,0 @@
-export enum XWAPaths {
-	xwa2_newsletter_create = 'xwa2_newsletter_create',
-	xwa2_newsletter_subscribers = 'xwa2_newsletter_subscribers',
-	xwa2_newsletter_view = 'xwa2_newsletter_view',
-	xwa2_newsletter_metadata = 'xwa2_newsletter',
-	xwa2_newsletter_admin_count = 'xwa2_newsletter_admin',
-	xwa2_newsletter_mute_v2 = 'xwa2_newsletter_mute_v2',
-	xwa2_newsletter_unmute_v2 = 'xwa2_newsletter_unmute_v2',
-	xwa2_newsletter_follow = 'xwa2_newsletter_follow',
-	xwa2_newsletter_unfollow = 'xwa2_newsletter_unfollow',
-	xwa2_newsletter_change_owner = 'xwa2_newsletter_change_owner',
-	xwa2_newsletter_demote = 'xwa2_newsletter_demote',
-	xwa2_newsletter_delete_v2 = 'xwa2_newsletter_delete_v2'
-}
-export enum QueryIds {
-	CREATE = '8823471724422422',
-	UPDATE_METADATA = '24250201037901610',
-	METADATA = '6563316087068696',
-	SUBSCRIBERS = '9783111038412085',
-	FOLLOW = '7871414976211147',
-	UNFOLLOW = '7238632346214362',
-	MUTE = '29766401636284406',
-	UNMUTE = '9864994326891137',
-	ADMIN_COUNT = '7130823597031706',
-	CHANGE_OWNER = '7341777602580933',
-	DEMOTE = '6551828931592903',
-	DELETE = '30062808666639665'
-}
-export type NewsletterUpdate = {
-	name?: string
-	description?: string
-	picture?: string
-}
-export interface NewsletterCreateResponse {
-	id: string
-	state: { type: string }
-	thread_metadata: {
-		creation_time: string
-		description: { id: string; text: string; update_time: string }
-		handle: string | null
-		invite: string
-		name: { id: string; text: string; update_time: string }
-		picture: { direct_path: string; id: string; type: string }
-		preview: { direct_path: string; id: string; type: string }
-		subscribers_count: string
-		verification: 'VERIFIED' | 'UNVERIFIED'
-	}
-	viewer_metadata: {
-		mute: 'ON' | 'OFF'
-		role: NewsletterViewRole
-	}
-}
-export interface NewsletterCreateResponse {
-	id: string
-	state: { type: string }
-	thread_metadata: {
-		creation_time: string
-		description: { id: string; text: string; update_time: string }
-		handle: string | null
-		invite: string
-		name: { id: string; text: string; update_time: string }
-		picture: { direct_path: string; id: string; type: string }
-		preview: { direct_path: string; id: string; type: string }
-		subscribers_count: string
-		verification: 'VERIFIED' | 'UNVERIFIED'
-	}
-	viewer_metadata: {
-		mute: 'ON' | 'OFF'
-		role: NewsletterViewRole
-	}
-}
-export type NewsletterViewRole = 'ADMIN' | 'GUEST' | 'OWNER' | 'SUBSCRIBER'
-export interface NewsletterMetadata {
-	id: string
-	owner?: string
-	name: string
-	description?: string
-	invite?: string
-	creation_time?: number
-	subscribers?: number
-	picture?: {
-		url?: string
-		directPath?: string
-		mediaKey?: string
-		id?: string
-	}
-	verification?: 'VERIFIED' | 'UNVERIFIED'
-	reaction_codes?: {
-		code: string
-		count: number
-	}[]
-	mute_state?: 'ON' | 'OFF'
-	thread_metadata?: {
-		creation_time?: number
-		name?: string
-		description?: string
-	}
-}

package/src/Types/Product.ts

@@ -1,85 +0,0 @@
-import type { WAMediaUpload } from './Message'
-
-export type CatalogResult = {
-	data: {
-		paging: { cursors: { before: string; after: string } }
-		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		data: any[]
-	}
-}
-
-export type ProductCreateResult = {
-	data: { product: {} }
-}
-
-export type CatalogStatus = {
-	status: string
-	canAppeal: boolean
-}
-
-export type CatalogCollection = {
-	id: string
-	name: string
-	products: Product[]
-
-	status: CatalogStatus
-}
-
-export type ProductAvailability = 'in stock'
-
-export type ProductBase = {
-	name: string
-	retailerId?: string
-	url?: string
-	description: string
-	price: number
-	currency: string
-	isHidden?: boolean
-}
-
-export type ProductCreate = ProductBase & {
-	/** ISO country code for product origin. Set to undefined for no country */
-	originCountryCode: string | undefined
-	/** images of the product */
-	images: WAMediaUpload[]
-}
-
-export type ProductUpdate = Omit<ProductCreate, 'originCountryCode'>
-
-export type Product = ProductBase & {
-	id: string
-	imageUrls: { [_: string]: string }
-	reviewStatus: { [_: string]: string }
-	availability: ProductAvailability
-}
-
-export type OrderPrice = {
-	currency: string
-	total: number
-}
-
-export type OrderProduct = {
-	id: string
-	imageUrl: string
-	name: string
-	quantity: number
-
-	currency: string
-	price: number
-}
-
-export type OrderDetails = {
-	price: OrderPrice
-	products: OrderProduct[]
-}
-
-export type CatalogCursor = string
-
-export type GetCatalogOptions = {
-	/** cursor to start from */
-	cursor?: CatalogCursor
-	/** number of products to fetch */
-	limit?: number
-
-	jid?: string
-}

package/src/Types/Signal.ts

@@ -1,76 +0,0 @@
-import { proto } from '../../WAProto/index.js'
-import type { LIDMappingStore } from '../Signal/lid-mapping'
-
-type DecryptGroupSignalOpts = {
-	group: string
-	authorJid: string
-	msg: Uint8Array
-}
-
-type ProcessSenderKeyDistributionMessageOpts = {
-	item: proto.Message.ISenderKeyDistributionMessage
-	authorJid: string
-}
-
-type DecryptSignalProtoOpts = {
-	jid: string
-	type: 'pkmsg' | 'msg'
-	ciphertext: Uint8Array
-}
-
-type EncryptMessageOpts = {
-	jid: string
-	data: Uint8Array
-}
-
-type EncryptGroupMessageOpts = {
-	group: string
-	data: Uint8Array
-	meId: string
-}
-
-type PreKey = {
-	keyId: number
-	publicKey: Uint8Array
-}
-
-type SignedPreKey = PreKey & {
-	signature: Uint8Array
-}
-
-type E2ESession = {
-	registrationId: number
-	identityKey: Uint8Array
-	signedPreKey: SignedPreKey
-	preKey: PreKey
-}
-
-type E2ESessionOpts = {
-	jid: string
-	session: E2ESession
-}
-
-export type SignalRepository = {
-	decryptGroupMessage(opts: DecryptGroupSignalOpts): Promise<Uint8Array>
-	processSenderKeyDistributionMessage(opts: ProcessSenderKeyDistributionMessageOpts): Promise<void>
-	decryptMessage(opts: DecryptSignalProtoOpts): Promise<Uint8Array>
-	encryptMessage(opts: EncryptMessageOpts): Promise<{
-		type: 'pkmsg' | 'msg'
-		ciphertext: Uint8Array
-	}>
-	encryptGroupMessage(opts: EncryptGroupMessageOpts): Promise<{
-		senderKeyDistributionMessage: Uint8Array
-		ciphertext: Uint8Array
-	}>
-	injectE2ESession(opts: E2ESessionOpts): Promise<void>
-	validateSession(jid: string): Promise<{ exists: boolean; reason?: string }>
-	jidToSignalProtocolAddress(jid: string): string
-	migrateSession(fromJid: string, toJid: string): Promise<{ migrated: number; skipped: number; total: number }>
-	validateSession(jid: string): Promise<{ exists: boolean; reason?: string }>
-	deleteSession(jids: string[]): Promise<void>
-}
-
-// Optimized repository with pre-loaded LID mapping store
-export interface SignalRepositoryWithLIDStore extends SignalRepository {
-	lidMapping: LIDMappingStore
-}