workspace

type FinderService interface {
	// FindByReference retrieves a repository by its reference
	FindByReference(ctx context.Context, ws WorkspaceService, reference repository.Reference) (*repository.Location, error)

	// FindByPath retrieves a repository by its path
	FindByPath(ctx context.Context, ws WorkspaceService, path string) (*repository.Location, error)

	// ListAllRepository retrieves a list of repositories under all roots
	ListAllRepository(context.Context, WorkspaceService, ListOptions) iter.Seq2[*repository.Location, error]

	// ListRepositoryInRoot retrieves a list of repositories under a root
	ListRepositoryInRoot(context.Context, LayoutService, ListOptions) iter.Seq2[*repository.Location, error]
}

type LayoutService interface {
	// GetRoot returns the root of the layout
	GetRoot() string

	// Match returns the repository reference corresponding the given path
	// If the path does not match the layout, it returns the error `repository.ErrNotMatched`
	// Example:
	// Match("github.com/owner/repo") returns "github.com/owner/repo"
	// Match("github.com/owner/repo/foo") returns "github.com/owner/repo"
	Match(path string) (*repository.Reference, error)

	// ExactMatch returns the repository reference corresponding exactly to the given path
	// If the path does not match the layout, it returns the error `repository.ErrNotMatched`
	// Example:
	// ExactMatch("github.com/owner/repo") returns "github.com/owner/repo"
	// ExactMatch("github.com/owner/repo/foo") returns `repository.ErrNotMatched`
	ExactMatch(path string) (*repository.Reference, error)

	// PathFor returns the path corresponding to the given reference
	PathFor(ref repository.Reference) string

	// CreateRepositoryFolder creates a new folder for the repository
	CreateRepositoryFolder(reference repository.Reference) (string, error)

	// DeleteRepository deletes the repository
	DeleteRepository(reference repository.Reference) error
}

type ListOptions struct {
	// Limit is the maximum number of repositories to return
	// If 0, all repositories will be returned
	Limit int
	// Patterns to match repository paths
	// If empty, all repositories will be returned
	Patterns []string
}

type Root = string

type WorkspaceService interface {
	// GetRoots returns all registered roots
	GetRoots() []Root

	// GetPrimaryRoot returns the primary root
	GetPrimaryRoot() Root

	// GetLayoutFor returns a Layout for the root
	GetLayoutFor(root Root) LayoutService

	// GetPrimaryLayout returns a Layout for the primary root
	GetPrimaryLayout() LayoutService

	// SetPrimaryRoot sets the primary root
	SetPrimaryRoot(Root) error

	// AddRoot adds a new root
	AddRoot(root Root, asPrimary bool) error

	// RemoveRoot removes a root
	RemoveRoot(root Root) error

	store.Content
}