@vsxid/alya-baileys 0.0.0-stage → 1.0.0

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 (432) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +1650 -2
  3. package/WAProto/GenerateStatics.sh +3 -0
  4. package/WAProto/WAProto.proto +5479 -0
  5. package/WAProto/fix-imports.js +85 -0
  6. package/WAProto/index.d.ts +14017 -0
  7. package/WAProto/index.js +97691 -0
  8. package/engine-requirements.js +10 -0
  9. package/lib/Defaults/index.d.ts +75 -0
  10. package/lib/Defaults/index.d.ts.map +1 -0
  11. package/lib/Defaults/index.js +129 -0
  12. package/lib/Defaults/index.js.map +1 -0
  13. package/lib/Signal/Group/ciphertext-message.d.ts +10 -0
  14. package/lib/Signal/Group/ciphertext-message.d.ts.map +1 -0
  15. package/lib/Signal/Group/ciphertext-message.js +12 -0
  16. package/lib/Signal/Group/ciphertext-message.js.map +1 -0
  17. package/lib/Signal/Group/group-session-builder.d.ts +15 -0
  18. package/lib/Signal/Group/group-session-builder.d.ts.map +1 -0
  19. package/lib/Signal/Group/group-session-builder.js +30 -0
  20. package/lib/Signal/Group/group-session-builder.js.map +1 -0
  21. package/lib/Signal/Group/group_cipher.d.ts +17 -0
  22. package/lib/Signal/Group/group_cipher.d.ts.map +1 -0
  23. package/lib/Signal/Group/group_cipher.js +82 -0
  24. package/lib/Signal/Group/group_cipher.js.map +1 -0
  25. package/lib/Signal/Group/index.d.ts +12 -0
  26. package/lib/Signal/Group/index.d.ts.map +1 -0
  27. package/lib/Signal/Group/index.js +12 -0
  28. package/lib/Signal/Group/index.js.map +1 -0
  29. package/lib/Signal/Group/keyhelper.d.ts +11 -0
  30. package/lib/Signal/Group/keyhelper.d.ts.map +1 -0
  31. package/lib/Signal/Group/keyhelper.js +18 -0
  32. package/lib/Signal/Group/keyhelper.js.map +1 -0
  33. package/lib/Signal/Group/sender-chain-key.d.ts +14 -0
  34. package/lib/Signal/Group/sender-chain-key.d.ts.map +1 -0
  35. package/lib/Signal/Group/sender-chain-key.js +26 -0
  36. package/lib/Signal/Group/sender-chain-key.js.map +1 -0
  37. package/lib/Signal/Group/sender-key-distribution-message.d.ts +17 -0
  38. package/lib/Signal/Group/sender-key-distribution-message.d.ts.map +1 -0
  39. package/lib/Signal/Group/sender-key-distribution-message.js +63 -0
  40. package/lib/Signal/Group/sender-key-distribution-message.js.map +1 -0
  41. package/lib/Signal/Group/sender-key-message.d.ts +19 -0
  42. package/lib/Signal/Group/sender-key-message.d.ts.map +1 -0
  43. package/lib/Signal/Group/sender-key-message.js +66 -0
  44. package/lib/Signal/Group/sender-key-message.js.map +1 -0
  45. package/lib/Signal/Group/sender-key-name.d.ts +18 -0
  46. package/lib/Signal/Group/sender-key-name.d.ts.map +1 -0
  47. package/lib/Signal/Group/sender-key-name.js +48 -0
  48. package/lib/Signal/Group/sender-key-name.js.map +1 -0
  49. package/lib/Signal/Group/sender-key-record.d.ts +31 -0
  50. package/lib/Signal/Group/sender-key-record.d.ts.map +1 -0
  51. package/lib/Signal/Group/sender-key-record.js +41 -0
  52. package/lib/Signal/Group/sender-key-record.js.map +1 -0
  53. package/lib/Signal/Group/sender-key-state.d.ts +39 -0
  54. package/lib/Signal/Group/sender-key-state.d.ts.map +1 -0
  55. package/lib/Signal/Group/sender-key-state.js +84 -0
  56. package/lib/Signal/Group/sender-key-state.js.map +1 -0
  57. package/lib/Signal/Group/sender-message-key.d.ts +12 -0
  58. package/lib/Signal/Group/sender-message-key.d.ts.map +1 -0
  59. package/lib/Signal/Group/sender-message-key.js +26 -0
  60. package/lib/Signal/Group/sender-message-key.js.map +1 -0
  61. package/lib/Signal/libsignal.d.ts +5 -0
  62. package/lib/Signal/libsignal.d.ts.map +1 -0
  63. package/lib/Signal/libsignal.js +431 -0
  64. package/lib/Signal/libsignal.js.map +1 -0
  65. package/lib/Signal/lid-mapping.d.ts +23 -0
  66. package/lib/Signal/lid-mapping.d.ts.map +1 -0
  67. package/lib/Signal/lid-mapping.js +277 -0
  68. package/lib/Signal/lid-mapping.js.map +1 -0
  69. package/lib/Socket/Client/index.d.ts +3 -0
  70. package/lib/Socket/Client/index.d.ts.map +1 -0
  71. package/lib/Socket/Client/index.js +3 -0
  72. package/lib/Socket/Client/index.js.map +1 -0
  73. package/lib/Socket/Client/types.d.ts +16 -0
  74. package/lib/Socket/Client/types.d.ts.map +1 -0
  75. package/lib/Socket/Client/types.js +11 -0
  76. package/lib/Socket/Client/types.js.map +1 -0
  77. package/lib/Socket/Client/websocket.d.ts +13 -0
  78. package/lib/Socket/Client/websocket.d.ts.map +1 -0
  79. package/lib/Socket/Client/websocket.js +54 -0
  80. package/lib/Socket/Client/websocket.js.map +1 -0
  81. package/lib/Socket/business.d.ts +217 -0
  82. package/lib/Socket/business.d.ts.map +1 -0
  83. package/lib/Socket/business.js +379 -0
  84. package/lib/Socket/business.js.map +1 -0
  85. package/lib/Socket/chats.d.ts +125 -0
  86. package/lib/Socket/chats.d.ts.map +1 -0
  87. package/lib/Socket/chats.js +1198 -0
  88. package/lib/Socket/chats.js.map +1 -0
  89. package/lib/Socket/communities.d.ts +273 -0
  90. package/lib/Socket/communities.d.ts.map +1 -0
  91. package/lib/Socket/communities.js +431 -0
  92. package/lib/Socket/communities.js.map +1 -0
  93. package/lib/Socket/groups.d.ts +161 -0
  94. package/lib/Socket/groups.d.ts.map +1 -0
  95. package/lib/Socket/groups.js +347 -0
  96. package/lib/Socket/groups.js.map +1 -0
  97. package/lib/Socket/index.d.ts +260 -0
  98. package/lib/Socket/index.d.ts.map +1 -0
  99. package/lib/Socket/index.js +12 -0
  100. package/lib/Socket/index.js.map +1 -0
  101. package/lib/Socket/messages-recv.d.ts +203 -0
  102. package/lib/Socket/messages-recv.d.ts.map +1 -0
  103. package/lib/Socket/messages-recv.js +1772 -0
  104. package/lib/Socket/messages-recv.js.map +1 -0
  105. package/lib/Socket/messages-send.d.ts +199 -0
  106. package/lib/Socket/messages-send.d.ts.map +1 -0
  107. package/lib/Socket/messages-send.js +1169 -0
  108. package/lib/Socket/messages-send.js.map +1 -0
  109. package/lib/Socket/mex.d.ts +3 -0
  110. package/lib/Socket/mex.d.ts.map +1 -0
  111. package/lib/Socket/mex.js +42 -0
  112. package/lib/Socket/mex.js.map +1 -0
  113. package/lib/Socket/newsletter.d.ts +170 -0
  114. package/lib/Socket/newsletter.d.ts.map +1 -0
  115. package/lib/Socket/newsletter.js +181 -0
  116. package/lib/Socket/newsletter.js.map +1 -0
  117. package/lib/Socket/socket.d.ts +59 -0
  118. package/lib/Socket/socket.d.ts.map +1 -0
  119. package/lib/Socket/socket.js +970 -0
  120. package/lib/Socket/socket.js.map +1 -0
  121. package/lib/Types/Auth.d.ts +117 -0
  122. package/lib/Types/Auth.d.ts.map +1 -0
  123. package/lib/Types/Auth.js +2 -0
  124. package/lib/Types/Auth.js.map +1 -0
  125. package/lib/Types/Bussines.d.ts +25 -0
  126. package/lib/Types/Bussines.d.ts.map +1 -0
  127. package/lib/Types/Bussines.js +2 -0
  128. package/lib/Types/Bussines.js.map +1 -0
  129. package/lib/Types/Call.d.ts +15 -0
  130. package/lib/Types/Call.d.ts.map +1 -0
  131. package/lib/Types/Call.js +2 -0
  132. package/lib/Types/Call.js.map +1 -0
  133. package/lib/Types/Chat.d.ts +124 -0
  134. package/lib/Types/Chat.d.ts.map +1 -0
  135. package/lib/Types/Chat.js +8 -0
  136. package/lib/Types/Chat.js.map +1 -0
  137. package/lib/Types/Contact.d.ts +26 -0
  138. package/lib/Types/Contact.d.ts.map +1 -0
  139. package/lib/Types/Contact.js +2 -0
  140. package/lib/Types/Contact.js.map +1 -0
  141. package/lib/Types/Events.d.ts +256 -0
  142. package/lib/Types/Events.d.ts.map +1 -0
  143. package/lib/Types/Events.js +2 -0
  144. package/lib/Types/Events.js.map +1 -0
  145. package/lib/Types/GroupMetadata.d.ts +71 -0
  146. package/lib/Types/GroupMetadata.d.ts.map +1 -0
  147. package/lib/Types/GroupMetadata.js +2 -0
  148. package/lib/Types/GroupMetadata.js.map +1 -0
  149. package/lib/Types/Label.d.ts +47 -0
  150. package/lib/Types/Label.d.ts.map +1 -0
  151. package/lib/Types/Label.js +25 -0
  152. package/lib/Types/Label.js.map +1 -0
  153. package/lib/Types/LabelAssociation.d.ts +30 -0
  154. package/lib/Types/LabelAssociation.d.ts.map +1 -0
  155. package/lib/Types/LabelAssociation.js +7 -0
  156. package/lib/Types/LabelAssociation.js.map +1 -0
  157. package/lib/Types/Message.d.ts +320 -0
  158. package/lib/Types/Message.d.ts.map +1 -0
  159. package/lib/Types/Message.js +11 -0
  160. package/lib/Types/Message.js.map +1 -0
  161. package/lib/Types/Mex.d.ts +141 -0
  162. package/lib/Types/Mex.d.ts.map +1 -0
  163. package/lib/Types/Mex.js +37 -0
  164. package/lib/Types/Mex.js.map +1 -0
  165. package/lib/Types/Product.d.ts +79 -0
  166. package/lib/Types/Product.d.ts.map +1 -0
  167. package/lib/Types/Product.js +2 -0
  168. package/lib/Types/Product.js.map +1 -0
  169. package/lib/Types/Signal.d.ts +87 -0
  170. package/lib/Types/Signal.d.ts.map +1 -0
  171. package/lib/Types/Signal.js +2 -0
  172. package/lib/Types/Signal.js.map +1 -0
  173. package/lib/Types/Socket.d.ts +136 -0
  174. package/lib/Types/Socket.d.ts.map +1 -0
  175. package/lib/Types/Socket.js +3 -0
  176. package/lib/Types/Socket.js.map +1 -0
  177. package/lib/Types/State.d.ts +97 -0
  178. package/lib/Types/State.d.ts.map +1 -0
  179. package/lib/Types/State.js +56 -0
  180. package/lib/Types/State.js.map +1 -0
  181. package/lib/Types/USync.d.ts +26 -0
  182. package/lib/Types/USync.d.ts.map +1 -0
  183. package/lib/Types/USync.js +2 -0
  184. package/lib/Types/USync.js.map +1 -0
  185. package/lib/Types/index.d.ts +66 -0
  186. package/lib/Types/index.d.ts.map +1 -0
  187. package/lib/Types/index.js +26 -0
  188. package/lib/Types/index.js.map +1 -0
  189. package/lib/Utils/auth-utils.d.ts +24 -0
  190. package/lib/Utils/auth-utils.d.ts.map +1 -0
  191. package/lib/Utils/auth-utils.js +302 -0
  192. package/lib/Utils/auth-utils.js.map +1 -0
  193. package/lib/Utils/browser-utils.d.ts +4 -0
  194. package/lib/Utils/browser-utils.d.ts.map +1 -0
  195. package/lib/Utils/browser-utils.js +29 -0
  196. package/lib/Utils/browser-utils.js.map +1 -0
  197. package/lib/Utils/business.d.ts +23 -0
  198. package/lib/Utils/business.d.ts.map +1 -0
  199. package/lib/Utils/business.js +231 -0
  200. package/lib/Utils/business.js.map +1 -0
  201. package/lib/Utils/chat-utils.d.ts +100 -0
  202. package/lib/Utils/chat-utils.d.ts.map +1 -0
  203. package/lib/Utils/chat-utils.js +872 -0
  204. package/lib/Utils/chat-utils.js.map +1 -0
  205. package/lib/Utils/companion-reg-client-utils.d.ts +17 -0
  206. package/lib/Utils/companion-reg-client-utils.d.ts.map +1 -0
  207. package/lib/Utils/companion-reg-client-utils.js +35 -0
  208. package/lib/Utils/companion-reg-client-utils.js.map +1 -0
  209. package/lib/Utils/crypto.d.ts +37 -0
  210. package/lib/Utils/crypto.d.ts.map +1 -0
  211. package/lib/Utils/crypto.js +118 -0
  212. package/lib/Utils/crypto.js.map +1 -0
  213. package/lib/Utils/decode-wa-message.d.ts +66 -0
  214. package/lib/Utils/decode-wa-message.d.ts.map +1 -0
  215. package/lib/Utils/decode-wa-message.js +317 -0
  216. package/lib/Utils/decode-wa-message.js.map +1 -0
  217. package/lib/Utils/event-buffer.d.ts +36 -0
  218. package/lib/Utils/event-buffer.d.ts.map +1 -0
  219. package/lib/Utils/event-buffer.js +622 -0
  220. package/lib/Utils/event-buffer.js.map +1 -0
  221. package/lib/Utils/generics.d.ts +92 -0
  222. package/lib/Utils/generics.d.ts.map +1 -0
  223. package/lib/Utils/generics.js +393 -0
  224. package/lib/Utils/generics.js.map +1 -0
  225. package/lib/Utils/history.d.ts +24 -0
  226. package/lib/Utils/history.d.ts.map +1 -0
  227. package/lib/Utils/history.js +134 -0
  228. package/lib/Utils/history.js.map +1 -0
  229. package/lib/Utils/identity-change-handler.d.ts +44 -0
  230. package/lib/Utils/identity-change-handler.d.ts.map +1 -0
  231. package/lib/Utils/identity-change-handler.js +50 -0
  232. package/lib/Utils/identity-change-handler.js.map +1 -0
  233. package/lib/Utils/index.d.ts +22 -0
  234. package/lib/Utils/index.d.ts.map +1 -0
  235. package/lib/Utils/index.js +22 -0
  236. package/lib/Utils/index.js.map +1 -0
  237. package/lib/Utils/link-preview.d.ts +21 -0
  238. package/lib/Utils/link-preview.d.ts.map +1 -0
  239. package/lib/Utils/link-preview.js +85 -0
  240. package/lib/Utils/link-preview.js.map +1 -0
  241. package/lib/Utils/logger.d.ts +12 -0
  242. package/lib/Utils/logger.d.ts.map +1 -0
  243. package/lib/Utils/logger.js +3 -0
  244. package/lib/Utils/logger.js.map +1 -0
  245. package/lib/Utils/lt-hash.d.ts +8 -0
  246. package/lib/Utils/lt-hash.d.ts.map +1 -0
  247. package/lib/Utils/lt-hash.js +8 -0
  248. package/lib/Utils/lt-hash.js.map +1 -0
  249. package/lib/Utils/make-mutex.d.ts +9 -0
  250. package/lib/Utils/make-mutex.d.ts.map +1 -0
  251. package/lib/Utils/make-mutex.js +33 -0
  252. package/lib/Utils/make-mutex.js.map +1 -0
  253. package/lib/Utils/message-retry-manager.d.ts +115 -0
  254. package/lib/Utils/message-retry-manager.d.ts.map +1 -0
  255. package/lib/Utils/message-retry-manager.js +265 -0
  256. package/lib/Utils/message-retry-manager.js.map +1 -0
  257. package/lib/Utils/messages-media.d.ts +133 -0
  258. package/lib/Utils/messages-media.d.ts.map +1 -0
  259. package/lib/Utils/messages-media.js +788 -0
  260. package/lib/Utils/messages-media.js.map +1 -0
  261. package/lib/Utils/messages.d.ts +91 -0
  262. package/lib/Utils/messages.d.ts.map +1 -0
  263. package/lib/Utils/messages.js +893 -0
  264. package/lib/Utils/messages.js.map +1 -0
  265. package/lib/Utils/noise-handler.d.ts +20 -0
  266. package/lib/Utils/noise-handler.d.ts.map +1 -0
  267. package/lib/Utils/noise-handler.js +201 -0
  268. package/lib/Utils/noise-handler.js.map +1 -0
  269. package/lib/Utils/offline-node-processor.d.ts +17 -0
  270. package/lib/Utils/offline-node-processor.d.ts.map +1 -0
  271. package/lib/Utils/offline-node-processor.js +40 -0
  272. package/lib/Utils/offline-node-processor.js.map +1 -0
  273. package/lib/Utils/pre-key-manager.d.ts +28 -0
  274. package/lib/Utils/pre-key-manager.d.ts.map +1 -0
  275. package/lib/Utils/pre-key-manager.js +106 -0
  276. package/lib/Utils/pre-key-manager.js.map +1 -0
  277. package/lib/Utils/process-message.d.ts +60 -0
  278. package/lib/Utils/process-message.d.ts.map +1 -0
  279. package/lib/Utils/process-message.js +630 -0
  280. package/lib/Utils/process-message.js.map +1 -0
  281. package/lib/Utils/reporting-utils.d.ts +11 -0
  282. package/lib/Utils/reporting-utils.d.ts.map +1 -0
  283. package/lib/Utils/reporting-utils.js +258 -0
  284. package/lib/Utils/reporting-utils.js.map +1 -0
  285. package/lib/Utils/signal.d.ts +47 -0
  286. package/lib/Utils/signal.d.ts.map +1 -0
  287. package/lib/Utils/signal.js +201 -0
  288. package/lib/Utils/signal.js.map +1 -0
  289. package/lib/Utils/stanza-ack.d.ts +11 -0
  290. package/lib/Utils/stanza-ack.d.ts.map +1 -0
  291. package/lib/Utils/stanza-ack.js +38 -0
  292. package/lib/Utils/stanza-ack.js.map +1 -0
  293. package/lib/Utils/sync-action-utils.d.ts +19 -0
  294. package/lib/Utils/sync-action-utils.d.ts.map +1 -0
  295. package/lib/Utils/sync-action-utils.js +49 -0
  296. package/lib/Utils/sync-action-utils.js.map +1 -0
  297. package/lib/Utils/tc-token-utils.d.ts +37 -0
  298. package/lib/Utils/tc-token-utils.d.ts.map +1 -0
  299. package/lib/Utils/tc-token-utils.js +164 -0
  300. package/lib/Utils/tc-token-utils.js.map +1 -0
  301. package/lib/Utils/use-multi-file-auth-state.d.ts +13 -0
  302. package/lib/Utils/use-multi-file-auth-state.d.ts.map +1 -0
  303. package/lib/Utils/use-multi-file-auth-state.js +121 -0
  304. package/lib/Utils/use-multi-file-auth-state.js.map +1 -0
  305. package/lib/Utils/validate-connection.d.ts +11 -0
  306. package/lib/Utils/validate-connection.d.ts.map +1 -0
  307. package/lib/Utils/validate-connection.js +210 -0
  308. package/lib/Utils/validate-connection.js.map +1 -0
  309. package/lib/WABinary/constants.d.ts +28 -0
  310. package/lib/WABinary/constants.d.ts.map +1 -0
  311. package/lib/WABinary/constants.js +1301 -0
  312. package/lib/WABinary/constants.js.map +1 -0
  313. package/lib/WABinary/decode.d.ts +7 -0
  314. package/lib/WABinary/decode.d.ts.map +1 -0
  315. package/lib/WABinary/decode.js +262 -0
  316. package/lib/WABinary/decode.js.map +1 -0
  317. package/lib/WABinary/encode.d.ts +3 -0
  318. package/lib/WABinary/encode.d.ts.map +1 -0
  319. package/lib/WABinary/encode.js +220 -0
  320. package/lib/WABinary/encode.js.map +1 -0
  321. package/lib/WABinary/generic-utils.d.ts +15 -0
  322. package/lib/WABinary/generic-utils.d.ts.map +1 -0
  323. package/lib/WABinary/generic-utils.js +113 -0
  324. package/lib/WABinary/generic-utils.js.map +1 -0
  325. package/lib/WABinary/index.d.ts +6 -0
  326. package/lib/WABinary/index.d.ts.map +1 -0
  327. package/lib/WABinary/index.js +6 -0
  328. package/lib/WABinary/index.js.map +1 -0
  329. package/lib/WABinary/jid-utils.d.ts +48 -0
  330. package/lib/WABinary/jid-utils.d.ts.map +1 -0
  331. package/lib/WABinary/jid-utils.js +96 -0
  332. package/lib/WABinary/jid-utils.js.map +1 -0
  333. package/lib/WABinary/types.d.ts +19 -0
  334. package/lib/WABinary/types.d.ts.map +1 -0
  335. package/lib/WABinary/types.js +2 -0
  336. package/lib/WABinary/types.js.map +1 -0
  337. package/lib/WAM/BinaryInfo.d.ts +9 -0
  338. package/lib/WAM/BinaryInfo.d.ts.map +1 -0
  339. package/lib/WAM/BinaryInfo.js +10 -0
  340. package/lib/WAM/BinaryInfo.js.map +1 -0
  341. package/lib/WAM/constants.d.ts +40 -0
  342. package/lib/WAM/constants.d.ts.map +1 -0
  343. package/lib/WAM/constants.js +22853 -0
  344. package/lib/WAM/constants.js.map +1 -0
  345. package/lib/WAM/encode.d.ts +3 -0
  346. package/lib/WAM/encode.d.ts.map +1 -0
  347. package/lib/WAM/encode.js +150 -0
  348. package/lib/WAM/encode.js.map +1 -0
  349. package/lib/WAM/index.d.ts +4 -0
  350. package/lib/WAM/index.d.ts.map +1 -0
  351. package/lib/WAM/index.js +4 -0
  352. package/lib/WAM/index.js.map +1 -0
  353. package/lib/WAUSync/Protocols/USyncContactProtocol.d.ts +10 -0
  354. package/lib/WAUSync/Protocols/USyncContactProtocol.d.ts.map +1 -0
  355. package/lib/WAUSync/Protocols/USyncContactProtocol.js +52 -0
  356. package/lib/WAUSync/Protocols/USyncContactProtocol.js.map +1 -0
  357. package/lib/WAUSync/Protocols/USyncDeviceProtocol.d.ts +23 -0
  358. package/lib/WAUSync/Protocols/USyncDeviceProtocol.d.ts.map +1 -0
  359. package/lib/WAUSync/Protocols/USyncDeviceProtocol.js +54 -0
  360. package/lib/WAUSync/Protocols/USyncDeviceProtocol.js.map +1 -0
  361. package/lib/WAUSync/Protocols/USyncDisappearingModeProtocol.d.ts +13 -0
  362. package/lib/WAUSync/Protocols/USyncDisappearingModeProtocol.d.ts.map +1 -0
  363. package/lib/WAUSync/Protocols/USyncDisappearingModeProtocol.js +27 -0
  364. package/lib/WAUSync/Protocols/USyncDisappearingModeProtocol.js.map +1 -0
  365. package/lib/WAUSync/Protocols/USyncStatusProtocol.d.ts +13 -0
  366. package/lib/WAUSync/Protocols/USyncStatusProtocol.d.ts.map +1 -0
  367. package/lib/WAUSync/Protocols/USyncStatusProtocol.js +38 -0
  368. package/lib/WAUSync/Protocols/USyncStatusProtocol.js.map +1 -0
  369. package/lib/WAUSync/Protocols/USyncUsernameProtocol.d.ts +10 -0
  370. package/lib/WAUSync/Protocols/USyncUsernameProtocol.d.ts.map +1 -0
  371. package/lib/WAUSync/Protocols/USyncUsernameProtocol.js +25 -0
  372. package/lib/WAUSync/Protocols/USyncUsernameProtocol.js.map +1 -0
  373. package/lib/WAUSync/Protocols/UsyncBotProfileProtocol.d.ts +26 -0
  374. package/lib/WAUSync/Protocols/UsyncBotProfileProtocol.d.ts.map +1 -0
  375. package/lib/WAUSync/Protocols/UsyncBotProfileProtocol.js +51 -0
  376. package/lib/WAUSync/Protocols/UsyncBotProfileProtocol.js.map +1 -0
  377. package/lib/WAUSync/Protocols/UsyncLIDProtocol.d.ts +10 -0
  378. package/lib/WAUSync/Protocols/UsyncLIDProtocol.d.ts.map +1 -0
  379. package/lib/WAUSync/Protocols/UsyncLIDProtocol.js +29 -0
  380. package/lib/WAUSync/Protocols/UsyncLIDProtocol.js.map +1 -0
  381. package/lib/WAUSync/Protocols/index.d.ts +6 -0
  382. package/lib/WAUSync/Protocols/index.d.ts.map +1 -0
  383. package/lib/WAUSync/Protocols/index.js +6 -0
  384. package/lib/WAUSync/Protocols/index.js.map +1 -0
  385. package/lib/WAUSync/USyncQuery.d.ts +30 -0
  386. package/lib/WAUSync/USyncQuery.d.ts.map +1 -0
  387. package/lib/WAUSync/USyncQuery.js +98 -0
  388. package/lib/WAUSync/USyncQuery.js.map +1 -0
  389. package/lib/WAUSync/USyncUser.d.ts +17 -0
  390. package/lib/WAUSync/USyncUser.d.ts.map +1 -0
  391. package/lib/WAUSync/USyncUser.js +31 -0
  392. package/lib/WAUSync/USyncUser.js.map +1 -0
  393. package/lib/WAUSync/index.d.ts +4 -0
  394. package/lib/WAUSync/index.d.ts.map +1 -0
  395. package/lib/WAUSync/index.js +4 -0
  396. package/lib/WAUSync/index.js.map +1 -0
  397. package/lib/index.d.ts +12 -0
  398. package/lib/index.d.ts.map +1 -0
  399. package/lib/index.js +12 -0
  400. package/lib/index.js.map +1 -0
  401. package/media/example.mp4 +0 -0
  402. package/media/thumb-alya.jpg +0 -0
  403. package/media/thumb-alya2.jpg +0 -0
  404. package/package.json +161 -3
  405. package/src/airich.js +93 -0
  406. package/src/anti-call.js +20 -0
  407. package/src/anti-delete.js +37 -0
  408. package/src/auto-reply.js +68 -0
  409. package/src/biz.js +80 -0
  410. package/src/broadcast.js +17 -0
  411. package/src/buttons_sheet.js +20 -0
  412. package/src/carousel.js +54 -0
  413. package/src/code-snippet.js +64 -0
  414. package/src/cta_copy.js +12 -0
  415. package/src/cta_url.js +12 -0
  416. package/src/custom-pairing.js +24 -0
  417. package/src/fake-quoted.js +166 -0
  418. package/src/fixxed-pairing.js +24 -0
  419. package/src/g.us.js +41 -0
  420. package/src/index.js +27 -0
  421. package/src/komunitas.js +35 -0
  422. package/src/lid-jid.js +45 -0
  423. package/src/limited_time_offer.js +40 -0
  424. package/src/location.js +20 -0
  425. package/src/newletter.js +35 -0
  426. package/src/poll.js +24 -0
  427. package/src/presence.js +47 -0
  428. package/src/status-story.js +31 -0
  429. package/src/sticker.js +4 -0
  430. package/src/storeJSON.js +33 -0
  431. package/src/url.js +25 -0
  432. package/src/voip.js +166 -0
package/README.md CHANGED
@@ -1,3 +1,1651 @@
1
- # Temporary Holding Version
1
+ <div align="center">
2
+ <img src="./media/thumb-alya.jpg" alt="Alya Baileys Banner" width="100%" />
3
+ <h1>@vsxid/alya-baileys</h1>
4
+ </div>
2
5
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
6
+ <p align="center">
7
+ <img src="./media/thumb-alya2.jpg" alt="Alya Thumbnail" width="320" />
8
+ </p>
9
+
10
+ <video src="./media/example.mp4" controls="controls" style="max-width: 100%;"></video>
11
+
12
+ <h1 align='center'><img alt="Baileys logo" src="https://raw.githubusercontent.com/vsxid/alya-baileys/refs/heads/master/Media/logo.png" height="75"/></h1>
13
+
14
+ <div align='center'>Baileys is a WebSockets-based TypeScript library for interacting with the WhatsApp Web API.</div>
15
+
16
+
17
+ > [!CAUTION]
18
+ > NOTICE OF BREAKING CHANGE.
19
+ >
20
+ > As of 1.0.2, multiple breaking changes were introduced into the library.
21
+ >
22
+ > Please check out https://whiskey.so/migrate-latest for more information.
23
+
24
+ # Important Note
25
+ This is a temporary README.md, the new guide is in development and will this file will be replaced with .github/README.md (already a default on GitHub).
26
+
27
+ New guide link: https://baileys.wiki
28
+
29
+ # Get Support
30
+
31
+ If you'd like business to enterprise-level support from Rajeh, the current maintainer of Baileys, you can book a video chat. Book a 1 hour time slot by contacting him on Discord or pre-ordering [here](https://purpshell.dev/book). The earlier you pre-order the better, as his time slots usually fill up very quickly. He offers immense value per hour and will answer all your questions before the time runs out.
32
+
33
+ If you are a business, we encourage you to contribute back to the high development costs of the project and to feed the maintainers who dump tens of hours a week on this. You can do so by booking meetings or sponsoring below. All support, even in bona fide / contribution hours, is welcome by businesses of all sizes. This is not condoning or endorsing businesses to use the library. See the Disclaimer below.
34
+
35
+ # Sponsor
36
+ If you'd like to financially support this project, you can do so by supporting the current maintainer [here](https://purpshell.dev/sponsor).
37
+
38
+ # Disclaimer
39
+ This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
40
+ The official WhatsApp website can be found at whatsapp.com. "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
41
+
42
+ The maintainers of Baileys do not in any way condone the use of this application in practices that violate the Terms of Service of WhatsApp. The maintainers of this application call upon the personal responsibility of its users to use this application in a fair way, as it is intended to be used.
43
+ Use at your own discretion. Do not spam people with this. We discourage any stalkerware, bulk or automated messaging usage.
44
+
45
+ ##
46
+
47
+ - Baileys does not require Selenium or any other browser to be interface with WhatsApp Web, it does so directly using a **WebSocket**.
48
+ - Not running Selenium or Chromium saves you like **half a gig** of ram :/
49
+ - Baileys supports interacting with the multi-device & web versions of WhatsApp.
50
+ - Thank you to [@pokearaujo](https://github.com/pokearaujo/multidevice) for writing his observations on the workings of WhatsApp Multi-Device. Also, thank you to [@Sigalor](https://github.com/sigalor/whatsapp-web-reveng) for writing his observations on the workings of WhatsApp Web and thanks to [@Rhymen](https://github.com/Rhymen/go-whatsapp/) for the __go__ implementation.
51
+
52
+ > [!IMPORTANT]
53
+ > The original repository had to be removed by the original author - we now continue development in this repository here.
54
+ This is the only official repository and is maintained by the community.
55
+ > **Join the Discord [here](https://discord.gg/WeJM5FP9GG)**
56
+
57
+ ## Example
58
+
59
+ Do check out & run [example.ts](Example/example.ts) to see an example usage of the library.
60
+ The script covers most common use cases.
61
+ To run the example script, download or clone the repo and then type the following in a terminal:
62
+ 1. ``` cd path/to/Baileys ```
63
+ 2. ``` yarn ```
64
+ 3. ``` yarn example ```
65
+
66
+ ## Install
67
+
68
+ Use the stable version:
69
+ ```
70
+ yarn add @vsxid/alya-baileys
71
+ ```
72
+
73
+ Use the edge version (no guarantee of stability, but latest fixes + features)
74
+ ```
75
+ yarn add github:vsxid/alya-baileys
76
+ ```
77
+
78
+ Then import your code using:
79
+ ```ts
80
+ import makeWASocket from '@vsxid/alya-baileys'
81
+ ```
82
+
83
+ # Links
84
+
85
+ - [Discord](https://discord.gg/WeJM5FP9GG)
86
+ - [Docs](https://baileys.wiki/docs/intro/)
87
+
88
+ #index
89
+
90
+ - [Installation / Instalasi](#installation--instalasi)
91
+ - [Basic Connection & Custom Pairing / Koneksi Dasar & Custom Pairing](#basic-connection--custom-pairing--koneksi-dasar--custom-pairing)
92
+ - [Interactive Buttons & Thumbnail (`<biz>` Fix) / Tombol Interaktif & Thumbnail](#interactive-buttons--thumbnail-biz-fix--tombol-interaktif--thumbnail)
93
+ - [Carousel, Offer, Location & URL / Carousel, Promo, Lokasi & URL](#carousel-offer-location--url--carousel-promo-lokasi--url)
94
+ - [AI Rich Response & Code Snippets / Pesan AI & Kirim Kode](#ai-rich-response--code-snippets--pesan-ai--kirim-kode)
95
+ - [Group (`@g.us`), `@lid` Resolver, Community & Newsletter / Grup, `@lid`, Komunitas & Saluran](#group-gus-lid-resolver-community--newsletter--grup-lid-komunitas--saluran)
96
+ - [Auto-Reply, Presence, Poll, Broadcast & Store / Auto-Reply, Status, Polling, Broadcast & Store](#auto-reply-presence-poll-broadcast--store--auto-reply-status-polling-broadcast--store)
97
+ - [VoIP WebRTC Audio & Call Link / Panggilan Suara WebRTC & Call Link](#voip-webrtc-audio--call-link--panggilan-suara-webrtc--call-link)
98
+ - [Anti-Delete Message / Anti Hapus Pesan](#anti-delete-message--anti-hapus-pesan)
99
+ - [Auto View & React Story / Auto Lihat & React Status](#auto-view--react-story--auto-lihat--react-status)
100
+ - [Custom Fake Quoted Presets / Preset Fake Quoted Custom](#custom-fake-quoted-presets--preset-fake-quoted-custom)
101
+
102
+
103
+ - [Connecting Account](#connecting-account)
104
+ - [Connect with QR-CODE](#starting-socket-with-qr-code)
105
+ - [Connect with Pairing Code](#starting-socket-with-pairing-code)
106
+ - [Receive Full History](#receive-full-history)
107
+ - [Important Notes About Socket Config](#important-notes-about-socket-config)
108
+ - [Caching Group Metadata (Recommended)](#caching-group-metadata-recommended)
109
+ - [Improve Retry System & Decrypt Poll Votes](#improve-retry-system--decrypt-poll-votes)
110
+ - [Receive Notifications in Whatsapp App](#receive-notifications-in-whatsapp-app)
111
+
112
+ - [Save Auth Info](#saving--restoring-sessions)
113
+ - [Handling Events](#handling-events)
114
+ - [Example to Start](#example-to-start)
115
+ - [Decrypt Poll Votes](#decrypt-poll-votes)
116
+ - [Summary of Events on First Connection](#summary-of-events-on-first-connection)
117
+ - [Implementing a Data Store](#implementing-a-data-store)
118
+ - [Whatsapp IDs Explain](#whatsapp-ids-explain)
119
+ - [Utility Functions](#utility-functions)
120
+ - [Sending Messages](#sending-messages)
121
+ - [Non-Media Messages](#non-media-messages)
122
+ - [Text Message](#text-message)
123
+ - [Quote Message](#quote-message-works-with-all-types)
124
+ - [Mention User](#mention-user-works-with-most-types)
125
+ - [Forward Messages](#forward-messages)
126
+ - [Location Message](#location-message)
127
+ - [Contact Message](#contact-message)
128
+ - [Reaction Message](#reaction-message)
129
+ - [Pin Message](#pin-message)
130
+ - [Poll Message](#poll-message)
131
+ - [Sending with Link Preview](#sending-messages-with-link-previews)
132
+ - [Media Messages](#media-messages)
133
+ - [Gif Message](#gif-message)
134
+ - [Video Message](#video-message)
135
+ - [Audio Message](#audio-message)
136
+ - [Image Message](#image-message)
137
+ - [ViewOnce Message](#view-once-message)
138
+ - [Modify Messages](#modify-messages)
139
+ - [Delete Messages (for everyone)](#deleting-messages-for-everyone)
140
+ - [Edit Messages](#editing-messages)
141
+ - [Manipulating Media Messages](#manipulating-media-messages)
142
+ - [Thumbnail in Media Messages](#thumbnail-in-media-messages)
143
+ - [Downloading Media Messages](#downloading-media-messages)
144
+ - [Re-upload Media Message to Whatsapp](#re-upload-media-message-to-whatsapp)
145
+ - [Reject Call](#reject-call)
146
+ - [Send States in Chat](#send-states-in-chat)
147
+ - [Reading Messages](#reading-messages)
148
+ - [Update Presence](#update-presence)
149
+ - [Modifying Chats](#modifying-chats)
150
+ - [Archive a Chat](#archive-a-chat)
151
+ - [Mute/Unmute a Chat](#muteunmute-a-chat)
152
+ - [Mark a Chat Read/Unread](#mark-a-chat-readunread)
153
+ - [Delete a Message for Me](#delete-a-message-for-me)
154
+ - [Delete a Chat](#delete-a-chat)
155
+ - [Star/Unstar a Message](#starunstar-a-message)
156
+ - [Disappearing Messages](#disappearing-messages)
157
+ - [User Querys](#user-querys)
158
+ - [Check If ID Exists in Whatsapp](#check-if-id-exists-in-whatsapp)
159
+ - [Query Chat History (groups too)](#query-chat-history-groups-too)
160
+ - [Fetch Status](#fetch-status)
161
+ - [Fetch Profile Picture (groups too)](#fetch-profile-picture-groups-too)
162
+ - [Fetch Bussines Profile (such as description or category)](#fetch-bussines-profile-such-as-description-or-category)
163
+ - [Fetch Someone's Presence (if they're typing or online)](#fetch-someones-presence-if-theyre-typing-or-online)
164
+ - [Change Profile](#change-profile)
165
+ - [Change Profile Status](#change-profile-status)
166
+ - [Change Profile Name](#change-profile-name)
167
+ - [Change Display Picture (groups too)](#change-display-picture-groups-too)
168
+ - [Remove display picture (groups too)](#remove-display-picture-groups-too)
169
+ - [Groups](#groups)
170
+ - [Create a Group](#create-a-group)
171
+ - [Add/Remove or Demote/Promote](#addremove-or-demotepromote)
172
+ - [Change Subject (name)](#change-subject-name)
173
+ - [Change Description](#change-description)
174
+ - [Change Settings](#change-settings)
175
+ - [Leave a Group](#leave-a-group)
176
+ - [Get Invite Code](#get-invite-code)
177
+ - [Revoke Invite Code](#revoke-invite-code)
178
+ - [Join Using Invitation Code](#join-using-invitation-code)
179
+ - [Get Group Info by Invite Code](#get-group-info-by-invite-code)
180
+ - [Query Metadata (participants, name, description...)](#query-metadata-participants-name-description)
181
+ - [Join using groupInviteMessage](#join-using-groupinvitemessage)
182
+ - [Get Request Join List](#get-request-join-list)
183
+ - [Approve/Reject Request Join](#approvereject-request-join)
184
+ - [Get All Participating Groups Metadata](#get-all-participating-groups-metadata)
185
+ - [Toggle Ephemeral](#toggle-ephemeral)
186
+ - [Change Add Mode](#change-add-mode)
187
+ - [Privacy](#privacy)
188
+ - [Block/Unblock User](#blockunblock-user)
189
+ - [Get Privacy Settings](#get-privacy-settings)
190
+ - [Get BlockList](#get-blocklist)
191
+ - [Update LastSeen Privacy](#update-lastseen-privacy)
192
+ - [Update Online Privacy](#update-online-privacy)
193
+ - [Update Profile Picture Privacy](#update-profile-picture-privacy)
194
+ - [Update Status Privacy](#update-status-privacy)
195
+ - [Update Read Receipts Privacy](#update-read-receipts-privacy)
196
+ - [Update Groups Add Privacy](#update-groups-add-privacy)
197
+ - [Update Default Disappearing Mode](#update-default-disappearing-mode)
198
+ - [Broadcast Lists & Stories](#broadcast-lists--stories)
199
+ - [Send Broadcast & Stories](#send-broadcast--stories)
200
+ - [Query a Broadcast List's Recipients & Name](#query-a-broadcast-lists-recipients--name)
201
+ - [Writing Custom Functionality](#writing-custom-functionality)
202
+ - [Enabling Debug Level in Baileys Logs](#enabling-debug-level-in-baileys-logs)
203
+ - [How Whatsapp Communicate With Us](#how-whatsapp-communicate-with-us)
204
+ - [Register a Callback for Websocket Events](#register-a-callback-for-websocket-events)
205
+
206
+ ## Connecting Account
207
+
208
+ WhatsApp provides a multi-device API that allows Baileys to be authenticated as a second WhatsApp client by scanning a **QR code** or **Pairing Code** with WhatsApp on your phone.
209
+
210
+ > [!NOTE]
211
+ > **[Here](#example-to-start) is a simple example of event handling**
212
+
213
+ > [!TIP]
214
+ > **You can see all supported socket configs in the [SocketConfig type alias](https://baileys.wiki/docs/api/type-aliases/SocketConfig/) (Recommended)**
215
+
216
+ # @vsxid/alya-baileys
217
+
218
+ Modified WhatsApp Web API library based on Baileys with built-in `<biz>` node injection, `@lid` JID resolver, custom 8-digit pairing code, interactive buttons, carousel, AI rich response, code snippet sender, newsletter, community, and VoIP WebRTC support.
219
+
220
+ Library WhatsApp Web API modifikasi berbasis Baileys dengan injeksi node `<biz>`, resolver JID `@lid`, custom pairing code 8 digit, tombol interaktif, carousel, AI rich response, kirim snippet kode, saluran, komunitas, dan dukungan VoIP WebRTC.
221
+
222
+ ---
223
+
224
+ ## Installation / Instalasi
225
+
226
+ ```bash
227
+ npm install @vsxid/alya-baileys
228
+ ```
229
+
230
+ ---
231
+
232
+ ## Basic Connection & Custom Pairing / Koneksi Dasar & Custom Pairing
233
+
234
+ ```javascript
235
+ import makeWASocket, {
236
+ useMultiFileAuthState,
237
+ DisconnectReason,
238
+ requestFixedPairing
239
+ } from '@vsxid/alya-baileys';
240
+
241
+ async function startBot() {
242
+ const { state, saveCreds } = await useMultiFileAuthState('./session'); // session folder / folder sesi
243
+
244
+ const sock = makeWASocket({
245
+ auth: state,
246
+ printQRInTerminal: false, // false for pairing code / false untuk pairing code
247
+ browser: ['Ubuntu', 'Chrome', '20.0.04'] // OS: Ubuntu, Windows, macOS | Browser: Chrome, Edge, Firefox, Safari
248
+ });
249
+
250
+ if (!sock.authState.creds.registered) {
251
+ const code = await requestFixedPairing(sock, '628123456789', {
252
+ customCode: 'ALYABOT1', // exact 8 chars A-Z 0-9 / wajib 8 karakter huruf/angka
253
+ maxRetries: 3 // retry attempts / jumlah percobaan ulang
254
+ });
255
+ console.log('Pairing Code:', code);
256
+ }
257
+
258
+ sock.ev.on('creds.update', saveCreds);
259
+
260
+ sock.ev.on('connection.update', ({ connection, lastDisconnect }) => {
261
+ if (connection === 'close') {
262
+ const shouldReconnect = lastDisconnect?.error?.output?.statusCode !== DisconnectReason.loggedOut;
263
+ if (shouldReconnect) startBot();
264
+ } else if (connection === 'open') {
265
+ console.log('Connected / Terhubung!');
266
+ }
267
+ });
268
+ }
269
+
270
+ startBot();
271
+ ```
272
+
273
+ ---
274
+
275
+ ## Interactive Buttons & Thumbnail (`<biz>` Fix) / Tombol Interaktif & Thumbnail
276
+
277
+ ```javascript
278
+ import { sendBizMessage, sendButtonsSheet } from '@vsxid/alya-baileys';
279
+
280
+ await sendBizMessage(sock, jid, {
281
+ title: 'MAIN MENU',
282
+ text: 'Select an option below / Pilih menu di bawah:',
283
+ footer: '© Alya-Baileys',
284
+ buttons: [
285
+ { type: 'quick_reply', text: 'Ping', id: '.ping' }, // types: quick_reply, cta_url, cta_copy
286
+ { type: 'cta_url', text: 'GitHub', url: 'https://github.com' },
287
+ { type: 'cta_copy', text: 'Copy Token', copy: 'ALYA-2026' }
288
+ ],
289
+ contextInfo: {
290
+ externalAdReply: {
291
+ title: 'Alya Bot',
292
+ body: 'Fast & Lightweight',
293
+ mediaType: 1, // 1: image, 2: video
294
+ renderLargerThumbnail: true, // true: big banner, false: small square
295
+ thumbnailUrl: 'https://example.com',
296
+ sourceUrl: 'https://example.com'
297
+ }
298
+ }
299
+ });
300
+
301
+ await sendButtonsSheet(sock, jid, {
302
+ title: 'BOT FEATURES',
303
+ text: 'Open list / Buka daftar fitur',
304
+ buttonTitle: 'Select Menu', // bottom sheet button label / teks tombol list
305
+ sections: [
306
+ {
307
+ title: 'General',
308
+ rows: [
309
+ { title: 'Speed Test', description: 'Check latency', id: '.ping' },
310
+ { title: 'Owner Info', description: 'Contact dev', id: '.owner' }
311
+ ]
312
+ }
313
+ ]
314
+ });
315
+ ```
316
+
317
+ ---
318
+
319
+ ## Carousel, Offer, Location & URL / Carousel, Promo, Lokasi & URL
320
+
321
+ ```javascript
322
+ import {
323
+ sendCarousel,
324
+ sendLimitedOffer,
325
+ sendCustomLocation,
326
+ sendUrlPreview
327
+ } from '@vsxid/alya-baileys';
328
+
329
+ await sendCarousel(sock, jid, {
330
+ text: 'Featured Items / Produk Pilihan',
331
+ footer: 'Swipe left or right / Geser kanan atau kiri',
332
+ cards: [
333
+ {
334
+ title: 'Item 1',
335
+ subtitle: 'Promo',
336
+ body: 'Description 1',
337
+ image: 'https://example.com', // URL or Buffer / URL atau Buffer gambar
338
+ buttons: [{ type: 'quick_reply', text: 'Buy / Beli', id: '.buy1' }]
339
+ }
340
+ ]
341
+ });
342
+
343
+ await sendLimitedOffer(sock, jid, {
344
+ text: 'Claim your discount / Klaim diskon sekarang',
345
+ offerTitle: '50% OFF', // promo badge text / teks label promo
346
+ couponCode: 'ALYA50',
347
+ expirationTime: Date.now() + 86400000, // 24h in ms / durasi kadaluarsa ms
348
+ url: 'https://example.com',
349
+ buttonText: 'Claim / Klaim'
350
+ });
351
+
352
+ await sendCustomLocation(sock, jid, {
353
+ latitude: -7.2575,
354
+ longitude: 112.7521,
355
+ name: 'Surabaya, East Java',
356
+ address: 'Indonesia',
357
+ isLive: false // true: live location, false: static pin
358
+ });
359
+
360
+ await sendUrlPreview(sock, jid, {
361
+ text: 'Check this link / Cek tautan ini: https://example.com',
362
+ title: 'Example Title',
363
+ body: 'Short description',
364
+ thumbnailUrl: 'https://example.com',
365
+ sourceUrl: 'https://example.com',
366
+ largeThumbnail: true // true: large, false: small
367
+ });
368
+ ```
369
+
370
+ ---
371
+
372
+ ## AI Rich Response & Code Snippets / Pesan AI & Kirim Kode
373
+
374
+ ```javascript
375
+ import { sendAiRichMessage, sendCodeSnippet } from '@vsxid/alya-baileys';
376
+
377
+ await sendAiRichMessage(sock, jid, {
378
+ title: '✨ Alya AI',
379
+ text: 'Here is the function / Ini fungsinya:',
380
+ codeLanguage: 'javascript', // javascript, python, html, php, css, bash, json, cpp, java, sql
381
+ codeBlock: 'const greet = (name) => `Hello ${name}`;',
382
+ sources: ['https://nodejs.org']
383
+ });
384
+
385
+ await sendCodeSnippet(sock, jid, {
386
+ language: 'python', // html, js, py, php, css, json, sh, cpp, java, sql
387
+ caption: 'Python Script:',
388
+ code: 'print("Hello from Alya-Baileys!")',
389
+ sendAsFile: false, // true: send as .py/.html/.js document, false: chat + copy button
390
+ fileName: 'script.py'
391
+ });
392
+ ```
393
+
394
+ ---
395
+
396
+ ## Group (`@g.us`), `@lid` Resolver, Community & Newsletter / Grup, `@lid`, Komunitas & Saluran
397
+
398
+ ```javascript
399
+ import {
400
+ resolveJid,
401
+ isGroupAdmin,
402
+ sendHidetag,
403
+ sendTagall,
404
+ getCommunityInfo,
405
+ sendNewsletter,
406
+ reactNewsletter
407
+ } from '@vsxid/alya-baileys';
408
+
409
+ const realJid = resolveJid(senderLid, groupMetadata.participants); // @lid -> @s.whatsapp.net
410
+ const adminStatus = isGroupAdmin(senderLid, groupMetadata.participants); // true / false
411
+
412
+ await sendHidetag(sock, groupJid, 'Announcement / Pengumuman penting!', quotedMsg);
413
+ await sendTagall(sock, groupJid, '📢 *MENTION ALL*', quotedMsg);
414
+
415
+ const commInfo = await getCommunityInfo(sock, groupJid); // check parent/sub-group / cek info komunitas
416
+ await sendNewsletter(sock, '120363xxxx@newsletter', { text: 'Channel update!' });
417
+ await reactNewsletter(sock, '120363xxxx@newsletter', '102', '🔥'); // serverId, emoji
418
+ ```
419
+
420
+ ---
421
+
422
+ ## Auto-Reply, Presence, Poll, Broadcast & Store / Auto-Reply, Status, Polling, Broadcast & Store
423
+
424
+ ```javascript
425
+ import {
426
+ setupAutoReply,
427
+ setupAutoPresence,
428
+ sendPoll,
429
+ sendBroadcast,
430
+ createJsonStore,
431
+ enableAntiCall
432
+ } from '@vsxid/alya-baileys';
433
+
434
+ setupAutoReply(sock, [
435
+ { trigger: 'ping', exact: true, reply: 'Pong! 🚀' }, // exact: true (persis), false (mengandung kata)
436
+ { trigger: /^hi|halo/i, reply: 'Hello! / Halo!' } // support RegEx, string, or function
437
+ ], { onlyGroup: false, onlyPrivate: false, quoteMessage: true });
438
+
439
+ setupAutoPresence(sock, {
440
+ autoRead: true, // true: blue tick / centang biru otomatis
441
+ autoTyping: true, // true: typing / mengetik (false jika pakai autoRecording)
442
+ autoRecording: false, // true: recording audio / merekam suara
443
+ durationMs: 1500
444
+ });
445
+
446
+ enableAntiCall(sock, {
447
+ rejectMessage: 'No calls allowed / Bot tidak menerima telepon.',
448
+ blockCaller: false // true: auto block caller / blokir penelpon
449
+ });
450
+
451
+ await sendPoll(sock, jid, {
452
+ name: 'Vote:',
453
+ values: ['Option A', 'Option B'], // min 2, max 12 options
454
+ selectableCount: 1 // 1: single choice, >1: multiple choice
455
+ });
456
+
457
+ await sendBroadcast(sock, ['628111@s.whatsapp.net', '628222@s.whatsapp.net'], {
458
+ text: 'Info!'
459
+ }, { delayMs: 2000 }); // delay in ms to prevent ban / jeda aman anti-banned
460
+
461
+ const store = createJsonStore('./alya_store', 50); // folder path, max chat per JID
462
+ store.bind(sock.ev);
463
+ // store.clearTrash(); // delete all stored chats / hapus semua sampah chat
464
+ ```
465
+
466
+ ---
467
+
468
+ ## VoIP WebRTC Audio & Call Link / Panggilan Suara WebRTC & Call Link
469
+
470
+ ```javascript
471
+ import { createCallLink, sendVoipCall, streamAudioToCall, onVoipEvent } from '@vsxid/alya-baileys';
472
+
473
+ const link = await createCallLink(sock, false); // false: audio call, true: video call
474
+
475
+ const call = await sendVoipCall(sock, '628123456789@s.whatsapp.net', { isVideo: false });
476
+ streamAudioToCall(call.session, './audio.mp3'); // supports mp3, wav, ogg (requires ffmpeg)
477
+
478
+ onVoipEvent(sock, (event) => {
479
+ console.log(`Call from ${event.from} | Status: ${event.status}`); // status: offer, ringing, accept, reject, terminate
480
+ });
481
+ ```
482
+ #### Anti-Delete Message / Anti Hapus Pesan
483
+
484
+ ```javascript
485
+ import { enableAntiDelete } from '@vsxid/alya-baileys';
486
+
487
+ // Catch deleted/revoked messages / Tangkap pesan yang ditarik user
488
+ enableAntiDelete(sock, {
489
+ forwardTo: null, // null: origin chat, or '628xxx@s.whatsapp.net' / null: chat asal
490
+ customHeader: '🚨 *ANTI-DELETE DETECTED*'
491
+ });
492
+ ```
493
+
494
+ #### Auto View & React Story / Auto Lihat & React Status
495
+
496
+ ```javascript
497
+ import { enableAutoStory } from '@vsxid/alya-baileys';
498
+
499
+ // Auto view & react WhatsApp status / Auto nonton & react story WA
500
+ enableAutoStory(sock, {
501
+ autoRead: true, // true: view story, false: skip / lihat status
502
+ autoReact: true, // true: send emoji reaction / kirim reaksi emoji
503
+ emojis: ['🔥', '❤️', '👍', '😂'], // random emoji list / daftar emoji acak
504
+ ignoreJids: ['628111@s.whatsapp.net'] // excluded contacts / nomor yang dilewati
505
+ });
506
+ ```
507
+
508
+ #### Custom Fake Quoted Presets / Preset Fake Quoted Custom
509
+
510
+ ```javascript
511
+ import { fakeQuoted } from '@vsxid/alya-baileys';
512
+
513
+ const qVerified = fakeQuoted.verified('Official Bot', '0@s.whatsapp.net');
514
+ const qChannel = fakeQuoted.newsletter('Alya Channel', '120363xxxx@newsletter');
515
+ const qOrder = fakeQuoted.order('Alya Premium', 999);
516
+ const qStatus = fakeQuoted.fstatus({ name: 'ALYA-MD', thumb: thumbBuffer, id: 'ALYA-01' });
517
+ const qKontak = fakeQuoted.fkontak({ wm: 'Owner Bot', sender: m.sender, thumb: thumbBuffer });
518
+ const qVn = fakeQuoted.fvn({ seconds: '999999', ptt: true }); // ptt: true (voice note), false (audio)
519
+ const qText = fakeQuoted.ftextt({ wm: 'Alya-Baileys', title: 'Official', thumb: thumbBuffer });
520
+ const qGif = fakeQuoted.fgif({ wm: 'Alya Video', seconds: '999', thumb: thumbBuffer });
521
+ const qToko = fakeQuoted.ftoko({ wm: 'Alya Store', priceAmount1000: '20000000', retailerId: 'ALYA-SHOP', thumb: thumbBuffer });
522
+ const qDocs = fakeQuoted.fdocs({ wm: 'Document.pdf', thumb: thumbBuffer });
523
+ const qGc = fakeQuoted.fgclink({ groupJid: '628xxx@g.us', groupName: 'ALYA GROUP', wm: 'Join Now', thumb: thumbBuffer });
524
+
525
+ // Send message with custom fake quoted / Kirim pesan pakai fake quoted custom
526
+ await sock.sendMessage(jid, { text: 'Hello! / Halo!' }, { quoted: qToko });
527
+ ```
528
+
529
+
530
+
531
+ ### Starting socket with **QR-CODE**
532
+
533
+ > [!TIP]
534
+ > You can customize browser name if you connect with **QR-CODE**, with `Browser` constant, we have some browsers config, **see the [BrowsersMap type alias](https://baileys.wiki/docs/api/type-aliases/BrowsersMap/)**
535
+
536
+ ```ts
537
+ import makeWASocket from '@vsxid/alya-baileys'
538
+
539
+ const sock = makeWASocket({
540
+ // can provide additional config here
541
+ browser: Browsers.ubuntu('My App'),
542
+ printQRInTerminal: true
543
+ })
544
+ ```
545
+
546
+ If the connection is successful, you will see a QR code printed on your terminal screen, scan it with WhatsApp on your phone and you'll be logged in!
547
+
548
+ ### Starting socket with **Pairing Code**
549
+
550
+
551
+ > [!IMPORTANT]
552
+ > Pairing Code isn't Mobile API, it's a method to connect Whatsapp Web without QR-CODE, you can connect only with one device, see [here](https://faq.whatsapp.com/1324084875126592/?cms_platform=web)
553
+
554
+ The phone number can't have `+` or `()` or `-`, only numbers, you must provide country code
555
+
556
+ ```ts
557
+ import makeWASocket from '@vsxid/alya-baileys'
558
+
559
+ const sock = makeWASocket({
560
+ // can provide additional config here
561
+ printQRInTerminal: false //need to be false
562
+ })
563
+
564
+ if (!sock.authState.creds.registered) {
565
+ const number = 'XXXXXXXXXXX'
566
+ const code = await sock.requestPairingCode(number)
567
+ console.log(code)
568
+ }
569
+ ```
570
+
571
+ ### Receive Full History
572
+
573
+ 1. Set `syncFullHistory` as `true`
574
+ 2. Baileys, by default, use chrome browser config
575
+ - If you'd like to emulate a desktop connection (and receive more message history), this browser setting to your Socket config:
576
+
577
+ ```ts
578
+ const sock = makeWASocket({
579
+ ...otherOpts,
580
+ // can use Windows, Ubuntu here too
581
+ browser: Browsers.macOS('Desktop'),
582
+ syncFullHistory: true
583
+ })
584
+ ```
585
+
586
+ ## Important Notes About Socket Config
587
+
588
+ ### Caching Group Metadata (Recommended)
589
+ - If you use baileys for groups, we recommend you to set `cachedGroupMetadata` in socket config, you need to implement a cache like this:
590
+
591
+ ```ts
592
+ const groupCache = new NodeCache({stdTTL: 5 * 60, useClones: false})
593
+
594
+ const sock = makeWASocket({
595
+ cachedGroupMetadata: async (jid) => groupCache.get(jid)
596
+ })
597
+
598
+ sock.ev.on('groups.update', async ([event]) => {
599
+ const metadata = await sock.groupMetadata(event.id)
600
+ groupCache.set(event.id, metadata)
601
+ })
602
+
603
+ sock.ev.on('group-participants.update', async (event) => {
604
+ const metadata = await sock.groupMetadata(event.id)
605
+ groupCache.set(event.id, metadata)
606
+ })
607
+ ```
608
+
609
+ ### Improve Retry System & Decrypt Poll Votes
610
+ - If you want to improve sending message, retrying when error occurs and decrypt poll votes, you need to have a store and set `getMessage` config in socket like this:
611
+ ```ts
612
+ const sock = makeWASocket({
613
+ getMessage: async (key) => await getMessageFromStore(key)
614
+ })
615
+ ```
616
+
617
+ ### Receive Notifications in Whatsapp App
618
+ - If you want to receive notifications in whatsapp app, set `markOnlineOnConnect` to `false`
619
+ ```ts
620
+ const sock = makeWASocket({
621
+ markOnlineOnConnect: false
622
+ })
623
+ ```
624
+ ## Saving & Restoring Sessions
625
+
626
+ You obviously don't want to keep scanning the QR code every time you want to connect.
627
+
628
+ So, you can load the credentials to log back in:
629
+ ```ts
630
+ import makeWASocket, { useMultiFileAuthState } from '@vsxid/alya-baileys'
631
+
632
+ const { state, saveCreds } = await useMultiFileAuthState('auth_info_baileys')
633
+
634
+ // will use the given state to connect
635
+ // so if valid credentials are available -- it'll connect without QR
636
+ const sock = makeWASocket({ auth: state })
637
+
638
+ // this will be called as soon as the credentials are updated
639
+ sock.ev.on('creds.update', saveCreds)
640
+ ```
641
+
642
+ > [!IMPORTANT]
643
+ > `useMultiFileAuthState` is a utility function to help save the auth state in a single folder, this function serves as a good guide to help write auth & key states for SQL/no-SQL databases, which I would recommend in any production grade system.
644
+
645
+ > [!NOTE]
646
+ > When a message is received/sent, due to signal sessions needing updating, the auth keys (`authState.keys`) will update. Whenever that happens, you must save the updated keys (`authState.keys.set()` is called). Not doing so will prevent your messages from reaching the recipient & cause other unexpected consequences. The `useMultiFileAuthState` function automatically takes care of that, but for any other serious implementation -- you will need to be very careful with the key state management.
647
+
648
+ ## Handling Events
649
+
650
+ - Baileys uses the EventEmitter syntax for events.
651
+ They're all nicely typed up, so you shouldn't have any issues with an Intellisense editor like VS Code.
652
+
653
+ > [!IMPORTANT]
654
+ > **The events are in the [BaileysEventMap type alias](https://baileys.wiki/docs/api/type-aliases/BaileysEventMap/)**, it's important you see all events
655
+
656
+ You can listen to these events like this:
657
+ ```ts
658
+ const sock = makeWASocket()
659
+ sock.ev.on('messages.upsert', ({ messages }) => {
660
+ console.log('got messages', messages)
661
+ })
662
+ ```
663
+
664
+ ### Example to Start
665
+
666
+ > [!NOTE]
667
+ > This example includes basic auth storage too
668
+
669
+ > [!NOTE]
670
+ > For reliable serialization of the authentication state, especially when storing as JSON, always use the BufferJSON utility.
671
+
672
+ ```ts
673
+ import makeWASocket, { DisconnectReason, useMultiFileAuthState } from '@vsxid/alya-baileys'
674
+ import { Boom } from '@hapi/boom'
675
+
676
+ async function connectToWhatsApp () {
677
+ const { state, saveCreds } = await useMultiFileAuthState('auth_info_baileys')
678
+ const sock = makeWASocket({
679
+ // can provide additional config here
680
+ auth: state,
681
+ printQRInTerminal: true
682
+ })
683
+ sock.ev.on('connection.update', (update) => {
684
+ const { connection, lastDisconnect } = update
685
+ if(connection === 'close') {
686
+ const shouldReconnect = (lastDisconnect.error as Boom)?.output?.statusCode !== DisconnectReason.loggedOut
687
+ console.log('connection closed due to ', lastDisconnect.error, ', reconnecting ', shouldReconnect)
688
+ // reconnect if not logged out
689
+ if(shouldReconnect) {
690
+ connectToWhatsApp()
691
+ }
692
+ } else if(connection === 'open') {
693
+ console.log('opened connection')
694
+ }
695
+ })
696
+ sock.ev.on('messages.upsert', event => {
697
+ for (const m of event.messages) {
698
+ console.log(JSON.stringify(m, undefined, 2))
699
+
700
+ console.log('replying to', m.key.remoteJid)
701
+ await sock.sendMessage(m.key.remoteJid!, { text: 'Hello Word' })
702
+ }
703
+ })
704
+
705
+ // to storage creds (session info) when it updates
706
+ sock.ev.on('creds.update', saveCreds)
707
+ }
708
+ // run in main file
709
+ connectToWhatsApp()
710
+ ```
711
+
712
+ > [!IMPORTANT]
713
+ > In `messages.upsert` it's recommended to use a loop like `for (const message of event.messages)` to handle all messages in array
714
+
715
+ ### Decrypt Poll Votes
716
+
717
+ - By default poll votes are encrypted and handled in `messages.update`
718
+ - That's a simple example
719
+ ```ts
720
+ sock.ev.on('messages.update', event => {
721
+ for(const { key, update } of event) {
722
+ if(update.pollUpdates) {
723
+ const pollCreation = await getMessage(key)
724
+ if(pollCreation) {
725
+ console.log(
726
+ 'got poll update, aggregation: ',
727
+ getAggregateVotesInPollMessage({
728
+ message: pollCreation,
729
+ pollUpdates: update.pollUpdates,
730
+ })
731
+ )
732
+ }
733
+ }
734
+ }
735
+ })
736
+ ```
737
+
738
+ - `getMessage` is a [store](#implementing-a-data-store) implementation (in your end)
739
+
740
+ ### Summary of Events on First Connection
741
+
742
+ 1. When you connect first time, `connection.update` will be fired requesting you to restart sock
743
+ 2. Then, history messages will be received in `messaging.history-set`
744
+
745
+ ## Implementing a Data Store
746
+
747
+ - Baileys does not come with a defacto storage for chats, contacts, or messages. However, a simple in-memory implementation has been provided. The store listens for chat updates, new messages, message updates, etc., to always have an up-to-date version of the data.
748
+
749
+ > [!IMPORTANT]
750
+ > I highly recommend building your own data store, as storing someone's entire chat history in memory is a terrible waste of RAM.
751
+
752
+ It can be used as follows:
753
+
754
+ ```ts
755
+ import makeWASocket, { makeInMemoryStore } from '@vsxid/alya-baileys'
756
+ // the store maintains the data of the WA connection in memory
757
+ // can be written out to a file & read from it
758
+ const store = makeInMemoryStore({ })
759
+ // can be read from a file
760
+ store.readFromFile('./baileys_store.json')
761
+ // saves the state to a file every 10s
762
+ setInterval(() => {
763
+ store.writeToFile('./baileys_store.json')
764
+ }, 10_000)
765
+
766
+ const sock = makeWASocket({ })
767
+ // will listen from this socket
768
+ // the store can listen from a new socket once the current socket outlives its lifetime
769
+ store.bind(sock.ev)
770
+
771
+ sock.ev.on('chats.upsert', () => {
772
+ // can use 'store.chats' however you want, even after the socket dies out
773
+ // 'chats' => a KeyedDB instance
774
+ console.log('got chats', store.chats.all())
775
+ })
776
+
777
+ sock.ev.on('contacts.upsert', () => {
778
+ console.log('got contacts', Object.values(store.contacts))
779
+ })
780
+
781
+ ```
782
+
783
+ The store also provides some simple functions such as `loadMessages` that utilize the store to speed up data retrieval.
784
+
785
+ ## Whatsapp IDs Explain
786
+
787
+ - `id` is the WhatsApp ID, called `jid` too, of the person or group you're sending the message to.
788
+ - It must be in the format ```[country code][phone number]@s.whatsapp.net```
789
+ - Example for people: ```+19999999999@s.whatsapp.net```.
790
+ - For groups, it must be in the format ``` 123456789-123345@g.us ```.
791
+ - For broadcast lists, it's `[timestamp of creation]@broadcast`.
792
+ - For stories, the ID is `status@broadcast`.
793
+
794
+ ## Utility Functions
795
+
796
+ - `getContentType`, returns the content type for any message
797
+ - `getDevice`, returns the device from message
798
+ - `makeCacheableSignalKeyStore`, make auth store more fast
799
+ - `downloadContentFromMessage`, download content from any message
800
+
801
+ ## Sending Messages
802
+
803
+ - Send all types of messages with a single function
804
+ - **In the [AnyMessageContent type alias](https://baileys.wiki/docs/api/type-aliases/AnyMessageContent/) you can see all message contents supported, like text message**
805
+ - **In the [MiscMessageGenerationOptions type alias](https://baileys.wiki/docs/api/type-aliases/MiscMessageGenerationOptions/) you can see all options supported, like quote message**
806
+
807
+ ```ts
808
+ const jid: string
809
+ const content: AnyMessageContent
810
+ const options: MiscMessageGenerationOptions
811
+
812
+ sock.sendMessage(jid, content, options)
813
+ ```
814
+
815
+ ### Non-Media Messages
816
+
817
+ #### Text Message
818
+ ```ts
819
+ await sock.sendMessage(jid, { text: 'hello word' })
820
+ ```
821
+
822
+ #### Quote Message (works with all types)
823
+ ```ts
824
+ await sock.sendMessage(jid, { text: 'hello word' }, { quoted: message })
825
+ ```
826
+
827
+ #### Mention User (works with most types)
828
+ - @number is to mention in text, it's optional
829
+ ```ts
830
+ await sock.sendMessage(
831
+ jid,
832
+ {
833
+ text: '@12345678901',
834
+ mentions: ['12345678901@s.whatsapp.net']
835
+ }
836
+ )
837
+ ```
838
+
839
+ #### Forward Messages
840
+ - You need to have message object, can be retrieved from [store](#implementing-a-data-store) or use a [message](https://baileys.wiki/docs/api/type-aliases/WAMessage/) object
841
+ ```ts
842
+ const msg = getMessageFromStore() // implement this on your end
843
+ await sock.sendMessage(jid, { forward: msg }) // WA forward the message!
844
+ ```
845
+
846
+ #### Location Message
847
+ ```ts
848
+ await sock.sendMessage(
849
+ jid,
850
+ {
851
+ location: {
852
+ degreesLatitude: 24.121231,
853
+ degreesLongitude: 55.1121221
854
+ }
855
+ }
856
+ )
857
+ ```
858
+ #### Contact Message
859
+ ```ts
860
+ const vcard = 'BEGIN:VCARD\n' // metadata of the contact card
861
+ + 'VERSION:3.0\n'
862
+ + 'FN:Jeff Singh\n' // full name
863
+ + 'ORG:Ashoka Uni;\n' // the organization of the contact
864
+ + 'TEL;type=CELL;type=VOICE;waid=911234567890:+91 12345 67890\n' // WhatsApp ID + phone number
865
+ + 'END:VCARD'
866
+
867
+ await sock.sendMessage(
868
+ id,
869
+ {
870
+ contacts: {
871
+ displayName: 'Jeff',
872
+ contacts: [{ vcard }]
873
+ }
874
+ }
875
+ )
876
+ ```
877
+
878
+ #### Reaction Message
879
+ - You need to pass the key of message, you can retrieve from [store](#implementing-a-data-store) or use a [key](https://baileys.wiki/docs/api/type-aliases/WAMessageKey/) object
880
+ ```ts
881
+ await sock.sendMessage(
882
+ jid,
883
+ {
884
+ react: {
885
+ text: '💖', // use an empty string to remove the reaction
886
+ key: message.key
887
+ }
888
+ }
889
+ )
890
+ ```
891
+
892
+ #### Pin Message
893
+ - You need to pass the key of message, you can retrieve from [store](#implementing-a-data-store) or use a [key](https://baileys.wiki/docs/api/type-aliases/WAMessageKey/) object
894
+
895
+ - Time can be:
896
+
897
+ | Time | Seconds |
898
+ |-------|----------------|
899
+ | 24h | 86.400 |
900
+ | 7d | 604.800 |
901
+ | 30d | 2.592.000 |
902
+
903
+ ```ts
904
+ await sock.sendMessage(
905
+ jid,
906
+ {
907
+ pin: {
908
+ type: 1, // 0 to remove
909
+ time: 86400
910
+ key: message.key
911
+ }
912
+ }
913
+ )
914
+ ```
915
+
916
+ #### Poll Message
917
+ ```ts
918
+ await sock.sendMessage(
919
+ jid,
920
+ {
921
+ poll: {
922
+ name: 'My Poll',
923
+ values: ['Option 1', 'Option 2', ...],
924
+ selectableCount: 1,
925
+ toAnnouncementGroup: false // or true
926
+ }
927
+ }
928
+ )
929
+ ```
930
+
931
+ ### Sending Messages with Link Previews
932
+
933
+ 1. By default, wa does not have link generation when sent from the web
934
+ 2. Baileys has a function to generate the content for these link previews
935
+ 3. To enable this function's usage, add `link-preview-js` as a dependency to your project with `yarn add link-preview-js`
936
+ 4. Send a link:
937
+ ```ts
938
+ await sock.sendMessage(
939
+ jid,
940
+ {
941
+ text: 'Hi, this was sent using https://github.com/vsxid/alya-baileys'
942
+ }
943
+ )
944
+ ```
945
+
946
+ ### Media Messages
947
+
948
+ Sending media (video, stickers, images) is easier & more efficient than ever.
949
+
950
+ > [!NOTE]
951
+ > In media messages, you can pass `{ stream: Stream }` or `{ url: Url }` or `Buffer` directly, you can see more in the [WAMediaUpload type alias](https://baileys.wiki/docs/api/type-aliases/WAMediaUpload/)
952
+
953
+ - When specifying a media url, Baileys never loads the entire buffer into memory; it even encrypts the media as a readable stream.
954
+
955
+ > [!TIP]
956
+ > It's recommended to use Stream or Url to save memory
957
+
958
+ #### Gif Message
959
+ - Whatsapp doesn't support `.gif` files, that's why we send gifs as common `.mp4` video with `gifPlayback` flag
960
+ ```ts
961
+ await sock.sendMessage(
962
+ jid,
963
+ {
964
+ video: fs.readFileSync('Media/ma_gif.mp4'),
965
+ caption: 'hello word',
966
+ gifPlayback: true
967
+ }
968
+ )
969
+ ```
970
+
971
+ #### Video Message
972
+ ```ts
973
+ await sock.sendMessage(
974
+ id,
975
+ {
976
+ video: {
977
+ url: './Media/ma_gif.mp4'
978
+ },
979
+ caption: 'hello word',
980
+ ptv: false // if set to true, will send as a `video note`
981
+ }
982
+ )
983
+ ```
984
+
985
+ #### Audio Message
986
+ - To audio message work in all devices you need to convert with some tool like `ffmpeg` with this flags:
987
+ ```bash
988
+ codec: libopus //ogg file
989
+ ac: 1 //one channel
990
+ avoid_negative_ts
991
+ make_zero
992
+ ```
993
+ - Example:
994
+ ```bash
995
+ ffmpeg -i input.mp4 -avoid_negative_ts make_zero -ac 1 output.ogg
996
+ ```
997
+ ```ts
998
+ await sock.sendMessage(
999
+ jid,
1000
+ {
1001
+ audio: {
1002
+ url: './Media/audio.mp3'
1003
+ },
1004
+ mimetype: 'audio/mp4'
1005
+ }
1006
+ )
1007
+ ```
1008
+
1009
+ #### Image Message
1010
+ ```ts
1011
+ await sock.sendMessage(
1012
+ id,
1013
+ {
1014
+ image: {
1015
+ url: './Media/ma_img.png'
1016
+ },
1017
+ caption: 'hello word'
1018
+ }
1019
+ )
1020
+ ```
1021
+
1022
+ #### View Once Message
1023
+
1024
+ - You can send all messages above as `viewOnce`, you only need to pass `viewOnce: true` in content object
1025
+
1026
+ ```ts
1027
+ await sock.sendMessage(
1028
+ id,
1029
+ {
1030
+ image: {
1031
+ url: './Media/ma_img.png'
1032
+ },
1033
+ viewOnce: true, //works with video, audio too
1034
+ caption: 'hello word'
1035
+ }
1036
+ )
1037
+ ```
1038
+
1039
+ ## Modify Messages
1040
+
1041
+ ### Deleting Messages (for everyone)
1042
+
1043
+ ```ts
1044
+ const msg = await sock.sendMessage(jid, { text: 'hello word' })
1045
+ await sock.sendMessage(jid, { delete: msg.key })
1046
+ ```
1047
+
1048
+ **Note:** deleting for oneself is supported via `chatModify`, see in [this section](#modifying-chats)
1049
+
1050
+ ### Editing Messages
1051
+
1052
+ - You can pass all editable contents here
1053
+ ```ts
1054
+ await sock.sendMessage(jid, {
1055
+ text: 'updated text goes here',
1056
+ edit: response.key,
1057
+ });
1058
+ ```
1059
+
1060
+ ## Manipulating Media Messages
1061
+
1062
+ ### Thumbnail in Media Messages
1063
+ - For media messages, the thumbnail can be generated automatically for images & stickers provided you add `jimp` or `sharp` as a dependency in your project using `yarn add jimp` or `yarn add sharp`.
1064
+ - Thumbnails for videos can also be generated automatically, though, you need to have `ffmpeg` installed on your system.
1065
+
1066
+ ### Downloading Media Messages
1067
+
1068
+ If you want to save the media you received
1069
+ ```ts
1070
+ import { createWriteStream } from 'fs'
1071
+ import { downloadMediaMessage, getContentType } from '@vsxid/alya-baileys'
1072
+
1073
+ sock.ev.on('messages.upsert', async ({ [m] }) => {
1074
+ if (!m.message) return // if there is no text or media message
1075
+ const messageType = getContentType(m) // get what type of message it is (text, image, video...)
1076
+
1077
+ // if the message is an image
1078
+ if (messageType === 'imageMessage') {
1079
+ // download the message
1080
+ const stream = await downloadMediaMessage(
1081
+ m,
1082
+ 'stream', // can be 'buffer' too
1083
+ { },
1084
+ {
1085
+ logger,
1086
+ // pass this so that baileys can request a reupload of media
1087
+ // that has been deleted
1088
+ reuploadRequest: sock.updateMediaMessage
1089
+ }
1090
+ )
1091
+ // save to file
1092
+ const writeStream = createWriteStream('./my-download.jpeg')
1093
+ stream.pipe(writeStream)
1094
+ }
1095
+ }
1096
+ ```
1097
+
1098
+ ### Re-upload Media Message to Whatsapp
1099
+
1100
+ - WhatsApp automatically removes old media from their servers. For the device to access said media -- a re-upload is required by another device that has it. This can be accomplished using:
1101
+ ```ts
1102
+ await sock.updateMediaMessage(msg)
1103
+ ```
1104
+
1105
+ ## Reject Call
1106
+
1107
+ - You can obtain `callId` and `callFrom` from `call` event
1108
+
1109
+ ```ts
1110
+ await sock.rejectCall(callId, callFrom)
1111
+ ```
1112
+
1113
+ ## Send States in Chat
1114
+
1115
+ ### Reading Messages
1116
+ - A set of message [keys](https://baileys.wiki/docs/api/type-aliases/WAMessageKey/) must be explicitly marked read now.
1117
+ - You cannot mark an entire 'chat' read as it were with Baileys Web.
1118
+ This means you have to keep track of unread messages.
1119
+
1120
+ ```ts
1121
+ const key: WAMessageKey
1122
+ // can pass multiple keys to read multiple messages as well
1123
+ await sock.readMessages([key])
1124
+ ```
1125
+
1126
+ The message ID is the unique identifier of the message that you are marking as read.
1127
+ On a `WAMessage`, the `messageID` can be accessed using ```messageID = message.key.id```.
1128
+
1129
+ ### Update Presence
1130
+
1131
+ - ``` presence ``` can be one of the values in the [WAPresence type alias](https://baileys.wiki/docs/api/type-aliases/WAPresence/)
1132
+ - The presence expires after about 10 seconds.
1133
+ - This lets the person/group with `jid` know whether you're online, offline, typing etc.
1134
+
1135
+ ```ts
1136
+ await sock.sendPresenceUpdate('available', jid)
1137
+ ```
1138
+
1139
+ > [!NOTE]
1140
+ > If a desktop client is active, WA doesn't send push notifications to the device. If you would like to receive said notifications -- mark your Baileys client offline using `sock.sendPresenceUpdate('unavailable')`
1141
+
1142
+ ## Modifying Chats
1143
+
1144
+ WA uses an encrypted form of communication to send chat/app updates. This has been implemented mostly and you can send the following updates:
1145
+
1146
+ > [!IMPORTANT]
1147
+ > If you mess up one of your updates, WA can log you out of all your devices and you'll have to log in again.
1148
+
1149
+ ### Archive a Chat
1150
+ ```ts
1151
+ const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
1152
+ await sock.chatModify({ archive: true, lastMessages: [lastMsgInChat] }, jid)
1153
+ ```
1154
+ ### Mute/Unmute a Chat
1155
+
1156
+ - Supported times:
1157
+
1158
+ | Time | Miliseconds |
1159
+ |-------|-----------------|
1160
+ | Remove | null |
1161
+ | 8h | 86.400.000 |
1162
+ | 7d | 604.800.000 |
1163
+
1164
+ ```ts
1165
+ // mute for 8 hours
1166
+ await sock.chatModify({ mute: 8 * 60 * 60 * 1000 }, jid)
1167
+ // unmute
1168
+ await sock.chatModify({ mute: null }, jid)
1169
+ ```
1170
+ ### Mark a Chat Read/Unread
1171
+ ```ts
1172
+ const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
1173
+ // mark it unread
1174
+ await sock.chatModify({ markRead: false, lastMessages: [lastMsgInChat] }, jid)
1175
+ ```
1176
+
1177
+ ### Delete a Message for Me
1178
+ ```ts
1179
+ await sock.chatModify(
1180
+ {
1181
+ clear: {
1182
+ messages: [
1183
+ {
1184
+ id: 'ATWYHDNNWU81732J',
1185
+ fromMe: true,
1186
+ timestamp: '1654823909'
1187
+ }
1188
+ ]
1189
+ }
1190
+ },
1191
+ jid
1192
+ )
1193
+
1194
+ ```
1195
+ ### Delete a Chat
1196
+ ```ts
1197
+ const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
1198
+ await sock.chatModify({
1199
+ delete: true,
1200
+ lastMessages: [
1201
+ {
1202
+ key: lastMsgInChat.key,
1203
+ messageTimestamp: lastMsgInChat.messageTimestamp
1204
+ }
1205
+ ]
1206
+ },
1207
+ jid
1208
+ )
1209
+ ```
1210
+ ### Pin/Unpin a Chat
1211
+ ```ts
1212
+ await sock.chatModify({
1213
+ pin: true // or `false` to unpin
1214
+ },
1215
+ jid
1216
+ )
1217
+ ```
1218
+ ### Star/Unstar a Message
1219
+ ```ts
1220
+ await sock.chatModify({
1221
+ star: {
1222
+ messages: [
1223
+ {
1224
+ id: 'messageID',
1225
+ fromMe: true // or `false`
1226
+ }
1227
+ ],
1228
+ star: true // - true: Star Message; false: Unstar Message
1229
+ }
1230
+ },
1231
+ jid
1232
+ )
1233
+ ```
1234
+
1235
+ ### Disappearing Messages
1236
+
1237
+ - Ephemeral can be:
1238
+
1239
+ | Time | Seconds |
1240
+ |-------|----------------|
1241
+ | Remove | 0 |
1242
+ | 24h | 86.400 |
1243
+ | 7d | 604.800 |
1244
+ | 90d | 7.776.000 |
1245
+
1246
+ - You need to pass in **Seconds**, default is 7 days
1247
+
1248
+ ```ts
1249
+ // turn on disappearing messages
1250
+ await sock.sendMessage(
1251
+ jid,
1252
+ // this is 1 week in seconds -- how long you want messages to appear for
1253
+ { disappearingMessagesInChat: WA_DEFAULT_EPHEMERAL }
1254
+ )
1255
+
1256
+ // will send as a disappearing message
1257
+ await sock.sendMessage(jid, { text: 'hello' }, { ephemeralExpiration: WA_DEFAULT_EPHEMERAL })
1258
+
1259
+ // turn off disappearing messages
1260
+ await sock.sendMessage(
1261
+ jid,
1262
+ { disappearingMessagesInChat: false }
1263
+ )
1264
+ ```
1265
+
1266
+ ## User Querys
1267
+
1268
+ ### Check If ID Exists in Whatsapp
1269
+ ```ts
1270
+ const [result] = await sock.onWhatsApp(jid)
1271
+ if (result.exists) console.log (`${jid} exists on WhatsApp, as jid: ${result.jid}`)
1272
+ ```
1273
+
1274
+ ### Query Chat History (groups too)
1275
+
1276
+ - You need to have oldest message in chat
1277
+ ```ts
1278
+ const msg = await getOldestMessageInChat(jid) // implement this on your end
1279
+ await sock.fetchMessageHistory(
1280
+ 50, //quantity (max: 50 per query)
1281
+ msg.key,
1282
+ msg.messageTimestamp
1283
+ )
1284
+ ```
1285
+ - Messages will be received in `messaging.history-set` event
1286
+
1287
+ ### Fetch Status
1288
+ ```ts
1289
+ const status = await sock.fetchStatus(jid)
1290
+ console.log('status: ' + status)
1291
+ ```
1292
+
1293
+ ### Fetch Profile Picture (groups too)
1294
+ - To get the display picture of some person/group
1295
+ ```ts
1296
+ // for low res picture
1297
+ const ppUrl = await sock.profilePictureUrl(jid)
1298
+ console.log(ppUrl)
1299
+
1300
+ // for high res picture
1301
+ const ppUrl = await sock.profilePictureUrl(jid, 'image')
1302
+ ```
1303
+
1304
+ ### Fetch Bussines Profile (such as description or category)
1305
+ ```ts
1306
+ const profile = await sock.getBusinessProfile(jid)
1307
+ console.log('business description: ' + profile.description + ', category: ' + profile.category)
1308
+ ```
1309
+
1310
+ ### Fetch Someone's Presence (if they're typing or online)
1311
+ ```ts
1312
+ // the presence update is fetched and called here
1313
+ sock.ev.on('presence.update', console.log)
1314
+
1315
+ // request updates for a chat
1316
+ await sock.presenceSubscribe(jid)
1317
+ ```
1318
+
1319
+ ## Change Profile
1320
+
1321
+ ### Change Profile Status
1322
+ ```ts
1323
+ await sock.updateProfileStatus('Hello World!')
1324
+ ```
1325
+ ### Change Profile Name
1326
+ ```ts
1327
+ await sock.updateProfileName('My name')
1328
+ ```
1329
+ ### Change Display Picture (groups too)
1330
+ - To change your display picture or a group's
1331
+
1332
+ > [!NOTE]
1333
+ > Like media messages, you can pass `{ stream: Stream }` or `{ url: Url }` or `Buffer` directly, you can see more in the [WAMediaUpload type alias](https://baileys.wiki/docs/api/type-aliases/WAMediaUpload/)
1334
+
1335
+ ```ts
1336
+ await sock.updateProfilePicture(jid, { url: './new-profile-picture.jpeg' })
1337
+ ```
1338
+ ### Remove display picture (groups too)
1339
+ ```ts
1340
+ await sock.removeProfilePicture(jid)
1341
+ ```
1342
+
1343
+ ## Groups
1344
+
1345
+ - To change group properties you need to be admin
1346
+
1347
+ ### Create a Group
1348
+ ```ts
1349
+ // title & participants
1350
+ const group = await sock.groupCreate('My Fab Group', ['1234@s.whatsapp.net', '4564@s.whatsapp.net'])
1351
+ console.log('created group with id: ' + group.gid)
1352
+ await sock.sendMessage(group.id, { text: 'hello there' }) // say hello to everyone on the group
1353
+ ```
1354
+ ### Add/Remove or Demote/Promote
1355
+ ```ts
1356
+ // id & people to add to the group (will throw error if it fails)
1357
+ await sock.groupParticipantsUpdate(
1358
+ jid,
1359
+ ['abcd@s.whatsapp.net', 'efgh@s.whatsapp.net'],
1360
+ 'add' // replace this parameter with 'remove' or 'demote' or 'promote'
1361
+ )
1362
+ ```
1363
+ ### Change Subject (name)
1364
+ ```ts
1365
+ await sock.groupUpdateSubject(jid, 'New Subject!')
1366
+ ```
1367
+ ### Change Description
1368
+ ```ts
1369
+ await sock.groupUpdateDescription(jid, 'New Description!')
1370
+ ```
1371
+ ### Change Settings
1372
+ ```ts
1373
+ // only allow admins to send messages
1374
+ await sock.groupSettingUpdate(jid, 'announcement')
1375
+ // allow everyone to send messages
1376
+ await sock.groupSettingUpdate(jid, 'not_announcement')
1377
+ // allow everyone to modify the group's settings -- like display picture etc.
1378
+ await sock.groupSettingUpdate(jid, 'unlocked')
1379
+ // only allow admins to modify the group's settings
1380
+ await sock.groupSettingUpdate(jid, 'locked')
1381
+ ```
1382
+ ### Leave a Group
1383
+ ```ts
1384
+ // will throw error if it fails
1385
+ await sock.groupLeave(jid)
1386
+ ```
1387
+ ### Get Invite Code
1388
+ - To create link with code use `'https://chat.whatsapp.com/' + code`
1389
+ ```ts
1390
+ const code = await sock.groupInviteCode(jid)
1391
+ console.log('group code: ' + code)
1392
+ ```
1393
+ ### Revoke Invite Code
1394
+ ```ts
1395
+ const code = await sock.groupRevokeInvite(jid)
1396
+ console.log('New group code: ' + code)
1397
+ ```
1398
+ ### Join Using Invitation Code
1399
+ - Code can't have `https://chat.whatsapp.com/`, only code
1400
+ ```ts
1401
+ const response = await sock.groupAcceptInvite(code)
1402
+ console.log('joined to: ' + response)
1403
+ ```
1404
+ ### Get Group Info by Invite Code
1405
+ ```ts
1406
+ const response = await sock.groupGetInviteInfo(code)
1407
+ console.log('group information: ' + response)
1408
+ ```
1409
+ ### Query Metadata (participants, name, description...)
1410
+ ```ts
1411
+ const metadata = await sock.groupMetadata(jid)
1412
+ console.log(metadata.id + ', title: ' + metadata.subject + ', description: ' + metadata.desc)
1413
+ ```
1414
+ ### Join using `groupInviteMessage`
1415
+ ```ts
1416
+ const response = await sock.groupAcceptInviteV4(jid, groupInviteMessage)
1417
+ console.log('joined to: ' + response)
1418
+ ```
1419
+ ### Get Request Join List
1420
+ ```ts
1421
+ const response = await sock.groupRequestParticipantsList(jid)
1422
+ console.log(response)
1423
+ ```
1424
+ ### Approve/Reject Request Join
1425
+ ```ts
1426
+ const response = await sock.groupRequestParticipantsUpdate(
1427
+ jid, // group id
1428
+ ['abcd@s.whatsapp.net', 'efgh@s.whatsapp.net'],
1429
+ 'approve' // or 'reject'
1430
+ )
1431
+ console.log(response)
1432
+ ```
1433
+ ### Get All Participating Groups Metadata
1434
+ ```ts
1435
+ const response = await sock.groupFetchAllParticipating()
1436
+ console.log(response)
1437
+ ```
1438
+ ### Toggle Ephemeral
1439
+
1440
+ - Ephemeral can be:
1441
+
1442
+ | Time | Seconds |
1443
+ |-------|----------------|
1444
+ | Remove | 0 |
1445
+ | 24h | 86.400 |
1446
+ | 7d | 604.800 |
1447
+ | 90d | 7.776.000 |
1448
+
1449
+ ```ts
1450
+ await sock.groupToggleEphemeral(jid, 86400)
1451
+ ```
1452
+
1453
+ ### Change Add Mode
1454
+ ```ts
1455
+ await sock.groupMemberAddMode(
1456
+ jid,
1457
+ 'all_member_add' // or 'admin_add'
1458
+ )
1459
+ ```
1460
+
1461
+ ## Privacy
1462
+
1463
+ ### Block/Unblock User
1464
+ ```ts
1465
+ await sock.updateBlockStatus(jid, 'block') // Block user
1466
+ await sock.updateBlockStatus(jid, 'unblock') // Unblock user
1467
+ ```
1468
+ ### Get Privacy Settings
1469
+ ```ts
1470
+ const privacySettings = await sock.fetchPrivacySettings(true)
1471
+ console.log('privacy settings: ' + privacySettings)
1472
+ ```
1473
+ ### Get BlockList
1474
+ ```ts
1475
+ const response = await sock.fetchBlocklist()
1476
+ console.log(response)
1477
+ ```
1478
+ ### Update LastSeen Privacy
1479
+ ```ts
1480
+ const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
1481
+ await sock.updateLastSeenPrivacy(value)
1482
+ ```
1483
+ ### Update Online Privacy
1484
+ ```ts
1485
+ const value = 'all' // 'match_last_seen'
1486
+ await sock.updateOnlinePrivacy(value)
1487
+ ```
1488
+ ### Update Profile Picture Privacy
1489
+ ```ts
1490
+ const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
1491
+ await sock.updateProfilePicturePrivacy(value)
1492
+ ```
1493
+ ### Update Status Privacy
1494
+ ```ts
1495
+ const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
1496
+ await sock.updateStatusPrivacy(value)
1497
+ ```
1498
+ ### Update Read Receipts Privacy
1499
+ ```ts
1500
+ const value = 'all' // 'none'
1501
+ await sock.updateReadReceiptsPrivacy(value)
1502
+ ```
1503
+ ### Update Groups Add Privacy
1504
+ ```ts
1505
+ const value = 'all' // 'contacts' | 'contact_blacklist'
1506
+ await sock.updateGroupsAddPrivacy(value)
1507
+ ```
1508
+ ### Update Default Disappearing Mode
1509
+
1510
+ - Like [this](#disappearing-messages), ephemeral can be:
1511
+
1512
+ | Time | Seconds |
1513
+ |-------|----------------|
1514
+ | Remove | 0 |
1515
+ | 24h | 86.400 |
1516
+ | 7d | 604.800 |
1517
+ | 90d | 7.776.000 |
1518
+
1519
+ ```ts
1520
+ const ephemeral = 86400
1521
+ await sock.updateDefaultDisappearingMode(ephemeral)
1522
+ ```
1523
+
1524
+ ## Broadcast Lists & Stories
1525
+
1526
+ ### Send Broadcast & Stories
1527
+ - Messages can be sent to broadcasts & stories. You need to add the following message options in sendMessage, like this:
1528
+ ```ts
1529
+ await sock.sendMessage(
1530
+ jid,
1531
+ {
1532
+ image: {
1533
+ url: url
1534
+ },
1535
+ caption: caption
1536
+ },
1537
+ {
1538
+ backgroundColor: backgroundColor,
1539
+ font: font,
1540
+ statusJidList: statusJidList,
1541
+ broadcast: true
1542
+ }
1543
+ )
1544
+ ```
1545
+ - Message body can be a `extendedTextMessage` or `imageMessage` or `videoMessage` or `voiceMessage`, see the [AnyRegularMessageContent type alias](https://baileys.wiki/docs/api/type-aliases/AnyRegularMessageContent/)
1546
+ - You can add `backgroundColor` and other options in the message options, see the [MiscMessageGenerationOptions type alias](https://baileys.wiki/docs/api/type-aliases/MiscMessageGenerationOptions/)
1547
+ - `broadcast: true` enables broadcast mode
1548
+ - `statusJidList`: a list of people that you can get which you need to provide, which are the people who will get this status message.
1549
+
1550
+ - You can send messages to broadcast lists the same way you send messages to groups & individual chats.
1551
+ - Right now, WA Web does not support creating broadcast lists, but you can still delete them.
1552
+ - Broadcast IDs are in the format `12345678@broadcast`
1553
+ ### Query a Broadcast List's Recipients & Name
1554
+ ```ts
1555
+ const bList = await sock.getBroadcastListInfo('1234@broadcast')
1556
+ console.log (`list name: ${bList.name}, recps: ${bList.recipients}`)
1557
+ ```
1558
+
1559
+ ## Writing Custom Functionality
1560
+ Baileys is written with custom functionality in mind. Instead of forking the project & re-writing the internals, you can simply write your own extensions.
1561
+
1562
+ ### Enabling Debug Level in Baileys Logs
1563
+ First, enable the logging of unhandled messages from WhatsApp by setting:
1564
+ ```ts
1565
+ const sock = makeWASocket({
1566
+ logger: P({ level: 'debug' }),
1567
+ })
1568
+ ```
1569
+ This will enable you to see all sorts of messages WhatsApp sends in the console.
1570
+
1571
+ ### How Whatsapp Communicate With Us
1572
+
1573
+ > [!TIP]
1574
+ > If you want to learn whatsapp protocol, we recommend to study about Libsignal Protocol and Noise Protocol
1575
+
1576
+ - **Example:** Functionality to track the battery percentage of your phone. You enable logging and you'll see a message about your battery pop up in the console:
1577
+ ```
1578
+ {
1579
+ "level": 10,
1580
+ "fromMe": false,
1581
+ "frame": {
1582
+ "tag": "ib",
1583
+ "attrs": {
1584
+ "from": "@s.whatsapp.net"
1585
+ },
1586
+ "content": [
1587
+ {
1588
+ "tag": "edge_routing",
1589
+ "attrs": {},
1590
+ "content": [
1591
+ {
1592
+ "tag": "routing_info",
1593
+ "attrs": {},
1594
+ "content": {
1595
+ "type": "Buffer",
1596
+ "data": [8,2,8,5]
1597
+ }
1598
+ }
1599
+ ]
1600
+ }
1601
+ ]
1602
+ },
1603
+ "msg":"communication"
1604
+ }
1605
+ ```
1606
+
1607
+ The `'frame'` is what the message received is, it has three components:
1608
+ - `tag` -- what this frame is about (eg. message will have 'message')
1609
+ - `attrs` -- a string key-value pair with some metadata (contains ID of the message usually)
1610
+ - `content` -- the actual data (eg. a message node will have the actual message content in it)
1611
+ - read more about this format [here](/src/WABinary/readme.md)
1612
+
1613
+ ### Register a Callback for Websocket Events
1614
+
1615
+ > [!TIP]
1616
+ > Recommended to see `onMessageReceived` function in `socket.ts` file to understand how websockets events are fired
1617
+
1618
+ ```ts
1619
+ // for any message with tag 'edge_routing'
1620
+ sock.ws.on('CB:edge_routing', (node: BinaryNode) => { })
1621
+
1622
+ // for any message with tag 'edge_routing' and id attribute = abcd
1623
+ sock.ws.on('CB:edge_routing,id:abcd', (node: BinaryNode) => { })
1624
+
1625
+ // for any message with tag 'edge_routing', id attribute = abcd & first content node routing_info
1626
+ sock.ws.on('CB:edge_routing,id:abcd,routing_info', (node: BinaryNode) => { })
1627
+ ```
1628
+
1629
+ # License
1630
+ Copyright (c) 2025 Rajeh Taher/WhiskeySockets/alya/baileys
1631
+
1632
+ Licensed under the MIT License:
1633
+ Permission is hereby granted, free of charge, to any person obtaining a copy
1634
+ of this software and associated documentation files (the "Software"), to deal
1635
+ in the Software without restriction, including without limitation the rights
1636
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
1637
+ copies of the Software, and to permit persons to whom the Software is
1638
+ furnished to do so, subject to the following conditions:
1639
+
1640
+ The above copyright notice and this permission notice shall be included in all
1641
+ copies or substantial portions of the Software.
1642
+
1643
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1644
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
1645
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1646
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1647
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
1648
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1649
+ SOFTWARE.
1650
+
1651
+ Thus, the maintainers of the project can't be held liable for any potential misuse of this project.