@dnb/eufemia/es/extensions/forms/utils/ajv.js

DNB Eufemia Design System UI Library

import Ajv from 'ajv/dist/2020.js';
import ajvErrors from 'ajv-errors';
import pointer from "./json-pointer/index.js";
import { FormError } from "./FormError.js";
export { Ajv };
const ajvErrorKeywordsTranslationTable = [{
  ajvKey: 'required',
  translationKey: 'Field.errorRequired'
}, {
  ajvKey: 'pattern',
  translationKey: 'Field.errorPattern'
}, {
  ajvKey: 'minLength',
  translationKey: 'StringField.errorMinLength'
}, {
  ajvKey: 'maxLength',
  translationKey: 'StringField.errorMaxLength'
}, {
  ajvKey: 'minimum',
  translationKey: 'NumberField.errorMinimum'
}, {
  ajvKey: 'maximum',
  translationKey: 'NumberField.errorMaximum'
}, {
  ajvKey: 'minItems',
  translationKey: 'IterateArray.errorMinItems'
}, {
  ajvKey: 'maxItems',
  translationKey: 'IterateArray.errorMaxItems'
}, {
  ajvKey: 'exclusiveMinimum',
  translationKey: 'NumberField.errorExclusiveMinimum'
}, {
  ajvKey: 'exclusiveMaximum',
  translationKey: 'NumberField.errorExclusiveMaximum'
}, {
  ajvKey: 'multipleOf',
  translationKey: 'NumberField.errorMultipleOf'
}];
export function makeAjvInstance(instance) {
  return enhanceAjvInstance(instance || new Ajv({
    allErrors: true
  }));
}
export function enhanceAjvInstance(instance) {
  if (!instance['__ajvErrors__']) {
    ajvErrors(instance);
    instance['__ajvErrors__'] = true;
  }
  return instance;
}
export function getInstancePath(ajvError) {
  switch (ajvError.keyword) {
    case 'required':
      {
        return `${ajvError.instancePath}/${ajvError.params.missingProperty}`;
      }
    case 'errorMessage':
      {
        if (ajvError.params.errors[0]) {
          return getInstancePath(ajvError.params.errors[0]);
        }
      }
  }
  return ajvError.instancePath;
}
export function getValidationRule(ajvError) {
  if (ajvError.keyword === 'errorMessage' && ajvError.params.errors[0]) {
    return getValidationRule(ajvError.params.errors[0]);
  }
  return ajvError.keyword;
}
export function getMessageValues(ajvError) {
  const validationRule = getValidationRule(ajvError);
  switch (validationRule) {
    case 'minLength':
    case 'maxLength':
    case 'minimum':
    case 'maximum':
    case 'minItems':
    case 'maxItems':
    case 'exclusiveMinimum':
    case 'exclusiveMaximum':
      return {
        [validationRule]: ajvError.params?.limit
      };
    case 'multipleOf':
      return {
        [validationRule]: ajvError.params?.multipleOf
      };
    case 'pattern':
      return {
        [validationRule]: ajvError.params?.pattern
      };
  }
}
export function overwriteErrorMessagesWithGivenAjvKeys(messages) {
  messages = {
    ...messages
  };
  ajvErrorKeywordsTranslationTable.forEach(({
    ajvKey,
    translationKey
  }) => {
    if (messages[ajvKey]) {
      messages[translationKey] = messages[ajvKey];
    }
  });
  return messages;
}
export function extendErrorMessagesWithTranslationMessages(messages, translation) {
  messages = {
    ...messages
  };
  ajvErrorKeywordsTranslationTable.forEach(({
    ajvKey,
    translationKey
  }) => {
    if (!messages[ajvKey]) {
      var _messages$translation, _messages$translation2;
      const keys = translationKey.split('.');
      messages[ajvKey] = (_messages$translation = messages[translationKey]) !== null && _messages$translation !== void 0 ? _messages$translation : translation[keys[0]]?.[keys[1]];
      messages[translationKey] = (_messages$translation2 = messages[translationKey]) !== null && _messages$translation2 !== void 0 ? _messages$translation2 : translation[keys[0]]?.[keys[1]];
    }
  });
  return messages;
}
export function getTranslationKeyFromValidationRule(validationRule) {
  const item = ajvErrorKeywordsTranslationTable.find(({
    ajvKey
  }) => ajvKey === validationRule);
  return item?.translationKey;
}
export function ajvErrorToFormError(ajvError) {
  var _ref, _getTranslationKeyFro;
  if (ajvError.keyword === 'errorMessage') {
    var _ajvError$message;
    return new Error((_ajvError$message = ajvError.message) !== null && _ajvError$message !== void 0 ? _ajvError$message : 'Unknown error');
  }
  return new FormError((_ref = (_getTranslationKeyFro = getTranslationKeyFromValidationRule(getValidationRule(ajvError))) !== null && _getTranslationKeyFro !== void 0 ? _getTranslationKeyFro : ajvError.message) !== null && _ref !== void 0 ? _ref : 'Unknown error', {
    messageValues: getMessageValues(ajvError),
    ajvKeyword: ajvError.keyword
  });
}
export function ajvErrorsToOneFormError(errors, value) {
  if (!errors || errors.length === 0) {
    return;
  }
  if (errors.length === 1) {
    const error = ajvErrorsTransformation(errors[0], value);
    if (!error) {
      return undefined;
    }
    return ajvErrorToFormError(error);
  }
  return new FormError('Multiple errors', {
    errors: errors?.map(error => ajvErrorToFormError(error))
  });
}
export const ajvErrorsToFormErrors = (errors, data) => {
  return (errors !== null && errors !== void 0 ? errors : []).reduce((errors, ajvError) => {
    const path = getInstancePath(ajvError);
    const error = ajvErrorsTransformation(ajvError, data, path);
    if (error) {
      errors[path] = ajvErrorToFormError(error);
    }
    return errors;
  }, {});
};
function ajvErrorsTransformation(ajvError, data, path) {
  if (ajvError.keyword === 'type') {
    const value = data && typeof data === 'object' && path ? pointer.get(data, path) : data;
    if (value === '' || value === null || typeof value === 'undefined') {
      return undefined;
    } else {
      const expectedType = ajvError?.params?.type;
      if (expectedType === 'integer') {
        ajvError.message = 'NumberField.errorInteger';
      } else {
        const field = path ? `field at path="${path}"` : 'field';
        ajvError.message = `The ${field} value (${value}) type ${ajvError.message}`;
      }
      console.error(ajvError.message);
    }
  }
  return ajvError;
}
//# sourceMappingURL=ajv.js.map