mirror of
https://github.com/plankanban/planka.git
synced 2025-12-19 09:13:20 +03:00
115 lines
2.7 KiB
JavaScript
115 lines
2.7 KiB
JavaScript
/*!
|
|
* Copyright (c) 2024 PLANKA Software GmbH
|
|
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
|
|
*/
|
|
|
|
/**
|
|
* @swagger
|
|
* /lists/{id}/clear:
|
|
* post:
|
|
* summary: Clear list
|
|
* description: Deletes all cards from a list. Only works with trash-type lists. Requires project manager or board editor permissions.
|
|
* tags:
|
|
* - Lists
|
|
* operationId: clearList
|
|
* parameters:
|
|
* - name: id
|
|
* in: path
|
|
* required: true
|
|
* description: ID of the list to clear (must be a trash-type list)
|
|
* schema:
|
|
* type: string
|
|
* example: "1357158568008091264"
|
|
* responses:
|
|
* 200:
|
|
* description: List cleared successfully
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* type: object
|
|
* required:
|
|
* - item
|
|
* properties:
|
|
* item:
|
|
* $ref: '#/components/schemas/List'
|
|
* 400:
|
|
* $ref: '#/components/responses/ValidationError'
|
|
* 401:
|
|
* $ref: '#/components/responses/Unauthorized'
|
|
* 403:
|
|
* $ref: '#/components/responses/Forbidden'
|
|
* 404:
|
|
* $ref: '#/components/responses/NotFound'
|
|
*/
|
|
|
|
const { idInput } = require('../../../utils/inputs');
|
|
|
|
const Errors = {
|
|
NOT_ENOUGH_RIGHTS: {
|
|
notEnoughRights: 'Not enough rights',
|
|
},
|
|
LIST_NOT_FOUND: {
|
|
listNotFound: 'List not found',
|
|
},
|
|
};
|
|
|
|
module.exports = {
|
|
inputs: {
|
|
id: {
|
|
...idInput,
|
|
required: true,
|
|
},
|
|
},
|
|
|
|
exits: {
|
|
notEnoughRights: {
|
|
responseType: 'forbidden',
|
|
},
|
|
listNotFound: {
|
|
responseType: 'notFound',
|
|
},
|
|
},
|
|
|
|
async fn(inputs) {
|
|
const { currentUser } = this.req;
|
|
|
|
const { list, board, project } = await sails.helpers.lists
|
|
.getPathToProjectById(inputs.id)
|
|
.intercept('pathNotFound', () => Errors.LIST_NOT_FOUND);
|
|
|
|
const isProjectManager = await sails.helpers.users.isProjectManager(currentUser.id, project.id);
|
|
|
|
if (!isProjectManager) {
|
|
const boardMembership = await BoardMembership.qm.getOneByBoardIdAndUserId(
|
|
board.id,
|
|
currentUser.id,
|
|
);
|
|
|
|
if (!boardMembership) {
|
|
throw Errors.LIST_NOT_FOUND; // Forbidden
|
|
}
|
|
|
|
if (boardMembership.role !== BoardMembership.Roles.EDITOR) {
|
|
throw Errors.NOT_ENOUGH_RIGHTS;
|
|
}
|
|
}
|
|
|
|
// TODO: allow for other types?
|
|
if (list.type !== List.Types.TRASH) {
|
|
throw Errors.NOT_ENOUGH_RIGHTS;
|
|
}
|
|
|
|
await sails.helpers.lists.clearOne.with({
|
|
project,
|
|
board,
|
|
record: list,
|
|
actorUser: currentUser,
|
|
request: this.req,
|
|
});
|
|
|
|
return {
|
|
item: list,
|
|
};
|
|
},
|
|
};
|