app

type AddOutput ¶ added in v0.5.2

type AddOutput struct {
	EntityID string `json:"entity_id"`
	Path     string `json:"path"`
}

AddOutput is the `add` command's JSON output shape for a newly created entity.

func ToAddOutput(result EntityResult) AddOutput

type App ¶

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

App is the top-level application handle. Create one per process via New and share it across all callers.

func New(s *store.Store) *App

func (a *App) ChangeStatus(ctx context.Context, req ChangeStatusRequest) error

func (a *App) CheckProjectionConsistency(ctx context.Context) ([]DoctorIssue, error)

func (a *App) ClearAllData(ctx context.Context) error

func (a *App) CreateEntity(ctx context.Context, req CreateEntityRequest) (EntityResult, error)

func (a *App) FindEntities(ctx context.Context, req FindEntitiesRequest) ([]FindResult, error)

func (a *App) GetAllEvents(ctx context.Context) ([]ExportResult, error)

func (a *App) GetChildren(ctx context.Context, parentID string) ([]EntityResult, error)

func (a *App) GetEntityByID(ctx context.Context, entityID string) (EntityResult, error)

func (a *App) GetEntityByPath(ctx context.Context, path string) (EntityResult, error)

func (a *App) GetHistory(ctx context.Context, req GetHistoryRequest) ([]HistoryResult, error)

func (a *App) HasEvents(ctx context.Context) (bool, error)

func (a *App) ImportEvents(ctx context.Context, events []ExportResult, opts ImportOptions) (ImportResult, error)

func (a *App) ListEntities(ctx context.Context) ([]EntityResult, error)

func (a *App) ListTags(ctx context.Context, req ListTagsRequest) ([]string, error)

func (a *App) RemoveEntity(ctx context.Context, req RemoveEntityRequest) error

func (a *App) RenameEntity(ctx context.Context, req RenameEntityRequest) (EntityResult, error)

func (a *App) ReparentEntity(ctx context.Context, req ReparentEntityRequest) (EntityResult, error)

func (a *App) RunDoctorChecks(ctx context.Context) ([]DoctorIssue, error)

func (a *App) TagEntity(ctx context.Context, req TagEntityRequest) error

func (a *App) TruncateAndReplay(ctx context.Context) (int, error)

func (a *App) ValidateEventLog(ctx context.Context) ([]DoctorIssue, error)

type ChangeStatusRequest ¶

type ChangeStatusRequest struct {
	EntityPath    string
	Status        inventory.EntityStatus
	StatusContext string
	ActorID       string
	Note          string
}

ChangeStatusRequest is the input for changing an entity's status.

type CreateEntityRequest ¶

type CreateEntityRequest struct {
	DisplayName string
	EntityType  inventory.EntityType
	// ParentPath is a colon-separated path, e.g. "Garage:Toolbox". Empty means root-level.
	ParentPath string
	ActorID    string
	Note       string
}

CreateEntityRequest is the input for creating a new entity.

type DoctorIssue ¶ added in v0.5.0

type DoctorIssue struct {
	Kind        DoctorKind
	EventID     *int64
	Description string
}

DoctorIssue describes a single structural problem found during a doctor validation.

type DoctorKind ¶ added in v0.5.0

type DoctorKind int

DoctorKind classifies which layer a DoctorIssue belongs to.

const (
	DoctorKindConfig     DoctorKind = iota + 1 // config
	DoctorKindEventLog                         // event_log
	DoctorKindProjection                       // projection
)

func (i DoctorKind) String() string

type EntityResult ¶

type EntityResult struct {
	EntityID        string
	DisplayName     string
	CanonicalName   string
	EntityType      inventory.EntityType
	FullPathDisplay string
	Status          inventory.EntityStatus
	StatusContext   string
	HasChildren     bool
	Tags            []string
}

EntityResult is the output representation of an entity.

type ExportResult ¶ added in v0.4.0

type ExportResult struct {
	EventID      int64           `json:"event_id"`
	EventType    string          `json:"event_type"`
	TimestampUTC string          `json:"timestamp_utc"`
	ActorUserID  string          `json:"actor_user_id"`
	EntityID     *string         `json:"entity_id,omitempty"`
	Payload      json.RawMessage `json:"payload"`
	Note         *string         `json:"note,omitempty"`
}

ExportResult is the app-layer representation of a single event for export.

type FindEntitiesRequest ¶

type FindEntitiesRequest struct {
	Query string
	Limit int
}

FindEntitiesRequest is the input for searching entities by name.

type FindResult ¶

type FindResult struct {
	Entity   EntityResult
	Distance int
}

FindResult pairs an EntityResult with its fuzzy-match distance.

type GetHistoryRequest ¶

type GetHistoryRequest struct {
	EntityPath  string
	EntityID    string
	Limit       int
	OldestFirst bool
}

GetHistoryRequest is the input for retrieving an entity's event history.

type HistoryItem ¶ added in v0.5.2

type HistoryItem struct {
	EventID   int64               `json:"event_id"`
	EventType inventory.EventType `json:"event_type"`
	Timestamp string              `json:"timestamp"`
	ActorUser string              `json:"actor_user"`
}

HistoryItem is the `history` command's JSON output shape: one row per event. Payload and Note from HistoryResult are intentionally omitted.

func ToHistoryItems(results []HistoryResult) []HistoryItem

type HistoryResult ¶

type HistoryResult struct {
	EventID      int64
	EventType    inventory.EventType
	TimestampUTC string
	ActorUserID  string
	Payload      []byte
	Note         string
}

HistoryResult is the output representation of a single history event.

type ImportOptions ¶ added in v0.4.0

type ImportOptions struct {
	Replace  bool // clear all data before replay (caller must have confirmed)
	Continue bool // accumulate per-event errors instead of aborting
}

ImportOptions controls the behaviour of ImportEvents.

type ImportResult ¶ added in v0.4.0

type ImportResult struct {
	Replayed     int
	Failed       int
	WarningCount int
	Warnings     []error
	Errors       []error
}

ImportResult summarises the outcome of an import run.

WarningCount is the number of non-fatal anomalies detected during replay (e.g. orphaned EntityPathChangedEvent records, mismatched path-changed payloads). Warnings holds one descriptive error per increment, in detection order, so callers can render diagnostics rather than only a count. len(Warnings) == WarningCount as an invariant.

type ListItem ¶ added in v0.5.2

type ListItem struct {
	EntityID string                 `json:"entity_id"`
	Path     string                 `json:"path"`
	Type     inventory.EntityType   `json:"type"`
	Status   inventory.EntityStatus `json:"status"`
}

ListItem is the `list` command's JSON output shape: one row per entity.

func ToListItems(results []EntityResult) []ListItem

type ListTagsRequest ¶ added in v0.6.0

type ListTagsRequest struct {
	EntityPath string
}

ListTagsRequest is the input for listing tags on an entity.

type MoveOutput ¶ added in v0.5.2

type MoveOutput struct {
	EntityID    string `json:"entity_id"`
	DisplayName string `json:"display_name"`
	Path        string `json:"path"`
}

MoveOutput is the `move` command's JSON output shape. It reports the entity's current location only; the prior location is recorded by the move event and surfaced via the history command (ADR 0014).

func ToMoveOutput(result EntityResult) MoveOutput

type RemoveEntityRequest ¶

type RemoveEntityRequest struct {
	EntityPath string
	ActorID    string
	Note       string
}

RemoveEntityRequest is the input for removing an entity.

type RenameEntityRequest ¶

type RenameEntityRequest struct {
	EntityPath string
	NewName    string
	ActorID    string
	Note       string
}

RenameEntityRequest is the input for renaming an entity.

type ReparentEntityRequest ¶

type ReparentEntityRequest struct {
	EntityPath    string
	NewParentPath string // empty means make root-level
	ActorID       string
	Note          string
}

ReparentEntityRequest is the input for moving an entity to a new parent.

type ScryItem ¶ added in v0.5.2

type ScryItem struct {
	EntityID string                 `json:"entity_id"`
	Path     string                 `json:"path"`
	Type     inventory.EntityType   `json:"type"`
	Status   inventory.EntityStatus `json:"status"`
	Distance *int                   `json:"distance"`
}

ScryItem is the `scry` command's JSON output shape. It currently coincides with ListItem, but is kept separate because scry is expected to gain a match Distance field (see issue #216) that list does not have.

func ToScryItems(results []FindResult, searched bool) []ScryItem

type StatusOutput ¶ added in v0.5.2

type StatusOutput struct {
	Path          string                 `json:"path"`
	Status        inventory.EntityStatus `json:"status"`
	StatusContext *string                `json:"status_context,omitempty"`
}

StatusOutput is the `status` command's JSON output shape. Because ChangeStatus returns no result, this is projected from the command's inputs rather than an EntityResult (see issue #214). StatusContext is omitted when there is no note.

func ToStatusOutput(path string, status inventory.EntityStatus, note string) StatusOutput

type TagEntityRequest ¶ added in v0.6.0

type TagEntityRequest struct {
	EntityPath string
	ActorID    string
	Add        []string
	Remove     []string
	Note       string
}

TagEntityRequest is the input for adding/removing tags on an entity.

type TagOutput ¶ added in v0.6.0

type TagOutput struct {
	Path string   `json:"path"`
	Tags []string `json:"tags"`
}

TagOutput is the --json output shape for the tag command.

func ToTagOutput(path string, tags []string) TagOutput