loopback-component-explorer/lib/model-helper.js

'use strict';

/**
 * Module dependencies.
 */
var _cloneDeep = require('lodash.clonedeep');
var _pick = require('lodash.pick');
var translateDataTypeKeys = require('./translate-data-type-keys');
var typeConverter = require('./type-converter');

/**
 * Export the modelHelper singleton.
 */
var modelHelper = module.exports = {
  /**
   * Given a class (from remotes.classes()), generate a model definition.
   * This is used to generate the schema at the top of many endpoints.
   * @param  {Class} modelClass Model class.
   * @param {Object} definitions Model definitions
   * @return {Object} Associated model definition.
   */
  generateModelDefinition: function generateModelDefinition(modelClass, definitions) {
    var def = modelClass.definition;
    var out = definitions || {};

    if (!def) {
      // The model does not have any definition, it was most likely
      // created as a placeholder for an unknown property type
      return out;
    }

    var name = def.name;
    if (out[name]) {
      // The model is already included
      return out;
    }
    var required = [];
    // Don't modify original properties.
    var properties = _cloneDeep(def.properties);

    var referencedModels = [];
    // Add models from settings
    if (def.settings && def.settings.models) {
      for (var m in def.settings.models) {
        var model = modelClass[m];
        if (typeof model === 'function' && model.modelName) {
          if (referencedModels.indexOf(model) === -1) {
            referencedModels.push(model);
          }
        }
      }
    }

    // Iterate through each property in the model definition.
    // Types may be defined as constructors (e.g. String, Date, etc.),
    // or as strings; getPropType() will take care of the conversion.
    // See more on types:
    // https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#431-primitives
    Object.keys(properties).forEach(function(key) {
      var prop = properties[key];

      // Hide hidden properties.
      if (modelHelper.isHiddenProperty(def, key)) {
        delete properties[key];
        return;
      }

      // Eke a type out of the constructors we were passed.
      var swaggerType = modelHelper.LDLPropToSwaggerDataType(prop);

      var desc = typeConverter.convertText(prop.description || prop.doc);
      if (desc) swaggerType.description = desc;

      // Required props sit in a per-model array.
      if (prop.required || (prop.id && !prop.generated)) {
        required.push(key);
      }

      // Assign this back to the properties object.
      properties[key] = swaggerType;

      var propType = prop.type;
      if (typeof propType === 'function' && propType.modelName) {
        if (referencedModels.indexOf(propType) === -1) {
          referencedModels.push(propType);
        }
      }
      if (Array.isArray(propType) && propType.length) {
        var itemType = propType[0];
        if (typeof itemType === 'function' && itemType.modelName) {
          if (referencedModels.indexOf(itemType) === -1) {
            referencedModels.push(itemType);
          }
        }
      }
    });

    out[name] = {
      id: name,
      description: typeConverter.convertText(def.description),
      properties: properties,
      required: required
    };

    // Generate model definitions for related models
    for (var r in modelClass.relations) {
      var rel = modelClass.relations[r];
      if (rel.modelTo){
        generateModelDefinition(rel.modelTo, out);
      }
      if (rel.modelThrough) {
        generateModelDefinition(rel.modelThrough, out);
      }
    }
    for (var i = 0, n = referencedModels.length; i < n; i++) {
      generateModelDefinition(referencedModels[i], out);
    }
    return out;
  },

  /**
   * Given a propType (which may be a function, string, or array),
   * get a string type.
   * @param  {*} propType Prop type description.
   * @return {String}     Prop type string.
   */ 
  getPropType: function getPropType(propType) {
    if (typeof propType === 'function') {
      // See https://github.com/strongloop/loopback-explorer/issues/32
      // The type can be a model class
      return propType.modelName || propType.name.toLowerCase();
    } else if (Array.isArray(propType)) {
      return 'array';
    } else if (typeof propType === 'object') {
      // Anonymous objects, they are allowed e.g. in accepts/returns definitions
      return 'object';
    }
    return propType;
  },

  isHiddenProperty: function(definition, propName) {
    return definition.settings && 
      Array.isArray(definition.settings.hidden) &&
      definition.settings.hidden.indexOf(propName) !== -1;
  },

  // Converts a prop defined with the LDL spec to one conforming to the 
  // Swagger spec.
  // https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#431-primitives
  LDLPropToSwaggerDataType: function LDLPropToSwaggerDataType(ldlType) {
    var SWAGGER_DATA_TYPE_FIELDS = [
      'format',
      'defaultValue',
      'enum',
      'minimum',
      'maximum',
      'uniqueItems',
      // loopback-explorer extensions
      'length',
      // https://www.npmjs.org/package/swagger-validation
      'pattern'
    ];

    // Rename LoopBack keys to Swagger keys
    ldlType = translateDataTypeKeys(ldlType);

    // Pick only keys supported by Swagger
    var swaggerType = _pick(ldlType, SWAGGER_DATA_TYPE_FIELDS);

    swaggerType.type = modelHelper.getPropType(ldlType.type);

    if (swaggerType.type === 'array') {
      var hasItemType = Array.isArray(ldlType.type) && ldlType.type.length;
      var arrayItem = hasItemType && ldlType.type[0];

      if (arrayItem) {
        if(typeof arrayItem === 'object') {
          swaggerType.items = modelHelper.LDLPropToSwaggerDataType(arrayItem);
        } else {
          swaggerType.items = { type: modelHelper.getPropType(arrayItem) };
        }
      } else {
        // NOTE: `any` is not a supported type in swagger 1.2
        swaggerType.items = { type: 'any' };
      }
    } else if (swaggerType.type === 'date') {
      swaggerType.type = 'string';
      swaggerType.format = 'date';
    } else if (swaggerType.type === 'buffer') {
      swaggerType.type = 'string';
      swaggerType.format = 'byte';
    } else if (swaggerType.type === 'number') {
      swaggerType.format = 'double'; // Since all JS numbers are doubles
    }
    return swaggerType;
  }
};