engine

package

Go to main page

Versions in this module

v2

v2.11.0

Oct 15, 2026

Changes in this version

+ const StanceAcceptResponse

+ const StanceAdjust

+ const StanceConcede

+ const StanceHold

+ var ErrNoComments = fmt.Errorf("%w: this deployment keeps no comments", ErrNotFound)

+ var Sides = []string

+ func ByPerson(ctx context.Context) context.Context

+ func QuestionID(set, kind, id, check string) string

+ type AggregationReading struct

+ Agg string

+ At int

+ Expr string

+ Names []string

+ Problem string

+ Reading string

+ func ReadAggregation(text string) AggregationReading

+ type Assumed struct

+ Field string

+ Took string

+ Why string

type Check

+ NotJudged bool

+ type CommentDraft struct

+ Anchor string

+ Body string

+ Mentions []store.Mention

+ Reply string

+ type Constraints struct

+ MostConstrained string

+ Sides []Side

+ Unplaced []string

+ func ConstraintsOf(spec map[string]any) Constraints

type DependencyEdge

+ Needed map[string]any

type Engine

+ func (e *Engine) Activity() activity.Recorder

+ func (e *Engine) AddComment(ctx context.Context, kind, id string, d CommentDraft) (store.Comment, error)

+ func (e *Engine) Affects(ctx context.Context, project, item string) ([]TimeNode, error)

+ func (e *Engine) Assume(ctx context.Context, set, kind, id string, decided []Assumed) error

+ func (e *Engine) Comments(ctx context.Context, kind, id string) ([]store.Comment, error)

+ func (e *Engine) ConfirmToken(ctx context.Context, set string) (string, error)

+ func (e *Engine) Constraints(ctx context.Context, id string) (Constraints, error)

+ func (e *Engine) Mentionables(ctx context.Context, q string, limit int) ([]Mentionable, error)

+ func (e *Engine) MyMentions(ctx context.Context, limit int) ([]store.Comment, error)

+ func (e *Engine) Names(ctx context.Context, cs []store.Comment) map[store.Mention]string

+ func (e *Engine) ResolveComment(ctx context.Context, id string, resolved bool) (store.Comment, error)

+ func (e *Engine) Round(ctx context.Context, set string, work []Ref, locale string) (Round, error)

+ func (e *Engine) Triggerables(ctx context.Context, project string) ([]Triggerable, error)

+ func (e *Engine) VocabularyLabel(vocab map[string][]VocabularyTerm, name, value string) string

+ func (e *Engine) Waits(ctx context.Context, project string) (TimeGraph, error)

+ func (e *Engine) WhatHappened(ctx context.Context, project, text string) (Happened, error)

type GoalCheck

+ NotJudged bool

+ type Happened struct

+ Available bool

+ Matches []Triggerable

+ type Mentionable struct

+ ID string

+ Kind string

+ Name string

+ type Named struct

+ Path string

type Option

+ func WithActivity(r activity.Recorder) Option

type PortRecord

+ Asked string

+ Assumed []Assumed

type PortRecordResult

+ TakenBack []string

type ProgrammeCheck

+ NotJudged bool

type ProjectCheckItem

+ NotJudged bool

+ Suggestion bool

+ type Question struct

+ Recommended *Candidate

+ type Round struct

+ Ask []Question

+ Settle []Task

+ Waiting int

+ Write []Task

+ func (r Round) Done() bool

type Settings

+ Vocabularies map[string][]VocabularyTerm

+ type Side struct

+ Constraint string

+ Exposure int

+ Risks []SideRisk

+ Share float64

+ Stance string

+ Unanswered int

+ Unweighed int

+ type SideRisk struct

+ ID string

+ Impact string

+ Implied bool

+ Likelihood string

+ On string

+ Response string

+ Spends string

+ Type string

+ Weight int

type Task

+ Question string

+ Stage int

+ type TimeEdge struct

+ From int

+ To int

+ type TimeGraph struct

+ Edges []TimeEdge

+ Nodes []TimeNode

+ type TimeNode struct

+ Conflict bool

+ Critical bool

+ Follows string

+ Item string

+ Kind string

+ Late bool

+ Month string

+ Name string

+ Record Ref

+ Risks []string

+ Timing map[string]any

+ Unplaced bool

+ X float64

+ Y float64

+ type Triggerable struct

+ Happens []string

+ Item string

+ Kind string

+ Likelihood float64

+ Name string

+ type VocabularyTerm struct

+ Description string

+ Label string

+ Value string

v2.10.1

Oct 9, 2026

v2.10.0

Oct 9, 2026

Changes in this version

+ const LineageDownstream

+ const LineageOutput

+ const LineageProject

+ const LineageSource

+ const LineageUpstream

+ const PhaseAnalyze

+ const PhaseControl

+ const PhaseDefine

+ const PhaseImprove

+ const PhaseMeasure

+ func ChangeSetOf(ctx context.Context) (string, bool)

+ func MayLeave(check, asked string) error

+ func RecordPresenceOf(kind, id string) (manifestKind, manifestID string, ok bool)

+ func WholeFile(text string, fileSize int) error

+ func WrittenFromTheDocument(check string) bool

+ type DMAIC struct

+ Phases []DMAICPhase

+ Project string

+ type DMAICItem struct

+ Field string

+ Key string

+ Lacking string

+ Met bool

+ Phase string

+ Says string

+ type DMAICPhase struct

+ Items []DMAICItem

+ Met int

+ Of int

+ Phase string

type DecisionModel

+ Off []string

+ type Draft struct

+ ID string

+ Kind string

+ Text []byte

type Engine

+ func (e *Engine) BringSource(ctx context.Context, set, title, text string) (Source, error)

+ func (e *Engine) ControlChartOf(ctx context.Context, kpi string) (spc.Chart, error)

+ func (e *Engine) DMAICOf(ctx context.Context, id string) (DMAIC, error)

+ func (e *Engine) ExportSemantic(ctx context.Context, format string) ([]semantic.File, []string, error)

+ func (e *Engine) FieldShapeAt(kind, pointer string) (FieldShape, bool)

+ func (e *Engine) LineageOf(ctx context.Context, id, name string, uses, produces []string) (Lineage, error)

+ func (e *Engine) ListFields(kind string) []string

+ func (e *Engine) NamedRefs(ctx context.Context, set, kind string, fields map[string]any) (map[string]any, []string, error)

+ func (e *Engine) PortFills(ctx context.Context, set string, work []string) ([]RecordFill, error)

+ func (e *Engine) PortPieces(ctx context.Context, set string, src Source, pieces []structure.Piece) (PortLayout, error)

+ func (e *Engine) PortRecords(ctx context.Context, set string, records []PortRecord) ([]PortRecordResult, []RecordFill, error)

+ func (e *Engine) ReadSections(ctx context.Context, set string, ids []string) ([]SectionText, error)

+ func (e *Engine) RegisterInto(ctx context.Context, set, kind, id, section, field string, ...) (RegisterResult, error)

+ func (e *Engine) RegisterOf(ctx context.Context, set, section, field string) ([]map[string]any, error)

+ func (e *Engine) SectionsFor(ctx context.Context, set, field string) []string

+ func (e *Engine) SemanticFormats() []string

+ func (e *Engine) SemanticLayer(ctx context.Context) (semantic.Layer, []string, error)

+ func (e *Engine) Sources(ctx context.Context, set string) ([]Source, error)

+ func (e *Engine) StructuralProblems(_ context.Context, kind string, text []byte) ([]Problem, error)

+ func (e *Engine) WriteFields(ctx context.Context, set, kind, id string, put map[string]any, unset []string, ...) ([]Problem, []string, error)

+ type FieldShape struct

+ Example any

+ OneOf []string

+ Optional []string

+ type FillItem struct

+ Check string

+ Do string

+ Field string

+ Read []string

+ Shape *FieldShape

+ type Judged struct

+ Holds bool

+ Sure float64

+ type Lineage struct

+ Edges []GraphEdge

+ Nodes []LineageNode

+ type LineageNode struct

+ ID string

+ Kind string

+ Name string

+ Role string

+ X float64

+ Y float64

+ type Measure struct

+ Of int

+ Right int

+ type OpenReason struct

+ Check string

+ Reason string

type Option

+ func WithSemanticExporters(xs ...semantic.Exporter) Option

+ type PortLayout struct

+ Drafts []Draft

+ Problems []string

+ Records []RecordFill

+ Registers []RegisterResult

+ Structure structure.Result

+ type PortRecord struct

+ Open []OpenReason

+ Record string

+ Set map[string]any

+ Unset []string

+ type PortRecordResult struct

+ Err error

+ Error string

+ Left []string

+ NotLeft []string

+ Record string

+ Refused []Problem

type Problem

+ Keyword string

+ type RecordFill struct

+ Fill []FillItem

+ Name string

+ Record string

+ type RegisterResult struct

+ Added int

+ Drafted int

+ Error string

+ Field string

+ Heading string

+ NotPorted []string

+ Refused []Problem

+ Rows int

+ Section string

+ type SectionText struct

+ Heading string

+ ID string

+ Text string

type Shared

+ func (s *Shared) RecordPresence(ctx context.Context, kind, id string) (string, error)

+ type Source struct

+ Sections []document.Section

+ Title string

type Task

+ Field string

v2.9.0

Oct 7, 2026

Changes in this version

+ const LinkGapGroup

+ const LinkGapOutcome

+ const LinkGoalContributes

+ const LinkGoalParent

+ const LinkKPIGap

+ const LinkProblemGap

+ const LinkProblemGroup

+ const LinkProgrammeComponent

+ const LinkProjectComponent

+ const LinkProjectOutcome

+ var ErrChangeSetRequired = errors.New(...)

+ var ErrTheirsToPropose = fmt.Errorf("%w: this change set is your person's, and they propose it themselves", ...)

+ var ErrUnknownLink = fmt.Errorf("unknown link")

+ var RelevantKinds = []string

+ func LeftFor(ctx context.Context, kind, id, check string) string

+ func Proposed(ctx context.Context, kind, id string) string

+ func SetOf(stored string) (set, kind string)

+ func WithHandoff(ctx context.Context, f HandoffFunc) context.Context

+ type AcceptResult struct

+ Deleted []Ref

+ Kept []Problem

+ Moved []Ref

+ Saved []Version

type Around

+ Via string

+ type ChangeControl struct

+ ChangeSetsRequired bool

+ RollIn RollInPolicy

type ChangeSetItem

+ Proposed string

type Check

+ Path string

+ type ComponentEdge struct

+ From Ref

+ Legacy bool

+ To Ref

+ Why string

+ type ComponentGraph struct

+ CriticalMonths int

+ CriticalPath []Ref

+ Edges []ComponentEdge

+ Loops [][]Ref

+ Nodes []ComponentNode

+ type ComponentNode struct

+ Critical bool

+ Dependents int

+ InLoop bool

+ Months int

+ MostDependedOn bool

+ Name string

+ type CyclePeriod struct

+ Due string

+ End string

+ Label string

+ Name string

+ Start string

+ type DecisionModel struct

+ Configured bool

+ Ready bool

type Engine

+ func (e *Engine) Components(ctx context.Context) (ComponentGraph, error)

+ func (e *Engine) CyclePeriods(ctx context.Context, id, from, to string) ([]CyclePeriod, error)

+ func (e *Engine) DecisionModel(ctx context.Context) DecisionModel

+ func (e *Engine) DirectWrite(ctx context.Context) error

+ func (e *Engine) DiscardChangeItem(ctx context.Context, set, kind, id string) error

+ func (e *Engine) DraftProblems(ctx context.Context, kind, id string) ([]Problem, error)

+ func (e *Engine) FromIdea(ctx context.Context, kind, idea string) ([]IdeaAnswer, bool)

+ func (e *Engine) HasAny(ctx context.Context, kind string) bool

+ func (e *Engine) LeaveOpen(ctx context.Context, set, kind, id, check, reason string, correct bool) error

+ func (e *Engine) LinkCandidates(ctx context.Context, link, from, problem string) ([]LinkCandidate, error)

+ func (e *Engine) MarkInChangeSet(ctx context.Context, set, kind, id, op, to string) error

+ func (e *Engine) MatchExisting(ctx context.Context, kind, level, text string) []Match

+ func (e *Engine) MayWorkInSet(ctx context.Context, set string) bool

+ func (e *Engine) OpenInChangeSet(ctx context.Context, id string) ([]OpenCheck, error)

+ func (e *Engine) OpenNow(ctx context.Context, set string) ([]OpenCheck, error)

+ func (e *Engine) PortfolioChecks(ctx context.Context, id string) ([]ProgrammeCheck, error)

+ func (e *Engine) Preview(ctx context.Context, set string) (context.Context, error)

+ func (e *Engine) Relevant(ctx context.Context, text string, kinds []string, level string, limit int) (Relevance, error)

+ func (e *Engine) Schedule(ctx context.Context, id string) ([]ScheduleItem, error)

+ func (e *Engine) SchemaDefs(kind string) (map[string]any, error)

+ func (e *Engine) Understand(ctx context.Context, text, locale string) (Understanding, error)

+ func (e *Engine) UnnamedInChangeSet(ctx context.Context, set string) ([]Ref, error)

+ func (e *Engine) WorksIn(ctx context.Context, cs store.ChangeSet) bool

type GoalCheckFix

+ Goal string

type GoalNode

+ Proposed string

type GoalTree

+ Unplaced []*GoalNode

type GraphNode

+ Proposed string

type GuideBundle

+ Cues map[string]string

+ FromIdea map[string]GuideIdeaQuestion

+ Judgements map[string]GuideJudgement

type GuideField

+ Format string

+ MaxLength int

+ Required bool

+ Shape string

+ Values []any

+ type GuideIdeaQuestion struct

+ Cue string

+ Field string

+ Question string

+ type GuideJudgement struct

+ Fail string

+ Good GuideOption

+ Levels []string

+ Opens []string

+ Pass string

+ Path string

+ Poor GuideOption

+ type GuideOption struct

+ Key string

+ Label string

+ type HandoffFunc func(ctx context.Context, projectID, actor, reason string) error

+ type IdeaAnswer struct

+ Field string

+ Key string

+ Likelihood float64

+ Question string

+ Sentence string

+ type LinkCandidate struct

+ Allowed bool

+ ID string

+ Kind string

+ Linked bool

+ Name string

+ Reason string

+ type Match struct

+ By string

+ Detail string

+ ID string

+ Kind string

+ Level string

+ Likelihood float64

+ Name string

type OpenCheck

+ Left string

type Option

+ func WithDecider(d decide.Decider) Option

type PlanItem

+ Missing bool

type Purpose

+ Logo string

+ Organisation string

type Refs

+ Uses []Use

+ type Relevance struct

+ Available bool

+ Matches []Match

+ type RollInPolicy struct

+ ChecksMet bool

+ NothingLeftOpen bool

+ SecondReviewer bool

+ type Route struct

+ Key string

+ Kind string

+ Level string

+ Likelihood float64

+ type ScheduleItem struct

+ Critical bool

+ Form string

+ ID string

+ Late bool

+ Month string

+ Name string

+ NotAfter string

+ NotBefore string

+ Pending bool

+ Unplaced bool

+ WaitsOn []string

type Settings

+ ChangeControl *ChangeControl

type Shared

+ func (s *Shared) DocumentInSet(ctx context.Context, set, kind, id string) (string, error)

+ func (s *Shared) MayWorkInSet(ctx context.Context, set string) bool

type Task

+ By string

+ type Understanding struct

+ Available bool

+ Matches []Match

+ Routes []Route

+ type Use struct

+ As string

+ ID string

+ Kind string

+ Name string

+ Path string

v2.8.0

Oct 4, 2026

v2.7.0

Oct 4, 2026

Changes in this version

+ var ErrBadEdit = errors.New("bad draft edit")

+ var ErrNoChangeSets = errors.New("this deployment's store keeps no change sets")

+ var ErrNoLayout = errors.New("no graph layout is configured")

+ var ErrNotOpen = fmt.Errorf("%w: the change set is not open", ErrConflict)

+ var ErrNotTheirChangeSet = fmt.Errorf("%w: this change set is not yours", identity.ErrForbidden)

+ func Registers() []string

+ type Around struct

+ Draft bool

+ ID string

+ Kind string

+ Link string

+ Name string

+ Open []Check

+ type ChangeSetItem struct

+ Changes []Change

+ Checks []Check

+ Item store.ChangeItem

+ Name string

+ Stale int

+ type ChangeSetView struct

+ ChangeSet store.ChangeSet

+ Items []ChangeSetItem

type Engine

+ func (e *Engine) AcceptChangeSet(ctx context.Context, id, reason string) ([]Version, error)

+ func (e *Engine) ChangeSetText(ctx context.Context, set, kind, id string) ([]byte, bool, error)

+ func (e *Engine) ChangeSets(ctx context.Context, status string, everyone bool) ([]store.ChangeSet, error)

+ func (e *Engine) CloseChangeSet(ctx context.Context, id, reason string) (store.ChangeSet, error)

+ func (e *Engine) CurrentChangeSet(ctx context.Context, id string) (store.ChangeSet, bool, error)

+ func (e *Engine) DropChangeItem(ctx context.Context, set, kind, id string) error

+ func (e *Engine) EditDraft(ctx context.Context, kind, id string, set map[string]any, unset []string, ...) ([]byte, error)

+ func (e *Engine) EditInChangeSet(ctx context.Context, set, kind, id string, put map[string]any, unset []string) ([]byte, error)

+ func (e *Engine) Glossary(locale string) ([]GlossaryEntry, error)

+ func (e *Engine) Graph(ctx context.Context, focus *Ref) (Graph, error)

+ func (e *Engine) InChangeSet(ctx context.Context, set string) (context.Context, error)

+ func (e *Engine) IncludeChangeItem(ctx context.Context, set, kind, id string, included bool) error

+ func (e *Engine) MergeInChangeSet(ctx context.Context, set, kind, id string, previous, next []byte) ([]byte, error)

+ func (e *Engine) Plan(ctx context.Context, kind, level, locale string) ([]PlanItem, error)

+ func (e *Engine) ProposeChangeSet(ctx context.Context, id, reason string, waive map[string]map[string]string) (store.ChangeSet, error)

+ func (e *Engine) ReopenChangeSet(ctx context.Context, id, reason string) (store.ChangeSet, error)

+ func (e *Engine) RetitleChangeSet(ctx context.Context, id, title, description string) (store.ChangeSet, error)

+ func (e *Engine) SaveInChangeSet(ctx context.Context, set, kind, id string, text []byte) error

+ func (e *Engine) StartChangeSet(ctx context.Context, title, description string) (store.ChangeSet, error)

+ func (e *Engine) Taxonomy(locale string) ([]TaxonomyEntry, error)

+ func (e *Engine) ViewChangeSet(ctx context.Context, id string) (ChangeSetView, error)

+ func (e *Engine) Work(ctx context.Context, work []Ref, locale string) (Worklist, error)

+ func (e *Engine) WorkAround(ctx context.Context, kind, id string, also []Ref) ([]Around, error)

+ func (e *Engine) WorkingChangeSet(ctx context.Context, id string) (store.ChangeSet, error)

+ func (e *Engine) WorkspaceOrder(ctx context.Context) (Order, error)

+ type GlossaryEntry struct

+ After []string

+ Example string

+ Key string

+ Kind string

+ Level string

+ Register bool

+ Summary string

+ type Graph struct

+ Edges []GraphEdge

+ Nodes []GraphNode

+ type GraphEdge struct

+ From Ref

+ To Ref

+ type GraphNode struct

+ Distance int

+ ID string

+ Kind string

+ Layer int

+ Level string

+ Name string

+ Stage string

+ X float64

+ Y float64

type Guide

+ Plan []PlanItem

type GuideBundle

+ Example string

+ KnownAs []string

+ LevelExamples map[string]string

+ Summary string

+ Terms map[string]GuideTerm

+ type GuideTerm struct

+ Example string

+ Summary string

type KindInfo

+ Summary string

type Option

+ func WithLayout(l layout.Layout) Option

+ type Order struct

+ Next string

+ Registers []KindInfo

+ Stages []StageState

+ type PlanItem struct

+ Ask string

+ Check string

+ Existing []Candidate

+ For string

+ IfNone string

+ Kind string

+ Level string

+ Link string

+ When string

type Shared

+ func (s *Shared) Update(ctx context.Context, kind, id string, fn func(map[string]any) error, ...) (map[string]any, error)

+ type Stage struct

+ After []string

+ Key string

+ Kind string

+ Level string

+ Optional bool

+ func Stages() []Stage

+ type StageState struct

+ Count int

+ State string

+ Waiting []string

+ type Task struct

+ Check string

+ Choices []Candidate

+ Do string

+ ID string

+ Kind string

+ Message string

+ Name string

+ Phase string

+ State string

+ Step string

+ type TaxonomyEntry struct

+ Example string

+ Kind string

+ KnownAs []string

+ Levels map[string]string

+ Names []string

+ Register bool

+ Summary string

+ type Worklist struct

+ Open map[string]int

+ Tasks []Task

v2.6.0

Oct 2, 2026

Changes in this version

+ const DefaultLocale

+ func AgentFeedOwner(kind, id string) (person string, ok bool)

+ type Candidate struct

+ Detail string

+ ID string

+ Name string

+ Under string

+ type Check struct

+ ID string

+ Message string

+ Section string

+ State string

+ func (c Check) Open() bool

type Engine

+ func (e *Engine) AgentFeed(ctx context.Context, person string) (string, error)

+ func (e *Engine) ChangedFields(before, after []byte, limit int) []string

+ func (e *Engine) ChecksOf(ctx context.Context, kind, id string, text []byte) ([]Check, error)

+ func (e *Engine) DraftChecks(ctx context.Context, kind, id string) ([]Check, error)

+ func (e *Engine) Guide(ctx context.Context, kind, level, locale string) (Guide, error)

+ func (e *Engine) MayFollow(ctx context.Context, person string) bool

+ func (e *Engine) ProposeSet(ctx context.Context, members []SetMember, reason string, ...) ([]store.Proposal, error)

+ func (e *Engine) ViewProposal(ctx context.Context, id string) (ProposalView, error)

+ type Guide struct

+ Checks map[string]string

+ Definition string

+ Existing []Candidate

+ Kind string

+ Level string

+ LevelIs string

+ Levels map[string]string

+ Locale string

+ Purpose *Purpose

+ Steps []GuideStep

+ Template map[string]any

+ Vocabulary map[string][]string

+ type GuideBundle struct

+ Checks map[string]string

+ Definition string

+ Fields map[string]GuideFieldWords

+ Kind string

+ Levels map[string]string

+ Links map[string]GuideLinkWords

+ Locale string

+ Steps map[string]GuideStepWords

+ Vocabulary map[string][]string

+ func GuideBundleFor(kind, locale string) (GuideBundle, bool, error)

+ type GuideField struct

+ Candidates []Candidate

+ Checks []string

+ Control string

+ Good []string

+ Guide string

+ Path string

+ Poor []GuidePoor

+ References string

+ type GuideFieldWords struct

+ Good []string

+ Guide string

+ Levels map[string]GuideFieldWords

+ Poor []GuidePoor

+ type GuideLink struct

+ Ask string

+ Candidates []Candidate

+ Check string

+ IfNone string

+ Kind string

+ Path string

+ type GuideLinkWords struct

+ Ask string

+ IfNone string

+ type GuidePoor struct

+ Text string

+ Why string

+ type GuideStep struct

+ Fields []GuideField

+ Guide string

+ Key string

+ Links []GuideLink

+ Title string

+ type GuideStepWords struct

+ Guide string

+ Title string

+ type OpenCheck struct

+ Kind string

+ ManifestID string

+ type OpenChecksError struct

+ Open []OpenCheck

+ func (e *OpenChecksError) Error() string

+ type ProposalPart struct

+ Changes []Change

+ Checks []Check

+ Proposal store.Proposal

+ type ProposalView struct

+ Parts []ProposalPart

+ Proposal store.Proposal

+ type SetMember struct

+ ID string

+ Kind string

+ Text []byte

type Shared

+ func (s *Shared) AgentFeed(ctx context.Context, person string) (string, error)

v2.5.0

Oct 2, 2026

Changes in this version

+ var ErrAgentGrantEnded = errors.New("the agent grant has ended")

+ var ErrAgentGrantReused = errors.New("the agent grant was used twice and is revoked")

+ var ErrAgentGrantsOff = fmt.Errorf("%w: agent grants need an access list (CARTOGRAPH_AUTHZ=access)", ErrConflict)

+ var ErrNoProposals = fmt.Errorf("%w: this store keeps no proposals", ErrNotFound)

+ var ErrNotAnAgent = errors.New("an agent proposes; a person saves")

+ var ErrNotTheirs = fmt.Errorf("%w: only the person an agent acts for decides its proposals", ...)

+ var ErrProposalStale = errors.New("the manifest has changed since this was proposed")

type Directory

+ Agents []string

type Engine

+ func (e *Engine) AcceptProposal(ctx context.Context, id, actor, reason string, handoff Handoff) (store.Proposal, error)

+ func (e *Engine) AdvanceAgentGrant(ctx context.Context, id string, gen int) (int, error)

+ func (e *Engine) AgentGrantPrincipal(ctx context.Context, id string) (identity.Principal, store.AgentGrant, error)

+ func (e *Engine) AgentGrants(ctx context.Context, email string) ([]store.AgentGrant, error)

+ func (e *Engine) DeclineProposal(ctx context.Context, id, actor, reason string) (store.Proposal, error)

+ func (e *Engine) GrantAgent(ctx context.Context, label string, ttl time.Duration) (store.AgentGrant, error)

+ func (e *Engine) Proposals(ctx context.Context, f store.ProposalFilter) ([]store.Proposal, error)

+ func (e *Engine) ProposeAppend(ctx context.Context, kind, id, series string, item map[string]any, ...) (store.Proposal, error)

+ func (e *Engine) ProposeSave(ctx context.Context, kind, id string, text []byte, reason string) (store.Proposal, error)

+ func (e *Engine) ProposeState(ctx context.Context, id, to, reason string) (store.Proposal, error)

+ func (e *Engine) RevokeAgentGrant(ctx context.Context, id string) error

+ type Handoff func(ctx context.Context, projectID, reason string) (int, error)

v2.4.0

Oct 2, 2026

v2.3.0

Oct 2, 2026

Changes in this version

+ var ErrNoSeries = errors.New("no such series")

type Engine

+ func (e *Engine) AppendSeriesItem(ctx context.Context, kind, id, series string, item map[string]any, ...) (Version, error)

+ func (e *Engine) CurrentOfKind(ctx context.Context, kind string) ([]Version, error)

+ func (e *Engine) Events(ctx context.Context, after int64, limit int) ([]store.Event, error)

+ func (e *Engine) GetMany(ctx context.Context, kind string, ids []string) ([]Version, error)

+ func (e *Engine) ListPage(ctx context.Context, kind string, f Filter, afterID string, limit int) ([]Summary, bool, error)

+ func (e *Engine) ProjectStates(ctx context.Context, ids []string) (map[string]string, error)

+ func (e *Engine) ReconcileSeries(ctx context.Context, ids map[string][]string) (int, error)

+ func (e *Engine) ReferencingKind(ctx context.Context, kind string) (map[string][]Summary, error)

+ func (e *Engine) RepairDocs(ctx context.Context) (int, error)

+ func (e *Engine) SeriesAsOf(ctx context.Context, kind, series string, ids []string, at time.Time) (map[string][]store.SeriesItem, error)

+ func (e *Engine) SeriesKinds() []string

v2.2.1

Oct 2, 2026

v2.2.0

Oct 2, 2026

Changes in this version

+ var ErrSelf = errors.New("you may not remove your own access")

+ type Directory struct

+ Roles map[string][]string

+ Teams []DirectoryTeam

+ type DirectoryTeam struct

+ Group string

+ Name string

+ Parent string

type Engine

+ func (e *Engine) ApplyDirectory(ctx context.Context, actor string) ([]string, error)

+ func (e *Engine) GrantPerson(ctx context.Context, email string, roles, teams []string, actor string) (store.Person, error)

+ func (e *Engine) Grants(ctx context.Context, p identity.Principal) (identity.Grants, error)

+ func (e *Engine) KeepsAccess() bool

+ func (e *Engine) People(ctx context.Context) ([]store.Person, error)

+ func (e *Engine) RemovePerson(ctx context.Context, email string) error

+ func (e *Engine) TeamName(ctx context.Context, id string) string

+ func (e *Engine) TeamsBeneath(ctx context.Context, teams []string) ([]string, error)

type Option

+ func WithAccess(s store.AccessStore, d Directory) Option

+ func WithAuthorizer(z identity.Authorizer) Option

v2.1.0

Oct 1, 2026

Changes in this version

type Option

+ func WithDocCache(n int) Option

type Shared

+ func (s *Shared) Stats() SharedStats

+ type SharedStats struct

+ Cached int

+ Compactions int64

+ StoreErrors int64

+ Stored int64

v2.0.0

Oct 1, 2026

Changes in this version

+ const ProjectStateCancelled

+ const ProjectStateDefined

+ const ProjectStateDraft

+ const ProjectStateHandedOff

+ var ErrConflict = errors.New("conflict")

+ var ErrNoShared = errors.New("engine: shared drafts are not configured")

+ var ErrNoState = errors.New("this store has no state manifest")

+ var ErrNotFound = errors.New("not found")

+ var ErrReadOnly = errors.New("engine: the principal may not change this document")

+ var ErrUnknownKind = errors.New("unknown kind")

+ func DocTopic(docID string) string

+ func EphemeralTopic(docID string) string

+ func IsPresence(kind, id string) bool

+ func NewDocumentID() string

+ func RefIsSet(v any) bool

+ func RefLabel(v any, spec map[string]any) string

+ func StandardUnitIDs() []string

+ type Bus interface

+ Publish func(ev Event)

+ Subscribe func(ctx context.Context, kind, id string) *Subscription

+ type Change struct

+ From any

+ Op string

+ Path string

+ To any

+ type Changed struct

+ Replica string

+ Seq int64

+ type DependencyEdge struct

+ FromID string

+ FromKind string

+ FromName string

+ NeedBy string

+ ToID string

+ ToKind string

+ ToName string

+ Why string

+ type Engine struct

+ func New(manifests store.ManifestStore, ops store.OperationalStore, opts ...Option) (*Engine, error)

+ func (e *Engine) Apply(ctx context.Context, refs []string) (State, error)

+ func (e *Engine) Bus() Bus

+ func (e *Engine) Codec() codec.Codec

+ func (e *Engine) Commit(ctx context.Context, kind, id string, yamlBytes []byte, actor, reason string) (Version, error)

+ func (e *Engine) CommitProject(ctx context.Context, id string, yamlBytes []byte, actor, reason string) (Version, error)

+ func (e *Engine) Delete(ctx context.Context, kind, id, actor, reason string) error

+ func (e *Engine) DeleteGoal(ctx context.Context, id, actor, reason string) error

+ func (e *Engine) DependencyCycles(ctx context.Context) ([][]string, error)

+ func (e *Engine) DependencyGraph(ctx context.Context) ([]DependencyEdge, error)

+ func (e *Engine) DependencyScheduleConflicts(ctx context.Context) ([]ScheduleConflict, error)

+ func (e *Engine) Diff(ctx context.Context, kind, id string, from, to int) ([]Change, error)

+ func (e *Engine) DiscardWorking(ctx context.Context, kind, id string) error

+ func (e *Engine) ExportDir(ctx context.Context, dir string) error

+ func (e *Engine) ExportDirAs(ctx context.Context, dir string, target codec.Codec) error

+ func (e *Engine) FlowJSON(kind string) ([]byte, bool, error)

+ func (e *Engine) FlowKinds() []string

+ func (e *Engine) GapChecks(ctx context.Context, id string) ([]ProgrammeCheck, error)

+ func (e *Engine) GapCoverageFor(ctx context.Context, id string) (GapCoverage, error)

+ func (e *Engine) Get(ctx context.Context, kind, id string) (Version, error)

+ func (e *Engine) GetProjectState(ctx context.Context, id string) (ProjectState, error)

+ func (e *Engine) GetSettings(ctx context.Context) (Settings, error)

+ func (e *Engine) GetState(ctx context.Context) (State, error)

+ func (e *Engine) GetVersion(ctx context.Context, kind, id string, number int) (Version, error)

+ func (e *Engine) GetWorking(ctx context.Context, kind, id string) ([]byte, bool, error)

+ func (e *Engine) GoalChecks(ctx context.Context, id string) ([]GoalCheck, error)

+ func (e *Engine) GoalTree(ctx context.Context) (GoalTree, error)

+ func (e *Engine) Handoff(ctx context.Context, projectID, actor string, req HandoffRequest) (HandoffResult, error)

+ func (e *Engine) HandoffGate(ctx context.Context, projectID string) (snapshot int, err error)

+ func (e *Engine) HasState() bool

+ func (e *Engine) ImportDir(ctx context.Context, dir, actor, reason string) (Report, error)

+ func (e *Engine) Kinds() []KindInfo

+ func (e *Engine) List(ctx context.Context, kind string, f Filter, includeDrafts bool) ([]Summary, error)

+ func (e *Engine) ListAllVersions(ctx context.Context, limit int, cursor string) ([]store.Version, string, error)

+ func (e *Engine) ListExcluded(ctx context.Context) ([]store.Exclusion, error)

+ func (e *Engine) ListUnapplied(ctx context.Context) ([]UnappliedRef, error)

+ func (e *Engine) OperationChecks(ctx context.Context, id string) ([]ProgrammeCheck, error)

+ func (e *Engine) ProgrammeChecks(ctx context.Context, id string) ([]ProgrammeCheck, error)

+ func (e *Engine) ProjectChecks(ctx context.Context, id string, draft bool) (ProjectChecks, error)

+ func (e *Engine) PutWorking(ctx context.Context, kind, id string, yamlBytes []byte) error

+ func (e *Engine) Recover(ctx context.Context, ref, actor, reason string) (State, error)

+ func (e *Engine) References(ctx context.Context, kind, id string) (Refs, error)

+ func (e *Engine) Reindex(ctx context.Context) error

+ func (e *Engine) SaveWorking(ctx context.Context, kind, id string, text []byte, actor string) error

+ func (e *Engine) Schema(kind string) (map[string]any, error)

+ func (e *Engine) SchemaJSON(kind string) ([]byte, error)

+ func (e *Engine) SeedStandardUnits(ctx context.Context) ([]string, error)

+ func (e *Engine) Shape(kind string) crdt.Shape

+ func (e *Engine) Shared() *Shared

+ func (e *Engine) Snapshot(ctx context.Context, kind, id string, yamlBytes []byte, ...) (Version, error)

+ func (e *Engine) TransitionProjectState(ctx context.Context, id, to, actor, reason string) (ProjectState, error)

+ func (e *Engine) Validate(ctx context.Context, kind string, yamlBytes []byte) ([]Problem, error)

+ func (e *Engine) Versions(ctx context.Context, kind, id string) ([]Version, error)

+ type Event struct

+ Actor string

+ Field string

+ ID string

+ Kind string

+ On time.Time

+ Seq int64

+ Type string

+ type FileProblems struct

+ File string

+ Problems []Problem

+ type Filter struct

+ Q string

+ Refs []Ref

+ type GapClaim struct

+ ID string

+ Kind string

+ Name string

+ Segments []string

+ Whole bool

+ type GapCoverage struct

+ Gap string

+ Segments []GapSegmentCoverage

+ Whole []GapClaim

+ type GapSegmentCoverage struct

+ Addressed []GapClaim

+ Name string

+ Segment string

+ type GoalAligned struct

+ KPIs int

+ Operations int

+ Programmes int

+ Projects int

+ type GoalCheck struct

+ Fix *GoalCheckFix

+ ID string

+ Message string

+ State string

+ type GoalCheckFix struct

+ Section string

+ type GoalGap struct

+ Current string

+ Desired string

+ ID string

+ Name string

+ type GoalLink struct

+ Because string

+ Goal string

+ type GoalNode struct

+ Aligned GoalAligned

+ Children []*GoalNode

+ ContributesTo []GoalLink

+ Gaps []GoalGap

+ Horizon *Horizon

+ ID string

+ KeyResults int

+ Level string

+ Name string

+ Objective string

+ Owner string

+ Parent string

+ Smart Smart

+ Why string

+ type GoalTree struct

+ Levels []string

+ Nodes []*GoalNode

+ type HandoffRequest struct

+ HtmlBytes []byte

+ JsonBytes []byte

+ PdfBytes []byte

+ type HandoffResult struct

+ Bundle string

+ HtmlPath string

+ JsonPath string

+ PdfPath string

+ type Horizon struct

+ End string

+ Inherited bool

+ Start string

+ type ImportedItem struct

+ ID string

+ Kind string

+ Version int

+ type KindInfo struct

+ Count int

+ Kind string

+ type MemoryBus struct

+ func NewMemoryBus() *MemoryBus

+ func (b *MemoryBus) Publish(ev Event)

+ func (b *MemoryBus) Subscribe(ctx context.Context, kind, id string) *Subscription

+ type Option func(*Engine)

+ func WithBundles(b store.BundleStore) Option

+ func WithBus(b Bus) Option

+ func WithCRDT(c crdt.Engine) Option

+ func WithCodec(c codec.Codec) Option

+ func WithDocStore(d store.DocStore) Option

+ func WithFanout(f fanout.Bus) Option

+ func WithState(s store.StateStore) Option

+ type Problem struct

+ Message string

+ Path string

+ type ProgrammeCheck struct

+ ID string

+ Message string

+ Section string

+ State string

+ type ProjectCheckFix struct

+ Phase string

+ Section string

+ type ProjectCheckItem struct

+ Fix ProjectCheckFix

+ ID string

+ Message string

+ Phase string

+ Section string

+ State string

+ type ProjectChecks struct

+ Blocking int

+ DerivedEnd string

+ Items []ProjectCheckItem

+ type ProjectState struct

+ History []ProjectStateEntry

+ State string

+ type ProjectStateEntry struct

+ Actor string

+ Bundle string

+ On time.Time

+ Reason string

+ Snapshot int

+ State string

+ type Purpose struct

+ Mission string

+ Source string

+ Vision string

+ type Ref struct

+ ID string

+ Kind string

+ Path string

+ type Refs struct

+ Incoming []Summary

+ Outgoing []Ref

+ type Report struct

+ Imported []ImportedItem

+ Notes []FileProblems

+ Problems []FileProblems

+ type ScheduleConflict struct

+ Edge DependencyEdge

+ NeedByOn string

+ ReadyOn string

+ type Settings struct

+ Chromium string

+ Examples map[string][]string

+ GoalLevels []string

+ Operator string

+ ProjectLevelName string

+ Purpose *Purpose

+ type Shared struct

+ func (s *Shared) Conflicts(ctx context.Context, kind, id string) ([]crdt.Conflict, error)

+ func (s *Shared) DocumentFor(ctx context.Context, kind, id string) (string, error)

+ func (s *Shared) Forget(docID string)

+ func (s *Shared) Generate(ctx context.Context, docID string, peer crdt.SyncState) ([]byte, bool, error)

+ func (s *Shared) ManifestFor(ctx context.Context, docID string) (kind, id string, err error)

+ func (s *Shared) NewSyncState() (crdt.SyncState, error)

+ func (s *Shared) PresenceDocument(ctx context.Context) (string, error)

+ func (s *Shared) Receive(ctx context.Context, docID string, peer crdt.SyncState, msg []byte, ...) (changed bool, err error)

+ func (s *Shared) Reconcile(ctx context.Context, kind, id string, content map[string]any, message string) error

+ func (s *Shared) Replica() string

+ type Smart struct

+ Attainable bool

+ Measurable bool

+ Relevant bool

+ Specific bool

+ TimeBound bool

+ type State struct

+ Included []string

+ Name string

+ type Subscription struct

+ C <-chan Event

+ func (s *Subscription) Close()

+ type Summary = store.Summary

+ type UnappliedRef = store.UnappliedRef

+ type ValidationError struct

+ Problems []Problem

+ func (e *ValidationError) Error() string

+ type Version = store.Version

Other modules containing this package

github.com/ProjectCartograph/cartograph-engine

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL