@sixcore/baileys 1.0.0 → 1.0.1

package/src/Types/Auth.ts

@@ -1,115 +0,0 @@
-import type { proto } from '../../WAProto/index.js'
-import type { Contact } from './Contact'
-import type { MinimalMessage } from './Message'
-
-export type KeyPair = { public: Uint8Array; private: Uint8Array }
-export type SignedKeyPair = {
-	keyPair: KeyPair
-	signature: Uint8Array
-	keyId: number
-	timestampS?: number
-}
-
-export type ProtocolAddress = {
-	name: string // jid
-	deviceId: number
-}
-export type SignalIdentity = {
-	identifier: ProtocolAddress
-	identifierKey: Uint8Array
-}
-
-export type LIDMapping = {
-	pn: string
-	lid: string
-}
-
-export type LTHashState = {
-	version: number
-	hash: Buffer
-	indexValueMap: {
-		[indexMacBase64: string]: { valueMac: Uint8Array | Buffer }
-	}
-}
-
-export type SignalCreds = {
-	readonly signedIdentityKey: KeyPair
-	readonly signedPreKey: SignedKeyPair
-	readonly registrationId: number
-}
-
-export type AccountSettings = {
-	/** unarchive chats when a new message is received */
-	unarchiveChats: boolean
-	/** the default mode to start new conversations with */
-	defaultDisappearingMode?: Pick<proto.IConversation, 'ephemeralExpiration' | 'ephemeralSettingTimestamp'>
-}
-
-export type AuthenticationCreds = SignalCreds & {
-	readonly noiseKey: KeyPair
-	readonly pairingEphemeralKeyPair: KeyPair
-	advSecretKey: string
-
-	me?: Contact
-	account?: proto.IADVSignedDeviceIdentity
-	signalIdentities?: SignalIdentity[]
-	myAppStateKeyId?: string
-	firstUnuploadedPreKeyId: number
-	nextPreKeyId: number
-
-	lastAccountSyncTimestamp?: number
-	platform?: string
-
-	processedHistoryMessages: MinimalMessage[]
-	/** number of times history & app state has been synced */
-	accountSyncCounter: number
-	accountSettings: AccountSettings
-	registered: boolean
-	pairingCode: string | undefined
-	lastPropHash: string | undefined
-	routingInfo: Buffer | undefined
-	additionalData?: any | undefined
-}
-
-export type SignalDataTypeMap = {
-	'pre-key': KeyPair
-	session: Uint8Array
-	'sender-key': Uint8Array
-	'sender-key-memory': { [jid: string]: boolean }
-	'app-state-sync-key': proto.Message.IAppStateSyncKeyData
-	'app-state-sync-version': LTHashState
-	'lid-mapping': string
-	'device-list': string[]
-	tctoken: { token: Buffer; timestamp?: string }
-}
-
-export type SignalDataSet = { [T in keyof SignalDataTypeMap]?: { [id: string]: SignalDataTypeMap[T] | null } }
-
-type Awaitable<T> = T | Promise<T>
-
-export type SignalKeyStore = {
-	get<T extends keyof SignalDataTypeMap>(type: T, ids: string[]): Awaitable<{ [id: string]: SignalDataTypeMap[T] }>
-	set(data: SignalDataSet): Awaitable<void>
-	/** clear all the data in the store */
-	clear?(): Awaitable<void>
-}
-
-export type SignalKeyStoreWithTransaction = SignalKeyStore & {
-	isInTransaction: () => boolean
-	transaction<T>(exec: () => Promise<T>, key: string): Promise<T>
-}
-
-export type TransactionCapabilityOptions = {
-	maxCommitRetries: number
-	delayBetweenTriesMs: number
-}
-
-export type SignalAuthState = {
-	creds: SignalCreds
-	keys: SignalKeyStore | SignalKeyStoreWithTransaction
-}
-
-export type AuthenticationState = {
-	creds: AuthenticationCreds
-	keys: SignalKeyStore
-}

package/src/Types/Bussines.ts

@@ -1,20 +0,0 @@
-import type { proto } from '../../WAProto'
-
-export type DayOfWeekBussines = 'sun' | 'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat'
-
-export type HoursDay =
-	| { day: DayOfWeekBussines; mode: 'specific_hours'; openTimeInMinutes: string; closeTimeInMinutes: string }
-	| { day: DayOfWeekBussines; mode: 'open_24h' | 'appointment_only' }
-
-export type UpdateBussinesProfileProps = {
-	address?: string
-	websites?: string[]
-	email?: string
-	description?: string
-	hours?: {
-		timezone: string
-		days: HoursDay[]
-	}
-}
-
-export type QuickReplyAction = proto.SyncActionValue.IQuickReplyAction & { timestamp?: string }

package/src/Types/Call.ts

@@ -1,14 +0,0 @@
-export type WACallUpdateType = 'offer' | 'ringing' | 'timeout' | 'reject' | 'accept' | 'terminate'
-
-export type WACallEvent = {
-	chatId: string
-	from: string
-	isGroup?: boolean
-	groupJid?: string
-	id: string
-	date: Date
-	isVideo?: boolean
-	status: WACallUpdateType
-	offline: boolean
-	latencyMs?: number
-}

package/src/Types/Chat.ts

@@ -1,138 +0,0 @@
-import type { proto } from '../../WAProto/index.js'
-import type { AccountSettings } from './Auth'
-import type { QuickReplyAction } from './Bussines.js'
-import type { BufferedEventData } from './Events'
-import type { LabelActionBody } from './Label'
-import type { ChatLabelAssociationActionBody } from './LabelAssociation'
-import type { MessageLabelAssociationActionBody } from './LabelAssociation'
-import type { MinimalMessage, WAMessageKey } from './Message'
-
-/** privacy settings in WhatsApp Web */
-export type WAPrivacyValue = 'all' | 'contacts' | 'contact_blacklist' | 'none'
-
-export type WAPrivacyOnlineValue = 'all' | 'match_last_seen'
-
-export type WAPrivacyGroupAddValue = 'all' | 'contacts' | 'contact_blacklist'
-
-export type WAReadReceiptsValue = 'all' | 'none'
-
-export type WAPrivacyCallValue = 'all' | 'known'
-
-export type WAPrivacyMessagesValue = 'all' | 'contacts'
-
-/** set of statuses visible to other people; see updatePresence() in WhatsAppWeb.Send */
-export type WAPresence = 'unavailable' | 'available' | 'composing' | 'recording' | 'paused'
-
-export const ALL_WA_PATCH_NAMES = [
-	'critical_block',
-	'critical_unblock_low',
-	'regular_high',
-	'regular_low',
-	'regular'
-] as const
-
-export type WAPatchName = (typeof ALL_WA_PATCH_NAMES)[number]
-
-export interface PresenceData {
-	lastKnownPresence: WAPresence
-	lastSeen?: number
-}
-
-export type BotListInfo = {
-	jid: string
-	personaId: string
-}
-
-export type ChatMutation = {
-	syncAction: proto.ISyncActionData
-	index: string[]
-}
-
-export type WAPatchCreate = {
-	syncAction: proto.ISyncActionValue
-	index: string[]
-	type: WAPatchName
-	apiVersion: number
-	operation: proto.SyncdMutation.SyncdOperation
-}
-
-export type Chat = proto.IConversation & {
-	/** unix timestamp of when the last message was received in the chat */
-	lastMessageRecvTimestamp?: number
-}
-
-export type ChatUpdate = Partial<
-	Chat & {
-		/**
-		 * if specified in the update,
-		 * the EV buffer will check if the condition gets fulfilled before applying the update
-		 * Right now, used to determine when to release an app state sync event
-		 *
-		 * @returns true, if the update should be applied;
-		 * false if it can be discarded;
-		 * undefined if the condition is not yet fulfilled
-		 * */
-		conditional: (bufferedData: BufferedEventData) => boolean | undefined
-		/** last update time */
-		timestamp?: number
-	}
->
-
-/**
- * the last messages in a chat, sorted reverse-chronologically. That is, the latest message should be first in the chat
- * for MD modifications, the last message in the array (i.e. the earlist message) must be the last message recv in the chat
- * */
-export type LastMessageList = MinimalMessage[] | proto.SyncActionValue.ISyncActionMessageRange
-
-export type ChatModification =
-	| {
-			archive: boolean
-			lastMessages: LastMessageList
-	  }
-	| { pushNameSetting: string }
-	| { pin: boolean }
-	| {
-			/** mute for duration, or provide timestamp of mute to remove*/
-			mute: number | null
-	  }
-	| {
-			clear: boolean
-			lastMessages: LastMessageList
-	  }
-	| {
-			deleteForMe: { deleteMedia: boolean; key: WAMessageKey; timestamp: number }
-	  }
-	| {
-			star: {
-				messages: { id: string; fromMe?: boolean }[]
-				star: boolean
-			}
-	  }
-	| {
-			markRead: boolean
-			lastMessages: LastMessageList
-	  }
-	| { delete: true; lastMessages: LastMessageList }
-	| { contact: proto.SyncActionValue.IContactAction | null }
-	| { disableLinkPreviews: proto.SyncActionValue.IPrivacySettingDisableLinkPreviewsAction }
-	// Label
-	| { addLabel: LabelActionBody }
-	// Label assosiation
-	| { addChatLabel: ChatLabelAssociationActionBody }
-	| { removeChatLabel: ChatLabelAssociationActionBody }
-	| { addMessageLabel: MessageLabelAssociationActionBody }
-	| { removeMessageLabel: MessageLabelAssociationActionBody }
-	| { quickReply: QuickReplyAction }
-
-export type InitialReceivedChatsState = {
-	[jid: string]: {
-		/** the last message received from the other party */
-		lastMsgRecvTimestamp?: number
-		/** the absolute last message in the chat */
-		lastMsgTimestamp: number
-	}
-}
-
-export type InitialAppStateSyncOptions = {
-	accountSettings: AccountSettings
-}

package/src/Types/Contact.ts

@@ -1,24 +0,0 @@
-export interface Contact {
-	/** ID either in lid or jid format (preferred) **/
-	id: string
-	/** ID in LID format (@lid) **/
-	lid?: string
-	/** ID in PN format (@s.whatsapp.net)  **/
-	phoneNumber?: string
-	/** name of the contact, you have saved on your WA */
-	name?: string
-	/** name of the contact, the contact has set on their own on WA */
-	notify?: string
-	/** I have no idea */
-	verifiedName?: string
-	// Baileys Added
-	/**
-	 * Url of the profile picture of the contact
-	 *
-	 * 'changed' => if the profile picture has changed
-	 * null => if the profile picture has not been set (default profile picture)
-	 * any other string => url of the profile picture
-	 */
-	imgUrl?: string | null
-	status?: string
-}

package/src/Types/Events.ts

@@ -1,132 +0,0 @@
-import type { Boom } from '@hapi/boom'
-import { proto } from '../../WAProto/index.js'
-import type { AuthenticationCreds } from './Auth'
-import type { WACallEvent } from './Call'
-import type { Chat, ChatUpdate, PresenceData } from './Chat'
-import type { Contact } from './Contact'
-import type {
-	GroupMetadata,
-	GroupParticipant,
-	ParticipantAction,
-	RequestJoinAction,
-	RequestJoinMethod
-} from './GroupMetadata'
-import type { Label } from './Label'
-import type { LabelAssociation } from './LabelAssociation'
-import type { MessageUpsertType, MessageUserReceiptUpdate, WAMessage, WAMessageKey, WAMessageUpdate } from './Message'
-import type { ConnectionState } from './State'
-
-// TODO: refactor this mess
-export type BaileysEventMap = {
-	/** connection state has been updated -- WS closed, opened, connecting etc. */
-	'connection.update': Partial<ConnectionState>
-	/** credentials updated -- some metadata, keys or something */
-	'creds.update': Partial<AuthenticationCreds>
-	/** set chats (history sync), everything is reverse chronologically sorted */
-	'messaging-history.set': {
-		chats: Chat[]
-		contacts: Contact[]
-		messages: WAMessage[]
-		isLatest?: boolean
-		progress?: number | null
-		syncType?: proto.HistorySync.HistorySyncType | null
-		peerDataRequestSessionId?: string | null
-	}
-	/** upsert chats */
-	'chats.upsert': Chat[]
-	/** update the given chats */
-	'chats.update': ChatUpdate[]
-	'lid-mapping.update': { lid: string; pn: string }
-	/** delete chats with given ID */
-	'chats.delete': string[]
-	/** presence of contact in a chat updated */
-	'presence.update': { id: string; presences: { [participant: string]: PresenceData } }
-
-	'contacts.upsert': Contact[]
-	'contacts.update': Partial<Contact>[]
-
-	'messages.delete': { keys: WAMessageKey[] } | { jid: string; all: true }
-	'messages.update': WAMessageUpdate[]
-	'messages.media-update': { key: WAMessageKey; media?: { ciphertext: Uint8Array; iv: Uint8Array }; error?: Boom }[]
-	/**
-	 * add/update the given messages. If they were received while the connection was online,
-	 * the update will have type: "notify"
-	 * if requestId is provided, then the messages was received from the phone due to it being unavailable
-	 *  */
-	'messages.upsert': { messages: WAMessage[]; type: MessageUpsertType; requestId?: string }
-	/** message was reacted to. If reaction was removed -- then "reaction.text" will be falsey */
-	'messages.reaction': { key: WAMessageKey; reaction: proto.IReaction }[]
-
-	'message-receipt.update': MessageUserReceiptUpdate[]
-
-	'groups.upsert': GroupMetadata[]
-	'groups.update': Partial<GroupMetadata>[]
-	/** apply an action to participants in a group */
-	'group-participants.update': {
-		id: string
-		author: string
-		authorPn?: string
-		participants: GroupParticipant[]
-		action: ParticipantAction
-	}
-	'group.join-request': {
-		id: string
-		author: string
-		authorPn?: string
-		participant: string
-		participantPn?: string
-		action: RequestJoinAction
-		method: RequestJoinMethod
-	}
-
-	'blocklist.set': { blocklist: string[] }
-	'blocklist.update': { blocklist: string[]; type: 'add' | 'remove' }
-
-	/** Receive an update on a call, including when the call was received, rejected, accepted */
-	call: WACallEvent[]
-	'labels.edit': Label
-	'labels.association': { association: LabelAssociation; type: 'add' | 'remove' }
-
-	/** Newsletter-related events */
-	'newsletter.reaction': {
-		id: string
-		server_id: string
-		reaction: { code?: string; count?: number; removed?: boolean }
-	}
-	'newsletter.view': { id: string; server_id: string; count: number }
-	'newsletter-participants.update': { id: string; author: string; user: string; new_role: string; action: string }
-	'newsletter-settings.update': { id: string; update: any }
-}
-
-export type BufferedEventData = {
-	historySets: {
-		chats: { [jid: string]: Chat }
-		contacts: { [jid: string]: Contact }
-		messages: { [uqId: string]: WAMessage }
-		empty: boolean
-		isLatest: boolean
-		progress?: number | null
-		syncType?: proto.HistorySync.HistorySyncType
-		peerDataRequestSessionId?: string
-	}
-	chatUpserts: { [jid: string]: Chat }
-	chatUpdates: { [jid: string]: ChatUpdate }
-	chatDeletes: Set<string>
-	contactUpserts: { [jid: string]: Contact }
-	contactUpdates: { [jid: string]: Partial<Contact> }
-	messageUpserts: { [key: string]: { type: MessageUpsertType; message: WAMessage } }
-	messageUpdates: { [key: string]: WAMessageUpdate }
-	messageDeletes: { [key: string]: WAMessageKey }
-	messageReactions: { [key: string]: { key: WAMessageKey; reactions: proto.IReaction[] } }
-	messageReceipts: { [key: string]: { key: WAMessageKey; userReceipt: proto.IUserReceipt[] } }
-	groupUpdates: { [jid: string]: Partial<GroupMetadata> }
-}
-
-export type BaileysEvent = keyof BaileysEventMap
-
-export interface BaileysEventEmitter {
-	on<T extends keyof BaileysEventMap>(event: T, listener: (arg: BaileysEventMap[T]) => void): void
-	off<T extends keyof BaileysEventMap>(event: T, listener: (arg: BaileysEventMap[T]) => void): void
-	removeAllListeners<T extends keyof BaileysEventMap>(event: T): void
-	emit<T extends keyof BaileysEventMap>(event: T, arg: BaileysEventMap[T]): boolean
-}

package/src/Types/GroupMetadata.ts

@@ -1,70 +0,0 @@
-import type { Contact } from './Contact'
-import type { WAMessageAddressingMode } from './Message'
-
-export type GroupParticipant = Contact & {
-	isAdmin?: boolean
-	isSuperAdmin?: boolean
-	admin?: 'admin' | 'superadmin' | null
-}
-
-export type ParticipantAction = 'add' | 'remove' | 'promote' | 'demote' | 'modify'
-
-export type RequestJoinAction = 'created' | 'revoked' | 'rejected'
-
-export type RequestJoinMethod = 'invite_link' | 'linked_group_join' | 'non_admin_add' | undefined
-
-export interface GroupMetadata {
-	id: string
-	notify?: string
-	/** group uses 'lid' or 'pn' to send messages */
-	addressingMode?: WAMessageAddressingMode
-	owner: string | undefined
-	ownerPn?: string | undefined
-	owner_country_code?: string | undefined
-	subject: string
-	/** group subject owner */
-	subjectOwner?: string
-	subjectOwnerPn?: string
-	/** group subject modification date */
-	subjectTime?: number
-	creation?: number
-	desc?: string
-	descOwner?: string
-	descOwnerPn?: string
-	descId?: string
-	descTime?: number
-	/** if this group is part of a community, it returns the jid of the community to which it belongs */
-	linkedParent?: string
-	/** is set when the group only allows admins to change group settings */
-	restrict?: boolean
-	/** is set when the group only allows admins to write messages */
-	announce?: boolean
-	/** is set when the group also allows members to add participants */
-	memberAddMode?: boolean
-	/** Request approval to join the group */
-	joinApprovalMode?: boolean
-	/** is this a community */
-	isCommunity?: boolean
-	/** is this the announce of a community */
-	isCommunityAnnounce?: boolean
-	/** number of group participants */
-	size?: number
-	// Baileys modified array
-	participants: GroupParticipant[]
-	ephemeralDuration?: number
-	inviteCode?: string
-	/** the person who added you to group or changed some setting in group */
-	author?: string
-	authorPn?: string
-}
-
-export interface WAGroupCreateResponse {
-	status: number
-	gid?: string
-	participants?: [{ [key: string]: {} }]
-}
-
-export interface GroupModificationResponse {
-	status: number
-	participants?: { [key: string]: {} }
-}

package/src/Types/Label.ts

@@ -1,48 +0,0 @@
-export interface Label {
-	/** Label uniq ID */
-	id: string
-	/** Label name */
-	name: string
-	/** Label color ID */
-	color: number
-	/** Is label has been deleted */
-	deleted: boolean
-	/** WhatsApp has 5 predefined labels (New customer, New order & etc) */
-	predefinedId?: string
-}
-
-export interface LabelActionBody {
-	id: string
-	/** Label name */
-	name?: string
-	/** Label color ID */
-	color?: number
-	/** Is label has been deleted */
-	deleted?: boolean
-	/** WhatsApp has 5 predefined labels (New customer, New order & etc) */
-	predefinedId?: number
-}
-
-/** WhatsApp has 20 predefined colors */
-export enum LabelColor {
-	Color1 = 0,
-	Color2,
-	Color3,
-	Color4,
-	Color5,
-	Color6,
-	Color7,
-	Color8,
-	Color9,
-	Color10,
-	Color11,
-	Color12,
-	Color13,
-	Color14,
-	Color15,
-	Color16,
-	Color17,
-	Color18,
-	Color19,
-	Color20
-}

package/src/Types/LabelAssociation.ts

@@ -1,35 +0,0 @@
-/** Association type */
-export enum LabelAssociationType {
-	Chat = 'label_jid',
-	Message = 'label_message'
-}
-
-export type LabelAssociationTypes = `${LabelAssociationType}`
-
-/** Association for chat */
-export interface ChatLabelAssociation {
-	type: LabelAssociationType.Chat
-	chatId: string
-	labelId: string
-}
-
-/** Association for message */
-export interface MessageLabelAssociation {
-	type: LabelAssociationType.Message
-	chatId: string
-	messageId: string
-	labelId: string
-}
-
-export type LabelAssociation = ChatLabelAssociation | MessageLabelAssociation
-
-/** Body for add/remove chat label association action */
-export interface ChatLabelAssociationActionBody {
-	labelId: string
-}
-
-/** body for add/remove message label association action */
-export interface MessageLabelAssociationActionBody {
-	labelId: string
-	messageId: string
-}