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

package/dist/SocketRequestHandler.d.ts

@@ -0,0 +1,14 @@
+import * as API from './types/api.js';
+import * as APIInternal from './types/api_internal.js';
+import * as Options from './types/options.js';
+import * as Socket from './types/socket.js';
+import { Logger } from './types/logger.js';
+import { SocketRequestMethods } from './types/requests.js';
+declare const SocketRequestHandler: (socket: () => Socket.APISocket, logger: Logger, { requestTimeout, ignoredRequestPaths }: Options.SocketRequestOptions) => {
+    socket: SocketRequestMethods;
+    onSocketConnected(): void;
+    onSocketDisconnected(): void;
+    handleMessage(messageObj: APIInternal.RequestSuccessResponse | APIInternal.RequestErrorResponse): void;
+    postAuthenticate(path: string, data: API.TokenAuthenticationData | API.CredentialsAuthenticationData | API.RefreshTokenAuthenticationData): Promise<any>;
+};
+export default SocketRequestHandler;

package/dist/SocketRequestHandler.js

@@ -0,0 +1,164 @@
+import chalk from 'chalk';
+import invariant from 'invariant';
+import Promise from './Promise.js';
+import { eventIgnored } from './utils.js';
+const SocketRequestHandler = (socket, logger, { requestTimeout = 30, ignoredRequestPaths }) => {
+    let callbacks = {};
+    let currentCallbackId = 0;
+    let timeoutReportInterval;
+    // Internal
+    // This creates a new callback ID for a request
+    const getCallbackId = () => {
+        if (currentCallbackId > 100000) {
+            currentCallbackId = 0;
+        }
+        currentCallbackId += 1;
+        return currentCallbackId;
+    };
+    const filterPassword = (data) => {
+        if (!data || !data.hasOwnProperty('password')) {
+            return data;
+        }
+        return {
+            ...data,
+            password: '(hidden)',
+        };
+    };
+    const sendRequest = (method, path, data, authenticating = false) => {
+        // Pre-checks
+        if (!authenticating && !socket().isConnected()) {
+            logger.warn(`Attempting to send request on a non-authenticated socket: ${path}`);
+            return Promise.reject('Not authorized');
+        }
+        if (!socket().nativeSocket) {
+            logger.warn(`Attempting to send request without a socket: ${path}`);
+            return Promise.reject('No socket');
+        }
+        const callbackId = getCallbackId();
+        // Reporting
+        invariant(path, 'Attempting socket request without a path');
+        const ignored = eventIgnored(path, ignoredRequestPaths);
+        if (!ignored) {
+            logger.verbose(chalk.white.bold(callbackId.toString()), method, path, data ? filterPassword(data) : '(no data)');
+        }
+        // Callback
+        const resolver = Promise.pending();
+        callbacks[callbackId.toString()] = {
+            time: Date.now(),
+            resolver,
+            ignored,
+        };
+        // Actual request
+        const request = {
+            path,
+            method,
+            data,
+            callback_id: callbackId,
+        };
+        socket().nativeSocket.send(JSON.stringify(request));
+        return resolver.promise;
+    };
+    // Report timed out requests
+    // This is more about spotting backend issues, such as frozen threads and dropped responses
+    // The socket itself should handle actual connection issues
+    const reportTimeouts = () => {
+        const now = Date.now();
+        Object.keys(callbacks).forEach(callbackId => {
+            const request = callbacks[callbackId];
+            if (request.time + (requestTimeout * 1000) < now) {
+                logger.warn(`Request ${callbackId} timed out`);
+            }
+        });
+    };
+    const cancelPendingRequests = (message = 'Request cancelled') => {
+        Object.keys(callbacks)
+            .forEach(id => {
+            logger.verbose(`Canceling a pending request ${id} (${message})`);
+            const cb = callbacks[id];
+            cb.resolver.reject(message);
+        });
+        callbacks = {};
+    };
+    // Public
+    const RequestsPublic = {
+        put: (path, data) => {
+            return sendRequest('PUT', path, data);
+        },
+        patch: (path, data) => {
+            return sendRequest('PATCH', path, data);
+        },
+        post: (path, data) => {
+            return sendRequest('POST', path, data);
+        },
+        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);
+        },
+        getPendingRequestCount: () => {
+            return Object.keys(callbacks).length;
+        },
+    };
+    Object.assign(RequestsPublic, {
+        reportRequestTimeouts: reportTimeouts, // internal method for testing
+    });
+    const formatFieldError = (error) => {
+        return error.field && error.code ? `${error.field} (${error.code})` : '';
+    };
+    // Shared for the socket
+    const RequestsInternal = {
+        onSocketConnected() {
+            timeoutReportInterval = setInterval(reportTimeouts, 30000);
+        },
+        onSocketDisconnected() {
+            // Clear callbacks
+            cancelPendingRequests('Socket disconnected');
+            clearTimeout(timeoutReportInterval);
+        },
+        handleMessage(messageObj) {
+            const id = messageObj.callback_id;
+            if (!callbacks.hasOwnProperty(id)) {
+                logger.warn('No pending request for an API response', id, messageObj);
+                return;
+            }
+            if (messageObj.code >= 200 && messageObj.code <= 204) {
+                const { data } = messageObj;
+                if (!callbacks[id].ignored) {
+                    logger.verbose(chalk.green(id.toString()), 'SUCCEEDED', data ? data : '(no data)');
+                }
+                callbacks[id].resolver.resolve(data);
+            }
+            else {
+                const errorMessageObj = messageObj;
+                if (!errorMessageObj.error) {
+                    // API should always return an error message but this isn't always the case
+                    // (e.g. https://github.com/airdcpp/airdcpp-windows/commit/596b31a9c8c4e72f6c9279972a40ea30f10798c4)
+                    logger.warn('Error message missing from the response (this is an API bug that should be reported)', id, messageObj);
+                }
+                const { code } = errorMessageObj;
+                const error = errorMessageObj.error || {
+                    message: '(no error description)'
+                };
+                logger.warn(id, code, error.message, formatFieldError(error));
+                callbacks[id].resolver.reject({
+                    message: error.message,
+                    code,
+                    json: error
+                });
+            }
+            delete callbacks[id];
+        },
+        postAuthenticate(path, data) {
+            return sendRequest('POST', path, data, true);
+        },
+    };
+    return {
+        ...RequestsInternal,
+        socket: RequestsPublic,
+    };
+};
+export default SocketRequestHandler;
+//# sourceMappingURL=SocketRequestHandler.js.map

package/dist/SocketRequestHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocketRequestHandler.js","sourceRoot":"","sources":["../src/SocketRequestHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,OAA0B,MAAM,cAAc,CAAC;AAEtD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAiB1C,MAAM,oBAAoB,GAAG,CAC3B,MAA8B,EAC9B,MAAc,EACd,EAAE,cAAc,GAAG,EAAE,EAAE,mBAAmB,EAAgC,EAC1E,EAAE;IAEF,IAAI,SAAS,GAA6B,EAAE,CAAC;IAC7C,IAAI,iBAAiB,GAAG,CAAC,CAAC;IAE1B,IAAI,qBAA0B,CAAC;IAE/B,WAAW;IAEX,+CAA+C;IAC/C,MAAM,aAAa,GAAG,GAAG,EAAE;QACzB,IAAI,iBAAiB,GAAG,MAAM,EAAE,CAAC;YAC/B,iBAAiB,GAAG,CAAC,CAAC;QACxB,CAAC;QAED,iBAAiB,IAAI,CAAC,CAAC;QACvB,OAAO,iBAAiB,CAAC;IAC3B,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,CAAC,IAAwB,EAAsB,EAAE;QACtE,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9C,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO;YACL,GAAG,IAAI;YACP,QAAQ,EAAE,UAAU;SACrB,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,CAClB,MAAc,EAAE,IAAY,EAAE,IAAY,EAAE,iBAA0B,KAAK,EAC3E,EAAE;QACF,aAAa;QACb,IAAI,CAAC,cAAc,IAAI,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;YAC/C,MAAM,CAAC,IAAI,CAAC,6DAA6D,IAAI,EAAE,CAAC,CAAC;YACjF,OAAO,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,CAAC,YAAY,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC,gDAAgD,IAAI,EAAE,CAAC,CAAC;YACpE,OAAO,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACrC,CAAC;QAED,MAAM,UAAU,GAAG,aAAa,EAAE,CAAC;QAEnC,YAAY;QACZ,SAAS,CAAC,IAAI,EAAE,0CAA0C,CAAC,CAAC;QAE5D,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,CAAC,OAAO,CACZ,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,EACvC,MAAM,EACN,IAAI,EACJ,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAC1C,CAAC;QACJ,CAAC;QAED,WAAW;QACX,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QAEnC,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,GAAG;YACjC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;YAChB,QAAQ;YACR,OAAO;SACR,CAAC;QAEF,iBAAiB;QACjB,MAAM,OAAO,GAAG;YACd,IAAI;YACJ,MAAM;YACN,IAAI;YACJ,WAAW,EAAE,UAAU;SACO,CAAC;QAEjC,MAAM,EAAE,CAAC,YAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;QACrD,OAAO,QAAQ,CAAC,OAAO,CAAC;IAC1B,CAAC,CAAC;IAEF,4BAA4B;IAC5B,2FAA2F;IAC3F,2DAA2D;IAC3D,MAAM,cAAc,GAAG,GAAG,EAAE;QAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC1C,MAAM,OAAO,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACtC,IAAI,OAAO,CAAC,IAAI,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;gBACjD,MAAM,CAAC,IAAI,CAAC,WAAW,UAAU,YAAY,CAAC,CAAC;YACjD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,qBAAqB,GAAG,CAAC,UAAkB,mBAAmB,EAAE,EAAE;QACtE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;aACnB,OAAO,CAAC,EAAE,CAAC,EAAE;YACZ,MAAM,CAAC,OAAO,CAAC,+BAA+B,EAAE,KAAK,OAAO,GAAG,CAAC,CAAC;YAEjE,MAAM,EAAE,GAAa,SAAS,CAAC,EAAE,CAAC,CAAC;YACnC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEL,SAAS,GAAG,EAAE,CAAC;IACjB,CAAC,CAAC;IAEF,SAAS;IACT,MAAM,cAAc,GAAyB;QAC3C,GAAG,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YAClB,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAG,CAAC;QAC1C,CAAC;QAED,KAAK,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YACpB,OAAO,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAG,CAAC;QAC5C,CAAC;QAED,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YACnB,OAAO,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YACf,4DAA4D;YAC5D,OAAO,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrC,CAAC;QAED,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE;YACZ,yDAAyD;YACzD,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAClC,CAAC;QAED,sBAAsB,EAAE,GAAG,EAAE;YAC3B,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC;QACvC,CAAC;KACF,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE;QAC5B,qBAAqB,EAAE,cAAc,EAAE,8BAA8B;KACtE,CAAC,CAAC;IAEH,MAAM,gBAAgB,GAAG,CAAC,KAAqB,EAAE,EAAE;QACjD,OAAO,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3E,CAAC,CAAC;IAEF,wBAAwB;IACxB,MAAM,gBAAgB,GAAG;QACvB,iBAAiB;YACf,qBAAqB,GAAG,WAAW,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QAC7D,CAAC;QAED,oBAAoB;YAClB,kBAAkB;YAClB,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;YAE7C,YAAY,CAAC,qBAAqB,CAAC,CAAC;QACtC,CAAC;QAED,aAAa,CAAC,UAAiF;YAC7F,MAAM,EAAE,GAAG,UAAU,CAAC,WAAW,CAAC;YAClC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC;gBAClC,MAAM,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;gBACtE,OAAO;YACT,CAAC;YAED,IAAI,UAAU,CAAC,IAAI,IAAI,GAAG,IAAI,UAAU,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC;gBACrD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAgD,CAAC;gBAClE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;oBAC3B,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;gBACrF,CAAC;gBAED,SAAS,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACN,MAAM,eAAe,GAAG,UAA8C,CAAC;gBAEvE,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;oBAC3B,2EAA2E;oBAC3E,oGAAoG;oBACpG,MAAM,CAAC,IAAI,CACT,sFAAsF,EACtF,EAAE,EACF,UAAU,CACX,CAAC;gBACJ,CAAC;gBAED,MAAM,EAAE,IAAI,EAAE,GAAG,eAAe,CAAC;gBACjC,MAAM,KAAK,GAAG,eAAe,CAAC,KAAK,IAAI;oBACrC,OAAO,EAAE,wBAAwB;iBAClC,CAAC;gBAEF,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,gBAAgB,CAAC,KAAuB,CAAC,CAAC,CAAC;gBAChF,SAAS,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAC5B,OAAO,EAAE,KAAK,CAAC,OAAO;oBACtB,IAAI;oBACJ,IAAI,EAAE,KAAK;iBACK,CAAC,CAAC;YACtB,CAAC;YAED,OAAO,SAAS,CAAC,EAAE,CAAC,CAAC;QACvB,CAAC;QAED,gBAAgB,CACd,IAAY,EACZ,IAA0G;YAE1G,OAAO,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC/C,CAAC;KACF,CAAC;IAEF,OAAO;QACL,GAAG,gBAAgB;QACnB,MAAM,EAAE,cAAc;KACvB,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/dist/SocketSubscriptionHandler.d.ts

@@ -0,0 +1,11 @@
+import { Logger } from './types/logger.js';
+import * as APIInternal from './types/api_internal.js';
+import * as Options from './types/options.js';
+import * as Socket from './types/socket.js';
+import * as Subscriptions from './types/subscriptions.js';
+declare const SocketSubscriptionHandler: (socket: () => Socket.APISocket, logger: Logger, { ignoredListenerEvents }: Options.SocketSubscriptionOptions) => {
+    socket: Subscriptions.SocketSubscriptions;
+    onSocketDisconnected(): void;
+    handleMessage(message: APIInternal.IncomingSubscriptionEvent): void;
+};
+export default SocketSubscriptionHandler;

package/dist/SocketSubscriptionHandler.js

@@ -0,0 +1,157 @@
+import invariant from 'invariant';
+import { EventEmitter } from 'events';
+import { eventIgnored } from './utils.js';
+import Promise from './Promise.js';
+const SocketSubscriptionHandler = (socket, logger, { ignoredListenerEvents = [] }) => {
+    // Internal
+    const getEmitId = (event, id) => {
+        invariant(id !== 0, 'Entity ID "0" is not allowed');
+        return id ? (event + id) : event;
+    };
+    const getSubscriptionUrl = (moduleUrl, id, event) => {
+        if (id) {
+            return `${moduleUrl}/${id}/listeners/${event}`;
+        }
+        return `${moduleUrl}/listeners/${event}`;
+    };
+    let subscriptions = {};
+    const emitter = new EventEmitter();
+    // Subscriptions pending to be added in the API
+    const pendingSubscriptions = {};
+    const removeSocketListener = (subscriptionUrl, subscriptionId, callback, sendApi) => {
+        if (!socket().isConnected()) {
+            return;
+        }
+        subscriptions[subscriptionId]--;
+        emitter.removeListener(subscriptionId, callback);
+        if (subscriptions[subscriptionId] === 0) {
+            if (sendApi && socket().isConnected()) {
+                socket().delete(subscriptionUrl)
+                    .catch((error) => {
+                    logger.error('Failed to remove socket listener', subscriptionUrl, error);
+                });
+            }
+            delete subscriptions[subscriptionId];
+        }
+    };
+    const removeLocalListener = (subscriptionId, callback) => {
+        emitter.removeListener(subscriptionId, callback);
+    };
+    const handleHookAction = (subscriptionUrl, callback, data, completionId) => {
+        callback(data, completionData => {
+            socket().post(`${subscriptionUrl}/${completionId}/resolve`, completionData)
+                .catch((error) => logger.error('Failed to complete hook action', subscriptionUrl, error));
+        }, (rejectId, rejectMessage) => {
+            socket().post(`${subscriptionUrl}/${completionId}/reject`, {
+                reject_id: rejectId,
+                message: rejectMessage,
+            }).catch(error => logger.error('Failed to complete failed hook action', subscriptionUrl, error));
+        });
+    };
+    const onSubscriptionAddSucceeded = (subscriptionId) => {
+        const pending = pendingSubscriptions[subscriptionId];
+        pending.forEach(pendingItem => pendingItem.resolver.resolve(pendingItem.removeHandler));
+        subscriptions[subscriptionId] = pending.length;
+        delete pendingSubscriptions[subscriptionId];
+    };
+    const onSubscriptionAddFailed = (subscriptionId, error) => {
+        const pending = pendingSubscriptions[subscriptionId];
+        pending.forEach(pendingItem => pendingItem.resolver.reject(error));
+        delete pendingSubscriptions[subscriptionId];
+    };
+    const addPendingEntry = (subscriptionUrl, subscriptionId, callback, data) => {
+        const removeHandler = (sendApi = true) => removeSocketListener(subscriptionUrl, subscriptionId, callback, sendApi);
+        if (!subscriptions[subscriptionId]) {
+            if (!pendingSubscriptions[subscriptionId]) {
+                pendingSubscriptions[subscriptionId] = [];
+                socket()
+                    .post(subscriptionUrl, data)
+                    .then(onSubscriptionAddSucceeded.bind(SocketSubscriptionHandler, subscriptionId), onSubscriptionAddFailed.bind(SocketSubscriptionHandler, subscriptionId));
+            }
+            const resolver = Promise.pending();
+            pendingSubscriptions[subscriptionId].push({
+                resolver,
+                removeHandler
+            });
+            return resolver.promise;
+        }
+        subscriptions[subscriptionId]++;
+        return Promise.resolve(removeHandler);
+    };
+    const getTotalEmitterSubscriptionCount = () => {
+        return Object.keys(subscriptions)
+            .reduce((reduced, name) => emitter.listenerCount(name) + reduced, 0);
+    };
+    // Public
+    // Listen to a specific event without sending subscription to the server
+    const SocketSubscriptionsPublic = {
+        addViewUpdateListener: (viewName, callback, entityId) => {
+            const subscriptionId = getEmitId(`${viewName}_updated`, entityId);
+            emitter.on(subscriptionId, callback);
+            return () => removeLocalListener(subscriptionId, callback);
+        },
+        // Listen to a specific event and manage the API subscription automatically
+        addListener: (apiModule, event, callback, entityId) => {
+            if (!socket().isConnected()) {
+                throw 'Listeners can be added only for a connected socket';
+            }
+            invariant(apiModule.indexOf('/') === -1, 'The first argument should only contain the API section without any path tokens (entity ID should be supplied separately)');
+            const subscriptionId = getEmitId(event, entityId);
+            const subscriptionUrl = getSubscriptionUrl(apiModule, entityId, event);
+            emitter.on(subscriptionId, callback);
+            return addPendingEntry(subscriptionUrl, subscriptionId, callback);
+        },
+        hasListeners: () => {
+            return Object.keys(subscriptions).length > 0 || getTotalEmitterSubscriptionCount() > 0;
+        },
+        addHook: (apiModule, event, callback, subscriberInfo) => {
+            if (!socket().isConnected()) {
+                throw 'Hooks can be added only for a connected socket';
+            }
+            invariant(apiModule.indexOf('/') === -1, 'The first argument should only contain the API section without any path tokens');
+            const subscriptionId = event;
+            if (subscriptions[subscriptionId] || pendingSubscriptions[subscriptionId]) {
+                throw 'Hook exists';
+            }
+            const subscriptionUrl = `${apiModule}/hooks/${event}`;
+            callback = handleHookAction.bind(SocketSubscriptionHandler, subscriptionUrl, callback);
+            emitter.on(subscriptionId, callback);
+            return addPendingEntry(subscriptionUrl, subscriptionId, callback, subscriberInfo);
+        },
+        getPendingSubscriptionCount: () => {
+            return Object.keys(pendingSubscriptions).length;
+        },
+    };
+    // For the socket
+    const SocketSubscriptionsInternal = {
+        onSocketDisconnected() {
+            emitter.removeAllListeners();
+            subscriptions = {};
+        },
+        handleMessage(message) {
+            const ignored = eventIgnored(message.event, ignoredListenerEvents);
+            if (message.completion_id) {
+                if (!ignored) {
+                    logger.verbose(message.event, `(completion id ${message.completion_id})`, message.data);
+                }
+                emitter.emit(message.event, message.data, message.completion_id);
+            }
+            else {
+                if (!ignored) {
+                    logger.verbose(message.event, message.id ? `(entity ${message.id})` : '(no entity)', message.data);
+                }
+                if (message.id) {
+                    // There can be subscribers for a single entity or for all events of this type... emit for both
+                    emitter.emit(getEmitId(message.event, message.id), message.data, message.id);
+                }
+                emitter.emit(message.event, message.data, message.id);
+            }
+        },
+    };
+    return {
+        ...SocketSubscriptionsInternal,
+        socket: SocketSubscriptionsPublic,
+    };
+};
+export default SocketSubscriptionHandler;
+//# sourceMappingURL=SocketSubscriptionHandler.js.map

package/dist/SocketSubscriptionHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocketSubscriptionHandler.js","sourceRoot":"","sources":["../src/SocketSubscriptionHandler.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,OAA0B,MAAM,cAAc,CAAC;AAgBtD,MAAM,yBAAyB,GAAG,CAChC,MAA8B,EAC9B,MAAc,EACd,EAAE,qBAAqB,GAAG,EAAE,EAAqC,EACjE,EAAE;IACF,WAAW;IACX,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,EAAiB,EAAE,EAAE;QACrD,SAAS,CAAC,EAAE,KAAK,CAAC,EAAE,8BAA8B,CAAC,CAAC;QACpD,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACnC,CAAC,CAAC;IAEF,MAAM,kBAAkB,GAAG,CAAC,SAAiB,EAAE,EAA4B,EAAE,KAAa,EAAE,EAAE;QAC5F,IAAI,EAAE,EAAE,CAAC;YACP,OAAO,GAAG,SAAS,IAAI,EAAE,cAAc,KAAK,EAAE,CAAC;QACjD,CAAC;QAED,OAAO,GAAG,SAAS,cAAc,KAAK,EAAE,CAAC;IAC3C,CAAC,CAAC;IAEF,IAAI,aAAa,GAA8B,EAAE,CAAC;IAClD,MAAM,OAAO,GAAG,IAAI,YAAY,EAAE,CAAC;IAEnC,+CAA+C;IAC/C,MAAM,oBAAoB,GAA6C,EAAE,CAAC;IAE1E,MAAM,oBAAoB,GAAG,CAC3B,eAAuB,EACvB,cAAsB,EACtB,QAAwF,EACxF,OAAgB,EAChB,EAAE;QACF,IAAI,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;YAC5B,OAAO;QACT,CAAC;QAED,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;QAChC,OAAO,CAAC,cAAc,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;QAEjD,IAAI,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;gBACtC,MAAM,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC;qBAC7B,KAAK,CACJ,CAAC,KAA6B,EAAE,EAAE;oBAChC,MAAM,CAAC,KAAK,CAAC,kCAAkC,EAAE,eAAe,EAAE,KAAK,CAAC,CAAC;gBAC3E,CAAC,CAAC,CAAC;YACT,CAAC;YAED,OAAO,aAAa,CAAC,cAAc,CAAC,CAAC;QACvC,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,mBAAmB,GAAG,CAC1B,cAAsB,EACtB,QAAwF,EACxF,EAAE;QACF,OAAO,CAAC,cAAc,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,CACvB,eAAuB,EACvB,QAA4D,EAC5D,IAAW,EACX,YAA0C,EAC1C,EAAE;QACF,QAAQ,CACN,IAAI,EACJ,cAAc,CAAC,EAAE;YACf,MAAM,EAAE,CAAC,IAAI,CAAC,GAAG,eAAe,IAAI,YAAY,UAAU,EAAE,cAAc,CAAC;iBACxE,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,EAAE,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC;QAC9F,CAAC,EACD,CAAC,QAAQ,EAAE,aAAa,EAAE,EAAE;YAC1B,MAAM,EAAE,CAAC,IAAI,CAAC,GAAG,eAAe,IAAI,YAAY,SAAS,EAAE;gBACzD,SAAS,EAAE,QAAQ;gBACnB,OAAO,EAAE,aAAa;aACvB,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,uCAAuC,EAAE,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC;QACnG,CAAC,CACF,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,0BAA0B,GAAG,CAAC,cAAsB,EAAE,EAAE;QAC5D,MAAM,OAAO,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;QACrD,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC;QAExF,aAAa,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;QAC/C,OAAO,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAC9C,CAAC,CAAC;IAEF,MAAM,uBAAuB,GAAG,CAAC,cAAsB,EAAE,KAA6B,EAAE,EAAE;QACxF,MAAM,OAAO,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;QACrD,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAEnE,OAAO,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAC9C,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,CACtB,eAAuB,EACvB,cAAsB,EACtB,QAAwF,EACxF,IAAY,EACsC,EAAE;QACpD,MAAM,aAAa,GAAG,CAAC,OAAO,GAAG,IAAI,EAAE,EAAE,CAAC,oBAAoB,CAAC,eAAe,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAEnH,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;YACnC,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC1C,oBAAoB,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC;gBAC1C,MAAM,EAAE;qBACL,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC;qBAC3B,IAAI,CACH,0BAA0B,CAAC,IAAI,CAAC,yBAAyB,EAAE,cAAc,CAAC,EAC1E,uBAAuB,CAAC,IAAI,CAAC,yBAAyB,EAAE,cAAc,CAAC,CACxE,CAAC;YACN,CAAC;YAED,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;YACnC,oBAAoB,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC;gBACxC,QAAQ;gBACR,aAAa;aACd,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC,OAAO,CAAC;QAC1B,CAAC;QAED,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;QAChC,OAAO,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACxC,CAAC,CAAC;IAEF,MAAM,gCAAgC,GAAG,GAAW,EAAE;QACpD,OAAO,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;aAC9B,MAAM,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;IACzE,CAAC,CAAC;IAEF,SAAS;IAET,wEAAwE;IACxE,MAAM,yBAAyB,GAAsC;QACnE,qBAAqB,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE;YACtD,MAAM,cAAc,GAAG,SAAS,CAAC,GAAG,QAAQ,UAAU,EAAE,QAAQ,CAAC,CAAC;YAClE,OAAO,CAAC,EAAE,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;YACrC,OAAO,GAAG,EAAE,CAAC,mBAAmB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;QAC7D,CAAC;QAED,2EAA2E;QAC3E,WAAW,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE;YACpD,IAAI,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;gBAC5B,MAAM,oDAAoD,CAAC;YAC7D,CAAC;YAED,SAAS,CACP,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAC7B,0HAA0H,CAC3H,CAAC;YAEF,MAAM,cAAc,GAAG,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAClD,MAAM,eAAe,GAAG,kBAAkB,CAAC,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;YAEvE,OAAO,CAAC,EAAE,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;YACrC,OAAO,eAAe,CAAC,eAAe,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC;QACpE,CAAC;QAED,YAAY,EAAE,GAAG,EAAE;YACjB,OAAO,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,gCAAgC,EAAE,GAAG,CAAC,CAAC;QACzF,CAAC;QAED,OAAO,EAAE,CACP,SAAiB,EACjB,KAAa,EACb,QAA4D,EAC5D,cAAgD,EAChD,EAAE;YACF,IAAI,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;gBAC5B,MAAM,gDAAgD,CAAC;YACzD,CAAC;YAED,SAAS,CACP,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAC7B,gFAAgF,CACjF,CAAC;YAEF,MAAM,cAAc,GAAG,KAAK,CAAC;YAC7B,IAAI,aAAa,CAAC,cAAc,CAAC,IAAI,oBAAoB,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC1E,MAAM,aAAa,CAAC;YACtB,CAAC;YAED,MAAM,eAAe,GAAG,GAAG,SAAS,UAAU,KAAK,EAAE,CAAC;YAEtD,QAAQ,GAAG,gBAAgB,CAAC,IAAI,CAAC,yBAAyB,EAAE,eAAe,EAAE,QAAQ,CAAC,CAAC;YACvF,OAAO,CAAC,EAAE,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;YAErC,OAAO,eAAe,CAAC,eAAe,EAAE,cAAc,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC;QACpF,CAAC;QAED,2BAA2B,EAAE,GAAG,EAAE;YAChC,OAAO,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,MAAM,CAAC;QAClD,CAAC;KACF,CAAC;IAEF,iBAAiB;IACjB,MAAM,2BAA2B,GAAG;QAClC,oBAAoB;YAClB,OAAO,CAAC,kBAAkB,EAAE,CAAC;YAC7B,aAAa,GAAG,EAAE,CAAC;QACrB,CAAC;QAED,aAAa,CAAC,OAA8C;YAC1D,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;YACnE,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;gBAC1B,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,kBAAkB,OAAO,CAAC,aAAa,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC1F,CAAC;gBAED,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;YACnE,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;gBACrG,CAAC;gBAED,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC;oBACf,+FAA+F;oBAC/F,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;gBAC/E,CAAC;gBAED,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;KACF,CAAC;IAEF,OAAO;QACL,GAAG,2BAA2B;QAC9B,MAAM,EAAE,yBAAyB;KAClC,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,yBAAyB,CAAC"}

package/dist/tests/helpers.d.ts

@@ -0,0 +1,57 @@
+import * as Options from '../types/options.js';
+export declare const waitForExpect: (func: () => void | Promise<void>) => any;
+declare const CONNECT_PARAMS: {
+    username: string;
+    password: string;
+    url: string;
+};
+declare const AUTH_RESPONSE: {
+    auth_token: string;
+    refresh_token: string;
+    user: {
+        permissions: string[];
+        username: string;
+        active_sessions: number;
+        last_login: number;
+    };
+    system: {
+        cid: string;
+        hostname: string;
+        network_type: string;
+        path_separator: string;
+        platform: string;
+        language: string;
+    };
+    wizard_pending: boolean;
+};
+export type MockSocketOptions = Omit<Options.APISocketOptions, 'username' | 'password' | 'url'> & {
+    username?: string;
+    password?: string;
+    url?: string;
+};
+declare const getSocket: (options?: MockSocketOptions) => {
+    socket: import("../NodeSocket.js").APISocket;
+    mockConsole: {
+        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>;
+        error: import("jest-mock").Mock<(a1: any, a2: any, a3: any, a4: any) => void>;
+    };
+};
+type Callback = (requestData: object) => void;
+declare const getConnectedSocket: (server: ReturnType<typeof getMockServer>, options?: MockSocketOptions, authCallback?: Callback) => Promise<{
+    socket: import("../NodeSocket.js").APISocket;
+    mockConsole: {
+        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>;
+        error: import("jest-mock").Mock<(a1: any, a2: any, a3: any, a4: any) => void>;
+    };
+}>;
+declare const getMockServer: () => {
+    addDataHandler: <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;
+    stop: () => void;
+    send: (data: object) => void;
+};
+export { getMockServer, getSocket, getConnectedSocket, CONNECT_PARAMS, AUTH_RESPONSE };

package/dist/tests/helpers.js

@@ -0,0 +1,127 @@
+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 CONNECT_PARAMS = {
+    username: 'test',
+    password: 'test',
+    url: 'ws://localhost:7171/api/v1/',
+};
+const getDefaultSocketOptions = (mockConsole) => ({
+    ...CONNECT_PARAMS,
+    logOutput: mockConsole,
+    logLevel: VERBOSE ? 'verbose' : 'warn',
+});
+const 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 = (options = {}) => {
+    const mockConsole = getMockConsole();
+    const socket = Socket({
+        ...getDefaultSocketOptions(mockConsole),
+        ...options,
+    }, WebSocket);
+    return { socket, mockConsole };
+};
+const getConnectedSocket = async (server, options, authCallback) => {
+    server.addDataHandler('POST', ApiConstants.LOGIN_URL, AUTH_RESPONSE, authCallback);
+    const { socket, mockConsole } = getSocket(options);
+    await socket.connect();
+    return { socket, mockConsole };
+};
+const toEmitId = (path, method) => {
+    return `${path}_${method}`;
+};
+const getMockServer = () => {
+    const mockServer = new Server(CONNECT_PARAMS.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, CONNECT_PARAMS, AUTH_RESPONSE };
+//# sourceMappingURL=helpers.js.map

package/dist/tests/helpers.js.map

@@ -0,0 +1 @@
+{"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,cAAc,GAAG;IACrB,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,cAAc;IACjB,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM;CACvC,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG;IACpB,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,UAA6B,EAAE,EAAE,EAAE;IACpD,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,MAAM,GAAG,MAAM,CACnB;QACE,GAAG,uBAAuB,CAAC,WAAW,CAAC;QACvC,GAAG,OAAO;KACX,EACD,SAAgB,CACjB,CAAC;IAEF,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;AACjC,CAAC,CAAC;AAKF,MAAM,kBAAkB,GAAG,KAAK,EAC9B,MAAwC,EACxC,OAA2B,EAC3B,YAAuB,EACvB,EAAE;IACF,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,SAAS,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC;IAEnF,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IACnD,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,GAAG,EAAE;IACzB,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IAClD,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,cAAc,EAAE,aAAa,EAAE,CAAC"}

package/dist/types/api.d.ts

@@ -0,0 +1,30 @@
+export type AuthTokenType = string;
+export interface AuthenticationResponse {
+    auth_token: AuthTokenType;
+}
+export interface LogoutResponse {
+}
+export interface CredentialsAuthenticationData {
+    username: string;
+    password: string;
+    grant_type: 'password';
+    max_inactivity?: number;
+}
+export interface RefreshTokenAuthenticationData {
+    refresh_token: string;
+    grant_type: 'refresh_token';
+    max_inactivity?: number;
+}
+export interface TokenAuthenticationData {
+    auth_token: string;
+}
+export type FieldErrorCode = 'missing_field' | 'invalid' | 'already_exists';
+export interface FieldError extends ErrorBase {
+    message: string;
+    field: string;
+    code: FieldErrorCode;
+}
+export interface ErrorBase {
+    message: string;
+}
+export type EntityId = string | number;

package/dist/types/api.js

@@ -0,0 +1,3 @@
+// AUTHENTICATION
+export {};
+//# sourceMappingURL=api.js.map

package/dist/types/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/types/api.ts"],"names":[],"mappings":"AAAA,iBAAiB"}

package/dist/types/api_internal.d.ts

@@ -0,0 +1,24 @@
+export type CompletionIdType = number;
+import { ErrorBase, FieldError, EntityId } from './api.js';
+export interface RequestResponseBase {
+    code: number;
+    callback_id: number;
+}
+export interface RequestSuccessResponse<DataT extends object | undefined = object | undefined> extends RequestResponseBase {
+    data?: DataT;
+}
+export interface RequestErrorResponse extends RequestResponseBase {
+    error: ErrorBase | FieldError;
+}
+export interface OutgoingRequest<DataT extends object | undefined = object | undefined> {
+    path: string;
+    method: string;
+    data: DataT;
+    callback_id: number;
+}
+export interface IncomingSubscriptionEvent<DataT extends object | undefined = object | undefined> {
+    event: string;
+    data: DataT;
+    completion_id?: CompletionIdType;
+    id?: EntityId;
+}

package/dist/types/api_internal.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api_internal.js.map

package/dist/types/api_internal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api_internal.js","sourceRoot":"","sources":["../../src/types/api_internal.ts"],"names":[],"mappings":""}

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from './api.js';
+export * from './logger.js';
+export * from './requests.js';
+export * from './subscriptions.js';
+export * from './socket.js';
+export * from './options.js';
+export * from './public_helpers.js';

package/dist/types/index.js

@@ -0,0 +1,8 @@
+export * from './api.js';
+export * from './logger.js';
+export * from './requests.js';
+export * from './subscriptions.js';
+export * from './socket.js';
+export * from './options.js';
+export * from './public_helpers.js';
+//# sourceMappingURL=index.js.map