tmc.js 0.3.6 → 0.3.8

package/README.md

@@ -30,14 +30,14 @@ new Tmc('your_app_key', 'your_app_secret')
 
 ## API
 
-**`new Tmc(appKey: string, appSecret: BinaryLike, groupName?: string | object, options?: object)`**
+**`new Tmc(appKey: string, appSecret: BinaryLike, groupName?: string | ConsumerOptions, options?: ConsumerOptions)`**
 
 | 参数 | 类型 | 说明 |
 | --- | --- | --- |
 | appKey | `string` | 应用ID |
 | appSecret | `BinaryLike` | 应用密钥 |
-| groupName | `string` | 消息分组(可选，默认`default`) |
-| options | `object` | 消费端配置参数(可选) |
+| groupName | `string \| ConsumerOptions` | 消息分组(可选，默认`default`) |
+| options | `ConsumerOptions` | 消费端配置参数(可选) |
 | options.pullRequestInterval | `number` | 定时发送`pullRequest`请求时间间隔(默认`5000`毫秒) |
 | options.onErrorReconnection | `number` | 当消费端出现错误，重试连接间隔(默认`15000`毫秒) |
 | options.onCloseReconnection | `number` | 当消费端断开连接，重试连接间隔(默认`3000`毫秒) |
@@ -75,11 +75,11 @@ 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 })
-.taobao_trade_TradeDelayConfirmPay(function needDoubleReriesThenConfirm(msg) {
+.taobao_trade_TradeDelayConfirmPay(function needDoubleRetriesThenConfirm(msg) {
   if (msg instanceof Message && msg.content?.retried === 0) {
     this.send(
       new Message(MessageType.SENDACK, MessageKind.Failed)
@@ -91,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`以原生`object`类型描述，`SDK`会将此对象转化成`JSON`字符串。例如：
+
+```js
+/** @see https://open.taobao.com/tmc.htm?docId=732&docType=9 */
+.send(
+  new Message(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, '{"tid":12345678901234567,"amount":"100.00"}')
+)
+```
+
 <details><summary>可选设置的 NODE_DEBUG=< label > 环境变量</summary>
 
 | label | 说明 |

package/lib/consumer.js

@@ -99,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() {

package/lib/message.js

@@ -56,29 +56,16 @@ class Message {
 
 const utf8 = 'utf8';
 
-const write = 'write';
-
-const writeInt8 = 'writeInt8';
-
-const writeInt16LE = 'writeInt16LE';
-
-const writeInt32LE = 'writeInt32LE';
-
-const writeBigInt64LE = 'writeBigInt64LE';
+const kOffset = Symbol('kOffset');
 
 const {
   Void, Byte, Int16, Int32, Int64, ByteArray, CountedString,
 } = ValueFormat;
 
-function pick(size, method, ...value) {
-  const buf = Buffer.alloc(size);
-  buf[method](...value);
-
-  return Buffer.from(buf.buffer);
-}
-
 class Encoder {
-  [kBuffer] = [];
+  [kOffset] = 0;
+
+  [kBuffer] = [/* method, value, offset, length, charset */];
 
   [kData];
 
@@ -102,25 +89,25 @@ class Encoder {
   }
 
   put(value) {
-    this[kBuffer].push(pick(1, writeInt8, Number(value)));
+    this[kBuffer].push(['writeInt8', Number(value), (this[kOffset] += 1) - 1, 1]);
 
     return this;
   }
 
   putShort(value) {
-    this[kBuffer].push(pick(2, writeInt16LE, Number(value)));
+    this[kBuffer].push(['writeInt16LE', Number(value), (this[kOffset] += 2) - 2, 2]);
 
     return this;
   }
 
   putInt(value) {
-    this[kBuffer].push(pick(4, writeInt32LE, Number(value)));
+    this[kBuffer].push(['writeInt32LE', Number(value), (this[kOffset] += 4) - 4, 4]);
 
     return this;
   }
 
   putLong(value) {
-    this[kBuffer].push(pick(8, writeBigInt64LE, BigInt(value)));
+    this[kBuffer].push(['writeBigInt64LE', BigInt(value), (this[kOffset] += 8) - 8, 8]);
 
     return this;
   }
@@ -128,7 +115,7 @@ class Encoder {
   writeCountedString(value) {
     const len = value ? Buffer.byteLength(value) : 0;
     this.putInt(len);
-    if (len) { this[kBuffer].push(pick(len, write, value, utf8)); }
+    if (len) { this[kBuffer].push(['write', value, (this[kOffset] += len) - len, len, utf8]); }
 
     return this;
   }
@@ -168,17 +155,24 @@ class Encoder {
     }
 
     if (Buffer.isBuffer(value)) {
-      this.put(ByteArray).putInt(value.length);
-      this[kBuffer].push(value);
+      const len = value.length;
+      this.put(ByteArray).putInt(len);
+      this[kBuffer].push(['fill', value, (this[kOffset] += len) - len, len]);
     }
 
     return this;
   }
 
-  get buffer() { return Buffer.concat(this.compress()[kBuffer]); }
-}
+  get buffer() {
+    this[kOffset] = 0;
+    this[kBuffer] = [];
+    this.compress();
+    const buf = Buffer.alloc(this[kOffset]);
+    this[kBuffer].forEach(([method, value, offset, length, charset]) => buf[method](value, offset, length, charset));
 
-const kOffset = Symbol('kOffset');
+    return buf;
+  }
+}
 
 class Decoder {
   [kOffset] = 1;

package/package.json

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