feat: Version 2

Closes #627, closes #1047

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

@@ -0,0 +1,110 @@
+/*!
+ * 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',
+      required: true,
+    },
+    project: {
+      type: 'ref',
+      required: true,
+    },
+    actorUser: {
+      type: 'ref',
+      required: true,
+    },
+    request: {
+      type: 'ref',
+    },
+  },
+
+  exits: {
+    baseCustomFieldGroupMustBeInValues: {},
+  },
+
+  async fn(inputs) {
+    const { values } = inputs;
+
+    if (!values.baseCustomFieldGroup) {
+      throw 'baseCustomFieldGroupMustBeInValues';
+    }
+
+    const scoper = sails.helpers.projects.makeScoper.with({
+      record: inputs.project,
+    });
+
+    const customFieldGroupRelatedUserIds = await scoper.getProjectRelatedUserIds();
+
+    if (!_.isUndefined(values.position)) {
+      const customFields = await CustomField.qm.getByBaseCustomFieldGroupId(
+        values.baseCustomFieldGroup.id,
+      );
+
+      const { position, repositions } = sails.helpers.utils.insertToPositionables(
+        values.position,
+        customFields,
+      );
+
+      values.position = position;
+
+      // eslint-disable-next-line no-restricted-syntax
+      for (const reposition of repositions) {
+        // eslint-disable-next-line no-await-in-loop
+        await CustomField.qm.updateOne(
+          {
+            id: reposition.record.id,
+            baseCustomFieldGroupId: reposition.record.baseCustomFieldGroupId,
+          },
+          {
+            position: reposition.position,
+          },
+        );
+
+        customFieldGroupRelatedUserIds.forEach((userId) => {
+          sails.sockets.broadcast(`user:${userId}`, 'customFieldUpdate', {
+            item: {
+              id: reposition.record.id,
+              position: reposition.position,
+            },
+          });
+        });
+
+        // TODO: send webhooks
+      }
+    }
+
+    const customField = await CustomField.qm.createOne({
+      ...values,
+      baseCustomFieldGroupId: values.baseCustomFieldGroup.id,
+    });
+
+    customFieldGroupRelatedUserIds.forEach((userId) => {
+      sails.sockets.broadcast(
+        `user:${userId}`,
+        'customFieldCreate',
+        {
+          item: customField,
+        },
+        inputs.request,
+      );
+    });
+
+    sails.helpers.utils.sendWebhooks.with({
+      event: 'customFieldCreate',
+      buildData: () => ({
+        item: customField,
+        included: {
+          projects: [inputs.project],
+          baseCustomFieldGroups: [values.baseCustomFieldGroup],
+        },
+      }),
+      user: inputs.actorUser,
+    });
+
+    return customField;
+  },
+};

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

@@ -0,0 +1,127 @@
+/*!
+ * 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',
+      required: true,
+    },
+    project: {
+      type: 'ref',
+      required: true,
+    },
+    board: {
+      type: 'ref',
+      required: true,
+    },
+    list: {
+      type: 'ref',
+    },
+    card: {
+      type: 'ref',
+    },
+    actorUser: {
+      type: 'ref',
+      required: true,
+    },
+    request: {
+      type: 'ref',
+    },
+  },
+
+  exits: {
+    customFieldGroupMustBeInValues: {},
+    listMustBePresent: {},
+    cardMustBePresent: {},
+  },
+
+  async fn(inputs) {
+    const { values } = inputs;
+
+    if (!values.customFieldGroup) {
+      throw 'customFieldGroupMustBeInValues';
+    }
+
+    if (values.customFieldGroup.cardId) {
+      if (!inputs.list) {
+        throw 'listMustBePresent';
+      }
+
+      if (!inputs.card) {
+        throw 'cardMustBePresent';
+      }
+    }
+
+    if (!_.isUndefined(values.position)) {
+      const customFields = await CustomField.qm.getByCustomFieldGroupId(values.customFieldGroup.id);
+
+      const { position, repositions } = sails.helpers.utils.insertToPositionables(
+        values.position,
+        customFields,
+      );
+
+      values.position = position;
+
+      // eslint-disable-next-line no-restricted-syntax
+      for (const reposition of repositions) {
+        // eslint-disable-next-line no-await-in-loop
+        await CustomField.qm.updateOne(
+          {
+            id: reposition.record.id,
+            customFieldGroupId: reposition.record.customFieldGroupId,
+          },
+          {
+            position: reposition.position,
+          },
+        );
+
+        sails.sockets.broadcast(`board:${inputs.board.id}`, 'customFieldUpdate', {
+          item: {
+            id: reposition.record.id,
+            position: reposition.position,
+          },
+        });
+
+        // TODO: send webhooks
+      }
+    }
+
+    const customField = await CustomField.qm.createOne({
+      ...values,
+      customFieldGroupId: values.customFieldGroup.id,
+    });
+
+    sails.sockets.broadcast(
+      `board:${inputs.board.id}`,
+      'customFieldCreate',
+      {
+        item: customField,
+      },
+      inputs.request,
+    );
+
+    sails.helpers.utils.sendWebhooks.with({
+      event: 'customFieldCreate',
+      buildData: () => ({
+        item: customField,
+        included: {
+          projects: [inputs.project],
+          boards: [inputs.board],
+          customFieldGroups: [values.customFieldGroup],
+          ...(inputs.list && {
+            lists: [inputs.list],
+          }),
+          ...(inputs.card && {
+            cards: [inputs.card],
+          }),
+        },
+      }),
+      user: inputs.actorUser,
+    });
+
+    return customField;
+  },
+};

server/api/helpers/custom-fields/delete-one-in-base-custom-field-group.js

@@ -0,0 +1,67 @@
+/*!
+ * 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: {
+      type: 'ref',
+      required: true,
+    },
+    project: {
+      type: 'ref',
+      required: true,
+    },
+    baseCustomFieldGroup: {
+      type: 'ref',
+      required: true,
+    },
+    actorUser: {
+      type: 'ref',
+      required: true,
+    },
+    request: {
+      type: 'ref',
+    },
+  },
+
+  async fn(inputs) {
+    await sails.helpers.customFields.deleteRelated(inputs.record);
+
+    const customField = await CustomField.qm.deleteOne(inputs.record.id);
+
+    if (customField) {
+      const scoper = sails.helpers.projects.makeScoper.with({
+        record: inputs.project,
+      });
+
+      const customFieldGroupRelatedUserIds = await scoper.getProjectRelatedUserIds();
+
+      customFieldGroupRelatedUserIds.forEach((userId) => {
+        sails.sockets.broadcast(
+          `user:${userId}`,
+          'customFieldDelete',
+          {
+            item: customField,
+          },
+          inputs.request,
+        );
+      });
+
+      sails.helpers.utils.sendWebhooks.with({
+        event: 'customFieldDelete',
+        buildData: () => ({
+          item: customField,
+          included: {
+            projects: [inputs.project],
+            baseCustomFieldGroups: [inputs.baseCustomFieldGroup],
+          },
+        }),
+        user: inputs.actorUser,
+      });
+    }
+
+    return customField;
+  },
+};

server/api/helpers/custom-fields/delete-one-in-custom-field-group.js

@@ -0,0 +1,91 @@
+/*!
+ * 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: {
+      type: 'ref',
+      required: true,
+    },
+    project: {
+      type: 'ref',
+      required: true,
+    },
+    board: {
+      type: 'ref',
+      required: true,
+    },
+    list: {
+      type: 'ref',
+    },
+    card: {
+      type: 'ref',
+    },
+    customFieldGroup: {
+      type: 'ref',
+      required: true,
+    },
+    actorUser: {
+      type: 'ref',
+      required: true,
+    },
+    request: {
+      type: 'ref',
+    },
+  },
+
+  exits: {
+    listMustBePresent: {},
+    cardMustBePresent: {},
+  },
+
+  async fn(inputs) {
+    if (inputs.customFieldGroup.cardId) {
+      if (!inputs.list) {
+        throw 'listMustBePresent';
+      }
+
+      if (!inputs.card) {
+        throw 'cardMustBePresent';
+      }
+    }
+
+    await sails.helpers.customFields.deleteRelated(inputs.record);
+
+    const customField = await CustomField.qm.deleteOne(inputs.record.id);
+
+    if (customField) {
+      sails.sockets.broadcast(
+        `board:${inputs.board.id}`,
+        'customFieldDelete',
+        {
+          item: customField,
+        },
+        inputs.request,
+      );
+
+      sails.helpers.utils.sendWebhooks.with({
+        event: 'customFieldDelete',
+        buildData: () => ({
+          item: customField,
+          included: {
+            projects: [inputs.project],
+            boards: [inputs.board],
+            customFieldGroups: [inputs.customFieldGroup],
+            ...(inputs.list && {
+              lists: [inputs.list],
+            }),
+            ...(inputs.card && {
+              cards: [inputs.card],
+            }),
+          },
+        }),
+        user: inputs.actorUser,
+      });
+    }
+
+    return customField;
+  },
+};

server/api/helpers/custom-fields/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 customFieldIdOrIds;
+    if (_.isPlainObject(inputs.recordOrRecords)) {
+      ({
+        recordOrRecords: { id: customFieldIdOrIds },
+      } = inputs);
+    } else if (_.every(inputs.recordOrRecords, _.isPlainObject)) {
+      customFieldIdOrIds = sails.helpers.utils.mapRecords(inputs.recordOrRecords);
+    }
+
+    await CustomFieldValue.qm.delete({
+      customFieldId: customFieldIdOrIds,
+    });
+  },
+};

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

@@ -0,0 +1,51 @@
+/*!
+ * 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 customField = await CustomField.qm.getOneById(inputs.id);
+
+    if (!customField) {
+      throw 'pathNotFound';
+    }
+
+    let pathToProject;
+    if (customField.baseCustomFieldGroupId) {
+      pathToProject = await sails.helpers.baseCustomFieldGroups
+        .getPathToProjectById(customField.baseCustomFieldGroupId)
+        .intercept('pathNotFound', (nodes) => ({
+          pathNotFound: {
+            customField,
+            ...nodes,
+          },
+        }));
+    } else if (customField.customFieldGroupId) {
+      pathToProject = await sails.helpers.customFieldGroups
+        .getPathToProjectById(customField.customFieldGroupId)
+        .intercept('pathNotFound', (nodes) => ({
+          pathNotFound: {
+            customField,
+            ...nodes,
+          },
+        }));
+    }
+
+    return {
+      customField,
+      ...pathToProject,
+    };
+  },
+};

server/api/helpers/custom-fields/update-one-in-base-custom-field-group.js

@@ -0,0 +1,115 @@
+/*!
+ * 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: {
+      type: 'ref',
+      required: true,
+    },
+    values: {
+      type: 'json',
+      required: true,
+    },
+    project: {
+      type: 'ref',
+      required: true,
+    },
+    baseCustomFieldGroup: {
+      type: 'ref',
+      required: true,
+    },
+    actorUser: {
+      type: 'ref',
+      required: true,
+    },
+    request: {
+      type: 'ref',
+    },
+  },
+
+  async fn(inputs) {
+    const { values } = inputs;
+
+    const scoper = sails.helpers.projects.makeScoper.with({
+      record: inputs.project,
+    });
+
+    const customFieldGroupRelatedUserIds = await scoper.getProjectRelatedUserIds();
+
+    if (!_.isUndefined(values.position)) {
+      const customFields = await CustomField.qm.getByBaseCustomFieldGroupId(
+        inputs.record.baseCustomFieldGroupId,
+        {
+          exceptIdOrIds: inputs.record.id,
+        },
+      );
+
+      const { position, repositions } = sails.helpers.utils.insertToPositionables(
+        values.position,
+        customFields,
+      );
+
+      values.position = position;
+
+      // eslint-disable-next-line no-restricted-syntax
+      for (const reposition of repositions) {
+        // eslint-disable-next-line no-await-in-loop
+        await CustomField.qm.updateOne(
+          {
+            id: reposition.record.id,
+            baseCustomFieldGroupId: reposition.record.baseCustomFieldGroupId,
+          },
+          {
+            position: reposition.position,
+          },
+        );
+
+        customFieldGroupRelatedUserIds.forEach((userId) => {
+          sails.sockets.broadcast(`user:${userId}`, 'customFieldUpdate', {
+            item: {
+              id: reposition.record.id,
+              position: reposition.position,
+            },
+          });
+        });
+
+        // TODO: send webhooks
+      }
+    }
+
+    const customField = await CustomField.qm.updateOne(inputs.record.id, values);
+
+    if (customField) {
+      customFieldGroupRelatedUserIds.forEach((userId) => {
+        sails.sockets.broadcast(
+          `user:${userId}`,
+          'customFieldUpdate',
+          {
+            item: customField,
+          },
+          inputs.request,
+        );
+      });
+
+      sails.helpers.utils.sendWebhooks.with({
+        event: 'customFieldUpdate',
+        buildData: () => ({
+          item: customField,
+          included: {
+            projects: [inputs.project],
+            baseCustomFieldGroups: [inputs.baseCustomFieldGroup],
+          },
+        }),
+        buildPrevData: () => ({
+          item: inputs.record,
+        }),
+        user: inputs.actorUser,
+      });
+    }
+
+    return customField;
+  },
+};

server/api/helpers/custom-fields/update-one-in-custom-field-group.js

@@ -0,0 +1,137 @@
+/*!
+ * 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: {
+      type: 'ref',
+      required: true,
+    },
+    values: {
+      type: 'json',
+      required: true,
+    },
+    project: {
+      type: 'ref',
+      required: true,
+    },
+    board: {
+      type: 'ref',
+      required: true,
+    },
+    list: {
+      type: 'ref',
+    },
+    card: {
+      type: 'ref',
+    },
+    customFieldGroup: {
+      type: 'ref',
+      required: true,
+    },
+    actorUser: {
+      type: 'ref',
+      required: true,
+    },
+    request: {
+      type: 'ref',
+    },
+  },
+
+  exits: {
+    listMustBePresent: {},
+    cardMustBePresent: {},
+  },
+
+  async fn(inputs) {
+    const { values } = inputs;
+
+    if (inputs.customFieldGroup.cardId) {
+      if (!inputs.list) {
+        throw 'listMustBePresent';
+      }
+
+      if (!inputs.card) {
+        throw 'cardMustBePresent';
+      }
+    }
+
+    if (!_.isUndefined(values.position)) {
+      const customFields = await CustomField.qm.getByCustomFieldGroupId(
+        inputs.record.customFieldGroupId,
+        {
+          exceptIdOrIds: inputs.record.id,
+        },
+      );
+
+      const { position, repositions } = sails.helpers.utils.insertToPositionables(
+        values.position,
+        customFields,
+      );
+
+      values.position = position;
+
+      // eslint-disable-next-line no-restricted-syntax
+      for (const reposition of repositions) {
+        // eslint-disable-next-line no-await-in-loop
+        await CustomField.qm.updateOne(
+          {
+            id: reposition.record.id,
+            customFieldGroupId: reposition.record.customFieldGroupId,
+          },
+          {
+            position: reposition.position,
+          },
+        );
+
+        sails.sockets.broadcast(`board:${inputs.board.id}`, 'customFieldUpdate', {
+          item: {
+            id: reposition.record.id,
+            position: reposition.position,
+          },
+        });
+
+        // TODO: send webhooks
+      }
+    }
+
+    const customField = await CustomField.qm.updateOne(inputs.record.id, values);
+
+    if (customField) {
+      sails.sockets.broadcast(
+        `board:${inputs.board.id}`,
+        'customFieldUpdate',
+        {
+          item: customField,
+        },
+        inputs.request,
+      );
+
+      sails.helpers.utils.sendWebhooks.with({
+        event: 'customFieldUpdate',
+        buildData: () => ({
+          item: customField,
+          included: {
+            projects: [inputs.project],
+            boards: [inputs.board],
+            customFieldGroups: [inputs.customFieldGroup],
+            ...(inputs.list && {
+              lists: [inputs.list],
+            }),
+            ...(inputs.card && {
+              cards: [inputs.card],
+            }),
+          },
+        }),
+        buildPrevData: () => ({
+          item: inputs.record,
+        }),
+        user: inputs.actorUser,
+      });
+    }
+
+    return customField;
+  },
+};