<?php

declare(strict_types=1);

namespace App\Models\FormBuilder;

use App\Models\Organisation;
use App\Models\Scopes\OrganisationScope;
use Illuminate\Database\Eloquent\Concerns\HasUlids;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\MorphMany;

final class FormFieldLibrary extends Model
{
    use HasFactory;
    use HasUlids;

    protected $table = 'form_field_library';

    public string $organisationScopeColumn = 'organisation_id';

    protected static function booted(): void
    {
        static::addGlobalScope(new OrganisationScope());
    }

    protected $fillable = [
        'organisation_id',
        'name',
        'slug',
        'field_type',
        'label',
        'help_text',
        'default_is_required',
        'default_is_filterable',
        'translations',
        'description',
        'is_active',
    ];

    /** @var array<string, string> */
    protected $casts = [
        'translations' => 'array',
        'default_is_required' => 'bool',
        'default_is_filterable' => 'bool',
        'is_system' => 'bool',
        'is_active' => 'bool',
        'usage_count' => 'int',
    ];

    public function organisation(): BelongsTo
    {
        return $this->belongsTo(Organisation::class);
    }

    public function fields(): HasMany
    {
        return $this->hasMany(FormField::class, 'library_field_id');
    }

    public function bindings(): MorphMany
    {
        return $this->morphMany(FormFieldBinding::class, 'owner');
    }

    public function validationRules(): MorphMany
    {
        return $this->morphMany(FormFieldValidationRule::class, 'owner');
    }

    public function configs(): MorphMany
    {
        return $this->morphMany(FormFieldConfig::class, 'owner');
    }

    public function options(): MorphMany
    {
        return $this->morphMany(FormFieldOption::class, 'owner')
            ->orderBy('sort_order');
    }

    /**
     * Force `$library->options` (no parens) to resolve to the morphMany
     * relation rather than the legacy JSON column attribute that lives
     * on the table until WS-5d commit 5 drops it. Removed at commit 5
     * along with the column.
     *
     * @return \Illuminate\Database\Eloquent\Collection<int, FormFieldOption>
     */
    public function getOptionsAttribute(): \Illuminate\Database\Eloquent\Collection
    {
        if (! $this->relationLoaded('options')) {
            $this->load('options');
        }

        /** @var \Illuminate\Database\Eloquent\Collection<int, FormFieldOption> $relation */
        $relation = $this->getRelation('options');

        return $relation;
    }
}