mqtt-control-map/types/types.js

104 lines
2.5 KiB
JavaScript

declare type Map<K,V> = { [K]: V };
declare type Classes = {
classes: Map<string, string>
};
declare type Topic = {
state: string,
command: string,
defaultValue: any,
values: Map<string,any>,
parseState?: (msg: Object) => any
};
declare type Topics = Map<string,Topic>;
declare type ControlUI = {
type: "toggle" | "dropDown" | "slider" | "section",
text: string,
topic?: string,
icon?: string,
enableCondition?: (internal: string, actual: any, state: State) => boolean,
// LINK optiona properties
link?: string,
// TOGGLE optional properties
on?: string, // on override for toggle
off?: string, // off override for toggle
toggled?: (internal: string, actual: any, state: State) => boolean,
// DROPDOWN optional properties
options?: Map<string,any>, //options for dropDown
renderValue?: (value: string) => string,
// SLIDER optional properties
min?: number,
max?: number,
step?: number
};
declare type Control = {
name: string,
position: Array<number>,
icon: string | (
internals: Map<string, string>,
actuals: Map<string, any>,
state: State
) => string,
iconColor?: (
internals: Map<string, string>,
actuals: Map<string, any>,
state: State
) => string,
ui: Array<ControlUI>
};
declare type Controls = Map<string,Control>;
declare type Config = {
space: Space,
topics: Topics,
controls: Controls,
layers: Array<Layer>
};
declare type Space = {
name: string,
color: "red"|"pink"|"purple"|"deepPurple"|"indigo"|"blue"|"lightBlue"|"cyan"|"teal"|
"green"|"lightgreen"|"lime"|"yellow"|"amber"|"orange"|"deepOrange"|"brown"|"grey"|"blueGrey"
};
declare type State = Map<string,any>;
//declare type State = {
// mqtt: ?any,
// uiOpened: ?string,
// A map of the actual state values for each topic.
// internal is the internal term for the value,
// that is equal to the key in the values section of that
// topic, for example given by:
// values: { off: "OFF", on: "ON" }
// and actual is the value of that or whatever is given by mqtt.
// values: Map<string, { internal: ?string, actual: any }>,
// visibleLayers: Array<string>
//};
declare type Point = [number, number];
declare type Layer = {
image: string,
name: string,
baseLayer: boolean,
defaultVisibility: "visible" | "hidden",
opacity: number,
bounds: {
topLeft: Point,
bottomRight: Point
}
};
declare type StateAction = {
type: "DISCONNECT" | "CONNECT" | "MESSAGE" | "UI_POPUP",
payload?: any
};