/***********************************************************************************************************************************************************************
 * File Name: achievement_definitions.mdl.js
 * Type of Program: Model
 * Description: Admin-managed catalog of achievements (badges and milestones).
 *              Replaces the old static ACHIEVEMENT_REGISTRY in data/achievements.data.js.
 *              `is_system` rows are the built-in keys referenced by name in
 *              services/achievements.service.js's trigger functions — protected
 *              from deletion/key-rename by the admin controller.
 *
 * Author: Kenneth Obsequio (@lash0000)
 * Date Created: Jul. 3, 2026
 ***********************************************************************************************************************************************************************/
const { DataTypes } = require('sequelize');
const sequelize     = require('../../config/db.config');

const mdl_AchievementDefinitions = sequelize.define('AchievementDefinition', {
  achievement_definition_id: { type: DataTypes.BIGINT,      primaryKey: true, autoIncrement: true, label: 'ID',          hidden: true,  order: 0 },
  key:                       { type: DataTypes.STRING(100), allowNull: false, unique: true,         label: 'Key',        hidden: false, order: 1, filterable: true },
  type:                      { type: DataTypes.ENUM('badge', 'milestone'), allowNull: false, defaultValue: 'badge', label: 'Type', hidden: false, order: 2, filterable: true },
  label:                     { type: DataTypes.STRING(255), allowNull: false,                      label: 'Label',       hidden: false, order: 3, filterable: true },
  description:               { type: DataTypes.TEXT,        allowNull: true,                       label: 'Description', hidden: false, order: 4, filterable: false },
  icon:                      { type: DataTypes.STRING(50),  allowNull: true,                       label: 'Icon',        hidden: false, order: 5, filterable: false },
  trigger:                   { type: DataTypes.STRING(30),  allowNull: true,                       label: 'Trigger',     hidden: false, order: 6, filterable: true },
  is_active:                 { type: DataTypes.BOOLEAN,     allowNull: false, defaultValue: true,  label: 'Active',      hidden: false, order: 7, filterable: true },
  is_system:                 { type: DataTypes.BOOLEAN,     allowNull: false, defaultValue: false, label: 'System',      hidden: false, order: 8, filterable: true },
}, {
  tableName:  'achievement_definitions',
  timestamps: true,
  paranoid:   false,
});

module.exports = mdl_AchievementDefinitions;