feat: Version 2

Closes #627, closes #1047

server/api/helpers/labels/create-one.js

@@ -1,24 +1,12 @@
-const valuesValidator = (value) => {
-  if (!_.isPlainObject(value)) {
-    return false;
-  }
-
-  if (!_.isFinite(value.position)) {
-    return false;
-  }
-
-  if (!_.isPlainObject(value.board)) {
-    return false;
-  }
-
-  return true;
-};
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
 
 module.exports = {
   inputs: {
     values: {
       type: 'ref',
-      custom: valuesValidator,
       required: true,
     },
     project: {
@@ -37,36 +25,41 @@ module.exports = {
   async fn(inputs) {
     const { values } = inputs;
 
-    const labels = await sails.helpers.boards.getLabels(values.board.id);
+    const labels = await Label.qm.getByBoardId(values.board.id);
 
     const { position, repositions } = sails.helpers.utils.insertToPositionables(
       values.position,
       labels,
     );
 
-    repositions.forEach(async ({ id, position: nextPosition }) => {
-      await Label.update({
-        id,
-        boardId: values.board.id,
-      }).set({
-        position: nextPosition,
-      });
+    // eslint-disable-next-line no-restricted-syntax
+    for (const reposition of repositions) {
+      // eslint-disable-next-line no-await-in-loop
+      await Label.qm.updateOne(
+        {
+          id: reposition.record.id,
+          boardId: reposition.record.boardId,
+        },
+        {
+          position: reposition.position,
+        },
+      );
 
       sails.sockets.broadcast(`board:${values.board.id}`, 'labelUpdate', {
         item: {
-          id,
-          position: nextPosition,
+          id: reposition.record.id,
+          position: reposition.position,
         },
       });
 
       // TODO: send webhooks
-    });
+    }
 
-    const label = await Label.create({
+    const label = await Label.qm.createOne({
       ...values,
       position,
       boardId: values.board.id,
-    }).fetch();
+    });
 
     sails.sockets.broadcast(
       `board:${label.boardId}`,
@@ -79,13 +72,13 @@ module.exports = {
 
     sails.helpers.utils.sendWebhooks.with({
       event: 'labelCreate',
-      data: {
+      buildData: () => ({
         item: label,
         included: {
           projects: [inputs.project],
           boards: [values.board],
         },
-      },
+      }),
       user: inputs.actorUser,
     });
 

server/api/helpers/labels/delete-one.js

@@ -1,3 +1,8 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
 module.exports = {
   inputs: {
     record: {
@@ -22,11 +27,9 @@ module.exports = {
   },
 
   async fn(inputs) {
-    await CardLabel.destroy({
-      labelId: inputs.record.id,
-    });
+    await sails.helpers.labels.deleteRelated(inputs.record);
 
-    const label = await Label.archiveOne(inputs.record.id);
+    const label = await Label.qm.deleteOne(inputs.record.id);
 
     if (label) {
       sails.sockets.broadcast(
@@ -40,13 +43,13 @@ module.exports = {
 
       sails.helpers.utils.sendWebhooks.with({
         event: 'labelDelete',
-        data: {
+        buildData: () => ({
           item: label,
           included: {
             projects: [inputs.project],
             boards: [inputs.board],
           },
-        },
+        }),
         user: inputs.actorUser,
       });
     }

server/api/helpers/labels/delete-related.js

@@ -0,0 +1,28 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+module.exports = {
+  inputs: {
+    recordOrRecords: {
+      type: 'ref',
+      required: true,
+    },
+  },
+
+  async fn(inputs) {
+    let labelIdOrIds;
+    if (_.isPlainObject(inputs.recordOrRecords)) {
+      ({
+        recordOrRecords: { id: labelIdOrIds },
+      } = inputs);
+    } else if (_.every(inputs.recordOrRecords, _.isPlainObject)) {
+      labelIdOrIds = sails.helpers.utils.mapRecords(inputs.recordOrRecords);
+    }
+
+    await CardLabel.qm.delete({
+      labelId: labelIdOrIds,
+    });
+  },
+};

server/api/helpers/labels/get-many.js

@@ -1,14 +0,0 @@
-const criteriaValidator = (value) => _.isArray(value) || _.isPlainObject(value);
-
-module.exports = {
-  inputs: {
-    criteria: {
-      type: 'json',
-      custom: criteriaValidator,
-    },
-  },
-
-  async fn(inputs) {
-    return Label.find(inputs.criteria).sort('position');
-  },
-};

server/api/helpers/labels/get-path-to-project-by-id.js

@@ -0,0 +1,39 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+module.exports = {
+  inputs: {
+    id: {
+      type: 'string',
+      required: true,
+    },
+  },
+
+  exits: {
+    pathNotFound: {},
+  },
+
+  async fn(inputs) {
+    const label = await Label.qm.getOneById(inputs.id);
+
+    if (!label) {
+      throw 'pathNotFound';
+    }
+
+    const pathToProject = await sails.helpers.boards
+      .getPathToProjectById(label.boardId)
+      .intercept('pathNotFound', (nodes) => ({
+        pathNotFound: {
+          label,
+          ...nodes,
+        },
+      }));
+
+    return {
+      label,
+      ...pathToProject,
+    };
+  },
+};

server/api/helpers/labels/get-project-path.js

@@ -1,34 +0,0 @@
-module.exports = {
-  inputs: {
-    criteria: {
-      type: 'json',
-      required: true,
-    },
-  },
-
-  exits: {
-    pathNotFound: {},
-  },
-
-  async fn(inputs) {
-    const label = await Label.findOne(inputs.criteria);
-
-    if (!label) {
-      throw 'pathNotFound';
-    }
-
-    const path = await sails.helpers.boards
-      .getProjectPath(label.boardId)
-      .intercept('pathNotFound', (nodes) => ({
-        pathNotFound: {
-          label,
-          ...nodes,
-        },
-      }));
-
-    return {
-      label,
-      ...path,
-    };
-  },
-};

server/api/helpers/labels/update-one.js

@@ -1,14 +1,7 @@
-const valuesValidator = (value) => {
-  if (!_.isPlainObject(value)) {
-    return false;
-  }
-
-  if (!_.isUndefined(value.position) && !_.isFinite(value.position)) {
-    return false;
-  }
-
-  return true;
-};
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
 
 module.exports = {
   inputs: {
@@ -18,7 +11,6 @@ module.exports = {
     },
     values: {
       type: 'json',
-      custom: valuesValidator,
       required: true,
     },
     project: {
@@ -42,7 +34,9 @@ module.exports = {
     const { values } = inputs;
 
     if (!_.isUndefined(values.position)) {
-      const labels = await sails.helpers.boards.getLabels(inputs.record.boardId, inputs.record.id);
+      const labels = await Label.qm.getByBoardId(inputs.record.boardId, {
+        exceptIdOrIds: inputs.record.id,
+      });
 
       const { position, repositions } = sails.helpers.utils.insertToPositionables(
         values.position,
@@ -51,26 +45,31 @@ module.exports = {
 
       values.position = position;
 
-      repositions.forEach(async ({ id, position: nextPosition }) => {
-        await Label.update({
-          id,
-          boardId: inputs.record.boardId,
-        }).set({
-          position: nextPosition,
-        });
+      // eslint-disable-next-line no-restricted-syntax
+      for (const reposition of repositions) {
+        // eslint-disable-next-line no-await-in-loop
+        await Label.qm.updateOne(
+          {
+            id: reposition.record.id,
+            boardId: reposition.record.boardId,
+          },
+          {
+            position: reposition.position,
+          },
+        );
 
         sails.sockets.broadcast(`board:${inputs.record.boardId}`, 'labelUpdate', {
           item: {
-            id,
-            position: nextPosition,
+            id: reposition.record.id,
+            position: reposition.position,
           },
         });
 
         // TODO: send webhooks
-      });
+      }
     }
 
-    const label = await Label.updateOne(inputs.record.id).set({ ...values });
+    const label = await Label.qm.updateOne(inputs.record.id, values);
 
     if (label) {
       sails.sockets.broadcast(
@@ -84,16 +83,16 @@ module.exports = {
 
       sails.helpers.utils.sendWebhooks.with({
         event: 'labelUpdate',
-        data: {
+        buildData: () => ({
           item: label,
           included: {
             projects: [inputs.project],
             boards: [inputs.board],
           },
-        },
-        prevData: {
+        }),
+        buildPrevData: () => ({
           item: inputs.record,
-        },
+        }),
         user: inputs.actorUser,
       });
     }