@wppconnect/wa-js 2.26.1 → 2.28.0

package/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 2.26.1 (2023-09-13)
+# 2.28.0 (2023-10-29)
 
 
 

package/dist/chat/functions/get.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.

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

@@ -59,6 +59,7 @@ export { LocationMessageOptions, sendLocationMessage, } from './sendLocationMess
 export { sendOrderMessage } from './sendOrderMessage';
 export { sendRawMessage } from './sendRawMessage';
 export { sendReactionToMessage } from './sendReactionToMessage';
+export { sendScheduledCallMessage } from './sendScheduledCallMessage';
 export { sendTextMessage, TextMessageOptions } from './sendTextMessage';
 export { sendVCardContactMessage, VCardContact, } from './sendVCardContactMessage';
 export { starMessage, StarMessageReturn } from './starMessage';

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

@@ -73,9 +73,6 @@ export interface AudioMessageOptions extends FileMessageOptions {
      */
     waveform?: boolean;
 }
-export interface PushToVideoMessageOptions extends FileMessageOptions {
-    type: 'ptv';
-}
 export interface DocumentMessageOptions extends FileMessageOptions, MessageButtonsOptions {
     type: 'document';
 }
@@ -89,6 +86,7 @@ export interface StickerMessageOptions extends FileMessageOptions {
 export interface VideoMessageOptions extends FileMessageOptions, MessageButtonsOptions {
     type: 'video';
     isGif?: boolean;
+    isPtv?: boolean;
 }
 /**
  * Send a file message, that can be an audio, document, image, sticker or video
@@ -172,11 +170,12 @@ export interface VideoMessageOptions extends FileMessageOptions, MessageButtonsO
  *  '[number]@c.us',
  *  'data:application/msword;base64,<a long base64 file...>',
  *  {
- *    type: 'ptv',
+ *    type: 'video',
+ *    isPtv: true,
  *  }
  * );
  * ```
  * @category Message
  * @return  {SendMessageReturn} The result
  */
-export declare function sendFileMessage(chatId: any, content: string | Blob | File, options: AutoDetectMessageOptions | AudioMessageOptions | DocumentMessageOptions | ImageMessageOptions | VideoMessageOptions | StickerMessageOptions | PushToVideoMessageOptions): Promise<SendMessageReturn>;
+export declare function sendFileMessage(chatId: any, content: string | Blob | File, options: AutoDetectMessageOptions | AudioMessageOptions | DocumentMessageOptions | ImageMessageOptions | VideoMessageOptions | StickerMessageOptions): Promise<SendMessageReturn>;

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

@@ -0,0 +1,40 @@
+/*!
+ * 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 { SendMessageOptions, SendMessageReturn } from '..';
+export declare enum SCHEDULED_CALL_TYPE {
+    UNKNOWN = 0,
+    VOICE = 1,
+    VIDEO = 2
+}
+export interface ScheduledCallMessageOptions extends SendMessageOptions {
+    scheduledTimestampMs: number | string;
+    callType: 'video' | 'voice' | SCHEDULED_CALL_TYPE;
+    title: string;
+}
+/**
+ * Send a scheduled call message
+ *
+ * @example
+ * ```javascript
+ * WPP.chat.sendScheduledCallMessage('[number]@c.us', {
+ *  title: "Title of event"
+ *  callType: 'voice'
+ *  scheduledTimestampMs: 1696084222000
+ * });
+ * ```
+ * @category Message
+ */
+export declare function sendScheduledCallMessage(chatId: any, options: ScheduledCallMessageOptions): Promise<SendMessageReturn>;

package/dist/chat/types.d.ts

@@ -95,6 +95,18 @@ export interface SendMessageOptions {
      * ```
      */
     waitForAck?: boolean;
+    /**
+     * Delay some time (in ms) before sending message
+     * While delaying, Typing Status is used to look like a human interaction
+     * @default 0
+     * @example
+     * ```javascript
+     * WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
+     *   delay: 4000
+     * })
+     * ```
+     */
+    delay?: number;
 }
 export interface SendMessageReturn {
     id: string;

package/dist/conn/functions/genLinkDeviceCodeForPhoneNumber.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.
+ */
+/**
+ * Alternative login method using code
+ * Get the Link Device Code for Authentication using the phone number
+ *
+ * @example
+ * ```javascript
+ * const code = await WPP.conn.genLinkDeviceCodeForPhoneNumber('[number]');
+ *
+ * // Disable push notification
+ * const code = await WPP.conn.genLinkDeviceCodeForPhoneNumber('[number]', false);
+ * ```
+ *
+ * @category Conn
+ */
+export declare function genLinkDeviceCodeForPhoneNumber(phone: string, sendPushNotification?: boolean): Promise<string>;

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

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export { genLinkDeviceCodeForPhoneNumber } from './genLinkDeviceCodeForPhoneNumber';
 export { getAuthCode } from './getAuthCode';
 export { getHistorySyncProgress, HistorySyncProgress, } from './getHistorySyncProgress';
 export { getMyDeviceId } from './getMyDeviceId';

package/dist/contact/functions/getCommonGroups.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 { Wid } from '../../whatsapp';
+/**
+ * Get all commons groups for the contact
+ *
+ * @example
+ * ```javascript
+ * const groups_ids = await WPP.contact.getCommonGroups('[number]@c.us');
+ * ```
+ *
+ * @category Contact
+ */
+export declare function getCommonGroups(wid: Wid | string): Promise<Wid[]>;

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

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 export { getBusinessProfile } from './getBusinessProfile';
+export { getCommonGroups } from './getCommonGroups';
 export { getProfilePictureUrl } from './getProfilePictureUrl';
 export { getStatus } from './getStatus';
 export { ContactListOptions, list } from './list';

package/dist/index.d.ts

@@ -33,6 +33,7 @@ export * as labels from './labels';
 export * as profile from './profile';
 export * as status from './status';
 export * as util from './util';
+export * as newsletter from './newsletter';
 export * as whatsapp from './whatsapp';
 export * as order from './order';
 export { emit, emitAsync, eventNames, getMaxListeners, hasListeners, listenTo, listenerCount, listeners, listenersAny, many, off, offAny, on, onAny, once, prependAny, prependListener, prependMany, prependOnceListener, removeAllListeners, removeListener, setMaxListeners, stopListeningTo, waitFor, } from './eventEmitter';

package/dist/newsletter/functions/create.d.ts

@@ -0,0 +1,42 @@
+/*!
+ * 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.
+ */
+export interface ResultCreateNewsletter {
+    idJid: string;
+    inviteCode: string;
+    inviteLink: string;
+    name: string;
+    state: string;
+    subscribersCount: number;
+    description: string | null;
+    timestamp: number;
+}
+/**
+ * Create a newsletter
+ *
+ * @example
+ * ```javascript
+ * // To edit name
+ * WPP.newsletter.create('Name for your newsletter', {
+ * description: 'Description for that',
+ * picture: '<base64_string',
+ * });
+ * ```
+ * @category Newsletter
+ */
+export declare function create(name: string, opts: {
+    description?: string;
+    picture?: string;
+}): Promise<ResultCreateNewsletter>;

package/dist/newsletter/functions/destroy.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.
+ */
+/**
+ * Delete a newsletter
+ *
+ * @example
+ * ```javascript
+ * const code = WPP.newsletter.destroy('[newsletter-id]@newsletter');
+ * ```
+ *
+ * @category Newsletter
+ */
+export declare function destroy(id: string): Promise<boolean>;

package/dist/newsletter/functions/edit.d.ts

@@ -0,0 +1,58 @@
+/*!
+ * 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.
+ */
+export interface ResultCreateNewsletter {
+    idJid: string;
+    inviteCode: string;
+    inviteLink: string;
+    name: string;
+    state: string;
+    subscribersCount: number;
+    description: string | null;
+    timestamp: number;
+}
+/**
+ * Edit the newsletter data
+ *
+ * @example
+ * ```javascript
+ * // To edit name
+ * const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
+ * name: 'New Name'
+ * });
+ *
+ * // To edit description
+ * const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
+ * description: 'New description'
+ * });
+ *
+ * // To change picture
+ * const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
+ * picture: '<base64_image>'
+ * });
+ *
+ * // To remove picture
+ * const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
+ * picture: null
+ * });
+ * ```
+ *
+ * @category Newsletter
+ */
+export declare function edit(newsletterId: string, opts: {
+    name?: string;
+    description?: string;
+    picture?: string;
+}): Promise<ResultCreateNewsletter>;

package/dist/newsletter/functions/ensureNewsletter.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 { Wid } from '../../whatsapp';
+export declare function ensureNewsletter(newsletterId: string | Wid): Promise<import("../../whatsapp").ChatModel>;

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

@@ -0,0 +1,19 @@
+/*!
+ * Copyright 2022 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 { create } from './create';
+export { destroy } from './destroy';
+export { edit } from './edit';
+export { mute } from './mute';

package/dist/newsletter/functions/mute.d.ts

@@ -0,0 +1,33 @@
+/*!
+ * 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 { ChatModel } from '../../whatsapp';
+/**
+ * Mute and unmute a newsletter
+ *
+ * @example
+ * // Mute
+ * ```javascript
+ * WPP.newsletter.mute('[newsletter-id]@newsletter', true);
+ * ```
+ *
+ * // Unmute
+ * ```javascript
+ * WPP.newsletter.mute('[newsletter-id]@newsletter', false);
+ * ```
+ *
+ * @category Newsletter
+ */
+export declare function mute(newsletterId: string, value?: boolean): Promise<ChatModel>;

package/dist/newsletter/index.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export * from './functions';

package/dist/webpack/index.d.ts

@@ -27,6 +27,7 @@ export declare let isReady: boolean;
 export declare let isFullReady: boolean;
 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 let webpackRequire: (<T = any>(moduleId: string) => T) & {
     /**

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

@@ -17,7 +17,7 @@ import { MsgModel, websocket, Wid } from '..';
 /**
  *
  */
-export declare function createFanoutMsgStanza(msg: MsgModel, proto: {
+export declare function createFanoutMsgStanza(msg: MsgModel, data: any, proto: {
     [key: string]: any;
 }, devices: Wid[], options: {
     [key: string]: any;

package/dist/whatsapp/functions/createNewsletterQuery.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.
+ */
+/**
+ * @whatsapp 874705
+ */
+export declare function createNewsletterQuery(opts: {
+    name: string;
+    description: string | null;
+    picture: string | null;
+}): any;

package/dist/whatsapp/functions/deleteNewsletter.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 698436
+ */
+export declare function deleteNewsletter(id: string): any;

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

@@ -0,0 +1,28 @@
+/*!
+ * 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 { ChatModel } from '../models';
+/**
+ * @whatsapp 172365
+ */
+export declare function editNewsletterMetadataAction(newsletter: ChatModel, editAtts: {
+    editName?: boolean;
+    editDescription?: boolean;
+    editPicture?: boolean;
+}, data: {
+    name?: string;
+    description?: string;
+    picture?: string | null;
+}): any;

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

@@ -13,10 +13,22 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { MsgKey, Wid } from '../misc';
 import { MsgModel } from '../models';
 /**
  * @whatsapp 95547
  * @whatsapp 695547 >= 2.2222.8
  * @whatsapp 925080 >= 2.2228.4
  */
-export declare function encryptAndSendMsg(message: MsgModel): Promise<any>;
+export declare function encryptAndSendMsg(msg: {
+    type: string;
+    data: MsgModel;
+}, data: {
+    ack: number;
+    author?: Wid;
+    from: Wid;
+    id: MsgKey;
+    subtype?: string;
+    to: Wid;
+    type: string;
+}, report: any): Promise<any>;

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

@@ -0,0 +1,34 @@
+/*!
+ * 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 95547
+ * @whatsapp 695547 >= 2.2222.8
+ * @whatsapp 925080 >= 2.2228.4
+ */
+export declare function encryptAndSendSenderKeyMsg(msg: {
+    type: string;
+    data: MsgModel;
+}, data: {
+    ack: number;
+    author?: Wid;
+    from: Wid;
+    id: MsgKey;
+    subtype?: string;
+    to: Wid;
+    type: string;
+}, proto: any, skGroup: any, options: any, report: any, other: any): Promise<any>;

package/dist/whatsapp/functions/findCommonGroups.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 { BaseCollection } from '../collections';
+import { ChatModel, ContactModel } from '../models';
+/**
+ * @whatsapp 714574
+ */
+export declare function findCommonGroups(wid: ContactModel): Promise<BaseCollection<ChatModel>>;

package/dist/whatsapp/functions/genLinkDeviceCodeForPhoneNumber.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 61777
+ */
+export declare function genLinkDeviceCodeForPhoneNumber(phone: string, pushNotification: boolean): Promise<string>;