@juzi/wechaty 1.0.114 → 1.0.116

package/src/user-modules/consult-card.ts

@@ -0,0 +1,94 @@
+import type * as PUPPET from '@juzi/wechaty-puppet'
+
+import type { Constructor } from 'clone-class'
+import { log } from '../config.js'
+
+import { validationMixin } from '../user-mixins/validation.js'
+
+import {
+  wechatifyMixinBase,
+} from '../user-mixins/wechatify.js'
+
+class ConsultCardMixin extends wechatifyMixinBase() {
+
+  /**
+   *
+   * Create
+   *
+   */
+  static async create (msgType: number, componentType: number, componentId: number): Promise<ConsultCardInterface> {
+    log.verbose('ConsultCard', 'create()')
+
+    const payload: PUPPET.payloads.ConsultCard = {
+      msgType,
+      componentType,
+      componentId,
+    }
+
+    return new this(payload)
+  }
+
+  /*
+   * @hideconstructor
+   */
+  constructor (
+    public readonly payload: PUPPET.payloads.ConsultCard,
+  ) {
+    super()
+    log.verbose('ConsultCard', 'constructor()')
+  }
+
+  msgType (): number {
+    return this.payload.msgType
+  }
+
+  componentType (): number {
+    return this.payload.componentType
+  }
+
+  componentId (): number {
+    return this.payload.componentId
+  }
+
+  // 接收/查询时的详细字段
+  id (): number | undefined {
+    return this.payload.id
+  }
+
+  cardType (): number | undefined {
+    return this.payload.cardType
+  }
+
+  name (): string | undefined {
+    return this.payload.name
+  }
+
+  content (): string | undefined {
+    return this.payload.content
+  }
+
+  status (): number | undefined {
+    return this.payload.status
+  }
+
+  statusMsg (): number | undefined {
+    return this.payload.statusMsg
+  }
+
+}
+
+class ConsultCardImpl extends validationMixin(ConsultCardMixin)<ConsultCardInterface>() { }
+interface ConsultCardInterface extends ConsultCardImpl { }
+
+type ConsultCardConstructor = Constructor<
+  ConsultCardInterface,
+  typeof ConsultCardImpl
+>
+
+export type {
+  ConsultCardConstructor,
+  ConsultCardInterface,
+}
+export {
+  ConsultCardImpl,
+}

package/src/user-modules/message.ts

@@ -71,6 +71,12 @@ import type {
 import type {
   ChannelInterface,
 }                       from './channel.js'
+import type {
+  ChannelCardInterface,
+}                       from './channel-card.js'
+import type {
+  ConsultCardInterface,
+}                       from './consult-card.js'
 
 import { validationMixin } from '../user-mixins/validation.js'
 import type { ContactSelfImpl } from './contact-self.js'
@@ -88,6 +94,7 @@ const ALLOW_PREVIEW_TYPES = [
   PUPPET.types.Message.Video,
   PUPPET.types.Message.Url,
   PUPPET.types.Message.Channel,
+  PUPPET.types.Message.ChannelCard,
   PUPPET.types.Message.Post,
 ]
 
@@ -1387,6 +1394,36 @@ class MessageMixin extends MixinBase implements SayableSayer {
     return new this.wechaty.Channel(channelPayload)
   }
 
+  public async toChannelCard (): Promise<ChannelCardInterface> {
+    log.verbose('Message', 'toChannelCard()')
+
+    if (!this.payload) {
+      throw new Error('no payload')
+    }
+
+    if (this.type() !== PUPPET.types.Message.ChannelCard) {
+      throw new Error('message not a ChannelCard')
+    }
+
+    const channelCardPayload = await this.wechaty.puppet.messageChannelCard(this.id)
+    return new this.wechaty.ChannelCard(channelCardPayload)
+  }
+
+  public async toConsultCard (): Promise<ConsultCardInterface> {
+    log.verbose('Message', 'toConsultCard()')
+
+    if (!this.payload) {
+      throw new Error('no payload')
+    }
+
+    if (this.type() !== PUPPET.types.Message.ConsultCard) {
+      throw new Error('message not a ConsultCard')
+    }
+
+    const consultCardPayload = await this.wechaty.puppet.messageConsultCard(this.id)
+    return new this.wechaty.ConsultCard(consultCardPayload)
+  }
+
   public async toCallRecord (): Promise<CallRecordInterface> {
     log.verbose('Message', 'toCallRecord()')
 

package/src/user-modules/mod.ts

@@ -107,6 +107,16 @@ import {
   ChannelInterface,
   ChannelConstructor,
 }                           from './channel.js'
+import {
+  ChannelCardImpl,
+  ChannelCardInterface,
+  ChannelCardConstructor,
+}                           from './channel-card.js'
+import {
+  ConsultCardImpl,
+  ConsultCardInterface,
+  ConsultCardConstructor,
+}                           from './consult-card.js'
 import {
   CallRecordImpl,
   CallRecordInterface,
@@ -144,6 +154,8 @@ export type {
   DelayInterface,
   UrlLinkInterface,
   ChannelInterface,
+  ChannelCardInterface,
+  ConsultCardInterface,
   CallRecordInterface,
   ChatHistoryInterface,
   WecomInterface,
@@ -168,6 +180,8 @@ export type {
   TagGroupConstructor,
   UrlLinkConstructor,
   ChannelConstructor,
+  ChannelCardConstructor,
+  ConsultCardConstructor,
   CallRecordConstructor,
   ChatHistoryConstructor,
   WecomConstructor,
@@ -194,6 +208,8 @@ export {
   TagGroupImpl,
   UrlLinkImpl,
   ChannelImpl,
+  ChannelCardImpl,
+  ConsultCardImpl,
   CallRecordImpl,
   ChatHistoryImpl,
   WecomImpl,

package/src/wechaty/wechaty-base.ts

@@ -219,7 +219,7 @@ class WechatyBase 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 {(string | Contact | FileBox | UrlLink | MiniProgram | Location | Channel)} sayable
+   * @param {(string | Contact | FileBox | UrlLink | MiniProgram | Location | Channel | ChannelCard | ConsultCard)} sayable
    * send text, Contact, or file to bot. </br>
    * You can use {@link https://www.npmjs.com/package/file-box|FileBox} to send file
    *

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

@@ -21,6 +21,8 @@ import type {
   UrlLinkConstructor,
   MessageInterface,
   ChannelConstructor,
+  ChannelCardConstructor,
+  ConsultCardConstructor,
   MomentConstructor,
   CallRecordConstructor,
   ChatHistoryConstructor,
@@ -53,6 +55,8 @@ test('Wechaty interface', async t => {
     TagGroup       : TagGroupConstructor
     UrlLink        : UrlLinkConstructor
     Channel        : ChannelConstructor
+    ChannelCard    : ChannelCardConstructor
+    ConsultCard    : ConsultCardConstructor
     Moment         : MomentConstructor
     CallRecord     : CallRecordConstructor
     ChatHistory    : ChatHistoryConstructor
@@ -76,6 +80,8 @@ test('Wechaty interface', async t => {
         = this.TagGroup
         = this.UrlLink
         = this.Channel
+        = this.ChannelCard
+        = this.ConsultCard
         = this.Moment
         = this.CallRecord
         = this.ChatHistory

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

@@ -16,6 +16,8 @@ import {
   TagGroupImpl,
   UrlLinkImpl,
   ChannelImpl,
+  ChannelCardImpl,
+  ConsultCardImpl,
   MomentImpl,
   CallRecordImpl,
   ChatHistoryImpl,
@@ -36,6 +38,8 @@ import {
   TagGroupConstructor,
   UrlLinkConstructor,
   ChannelConstructor,
+  ChannelCardConstructor,
+  ConsultCardConstructor,
   MomentConstructor,
   CallRecordConstructor,
   ChatHistoryConstructor,
@@ -73,6 +77,8 @@ const wechatifyUserModuleMixin = <MixinBase extends typeof WechatySkeleton> (mix
     __wechatifiedTagGroup?       : TagGroupConstructor
     __wechatifiedUrlLink?        : UrlLinkConstructor
     __wechatifiedChannel?        : ChannelConstructor
+    __wechatifiedChannelCard?    : ChannelCardConstructor
+    __wechatifiedConsultCard?    : ConsultCardConstructor
     __wechatifiedMoment?         : MomentConstructor
     __wechatifiedCallRecord?     : CallRecordConstructor
     __wechatifiedChatHistory?    : ChatHistoryConstructor
@@ -93,6 +99,8 @@ const wechatifyUserModuleMixin = <MixinBase extends typeof WechatySkeleton> (mix
     get TagGroup ()       : TagGroupConstructor       { return guardWechatify(this.__wechatifiedTagGroup)       }
     get UrlLink ()        : UrlLinkConstructor        { return guardWechatify(this.__wechatifiedUrlLink)        }
     get Channel ()        : ChannelConstructor        { return guardWechatify(this.__wechatifiedChannel)        }
+    get ChannelCard ()    : ChannelCardConstructor    { return guardWechatify(this.__wechatifiedChannelCard)    }
+    get ConsultCard ()    : ConsultCardConstructor    { return guardWechatify(this.__wechatifiedConsultCard)    }
     get Moment ()         : MomentConstructor         { return guardWechatify(this.__wechatifiedMoment)         }
     get CallRecord ()     : CallRecordConstructor     { return guardWechatify(this.__wechatifiedCallRecord)     }
     get ChatHistory ()    : ChatHistoryConstructor    { return guardWechatify(this.__wechatifiedChatHistory)    }
@@ -133,6 +141,8 @@ const wechatifyUserModuleMixin = <MixinBase extends typeof WechatySkeleton> (mix
       this.__wechatifiedTagGroup       = wechatifyUserModule(TagGroupImpl)(this as any)
       this.__wechatifiedUrlLink        = wechatifyUserModule(UrlLinkImpl)(this as any)
       this.__wechatifiedChannel        = wechatifyUserModule(ChannelImpl)(this as any)
+      this.__wechatifiedChannelCard    = wechatifyUserModule(ChannelCardImpl)(this as any)
+      this.__wechatifiedConsultCard    = wechatifyUserModule(ConsultCardImpl)(this as any)
       this.__wechatifiedMoment         = wechatifyUserModule(MomentImpl)(this as any)
       this.__wechatifiedCallRecord     = wechatifyUserModule(CallRecordImpl)(this as any)
       this.__wechatifiedChatHistory    = wechatifyUserModule(ChatHistoryImpl)(this as any)
@@ -173,6 +183,8 @@ type ProtectedPropertyWechatifyUserModuleMixin =
   | '__wechatifiedTagGroup'
   | '__wechatifiedUrlLink'
   | '__wechatifiedChannel'
+  | '__wechatifiedChannelCard'
+  | '__wechatifiedConsultCard'
   | '__wechatifiedMoment'
   | '__wechatifiedCallRecord'
   | '__wechatifiedChatHistory'