@rfkit/json-rpc-websocket 0.1.0

package/README.md

@@ -0,0 +1,44 @@
+# [json-rpc-websocket](https://github.com/Hxgh/json-rpc-websocket)
+
+基于WebSocket+JSONRPC+msgpack+TypeScript封装的实时通讯函数
+- [msgpack-lite](https://github.com/kawanet/msgpack-lite/)
+- [JSON-RPC 2.0](http://wiki.geekdream.com/Specification/json-rpc_2.0.html)
+
+### 安装
+
+```sh
+pnpm add json-rpc-websocket
+```
+### 使用
+```
+import Socket, { SocketType } from 'json-rpc-websocket';
+
+const socket: SocketType = new Socket({ url: 'ws://url' });
+
+// 普通模式
+socket.send({
+    method: 'msg',
+    callback: e => {
+      console.log(e);
+    },
+});
+
+// 流模式
+const stream = socket.stream({
+    method: 'start',
+    callback: e => {
+      console.log(e);
+    },
+    onerror: e => {
+      console.log('处理超时 || 处理send无法启动');
+    },
+});
+stream.close();
+
+// 接收所有消息
+const socket = new Socket({
+  url: 'ws://url',
+  onmessage: (res: Object) => console.log(res),
+});
+
+```

package/index.d.ts

@@ -0,0 +1,4 @@
+import Socket from './socket';
+import type { SocketType } from './type';
+export default Socket;
+export type { SocketType };

package/index.js

@@ -0,0 +1 @@
+var __webpack_modules__={"./src/msgpack/index.js":function(module,__unused_webpack_exports,__webpack_require__){module=__webpack_require__.nmd(module);(function(){"use strict";function serialize(data,options){if(options&&options.multiple&&!Array.isArray(data))throw new Error("Invalid argument type: Expected an Array to serialize multiple values.");const pow32=0x100000000;let floatBuffer,floatView;let array=new Uint8Array(128);let length=0;if(options&&options.multiple)for(let i=0;i<data.length;i++)append(data[i]);else append(data);return array.subarray(0,length);function append(data,isReplacement){switch(typeof data){case"undefined":appendNull(data);break;case"boolean":appendBoolean(data);break;case"number":appendNumber(data);break;case"string":appendString(data);break;case"object":if(null===data)appendNull(data);else if(data instanceof Date)appendDate(data);else if(Array.isArray(data))appendArray(data);else if(data instanceof Uint8Array||data instanceof Uint8ClampedArray)appendBinArray(data);else if(data instanceof Int8Array||data instanceof Int16Array||data instanceof Uint16Array||data instanceof Int32Array||data instanceof Uint32Array||data instanceof Float32Array||data instanceof Float64Array)appendArray(data);else appendObject(data);break;default:if(!isReplacement&&options&&options.invalidTypeReplacement)"function"==typeof options.invalidTypeReplacement?append(options.invalidTypeReplacement(data),true):append(options.invalidTypeReplacement,true);else throw new Error("Invalid argument type: The type '"+typeof data+"' cannot be serialized.")}}function appendNull(data){appendByte(192)}function appendBoolean(data){appendByte(data?195:194)}function appendNumber(data){if(isFinite(data)&&Math.floor(data)===data){if(data>=0&&data<=127)appendByte(data);else if(data<0&&data>=-32)appendByte(data);else if(data>0&&data<=255)appendBytes([204,data]);else if(data>=-128&&data<=127)appendBytes([208,data]);else if(data>0&&data<=65535)appendBytes([205,data>>>8,data]);else if(data>=-32768&&data<=32767)appendBytes([209,data>>>8,data]);else if(data>0&&data<=0xffffffff)appendBytes([206,data>>>24,data>>>16,data>>>8,data]);else if(data>=-0x80000000&&data<=0x7fffffff)appendBytes([210,data>>>24,data>>>16,data>>>8,data]);else if(data>0&&data<=0xffffffffffffffff){let hi=data/pow32;let lo=data%pow32;appendBytes([211,hi>>>24,hi>>>16,hi>>>8,hi,lo>>>24,lo>>>16,lo>>>8,lo])}else if(data>=-0x8000000000000000&&data<=0x8000000000000000){appendByte(211);appendInt64(data)}else data<0?appendBytes([211,128,0,0,0,0,0,0,0]):appendBytes([207,255,255,255,255,255,255,255,255])}else{if(!floatView){floatBuffer=new ArrayBuffer(8);floatView=new DataView(floatBuffer)}floatView.setFloat64(0,data);appendByte(203);appendBytes(new Uint8Array(floatBuffer))}}function appendString(data){let bytes=encodeUtf8(data);let length=bytes.length;if(length<=31)appendByte(160+length);else if(length<=255)appendBytes([217,length]);else length<=65535?appendBytes([218,length>>>8,length]):appendBytes([219,length>>>24,length>>>16,length>>>8,length]);appendBytes(bytes)}function appendArray(data){let length=data.length;if(length<=15)appendByte(144+length);else length<=65535?appendBytes([220,length>>>8,length]):appendBytes([221,length>>>24,length>>>16,length>>>8,length]);for(let index=0;index<length;index++)append(data[index])}function appendBinArray(data){let length=data.length;if(length<=15)appendBytes([196,length]);else length<=65535?appendBytes([197,length>>>8,length]):appendBytes([198,length>>>24,length>>>16,length>>>8,length]);appendBytes(data)}function appendObject(data){let length=0;for(let key in data)if(void 0!==data[key])length++;if(length<=15)appendByte(128+length);else length<=65535?appendBytes([222,length>>>8,length]):appendBytes([223,length>>>24,length>>>16,length>>>8,length]);for(let key in data){let value=data[key];if(void 0!==value){append(key);append(value)}}}function appendDate(data){let sec=data.getTime()/1e3;if(0===data.getMilliseconds()&&sec>=0&&sec<0x100000000)appendBytes([214,255,sec>>>24,sec>>>16,sec>>>8,sec]);else if(sec>=0&&sec<0x400000000){let ns=1e6*data.getMilliseconds();appendBytes([215,255,ns>>>22,ns>>>14,ns>>>6,ns<<2>>>0|sec/pow32,sec>>>24,sec>>>16,sec>>>8,sec])}else{let ns=1e6*data.getMilliseconds();appendBytes([199,12,255,ns>>>24,ns>>>16,ns>>>8,ns]);appendInt64(sec)}}function appendByte(byte){if(array.length<length+1){let newLength=2*array.length;while(newLength<length+1)newLength*=2;let newArray=new Uint8Array(newLength);newArray.set(array);array=newArray}array[length]=byte;length++}function appendBytes(bytes){if(array.length<length+bytes.length){let newLength=2*array.length;while(newLength<length+bytes.length)newLength*=2;let newArray=new Uint8Array(newLength);newArray.set(array);array=newArray}array.set(bytes,length);length+=bytes.length}function appendInt64(value){let hi,lo;if(value>=0){hi=value/pow32;lo=value%pow32}else{value++;hi=Math.abs(value)/pow32;lo=Math.abs(value)%pow32;hi=~hi;lo=~lo}appendBytes([hi>>>24,hi>>>16,hi>>>8,hi,lo>>>24,lo>>>16,lo>>>8,lo])}}function deserialize(array,options){const pow32=0x100000000;let pos=0;if(array instanceof ArrayBuffer)array=new Uint8Array(array);if("object"!=typeof array||void 0===array.length)throw new Error("Invalid argument type: Expected a byte array (Array or Uint8Array) to deserialize.");if(!array.length)throw new Error("Invalid argument: The byte array to deserialize is empty.");if(!(array instanceof Uint8Array))array=new Uint8Array(array);let data;if(options&&options.multiple){data=[];while(pos<array.length)data.push(read())}else data=read();return data;function read(){const byte=array[pos++];if(byte>=0&&byte<=127)return byte;if(byte>=128&&byte<=143)return readMap(byte-128);if(byte>=144&&byte<=159)return readArray(byte-144);if(byte>=160&&byte<=191)return readStr(byte-160);if(192===byte)return null;if(193===byte)throw new Error("Invalid byte code 0xc1 found.");if(194===byte)return false;if(195===byte)return true;if(196===byte)return readBin(-1,1);if(197===byte)return readBin(-1,2);if(198===byte)return readBin(-1,4);if(199===byte)return readExt(-1,1);if(200===byte)return readExt(-1,2);if(201===byte)return readExt(-1,4);if(202===byte)return readFloat(4);if(203===byte)return readFloat(8);if(204===byte)return readUInt(1);if(205===byte)return readUInt(2);if(206===byte)return readUInt(4);if(207===byte)return readUInt(8);if(208===byte)return readInt(1);if(209===byte)return readInt(2);if(210===byte)return readInt(4);if(211===byte)return readInt(8);if(212===byte)return readExt(1);if(213===byte)return readExt(2);if(214===byte)return readExt(4);if(215===byte)return readExt(8);if(216===byte)return readExt(16);if(217===byte)return readStr(-1,1);if(218===byte)return readStr(-1,2);if(219===byte)return readStr(-1,4);if(220===byte)return readArray(-1,2);if(221===byte)return readArray(-1,4);if(222===byte)return readMap(-1,2);if(223===byte)return readMap(-1,4);if(byte>=224&&byte<=255)return byte-256;console.debug("msgpack array:",array);throw new Error("Invalid byte value '"+byte+"' at index "+(pos-1)+" in the MessagePack binary data (length "+array.length+"): Expecting a range of 0 to 255. This is not a byte array.")}function readInt(size){let value=0;let first=true;while(size-- >0)if(first){let byte=array[pos++];value+=127&byte;if(128&byte)value-=128;first=false}else{value*=256;value+=array[pos++]}return value}function readUInt(size){let value=0;while(size-- >0){value*=256;value+=array[pos++]}return value}function readFloat(size){let view=new DataView(array.buffer,pos+array.byteOffset,size);pos+=size;if(4===size)return view.getFloat32(0,false);if(8===size)return view.getFloat64(0,false)}function readBin(size,lengthSize){if(size<0)size=readUInt(lengthSize);let data=array.subarray(pos,pos+size);pos+=size;return data}function readMap(size,lengthSize){if(size<0)size=readUInt(lengthSize);let data={};while(size-- >0){let key=read();data[key]=read()}return data}function readArray(size,lengthSize){if(size<0)size=readUInt(lengthSize);let data=[];while(size-- >0)data.push(read());return data}function readStr(size,lengthSize){if(size<0)size=readUInt(lengthSize);let start=pos;pos+=size;return decodeUtf8(array,start,size)}function readExt(size,lengthSize){if(size<0)size=readUInt(lengthSize);let type=readUInt(1);let data=readBin(size);switch(type){case 255:return readExtDate(data)}return{type:type,data:data}}function readExtDate(data){if(4===data.length){let sec=(data[0]<<24>>>0)+(data[1]<<16>>>0)+(data[2]<<8>>>0)+data[3];return new Date(1e3*sec)}if(8===data.length){let ns=(data[0]<<22>>>0)+(data[1]<<14>>>0)+(data[2]<<6>>>0)+(data[3]>>>2);let sec=(3&data[3])*pow32+(data[4]<<24>>>0)+(data[5]<<16>>>0)+(data[6]<<8>>>0)+data[7];return new Date(1e3*sec+ns/1e6)}if(12===data.length){let ns=(data[0]<<24>>>0)+(data[1]<<16>>>0)+(data[2]<<8>>>0)+data[3];pos-=8;let sec=readInt(8);return new Date(1e3*sec+ns/1e6)}throw new Error("Invalid data length for a date value.")}}function encodeUtf8(str){let ascii=true,length=str.length;for(let x=0;x<length;x++)if(str.charCodeAt(x)>127){ascii=false;break}let i=0,bytes=new Uint8Array(str.length*(ascii?1:4));for(let ci=0;ci!==length;ci++){let c=str.charCodeAt(ci);if(c<128){bytes[i++]=c;continue}if(c<2048)bytes[i++]=c>>6|192;else{if(c>55295&&c<56320){if(++ci>=length)throw new Error("UTF-8 encode: incomplete surrogate pair");let c2=str.charCodeAt(ci);if(c2<56320||c2>57343)throw new Error("UTF-8 encode: second surrogate character 0x"+c2.toString(16)+" at index "+ci+" out of range");c=65536+((1023&c)<<10)+(1023&c2);bytes[i++]=c>>18|240;bytes[i++]=c>>12&63|128}else bytes[i++]=c>>12|224;bytes[i++]=c>>6&63|128}bytes[i++]=63&c|128}return ascii?bytes:bytes.subarray(0,i)}function decodeUtf8(bytes,start,length){let i=start,str="";length+=start;while(i<length){let c=bytes[i++];if(c>127){if(c>191&&c<224){if(i>=length)throw new Error("UTF-8 decode: incomplete 2-byte sequence");c=(31&c)<<6|63&bytes[i++]}else if(c>223&&c<240){if(i+1>=length)throw new Error("UTF-8 decode: incomplete 3-byte sequence");c=(15&c)<<12|(63&bytes[i++])<<6|63&bytes[i++]}else if(c>239&&c<248){if(i+2>=length)throw new Error("UTF-8 decode: incomplete 4-byte sequence");c=(7&c)<<18|(63&bytes[i++])<<12|(63&bytes[i++])<<6|63&bytes[i++]}else throw new Error("UTF-8 decode: unknown multibyte start 0x"+c.toString(16)+" at index "+(i-1))}if(c<=65535)str+=String.fromCharCode(c);else if(c<=1114111){c-=65536;str+=String.fromCharCode(c>>10|55296);str+=String.fromCharCode(1023&c|56320)}else throw new Error("UTF-8 decode: code point 0x"+c.toString(16)+" exceeds UTF-16 reach")}return str}let msgpack={serialize:serialize,deserialize:deserialize,encode:serialize,decode:deserialize};if(module&&"object"==typeof module.exports)module.exports=msgpack;else window[window.msgpackJsName||"msgpack"]=msgpack})()}};var __webpack_module_cache__={};function __webpack_require__(moduleId){var cachedModule=__webpack_module_cache__[moduleId];if(void 0!==cachedModule)return cachedModule.exports;var module=__webpack_module_cache__[moduleId]={id:moduleId,loaded:false,exports:{}};__webpack_modules__[moduleId](module,module.exports,__webpack_require__);module.loaded=true;return module.exports}(()=>{__webpack_require__.nmd=function(module){module.paths=[];if(!module.children)module.children=[];return module}})();var msgpack=__webpack_require__("./src/msgpack/index.js");const generateHexSegment=()=>((1+Math.random())*65536|0).toString(16).substring(1);const generateUUID=()=>[generateHexSegment()+generateHexSegment(),generateHexSegment(),generateHexSegment(),generateHexSegment(),generateHexSegment()+generateHexSegment()+generateHexSegment()].join("-");const generateId=(length=8)=>{let result="";const characters="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";const charactersLength=characters.length;for(let i=0;i<length;i++)result+=characters.charAt(Math.floor(Math.random()*charactersLength));return result};const defaultProps={onopen:()=>{},onmessage:()=>{},onclose:()=>{},onerror:()=>{}};class Socket{props;guidStorage=[];callbackStorage={};ws;streamID="";constructor(props){this.props={jsonrpc:"2.0",...defaultProps,...props};this.ws=this.setupWS()}setupWS(){const ws=new WebSocket(this.props.url,this.props.protocols);ws.binaryType="arraybuffer";ws.onopen=e=>this.props.onopen(e);ws.onmessage=e=>this.onmessage(e);ws.onclose=e=>this.props.onclose(e);ws.onerror=e=>this.props.onerror(e);return ws}saveGUID(guid){this.guidStorage.push(guid);return guid}deleteGUID(guid){const arr=this.guidStorage;const index=arr.indexOf(guid);if(-1!==index){arr.splice(index,1);return true}return false}touchTimeout(id,time=15e3,onerror=()=>{}){setTimeout(()=>{if(this.guidStorage.includes(id)){onerror({code:408,message:"发送数据链接超时"});this.deleteGUID(id)}},time)}saveResponse(callback,id){this.callbackStorage[id]=callback}finishResponse(res,id){const callback=this.callbackStorage[id];if(void 0!==this.callbackStorage[id]&&callback){callback(res);if(id!==this.streamID)delete this.callbackStorage[id]}return id}onmessage(e){const response=(0,msgpack.decode)(Array.prototype.slice.call(new Uint8Array(e.data)));if(!response)return;const{id}=response;if(id&&this.deleteGUID(id))this.finishResponse(response,id);this.props.onmessage(response)}send=data=>{const{id:paramId,method,isInform,callback,onerror,params,timeout}=data;if(1!==this.ws.readyState){if(onerror)onerror({code:3,message:"连接已关闭或者没有链接成功"});return}if(void 0===method)return;let guid={};const id=this.saveGUID(paramId||generateUUID());if(!isInform){guid={id};if(callback)this.saveResponse(callback,id)}this.touchTimeout(id,timeout,onerror);this.ws.send((0,msgpack.encode)({jsonrpc:this.props.jsonrpc,params,method,...guid}))};stream=data=>{const{id:paramId,method,callback,params}=data;if(void 0===method||!callback||1!==this.ws.readyState)return;const id=this.saveGUID(paramId||generateUUID());if(callback)this.saveResponse(callback,id);this.ws.send((0,msgpack.encode)({jsonrpc:this.props.jsonrpc,params,method,id:this.streamID}));return{id:this.streamID,close:(code,reason)=>{this.streamID="";this.close(code,reason)}}};close=(code,reason)=>this.ws.close(code,reason);withUrl=url=>{this.close();this.guidStorage=[];this.callbackStorage={};this.streamID="";this.props.url=url;this.ws=this.setupWS()}}const src=Socket;export{src as default};

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@rfkit/json-rpc-websocket",
+  "description": "A lightweight JSON-RPC 2.0 client implementation over WebSocket, supporting request-response, notifications, and batch processing",
+  "module": "index.js",
+  "types": "index.d.ts",
+  "author": "Hxgh",
+  "license": "MIT",
+  "version": "0.1.0",
+  "private": false,
+  "keywords": [
+    "json-rpc",
+    "websocket",
+    "rpc",
+    "client",
+    "remote-procedure-call",
+    "typescript",
+    "real-time",
+    "communication",
+    "async"
+  ]
+}

package/socket.d.ts

@@ -0,0 +1,103 @@
+import type { PropsType, SocketType, WithUrl } from './type';
+/**
+ * Socket
+ * 基于WebSocket、msgpack、JSONRPC封装的实时通讯函数
+ * @export
+ * @class Socket
+ */
+export default class Socket {
+    private props;
+    private guidStorage;
+    private callbackStorage;
+    ws: WebSocket;
+    private streamID;
+    constructor(props: PropsType);
+    /**
+     * 初始化链接
+     *
+     * @private
+     * @returns {WebSocket}
+     * @memberof Socket
+     */
+    private setupWS;
+    /**
+     * 存储guid
+     *
+     * @private
+     * @param {string} guid
+     * @returns {string}
+     * @memberof Socket
+     */
+    private saveGUID;
+    /**
+     * 删除guid
+     *
+     * @private
+     * @param {string} guid
+     * @returns {boolean}
+     * @memberof Socket
+     */
+    private deleteGUID;
+    /**
+     * send时触发超时函数
+     *
+     * @private
+     * @param {string} guid
+     * @memberof Socket
+     */
+    private touchTimeout;
+    /**
+     * 存储回调方法
+     *
+     * @private
+     * @param {Communicate['callback']} callback
+     * @param {string} id
+     * @memberof Socket
+     */
+    private saveResponse;
+    /**
+     * 执行回调方法并移除
+     *
+     * @private
+     * @param {string} id
+     * @returns
+     * @memberof Socket
+     */
+    private finishResponse;
+    /**
+     * 接收数据
+     *
+     * @param {MessageEvent} buffer
+     * @returns
+     * @memberof Socket
+     */
+    private onmessage;
+    /**
+     * 发送数据
+     *
+     * @param {Communicate} params
+     * @returns
+     * @memberof Socket
+     */
+    send: SocketType['send'];
+    /**
+     * 启用流模式
+     *
+     * @type {SocketType['stream']}
+     * @memberof Socket
+     */
+    stream: SocketType['stream'];
+    /**
+     * 关闭链接
+     *
+     * @memberof Socket
+     */
+    close: SocketType['close'];
+    /**
+     * 更换url
+     *
+     * @type {WithUrl}
+     * @memberof Socket
+     */
+    withUrl: WithUrl;
+}

package/tools.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 生成四位随机数（十六进制）
+ * @returns {string} 四位十六进制随机数
+ */
+export declare const generateHexSegment: () => string;
+/**
+ * 生成全局唯一标识符(UUID)
+ * 格式: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+ * @returns {string} 符合RFC4122标准的UUID字符串
+ */
+export declare const generateUUID: () => string;
+/**
+ * 生成简单的唯一ID（更短的标识符）
+ * @param {number} [length=8] ID的长度
+ * @returns {string} 指定长度的随机ID
+ */
+export declare const generateId: (length?: number) => string;

package/type.d.ts

@@ -0,0 +1,138 @@
+/**
+ * 发送数据时回调函数参数类型
+ *
+ * @export
+ * @interface ResType
+ */
+export interface ResType {
+    jsonrpc: string;
+    result: object;
+    id: string;
+    error?: object;
+    message?: string;
+    data?: string | object;
+    res?: ResType['result'] | ResType['error'] | {
+        message: ResType['message'];
+        data: ResType['data'];
+    };
+}
+/**
+ * 发送数据的参数类型
+ *
+ * @export
+ * @interface Communicate
+ */
+export interface Communicate {
+    jsonrpc?: string;
+    method: string;
+    params?: Record<string, unknown>;
+    id?: string;
+    timeout?: number;
+    isInform?: boolean | undefined;
+    callback?: (res: ResType['res']) => void;
+    onerror?: (res: {
+        code?: string | number;
+        message?: string;
+    }) => void;
+}
+/**
+ * Socket的事件类型
+ *
+ * @export
+ * @interface PropsFuncType
+ */
+export interface PropsFuncType {
+    onopen: (e?: Event) => void;
+    onmessage: (e?: unknown) => void;
+    onclose: (e?: CloseEvent) => void;
+    onerror: (e?: Event) => void;
+}
+/**
+ * Socket的websocket参数类型
+ *
+ * @export
+ * @interface PropsType
+ */
+export interface PropsType {
+    url: string;
+    protocols?: string | string[] | undefined;
+    onopen?: PropsFuncType['onopen'];
+    onmessage?: PropsFuncType['onmessage'];
+    onclose?: PropsFuncType['onclose'];
+    onerror?: PropsFuncType['onerror'];
+    jsonrpc?: string;
+}
+/**
+ * 发送数据时回调函数存储的类型
+ *
+ * @export
+ * @interface CallbackStorage
+ */
+export interface CallbackStorage {
+    [propName: string]: Communicate['callback'];
+}
+/**
+ * 更换url函数的数据类型
+ *
+ * @export
+ * @interface WithUrl
+ */
+export type WithUrl = (url: string) => void;
+/**
+ * stream的类型
+ *
+ * @export
+ * @interface SocketStrem
+ */
+export interface SocketStrem {
+    close: (code?: number, reason?: string) => void;
+}
+/**
+ * 实时通讯函暴露的API类型:public
+ *
+ * @export
+ * @interface SocketType
+ */
+export interface SocketType {
+    send: (send: Communicate) => void;
+    close: (code?: number, reason?: string) => void;
+    stream: (send: Communicate) => {
+        id: string;
+        close: SocketStrem['close'];
+    } | undefined;
+}
+/**
+ * JSON-RPC 2.0 请求对象
+ */
+export interface JsonRpcRequest {
+    jsonrpc: '2.0';
+    method: string;
+    params?: unknown;
+    id?: string | number | null;
+}
+/**
+ * JSON-RPC 2.0 响应对象
+ */
+export interface JsonRpcResponse {
+    jsonrpc: '2.0';
+    result?: unknown;
+    error?: JsonRpcError;
+    id: string | number | null;
+}
+/**
+ * JSON-RPC 2.0 错误对象
+ */
+export interface JsonRpcError {
+    code: number;
+    message: string;
+    data?: unknown;
+}
+/**
+ * 连接选项
+ */
+export interface ConnectionOptions {
+    reconnect?: boolean;
+    reconnectInterval?: number;
+    maxReconnectAttempts?: number;
+    timeout?: number;
+}