@juzi/wechaty 1.0.0

package/src/pure-functions/escape-regexp.ts

@@ -0,0 +1,22 @@
+/**
+ *   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 function escapeRegExp (text: string) {
+  return text.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&')
+}

package/src/pure-functions/guard-qr-code-value.ts

@@ -0,0 +1,27 @@
+/**
+ *   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.
+ *
+ */
+const MAX_LEN = 7089
+
+export function guardQrCodeValue (value: string): string {
+  if (value.length > MAX_LEN) {
+    throw new Error('QR Code Value is larger then the max len. Did you return the image base64 text by mistake? See: https://github.com/wechaty/wechaty/issues/1889')
+  }
+  return value
+}

package/src/pure-functions/is-template-string-array.spec.ts

@@ -0,0 +1,44 @@
+#!/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 { isTemplateStringArray } from './is-template-string-array.js'
+
+test('isTemplateStringArray', async t => {
+  function test (
+    s: string | TemplateStringsArray,
+    ...varList : unknown[]
+  ) {
+    void varList
+    if (isTemplateStringArray(s)) {
+      return true
+    }
+    return false
+  }
+
+  const n = 42
+  const obj = {}
+
+  t.ok(test`foo`, 'should return true for template string')
+  t.ok(test`bar${n}`, 'should return true for template string with one var')
+  t.ok(test`obj${obj}`, 'should return true for template string with one obj')
+
+  t.notOk(test('xixi'), 'should return false for (string) call')
+})

package/src/pure-functions/is-template-string-array.ts

@@ -0,0 +1,5 @@
+function isTemplateStringArray (tsa: any): tsa is TemplateStringsArray {
+  return Array.isArray(tsa.raw) && Array.isArray(tsa)
+}
+
+export { isTemplateStringArray }

package/src/pure-functions/mod.ts

@@ -0,0 +1,28 @@
+/**
+ *   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 { retryPolicy }      from './retry-policy.js'
+export {
+  digestEmoji,
+  plainText,
+  stripEmoji,
+  stripHtml,
+  unescapeHtml,
+  unifyEmoji,
+}                          from './xml.js'

package/src/pure-functions/retry-policy.ts

@@ -0,0 +1,45 @@
+import {
+  Policy,
+  RetryPolicy,
+}                 from 'cockatiel'
+import {
+  log,
+}                 from 'wechaty-puppet'
+
+/**
+ * Create a retry policy that'll try whatever function we execute 3
+ *  times with a randomized exponential backoff.
+ *
+ * https://github.com/connor4312/cockatiel#policyretry
+ */
+const retryPolicy = getRetryPolicy()
+
+function getRetryPolicy (): RetryPolicy {
+  const policy = Policy
+    .handleAll()
+    .retry()
+    .attempts(3)
+    .exponential({
+      /**
+       * ExponentialBackoff
+       *  https://github.com/connor4312/cockatiel#exponentialbackoff
+       */
+      initialDelay : 1000,
+      maxAttempts  : 5,
+      maxDelay     : 10 * 1000,
+    })
+
+  policy.onRetry(reason => log.silly('wechaty',
+    'retry-policy getRetryPolicy policy.onRetry() reason: "%s"',
+    JSON.stringify(reason),
+  ))
+  policy.onSuccess(({ duration }) => log.silly('wechaty',
+    'retry-policy getRetryPolicy policy.onSuccess(): retry call ran in %s ms',
+    duration,
+  ))
+  return policy
+}
+
+export {
+  retryPolicy,
+}

package/src/pure-functions/timestamp-to-date.spec.ts

@@ -0,0 +1,43 @@
+#!/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 { timestampToDate } from './timestamp-to-date.js'
+
+/**
+ * 1e11
+ *   in milliseconds:  Sat Mar 03 1973 09:46:39 UTC
+ *   in seconds:       Wed Nov 16 5138 9:46:40 UTC
+ */
+test('timestampToDate() for dealing with seconds', async t => {
+  const SECONDS = 1e11 - 1
+  const EXPECTED_DATE_NOW = 'Wed, 16 Nov 5138 09:46:39 GMT'
+
+  const date = timestampToDate(SECONDS)
+  t.equal(date.toUTCString(), EXPECTED_DATE_NOW, 'should parse seconds to right date')
+})
+
+test('timestampToDate() for dealing with milliseconds', async t => {
+  const MILLISECONDS = 1e11 + 1
+  const EXPECTED_DATE_UTC = 'Sat, 03 Mar 1973 09:46:40 GMT'
+
+  const date = timestampToDate(MILLISECONDS)
+  t.equal(date.toUTCString(), EXPECTED_DATE_UTC, 'should parse milliseconds to right date')
+})

package/src/pure-functions/timestamp-to-date.ts

@@ -0,0 +1,31 @@
+/**
+ *   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 function timestampToDate (timestamp: number): Date {
+  /**
+    * 1e11:
+    *   in milliseconds:  Sat Mar 03 1973 09:46:39 UTC
+    *   in seconds:       Wed Nov 16 5138 9:46:40 UTC
+    */
+  if (timestamp < 1e11) {
+    timestamp *= 1000 // turn seconds to milliseconds
+  }
+
+  return new Date(timestamp)
+}

package/src/pure-functions/xml.spec.ts

@@ -0,0 +1,116 @@
+#!/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 {
+  digestEmoji,
+  plainText,
+  stripEmoji,
+  stripHtml,
+  unescapeHtml,
+  unifyEmoji,
+}                   from './xml.js'
+
+test('stripHtml()', async t => {
+  const HTML_BEFORE_STRIP = 'Outer<html>Inner</html>'
+  const HTML_AFTER_STRIP  = 'OuterInner'
+
+  const strippedHtml = stripHtml(HTML_BEFORE_STRIP)
+  t.equal(strippedHtml, HTML_AFTER_STRIP, 'should strip html as expected')
+})
+
+test('unescapeHtml()', async t => {
+  const HTML_BEFORE_UNESCAPE  = '&apos;|&quot;|&gt;|&lt;|&amp;'
+  // eslint-disable-next-line
+  const HTML_AFTER_UNESCAPE   = `'|"|>|<|&`
+
+  const unescapedHtml = unescapeHtml(HTML_BEFORE_UNESCAPE)
+  t.equal(unescapedHtml, HTML_AFTER_UNESCAPE, 'should unescape html as expected')
+})
+
+test('plainText()', async t => {
+  const PLAIN_BEFORE  = '&amp;<html>&amp;</html>&amp;<img class="emoji emoji1f4a4" text="[流汗]_web" src="/zh_CN/htmledition/v2/images/spacer.gif" />'
+  const PLAIN_AFTER   = '&&&[流汗]'
+
+  const text = plainText(PLAIN_BEFORE)
+  t.equal(text, PLAIN_AFTER, 'should convert plain text as expected')
+
+})
+
+test('digestEmoji()', async t => {
+  const EMOJI_XML = [
+    '<img class="emoji emoji1f4a4" text="[流汗]_web" src="/zh_CN/htmledition/v2/images/spacer.gif" />',
+    '<img class="qqemoji qqemoji13" text="[呲牙]_web" src="/zh_CN/htmledition/v2/images/spacer.gif" />',
+    '<img class="emoji emoji1f44d" text="_web" src="/zh_CN/htmledition/v2/images/spacer.gif" />',
+    '<span class="emoji emoji1f334"></span>',
+  ]
+  const EMOJI_AFTER_DIGEST  = [
+    '[流汗]',
+    '[呲牙]',
+    '',
+    '[emoji1f334]',
+  ]
+
+  for (let i = 0; i < EMOJI_XML.length; i++) {
+    const emojiDigest = digestEmoji(EMOJI_XML[i])
+    t.equal(emojiDigest, EMOJI_AFTER_DIGEST[i], 'should digest emoji string ' + i + ' as expected')
+  }
+})
+
+test('unifyEmoji()', async t => {
+  const ORIGNAL_XML_LIST: Array<[string[], string]> = [
+    [
+      [
+        '<img class="emoji emoji1f602" text="_web" src="/zh_CN/htmledition/v2/images/spacer.gif" />',
+        '<span class="emoji emoji1f602"></span>',
+      ],
+      '<emoji code="emoji1f602"/>',
+    ],
+  ]
+
+  ORIGNAL_XML_LIST.forEach(([xmlList, expectedEmojiXml]) => {
+    xmlList.forEach(xml => {
+      const unifiedXml = unifyEmoji(xml)
+      t.equal(unifiedXml, expectedEmojiXml, 'should convert the emoji xml to the expected unified xml')
+    })
+  })
+})
+
+test('stripEmoji()', async t => {
+  const EMOJI_STR = [
+    [
+      'ABC<img class="emoji emoji1f4a4" text="[流汗]_web" src="/zh_CN/htmledition/v2/images/spacer.gif" />DEF',
+      'ABCDEF',
+    ],
+    [
+      'UVW<span class="emoji emoji1f334"></span>XYZ',
+      'UVWXYZ',
+    ],
+  ]
+
+  EMOJI_STR.forEach(([emojiStr, expectResult]) => {
+    const result = stripEmoji(emojiStr)
+    t.equal(result, expectResult, 'should strip to the expected str')
+  })
+
+  const empty = stripEmoji(undefined)
+  t.equal(empty, '', 'should return empty string for `undefined`')
+})

package/src/pure-functions/xml.ts

@@ -0,0 +1,98 @@
+/**
+ *   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 function stripHtml (html?: string): string {
+  if (!html) {
+    return ''
+  }
+  return html.replace(/(<([^>]+)>)/ig, '')
+}
+
+export function unescapeHtml (str?: string): string {
+  if (!str) {
+    return ''
+  }
+  return str
+    .replace(/&apos;/g, "'")
+    .replace(/&quot;/g, '"')
+    .replace(/&gt;/g, '>')
+    .replace(/&lt;/g, '<')
+    .replace(/&amp;/g, '&')
+}
+
+export function digestEmoji (html?: string): string {
+  if (!html) {
+    return ''
+  }
+  return html
+    .replace(/<img class="(\w*?emoji) (\w*?emoji[^"]+?)" text="(.*?)_web" src=[^>]+>/g,
+      '$3',
+    ) // <img class="emoji emoji1f4a4" text="[流汗]_web" src="/zh_CN/htmledition/v2/images/spacer.gif" />
+    .replace(/<span class="(\w*?emoji) (\w*?emoji[^"]+?)"><\/span>/g,
+      '[$2]',
+    ) // '<span class="emoji emoji1f334"></span>'
+}
+
+/**
+ * unifyEmoji: the same emoji will be encoded as different xml code in browser. unify them.
+ *
+ *  from: <img class="emoji emoji1f602" text="_web" src="/zh_CN/htmledition/v2/images/spacer.gif" />
+ *  to:   <span class=\"emoji emoji1f602\"></span>
+ *
+ */
+export function unifyEmoji (html?: string): string {
+  if (!html) {
+    return ''
+  }
+  return html
+    .replace(/<img class="(\w*?emoji) (\w*?emoji[^"]+?)" text="(.*?)_web" src=[^>]+>/g,
+      '<emoji code="$2"/>',
+    ) // <img class="emoji emoji1f4a4" text="[流汗]_web" src="/zh_CN/htmledition/v2/images/spacer.gif" />
+    .replace(/<span class="(\w*?emoji) (\w*?emoji[^"]+?)"><\/span>/g,
+      '<emoji code="$2"/>',
+    ) // '<span class="emoji emoji1f334"></span>'
+}
+
+export function stripEmoji (html?: string): string {
+  if (!html) {
+    return ''
+  }
+  return html
+    .replace(/<img class="(\w*?emoji) (\w*?emoji[^"]+?)" text="(.*?)_web" src=[^>]+>/g,
+      '',
+    ) // <img class="emoji emoji1f4a4" text="[流汗]_web" src="/zh_CN/htmledition/v2/images/spacer.gif" />
+    .replace(/<span class="(\w*?emoji) (\w*?emoji[^"]+?)"><\/span>/g,
+      '',
+    ) // '<span class="emoji emoji1f334"></span>'
+}
+
+export function plainText (html?: string): string {
+  if (!html) {
+    return ''
+  }
+  return stripHtml(
+    unescapeHtml(
+      stripHtml(
+        digestEmoji(
+          html,
+        ),
+      ),
+    ),
+  )
+}

package/src/raven.ts

@@ -0,0 +1,75 @@
+import type Raven from 'raven'
+
+import os from 'os'
+
+import {
+  log,
+}           from 'wechaty-puppet'
+import type { GError } from 'gerror'
+
+import {
+  VERSION,
+  GIT_COMMIT_HASH,
+}                   from './config.js'
+
+let raven: typeof Raven
+let enabled = false
+
+function getRavenDsn (): undefined | string {
+  // const RAVEN_DSN = 'https://f6770399ee65459a82af82650231b22c:d8d11b283deb441e807079b8bb2c45cd@sentry.io/179672'
+  const dsn = process.env['WECHATY_RAVEN_DSN']
+  return dsn
+}
+
+function enableRaven (dsn: string):void  {
+  /**
+   * Raven.io
+   */
+  const ravenOptions = {
+    release: VERSION,
+    tags: {
+      git_commit: GIT_COMMIT_HASH,
+      platform: process.env['WECHATY_DOCKER']
+        ? 'docker'
+        : os.platform(),
+    },
+  }
+
+  raven.disableConsoleAlerts()
+  raven
+    .config(dsn, ravenOptions)
+    .install()
+
+  enabled = true
+}
+
+async function init () {
+  try {
+    raven = await import('raven')
+    log.verbose('Wechaty', 'init() Raven enabled (import("raven") succeed)')
+  } catch (e) {
+    // It's ok when there's no raven installed
+    log.verbose('Wechaty', 'init() Raven disabled (import("raven") failed)')
+    return
+  }
+
+  const dsn = getRavenDsn()
+  if (!dsn) {
+    log.verbose('Wechaty', 'init() getRavenDsn() return undefined, skipped.')
+    return
+  }
+
+  enableRaven(dsn)
+}
+
+function wechatyCaptureException (e: GError) {
+  if (enabled) {
+    raven.captureException(e)
+  }
+}
+
+init().catch(console.error)
+
+export {
+  wechatyCaptureException,
+}

package/src/sayable/deliver-sayable.ts

@@ -0,0 +1,107 @@
+import type * as PUPPET from 'wechaty-puppet'
+import { FileBox } from 'file-box'
+
+import {
+  ContactImpl,
+  MessageImpl,
+  DelayImpl,
+  UrlLinkImpl,
+  MiniProgramImpl,
+  PostImpl,
+  LocationImpl,
+}                     from '../user-modules/mod.js'
+
+import type { Sayable } from './types.js'
+
+/**
+ * TODO: add unit test to ensure the interface validation code works
+ */
+const deliverSayableConversationPuppet = (puppet: PUPPET.impls.PuppetInterface) => (conversationId: string) => async (sayable: Sayable) => {
+  let msgId: string | void
+
+  if (typeof sayable === 'number') {
+    sayable = String(sayable)
+  }
+
+  if (typeof sayable === 'string') {
+    return puppet.messageSendText(
+      conversationId,
+      sayable,
+    )
+  }
+
+  /**
+   * Huan(202110): Checking `looseInstanceOf` is enough for the following types:
+   *  so we do not check `interfaceOfClass` anymore because it will consume more resources.
+   */
+  if (FileBox.valid(sayable)) {
+    /**
+     * 1. File
+     */
+    msgId = await puppet.messageSendFile(
+      conversationId,
+      sayable,
+    )
+  } else if (MessageImpl.validInstance(sayable)) {
+    /**
+     * 2. Message
+     */
+    msgId = await puppet.messageForward(
+      conversationId,
+      sayable.id,
+    )
+  } else if (ContactImpl.validInstance(sayable)) {
+    /**
+     * 3. Contact
+     */
+    msgId = await puppet.messageSendContact(
+      conversationId,
+      sayable.id,
+    )
+  } else if (UrlLinkImpl.validInstance(sayable)) {
+    /**
+     * 4. Link Message
+     */
+    msgId = await puppet.messageSendUrl(
+      conversationId,
+      sayable.payload,
+    )
+  } else if (MiniProgramImpl.validInstance(sayable)) {
+    /**
+     * 5. Mini Program
+     */
+    msgId = await puppet.messageSendMiniProgram(
+      conversationId,
+      sayable.payload,
+    )
+  } else if (LocationImpl.validInstance(sayable)) {
+    /**
+     * 6. Location
+     */
+    msgId = await puppet.messageSendLocation(
+      conversationId,
+      sayable.payload,
+    )
+  } else if (DelayImpl.validInstance(sayable)) {
+    /**
+     * 7. Delay for a while
+     */
+    await sayable.wait()
+  } else if (PostImpl.validInstance(sayable)) {
+    /**
+     * 8. Post
+     */
+    msgId = await puppet.messageSendPost(
+      conversationId,
+      sayable.payload,
+    )
+  } else {
+    throw new Error('unsupported arg: ' + sayable)
+  }
+
+  return msgId
+}
+
+export {
+  deliverSayableConversationPuppet,
+}