model

type ID int64

type MailingListService interface {
	// Subscribe adds an admin to the mailing list.
	Subscribe(ctx context.Context, username, email string) error
	// Unsubscribe removes an admin from the mailing list.
	Unsubscribe(ctx context.Context, username string) error
	// IsSubscribed checks if an admin is subscribed.
	IsSubscribed(ctx context.Context, username string) (bool, error)
	// ListSubscribers returns all subscribed admins.
	ListSubscribers(ctx context.Context) ([]Subscriber, error)
}

type Nodegroup string

type Resource string

type Subscriber struct {
	Username string
	Email    string
}

type Workspace struct {
	ID

	Created   bool
	Enabled   bool
	Nodegroup Nodegroup
	Userdata  string

	Quotas map[Resource]uint64
	Users  []WorkspaceUser

	Request *WorkspaceUpdate
}

type WorkspaceService interface {
	// Accept user-provided fields only.
	CreateWorkspace(ctx context.Context, ws *Workspace, creatorEmail string) (*Workspace, error)

	// Full scan every workspace.
	ListAllWorkspaces(ctx context.Context) ([]*Workspace, error)
	// Only list workspaces for a given user (accepted invitations only).
	ListUserWorkspaces(ctx context.Context, user string) ([]*Workspace, error)
	// List all created workspaces.
	ListCreatedWorkspaces(ctx context.Context) ([]*Workspace, error)
	// List workspaces where user has pending invitation (email is NULL).
	ListUserInvitations(ctx context.Context, user string) ([]*Workspace, error)

	GetWorkspace(ctx context.Context, id ID) (*Workspace, error)
	// Return ErrNotFound if not owned.
	GetUserWorkspace(ctx context.Context, id ID, user string) (*Workspace, error)

	// Immediately apply any changes, for admins.
	UpdateWorkspace(ctx context.Context, upd *WorkspaceUpdate) (*Workspace, error)
	// Requetst an update, for uesrs. Ignore admin-controlled fields.
	RequestUpdateWorkspace(ctx context.Context, upd *WorkspaceUpdate) (*Workspace, error)

	// Accept a workspace invitation (sets email for the user).
	AcceptInvitation(ctx context.Context, workspaceID ID, username, email string) error
	// Decline a workspace invitation (removes user from workspace).
	DeclineInvitation(ctx context.Context, workspaceID ID, username string) error

	DeleteWorkspace(ctx context.Context, id ID) error
}

type WorkspaceUpdate struct {
	WorkspaceID ID
	ByUser      string

	Enabled   bool
	Nodegroup Nodegroup
	Userdata  string

	Quotas map[Resource]uint64
	Users  []string
}

type WorkspaceUser struct {
	Username string
	Email    string // empty = pending invitation
}