@juzi/wechaty-puppet-service 1.0.43 → 1.0.45

package/dist/esm/src/client/puppet-service.js

@@ -25,11 +25,6 @@ import { Ducks,
 // Bundle,
  } from 'ducks';
 // import type { Subscription }  from 'rxjs'
-/**
- * Deprecated. Will be removed after Dec 31, 2022
- */
-import { packConversationIdFileBoxToPb, unpackFileBoxFromPb, } from '../deprecated/mod.js';
-import { serializeFileBox } from '../deprecated/serialize-file-box.js';
 import { millisecondsFromTimestamp } from '../pure-functions/timestamp.js';
 import { uuidifyFileBoxGrpc, normalizeFileBoxUuid, } from '../file-box-helper/mod.js';
 import { envVars, log, NO_LOG_EVENTS, VERSION, } from '../config.js';
@@ -37,7 +32,7 @@ import { EventTypeRev, } from '../event-type-rev.js';
 import { packageJson } from '../package-json.js';
 import { GrpcManager } from './grpc-manager.js';
 import { PayloadStore } from './payload-store.js';
-import { channelPayloadToPb, channelPbToPayload, urlLinkPayloadToPb, urlLinkPbToPayload } from '../utils/pb-payload-helper.js';
+import { channelPayloadToPb, channelPbToPayload, postPayloadToPb, urlLinkPbToPayload } from '../utils/pb-payload-helper.js';
 class PuppetService extends PUPPET.Puppet {
     options;
     static VERSION = VERSION;
@@ -441,12 +436,6 @@ class PuppetService extends PUPPET.Puppet {
             request.setId(contactId);
             const serializedFileBox = await this.serializeFileBox(fileBox);
             request.setFileBox(serializedFileBox);
-            {
-                // DEPRECATED, will be removed after Dec 31, 2022
-                const fileboxWrapper = new StringValue();
-                fileboxWrapper.setValue(await serializeFileBox(fileBox));
-                request.setFileboxStringValueDeprecated(fileboxWrapper);
-            }
             await util.promisify(this.grpcManager.client.contactAvatar
                 .bind(this.grpcManager.client))(request);
             return;
@@ -532,58 +521,58 @@ class PuppetService extends PUPPET.Puppet {
         if (payload.id) {
             throw new Error('cannot modify contactId');
         }
-        if (payload.gender) {
+        if (typeof payload.gender !== 'undefined') {
             request.setGender(payload.gender);
         }
-        if (payload.type) {
+        if (typeof payload.type !== 'undefined') {
             request.setType(payload.type);
         }
-        if (payload.name) {
+        if (typeof payload.name !== 'undefined') {
             request.setName(payload.name);
         }
-        if (payload.avatar) {
+        if (typeof payload.avatar !== 'undefined') {
             request.setAvatar(payload.avatar);
         }
-        if (payload.address) {
+        if (typeof payload.address !== 'undefined') {
             request.setAddress(payload.address);
         }
-        if (payload.alias) {
+        if (typeof payload.alias !== 'undefined') {
             request.setAlias(payload.alias);
         }
-        if (payload.city) {
+        if (typeof payload.city !== 'undefined') {
             request.setCity(payload.city);
         }
-        if (payload.friend) {
+        if (typeof payload.friend !== 'undefined') {
             request.setFriend(payload.friend);
         }
-        if (payload.province) {
+        if (typeof payload.province !== 'undefined') {
             request.setProvince(payload.province);
         }
-        if (payload.star) {
+        if (typeof payload.star !== 'undefined') {
             request.setStar(payload.star);
         }
-        if (payload.weixin) {
+        if (typeof payload.weixin !== 'undefined') {
             request.setWeixin(payload.weixin);
         }
-        if (payload.corporation) {
+        if (typeof payload.corporation !== 'undefined') {
             request.setCorporation(payload.corporation);
         }
-        if (payload.title) {
+        if (typeof payload.title !== 'undefined') {
             request.setTitle(payload.title);
         }
-        if (payload.description) {
+        if (typeof payload.description !== 'undefined') {
             request.setDescription(payload.description);
         }
-        if (payload.coworker) {
+        if (typeof payload.coworker !== 'undefined') {
             request.setCoworker(payload.coworker);
         }
-        if (payload.phone) {
+        if (typeof payload.phone !== 'undefined') {
             request.setPhonesList(payload.phone);
         }
-        if (payload.additionalInfo) {
+        if (typeof payload.additionalInfo !== 'undefined') {
             request.setAdditionalInfo(payload.additionalInfo);
         }
-        if (payload.tags) {
+        if (typeof payload.tags !== 'undefined') {
             request.setTagIdsList(payload.tags);
         }
         await util.promisify(this.grpcManager.client.contactPayloadModify
@@ -671,31 +660,16 @@ class PuppetService extends PUPPET.Puppet {
     }
     async messageImage(messageId, imageType) {
         log.verbose('PuppetService', 'messageImage(%s, %s[%s])', messageId, imageType, PUPPET.types.Image[imageType]);
-        try {
-            const request = new grpcPuppet.MessageImageRequest();
-            request.setId(messageId);
-            request.setType(imageType);
-            const response = await util.promisify(this.grpcManager.client.messageImage
-                .bind(this.grpcManager.client))(request);
-            const jsonText = response.getFileBox();
-            if (jsonText) {
-                return this.FileBoxUuid.fromJSON(jsonText);
-            }
-        }
-        catch (e) {
-            log.verbose('PuppetService', 'messageImage() rejection %s', e.message);
-        }
-        {
-            // Deprecated. Will be removed after Dec 31, 2022
-            const request = new grpcPuppet.MessageImageStreamRequest();
-            request.setId(messageId);
-            request.setType(imageType);
-            const pbStream = this.grpcManager.client.messageImageStream(request);
-            const fileBox = await unpackFileBoxFromPb(pbStream);
-            // const fileBoxChunkStream = unpackFileBoxChunk(stream)
-            // return unpackFileBox(fileBoxChunkStream)
-            return fileBox;
+        const request = new grpcPuppet.MessageImageRequest();
+        request.setId(messageId);
+        request.setType(imageType);
+        const response = await util.promisify(this.grpcManager.client.messageImage
+            .bind(this.grpcManager.client))(request);
+        const jsonText = response.getFileBox();
+        if (jsonText) {
+            return this.FileBoxUuid.fromJSON(jsonText);
         }
+        throw new Error(`failed to get image filebox for message ${messageId}`);
     }
     async messageContact(messageId) {
         log.verbose('PuppetService', 'messageContact(%s)', messageId);
@@ -815,36 +789,15 @@ class PuppetService extends PUPPET.Puppet {
     }
     async messageFile(id) {
         log.verbose('PuppetService', 'messageFile(%s)', id);
-        try {
-            const request = new grpcPuppet.MessageFileRequest();
-            request.setId(id);
-            const response = await util.promisify(this.grpcManager.client.messageFile
-                .bind(this.grpcManager.client))(request);
-            const jsonText = response.getFileBox();
-            if (jsonText) {
-                return this.FileBoxUuid.fromJSON(jsonText);
-            }
-        }
-        catch (e) {
-            log.warn('PuppetService', 'messageFile() rejection: %s', e.message);
-            log.warn('PuppetService', [
-                'This might because you are using Wechaty v1.x with a Puppet Service v0.x',
-                'Contact your Wechaty Puppet Service provided to report this problem',
-                'Related issues:',
-                ' - https://github.com/wechaty/puppet-service/issues/179',
-                ' - https://github.com/wechaty/puppet-service/pull/170',
-            ].join('\n'));
-        }
-        {
-            // Deprecated. `MessageFileStream` Will be removed after Dec 31, 2022
-            const request = new grpcPuppet.MessageFileStreamRequest();
-            request.setId(id);
-            const pbStream = this.grpcManager.client.messageFileStream(request);
-            // const fileBoxChunkStream = unpackFileBoxChunk(pbStream)
-            // return unpackFileBox(fileBoxChunkStream)
-            const fileBox = await unpackFileBoxFromPb(pbStream);
-            return fileBox;
+        const request = new grpcPuppet.MessageFileRequest();
+        request.setId(id);
+        const response = await util.promisify(this.grpcManager.client.messageFile
+            .bind(this.grpcManager.client))(request);
+        const jsonText = response.getFileBox();
+        if (jsonText) {
+            return this.FileBoxUuid.fromJSON(jsonText);
         }
+        throw new Error(`failed to get filebox for message ${id}`);
     }
     async messagePreview(id) {
         log.verbose('PuppetService', 'messagePreview(%s)', id);
@@ -963,40 +916,27 @@ class PuppetService extends PUPPET.Puppet {
     }
     async messageSendFile(conversationId, fileBox) {
         log.verbose('PuppetService', 'messageSendFile(%s, %s)', conversationId, fileBox);
-        try {
-            const request = new grpcPuppet.MessageSendFileRequest();
-            request.setConversationId(conversationId);
-            const serializedFileBox = await this.serializeFileBox(fileBox);
-            request.setFileBox(serializedFileBox);
-            log.info('PuppetService', `messageSendFile(${conversationId}, ${fileBox}) about to call grpc`);
-            const response = await util.promisify(this.grpcManager.client.messageSendFile
-                .bind(this.grpcManager.client))(request);
-            const messageId = response.getId();
-            log.info('PuppetService', `messageSendFile(${conversationId}, ${fileBox}) grpc called, messageId: ${messageId}`);
-            if (messageId) {
-                return messageId;
-            }
-            else {
-                /**
-                 * Huan(202110): Deprecated: will be removed after Dec 31, 2022
-                 */
-                const messageIdWrapper = response.getIdStringValueDeprecated();
-                if (messageIdWrapper) {
-                    return messageIdWrapper.getValue();
-                }
-            }
-            return; // void
+        const request = new grpcPuppet.MessageSendFileRequest();
+        request.setConversationId(conversationId);
+        const serializedFileBox = await this.serializeFileBox(fileBox);
+        request.setFileBox(serializedFileBox);
+        log.info('PuppetService', `messageSendFile(${conversationId}, ${fileBox}) about to call grpc`);
+        const response = await util.promisify(this.grpcManager.client.messageSendFile
+            .bind(this.grpcManager.client))(request);
+        const messageId = response.getId();
+        log.info('PuppetService', `messageSendFile(${conversationId}, ${fileBox}) grpc called, messageId: ${messageId}`);
+        if (messageId) {
+            return messageId;
         }
-        catch (e) {
-            log.verbose('PuppetService', 'messageSendFile() rejection: %s', e.message);
+        else {
+            /**
+             * Huan(202110): Deprecated: will be removed after Dec 31, 2022
+             */
+            const messageIdWrapper = response.getIdStringValueDeprecated();
+            if (messageIdWrapper) {
+                return messageIdWrapper.getValue();
+            }
         }
-        /**
-         * Huan(202110): Deprecated: will be removed after Dec 31, 2022
-         *  The old server will not support `Upload` gRPC method,
-         *  which I'm expecting the above code will throw a exception,
-         *  then the below code will be executed.
-         */
-        return this.messageSendFileStream(conversationId, fileBox);
     }
     async messageSendContact(conversationId, contactId) {
         log.verbose('PuppetService', 'messageSend("%s", %s)', conversationId, contactId);
@@ -1074,6 +1014,28 @@ class PuppetService extends PUPPET.Puppet {
         };
         return payload;
     }
+    async getMessageBroadcastTarget() {
+        log.verbose('PuppetService', 'getMessageBroadcastTarget()');
+        const request = new grpcPuppet.GetMessageBroadcastTargetRequest();
+        const response = await util.promisify(this.grpcManager.client.getMessageBroadcastTarget.bind(this.grpcManager.client))(request);
+        return {
+            contactIds: response.getContactIdsList(),
+            roomIds: response.getRoomIdsList(),
+        };
+    }
+    async createMessageBroadcast(targets, type, content) {
+        log.verbose('PuppetService', 'createMessageBroadcast()');
+        if (!PUPPET.payloads.isPostClient(content)) {
+            throw new Error('can only create broadcast with client post');
+        }
+        const request = new grpcPuppet.CreateMessageBroadcastRequest();
+        const post = await postPayloadToPb(grpcPuppet, content, this.serializeFileBox.bind(this));
+        request.setContent(post);
+        request.setTargetIdsList(targets);
+        request.setType(type);
+        const response = await util.promisify(this.grpcManager.client.createMessageBroadcast.bind(this.grpcManager.client))(request);
+        return response.getId();
+    }
     /**
      *
      * Room
@@ -1617,57 +1579,7 @@ class PuppetService extends PUPPET.Puppet {
             throw new Error('can only publish client post now');
         }
         const request = new grpcPuppet.MomentPublishRequest();
-        const post = new grpcPuppet.PostPayloadClient();
-        post.setType(grpcPuppet.PostType.POST_TYPE_MOMENT);
-        for (const item of payload.sayableList) {
-            const sayable = new grpcPuppet.PostSayable();
-            switch (item.type) {
-                case PUPPET.types.Sayable.Text:
-                    sayable.setType(grpcPuppet.SayableType.SAYABLE_TYPE_TEXT);
-                    sayable.setText(item.payload.text);
-                    sayable.setMentionIdListList(item.payload.mentions);
-                    break;
-                case PUPPET.types.Sayable.Attachment: {
-                    sayable.setType(grpcPuppet.SayableType.SAYABLE_TYPE_FILE);
-                    const serializedFileBox = typeof item.payload.filebox === 'string' ? item.payload.filebox : await this.serializeFileBox(item.payload.filebox);
-                    sayable.setFileBox(serializedFileBox);
-                    break;
-                }
-                case PUPPET.types.Sayable.Url: {
-                    sayable.setType(grpcPuppet.SayableType.SAYABLE_TYPE_URL);
-                    const urlLinkPayload = item.payload;
-                    const pbUrlLinkPayload = urlLinkPayloadToPb(grpcPuppet, urlLinkPayload);
-                    sayable.setUrlLink(pbUrlLinkPayload);
-                    break;
-                }
-                case PUPPET.types.Sayable.Channel: {
-                    sayable.setType(grpcPuppet.SayableType.SAYABLE_TYPE_CHANNEL);
-                    const channelPayload = item.payload;
-                    const pbChannelPayload = channelPayloadToPb(grpcPuppet, channelPayload);
-                    sayable.setChannel(pbChannelPayload);
-                    break;
-                }
-                default:
-                    throw new Error(`postPublish unsupported type ${item.type}`);
-            }
-            post.addSayableList(sayable);
-        }
-        if (payload.rootId) {
-            post.setRootId(payload.rootId);
-        }
-        if (payload.parentId) {
-            post.setParentId(payload.parentId);
-        }
-        if (payload.location) {
-            const location = new grpcPuppet.LocationPayload();
-            location.setAccuracy(payload.location.accuracy);
-            location.setAddress(payload.location.address);
-            location.setName(payload.location.name);
-            location.setLatitude(payload.location.latitude);
-            location.setLongitude(payload.location.longitude);
-            post.setLocation(location);
-        }
-        post.setVisibleListList(payload.visibleList || []);
+        const post = await postPayloadToPb(grpcPuppet, payload, this.serializeFileBox.bind(this));
         request.setPost(post);
         const result = await util.promisify(this.grpcManager.client.momentPublish
             .bind(this.grpcManager.client))(request);
@@ -1820,36 +1732,6 @@ class PuppetService extends PUPPET.Puppet {
         const contactIdsList = response.getContactIdsList();
         return contactIdsList;
     }
-    /**
-     * @deprecated Will be removed in v2.0
-     */
-    async messageSendFileStream(conversationId, file) {
-        const request = await packConversationIdFileBoxToPb(grpcPuppet.MessageSendFileStreamRequest)(conversationId, file);
-        const response = await new Promise((resolve, reject) => {
-            const stream = this.grpcManager.client.messageSendFileStream((err, response) => {
-                if (err) {
-                    reject(err);
-                }
-                else {
-                    resolve(response);
-                }
-            });
-            request.pipe(stream); // Huan(202203): FIXME: as unknown as
-        });
-        const messageId = response.getId();
-        if (messageId) {
-            return messageId;
-        }
-        {
-            /**
-             * Huan(202110): Deprecated: will be removed after Dec 31, 2022
-             */
-            const messageIdWrapper = response.getIdStringValueDeprecated();
-            if (messageIdWrapper) {
-                return messageIdWrapper.getValue();
-            }
-        }
-    }
     healthCheckInterval;
     startHealthCheck() {
         this.healthCheckInterval = setInterval(() => {