@open-wa/wa-automate 4.54.6 → 4.55.1

package/dist/api/Client.d.ts

@@ -4,7 +4,7 @@ import { Chat, LiveLocationChangedEvent, ChatState, ChatMuteDuration, GroupChatC
 import { Contact, NumberCheck } from './model/contact';
 import { Message, MessageInfo, PollData } from './model/message';
 import { AxiosRequestConfig } from 'axios';
-import { NewCommunityGroup, ParticipantChangedEventModel } from './model/group-metadata';
+import { NewCommunityGroup, ParticipantChangedEventModel, GenericGroupChangeEvent } from './model/group-metadata';
 import { ConfigObject, STATE, LicenseType, Webhook, EventPayload } from './model';
 import PQueue, { DefaultAddOptions, Options } from 'p-queue';
 import { HealthCheck, SessionInfo } from './model/sessionInfo';
@@ -200,8 +200,16 @@ export declare class Client {
      */
     onBroadcast(fn: (message: Message) => void): Promise<Listener | boolean>;
     /**
+     * @deprecated
+     *
      * Listens to battery changes
      *
+     * :::caution
+     *
+     *  This will most likely not work with multi-device mode (the only remaining mode) since the session is no longer connected to the phone but directly to WA servers.
+     *
+     * :::
+     *
      * @event
      * @param fn callback
      * @fires number
@@ -316,6 +324,14 @@ export declare class Client {
      * @returns `true` if the callback was registered
      */
     onGlobalParticipantsChanged(fn: (participantChangedEvent: ParticipantChangedEventModel) => void): Promise<Listener | boolean>;
+    /**
+     * Listens to all group (gp2) events. This can be useful if you want to catch when a group title, subject or picture is changed.
+     *
+     * @event
+     * @param fn callback function that handles a [[ParticipantChangedEventModel]] as the first and only parameter.
+     * @returns `true` if the callback was registered
+     */
+    onGroupChange(fn: (genericGroupChangeEvent: GenericGroupChangeEvent) => void): Promise<Listener | boolean>;
     /**
      * Fires callback with Chat object every time the host phone is added to a group.
      *
@@ -737,7 +753,7 @@ export declare class Client {
      * @param quotedMsgId string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message
      * @returns `Promise <boolean | string>` This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true
      */
-    sendPtt(to: ChatId, file: AdvancedFile, quotedMsgId: MessageId): Promise<MessageId>;
+    sendPtt(to: ChatId, file: AdvancedFile, quotedMsgId?: MessageId): Promise<MessageId>;
     /**
      * Send an audio file with the default audio player (not PTT/voice message)
      * @param to chat id `xxxxx@c.us`

package/dist/api/Client.js

@@ -864,8 +864,16 @@ class Client {
         });
     }
     /**
+     * @deprecated
+     *
      * Listens to battery changes
      *
+     * :::caution
+     *
+     *  This will most likely not work with multi-device mode (the only remaining mode) since the session is no longer connected to the phone but directly to WA servers.
+     *
+     * :::
+     *
      * @event
      * @param fn callback
      * @fires number
@@ -1033,6 +1041,18 @@ class Client {
             return this.registerListener(events_2.SimpleListener.GlobalParticipantsChanged, fn);
         });
     }
+    /**
+     * Listens to all group (gp2) events. This can be useful if you want to catch when a group title, subject or picture is changed.
+     *
+     * @event
+     * @param fn callback function that handles a [[ParticipantChangedEventModel]] as the first and only parameter.
+     * @returns `true` if the callback was registered
+     */
+    onGroupChange(fn) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.registerListener(events_2.SimpleListener.GroupChange, fn);
+        });
+    }
     /**
      * Fires callback with Chat object every time the host phone is added to a group.
      *
@@ -1847,7 +1867,7 @@ class Client {
      */
     sendPtt(to, file, quotedMsgId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.sendImage(to, file, 'ptt.ogg', '', quotedMsgId, true, true);
+            return this.sendImage(to, file, 'ptt.ogg', '', quotedMsgId ? quotedMsgId : null, true, true);
         });
     }
     /**

package/dist/api/model/config.d.ts

@@ -387,6 +387,11 @@ export interface ConfigObject {
     * @default `60`
     */
     authTimeout?: number;
+    /**
+     * phoneIsOutOfReach check timeout
+     * @default `60`
+     */
+    oorTimeout?: number;
     /**
      * Setting this to `true` will kill the whole process when the client is disconnected from the page or if the browser is closed.
      * @default `false`

package/dist/api/model/events.d.ts

@@ -107,5 +107,10 @@ export declare enum SimpleListener {
      * Requires licence
      * Represents [[onReaction]]
      */
-    Reaction = "onReaction"
+    Reaction = "onReaction",
+    /**
+     * Requires licence
+     * Represents [[onGroupChange]]
+     */
+    GroupChange = "onGroupChange"
 }

package/dist/api/model/events.js

@@ -115,4 +115,9 @@ var SimpleListener;
      * Represents [[onReaction]]
      */
     SimpleListener["Reaction"] = "onReaction";
+    /**
+     * Requires licence
+     * Represents [[onGroupChange]]
+     */
+    SimpleListener["GroupChange"] = "onGroupChange";
 })(SimpleListener = exports.SimpleListener || (exports.SimpleListener = {}));

package/dist/api/model/group-metadata.d.ts

@@ -1,5 +1,7 @@
-import { ChatId, ContactId, GroupChatId, NonSerializedId, DataURL, GroupId } from './aliases';
+import { ChatId, ContactId, GroupChatId, NonSerializedId, DataURL, GroupId, MessageId } from './aliases';
+import { Contact } from './contact';
 export interface Participant {
+    contact: Contact;
     id: NonSerializedId;
     isAdmin: boolean;
     isSuperAdmin: boolean;
@@ -100,3 +102,23 @@ export interface NewCommunityGroup {
     icon?: DataURL;
     ephemeralDuration?: number;
 }
+export interface GenericGroupChangeEvent {
+    /**
+     * The contact who triggered this event. (E.g the contact who changed the group picture)
+     */
+    author: Contact;
+    /**
+     * Some more information about the event
+     */
+    body: string;
+    groupMetadata: GroupMetadata;
+    /**
+     * Base 64 encoded image
+     */
+    groupPic: string;
+    id: MessageId;
+    /**
+     * Type of the event
+     */
+    type: 'picutre' | 'create' | 'delete' | 'subject' | 'revoke_invite' | 'description' | 'restrict' | 'announce' | 'no_frequently_forwarded' | 'announce_msg_bounce' | 'add' | 'remove' | 'demote' | 'promote' | 'invite' | 'leave' | 'modify' | 'v4_add_invite_sent' | 'v4_add_invite_join' | 'growth_locked' | 'growth_unlocked' | 'linked_group_join';
+}

package/dist/cli/integrations/chatwoot.d.ts

@@ -5,3 +5,45 @@ export declare const chatwoot_webhook_check_event_name = "cli.integrations.chatw
 export type expressMiddleware = (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
 export declare const chatwootMiddleware: (cliConfig: cliFlags, client: Client) => expressMiddleware;
 export declare const setupChatwootOutgoingMessageHandler: (cliConfig: cliFlags, client: Client) => Promise<void>;
+export type ChatwootConfig = {
+    /**
+     * The URL of the chatwoot inbox. If you want this integration to create & manage the inbox for you, you can omit the inbox part.
+     */
+    chatwootUrl: string;
+    /**
+     * The API access token which you can get from your account menu.
+     */
+    chatwootApiAccessToken: string;
+    /**
+     * The API host which will be used as the webhook address in the Chatwoot inbox.
+     */
+    apiHost: string;
+    /**
+     * Similar to apiHost
+     */
+    host: string;
+    /**
+     * Whether or not to use https for the webhook address
+     */
+    https?: boolean;
+    /**
+     * The certificate for https
+     */
+    cert: string;
+    /**
+     * The private key for https
+     */
+    privkey: string;
+    /**
+     * The API key used to secure the instance webhook address
+     */
+    key?: string;
+    /**
+     * Whether or not to update the webhook address in the Chatwoot inbox on launch
+     */
+    forceUpdateCwWebhook?: boolean;
+    /**
+     * port
+     */
+    port: number;
+};