@eluvio/elv-js-helpers/ModelFactory/defTypedKVObjModel.js

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

'use strict'
const defBasicModel = require('./defBasicModel')

const isObject = require('../Boolean/isObject')

const assertAfterCheck = require('../ModelAssertion/assertAfterCheck')
const assertObjKeysValid = require('../ModelAssertion/assertObjKeysValid')
const assertObjValuesValid = require('../ModelAssertion/assertObjValuesValid')

const throwIfUndefined = require('../Validation/throwIfUndefined')

/**
 * Returns an [ObjectModel](http://objectmodel.js.org/) which will validate that an input is:
 *
 *  * A [Javascript Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
 *  * Has keys that validate against a Model
 *  * Has values that validate against a Model
 *
 *  It offers similar validation capabilities as [ObjectModel's MapModel](http://objectmodel.js.org/#doc-map-models)
 *  but the resulting Model accepts a Javascript object as input and returns a (proxied) Javascript object as output.
 *
 * @function
 * @category ModelFactory
 * @sig String -> Model -> Model -> (* -> Object | THROW)
 * @param {String} name - the name of the generated Model
 * @param {Model} keyModel - The Model to validate keys against
 * @param {Model} valueModel - The Model to validate values against
 * @returns {Object} Returns an [ObjectModel](http://objectmodel.js.org/) that can be called with an input
 * @example
 *
 * 'use strict'
 * const defTypedKVObjModel = require('@eluvio/elv-js-helpers/ModelFactory/defTypedKVObjModel')
 *
 * const NonBlankStrModel = require('@eluvio/elv-js-helpers/Model/NonBlankStrModel')
 *
 * const NoBlankKVModel = defTypedKVObjModel(
 *   'NonBlankKV',
 *   NonBlankStrModel,
 *   NonBlankStrModel
 * )
 *
 * NoBlankKVModel({})               //=> {}
 *
 * NoBlankKVModel({foo: 'bar'})     //=> {foo: 'bar'}
 *
 * NoBlankKVModel({foo: '   '})     //=> EXCEPTION: 'key "foo" points to a value that is an invalid NonBlankString (NonBlankString: Value must not be a blank string (got: "   "))'
 *
 * NoBlankKVModel({'  ': 'bar'})    //=> EXCEPTION: 'invalid property name "  " (is not a valid NonBlankString)'
 *
 * NoBlankKVModel({foo: 42})        //=> EXCEPTION: 'key "foo" points to a value that is an invalid NonBlankString (NonBlankString: expecting String, got Number 42)'
 *
 * NoBlankKVModel(42)               //=> EXCEPTION: 'expecting Object, got Number 42'
 *
 *
 */
// noinspection JSCheckFunctionSignatures
const defTypedKVObjModel = (name, keyModel, valueModel) => {
  throwIfUndefined('no key model supplied', keyModel)
  throwIfUndefined('no value model supplied', valueModel)
  return defBasicModel(name, Object)
    .extend()
    .assert(
      ...assertAfterCheck(
        isObject,
        ...assertObjKeysValid(keyModel)
      )
    )
    .assert(
      ...assertAfterCheck(
        isObject,
        ...assertObjValuesValid(valueModel)
      )
    )
}

module.exports = defTypedKVObjModel