manifest

type Build struct {
	Backend string            `toml:"backend"` // make|shell|c|lua-c|go|cargo - closed enum.
	Cwd     string            `toml:"cwd,omitempty"`
	Env     map[string]string `toml:"env,omitempty"`
	Output  []string          `toml:"output,omitempty"`
	// Incremental skips the build of a make or shell component when its
	// inputs - the build block and the files of the component, but those its
	// .gitignore files ignore - are the ones of its last build, and its
	// outputs are there.
	Incremental *bool `toml:"incremental,omitempty"`

	// make backend.
	MakeTarget string   `toml:"make_target,omitempty"`
	Entrypoint string   `toml:"entrypoint,omitempty"`
	Flags      []string `toml:"flags,omitempty"`

	// shell backend.
	Command string   `toml:"command,omitempty"`
	Args    []string `toml:"args,omitempty"`

	// c / lua-c backends.
	Module      string                  `toml:"module,omitempty"`
	Sources     []string                `toml:"sources,omitempty"`
	IncludeDirs []string                `toml:"include_dirs,omitempty"`
	Libraries   []string                `toml:"libraries,omitempty"`
	LibraryDirs []string                `toml:"library_dirs,omitempty"`
	Defines     []string                `toml:"defines,omitempty"`
	Platforms   map[string]BuildOverlay `toml:"platforms,omitempty"`

	// go and cargo backends. Package is the Go package to build (default
	// ".") or the cargo package that holds the binary.
	Package string `toml:"package,omitempty"`
	// Static asks for a program that needs no loader and no shared library
	// of the machine it runs on; the build checks that it got one.
	Static *bool `toml:"static,omitempty"`

	// go backend.
	Name    string   `toml:"name,omitempty"` // Default: the component name.
	Tags    []string `toml:"tags,omitempty"`
	Ldflags []string `toml:"ldflags,omitempty"`
	Cgo     *bool    `toml:"cgo,omitempty"` // Nil or false: CGO_ENABLED=0.

	// cargo backend.
	Bin      string   `toml:"bin,omitempty"` // Default: the component name.
	Features []string `toml:"features,omitempty"`
	Profile  string   `toml:"profile,omitempty"` // Default: release.
}

type BuildOverlay struct {
	IncludeDirs []string `toml:"include_dirs,omitempty"`
	Libraries   []string `toml:"libraries,omitempty"`
	LibraryDirs []string `toml:"library_dirs,omitempty"`
	Defines     []string `toml:"defines,omitempty"`
}

type Change struct {
	Existed  bool   // A declaration was already there.
	Previous string // Its previous version constraint, when Existed.
}

type Component struct {
	Path         string                `toml:"path"`              // Required.
	Kind         string                `toml:"kind,omitempty"`    // module|executable; "": module.
	Include      []string              `toml:"include,omitempty"` // Default *.lua, *.so.
	Exclude      []string              `toml:"exclude,omitempty"`
	Namespace    *string               `toml:"namespace,omitempty"` // Nil: pkg name; "": flat.
	Dependencies map[string]Dependency `toml:"dependencies,omitempty"`
	Build        *Build                `toml:"build,omitempty"`
}

type Constraint struct {
	// Version is the semver constraint part, e.g. ">=3.0.0,<4.0.0". Empty for
	// an unset (omitted) constraint.
	Version string
	// Flavor is "ce", "ee" or "" (unspecified). For tarantool/tt an empty
	// flavor means [ce]; see EffectiveFlavor.
	Flavor string
}

type DepTable string

type Dependency struct {
	Source   string `toml:"source,omitempty"`   // Source: "registry" (default) or "path".
	Version  string `toml:"version,omitempty"`  // Constraint; required for registry.
	Path     string `toml:"path,omitempty"`     // Required for path.
	Registry string `toml:"registry,omitempty"` // Overrides the server.
	Kind     string `toml:"kind,omitempty"`     // In v0 only "library".
}

type Distribution struct {
	ManifestVersion string                      `toml:"manifest_version"`
	Kind            string                      `toml:"manifest_kind"`
	Package         DistributionPackage         `toml:"package,omitempty"`
	Core            DistributionCore            `toml:"core,omitempty"`
	Distribution    DistributionOptions         `toml:"distribution,omitempty"`
	Build           DistributionBuild           `toml:"build,omitempty"`
	Dependencies    map[string]ModuleDependency `toml:"dependencies,omitempty"`
	// Replace overrides Go modules of the build, like replace directives of
	// its go.mod: a module path, with an optional @version, to a local
	// directory or to module@version. See Replacement.
	Replace map[string]string `toml:"replace,omitempty"`
	// contains filtered or unexported fields
}

type DistributionBuild struct {
	// SSL is the TLS implementation: SSLDefault, SSLOpenSSL or
	// SSLOpenSSLStatic. TT_CLI_BUILD_SSL, when set, takes precedence.
	// Default: SSLDefault.
	SSL string `toml:"ssl,omitempty"`
	// Cgo builds with cgo. Default: only for the OpenSSL implementations.
	Cgo *bool `toml:"cgo,omitempty"`
	// Tags are build tags added to the canonical ones.
	Tags []string `toml:"tags,omitempty"`
	// Ldflags are linker flags added to the canonical ones, one flag per
	// entry.
	Ldflags []string `toml:"ldflags,omitempty"`
}

type DistributionCore struct {
	// Tt is a Go version query for the core module: latest, a branch, a
	// commit, a version. Default: the version of the core of the tt that
	// builds the distribution.
	Tt string `toml:"tt,omitempty"`
	// Path is a local checkout of the core's repository, relative to the
	// manifest's directory. It excludes Tt.
	Path string `toml:"path,omitempty"`
	// Module is the Go module of the core. Default: DefaultCoreModule.
	Module string `toml:"module,omitempty"`
}

type DistributionLock struct {
	LockVersion     string                  `toml:"lock_version"`
	ManifestVersion string                  `toml:"manifest_version"`
	GeneratedBy     string                  `toml:"generated_by"`  // Like "tt 3.x.y".
	ManifestHash    string                  `toml:"manifest_hash"` // Like "sha256:...".
	Core            LockedCore              `toml:"core"`
	Modules         map[string]LockedModule `toml:"modules,omitempty"`
	// Replace pins the entries of [replace], by their keys.
	Replace map[string]LockedReplace `toml:"replace,omitempty"`
}

type DistributionOptions struct {
	// Title is the name the binary presents itself under. Default: tt's
	// own.
	Title string `toml:"title,omitempty"`
	// Edition follows the short version as semver build metadata: "ee"
	// makes it 3.1.0+ee. Default: none.
	Edition string `toml:"edition,omitempty"`
	// Integrity is the integrity provider: IntegrityNone or IntegrityRSA.
	// Default: IntegrityNone.
	Integrity string `toml:"integrity,omitempty"`
	// Builtin includes tt's own commands. Default: true.
	Builtin *bool `toml:"builtin,omitempty"`
	// ExternalModules lets tt run the external modules TT_CLI_MODULES_PATH
	// lists. Default: true.
	ExternalModules *bool `toml:"external_modules,omitempty"`
}

type DistributionPackage struct {
	// Name is the name of the binary. Default: DefaultDistributionName.
	Name string `toml:"name,omitempty"`
}

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

type Hook = Build

type Lock struct {
	LockVersion      string `toml:"lock_version"`
	ManifestVersion  string `toml:"manifest_version"`
	GeneratedBy      string `toml:"generated_by"`  // Like "tt 3.x.y".
	ManifestHash     string `toml:"manifest_hash"` // Like "sha256:...".
	BundledTarantool string `toml:"bundled_tarantool_version,omitempty"`
	BundledTt        string `toml:"bundled_tt_version,omitempty"`
	BundledTcm       string `toml:"bundled_tcm_version,omitempty"`

	// Products maps product name to its resolution snapshot. On disk this is
	// the [lock.products.<name>] table tree.
	Products map[string]LockProduct `toml:"-"`

	// DevDependencies is the closure of [dev_dependencies], as
	// [[lock.dev_dependencies]]. It is one list rather than one per product:
	// the manifest declares dev dependencies globally, so there is nothing to
	// key them by.
	//
	// It is pinned like any other closure because it can shape the artifact:
	// the dev tree is materialized into .rocks/ before the component build
	// backends run, so a generator installed as a dev dependency writes files
	// that are then laid out and packed. Recording the versions is what makes
	// such a build reproducible. Empty for a manifest that declares none, and then absent
	// from the file entirely - a lock written before dev dependencies existed
	// is therefore indistinguishable from one whose manifest declares none,
	// which is why IsStale checks the manifest side too.
	DevDependencies []LockDependency `toml:"-"`
}

type LockDependency struct {
	Name        string `toml:"name"`
	Version     string `toml:"version"`                // Exact version.
	Source      string `toml:"source"`                 // Registry or path.
	Checksum    string `toml:"checksum,omitempty"`     // Registry: "md5:..." or "sha256:...".
	Path        string `toml:"path,omitempty"`         // Path source.
	ContentHash string `toml:"content_hash,omitempty"` // Path: sha256 of contents.
}

type LockProduct struct {
	Dependencies []LockDependency `toml:"dependencies"`
}

type LockedCore struct {
	// Module is the Go module of the core.
	Module string `toml:"module"`
	// Version is the exact version of the core; empty for a local core.
	Version string `toml:"version,omitempty"`
	// Revision is the commit of the core's repository Version is.
	Revision string `toml:"revision,omitempty"`
	// Path is the local core, as the manifest names it.
	Path string `toml:"path,omitempty"`
	// ContentHash is the hash of the files of a local core and of the
	// modules of its repository it is built with, "sha256:<hex>"; a build
	// from the lock fails when they changed. Empty for a versioned core.
	ContentHash string `toml:"content_hash,omitempty"`
	// Repository maps every other module of the core's repository to its
	// exact version at Revision; empty for a local core, whose modules are
	// taken from its directory.
	Repository map[string]string `toml:"repository,omitempty"`
}

type LockedModule struct {
	// Module is the Go module path.
	Module string `toml:"module"`
	// Version is the exact version; empty for a module of the core's
	// repository, which follows the core, and for a local module.
	Version string `toml:"version,omitempty"`
	// Path is the local module, as the manifest names it.
	Path string `toml:"path,omitempty"`
	// ContentHash is the hash of the files of a local module,
	// "sha256:<hex>"; a build from the lock fails when they changed. Empty
	// for a module from a module proxy, which go.sum checks.
	ContentHash string `toml:"content_hash,omitempty"`
}

type LockedReplace struct {
	// Module is the module the entry replaces with: its path for a
	// replacement with a module, empty for a local directory.
	Module string `toml:"module,omitempty"`
	// Version is the exact version of Module; empty for a local directory.
	Version string `toml:"version,omitempty"`
	// Path is the local directory, as the manifest names it.
	Path string `toml:"path,omitempty"`
	// ContentHash is the hash of the files of a local directory,
	// "sha256:<hex>"; a build from the lock fails when they changed. Empty
	// for a replacement with a module, which go.sum checks.
	ContentHash string `toml:"content_hash,omitempty"`
}

type Manifest struct {
	ManifestVersion string                `toml:"manifest_version"`
	Kind            string                `toml:"manifest_kind,omitempty"` // "" or ManifestKindApp.
	Package         Package               `toml:"package"`
	Platform        Platform              `toml:"platform"`
	Dependencies    map[string]Dependency `toml:"dependencies,omitempty"`
	DevDependencies map[string]Dependency `toml:"dev_dependencies,omitempty"`
	Components      map[string]Component  `toml:"components,omitempty"`
	Products        map[string]Product    `toml:"products,omitempty"`
	Hooks           map[string]Hook       `toml:"hooks,omitempty"` // Keys: pre_build, post_build.
	// contains filtered or unexported fields
}

type ModuleDependency struct {
	// Module is the Go module path. Required unless Path is set; for a path
	// dependency it is read from the go.mod there.
	Module string `toml:"module,omitempty"`
	// Version is a Go version query. Default: the core's commit for a
	// module of the core's repository, LatestVersion for any other.
	Version string `toml:"version,omitempty"`
	// Path is a local directory with the module, relative to the
	// manifest's directory.
	Path string `toml:"path,omitempty"`
	// Package is the import path of the package with the constructor.
	// Default: the module's root package.
	Package string `toml:"package,omitempty"`
	// Symbol is the constructor's name. Default: DefaultModuleSymbol.
	Symbol string `toml:"symbol,omitempty"`
	// Kind is ModuleKind, the only kind there is; it may be omitted.
	Kind string `toml:"kind,omitempty"`
	// Source is "registry" or "path"; it follows from Path when omitted.
	Source string `toml:"source,omitempty"`
}

type Package struct {
	Name               string   `toml:"name"` // Regex [a-z][a-z0-9-]*; not "bin"/"manifests".
	Description        string   `toml:"description,omitempty"`
	License            string   `toml:"license,omitempty"`
	LicenseFiles       []string `toml:"license_files,omitempty"`
	Include            []string `toml:"include,omitempty"`
	Repository         string   `toml:"repository,omitempty"`
	Authors            []string `toml:"authors,omitempty"`
	GenerateVersionLua *bool    `toml:"generate_version_lua,omitempty"` // Nil means true.
}

type Platform struct {
	Tarantool Constraint `toml:"tarantool"`           // Required; flavor [ce]/[ee], default [ce].
	Tt        Constraint `toml:"tt"`                  // Required.
	Tcm       Constraint `toml:"tcm,omitempty"`       // No flavor - TCM is Enterprise only.
	Platforms []string   `toml:"platforms,omitempty"` // One of linux/darwin-amd64/arm64 or any.

	// Registries is the ordered rock-server list the project resolves
	// against, replacing the built-in defaults. An entry is an HTTP(S) URL
	// or a local directory - a path without a scheme, or a file:// URL - and
	// a relative path is taken relative to the directory holding the
	// manifest. Omitted uses the defaults.
	Registries []string `toml:"registries,omitempty"`
}

type Product struct {
	Components []string `toml:"components"` // Required; names must exist in [components].
	Default    bool     `toml:"default,omitempty"`
}

type Replacement struct {
	// Key is the key as the manifest writes it: Module, or Module@Version.
	Key string
	// Module is the Go module path that is replaced.
	Module string
	// Version is the version that is replaced; empty replaces every version.
	Version string
	// Path is the local directory the module is replaced with, as the
	// manifest names it; empty for a replacement with a module.
	Path string
	// Target is the module the module is replaced with; empty for a
	// directory.
	Target string
	// TargetVersion is the Go version query of Target.
	TargetVersion string
}

type ValidationError struct {
	Field string
	Msg   string
}