mirror of
https://github.com/plankanban/planka.git
synced 2025-12-20 01:14:12 +03:00
154 lines
4.4 KiB
JavaScript
Executable File
154 lines
4.4 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
|
|
*/
|
|
|
|
/**
|
|
* Notification.js
|
|
*
|
|
* @description :: A model definition represents a database table/collection.
|
|
* @docs :: https://sailsjs.com/docs/concepts/models-and-orm/models
|
|
*/
|
|
|
|
/**
|
|
* @swagger
|
|
* components:
|
|
* schemas:
|
|
* Notification:
|
|
* type: object
|
|
* required:
|
|
* - id
|
|
* - userId
|
|
* - boardId
|
|
* - cardId
|
|
* - type
|
|
* - data
|
|
* - isRead
|
|
* properties:
|
|
* id:
|
|
* type: string
|
|
* description: Unique identifier for the notification
|
|
* example: 1357158568008091264
|
|
* userId:
|
|
* type: string
|
|
* description: ID of the user who receives the notification
|
|
* example: 1357158568008091265
|
|
* creatorUserId:
|
|
* type: string
|
|
* nullable: true
|
|
* description: ID of the user who created the notification
|
|
* example: 1357158568008091266
|
|
* boardId:
|
|
* type: string
|
|
* description: ID of the board associated with the notification (denormalized)
|
|
* example: 1357158568008091267
|
|
* cardId:
|
|
* type: string
|
|
* description: ID of the card associated with the notification
|
|
* example: 1357158568008091268
|
|
* commentId:
|
|
* type: string
|
|
* nullable: true
|
|
* description: ID of the comment associated with the notification
|
|
* example: 1357158568008091269
|
|
* actionId:
|
|
* type: string
|
|
* nullable: true
|
|
* description: ID of the action associated with the notification
|
|
* example: 1357158568008091270
|
|
* type:
|
|
* type: string
|
|
* enum: [moveCard, commentCard, addMemberToCard, mentionInComment]
|
|
* description: Type of the notification
|
|
* example: commentCard
|
|
* data:
|
|
* type: object
|
|
* description: Notification payload specific to the type
|
|
* example: {"card": {"name": "Implement user authentication"}, "text": "This task is almost complete..."}
|
|
* isRead:
|
|
* type: boolean
|
|
* description: Whether the notification has been read
|
|
* example: false
|
|
* createdAt:
|
|
* type: string
|
|
* format: date-time
|
|
* nullable: true
|
|
* description: When the notification was created
|
|
* example: 2024-01-01T00:00:00.000Z
|
|
* updatedAt:
|
|
* type: string
|
|
* format: date-time
|
|
* nullable: true
|
|
* description: When the notification was last updated
|
|
* example: 2024-01-01T00:00:00.000Z
|
|
*/
|
|
|
|
const Types = {
|
|
MOVE_CARD: 'moveCard',
|
|
COMMENT_CARD: 'commentCard',
|
|
ADD_MEMBER_TO_CARD: 'addMemberToCard',
|
|
MENTION_IN_COMMENT: 'mentionInComment',
|
|
};
|
|
|
|
module.exports = {
|
|
Types,
|
|
|
|
attributes: {
|
|
// ╔═╗╦═╗╦╔╦╗╦╔╦╗╦╦ ╦╔═╗╔═╗
|
|
// ╠═╝╠╦╝║║║║║ ║ ║╚╗╔╝║╣ ╚═╗
|
|
// ╩ ╩╚═╩╩ ╩╩ ╩ ╩ ╚╝ ╚═╝╚═╝
|
|
|
|
type: {
|
|
type: 'string',
|
|
isIn: Object.values(Types),
|
|
required: true,
|
|
},
|
|
data: {
|
|
type: 'json',
|
|
required: true,
|
|
},
|
|
isRead: {
|
|
type: 'boolean',
|
|
defaultsTo: false,
|
|
columnName: 'is_read',
|
|
},
|
|
|
|
// ╔═╗╔╦╗╔╗ ╔═╗╔╦╗╔═╗
|
|
// ║╣ ║║║╠╩╗║╣ ║║╚═╗
|
|
// ╚═╝╩ ╩╚═╝╚═╝═╩╝╚═╝
|
|
|
|
// ╔═╗╔═╗╔═╗╔═╗╔═╗╦╔═╗╔╦╗╦╔═╗╔╗╔╔═╗
|
|
// ╠═╣╚═╗╚═╗║ ║║ ║╠═╣ ║ ║║ ║║║║╚═╗
|
|
// ╩ ╩╚═╝╚═╝╚═╝╚═╝╩╩ ╩ ╩ ╩╚═╝╝╚╝╚═╝
|
|
|
|
userId: {
|
|
model: 'User',
|
|
required: true,
|
|
columnName: 'user_id',
|
|
},
|
|
creatorUserId: {
|
|
model: 'User',
|
|
columnName: 'creator_user_id',
|
|
},
|
|
// Denormalization
|
|
boardId: {
|
|
model: 'Board',
|
|
required: true,
|
|
columnName: 'board_id',
|
|
},
|
|
cardId: {
|
|
model: 'Card',
|
|
required: true,
|
|
columnName: 'card_id',
|
|
},
|
|
commentId: {
|
|
model: 'Comment',
|
|
columnName: 'comment_id',
|
|
},
|
|
actionId: {
|
|
model: 'Action',
|
|
columnName: 'action_id',
|
|
},
|
|
},
|
|
};
|