ModuleDefinitionSchema

@aurorajs.dev/catalyst-cli / generator/domain/model / ModuleDefinitionSchema

Interface: ModuleDefinitionSchema

Defined in: generator/domain/model.ts:278

Full schema for a generated module. This is the in-memory representation loaded from cliter/<bc>/<module>.aurora.yaml, after validation and default-filling.

Properties

additionalApis?

optional additionalApis?: AdditionalApi[]

Defined in: generator/domain/model.ts:279

aggregateName

aggregateName: string

Defined in: generator/domain/model.ts:280

aggregateProperties

aggregateProperties: Property[]

Defined in: generator/domain/model.ts:281

boundedContextName

boundedContextName: string

Defined in: generator/domain/model.ts:282

excludedFiles?

optional excludedFiles?: string[]

Defined in: generator/domain/model.ts:284

Templates skipped when generating this module.

excludedOperations?

optional excludedOperations?: string[]

Defined in: generator/domain/model.ts:286

CRUD operations skipped when generating this module.

front?

optional front?: object

Defined in: generator/domain/model.ts:288

Frontend-only presentation metadata (icon, grammatical gender, …).

gender?

optional gender?: Gender

Grammatical gender of the module’s singular noun. Used by the generator to pick F/M variants from the global i18n JSON (e.g. New.F → “Nueva”, New.M → “Nuevo”). Ignored by languages without grammatical gender.