@fazzcode/baileys 0.1.7 → 2.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (209) hide show
  1. package/LICENSE +21 -0
  2. package/README.MD +1420 -103
  3. package/WAProto/WAProto.proto +5311 -0
  4. package/WAProto/index.js +83385 -119575
  5. package/lib/Defaults/index.js +117 -124
  6. package/lib/KeyDB/BinarySearch.js +20 -0
  7. package/lib/KeyDB/KeyedDB.js +167 -0
  8. package/lib/KeyDB/index.js +4 -0
  9. package/lib/Signal/Group/ciphertext-message.js +12 -14
  10. package/lib/Signal/Group/group-session-builder.js +10 -42
  11. package/lib/Signal/Group/group_cipher.js +75 -87
  12. package/lib/Signal/Group/index.js +13 -57
  13. package/lib/Signal/Group/keyhelper.js +17 -52
  14. package/lib/Signal/Group/sender-chain-key.js +27 -33
  15. package/lib/Signal/Group/sender-key-distribution-message.js +62 -63
  16. package/lib/Signal/Group/sender-key-message.js +65 -66
  17. package/lib/Signal/Group/sender-key-name.js +45 -44
  18. package/lib/Signal/Group/sender-key-record.js +39 -49
  19. package/lib/Signal/Group/sender-key-state.js +80 -93
  20. package/lib/Signal/Group/sender-message-key.js +27 -28
  21. package/lib/Signal/libsignal.js +313 -163
  22. package/lib/Signal/lid-mapping.js +155 -0
  23. package/lib/Socket/Client/index.js +4 -19
  24. package/lib/Socket/Client/types.js +13 -0
  25. package/lib/Socket/Client/websocket.js +52 -0
  26. package/lib/Socket/business.js +359 -242
  27. package/lib/Socket/chats.js +851 -830
  28. package/lib/Socket/communities.js +413 -0
  29. package/lib/Socket/groups.js +304 -309
  30. package/lib/Socket/index.js +15 -9
  31. package/lib/Socket/messages-recv.js +1107 -1054
  32. package/lib/Socket/messages-send.js +709 -414
  33. package/lib/Socket/mex.js +45 -0
  34. package/lib/Socket/newsletter.js +232 -318
  35. package/lib/Socket/socket.js +789 -599
  36. package/lib/Store/index.js +6 -10
  37. package/lib/Store/make-cache-manager-store.js +73 -81
  38. package/lib/Store/make-in-memory-store.js +286 -423
  39. package/lib/Store/make-ordered-dictionary.js +77 -79
  40. package/lib/Store/object-repository.js +24 -26
  41. package/lib/Types/Auth.js +3 -2
  42. package/lib/Types/Bussines.js +3 -0
  43. package/lib/Types/Call.js +3 -2
  44. package/lib/Types/Chat.js +9 -4
  45. package/lib/Types/Contact.js +3 -2
  46. package/lib/Types/Events.js +3 -2
  47. package/lib/Types/GroupMetadata.js +3 -2
  48. package/lib/Types/Label.js +24 -26
  49. package/lib/Types/LabelAssociation.js +6 -8
  50. package/lib/Types/Message.js +12 -9
  51. package/lib/Types/Newsletter.js +31 -30
  52. package/lib/Types/Newsletter.js.bak +33 -0
  53. package/lib/Types/Product.js +3 -2
  54. package/lib/Types/Signal.js +3 -2
  55. package/lib/Types/Socket.js +4 -2
  56. package/lib/Types/State.js +11 -2
  57. package/lib/Types/USync.js +3 -2
  58. package/lib/Types/index.js +27 -41
  59. package/lib/Utils/auth-utils.js +211 -198
  60. package/lib/Utils/baileys-event-stream.js +42 -61
  61. package/lib/Utils/browser-utils.js +25 -0
  62. package/lib/Utils/business.js +213 -214
  63. package/lib/Utils/chat-utils.js +710 -687
  64. package/lib/Utils/crypto.js +112 -133
  65. package/lib/Utils/decode-wa-message.js +252 -183
  66. package/lib/Utils/event-buffer.js +510 -496
  67. package/lib/Utils/generics.js +328 -356
  68. package/lib/Utils/history.js +83 -92
  69. package/lib/Utils/index.js +21 -33
  70. package/lib/Utils/link-preview.js +71 -83
  71. package/lib/Utils/logger.js +5 -7
  72. package/lib/Utils/lt-hash.js +40 -46
  73. package/lib/Utils/make-mutex.js +34 -41
  74. package/lib/Utils/message-retry-manager.js +113 -0
  75. package/lib/Utils/messages-media.js +548 -678
  76. package/lib/Utils/messages.js +352 -249
  77. package/lib/Utils/noise-handler.js +138 -149
  78. package/lib/Utils/pre-key-manager.js +85 -0
  79. package/lib/Utils/process-message.js +323 -303
  80. package/lib/Utils/signal.js +148 -138
  81. package/lib/Utils/use-multi-file-auth-state.js +98 -67
  82. package/lib/Utils/validate-connection.js +183 -188
  83. package/lib/WABinary/constants.js +1298 -35
  84. package/lib/WABinary/decode.js +237 -249
  85. package/lib/WABinary/encode.js +208 -218
  86. package/lib/WABinary/generic-utils.js +53 -57
  87. package/lib/WABinary/index.js +7 -21
  88. package/lib/WABinary/jid-utils.js +89 -58
  89. package/lib/WABinary/types.js +3 -2
  90. package/lib/WAM/BinaryInfo.js +10 -12
  91. package/lib/WAM/constants.js +22851 -15348
  92. package/lib/WAM/encode.js +135 -136
  93. package/lib/WAM/index.js +5 -19
  94. package/lib/WAUSync/Protocols/USyncContactProtocol.js +28 -30
  95. package/lib/WAUSync/Protocols/USyncDeviceProtocol.js +49 -53
  96. package/lib/WAUSync/Protocols/USyncDisappearingModeProtocol.js +27 -28
  97. package/lib/WAUSync/Protocols/USyncStatusProtocol.js +36 -39
  98. package/lib/WAUSync/Protocols/UsyncBotProfileProtocol.js +50 -50
  99. package/lib/WAUSync/Protocols/UsyncLIDProtocol.js +26 -20
  100. package/lib/WAUSync/Protocols/index.js +6 -20
  101. package/lib/WAUSync/USyncQuery.js +86 -85
  102. package/lib/WAUSync/USyncUser.js +23 -25
  103. package/lib/WAUSync/index.js +5 -19
  104. package/lib/index.js +32 -34
  105. package/package.json +99 -105
  106. package/engine-requirements.js +0 -10
  107. package/lib/Defaults/baileys-version.json +0 -3
  108. package/lib/Defaults/index.d.ts +0 -53
  109. package/lib/Defaults/phonenumber-mcc.json +0 -223
  110. package/lib/Signal/Group/ciphertext-message.d.ts +0 -9
  111. package/lib/Signal/Group/group-session-builder.d.ts +0 -14
  112. package/lib/Signal/Group/group_cipher.d.ts +0 -17
  113. package/lib/Signal/Group/index.d.ts +0 -11
  114. package/lib/Signal/Group/keyhelper.d.ts +0 -10
  115. package/lib/Signal/Group/queue-job.d.ts +0 -1
  116. package/lib/Signal/Group/queue-job.js +0 -57
  117. package/lib/Signal/Group/sender-chain-key.d.ts +0 -13
  118. package/lib/Signal/Group/sender-key-distribution-message.d.ts +0 -16
  119. package/lib/Signal/Group/sender-key-message.d.ts +0 -18
  120. package/lib/Signal/Group/sender-key-name.d.ts +0 -17
  121. package/lib/Signal/Group/sender-key-record.d.ts +0 -30
  122. package/lib/Signal/Group/sender-key-state.d.ts +0 -38
  123. package/lib/Signal/Group/sender-message-key.d.ts +0 -11
  124. package/lib/Signal/libsignal.d.ts +0 -3
  125. package/lib/Socket/Client/abstract-socket-client.d.ts +0 -17
  126. package/lib/Socket/Client/abstract-socket-client.js +0 -13
  127. package/lib/Socket/Client/index.d.ts +0 -3
  128. package/lib/Socket/Client/mobile-socket-client.d.ts +0 -13
  129. package/lib/Socket/Client/mobile-socket-client.js +0 -65
  130. package/lib/Socket/Client/web-socket-client.d.ts +0 -12
  131. package/lib/Socket/Client/web-socket-client.js +0 -62
  132. package/lib/Socket/business.d.ts +0 -171
  133. package/lib/Socket/chats.d.ts +0 -80
  134. package/lib/Socket/dugong.d.ts +0 -219
  135. package/lib/Socket/dugong.js +0 -441
  136. package/lib/Socket/groups.d.ts +0 -115
  137. package/lib/Socket/index.d.ts +0 -173
  138. package/lib/Socket/messages-recv.d.ts +0 -161
  139. package/lib/Socket/messages-send.d.ts +0 -149
  140. package/lib/Socket/newsletter.d.ts +0 -134
  141. package/lib/Socket/registration.d.ts +0 -267
  142. package/lib/Socket/registration.js +0 -166
  143. package/lib/Socket/socket.d.ts +0 -43
  144. package/lib/Socket/usync.d.ts +0 -36
  145. package/lib/Socket/usync.js +0 -70
  146. package/lib/Store/index.d.ts +0 -3
  147. package/lib/Store/make-cache-manager-store.d.ts +0 -13
  148. package/lib/Store/make-in-memory-store.d.ts +0 -118
  149. package/lib/Store/make-ordered-dictionary.d.ts +0 -13
  150. package/lib/Store/object-repository.d.ts +0 -10
  151. package/lib/Types/Auth.d.ts +0 -110
  152. package/lib/Types/Call.d.ts +0 -13
  153. package/lib/Types/Chat.d.ts +0 -102
  154. package/lib/Types/Contact.d.ts +0 -19
  155. package/lib/Types/Events.d.ts +0 -157
  156. package/lib/Types/GroupMetadata.d.ts +0 -55
  157. package/lib/Types/Label.d.ts +0 -35
  158. package/lib/Types/LabelAssociation.d.ts +0 -29
  159. package/lib/Types/Message.d.ts +0 -273
  160. package/lib/Types/Newsletter.d.ts +0 -92
  161. package/lib/Types/Product.d.ts +0 -78
  162. package/lib/Types/Signal.d.ts +0 -57
  163. package/lib/Types/Socket.d.ts +0 -111
  164. package/lib/Types/State.d.ts +0 -27
  165. package/lib/Types/USync.d.ts +0 -25
  166. package/lib/Types/index.d.ts +0 -57
  167. package/lib/Utils/auth-utils.d.ts +0 -18
  168. package/lib/Utils/baileys-event-stream.d.ts +0 -16
  169. package/lib/Utils/business.d.ts +0 -22
  170. package/lib/Utils/chat-utils.d.ts +0 -71
  171. package/lib/Utils/crypto.d.ts +0 -41
  172. package/lib/Utils/decode-wa-message.d.ts +0 -19
  173. package/lib/Utils/event-buffer.d.ts +0 -35
  174. package/lib/Utils/generics.d.ts +0 -92
  175. package/lib/Utils/history.d.ts +0 -15
  176. package/lib/Utils/index.d.ts +0 -17
  177. package/lib/Utils/link-preview.d.ts +0 -21
  178. package/lib/Utils/logger.d.ts +0 -4
  179. package/lib/Utils/lt-hash.d.ts +0 -12
  180. package/lib/Utils/make-mutex.d.ts +0 -7
  181. package/lib/Utils/messages-media.d.ts +0 -116
  182. package/lib/Utils/messages.d.ts +0 -77
  183. package/lib/Utils/noise-handler.d.ts +0 -21
  184. package/lib/Utils/process-message.d.ts +0 -41
  185. package/lib/Utils/signal.d.ts +0 -32
  186. package/lib/Utils/use-multi-file-auth-state.d.ts +0 -13
  187. package/lib/Utils/validate-connection.d.ts +0 -11
  188. package/lib/WABinary/constants.d.ts +0 -27
  189. package/lib/WABinary/decode.d.ts +0 -7
  190. package/lib/WABinary/encode.d.ts +0 -3
  191. package/lib/WABinary/generic-utils.d.ts +0 -16
  192. package/lib/WABinary/index.d.ts +0 -5
  193. package/lib/WABinary/jid-utils.d.ts +0 -31
  194. package/lib/WABinary/types.d.ts +0 -18
  195. package/lib/WAM/BinaryInfo.d.ts +0 -17
  196. package/lib/WAM/constants.d.ts +0 -38
  197. package/lib/WAM/encode.d.ts +0 -3
  198. package/lib/WAM/index.d.ts +0 -3
  199. package/lib/WAUSync/Protocols/USyncContactProtocol.d.ts +0 -9
  200. package/lib/WAUSync/Protocols/USyncDeviceProtocol.d.ts +0 -22
  201. package/lib/WAUSync/Protocols/USyncDisappearingModeProtocol.d.ts +0 -12
  202. package/lib/WAUSync/Protocols/USyncStatusProtocol.d.ts +0 -12
  203. package/lib/WAUSync/Protocols/UsyncBotProfileProtocol.d.ts +0 -25
  204. package/lib/WAUSync/Protocols/UsyncLIDProtocol.d.ts +0 -8
  205. package/lib/WAUSync/Protocols/index.d.ts +0 -4
  206. package/lib/WAUSync/USyncQuery.d.ts +0 -28
  207. package/lib/WAUSync/USyncUser.d.ts +0 -12
  208. package/lib/WAUSync/index.d.ts +0 -3
  209. package/lib/index.d.ts +0 -12
@@ -1,70 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.makeUSyncSocket = void 0;
4
- const boom_1 = require("@hapi/boom");
5
- const WABinary_1 = require("../WABinary");
6
- const socket_1 = require("./socket");
7
- const makeUSyncSocket = (config) => {
8
- const sock = (0, socket_1.makeSocket)(config);
9
- const { generateMessageTag, query, } = sock;
10
- const executeUSyncQuery = async (usyncQuery) => {
11
- if (usyncQuery.protocols.length === 0) {
12
- throw new boom_1.Boom('USyncQuery must have at least one protocol');
13
- }
14
- // todo: validate users, throw WARNING on no valid users
15
- // variable below has only validated users
16
- const validUsers = usyncQuery.users;
17
- const userNodes = validUsers.map((user) => {
18
- return {
19
- tag: 'user',
20
- attrs: {
21
- jid: !user.phone ? user.id : undefined,
22
- },
23
- content: usyncQuery.protocols
24
- .map((a) => a.getUserElement(user))
25
- .filter(a => a !== null)
26
- };
27
- });
28
- const listNode = {
29
- tag: 'list',
30
- attrs: {},
31
- content: userNodes
32
- };
33
- const queryNode = {
34
- tag: 'query',
35
- attrs: {},
36
- content: usyncQuery.protocols.map((a) => a.getQueryElement())
37
- };
38
- const iq = {
39
- tag: 'iq',
40
- attrs: {
41
- to: WABinary_1.S_WHATSAPP_NET,
42
- type: 'get',
43
- xmlns: 'usync',
44
- },
45
- content: [
46
- {
47
- tag: 'usync',
48
- attrs: {
49
- context: usyncQuery.context,
50
- mode: usyncQuery.mode,
51
- sid: generateMessageTag(),
52
- last: 'true',
53
- index: '0',
54
- },
55
- content: [
56
- queryNode,
57
- listNode
58
- ]
59
- }
60
- ],
61
- };
62
- const result = await query(iq);
63
- return usyncQuery.parseUSyncQueryResult(result);
64
- };
65
- return {
66
- ...sock,
67
- executeUSyncQuery,
68
- };
69
- };
70
- exports.makeUSyncSocket = makeUSyncSocket;
@@ -1,3 +0,0 @@
1
- import makeCacheManagerAuthState from './make-cache-manager-store';
2
- import makeInMemoryStore from './make-in-memory-store';
3
- export { makeInMemoryStore, makeCacheManagerAuthState };
@@ -1,13 +0,0 @@
1
- import { AuthenticationCreds } from '../Types';
2
- declare const makeCacheManagerAuthState: (store: Storage, sessionKey: string) => Promise<{
3
- clearState: () => Promise<void>;
4
- saveCreds: () => Promise<void>;
5
- state: {
6
- creds: AuthenticationCreds;
7
- keys: {
8
- get: (type: string, ids: string[]) => Promise<{}>;
9
- set: (data: any) => Promise<void>;
10
- };
11
- };
12
- }>;
13
- export default makeCacheManagerAuthState;
@@ -1,118 +0,0 @@
1
- import type KeyedDB from '@adiwajshing/keyed-db';
2
- import type { Comparable } from '@adiwajshing/keyed-db/lib/Types';
3
- import type { Logger } from 'pino';
4
- import { proto } from '../../WAProto';
5
- import type makeMDSocket from '../Socket';
6
- import type { BaileysEventEmitter, Chat, ConnectionState, Contact, GroupMetadata, PresenceData, WAMessage, WAMessageCursor, WAMessageKey } from '../Types';
7
- import { Label } from '../Types/Label';
8
- import { LabelAssociation } from '../Types/LabelAssociation';
9
- import { ObjectRepository } from './object-repository';
10
- type WASocket = ReturnType<typeof makeMDSocket>;
11
- export declare const waChatKey: (pin: boolean) => {
12
- key: (c: Chat) => string;
13
- compare: (k1: string, k2: string) => number;
14
- };
15
- export declare const waMessageID: (m: WAMessage) => string;
16
- export declare const waLabelAssociationKey: Comparable<LabelAssociation, string>;
17
- export type BaileysInMemoryStoreConfig = {
18
- chatKey?: Comparable<Chat, string>;
19
- labelAssociationKey?: Comparable<LabelAssociation, string>;
20
- logger?: Logger;
21
- socket?: WASocket;
22
- };
23
- declare const _default: (config: BaileysInMemoryStoreConfig) => {
24
- chats: KeyedDB<Chat, string>;
25
- contacts: {
26
- [_: string]: Contact;
27
- };
28
- messages: {
29
- [_: string]: {
30
- array: proto.IWebMessageInfo[];
31
- get: (id: string) => proto.IWebMessageInfo | undefined;
32
- upsert: (item: proto.IWebMessageInfo, mode: "append" | "prepend") => void;
33
- update: (item: proto.IWebMessageInfo) => boolean;
34
- remove: (item: proto.IWebMessageInfo) => boolean;
35
- updateAssign: (id: string, update: Partial<proto.IWebMessageInfo>) => boolean;
36
- clear: () => void;
37
- filter: (contain: (item: proto.IWebMessageInfo) => boolean) => void;
38
- toJSON: () => proto.IWebMessageInfo[];
39
- fromJSON: (newItems: proto.IWebMessageInfo[]) => void;
40
- };
41
- };
42
- groupMetadata: {
43
- [_: string]: GroupMetadata;
44
- };
45
- state: ConnectionState;
46
- presences: {
47
- [id: string]: {
48
- [participant: string]: PresenceData;
49
- };
50
- };
51
- labels: ObjectRepository<Label>;
52
- labelAssociations: KeyedDB<LabelAssociation, string>;
53
- bind: (ev: BaileysEventEmitter) => void;
54
- /** loads messages from the store, if not found -- uses the legacy connection */
55
- loadMessages: (jid: string, count: number, cursor: WAMessageCursor) => Promise<proto.IWebMessageInfo[]>;
56
- /**
57
- * Get all available labels for profile
58
- *
59
- * Keep in mind that the list is formed from predefined tags and tags
60
- * that were "caught" during their editing.
61
- */
62
- getLabels: () => ObjectRepository<Label>;
63
- /**
64
- * Get labels for chat
65
- *
66
- * @returns Label IDs
67
- **/
68
- getChatLabels: (chatId: string) => LabelAssociation[];
69
- /**
70
- * Get labels for message
71
- *
72
- * @returns Label IDs
73
- **/
74
- getMessageLabels: (messageId: string) => string[];
75
- loadMessage: (jid: string, id: string) => Promise<proto.IWebMessageInfo | undefined>;
76
- mostRecentMessage: (jid: string) => Promise<proto.IWebMessageInfo>;
77
- fetchImageUrl: (jid: string, sock: WASocket | undefined) => Promise<string | null | undefined>;
78
- fetchGroupMetadata: (jid: string, sock: WASocket | undefined) => Promise<GroupMetadata>;
79
- fetchMessageReceipts: ({ remoteJid, id }: WAMessageKey) => Promise<proto.IUserReceipt[] | null | undefined>;
80
- toJSON: () => {
81
- chats: KeyedDB<Chat, string>;
82
- contacts: {
83
- [_: string]: Contact;
84
- };
85
- messages: {
86
- [_: string]: {
87
- array: proto.IWebMessageInfo[];
88
- get: (id: string) => proto.IWebMessageInfo | undefined;
89
- upsert: (item: proto.IWebMessageInfo, mode: "append" | "prepend") => void;
90
- update: (item: proto.IWebMessageInfo) => boolean;
91
- remove: (item: proto.IWebMessageInfo) => boolean;
92
- updateAssign: (id: string, update: Partial<proto.IWebMessageInfo>) => boolean;
93
- clear: () => void;
94
- filter: (contain: (item: proto.IWebMessageInfo) => boolean) => void;
95
- toJSON: () => proto.IWebMessageInfo[];
96
- fromJSON: (newItems: proto.IWebMessageInfo[]) => void;
97
- };
98
- };
99
- labels: ObjectRepository<Label>;
100
- labelAssociations: KeyedDB<LabelAssociation, string>;
101
- };
102
- fromJSON: (json: {
103
- chats: Chat[];
104
- contacts: {
105
- [id: string]: Contact;
106
- };
107
- messages: {
108
- [id: string]: proto.IWebMessageInfo[];
109
- };
110
- labels: {
111
- [labelId: string]: Label;
112
- };
113
- labelAssociations: LabelAssociation[];
114
- }) => void;
115
- writeToFile: (path: string) => void;
116
- readFromFile: (path: string) => void;
117
- };
118
- export default _default;
@@ -1,13 +0,0 @@
1
- declare function makeOrderedDictionary<T>(idGetter: (item: T) => string): {
2
- array: T[];
3
- get: (id: string) => T | undefined;
4
- upsert: (item: T, mode: 'append' | 'prepend') => void;
5
- update: (item: T) => boolean;
6
- remove: (item: T) => boolean;
7
- updateAssign: (id: string, update: Partial<T>) => boolean;
8
- clear: () => void;
9
- filter: (contain: (item: T) => boolean) => void;
10
- toJSON: () => T[];
11
- fromJSON: (newItems: T[]) => void;
12
- };
13
- export default makeOrderedDictionary;
@@ -1,10 +0,0 @@
1
- export declare class ObjectRepository<T extends object> {
2
- readonly entityMap: Map<string, T>;
3
- constructor(entities?: Record<string, T>);
4
- findById(id: string): T | undefined;
5
- findAll(): T[];
6
- upsertById(id: string, entity: T): Map<string, T>;
7
- deleteById(id: string): boolean;
8
- count(): number;
9
- toJSON(): T[];
10
- }
@@ -1,110 +0,0 @@
1
- /// <reference types="node" />
2
- import type { proto } from '../../WAProto';
3
- import { RegistrationOptions } from '../Socket/registration';
4
- import type { Contact } from './Contact';
5
- import type { MinimalMessage } from './Message';
6
- export type KeyPair = {
7
- public: Uint8Array;
8
- private: Uint8Array;
9
- };
10
- export type SignedKeyPair = {
11
- keyPair: KeyPair;
12
- signature: Uint8Array;
13
- keyId: number;
14
- timestampS?: number;
15
- };
16
- export type ProtocolAddress = {
17
- name: string;
18
- deviceId: number;
19
- };
20
- export type SignalIdentity = {
21
- identifier: ProtocolAddress;
22
- identifierKey: Uint8Array;
23
- };
24
- export type LTHashState = {
25
- version: number;
26
- hash: Buffer;
27
- indexValueMap: {
28
- [indexMacBase64: string]: {
29
- valueMac: Uint8Array | Buffer;
30
- };
31
- };
32
- };
33
- export type SignalCreds = {
34
- readonly signedIdentityKey: KeyPair;
35
- readonly signedPreKey: SignedKeyPair;
36
- readonly registrationId: number;
37
- };
38
- export type AccountSettings = {
39
- /** unarchive chats when a new message is received */
40
- unarchiveChats: boolean;
41
- /** the default mode to start new conversations with */
42
- defaultDisappearingMode?: Pick<proto.IConversation, 'ephemeralExpiration' | 'ephemeralSettingTimestamp'>;
43
- };
44
- export type AuthenticationCreds = SignalCreds & {
45
- readonly noiseKey: KeyPair;
46
- readonly pairingEphemeralKeyPair: KeyPair;
47
- advSecretKey: string;
48
- me?: Contact;
49
- account?: proto.IADVSignedDeviceIdentity;
50
- signalIdentities?: SignalIdentity[];
51
- myAppStateKeyId?: string;
52
- firstUnuploadedPreKeyId: number;
53
- nextPreKeyId: number;
54
- lastAccountSyncTimestamp?: number;
55
- platform?: string;
56
- processedHistoryMessages: MinimalMessage[];
57
- /** number of times history & app state has been synced */
58
- accountSyncCounter: number;
59
- accountSettings: AccountSettings;
60
- deviceId: string;
61
- phoneId: string;
62
- identityId: Buffer;
63
- registered: boolean;
64
- backupToken: Buffer;
65
- registration: RegistrationOptions;
66
- pairingCode: string | undefined;
67
- lastPropHash: string | undefined;
68
- routingInfo: Buffer | undefined;
69
- };
70
- export type SignalDataTypeMap = {
71
- 'pre-key': KeyPair;
72
- 'session': Uint8Array;
73
- 'sender-key': Uint8Array;
74
- 'sender-key-memory': {
75
- [jid: string]: boolean;
76
- };
77
- 'app-state-sync-key': proto.Message.IAppStateSyncKeyData;
78
- 'app-state-sync-version': LTHashState;
79
- };
80
- export type SignalDataSet = {
81
- [T in keyof SignalDataTypeMap]?: {
82
- [id: string]: SignalDataTypeMap[T] | null;
83
- };
84
- };
85
- type Awaitable<T> = T | Promise<T>;
86
- export type SignalKeyStore = {
87
- get<T extends keyof SignalDataTypeMap>(type: T, ids: string[]): Awaitable<{
88
- [id: string]: SignalDataTypeMap[T];
89
- }>;
90
- set(data: SignalDataSet): Awaitable<void>;
91
- /** clear all the data in the store */
92
- clear?(): Awaitable<void>;
93
- };
94
- export type SignalKeyStoreWithTransaction = SignalKeyStore & {
95
- isInTransaction: () => boolean;
96
- transaction<T>(exec: () => Promise<T>): Promise<T>;
97
- };
98
- export type TransactionCapabilityOptions = {
99
- maxCommitRetries: number;
100
- delayBetweenTriesMs: number;
101
- };
102
- export type SignalAuthState = {
103
- creds: SignalCreds;
104
- keys: SignalKeyStore | SignalKeyStoreWithTransaction;
105
- };
106
- export type AuthenticationState = {
107
- creds: AuthenticationCreds;
108
- keys: SignalKeyStore;
109
- };
110
- export {};
@@ -1,13 +0,0 @@
1
- export type WACallUpdateType = 'offer' | 'ringing' | 'timeout' | 'reject' | 'accept';
2
- export type WACallEvent = {
3
- chatId: string;
4
- from: string;
5
- isGroup?: boolean;
6
- groupJid?: string;
7
- id: string;
8
- date: Date;
9
- isVideo?: boolean;
10
- status: WACallUpdateType;
11
- offline: boolean;
12
- latencyMs?: number;
13
- };
@@ -1,102 +0,0 @@
1
- import type { proto } from '../../WAProto';
2
- import type { AccountSettings } from './Auth';
3
- import type { BufferedEventData } from './Events';
4
- import type { ChatLabelAssociationActionBody } from './LabelAssociation';
5
- import type { MessageLabelAssociationActionBody } from './LabelAssociation';
6
- import type { MinimalMessage } from './Message';
7
- /** privacy settings in WhatsApp Web */
8
- export type WAPrivacyValue = 'all' | 'contacts' | 'contact_blacklist' | 'none';
9
- export type WAPrivacyOnlineValue = 'all' | 'match_last_seen';
10
- export type WAReadReceiptsValue = 'all' | 'none';
11
- /** set of statuses visible to other people; see updatePresence() in WhatsAppWeb.Send */
12
- export type WAPresence = 'unavailable' | 'available' | 'composing' | 'recording' | 'paused';
13
- export declare const ALL_WA_PATCH_NAMES: readonly ["critical_block", "critical_unblock_low", "regular_high", "regular_low", "regular"];
14
- export type WAPatchName = typeof ALL_WA_PATCH_NAMES[number];
15
- export interface PresenceData {
16
- lastKnownPresence: WAPresence;
17
- lastSeen?: number;
18
- }
19
- export type ChatMutation = {
20
- syncAction: proto.ISyncActionData;
21
- index: string[];
22
- };
23
- export type WAPatchCreate = {
24
- syncAction: proto.ISyncActionValue;
25
- index: string[];
26
- type: WAPatchName;
27
- apiVersion: number;
28
- operation: proto.SyncdMutation.SyncdOperation;
29
- };
30
- export type Chat = proto.IConversation & {
31
- /** unix timestamp of when the last message was received in the chat */
32
- lastMessageRecvTimestamp?: number;
33
- };
34
- export type ChatUpdate = Partial<Chat & {
35
- /**
36
- * if specified in the update,
37
- * the EV buffer will check if the condition gets fulfilled before applying the update
38
- * Right now, used to determine when to release an app state sync event
39
- *
40
- * @returns true, if the update should be applied;
41
- * false if it can be discarded;
42
- * undefined if the condition is not yet fulfilled
43
- * */
44
- conditional: (bufferedData: BufferedEventData) => boolean | undefined;
45
- }>;
46
- /**
47
- * the last messages in a chat, sorted reverse-chronologically. That is, the latest message should be first in the chat
48
- * for MD modifications, the last message in the array (i.e. the earlist message) must be the last message recv in the chat
49
- * */
50
- export type LastMessageList = MinimalMessage[] | proto.SyncActionValue.ISyncActionMessageRange;
51
- export type ChatModification = {
52
- archive: boolean;
53
- lastMessages: LastMessageList;
54
- } | {
55
- pushNameSetting: string;
56
- } | {
57
- pin: boolean;
58
- } | {
59
- /** mute for duration, or provide timestamp of mute to remove*/
60
- mute: number | null;
61
- } | {
62
- clear: 'all' | {
63
- messages: {
64
- id: string;
65
- fromMe?: boolean;
66
- timestamp: number;
67
- }[];
68
- };
69
- } | {
70
- star: {
71
- messages: {
72
- id: string;
73
- fromMe?: boolean;
74
- }[];
75
- star: boolean;
76
- };
77
- } | {
78
- markRead: boolean;
79
- lastMessages: LastMessageList;
80
- } | {
81
- delete: true;
82
- lastMessages: LastMessageList;
83
- } | {
84
- addChatLabel: ChatLabelAssociationActionBody;
85
- } | {
86
- removeChatLabel: ChatLabelAssociationActionBody;
87
- } | {
88
- addMessageLabel: MessageLabelAssociationActionBody;
89
- } | {
90
- removeMessageLabel: MessageLabelAssociationActionBody;
91
- };
92
- export type InitialReceivedChatsState = {
93
- [jid: string]: {
94
- /** the last message received from the other party */
95
- lastMsgRecvTimestamp?: number;
96
- /** the absolute last message in the chat */
97
- lastMsgTimestamp: number;
98
- };
99
- };
100
- export type InitialAppStateSyncOptions = {
101
- accountSettings: AccountSettings;
102
- };
@@ -1,19 +0,0 @@
1
- export interface Contact {
2
- id: string;
3
- lid?: string;
4
- /** name of the contact, you have saved on your WA */
5
- name?: string;
6
- /** name of the contact, the contact has set on their own on WA */
7
- notify?: string;
8
- /** I have no idea */
9
- verifiedName?: string;
10
- /**
11
- * Url of the profile picture of the contact
12
- *
13
- * 'changed' => if the profile picture has changed
14
- * null => if the profile picture has not been set (default profile picture)
15
- * any other string => url of the profile picture
16
- */
17
- imgUrl?: string | null | 'changed';
18
- status?: string;
19
- }
@@ -1,157 +0,0 @@
1
- import type { Boom } from '@hapi/boom';
2
- import { proto } from '../../WAProto';
3
- import { AuthenticationCreds } from './Auth';
4
- import { WACallEvent } from './Call';
5
- import { Chat, ChatUpdate, PresenceData } from './Chat';
6
- import { Contact } from './Contact';
7
- import { GroupMetadata, ParticipantAction } from './GroupMetadata';
8
- import { Label } from './Label';
9
- import { LabelAssociation } from './LabelAssociation';
10
- import { MessageUpsertType, MessageUserReceiptUpdate, WAMessage, WAMessageKey, WAMessageUpdate } from './Message';
11
- import { ConnectionState } from './State';
12
- export type BaileysEventMap = {
13
- /** connection state has been updated -- WS closed, opened, connecting etc. */
14
- 'connection.update': Partial<ConnectionState>;
15
- /** credentials updated -- some metadata, keys or something */
16
- 'creds.update': Partial<AuthenticationCreds>;
17
- /** set chats (history sync), everything is reverse chronologically sorted */
18
- 'messaging-history.set': {
19
- chats: Chat[];
20
- contacts: Contact[];
21
- messages: WAMessage[];
22
- isLatest: boolean;
23
- };
24
- /** upsert chats */
25
- 'chats.upsert': Chat[];
26
- /** update the given chats */
27
- 'chats.update': ChatUpdate[];
28
- 'chats.phoneNumberShare': {
29
- lid: string;
30
- jid: string;
31
- };
32
- /** delete chats with given ID */
33
- 'chats.delete': string[];
34
- /** presence of contact in a chat updated */
35
- 'presence.update': {
36
- id: string;
37
- presences: {
38
- [participant: string]: PresenceData;
39
- };
40
- };
41
- 'contacts.upsert': Contact[];
42
- 'contacts.update': Partial<Contact>[];
43
- 'messages.delete': {
44
- keys: WAMessageKey[];
45
- } | {
46
- jid: string;
47
- all: true;
48
- };
49
- 'messages.update': WAMessageUpdate[];
50
- 'messages.media-update': {
51
- key: WAMessageKey;
52
- media?: {
53
- ciphertext: Uint8Array;
54
- iv: Uint8Array;
55
- };
56
- error?: Boom;
57
- }[];
58
- /**
59
- * add/update the given messages. If they were received while the connection was online,
60
- * the update will have type: "notify"
61
- * */
62
- 'messages.upsert': {
63
- messages: WAMessage[];
64
- type: MessageUpsertType;
65
- };
66
- /** message was reacted to. If reaction was removed -- then "reaction.text" will be falsey */
67
- 'messages.reaction': {
68
- key: WAMessageKey;
69
- reaction: proto.IReaction;
70
- }[];
71
- 'message-receipt.update': MessageUserReceiptUpdate[];
72
- 'groups.upsert': GroupMetadata[];
73
- 'groups.update': Partial<GroupMetadata>[];
74
- /** apply an action to participants in a group */
75
- 'group-participants.update': {
76
- id: string;
77
- author: string;
78
- participants: string[];
79
- action: ParticipantAction;
80
- };
81
- 'blocklist.set': {
82
- blocklist: string[];
83
- };
84
- 'blocklist.update': {
85
- blocklist: string[];
86
- type: 'add' | 'remove';
87
- };
88
- /** Receive an update on a call, including when the call was received, rejected, accepted */
89
- 'call': WACallEvent[];
90
- 'labels.edit': Label;
91
- 'labels.association': {
92
- association: LabelAssociation;
93
- type: 'add' | 'remove';
94
- };
95
- };
96
- export type BufferedEventData = {
97
- historySets: {
98
- chats: {
99
- [jid: string]: Chat;
100
- };
101
- contacts: {
102
- [jid: string]: Contact;
103
- };
104
- messages: {
105
- [uqId: string]: WAMessage;
106
- };
107
- empty: boolean;
108
- isLatest: boolean;
109
- };
110
- chatUpserts: {
111
- [jid: string]: Chat;
112
- };
113
- chatUpdates: {
114
- [jid: string]: ChatUpdate;
115
- };
116
- chatDeletes: Set<string>;
117
- contactUpserts: {
118
- [jid: string]: Contact;
119
- };
120
- contactUpdates: {
121
- [jid: string]: Partial<Contact>;
122
- };
123
- messageUpserts: {
124
- [key: string]: {
125
- type: MessageUpsertType;
126
- message: WAMessage;
127
- };
128
- };
129
- messageUpdates: {
130
- [key: string]: WAMessageUpdate;
131
- };
132
- messageDeletes: {
133
- [key: string]: WAMessageKey;
134
- };
135
- messageReactions: {
136
- [key: string]: {
137
- key: WAMessageKey;
138
- reactions: proto.IReaction[];
139
- };
140
- };
141
- messageReceipts: {
142
- [key: string]: {
143
- key: WAMessageKey;
144
- userReceipt: proto.IUserReceipt[];
145
- };
146
- };
147
- groupUpdates: {
148
- [jid: string]: Partial<GroupMetadata>;
149
- };
150
- };
151
- export type BaileysEvent = keyof BaileysEventMap;
152
- export interface BaileysEventEmitter {
153
- on<T extends keyof BaileysEventMap>(event: T, listener: (arg: BaileysEventMap[T]) => void): void;
154
- off<T extends keyof BaileysEventMap>(event: T, listener: (arg: BaileysEventMap[T]) => void): void;
155
- removeAllListeners<T extends keyof BaileysEventMap>(event: T): void;
156
- emit<T extends keyof BaileysEventMap>(event: T, arg: BaileysEventMap[T]): boolean;
157
- }