@chainlink/external-adapter-framework 0.3.9 → 0.4.0

package/metrics/constants.d.ts

@@ -1,16 +0,0 @@
-export declare enum HttpRequestType {
-    CACHE_HIT = "cacheHit",
-    DATA_PROVIDER_HIT = "dataProviderHit",
-    ADAPTER_ERROR = "adapterError",
-    INPUT_ERROR = "inputError",
-    RATE_LIMIT_ERROR = "rateLimitError",
-    DP_ERROR = "dataProviderError",
-    TIMEOUT_ERROR = "timeoutError",
-    CONNECTION_ERROR = "connectionError",
-    CUSTOM_ERROR = "customError"
-}
-/**
- * Maxiumum number of characters that a feedId can contain.
- */
-export declare const MAX_FEED_ID_LENGTH = 300;
-export declare const requestDurationBuckets: number[];

package/metrics/constants.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.requestDurationBuckets = exports.MAX_FEED_ID_LENGTH = exports.HttpRequestType = void 0;
-var HttpRequestType;
-(function (HttpRequestType) {
-    HttpRequestType["CACHE_HIT"] = "cacheHit";
-    HttpRequestType["DATA_PROVIDER_HIT"] = "dataProviderHit";
-    HttpRequestType["ADAPTER_ERROR"] = "adapterError";
-    HttpRequestType["INPUT_ERROR"] = "inputError";
-    HttpRequestType["RATE_LIMIT_ERROR"] = "rateLimitError";
-    // BURST_LIMIT_ERROR = 'burstLimitError',
-    // BACKOFF_ERROR = 'backoffError',
-    HttpRequestType["DP_ERROR"] = "dataProviderError";
-    HttpRequestType["TIMEOUT_ERROR"] = "timeoutError";
-    HttpRequestType["CONNECTION_ERROR"] = "connectionError";
-    // RES_EMPTY_ERROR = 'responseEmptyError',
-    // RES_INVALID_ERROR = 'responseInvalidError',
-    HttpRequestType["CUSTOM_ERROR"] = "customError";
-})(HttpRequestType = exports.HttpRequestType || (exports.HttpRequestType = {}));
-/**
- * Maxiumum number of characters that a feedId can contain.
- */
-exports.MAX_FEED_ID_LENGTH = 300;
-// We should tune these as we collect data, this is the default bucket distribution that prom comes with
-exports.requestDurationBuckets = [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10];
-//# sourceMappingURL=constants.js.map

package/metrics/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/metrics/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,eAcX;AAdD,WAAY,eAAe;IACzB,yCAAsB,CAAA;IACtB,wDAAqC,CAAA;IACrC,iDAA8B,CAAA;IAC9B,6CAA0B,CAAA;IAC1B,sDAAmC,CAAA;IACnC,yCAAyC;IACzC,kCAAkC;IAClC,iDAA8B,CAAA;IAC9B,iDAA8B,CAAA;IAC9B,uDAAoC,CAAA;IACpC,0CAA0C;IAC1C,8CAA8C;IAC9C,+CAA4B,CAAA;AAC9B,CAAC,EAdW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAc1B;AAED;;GAEG;AACU,QAAA,kBAAkB,GAAG,GAAG,CAAA;AAErC,wGAAwG;AAC3F,QAAA,sBAAsB,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA"}

package/metrics/index.d.ts

@@ -1,19 +0,0 @@
-import * as client from 'prom-client';
-import { AdapterRequest } from '../util';
-import { AdapterConfig } from '../config';
-import { FastifyReply, HookHandlerDoneFunction } from 'fastify';
-import { AdapterError } from '../validation/error';
-export declare function setupMetricsServer(name: string, config: AdapterConfig): void;
-export declare const setupMetrics: (name: string, config: AdapterConfig) => void;
-/**
- * Builds metrics middleware that records end to end EA response times
- * and count of requests
- *
- * @returns the cache middleware function
- */
-export declare const buildMetricsMiddleware: (req: AdapterRequest, res: FastifyReply, done: HookHandlerDoneFunction) => void;
-export declare const buildHttpRequestMetricsLabel: (feedId: string, error?: AdapterError | Error, cacheHit?: boolean) => Partial<Record<"type" | "method" | "feed_id" | "status_code" | "provider_status_code" | "retry" | "is_cache_warming", string | number>>;
-export declare const httpRequestsTotal: client.Counter<"type" | "method" | "feed_id" | "status_code" | "provider_status_code" | "retry" | "is_cache_warming">;
-export declare const httpRequestDurationSeconds: client.Histogram<string>;
-export declare const bgExecuteTotal: client.Counter<"endpoint">;
-export declare const bgExecuteDurationSeconds: client.Gauge<"endpoint">;

package/metrics/index.js

@@ -1,139 +0,0 @@
-"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.bgExecuteDurationSeconds = exports.bgExecuteTotal = exports.httpRequestDurationSeconds = exports.httpRequestsTotal = exports.buildHttpRequestMetricsLabel = exports.buildMetricsMiddleware = exports.setupMetrics = exports.setupMetricsServer = void 0;
-const client = __importStar(require("prom-client"));
-const constants_1 = require("./constants");
-const util_1 = require("../util");
-const fastify_1 = __importDefault(require("fastify"));
-const path_1 = require("path");
-const error_1 = require("../validation/error");
-const logger = (0, util_1.makeLogger)('Metrics');
-function setupMetricsServer(name, config) {
-    const metricsApp = (0, fastify_1.default)({
-        logger: false,
-    });
-    const metricsPort = config.METRICS_PORT;
-    const endpoint = config.METRICS_USE_BASE_URL ? (0, path_1.join)(config.BASE_URL, 'metrics') : '/metrics';
-    const eaHost = config.EA_HOST;
-    (0, exports.setupMetrics)(name, config);
-    metricsApp.get(endpoint, async (_, res) => {
-        res.type('txt');
-        res.send(await client.register.metrics());
-    });
-    metricsApp.listen({
-        port: metricsPort,
-        host: eaHost,
-    }, () => logger.info(`Monitoring listening on port ${metricsPort}!`));
-}
-exports.setupMetricsServer = setupMetricsServer;
-const setupMetrics = (name, config) => {
-    client.collectDefaultMetrics();
-    client.register.setDefaultLabels({
-        app_name: config.METRICS_NAME || name || 'N/A',
-        app_version: process.env['npm_package_version'],
-    });
-};
-exports.setupMetrics = setupMetrics;
-/**
- * Builds metrics middleware that records end to end EA response times
- * and count of requests
- *
- * @returns the cache middleware function
- */
-const buildMetricsMiddleware = (req, res, done) => {
-    // The request context can technically be empty if the input validation failed
-    const feedId = req.requestContext?.meta?.metrics?.feedId || 'N/A';
-    const labels = (0, exports.buildHttpRequestMetricsLabel)(feedId, req.requestContext?.meta?.error, req.requestContext?.meta?.metrics?.cacheHit);
-    // Record number of requests sent to EA
-    exports.httpRequestsTotal.labels(labels).inc();
-    // Record response time of request through entire EA
-    exports.httpRequestDurationSeconds.observe(res.getResponseTime() / 1000);
-    logger.debug(`Response time for ${feedId}: ${res.getResponseTime()}ms`);
-    done();
-};
-exports.buildMetricsMiddleware = buildMetricsMiddleware;
-const buildHttpRequestMetricsLabel = (feedId, error, cacheHit) => {
-    const labels = {};
-    labels.method = 'POST';
-    labels.feed_id = feedId;
-    if (error instanceof error_1.AdapterError) {
-        // If error present and an instace of AdapterError, build label from error info
-        labels.type = error?.metricsLabel || constants_1.HttpRequestType.ADAPTER_ERROR;
-        labels.status_code = error?.statusCode;
-        labels.provider_status_code = error?.providerStatusCode;
-    }
-    else if (error instanceof Error) {
-        // If error present and not instance of generic Error, unexpected failure occurred
-        labels.type = constants_1.HttpRequestType.ADAPTER_ERROR;
-        labels.status_code = 500;
-    }
-    else {
-        // If no error present, request went as expected
-        labels.status_code = 200;
-        if (cacheHit) {
-            labels.type = constants_1.HttpRequestType.CACHE_HIT;
-        }
-        else {
-            labels.type = constants_1.HttpRequestType.DATA_PROVIDER_HIT;
-            labels.provider_status_code = 200;
-        }
-    }
-    return labels;
-};
-exports.buildHttpRequestMetricsLabel = buildHttpRequestMetricsLabel;
-exports.httpRequestsTotal = new client.Counter({
-    name: 'http_requests_total',
-    help: 'The number of http requests this external adapter has serviced for its entire uptime',
-    labelNames: [
-        'method',
-        'status_code',
-        'retry',
-        'type',
-        'is_cache_warming',
-        'feed_id',
-        'provider_status_code',
-    ],
-});
-exports.httpRequestDurationSeconds = new client.Histogram({
-    name: 'http_request_duration_seconds',
-    help: 'A histogram bucket of the distribution of http request durations',
-    buckets: constants_1.requestDurationBuckets,
-});
-// V3 specific metrics
-exports.bgExecuteTotal = new client.Counter({
-    name: 'bg_execute_total',
-    help: 'The number of background executes performed per endpoint',
-    labelNames: ['endpoint'],
-});
-exports.bgExecuteDurationSeconds = new client.Gauge({
-    name: 'bg_execute_duration_seconds',
-    help: 'A histogram bucket of the distribution of background execute durations',
-    labelNames: ['endpoint'],
-});
-//# sourceMappingURL=index.js.map

package/metrics/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/metrics/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAqC;AACrC,2CAAqE;AACrE,kCAAoD;AAEpD,sDAAwE;AACxE,+BAA2B;AAC3B,+CAAkD;AAElD,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,SAAS,CAAC,CAAA;AAEpC,SAAgB,kBAAkB,CAAC,IAAY,EAAE,MAAqB;IACpE,MAAM,UAAU,GAAG,IAAA,iBAAO,EAAC;QACzB,MAAM,EAAE,KAAK;KACd,CAAC,CAAA;IACF,MAAM,WAAW,GAAG,MAAM,CAAC,YAAY,CAAA;IACvC,MAAM,QAAQ,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,CAAA;IAC5F,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAA;IAE7B,IAAA,oBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAE1B,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE;QACxC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACf,GAAG,CAAC,IAAI,CAAC,MAAM,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;IAC3C,CAAC,CAAC,CAAA;IAEF,UAAU,CAAC,MAAM,CACf;QACE,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,MAAM;KACb,EACD,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,gCAAgC,WAAW,GAAG,CAAC,CAClE,CAAA;AACH,CAAC;AAtBD,gDAsBC;AAEM,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,MAAqB,EAAQ,EAAE;IACxE,MAAM,CAAC,qBAAqB,EAAE,CAAA;IAC9B,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC;QAC/B,QAAQ,EAAE,MAAM,CAAC,YAAY,IAAI,IAAI,IAAI,KAAK;QAC9C,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;KAChD,CAAC,CAAA;AACJ,CAAC,CAAA;AANY,QAAA,YAAY,gBAMxB;AAED;;;;;GAKG;AACI,MAAM,sBAAsB,GAAG,CACpC,GAAmB,EACnB,GAAiB,EACjB,IAA6B,EAC7B,EAAE;IACF,8EAA8E;IAC9E,MAAM,MAAM,GAAG,GAAG,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK,CAAA;IACjE,MAAM,MAAM,GAAG,IAAA,oCAA4B,EACzC,MAAM,EACN,GAAG,CAAC,cAAc,EAAE,IAAI,EAAE,KAAK,EAC/B,GAAG,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,CAC5C,CAAA;IAED,uCAAuC;IACvC,yBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAA;IAEtC,oDAAoD;IACpD,kCAA0B,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,IAAI,CAAC,CAAA;IAChE,MAAM,CAAC,KAAK,CAAC,qBAAqB,MAAM,KAAK,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,CAAA;IACvE,IAAI,EAAE,CAAA;AACR,CAAC,CAAA;AApBY,QAAA,sBAAsB,0BAoBlC;AAEM,MAAM,4BAA4B,GAAG,CAC1C,MAAc,EACd,KAA4B,EAC5B,QAAkB,EAC8B,EAAE;IAClD,MAAM,MAAM,GAAmD,EAAE,CAAA;IACjE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,MAAM,CAAC,OAAO,GAAG,MAAM,CAAA;IACvB,IAAI,KAAK,YAAY,oBAAY,EAAE;QACjC,+EAA+E;QAC/E,MAAM,CAAC,IAAI,GAAG,KAAK,EAAE,YAAY,IAAI,2BAAe,CAAC,aAAa,CAAA;QAClE,MAAM,CAAC,WAAW,GAAG,KAAK,EAAE,UAAU,CAAA;QACtC,MAAM,CAAC,oBAAoB,GAAG,KAAK,EAAE,kBAAkB,CAAA;KACxD;SAAM,IAAI,KAAK,YAAY,KAAK,EAAE;QACjC,kFAAkF;QAClF,MAAM,CAAC,IAAI,GAAG,2BAAe,CAAC,aAAa,CAAA;QAC3C,MAAM,CAAC,WAAW,GAAG,GAAG,CAAA;KACzB;SAAM;QACL,gDAAgD;QAChD,MAAM,CAAC,WAAW,GAAG,GAAG,CAAA;QACxB,IAAI,QAAQ,EAAE;YACZ,MAAM,CAAC,IAAI,GAAG,2BAAe,CAAC,SAAS,CAAA;SACxC;aAAM;YACL,MAAM,CAAC,IAAI,GAAG,2BAAe,CAAC,iBAAiB,CAAA;YAC/C,MAAM,CAAC,oBAAoB,GAAG,GAAG,CAAA;SAClC;KACF;IAED,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AA7BY,QAAA,4BAA4B,gCA6BxC;AAEY,QAAA,iBAAiB,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IAClD,IAAI,EAAE,qBAAqB;IAC3B,IAAI,EAAE,sFAAsF;IAC5F,UAAU,EAAE;QACV,QAAQ;QACR,aAAa;QACb,OAAO;QACP,MAAM;QACN,kBAAkB;QAClB,SAAS;QACT,sBAAsB;KACd;CACX,CAAC,CAAA;AAEW,QAAA,0BAA0B,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC;IAC7D,IAAI,EAAE,+BAA+B;IACrC,IAAI,EAAE,kEAAkE;IACxE,OAAO,EAAE,kCAAsB;CAChC,CAAC,CAAA;AAEF,sBAAsB;AACT,QAAA,cAAc,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IAC/C,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,0DAA0D;IAChE,UAAU,EAAE,CAAC,UAAU,CAAU;CAClC,CAAC,CAAA;AAEW,QAAA,wBAAwB,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC;IACvD,IAAI,EAAE,6BAA6B;IACnC,IAAI,EAAE,wEAAwE;IAC9E,UAAU,EAAE,CAAC,UAAU,CAAU;CAClC,CAAC,CAAA"}

package/metrics/util.d.ts

@@ -1,7 +0,0 @@
-import { AdapterMetricsMeta, AdapterRequestData } from '../util';
-import { AdapterEndpoint } from '../adapter';
-import { AdapterConfig, SettingsMap } from '../config';
-export declare const getMetricsMeta: <Params, Result, CustomSettings extends SettingsMap>({ adapterEndpoint, adapterConfig, }: {
-    adapterEndpoint: AdapterEndpoint<Params, Result, CustomSettings>;
-    adapterConfig: AdapterConfig<CustomSettings>;
-}, data: AdapterRequestData) => AdapterMetricsMeta;

package/metrics/util.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMetricsMeta = void 0;
-const cache_1 = require("../cache");
-const getMetricsMeta = ({ adapterEndpoint, adapterConfig, }, data) => {
-    const feedId = (0, cache_1.calculateFeedId)({ adapterEndpoint, adapterConfig }, data);
-    return { feedId };
-};
-exports.getMetricsMeta = getMetricsMeta;
-//# sourceMappingURL=util.js.map

package/metrics/util.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/metrics/util.ts"],"names":[],"mappings":";;;AAEA,oCAA0C;AAGnC,MAAM,cAAc,GAAG,CAC5B,EACE,eAAe,EACf,aAAa,GAId,EACD,IAAwB,EACJ,EAAE;IACtB,MAAM,MAAM,GAAG,IAAA,uBAAe,EAAC,EAAE,eAAe,EAAE,aAAa,EAAE,EAAE,IAAI,CAAC,CAAA;IACxE,OAAO,EAAE,MAAM,EAAE,CAAA;AACnB,CAAC,CAAA;AAZY,QAAA,cAAc,kBAY1B"}

package/rate-limiting/background/fixed-frequency.d.ts

@@ -1,11 +0,0 @@
-import { AdapterRateLimitTier, BackgroundExecuteRateLimiter } from '..';
-import { AdapterEndpoint } from '../../adapter';
-import { SettingsMap } from '../../config';
-export declare const DEFAULT_SHARED_MS_BETWEEN_REQUESTS = 5000;
-export declare class FixedFrequencyRateLimiter implements BackgroundExecuteRateLimiter {
-    msBetweenRequestsMap: {
-        [endpointName: string]: number;
-    };
-    initialize<Params, Result, CustomSettings extends SettingsMap>(endpoints: AdapterEndpoint<Params, Result, CustomSettings>[], limits?: AdapterRateLimitTier): this;
-    msUntilNextExecution(endpointName: string): number;
-}

package/rate-limiting/background/fixed-frequency.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FixedFrequencyRateLimiter = exports.DEFAULT_SHARED_MS_BETWEEN_REQUESTS = void 0;
-const __1 = require("..");
-const util_1 = require("../../util");
-const logger = (0, util_1.makeLogger)('FixedFrequencyRateLimiter');
-exports.DEFAULT_SHARED_MS_BETWEEN_REQUESTS = 5000;
-class FixedFrequencyRateLimiter {
-    constructor() {
-        this.msBetweenRequestsMap = {};
-    }
-    initialize(endpoints, limits) {
-        // Translate the hourly limit into reqs per minute
-        let sharedMsBetweenRequests = 1000 / (0, __1.consolidateTierLimits)(limits);
-        // If there is no limit set, we use some reasonable number
-        if (!limits?.rateLimit1h && !limits?.rateLimit1m && !limits?.rateLimit1s) {
-            // 5s period for all seems good
-            sharedMsBetweenRequests = exports.DEFAULT_SHARED_MS_BETWEEN_REQUESTS;
-        }
-        logger.debug('Using fixed frequency batch rate limiting');
-        for (const endpoint of endpoints) {
-            if (endpoint.rateLimiting?.allocationPercentage == null) {
-                throw new Error(`Allocation percentage for endpoint "${endpoint.name}" is null`);
-            }
-            this.msBetweenRequestsMap[endpoint.name] =
-                (sharedMsBetweenRequests / endpoint.rateLimiting?.allocationPercentage) * 100;
-            logger.debug(`Endpoint [${endpoint.name}]: ${this.msBetweenRequestsMap[endpoint.name] / 1000}s between requests`);
-        }
-        return this;
-    }
-    msUntilNextExecution(endpointName) {
-        return this.msBetweenRequestsMap[endpointName];
-    }
-}
-exports.FixedFrequencyRateLimiter = FixedFrequencyRateLimiter;
-//# sourceMappingURL=fixed-frequency.js.map

package/rate-limiting/background/fixed-frequency.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fixed-frequency.js","sourceRoot":"","sources":["../../../../src/rate-limiting/background/fixed-frequency.ts"],"names":[],"mappings":";;;AAAA,0BAA8F;AAG9F,qCAAuC;AAEvC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,2BAA2B,CAAC,CAAA;AACzC,QAAA,kCAAkC,GAAG,IAAI,CAAA;AAEtD,MAAa,yBAAyB;IAAtC;QACE,yBAAoB,GAEhB,EAAE,CAAA;IAqCR,CAAC;IAnCC,UAAU,CACR,SAA4D,EAC5D,MAA6B;QAE7B,kDAAkD;QAClD,IAAI,uBAAuB,GAAG,IAAI,GAAG,IAAA,yBAAqB,EAAC,MAAM,CAAC,CAAA;QAElE,0DAA0D;QAC1D,IAAI,CAAC,MAAM,EAAE,WAAW,IAAI,CAAC,MAAM,EAAE,WAAW,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE;YACxE,+BAA+B;YAC/B,uBAAuB,GAAG,0CAAkC,CAAA;SAC7D;QAED,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAA;QACzD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;YAChC,IAAI,QAAQ,CAAC,YAAY,EAAE,oBAAoB,IAAI,IAAI,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,uCAAuC,QAAQ,CAAC,IAAI,WAAW,CAAC,CAAA;aACjF;YAED,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACtC,CAAC,uBAAuB,GAAG,QAAQ,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,GAAG,CAAA;YAE/E,MAAM,CAAC,KAAK,CACV,aAAa,QAAQ,CAAC,IAAI,MACxB,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,IAC7C,oBAAoB,CACrB,CAAA;SACF;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED,oBAAoB,CAAC,YAAoB;QACvC,OAAO,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAA;IAChD,CAAC;CACF;AAxCD,8DAwCC"}

package/rate-limiting/index.d.ts

@@ -1,56 +0,0 @@
-import { AdapterEndpoint } from '../adapter';
-import { AdapterConfig, SettingsMap } from '../config';
-export * from './request/simple-counting';
-export * from './background/fixed-frequency';
-export interface AdapterRateLimitTier {
-    rateLimit1s?: number;
-    rateLimit1m?: number;
-    rateLimit1h?: number;
-    note?: string;
-}
-/**
- * Common interface for all RateLimiter classes to implement
- */
-export interface RateLimiter {
-    /**
-     * Method to ensure all RateLimiters can be initialized in the same manner.
-     *
-     * @param limits - settings for how much throughput to allow for the Adapter
-     * @param endpoints - list of adapter endpoints
-     */
-    initialize<Params, Result, CustomSettings extends SettingsMap>(endpoints: AdapterEndpoint<Params, Result, CustomSettings>[], limits: AdapterRateLimitTier): this;
-}
-/**
- * RequestRateLimiters perform checks agains imminent outbound requests for any transport.
- */
-export interface RequestRateLimiter extends RateLimiter {
-    /**
-     * This method will check using whatever strategy is implemented to determine if
-     * this request can be processed. If so, it returns true; if not, returns false.
-     */
-    isUnderLimits(): boolean;
-}
-/**
- * BackgroundExecuteFrequencyRateLimiters will implement custom logic to calculate
- * the period of time to wait between background executions for a transport.
- */
-export interface BackgroundExecuteRateLimiter extends RateLimiter {
-    msUntilNextExecution(endpointName: string): number;
-}
-/**
- * This method will convert all possible settings for a rate limit tier and
- * convert them all to requests per second, returning the lowest one
- *
- * @param limits - the rate limit tier set for the adapter
- * @returns the most restrictive of the set options, in requests per second
- */
-export declare const consolidateTierLimits: (limits?: AdapterRateLimitTier) => number;
-/**
- * Validates rate limiting tiers specified for the adapter, and returns the one to use.
- *
- * @param config - the adapter config containing the env vars
- * @param tiers - the adapter config listing the different available API tiers
- * @returns the specified API tier, or a default one if none are specified
- */
-export declare const getRateLimitingTier: (config: AdapterConfig, tiers?: Record<string, AdapterRateLimitTier>) => AdapterRateLimitTier | undefined;
-export declare const buildRateLimitTiersFromConfig: (config: AdapterConfig) => AdapterRateLimitTier | undefined;

package/rate-limiting/index.js

@@ -1,86 +0,0 @@
-"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.buildRateLimitTiersFromConfig = exports.getRateLimitingTier = exports.consolidateTierLimits = void 0;
-__exportStar(require("./request/simple-counting"), exports);
-__exportStar(require("./background/fixed-frequency"), exports);
-/**
- * This method will convert all possible settings for a rate limit tier and
- * convert them all to requests per second, returning the lowest one
- *
- * @param limits - the rate limit tier set for the adapter
- * @returns the most restrictive of the set options, in requests per second
- */
-const consolidateTierLimits = (limits) => {
-    const perHourLimit = (limits?.rateLimit1h || Infinity) / (60 * 60);
-    const perMinuteLimit = (limits?.rateLimit1m || Infinity) / 60;
-    const perSecondLimit = limits?.rateLimit1s || Infinity;
-    return Math.min(perHourLimit, perMinuteLimit, perSecondLimit);
-};
-exports.consolidateTierLimits = consolidateTierLimits;
-/**
- * Validates rate limiting tiers specified for the adapter, and returns the one to use.
- *
- * @param config - the adapter config containing the env vars
- * @param tiers - the adapter config listing the different available API tiers
- * @returns the specified API tier, or a default one if none are specified
- */
-const getRateLimitingTier = (config, tiers) => {
-    if (config.RATE_LIMIT_CAPACITY ||
-        config.RATE_LIMIT_CAPACITY_MINUTE ||
-        config.RATE_LIMIT_CAPACITY_SECOND) {
-        return (0, exports.buildRateLimitTiersFromConfig)(config);
-    }
-    if (!tiers) {
-        return;
-    }
-    // Check that if the tiers object is defined, it has values
-    if (Object.values(tiers).length === 0) {
-        throw new Error(`The tiers object is defined, but has no entries`);
-    }
-    // Check that the tier set in the AdapterConfig is a valid one
-    const selectedTier = config.RATE_LIMIT_API_TIER;
-    if (selectedTier && !tiers[selectedTier]) {
-        const validTiersString = Object.keys(tiers)
-            .map((t) => `"${t}"`)
-            .join(', ');
-        throw new Error(`The selected rate limit tier "${selectedTier}" is not valid (can be one of ${validTiersString})`);
-    }
-    if (!selectedTier) {
-        // Sort the tiers by most to least restrictive
-        const sortedTiers = Object.values(tiers).sort((t1, t2) => (0, exports.consolidateTierLimits)(t1) - (0, exports.consolidateTierLimits)(t2));
-        return sortedTiers[0];
-    }
-    return tiers[selectedTier];
-};
-exports.getRateLimitingTier = getRateLimitingTier;
-// Creates adapter rate limit tier using the configs specified in env vars
-const buildRateLimitTiersFromConfig = (config) => {
-    const rateLimit1s = config.RATE_LIMIT_CAPACITY_SECOND;
-    let rateLimit1m;
-    if (config.RATE_LIMIT_CAPACITY_MINUTE) {
-        rateLimit1m = config.RATE_LIMIT_CAPACITY_MINUTE;
-    }
-    else if (config.RATE_LIMIT_CAPACITY) {
-        rateLimit1m = config.RATE_LIMIT_CAPACITY;
-    }
-    return {
-        rateLimit1s,
-        rateLimit1m,
-    };
-};
-exports.buildRateLimitTiersFromConfig = buildRateLimitTiersFromConfig;
-//# sourceMappingURL=index.js.map

package/rate-limiting/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/rate-limiting/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAGA,4DAAyC;AACzC,+DAA4C;AA4C5C;;;;;;GAMG;AACI,MAAM,qBAAqB,GAAG,CAAC,MAA6B,EAAE,EAAE;IACrE,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,WAAW,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAA;IAClE,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,WAAW,IAAI,QAAQ,CAAC,GAAG,EAAE,CAAA;IAC7D,MAAM,cAAc,GAAG,MAAM,EAAE,WAAW,IAAI,QAAQ,CAAA;IACtD,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,cAAc,EAAE,cAAc,CAAC,CAAA;AAC/D,CAAC,CAAA;AALY,QAAA,qBAAqB,yBAKjC;AAED;;;;;;GAMG;AACI,MAAM,mBAAmB,GAAG,CACjC,MAAqB,EACrB,KAA4C,EACV,EAAE;IACpC,IACE,MAAM,CAAC,mBAAmB;QAC1B,MAAM,CAAC,0BAA0B;QACjC,MAAM,CAAC,0BAA0B,EACjC;QACA,OAAO,IAAA,qCAA6B,EAAC,MAAM,CAAC,CAAA;KAC7C;IACD,IAAI,CAAC,KAAK,EAAE;QACV,OAAM;KACP;IAED,2DAA2D;IAC3D,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QACrC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;KACnE;IAED,8DAA8D;IAC9D,MAAM,YAAY,GAAG,MAAM,CAAC,mBAAmB,CAAA;IAC/C,IAAI,YAAY,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE;QACxC,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;aACxC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC;aACpB,IAAI,CAAC,IAAI,CAAC,CAAA;QAEb,MAAM,IAAI,KAAK,CACb,iCAAiC,YAAY,iCAAiC,gBAAgB,GAAG,CAClG,CAAA;KACF;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,8CAA8C;QAC9C,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAC3C,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,IAAA,6BAAqB,EAAC,EAAE,CAAC,GAAG,IAAA,6BAAqB,EAAC,EAAE,CAAC,CAClE,CAAA;QAED,OAAO,WAAW,CAAC,CAAC,CAAC,CAAA;KACtB;IAED,OAAO,KAAK,CAAC,YAAY,CAAC,CAAA;AAC5B,CAAC,CAAA;AA1CY,QAAA,mBAAmB,uBA0C/B;AAED,0EAA0E;AACnE,MAAM,6BAA6B,GAAG,CAC3C,MAAqB,EACa,EAAE;IACpC,MAAM,WAAW,GAAG,MAAM,CAAC,0BAA0B,CAAA;IACrD,IAAI,WAAW,CAAA;IACf,IAAI,MAAM,CAAC,0BAA0B,EAAE;QACrC,WAAW,GAAG,MAAM,CAAC,0BAA0B,CAAA;KAChD;SAAM,IAAI,MAAM,CAAC,mBAAmB,EAAE;QACrC,WAAW,GAAG,MAAM,CAAC,mBAAmB,CAAA;KACzC;IACD,OAAO;QACL,WAAW;QACX,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAdY,QAAA,6BAA6B,iCAczC"}

package/rate-limiting/metrics.d.ts

@@ -1,3 +0,0 @@
-import * as client from 'prom-client';
-export declare const retrieveCost: <ProviderResponseBody>(data: ProviderResponseBody) => number;
-export declare const rateLimitCreditsSpentTotal: client.Counter<"feed_id" | "participant_id">;

package/rate-limiting/metrics.js

@@ -1,45 +0,0 @@
-"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;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.rateLimitCreditsSpentTotal = exports.retrieveCost = void 0;
-const client = __importStar(require("prom-client"));
-// Retrieve cost field from response if exists
-// If not return default cost of 1
-const retrieveCost = (data) => {
-    const cost = data['cost'];
-    if (typeof cost === 'number' || typeof cost === 'string') {
-        return Number(cost);
-    }
-    else {
-        return 1;
-    }
-};
-exports.retrieveCost = retrieveCost;
-exports.rateLimitCreditsSpentTotal = new client.Counter({
-    name: 'rate_limit_credits_spent_total',
-    help: 'The number of data provider credits the adapter is consuming',
-    labelNames: ['participant_id', 'feed_id'],
-});
-//# sourceMappingURL=metrics.js.map

package/rate-limiting/metrics.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../../src/rate-limiting/metrics.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAqC;AAErC,8CAA8C;AAC9C,kCAAkC;AAC3B,MAAM,YAAY,GAAG,CAAuB,IAA0B,EAAU,EAAE;IACvF,MAAM,IAAI,GAAI,IAAgC,CAAC,MAAM,CAAC,CAAA;IACtD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACxD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAA;KACpB;SAAM;QACL,OAAO,CAAC,CAAA;KACT;AACH,CAAC,CAAA;AAPY,QAAA,YAAY,gBAOxB;AAEY,QAAA,0BAA0B,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IAC3D,IAAI,EAAE,gCAAgC;IACtC,IAAI,EAAE,8DAA8D;IACpE,UAAU,EAAE,CAAC,gBAAgB,EAAE,SAAS,CAAU;CACnD,CAAC,CAAA"}

package/rate-limiting/request/simple-counting.d.ts

@@ -1,21 +0,0 @@
-import { AdapterRateLimitTier, RateLimiter } from '..';
-import { AdapterEndpoint } from '../../adapter';
-import { SettingsMap } from '../../config';
-/**
- * This rate limiter is the simplest stateful option.
- * On startup, it'll compare the different thresholds for each tier, calculate them all
- * in the finest window we'll use (seconds), and use the most restrictive one.
- * This is so if the EA were to restart, we don't need to worry about persisting state
- * for things like daily quotas. The downside is that this does not work well for bursty
- * loads or spikes, in cases where e.g. the per second limit is high but daily quotas low.
- */
-export declare class SimpleCountingRateLimiter implements RateLimiter {
-    latestSecondInterval: number;
-    requestsThisSecond: number;
-    latestMinuteInterval: number;
-    requestsThisMinute: number;
-    perSecondLimit: number;
-    perMinuteLimit: number;
-    initialize<Params, Result, CustomSettings extends SettingsMap>(endpoints: AdapterEndpoint<Params, Result, CustomSettings>[], limits?: AdapterRateLimitTier): this;
-    isUnderLimits(): boolean;
-}

package/rate-limiting/request/simple-counting.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SimpleCountingRateLimiter = void 0;
-const util_1 = require("../../util");
-const logger = (0, util_1.makeLogger)('SimpleCountingRateLimiter');
-/**
- * This rate limiter is the simplest stateful option.
- * On startup, it'll compare the different thresholds for each tier, calculate them all
- * in the finest window we'll use (seconds), and use the most restrictive one.
- * This is so if the EA were to restart, we don't need to worry about persisting state
- * for things like daily quotas. The downside is that this does not work well for bursty
- * loads or spikes, in cases where e.g. the per second limit is high but daily quotas low.
- */
-class SimpleCountingRateLimiter {
-    constructor() {
-        this.latestSecondInterval = 0;
-        this.requestsThisSecond = 0;
-        this.latestMinuteInterval = 0;
-        this.requestsThisMinute = 0;
-    }
-    initialize(endpoints, limits) {
-        // Translate the hourly limit into reqs per minute
-        const perHourLimit = (limits?.rateLimit1h || Infinity) / 60;
-        this.perMinuteLimit = Math.min(limits?.rateLimit1m || Infinity, perHourLimit);
-        this.perSecondLimit = limits?.rateLimit1s || Infinity;
-        logger.debug(`Using rate limiting settings: perMinute = ${this.perMinuteLimit} | perSecond: = ${this.perSecondLimit}`);
-        return this;
-    }
-    isUnderLimits() {
-        // If the limit is set to infinity, there was no tier limit specified
-        if (this.perSecondLimit === Infinity && this.perMinuteLimit === Infinity) {
-            return true;
-        }
-        const now = Date.now();
-        const nearestSecondInterval = Math.floor(now / 1000);
-        const nearestMinuteInterval = Math.floor(now / (1000 * 60));
-        // This should always run to completion, even if it doesn't look atomic; therefore the
-        // Ops should be "thread safe". Thank JS and its infinite single threaded dumbness.
-        if (nearestSecondInterval !== this.latestSecondInterval) {
-            logger.trace(`Clearing latest second interval, # of requests logged was: ${this.requestsThisSecond} `);
-            this.latestSecondInterval = nearestSecondInterval;
-            this.requestsThisSecond = 0;
-        }
-        if (nearestMinuteInterval !== this.latestMinuteInterval) {
-            logger.trace(`Clearing latest second minute, # of requests logged was: ${this.requestsThisMinute} `);
-            this.latestMinuteInterval = nearestMinuteInterval;
-            this.requestsThisMinute = 0;
-        }
-        if (this.requestsThisSecond < this.perSecondLimit &&
-            this.requestsThisMinute < this.perMinuteLimit) {
-            logger.trace('Request under limits, counting +1');
-            this.requestsThisSecond++;
-            this.requestsThisMinute++;
-            return true;
-        }
-        else {
-            logger.trace('Requests seen this interval are above limits');
-            return false;
-        }
-    }
-}
-exports.SimpleCountingRateLimiter = SimpleCountingRateLimiter;
-//# sourceMappingURL=simple-counting.js.map

package/rate-limiting/request/simple-counting.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"simple-counting.js","sourceRoot":"","sources":["../../../../src/rate-limiting/request/simple-counting.ts"],"names":[],"mappings":";;;AAGA,qCAAuC;AAEvC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,2BAA2B,CAAC,CAAA;AAEtD;;;;;;;GAOG;AACH,MAAa,yBAAyB;IAAtC;QACE,yBAAoB,GAAG,CAAC,CAAA;QACxB,uBAAkB,GAAG,CAAC,CAAA;QACtB,yBAAoB,GAAG,CAAC,CAAA;QACxB,uBAAkB,GAAG,CAAC,CAAA;IA4DxB,CAAC;IAxDC,UAAU,CACR,SAA4D,EAC5D,MAA6B;QAE7B,kDAAkD;QAClD,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,WAAW,IAAI,QAAQ,CAAC,GAAG,EAAE,CAAA;QAC3D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,IAAI,QAAQ,EAAE,YAAY,CAAC,CAAA;QAC7E,IAAI,CAAC,cAAc,GAAG,MAAM,EAAE,WAAW,IAAI,QAAQ,CAAA;QACrD,MAAM,CAAC,KAAK,CACV,6CAA6C,IAAI,CAAC,cAAc,mBAAmB,IAAI,CAAC,cAAc,EAAE,CACzG,CAAA;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED,aAAa;QACX,qEAAqE;QACrE,IAAI,IAAI,CAAC,cAAc,KAAK,QAAQ,IAAI,IAAI,CAAC,cAAc,KAAK,QAAQ,EAAE;YACxE,OAAO,IAAI,CAAA;SACZ;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACtB,MAAM,qBAAqB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,CAAA;QACpD,MAAM,qBAAqB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAA;QAE3D,sFAAsF;QACtF,mFAAmF;QACnF,IAAI,qBAAqB,KAAK,IAAI,CAAC,oBAAoB,EAAE;YACvD,MAAM,CAAC,KAAK,CACV,8DAA8D,IAAI,CAAC,kBAAkB,GAAG,CACzF,CAAA;YACD,IAAI,CAAC,oBAAoB,GAAG,qBAAqB,CAAA;YACjD,IAAI,CAAC,kBAAkB,GAAG,CAAC,CAAA;SAC5B;QAED,IAAI,qBAAqB,KAAK,IAAI,CAAC,oBAAoB,EAAE;YACvD,MAAM,CAAC,KAAK,CACV,4DAA4D,IAAI,CAAC,kBAAkB,GAAG,CACvF,CAAA;YACD,IAAI,CAAC,oBAAoB,GAAG,qBAAqB,CAAA;YACjD,IAAI,CAAC,kBAAkB,GAAG,CAAC,CAAA;SAC5B;QAED,IACE,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,cAAc;YAC7C,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,cAAc,EAC7C;YACA,MAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAA;YACjD,IAAI,CAAC,kBAAkB,EAAE,CAAA;YACzB,IAAI,CAAC,kBAAkB,EAAE,CAAA;YACzB,OAAO,IAAI,CAAA;SACZ;aAAM;YACL,MAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAA;YAC5D,OAAO,KAAK,CAAA;SACb;IACH,CAAC;CACF;AAhED,8DAgEC"}

package/transports/batch-warming.d.ts

@@ -1,35 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
-import { Cache } from '../cache';
-import { AdapterConfig, SettingsMap } from '../config';
-import { BackgroundExecuteRateLimiter } from '../rate-limiting';
-import { SubscriptionSet } from '../util';
-import { AdapterRequest, AdapterResponse, ProviderResult } from '../util/request';
-import { Transport, BackgroundStoredResultType } from './';
-import { AdapterContext, AdapterDependencies } from '../adapter';
-/**
- * Transport implementation that takes incoming batches requests and keeps a warm cache of values.
- * Within the setup function, adapter params are added to an set that also keeps track and expires values.
- * In the background execute, the list of non-expired items in the set is fetched.
- * Then, the list is passed through the `prepareRequest` function, that returns an AxiosRequestConfig.
- * The Data Provider response is, they are passed through the `parseResponse` function to create a [[CacheEntry]] list.
- * Finally, the items in that [[CacheEntry]] list are set in the Cache so the Adapter can fetch values from there.
- *
- * @typeParam AdapterParams - interface for the adapter request body
- * @typeParam ProviderRequestBody - interface for the body of the request to the Data Provider
- * @typeParam ProviderResponseBody - interface for the body of the Data Provider's response
- */
-export declare class BatchWarmingTransport<AdapterParams, ProviderRequestBody, ProviderResponseBody, CustomSettings extends SettingsMap> implements Transport<AdapterParams, BackgroundStoredResultType, CustomSettings> {
-    private config;
-    cache: Cache<AdapterResponse<BackgroundStoredResultType>>;
-    rateLimiter: BackgroundExecuteRateLimiter;
-    subscriptionSet: SubscriptionSet<AdapterParams>;
-    WARMER_ACTIVE: boolean;
-    constructor(config: {
-        prepareRequest: (params: AdapterParams[], config: AdapterConfig<CustomSettings>) => AxiosRequestConfig<ProviderRequestBody>;
-        parseResponse: (params: AdapterParams[], res: AxiosResponse<ProviderResponseBody>, config: AdapterConfig<CustomSettings>) => ProviderResult<AdapterParams>[];
-    });
-    initialize(dependencies: AdapterDependencies, _: AdapterConfig<CustomSettings>, endpointName: string): Promise<void>;
-    registerRequest(req: AdapterRequest<AdapterParams>, config: AdapterConfig<CustomSettings>): Promise<void>;
-    backgroundExecute(context: AdapterContext<CustomSettings>): Promise<number>;
-    private makeRequest;
-}