v1alpha1

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

	Spec   ComponentDescriptorSpec   `json:"spec,omitempty"`
	Status ComponentDescriptorStatus `json:"status,omitempty"`
}

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

type ComponentDescriptorSpec struct {
	v3alpha1.ComponentVersionSpec `json:",inline"`
	Version                       string `json:"version"`
}

type ComponentDescriptorStatus struct {
}

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

	Spec   ComponentVersionSpec   `json:"spec,omitempty"`
	Status ComponentVersionStatus `json:"status,omitempty"`
}

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

type ComponentVersionSpec struct {
	// +required
	Interval metav1.Duration `json:"interval"`

	// Every Component Version has a name.
	// Name and version are the identifier for a Component Version and therefor for the artifact set described by it.
	// A component name SHOULD reference a location where the component’s resources (typically source code, and/or documentation) are hosted.
	// It MUST be a DNS compliant name with lowercase characters and MUST contain a name after the domain.
	// Examples:
	// - github.com/pathToYourRepo
	// +required
	Component string `json:"component"`

	// Component versions refer to specific snapshots of a component. A common scenario being the release of a component.
	// +required
	Version Version `json:"version"`

	// +required
	Repository Repository `json:"repository"`

	// +required
	Verify []Signature `json:"verify"`

	// +optional
	References ReferencesConfig `json:"references,omitempty"`
}

type ComponentVersionStatus struct {
	ComponentDescriptor Reference `json:"componentDescriptor,omitempty"`

	ReconciledVersion string `json:"reconciledVersion,omitempty"`
	Verified          bool   `json:"verified,omitempty"`
}

type ConfigReference struct {
	// +required
	Resource Source `json:"resource"`
}

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

	Spec   MutationSpec   `json:"spec,omitempty"`
	Status MutationStatus `json:"status,omitempty"`
}

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

type Identity map[string]string

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

	Spec   MutationSpec   `json:"spec,omitempty"`
	Status MutationStatus `json:"status,omitempty"`
}

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

type MutationSpec struct {
	// +required
	Interval metav1.Duration `json:"interval"`

	// +required
	ComponentVersionRef meta.NamespacedObjectReference `json:"componentVersionRef"`

	// +required
	Source Source `json:"source"`

	// +required
	ConfigRef ConfigReference `json:"configRef"`

	// +required
	SnapshotTemplate SnapshotTemplateSpec `json:"snapshotTemplate"`

	// +optional
	Values map[string]string `json:"values,omitempty"`
}

type MutationStatus struct {
	// ObservedGeneration is the last reconciled generation.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// +optional
	LatestSnapshotDigest string `json:"latestSnapshotDigest,omitempty"`

	LatestConfigVersion string `json:"latestConfigVersion,omitempty"`
}

type Reference struct {
	// +required
	Name string `json:"name"`

	// +required
	Version string `json:"version"`

	// +kubebuilder:pruning:PreserveUnknownFields
	// +kubebuilder:validation:Schemaless
	References []Reference `json:"references,omitempty"`

	// +optional
	ExtraIdentity map[string]string `json:"extraIdentity,omitempty"`

	// +optional
	ComponentDescriptorRef meta.NamespacedObjectReference `json:"componentDescriptorRef,omitempty"`
}

type ReferencesConfig struct {
	// +optional
	Expand bool `json:"expand,omitempty"`
}

type Repository struct {
	//TODO@souleb: do we need a scheme for the url?
	// add description for each field
	// Do we need a type field? (e.g. oci, git, s3, etc.)
	URL       string    `json:"url"`
	SecretRef SecretRef `json:"secretRef"`
}

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

	Spec   ResourceSpec   `json:"spec,omitempty"`
	Status ResourceStatus `json:"status,omitempty"`
}

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

type ResourceRef struct {
	// +required
	Name string `json:"name"`
	// +optional
	Version string `json:"version,omitempty"`

	// +optional
	ExtraIdentity map[string]string `json:"extraIdentity,omitempty"`

	// ReferencePath is a list of references with identities that include this resource.
	//      referencePath:
	//        - name: installer
	// +optional
	ReferencePath []map[string]string `json:"referencePath,omitempty"`
}

type ResourceSpec struct {
	// +required
	Interval metav1.Duration `json:"interval"`

	// +required
	ComponentVersionRef meta.NamespacedObjectReference `json:"componentVersionRef"`

	// Resource names a Source that this Resource watches.
	// +required
	Resource ResourceRef `json:"resource"`

	// +required
	SnapshotTemplate SnapshotTemplateSpec `json:"snapshotTemplate"`
}

type ResourceStatus struct {
	// ObservedGeneration is the last reconciled generation.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// +optional
	LastAppliedResourceVersion string `json:"lastAppliedResourceVersion,omitempty"`
}

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

type SecretRefValue struct {
	SecretRef SecretRef `json:"secretRef"`
}

type Signature struct {
	// Name of the signature.
	Name string `json:"name"`
	// Key which is used for verification.
	PublicKey SecretRefValue `json:"publicKey"`
}

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

	Spec   SnapshotSpec   `json:"spec,omitempty"`
	Status SnapshotStatus `json:"status,omitempty"`
}

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

type SnapshotSpec struct {
	Identity Identity `json:"identity"`

	// +optional
	CreateFluxSource bool `json:"createFluxSource,omitempty"`

	Digest string `json:"digest"`

	Tag string `json:"tag"`
}

type SnapshotStatus struct {
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// Digest is calculated by the caching layer.
	// +optional
	LastReconciledDigest string `json:"digest,omitempty"`

	// Tag defines the explicit tag that was used to create the related snapshot and cache entry.
	// +optional
	LastReconciledTag string `json:"tag,omitempty"`

	// RepositoryURL has the concrete URL pointing to the local registry including the service name.
	// +optional
	RepositoryURL string `json:"repositoryURL,omitempty"`
}

type SnapshotTemplateSpec struct {
	// +required
	Name string `json:"name"`

	//TODO@souleb: add a description, is that actually used?
	// +optional
	Labels map[string]string `json:"labels,omitempty"`

	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`

	// +optional
	CreateFluxSource bool `json:"createFluxSource,omitempty"`
}

type Source struct {
	// +optional
	SourceRef *meta.NamespacedObjectKindReference `json:"sourceRef,omitempty"`
	// +optional
	ResourceRef *ResourceRef `json:"resourceRef,omitempty"`
}

type Version struct {
	Semver string `json:"semver,omitempty"`
}