tmc.js 0.3.0 → 0.3.1

package/README.md

@@ -1,4 +1,4 @@
-# Taobao Message Channel (tmc.js)
+# tmc.js
 
 Events driven and chained Taobao Message Channel(TMC) for NodeJS
 
@@ -7,9 +7,9 @@ Events driven and chained Taobao Message Channel(TMC) for NodeJS
 `npm i tmc.js`
 
 ```js
-import TMC from 'tmc.js';
+import Tmc from 'tmc.js';
 
-new TMC('your_app_key', 'your_app_secret')
+new Tmc('your_app_key', 'your_app_secret')
 .on('taobao_trade_TradeChanged', msg => console.info(msg))
 .taobao_trade_TradeClose(msg => console.info(msg))
 .connect();
@@ -17,7 +17,7 @@ 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 | object, options?: object)`**
 
 | 参数 | 类型 | 说明 |
 | --- | --- | --- |
@@ -31,6 +31,135 @@ new TMC('your_app_key', 'your_app_secret')
 | options.autoParseContentJson | `boolean` | 自动解析推送消息`$.content.content`字段为对象(默认`true`) |
 | options.autoReplyConfirmation | `boolean` | 以推送的`$.content.id`字段自动`Confirm`消息(默认`true`) |
 
+**`tmc.on(topic: string, listener: (this: Tmc, message: Message) => void) => Tmc`**
+
+注册 `topic` 消息通知处理函数，默认已内置 [消息](./types/message.in.d.ts) 说明。
+
+**`tmc[<topic>](fn: (this: Tmc, message: Message) => void) => Tmc`**
+
+直接以 `topic` 为键值，注册消息通知处理函数。
+
+**`tmc.reconnect(ms: number) => Tmc`**
+
+当消费端 `onerror`/`onclose` 事件发生时，延迟 `ms` 毫秒自动重新建立连接。
+
+**`tmc.connect(address?: string) => Tmc`**
+
+消费端发起建立连接 `onopen` 事件，`address` 默认为 `ws://mc.api.taobao.com/`。
+
+<details><summary>可选设置的 NODE_DEBUG=< label > 环境变量</summary>
+
+| label | 说明 |
+| --- | --- |
+| `tmc` | 开启全部`DEBUG`日志模式
+| `tmc:onping` | 开启 `onping` 时的日志
+| `tmc:onopen` | 开启 `onopen` 时的日志
+| `tmc:onpull` | 开启 `onpull` 时的日志
+| `tmc:onerror` | 开启 `onerror` 时的日志
+| `tmc:onclose` | 开启 `onclose` 时的日志
+| `tmc:onmessage` | 开启全部 `onmessage` 时的日志(即`From`淘宝消息)
+| `tmc:onmessage:connect` | 开启消费端发起连接 `connect` 时的日志
+| `tmc:onmessage:connectack` | 开启消费端回复连接 `connectack` 时的日志
+| `tmc:onmessage:send` | 开启消费端接收到(即`From`淘宝) `send` 的消息时的日志
+| `tmc:onmessage:sendack` | (暂未明确场景)
+| `tmc:onmessage:send:confirm` | 开启消费端回复接收到的(即`From`淘宝消息)，发送自动确认 `send:confirm` 时的日志
+
+</details>
+
+## 支持的TOPICS
+
+<details><summary>共计 81+ 类别，439+ 消息数</summary>
+
+| 类别 | 消息数 |
+| --- | --- |
+| 淘宝交易 | 20 |
+| 淘宝退款 | 13 |
+| 淘宝商品 | 13 |
+| 淘宝分销 | 23 |
+| 淘宝点点 | 12 |
+| 淘宝火车票 | 5 |
+| 平台消息 | 7 |
+| 交易全链路 | 3 |
+| 淘宝机票 | 14 |
+| 导购平台 | 21 |
+| 淘宝汽车票 | 4 |
+| 服务市场 | 9 |
+| 天猫服务 | 16 |
+| 天猫美妆 | 2 |
+| 聚石塔 | 9 |
+| 淘宝物流 | 1 |
+| 阿里通信 | 17 |
+| 天猫魔盒 | 2 |
+| OpenIM消息 | 1 |
+| 网上法庭 | 8 |
+| 电子发票 | 20 |
+| 航旅度假交易 | 8 |
+| YunOS YoC | 2 |
+| 阿里物联 | 2 |
+| 全球购跨境物流 | 1 |
+| 零售plus | 8 |
+| 客户运营平台API | 12 |
+| AE-交易 | 10 |
+| 五道口配送 | 1 |
+| 百川 | 2 |
+| 闲鱼 | 14 |
+| 闲鱼回收商消息 | 5 |
+| 零售通POS开放平台消息 | 4 |
+| DPAAS | 6 |
+| AliGenius | 1 |
+| 智慧门店下行消息 | 2 |
+| 渠道中心API | 4 |
+| 五道口订单 | 22 |
+| 信息平台-采购 | 1 |
+| 1688服务市场 | 1 |
+| 酒店商品消息api | 9 |
+| 新零售终端下行消息 | 1 |
+| 新零售终端上行消息 | 4 |
+| 欢行开放平台 | 1 |
+| 阿里发票 | 5 |
+| 大麦票单状态 | 1 |
+| 五道口营销 | 4 |
+| 酒店签约中心消息 | 3 |
+| 蜂鸟物流 | 6 |
+| 商旅API | 3 |
+| 阿里健康-O2O中台 | 2 |
+| 业务平台新零售-消息上行 | 2 |
+| 大麦第三方票务供应商接入 | 5 |
+| TVOS应用审核平台 | 1 |
+| Gifting送礼 | 1 |
+| 五道口商品 | 2 |
+| HOMEAI | 1 |
+| HOMEAI消息对接 | 5 |
+| 零售通_公共 | 8 |
+| 酒店标准库基础信息变更消息 | 2 |
+| 菜鸟发货工作台 | 1 |
+| IOT-智能制造 | 2 |
+| 智能制造API | 1 |
+| IoT售后解决方案 | 1 |
+| OpenMall-API | 5 |
+| 闲鱼已验货 | 6 |
+| 阿里健康三方机构 | 2 |
+| 聚石塔监控告警 | 2 |
+| 大资产拍卖Top端拍品消息 | 2 |
+| AE-任务平台消息 | 1 |
+| 天猫汽车 | 5 |
+| 阿信消息通知前台类目 | 1 |
+| 阿里健康追溯码 | 1 |
+| 自动驾驶API | 3 |
+| MMC五盘货项目 | 5 |
+| 银泰开放平台消息 | 2 |
+| 阿里智付 | 1 |
+| 代发管理 | 2 |
+| 蚂蚁采购 | 1 |
+| 阿里健康&一树-电商中台对接 | 2 |
+| 阿里健康-疫苗 | 1 |
+
+</details>
+
+## 链接
+
+- [淘宝开放平台-消息服务使用介绍](https://open.taobao.com/doc.htm?docId=101663&docType=1)
+
 ## License
 
 [MIT](LICENSE)

package/lib/consumer.js

@@ -29,7 +29,7 @@ function ipAddr() {
   )?.address;
 }
 
-class TaoMessageComsumer extends EventEmitter {
+class TaoMessageConsumer extends EventEmitter {
   [kAddress] = 'ws://mc.api.taobao.com/';
 
   [kGroupName] = 'default';
@@ -202,5 +202,5 @@ class TaoMessageComsumer extends EventEmitter {
   }
 }
 
-module.exports = TaoMessageComsumer;
-module.exports.default = TaoMessageComsumer;
+module.exports = TaoMessageConsumer;
+module.exports.default = TaoMessageConsumer;

package/lib/message.js

@@ -10,6 +10,9 @@ const {
   TYPE, CODE, PHRASE, FLAG, TOKEN, CONTENT,
 } = require('./message-fields');
 
+const kData = Symbol('kData');
+const kBuffer = Symbol('kBuffer');
+
 class Message {
   protocolVersion = 2;
 
@@ -49,7 +52,7 @@ class Message {
 
   static from(buf) {
     /* eslint-disable-next-line no-use-before-define */
-    return new Decoder(buf).data;
+    return new Decoder(buf).message;
   }
 }
 
@@ -77,53 +80,53 @@ function pick(size, method, ...value) {
 }
 
 class Encoder {
-  buffers = [];
+  [kBuffer] = [];
 
-  data;
+  [kData];
 
   constructor(message) {
     if (!(message instanceof Message)) {
       throw new TypeError('Must be an instance Message here.');
     }
-    this.data = message;
+    this[kData] = message;
   }
 
   compress() {
-    this.put(this.data.protocolVersion).put(this.data[TYPE]);
+    this.put(this[kData].protocolVersion).put(this[kData][TYPE]);
     /* eslint-disable-next-line no-unused-expressions */
-    this.data[CODE] && this.putShort(StatusCode).putShort(this.data[CODE]);
+    this[kData][CODE] && this.putShort(StatusCode).putShort(this[kData][CODE]);
     /* eslint-disable-next-line no-unused-expressions */
-    this.data[PHRASE] && this.putShort(StatusPhrase).writeCountedString(this.data[PHRASE]);
+    this[kData][PHRASE] && this.putShort(StatusPhrase).writeCountedString(this[kData][PHRASE]);
     /* eslint-disable-next-line no-unused-expressions */
-    this.data[FLAG] && this.putShort(Flag).putInt(this.data[FLAG]);
+    this[kData][FLAG] && this.putShort(Flag).putInt(this[kData][FLAG]);
     /* eslint-disable-next-line no-unused-expressions */
-    this.data[TOKEN] && this.putShort(Token).writeCountedString(this.data[TOKEN]);
-    Object.entries(this.data[CONTENT] || {}).forEach(([k, v]) => this.putShort(Custom).writeCountedString(k).writeCustomValue(v));
+    this[kData][TOKEN] && this.putShort(Token).writeCountedString(this[kData][TOKEN]);
+    Object.entries(this[kData][CONTENT] || {}).forEach(([k, v]) => this.putShort(Custom).writeCountedString(k).writeCustomValue(v));
     this.putShort(EndOfHeaders);
 
     return this;
   }
 
   put(value) {
-    this.buffers.push(pick(1, writeInt8, Number(value)));
+    this[kBuffer].push(pick(1, writeInt8, Number(value)));
 
     return this;
   }
 
   putShort(value) {
-    this.buffers.push(pick(2, writeInt16LE, Number(value)));
+    this[kBuffer].push(pick(2, writeInt16LE, Number(value)));
 
     return this;
   }
 
   putInt(value) {
-    this.buffers.push(pick(4, writeInt32LE, Number(value)));
+    this[kBuffer].push(pick(4, writeInt32LE, Number(value)));
 
     return this;
   }
 
   putLong(value) {
-    this.buffers.push(pick(8, writeBigInt64LE, BigInt(value)));
+    this[kBuffer].push(pick(8, writeBigInt64LE, BigInt(value)));
 
     return this;
   }
@@ -132,7 +135,7 @@ class Encoder {
     const len = value ? Buffer.byteLength(value) : 0;
     this.putInt(len);
     /* eslint-disable-next-line no-unused-expressions */
-    len && this.buffers.push(pick(len, write, value, utf8));
+    len && this[kBuffer].push(pick(len, write, value, utf8));
 
     return this;
   }
@@ -173,15 +176,17 @@ class Encoder {
 
     if (Buffer.isBuffer(value)) {
       this.put(ByteArray).putInt(value.length);
-      this.buffers.push(value);
+      this[kBuffer].push(value);
     }
 
     return this;
   }
 
-  get buffer() { return Buffer.concat(this.compress().buffers); }
+  get buffer() { return Buffer.concat(this.compress()[kBuffer]); }
 }
 
+const kOffset = Symbol('kOffset');
+
 const readInt8 = 'readInt8';
 
 const readInt16LE = 'readInt16LE';
@@ -195,23 +200,23 @@ function read(buffer, method, offset, ...extra) {
 }
 
 class Decoder {
-  offset = 1;
+  [kOffset] = 1;
 
-  buffer;
+  [kBuffer];
 
-  data;
+  [kData];
 
   constructor(buf) {
     if (!Buffer.isBuffer(buf)) {
       throw new TypeError('Must be an instance Buffer here.');
     }
-    this.buffer = buf;
-    this.data = new Message();
+    this[kBuffer] = buf;
+    this[kData] = new Message();
     this.extract();
   }
 
   extract() {
-    this.data.with(TYPE, this.reset().get());
+    this[kData].with(TYPE, this.reset().get());
 
     let headerType;
     do {
@@ -219,47 +224,47 @@ class Decoder {
       this[`pick${headerType}`]();
     } while (headerType !== EndOfHeaders);
 
-    this.reset();
+    return this.reset();
   }
 
-  [`pick${EndOfHeaders}`]() { return this.data; }
+  [`pick${EndOfHeaders}`]() { return this[kData]; }
 
-  [`pick${Custom}`]() { return this.data.with(this.readCountedString(), this.readCustomValue()); }
+  [`pick${Custom}`]() { return this[kData].with(this.readCountedString(), this.readCustomValue()); }
 
-  [`pick${StatusCode}`]() { return this.data.with(CODE, this.getInt()); }
+  [`pick${StatusCode}`]() { return this[kData].with(CODE, this.getInt()); }
 
-  [`pick${StatusPhrase}`]() { return this.data.with(PHRASE, this.readCountedString()); }
+  [`pick${StatusPhrase}`]() { return this[kData].with(PHRASE, this.readCountedString()); }
 
-  [`pick${Flag}`]() { return this.data.with(FLAG, this.getInt()); }
+  [`pick${Flag}`]() { return this[kData].with(FLAG, this.getInt()); }
 
-  [`pick${Token}`]() { return this.data.with(TOKEN, this.readCountedString()); }
+  [`pick${Token}`]() { return this[kData].with(TOKEN, this.readCountedString()); }
 
   reset() {
-    this.offset = 1;
+    this[kOffset] = 1;
     return this;
   }
 
   get() {
-    const value = read(this.buffer, readInt8, this.offset);
-    this.offset += 1;
+    const value = read(this[kBuffer], readInt8, this[kOffset]);
+    this[kOffset] += 1;
     return Number(value);
   }
 
   getShort() {
-    const value = read(this.buffer, readInt16LE, this.offset);
-    this.offset += 2;
+    const value = read(this[kBuffer], readInt16LE, this[kOffset]);
+    this[kOffset] += 2;
     return Number(value);
   }
 
   getInt() {
-    const value = read(this.buffer, readInt32LE, this.offset);
-    this.offset += 4;
+    const value = read(this[kBuffer], readInt32LE, this[kOffset]);
+    this[kOffset] += 4;
     return Number(value);
   }
 
   getLong() {
-    const value = read(this.buffer, readBigInt64LE, this.offset);
-    this.offset += 8;
+    const value = read(this[kBuffer], readBigInt64LE, this[kOffset]);
+    this[kOffset] += 8;
     return BigInt(value);
   }
 
@@ -268,8 +273,8 @@ class Decoder {
     if (size === 0) {
       return null;
     }
-    const buf = this.buffer.subarray(this.offset, this.offset + size);
-    this.offset += size;
+    const buf = this[kBuffer].subarray(this[kOffset], this[kOffset] + size);
+    this[kOffset] += size;
     return buf;
   }
 
@@ -293,7 +298,7 @@ class Decoder {
 
   [`parse${CountedString}`]() { return this.readCountedString(); }
 
-  get message() { return this.data; }
+  get message() { return this[kData]; }
 }
 
 module.exports = Message;

package/package.json

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

package/types/header-type.d.ts

@@ -0,0 +1,21 @@
+declare namespace HeaderType {
+  type EndOfHeaders = 0;
+  type Custom = 1;
+  type StatusCode = 2;
+  type StatusPhrase = 3;
+  type Flag = 4;
+  type Token = 5;
+  interface includes {
+    (value: any): boolean;
+  }
+}
+
+declare class HeaderType {
+  static EndOfHeaders: HeaderType.EndOfHeaders;
+  static Custom: HeaderType.Custom;
+  static StatusCode: HeaderType.StatusCode;
+  static StatusPhrase: HeaderType.StatusPhrase;
+  static Flag: HeaderType.Flag;
+  static Token: HeaderType.Token;
+  static includes: HeaderType.includes;
+}