@triveria/wallet 0.0.0-dev-c46c1cf

package/notifications.js

@@ -0,0 +1,299 @@
+"use strict";
+/**
+ * Hand-written client for the `walletNotifications` SSE endpoint.
+ *
+ * This file is NOT managed by the OpenAPI generator (see .openapi-generator/FILES) -
+ * it builds on top of the generated request builder in `api.ts` to provide an
+ * ergonomic Node.js client for the `GET /wallets/{wallet_id}/notifications`
+ * `text/event-stream` endpoint, including reconnect-with-replay via `Last-Event-ID`.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = Object.create((typeof AsyncIterator === "function" ? AsyncIterator : Object).prototype), verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
+    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WalletNotificationStream = void 0;
+const events_1 = require("events");
+const axios_1 = __importDefault(require("axios"));
+const base_1 = require("./base");
+const common_1 = require("./common");
+const api_1 = require("./api");
+/**
+ * Parses a raw byte/text stream into Server-Sent Events per the WHATWG spec
+ * (https://html.spec.whatwg.org/multipage/server-sent-events.html#event-stream-interpretation).
+ */
+function parseSseStream(source) {
+    return __asyncGenerator(this, arguments, function* parseSseStream_1() {
+        var _a, e_1, _b, _c;
+        let buffer = '';
+        let eventType;
+        let dataLines = [];
+        let id;
+        let sawData = false;
+        function takeEvent() {
+            const event = sawData
+                ? { kind: 'event', id, event: eventType, data: dataLines.join('\n') }
+                : undefined;
+            eventType = undefined;
+            dataLines = [];
+            sawData = false;
+            return event;
+        }
+        try {
+            for (var _d = true, source_1 = __asyncValues(source), source_1_1; source_1_1 = yield __await(source_1.next()), _a = source_1_1.done, !_a; _d = true) {
+                _c = source_1_1.value;
+                _d = false;
+                const chunk = _c;
+                buffer += typeof chunk === 'string' ? chunk : chunk.toString('utf8');
+                let newlineIndex;
+                while ((newlineIndex = buffer.indexOf('\n')) >= 0) {
+                    let line = buffer.slice(0, newlineIndex);
+                    buffer = buffer.slice(newlineIndex + 1);
+                    if (line.endsWith('\r')) {
+                        line = line.slice(0, -1);
+                    }
+                    if (line === '') {
+                        const event = takeEvent();
+                        if (event)
+                            yield yield __await(event);
+                        continue;
+                    }
+                    if (line.startsWith(':')) {
+                        continue;
+                    }
+                    const colonIndex = line.indexOf(':');
+                    const field = colonIndex === -1 ? line : line.slice(0, colonIndex);
+                    let value = colonIndex === -1 ? '' : line.slice(colonIndex + 1);
+                    if (value.startsWith(' '))
+                        value = value.slice(1);
+                    switch (field) {
+                        case 'event':
+                            eventType = value;
+                            break;
+                        case 'data':
+                            dataLines.push(value);
+                            sawData = true;
+                            break;
+                        case 'id':
+                            // Per spec, an id field containing a NUL character is ignored.
+                            if (!value.includes('\u0000'))
+                                id = value;
+                            break;
+                        case 'retry':
+                            // Unlike `data`/`id`, `retry` is not part of a dispatched event - it
+                            // just updates the reconnection delay for future reconnects.
+                            if (/^\d+$/.test(value))
+                                yield yield __await({ kind: 'retry', delayMs: parseInt(value, 10) });
+                            break;
+                    }
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = source_1.return)) yield __await(_b.call(source_1));
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    });
+}
+/**
+ * Live stream of wallet notifications over `GET /wallets/{wallet_id}/notifications`.
+ *
+ * Emits `open`, `notification`, `error` and `close` events, and is itself an
+ * async iterable of {@link WalletNotification}:
+ *
+ * ```ts
+ * const stream = new WalletNotificationStream(configuration, walletId);
+ * for await (const notification of stream) {
+ *     console.log(notification);
+ * }
+ * ```
+ *
+ * Drops are reconnected automatically (replaying queued notifications via
+ * `Last-Event-ID`) unless `options.reconnect` is set to `false`. The current
+ * `Last-Event-ID` is exposed via {@link WalletNotificationStream.lastEventId}
+ * so it can be persisted and used to resume the stream later, e.g. across
+ * process restarts.
+ */
+class WalletNotificationStream extends events_1.EventEmitter {
+    constructor(configuration, walletId, options = {}) {
+        var _a, _b, _c, _d, _e, _f;
+        super();
+        this.configuration = configuration;
+        this.walletId = walletId;
+        this.closed = false;
+        this.queue = [];
+        this.waiters = [];
+        this.axiosInstance = (_a = options.axios) !== null && _a !== void 0 ? _a : axios_1.default;
+        this.basePath = (_c = (_b = options.basePath) !== null && _b !== void 0 ? _b : configuration.basePath) !== null && _c !== void 0 ? _c : base_1.BASE_PATH;
+        this.eventType = options.eventType;
+        this.state = options.state;
+        this._lastEventId = options.lastEventId;
+        this.reconnect = (_d = options.reconnect) !== null && _d !== void 0 ? _d : true;
+        this.retryDelayMs = (_e = options.retryDelayMs) !== null && _e !== void 0 ? _e : 3000;
+        this.maxRetryDelayMs = (_f = options.maxRetryDelayMs) !== null && _f !== void 0 ? _f : 30000;
+        void this.connect();
+    }
+    /** Stops the stream and prevents further reconnection attempts. */
+    close() {
+        var _a;
+        if (this.closed)
+            return;
+        this.closed = true;
+        if (this.retryTimer)
+            clearTimeout(this.retryTimer);
+        (_a = this.abortController) === null || _a === void 0 ? void 0 : _a.abort();
+        this.settleWaiters();
+        this.emit('close');
+    }
+    get isClosed() {
+        return this.closed;
+    }
+    /**
+     * The ID of the last SSE event received on this stream (per the `id:` field),
+     * or the `lastEventId` the stream was constructed/reconnected with if no event
+     * has been received yet.
+     *
+     * Persist this value and pass it back as `options.lastEventId` when creating a
+     * new {@link WalletNotificationStream} (e.g. after a process restart) to resume
+     * the stream and replay any notifications queued since that event.
+     */
+    get lastEventId() {
+        return this._lastEventId;
+    }
+    connect() {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, e_2, _b, _c;
+            var _d;
+            if (this.closed)
+                return;
+            this.abortController = new AbortController();
+            try {
+                const requestArgs = yield (0, api_1.DefaultApiAxiosParamCreator)(this.configuration).walletNotifications(this.walletId, this.eventType, this.state, this._lastEventId, { signal: this.abortController.signal, responseType: 'stream' });
+                const request = (0, common_1.createRequestFunction)(requestArgs, this.axiosInstance, this.basePath, this.configuration);
+                const response = yield request(this.axiosInstance, this.basePath);
+                this.emit('open');
+                try {
+                    for (var _e = true, _f = __asyncValues(parseSseStream(response.data)), _g; _g = yield _f.next(), _a = _g.done, !_a; _e = true) {
+                        _c = _g.value;
+                        _e = false;
+                        const message = _c;
+                        if (this.closed)
+                            break;
+                        if (message.kind === 'retry') {
+                            this.nextRetryDelayMs = message.delayMs;
+                            continue;
+                        }
+                        if (message.id !== undefined)
+                            this._lastEventId = message.id;
+                        if (!message.data)
+                            continue;
+                        let notification;
+                        try {
+                            notification = JSON.parse(message.data);
+                        }
+                        catch (_h) {
+                            this.emit('error', new Error(`Failed to parse wallet notification payload: ${message.data}`));
+                            continue;
+                        }
+                        this.emit('notification', notification);
+                        this.dispatchToQueue(notification);
+                    }
+                }
+                catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                finally {
+                    try {
+                        if (!_e && !_a && (_b = _f.return)) yield _b.call(_f);
+                    }
+                    finally { if (e_2) throw e_2.error; }
+                }
+                if (this.closed)
+                    return;
+                this.scheduleReconnect();
+            }
+            catch (err) {
+                if (this.closed)
+                    return;
+                this.emit('error', err instanceof Error ? err : new Error(String(err)));
+                const status = (_d = err === null || err === void 0 ? void 0 : err.response) === null || _d === void 0 ? void 0 : _d.status;
+                if (status !== undefined && status >= 400 && status < 500) {
+                    // Client errors (bad wallet ID, invalid/expired token, ...) won't be fixed by retrying.
+                    this.close();
+                    return;
+                }
+                this.scheduleReconnect();
+            }
+        });
+    }
+    scheduleReconnect() {
+        var _a;
+        if (this.closed || !this.reconnect) {
+            this.close();
+            return;
+        }
+        const delay = Math.min((_a = this.nextRetryDelayMs) !== null && _a !== void 0 ? _a : this.retryDelayMs, this.maxRetryDelayMs);
+        this.retryTimer = setTimeout(() => void this.connect(), delay);
+    }
+    dispatchToQueue(notification) {
+        const waiter = this.waiters.shift();
+        if (waiter) {
+            waiter({ value: notification, done: false });
+        }
+        else {
+            this.queue.push(notification);
+        }
+    }
+    settleWaiters() {
+        while (this.waiters.length) {
+            this.waiters.shift()({ value: undefined, done: true });
+        }
+    }
+    [Symbol.asyncIterator]() {
+        return {
+            next: () => {
+                if (this.queue.length) {
+                    return Promise.resolve({ value: this.queue.shift(), done: false });
+                }
+                if (this.closed) {
+                    return Promise.resolve({ value: undefined, done: true });
+                }
+                return new Promise((resolve) => this.waiters.push(resolve));
+            },
+            return: () => {
+                this.close();
+                return Promise.resolve({ value: undefined, done: true });
+            },
+        };
+    }
+}
+exports.WalletNotificationStream = WalletNotificationStream;

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@triveria/wallet",
+  "private": false,
+  "version": "0.0.0-dev-c46c1cf",
+  "description": "",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/triveria-com/wallet-sdk-ts.git"
+  },
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc && cp package.json dist/",
+    "gen-docs": "typedoc --plugin typedoc-plugin-markdown --out ts-docs ./index.ts"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^1.6.5",
+    "jwt-decode": "^4.0.0",
+    "node-localstorage": "^3.0.5",
+    "ts-localstorage": "^3.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.6",
+    "@types/node-localstorage": "^1.3.3",
+    "typedoc": "^0.25.7",
+    "typedoc-plugin-markdown": "^3.17.1",
+    "typescript": "^5.3.3"
+  }
+}