@wppconnect/wa-js 1.0.16 → 1.1.3

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

@@ -0,0 +1,53 @@
+/*!
+ * 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 { RawMessage } from '..';
+export interface LinkPreviewOptions {
+    /**
+     * Send text message with link preview
+     *
+     * @default true
+     *
+     * @example
+     * ```javascript
+     * // Automatic detection
+     * WPP.chat.sendTextMessage('<number>@c.us', 'See https://www.youtube.com/watch?v=v1PBptSDIh8');
+     *
+     * // Overriding the title and description
+     * WPP.chat.sendTextMessage('<number>@c.us', 'See https://www.youtube.com/watch?v=v1PBptSDIh8', {
+     *   linkPreview: {
+     *     title: 'Another text',
+     *     description: 'Another description'
+     *   }
+     * });
+     * ```
+     */
+    linkPreview?: boolean | {
+        title?: string;
+        description?: string;
+        canonicalUrl?: string;
+        matchedText?: string;
+        richPreviewType?: number;
+        thumbnail?: string;
+        doNotPlayInline: boolean;
+    };
+}
+/**
+ * Prepare a message for link preview
+ *
+ * @category Message
+ * @internal
+ */
+export declare function prepareLinkPreview<T extends RawMessage>(message: T, options: LinkPreviewOptions): Promise<T>;

package/dist/chat/functions/prepareMessageButtons.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 { RawMessage } from '..';
+export interface MessageButtonsOptions {
+    /**
+     * List of buttons, with at least 1 option and a maximum of 3
+     */
+    buttons?: Array<{
+        id: string;
+        text: string;
+    }>;
+    /**
+     * Title for buttons, only for text message
+     */
+    title?: string;
+    /**
+     * Footer text for buttons
+     */
+    footer?: string;
+}
+/**
+ * Prepare a message for buttons
+ *
+ * @category Message
+ * @internal
+ */
+export declare function prepareMessageButtons<T extends RawMessage>(message: T, options: MessageButtonsOptions): T;

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

@@ -0,0 +1,23 @@
+/*!
+ * 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 } from '../../whatsapp';
+import { RawMessage, SendMessageOptions } from '..';
+/**
+ * Prepare a raw message
+ * @category Message
+ * @internal
+ */
+export declare function prepareRawMessage<T extends RawMessage>(chat: ChatModel, message: T, options?: SendMessageOptions): Promise<T>;

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

@@ -0,0 +1,116 @@
+/*!
+ * 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 '..';
+import { MessageButtonsOptions } from '.';
+export interface FileMessageOptions extends SendMessageOptions {
+    type: string;
+    caption?: string;
+    filename?: string;
+    mimetype?: string;
+}
+export interface AutoDetectMessageOptions extends FileMessageOptions {
+    type: 'auto-detect';
+}
+export interface AudioMessageOptions extends FileMessageOptions {
+    type: 'audio';
+    isPtt?: boolean;
+}
+export interface DocumentMessageOptions extends FileMessageOptions, MessageButtonsOptions {
+    type: 'document';
+}
+export interface ImageMessageOptions extends FileMessageOptions, MessageButtonsOptions {
+    type: 'image';
+    isViewOnce?: boolean;
+}
+export interface StickerMessageOptions extends FileMessageOptions {
+    type: 'sticker';
+}
+export interface VideoMessageOptions extends FileMessageOptions, MessageButtonsOptions {
+    type: 'video';
+    isGif?: boolean;
+}
+/**
+ * Send a file message, that can be an audio, document, image, sticker or video
+ *
+ * @example
+ * ```javascript
+ * // Single document
+ * WPP.chat.sendFileMessage(
+ *  '<number>@c.us',
+ *  'data:image/jpeg;base64,<a long base64 file...>',
+ *  {
+ *    type: 'document',
+ *    caption: 'My document', // Optional
+ *    filename: 'myfile.doc', // Optional
+ *    mimetype: 'application/msword' // Optional
+ *  }
+ * );
+ *
+ * // Image with view once
+ * WPP.chat.sendFileMessage(
+ *  '<number>@c.us',
+ *  'data:image/jpeg;base64,<a long base64 file...>',
+ *  {
+ *    type: 'image',
+ *    caption: 'My image', // Optional
+ *    isViewOnce: true
+ *  }
+ * );
+ *
+ * // PTT audio
+ * WPP.chat.sendFileMessage(
+ *  '<number>@c.us',
+ *  'data:audio/mp3;base64,<a long base64 file...>',
+ *  {
+ *    type: 'audio',
+ *    isPtt: true // false for common audio
+ *  }
+ * );
+ *
+ * // Image with view buttons
+ * WPP.chat.sendFileMessage(
+ *  '<number>@c.us',
+ *  'data:image/jpeg;base64,<a long base64 file...>',
+ *  {
+ *    type: 'image',
+ *    caption: 'My image'
+ *    buttons: [
+ *      {
+ *        id: 'your custom id 1',
+ *        text: 'Some text'
+ *      },
+ *      {
+ *        id: 'another id 2',
+ *        text: 'Another text'
+ *      }
+ *    ],
+ *    footer: 'Footer text' // Optional
+ *  }
+ * );
+ *
+ * // Image as Sticker
+ * WPP.chat.sendFileMessage(
+ *   '<number>@c.us',
+ *   'data:image/png;base64,<a long base64 file...>',
+ *   {
+ *     type: 'sticker'
+ *   }
+ * );
+ * ```
+ * @category Message
+ * @return  {SendMessageReturn} The result
+ */
+export declare function sendFileMessage(chatId: any, content: any, options: AutoDetectMessageOptions | AudioMessageOptions | DocumentMessageOptions | ImageMessageOptions | VideoMessageOptions | StickerMessageOptions): Promise<SendMessageReturn>;

package/dist/{group/types.d.ts → chat/functions/sendListMessage.d.ts}

@@ -13,28 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { ModelPropertiesContructor, MsgModel } from '../whatsapp';
-export interface ChatEventTypes {
-    change: string;
-    idle: undefined;
-}
-export interface GetMessagesOptions {
-    count?: number;
-    direction?: 'after' | 'before';
-    id?: string;
-}
-export interface SendMessageOptions {
-    waitForAck?: boolean;
-    createChat?: boolean;
-}
-export interface MessageButtonsOptions {
-    buttons?: Array<{
-        id: string;
-        text: string;
-    }>;
-    title?: string;
-    footer?: string;
-}
+import { SendMessageOptions, SendMessageReturn } from '..';
 export interface ListMessageOptions extends SendMessageOptions {
     buttonText: string;
     description: string;
@@ -47,6 +26,28 @@ export interface ListMessageOptions extends SendMessageOptions {
         }>;
     }>;
 }
-export declare type TextMessageOptions = SendMessageOptions & MessageButtonsOptions;
-export declare type AllMessageOptions = SendMessageOptions & MessageButtonsOptions & Partial<ListMessageOptions>;
-export declare type RawMessage = ModelPropertiesContructor<MsgModel>;
+/**
+ * Send a list message
+ *
+ * @example
+ * ```javascript
+ * WPP.chat.sendListMessage('<number>@c.us', {
+ *   buttonText: 'Click Me!',
+ *   description: "Hello it's list message",
+ *   sections: [{
+ *     title: 'Section 1',
+ *     rows: [{
+ *       rowId: 'rowid1',
+ *       title: 'Row 1',
+ *       description: "Hello it's description 1",
+ *     },{
+ *       rowId: 'rowid2',
+ *       title: 'Row 2',
+ *       description: "Hello it's description 2",
+ *     }]
+ *   }]
+ * });
+ * ```
+ * @category Message
+ */
+export declare function sendListMessage(chatId: any, options: ListMessageOptions): Promise<SendMessageReturn>;

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

@@ -0,0 +1,22 @@
+/*!
+ * 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 { RawMessage, SendMessageOptions, SendMessageReturn } from '..';
+/**
+ * Send a raw message
+ *
+ * @category Message
+ */
+export declare function sendRawMessage(chatId: any, rawMessage: RawMessage, options?: SendMessageOptions): Promise<SendMessageReturn>;

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

@@ -0,0 +1,23 @@
+/*!
+ * 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 { LinkPreviewOptions, MessageButtonsOptions, SendMessageOptions, SendMessageReturn } from '..';
+export declare type TextMessageOptions = SendMessageOptions & MessageButtonsOptions & LinkPreviewOptions;
+/**
+ * Send a text message
+ *
+ * @category Message
+ */
+export declare function sendTextMessage(chatId: any, content: any, options?: TextMessageOptions): Promise<SendMessageReturn>;

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

@@ -0,0 +1,27 @@
+/*!
+ * 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 VCardContact {
+    id: string | Wid;
+    name: string;
+}
+/**
+ * Send a VCard as message
+ *
+ * @category Message
+ */
+export declare function sendVCardContactMessage(chatId: any, contacts: string | Wid | VCardContact | (string | Wid | VCardContact)[], options?: SendMessageOptions): Promise<SendMessageReturn>;

package/dist/chat/index.d.ts

@@ -13,8 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Chat } from './Chat';
-export * from './Chat';
+import './events';
+export * from './defaultSendMessageOptions';
+export { clearListeners, EventTypes, listenerCount, off, on, once, UnsubscribeFn, } from './eventEmitter';
+export * from './functions';
 export * from './types';
-declare const _default: Chat;
-export default _default;

package/dist/chat/types.d.ts

@@ -15,52 +15,6 @@
  */
 import { ModelPropertiesContructor, MsgKey, MsgModel, Wid } from '../whatsapp';
 import { SendMsgResult } from '../whatsapp/enums';
-export interface ChatEventTypes {
-    change: string;
-    idle: undefined;
-    msg_revoke: {
-        /**
-         * Author of message, only for groups
-         */
-        author?: Wid;
-        from: Wid;
-        /**
-         * Message id of revoke event
-         */
-        id: MsgKey;
-        /**
-         * Message id of revoked message
-         */
-        refId: MsgKey;
-        to: Wid;
-    };
-    msg_ack_change: {
-        ack: number;
-        /**
-         * Who sended the ack, only for groups, broadcast and status
-         */
-        sender?: Wid;
-        /**
-         * The chat that sended the messeage
-         */
-        chat: Wid;
-        /**
-         * Message id of revoke event
-         */
-        ids: MsgKey[];
-    };
-}
-export interface GetMessagesOptions {
-    count?: number;
-    direction?: 'after' | 'before';
-    id?: string;
-}
-export interface DeleteMessageReturn {
-    id: string;
-    sendMsgResult: Promise<SendMsgResult>;
-    isRevoked: boolean;
-    isDeleted: boolean;
-}
 export interface SendMessageOptions {
     /**
      * Create a new chat to a new contact
@@ -147,63 +101,4 @@ export interface SendMessageReturn {
     ack: number;
     sendMsgResult: Promise<SendMsgResult>;
 }
-export interface MessageButtonsOptions {
-    /**
-     * List of buttons, with at least 1 option and a maximum of 3
-     */
-    buttons?: Array<{
-        id: string;
-        text: string;
-    }>;
-    /**
-     * Title for buttons, only for text message
-     */
-    title?: string;
-    /**
-     * Footer text for buttons
-     */
-    footer?: string;
-}
-export interface ListMessageOptions extends SendMessageOptions {
-    buttonText: string;
-    description: string;
-    sections: Array<{
-        title: string;
-        rows: Array<{
-            rowId: string;
-            title: string;
-            description: string;
-        }>;
-    }>;
-}
-export declare type TextMessageOptions = SendMessageOptions & MessageButtonsOptions;
-export interface FileMessageOptions extends SendMessageOptions {
-    type: string;
-    caption?: string;
-    filename?: string;
-    mimetype?: string;
-}
-export interface AutoDetectMessageOptions extends FileMessageOptions {
-    type: 'auto-detect';
-}
-export interface AudioMessageOptions extends FileMessageOptions {
-    type: 'audio';
-    isPtt?: boolean;
-}
-export interface DocumentMessageOptions extends FileMessageOptions, MessageButtonsOptions {
-    type: 'document';
-}
-export interface ImageMessageOptions extends FileMessageOptions, MessageButtonsOptions {
-    type: 'image';
-    isViewOnce?: boolean;
-}
-export interface VideoMessageOptions extends FileMessageOptions, MessageButtonsOptions {
-    type: 'video';
-    isGif?: boolean;
-}
-export interface VCardContact {
-    id: string | Wid;
-    name: string;
-}
-export declare type AllMessageOptions = SendMessageOptions & MessageButtonsOptions & Partial<ListMessageOptions>;
 export declare type RawMessage = ModelPropertiesContructor<MsgModel>;

package/dist/contact/eventEmitter.d.ts

@@ -0,0 +1,48 @@
+/*!
+ * 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 Emittery from 'emittery';
+export declare type UnsubscribeFn = () => void;
+export interface EventTypes {
+}
+export declare const eventEmitter: Emittery<EventTypes, EventTypes, never>;
+/**
+ * Subscribe to one event.
+ * @event
+ * @returns An unsubscribe method.
+ */
+export declare function on<Name extends keyof EventTypes>(eventName: Name, listener: (eventData: EventTypes[Name]) => void | Promise<void>): UnsubscribeFn;
+/**
+ * Subscribe to one or more events only once. It will be unsubscribed after the first event.
+ * @event
+ */
+export declare function once<Name extends keyof EventTypes>(eventName: Name): Promise<EventTypes[Name]>;
+/**
+ * @event
+ */
+export declare function off<Name extends keyof EventTypes>(eventName: Name, listener: (eventData: EventTypes[Name]) => void | Promise<void>): void;
+/**
+ * Clear all event listeners on the instance.
+ *
+ * If `eventName` is given, only the listeners for that event are cleared.
+ *
+ * @event
+ */
+export declare function clearListeners<Name extends keyof EventTypes>(eventName?: Name | Name[]): void;
+/**
+ * The number of listeners for the `eventName` or all events if not specified.
+ * @event
+ */
+export declare function listenerCount<Name extends keyof EventTypes>(eventName?: Name | Name[]): number;

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

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

package/dist/contact/functions/queryExists.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 { Wid } from '../../whatsapp';
+export declare function queryExists(contactId: string | Wid): Promise<{
+    wid: Wid;
+    biz: boolean;
+} | null | undefined>;

package/dist/contact/index.d.ts

@@ -13,8 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Contact } from './Contact';
-export * from './Contact';
-export * from './types';
-declare const _default: Contact;
-export default _default;
+export { clearListeners, EventTypes, listenerCount, off, on, once, UnsubscribeFn, } from './eventEmitter';
+export * from './functions';

package/dist/group/eventEmitter.d.ts

@@ -0,0 +1,48 @@
+/*!
+ * 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 Emittery from 'emittery';
+export declare type UnsubscribeFn = () => void;
+export interface EventTypes {
+}
+export declare const eventEmitter: Emittery<EventTypes, EventTypes, never>;
+/**
+ * Subscribe to one event.
+ * @event
+ * @returns An unsubscribe method.
+ */
+export declare function on<Name extends keyof EventTypes>(eventName: Name, listener: (eventData: EventTypes[Name]) => void | Promise<void>): UnsubscribeFn;
+/**
+ * Subscribe to one or more events only once. It will be unsubscribed after the first event.
+ * @event
+ */
+export declare function once<Name extends keyof EventTypes>(eventName: Name): Promise<EventTypes[Name]>;
+/**
+ * @event
+ */
+export declare function off<Name extends keyof EventTypes>(eventName: Name, listener: (eventData: EventTypes[Name]) => void | Promise<void>): void;
+/**
+ * Clear all event listeners on the instance.
+ *
+ * If `eventName` is given, only the listeners for that event are cleared.
+ *
+ * @event
+ */
+export declare function clearListeners<Name extends keyof EventTypes>(eventName?: Name | Name[]): void;
+/**
+ * The number of listeners for the `eventName` or all events if not specified.
+ * @event
+ */
+export declare function listenerCount<Name extends keyof EventTypes>(eventName?: Name | Name[]): number;

package/dist/group/functions/addParticipants.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 addParticipants(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<void>;