nodebb-plugin-mentions 4.4.4 → 4.5.0

package/library.js

@@ -12,6 +12,7 @@ const winston = require.main.require('winston');
 const db = require.main.require('./src/database');
 const api = require.main.require('./src/api');
 const meta = require.main.require('./src/meta');
+const categories = require.main.require('./src/categories');
 const Topics = require.main.require('./src/topics');
 const posts = require.main.require('./src/posts');
 const User = require.main.require('./src/user');
@@ -393,18 +394,34 @@ Mentions.parseRaw = async (content) => {
 		const slug = slugify(match.slice(1));
 		match = removePunctuationSuffix(match);
 		const uid = await User.getUidByUserslug(slug);
-		const { groupExists, user } = await utils.promiseParallel({
+		const cid = await categories.getCidByHandle(slug);
+		const { groupExists, user, category } = await utils.promiseParallel({
 			groupExists: Groups.existsBySlug(slug),
 			user: User.getUserFields(uid, ['uid', 'username', 'fullname', 'url']),
+			category: categories.getCategoryFields(cid, ['slug']),
 		});
 
-		if (user.uid || groupExists) {
+		if (uid || groupExists || cid) {
 			let url;
-			if (user.uid) {
-				url = utils.isNumber(user.uid) ? `${nconf.get('url')}/uid/${user.uid}` : (user.url || user.uid);
-			} else {
-				url = `${nconf.get('url')}/groups/${slug}`;
+
+			switch (true) {
+				case !!uid: {
+					url = utils.isNumber(user.uid) ? `${nconf.get('url')}/uid/${user.uid}` : (user.url || user.uid);
+					break;
+				}
+
+				case !!cid: {
+					url = `${nconf.get('url')}/category/${category.slug}`;
+					console.log('setting url', url);
+					break;
+				}
+
+				case !!groupExists: {
+					url = `${nconf.get('url')}/groups/${slug}`;
+					break;
+				}
 			}
+
 			const regex = isLatinMention.test(match) ?
 				RegExp(`${parts.before}${match}${parts.after}`, 'gu') :
 				RegExp(`${parts.before}${match}`, 'gu');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-mentions",
-  "version": "4.4.4",
+  "version": "4.5.0",
   "description": "NodeBB Plugin that allows users to mention other users by prepending an '@' sign to their username",
   "main": "library.js",
   "scripts": {

package/static/autofill.js

@@ -3,6 +3,8 @@
 
 $(document).ready(function () {
 	let groupList = [];
+	let categoryList;
+	const categorySlugMap = new Map();
 	let localUserList = [];
 
 	$(window).on('composer:autocomplete:init chat:autocomplete:init', function (ev, data) {
@@ -12,6 +14,10 @@ $(document).ready(function () {
 			loadGroupList();
 		}
 
+		if (!categoryList) {
+			loadCategoryList();
+		}
+
 		let slugify;
 		const strategy = {
 			match: /\B@([^\s\n]*)?$/,
@@ -20,7 +26,7 @@ $(document).ready(function () {
 					slugify = _slugify;
 					let mentions = [];
 					if (!term) {
-						mentions = usersToMentions(sortUsers(localUserList), helpers);
+						mentions = entriesToMentions(sortEntries(localUserList), helpers);
 						return callback(mentions);
 					}
 
@@ -37,10 +43,12 @@ $(document).ready(function () {
 						const localMatches = localUserList.filter(
 							u => u.username.toLocaleLowerCase().startsWith(termLowerCase)
 						);
+						const categoryMatches = categoryList.filter(c => c.handle.startsWith(termLowerCase));
 
-						// remove local matches from search results
+						// remove local matches from search results, add category matches
 						users = users.filter(u => !localMatches.find(lu => lu.uid === u.uid));
-						mentions = usersToMentions(sortUsers(localMatches).concat(sortUsers(users)), helpers);
+						users = sortEntries(localMatches).concat(sortEntries([...users, ...categoryMatches]));
+						mentions = entriesToMentions(users, helpers);
 
 						// Add groups that start with the search term
 						const groupMentions = groupList.filter(function (groupName) {
@@ -62,7 +70,14 @@ $(document).ready(function () {
 				mention = $('<div/>').html(mention);
 				// Strip letter avatar
 				mention.find('span').remove();
-				return '@' + slugify(mention.text(), true) + ' ';
+
+				const text = mention.text().trim();
+				const categoryHandle = categorySlugMap.get(text.toLowerCase());
+				if (categoryHandle) {
+					return `@${categoryHandle}`;
+				}
+
+				return '@' + slugify(text, true) + ' ';
 			},
 			cache: true,
 		};
@@ -75,23 +90,25 @@ $(document).ready(function () {
 		composer.attr('data-mentions', '1');
 	});
 
-	function sortUsers(users) {
-		return users.sort(function (user1, user2) {
-			return user1.username.toLocaleLowerCase() > user2.username.toLocaleLowerCase() ? 1 : -1;
+	function sortEntries(entries) {
+		return entries.sort(function (entry1, entry2) {
+			const comparator1 = entry1.username || entry1.name;
+			const comparator2 = entry2.username || entry2.name;
+			return comparator1.toLocaleLowerCase() > comparator2.toLocaleLowerCase() ? 1 : -1;
 		});
 	}
 
-	function usersToMentions(users, helpers) {
-		return users.reduce(function (carry, user) {
+	function entriesToMentions(entries, helpers) {
+		return entries.reduce(function (carry, entry) {
 			// Don't add current user to suggestions
-			if (app.user.username && app.user.username === user.username) {
+			if (app.user.username && app.user.username === entry.username) {
 				return carry;
 			}
 
-			// Format suggestions as 'avatar username (fullname)'
-			const avatar = helpers.buildAvatar(user, '24px', true);
-			const fullname = user.fullname ? `(${user.fullname})` : '';
-			carry.push(`${avatar} ${user.username} ${helpers.escape(fullname)}`);
+			// Format suggestions as 'avatar username/name (fullname)'
+			const avatar = entry.uid ? helpers.buildAvatar(entry, '24px', true) : '';
+			const fullname = entry.fullname ? `(${entry.fullname})` : '';
+			carry.push(`${avatar} ${entry.username || entry.name} ${helpers.escape(fullname)}`);
 
 			return carry;
 		}, []);
@@ -141,4 +158,14 @@ $(document).ready(function () {
 			groupList = groupNames;
 		});
 	}
+
+	function loadCategoryList() {
+		require(['api'], async (api) => {
+			const { categories } = await api.get('/categories');
+			categoryList = categories;
+			categories.forEach((category) => {
+				categorySlugMap.set(category.name.toLowerCase(), category.handle);
+			});
+		});
+	}
 });