@openactive/data-model-validator/src/rules/format/duration-format-rule.js

A library to allow a developer to validate a JSON document against the OpenActive Modelling Opportunity Specification

const Rule = require('../rule');
const Field = require('../../classes/field');
const ValidationErrorType = require('../../errors/validation-error-type');
const ValidationErrorCategory = require('../../errors/validation-error-category');
const ValidationErrorSeverity = require('../../errors/validation-error-severity');

module.exports = class DurationFormatRule extends Rule {
  constructor(options) {
    super(options);
    this.targetFields = '*';
    this.meta = {
      name: 'DurationFormatRule',
      description: 'Validates that duration properties are in the correct format.',
      tests: {
        default: {
          message: 'Durations must be expressed as ISO 8601 durations. For example, `"P1D"`, `"PT1H"` or `"PT1H30M"`.',
          category: ValidationErrorCategory.CONFORMANCE,
          severity: ValidationErrorSeverity.FAILURE,
          type: ValidationErrorType.INVALID_FORMAT,
        },
      },
    };
  }

  validateField(node, field) {
    const errors = [];
    let fieldObj;
    if (node.model.hasSpecification) {
      fieldObj = node.model.getField(field);
      if (typeof fieldObj === 'undefined') {
        return [];
      }
    } else {
      fieldObj = new Field({}, node.options.version);
    }

    // See https://en.wikipedia.org/wiki/ISO_8601
    // NOTE: moment should not be used to validate durations, it is
    // too lenient - it allows time components without the T, and
    // fractions of units all the way through the string, and allows
    // the character 'P'
    const durationRegex = new RegExp(
      '^P('
      + '('
        // Necessary, because each final term in the string can be a fraction
        + '([0-9]+Y)?([0-9]+M)?([0-9]+D)?T([0-9]+H)?([0-9]+M)?([0-9]+(?:[,\\.][0-9]+)?S)'
        + '|([0-9]+Y)?([0-9]+M)?([0-9]+D)?T([0-9]+H)?([0-9]+(?:[,\\.][0-9]+)?M)'
        + '|([0-9]+Y)?([0-9]+M)?([0-9]+D)?T([0-9]+(?:[,\\.][0-9]+)?H)'
        + '|([0-9]+Y)?([0-9]+M)?([0-9]+(?:[,\\.][0-9]+)?D)'
        + '|([0-9]+Y)?([0-9]+(?:[,\\.][0-9]+)?M)'
        + '|([0-9]+(?:[,\\.][0-9]+)?Y)'
      + ')'
      + '|([0-9]+W)'
      + ')$',
    );

    const fieldValue = node.getValue(field);
    const type = fieldObj.detectType(fieldValue);
    if (type === 'https://schema.org/Duration'
        || fieldObj.isOnlyType('https://schema.org/Duration')
    ) {
      if (!durationRegex.test(fieldValue)) {
        errors.push(
          this.createError(
            'default',
            {
              value: fieldValue,
              path: node.getPath(field),
            },
          ),
        );
      }
    }
    return errors;
  }
};