nodebb-plugin-ns-awards-next/plugin/filters.js

System for rewarding forum users. It allows admin to define set of awards that could be granted to users for special accomplishments.

(function (Filter) {
    'use strict';

    let constants  = require('./constants'),
        controller = require('./controller');

    /**
     * Hook to render a user profile.
     * 'userData' will be used as payload in hook handler.
     *
     * @param {object} payload structure {userData: userData, uid: callerUID}
     * @param {function} callback
     */
    Filter.account = function (payload, callback) {
        controller.getAccountWithRewards(payload.userData, function (error, account) {
            if (error) {
                return callback(error);
            }
            payload.userData = account;
            callback(null, payload);
        });
    };

    Filter.menuAdmin = function (header, callback) {
        header.plugins.push({
            route: '/plugins/awards',
            icon : 'fa-trophy',
            name : 'Awards'
        });
        callback(null, header);
    };

    Filter.navigation = function (items, callback) {
        items.push({
            route    : constants.CLIENT_PAGE_PATH,
            title    : 'Awards',
            enabled  : true,
            iconClass: 'fa-trophy',
            textClass: 'visible-xs-inline',
            text     : 'Awards'
        });
        callback(null, items);
    };

    /**
     * Hook to render a topic thread
     *
     * @param {object} payload fields: {posts: posts, uid: uid}
     * @param {function} callback
     */
    Filter.getPosts = function (payload, callback) {
        // Remove purged posts
        let posts = payload.posts.filter(post => post !== null);

        controller.getPostsWithRewards(posts, function (error, posts) {
            if (error) {
                return callback(error);
            }
            payload.posts = posts;
            callback(null, payload);
        });
    };

})(module.exports);