@chainlink/external-adapter-framework 0.0.19 → 0.0.21

package/examples/bank-frick/accounts.d.ts

@@ -0,0 +1,39 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AdapterInputParameters, BankFrickAccountsRequestSchema, BankFrickAccountsResponseSchema, SigningAlgorithm } from './types';
+import { customSettings } from './config';
+import { Transport } from '../../transports';
+import { AdapterRequest, AdapterResponse } from '../../util';
+import { AdapterConfig } from '../../config';
+import { Cache } from '../../cache';
+import { AdapterDependencies, AdapterEndpoint } from '../../adapter';
+/**
+ * RestTransport implementation for Bank Frick, which has unusually complex requirements for an EA
+ * The RestTransport is generally built to make a single request and return a single response.
+ * This transport instead is used to fetch and process pages of data, and also requires a JWT to run
+ *
+ * This transport does all the heavy lifting in setup(), which is where the paging happens, and it
+ * also has complex retry logic that will attempt to refresh the JWT when certain HTTP errors occur
+ */
+export declare class BankFrickAccountsTransport implements Transport<AdapterInputParameters, number, typeof customSettings> {
+    token: string;
+    cache: Cache;
+    initialize(dependencies: AdapterDependencies): Promise<void>;
+    hasBeenSetUp(): Promise<boolean>;
+    /**
+     * Creates an AxiosRequestConfig object for fetching a page of accounts from the Bank Frick API
+     */
+    prepareRequest(firstPosition: number, inputParams: AdapterInputParameters, config: AdapterConfig<typeof customSettings>): AxiosRequestConfig<BankFrickAccountsRequestSchema>;
+    /**
+     * Request with retry logic for Bank Frick's API. In addition to standard retry logic, this function
+     * compares errors against expected errors from the Bank Frick API, and will throw without retries
+     * on a known fatal error, or try to refresh the JWT on a known auth error
+     **/
+    makeRequest(axiosRequest: AxiosRequestConfig<BankFrickAccountsRequestSchema>, config: AdapterConfig<typeof customSettings>, signingAlgorithm?: SigningAlgorithm): Promise<AxiosResponse<BankFrickAccountsResponseSchema>>;
+    validateInputParams(params: AdapterInputParameters): string[];
+    /**
+     * Fetches pages of data from the Bank Frick API, scans for accounts by IBAN, and returns the balance
+     * of all found accounts. Returns a 404 if any IBAN isn't found.
+     */
+    setup(req: AdapterRequest<AdapterInputParameters>, config: AdapterConfig<typeof customSettings>): Promise<AdapterResponse<number>>;
+}
+export declare const accountsRestEndpoint: AdapterEndpoint<AdapterInputParameters, number, import("../../config").SettingsMap>;

package/examples/bank-frick/config/index.d.ts

@@ -0,0 +1,4 @@
+import { SettingsMap } from '../../../config';
+import { SigningAlgorithm } from '../types';
+export declare const signingAlgorithms: SigningAlgorithm[];
+export declare const customSettings: SettingsMap;

package/examples/bank-frick/index.d.ts

@@ -0,0 +1,2 @@
+import { Adapter } from '../../adapter';
+export declare const adapter: Adapter<import("../../config").SettingsMap>;

package/examples/bank-frick/util.d.ts

@@ -0,0 +1,4 @@
+import { SigningAlgorithm } from './types';
+import { customSettings } from './config';
+import { AdapterConfig } from '../../config';
+export declare const generateJWT: (config: AdapterConfig<typeof customSettings>, signingAlgorithm?: SigningAlgorithm) => Promise<string>;

package/examples/coingecko/batch-warming.d.ts

@@ -0,0 +1,7 @@
+import { AdapterEndpoint } from '../../adapter';
+interface AdapterRequestParams {
+    base: string;
+    quote: string;
+}
+export declare const batchEndpoint: AdapterEndpoint<AdapterRequestParams, unknown, import("../../config").SettingsMap>;
+export {};

package/examples/coingecko/index.d.ts

@@ -0,0 +1,2 @@
+import { Adapter } from '../../adapter';
+export declare const adapter: Adapter<import("../../config").SettingsMap>;

package/examples/coingecko/rest.d.ts

@@ -0,0 +1,12 @@
+import { AdapterEndpoint } from '../../adapter';
+interface AdapterRequestParams {
+    base: string;
+    quote: string;
+}
+interface ProviderResponseBody {
+    [base: string]: {
+        [quote: string]: number;
+    };
+}
+export declare const restEndpoint: AdapterEndpoint<AdapterRequestParams, ProviderResponseBody, import("../../config").SettingsMap>;
+export {};

package/examples/coingecko/src/config/index.d.ts

@@ -0,0 +1,2 @@
+export declare const DEFAULT_API_ENDPOINT = "https://api.coingecko.com/api/v3";
+export declare const PRO_API_ENDPOINT = "https://pro-api.coingecko.com/api/v3";

package/examples/coingecko/src/config/index.js

@@ -1,13 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.customSettings = exports.PRO_API_ENDPOINT = exports.DEFAULT_API_ENDPOINT = exports.DEFAULT_ENDPOINT = exports.NAME = void 0;
-exports.NAME = 'COINGECKO';
-exports.DEFAULT_ENDPOINT = 'crypto';
+exports.PRO_API_ENDPOINT = exports.DEFAULT_API_ENDPOINT = void 0;
 exports.DEFAULT_API_ENDPOINT = 'https://api.coingecko.com/api/v3';
 exports.PRO_API_ENDPOINT = 'https://pro-api.coingecko.com/api/v3';
-exports.customSettings = {
-    API_KEY: {
-        description: 'API key for the CoinGecko API',
-        type: 'string',
-    },
-};

package/examples/coingecko/src/config/overrides.json

@@ -9003,7 +9003,6 @@
         "CRDC": "cardiocoin",
         "$CRDN": "cardence",
         "CEVO": "cardanoevo",
-        "ADA": "binance-peg-cardano",
         "ADA": "cardano",
         "CCM": "car-coin",
         "CARBON": "carboncoin",

package/examples/coingecko/src/cryptoUtils.d.ts

@@ -0,0 +1,31 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AdapterConfig } from '../../../config';
+import { InputParameters } from '../../../validation';
+export interface CryptoRequestParams {
+    coinid?: string;
+    base?: string;
+    quote: string;
+}
+export declare const cryptoInputParams: InputParameters;
+export interface ProviderRequestBody {
+    ids: string;
+    vs_currencies: string;
+    include_market_cap?: boolean;
+    include_24hr_vol?: boolean;
+}
+export interface ProviderResponseBody {
+    [base: string]: {
+        [quote: string]: number;
+    };
+}
+interface ResultEntryWithoutOverrides {
+    value: number;
+    params: {
+        quote: string;
+        base?: string;
+        coinid?: string;
+    };
+}
+export declare const buildBatchedRequestBody: (params: CryptoRequestParams[], config: AdapterConfig) => AxiosRequestConfig<ProviderRequestBody>;
+export declare const constructEntry: (res: AxiosResponse<ProviderResponseBody>, requestPayload: CryptoRequestParams, resultPath: string) => ResultEntryWithoutOverrides | undefined;
+export {};

package/examples/coingecko/src/cryptoUtils.js

@@ -1,8 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.constructEntry = exports.buildBatchedRequestBody = void 0;
+exports.constructEntry = exports.buildBatchedRequestBody = exports.cryptoInputParams = void 0;
 const config_1 = require("./config");
 const logger_1 = require("../../../util/logger");
+exports.cryptoInputParams = {
+    coinid: {
+        description: 'The CoinGecko id or to query',
+        type: 'string',
+        required: false,
+    },
+    base: {
+        aliases: ['from', 'coin'],
+        type: 'string',
+        description: 'The symbol of symbols of the currency to query',
+        required: false,
+    },
+    quote: {
+        aliases: ['to', 'market'],
+        type: 'string',
+        description: 'The symbol of the currency to convert to',
+        required: true,
+    },
+};
 const buildBatchedRequestBody = (params, config) => {
     return {
         baseURL: config.API_KEY ? config_1.PRO_API_ENDPOINT : config_1.DEFAULT_API_ENDPOINT,

package/examples/coingecko/src/endpoint/coins.d.ts

@@ -0,0 +1,9 @@
+import { AdapterEndpoint } from '../../../../../src/adapter';
+import { InputParameters } from '../../../../../src/validation';
+export declare const inputParameters: InputParameters;
+export interface CoinsResponse {
+    id: string;
+    symbol: string;
+    name: string;
+}
+export declare const endpoint: AdapterEndpoint<import("../../../../util/request").AdapterRequestData, CoinsResponse[], import("../../../../config").SettingsMap>;

package/examples/coingecko/src/endpoint/coins.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.endpoint = exports.inputParameters = void 0;
+const adapter_1 = require("../../../../../src/adapter");
 const transports_1 = require("../../../../../src/transports");
 const config_1 = require("../config");
 exports.inputParameters = {};
@@ -26,8 +27,8 @@ const restEndpointTransport = new transports_1.RestTransport({
         coalescing: true,
     },
 });
-exports.endpoint = {
+exports.endpoint = new adapter_1.AdapterEndpoint({
     name: 'coins',
     transport: restEndpointTransport,
     inputParameters: exports.inputParameters,
-};
+});

package/examples/coingecko/src/endpoint/crypto-marketcap.d.ts

@@ -0,0 +1,3 @@
+import { AdapterEndpoint } from '../../../../adapter';
+import { CryptoRequestParams } from '../cryptoUtils';
+export declare const endpoint: AdapterEndpoint<CryptoRequestParams, unknown, import("../../../../config").SettingsMap>;

package/examples/coingecko/src/endpoint/crypto-marketcap.js

@@ -1,26 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.endpoint = exports.inputParameters = void 0;
+exports.endpoint = void 0;
+const adapter_1 = require("../../../../adapter");
 const batch_warming_1 = require("../../../../transports/batch-warming");
-const input_params_1 = require("../../../../validation/input-params");
 const cryptoUtils_1 = require("../cryptoUtils");
-exports.inputParameters = {
-    overrides: input_params_1.baseInputParameters['overrides'],
-    coinid: {
-        description: 'The CoinGecko id or to query',
-        required: false,
-    },
-    base: {
-        aliases: ['from', 'coin'],
-        description: 'The symbol of symbols of the currency to query',
-        required: false,
-    },
-    quote: {
-        aliases: ['to', 'market'],
-        description: 'The symbol of the currency to convert to',
-        required: true,
-    },
-};
 const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
     prepareRequest: (params, context) => {
         const requestBody = (0, cryptoUtils_1.buildBatchedRequestBody)(params, context.adapterConfig);
@@ -38,9 +21,9 @@ const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
         return entries;
     },
 });
-exports.endpoint = {
+exports.endpoint = new adapter_1.AdapterEndpoint({
     name: 'marketcap',
     aliases: ['crypto-marketcap'],
     transport: batchEndpointTransport,
-    inputParameters: exports.inputParameters,
-};
+    inputParameters: cryptoUtils_1.cryptoInputParams,
+});

package/examples/coingecko/src/endpoint/crypto-volume.d.ts

@@ -0,0 +1,3 @@
+import { AdapterEndpoint } from '../../../../adapter';
+import { CryptoRequestParams } from '../cryptoUtils';
+export declare const endpoint: AdapterEndpoint<CryptoRequestParams, unknown, import("../../../../config").SettingsMap>;

package/examples/coingecko/src/endpoint/crypto-volume.js

@@ -1,26 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.endpoint = exports.inputParameters = void 0;
+exports.endpoint = void 0;
+const adapter_1 = require("../../../../adapter");
 const batch_warming_1 = require("../../../../transports/batch-warming");
-const input_params_1 = require("../../../../validation/input-params");
 const cryptoUtils_1 = require("../cryptoUtils");
-exports.inputParameters = {
-    overrides: input_params_1.baseInputParameters['overrides'],
-    coinid: {
-        description: 'The CoinGecko id or to query',
-        required: false,
-    },
-    base: {
-        aliases: ['from', 'coin'],
-        description: 'The symbol of symbols of the currency to query',
-        required: false,
-    },
-    quote: {
-        aliases: ['to', 'market'],
-        description: 'The symbol of the currency to convert to',
-        required: true,
-    },
-};
 const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
     prepareRequest: (params, context) => {
         const requestBody = (0, cryptoUtils_1.buildBatchedRequestBody)(params, context.adapterConfig);
@@ -38,9 +21,9 @@ const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
         return entries;
     },
 });
-exports.endpoint = {
+exports.endpoint = new adapter_1.AdapterEndpoint({
     name: 'volume',
     aliases: ['crypto-volume'],
     transport: batchEndpointTransport,
-    inputParameters: exports.inputParameters,
-};
+    inputParameters: cryptoUtils_1.cryptoInputParams,
+});

package/examples/coingecko/src/endpoint/crypto.d.ts

@@ -0,0 +1,3 @@
+import { AdapterEndpoint } from '../../../../adapter';
+import { CryptoRequestParams } from '../cryptoUtils';
+export declare const endpoint: AdapterEndpoint<CryptoRequestParams, unknown, import("../../../../config").SettingsMap>;

package/examples/coingecko/src/endpoint/crypto.js

@@ -1,26 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.endpoint = exports.inputParameters = void 0;
+exports.endpoint = void 0;
+const adapter_1 = require("../../../../adapter");
 const batch_warming_1 = require("../../../../transports/batch-warming");
-const input_params_1 = require("../../../../validation/input-params");
 const cryptoUtils_1 = require("../cryptoUtils");
-exports.inputParameters = {
-    overrides: input_params_1.baseInputParameters['overrides'],
-    coinid: {
-        description: 'The CoinGecko id or to query',
-        required: false,
-    },
-    base: {
-        aliases: ['from', 'coin'],
-        description: 'The symbol of symbols of the currency to query',
-        required: false,
-    },
-    quote: {
-        aliases: ['to', 'market'],
-        description: 'The symbol of the currency to convert to',
-        required: true,
-    },
-};
 const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
     prepareRequest: (params, context) => {
         return (0, cryptoUtils_1.buildBatchedRequestBody)(params, context.adapterConfig);
@@ -29,9 +12,6 @@ const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
         const entries = [];
         for (const requestPayload of params) {
             const entry = (0, cryptoUtils_1.constructEntry)(res, requestPayload, requestPayload.quote.toLowerCase());
-            // NOTE: the `entries` array is going to be shorter than the `params` array if one of the params has a bad token.
-            // Is that okay?  I did this to avoid caching an invalid value for transient DP issues.  Just want to make
-            // sure this works within the core framework
             if (entry) {
                 entries.push(entry);
             }
@@ -39,9 +19,9 @@ const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
         return entries;
     },
 });
-exports.endpoint = {
+exports.endpoint = new adapter_1.AdapterEndpoint({
     name: 'crypto',
     aliases: ['crypto-batched', 'batched', 'batch'],
     transport: batchEndpointTransport,
-    inputParameters: exports.inputParameters,
-};
+    inputParameters: cryptoUtils_1.cryptoInputParams,
+});

package/examples/coingecko/src/endpoint/dominance.d.ts

@@ -0,0 +1,3 @@
+import { AdapterEndpoint } from '../../../../adapter';
+import { AdapterRequestParams } from '../globalUtils';
+export declare const endpoint: AdapterEndpoint<AdapterRequestParams, unknown, import("../../../../config").SettingsMap>;

package/examples/coingecko/src/endpoint/dominance.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.endpoint = void 0;
+const adapter_1 = require("../../../../adapter");
 const batch_warming_1 = require("../../../../transports/batch-warming");
 const globalUtils_1 = require("../globalUtils");
 const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
     prepareRequest: (params, context) => {
-        return (0, globalUtils_1.buildGlobalRequestBody)(context.adapterConfig);
+        return (0, globalUtils_1.buildGlobalRequestBody)(context.adapterConfig.API_KEY);
     },
     parseResponse: (params, res) => {
         const entries = [];
@@ -18,9 +19,9 @@ const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
         return entries;
     },
 });
-exports.endpoint = {
+exports.endpoint = new adapter_1.AdapterEndpoint({
     name: 'dominance',
     aliases: ['market_cap_percentage'],
     transport: batchEndpointTransport,
     inputParameters: globalUtils_1.inputParameters,
-};
+});

package/examples/coingecko/src/endpoint/global-marketcap.d.ts

@@ -0,0 +1,3 @@
+import { AdapterEndpoint } from '../../../../adapter';
+import { AdapterRequestParams } from '../globalUtils';
+export declare const endpoint: AdapterEndpoint<AdapterRequestParams, unknown, import("../../../../config").SettingsMap>;

package/examples/coingecko/src/endpoint/global-marketcap.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.endpoint = void 0;
+const adapter_1 = require("../../../../adapter");
 const batch_warming_1 = require("../../../../transports/batch-warming");
 const globalUtils_1 = require("../globalUtils");
 const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
     prepareRequest: (params, context) => {
-        return (0, globalUtils_1.buildGlobalRequestBody)(context.adapterConfig);
+        return (0, globalUtils_1.buildGlobalRequestBody)(context.adapterConfig.API_KEY);
     },
     parseResponse: (params, res) => {
         const entries = [];
@@ -18,9 +19,9 @@ const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
         return entries;
     },
 });
-exports.endpoint = {
+exports.endpoint = new adapter_1.AdapterEndpoint({
     name: 'globalmarketcap',
     aliases: ['total_market_cap'],
     transport: batchEndpointTransport,
     inputParameters: globalUtils_1.inputParameters,
-};
+});

package/examples/coingecko/src/endpoint/index.d.ts

@@ -0,0 +1,6 @@
+export { endpoint as coins } from './coins';
+export { endpoint as crypto } from './crypto';
+export { endpoint as cryptoMarketcap } from './crypto-marketcap';
+export { endpoint as globalMarketcap } from './global-marketcap';
+export { endpoint as dominance } from './dominance';
+export { endpoint as cryptoVolume } from './crypto-volume';

package/examples/coingecko/src/globalUtils.d.ts

@@ -0,0 +1,27 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { InputParameters } from '../../../validation';
+export declare const inputParameters: InputParameters;
+export interface AdapterRequestParams {
+    market: string;
+}
+export interface ProviderResponseBody {
+    data: {
+        active_cryptocurrencies: number;
+        upcoming_icos: number;
+        ongoing_icos: number;
+        ended_icos: number;
+        markets: number;
+        total_market_cap: Record<string, number>;
+        total_volume: Record<string, number>;
+        market_cap_percentage: Record<string, number>;
+        market_cap_change_percentage_24h_usd: number;
+        updated_at: number;
+    };
+}
+interface ResultEntry {
+    value: number;
+    params: AdapterRequestParams;
+}
+export declare const buildGlobalRequestBody: (apiKey?: string) => AxiosRequestConfig<never>;
+export declare const constructEntry: (res: AxiosResponse<ProviderResponseBody>, requestPayload: AdapterRequestParams, resultPath: 'total_market_cap' | 'market_cap_percentage') => ResultEntry | undefined;
+export {};

package/examples/coingecko/src/globalUtils.js

@@ -11,15 +11,14 @@ exports.inputParameters = {
         required: true,
     },
 };
-const buildGlobalRequestBody = (config) => {
-    const apiKey = {
-        x_cg_pro_api_key: config.API_KEY,
-    };
+const buildGlobalRequestBody = (apiKey) => {
     return {
-        baseURL: config.API_KEY ? config_1.PRO_API_ENDPOINT : config_1.DEFAULT_API_ENDPOINT,
+        baseURL: apiKey ? config_1.PRO_API_ENDPOINT : config_1.DEFAULT_API_ENDPOINT,
         url: '/global',
         method: 'GET',
-        params: apiKey,
+        params: {
+            x_cg_pro_api_key: apiKey,
+        },
     };
 };
 exports.buildGlobalRequestBody = buildGlobalRequestBody;
@@ -39,10 +38,9 @@ const constructEntry = (res, requestPayload, resultPath) => {
         logger.warn(`Data for "${requestPayload.market}" not found".`);
         return;
     }
-    const entry = {
+    return {
         params: requestPayload,
         value: result,
     };
-    return entry;
 };
 exports.constructEntry = constructEntry;

package/examples/coingecko/src/index.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+import { Adapter } from '../../../../src/adapter';
+export declare const adapter: Adapter<import("../../../config").SettingsMap>;
+export declare const server: () => Promise<import("fastify").FastifyInstance<import("fastify").RawServerDefault, import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> | undefined>;

package/examples/coingecko/src/index.js

@@ -3,12 +3,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.adapter = void 0;
+exports.server = exports.adapter = void 0;
+const __1 = require("../../..");
+const adapter_1 = require("../../../../src/adapter");
 const overrides_json_1 = __importDefault(require("./config/overrides.json"));
 const endpoint_1 = require("./endpoint");
-exports.adapter = {
+exports.adapter = new adapter_1.Adapter({
     defaultEndpoint: 'crypto',
     name: 'coingecko',
     endpoints: [endpoint_1.crypto, endpoint_1.coins, endpoint_1.cryptoMarketcap, endpoint_1.cryptoVolume, endpoint_1.dominance, endpoint_1.globalMarketcap],
     overrides: overrides_json_1.default['coingecko'],
-};
+});
+const server = () => (0, __1.expose)(exports.adapter);
+exports.server = server;

package/examples/coingecko-old/batch-warming.d.ts

@@ -0,0 +1,7 @@
+import { AdapterEndpoint } from '../../adapter';
+interface AdapterRequestParams {
+    base: string;
+    quote: string;
+}
+export declare const batchEndpoint: AdapterEndpoint<AdapterRequestParams, unknown, import("../../config").SettingsMap>;
+export {};

package/examples/coingecko-old/index.d.ts

@@ -0,0 +1,2 @@
+import { Adapter } from '../../adapter';
+export declare const adapter: Adapter<import("../../config").SettingsMap>;

package/examples/coingecko-old/rest.d.ts

@@ -0,0 +1,12 @@
+import { AdapterEndpoint } from '../../adapter';
+interface AdapterRequestParams {
+    base: string;
+    quote: string;
+}
+interface ProviderResponseBody {
+    [base: string]: {
+        [quote: string]: number;
+    };
+}
+export declare const restEndpoint: AdapterEndpoint<AdapterRequestParams, ProviderResponseBody, import("../../config").SettingsMap>;
+export {};

package/examples/ncfx/config/index.d.ts

@@ -0,0 +1,12 @@
+export declare const customSettings: {
+    readonly USERNAME: {
+        readonly description: "Username for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+    readonly PASSWORD: {
+        readonly description: "Password for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+};

package/examples/ncfx/index.d.ts

@@ -0,0 +1,13 @@
+import { Adapter } from '../../adapter';
+export declare const adapter: Adapter<{
+    readonly USERNAME: {
+        readonly description: "Username for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+    readonly PASSWORD: {
+        readonly description: "Password for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+}>;

package/examples/ncfx/websocket.d.ts

@@ -0,0 +1,47 @@
+import { AdapterEndpoint } from '../../adapter';
+import { WebSocketTransport } from '../../transports/websocket';
+import { InputParameters } from '../../validation';
+interface AdapterRequestParams {
+    base: string;
+    quote: string;
+}
+export declare const inputParameters: InputParameters;
+interface ProviderMessage {
+    timestamp: string;
+    currencyPair: string;
+    bid: number;
+    offer: number;
+    mid: number;
+    changes: [
+        {
+            period: string;
+            change: number;
+            percentage: number;
+        }
+    ];
+}
+export declare const websocketTransport: WebSocketTransport<AdapterRequestParams, ProviderMessage[], {
+    readonly USERNAME: {
+        readonly description: "Username for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+    readonly PASSWORD: {
+        readonly description: "Password for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+}>;
+export declare const webSocketEndpoint: AdapterEndpoint<AdapterRequestParams, unknown, {
+    readonly USERNAME: {
+        readonly description: "Username for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+    readonly PASSWORD: {
+        readonly description: "Password for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+}>;
+export {};

package/index.d.ts

@@ -0,0 +1,11 @@
+import { FastifyInstance } from 'fastify';
+import { Adapter, AdapterDependencies } from './adapter';
+/**
+ * Main function for the framework.
+ * Initializes config and dependencies, uses those to initialize Transports, and starts listening for requests.
+ *
+ * @param adapter - an object describing an External Adapter
+ * @param dependencies - an optional object with adapter dependencies to inject
+ * @returns a Promise that resolves to the http.Server listening for connections
+ */
+export declare const expose: (adapter: Adapter, dependencies?: Partial<AdapterDependencies>) => Promise<FastifyInstance | undefined>;