All files / builtins/exponent index.ts

100% Statements 30/30
100% Branches 2/2
100% Functions 8/8
100% Lines 29/29

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 934x 4x             4x   4x   4x 4x   4x 2x             2x 4x           4x                 2x 4x 3x     2x 4x 1x       2x 3x 1x             2x         4x 4x 4x   2x                   2x         2x 2x     2x          
import {z} from 'zod';
import {ERRORS} from '@grnsft/if-core/utils';
import {
  ExecutePlugin,
  PluginParams,
  ExponentConfig,
} from '@grnsft/if-core/types';
 
import {validate} from '../../util/validations';
 
import {STRINGS} from '../../config';
 
const {MissingInputDataError, InputValidationError} = ERRORS;
const {MISSING_INPUT_DATA, NOT_NUMERIC_VALUE} = STRINGS;
 
export const Exponent = (globalConfig: ExponentConfig): ExecutePlugin => {
  const metadata = {
    kind: 'execute',
  };
 
  /**
   * Checks global config value are valid.
   */
  const validateGlobalConfig = () => {
    const globalConfigSchema = z.object({
      'input-parameter': z.string().min(1),
      exponent: z.number().min(1),
      'output-parameter': z.string().min(1),
    });
 
    return validate<z.infer<typeof globalConfigSchema>>(
      globalConfigSchema,
      globalConfig
    );
  };
 
  /**
   * Checks for required fields in input.
   */
  const validateSingleInput = (input: PluginParams, inputParameter: string) => {
    validateParamExists(input, inputParameter);
    validateNumericString(input[inputParameter]);
  };
 
  const validateParamExists = (input: PluginParams, param: string) => {
    if (input[param] === undefined) {
      throw new MissingInputDataError(MISSING_INPUT_DATA(param));
    }
  };
 
  const validateNumericString = (str: string) => {
    if (isNaN(+Number(str))) {
      throw new InputValidationError(NOT_NUMERIC_VALUE(str));
    }
  };
 
  /**
   * Calculate the input param raised by to the power of the given exponent.
   */
  const execute = (inputs: PluginParams[]): PluginParams[] => {
    const {
      'input-parameter': inputParameter,
      exponent: exponent,
      'output-parameter': outputParameter,
    } = validateGlobalConfig();
    return inputs.map(input => {
      validateSingleInput(input, inputParameter);
 
      return {
        ...input,
        [outputParameter]: calculateExponent(input, inputParameter, exponent),
      };
    });
  };
 
  /**
   * Calculates the input param raised by the power of a given exponent.
   */
  const calculateExponent = (
    input: PluginParams,
    inputParameter: string,
    exponent: number
  ) => {
    const base = input[inputParameter];
    return Math.pow(base, exponent);
  };
 
  return {
    metadata,
    execute,
  };
};