framework

type NoExtras struct {
}

type OutputLookupFunc func(keys ...string) (interface{}, error)

type ResourceUid string

type ScoreResourceState[ResourceExtras any] struct {
	// Guid is a uuid assigned to this "instance" of the resource.
	Guid string `yaml:"guid"`
	// Type is the resource type.
	Type string `yaml:"type"`
	// Class is the resource class or 'default' if not provided.
	Class string `yaml:"class"`
	// Id is the generated id for the resource, either <workload>.<resName> or <id>. This is tracked so that
	// we can deduplicate and work out where a resource came from.
	Id string `yaml:"id"`

	Metadata map[string]interface{} `yaml:"metadata"`
	Params   map[string]interface{} `yaml:"params"`
	// SourceWorkload holds the workload name that had the best definition for this resource. "best" is either the
	// first one or the one with params defined.
	SourceWorkload string `yaml:"source_workload"`

	// ProvisionerUri is the resolved provisioner uri that should be found in the config. This is tracked so that
	// we identify which provisioner was used for a particular instance of the resource.
	ProvisionerUri string `yaml:"provisioner"`
	// State is the internal state local to this resource. It will be persisted to disk when possible.
	State map[string]interface{} `yaml:"state"`

	// Outputs is the current set of outputs for the resource. This is the output of calling the provider. It may contain
	// secrets so be careful when persisting this to disk.
	Outputs map[string]interface{} `yaml:"outputs,omitempty"`
	// OutputLookupFunc is function that allows certain in-process providers to defer any output generation. If this is
	// not provided, it will fall back to using what's in the outputs.
	OutputLookupFunc OutputLookupFunc `yaml:"-"`

	// Extras stores any implementation specific extras needed for this resource.
	Extras ResourceExtras `yaml:",inline"`
}

type ScoreWorkloadState[WorkloadExtras any] struct {
	// Spec is the final score spec after all overrides and images have been set. This is a validated score file.
	Spec score.Workload `yaml:"spec"`
	// File is the source score file if known.
	File *string `yaml:"file,omitempty"`
	// Extras stores any implementation specific extras needed for this workload.
	Extras WorkloadExtras `yaml:",inline"`
}

type State[StateExtras any, WorkloadExtras any, ResourceExtras any] struct {
	Workloads   map[string]ScoreWorkloadState[WorkloadExtras]      `yaml:"workloads"`
	Resources   map[ResourceUid]ScoreResourceState[ResourceExtras] `yaml:"resources"`
	SharedState map[string]interface{}                             `yaml:"shared_state"`
	Extras      StateExtras                                        `yaml:",inline"`
}