@eluvio/elv-js-helpers/src/Model/UTCStrModel.js

A collection of Javascript helper functions used by several Eluvio libraries.

'use strict'
const assertAfterCheck = require('../ModelAssertion/assertAfterCheck')
const assertValidUTCStr = require('../ModelAssertion/assertValidUTCStr')
const defRegexMatchedStrModel = require('../ModelFactory/defRegexMatchedStrModel')
const passesModelCheck = require('../Boolean/passesModelCheck')
const RE_UTC_TIMESTAMP = require('../Datetime/RE_UTC_TIMESTAMP')
const StringModel = require('../Model/StringModel')

/**
 * An [ObjectModel](http://objectmodel.js.org/) which validates that an input is:
 *
 * * A [Javascript String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
 * * In UTC timestamp format e.g. '2022-01-01T14:00:00Z'
 * * A valid Datetime
 *
 * If input passes validation, will return the input
 *
 * Throws an exception if passed in an invalid value.
 *
 * @class
 * @category Model
 * @sig * -> String | THROW
 * @param {*} - The input to validate
 * @returns {String} The validated input
 * @example
 *
 * 'use strict'
 * const UTCStrModel = require('@eluvio/elv-js-helpers/Model/UTCStrModel')
 *
 * UTCStrModel('2022-01-01T14:00:00Z') //=> '2022-01-01T14:00:00Z'
 *
 * UTCStrModel('2022-01-01T14:00:00.123Z') //=> '2022-01-01T14:00:00.123Z'
 *
 * UTCStrModel('2022-13-01T14:00:00Z') //=> EXCEPTION: 'Value is not a valid UTC datetime string (got: "2022-13-01T14:00:00Z")'
 *
 * UTCStrModel('foo')                  //=> EXCEPTION: `Value is not in UTC format 'yyyy-mm-ddThh:mm:ss[.s...]Z' (got: "foo")`
 *
 * UTCStrModel(42)                     //=> EXCEPTION: 'expecting String, got Number 42'
 *
 */
const UTCStrModel =
  defRegexMatchedStrModel(
    'UTCTimestampRegexMatchStr', // intermediate name for the Model that only checks regex
    RE_UTC_TIMESTAMP,
    'is not in UTC format \'yyyy-mm-ddThh:mm:ss[.s...]Z\''
  )
    .extend()
    .assert(
      ...assertAfterCheck(
        x=> passesModelCheck(StringModel,x) && RE_UTC_TIMESTAMP.test(x),
        ...assertValidUTCStr()
      )
    )
    .as('UTCStr') // final name for Model that also checks that string is a valid Datetime

module.exports = UTCStrModel