airdcpp-apisocket 3.0.0-beta.1 → 3.0.0-beta.11

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

@@ -0,0 +1,163 @@
+import { Server } from 'mock-socket';
+import { EventEmitter } from 'events';
+import { MOCK_SERVER_URL } from './mock-data.js';
+;
+const toEmitId = (path, method) => {
+    return `${path}_${method}`;
+};
+const getDefaultMockCreatorF = () => ({
+    fn: () => { },
+});
+const DEFAULT_MOCK_SERVER_OPTIONS = {
+    url: MOCK_SERVER_URL,
+    reportMissingListeners: true,
+    mockF: getDefaultMockCreatorF(),
+};
+const getMockServer = (initialOptions = {}) => {
+    const { url, reportMissingListeners, mockF } = {
+        ...DEFAULT_MOCK_SERVER_OPTIONS,
+        ...initialOptions,
+    };
+    const mockServer = new Server(url);
+    let socket;
+    const emitter = new EventEmitter();
+    emitter.setMaxListeners(1);
+    const send = (data) => {
+        socket.send(JSON.stringify(data));
+    };
+    const handlers = new Map();
+    const addServerHandler = (method, path, responseData, subscriptionCallback) => {
+        const requestHandler = (request, s) => {
+            if (subscriptionCallback) {
+                subscriptionCallback(request);
+            }
+            const data = typeof responseData === 'function' ? responseData(request, s) : responseData;
+            if (!data || !data.code) {
+                throw new Error(`Mock server: response handler for path ${path} must return a status code`);
+            }
+            const response = {
+                callback_id: request.callback_id,
+                ...data,
+            };
+            s.send(JSON.stringify(response));
+        };
+        // Don't add duplicates
+        const emitId = toEmitId(path, method);
+        const removeExisting = handlers.get(emitId);
+        if (removeExisting) {
+            removeExisting();
+            handlers.delete(emitId);
+        }
+        // Add new
+        emitter.addListener(emitId, requestHandler);
+        // Prepare for removal
+        const removeListener = () => emitter.removeListener(emitId, requestHandler);
+        handlers.set(emitId, removeListener);
+        return removeListener;
+    };
+    const addDummyDataHandler = (method, path) => {
+        const handler = (request, s) => {
+            // Do nothing
+        };
+        const emitId = toEmitId(path, method);
+        emitter.addListener(emitId, handler);
+        emitter.setMaxListeners(1);
+        return () => emitter.removeListener(emitId, handler);
+    };
+    const addRequestHandler = (method, path, data, subscriptionCallback) => {
+        const handlerData = typeof data === 'function' ? data : {
+            data,
+            code: data ? 200 : 204,
+        };
+        return addServerHandler(method, path, handlerData, subscriptionCallback);
+    };
+    const addErrorHandler = (method, path, errorStr, errorCode, subscriptionCallback) => {
+        return addServerHandler(method, path, {
+            error: !errorStr ? null : {
+                message: errorStr,
+            },
+            code: errorCode,
+        }, subscriptionCallback);
+    };
+    const addSubscriptionHandlerImpl = (moduleName, type, listenerName, entityId) => {
+        const subscribeFn = mockF.fn();
+        const unsubscribeFn = mockF.fn();
+        const path = entityId ? `${moduleName}/${entityId}/${type}/${listenerName}` : `${moduleName}/${type}/${listenerName}`;
+        const subscribeRemove = addRequestHandler('POST', path, undefined, subscribeFn);
+        const unsubscribeRemove = addRequestHandler('DELETE', path, undefined, unsubscribeFn);
+        const fire = (data, entityId) => {
+            send({
+                event: listenerName,
+                data,
+                id: entityId,
+            });
+        };
+        const remove = () => {
+            subscribeRemove();
+            unsubscribeRemove();
+        };
+        return {
+            fire,
+            remove,
+            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 = mockF.fn();
+            const rejectFn = mockF.fn();
+            const resolveRemove = addRequestHandler('POST', `${subscriber.path}/${completionId}/resolve`, undefined, resolveFn);
+            const rejectRemove = addRequestHandler('POST', `${subscriber.path}/${completionId}/reject`, undefined, rejectFn);
+            const remove = () => {
+                resolveRemove();
+                rejectRemove();
+            };
+            const fire = (data) => {
+                send({
+                    event: listenerName,
+                    data,
+                    completion_id: completionId,
+                });
+            };
+            return { fire, remove, 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}`);
+            }
+        });
+    });
+    return {
+        addRequestHandler,
+        addErrorHandler,
+        addSubscriptionHandler,
+        addHookHandler,
+        ignoreMissingHandler: addDummyDataHandler,
+        stop: () => {
+            mockServer.stop(() => {
+                emitter.removeAllListeners();
+                handlers.clear();
+            });
+        },
+        send,
+        url,
+    };
+};
+export { getMockServer };
+//# sourceMappingURL=mock-server.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mock-server.js","sourceRoot":"","sources":["../../../src/tests/mocks/mock-server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,MAAM,EAAa,MAAM,aAAa,CAAC;AAGxD,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAIhD,CAAC;AAIF,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,MAAc,EAAE,EAAE;IAChD,OAAO,GAAG,IAAI,IAAI,MAAM,EAAE,CAAC;AAC7B,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,GAAG,EAAE,CAAC,CAAC;IACpC,EAAE,EAAE,GAAG,EAAE,GAAE,CAAC;CACb,CAAC,CAAC;AAQH,MAAM,2BAA2B,GAAsB;IACrD,GAAG,EAAE,eAAe;IACpB,sBAAsB,EAAE,IAAI;IAC5B,KAAK,EAAE,sBAAsB,EAAE;CAChC,CAAA;AAMD,MAAM,aAAa,GAAG,CAAC,iBAA6C,EAAE,EAAE,EAAE;IACxE,MAAM,EAAE,GAAG,EAAE,sBAAsB,EAAE,KAAK,EAAE,GAAsB;QAChE,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;IACnC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAE3B,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,QAAQ,GAA2B,IAAI,GAAG,EAAE,CAAC;IAEnD,MAAM,gBAAgB,GAAG,CACvB,MAAc,EACd,IAAY,EACZ,YAA4C,EAC5C,oBAAsC,EACtC,EAAE;QACF,MAAM,cAAc,GAAG,CAAC,OAAwB,EAAE,CAAY,EAAE,EAAE;YAChE,IAAI,oBAAoB,EAAE,CAAC;gBACzB,oBAAoB,CAAC,OAAO,CAAC,CAAC;YAChC,CAAC;YAED,MAAM,IAAI,GAAG,OAAO,YAAY,KAAK,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;YAC1F,IAAI,CAAC,IAAI,IAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACvB,MAAM,IAAI,KAAK,CAAC,0CAA0C,IAAI,4BAA4B,CAAC,CAAC;YAC9F,CAAC;YAED,MAAM,QAAQ,GAAkD;gBAC9D,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,GAAG,IAAI;aACR,CAAC;YAEF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnC,CAAC,CAAC;QAEF,uBAAuB;QACvB,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACtC,MAAM,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,cAAc,EAAE,CAAC;YACnB,cAAc,EAAE,CAAC;YACjB,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC;QAED,UAAU;QACV,OAAO,CAAC,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAE5C,sBAAsB;QACtB,MAAM,cAAc,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAC5E,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;QACpC,OAAO,cAAc,CAAC;IACxB,CAAC,CAAC;IAEF,MAAM,mBAAmB,GAAG,CAAC,MAAc,EAAE,IAAY,EAAE,EAAE;QAC3D,MAAM,OAAO,GAAG,CAAC,OAAwB,EAAE,CAAY,EAAE,EAAE;YACzD,aAAa;QACf,CAAC,CAAC;QAEF,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CACjB,MAAM,EACN,OAAO,CACR,CAAC;QACF,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAE3B,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC,CAAA;IAED,MAAM,iBAAiB,GAAG,CACxB,MAAc,EACd,IAAY,EACZ,IAAoD,EACpD,oBAAsC,EACtC,EAAE;QACF,MAAM,WAAW,GAAG,OAAO,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YACtD,IAAI;YACJ,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;SACvB,CAAA;QAED,OAAO,gBAAgB,CACrB,MAAM,EACN,IAAI,EACJ,WAAW,EACX,oBAAoB,CACrB,CAAC;IACJ,CAAC,CAAA;IAED,MAAM,eAAe,GAAG,CACtB,MAAc,EACd,IAAY,EACZ,QAAuB,EACvB,SAAiB,EACjB,oBAAsC,EACtC,EAAE;QACF,OAAO,gBAAgB,CACrB,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,KAAK,CAAC,EAAE,EAAE,CAAC;QAC/B,MAAM,aAAa,GAAG,KAAK,CAAC,EAAE,EAAE,CAAC;QAEjC,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,MAAM,eAAe,GAAG,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;QAChF,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAEtF,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,MAAM,MAAM,GAAG,GAAG,EAAE;YAClB,eAAe,EAAE,CAAC;YAClB,iBAAiB,EAAE,CAAC;QACtB,CAAC,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,MAAM;YAEN,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,KAAK,CAAC,EAAE,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAG,KAAK,CAAC,EAAE,EAAE,CAAC;YAE5B,MAAM,aAAa,GAAG,iBAAiB,CACrC,MAAM,EACN,GAAG,UAAU,CAAC,IAAI,IAAI,YAAY,UAAU,EAC5C,SAAS,EACT,SAAS,CACV,CAAC;YAEF,MAAM,YAAY,GAAG,iBAAiB,CACpC,MAAM,EACN,GAAG,UAAU,CAAC,IAAI,IAAI,YAAY,SAAS,EAC3C,SAAS,EACT,QAAQ,CACT,CAAC;YAEF,MAAM,MAAM,GAAG,GAAG,EAAE;gBAClB,aAAa,EAAE,CAAC;gBAChB,YAAY,EAAE,CAAC;YACjB,CAAC,CAAA;YAED,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,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;QAC/C,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,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,OAAO,CAAC,kBAAkB,EAAE,CAAC;gBAC7B,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC;QACD,IAAI;QACJ,GAAG;KACJ,CAAC;AACJ,CAAC,CAAC;AAEF,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist-es/tests/mocks/mock-socket.d.ts

@@ -0,0 +1,24 @@
+import * as Options from '../../types/options.js';
+import { getMockServer } from './mock-server.js';
+export type MockSocketConnectOptions = Omit<Options.APISocketOptions, 'username' | 'password' | 'url'> & {
+    username?: string;
+    password?: string;
+    url?: string;
+};
+type RequestCallback = (requestData: object) => void;
+interface MockSocketOptions {
+    console: Options.LogOutput;
+    socketOptions?: MockSocketConnectOptions;
+}
+export interface MockConnectedSocketOptions extends MockSocketOptions {
+    authCallback?: RequestCallback;
+    authResponse: object;
+}
+export declare const getSocket: (socketOptions?: MockSocketConnectOptions) => {
+    socket: import("../../NodeSocket.js").APISocket;
+};
+export declare const getConnectedSocket: (server: ReturnType<typeof getMockServer>, userOptions?: Partial<MockConnectedSocketOptions>) => Promise<{
+    socket: import("../../NodeSocket.js").APISocket;
+    removeAuthHandler: () => import("events")<[never]>;
+}>;
+export {};

package/dist-es/tests/mocks/mock-socket.js

@@ -0,0 +1,35 @@
+import { Socket } from '../../NodeSocket.js';
+import { WebSocket } from 'mock-socket';
+import ApiConstants from '../../ApiConstants.js';
+import { DEFAULT_AUTH_RESPONSE, DEFAULT_CONNECT_CREDENTIALS, MOCK_SERVER_URL } from './mock-data.js';
+const getDefaultSocketOptions = () => ({
+    url: MOCK_SERVER_URL,
+    logOutput: console,
+    logLevel: 'warn',
+});
+export const getSocket = (socketOptions = {}) => {
+    const socket = Socket({
+        ...getDefaultSocketOptions(),
+        ...socketOptions
+    }, WebSocket);
+    return { socket };
+};
+const getDefaultConnectOptions = () => ({
+    console,
+    authResponse: DEFAULT_AUTH_RESPONSE,
+});
+export const getConnectedSocket = async (server, userOptions) => {
+    const options = {
+        ...getDefaultConnectOptions(),
+        ...userOptions,
+    };
+    const removeAuthHandler = server.addRequestHandler('POST', ApiConstants.LOGIN_URL, options.authResponse, options.authCallback);
+    const { socket } = getSocket({
+        ...DEFAULT_CONNECT_CREDENTIALS,
+        ...getDefaultSocketOptions(),
+        ...options.socketOptions
+    });
+    await socket.connect();
+    return { socket, removeAuthHandler };
+};
+//# sourceMappingURL=mock-socket.js.map

package/dist-es/tests/mocks/mock-socket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock-socket.js","sourceRoot":"","sources":["../../../src/tests/mocks/mock-socket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,OAAO,YAAY,MAAM,uBAAuB,CAAC;AAGjD,OAAO,EAAE,qBAAqB,EAAE,2BAA2B,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAErG,MAAM,uBAAuB,GAAG,GAA6B,EAAE,CAAC,CAAC;IAC/D,GAAG,EAAE,eAAe;IACpB,SAAS,EAAE,OAAO;IAClB,QAAQ,EAAE,MAAM;CACjB,CAAC,CAAC;AAsBH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,gBAA0C,EAAE,EAAE,EAAE;IACxE,MAAM,MAAM,GAAG,MAAM,CACnB;QACE,GAAG,uBAAuB,EAAE;QAC5B,GAAG,aAAa;KACjB,EACD,SAAgB,CACjB,CAAC;IAEF,OAAO,EAAE,MAAM,EAAE,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,GAAG,EAAE,CAAC,CAAC;IACtC,OAAO;IACP,YAAY,EAAE,qBAAqB;CACpC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,EACrC,MAAwC,EACxC,WAAiD,EACjD,EAAE;IACF,MAAM,OAAO,GAA+B;QAC1C,GAAG,wBAAwB,EAAE;QAC7B,GAAG,WAAW;KACf,CAAC;IAEF,MAAM,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAE/H,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;QAC3B,GAAG,2BAA2B;QAC9B,GAAG,uBAAuB,EAAE;QAC5B,GAAG,OAAO,CAAC,aAAa;KACzB,CAAC,CAAC;IACH,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;IAEvB,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC;AACvC,CAAC,CAAC"}

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

@@ -0,0 +1,8 @@
+export declare const waitForExpect: (func: () => void | Promise<void>) => Promise<{}>;
+export declare const defusedPromise: (promise: Promise<any>) => Promise<any>;
+export declare const getMockConsole: (verbose?: boolean) => {
+    log: jest.Mock<void, [a1: any, a2: any, a3: any, a4: any], any>;
+    info: jest.Mock<void, [a1: any, a2: any, a3: any, a4: any], any>;
+    warn: jest.Mock<void, [a1: any, a2: any, a3: any, a4: any], any>;
+    error: jest.Mock<void, [a1: any, a2: any, a3: any, a4: any], any>;
+};

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

@@ -0,0 +1,28 @@
+import waitForExpectOriginal from 'wait-for-expect';
+const EXCEPT_TIMEOUT = 1000;
+//@ts-ignore
+export const waitForExpect = (func) => waitForExpectOriginal.default(func, EXCEPT_TIMEOUT);
+// This is a helper function that will suppress the error of a promise.
+export const defusedPromise = (promise) => {
+    promise.catch(() => { });
+    return promise;
+};
+export const getMockConsole = (verbose = false) => ({
+    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);
+    }),
+});
+//# 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;AAGvH,uEAAuE;AACvE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAqB,EAAE,EAAE;IACtD,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACxB,OAAO,OAAO,CAAC;AACjB,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAO,GAAG,KAAK,EAAE,EAAE,CAAC,CAAC;IAClD,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"}

package/dist-es/types/public_helpers.d.ts

@@ -1,17 +1,26 @@
 import { HookSubscriberInfo } from './subscriptions.js';
-type AsyncCallbackProperty<IdT, EntityIdT, ReturnT> = (selectedIds: IdT[], entityId: EntityIdT | null, permissions: string[], supports: string[]) => ReturnT | Promise<ReturnT>;
+export interface MenuCallbackProperties<IdT, EntityIdT> {
+    selectedIds: IdT[];
+    entityId: EntityIdT;
+    permissions: string[];
+    supports: string[];
+}
+export interface MenuClickHandlerProperties<IdT, EntityIdT, FormValueT extends object = object> extends MenuCallbackProperties<IdT, EntityIdT> {
+    formValues: FormValueT;
+}
+type AsyncCallbackProperty<IdT, EntityIdT, ReturnT> = (props: MenuCallbackProperties<IdT, EntityIdT>) => ReturnT | Promise<ReturnT>;
 export type ContextMenuIcon = {
     [key in string]: string;
 };
 export interface ContextMenu extends HookSubscriberInfo {
     icon?: ContextMenuIcon;
 }
-export interface ContextMenuItem<IdT, EntityIdT> {
+export interface ContextMenuItem<IdT, EntityIdT, FormValueT extends object = object> {
     id: string;
     title: string;
     icon?: ContextMenuIcon;
     urls?: string[] | AsyncCallbackProperty<IdT, EntityIdT, string[] | undefined>;
-    onClick?: (selectedIds: IdT[], entityId: EntityIdT | null, permissions: string[], supports: string[], formValues: object) => void;
+    onClick?: (props: MenuClickHandlerProperties<IdT, EntityIdT, FormValueT>) => void;
     filter?: AsyncCallbackProperty<IdT, EntityIdT, boolean>;
     access?: string;
     formDefinitions?: object[] | AsyncCallbackProperty<IdT, EntityIdT, object[]>;

package/dist-es/types/public_helpers_internal.d.ts

@@ -4,20 +4,20 @@ export interface SelectedMenuItemListenerData<IdT, EntityIdT> {
     menu_id: string;
     menuitem_id: string;
     selected_ids: IdT[];
-    entity_id: EntityIdT | null;
+    entity_id: EntityIdT;
     permissions: string[];
     supports: string[];
     form_values: object;
 }
 export interface MenuItemListHookData<IdT, EntityIdT> {
     selected_ids: IdT[];
-    entity_id: EntityIdT | null;
+    entity_id: EntityIdT;
     permissions: string[];
     supports: string[];
 }
 export interface ResponseMenuItemCallbackFields {
-    urls?: string[] | undefined;
-    form_definitions?: object[] | undefined;
+    urls?: string[];
+    form_definitions?: object[];
 }
 export type ResponseMenuItem<IdT, EntityIdT> = Omit<ContextMenuItem<IdT, EntityIdT>, 'onClick' | 'filter' | 'urls' | 'form_definitions'> & ResponseMenuItemCallbackFields;
 export interface MenuItemListHookAcceptData<IdT, EntityIdT> {

package/dist-es/types/socket.d.ts

@@ -20,4 +20,5 @@ export interface APISocket extends SocketRequestMethods, SocketSubscriptions {
     onSessionReset: SessionResetCallback | null;
     onDisconnected: DisconnectedCallback | null;
     readonly nativeSocket: WebSocket | null;
+    readonly url: string;
 }

package/dist-es/types/subscriptions.d.ts

@@ -1,5 +1,5 @@
 import * as API from './api.js';
-export type SubscriptionRemoveHandler = (sendApi?: boolean) => void;
+export type SubscriptionRemoveHandler = (sendApi?: boolean) => Promise<void>;
 export type SubscriptionCallback<DataT extends object | void = object, EntityIdT = API.EntityId | undefined> = (data: DataT, entityId: EntityIdT) => void;
 export interface HookSubscriberInfo {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "airdcpp-apisocket",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.11",
   "description": "Javascript connector for AirDC++ Web API",
   "license": "MIT",
   "authors": [
@@ -41,14 +41,14 @@
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",
     "@types/invariant": "^2.2.35",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.14.9",
-    "jest": "^29.7.0",
-    "jest-cli": "^29.7.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.1.0",
+    "jest": "^30.0.5",
+    "jest-cli": "^30.0.5",
     "jest-environment-node-debug": "^2.0.0",
     "mock-socket": "^9.1.5",
     "pre-commit": "^1.2.2",
-    "rimraf": "^4.1.2",
+    "rimraf": "^6.0.1",
     "ts-jest": "^29.1.5",
     "ts-node": "^10.9.1",
     "tslint": "^6.1.3",
@@ -57,6 +57,9 @@
     "websocket": "^1.0.34"
   },
   "main": "./dist/NodeSocket.js",
-  "exports": "./dist-es/NodeSocket.js",
+  "exports": {
+    ".": "./dist-es/NodeSocket.js",
+    "./tests": "./dist-es/tests/mocks/index.js"
+  },
   "type": "module"
 }

package/src/PublicHelpers.ts

@@ -30,7 +30,12 @@ const validateItem = async <IdT, EntityIdT>(
     return false;
   }
 
-  if (!!menuItem.filter && !(await menuItem.filter(selected_ids, entity_id, permissions, supports))) {
+  if (!!menuItem.filter && !(await menuItem.filter({
+    selectedIds: selected_ids, 
+    entityId: entity_id, 
+    permissions, 
+    supports
+  }))) {
     return false;
   }
 
@@ -42,10 +47,17 @@ const parseCallbackData = async <IdT, EntityIdT extends EntityId | undefined = u
   data: MenuItemListHookData<IdT, EntityIdT>
 ): Promise<ResponseMenuItemCallbackFields> => {
   const { selected_ids, entity_id, permissions, supports } = data;
+  const callbackProps = {
+    selectedIds: selected_ids, 
+    entityId: entity_id, 
+    permissions, 
+    supports
+  }
+
   if (!!item.urls && !!item.urls.length) {
     let urls: string[] | undefined;
     if (typeof item.urls === 'function') {
-      urls = await item.urls(selected_ids, entity_id, permissions, supports);
+      urls = await item.urls(callbackProps);
     } else {
       urls = item.urls;
     }
@@ -56,7 +68,7 @@ const parseCallbackData = async <IdT, EntityIdT extends EntityId | undefined = u
   } else if (!!item.formDefinitions && hasSupport(FORM_SUPPORT, supports)) {
     let formDefinitions: object[] | undefined;
     if (typeof item.formDefinitions === 'function') {
-      formDefinitions = await item.formDefinitions(selected_ids, entity_id, permissions, supports);
+      formDefinitions = await item.formDefinitions(callbackProps);
     } else {
       formDefinitions = item.formDefinitions;
     }
@@ -85,7 +97,13 @@ export const addContextMenuItems = async <IdT, EntityIdT extends EntityId | unde
           const isValid = await validateItem(menuItem, data);
           if (isValid && !!menuItem.onClick) {
             const { selected_ids, entity_id, permissions, supports, form_values } = data;
-            menuItem.onClick(selected_ids, entity_id, permissions, supports, form_values);
+            menuItem.onClick({
+              selectedIds: selected_ids, 
+              entityId: entity_id, 
+              permissions, 
+              supports, 
+              formValues: form_values
+            });
           }
         }
       }
@@ -125,8 +143,8 @@ export const addContextMenuItems = async <IdT, EntityIdT extends EntityId | unde
     menu
   );
 
-  return () => {
-    removeHook();
-    removeListener();
+  return async () => {
+    await removeHook();
+    await removeListener();
   };
 };

package/src/SocketBase.ts

@@ -125,11 +125,11 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
   // Connect handler for creation of new session
   const handlePasswordLogin = (username = options.username, password = options.password) => {
     if (!username) {
-      throw '"username" option was not supplied for authentication';
+      throw new Error('"username" option was not supplied for authentication');
     }
 
     if (!password) {
-      throw '"password" option was not supplied for authentication';
+      throw new Error('"password" option was not supplied for authentication');
     }
 
     const data: API.CredentialsAuthenticationData = {
@@ -146,7 +146,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
 
   const handleRefreshTokenLogin = (refreshToken: string) => {
     if (!refreshToken) {
-      throw '"refreshToken" option was not supplied for authentication';
+      throw new Error('"refreshToken" option was not supplied for authentication');
     }
 
     const data: API.RefreshTokenAuthenticationData = {
@@ -268,7 +268,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
     };
 
     ws!.onerror = (event) => {
-      logger.error('Connecting socket failed');
+      logger.error('Connecting socket failed (network/system error, most likely the server is unreachable)');
       scheduleReconnect();
     };
   };
@@ -281,7 +281,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
     forceNoAutoConnect = false;
     return new Promise(
       (resolve, reject) => {
-        logger.info('Starting socket connect');
+        logger.info(`Starting socket connect to ${userOptions.url}`);
         connectInternal(resolve, reject, authenticationHandler, reconnectOnFailure);
       }
     );
@@ -317,7 +317,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
         if (isActive()) {
           if (attempts >= maxAttempts) {
             logger.error(`Socket disconnect timed out after ${timeoutMs} ms`);
-            reject('Socket disconnect timed out');
+            reject(new Error('Socket disconnect timed out'));
           } else {
             setTimeout(wait, checkInterval);
             attempts++;
@@ -343,7 +343,6 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
         }
       } else {
         logger.warn('Attempting to disconnect a closed socket (ignore)');
-        //throw 'Attempting to disconnect a closed socket';
       }
 
       return;
@@ -363,7 +362,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
     // Username and password are not required if those are available in socket options
     connect: (username?: string, password?: string, reconnectOnFailure = true) => {
       if (isActive()) {
-        throw 'Connect may only be used for a closed socket';
+        throw new Error('Connect may only be used for a closed socket');
       }
 
       resetSession();
@@ -373,7 +372,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
 
     connectRefreshToken: (refreshToken: string, reconnectOnFailure = true) => {
       if (isActive()) {
-        throw 'Connect may only be used for a closed socket';
+        throw new Error('Connect may only be used for a closed socket');
       }
 
       resetSession();
@@ -384,7 +383,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
     // Connect and attempt to associate the socket with an existing session
     reconnect: (token: API.AuthTokenType | undefined = undefined, reconnectOnFailure = true) => {
       if (isActive()) {
-        throw 'Reconnect may only be used for a closed socket';
+        throw new Error('Reconnect may only be used for a closed socket');
       }
 
       if (token) {
@@ -392,7 +391,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
       }
 
       if (!authToken) {
-        throw 'No session token available for reconnecting';
+        throw new Error('No session token available for reconnecting');
       }
 
       logger.info('Reconnecting socket');
@@ -459,11 +458,15 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
       return ws;
     },
 
+    get url() {
+      return userOptions.url;
+    },
+
     ...subscriptions.socket,
     ...requests.socket,
   };
 
-  return socket!;
+  return socket;
 };
 
 export default ApiSocket;

package/src/SocketRequestHandler.ts

@@ -59,12 +59,12 @@ const SocketRequestHandler = (
     // Pre-checks
     if (!authenticating && !socket().isConnected()) {
       logger.warn(`Attempting to send request on a non-authenticated socket: ${path}`);
-      return Promise.reject('Not authorized');
+      return Promise.reject(new Error('Not authorized'));
     }
 
     if (!socket().nativeSocket) {
       logger.warn(`Attempting to send request without a socket: ${path}`);
-      return Promise.reject('No socket');
+      return Promise.reject(new Error('No socket'));
     }
 
     const callbackId = getCallbackId();
@@ -143,12 +143,10 @@ const SocketRequestHandler = (
     },
   
     delete: (path) => {
-      //invariant(!data, 'No data is allowed for delete command');
       return sendRequest('DELETE', path);
     },
   
     get: (path) => {
-      //invariant(!data, 'No data is allowed for get command');
       return sendRequest('GET', path);
     },
   
@@ -188,7 +186,7 @@ const SocketRequestHandler = (
       if (messageObj.code >= 200 && messageObj.code <= 204) {
         const { data } = messageObj as APIInternal.RequestSuccessResponse;
         if (!callbacks[id].ignored) {
-          logger.verbose(chalk.green(id.toString()), 'SUCCEEDED', data ? data : '(no data)');
+          logger.verbose(chalk.green(id.toString()), 'SUCCEEDED', data ?? '(no data)');
         }
 
         callbacks[id].resolver.resolve(data);

package/src/SocketSubscriptionHandler.ts

@@ -43,7 +43,7 @@ const SocketSubscriptionHandler = (
   // Subscriptions pending to be added in the API
   const pendingSubscriptions: { [key: string]: PendingSubscription[] } = {};
 
-  const removeSocketListener = (
+  const removeSocketListener = async (
     subscriptionUrl: string, 
     subscriptionId: string, 
     callback: Subscriptions.HookCallback<any, any> | Subscriptions.SubscriptionCallback<any>, 
@@ -58,11 +58,12 @@ const SocketSubscriptionHandler = (
 
     if (subscriptions[subscriptionId] === 0) {
       if (sendApi && socket().isConnected()) {
-        socket().delete(subscriptionUrl)
-          .catch(
-            (error: Requests.ErrorResponse) => {
-              logger.error('Failed to remove socket listener', subscriptionUrl, error);
-            });
+        try {
+          await socket().delete(subscriptionUrl);
+        } catch (error) {
+          const e: Requests.ErrorResponse = error;
+          logger.error('Failed to remove socket listener', subscriptionUrl, e);
+        };
       }
 
       delete subscriptions[subscriptionId];