Merge pull request #1 from wx-chevalier/master

chore: update client

package.json

@@ -2,13 +2,16 @@
   "name": "ts-linker-sdk",
   "version": "1.0.5",
   "description": "linker's ts sdk",
-  "main": "lib/src/client.js",
+  "main": "dist/index.js",
+  "types": "dist/types/index.d.ts",
   "scripts": {
     "type-check": "tsc --noEmit",
     "type-check:watch": "npm run type-check -- --watch",
     "start": "webpack-dev-server --mode development",
     "test": "jest",
-    "build": "tsc"
+    "build": "npm run clean && npm run build:cjs",
+    "build:cjs": "tsc --project ./tsconfig.cjs.json",
+    "clean": "rimraf dist"
   },
   "repository": {
     "type": "git",
@@ -18,7 +21,8 @@
   "license": "private",
   "dependencies": {
     "crypto-js": "^3.1.9-1",
-    "node-int64": "^0.4.0"
+    "node-int64": "^0.4.0",
+    "rimraf": "^2.6.3"
   },
   "devDependencies": {
     "@babel/cli": "^7.4.4",
@@ -48,5 +52,8 @@
     "webpack": "^4.30.0",
     "webpack-cli": "^3.3.2",
     "webpack-dev-server": "^3.3.1"
-  }
+  },
+  "files": [
+    "dist/"
+  ]
 }

src/client.ts

@@ -5,13 +5,17 @@ import { WebsocketError } from './error';
 
 const clientError = 400;
 
+export interface WebSocketResp {
+  value: object | string;
+}
+
 /**
  * 初始化链接以及收发数据
  */
 class Client {
   private _maxPayload: number;
   private _enableLogger: boolean;
-  private listeners: Map<number, (data: string) => void>;
+  private listeners: Map<number, (data: WebSocketResp) => void>;
   private requestHeader: string;
   private responseHeader: string;
   private url: string;
@@ -26,7 +30,7 @@ class Client {
    * @param readyStateCallback 链接状态回调，可以处理onOpen、onClose、onError
    */
   public constructor(url: string, readyStateCallback: ReadyStateCallback) {
-    this.listeners = new Map<number, (data: string) => void>();
+    this.listeners = new Map<number, (data: WebSocketResp) => void>();
     this.requestHeader = '';
     this.requestHeader = '';
     this._maxPayload = 1024 * 1024;
@@ -70,10 +74,10 @@ class Client {
    * 发送ping请求，来保持长连接
    * @param param 请求参数,比如{"hello":"world"}
    */
-  public async ping(param: object): Promise<string> {
+  public async ping(param: object): Promise<WebSocketResp> {
     return new Promise(
       (
-        resolve: (data: string) => void,
+        resolve: (data: WebSocketResp) => void,
         reject: (err: WebsocketError) => void,
       ): void => {
         if (this.socket.readyState !== this.socket.OPEN) {
@@ -88,7 +92,7 @@ class Client {
 
         this.listeners.set(
           heartbeatOperator,
-          (data: string): void => {
+          (data: WebSocketResp): void => {
             const code = this.getResponseProperty('code');
             if (code !== '') {
               const message = this.getResponseProperty('message');
@@ -128,7 +132,10 @@ class Client {
    * @param param 请求参数，比如{"hello":"world"}
    * @param callback 请求状态回调处理
    */
-  public async request(operator: string, param: object): Promise<string> {
+  public async request(
+    operator: string,
+    param: object,
+  ): Promise<WebSocketResp> {
     return await this.asyncSend(operator, param);
   }
 
@@ -140,7 +147,7 @@ class Client {
    */
   public addMessageListener(
     operator: string,
-    listener: (data: string) => void,
+    listener: (data: WebSocketResp) => void,
   ): void {
     this.listeners.set(Utils.crc32(operator), listener);
   }
@@ -220,14 +227,12 @@ class Client {
 
     return '';
   }
-
   /**
    * 关闭客户端链接
    */
   public close(code?: number, reason?: string): void {
     this.socket.close(code, reason);
   }
-
   /**
    * 创建websocket链接
    */
@@ -287,7 +292,7 @@ class Client {
 
               this.responseHeader = packet.header;
 
-              (this.listeners.get(operator) as (data: string) => void)(
+              (this.listeners.get(operator) as (data: WebSocketResp) => void)(
                 JSON.parse(packet.body),
               );
             }
@@ -312,7 +317,7 @@ class Client {
   /**
    * 断线重连
    */
-  private reconnect(): void {
+  reconnect(): void {
     if (!this.reconnectLock) {
       this.reconnectLock = true;
       if (this._enableLogger) {
@@ -356,10 +361,10 @@ class Client {
    * @param param 请求参数，比如{"hello":"world"}
    * @param callback 请求状态回调处理
    */
-  private asyncSend(operator: string, param: object): Promise<string> {
+  asyncSend(operator: string, param: object): Promise<WebSocketResp> {
     return new Promise(
       (
-        resolve: (data: string) => void,
+        resolve: (data: WebSocketResp) => void,
         reject: (err: WebsocketError) => void,
       ): void => {
         if (this.socket.readyState !== this.socket.OPEN) {
@@ -376,7 +381,7 @@ class Client {
         const listener = Utils.crc32(operator) + sequence;
         this.listeners.set(
           listener,
-          (data: string): void => {
+          (data: WebSocketResp): void => {
             const code = this.getResponseProperty('code');
             if (code !== '') {
               const message = this.getResponseProperty('message');
@@ -413,4 +418,14 @@ class Client {
   }
 }
 
-export { Client };
+let client: Client;
+
+function getClient(url: string, callback: ReadyStateCallback) {
+  if (!client) {
+    client = new Client(url, callback);
+  }
+
+  return client;
+}
+
+export { Client, getClient };

src/index.ts

@@ -0,0 +1,3 @@
+export { WebSocketClient } from './WebSocketClient';
+export { WebsocketError } from './error';
+export { Client } from './client';

tsconfig.cjs.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "rootDir": "./src",
+    "outDir": "dist/cjs",
+    "declaration": true,
+    "declarationDir": "dist/types",
+    "sourceMap": false
+  }
+}

tsconfig.json

@@ -6,21 +6,15 @@
     // Search under node_modules for non-relative imports.
     "moduleResolution": "node",
     // Process & infer types from .js files.
-    "allowJs": true,
+    "allowJs": false,
     // Import non-ES modules as default imports.
     "esModuleInterop": true,
     // Enable strictest settings like strictNullChecks & noImplicitAny.
     "strictNullChecks": true,
     "alwaysStrict": true,
     "sourceMap": true,
-    "rootDirs": [
-      "src",
-      "example"
-    ],
-    "outDir": "lib/",
+    "rootDirs": ["src", "example"],
+    "outDir": "lib/"
   },
-  "include": [
-    "src/**/*",
-    "example/**/*"
-  ]
+  "include": ["src/**/*", "example/**/*"]
 }