'use strict'; /** * Module dependencies. */ var _cloneDeep = require('lodash.clonedeep'); var translateDataTypeKeys = require('./translate-data-type-keys'); var TYPES_PRIMITIVE = ['array', 'boolean', 'integer', 'number', 'null', 'object', 'string', 'any']; /** * 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 processType = function(app, modelName, referencedModels) { if (app && modelName) { if (modelName.indexOf('[') == 0) { modelName = modelName.replace(/[\[\]]/g, ''); } var model = app.models[modelName]; if (model && referencedModels.indexOf(model) === -1) { referencedModels.push(model); } } }; var convertTypeTo$Ref = function convertTypeTo$Ref(prop, modelUri){ if (prop.type && TYPES_PRIMITIVE.indexOf(prop.type) === -1 ){ prop.$ref = modelUri + '/definitions/' + prop.type; delete prop.type; } }; var def = modelClass.definition; var name = def.name; var modelUri = 'https://strongloop.com/loopback/' + name + '#'; var out = definitions || {}; if (out[name]) { // The model is already included return out; } var required = []; // Don't modify original properties. var properties = _cloneDeep(def.rawProperties || 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 (model && 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. prop = modelHelper.LDLPropToSwaggerDataType(prop); processType(modelClass.app, prop.type, referencedModels); if (prop.items) { processType(modelClass.app, prop.items.type, referencedModels); convertTypeTo$Ref(prop.items, modelUri); } // Required props sit in a per-model array. if (prop.required || (prop.id && !prop.generated)) { required.push(key); } // Change mismatched keys. prop = translateDataTypeKeys(prop); convertTypeTo$Ref(prop, modelUri); delete prop.required; delete prop.id; if (prop.description) { prop.description = Array.isArray(prop.description) ? prop.description.join('') : prop.description; } // Assign this back to the properties object. properties[key] = prop; var propType = def.properties[key].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: modelUri, $schema: 'http://json-schema.org/draft-04/schema#', properties: properties, required: required }; if (def.description){ out[name].description = Array.isArray(def.description) ? def.description.join('') : def.description; } if (def.settings && typeof def.settings.strict != 'undefined') { out[name].additionalProperties = !def.settings.strict; } else if (def.settings && typeof def.settings.additionalProperties != 'undefined') { out[name].additionalProperties = def.settings.additionalProperties; } // Generate model definitions for related models for (var r in modelClass.relations) { var rel = modelClass.relations[r]; if (rel.modelTo && referencedModels.indexOf(rel.modelTo) === -1) { referencedModels.push(rel.modelTo); } if (rel.modelThrough && referencedModels.indexOf(rel.modelThrough) === -1) { referencedModels.push(rel.modelThrough); } } if (modelClass.sharedClass) { var remotes = modelClass.sharedClass.methods(); for (var remoteIdx in remotes) { var remote = remotes[remoteIdx]; var accepts = remote.accepts; if (accepts) { for (var acceptIdx in accepts) { processType(modelClass.app, accepts[acceptIdx].type, referencedModels); } } var returns = remote.returns; if (returns) { for (var returnIdx in returns) { processType(modelClass.app, returns[returnIdx].type, referencedModels); } } var errors = remote.errors; if (errors) { for (var errorIdx in errors) { processType(modelClass.app, errors[errorIdx].responseModel, referencedModels); } } } } for (var i = 0, n = referencedModels.length; i < n; i++) { if (referencedModels[i].definition) { 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 propType = propType.modelName || propType.name.toLowerCase(); } else if(Array.isArray(propType)) { propType = 'array'; } 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(prop) { if (typeof prop === 'string') { prop = { type: prop } } var out = _cloneDeep(prop); out.type = modelHelper.getPropType(out.type); if (out.type === 'array') { var hasItemType = Array.isArray(prop.type) && prop.type.length; var arrayItem = hasItemType && prop.type[0]; if (arrayItem) { if(typeof arrayItem === 'object') { out.items = modelHelper.LDLPropToSwaggerDataType(arrayItem); } else { out.items = { type: modelHelper.getPropType(arrayItem) }; } } else { // NOTE: `any` is not a supported type in swagger 1.2 out.items = { type: 'any' }; } } else if (out.type === 'date') { out.type = 'string'; out.format = 'date'; } else if (out.type === 'buffer') { out.type = 'string'; out.format = 'byte'; } else if (out.type === 'number') { out.format = 'double'; // Since all JS numbers are doubles } return out; } };