@juzi/wechaty 1.0.0

package/dist/esm/src/user-mixins/validation.spec.js

@@ -0,0 +1,54 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+import { test, } from 'tstest';
+import { validationMixin, } from './validation.js';
+test('validationMixin() valid()', async (t) => {
+    class Parent {
+        foo() { return 'foo'; }
+    }
+    class Child extends Parent {
+        bar() { return 'bar'; }
+    }
+    class UserClassImpl extends validationMixin(Child)() {
+    }
+    const FIXTURES = [
+        [new UserClassImpl(), true],
+        // Invalid things
+        [{}, false],
+        [[], false],
+        [new Map(), false],
+        // Object interface
+        [{ bar: true, foo: true }, true],
+        [{ bar: true }, false],
+        [{ foo: true }, false],
+    ];
+    for (const [input, expected] of FIXTURES) {
+        const valid = expected ? 'valid' : 'invalid';
+        /* eslint-disable multiline-ternary */
+        const type = typeof input !== 'object' ? typeof input
+            : typeof input.constructor === 'function' ? input.constructor.name
+                : 'object';
+        t.equal(UserClassImpl.valid(input), expected, `should be ${valid} for ${type} "${JSON.stringify(input)}"`);
+    }
+});
+test('validationMixin() type guard', async (t) => {
+    class Parent {
+        foo() { return 'foo'; }
+        constructor() { }
+    }
+    class Child extends Parent {
+        bar() { return 'bar'; }
+        constructor() { super(); }
+    }
+    class UserClassImpl extends validationMixin(Child)() {
+    }
+    const obj = {};
+    if (UserClassImpl.valid(obj)) {
+        const validType = true;
+        t.ok(validType, 'should be type `UserClass`');
+    }
+    else {
+        const stringType = true;
+        t.ok(stringType, 'should be type `string`');
+    }
+});
+//# sourceMappingURL=validation.spec.js.map

package/dist/esm/src/user-mixins/validation.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.spec.js","sourceRoot":"","sources":["../../../../src/user-mixins/validation.spec.ts"],"names":[],"mappings":";AACA,OAAO,EACL,IAAI,GAEL,MAAoB,QAAQ,CAAA;AAE7B,OAAO,EACL,eAAe,GAChB,MAA4B,iBAAiB,CAAA;AAE9C,IAAI,CAAC,2BAA2B,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC1C,MAAM,MAAM;QAEV,GAAG,KAAM,OAAO,KAAK,CAAA,CAAC,CAAC;KAExB;IAED,MAAM,KAAM,SAAQ,MAAM;QAExB,GAAG,KAAM,OAAO,KAAK,CAAA,CAAC,CAAC;KAExB;IAED,MAAM,aAAc,SAAQ,eAAe,CAAC,KAAK,CAAC,EAAa;KAAG;IAGlE,MAAM,QAAQ,GAAG;QACf,CAAC,IAAI,aAAa,EAAE,EAAQ,IAAI,CAAC;QACjC,iBAAiB;QACjB,CAAC,EAAE,EAAyB,KAAK,CAAC;QAClC,CAAC,EAAE,EAAyB,KAAK,CAAC;QAClC,CAAC,IAAI,GAAG,EAAE,EAAkB,KAAK,CAAC;QAClC,mBAAmB;QACnB,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,EAAG,IAAI,CAAC;QACjC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,EAAc,KAAK,CAAC;QAClC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,EAAc,KAAK,CAAC;KACnC,CAAA;IAED,KAAK,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,QAAQ,EAAE;QACxC,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAA;QAC5C,sCAAsC;QACtC,MAAM,IAAI,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,KAAK;YACnD,CAAC,CAAC,OAAO,KAAK,CAAC,WAAW,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI;gBAChE,CAAC,CAAC,QAAQ,CAAA;QAEd,CAAC,CAAC,KAAK,CACL,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,EAC1B,QAAQ,EACR,aAAa,KAAK,QAAQ,IAAI,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAC5D,CAAA;KACF;AACH,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,8BAA8B,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC7C,MAAM,MAAM;QAEV,GAAG,KAAM,OAAO,KAAK,CAAA,CAAC,CAAC;QACvB,gBAAgB,CAAC;KAElB;IAED,MAAM,KAAM,SAAQ,MAAM;QAExB,GAAG,KAAM,OAAO,KAAK,CAAA,CAAC,CAAC;QACvB,gBAAiB,KAAK,EAAE,CAAA,CAAC,CAAC;KAE3B;IAED,MAAM,aAAc,SAAQ,eAAe,CAAC,KAAK,CAAC,EAAa;KAAG;IAGlE,MAAM,GAAG,GAAuB,EAAS,CAAA;IAEzC,IAAI,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QAC5B,MAAM,SAAS,GAGX,IAAI,CAAA;QACR,CAAC,CAAC,EAAE,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAA;KAC9C;SAAM;QACL,MAAM,UAAU,GAGZ,IAAI,CAAA;QACR,CAAC,CAAC,EAAE,CAAC,UAAU,EAAE,yBAAyB,CAAC,CAAA;KAC5C;AACH,CAAC,CAAC,CAAA"}

package/dist/esm/src/user-mixins/wechatify.d.ts

@@ -0,0 +1,24 @@
+import type { Constructor } from 'clone-class';
+import type { WechatyInterface } from '../wechaty/mod.js';
+interface WechatyMinxin {
+    wechaty: WechatyInterface;
+    new (...args: any[]): {
+        get wechaty(): WechatyInterface;
+    };
+}
+declare const wechatifyUserModule: <T extends WechatyMinxin>(UserClass: T) => (wechaty: WechatyInterface) => T;
+declare const isWechatified: (klass: Function) => boolean;
+declare const wechatifyMixin: <TBase extends Constructor<{}, {}>>(Base: TBase) => ((abstract new (...args: any[]) => {
+    readonly wechaty: WechatyInterface;
+}) & {
+    readonly wechaty: WechatyInterface;
+}) & TBase;
+declare const wechatifyMixinBase: () => ((abstract new (...args: any[]) => {
+    readonly wechaty: WechatyInterface;
+}) & {
+    readonly wechaty: WechatyInterface;
+}) & {
+    new (): {};
+};
+export { isWechatified, wechatifyMixin, wechatifyMixinBase, wechatifyUserModule, };
+//# sourceMappingURL=wechatify.d.ts.map

package/dist/esm/src/user-mixins/wechatify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wechatify.d.ts","sourceRoot":"","sources":["../../../../src/user-mixins/wechatify.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAE9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAIzD,UAAU,aAAa;IACrB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG;QACpB,IAAI,OAAO,IAAK,gBAAgB,CAAA;KACjC,CAAA;CACF;AAED,QAAA,MAAM,mBAAmB,uDAGN,gBAAgB,MAgBlC,CAAA;AASD,QAAA,MAAM,aAAa,UAAW,QAAQ,YAA8C,CAAA;AAEpF,QAAA,MAAM,cAAc,+EAQM,GAAG,EAAE;;;;UAU9B,CAAA;AAED,QAAA,MAAM,kBAAkB,iCAZE,GAAG,EAAE;;;;;;CAYoC,CAAA;AAEnE,OAAO,EACL,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,mBAAmB,GACpB,CAAA"}

package/dist/esm/src/user-mixins/wechatify.js

@@ -0,0 +1,41 @@
+import { log } from 'wechaty-puppet';
+const WECHATIFIED_PREFIX = 'Wechatified';
+const wechatifyUserModule = (UserClass) => {
+    log.verbose('WechatifyMixin', 'wechatifyUserModule(%s)', UserClass.name);
+    return (wechaty) => {
+        log.verbose('WechatifyMixin', 'wechatifyUserModule(%s)(%s)', UserClass.name, wechaty);
+        class WechatifiedUserClass extends UserClass {
+            static get wechaty() { return wechaty; }
+            get wechaty() { return wechaty; }
+        }
+        Reflect.defineProperty(WechatifiedUserClass, 'name', {
+            value: WECHATIFIED_PREFIX + UserClass.name,
+        });
+        return WechatifiedUserClass;
+    };
+};
+const throwWechatifyError = (WechatyUserClass) => {
+    throw new Error([
+        `${WechatyUserClass.name}: Wechaty User Class (WUC) can not be instantiated directly!`,
+        'See: https://github.com/wechaty/wechaty/issues/1217',
+    ].join('\n'));
+};
+const isWechatified = (klass) => klass.name.startsWith(WECHATIFIED_PREFIX);
+const wechatifyMixin = (Base) => {
+    log.verbose('WechatifyMixin', 'wechatifyMixin(%s)', Base.name || '');
+    class AbstractWechatifyMixin extends Base {
+        static get wechaty() { return throwWechatifyError(this); }
+        get wechaty() { return throwWechatifyError(this.constructor); }
+        constructor(...args) {
+            super(...args);
+            if (!isWechatified(this.constructor)) {
+                throwWechatifyError(this.constructor);
+            }
+        }
+    }
+    return AbstractWechatifyMixin;
+};
+const wechatifyMixinBase = () => wechatifyMixin(class EmptyBase {
+});
+export { isWechatified, wechatifyMixin, wechatifyMixinBase, wechatifyUserModule, };
+//# sourceMappingURL=wechatify.js.map

package/dist/esm/src/user-mixins/wechatify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wechatify.js","sourceRoot":"","sources":["../../../../src/user-mixins/wechatify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAmB,gBAAgB,CAAA;AAKjD,MAAM,kBAAkB,GAAG,aAAa,CAAA;AASxC,MAAM,mBAAmB,GAAG,CAA2B,SAAY,EAAE,EAAE;IACrE,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,yBAAyB,EAAE,SAAS,CAAC,IAAI,CAAC,CAAA;IAExE,OAAO,CAAC,OAAyB,EAAK,EAAE;QACtC,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,6BAA6B,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAErF,MAAM,oBAAqB,SAAQ,SAAS;YAE1C,MAAM,KAAc,OAAO,KAAM,OAAO,OAAO,CAAA,CAAC,CAAC;YACjD,IAAa,OAAO,KAAa,OAAO,OAAO,CAAA,CAAC,CAAC;SAElD;QAED,OAAO,CAAC,cAAc,CAAC,oBAAoB,EAAE,MAAM,EAAE;YACnD,KAAK,EAAE,kBAAkB,GAAG,SAAS,CAAC,IAAI;SAC3C,CAAC,CAAA;QAEF,OAAO,oBAAoB,CAAA;IAC7B,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,mBAAmB,GAAG,CAAC,gBAA0B,EAAE,EAAE;IACzD,MAAM,IAAI,KAAK,CAAC;QACd,GAAG,gBAAgB,CAAC,IAAI,8DAA8D;QACtF,qDAAqD;KACtD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;AACf,CAAC,CAAA;AAED,MAAM,aAAa,GAAG,CAAC,KAAe,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAA;AAEpF,MAAM,cAAc,GAAG,CAA6B,IAAW,EAAE,EAAE;IACjE,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,oBAAoB,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,CAAA;IAEpE,MAAe,sBAAuB,SAAQ,IAAI;QAEhD,MAAM,KAAK,OAAO,KAAyB,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAA,CAAC,CAAC;QAC7E,IAAI,OAAO,KAAgC,OAAO,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA,CAAC,CAAC;QAEzF,YAAa,GAAG,IAAW;YACzB,KAAK,CAAC,GAAG,IAAI,CAAC,CAAA;YACd,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;gBACpC,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;aACtC;QACH,CAAC;KAEF;IAED,OAAO,sBAAsB,CAAA;AAC/B,CAAC,CAAA;AAED,MAAM,kBAAkB,GAAG,GAAG,EAAE,CAAC,cAAc,CAAC,MAAM,SAAS;CAAG,CAAC,CAAA;AAEnE,OAAO,EACL,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,mBAAmB,GACpB,CAAA"}

package/dist/esm/src/user-mixins/wechatify.spec.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+export {};
+//# sourceMappingURL=wechatify.spec.d.ts.map

package/dist/esm/src/user-mixins/wechatify.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wechatify.spec.d.ts","sourceRoot":"","sources":["../../../../src/user-mixins/wechatify.spec.ts"],"names":[],"mappings":""}

package/dist/esm/src/user-mixins/wechatify.spec.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+import { test } from 'tstest';
+import { isWechatified, wechatifyMixin, wechatifyUserModule, } from './wechatify.js';
+const wechaty = {
+    puppet: {},
+};
+test('isWechatified()', async (t) => {
+    class UserClassTest extends wechatifyMixin(Object) {
+    }
+    t.notOk(isWechatified(UserClassTest), 'should not be wechatified');
+    t.throws(() => UserClassTest.wechaty, 'should throw before wechatified');
+    const WechatifiedUserClass = wechatifyUserModule(UserClassTest)(wechaty);
+    t.ok(isWechatified(WechatifiedUserClass), 'should be wechatified');
+    t.doesNotThrow(() => WechatifiedUserClass.wechaty, 'should not throw after wechatified');
+    const user = new WechatifiedUserClass();
+    t.ok(user, 'should be able to assign with the correct typing');
+});
+//# sourceMappingURL=wechatify.spec.js.map

package/dist/esm/src/user-mixins/wechatify.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wechatify.spec.js","sourceRoot":"","sources":["../../../../src/user-mixins/wechatify.spec.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAG7B,OAAO,EACL,aAAa,EACb,cAAc,EACd,mBAAmB,GACpB,MAA4B,gBAAgB,CAAA;AAE7C,MAAM,OAAO,GAAG;IACd,MAAM,EAAE,EAAS;CACA,CAAA;AAEnB,IAAI,CAAC,iBAAiB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAEhC,MAAM,aAAc,SAAQ,cAAc,CAAC,MAAM,CAAC;KAAG;IACrD,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE,2BAA2B,CAAC,CAAA;IAClE,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,iCAAiC,CAAC,CAAA;IAExE,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAA;IACxE,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,oBAAoB,CAAC,EAAE,uBAAuB,CAAC,CAAA;IAClE,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC,OAAO,EAAE,oCAAoC,CAAC,CAAA;IAExF,MAAM,IAAI,GAAkB,IAAI,oBAAoB,EAAE,CAAA;IACtD,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,kDAAkD,CAAC,CAAA;AAChE,CAAC,CAAC,CAAA"}

package/dist/esm/src/user-modules/contact-self.d.ts

@@ -0,0 +1,110 @@
+/**
+ *   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 { FileBoxInterface } from 'file-box';
+import type { Constructor } from 'clone-class';
+import { ContactImpl } from './contact.js';
+declare const MixinBase: ((abstract new (...args: any[]) => {}) & {
+    _pool?: Map<string, ContactSelfInterface> | undefined;
+    readonly pool: Map<string, ContactSelfInterface>;
+    load<L extends import("clone-class/dist/esm/src/constructor.js").ClassInterface<{}> & {
+        new (...args: any[]): ContactSelfInterface;
+        prototype: ContactSelfInterface;
+    } & import("../user-mixins/poolify.js").PoolifyMixin<ContactSelfInterface>>(this: L, id: string): ContactSelfInterface;
+}) & typeof 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`)
+ * })
+ */
+declare class ContactSelfMixin extends MixinBase {
+    static find(query: string | PUPPET.filters.Contact): Promise<undefined | ContactSelfInterface>;
+    avatar(): Promise<FileBoxInterface>;
+    avatar(file: FileBoxInterface): Promise<void>;
+    /**
+     * 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 })
+     * })
+     */
+    qrcode(): Promise<string>;
+    /**
+     * Change bot name
+     *
+     * @param name The new name that the bot will change to
+     *
+     * @example
+     * bot.on('login', async user => {
+     *   console.log(`user ${user} login`)
+     *   const oldName = user.name()
+     *   try {
+     *     await user.name(`${oldName}-${new Date().getTime()}`)
+     *   } catch (e) {
+     *     console.error('change name failed', e)
+     *   }
+     * })
+     */
+    name(): string;
+    name(name: string): Promise<void>;
+    /**
+     * 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)
+     *   }
+     * })
+     */
+    signature(signature: string): Promise<void>;
+}
+declare const ContactSelfImpl_base: {
+    new (...args: any[]): {};
+    valid: (o: any) => o is ContactSelfInterface;
+    validInstance: (target: any) => target is ContactSelfMixin;
+    validInterface: (target: any) => target is ContactSelfInterface;
+} & typeof ContactSelfMixin;
+declare class ContactSelfImpl extends ContactSelfImpl_base {
+}
+interface ContactSelfInterface extends ContactSelfImpl {
+}
+declare type ContactSelfConstructor = Constructor<ContactSelfInterface, Omit<typeof ContactSelfImpl, 'load'>>;
+export type { ContactSelfConstructor, ContactSelfInterface, };
+export { ContactSelfImpl, };
+//# sourceMappingURL=contact-self.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"contact-self.d.ts","sourceRoot":"","sources":["../../../../src/user-modules/contact-self.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,KAAK,KAAK,MAAM,MAAM,gBAAgB,CAAA;AAI7C,OAAO,KAAK,EACV,gBAAgB,EACjB,MAAkC,UAAU,CAAA;AAE7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAQ,aAAa,CAAA;AAMhD,OAAO,EACL,WAAW,EACZ,MAA4B,cAAc,CAAA;AAI3C,QAAA,MAAM,SAAS;;;;;;;uBAEU,CAAA;AAEzB;;;;;;;;;;GAUG;AACH,cAAM,gBAAiB,SAAQ,SAAS;WAEhB,IAAI,CACxB,KAAK,EAAG,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,GACtC,OAAO,CAAC,SAAS,GAAG,oBAAoB,CAAC;IAgBtB,MAAM,IAA4B,OAAO,CAAC,gBAAgB,CAAC;IAC3D,MAAM,CAAE,IAAI,EAAE,gBAAgB,GAAI,OAAO,CAAC,IAAI,CAAC;IA4CrE;;;;;;;;;;;;;OAaG;IACU,MAAM,IAAK,OAAO,CAAC,MAAM,CAAC;IAUvC;;;;;;;;;;;;;;;OAeG;IACa,IAAI,IAAK,MAAM;IACf,IAAI,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBlD;;;;;;;;;;;;;;OAcG;IACU,SAAS,CAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAU1D;;;;;;;AAED,cAAM,eAAgB,SAAQ,oBAAyD;CAAG;AAC1F,UAAU,oBAAqB,SAAQ,eAAe;CAAG;AACzD,aAAK,sBAAsB,GAAG,WAAW,CACvC,oBAAoB,EACpB,IAAI,CAAC,OAAO,eAAe,EAAE,MAAM,CAAC,CACrC,CAAA;AAED,YAAY,EACV,sBAAsB,EACtB,oBAAoB,GACrB,CAAA;AACD,OAAO,EACL,eAAe,GAChB,CAAA"}

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

@@ -0,0 +1,130 @@
+import { log, } from 'wechaty-puppet';
+import { guardQrCodeValue, } from '../pure-functions/guard-qr-code-value.js';
+import { ContactImpl, } from './contact.js';
+import { validationMixin } from '../user-mixins/validation.js';
+import { poolifyMixin } from '../user-mixins/poolify.js';
+const MixinBase = poolifyMixin(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) {
+            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) {
+        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() {
+        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 guardQrCodeValue(qrcodeValue);
+    }
+    name(name) {
+        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) {
+        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 validationMixin(ContactSelfMixin)() {
+}
+export { ContactSelfImpl, };
+//# sourceMappingURL=contact-self.js.map

package/dist/esm/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,OAAO,EACL,GAAG,GACJ,MAAkC,gBAAgB,CAAA;AAOnD,OAAO,EACL,gBAAgB,GACjB,MAA4B,0CAA0C,CAAA;AAEvE,OAAO,EACL,WAAW,GACZ,MAA4B,cAAc,CAAA;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAExD,MAAM,SAAS,GAAG,YAAY,CAC5B,WAAW,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,GAAG,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,GAAG,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,GAAG,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,gBAAgB,CAAC,WAAW,CAAC,CAAA;IACtC,CAAC;IAqBe,IAAI,CAAE,IAAa;QACjC,GAAG,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,GAAG,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,eAAe,CAAC,gBAAgB,CAAC,EAAwB;CAAG;AAW1F,OAAO,EACL,eAAe,GAChB,CAAA"}