bufmodule

type Module interface {
	// TargetFileInfos gets all FileInfos specified as target files. This is either
	// all the FileInfos belonging to the module, or those specified by ModuleWithTargetPaths().
	//
	// It does not include dependencies.
	//
	// The returned TargetFileInfos are sorted by path.
	TargetFileInfos(ctx context.Context) ([]bufmoduleref.FileInfo, error)
	// SourceFileInfos gets all FileInfos belonging to the module.
	//
	// It does not include dependencies.
	//
	// The returned SourceFileInfos are sorted by path.
	SourceFileInfos(ctx context.Context) ([]bufmoduleref.FileInfo, error)
	// GetModuleFile gets the source file for the given path.
	//
	// Returns fs.ErrNotExist error if the file does not exist.
	GetModuleFile(ctx context.Context, path string) (ModuleFile, error)
	// DeclaredDirectDependencies returns the direct dependencies declared in the configuration file.
	//
	// The returned ModuleReferences are sorted by remote, owner, repository, and reference (if
	// present). The returned ModulePins are unique by remote, owner, repository.
	//
	// This does not include any transitive dependencies, but if the declarations are correct,
	// this should be a subset of the dependencies from DependencyModulePins.
	//
	// TODO: validate that this is a subset? This may mess up construction.
	DeclaredDirectDependencies() []bufmoduleref.ModuleReference
	// DependencyModulePins gets the dependency ModulePins.
	//
	// The returned ModulePins are sorted by remote, owner, repository, branch, commit, and then digest.
	// The returned ModulePins are unique by remote, owner, repository.
	//
	// This includes all transitive dependencies.
	DependencyModulePins() []bufmoduleref.ModulePin
	// Documentation gets the contents of the module documentation file, buf.md and returns the string representation.
	// This may return an empty string if the documentation file does not exist.
	Documentation() string
	// DocumentationPath returns the path to the documentation file for the module.
	// Can be one of `buf.md`, `README.md` or `README.markdown`
	DocumentationPath() string
	// License gets the contents of the module license file, LICENSE and returns the string representation.
	// This may return an empty string if the documentation file does not exist.
	License() string
	// BreakingConfig returns the breaking change check configuration set for the module.
	//
	// This may be nil, since older versions of the module would not have this stored.
	BreakingConfig() *bufbreakingconfig.Config
	// LintConfig returns the lint check configuration set for the module.
	//
	// This may be nil, since older versions of the module would not have this stored.
	LintConfig() *buflintconfig.Config
	// FileSet returns the FileSet for the module.
	//
	// FileSet will be nil if the Module was not constructed with a FileSet.
	//
	// A FileSet's contents contain a lexicographically sorted list of path names along
	// with each path's digest. In addition to the .proto files in the module, it also lists
	// the buf.yaml, LICENSE, buf.md, and buf.lock files (if present).
	FileSet() bufcas.FileSet
	// ModuleIdentity returns the ModuleIdentity for the Module, if it was
	// provided at construction time via ModuleWithModuleIdentity or ModuleWithModuleIdentityAndCommit.
	//
	// Note this *can* be nil if we did not build from a named module.
	// All code must assume this can be nil.
	// nil checking should work since the backing type is always a pointer.
	ModuleIdentity() bufmoduleref.ModuleIdentity

	// Note this can be empty.
	// This will only be set if ModuleIdentity is set. but may not be set
	// even if ModuleIdentity is set, that is commit is optional information
	// even if we know what module this file came from.
	Commit() string
	// WorkspaceDirectory returns the directory within the workspace that this Module was constructed from,
	// if this Module was constructed from a Workspace. If the Module was not constructed from a Workspace,
	// This value will be empty.
	//
	// This is needed for now because we need to determine if the input for ModuleFileSetBuilder is equal
	// to any Modules within the given optional Workspace. This is terrible. Once we have refactored
	// the CLI to have Workspaces as a first-class citizen, where the typical case is a Workspace with
	// a single Module, we will no longer need to do this type of check, and this can be removed.
	WorkspaceDirectory() string
	// contains filtered or unexported methods
}

type ModuleFile interface {
	bufmoduleref.FileInfo
	io.ReadCloser
	// contains filtered or unexported methods
}

type ModuleFileSet interface {
	// Note that GetModuleFile will pull from All files instead of just Source Files!
	Module
	// AllFileInfos gets all FileInfos associated with the module, including dependencies.
	//
	// The returned FileInfos are sorted by path.
	AllFileInfos(ctx context.Context) ([]bufmoduleref.FileInfo, error)
	// contains filtered or unexported methods
}

type ModuleOption func(*module)

type ModuleReader interface {
	// GetModule gets the Module for the ModulePin.
	//
	// Returns an error with fs.ErrNotExist if the Module does not exist.
	GetModule(ctx context.Context, modulePin bufmoduleref.ModulePin) (Module, error)
}

type ModuleResolver interface {
	// GetModulePin resolves the provided ModuleReference to a ModulePin.
	//
	// Returns an error with fs.ErrNotExist if the named Module does not exist.
	GetModulePin(ctx context.Context, moduleReference bufmoduleref.ModuleReference) (bufmoduleref.ModulePin, error)
}

type Workspace interface {
	// GetModule gets the module identified by the given ModuleIdentity.
	//
	GetModule(moduleIdentity bufmoduleref.ModuleIdentity) (Module, bool)
	// GetModules returns all of the modules found in the workspace.
	GetModules() []Module
}