modules

type ModuleCodegenConfig struct {
	// Whether to automatically generate a .gitignore file for this module.
	AutomaticGitignore *bool `json:"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 SDK this module uses
	SDK *SDK `json:"sdk,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"`
}

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

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

	// Whether the client is generated in Dev mode or not.
	// If set using an official SDK like Go or Typescript, the client will use the local SDK library
	// instead of the published one.
	Dev *bool `field:"true" name:"dev" json:"localLibrary,omitempty" doc:"If true, generate the client in developer mode."`
}

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"`
}

type ModuleConfigUserFields struct {
	// The self-describing json $schema
	Schema string `json:"$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"`
	Config map[string]interface{} `json:"config,omitempty"`
}