@juzi/wechaty 1.0.149 → 1.0.150

package/src/user-modules/voice.ts

@@ -0,0 +1,104 @@
+/**
+ *   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 {
+  FileBoxInterface,
+}                   from 'file-box'
+import type { Constructor } from 'clone-class'
+import { validationMixin } from '../user-mixins/validation.js'
+import { log } from '../config.js'
+
+import {
+  wechatifyMixinBase,
+}                       from '../user-mixins/wechatify.js'
+
+class VoiceMixin extends wechatifyMixinBase() {
+
+  static create (id: string): VoiceInterface {
+    log.verbose('Voice', 'static create(%s)', id)
+
+    const voice = new this(id)
+    return voice
+  }
+
+  constructor (
+    public id: string,
+  ) {
+    super()
+    log.verbose('Voice', 'constructor(%s)', id)
+  }
+
+  /**
+   * Get the voice file (FileBox) via the puppet's dedicated `messageVoice` RPC.
+   *
+   * Falls back to the generic `messageFile` when the puppet does not implement
+   * `messageVoice` (old puppet without the new RPC → rejection), keeping the
+   * behaviour compatible with the legacy "voice file via messageFile" path.
+   */
+  async file (): Promise<FileBoxInterface> {
+    log.verbose('Voice', 'file() for id: "%s"', this.id)
+    try {
+      const fileBox = await this.wechaty.puppet.messageVoice(this.id)
+      return fileBox
+    } catch (e) {
+      log.verbose('Voice', 'file() messageVoice() failed, fallback to messageFile(): %s', (e as Error).message)
+      const fileBox = await this.wechaty.puppet.messageFile(this.id)
+      return fileBox
+    }
+  }
+
+  /**
+   * Get the voice-to-text (ASR) result via the puppet's dedicated
+   * `messageVoiceText` RPC. Returns a discriminated result so the bot can tell
+   * "confirmed no speech" (`noSpeech=true`) from "normal transcription".
+   *
+   * Falls back to reading the legacy `messagePayload().text` when the puppet
+   * does not implement `messageVoiceText` (old puppet without the new RPC →
+   * rejection). Old puppets put the ASR result into `payload.text`, so this
+   * keeps the behaviour compatible; `noSpeech` is `false` in the fallback.
+   */
+  async text (): Promise<{ text: string; noSpeech: boolean }> {
+    log.verbose('Voice', 'text() for id: "%s"', this.id)
+    try {
+      const payload = await this.wechaty.puppet.messageVoiceText(this.id)
+      return payload
+    } catch (e) {
+      log.verbose('Voice', 'text() messageVoiceText() failed, fallback to messagePayload().text: %s', (e as Error).message)
+      const payload = await this.wechaty.puppet.messagePayload(this.id)
+      return { text: payload.text || '', noSpeech: false }
+    }
+  }
+
+}
+
+class VoiceImpl extends validationMixin(VoiceMixin)<VoiceInterface>() {}
+interface VoiceInterface extends VoiceImpl { }
+
+type VoiceConstructor = Constructor<
+  VoiceInterface,
+  typeof VoiceImpl
+>
+
+export type {
+  VoiceConstructor,
+  VoiceInterface,
+}
+export {
+  VoiceImpl,
+}

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

@@ -9,6 +9,7 @@ import type {
   ContactConstructor,
   FriendshipConstructor,
   ImageConstructor,
+  VoiceConstructor,
   LocationConstructor,
   MessageConstructor,
   MiniProgramConstructor,
@@ -51,6 +52,7 @@ test('Wechaty interface', async t => {
     Delay                         : DelayConstructor
     Friendship                    : FriendshipConstructor
     Image                         : ImageConstructor
+    Voice                         : VoiceConstructor
     Location                      : LocationConstructor
     Message                       : MessageConstructor
     MiniProgram                   : MiniProgramConstructor
@@ -82,6 +84,7 @@ test('Wechaty interface', async t => {
         = this.Delay
         = this.Friendship
         = this.Image
+        = this.Voice
         = this.Location
         = this.Message
         = this.MiniProgram

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

@@ -7,6 +7,7 @@ import {
   DelayImpl,
   FriendshipImpl,
   ImageImpl,
+  VoiceImpl,
   LocationImpl,
   MessageImpl,
   MiniProgramImpl,
@@ -35,6 +36,7 @@ import {
   DelayConstructor,
   FriendshipConstructor,
   ImageConstructor,
+  VoiceConstructor,
   LocationConstructor,
   MessageConstructor,
   MiniProgramConstructor,
@@ -79,6 +81,7 @@ const wechatifyUserModuleMixin = <MixinBase extends typeof WechatySkeleton> (mix
     __wechatifiedDelay?                         : DelayConstructor
     __wechatifiedFriendship?                    : FriendshipConstructor
     __wechatifiedImage?                         : ImageConstructor
+    __wechatifiedVoice?                         : VoiceConstructor
     __wechatifiedLocation?                      : LocationConstructor
     __wechatifiedMessage?                       : MessageConstructor
     __wechatifiedMiniProgram?                   : MiniProgramConstructor
@@ -107,6 +110,7 @@ const wechatifyUserModuleMixin = <MixinBase extends typeof WechatySkeleton> (mix
     get Delay ()                        : DelayConstructor                          { return guardWechatify(this.__wechatifiedDelay)          }
     get Friendship ()                   : FriendshipConstructor                     { return guardWechatify(this.__wechatifiedFriendship)     }
     get Image ()                        : ImageConstructor                          { return guardWechatify(this.__wechatifiedImage)          }
+    get Voice ()                        : VoiceConstructor                          { return guardWechatify(this.__wechatifiedVoice)          }
     get Location ()                     : LocationConstructor                       { return guardWechatify(this.__wechatifiedLocation)       }
     get Message ()                      : MessageConstructor                        { return guardWechatify(this.__wechatifiedMessage)        }
     get MiniProgram ()                  : MiniProgramConstructor                    { return guardWechatify(this.__wechatifiedMiniProgram)    }
@@ -155,6 +159,7 @@ const wechatifyUserModuleMixin = <MixinBase extends typeof WechatySkeleton> (mix
       this.__wechatifiedDelay                        = wechatifyUserModule(DelayImpl)(this as any)
       this.__wechatifiedFriendship                   = wechatifyUserModule(FriendshipImpl)(this as any)
       this.__wechatifiedImage                        = wechatifyUserModule(ImageImpl)(this as any)
+      this.__wechatifiedVoice                        = wechatifyUserModule(VoiceImpl)(this as any)
       this.__wechatifiedLocation                     = wechatifyUserModule(LocationImpl)(this as any)
       this.__wechatifiedMessage                      = wechatifyUserModule(MessageImpl)(this as any)
       this.__wechatifiedMiniProgram                  = wechatifyUserModule(MiniProgramImpl)(this as any)
@@ -204,6 +209,7 @@ type ProtectedPropertyWechatifyUserModuleMixin =
   | '__wechatifiedDelay'
   | '__wechatifiedFriendship'
   | '__wechatifiedImage'
+  | '__wechatifiedVoice'
   | '__wechatifiedLocation'
   | '__wechatifiedMessage'
   | '__wechatifiedMiniProgram'