/*! * Copyright (c) 2024 PLANKA Software GmbH * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md */ /** * @swagger * /lists/{listId}/cards: * post: * summary: Create card * description: Creates a card within a list. Requires board editor permissions. * tags: * - Cards * operationId: createCard * parameters: * - name: listId * in: path * required: true * description: ID of the list to create the card in * schema: * type: string * example: "1357158568008091264" * requestBody: * required: true * content: * application/json: * schema: * type: object * required: * - type * - name * properties: * type: * type: string * enum: [project, story] * description: Type of the card * example: project * position: * type: number * minimum: 0 * nullable: true * description: Position of the card within the list * example: 65536 * name: * type: string * maxLength: 1024 * description: Name/title of the card * example: Implement user authentication * description: * type: string * maxLength: 1048576 * nullable: true * description: Detailed description of the card * example: Add JWT-based authentication system... * dueDate: * type: string * format: date-time * nullable: true * description: Due date for the card * example: 2024-01-01T00:00:00.000Z * isDueCompleted: * type: boolean * nullable: true * description: Whether the due date is completed * example: false * stopwatch: * type: object * required: * - startedAt * - total * nullable: true * description: Stopwatch data for time tracking * properties: * startedAt: * type: string * format: date-time * description: When the stopwatch was started * example: 2024-01-01T00:00:00.000Z * total: * type: number * description: Total time in seconds * example: 3600 * responses: * 200: * description: Card created successfully * content: * application/json: * schema: * type: object * required: * - item * properties: * item: * $ref: '#/components/schemas/Card' * 400: * $ref: '#/components/responses/ValidationError' * 401: * $ref: '#/components/responses/Unauthorized' * 403: * $ref: '#/components/responses/Forbidden' * 404: * $ref: '#/components/responses/NotFound' * 422: * $ref: '#/components/responses/UnprocessableEntity' */ const { isDueDate, isStopwatch } = require('../../../utils/validators'); const { idInput } = require('../../../utils/inputs'); const Errors = { NOT_ENOUGH_RIGHTS: { notEnoughRights: 'Not enough rights', }, LIST_NOT_FOUND: { listNotFound: 'List not found', }, POSITION_MUST_BE_PRESENT: { positionMustBePresent: 'Position must be present', }, }; module.exports = { inputs: { listId: { ...idInput, required: true, }, type: { type: 'string', isIn: Object.values(Card.Types), required: true, }, position: { type: 'number', min: 0, allowNull: true, }, name: { type: 'string', maxLength: 1024, required: true, }, description: { type: 'string', isNotEmptyString: true, maxLength: 1048576, allowNull: true, }, dueDate: { type: 'string', custom: isDueDate, }, isDueCompleted: { type: 'boolean', allowNull: true, }, stopwatch: { type: 'json', custom: isStopwatch, }, }, exits: { notEnoughRights: { responseType: 'forbidden', }, listNotFound: { responseType: 'notFound', }, positionMustBePresent: { responseType: 'unprocessableEntity', }, }, async fn(inputs) { const { currentUser } = this.req; const { list, board, project } = await sails.helpers.lists .getPathToProjectById(inputs.listId) .intercept('pathNotFound', () => Errors.LIST_NOT_FOUND); 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; } const values = _.pick(inputs, [ 'type', 'position', 'name', 'description', 'dueDate', 'isDueCompleted', 'stopwatch', ]); const card = await sails.helpers.cards.createOne .with({ project, values: { ...values, board, list, creatorUser: currentUser, }, request: this.req, }) .intercept('positionMustBeInValues', () => Errors.POSITION_MUST_BE_PRESENT); return { item: card, }; }, };