<?php

declare(strict_types=1);

/**
 * NOTICE OF LICENSE.
 *
 * UNIT3D Community Edition is open-sourced software licensed under the GNU Affero General Public License v3.0
 * The details is bundled with this project in the file LICENSE.txt.
 *
 * @project    UNIT3D Community Edition
 *
 * @author     HDVinnie <hdinnovations@protonmail.com>
 * @license    https://www.gnu.org/licenses/agpl-3.0.en.html/ GNU Affero General Public License v3.0
 */

namespace App\Models;

use App\Traits\Auditable;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use AllowDynamicProperties;

/**
 * App\Models\Bot.
 *
 * @property int                             $id
 * @property int                             $position
 * @property string                          $name
 * @property string                          $command
 * @property string|null                     $color
 * @property string|null                     $icon
 * @property string|null                     $emoji
 * @property string|null                     $help
 * @property bool                            $active
 * @property bool                            $is_protected
 * @property bool                            $is_nerdbot
 * @property bool                            $is_systembot
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 */
#[AllowDynamicProperties]
final class Bot extends Model
{
    use Auditable;

    /** @use HasFactory<\Database\Factories\BotFactory> */
    use HasFactory;

    /**
     * Get the attributes that should be cast.
     *
     * @return array{
     *     name: 'string',
     *     cost: 'decimal:2',
     *     active: 'bool',
     *     is_protected: 'bool',
     *     is_nerdbot: 'bool',
     *     is_systembot: 'bool',
     * }
     */
    protected function casts(): array
    {
        return [
            'name'         => 'string',
            'cost'         => 'decimal:2',
            'active'       => 'bool',
            'is_protected' => 'bool',
            'is_nerdbot'   => 'bool',
            'is_systembot' => 'bool',
        ];
    }

    /**
     * The attributes that aren't mass assignable.
     *
     * @var string[]
     */
    protected $guarded = ['id', 'created_at', 'updated_at'];
}
