@juzi/wechaty 1.0.0

package/src/user-mixins/wechatify.ts

@@ -0,0 +1,72 @@
+import { log }              from 'wechaty-puppet'
+import type { Constructor } from 'clone-class'
+
+import type { WechatyInterface } from '../wechaty/mod.js'
+
+const WECHATIFIED_PREFIX = 'Wechatified'
+
+interface WechatyMinxin {
+  wechaty: WechatyInterface,
+  new (...args: any[]): {
+    get wechaty (): WechatyInterface
+  }
+}
+
+const wechatifyUserModule = <T extends WechatyMinxin> (UserClass: T) => {
+  log.verbose('WechatifyMixin', 'wechatifyUserModule(%s)', UserClass.name)
+
+  return (wechaty: WechatyInterface): T => {
+    log.verbose('WechatifyMixin', 'wechatifyUserModule(%s)(%s)', UserClass.name, wechaty)
+
+    class WechatifiedUserClass extends UserClass {
+
+      static override get wechaty () { return wechaty }
+      override get wechaty        () { return wechaty }
+
+    }
+
+    Reflect.defineProperty(WechatifiedUserClass, 'name', {
+      value: WECHATIFIED_PREFIX + UserClass.name,
+    })
+
+    return WechatifiedUserClass
+  }
+}
+
+const throwWechatifyError = (WechatyUserClass: Function) => {
+  throw new Error([
+    `${WechatyUserClass.name}: Wechaty User Class (WUC) can not be instantiated directly!`,
+    'See: https://github.com/wechaty/wechaty/issues/1217',
+  ].join('\n'))
+}
+
+const isWechatified = (klass: Function) => klass.name.startsWith(WECHATIFIED_PREFIX)
+
+const wechatifyMixin = <TBase extends Constructor> (Base: TBase) => {
+  log.verbose('WechatifyMixin', 'wechatifyMixin(%s)', Base.name || '')
+
+  abstract class AbstractWechatifyMixin extends Base {
+
+    static get wechaty  (): WechatyInterface { return throwWechatifyError(this) }
+    get wechaty         (): WechatyInterface { return throwWechatifyError(this.constructor) }
+
+    constructor (...args: any[]) {
+      super(...args)
+      if (!isWechatified(this.constructor)) {
+        throwWechatifyError(this.constructor)
+      }
+    }
+
+  }
+
+  return AbstractWechatifyMixin
+}
+
+const wechatifyMixinBase = () => wechatifyMixin(class EmptyBase {})
+
+export {
+  isWechatified,
+  wechatifyMixin,
+  wechatifyMixinBase,
+  wechatifyUserModule,
+}

package/src/user-modules/contact-self.ts

@@ -0,0 +1,217 @@
+/**
+ *   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 'wechaty-puppet'
+import {
+  log,
+}                             from 'wechaty-puppet'
+import type {
+  FileBoxInterface,
+}                             from 'file-box'
+
+import type { Constructor }   from 'clone-class'
+
+import {
+  guardQrCodeValue,
+}                       from '../pure-functions/guard-qr-code-value.js'
+
+import {
+  ContactImpl,
+}                       from './contact.js'
+import { validationMixin } from '../user-mixins/validation.js'
+import { poolifyMixin } from '../user-mixins/poolify.js'
+
+const MixinBase = poolifyMixin(
+  ContactImpl,
+)<ContactSelfInterface>()
+
+/**
+ * Bot itself will be encapsulated as a ContactSelf.
+ *
+ * > Tips: this class is extends Contact
+ * @example
+ * const bot = new Wechaty()
+ * await bot.start()
+ * bot.on('login', (user: ContactSelf) => {
+ *   console.log(`user ${user} login`)
+ * })
+ */
+class ContactSelfMixin extends MixinBase {
+
+  static override async find (
+    query : string | PUPPET.filters.Contact,
+  ): Promise<undefined | ContactSelfInterface> {
+    if (!this.wechaty.isLoggedIn) {
+      return undefined
+    }
+
+    try {
+      const contact = await super.find(query)
+      if (contact && contact.id === this.wechaty.puppet.currentUserId) {
+        return contact as ContactSelfInterface
+      }
+    } catch (e) {
+      log.silly('ContactSelf', 'find() exception: %s', (e as Error).message)
+    }
+    return undefined
+  }
+
+  public override async avatar ()                       : Promise<FileBoxInterface>
+  public override async avatar (file: FileBoxInterface) : Promise<void>
+
+  /**
+   * GET / SET bot avatar
+   *
+   * @param {FileBox} [file]
+   * @returns {(Promise<void | FileBox>)}
+   *
+   * @example <caption> GET the avatar for bot, return {Promise<FileBox>}</caption>
+   * // Save avatar to local file like `1-name.jpg`
+   *
+   * bot.on('login', (user: ContactSelf) => {
+   *   console.log(`user ${user} login`)
+   *   const file = await user.avatar()
+   *   const name = file.name
+   *   await file.toFile(name, true)
+   *   console.log(`Save bot avatar: ${contact.name()} with avatar file: ${name}`)
+   * })
+   *
+   * @example <caption>SET the avatar for a bot</caption>
+   * import { FileBox }  from 'wechaty'
+   * bot.on('login', (user: ContactSelf) => {
+   *   console.log(`user ${user} login`)
+   *   const fileBox = FileBox.fromUrl('https://wechaty.github.io/wechaty/images/bot-qr-code.png')
+   *   await user.avatar(fileBox)
+   *   console.log(`Change bot avatar successfully!`)
+   * })
+   *
+   */
+  public override async avatar (file?: FileBoxInterface): Promise<void | FileBoxInterface> {
+    log.verbose('Contact', 'avatar(%s)', file ? file.name : '')
+
+    if (!file) {
+      const filebox = await super.avatar()
+      return filebox
+    }
+
+    if (this.id !== this.wechaty.puppet.currentUserId) {
+      throw new Error('set avatar only available for user self')
+    }
+
+    await this.wechaty.puppet.contactAvatar(this.id, file)
+  }
+
+  /**
+   * Get bot qrcode
+   *
+   * @returns {Promise<string>}
+   *
+   * @example
+   * import { generate } from 'qrcode-terminal'
+   * bot.on('login', (user: ContactSelf) => {
+   *   console.log(`user ${user} login`)
+   *   const qrcode = await user.qrcode()
+   *   console.log(`Following is the bot qrcode!`)
+   *   generate(qrcode, { small: true })
+   * })
+   */
+  public async qrcode (): Promise<string> {
+    log.verbose('Contact', 'qrcode()')
+    if (this.id !== this.wechaty.puppet.currentUserId) {
+      throw new Error('only can get qrcode for the currentUser')
+    }
+
+    const qrcodeValue = await this.wechaty.puppet.contactSelfQRCode()
+    return guardQrCodeValue(qrcodeValue)
+  }
+
+  /**
+   * Change bot name
+   *
+   * @param name The new name that the bot will change to
+   *
+   * @example
+   * bot.on('login', async user => {
+   *   console.log(`user ${user} login`)
+   *   const oldName = user.name()
+   *   try {
+   *     await user.name(`${oldName}-${new Date().getTime()}`)
+   *   } catch (e) {
+   *     console.error('change name failed', e)
+   *   }
+   * })
+   */
+  public override name (): string
+  public override name (name: string): Promise<void>
+
+  public override name (name?: string): string | Promise<void> {
+    log.verbose('ContactSelf', 'name(%s)', name || '')
+
+    if (typeof name === 'undefined') {
+      return super.name()
+    }
+
+    if (this.id !== this.wechaty.puppet.currentUserId) {
+      throw new Error('only can set name for user self')
+    }
+
+    return this.wechaty.puppet.contactSelfName(name).then(this.sync.bind(this))
+  }
+
+  /**
+   * Change bot signature
+   *
+   * @param signature The new signature that the bot will change to
+   *
+   * @example
+   * bot.on('login', async user => {
+   *   console.log(`user ${user} login`)
+   *   try {
+   *     await user.signature(`Signature changed by wechaty on ${new Date()}`)
+   *   } catch (e) {
+   *     console.error('change signature failed', e)
+   *   }
+   * })
+   */
+  public async signature (signature: string): Promise<void> {
+    log.verbose('ContactSelf', 'signature()')
+
+    if (this.id !== this.wechaty.puppet.currentUserId) {
+      throw new Error('only can change signature for user self')
+    }
+
+    return this.wechaty.puppet.contactSelfSignature(signature).then(this.sync.bind(this))
+  }
+
+}
+
+class ContactSelfImpl extends validationMixin(ContactSelfMixin)<ContactSelfInterface>() {}
+interface ContactSelfInterface extends ContactSelfImpl {}
+type ContactSelfConstructor = Constructor<
+  ContactSelfInterface,
+  Omit<typeof ContactSelfImpl, 'load'>
+>
+
+export type {
+  ContactSelfConstructor,
+  ContactSelfInterface,
+}
+export {
+  ContactSelfImpl,
+}

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

@@ -0,0 +1,91 @@
+#!/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 { PuppetMock } from 'wechaty-puppet-mock'
+import { WechatyBuilder } from '../wechaty-builder.js'
+
+import {
+  ContactImpl,
+  ContactProtectedProperty,
+}                             from './contact.js'
+
+test('findAll()', async t => {
+  const EXPECTED_NAME = 'TestingBot'
+
+  const puppet = new PuppetMock()
+  const wechaty = WechatyBuilder.build({ puppet })
+
+  const mockContact = puppet.mocker.createContact({ name: EXPECTED_NAME })
+
+  await wechaty.start()
+  await puppet.mocker.login(mockContact)
+
+  const contactList = await wechaty.Contact.findAll()
+  t.equal(contactList.length, 1, 'should find 1 contact')
+  t.equal(contactList[0]!.name(), EXPECTED_NAME, 'should get name from payload')
+  t.same(contactList[0]!.payload, mockContact.payload, 'should get payload from mockContact')
+
+  await wechaty.stop()
+})
+
+test('Should not be able to instanciate directly', async t => {
+  t.throws(() => {
+    const c = ContactImpl.load('xxx')
+    t.fail(c.name())
+  }, 'should throw when `Contact.load()`')
+
+  t.throws(() => {
+    const c = ContactImpl.load('xxx')
+    t.fail(c.name())
+  }, 'should throw when `Contact.load()`')
+})
+
+test('Should not be able to instanciate through cloneClass without puppet', async t => {
+  t.throws(() => {
+    const c = ContactImpl.load('xxx')
+    t.fail(c.name())
+  }, 'should throw when `MyContact.load()` without puppet')
+
+  t.throws(() => {
+    const c = ContactImpl.load('xxx')
+    t.fail(c.name())
+  }, 'should throw when `MyContact.load()` without puppet')
+
+})
+
+test('should throw when instanciate the global class', async t => {
+  t.throws(() => {
+    const c = ContactImpl.load('xxx')
+    t.fail('should not run to here')
+    t.fail(c.toString())
+  }, 'should throw when we instanciate a global class')
+})
+
+test('ProtectedProperties', async t => {
+  type NotExistInWechaty = Exclude<ContactProtectedProperty, keyof ContactImpl>
+  type NotExistTest = NotExistInWechaty extends never ? true : false
+
+  const noOneLeft: NotExistTest = true
+  t.ok(noOneLeft, 'should match Wechaty properties for every protected property')
+})