tmc.js 0.3.1 → 0.3.3

package/README.md

@@ -2,6 +2,19 @@
 
 Events driven and chained Taobao Message Channel(TMC) for NodeJS
 
+[![release](https://img.shields.io/npm/v/tmc.js)](https://github.com/TheNorthMemory/tmc.js/releases)
+[![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/tmc.js?label=snyk.io)](https://snyk.io/advisor/npm-package/tmc.js)
+[![types](https://img.shields.io/badge/types-included-blue)](https://www.npmjs.com/package/tmc.js)
+[![requirement](https://img.shields.io/node/v/tmc.js)](https://www.npmjs.com/package/tmc.js)
+[![downloads](https://img.shields.io/npm/dm/tmc.js)](https://www.npmjs.com/package/tmc.js)
+[![license](https://img.shields.io/npm/l/tmc.js)](https://www.npmjs.com/package/tmc.js)
+
+## 设计
+
+核心包以事件作为驱动，通过注册`TOPIC`回调处理函数，实现了TMC产品服务的消息消费处理能力，同时通过`Proxy`代理，以`TOPIC`作为键值，平序注册消息消费处理函数，序图如下：
+
+[![SDK Sequence](./.github/sdk-sequence.svg)](./.github/sdk-sequence.mmd)
+
 ## 使用
 
 `npm i tmc.js`
@@ -51,7 +64,6 @@ new Tmc('your_app_key', 'your_app_secret')
 
 | label | 说明 |
 | --- | --- |
-| `tmc` | 开启全部`DEBUG`日志模式
 | `tmc:onping` | 开启 `onping` 时的日志
 | `tmc:onopen` | 开启 `onopen` 时的日志
 | `tmc:onpull` | 开启 `onpull` 时的日志
@@ -61,7 +73,7 @@ new Tmc('your_app_key', 'your_app_secret')
 | `tmc:onmessage:connect` | 开启消费端发起连接 `connect` 时的日志
 | `tmc:onmessage:connectack` | 开启消费端回复连接 `connectack` 时的日志
 | `tmc:onmessage:send` | 开启消费端接收到(即`From`淘宝) `send` 的消息时的日志
-| `tmc:onmessage:sendack` | (暂未明确场景)
+| `tmc:onmessage:sendack` | 当消费端收到(`From`淘宝)消息，消费端消息处理失败，需要服务端重发，须回复`SENDACK(3)`及`FLAG`字典值时的日志
 | `tmc:onmessage:send:confirm` | 开启消费端回复接收到的(即`From`淘宝消息)，发送自动确认 `send:confirm` 时的日志
 
 </details>

package/lib/consumer.js

@@ -83,9 +83,9 @@ class TaoMessageConsumer extends EventEmitter {
   sign(timestamp) {
     const sk = this[kAppSecret].export();
     return [
-      ['app_key', this[kAppKey]],
-      ['group_name', this[kGroupName]],
-      ['timestamp', `${timestamp}`],
+      [APP_KEY, this[kAppKey]],
+      [GROUP_NAME, this[kGroupName]],
+      [TIMESTAMP, `${timestamp}`],
     ].reduce(
       (h, [k, v]) => h.update(k).update(v),
       createHash('md5').update(sk),
@@ -187,16 +187,12 @@ class TaoMessageConsumer extends EventEmitter {
   connect(address) {
     if (address) { this[kAddress] = address; }
 
-    this[kWebSocket]?.close();
-
-    const ws = new WebSocket(this[kAddress]);
-    Reflect.set(this, kWebSocket, ws);
-
-    ws.on('open', () => this.onopen());
-    ws.on('ping', (...arg) => this.onping(...arg));
-    ws.on('error', (err) => this.onerror(err));
-    ws.on('close', (...arg) => this.onclose(...arg));
-    ws.on('message', (...arg) => this.onmessage(...arg));
+    this[kWebSocket] = new WebSocket(this[kAddress])
+      .on('message', (data, isBinary) => this.onmessage(data, isBinary))
+      .on('close', (code, reason) => this.onclose(code, reason))
+      .on('error', (err) => this.onerror(err))
+      .on('ping', (data) => this.onping(data))
+      .on('open', () => this.onopen());
 
     return this;
   }

package/lib/message-fields.js

@@ -12,6 +12,11 @@ const SDK = 'sdk';
 const INTRANET_IP = 'intranet_ip';
 const ID = 'id';
 const TOPIC = 'topic';
+const MSG = 'msg';
+const DATAID = 'dataid';
+const USERID = 'userid';
+const OUTTIME = 'outtime';
+const PUBLISHER = 'publisher';
 
 class MessageFields {
   static TYPE = TYPE;
@@ -41,6 +46,16 @@ class MessageFields {
   static ID = ID;
 
   static TOPIC = TOPIC;
+
+  static MSG = MSG;
+
+  static DATAID = DATAID;
+
+  static USERID = USERID;
+
+  static OUTTIME = OUTTIME;
+
+  static PUBLISHER = PUBLISHER;
 }
 
 module.exports = MessageFields;
@@ -59,3 +74,8 @@ module.exports.SDK = SDK;
 module.exports.INTRANET_IP = INTRANET_IP;
 module.exports.ID = ID;
 module.exports.TOPIC = TOPIC;
+module.exports.MSG = MSG;
+module.exports.DATAID = DATAID;
+module.exports.USERID = USERID;
+module.exports.OUTTIME = OUTTIME;
+module.exports.PUBLISHER = PUBLISHER;

package/package.json

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

package/types/index.d.ts

@@ -42,10 +42,10 @@ declare interface TaoMessageConstractor extends EventEmitter {
 }
 
 declare interface TaoMessageSubscriber {
-  [K: string]: TopicSubscriber;
+  [K: string]: TaoTopicSubscriber;
 }
 
-declare interface TopicSubscriber {
+declare interface TaoTopicSubscriber {
   (fn: TaoMessageProcessor): TaoMessageConsumer;
 }
 
@@ -784,6 +784,10 @@ declare interface TaoTopicsDescriptor {
   tmall_auto_TradeModify(fn: (this: TaoMessageConsumer, message: IncomingMessage.TmallAutoTradeModify) => void): TaoMessageConsumer;
   /** {@link IncomingMessage.TmallAutoTwoWheelsReceiptCreate 天猫汽车 > 天猫二轮车服务工单创建开放} */
   tmall_auto_TwoWheelsReceiptCreate(fn: (this: TaoMessageConsumer, message: IncomingMessage.TmallAutoTwoWheelsReceiptCreate) => void): TaoMessageConsumer;
+  /** {@link IncomingMessage.TmallCarContractSign 天猫汽车 > 合同签署消息} */
+  tmall_car_ContractSign(fn: (this: TaoMessageConsumer, message: IncomingMessage.TmallCarContractSign) => void): TaoMessageConsumer;
+  /** {@link IncomingMessage.TmallCarFinanceMsg 天猫汽车 > 汽车金融消息} */
+  tmall_car_FinanceMsg(fn: (this: TaoMessageConsumer, message: IncomingMessage.TmallCarFinanceMsg) => void): TaoMessageConsumer;
   /** {@link IncomingMessage.TmallChannelApplyOrderChange 渠道中心API > 申请单变更消息} */
   tmall_channel_ApplyOrderChange(fn: (this: TaoMessageConsumer, message: IncomingMessage.TmallChannelApplyOrderChange) => void): TaoMessageConsumer;
   /** {@link IncomingMessage.TmallChannelDeliverOrderChange 渠道中心API > 发货单消息变更} */
@@ -1609,6 +1613,10 @@ declare interface TaoEventsListener {
   on(topic: 'tmall_auto_TradeModify', listener: (this: TaoMessageConsumer, message: IncomingMessage.TmallAutoTradeModify) => void): TaoMessageConsumer;
   /** {@link IncomingMessage.TmallAutoTwoWheelsReceiptCreate 天猫汽车 > 天猫二轮车服务工单创建开放} */
   on(topic: 'tmall_auto_TwoWheelsReceiptCreate', listener: (this: TaoMessageConsumer, message: IncomingMessage.TmallAutoTwoWheelsReceiptCreate) => void): TaoMessageConsumer;
+  /** {@link IncomingMessage.TmallCarContractSign 天猫汽车 > 合同签署消息} */
+  on(topic: 'tmall_car_ContractSign', listener: (this: TaoMessageConsumer, message: IncomingMessage.TmallCarContractSign) => void): TaoMessageConsumer;
+  /** {@link IncomingMessage.TmallCarFinanceMsg 天猫汽车 > 汽车金融消息} */
+  on(topic: 'tmall_car_FinanceMsg', listener: (this: TaoMessageConsumer, message: IncomingMessage.TmallCarFinanceMsg) => void): TaoMessageConsumer;
   /** {@link IncomingMessage.TmallChannelApplyOrderChange 渠道中心API > 申请单变更消息} */
   on(topic: 'tmall_channel_ApplyOrderChange', listener: (this: TaoMessageConsumer, message: IncomingMessage.TmallChannelApplyOrderChange) => void): TaoMessageConsumer;
   /** {@link IncomingMessage.TmallChannelDeliverOrderChange 渠道中心API > 发货单消息变更} */
@@ -1707,4 +1715,21 @@ declare interface TaoEventsListener {
 
 declare const TMC: TaoMessageConsumer;
 
+type internalMessage = Message;
+type internalMessageFields = MessageFields;
+type internalMessageKind = MessageKind;
+type internalMessageType = MessageType;
+type internalHeaderType = HeaderType;
+type internalValueFormat = ValueFormat;
+declare namespace TMC {
+  export {
+    internalMessage as Message,
+    internalMessageFields as MessageFields,
+    internalMessageKind as MessageKind,
+    internalMessageType as MessageType,
+    internalHeaderType as HeaderType,
+    internalValueFormat as ValueFormat,
+  };
+}
+
 export = TMC;

package/types/message-fields.d.ts

@@ -13,6 +13,11 @@ declare namespace MessageFields {
   type INTRANET_IP = 'intranet_ip';
   type ID = 'id';
   type TOPIC = 'topic';
+  type MSG = 'msg';
+  type DATAID = 'dataid';
+  type USERID = 'userid';
+  type OUTTIME = 'outtime';
+  type PUBLISHER = 'publisher';
 }
 
 declare class MessageFields {
@@ -30,4 +35,9 @@ declare class MessageFields {
   static INTRANET_IP: MessageFields.INTRANET_IP;
   static ID: MessageFields.ID;
   static TOPIC: MessageFields.TOPIC;
+  static MSG: MessageFields.MSG;
+  static DATAID: MessageFields.DATAID;
+  static USERID: MessageFields.USERID;
+  static OUTTIME: MessageFields.OUTTIME;
+  static PUBLISHER: MessageFields.PUBLISHER;
 }

package/types/message.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-/// <reference path="header-type.d.ts" />
+/// <reference path="message-type.d.ts" />
 /// <reference path="message-kind.d.ts" />
 
 declare class Message {
@@ -7,14 +7,14 @@ declare class Message {
     type?: MessageType.CONNECT | MessageType.CONNECTACK | MessageType.SEND | MessageType.SENDACK,
     kind?: MessageKind.None | MessageKind.PullRequest | MessageKind.Confirm | MessageKind.Data | MessageKind.Failed
   );
-  protocolVersion: number;
-  messageType: number;
+  protocolVersion: 2;
+  messageType: MessageType.CONNECT | MessageType.CONNECTACK | MessageType.SEND | MessageType.SENDACK;
   statusCode?: number;
   statusPhrase?: string;
   flag?: number;
   token?: string;
   content?: MessageContent;
-  with(key: string, value?: number | bigint | string | Buffer | Date): this;
+  with(key: string | MessageKind, value?: number | bigint | string | Buffer | Date): this;
   get buffer(): Buffer;
   static from(buf: Buffer): Message;
 }

package/types/message.in.d.ts

@@ -751,6 +751,10 @@ declare namespace IncomingMessage {
   type TmallAutoTradeModify = Message & { content?: MessageContent & { content?: string | Tmall.Auto.TradeModify } };
   /** {@link Tmall.Auto.TwoWheelsReceiptCreate 天猫汽车 > 天猫二轮车服务工单创建开放} */
   type TmallAutoTwoWheelsReceiptCreate = Message & { content?: MessageContent & { content?: string | Tmall.Auto.TwoWheelsReceiptCreate } };
+  /** {@link Tmall.Car.ContractSign 天猫汽车 > 合同签署消息} */
+  type TmallCarContractSign = Message & { content?: MessageContent & { content?: string | Tmall.Car.ContractSign } };
+  /** {@link Tmall.Car.FinanceMsg 天猫汽车 > 汽车金融消息} */
+  type TmallCarFinanceMsg = Message & { content?: MessageContent & { content?: string | Tmall.Car.FinanceMsg } };
   /** {@link Tmall.Channel.ApplyOrderChange 渠道中心API > 申请单变更消息} */
   type TmallChannelApplyOrderChange = Message & { content?: MessageContent & { content?: string | Tmall.Channel.ApplyOrderChange } };
   /** {@link Tmall.Channel.DeliverOrderChange 渠道中心API > 发货单消息变更} */

package/types/tmall.d.ts

@@ -28,6 +28,25 @@ declare namespace Tmall.Auto {
   }
 }
 
+/** 天猫汽车 */
+declare namespace Tmall.Car {
+  /** 合同签署消息 */
+  interface ContractSign {
+    /** 合同下载地址，有效期10分钟 */
+    contract_url: string;
+    /** 订单id */
+    order_id: number;
+  }
+
+  /** 汽车金融消息 */
+  interface FinanceMsg {
+    /** 订单id */
+    order_id: number;
+    /** 消息类型： FULL_PURCHASE_FINANCE_CANCEL_MSG_TYPE?，因全款购车导致金融取消 REFUND_FINANCE_CANCEL，因退款导致的金融单关闭 */
+    type: string;
+  }
+}
+
 /** 渠道中心API */
 declare namespace Tmall.Channel {
   /** 申请单变更消息 */