@juzi/wechaty 1.0.163 → 1.0.164

package/src/package-json.ts

@@ -4,10 +4,10 @@
  */
 import type { PackageJsonWechaty } from './config'
 
-export const GIT_COMMIT_HASH: string = '2b021fb30496d10b75bdeebbb17e0285593b0fa0'
+export const GIT_COMMIT_HASH: string = '2c311276c0c88cacc69d0844f82d3240ae112408'
 export const packageJson: PackageJsonWechaty = {
   "name": "@juzi/wechaty",
-  "version": "1.0.163",
+  "version": "1.0.164",
   "description": "Wechaty is a RPA SDK for Chatbot Makers.",
   "type": "module",
   "exports": {
@@ -116,6 +116,7 @@ export const packageJson: PackageJsonWechaty = {
   },
   "homepage": "https://github.com/wechaty/",
   "dependencies": {
+    "@juzi/wechaty-puppet": "^1.0.153",
     "@juzi/wechaty-puppet-service": "1.0.124",
     "clone-class": "^1.1.1",
     "cmd-ts": "^0.10.0",

package/src/sayable/deliver-sayable.ts

@@ -6,6 +6,7 @@ import {
   MessageImpl,
   DelayImpl,
   UrlLinkImpl,
+  EmailImpl,
   MiniProgramImpl,
   PostImpl,
   LocationImpl,
@@ -77,6 +78,14 @@ const deliverSayableConversationPuppet = (puppet: PUPPET.impls.PuppetInterface)
       conversationId,
       sayable.payload,
     )
+  } else if (EmailImpl.validInstance(sayable)) {
+    /**
+     * 4.1. Email Message
+     */
+    msgId = await puppet.messageSendEmail(
+      conversationId,
+      sayable.payload,
+    )
   } else if (MiniProgramImpl.validInstance(sayable)) {
     /**
      * 5. Mini Program

package/src/sayable/message-to-sayable.ts

@@ -31,6 +31,9 @@ async function messageToSayable (
     case PUPPET.types.Message.Url:
       return message.toUrlLink()
 
+    case PUPPET.types.Message.Email:
+      return message.toEmail()
+
     case PUPPET.types.Message.MiniProgram:
       return message.toMiniProgram()
 

package/src/sayable/payload-to-sayable.ts

@@ -38,6 +38,9 @@ const payloadToSayableWechaty: (w: WechatyInterface) => (p: PUPPET.payloads.Saya
     case PUPPET.types.Sayable.Url:
       return new wechaty.UrlLink(sayable.payload)
 
+    case PUPPET.types.Sayable.Email:
+      return new wechaty.Email(sayable.payload)
+
     case PUPPET.types.Sayable.Post:
       return new wechaty.Post(sayable.payload)
 

package/src/sayable/sayable-to-payload.ts

@@ -8,6 +8,7 @@ import {
   MessageImpl,
   MiniProgramImpl,
   UrlLinkImpl,
+  EmailImpl,
   ContactImpl,
   PostImpl,
   ChannelImpl,
@@ -47,6 +48,8 @@ async function sayableToPayload (sayable: Sayable): Promise<undefined | PUPPET.p
     return PUPPET.payloads.sayable.post(sayable.payload)
   } else if (UrlLinkImpl.validInstance(sayable)) {
     return PUPPET.payloads.sayable.url(sayable.payload)
+  } else if (EmailImpl.validInstance(sayable)) {
+    return PUPPET.payloads.sayable.email(sayable.payload)
   } else if (ChannelImpl.validInstance(sayable)) {
     return PUPPET.payloads.sayable.channel(sayable.payload)
   } else if (ChannelCardImpl.validInstance(sayable)) {

package/src/sayable/types.ts

@@ -29,6 +29,7 @@ import {
   MiniProgramInterface,
   PostInterface,
   UrlLinkInterface,
+  EmailInterface,
   ChannelInterface,
   ContactImpl,
   MessageImpl,
@@ -55,6 +56,7 @@ type Sayable =
   | PostInterface
   | string
   | UrlLinkInterface
+  | EmailInterface
   | ChannelInterface
   | ChannelCardInterface
   | ConsultCardInterface

package/src/user-modules/email.spec.ts

@@ -0,0 +1,82 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+/**
+ *   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.
+ *
+ */
+import { test } from 'tstest'
+import type * as PUPPET from '@juzi/wechaty-puppet'
+import { log } from '@juzi/wechaty-puppet'
+
+import type { Wechaty } from '../mods/mod.js'
+
+import { MessageImpl } from './message.js'
+import { wechatifyUserModule } from './mod.js'
+import { EmailImpl } from './email.js'
+
+const wechaty = {
+  log,
+  puppet: {} as any,
+} as any as Wechaty
+
+const EmailTest = wechatifyUserModule(EmailImpl)(wechaty)
+
+const PAYLOAD: PUPPET.payloads.Email = {
+  attachments : [ { filename: 'report.pdf', contentType: 'application/pdf', size: 1024 } ],
+  cc          : [ { address: 'cc@example.com' } ],
+  from        : { address: 'alice@example.com', name: 'Alice' },
+  html        : '<p>hello</p>',
+  inReplyTo   : '<parent@example.com>',
+  mimeMessageId : '<abc@example.com>',
+  replyTo     : [ { address: 'reply@example.com' } ],
+  subject     : 'Hello World',
+  text        : 'hello',
+  to          : [ { address: 'bob@example.com', name: 'Bob' } ],
+}
+
+test('Email getters expose the payload', async t => {
+  const email = new EmailTest(PAYLOAD)
+
+  t.equal(email.subject(),         PAYLOAD.subject,         'should expose subject')
+  t.same(email.from(),             PAYLOAD.from,            'should expose from')
+  t.same(email.to(),               PAYLOAD.to,              'should expose to')
+  t.same(email.cc(),               PAYLOAD.cc,              'should expose cc')
+  t.same(email.replyTo(),          PAYLOAD.replyTo,         'should expose replyTo')
+  t.equal(email.text(),            PAYLOAD.text,            'should expose text')
+  t.equal(email.html(),            PAYLOAD.html,            'should expose html')
+  t.equal(email.mimeMessageId(),   PAYLOAD.mimeMessageId,   'should expose mimeMessageId')
+  t.equal(email.inReplyTo(),       PAYLOAD.inReplyTo,       'should expose inReplyTo')
+  t.same(email.attachments(),      PAYLOAD.attachments,     'should expose attachments metadata')
+})
+
+test('Email absent optional fields are undefined', async t => {
+  const email = new EmailTest({
+    from    : { address: 'alice@example.com' },
+    subject : 'Bare',
+    to      : [ { address: 'bob@example.com' } ],
+  })
+
+  t.equal(email.cc(),   undefined, 'should return undefined for absent cc')
+  t.equal(email.bcc(),  undefined, 'should return undefined for absent bcc')
+  t.equal(email.html(), undefined, 'should return undefined for absent html')
+})
+
+test('Email.valid()', async t => {
+  const email = new EmailTest(PAYLOAD)
+  t.ok(EmailImpl.valid(email), 'should pass the validation of EmailImpl')
+  t.notOk(MessageImpl.valid(email), 'should not pass the validation of MessageImpl')
+})

package/src/user-modules/email.ts

@@ -0,0 +1,130 @@
+/**
+ *   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.
+ *
+ */
+import type * as PUPPET     from '@juzi/wechaty-puppet'
+import type { Constructor } from 'clone-class'
+
+import { validationMixin }    from '../user-mixins/validation.js'
+import { wechatifyMixinBase } from '../user-mixins/wechatify.js'
+
+class EmailMixin extends wechatifyMixinBase() {
+
+  /**
+   *
+   * Create from payload
+   *
+   */
+  static create (
+    payload: PUPPET.payloads.Email,
+  ): EmailInterface {
+    this.log.verbose('Email', 'create()')
+    return new this(payload)
+  }
+
+  /*
+   * @hideconstructor
+   */
+  constructor (
+    public readonly payload: PUPPET.payloads.Email,
+  ) {
+    super()
+    this.log.verbose('Email', 'constructor()')
+  }
+
+  override toString (): string {
+    return `Email<${this.payload.subject}>`
+  }
+
+  subject (): string {
+    return this.payload.subject
+  }
+
+  from (): PUPPET.payloads.EmailAddress {
+    return this.payload.from
+  }
+
+  to (): PUPPET.payloads.EmailAddress[] {
+    return this.payload.to
+  }
+
+  cc (): undefined | PUPPET.payloads.EmailAddress[] {
+    return this.payload.cc
+  }
+
+  bcc (): undefined | PUPPET.payloads.EmailAddress[] {
+    return this.payload.bcc
+  }
+
+  date (): undefined | number {
+    return this.payload.date
+  }
+
+  mimeMessageId (): undefined | string {
+    return this.payload.mimeMessageId
+  }
+
+  inReplyTo (): undefined | string {
+    return this.payload.inReplyTo
+  }
+
+  references (): undefined | string[] {
+    return this.payload.references
+  }
+
+  replyTo (): undefined | PUPPET.payloads.EmailAddress[] {
+    return this.payload.replyTo
+  }
+
+  sender (): undefined | PUPPET.payloads.EmailAddress {
+    return this.payload.sender
+  }
+
+  headers (): undefined | { [name: string]: string } {
+    return this.payload.headers
+  }
+
+  text (): undefined | string {
+    return this.payload.text
+  }
+
+  html (): undefined | string {
+    return this.payload.html
+  }
+
+  attachments (): undefined | PUPPET.payloads.EmailAttachment[] {
+    return this.payload.attachments
+  }
+
+}
+
+class EmailImpl extends validationMixin(EmailMixin)<EmailInterface>() {}
+interface EmailInterface extends EmailImpl {}
+
+type EmailConstructor = Constructor<
+  EmailInterface,
+  typeof EmailImpl
+>
+
+export type {
+  EmailConstructor,
+  EmailInterface,
+}
+export {
+  EmailImpl,
+}

package/src/user-modules/message.ts

@@ -55,6 +55,9 @@ import type {
 import type {
   UrlLinkInterface,
 }                       from './url-link.js'
+import type {
+  EmailInterface,
+}                       from './email.js'
 import type {
   MiniProgramInterface,
 }                       from './mini-program.js'
@@ -1384,6 +1387,7 @@ class MessageMixin extends MixinBase implements SayableSayer {
    * > Tips:
    * This function is depending on the Puppet Implementation, see [puppet-compatible-table](https://github.com/wechaty/wechaty/wiki/Puppet#3-puppet-compatible-table)
    *
+   * @param {number} [index] For an Email message, pick the N-th attachment (0-based). Ignored by other message types.
    * @returns {Promise<FileBoxInterface>}
    *
    * @example <caption>Save media file from a message</caption>
@@ -1391,12 +1395,12 @@ class MessageMixin extends MixinBase implements SayableSayer {
    * const fileName = fileBox.name
    * fileBox.toFile(fileName)
    */
-  async toFileBox (): Promise<FileBoxInterface> {
-    this.log.verbose('Message', 'toFileBox()')
+  async toFileBox (index?: number): Promise<FileBoxInterface> {
+    this.log.verbose('Message', 'toFileBox(%s)', index ?? '')
     if (this.type() === PUPPET.types.Message.Text) {
       throw new Error('text message no file')
     }
-    const fileBox = await this.wechaty.puppet.messageFile(this.id)
+    const fileBox = await this.wechaty.puppet.messageFile(this.id, index)
     return fileBox
   }
 
@@ -1495,6 +1499,22 @@ class MessageMixin extends MixinBase implements SayableSayer {
     return new this.wechaty.UrlLink(urlPayload)
   }
 
+  async toEmail (): Promise<EmailInterface> {
+    this.log.verbose('Message', 'toEmail()')
+
+    if (!this.payload) {
+      throw new Error('no payload')
+    }
+
+    if (this.type() !== PUPPET.types.Message.Email) {
+      throw new Error('message not an Email')
+    }
+
+    const emailPayload = await this.wechaty.puppet.messageEmail(this.id)
+
+    return new this.wechaty.Email(emailPayload)
+  }
+
   async toMiniProgram (): Promise<MiniProgramInterface> {
     this.log.verbose('Message', 'toMiniProgram()')
 

package/src/user-modules/mod.ts

@@ -102,6 +102,11 @@ import {
   UrlLinkInterface,
   UrlLinkConstructor,
 }                           from './url-link.js'
+import {
+  EmailImpl,
+  EmailInterface,
+  EmailConstructor,
+}                           from './email.js'
 import {
   DelayImpl,
   DelayInterface,
@@ -193,6 +198,7 @@ export type {
   TagGroupInterface,
   DelayInterface,
   UrlLinkInterface,
+  EmailInterface,
   ChannelInterface,
   ChannelCardInterface,
   ConsultCardInterface,
@@ -226,6 +232,7 @@ export type {
   TagConstructor,
   TagGroupConstructor,
   UrlLinkConstructor,
+  EmailConstructor,
   ChannelConstructor,
   ChannelCardConstructor,
   ConsultCardConstructor,
@@ -261,6 +268,7 @@ export {
   TagImpl,
   TagGroupImpl,
   UrlLinkImpl,
+  EmailImpl,
   ChannelImpl,
   ChannelCardImpl,
   ConsultCardImpl,

package/src/wechaty/wechaty-impl.spec.ts

@@ -20,6 +20,7 @@ import type {
   TagConstructor,
   TagGroupConstructor,
   UrlLinkConstructor,
+  EmailConstructor,
   MessageInterface,
   ChannelConstructor,
   ChannelCardConstructor,
@@ -62,6 +63,7 @@ test('Wechaty interface', async t => {
     Tag                           : TagConstructor
     TagGroup                      : TagGroupConstructor
     UrlLink                       : UrlLinkConstructor
+    Email                         : EmailConstructor
     Channel                       : ChannelConstructor
     ChannelCard                   : ChannelCardConstructor
     ConsultCard                   : ConsultCardConstructor
@@ -94,6 +96,7 @@ test('Wechaty interface', async t => {
         = this.Tag
         = this.TagGroup
         = this.UrlLink
+        = this.Email
         = this.Channel
         = this.ChannelCard
         = this.ConsultCard

package/src/wechaty-mixins/wechatify-user-module-mixin.ts

@@ -17,6 +17,7 @@ import {
   TagImpl,
   TagGroupImpl,
   UrlLinkImpl,
+  EmailImpl,
   ChannelImpl,
   ChannelCardImpl,
   ConsultCardImpl,
@@ -46,6 +47,7 @@ import {
   TagConstructor,
   TagGroupConstructor,
   UrlLinkConstructor,
+  EmailConstructor,
   ChannelConstructor,
   ChannelCardConstructor,
   ConsultCardConstructor,
@@ -91,6 +93,7 @@ const wechatifyUserModuleMixin = <MixinBase extends typeof WechatySkeleton> (mix
     __wechatifiedTag?                           : TagConstructor
     __wechatifiedTagGroup?                      : TagGroupConstructor
     __wechatifiedUrlLink?                       : UrlLinkConstructor
+    __wechatifiedEmail?                         : EmailConstructor
     __wechatifiedChannel?                       : ChannelConstructor
     __wechatifiedChannelCard?                   : ChannelCardConstructor
     __wechatifiedConsultCard?                   : ConsultCardConstructor
@@ -120,6 +123,7 @@ const wechatifyUserModuleMixin = <MixinBase extends typeof WechatySkeleton> (mix
     get Tag ()                          : TagConstructor                            { return guardWechatify(this.__wechatifiedTag)            }
     get TagGroup ()                     : TagGroupConstructor                       { return guardWechatify(this.__wechatifiedTagGroup)       }
     get UrlLink ()                      : UrlLinkConstructor                        { return guardWechatify(this.__wechatifiedUrlLink)        }
+    get Email ()                        : EmailConstructor                          { return guardWechatify(this.__wechatifiedEmail)          }
     get Channel ()                      : ChannelConstructor                        { return guardWechatify(this.__wechatifiedChannel)        }
     get ChannelCard ()                  : ChannelCardConstructor                    { return guardWechatify(this.__wechatifiedChannelCard)    }
     get ConsultCard ()                  : ConsultCardConstructor                    { return guardWechatify(this.__wechatifiedConsultCard)    }
@@ -169,6 +173,7 @@ const wechatifyUserModuleMixin = <MixinBase extends typeof WechatySkeleton> (mix
       this.__wechatifiedTag                          = wechatifyUserModule(TagImpl)(this as any)
       this.__wechatifiedTagGroup                     = wechatifyUserModule(TagGroupImpl)(this as any)
       this.__wechatifiedUrlLink                      = wechatifyUserModule(UrlLinkImpl)(this as any)
+      this.__wechatifiedEmail                        = wechatifyUserModule(EmailImpl)(this as any)
       this.__wechatifiedChannel                      = wechatifyUserModule(ChannelImpl)(this as any)
       this.__wechatifiedChannelCard                  = wechatifyUserModule(ChannelCardImpl)(this as any)
       this.__wechatifiedConsultCard                  = wechatifyUserModule(ConsultCardImpl)(this as any)
@@ -218,6 +223,7 @@ type ProtectedPropertyWechatifyUserModuleMixin =
   | '__wechatifiedTag'
   | '__wechatifiedTagGroup'
   | '__wechatifiedUrlLink'
+  | '__wechatifiedEmail'
   | '__wechatifiedChannel'
   | '__wechatifiedChannelCard'
   | '__wechatifiedConsultCard'