flag

type Context struct {
	// EvaluationContextEnrichment will be merged with the evaluation context sent during the evaluation.
	// It is useful to add common attributes to all the evaluation, such as a server version, environment, ...
	//
	// All those fields will be included in the custom attributes of the evaluation context,
	// if in the evaluation context you have a field with the same name, it will override the common one.
	// Default: nil
	EvaluationContextEnrichment map[string]any `json:"evaluationContextEnrichment,omitempty"`

	// DefaultSdkValue is the default value of the SDK when calling the variation.
	DefaultSdkValue any `json:"defaultSdkValue,omitempty"`
}

type ErrorCode = string

type ExperimentationRollout struct {
	// Start is the starting time of the experimentation
	Start *time.Time `json:"start,omitempty" yaml:"start,omitempty" toml:"start,omitempty"`

	// End is the ending time of the experimentation
	End *time.Time `json:"end,omitempty" yaml:"end,omitempty" toml:"end,omitempty"`
}

type Flag interface {
	// Value is returning the Value associate to the flag
	Value(
		flagName string,
		evaluationContext ffcontext.Context,
		flagContext Context,
	) (any, ResolutionDetails)

	// GetVersion is the getter for the field Version
	// Default: 0.0
	GetVersion() string

	// IsTrackEvents is the getter of the field TrackEvents
	// Default: true
	IsTrackEvents() bool

	// IsDisable is the getter for the field Disable
	// Default: false
	IsDisable() bool

	// GetVariationValue return the value of variation from his name
	GetVariationValue(name string) any

	// GetMetadata return the metadata associated to the flag
	GetMetadata() map[string]any
}

type InternalFlag struct {
	// Variations are all the variations available for this flag. You can have as many variation as needed.
	Variations *map[string]*any `json:"variations,omitempty" yaml:"variations,omitempty" toml:"variations,omitempty"` // nolint:lll

	// Rules is the list of Rule for this flag.
	// This an optional field.
	Rules *[]Rule `json:"targeting,omitempty" yaml:"targeting,omitempty" toml:"targeting,omitempty"`

	// BucketingKey defines a source for a dynamic targeting key
	BucketingKey *string `json:"bucketingKey,omitempty" yaml:"bucketingKey,omitempty" toml:"bucketingKey,omitempty"`

	// DefaultRule is the originalRule applied after checking that any other rules
	// matched the user.
	DefaultRule *Rule `json:"defaultRule,omitempty" yaml:"defaultRule,omitempty" toml:"defaultRule,omitempty"`

	// Experimentation is your struct to configure an experimentation, it will allow you to configure a start date and
	// an end date for your flag.
	// When the experimentation is not running, the flag will serve the default value.
	Experimentation *ExperimentationRollout `json:"experimentation,omitempty" yaml:"experimentation,omitempty" toml:"experimentation,omitempty"` // nolint: lll

	// Scheduled is your struct to configure an update on some fields of your flag over time.
	// You can add several steps that updates the flag, this is typically used if you want to gradually add more user
	// in your flag.
	Scheduled *[]ScheduledStep `json:"scheduledRollout,omitempty" yaml:"scheduledRollout,omitempty" toml:"scheduledRollout,omitempty"` // nolint: lll

	// TrackEvents is false if you don't want to export the data in your data exporter.
	// Default value is true
	TrackEvents *bool `json:"trackEvents,omitempty" yaml:"trackEvents,omitempty" toml:"trackEvents,omitempty"`

	// Disable is true if the flag is disabled.
	Disable *bool `json:"disable,omitempty" yaml:"disable,omitempty" toml:"disable,omitempty"`

	// Version (optional) This field contains the version of the flag.
	// The version is manually managed when you configure your flags, and it is used to display the information
	// in the notifications and data collection.
	Version *string `json:"version,omitempty" yaml:"version,omitempty" toml:"version,omitempty"`

	// Metadata is a field containing information about your flag such as an issue tracker link, a description, etc ...
	Metadata *map[string]any `json:"metadata,omitempty" yaml:"metadata,omitempty" toml:"metadata,omitempty"`
}

type ProgressiveRollout struct {
	// Initial contains a description of the initial state of the rollout.
	Initial *ProgressiveRolloutStep `` // nolint: lll
	/* 164-byte string literal not displayed */

	// End contains what describes the end status of the rollout.
	End *ProgressiveRolloutStep `` // nolint: lll
	/* 148-byte string literal not displayed */
}

type ProgressiveRolloutStep struct {
	// Variation - name of the variation for this step
	Variation *string `` // nolint: lll
	/* 162-byte string literal not displayed */

	// Percentage is the percentage (initial or end) for the progressive rollout
	Percentage *float64 `` // nolint: lll
	/* 195-byte string literal not displayed */

	// Date is the time it starts or ends.
	Date *time.Time `` // nolint: lll
	/* 146-byte string literal not displayed */
}

type QueryFormat = string

type ResolutionDetails struct {
	// Variant indicates the name of the variant used when evaluating the flag
	Variant string

	// Reason indicates the reason of the decision
	Reason ResolutionReason

	// ErrorCode indicates the error code for this evaluation
	ErrorCode ErrorCode

	// ErrorMessage gives more information about the error
	ErrorMessage string

	// RuleIndex indicates which rules applied
	RuleIndex *int

	// RuleName (optional) is the name of the associated rule if we have one
	RuleName *string

	// Cacheable is set to true if an SDK/provider can cache the value locally.
	Cacheable bool

	// Metadata is a field containing information about your flag such as an issue tracker link, a description, etc ...
	Metadata map[string]any
}

type ResolutionReason = string

type Rollout struct {
	// Experimentation is your struct to configure an experimentation, it will allow you to configure a start date and
	// an end date for your flag.
	// When the experimentation is not running, the flag will serve the default value.
	Experimentation *ExperimentationRollout `json:"experimentation,omitempty" yaml:"experimentation,omitempty" toml:"experimentation,omitempty"` // nolint: lll

	// Scheduled is your struct to configure an update on some fields of your flag over time.
	// You can add several steps that update the flag, this is typically used if you want to gradually add more user
	// in your flag.
	Scheduled *[]ScheduledStep `json:"scheduled,omitempty" yaml:"scheduled,omitempty" toml:"scheduled,omitempty"`
}

type Rule struct {
	// Name is the name of the rule, this field is mandatory if you want
	// to update the rule during scheduled rollout
	Name *string `` // nolint: lll
	/* 212-byte string literal not displayed */

	// Query represents the query used to target the audience of the flag.
	Query *string `` // nolint: lll
	/* 217-byte string literal not displayed */

	// VariationResult represents the variation name to use if the rule apply for the user.
	// In case we have a percentage field in the config VariationResult is ignored
	VariationResult *string `` // nolint: lll
	/* 250-byte string literal not displayed */

	// Percentages represents the percentage we should give to each variation.
	// example: variationA = 10%, variationB = 80%, variationC = 10%
	Percentages *map[string]float64 `` // nolint: lll
	/* 185-byte string literal not displayed */

	// ProgressiveRollout is your struct to configure a progressive rollout deployment of your flag.
	// It will allow you to ramp up the percentage of your flag over time.
	// You can decide at which percentage you starts with and at what percentage you ends with in your release ramp.
	// Before the start date we will serve the initial percentage and, after we will serve the end percentage.
	ProgressiveRollout *ProgressiveRollout `` // nolint: lll
	/* 214-byte string literal not displayed */

	// Disable indicates that this rule is disabled.
	Disable *bool `` // nolint: lll
	/* 151-byte string literal not displayed */
}

type ScheduledStep struct {
	InternalFlag `yaml:",inline"`
	Date         *time.Time `yaml:"date,omitempty" json:"date,omitempty" toml:"date,omitempty"`
}