modules

type ConfigFormat string

type CurrentModuleConfig struct {
	// The name of the module.
	Name string `json:"name" toml:"name"`

	// The version of the engine this module was last updated with.
	EngineVersion string `json:"engineVersion" toml:"engineVersion"`

	// Paths to explicitly include from the module, relative to the configuration file.
	Include []string `json:"include,omitempty" toml:"include,omitempty"`

	// The path, relative to this config file, to the subdir containing the module's implementation source code.
	Source string `json:"source,omitempty" toml:"source,omitempty"`

	// Paths to explicitly exclude from the module, relative to the configuration file.
	//
	// Deprecated: Use !<pattern> in the include list instead.
	Exclude []string `json:"exclude,omitempty" toml:"exclude,omitempty"`

	// If true, disable the new default function caching behavior for this module. Functions will
	// instead default to the old behavior of per-session caching.
	DisableDefaultFunctionCaching *bool `json:"disableDefaultFunctionCaching,omitempty" toml:"disableDefaultFunctionCaching,omitempty"`

	// The runtime this module uses.
	Runtime *SDK `json:"runtime,omitempty" toml:"runtime,omitempty"`

	// The modules this module depends on.
	Dependencies []*CurrentModuleConfigDependency `json:"dependencies,omitempty" toml:"dependencies,omitempty"`

	// Codegen configuration for this module.
	Codegen *ModuleCodegenConfig `json:"codegen,omitempty" toml:"codegen,omitempty"`

	// The clients generated for this module.
	Clients []*ModuleConfigClient `json:"clients,omitempty" toml:"clients,omitempty"`
}

type CurrentModuleConfigDependency struct {
	// The name to use for this dependency. By default, the same as the dependency module's name,
	// but can also be overridden to use a different name.
	Name string `json:"name,omitempty" toml:"name,omitempty"`

	// The source ref of the module dependency.
	Source string `json:"source" toml:"source"`

	// The pinned version of the module dependency.
	Pin string `json:"pin,omitempty" toml:"pin,omitempty"`
}

type CurrentModuleConfigWithUserFields struct {
	ModuleConfigUserFields
	CurrentModuleConfig
}

type LegacyModuleConfigWithUserFields struct {
	ModuleConfigUserFields
	ModuleConfig
}

type ModuleCodegenConfig struct {
	// Whether to automatically generate a .gitignore file for this module.
	AutomaticGitignore *bool `json:"automaticGitignore,omitempty" toml:"automaticGitignore,omitempty"`
}

type ModuleConfig struct {
	// The name of the module.
	Name string `json:"name"`

	// The version of the engine this module was last updated with.
	EngineVersion string `json:"engineVersion"`

	// The runtime this module uses. It is serialized as "runtime" in
	// dagger-module.toml and as "sdk" in legacy dagger.json.
	SDK *SDK `json:"sdk,omitempty"`

	// An optional blueprint module
	Blueprint *ModuleConfigDependency `json:"blueprint,omitempty"`

	// Toolchain modules
	Toolchains []*ModuleConfigDependency `json:"toolchains,omitempty"`

	// Paths to explicitly include from the module, relative to the configuration file.
	Include []string `json:"include,omitempty"`

	// The modules this module depends on.
	Dependencies []*ModuleConfigDependency `json:"dependencies,omitempty"`

	// The path, relative to this config file, to the subdir containing the module's implementation source code.
	Source string `json:"source,omitempty"`

	// Codegen configuration for this module.
	Codegen *ModuleCodegenConfig `json:"codegen,omitempty"`

	// Paths to explicitly exclude from the module, relative to the configuration file.
	//
	// Deprecated: Use !<pattern> in the include list instead.
	Exclude []string `json:"exclude,omitempty"`

	// The clients generated for this module.
	Clients []*ModuleConfigClient `json:"clients,omitempty"`

	// If true, disable the new default function caching behavior for this module. Functions will
	// instead default to the old behavior of per-session caching.
	DisableDefaultFunctionCaching *bool `json:"disableDefaultFunctionCaching,omitempty"`
}

type ModuleConfigArgument struct {
	// The function chain to apply this argument to. Empty or nil for constructor.
	Function []string `json:"function,omitempty"`

	// The name of the argument to override.
	Argument string `json:"argument"`

	// The default value to use for this argument.
	Default string `json:"default,omitempty"`

	// The default path to use for File or Directory arguments.
	DefaultPath string `json:"defaultPath,omitempty"`

	// The default address to use for Container arguments.
	DefaultAddress string `json:"defaultAddress,omitempty"`

	// Ignore patterns for Directory arguments.
	Ignore []string `json:"ignore,omitempty"`
}

type ModuleConfigClient struct {
	// The generator the client uses to be generated.
	Generator string `field:"true" name:"generator" json:"generator" toml:"generator" doc:"The generator to use"`

	// The directory the client is generated in.
	Directory string `field:"true" name:"directory" json:"directory" toml:"directory" doc:"The directory the client is generated in."`
}

type ModuleConfigDependency struct {
	// The name to use for this dependency. By default, the same as the dependency module's name,
	// but can also be overridden to use a different name.
	Name string `json:"name"`

	// The source ref of the module dependency.
	Source string `json:"source"`

	// The pinned version of the module dependency.
	Pin string `json:"pin,omitempty"`

	// Customizations configuration for toolchains that override function argument pragmas.
	Customizations []*ModuleConfigArgument `json:"customizations,omitempty"`

	// IgnoreChecks is a list of check patterns to exclude from this toolchain.
	// Patterns can use glob syntax to match check names.
	IgnoreChecks []string `json:"ignoreChecks,omitempty"`

	// IgnoreGenerators is a list of generator patterns to exclude from this toolchain.
	// Patterns can use glob syntax to match generator names.
	IgnoreGenerators []string `json:"ignoreGenerators,omitempty"`

	// IgnoreServices is a list of service (up) patterns to exclude from this toolchain.
	// Patterns can use glob syntax to match service names.
	IgnoreServices []string `json:"ignoreServices,omitempty"`

	// PortMappings maps service names to port forwarding rules.
	// Keys are service names (e.g. "web", "infra:database").
	// Values are arrays of "hostPort:containerPort" strings (e.g. ["3000:80"]).
	PortMappings map[string][]string `json:"portMappings,omitempty"`
}

type ModuleConfigUserFields struct {
	// The self-describing config schema.
	Schema string `json:"$schema,omitempty" toml:"$schema,omitempty"`
}

type ModuleConfigView struct {
	Name     string   `json:"name"`
	Patterns []string `json:"patterns,omitempty"`
}

type ModuleConfigWithUserFields struct {
	ModuleConfigUserFields
	ModuleConfig
}

type SDK struct {
	Source string         `json:"source" toml:"source"`
	Config map[string]any `json:"config,omitempty" toml:"config,omitempty"`
	Debug  bool           `json:"debug,omitempty" toml:"debug,omitempty"`
	// The experimental features enabled for this module.
	Experimental map[string]bool `json:"experimental,omitempty" toml:"experimental,omitempty"`
}