@siebly/kraken-api 0.0.9

package/dist/mjs/lib/websocket/WsStore.js

@@ -0,0 +1,298 @@
+import { DefaultLogger } from './logger.js';
+import { WsConnectionStateEnum, } from './WsStore.types.js';
+/**
+ * Simple comparison of two objects, recursive for nested objects. Adoped from OKX SDK.
+ */
+export function isDeepObjectMatch(object1, object2) {
+    if (typeof object2 !== typeof object1) {
+        return false;
+    }
+    const keys1 = Object.keys(object1).sort();
+    const keys2 = Object.keys(object2).sort();
+    const hasSameKeyCount = keys1.length === keys2.length;
+    if (!hasSameKeyCount) {
+        // console.log('not same key count', { keys1, keys2 });
+        // not the same amount of keys or keys don't match
+        return false;
+    }
+    const hasSameKeyNames = keys1.every((val, i) => val === keys2[i]);
+    if (!hasSameKeyNames) {
+        // console.log('not same key names: ', { keys1, keys2 });
+        return false;
+    }
+    for (const key in object1) {
+        const value1 = object1[key];
+        const value2 = object2[key];
+        if (typeof value1 === 'object' && typeof value2 === 'object') {
+            if (!isDeepObjectMatch(value1, value2)) {
+                return false;
+            }
+        }
+        if (value1 !== value2) {
+            return false;
+        }
+    }
+    return true;
+}
+const DEFERRED_PROMISE_REF = {
+    CONNECTION_IN_PROGRESS: 'CONNECTION_IN_PROGRESS',
+    AUTHENTICATION_IN_PROGRESS: 'AUTHENTICATION_IN_PROGRESS',
+};
+export class WsStore {
+    wsState = {};
+    logger;
+    constructor(logger) {
+        this.logger = logger || DefaultLogger;
+    }
+    get(key, createIfMissing) {
+        if (this.wsState[key]) {
+            return this.wsState[key];
+        }
+        if (createIfMissing) {
+            return this.create(key);
+        }
+    }
+    getKeys() {
+        return Object.keys(this.wsState);
+    }
+    create(key) {
+        if (this.hasExistingActiveConnection(key)) {
+            this.logger.info('WsStore setConnection() overwriting existing open connection: ', this.getWs(key));
+        }
+        this.wsState[key] = {
+            subscribedTopics: new Set(),
+            connectionState: WsConnectionStateEnum.INITIAL,
+            deferredPromiseStore: {},
+        };
+        return this.get(key);
+    }
+    delete(key) {
+        // TODO: should we allow this at all? Perhaps block this from happening...
+        if (this.hasExistingActiveConnection(key)) {
+            const ws = this.getWs(key);
+            this.logger.info('WsStore deleting state for connection still open: ', ws);
+            ws?.close();
+        }
+        delete this.wsState[key];
+    }
+    /* connection websocket */
+    hasExistingActiveConnection(key) {
+        return this.get(key) && this.isWsOpen(key);
+    }
+    getWs(key) {
+        return this.get(key)?.ws;
+    }
+    setWs(key, wsConnection) {
+        if (this.isWsOpen(key)) {
+            this.logger.info('WsStore setConnection() overwriting existing open connection: ', this.getWs(key));
+        }
+        this.get(key, true).ws = wsConnection;
+        return wsConnection;
+    }
+    /**
+     * deferred promises
+     */
+    getDeferredPromise(wsKey, promiseRef) {
+        const storeForKey = this.get(wsKey);
+        if (!storeForKey) {
+            return;
+        }
+        const deferredPromiseStore = storeForKey.deferredPromiseStore;
+        return deferredPromiseStore[promiseRef];
+    }
+    createDeferredPromise(wsKey, promiseRef, throwIfExists) {
+        const existingPromise = this.getDeferredPromise(wsKey, promiseRef);
+        if (existingPromise) {
+            if (throwIfExists) {
+                throw new Error(`Promise exists for "${wsKey}"`);
+            }
+            else {
+                // console.log('existing promise');
+                return existingPromise;
+            }
+        }
+        // console.log('create promise');
+        const createIfMissing = true;
+        const storeForKey = this.get(wsKey, createIfMissing);
+        // TODO: Once stable, use Promise.withResolvers in future
+        const deferredPromise = {};
+        deferredPromise.promise = new Promise((resolve, reject) => {
+            deferredPromise.resolve = resolve;
+            deferredPromise.reject = reject;
+        });
+        const deferredPromiseStore = storeForKey.deferredPromiseStore;
+        deferredPromiseStore[promiseRef] = deferredPromise;
+        return deferredPromise;
+    }
+    resolveDeferredPromise(wsKey, promiseRef, value, removeAfter) {
+        const promise = this.getDeferredPromise(wsKey, promiseRef);
+        if (promise?.resolve) {
+            promise.resolve(value);
+        }
+        if (removeAfter) {
+            this.removeDeferredPromise(wsKey, promiseRef);
+        }
+    }
+    rejectDeferredPromise(wsKey, promiseRef, value, removeAfter) {
+        const promise = this.getDeferredPromise(wsKey, promiseRef);
+        if (promise?.reject) {
+            this.logger.trace(`rejectDeferredPromise(): rejecting ${wsKey}/${promiseRef}`, value);
+            if (typeof value === 'string') {
+                promise.reject(new Error(value));
+            }
+            else {
+                promise.reject(value);
+            }
+        }
+        if (removeAfter) {
+            this.removeDeferredPromise(wsKey, promiseRef);
+        }
+    }
+    removeDeferredPromise(wsKey, promiseRef) {
+        const storeForKey = this.get(wsKey);
+        if (!storeForKey) {
+            return;
+        }
+        const deferredPromise = storeForKey.deferredPromiseStore[promiseRef];
+        if (deferredPromise) {
+            // Just in case it's pending
+            if (deferredPromise.resolve) {
+                deferredPromise.resolve('promiseRemoved');
+            }
+            delete storeForKey.deferredPromiseStore[promiseRef];
+        }
+    }
+    rejectAllDeferredPromises(wsKey, reason) {
+        const storeForKey = this.get(wsKey);
+        const deferredPromiseStore = storeForKey.deferredPromiseStore;
+        if (!storeForKey || !deferredPromiseStore) {
+            return;
+        }
+        const reservedKeys = Object.values(DEFERRED_PROMISE_REF);
+        for (const promiseRef in deferredPromiseStore) {
+            // Skip reserved keys, such as the connection promise
+            if (reservedKeys.includes(promiseRef)) {
+                continue;
+            }
+            try {
+                this.logger.trace(`rejectAllDeferredPromises(): rejecting ${wsKey}/${promiseRef}/${reason}`);
+                this.rejectDeferredPromise(wsKey, promiseRef, reason, true);
+            }
+            catch (e) {
+                this.logger.error('rejectAllDeferredPromises(): Exception rejecting deferred promise', { wsKey: wsKey, reason, promiseRef, exception: e });
+            }
+        }
+    }
+    /** Get promise designed to track a connection attempt in progress. Resolves once connected. */
+    getConnectionInProgressPromise(wsKey) {
+        return this.getDeferredPromise(wsKey, DEFERRED_PROMISE_REF.CONNECTION_IN_PROGRESS);
+    }
+    getAuthenticationInProgressPromise(wsKey) {
+        return this.getDeferredPromise(wsKey, DEFERRED_PROMISE_REF.AUTHENTICATION_IN_PROGRESS);
+    }
+    /**
+     * Create a deferred promise designed to track a connection attempt in progress.
+     *
+     * Will throw if existing promise is found.
+     */
+    createConnectionInProgressPromise(wsKey, throwIfExists) {
+        return this.createDeferredPromise(wsKey, DEFERRED_PROMISE_REF.CONNECTION_IN_PROGRESS, throwIfExists);
+    }
+    createAuthenticationInProgressPromise(wsKey, throwIfExists) {
+        return this.createDeferredPromise(wsKey, DEFERRED_PROMISE_REF.AUTHENTICATION_IN_PROGRESS, throwIfExists);
+    }
+    /** Remove promise designed to track a connection attempt in progress */
+    removeConnectingInProgressPromise(wsKey) {
+        return this.removeDeferredPromise(wsKey, DEFERRED_PROMISE_REF.CONNECTION_IN_PROGRESS);
+    }
+    removeAuthenticationInProgressPromise(wsKey) {
+        return this.removeDeferredPromise(wsKey, DEFERRED_PROMISE_REF.AUTHENTICATION_IN_PROGRESS);
+    }
+    /* connection state */
+    isWsOpen(key) {
+        const existingConnection = this.getWs(key);
+        return (!!existingConnection &&
+            existingConnection.readyState === existingConnection.OPEN);
+    }
+    getConnectionState(key) {
+        return this.get(key, true).connectionState;
+    }
+    setConnectionState(key, state) {
+        this.get(key, true).connectionState = state;
+        this.get(key, true).connectionStateChangedAt = new Date();
+    }
+    isConnectionState(key, state) {
+        return this.getConnectionState(key) === state;
+    }
+    /**
+     * Check if we're currently in the process of opening a connection for any reason. Safer than only checking "CONNECTING" as the state
+     * @param key
+     * @returns
+     */
+    isConnectionAttemptInProgress(key) {
+        const isConnectionInProgress = this.isConnectionState(key, WsConnectionStateEnum.CONNECTING) ||
+            this.isConnectionState(key, WsConnectionStateEnum.RECONNECTING);
+        if (isConnectionInProgress) {
+            const wsState = this.get(key, true);
+            const stateLastChangedAt = wsState?.connectionStateChangedAt;
+            const stateChangedAtTimestamp = stateLastChangedAt?.getTime();
+            if (stateChangedAtTimestamp) {
+                const timestampNow = new Date().getTime();
+                const stateChangedTimeAgo = timestampNow - stateChangedAtTimestamp;
+                const stateChangeTimeout = 15000; // allow a max 15 second timeout since the last state change before assuming stuck;
+                if (stateChangedTimeAgo >= stateChangeTimeout) {
+                    const msg = 'State change timed out, reconnect workflow stuck?';
+                    this.logger.error(msg, { key, wsState });
+                    this.setConnectionState(key, WsConnectionStateEnum.ERROR);
+                }
+            }
+        }
+        return isConnectionInProgress;
+    }
+    /* subscribed topics */
+    getTopics(key) {
+        return this.get(key, true).subscribedTopics;
+    }
+    getTopicsAsArray(key) {
+        return [...this.getTopics(key).values()];
+    }
+    getTopicsByKey() {
+        const result = {};
+        for (const refKey in this.wsState) {
+            result[refKey] = this.getTopics(refKey);
+        }
+        return result;
+    }
+    /**
+     * Find matching "topic" request from the store
+     * @param key
+     * @param topic
+     * @returns
+     */
+    getMatchingTopic(key, topic) {
+        const allTopics = this.getTopics(key).values();
+        for (const storedTopic of allTopics) {
+            const matchesStoredTopic = isDeepObjectMatch(topic, storedTopic);
+            if (matchesStoredTopic) {
+                return storedTopic;
+            }
+        }
+    }
+    addTopic(key, topic) {
+        // Check for duplicate topic. If already tracked, don't store this one
+        const existingTopic = this.getMatchingTopic(key, topic);
+        if (existingTopic) {
+            return this.getTopics(key);
+        }
+        return this.getTopics(key).add(topic);
+    }
+    deleteTopic(key, topic) {
+        // Check if we're subscribed to a topic like this
+        const storedTopic = this.getMatchingTopic(key, topic);
+        if (storedTopic) {
+            this.getTopics(key).delete(storedTopic);
+        }
+        return this.getTopics(key);
+    }
+}
+//# sourceMappingURL=WsStore.js.map

package/dist/mjs/lib/websocket/WsStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WsStore.js","sourceRoot":"","sources":["../../../../src/lib/websocket/WsStore.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAGL,qBAAqB,GAEtB,MAAM,oBAAoB,CAAC;AAE5B;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAY,EAAE,OAAY;IAC1D,IAAI,OAAO,OAAO,KAAK,OAAO,OAAO,EAAE,CAAC;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;IAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;IAE1C,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,CAAC;IACtD,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,uDAAuD;QACvD,kDAAkD;QAClD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,eAAe,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,yDAAyD;QACzD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAE5B,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC7D,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;gBACvC,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,oBAAoB,GAAG;IAC3B,sBAAsB,EAAE,wBAAwB;IAChD,0BAA0B,EAAE,4BAA4B;CAChD,CAAC;AAKX,MAAM,OAAO,OAAO;IAIV,OAAO,GACb,EAAE,CAAC;IAEG,MAAM,CAAgB;IAE9B,YAAY,MAAqB;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,aAAa,CAAC;IACxC,CAAC;IAaD,GAAG,CACD,GAAU,EACV,eAAyB;QAEzB,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QAED,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,OAAO;QACL,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAY,CAAC;IAC9C,CAAC;IAED,MAAM,CAAC,GAAU;QACf,IAAI,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,gEAAgE,EAChE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAChB,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG;YAClB,gBAAgB,EAAE,IAAI,GAAG,EAA8B;YACvD,eAAe,EAAE,qBAAqB,CAAC,OAAO;YAC9C,oBAAoB,EAAE,EAAE;SACzB,CAAC;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,GAAU;QACf,0EAA0E;QAC1E,IAAI,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1C,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,oDAAoD,EACpD,EAAE,CACH,CAAC;YACF,EAAE,EAAE,KAAK,EAAE,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,0BAA0B;IAE1B,2BAA2B,CAAC,GAAU;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,GAAU;QACd,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,GAAU,EAAE,YAAuB;QACvC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,gEAAgE,EAChE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAChB,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,EAAE,GAAG,YAAY,CAAC;QACtC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;OAEG;IAEH,kBAAkB,CAChB,KAAY,EACZ,UAAuC;QAEvC,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QAED,MAAM,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC;QAC9D,OAAO,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAC1C,CAAC;IAED,qBAAqB,CACnB,KAAY,EACZ,UAAuC,EACvC,aAAsB;QAEtB,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAC7C,KAAK,EACL,UAAU,CACX,CAAC;QACF,IAAI,eAAe,EAAE,CAAC;YACpB,IAAI,aAAa,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,uBAAuB,KAAK,GAAG,CAAC,CAAC;YACnD,CAAC;iBAAM,CAAC;gBACN,mCAAmC;gBACnC,OAAO,eAAe,CAAC;YACzB,CAAC;QACH,CAAC;QAED,iCAAiC;QACjC,MAAM,eAAe,GAAG,IAAI,CAAC;QAC7B,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;QAErD,yDAAyD;QACzD,MAAM,eAAe,GAAoB,EAAE,CAAC;QAE5C,eAAe,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxD,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;YAClC,eAAe,CAAC,MAAM,GAAG,MAAM,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,MAAM,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC;QAE9D,oBAAoB,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC;QAEnD,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,sBAAsB,CACpB,KAAY,EACZ,UAAuC,EACvC,KAAc,EACd,WAAoB;QAEpB,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC3D,IAAI,OAAO,EAAE,OAAO,EAAE,CAAC;YACrB,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;QACD,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,qBAAqB,CACnB,KAAY,EACZ,UAAuC,EACvC,KAAc,EACd,WAAoB;QAEpB,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAE3D,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,sCAAsC,KAAK,IAAI,UAAU,EAAE,EAC3D,KAAK,CACN,CAAC;YAEF,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YACnC,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,qBAAqB,CACnB,KAAY,EACZ,UAAuC;QAEvC,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QAED,MAAM,eAAe,GAAG,WAAW,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACrE,IAAI,eAAe,EAAE,CAAC;YACpB,4BAA4B;YAC5B,IAAI,eAAe,CAAC,OAAO,EAAE,CAAC;gBAC5B,eAAe,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;YAC5C,CAAC;YAED,OAAO,WAAW,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED,yBAAyB,CAAC,KAAY,EAAE,MAAc;QACpD,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpC,MAAM,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC;QAC9D,IAAI,CAAC,WAAW,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1C,OAAO;QACT,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAa,CAAC;QAErE,KAAK,MAAM,UAAU,IAAI,oBAAoB,EAAE,CAAC;YAC9C,qDAAqD;YACrD,IAAI,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBACtC,SAAS;YACX,CAAC;YAED,IAAI,CAAC;gBACH,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,0CAA0C,KAAK,IAAI,UAAU,IAAI,MAAM,EAAE,CAC1E,CAAC;gBACF,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;YAC9D,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,mEAAmE,EACnE,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,EAAE,CACnD,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,+FAA+F;IAC/F,8BAA8B,CAC5B,KAAY;QAEZ,OAAO,IAAI,CAAC,kBAAkB,CAC5B,KAAK,EACL,oBAAoB,CAAC,sBAAsB,CAC5C,CAAC;IACJ,CAAC;IAED,kCAAkC,CAChC,KAAY;QAEZ,OAAO,IAAI,CAAC,kBAAkB,CAC5B,KAAK,EACL,oBAAoB,CAAC,0BAA0B,CAChD,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,iCAAiC,CAC/B,KAAY,EACZ,aAAsB;QAEtB,OAAO,IAAI,CAAC,qBAAqB,CAC/B,KAAK,EACL,oBAAoB,CAAC,sBAAsB,EAC3C,aAAa,CACd,CAAC;IACJ,CAAC;IAED,qCAAqC,CACnC,KAAY,EACZ,aAAsB;QAEtB,OAAO,IAAI,CAAC,qBAAqB,CAC/B,KAAK,EACL,oBAAoB,CAAC,0BAA0B,EAC/C,aAAa,CACd,CAAC;IACJ,CAAC;IAED,wEAAwE;IACxE,iCAAiC,CAAC,KAAY;QAC5C,OAAO,IAAI,CAAC,qBAAqB,CAC/B,KAAK,EACL,oBAAoB,CAAC,sBAAsB,CAC5C,CAAC;IACJ,CAAC;IAED,qCAAqC,CAAC,KAAY;QAChD,OAAO,IAAI,CAAC,qBAAqB,CAC/B,KAAK,EACL,oBAAoB,CAAC,0BAA0B,CAChD,CAAC;IACJ,CAAC;IAED,sBAAsB;IAEtB,QAAQ,CAAC,GAAU;QACjB,MAAM,kBAAkB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3C,OAAO,CACL,CAAC,CAAC,kBAAkB;YACpB,kBAAkB,CAAC,UAAU,KAAK,kBAAkB,CAAC,IAAI,CAC1D,CAAC;IACJ,CAAC;IAED,kBAAkB,CAAC,GAAU;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,eAAgB,CAAC;IAC9C,CAAC;IAED,kBAAkB,CAAC,GAAU,EAAE,KAA4B;QACzD,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,eAAe,GAAG,KAAK,CAAC;QAC5C,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,wBAAwB,GAAG,IAAI,IAAI,EAAE,CAAC;IAC5D,CAAC;IAED,iBAAiB,CAAC,GAAU,EAAE,KAA4B;QACxD,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,6BAA6B,CAAC,GAAU;QACtC,MAAM,sBAAsB,GAC1B,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,qBAAqB,CAAC,UAAU,CAAC;YAC7D,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAElE,IAAI,sBAAsB,EAAE,CAAC;YAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACpC,MAAM,kBAAkB,GAAG,OAAO,EAAE,wBAAwB,CAAC;YAC7D,MAAM,uBAAuB,GAAG,kBAAkB,EAAE,OAAO,EAAE,CAAC;YAC9D,IAAI,uBAAuB,EAAE,CAAC;gBAC5B,MAAM,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;gBAC1C,MAAM,mBAAmB,GAAG,YAAY,GAAG,uBAAuB,CAAC;gBACnE,MAAM,kBAAkB,GAAG,KAAK,CAAC,CAAC,mFAAmF;gBACrH,IAAI,mBAAmB,IAAI,kBAAkB,EAAE,CAAC;oBAC9C,MAAM,GAAG,GAAG,mDAAmD,CAAC;oBAChE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;oBACzC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC;gBAC5D,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,sBAAsB,CAAC;IAChC,CAAC;IAED,uBAAuB;IAEvB,SAAS,CAAC,GAAU;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,gBAAgB,CAAC;IAC9C,CAAC;IAED,gBAAgB,CAAC,GAAU;QACzB,OAAO,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,cAAc;QACZ,MAAM,MAAM,GAAoD,EAAE,CAAC;QAEnE,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAe,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,GAAU,EAAE,KAAiC;QAC5D,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;QAC/C,KAAK,MAAM,WAAW,IAAI,SAAS,EAAE,CAAC;YACpC,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YACjE,IAAI,kBAAkB,EAAE,CAAC;gBACvB,OAAO,WAAW,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IAED,QAAQ,CAAC,GAAU,EAAE,KAAiC;QACpD,sEAAsE;QACtE,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACxD,IAAI,aAAa,EAAE,CAAC;YAClB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAED,WAAW,CAAC,GAAU,EAAE,KAAiC;QACvD,iDAAiD;QACjD,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtD,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;CACF"}

package/dist/mjs/lib/websocket/WsStore.types.d.ts

@@ -0,0 +1,51 @@
+import WebSocket from 'isomorphic-ws';
+export declare enum WsConnectionStateEnum {
+    INITIAL = 0,
+    CONNECTING = 1,
+    CONNECTED = 2,
+    CLOSING = 3,
+    RECONNECTING = 4,
+    ERROR = 5
+}
+export interface DeferredPromise<TSuccess = any, TError = any> {
+    resolve?: (value: TSuccess) => TSuccess;
+    reject?: (value: TError) => TError;
+    promise?: Promise<TSuccess>;
+}
+export interface WSConnectedResult {
+    wsKey: string;
+    ws: WebSocket;
+}
+export interface WsStoredState<TWSTopicSubscribeEvent extends string | object> {
+    /** The currently active websocket connection */
+    ws?: WebSocket;
+    /** The current lifecycle state of the connection (enum) */
+    connectionState?: WsConnectionStateEnum;
+    connectionStateChangedAt?: Date;
+    /** A timer that will send an upstream heartbeat (ping) when it expires */
+    activePingTimer?: ReturnType<typeof setTimeout> | undefined;
+    /** A timer tracking that an upstream heartbeat was sent, expecting a reply before it expires */
+    activePongTimer?: ReturnType<typeof setTimeout> | undefined;
+    /** If a reconnection is in progress, this will have the timer for the delayed reconnect */
+    activeReconnectTimer?: ReturnType<typeof setTimeout> | undefined;
+    /**
+     * When a connection attempt is in progress (even for reconnect), a promise is stored here.
+     *
+     * This promise will resolve once connected (and will then get removed);
+     */
+    deferredPromiseStore: Record<string, DeferredPromise>;
+    /**
+     * All the topics we are expected to be subscribed to on this connection (and we automatically resubscribe to if the connection drops)
+     *
+     * A "Set" and a deep-object-match are used to ensure we only subscribe to a topic once (tracking a list of unique topics we're expected to be connected to)
+     */
+    subscribedTopics: Set<TWSTopicSubscribeEvent>;
+    /** Whether this connection has completed authentication (only applies to private connections) */
+    isAuthenticated?: boolean;
+    /**
+     * Whether this connection has completed authentication before for the Websocket API, so it knows to automatically reauth if reconnected
+     */
+    didAuthWSAPI?: boolean;
+    /** To reauthenticate on the WS API, which channel do we send to? */
+    WSAPIAuthChannel?: string;
+}

package/dist/mjs/lib/websocket/WsStore.types.js

@@ -0,0 +1,11 @@
+export var WsConnectionStateEnum;
+(function (WsConnectionStateEnum) {
+    WsConnectionStateEnum[WsConnectionStateEnum["INITIAL"] = 0] = "INITIAL";
+    WsConnectionStateEnum[WsConnectionStateEnum["CONNECTING"] = 1] = "CONNECTING";
+    WsConnectionStateEnum[WsConnectionStateEnum["CONNECTED"] = 2] = "CONNECTED";
+    WsConnectionStateEnum[WsConnectionStateEnum["CLOSING"] = 3] = "CLOSING";
+    WsConnectionStateEnum[WsConnectionStateEnum["RECONNECTING"] = 4] = "RECONNECTING";
+    // ERROR_RECONNECTING = 5,
+    WsConnectionStateEnum[WsConnectionStateEnum["ERROR"] = 5] = "ERROR";
+})(WsConnectionStateEnum || (WsConnectionStateEnum = {}));
+//# sourceMappingURL=WsStore.types.js.map

package/dist/mjs/lib/websocket/WsStore.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WsStore.types.js","sourceRoot":"","sources":["../../../../src/lib/websocket/WsStore.types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,qBAQX;AARD,WAAY,qBAAqB;IAC/B,uEAAW,CAAA;IACX,6EAAc,CAAA;IACd,2EAAa,CAAA;IACb,uEAAW,CAAA;IACX,iFAAgB,CAAA;IAChB,0BAA0B;IAC1B,mEAAS,CAAA;AACX,CAAC,EARW,qBAAqB,KAArB,qBAAqB,QAQhC"}

package/dist/mjs/lib/websocket/logger.d.ts

@@ -0,0 +1,7 @@
+export type LogParams = null | any;
+export declare const DefaultLogger: {
+    trace: (..._params: LogParams) => void;
+    info: (...params: LogParams) => void;
+    error: (...params: LogParams) => void;
+};
+export type DefaultLogger = typeof DefaultLogger;

package/dist/mjs/lib/websocket/logger.js

@@ -0,0 +1,13 @@
+export const DefaultLogger = {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    trace: (..._params) => {
+        // console.log(_params);
+    },
+    info: (...params) => {
+        console.info(params);
+    },
+    error: (...params) => {
+        console.error(params);
+    },
+};
+//# sourceMappingURL=logger.js.map

package/dist/mjs/lib/websocket/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../../src/lib/websocket/logger.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,6DAA6D;IAC7D,KAAK,EAAE,CAAC,GAAG,OAAkB,EAAQ,EAAE;QACrC,wBAAwB;IAC1B,CAAC;IACD,IAAI,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACnC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC;IACD,KAAK,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACpC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;CACF,CAAC"}

package/dist/mjs/lib/websocket/rest-client-cache.d.ts

@@ -0,0 +1,22 @@
+import { AxiosRequestConfig } from 'axios';
+import { DerivativesClient } from '../../DerivativesClient.js';
+import { SpotClient } from '../../SpotClient.js';
+import { RestClientOptions } from '../requestUtils.js';
+import { DefaultLogger } from './logger.js';
+/**
+ * Caches REST clients and WebSocket tokens to avoid redundant requests.
+ */
+export declare class RestClientCache {
+    private logger;
+    private WS_LOGGER_CATEGORY;
+    private restClients;
+    private wsTokenCache;
+    setLogger(logger: DefaultLogger, loggerCategory: object): void;
+    getSpotRESTClient(restOptions: RestClientOptions, requestOptions?: AxiosRequestConfig): SpotClient;
+    fetchSpotWebSocketToken(restOptions: RestClientOptions, requestOptions?: AxiosRequestConfig): Promise<{
+        token: string;
+        expiresAtMs: number;
+        timeLeftMs: number;
+    }>;
+    getDerivativesRESTClient(restOptions: RestClientOptions, requestOptions?: AxiosRequestConfig): DerivativesClient;
+}

package/dist/mjs/lib/websocket/rest-client-cache.js

@@ -0,0 +1,62 @@
+import { DerivativesClient } from '../../DerivativesClient.js';
+import { SpotClient } from '../../SpotClient.js';
+/**
+ * Caches REST clients and WebSocket tokens to avoid redundant requests.
+ */
+export class RestClientCache {
+    logger;
+    WS_LOGGER_CATEGORY;
+    restClients = {};
+    wsTokenCache = {};
+    setLogger(logger, loggerCategory) {
+        this.logger = logger;
+        this.WS_LOGGER_CATEGORY = loggerCategory;
+    }
+    getSpotRESTClient(restOptions, requestOptions) {
+        if (!this.restClients.spot) {
+            this.restClients.spot = new SpotClient(restOptions, requestOptions);
+        }
+        return this.restClients.spot;
+    }
+    async fetchSpotWebSocketToken(restOptions, requestOptions) {
+        if (this.wsTokenCache.spot) {
+            const now = Date.now();
+            const timeLeftMs = this.wsTokenCache.spot.expiresAtMs - now;
+            if (timeLeftMs > 10000) {
+                this.logger.trace('Using cached spot WebSocket token', {
+                    ...this.WS_LOGGER_CATEGORY,
+                    nowMs: now,
+                    expiresAtMs: this.wsTokenCache.spot.expiresAtMs,
+                    remainingMs: +timeLeftMs.toFixed(0),
+                });
+                // still valid for at least 10s
+                return { ...this.wsTokenCache.spot, timeLeftMs };
+            }
+            this.logger.trace('Spot WebSocket token expired or expiring soon, fetching new token', {
+                ...this.WS_LOGGER_CATEGORY,
+                nowMs: now,
+                expiresAtMs: this.wsTokenCache.spot.expiresAtMs,
+                remainingMs: +timeLeftMs.toFixed(0),
+            });
+            delete this.wsTokenCache.spot;
+        }
+        const client = this.getSpotRESTClient(restOptions, requestOptions);
+        const tokenResult = await client.getWebSocketsToken();
+        const token = tokenResult?.result?.token;
+        if (!token) {
+            throw new Error(`Failed to fetch spot WebSocket token: ${JSON.stringify(tokenResult)}`);
+        }
+        const expiresInSec = tokenResult?.result?.expires || 900;
+        const expiresInMs = expiresInSec * 1000;
+        const expiresAtMs = Date.now() + expiresInMs;
+        this.wsTokenCache.spot = { token, expiresAtMs };
+        return { ...this.wsTokenCache.spot, timeLeftMs: expiresInMs };
+    }
+    getDerivativesRESTClient(restOptions, requestOptions) {
+        if (!this.restClients.derivatives) {
+            this.restClients.derivatives = new DerivativesClient(restOptions, requestOptions);
+        }
+        return this.restClients.derivatives;
+    }
+}
+//# sourceMappingURL=rest-client-cache.js.map

package/dist/mjs/lib/websocket/rest-client-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest-client-cache.js","sourceRoot":"","sources":["../../../../src/lib/websocket/rest-client-cache.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAcjD;;GAEG;AACH,MAAM,OAAO,eAAe;IAClB,MAAM,CAAiB;IAEvB,kBAAkB,CAAU;IAE5B,WAAW,GAA6B,EAAE,CAAC;IAE3C,YAAY,GAAwB,EAAE,CAAC;IAExC,SAAS,CAAC,MAAqB,EAAE,cAAsB;QAC5D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,kBAAkB,GAAG,cAAc,CAAC;IAC3C,CAAC;IAEM,iBAAiB,CACtB,WAA8B,EAC9B,cAAmC;QAEnC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YAC3B,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,IAAI,UAAU,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QACtE,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAEM,KAAK,CAAC,uBAAuB,CAClC,WAA8B,EAC9B,cAAmC;QAEnC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;YAC5D,IAAI,UAAU,GAAG,KAAK,EAAE,CAAC;gBACvB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mCAAmC,EAAE;oBACrD,GAAG,IAAI,CAAC,kBAAkB;oBAC1B,KAAK,EAAE,GAAG;oBACV,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW;oBAC/C,WAAW,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;iBACpC,CAAC,CAAC;gBAEH,+BAA+B;gBAC/B,OAAO,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC;YACnD,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,mEAAmE,EACnE;gBACE,GAAG,IAAI,CAAC,kBAAkB;gBAC1B,KAAK,EAAE,GAAG;gBACV,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW;gBAC/C,WAAW,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;aACpC,CACF,CAAC;YAEF,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;QAChC,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QACnE,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,kBAAkB,EAAE,CAAC;QAEtD,MAAM,KAAK,GAAG,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC;QACzC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CACb,yCAAyC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CACvE,CAAC;QACJ,CAAC;QAED,MAAM,YAAY,GAAG,WAAW,EAAE,MAAM,EAAE,OAAO,IAAI,GAAG,CAAC;QACzD,MAAM,WAAW,GAAG,YAAY,GAAG,IAAI,CAAC;QACxC,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC;QAE7C,IAAI,CAAC,YAAY,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;QAEhD,OAAO,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC;IAChE,CAAC;IAEM,wBAAwB,CAC7B,WAA8B,EAC9B,cAAmC;QAEnC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;YAClC,IAAI,CAAC,WAAW,CAAC,WAAW,GAAG,IAAI,iBAAiB,CAClD,WAAW,EACX,cAAc,CACf,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;IACtC,CAAC;CACF"}

package/dist/mjs/lib/websocket/websocket-util.d.ts

@@ -0,0 +1,76 @@
+import WebSocket from 'isomorphic-ws';
+import { WSAPIRequestOperationKrakenSpot } from '../../types/websockets/ws-api.js';
+import { WSTopic } from '../../types/websockets/ws-subscriptions.js';
+/** Should be one WS key per unique URL */
+export declare const WS_KEY_MAP: {
+    /**
+     * Public WebSocket subscriptions for Kraken Spot products, via the V2 API
+     *
+     * - Ref: https://docs.kraken.com/api/docs/guides/spot-ws-intro
+     * - Channels: https://docs.kraken.com/api/docs/websocket-v2/add_order
+     *
+     * Note: Use spotPrivateV2 for private channels (requires API keys).
+     */
+    readonly spotPublicV2: "spotPublicV2";
+    readonly spotPrivateV2: "spotPrivateV2";
+    readonly spotBetaPublicV2: "spotBetaPublicV2";
+    readonly spotBetaPrivateV2: "spotBetaPrivateV2";
+    /**
+     * Public WebSocket subscriptions for Kraken Derivatives products, via the V1 API:
+     *
+     * - Ref: https://docs.kraken.com/api/docs/guides/futures-websockets
+     * - Channels: https://docs.kraken.com/api/docs/futures-api/websocket/open_orders
+     *
+     * Note: While both Public and Private channels use the same WebSocket URL, we will actually maintain separate connections for easier management. Private channels require authentication and the connection is authenticated automatically.
+     */
+    readonly derivativesPublicV1: "derivativesPublicV1";
+    readonly derivativesPrivateV1: "derivativesPrivateV1";
+};
+/** This is used to differentiate between each of the available websocket streams */
+export type WsKey = (typeof WS_KEY_MAP)[keyof typeof WS_KEY_MAP];
+export type WSOperation = 'subscribe' | 'unsubscribe';
+/**
+ * Normalised internal format for a request (subscribe/unsubscribe/etc) on a topic, with optional parameters.
+ *
+ * - Topic: the topic this event is for
+ * - Payload: the parameters to include, optional. E.g. auth requires key + sign. Some topics allow configurable parameters.
+ */
+export interface WSTopicRequest<TWSTopic extends WSTopic = WSTopic, TWSPayload = any> {
+    topic: TWSTopic;
+    payload?: TWSPayload;
+}
+/**
+ * Conveniently allow users to request a topic either as string topics or objects (containing string topic + params)
+ */
+export type WSTopicRequestOrStringTopic<TWSTopic extends WSTopic, TWSPayload = any> = WSTopicRequest<TWSTopic, TWSPayload> | string;
+export interface WSRequestOperationKraken<TWSTopic extends string, TWSParams extends object = any> {
+    method?: WSOperation;
+    event?: WSOperation;
+    params: {
+        channel: (TWSTopic | string | number)[];
+        symbol?: string[];
+        event_trigger?: string;
+        snapshot?: boolean;
+    } | TWSParams;
+    req_id: number;
+    /**
+     * The following are needed for futures/derivatives requests
+     */
+    feed?: TWSTopic;
+    api_key?: string;
+    original_challenge?: string;
+    signed_challenge?: string;
+}
+/**
+ * #305: ws.terminate() is undefined in browsers.
+ * This only works in node.js, not in browsers.
+ * Does nothing if `ws` is undefined. Does nothing in browsers.
+ */
+export declare function safeTerminateWs(ws?: WebSocket | any, fallbackToClose?: boolean): boolean;
+/**
+ * WS API promises are stored using a primary key. This key is constructed using
+ * properties found in every request & reply.
+ *
+ * The counterpart to this is in resolveEmittableEvents
+ */
+export declare function getPromiseRefForWSAPIRequest(wsKey: WsKey, requestEvent: WSAPIRequestOperationKrakenSpot): string;

package/dist/mjs/lib/websocket/websocket-util.js

@@ -0,0 +1,54 @@
+/** Should be one WS key per unique URL */
+export const WS_KEY_MAP = {
+    /**
+     * Public WebSocket subscriptions for Kraken Spot products, via the V2 API
+     *
+     * - Ref: https://docs.kraken.com/api/docs/guides/spot-ws-intro
+     * - Channels: https://docs.kraken.com/api/docs/websocket-v2/add_order
+     *
+     * Note: Use spotPrivateV2 for private channels (requires API keys).
+     */
+    spotPublicV2: 'spotPublicV2',
+    spotPrivateV2: 'spotPrivateV2',
+    spotBetaPublicV2: 'spotBetaPublicV2',
+    spotBetaPrivateV2: 'spotBetaPrivateV2',
+    /**
+     * Public WebSocket subscriptions for Kraken Derivatives products, via the V1 API:
+     *
+     * - Ref: https://docs.kraken.com/api/docs/guides/futures-websockets
+     * - Channels: https://docs.kraken.com/api/docs/futures-api/websocket/open_orders
+     *
+     * Note: While both Public and Private channels use the same WebSocket URL, we will actually maintain separate connections for easier management. Private channels require authentication and the connection is authenticated automatically.
+     */
+    derivativesPublicV1: 'derivativesPublicV1',
+    derivativesPrivateV1: 'derivativesPrivateV1',
+};
+/**
+ * #305: ws.terminate() is undefined in browsers.
+ * This only works in node.js, not in browsers.
+ * Does nothing if `ws` is undefined. Does nothing in browsers.
+ */
+export function safeTerminateWs(ws, fallbackToClose) {
+    if (!ws) {
+        return false;
+    }
+    if (typeof ws['terminate'] === 'function') {
+        ws.terminate();
+        return true;
+    }
+    else if (fallbackToClose) {
+        ws.close();
+    }
+    return false;
+}
+/**
+ * WS API promises are stored using a primary key. This key is constructed using
+ * properties found in every request & reply.
+ *
+ * The counterpart to this is in resolveEmittableEvents
+ */
+export function getPromiseRefForWSAPIRequest(wsKey, requestEvent) {
+    const promiseRef = [wsKey, requestEvent.method, requestEvent.req_id].join('_');
+    return promiseRef;
+}
+//# sourceMappingURL=websocket-util.js.map

package/dist/mjs/lib/websocket/websocket-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-util.js","sourceRoot":"","sources":["../../../../src/lib/websocket/websocket-util.ts"],"names":[],"mappings":"AAKA,0CAA0C;AAC1C,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB;;;;;;;OAOG;IACH,YAAY,EAAE,cAAc;IAC5B,aAAa,EAAE,eAAe;IAC9B,gBAAgB,EAAE,kBAAkB;IACpC,iBAAiB,EAAE,mBAAmB;IACtC;;;;;;;OAOG;IACH,mBAAmB,EAAE,qBAAqB;IAC1C,oBAAoB,EAAE,sBAAsB;CACpC,CAAC;AAuDX;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAC7B,EAAoB,EACpB,eAAyB;IAEzB,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,EAAE,CAAC,WAAW,CAAC,KAAK,UAAU,EAAE,CAAC;QAC1C,EAAE,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,IAAI,eAAe,EAAE,CAAC;QAC3B,EAAE,CAAC,KAAK,EAAE,CAAC;IACb,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAC1C,KAAY,EACZ,YAA6C;IAE7C,MAAM,UAAU,GAAG,CAAC,KAAK,EAAE,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,IAAI,CACvE,GAAG,CACJ,CAAC;IACF,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/mjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "module"
+}