changes

type BlueprintChanges struct {
	// NewResources contains the resources that will be created
	// when deploying the changes.
	NewResources map[string]provider.Changes `json:"newResources"`
	// ResourceChanges contains the changes that will be made to
	// existing resources when deploying the changes.
	ResourceChanges map[string]provider.Changes `json:"resourceChanges"`
	// RemovedResources contains the name of the resources that will be removed
	// when deploying the changes.
	RemovedResources []string `json:"removedResources"`
	// RemovedLinks contains the name of the links that will be removed
	// when deploying the changes.
	// These will be in the format "resourceAName::resourceBName".
	RemovedLinks []string `json:"removedLinks"`
	// NewChildren contains the child blueprints that will be created
	// when deploying the changes.
	NewChildren map[string]NewBlueprintDefinition `json:"newChildren"`
	// ChildChanges contains the changes that will be made to the child blueprints
	// when deploying the changes.
	ChildChanges map[string]BlueprintChanges `json:"childChanges"`
	// RecreateChildren contains the name of the child blueprints that will be recreated
	// when deploying the changes.
	// The reason for this will primarily be due to a dependency of a child blueprint
	// being removed from the latest version of the host blueprint.
	RecreateChildren []string `json:"recreateChildren"`
	// RemovedChildren contains the name of the child blueprints that will be removed
	// when deploying the changes.
	RemovedChildren []string `json:"removedChildren"`
	// NewExports contains new fields that will be exported from the blueprint.
	NewExports map[string]provider.FieldChange `json:"newExports"`
	// ExportChanges contains changes to exported fields.
	ExportChanges map[string]provider.FieldChange `json:"exportChanges"`
	// UnchangedExports contains the names of fields that will not be changed.
	UnchangedExports []string `json:"unchangedExports"`
	// RemovedExports contains the names of fields that will no longer be exported.
	RemovedExports []string `json:"removedExports"`
	// MetadataChanges contains changes to blueprint-wide metadata.
	MetadataChanges MetadataChanges `json:"metadataChanges"`
	// ResolveOnDeploy contains paths to properties in blueprint elements
	// that contain substitutions that can not be resolved until the blueprint
	// is deployed.
	// This includes properties in resources, data sources, blueprint-wide metadata
	// and exported fields.
	ResolveOnDeploy []string `json:"resolveOnDeploy"`
}

type IntermediaryBlueprintChanges struct {
	NewResources     map[string]*provider.Changes
	ResourceChanges  map[string]*provider.Changes
	RemovedResources []string
	RemovedLinks     []string
	NewChildren      map[string]*NewBlueprintDefinition
	ChildChanges     map[string]*BlueprintChanges
	RemovedChildren  []string
	NewExports       map[string]*provider.FieldChange
	ExportChanges    map[string]*provider.FieldChange
	RemovedExports   []string
	MetadataChanges  *MetadataChanges
	UnchangedExports []string
	ResolveOnDeploy  []string
}

type MappingNodeTypeMatchInfo struct {
	TypeMatches bool
	Schema      *provider.ResourceDefinitionsSchema
}

type MetadataChanges struct {
	// NewFields contains new fields that will be added to the blueprint-wide metadata.
	NewFields []provider.FieldChange `json:"newFields"`
	// ModifiedFields contains changes to existing fields in the blueprint-wide metadata.
	ModifiedFields []provider.FieldChange `json:"modifiedFields"`
	// UnchangedFields contains the names of fields that will not be changed.
	UnchangedFields []string `json:"unchangedFields"`
	// RemovedFields contains the names of fields that will no longer be present.
	RemovedFields []string `json:"removedFields"`
}

type NewBlueprintDefinition struct {
	NewResources    map[string]provider.Changes       `json:"newResources"`
	NewChildren     map[string]NewBlueprintDefinition `json:"newChildren"`
	NewExports      map[string]provider.FieldChange   `json:"newExports"`
	ResolveOnDeploy []string                          `json:"resolveOnDeploy,omitempty"`
}

type RemovalChangesResult struct {
	// Changes contains the removal changes for resources, links, children, and exports
	// that are safe to destroy.
	Changes *BlueprintChanges
	// SkippedItems lists resources and links that were not in a safe state
	// to destroy and were therefore excluded from the removal changes.
	SkippedItems []SkippedRollbackItem
	// HasSkippedItems is true if any items were skipped.
	HasSkippedItems bool
}

type ResourceChangeGenerator interface {
	GenerateChanges(
		ctx context.Context,
		resourceInfo *provider.ResourceInfo,
		resourceImplementation provider.Resource,
		resolveOnDeploy []string,
		params bpcore.BlueprintParams,
	) (*provider.Changes, error)
}

type RollbackFilterResult struct {
	// FilteredChanges contains only the changes that are safe to rollback.
	FilteredChanges *BlueprintChanges
	// SkippedItems lists resources and links that were not in a safe state
	// to rollback and were therefore excluded from the changeset.
	SkippedItems []SkippedRollbackItem
	// HasSkippedItems is true if any items were skipped.
	HasSkippedItems bool
}

type SkippedRollbackItem struct {
	// Name is the resource or link name.
	Name string
	// Type indicates whether this is a "resource" or "link".
	Type string
	// ChildPath is the path to the child blueprint containing this item,
	// empty string for root-level items.
	ChildPath string
	// Status is the current status that prevented rollback.
	Status string
	// Reason explains why the item was skipped.
	Reason string
}