Follow the puppet@0.19 abstract design

package.json

@@ -97,7 +97,7 @@
     "read-pkg-up": "^7.0.0",
     "state-switch": "^0.6.2",
     "watchdog": "^0.8.1",
-    "wechaty-puppet": "^0.19.5",
+    "wechaty-puppet": "^0.19.6",
     "ws": "^7.0.0"
   },
   "devDependencies": {

src/user/contact-self.ts

@@ -121,7 +121,7 @@ export class ContactSelf extends Contact {
       throw new Error('only can get qrcode for the login userself')
     }
 
-    const qrcodeValue = await this.puppet.contactSelfQrcode()
+    const qrcodeValue = await this.puppet.contactSelfQRCode()
     return guardQrCodeValue(qrcodeValue)
   }
 

src/user/contact.ts

@@ -397,37 +397,42 @@ export class Contact extends Accessory implements Sayable {
       /**
        * 1. Text
        */
-      msgId = await this.puppet.messageSendText({
-        contactId: this.id,
-      }, something)
+      msgId = await this.puppet.messageSendText(
+        this.id,
+        something,
+      )
     } else if (something instanceof Contact) {
       /**
        * 2. Contact
        */
-      msgId = await this.puppet.messageSendContact({
-        contactId: this.id,
-      }, something.id)
+      msgId = await this.puppet.messageSendContact(
+        this.id,
+        something.id,
+      )
     } else if (something instanceof FileBox) {
       /**
        * 3. File
        */
-      msgId = await this.puppet.messageSendFile({
-        contactId: this.id,
-      }, something)
+      msgId = await this.puppet.messageSendFile(
+        this.id,
+        something,
+      )
     } else if (something instanceof UrlLink) {
       /**
        * 4. Link Message
        */
-      msgId = await this.puppet.messageSendUrl({
-        contactId : this.id,
-      }, something.payload)
+      msgId = await this.puppet.messageSendUrl(
+        this.id,
+        something.payload,
+      )
     } else if (something instanceof MiniProgram) {
       /**
        * 5. Mini Program
        */
-      msgId = await this.puppet.messageSendMiniProgram({
-        contactId : this.id,
-      }, something.payload)
+      msgId = await this.puppet.messageSendMiniProgram(
+        this.id,
+        something.payload,
+      )
     } else {
       throw new Error('unsupported arg: ' + something)
     }

src/user/message.ts

@@ -518,47 +518,61 @@ export class Message extends Accessory implements Sayable {
     const from = this.from()
     // const to   = this.to()
     const room = this.room()
+
+    let conversationId: string
+    if (room) {
+      conversationId = room.id
+    } else if (from) {
+      conversationId = from.id
+    } else {
+      throw new Error('neither room nor from?')
+    }
+
     let msgId: void | string
     if (typeof textOrContactOrFileOrUrlOrMini === 'string') {
       /**
        * Text Message
        */
-      msgId = await this.puppet.messageSendText({
-        contactId : (from && from.id) || undefined,
-        roomId    : (room && room.id) || undefined,
-      }, textOrContactOrFileOrUrlOrMini)
+      // msgId = await this.puppet.messageSendText({
+      //   contactId : (from && from.id) || undefined,
+      //   roomId    : (room && room.id) || undefined,
+      // }, textOrContactOrFileOrUrlOrMini)
+      msgId = await this.puppet.messageSendText(
+        conversationId,
+        textOrContactOrFileOrUrlOrMini,
+      )
     } else if (textOrContactOrFileOrUrlOrMini instanceof Contact) {
       /**
        * Contact Card
        */
-      msgId = await this.puppet.messageSendContact({
-        contactId : (from && from.id) || undefined,
-        roomId    : (room && room.id) || undefined,
-      }, textOrContactOrFileOrUrlOrMini.id)
+      msgId = await this.puppet.messageSendContact(
+        conversationId,
+        textOrContactOrFileOrUrlOrMini.id,
+      )
     } else if (textOrContactOrFileOrUrlOrMini instanceof FileBox) {
       /**
        * File Message
        */
-      msgId = await this.puppet.messageSendFile({
-        contactId : (from && from.id) || undefined,
-        roomId    : (room && room.id) || undefined,
-      }, textOrContactOrFileOrUrlOrMini)
+      msgId = await this.puppet.messageSendFile(
+        conversationId,
+        textOrContactOrFileOrUrlOrMini,
+      )
     } else if (textOrContactOrFileOrUrlOrMini instanceof UrlLink) {
       /**
        * Link Message
        */
-      msgId = await this.puppet.messageSendUrl({
-        contactId : (from && from.id) || undefined,
-        roomId    : (room && room.id) || undefined,
-      }, textOrContactOrFileOrUrlOrMini.payload)
+      msgId = await this.puppet.messageSendUrl(
+        conversationId,
+        textOrContactOrFileOrUrlOrMini.payload,
+      )
     } else if (textOrContactOrFileOrUrlOrMini instanceof MiniProgram) {
       /**
        * MiniProgram
        */
-      msgId = await this.puppet.messageSendMiniProgram({
-        contactId : (from && from.id) || undefined,
-        roomId    : (room && room.id) || undefined,
-      }, textOrContactOrFileOrUrlOrMini.payload)
+      msgId = await this.puppet.messageSendMiniProgram(
+        conversationId,
+        textOrContactOrFileOrUrlOrMini.payload,
+      )
     } else {
       throw new Error('unknown msg: ' + textOrContactOrFileOrUrlOrMini)
     }
@@ -884,21 +898,12 @@ export class Message extends Accessory implements Sayable {
   public async forward (to: Room | Contact): Promise<void> {
     log.verbose('Message', 'forward(%s)', to)
 
-    let roomId
-    let contactId
-
-    if (to instanceof Room) {
-      roomId = to.id
-    } else if (to instanceof Contact) {
-      contactId = to.id
-    }
+    // let roomId
+    // let contactId
 
     try {
       await this.puppet.messageForward(
-        {
-          contactId,
-          roomId,
-        },
+        to.id,
         this.id,
       )
     } catch (e) {

src/user/room-invitation.ts

@@ -92,7 +92,7 @@ export class RoomInvitation extends Accessory implements Acceptable {
       'RoomInvitation#',
       this.id,
       '<',
-      payload.roomTopic,
+      payload.topic,
       ',',
       payload.inviterId,
       '>',
@@ -177,7 +177,7 @@ export class RoomInvitation extends Accessory implements Acceptable {
     const payload = await this.puppet.roomInvitationPayload(this.id)
 
     // roomTopic deprecated. use topic instead:
-    return payload.topic || payload.roomTopic || ''
+    return payload.topic || payload.topic || ''
   }
 
   /**
@@ -194,7 +194,7 @@ export class RoomInvitation extends Accessory implements Acceptable {
     const payload = await this.puppet.roomInvitationPayload(this.id)
 
     // roomMemberCount deprecated. use memberCount instead:
-    return payload.memberCount || payload.roomMemberCount || 0
+    return payload.memberCount || payload.memberCount || 0
   }
 
   /**
@@ -216,7 +216,7 @@ export class RoomInvitation extends Accessory implements Acceptable {
     const payload = await this.puppet.roomInvitationPayload(this.id)
 
     // roomMemberIdList deprecated. use memberIdList isntead.
-    const contactIdList = payload.memberIdList || payload.roomMemberIdList || []
+    const contactIdList = payload.memberIdList || payload.memberIdList || []
 
     const contactList = contactIdList.map(
       id => this.wechaty.Contact.load(id),

src/user/room.spec.ts

@@ -113,7 +113,8 @@ test('say()', async () => {
     await room.say`To be ${contact1} or not to be ${contact2}`
 
     t.deepEqual(callback.getCall(0).args, [
-      { contactId: EXPECTED_CONTACT_1_ID, roomId: EXPECTED_ROOM_ID },
+      // { contactId: EXPECTED_CONTACT_1_ID, roomId: EXPECTED_ROOM_ID },
+      EXPECTED_ROOM_ID,
       'To be @little1 or not to be @big2',
       [EXPECTED_CONTACT_1_ID, EXPECTED_CONTACT_2_ID],
     ], 'Tagged Template say should be matched')
@@ -124,7 +125,8 @@ test('say()', async () => {
     await room.say('Yo', contact1)
 
     t.deepEqual(callback.getCall(0).args, [
-      { contactId: EXPECTED_CONTACT_1_ID, roomId: EXPECTED_ROOM_ID },
+      // { contactId: EXPECTED_CONTACT_1_ID, roomId: EXPECTED_ROOM_ID },
+      EXPECTED_ROOM_ID,
       '@little1 Yo',
       [EXPECTED_CONTACT_1_ID],
     ], 'Single mention should work with old ways')
@@ -135,7 +137,8 @@ test('say()', async () => {
     await room.say('hey buddies, let\'s party', contact1, contact2)
 
     t.deepEqual(callback.getCall(0).args, [
-      { contactId: EXPECTED_CONTACT_1_ID, roomId: EXPECTED_ROOM_ID },
+      // { contactId: EXPECTED_CONTACT_1_ID, roomId: EXPECTED_ROOM_ID },
+      EXPECTED_ROOM_ID,
       '@little1 @big2 hey buddies, let\'s party',
       [EXPECTED_CONTACT_1_ID, EXPECTED_CONTACT_2_ID],
     ], 'Multiple mention should work with new way')

src/user/room.ts

@@ -526,12 +526,12 @@ export class Room extends Accessory implements Sayable {
       } else {
         text = something
       }
-      const receiver = {
-        contactId : (mentionList.length && mentionList[0].id) || undefined,
-        roomId    : this.id,
-      }
+      // const receiver = {
+      //   contactId : (mentionList.length && mentionList[0].id) || undefined,
+      //   roomId    : this.id,
+      // }
       msgId = await this.puppet.messageSendText(
-        receiver,
+        this.id,
         text,
         mentionList.map(c => c.id),
       )
@@ -539,30 +539,34 @@ export class Room extends Accessory implements Sayable {
       /**
        * 2. File Message
        */
-      msgId = await this.puppet.messageSendFile({
-        roomId: this.id,
-      }, something)
+      msgId = await this.puppet.messageSendFile(
+        this.id,
+        something,
+      )
     } else if (something instanceof Contact) {
       /**
        * 3. Contact Card
        */
-      msgId = await this.puppet.messageSendContact({
-        roomId: this.id,
-      }, something.id)
+      msgId = await this.puppet.messageSendContact(
+        this.id,
+        something.id,
+      )
     } else if (something instanceof UrlLink) {
       /**
        * 4. Link Message
        */
-      msgId = await this.puppet.messageSendUrl({
-        contactId : this.id,
-      }, something.payload)
+      msgId = await this.puppet.messageSendUrl(
+        this.id,
+        something.payload,
+      )
     } else if (something instanceof MiniProgram) {
       /**
        * 5. Mini Program
        */
-      msgId = await this.puppet.messageSendMiniProgram({
-        contactId : this.id,
-      }, something.payload)
+      msgId = await this.puppet.messageSendMiniProgram(
+        this.id,
+        something.payload,
+      )
     } else {
       throw new Error('arg unsupported: ' + something)
     }
@@ -579,16 +583,16 @@ export class Room extends Accessory implements Sayable {
     ...varList: unknown[]
   ) {
     const mentionList: Contact[] = varList.filter(v => v instanceof Contact) as any
-    const receiver = {
-      contactId : (mentionList.length && mentionList[0].id) || undefined,
-      roomId    : this.id,
-    }
+    // const receiver = {
+    //   contactId : (mentionList.length && mentionList[0].id) || undefined,
+    //   roomId    : this.id,
+    // }
     if (varList.length === 0) {
       /**
        * No mention in the string
        */
       return this.puppet.messageSendText(
-        receiver,
+        this.id,
         textList[0],
       )
     // TODO(huan) 20191222 it seems the following code will not happen,
@@ -630,7 +634,7 @@ export class Room extends Accessory implements Sayable {
       finalText += textList[i]
 
       return this.puppet.messageSendText(
-        receiver,
+        this.id,
         finalText,
         mentionList.map(c => c.id),
       )
@@ -956,7 +960,7 @@ export class Room extends Accessory implements Sayable {
    */
   public async qrcode (): Promise<string> {
     log.verbose('Room', 'qrcode()')
-    const qrcodeValue = await this.puppet.roomQrcode(this.id)
+    const qrcodeValue = await this.puppet.roomQRCode(this.id)
     return guardQrCodeValue(qrcodeValue)
   }