feat: Version 2

Closes #627, closes #1047

server/api/controllers/notifications/index.js

@@ -1,24 +1,21 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
 module.exports = {
   async fn() {
     const { currentUser } = this.req;
 
-    const notifications = await sails.helpers.users.getNotifications(currentUser.id);
+    const notifications = await Notification.qm.getUnreadByUserId(currentUser.id);
 
-    const actionIds = sails.helpers.utils.mapRecords(notifications, 'actionId');
-    const actions = await sails.helpers.actions.getMany(actionIds);
-
-    const userIds = sails.helpers.utils.mapRecords(actions, 'userId', true);
-    const users = await sails.helpers.users.getMany(userIds, true);
-
-    const cardIds = sails.helpers.utils.mapRecords(notifications, 'cardId');
-    const cards = await sails.helpers.cards.getMany(cardIds);
+    const userIds = sails.helpers.utils.mapRecords(notifications, 'creatorUserId', true, true);
+    const users = await User.qm.getByIds(userIds);
 
     return {
       items: notifications,
       included: {
-        users,
-        cards,
-        actions,
+        users: sails.helpers.users.presentMany(users, currentUser),
       },
     };
   },

server/api/controllers/notifications/read-all.js

@@ -0,0 +1,19 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+module.exports = {
+  async fn() {
+    const { currentUser } = this.req;
+
+    const notifications = await sails.helpers.notifications.readAllForUser.with({
+      user: currentUser,
+      request: this.req,
+    });
+
+    return {
+      items: notifications,
+    };
+  },
+};

server/api/controllers/notifications/show.js

@@ -1,3 +1,10 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+const { idInput } = require('../../../utils/inputs');
+
 const Errors = {
   NOTIFICATION_NOT_FOUND: {
     notificationNotFound: 'Notification not found',
@@ -7,8 +14,7 @@ const Errors = {
 module.exports = {
   inputs: {
     id: {
-      type: 'string',
-      regex: /^[0-9]+$/,
+      ...idInput,
       required: true,
     },
   },
@@ -22,9 +28,7 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    const notification = await Notification.findOne({
-      id: inputs.id,
-      isRead: false,
+    const notification = await Notification.qm.getOneById(inputs.id, {
       userId: currentUser.id,
     });
 
@@ -32,16 +36,14 @@ module.exports = {
       throw Errors.NOTIFICATION_NOT_FOUND;
     }
 
-    const action = await Action.findOne(notification.actionId);
-    const user = await sails.helpers.users.getOne(action.userId, true);
-    const card = await Card.findOne(notification.cardId);
+    const users = notification.creatorUserId
+      ? await User.qm.getByIds([notification.creatorUserId])
+      : [];
 
     return {
       item: notification,
       included: {
-        users: [user],
-        cards: [card],
-        actions: [action],
+        users,
       },
     };
   },

server/api/controllers/notifications/update.js

@@ -1,29 +1,59 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+const { idInput } = require('../../../utils/inputs');
+
+const Errors = {
+  NOTIFICATION_NOT_FOUND: {
+    notificationNotFound: 'Notification not found',
+  },
+};
+
 module.exports = {
   inputs: {
-    ids: {
-      type: 'string',
+    id: {
+      ...idInput,
       required: true,
-      regex: /^[0-9]+(,[0-9]+)*$/,
     },
     isRead: {
       type: 'boolean',
     },
   },
 
+  exits: {
+    notificationNotFound: {
+      responseType: 'notFound',
+    },
+  },
+
   async fn(inputs) {
     const { currentUser } = this.req;
 
+    let notification = await Notification.qm.getOneById(inputs.id, {
+      userId: currentUser.id,
+    });
+
+    if (!notification) {
+      throw Errors.NOTIFICATION_NOT_FOUND;
+    }
+
     const values = _.pick(inputs, ['isRead']);
 
-    const notifications = await sails.helpers.notifications.updateMany.with({
+    notification = await sails.helpers.notifications.updateOne.with({
       values,
-      recordsOrIds: inputs.ids.split(','),
+      record: notification,
       actorUser: currentUser,
       request: this.req,
     });
 
+    if (!notification) {
+      throw Errors.NOTIFICATION_NOT_FOUND;
+    }
+
     return {
-      items: notifications,
+      item: notification,
     };
   },
 };