@juzi/wechaty 1.0.4 → 1.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juzi/wechaty",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Wechaty is a RPA SDK for Chatbot Makers.",
   "type": "module",
   "exports": {
@@ -109,8 +109,8 @@
   },
   "homepage": "https://github.com/wechaty/",
   "dependencies": {
-    "@juzi/wechaty-puppet": "1.0.1",
-    "@juzi/wechaty-puppet-service": "1.0.4",
+    "@juzi/wechaty-puppet": "1.0.2",
+    "@juzi/wechaty-puppet-service": "1.0.6",
     "clone-class": "^1.1.1",
     "cmd-ts": "^0.10.0",
     "cockatiel": "^2.0.2",

package/src/package-json.ts

@@ -4,10 +4,10 @@
  */
 import type { PackageJsonWechaty } from './config'
 
-export const GIT_COMMIT_HASH: string = 'dd3d54130e20590b2d18801e099a0adaa7521176'
+export const GIT_COMMIT_HASH: string = '531918e9b8f05a17b7442054cc26817ea0d187bb'
 export const packageJson: PackageJsonWechaty = {
   "name": "@juzi/wechaty",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Wechaty is a RPA SDK for Chatbot Makers.",
   "type": "module",
   "exports": {
@@ -116,8 +116,8 @@ export const packageJson: PackageJsonWechaty = {
   },
   "homepage": "https://github.com/wechaty/",
   "dependencies": {
-    "@juzi/wechaty-puppet": "1.0.1",
-    "@juzi/wechaty-puppet-service": "1.0.4",
+    "@juzi/wechaty-puppet": "1.0.2",
+    "@juzi/wechaty-puppet-service": "1.0.6",
     "clone-class": "^1.1.1",
     "cmd-ts": "^0.10.0",
     "cockatiel": "^2.0.2",

package/src/sayable/deliver-sayable.ts

@@ -12,12 +12,12 @@ import {
   ChannelImpl,
 }                     from '../user-modules/mod.js'
 
-import type { Sayable } from './types.js'
+import type { Sayable, SayOptionsObject } from './types.js'
 
 /**
  * TODO: add unit test to ensure the interface validation code works
  */
-const deliverSayableConversationPuppet = (puppet: PUPPET.impls.PuppetInterface) => (conversationId: string) => async (sayable: Sayable) => {
+const deliverSayableConversationPuppet = (puppet: PUPPET.impls.PuppetInterface) => (conversationId: string) => async (sayable: Sayable, options?: SayOptionsObject) => {
   let msgId: string | void
 
   if (typeof sayable === 'number') {
@@ -28,6 +28,10 @@ const deliverSayableConversationPuppet = (puppet: PUPPET.impls.PuppetInterface)
     return puppet.messageSendText(
       conversationId,
       sayable,
+      {
+        mentionIdList: options?.mentionList?.map(c => c.id),
+        quoteId: options?.quoteMessage?.id,
+      },
     )
   }
 

package/src/sayable/mod.ts

@@ -1,6 +1,8 @@
 import type {
   SayableSayer,
   Sayable,
+  SayOptions,
+  SayOptionsObject,
 }                                     from './types.js'
 import {
   messageToSayable,
@@ -18,6 +20,8 @@ import {
 export type {
   Sayable,
   SayableSayer,
+  SayOptions,
+  SayOptionsObject,
 }
 export {
   messageToSayable,

package/src/sayable/types.ts

@@ -21,7 +21,7 @@ import type {
   FileBoxInterface,
 }                       from 'file-box'
 
-import type {
+import {
   ContactInterface,
   DelayInterface,
   LocationInterface,
@@ -30,6 +30,8 @@ import type {
   PostInterface,
   UrlLinkInterface,
   ChannelInterface,
+  ContactImpl,
+  MessageImpl,
 }                           from '../user-modules/mod.js'
 
 import type {
@@ -54,11 +56,28 @@ interface SayableSayer {
   wechaty : WechatyInterface,
   say (
     sayable  : Sayable,
-    replyTo? : ContactInterface | ContactInterface[]
+    options? : SayOptions,
   ): Promise<void | MessageInterface>
 }
 
+interface SayOptionsObject {
+  mentionList?: ContactInterface[],
+  quoteMessage?: MessageInterface,
+}
+
+export const isSayOptionsObject = (target: any) => {
+  return (typeof target === 'object'
+    && ((target.mentionList && target.mentionList.every((c: any) => ContactImpl.valid(c)))
+      || (target.quoteMessage && MessageImpl.valid(target.quoteMessage))
+    )
+  )
+}
+
+type SayOptions = ContactInterface | ContactInterface[] | SayOptionsObject
+
 export type {
   SayableSayer,
   Sayable,
+  SayOptions,
+  SayOptionsObject,
 }

package/src/user-modules/contact.ts

@@ -45,6 +45,7 @@ import {
 import type {
   SayableSayer,
   Sayable,
+  SayOptionsObject,
 }                                     from '../sayable/mod.js'
 import { stringifyFilter }            from '../helper-functions/stringify-filter.js'
 
@@ -332,10 +333,16 @@ class ContactMixin extends MixinBase implements SayableSayer {
    */
   async say (
     sayable: Sayable,
+    options?: SayOptionsObject,
   ): Promise<void | MessageInterface> {
     log.verbose('Contact', 'say(%s)', sayable)
 
-    const msgId = await deliverSayableConversationPuppet(this.wechaty.puppet)(this.id)(sayable)
+    if (options?.mentionList) {
+      log.warn('Contact', 'you cannot mention someone in private conversation!')
+      delete options.mentionList
+    }
+
+    const msgId = await deliverSayableConversationPuppet(this.wechaty.puppet)(this.id)(sayable, options)
 
     if (msgId) {
       const msg = await this.wechaty.Message.find({ id: msgId })

package/src/user-modules/message.ts

@@ -560,6 +560,32 @@ class MessageMixin extends MixinBase implements SayableSayer {
     }
   }
 
+  /**
+   * Reply a message while quoting the original one
+   * @param text
+   * @param mentionIdList
+   */
+  async reply (
+    text: string,
+    mentionList?: ContactInterface[],
+  ): Promise<void | MessageInterface> {
+    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:
@@ -1100,6 +1126,19 @@ class MessageMixin extends MixinBase implements SayableSayer {
     return messageToSayable(this)
   }
 
+  async getQuotedMessage (): Promise<undefined | MessageInterface> {
+    log.verbose('Message', 'getQuotedMessage()')
+    if (!this.payload) {
+      throw new Error('no payload')
+    }
+
+    if (!this.payload.quoteId) {
+      throw new Error('this message did not quote another message')
+    }
+
+    return this.wechaty.Message.find({ id: this.payload.quoteId })
+  }
+
 }
 
 class MessageImplBase extends validationMixin(MessageMixin)<MessageImplInterface>() {}

package/src/user-modules/room.ts

@@ -46,7 +46,7 @@ import {
   validationMixin,
 }                                       from '../user-mixins/mod.js'
 import {
-  deliverSayableConversationPuppet,
+  deliverSayableConversationPuppet, SayOptions, SayOptionsObject,
 }                                       from '../sayable/mod.js'
 import type {
   SayableSayer,
@@ -61,6 +61,7 @@ import {
 import type {
   MessageInterface,
 }                       from './message.js'
+import { isSayOptionsObject } from '../sayable/types.js'
 
 const MixinBase = wechatifyMixin(
   poolifyMixin(
@@ -355,7 +356,8 @@ class RoomMixin extends MixinBase implements SayableSayer {
   }
 
   say (sayable:  Sayable)                                 : Promise<void | MessageInterface>
-  say (text:     string, ...mentionList: ContactInterface[])       : Promise<void | MessageInterface>
+  say (text: string, options?: SayOptions): Promise<void | MessageInterface>
+  say (text: string, ...options: SayOptions[]): Promise<void | MessageInterface>
   say (textList: TemplateStringsArray, ...varList: any[]) : Promise<void | MessageInterface>
 
   // Huan(202006): allow fall down to the defination to get more flexibility.
@@ -464,15 +466,23 @@ class RoomMixin extends MixinBase implements SayableSayer {
        * 1. string
        */
       let mentionList: ContactInterface[] = []
+      let quoteMessage: MessageInterface | undefined
+      let options: SayOptionsObject
 
       if (varList.length > 0) {
-        const allIsContact = varList.every(c => ContactImpl.valid(c))
+        if (isSayOptionsObject(varList[0])) {
+          options = varList[0] as SayOptionsObject
+          mentionList = options.mentionList || []
+          quoteMessage = options.quoteMessage
+        } else {
+          mentionList = varList as ContactInterface[]
+        }
+
+        const allIsContact = mentionList.every(c => ContactImpl.valid(c))
         if (!allIsContact) {
           throw new Error('mentionList must be contact when not using TemplateStringsArray function call.')
         }
 
-        mentionList = [...varList as any]
-
         const AT_SEPARATOR = FOUR_PER_EM_SPACE
         const mentionAlias = await Promise.all(mentionList.map(async contact =>
           '@' + (await this.alias(contact) || contact.name()),
@@ -487,11 +497,23 @@ class RoomMixin extends MixinBase implements SayableSayer {
       //   contactId : (mentionList.length && mentionList[0].id) || undefined,
       //   roomId    : this.id,
       // }
-      msgId = await this.wechaty.puppet.messageSendText(
-        this.id,
-        text,
-        mentionList.map(c => c.id),
-      )
+      if (quoteMessage) {
+        msgId = await this.wechaty.puppet.messageSendText(
+          this.id,
+          text,
+          {
+            mentionIdList: mentionList.map(c => c.id),
+            quoteId: quoteMessage.id,
+          },
+        )
+      } else {
+        msgId = await this.wechaty.puppet.messageSendText(
+          this.id,
+          text,
+          mentionList.map(c => c.id),
+        )
+      }
+
     } else {
       msgId = await deliverSayableConversationPuppet(this.wechaty.puppet)(this.id)(sayable)
     }