@montevideo-tech/cmcd-validator/src/keyValueValidator/keysValueValidator.js

This is a library created to validate CMCD

import {
  checkMaxLength, isEncoded, checkValidNrrFormat, checkRoundToNearest, checkIgnoredParameter,
  isReserved, isPositive, checkBlKey, checkCorrectType, checkOtValidValue, checkSfValidValue,
  checkPrValue,
  checkVValue,
  checkStValidValue, checkSidIsPresent, isRelativePath,
} from './validatorFunctions.js';
import { warningTypes } from '../utils/constants.js';
import { createWarning } from '../utils/warning.js';

// keyValValidator takes as a parameter cmcdJson, which is a javascript object.
// The function iterates through it validating every key value pair.
// eslint-disable-next-line max-len
const keyValValidator = (cmcdJson, errors, requestID, warnings, config, extendedKeyTypes, warningFlag) => {
  if (warningFlag === true) {
    checkSidIsPresent(cmcdJson, warnings, requestID);
  }

  // Check if all the specifickey have been received in the request
  const keysReceived = Object.keys(cmcdJson);
  if (config?.specificKey && warningFlag) {
    config.specificKey.forEach((key) => {
      if (!keysReceived.includes(key)) {
        warnings.push(createWarning(warningTypes.specificKeysNotSent, requestID, key));
      }
    });
  }

  if (config?.customKey && warningFlag) {
    config.customKey.forEach((cKey) => {
      if (!keysReceived.includes(cKey.key)) {
        warnings.push(createWarning(warningTypes.specificKeysNotSent, requestID, cKey.key));
      }
    });
  }

  Object.keys(cmcdJson).forEach((key) => {
    // Check if we received a configuration
    if (config?.specificKey && !config.specificKey?.includes(key)) {
      return;
    }

    const keyValue = cmcdJson[key];
    isReserved(errors, requestID, key, keyValue, extendedKeyTypes);
    checkCorrectType(errors, key, keyValue, requestID);
    isPositive(errors, key, keyValue, requestID);
    switch (key) {
      case 'bl':
        checkRoundToNearest(errors, key, keyValue, 100, 'ms', requestID);
        if (warningFlag === true) {
          checkBlKey(cmcdJson, warnings, key, keyValue, requestID);
        }
        break;
      case 'cid':
        checkMaxLength(errors, key, keyValue, requestID);
        break;
      case 'dl':
        checkRoundToNearest(errors, key, keyValue, 100, 'ms', requestID);
        break;
      case 'mtp':
        checkIgnoredParameter(errors, key, keyValue, 0, requestID);
        checkRoundToNearest(errors, key, keyValue, 100, 'kbps', requestID);
        break;
      case 'nor':
        if (isEncoded(errors, key, keyValue, requestID)) {
          isRelativePath(errors, key, keyValue, requestID);
        }
        break;
      case 'nrr':
        checkValidNrrFormat(errors, key, keyValue, requestID);
        break;
      case 'ot':
        checkOtValidValue(errors, key, keyValue, requestID);
        break;
      case 'rtp':
        checkRoundToNearest(errors, key, keyValue, 100, 'kbps', requestID);
        break;
      case 'sf':
        checkSfValidValue(errors, key, keyValue, requestID);
        break;
      case 'sid':
        checkMaxLength(errors, key, keyValue, requestID);
        break;
      case 'st':
        checkStValidValue(errors, key, keyValue, requestID);
        break;
      case 'su':
        checkIgnoredParameter(errors, key, keyValue, false, requestID);
        break;
      case 'bs':
        checkIgnoredParameter(errors, key, keyValue, false, requestID);
        break;
      case 'pr':
        if (warningFlag) {
          checkPrValue(cmcdJson, warnings, key, keyValue, requestID);
        }
        break;
      case 'v':
        if (warningFlag) {
          checkVValue(cmcdJson, warnings, key, keyValue, requestID);
        }
        break;
      default:
        break;
    }
  });
};

export default keyValValidator;