Files
planka/server/api/models/Label.js
2025-09-12 12:17:01 +02:00

152 lines
4.1 KiB
JavaScript
Executable File

/*!
* Copyright (c) 2024 PLANKA Software GmbH
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* Label.js
*
* @description :: A model definition represents a database table/collection.
* @docs :: https://sailsjs.com/docs/concepts/models-and-orm/models
*/
/**
* @swagger
* components:
* schemas:
* Label:
* type: object
* required:
* - id
* - boardId
* - position
* - name
* - color
* - createdAt
* - updatedAt
* properties:
* id:
* type: string
* description: Unique identifier for the label
* example: "1357158568008091264"
* boardId:
* type: string
* description: ID of the board the label belongs to
* example: "1357158568008091265"
* position:
* type: number
* description: Position of the label within the board
* example: 65536
* name:
* type: string
* nullable: true
* description: Name/title of the label
* example: Bug
* color:
* type: string
* enum: [muddy-grey, autumn-leafs, morning-sky, antique-blue, egg-yellow, desert-sand, dark-granite, fresh-salad, lagoon-blue, midnight-blue, light-orange, pumpkin-orange, light-concrete, sunny-grass, navy-blue, lilac-eyes, apricot-red, orange-peel, silver-glint, bright-moss, deep-ocean, summer-sky, berry-red, light-cocoa, grey-stone, tank-green, coral-green, sugar-plum, pink-tulip, shady-rust, wet-rock, wet-moss, turquoise-sea, lavender-fields, piggy-red, light-mud, gun-metal, modern-green, french-coast, sweet-lilac, red-burgundy, pirate-gold]
* description: Color of the label
* example: berry-red
* createdAt:
* type: string
* format: date-time
* nullable: true
* description: When the label was created
* example: 2024-01-01T00:00:00.000Z
* updatedAt:
* type: string
* format: date-time
* nullable: true
* description: When the label was last updated
* example: 2024-01-01T00:00:00.000Z
*/
const COLORS = [
'muddy-grey',
'autumn-leafs',
'morning-sky',
'antique-blue',
'egg-yellow',
'desert-sand',
'dark-granite',
'fresh-salad',
'lagoon-blue',
'midnight-blue',
'light-orange',
'pumpkin-orange',
'light-concrete',
'sunny-grass',
'navy-blue',
'lilac-eyes',
'apricot-red',
'orange-peel',
'silver-glint',
'bright-moss',
'deep-ocean',
'summer-sky',
'berry-red',
'light-cocoa',
'grey-stone',
'tank-green',
'coral-green',
'sugar-plum',
'pink-tulip',
'shady-rust',
'wet-rock',
'wet-moss',
'turquoise-sea',
'lavender-fields',
'piggy-red',
'light-mud',
'gun-metal',
'modern-green',
'french-coast',
'sweet-lilac',
'red-burgundy',
'pirate-gold',
];
module.exports = {
COLORS,
attributes: {
// ╔═╗╦═╗╦╔╦╗╦╔╦╗╦╦ ╦╔═╗╔═╗
// ╠═╝╠╦╝║║║║║ ║ ║╚╗╔╝║╣ ╚═╗
// ╩ ╩╚═╩╩ ╩╩ ╩ ╩ ╚╝ ╚═╝╚═╝
position: {
type: 'number',
required: true,
},
name: {
type: 'string',
isNotEmptyString: true,
allowNull: true,
},
color: {
type: 'string',
isIn: COLORS,
required: true,
},
// ╔═╗╔╦╗╔╗ ╔═╗╔╦╗╔═╗
// ║╣ ║║║╠╩╗║╣ ║║╚═╗
// ╚═╝╩ ╩╚═╝╚═╝═╩╝╚═╝
// ╔═╗╔═╗╔═╗╔═╗╔═╗╦╔═╗╔╦╗╦╔═╗╔╗╔╔═╗
// ╠═╣╚═╗╚═╗║ ║║ ║╠═╣ ║ ║║ ║║║║╚═╗
// ╩ ╩╚═╝╚═╝╚═╝╚═╝╩╩ ╩ ╩ ╩╚═╝╝╚╝╚═╝
boardId: {
model: 'Board',
required: true,
columnName: 'board_id',
},
cards: {
collection: 'Card',
via: 'labelId',
through: 'CardLabel',
},
},
};