libshv-js 3.9.0 → 3.9.2

package/dist/ws-client.d.ts

@@ -0,0 +1,239 @@
+import { type RpcMessage, type ErrorMap } from './rpcmessage';
+import { type RpcValue, type Null, type Int, type IMap, type ShvMap } from './rpcvalue';
+import { StringGetter } from './utils';
+type SubscriptionCallback = (path: string, method: string, param?: RpcValue) => void;
+type ResultOrError<T = RpcValue> = T | Error;
+type Login = {
+    type: 'PLAIN';
+    user: string;
+    password: string;
+} | {
+    type: 'TOKEN';
+    token: string;
+};
+type WsClientOptionsCommon = {
+    logDebug: (...args: string[]) => void;
+    wsUri: string;
+    parseMessage?: (rpcVal: RpcValue) => RpcMessage;
+};
+export declare class RequestHandler {
+    options: {
+        result: Promise<RpcValue>;
+        onAbort?: () => void;
+        onProgressQuery?: () => number | Promise<number>;
+    };
+    constructor(options: {
+        result: Promise<RpcValue>;
+        onAbort?: () => void;
+        onProgressQuery?: () => number | Promise<number>;
+    });
+}
+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;
+    [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 = {
+    paramValidator?: (param: RpcValue) => boolean;
+    handler: (shvPath: string, method: string, params: RpcValue, delay: (progress: number) => void) => Promise<RpcValue> | RpcValue | RequestHandler;
+};
+export type WsClientOptionsLogin<MethodHandlerType = MethodHandler> = WsClientOptionsCommon & {
+    mountPoint?: string;
+    login: Login;
+    timeout?: number;
+    pingInterval?: number;
+    onConnected: () => void;
+    onConnectionFailure: (error: Error) => void;
+    onDisconnected: () => void;
+    onRequest: (shvPath: string) => {
+        ls: (shvPath: string) => string[] | Promise<string[]>;
+        dirEntries: Array<{
+            entry: DirEntry;
+        } & MethodHandlerType>;
+    } | undefined;
+};
+export type WsClientOptionsWorkflows = WsClientOptionsCommon & {
+    onWorkflows: (workflows: RpcValue) => void;
+    onWorkflowsFailed: () => void;
+};
+export type WsClientOptions<MethodHandlerType> = WsClientOptionsLogin<MethodHandlerType> | WsClientOptionsWorkflows;
+type LsResult = string[];
+export declare enum DirFlags {
+    Reserved = 1,
+    Getter = 2,
+    Setter = 4,
+    LargeResultHint = 8,
+    NotIdempotent = 16,
+    RequiresClientId = 32
+}
+export declare const DIR_NAME = 1;
+export declare const DIR_FLAGS = 2;
+export declare const DIR_PARAM = 3;
+export declare const DIR_RESULT = 4;
+export declare const DIR_ACCESS = 5;
+export declare const DIR_SIGNALS = 6;
+export declare const DIR_EXTRA = 63;
+export declare const InvalidRequest: {
+    new (errInfoOrMsg: ErrorMap | string): {
+        readonly err_info: ErrorMap;
+        data(): RpcValue;
+        name: string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+};
+export declare const MethodNotFound: {
+    new (errInfoOrMsg: ErrorMap | string): {
+        readonly err_info: ErrorMap;
+        data(): RpcValue;
+        name: string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+};
+export declare const InvalidParams: {
+    new (errInfoOrMsg: ErrorMap | string): {
+        readonly err_info: ErrorMap;
+        data(): RpcValue;
+        name: string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+};
+export declare const InternalError: {
+    new (errInfoOrMsg: ErrorMap | string): {
+        readonly err_info: ErrorMap;
+        data(): RpcValue;
+        name: string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+};
+export declare const ParseError: {
+    new (errInfoOrMsg: ErrorMap | string): {
+        readonly err_info: ErrorMap;
+        data(): RpcValue;
+        name: string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+};
+export declare const MethodCallTimeout: {
+    new (errInfoOrMsg: ErrorMap | string): {
+        readonly err_info: ErrorMap;
+        data(): RpcValue;
+        name: string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+};
+export declare const MethodCallCancelled: {
+    new (errInfoOrMsg: ErrorMap | string): {
+        readonly err_info: ErrorMap;
+        data(): RpcValue;
+        name: string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+};
+export declare const MethodCallException: {
+    new (errInfoOrMsg: ErrorMap | string): {
+        readonly err_info: ErrorMap;
+        data(): RpcValue;
+        name: string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+};
+export declare const Unknown: {
+    new (errInfoOrMsg: ErrorMap | string): {
+        readonly err_info: ErrorMap;
+        data(): RpcValue;
+        name: string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+};
+export declare const LoginRequired: {
+    new (errInfoOrMsg: ErrorMap | string): {
+        readonly err_info: ErrorMap;
+        data(): RpcValue;
+        name: string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+};
+export declare const UserIDRequired: {
+    new (errInfoOrMsg: ErrorMap | string): {
+        readonly err_info: ErrorMap;
+        data(): RpcValue;
+        name: string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+};
+export declare const NotImplemented: {
+    new (errInfoOrMsg: ErrorMap | string): {
+        readonly err_info: ErrorMap;
+        data(): RpcValue;
+        name: string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+};
+declare class RpcRequestPromise<Result> extends Promise<Result> {
+    readonly abort: () => void;
+    readonly progressQuery: () => void;
+    constructor(executor: (resolve: (value: Result | PromiseLike<Result>) => void, reject: (reason?: unknown) => void) => void, abort: () => void, progressQuery: () => void);
+}
+export type CallRpcMethodOptions = {
+    delayCallback?: (progress: number) => void;
+    requestUserId?: boolean;
+};
+declare class WsClient {
+    private requestId;
+    private pingTimerId;
+    private rpcHandlers;
+    private requestHandlers;
+    private abortedRequests;
+    private readonly subscriptions;
+    private readonly websocket;
+    private readonly options;
+    private readonly timeout;
+    constructor(options: WsClientOptions<MethodHandler>);
+    callRpcMethod(shvPath: '.broker/currentClient', method: 'accessGrantForMethodCall', params: [string, string], options?: CallRpcMethodOptions): RpcRequestPromise<ResultOrError<string>>;
+    callRpcMethod(shvPath: '.broker/currentClient', method: 'accessLevelForMethodCall', params: [string, string], options?: CallRpcMethodOptions): RpcRequestPromise<ResultOrError<number>>;
+    callRpcMethod(shvPath: string | undefined, method: 'dir', params?: RpcValue, options?: CallRpcMethodOptions): RpcRequestPromise<ResultOrError<DirResult>>;
+    callRpcMethod(shvPath: string | undefined, method: 'ls', params?: RpcValue, options?: CallRpcMethodOptions): RpcRequestPromise<ResultOrError<LsResult>>;
+    callRpcMethod(shvPath: string | undefined, method: string, params?: RpcValue, options?: CallRpcMethodOptions): RpcRequestPromise<ResultOrError>;
+    sendRpcMessage(rpcMsg: RpcMessage): 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>>;
+    accessLevelForMethodCall(path: string, method: string): RpcRequestPromise<ResultOrError<number>>;
+    close(): void;
+    protected logDebug(...args: string[]): void;
+    private workflowsProcedure;
+    private loginProcedure;
+}
+export { WsClient };