@juzi/wechaty 1.0.0

package/dist/esm/src/user-modules/contact.spec.js

@@ -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 { test, } from 'tstest';
+import { PuppetMock } from 'wechaty-puppet-mock';
+import { WechatyBuilder } from '../wechaty-builder.js';
+import { ContactImpl, } from './contact.js';
+test('findAll()', async (t) => {
+    const EXPECTED_NAME = 'TestingBot';
+    const puppet = new PuppetMock();
+    const wechaty = WechatyBuilder.build({ puppet });
+    const mockContact = puppet.mocker.createContact({ name: EXPECTED_NAME });
+    await wechaty.start();
+    await puppet.mocker.login(mockContact);
+    const contactList = await wechaty.Contact.findAll();
+    t.equal(contactList.length, 1, 'should find 1 contact');
+    t.equal(contactList[0].name(), EXPECTED_NAME, 'should get name from payload');
+    t.same(contactList[0].payload, mockContact.payload, 'should get payload from mockContact');
+    await wechaty.stop();
+});
+test('Should not be able to instanciate directly', async (t) => {
+    t.throws(() => {
+        const c = ContactImpl.load('xxx');
+        t.fail(c.name());
+    }, 'should throw when `Contact.load()`');
+    t.throws(() => {
+        const c = ContactImpl.load('xxx');
+        t.fail(c.name());
+    }, 'should throw when `Contact.load()`');
+});
+test('Should not be able to instanciate through cloneClass without puppet', async (t) => {
+    t.throws(() => {
+        const c = ContactImpl.load('xxx');
+        t.fail(c.name());
+    }, 'should throw when `MyContact.load()` without puppet');
+    t.throws(() => {
+        const c = ContactImpl.load('xxx');
+        t.fail(c.name());
+    }, 'should throw when `MyContact.load()` without puppet');
+});
+test('should throw when instanciate the global class', async (t) => {
+    t.throws(() => {
+        const c = ContactImpl.load('xxx');
+        t.fail('should not run to here');
+        t.fail(c.toString());
+    }, 'should throw when we instanciate a global class');
+});
+test('ProtectedProperties', async (t) => {
+    const noOneLeft = true;
+    t.ok(noOneLeft, 'should match Wechaty properties for every protected property');
+});
+//# sourceMappingURL=contact.spec.js.map

package/dist/esm/src/user-modules/contact.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contact.spec.js","sourceRoot":"","sources":["../../../../src/user-modules/contact.spec.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,EACL,IAAI,GACL,MAAgB,QAAQ,CAAA;AAEzB,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAEtD,OAAO,EACL,WAAW,GAEZ,MAAkC,cAAc,CAAA;AAEjD,IAAI,CAAC,WAAW,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC1B,MAAM,aAAa,GAAG,YAAY,CAAA;IAElC,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAA;IAC/B,MAAM,OAAO,GAAG,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAEhD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;IAExE,MAAM,OAAO,CAAC,KAAK,EAAE,CAAA;IACrB,MAAM,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;IAEtC,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,CAAA;IACnD,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,uBAAuB,CAAC,CAAA;IACvD,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,8BAA8B,CAAC,CAAA;IAC9E,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAE,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,qCAAqC,CAAC,CAAA;IAE3F,MAAM,OAAO,CAAC,IAAI,EAAE,CAAA;AACtB,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,4CAA4C,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC3D,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE;QACZ,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACjC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;IAClB,CAAC,EAAE,oCAAoC,CAAC,CAAA;IAExC,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE;QACZ,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACjC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;IAClB,CAAC,EAAE,oCAAoC,CAAC,CAAA;AAC1C,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,qEAAqE,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACpF,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE;QACZ,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACjC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;IAClB,CAAC,EAAE,qDAAqD,CAAC,CAAA;IAEzD,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE;QACZ,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACjC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;IAClB,CAAC,EAAE,qDAAqD,CAAC,CAAA;AAE3D,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,gDAAgD,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC/D,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE;QACZ,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACjC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAA;QAChC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;IACtB,CAAC,EAAE,iDAAiD,CAAC,CAAA;AACvD,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,qBAAqB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAIpC,MAAM,SAAS,GAAiB,IAAI,CAAA;IACpC,CAAC,CAAC,EAAE,CAAC,SAAS,EAAE,8DAA8D,CAAC,CAAA;AACjF,CAAC,CAAC,CAAA"}

package/dist/esm/src/user-modules/delay.d.ts

@@ -0,0 +1,47 @@
+/**
+ *   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 { Constructor } from 'clone-class';
+declare const DelayMixin_base: ((abstract new (...args: any[]) => {
+    readonly wechaty: import("../wechaty/wechaty-impl.js").WechatyInterface;
+}) & {
+    readonly wechaty: import("../wechaty/wechaty-impl.js").WechatyInterface;
+}) & {
+    new (): {};
+};
+declare class DelayMixin extends DelayMixin_base {
+    milliseconds: number;
+    static create(milliseconds: number): DelayInterface;
+    constructor(milliseconds: number);
+    wait(): Promise<void>;
+}
+declare const DelayImpl_base: {
+    new (...args: any[]): {};
+    valid: (o: any) => o is DelayInterface;
+    validInstance: (target: any) => target is DelayMixin;
+    validInterface: (target: any) => target is DelayInterface;
+} & typeof DelayMixin;
+declare class DelayImpl extends DelayImpl_base {
+}
+interface DelayInterface extends DelayImpl {
+}
+declare type DelayConstructor = Constructor<DelayInterface, typeof DelayImpl>;
+export type { DelayConstructor, DelayInterface, };
+export { DelayImpl, };
+//# sourceMappingURL=delay.d.ts.map

package/dist/esm/src/user-modules/delay.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"delay.d.ts","sourceRoot":"","sources":["../../../../src/user-modules/delay.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;;;;;;;;AAO9C,cAAM,UAAW,SAAQ,eAAoB;IAOlC,YAAY,EAAE,MAAM;IAL7B,MAAM,CAAC,MAAM,CAAE,YAAY,EAAE,MAAM,GAAG,cAAc;gBAK3C,YAAY,EAAE,MAAM;IAK7B,IAAI,IAAK,OAAO,CAAC,IAAI,CAAC;CAMvB;;;;;;;AAED,cAAM,SAAU,SAAQ,cAA6C;CAAG;AACxE,UAAU,cAAe,SAAQ,SAAS;CAAG;AAE7C,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/esm/src/user-modules/delay.js

@@ -0,0 +1,21 @@
+import { validationMixin } from '../user-mixins/validation.js';
+import { wechatifyMixinBase, } from '../user-mixins/wechatify.js';
+class DelayMixin extends wechatifyMixinBase() {
+    milliseconds;
+    static create(milliseconds) {
+        return new DelayImpl(milliseconds);
+    }
+    constructor(milliseconds) {
+        super();
+        this.milliseconds = milliseconds;
+    }
+    wait() {
+        return new Promise(resolve => {
+            setTimeout(resolve, this.milliseconds);
+        });
+    }
+}
+class DelayImpl extends validationMixin(DelayMixin)() {
+}
+export { DelayImpl, };
+//# sourceMappingURL=delay.js.map

package/dist/esm/src/user-modules/delay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delay.js","sourceRoot":"","sources":["../../../../src/user-modules/delay.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAE9D,OAAO,EACL,kBAAkB,GACnB,MAA4B,6BAA6B,CAAA;AAE1D,MAAM,UAAW,SAAQ,kBAAkB,EAAE;IAOlC;IALT,MAAM,CAAC,MAAM,CAAE,YAAoB;QACjC,OAAO,IAAI,SAAS,CAAC,YAAY,CAAC,CAAA;IACpC,CAAC;IAED,YACS,YAAoB;QAE3B,KAAK,EAAE,CAAA;QAFA,iBAAY,GAAZ,YAAY,CAAQ;IAG7B,CAAC;IAED,IAAI;QACF,OAAO,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE;YACjC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAA;QACxC,CAAC,CAAC,CAAA;IACJ,CAAC;CAEF;AAED,MAAM,SAAU,SAAQ,eAAe,CAAC,UAAU,CAAC,EAAkB;CAAG;AAYxE,OAAO,EACL,SAAS,GACV,CAAA"}

package/dist/esm/src/user-modules/favorite.d.ts

@@ -0,0 +1,38 @@
+import type { Constructor } from 'clone-class';
+import type { TagInterface } from './tag.js';
+declare const FavoriteMixin_base: ((abstract new (...args: any[]) => {
+    readonly wechaty: import("../wechaty/wechaty-impl.js").WechatyInterface;
+}) & {
+    readonly wechaty: import("../wechaty/wechaty-impl.js").WechatyInterface;
+}) & {
+    new (): {};
+};
+declare class FavoriteMixin extends FavoriteMixin_base {
+    static list(): FavoriteInterface[];
+    /**
+     * Get tags for all favorites
+     *
+     * @static
+     * @returns {Promise<TagInterface[]>}
+     * @example
+     * const tags = await wechaty.Favorite.tags()
+     */
+    static tags(): Promise<TagInterface[]>;
+    constructor();
+    tags(): Promise<TagInterface[]>;
+    findAll(): Promise<void>;
+}
+declare const FavoriteImpl_base: {
+    new (...args: any[]): {};
+    valid: (o: any) => o is FavoriteInterface;
+    validInstance: (target: any) => target is FavoriteMixin;
+    validInterface: (target: any) => target is FavoriteInterface;
+} & typeof FavoriteMixin;
+declare class FavoriteImpl extends FavoriteImpl_base {
+}
+interface FavoriteInterface extends FavoriteImpl {
+}
+declare type FavoriteConstructor = Constructor<FavoriteInterface, typeof FavoriteImpl>;
+export type { FavoriteConstructor, FavoriteInterface, };
+export { FavoriteImpl, };
+//# sourceMappingURL=favorite.d.ts.map

package/dist/esm/src/user-modules/favorite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"favorite.d.ts","sourceRoot":"","sources":["../../../../src/user-modules/favorite.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAM9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;;;;;;;;AAE5C,cAAM,aAAc,SAAQ,kBAAoB;IAE9C,MAAM,CAAC,IAAI,IAAK,iBAAiB,EAAE;IAInC;;;;;;;OAOG;WACU,IAAI,IAAK,OAAO,CAAC,YAAY,EAAE,CAAC;;IAsBvC,IAAI,IAAK,OAAO,CAAC,YAAY,EAAE,CAAC;IAKhC,OAAO;CAId;;;;;;;AAED,cAAM,YAAa,SAAQ,iBAAmD;CAAG;AACjF,UAAU,iBAAkB,SAAQ,YAAY;CAAG;AACnD,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/esm/src/user-modules/favorite.js

@@ -0,0 +1,65 @@
+/**
+ *   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 { validationMixin } from '../user-mixins/validation.js';
+import { wechatifyMixinBase, } from '../user-mixins/wechatify.js';
+class FavoriteMixin extends wechatifyMixinBase() {
+    static list() {
+        return [];
+    }
+    /**
+     * Get tags for all favorites
+     *
+     * @static
+     * @returns {Promise<TagInterface[]>}
+     * @example
+     * const tags = await wechaty.Favorite.tags()
+     */
+    static async tags() {
+        log.verbose('Favorite', 'static tags() for %s', this);
+        // TODO:
+        // try {
+        //   const tagIdList = await this.puppet.tagFavoriteList()
+        //   const tagList = tagIdList.map(id => this.wechaty.Tag.load(id))
+        //   return tagList
+        // } catch (e) {
+        //   log.error('Favorite', 'static tags() exception: %s', e.message)
+        //   return []
+        // }
+        return [];
+    }
+    /*
+     * @hideconstructor
+     */
+    constructor() {
+        super();
+    }
+    async tags() {
+        // TODO: implmente this method
+        return [];
+    }
+    async findAll() {
+        //
+    }
+}
+class FavoriteImpl extends validationMixin(FavoriteMixin)() {
+}
+export { FavoriteImpl, };
+//# sourceMappingURL=favorite.js.map

package/dist/esm/src/user-modules/favorite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"favorite.js","sourceRoot":"","sources":["../../../../src/user-modules/favorite.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,EAAE,GAAG,EAAE,MAAa,gBAAgB,CAAA;AAE3C,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAE9D,OAAO,EACL,kBAAkB,GACnB,MAA4B,6BAA6B,CAAA;AAG1D,MAAM,aAAc,SAAQ,kBAAkB,EAAE;IAE9C,MAAM,CAAC,IAAI;QACT,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI;QACf,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,sBAAsB,EAAE,IAAI,CAAC,CAAA;QAErD,QAAQ;QACR,QAAQ;QACR,0DAA0D;QAC1D,mEAAmE;QACnE,mBAAmB;QACnB,gBAAgB;QAChB,oEAAoE;QACpE,cAAc;QACd,IAAI;QACJ,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;OAEG;IACH;QACE,KAAK,EAAE,CAAA;IACT,CAAC;IAED,KAAK,CAAC,IAAI;QACR,8BAA8B;QAC9B,OAAO,EAAE,CAAA;IACX,CAAC;IAED,KAAK,CAAC,OAAO;QACX,EAAE;IACJ,CAAC;CAEF;AAED,MAAM,YAAa,SAAQ,eAAe,CAAC,aAAa,CAAC,EAAqB;CAAG;AAWjF,OAAO,EACL,YAAY,GACb,CAAA"}

package/dist/esm/src/user-modules/friendship.d.ts

@@ -0,0 +1,244 @@
+/// <reference types="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 { EventEmitter } from 'events';
+import * as PUPPET from 'wechaty-puppet';
+import type { Constructor } from 'clone-class';
+import type { Accepter } from '../schemas/acceptable.js';
+import type { ContactInterface } from './contact.js';
+import type { RoomInterface } from './room.js';
+interface FriendshipAddOptionsObject {
+    room?: RoomInterface;
+    contact?: ContactInterface;
+    hello?: string;
+}
+declare type FriendshipAddOptions = string | FriendshipAddOptionsObject;
+declare const MixinBase: ((abstract new (...args: any[]) => {
+    readonly wechaty: import("../wechaty/wechaty-impl.js").WechatyInterface;
+}) & {
+    readonly wechaty: import("../wechaty/wechaty-impl.js").WechatyInterface;
+}) & typeof 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}
+ */
+declare class FriendshipMixin extends MixinBase implements Accepter {
+    readonly id: string;
+    static Type: typeof PUPPET.types.Friendship;
+    /**
+     * @ignore
+     */
+    static load(id: string): FriendshipInterface;
+    /**
+     * 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 search(queryFilter: PUPPET.filters.Friendship): Promise<undefined | ContactInterface>;
+    /**
+     * 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 add(contact: ContactInterface, options: FriendshipAddOptions): Promise<void>;
+    static del(contact: ContactInterface): Promise<void>;
+    /**
+     *
+     * Instance Properties
+     *
+     */
+    /**
+      * @ignore
+     */
+    payload?: PUPPET.payloads.Friendship;
+    constructor(id: string);
+    toString(): string;
+    isReady(): boolean;
+    /**
+     * no `dirty` support because Friendship has no rawPayload(yet)
+      * @ignore
+     */
+    ready(): Promise<void>;
+    /**
+     * 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()
+     */
+    accept(): Promise<void>;
+    /**
+     * 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(): string;
+    /**
+     * 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(): ContactInterface;
+    /**
+     * 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(): PUPPET.types.Friendship;
+    /**
+     * 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(): string;
+    /**
+     * 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 fromJSON(payload: string | PUPPET.payloads.Friendship): Promise<FriendshipInterface>;
+}
+declare const FriendshipImpl_base: {
+    new (...args: any[]): {};
+    valid: (o: any) => o is FriendshipInterface;
+    validInstance: (target: any) => target is FriendshipMixin;
+    validInterface: (target: any) => target is FriendshipInterface;
+} & typeof FriendshipMixin;
+declare class FriendshipImpl extends FriendshipImpl_base {
+}
+interface FriendshipInterface extends FriendshipImpl {
+}
+declare type FriendshipConstructor = Constructor<FriendshipInterface, typeof FriendshipImpl>;
+export type { FriendshipConstructor, FriendshipInterface, };
+export { FriendshipImpl, };
+//# sourceMappingURL=friendship.d.ts.map

package/dist/esm/src/user-modules/friendship.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"friendship.d.ts","sourceRoot":"","sources":["../../../../src/user-modules/friendship.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,EAAE,YAAY,EAAE,MAAU,QAAQ,CAAA;AACzC,OAAO,KAAK,MAAM,MAAe,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAM9C,OAAO,KAAK,EACV,QAAQ,EACT,MAAwB,0BAA0B,CAAA;AAEnD,OAAO,KAAK,EACV,gBAAgB,EAEjB,MAA4B,cAAc,CAAA;AAC3C,OAAO,KAAK,EACV,aAAa,EACd,MAA4B,WAAW,CAAA;AAMxC,UAAU,0BAA0B;IAClC,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,aAAK,oBAAoB,GAAG,MAAM,GAAG,0BAA0B,CAAA;AAE/D,QAAA,MAAM,SAAS;;;;wBAEd,CAAA;AAED;;;;;;;;GAQG;AACH,cAAM,eAAgB,SAAQ,SAAU,YAAW,QAAQ;aAkHvC,EAAE,EAAE,MAAM;IAhH5B,MAAM,CAAC,IAAI,iCAA0B;IAErC;;OAEG;IACH,MAAM,CAAC,IAAI,CACT,EAAE,EAAK,MAAM,GACZ,mBAAmB;IAKtB;;;;;;;;;;;;;;;;OAgBG;WACU,MAAM,CACjB,WAAW,EAAG,MAAM,CAAC,OAAO,CAAC,UAAU,GACtC,OAAO,CAAC,SAAS,GAAG,gBAAgB,CAAC;IAcxC;;;;;;;;;;;;;;;;;;;;;;OAsBG;WACU,GAAG,CACd,OAAO,EAAG,gBAAgB,EAC1B,OAAO,EAAI,oBAAoB,GAC9B,OAAO,CAAC,IAAI,CAAC;WAmBH,GAAG,CACd,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;OAIG;IAEH;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAA;gBAMlB,EAAE,EAAE,MAAM;IAMnB,QAAQ;IAcjB,OAAO,IAAK,OAAO;IAInB;;;OAGG;IACG,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;IAc7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,MAAM,IAAK,OAAO,CAAC,IAAI,CAAC;IAsC9B;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,IAAK,MAAM;IAOhB;;;;;;;;;;;;OAYG;IACH,OAAO,IAAK,gBAAgB;IAS5B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,IAAK,MAAM,CAAC,KAAK,CAAC,UAAU;IAMhC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,IAAK,MAAM;IASjB;;;;;;;;;OASG;WACU,QAAQ,CACnB,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,GAC3C,OAAO,CAAC,mBAAmB,CAAC;CAsBhC;;;;;;;AAED,cAAM,cAAe,SAAQ,mBAAuD;CAAG;AACvF,UAAU,mBAAoB,SAAQ,cAAc;CAAG;AAEvD,aAAK,qBAAqB,GAAG,WAAW,CACtC,mBAAmB,EACnB,OAAO,cAAc,CACtB,CAAA;AAED,YAAY,EACV,qBAAqB,EACrB,mBAAmB,GACpB,CAAA;AACD,OAAO,EACL,cAAc,GACf,CAAA"}