@wppconnect/wa-js 2.28.0 → 3.0.0

package/CHANGELOG.md

@@ -1,4 +1,4 @@
-# 2.28.0 (2023-10-29)
+# 3.0.0 (2024-03-09)
 
 
 

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

@@ -73,6 +73,14 @@ export interface ChatEventTypes {
          */
         ids: MsgKey[];
     };
+    /**
+     * On Message edit
+     */
+    'chat.msg_edited': {
+        chat: Wid;
+        id: string;
+        msg: MsgModel;
+    };
     'chat.live_location_start': {
         id: Wid;
         msgId: MsgKey;

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

@@ -22,3 +22,4 @@ import './registerPresenceChange';
 import './registerReactionsEvent';
 import './registerRevokeMessageEvent';
 import './registerLabelEvent';
+import './registerEditedMessageEvent';

package/dist/{whatsapp/misc/Locale.d.ts → chat/events/registerEditedMessageEvent.d.ts}

@@ -13,12 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-declare class LocaleClass {
-}
-/** @whatsapp 14296
- * @whatsapp 43725 >= 2.2204.13
- * @whatsapp 914296 >= 2.2222.8
- * @whatsapp 568064 >= 2.2230.8
- */
-export declare const Locale: LocaleClass;
 export {};

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

@@ -28,13 +28,13 @@ export interface DeleteMessageReturn {
  * @example
  * ```javascript
  * // Delete a message
- * WPP.chat.deleteMessage('[number]@callback.us', 'msgid');
+ * WPP.chat.deleteMessage('[number]@c.us', 'msgid');
  * // Delete a list of messages
- * WPP.chat.deleteMessage('[number]@callback.us', ['msgid1', 'msgid2]);
+ * WPP.chat.deleteMessage('[number]@c.us', ['msgid1', 'msgid2]);
  * // Delete a message and delete media
- * WPP.chat.deleteMessage('[number]@callback.us', 'msgid', true);
+ * WPP.chat.deleteMessage('[number]@c.us', 'msgid', true);
  * // Revoke a message
- * WPP.chat.deleteMessage('[number]@callback.us', 'msgid', true, true);
+ * WPP.chat.deleteMessage('[number]@c.us', 'msgid', true, true);
  * ```
  *
  * @category Message

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

@@ -36,6 +36,7 @@ export { getQuotedMsg } from './getQuotedMsg';
 export { getQuotedMsgKey } from './getQuotedMsgKey';
 export { getReactions } from './getReactions';
 export { getVotes } from './getVotes';
+export { keepMessage } from './keepMessage';
 export { ChatListOptions, list } from './list';
 export { markIsComposing } from './markIsComposing';
 export { markIsPaused } from './markIsPaused';
@@ -54,12 +55,13 @@ export { prepareRawMessage } from './prepareRawMessage';
 export { requestPhoneNumber } from './requestPhoneNumber';
 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 { sendOrderMessage } from './sendOrderMessage';
+export { OrderItems, OrderMessageOptions, sendOrderMessage, } from './sendOrderMessage';
 export { sendRawMessage } from './sendRawMessage';
 export { sendReactionToMessage } from './sendReactionToMessage';
-export { sendScheduledCallMessage } from './sendScheduledCallMessage';
+export { ScheduledCallMessageOptions, sendScheduledCallMessage, } from './sendScheduledCallMessage';
 export { sendTextMessage, TextMessageOptions } from './sendTextMessage';
 export { sendVCardContactMessage, VCardContact, } from './sendVCardContactMessage';
 export { starMessage, StarMessageReturn } from './starMessage';

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

@@ -0,0 +1,30 @@
+/*!
+ * Copyright 2023 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, MsgModel } from '../../whatsapp';
+/**
+ * Keep or unkeep a message in a group chat with expiration
+ *
+ * @example
+ * ```javascript
+ * // To keep a message in chat
+ * WPP.chat.keepMessage('true_[number]@c.us_ABCDEF', true);
+ *
+ * // To unkeep a message in chat
+ * WPP.chat.keepMessage('true_[number]@c.us_ABCDEF', false);
+ * ```
+ * @category Chat
+ */
+export declare function keepMessage(msgId: string | MsgKey, value?: boolean): Promise<MsgModel>;

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

@@ -0,0 +1,56 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+import { SendMessageOptions, SendMessageReturn } from '..';
+export interface GroupInviteMessage extends SendMessageOptions {
+    jpegThumbnail?: string;
+    inviteCode: string;
+    inviteCodeExpiration?: number;
+    groupId: string | Wid;
+    groupName?: string;
+    caption?: string;
+}
+/**
+ * Send a group invite message
+ *
+ * @example
+ * ```javascript
+ * WPP.chat.sendGroupInviteMessage(
+ *  '[number]@c.us',
+ *  {
+ *    inviteCode: '123',
+ *    groupId: '789@g.us'
+ *  }
+ * );
+ *
+ * // After a invite
+ * const result = await WPP.group.addParticipants('789@g.us', '123@c.us');
+ * const participant = result['123@c.us'];
+ * if (participant.invite_code) {
+ *   WPP.chat.sendGroupInviteMessage(
+ *     '123@c.us',
+ *     {
+ *       inviteCode: participant.invite_code,
+ *       inviteCodeExpiration: participant.invite_code_exp,
+ *       groupId: '789@g.us'
+ *     }
+ *   );
+ * }
+ * ```
+ *
+ * @category Message
+ */
+export declare function sendGroupInviteMessage(chatId: any, options: GroupInviteMessage): Promise<SendMessageReturn>;

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

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2023 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 { ContactModel, Wid } from '../../whatsapp';
+/**
+ * Get a contact by id
+ *
+ * @example
+ * ```javascript
+ * await WPP.contact.get('[number]@c.us');
+ * ```
+ *
+ * @category Contact
+ */
+export declare function get(contactId: string | Wid): Promise<ContactModel | undefined>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2021 WPPConnect Team
+ * Copyright 2023 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export { get } from './get';
 export { getBusinessProfile } from './getBusinessProfile';
 export { getCommonGroups } from './getCommonGroups';
 export { getProfilePictureUrl } from './getProfilePictureUrl';

package/dist/profile/functions/getMyProfileName.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * 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.
+ */
+/**
+ * Get your current profile name
+ *
+ * @example
+ * ```javascript
+ * const myProfileName = WPP.profile.getMyProfileName();
+ * ```
+ *
+ * @category Profile
+ */
+export declare function getMyProfileName(): string;

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

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 export { editBusinessProfile } from './editBusinessProfile';
+export { getMyProfileName } from './getMyProfileName';
 export { getMyStatus } from './getMyStatus';
 export { isBusiness } from './isBusiness';
 export { removeMyProfilePicture } from './removeMyProfilePicture';

package/dist/webpack/index.d.ts

@@ -13,6 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * Is setted true when the loader is injected
+ */
+export declare let loaderType: 'meta' | 'unknown' | 'webpack';
 /**
  * Is setted true when the loader is injected
  */
@@ -29,6 +33,11 @@ export declare function onInjected(listener: () => void, delay?: number): void;
 export declare function onReady(listener: () => void, delay?: number): void;
 export declare function onFullReady(listener: () => void, delay?: number): void;
 export type SearchModuleCondition = (module: any, moduleId: string) => boolean;
+export declare const __debug: () => {
+    modulesMap: {
+        [key: string]: any;
+    };
+};
 export declare let webpackRequire: (<T = any>(moduleId: string) => T) & {
     /**
      * module list

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

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2023 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 982015
+ */
+export declare enum KIC_ENTRY_POINT_TYPE {
+    CHAT_INFO = 1,
+    SEARCH = 2,
+    CHAT = 3,
+    MEDIA = 4,
+    DOCS = 5,
+    LINKS = 6
+}

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

@@ -16,6 +16,7 @@
 export * from './ACK';
 export * from './CALL_STATES';
 export * from './GROUP_SETTING_TYPE';
+export * from './KIC_ENTRY_POINT_TYP';
 export * from './LogoutReason';
 export * from './MSG_TYPE';
 export * from './OUTWARD_TYPES';

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

@@ -0,0 +1,21 @@
+/*!
+ * Copyright 2023 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 355813
+ */
+export declare function GROUP_JID(jid: Wid): any;
+export declare function CHAT_JID(jid: Wid): any;

package/dist/whatsapp/functions/forwardMessagesToChats.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 { ChatModel, MsgModel } from '../models';
+/** @whatsapp 69951
+ * @whatsapp 450192 >= 2.2353.0
+ */
+export declare function forwardMessagesToChats(msgs: MsgModel[], chats: ChatModel[], displayCaptionText?: boolean): Promise<boolean>;

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

@@ -0,0 +1,19 @@
+/*!
+ * Copyright 2023 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 135963 >= 2.2310.5
+ */
+export declare function getPushname(): string;

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

@@ -41,6 +41,7 @@ export * from './fetchLinkPreview';
 export * from './findChat';
 export * from './findCommonGroups';
 export * from './findFirstWebLink';
+export * from './forwardMessagesToChats';
 export * from './frontendFireAndForget';
 export * from './generateVideoThumbsAndDuration';
 export * from './genLinkDeviceCodeForPhoneNumber';
@@ -59,11 +60,13 @@ export * from './getMembershipApprovalRequests';
 export * from './getNumChatsPinned';
 export * from './getOrderInfo';
 export * from './getParticipants';
+export * from './getPushname';
 export * from './getQuotedMsgObj';
 export * from './getReactions';
 export * from './getSearchContext';
 export * from './getVotes';
 export * from './getWhatsAppWebExternalBetaJoinedIdb';
+export * from './GROUP_JID';
 export * from './groupParticipants';
 export * from './handleAck';
 export * from './handleSingleMsg';
@@ -73,6 +76,7 @@ export * from './isAuthenticated';
 export * from './isRegistered';
 export * from './isUnreadTypeMsg';
 export * from './joinGroupViaInvite';
+export * from './keepMessage';
 export * from './markSeen';
 export * from './mediaTypeFromProtobuf';
 export * from './membershipApprovalRequestAction';

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

@@ -0,0 +1,23 @@
+/*!
+ * Copyright 2023 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 { MsgModel } from '..';
+/**
+ * @whatsapp 170235
+ */
+export declare function keepMessage(msg: MsgModel, t: number): Promise<any>;
+export declare function undoKeepMessage(msg: MsgModel, options: {
+    deleteExpired: boolean;
+}, n: number): Promise<any>;

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

@@ -21,7 +21,6 @@ export * from './Conn';
 export * from './Constants';
 export * from './EventEmitter';
 export * from './ImageUtils';
-export * from './Locale';
 export * from './MediaBlobCache';
 export * from './MediaEntry';
 export * from './MediaObject';