# JSDoc: Source: schemas/channel/channelBanSchema.js

# Source: schemas/channel/channelBanSchema.js

    /*Canopy - The next generation of stoner streaming software
    Copyright (C) 2024-2025 Rainbownapkin and the TTN Community

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as
    published by the Free Software Foundation, either version 3 of the
    License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.*/

    //NPM Imports
    const {mongoose} = require('mongoose');

    /**
     * DB Schema for Documents representing a user ban from a single channel
     */
    const channelBanSchema = new mongoose.Schema({
        user: {
            type: mongoose.SchemaTypes.ObjectID,
            required: true,
            ref: "user"
        },
        banDate: {
            type: mongoose.SchemaTypes.Date,
            required: true,
            default: new Date()
        },
        expirationDays: {
            type: mongoose.SchemaTypes.Number,
            required: true,
            default: 14
        },
        banAlts: {
            type: mongoose.SchemaTypes.Boolean,
            required: true,
            default: false
        }
    });

    //methods
    /**
     * Calculates days until ban expiration
     * @returns {Number} Days until the given ban expires
     */
    channelBanSchema.methods.getDaysUntilExpiration = function(){
            //Get ban date
            const expirationDate = new Date(this.banDate);
            //Get expiration days and calculate expiration date
            expirationDate.setDate(expirationDate.getDate() + this.expirationDays);
            //Calculate and return days until ban expiration
            return ((expirationDate - new Date()) / (1000 * 60 * 60 * 24)).toFixed(1);
    }

    module.exports = channelBanSchema;