@juzi/wechaty 1.0.0

package/bin/doctor.ts

@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+/**
+ *   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 os from 'os'
+
+import { config }   from '../src/config.js'
+import { Doctor }   from '../src/doctor.js'
+import { WechatyBuilder }  from '../src/wechaty-builder.js'
+
+const wechaty = WechatyBuilder.singleton()
+const doctor = new Doctor()
+
+async function main () {
+  let ipcTestResult: string
+  try {
+    await doctor.testTcp()
+    ipcTestResult = 'PASS'
+  } catch (err) {
+    console.info(err)
+    ipcTestResult = 'FAIL. Please check your tcp network, Wechaty need to listen on localhost and connect to it.'
+  }
+
+  console.info(`
+  #### Wechaty Doctor
+
+  1. Wechaty version: ${wechaty.version()}
+  2. ${os.type()} ${os.arch()} version ${os.release()} memory ${Math.floor(os.freemem() / 1024 / 1024)}/${Math.floor(os.totalmem() / 1024 / 1024)} MB
+  3. Docker: ${config.docker}
+  4. Node version: ${process.version}
+  5. Tcp IPC TEST: ${ipcTestResult}
+
+  `)
+
+}
+
+main()
+  .catch(err => console.error('main() exception: %s', err))

package/bin/entrypoint.sh

@@ -0,0 +1,338 @@
+#!/usr/bin/env bash
+#
+# Wechaty - Connect ChatBots
+#
+# https://github.com/wechaty/wechaty
+#
+set -e
+
+export HOME=/bot
+export PATH=$PATH:/wechaty/bin:/wechaty/node_modules/.bin
+
+function wechaty::banner() {
+  echo
+  figlet " Wechaty "
+  echo ____________________________________________________
+  echo "            https://www.chatie.io"
+}
+
+function wechaty::errorBotNotFound() {
+  local file=$1
+  echo "Container ERROR: can not found bot file: $HOME/$file"
+
+  echo "Container PWD: $(pwd)"
+  echo "Container HOME: $HOME"
+  echo "Container LS $HOME: $(ls -l $HOME)"
+
+  figlet " Troubleshooting "
+  cat <<'TROUBLESHOOTING'
+
+    Troubleshooting:
+
+    1. Did you bind the current directory into container?
+
+      check your `docker run ...` command, if there's no `volumn` arg,
+      then you need to add it so that we can bind the volume of /bot:
+
+        `--volume="$(pwd)":/bot`
+
+      this will let the container visit your current directory.
+
+    2. Are you sure your .js/.ts files aren't .js.txt/.ts.txt?
+
+      this could be a problem on new Windows installs (file
+      extensions hidden by default).
+
+    if you still have issue, please have a look at
+      https://github.com/wechaty/wechaty/issues/66
+      and do a search in issues, that might be help.
+
+TROUBLESHOOTING
+}
+
+function wechaty::printEnv () {
+  num=$(env | grep -c WECHATY)
+  echo "WECHATY Environment Variables: $num"
+  env | grep WECHATY
+}
+
+function wechaty::errorCtrlC () {
+  # http://www.tldp.org/LDP/abs/html/exitcodes.html
+  # 130 Script terminated by Control-C  Ctl-C Control-C is fatal error signal 2, (130 = 128 + 2, see above)
+  echo ' Script terminated by Control-C '
+  figlet ' Ctrl + C '
+}
+
+function wechaty::pressEnterToContinue() {
+  local -i timeoutSecond=${1:-30}
+  local message=${2:-'Press ENTER to continue ... '}
+
+  read -r -t "$timeoutSecond"  -p "$message" || true
+  echo
+}
+
+function wechaty::diagnose() {
+  local -i ret=$1  && shift
+  local file=$1 && shift
+
+  echo "ERROR: Bot exited with code $ret"
+
+  figlet ' BUG REPORT '
+  wechaty::pressEnterToContinue 30
+
+  echo
+  echo "### 1. source code of $file"
+  echo
+  cat "$HOME/$file" || echo "ERROR: file not found"
+  echo
+
+  echo
+  echo "### 2. directory structor of $HOME"
+  echo
+  ls -l "$HOME"
+
+  echo
+  echo '### 3. package.json'
+  echo
+  cat "$HOME"/package.json || echo "No package.json"
+
+  echo
+  echo "### 4. directory structor inside $HOME/node_modules"
+  echo
+  ls "$HOME"/node_modules || echo "No node_modules"
+
+  echo
+  echo '### 5. wechaty doctor'
+  echo
+  wechaty-doctor
+
+  figlet " Submit a ISSUE "
+  echo _____________________________________________________________
+  echo '####### please paste all the above diagnose messages #######'
+  echo
+  echo 'Wechaty Issue https://github.com/wechaty/wechaty/issues'
+  echo
+
+  wechaty::pressEnterToContinue
+}
+
+function wechaty::runBot() {
+  local botFile=$1
+
+  if [ ! -f "$HOME/$botFile" ]; then
+    wechaty::errorBotNotFound "$botFile"
+    return 1
+  fi
+
+  echo  "Working directory: $HOME"
+  cd    "$HOME"
+
+  [ -f package.json ] && {
+    # echo "Install dependencies modules ..."
+
+    #
+    # NPM module install will have problem in China.
+    # i.e. chromedriver need to visit a google host to download binarys.
+    #
+    echo "Please make sure you had installed all the NPM modules which is depended on your bot script."
+    # yarn < /dev/null || return $? # yarn will close stdin??? cause `read` command fail after yarn
+
+    #
+    # Issue https://github.com/wechaty/wechaty/issues/1478
+    #   As a conclusion: we should better not to link the local node_modules to the Docker global.
+    #
+    # wechaty::linkBotNodeModules
+  }
+
+  # echo -n "Linking Wechaty module to bot ... "
+  # npm link wechaty < /dev/null > /dev/null 2>&1
+  # echo "linked. "
+
+  # npm --progress=false install @types/node > /dev/null
+
+  #
+  # Huan(202108) node_arg: --es-module-specifier-resolution=node
+  #
+  #   Make .js extension default for ESM imports
+  #     See: https://github.com/nodejs/node/issues/30927#issuecomment-575998045 \
+  #
+  local -i ret=0
+  case "$botFile" in
+    *.js | *.cjs | *.mjs)
+      echo "Executing node $*"
+      node \
+        --es-module-specifier-resolution=node \
+        "$@" \
+        &
+      ;;
+    *.ts)
+      echo "Executing node --loader=ts-node/esm $*"
+      node \
+        --es-module-specifier-resolution=node \
+        --no-warnings \
+        --loader=ts-node/esm \
+        "$@" \
+        &
+      ;;
+    *)
+      echo "ERROR: wechaty::runBot() neither .{js,cjs,mjs} nor .ts"
+      exit 1 &
+  esac
+
+  wait "$!" || ret=$? # fix `can only `return' from a function or sourced script` error
+
+  case "$ret" in
+    0)
+      ;;
+    130)
+      wechaty::errorCtrlC
+      ;;
+    *)
+      wechaty::diagnose "$ret" "$@"
+      ;;
+  esac
+
+  return "$ret"
+}
+
+# Issue https://github.com/wechaty/wechaty/issues/1478
+# To Be Tested:
+function wechaty::linkBotNodeModules() {
+  for localModule in /bot/node_modules/*; do
+    [ -e "$localModule" ] || continue
+
+    module=${localModule//\/bot\/node_modules\//}
+
+    globalModule="/node_modules/$module"
+
+    if [ ! -e "$globalModule" ]; then
+      ln -sf "$localModule" /node_modules/
+    # else
+      # echo "$globalModule exists"
+    fi
+  done
+}
+
+function wechaty::io-client() {
+  figlet " Chatie.io "
+  figlet " Authing By:"
+  echo
+  echo "WECHATY_TOKEN=$WECHATY_TOKEN "
+  echo
+
+  pushd /wechaty
+  npm run io-client
+  popd
+}
+
+function wechaty::help() {
+  figlet " Docker Usage: "
+  cat <<HELP
+
+
+
+  Usage: wechaty [ mybot.js | mybot.ts | COMMAND ]
+
+  Run a JavaScript/TypeScript <Bot File>, or a <Wechaty Command>.
+
+  <Bot File>:
+    mybot.js: a JavaScript program for your bot.
+    mybot.ts: a TypeScript program for your bot.
+
+  <Commands>:
+    demo    Run Wechaty DEMO
+    doctor  Print Diagnose Report
+    test    Run Unit Test
+
+  Learn more at:
+    https://github.com/wechaty/wechaty/wiki/Docker
+
+
+
+HELP
+}
+
+function main() {
+  # issue #84
+  echo -e 'nameserver 114.114.114.114\nnameserver 1.1.1.1\nnameserver 8.8.8.8' | sudo tee -a /etc/resolv.conf > /dev/null
+
+  wechaty::banner
+  figlet Connecting
+  figlet ChatBots
+
+  wechaty::printEnv
+
+  VERSION=$(WECHATY_LOG=WARN wechaty-version 2>/dev/null || echo '0.0.0(unknown)')
+
+  echo
+  echo -n "Starting Docker Container for Wechaty v$VERSION with "
+  echo -n "Node.js $(node --version) ..."
+  echo
+
+  local -i ret=0
+
+  local defaultArg=help
+  if [ -n "$WECHATY_TOKEN" ]; then
+    defaultArg=io-client
+  fi
+
+  case "${1:-${defaultArg}}" in
+    #
+    # 1. Get a shell
+    #
+    shell | sh | bash)
+      /bin/bash -s || ret=$?
+      ;;
+
+    #
+    # 2. Run a bot
+    #
+    *.ts | *.js | *.cjs | *.mjs)
+      # set -e will not work inside wechaty::runBot because of
+      # http://stackoverflow.com/a/4073372/1123955
+      wechaty::runBot "$@" || ret=$?
+      ;;
+
+    #
+    # 3. If there's additional `npm` arg...
+    #
+    npm)
+      shift
+      npm "$@" || ret=$?
+      ;;
+
+    help|version)
+      wechaty::help
+      ;;
+
+    io-client)
+      wechaty::io-client
+      ;;
+
+    test)
+      # WECHATY_LOG=silent npm run test:unit
+      if [ -f "$HOME"/package.json ]; then
+        pushd "$HOME"
+      else
+        pushd /wechaty
+      fi
+      WECHATY_LOG=silent npm run test
+      popd
+      ;;
+
+    #
+    # 4. Default to execute npm run ...
+    #
+    *)
+      [ "$1" = "run" ] && shift
+      npm run "$@" || ret=$?
+     ;;
+  esac
+
+  wechaty::banner
+  figlet " Exit $ret "
+  return $ret
+}
+
+main "$@"
+

package/bin/io-client.ts

@@ -0,0 +1,95 @@
+#!/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 'dotenv/config.js'
+
+import {
+  log,
+}             from 'wechaty-puppet'
+import {
+  config,
+}             from '../src/config.js'
+
+import {
+  IoClient,
+  IoClientOptions,
+}                   from '../src/io-client.js'
+import { WechatyBuilder }  from '../src/wechaty-builder.js'
+
+const welcome = `
+| __        __        _           _
+| \\ \\      / /__  ___| |__   __ _| |_ _   _
+|  \\ \\ /\\ / / _ \\/ __| '_ \\ / _\` | __| | | |
+|   \\ V  V /  __/ (__| | | | (_| | |_| |_| |
+|    \\_/\\_/ \\___|\\___|_| |_|\\__,_|\\__|\\__, |
+|                                     |___/
+
+=============== Powered by Wechaty ===============
+       -------- https://www.chatie.io --------
+
+My super power: download cloud bot from www.chatie.io
+
+__________________________________________________
+
+`
+
+async function main () {
+  const token = config.token
+
+  if (!token) {
+    throw new Error('token not found: please set WECHATY_TOKEN in environment before run io-client')
+  }
+
+  console.info(welcome)
+  log.info('Client', 'Starting for WECHATY_TOKEN: %s', token)
+
+  const wechaty = WechatyBuilder.build({ name: token })
+
+  let port
+  if (process.env['WECHATY_PUPPET_SERVER_PORT']) {
+    port = parseInt(process.env['WECHATY_PUPPET_SERVER_PORT'])
+  }
+
+  const options: IoClientOptions = {
+    token,
+    wechaty,
+  }
+  if (port) {
+    options.port = port
+  }
+
+  const client = new IoClient(options)
+
+  client.start()
+    .catch(onError.bind(client))
+}
+
+async function onError (
+  this : IoClient,
+  e    : Error,
+) {
+  log.error('Client', 'start() fail: %s', e)
+  await this.quit()
+  process.exit(-1)
+}
+
+main()
+  .catch(console.error)

package/bin/providers-trends.ts

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+import { OFFICIAL_PUPPET_DEPENDENCIES } from '../src/puppet-config.js'
+
+async function main () {
+  const puppetNameList = Object.keys(OFFICIAL_PUPPET_DEPENDENCIES)
+  const publicNameList = puppetNameList.filter(name => /^[^@]/.test(name))
+  const urlPath = publicNameList.join('-vs-')
+  const url = 'https://www.npmtrends.com/' + urlPath
+  console.info(url)
+}
+
+main()
+  .catch(console.error)

package/bin/puppet-install.ts

@@ -0,0 +1,69 @@
+#!/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 spawn from 'cross-spawn'
+
+import { log } from 'wechaty-puppet'
+
+import {
+  OFFICIAL_PUPPET_DEPENDENCIES,
+  OfficialPuppetNpmName,
+}                         from '../src/puppet-config.js'
+
+/**
+ * Install all `wechaty-puppet-*` modules from `puppet-config.ts`
+ */
+async function main (): Promise<void> {
+  log.info('PuppetInstall', 'main() installing ...')
+
+  const skipList = [
+    '@juzibot/wechaty-puppet-donut',  // windows puppet
+    '@juzibot/wechaty-puppet-wxwork', // wxwork puppet
+  ]
+
+  const moduleList: string[] = []
+
+  for (const puppetModuleName of Object.keys(OFFICIAL_PUPPET_DEPENDENCIES)) {
+    const version = OFFICIAL_PUPPET_DEPENDENCIES[puppetModuleName as OfficialPuppetNpmName]
+
+    if (version === '0.0.0' || skipList.includes(puppetModuleName)) {
+      continue
+    }
+
+    moduleList.push(`${puppetModuleName}@${version}`)
+  }
+
+  const args = [
+    'install',
+    '--no-save',
+    ...moduleList,
+  ]
+  log.info('PuppetInstall', `installing ... Shell: "npm install ${args.join(' ')}"\n`)
+
+  const result = spawn('npm', args, { stdio: 'inherit' })
+  await new Promise(resolve => result.once('exit', resolve))
+
+  log.info('PuppetInstall', 'main() installing ... done')
+}
+
+main().catch(e => {
+  console.error(e)
+  process.exit(1)
+})

package/bin/version.ts

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+/**
+ *   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 { VERSION } from '../src/config.js'
+
+console.info(VERSION)

package/dist/cjs/bin/cli.d.ts

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+/**
+ * https://github.com/wechaty/wechaty
+ *
+ * Author: Huan <zixia@zixia.net>
+ * License: Apache-2.0
+ *
+ * CLI Apps in TypeScript with `cmd-ts` (Part 1)
+ *  Using `cmd-ts` to easily build a type-safe TypeScript CLI app
+ *
+ *  https://gal.hagever.com/posts/type-safe-cli-apps-in-typescript-with-cmd-ts-part-1/
+ */
+import 'dotenv/config.js';
+//# sourceMappingURL=cli.d.ts.map

package/dist/cjs/bin/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../../bin/cli.ts"],"names":[],"mappings":";AACA;;;;;;;;;;GAUG;AAEH,OAAO,kBAAkB,CAAA"}

package/dist/cjs/bin/cli.js

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * https://github.com/wechaty/wechaty
+ *
+ * Author: Huan <zixia@zixia.net>
+ * License: Apache-2.0
+ *
+ * CLI Apps in TypeScript with `cmd-ts` (Part 1)
+ *  Using `cmd-ts` to easily build a type-safe TypeScript CLI app
+ *
+ *  https://gal.hagever.com/posts/type-safe-cli-apps-in-typescript-with-cmd-ts-part-1/
+ */
+/* eslint-disable sort-keys */
+require("dotenv/config.js");
+const cmd_ts_1 = require("cmd-ts");
+const config_js_1 = require("../src/config.js");
+const cmds = __importStar(require("../src/cli/mod.js"));
+const wechatyCli = (0, cmd_ts_1.subcommands)({
+    name: 'wechaty',
+    description: 'Wechaty CLI Utility',
+    version: config_js_1.VERSION,
+    cmds,
+});
+(0, cmd_ts_1.run)((0, cmd_ts_1.binary)(wechatyCli), process.argv).catch(console.error);
+//# sourceMappingURL=cli.js.map

package/dist/cjs/bin/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../bin/cli.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA;;;;;;;;;;GAUG;AACH,8BAA8B;AAC9B,4BAAyB;AAEzB,mCAImC;AAEnC,gDAA0C;AAE1C,wDAA6C;AAE7C,MAAM,UAAU,GAAG,IAAA,oBAAW,EAAC;IAC7B,IAAI,EAAE,SAAS;IACf,WAAW,EAAE,qBAAqB;IAClC,OAAO,EAAE,mBAAO;IAChB,IAAI;CACL,CAAC,CAAA;AAEF,IAAA,YAAG,EACD,IAAA,eAAM,EAAC,UAAU,CAAC,EAClB,OAAO,CAAC,IAAI,CACb,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA"}

package/dist/cjs/bin/doctor.d.ts

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+/**
+ *   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.
+ *
+ */
+export {};
+//# sourceMappingURL=doctor.d.ts.map

package/dist/cjs/bin/doctor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doctor.d.ts","sourceRoot":"","sources":["../../../bin/doctor.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;;GAkBG"}