@chainlink/external-adapter-framework 0.5.0 → 0.5.1

package/transports/routing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routing.js","sourceRoot":"","sources":["../../../src/transports/routing.ts"],"names":[],"mappings":";;;AAEA,kCAAoC;AAEpC,+CAAkD;AAGlD,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,kBAAkB,CAAC,CAAA;AAE7C;;;;GAIG;AACH,MAAa,gBAAgB;IAI3B;IACE,6GAA6G;IACtG,UAA2C;IAElD,+FAA+F;IACvF,KAGG;QANJ,eAAU,GAAV,UAAU,CAAiC;QAG1C,UAAK,GAAL,KAAK,CAGF;IACV,CAAC;IAEJ,KAAK,CAAC,UAAU,CACd,YAAiC,EACjC,aAAiD,EACjD,YAAoB;QAEpB,MAAM,CAAC,KAAK,CAAC,gBAAgB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,aAAa,CAAC,CAAA;QAC9E,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;YACjD,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,CAAA;YACnE,CAAC,CAAC,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,YAAY,CAAC,CAAA;QACzD,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,gBAAgB,CACtB,GAAiC,EACjC,aAAkD;QAElD,MAAM,CAAC,KAAK,CAAC,uBAAuB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QACjD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,aAAa,IAAI,SAAS,CAAC,CAAA;QACvD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACzB,MAAM,IAAI,oBAAY,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,0BAA0B,GAAG,EAAE,EAAE,CAAC,CAAA;SACtF;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QACtC,MAAM,CAAC,KAAK,CAAC,SAAS,SAAS,CAAC,WAAW,CAAC,IAAI,qBAAqB,GAAG,EAAE,CAAC,CAAA;QAC3E,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,oFAAoF;IACpF,wDAAwD;IACxD,KAAK,CAAC,iBAAiB,CACrB,GAAiC,EACjC,aAAiD;QAEjD,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,aAAa,CAAC,CAAA;QAC3D,IAAI,SAAS,CAAC,iBAAiB,EAAE;YAC/B,MAAM,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAA;YAChE,OAAO,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,aAAa,CAAC,CAAA;SACvD;QACD,MAAM,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAA;IACzE,CAAC;CACF;AAtDD,4CAsDC"}

package/transports/sse.d.ts

@@ -0,0 +1,61 @@
+import { AxiosRequestConfig } from 'axios';
+import EventSource from 'eventsource';
+import { AdapterContext, AdapterDependencies } from '../adapter';
+import { Cache } from '../cache';
+import { AdapterConfig } from '../config';
+import { SubscriptionSet } from '../util';
+import { AdapterRequest, AdapterResponse, ProviderResult } from '../util/request';
+import { Transport, TransportGenerics } from './';
+export interface SSEConfig {
+    url: string;
+    eventSourceInitDict?: EventSource.EventSourceInitDict;
+}
+/**
+ * Helper struct type that will be used to pass types to the generic parameters of a Transport.
+ * Extends the common TransportGenerics, adding Provider specific types for this Batch endpoint.
+ */
+declare type SSETransportGenerics = TransportGenerics & {
+    /**
+     * Type details for any provider specific interfaces.
+     */
+    Provider: {
+        /**
+         * Structure of the body of the request that will be sent to the data provider.
+         */
+        RequestBody: unknown;
+    };
+};
+/**
+ * Transport implementation that establishes a long lived connection to a server using the SSE protocol and subcribes to updates.
+ *
+ * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[SSETransportGenerics]])
+ */
+export declare class SSETransport<T extends SSETransportGenerics> implements Transport<T> {
+    private config;
+    EventSource: typeof EventSource;
+    cache: Cache<AdapterResponse<T['Response']>>;
+    eventListeners: {
+        type: string;
+        parseResponse: (evt: MessageEvent) => ProviderResult<T>;
+    }[];
+    sseConnection?: EventSource;
+    subscriptionSet: SubscriptionSet<T['Request']['Params']>;
+    timeOfLastReq: number;
+    localSubscriptions: T['Request']['Params'][];
+    constructor(config: {
+        prepareSSEConnectionConfig: (params: T['Request']['Params'][], context: AdapterContext<T>) => SSEConfig;
+        prepareKeepAliveRequest: (context: AdapterContext<T>) => AxiosRequestConfig<T['Provider']['RequestBody']>;
+        prepareSubscriptionRequest: (params: T['Request']['Params'][], context: AdapterContext<T>) => AxiosRequestConfig<T['Provider']['RequestBody']>;
+        prepareUnsubscriptionRequest: (params: T['Request']['Params'][], context: AdapterContext<T>) => AxiosRequestConfig<T['Provider']['RequestBody']>;
+        eventListeners: {
+            type: string;
+            parseResponse: (evt: MessageEvent) => ProviderResult<T>[];
+        }[];
+        keepaliveSleepMs?: number;
+        pollingSleepMs?: number;
+    });
+    initialize(dependencies: AdapterDependencies, config: AdapterConfig<T['CustomSettings']>, endpointName: string): Promise<void>;
+    registerRequest(req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>): Promise<void>;
+    backgroundExecute(context: AdapterContext<T>): Promise<number>;
+}
+export {};

package/transports/sse.js

@@ -0,0 +1,97 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SSETransport = void 0;
+const axios_1 = __importDefault(require("axios"));
+const eventsource_1 = __importDefault(require("eventsource"));
+const util_1 = require("../util");
+const _1 = require("./");
+const logger = (0, util_1.makeLogger)('SSETransport');
+/**
+ * Transport implementation that establishes a long lived connection to a server using the SSE protocol and subcribes to updates.
+ *
+ * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[SSETransportGenerics]])
+ */
+class SSETransport {
+    constructor(config) {
+        this.config = config;
+        this.EventSource = eventsource_1.default;
+        this.timeOfLastReq = 0;
+        // The double sets serve to create a simple polling mechanism instead of needing a subscription
+        // This one would not; this is always local state
+        this.localSubscriptions = [];
+    }
+    async initialize(dependencies, config, endpointName) {
+        this.cache = dependencies.cache;
+        this.subscriptionSet = dependencies.subscriptionSetFactory.buildSet(endpointName);
+        if (dependencies.eventSource) {
+            this.EventSource = dependencies.eventSource;
+        }
+    }
+    async registerRequest(req, config) {
+        logger.debug(`Adding entry to subscription set (ttl: ${config.SSE_SUBSCRIPTION_TTL}): [${req.requestContext.cacheKey}] = ${req.requestContext.data}`);
+        await this.subscriptionSet.add(req.requestContext.cacheKey, req.requestContext.data, config.SSE_SUBSCRIPTION_TTL);
+    }
+    // Unlike cache warming, this execute will manage subscriptions
+    async backgroundExecute(context) {
+        logger.debug('Starting background execute, getting subscriptions from sorted set');
+        const desiredSubs = await this.subscriptionSet.getAll();
+        logger.debug('Generating delta (subscribes & unsubscribes)');
+        const subscribeParams = desiredSubs.filter((s) => !this.localSubscriptions.includes(s));
+        const unsubscribeParams = this.localSubscriptions.filter((s) => !desiredSubs.includes(s));
+        logger.debug(`${subscribeParams.length} new subscriptions; ${unsubscribeParams.length} to unsubscribe`);
+        if (subscribeParams.length) {
+            logger.trace(`Will subscribe to: ${subscribeParams}`);
+        }
+        if (unsubscribeParams.length) {
+            logger.trace(`Will unsubscribe to: ${unsubscribeParams}`);
+        }
+        if ((subscribeParams.length || unsubscribeParams.length) &&
+            (!this.sseConnection || this.sseConnection.readyState !== this.sseConnection.OPEN)) {
+            logger.debug('No established connection and new subscriptions available, connecting to SSE');
+            const sseConfig = this.config.prepareSSEConnectionConfig(subscribeParams, context);
+            this.sseConnection = new this.EventSource(sseConfig.url, sseConfig.eventSourceInitDict);
+            const eventHandlerGenerator = (listener) => {
+                return (e) => {
+                    const providerResponses = listener.parseResponse(e);
+                    const cacheEntries = (0, _1.buildCacheEntriesFromResults)(providerResponses, context);
+                    this.cache.setMany(cacheEntries, context.adapterConfig.CACHE_MAX_AGE);
+                };
+            };
+            this.config.eventListeners.forEach((listener) => {
+                this.sseConnection?.addEventListener(listener.type, eventHandlerGenerator(listener));
+            });
+        }
+        const makeRequest = async (req) => {
+            try {
+                const res = await axios_1.default.request(req);
+                logger.debug(res.data, `response status ${res.statusText} from keepalive request`);
+            }
+            catch (err) {
+                logger.error(err, `Error on keepalive request`);
+            }
+            this.timeOfLastReq = Date.now();
+        };
+        if (subscribeParams.length) {
+            const subscribeRequest = this.config.prepareSubscriptionRequest(subscribeParams, context);
+            makeRequest(subscribeRequest);
+        }
+        if (unsubscribeParams.length) {
+            const unsubscribeRequest = this.config.prepareUnsubscriptionRequest(unsubscribeParams, context);
+            makeRequest(unsubscribeRequest);
+        }
+        if (desiredSubs.length &&
+            Date.now() - this.timeOfLastReq > context.adapterConfig.SSE_KEEPALIVE_SLEEP) {
+            const prepareKeepAliveRequest = this.config.prepareKeepAliveRequest(context);
+            makeRequest(prepareKeepAliveRequest);
+        }
+        logger.debug('Setting local state to cache value');
+        this.localSubscriptions = desiredSubs;
+        logger.debug('Background execute complete');
+        return context.adapterConfig.SSE_SUBSCRIPTION_UPDATE_SLEEP;
+    }
+}
+exports.SSETransport = SSETransport;
+//# sourceMappingURL=sse.js.map

package/transports/sse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sse.js","sourceRoot":"","sources":["../../../src/transports/sse.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAiD;AACjD,8DAAqC;AAIrC,kCAAqD;AAErD,yBAA+E;AAE/E,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,cAAc,CAAC,CAAA;AAuBzC;;;;GAIG;AACH,MAAa,YAAY;IAevB,YACU,MAsBP;QAtBO,WAAM,GAAN,MAAM,CAsBb;QArCH,gBAAW,GAAuB,qBAAW,CAAA;QAQ7C,kBAAa,GAAG,CAAC,CAAA;QAEjB,+FAA+F;QAC/F,iDAAiD;QACjD,uBAAkB,GAA6B,EAAE,CAAA;IA0B9C,CAAC;IAEJ,KAAK,CAAC,UAAU,CACd,YAAiC,EACjC,MAA0C,EAC1C,YAAoB;QAEpB,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAA8C,CAAA;QACxE,IAAI,CAAC,eAAe,GAAG,YAAY,CAAC,sBAAsB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;QACjF,IAAI,YAAY,CAAC,WAAW,EAAE;YAC5B,IAAI,CAAC,WAAW,GAAG,YAAY,CAAC,WAAW,CAAA;SAC5C;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,GAAiC,EACjC,MAA0C;QAE1C,MAAM,CAAC,KAAK,CACV,0CAA0C,MAAM,CAAC,oBAAoB,OAAO,GAAG,CAAC,cAAc,CAAC,QAAQ,OAAO,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CACxI,CAAA;QACD,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAC5B,GAAG,CAAC,cAAc,CAAC,QAAQ,EAC3B,GAAG,CAAC,cAAc,CAAC,IAAI,EACvB,MAAM,CAAC,oBAAoB,CAC5B,CAAA;IACH,CAAC;IAED,+DAA+D;IAC/D,KAAK,CAAC,iBAAiB,CAAC,OAA0B;QAChD,MAAM,CAAC,KAAK,CAAC,oEAAoE,CAAC,CAAA;QAClF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAA;QAEvD,MAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAA;QAC5D,MAAM,eAAe,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QACvF,MAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QAEzF,MAAM,CAAC,KAAK,CACV,GAAG,eAAe,CAAC,MAAM,uBAAuB,iBAAiB,CAAC,MAAM,iBAAiB,CAC1F,CAAA;QACD,IAAI,eAAe,CAAC,MAAM,EAAE;YAC1B,MAAM,CAAC,KAAK,CAAC,sBAAsB,eAAe,EAAE,CAAC,CAAA;SACtD;QACD,IAAI,iBAAiB,CAAC,MAAM,EAAE;YAC5B,MAAM,CAAC,KAAK,CAAC,wBAAwB,iBAAiB,EAAE,CAAC,CAAA;SAC1D;QAED,IACE,CAAC,eAAe,CAAC,MAAM,IAAI,iBAAiB,CAAC,MAAM,CAAC;YACpD,CAAC,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,UAAU,KAAK,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAClF;YACA,MAAM,CAAC,KAAK,CAAC,8EAA8E,CAAC,CAAA;YAC5F,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,0BAA0B,CAAC,eAAe,EAAE,OAAO,CAAC,CAAA;YAClF,IAAI,CAAC,aAAa,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,CAAC,mBAAmB,CAAC,CAAA;YAEvF,MAAM,qBAAqB,GAAG,CAAC,QAA8C,EAAE,EAAE;gBAC/E,OAAO,CAAC,CAAe,EAAE,EAAE;oBACzB,MAAM,iBAAiB,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;oBACnD,MAAM,YAAY,GAAG,IAAA,+BAA4B,EAAC,iBAAiB,EAAE,OAAO,CAAC,CAAA;oBAC7E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAA;gBACvE,CAAC,CAAA;YACH,CAAC,CAAA;YAED,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;gBAC9C,IAAI,CAAC,aAAa,EAAE,gBAAgB,CAAC,QAAQ,CAAC,IAAI,EAAE,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAA;YACtF,CAAC,CAAC,CAAA;SACH;QAED,MAAM,WAAW,GAAG,KAAK,EAAE,GAAqD,EAAE,EAAE;YAClF,IAAI;gBACF,MAAM,GAAG,GAAG,MAAM,eAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;gBACpC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,mBAAmB,GAAG,CAAC,UAAU,yBAAyB,CAAC,CAAA;aACnF;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,4BAA4B,CAAC,CAAA;aAChD;YACD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACjC,CAAC,CAAA;QAED,IAAI,eAAe,CAAC,MAAM,EAAE;YAC1B,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC,0BAA0B,CAAC,eAAe,EAAE,OAAO,CAAC,CAAA;YACzF,WAAW,CAAC,gBAAgB,CAAC,CAAA;SAC9B;QACD,IAAI,iBAAiB,CAAC,MAAM,EAAE;YAC5B,MAAM,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,4BAA4B,CACjE,iBAAiB,EACjB,OAAO,CACR,CAAA;YACD,WAAW,CAAC,kBAAkB,CAAC,CAAA;SAChC;QACD,IACE,WAAW,CAAC,MAAM;YAClB,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,mBAAmB,EAC3E;YACA,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAA;YAC5E,WAAW,CAAC,uBAAuB,CAAC,CAAA;SACrC;QAED,MAAM,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAA;QAClD,IAAI,CAAC,kBAAkB,GAAG,WAAW,CAAA;QAErC,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAA;QAC3C,OAAO,OAAO,CAAC,aAAa,CAAC,6BAA6B,CAAA;IAC5D,CAAC;CACF;AA9ID,oCA8IC"}

package/transports/util.d.ts

@@ -0,0 +1,9 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AdapterConfig, SettingsMap } from '../config';
+/**
+ * Performs axios request along with metrics recording and error handling
+ *
+ * @param request - axios request config
+ * @returns axios response for the request
+ */
+export declare function axiosRequest<ProviderRequestBody, ProviderResponseBody, CustomSettings extends SettingsMap>(request: AxiosRequestConfig<ProviderRequestBody>, config: AdapterConfig<CustomSettings>): Promise<AxiosResponse<ProviderResponseBody>>;

package/transports/util.js

@@ -0,0 +1,87 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.axiosRequest = void 0;
+const axios_1 = __importDefault(require("axios"));
+const error_1 = require("../validation/error");
+const transportMetrics = __importStar(require("./metrics"));
+/**
+ * Performs axios request along with metrics recording and error handling
+ *
+ * @param request - axios request config
+ * @returns axios response for the request
+ */
+async function axiosRequest(request, config) {
+    const responseTimer = transportMetrics.dataProviderRequestDurationSeconds.startTimer();
+    let providerResponse;
+    try {
+        request.timeout = config.API_TIMEOUT;
+        providerResponse = await axios_1.default.request(request);
+    }
+    catch (e) {
+        const error = e;
+        // Request error
+        let providerStatusCode;
+        let adapterError;
+        if (error.code === 'ECONNABORTED') {
+            adapterError = new error_1.AdapterTimeoutError({});
+            providerStatusCode = error?.response?.status ?? 504;
+            adapterError.name = 'Data Provider Request Timeout error';
+        }
+        else if (error?.response?.status) {
+            adapterError = new error_1.AdapterDataProviderError({});
+            providerStatusCode = error?.response?.status;
+        }
+        else {
+            adapterError = new error_1.AdapterConnectionError({});
+            providerStatusCode = 0; // 0 -> connection error
+        }
+        // Record count of failed data provider request
+        transportMetrics.dataProviderRequests
+            .labels(transportMetrics.dataProviderMetricsLabel(providerStatusCode, request.method))
+            .inc();
+        adapterError.statusCode = 200;
+        adapterError.providerStatusCode = providerStatusCode;
+        adapterError.message = error?.message;
+        adapterError.cause = error;
+        adapterError.errorResponse = error?.response?.data;
+        adapterError.url = request.url;
+        throw adapterError;
+    }
+    finally {
+        // Record time taken for data provider request for success or failure
+        responseTimer();
+    }
+    // Record count of successful data provider requests
+    transportMetrics.dataProviderRequests
+        .labels(transportMetrics.dataProviderMetricsLabel(providerResponse.status, request.method))
+        .inc();
+    return providerResponse;
+}
+exports.axiosRequest = axiosRequest;
+//# sourceMappingURL=util.js.map

package/transports/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/transports/util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA4E;AAE5E,+CAK4B;AAC5B,4DAA6C;AAE7C;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAKhC,OAAgD,EAChD,MAAqC;IAErC,MAAM,aAAa,GAAG,gBAAgB,CAAC,kCAAkC,CAAC,UAAU,EAAE,CAAA;IACtF,IAAI,gBAAqD,CAAA;IACzD,IAAI;QACF,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC,WAAW,CAAA;QACpC,gBAAgB,GAAG,MAAM,eAAK,CAAC,OAAO,CAAuB,OAAO,CAAC,CAAA;KACtE;IAAC,OAAO,CAAU,EAAE;QACnB,MAAM,KAAK,GAAG,CAAe,CAAA;QAC7B,gBAAgB;QAChB,IAAI,kBAAsC,CAAA;QAC1C,IAAI,YAA0B,CAAA;QAC9B,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE;YACjC,YAAY,GAAG,IAAI,2BAAmB,CAAC,EAAE,CAAC,CAAA;YAC1C,kBAAkB,GAAG,KAAK,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,CAAA;YACnD,YAAY,CAAC,IAAI,GAAG,qCAAqC,CAAA;SAC1D;aAAM,IAAI,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE;YAClC,YAAY,GAAG,IAAI,gCAAwB,CAAC,EAAE,CAAC,CAAA;YAC/C,kBAAkB,GAAG,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAA;SAC7C;aAAM;YACL,YAAY,GAAG,IAAI,8BAAsB,CAAC,EAAE,CAAC,CAAA;YAC7C,kBAAkB,GAAG,CAAC,CAAA,CAAC,wBAAwB;SAChD;QACD,+CAA+C;QAC/C,gBAAgB,CAAC,oBAAoB;aAClC,MAAM,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,kBAAkB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;aACrF,GAAG,EAAE,CAAA;QAER,YAAY,CAAC,UAAU,GAAG,GAAG,CAAA;QAC7B,YAAY,CAAC,kBAAkB,GAAG,kBAAkB,CAAA;QACpD,YAAY,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,CAAA;QACrC,YAAY,CAAC,KAAK,GAAG,KAAK,CAAA;QAC1B,YAAY,CAAC,aAAa,GAAG,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAA;QAClD,YAAY,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QAE9B,MAAM,YAAY,CAAA;KACnB;YAAS;QACR,qEAAqE;QACrE,aAAa,EAAE,CAAA;KAChB;IAED,oDAAoD;IACpD,gBAAgB,CAAC,oBAAoB;SAClC,MAAM,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;SAC1F,GAAG,EAAE,CAAA;IAER,OAAO,gBAAgB,CAAA;AACzB,CAAC;AArDD,oCAqDC"}

package/transports/websocket.d.ts

@@ -0,0 +1,95 @@
+import WebSocket, { ClientOptions, RawData } from 'ws';
+import { AdapterContext, AdapterDependencies } from '../adapter';
+import { Cache } from '../cache';
+import { AdapterConfig } from '../config';
+import { BackgroundExecuteRateLimiter } from '../rate-limiting';
+import { SubscriptionSet } from '../util';
+import { AdapterRequest, AdapterResponse, ProviderResult } from '../util/request';
+import { Transport, TransportGenerics } from './';
+export { WebSocket, RawData as WebSocketRawData };
+declare type WebSocketClass = new (url: string, protocols?: string | string[] | undefined, options?: ClientOptions) => WebSocket;
+export declare class WebSocketClassProvider {
+    static ctor: WebSocketClass;
+    static set(ctor: WebSocketClass): void;
+    static get(): WebSocketClass;
+}
+/**
+ * Config object that is provided to the WebSocketTransport constructor.
+ */
+export interface WebSocketTransportConfig<T extends WebsocketTransportGenerics> {
+    /** Endpoint to which to open the WS connection*/
+    url: (context: AdapterContext<T>) => string;
+    /** Optional parameters used when establishing the WebSocket connection */
+    options?: (context: AdapterContext<T>) => ClientOptions;
+    /** Map of handlers for different WS lifecycle events */
+    handlers: {
+        /**
+         * Handles when the WS is successfully opened
+         *
+         * @param wsConnection - the WebSocket with an established connection
+         * @returns an empty Promise, or void
+         */
+        open: (wsConnection: WebSocket, context: AdapterContext<T>) => Promise<void> | void;
+        /**
+         * Handles when the WS receives a message
+         *
+         * @param message - the message received by the WS
+         * @param context - the background context for the Adapter
+         * @returns a list of cache entries of adapter responses to set in the cache
+         */
+        message: (message: T['Provider']['WsMessage'], context: AdapterContext<T>) => ProviderResult<T>[] | undefined;
+    };
+    /** Map of "builders", functions that will be used to prepare specific WS messages */
+    builders: {
+        /**
+         * Builds a WS message that will be sent to subscribe to a specific feed
+         *
+         * @param params - the body of the adapter request
+         * @returns the WS message (can be any type as long as the [[WebSocket]] doesn't complain)
+         */
+        subscribeMessage: (params: T['Request']['Params']) => unknown;
+        /**
+         * Builds a WS message that will be sent to unsubscribe to a specific feed
+         *
+         * @param params - the body of the adapter request
+         * @returns the WS message (can be any type as long as the [[WebSocket]] doesn't complain)
+         */
+        unsubscribeMessage: (params: T['Request']['Params']) => unknown;
+    };
+}
+/**
+ * Helper struct type that will be used to pass types to the generic parameters of a Transport.
+ * Extends the common TransportGenerics, adding Provider specific types for this Batch endpoint.
+ */
+declare type WebsocketTransportGenerics = TransportGenerics & {
+    /**
+     * Type details for any provider specific interfaces.
+     */
+    Provider: {
+        /**
+         * Structure of any message that will come through the websocket connection.
+         */
+        WsMessage: unknown;
+    };
+};
+/**
+ * Transport implementation that takes incoming requests, adds them to an [[subscriptionSet]] and,
+ * through a WebSocket connection, subscribes to the relevant feeds to populate the cache.
+ *
+ * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[WebsocketTransportGenerics]])
+ */
+export declare class WebSocketTransport<T extends WebsocketTransportGenerics> implements Transport<T> {
+    private config;
+    cache: Cache<AdapterResponse<T['Response']>>;
+    rateLimiter: BackgroundExecuteRateLimiter;
+    subscriptionSet: SubscriptionSet<T['Request']['Params']>;
+    localSubscriptions: T['Request']['Params'][];
+    wsConnection: WebSocket;
+    constructor(config: WebSocketTransportConfig<T>);
+    initialize(dependencies: AdapterDependencies, config: AdapterConfig<T['CustomSettings']>, endpointName: string): Promise<void>;
+    registerRequest(req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>): Promise<void>;
+    serializeMessage(payload: unknown): string;
+    deserializeMessage(data: WebSocket.Data): T['Provider']['WsMessage'];
+    establishWsConnection(context: AdapterContext<T>): Promise<unknown>;
+    backgroundExecute(context: AdapterContext<T>): Promise<number>;
+}

package/transports/websocket.js

@@ -0,0 +1,164 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocketTransport = exports.WebSocketClassProvider = exports.WebSocket = void 0;
+const ws_1 = __importDefault(require("ws"));
+exports.WebSocket = ws_1.default;
+const util_1 = require("../util");
+const _1 = require("./");
+const transportMetrics = __importStar(require("./metrics"));
+const logger = (0, util_1.makeLogger)('WebSocketTransport');
+class WebSocketClassProvider {
+    static set(ctor) {
+        this.ctor = ctor;
+    }
+    static get() {
+        return this.ctor;
+    }
+}
+exports.WebSocketClassProvider = WebSocketClassProvider;
+WebSocketClassProvider.ctor = ws_1.default;
+/**
+ * Transport implementation that takes incoming requests, adds them to an [[subscriptionSet]] and,
+ * through a WebSocket connection, subscribes to the relevant feeds to populate the cache.
+ *
+ * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[WebsocketTransportGenerics]])
+ */
+class WebSocketTransport {
+    constructor(config) {
+        this.config = config;
+        // The double sets serve to create a simple polling mechanism instead of needing a subscription
+        // This one would not; this is always local state
+        this.localSubscriptions = [];
+    }
+    async initialize(dependencies, config, endpointName) {
+        this.cache = dependencies.cache;
+        this.rateLimiter = dependencies.backgroundExecuteRateLimiter;
+        this.subscriptionSet = dependencies.subscriptionSetFactory.buildSet(endpointName);
+    }
+    async registerRequest(req, config) {
+        logger.debug(`Adding entry to subscription set (ttl: ${config.WS_SUBSCRIPTION_TTL}): [${req.requestContext.cacheKey}] = ${req.requestContext.data}`);
+        await this.subscriptionSet.add(req.requestContext.cacheKey, req.requestContext.data, config.WS_SUBSCRIPTION_TTL);
+    }
+    serializeMessage(payload) {
+        return typeof payload === 'string' ? payload : JSON.stringify(payload);
+    }
+    deserializeMessage(data) {
+        return JSON.parse(data.toString());
+    }
+    establishWsConnection(context) {
+        return new Promise((resolve) => {
+            const ctor = WebSocketClassProvider.get();
+            const url = context.adapterConfig.WS_API_ENDPOINT || this.config.url(context);
+            const options = this.config.options && this.config.options(context);
+            this.wsConnection = new ctor(url, undefined, options);
+            this.wsConnection.addEventListener('open', async (event) => {
+                logger.debug(`Opened websocket connection. (event type ${event.type})`);
+                await this.config.handlers.open(this.wsConnection, context);
+                logger.debug('Successfully executed connection opened handler');
+                // Record active ws connections by incrementing count on open
+                transportMetrics.wsConnectionActive.inc();
+                resolve(true);
+            });
+            this.wsConnection.addEventListener('message', async (event) => {
+                const parsed = this.deserializeMessage(event.data);
+                logger.trace(`Got ws message: ${parsed}`);
+                const results = this.config.handlers.message(parsed, context);
+                if (Array.isArray(results)) {
+                    const responses = (0, _1.buildCacheEntriesFromResults)(results, context);
+                    logger.trace(`Writing ${responses.length} responses to cache`);
+                    await this.cache.setMany(responses, context.adapterConfig.CACHE_MAX_AGE);
+                }
+            });
+            this.wsConnection.addEventListener('error', async (event) => {
+                logger.debug(`Error occurred in web socket connection. Error: ${event.error} ; Message: ${event.message}`);
+                // Record connection error count
+                transportMetrics.wsConnectionErrors
+                    .labels(transportMetrics.connectionErrorLabels(event.message))
+                    .inc();
+            });
+            this.wsConnection.addEventListener('close', (event) => {
+                logger.debug(`Closed websocket connection. Code: ${event.code} ; reason: ${event.reason?.toString()}`);
+                // Record active ws connections by decrementing count on close
+                // Using URL in label since connection_key is removed from v3
+                transportMetrics.wsConnectionActive.dec();
+            });
+        });
+    }
+    // Unlike cache warming, this execute will manage subscriptions
+    async backgroundExecute(context) {
+        logger.debug('Starting background execute, getting subscriptions from sorted set');
+        const desiredSubs = await this.subscriptionSet.getAll();
+        // Keep track of active subscriptions for background execute
+        transportMetrics.bgExecuteSubscriptionSetCount
+            .labels({ endpoint: context.adapterEndpoint.name, transport_type: 'websocket' })
+            .set(desiredSubs.length);
+        logger.debug('Generating delta (subscribes & unsubscribes)');
+        const subscribeParams = desiredSubs.filter((s) => !this.localSubscriptions.map((ls) => JSON.stringify(ls)).includes(JSON.stringify(s)));
+        const subscribes = subscribeParams
+            .map(this.config.builders.subscribeMessage)
+            .map(this.serializeMessage);
+        const unsubscribeParams = this.localSubscriptions.filter((s) => !desiredSubs.map((ds) => JSON.stringify(ds)).includes(JSON.stringify(s)));
+        const unsubscribes = unsubscribeParams
+            .map(this.config.builders.unsubscribeMessage)
+            .map(this.serializeMessage);
+        logger.debug(`${subscribes.length} new subscriptions; ${unsubscribes.length} to unsubscribe`);
+        if (subscribes.length) {
+            logger.trace(`Will subscribe to: ${subscribes}`);
+        }
+        if (unsubscribes.length) {
+            logger.trace(`Will unsubscribe to: ${unsubscribes}`);
+        }
+        // New subs && no connection -> connect -> add subs
+        // No new subs && no connection -> skip
+        // New subs && connection -> add subs
+        // No new subs && connection -> unsubs only
+        if (!subscribes.length && !this.wsConnection) {
+            logger.debug('No entries in subscription set and no established connection, skipping');
+            return this.rateLimiter.msUntilNextExecution(context.adapterEndpoint.name);
+        }
+        if (!this.wsConnection && subscribes.length) {
+            logger.debug('No established connection and new subscriptions available, connecting to WS');
+            await this.establishWsConnection(context);
+        }
+        logger.debug('Sending subs/unsubs if there are any');
+        const messages = unsubscribes.concat(subscribes);
+        for (const message of messages) {
+            logger.trace(`Sending message: ${JSON.stringify(message)}`);
+            this.wsConnection.send(message);
+        }
+        // Record WS message and subscription metrics
+        transportMetrics.recordWsMessageMetrics(context, subscribeParams, unsubscribeParams);
+        logger.debug('Setting local state to cache value');
+        this.localSubscriptions = desiredSubs;
+        logger.debug('Background execute complete');
+        return this.rateLimiter.msUntilNextExecution(context.adapterEndpoint.name);
+    }
+}
+exports.WebSocketTransport = WebSocketTransport;
+//# sourceMappingURL=websocket.js.map

package/transports/websocket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.js","sourceRoot":"","sources":["../../../src/transports/websocket.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAsD;AAW7C,oBAXF,YAAS,CAWE;AANlB,kCAAqD;AAErD,yBAA+E;AAC/E,4DAA6C;AAK7C,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,oBAAoB,CAAC,CAAA;AAQ/C,MAAa,sBAAsB;IAGjC,MAAM,CAAC,GAAG,CAAC,IAAoB;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED,MAAM,CAAC,GAAG;QACR,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;;AATH,wDAUC;AATQ,2BAAI,GAAmB,YAAS,CAAA;AAgFzC;;;;;GAKG;AACH,MAAa,kBAAkB;IAW7B,YAAoB,MAAmC;QAAnC,WAAM,GAAN,MAAM,CAA6B;QANvD,+FAA+F;QAC/F,iDAAiD;QACjD,uBAAkB,GAA6B,EAAE,CAAA;IAIS,CAAC;IAE3D,KAAK,CAAC,UAAU,CACd,YAAiC,EACjC,MAA0C,EAC1C,YAAoB;QAEpB,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAA8C,CAAA;QACxE,IAAI,CAAC,WAAW,GAAG,YAAY,CAAC,4BAA4B,CAAA;QAC5D,IAAI,CAAC,eAAe,GAAG,YAAY,CAAC,sBAAsB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;IACnF,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,GAAiC,EACjC,MAA0C;QAE1C,MAAM,CAAC,KAAK,CACV,0CAA0C,MAAM,CAAC,mBAAmB,OAAO,GAAG,CAAC,cAAc,CAAC,QAAQ,OAAO,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CACvI,CAAA;QACD,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAC5B,GAAG,CAAC,cAAc,CAAC,QAAQ,EAC3B,GAAG,CAAC,cAAc,CAAC,IAAI,EACvB,MAAM,CAAC,mBAAmB,CAC3B,CAAA;IACH,CAAC;IAED,gBAAgB,CAAC,OAAgB;QAC/B,OAAO,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;IACxE,CAAC;IACD,kBAAkB,CAAC,IAAoB;QACrC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAA+B,CAAA;IAClE,CAAC;IAED,qBAAqB,CAAC,OAA0B;QAC9C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,MAAM,IAAI,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAA;YACzC,MAAM,GAAG,GAAG,OAAO,CAAC,aAAa,CAAC,eAAe,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;YAC7E,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;YACnE,IAAI,CAAC,YAAY,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;YACrD,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,MAAM,EAAE,KAAK,EAAE,KAAsB,EAAE,EAAE;gBAC1E,MAAM,CAAC,KAAK,CAAC,4CAA4C,KAAK,CAAC,IAAI,GAAG,CAAC,CAAA;gBACvE,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;gBAC3D,MAAM,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAA;gBAC/D,6DAA6D;gBAC7D,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAA;gBACzC,OAAO,CAAC,IAAI,CAAC,CAAA;YACf,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,SAAS,EAAE,KAAK,EAAE,KAA6B,EAAE,EAAE;gBACpF,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;gBAClD,MAAM,CAAC,KAAK,CAAC,mBAAmB,MAAM,EAAE,CAAC,CAAA;gBACzC,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;gBAC7D,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;oBAC1B,MAAM,SAAS,GAAG,IAAA,+BAA4B,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;oBAChE,MAAM,CAAC,KAAK,CAAC,WAAW,SAAS,CAAC,MAAM,qBAAqB,CAAC,CAAA;oBAC9D,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAA;iBACzE;YACH,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,KAA2B,EAAE,EAAE;gBAChF,MAAM,CAAC,KAAK,CACV,mDAAmD,KAAK,CAAC,KAAK,eAAe,KAAK,CAAC,OAAO,EAAE,CAC7F,CAAA;gBACD,gCAAgC;gBAChC,gBAAgB,CAAC,kBAAkB;qBAChC,MAAM,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;qBAC7D,GAAG,EAAE,CAAA;YACV,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAA2B,EAAE,EAAE;gBAC1E,MAAM,CAAC,KAAK,CACV,sCAAsC,KAAK,CAAC,IAAI,cAAc,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CACzF,CAAA;gBACD,8DAA8D;gBAC9D,6DAA6D;gBAC7D,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAA;YAC3C,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,+DAA+D;IAC/D,KAAK,CAAC,iBAAiB,CAAC,OAA0B;QAChD,MAAM,CAAC,KAAK,CAAC,oEAAoE,CAAC,CAAA;QAClF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAA;QAEvD,4DAA4D;QAC5D,gBAAgB,CAAC,6BAA6B;aAC3C,MAAM,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC;aAC/E,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QAE1B,MAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAA;QAC5D,MAAM,eAAe,GAAG,WAAW,CAAC,MAAM,CACxC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAC5F,CAAA;QACD,MAAM,UAAU,GAAG,eAAe;aAC/B,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC;aAC1C,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAE7B,MAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CACtD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAChF,CAAA;QACD,MAAM,YAAY,GAAG,iBAAiB;aACnC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC;aAC5C,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAE7B,MAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,MAAM,uBAAuB,YAAY,CAAC,MAAM,iBAAiB,CAAC,CAAA;QAC7F,IAAI,UAAU,CAAC,MAAM,EAAE;YACrB,MAAM,CAAC,KAAK,CAAC,sBAAsB,UAAU,EAAE,CAAC,CAAA;SACjD;QACD,IAAI,YAAY,CAAC,MAAM,EAAE;YACvB,MAAM,CAAC,KAAK,CAAC,wBAAwB,YAAY,EAAE,CAAC,CAAA;SACrD;QAED,mDAAmD;QACnD,uCAAuC;QACvC,qCAAqC;QACrC,2CAA2C;QAE3C,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YAC5C,MAAM,CAAC,KAAK,CAAC,wEAAwE,CAAC,CAAA;YACtF,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;SAC3E;QAED,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,UAAU,CAAC,MAAM,EAAE;YAC3C,MAAM,CAAC,KAAK,CAAC,6EAA6E,CAAC,CAAA;YAC3F,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAA;SAC1C;QAED,MAAM,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAA;QACpD,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QAChD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC9B,MAAM,CAAC,KAAK,CAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YAC3D,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;SAChC;QAED,6CAA6C;QAC7C,gBAAgB,CAAC,sBAAsB,CAAC,OAAO,EAAE,eAAe,EAAE,iBAAiB,CAAC,CAAA;QAEpF,MAAM,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAA;QAClD,IAAI,CAAC,kBAAkB,GAAG,WAAW,CAAA;QAErC,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAA;QAC3C,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;IAC5E,CAAC;CACF;AAxJD,gDAwJC"}

package/util/censor/censor-list.d.ts

@@ -0,0 +1,9 @@
+export default class CensorList {
+    static censorList: CensorKeyValue[];
+    static getAll(): CensorKeyValue[];
+    static set(censorList: CensorKeyValue[]): void;
+}
+export interface CensorKeyValue {
+    key: string;
+    value: RegExp;
+}

package/util/censor/censor-list.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class CensorList {
+    static getAll() {
+        return this.censorList;
+    }
+    static set(censorList) {
+        this.censorList = censorList;
+    }
+}
+exports.default = CensorList;
+CensorList.censorList = [];
+//# sourceMappingURL=censor-list.js.map

package/util/censor/censor-list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"censor-list.js","sourceRoot":"","sources":["../../../../src/util/censor/censor-list.ts"],"names":[],"mappings":";;AAAA,MAAqB,UAAU;IAE7B,MAAM,CAAC,MAAM;QACX,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IACD,MAAM,CAAC,GAAG,CAAC,UAA4B;QACrC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;;AAPH,6BAQC;AAPQ,qBAAU,GAAqB,EAAE,CAAA"}

package/util/index.d.ts

@@ -0,0 +1,13 @@
+export * from './request';
+export * from './logger';
+export * from './subscription-set/subscription-set';
+/**
+ * Sleeps for the provided number of milliseconds
+ * @param ms - The number of milliseconds to sleep for
+ * @returns a Promise that resolves once the specified time passes
+ */
+export declare const sleep: (ms: number) => Promise<void>;
+export declare const isObject: (o: unknown) => boolean;
+export declare const isArray: (o: unknown) => boolean;
+export declare const isEmpty: (o: unknown) => boolean;
+export declare type PromiseOrValue<T> = Promise<T> | T;

package/util/index.js

@@ -0,0 +1,38 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEmpty = exports.isArray = exports.isObject = exports.sleep = void 0;
+__exportStar(require("./request"), exports);
+__exportStar(require("./logger"), exports);
+__exportStar(require("./subscription-set/subscription-set"), exports);
+/**
+ * Sleeps for the provided number of milliseconds
+ * @param ms - The number of milliseconds to sleep for
+ * @returns a Promise that resolves once the specified time passes
+ */
+const sleep = (ms) => {
+    return new Promise((resolve) => {
+        setTimeout(resolve, ms);
+    });
+};
+exports.sleep = sleep;
+const isObject = (o) => o !== null && typeof o === 'object' && Array.isArray(o) === false;
+exports.isObject = isObject;
+const isArray = (o) => o !== null && typeof o === 'object' && Array.isArray(o);
+exports.isArray = isArray;
+const isEmpty = (o) => o === undefined || o === null || o === '';
+exports.isEmpty = isEmpty;
+//# sourceMappingURL=index.js.map

package/util/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/util/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,2CAAwB;AACxB,sEAAmD;AAEnD;;;;GAIG;AACI,MAAM,KAAK,GAAG,CAAC,EAAU,EAAiB,EAAE;IACjD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IACzB,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAJY,QAAA,KAAK,SAIjB;AAEM,MAAM,QAAQ,GAAG,CAAC,CAAU,EAAW,EAAE,CAC9C,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,KAAK,CAAA;AADtD,QAAA,QAAQ,YAC8C;AAE5D,MAAM,OAAO,GAAG,CAAC,CAAU,EAAW,EAAE,CAC7C,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;AAD5C,QAAA,OAAO,WACqC;AAElD,MAAM,OAAO,GAAG,CAAC,CAAU,EAAW,EAAE,CAAC,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE,CAAA;AAA5E,QAAA,OAAO,WAAqE"}