b43ab65d8a
refs #9866 - preparation for v2 - moved api/ to api/v0.1 - do export v0.1 straight from the api folder, we don't want to touch this right now - that means currently if you require the api folder, we return v0.1 by default - there were some direct requires of api files in the test env - some of them use rewire - for now, we just correct the require path to require api/v0.1/ - we touch the test env next week **Docs about V2 design are coming soon!**
89 lines
2.7 KiB
JavaScript
89 lines
2.7 KiB
JavaScript
// # Slug API
|
|
// RESTful API for the Slug resource
|
|
const Promise = require('bluebird'),
|
|
pipeline = require('../../lib/promise/pipeline'),
|
|
localUtils = require('./utils'),
|
|
models = require('../../models'),
|
|
common = require('../../lib/common'),
|
|
docName = 'slugs';
|
|
|
|
let slugs,
|
|
allowedTypes;
|
|
|
|
/**
|
|
* ## Slugs API Methods
|
|
*
|
|
* **See:** [API Methods](constants.js.html#api%20methods)
|
|
*/
|
|
slugs = {
|
|
|
|
/**
|
|
* ## Generate Slug
|
|
* Create a unique slug for the given type and its name
|
|
*
|
|
* @param {{type (required), name (required), context, transacting}} options
|
|
* @returns {Promise(String)} Unique string
|
|
*/
|
|
generate(options) {
|
|
let opts = ['type'],
|
|
attrs = ['name'],
|
|
tasks;
|
|
|
|
// `allowedTypes` is used to define allowed slug types and map them against its model class counterpart
|
|
allowedTypes = {
|
|
post: models.Post,
|
|
tag: models.Tag,
|
|
user: models.User,
|
|
app: models.App
|
|
};
|
|
|
|
/**
|
|
* ### Check allowed types
|
|
* check if options.type contains an allowed type
|
|
* @param {Object} options
|
|
* @returns {Object} options
|
|
*/
|
|
function checkAllowedTypes(options) {
|
|
if (allowedTypes[options.type] === undefined) {
|
|
return Promise.reject(new common.errors.BadRequestError({message: common.i18n.t('errors.api.slugs.unknownSlugType', {type: options.type})}));
|
|
}
|
|
return options;
|
|
}
|
|
|
|
/**
|
|
* ### Model Query
|
|
* Make the call to the Model layer
|
|
* @param {Object} options
|
|
* @returns {Object} options
|
|
*/
|
|
function modelQuery(options) {
|
|
return models.Base.Model.generateSlug(allowedTypes[options.type], options.data.name, {status: 'all'})
|
|
.then((slug) => {
|
|
if (!slug) {
|
|
return Promise.reject(new common.errors.GhostError({
|
|
message: common.i18n.t('errors.api.slugs.couldNotGenerateSlug')
|
|
}));
|
|
}
|
|
|
|
return {
|
|
slugs: [{slug: slug}]
|
|
};
|
|
});
|
|
}
|
|
|
|
// Push all of our tasks into a `tasks` array in the correct order
|
|
tasks = [
|
|
localUtils.validate(docName, {opts: opts, attrs: attrs}),
|
|
localUtils.convertOptions(),
|
|
localUtils.handlePermissions(docName, 'generate'),
|
|
checkAllowedTypes,
|
|
modelQuery
|
|
];
|
|
|
|
// Pipeline calls each task passing the result of one to be the arguments for the next
|
|
return pipeline(tasks, options);
|
|
}
|
|
};
|
|
|
|
module.exports = slugs;
|