@juzi/wechaty
Version:
Wechaty is a RPA SDK for Chatbot Makers.
1,226 lines • 45.8 kB
JavaScript
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.MessageImpl = void 0;
/**
* Wechaty Chatbot SDK - https://github.com/wechaty/wechaty
*
* @copyright 2016 Huan LI (李卓桓) <https://github.com/huan>, and
* Wechaty Contributors <https://github.com/wechaty>.
*
* 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.
*
*/
const events_1 = require("events");
const PUPPET = __importStar(require("@juzi/wechaty-puppet"));
const escape_regexp_js_1 = require("../pure-functions/escape-regexp.js");
const timestamp_to_date_js_1 = require("../pure-functions/timestamp-to-date.js");
const config_js_1 = require("../config.js");
const mod_js_1 = require("../sayable/mod.js");
const wechatify_js_1 = require("../user-mixins/wechatify.js");
const post_js_1 = require("./post.js");
const validation_js_1 = require("../user-mixins/validation.js");
const rx_queue_1 = require("rx-queue");
const MixinBase = (0, wechatify_js_1.wechatifyMixin)(events_1.EventEmitter);
const ALLOW_PREVIEW_TYPES = [
PUPPET.types.Message.Image,
PUPPET.types.Message.MiniProgram,
PUPPET.types.Message.Video,
PUPPET.types.Message.Url,
PUPPET.types.Message.Channel,
PUPPET.types.Message.Post,
];
/**
* All wechat messages will be encapsulated as a Message.
*
* [Examples/Ding-Dong-Bot]{@link https://github.com/wechaty/wechaty/blob/1523c5e02be46ebe2cc172a744b2fbe53351540e/examples/ding-dong-bot.ts}
*/
class MessageMixin extends MixinBase {
id;
/**
*
* Static Properties
*
*/
/**
* @ignore
*/
static Type = PUPPET.types.Message;
/**
* Find message in cache
*/
static async find(query) {
config_js_1.log.verbose('Message', 'find(%s)', JSON.stringify(query));
if (typeof query === 'object' && query.id) {
const message = this.load(query.id);
try {
await message.ready();
}
catch (e) {
this.wechaty.emitError(e);
return undefined;
}
return message;
}
if (typeof query === 'string') {
query = { text: query };
}
const messageList = await this.findAll(query);
if (messageList.length < 1) {
return undefined;
}
if (messageList.length > 1) {
config_js_1.log.warn('Message', 'findAll() got more than one(%d) result', messageList.length);
}
return messageList[0];
}
/**
* Find messages in cache
*/
static async findAll(query) {
config_js_1.log.verbose('Message', 'findAll(%s)', JSON.stringify(query) || '');
// Huan(202111): { id } query has been optimized in the PuppetAbstract class
const invalidDict = {};
try {
const MessageIdList = await this.wechaty.puppet.messageSearch(query);
const messageList = MessageIdList.map(id => this.load(id));
await Promise.all(messageList.map(message => message.ready()
.catch(e => {
config_js_1.log.warn('Room', 'findAll() message.ready() rejection: %s', e);
invalidDict[message.id] = true;
})));
return messageList.filter(message => !invalidDict[message.id]);
}
catch (e) {
this.wechaty.emitError(e);
config_js_1.log.warn('Message', 'findAll() rejected: %s', e.message);
return []; // fail safe
}
}
/**
* Create a Mobile Terminated Message
* @ignore
* "mobile originated" or "mobile terminated"
* https://www.tatango.com/resources/video-lessons/video-mo-mt-sms-messaging/
*/
static load(id) {
config_js_1.log.verbose('Message', 'static load(%s)', id);
/**
* Must NOT use `Message` at here
* MUST use `this` at here
*
* because the class will be `cloneClass`-ed
*/
const msg = new this(id);
return msg;
}
static async getBroadcastTargets() {
config_js_1.log.verbose('Message', 'static getBroadcastTargets()');
const { contactIds = [], roomIds = [] } = await this.wechaty.puppet.getMessageBroadcastTarget();
const CONCURRENCY = 17;
let roomContinuousErrorCount = 0;
let roomTotalErrorCount = 0;
const roomTotalErrorThreshold = Math.round(roomIds.length / 5);
const idToRoom = async (id) => {
if (!this.wechaty.isLoggedIn) {
throw new Error('wechaty not logged in');
}
const result = await this.wechaty.Room.find({ id }).catch(e => {
this.wechaty.emitError(e);
roomContinuousErrorCount++;
roomTotalErrorCount++;
if (roomContinuousErrorCount > 5) {
throw new Error('5 continuous errors!');
}
if (roomTotalErrorCount > roomTotalErrorThreshold) {
throw new Error(`${roomTotalErrorThreshold} total errors!`);
}
});
roomContinuousErrorCount = 0;
return result;
};
const roomIterator = (0, rx_queue_1.concurrencyExecuter)(CONCURRENCY)(idToRoom)(roomIds);
const roomList = [];
for await (const room of roomIterator) {
if (room) {
roomList.push(room);
}
}
let contactContinuousErrorCount = 0;
let contactTotalErrorCount = 0;
const contactTotalErrorThreshold = Math.round(roomIds.length / 5);
const idToContact = async (id) => {
if (!this.wechaty.isLoggedIn) {
throw new Error('wechaty not logged in');
}
const result = await this.wechaty.Contact.find({ id }).catch(e => {
this.wechaty.emitError(e);
contactContinuousErrorCount++;
contactTotalErrorCount++;
if (contactContinuousErrorCount > 5) {
throw new Error('5 continuous errors!');
}
if (contactTotalErrorCount > contactTotalErrorThreshold) {
throw new Error(`${contactTotalErrorThreshold} total errors!`);
}
});
contactContinuousErrorCount = 0;
return result;
};
const contactIterator = (0, rx_queue_1.concurrencyExecuter)(CONCURRENCY)(idToContact)(contactIds);
const contactList = [];
for await (const contact of contactIterator) {
if (contact) {
contactList.push(contact);
}
}
return {
contacts: contactList,
rooms: roomList,
};
}
static async createBroadcast(targets, post) {
config_js_1.log.verbose('Message', 'static createBroadcast()');
const targetIds = targets.map(target => target.id);
const type = post.payload.type || PUPPET.types.Post.Unspecified;
if (type !== PUPPET.types.Post.Broadcast) {
throw new Error(`you cannot create broadcast with type ${PUPPET.types.Post[type]}`);
}
const postId = await this.wechaty.puppet.createMessageBroadcast(targetIds, post.payload);
if (postId) {
return this.wechaty.Post.find({ id: postId });
}
}
static async getBroadcastStatus(broadcast) {
config_js_1.log.verbose('Message', 'static getBroadcastStatus()');
const postId = broadcast.id;
if (!postId) {
throw new Error('cannot get status from a post with no Id');
}
const type = broadcast.payload.type;
if (type !== PUPPET.types.Post.Broadcast) {
throw new Error(`cannot get status from a ${PUPPET.types.Post[type || 0]} post`);
}
const result = await this.wechaty.puppet.getMessageBroadcastStatus(postId);
const broadcastStatus = {
status: result.status,
detail: [],
};
const CONCURRENCY = 17;
const targetStatusToWechatyTargetStatus = async (detail) => {
let contact;
let room;
if (detail.contactId) {
try {
contact = await this.wechaty.Contact.find({ id: detail.contactId });
}
catch (e) {
this.wechaty.emitError(e);
contact = undefined;
}
}
if (detail.roomId) {
try {
room = await this.wechaty.Room.find({ id: detail.roomId });
}
catch (e) {
this.wechaty.emitError(e);
room = undefined;
}
}
return {
contact,
room,
status: detail.status,
};
};
const targetStatusIterator = (0, rx_queue_1.concurrencyExecuter)(CONCURRENCY)(targetStatusToWechatyTargetStatus)(result.detail);
for await (const targetStatus of targetStatusIterator) {
if (targetStatus.contact || targetStatus.room) {
broadcastStatus.detail.push(targetStatus);
}
}
return broadcastStatus;
}
static async mergeForward(to, messageList) {
config_js_1.log.verbose('Message', `mergeForward(${messageList})`);
try {
const msgId = await this.wechaty.puppet.messageForward(to.id, messageList.map(msg => msg.id));
if (msgId) {
const msg = await this.wechaty.Message.find({ id: msgId });
return msg;
}
}
catch (e) {
config_js_1.log.error('Message', 'forward(%s) exception: %s', to, e);
throw e;
}
}
/**
*
* Instance Properties
* @hidden
*
*/
payload;
/**
* @hideconstructor
*/
constructor(id) {
super();
this.id = id;
config_js_1.log.verbose('Message', 'constructor(%s) for class %s', id || '', this.constructor.name);
}
/**
* @ignore
*/
toString() {
if (!this.payload) {
return this.constructor.name;
}
let talker;
try {
talker = this.talker();
}
catch (e) {
talker = e.message;
}
const msgStrList = [
'Message',
`#${PUPPET.types.Message[this.type()]}`,
'[',
'🗣',
talker,
this.room()
? '@👥' + this.room()
: '',
']',
];
if (this.type() === PUPPET.types.Message.Text
|| this.type() === PUPPET.types.Message.Unknown) {
msgStrList.push(`\t${this.text().substr(0, 70)}`);
}
else {
config_js_1.log.silly('Message', 'toString() for message type: %s(%s)', PUPPET.types.Message[this.type()], this.type());
// if (!this.#payload) {
// throw new Error('no payload')
// }
}
return msgStrList.join('');
}
conversation() {
if (this.room()) {
return this.room();
}
else {
return this.talker();
}
}
/**
* Get the talker of a message.
* @returns {ContactInterface}
* @example
* const bot = new Wechaty()
* bot
* .on('message', async m => {
* const talker = msg.talker()
* const text = msg.text()
* const room = msg.room()
* if (room) {
* const topic = await room.topic()
* console.log(`Room: ${topic} Contact: ${talker.name()} Text: ${text}`)
* } else {
* console.log(`Contact: ${talker.name()} Text: ${text}`)
* }
* })
* .start()
*/
talker() {
if (!this.payload) {
throw new Error('no payload');
}
let talkerId = this.payload.talkerId;
if (!talkerId) {
/**
* `fromId` is deprecated, this code block will be removed in v2.0
*/
if (this.payload.fromId) {
talkerId = this.payload.fromId;
}
else {
throw new Error('no talkerId found for talker');
}
config_js_1.log.warn('Message', 'talker() payload.talkerId not exist! See: https://github.com/wechaty/puppet/issues/187');
console.error('Puppet: %s@%s', this.wechaty.puppet.name(), this.wechaty.puppet.version());
console.error(new Error().stack);
}
let talker;
if (this.wechaty.isLoggedIn && talkerId === this.wechaty.puppet.currentUserId) {
talker = this.wechaty.ContactSelf.load(talkerId);
}
else {
talker = this.wechaty.Contact.load(talkerId);
}
return talker;
}
/**
* @depreacated Use `message.talker()` to replace `message.from()`
* https://github.com/wechaty/wechaty/issues/2094
*/
from() {
config_js_1.log.warn('Message', 'from() is deprecated, use talker() instead. Call stack: %s', new Error().stack);
try {
return this.talker();
}
catch (e) {
this.wechaty.emitError(e);
return undefined;
}
}
/**
* Get the destination of the message
* Message.to() will return null if a message is in a room, use Message.room() to get the room.
* @returns {(ContactInterface|null)}
* @deprecated use `listener()` instead
*/
to() {
// Huan(202108): I want to deprecate this method name in the future,
// and use `message.listener()` to replace it.
return this.listener();
}
/**
* Get the destination of the message
* Message.listener() will return null if a message is in a room,
* use Message.room() to get the room.
* @returns {(undefined | ContactInterface)}
*/
listener() {
if (!this.payload) {
throw new Error('no payload');
}
let listenerId = this.payload.listenerId;
if (!listenerId && this.payload.toId) {
/**
* `toId` is deprecated, this code block will be removed in v2.0
*/
listenerId = this.payload.toId;
config_js_1.log.warn('Message', 'listener() payload.listenerId should be set! See: https://github.com/wechaty/puppet/issues/187');
console.error('Puppet: %s@%s', this.wechaty.puppet.name(), this.wechaty.puppet.version());
console.error(new Error().stack);
}
if (!listenerId) {
return undefined;
}
let listener;
if (listenerId === this.wechaty.puppet.currentUserId) {
listener = this.wechaty.ContactSelf.load(listenerId);
}
else {
listener = this.wechaty.Contact.load(listenerId);
}
return listener;
}
/**
* Get the room from the message.
* If the message is not in a room, then will return `null`
*
* @returns {(RoomInterface | null)}
* @example
* const bot = new Wechaty()
* bot
* .on('message', async m => {
* const contact = msg.from()
* const text = msg.text()
* const room = msg.room()
* if (room) {
* const topic = await room.topic()
* console.log(`Room: ${topic} Contact: ${contact.name()} Text: ${text}`)
* } else {
* console.log(`Contact: ${contact.name()} Text: ${text}`)
* }
* })
* .start()
*/
room() {
if (!this.payload) {
throw new Error('no payload');
}
const roomId = this.payload.roomId;
if (!roomId) {
return undefined;
}
const room = this.wechaty.Room.load(roomId);
return room;
}
/**
* Get the text content of the message
*
* @returns {string}
* @example
* const bot = new Wechaty()
* bot
* .on('message', async m => {
* const contact = msg.from()
* const text = msg.text()
* const room = msg.room()
* if (room) {
* const topic = await room.topic()
* console.log(`Room: ${topic} Contact: ${contact.name()} Text: ${text}`)
* } else {
* console.log(`Contact: ${contact.name()} Text: ${text}`)
* }
* })
* .start()
*/
text() {
if (!this.payload) {
throw new Error('no payload');
}
const oldText = this.payload.text || '';
const newText = (this.payload.textContent || []).map(item => item.text).join('');
if (newText && oldText !== newText) {
config_js_1.log.warn('Message', `got different text, old: ${oldText}, new: ${newText}`);
}
// still use old text before we deprecate old text field
return oldText;
}
/**
* Get the recalled message
*
* @example
* const bot = new Wechaty()
* bot
* .on('message', async m => {
* if (m.type() === PUPPET.types.Message.Recalled) {
* const recalledMessage = await m.toRecalled()
* console.log(`Message: ${recalledMessage} has been recalled.`)
* }
* })
* .start()
*/
async toRecalled() {
if (this.type() !== PUPPET.types.Message.Recalled) {
throw new Error('Can not call toRecalled() on message which is not recalled type.');
}
const originalMessageId = this.text();
if (!originalMessageId) {
throw new Error('Can not find recalled message');
}
try {
const message = await this.wechaty.Message.find({ id: originalMessageId });
if (message) {
return message;
}
}
catch (e) {
this.wechaty.emitError(e);
config_js_1.log.verbose(`Can not retrieve the recalled message with id ${originalMessageId}.`);
}
return undefined;
}
/**
* Reply a Text or Media File message to the sender.
* > Tips:
* This function is depending on the Puppet Implementation, see [puppet-compatible-table](https://github.com/wechaty/wechaty/wiki/Puppet#3-puppet-compatible-table)
*
* @see {@link https://github.com/wechaty/wechaty/blob/1523c5e02be46ebe2cc172a744b2fbe53351540e/examples/ding-dong-bot.ts|Examples/ding-dong-bot}
* @param {(string | ContactInterface | FileBox | UrlLinkInterface | MiniProgramInterface | LocationInterface)} textOrContactOrFile
* send text, Contact, or file to bot. </br>
* You can use {@link https://www.npmjs.com/package/file-box|FileBox} to send file
* @param {(ContactInterface|ContactInterface[])} [mention]
* If this is a room message, when you set mention param, you can `@` Contact in the room.
* @returns {Promise<void | MessageInterface>}
*
* @example
* import { FileBox } from 'wechaty'
* const bot = new Wechaty()
* bot
* .on('message', async m => {
*
* // 1. send Image
*
* if (/^ding$/i.test(m.text())) {
* const fileBox = FileBox.fromUrl('https://wechaty.github.io/wechaty/images/bot-qr-code.png')
* await msg.say(fileBox)
* const message = await msg.say(fileBox) // only supported by puppet-padplus
* }
*
* // 2. send Text
*
* if (/^dong$/i.test(m.text())) {
* await msg.say('ding')
* const message = await msg.say('ding') // only supported by puppet-padplus
* }
*
* // 3. send Contact
*
* if (/^lijiarui$/i.test(m.text())) {
* const contactCard = await bot.Contact.find({name: 'lijiarui'})
* if (!contactCard) {
* console.log('not found')
* return
* }
* await msg.say(contactCard)
* const message = await msg.say(contactCard) // only supported by puppet-padplus
* }
*
* // 4. send Link
*
* if (/^link$/i.test(m.text())) {
* const linkPayload = new UrlLink ({
* description : 'WeChat Bot SDK for Individual Account, Powered by TypeScript, Docker, and Love',
* thumbnailUrl: 'https://avatars0.githubusercontent.com/u/25162437?s=200&v=4',
* title : 'Welcome to Wechaty',
* url : 'https://github.com/wechaty/wechaty',
* })
* await msg.say(linkPayload)
* const message = await msg.say(linkPayload) // only supported by puppet-padplus
* }
*
* // 5. send MiniProgram
*
* if (/^miniProgram$/i.test(m.text())) {
* const miniProgramPayload = new MiniProgram ({
* username : 'gh_xxxxxxx', //get from mp.weixin.qq.com
* appid : '', //optional, get from mp.weixin.qq.com
* title : '', //optional
* pagepath : '', //optional
* description : '', //optional
* thumbnailurl : '', //optional
* })
* await msg.say(miniProgramPayload)
* const message = await msg.say(miniProgramPayload) // only supported by puppet-padplus
* }
*
* // 6. send Location
* if (/^location$/i.test(m.text())) {
* const location = new Location ({
* accuracy : 15,
* address : '北京市北京市海淀区45 Chengfu Rd',
* latitude : 39.995120999999997,
* longitude : 116.334154,
* name : '东升乡人民政府(海淀区成府路45号)',
* })
* await contact.say(location)
* const msg = await msg.say(location)
* }
* })
* .start()
*/
async say(sayable) {
config_js_1.log.verbose('Message', 'say(%s)', sayable);
const talker = this.talker();
const room = this.room();
if (room) {
return room.say(sayable);
}
else {
return talker.say(sayable);
}
}
/**
* Reply a message while quoting the original one
* @param text
* @param mentionIdList
*/
async reply(text, mentionList) {
config_js_1.log.verbose('Message', 'say(%s)', text);
const talker = this.talker();
const room = this.room();
if (room) {
return room.say(text, {
mentionList,
quoteMessage: this,
});
}
else {
return talker.say(text, {
quoteMessage: this,
});
}
}
/**
* Recall a message.
* > Tips:
* @returns {Promise<boolean>}
*
* @example
* const bot = new Wechaty()
* bot
* .on('message', async m => {
* const recallMessage = await msg.say('123')
* if (recallMessage) {
* const isSuccess = await recallMessage.recall()
* }
* })
*/
async recall() {
config_js_1.log.verbose('Message', 'recall()');
const isSuccess = await this.wechaty.puppet.messageRecall(this.id);
return isSuccess;
}
/**
* Get the type from the message.
* > Tips: PUPPET.types.Message is Enum here. </br>
* - PUPPET.types.Message.Unknown </br>
* - PUPPET.types.Message.Attachment </br>
* - PUPPET.types.Message.Audio </br>
* - PUPPET.types.Message.Contact </br>
* - PUPPET.types.Message.Emoticon </br>
* - PUPPET.types.Message.Image </br>
* - PUPPET.types.Message.Text </br>
* - PUPPET.types.Message.Video </br>
* - PUPPET.types.Message.Url </br>
* @returns {PUPPET.types.Message}
*
* @example
* const bot = new Wechaty()
* if (message.type() === bot.Message.Type.Text) {
* console.log('This is a text message')
* }
*/
type() {
if (!this.payload) {
throw new Error('no payload');
}
return this.payload.type || PUPPET.types.Message.Unknown;
}
/**
* Check if a message is sent by self.
*
* @returns {boolean} - Return `true` for send from self, `false` for send from others.
* @example
* if (message.self()) {
* console.log('this message is sent by myself!')
* }
*/
self() {
try {
const talker = this.talker();
return talker.id === this.wechaty.puppet.currentUserId;
}
catch (e) {
this.wechaty.emitError(e);
config_js_1.log.error('Message', 'self() rejection: %s', e.message);
return false;
}
}
/**
*
* Get message mentioned contactList.
*
* Message event table as follows
*
* | | Web | Mac PC Client | iOS Mobile | android Mobile |
* | :--- | :--: | :----: | :---: | :---: |
* | [You were mentioned] tip ([有人@我]的提示) | ✘ | √ | √ | √ |
* | Identify magic code (8197) by copy & paste in mobile | ✘ | √ | √ | ✘ |
* | Identify magic code (8197) by programming | ✘ | ✘ | ✘ | ✘ |
* | Identify two contacts with the same roomAlias by [You were mentioned] tip | ✘ | ✘ | √ | √ |
*
* @returns {Promise<ContactInterface[]>} - Return message mentioned contactList
*
* @example
* const contactList = await message.mentionList()
* console.log(contactList)
*/
async mentionList() {
config_js_1.log.verbose('Message', 'mentionList()');
const room = this.room();
if (this.type() !== PUPPET.types.Message.Text || !room) {
return [];
}
/**
* 1. Use mention list if mention list is available
*/
if (this.payload
&& 'mentionIdList' in this.payload
&& Array.isArray(this.payload.mentionIdList)) {
const contactList = await this.wechaty.Contact.batchLoadContacts(this.payload.mentionIdList);
// remove `undefined` types because we use a `filter(Boolean)`
return contactList;
}
/**
* 2. Otherwise, process the message and get the mention list
*/
/**
* define magic code `8197` to identify @xxx
* const AT_SEPARATOR = String.fromCharCode(8197)
*/
const atList = this.text().split(config_js_1.AT_SEPARATOR_REGEX);
// console.log('atList: ', atList)
if (atList.length === 0)
return [];
// Using `filter(e => e.indexOf('@') > -1)` to filter the string without `@`
const rawMentionList = atList
.filter(str => str.includes('@'))
.map(str => multipleAt(str));
// convert 'hello@a@b@c' to [ 'c', 'b@c', 'a@b@c' ]
function multipleAt(str) {
str = str.replace(/^.*?@/, '@');
let name = '';
const nameList = [];
str.split('@')
.filter(mentionName => !!mentionName)
.reverse()
.forEach(mentionName => {
// console.log('mentionName: ', mentionName)
name = mentionName + '@' + name;
nameList.push(name.slice(0, -1)); // get rid of the `@` at beginning
});
return nameList;
}
let mentionNameList = [];
// Flatten Array
// see http://stackoverflow.com/a/10865042/1123955
mentionNameList = mentionNameList.concat.apply([], rawMentionList);
// filter blank string
mentionNameList = mentionNameList.filter(s => !!s);
config_js_1.log.verbose('Message', 'mentionList() text = "%s", mentionNameList = "%s"', this.text(), JSON.stringify(mentionNameList));
const contactListNested = await Promise.all(mentionNameList.map(name => room.memberAll(name)));
let contactList = [];
contactList = contactList.concat.apply([], contactListNested);
if (contactList.length === 0) {
config_js_1.log.silly('Message', `message.mentionList() can not found member using room.member() from mentionList, mention string: ${JSON.stringify(mentionNameList)}`);
}
return contactList;
}
isMentionAll() {
config_js_1.log.verbose('Message', 'isMentionAll()');
const room = this.room();
if (this.type() !== PUPPET.types.Message.Text || !room) {
return false;
}
if (this.payload
&& 'mentionIdList' in this.payload
&& Array.isArray(this.payload.mentionIdList)) {
return this.payload.mentionIdList.some(id => id === this.payload?.talkerId);
}
else {
return false;
}
}
/**
* @deprecated mention() DEPRECATED. use mentionList() instead.
*/
async mention() {
config_js_1.log.warn('Message', 'mention() DEPRECATED. use mentionList() instead. Call stack: %s', new Error().stack);
return this.mentionList();
}
async mentionText() {
const text = this.text();
const room = this.room();
const mentionList = await this.mentionList();
if (!room || mentionList.length === 0) {
return text;
}
if (this.payload?.textContent?.length) {
const text = this.payload.textContent.map(item => {
const type = item.type;
switch (type) {
case PUPPET.types.TextContentType.Regular:
return item.text;
case PUPPET.types.TextContentType.At:
return '';
default:
config_js_1.log.warn(`got unknown type ${type} in text content`);
return '';
}
}).join('');
return text;
}
else {
const toAliasName = async (member) => {
const alias = await room.alias(member);
const name = member.name();
return alias || name;
};
const mentionNameList = await Promise.all(mentionList.map(toAliasName));
const textWithoutMention = mentionNameList.reduce((prev, cur) => {
const escapedCur = (0, escape_regexp_js_1.escapeRegExp)(cur);
const regex = new RegExp(`@${escapedCur}(\u2005|\u0020|$)`);
return prev.replace(regex, '');
}, text);
return textWithoutMention.trim();
}
}
/**
* Check if a message is mention self.
*
* @returns {boolean} - Return `true` for mention me.
* @example
* if (message.mentionSelf()) {
* console.log('this message were mentioned me! [You were mentioned] tip ([有人@我]的提示)')
* }
*/
mentionSelf() {
if (this.payload?.roomId
&& 'mentionIdList' in this.payload
&& Array.isArray(this.payload.mentionIdList)) {
const currentUserId = this.wechaty.puppet.currentUserId;
// const mentionList = await this.mentionList()
const mentionIdList = this.payload.mentionIdList;
return mentionIdList.some(id => id === currentUserId);
}
else {
return false;
}
}
/**
* @ignore
*/
isReady() {
return !!this.payload;
}
/**
* @ignore
*/
async ready(forceSync = false) {
config_js_1.log.verbose('Message', 'ready()');
if (this.isReady() && !forceSync) {
return;
}
this.payload = await this.wechaty.puppet.messagePayload(this.id);
let talkerId = this.payload.talkerId;
if (!talkerId) {
/**
* `fromId` is deprecated: this code block will be removed in v2.0
*/
if (this.payload.fromId) {
talkerId = this.payload.fromId;
}
else {
throw new Error('no talkerId found for talker');
}
config_js_1.log.warn('Message', 'ready() payload.talkerId not exist! See: https://github.com/wechaty/puppet/issues/187');
console.error('Puppet: %s@%s', this.wechaty.puppet.name(), this.wechaty.puppet.version());
console.error(new Error().stack);
}
const roomId = this.payload.roomId;
let listenerId = this.payload.listenerId;
if (!listenerId && this.payload.toId) {
/**
* `fromId` is deprecated: this code block will be removed in v2.0
*/
listenerId = this.payload.toId;
config_js_1.log.warn('Message', 'ready() payload.listenerId should be set! See: https://github.com/wechaty/puppet/issues/187');
console.error('Puppet: %s@%s', this.wechaty.puppet.name(), this.wechaty.puppet.version());
console.error(new Error().stack);
}
if (roomId) {
await this.wechaty.Room.find({ id: roomId });
}
if (talkerId) {
await this.wechaty.Contact.find({ id: talkerId });
}
if (listenerId) {
await this.wechaty.Contact.find({ id: listenerId });
}
}
// case WebMsgType.APP:
// if (!this.rawObj) {
// throw new Error('no rawObj')
// }
// switch (this.typeApp()) {
// case WebAppMsgType.ATTACH:
// if (!this.rawObj.MMAppMsgDownloadUrl) {
// throw new Error('no MMAppMsgDownloadUrl')
// }
// // had set in Message
// // url = this.rawObj.MMAppMsgDownloadUrl
// break
// case WebAppMsgType.URL:
// case WebAppMsgType.READER_TYPE:
// if (!this.rawObj.Url) {
// throw new Error('no Url')
// }
// // had set in Message
// // url = this.rawObj.Url
// break
// default:
// const e = new Error('ready() unsupported typeApp(): ' + this.typeApp())
// log.warn('PuppeteerMessage', e.message)
// throw e
// }
// break
// case WebMsgType.TEXT:
// if (this.typeSub() === WebMsgType.LOCATION) {
// url = await puppet.bridge.getMsgPublicLinkImg(this.id)
// }
// break
/**
* Forward the received message.
*
* @param {(Sayable | Sayable[])} to Room or Contact
* The recipient of the message, the room, or the contact
* @returns {Promise<void>}
* @example
* const bot = new Wechaty()
* bot
* .on('message', async m => {
* const room = await bot.Room.find({topic: 'wechaty'})
* if (room) {
* await m.forward(room)
* console.log('forward this message to wechaty room!')
* }
* })
* .start()
*/
async forward(to) {
config_js_1.log.verbose('Message', 'forward(%s)', to);
// let roomId
// let contactId
try {
const msgId = await this.wechaty.puppet.messageForward(to.id, this.id);
if (msgId) {
const msg = await this.wechaty.Message.find({ id: msgId });
return msg;
}
}
catch (e) {
config_js_1.log.error('Message', 'forward(%s) exception: %s', to, e);
throw e;
}
}
/**
* Message sent date
*/
date() {
if (!this.payload) {
throw new Error('no payload');
}
const timestamp = this.payload.timestamp;
return (0, timestamp_to_date_js_1.timestampToDate)(timestamp);
}
/**
* Returns the message age in seconds. <br>
*
* For example, the message is sent at time `8:43:01`,
* and when we received it in Wechaty, the time is `8:43:15`,
* then the age() will return `8:43:15 - 8:43:01 = 14 (seconds)`
*
* @returns {number} message age in seconds.
*/
age() {
const ageMilliseconds = Date.now() - this.date().getTime();
const ageSeconds = Math.floor(ageMilliseconds / 1000);
return ageSeconds;
}
/**
* Extract the Media File from the Message, and put it into the FileBox.
* > Tips:
* This function is depending on the Puppet Implementation, see [puppet-compatible-table](https://github.com/wechaty/wechaty/wiki/Puppet#3-puppet-compatible-table)
*
* @returns {Promise<FileBoxInterface>}
*
* @example <caption>Save media file from a message</caption>
* const fileBox = await message.toFileBox()
* const fileName = fileBox.name
* fileBox.toFile(fileName)
*/
async toFileBox() {
config_js_1.log.verbose('Message', 'toFileBox()');
if (this.type() === PUPPET.types.Message.Text) {
throw new Error('text message no file');
}
const fileBox = await this.wechaty.puppet.messageFile(this.id);
return fileBox;
}
/**
* Extract the Image File from the Message, so that we can use different image sizes.
* > Tips:
* This function is depending on the Puppet Implementation, see [puppet-compatible-table](https://github.com/wechaty/wechaty/wiki/Puppet#3-puppet-compatible-table)
*
* @returns {ImageInterface}
*
* @example <caption>Save image file from a message</caption>
* const image = message.toImage()
* const fileBox = await image.artwork()
* const fileName = fileBox.name
* fileBox.toFile(fileName)
*/
toImage() {
config_js_1.log.verbose('Message', 'toImage() for message id: %s', this.id);
if (this.type() !== PUPPET.types.Message.Image) {
throw new Error(`not a image type message. type: ${this.type()}`);
}
return this.wechaty.Image.create(this.id);
}
async toPreview() {
config_js_1.log.verbose('Message', 'toPreview() for message id: %s', this.id);
if (!ALLOW_PREVIEW_TYPES.some(e => e === this.type())) {
throw new Error(`cannot get preview for this type. type: ${this.type}`);
}
return this.wechaty.puppet.messagePreview(this.id);
}
/**
* Get Share Card of the Message
* Extract the Contact Card from the Message, and encapsulate it into Contact class
* > Tips:
* This function is depending on the Puppet Implementation, see [puppet-compatible-table](https://github.com/wechaty/wechaty/wiki/Puppet#3-puppet-compatible-table)
* @returns {Promise<ContactInterface>}
*/
async toContact() {
config_js_1.log.verbose('Message', 'toContact()');
if (this.type() !== PUPPET.types.Message.Contact) {
throw new Error('message not a ShareCard');
}
const contactId = await this.wechaty.puppet.messageContact(this.id);
if (!contactId) {
throw new Error(`can not get Contact id by message: ${contactId}`);
}
const contact = await this.wechaty.Contact.find({ id: contactId });
if (!contact) {
throw new Error(`can not get Contact payload by from id: ${contactId}`);
}
return contact;
}
async toUrlLink() {
config_js_1.log.verbose('Message', 'toUrlLink()');
if (!this.payload) {
throw new Error('no payload');
}
if (this.type() !== PUPPET.types.Message.Url) {
throw new Error('message not a Url Link');
}
const urlPayload = await this.wechaty.puppet.messageUrl(this.id);
return new this.wechaty.UrlLink(urlPayload);
}
async toMiniProgram() {
config_js_1.log.verbose('Message', 'toMiniProgram()');
if (!this.payload) {
throw new Error('no payload');
}
if (this.type() !== PUPPET.types.Message.MiniProgram) {
throw new Error('message not a MiniProgram');
}
const miniProgramPayload = await this.wechaty.puppet.messageMiniProgram(this.id);
return new this.wechaty.MiniProgram(miniProgramPayload);
}
async toLocation() {
config_js_1.log.verbose('Message', 'toLocation()');
if (!this.payload) {
throw new Error('no payload');
}
if (this.type() !== PUPPET.types.Message.Location) {
throw new Error('message not a Location');
}
const locationPayload = await this.wechaty.puppet.messageLocation(this.id);
return new this.wechaty.Location(locationPayload);
}
async toPost() {
config_js_1.log.verbose('Message', 'toPost()');
if (!this.payload) {
throw new Error('no payload');
}
if (this.type() !== PUPPET.types.Message.Post) {
throw new Error('message type not a Post');
}
const post = post_js_1.PostImpl.load(this.id);
await post.ready();
return post;
}
async toChannel() {
config_js_1.log.verbose('Message', 'toChannel()');
if (!this.payload) {
throw new Error('no payload');
}
if (this.type() !== PUPPET.types.Message.Channel) {
throw new Error('message not a Channel');
}
const channelPayload = await this.wechaty.puppet.messageChannel(this.id);
return new this.wechaty.Channel(channelPayload);
}
async toCallRecord() {
config_js_1.log.verbose('Message', 'toCallRecord()');
if (!this.payload) {
throw new Error('no payload');
}
if (this.type() !== PUPPET.types.Message.CallRecord) {
throw new Error('message not a CallRecord');
}
const callRecordPayload = await this.wechaty.puppet.messageCallRecord(this.id);
return new this.wechaty.CallRecord(callRecordPayload);
}
async toChatHistory() {
config_js_1.log.verbose('Message', 'toChatHistory()');
if (!this.payload) {
throw new Error('no payload');
}
if (this.type() !== PUPPET.types.Message.ChatHistory) {
throw new Error('message not a ChatHistory');
}
const chatHistoryPayload = await this.wechaty.puppet.messageChatHistory(this.id);
return new this.wechaty.ChatHistory(chatHistoryPayload);
}
async toSayable() {
config_js_1.log.verbose('Message', 'toSayable()');
return (0, mod_js_1.messageToSayable)(this);
}
async getQuotedMessage() {
config_js_1.log.verbose('Message', 'getQuotedMessage()');
if (!this.payload) {
throw new Error('no payload');
}
if (!this.payload.quoteId) {
return;
}
return this.wechaty.Message.find({ id: this.payload.quoteId });
}
additionalInfo() {
let additionalInfoObj = {};
if (this.payload?.additionalInfo) {
try {
additionalInfoObj = JSON.parse(this.payload.additionalInfo);
}
catch (e) {
config_js_1.log.warn('Message', 'additionalInfo() parse failed, additionalInfo: %s', this.payload.additionalInfo);
}
}
return additionalInfoObj;
}
sendError() {
return this.payload?.sendError;
}
readList() {
return this.payload?.readList;
}
}
class MessageImplBase extends (0, validation_js_1.validationMixin)(MessageMixin)() {
}
class MessageImpl extends (0, validation_js_1.validationMixin)(MessageImplBase)() {
}
exports.MessageImpl = MessageImpl;
//# sourceMappingURL=message.js.map