@wppconnect/wa-js 3.4.2 → 3.6.0

package/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 3.4.2 (2024-07-08)
+# 3.6.0 (2024-07-16)
 
 
 

package/README.md

@@ -19,6 +19,13 @@
 [![WhatsApp Group](https://img.shields.io/badge/WhatsApp-Group-25D366?logo=whatsapp)](https://chat.whatsapp.com/LJaQu6ZyNvnBPNAVRbX00K)
 [![YouTube](https://img.shields.io/youtube/channel/subscribers/UCD7J9LG08PmGQrF5IS7Yv9A?label=YouTube)](https://www.youtube.com/c/wppconnect)
 
+
+### Top Contributors (last 45 days) widget
+---
+![Top Contributors (Last 45 days) widget](https://embeddables.devactivity.com/orgs/wppconnect-team/508ecbcd-e55e-4e31-a647-6674f134b5bf.svg)
+---
+<sup><sub>Check also our [Public Dashboard](https://app.devactivity.com/public/?organizationLogin=wppconnect-team) powered by [devActivity](https://devactivity.com/?ref=public_widget)</sub></sup>
+
 ## How does it work
 
 This project extract some functions of WhatsApp sources, that uses webpack.
@@ -40,6 +47,56 @@ There are a convection name for some exported modules:
 - `...Collection` - Class for collection of models (`ChatCollection`, `MsgCollection`)
 - `...Store` - Default and global instance of a collection (`ChatStore`, `MsgStore`)
 
+## Some Available functions
+### General Functions
+`WPP.conn.connect` - Connect to WhatsApp Web
+
+`WPP.conn.isAuthenticated` - Check if the connection is authenticated
+
+`WPP.conn.logout` - Logout from WhatsApp Web
+
+### Chat Functions
+`WPP.chat.sendTextMessage` - Send a text message
+
+`WPP.chat.sendImageMessage` - Send an image message
+
+`WPP.chat.sendVideoMessage` - Send a video message
+
+`WPP.chat.sendFileMessage` - Send a file message
+
+`WPP.chat.sendAudioMessage` - Send an audio message
+
+`WPP.chat.getChat` - Get chat details
+
+`WPP.chat.deleteMessage` - Delete a message
+
+### Contact Functions
+`WPP.contact.getContact` - Get contact details
+
+`WPP.contact.blockContact` - Block a contact
+
+`WPP.contact.unblockContact` - Unblock a contact
+
+`WPP.contact.getAllContacts` - Get all contacts
+
+### Group Functions
+`WPP.group.createGroup` - Create a new group
+
+`WPP.group.addParticipant` - Add a participant to a group
+
+`WPP.group.removeParticipant` - Remove a participant from a group.
+
+`WPP.group.promoteParticipant` - Promote a participant to admin
+
+`WPP.group.demoteParticipant` - Demote a participant from admin.
+
+`WPP.group.getGroupInfo` - Get group information.
+
+### Events
+`WPP.chat.on('chat.new_message')` - Event to dispatch on receive a new message
+
+To see all events, check: [https://wppconnect.io/wa-js/types/ev.EventTypes.html](https://wppconnect.io/wa-js/types/ev.EventTypes.html)
+
 ## Development
 
 Steps to run locally:

package/dist/chat/functions/closeChat.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2024 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Close the chat tab
+ *
+ * @example
+ * ```javascript
+ * await WPP.chat.closeChat();
+ * ```
+ *
+ * @category Chat
+ */
+export declare function closeChat(): Promise<boolean>;

package/dist/chat/functions/index.d.ts

@@ -18,6 +18,7 @@ export { canMarkPlayed } from './canMarkPlayed';
 export { canMute } from './canMute';
 export { canReply } from './canReply';
 export { clear } from './clear';
+export { closeChat } from './closeChat';
 export { delete } from './delete';
 export { deleteMessage, DeleteMessageReturn } from './deleteMessage';
 export { downloadMedia } from './downloadMedia';

package/dist/conn/events/eventTypes.d.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { LogoutReason } from '../../whatsapp/enums';
 import { AuthCode } from '../types';
 export interface ConnEventTypes {
     'conn.auth_code_change': AuthCode | null;
@@ -28,6 +29,7 @@ export interface ConnEventTypes {
      */
     'conn.authenticated': undefined;
     'conn.logout': undefined;
+    'conn.logout_reason': LogoutReason;
     /**
      * Triggered when the interface is booting
      *

package/dist/conn/events/index.d.ts

@@ -16,6 +16,7 @@
 import './registerAuthCodeChangeEvent';
 import './registerAuthenticatedEvent';
 import './registerLogoutEvent';
+import './registerLogoutReasonEvent';
 import './registerMainInit';
 import './registerMainLoadedEvent';
 import './registerMainReadyEvent';

package/dist/conn/events/registerLogoutReasonEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright 2024 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/dist/whatsapp/enums/LogoutReason.d.ts

@@ -16,15 +16,32 @@
 /** @whatsapp 83578
  * @whatsapp 88950 >= 2.2218.4
  * @whatsapp 788950 >= 2.2222.8
+ * @whatsapp WAWebLogoutReasonConstants >= 2.3000.x
  */
 export declare enum LogoutReason {
-    USER_INITIATED = "user_initiated",
-    SYNCD_FAILURE = "syncd_failure",
-    CRITICAL_SYNC_TIMEOUT = "critical_sync_timeout",
-    UNKNOWN_COMPANION = "unknown_companion",
-    CLIENT_VERSION_OUTDATED = "client_version_outdated",
-    SYNCD_ERROR_DURING_BOOTSTRAP = "syncd_error_during_bootstrap",
-    ACCOUNT_SYNC_ERROR = "account_sync_error",
-    CLIENT_FATAL_ERROR = "client_fatal_error",
+    UserInitiated = "user_initiated",
+    SyncdFailure = "syncd_failure",
+    InvalidAdvStatus = "invalid_adv_status",
+    CriticalSyncTimeout = "critical_sync_timeout",
+    SyncdTimeout = "syncd_timeout",
+    HistorySyncTimeout = "history_sync_timeout",
+    AccountSyncTimeout = "account_sync_timeout",
+    MDOptOut = "md_opt_out",
+    UnknownCompanion = "unknown_companion",
+    ClientVersionOutdated = "client_version_outdated",
+    SyncdErrorDuringBootstrap = "syncd_error_during_bootstrap",
+    AccountSyncError = "account_sync_error",
+    ClientFatalError = "client_fatal_error",
+    StorageQuotaExceeded = "storage_quota_exceeded",
+    PrimaryIdentityKeyChange = "primary_identity_key_change",
+    MissingEncSalt = "missing_enc_salt",
+    MissingScreenLockSalt = "missing_screen_lock_salt",
+    AccountLocked = "account_locked",
     UNKNOWN = "unknown"
 }
+export declare enum LOGOUT_REASON_CODE {
+    CLIENT_FATAL = "0",
+    SYNC_FAIL = "1",
+    INITIAL_HISTORY_SYNC_TIMEOUT = "2",
+    ACCOUNT_LOCKED = "3"
+}

package/dist/whatsapp/functions/getErrorCodeFromLogoutReason.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { LOGOUT_REASON_CODE, LogoutReason } from '../enums';
+/**
+ * @whatsapp WAWebLogoutReason >= 2.3000.x
+ */
+export declare function getErrorCodeFromLogoutReason(type: LogoutReason): LOGOUT_REASON_CODE | null;

package/dist/whatsapp/functions/index.d.ts

@@ -55,6 +55,7 @@ export * from './getCommunityParticipants';
 export * from './getCountryShortcodeByPhone';
 export * from './getCurrentLid';
 export * from './getEphemeralFields';
+export * from './getErrorCodeFromLogoutReason';
 export * from './getFanOutList';
 export * from './getGroupSenderKeyList';
 export * from './getGroupSizeLimit';