@juzi/wechaty-puppet-service 1.0.0

package/dist/cjs/src/client/puppet-service.d.ts

@@ -0,0 +1,161 @@
+import * as PUPPET from '@juzi/wechaty-puppet';
+import type { FileBoxInterface, FileBox } from 'file-box';
+import { Duck as PuppetDuck } from 'wechaty-redux';
+import { Ducks } from 'ducks';
+import type { Store } from 'redux';
+import { GrpcManager } from './grpc-manager.js';
+import { PayloadStore } from './payload-store.js';
+export declare type PuppetServiceOptions = PUPPET.PuppetOptions & {
+    authority?: string;
+    tls?: {
+        caCert?: string;
+        serverName?: string;
+        /**
+         * Huan(202108): only for compatible with old clients/servers
+         *  for disabling TLS
+         */
+        disable?: boolean;
+    };
+};
+declare class PuppetService extends PUPPET.Puppet {
+    options: PuppetServiceOptions;
+    static readonly VERSION: string;
+    protected _cleanupCallbackList: (() => void)[];
+    protected _payloadStore: PayloadStore;
+    /**
+     * Wechaty Redux
+     */
+    protected _ducks: Ducks<{
+        puppet: typeof PuppetDuck;
+    }>;
+    protected _store: Store;
+    protected _grpcManager?: GrpcManager;
+    get grpcManager(): GrpcManager;
+    /**
+     * UUIDify:
+     *  We need to clone a FileBox
+     *  to set uuid loader/saver with this grpc client
+     */
+    protected FileBoxUuid: typeof FileBox;
+    constructor(options?: PuppetServiceOptions);
+    protected serializeFileBox(fileBox: FileBoxInterface): Promise<string>;
+    name(): string;
+    version(): string;
+    onStart(): Promise<void>;
+    onStop(): Promise<void>;
+    protected hookPayloadStore(): void;
+    protected bridgeGrpcEventStream(client: GrpcManager): void;
+    private onGrpcStreamEvent;
+    logout(reason?: string): Promise<void>;
+    ding(data: string): void;
+    /**
+     *
+     * Huan(202111) Issue #158 - Refactoring the 'dirty' event, dirtyPayload(),
+     *  and XXXPayloadDirty() methods logic & spec
+     *
+     *    @see https://github.com/wechaty/puppet/issues/158
+     *
+     */
+    dirtyPayload(type: PUPPET.types.Dirty, id: string): Promise<void>;
+    /**
+     * `onDirty()` is called when the puppet emit `dirty` event.
+     *  the event listener will be registered in `start()` from the `PuppetAbstract` class
+     */
+    onDirty({ payloadType, payloadId, }: PUPPET.payloads.EventDirty): void;
+    /**
+     *
+     * Contact
+     *
+     */
+    contactAlias(contactId: string): Promise<string>;
+    contactAlias(contactId: string, alias: string | null): Promise<void>;
+    contactPhone(contactId: string, phoneList: string[]): Promise<void>;
+    contactCorporationRemark(contactId: string, corporationRemark: string | null): Promise<void>;
+    contactDescription(contactId: string, description: string | null): Promise<void>;
+    contactList(): Promise<string[]>;
+    contactAvatar(contactId: string): Promise<FileBoxInterface>;
+    contactAvatar(contactId: string, file: FileBoxInterface): Promise<void>;
+    contactRawPayload(id: string): Promise<PUPPET.payloads.Contact>;
+    contactRawPayloadParser(payload: PUPPET.payloads.Contact): Promise<PUPPET.payloads.Contact>;
+    contactSelfName(name: string): Promise<void>;
+    contactSelfQRCode(): Promise<string>;
+    contactSelfSignature(signature: string): Promise<void>;
+    /**
+     *
+     * Conversation
+     *
+     */
+    conversationReadMark(conversationId: string, hasRead?: boolean): Promise<void>;
+    /**
+     *
+     * Message
+     *
+     */
+    messageMiniProgram(messageId: string): Promise<PUPPET.payloads.MiniProgram>;
+    messageLocation(messageId: string): Promise<PUPPET.payloads.Location>;
+    messageImage(messageId: string, imageType: PUPPET.types.Image): Promise<FileBoxInterface>;
+    messageContact(messageId: string): Promise<string>;
+    messageSendMiniProgram(conversationId: string, miniProgramPayload: PUPPET.payloads.MiniProgram): Promise<void | string>;
+    messageSendLocation(conversationId: string, locationPayload: PUPPET.payloads.Location): Promise<void | string>;
+    messageRecall(messageId: string): Promise<boolean>;
+    messageFile(id: string): Promise<FileBoxInterface>;
+    messageForward(conversationId: string, messageId: string): Promise<string | void>;
+    messageRawPayload(id: string): Promise<PUPPET.payloads.Message>;
+    messageRawPayloadParser(payload: PUPPET.payloads.Message): Promise<PUPPET.payloads.Message>;
+    messageSendText(conversationId: string, text: string, mentionIdList?: string[]): Promise<void | string>;
+    messageSendFile(conversationId: string, fileBox: FileBoxInterface): Promise<void | string>;
+    messageSendContact(conversationId: string, contactId: string): Promise<void | string>;
+    messageSendUrl(conversationId: string, urlLinkPayload: PUPPET.payloads.UrlLink): Promise<void | string>;
+    messageUrl(messageId: string): Promise<PUPPET.payloads.UrlLink>;
+    /**
+     *
+     * Room
+     *
+     */
+    roomRawPayload(id: string): Promise<PUPPET.payloads.Room>;
+    roomRawPayloadParser(payload: PUPPET.payloads.Room): Promise<PUPPET.payloads.Room>;
+    roomList(): Promise<string[]>;
+    roomDel(roomId: string, contactId: string): Promise<void>;
+    roomAvatar(roomId: string): Promise<FileBoxInterface>;
+    roomAdd(roomId: string, contactId: string, inviteOnly: boolean): Promise<void>;
+    roomTopic(roomId: string): Promise<string>;
+    roomTopic(roomId: string, topic: string): Promise<void>;
+    roomCreate(contactIdList: string[], topic: string): Promise<string>;
+    roomQuit(roomId: string): Promise<void>;
+    roomQRCode(roomId: string): Promise<string>;
+    roomMemberList(roomId: string): Promise<string[]>;
+    roomMemberRawPayload(roomId: string, contactId: string): Promise<PUPPET.payloads.RoomMember>;
+    roomMemberRawPayloadParser(payload: PUPPET.payloads.RoomMember): Promise<PUPPET.payloads.RoomMember>;
+    roomAnnounce(roomId: string): Promise<string>;
+    roomAnnounce(roomId: string, text: string): Promise<void>;
+    roomInvitationAccept(roomInvitationId: string): Promise<void>;
+    roomInvitationRawPayload(id: string): Promise<PUPPET.payloads.RoomInvitation>;
+    roomInvitationRawPayloadParser(payload: PUPPET.payloads.RoomInvitation): Promise<PUPPET.payloads.RoomInvitation>;
+    /**
+     *
+     * Friendship
+     *
+     */
+    friendshipSearchPhone(phone: string): Promise<string | null>;
+    friendshipSearchHandle(handle: string): Promise<string | null>;
+    friendshipRawPayload(id: string): Promise<PUPPET.payloads.Friendship>;
+    friendshipRawPayloadParser(payload: PUPPET.payloads.Friendship): Promise<PUPPET.payloads.Friendship>;
+    friendshipAdd(contactId: string, options: PUPPET.types.FriendshipAddOptions): Promise<void>;
+    friendshipAccept(friendshipId: string): Promise<void>;
+    /**
+     *
+     * Tag
+     *
+     */
+    tagContactAdd(id: string, contactId: string): Promise<void>;
+    tagContactRemove(id: string, contactId: string): Promise<void>;
+    tagContactDelete(id: string): Promise<void>;
+    tagContactList(contactId?: string): Promise<string[]>;
+    /**
+     * @deprecated Will be removed in v2.0
+     */
+    private messageSendFileStream;
+}
+export { PuppetService, };
+export default PuppetService;
+//# sourceMappingURL=puppet-service.d.ts.map

package/dist/cjs/src/client/puppet-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"puppet-service.d.ts","sourceRoot":"","sources":["../../../../src/client/puppet-service.ts"],"names":[],"mappings":"AAqBA,OAAO,KAAK,MAAM,MAAa,sBAAsB,CAAA;AAErD,OAAO,KAAK,EACV,gBAAgB,EAChB,OAAO,EACR,MAA8B,UAAU,CAAA;AAKzC,OAAO,EAEL,IAAI,IAAI,UAAU,EACnB,MAA8B,eAAe,CAAA;AAC9C,OAAO,EACL,KAAK,EAEN,MAA8B,OAAO,CAAA;AACtC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAU,OAAO,CAAA;AA4BtC,OAAO,EAAE,WAAW,EAAE,MAAO,mBAAmB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEjD,oBAAY,oBAAoB,GAAG,MAAM,CAAC,aAAa,GAAG;IACxD,SAAS,CAAC,EAAI,MAAM,CAAA;IACpB,GAAG,CAAC,EAAE;QACJ,MAAM,CAAC,EAAO,MAAM,CAAA;QACpB,UAAU,CAAC,EAAG,MAAM,CAAA;QACpB;;;WAGG;QACH,OAAO,CAAC,EAAG,OAAO,CAAA;KACnB,CAAA;CACF,CAAA;AAED,cAAM,aAAc,SAAQ,MAAM,CAAC,MAAM;IA6BrB,OAAO,EAAE,oBAAoB;IA3B/C,gBAAyB,OAAO,SAAU;IAE1C,SAAS,CAAC,oBAAoB,EAAE,CAAC,MAAM,IAAI,CAAC,EAAE,CAAA;IAC9C,SAAS,CAAC,aAAa,EAAE,YAAY,CAAA;IAErC;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,OAAO,UAAU,CAAA;KAAE,CAAC,CAAA;IACtD,SAAS,CAAC,MAAM,EAAE,KAAK,CAAA;IAEvB,SAAS,CAAC,YAAY,CAAC,EAAE,WAAW,CAAA;IACpC,IAAI,WAAW,IAAK,WAAW,CAK9B;IAED;;;;OAIG;IACH,SAAS,CAAC,WAAW,EAAE,OAAO,OAAO,CAAA;gBAGnB,OAAO,GAAE,oBAAyB;cAiBpC,gBAAgB,CAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAYpE,IAAI;IAIJ,OAAO;IAID,OAAO,IAAK,OAAO,CAAC,IAAI,CAAC;IAuCzB,MAAM,IAAK,OAAO,CAAC,IAAI,CAAC;IAiBvC,SAAS,CAAC,gBAAgB,IAAK,IAAI;IAsBnC,SAAS,CAAC,qBAAqB,CAAE,MAAM,EAAE,WAAW,GAAG,IAAI;IA8B3D,OAAO,CAAC,iBAAiB;IAsGV,MAAM,CAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB7C,IAAI,CAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAgBlC;;;;;;;OAOG;IACY,YAAY,CAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,MAAM;IAkBjE;;;OAGG;IACM,OAAO,CACd,EACE,WAAW,EACX,SAAS,GACV,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU,GAC5B,IAAI;IAsBP;;;;OAIG;IACM,YAAY,CAAE,SAAS,EAAE,MAAM,GAAyB,OAAO,CAAC,MAAM,CAAC;IACvE,YAAY,CAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAsD/D,YAAY,CAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAapE,wBAAwB,CAAE,SAAS,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,IAAI;IAwB7E,kBAAkB,CAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI;IAwBjE,WAAW,IAAK,OAAO,CAAC,MAAM,EAAE,CAAC;IAWjC,aAAa,CAAE,SAAS,EAAE,MAAM,GAA6B,OAAO,CAAC,gBAAgB,CAAC;IACtF,aAAa,CAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAK,OAAO,CAAC,IAAI,CAAC;IA6D1E,iBAAiB,CAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;IAqDhE,uBAAuB,CAAE,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;IAM5F,eAAe,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY7C,iBAAiB,IAAK,OAAO,CAAC,MAAM,CAAC;IAWrC,oBAAoB,CAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYtE;;;;OAIG;IACM,oBAAoB,CAC3B,cAAc,EAAE,MAAM,EACtB,OAAO,UAAO,GACZ,OAAO,CAAC,IAAI,CAAC;IAKjB;;;;OAIG;IACY,kBAAkB,CAC/B,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC;IA2BxB,eAAe,CAC5B,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAwBrB,YAAY,CACzB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,GAC5B,OAAO,CAAC,gBAAgB,CAAC;IAyCb,cAAc,CAC3B,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC;IAeH,sBAAsB,CACnC,cAAc,EAAO,MAAM,EAC3B,kBAAkB,EAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,GAC/C,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;IA8CV,mBAAmB,CAChC,cAAc,EAAE,MAAM,EACtB,eAAe,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,GACxC,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;IA0BV,aAAa,CAC1B,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,CAAC;IAcJ,WAAW,CAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAuCnD,cAAc,CAC3B,cAAc,EAAE,MAAM,EACtB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IA8BV,iBAAiB,CAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;IA4ChE,uBAAuB,CAAE,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;IAM5F,eAAe,CAC5B,cAAc,EAAG,MAAM,EACvB,IAAI,EAAa,MAAM,EACvB,aAAa,CAAC,EAAG,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;IAiCV,eAAe,CAC5B,cAAc,EAAG,MAAM,EACvB,OAAO,EAAU,gBAAgB,GAChC,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;IA4CV,kBAAkB,CAC/B,cAAc,EAAI,MAAM,EACxB,SAAS,EAAS,MAAM,GACvB,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;IA8BV,cAAc,CAC3B,cAAc,EAAE,MAAM,EACtB,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,GACtC,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;IAuCV,UAAU,CAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;IA0B/E;;;;OAIG;IACY,cAAc,CAC3B,EAAE,EAAE,MAAM,GACT,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;IAiCjB,oBAAoB,CAAE,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;IAMnF,QAAQ,IAAK,OAAO,CAAC,MAAM,EAAE,CAAC;IAW9B,OAAO,CACpB,MAAM,EAAM,MAAM,EAClB,SAAS,EAAG,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC;IAaD,UAAU,CAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAetD,OAAO,CACpB,MAAM,EAAO,MAAM,EACnB,SAAS,EAAI,MAAM,EACnB,UAAU,EAAG,OAAO,GACnB,OAAO,CAAC,IAAI,CAAC;IAcD,SAAS,CAAE,MAAM,EAAE,MAAM,GAAmB,OAAO,CAAC,MAAM,CAAC;IAC3D,SAAS,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IAyDzD,UAAU,CACvB,aAAa,EAAG,MAAM,EAAE,EACxB,KAAK,EAAW,MAAM,GACrB,OAAO,CAAC,MAAM,CAAC;IAeH,QAAQ,CAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYxC,UAAU,CAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAc5C,cAAc,CAAE,MAAM,EAAE,MAAM,GAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAcnD,oBAAoB,CAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC;IAqC7F,0BAA0B,CAAE,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC;IAMrG,YAAY,CAAE,MAAM,EAAE,MAAM,GAAmB,OAAO,CAAC,MAAM,CAAC;IAC9D,YAAY,CAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAK,OAAO,CAAC,IAAI,CAAC;IA4D5D,oBAAoB,CACjC,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAYD,wBAAwB,CACrC,EAAE,EAAE,MAAM,GACT,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC;IA6C3B,8BAA8B,CAAE,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC;IAMhI;;;;OAIG;IACY,qBAAqB,CAClC,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IA2BV,sBAAsB,CACnC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IA+BV,oBAAoB,CAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC;IAwBtE,0BAA0B,CAAE,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU,GAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC;IAMtG,aAAa,CAC1B,SAAS,EAAG,MAAM,EAClB,OAAO,EAAK,MAAM,CAAC,KAAK,CAAC,oBAAoB,GAC5C,OAAO,CAAC,IAAI,CAAC;IAkCD,gBAAgB,CAC7B,YAAY,EAAG,MAAM,GACpB,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;OAIG;IAEY,aAAa,CAC1B,EAAE,EAAE,MAAM,EACV,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC;IAcD,gBAAgB,CAC7B,EAAE,EAAE,MAAM,EACV,SAAS,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC;IAcF,gBAAgB,CAC7B,EAAE,EAAE,MAAM,GACR,OAAO,CAAC,IAAI,CAAC;IAaF,cAAc,CAC3B,SAAS,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,EAAE,CAAC;IA0BrB;;OAEG;YACW,qBAAqB;CAkCpC;AAED,OAAO,EACL,aAAa,GACd,CAAA;AACD,eAAe,aAAa,CAAA"}