All files / builtins/sum 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 844x 4x     4x   4x   4x 4x   4x 3x             3x 4x 3x 3x   3x 3x   2x                   3x 4x 1x     3x         3x                 3x       3x 6x 1x       2x           3x 2x 5x       3x          
import {z} from 'zod';
import {ERRORS} from '@grnsft/if-core/utils';
import {ExecutePlugin, PluginParams, SumConfig} from '@grnsft/if-core/types';
 
import {validate} from '../../util/validations';
 
import {STRINGS} from '../../config';
 
const {GlobalConfigError, MissingInputDataError} = ERRORS;
const {MISSING_INPUT_DATA, MISSING_GLOBAL_CONFIG} = STRINGS;
 
export const Sum = (globalConfig: SumConfig): ExecutePlugin => {
  const metadata = {
    kind: 'execute',
  };
 
  /**
   * Calculate the sum of each input-paramters.
   */
  const execute = (inputs: PluginParams[]) => {
    const safeGlobalConfig = validateGlobalConfig();
    const inputParameters = safeGlobalConfig['input-parameters'];
    const outputParameter = safeGlobalConfig['output-parameter'];
 
    return inputs.map(input => {
      const safeInput = validateSingleInput(input, inputParameters);
 
      return {
        ...input,
        [outputParameter]: calculateSum(safeInput, inputParameters),
      };
    });
  };
 
  /**
   * Checks global config value are valid.
   */
  const validateGlobalConfig = () => {
    if (!globalConfig) {
      throw new GlobalConfigError(MISSING_GLOBAL_CONFIG);
    }
 
    const globalConfigSchema = z.object({
      'input-parameters': z.array(z.string()),
      'output-parameter': z.string().min(1),
    });
 
    return validate<z.infer<typeof globalConfigSchema>>(
      globalConfigSchema,
      globalConfig
    );
  };
 
  /**
   * Checks for required fields in input.
   */
  const validateSingleInput = (
    input: PluginParams,
    inputParameters: string[]
  ) => {
    inputParameters.forEach(metricToSum => {
      if (!input[metricToSum]) {
        throw new MissingInputDataError(MISSING_INPUT_DATA(metricToSum));
      }
    });
 
    return input;
  };
 
  /**
   * Calculates the sum of the energy components.
   */
  const calculateSum = (input: PluginParams, inputParameters: string[]) =>
    inputParameters.reduce(
      (accumulator, metricToSum) => accumulator + input[metricToSum],
      0
    );
 
  return {
    metadata,
    execute,
  };
};