applets

type Applet struct {
	ID string `yaml:"-"`
	// Dir is the applet's directory, exported to its commands as HIVE_APPLET_DIR. A
	// built-in has its page in the binary, and keeps only its saved storage here.
	Dir string `yaml:"-"`
	// Builtin marks an applet Hive ships. A directory of the same name replaces it.
	Builtin bool `yaml:"-"`
	// Warnings names what this Hive skipped in the file, such as a key from a later
	// release. The applet still runs.
	Warnings []string `yaml:"-"`
	// Version is the format of this file, not a release of the applet.
	Version int `yaml:"version"`
	// Hive is the oldest Hive that can run this applet, as ">=0.60".
	Hive  string `yaml:"hive,omitempty"`
	Title string `yaml:"title"`
	Icon  string `yaml:"icon,omitempty"`
	// Cwd pins the applet's commands to one directory. Empty follows the session on
	// screen, and the applet's own directory without one.
	Cwd string `yaml:"cwd,omitempty"`
	// Entry is the page the applet opens on, relative to its directory.
	Entry string `yaml:"entry,omitempty"`
	// Surfaces says where the applet shows. A file that names none is a pop-up.
	Surfaces Surfaces `yaml:"surfaces,omitempty"`
	// Commands are the applet's palette rows that a user can bind to a key, as
	// applet.<id>.<command>. They carry no default chord, so a file cannot claim a key.
	Commands []Command `yaml:"commands,omitempty"`
}

type Archive struct {
	Applet Applet
	Files  []ArchiveFile
}

type ArchiveFile struct {
	Path string
	Data []byte
}

type Command struct {
	// ID is permanent once a user has bound it: it is what settings.yaml names.
	ID       string   `yaml:"id"`
	Title    string   `yaml:"title"`
	Icon     string   `yaml:"icon,omitempty"`
	Keywords []string `yaml:"keywords,omitempty"`
}

type Entry struct {
	Applet Applet
	Err    error
	// Revision is the newest change among the applet's watched files, in Unix
	// milliseconds. It is what tells a page on screen to load again after an edit,
	// without a change to another applet restarting this one.
	Revision int64
}

type PackList struct {
	Files   []PackedFile
	LeftOut []string
}

type PackedApplet struct {
	Data []byte
	List PackList
}

type PackedFile struct {
	Path  string
	Bytes int64
}

type PopupSurface struct {
	Enabled *bool `yaml:"enabled,omitempty"`
	Width   int   `yaml:"width,omitempty"`
	Height  int   `yaml:"height,omitempty"`
}

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

type Surfaces struct {
	// Tab puts the applet in a session's + menu.
	Tab *TabSurface `yaml:"tab,omitempty"`
	// Popup opens the applet over the app, from the palette or a chord.
	Popup *PopupSurface `yaml:"popup,omitempty"`
	// Titlebar runs a page in the title bar from the moment the file loads.
	Titlebar *TitlebarSurface `yaml:"titlebar,omitempty"`
}

type TabSurface struct {
	// Enabled false turns the surface off and keeps its settings. Unset is on.
	Enabled *bool `yaml:"enabled,omitempty"`
}

type TitlebarSurface struct {
	Enabled *bool `yaml:"enabled,omitempty"`
	// Entry is relative to the applet's directory. Empty uses the applet's Entry, and
	// the page tells the two apart with hive.surface.
	Entry string `yaml:"entry,omitempty"`
	// Width is the slot's width in pixels until the page asks for another. Zero is
	// DefaultTitlebarWidth, one icon button.
	Width int `yaml:"width,omitempty"`
}

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