@open-wa/wa-automate-types-only 4.51.1 → 4.54.6

package/dist/api/Client.d.ts

@@ -2,13 +2,13 @@
 import { Page } from 'puppeteer';
 import { Chat, LiveLocationChangedEvent, ChatState, ChatMuteDuration, GroupChatCreationResponse, EphemeralDuration } from './model/chat';
 import { Contact, NumberCheck } from './model/contact';
-import { Message, MessageInfo } from './model/message';
+import { Message, MessageInfo, PollData } from './model/message';
 import { AxiosRequestConfig } from 'axios';
-import { ParticipantChangedEventModel } from './model/group-metadata';
+import { NewCommunityGroup, ParticipantChangedEventModel } 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';
-import { ChatId, GroupChatId, Content, Base64, MessageId, ContactId, DataURL, AdvancedFile } from './model/aliases';
+import { ChatId, GroupChatId, Content, Base64, MessageId, ContactId, DataURL, AdvancedFile, GroupId } from './model/aliases';
 import { CustomProduct, Order, Product } from './model/product';
 import { Label } from './model/label';
 import { Mp4StickerConversionProcessOptions, StickerMetadata } from './model/media';
@@ -40,6 +40,7 @@ export declare class Client {
     private _currentlyBeingKilled;
     private _refreshing;
     private _loaded;
+    private _hostAccountNumber;
     private _prio;
     private _pageListeners;
     private _registeredPageListeners;
@@ -184,6 +185,13 @@ export declare class Client {
      * @fires [[Message]]
      */
     onButton(fn: (message: Message) => void): Promise<Listener | boolean>;
+    /**
+     * Listens to poll vote events
+     * @event
+     * @param fn callback
+     * @fires [[PollData]]
+     */
+    onPollVote(fn: (pollDate: PollData) => void): Promise<Listener | boolean>;
     /**
      * Listens to broadcast messages
      * @event
@@ -729,7 +737,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`
@@ -1421,6 +1429,18 @@ export declare class Client {
      * @param contacts: A single contact id or an array of contact ids.
      */
     createGroup(groupName: string, contacts: ContactId | ContactId[]): Promise<GroupChatCreationResponse>;
+    /**
+     * {@license:insiders@}
+     *
+     * Create a new community
+     *
+     * @param communityName The community name
+     * @param communitySubject: The community subject line
+     * @param icon DataURL of a 1:1 ratio jpeg for the community icon
+     * @param existingGroups An array of existing group IDs, that are not already part of a community, to add to this new community.
+     * @param newGroups An array of new group objects that
+     */
+    createCommunity(communityName: string, communitySubject: string, icon: DataURL, existingGroups?: GroupChatId[], newGroups?: NewCommunityGroup[]): Promise<GroupId>;
     /**
      * Remove participant of Group
      *
@@ -1561,6 +1581,12 @@ export declare class Client {
      * @param messageId The message id
      */
     getMessageReaders(messageId: MessageId): Promise<Contact[]>;
+    /**
+     * Returns poll data including results and votes.
+     *
+     * @param messageId The message id of the Poll
+     */
+    getPollData(messageId: MessageId): Promise<PollData>;
     /**
      * Sends a sticker (including GIF) from a given URL
      * @param to: The recipient id.
@@ -1713,7 +1739,7 @@ export declare class Client {
      * @deprecated
      * Alias for deleteStory
      */
-    deleteStatus: (statusesToDelete: string | string[]) => Promise<boolean>;
+    deleteStatus(statusesToDelete: string | string[]): Promise<boolean>;
     /**
      * {@license:restricted@}
      *
@@ -1725,7 +1751,7 @@ export declare class Client {
      * @deprecated
      * Alias for deleteStory
      */
-    deleteAllStatus: () => Promise<boolean>;
+    deleteAllStatus(): Promise<boolean>;
     /**
      * {@license:restricted@}
      *
@@ -1738,7 +1764,7 @@ export declare class Client {
      * @deprecated
      * Alias for deleteStory
      */
-    getMyStatusArray: () => Promise<Message[]>;
+    getMyStatusArray(): Promise<Message[]>;
     /**
      * {@license:restricted@}
      *
@@ -1889,7 +1915,7 @@ export declare class Client {
      *
      * For example, if you have a session with id  `host` if you set useSessionIdInPath to true, then all requests will need to be prefixed with the path `host`. E.g `localhost:8082/sendText` becomes `localhost:8082/host/sendText`
      */
-    middleware: (useSessionIdInPath?: boolean) => (req: Request, res: Response, next: NextFunction) => Promise<any>;
+    middleware: (useSessionIdInPath?: boolean, PORT?: number) => (req: Request, res: Response, next: NextFunction) => Promise<any>;
     /**
      * Retreives an array of webhook objects
      */

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

@@ -21,6 +21,10 @@ export type CountryCode = 1 | 7 | 20 | 27 | 30 | 31 | 32 | 33 | 34 | 36 | 39 | 4
  * The account number. It is made up of a country code and then the local number without the preceeding 0. For example, if a UK (+44) wa account is linked to the number 07123456789 then the account number will be 447123456789.
  */
 export type AccountNumber = `${number}`;
+/**
+ * A new group or community has the format of a random number followed by `@g.us`
+ */
+export type GroupId = `${number}@${GroupChatServer}`;
 /**
  * A group chat ends with `@g.us` and usually has two parts, the timestamp of when it was created, and the user id of the number that created the group. For example `[creator number]-[timestamp]@g.us`
  *
@@ -28,7 +32,7 @@ export type AccountNumber = `${number}`;
  *
  * `"447123456789-1445627445@g.us"`
  */
-export type GroupChatId = `${AccountNumber}-${number}@${GroupChatServer}` | `${number}@${GroupChatServer}`;
+export type GroupChatId = `${AccountNumber}-${number}@${GroupChatServer}` | GroupId;
 /**
  * A contact id ends with `@c.us` and only contains the number of the contact. For example, if the country code of a contact is `44` and their number is `7123456789` then the contact id would be `447123456789@c.us`
  *

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

@@ -66,6 +66,10 @@ export declare enum SimpleListener {
      * Represents [[onButton]]
      */
     Button = "onButton",
+    /**
+     * Represents [[onButton]]
+     */
+    PollVote = "onPollVote",
     /**
      * Represents [[onBroadcast]]
      */

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

@@ -1,4 +1,4 @@
-import { ChatId, ContactId, GroupChatId, NonSerializedId } from './aliases';
+import { ChatId, ContactId, GroupChatId, NonSerializedId, DataURL, GroupId } from './aliases';
 export interface Participant {
     id: NonSerializedId;
     isAdmin: boolean;
@@ -45,6 +45,26 @@ export interface GroupMetadata {
      * Not sure what this represents
      */
     support?: boolean;
+    /**
+     * Is this group a parent group (a.k.a community)
+     */
+    isParentGroup?: boolean;
+    /**
+     * The type of group
+     */
+    groupType: 'DEAFULT' | 'SUBGROUP' | 'COMMUNITY';
+    /**
+     * Communities have a default group chat
+     */
+    defaultSubgroup: boolean;
+    /**
+     *
+     */
+    isParentGroupClosed: boolean;
+    /**
+     * List of Group IDs that the host account has joined as part of this community
+     */
+    joinedSubgroups: GroupId[];
 }
 export declare enum groupChangeEvent {
     remove = "remove",
@@ -72,3 +92,11 @@ export declare enum GroupNotificationTypes {
     ANNOUNCE = "announce",
     RESTRICT = "restrict"
 }
+/**
+ * Used when creating a new community with.
+ */
+export interface NewCommunityGroup {
+    subject: string;
+    icon?: DataURL;
+    ephemeralDuration?: number;
+}

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

@@ -151,6 +151,24 @@ export interface Message {
     deprecatedMms3Url: string;
     quotedMsg?: Message;
     quotedMsgObj?: Message;
+    /**
+     * When a user requests to join a group wihtin a community the request is received by the host as a message. This boolean will allow you to easily determine if the incoming message is a request to join a group.
+     *
+     * If this is `true` then you need to determine within your own code whether or not to accept the user to the group which is indicated with `quotedRemoteJid` using `addParticipant`.
+     */
+    isGroupJoinRequest?: boolean;
+    /**
+     * The ID of the message sender
+     */
+    senderId?: string;
+    /**
+     * The ID of the quoted group. Usually present when a user is requesting to join a group.
+     */
+    quotedRemoteJid?: string;
+    /**
+     * The parent group ID (community ID - communities are just groups made up of other groups) of the group represented by `quotedRemoteJid`
+     */
+    quotedParentGroupJid?: string;
     mediaData: unknown;
     shareDuration: number;
     isAnimated: boolean;
@@ -189,6 +207,74 @@ export interface Message {
         "description": string;
         "buttonText": string;
     };
+    /**
+     * The options of a poll
+     */
+    pollOptions?: PollOption[];
+}
+export interface PollOption {
+    name: string;
+    localId: number;
+}
+export interface PollData {
+    /**
+     * The total amount of votes recorded so far
+     */
+    totalVotes: number;
+    /**
+     * The poll options and their respective count of votes.
+     */
+    pollOptions: (PollOption & {
+        count: number;
+    })[];
+    /**
+     * An arrray of vote objects
+     */
+    votes: PollVote[];
+    /**
+     * The message object of the poll
+     */
+    pollMessage: Message;
+}
+export interface PollVote {
+    ack: number;
+    /**
+     * The message ID of this vote. For some reason this is different from the msgKey and includes exclamaition marks.
+     */
+    id: string;
+    /**
+     * The message key of this vote
+     */
+    msgKey: string;
+    /**
+     * The Message ID of the original Poll message
+     */
+    parentMsgKey: string;
+    /**
+     * The original poll options available on the poll
+     */
+    pollOptions: PollOption[];
+    /**
+     * The selected option IDs of the voter
+     */
+    selectedOptionLocalIds: number[];
+    /**
+     * The selected option values by this voter
+     */
+    selectedOptionValues: string[];
+    /**
+     * The contact ID of the voter
+     */
+    sender: ContactId;
+    /**
+     * The contact object of the voter
+     */
+    senderObj: Contact;
+    /**
+     * Timestamp of the vote
+     */
+    senderTimestampMs: number;
+    stale: boolean;
 }
 export interface QuoteMap {
     [messageId: string]: {

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;
+};

package/dist/cli/server.d.ts

@@ -13,9 +13,11 @@ export declare const setupAuthenticationLayer: (cliConfig: cliFlags) => void;
 export declare const setupApiDocs: (cliConfig: cliFlags) => void;
 export declare const setupSwaggerStatsMiddleware: (cliConfig: cliFlags) => Promise<void>;
 export declare const setupRefocusDisengageMiddleware: (cliConfig: cliFlags) => void;
+export declare const setupMetaProcessMiddleware: (client: Client, cliConfig: any) => void;
 export declare const getCommands: () => any;
 export declare const listListeners: () => string[];
 export declare const setupMediaMiddleware: () => void;
+export declare const setupTunnel: (cliConfig: any, tunnelCode: string, PORT: number) => Promise<string>;
 export declare const setupTwilioCompatibleWebhook: (cliConfig: cliFlags, client: Client) => void;
 export declare const setupChatwoot: (cliConfig: cliFlags, client: Client) => void;
 export declare const setupBotPressHandler: (cliConfig: cliFlags, client: Client) => void;

package/dist/controllers/initializer.d.ts

@@ -1,6 +1,6 @@
 import { Client } from '../api/Client';
 import { AdvancedConfig, ConfigObject } from '../api/model/index';
-export declare const pkg: any, configWithCases: any, timeout: (ms: number) => Promise<unknown>;
+export declare const pkg: any, configWithCases: any, timeout: (ms: number) => Promise<string>;
 export declare let screenshot: any;
 /**
  * Used to initialize the client session.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@open-wa/wa-automate-types-only",
-    "version": "4.51.1",
+    "version": "4.54.6",
     "description": "Types generated from the @open-wa/wa-automate package",
     "scripts": {
         "build": "tsc",