punchcard-content-types/lib/content-types.js

Combines with input plugins to create forms with validation. Creates forms for Punchcard CMS.

'use strict';

const _ = require('lodash');

const loader = require('./content-types/load');
const merge = require('./content-types/merge');
const only = require('./content-types/only');
const utils = require('./utils');

/**
 * Get single Content Type
 *
 * @param {string} id kebab-case id of content type
 * @param {array} types array of content type objects
 *
 * @returns {object} content type object
 */
const findCT = (id, types) => {
  const ct = utils.singleItem('id', id, types);

  if (ct === false) {
    throw new Error(`Content type ${id} not found `);
  }

  return ct;
};

/**
 * Get all Content Types
 *
 * @returns {Promise} - An {Array} containing {Object} for each content type, including `name` {String}, `id` name {String}, and full config {Object} loaded from YAML config file
 */
const raw = loader;

/*
 * Merge content type object with input plugin data
 *
 * @param {array} content content types array
 * @param {object} config - configuration object
 *
 * @returns {array} content types array that has been merged with input plugins and user settings
 */
const merged = (content, config) => {
  let mergedTypes = _.cloneDeep(content);

  if (content) {
    return merge(mergedTypes, config);
  }

  return raw(config).then(types => {
    mergedTypes = _.cloneDeep(types);

    return merge(mergedTypes, config);
  });
};

/**
 * Returns only one content type, merged with input plugins and values
 *
 * @param  {string} type - id of a content type
 * @param  {object} overrides - contains values for inputs
 * @param  {array} loadedTypes - array of merged content type objects
 * @param  {object} config - configuration object
 *
 * @returns {promise} resolves with promise from `only` function
 */
const onlyCT = (type, overrides, loadedTypes, config) => {
  const overs = overrides || {};

  let onlyTypes = _.cloneDeep(loadedTypes);

  if (loadedTypes) {
    const ct = findCT(type, onlyTypes);

    return only(ct, overs, config);
  }

  return merged(null, config).then(types => {
    onlyTypes = _.cloneDeep(types);

    const ct = findCT(type, onlyTypes);

    return only(ct, overs, config);
  });
};

module.exports = merged;
module.exports.raw = raw;
module.exports.only = onlyCT;