mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-14 18:52:05 +03:00
469aaa398c
resolves #1920 - updates all files to conform to style settings.
130 lines
4.4 KiB
JavaScript
130 lines
4.4 KiB
JavaScript
// # Notifications API
|
|
// RESTful API for creating notifications
|
|
var Promise = require('bluebird'),
|
|
_ = require('lodash'),
|
|
canThis = require('../permissions').canThis,
|
|
errors = require('../errors'),
|
|
utils = require('./utils'),
|
|
|
|
// Holds the persistent notifications
|
|
notificationsStore = [],
|
|
// Holds the last used id
|
|
notificationCounter = 0,
|
|
notifications;
|
|
|
|
/**
|
|
* ## Notification API Methods
|
|
*
|
|
* **See:** [API Methods](index.js.html#api%20methods)
|
|
*/
|
|
notifications = {
|
|
|
|
/**
|
|
* ### Browse
|
|
* Fetch all notifications
|
|
* @returns {Promise(Notifications)}
|
|
*/
|
|
browse: function browse(options) {
|
|
return canThis(options.context).browse.notification().then(function () {
|
|
return {notifications: notificationsStore};
|
|
}, function () {
|
|
return Promise.reject(new errors.NoPermissionError('You do not have permission to browse notifications.'));
|
|
});
|
|
},
|
|
|
|
/**
|
|
* ### Add
|
|
*
|
|
*
|
|
* **takes:** a notification object of the form
|
|
* ```
|
|
* msg = { notifications: [{
|
|
* type: 'error', // this can be 'error', 'success', 'warn' and 'info'
|
|
* message: 'This is an error', // A string. Should fit in one line.
|
|
* location: 'bottom', // A string where this notification should appear. can be 'bottom' or 'top'
|
|
* dismissible: true // A Boolean. Whether the notification is dismissible or not.
|
|
* }] };
|
|
* ```
|
|
*/
|
|
add: function add(object, options) {
|
|
var defaults = {
|
|
dismissible: true,
|
|
location: 'bottom',
|
|
status: 'persistent'
|
|
},
|
|
addedNotifications = [];
|
|
|
|
return canThis(options.context).add.notification().then(function () {
|
|
return utils.checkObject(object, 'notifications').then(function (checkedNotificationData) {
|
|
_.each(checkedNotificationData.notifications, function (notification) {
|
|
notificationCounter = notificationCounter + 1;
|
|
|
|
notification = _.assign(defaults, notification, {
|
|
id: notificationCounter
|
|
// status: 'persistent'
|
|
});
|
|
|
|
notificationsStore.push(notification);
|
|
addedNotifications.push(notification);
|
|
});
|
|
|
|
return {notifications: addedNotifications};
|
|
});
|
|
}, function () {
|
|
return Promise.reject(new errors.NoPermissionError('You do not have permission to add notifications.'));
|
|
});
|
|
},
|
|
|
|
/**
|
|
* ### Destroy
|
|
* Remove a specific notification
|
|
*
|
|
* @param {{id (required), context}} options
|
|
* @returns {Promise(Notifications)}
|
|
*/
|
|
destroy: function destroy(options) {
|
|
return canThis(options.context).destroy.notification().then(function () {
|
|
var notification = _.find(notificationsStore, function (element) {
|
|
return element.id === parseInt(options.id, 10);
|
|
});
|
|
|
|
if (notification && !notification.dismissible) {
|
|
return Promise.reject(
|
|
new errors.NoPermissionError('You do not have permission to dismiss this notification.')
|
|
);
|
|
}
|
|
|
|
if (!notification) {
|
|
return Promise.reject(new errors.NotFoundError('Notification does not exist.'));
|
|
}
|
|
|
|
notificationsStore = _.reject(notificationsStore, function (element) {
|
|
return element.id === parseInt(options.id, 10);
|
|
});
|
|
return {notifications: [notification]};
|
|
}, function () {
|
|
return Promise.reject(new errors.NoPermissionError('You do not have permission to destroy notifications.'));
|
|
});
|
|
},
|
|
|
|
/**
|
|
* ### DestroyAll
|
|
* Clear all notifications, used for tests
|
|
*
|
|
* @private Not exposed over HTTP
|
|
* @returns {Promise}
|
|
*/
|
|
destroyAll: function destroyAll(options) {
|
|
return canThis(options.context).destroy.notification().then(function () {
|
|
notificationsStore = [];
|
|
notificationCounter = 0;
|
|
|
|
return notificationsStore;
|
|
}, function () {
|
|
return Promise.reject(new errors.NoPermissionError('You do not have permission to destroy notifications.'));
|
|
});
|
|
}
|
|
};
|
|
|
|
module.exports = notifications;
|