@chainlink/external-adapter-framework 0.28.6 → 0.29.0

package/validation/input-params.d.ts

@@ -1,22 +1,201 @@
-import { ReservedInputParameterNames } from '../util';
+import { Overrides, ReservedInputParameterNames } from '../util';
+/**
+ * Type for the overrides object that is either hardcoded in the adapter,
+ * or present in the incoming request body
+ */
 export type Override = Map<string, Map<string, string>>;
-type ParameterType = 'bigint' | 'boolean' | 'array' | 'number' | 'object' | 'string';
-export type InputParameter = {
-    aliases?: readonly string[];
-    description?: string;
-    type?: ParameterType;
+/**
+ * Possible strings that correspond to types of primitive values
+ * that can be specified for an input parameter
+ */
+type PrimitiveParameterTypeString = 'boolean' | 'number' | 'string';
+/**
+ * Possible types for each of the possible type strings
+ */
+type PrimitiveParameterType = TypeFromTypeString<PrimitiveParameterTypeString>;
+/**
+ * All possible types for an input parameter (either a string, or a nested param definition)
+ */
+type ParameterType = PrimitiveParameterTypeString | InputParametersDefinition;
+/**
+ * Given a type parameter T that is a parameter type (string or nested definition),
+ * equals to the corresponding type for that type string or definition
+ */
+type TypeFromTypeString<T extends ParameterType> = T extends 'string' ? string : T extends 'number' ? number : T extends 'boolean' ? boolean : T extends InputParametersDefinition ? TypeFromDefinition<T> : never;
+/**
+ * Util type to be able to discern exactly if a generic is exactly unknown
+ * (because everything extends unknown, but unknown only extends itself)
+ */
+type IsUnknown<T> = unknown extends T ? true : false;
+/**
+ * Given a concrete InputParameter P, results in the type for that definition taking into account
+ * the required property of the definition (i.e. makes it optional or not)
+ */
+type ShouldBeUndefinable<P extends InputParameter, T = TypeFromTypeString<P['type']>> = P['required'] extends true ? T : IsUnknown<P['default']> extends true ? T | undefined : T;
+/**
+ * Just an alias to make types below more readable
+ */
+type NonArrayInputType<P extends InputParameter> = ShouldBeUndefinable<P>;
+/**
+ * Given an InputParameter P, results in the corresponding type for that definition,
+ * accounting for configurations like required, array, defaults, etc.
+ */
+type TypeFromParameter<P extends InputParameter, T = TypeFromTypeString<P['type']>> = P['array'] extends true ? T[] : NonArrayInputType<P>;
+/**
+ * Constraint for an InputParameter to make sure options are only specified for parameters of type string.
+ * All these constraints, for them to work properly, should represent the entire closed realm of possibilities.
+ * That is, there should be no possible input parameter that the constraint doesn't accept one way or the other.
+ */
+type InputParameterOptionConstraints = {
+    type: 'string';
+    options?: string[] | readonly string[];
+} | {
+    type: 'number';
+    options?: number[] | readonly number[];
+} | {
+    type: Exclude<ParameterType, 'string' | 'number'>;
+    options?: never;
+};
+/**
+ * Constraint to make sure input parameter defaults match their type, and that
+ * defaults are only allowed for primitive types
+ */
+type InputParameterDefaultTypeConstraints = {
+    type: 'string';
+    default?: string;
+} | {
+    type: 'number';
+    default?: number;
+} | {
+    type: 'boolean';
+    default?: boolean;
+} | {
+    type: Exclude<ParameterType, 'string' | 'number' | 'boolean'>;
+    default?: never;
+};
+/**
+ * Constraint to avoid unnecessary or impossible required and default combinations
+ */
+type InputParameterDefaultRequiredConstraints = {
+    required: true;
+    default?: never;
+} | {
+    required?: false;
+    default?: PrimitiveParameterType;
+};
+/**
+ * Constraint to make sure array input parameters don't specify a default
+ */
+type InputParameterArrayDefaultConstraints = {
+    array: true;
+    default?: never;
+} | {
+    array?: false;
+    default?: PrimitiveParameterType;
+};
+/**
+ * Basic structure for an InputParameter.
+ * The concrete possible types that will be used in a definition can be found below this one.
+ * (they are split into several types due to existential types not being supported)
+ */
+type BaseInputParameter = {
+    description: string;
+    type: ParameterType;
+    default?: PrimitiveParameterType;
     required?: boolean;
-    options?: unknown[];
-    default?: unknown;
+    array?: boolean;
+    options?: string[] | readonly string[] | number | readonly number[];
+    aliases?: readonly string[];
     dependsOn?: readonly string[];
     exclusive?: readonly string[];
 };
-export type InputParameters = {
-    [name: string]: InputParameter;
-} & {
+/**
+ * Type for the definition of one InputParameter.
+ * This is built from the base type, intersected with a bunch of constraints.
+ */
+export type InputParameter = BaseInputParameter & InputParameterOptionConstraints & InputParameterDefaultTypeConstraints & InputParameterDefaultRequiredConstraints & InputParameterArrayDefaultConstraints;
+/**
+ * Map of input names to their corresponding definition.
+ */
+export type InputParametersDefinition = Record<string, InputParameter>;
+/**
+ * Constrains the InputParametersDefinition to exclude reserved param names.
+ */
+type ProperInputParametersDefinition = InputParametersDefinition & {
     [K in ReservedInputParameterNames]?: never;
 };
-export type SpecificInputParameters<T> = {
-    [K in keyof T]: InputParameter;
+/**
+ * Given an input parameter definition, results in the type for the actual params object.
+ */
+export type TypeFromDefinition<T extends InputParametersDefinition> = {
+    -readonly [K in keyof T]: TypeFromParameter<T[K]>;
 };
+/**
+ * Util type to represent the absence of input parameters for an adapter endpoint.
+ */
+export type EmptyInputParameters = InputParametersDefinition;
+/**
+ * This class encapsulates logic for a single input parameter, taking its definition
+ * and performing validations (both on the definition on construction, and params when prompted).
+ */
+declare class ProcessedParam<const T extends InputParameter = InputParameter> {
+    name: string;
+    definition: T;
+    /** List of aliases for this processed parameter, including the original parameter name */
+    aliases: string[];
+    /** Set of all possible options for this parameter (used when validating inputs) */
+    options?: Set<TypeFromParameter<T>>;
+    /** Definition for the type of this parameter */
+    type: PrimitiveParameterTypeString | InputParameters<InputParametersDefinition>;
+    constructor(name: string, definition: T);
+    /** Util method to throw a definition error prefixed with this param name */
+    private definitionError;
+    /** Util method to throw a validation error prefixed with this param name */
+    private validationError;
+    /**
+     * Validates the definition that this parameter has been constructed with.
+     */
+    private validateDefinition;
+    /**
+     * Validates an incoming adapter request's input params and
+     * performs all necessary checks and modifications.
+     *
+     * @param input - the input data from an incoming adapter request
+     * @returns - the validated data
+     */
+    validateInput(input: unknown): unknown;
+    /**
+     * Validates a single value from the incoming params.
+     *
+     * @param input - a single value from the request params object
+     * @returns - the validated input data
+     */
+    private validateInputType;
+}
+export declare class InputParameters<const T extends ProperInputParametersDefinition> {
+    definition: T;
+    params: ProcessedParam[];
+    constructor(definition: T);
+    /**
+     * Validates the entire definitions object provided to the constructor.
+     */
+    private validateDefinition;
+    /**
+     * Validates an incoming adapter request's input params and
+     * performs all necessary checks and modifications.
+     *
+     * @param input - the input data from an incoming adapter request
+     * @returns - the validated data
+     */
+    validateInput(rawData: unknown): TypeFromDefinition<T>;
+}
+/**
+ * Validates that the overrides object in a request (if present) is correct.
+ *
+ * @param input - a request's input data, which may contain overrides
+ * @returns nothing, only throws if an error is found
+ */
+export declare const validateOverrides: (input: {
+    overrides?: Overrides;
+}) => void;
 export {};

package/validation/input-params.js

@@ -1,3 +1,229 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateOverrides = exports.InputParameters = void 0;
+const util_1 = require("../util");
+const error_1 = require("./error");
+/**
+ * Error thrown when the validation of a request's params fails.
+ */
+class InputValidationError extends error_1.AdapterError {
+    constructor(message) {
+        super({
+            statusCode: 400,
+            message,
+        });
+    }
+}
+/**
+ * Error thrown when the validation of the input parameters definition fails.
+ */
+class InputParametersDefinitionError extends Error {
+}
+/**
+ * This class encapsulates logic for a single input parameter, taking its definition
+ * and performing validations (both on the definition on construction, and params when prompted).
+ */
+class ProcessedParam {
+    constructor(name, definition) {
+        this.name = name;
+        this.definition = definition;
+        this.aliases = [this.name, ...(this.definition.aliases || [])];
+        this.type =
+            typeof definition.type === 'object' ? new InputParameters(definition.type) : definition.type;
+        if (definition.options) {
+            this.options = new Set(definition.options);
+        }
+        this.validateDefinition();
+    }
+    /** Util method to throw a definition error prefixed with this param name */
+    definitionError(message) {
+        return new InputParametersDefinitionError(`[Param: ${this.name}] ${message}`);
+    }
+    /** Util method to throw a validation error prefixed with this param name */
+    validationError(message) {
+        return new InputValidationError(`[Param: ${this.name}] ${message}`);
+    }
+    /**
+     * Validates the definition that this parameter has been constructed with.
+     */
+    validateDefinition() {
+        // Check that there are no repeated aliases
+        if ((0, util_1.hasRepeatedValues)(this.aliases)) {
+            throw this.definitionError(`There are repeated aliases for input param ${this.name}: ${this.aliases}`);
+        }
+        // Check that if options are specified it has at least one entry
+        if (this.definition.options?.length === 0) {
+            throw this.definitionError(`The options array must contain at least one option`);
+        }
+        // Check that there are no repeated options
+        if (this.options && this.definition.options?.length !== this.options.size) {
+            throw this.definitionError(`There are duplicates in the specified options: ${this.definition.options}`);
+        }
+    }
+    /**
+     * Validates an incoming adapter request's input params and
+     * performs all necessary checks and modifications.
+     *
+     * @param input - the input data from an incoming adapter request
+     * @returns - the validated data
+     */
+    validateInput(input) {
+        if (this.definition.required && input == null) {
+            throw this.validationError('param is required but no value was provided');
+        }
+        if (this.definition.default && input == null) {
+            return this.definition.default;
+        }
+        if (this.definition.array) {
+            if (!(Array.isArray(input) && input.length >= 0)) {
+                if (this.definition.required || input != null) {
+                    throw this.validationError('input value must be a non-empty array');
+                }
+                else {
+                    return [];
+                }
+            }
+            // Validate each value from the array individually
+            return input.map((item) => this.validateInputType(item));
+        }
+        // We already know this won't be an array, but the generics are too complex for typescript
+        // to infer by itself so we cast manually
+        return this.validateInputType(input);
+    }
+    /**
+     * Validates a single value from the incoming params.
+     *
+     * @param input - a single value from the request params object
+     * @returns - the validated input data
+     */
+    validateInputType(input) {
+        // If we're here we've already checked this is not required
+        if (input == null) {
+            return;
+        }
+        // If the type is a nested input params object, use that to validate
+        if (this.type instanceof InputParameters) {
+            return this.type.validateInput(input);
+        }
+        // If the param has specified options, check that the input is one of them.
+        // In this case we don't need to check the type, since the options will do that for us
+        if (this.options && !this.options.has(input)) {
+            throw this.validationError(`input is not one of valid options (${this.definition.options})`);
+        }
+        else if (typeof input !== this.definition.type) {
+            throw this.validationError(`input type is not the expected one (${this.type})`);
+        }
+        // If no validations failed and no defaults / modifications were applied, use the original input
+        return input;
+    }
+}
+class InputParameters {
+    constructor(definition) {
+        this.definition = definition;
+        this.params = Object.entries(this.definition).map(([name, param]) => new ProcessedParam(name, param));
+        // Check that all options match param type
+        // Check that defaults matches param validation
+        this.validateDefinition();
+    }
+    /**
+     * Validates the entire definitions object provided to the constructor.
+     */
+    validateDefinition() {
+        const paramNames = new Set(this.params.map((p) => p.name));
+        // Check that aliases don't clash with other properties
+        if ((0, util_1.hasRepeatedValues)(this.params.map((p) => p.aliases).flat())) {
+            throw new InputParametersDefinitionError('There are clashes in property names and aliases, check that they are all unique');
+        }
+        for (const param of this.params) {
+            // Check that all dependencies reference valid options
+            for (const dependency of param.definition.dependsOn || []) {
+                if (!paramNames.has(dependency)) {
+                    throw new InputParametersDefinitionError(`Param "${param.name}" depends on non-existent param "${dependency}"`);
+                }
+                if (this.definition[dependency].required) {
+                    throw new InputParametersDefinitionError(`Param "${param.name}" has an unnecessary dependency on "${dependency}" (dependency is always required)`);
+                }
+            }
+            for (const exclusion of param.definition.exclusive || []) {
+                if (!paramNames.has(exclusion)) {
+                    throw new InputParametersDefinitionError(`Param "${param.name}" excludes non-existent param "${exclusion}"`);
+                }
+                if (this.definition[exclusion].required) {
+                    throw new InputParametersDefinitionError(`Param "${param.name}" excludes required (i.e. always present) param "${exclusion}"`);
+                }
+            }
+        }
+    }
+    /**
+     * Validates an incoming adapter request's input params and
+     * performs all necessary checks and modifications.
+     *
+     * @param input - the input data from an incoming adapter request
+     * @returns - the validated data
+     */
+    validateInput(rawData) {
+        if (typeof rawData !== 'object' || rawData == null) {
+            throw new InputValidationError('Input for input parameters should be an object');
+        }
+        const data = rawData;
+        const validated = {};
+        // Validate each param individually
+        for (const param of this.params) {
+            let value;
+            for (const alias of param.aliases) {
+                if (data[alias] == null) {
+                    continue;
+                }
+                if (value) {
+                    throw new InputValidationError(`Parameter "${param.name}" is specified more than once (aliases: ${param.aliases})`);
+                }
+                value = data[alias];
+            }
+            // Perform all validations for the individual param value
+            validated[param.name] = param.validateInput(value);
+        }
+        // We iterate again, now with the complete validated obj to check for dependencies and exclusions
+        for (const param of this.params) {
+            if (validated[param.name] == null) {
+                continue;
+            }
+            if (param.definition.dependsOn?.some((d) => validated[d] == null)) {
+                throw new InputValidationError(`Parameter "${param.name}" is missing dependencies (${param.definition.dependsOn})`);
+            }
+            if (param.definition.exclusive?.some((d) => validated[d] != null)) {
+                throw new InputValidationError(`Parameter "${param.name}" cannot be present at the same time as exclusions (${param.definition.exclusive})`);
+            }
+        }
+        return validated;
+    }
+}
+exports.InputParameters = InputParameters;
+/**
+ * Validates that the overrides object in a request (if present) is correct.
+ *
+ * @param input - a request's input data, which may contain overrides
+ * @returns nothing, only throws if an error is found
+ */
+const validateOverrides = (input) => {
+    if (!input.overrides) {
+        // Nothing to validate!
+        return;
+    }
+    if (typeof input.overrides !== 'object') {
+        throw new InputValidationError('Overrides should be an object');
+    }
+    for (const adapterName in input.overrides) {
+        const overrides = input.overrides[adapterName];
+        if (typeof overrides !== 'object') {
+            throw new InputValidationError(`Overrides for adapter "${adapterName}" should be an object`);
+        }
+        for (const symbol in overrides) {
+            const override = overrides[symbol];
+            if (typeof symbol !== 'string' || typeof override !== 'string') {
+                throw new InputValidationError(`Overrides should map strings to strings, got ${symbol} to ${override}`);
+            }
+        }
+    }
+};
+exports.validateOverrides = validateOverrides;
 //# sourceMappingURL=input-params.js.map

package/validation/input-params.js.map

@@ -1 +1 @@
-{"version":3,"file":"input-params.js","sourceRoot":"","sources":["../../../src/validation/input-params.ts"],"names":[],"mappings":""}
+{"version":3,"file":"input-params.js","sourceRoot":"","sources":["../../../src/validation/input-params.ts"],"names":[],"mappings":";;;AAAA,kCAAmF;AACnF,mCAAsC;AA+LtC;;GAEG;AACH,MAAM,oBAAqB,SAAQ,oBAAY;IAC7C,YAAY,OAAe;QACzB,KAAK,CAAC;YACJ,UAAU,EAAE,GAAG;YACf,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;CACF;AAED;;GAEG;AACH,MAAM,8BAA+B,SAAQ,KAAK;CAAG;AAErD;;;GAGG;AACH,MAAM,cAAc;IAUlB,YAAmB,IAAY,EAAS,UAAa;QAAlC,SAAI,GAAJ,IAAI,CAAQ;QAAS,eAAU,GAAV,UAAU,CAAG;QACnD,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAA;QAC9D,IAAI,CAAC,IAAI;YACP,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAA;QAE9F,IAAI,UAAU,CAAC,OAAO,EAAE;YACtB,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,OAAiC,CAAC,CAAA;SACrE;QAED,IAAI,CAAC,kBAAkB,EAAE,CAAA;IAC3B,CAAC;IAED,4EAA4E;IACpE,eAAe,CAAC,OAAe;QACrC,OAAO,IAAI,8BAA8B,CAAC,WAAW,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC,CAAA;IAC/E,CAAC;IAED,4EAA4E;IACpE,eAAe,CAAC,OAAe;QACrC,OAAO,IAAI,oBAAoB,CAAC,WAAW,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC,CAAA;IACrE,CAAC;IAED;;OAEG;IACK,kBAAkB;QACxB,2CAA2C;QAC3C,IAAI,IAAA,wBAAiB,EAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACnC,MAAM,IAAI,CAAC,eAAe,CACxB,8CAA8C,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,EAAE,CAC3E,CAAA;SACF;QAED,gEAAgE;QAChE,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,KAAK,CAAC,EAAE;YACzC,MAAM,IAAI,CAAC,eAAe,CAAC,oDAAoD,CAAC,CAAA;SACjF;QAED,2CAA2C;QAC3C,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;YACzE,MAAM,IAAI,CAAC,eAAe,CACxB,kDAAkD,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAC5E,CAAA;SACF;IACH,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,KAAc;QAC1B,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,KAAK,IAAI,IAAI,EAAE;YAC7C,MAAM,IAAI,CAAC,eAAe,CAAC,6CAA6C,CAAC,CAAA;SAC1E;QAED,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,KAAK,IAAI,IAAI,EAAE;YAC5C,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAA;SAC/B;QAED,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE;YACzB,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,EAAE;gBAChD,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,KAAK,IAAI,IAAI,EAAE;oBAC7C,MAAM,IAAI,CAAC,eAAe,CAAC,uCAAuC,CAAC,CAAA;iBACpE;qBAAM;oBACL,OAAO,EAAE,CAAA;iBACV;aACF;YAED,kDAAkD;YAClD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAA;SACzD;QAED,0FAA0F;QAC1F,yCAAyC;QACzC,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAA+B,CAAC,CAAA;IAChE,CAAC;IAED;;;;;OAKG;IACK,iBAAiB,CAAC,KAA2B;QACnD,2DAA2D;QAC3D,IAAI,KAAK,IAAI,IAAI,EAAE;YACjB,OAAM;SACP;QAED,oEAAoE;QACpE,IAAI,IAAI,CAAC,IAAI,YAAY,eAAe,EAAE;YACxC,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;SACtC;QAED,2EAA2E;QAC3E,sFAAsF;QACtF,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAA6B,CAAC,EAAE;YACpE,MAAM,IAAI,CAAC,eAAe,CAAC,sCAAsC,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,CAAC,CAAA;SAC7F;aAAM,IAAI,OAAO,KAAK,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YAChD,MAAM,IAAI,CAAC,eAAe,CAAC,uCAAuC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAA;SAChF;QAED,gGAAgG;QAChG,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,MAAa,eAAe;IAG1B,YAAmB,UAAa;QAAb,eAAU,GAAV,UAAU,CAAG;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,CAC/C,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,IAAI,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CACnD,CAAA;QAED,0CAA0C;QAC1C,+CAA+C;QAC/C,IAAI,CAAC,kBAAkB,EAAE,CAAA;IAC3B,CAAC;IAED;;OAEG;IACK,kBAAkB;QACxB,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;QAE1D,uDAAuD;QACvD,IAAI,IAAA,wBAAiB,EAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE;YAC/D,MAAM,IAAI,8BAA8B,CACtC,iFAAiF,CAClF,CAAA;SACF;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;YAC/B,sDAAsD;YACtD,KAAK,MAAM,UAAU,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,IAAI,EAAE,EAAE;gBACzD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;oBAC/B,MAAM,IAAI,8BAA8B,CACtC,UAAU,KAAK,CAAC,IAAI,oCAAoC,UAAU,GAAG,CACtE,CAAA;iBACF;gBACD,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE;oBACxC,MAAM,IAAI,8BAA8B,CACtC,UAAU,KAAK,CAAC,IAAI,uCAAuC,UAAU,mCAAmC,CACzG,CAAA;iBACF;aACF;YAED,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,IAAI,EAAE,EAAE;gBACxD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;oBAC9B,MAAM,IAAI,8BAA8B,CACtC,UAAU,KAAK,CAAC,IAAI,kCAAkC,SAAS,GAAG,CACnE,CAAA;iBACF;gBACD,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE;oBACvC,MAAM,IAAI,8BAA8B,CACtC,UAAU,KAAK,CAAC,IAAI,oDAAoD,SAAS,GAAG,CACrF,CAAA;iBACF;aACF;SACF;IACH,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,OAAgB;QAC5B,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,IAAI,IAAI,EAAE;YAClD,MAAM,IAAI,oBAAoB,CAAC,gDAAgD,CAAC,CAAA;SACjF;QAED,MAAM,IAAI,GAAG,OAAkC,CAAA;QAC/C,MAAM,SAAS,GAA4B,EAAE,CAAA;QAE7C,mCAAmC;QACnC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;YAC/B,IAAI,KAAc,CAAA;YAClB,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,OAAO,EAAE;gBACjC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE;oBACvB,SAAQ;iBACT;gBACD,IAAI,KAAK,EAAE;oBACT,MAAM,IAAI,oBAAoB,CAC5B,cAAc,KAAK,CAAC,IAAI,2CAA2C,KAAK,CAAC,OAAO,GAAG,CACpF,CAAA;iBACF;gBACD,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;aACpB;YAED,yDAAyD;YACzD,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;SACnD;QAED,iGAAiG;QACjG,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;YAC/B,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE;gBACjC,SAAQ;aACT;YAED,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,EAAE;gBACjE,MAAM,IAAI,oBAAoB,CAC5B,cAAc,KAAK,CAAC,IAAI,8BAA8B,KAAK,CAAC,UAAU,CAAC,SAAS,GAAG,CACpF,CAAA;aACF;YAED,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,EAAE;gBACjE,MAAM,IAAI,oBAAoB,CAC5B,cAAc,KAAK,CAAC,IAAI,uDAAuD,KAAK,CAAC,UAAU,CAAC,SAAS,GAAG,CAC7G,CAAA;aACF;SACF;QAED,OAAO,SAAkC,CAAA;IAC3C,CAAC;CACF;AA/GD,0CA+GC;AAED;;;;;GAKG;AACI,MAAM,iBAAiB,GAAG,CAAC,KAAgC,EAAE,EAAE;IACpE,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;QACpB,uBAAuB;QACvB,OAAM;KACP;IAED,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,EAAE;QACvC,MAAM,IAAI,oBAAoB,CAAC,+BAA+B,CAAC,CAAA;KAChE;IAED,KAAK,MAAM,WAAW,IAAI,KAAK,CAAC,SAAS,EAAE;QACzC,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA;QAC9C,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACjC,MAAM,IAAI,oBAAoB,CAAC,0BAA0B,WAAW,uBAAuB,CAAC,CAAA;SAC7F;QAED,KAAK,MAAM,MAAM,IAAI,SAAS,EAAE;YAC9B,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;YAClC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;gBAC9D,MAAM,IAAI,oBAAoB,CAC5B,gDAAgD,MAAM,OAAO,QAAQ,EAAE,CACxE,CAAA;aACF;SACF;KACF;AACH,CAAC,CAAA;AAzBY,QAAA,iBAAiB,qBAyB7B"}

package/validation/utils.d.ts

@@ -5,13 +5,12 @@ export declare const validator: {
     integer: (params?: {
         min?: number;
         max?: number;
-    }) => Validator<string | number>;
-    positiveInteger: () => Validator<string | number>;
-    port: () => Validator<string | number>;
+    }) => Validator<number>;
+    positiveInteger: () => Validator<number>;
+    port: () => Validator<number>;
     url: () => Validator<string>;
     host: () => Validator<string>;
-    object: () => (value: Record<string, unknown>) => "Value is not valid object." | undefined;
-    responseTimestamp: () => Validator<string | number>;
+    responseTimestamp: () => Validator<number>;
     base64: () => Validator<string>;
-    compose: (f: Validator<string | number>[]) => Validator<number | string>;
+    compose: <T>(f: Validator<T>[]) => Validator<T>;
 };

package/validation/utils.js

@@ -24,7 +24,7 @@ const _integer = () => {
 };
 const positive = () => {
     return (value) => {
-        if (value !== undefined && value < 0) {
+        if (value !== undefined && Number(value) < 0) {
             return `Value should be positive number, Received ${value}`;
         }
         return;
@@ -32,7 +32,7 @@ const positive = () => {
 };
 const minNumber = (param) => {
     return (value) => {
-        if (value !== undefined && value < param) {
+        if (value !== undefined && Number(value) < param) {
             return `Minimum allowed value is ${param}. Received ${value}`;
         }
         return;
@@ -40,7 +40,7 @@ const minNumber = (param) => {
 };
 const maxNumber = (param) => {
     return (value) => {
-        if (value !== undefined && value > param) {
+        if (value !== undefined && Number(value) > param) {
             return `Maximum allowed value is ${param}. Received ${value}`;
         }
         return;
@@ -66,15 +66,6 @@ const host = () => {
         return;
     };
 };
-const object = () => {
-    return (value) => {
-        const isObject = typeof value === 'object' && value !== null;
-        if (!isObject) {
-            return `Value is not valid object.`;
-        }
-        return;
-    };
-};
 const positiveInteger = () => compose([_integer(), positive()]);
 const integer = (params) => {
     const validators = [_integer()];
@@ -87,8 +78,8 @@ const integer = (params) => {
     return compose(validators);
 };
 const port = () => integer({ min: 1, max: 65535 });
-// Validates that value is a valid timestamp from 2018-01-01 to now
-const responseTimestamp = () => integer({ min: 1514764861000, max: new Date().getTime() });
+// Validates that value is a valid timestamp from 2018-01-01 to now + 50ms to account for clock drift
+const responseTimestamp = () => integer({ min: 1514764861000, max: new Date().getTime() + 50 });
 const base64 = () => {
     return (value) => {
         const errorMessage = `Value is not valid base64 string.`;
@@ -111,7 +102,6 @@ exports.validator = {
     port,
     url,
     host,
-    object,
     responseTimestamp,
     base64,
     compose,

package/validation/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/validation/utils.ts"],"names":[],"mappings":";;;AACA,6BAA0B;AAK1B,sJAAsJ;AACtJ,MAAM,OAAO,GAAoE,CAC/E,kBAAgD,EAChD,EAAE;IACF,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,KAAK,MAAM,SAAS,IAAI,kBAAkB,EAAE;YAC1C,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,CAAA;YAClC,IAAI,SAAS,EAAE,MAAM,EAAE;gBACrB,OAAO,SAAS,CAAA;aACjB;SACF;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,QAAQ,GAAqC,GAAG,EAAE;IACtD,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;YAC5B,OAAO,6DAA6D,OAAO,KAAK,IAAI,KAAK,EAAE,CAAA;SAC5F;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,QAAQ,GAAqC,GAAG,EAAE;IACtD,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,GAAG,CAAC,EAAE;YACpC,OAAO,6CAA6C,KAAK,EAAE,CAAA;SAC5D;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,SAAS,GAAiD,CAAC,KAAK,EAAE,EAAE;IACxE,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,GAAG,KAAK,EAAE;YACxC,OAAO,4BAA4B,KAAK,cAAc,KAAK,EAAE,CAAA;SAC9D;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,SAAS,GAAiD,CAAC,KAAK,EAAE,EAAE;IACxE,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,GAAG,KAAK,EAAE;YACxC,OAAO,4BAA4B,KAAK,cAAc,KAAK,EAAE,CAAA;SAC9D;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,GAAG,GAA4B,GAAG,EAAE;IACxC,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI;YACF,KAAK,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,CAAA;SACxB;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,uCAAuC,KAAK,EAAE,CAAA;SACtD;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,IAAI,GAA4B,GAAG,EAAE;IACzC,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,MAAM,GAAG,IAAA,UAAI,EAAC,KAAK,IAAI,EAAE,CAAC,CAAA;QAChC,IAAI,MAAM,KAAK,CAAC,IAAI,KAAK,KAAK,WAAW,EAAE;YACzC,OAAO,2CAA2C,KAAK,EAAE,CAAA;SAC1D;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,MAAM,GAAG,GAAG,EAAE;IAClB,OAAO,CAAC,KAA8B,EAAE,EAAE;QACxC,MAAM,QAAQ,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAA;QAC5D,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,4BAA4B,CAAA;SACpC;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAA;AAE/D,MAAM,OAAO,GAAG,CAAC,MAAuC,EAAE,EAAE;IAC1D,MAAM,UAAU,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC/B,IAAI,MAAM,EAAE,GAAG,KAAK,SAAS,EAAE;QAC7B,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;KACvC;IACD,IAAI,MAAM,EAAE,GAAG,KAAK,SAAS,EAAE;QAC7B,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;KACvC;IACD,OAAO,OAAO,CAAC,UAAU,CAAC,CAAA;AAC5B,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAA;AAElD,mEAAmE;AACnE,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,GAAG,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;AAE1F,MAAM,MAAM,GAA4B,GAAG,EAAE;IAC3C,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,YAAY,GAAG,mCAAmC,CAAA;QACxD,IAAI,CAAC,KAAK,EAAE;YACV,OAAO,YAAY,CAAA;SACpB;QACD,IAAI;YACF,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;YAC9D,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;YACrE,OAAO,KAAK,KAAK,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAA;SACzD;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,YAAY,CAAA;SACpB;IACH,CAAC,CAAA;AACH,CAAC,CAAA;AAEY,QAAA,SAAS,GAAG;IACvB,OAAO;IACP,eAAe;IACf,IAAI;IACJ,GAAG;IACH,IAAI;IACJ,MAAM;IACN,iBAAiB;IACjB,MAAM;IACN,OAAO;CACR,CAAA"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/validation/utils.ts"],"names":[],"mappings":";;;AAAA,6BAA0B;AAM1B,sJAAsJ;AACtJ,MAAM,OAAO,GAA2C,CAAI,kBAAkC,EAAE,EAAE;IAChG,OAAO,CAAC,KAAoB,EAAE,EAAE;QAC9B,KAAK,MAAM,SAAS,IAAI,kBAAkB,EAAE;YAC1C,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,CAAA;YAClC,IAAI,SAAS,EAAE,MAAM,EAAE;gBACrB,OAAO,SAAS,CAAA;aACjB;SACF;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,QAAQ,GAA4B,GAAG,EAAE;IAC7C,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;YAC5B,OAAO,6DAA6D,OAAO,KAAK,IAAI,KAAK,EAAE,CAAA;SAC5F;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,QAAQ,GAA4B,GAAG,EAAE;IAC7C,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YAC5C,OAAO,6CAA6C,KAAK,EAAE,CAAA;SAC5D;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,SAAS,GAAwC,CAAC,KAAK,EAAE,EAAE;IAC/D,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,EAAE;YAChD,OAAO,4BAA4B,KAAK,cAAc,KAAK,EAAE,CAAA;SAC9D;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,SAAS,GAAwC,CAAC,KAAK,EAAE,EAAE;IAC/D,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,EAAE;YAChD,OAAO,4BAA4B,KAAK,cAAc,KAAK,EAAE,CAAA;SAC9D;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,GAAG,GAA4B,GAAG,EAAE;IACxC,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI;YACF,KAAK,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,CAAA;SACxB;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,uCAAuC,KAAK,EAAE,CAAA;SACtD;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,IAAI,GAA4B,GAAG,EAAE;IACzC,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,MAAM,GAAG,IAAA,UAAI,EAAC,KAAK,IAAI,EAAE,CAAC,CAAA;QAChC,IAAI,MAAM,KAAK,CAAC,IAAI,KAAK,KAAK,WAAW,EAAE;YACzC,OAAO,2CAA2C,KAAK,EAAE,CAAA;SAC1D;QACD,OAAM;IACR,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAA;AAE/D,MAAM,OAAO,GAAG,CAAC,MAAuC,EAAE,EAAE;IAC1D,MAAM,UAAU,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC/B,IAAI,MAAM,EAAE,GAAG,KAAK,SAAS,EAAE;QAC7B,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;KACvC;IACD,IAAI,MAAM,EAAE,GAAG,KAAK,SAAS,EAAE;QAC7B,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;KACvC;IACD,OAAO,OAAO,CAAC,UAAU,CAAC,CAAA;AAC5B,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAA;AAElD,qGAAqG;AACrG,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,GAAG,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,CAAA;AAE/F,MAAM,MAAM,GAA4B,GAAG,EAAE;IAC3C,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,YAAY,GAAG,mCAAmC,CAAA;QACxD,IAAI,CAAC,KAAK,EAAE;YACV,OAAO,YAAY,CAAA;SACpB;QACD,IAAI;YACF,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;YAC9D,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;YACrE,OAAO,KAAK,KAAK,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAA;SACzD;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,YAAY,CAAA;SACpB;IACH,CAAC,CAAA;AACH,CAAC,CAAA;AAEY,QAAA,SAAS,GAAG;IACvB,OAAO;IACP,eAAe;IACf,IAAI;IACJ,GAAG;IACH,IAAI;IACJ,iBAAiB;IACjB,MAAM;IACN,OAAO;CACR,CAAA"}

package/validation/input-validator.d.ts

@@ -1,19 +0,0 @@
-import { InputParameters } from './input-params';
-export type NormalizedInput = Record<string, unknown>;
-export type Override = Record<string, string>;
-export type OverridesMap = Record<string, Override>;
-export declare class InputValidator {
-    private readonly inputConfig;
-    private aliases;
-    constructor(inputConfig: InputParameters);
-    validateInput(input: Record<string, unknown>): NormalizedInput;
-    private validateOverrides;
-    private initializeInputs;
-    private validateInputParamsSchema;
-    private validateRequiredConfig;
-    private validateOptions;
-    private validateTypes;
-    private validateDeps;
-    private getUsedKey;
-    private throwInvalid;
-}