@chainlink/external-adapter-framework 0.15.1 → 0.16.0

package/util/request.d.ts

@@ -6,7 +6,7 @@ declare module 'fastify' {
         requestContext: AdapterRequestContext;
     }
 }
-export declare type Merge<T1, T2> = {
+export type Merge<T1, T2> = {
     [K in keyof T1 | keyof T2]: K extends keyof T2 ? T2[K] : K extends keyof T1 ? T1[K] : never;
 };
 /**
@@ -22,7 +22,7 @@ export interface AdapterRequestBody<T = AdapterRequestData> {
  * Object that will be added to the request on a successful validation.
  * Contains all the necessary information the adapter will need across the request execution.
  */
-export declare type AdapterRequestContext<T = AdapterRequestData> = {
+export type AdapterRequestContext<T = AdapterRequestData> = {
     /** Name of the endpoint this payload should be directed to */
     endpointName: string;
     /** Precalculated cache key used to get and set corresponding values from the cache and subscription sets */
@@ -35,18 +35,18 @@ export declare type AdapterRequestContext<T = AdapterRequestData> = {
 /**
  * Helper type to denote an empty body
  */
-declare type EmptyBody = Record<string, never>;
+type EmptyBody = Record<string, never>;
 /**
  * Helper type to provide fastify for all adapter handlers
  */
-export declare type AdapterRouteGeneric = {
+export type AdapterRouteGeneric = {
     /** Set to an empty record so the user does not access the raw request data and uses the Validated data from the context instead */
     Body: EmptyBody;
 };
 /**
  * Structure for all requests incoming to this adapter
  */
-export declare type AdapterRequest<T extends RequestGenerics = RequestGenerics> = FastifyRequest<AdapterRouteGeneric> & {
+export type AdapterRequest<T extends RequestGenerics = RequestGenerics> = FastifyRequest<AdapterRouteGeneric> & {
     /** Set to an empty record so the user does not access the raw request data and uses the Validated data from the context instead */
     body: EmptyBody;
     /** Container for all validated information that will be used by the framework across this request's lifecycle */
@@ -73,23 +73,23 @@ export interface AdapterMetricsMeta {
 /**
  * Basic shape for the data within the request body
  */
-export declare type AdapterRequestData = Record<string, unknown> & {
+export type AdapterRequestData = Record<string, unknown> & {
     endpoint?: string;
 };
-export declare type ProviderResultGenerics = {
+export type ProviderResultGenerics = {
     Request: RequestGenerics;
     Response: ResponseGenerics;
 };
 /**
  * Helper type to hold the value from responses from a provider, and the adapter params they correspond to.
  */
-export declare type ProviderResult<T extends ProviderResultGenerics> = {
+export type ProviderResult<T extends ProviderResultGenerics> = {
     /** The set of parameters that uniquely relate to the response */
     params: T['Request']['Params'];
     /** Value that will be included in the result property of the response */
     response: PartialAdapterResponse<T['Response']>;
 };
-export declare type TimestampedProviderResult<T extends ProviderResultGenerics> = Pick<ProviderResult<T>, 'params'> & {
+export type TimestampedProviderResult<T extends ProviderResultGenerics> = Pick<ProviderResult<T>, 'params'> & {
     /** Value that will be included in the result property of the response, with timestamps applied */
     response: TimestampedAdapterResponse<T['Response']>;
 };
@@ -97,11 +97,11 @@ export declare type TimestampedProviderResult<T extends ProviderResultGenerics>
  * Here we do actually want an object, since unknown could be a primitive.
  * The rule itself does say "marginally better"
  */
-export declare type EmptyObject = Object;
+export type EmptyObject = Object;
 /**
  * Helper struct type that provides detail about the incoming Adapter Request
  */
-export declare type RequestGenerics = {
+export type RequestGenerics = {
     /**
      * Type for the parameters sent to the EA in the data property of the body.
      */
@@ -110,7 +110,7 @@ export declare type RequestGenerics = {
 /**
  * Helper struct type that provides detail about the outgoing Adapter Response
  */
-export declare type ResponseGenerics = {
+export type ResponseGenerics = {
     /**
      * Type for the data property of the response.
      */
@@ -124,7 +124,7 @@ export declare type ResponseGenerics = {
 /**
  * Details for timestamps to be included in the response
  */
-export declare type ResponseTimestamps = {
+type ResponseTimestamps = {
     /** Time at which data was received from the provider */
     providerDataReceived: number;
     /** Time indicated by the provider representing the time at which this value was calculated/set/valid */
@@ -147,14 +147,14 @@ export declare type ResponseTimestamps = {
 /**
  * Object with timestamps that will be present in both successful and provider error responses
  */
-declare type TimestampedResponseObject = {
+type TimestampedResponseObject = {
     /** Timestamps relevant for data provider timings */
     timestamps: ResponseTimestamps;
 };
 /**
  * Response from the EA to send when manually storing an error in the cache
  */
-declare type ProviderErrorResponse = {
+type ProviderErrorResponse = {
     /** Status code for the errored response */
     statusCode: number;
     /** Error message that will be sent back from the adapter */
@@ -167,11 +167,11 @@ declare type ProviderErrorResponse = {
 /**
  * Provider error response with timestamps added
  */
-export declare type TimestampedProviderErrorResponse = ProviderErrorResponse & TimestampedResponseObject;
+export type TimestampedProviderErrorResponse = ProviderErrorResponse & TimestampedResponseObject;
 /**
  * The most basic data that needs to be manually set for an adapter response.
  */
-export declare type PartialSuccessfulResponse<T extends ResponseGenerics> = {
+export type PartialSuccessfulResponse<T extends ResponseGenerics> = {
     /** Response data, holds "result" for Flux Monitor */
     data: T['Data'];
     /** Result value used for OCR */
@@ -184,11 +184,11 @@ export declare type PartialSuccessfulResponse<T extends ResponseGenerics> = {
 /**
  * Partial EA response, with timestamps added
  */
-declare type TimestampedSuccessfulResponse<T extends ResponseGenerics> = PartialSuccessfulResponse<T> & TimestampedResponseObject;
+type TimestampedSuccessfulResponse<T extends ResponseGenerics> = PartialSuccessfulResponse<T> & TimestampedResponseObject;
 /**
  * Full EA successful response, with metadata and defaults added
  */
-declare type SuccessfulResponse<T extends ResponseGenerics> = TimestampedSuccessfulResponse<T> & {
+type SuccessfulResponse<T extends ResponseGenerics> = TimestampedSuccessfulResponse<T> & {
     /** Metadata relevant to this request */
     meta?: AdapterRequestMeta;
     /** HTTP status code, by default will be set to 200 */
@@ -197,21 +197,21 @@ declare type SuccessfulResponse<T extends ResponseGenerics> = TimestampedSuccess
 /**
  * Response body from the EA, before timestamps, defaults and metadata are filled in
  */
-export declare type PartialAdapterResponse<T extends ResponseGenerics = ResponseGenerics> = PartialSuccessfulResponse<T> | ProviderErrorResponse;
+export type PartialAdapterResponse<T extends ResponseGenerics = ResponseGenerics> = PartialSuccessfulResponse<T> | ProviderErrorResponse;
 /**
  * Response body from the EA with timestamps, before defaults and metadata are filled in
  */
-export declare type TimestampedAdapterResponse<T extends ResponseGenerics = ResponseGenerics> = TimestampedSuccessfulResponse<T> | TimestampedProviderErrorResponse;
+export type TimestampedAdapterResponse<T extends ResponseGenerics = ResponseGenerics> = TimestampedSuccessfulResponse<T> | TimestampedProviderErrorResponse;
 /**
  * Shape of the response body from the adapter
  */
-export declare type AdapterResponse<T extends ResponseGenerics = ResponseGenerics> = SuccessfulResponse<T> | TimestampedProviderErrorResponse;
-export declare type SingleNumberResultResponse = {
+export type AdapterResponse<T extends ResponseGenerics = ResponseGenerics> = SuccessfulResponse<T> | TimestampedProviderErrorResponse;
+export type SingleNumberResultResponse = {
     Result: number;
     Data: {
         result: number;
     };
 };
-export declare type Middleware = ((req: AdapterRequest, reply: FastifyReply, done: HookHandlerDoneFunction) => FastifyReply | void) | ((req: AdapterRequest, reply: FastifyReply) => Promise<FastifyReply | void>);
-export declare type AdapterMiddlewareBuilder = (adapter: Adapter) => Middleware;
+export type Middleware = ((req: AdapterRequest, reply: FastifyReply, done: HookHandlerDoneFunction) => FastifyReply | void) | ((req: AdapterRequest, reply: FastifyReply) => Promise<FastifyReply | void>);
+export type AdapterMiddlewareBuilder = (adapter: Adapter) => Middleware;
 export {};