v1alpha1

type AdditionalHeader struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type AdditionalHeaders []AdditionalHeader

type AdditionalHeadersRef struct {
	Name string `json:"name"`
}

type ConditionReason string

type ConditionType string

type DNSHealthCheckProbe struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DNSHealthCheckProbeSpec   `json:"spec,omitempty"`
	Status DNSHealthCheckProbeStatus `json:"status,omitempty"`
}

type DNSHealthCheckProbeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []DNSHealthCheckProbe `json:"items"`
}

type DNSHealthCheckProbeSpec struct {
	// Port to connect to the host on. Must be either 80, 443 or 1024-49151
	// +kubebuilder:validation:XValidation:rule="self in [80, 443] || (self >= 1024 && self <= 49151)",message="Only ports 80, 443, 1024-49151 are allowed"
	Port int `json:"port,omitempty"`

	// Hostname is the value sent in the host header, to route the request to the correct service
	// Represents a root host of the parent DNS Record.
	Hostname string `json:"hostname,omitempty"`

	// Address to connect to the host on (IP Address (A Record) or hostname (CNAME)).
	Address string `json:"address,omitempty"`

	// Path is the path to append to the host to reach the expected health check.
	// Must start with "?" or "/", contain only valid URL characters and end with alphanumeric char or "/". For example "/" or "/healthz" are common
	// +kubebuilder:validation:Pattern=`^(?:\?|\/)[\w\-.~:\/?#\[\]@!$&'()*+,;=]+(?:[a-zA-Z0-9]|\/){1}$`
	Path string `json:"path,omitempty"`

	// Protocol to use when connecting to the host, valid values are "HTTP" or "HTTPS"
	// +kubebuilder:validation:XValidation:rule="self in ['HTTP','HTTPS']",message="Only HTTP or HTTPS protocols are allowed"
	Protocol Protocol `json:"protocol,omitempty"`

	// Interval defines how frequently this probe should execute
	Interval *metav1.Duration `json:"interval,omitempty"`

	// AdditionalHeadersRef refers to a secret that contains extra headers to send in the probe request, this is primarily useful if an authentication
	// token is required by the endpoint.
	// +optional
	AdditionalHeadersRef *AdditionalHeadersRef `json:"additionalHeadersRef,omitempty"`

	// FailureThreshold is the number of consecutive failures that must be exceeded for a host to be considered unhealthy.
	// When the number of consecutive failures exceeds this threshold, the health check will be marked as unhealthy.
	// +kubebuilder:validation:XValidation:rule="self > 0",message="Failure threshold must be greater than 0"
	FailureThreshold int `json:"failureThreshold,omitempty"`

	// AllowInsecureCertificate will instruct the health check probe to not fail on a self-signed or otherwise invalid SSL certificate
	// this is primarily used in development or testing environments and is set by the --insecure-health-checks flag
	AllowInsecureCertificate bool `json:"allowInsecureCertificate,omitempty"`
}

type DNSHealthCheckProbeStatus struct {
	LastCheckedAt       metav1.Time `json:"-"`
	ConsecutiveFailures int         `json:"consecutiveFailures,omitempty"`
	Reason              string      `json:"reason,omitempty"`
	Status              int         `json:"status,omitempty"`
	Healthy             *bool       `json:"healthy,omitempty"`
	ObservedGeneration  int64       `json:"observedGeneration,omitempty"`
}

type DNSRecord struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DNSRecordSpec   `json:"spec,omitempty"`
	Status DNSRecordStatus `json:"status,omitempty"`
}

type DNSRecordList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []DNSRecord `json:"items"`
}

type DNSRecordSpec struct {
	// ownerID is a unique string used to identify the owner of this record.
	// If unset or set to an empty string the record UID will be used.
	// +kubebuilder:validation:Optional
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="OwnerID is immutable"
	// +kubebuilder:validation:MinLength=6
	// +kubebuilder:validation:MaxLength=36
	OwnerID string `json:"ownerID,omitempty"`

	// rootHost is the single root for all endpoints in a DNSRecord.
	// it is expected all defined endpoints are children of or equal to this rootHost
	// Must contain at least two groups of valid URL characters separated by a "."
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="RootHost is immutable"
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=255
	// +kubebuilder:validation:Pattern=`^(?:[\w\-.~:\/?#[\]@!$&'()*+,;=]+)\.(?:[\w\-.~:\/?#[\]@!$&'()*+,;=]+)$`
	RootHost string `json:"rootHost"`

	// ProviderRef is a reference to a provider secret.
	// +optional
	ProviderRef *ProviderRef `json:"providerRef,omitempty"`

	// endpoints is a list of endpoints that will be published into the dns provider.
	// +kubebuilder:validation:MinItems=0
	// +optional
	Endpoints []*externaldns.Endpoint `json:"endpoints,omitempty"`

	// +optional
	HealthCheck *HealthCheckSpec `json:"healthCheck,omitempty"`

	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="delegate is immutable"
	Delegate bool `json:"delegate,omitempty"`
}

type DNSRecordStatus struct {

	// conditions are any conditions associated with the record in the dns provider.
	//
	// If publishing the record fails, the "Failed" condition will be set with a
	// reason and message describing the cause of the failure.
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// observedGeneration is the most recently observed generation of the DNSRecord.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// QueuedAt is a time when DNS record was received for the reconciliation
	QueuedAt metav1.Time `json:"queuedAt,omitempty"`

	// ValidFor indicates duration since the last reconciliation we consider data in the record to be valid
	ValidFor string `json:"validFor,omitempty"`

	// WriteCounter represent a number of consecutive write attempts on the same generation of the record.
	// It is being reset to 0 when the generation changes or there are no changes to write.
	WriteCounter int64 `json:"writeCounter,omitempty"`

	// endpoints are the last endpoints that were successfully published to the provider zone
	Endpoints []*externaldns.Endpoint `json:"endpoints,omitempty"`

	HealthCheck *HealthCheckStatus `json:"healthCheck,omitempty"`

	// ownerID is a unique string used to identify the owner of this record.
	OwnerID string `json:"ownerID,omitempty"`

	// ProviderRef is a reference to a provider secret used to publish endpoints.
	ProviderRef ProviderRef `json:"providerRef,omitempty"`

	// DomainOwners is a list of all the owners working against the root domain of this record
	DomainOwners []string `json:"domainOwners,omitempty"`

	// zoneID is the provider specific id to which this dns record is publishing endpoints
	ZoneID string `json:"zoneID,omitempty"`

	// zoneDomainName is the domain name of the zone that the dns record is publishing endpoints
	ZoneDomainName string `json:"zoneDomainName,omitempty"`

	// remoteRecordStatuses is a map of cluster IDs and their unique DNSRecordStatus as raw JSON.
	//
	// A CRD can't reference a type within itself so the `apiextensionsv1.JSON` type is used.
	// Use GetRemoteRecordStatuses to get the converted type.
	RemoteRecordStatuses map[string]apiextensionsv1.JSON `json:"remoteRecordStatuses,omitempty"`

	// Group displays the group which the dns-operator belongs to, if set.
	Group types.Group `json:"group,omitempty"`

	// ActiveGroups displays the last read list of active groups
	ActiveGroups string `json:"activeGroups,omitempty"`
}

type DNSRecordType string

type HealthCheckSpec struct {
	// Port to connect to the host on. Must be either 80, 443 or 1024-49151
	// Defaults to port 443
	// +kubebuilder:validation:XValidation:rule="self in [80, 443] || (self >= 1024 && self <= 49151)",message="Only ports 80, 443, 1024-49151 are allowed"
	// +kubebuilder:default=443
	Port int `json:"port,omitempty"`

	// Path is the path to append to the host to reach the expected health check.
	// Must start with "?" or "/", contain only valid URL characters and end with alphanumeric char or "/". For example "/" or "/healthz" are common
	// +kubebuilder:validation:Pattern=`^(?:\?|\/)[\w\-.~:\/?#\[\]@!$&'()*+,;=]+(?:[a-zA-Z0-9]|\/){1}$`
	Path string `json:"path,omitempty"`

	// Protocol to use when connecting to the host, valid values are "HTTP" or "HTTPS"
	// Defaults to HTTPS
	// +kubebuilder:validation:XValidation:rule="self in ['HTTP','HTTPS']",message="Only HTTP or HTTPS protocols are allowed"
	// +kubebuilder:default=HTTPS
	Protocol Protocol `json:"protocol,omitempty"`

	// Interval defines how frequently this probe should execute
	// Defaults to 5 minutes
	// +kubebuilder:default="5m"
	Interval *metav1.Duration `json:"interval,omitempty"`

	// AdditionalHeadersRef refers to a secret that contains extra headers to send in the probe request, this is primarily useful if an authentication
	// token is required by the endpoint.
	// +optional
	AdditionalHeadersRef *AdditionalHeadersRef `json:"additionalHeadersRef,omitempty"`

	// FailureThreshold is the number of consecutive failures that must be exceeded for a host to be considered unhealthy.
	// When the number of consecutive failures exceeds this threshold, the health check will be marked as unhealthy.
	// Defaults to 5
	// +kubebuilder:validation:XValidation:rule="self > 0",message="Failure threshold must be greater than 0"
	// +kubebuilder:default=5
	FailureThreshold int `json:"failureThreshold,omitempty"`
}

type HealthCheckStatus struct {
	Conditions []metav1.Condition       `json:"conditions,omitempty"`
	Probes     []HealthCheckStatusProbe `json:"probes,omitempty"`
}

type HealthCheckStatusProbe struct {
	ID         string             `json:"id"`
	IPAddress  string             `json:"ipAddress"`
	Host       string             `json:"host"`
	Synced     bool               `json:"synced,omitempty"`
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

type Protocol string

type ProviderAccessor interface {
	GetNamespace() string
	GetProviderRef() ProviderRef
	GetRootHost() string
	IsAuthoritativeRecord() bool
	IsDelegating() bool
}

type ProviderRef struct {
	Name string `json:"name"`
}