airdcpp-apisocket 3.0.0-beta.4 → 3.0.0-beta.6

package/dist-es/tests/{helpers.d.ts → mock-server.d.ts}

@@ -1,6 +1,5 @@
 import * as Options from '../types/options.js';
-export declare const waitForExpect: (func: () => void | Promise<void>) => Promise<{}>;
-declare const getMockConsole: () => {
+export declare const getMockConsole: () => {
     log: import("jest-mock").Mock<(a1: any, a2: any, a3: any, a4: any) => void>;
     info: import("jest-mock").Mock<(a1: any, a2: any, a3: any, a4: any) => void>;
     warn: import("jest-mock").Mock<(a1: any, a2: any, a3: any, a4: any) => void>;
@@ -65,10 +64,33 @@ declare const getConnectedSocket: (server: ReturnType<typeof getMockServer>, use
         error: import("jest-mock").Mock<(a1: any, a2: any, a3: any, a4: any) => void>;
     };
 }>;
-declare const getMockServer: (url?: string) => {
-    addDataHandler: <DataT extends object | undefined>(method: string, path: string, data?: DataT, subscriptionCallback?: Callback) => void;
+interface MockServerOptions {
+    url: string;
+    reportMissingListeners?: boolean;
+}
+declare const getMockServer: (initialOptions?: Partial<MockServerOptions>) => {
+    addRequestHandler: <DataT extends object | undefined>(method: string, path: string, data?: DataT, subscriptionCallback?: Callback) => void;
     addErrorHandler: (method: string, path: string, errorStr: string | null, errorCode: number, subscriptionCallback?: Callback) => void;
+    addSubscriptionHandler: (moduleName: string, listenerName: string, entityId?: string | number) => {
+        fire: (data: object, entityId?: string | number) => void;
+        subscribeFn: import("jest-mock").Mock<import("jest-mock").UnknownFunction>;
+        unsubscribeFn: import("jest-mock").Mock<import("jest-mock").UnknownFunction>;
+        path: string;
+    };
+    addHookHandler: (moduleName: string, listenerName: string) => {
+        fire: (data: object, entityId?: string | number) => void;
+        subscribeFn: import("jest-mock").Mock<import("jest-mock").UnknownFunction>;
+        unsubscribeFn: import("jest-mock").Mock<import("jest-mock").UnknownFunction>;
+        path: string;
+        addResolver: (completionId: number) => {
+            fire: (data: object) => void;
+            resolveFn: import("jest-mock").Mock<import("jest-mock").UnknownFunction>;
+            rejectFn: import("jest-mock").Mock<import("jest-mock").UnknownFunction>;
+        };
+    };
+    ignoreMissingHandler: (method: string, path: string) => void;
     stop: () => void;
     send: (data: object) => void;
+    url: string;
 };
 export { getMockServer, getSocket, getConnectedSocket, DEFAULT_CONNECT_PARAMS, DEFAULT_AUTH_RESPONSE };

package/dist-es/tests/mock-server.js

@@ -0,0 +1,198 @@
+import { Socket } from '../NodeSocket.js';
+import { Server, WebSocket } from 'mock-socket';
+import { jest } from '@jest/globals';
+import ApiConstants from '../ApiConstants.js';
+import { EventEmitter } from 'events';
+const VERBOSE = false;
+export const getMockConsole = () => ({
+    log: jest.fn((a1, a2, a3, a4) => {
+        if (VERBOSE) {
+            console.log(a1, a2, a3, a4);
+        }
+    }),
+    info: jest.fn((a1, a2, a3, a4) => {
+        if (VERBOSE) {
+            console.info(a1, a2, a3, a4);
+        }
+    }),
+    warn: jest.fn((a1, a2, a3, a4) => {
+        console.warn(a1, a2, a3, a4);
+    }),
+    error: jest.fn((a1, a2, a3, a4) => {
+        console.error(a1, a2, a3, a4);
+    }),
+});
+const DEFAULT_CONNECT_PARAMS = {
+    username: 'test',
+    password: 'test',
+    url: 'ws://localhost:7171/api/v1/',
+};
+const getDefaultSocketOptions = (mockConsole) => ({
+    ...DEFAULT_CONNECT_PARAMS,
+    logOutput: mockConsole,
+    logLevel: VERBOSE ? 'verbose' : 'warn',
+});
+const DEFAULT_AUTH_RESPONSE = {
+    auth_token: 'b823187f-4aab-4b71-9764-e63e88401a26',
+    refresh_token: '5124faasf-4aab-4b71-9764-e63e88401a26',
+    user: {
+        permissions: ['admin'],
+        username: 'test',
+        active_sessions: 1,
+        last_login: 0,
+    },
+    system: {
+        cid: 'AHLUODI2YZ2U7FDWMHFNJU65ERGKUN4MH7GW5LY',
+        hostname: 'ubuntu-htpc',
+        network_type: 'private',
+        path_separator: '/',
+        platform: 'other',
+        language: 'fi',
+    },
+    wizard_pending: false,
+};
+const getSocket = (socketOptions = {}, mockConsole = getMockConsole()) => {
+    const socket = Socket({
+        ...getDefaultSocketOptions(mockConsole),
+        ...socketOptions,
+    }, WebSocket);
+    return { socket, mockConsole };
+};
+const getDefaultConnectOptions = () => ({
+    console: getMockConsole(),
+    authResponse: DEFAULT_AUTH_RESPONSE,
+});
+const getConnectedSocket = async (server, userOptions) => {
+    const options = {
+        ...getDefaultConnectOptions(),
+        ...userOptions,
+    };
+    server.addRequestHandler('POST', ApiConstants.LOGIN_URL, options.authResponse, options.authCallback);
+    const { socket, mockConsole } = getSocket(options.socketOptions, options.console);
+    await socket.connect();
+    return { socket, mockConsole };
+};
+const toEmitId = (path, method) => {
+    return `${path}_${method}`;
+};
+const DEFAULT_MOCK_SERVER_OPTIONS = {
+    url: DEFAULT_CONNECT_PARAMS.url,
+    reportMissingListeners: true,
+};
+const getMockServer = (initialOptions = {}) => {
+    const { url, reportMissingListeners } = {
+        ...DEFAULT_MOCK_SERVER_OPTIONS,
+        ...initialOptions,
+    };
+    const mockServer = new Server(url);
+    let socket;
+    const emitter = new EventEmitter();
+    const send = (data) => {
+        socket.send(JSON.stringify(data));
+    };
+    const addServerHandler = (method, path, responseData, subscriptionCallback) => {
+        emitter.addListener(toEmitId(path, method), (request, s) => {
+            if (subscriptionCallback) {
+                subscriptionCallback(request);
+            }
+            const response = {
+                callback_id: request.callback_id,
+                ...responseData,
+            };
+            s.send(JSON.stringify(response));
+        });
+    };
+    const addDummyDataHandler = (method, path) => {
+        emitter.addListener(toEmitId(path, method), (request, s) => {
+            // Do nothing
+        });
+    };
+    const addRequestHandler = (method, path, data, subscriptionCallback) => {
+        addServerHandler(method, path, {
+            data,
+            code: 200,
+        }, subscriptionCallback);
+    };
+    const addErrorHandler = (method, path, errorStr, errorCode, subscriptionCallback) => {
+        addServerHandler(method, path, {
+            error: !errorStr ? null : {
+                message: errorStr,
+            },
+            code: errorCode,
+        }, subscriptionCallback);
+    };
+    const addSubscriptionHandlerImpl = (moduleName, type, listenerName, entityId) => {
+        const subscribeFn = jest.fn();
+        const unsubscribeFn = jest.fn();
+        const path = entityId ? `${moduleName}/${entityId}/${type}/${listenerName}` : `${moduleName}/${type}/${listenerName}`;
+        addRequestHandler('POST', path, undefined, subscribeFn);
+        addRequestHandler('DELETE', path, undefined, unsubscribeFn);
+        const fire = (data, entityId) => {
+            send({
+                event: listenerName,
+                data,
+                id: entityId,
+            });
+        };
+        return {
+            fire,
+            subscribeFn,
+            unsubscribeFn,
+            path,
+        };
+    };
+    const addSubscriptionHandler = (moduleName, listenerName, entityId) => {
+        return addSubscriptionHandlerImpl(moduleName, 'listeners', listenerName, entityId);
+    };
+    const addHookHandler = (moduleName, listenerName) => {
+        const subscriber = addSubscriptionHandlerImpl(moduleName, 'hooks', listenerName);
+        const addResolver = (completionId) => {
+            const resolveFn = jest.fn();
+            const rejectFn = jest.fn();
+            addRequestHandler('POST', `${subscriber.path}/${completionId}/resolve`, undefined, resolveFn);
+            addRequestHandler('POST', `${subscriber.path}/${completionId}/reject`, undefined, rejectFn);
+            const fire = (data) => {
+                send({
+                    event: listenerName,
+                    data,
+                    completion_id: completionId,
+                });
+            };
+            return { fire, resolveFn, rejectFn };
+        };
+        return {
+            addResolver,
+            ...subscriber,
+        };
+    };
+    mockServer.on('connection', s => {
+        socket = s;
+        socket.on('message', (messageObj) => {
+            const request = JSON.parse(messageObj);
+            const emitId = toEmitId(request.path, request.method);
+            const processed = emitter.emit(emitId, request, s);
+            if (reportMissingListeners && !processed) {
+                console.warn(`Mock server: no listeners for event ${request.method} ${request.path}`);
+            }
+        });
+    });
+    mockServer.on('close', () => {
+        emitter.removeAllListeners();
+    });
+    return {
+        addRequestHandler,
+        addErrorHandler,
+        addSubscriptionHandler,
+        addHookHandler,
+        ignoreMissingHandler: addDummyDataHandler,
+        stop: () => {
+            mockServer.stop(() => {
+                // ...
+            });
+        },
+        send,
+        url,
+    };
+};
+export { getMockServer, getSocket, getConnectedSocket, DEFAULT_CONNECT_PARAMS, DEFAULT_AUTH_RESPONSE };
+//# sourceMappingURL=mock-server.js.map

package/dist-es/tests/mock-server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock-server.js","sourceRoot":"","sources":["../../src/tests/mock-server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAU,MAAM,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAIrC,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,MAAM,OAAO,GAAG,KAAK,CAAC;AAEtB,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,EAAE,CAAC,CAAC;IACnC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAE;QAClD,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC,CAAC;IACF,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAE;QACnD,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC,CAAC;IACF,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAE;QACnD,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/B,CAAC,CAAC;IACF,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAE;QACpD,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG;IAC7B,QAAQ,EAAE,MAAM;IAChB,QAAQ,EAAE,MAAM;IAChB,GAAG,EAAE,6BAA6B;CACnC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,WAA8B,EAA4B,EAAE,CAAC,CAAC;IAC7F,GAAG,sBAAsB;IACzB,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM;CACvC,CAAC,CAAC;AAEH,MAAM,qBAAqB,GAAG;IAC5B,UAAU,EAAE,sCAAsC;IAClD,aAAa,EAAE,uCAAuC;IACtD,IAAI,EAAE;QACJ,WAAW,EAAE,CAAE,OAAO,CAAE;QACxB,QAAQ,EAAE,MAAM;QAChB,eAAe,EAAE,CAAC;QAClB,UAAU,EAAE,CAAC;KACd;IACD,MAAM,EAAE;QACN,GAAG,EAAE,yCAAyC;QAC9C,QAAQ,EAAE,aAAa;QACvB,YAAY,EAAE,SAAS;QACvB,cAAc,EAAE,GAAG;QACnB,QAAQ,EAAE,OAAO;QACjB,QAAQ,EAAE,IAAI;KACf;IACD,cAAc,EAAE,KAAK;CACtB,CAAC;AAQF,MAAM,SAAS,GAAG,CAAC,gBAAmC,EAAE,EAAE,WAAW,GAAG,cAAc,EAAE,EAAE,EAAE;IAC1F,MAAM,MAAM,GAAG,MAAM,CACnB;QACE,GAAG,uBAAuB,CAAC,WAAW,CAAC;QACvC,GAAG,aAAa;KACjB,EACD,SAAgB,CACjB,CAAC;IAEF,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;AACjC,CAAC,CAAC;AAYF,MAAM,wBAAwB,GAAG,GAAG,EAAE,CAAC,CAAC;IACtC,OAAO,EAAE,cAAc,EAAE;IACzB,YAAY,EAAE,qBAAqB;CACpC,CAAC,CAAC;AAEH,MAAM,kBAAkB,GAAG,KAAK,EAC9B,MAAwC,EACxC,WAA4B,EAC5B,EAAE;IACF,MAAM,OAAO,GAAG;QACd,GAAG,wBAAwB,EAAE;QAC7B,GAAG,WAAW;KACf,CAAC;IAEF,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAErG,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAClF,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;IAEvB,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,MAAc,EAAE,EAAE;IAChD,OAAO,GAAG,IAAI,IAAI,MAAM,EAAE,CAAC;AAC7B,CAAC,CAAC;AAOF,MAAM,2BAA2B,GAAsB;IACrD,GAAG,EAAE,sBAAsB,CAAC,GAAG;IAC/B,sBAAsB,EAAE,IAAI;CAC7B,CAAA;AAED,MAAM,aAAa,GAAG,CAAC,iBAA6C,EAAE,EAAE,EAAE;IACxE,MAAM,EAAE,GAAG,EAAE,sBAAsB,EAAE,GAAsB;QACzD,GAAG,2BAA2B;QAC9B,GAAG,cAAc;KAClB,CAAC;IAEF,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;IACnC,IAAI,MAAc,CAAC;IACnB,MAAM,OAAO,GAAG,IAAI,YAAY,EAAE,CAAC;IAEnC,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAAE;QAC5B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IACpC,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,CACvB,MAAc,EACd,IAAY,EACZ,YAA4G,EAC5G,oBAA+B,EAC/B,EAAE;QACF,OAAO,CAAC,WAAW,CACjB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,EACtB,CAAC,OAAwB,EAAE,CAAY,EAAE,EAAE;YACzC,IAAI,oBAAoB,EAAE,CAAC;gBACzB,oBAAoB,CAAC,OAAO,CAAC,CAAC;YAChC,CAAC;YAED,MAAM,QAAQ,GAAkD;gBAC9D,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,GAAG,YAAY;aAChB,CAAC;YAEF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnC,CAAC,CACF,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,mBAAmB,GAAG,CAAC,MAAc,EAAE,IAAY,EAAE,EAAE;QAC3D,OAAO,CAAC,WAAW,CACjB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,EACtB,CAAC,OAAwB,EAAE,CAAY,EAAE,EAAE;YACzC,aAAa;QACf,CAAC,CACF,CAAC;IACJ,CAAC,CAAA;IAED,MAAM,iBAAiB,GAAG,CACxB,MAAc,EACd,IAAY,EACZ,IAAY,EACZ,oBAA+B,EAC/B,EAAE;QACF,gBAAgB,CACd,MAAM,EACN,IAAI,EAAE;YACJ,IAAI;YACJ,IAAI,EAAE,GAAG;SACV,EACD,oBAAoB,CACrB,CAAC;IACJ,CAAC,CAAA;IAED,MAAM,eAAe,GAAG,CACtB,MAAc,EACd,IAAY,EACZ,QAAuB,EACvB,SAAiB,EACjB,oBAA+B,EAC/B,EAAE;QACF,gBAAgB,CACd,MAAM,EACN,IAAI,EACJ;YACE,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAW,CAAC,CAAC,CAAC;gBAC/B,OAAO,EAAE,QAAQ;aAClB;YACD,IAAI,EAAE,SAAS;SAChB,EACD,oBAAoB,CACrB,CAAC;IACJ,CAAC,CAAA;IAED,MAAM,0BAA0B,GAAG,CACjC,UAAkB,EAClB,IAAY,EACZ,YAAoB,EACpB,QAA0B,EAC1B,EAAE;QACF,MAAM,WAAW,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAC9B,MAAM,aAAa,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAEhC,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,UAAU,IAAI,QAAQ,IAAI,IAAI,IAAI,YAAY,EAAE,CAAC,CAAC,CAAC,GAAG,UAAU,IAAI,IAAI,IAAI,YAAY,EAAE,CAAC;QAEtH,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;QACxD,iBAAiB,CAAC,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAE5D,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,QAA0B,EAAE,EAAE;YACxD,IAAI,CAAC;gBACH,KAAK,EAAE,YAAY;gBACnB,IAAI;gBACJ,EAAE,EAAE,QAAQ;aACb,CAAC,CAAC;QACL,CAAC,CAAA;QAED,OAAO;YACL,IAAI;YAEJ,WAAW;YACX,aAAa;YAEb,IAAI;SACL,CAAA;IACH,CAAC,CAAA;IAGD,MAAM,sBAAsB,GAAG,CAC7B,UAAkB,EAClB,YAAoB,EACpB,QAA0B,EAC1B,EAAE;QACF,OAAO,0BAA0B,CAAC,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;IACrF,CAAC,CAAA;IAED,MAAM,cAAc,GAAG,CACrB,UAAkB,EAClB,YAAoB,EACpB,EAAE;QACF,MAAM,UAAU,GAAG,0BAA0B,CAAC,UAAU,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;QAEjF,MAAM,WAAW,GAAG,CAAC,YAAoB,EAAE,EAAE;YAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;YAE3B,iBAAiB,CACf,MAAM,EACN,GAAG,UAAU,CAAC,IAAI,IAAI,YAAY,UAAU,EAC5C,SAAS,EACT,SAAS,CACV,CAAC;YAEF,iBAAiB,CACf,MAAM,EACN,GAAG,UAAU,CAAC,IAAI,IAAI,YAAY,SAAS,EAC3C,SAAS,EACT,QAAQ,CACT,CAAC;YAEF,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAAE;gBAC5B,IAAI,CAAC;oBACH,KAAK,EAAE,YAAY;oBACnB,IAAI;oBACJ,aAAa,EAAE,YAAY;iBAC5B,CAAC,CAAC;YACL,CAAC,CAAA;YAED,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;QACvC,CAAC,CAAC;QAEF,OAAO;YACL,WAAW;YAEX,GAAG,UAAU;SACd,CAAA;IACH,CAAC,CAAA;IAGD,UAAU,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE;QAC9B,MAAM,GAAG,CAAC,CAAC;QAEX,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,UAAU,EAAE,EAAE;YAClC,MAAM,OAAO,GAAoB,IAAI,CAAC,KAAK,CAAC,UAAoB,CAAC,CAAC;YAClE,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;YACtD,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;YACnD,IAAI,sBAAsB,IAAI,CAAC,SAAS,EAAE,CAAC;gBACzC,OAAO,CAAC,IAAI,CAAC,uCAAuC,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;YACxF,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;QAC1B,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,iBAAiB;QACjB,eAAe;QAEf,sBAAsB;QACtB,cAAc;QAEd,oBAAoB,EAAE,mBAAmB;QACzC,IAAI,EAAE,GAAG,EAAE;YACT,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnB,MAAM;YACR,CAAC,CAAC,CAAC;QACL,CAAC;QACD,IAAI;QACJ,GAAG;KACJ,CAAC;AACJ,CAAC,CAAC;AAEF,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,CAAC"}

package/dist-es/tests/test-utils.d.ts

@@ -0,0 +1 @@
+export declare const waitForExpect: (func: () => void | Promise<void>) => Promise<{}>;

package/dist-es/tests/test-utils.js

@@ -0,0 +1,5 @@
+import waitForExpectOriginal from 'wait-for-expect';
+const EXCEPT_TIMEOUT = 1000;
+//@ts-ignore
+export const waitForExpect = (func) => waitForExpectOriginal.default(func, EXCEPT_TIMEOUT);
+//# sourceMappingURL=test-utils.js.map

package/dist-es/tests/test-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utils.js","sourceRoot":"","sources":["../../src/tests/test-utils.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,MAAM,iBAAiB,CAAC;AAEpD,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,YAAY;AACZ,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAgC,EAAE,EAAE,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "airdcpp-apisocket",
-  "version": "3.0.0-beta.4",
+  "version": "3.0.0-beta.6",
   "description": "Javascript connector for AirDC++ Web API",
   "license": "MIT",
   "authors": [

package/src/tests/Socket.test.ts

@@ -1,7 +1,7 @@
 import { 
   DEFAULT_AUTH_RESPONSE, DEFAULT_CONNECT_PARAMS, 
-  getConnectedSocket, getMockServer, getSocket, waitForExpect
-} from './helpers.js';
+  getConnectedSocket, getMockServer, getSocket
+} from './mock-server.js';
 
 import ApiConstants from '../ApiConstants.js';
 
@@ -9,6 +9,7 @@ import { HookCallback, HookSubscriberInfo, SubscriptionRemoveHandler } from '../
 import { IncomingSubscriptionEvent } from '../types/api_internal.js';
 
 import { jest } from '@jest/globals';
+import { waitForExpect } from './test-utils.js';
 
 let server: ReturnType<typeof getMockServer>;
 
@@ -29,7 +30,7 @@ describe('socket', () => {
 
   describe('auth', () => {
     test('should handle valid credentials', async () => {
-      server.addDataHandler('POST', ApiConstants.LOGIN_URL, DEFAULT_AUTH_RESPONSE);
+      server.addRequestHandler('POST', ApiConstants.LOGIN_URL, DEFAULT_AUTH_RESPONSE);
       const connectedCallback = jest.fn();
 
       const { socket, mockConsole } = getSocket();
@@ -48,7 +49,7 @@ describe('socket', () => {
     });
 
     test('should handle valid refresh token', async () => {
-      server.addDataHandler('POST', ApiConstants.LOGIN_URL, DEFAULT_AUTH_RESPONSE);
+      server.addRequestHandler('POST', ApiConstants.LOGIN_URL, DEFAULT_AUTH_RESPONSE);
       const connectedCallback = jest.fn();
 
       const { socket, mockConsole } = getSocket();
@@ -106,7 +107,7 @@ describe('socket', () => {
 
       // Valid connect attempt
       server = getMockServer();
-      server.addDataHandler('POST', ApiConstants.LOGIN_URL, DEFAULT_AUTH_RESPONSE);
+      server.addRequestHandler('POST', ApiConstants.LOGIN_URL, DEFAULT_AUTH_RESPONSE);
 
       await socket.connect(DEFAULT_CONNECT_PARAMS.username, DEFAULT_CONNECT_PARAMS.password, false);
 
@@ -125,17 +126,19 @@ describe('socket', () => {
       socket.onDisconnected = disconnectedCallback;
 
       // Dummy listener
-      server.addDataHandler('POST', 'hubs/listeners/hub_updated', undefined);
+      server.addRequestHandler('POST', 'hubs/listeners/hub_updated', undefined);
       await socket.addListener('hubs', 'hub_updated', dummyfn);
 
       // Dummy pending request
+      server.ignoreMissingHandler('DELETE', 'dummyLogoutDelete');
+
       socket.delete('dummyLogoutDelete').catch((error: Error) => {
         // TODO: fix, too unreliable at the moment (depends on the timings)
         //expect(error.message).toEqual('Socket disconnected');
       });
 
       // Logout
-      server.addDataHandler('DELETE', ApiConstants.LOGOUT_URL);
+      server.addRequestHandler('DELETE', ApiConstants.LOGOUT_URL);
       await socket.logout();
 
       expect(sessionResetCallback.mock.calls.length).toBe(1);
@@ -206,7 +209,7 @@ describe('socket', () => {
       expect(mockConsole.error.mock.calls.length).toBe(1);
 
       server = getMockServer();
-      server.addDataHandler('POST', ApiConstants.CONNECT_URL, undefined);
+      server.addRequestHandler('POST', ApiConstants.CONNECT_URL, undefined);
       jest.runOnlyPendingTimers();
       jest.runOnlyPendingTimers();
       jest.runOnlyPendingTimers();
@@ -257,7 +260,7 @@ describe('socket', () => {
       socket.disconnect();
       await waitForExpect(() => expect(socket.isActive()).toEqual(false));
 
-      server.addDataHandler('POST', ApiConstants.CONNECT_URL, undefined);
+      server.addRequestHandler('POST', ApiConstants.CONNECT_URL, undefined);
       await socket.reconnect();
       expect(socket.isConnected()).toEqual(true);
 
@@ -285,7 +288,7 @@ describe('socket', () => {
       server.addErrorHandler('POST', ApiConstants.CONNECT_URL, ErrorResponse, 400);
       
       const authCallback = jest.fn();
-      server.addDataHandler('POST', ApiConstants.LOGIN_URL, DEFAULT_AUTH_RESPONSE, authCallback);
+      server.addRequestHandler('POST', ApiConstants.LOGIN_URL, DEFAULT_AUTH_RESPONSE, authCallback);
 
       jest.runOnlyPendingTimers();
       socket.reconnect();
@@ -328,6 +331,9 @@ describe('socket', () => {
     test('should report request timeouts', async () => {
       const { socket, mockConsole } = await getConnectedSocket(server);
 
+      server.ignoreMissingHandler('POST', 'hubs/listeners/hub_updated');
+      server.ignoreMissingHandler('POST', 'hubs/listeners/hub_added');
+
       jest.useFakeTimers();
       socket.addListener('hubs', 'hub_updated', dummyfn)
         .catch(() => {});
@@ -388,8 +394,8 @@ describe('socket', () => {
 
     test('should handle listener messages', async () => {
       const { socket, mockConsole } = await getConnectedSocket(server);
-      server.addDataHandler('POST', 'hubs/listeners/hub_updated', undefined);
-      server.addDataHandler('POST', `hubs/${entityId}/listeners/hub_updated`, undefined);
+      server.addSubscriptionHandler('hubs', 'hub_updated');
+      server.addSubscriptionHandler('hubs', 'hub_updated', entityId);
 
       const commonSubscriptionCallback = jest.fn();
       const entitySubscriptionCallback = jest.fn();
@@ -415,8 +421,7 @@ describe('socket', () => {
     test('should handle listener removal', async () => {
       const { socket, mockConsole } = await getConnectedSocket(server);
 
-      const subscribeCallback = jest.fn();
-      server.addDataHandler('POST', 'hubs/listeners/hub_updated', undefined, subscribeCallback);
+      const hubUpdatedListener = server.addSubscriptionHandler('hubs', 'hub_updated');
 
       // Add two simultaneous pending add events
       const p1 = socket.addListener('hubs', 'hub_updated', dummyfn);
@@ -428,17 +433,14 @@ describe('socket', () => {
       const removeListener1 = await p1;
       const removeListener2 = await p2;
 
-      expect(subscribeCallback.mock.calls.length).toBe(1);
+      expect(hubUpdatedListener.subscribeFn.mock.calls.length).toBe(1);
       expect(socket.getPendingSubscriptionCount()).toBe(0);
 
-      const deleteCallback = jest.fn();
-      server.addDataHandler('DELETE', 'hubs/listeners/hub_updated', undefined, deleteCallback);
-
       removeListener1();
-      expect(deleteCallback.mock.calls.length).toBe(0); // Shouldn't call API yet, still one left
+      expect(hubUpdatedListener.unsubscribeFn.mock.calls.length).toBe(0); // Shouldn't call API yet, still one left
 
       removeListener2();
-      await waitForExpect(() => expect(deleteCallback.mock.calls.length).toBe(1));
+      await waitForExpect(() => expect(hubUpdatedListener.unsubscribeFn.mock.calls.length).toBe(1));
 
       expect(socket.hasListeners()).toBe(false);
 
@@ -466,11 +468,9 @@ describe('socket', () => {
   });
 
   describe('hooks', () => {
-    const hookEventData: IncomingSubscriptionEvent = {
-      event: 'queue_bundle_finished_hook',
-      data: {},
-      completion_id: 1,
-    };
+    const HOOK_MODULE = 'queue';
+    const HOOK_NAME = 'queue_bundle_finished_hook';
+    const HOOK_COMPLETION_ID = 1;
 
     const hookSubscriberInfo: HookSubscriberInfo = {
       id: 'sfv_checker', 
@@ -487,26 +487,22 @@ describe('socket', () => {
 
       // Add hook
       {
-        const hookAddCallback = jest.fn();
-        server.addDataHandler('POST', 'queue/hooks/queue_bundle_finished_hook', undefined, hookAddCallback);
+        const hook = server.addHookHandler(HOOK_MODULE, HOOK_NAME);
 
         removeListener = await socket.addHook(
-          'queue', 
-          'queue_bundle_finished_hook', 
+          HOOK_MODULE, 
+          HOOK_NAME, 
           rejectCallback, 
           hookSubscriberInfo
         );
 
-        expect((hookAddCallback.mock.calls[0][0] as any).data).toEqual(hookSubscriberInfo);
-        expect(hookAddCallback.mock.calls.length).toBe(1);
-      }
+        expect((hook.subscribeFn.mock.calls[0][0] as any).data).toEqual(hookSubscriberInfo);
+        expect(hook.subscribeFn.mock.calls.length).toBe(1);
 
-      // Simulate action
-      {
-        const hookEventCallback = jest.fn();
-        server.addDataHandler('POST', 'queue/hooks/queue_bundle_finished_hook/1/reject', undefined, hookEventCallback);
-        server.send(hookEventData);
-        await waitForExpect(() => expect(hookEventCallback.mock.calls.length).toBe(1));
+        // Simulate action
+        const hookResolver = hook.addResolver(HOOK_COMPLETION_ID);
+        hookResolver.fire({});
+        await waitForExpect(() => expect(hookResolver.rejectFn.mock.calls.length).toBe(1));
       }
 
       // Clean up

package/src/tests/mock-server.ts

@@ -0,0 +1,328 @@
+import { Socket } from '../NodeSocket.js';
+import { Client, Server, WebSocket } from 'mock-socket';
+import { jest } from '@jest/globals';
+
+import { OutgoingRequest, RequestSuccessResponse, RequestErrorResponse } from '../types/api_internal.js';
+import * as Options from '../types/options.js';
+import ApiConstants from '../ApiConstants.js';
+import { EventEmitter } from 'events';
+
+const VERBOSE = false;
+
+export const getMockConsole = () => ({
+  log: jest.fn((a1: any, a2: any, a3: any, a4: any) => {
+    if (VERBOSE) {
+      console.log(a1, a2, a3, a4);
+    }
+  }),
+  info: jest.fn((a1: any, a2: any, a3: any, a4: any) => {
+    if (VERBOSE) {
+      console.info(a1, a2, a3, a4);
+    }
+  }),
+  warn: jest.fn((a1: any, a2: any, a3: any, a4: any) => {
+    console.warn(a1, a2, a3, a4);
+  }),
+  error: jest.fn((a1: any, a2: any, a3: any, a4: any) => {
+    console.error(a1, a2, a3, a4);
+  }),
+});
+
+const DEFAULT_CONNECT_PARAMS = {
+  username: 'test',
+  password: 'test',
+  url: 'ws://localhost:7171/api/v1/',
+};
+
+const getDefaultSocketOptions = (mockConsole: Options.LogOutput): Options.APISocketOptions => ({
+  ...DEFAULT_CONNECT_PARAMS,
+  logOutput: mockConsole,
+  logLevel: VERBOSE ? 'verbose' : 'warn',
+});
+
+const DEFAULT_AUTH_RESPONSE = {
+  auth_token: 'b823187f-4aab-4b71-9764-e63e88401a26',
+  refresh_token: '5124faasf-4aab-4b71-9764-e63e88401a26',
+  user: {
+    permissions: [ 'admin' ],
+    username: 'test',
+    active_sessions: 1,
+    last_login: 0,
+  },
+  system: {
+    cid: 'AHLUODI2YZ2U7FDWMHFNJU65ERGKUN4MH7GW5LY',
+    hostname: 'ubuntu-htpc',
+    network_type: 'private',
+    path_separator: '/',
+    platform: 'other',
+    language: 'fi',
+  },
+  wizard_pending: false,
+};
+
+export type MockSocketOptions = Omit<Options.APISocketOptions, 'username' | 'password' | 'url'> & {
+  username?: string;
+  password?: string;
+  url?: string;
+};
+
+const getSocket = (socketOptions: MockSocketOptions = {}, mockConsole = getMockConsole()) => {
+  const socket = Socket(
+    {
+      ...getDefaultSocketOptions(mockConsole),
+      ...socketOptions,
+    }, 
+    WebSocket as any
+  );
+  
+  return { socket, mockConsole };
+};
+
+
+type Callback = (requestData: object) => void;
+
+interface ConnectOptions {
+  socketOptions?: MockSocketOptions;
+  authCallback?: Callback;
+  authResponse?: object;
+  console?: ReturnType<typeof getMockConsole>;
+}
+
+const getDefaultConnectOptions = () => ({
+  console: getMockConsole(),
+  authResponse: DEFAULT_AUTH_RESPONSE,
+});
+
+const getConnectedSocket = async (
+  server: ReturnType<typeof getMockServer>, 
+  userOptions?: ConnectOptions,
+) => {
+  const options = {
+    ...getDefaultConnectOptions(),
+    ...userOptions,
+  };
+
+  server.addRequestHandler('POST', ApiConstants.LOGIN_URL, options.authResponse, options.authCallback);
+
+  const { socket, mockConsole } = getSocket(options.socketOptions, options.console);
+  await socket.connect();
+
+  return { socket, mockConsole };
+};
+
+const toEmitId = (path: string, method: string) => {
+  return `${path}_${method}`;
+};
+
+interface MockServerOptions {
+  url: string;
+  reportMissingListeners?: boolean;
+}
+
+const DEFAULT_MOCK_SERVER_OPTIONS: MockServerOptions = {
+  url: DEFAULT_CONNECT_PARAMS.url,
+  reportMissingListeners: true,
+}
+
+const getMockServer = (initialOptions: Partial<MockServerOptions> = {}) => {
+  const { url, reportMissingListeners }: MockServerOptions = {
+    ...DEFAULT_MOCK_SERVER_OPTIONS,
+    ...initialOptions,
+  };
+
+  const mockServer = new Server(url);
+  let socket: Client;
+  const emitter = new EventEmitter();
+
+  const send = (data: object) => {
+    socket.send(JSON.stringify(data));
+  };
+
+  const addServerHandler = <DataT extends object | undefined>(
+    method: string, 
+    path: string, 
+    responseData: Omit<RequestSuccessResponse<DataT>, 'callback_id'> | Omit<RequestErrorResponse, 'callback_id'>, 
+    subscriptionCallback?: Callback
+  ) => {
+    emitter.addListener(
+      toEmitId(path, method), 
+      (request: OutgoingRequest, s: WebSocket) => {
+        if (subscriptionCallback) {
+          subscriptionCallback(request);
+        }
+
+        const response: RequestSuccessResponse | RequestErrorResponse = {
+          callback_id: request.callback_id,
+          ...responseData,
+        };
+
+        s.send(JSON.stringify(response));
+      }
+    );
+  };
+
+  const addDummyDataHandler = (method: string, path: string) => {
+    emitter.addListener(
+      toEmitId(path, method), 
+      (request: OutgoingRequest, s: WebSocket) => {
+        // Do nothing
+      }
+    );
+  }
+
+  const addRequestHandler = <DataT extends object | undefined>(
+    method: string, 
+    path: string, 
+    data?: DataT, 
+    subscriptionCallback?: Callback
+  ) => {
+    addServerHandler<DataT>(
+      method, 
+      path, {
+        data,
+        code: 200,
+      }, 
+      subscriptionCallback
+    );
+  }
+
+  const addErrorHandler = (
+    method: string, 
+    path: string, 
+    errorStr: string | null, 
+    errorCode: number, 
+    subscriptionCallback?: Callback
+  ) => {
+    addServerHandler(
+      method, 
+      path, 
+      {
+        error: !errorStr ? null as any : {
+          message: errorStr,
+        },
+        code: errorCode,
+      }, 
+      subscriptionCallback
+    );
+  }
+
+  const addSubscriptionHandlerImpl = (
+    moduleName: string,
+    type: string,
+    listenerName: string,
+    entityId?: string | number,
+  ) => {
+    const subscribeFn = jest.fn();
+    const unsubscribeFn = jest.fn();
+
+    const path = entityId ? `${moduleName}/${entityId}/${type}/${listenerName}` : `${moduleName}/${type}/${listenerName}`;
+
+    addRequestHandler('POST', path, undefined, subscribeFn);
+    addRequestHandler('DELETE', path, undefined, unsubscribeFn);
+
+    const fire = (data: object, entityId?: string | number) => {
+      send({
+        event: listenerName,
+        data,
+        id: entityId,
+      });
+    }
+
+    return {
+      fire,
+
+      subscribeFn,
+      unsubscribeFn,
+
+      path,
+    }
+  }
+  
+
+  const addSubscriptionHandler = (
+    moduleName: string,
+    listenerName: string,
+    entityId?: string | number,
+  ) => {
+    return addSubscriptionHandlerImpl(moduleName, 'listeners', listenerName, entityId);
+  }
+
+  const addHookHandler = (
+    moduleName: string,
+    listenerName: string,
+  ) => {
+    const subscriber = addSubscriptionHandlerImpl(moduleName, 'hooks', listenerName);
+
+    const addResolver = (completionId: number) => {
+      const resolveFn = jest.fn();
+      const rejectFn = jest.fn();
+
+      addRequestHandler(
+        'POST', 
+        `${subscriber.path}/${completionId}/resolve`, 
+        undefined, 
+        resolveFn
+      );
+
+      addRequestHandler(
+        'POST', 
+        `${subscriber.path}/${completionId}/reject`, 
+        undefined, 
+        rejectFn
+      );
+
+      const fire = (data: object) => {
+        send({
+          event: listenerName,
+          data,
+          completion_id: completionId,
+        });
+      }
+
+      return { fire, resolveFn, rejectFn };
+    };
+
+    return {
+      addResolver,
+
+      ...subscriber,
+    }
+  }
+
+
+  mockServer.on('connection', s => {
+    socket = s;
+
+    socket.on('message', (messageObj) => {
+      const request: OutgoingRequest = JSON.parse(messageObj as string);
+      const emitId = toEmitId(request.path, request.method);
+      const processed = emitter.emit(emitId, request, s);
+      if (reportMissingListeners && !processed) {
+        console.warn(`Mock server: no listeners for event ${request.method} ${request.path}`);
+      }
+    });
+  });
+
+  mockServer.on('close', () => {
+    emitter.removeAllListeners();
+  });
+
+  return {
+    addRequestHandler,
+    addErrorHandler,
+
+    addSubscriptionHandler,
+    addHookHandler,
+
+    ignoreMissingHandler: addDummyDataHandler,
+    stop: () => {
+      mockServer.stop(() => {
+        // ...
+      });
+    },
+    send,
+    url,
+  };
+};
+
+export { getMockServer, getSocket, getConnectedSocket, DEFAULT_CONNECT_PARAMS, DEFAULT_AUTH_RESPONSE };

package/src/tests/public_helpers.test.ts

@@ -1,15 +1,14 @@
 import { 
   getMockServer,
   getConnectedSocket,
-  waitForExpect,
-} from './helpers.js';
+} from './mock-server.js';
+import { waitForExpect } from './test-utils.js';
 
 import { jest } from '@jest/globals';
 
 import { addContextMenuItems } from '../PublicHelpers.js';
 import { SelectedMenuItemListenerData, MenuItemListHookData, MenuItemListHookAcceptData } from '../types/public_helpers_internal.js';
 import { HookSubscriberInfo, MenuCallbackProperties, MenuClickHandlerProperties } from '../types/index.js';
-import { IncomingSubscriptionEvent } from '../types/api_internal.js';
 
 
 let server: ReturnType<typeof getMockServer>;
@@ -97,19 +96,10 @@ describe('public helpers', () => {
       // Socket handlers
       const { socket } = await getConnectedSocket(server);
 
-      const listenerAddCallback = jest.fn();
-      server.addDataHandler('POST', `menus/listeners/${MENU_ID}_menuitem_selected`, undefined, listenerAddCallback);
-
-      const hookAddCallback = jest.fn();
-      const hookResolveCallback = jest.fn();
-      server.addDataHandler('POST', `menus/hooks/${MENU_ID}_list_menuitems`, undefined, hookAddCallback);
-      server.addDataHandler(
-        'POST', 
-        `menus/hooks/${MENU_ID}_list_menuitems/${HOOK_COMPLETION_ID}/resolve`, 
-        menuItemListData, 
-        hookResolveCallback
-      );
+      const itemSelectedListener = server.addSubscriptionHandler('menus', `${MENU_ID}_menuitem_selected`);
 
+      const listItemsHook = server.addHookHandler('menus', `${MENU_ID}_list_menuitems`);
+      const listItemsResolver = listItemsHook.addResolver(HOOK_COMPLETION_ID);
 
       // Add menu items
       const onClickItem1Mock = jest.fn();
@@ -166,33 +156,29 @@ describe('public helpers', () => {
         SUBSCRIBER_INFO,
       );
       
-      expect(listenerAddCallback).toHaveBeenCalledTimes(1);
-      expect(hookAddCallback).toHaveBeenCalledTimes(1);
+      expect(itemSelectedListener.subscribeFn).toHaveBeenCalledTimes(1);
+      expect(listItemsHook.subscribeFn).toHaveBeenCalledTimes(1);
 
 
       // List items hook
       {
-        const hookEventData: IncomingSubscriptionEvent<MenuItemListHookData<string, null>> = {
-          event: `${MENU_ID}_list_menuitems`,
-          data: {
-            selected_ids: selectedMenuIds,
-            entity_id: null,
-            permissions: PERMISSIONS,
-            supports: SUPPORTS,
-          },
-          completion_id: 1,
+        const menuItemListData: MenuItemListHookData<string, null> = {
+          selected_ids: selectedMenuIds,
+          entity_id: null,
+          permissions: PERMISSIONS,
+          supports: SUPPORTS,
         };
 
-        server.send(hookEventData);
+        listItemsResolver.fire(menuItemListData);
       }
 
       // Validate list items results
       {
         await waitForExpect(() => {
-          expect(hookResolveCallback).toHaveBeenCalledTimes(1);
+          expect(listItemsResolver.resolveFn).toHaveBeenCalledTimes(1);
         });
 
-        expect(hookResolveCallback).toHaveBeenCalledWith(
+        expect(listItemsResolver.resolveFn).toHaveBeenCalledWith(
           expect.objectContaining({
             data: menuItemListData
           }),
@@ -214,22 +200,18 @@ describe('public helpers', () => {
 
       // Select event listener
       {
-        const selectEventData: IncomingSubscriptionEvent<SelectedMenuItemListenerData<string, null>> = {
-          event: `${MENU_ID}_menuitem_selected`,
-          data: {
-            menuitem_id: MENU_ITEM1_ID,
-            hook_id: SUBSCRIBER_INFO.id,
-            menu_id: MENU_ID,
-            entity_id: null,
-            selected_ids: selectedMenuIds,
-            permissions: PERMISSIONS,
-            supports: SUPPORTS,
-            form_values: FORM_VALUES
-          },
-          completion_id: HOOK_COMPLETION_ID,
+        const selectData: SelectedMenuItemListenerData<string, null> = {
+          menuitem_id: MENU_ITEM1_ID,
+          hook_id: SUBSCRIBER_INFO.id,
+          menu_id: MENU_ID,
+          entity_id: null,
+          selected_ids: selectedMenuIds,
+          permissions: PERMISSIONS,
+          supports: SUPPORTS,
+          form_values: FORM_VALUES
         };
 
-        server.send(selectEventData);
+        itemSelectedListener.fire(selectData);
       }
 
       // Validate select event results

package/src/tests/test-utils.ts

@@ -0,0 +1,5 @@
+import waitForExpectOriginal from 'wait-for-expect';
+
+const EXCEPT_TIMEOUT = 1000;
+//@ts-ignore
+export const waitForExpect = (func: () => void | Promise<void>) => waitForExpectOriginal.default(func, EXCEPT_TIMEOUT);

package/dist-es/tests/helpers.js

@@ -1,134 +0,0 @@
-import { Socket } from '../NodeSocket.js';
-import { Server, WebSocket } from 'mock-socket';
-import { jest } from '@jest/globals';
-import ApiConstants from '../ApiConstants.js';
-import { EventEmitter } from 'events';
-import waitForExpectOriginal from 'wait-for-expect';
-const EXCEPT_TIMEOUT = 1000;
-//@ts-ignore
-export const waitForExpect = (func) => waitForExpectOriginal.default(func, EXCEPT_TIMEOUT);
-const VERBOSE = false;
-const getMockConsole = () => ({
-    log: jest.fn((a1, a2, a3, a4) => {
-        if (VERBOSE) {
-            console.log(a1, a2, a3, a4);
-        }
-    }),
-    info: jest.fn((a1, a2, a3, a4) => {
-        if (VERBOSE) {
-            console.info(a1, a2, a3, a4);
-        }
-    }),
-    warn: jest.fn((a1, a2, a3, a4) => {
-        console.warn(a1, a2, a3, a4);
-    }),
-    error: jest.fn((a1, a2, a3, a4) => {
-        console.error(a1, a2, a3, a4);
-    }),
-});
-const DEFAULT_CONNECT_PARAMS = {
-    username: 'test',
-    password: 'test',
-    url: 'ws://localhost:7171/api/v1/',
-};
-const getDefaultSocketOptions = (mockConsole) => ({
-    ...DEFAULT_CONNECT_PARAMS,
-    logOutput: mockConsole,
-    logLevel: VERBOSE ? 'verbose' : 'warn',
-});
-const DEFAULT_AUTH_RESPONSE = {
-    auth_token: 'b823187f-4aab-4b71-9764-e63e88401a26',
-    refresh_token: '5124faasf-4aab-4b71-9764-e63e88401a26',
-    user: {
-        permissions: ['admin'],
-        username: 'test',
-        active_sessions: 1,
-        last_login: 0,
-    },
-    system: {
-        cid: 'AHLUODI2YZ2U7FDWMHFNJU65ERGKUN4MH7GW5LY',
-        hostname: 'ubuntu-htpc',
-        network_type: 'private',
-        path_separator: '/',
-        platform: 'other',
-        language: 'fi',
-    },
-    wizard_pending: false,
-};
-const getSocket = (socketOptions = {}, mockConsole = getMockConsole()) => {
-    const socket = Socket({
-        ...getDefaultSocketOptions(mockConsole),
-        ...socketOptions,
-    }, WebSocket);
-    return { socket, mockConsole };
-};
-const getDefaultConnectOptions = () => ({
-    console: getMockConsole(),
-    authResponse: DEFAULT_AUTH_RESPONSE,
-});
-const getConnectedSocket = async (server, userOptions) => {
-    const options = {
-        ...getDefaultConnectOptions(),
-        ...userOptions,
-    };
-    server.addDataHandler('POST', ApiConstants.LOGIN_URL, options.authResponse, options.authCallback);
-    const { socket, mockConsole } = getSocket(options.socketOptions, options.console);
-    await socket.connect();
-    return { socket, mockConsole };
-};
-const toEmitId = (path, method) => {
-    return `${path}_${method}`;
-};
-const getMockServer = (url = DEFAULT_CONNECT_PARAMS.url) => {
-    const mockServer = new Server(url);
-    let socket;
-    const emitter = new EventEmitter();
-    const addServerHandler = (method, path, responseData, subscriptionCallback) => {
-        emitter.addListener(toEmitId(path, method), (request, s) => {
-            if (subscriptionCallback) {
-                subscriptionCallback(request);
-            }
-            const response = {
-                callback_id: request.callback_id,
-                ...responseData,
-            };
-            s.send(JSON.stringify(response));
-        });
-    };
-    mockServer.on('connection', s => {
-        socket = s;
-        socket.on('message', (messageObj) => {
-            const request = JSON.parse(messageObj);
-            emitter.emit(toEmitId(request.path, request.method), request, s);
-        });
-    });
-    mockServer.on('close', () => {
-        emitter.removeAllListeners();
-    });
-    return {
-        addDataHandler: (method, path, data, subscriptionCallback) => {
-            addServerHandler(method, path, {
-                data,
-                code: 200,
-            }, subscriptionCallback);
-        },
-        addErrorHandler: (method, path, errorStr, errorCode, subscriptionCallback) => {
-            addServerHandler(method, path, {
-                error: !errorStr ? null : {
-                    message: errorStr,
-                },
-                code: errorCode,
-            }, subscriptionCallback);
-        },
-        stop: () => {
-            mockServer.stop(() => {
-                // ...
-            });
-        },
-        send: (data) => {
-            socket.send(JSON.stringify(data));
-        },
-    };
-};
-export { getMockServer, getSocket, getConnectedSocket, DEFAULT_CONNECT_PARAMS, DEFAULT_AUTH_RESPONSE };
-//# sourceMappingURL=helpers.js.map

package/dist-es/tests/helpers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/tests/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAU,MAAM,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAIrC,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,qBAAqB,MAAM,iBAAiB,CAAC;AAEpD,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,YAAY;AACZ,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAgC,EAAE,EAAE,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;AAEvH,MAAM,OAAO,GAAG,KAAK,CAAC;AAEtB,MAAM,cAAc,GAAG,GAAG,EAAE,CAAC,CAAC;IAC5B,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAE;QAClD,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC,CAAC;IACF,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAE;QACnD,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC,CAAC;IACF,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAE;QACnD,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/B,CAAC,CAAC;IACF,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAE;QACpD,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG;IAC7B,QAAQ,EAAE,MAAM;IAChB,QAAQ,EAAE,MAAM;IAChB,GAAG,EAAE,6BAA6B;CACnC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,WAA8B,EAA4B,EAAE,CAAC,CAAC;IAC7F,GAAG,sBAAsB;IACzB,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM;CACvC,CAAC,CAAC;AAEH,MAAM,qBAAqB,GAAG;IAC5B,UAAU,EAAE,sCAAsC;IAClD,aAAa,EAAE,uCAAuC;IACtD,IAAI,EAAE;QACJ,WAAW,EAAE,CAAE,OAAO,CAAE;QACxB,QAAQ,EAAE,MAAM;QAChB,eAAe,EAAE,CAAC;QAClB,UAAU,EAAE,CAAC;KACd;IACD,MAAM,EAAE;QACN,GAAG,EAAE,yCAAyC;QAC9C,QAAQ,EAAE,aAAa;QACvB,YAAY,EAAE,SAAS;QACvB,cAAc,EAAE,GAAG;QACnB,QAAQ,EAAE,OAAO;QACjB,QAAQ,EAAE,IAAI;KACf;IACD,cAAc,EAAE,KAAK;CACtB,CAAC;AAQF,MAAM,SAAS,GAAG,CAAC,gBAAmC,EAAE,EAAE,WAAW,GAAG,cAAc,EAAE,EAAE,EAAE;IAC1F,MAAM,MAAM,GAAG,MAAM,CACnB;QACE,GAAG,uBAAuB,CAAC,WAAW,CAAC;QACvC,GAAG,aAAa;KACjB,EACD,SAAgB,CACjB,CAAC;IAEF,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;AACjC,CAAC,CAAC;AAYF,MAAM,wBAAwB,GAAG,GAAG,EAAE,CAAC,CAAC;IACtC,OAAO,EAAE,cAAc,EAAE;IACzB,YAAY,EAAE,qBAAqB;CACpC,CAAC,CAAC;AAEH,MAAM,kBAAkB,GAAG,KAAK,EAC9B,MAAwC,EACxC,WAA4B,EAC5B,EAAE;IACF,MAAM,OAAO,GAAG;QACd,GAAG,wBAAwB,EAAE;QAC7B,GAAG,WAAW;KACf,CAAC;IAEF,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAElG,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAClF,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;IAEvB,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,MAAc,EAAE,EAAE;IAChD,OAAO,GAAG,IAAI,IAAI,MAAM,EAAE,CAAC;AAC7B,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,GAAG,GAAG,sBAAsB,CAAC,GAAG,EAAE,EAAE;IACzD,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;IACnC,IAAI,MAAc,CAAC;IACnB,MAAM,OAAO,GAAG,IAAI,YAAY,EAAE,CAAC;IAEnC,MAAM,gBAAgB,GAAG,CACvB,MAAc,EACd,IAAY,EACZ,YAA4G,EAC5G,oBAA+B,EAC/B,EAAE;QACF,OAAO,CAAC,WAAW,CACjB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,EACtB,CAAC,OAAwB,EAAE,CAAY,EAAE,EAAE;YACzC,IAAI,oBAAoB,EAAE,CAAC;gBACzB,oBAAoB,CAAC,OAAO,CAAC,CAAC;YAChC,CAAC;YAED,MAAM,QAAQ,GAAkD;gBAC9D,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,GAAG,YAAY;aAChB,CAAC;YAEF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnC,CAAC,CACF,CAAC;IACJ,CAAC,CAAC;IAEF,UAAU,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE;QAC9B,MAAM,GAAG,CAAC,CAAC;QAEX,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,UAAU,EAAE,EAAE;YAClC,MAAM,OAAO,GAAoB,IAAI,CAAC,KAAK,CAAC,UAAoB,CAAC,CAAC;YAClE,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;QAC1B,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,cAAc,EAAE,CACd,MAAc,EACd,IAAY,EACZ,IAAY,EACZ,oBAA+B,EAC/B,EAAE;YACF,gBAAgB,CACd,MAAM,EACN,IAAI,EAAE;gBACJ,IAAI;gBACJ,IAAI,EAAE,GAAG;aACV,EACD,oBAAoB,CACrB,CAAC;QACJ,CAAC;QACD,eAAe,EAAE,CACf,MAAc,EACd,IAAY,EACZ,QAAuB,EACvB,SAAiB,EACjB,oBAA+B,EAC/B,EAAE;YACF,gBAAgB,CACd,MAAM,EACN,IAAI,EACJ;gBACE,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAW,CAAC,CAAC,CAAC;oBAC/B,OAAO,EAAE,QAAQ;iBAClB;gBACD,IAAI,EAAE,SAAS;aAChB,EACD,oBAAoB,CACrB,CAAC;QACJ,CAAC;QACD,IAAI,EAAE,GAAG,EAAE;YACT,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnB,MAAM;YACR,CAAC,CAAC,CAAC;QACL,CAAC;QACD,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE;YACrB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QACpC,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,CAAC"}

package/src/tests/helpers.ts

@@ -1,210 +0,0 @@
-import { Socket } from '../NodeSocket.js';
-import { Client, Server, WebSocket } from 'mock-socket';
-import { jest } from '@jest/globals';
-
-import { OutgoingRequest, RequestSuccessResponse, RequestErrorResponse } from '../types/api_internal.js';
-import * as Options from '../types/options.js';
-import ApiConstants from '../ApiConstants.js';
-import { EventEmitter } from 'events';
-
-import waitForExpectOriginal from 'wait-for-expect';
-
-const EXCEPT_TIMEOUT = 1000;
-//@ts-ignore
-export const waitForExpect = (func: () => void | Promise<void>) => waitForExpectOriginal.default(func, EXCEPT_TIMEOUT);
-
-const VERBOSE = false;
-
-const getMockConsole = () => ({
-  log: jest.fn((a1: any, a2: any, a3: any, a4: any) => {
-    if (VERBOSE) {
-      console.log(a1, a2, a3, a4);
-    }
-  }),
-  info: jest.fn((a1: any, a2: any, a3: any, a4: any) => {
-    if (VERBOSE) {
-      console.info(a1, a2, a3, a4);
-    }
-  }),
-  warn: jest.fn((a1: any, a2: any, a3: any, a4: any) => {
-    console.warn(a1, a2, a3, a4);
-  }),
-  error: jest.fn((a1: any, a2: any, a3: any, a4: any) => {
-    console.error(a1, a2, a3, a4);
-  }),
-});
-
-const DEFAULT_CONNECT_PARAMS = {
-  username: 'test',
-  password: 'test',
-  url: 'ws://localhost:7171/api/v1/',
-};
-
-const getDefaultSocketOptions = (mockConsole: Options.LogOutput): Options.APISocketOptions => ({
-  ...DEFAULT_CONNECT_PARAMS,
-  logOutput: mockConsole,
-  logLevel: VERBOSE ? 'verbose' : 'warn',
-});
-
-const DEFAULT_AUTH_RESPONSE = {
-  auth_token: 'b823187f-4aab-4b71-9764-e63e88401a26',
-  refresh_token: '5124faasf-4aab-4b71-9764-e63e88401a26',
-  user: {
-    permissions: [ 'admin' ],
-    username: 'test',
-    active_sessions: 1,
-    last_login: 0,
-  },
-  system: {
-    cid: 'AHLUODI2YZ2U7FDWMHFNJU65ERGKUN4MH7GW5LY',
-    hostname: 'ubuntu-htpc',
-    network_type: 'private',
-    path_separator: '/',
-    platform: 'other',
-    language: 'fi',
-  },
-  wizard_pending: false,
-};
-
-export type MockSocketOptions = Omit<Options.APISocketOptions, 'username' | 'password' | 'url'> & {
-  username?: string;
-  password?: string;
-  url?: string;
-};
-
-const getSocket = (socketOptions: MockSocketOptions = {}, mockConsole = getMockConsole()) => {
-  const socket = Socket(
-    {
-      ...getDefaultSocketOptions(mockConsole),
-      ...socketOptions,
-    }, 
-    WebSocket as any
-  );
-  
-  return { socket, mockConsole };
-};
-
-
-type Callback = (requestData: object) => void;
-
-interface ConnectOptions {
-  socketOptions?: MockSocketOptions;
-  authCallback?: Callback;
-  authResponse?: object;
-  console?: ReturnType<typeof getMockConsole>;
-}
-
-const getDefaultConnectOptions = () => ({
-  console: getMockConsole(),
-  authResponse: DEFAULT_AUTH_RESPONSE,
-});
-
-const getConnectedSocket = async (
-  server: ReturnType<typeof getMockServer>, 
-  userOptions?: ConnectOptions,
-) => {
-  const options = {
-    ...getDefaultConnectOptions(),
-    ...userOptions,
-  };
-
-  server.addDataHandler('POST', ApiConstants.LOGIN_URL, options.authResponse, options.authCallback);
-
-  const { socket, mockConsole } = getSocket(options.socketOptions, options.console);
-  await socket.connect();
-
-  return { socket, mockConsole };
-};
-
-const toEmitId = (path: string, method: string) => {
-  return `${path}_${method}`;
-};
-
-const getMockServer = (url = DEFAULT_CONNECT_PARAMS.url) => {
-  const mockServer = new Server(url);
-  let socket: Client;
-  const emitter = new EventEmitter();
-
-  const addServerHandler = <DataT extends object | undefined>(
-    method: string, 
-    path: string, 
-    responseData: Omit<RequestSuccessResponse<DataT>, 'callback_id'> | Omit<RequestErrorResponse, 'callback_id'>, 
-    subscriptionCallback?: Callback
-  ) => {
-    emitter.addListener(
-      toEmitId(path, method), 
-      (request: OutgoingRequest, s: WebSocket) => {
-        if (subscriptionCallback) {
-          subscriptionCallback(request);
-        }
-
-        const response: RequestSuccessResponse | RequestErrorResponse = {
-          callback_id: request.callback_id,
-          ...responseData,
-        };
-
-        s.send(JSON.stringify(response));
-      }
-    );
-  };
-
-  mockServer.on('connection', s => {
-    socket = s;
-
-    socket.on('message', (messageObj) => {
-      const request: OutgoingRequest = JSON.parse(messageObj as string);
-      emitter.emit(toEmitId(request.path, request.method), request, s);
-    });
-  });
-
-  mockServer.on('close', () => {
-    emitter.removeAllListeners();
-  });
-
-  return {
-    addDataHandler: <DataT extends object | undefined>(
-      method: string, 
-      path: string, 
-      data?: DataT, 
-      subscriptionCallback?: Callback
-    ) => {
-      addServerHandler<DataT>(
-        method, 
-        path, {
-          data,
-          code: 200,
-        }, 
-        subscriptionCallback
-      );
-    },
-    addErrorHandler: (
-      method: string, 
-      path: string, 
-      errorStr: string | null, 
-      errorCode: number, 
-      subscriptionCallback?: Callback
-    ) => {
-      addServerHandler(
-        method, 
-        path, 
-        {
-          error: !errorStr ? null as any : {
-            message: errorStr,
-          },
-          code: errorCode,
-        }, 
-        subscriptionCallback
-      );
-    },
-    stop: () => {
-      mockServer.stop(() => {
-        // ...
-      });
-    },
-    send: (data: object) => {
-      socket.send(JSON.stringify(data));
-    },
-  };
-};
-
-export { getMockServer, getSocket, getConnectedSocket, DEFAULT_CONNECT_PARAMS, DEFAULT_AUTH_RESPONSE };