resources

type APIDocumentResource struct {
	kkComps.CreateAPIDocumentRequest `       yaml:",inline"                      json:",inline"`
	Ref                              string `yaml:"ref"                          json:"ref"`
	// Parent API reference (for root-level definitions)
	API              string `yaml:"api,omitempty"                json:"api,omitempty"`
	ParentDocumentID string `yaml:"parent_document_id,omitempty" json:"parent_document_id,omitempty"`
	// contains filtered or unexported fields
}

type APIImplementationResource struct {
	kkComps.APIImplementation `       yaml:",inline"       json:",inline"`
	Ref                       string `yaml:"ref"           json:"ref"`
	// Parent API reference (for root-level definitions)
	API string `yaml:"api,omitempty" json:"api,omitempty"`
	// contains filtered or unexported fields
}

type APIPublicationResource struct {
	kkComps.APIPublication `       yaml:",inline"       json:",inline"`
	Ref                    string `yaml:"ref"           json:"ref"`
	// Parent API reference (for root-level definitions)
	API      string `yaml:"api,omitempty" json:"api,omitempty"`
	PortalID string `yaml:"portal_id"     json:"portal_id"`
	// contains filtered or unexported fields
}

type APIResource struct {
	kkComps.CreateAPIRequest `             yaml:",inline"           json:",inline"`
	Ref                      string       `yaml:"ref"               json:"ref"`
	Kongctl                  *KongctlMeta `yaml:"kongctl,omitempty" json:"kongctl,omitempty"`

	// Nested child resources
	Versions        []APIVersionResource        `yaml:"versions,omitempty"        json:"versions,omitempty"`
	Publications    []APIPublicationResource    `yaml:"publications,omitempty"    json:"publications,omitempty"`
	Implementations []APIImplementationResource `yaml:"implementations,omitempty" json:"implementations,omitempty"`
	Documents       []APIDocumentResource       `yaml:"documents,omitempty"       json:"documents,omitempty"`
	// contains filtered or unexported fields
}

type APIVersionResource struct {
	kkComps.CreateAPIVersionRequest `       yaml:",inline"       json:",inline"`
	Ref                             string `yaml:"ref"           json:"ref"`
	// Parent API reference (for root-level definitions)
	API string `yaml:"api,omitempty" json:"api,omitempty"`
	// contains filtered or unexported fields
}

type ApplicationAuthStrategyResource struct {
	kkComps.CreateAppAuthStrategyRequest `             yaml:",inline"           json:",inline"`
	Ref                                  string       `yaml:"ref"               json:"ref"`
	Kongctl                              *KongctlMeta `yaml:"kongctl,omitempty" json:"kongctl,omitempty"`
	// contains filtered or unexported fields
}

type ControlPlaneResource struct {
	kkComps.CreateControlPlaneRequest `             yaml:",inline"           json:",inline"`
	Ref                               string       `yaml:"ref"               json:"ref"`
	Kongctl                           *KongctlMeta `yaml:"kongctl,omitempty" json:"kongctl,omitempty"`
	// contains filtered or unexported fields
}

type ExternalBlock struct {
	// Direct ID reference (use when you know the exact Konnect ID)
	ID string `yaml:"id,omitempty" json:"id,omitempty"`

	// Selector for querying by fields (use to find by name)
	Selector *ExternalSelector `yaml:"selector,omitempty" json:"selector,omitempty"`
}

type ExternalSelector struct {
	// Field equality matches (initially just support name)
	MatchFields map[string]string `yaml:"matchFields" json:"matchFields"`
}

type FileDefaults struct {
	Kongctl *KongctlMetaDefaults `yaml:"kongctl,omitempty" json:"kongctl,omitempty"`
}

type KongctlMeta struct {
	// Protected prevents accidental deletion of critical resources
	Protected *bool `yaml:"protected,omitempty" json:"protected,omitempty"`
	// Namespace for resource isolation and multi-team management
	Namespace *string `yaml:"namespace,omitempty" json:"namespace,omitempty"`
}

type KongctlMetaDefaults struct {
	Namespace *string `yaml:"namespace,omitempty" json:"namespace,omitempty"`
	Protected *bool   `yaml:"protected,omitempty" json:"protected,omitempty"`
}

type PortalCustomDomainResource struct {
	// Use CreatePortalCustomDomainRequest which contains only user-configurable fields
	// This aligns with the pattern used by other resources (API, APIVersion, etc.)
	kkComps.CreatePortalCustomDomainRequest `       yaml:",inline"          json:",inline"`
	Ref                                     string `yaml:"ref,omitempty"    json:"ref,omitempty"`
	// Parent portal reference
	Portal string `yaml:"portal,omitempty" json:"portal,omitempty"`
	// contains filtered or unexported fields
}

type PortalCustomizationResource struct {
	kkComps.PortalCustomization `       yaml:",inline"          json:",inline"`
	Ref                         string `yaml:"ref,omitempty"    json:"ref,omitempty"`
	Portal                      string `yaml:"portal,omitempty" json:"portal,omitempty"` // Parent portal reference
	// contains filtered or unexported fields
}

type PortalPageResource struct {
	kkComps.CreatePortalPageRequest `                     yaml:",inline"                   json:",inline"`
	Ref                             string `yaml:"ref"                       json:"ref"`
	// Parent portal reference
	Portal string `yaml:"portal,omitempty"          json:"portal,omitempty"`
	// Reference to parent page
	ParentPageRef string `yaml:"parent_page_ref,omitempty" json:"parent_page_ref,omitempty"`
	// Nested child pages
	Children []PortalPageResource `yaml:"children,omitempty"        json:"children,omitempty"`
	// contains filtered or unexported fields
}

type PortalResource struct {
	kkComps.CreatePortal `             yaml:",inline"           json:",inline"`
	Ref                  string       `yaml:"ref"               json:"ref"`
	Kongctl              *KongctlMeta `yaml:"kongctl,omitempty" json:"kongctl,omitempty"`

	// Child resources that match API endpoints
	Customization *PortalCustomizationResource `yaml:"customization,omitempty" json:"customization,omitempty"`
	CustomDomain  *PortalCustomDomainResource  `yaml:"custom_domain,omitempty" json:"custom_domain,omitempty"`
	Pages         []PortalPageResource         `yaml:"pages,omitempty"         json:"pages,omitempty"`
	Snippets      []PortalSnippetResource      `yaml:"snippets,omitempty"      json:"snippets,omitempty"`

	// External resource marker
	External *ExternalBlock `yaml:"_external,omitempty" json:"_external,omitempty"`
	// contains filtered or unexported fields
}

type PortalSnippetResource struct {
	Ref string `yaml:"ref"                   json:"ref"`
	// Parent portal reference
	Portal      string                           `yaml:"portal,omitempty"      json:"portal,omitempty"`
	Name        string                           `yaml:"name"                  json:"name"`
	Content     string                           `yaml:"content"               json:"content"`
	Title       *string                          `yaml:"title,omitempty"       json:"title,omitempty"`
	Visibility  *kkComps.SnippetVisibilityStatus `yaml:"visibility,omitempty"  json:"visibility,omitempty"`
	Status      *kkComps.PublishedStatus         `yaml:"status,omitempty"      json:"status,omitempty"`
	Description *string                          `yaml:"description,omitempty" json:"description,omitempty"`
	// contains filtered or unexported fields
}

type RefReader interface {
	// HasRef checks if a ref exists globally across all resource types
	HasRef(ref string) bool

	// GetResourceByRef returns the resource for a given ref
	// Returns nil and false if not found
	GetResourceByRef(ref string) (Resource, bool)

	// GetResourceTypeByRef returns the resource type for a given ref
	// This is a convenience method that uses GetResourceByRef
	GetResourceTypeByRef(ref string) (ResourceType, bool)
}

type ReferenceMapping interface {
	GetReferenceFieldMappings() map[string]string
}

type ReferencedResource interface {
	GetRef() string
}

type Resource interface {
	GetType() ResourceType
	GetRef() string
	GetMoniker() string // Generic identifier (name, username, version, etc.)
	GetDependencies() []ResourceRef
	Validate() error
	SetDefaults()

	// Identity resolution methods
	GetKonnectID() string                             // Returns the Konnect ID if resolved, empty otherwise
	GetKonnectMonikerFilter() string                  // Returns filter string for Konnect API lookup
	TryMatchKonnectResource(konnectResource any) bool // Matches against Konnect resource
}

type ResourceRef struct {
	Kind string `json:"kind" yaml:"kind"`
	Ref  string `json:"ref"  yaml:"ref"`
}

type ResourceSet struct {
	Portals []PortalResource `yaml:"portals,omitempty"                     json:"portals,omitempty"`
	// ApplicationAuthStrategies contains auth strategy configurations
	ApplicationAuthStrategies []ApplicationAuthStrategyResource `yaml:"application_auth_strategies,omitempty" json:"application_auth_strategies,omitempty"` //nolint:lll
	// ControlPlanes contains control plane configurations
	ControlPlanes []ControlPlaneResource `yaml:"control_planes,omitempty"              json:"control_planes,omitempty"`
	APIs          []APIResource          `yaml:"apis,omitempty"                        json:"apis,omitempty"`
	// API child resources can be defined at root level (with parent reference) or nested under APIs
	APIVersions        []APIVersionResource        `yaml:"api_versions,omitempty"                json:"api_versions,omitempty"`        //nolint:lll
	APIPublications    []APIPublicationResource    `yaml:"api_publications,omitempty"            json:"api_publications,omitempty"`    //nolint:lll
	APIImplementations []APIImplementationResource `yaml:"api_implementations,omitempty"         json:"api_implementations,omitempty"` //nolint:lll
	APIDocuments       []APIDocumentResource       `yaml:"api_documents,omitempty"               json:"api_documents,omitempty"`       //nolint:lll
	// Portal child resources can be defined at root level (with parent reference) or nested under Portals
	PortalCustomizations []PortalCustomizationResource `yaml:"portal_customizations,omitempty"       json:"portal_customizations,omitempty"` //nolint:lll
	PortalCustomDomains  []PortalCustomDomainResource  `yaml:"portal_custom_domains,omitempty"       json:"portal_custom_domains,omitempty"` //nolint:lll
	PortalPages          []PortalPageResource          `yaml:"portal_pages,omitempty"                json:"portal_pages,omitempty"`          //nolint:lll
	PortalSnippets       []PortalSnippetResource       `yaml:"portal_snippets,omitempty"             json:"portal_snippets,omitempty"`       //nolint:lll

	// DefaultNamespace tracks namespace from _defaults when no resources are present
	// This is used by the planner to determine which namespace to check for deletions
	DefaultNamespace string `yaml:"-" json:"-"`
}

type ResourceType string

type ResourceValidator interface {
	Validate() error
}

type ResourceWithLabels interface {
	Resource
	GetLabels() map[string]string
	SetLabels(map[string]string)
}

type ResourceWithParent interface {
	Resource
	GetParentRef() *ResourceRef
}