@juzi/wechaty/dist/cjs/src/schemas/wechaty-events.d.ts

Wechaty is a RPA SDK for Chatbot Makers.

import type TypedEventEmitter from 'typed-emitter';
import type { GError } from 'gerror';
import * as PUPPET from '@juzi/wechaty-puppet';
import type { FriendshipInterface, ContactSelfInterface, RoomInterface, RoomInvitationInterface, ContactInterface, MessageInterface, PostInterface, TagInterface, TagGroupInterface } from '../user-modules/mod.js';
declare const WECHATY_EVENT_DICT: {
    readonly dong: "Should be emitted after we call `Wechaty.ding()`";
    readonly error: "Will be emitted when there's an Error occurred.";
    readonly heartbeat: "Will be emitted periodically after the Wechaty started. If not, means that the Wechaty had died.";
    readonly puppet: "Will be emitted when the puppet has been set.";
    readonly ready: "All underlined data source are ready for use.";
    readonly start: "Will be emitted after the Wechaty had been started.";
    readonly stop: "Will be emitted after the Wechaty had been stopped.";
    readonly 'contact-tag-add': "Will be emitted when contact has new tags.";
    readonly 'contact-tag-remove': "Will be emitted when contact has some tags removed.";
    readonly 'contact-name': "Will be emitted when contact name has been changed.";
    readonly 'contact-alias': "Will be emitted when contact alias has been changed.";
    readonly 'contact-phone': "Will be emitted when contact phone has been changed.";
    readonly 'contact-description': "Will be emitted when contact description has been changed.";
    readonly 'contact-corporation': "Will be emitted when contact corporation has been changed.";
    readonly 'room-owner': "Will be emitted when room owner has been changed.";
    readonly friendship: string;
    readonly login: string;
    readonly logout: string;
    readonly message: string;
    readonly post: string;
    readonly 'room-invite': string;
    readonly 'room-join': string;
    readonly 'room-leave': string;
    readonly 'room-topic': string;
    readonly 'room-announce': string;
    readonly scan: string;
    readonly tag: string;
    readonly 'tag-group': string;
    readonly 'post-comment': string;
    readonly 'post-tap': string;
    readonly 'verify-code': string;
    readonly dirty: string;
    readonly 'login-url': string;
};
declare type WechatyEventName = keyof typeof WECHATY_EVENT_DICT;
/**
 * Wechaty Event Listener Interfaces
 */
declare type WechatyEventListenerDong = (data?: string) => void | Promise<void>;
declare type WechatyEventListenerError = (error: GError) => void | Promise<void>;
declare type WechatyEventListenerFriendship = (friendship: FriendshipInterface) => void | Promise<void>;
declare type WechatyEventListenerHeartbeat = (data: any) => void | Promise<void>;
declare type WechatyEventListenerLogin = (user: ContactSelfInterface) => void | Promise<void>;
declare type WechatyEventListenerLogout = (user: ContactSelfInterface, reason?: string) => void | Promise<void>;
declare type WechatyEventListenerMessage = (message: MessageInterface) => void | Promise<void>;
declare type WechatyEventListenerPost = (post: PostInterface) => void | Promise<void>;
declare type WechatyEventListenerPuppet = (puppet: PUPPET.impls.PuppetInterface) => void | Promise<void>;
declare type WechatyEventListenerReady = () => void | Promise<void>;
declare type WechatyEventListenerRoomInvite = (roomInvitation: RoomInvitationInterface) => void | Promise<void>;
declare type WechatyEventListenerRoomJoin = (room: RoomInterface, inviteeList: ContactInterface[], inviter: ContactInterface, date?: Date) => void | Promise<void>;
declare type WechatyEventListenerRoomLeave = (room: RoomInterface, leaverList: ContactInterface[], remover?: ContactInterface, date?: Date) => void | Promise<void>;
declare type WechatyEventListenerRoomTopic = (room: RoomInterface, newTopic: string, oldTopic: string, changer: ContactInterface, date?: Date) => void | Promise<void>;
declare type WechatyEventListenerRoomAnnounce = (room: RoomInterface, newAnnounce: string, changer?: ContactInterface, oldAnnounce?: string, date?: Date) => void | Promise<void>;
declare type WechatyEventListenerRoomOwner = (room: RoomInterface, newOwner: ContactInterface, oldOwner: ContactInterface) => void | Promise<void>;
declare type WechatyEventListenerScan = (qrcode: string, status: PUPPET.types.ScanStatus, data: string, type: PUPPET.types.ScanType, createDate: Date, expireDate?: Date) => void | Promise<void>;
declare type WechatyEventListenerStartStop = () => void | Promise<void>;
declare type WechatyEventListenerContactTagAdd = (contact: ContactInterface, tagList: TagInterface[]) => void | Promise<void>;
declare type WechatyEventListenerContactTagRemove = (contact: ContactInterface, tagList: TagInterface[]) => void | Promise<void>;
declare type WechatyEventListenerContactName = (contact: ContactInterface, newName: string, oldName: string) => void | Promise<void>;
declare type WechatyEventListenerContactPhone = (contact: ContactInterface, newPhoneList: string[], oldPhoneList: []) => void | Promise<void>;
declare type WechatyEventListenerContactAlias = (contact: ContactInterface, newAlias: string, oldAlias: string) => void | Promise<void>;
declare type WechatyEventListenerContactDescription = (contact: ContactInterface, newDescription: string, oldDescription: string) => void | Promise<void>;
declare type WechatyEventListenerContactCorporation = (contact: ContactInterface, newCorporation: string, oldCorporation: string) => void | Promise<void>;
declare type WechatyEventListenerTag = (type: PUPPET.types.TagEvent, list: TagInterface[], date?: Date) => void | Promise<void>;
declare type WechatyEventListenerTagGroup = (type: PUPPET.types.TagGroupEvent, list: TagGroupInterface[], date?: Date) => void | Promise<void>;
declare type WechatyEventListenerPostComment = (comment: PostInterface, post: PostInterface) => void | Promise<void>;
declare type WechatyEventListenerPostTap = (post: PostInterface, contact: ContactInterface, type: PUPPET.types.Tap, tap: boolean, date?: Date) => void | Promise<void>;
declare type WechatyEventListenerVerifyCode = (id: string, message: string, scene: PUPPET.types.VerifyCodeScene, status: PUPPET.types.VerifyCodeStatus) => void | Promise<void>;
declare type WechatyEventListenerDirty = (id: string, type: PUPPET.types.Dirty) => void | Promise<void>;
declare type WechatyEventListenerLoginUrl = (url: string) => void | Promise<void>;
/**
 * @desc       Wechaty Class Event Type
 * @typedef    WechatyEventName
 * @property   {string}  error       - When the bot get error, there will be a Wechaty error event fired.
 * @property   {string}  login       - After the bot login full successful, the event login will be emitted, with a Contact of current logged in user.
 * @property   {string}  logout      - Logout will be emitted when bot detected log out, with a Contact of the current login user.
 * @property   {string}  heartbeat   - Get heartbeat of the bot.
 * @property   {string}  friendship  - When someone sends you a friend request, there will be a Wechaty friendship event fired.
 * @property   {string}  message     - Emit when there's a new message.
 * @property   {string}  ready       - Emit when all data has load completed, in wechaty-puppet-padchat, it means it has sync Contact and Room completed
 * @property   {string}  room-join   - Emit when anyone join any room.
 * @property   {string}  room-topic  - Get topic event, emitted when someone change room topic.
 * @property   {string}  room-leave  - Emit when anyone leave the room.<br>
 *                                   - If someone leaves the room by themselves, WeChat will not notice other people in the room, so the bot will never get the "leave" event.
 * @property   {string}  room-invite - Emit when there is a room invitation, see more in  {@link RoomInvitation}
 * @property   {string}  scan        - A scan event will be emitted when the bot needs to show you a QR Code for scanning. </br>
 *                                    It is recommend to install qrcode-terminal(run `npm install qrcode-terminal`) in order to show qrcode in the terminal.
 */
/**
 * @desc       Wechaty Class Event Function
 * @typedef    WechatyEventFunction
 * @property   {Function} error           -(this: Wechaty, error: Error) => void | Promise<void> callback function
 * @property   {Function} login           -(this: Wechaty, user: ContactSelf)=> void
 * @property   {Function} logout          -(this: Wechaty, user: ContactSelf) => void | Promise<void>
 * @property   {Function} scan            -(this: Wechaty, url: string, code: number) => void | Promise<void> <br>
 * <ol>
 * <li>URL: {String} the QR code image URL</li>
 * <li>code: {Number} the scan status code. some known status of the code list here is:</li>
 * </ol>
 * <ul>
 * <li>0 initial_</li>
 * <li>200 login confirmed</li>
 * <li>201 scanned, wait for confirm</li>
 * <li>408 waits for scan</li>
 * </ul>
 * @property   {Function} heartbeat       -(this: Wechaty, data: any) => void | Promise<void>
 * @property   {Function} friendship      -(this: Wechaty, friendship: Friendship) => void | Promise<void>
 * @property   {Function} message         -(this: Wechaty, message: Message) => void | Promise<void>
 * @property   {Function} ready           -(this: Wechaty) => void | Promise<void>
 * @property   {Function} room-join       -(this: Wechaty, room: Room, inviteeList: Contact[],  inviter: Contact) => void | Promise<void>
 * @property   {Function} room-topic      -(this: Wechaty, room: Room, newTopic: string, oldTopic: string, changer: Contact) => void | Promise<void>
 * @property   {Function} room-leave      -(this: Wechaty, room: Room, leaverList: Contact[]) => void | Promise<void>
 * @property   {Function} room-invite     -(this: Wechaty, room: Room, roomInvitation: RoomInvitation) => void | Promise<void> <br>
 *                                        see more in  {@link RoomInvitation}
 */
/**
 * @listens Wechaty
 * @param   {WechatyEventName}      event      - Emit WechatyEvent
 * @param   {WechatyEventFunction}  listener   - Depends on the WechatyEvent
 *
 * @return  {Wechaty}                          - this for chaining,
 * see advanced {@link https://github.com/wechaty/getting-started/wiki/FAQ#36-why-wechatyonevent-listener-return-wechaty|chaining usage}
 *
 * @desc
 * When the bot get message, it will emit the following Event.
 *
 * You can do anything you want when in these events functions.
 * The main Event name as follows:
 * - **scan**: Emit when the bot needs to show you a QR Code for scanning. After scan the qrcode, you can login
 * - **login**: Emit when bot login full successful.
 * - **logout**: Emit when bot detected log out.
 * - **message**: Emit when there's a new message.
 *
 * see more in {@link WechatyEventName}
 *
 * @example <caption>Event:scan</caption>
 * // Scan Event will emit when the bot needs to show you a QR Code for scanning
 *
 * bot.on('scan', (url, status) => {
 *   console.log(`[${status}] Scan ${url} to login.` )
 * })
 *
 * @example <caption>Event:login </caption>
 * // Login Event will emit when bot login full successful.
 *
 * bot.on('login', (user) => {
 *   console.log(`user ${user} login`)
 * })
 *
 * @example <caption>Event:logout </caption>
 * // Logout Event will emit when bot detected log out.
 *
 * bot.on('logout', (user) => {
 *   console.log(`user ${user} logout`)
 * })
 *
 * @example <caption>Event:message </caption>
 * // Message Event will emit when there's a new message.
 *
 * wechaty.on('message', (message) => {
 *   console.log(`message ${message} received`)
 * })
 *
 * @example <caption>Event:friendship </caption>
 * // Friendship Event will emit when got a new friend request, or friendship is confirmed.
 *
 * bot.on('friendship', (friendship) => {
 *   if(friendship.type() === Friendship.Type.Receive){ // 1. receive new friendship request from new contact
 *     const contact = friendship.contact()
 *     let result = await friendship.accept()
 *       if(result){
 *         console.log(`Request from ${contact.name()} is accept successfully!`)
 *       } else{
 *         console.log(`Request from ${contact.name()} failed to accept!`)
 *       }
 *  } else if (friendship.type() === Friendship.Type.Confirm) { // 2. confirm friendship
 *       console.log(`new friendship confirmed with ${contact.name()}`)
 *    }
 *  })
 *
 * @example <caption>Event:room-join </caption>
 * // room-join Event will emit when someone join the room.
 *
 * bot.on('room-join', (room, inviteeList, inviter) => {
 *   const nameList = inviteeList.map(c => c.name()).join(',')
 *   console.log(`Room ${room.topic()} got new member ${nameList}, invited by ${inviter}`)
 * })
 *
 * @example <caption>Event:room-leave </caption>
 * // room-leave Event will emit when someone leave the room.
 *
 * bot.on('room-leave', (room, leaverList) => {
 *   const nameList = leaverList.map(c => c.name()).join(',')
 *   console.log(`Room ${room.topic()} lost member ${nameList}`)
 * })
 *
 * @example <caption>Event:room-topic </caption>
 * // room-topic Event will emit when someone change the room's topic.
 *
 * bot.on('room-topic', (room, topic, oldTopic, changer) => {
 *   console.log(`Room ${room.topic()} topic changed from ${oldTopic} to ${topic} by ${changer.name()}`)
 * })
 *
 * @example <caption>Event:room-invite, RoomInvitation has been encapsulated as a RoomInvitation Class. </caption>
 * // room-invite Event will emit when there's an room invitation.
 *
 * bot.on('room-invite', async roomInvitation => {
 *   try {
 *     console.log(`received room-invite event.`)
 *     await roomInvitation.accept()
 *   } catch (e) {
 *     console.error(e)
 *   }
 * })
 *
 * @example <caption>Event:error </caption>
 * // error Event will emit when there's an error occurred.
 *
 * bot.on('error', (error) => {
 *   console.error(error)
 * })
 */
interface WechatyEventListeners {
    'room-invite': WechatyEventListenerRoomInvite;
    'room-join': WechatyEventListenerRoomJoin;
    'room-leave': WechatyEventListenerRoomLeave;
    'room-topic': WechatyEventListenerRoomTopic;
    'room-announce': WechatyEventListenerRoomAnnounce;
    dong: WechatyEventListenerDong;
    error: WechatyEventListenerError;
    friendship: WechatyEventListenerFriendship;
    heartbeat: WechatyEventListenerHeartbeat;
    login: WechatyEventListenerLogin;
    logout: WechatyEventListenerLogout;
    message: WechatyEventListenerMessage;
    post: WechatyEventListenerPost;
    puppet: WechatyEventListenerPuppet;
    ready: WechatyEventListenerReady;
    scan: WechatyEventListenerScan;
    start: WechatyEventListenerStartStop;
    stop: WechatyEventListenerStartStop;
    'contact-tag-add': WechatyEventListenerContactTagAdd;
    'contact-tag-remove': WechatyEventListenerContactTagRemove;
    'contact-name': WechatyEventListenerContactName;
    'contact-alias': WechatyEventListenerContactAlias;
    'contact-phone': WechatyEventListenerContactPhone;
    'contact-description': WechatyEventListenerContactDescription;
    'contact-corporation': WechatyEventListenerContactCorporation;
    'room-owner': WechatyEventListenerRoomOwner;
    'tag': WechatyEventListenerTag;
    'tag-group': WechatyEventListenerTagGroup;
    'post-comment': WechatyEventListenerPostComment;
    'post-tap': WechatyEventListenerPostTap;
    'verify-code': WechatyEventListenerVerifyCode;
    'dirty': WechatyEventListenerDirty;
    'login-url': WechatyEventListenerLoginUrl;
}
declare const WechatyEventEmitter: new () => TypedEventEmitter<WechatyEventListeners>;
export type { WechatyEventName, WechatyEventListeners, WechatyEventListenerDong, WechatyEventListenerError, WechatyEventListenerFriendship, WechatyEventListenerHeartbeat, WechatyEventListenerLogin, WechatyEventListenerLogout, WechatyEventListenerMessage, WechatyEventListenerPost, WechatyEventListenerPuppet, WechatyEventListenerReady, WechatyEventListenerRoomInvite, WechatyEventListenerRoomJoin, WechatyEventListenerRoomLeave, WechatyEventListenerRoomTopic, WechatyEventListenerRoomOwner, WechatyEventListenerRoomAnnounce, WechatyEventListenerScan, WechatyEventListenerStartStop, WechatyEventListenerContactTagAdd, WechatyEventListenerContactTagRemove, WechatyEventListenerContactName, WechatyEventListenerContactAlias, WechatyEventListenerContactPhone, WechatyEventListenerContactDescription, WechatyEventListenerContactCorporation, WechatyEventListenerTag, WechatyEventListenerTagGroup, WechatyEventListenerPostComment, WechatyEventListenerPostTap, WechatyEventListenerVerifyCode, WechatyEventListenerDirty, WechatyEventListenerLoginUrl, };
export { WechatyEventEmitter, };
//# sourceMappingURL=wechaty-events.d.ts.map