@wppconnect/wa-js 3.23.1 → 4.0.2-alpha.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 (266) hide show
  1. package/CHANGELOG.md +1 -9
  2. package/dist/blocklist/functions/all.d.ts +3 -2
  3. package/dist/blocklist/functions/blockContact.d.ts +12 -3
  4. package/dist/blocklist/functions/index.d.ts +4 -4
  5. package/dist/blocklist/functions/isBlocked.d.ts +9 -3
  6. package/dist/blocklist/functions/unblockContact.d.ts +12 -3
  7. package/dist/call/functions/accept.d.ts +13 -6
  8. package/dist/call/functions/enableCallInterface.d.ts +3 -2
  9. package/dist/call/functions/end.d.ts +11 -4
  10. package/dist/call/functions/index.d.ts +6 -6
  11. package/dist/call/functions/offer.d.ts +13 -8
  12. package/dist/call/functions/parseRelayResponse.d.ts +9 -2
  13. package/dist/call/functions/prepareDestination.d.ts +10 -2
  14. package/dist/call/functions/reject.d.ts +11 -4
  15. package/dist/cart/functions/add.d.ts +29 -5
  16. package/dist/cart/functions/clear.d.ts +19 -2
  17. package/dist/cart/functions/get.d.ts +12 -5
  18. package/dist/cart/functions/getThumbFromCart.d.ts +19 -2
  19. package/dist/cart/functions/index.d.ts +7 -7
  20. package/dist/cart/functions/remove.d.ts +23 -2
  21. package/dist/cart/functions/submit.d.ts +40 -3
  22. package/dist/cart/functions/update.d.ts +25 -4
  23. package/dist/catalog/functions/addProductImage.d.ts +15 -6
  24. package/dist/catalog/functions/changeProductImage.d.ts +15 -6
  25. package/dist/catalog/functions/createCollection.d.ts +16 -5
  26. package/dist/catalog/functions/createProduct.d.ts +25 -25
  27. package/dist/catalog/functions/deleteCollection.d.ts +12 -5
  28. package/dist/catalog/functions/deleteProduct.d.ts +17 -9
  29. package/dist/catalog/functions/editCollection.d.ts +19 -10
  30. package/dist/catalog/functions/editProduct.d.ts +23 -15
  31. package/dist/catalog/functions/getCollections.d.ts +12 -3
  32. package/dist/catalog/functions/getMyCatalog.d.ts +4 -2
  33. package/dist/catalog/functions/getProductById.d.ts +24 -14
  34. package/dist/catalog/functions/getProducts.d.ts +16 -6
  35. package/dist/catalog/functions/index.d.ts +16 -16
  36. package/dist/catalog/functions/removeProductImage.d.ts +16 -7
  37. package/dist/catalog/functions/setProductVisibility.d.ts +18 -9
  38. package/dist/catalog/functions/updateCartEnabled.d.ts +16 -9
  39. package/dist/chat/functions/archive.d.ts +15 -20
  40. package/dist/chat/functions/canMarkPlayed.d.ts +9 -4
  41. package/dist/chat/functions/canMute.d.ts +9 -3
  42. package/dist/chat/functions/canReply.d.ts +9 -4
  43. package/dist/chat/functions/clear.d.ts +13 -5
  44. package/dist/chat/functions/closeChat.d.ts +3 -2
  45. package/dist/chat/functions/delete.d.ts +10 -4
  46. package/dist/chat/functions/{deleteMessage.d.ts → deleteMessages.d.ts} +15 -6
  47. package/dist/chat/functions/downloadMedia.d.ts +10 -3
  48. package/dist/chat/functions/editMessage.d.ts +33 -6
  49. package/dist/chat/functions/find.d.ts +9 -2
  50. package/dist/chat/functions/forwardMessage.d.ts +14 -7
  51. package/dist/chat/functions/forwardMessages.d.ts +15 -8
  52. package/dist/chat/functions/generateMessageID.d.ts +9 -2
  53. package/dist/chat/functions/get.d.ts +9 -2
  54. package/dist/chat/functions/getActiveChat.d.ts +4 -2
  55. package/dist/chat/functions/getLastSeen.d.ts +8 -2
  56. package/dist/chat/functions/getMessageACK.d.ts +18 -11
  57. package/dist/chat/functions/getMessageById.d.ts +12 -10
  58. package/dist/chat/functions/getMessages.d.ts +33 -53
  59. package/dist/chat/functions/getNotes.d.ts +9 -2
  60. package/dist/chat/functions/getPlatformFromMessage.d.ts +8 -3
  61. package/dist/chat/functions/getQuotedMsg.d.ts +9 -2
  62. package/dist/chat/functions/getQuotedMsgKey.d.ts +9 -2
  63. package/dist/chat/functions/getReactions.d.ts +17 -10
  64. package/dist/chat/functions/getUnreadChats.d.ts +8 -1
  65. package/dist/chat/functions/getVotes.d.ts +17 -10
  66. package/dist/chat/functions/index.d.ts +66 -65
  67. package/dist/chat/functions/keepMessage.d.ts +12 -4
  68. package/dist/chat/functions/list.d.ts +33 -33
  69. package/dist/chat/functions/markIsComposing.d.ts +9 -2
  70. package/dist/chat/functions/markIsPaused.d.ts +8 -2
  71. package/dist/chat/functions/markIsRead.d.ts +10 -5
  72. package/dist/chat/functions/markIsRecording.d.ts +9 -2
  73. package/dist/chat/functions/markIsUnread.d.ts +8 -4
  74. package/dist/chat/functions/markPlayed.d.ts +9 -4
  75. package/dist/chat/functions/mute.d.ts +13 -9
  76. package/dist/chat/functions/openChatAt.d.ts +11 -3
  77. package/dist/chat/functions/openChatBottom.d.ts +9 -2
  78. package/dist/chat/functions/openChatFromUnread.d.ts +9 -2
  79. package/dist/chat/functions/pin.d.ts +18 -20
  80. package/dist/chat/functions/pinMsg.d.ts +16 -11
  81. package/dist/chat/functions/prepareAudioWaveform.d.ts +30 -5
  82. package/dist/chat/functions/prepareLinkPreview.d.ts +31 -31
  83. package/dist/chat/functions/prepareMessageButtons.d.ts +41 -1
  84. package/dist/chat/functions/prepareRawMessage.d.ts +22 -3
  85. package/dist/chat/functions/replyToButtonMessage.d.ts +12 -1
  86. package/dist/chat/functions/requestPhoneNumber.d.ts +10 -3
  87. package/dist/chat/functions/sendCatalogMessage.d.ts +34 -12
  88. package/dist/chat/functions/sendChargeMessage.d.ts +65 -25
  89. package/dist/chat/functions/sendCreatePollMessage.d.ts +35 -18
  90. package/dist/chat/functions/sendEventMessage.d.ts +62 -22
  91. package/dist/chat/functions/sendFileMessage.d.ts +10 -2
  92. package/dist/chat/functions/sendGroupInviteMessage.d.ts +39 -16
  93. package/dist/chat/functions/sendListMessage.d.ts +50 -17
  94. package/dist/chat/functions/sendLocationMessage.d.ts +52 -48
  95. package/dist/chat/functions/sendPixKeyMessage.d.ts +26 -10
  96. package/dist/chat/functions/sendRawMessage.d.ts +22 -2
  97. package/dist/chat/functions/sendReactionToMessage.d.ts +13 -7
  98. package/dist/chat/functions/sendScheduledCallMessage.d.ts +17 -6
  99. package/dist/chat/functions/sendTextMessage.d.ts +11 -28
  100. package/dist/chat/functions/sendVCardContactMessage.d.ts +44 -19
  101. package/dist/chat/functions/setChatList.d.ts +10 -2
  102. package/dist/chat/functions/setInputText.d.ts +10 -3
  103. package/dist/chat/functions/setNotes.d.ts +10 -2
  104. package/dist/chat/functions/starMessage.d.ts +13 -16
  105. package/dist/chat/functions/unmute.d.ts +8 -2
  106. package/dist/chat/types.d.ts +13 -101
  107. package/dist/community/functions/addSubgroups.d.ts +21 -11
  108. package/dist/community/functions/create.d.ts +16 -4
  109. package/dist/community/functions/deactivate.d.ts +10 -4
  110. package/dist/community/functions/demoteParticipants.d.ts +14 -4
  111. package/dist/community/functions/getAnnouncementGroup.d.ts +11 -3
  112. package/dist/community/functions/getParticipants.d.ts +9 -3
  113. package/dist/community/functions/getSubgroups.d.ts +11 -3
  114. package/dist/community/functions/index.d.ts +9 -9
  115. package/dist/community/functions/promoteParticipants.d.ts +14 -4
  116. package/dist/community/functions/removeSubgroups.d.ts +20 -10
  117. package/dist/conn/functions/changeEnviromentDevice.d.ts +3 -2
  118. package/dist/conn/functions/genLinkDeviceCodeForPhoneNumber.d.ts +12 -4
  119. package/dist/conn/functions/getABProps.d.ts +15 -6
  120. package/dist/conn/functions/getAuthCode.d.ts +3 -2
  121. package/dist/conn/functions/getAutoDownloadSettings.d.ts +7 -6
  122. package/dist/conn/functions/getBuildConstants.d.ts +21 -8
  123. package/dist/conn/functions/getHistorySyncProgress.d.ts +4 -4
  124. package/dist/conn/functions/getMigrationState.d.ts +4 -4
  125. package/dist/conn/functions/getMyDeviceId.d.ts +3 -2
  126. package/dist/conn/functions/getMyUserId.d.ts +3 -2
  127. package/dist/conn/functions/getMyUserLid.d.ts +3 -2
  128. package/dist/conn/functions/getMyUserWid.d.ts +3 -2
  129. package/dist/conn/functions/getPlatform.d.ts +3 -2
  130. package/dist/conn/functions/getStreamData.d.ts +3 -3
  131. package/dist/conn/functions/getTheme.d.ts +2 -1
  132. package/dist/conn/functions/index.d.ts +33 -33
  133. package/dist/conn/functions/isAuthenticated.d.ts +3 -2
  134. package/dist/conn/functions/isIdle.d.ts +3 -2
  135. package/dist/conn/functions/isMainInit.d.ts +3 -2
  136. package/dist/conn/functions/isMainLoaded.d.ts +3 -2
  137. package/dist/conn/functions/isMainReady.d.ts +3 -2
  138. package/dist/conn/functions/isMultiDevice.d.ts +3 -2
  139. package/dist/conn/functions/isOnline.d.ts +3 -2
  140. package/dist/conn/functions/isRegistered.d.ts +3 -2
  141. package/dist/conn/functions/joinWebBeta.d.ts +11 -4
  142. package/dist/conn/functions/logout.d.ts +3 -2
  143. package/dist/conn/functions/markAvailable.d.ts +12 -4
  144. package/dist/conn/functions/needsUpdate.d.ts +3 -2
  145. package/dist/conn/functions/refreshQR.d.ts +3 -2
  146. package/dist/conn/functions/setAutoDownloadSettings.d.ts +11 -19
  147. package/dist/conn/functions/setKeepAlive.d.ts +11 -4
  148. package/dist/conn/functions/setLimit.d.ts +28 -38
  149. package/dist/conn/functions/setMultiDevice.d.ts +11 -4
  150. package/dist/conn/functions/setTheme.d.ts +14 -7
  151. package/dist/contact/functions/get.d.ts +12 -7
  152. package/dist/contact/functions/getBusinessProfile.d.ts +12 -5
  153. package/dist/contact/functions/getCommonGroups.d.ts +10 -3
  154. package/dist/contact/functions/getPnLidEntry.d.ts +10 -5
  155. package/dist/contact/functions/getProfilePictureUrl.d.ts +12 -5
  156. package/dist/contact/functions/getStatus.d.ts +10 -4
  157. package/dist/contact/functions/index.d.ts +14 -14
  158. package/dist/contact/functions/list.d.ts +15 -11
  159. package/dist/contact/functions/queryExists.d.ts +10 -3
  160. package/dist/contact/functions/remove.d.ts +11 -4
  161. package/dist/contact/functions/reportContact.d.ts +16 -14
  162. package/dist/contact/functions/save.d.ts +18 -11
  163. package/dist/contact/functions/subscribePresence.d.ts +11 -4
  164. package/dist/contact/functions/unsubscribePresence.d.ts +11 -3
  165. package/dist/group/functions/addParticipants.d.ts +19 -12
  166. package/dist/group/functions/approve.d.ts +14 -6
  167. package/dist/group/functions/canAdd.d.ts +10 -4
  168. package/dist/group/functions/canDemote.d.ts +11 -4
  169. package/dist/group/functions/canPromote.d.ts +11 -4
  170. package/dist/group/functions/canRemove.d.ts +11 -4
  171. package/dist/group/functions/create.d.ts +23 -14
  172. package/dist/group/functions/demoteParticipants.d.ts +12 -5
  173. package/dist/group/functions/ensureGroup.d.ts +11 -3
  174. package/dist/group/functions/ensureGroupAndParticipants.d.ts +14 -5
  175. package/dist/group/functions/getAllGroups.d.ts +4 -2
  176. package/dist/group/functions/getGroupInfoFromInviteCode.d.ts +10 -35
  177. package/dist/group/functions/getGroupSizeLimit.d.ts +3 -2
  178. package/dist/group/functions/getInviteCode.d.ts +10 -4
  179. package/dist/group/functions/getMembershipRequests.d.ts +16 -9
  180. package/dist/group/functions/getParticipants.d.ts +11 -4
  181. package/dist/group/functions/getPastParticipants.d.ts +11 -4
  182. package/dist/group/functions/iAmAdmin.d.ts +9 -3
  183. package/dist/group/functions/iAmMember.d.ts +9 -3
  184. package/dist/group/functions/iAmRestrictedMember.d.ts +9 -3
  185. package/dist/group/functions/iAmSuperAdmin.d.ts +9 -3
  186. package/dist/group/functions/index.d.ts +32 -32
  187. package/dist/group/functions/join.d.ts +12 -5
  188. package/dist/group/functions/leave.d.ts +10 -4
  189. package/dist/group/functions/promoteParticipants.d.ts +12 -5
  190. package/dist/group/functions/reject.d.ts +14 -6
  191. package/dist/group/functions/removeIcon.d.ts +10 -4
  192. package/dist/group/functions/removeParticipants.d.ts +12 -5
  193. package/dist/group/functions/revokeInviteCode.d.ts +10 -4
  194. package/dist/group/functions/setDescription.d.ts +11 -4
  195. package/dist/group/functions/setIcon.d.ts +17 -10
  196. package/dist/group/functions/setProperty.d.ts +19 -11
  197. package/dist/group/functions/setSubject.d.ts +11 -4
  198. package/dist/indexdb/functions/getMessagesFromRowId.d.ts +9 -13
  199. package/dist/indexdb/functions/index.d.ts +1 -1
  200. package/dist/labels/functions/addNewLabel.d.ts +14 -13
  201. package/dist/labels/functions/addOrRemoveLabels.d.ts +20 -11
  202. package/dist/labels/functions/colorIsInLabelPalette.d.ts +11 -5
  203. package/dist/labels/functions/deleteAllLabels.d.ts +14 -2
  204. package/dist/labels/functions/deleteLabel.d.ts +9 -3
  205. package/dist/labels/functions/editLabel.d.ts +15 -13
  206. package/dist/labels/functions/getAllLabels.d.ts +14 -2
  207. package/dist/labels/functions/getLabelById.d.ts +9 -2
  208. package/dist/labels/functions/getLabelColorPalette.d.ts +11 -2
  209. package/dist/labels/functions/getNewLabelColor.d.ts +12 -3
  210. package/dist/labels/functions/index.d.ts +11 -11
  211. package/dist/newsletter/functions/create.d.ts +16 -11
  212. package/dist/newsletter/functions/destroy.d.ts +10 -3
  213. package/dist/newsletter/functions/edit.d.ts +25 -16
  214. package/dist/newsletter/functions/ensureNewsletter.d.ts +8 -3
  215. package/dist/newsletter/functions/follow.d.ts +9 -2
  216. package/dist/newsletter/functions/getSubscribers.d.ts +10 -3
  217. package/dist/newsletter/functions/index.d.ts +9 -9
  218. package/dist/newsletter/functions/mute.d.ts +12 -4
  219. package/dist/newsletter/functions/search.d.ts +18 -12
  220. package/dist/newsletter/functions/unfollow.d.ts +9 -2
  221. package/dist/order/functions/accept.d.ts +9 -10
  222. package/dist/order/functions/decline.d.ts +10 -12
  223. package/dist/order/functions/get.d.ts +12 -5
  224. package/dist/order/functions/index.d.ts +5 -5
  225. package/dist/order/functions/update.d.ts +16 -3
  226. package/dist/privacy/functions/get.d.ts +14 -3
  227. package/dist/privacy/functions/getDisallowedList.d.ts +20 -13
  228. package/dist/privacy/functions/index.d.ts +9 -9
  229. package/dist/privacy/functions/prepareDisallowedList.d.ts +18 -6
  230. package/dist/privacy/functions/setAbout.d.ts +39 -6
  231. package/dist/privacy/functions/setAddGroup.d.ts +37 -6
  232. package/dist/privacy/functions/setLastSeen.d.ts +39 -6
  233. package/dist/privacy/functions/setOnline.d.ts +22 -3
  234. package/dist/privacy/functions/setProfilePic.d.ts +39 -6
  235. package/dist/privacy/functions/setReadReceipts.d.ts +22 -3
  236. package/dist/privacy/functions/setStatus.d.ts +31 -4
  237. package/dist/profile/functions/editBusinessProfile.d.ts +21 -4
  238. package/dist/profile/functions/getMyProfileName.d.ts +3 -2
  239. package/dist/profile/functions/getMyProfilePicture.d.ts +3 -2
  240. package/dist/profile/functions/getMyStatus.d.ts +3 -2
  241. package/dist/profile/functions/index.d.ts +9 -9
  242. package/dist/profile/functions/isBusiness.d.ts +4 -3
  243. package/dist/profile/functions/removeMyProfilePicture.d.ts +3 -2
  244. package/dist/profile/functions/setMyProfileName.d.ts +10 -3
  245. package/dist/profile/functions/setMyProfilePicture.d.ts +16 -9
  246. package/dist/profile/functions/setMyStatus.d.ts +10 -3
  247. package/dist/status/functions/get.d.ts +18 -3
  248. package/dist/status/functions/getMyStatus.d.ts +3 -2
  249. package/dist/status/functions/index.d.ts +10 -10
  250. package/dist/status/functions/postSendStatus.d.ts +9 -2
  251. package/dist/status/functions/remove.d.ts +17 -3
  252. package/dist/status/functions/sendImageStatus.d.ts +14 -5
  253. package/dist/status/functions/sendRawStatus.d.ts +12 -8
  254. package/dist/status/functions/sendReadStatus.d.ts +11 -4
  255. package/dist/status/functions/sendTextStatus.d.ts +16 -8
  256. package/dist/status/functions/sendVideoStatus.d.ts +14 -5
  257. package/dist/status/functions/updateParticipants.d.ts +11 -9
  258. package/dist/status/index.d.ts +0 -1
  259. package/dist/types.d.ts +20 -0
  260. package/dist/whatsapp/functions/deleteContactAction.d.ts +3 -23
  261. package/dist/whatsapp/functions/setArchive.d.ts +0 -9
  262. package/dist/wppconnect-wa.js +1 -1
  263. package/dist/wppconnect-wa.js.LICENSE.txt +1 -1
  264. package/package.json +20 -17
  265. package/dist/blocklist/types.d.ts +0 -20
  266. package/dist/status/defaultSendStatusOptions.d.ts +0 -19
package/dist/types.d.ts CHANGED
@@ -13,6 +13,26 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
+ import { z } from 'zod';
16
17
  export interface Stringable {
17
18
  toString(): string;
18
19
  }
20
+ /** Zod schema for a WhatsApp group/community chat ID (ends with `@g.us`) */
21
+ export declare const groupIdSchema: z.ZodString;
22
+ export type GroupId = z.infer<typeof groupIdSchema>;
23
+ /** Zod schema for a WhatsApp DM chat ID (ends with `@c.us` or `@lid`) */
24
+ export declare const dmChatIdSchema: z.ZodString;
25
+ export type DMChatId = z.infer<typeof dmChatIdSchema>;
26
+ /** Zod schema for a WhatsApp Newsletter channel ID (ends with `@newsletter`) */
27
+ export declare const newsletterIdSchema: z.ZodString;
28
+ export type NewsletterId = z.infer<typeof newsletterIdSchema>;
29
+ /** Zod schema for a WhatsApp Status broadcast ID (`status@broadcast`) */
30
+ export declare const statusIdSchema: z.ZodLiteral<"status@broadcast">;
31
+ export type StatusId = z.infer<typeof statusIdSchema>;
32
+ /**
33
+ * Zod schema for any valid WhatsApp chat ID.
34
+ * Accepts DMs (`@c.us`, `@lid`), groups/communities (`@g.us`),
35
+ * newsletters (`@newsletter`), and status (`status@broadcast`).
36
+ */
37
+ export declare const chatIdSchema: z.ZodUnion<readonly [z.ZodString, z.ZodString, z.ZodString, z.ZodLiteral<"status@broadcast">]>;
38
+ export type ChatId = z.infer<typeof chatIdSchema>;
@@ -14,26 +14,6 @@
14
14
  * limitations under the License.
15
15
  */
16
16
  import { Wid } from '../misc';
17
- /**
18
- * Deletes a contact from the contact list (legacy API).
19
- *
20
- * @whatsapp WAWebDeleteContactAction >= 2.3000.0
21
- * @whatsapp ~2.3000.1030040369
22
- *
23
- * @param number - Phone number string
24
- *
25
- * @deprecated Since around WhatsApp version 2.3000.1030110621. Use the new object-based API instead.
26
- * Use `deleteContactActionV2({ phoneNumber: wid })` for regular contacts
27
- * or `deleteContactActionV2({ username, lid })` for username contacts.
28
- *
29
- * @example
30
- * // Deprecated usage
31
- * await deleteContactAction('5511999999999');
32
- *
33
- * // Use this instead
34
- * await deleteContactActionV2({ phoneNumber: wid });
35
- */
36
- export declare function deleteContactAction(number: string): Promise<void>;
37
17
  /**
38
18
  * Deletes a contact from the contact list.
39
19
  *
@@ -46,12 +26,12 @@ export declare function deleteContactAction(number: string): Promise<void>;
46
26
  *
47
27
  * @example
48
28
  * // Delete regular contact by phone number
49
- * await deleteContactActionV2({ phoneNumber: wid });
29
+ * await deleteContactAction({ phoneNumber: wid });
50
30
  *
51
31
  * // Delete username contact
52
- * await deleteContactActionV2({ username: 'john', lid: '123' });
32
+ * await deleteContactAction({ username: 'john', lid: '123' });
53
33
  */
54
- export declare function deleteContactActionV2(params: {
34
+ export declare function deleteContactAction(params: {
55
35
  phoneNumber?: Wid;
56
36
  username?: string;
57
37
  lid?: string;
@@ -13,15 +13,6 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
- import { ChatModel } from '../models';
17
- /**
18
- * @deprecated
19
- * @whatsapp 59992
20
- * @whatsapp 259992 >= 2.2222.8
21
- * @whatsapp 503153 >= 2.2228.4
22
- * <= 2.3000.x
23
- */
24
- export declare function setArchive(chat: ChatModel, archive: boolean, id?: string): Promise<void>;
25
16
  /**
26
17
  * @whatsapp >= 2.3000.1012117641
27
18
  */