wechaty.js

/**
 *
 * wechaty: Wechat for Bot. and for human who talk to bot/robot
 *
 * Class Wechaty
 *
 * Licenst: ISC
 * https://github.com/zixia/wechaty
 *
 */

const log           = require('npmlog')
const EventEmitter  = require('events')

const Puppet      = require('./puppet')
const PuppetWeb   = require('./puppet-web')

const Message     = require('./message')
const Contact     = require('./contact')
const Group       = require('./group')

class Wechaty extends EventEmitter {
  constructor(options) {
    super()
    this.options = options || {}
    this.options.puppet = this.options.puppet || 'web'

    this.VERSION = require('../package.json').version
  }
  toString() { return 'Class Wechaty(' + this.puppet + ')'}
  init() {
    log.info('Wechaty', 'init() with version: %s', this.VERSION)
    this.initPuppet()
    this.initEventHook()

    return this.puppet.init()
    .then(r => {
      return this // for chaining
    })
  }
  initPuppet() {
    switch (this.options.puppet) {
      case 'web':
        this.puppet = new Puppet.Web({
          head:   this.options.head
          , port: this.options.port
        })
        break
      default:
        throw new Error('Puppet unsupport(yet): ' + this.options.puppet)
    }
    return Promise.resolve(this.puppet)
  }
  initEventHook() {
    // scan qrCode
    this.puppet.on('scan', (e) => {
      this.emit('scan', e)
    })
    this.puppet.on('message', (e) => {
      this.emit('message', e)
    })
    this.puppet.on('login', (e) => {
      this.emit('login', e)
    })
    this.puppet.on('logout', (e) => {
      this.emit('logout', e)
    })

    /**
     * TODO: support more events:
     * 1. error
     * 2. send
     * 3. reply
     * 4. quit
     * 5. ...
     */

    return Promise.resolve()
  }

  quit()   { return this.puppet.quit() }

  send(message)   { return this.puppet.send(message) }
  reply(message, reply) { return this.puppet.reply(message, reply) }

  ding()          {
    // TODO: test through the server & browser
    return 'dong'
  }

  /**
   * @deprecated
   * use on('scan', ({code, url}) => {}) instead.
   */
  getLoginQrImgUrl() { return this.puppet.getLoginQrImgUrl() }
}

Puppet.Web = PuppetWeb

Object.assign(Wechaty, {
  Puppet:     Puppet
  , Message:  Message
  , Contact:  Contact
  , Group:    Group
})

/**
 * Expose `Wechaty`.
 */
module.exports = Wechaty.default = Wechaty.Wechaty = Wechaty