config

type ChangedSetting struct {
	Name               string
	OldValue           string
	NewValue           string
	AffectedContainers map[ContainerID]bool
}

type ContainerID string

type IParameter interface {
	// Get the parameter's common fields
	GetCommon() *ParameterCommon

	// Get the common fields from each ParameterOption (returns nil if this isn't a choice parameter)
	GetOptions() []*ParameterOptionCommon

	// Set the parameter to the default value
	SetToDefault(network rptypes.Network) error

	// Get the parameter's value as a string
	GetValueAsString() string

	// Deserializes a string into this parameter's value
	Deserialize(serializedParam string, network rptypes.Network) error
}

type IParameterOption interface {
	// Get the parameter option's common fields
	Common() *ParameterOptionCommon
	GetValueAsString() string
}

type Parameter[Type ParameterType] struct {
	*ParameterCommon
	Default map[rptypes.Network]Type
	Value   Type
	Options []*ParameterOption[Type]
}

type ParameterCommon struct {
	// The parameter's ID, used for serialization and deserialization
	ID string

	// The parameter's human-readable name
	Name string

	// A description of this parameter / setting
	Description string

	// Whether or not this is a selection-type parameter with multiple options to choose from
	IsChoice bool

	// The max length of the parameter, in characters, if it's free-form input
	MaxLength int

	// An optional regex used to validate free-form input for the parameter
	Regex string

	// True if this is an advanced parameter and should be hidden unless advanced configuration mode is enabled
	Advanced bool

	// The list of Docker containers affected by changing this parameter
	// (these containers will require a restart for the change to take effect)
	AffectsContainers []ContainerID

	// A list of Docker container environment variables that should be set to this parameter's value
	EnvironmentVariables []string

	// Whether or not the parameter is allowed to be blank
	CanBeBlank bool

	// True to reset the parameter's value to the default option after Hyperdrive is updated
	OverwriteOnUpgrade bool

	// Descriptions of the parameter that change depending on the selected network
	DescriptionsByNetwork map[rptypes.Network]string
}

type ParameterOption[Type ParameterType] struct {
	*ParameterOptionCommon

	// The underlying value for this option
	Value Type
}

type ParameterOptionCommon struct {
	// The option's human-readable name, to be used in config displays
	Name string

	// A description signifying what this option means
	Description string
}

type ParameterType interface {
	bool | string
}