manifest

Documentation

Index

• Variables
• type Choice
• type Extendable
• type Extension
• type ID
• type Id
• type Location
• type Manifest
  • func MergeManifestTranslation(m *Manifest, tl map[string]*TranslationRoot) *Manifest
  • func MustParseSystemFromBytes(source []byte, scene *id.SceneID) *Manifest
  • func Parse(source io.Reader, scene *id.SceneID) (*Manifest, error)
  • func ParseSystemFromBytes(source []byte, scene *id.SceneID) (*Manifest, error)
  • func (m Manifest) PropertySchemas() []*property.Schema
• type PropertyCondition
• type PropertyLinkableFields
• type PropertyPointer
• type PropertySchema
• type PropertySchemaField
• type PropertySchemaGroup
• type Root
• type TranslationExtension
• type TranslationPropertySchema
• type TranslationPropertySchemaField
• type TranslationPropertySchemaGroup
• type TranslationRoot
  • func MustParseTranslationFromBytes(source []byte) *TranslationRoot
  • func ParseTranslation(source io.Reader) (*TranslationRoot, error)
  • func ParseTranslationFromBytes(source []byte) (*TranslationRoot, error)
• type Valuetype
• type WidgetLayout

Variables

var (
	ErrInvalidManifest       error = errors.New("invalid manifest")
	ErrFailedToParseManifest error = errors.New("failed to parse plugin manifest")
	ErrSystemManifest              = errors.New("cannot build system manifest")
)

var (
	ErrInvalidManifestTranslation       error = errors.New("invalid manifest translation")
	ErrFailedToParseManifestTranslation error = errors.New("failed to parse plugin manifest translation")
)

Types

type Choice

type Choice struct {
	Icon  string `json:"icon,omitempty"`
	Key   string `json:"key"`
	Label string `json:"label,omitempty"`
}

type Extendable

type Extendable struct {
	Horizontally *bool `json:"horizontally,omitempty"`
	Vertically   *bool `json:"vertically,omitempty"`
}

type Extension

type Extension struct {
	Description  *string         `json:"description,omitempty"`
	ID           ID              `json:"id"`
	Icon         *string         `json:"icon,omitempty"`
	Name         string          `json:"name"`
	Schema       *PropertySchema `json:"schema,omitempty"`
	SingleOnly   *bool           `json:"singleOnly,omitempty"`
	Type         string          `json:"type"`
	Visualizer   *string         `json:"visualizer,omitempty"`
	WidgetLayout *WidgetLayout   `json:"widgetLayout,omitempty"`
}

type ID

type ID string

type Id

type Id string

type Location

type Location struct {
	Area    string `json:"area,omitempty"`
	Section string `json:"section,omitempty"`
	Zone    string `json:"zone,omitempty"`
}

type Manifest

type Manifest struct {
	Plugin          *plugin.Plugin
	ExtensionSchema []*property.Schema
	Schema          *property.Schema
}

func MergeManifestTranslation

func MergeManifestTranslation(m *Manifest, tl map[string]*TranslationRoot) *Manifest

func MustParseSystemFromBytes

func MustParseSystemFromBytes(source []byte, scene *id.SceneID) *Manifest

func Parse

func Parse(source io.Reader, scene *id.SceneID) (*Manifest, error)

func ParseSystemFromBytes

func ParseSystemFromBytes(source []byte, scene *id.SceneID) (*Manifest, error)

func (Manifest) PropertySchemas

func (m Manifest) PropertySchemas() []*property.Schema

type PropertyCondition

type PropertyCondition struct {
	Field string      `json:"field"`
	Type  Valuetype   `json:"type"`
	Value interface{} `json:"value"`
}

type PropertyLinkableFields

type PropertyLinkableFields struct {
	Latlng *PropertyPointer `json:"latlng,omitempty"`
	URL    *PropertyPointer `json:"url,omitempty"`
}

type PropertyPointer

type PropertyPointer struct {
	FieldID       string `json:"fieldId"`
	SchemaGroupID string `json:"schemaGroupId"`
}

type PropertySchema

type PropertySchema struct {
	Groups   []PropertySchemaGroup   `json:"groups,omitempty"`
	Linkable *PropertyLinkableFields `json:"linkable,omitempty"`
	Version  float64                 `json:"version,omitempty"`
}

type PropertySchemaField

type PropertySchemaField struct {
	AvailableIf  *PropertyCondition `json:"availableIf,omitempty"`
	Choices      []Choice           `json:"choices,omitempty"`
	DefaultValue interface{}        `json:"defaultValue,omitempty"`
	Description  *string            `json:"description,omitempty"`
	ID           ID                 `json:"id"`
	Max          *float64           `json:"max,omitempty"`
	Min          *float64           `json:"min,omitempty"`
	Prefix       *string            `json:"prefix,omitempty"`
	Suffix       *string            `json:"suffix,omitempty"`
	Title        *string            `json:"title"`
	Type         Valuetype          `json:"type"`
	UI           *string            `json:"ui,omitempty"`
}

type PropertySchemaGroup

type PropertySchemaGroup struct {
	AvailableIf         *PropertyCondition    `json:"availableIf,omitempty"`
	Description         *string               `json:"description,omitempty"`
	Fields              []PropertySchemaField `json:"fields,omitempty"`
	ID                  ID                    `json:"id"`
	List                bool                  `json:"list,omitempty"`
	RepresentativeField *Id                   `json:"representativeField,omitempty"`
	Title               string                `json:"title"`
}

type Root

type Root struct {
	Author      *string         `json:"author,omitempty"`
	Description *string         `json:"description,omitempty"`
	Extensions  []Extension     `json:"extensions,omitempty"`
	ID          ID              `json:"id"`
	Main        *string         `json:"main,omitempty"`
	Name        string          `json:"name"`
	Repository  *string         `json:"repository,omitempty"`
	Schema      *PropertySchema `json:"schema,omitempty"`
	System      bool            `json:"system,omitempty"`
	Version     string          `json:"version,omitempty"`
}

type TranslationExtension

type TranslationExtension struct {
	Description    *string                   `json:"description,omitempty"`
	Name           *string                   `json:"name,omitempty"`
	PropertySchema TranslationPropertySchema `json:"propertySchema,omitempty"`
}

type TranslationPropertySchema

type TranslationPropertySchema map[string]TranslationPropertySchemaGroup

type TranslationPropertySchemaField

type TranslationPropertySchemaField struct {
	Choices     map[string]string `json:"choices,omitempty"`
	Description *string           `json:"description,omitempty"`
	Title       *string           `json:"title,omitempty"`
}

type TranslationPropertySchemaGroup

type TranslationPropertySchemaGroup struct {
	Description *string                                   `json:"description,omitempty"`
	Fields      map[string]TranslationPropertySchemaField `json:"fields,omitempty"`
	Title       *string                                   `json:"title,omitempty"`
}

type TranslationRoot

type TranslationRoot struct {
	Description *string                         `json:"description,omitempty"`
	Extensions  map[string]TranslationExtension `json:"extensions,omitempty"`
	Name        *string                         `json:"name,omitempty"`
	Schema      TranslationPropertySchema       `json:"schema,omitempty"`
}

func MustParseTranslationFromBytes

func MustParseTranslationFromBytes(source []byte) *TranslationRoot

func ParseTranslation

func ParseTranslation(source io.Reader) (*TranslationRoot, error)

func ParseTranslationFromBytes

func ParseTranslationFromBytes(source []byte) (*TranslationRoot, error)

type Valuetype

type Valuetype string

type WidgetLayout

type WidgetLayout struct {
	DefaultLocation *Location   `json:"defaultLocation,omitempty"`
	Extendable      *Extendable `json:"extendable,omitempty"`
	Extended        *bool       `json:"extended,omitempty"`
	Floating        bool        `json:"floating,omitempty"`
}