@wppconnect/wa-js 4.1.2-alpha.0 → 4.2.0

package/CHANGELOG.md

@@ -1,3 +1,3 @@
-## <small>4.1.2-alpha.0 (2026-05-14)</small>
+## 4.2.0 (2026-05-15)
 
-* Merge branch 'manfe/attempt-to-fix-disconnections-1' of github.com:wppconnect-team/wa-js into manfe/attempt-to-fix-disconnections-1 ([1dc5afb8efa912eb468355ab056ab29c38ce2958](https://github.com/wppconnect-team/wa-js/commit/1dc5afb8efa912eb468355ab056ab29c38ce2958))
+* fix: remove outdated pre-lid release patches (#3425) ([aadc862253d4c4989d6a9e404c349889d55fa0d1](https://github.com/wppconnect-team/wa-js/commit/aadc862253d4c4989d6a9e404c349889d55fa0d1)), closes [#3425](https://github.com/wppconnect-team/wa-js/issues/3425)

package/README.md

@@ -132,6 +132,194 @@ For the most up-to-date list of available functions, launch the project locally
 
 `Object.keys(WPP.group).sort()`
 
+### Newsletter (Channels) Functions
+
+`WPP.newsletter.create` - Create a new newsletter (WhatsApp Channel)
+
+`WPP.newsletter.edit` - Edit an existing newsletter (name, description, picture)
+
+`WPP.newsletter.destroy` - Delete a newsletter you own
+
+`WPP.newsletter.follow` / `WPP.newsletter.unfollow` - Follow or unfollow a newsletter
+
+`WPP.newsletter.mute` - Mute notifications from a newsletter
+
+`WPP.newsletter.search` - Search newsletters by name or country
+
+`WPP.newsletter.getSubscribers` - Get the subscriber list of a newsletter you own
+
+For the most up-to-date list of available functions, launch the project locally and run this in your browser console:
+
+`Object.keys(WPP.newsletter).sort()`
+
+### Community Functions
+
+`WPP.community.create` - Create a new community
+
+`WPP.community.deactivate` - Deactivate (delete) a community
+
+`WPP.community.addSubgroups` - Add existing groups as subgroups of a community
+
+`WPP.community.removeSubgroups` - Remove subgroups from a community
+
+`WPP.community.getSubgroups` - Get all subgroups of a community
+
+`WPP.community.getParticipants` - Get all participants across the community
+
+`WPP.community.getAnnouncementGroup` - Get the announcement group of a community
+
+`WPP.community.promoteParticipants` / `WPP.community.demoteParticipants` - Promote or demote community admins
+
+For the most up-to-date list of available functions, launch the project locally and run this in your browser console:
+
+`Object.keys(WPP.community).sort()`
+
+### Catalog Functions
+
+`WPP.catalog.getMyCatalog` - Get the catalog of the connected business account
+
+`WPP.catalog.getProducts` - Get products of any business contact
+
+`WPP.catalog.getProductById` - Get a single product by id
+
+`WPP.catalog.createProduct` - Create a new product in your catalog
+
+`WPP.catalog.editProduct` - Edit an existing product
+
+`WPP.catalog.delProducts` - Delete one or more products
+
+`WPP.catalog.addProductImage` / `WPP.catalog.changeProductImage` / `WPP.catalog.removeProductImage` - Manage product images
+
+`WPP.catalog.setProductVisibility` - Show or hide a product
+
+`WPP.catalog.createCollection` / `WPP.catalog.editCollection` / `WPP.catalog.deleteCollection` / `WPP.catalog.getCollections` - Manage product collections
+
+`WPP.catalog.updateCartEnabled` - Enable or disable cart for the catalog
+
+For the most up-to-date list of available functions, launch the project locally and run this in your browser console:
+
+`Object.keys(WPP.catalog).sort()`
+
+### Cart Functions
+
+`WPP.cart.add` - Add a product to the cart of a business chat
+
+`WPP.cart.update` - Update the quantity of an item in the cart
+
+`WPP.cart.remove` - Remove an item from the cart
+
+`WPP.cart.get` - Get the current cart for a business chat
+
+`WPP.cart.clear` - Empty the cart
+
+`WPP.cart.submit` - Submit the cart and send the order
+
+`WPP.cart.getThumbFromCart` - Get the cart thumbnail preview
+
+For the most up-to-date list of available functions, launch the project locally and run this in your browser console:
+
+`Object.keys(WPP.cart).sort()`
+
+### Order Functions
+
+`WPP.order.get` - Get the details of an order received in a chat
+
+`WPP.order.accept` - Accept an order
+
+`WPP.order.decline` - Decline an order
+
+`WPP.order.update` - Update an order (e.g. change status)
+
+For the most up-to-date list of available functions, launch the project locally and run this in your browser console:
+
+`Object.keys(WPP.order).sort()`
+
+### Status Functions
+
+`WPP.status.sendTextStatus` - Post a text status
+
+`WPP.status.sendImageStatus` - Post an image status
+
+`WPP.status.sendVideoStatus` - Post a video status
+
+`WPP.status.sendReadStatus` - Mark a status as seen
+
+`WPP.status.get` - Get the status feed of a contact
+
+`WPP.status.getMyStatus` - Get your own status feed
+
+`WPP.status.remove` - Remove one of your statuses
+
+`WPP.status.updateParticipants` - Update who can see your statuses
+
+For the most up-to-date list of available functions, launch the project locally and run this in your browser console:
+
+`Object.keys(WPP.status).sort()`
+
+### Labels Functions
+
+`WPP.labels.getAllLabels` - Get every label defined in the account
+
+`WPP.labels.getLabelById` - Get a label by id
+
+`WPP.labels.addNewLabel` - Create a new label
+
+`WPP.labels.editLabel` - Rename or recolor a label
+
+`WPP.labels.deleteLabel` - Delete a single label
+
+`WPP.labels.deleteAllLabels` - Delete every label in the account
+
+`WPP.labels.addOrRemoveLabels` - Apply or remove labels on chats / messages in bulk
+
+`WPP.labels.getLabelColorPalette` / `WPP.labels.getNewLabelColor` - Helpers for label colors
+
+For the most up-to-date list of available functions, launch the project locally and run this in your browser console:
+
+`Object.keys(WPP.labels).sort()`
+
+### Profile Functions
+
+`WPP.profile.getMyProfileName` / `WPP.profile.setMyProfileName` - Read or change your profile name
+
+`WPP.profile.getMyStatus` / `WPP.profile.setMyStatus` - Read or change your "about" text
+
+`WPP.profile.getMyProfilePicture` - Get your current profile picture
+
+`WPP.profile.setMyProfilePicture` / `WPP.profile.removeMyProfilePicture` - Set or remove your profile picture
+
+`WPP.profile.isBusiness` - Check whether the connected account is a Business account
+
+`WPP.profile.editBusinessProfile` - Edit business profile fields (description, address, etc.)
+
+For the most up-to-date list of available functions, launch the project locally and run this in your browser console:
+
+`Object.keys(WPP.profile).sort()`
+
+### Privacy Functions
+
+`WPP.privacy.get` - Get the current privacy settings as an object
+
+`WPP.privacy.setLastSeen` - Configure who can see your "last seen"
+
+`WPP.privacy.setOnline` - Configure who can see when you are online
+
+`WPP.privacy.setProfilePic` - Configure who can see your profile picture
+
+`WPP.privacy.setReadReceipts` - Enable or disable read receipts
+
+`WPP.privacy.setStatus` - Configure who can see your status updates
+
+`WPP.privacy.setAbout` - Configure who can see your "about" text
+
+`WPP.privacy.setAddGroup` - Configure who can add you to groups
+
+`WPP.privacy.getDisallowedList` - Get the disallowed list (used together with `setAddGroup` / `setStatus` when set to `contact_blacklist`)
+
+For the most up-to-date list of available functions, launch the project locally and run this in your browser console:
+
+`Object.keys(WPP.privacy).sort()`
+
 ### Events
 
 #### Connection Events
@@ -215,6 +403,33 @@ To debug or inspect `wa-source` folder, format the files to be easier to underst
 npm run wa-source:format
 ```
 
+### Testing
+
+The project ships a Playwright suite under `tests/`. Two flavours are available:
+
+```bash
+# Smoke tests — no QR scan needed.
+# Loads the live wppconnect-wa.js bundle on web.whatsapp.com and verifies
+# every public WPP module still exposes the functions documented above.
+# Useful as an early-warning when WhatsApp Web ships an update that breaks
+# our patches.
+npm test -- tests/smoke.spec.ts
+
+# Full test project (smoke + any other *.spec.ts)
+npm test
+```
+
+Tests that need an authenticated session use the `loggedPage` fixture from
+`tests/wpp-test.ts`. To bootstrap that session once (this opens a real
+browser so you can scan the QR), run:
+
+```bash
+npm run test:prepare
+```
+
+The session is cached under your OS temp dir (`wa-js-test-<browser>`) and
+reused by subsequent runs.
+
 ### Comparing WhatsApp Web Versions
 
 To compare changes between two WhatsApp Web versions, use the helper script:

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

@@ -31,13 +31,27 @@ export declare enum LogoutReason {
     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"
+    LidMigrationSplitThreadMismatch = "lid_migration_split_thread_mismatch",
+    LidMigrationNoLidAvailiable = "lid_migration_no_lid_available",
+    LidMigrationPrimaryMappingsObsolete = "lid_migration_primary_mappings_obsolete",
+    LidMigrationPeerMappingsNotReceived = "lid_migration_peer_mapping_not_received",
+    LidMigrationStateDiscrepancy = "lid_migration_state_discrepancy",
+    LidMigrationPeerMappingsMalformed = "lid_migration_peer_mapping_malformed",
+    LidMigrationFailedToParseMapping = "lid_migration_failed_to_parse_mapping",
+    LidMigrationCompanionIncompatibleKillswitch = "lid_migration_companion_incompatible_killswitch",
+    LidMigrationOneOnOneThreadMigrationInternalError = "lid_migration_one_on_one_thread_migration_internal_error",
+    LidBlocklistPnWhenMigrated = "lid_blocklist_pn_when_migrated",
+    LidBlocklistChatDbUnmigrated = "lid_blocklist_chat_db_unmigrated",
+    WebFailAddChat = "web_fail_add_chat",
+    WebFailOfflineResume = "web_fail_offline_resume",
+    WebFailStorageInitialization = "web_fail_storage_initialization",
+    WebFailEncSalt = "web_fail_enc_salt",
+    CacheStorageOpenFailed = "cache_storage_open_failed"
 }
 export declare enum LOGOUT_REASON_CODE {
     CLIENT_FATAL = "0",

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

@@ -0,0 +1,19 @@
+/*!
+ * 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 { MsgKey } from '../misc';
+import { ChatModel, MsgModel } from '../models';
+import { getSearchContext } from './getSearchContext';
+export declare function callGetSearchContext(chat: ChatModel | string, msgKey: MsgModel | MsgKey | string): ReturnType<typeof getSearchContext>;

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

@@ -26,3 +26,14 @@ export declare function getSearchContext(chat: ChatModel | string, msg: MsgModel
     key?: MsgKey;
     highlightMsg: true;
 };
+export declare function getSearchContext(params: {
+    chat: ChatModel | string;
+    msgKey: MsgModel | MsgKey | string;
+    rootMsg?: MsgModel;
+    threadId?: string;
+}): {
+    collection: MsgLoad;
+    msg?: MsgModel;
+    key?: MsgKey;
+    highlightMsg: true;
+};

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

@@ -70,7 +70,6 @@ export * from './getCountryShortcodeByPhone';
 export * from './getCurrentLid';
 export * from './getEnforceCurrentLid';
 export * from './getEphemeralFields';
-export * from './getErrorCodeFromLogoutReason';
 export * from './getExisting';
 export * from './getFanOutList';
 export * from './getGroupSenderKeyList';
@@ -109,6 +108,7 @@ export * from './isWid';
 export * from './joinGroupViaInvite';
 export * from './keepMessage';
 export * from './labelAddAction';
+export * from './logoutReason';
 export * from './markSeen';
 export * from './mediaTypeFromProtobuf';
 export * from './membershipApprovalRequestAction';

package/dist/whatsapp/functions/{getErrorCodeFromLogoutReason.d.ts → logoutReason.d.ts}

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2021 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,3 +18,7 @@ import { LOGOUT_REASON_CODE, LogoutReason } from '../enums';
  * @whatsapp WAWebLogoutReason >= 2.3000.x
  */
 export declare function getErrorCodeFromLogoutReason(type: LogoutReason): LOGOUT_REASON_CODE | null;
+export declare function setPrevLogoutReasonCode(code: LOGOUT_REASON_CODE | null): void;
+export declare function setPrevCustomLogoutMessage(message: string | null): void;
+export declare function getPrevLogoutReasonCode(): LOGOUT_REASON_CODE | null;
+export declare function getPrevCustomLogoutMessage(): string | null;