Source: services/dynamic-common.js

  1. /**
  2.  * Common functions and utilities for tasks related to dynamic badges.
  3.  *
  4.  * @module
  5.  */
  7. import Joi from 'joi'
  8. import toArray from '../core/base-service/to-array.js'
  9. import validate from '../core/base-service/validate.js'
  10. import { InvalidResponse } from './index.js'
  12. /**
  13.  * Map of error codes and their corresponding error messages.
  14.  *
  15.  * @type {object}
  16.  */
  17. const httpErrors = {
  18.   404: 'resource not found',
  19. }
  21. /**
  22.  * Joi schema for validating individual value.
  23.  * Checks if the individual value is of type string or number.
  24.  *
  25.  * @type {Joi}
  26.  */
  27. const individualValueSchema = Joi.alternatives()
  28.   .try(Joi.string(), Joi.number())
  29.   .required()
  31. /**
  32.  * Joi schema for validating compound value.
  33.  * Checks if the compound value is of type individualValueSchema, array of individualValueSchema or empty array.
  34.  *
  35.  * @type {Joi}
  36.  */
  37. const compoundValueSchema = Joi.alternatives().try(
  38.   individualValueSchema,
  39.   Joi.array().items(individualValueSchema).required(),
  40.   Joi.array().length(0),
  41. )
  43. /**
  44.  * Look up the value in the data object by key and validate the value against compoundValueSchema.
  45.  *
  46.  * @param {object} attrs Refer to individual attributes
  47.  * @param {object} attrs.data Object containing the data for validation
  48.  * @param {string} attrs.key Key to retrieve the data from object for validation
  49.  * @throws {InvalidResponse|Error} Error if Joi validation fails due to invalid or no schema
  50.  * @returns {object} Value if Joi validation is success
  51.  */
  52. function transformAndValidate({ data, key }) {
  53.   return validate(
  54.     {
  55.       ErrorClass: InvalidResponse,
  56.       prettyErrorMessage: 'invalid key value',
  57.       traceErrorMessage: 'Key value not valid for dynamic badge',
  58.       traceSuccessMessage: 'Key value after validation',
  59.     },
  60.     data[key],
  61.     compoundValueSchema,
  62.   )
  63. }
  65. /**
  66.  * Handles rendering concerns of dynamic badges.
  67.  * Determines the label of the badge according to the tag and defaultLabel.
  68.  * Determines the message of the badge according to the prefix, suffix and value.
  69.  * Sets the color of the badge to blue.
  70.  *
  71.  * @param {object} attrs Refer to individual attributes
  72.  * @param {string} attrs.defaultLabel default badge label
  73.  * @param {string} [attrs.tag] If provided then this value will be appended to the badge label, e.g. `foobar@v1.23`
  74.  * @param {any} attrs.value Value or array of value to be used for the badge message
  75.  * @param {string} [attrs.prefix] If provided then the badge message will use this value as a prefix
  76.  * @param {string} [attrs.suffix] If provided then the badge message will use this value as a suffix
  77.  * @returns {object} Badge with label, message and color properties
  78.  */
  79. function renderDynamicBadge({
  80.   defaultLabel,
  81.   tag,
  82.   value,
  83.   prefix = '',
  84.   suffix = '',
  85. }) {
  86.   const renderedValue =
  87.     value === undefined ? 'not specified' : toArray(value).join(', ')
  88.   return {
  89.     label: tag ? `${defaultLabel}@${tag}` : defaultLabel,
  90.     message: `${prefix}${renderedValue}${suffix}`,
  91.     color: 'blue',
  92.   }
  93. }
  95. export {
  96.   httpErrors,
  97.   individualValueSchema,
  98.   transformAndValidate,
  99.   renderDynamicBadge,
  100. }