// This file is part of the happyDomain (R) project.
// Copyright (c) 2020-2026 happyDomain
// Authors: Pierre-Olivier Mercier, et al.
//
// This program is offered under a commercial and under the AGPL license.
// For commercial licensing, contact us at <contact@happydomain.org>.
//
// For AGPL licensing:
// 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/>.

package checker

import (
	"time"

	sdk "git.happydns.org/checker-sdk-go/checker"
)

// Version is the checker version reported in CheckerDefinition.Version.
//
// It defaults to "built-in", which is appropriate when the checker package is
// imported directly. Standalone binaries and plugin entrypoints override this
// from their own Version variable at the start of main(), which makes it easy
// for CI to inject a version with a single -ldflags "-X main.Version=..."
// flag instead of targeting the nested package path.
var Version = "built-in"

// Definition returns the CheckerDefinition for the NS security restrictions
// checker.
func Definition() *sdk.CheckerDefinition {
	return &sdk.CheckerDefinition{
		ID:      "ns_restrictions",
		Name:    "NS Security Restrictions",
		Version: Version,
		Availability: sdk.CheckerAvailability{
			ApplyToService:  true,
			LimitToServices: []string{serviceTypeOrigin, serviceTypeNSOnlyOrigin},
		},
		ObservationKeys: []sdk.ObservationKey{ObservationKeyNSRestrictions},
		Options: sdk.CheckerOptionsDocumentation{
			ServiceOpts: []sdk.CheckerOptionDocumentation{
				{
					Id:       "service",
					Label:    "Service",
					AutoFill: sdk.AutoFillService,
				},
				{
					Id:       "domainName",
					Label:    "Domain name",
					AutoFill: sdk.AutoFillDomainName,
				},
			},
		},
		Rules: []sdk.CheckRule{
			Rule(),
		},
		Interval: &sdk.CheckIntervalSpec{
			Min:     1 * time.Hour,
			Max:     24 * time.Hour,
			Default: 6 * time.Hour,
		},
	}
}