Remove hidden properties from definition.

This commit is contained in:
Samuel Reed 2014-07-26 12:12:05 -05:00
parent 8c07540755
commit a9ecfecde5
3 changed files with 52 additions and 1 deletions

20
example/hidden.js Normal file
View File

@ -0,0 +1,20 @@
var loopback = require('loopback');
var app = loopback();
var explorer = require('../');
var port = 3000;
var User = loopback.Model.extend('user', {
username: 'string',
email: 'string',
sensitiveInternalProperty: 'string',
}, {hidden: ['sensitiveInternalProperty']});
User.attachTo(loopback.memory());
app.model(User);
var apiPath = '/api';
app.use('/explorer', explorer(app, {basePath: apiPath}));
app.use(apiPath, loopback.rest());
console.log('Explorer mounted at localhost:' + port + '/explorer');
app.listen(port);

View File

@ -37,6 +37,12 @@ var modelHelper = module.exports = {
Object.keys(properties).forEach(function(key) { Object.keys(properties).forEach(function(key) {
var prop = properties[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. // Eke a type out of the constructors we were passed.
prop = modelHelper.LDLPropToSwaggerDataType(prop); prop = modelHelper.LDLPropToSwaggerDataType(prop);
@ -84,6 +90,12 @@ var modelHelper = module.exports = {
return propType; 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 // Converts a prop defined with the LDL spec to one conforming to the
// Swagger spec. // Swagger spec.
// https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#431-primitives // https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#431-primitives

View File

@ -117,10 +117,29 @@ describe('model-helper', function() {
expect(defs).has.property('relatedModel'); expect(defs).has.property('relatedModel');
}); });
}); });
describe('hidden properties', function() {
it('should hide properties marked as "hidden"', function() {
var aClass = createModelCtor({
visibleProperty: 'string',
hiddenProperty: 'string'
});
aClass.ctor.definition.settings = {
hidden: ['hiddenProperty']
};
var def = modelHelper.generateModelDefinition(aClass.ctor, {}).testModel;
expect(def.properties).to.not.have.property('hiddenProperty');
expect(def.properties).to.have.property('visibleProperty');
});
});
}); });
// Simulates the format of a remoting class. // Simulates the format of a remoting class.
function buildSwaggerModels(model) { function buildSwaggerModels(model) {
var aClass = createModelCtor(model);
return modelHelper.generateModelDefinition(aClass.ctor, {}).testModel;
}
function createModelCtor(model) {
Object.keys(model).forEach(function(name) { Object.keys(model).forEach(function(name) {
model[name] = {type: model[name]}; model[name] = {type: model[name]};
}); });
@ -132,7 +151,7 @@ function buildSwaggerModels(model) {
} }
} }
}; };
return modelHelper.generateModelDefinition(aClass.ctor, {}).testModel; return aClass;
} }
function buildSwaggerModelsWithRelations(model) { function buildSwaggerModelsWithRelations(model) {