homegraph

type AdoptionPlan struct {
	Graph    Graph
	Snapshot HASnapshot
	Mapping  Mapping
	FirstRun bool
	// Leading is the leading system the person chose; it starts as the
	// graph's setting (kombify by default) and decides every conflict without
	// an explicit decision.
	Leading string

	Matched     []Match
	OnlyKombify []Only
	OnlyHA      []Only
	Conflicts   []Conflict
}

type AreaUpdate struct {
	Name       *string
	FloorID    *string
	ClearFloor bool
	Labels     []string
	SetLabels  bool
}

type Assignment struct {
	ID             string `json:"id"`
	Kind           string `json:"kind"`
	DeviceID       string `json:"device_id"`
	Subject        string `json:"subject,omitempty"`
	TargetDeviceID string `json:"target_device_id,omitempty"`
}

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

type Conflict struct {
	ID        string
	Kind      ConflictKind
	Subject   string // floor, room, device
	KombifyID string
	HAID      string
	Name      string
	// Kombify and HA are the contradicting values as the person reads them
	// (floor name, room name, or the object's name for the other kinds).
	Kombify string
	HA      string
	// Candidates are the Home Assistant ids a name_collision is ambiguous
	// between.
	Candidates []string
	// DeletedOn is the side that no longer has the object
	// (deleted_on_one_side only).
	DeletedOn Side
}

type ConflictKind string

type Device struct {
	ID           string        `json:"id"`
	Name         string        `json:"name"`
	Class        string        `json:"class"`
	Roles        []string      `json:"roles"`
	RoomID       *string       `json:"room_id"`
	Identity     Identity      `json:"identity"`
	ExternalRefs []ExternalRef `json:"external_refs"`
	Status       string        `json:"status"`
}

type Drift struct {
	Kind      string // floor, area, device
	Field     string // name, level, floor, area, deleted, name_collision
	KombifyID string
	HAID      string
	Graph     string
	HA        string
}

type ExternalRef struct {
	System string `json:"system"`
	Ref    string `json:"ref"`
}

type Floor struct {
	ID           string        `json:"id"`
	Name         string        `json:"name"`
	Level        int           `json:"level"`
	ExternalRefs []ExternalRef `json:"external_refs"`
}

type Graph struct {
	Schema        string       `json:"schema"`
	SpaceID       string       `json:"space_id"`
	Revision      int64        `json:"revision"`
	LeadingSystem string       `json:"leading_system"`
	MirrorClasses []string     `json:"mirror_classes"`
	Floors        []Floor      `json:"floors"`
	Rooms         []Room       `json:"rooms"`
	Devices       []Device     `json:"devices"`
	Assignments   []Assignment `json:"assignments"`
}

type HAArea struct {
	AreaID  string   `json:"area_id"`
	Name    string   `json:"name"`
	FloorID *string  `json:"floor_id"`
	Labels  []string `json:"labels"`
	Aliases []string `json:"aliases"`
}

type HADevice struct {
	ID           string   `json:"id"`
	Name         *string  `json:"name"`
	NameByUser   *string  `json:"name_by_user"`
	AreaID       *string  `json:"area_id"`
	Labels       []string `json:"labels"`
	Manufacturer *string  `json:"manufacturer"`
	Model        *string  `json:"model"`
}

type HAFloor struct {
	FloorID string   `json:"floor_id"`
	Name    string   `json:"name"`
	Level   *int     `json:"level"`
	Aliases []string `json:"aliases"`
	Icon    *string  `json:"icon"`
}

type HALabel struct {
	LabelID string `json:"label_id"`
	Name    string `json:"name"`
}

type HASnapshot struct {
	Floors  []HAFloor
	Areas   []HAArea
	Labels  []HALabel
	Devices []HADevice
}

type Identity struct {
	Kind string `json:"kind"`
	Ref  string `json:"ref"`
}

type InventoryArea struct {
	HAID      string `json:"haId"`
	Name      string `json:"name"`
	FloorHAID string `json:"floorHaId,omitempty"`
}

type InventoryFloor struct {
	HAID  string `json:"haId"`
	Name  string `json:"name"`
	Level *int   `json:"level"`
}

type LoxoneDevice struct {
	Name     string
	Class    string
	Roles    []string
	Ref      string // Loxone control uuid
	RoomRef  string // Loxone room uuid, empty when the control has none
	Type     string // Loxone control type
	Category string // Loxone category name
}

type LoxoneImport struct {
	Rooms   []LoxoneRoom
	Devices []LoxoneDevice
}

type LoxoneRoom struct {
	Name string
	Ref  string // Loxone room uuid
}

type Mapping struct {
	Schema string `json:"schema"`
	// LabelID is the Home Assistant id of the label "kombify".
	LabelID string `json:"label_id,omitempty"`
	// Floors, Areas and Devices map a kombify floor, room and device id to the
	// Home Assistant floor_id, area_id and device registry id.
	Floors  map[string]string `json:"floors"`
	Areas   map[string]string `json:"areas"`
	Devices map[string]string `json:"devices"`
	// Created lists the Home Assistant objects kombify created itself
	// ("floor:<id>", "area:<id>"). Only these may ever be removed, and only with
	// the person's confirmation.
	Created map[string]bool `json:"created"`
	// Synced holds the value each synchronized field had after the last
	// successful write or comparison; it tells a change made in kombify from a
	// change made in Home Assistant.
	Synced map[string]string `json:"synced"`
}

type MappingStore struct{ Path string }

type Match struct {
	Kind      string // floor, room, device
	KombifyID string
	HAID      string
	Name      string
}

type Only struct {
	Kind string
	ID   string
	Name string
}

type Op struct {
	Kind      OpKind
	KombifyID string
	// HAID is the Home Assistant object the op changes, empty for creates.
	HAID string
	Name string
	// Level is the floor level of a floor op.
	Level int
	// ParentKombifyID is the floor of an area op ("" for none) or the room of
	// a device op.
	ParentKombifyID string
	// Fields lists the changed fields of an update op: name, level, floor.
	Fields []string
}

type OpKind string

type Plan struct {
	Ops   []Op
	Drift []Drift
	// Mapping is the mapping the plan starts from, with links found while
	// planning. ApplyPlan starts from it.
	Mapping Mapping
}

type Registry interface {
	Snapshot(ctx context.Context) (HASnapshot, error)
	CreateFloor(ctx context.Context, name string, level int) (HAFloor, error)
	UpdateFloor(ctx context.Context, id string, name *string, level *int) error
	CreateArea(ctx context.Context, name string, floorID *string, labels []string) (HAArea, error)
	UpdateArea(ctx context.Context, id string, set AreaUpdate) error
	CreateLabel(ctx context.Context, name string) (HALabel, error)
	SetDeviceArea(ctx context.Context, deviceID, areaID string) error
}

type Restore struct {
	Kind      string `json:"kind"`
	KombifyID string `json:"kombifyId"`
	Field     string `json:"field"`
}

type Room struct {
	ID           string        `json:"id"`
	Name         string        `json:"name"`
	FloorID      *string       `json:"floor_id"`
	Icon         string        `json:"icon,omitempty"`
	Aliases      []string      `json:"aliases"`
	ExternalRefs []ExternalRef `json:"external_refs"`
}

type Side string

type SyncDrift struct {
	Kind      string `json:"kind"`
	Field     string `json:"field"`
	KombifyID string `json:"kombifyId"`
	HAID      string `json:"haId"`
	Graph     string `json:"graph"`
	HA        string `json:"ha"`
}

type SyncInventory struct {
	Floors          []InventoryFloor `json:"floors"`
	Areas           []InventoryArea  `json:"areas"`
	UnmappedDevices int              `json:"unmappedDevices"`
}

type SyncLinks struct {
	Floors  map[string]string `json:"floors"`
	Areas   map[string]string `json:"areas"`
	Devices map[string]string `json:"devices"`
}

type SyncRequest struct {
	SchemaVersion string    `json:"schemaVersion"`
	Graph         Graph     `json:"graph"`
	Restore       []Restore `json:"restore"`
}

type SyncResult struct {
	SchemaVersion string        `json:"schemaVersion"`
	Revision      int64         `json:"revision"`
	LeadingSystem string        `json:"leadingSystem"`
	Status        string        `json:"status"`
	Operations    int           `json:"operations"`
	Links         SyncLinks     `json:"links"`
	Drift         []SyncDrift   `json:"drift"`
	Inventory     SyncInventory `json:"inventory"`
	SyncedAt      string        `json:"syncedAt"`
}