@chainlink/external-adapter-framework 0.25.1 → 0.26.0

package/transports/meta/routing.d.ts

@@ -1,38 +0,0 @@
-import { EndpointContext } from '../../adapter';
-import { ResponseCache } from '../../cache/response';
-import { AdapterConfig } from '../../config';
-import { AdapterRequest, AdapterResponse, RequestGenerics } from '../../util';
-import { MetaTransport, Transport, TransportDependencies, TransportGenerics } from '..';
-export type RoutingTransportGenerics = TransportGenerics & {
-    Request: RequestGenerics & {
-        Params: RequestGenerics['Params'] & {
-            transport: string;
-        };
-    };
-};
-export declare const routingTransportParams: {
-    transport: {
-        description: string;
-        type: "string";
-    };
-};
-/**
- * Transport implementation that takes 2 or more transports and a function that determines with transport to use.
- *
- * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[TransportGenerics]])
- */
-export declare class RoutingTransport<T extends RoutingTransportGenerics> implements MetaTransport<T> {
-    transports: Record<string, Transport<T>>;
-    private customRouter?;
-    constructor(transports: Record<string, Transport<T>>, customRouter?: ((req: AdapterRequest<T['Request']>, adapterConfig: AdapterConfig<T['CustomSettings']>) => string) | undefined);
-    responseCache: ResponseCache<{
-        Request: T['Request'];
-        Response: T['Response'];
-    }>;
-    backgroundExecute?: ((context: EndpointContext<T>) => Promise<void>) | undefined;
-    initialize(dependencies: TransportDependencies<T>, adapterConfig: AdapterConfig<T['CustomSettings']>, endpointName: string): Promise<void>;
-    registerRequest(req: AdapterRequest<T['Request']>, adapterConfig: AdapterConfig<T['CustomSettings']>): Promise<void>;
-    private defaultRouter;
-    private resolveTransport;
-    foregroundExecute(req: AdapterRequest<T['Request']>, adapterConfig: AdapterConfig<T['CustomSettings']>): Promise<AdapterResponse<any> | void>;
-}

package/transports/meta/routing.js

@@ -1,80 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RoutingTransport = exports.routingTransportParams = void 0;
-const util_1 = require("../../util");
-const error_1 = require("../../validation/error");
-const logger = (0, util_1.makeLogger)('RoutingTransport');
-exports.routingTransportParams = {
-    transport: {
-        description: 'Name of the transport this request shuold be routed to',
-        type: 'string',
-    },
-};
-/**
- * Transport implementation that takes 2 or more transports and a function that determines with transport to use.
- *
- * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[TransportGenerics]])
- */
-class RoutingTransport {
-    constructor(transports, 
-    //  This is public for tests, which sometimes need the underlying transport for things like ticking the clock
-    customRouter) {
-        this.transports = transports;
-        this.customRouter = customRouter;
-        for (const transportName in this.transports) {
-            // This is intentional, to keep names to one word only
-            if (!/^[a-z]+$/.test(transportName)) {
-                throw new Error(`Transport name "${transportName}" names in the RoutingTransport map can only include lowercase letters`);
-            }
-        }
-    }
-    async initialize(dependencies, adapterConfig, endpointName) {
-        logger.debug(`Initializing ${Object.keys(this.transports).length} transports`);
-        await Promise.all(Object.entries(this.transports).map(([name, transport]) => {
-            logger.debug(`Initializing transport ${name} (${transport.constructor.name})`);
-            return transport.initialize(dependencies, adapterConfig, endpointName);
-        }));
-    }
-    async registerRequest(req, adapterConfig) {
-        logger.debug(`registering request using `, req.requestContext.data);
-        const transport = this.resolveTransport(req, adapterConfig);
-        if (transport.registerRequest) {
-            logger.debug(`Running registerRequest on retrieved transport`);
-            return transport.registerRequest(req, adapterConfig);
-        }
-        logger.debug(`Retrieved transport doesn't implement registerRequest`);
-    }
-    defaultRouter(req) {
-        return req.requestContext.data.transport?.toLowerCase();
-    }
-    resolveTransport(req, adapterConfig) {
-        logger.debug(`Routing request using `, req.requestContext.data);
-        const key = this.customRouter ? this.customRouter(req, adapterConfig) : this.defaultRouter(req);
-        if (!key) {
-            logger.error(`No transport was specified in the input parameters, and this endpoint does not have a default set.`);
-            throw new error_1.AdapterError({
-                statusCode: 400,
-                message: `No transport was specified in the input parameters, and this endpoint does not have a default set.`,
-            });
-        }
-        if (!this.transports[key]) {
-            logger.error(`No transport found for key ${key}`);
-            throw new error_1.AdapterError({ statusCode: 400, message: `No transport found for ${key}` });
-        }
-        const transport = this.transports[key];
-        logger.debug(`Found ${transport.constructor.name} corresponding to ${key}`);
-        return transport;
-    }
-    // Allow AdapterResponse<any> below since we don't know what the adapter will return
-    /* eslint-disable  @typescript-eslint/no-explicit-any */
-    async foregroundExecute(req, adapterConfig) {
-        const transport = this.resolveTransport(req, adapterConfig);
-        if (transport.foregroundExecute) {
-            logger.debug(`Running foregroundExecute on retrieved transport`);
-            return transport.foregroundExecute(req, adapterConfig);
-        }
-        logger.debug(`Retrieved transport doesn't implement foregroundExecute`);
-    }
-}
-exports.RoutingTransport = RoutingTransport;
-//# sourceMappingURL=routing.js.map

package/transports/meta/routing.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"routing.js","sourceRoot":"","sources":["../../../../src/transports/meta/routing.ts"],"names":[],"mappings":";;;AAGA,qCAAyF;AACzF,kDAAqD;AAIrD,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,kBAAkB,CAAC,CAAA;AAUhC,QAAA,sBAAsB,GAAG;IACpC,SAAS,EAAE;QACT,WAAW,EAAE,wDAAwD;QACrE,IAAI,EAAE,QAAQ;KACf;CACwB,CAAA;AAE3B;;;;GAIG;AACH,MAAa,gBAAgB;IAI3B,YACS,UAAwC;IAC/C,6GAA6G;IACrG,YAGG;QALJ,eAAU,GAAV,UAAU,CAA8B;QAEvC,iBAAY,GAAZ,YAAY,CAGT;QAEX,KAAK,MAAM,aAAa,IAAI,IAAI,CAAC,UAAU,EAAE;YAC3C,sDAAsD;YACtD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;gBACnC,MAAM,IAAI,KAAK,CACb,mBAAmB,aAAa,wEAAwE,CACzG,CAAA;aACF;SACF;IACH,CAAC;IAQD,KAAK,CAAC,UAAU,CACd,YAAsC,EACtC,aAAiD,EACjD,YAAoB;QAEpB,MAAM,CAAC,KAAK,CAAC,gBAAgB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,aAAa,CAAC,CAAA;QAC9E,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,EAAE;YACxD,MAAM,CAAC,KAAK,CAAC,0BAA0B,IAAI,KAAK,SAAS,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,CAAA;YAC9E,OAAO,SAAS,CAAC,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,YAAY,CAAC,CAAA;QACxE,CAAC,CAAC,CACH,CAAA;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,GAAiC,EACjC,aAAiD;QAEjD,MAAM,CAAC,KAAK,CAAC,4BAA4B,EAAE,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QAEnE,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,aAAa,CAAC,CAAA;QAC3D,IAAI,SAAS,CAAC,eAAe,EAAE;YAC7B,MAAM,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAA;YAC9D,OAAO,SAAS,CAAC,eAAe,CAAC,GAAG,EAAE,aAAa,CAAC,CAAA;SACrD;QACD,MAAM,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAA;IACvE,CAAC;IAEO,aAAa,CAAC,GAAiC;QACrD,OAAO,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,EAAE,CAAA;IACzD,CAAC;IAEO,gBAAgB,CACtB,GAAiC,EACjC,aAAiD;QAEjD,MAAM,CAAC,KAAK,CAAC,wBAAwB,EAAE,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QAC/D,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;QAE/F,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,CAAC,KAAK,CACV,oGAAoG,CACrG,CAAA;YACD,MAAM,IAAI,oBAAY,CAAC;gBACrB,UAAU,EAAE,GAAG;gBACf,OAAO,EAAE,oGAAoG;aAC9G,CAAC,CAAA;SACH;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACzB,MAAM,CAAC,KAAK,CAAC,8BAA8B,GAAG,EAAE,CAAC,CAAA;YACjD,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;AAnGD,4CAmGC"}