@nodebb/nodebb-plugin-reactions 1.0.3 → 2.0.1

package/README.md

@@ -1,2 +1,12 @@
 # nodebb-plugin-reactions
 Reactions plugin for NodeBB
+
+# Screenshots
+
+## Reactions:
+![CleanShot 2023-05-11 at 08 53 48@2x](https://github.com/ShlomoCode/nodebb-plugin-reactions/assets/78599753/613cb49e-994a-4869-a721-c1eeb00959ff)
+
+
+## ACP:
+![CleanShot 2023-05-11 at 04 09 11@2x](https://github.com/ShlomoCode/nodebb-plugin-reactions/assets/78599753/f4a4e5cb-f060-4415-a337-222a157a6e59)
+

package/languages/en-GB/reactions.json

@@ -2,5 +2,17 @@
   "reactions": "Reactions",
   "add-reaction": "Add reaction",
   "error.invalid-reaction": "Invalid reaction",
-  "error.maximum-reached": "Maximum reactions reached"
+  "error.maximum-reached": "Maximum reactions reached",
+  "error.maximum-per-user-per-post-reached": "Maximum reactions per user per post reached",
+  "settings.title": "Reactions plugin settings",
+  "settings.max-reactions-per-post": "Maximum unique reactions per post (0 for unlimited, default: 4)",
+  "settings.max-reactions-per-user-per-post": "Maximum reactions per user per post (0 for unlimited)",
+  "settings.max-reactions-per-user-per-post-help": "The limit is enforced only when adding a new reaction and not when joining an existing reaction.",
+  "settings.reaction-reputations": "Reaction Reputations (Optional)",
+  "settings.reaction-reputations-help": "You can assign a reputation to individual reactions. When a reaction is applied to a post, the owner of that post will get this reputation.",
+  "settings.reaction-reputations.add": "Add Rule",
+  "settings.reaction-reputations.reaction": "Reaction",
+  "settings.reaction-reputations.reputation": "Reputation",
+  "settings.reaction-reputations.remove": "Delete",
+  "settings.reaction-reputations.edit": "Edit"
 }

package/languages/he/reactions.json

@@ -0,0 +1,18 @@
+{
+  "reactions": "Reactions",
+  "add-reaction": "הוסף תגובה",
+  "error.invalid-reaction": "תגובה לא חוקית",
+  "error.maximum-reached": "הגעת למספר התגובות המקסימלי לפוסט",
+  "error.maximum-per-user-per-post-reached": "הגעת למספר התגובות המקסימלי למשתמש לפוסט",
+  "settings.title": "הגדרות תגובות",
+  "settings.max-reactions-per-post": "מספר התגובות המקסימלי לפוסט (0 = ללא הגבלה, ברירת מחדל: 4)",
+  "settings.max-reactions-per-user-per-post": "מספר התגובות המקסימלי למשתמש לפוסט (0 = ללא הגבלה)",
+  "settings.max-reactions-per-user-per-post-help": ".ההגבלה נאכפת רק בהוספת תגובה חדשה ולא בהצטרפות לתגובה קיימת",
+  "settings.reaction-reputations": "מוניטין תגובה (אופציונלי)",
+  "settings.reaction-reputations-help": "אתה יכול להקצות מוניטין לתגובות מסוימות. כאשר התגובה נוספת לפוסט, בעל הפוסט יקבל את המוניטין שנקבע.",
+  "settings.reaction-reputations.add": "הוסף כלל",
+  "settings.reaction-reputations.reaction": "תגובה",
+  "settings.reaction-reputations.reputation": "מוניטין",
+  "settings.reaction-reputations.remove": "הסר",
+  "settings.reaction-reputations.edit": "ערוך"
+}

package/library.js

@@ -13,7 +13,7 @@ const emojiParser = require.main.require('nodebb-plugin-emoji/build/lib/parse.js
 const emojiTable = require.main.require('nodebb-plugin-emoji/build/emoji/table.json');
 const emojiAliases = require.main.require('nodebb-plugin-emoji/build/emoji/aliases.json');
 
-const DEFAULT_MAX_EMOTES = 5;
+const DEFAULT_MAX_EMOTES = 4;
 
 function parse(name) {
 	return emojiParser.buildEmoji(emojiTable[name] || emojiTable[emojiAliases[name]], '');
@@ -71,7 +71,7 @@ ReactionsPlugin.getReactions = async function (data) {
 
 				if (reactionsList && reactionsList.length > 0) {
 					pidToReactionsMap.set(pid, reactionsList);
-					pidToIsMaxReactionsReachedMap.set(pid, reactionsCount >= maximumReactions);
+					pidToIsMaxReactionsReachedMap.set(pid, reactionsCount > maximumReactions);
 					reactionSets = reactionSets.concat(reactionsList.map(reaction => `pid:${pid}:reaction:${reaction}`));
 				}
 			} catch (e) {
@@ -203,33 +203,42 @@ SocketPlugins.reactions = {
 
 		data.uid = socket.uid;
 
-		try {
-			const settings = await meta.settings.get('reactions');
-			const maximumReactions = settings.maximumReactions || DEFAULT_MAX_EMOTES;
-			const [totalReactions, isMember, alreadyReacted, reactionReputation] = await Promise.all([
-				db.setCount(`pid:${data.pid}:reactions`),
-				db.isSetMember(`pid:${data.pid}:reactions`, data.reaction),
-				db.isSetMember(`pid:${data.pid}:reaction:${data.reaction}`, socket.uid),
-				getReactionReputation(data.reaction),
-			]);
+		const settings = await meta.settings.get('reactions');
+		const maximumReactions = settings.maximumReactions || DEFAULT_MAX_EMOTES;
+		const [totalReactions, emojiIsAlreadyExist, alreadyReacted, reactionReputation] = await Promise.all([
+			db.setCount(`pid:${data.pid}:reactions`),
+			db.isSetMember(`pid:${data.pid}:reactions`, data.reaction),
+			db.isSetMember(`pid:${data.pid}:reaction:${data.reaction}`, socket.uid),
+			getReactionReputation(data.reaction),
+		]);
 
-			if (!isMember && totalReactions >= maximumReactions) {
-				throw new Error('[[reactions:error.maximum-reached]]');
+		if (!emojiIsAlreadyExist) {
+			if (totalReactions > maximumReactions) {
+				throw new Error(`[[reactions:error.maximum-reached]] (${maximumReactions})`);
 			}
-
-			await Promise.all([
-				db.setAdd(`pid:${data.pid}:reactions`, data.reaction),
-				db.setAdd(`pid:${data.pid}:reaction:${data.reaction}`, socket.uid),
-			]);
-
-			if (!alreadyReacted && reactionReputation > 0) {
-				await giveOwnerReactionReputation(reactionReputation, data.pid);
+			
+			const maximumReactionsPerUserPerPost = settings.maximumReactionsPerUserPerPost ? parseInt(settings.maximumReactionsPerUserPerPost, 10) : 0;
+			if (maximumReactionsPerUserPerPost > 0) {
+				const emojiesInPost = await db.getSetMembers(`pid:${data.pid}:reactions`);
+				const userPostReactions = await db.isMemberOfSets(emojiesInPost.map(emojiName => `pid:${data.pid}:reaction:${emojiName}`), socket.uid);
+				const userPostReactionCount = userPostReactions.filter(Boolean).length;
+				if (userPostReactionCount > maximumReactionsPerUserPerPost) {
+					throw new Error(`[[reactions:error.maximum-per-user-per-post-reached]] (${maximumReactionsPerUserPerPost})`);
+				}
 			}
+		}
+		
 
-			await sendEvent(data, 'event:reactions.addPostReaction');
-		} catch (e) {
-			console.error(e);
+		await Promise.all([
+			db.setAdd(`pid:${data.pid}:reactions`, data.reaction),
+			db.setAdd(`pid:${data.pid}:reaction:${data.reaction}`, socket.uid),
+		]);
+
+		if (!alreadyReacted && reactionReputation > 0) {
+			await giveOwnerReactionReputation(reactionReputation, data.pid);
 		}
+
+		await sendEvent(data, 'event:reactions.addPostReaction');
 	},
 	removePostReaction: async function (socket, data) {
 		if (!socket.uid) {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@nodebb/nodebb-plugin-reactions",
-  "version": "1.0.3",
+  "version": "2.0.1",
   "nbbpm": {
-    "compatibility": "^1.19.7"
+    "compatibility": "^3.0.0"
   },
   "description": "Reactions plugin for NodeBB",
   "main": "library.js",
@@ -33,15 +33,14 @@
       "url": "https://github.com/barisusakli"
     }
   ],
-  "dependencies": {},
   "peerDependencies": {
-    "nodebb-plugin-emoji": "^4.0.0"
+    "nodebb-plugin-emoji": "^5.0.0"
   },
   "license": "MIT",
   "devDependencies": {
-    "eslint": "^7.32.0",
-    "eslint-config-nodebb": "0.0.2",
-    "eslint-plugin-import": "^2.24.1"
+    "eslint": "^8.40.0",
+    "eslint-config-nodebb": "^0.2.1",
+    "eslint-plugin-import": "^2.27.5"
   },
   "scripts": {
     "lint": "eslint ."

package/plugin.json

@@ -2,12 +2,12 @@
     "id": "nodebb-plugin-reactions",
     "name": "NodeBB Reactions",
     "description": "Reactions plugin for NodeBB",
-    "url": "https://github.com/pichalite/nodebb-plugin-reactions",
+    "url": "https://github.com/NodeBB-Community/nodebb-plugin-reactions",
     "library": "./library.js",
     "templates": "templates",
     "languages": "languages",
-    "less": [
-        "less/reactions.less"
+    "scss": [
+        "scss/reactions.scss"
     ],
     "scripts": [
         "public/client.js"

package/public/admin.js

@@ -1,7 +1,7 @@
 'use strict';
 
 define('admin/plugins/reactions', [
-	'settings',  'alerts', 'hooks', 'emoji-dialog', 'emoji',
+	'settings', 'alerts', 'hooks', 'emoji-dialog', 'emoji',
 ], function (Settings, alerts, hooks, emojiDialog, emoji) {
 	var ACP = {};
 	ACP.init = function () {
@@ -16,7 +16,7 @@ define('admin/plugins/reactions', [
 			if (reactionEl.length) {
 				const reaction = reactionEl.attr('data-reaction');
 				if (reaction) {
-					const foundEmoji = emoji.table[reaction]
+					const foundEmoji = emoji.table[reaction];
 					if (foundEmoji) {
 						reactionEl.html(emoji.buildEmoji(foundEmoji));
 					}
@@ -45,6 +45,7 @@ define('admin/plugins/reactions', [
 					alert_id: 'reactions-saved',
 					title: 'Settings Saved',
 					message: 'Reactions plugin settings saved',
+					timeout: 3000,
 				});
 			});
 		});

package/public/client.js

@@ -74,13 +74,13 @@ $(document).ready(function () {
 	}
 
 	function updateReactionCount(data) {
-		var maxReactionsReached = parseInt(data.totalReactions, 10) >= config.maximumReactions;
+		var maxReactionsReached = parseInt(data.totalReactions, 10) > config.maximumReactions;
 		$('[component="post/reaction/add"][data-pid="' + data.pid + '"]').toggleClass('max-reactions', maxReactionsReached);
 
-		var reactionEl = $('[component="post/reaction"][data-pid="' + data.pid + '"][data-reaction="' + data.reaction + '"]');
+		var reactionEl = $(`[component="post/reaction"][data-pid="${data.pid}"][data-reaction="${data.reaction}"]`);
 
 		if (parseInt(data.reactionCount, 10) === 0) {
-			reactionEl.tooltip('destroy');
+			reactionEl.tooltip('dispose');
 			reactionEl.remove();
 		}
 
@@ -94,21 +94,23 @@ $(document).ready(function () {
 				reactionImage: data.reactionImage,
 			}, function (html) {
 				$('[component="post/reactions"][data-pid="' + data.pid + '"]').append(html);
-				createReactionTooltips();
 			});
 		} else {
 			reactionEl.find('.reaction-emoji-count').attr('data-count', data.reactionCount);
-			reactionEl.attr('data-original-title', data.usernames);
+			reactionEl.attr('data-bs-original-title', data.usernames);
+			reactionEl.attr('aria-label', data.usernames);
 			reactionEl.toggleClass('reacted', !(parseInt(data.uid, 10) === app.user.uid));
 		}
+		createReactionTooltips();
 	}
 
 	function createReactionTooltips() {
 		$('.reaction, .reaction-add').each(function () {
 			if (!utils.isTouchDevice()) {
+				$(this).tooltip('dispose');
 				$(this).tooltip({
 					placement: 'top',
-					title: $(this).attr('title'),
+					title: $(this).attr('title') || $(this).attr('data-bs-original-title'),
 				});
 			}
 		});

package/scss/reactions.scss

@@ -0,0 +1,29 @@
+.reactions {
+	.reaction {
+		border: 1px solid #9ddefe;
+		display: inline-block;
+		border-radius: 4px;
+		padding: 2px 4px;
+		margin: 0 1px;
+		cursor: pointer;
+		.emoji {
+			height: 18px;
+		}
+		&.reacted {
+			border: 1px solid #039BE5;
+		}
+		.reaction-emoji-count {
+			margin-left: 5px;
+			&:before {
+				content: attr(data-count);
+			}
+		}
+	}
+	.reaction-add {
+		margin-right: 10px;
+		cursor: pointer;
+		&.max-reactions {
+			display: none !important;
+		}
+	}
+}

package/templates/admin/plugins/reactions/partials/sorted-list/emoji-form.tpl

@@ -1,10 +1,10 @@
 <form>
     <div class="form-group">
-        <label for="reaction">Reaction</label>
-        <input type="text" id="reaction" name="reaction" class="form-control" placeholder="Reaction" />
+        <label for="reaction">[[reactions:settings.reaction-reputations.reaction]]</label>
+        <input type="text" id="reaction" name="reaction" class="form-control" placeholder="[[reactions:settings.reaction-reputations.reaction]]" />
     </div>
     <div class="form-group">
-        <label for="reputation">Reputation</label>
-        <input type="number" id="reputation" name="reputation" class="form-control" placeholder="reputation" />
+        <label for="reputation">[[reactions:settings.reaction-reputations.reputation]]</label>
+        <input type="number" id="reputation" name="reputation" class="form-control" placeholder="[[reactions:settings.reaction-reputations.reputation]]" />
     </div>
 </form>

package/templates/admin/plugins/reactions/partials/sorted-list/emoji-item.tpl

@@ -2,11 +2,11 @@
     <div class="row">
         <div class="col-xs-9">
             <span data-reaction="{reaction}"></span><strong> {reaction}</strong><br />
-            <small>Reputation: {reputation}</small>
+            <small>[[reactions:settings.reaction-reputations.reaction]]: {reputation}</small>
         </div>
         <div class="col-xs-3 text-right">
-            <button type="button" data-type="edit" class="btn btn-info">Edit</button>
-            <button type="button" data-type="remove" class="btn btn-danger">Delete</button>
+            <button type="button" data-type="edit" class="btn btn-info">[[reactions:settings.reaction-reputations.edit]]</button>
+            <button type="button" data-type="remove" class="btn btn-danger">[[reactions:settings.reaction-reputations.remove]]</button>
         </div>
     </div>
 </li>

package/templates/admin/plugins/reactions.tpl

@@ -1,31 +1,33 @@
 <form role="form" class="reactions-settings">
 	<div class="row">
-		<div class="col-sm-2 col-xs-12 settings-header">Reactions plugin settings</div>
+		<div class="col-sm-2 col-xs-12 settings-header">[[reactions:settings.title]]</div>
 		<div class="col-sm-10 col-xs-12">
 			<div class="form-group">
-				<label>Maximum unique reactions per post</label>
-				<input type="text" class="form-control" id="maximumReactions" name="maximumReactions">
+				<label>[[reactions:settings.max-reactions-per-post]]</label>
+				<input type="number" min="0" class="form-control" id="maximumReactions" name="maximumReactions">
+
+				<label>[[reactions:settings.max-reactions-per-user-per-post]]</label>
+				<input type="number" min="0" class="form-control" id="maximumReactionsPerUserPerPost" name="maximumReactionsPerUserPerPost">
+				<p class="help-text">
+					[[reactions:settings.max-reactions-per-user-per-post-help]]
+				</p>
 			</div>
 		</div>
 	</div>
-	<div class="row">
-		<div class="col-sm-2 col-xs-12 settings-header">Reaction Reputations (Optional)</div>
+
+	<div class="row mt-3">
+		<div class="col-sm-2 col-xs-12 settings-header">[[reactions:settings.reaction-reputations]]</div>
 		<div class="col-sm-10 col-xs-12">
 			<p class="help-text">
-				You can assign a reputation to individual reactions. When a reaction is applied to a post, the owner of that post will get this reputation.
+				[[reactions:settings.reaction-reputations-help]]
 			</p>
 			<div class="form-group" data-type="sorted-list" data-sorted-list="reaction-reputations" data-item-template="admin/plugins/reactions/partials/sorted-list/emoji-item" data-form-template="admin/plugins/reactions/partials/sorted-list/emoji-form">
 				<ul data-type="list" class="list-group"></ul>
-				<button type="button" data-type="add" class="btn btn-info">Add Item</button>
+				<button type="button" data-type="add" class="btn btn-info mt-2">[[reactions:settings.reaction-reputations.add]]</button>
 			</div>
 		</div>
 	</div>
 </form>
 
 
-
-
-
-<button id="save" class="floating-button mdl-button mdl-js-button mdl-button--fab mdl-js-ripple-effect mdl-button--colored">
-    <i class="material-icons">save</i>
-</button>
+<!-- IMPORT admin/partials/save_button.tpl -->

package/templates/partials/topic/reactions.tpl

@@ -1,5 +1,5 @@
 <span class="reactions" component="post/reactions" data-pid="{./pid}">
-  <span class="reaction-add {{{ if ./maxReactionsReached }}}max-reactions{{{ end }}}" component="post/reaction/add" data-pid="{./pid}" title="[[reactions:add-reaction]]">
+  <span class="reaction-add d-inline-block px-2 mx-1 btn-ghost-sm {{{ if ./maxReactionsReached }}}max-reactions{{{ end }}}" component="post/reaction/add" data-pid="{./pid}" title="[[reactions:add-reaction]]">
     <i class="fa fa-plus-square-o"></i>
   </span>
   {{{ each ./reactions }}}

package/less/reactions.less

@@ -1,38 +0,0 @@
-@primary-color: #039BE5;
-
-.reactions {
-
-    .reaction {
-        border: 1px solid lighten(@primary-color, 35%);
-        display: inline-block;
-        border-radius: 4px;
-        padding: 2px 4px;
-        margin: 0 1px;
-        cursor: pointer;
-
-        .emoji {
-            height: 18px;
-        }
-
-        &.reacted {
-            border: 1px solid @primary-color;
-        }
-
-        .reaction-emoji-count {
-            margin-left: 5px;
-
-            &:before {
-                content: attr(data-count);
-            }
-        }
-    }
-
-    .reaction-add {
-        margin-right: 10px;
-        cursor: pointer;
-
-        &.max-reactions {
-            display: none;
-        }
-    }
-}