v3

type AnnotatedLayer struct {
	// The name of the group that this layer belongs to, nil if it is not a member of a group. Groups can be a member of the toplayer as a group
	GroupName *string
	// Only for spec.Service.Layer
	IsTopLayer bool
	// Top layer or layer below the toplayer with children itself
	IsGroupLayer bool
	// Contains actual data
	IsDataLayer bool
	Layer
}

type Authority struct {
	Name                     string `json:"name"`
	URL                      string `json:"url"`
	SpatialDatasetIdentifier string `json:"spatialDatasetIdentifier"`
}

type BaseData struct {
	// Gpkg configures a GeoPackage file source
	Gpkg *Gpkg `json:"gpkg,omitempty"`

	// Postgis configures a Postgis table source
	Postgis *Postgis `json:"postgis,omitempty"`
}

type BaseOptions struct {
	// IncludeIngress dictates whether to deploy an Ingress or ensure none exists.
	// +kubebuilder:default:=true
	// +kubebuilder:validation:Optional
	IncludeIngress bool `json:"includeIngress"`

	// AutomaticCasing enables automatic conversion from snake_case to camelCase.
	// +kubebuilder:default:=true
	// +kubebuilder:validation:Optional
	AutomaticCasing bool `json:"automaticCasing"`

	// Whether to prefetch data from blob storage, and store it on the local filesystem.
	// If `false`, the data will be served directly out of blob storage
	// +kubebuilder:default:=true
	// +kubebuilder:validation:Optional
	PrefetchData bool `json:"prefetchData"`
}

type BaseService struct {
	// Geonovum subdomein
	// +kubebuilder:validation:MinLength:=1
	Prefix string `json:"prefix"`

	// URL of the service
	URL smoothoperatormodel.URL `json:"url"`

	// External Mapfile reference
	Mapfile *Mapfile `json:"mapfile,omitempty"`

	// Reference to OwnerInfo CR
	// +kubebuilder:validation:MinLength:=1
	OwnerInfoRef string `json:"ownerInfoRef"`

	// Service title
	// +kubebuilder:validation:MinLength:=1
	Title string `json:"title"`

	// Service abstract
	// +kubebuilder:validation:MinLength:=1
	Abstract string `json:"abstract"`

	// Keywords for capabilities
	// +kubebuilder:validation:MinItems:=1
	// +kubebuilder:validation:items:MinLength:=1
	Keywords []string `json:"keywords"`

	// Optional Fees
	// +kubebuilder:validation:MinLength:=1
	Fees *string `json:"fees,omitempty"`

	// AccessConstraints URL
	// +kubebuilder:default="https://creativecommons.org/publicdomain/zero/1.0/deed.nl"
	AccessConstraints smoothoperatormodel.URL `json:"accessConstraints,omitempty"`
}

type Bbox struct {
	// EXTENT/wfs_extent in mapfile
	//nolint:tagliatelle
	// +kubebuilder:validation:Type=object
	DefaultCRS smoothoperatormodel.BBox `json:"defaultCRS"`
}

type Column struct {
	// Name of the column in the data source.
	// +kubebuilder:validation:MinLength=1
	Name string `json:"name"`

	// Alias for the column in the service output.
	// +kubebuilder:validation:MinLength=1
	Alias *string `json:"alias,omitempty"`
}

type ConfigMapRef struct {
	// Name is the name of the ConfigMap
	// +kubebuilder:validation:MinLength:=1
	Name string `json:"name"`

	// Keys contains styling assets that contain mapfile code (.style|.symbol), required if you use symbols in your styles
	// +kubebuilder:validation:MinItems:=1
	// +kubebuilder:validation:items:Pattern:=^\S*.\.(style|symbol)
	Keys []string `json:"keys,omitempty"`
}

type Custom struct {
	// Href of the custom metadata url
	Href smoothoperatormodel.URL `json:"href"`

	// MIME type of the custom link
	// +kubebuilder:validation:MinLength=1
	Type string `json:"type"`
}

type Data struct {
	BaseData `json:",inline"`

	// TIF configures a GeoTIF raster source
	TIF *TIF `json:"tif,omitempty"`
}

type FeatureBbox struct {
	// DefaultCRS defines the EXTENT/wfs_extent for the featureType for use in the mapfile
	//nolint:tagliatelle
	// +kubebuilder:validation:Type=object
	DefaultCRS *smoothoperatormodel.BBox `json:"defaultCRS,omitempty"`

	// WGS84, if provided, gives the same bounding box reprojected into EPSG:4326 for use in the capabilities.
	// +kubebuilder:validation:Type=object
	WGS84 *smoothoperatormodel.BBox `json:"wgs84,omitempty"`
}

type FeatureType struct {
	// Name of the feature
	// +kubebuilder:validation:Pattern:=`^\S+$`
	Name string `json:"name"`

	// Title of the feature
	// +kubebuilder:validation:MinLength:=1
	Title string `json:"title"`

	// Abstract of the feature
	// +kubebuilder:validation:MinLength:=1
	Abstract string `json:"abstract"`

	// Keywords of the feature
	// +kubebuilder:validation:MinItems:=1
	// +kubebuilder:validation:items:MinLength:=1
	Keywords []string `json:"keywords"`

	// Metadata URL
	// +kubebuilder:validation:Type=object
	DatasetMetadataURL *MetadataURL `json:"datasetMetadataUrl,omitempty"`

	// Optional feature bbox
	// +kubebuilder:validation:Optional
	// +kubebuilder:validation:Type:=object
	Bbox *FeatureBbox `json:"bbox,omitempty"`

	// FeatureType data connection
	// +kubebuilder:validation:Type=object
	// +kubebuilder:validation:XValidation:rule="has(self.gpkg) || has(self.postgis)", message="At least one of the datasource should be provided (postgis, gpkg)"
	Data BaseData `json:"data"`
}

type Gpkg struct {
	// Blobkey identifies the location/bucket of the .gpkg file
	// +kubebuilder:validation:Pattern:=^.+\/.+\/.+\.gpkg$
	BlobKey string `json:"blobKey"`

	// TableName is the table within the geopackage
	// +kubebuilder:validation:MinLength:=1
	TableName string `json:"tableName"`

	// GeometryType of the table, must match an OGC type
	// +kubebuilder:validation:Pattern:=`^(Multi)?(Point|LineString|Polygon)$`
	GeometryType string `json:"geometryType"`

	// Columns to visualize for this table
	// +kubebuilder:validation:MinItems:=1
	Columns []Column `json:"columns"`
}

type HealthCheckWFS struct {
	// +kubebuilder:validation:XValidation:rule="self.lowerAscii().contains('service=wfs')",message="a valid healthcheck contains 'Service=WFS'"
	// +kubebuilder:validation:XValidation:rule="self.lowerAscii().contains('request=')",message="a valid healthcheck contains 'Request='"
	Querystring string `json:"querystring"`
	// +kubebuilder:validation:Pattern=(image/png|text/xml|text/html)
	Mimetype string `json:"mimetype"`
}

type HealthCheckWMS struct {
	// +kubebuilder:validation:XValidation:rule="self.lowerAscii().contains('service=wms')",message="a valid healthcheck contains 'SERVICE=WMS'"
	// +kubebuilder:validation:XValidation:rule="self.lowerAscii().contains('request=')",message="a valid healthcheck contains 'REQUEST='"
	Querystring *string `json:"querystring,omitempty"`
	// +kubebuilder:validation:Pattern=(image/png|text/xml|text/html)
	Mimetype *string `json:"mimetype,omitempty"`

	Boundingbox *smoothoperatormodel.BBox `json:"boundingbox,omitempty"`
}

type HorizontalPodAutoscalerPatch struct {
	MinReplicas *int32                                         `json:"minReplicas,omitempty"`
	MaxReplicas *int32                                         `json:"maxReplicas,omitempty"`
	Metrics     []autoscalingv2.MetricSpec                     `json:"metrics,omitempty"`
	Behavior    *autoscalingv2.HorizontalPodAutoscalerBehavior `json:"behavior,omitempty"`
}

type Inspire struct {
	// ServiceMetadataURL references the CSW or custom metadata record.
	// +kubebuilder:validation:Type=object
	ServiceMetadataURL MetadataURL `json:"serviceMetadataUrl"`

	// Language of the INSPIRE metadata record
	// +kubebuilder:validation:Pattern:=`bul|cze|dan|dut|eng|est|fin|fre|ger|gre|hun|gle|ita|lav|lit|mlt|pol|por|rum|slo|slv|spa|swe`
	Language string `json:"language"`
}

type Layer struct {
	// Name of the layer, required for layers on the 2nd or 3rd level
	// +kubebuilder:validation:MinLength:=1
	Name *string `json:"name,omitempty"`

	// Title of the layer
	// +kubebuilder:validation:MinLength:=1
	Title *string `json:"title,omitempty"`

	// Abstract of the layer
	// +kubebuilder:validation:MinLength:=1
	Abstract *string `json:"abstract,omitempty"`

	// Keywords of the layer, required if the layer is visible
	// +kubebuilder:validation:MinItems:=1
	// +kubebuilder:validation:items:MinLength:=1
	Keywords []string `json:"keywords,omitempty"`

	// BoundingBoxes of the layer. If omitted the boundingboxes of the parent layer of the service is used.
	// +kubebuilder:validation:MinItems:=1
	BoundingBoxes []WMSBoundingBox `json:"boundingBoxes,omitempty"`

	// Whether or not the layer is visible. At least one of the layers must be visible.
	// +kubebuilder:default:=true
	// +kubebuilder:validation:Optional
	Visible bool `json:"visible"`

	// TODO ??
	Authority *Authority `json:"authority,omitempty"`

	// Links to metadata
	DatasetMetadataURL *MetadataURL `json:"datasetMetadataUrl,omitempty"`

	// The minimum scale at which this layer functions
	// +kubebuilder:validation:Pattern:=`^[0-9]+(.[0-9]+)?$`
	MinScaleDenominator *string `json:"minscaledenominator,omitempty"`

	// The maximum scale at which this layer functions
	// +kubebuilder:validation:Pattern:=`^[1-9][0-9]*(.[0-9]+)?$`
	MaxScaleDenominator *string `json:"maxscaledenominator,omitempty"`

	// List of styles used by the layer
	// +kubebuilder:validation:MinItems:=1
	Styles []Style `json:"styles,omitempty"`

	// Mapfile setting, sets "LABEL_NO_CLIP=ON"
	LabelNoClip bool `json:"labelNoClip,omitempty"`

	// Data (gpkg/postgis/tif) used by the layer
	Data *Data `json:"data,omitempty"`

	// Sublayers of the layer
	// +kubebuilder:validation:MinItems:=1
	// +kubebuilder:validation:Type=array
	Layers []Layer `json:"layers,omitempty"`
}

type Legend struct {
	// The width of the legend in px, defaults to 78
	// + kubebuilder:default=78
	Width int32 `json:"width,omitempty"`

	// The height of the legend in px, defaults to 20
	// + kubebuilder:default=20
	Height int32 `json:"height,omitempty"`

	// Format of the legend, defaults to image/png
	// +kubebuilder:default="image/png"
	Format string `json:"format,omitempty"`

	// Location of the legend on the blobstore
	// +kubebuilder:validation:MinLength:=1
	BlobKey string `json:"blobKey"`
}

type Mapfile struct {
	// +kubebuilder:validation:Type=object
	ConfigMapKeyRef corev1.ConfigMapKeySelector `json:"configMapKeyRef"`
}

type Metadata struct {
	// MetadataIdentifier is the record's UUID
	// +kubebuilder:validation:Pattern:=`^[0-9a-zA-Z]{8}\-[0-9a-zA-Z]{4}\-[0-9a-zA-Z]{4}\-[0-9a-zA-Z]{4}\-[0-9a-zA-Z]{12}$`
	MetadataIdentifier string `json:"metadataIdentifier"`
}

type MetadataURL struct {
	// CSW describes a metadata record via a metadataIdentifier (UUID) as defined in the OwnerInfo.
	CSW *Metadata `json:"csw,omitempty"`

	// Custom allows arbitrary href
	Custom *Custom `json:"custom,omitempty"`
}

type Options struct {
	BaseOptions `json:",inline"`
	WMSOptions  `json:",inline"`
}

type Postgis struct {
	// TableName in postGIS
	// +kubebuilder:validation:MinLength=1
	TableName string `json:"tableName"`

	// GeometryType of the table
	// +kubebuilder:validation:Pattern=`^(Multi)?(Point|LineString|Polygon)$`
	GeometryType string `json:"geometryType"`

	// Columns to expose from table
	// +kubebuilder:validation:MinItems=1
	Columns []Column `json:"columns"`
}

type ServiceType string

type Style struct {
	// +kubebuilder:validation:MinLength:=1
	Name string `json:"name"`

	// +kubebuilder:validation:MinLength:=1
	Title *string `json:"title,omitempty"`

	// +kubebuilder:validation:MinLength:=1
	Abstract *string `json:"abstract,omitempty"`

	// +kubebuilder:validation:MinLength:=1
	Visualization *string `json:"visualization,omitempty"`

	Legend *Legend `json:"legend,omitempty"`
}

type StylingAssets struct {
	// BlobKeys contains symbol image (.png/.svg) or font (.ttf) keys on blob storage, format: container/key/file.(png|ttf)
	// +kubebuilder:validation:MinItems:=1
	// +kubebuilder:validation:items:Pattern:=^.+\/.+\/.+\.(png|ttf|svg)$
	BlobKeys []string `json:"blobKeys,omitempty"`

	// +kubebuilder:validation:MinItems:=1
	ConfigMapRefs []ConfigMapRef `json:"configMapRefs,omitempty"`
}

type TIF struct {
	// BlobKey to the TIFF file
	// +kubebuilder:validation:Pattern:=`^.+\/.+\/.+\.(tif?f|vrt)$`
	BlobKey string `json:"blobKey"`

	// This option can be used to control the resampling kernel used sampling raster images, optional
	// +kubebuilder:validation:Pattern=`(NEAREST|AVERAGE|BILINEAR)`
	// +kubebuilder:default=NEAREST
	Resample string `json:"resample,omitempty"`

	// Controls the smoothing of the image on a certain point. Bigger value gives a smoother/better picture but
	// results in slower web responses, optional
	// +kubebuilder:validation:Pattern="^-?[0-9]+([.][0-9]*)?$"
	// +kubebuilder:default="2.5"
	OversampleRatio string `json:"oversampleRatio,omitempty"`

	// Sets the color index to treat as transparent for raster layers, optional, hex or rgb
	// +kubebuilder:validation:Pattern=`(#[0-9A-F]{6}([0-9A-F]{2})?)|([0-9]{1,3}\s[0-9]{1,3}\s[0-9]{1,3})`
	Offsite *string `json:"offsite,omitempty"`

	// "When a band represents nominal or ordinal data the class name (from styling) can be included in the getFeatureInfo"
	// +kubebuilder:default:=false
	GetFeatureInfoIncludesClass bool `json:"getFeatureInfoIncludesClass,omitempty"`
}

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

	Spec   WFSSpec                            `json:"spec"`
	Status smoothoperatormodel.OperatorStatus `json:"status,omitempty"`
}

type WFSInspire struct {
	Inspire `json:",inline"`
	// SpatialDatasetIdentifier is the ID uniquely identifying the dataset.
	// +kubebuilder:validation:Pattern:=`^[0-9a-zA-Z]{8}\-[0-9a-zA-Z]{4}\-[0-9a-zA-Z]{4}\-[0-9a-zA-Z]{4}\-[0-9a-zA-Z]{12}$`
	SpatialDatasetIdentifier string `json:"spatialDatasetIdentifier"`
}

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

type WFSService struct {
	BaseService `json:",inline"`

	// Inspire holds INSPIRE-specific metadata for the service.
	Inspire *WFSInspire `json:"inspire,omitempty"`

	// Default CRS (DataEPSG)
	// +kubebuilder:validation:Pattern:="^EPSG:(28992|25831|25832|3034|3035|3857|4258|4326)$"
	DefaultCrs string `json:"defaultCrs"`

	// Other supported CRS
	// +kubebuilder:validation:MinItems:=1
	// +kubebuilder:validation:items:Pattern:="^EPSG:(28992|25831|25832|3034|3035|3857|4258|4326)$"
	OtherCrs []string `json:"otherCrs,omitempty"`

	// Service bounding box
	Bbox *Bbox `json:"bbox,omitempty"`

	// CountDefault -> wfs_maxfeatures in mapfile
	// +kubebuilder:validation:Minimum:=1
	CountDefault *int `json:"countDefault,omitempty"`

	// FeatureTypes configurations
	// +kubebuilder:validation:MinItems:=1
	// +kubebuilder:validation:Type=array
	FeatureTypes []FeatureType `json:"featureTypes"`
}

type WFSSpec struct {
	// Optional lifecycle settings
	Lifecycle *smoothoperatormodel.Lifecycle `json:"lifecycle,omitempty"`

	// +kubebuilder:validation:Type=object
	// +kubebuilder:validation:Schemaless
	// +kubebuilder:pruning:PreserveUnknownFields
	// Strategic merge patch for the pod in the deployment. E.g. to patch the resources or add extra env vars.
	PodSpecPatch                 corev1.PodSpec                `json:"podSpecPatch"`
	HorizontalPodAutoscalerPatch *HorizontalPodAutoscalerPatch `json:"horizontalPodAutoscalerPatch,omitempty"`
	// TODO omitting the options field or setting an empty value results in incorrect defaulting of the options
	// Options configures optional behaviors of the operator, like ingress, casing, and data prefetching.
	Options *BaseOptions `json:"options,omitempty"`

	// Custom healthcheck options
	HealthCheck *HealthCheckWFS `json:"healthCheck,omitempty"`

	// Optional list of URLs where the service can be reached
	// By default only the spec.service.url is used
	IngressRouteURLs smoothoperatormodel.IngressRouteURLs `json:"ingressRouteUrls,omitempty"`

	// service configuration
	Service WFSService `json:"service"`
}

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

	Spec   WMSSpec                            `json:"spec"`
	Status smoothoperatormodel.OperatorStatus `json:"status,omitempty"`
}

type WMSBoundingBox struct {
	// +kubebuilder:validation:Pattern:="^(EPSG:(28992|25831|25832|3034|3035|3857|4258|4326)|CRS:84)$"
	CRS  string                   `json:"crs"`
	BBox smoothoperatormodel.BBox `json:"bbox"`
}

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

type WMSOptions struct {

	// ValidateRequests enables request validation against the service schema.
	// +kubebuilder:default:=true
	// +kubebuilder:validation:Optional
	ValidateRequests bool `json:"validateRequests"`

	// RewriteGroupToDataLayers merges group layers into individual data layers.
	// +kubebuilder:default:=false
	// +kubebuilder:validation:Optional
	RewriteGroupToDataLayers bool `json:"rewriteGroupToDataLayers"`

	// DisableWebserviceProxy disables the built-in proxy for external web services.
	// +kubebuilder:default:=false
	// +kubebuilder:validation:Optional
	DisableWebserviceProxy bool `json:"disableWebserviceProxy"`

	// ValidateChildStyleNameEqual ensures child style names match the parent style.
	// +kubebuilder:default=false
	// +kubebuilder:validation:Optional
	ValidateChildStyleNameEqual bool `json:"validateChildStyleNameEqual"`
}

type WMSService struct {
	BaseService `json:",inline"`

	// Config for Inspire services
	Inspire *Inspire `json:"inspire,omitempty"`

	// CRS of the data
	// +kubebuilder:validation:Pattern:=`(EPSG|CRS):\d+`
	//nolint:tagliatelle
	DataEPSG string `json:"dataEPSG"`

	// Mapfile setting: Sets the maximum size (in pixels) for both dimensions of the image from a getMap request.
	// +kubebuilder:validation:Minimum:=1
	MaxSize *int32 `json:"maxSize,omitempty"`

	// Mapfile setting: Sets the RESOLUTION field in the mapfile, not used when service.mapfile is configured
	Resolution *int32 `json:"resolution,omitempty"`

	// Mapfile setting: Sets the DEFRESOLUTION field in the mapfile, not used when service.mapfile is configured
	DefResolution *int32 `json:"defResolution,omitempty"`

	// Optional. Required files for the styling of the service
	StylingAssets *StylingAssets `json:"stylingAssets,omitempty"`

	// Custom mapfile
	Mapfile *Mapfile `json:"mapfile,omitempty"`

	// Toplayer
	Layer Layer `json:"layer"`
}

type WMSSpec struct {
	// Optional lifecycle settings
	Lifecycle *smoothoperatormodel.Lifecycle `json:"lifecycle,omitempty"`

	// +kubebuilder:validation:Type=object
	// +kubebuilder:validation:Schemaless
	// +kubebuilder:pruning:PreserveUnknownFields
	// Strategic merge patch for the pod in the deployment. E.g. to patch the resources or add extra env vars.
	PodSpecPatch corev1.PodSpec `json:"podSpecPatch"`

	// Optional specification for the HorizontalAutoscaler
	HorizontalPodAutoscalerPatch *HorizontalPodAutoscalerPatch `json:"horizontalPodAutoscalerPatch,omitempty"`

	// Optional options for the configuration of the service.
	// TODO omitting the options field or setting an empty value results in incorrect defaulting of the options
	Options *Options `json:"options,omitempty"`

	// Custom healthcheck options
	HealthCheck *HealthCheckWMS `json:"healthCheck,omitempty"`

	// Optional list of URLs where the service can be reached
	// By default only the spec.service.url is used
	IngressRouteURLs smoothoperatormodel.IngressRouteURLs `json:"ingressRouteUrls,omitempty"`

	// Service specification
	Service WMSService `json:"service"`
}

type WMSWFS interface {
	*WFS | *WMS
	metav1.Object

	GroupKind() schema.GroupKind
	Inspire() *WFSInspire
	Mapfile() *Mapfile
	PodSpecPatch() corev1.PodSpec
	HorizontalPodAutoscalerPatch() *HorizontalPodAutoscalerPatch
	Type() ServiceType
	TypedName() string
	Options() Options
	HasPostgisData() bool
	OwnerInfoRef() string

	// URL returns the configured service URL
	URL() smoothoperatormodel.URL
	IngressRouteURLs(includeServiceURLWhenEmpty bool) smoothoperatormodel.IngressRouteURLs

	// DatasetMetadataIds returns list of all configured metadata identifiers configured on Layers or Featuretypes
	DatasetMetadataIDs() []string

	GeoPackages() []*Gpkg

	ReadinessQueryString() (string, string, error)
}