@juzi/wechaty 1.0.0

package/dist/cjs/src/user-modules/contact-self.js

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContactSelfImpl = void 0;
+const wechaty_puppet_1 = require("wechaty-puppet");
+const guard_qr_code_value_js_1 = require("../pure-functions/guard-qr-code-value.js");
+const contact_js_1 = require("./contact.js");
+const validation_js_1 = require("../user-mixins/validation.js");
+const poolify_js_1 = require("../user-mixins/poolify.js");
+const MixinBase = (0, poolify_js_1.poolifyMixin)(contact_js_1.ContactImpl)();
+/**
+ * Bot itself will be encapsulated as a ContactSelf.
+ *
+ * > Tips: this class is extends Contact
+ * @example
+ * const bot = new Wechaty()
+ * await bot.start()
+ * bot.on('login', (user: ContactSelf) => {
+ *   console.log(`user ${user} login`)
+ * })
+ */
+class ContactSelfMixin extends MixinBase {
+    static async find(query) {
+        if (!this.wechaty.isLoggedIn) {
+            return undefined;
+        }
+        try {
+            const contact = await super.find(query);
+            if (contact && contact.id === this.wechaty.puppet.currentUserId) {
+                return contact;
+            }
+        }
+        catch (e) {
+            wechaty_puppet_1.log.silly('ContactSelf', 'find() exception: %s', e.message);
+        }
+        return undefined;
+    }
+    /**
+     * GET / SET bot avatar
+     *
+     * @param {FileBox} [file]
+     * @returns {(Promise<void | FileBox>)}
+     *
+     * @example <caption> GET the avatar for bot, return {Promise<FileBox>}</caption>
+     * // Save avatar to local file like `1-name.jpg`
+     *
+     * bot.on('login', (user: ContactSelf) => {
+     *   console.log(`user ${user} login`)
+     *   const file = await user.avatar()
+     *   const name = file.name
+     *   await file.toFile(name, true)
+     *   console.log(`Save bot avatar: ${contact.name()} with avatar file: ${name}`)
+     * })
+     *
+     * @example <caption>SET the avatar for a bot</caption>
+     * import { FileBox }  from 'wechaty'
+     * bot.on('login', (user: ContactSelf) => {
+     *   console.log(`user ${user} login`)
+     *   const fileBox = FileBox.fromUrl('https://wechaty.github.io/wechaty/images/bot-qr-code.png')
+     *   await user.avatar(fileBox)
+     *   console.log(`Change bot avatar successfully!`)
+     * })
+     *
+     */
+    async avatar(file) {
+        wechaty_puppet_1.log.verbose('Contact', 'avatar(%s)', file ? file.name : '');
+        if (!file) {
+            const filebox = await super.avatar();
+            return filebox;
+        }
+        if (this.id !== this.wechaty.puppet.currentUserId) {
+            throw new Error('set avatar only available for user self');
+        }
+        await this.wechaty.puppet.contactAvatar(this.id, file);
+    }
+    /**
+     * Get bot qrcode
+     *
+     * @returns {Promise<string>}
+     *
+     * @example
+     * import { generate } from 'qrcode-terminal'
+     * bot.on('login', (user: ContactSelf) => {
+     *   console.log(`user ${user} login`)
+     *   const qrcode = await user.qrcode()
+     *   console.log(`Following is the bot qrcode!`)
+     *   generate(qrcode, { small: true })
+     * })
+     */
+    async qrcode() {
+        wechaty_puppet_1.log.verbose('Contact', 'qrcode()');
+        if (this.id !== this.wechaty.puppet.currentUserId) {
+            throw new Error('only can get qrcode for the currentUser');
+        }
+        const qrcodeValue = await this.wechaty.puppet.contactSelfQRCode();
+        return (0, guard_qr_code_value_js_1.guardQrCodeValue)(qrcodeValue);
+    }
+    name(name) {
+        wechaty_puppet_1.log.verbose('ContactSelf', 'name(%s)', name || '');
+        if (typeof name === 'undefined') {
+            return super.name();
+        }
+        if (this.id !== this.wechaty.puppet.currentUserId) {
+            throw new Error('only can set name for user self');
+        }
+        return this.wechaty.puppet.contactSelfName(name).then(this.sync.bind(this));
+    }
+    /**
+     * Change bot signature
+     *
+     * @param signature The new signature that the bot will change to
+     *
+     * @example
+     * bot.on('login', async user => {
+     *   console.log(`user ${user} login`)
+     *   try {
+     *     await user.signature(`Signature changed by wechaty on ${new Date()}`)
+     *   } catch (e) {
+     *     console.error('change signature failed', e)
+     *   }
+     * })
+     */
+    async signature(signature) {
+        wechaty_puppet_1.log.verbose('ContactSelf', 'signature()');
+        if (this.id !== this.wechaty.puppet.currentUserId) {
+            throw new Error('only can change signature for user self');
+        }
+        return this.wechaty.puppet.contactSelfSignature(signature).then(this.sync.bind(this));
+    }
+}
+class ContactSelfImpl extends (0, validation_js_1.validationMixin)(ContactSelfMixin)() {
+}
+exports.ContactSelfImpl = ContactSelfImpl;
+//# sourceMappingURL=contact-self.js.map

package/dist/cjs/src/user-modules/contact-self.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contact-self.js","sourceRoot":"","sources":["../../../../src/user-modules/contact-self.ts"],"names":[],"mappings":";;;AAoBA,mDAEmD;AAOnD,qFAEuE;AAEvE,6CAE2C;AAC3C,gEAA8D;AAC9D,0DAAwD;AAExD,MAAM,SAAS,GAAG,IAAA,yBAAY,EAC5B,wBAAW,CACZ,EAAwB,CAAA;AAEzB;;;;;;;;;;GAUG;AACH,MAAM,gBAAiB,SAAQ,SAAS;IAEtC,MAAM,CAAU,KAAK,CAAC,IAAI,CACxB,KAAuC;QAEvC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YAC5B,OAAO,SAAS,CAAA;SACjB;QAED,IAAI;YACF,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACvC,IAAI,OAAO,IAAI,OAAO,CAAC,EAAE,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE;gBAC/D,OAAO,OAA+B,CAAA;aACvC;SACF;QAAC,OAAO,CAAC,EAAE;YACV,oBAAG,CAAC,KAAK,CAAC,aAAa,EAAE,sBAAsB,EAAG,CAAW,CAAC,OAAO,CAAC,CAAA;SACvE;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAKD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACa,KAAK,CAAC,MAAM,CAAE,IAAuB;QACnD,oBAAG,CAAC,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;QAE3D,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE,CAAA;YACpC,OAAO,OAAO,CAAA;SACf;QAED,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE;YACjD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;SAC3D;QAED,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;IACxD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,MAAM;QACjB,oBAAG,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;QAClC,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE;YACjD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;SAC3D;QAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAA;QACjE,OAAO,IAAA,yCAAgB,EAAC,WAAW,CAAC,CAAA;IACtC,CAAC;IAqBe,IAAI,CAAE,IAAa;QACjC,oBAAG,CAAC,OAAO,CAAC,aAAa,EAAE,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,CAAA;QAElD,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;YAC/B,OAAO,KAAK,CAAC,IAAI,EAAE,CAAA;SACpB;QAED,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE;YACjD,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;SACnD;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IAC7E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,SAAS,CAAE,SAAiB;QACvC,oBAAG,CAAC,OAAO,CAAC,aAAa,EAAE,aAAa,CAAC,CAAA;QAEzC,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE;YACjD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;SAC3D;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IACvF,CAAC;CAEF;AAED,MAAM,eAAgB,SAAQ,IAAA,+BAAe,EAAC,gBAAgB,CAAC,EAAwB;CAAG;AAYxF,0CAAe"}

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

@@ -0,0 +1,388 @@
+/**
+ *   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 * as PUPPET from 'wechaty-puppet';
+import type { FileBoxInterface } from 'file-box';
+import type { Constructor } from 'clone-class';
+import type { SayableSayer, Sayable } from '../sayable/mod.js';
+import type { MessageInterface } from './message.js';
+import type { TagInterface } from './tag.js';
+declare const MixinBase: ((abstract new (...args: any[]) => {
+    readonly wechaty: import("../wechaty/wechaty-impl.js").WechatyInterface;
+}) & {
+    readonly wechaty: import("../wechaty/wechaty-impl.js").WechatyInterface;
+}) & ((abstract new (...args: any[]) => {}) & {
+    _pool?: Map<string, ContactImplInterface> | undefined;
+    readonly pool: Map<string, ContactImplInterface>;
+    load<L extends import("clone-class/dist/esm/src/constructor.js").ClassInterface<{}> & {
+        new (...args: any[]): ContactImplInterface;
+        prototype: ContactImplInterface;
+    } & import("../user-mixins/poolify.js").PoolifyMixin<ContactImplInterface>>(this: L, id: string): ContactImplInterface;
+}) & (new () => import("typed-emitter").default<import("../schemas/contact-events.js").ContactEventListeners>);
+/**
+ * All wechat contacts(friend) will be encapsulated as a Contact.
+ * [Examples/Contact-Bot]{@link https://github.com/wechaty/wechaty/blob/1523c5e02be46ebe2cc172a744b2fbe53351540e/examples/contact-bot.ts}
+ *
+ * @property {string}  id               - Get Contact id.
+ * This function is depending on the Puppet Implementation, see [puppet-compatible-table](https://github.com/wechaty/wechaty/wiki/Puppet#3-puppet-compatible-table)
+ */
+declare class ContactMixin extends MixinBase implements SayableSayer {
+    readonly id: string;
+    static Type: typeof PUPPET.types.Contact;
+    static Gender: typeof PUPPET.types.ContactGender;
+    /**
+     * The way to search Contact
+     *
+     * @typedef    ContactQueryFilter
+     * @property   {string} name    - The name-string set by user-self, should be called name
+     * @property   {string} alias   - The name-string set by bot for others, should be called alias
+     * [More Detail]{@link https://github.com/wechaty/wechaty/issues/365}
+     */
+    /**
+     * Try to find a contact by filter: {name: string | RegExp} / {alias: string | RegExp}
+     *
+     * Find contact by name or alias, if the result more than one, return the first one.
+     *
+     * @static
+     * @param {string | ContactQueryFilter} query `string` will search `name` & `alias`
+     * @returns {(Promise<undefined | ContactInterface>)} If can find the contact, return Contact, or return null
+     * @example
+     * const bot = new Wechaty()
+     * await bot.start()
+     * const contactFindByName = await bot.Contact.find({ name:"ruirui"} )
+     * const contactFindByAlias = await bot.Contact.find({ alias:"lijiarui"} )
+     */
+    static find(query: string | PUPPET.filters.Contact): Promise<undefined | ContactInterface>;
+    /**
+     * Find contact by `name` or `alias`
+     *
+     * If use Contact.findAll() get the contact list of the bot.
+     *
+     * #### definition
+     * - `name`   the name-string set by user-self, should be called name
+     * - `alias`  the name-string set by bot for others, should be called alias
+     *
+     * @static
+     * @param {string | ContactQueryFilter} [queryArg] `string` will search `name` & `alias`
+     * @returns {Promise<ContactInterface[]>}
+     * @example
+     * const bot = new Wechaty()
+     * await bot.start()
+     * const contactList = await bot.Contact.findAll()                      // get the contact list of the bot
+     * const contactList = await bot.Contact.findAll({ name: 'ruirui' })    // find all of the contacts whose name is 'ruirui'
+     * const contactList = await bot.Contact.findAll({ alias: 'lijiarui' }) // find all of the contacts whose alias is 'lijiarui'
+     */
+    static findAll(query?: string | PUPPET.filters.Contact): Promise<ContactInterface[]>;
+    static delete(contact: ContactInterface): Promise<void>;
+    /**
+     * Get tags for all contact
+     *
+     * @static
+     * @returns {Promise<TagInterface[]>}
+     * @example
+     * const tags = await wechaty.Contact.tags()
+     */
+    static tags(): Promise<TagInterface[]>;
+    /**
+     *
+     * Instance properties
+     * @ignore
+     *
+     */
+    payload?: PUPPET.payloads.Contact;
+    /**
+     * @hideconstructor
+     */
+    constructor(id: string);
+    /**
+     * @ignore
+     */
+    toString(): string;
+    /**
+     * > Tips:
+     * This function is depending on the Puppet Implementation, see [puppet-compatible-table](https://github.com/wechaty/wechaty/wiki/Puppet#3-puppet-compatible-table)
+     *
+     * @param {(string | ContactInterface | FileBox | UrlLink | MiniProgram | Location)} sayable
+     * send text, Contact, or file to contact. </br>
+     * You can use {@link https://www.npmjs.com/package/file-box|FileBox} to send file
+     * @returns {Promise<void | MessageInterface>}
+     * @example
+     * const bot = new Wechaty()
+     * await bot.start()
+     * const contact = await bot.Contact.find({name: 'lijiarui'})  // change 'lijiarui' to any of your contact name in wechat
+     *
+     * // 1. send text to contact
+     *
+     * await contact.say('welcome to wechaty!')
+     * const msg = await contact.say('welcome to wechaty!') // only supported by puppet-padplus
+     *
+     * // 2. send media file to contact
+     *
+     * import { FileBox }  from 'wechaty'
+     * const fileBox1 = FileBox.fromUrl('https://wechaty.github.io/wechaty/images/bot-qr-code.png')
+     * const fileBox2 = FileBox.fromFile('/tmp/text.txt')
+     * await contact.say(fileBox1)
+     * const msg1 = await contact.say(fileBox1) // only supported by puppet-padplus
+     * await contact.say(fileBox2)
+     * const msg2 = await contact.say(fileBox2) // only supported by puppet-padplus
+     *
+     * // 3. send contact card to contact
+     *
+     * const contactCard = bot.Contact.load('contactId')
+     * const msg = await contact.say(contactCard) // only supported by puppet-padplus
+     *
+     * // 4. send url link to contact
+     *
+     * const urlLink = new UrlLink ({
+     *   description : 'WeChat Bot SDK for Individual Account, Powered by TypeScript, Docker, and Love',
+     *   thumbnailUrl: 'https://avatars0.githubusercontent.com/u/25162437?s=200&v=4',
+     *   title       : 'Welcome to Wechaty',
+     *   url         : 'https://github.com/wechaty/wechaty',
+     * })
+     * await contact.say(urlLink)
+     * const msg = await contact.say(urlLink) // only supported by puppet-padplus
+     *
+     * // 5. send mini program to contact
+     *
+     * const miniProgram = new MiniProgram ({
+     *   username           : 'gh_xxxxxxx',     //get from mp.weixin.qq.com
+     *   appid              : '',               //optional, get from mp.weixin.qq.com
+     *   title              : '',               //optional
+     *   pagepath           : '',               //optional
+     *   description        : '',               //optional
+     *   thumbnailurl       : '',               //optional
+     * })
+     * await contact.say(miniProgram)
+     * const msg = await contact.say(miniProgram) // only supported by puppet-padplus
+     *
+     * // 6. send location to contact
+     * const location = new Location ({
+     *   accuracy  : 15,
+     *   address   : '北京市北京市海淀区45 Chengfu Rd',
+     *   latitude  : 39.995120999999997,
+     *   longitude : 116.334154,
+     *   name      : '东升乡人民政府(海淀区成府路45号)',
+     * })
+     * await contact.say(location)
+     * const msg = await contact.say(location)
+     */
+    say(sayable: Sayable): Promise<void | MessageInterface>;
+    /**
+     * Get the name from a contact
+     *
+     * @returns {string}
+     * @example
+     * const name = contact.name()
+     */
+    name(): string;
+    alias(): Promise<undefined | string>;
+    alias(newAlias: string): Promise<void>;
+    alias(empty: null): Promise<void>;
+    /**
+     * GET / SET / DELETE the phone list for a contact
+     *
+     * @param {(none | string[])} phoneList
+     * @returns {(Promise<string[] | void>)}
+     * @example <caption> GET the phone list for a contact, return {(Promise<string[]>)}</caption>
+     * const phoneList = await contact.phone()
+     * if (phone.length === 0) {
+     *   console.log('You have not yet set any phone number for contact ' + contact.name())
+     * } else {
+     *   console.log('You have already set phone numbers for contact ' + contact.name() + ':' + phoneList.join(','))
+     * }
+     *
+     * @example <caption>SET the phoneList for a contact</caption>
+     * try {
+     *   const phoneList = ['13999999999', '13888888888']
+     *   await contact.alias(phoneList)
+     *   console.log(`change ${contact.name()}'s phone successfully!`)
+     * } catch (e) {
+     *   console.log(`failed to change ${contact.name()} phone!`)
+     * }
+     */
+    phone(): Promise<string[]>;
+    phone(phoneList: string[]): Promise<void>;
+    corporation(): Promise<undefined | string>;
+    corporation(remark: string | null): Promise<void>;
+    description(): Promise<undefined | string>;
+    description(newDescription: string | null): Promise<void>;
+    title(): string | null;
+    coworker(): boolean;
+    /**
+     * Check if contact is friend
+     *
+     * > Tips:
+     * This function is depending on the Puppet Implementation, see [puppet-compatible-table](https://github.com/wechaty/wechaty/wiki/Puppet#3-puppet-compatible-table)
+     *
+     * @returns {boolean | null}
+     *
+     * <br>True for friend of the bot <br>
+     * False for not friend of the bot, null for unknown.
+     * @example
+     * const isFriend = contact.friend()
+     */
+    friend(): undefined | boolean;
+    /**
+     * Enum for ContactType
+     * @enum {number}
+     * @property {number} Unknown    - ContactType.Unknown    (0) for Unknown
+     * @property {number} Personal   - ContactType.Personal   (1) for Personal
+     * @property {number} Official   - ContactType.Official   (2) for Official
+     */
+    /**
+     * Return the type of the Contact
+     * > Tips: ContactType is enum here.</br>
+     * @returns {ContactType.Unknown | ContactType.Personal | ContactType.Official}
+     *
+     * @example
+     * const bot = new Wechaty()
+     * await bot.start()
+     * const isOfficial = contact.type() === bot.Contact.Type.Official
+     */
+    type(): PUPPET.types.Contact;
+    /**
+     * @ignore
+     * TODO: Check if the contact is star contact.
+     *
+     * @returns {boolean | null} - True for star friend, False for no star friend.
+     * @example
+     * const isStar = contact.star()
+     */
+    star(): undefined | boolean;
+    /**
+     * Contact gender
+     * > Tips: ContactGender is enum here. </br>
+     *
+     * @returns {ContactGender.Unknown | ContactGender.Male | ContactGender.Female}
+     * @example
+     * const gender = contact.gender() === bot.Contact.Gender.Male
+     */
+    gender(): PUPPET.types.ContactGender;
+    /**
+     * Get the region 'province' from a contact
+     *
+     * @returns {string | null}
+     * @example
+     * const province = contact.province()
+     */
+    province(): undefined | string;
+    /**
+     * Get the region 'city' from a contact
+     *
+     * @returns {string | null}
+     * @example
+     * const city = contact.city()
+     */
+    city(): undefined | string;
+    /**
+     * Get avatar picture file stream
+     *
+     * @returns {Promise<FileBox>}
+     * @example
+     * // Save avatar to local file like `1-name.jpg`
+     *
+     * const file = await contact.avatar()
+     * const name = file.name
+     * await file.toFile(name, true)
+     * console.log(`Contact: ${contact.name()} with avatar file: ${name}`)
+     */
+    avatar(): Promise<FileBoxInterface>;
+    /**
+     * Get all tags of contact
+     *
+     * @returns {Promise<TagInterface[]>}
+     * @example
+     * const tags = await contact.tags()
+     */
+    tags(): Promise<TagInterface[]>;
+    /**
+     * Force reload data for Contact, Sync data from low-level API again.
+     *
+     * @returns {Promise<this>}
+     * @example
+     * await contact.sync()
+     */
+    sync(): Promise<void>;
+    /**
+     * `ready()` is For FrameWork ONLY!
+     *
+     * Please not to use `ready()` at the user land.
+     * If you want to sync data, use `sync()` instead.
+     *
+     * @ignore
+     */
+    ready(forceSync?: boolean): Promise<void>;
+    readMark(hasRead: boolean): Promise<void>;
+    readMark(): Promise<boolean>;
+    /**
+     * @ignore
+     */
+    isReady(): boolean;
+    /**
+     * Check if contact is self
+     *
+     * @returns {boolean} True for contact is self, False for contact is others
+     * @example
+     * const isSelf = contact.self()
+     */
+    self(): boolean;
+    /**
+     * Get the handle from a contact.
+     *
+     * > A Twitter handle is the username that appears at the end of your unique Twitter URL.
+     *
+     * Sometimes cannot get handle due to the puppet implementation.
+     *
+     * @ignore
+     * @returns {string | null}
+     * @example
+     * const handle = contact.handle()
+     */
+    handle(): undefined | string;
+    /**
+     * Huan(202203): `weixin()` will be removed in v2.0
+     *  @link https://github.com/wechaty/puppet/issues/181
+     * @deprecated use `handle()` instead
+     */
+    weixin(): undefined | string;
+}
+declare const ContactImplBase_base: {
+    new (...args: any[]): {};
+    valid: (o: any) => o is ContactImplInterface;
+    validInstance: (target: any) => target is ContactMixin;
+    validInterface: (target: any) => target is ContactImplInterface;
+} & typeof ContactMixin;
+declare class ContactImplBase extends ContactImplBase_base {
+}
+interface ContactImplInterface extends ContactImplBase {
+}
+declare type ContactProtectedProperty = 'ready';
+declare type ContactInterface = Omit<ContactImplInterface, ContactProtectedProperty>;
+declare const ContactImpl_base: {
+    new (...args: any[]): {};
+    valid: (o: any) => o is ContactInterface;
+    validInstance: (target: any) => target is ContactImplBase;
+    validInterface: (target: any) => target is ContactInterface;
+} & typeof ContactImplBase;
+declare class ContactImpl extends ContactImpl_base {
+}
+declare type ContactConstructor = Constructor<ContactImplInterface, Omit<typeof ContactImpl, 'load'>>;
+export type { ContactConstructor, ContactProtectedProperty, ContactInterface, };
+export { ContactImpl, };
+//# sourceMappingURL=contact.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"contact.d.ts","sourceRoot":"","sources":["../../../../src/user-modules/contact.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,KAAK,MAAM,MAAW,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EACV,gBAAgB,EACjB,MAA4B,UAAU,CAAA;AAIvC,OAAO,KAAK,EACV,WAAW,EACZ,MAA4B,aAAa,CAAA;AAgB1C,OAAO,KAAK,EACV,YAAY,EACZ,OAAO,EACR,MAA0C,mBAAmB,CAAA;AAG9D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAO,cAAc,CAAA;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAW,UAAU,CAAA;AAGjD,QAAA,MAAM,SAAS;;;;;;;;;;;8GAId,CAAA;AAED;;;;;;GAMG;AACH,cAAM,YAAa,SAAQ,SAAU,YAAW,YAAY;aA+KxC,EAAE,EAAE,MAAM;IA7K5B,MAAM,CAAC,IAAI,8BAAyB;IACpC,MAAM,CAAC,MAAM,oCAA6B;IAE1C;;;;;;;OAOG;IAEH;;;;;;;;;;;;;OAaG;WACU,IAAI,CACf,KAAK,EAAG,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,GACtC,OAAO,CAAC,SAAS,GAAG,gBAAgB,CAAC;IAqDxC;;;;;;;;;;;;;;;;;;OAkBG;WACU,OAAO,CAClB,KAAK,CAAC,EAAG,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,GACvC,OAAO,CAAC,gBAAgB,EAAE,CAAC;WAiCjB,MAAM,CAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9D;;;;;;;OAOG;WACU,IAAI,IAAK,OAAO,CAAC,YAAY,EAAE,CAAC;IAc7C;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAA;IAEjC;;OAEG;gBAEe,EAAE,EAAE,MAAM;IAM5B;;OAEG;IACM,QAAQ,IAAK,MAAM;IAa5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmEG;IACG,GAAG,CACP,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,IAAI,GAAG,gBAAgB,CAAC;IAanC;;;;;;OAMG;IACH,IAAI,IAAK,MAAM;IAIT,KAAK,IAAuB,OAAO,CAAC,SAAS,GAAG,MAAM,CAAC;IACvD,KAAK,CAAE,QAAQ,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IACzC,KAAK,CAAE,KAAK,EAAM,IAAI,GAAM,OAAO,CAAC,IAAI,CAAC;IAiE/C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,KAAK,IAAK,OAAO,CAAC,MAAM,EAAE,CAAC;IAC3B,KAAK,CAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAsB1C,WAAW,IAAK,OAAO,CAAC,SAAS,GAAG,MAAM,CAAC;IAC3C,WAAW,CAAE,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BlD,WAAW,IAAK,OAAO,CAAC,SAAS,GAAG,MAAM,CAAC;IAC3C,WAAW,CAAE,cAAc,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBhE,KAAK,IAAK,MAAM,GAAG,IAAI;IAQvB,QAAQ,IAAK,OAAO;IAQpB;;;;;;;;;;;;OAYG;IACH,MAAM,IAAK,SAAS,GAAG,OAAO;IAK9B;;;;;;OAMG;IAEH;;;;;;;;;OASG;IACH,IAAI,IAAK,MAAM,CAAC,KAAK,CAAC,OAAO;IAO7B;;;;;;;OAOG;IACH,IAAI,IAAK,SAAS,GAAG,OAAO;IAI5B;;;;;;;OAOG;IACH,MAAM,IAAK,MAAM,CAAC,KAAK,CAAC,aAAa;IAMrC;;;;;;OAMG;IACH,QAAQ,IAAK,SAAS,GAAG,MAAM;IAI/B;;;;;;OAMG;IACH,IAAI,IAAK,SAAS,GAAG,MAAM;IAI3B;;;;;;;;;;;OAWG;IACG,MAAM,IAAK,OAAO,CAAC,gBAAgB,CAAC;IAO1C;;;;;;OAMG;IACG,IAAI,IAAK,OAAO,CAAC,YAAY,EAAE,CAAC;IActC;;;;;;OAMG;IACG,IAAI,IAAK,OAAO,CAAC,IAAI,CAAC;IAK5B;;;;;;;OAOG;IACG,KAAK,CACT,SAAS,UAAQ,GAChB,OAAO,CAAC,IAAI,CAAC;IAsBV,QAAQ,CAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAC1C,QAAQ,IAAK,OAAO,CAAC,OAAO,CAAC;IAyBnC;;OAEG;IACH,OAAO,IAAK,OAAO;IAInB;;;;;;OAMG;IACH,IAAI,IAAK,OAAO;IAIhB;;;;;;;;;;;OAWG;IACH,MAAM,IAAK,SAAS,GAAG,MAAM;IAI7B;;;;OAIG;IACH,MAAM,IAAK,SAAS,GAAG,MAAM;CAM9B;;;;;;;AAED,cAAM,eAAgB,SAAQ,oBAAqD;CAAG;AACtF,UAAU,oBAAqB,SAAQ,eAAe;CAAG;AAEzD,aAAK,wBAAwB,GACzB,OAAO,CAAA;AAEX,aAAK,gBAAgB,GAAG,IAAI,CAAC,oBAAoB,EAAE,wBAAwB,CAAC,CAAA;;;;;;;AAC5E,cAAM,WAAY,SAAQ,gBAAoD;CAAG;AAEjF,aAAK,kBAAkB,GAAG,WAAW,CACnC,oBAAoB,EACpB,IAAI,CAAC,OAAO,WAAW,EAAE,MAAM,CAAC,CACjC,CAAA;AAED,YAAY,EACV,kBAAkB,EAClB,wBAAwB,EACxB,gBAAgB,GACjB,CAAA;AACD,OAAO,EACL,WAAW,GACZ,CAAA"}