libshv-js 3.0.0

package/.github/workflows/lint.yml

@@ -0,0 +1,33 @@
+# vim: sw=2
+name: Lint
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  type-check:
+    name: Type check
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install tsc
+        run: npm install
+      - name: Run tsc
+        run: npx tsc --noEmit
+
+  xo:
+    name: xo
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install tsc
+        run: npm install
+      - name: Run xo
+        run: npx xo --reporter unix src/* test.ts

package/.github/workflows/test.yml

@@ -0,0 +1,25 @@
+# vim: sw=2
+name: Test
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    name: CPON/Chainpack conversions
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: denoland/setup-deno@v1
+        with:
+          deno-version: vx.x.x
+
+      - name: Run tests
+        run: deno run test.ts

package/.xo-config.json

@@ -0,0 +1,33 @@
+{
+    "space": 4,
+    "rules": {
+        "@typescript-eslint/no-unsafe-argument": "off",
+        "@typescript-eslint/no-unsafe-assignment": "off",
+        "@typescript-eslint/no-unsafe-call": "off",
+        "@typescript-eslint/no-unsafe-return": "off",
+
+        "@typescript-eslint/naming-convention": "off",
+        "@typescript-eslint/prefer-promise-reject-errors": "off",
+        "@typescript-eslint/promise-function-async": "off",
+        "capitalized-comments": "off",
+        "max-depth": "off",
+        "@typescript-eslint/padding-line-between-statements": "off",
+        "no-constant-condition": ["error", {
+            "checkLoops": false
+        }],
+        "complexity": "off",
+        "no-bitwise": "off",
+        "object-curly-newline": ["error", {
+            "ImportDeclaration": "never"
+        }],
+        "n/file-extension-in-import": "off",
+        "promise-function-async": "off",
+        "default-case": "off",
+        "prefer-promise-reject-errors": "off",
+        "eslint-disable-next-line prefer-promise-reject-errors": "off",
+        "unicorn/explicit-length-check": "off",
+        "unicorn/no-negated-condition": "off",
+        "unicorn/switch-case-braces": "off",
+        "unicorn/prevent-abbreviations": "off"
+    }
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 silicon-heaven
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# libshv-js
+JavaScript implementation of SHV RPC

package/deno.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "lib": ["dom", "dom.iterable", "deno.window"]
+  },
+  "tasks": {
+    "lint": "deno run --allow-read --allow-write --allow-net --allow-sys --allow-env npm:xo --reporter unix src/*"
+  }
+}

package/examples/websocketosaurus.html

@@ -0,0 +1,44 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<title>WebSocketoSaurus</title>
+		<meta charset="utf-8">
+		<script type="text/javascript" src="../rpcvalue.js"></script>
+		<script type="text/javascript" src="../cpcontext.js"></script>
+		<script type="text/javascript" src="../chainpack.js"></script>
+		<script type="text/javascript" src="../cpon.js"></script>
+		<script type="text/javascript" src="../bint.js"></script>
+		<script type="text/javascript" src="../rpcmessage.js"></script>
+		<script type="text/javascript" src="../ws_client.js"></script>
+	</head>
+	<body>
+		<h1>WebSocketoSaurus</h1>
+		<h2>WebSocket Shv Broker test Client</h1>
+		<p>
+			Uri <input type="text" id="edUri" style="width:50em;"/>
+		</p>
+		<p>
+			user <input type="text" id="edUser"/>
+			password <input type="password" id="edPassword"/>
+		</p>
+		<p>
+			<button onClick="initWebSocket(true);">Connect ChainPack</button>
+			<button onClick="initWebSocket(false);">Connect Cpon</button>
+			<button onClick="stopWebSocket();">Disconnect</button>
+		</p>
+		<p>
+			<input type="text" id="edShvPath" onkeydown="if(event.keyCode==13)sendMessage();"/>
+			<input type="text" id="edMethod" onkeydown="if(event.keyCode==13)sendMessage();"/>
+			<input type="text" id="edParams" onkeydown="if(event.keyCode==13)sendMessage();"/>
+			<button onClick="sendMessage();">Send</button>
+		</p>
+		<p>
+			<textarea id="txtResult" style="width:50em;height:100px;"></textarea>
+		</p>
+		<p>
+			<textarea id="txtLog" style="width:50em;height:200px;"></textarea>
+		</p>
+
+		<script type="text/javascript" src="websocketosaurus.js" ></script>
+	</body>
+</html>

package/examples/websocketosaurus.js

@@ -0,0 +1,94 @@
+//document.getElementById("edUri").value = "wss://nirvana.elektroline.cz:3778";
+document.getElementById("edUri").value = "wss://localhost:3778";
+document.getElementById("edUser").value = "user";
+document.getElementById("edPassword").value = "pwd";
+
+document.getElementById("edShvPath").value = ".broker/app";
+document.getElementById("edMethod").value = "echo";
+document.getElementById("edParams").value = "42";
+
+let txtLog = document.getElementById("txtLog");
+
+const debug = (...args) => {
+	let line = "";
+	for (let i = 0; i < args.length; i++) {
+		if (i > 0) {
+			line += " ";
+		}
+		line += args[i];
+	}
+	txtLog.value += line + "\n";
+	txtLog.scrollTop = txtLog.scrollHeight;
+};
+
+let ws_client;
+
+const sendMessage = () => {
+	if (ws_client && ws_client.websocket.readyState == 1 ) {
+		const shv_path = document.getElementById("edShvPath").value;
+		const method = document.getElementById("edMethod").value;
+		const params = document.getElementById("edParams").value;
+
+		ws_client.callRpcMethod(shv_path, method, params).then((rpc_msg) => {
+			const txtResult = document.getElementById("txtResult");
+			// result == 2
+			// error == 3
+			const err = rpc_msg.error();
+			if (err) {
+				txtResult.value = err.toString();
+				txtResult.style.background = "salmon";
+			} else {
+				const result = rpc_msg.result();
+				txtResult.value = result.toString();
+				txtResult.style.background = "";
+			}
+		});
+	}
+}
+
+const initWebSocket = (use_chainpack) => {
+	const wsUri = document.getElementById("edUri").value;
+	const user = document.getElementById("edUser").value;
+	const password = document.getElementById("edPassword").value;
+
+
+	const isUseCpon = !use_chainpack;
+	const txtLog = document.getElementById("txtLog");
+	txtLog.value = `Connection to shvbroker using ${isUseCpon? "Cpon": "ChainPack"}serialization.`;
+	try {
+		ws_client = new WsClient({
+			user,
+			password,
+			wsUri,
+			logDebug: debug,
+			onRequest: (rpc_msg) => {
+				const method = rpc_msg.method().asString();
+				const resp = new RpcMessage();
+				if(method == "dir") {
+					resp.setResult(["ls", "dir", "appName"]);
+				}
+				else if(method == "ls") {
+					resp.setResult([]);
+				}
+				else if(method == "appName") {
+					resp.setResult("websocketosaurus");
+				}
+				else {
+					debug(`ERROR: Method: ${method} is not defined.`);
+					resp.setError(`Method: ${method} is not defined.`);
+				}
+				resp.setRequestId(rpc_msg.requestId());
+				resp.setCallerIds(rpc_msg.callerIds());
+				ws_client.sendRpcMessage(resp);
+			}
+		});
+	} catch (exception) {
+		debug(`EXCEPTION: ${exception}`);
+	}
+};
+
+const stopWebSocket = () => {
+	if (websocket) {
+		websocket.close();
+	}
+};

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "libshv-js",
+  "version": "3.0.0",
+  "description": "Typescript implementation of libshv",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Elektroline",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/silicon-heaven/libshv-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/silicon-heaven/libshv-js/issues"
+  },
+  "homepage": "https://github.com/silicon-heaven/libshv-js",
+  "exports": {
+    "./bint.ts": "./src/bint.ts",
+    "./chainpack.ts": "./src/chainpack.ts",
+    "./cpcontext.ts": "./src/cpcontext.ts",
+    "./cpon.ts": "./src/cpon.ts",
+    "./rpcmessage.ts": "./src/rpcmessage.ts",
+    "./rpcvalue.ts": "./src/rpcvalue.ts",
+    "./ws-client.ts": "./src/ws-client.ts"
+  },
+  "devDependencies": {
+    "typescript": "^5.5.4",
+    "xo": "^0.59.3"
+  }
+}