i18n

type DefaultLocaleContextHolder struct {
	// contains filtered or unexported fields
}

type DefaultLocaleMessageBundle struct {
	// contains filtered or unexported fields
}

type DefaultMessageSource struct {
	// contains filtered or unexported fields
}

type DefaultMessageSourceValidator struct {
	// contains filtered or unexported fields
}

type Locale = loc.Translator

type LocaleContextHolder interface {
	// Clear() reset the current value for Locale, reverting to its default value.
	Clear()

	// Set() set the current Locale to use after.
	Set(locale Locale)

	// Get() returns the current Locale or the default one if none is defined.
	Get() Locale
}

type LocaleMessageBundle interface {
	LoadLocalizedMessages(messages LocalizedMessages)

	// AddValidationTranslation() let's you register a validation function.
	//
	// To be used with [github.com/go-playground/validator/v10/translations] modules.
	//
	// Example :
	//
	//  import "github.com/go-playground/validator/v10/translations/en
	//
	//  ...
	//
	//  bundle.AddValidationTranslation(en.RegisterDefaultTranslations)
	LoadValidationTranslation(translation ValidationTranslationFunction) error

	// AddTranslation() adds a normal translation for this LocaleMessageBundle language/locale
	// Multiple string parameters may be references (like "{0}", "{1}", ...)
	//
	// Example :
	//
	//  bundle.AddTranslation("welcome": "Welcome back, {0}")
	AddTranslation(key, text string)

	// AddCardinal() adds a cardinal translation for this LocaleMessageBundle language/locale.
	// {0} is the only replacement type accepted and only one variable is accepted as
	// multiple cannot be used for a plural rule determination.
	//
	// Example :
	//
	//  bundle.AddCardinal("days.left", "{0} day left", PluralRules.ONE)
	//  bundle.AddCardinal("days.left", "{0} days left", PluralRules.OTHER)
	AddCardinal(key, text string, rule PluralRule)

	// AddOrdinal() adds an ordinal translation for this LocaleMessageBundle language/locale.
	// {0} is the only replacement type accepted and only one variable is accepted as
	// multiple cannot be used for a plural rule determination.
	//
	// Example :
	//
	// bundle.AddOrdinal("spring_days", "{0}st day of spring", PluralRules.ONE)
	// bundle.AddOrdinal("spring_days", "{0}nd day of spring", PluralRules.TWO)
	// bundle.AddOrdinal("spring_days", "{0}rd day of spring", PluralRules.FEW)
	// bundle.AddOrdinal("spring_days", "{0}th day of spring", PluralRules.OTHER)
	AddOrdinal(key, text string, rule PluralRule)

	// AddRange() adds a range translation for this LocaleMessageBundle language/locale.
	// {0} and {1} are the only replacement types accepted and only these are accepted.
	//
	// Example :
	//
	// bundle.AddRange('days_left', "{0}-{1} day left", PluralRules.ONE)
	// bundle.AddRange('days_left', "{0}-{1} days left", PluralRules.OTHER)
	AddRange(key, text string, rule PluralRule)

	// Translate() creates the translation for the locale given the 'key' and params passed in
	Translate(key string, params ...string) (string, error)

	// Cardinal() creates the cardinal translation for the locale given the 'key', 'num' and 'digit' arguments
	// and param passed in
	Cardinal(key string, num float64) (string, error)

	// CardinalWithPrecision() creates the cardinal translation for the locale given the 'key', 'num' and 'digit' arguments
	// and param passed in.
	CardinalWithPrecision(key string, num float64, precision uint64) (string, error)

	// Ordinal() creates the ordinal translation for the locale given the 'key', 'num' and 'digit' arguments
	// and param passed in.
	Ordinal(key string, num float64) (string, error)

	// OrdinalWithPrecision() creates the ordinal translation for the locale given the 'key', 'num' and 'digit' arguments
	// and param passed in.
	OrdinalWithPrecision(key string, num float64, precision uint64) (string, error)

	// Range() creates the range translation for the locale given the 'key', 'num1', 'digit1', 'num2' and
	// 'digit2' arguments and 'param1' and 'param2' passed in.
	Range(key string, num1, num2 float64) (string, error)

	// RangeWithPrecision() creates the range translation for the locale given the 'key', 'num1', 'digit1', 'num2' and
	// 'digit2' arguments and 'param1' and 'param2' passed in.
	RangeWithPrecision(key string, num1, num2 float64, precision uint64) (string, error)
}

type LocalizedMessages struct {
	// contains filtered or unexported fields
}

type MessageSource interface {
	// DefaultMessageBundle() lets you retrieve the default configured [LocaleMessageBundle]
	DefaultMessageBundle() LocaleMessageBundle

	// NewMessageBundle() add a new [LocalMessageBundle] for the desired [Locale]
	NewMessageBundle(locale Locale) LocaleMessageBundle

	// FindMessageBundle() let's you retrieve the first available [LocaleMessageBundle] from the locale/locales parameters,
	// or returns the "defaultLocale" [LocaleMessageBundle] if none match.
	FindMessageBundle(locale Locale, locales ...Locale) LocaleMessageBundle

	// FindTranslator() let's you retrieve the first available [Translator] from the locale/locales parameters,
	// or returns the "defaultLocale" [Translator] if none match.
	FindTranslator(locale Locale, locales ...Locale) Translator

	// UniversalTranslator() returns the [github.com/go-playground/universal-translator.UniversalTranslator].
	UniversalTranslator() *ut.UniversalTranslator

	// Validator() returns the [github.com/go-playground/validator/v10.Validator].
	Validator() *validator.Validate
}

type MessageSourceValidator interface {
	// Validate() implements the validation function.
	Validate(data any) error

	// TranslateValidationErrors() will help ou translate any validation errors,
	// using the current locale obtain from the LocaleContextHolder.
	TranslateValidationErrors(validationErrors validator.ValidationErrors, namespace ...string) validator.ValidationErrorsTranslations
}

type PluralRule = Enum[PluralRuleEnum]

type PluralRuleEnum struct {
	ZERO,
	ONE,
	TWO,
	FEW,
	MANY,
	OTHER PluralRule
}

type ThreadLocaleContextHolder struct {
	// contains filtered or unexported fields
}

type Translator = ut.Translator

type ValidationTranslationFunction func(*validator.Validate, Translator) (err error)