@juzi/wechaty 1.0.0

package/src/user-modules/location.ts

@@ -0,0 +1,103 @@
+/**
+ *   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 type { Constructor } from 'clone-class'
+import { log } from '../config.js'
+
+import { validationMixin }  from '../user-mixins/validation.js'
+import {
+  wechatifyMixinBase,
+}                       from '../user-mixins/wechatify.js'
+
+class LocationMixin extends wechatifyMixinBase() {
+
+  /**
+   *
+   * Create
+   * @param poi string A point of interest (POI) is a specific point location that someone may find useful or interesting.
+   *  See: https://en.wikipedia.org/wiki/Point_of_interest
+   */
+  static async create (poi: string): Promise<LocationInterface> {
+    log.verbose('Location', 'create(%s)', poi)
+
+    const payload: PUPPET.payloads.Location = {
+      accuracy  : 15, // in meters
+      address   : '北京市北京市海淀区45 Chengfu Rd',
+      latitude  : 39.995120999999997,
+      longitude : 116.334154,
+      name      : poi,  // Huan(202109): FIXME: generate payload by poi
+    }
+
+    return new this(payload)
+  }
+
+  /*
+   * @hideconstructor
+   */
+  constructor (
+    public readonly payload: PUPPET.payloads.Location,
+  ) {
+    super()
+    log.verbose('Location', 'constructor()')
+    // Huan(202110): it is ok to create a raw one without wechaty instance
+    // guardWechatifyClass.call(this, Location)
+  }
+
+  override toString (): string {
+    return `Location<${this.payload.name}>`
+  }
+
+  address (): string {
+    return this.payload.address
+  }
+
+  latitude (): number {
+    return this.payload.latitude
+  }
+
+  longitude (): number {
+    return this.payload.longitude
+  }
+
+  name (): string {
+    return this.payload.name
+  }
+
+  accuracy (): number {
+    return this.payload.accuracy
+  }
+
+}
+
+class LocationImpl extends validationMixin(LocationMixin)<LocationInterface>() {}
+interface LocationInterface extends LocationImpl {}
+
+type LocationConstructor = Constructor<
+  LocationInterface,
+  typeof LocationImpl
+>
+
+export type {
+  LocationConstructor,
+  LocationInterface,
+}
+export {
+  LocationImpl,
+}

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

@@ -0,0 +1,124 @@
+#!/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,
+  sinon,
+}             from 'tstest'
+
+import * as PUPPET        from 'wechaty-puppet'
+import { PuppetMock }     from 'wechaty-puppet-mock'
+import { WechatyBuilder } from '../wechaty-builder.js'
+import type {
+  MessageImpl,
+  MessageProtectedProperty,
+}                           from './message.js'
+
+test('recalled()', async t => {
+
+  const EXPECTED_RECALL_MESSAGE_ID = 'message-id-1'
+  const EXPECTED_RECALLED_MESSAGE_ID = 'message-id-2'
+  const EXPECTED_MESSAGE_TIMESTAMP = new Date().getTime()
+  const EXPECTED_ROOM_TOPIC = 'topic'
+  const EXPECTED_ROOM_ID = 'room-id'
+  const EXPECTED_TALKER_CONTACT_ID = 'talker-contact-id'
+  const EXPECTED_LISTENER_CONTACT_ID = 'listener-contact-id'
+
+  const sandbox = sinon.createSandbox()
+
+  const puppet = new PuppetMock()
+  const wechaty = WechatyBuilder.build({ puppet })
+
+  await wechaty.start()
+
+  sandbox.stub(puppet, 'messagePayload').callsFake(async (id) => {
+    await new Promise(resolve => setImmediate(resolve))
+    if (id === EXPECTED_RECALL_MESSAGE_ID) {
+      return {
+        id: EXPECTED_RECALL_MESSAGE_ID,
+        talkerId: EXPECTED_TALKER_CONTACT_ID,
+        text: EXPECTED_RECALLED_MESSAGE_ID,
+        timestamp: EXPECTED_MESSAGE_TIMESTAMP,
+        type: PUPPET.types.Message.Recalled,
+      } as PUPPET.payloads.Message
+    } else {
+      return {
+        id: EXPECTED_RECALLED_MESSAGE_ID,
+        listenerId: EXPECTED_LISTENER_CONTACT_ID,
+        roomId: EXPECTED_ROOM_ID,
+        talkerId: EXPECTED_TALKER_CONTACT_ID,
+        text: '',
+        timestamp: EXPECTED_MESSAGE_TIMESTAMP,
+        type: PUPPET.types.Message.Text,
+      } as PUPPET.payloads.Message
+    }
+  })
+  sandbox.stub(puppet, 'roomPayload').callsFake(async () => {
+    await new Promise(resolve => setImmediate(resolve))
+    return {
+      topic: EXPECTED_ROOM_TOPIC,
+    } as PUPPET.payloads.Room
+  })
+
+  sandbox.stub(puppet, 'roomMemberList').callsFake(async () => {
+    await new Promise((resolve) => setImmediate(resolve))
+    return [EXPECTED_TALKER_CONTACT_ID, EXPECTED_LISTENER_CONTACT_ID]
+  })
+
+  sandbox.stub(puppet, 'contactPayload').callsFake(async (id: string) => {
+    await new Promise(setImmediate)
+    return {
+      id,
+      name: id,
+    } as PUPPET.payloads.Contact
+  })
+
+  const fakeIdSearcher = async (...args: any[]) => {
+    await new Promise(setImmediate)
+    return [args[0].id]
+  }
+
+  sandbox.stub(puppet, 'messageSearch').callsFake(fakeIdSearcher)
+  sandbox.stub(puppet, 'contactSearch').callsFake(fakeIdSearcher)
+
+  await puppet.login(EXPECTED_LISTENER_CONTACT_ID)
+
+  const message = await wechaty.Message.find({ id: EXPECTED_RECALL_MESSAGE_ID })
+  if (!message) {
+    throw new Error('no message for id: ' + EXPECTED_RECALL_MESSAGE_ID)
+  }
+  const recalledMessage = await message.toRecalled()
+  t.ok(recalledMessage, 'recalled message should exist.')
+  t.equal(recalledMessage!.id, EXPECTED_RECALLED_MESSAGE_ID, 'Recalled message should have the right id.')
+  t.equal(recalledMessage!.talker().id, EXPECTED_TALKER_CONTACT_ID, 'Recalled message should have the right from contact id.')
+  t.equal(recalledMessage!.listener()!.id, EXPECTED_LISTENER_CONTACT_ID, 'Recalled message should have the right to contact id.')
+  t.equal(recalledMessage!.room()!.id, EXPECTED_ROOM_ID, 'Recalled message should have the right room id.')
+
+  await wechaty.stop()
+})
+
+test('ProtectedProperties', async t => {
+  type NotExistInWechaty = Exclude<MessageProtectedProperty, keyof MessageImpl>
+  type NotExistTest = NotExistInWechaty extends never ? true : false
+
+  const noOneLeft: NotExistTest = true
+  t.ok(noOneLeft, 'should match Wechaty properties for every protected property')
+})