feat: Version 2

Closes #627, closes #1047

server/api/helpers/base-custom-field-groups/create-one.js

@@ -0,0 +1,59 @@
+/*!
+ * 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,
+    },
+    actorUser: {
+      type: 'ref',
+      required: true,
+    },
+    request: {
+      type: 'ref',
+    },
+  },
+
+  async fn(inputs) {
+    const { values } = inputs;
+
+    const baseCustomFieldGroup = await BaseCustomFieldGroup.qm.createOne({
+      ...values,
+      projectId: values.project.id,
+    });
+
+    const scoper = sails.helpers.projects.makeScoper.with({
+      record: values.project,
+    });
+
+    const projectRelatedUserIds = await scoper.getProjectRelatedUserIds();
+
+    projectRelatedUserIds.forEach((userId) => {
+      sails.sockets.broadcast(
+        `user:${userId}`,
+        'baseCustomFieldGroupCreate',
+        {
+          item: baseCustomFieldGroup,
+        },
+        inputs.request,
+      );
+    });
+
+    sails.helpers.utils.sendWebhooks.with({
+      event: 'baseCustomFieldGroupCreate',
+      buildData: () => ({
+        item: baseCustomFieldGroup,
+        included: {
+          projects: [values.project],
+        },
+      }),
+      user: inputs.actorUser,
+    });
+
+    return baseCustomFieldGroup;
+  },
+};

server/api/helpers/base-custom-field-groups/delete-one.js

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

server/api/helpers/base-custom-field-groups/delete-related.js

@@ -0,0 +1,34 @@
+/*!
+ * 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 baseCustomFieldGroupIdOrIds;
+    if (_.isPlainObject(inputs.recordOrRecords)) {
+      ({
+        recordOrRecords: { id: baseCustomFieldGroupIdOrIds },
+      } = inputs);
+    } else if (_.every(inputs.recordOrRecords, _.isPlainObject)) {
+      baseCustomFieldGroupIdOrIds = sails.helpers.utils.mapRecords(inputs.recordOrRecords);
+    }
+
+    const customFieldGroups = await CustomFieldGroup.qm.delete({
+      baseCustomFieldGroupId: baseCustomFieldGroupIdOrIds,
+    });
+
+    await sails.helpers.customFieldGroups.deleteRelated(customFieldGroups);
+
+    await CustomField.qm.delete({
+      baseCustomFieldGroupId: baseCustomFieldGroupIdOrIds,
+    });
+  },
+};

server/api/helpers/base-custom-field-groups/get-path-to-project-by-id.js

@@ -0,0 +1,40 @@
+/*!
+ * 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 baseCustomFieldGroup = await BaseCustomFieldGroup.qm.getOneById(inputs.id);
+
+    if (!baseCustomFieldGroup) {
+      throw 'pathNotFound';
+    }
+
+    const project = await Project.qm.getOneById(baseCustomFieldGroup.projectId);
+
+    if (!project) {
+      throw {
+        pathNotFound: {
+          baseCustomFieldGroup,
+        },
+      };
+    }
+
+    return {
+      baseCustomFieldGroup,
+      project,
+    };
+  },
+};

server/api/helpers/base-custom-field-groups/update-one.js

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