import Planka upstream

2026-07-18 11:48:22 +08:00
commit c26fd3b190
1564 changed files with 214813 additions and 0 deletions
@@ -0,0 +1,221 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+/**
+ * @swagger
+ * /lists/{id}:
+ *   get:
+ *     summary: Get list details
+ *     description: Retrieves comprehensive list information, including cards, attachments, and other related data. Requires access to the board.
+ *     tags:
+ *       - Lists
+ *     operationId: getList
+ *     parameters:
+ *       - name: id
+ *         in: path
+ *         required: true
+ *         description: ID of the list to retrieve
+ *         schema:
+ *           type: string
+ *           example: "1357158568008091264"
+ *     responses:
+ *       200:
+ *         description: List details retrieved successfully
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - item
+ *                 - included
+ *               properties:
+ *                 item:
+ *                   $ref: '#/components/schemas/List'
+ *                 included:
+ *                   type: object
+ *                   required:
+ *                     - users
+ *                     - cards
+ *                     - cardMemberships
+ *                     - cardLabels
+ *                     - taskLists
+ *                     - tasks
+ *                     - attachments
+ *                     - customFieldGroups
+ *                     - customFields
+ *                     - customFieldValues
+ *                   properties:
+ *                     users:
+ *                       type: array
+ *                       description: Related users
+ *                       items:
+ *                         $ref: '#/components/schemas/User'
+ *                     cards:
+ *                       type: array
+ *                       description: Related cards
+ *                       items:
+ *                         allOf:
+ *                           - $ref: '#/components/schemas/Card'
+ *                           - type: object
+ *                             properties:
+ *                               isSubscribed:
+ *                                 type: boolean
+ *                                 description: Whether the current user is subscribed to the card
+ *                                 example: true
+ *                     cardMemberships:
+ *                       type: array
+ *                       description: Related card-membership associations
+ *                       items:
+ *                         $ref: '#/components/schemas/CardMembership'
+ *                     cardLabels:
+ *                       type: array
+ *                       description: Related card-label associations
+ *                       items:
+ *                         $ref: '#/components/schemas/CardLabel'
+ *                     taskLists:
+ *                       type: array
+ *                       description: Related task lists
+ *                       items:
+ *                         $ref: '#/components/schemas/TaskList'
+ *                     tasks:
+ *                       type: array
+ *                       description: Related tasks
+ *                       items:
+ *                         $ref: '#/components/schemas/Task'
+ *                     attachments:
+ *                       type: array
+ *                       description: Related attachments
+ *                       items:
+ *                         $ref: '#/components/schemas/Attachment'
+ *                     customFieldGroups:
+ *                       type: array
+ *                       description: Related custom field groups
+ *                       items:
+ *                         $ref: '#/components/schemas/CustomFieldGroup'
+ *                     customFields:
+ *                       type: array
+ *                       description: Related custom fields
+ *                       items:
+ *                         $ref: '#/components/schemas/CustomField'
+ *                     customFieldValues:
+ *                       type: array
+ *                       description: Related custom field values
+ *                       items:
+ *                         $ref: '#/components/schemas/CustomFieldValue'
+ *       400:
+ *         $ref: '#/components/responses/ValidationError'
+ *       401:
+ *         $ref: '#/components/responses/Unauthorized'
+ *       404:
+ *         $ref: '#/components/responses/NotFound'
+ */
+
+const { idInput } = require('../../../utils/inputs');
+
+const Errors = {
+  LIST_NOT_FOUND: {
+    listNotFound: 'List not found',
+  },
+};
+
+module.exports = {
+  inputs: {
+    id: {
+      ...idInput,
+      required: true,
+    },
+  },
+
+  exits: {
+    listNotFound: {
+      responseType: 'notFound',
+    },
+  },
+
+  async fn(inputs) {
+    const { currentUser } = this.req;
+
+    const { list, project } = await sails.helpers.lists
+      .getPathToProjectById(inputs.id)
+      .intercept('pathNotFound', () => Errors.LIST_NOT_FOUND);
+
+    if (!sails.helpers.lists.isFinite(list)) {
+      throw Errors.LIST_NOT_FOUND;
+    }
+
+    if (currentUser.role !== User.Roles.ADMIN || project.ownerProjectManagerId) {
+      const isProjectManager = await sails.helpers.users.isProjectManager(
+        currentUser.id,
+        project.id,
+      );
+
+      if (!isProjectManager) {
+        const boardMembership = await BoardMembership.qm.getOneByBoardIdAndUserId(
+          list.boardId,
+          currentUser.id,
+        );
+
+        if (!boardMembership) {
+          throw Errors.LIST_NOT_FOUND; // Forbidden
+        }
+      }
+    }
+
+    const cards = await Card.qm.getByListId(list.id);
+    const cardIds = sails.helpers.utils.mapRecords(cards);
+
+    const userIds = sails.helpers.utils.mapRecords(cards, 'creatorUserId', true, true);
+    const users = await User.qm.getByIds(userIds);
+
+    const cardMemberships = await CardMembership.qm.getByCardIds(cardIds);
+    const cardLabels = await CardLabel.qm.getByCardIds(cardIds);
+
+    const taskLists = await TaskList.qm.getByCardIds(cardIds);
+    const taskListIds = sails.helpers.utils.mapRecords(taskLists);
+
+    const tasks = await Task.qm.getByTaskListIds(taskListIds);
+    const attachments = await Attachment.qm.getByCardIds(cardIds);
+
+    const customFieldGroups = await CustomFieldGroup.qm.getByCardIds(cardIds);
+    const customFieldGroupIds = sails.helpers.utils.mapRecords(customFieldGroups);
+
+    const customFields = await CustomField.qm.getByCustomFieldGroupIds(customFieldGroupIds);
+    const customFieldValues = await CustomFieldValue.qm.getByCardIds(cardIds);
+
+    const cardSubscriptions = await CardSubscription.qm.getByCardIdsAndUserId(
+      cardIds,
+      currentUser.id,
+    );
+
+    const isSubscribedByCardId = cardSubscriptions.reduce(
+      (result, cardSubscription) => ({
+        ...result,
+        [cardSubscription.cardId]: true,
+      }),
+      {},
+    );
+
+    cards.forEach((card) => {
+      // eslint-disable-next-line no-param-reassign
+      card.isSubscribed = isSubscribedByCardId[card.id] || false;
+    });
+
+    return {
+      item: list,
+      included: {
+        cards,
+        cardMemberships,
+        cardLabels,
+        taskLists,
+        tasks,
+        customFieldGroups,
+        customFields,
+        customFieldValues,
+        users: sails.helpers.users.presentMany(users, currentUser),
+        attachments: sails.helpers.attachments.presentMany(attachments),
+      },
+    };
+  },
+};