libshv-js 3.3.4 → 3.3.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libshv-js",
-  "version": "3.3.4",
+  "version": "3.3.6",
   "description": "Typescript implementation of libshv",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
@@ -17,7 +17,7 @@
   },
   "homepage": "https://github.com/silicon-heaven/libshv-js",
   "exports": {
-    "./bint.ts": "./src/bint.ts",
+    "./access.ts": "./src/access.ts",
     "./chainpack.ts": "./src/chainpack.ts",
     "./cpcontext.ts": "./src/cpcontext.ts",
     "./cpon.ts": "./src/cpon.ts",

package/src/access.ts

@@ -0,0 +1,103 @@
+enum Role {
+    Browse = 'bws',
+    Read = 'rd',
+    Write = 'wr',
+    Command = 'cmd',
+    Config = 'cfg',
+    Service = 'srv',
+    SuperService = 'ssrv',
+    Devel = 'dev',
+    Admin = 'su',
+}
+
+enum AccessLevel {
+    None = 0,
+
+    Browse = 1,
+    Browse1,
+    Browse2,
+    Browse3,
+    Browse4,
+    Browse5,
+    Browse6,
+
+    Read = 8,
+    Read1,
+    Read2,
+    Read3,
+    Read4,
+    Read5,
+    Read6,
+    Read7,
+
+    Write = 16,
+    Write1,
+    Write2,
+    Write3,
+    Write4,
+    Write5,
+    Write6,
+    Write7,
+
+    Command = 24,
+    Command1,
+    Command2,
+    Command3,
+    Command4,
+    Command5,
+    Command6,
+    Command7,
+
+    Config = 32,
+    Config1,
+    Config2,
+    Config3,
+    Config4,
+    Config5,
+    Config6,
+    Config7,
+
+    Service = 40,
+    Service1,
+    Service2,
+    Service3,
+    Service4,
+    Service5,
+    Service6,
+    Service7,
+
+    SuperService = 48,
+    SuperService1,
+    SuperService2,
+    SuperService3,
+    SuperService4,
+    SuperService5,
+    SuperService6,
+    SuperService7,
+
+    Devel = 56,
+    Devel1,
+    Devel2,
+    Devel3,
+    Devel4,
+    Devel5,
+    Devel6,
+    Devel7,
+
+    Admin = 63,
+}
+
+export const accessLevelFromAccessString = (s: string): AccessLevel => {
+    switch (s as unknown) {
+        case Role.Browse: return AccessLevel.Browse;
+        case Role.Read: return AccessLevel.Read;
+        case Role.Write: return AccessLevel.Write;
+        case Role.Command: return AccessLevel.Command;
+        case Role.Config: return AccessLevel.Config;
+        case Role.Service: return AccessLevel.Service;
+        case Role.SuperService: return AccessLevel.SuperService;
+        case Role.Devel: return AccessLevel.Devel;
+        case Role.Admin: return AccessLevel.Admin;
+        default: throw new Error(`unknown access grant string: ${s}`);
+    }
+};

package/src/ws-client.ts

@@ -4,6 +4,7 @@ import {ERROR_MESSAGE, ErrorCode, ERROR_CODE, RpcMessage, type RpcResponse, Meth
 import {type RpcValue, type Null, type Int, type IMap, type ShvMap, makeMap, makeIMap} from './rpcvalue';
 
 const DEFAULT_TIMEOUT = 5000;
+const DEFAULT_PING_INTERVAL = 30 * 1000;
 
 const dataToRpcValue = (buff: ArrayBuffer) => {
     const rd: ChainPackReader | CponReader = new ChainPackReader(buff);
@@ -39,6 +40,7 @@ type WsClientOptions = {
     password: string;
     loginType?: 'PLAIN' | 'AZURE';
     timeout?: number;
+    pingInterval?: number;
     wsUri: string;
     onConnected: () => void;
     onConnectionFailure: (error: Error) => void;
@@ -74,6 +76,8 @@ type DirResult = Array<IMap<{
 
 class WsClient {
     requestId = 1;
+    pingTimerId = -1;
+
     rpcHandlers: Array<{
         resolve: RpcResponseResolver;
         timeout_handle: number;
@@ -92,6 +96,7 @@ class WsClient {
     onDisconnected: WsClientOptions['onDisconnected'];
     onRequest: WsClientOptions['onRequest'];
     timeout: WsClientOptions['timeout'];
+    pingInterval: WsClientOptions['pingInterval'];
 
     constructor(options: WsClientOptions) {
         if (typeof options !== 'object') {
@@ -108,6 +113,7 @@ class WsClient {
         this.websocket = new WebSocket(options.wsUri);
         this.websocket.binaryType = 'arraybuffer';
 
+        this.pingInterval = options.pingInterval ?? DEFAULT_PING_INTERVAL;
         this.onConnected = options.onConnected ?? (() => {/* nothing */});
         this.onConnectionFailure = options.onConnectionFailure ?? (() => {/* nothing */});
         this.onDisconnected = options.onDisconnected ?? (() => {/* nothing */});
@@ -144,6 +150,9 @@ class WsClient {
                 }
                 this.logDebug('SUCCESS: connected to shv broker');
                 this.onConnected();
+                this.pingTimerId = window.setInterval(() => {
+                    this.sendPing();
+                }, this.pingInterval);
             }).catch(() => {
                 this.logDebug('FAILURE: couldn\' connected to shv broker');
             });
@@ -153,6 +162,7 @@ class WsClient {
             this.logDebug('DISCONNECTED');
             this.subscriptions.length = 0;
             this.onDisconnected();
+            window.clearInterval(this.pingTimerId);
         });
 
         this.websocket.addEventListener('message', evt => {
@@ -223,7 +233,7 @@ class WsClient {
     }
 
     sendRpcMessage(rpc_msg: RpcMessage) {
-        if (this.websocket && this.websocket.readyState === 1) {
+        if (this.websocket && this.websocket.readyState === WebSocket.OPEN) {
             this.logDebug('sending rpc message:', rpc_msg.toCpon());
             const msg_data = new Uint8Array(rpc_msg.toChainPack());
 
@@ -284,6 +294,12 @@ class WsClient {
         });
     }
 
+    sendPing() {
+        this.callRpcMethod('.broker/app', 'ping').catch((error: unknown) => {
+            console.log('Failed to send ping:', error);
+        });
+    }
+
     accessGrantForMethodCall(path: string, method: string) {
         return this.callRpcMethod('.broker/currentClient', 'accessGrantForMethodCall', [path, method]);
     }