tmc.js 0.3.5 → 0.3.7

package/README.md

@@ -43,14 +43,27 @@ new Tmc('your_app_key', 'your_app_secret')
 | options.onCloseReconnection | `number` | 当消费端断开连接，重试连接间隔(默认`3000`毫秒) |
 | options.autoParseContentJson | `boolean` | 自动解析推送消息`$.content.content`字段为对象(默认`true`) |
 | options.autoReplyConfirmation | `boolean` | 以推送的`$.content.id`字段自动`Confirm`消息(默认`true`) |
+| options.autoGroupedEmitting | `boolean` | 以`/^(([^_]+)_[^_]+)_.+/`规则切分`$.content.topic`主题，开关消费端多维监听功能(默认`true`) |
 
 **`tmc.on(topic: string, listener: (this: Tmc, message: Message) => void) => Tmc`**
 
 注册 `topic` 消息通知处理函数，默认已内置 [消息](./types/message.in.d.ts) 说明。
+自`v0.3.6`起，默认开启消费端多维监听功能，`topic`字符串也可以是`BU`及`BU_G`单位，例如：
+
+```js
+.on('taobao', console.info)
+.on('alibaba_einvoice', console.info)
+```
 
 **`tmc[<topic>](fn: (this: Tmc, message: Message) => void) => Tmc`**
 
 直接以 `topic` 为键值，注册消息通知处理函数。
+自`v0.3.6`起，默认开启消费端多维监听功能，`topic`字符串也可以是`BU`及`BU_G`单位，例如：
+
+```js
+.taobao(console.info)
+.alibaba_einvoice(console.info)
+```
 
 **`tmc.reconnect(ms: number) => Tmc`**
 
@@ -62,7 +75,7 @@ new Tmc('your_app_key', 'your_app_secret')
 
 **`tmc.send(msg: Message, options?: { mask?: true, binary?: true }, cb?: (err: Error) => void) => void`**
 
-实例化后，当自动应答确认消息无法满足需求的时候，比如消息处理失败，需要`Publisher`再次重推消息，在实例初始化时置`options.autoReplyConfirmation=false`，则在消息处理函数内，可以通过 `this.send()` 函数回复`确认`或者`失败`消息。例如：
+自`v0.3.4`起，当自动应答确认消息无法满足需求的时候，比如消息处理失败，需要`Publisher`再次重推消息，在实例初始化时置`options.autoReplyConfirmation=false`，则在消息处理函数内，可以通过 `this.send()` 函数回复`确认`或者`失败`消息。例如：
 
 ```js
 new Tmc('your_app_key', 'your_app_secret', { autoReplyConfirmation: false })
@@ -78,6 +91,29 @@ new Tmc('your_app_key', 'your_app_secret', { autoReplyConfirmation: false })
 .connect();
 ```
 
+也可以使用此方法发送`To淘宝`消息，`>=v0.3.4 && <v0.3.7`版本，需要自主对`$.content.content`数据做`JSON`字符串化(**特别注意：**原生`JSON`对`BigInt`类型无法处理)。自`v0.3.7`起，可直接对`$.content.content`以原生数据类型描述。例如：
+
+```js
+/** @see https://open.taobao.com/tmc.htm?docId=732&docType=9 */
+.send(
+  new Mesage(MessageType.SEND, MessageKind.Data)
+  .with(MessageFields.TOPIC, 'taobao_fuwu_ElectronicInvoice')
+  .with(MessageFields.CONTENT, {
+    id: 12345678901234567n, // 支持 BigInt 类型
+    tid: 12345678901234567n,
+    oid: 12345678901234567n,
+    invoice_file: 12345678901234567n,
+    e_invoice_no: '12342243435466',
+    invoice_time: '2015-04-10 10:33:49', // 时区 +08:00
+    invoice_no: '123456',
+    invoice_code: '123456',
+    amount: '100.00',
+  })
+  // >=v0.3.4 && <v0.3.7 写法
+  // .with(MessageFields.CONTENT, '{"id":12345678901234567,"tid":12345678901234567,"amount":"100.00"}')
+)
+```
+
 <details><summary>可选设置的 NODE_DEBUG=< label > 环境变量</summary>
 
 | label | 说明 |

package/lib/consumer.js

@@ -46,6 +46,8 @@ class TaoMessageConsumer extends EventEmitter {
     onCloseReconnection: 3e3,
     autoParseContentJson: true,
     autoReplyConfirmation: true,
+    /** @since v0.3.6 */
+    autoGroupedEmitting: true,
   };
 
   [kWebSocket];
@@ -97,10 +99,16 @@ class TaoMessageConsumer extends EventEmitter {
    * @param {object|Function} [options] - The options
    * @param {Function} [cb] - The Callback
    * @returns {void}
-   * @since v0.3.4
+   * @since v0.3.4 Exposed for `send(new Message(SENDACK, Failed))` scene
+   * @since v0.3.7 The `data.content.content` can be a plain `object` now
    */
   send(data, options = { mask: true, binary: true }, cb = undefined) {
-    if (data instanceof Message) { this[kWebSocket]?.send(data.with(TOKEN, this[kToken]).buffer, options, cb); }
+    if (data instanceof Message) {
+      if (typeof data[CONTENT][CONTENT] === 'object' && data[CONTENT][CONTENT] !== null) {
+        Reflect.set(data[CONTENT], CONTENT, stringify(data[CONTENT][CONTENT]));
+      }
+      this[kWebSocket]?.send(data.with(TOKEN, this[kToken]).buffer, options, cb);
+    }
   }
 
   onopen() {
@@ -129,7 +137,7 @@ class TaoMessageConsumer extends EventEmitter {
   }
 
   onping(data) {
-    logger.onping('The channel is onping with data [%s].', stringify(data));
+    logger.onping('The channel is onping with data [%s].', data);
     this[kWebSocket]?.pong(data, true);
   }
 
@@ -138,8 +146,8 @@ class TaoMessageConsumer extends EventEmitter {
     this.reconnect(this[kOptions].onErrorReconnection);
   }
 
-  onclose(...arg) {
-    logger.onclose('The channel is onclose(%s), let us reconnect.', stringify(arg));
+  onclose(code, reason) {
+    logger.onclose('The channel is onclose(%d: %s), let us reconnect.', code, reason);
     this.reconnect(this[kOptions].onCloseReconnection);
   }
 
@@ -148,7 +156,13 @@ class TaoMessageConsumer extends EventEmitter {
   }
 
   [`process${SEND}`](msg) {
-    if (msg && msg[CONTENT] && msg[CONTENT][TOPIC]) { this.emit(msg[CONTENT][TOPIC], msg); }
+    if (msg && msg[CONTENT] && msg[CONTENT][TOPIC]) {
+      [msg[CONTENT][TOPIC]].concat(
+        this[kOptions].autoGroupedEmitting
+          ? msg[CONTENT][TOPIC].split(/^(([^_]+)_[^_]+)_.+/).slice(1, -1)
+          : [],
+      ).forEach((t) => this.emit(t, msg));
+    }
 
     if (this[kOptions].autoReplyConfirmation && msg && msg[CONTENT] && msg[CONTENT][ID]) {
       const reply = new Message(SEND, Confirm).with(TOKEN, this[kToken]).with(ID, msg[CONTENT][ID]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tmc.js",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "description": "Events driven and chained Taobao Message Channel(TMC) for NodeJS",
   "author": "James ZHANG",
   "license": "MIT",