libshv-js 3.22.2 → 3.23.0

package/dist/utils.d.ts

@@ -0,0 +1,2 @@
+export type StringGetter = string | Promise<string> | (() => string | Promise<string>);
+export declare const resolveString: (input: StringGetter) => string | Promise<string>;

package/dist/utils.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveString = void 0;
+const resolveString = (input) => {
+    if (typeof input === 'function') {
+        input = input();
+    }
+    return input;
+};
+exports.resolveString = resolveString;

package/dist/vue-shv.d.ts

@@ -4,15 +4,16 @@ import PKCE from 'js-pkce';
 import * as z from './zod';
 import { type shvMapType } from './rpcvalue';
 import { RpcValue } from './rpcvalue';
+import { StringGetter } from './utils';
 type GlobalResourceOptions<ResourceType> = {
-    shvPath: string;
+    shvPath: StringGetter;
     method: string;
     validator: z.ZodType<ResourceType>;
     signalName: string;
     signalHandler: (param: RpcValue, resource: Ref<ResourceType | undefined>, reinit: () => void) => void;
 };
 type VueShvOptions = {
-    wsUri: string;
+    wsUri: StringGetter;
     onRequest: WsClientOptionsLogin['onRequest'];
     azureCodeRedirect?: string;
     mountPoint?: string;
@@ -63,7 +64,7 @@ declare const makePkce: (oauthOptions: {
 }) => PKCE;
 export { makePkce as azure };
 export declare function useShv(options: VueShvOptions): {
-    azureAuth: (redirectTo: string) => void;
+    azureAuth: (redirectTo: string) => Promise<void>;
     azureHandlerError: Ref<string, string>;
     connected: Ref<"connected" | "connecting" | "disconnected", "connected" | "connecting" | "disconnected">;
     displayEmail: Ref<string, string>;
@@ -81,9 +82,9 @@ export declare function useShv(options: VueShvOptions): {
             default: ResourceType;
         }): () => ComputedRef<ResourceType>;
     };
-    makeRpcCall: <ResultType>(shvPath: string, method: string, validator: z.ZodType<ResultType>) => () => Promise<Error | ResultType>;
-    makeRpcCallParam: <ResultType, ParamType extends RpcValue>(shvPath: string, method: string, _paramType: z.ZodType<ParamType>, validator: z.ZodType<ResultType>) => (param: ParamType) => Promise<Error | ResultType>;
-    rpcCall: (shvPath: string, method: string, params?: RpcValue) => Promise<Error | RpcValue>;
+    makeRpcCall: <ResultType>(shvPath: StringGetter, method: string, validator: z.ZodType<ResultType>) => () => Promise<Error | ResultType>;
+    makeRpcCallParam: <ResultType, ParamType extends RpcValue>(shvPath: StringGetter, method: string, _paramType: z.ZodType<ParamType>, validator: z.ZodType<ResultType>) => (param: ParamType) => Promise<Error | ResultType>;
+    rpcCall: (shvPath: StringGetter, method: string, params?: RpcValue) => Promise<Error | RpcValue>;
     setShvCredentials: (userName: string, password: string) => void;
     shvLocalStorage: import("@vueuse/shared").RemovableRef<ShvLocalStorage>;
     shvLogout: () => void;

package/dist/vue-shv.js

@@ -43,6 +43,7 @@ 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 OAuth2AzureWorkflowZod = z.map({
     type: z.literal('oauth2-azure'),
     authorizeUrl: z.string(),
@@ -133,7 +134,7 @@ function useShv(options) {
         logContents.value = logContents.value + args.join(' ') + '\n';
         console.debug(...args);
     };
-    const azureAuth = (redirectTo) => {
+    const azureAuth = async (redirectTo) => {
         if (options.azureCodeRedirect === undefined) {
             throw new Error('Azure redirect URL not set');
         }
@@ -147,7 +148,7 @@ function useShv(options) {
         };
         state.ws = new ws_client_1.WsClient({
             logDebug: debug,
-            wsUri: options.wsUri,
+            wsUri: await (0, utils_1.resolveString)(options.wsUri),
             onWorkflows(workflows) {
                 if (!Array.isArray(workflows)) {
                     noBrokerSupport();
@@ -174,10 +175,10 @@ function useShv(options) {
     };
     const rpcCall = async (shvPath, method, params) => {
         const shv = await getConnection();
-        return shv.callRpcMethod(shvPath, method, params);
+        return shv.callRpcMethod(await (0, utils_1.resolveString)(shvPath), method, params);
     };
     const makeRpcCall = (shvPath, method, validator) => async () => {
-        const resultOrError = await rpcCall(shvPath, method);
+        const resultOrError = await rpcCall(await (0, utils_1.resolveString)(shvPath), method);
         if (resultOrError instanceof Error) {
             return resultOrError;
         }
@@ -188,7 +189,7 @@ function useShv(options) {
         return parsed.data;
     };
     const makeRpcCallParam = (shvPath, method, _paramType, validator) => async (param) => {
-        const resultOrError = await rpcCall(shvPath, method, param);
+        const resultOrError = await rpcCall(await (0, utils_1.resolveString)(shvPath), method, param);
         if (resultOrError instanceof Error) {
             return resultOrError;
         }
@@ -226,8 +227,9 @@ function useShv(options) {
                 return;
             }
             connected.value = 'connecting';
-            const doConnect = (user, password, loginType) => {
-                console.log('Connecting to', options.wsUri);
+            const doConnect = async (user, password, loginType) => {
+                const wsUri = await (0, utils_1.resolveString)(options.wsUri);
+                console.log('Connecting to', wsUri);
                 const makeLoginOptions = () => {
                     switch (loginType) {
                         case 'PLAIN':
@@ -245,7 +247,7 @@ function useShv(options) {
                 };
                 state.ws = new ws_client_1.WsClient({
                     login: makeLoginOptions(),
-                    wsUri: options.wsUri,
+                    wsUri,
                     timeout: 120_000,
                     mountPoint: options.mountPoint,
                     logDebug: debug,
@@ -254,11 +256,11 @@ function useShv(options) {
                             waiter.resolve(state.ws);
                         }
                         waitingForSocket.length = 0;
-                        console.log('Connected to', options.wsUri);
+                        console.log('Connected to', wsUri);
                         connected.value = 'connected';
                     },
                     onConnectionFailure(error) {
-                        console.error(`Failed to connect to: ${options.wsUri}`, error);
+                        console.error(`Failed to connect to: ${wsUri}`, error);
                         shvLogout();
                         loginFailure.value = {
                             reason: LoginFailureReason.CouldntLogin,
@@ -269,7 +271,7 @@ function useShv(options) {
                         connected.value = 'disconnected';
                         const RECONNECT_INTERVAL = 3000;
                         if (shvLocalStorage.value.azureAccessToken !== undefined) {
-                            console.log('Disconnected from', options.wsUri, 'reconnecting in', RECONNECT_INTERVAL, 'ms');
+                            console.log('Disconnected from', wsUri, 'reconnecting in', RECONNECT_INTERVAL, 'ms');
                             state.reconnectService = globalThis.setTimeout(async () => {
                                 await getConnection();
                             }, RECONNECT_INTERVAL);
@@ -284,7 +286,10 @@ function useShv(options) {
                 displayName.value = shvUser;
                 displayShortName.value = shvUser[0];
                 displayFullName.value = shvUser;
-                doConnect(shvUser, shvPassword, 'PLAIN');
+                doConnect(shvUser, shvPassword, 'PLAIN')
+                    .catch((error) => {
+                    console.error('Unexpected failure in doConnect:', error);
+                });
                 return;
             }
             azureAvailable().then(isAzureAvailable => {
@@ -301,7 +306,10 @@ function useShv(options) {
                 }
                 const accessToken = shvLocalStorage.value.azureAccessToken;
                 if (accessToken !== undefined) {
-                    doConnect('', accessToken, 'TOKEN');
+                    doConnect('', accessToken, 'TOKEN')
+                        .catch((error) => {
+                        console.error('Unexpected failure in doConnect:', error);
+                    });
                 }
             }).catch((error) => {
                 console.error('Failed to fetch verify azure info, redirecting to the login page in 3 seconds', error);
@@ -316,7 +324,6 @@ function useShv(options) {
     };
     function makeGlobalResource(options) {
         const resource = (0, vue_1.ref)();
-        const resIdentifier = `${options.shvPath}:${options.method}`;
         const resourceCall = makeRpcCall(options.shvPath, options.method, options.validator);
         const refreshValue = async () => {
             const newResource = await resourceCall();
@@ -326,10 +333,12 @@ function useShv(options) {
             resource.value = newResource;
         };
         const initialize = async () => {
+            const shvPath = await (0, utils_1.resolveString)(options.shvPath);
+            const resIdentifier = `${shvPath}:${options.method}`;
             try {
                 await refreshValue();
                 const connection = await getConnection();
-                connection.subscribe(`Global-${resIdentifier}:`, options.shvPath, options.signalName, (_path, _method, param) => {
+                await connection.subscribe(`Global-${resIdentifier}:`, shvPath, options.signalName, (_path, _method, param) => {
                     options.signalHandler(param, resource, async () => refreshValue().catch((error) => {
                         console.error(`Failed to initialize ${resIdentifier}`, error);
                     }));
@@ -343,10 +352,12 @@ function useShv(options) {
         return () => {
             if (!initialized) {
                 initialized = true;
-                (0, vue_1.watchEffect)(() => {
+                (0, vue_1.watchEffect)(async () => {
                     if (connected.value !== 'connected') {
                         return;
                     }
+                    const shvPath = await (0, utils_1.resolveString)(options.shvPath);
+                    const resIdentifier = `${shvPath}:${options.method}`;
                     initialize().catch((error) => {
                         console.error(`Failed to initialize ${resIdentifier}`, error);
                     });

package/dist/ws-client.d.ts

@@ -1,5 +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;
@@ -220,8 +221,8 @@ declare class WsClient {
     callRpcMethod(shvPath: string | undefined, method: 'ls', params?: RpcValue, delayCallback?: (progress: number) => void): RpcRequestPromise<ResultOrError<LsResult>>;
     callRpcMethod(shvPath: string | undefined, method: string, params?: RpcValue, delayCallback?: (progress: number) => void): RpcRequestPromise<ResultOrError>;
     sendRpcMessage(rpcMsg: RpcMessage): void;
-    subscribe(subscriber: string, path: string, method: string, callback: SubscriptionCallback): void;
-    unsubscribe(subscriber: string, path: string, method: string): void;
+    subscribe(subscriber: string, pathGetter: StringGetter, method: string, callback: SubscriptionCallback): Promise<void>;
+    unsubscribe(subscriber: string, pathGetter: StringGetter, method: string): Promise<void>;
     sendPing(): void;
     accessGrantForMethodCall(path: string, method: string): RpcRequestPromise<ResultOrError<string>>;
     close(): void;

package/dist/ws-client.js

@@ -39,6 +39,7 @@ 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;
@@ -445,11 +446,12 @@ class WsClient {
             this.websocket.send(dgram.buffer);
         }
     }
-    subscribe(subscriber, path, method, callback) {
+    async subscribe(subscriber, pathGetter, method, callback) {
         if (this.subscriptions.some(val => val.subscriber === subscriber && val.path === path && val.method === method)) {
             this.logDebug(`Already subscribed {$path}:${method} for subscriber ${subscriber}`);
             return;
         }
+        const path = await (0, utils_1.resolveString)(pathGetter);
         // If this path:method has not been subscribed on the broker, do it now
         if (!this.subscriptions.some(val => val.path === path && val.method === method)) {
             this.callRpcMethod('.broker/app', 'subscribe', (0, rpcvalue_1.makeMap)({
@@ -465,7 +467,8 @@ class WsClient {
             callback,
         });
     }
-    unsubscribe(subscriber, path, method) {
+    async unsubscribe(subscriber, pathGetter, method) {
+        const path = await (0, utils_1.resolveString)(pathGetter);
         const idx = this.subscriptions.findIndex(val => val.subscriber === subscriber && val.path === path && val.method === method);
         if (idx === -1) {
             this.logDebug(`No such subscription ${path}:${method} for subscriber ${subscriber}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libshv-js",
-  "version": "3.22.2",
+  "version": "3.23.0",
   "description": "Typescript implementation of libshv",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -33,6 +33,7 @@
     "./json": "./dist/json.js",
     "./rpcmessage": "./dist/rpcmessage.js",
     "./rpcvalue": "./dist/rpcvalue.js",
+    "./utils": "./dist/utils.js",
     "./vue-shv": "./dist/vue-shv.js",
     "./ws-client": "./dist/ws-client.js",
     "./zod": "./dist/zod.js"