libshv-js 3.16.1 → 3.20.0

package/dist/zod.js

@@ -0,0 +1,112 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withMeta = exports.rpcvalue = exports.list = exports.blob = exports.decimal = exports.double = exports.uint = exports.recmap = exports.metamap = exports.imap = exports.map = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const v4_1 = require("zod/v4");
+const rpcvalue_1 = require("./rpcvalue");
+const implMakeMapParser = (mapValidator, _mapBrand, mapName, objectParser) => v4_1.z.custom().check(ctx => {
+    if (!mapValidator(ctx.value)) {
+        ctx.issues.push({
+            expected: 'map',
+            code: 'invalid_type',
+            input: ctx.value,
+            message: `Invalid input: expected ${mapName}, received ${(0, rpcvalue_1.typeName)(ctx.value)}`,
+        });
+        return;
+    }
+    // For record, Zod finds out map brand, and calls the record's value parser with the value. There's no way to detect
+    // it, because Zod does not supply the parser with the key. To prevent this, remove the key before passing the value
+    // to Zod. This unfortunately means that we need to copy the whole object. :/
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    const { [rpcvalue_1.shvMapType]: zodMustNotHaveThis, ...rest } = { ...ctx.value };
+    const parsedObject = objectParser.safeParse(rest);
+    if (!parsedObject.success) {
+        ctx.issues = parsedObject.error.issues;
+    }
+});
+const map = (schema) => implMakeMapParser(rpcvalue_1.isShvMap, 'map', 'ShvMap', v4_1.z.object(schema));
+exports.map = map;
+const imap = (schema) => implMakeMapParser(rpcvalue_1.isIMap, 'imap', 'IMap', v4_1.z.object(schema));
+exports.imap = imap;
+const metamap = (schema) => implMakeMapParser(rpcvalue_1.isMetaMap, 'metamap', 'MetaMap', v4_1.z.object(schema));
+exports.metamap = metamap;
+const recmap = (schema) => implMakeMapParser(val => (0, rpcvalue_1.isShvMap)(val) || (0, rpcvalue_1.isIMap)(val), 'map', 'ShvMap', v4_1.z.record(v4_1.z.any(), schema));
+exports.recmap = recmap;
+const uint = () => v4_1.z.instanceof((rpcvalue_1.UInt));
+exports.uint = uint;
+const double = () => v4_1.z.instanceof(rpcvalue_1.Double);
+exports.double = double;
+const decimal = () => v4_1.z.instanceof(rpcvalue_1.Decimal);
+exports.decimal = decimal;
+const blob = () => v4_1.z.instanceof(ArrayBuffer);
+exports.blob = blob;
+const list = () => v4_1.z.array(v4_1.z.lazy(exports.rpcvalue));
+exports.list = list;
+const withMetaInstanceParser = v4_1.z.instanceof(rpcvalue_1.RpcValueWithMetaData);
+const rpcvalue = () => v4_1.z.lazy(() => v4_1.z.union([
+    v4_1.z.undefined(),
+    v4_1.z.boolean(),
+    v4_1.z.number(),
+    (0, exports.uint)(),
+    (0, exports.double)(),
+    (0, exports.decimal)(),
+    (0, exports.blob)(),
+    v4_1.z.string(),
+    v4_1.z.date(),
+    (0, exports.list)(),
+    (0, exports.recmap)((0, exports.rpcvalue)()),
+    withMetaInstanceParser,
+]));
+exports.rpcvalue = rpcvalue;
+const withMeta = (metaParser, valueParser) => v4_1.z.custom().check(ctx => {
+    if (!withMetaInstanceParser.safeParse(ctx.value).success) {
+        ctx.issues.push({
+            expected: 'map',
+            code: 'invalid_type',
+            input: ctx.value,
+            message: 'Invalid input: expected a value with metadata, got a value with no metadata}',
+        });
+        return;
+    }
+    const parsedMeta = metaParser.safeParse(ctx.value.meta);
+    if (!parsedMeta.success) {
+        ctx.issues = [
+            {
+                expected: 'map',
+                code: 'invalid_type',
+                input: ctx.value,
+                message: 'Wrong RpcValueWithMetaData meta',
+            },
+            ...parsedMeta.error.issues,
+        ];
+        return;
+    }
+    const parsedValue = valueParser.safeParse(ctx.value.value);
+    if (!parsedValue.success) {
+        ctx.issues = [
+            {
+                expected: 'map',
+                code: 'invalid_type',
+                input: ctx.value,
+                message: 'Wrong RpcValueWithMetaData value',
+            },
+            ...parsedValue.error.issues,
+        ];
+    }
+});
+exports.withMeta = withMeta;
+__exportStar(require("zod/v4"), exports);

package/package.json

@@ -1,12 +1,19 @@
 {
   "name": "libshv-js",
-  "version": "3.16.1",
+  "version": "3.20.0",
   "description": "Typescript implementation of libshv",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "tsc -p tsconfig.tests.json && node dist-tests/tests/test.js && node dist-tests/tests/test_json.js && node dist-tests/tests/test_zod.js",
+    "test:ci": "tsc -p tsconfig.tests.json && node dist-tests/tests/test.js && node dist-tests/tests/test_json.js && node dist-tests/tests/test_zod.js",
     "lint": "eslint --format unix src/",
     "fix": "npm run lint -- --fix",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc -p tsconfig.tests.json --noEmit",
+    "build": "tsc"
   },
   "author": "Elektroline",
   "repository": {
@@ -18,16 +25,17 @@
   },
   "homepage": "https://github.com/silicon-heaven/libshv-js",
   "exports": {
-    "./access.ts": "./src/access.ts",
-    "./chainpack.ts": "./src/chainpack.ts",
-    "./cpcontext.ts": "./src/cpcontext.ts",
-    "./cpon.ts": "./src/cpon.ts",
-    "./json.ts": "./src/json.ts",
-    "./rpcmessage.ts": "./src/rpcmessage.ts",
-    "./rpcvalue.ts": "./src/rpcvalue.ts",
-    "./vue-shv.ts": "./src/vue-shv.ts",
-    "./ws-client.ts": "./src/ws-client.ts",
-    "./zod.ts": "./src/zod.ts"
+    ".": "./dist/index.js",
+    "./access": "./dist/access.js",
+    "./chainpack": "./dist/chainpack.js",
+    "./cpcontext": "./dist/cpcontext.js",
+    "./cpon": "./dist/cpon.js",
+    "./json": "./dist/json.js",
+    "./rpcmessage": "./dist/rpcmessage.js",
+    "./rpcvalue": "./dist/rpcvalue.js",
+    "./vue-shv": "./dist/vue-shv.js",
+    "./ws-client": "./dist/ws-client.js",
+    "./zod": "./dist/zod.js"
   },
   "dependencies": {
     "js-pkce": "^2.0.0",

package/.github/workflows/check-version-bump.yml

@@ -1,22 +0,0 @@
-# vim: sw=2
-name: Misc
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
-  cancel-in-progress: true
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-jobs:
-  check-version-bump:
-    name: Check version bump
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Check if version bumped
-        uses: del-systems/check-if-version-bumped@v2
-

package/.github/workflows/lint.yml

@@ -1,33 +0,0 @@
-# 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-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Install tsc
-        run: npm install
-      - name: Run tsc
-        run: npx tsc --noEmit
-
-  xo:
-    name: xo
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Install tsc
-        run: npm install
-      - name: Run linters
-        run: npm run lint

package/.github/workflows/publish.yml

@@ -1,24 +0,0 @@
-# vim: sw=2
-name: Publish
-
-on:
-  push:
-    branches: [ "main" ]
-
-jobs:
-  test:
-    name: Publish new version
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Setup node
-        uses: actions/setup-node@v4
-        with:
-          node-version: '22.x'
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: Publish
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/test.yml

@@ -1,31 +0,0 @@
-# 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-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Install dependencies
-        run: npm install
-
-      - name: Compile
-        run: npx tsc
-
-      - name: Run tests
-        run: |
-          node test.js
-          node test_json.js
-          node test_zod.js

package/eslint.config.js

@@ -1,103 +0,0 @@
-import xo from "eslint-config-xo";
-import typescriptEslintParser from "@typescript-eslint/parser";
-import eslint from '@eslint/js';
-import tseslint from 'typescript-eslint';
-import unicornPlugin from 'eslint-plugin-unicorn';
-
-export default tseslint.config(
-    eslint.configs.recommended,
-    eslint.configs.recommended,
-    ...tseslint.configs.recommendedTypeChecked,
-    ...tseslint.configs.stylisticTypeChecked,
-    unicornPlugin.configs.recommended,
-    ...xo,
-    {
-        languageOptions: {
-            parser: typescriptEslintParser,
-            parserOptions: {
-                project: "./tsconfig.json",
-            },
-        },
-        rules: {
-            "@stylistic/indent": ["error", 4],
-            "@stylistic/indent-binary-ops": ["error", 4],
-            "@stylistic/max-len": ["off"],
-            "@stylistic/multiline-ternary": ["off"],
-            "@stylistic/function-paren-newline": ["off"],
-            "@typescript-eslint/no-misused-promises": ["error", {
-                checksVoidReturn: false
-            }],
-            "@typescript-eslint/no-unsafe-assignment": ["off"],
-            "@typescript-eslint/no-unsafe-call": ["off"],
-            "@typescript-eslint/no-unsafe-enum-comparison": ["off"],
-            "@typescript-eslint/consistent-type-definitions": ["error",
-                "type"
-            ],
-            "@typescript-eslint/array-type": ["error", {
-                default: "array-simple"
-            }],
-            "@typescript-eslint/naming-convention": ["error",
-                {
-                    "selector": "variableLike",
-                    "format": ["camelCase"]
-                },
-                {
-                    "selector": "variableLike",
-                    "format": null,
-                    "modifiers": ["unused"]
-                },
-                {
-                    "format": ["camelCase", "UPPER_CASE"],
-                    "selector": "variable",
-                    "modifiers": ["const"]
-                },
-                {
-                    "format": ["PascalCase"],
-                    "selector": "variable",
-                    "modifiers": ["const"],
-                    "filter": "Validation$|Zod$"
-                }
-            ],
-            "@typescript-eslint/prefer-promise-reject-errors": "off",
-            "@typescript-eslint/promise-function-async": "off",
-            "@typescript-eslint/strict-boolean-expressions": ["error",
-                {
-                    "allowString": false,
-                    "allowNumber": false,
-                    "allowNullableObject": false
-                }
-            ],
-            "@typescript-eslint/triple-slash-reference": "off",
-            "capitalized-comments": "off",
-            "@stylistic/object-curly-newline": ["error", {
-                "ImportDeclaration": "never"
-            }],
-            "n/file-extension-in-import": "off",
-            "promise-function-async": "off",
-            "camelcase": "off",
-            "default-case": "off",
-            "import/extensions": "off",
-            "import/no-unassigned-import": "off",
-            "no-dupe-class-members": "off",
-            "no-negated-condition": "off",
-            "no-redeclare": "off",
-            "no-unused-vars": "off",
-            "no-useless-constructor": "off",
-            "no-void": ["error", {
-                allowAsStatement: true
-            }],
-            "no-warning-comments": "off",
-            "prefer-promise-reject-errors": "off",
-            "unicorn/consistent-function-scoping": "off",
-            "unicorn/explicit-length-check": "off",
-            "unicorn/filename-case": "off",
-            "unicorn/no-negated-condition": "off",
-            "unicorn/no-useless-undefined": ["error", {
-                checkArguments: false
-            }],
-            "unicorn/prefer-top-level-await": "off",
-            "unicorn/switch-case-braces": "off",
-            "unicorn/prevent-abbreviations": "off",
-        }
-    }
-);

package/examples/websocketosaurus.html

@@ -1,44 +0,0 @@
-<!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

@@ -1,94 +0,0 @@
-//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/src/access.ts

@@ -1,103 +0,0 @@
-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}`);
-    }
-};