feat: Version 2

Closes #627, closes #1047

server/api/controllers/custom-fields/create-in-base-custom-field-group.js

@@ -0,0 +1,70 @@
+/*!
+ * 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 = {
+  BASE_CUSTOM_FIELD_GROUP_NOT_FOUND: {
+    baseCustomFieldGroupNotFound: 'Base custom field group not found',
+  },
+};
+
+module.exports = {
+  inputs: {
+    baseCustomFieldGroupId: {
+      ...idInput,
+      required: true,
+    },
+    position: {
+      type: 'number',
+      min: 0,
+      required: true,
+    },
+    name: {
+      type: 'string',
+      maxLength: 128,
+      required: true,
+    },
+    showOnFrontOfCard: {
+      type: 'boolean',
+    },
+  },
+
+  exits: {
+    baseCustomFieldGroupNotFound: {
+      responseType: 'notFound',
+    },
+  },
+
+  async fn(inputs) {
+    const { currentUser } = this.req;
+
+    const { baseCustomFieldGroup, project } = await sails.helpers.baseCustomFieldGroups
+      .getPathToProjectById(inputs.baseCustomFieldGroupId)
+      .intercept('pathNotFound', () => Errors.BASE_CUSTOM_FIELD_GROUP_NOT_FOUND);
+
+    const isProjectManager = await sails.helpers.users.isProjectManager(currentUser.id, project.id);
+
+    if (!isProjectManager) {
+      throw Errors.BASE_CUSTOM_FIELD_GROUP_NOT_FOUND; // Forbidden
+    }
+
+    const values = _.pick(inputs, ['position', 'name', 'showOnFrontOfCard']);
+
+    const customField = await sails.helpers.customFields.createOneInBaseCustomFieldGroup.with({
+      project,
+      values: {
+        ...values,
+        baseCustomFieldGroup,
+      },
+      actorUser: currentUser,
+      request: this.req,
+    });
+
+    return {
+      item: customField,
+    };
+  },
+};

server/api/controllers/custom-fields/create-in-custom-field-group.js

@@ -0,0 +1,86 @@
+/*!
+ * 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 = {
+  NOT_ENOUGH_RIGHTS: {
+    notEnoughRights: 'Not enough rights',
+  },
+  CUSTOM_FIELD_GROUP_NOT_FOUND: {
+    customFieldGroupNotFound: 'Custom field group not found',
+  },
+};
+
+module.exports = {
+  inputs: {
+    customFieldGroupId: {
+      ...idInput,
+      required: true,
+    },
+    position: {
+      type: 'number',
+      min: 0,
+      required: true,
+    },
+    name: {
+      type: 'string',
+      maxLength: 128,
+      required: true,
+    },
+    showOnFrontOfCard: {
+      type: 'boolean',
+    },
+  },
+
+  exits: {
+    notEnoughRights: {
+      responseType: 'forbidden',
+    },
+    customFieldGroupNotFound: {
+      responseType: 'notFound',
+    },
+  },
+
+  async fn(inputs) {
+    const { currentUser } = this.req;
+
+    const { customFieldGroup, card, list, board, project } = await sails.helpers.customFieldGroups
+      .getPathToProjectById(inputs.customFieldGroupId)
+      .intercept('pathNotFound', () => Errors.CUSTOM_FIELD_GROUP_NOT_FOUND);
+
+    const boardMembership = await BoardMembership.qm.getOneByBoardIdAndUserId(
+      board.id,
+      currentUser.id,
+    );
+
+    if (!boardMembership) {
+      throw Errors.CUSTOM_FIELD_GROUP_NOT_FOUND; // Forbidden
+    }
+
+    if (boardMembership.role !== BoardMembership.Roles.EDITOR) {
+      throw Errors.NOT_ENOUGH_RIGHTS;
+    }
+
+    const values = _.pick(inputs, ['position', 'name', 'showOnFrontOfCard']);
+
+    const customField = await sails.helpers.customFields.createOneInCustomFieldGroup.with({
+      project,
+      board,
+      list,
+      card,
+      values: {
+        ...values,
+        customFieldGroup,
+      },
+      actorUser: currentUser,
+      request: this.req,
+    });
+
+    return {
+      item: customField,
+    };
+  },
+};

server/api/controllers/custom-fields/delete.js

@@ -0,0 +1,95 @@
+/*!
+ * 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 = {
+  NOT_ENOUGH_RIGHTS: {
+    notEnoughRights: 'Not enough rights',
+  },
+  CUSTOM_FIELD_NOT_FOUND: {
+    customFieldNotFound: 'Custom field not found',
+  },
+};
+
+module.exports = {
+  inputs: {
+    id: {
+      ...idInput,
+      required: true,
+    },
+  },
+
+  exits: {
+    notEnoughRights: {
+      responseType: 'forbidden',
+    },
+    customFieldNotFound: {
+      responseType: 'notFound',
+    },
+  },
+
+  async fn(inputs) {
+    const { currentUser } = this.req;
+
+    const pathToProject = await sails.helpers.customFields
+      .getPathToProjectById(inputs.id)
+      .intercept('pathNotFound', () => Errors.CUSTOM_FIELD_NOT_FOUND);
+
+    let { customField } = pathToProject;
+    const { customFieldGroup, card, list, board, baseCustomFieldGroup, project } = pathToProject;
+
+    if (customField.baseCustomFieldGroupId) {
+      const isProjectManager = await sails.helpers.users.isProjectManager(
+        currentUser.id,
+        project.id,
+      );
+
+      if (!isProjectManager) {
+        throw Errors.CUSTOM_FIELD_NOT_FOUND; // Forbidden
+      }
+
+      customField = await sails.helpers.customFields.deleteOneInBaseCustomFieldGroup.with({
+        project,
+        baseCustomFieldGroup,
+        record: customField,
+        actorUser: currentUser,
+        request: this.req,
+      });
+    } else if (customField.customFieldGroupId) {
+      const boardMembership = await BoardMembership.qm.getOneByBoardIdAndUserId(
+        board.id,
+        currentUser.id,
+      );
+
+      if (!boardMembership) {
+        throw Errors.CUSTOM_FIELD_NOT_FOUND; // Forbidden
+      }
+
+      if (boardMembership.role !== BoardMembership.Roles.EDITOR) {
+        throw Errors.NOT_ENOUGH_RIGHTS;
+      }
+
+      customField = await sails.helpers.customFields.deleteOneInCustomFieldGroup.with({
+        project,
+        board,
+        list,
+        card,
+        customFieldGroup,
+        record: customField,
+        actorUser: currentUser,
+        request: this.req,
+      });
+    }
+
+    if (!customField) {
+      throw Errors.CUSTOM_FIELD_NOT_FOUND;
+    }
+
+    return {
+      item: customField,
+    };
+  },
+};

server/api/controllers/custom-fields/update.js

@@ -0,0 +1,111 @@
+/*!
+ * 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 = {
+  NOT_ENOUGH_RIGHTS: {
+    notEnoughRights: 'Not enough rights',
+  },
+  CUSTOM_FIELD_NOT_FOUND: {
+    customFieldNotFound: 'Custom field not found',
+  },
+};
+
+module.exports = {
+  inputs: {
+    id: {
+      ...idInput,
+      required: true,
+    },
+    position: {
+      type: 'number',
+      min: 0,
+    },
+    name: {
+      type: 'string',
+      isNotEmptyString: true,
+      maxLength: 128,
+    },
+    showOnFrontOfCard: {
+      type: 'boolean',
+    },
+  },
+
+  exits: {
+    notEnoughRights: {
+      responseType: 'forbidden',
+    },
+    customFieldNotFound: {
+      responseType: 'notFound',
+    },
+  },
+
+  async fn(inputs) {
+    const { currentUser } = this.req;
+
+    const pathToProject = await sails.helpers.customFields
+      .getPathToProjectById(inputs.id)
+      .intercept('pathNotFound', () => Errors.CUSTOM_FIELD_NOT_FOUND);
+
+    let { customField } = pathToProject;
+    const { customFieldGroup, card, list, board, baseCustomFieldGroup, project } = pathToProject;
+
+    const values = _.pick(inputs, ['position', 'name', 'showOnFrontOfCard']);
+
+    if (customField.baseCustomFieldGroupId) {
+      const isProjectManager = await sails.helpers.users.isProjectManager(
+        currentUser.id,
+        project.id,
+      );
+
+      if (!isProjectManager) {
+        throw Errors.CUSTOM_FIELD_NOT_FOUND; // Forbidden
+      }
+
+      customField = await sails.helpers.customFields.updateOneInBaseCustomFieldGroup.with({
+        values,
+        project,
+        baseCustomFieldGroup,
+        record: customField,
+        actorUser: currentUser,
+        request: this.req,
+      });
+    } else if (customField.customFieldGroupId) {
+      const boardMembership = await BoardMembership.qm.getOneByBoardIdAndUserId(
+        board.id,
+        currentUser.id,
+      );
+
+      if (!boardMembership) {
+        throw Errors.CUSTOM_FIELD_NOT_FOUND; // Forbidden
+      }
+
+      if (boardMembership.role !== BoardMembership.Roles.EDITOR) {
+        throw Errors.NOT_ENOUGH_RIGHTS;
+      }
+
+      customField = await sails.helpers.customFields.updateOneInCustomFieldGroup.with({
+        values,
+        project,
+        board,
+        list,
+        card,
+        customFieldGroup,
+        record: customField,
+        actorUser: currentUser,
+        request: this.req,
+      });
+    }
+
+    if (!customField) {
+      throw Errors.CUSTOM_FIELD_NOT_FOUND;
+    }
+
+    return {
+      item: customField,
+    };
+  },
+};