foundation

type Application interface {
	Version() string

	GetBasePath() string
	GetBootstrapPath() string
	GetConfigPath() string
	GetLangPath() string
	GetPublicPath() string
	GetResourcePath() string
	GetStoragePath() string

	Environment(...string) (string, bool)
	MaintenanceMode() context.Context
	IsDownForMaintenance() bool
	SetMaintenanceMode(down bool)

	// RunMode returns the current shell mode (web/console/unknown).
	RunMode() RunMode

	// Register a service provider constructor with the application.
	Register(provider ...any) error
	Provide(function interface{}, opts ...dig.ProvideOption) error
	Invoke(function interface{}, opts ...dig.InvokeOption) error

	// Boot the application's service providers.
	Boot(ctx context.Context) error

	// Register a new boot listener.
	Booting(callback func(application Application))

	// Register a new "booted" listener.
	Booted(callback func(application Application))

	// Get the current application locale.
	GetLocale() string

	// Get the registered service provider instances if any exist.
	GetProviders(provider interface{}) []interface{}

	// Determine if the application has been bootstrapped before.
	HasBeenBootstrapped() bool

	// LifecycleState returns the current lifecycle state name.
	LifecycleState() string

	// Set the current application locale.
	SetLocale(locale string)

	// Register a terminating callback with the application.
	Terminating(callback interface{}) Application

	// Terminate the application.
	Terminate(ctx context.Context) error
}

type ApplicationAware interface {
	SetApplication(app Application)
}

type ConfigValidator interface {
	ValidateConfig(ctx context.Context) error
}

type HealthProvider interface {
	HealthCheck(ctx context.Context) error
}

type LifecycleError struct {
	Phase     string
	Provider  string
	Operation string
	Cause     error
}

type RunMode string

type RunnableProvider interface {
	RunWithContext(ctx context.Context) error
}

type ServiceProvider interface {
	Register(ctx context.Context) error
	Boot(ctx context.Context) error
	Conf() map[string]string
	Description() string
}

type ShutdownProvider interface {
	Shutdown(ctx context.Context) error
}