@juzi/wechaty 1.0.0

package/src/user-modules/tag.ts

@@ -0,0 +1,202 @@
+/**
+ *   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 {
+  log,
+}                     from 'wechaty-puppet'
+
+import type { Constructor }  from 'clone-class'
+
+import { ContactInterface, ContactImpl }  from './contact.js'
+import { FavoriteInterface, FavoriteImpl } from './favorite.js'
+
+import {
+  poolifyMixin,
+}                     from '../user-mixins/poolify.js'
+import { validationMixin } from '../user-mixins/validation.js'
+import {
+  wechatifyMixinBase,
+}                     from '../user-mixins/wechatify.js'
+
+const MixinBase = poolifyMixin(
+  wechatifyMixinBase(),
+)<TagInterface>()
+
+class TagMixin extends MixinBase {
+
+  /**
+   * @hideconstructor
+   */
+  constructor (
+    public readonly id: string,
+  ) {
+    super()
+    log.silly('Tag', `constructor(${id})`)
+  }
+
+  /**
+   * Get a Tag instance for "tag"
+   *
+   * > Tips:
+   * This function is depending on the Puppet Implementation, see [puppet-compatible-table](https://github.com/Chatie/wechaty/wiki/Puppet#3-puppet-compatible-table)
+   *
+   * @static
+   * @param {string} [tag] the tag name which want to create
+   * @returns {Promise<TagImpl>}
+   * @example
+   * const bot = new Wechaty()
+   * await bot.Tag.get('TagName')
+   */
+  static async get (
+    tag: string,
+  ): Promise<TagInterface> {
+    log.verbose('Tag', 'get(%s)', tag)
+    return this.load(tag)
+  }
+
+  /**
+   * Delete a tag from Wechat
+   *
+   * If you want to delete a tag, please make sure there's no more Contact/Favorite(s) are using this tag.
+   * If this tag is be used by any Contact/Favorite, then it can not be deleted.
+   * (This is for protecting the tag being deleted by mistake)
+   *
+   * @static
+   * @returns {Promise<TagInterface[]>}
+   * @example
+   * const tag = wechaty.Tag.get('tag')
+   * await wechaty.Tag.delete(tag)
+   */
+
+  /**
+   * TODO: refactoring the target: do not use ContactIml or FavoriteImpl
+   */
+  static async delete (
+    tag: TagInterface,
+    target?: typeof ContactImpl | typeof FavoriteImpl,
+  ): Promise<void> {
+    log.verbose('Tag', 'static delete(%s)', tag)
+
+    /**
+     * Huan(202110) TODO: refactory this design:
+     *  1. we should not pass `typeof ContactImpl` as argument
+     *  2. find a better way to manage tag.
+     */
+
+    try {
+
+      /**
+       * TODO(huan): add tag check code here for checking if this tag is still being used.
+       */
+
+      if (!target || target === ContactImpl || target === this.wechaty.Contact) {
+        await this.wechaty.puppet.tagContactDelete(tag.id)
+      // TODO:
+      // } else if (!target || target === Favorite || target === this.wechaty.Favorite) {
+      //   await this.wechaty.puppet.tagFavoriteDelete(tag.id)
+      }
+    } catch (e) {
+      this.wechaty.emitError(e)
+      log.error('Tag', 'static delete() exception: %s', (e as Error).message)
+    }
+  }
+
+  /**
+   * Add tag for contact
+   *
+   * > Tips:
+   * This function is depending on the Puppet Implementation, see [puppet-compatible-table](https://github.com/Chatie/wechaty/wiki/Puppet#3-puppet-compatible-table)
+   *
+   * @param {ContactInterface} [to] the contact which need to add tag
+   * @returns {Promise<void>}
+   * @example
+   * await tag.add(contact)
+   */
+  async add (
+    to: ContactInterface | FavoriteInterface,
+  ): Promise<void> {
+    log.verbose('Tag', 'add(%s) for %s', to, this.id)
+
+    /**
+     * Huan(202110): TODO: refactory this design:
+     *  1. we should not pass `typeof ContactImpl` as argument
+     *  2. use instanceof to check the type of `to`
+     */
+    try {
+      if (ContactImpl.valid(to)) {
+        await this.wechaty.puppet.tagContactAdd(this.id, to.id)
+      } else if (FavoriteImpl.valid(to)) {
+        // TODO: await this.wechaty.puppet.tagAddFavorite(this.tag, to.id)
+      }
+    } catch (e) {
+      this.wechaty.emitError(e)
+      log.error('Tag', 'add() exception: %s', (e as Error).message)
+      throw new Error(`add error : ${(e as Error)}`)
+    }
+  }
+
+  /**
+   * Remove this tag from Contact/Favorite
+   *
+   * > Tips:
+   * This function is depending on the Puppet Implementation, see [puppet-compatible-table](https://github.com/Chatie/wechaty/wiki/Puppet#3-puppet-compatible-table)
+   *
+   * @returns {Promise<void>}
+   * @example
+   * await tag.remove(contact)
+   */
+  async remove (from: ContactInterface | FavoriteInterface): Promise<void> {
+    log.verbose('Tag', 'remove(%s) for %s', from, this.id)
+
+    /**
+     * Huan(202110): TODO: refactory this design:
+     *  1. we should not pass `typeof ContactImpl` as argument
+     *  2. use instanceof to check the type of `to`
+     */
+
+    try {
+      if (from instanceof ContactImpl) {
+        await this.wechaty.puppet.tagContactRemove(this.id, from.id)
+      } else if (from instanceof FavoriteImpl) {
+        // TODO await this.wechaty.puppet.tagRemoveFavorite(this.tag, from.id)
+      }
+    } catch (e) {
+      this.wechaty.emitError(e)
+      log.error('Tag', 'remove() exception: %s', (e as Error).message)
+      throw new Error(`remove error : ${e}`)
+    }
+  }
+
+}
+
+class TagImpl extends validationMixin(TagMixin)<TagInterface>() {}
+interface TagInterface extends TagImpl {}
+
+type TagConstructor = Constructor<
+  TagInterface,
+  typeof TagImpl
+>
+
+export type {
+  TagConstructor,
+  TagInterface,
+}
+export {
+  TagImpl,
+}

package/src/user-modules/url-link.spec.ts

@@ -0,0 +1,35 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+import { test } from 'tstest'
+import type { Wechaty } from '../mods/mod.js'
+import { MessageImpl } from './message.js'
+
+import { wechatifyUserModule } from './mod.js'
+import { UrlLinkImpl } from './url-link.js'
+
+const wechaty = {
+  puppet: {} as any,
+} as any as Wechaty
+
+const UrlLinkTest = wechatifyUserModule(UrlLinkImpl)(wechaty)
+
+test('UrlLink.create() for wechaty.js.org', async t => {
+  const URL = 'https://wechaty.js.org/2020/07/02/wechat-bot-in-ten-minutes'
+  const EXPECTED_PAYLOAD = {
+    description: 'Conversational RPA SDK for Chatbot Makers',
+    thumbnailUrl: 'https://wechaty.js.org/assets/contributors/luweicn/avatar.webp',
+    title: '十分钟实现一个智能问答微信聊天机器人',
+    url: 'https://wechaty.js.org/2020/07/02/wechat-bot-in-ten-minutes',
+  }
+
+  const urlLink = await UrlLinkTest.create(URL)
+  t.equal(urlLink.title(),        EXPECTED_PAYLOAD.title, 'should have title')
+  t.equal(urlLink.description(),  EXPECTED_PAYLOAD.description, 'should have description')
+  t.equal(urlLink.url(),          EXPECTED_PAYLOAD.url, 'should have url')
+  t.equal(urlLink.thumbnailUrl(), EXPECTED_PAYLOAD.thumbnailUrl, 'should have thumbnailUrl')
+})
+
+test('UrlLink.valid()', async t => {
+  const urlLink = new UrlLinkTest({} as any)
+  t.ok(UrlLinkImpl.valid(urlLink), 'should pass the validation of UrlLinkImpl')
+  t.notOk(MessageImpl.valid(urlLink), 'should not pass the validation of MessageImpl')
+})

package/src/user-modules/url-link.ts

@@ -0,0 +1,145 @@
+/**
+ *   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 Url from 'url'
+
+import type * as PUPPET     from 'wechaty-puppet'
+import type { Constructor } from 'clone-class'
+
+import { openGraph }          from '../helper-functions/open-graph.js'
+import { validationMixin }    from '../user-mixins/validation.js'
+import { wechatifyMixinBase } from '../user-mixins/wechatify.js'
+import { log } from '../config.js'
+
+class UrlLinkMixin extends wechatifyMixinBase() {
+
+  /**
+   *
+   * Create from URL
+   *
+   */
+  static async create (
+    url: string,
+    fallback?: Partial<
+      Omit<
+        PUPPET.payloads.UrlLink,
+        'url'
+      >
+    >,
+  ): Promise<UrlLinkInterface> {
+    log.verbose('UrlLink', 'create(%s)', url)
+
+    const meta = await openGraph(url)
+
+    let description  : undefined | string
+    let thumbnailUrl : undefined | string
+    let title        : string
+
+    if (meta.image) {
+      if (typeof meta.image === 'string') {
+        thumbnailUrl = meta.image
+      } else if (Array.isArray(meta.image)) {
+        thumbnailUrl = meta.image[0]
+      } else {
+        if (Array.isArray(meta.image.url)) {
+          thumbnailUrl = meta.image.url[0]
+        } else if (meta.image.url) {
+          thumbnailUrl = meta.image.url
+        }
+      }
+    }
+
+    if (Array.isArray(meta.title)) {
+      title = meta.title[0]!
+    } else {
+      title = meta.title
+    }
+
+    if (Array.isArray(meta.description)) {
+      description = meta.description[0]
+    } else if (meta.description) {
+      description = meta.description
+    } else {
+      description = title
+    }
+
+    if (thumbnailUrl && !thumbnailUrl.startsWith('http')) {
+      const resolvedUrl = new Url.URL(thumbnailUrl, url)
+      thumbnailUrl = resolvedUrl.toString()
+    }
+
+    const payload: PUPPET.payloads.UrlLink = {
+      description  : description  || fallback?.description  || '',
+      thumbnailUrl : thumbnailUrl || fallback?.thumbnailUrl || '',
+      title        : title        || fallback?.title        || '',
+      url,
+    }
+
+    return new this(payload)
+  }
+
+  /*
+   * @hideconstructor
+   */
+  constructor (
+    public readonly payload: PUPPET.payloads.UrlLink,
+  ) {
+    super()
+    log.verbose('UrlLink', 'constructor()')
+    // Huan(202110): it is ok to create a raw one without wechaty instance
+    // guardWechatifyClass.call(this, UrlLink)
+  }
+
+  override toString (): string {
+    return `UrlLink<${this.payload.url}>`
+  }
+
+  url (): string {
+    return this.payload.url
+  }
+
+  title (): string {
+    return this.payload.title
+  }
+
+  thumbnailUrl (): undefined | string {
+    return this.payload.thumbnailUrl
+  }
+
+  description (): undefined | string {
+    return this.payload.description
+  }
+
+}
+
+class UrlLinkImpl extends validationMixin(UrlLinkMixin)<UrlLinkInterface>() {}
+interface UrlLinkInterface extends UrlLinkImpl {}
+
+type UrlLinkConstructor = Constructor<
+  UrlLinkInterface,
+  typeof UrlLinkImpl
+>
+
+export type {
+  UrlLinkConstructor,
+  UrlLinkInterface,
+}
+export {
+  UrlLinkImpl,
+}

package/src/wechaty/mod.ts

@@ -0,0 +1,18 @@
+import type {
+  WechatyInterface,
+  WechatyConstructor,
+}                         from './wechaty-impl.js'
+import { WechatyImpl }    from './wechaty-impl.js'
+
+import type {
+  WechatyOptions,
+}                           from '../schemas/wechaty-options.js'
+import { WechatySkeleton }  from './wechaty-skeleton.js'
+
+export {
+  type WechatyInterface,
+  type WechatyConstructor,
+  type WechatyOptions,
+  WechatySkeleton,
+  WechatyImpl,
+}