modules

type Auditable ¶

type Auditable interface {
	SetCreatedUtcNow()
	SetUpdatedUtcNow()
}

type Copiable ¶

type Copiable interface {
	CopyTo(destPtr any)
	CopyFrom(sourcePtr any) any
}

type DefaultConfig ¶

type DefaultConfig []byte

type DomainModel ¶

type DomainModel interface {
	PrimaryKey() ValueObject
	Clone() any
	Validate(forEdit bool) error
}

type DynamicModule ¶

type DynamicModule interface {
	Deps() []string
	// LabelKey is the translation key.
	LabelKey() string
	Name() string
	Init() error
	IsInternal() bool
	RegisterModels() error
	Version() semver.SemVer
	// ModelPrefixes returns the prefixes this module's schemas are named with, without a
	// trailing separator - GenSql appends the "_" itself. Most modules own one prefix, their
	// name; a module made of parts (commerce) owns one per part.
	ModelPrefixes() []string
	// HasUi reports whether the module has a frontend micro-app, so Module Home lists it.
	HasUi() bool
	// Category is the product line the module ships with; Module Home groups modules by it.
	Category() ModuleCategory
}

type InCodeModule ¶

type InCodeModule interface {
	Deps() []string
	// Deprecated: Use Name() instead.
	LabelKey() string
	Name() string
	Init() error
	IsInternal() bool
	Version() semver.SemVer
	// ModelPrefixes returns the prefixes this module's schemas are named with, without a
	// trailing separator - GenSql appends the "_" itself. Most modules own one prefix, their
	// name; a module made of parts (commerce) owns one per part.
	ModelPrefixes() []string
	// HasUi reports whether the module has a frontend micro-app, so Module Home lists it.
	HasUi() bool
	// Category is the product line the module ships with; Module Home groups modules by it.
	Category() ModuleCategory
}

type InCodeModuleAppStarted ¶

type InCodeModuleAppStarted interface {
	OnAppStarted() error
}

type InCodeModuleAppStopping ¶

type InCodeModuleAppStopping interface {
	OnAppStopping(ctx context.Context) error
}

InCodeModuleAppStopping is an optional hook, the counterpart to InCodeModuleAppStarted, invoked after the OS termination signal and before the HTTP server shuts down. A module that owns background goroutines implements it to stop accepting new work and drain what is already in flight.

It is best-effort. Every module shares one deadline carried by ctx, and a module that blocks past it is abandoned rather than allowed to hold up the shutdown of the rest. A module whose work must survive an abrupt stop has to be recoverable from persisted state; this hook shortens the window in which that recovery is needed, it does not remove it.

type InCodeModuleDependants ¶

type InCodeModuleDependants interface {
	Dependants() []string
}

InCodeModuleDependants is the optional counterpart to Deps(): the modules that reference THIS module's resources, declared by this module rather than by them.

The two lists answer opposite questions and neither can be derived from the other. Deps() says what this module needs in order to start; Dependants() says who must be consulted before one of its resources is deleted. A dependency graph cannot answer the second question — inventory depending on essential says nothing about who depends on inventory — so the list is hard-coded and owned by the module whose resources are at stake.

The names are canonical module names, matching Name(). A name that is not loaded in this binary is skipped rather than rejected: the same module ships in binaries with different module sets, and a resource whose consumer is absent has no consumer to ask.

type InCodeModuleRegisterLanguage ¶

type InCodeModuleRegisterLanguage interface {
	RegisterLanguage() model.LanguageTranslation
}

InCodeModuleRegisterLanguage is optional: a module returns its own translations, per language code (e.g. "en-US"). Essential collects them in OnAppStarted and serves them under the module's Name(), so a module ships its translations without touching essential.

A language essential already embeds for that module, or one registered twice, fails startup: every translation has exactly one source.

type JSON ¶

type JSON map[string]any

type ModuleCategory ¶

type ModuleCategory string

ModuleCategory groups modules by the product line they belong to. The repository a module lives in decides it, except a shadow module, which keeps the category of the base it replaces.

const (
	ModuleCategoryFoundation  ModuleCategory = "foundation"
	ModuleCategoryCoremart    ModuleCategory = "coremart"
	ModuleCategoryCoreparking ModuleCategory = "coreparking"
	ModuleCategoryItInfra     ModuleCategory = "itinfra"
)

type ModuleDependantRegistry ¶

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

ModuleDependantRegistry answers "who references this module's resources", which a module asks before deleting one of them. It is built once at startup from every module implementing InCodeModuleDependants and is read-only afterwards.

Absent dependants are kept out of the answer rather than rejected. A module's dependant list is written once and ships in every binary, but the binaries load different module sets — coremart runs the vending machine, nikkierp does not — so naming a module that this binary did not load is a legitimate state, not a misconfiguration. Only the names that are actually loaded can answer a usage check, and only those are returned.

func NewModuleDependantRegistry(mods []InCodeModule) (*ModuleDependantRegistry, error)

func (this *ModuleDependantRegistry) AbsentDependants(moduleName string) []string

func (this *ModuleDependantRegistry) GetModuleDependants(moduleName string) []string

func (this *ModuleDependantRegistry) OwnersWithAbsentDependants() []string

type SoftDeletable ¶

type SoftDeletable interface {
	SetDeletedUtcNow()
}

type ValueObject ¶

type ValueObject interface {
	// Value() (any, error)
	Json() any
	String() string
}