libshv-js 3.13.0 → 3.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libshv-js",
-  "version": "3.13.0",
+  "version": "3.15.0",
   "description": "Typescript implementation of libshv",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",

package/src/ws-client.ts

@@ -1,7 +1,9 @@
+import {accessLevelFromAccessString} from './access';
 import {ChainPackReader, CHAINPACK_PROTOCOL_TYPE, ChainPackWriter, toChainPack} from './chainpack';
 import {type CponReader, CPON_PROTOCOL_TYPE, toCpon} from './cpon';
 import {ERROR_MESSAGE, ErrorCode, ERROR_CODE, RpcMessageZod, type RpcMessage, isSignal, isRequest, type RpcRequest, isResponse, ERROR_DATA, type ErrorMap, RPC_MESSAGE_METHOD, RPC_MESSAGE_SHV_PATH, RPC_MESSAGE_REQUEST_ID, RPC_MESSAGE_PARAMS, RPC_MESSAGE_ERROR, RPC_MESSAGE_RESULT, RPC_MESSAGE_CALLER_IDS, RpcResponseValue, RPC_MESSAGE_DELAY, RPC_MESSAGE_ABORT, RpcSignal, RpcResponse, RPC_MESSAGE_ACCESS_LEVEL} from './rpcmessage';
 import {type RpcValue, type Null, type Int, type IMap, type ShvMap, makeMap, makeIMap, RpcValueWithMetaData, makeMetaMap, Double} from './rpcvalue';
+import * as z from './zod';
 
 const DEFAULT_TIMEOUT = 5000;
 const DEFAULT_PING_INTERVAL = 30 * 1000;
@@ -60,12 +62,24 @@ export class RequestHandler {
     }
 }
 
-type RequestHandlerParams = {
-    shvPath: string;
-    method: string;
-    param: RpcValue;
-    accessLevel: number;
-    delay: (progress: number) => void;
+export const LsParamZod = z.undefined().or(z.string());
+export const DirParamZod = z.undefined().or(z.boolean()).or(z.string());
+
+export type DirEntry = IMap<{
+    [DIR_NAME]: string;
+    [DIR_FLAGS]: number;
+    [DIR_PARAM]: string | Null;
+    [DIR_RESULT]: string | Null;
+    [DIR_ACCESS]: Int;
+    [DIR_SIGNALS]: ShvMap<Record<string, string | Null>>;
+    [DIR_EXTRA]: ShvMap;
+}>;
+
+export type DirResult = DirEntry[];
+
+export type MethodHandler = {
+    paramParser: z.ZodType<RpcValue>,
+    handler: (shvPath: string, method: string, params: RpcValue, delay: (progress: number) => void) => Promise<RpcValue> | RpcValue | RequestHandler,
 };
 
 type WsClientOptionsLogin = WsClientOptionsCommon & {
@@ -76,7 +90,10 @@ type WsClientOptionsLogin = WsClientOptionsCommon & {
     onConnected: () => void;
     onConnectionFailure: (error: Error) => void;
     onDisconnected: () => void;
-    onRequest: (request: RequestHandlerParams) => RpcValue | Promise<RpcValue> | RequestHandler;
+    onRequest: (shvPath: string) => {
+        ls: (shvPath: string) => string[] | Promise<string[]>;
+        dirEntries: Array<{entry: DirEntry} & MethodHandler>;
+    } | undefined;
 };
 
 type WsClientOptionsWorkflows = WsClientOptionsCommon & {
@@ -102,15 +119,6 @@ export const DIR_RESULT = 4;
 export const DIR_ACCESS = 5;
 export const DIR_SIGNALS = 6;
 export const DIR_EXTRA = 63;
-export type DirResult = Array<IMap<{
-    [DIR_NAME]: string;
-    [DIR_FLAGS]: DirFlags;
-    [DIR_PARAM]: string | Null;
-    [DIR_RESULT]: string | Null;
-    [DIR_ACCESS]: Int;
-    [DIR_SIGNALS]: ShvMap<Record<string, string | Null>>;
-    [DIR_EXTRA]: ShvMap;
-}>>;
 
 class RpcError extends Error {
     constructor(readonly err_info: ErrorMap) {
@@ -224,6 +232,7 @@ class WsClient {
             }
         };
 
+        // eslint-disable-next-line complexity
         const handleRequest = async (request: RpcRequest) => {
             if ('onRequest' in this.options) {
                 const requestId = request.meta[RPC_MESSAGE_REQUEST_ID];
@@ -246,9 +255,12 @@ class WsClient {
                 if (RPC_MESSAGE_ABORT in request.value) {
                     const requestHandler = this.requestHandlers.get(requestId);
 
-                    if (request.value[RPC_MESSAGE_ABORT] === true && requestHandler?.options.onAbort !== undefined) {
+                    if (request.value[RPC_MESSAGE_ABORT] === true) {
                         this.abortedRequests.add(requestId);
-                        requestHandler.options.onAbort();
+
+                        if (requestHandler?.options.onAbort !== undefined) {
+                            requestHandler.options.onAbort();
+                        }
                     }
 
                     if (request.value[RPC_MESSAGE_ABORT] === false && requestHandler?.options.onProgressQuery !== undefined) {
@@ -261,19 +273,94 @@ class WsClient {
 
                 try {
                     const shvPath = request.meta[RPC_MESSAGE_SHV_PATH];
-                    const method = request.meta[RPC_MESSAGE_METHOD];
+                    const methodName = request.meta[RPC_MESSAGE_METHOD];
+                    const unhandledMethod = () => {
+                        throw new MethodNotFound(`No such path '${shvPath}' or method '${methodName}' or insufficient access rights.`);
+                    };
+
                     const accessLevel = request.meta[RPC_MESSAGE_ACCESS_LEVEL];
                     if (accessLevel === undefined) {
-                        throw new MethodNotFound(`Unknown method ${method} on path ${shvPath}`);
+                        unhandledMethod();
+                        return;
+                    }
+
+                    const methods = this.options.onRequest(shvPath);
+                    if (methods === undefined) {
+                        unhandledMethod();
+                        return;
                     }
 
-                    let result = this.options.onRequest({
+                    const methodDefinition = ((): {entry: DirEntry} & MethodHandler | undefined => {
+                        const dirEntry = makeIMap({
+                            [DIR_NAME]: 'dir',
+                            [DIR_FLAGS]: 0,
+                            [DIR_PARAM]: 'DirParam',
+                            [DIR_RESULT]: 'DirResult',
+                            [DIR_ACCESS]: accessLevelFromAccessString('bws'),
+                            [DIR_SIGNALS]: makeMap({}),
+                            [DIR_EXTRA]: makeMap({}),
+                        });
+                        const lsEntry = makeIMap({
+                            [DIR_NAME]: 'ls',
+                            [DIR_FLAGS]: 0,
+                            [DIR_PARAM]: 'LsParam',
+                            [DIR_RESULT]: 'LsResult',
+                            [DIR_ACCESS]: accessLevelFromAccessString('bws'),
+                            [DIR_SIGNALS]: makeMap({}),
+                            [DIR_EXTRA]: makeMap({}),
+                        });
+                        switch (methodName) {
+                            case 'dir':
+                                return {
+                                    entry: dirEntry,
+                                    paramParser: DirParamZod,
+                                    handler(_shvPath, _method, param) {
+                                        const methodsResult = [dirEntry, lsEntry, ...methods.dirEntries.map(method => method.entry)];
+                                        switch (true) {
+                                            case typeof param === 'string':
+                                                return methodsResult.find(method => method[DIR_NAME] === param) ?? false;
+                                            case typeof param === 'boolean':
+                                            case param === undefined:
+                                                console.log('methodsResult', '=', methodsResult);
+                                                return methodsResult;
+                                        }
+                                    },
+                                };
+                            case 'ls':
+                                return {
+                                    entry: lsEntry,
+                                    paramParser: LsParamZod,
+                                    handler(shvPath) {
+                                        return methods.ls(shvPath);
+                                    },
+                                };
+                            default:
+                                return methods.dirEntries.find(method => method.entry[DIR_NAME] === methodName);
+                        }
+                    })();
+
+                    if (methodDefinition === undefined) {
+                        unhandledMethod();
+                        return;
+                    }
+
+                    if (accessLevel < methodDefinition.entry[DIR_ACCESS]) {
+                        unhandledMethod();
+                        return;
+                    }
+
+                    const requestParam = request.value[RPC_MESSAGE_PARAMS];
+                    const parsedParam = methodDefinition.paramParser.safeParse(requestParam);
+                    if (!parsedParam.success) {
+                        throw new InvalidParams(`Unexpected param for method ${methodName} on path ${shvPath}: ${toCpon(requestParam)}`);
+                    }
+
+                    let result = methodDefinition.handler(
                         shvPath,
-                        method,
-                        param: request.value[RPC_MESSAGE_PARAMS],
-                        accessLevel,
-                        delay: sendDelay,
-                    });
+                        methodName,
+                        parsedParam.data,
+                        sendDelay,
+                    );
                     if (result instanceof RequestHandler) {
                         this.requestHandlers.set(requestId, result);
                         result = result.options.result;