WPPConnect WA-JS

https://github.com/wppconnect-team/wa-js
Admin
WPPConnect/WA-JS is an open-source project that exports functions from WhatsApp Web, enabling...
Tokens:79,933
Snippets:902
Trust Score:8.5
License:Apache-2.0
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example: Get All Groups

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/group.md

Demonstrates how to fetch all groups and log their subjects and member counts. Requires the WPP object to be initialized.

```javascript
const groups = await WPP.group.getAllGroups();
groups.forEach(group => {
  console.log('Group:', group.subject);
  console.log('Members:', group.participants.length);
});
```

--------------------------------

### Install Dependencies and Build Project

Source: https://github.com/wppconnect-team/wa-js/blob/main/README.md

Install project dependencies and build the JavaScript files for production or development.

```bash
npm install

npm run build:prd # or build:dev for development
```

--------------------------------

### Install WA-JS via NPM

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/README.md

Use this command to install the WA-JS library using npm.

```bash
npm install @wppconnect/wa-js
```

--------------------------------

### Clone Repository and Install Dependencies

Source: https://github.com/wppconnect-team/wa-js/blob/main/README.md

Clone the WA-JS repository and install the necessary npm packages to begin development.

```bash
git clone https://github.com/wppconnect-team/wa-js.git
cd wa-js
npm install
```

--------------------------------

### Example: Get Group Info From Invite Code

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/group.md

Shows how to retrieve and log the subject of a group using its invite code. Ensure the invite code is valid.

```javascript
const info = await WPP.group.getGroupInfoFromInviteCode('A1b2C3d4E5f6G7h8');
console.log('Group:', info.subject);
```

--------------------------------

### Get Platform Information

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Fetches information about the current operating platform or browser.

```typescript
function getPlatform(): string
```

--------------------------------

### Set Pre-Injection Configuration

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/configuration.md

Configure WA-JS by setting options in `window.WPPConfig` before loading the library script. This is the primary method for initial setup.

```javascript
// Set this before loading wppconnect-wa.js
window.WPPConfig = {
  deviceName: 'My Bot',
  lockUi: false,
  headless: false
};

// Then load the script
<script src="wppconnect-wa.js"></script>

// Or with TamperMonkey/GreaseMonkey:
// @require      https://github.com/wppconnect-team/wa-js/releases/download/nightly/wppconnect-wa.js
```

--------------------------------

### Initialize WA-JS with Configuration and Timing

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/configuration.md

This example demonstrates the correct sequence for initializing WA-JS. It involves setting `window.WPPConfig` before loading the script, appending the script tag, and then using `WPP.loader.onReady` to ensure the library is ready before proceeding with authentication checks and event listeners.

```javascript
// Example initialization with proper timing

// 1. Set config BEFORE script load
window.WPPConfig = {
  deviceName: 'My Bot'
};

// 2. Load script
const script = document.createElement('script');
script.src = 'wppconnect-wa.js';
document.head.appendChild(script);

// 3. Wait for ready
script.onload = () => {
  WPP.loader.onReady(() => {
    console.log('WPP ready');
    
    // 4. Check authentication
    if (WPP.conn.isAuthenticated()) {
      console.log('Already logged in');
      startBot();
    } else {
      console.log('Waiting for QR scan');
    }
    
    // 5. Listen for auth changes
    WPP.on('conn.authenticated', () => {
      console.log('Logged in');
      startBot();
    });
  });
};
```

--------------------------------

### Example: Join Group

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/group.md

Demonstrates joining a group with an invite code and logging the resulting group ID. The invite code must be valid and not expired.

```javascript
const groupId = await WPP.group.join('A1b2C3d4E5f6G7h8');
console.log('Joined group:', groupId.toString());
```

--------------------------------

### Settings Management

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/module-exports.md

Methods for getting and setting various application settings.

```APIDOC
## getTheme

### Description
Gets the current theme setting.

### Method
`getTheme()`

### Returns
- `Theme`: The current theme.

## setTheme

### Description
Sets the application theme.

### Method
`setTheme(theme)`

### Parameters
#### Path Parameters
- **theme** (Theme) - Required - The theme to set.

### Returns
- `void`

## getStreamData

### Description
Gets the current stream data.

### Method
`getStreamData()`

### Returns
- `StreamData`: The stream data.

## getAuthCode

### Description
Gets the authentication code.

### Method
`getAuthCode()`

### Returns
- `AuthCode`: The authentication code.
```

--------------------------------

### Listening to Connection Events

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/README.md

Provides examples of how to subscribe to and unsubscribe from various connection-related events, such as authentication status and stream mode changes.

```javascript
// Connection events
WPP.on('conn.authenticated', () => {
  console.log('Logged in');
});

WPP.on('conn.stream_mode_changed', (mode) => {
  if (mode === 'MAIN') {
    console.log('WhatsApp ready');
  }
});

// Chat events
WPP.on('chat.new_message', (msg) => {
  console.log('New message:', msg.body);
});

WPP.on('chat.update', (chat) => {
  if (chat.unreadCount > 0) {
    console.log('Unread messages in:', chat.name);
  }
});

// Contact events
WPP.on('contact.update', (contact) => {
  console.log('Contact updated:', contact.name);
});

// Cleanup
const handler = (msg) => console.log(msg.body);
WPP.off('chat.new_message', handler);
```

--------------------------------

### Pre-injection Usage Example with Custom Global

Source: https://github.com/wppconnect-team/wa-js/blob/main/README.md

Demonstrates how to set pre-injection configuration and use the custom global variable after injecting your WA-JS build. This ensures your tool operates independently.

```javascript
// Set this before injecting your custom build
window.MYWPPConfig = {
  deviceName: 'My Extension',
};

// After injection, use your custom global
window.MYWPP.loader.onReady(function () {
  console.log('My extension is ready');
});
```

--------------------------------

### Handling New Incoming Messages

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/README.md

Sets up a listener for new messages, logs details like sender and text, and includes an example of replying to the received message.

```javascript
// New incoming message
WPP.on('chat.new_message', (msg) => {
  if (msg.fromMe) return; // Ignore our own messages
  
  console.log('From:', msg.from.toString());
  console.log('Text:', msg.body);
  console.log('Type:', msg.type);
  
  // Reply
  WPP.chat.sendTextMessage(msg.from, 'Got your message!', {
    quotedMsg: msg.id
  });
});
```

--------------------------------

### Setup Connection Error Handling

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/errors.md

Implement automatic reconnection logic by listening to connection stream events. This function resets attempts on going offline and increments them on QR code display, stopping if max attempts are reached.

```javascript
let reconnectAttempts = 0;
const MAX_ATTEMPTS = 5;

function setupConnectionHandling() {
  WPP.on('conn.stream_info_changed', (info) => {
    if (info === 'OFFLINE') {
      reconnectAttempts = 0;
      console.log('Offline - will auto-reconnect');
    }
  });
  
  WPP.on('conn.stream_mode_changed', (mode) => {
    if (mode === 'QR' && reconnectAttempts < MAX_ATTEMPTS) {
      reconnectAttempts++;
      console.log(`Reconnect attempt ${reconnectAttempts}/${MAX_ATTEMPTS}`);
    } else if (mode === 'QR') {
      console.error('Max reconnection attempts reached');
      // Alert user or restart
    } else if (mode === 'MAIN') {
      reconnectAttempts = 0;
      console.log('Reconnected successfully');
    }
  });
}
```

--------------------------------

### Handle New Message Content

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/events.md

An alternative example for 'chat.new_message' that logs whether the message was sent or received.

```javascript
WPP.on('chat.new_message', (msg) => {
  if (msg.fromMe) {
    console.log('I sent:', msg.body);
  } else {
    console.log('Received:', msg.body);
  }
});
```

--------------------------------

### Get Product Collections

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/business-features.md

Retrieves all product collections available in your catalog. This is useful for organizing and categorizing products.

```typescript
async function getCollections(): Promise<CollectionModel[]>
```

--------------------------------

### Automate WhatsApp Web with Playwright

Source: https://github.com/wppconnect-team/wa-js/blob/main/README.md

This TypeScript example demonstrates launching a browser with Playwright, navigating to WhatsApp Web, injecting WA-JS, and evaluating functions like `isAuthenticated` and `sendTextMessage`.

```typescript
import * as playwright from 'playwright-chromium';

async function start() {
  const browser = await playwright.chromium.launch();
  const page = await browser.newPage();

  await page.goto('https://web.whatsapp.com/');

  await page.addScriptTag({
    path: require.resolve('@wppconnect/wa-js'),
  });

  // Wait WA-JS load
  await page.waitForFunction(() => window.WPP?.isReady);

  // Evaluating code: See https://playwright.dev/docs/evaluating/ 
  const isAuthenticated: string = await page.evaluate(() =>
    WPP.conn.isAuthenticated()
  );

  // Sending message: See https://playwright.dev/docs/evaluating/ 
  const sendResult: string = await page.evaluate(
    (to, message) => WPP.chat.sendTextMessage(to, message),
    to,
    message
  );
}

start();

```

--------------------------------

### Configure WA-JS Before Script Load

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/README.md

Set global configuration options for WA-JS before the main script is injected. This is useful for initial setup like defining the device name or controlling UI behavior.

```javascript
// Set before injecting wppconnect-wa.js
window.WPPConfig = {
  deviceName: 'My Bot',  // Device name shown to WhatsApp
  lockUi: false,         // Lock/unlock WhatsApp UI
  headless: false        // Headless mode
};
```

--------------------------------

### Get All Labels

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/status-labels-community.md

Retrieves all labels defined in the account. Use this to list available tags for chat organization.

```typescript
async function getAllLabels(): Promise<LabelModel[]>
```

```javascript
const labels = await WPP.labels.getAllLabels();
labels.forEach(label => console.log(label.name));
```

--------------------------------

### Send Supported Media File

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/errors.md

Example of sending a supported media file type (image) and how attempting to send an unsupported type might fail.

```javascript
// Correct
WPP.chat.sendFileMessage('[number]@c.us', 'data:image/jpeg;base64,...', {
  type: 'image'
});

// Error: Unsupported type
WPP.chat.sendFileMessage('[number]@c.us', 'data:application/x-executable;base64,...');
```

--------------------------------

### Get Auto Download Settings

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Retrieves the current configuration for automatic media downloads. This function returns the settings object.

```typescript
function getAutoDownloadSettings(): AutoDownloadSettings
```

--------------------------------

### Send File Message Examples

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/chat.md

Demonstrates sending different types of files using sendFileMessage. Ensure the file content is provided as a data URL or Blob and specify the correct message type in the options.

```javascript
WPP.chat.sendFileMessage('[number]@c.us',
  'data:audio/mp3;base64,<base64-data>',
  { type: 'audio', isPtt: true }
);
```

```javascript
WPP.chat.sendFileMessage('[number]@c.us',
  'data:image/jpeg;base64,<base64-data>',
  { type: 'image', caption: 'My photo' }
);
```

```javascript
WPP.chat.sendFileMessage('[number]@c.us',
  'data:application/pdf;base64,<base64-data>',
  { type: 'document', filename: 'document.pdf' }
);
```

```javascript
WPP.chat.sendFileMessage('[number]@c.us',
  'data:image/webp;base64,<base64-data>',
  { type: 'sticker' }
);
```

--------------------------------

### Discover Available Catalog Functions

Source: https://github.com/wppconnect-team/wa-js/blob/main/README.md

Run this in your browser console to get an up-to-date list of all available functions within the WPP.catalog object. This is useful for exploring the latest features.

```javascript
Object.keys(WPP.catalog).sort()
```

--------------------------------

### Main Entry Point

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/module-exports.md

You can import the WA-JS library using the following statement. Alternatively, it can be accessed via the global `window.WPP` object after injection.

```APIDOC
## Main Entry Point

```typescript
import WPP from '@wppconnect/wa-js';
```

Or via global variable:

```javascript
// After injection
window.WPP // All exports below
```
```

--------------------------------

### get

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/status-labels-community.md

Retrieves status updates from a specific contact.

```APIDOC
## get

### Description
Get status updates from a contact.

### Method
```typescript
async function get(contactId: string | Wid): Promise<StatusModel[]>
```

### Parameters
#### Parameters
- `contactId` (string | Wid) - Required - Contact ID

### Returns
- `StatusModel[]` - Array of status updates

### Example
```javascript
const statuses = await WPP.status.get('[number]@c.us');
```
```

--------------------------------

### Get Products from a Contact's Catalog

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/business-features.md

Fetches all products listed in a specific business contact's catalog. Requires the contact's ID.

```typescript
async function getProducts(
  contactId: string | Wid
): Promise<ProductModel[]>
```

```javascript
const products = await WPP.catalog.getProducts('[number]@c.us');
products.forEach(p => console.log(p.name, p.price));
```

--------------------------------

### Get All Lists

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/status-labels-community.md

Retrieves all custom chat lists or tabs.

```APIDOC
## list

### Description
Get all custom lists/tabs.

### Method
```typescript
async function list(): Promise<ListModel[]>
```

### Response
#### Success Response (200)
- **ListModel[]** - Array of lists
```

--------------------------------

### isMainInit

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Check if main is currently initializing.

```APIDOC
## isMainInit

### Description
Check if main is currently initializing.

### Method
```typescript
function isMainInit(): boolean
```

### Returns
- **boolean**: True if main is initializing

```

--------------------------------

### listenerCount

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/events.md

Get the number of listeners currently registered for a specific event.

```APIDOC
## listenerCount

### Description
Get the number of listeners for an event.

### Method
`listenerCount(event: keyof EventTypes): number`

### Parameters
#### Path Parameters
- `event` (string) - Required - The name of the event to count listeners for
```

--------------------------------

### Group Creation and Management

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/README.md

Shows how to create a new group with initial members, add participants to an existing group, promote members to admin, and check admin status.

```javascript
// Create group
const result = await WPP.group.create('Team', ['123@c.us', '456@c.us']);
console.log('Group ID:', result.gid.toString());

// Add members
WPP.group.addParticipants('groupid@g.us', '789@c.us');

// Promote admin
WPP.group.promoteParticipants('groupid@g.us', '789@c.us');

// Check permissions
const isAdmin = await WPP.group.iAmAdmin('groupid@g.us');
```

--------------------------------

### Get My Device ID

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Retrieves the unique identifier for the current device.

```typescript
function getMyDeviceId(): string
```

--------------------------------

### Get Subscribers

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/status-labels-community.md

Retrieves the list of subscribers for a channel that the user owns.

```APIDOC
## getSubscribers

### Description
Get the subscriber list of a channel you own.

### Method
```typescript
async function getSubscribers(
  channelId: string | Wid
): Promise<SubscriberModel[]>
```

### Parameters
#### Path Parameters
- `channelId` (string | Wid) - Required - Channel ID

### Response
#### Success Response (200)
- `SubscriberModel[]` - Array of subscribers
```

--------------------------------

### WA-JS API Reference Overview

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/MANIFEST.txt

This section provides an overview of the WA-JS API structure, detailing the modules available and the types of functions documented. It serves as a guide to navigating the library's capabilities.

```APIDOC
## API Modules Overview

This documentation covers the following core and business modules:

**Core Modules:**
- WPP.conn (Connection & Auth)
- WPP.chat (Messages & Chats)
- WPP.contact (Contacts)
- WPP.group (Groups)
- WPP.profile (User Profile)
- WPP.privacy (Privacy Settings)

**Business Modules:**
- WPP.blocklist (Blocked Contacts)
- WPP.catalog (Product Catalog)
- WPP.cart (Shopping Cart)
- WPP.order (Orders)
- WPP.labels (Chat Labels)
- WPP.lists (Chat Lists/Tabs)

**Channel & Community Modules:**
- WPP.status (Status Updates)
- WPP.newsletter (Channels)
- WPP.community (Communities)

**System Modules:**
- WPP.ev (Event Emitter)
- WPP.loader (Initialization)
- WPP.config (Configuration)
- WPP.util (Utilities)
- WPP.whatsapp (Internal Models)

Each module contains numerous functions with detailed signatures, parameters, return types, and code examples.
```

--------------------------------

### Run Specific WhatsApp Web Versions Locally

Source: https://github.com/wppconnect-team/wa-js/blob/main/README.md

Cleans the wa-source directory, builds the project, and then launches a specific WhatsApp Web version locally. Useful for testing or debugging particular versions.

```bash
npm run wa-source:clean

npm run build:prd

WA_VERSION="2.3000.1029560485" npm run launch:local
```

--------------------------------

### Get WhatsApp Web Build Constants

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Retrieves build constants and version information for the WhatsApp Web client. This can be useful for debugging or compatibility checks. Returns null if constants are unavailable.

```javascript
const buildConstants = WPP.conn.getBuildConstants();
console.log('Version:', buildConstants.VERSION_STR);
console.log('Primary:', buildConstants.PARSED.PRIMARY);
```

--------------------------------

### Get Contact

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/contact.md

Retrieves a contact's information using their unique ID.

```APIDOC
## Get Contact

### Description
Get a contact by ID.

### Method
`async function get(contactId: string | Wid): Promise<ContactModel | undefined>`

### Parameters
#### Path Parameters
- **contactId** (string | Wid) - Required - Contact ID (e.g., "[number]@c.us", "[number]@lid", "[number]@g.us")

### Returns
- **ContactModel | undefined** - Contact model or undefined if not found

### Example
```javascript
const contact = await WPP.contact.get('[number]@c.us');
console.log('Name:', contact.name);
console.log('Phone:', contact.id);
```
```

--------------------------------

### Local Development Commands

Source: https://github.com/wppconnect-team/wa-js/blob/main/CLAUDE.md

Commands to set up and launch the local development environment for WA-JS, allowing testing with specific WhatsApp Web versions.

```bash
# Local development
npm run build:dev && WA_VERSION=latest npm run launch:local
npm run build:dev && WA_VERSION=<version> npm run launch:local
```

--------------------------------

### Download and Format WhatsApp Source Bundles

Source: https://github.com/wppconnect-team/wa-js/blob/main/CLAUDE.md

Use these npm scripts to download and format WhatsApp Web bundles for debugging. The populate script fetches the latest 20 versions by default, or a specific version with the --version flag. The format script makes the code readable.

```bash
npm run wa-source:populate
npm run wa-source:populate -- --version <version>
```

```bash
npm run wa-source:format <version>
```

--------------------------------

### Get Community Participants

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/status-labels-community.md

Fetches all participants across a community. Requires the community ID.

```typescript
async function getParticipants(
  communityId: string | Wid
): Promise<ParticipantModel[]>
```

--------------------------------

### Discover Available Labels Functions

Source: https://github.com/wppconnect-team/wa-js/blob/main/README.md

Execute this command in your browser console to get a sorted list of all functions available for managing labels within the WPP.labels object. This is useful for discovering label-related functionalities.

```javascript
Object.keys(WPP.labels).sort()
```

--------------------------------

### Get Community Subgroups

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/status-labels-community.md

Retrieves all subgroups associated with a community. Requires the community ID.

```typescript
async function getSubgroups(
  communityId: string | Wid
): Promise<GroupModel[]>
```

--------------------------------

### isMainReady

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Check if the main UI is fully loaded and ready.

```APIDOC
## isMainReady

### Description
Check if the main UI is fully loaded and ready.

### Method
```typescript
function isMainReady(): boolean
```

### Returns
- **boolean**: True if main interface is loaded

```

--------------------------------

### Initialize on Ready State

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/README.md

Use the `onReady()` function to ensure that the WPP object is fully initialized and safe to use. Operations should be placed within this callback.

```javascript
WPP.loader.onReady(() => {
  // Safe to use WPP
});
```

--------------------------------

### Get Community Participants

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/status-labels-community.md

Retrieves all participants across a specified community. Requires the community ID.

```APIDOC
## getParticipants

### Description
Get all participants across the community.

### Method
```typescript
async function getParticipants(
  communityId: string | Wid
): Promise<ParticipantModel[]>
```

### Parameters
#### Path Parameters
- **communityId** (string | Wid) - Required - Community ID

### Response
#### Success Response (200)
- **ParticipantModel[]** - Array of participants
```

--------------------------------

### Get Community Subgroups

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/status-labels-community.md

Retrieves all subgroups associated with a specific community. Requires the community ID.

```APIDOC
## getSubgroups

### Description
Get all subgroups of a community.

### Method
```typescript
async function getSubgroups(
  communityId: string | Wid
): Promise<GroupModel[]>
```

### Parameters
#### Path Parameters
- **communityId** (string | Wid) - Required - Community ID

### Response
#### Success Response (200)
- **GroupModel[]** - Array of subgroups
```

--------------------------------

### Get Channel Subscribers

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/status-labels-community.md

Retrieve the list of subscribers for a channel you own. This returns an array of subscriber models.

```typescript
async function getSubscribers(
  channelId: string | Wid
): Promise<SubscriberModel[]>
```

--------------------------------

### Get All Groups

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/group.md

Retrieves a list of all groups the user is a part of. Useful for displaying a list of groups or iterating through them.

```typescript
async function getAllGroups(): Promise<GroupModel[]>
```

--------------------------------

### Configuration - Pre-Injection

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/README.md

Configure WA-JS settings before the script is loaded by setting the `WPPConfig` object on the `window`.

```APIDOC
## Configuration - Pre-Injection

### Description
Set configuration options before injecting `wppconnect-wa.js` by defining the `window.WPPConfig` object.

### Usage
```javascript
window.WPPConfig = {
  deviceName: 'My Bot',  // Device name shown to WhatsApp
  lockUi: false,         // Lock/unlock WhatsApp UI
  headless: false        // Headless mode
};
```
```

--------------------------------

### Listen for Loader Ready Event

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/events.md

Use the `onReady` callback to execute code only after the library has fully loaded. This is crucial for ensuring all WPP functionalities are available.

```javascript
WPP.loader.onReady(() => {
  console.log('WPP is ready!');
  WPP.chat.sendTextMessage('[number]@c.us', 'Hello');
});
```

```javascript
// Using the loader ready callback
WPP.loader.onReady(() => {
  console.log('Library version:', WPP.version);
  
  // Now safe to use WPP
  WPP.on('chat.new_message', (msg) => {
    console.log('Got message:', msg.body);
  });
});
```

--------------------------------

### Get A/B Prop Name by ID

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Retrieves the name of an A/B testing property using its ID.

```typescript
function getABPropName(propId: string): string
```

--------------------------------

### Get Authentication Code

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Retrieves the authentication code object, which can be either single-device or multi-device. This is used for pairing.

```typescript
function getAuthCode(): AuthCode
```

```typescript
{
  type: 'single',
  ref: string,
  keyPair: string,
  browserId: string,
  fullCode: string
}
```

```typescript
{
  type: 'multidevice',
  ref: string,
  staticKeyPair: string,
  identityKeyPair: string,
  secretKey: string,
  fullCode: string
}
```

--------------------------------

### Set Build Environment Variables

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/configuration.md

Configure build-time settings using environment variables, such as specifying the WhatsApp version for local launches or enabling debug logging during the build process.

```bash
# Specify WhatsApp version for testing
WA_VERSION="2.3000.1030110621" npm run launch:local

# Or use latest
WA_VERSION="latest" npm run launch:local

# Build with debug enabled
DEBUG="WA-JS:*" npm run build:dev
```

--------------------------------

### Get Message Reactions

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/chat.md

Retrieves all emoji reactions associated with a specific message. Requires the message ID.

```typescript
async function getReactions(
  messageId: string
): Promise<ReactionData[]>
```

--------------------------------

### Build and Version Information

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/module-exports.md

Methods for accessing build constants and checking WhatsApp version compatibility.

```APIDOC
## getBuildConstants

### Description
Retrieves the build constants for the current WhatsApp version.

### Method
`getBuildConstants()`

### Returns
- `BuildConstants | null`: An object containing build constants, or null if not available.

## isWhatsAppVersionGTE

### Description
Checks if the WhatsApp version is greater than or equal to a specified version.

### Method
`isWhatsAppVersionGTE(v)`

### Parameters
#### Path Parameters
- **v** (string) - Required - The version string to compare against.

### Returns
- `boolean`: True if the WhatsApp version is greater than or equal to `v`, false otherwise.

## isWhatsAppVersionLTE

### Description
Checks if the WhatsApp version is less than or equal to a specified version.

### Method
`isWhatsAppVersionLTE(v)`

### Parameters
#### Path Parameters
- **v** (string) - Required - The version string to compare against.

### Returns
- `boolean`: True if the WhatsApp version is less than or equal to `v`, false otherwise.
```

--------------------------------

### Create a New Product

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/business-features.md

Adds a new product to your business catalog. Requires product details such as name, price, and optionally description, currency, SKU, and visibility settings.

```typescript
async function createProduct(
  options: ProductCreateOptions
): Promise<ProductModel>
```

```javascript
const product = await WPP.catalog.createProduct({
  name: 'Widget',
  price: 19.99,
  description: 'A useful widget',
  currency: 'USD'
});
```

--------------------------------

### Get Chat Details

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/chat.md

Retrieves detailed information about a specific chat, including unread counts and other metadata.

```APIDOC
## get

### Description
Get chat details.

### Method
`get`

### Parameters
#### Path Parameters
- **chatId** (string | Wid) - Required - Chat ID

### Returns
#### Success Response (200)
- **ChatModel** - Chat model with all properties

### Response Example
```json
{
  "example": "{\"id\": \"[number]@c.us\", \"unreadCount\": 5, ...}"
}
```

### Request Example
```javascript
const chat = await WPP.chat.get('[number]@c.us');
console.log('Unread count:', chat.unreadCount);
```
```

--------------------------------

### Get Community Announcement Group

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/status-labels-community.md

Retrieves the announcement group for a specific community. Requires the community ID.

```APIDOC
## getAnnouncementGroup

### Description
Get the announcement group of a community.

### Method
```typescript
async function getAnnouncementGroup(
  communityId: string | Wid
): Promise<GroupModel>
```

### Parameters
#### Path Parameters
- **communityId** (string | Wid) - Required - Community ID

### Response
#### Success Response (200)
- **GroupModel** - Announcement group
```

--------------------------------

### Register Initialization Callback

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/module-exports.md

Use WPP.loader.onReady to register a callback function that will be executed once the library is fully initialized and ready.

```typescript
WPP.loader.onReady(callback)
```

--------------------------------

### Get Community Announcement Group

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/status-labels-community.md

Retrieves the announcement group for a specific community. Requires the community ID.

```typescript
async function getAnnouncementGroup(
  communityId: string | Wid
): Promise<GroupModel>
```

--------------------------------

### Build Commands for WA-JS

Source: https://github.com/wppconnect-team/wa-js/blob/main/CLAUDE.md

Commands for building the WA-JS library in production, development, or watch modes. Production builds are minified.

```bash
# Build
npm run build:prd        # Production build (minified) → dist/wppconnect-wa.js
npm run build:dev        # Development build (inline source maps)
npm run build:watch      # Watch mode
```

--------------------------------

### Get Label Color Palette

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/status-labels-community.md

Retrieves a list of available hex color codes that can be used for labels.

```typescript
async function getLabelColorPalette(): Promise<string[]>
```

--------------------------------

### Configure Auto Download Settings

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Sets the configuration for automatic media downloads. Pass a settings object to define download behavior.

```typescript
function setAutoDownloadSettings(settings: AutoDownloadSettings): void
```

--------------------------------

### Get My Status

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/profile-privacy.md

Retrieves the user's current status message (about text). Returns the status as a string.

```javascript
const status = await WPP.profile.getMyStatus();
console.log('My status:', status);
```

--------------------------------

### Get My Profile Name

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/profile-privacy.md

Retrieves the current user's display name. Returns the name as a string.

```javascript
const name = await WPP.profile.getMyProfileName();
console.log('My name:', name);
```

--------------------------------

### Set Configuration Early

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/configuration.md

Configure WPP before the script loads to ensure settings are applied correctly. Avoid setting configuration after the script has loaded, as changes may not take effect.

```javascript
// Correct: Before injecting
window.WPPConfig = { deviceName: 'Bot' };
<script src="wppconnect-wa.js"></script>

// Avoid: After script loads, changes may not apply
<script src="wppconnect-wa.js"></script>
<script>
  // Too late
  window.WPPConfig = { deviceName: 'Bot' };
</script>
```

--------------------------------

### Event Emitter Equivalents

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/module-exports.md

Demonstrates that event listener registration and emission can be performed using either the WPP.ev namespace or directly through the root WPP object. Use either method based on your preference or project conventions.

```typescript
WPP.ev.on('chat.new_message', handler);
WPP.on('chat.new_message', handler);
```

```typescript
WPP.ev.emit('event.name', data);
WPP.emit('event.name', data);
```

--------------------------------

### Get All Blocked Contacts

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/business-features.md

Use this function to retrieve a list of all blocked contact IDs. It returns an array of strings.

```javascript
const blocked = await WPP.blocklist.all();
console.log('Blocked contacts:', blocked);
```

--------------------------------

### Configuration - Runtime

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/README.md

Modify configuration settings at runtime and listen for configuration updates.

```APIDOC
## Configuration - Runtime

### Description
Change configuration values after the library has loaded and subscribe to configuration update events.

### Usage
```javascript
// Change at runtime
WPP.config.deviceName = 'New Name';

// Listen for config changes
WPP.on('config.update', (update) => {
  console.log('Config key changed:', update.key);
});
```
```

--------------------------------

### Get My User Lid

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Retrieves the current user's Lid, which is the legacy ID used for multi-device compatibility.

```typescript
function getMyUserLid(): Wid
```

--------------------------------

### Download WA Source Bundles

Source: https://github.com/wppconnect-team/wa-js/blob/main/CLAUDE.md

Commands to download WhatsApp Web source bundles for debugging. Supports downloading the latest versions, all versions, or specific versions, with an option to force re-download.

```bash
# WA source — download bundles (alpha included)
npm run wa-source:populate                          # latest 20 versions (default)
npm run wa-source:populate -- --all                # all versions
npm run wa-source:populate -- --version <version>  # single version
npm run wa-source:populate -- --force              # re-download existing
```

--------------------------------

### Get My Profile Picture

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/profile-privacy.md

Retrieves the URL of the user's current profile picture. Returns the URL as a string.

```typescript
async function getMyProfilePicture(): Promise<string>
```

--------------------------------

### Get Group Size Limit

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/group.md

Retrieve the maximum number of members allowed in a group. This function requires an asynchronous call.

```javascript
const limit = await WPP.group.getGroupSizeLimit();
console.log('Max members:', limit);
```

--------------------------------

### Select Descriptive Device Names

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/configuration.md

Set a `deviceName` in `window.WPPConfig` to include identifying information for your bot, such as application name, version, and environment. This aids in distinguishing instances.

```javascript
// Include identifying information
window.WPPConfig = {
  deviceName: 'MyApp-Bot-v2.1-Node14'
};

// Or use timestamp
window.WPPConfig = {
  deviceName: `Bot-${Date.now()}`
};
```

--------------------------------

### Get Cart Contents

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/business-features.md

Retrieve the current cart for a business chat. This returns a CartModel object containing items and the total.

```javascript
const cart = await WPP.cart.get('[number]@c.us');
console.log('Items:', cart.items);
console.log('Total:', cart.total);
```

--------------------------------

### Initialize with onReady

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/configuration.md

Use WPP.loader.onReady to ensure the WPP API is fully initialized before making calls. Avoid checking for the WPP object's existence directly, as it might not be ready.

```javascript
// Correct
WPP.loader.onReady(() => {
  // Safe to use WPP API
});

// Avoid: Checking if module exists
if (typeof WPP !== 'undefined') {
  // WPP might not be fully initialized
}
```

--------------------------------

### Waiting for Library Ready State

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/README.md

Shows how to use the `onReady` event to ensure the WPP API is safe to use, or by checking the `isReady` and `isAuthenticated` states.

```javascript
WPP.loader.onReady(() => {
  // Now safe to use WPP API
  console.log('Library ready');
});

// Or check state
if (WPP.isReady && WPP.conn.isAuthenticated()) {
  // Can use API immediately
}
```

--------------------------------

### Get A/B Testing Properties

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Retrieves A/B testing properties and experimental feature configurations. Returns a Map of configurations.

```typescript
function getABProps(): Map<string, ABPropConfig>
```

```typescript
function getABPropsMap(): Map<string, ABPropConfig>
```

--------------------------------

### Compare WhatsApp Web Versions

Source: https://github.com/wppconnect-team/wa-js/blob/main/README.md

Compares differences between two specified WhatsApp Web versions, providing an overview of module changes. Requires local versions to be downloaded via `npm run launch:local`.

```bash
./scripts/compare-wa-versions.sh 2.3000.1031980585 2.3000.1031992593
```

```bash
./scripts/compare-wa-versions.sh 2.3000.1031980585 2.3000.1031992593 WAWebUpdateUnreadChatAction
```

```bash
./scripts/compare-wa-versions.sh
```

--------------------------------

### Get History Sync Progress

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Retrieves the current progress of message history synchronization. Returns sync progress information.

```typescript
function getHistorySyncProgress(): HistorySyncProgress
```

--------------------------------

### Use Named Instances for Multiple Bots

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/configuration.md

When running multiple bots, build custom instances with distinct names (e.g., MYWPP) to manage them separately. This allows independent control and communication for each bot.

```javascript
// If multiple instances needed, build with different names
// Bot 1 uses default WPP
// Bot 2 uses MYWPP (custom build)

WPP.chat.sendTextMessage('1234@c.us', 'From bot 1');
MYWPP.chat.sendTextMessage('5678@c.us', 'From bot 2');
```

--------------------------------

### Prepare Authenticated Test Session

Source: https://github.com/wppconnect-team/wa-js/blob/main/README.md

Prepares an authenticated test session by running tests that require a logged-in state. This opens a real browser for QR code scanning and caches the session.

```bash
npm run test:prepare
```

--------------------------------

### Get Stream Data

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Retrieves the current connection stream mode and internal state. This is useful for monitoring the connection status.

```typescript
function getStreamData(): StreamData
```

```javascript
const streamData = WPP.conn.getStreamData();
console.log('Mode:', streamData.stream);
console.log('Info:', streamData.info);
```

--------------------------------

### Get Chat Details

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/chat.md

Retrieves detailed information about a specific chat, including its unread count. Requires the chat ID.

```javascript
const chat = await WPP.chat.get('[number]@c.us');
console.log('Unread count:', chat.unreadCount);
```

--------------------------------

### Get Message by ID

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/chat.md

Retrieves one or more messages using their unique IDs. Accepts a single ID or an array of IDs.

```typescript
async function getMessageById(
  ids: string | string[]
): Promise<MsgModel | MsgModel[]>

```

--------------------------------

### Get Label by ID

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/status-labels-community.md

Retrieves a specific label using its unique ID. Useful for fetching details of a single tag.

```typescript
async function getLabelById(
  labelId: string
): Promise<LabelModel>
```

--------------------------------

### createCollection

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/business-features.md

Creates a new product collection.

```APIDOC
## createCollection

### Description
Create a new product collection.

### Method
`WPP.catalog.createCollection(name, productIds?)`

### Parameters
#### Request Body
- **name** (string) - Required - Collection name
- **productIds** ((string | number)[]) - Optional - Initial products

### Returns
- `CollectionModel`: Created collection

### Example
```javascript
const newCollection = await WPP.catalog.createCollection('Summer Sale', ['product1', 'product2']);
```
```

--------------------------------

### Documentation Generation Command

Source: https://github.com/wppconnect-team/wa-js/blob/main/CLAUDE.md

Command to generate API documentation using TypeDoc.

```bash
# Docs
npm run docs:build       # Generate TypeDoc API docs
```

--------------------------------

### Get Status Updates from a Contact

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/status-labels-community.md

Retrieve all status updates posted by a specific contact. Requires the contact's ID.

```javascript
const statuses = await WPP.status.get('[number]@c.us');
```

--------------------------------

### Key Modules Overview

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/README.md

An overview of the primary modules available in the WA-JS library and their general purpose.

```APIDOC
## Key Modules

| Module |
|--------|
| `conn` | Connection, auth, device info | `WPP.conn.isAuthenticated()` |
| `chat` | Messages, chats | `WPP.chat.sendTextMessage(...)` |
| `contact` | Contacts, profiles | `WPP.contact.get(...)` |
| `group` | Groups, members, admin | `WPP.group.create(...)` |
| `profile` | User profile | `WPP.profile.getMyProfileName()` |
| `privacy` | Privacy settings | `WPP.privacy.get()` |
| `status` | Status updates | `WPP.status.sendTextStatus(...)` |
| `catalog` | Business catalog | `WPP.catalog.getProducts(...)` |
| `blocklist` | Blocked contacts | `WPP.blocklist.blockContact(...)` |
| `labels` | Chat labels (business) | `WPP.labels.getAllLabels()` |
| `lists` | Chat lists/tabs | `WPP.lists.create(...)` |
| `newsletter` | Channels | `WPP.newsletter.create(...)` |
| `community` | Communities | `WPP.community.create(...)` |
| `cart` | Shopping cart | `WPP.cart.add(...)` |
| `order` | Orders | `WPP.order.get(...)` |
| `ev` | Event emitter | `WPP.on('chat.new_message', ...)` |
```

--------------------------------

### Get Group Invite Code

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/group.md

Retrieve the invite code for a group, which can be used to generate an invite link. Requires the group ID.

```typescript
async function getInviteCode(
  groupId: string | Wid
): Promise<string>
```

```javascript
const code = await WPP.group.getInviteCode('groupid@g.us');
const link = 'https://chat.whatsapp.com/' + code;
console.log('Invite link:', link);
```

--------------------------------

### Get Group Participants

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/group.md

Retrieves all current members of a specified group. The returned array contains participant objects, each indicating if they are an admin.

```javascript
const members = await WPP.group.getParticipants('groupid@g.us');
members.forEach(member => {
  console.log('Member:', member.id.toString());
  console.log('Admin:', member.isAdmin);
});
```

--------------------------------

### Loader Functions

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/module-exports.md

Functions for managing the WPP initialization process. `onReady` registers a callback to be executed once the library is ready, and `injectLoader` is an internal function for injecting the loader script.

```APIDOC
## WPP.loader.onReady

### Description
Registers a callback function to be executed when the WPP library is fully initialized and ready.

### Method
`WPP.loader.onReady(callback: Function): void`

### Parameters
* **callback** (Function) - Required - The function to execute when the library is ready.

## WPP.loader.injectLoader

### Description
Internal function used to inject the WPP loader script into the page. This is typically handled automatically and not intended for direct user invocation.

### Method
`WPP.loader.injectLoader(): void`
```

--------------------------------

### Get My Business Catalog

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/business-features.md

Retrieves the catalog associated with the connected business account. Use this to fetch all catalog data for the current business.

```typescript
async function getMyCatalog(): Promise<CatalogModel>
```

```javascript
const catalog = await WPP.catalog.getMyCatalog();
console.log('Catalog:', catalog);
```

--------------------------------

### Run Smoke Tests

Source: https://github.com/wppconnect-team/wa-js/blob/main/README.md

Executes smoke tests which load the live wppconnect-wa.js bundle on web.whatsapp.com to verify public WPP module functions. No QR scan is needed.

```bash
npm test -- tests/smoke.spec.ts
```

--------------------------------

### Get Migration State

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Retrieves the current migration state, such as single to multi-device migration status. Returns a migration state object.

```typescript
function getMigrationState(): MigrationState
```

--------------------------------

### Get Business Profile Information

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/contact.md

Fetches business profile details for a given contact ID. The contact ID can be a string or a Wid.

```javascript
const profile = await WPP.contact.getBusinessProfile('[number]@c.us');
console.log('Business:', profile.description);
```

--------------------------------

### Accessing Models and Stores

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/README.md

Illustrates how to retrieve individual chat or contact models from their respective global stores and access their properties.

```javascript
// Get from store
const chat = WPP.whatsapp.ChatStore.get('[number]@c.us');
const contact = WPP.whatsapp.ContactStore.get('[number]@c.us');

// Access properties
console.log(chat.unreadCount);
console.log(contact.name);
```

--------------------------------

### getBuildConstants

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/connection.md

Retrieves the build constants and version information for WhatsApp Web. This function returns an object containing version details or null if unavailable.

```APIDOC
## getBuildConstants

### Description
Get WhatsApp Web build constants and version information.

### Method
```typescript
function getBuildConstants(): BuildConstants | null
```

### Returns
- `BuildConstants | null`: Object containing version constants or null if unavailable.

### BuildConstants Interface
- `VERSION_STR` (string): Full version string (e.g., "2.3000.1234567")
- `VERSION_BASE` (string): Base version
- `VERSION_PRIMARY` (string): Primary version number
- `VERSION_SECONDARY` (string): Secondary version number
- `VERSION_TERTIARY` (string): Tertiary version number
- `WINDOWS_BUILD` (string | null): Windows build number if applicable
- `PARSED` (object): Parsed version object with PRIMARY, SECONDARY, TERTIARY as numbers

### Example
```javascript
const buildConstants = WPP.conn.getBuildConstants();
console.log('Version:', buildConstants.VERSION_STR);
console.log('Primary:', buildConstants.PARSED.PRIMARY);
```
```

--------------------------------

### Get Contact by ID

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/contact.md

Retrieves a specific contact using their unique ID. Returns the contact model if found, otherwise undefined.

```typescript
async function get(
  contactId: string | Wid
): Promise<ContactModel | undefined>
```

```javascript
const contact = await WPP.contact.get('[number]@c.us');
console.log('Name:', contact.name);
console.log('Phone:', contact.id);
```

--------------------------------

### Launch Local Browser with Automatic Injection

Source: https://github.com/wppconnect-team/wa-js/blob/main/README.md

Launches a local browser with automatic injection of wa-js. This command also caches files in the wa-source directory for subsequent requests.

```bash
npm run launch:local
```

--------------------------------

### Sending Text Messages

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/README.md

Provides examples for sending basic text messages, messages with mentions, and messages that reply to a specific message.

```javascript
// Text message
WPP.chat.sendTextMessage('[number]@c.us', 'Hello!');

// With mentions
WPP.chat.sendTextMessage('[number]@c.us', 'Hi @123', {
  mentionedList: ['123@c.us']
});

// With reply
WPP.chat.sendTextMessage('[number]@c.us', 'Thanks!', {
  quotedMsg: messageId
});
```

--------------------------------

### List Connection Functions

Source: https://github.com/wppconnect-team/wa-js/blob/main/README.md

Lists all available functions within the WPP.conn module. Useful for discovering connection-related functionalities.

```javascript
Object.keys(WPP.conn).sort()
```

--------------------------------

### createProduct

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/business-features.md

Creates a new product in the user's catalog.

```APIDOC
## createProduct

### Description
Create a new product in your catalog.

### Method
`WPP.catalog.createProduct(options)`

### Parameters
#### Request Body
- **options** (ProductCreateOptions) - Required - Product details
  - **name** (string) - Required - Product name
  - **price** (number) - Required - Product price
  - **description** (string) - Optional - Product description
  - **currency** (string) - Optional - Currency code (e.g., "USD")
  - **sku** (string) - Optional - SKU identifier
  - **isHidden** (boolean) - Optional - Hide product from catalog

### Returns
- `ProductModel`: Created product

### Example
```javascript
const product = await WPP.catalog.createProduct({
  name: 'Widget',
  price: 19.99,
  description: 'A useful widget',
  currency: 'USD'
});
```
```

--------------------------------

### Run Full Test Project

Source: https://github.com/wppconnect-team/wa-js/blob/main/README.md

Executes the full test project, including smoke tests and any other *.spec.ts files. This may require an authenticated session for some tests.

```bash
npm test
```

--------------------------------

### Get Past Group Participants

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/group.md

Fetches a list of contacts who were previously part of the group but have since left or been removed. Requires the group ID.

```typescript
async function getPastParticipants(
  groupId: string | Wid
): Promise<ParticipantModel[]>
```

--------------------------------

### Build WA-JS with Custom Global Name

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/configuration.md

Execute the build command to generate the custom WA-JS build. This command compiles the project with the specified custom global name.

```bash
npm run build:prd
```

--------------------------------

### Get Order Details

Source: https://github.com/wppconnect-team/wa-js/blob/main/_autodocs/api-reference/business-features.md

Retrieves the details of a specific order using its chat ID and message ID. This function returns an OrderModel object.

```typescript
async function get(
  chatId: string | Wid,
  messageId: string
): Promise<OrderModel>
```
Tokens:
Raw