objectives

Documentation

Overview

Package objectives manages the human-authored goals that give the engine its sense of direction ("what we're trying to do"). In v1 objectives are created by people, never inferred — that avoids stale or hallucinated goals.

Index

• Constants
• type Objective
• type Service
  • func New(s store.Store) *Service
  • func (svc *Service) Add(ctx context.Context, title string, priority int, parentID string) (Objective, error)
  • func (svc *Service) Current(ctx context.Context) ([]Objective, error)
  • func (svc *Service) List(ctx context.Context) ([]Objective, error)
  • func (svc *Service) SetStatus(ctx context.Context, id, status string) (Objective, error)

Constants

const (
	StatusProposed  = "proposed"
	StatusActive    = "active"
	StatusBlocked   = "blocked"
	StatusDone      = "done"
	StatusAbandoned = "abandoned"
)

Status values for an objective.

Types

type Objective

type Objective = store.Objective

Objective is re-exported from store for callers that only need this package.

type Service

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

Service is the objective use-case layer over a Store.

func New

func New(s store.Store) *Service

New returns a Service backed by s.

func (*Service) Add

func (svc *Service) Add(ctx context.Context, title string, priority int, parentID string) (Objective, error)

Add creates a new objective. priority defaults sensibly; parent may be empty.

func (*Service) Current

func (svc *Service) Current(ctx context.Context) ([]Objective, error)

Current returns the objectives in flight (active or blocked).

func (*Service) List

func (svc *Service) List(ctx context.Context) ([]Objective, error)

List returns all objectives, highest priority first.

func (*Service) SetStatus

func (svc *Service) SetStatus(ctx context.Context, id, status string) (Objective, error)

SetStatus transitions an objective to a new status.