@wppconnect/wa-js 3.5.0 → 3.7.0

package/README.md

@@ -47,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/cart/functions/add.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * 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.
+ */
+import { CartModel } from '../../whatsapp';
+export declare function add(chatId: string, products: {
+    id: string;
+    qnt: number;
+}[]): Promise<CartModel | undefined>;

package/dist/cart/functions/clear.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 declare function clear(wid: string): Promise<void>;

package/dist/cart/functions/get.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * 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.
+ */
+/**
+ * Get products in cart chat
+ *
+ * @example
+ * ```javascript
+ * const cart = WPP.cart.get('[number]@c.us');
+ * ```
+ *
+ * @category Cart
+ */
+import { CartModel } from '../../whatsapp';
+export declare function get(wid: string): CartModel | undefined;

package/dist/cart/functions/getThumbFromCart.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 declare function getThumbFromCart(wid: string): Promise<string>;

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

@@ -0,0 +1,22 @@
+/*!
+ * 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 { add } from './add';
+export { clear } from './clear';
+export { get } from './get';
+export { getThumbFromCart } from './getThumbFromCart';
+export { remove } from './remove';
+export { submit } from './submit';
+export { update } from './update';

package/dist/cart/functions/remove.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * 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.
+ */
+import { CartModel } from '../../whatsapp';
+export declare function remove(chatId: string, productId: string): Promise<CartModel | undefined>;

package/dist/cart/functions/submit.d.ts

@@ -0,0 +1,33 @@
+/*!
+ * 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.
+ */
+/**
+ * Send a request order to business chat
+ *
+ * @example
+ * ```javascript
+ * const cart = WPP.cart.submit('[number]@c.us');
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Send cart with a custom message
+ * const cart = WPP.cart.submit('[number]@c.us', 'Custom message here');
+ * ```
+ *
+ * @category Cart
+ */
+import { SendMessageOptions } from '../../chat';
+export declare function submit(wid: string, msg?: string, options?: SendMessageOptions): Promise<any>;

package/dist/cart/functions/update.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * 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.
+ */
+import { CartModel } from '../../whatsapp';
+export declare function update(chatId: string, productId: string, options: {
+    quantity: number;
+}): Promise<CartModel | undefined>;

package/dist/cart/index.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 * from './functions';

package/dist/catalog/functions/getProductById.d.ts

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { ProductModel } from '../../whatsapp';
 /**
  * Retrieves product by id
  *
@@ -25,4 +24,27 @@ import { ProductModel } from '../../whatsapp';
  *
  * @category Catalog
  */
-export declare function getProductById(chatId: string, productId: number): Promise<ProductModel>;
+export declare function getProductById(chatId: string, productId: number): Promise<{
+    id: string;
+    retailer_id: string;
+    name: string;
+    description: string;
+    url: string;
+    currency: string;
+    price: string;
+    is_hidden: boolean;
+    max_available: number;
+    availability: string;
+    checkmark: boolean;
+    image_hashes_for_whatsapp: string[];
+    image_cdn_urls: {
+        key: 'requested' | 'full';
+        value: string;
+    }[];
+    additional_image_cdn_urls: any[];
+    whatsapp_product_can_appeal: boolean;
+    capability_to_review_status: {
+        key: 'WHATSAPP';
+        value: 'APPROVED';
+    }[];
+}>;

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';
@@ -54,12 +55,12 @@ export { LinkPreviewOptions, prepareLinkPreview } from './prepareLinkPreview';
 export { MessageButtonsOptions, prepareMessageButtons, } from './prepareMessageButtons';
 export { prepareRawMessage } from './prepareRawMessage';
 export { requestPhoneNumber } from './requestPhoneNumber';
+export { OrderItems, OrderMessageOptions, sendChargeMessage, } from './sendChargeMessage';
 export { PoolMessageOptions, sendCreatePollMessage, } from './sendCreatePollMessage';
 export { AudioMessageOptions, AutoDetectMessageOptions, DocumentMessageOptions, FileMessageOptions, ImageMessageOptions, sendFileMessage, StickerMessageOptions, VideoMessageOptions, } from './sendFileMessage';
 export { GroupInviteMessage, sendGroupInviteMessage, } from './sendGroupInviteMessage';
 export { ListMessageOptions, sendListMessage } from './sendListMessage';
 export { LocationMessageOptions, sendLocationMessage, } from './sendLocationMessage';
-export { OrderItems, OrderMessageOptions, sendOrderMessage, } from './sendOrderMessage';
 export { sendPixKeyMessage } from './sendPixKeyMessage';
 export { sendRawMessage } from './sendRawMessage';
 export { sendReactionToMessage } from './sendReactionToMessage';

package/dist/chat/functions/{sendOrderMessage.d.ts → sendChargeMessage.d.ts}

@@ -34,19 +34,19 @@ export interface OrderMessageOptions extends SendMessageOptions {
  *
  * @example
  * ```javascript
- * // Send Order with a product
- * WPP.chat.sendOrderMessage('[number]@c.us', [
+ * // Send charge with a product
+ * WPP.chat.sendChargeMessage('[number]@c.us', [
  *   { type: 'product', id: '67689897878', qnt: 2 },
  *   { type: 'product', id: '37878774457', qnt: 1 },
  * ]
  *
- * // Send Order with a custom item
- * WPP.chat.sendOrderMessage('[number]@c.us', [
+ * // Send charge with a custom item
+ * WPP.chat.sendChargeMessage('[number]@c.us', [
  *   { type: 'custom', name: 'Item de cost test', price: 120000, qnt: 2 },
  * ]
  *
- * // Send Order with custom options
- * WPP.chat.sendOrderMessage('[number]@c.us', [
+ * // Send charge with custom options
+ * WPP.chat.sendChargeMessage('[number]@c.us', [
  *   { type: 'product', id: '37878774457', qnt: 1 },
  *   { type: 'custom', name: 'Item de cost test', price: 120000, qnt: 2 },
  * ],
@@ -54,4 +54,4 @@ export interface OrderMessageOptions extends SendMessageOptions {
  * ```
  * @category Message
  */
-export declare function sendOrderMessage(chatId: any, items: OrderItems[], options?: OrderMessageOptions): Promise<SendMessageReturn>;
+export declare function sendChargeMessage(chatId: any, items: OrderItems[], options?: OrderMessageOptions): Promise<SendMessageReturn>;

package/dist/index.d.ts

@@ -22,6 +22,7 @@ export { isInjected, isReady, isFullReady } from './webpack';
 export { config, Config } from './config';
 export * as blocklist from './blocklist';
 export * as call from './call';
+export * as cart from './cart';
 export * as catalog from './catalog';
 export * as chat from './chat';
 export * as conn from './conn';

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

@@ -0,0 +1,23 @@
+/*!
+ * 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.
+ */
+import { ProductModel } from '../models';
+export declare function addProductToCart(product: ProductModel): Promise<{
+    newCount: number;
+    status: 'SUCCESS' | 'QUANTITY_LIMIT_REACHED';
+    totalCartCount: number;
+}>;
+export declare function updateProductQuantityCart(product: ProductModel, quantity: number): Promise<any>;
+export declare function deleteProductFromCart(chatId: string, productId: string): Promise<any>;

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

@@ -0,0 +1,24 @@
+/*!
+ * 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.
+ */
+import { Wid } from '../misc';
+/**
+ * @whatsapp 990553
+ */
+export declare function createOrder(wid: Wid, cartItems?: any): Promise<{
+    id: number;
+    token: any;
+    price?: any;
+}>;

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

@@ -15,6 +15,7 @@
  */
 export * from './addAndSendMessageEdit';
 export * from './addAndSendMsgToChat';
+export * from './addProductToCart';
 export * from './addToLabelCollection';
 export * from './blockContact';
 export * from './calculateFilehashFromBlob';
@@ -29,6 +30,7 @@ export * from './createFanoutMsgStanza';
 export * from './createGroup';
 export * from './createMsgProtobuf';
 export * from './createNewsletterQuery';
+export * from './createOrder';
 export * from './createOrUpdateReactions';
 export * from './currencyForCountryShortcode';
 export * from './deleteNewsletter';
@@ -134,6 +136,7 @@ export * from './syncABPropsTask';
 export * from './typeAttributeFromProtobuf';
 export * from './unixTime';
 export * from './unmuteNewsletter';
+export * from './updateCart';
 export * from './updateCartEnabled';
 export * from './updateDBForGroupAction';
 export * from './updateNewsletterMsgRecord';

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

@@ -0,0 +1,20 @@
+/*!
+ * 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.
+ */
+import { CartModel } from '../models';
+/**
+ * @whatsapp 990553
+ */
+export declare function updateCart(cart: CartModel, c?: number): Promise<void>;

package/dist/whatsapp/misc/MsgKey.d.ts

@@ -43,5 +43,5 @@ export declare class MsgKey {
     /**
      * @whatsapp >= 2.2208.7
      */
-    static newId(): string;
+    static newId(): Promise<string>;
 }

package/dist/whatsapp/models/CartItemModel.d.ts

@@ -19,6 +19,7 @@ interface Props {
     id?: any;
     priceAmount1000?: any;
     currency?: any;
+    name?: string;
     quantity?: any;
     imageHash?: any;
     imageCdnUrl?: any;