libshv-js 3.23.2 → 3.24.0

package/dist/index.d.ts

@@ -8,3 +8,4 @@ export * from './rpcvalue';
 export * from './vue-shv';
 export * from './ws-client';
 export * from './zod';
+export * from './zod-ws-client';

package/dist/index.js

@@ -24,3 +24,4 @@ __exportStar(require("./rpcvalue"), exports);
 __exportStar(require("./vue-shv"), exports);
 __exportStar(require("./ws-client"), exports);
 __exportStar(require("./zod"), exports);
+__exportStar(require("./zod-ws-client"), exports);

package/dist/vue-shv.d.ts

@@ -1,10 +1,11 @@
 import { ComputedRef, Ref } from 'vue';
-import { WsClient, WsClientOptionsLogin } from './ws-client';
+import { type WsClient, type WsClientOptionsLogin } from './ws-client';
 import PKCE from 'js-pkce';
 import * as z from './zod';
 import { type shvMapType } from './rpcvalue';
 import { RpcValue } from './rpcvalue';
 import { StringGetter } from './utils';
+import { ZodMethodHandler } from './zod-ws-client';
 type GlobalResourceOptions<ResourceType> = {
     shvPath: StringGetter;
     method: string;
@@ -14,7 +15,7 @@ type GlobalResourceOptions<ResourceType> = {
 };
 type VueShvOptions = {
     wsUri: StringGetter;
-    onRequest: WsClientOptionsLogin['onRequest'];
+    onRequest: WsClientOptionsLogin<ZodMethodHandler>['onRequest'];
     azureCodeRedirect?: string;
     mountPoint?: string;
 };

package/dist/vue-shv.js

@@ -39,11 +39,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fullReloadHandler = exports.azure = exports.LoginFailureReason = void 0;
 exports.useShv = useShv;
 const vue_1 = require("vue");
-const ws_client_1 = require("./ws-client");
 const core_1 = require("@vueuse/core");
 const js_pkce_1 = __importDefault(require("js-pkce"));
 const z = __importStar(require("./zod"));
 const utils_1 = require("./utils");
+const zod_ws_client_1 = require("./zod-ws-client");
 const OAuth2AzureWorkflowZod = z.map({
     type: z.literal('oauth2-azure'),
     authorizeUrl: z.string(),
@@ -146,7 +146,7 @@ function useShv(options) {
                 message: 'Broker does not support Azure',
             };
         };
-        state.ws = new ws_client_1.WsClient({
+        state.ws = (0, zod_ws_client_1.createZodWsClient)({
             logDebug: debug,
             wsUri: await (0, utils_1.resolveString)(options.wsUri),
             onWorkflows(workflows) {
@@ -246,7 +246,7 @@ function useShv(options) {
                             };
                     }
                 };
-                state.ws = new ws_client_1.WsClient({
+                state.ws = (0, zod_ws_client_1.createZodWsClient)({
                     login: makeLoginOptions(),
                     wsUri,
                     timeout: 120_000,
@@ -354,6 +354,10 @@ function useShv(options) {
             if (!initialized) {
                 initialized = true;
                 (0, vue_1.watchEffect)(async () => {
+                    (0, vue_1.onWatcherCleanup)(() => {
+                        initialized = false;
+                        resource.value = undefined;
+                    });
                     if (connected.value !== 'connected') {
                         return;
                     }

package/dist/ws-client.d.ts

@@ -1,7 +1,6 @@
 import { type RpcMessage, type ErrorMap } from './rpcmessage';
 import { type RpcValue, type Null, type Int, type IMap, type ShvMap } from './rpcvalue';
 import { StringGetter } from './utils';
-import * as z from './zod';
 type SubscriptionCallback = (path: string, method: string, param?: RpcValue) => void;
 type ResultOrError<T = RpcValue> = T | Error;
 type Login = {
@@ -15,6 +14,7 @@ type Login = {
 type WsClientOptionsCommon = {
     logDebug: (...args: string[]) => void;
     wsUri: string;
+    parseMessage?: (rpcVal: RpcValue) => RpcMessage;
 };
 export declare class RequestHandler {
     options: {
@@ -28,8 +28,8 @@ export declare class RequestHandler {
         onProgressQuery?: () => number | Promise<number>;
     });
 }
-export declare const LsParamZod: z.ZodUnion<[z.ZodUndefined, z.ZodString]>;
-export declare const DirParamZod: z.ZodUnion<[z.ZodUnion<[z.ZodUndefined, z.ZodBoolean]>, z.ZodString]>;
+export declare const validateLsParam: (param: RpcValue) => param is string | undefined;
+export declare const validateDirParam: (param: RpcValue) => param is string | boolean | undefined;
 export type DirEntry = IMap<{
     [DIR_NAME]: string;
     [DIR_FLAGS]: number;
@@ -41,10 +41,10 @@ export type DirEntry = IMap<{
 }>;
 export type DirResult = DirEntry[];
 export type MethodHandler = {
-    paramParser: z.ZodType<RpcValue>;
+    paramValidator?: (param: RpcValue) => boolean;
     handler: (shvPath: string, method: string, params: RpcValue, delay: (progress: number) => void) => Promise<RpcValue> | RpcValue | RequestHandler;
 };
-export type WsClientOptionsLogin = WsClientOptionsCommon & {
+export type WsClientOptionsLogin<MethodHandlerType = MethodHandler> = WsClientOptionsCommon & {
     mountPoint?: string;
     login: Login;
     timeout?: number;
@@ -56,14 +56,14 @@ export type WsClientOptionsLogin = WsClientOptionsCommon & {
         ls: (shvPath: string) => string[] | Promise<string[]>;
         dirEntries: Array<{
             entry: DirEntry;
-        } & MethodHandler>;
+        } & MethodHandlerType>;
     } | undefined;
 };
-type WsClientOptionsWorkflows = WsClientOptionsCommon & {
+export type WsClientOptionsWorkflows = WsClientOptionsCommon & {
     onWorkflows: (workflows: RpcValue) => void;
     onWorkflowsFailed: () => void;
 };
-type WsClientOptions = WsClientOptionsLogin | WsClientOptionsWorkflows;
+export type WsClientOptions<MethodHandlerType> = WsClientOptionsLogin<MethodHandlerType> | WsClientOptionsWorkflows;
 type LsResult = string[];
 export declare enum DirFlags {
     Reserved = 1,
@@ -215,7 +215,7 @@ declare class WsClient {
     private readonly websocket;
     private readonly options;
     private readonly timeout;
-    constructor(options: WsClientOptions);
+    constructor(options: WsClientOptions<MethodHandler>);
     callRpcMethod(shvPath: '.broker/currentClient', method: 'accessGrantForMethodCall', params: [string, string], delayCallback?: (progress: number) => void): RpcRequestPromise<ResultOrError<string>>;
     callRpcMethod(shvPath: string | undefined, method: 'dir', params?: RpcValue, delayCallback?: (progress: number) => void): RpcRequestPromise<ResultOrError<DirResult>>;
     callRpcMethod(shvPath: string | undefined, method: 'ls', params?: RpcValue, delayCallback?: (progress: number) => void): RpcRequestPromise<ResultOrError<LsResult>>;
@@ -226,7 +226,7 @@ declare class WsClient {
     sendPing(): void;
     accessGrantForMethodCall(path: string, method: string): RpcRequestPromise<ResultOrError<string>>;
     close(): void;
-    private logDebug;
+    protected logDebug(...args: string[]): void;
     private workflowsProcedure;
     private loginProcedure;
 }

package/dist/ws-client.js

@@ -1,48 +1,19 @@
 "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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WsClient = exports.NotImplemented = exports.UserIDRequired = exports.LoginRequired = exports.Unknown = exports.MethodCallException = exports.MethodCallCancelled = exports.MethodCallTimeout = exports.ParseError = exports.InternalError = exports.InvalidParams = exports.MethodNotFound = exports.InvalidRequest = exports.DIR_EXTRA = exports.DIR_SIGNALS = exports.DIR_ACCESS = exports.DIR_RESULT = exports.DIR_PARAM = exports.DIR_FLAGS = exports.DIR_NAME = exports.DirFlags = exports.DirParamZod = exports.LsParamZod = exports.RequestHandler = void 0;
+exports.WsClient = exports.NotImplemented = exports.UserIDRequired = exports.LoginRequired = exports.Unknown = exports.MethodCallException = exports.MethodCallCancelled = exports.MethodCallTimeout = exports.ParseError = exports.InternalError = exports.InvalidParams = exports.MethodNotFound = exports.InvalidRequest = exports.DIR_EXTRA = exports.DIR_SIGNALS = exports.DIR_ACCESS = exports.DIR_RESULT = exports.DIR_PARAM = exports.DIR_FLAGS = exports.DIR_NAME = exports.DirFlags = exports.validateDirParam = exports.validateLsParam = exports.RequestHandler = void 0;
 const access_1 = require("./access");
 const chainpack_1 = require("./chainpack");
 const cpon_1 = require("./cpon");
 const rpcmessage_1 = require("./rpcmessage");
 const rpcvalue_1 = require("./rpcvalue");
 const utils_1 = require("./utils");
-const z = __importStar(require("./zod"));
 const DEFAULT_TIMEOUT = 5000;
 const DEFAULT_PING_INTERVAL = 30 * 1000;
+const defaultParseMessage = (rpcVal) => {
+    // Assume rpcVal is a valid RpcMessage - no runtime validation
+    const rpcMsg = rpcVal;
+    return rpcMsg;
+};
 const dataToRpcValue = (buff) => {
     const rd = new chainpack_1.ChainPackReader(buff);
     rd.readUIntData();
@@ -66,8 +37,10 @@ class RequestHandler {
     }
 }
 exports.RequestHandler = RequestHandler;
-exports.LsParamZod = z.undefined().or(z.string());
-exports.DirParamZod = z.undefined().or(z.boolean()).or(z.string());
+const validateLsParam = (param) => param === undefined || typeof param === 'string';
+exports.validateLsParam = validateLsParam;
+const validateDirParam = (param) => param === undefined || typeof param === 'string' || typeof param === 'boolean';
+exports.validateDirParam = validateDirParam;
 var DirFlags;
 (function (DirFlags) {
     DirFlags[DirFlags["Reserved"] = 1] = "Reserved";
@@ -251,7 +224,7 @@ class WsClient {
                             case 'dir':
                                 return {
                                     entry: dirEntry,
-                                    paramParser: exports.DirParamZod,
+                                    paramValidator: exports.validateDirParam,
                                     handler(_shvPath, _method, param) {
                                         const methodsResult = [dirEntry, lsEntry, ...methods.dirEntries.map(method => method.entry)];
                                         switch (true) {
@@ -267,7 +240,7 @@ class WsClient {
                             case 'ls':
                                 return {
                                     entry: lsEntry,
-                                    paramParser: exports.LsParamZod,
+                                    paramValidator: exports.validateLsParam,
                                     handler(shvPath) {
                                         return methods.ls(shvPath);
                                     },
@@ -285,11 +258,10 @@ class WsClient {
                         return;
                     }
                     const requestParam = request.value[rpcmessage_1.RPC_MESSAGE_PARAMS];
-                    const parsedParam = methodDefinition.paramParser.safeParse(requestParam);
-                    if (!parsedParam.success) {
-                        throw new exports.InvalidParams(`Unexpected param for method ${methodName} on path '${shvPath}': ${(0, cpon_1.toCpon)(requestParam)}`);
+                    if (methodDefinition.paramValidator !== undefined && !methodDefinition.paramValidator(requestParam)) {
+                        throw new exports.InvalidParams(`Unexpected param '${shvPath}:${methodName}': ${(0, cpon_1.toCpon)(requestParam)}`);
                     }
-                    let result = methodDefinition.handler(shvPath, methodName, parsedParam.data, sendDelay);
+                    let result = methodDefinition.handler(shvPath, methodName, requestParam, sendDelay);
                     if (result instanceof RequestHandler) {
                         this.requestHandlers.set(requestId, result);
                         result = result.options.result;
@@ -380,7 +352,8 @@ class WsClient {
         };
         this.websocket.addEventListener('message', async (evt) => {
             const rpcVal = dataToRpcValue(evt.data);
-            const rpcMsg = rpcmessage_1.RpcMessageZod.parse(rpcVal);
+            const parseMessage = this.options.parseMessage ?? defaultParseMessage;
+            const rpcMsg = parseMessage(rpcVal);
             this.logDebug(`message received: ${(0, cpon_1.toCpon)(rpcMsg)}`);
             if ((0, rpcmessage_1.isSignal)(rpcMsg)) {
                 handleSignal(rpcMsg);

package/dist/zod-ws-client.d.ts

@@ -0,0 +1,11 @@
+import { WsClient, WsClientOptions } from './ws-client';
+import { type RpcValue } from './rpcvalue';
+import * as z from './zod';
+export declare const LsParamZod: z.ZodUnion<[z.ZodUndefined, z.ZodString]>;
+export declare const DirParamZod: z.ZodUnion<[z.ZodUnion<[z.ZodUndefined, z.ZodBoolean]>, z.ZodString]>;
+export type ZodMethodHandler = {
+    paramParser: z.ZodType<RpcValue>;
+    handler: (shvPath: string, method: string, params: RpcValue, delay: (progress: number) => void) => Promise<RpcValue> | RpcValue | import('./ws-client').RequestHandler;
+};
+declare function createZodWsClient(options: WsClientOptions<ZodMethodHandler>): WsClient;
+export { createZodWsClient };

package/dist/zod-ws-client.js

@@ -0,0 +1,82 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DirParamZod = exports.LsParamZod = void 0;
+exports.createZodWsClient = createZodWsClient;
+const ws_client_1 = require("./ws-client");
+const rpcmessage_1 = require("./rpcmessage");
+const z = __importStar(require("./zod"));
+exports.LsParamZod = z.undefined().or(z.string());
+exports.DirParamZod = z.undefined().or(z.boolean()).or(z.string());
+function createZodWsClient(options) {
+    const parseMessage = (rpcVal) => {
+        try {
+            return rpcmessage_1.RpcMessageZod.parse(rpcVal);
+        }
+        catch (error) {
+            console.error('RPC Message validation failed:', error);
+            throw error;
+        }
+    };
+    const convertedOptions = 'login' in options ? {
+        ...options,
+        parseMessage,
+        onRequest(shvPath) {
+            const zodHandlers = options.onRequest(shvPath);
+            if (zodHandlers === undefined) {
+                return;
+            }
+            return {
+                ls: zodHandlers.ls,
+                dirEntries: zodHandlers.dirEntries.map(zodHandler => ({
+                    entry: zodHandler.entry,
+                    paramValidator(param) {
+                        const result = zodHandler.paramParser.safeParse(param);
+                        if (!result.success) {
+                            console.error(`Parameter validation failed for '${shvPath}:${zodHandler.entry[ws_client_1.DIR_NAME]}':`, result.error.message);
+                            return false;
+                        }
+                        return true;
+                    },
+                    handler: zodHandler.handler,
+                })),
+            };
+        },
+    } : {
+        ...options,
+        parseMessage,
+    };
+    return new ws_client_1.WsClient(convertedOptions);
+}

package/dist/zod.d.ts

@@ -28,3 +28,4 @@ export declare const list: () => z.ZodArray<z.ZodLazy<z.ZodType<RpcValue>>>;
 export declare const rpcvalue: () => ZodType<RpcValue>;
 export declare const withMeta: <MetaSchema extends MetaMap, ValueSchema extends RpcValueType>(metaParser: ZodType<MetaSchema>, valueParser: ZodType<ValueSchema>) => z.ZodCustom<RpcValueWithMetaData<MetaSchema, ValueSchema>, RpcValueWithMetaData<MetaSchema, ValueSchema>>;
 export * from 'zod/v4';
+export { z } from 'zod/v4';

package/dist/zod.js

@@ -14,7 +14,7 @@ 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;
+exports.z = 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");
@@ -110,3 +110,5 @@ const withMeta = (metaParser, valueParser) => v4_1.z.custom().check(ctx => {
 });
 exports.withMeta = withMeta;
 __exportStar(require("zod/v4"), exports);
+var v4_2 = require("zod/v4");
+Object.defineProperty(exports, "z", { enumerable: true, get: function () { return v4_2.z; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libshv-js",
-  "version": "3.23.2",
+  "version": "3.24.0",
   "description": "Typescript implementation of libshv",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -36,12 +36,13 @@
     "./utils": "./dist/utils.js",
     "./vue-shv": "./dist/vue-shv.js",
     "./ws-client": "./dist/ws-client.js",
-    "./zod": "./dist/zod.js"
+    "./zod": "./dist/zod.js",
+    "./zod-ws-client": "./dist/zod-ws-client.js"
   },
   "dependencies": {
     "@vueuse/core": "^13.5.0",
     "js-pkce": "^2.0.0",
-    "vue": "^3.5.18",
+    "vue": "^3.5.22",
     "zod": "^4.0.11"
   },
   "devDependencies": {