@juzi/wechaty 1.0.0

package/dist/cjs/src/user-modules/friendship.js

@@ -0,0 +1,369 @@
+"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 });
+exports.FriendshipImpl = void 0;
+/**
+ *   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 events_1 = require("events");
+const PUPPET = __importStar(require("wechaty-puppet"));
+const wechaty_puppet_1 = require("wechaty-puppet");
+const mod_js_1 = require("../pure-functions/mod.js");
+const wechatify_js_1 = require("../user-mixins/wechatify.js");
+const validation_js_1 = require("../user-mixins/validation.js");
+const MixinBase = (0, wechatify_js_1.wechatifyMixin)(events_1.EventEmitter);
+/**
+ * Send, receive friend request, and friend confirmation events.
+ *
+ * 1. send request
+ * 2. receive request(in friend event)
+ * 3. confirmation friendship(friend event)
+ *
+ * [Examples/Friend-Bot]{@link https://github.com/wechaty/wechaty/blob/1523c5e02be46ebe2cc172a744b2fbe53351540e/examples/friend-bot.ts}
+ */
+class FriendshipMixin extends MixinBase {
+    id;
+    static Type = PUPPET.types.Friendship;
+    /**
+     * @ignore
+     */
+    static load(id) {
+        const newFriendship = new this(id);
+        return newFriendship;
+    }
+    /**
+     * Search a Friend by phone or weixin.
+     *
+     * The best practice is to search friend request once per minute.
+     * Remember not to do this too frequently, or your account may be blocked.
+     *
+     * @param {FriendshipSearchCondition} condition - Search friend by phone or weixin.
+     * @returns {Promise<ContactInterface>}
+     *
+     * @example
+     * const friend_phone = await bot.Friendship.search({phone: '13112341234'})
+     * const friend_weixin = await bot.Friendship.search({weixin: 'weixin_account'})
+     *
+     * console.log(`This is the new friend info searched by phone : ${friend_phone}`)
+     * await bot.Friendship.add(friend_phone, 'hello')
+     *
+     */
+    static async search(queryFilter) {
+        wechaty_puppet_1.log.verbose('Friendship', 'static search("%s")', JSON.stringify(queryFilter));
+        const contactId = await this.wechaty.puppet.friendshipSearch(queryFilter);
+        if (!contactId) {
+            return undefined;
+        }
+        const contact = await this.wechaty.Contact.find({ id: contactId });
+        return contact;
+    }
+    /**
+     * Send a Friend Request to a `contact` with message `hello`.
+     *
+     * The best practice is to send friend request once per minute.
+     * Remeber not to do this too frequently, or your account may be blocked.
+     *
+     * @param {ContactInterface} contact - Send friend request to contact
+     * @param {FriendshipAddOptions} options - The friend request content
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const contact = await bot.Friendship.search({phone: '13112341234'})
+     * await bot.Friendship.add(contact, 'Nice to meet you! I am wechaty bot!')
+     *
+     * const memberList = await room.memberList()
+     * for (let i = 0; i < memberList.length; i++) {
+     *   await bot.Friendship.add(member, {
+     *     room: room,
+     *     hello: `Nice to meet you! I am wechaty bot from room: ${await room.topic()}!`,
+     *   })
+     * }
+     *
+     */
+    static async add(contact, options) {
+        wechaty_puppet_1.log.verbose('Friendship', 'static add(%s, %s)', contact.id, typeof options === 'string' ? options : options.hello);
+        if (typeof options === 'string') {
+            wechaty_puppet_1.log.warn('Friendship', 'the params hello is deprecated in the next version, please put the attr hello into options object, e.g. { hello: "xxxx" }');
+            await this.wechaty.puppet.friendshipAdd(contact.id, { hello: options });
+        }
+        else {
+            const friendOption = {
+                contactId: options.contact?.id,
+                hello: options.hello,
+                roomId: options.room && options.room.id,
+            };
+            await this.wechaty.puppet.friendshipAdd(contact.id, friendOption);
+        }
+    }
+    static async del(contact) {
+        wechaty_puppet_1.log.verbose('Friendship', 'static del(%s)', contact.id);
+        throw new Error('to be implemented');
+    }
+    /**
+     *
+     * Instance Properties
+     *
+     */
+    /**
+      * @ignore
+     */
+    payload;
+    /*
+     * @hideconstructor
+     */
+    constructor(id) {
+        super();
+        this.id = id;
+        wechaty_puppet_1.log.verbose('Friendship', 'constructor(id=%s)', id);
+    }
+    toString() {
+        if (!this.payload) {
+            return this.constructor.name;
+        }
+        return [
+            'Friendship#',
+            PUPPET.types.Friendship[this.payload.type],
+            '<',
+            this.payload.contactId,
+            '>',
+        ].join('');
+    }
+    isReady() {
+        return !!this.payload && (Object.keys(this.payload).length > 0);
+    }
+    /**
+     * no `dirty` support because Friendship has no rawPayload(yet)
+      * @ignore
+     */
+    async ready() {
+        if (this.isReady()) {
+            return;
+        }
+        this.payload = await this.wechaty.puppet.friendshipPayload(this.id);
+        // if (!this.#payload) {
+        //   throw new Error('no payload')
+        // }
+        await this.contact().ready();
+    }
+    /**
+     * Accept Friend Request
+     *
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const bot = new Wechaty()
+     * bot.on('friendship', async friendship => {
+     *   try {
+     *     console.log(`received friend event.`)
+     *     switch (friendship.type()) {
+     *
+     *     // 1. New Friend Request
+     *
+     *     case Friendship.Type.Receive:
+     *       await friendship.accept()
+     *       break
+     *
+     *     // 2. Friend Ship Confirmed
+     *
+     *     case Friendship.Type.Confirm:
+     *       console.log(`friend ship confirmed`)
+     *       break
+     *     }
+     *   } catch (e) {
+     *     console.error(e)
+     *   }
+     * }
+     * .start()
+     */
+    async accept() {
+        wechaty_puppet_1.log.verbose('Friendship', 'accept()');
+        if (!this.payload) {
+            throw new Error('no payload');
+        }
+        if (this.payload.type !== PUPPET.types.Friendship.Receive) {
+            throw new Error('accept() need type to be FriendshipType.Receive, but it got a ' + FriendshipImpl.Type[this.payload.type]);
+        }
+        wechaty_puppet_1.log.silly('Friendship', 'accept() to %s', this.payload.contactId);
+        await this.wechaty.puppet.friendshipAccept(this.id);
+        const contact = this.contact();
+        try {
+            const doSync = async () => {
+                await contact.ready();
+                if (!contact.isReady()) {
+                    throw new Error('Friendship.accept() contact.ready() not ready');
+                }
+                wechaty_puppet_1.log.verbose('Friendship', 'accept() with contact %s ready()', contact.name());
+            };
+            await mod_js_1.retryPolicy.execute(doSync);
+        }
+        catch (e) {
+            this.wechaty.emitError(e);
+            wechaty_puppet_1.log.warn('Friendship', 'accept() contact %s not ready because of %s', contact, (e && e.message) || e);
+            // console.error(e)
+        }
+        // try to fix issue #293 - https://github.com/wechaty/wechaty/issues/293
+        await contact.sync();
+    }
+    /**
+     * Get verify message from
+     *
+     * @returns {string}
+     * @example <caption>If request content is `ding`, then accept the friendship</caption>
+     * const bot = new Wechaty()
+     * bot.on('friendship', async friendship => {
+     *   try {
+     *     console.log(`received friend event from ${friendship.contact().name()}`)
+     *     if (friendship.type() === Friendship.Type.Receive && friendship.hello() === 'ding') {
+     *       await friendship.accept()
+     *     }
+     *   } catch (e) {
+     *     console.error(e)
+     *   }
+     * }
+     * .start()
+     */
+    hello() {
+        if (!this.payload) {
+            throw new Error('no payload');
+        }
+        return this.payload.hello || '';
+    }
+    /**
+     * Get the contact from friendship
+     *
+     * @returns {ContactInterface}
+     * @example
+     * const bot = new Wechaty()
+     * bot.on('friendship', async friendship => {
+     *   const contact = friendship.contact()
+     *   const name = contact.name()
+     *   console.log(`received friend event from ${name}`)
+     * }
+     * .start()
+     */
+    contact() {
+        if (!this.payload) {
+            throw new Error('no payload');
+        }
+        const contact = this.wechaty.Contact.load(this.payload.contactId);
+        return contact;
+    }
+    /**
+     * Return the Friendship Type
+     * > Tips: FriendshipType is enum here. </br>
+     * - FriendshipType.Unknown  </br>
+     * - FriendshipType.Confirm  </br>
+     * - FriendshipType.Receive  </br>
+     * - FriendshipType.Verify   </br>
+     *
+     * @returns {FriendshipType}
+     *
+     * @example <caption>If request content is `ding`, then accept the friendship</caption>
+     * const bot = new Wechaty()
+     * bot.on('friendship', async friendship => {
+     *   try {
+     *     if (friendship.type() === Friendship.Type.Receive && friendship.hello() === 'ding') {
+     *       await friendship.accept()
+     *     }
+     *   } catch (e) {
+     *     console.error(e)
+     *   }
+     * }
+     * .start()
+     */
+    type() {
+        return this.payload
+            ? this.payload.type
+            : PUPPET.types.Friendship.Unknown;
+    }
+    /**
+     * get friendShipPayload Json
+     * @returns {FriendshipPayload}
+     *
+     * @example
+     * const bot = new Wechaty()
+     * bot.on('friendship', async friendship => {
+     *   try {
+     *     // JSON.stringify(friendship) as well.
+     *     const payload = await friendship.toJSON()
+     *   } catch (e) {
+     *     console.error(e)
+     *   }
+     * }
+     * .start()
+     */
+    toJSON() {
+        wechaty_puppet_1.log.verbose('Friendship', 'toJSON()');
+        if (!this.isReady()) {
+            throw new Error(`Friendship<${this.id}> needs to be ready. Please call ready() before toJSON()`);
+        }
+        return JSON.stringify(this.payload);
+    }
+    /**
+     * create friendShip by friendshipJson
+     * @example
+     * const bot = new Wechaty()
+     * bot.start()
+     *
+     * const payload = '{...}'  // your saved JSON payload
+     * const friendship = bot.FriendShip.fromJSON(friendshipFromDisk)
+     * await friendship.accept()
+     */
+    static async fromJSON(payload) {
+        wechaty_puppet_1.log.verbose('Friendship', 'static fromJSON(%s)', typeof payload === 'string'
+            ? payload
+            : JSON.stringify(payload));
+        if (typeof payload === 'string') {
+            payload = JSON.parse(payload);
+        }
+        /**
+         * Set the payload back to the puppet for future use
+         */
+        await this.wechaty.puppet.friendshipPayload(payload.id, payload);
+        const instance = this.wechaty.Friendship.load(payload.id);
+        await instance.ready();
+        return instance;
+    }
+}
+class FriendshipImpl extends (0, validation_js_1.validationMixin)(FriendshipMixin)() {
+}
+exports.FriendshipImpl = FriendshipImpl;
+//# sourceMappingURL=friendship.js.map

package/dist/cjs/src/user-modules/friendship.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"friendship.js","sourceRoot":"","sources":["../../../../src/user-modules/friendship.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,mCAAyC;AACzC,uDAAiD;AACjD,mDAAiD;AAGjD,qDAEmD;AAanD,8DAE0D;AAC1D,gEAA8D;AAU9D,MAAM,SAAS,GAAG,IAAA,6BAAc,EAC9B,qBAAY,CACb,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,eAAgB,SAAQ,SAAS;IAkHnB;IAhHlB,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAA;IAErC;;OAEG;IACH,MAAM,CAAC,IAAI,CACT,EAAa;QAEb,MAAM,aAAa,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC,CAAA;QAClC,OAAO,aAAa,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,WAAuC;QAEvC,oBAAG,CAAC,OAAO,CAAC,YAAY,EAAE,qBAAqB,EAC7C,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAC5B,CAAA;QACD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAA;QAEzE,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,SAAS,CAAA;SACjB;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,CAAA;QAClE,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,KAAK,CAAC,GAAG,CACd,OAA0B,EAC1B,OAA+B;QAE/B,oBAAG,CAAC,OAAO,CAAC,YAAY,EAAE,oBAAoB,EAC5C,OAAO,CAAC,EAAE,EACV,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CACtD,CAAA;QAED,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,oBAAG,CAAC,IAAI,CAAC,YAAY,EAAE,2HAA2H,CAAC,CAAA;YACnJ,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAA;SACxE;aAAM;YACL,MAAM,YAAY,GAAsC;gBACtD,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE;gBAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,MAAM,EAAE,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;aACxC,CAAA;YACD,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,EAAE,YAAY,CAAC,CAAA;SAClE;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,GAAG,CACd,OAAyB;QAEzB,oBAAG,CAAC,OAAO,CAAC,YAAY,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,CAAC,CAAA;QACvD,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;IACtC,CAAC;IAED;;;;OAIG;IAEH;;OAEG;IACH,OAAO,CAA6B;IAEpC;;OAEG;IACH,YACkB,EAAU;QAE1B,KAAK,EAAE,CAAA;QAFS,OAAE,GAAF,EAAE,CAAQ;QAG1B,oBAAG,CAAC,OAAO,CAAC,YAAY,EAAE,oBAAoB,EAAE,EAAE,CAAC,CAAA;IACrD,CAAC;IAEQ,QAAQ;QACf,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;SAC7B;QAED,OAAO;YACL,aAAa;YACb,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YAC1C,GAAG;YACH,IAAI,CAAC,OAAO,CAAC,SAAS;YACtB,GAAG;SACJ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACZ,CAAC;IAED,OAAO;QACL,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACjE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE;YAClB,OAAM;SACP;QAED,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAEnE,wBAAwB;QACxB,kCAAkC;QAClC,IAAI;QAEJ,MAAO,IAAI,CAAC,OAAO,EAAkB,CAAC,KAAK,EAAE,CAAA;IAC/C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,MAAM;QACV,oBAAG,CAAC,OAAO,CAAC,YAAY,EAAE,UAAU,CAAC,CAAA;QAErC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAA;SAC9B;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE;YACzD,MAAM,IAAI,KAAK,CAAC,gEAAgE,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;SAC3H;QAED,oBAAG,CAAC,KAAK,CAAC,YAAY,EAAE,gBAAgB,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;QAEjE,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAEnD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAA;QAE9B,IAAI;YACF,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE;gBACxB,MAAO,OAAuB,CAAC,KAAK,EAAE,CAAA;gBACtC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE;oBACtB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;iBACjE;gBACD,oBAAG,CAAC,OAAO,CAAC,YAAY,EAAE,kCAAkC,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;YAC/E,CAAC,CAAA;YAED,MAAM,oBAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;SAElC;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;YACzB,oBAAG,CAAC,IAAI,CAAC,YAAY,EAAE,6CAA6C,EAAE,OAAO,EAAE,CAAC,CAAC,IAAK,CAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;YAChH,mBAAmB;SACpB;QAED,wEAAwE;QACxE,MAAM,OAAO,CAAC,IAAI,EAAE,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK;QACH,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAA;SAC9B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAA;IACjC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,OAAO;QACL,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAA;SAC9B;QAED,MAAM,OAAO,GAAI,IAAI,CAAC,OAAO,CAAC,OAA8B,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;QACzF,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI;QACF,OAAO,IAAI,CAAC,OAAO;YACjB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI;YACnB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAA;IACrC,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM;QACJ,oBAAG,CAAC,OAAO,CAAC,YAAY,EAAE,UAAU,CAAC,CAAA;QAErC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,cAAc,IAAI,CAAC,EAAE,0DAA0D,CAAC,CAAA;SACjG;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACrC,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,QAAQ,CACnB,OAA4C;QAE5C,oBAAG,CAAC,OAAO,CAAC,YAAY,EAAE,qBAAqB,EAC7C,OAAO,OAAO,KAAK,QAAQ;YACzB,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAC5B,CAAA;QAED,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAA+B,CAAA;SAC5D;QAED;;WAEG;QACH,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;QAEhE,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QACzD,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAA;QAEtB,OAAO,QAAQ,CAAA;IACjB,CAAC;;AAIH,MAAM,cAAe,SAAQ,IAAA,+BAAe,EAAC,eAAe,CAAC,EAAuB;CAAG;AAarF,wCAAc"}

package/dist/cjs/src/user-modules/image.d.ts

@@ -0,0 +1,31 @@
+import type { FileBoxInterface } from 'file-box';
+import type { Constructor } from 'clone-class';
+declare const ImageMixin_base: ((abstract new (...args: any[]) => {
+    readonly wechaty: import("../wechaty/wechaty-impl.js").WechatyInterface;
+}) & {
+    readonly wechaty: import("../wechaty/wechaty-impl.js").WechatyInterface;
+}) & {
+    new (): {};
+};
+declare class ImageMixin extends ImageMixin_base {
+    id: string;
+    static create(id: string): ImageInterface;
+    constructor(id: string);
+    thumbnail(): Promise<FileBoxInterface>;
+    hd(): Promise<FileBoxInterface>;
+    artwork(): Promise<FileBoxInterface>;
+}
+declare const ImageImpl_base: {
+    new (...args: any[]): {};
+    valid: (o: any) => o is ImageInterface;
+    validInstance: (target: any) => target is ImageMixin;
+    validInterface: (target: any) => target is ImageInterface;
+} & typeof ImageMixin;
+declare class ImageImpl extends ImageImpl_base {
+}
+interface ImageInterface extends ImageImpl {
+}
+declare type ImageConstructor = Constructor<ImageInterface, typeof ImageImpl>;
+export type { ImageConstructor, ImageInterface, };
+export { ImageImpl, };
+//# sourceMappingURL=image.d.ts.map

package/dist/cjs/src/user-modules/image.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../../../src/user-modules/image.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,EACV,gBAAgB,EACjB,MAAwB,UAAU,CAAA;AACnC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;;;;;;;;AAQ9C,cAAM,UAAW,SAAQ,eAAoB;IAUlC,EAAE,EAAE,MAAM;IARnB,MAAM,CAAC,MAAM,CAAE,EAAE,EAAE,MAAM,GAAG,cAAc;gBAQjC,EAAE,EAAE,MAAM;IAMb,SAAS,IAAK,OAAO,CAAC,gBAAgB,CAAC;IASvC,EAAE,IAAK,OAAO,CAAC,gBAAgB,CAAC;IAShC,OAAO,IAAK,OAAO,CAAC,gBAAgB,CAAC;CAS5C;;;;;;;AAED,cAAM,SAAU,SAAQ,cAA6C;CAAG;AACxE,UAAU,cAAe,SAAQ,SAAS;CAAI;AAE9C,aAAK,gBAAgB,GAAG,WAAW,CACjC,cAAc,EACd,OAAO,SAAS,CACjB,CAAA;AAED,YAAY,EACV,gBAAgB,EAChB,cAAc,GACf,CAAA;AACD,OAAO,EACL,SAAS,GACV,CAAA"}

package/dist/cjs/src/user-modules/image.js

@@ -0,0 +1,81 @@
+"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 });
+exports.ImageImpl = void 0;
+/**
+ *   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 PUPPET = __importStar(require("wechaty-puppet"));
+const validation_js_1 = require("../user-mixins/validation.js");
+const config_js_1 = require("../config.js");
+const wechatify_js_1 = require("../user-mixins/wechatify.js");
+class ImageMixin extends (0, wechatify_js_1.wechatifyMixinBase)() {
+    id;
+    static create(id) {
+        config_js_1.log.verbose('Image', 'static create(%s)', id);
+        const image = new this(id);
+        return image;
+    }
+    constructor(id) {
+        super();
+        this.id = id;
+        config_js_1.log.verbose('Image', 'constructor(%s)', id);
+    }
+    async thumbnail() {
+        config_js_1.log.verbose('Image', 'thumbnail() for id: "%s"', this.id);
+        const fileBox = await this.wechaty.puppet.messageImage(this.id, PUPPET.types.Image.Thumbnail);
+        return fileBox;
+    }
+    async hd() {
+        config_js_1.log.verbose('Image', 'hd() for id: "%s"', this.id);
+        const fileBox = await this.wechaty.puppet.messageImage(this.id, PUPPET.types.Image.HD);
+        return fileBox;
+    }
+    async artwork() {
+        config_js_1.log.verbose('Image', 'artwork() for id: "%s"', this.id);
+        const fileBox = await this.wechaty.puppet.messageImage(this.id, PUPPET.types.Image.Artwork);
+        return fileBox;
+    }
+}
+class ImageImpl extends (0, validation_js_1.validationMixin)(ImageMixin)() {
+}
+exports.ImageImpl = ImageImpl;
+//# sourceMappingURL=image.js.map

package/dist/cjs/src/user-modules/image.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image.js","sourceRoot":"","sources":["../../../../src/user-modules/image.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,uDAAiD;AAKjD,gEAA8D;AAC9D,4CAAkC;AAElC,8DAE0D;AAE1D,MAAM,UAAW,SAAQ,IAAA,iCAAkB,GAAE;IAUlC;IART,MAAM,CAAC,MAAM,CAAE,EAAU;QACvB,eAAG,CAAC,OAAO,CAAC,OAAO,EAAE,mBAAmB,EAAE,EAAE,CAAC,CAAA;QAE7C,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC,CAAA;QAC1B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,YACS,EAAU;QAEjB,KAAK,EAAE,CAAA;QAFA,OAAE,GAAF,EAAE,CAAQ;QAGjB,eAAG,CAAC,OAAO,CAAC,OAAO,EAAE,iBAAiB,EAAE,EAAE,CAAC,CAAA;IAC7C,CAAC;IAED,KAAK,CAAC,SAAS;QACb,eAAG,CAAC,OAAO,CAAC,OAAO,EAAE,0BAA0B,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QACzD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CACpD,IAAI,CAAC,EAAE,EACP,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAC7B,CAAA;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,KAAK,CAAC,EAAE;QACN,eAAG,CAAC,OAAO,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QAClD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CACpD,IAAI,CAAC,EAAE,EACP,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CACtB,CAAA;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,eAAG,CAAC,OAAO,CAAC,OAAO,EAAE,wBAAwB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QACvD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CACpD,IAAI,CAAC,EAAE,EACP,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAC3B,CAAA;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;CAEF;AAED,MAAM,SAAU,SAAQ,IAAA,+BAAe,EAAC,UAAU,CAAC,EAAkB;CAAG;AAatE,8BAAS"}

package/dist/cjs/src/user-modules/location.d.ts

@@ -0,0 +1,59 @@
+/**
+ *   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';
+declare const LocationMixin_base: ((abstract new (...args: any[]) => {
+    readonly wechaty: import("../wechaty/wechaty-impl.js").WechatyInterface;
+}) & {
+    readonly wechaty: import("../wechaty/wechaty-impl.js").WechatyInterface;
+}) & {
+    new (): {};
+};
+declare class LocationMixin extends LocationMixin_base {
+    readonly payload: PUPPET.payloads.Location;
+    /**
+     *
+     * 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 create(poi: string): Promise<LocationInterface>;
+    constructor(payload: PUPPET.payloads.Location);
+    toString(): string;
+    address(): string;
+    latitude(): number;
+    longitude(): number;
+    name(): string;
+    accuracy(): number;
+}
+declare const LocationImpl_base: {
+    new (...args: any[]): {};
+    valid: (o: any) => o is LocationInterface;
+    validInstance: (target: any) => target is LocationMixin;
+    validInterface: (target: any) => target is LocationInterface;
+} & typeof LocationMixin;
+declare class LocationImpl extends LocationImpl_base {
+}
+interface LocationInterface extends LocationImpl {
+}
+declare type LocationConstructor = Constructor<LocationInterface, typeof LocationImpl>;
+export type { LocationConstructor, LocationInterface, };
+export { LocationImpl, };
+//# sourceMappingURL=location.d.ts.map

package/dist/cjs/src/user-modules/location.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"location.d.ts","sourceRoot":"","sources":["../../../../src/user-modules/location.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,KAAK,KAAK,MAAM,MAAe,gBAAgB,CAAA;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;;;;;;;;AAQ9C,cAAM,aAAc,SAAQ,kBAAoB;aA0B5B,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ;IAxBnD;;;;;OAKG;WACU,MAAM,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;gBAkB3C,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ;IAQ1C,QAAQ,IAAK,MAAM;IAI5B,OAAO,IAAK,MAAM;IAIlB,QAAQ,IAAK,MAAM;IAInB,SAAS,IAAK,MAAM;IAIpB,IAAI,IAAK,MAAM;IAIf,QAAQ,IAAK,MAAM;CAIpB;;;;;;;AAED,cAAM,YAAa,SAAQ,iBAAmD;CAAG;AACjF,UAAU,iBAAkB,SAAQ,YAAY;CAAG;AAEnD,aAAK,mBAAmB,GAAG,WAAW,CACpC,iBAAiB,EACjB,OAAO,YAAY,CACpB,CAAA;AAED,YAAY,EACV,mBAAmB,EACnB,iBAAiB,GAClB,CAAA;AACD,OAAO,EACL,YAAY,GACb,CAAA"}

package/dist/cjs/src/user-modules/location.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocationImpl = void 0;
+const config_js_1 = require("../config.js");
+const validation_js_1 = require("../user-mixins/validation.js");
+const wechatify_js_1 = require("../user-mixins/wechatify.js");
+class LocationMixin extends (0, wechatify_js_1.wechatifyMixinBase)() {
+    payload;
+    /**
+     *
+     * 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) {
+        config_js_1.log.verbose('Location', 'create(%s)', poi);
+        const payload = {
+            accuracy: 15,
+            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(payload) {
+        super();
+        this.payload = payload;
+        config_js_1.log.verbose('Location', 'constructor()');
+        // Huan(202110): it is ok to create a raw one without wechaty instance
+        // guardWechatifyClass.call(this, Location)
+    }
+    toString() {
+        return `Location<${this.payload.name}>`;
+    }
+    address() {
+        return this.payload.address;
+    }
+    latitude() {
+        return this.payload.latitude;
+    }
+    longitude() {
+        return this.payload.longitude;
+    }
+    name() {
+        return this.payload.name;
+    }
+    accuracy() {
+        return this.payload.accuracy;
+    }
+}
+class LocationImpl extends (0, validation_js_1.validationMixin)(LocationMixin)() {
+}
+exports.LocationImpl = LocationImpl;
+//# sourceMappingURL=location.js.map

package/dist/cjs/src/user-modules/location.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"location.js","sourceRoot":"","sources":["../../../../src/user-modules/location.ts"],"names":[],"mappings":";;;AAqBA,4CAAkC;AAElC,gEAA+D;AAC/D,8DAE0D;AAE1D,MAAM,aAAc,SAAQ,IAAA,iCAAkB,GAAE;IA0B5B;IAxBlB;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CAAE,GAAW;QAC9B,eAAG,CAAC,OAAO,CAAC,UAAU,EAAE,YAAY,EAAE,GAAG,CAAC,CAAA;QAE1C,MAAM,OAAO,GAA6B;YACxC,QAAQ,EAAI,EAAE;YACd,OAAO,EAAK,wBAAwB;YACpC,QAAQ,EAAI,kBAAkB;YAC9B,SAAS,EAAG,UAAU;YACtB,IAAI,EAAQ,GAAG,EAAG,+CAA+C;SAClE,CAAA;QAED,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,CAAA;IAC1B,CAAC;IAED;;OAEG;IACH,YACkB,OAAiC;QAEjD,KAAK,EAAE,CAAA;QAFS,YAAO,GAAP,OAAO,CAA0B;QAGjD,eAAG,CAAC,OAAO,CAAC,UAAU,EAAE,eAAe,CAAC,CAAA;QACxC,sEAAsE;QACtE,2CAA2C;IAC7C,CAAC;IAEQ,QAAQ;QACf,OAAO,YAAY,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAA;IACzC,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAA;IAC7B,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAA;IAC9B,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAA;IAC/B,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;IAC1B,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAA;IAC9B,CAAC;CAEF;AAED,MAAM,YAAa,SAAQ,IAAA,+BAAe,EAAC,aAAa,CAAC,EAAqB;CAAG;AAa/E,oCAAY"}