import Planka upstream
This commit is contained in:
xiaojibeier
@@ -0,0 +1,131 @@
|
||||
/*!
|
||||
* Copyright (c) 2024 PLANKA Software GmbH
|
||||
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /base-custom-field-groups/{baseCustomFieldGroupId}/custom-fields:
|
||||
* post:
|
||||
* summary: Create custom field in base custom field group
|
||||
* description: Creates a custom field within a base custom field group. Requires project manager permissions.
|
||||
* tags:
|
||||
* - Custom Fields
|
||||
* operationId: createCustomFieldInBaseGroup
|
||||
* parameters:
|
||||
* - name: baseCustomFieldGroupId
|
||||
* in: path
|
||||
* required: true
|
||||
* description: ID of the base custom field group to create the custom field in
|
||||
* schema:
|
||||
* type: string
|
||||
* example: "1357158568008091264"
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - position
|
||||
* - name
|
||||
* properties:
|
||||
* position:
|
||||
* type: number
|
||||
* minimum: 0
|
||||
* description: Position of the custom field within the group
|
||||
* example: 65536
|
||||
* name:
|
||||
* type: string
|
||||
* maxLength: 128
|
||||
* description: Name/title of the custom field
|
||||
* example: Priority
|
||||
* showOnFrontOfCard:
|
||||
* type: boolean
|
||||
* description: Whether to show the field on the front of cards
|
||||
* example: false
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Custom field created successfully
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - item
|
||||
* properties:
|
||||
* item:
|
||||
* $ref: '#/components/schemas/CustomField'
|
||||
* 400:
|
||||
* $ref: '#/components/responses/ValidationError'
|
||||
* 401:
|
||||
* $ref: '#/components/responses/Unauthorized'
|
||||
* 404:
|
||||
* $ref: '#/components/responses/NotFound'
|
||||
*/
|
||||
|
||||
const { idInput } = require('../../../utils/inputs');
|
||||
|
||||
const Errors = {
|
||||
BASE_CUSTOM_FIELD_GROUP_NOT_FOUND: {
|
||||
baseCustomFieldGroupNotFound: 'Base custom field group not found',
|
||||
},
|
||||
};
|
||||
|
||||
module.exports = {
|
||||
inputs: {
|
||||
baseCustomFieldGroupId: {
|
||||
...idInput,
|
||||
required: true,
|
||||
},
|
||||
position: {
|
||||
type: 'number',
|
||||
min: 0,
|
||||
required: true,
|
||||
},
|
||||
name: {
|
||||
type: 'string',
|
||||
maxLength: 128,
|
||||
required: true,
|
||||
},
|
||||
showOnFrontOfCard: {
|
||||
type: 'boolean',
|
||||
},
|
||||
},
|
||||
|
||||
exits: {
|
||||
baseCustomFieldGroupNotFound: {
|
||||
responseType: 'notFound',
|
||||
},
|
||||
},
|
||||
|
||||
async fn(inputs) {
|
||||
const { currentUser } = this.req;
|
||||
|
||||
const { baseCustomFieldGroup, project } = await sails.helpers.baseCustomFieldGroups
|
||||
.getPathToProjectById(inputs.baseCustomFieldGroupId)
|
||||
.intercept('pathNotFound', () => Errors.BASE_CUSTOM_FIELD_GROUP_NOT_FOUND);
|
||||
|
||||
const isProjectManager = await sails.helpers.users.isProjectManager(currentUser.id, project.id);
|
||||
|
||||
if (!isProjectManager) {
|
||||
throw Errors.BASE_CUSTOM_FIELD_GROUP_NOT_FOUND; // Forbidden
|
||||
}
|
||||
|
||||
const values = _.pick(inputs, ['position', 'name', 'showOnFrontOfCard']);
|
||||
|
||||
const customField = await sails.helpers.customFields.createOneInBaseCustomFieldGroup.with({
|
||||
project,
|
||||
values: {
|
||||
...values,
|
||||
baseCustomFieldGroup,
|
||||
},
|
||||
actorUser: currentUser,
|
||||
request: this.req,
|
||||
});
|
||||
|
||||
return {
|
||||
item: customField,
|
||||
};
|
||||
},
|
||||
};
|
||||
@@ -0,0 +1,149 @@
|
||||
/*!
|
||||
* Copyright (c) 2024 PLANKA Software GmbH
|
||||
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /custom-field-groups/{customFieldGroupId}/custom-fields:
|
||||
* post:
|
||||
* summary: Create custom field in custom field group
|
||||
* description: Creates a custom field within a custom field group. Requires board editor permissions.
|
||||
* tags:
|
||||
* - Custom Fields
|
||||
* operationId: createCustomFieldInGroup
|
||||
* parameters:
|
||||
* - name: customFieldGroupId
|
||||
* in: path
|
||||
* required: true
|
||||
* description: ID of the custom field group to create the custom field in
|
||||
* schema:
|
||||
* type: string
|
||||
* example: "1357158568008091264"
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - position
|
||||
* - name
|
||||
* properties:
|
||||
* position:
|
||||
* type: number
|
||||
* minimum: 0
|
||||
* description: Position of the custom field within the group
|
||||
* example: 65536
|
||||
* name:
|
||||
* type: string
|
||||
* maxLength: 128
|
||||
* description: Name/title of the custom field
|
||||
* example: Priority
|
||||
* showOnFrontOfCard:
|
||||
* type: boolean
|
||||
* description: Whether to show the field on the front of cards
|
||||
* example: false
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Custom field created successfully
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - item
|
||||
* properties:
|
||||
* item:
|
||||
* $ref: '#/components/schemas/CustomField'
|
||||
* 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',
|
||||
},
|
||||
CUSTOM_FIELD_GROUP_NOT_FOUND: {
|
||||
customFieldGroupNotFound: 'Custom field group not found',
|
||||
},
|
||||
};
|
||||
|
||||
module.exports = {
|
||||
inputs: {
|
||||
customFieldGroupId: {
|
||||
...idInput,
|
||||
required: true,
|
||||
},
|
||||
position: {
|
||||
type: 'number',
|
||||
min: 0,
|
||||
required: true,
|
||||
},
|
||||
name: {
|
||||
type: 'string',
|
||||
maxLength: 128,
|
||||
required: true,
|
||||
},
|
||||
showOnFrontOfCard: {
|
||||
type: 'boolean',
|
||||
},
|
||||
},
|
||||
|
||||
exits: {
|
||||
notEnoughRights: {
|
||||
responseType: 'forbidden',
|
||||
},
|
||||
customFieldGroupNotFound: {
|
||||
responseType: 'notFound',
|
||||
},
|
||||
},
|
||||
|
||||
async fn(inputs) {
|
||||
const { currentUser } = this.req;
|
||||
|
||||
const { customFieldGroup, card, list, board, project } = await sails.helpers.customFieldGroups
|
||||
.getPathToProjectById(inputs.customFieldGroupId)
|
||||
.intercept('pathNotFound', () => Errors.CUSTOM_FIELD_GROUP_NOT_FOUND);
|
||||
|
||||
const boardMembership = await BoardMembership.qm.getOneByBoardIdAndUserId(
|
||||
board.id,
|
||||
currentUser.id,
|
||||
);
|
||||
|
||||
if (!boardMembership) {
|
||||
throw Errors.CUSTOM_FIELD_GROUP_NOT_FOUND; // Forbidden
|
||||
}
|
||||
|
||||
if (boardMembership.role !== BoardMembership.Roles.EDITOR) {
|
||||
throw Errors.NOT_ENOUGH_RIGHTS;
|
||||
}
|
||||
|
||||
const values = _.pick(inputs, ['position', 'name', 'showOnFrontOfCard']);
|
||||
|
||||
const customField = await sails.helpers.customFields.createOneInCustomFieldGroup.with({
|
||||
project,
|
||||
board,
|
||||
list,
|
||||
card,
|
||||
values: {
|
||||
...values,
|
||||
customFieldGroup,
|
||||
},
|
||||
actorUser: currentUser,
|
||||
request: this.req,
|
||||
});
|
||||
|
||||
return {
|
||||
item: customField,
|
||||
};
|
||||
},
|
||||
};
|
||||
+134
@@ -0,0 +1,134 @@
|
||||
/*!
|
||||
* Copyright (c) 2024 PLANKA Software GmbH
|
||||
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /custom-fields/{id}:
|
||||
* delete:
|
||||
* summary: Delete custom field
|
||||
* description: Deletes a custom field. Can delete the in base custom field group (requires project manager permissions) or the custom field group (requires board editor permissions).
|
||||
* tags:
|
||||
* - Custom Fields
|
||||
* operationId: deleteCustomField
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* required: true
|
||||
* description: ID of the custom field to delete
|
||||
* schema:
|
||||
* type: string
|
||||
* example: "1357158568008091264"
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Custom field deleted successfully
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - item
|
||||
* properties:
|
||||
* item:
|
||||
* $ref: '#/components/schemas/CustomField'
|
||||
* 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',
|
||||
},
|
||||
CUSTOM_FIELD_NOT_FOUND: {
|
||||
customFieldNotFound: 'Custom field not found',
|
||||
},
|
||||
};
|
||||
|
||||
module.exports = {
|
||||
inputs: {
|
||||
id: {
|
||||
...idInput,
|
||||
required: true,
|
||||
},
|
||||
},
|
||||
|
||||
exits: {
|
||||
notEnoughRights: {
|
||||
responseType: 'forbidden',
|
||||
},
|
||||
customFieldNotFound: {
|
||||
responseType: 'notFound',
|
||||
},
|
||||
},
|
||||
|
||||
async fn(inputs) {
|
||||
const { currentUser } = this.req;
|
||||
|
||||
const pathToProject = await sails.helpers.customFields
|
||||
.getPathToProjectById(inputs.id)
|
||||
.intercept('pathNotFound', () => Errors.CUSTOM_FIELD_NOT_FOUND);
|
||||
|
||||
let { customField } = pathToProject;
|
||||
const { customFieldGroup, card, list, board, baseCustomFieldGroup, project } = pathToProject;
|
||||
|
||||
if (customField.baseCustomFieldGroupId) {
|
||||
const isProjectManager = await sails.helpers.users.isProjectManager(
|
||||
currentUser.id,
|
||||
project.id,
|
||||
);
|
||||
|
||||
if (!isProjectManager) {
|
||||
throw Errors.CUSTOM_FIELD_NOT_FOUND; // Forbidden
|
||||
}
|
||||
|
||||
customField = await sails.helpers.customFields.deleteOneInBaseCustomFieldGroup.with({
|
||||
project,
|
||||
baseCustomFieldGroup,
|
||||
record: customField,
|
||||
actorUser: currentUser,
|
||||
request: this.req,
|
||||
});
|
||||
} else if (customField.customFieldGroupId) {
|
||||
const boardMembership = await BoardMembership.qm.getOneByBoardIdAndUserId(
|
||||
board.id,
|
||||
currentUser.id,
|
||||
);
|
||||
|
||||
if (!boardMembership) {
|
||||
throw Errors.CUSTOM_FIELD_NOT_FOUND; // Forbidden
|
||||
}
|
||||
|
||||
if (boardMembership.role !== BoardMembership.Roles.EDITOR) {
|
||||
throw Errors.NOT_ENOUGH_RIGHTS;
|
||||
}
|
||||
|
||||
customField = await sails.helpers.customFields.deleteOneInCustomFieldGroup.with({
|
||||
project,
|
||||
board,
|
||||
list,
|
||||
card,
|
||||
customFieldGroup,
|
||||
record: customField,
|
||||
actorUser: currentUser,
|
||||
request: this.req,
|
||||
});
|
||||
}
|
||||
|
||||
if (!customField) {
|
||||
throw Errors.CUSTOM_FIELD_NOT_FOUND;
|
||||
}
|
||||
|
||||
return {
|
||||
item: customField,
|
||||
};
|
||||
},
|
||||
};
|
||||
+171
@@ -0,0 +1,171 @@
|
||||
/*!
|
||||
* Copyright (c) 2024 PLANKA Software GmbH
|
||||
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /custom-fields/{id}:
|
||||
* patch:
|
||||
* summary: Update custom field
|
||||
* description: Updates a custom field. Can update in the base custom field group (requires project manager permissions) or the custom field group (requires board editor permissions).
|
||||
* tags:
|
||||
* - Custom Fields
|
||||
* operationId: updateCustomField
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* required: true
|
||||
* description: ID of the custom field to update
|
||||
* schema:
|
||||
* type: string
|
||||
* example: "1357158568008091264"
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* position:
|
||||
* type: number
|
||||
* minimum: 0
|
||||
* description: Position of the custom field within the group
|
||||
* example: 65536
|
||||
* name:
|
||||
* type: string
|
||||
* maxLength: 128
|
||||
* description: Name/title of the custom field
|
||||
* example: Priority
|
||||
* showOnFrontOfCard:
|
||||
* type: boolean
|
||||
* description: Whether to show the field on the front of cards
|
||||
* example: false
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Custom field updated successfully
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - item
|
||||
* properties:
|
||||
* item:
|
||||
* $ref: '#/components/schemas/CustomField'
|
||||
* 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',
|
||||
},
|
||||
CUSTOM_FIELD_NOT_FOUND: {
|
||||
customFieldNotFound: 'Custom field not found',
|
||||
},
|
||||
};
|
||||
|
||||
module.exports = {
|
||||
inputs: {
|
||||
id: {
|
||||
...idInput,
|
||||
required: true,
|
||||
},
|
||||
position: {
|
||||
type: 'number',
|
||||
min: 0,
|
||||
},
|
||||
name: {
|
||||
type: 'string',
|
||||
isNotEmptyString: true,
|
||||
maxLength: 128,
|
||||
},
|
||||
showOnFrontOfCard: {
|
||||
type: 'boolean',
|
||||
},
|
||||
},
|
||||
|
||||
exits: {
|
||||
notEnoughRights: {
|
||||
responseType: 'forbidden',
|
||||
},
|
||||
customFieldNotFound: {
|
||||
responseType: 'notFound',
|
||||
},
|
||||
},
|
||||
|
||||
async fn(inputs) {
|
||||
const { currentUser } = this.req;
|
||||
|
||||
const pathToProject = await sails.helpers.customFields
|
||||
.getPathToProjectById(inputs.id)
|
||||
.intercept('pathNotFound', () => Errors.CUSTOM_FIELD_NOT_FOUND);
|
||||
|
||||
let { customField } = pathToProject;
|
||||
const { customFieldGroup, card, list, board, baseCustomFieldGroup, project } = pathToProject;
|
||||
|
||||
const values = _.pick(inputs, ['position', 'name', 'showOnFrontOfCard']);
|
||||
|
||||
if (customField.baseCustomFieldGroupId) {
|
||||
const isProjectManager = await sails.helpers.users.isProjectManager(
|
||||
currentUser.id,
|
||||
project.id,
|
||||
);
|
||||
|
||||
if (!isProjectManager) {
|
||||
throw Errors.CUSTOM_FIELD_NOT_FOUND; // Forbidden
|
||||
}
|
||||
|
||||
customField = await sails.helpers.customFields.updateOneInBaseCustomFieldGroup.with({
|
||||
values,
|
||||
project,
|
||||
baseCustomFieldGroup,
|
||||
record: customField,
|
||||
actorUser: currentUser,
|
||||
request: this.req,
|
||||
});
|
||||
} else if (customField.customFieldGroupId) {
|
||||
const boardMembership = await BoardMembership.qm.getOneByBoardIdAndUserId(
|
||||
board.id,
|
||||
currentUser.id,
|
||||
);
|
||||
|
||||
if (!boardMembership) {
|
||||
throw Errors.CUSTOM_FIELD_NOT_FOUND; // Forbidden
|
||||
}
|
||||
|
||||
if (boardMembership.role !== BoardMembership.Roles.EDITOR) {
|
||||
throw Errors.NOT_ENOUGH_RIGHTS;
|
||||
}
|
||||
|
||||
customField = await sails.helpers.customFields.updateOneInCustomFieldGroup.with({
|
||||
values,
|
||||
project,
|
||||
board,
|
||||
list,
|
||||
card,
|
||||
customFieldGroup,
|
||||
record: customField,
|
||||
actorUser: currentUser,
|
||||
request: this.req,
|
||||
});
|
||||
}
|
||||
|
||||
if (!customField) {
|
||||
throw Errors.CUSTOM_FIELD_NOT_FOUND;
|
||||
}
|
||||
|
||||
return {
|
||||
item: customField,
|
||||
};
|
||||
},
|
||||
};
|
||||
Reference in New Issue
Block a user