@wppconnect/wa-js 1.2.5 → 2.0.0

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 2.0.0 (2022-04-25)
+
+
+### Features
+
+* Added WPP.conn.setKeepAlive function ([d211485](https://github.com/wppconnect-team/wa-js/commit/d211485cd6379073b1962e7fc8e99d6c3d30da8d))
+
+
+
 ## 1.2.5 (2022-03-25)
 
 

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

@@ -0,0 +1,18 @@
+/*!
+ * 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 interface BlocklistEventTypes {
+    'blocklist.sync': undefined;
+}

package/dist/blocklist/index.d.ts

@@ -14,5 +14,4 @@
  * limitations under the License.
  */
 import './events';
-export { clearListeners, EventTypes, listenerCount, off, on, once, UnsubscribeFn, } from './eventEmitter';
 export * from './functions';

package/dist/chat/{eventEmitter.d.ts → events/eventTypes.d.ts}

@@ -13,11 +13,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import Emittery from 'emittery';
-import { MsgKey, Wid } from '../whatsapp';
-export declare type UnsubscribeFn = () => void;
-export interface EventTypes {
-    msg_revoke: {
+import { MsgKey, MsgModel, Wid } from '../../whatsapp';
+export interface ChatEventTypes {
+    /**
+     * Triggered when new message is received
+     *
+     * @example
+     * ```javascript
+     * WPP.on('chat.new_message', (msg) => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'chat.new_message': MsgModel;
+    'chat.msg_revoke': {
         /**
          * Author of message, only for groups
          */
@@ -37,7 +46,7 @@ export interface EventTypes {
          */
         type: 'revoke' | 'sender_revoke' | 'admin_revoke';
     };
-    msg_ack_change: {
+    'chat.msg_ack_change': {
         ack: number;
         /**
          * Who sended the ack, only for groups, broadcast and status
@@ -52,7 +61,7 @@ export interface EventTypes {
          */
         ids: MsgKey[];
     };
-    live_location_start: {
+    'chat.live_location_start': {
         id: Wid;
         msgId: MsgKey;
         chat: Wid;
@@ -63,7 +72,7 @@ export interface EventTypes {
         degrees?: number;
         shareDuration: number;
     };
-    live_location_update: {
+    'chat.live_location_update': {
         id: Wid;
         lastUpdated: number;
         elapsed: number;
@@ -74,38 +83,27 @@ export interface EventTypes {
         degrees?: number;
         comment: string;
     };
-    live_location_end: {
+    'chat.live_location_end': {
         id: Wid;
         chat: Wid;
         seq: number;
     };
+    /**
+     * On presence change
+     */
+    'chat.presence_change': {
+        id: Wid;
+        isOnline: boolean;
+        isGroup: boolean;
+        isUser: boolean;
+        shortName: string;
+        state: string;
+        t: number;
+        isContact?: boolean;
+        participants?: {
+            id: string;
+            state: string;
+            shortName: string;
+        }[];
+    };
 }
-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/chat/events/index.d.ts

@@ -14,5 +14,7 @@
  * limitations under the License.
  */
 import './registerAckMessageEvent';
-import './registerRevokeMessageEvent';
 import './registerLiveLocationUpdateEvent';
+import './registerNewMessageEvent';
+import './registerPresenceChange';
+import './registerRevokeMessageEvent';

package/dist/chat/events/registerPresenceChange.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 {};

package/dist/chat/index.d.ts

@@ -15,6 +15,5 @@
  */
 import './events';
 export * from './defaultSendMessageOptions';
-export { clearListeners, EventTypes, listenerCount, off, on, once, UnsubscribeFn, } from './eventEmitter';
 export * from './functions';
 export * from './types';

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

@@ -0,0 +1,55 @@
+/*!
+ * 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 { AuthCode } from '../types';
+export interface ConnEventTypes {
+    'conn.auth_code_change': AuthCode | null;
+    /**
+     * Triggered afted a success QR code scan
+     *
+     * @example
+     * ```javascript
+     * WPP.on('conn.authenticated', () => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'conn.authenticated': undefined;
+    'conn.logout': undefined;
+    /**
+     * Triggered when the main interface is loaded, but is syncing
+     *
+     * @example
+     * ```javascript
+     * WPP.on('conn.main_loaded', () => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'conn.main_loaded': undefined;
+    /**
+     * Triggered when the main interface is loaded, authenticated and ready to send message
+     *
+     * @example
+     * ```javascript
+     * WPP.on('conn.main_ready', () => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'conn.main_ready': undefined;
+    'conn.qrcode_idle': undefined;
+    'conn.require_auth': undefined;
+}

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

@@ -20,4 +20,5 @@ export { isMainLoaded } from './isMainLoaded';
 export { isMultiDevice } from './isMultiDevice';
 export { logout } from './logout';
 export { refreshQR } from './refreshQR';
+export { setKeepAlive } from './setKeepAlive';
 export { setMultiDevice } from './setMultiDevice';

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

@@ -0,0 +1,28 @@
+/*!
+ * 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.
+ */
+/**
+ * Set keep alive state, that will force the focused and online state
+ *
+ * @example
+ * ```javascript
+ * // To enable
+ * await WPP.conn.setKeepAlive();
+ *
+ * // To disable
+ * await WPP.conn.setKeepAlive(false);
+ * ```
+ */
+export declare function setKeepAlive(enable?: boolean): boolean;

package/dist/conn/index.d.ts

@@ -14,6 +14,5 @@
  * limitations under the License.
  */
 import './events';
-export { clearListeners, EventTypes, listenerCount, off, on, once, UnsubscribeFn, } from './eventEmitter';
 export * from './functions';
 export * from './types';

package/dist/contact/functions/getProfilePictureUrl.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';
+/**
+ * Get the current text status
+ *
+ * @example
+ * ```javascript
+ * const url = await WPP.contact.getProfilePicture('[number]@c.us');
+ * ```
+ *
+ * @category Chat
+ */
+export declare function getProfilePictureUrl(contactId: string | Wid, full?: boolean): Promise<string | null | undefined>;

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

@@ -13,5 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export { getProfilePictureUrl } from './getProfilePictureUrl';
 export { getStatus } from './getStatus';
 export { queryExists } from './queryExists';

package/dist/contact/index.d.ts

@@ -13,5 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export { clearListeners, EventTypes, listenerCount, off, on, once, UnsubscribeFn, } from './eventEmitter';
 export * from './functions';

package/dist/eventEmitter/eventEmitter.d.ts

@@ -0,0 +1,169 @@
+/*!
+ * 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 { CancelablePromise, ConstructorOptions, event, EventAndListener, EventEmitter2, eventNS, GeneralEventEmitter, Listener, ListenerFn, ListenToOptions, OnceOptions, WaitForFilter, WaitForOptions } from 'eventemitter2';
+export interface OnOptions {
+    /**
+     * invoke the listener in async mode using setImmediate (fallback to setTimeout if not available) or process.nextTick depending on the nextTick option.
+     */
+    async?: boolean;
+    /**
+     * additionally wraps the listener to a Promise for later invocation using emitAsync method. This option will be activated by default if its value is undefined and the listener function is an asynchronous function (whose constructor name is AsyncFunction).
+     */
+    promisify?: boolean;
+    /**
+     * activates returning a listener object instead of 'this' by the subscription method.
+     */
+    objectify?: boolean;
+}
+export declare type ListenerType<T> = [T] extends [(...args: infer U) => any] ? U : [T] extends [void] ? [] : [T];
+export declare class EventEmitter<EventData> {
+    constructor(options?: ConstructorOptions);
+    emit<Name extends keyof EventData>(event: Name, ...args: ListenerType<EventData[Name]>): boolean;
+    emitAsync<Name extends keyof EventData>(event: Name, ...args: ListenerType<EventData[Name]>): Promise<any[]>;
+    /**
+     * Adds a listener to the end of the listeners array for the specified event.
+     */
+    addListener<Name extends keyof EventData>(event: Name, listener: (...args: ListenerType<EventData[Name]>) => void): this | Listener;
+    /**
+     * Adds a listener to the end of the listeners array for the specified event.
+     */
+    on<Name extends keyof EventData>(event: Name, listener: (...args: ListenerType<EventData[Name]>) => void, options: OnOptions & {
+        objectify: true;
+    }): Listener;
+    /**
+     * Adds a listener to the end of the listeners array for the specified event.
+     */
+    on<Name extends keyof EventData>(event: Name, listener: (...args: ListenerType<EventData[Name]>) => void, options?: boolean | OnOptions): this;
+    /**
+     * Adds a listener to the beginning of the listeners array for the specified event.
+     */
+    prependListener<Name extends keyof EventData>(event: Name, listener: (...args: ListenerType<EventData[Name]>) => void, options: OnOptions & {
+        objectify: true;
+    }): Listener;
+    /**
+     * Adds a listener to the beginning of the listeners array for the specified event.
+     */
+    prependListener<Name extends keyof EventData>(event: Name, listener: (...args: ListenerType<EventData[Name]>) => void, options?: boolean | OnOptions): this;
+    /**
+     * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
+     */
+    once<Name extends keyof EventData>(event: Name, listener: (...args: ListenerType<EventData[Name]>) => void, options: OnOptions & {
+        objectify: true;
+    }): Listener;
+    /**
+     * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
+     */
+    once<Name extends keyof EventData>(event: Name, listener: (...args: ListenerType<EventData[Name]>) => void, options?: true | OnOptions): this;
+    /**
+     * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed. The listener is added to the beginning of the listeners array
+     */
+    prependOnceListener<Name extends keyof EventData>(event: Name, listener: (...args: ListenerType<EventData[Name]>) => void, options: OnOptions & {
+        objectify: true;
+    }): Listener;
+    /**
+     * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed. The listener is added to the beginning of the listeners array
+     */
+    prependOnceListener<Name extends keyof EventData>(event: Name, listener: (...args: ListenerType<EventData[Name]>) => void, options?: boolean | OnOptions): this;
+    /**
+     * Adds a listener that will execute n times for the event before being removed. The listener is invoked only the first n times the event is fired, after which it is removed.
+     */
+    many<Name extends keyof EventData>(event: Name, timesToListen: number, listener: (...args: ListenerType<EventData[Name]>) => void, options: OnOptions & {
+        objectify: true;
+    }): Listener;
+    /**
+     * Adds a listener that will execute n times for the event before being removed. The listener is invoked only the first n times the event is fired, after which it is removed.
+     */
+    many<Name extends keyof EventData>(event: Name, timesToListen: number, listener: (...args: ListenerType<EventData[Name]>) => void, options?: boolean | OnOptions): this;
+    /**
+     * Adds a listener that will execute n times for the event before being removed. The listener is invoked only the first n times the event is fired, after which it is removed. The listener is added to the beginning of the listeners array.
+     */
+    prependMany<Name extends keyof EventData>(event: Name, timesToListen: number, listener: (...args: ListenerType<EventData[Name]>) => void, options: OnOptions & {
+        objectify: true;
+    }): Listener;
+    /**
+     * Adds a listener that will execute n times for the event before being removed. The listener is invoked only the first n times the event is fired, after which it is removed. The listener is added to the beginning of the listeners array.
+     */
+    prependMany<Name extends keyof EventData>(event: Name, timesToListen: number, listener: (...args: ListenerType<EventData[Name]>) => void, options?: boolean | OnOptions): this;
+    /**
+     * Adds a listener that will be fired when any event is emitted. The event name is passed as the first argument to the callback.
+     */
+    onAny(listener: EventAndListener): this;
+    /**
+     * Adds a listener that will be fired when any event is emitted. The event name is passed as the first argument to the callback. The listener is added to the beginning of the listeners array
+     */
+    prependAny(listener: EventAndListener): this;
+    /**
+     * Removes the listener that will be fired when any event is emitted.'
+     */
+    offAny(listener: ListenerFn): this;
+    /**
+     * Remove a listener from the listener array for the specified event. Caution: Calling this method changes the array indices in the listener array behind the listener.
+     */
+    removeListener<Name extends keyof EventData>(event: Name, listener: (...args: ListenerType<EventData[Name]>) => void): this;
+    /**
+     * Remove a listener from the listener array for the specified event. Caution: Calling this method changes the array indices in the listener array behind the listener.
+     */
+    off<Name extends keyof EventData>(event: Name, listener: (...args: ListenerType<EventData[Name]>) => void): this;
+    /**
+     * Removes all listeners, or those of the specified event.
+     */
+    removeAllListeners<Name extends keyof EventData>(event?: Name): this;
+    /**
+     * By default EventEmitters will print a warning if more than 10 listeners are added to it. This is a useful default which helps finding memory leaks. Obviously not all Emitters should be limited to 10. This function allows that to be increased. Set to zero for unlimited.
+     */
+    setMaxListeners(n: number): void;
+    /**
+     * Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter2.defaultMaxListeners
+     */
+    getMaxListeners(): number;
+    /**
+     * Returns an array listing the events for which the emitter has registered listeners.
+     *
+     * Note: Listeners order not guaranteed
+     */
+    eventNames<Name extends keyof EventData>(nsAsArray?: boolean): Name[];
+    listenerCount<Name extends keyof EventData>(event?: Name): number;
+    /**
+     * Returns an array of listeners for the specified event. This array can be manipulated, e.g. to remove listeners.
+     */
+    listeners<Name extends keyof EventData>(event?: Name): ListenerFn[];
+    /**
+     * Returns an array of listeners that are listening for any event that is specified. This array can be manipulated, e.g. to remove listeners.
+     */
+    listenersAny(): ListenerFn[];
+    /**
+     * Returns a thenable object (promise interface) that resolves when a specific event occurs
+     */
+    waitFor<Name extends keyof EventData>(event: Name, timeout?: number): CancelablePromise<ListenerType<EventData[Name]>>;
+    /**
+     * Returns a thenable object (promise interface) that resolves when a specific event occurs
+     */
+    waitFor<Name extends keyof EventData>(event: Name, filter?: WaitForFilter): CancelablePromise<ListenerType<EventData[Name]>>;
+    /**
+     * Returns a thenable object (promise interface) that resolves when a specific event occurs
+     */
+    waitFor<Name extends keyof EventData>(event: Name, options?: WaitForOptions): CancelablePromise<ListenerType<EventData[Name]>>;
+    listenTo(target: GeneralEventEmitter, events: event | eventNS, options?: ListenToOptions): this;
+    listenTo(target: GeneralEventEmitter, events: event[], options?: ListenToOptions): this;
+    listenTo(target: GeneralEventEmitter, events: object, options?: ListenToOptions): this;
+    stopListeningTo(target?: GeneralEventEmitter, event?: event | eventNS): boolean;
+    /**
+     * Checks whether emitter has any listeners.
+     */
+    hasListeners<Name extends keyof EventData>(event?: Name): boolean;
+    static once(emitter: EventEmitter2, event: string, options?: OnceOptions): CancelablePromise<any[]>;
+    static defaultMaxListeners: number;
+}

package/dist/eventEmitter/eventTypes.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.
+ */
+import { BlocklistEventTypes } from '../blocklist/events/eventTypes';
+import { ChatEventTypes } from '../chat/events/eventTypes';
+import { ConnEventTypes } from '../conn/events/eventTypes';
+import { StatusEventTypes } from '../status/events/eventTypes';
+import { WebpackEvents } from '../webpack/eventTypes';
+export { BlocklistEventTypes } from '../blocklist/events/eventTypes';
+export { ChatEventTypes } from '../chat/events/eventTypes';
+export { ConnEventTypes } from '../conn/events/eventTypes';
+export { StatusEventTypes } from '../status/events/eventTypes';
+export { WebpackEvents } from '../webpack/eventTypes';
+export declare type EventTypes = BlocklistEventTypes & ChatEventTypes & ConnEventTypes & StatusEventTypes & WebpackEvents;