talkyzap-wapp-api 1.0.3 → 1.0.4

package/CHANGELOG.md

@@ -1,9 +1,9 @@
-## 3.3.1 (2024-06-09)
+# 3.5.0 (2024-07-12)
 
 
-### Bug Fixes
+### Features
 
-* Fixed delete messages for me ([5cdf157](https://github.com/wppconnect-team/wa-js/commit/5cdf157ae1c7ad02ff099979cf6a0a949c436ee0))
+* Added 'conn.logout_reason' event (close [#1899](https://github.com/wppconnect-team/wa-js/issues/1899)) ([2466c30](https://github.com/wppconnect-team/wa-js/commit/2466c30cad19eaa14c2119e476d44b2e2e61d265))
 
 
 

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/call/functions/end.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2023 WPPConnect Team
+ * 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.
@@ -14,18 +14,18 @@
  * limitations under the License.
  */
 /**
- * End a outcoming call
+ * End a call
  *
  * @example
  * ```javascript
- * // End any outcoming call
+ * // End any call
  * WPP.call.end();
  *
  * // End specific call id
  * WPP.call.end(callId);
  *
- * // End any outcoming call
- * WPP.on('call.outcoming_call', (call) => {
+ * // End any incoming call
+ * WPP.on('call.incoming_call', (call) => {
  *   WPP.call.end(call.id);
  * });
  * ```

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

@@ -60,6 +60,7 @@ export { GroupInviteMessage, sendGroupInviteMessage, } from './sendGroupInviteMe
 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';
 export { ScheduledCallMessageOptions, sendScheduledCallMessage, } from './sendScheduledCallMessage';

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

@@ -0,0 +1,53 @@
+/*!
+ * 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 { SendMessageOptions, SendMessageReturn } from '..';
+export interface OrderItems {
+    type: 'product' | 'custom';
+    id?: number[] | string[];
+    name?: string;
+    price?: number;
+    qnt?: number;
+}
+export interface OrderMessageOptions extends SendMessageOptions {
+    notes?: string;
+    discount?: number;
+    tax?: number;
+    shipping?: number;
+    offset?: number;
+}
+/**
+ * Send a invoice message
+ * To send (prices, tax, shipping or discount), for example: USD 12.90, send them without dots or commas, like: 12900
+ *
+ * @example
+ * ```javascript
+ * // Send PIX Key Message (Brazil Pix Key)
+ * WPP.chat.sendPixKeyMessage('[number]@c.us', {
+ *     keyType: 'CNPJ',
+ *     name: 'WPPCONNECT-TEAM',
+ *     key: '33460516000178',
+ *     instructions: 'Pay text for instructions here',
+ * });
+ *
+ * ```
+ * @category Message
+ */
+export declare function sendPixKeyMessage(chatId: any, params: {
+    keyType: 'CNPJ' | 'CPF' | 'PHONE' | 'EMAIL' | 'EVP';
+    name: string;
+    key: string;
+    instructions?: string;
+}, options?: SendMessageOptions): Promise<SendMessageReturn>;

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/order/functions/get.d.ts

@@ -13,9 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { MsgKey } from '../../whatsapp';
+import { MsgKey, OrderModel } from '../../whatsapp';
 /**
- * Get info of your sended order
+ * Get info of a order
  *
  * @example
  * ```javascript
@@ -24,4 +24,4 @@ import { MsgKey } from '../../whatsapp';
  *
  * @return Your current catalog
  */
-export declare function get(msgId: string | MsgKey): Promise<boolean>;
+export declare function get(msgId: string | MsgKey): Promise<OrderModel>;

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

@@ -15,6 +15,7 @@
  */
 export { get } from './get';
 export { getMyStatus } from './getMyStatus';
+export { remove } from './remove';
 export { ImageStatusOptions, sendImageStatus } from './sendImageStatus';
 export { sendRawStatus, SendStatusOptions } from './sendRawStatus';
 export { sendReadStatus } from './sendReadStatus';

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

@@ -0,0 +1,17 @@
+/*!
+ * 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 '../../whatsapp';
+export declare function remove(msgId: string | MsgKey): Promise<boolean>;

package/dist/status/functions/sendRawStatus.d.ts

@@ -18,5 +18,6 @@ import { MsgKey } from '../../whatsapp';
 export interface SendStatusOptions {
     waitForAck?: boolean;
     messageId?: string | MsgKey;
+    caption?: string;
 }
 export declare function sendRawStatus(message: Chat.RawMessage, options?: SendStatusOptions): Promise<Chat.SendMessageReturn>;

package/dist/status/functions/sendTextStatus.d.ts

@@ -18,7 +18,6 @@ import { SendStatusOptions } from './sendRawStatus';
 export interface TextStatusOptions extends SendStatusOptions {
     font?: TextFontStyle;
     backgroundColor?: string | number;
-    textColor?: string | number;
 }
 /**
  * Send a text message to status stories

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/STATUS_JID.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.
+ */
+/**
+ * @whatsapp WAJids
+ */
+export declare const STATUS_JID: string;

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

@@ -26,3 +26,20 @@ export declare function createGroup(groupName: string, participants: Wid[], ephe
         invite_code_exp: string | null;
     }[];
 }>;
+export declare function createGroup(options: {
+    title: string;
+    ephemeralDuration: number;
+    restrict: boolean;
+    announce: boolean;
+    membershipApprovalMode: boolean;
+    memberAddMode: boolean;
+    parentGroupId?: Wid;
+}, participants: Wid[]): Promise<{
+    wid: Wid;
+    participants: {
+        wid: Wid;
+        error: string;
+        invite_code: string | null;
+        invite_code_exp: string | null;
+    }[];
+}>;

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

@@ -25,5 +25,6 @@ export interface ReactionData {
 }
 /** @whatsapp 7394
  * @whatsapp 307394 >= 2.2222.8
+ * @whatsapp WAWebReactionsMsgAction >= 2.3000.x
  */
 export declare function createOrUpdateReactions(data: ReactionData[]): Promise<any>;

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

@@ -0,0 +1,35 @@
+/*!
+ * 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, Wid } from '../misc';
+import { MsgModel } from '../models';
+/**
+ * @whatsapp WAWebEncryptAndSendStatusMsg
+ */
+export declare function encryptAndSendStatusMsg(msg: {
+    msg: {
+        type: string;
+        data: MsgModel;
+    };
+    data: {
+        ack: number;
+        author?: Wid;
+        from: Wid;
+        id: MsgKey;
+        subtype?: string;
+        to: Wid;
+        type: string;
+    };
+}, proto: any, report: any): Promise<any>;

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

@@ -38,6 +38,7 @@ export * from './encodeMaybeMediaType';
 export * from './encryptAndSendGroupMsg';
 export * from './encryptAndSendMsg';
 export * from './encryptAndSendSenderKeyMsg';
+export * from './encryptAndSendStatusMsg';
 export * from './encryptMsgProtobuf';
 export * from './fetchLinkPreview';
 export * from './findChat';
@@ -54,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';
@@ -101,9 +103,11 @@ export * from './profilePic';
 export * from './queryAllGroups';
 export * from './queryGroupInviteCode';
 export * from './queryNewsletterMetadataByJid';
+export * from './queryOrder';
 export * from './randomHex';
 export * from './randomId';
 export * from './resetGroupInviteCode';
+export * from './revokeStatus';
 export * from './sendClear';
 export * from './sendCreateCommunity';
 export * from './sendCreateGroup';
@@ -124,6 +128,8 @@ export * from './setGroup';
 export * from './setPin';
 export * from './setPushname';
 export * from './status';
+export * from './STATUS_JID';
+export * from './statusEnable';
 export * from './syncABPropsTask';
 export * from './typeAttributeFromProtobuf';
 export * from './unixTime';

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

@@ -0,0 +1,32 @@
+/*!
+ * 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.
+ */
+/** @whatsapp WAWebBizQueryOrderJob >= 2.30000.0 */
+export declare function queryOrder(productId: string, imageWidth: number, imageHeight: number, token: string, e?: any): Promise<{
+    currency: string;
+    createdAt: number;
+    products: {
+        id: string;
+        price: number;
+        thumbnailId: string;
+        thumbnailUrl: string;
+        currency: string;
+        name: string;
+        quantity: number;
+    }[];
+    subtotal: number;
+    total: number;
+    tax: number | null;
+}>;

package/dist/whatsapp/functions/revokeStatus.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 { ChatModel, MsgModel } from '../models';
+/**
+ * @whatsapp WAWebRevokeStatusAction
+ */
+export declare function revokeStatus(chat: ChatModel, msg: MsgModel): Promise<any>;

package/dist/whatsapp/functions/statusEnable.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.
+ */
+/**
+ * @whatsapp WAWebStatusSendGatingUtils >= 2.3000.0
+ */
+export declare function primaryFeatureEnabled(key: string): boolean;

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

@@ -38,6 +38,7 @@ export declare class Wid {
     isPSA(): boolean;
     isServer(): boolean;
     isStatusV3(): boolean;
+    isStatus(): boolean;
     isUser(): boolean;
     isLid(): boolean;
     isUserNotPSA(): boolean;
@@ -60,6 +61,7 @@ export declare class Wid {
     static isPSA(wid: string | Wid): boolean;
     static isServer(wid: string | Wid): boolean;
     static isStatusV3(wid: string | Wid): boolean;
+    static isStatus(wid: string | Wid): boolean;
     static isUser(wid: string | Wid): boolean;
     static isLid(wid: string | Wid): boolean;
     static isWid(wid: string | Wid): boolean;

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

@@ -19,7 +19,6 @@ export * from './BlocklistModel';
 export * from './BusinessCategoriesResultModel';
 export * from './BusinessProfileModel';
 export * from './CallModel';
-export * from './CallParticipantModel';
 export * from './CartItemModel';
 export * from './CartModel';
 export * from './CatalogModel';