-
Notifications
You must be signed in to change notification settings - Fork 1
/
data-navigator.ts
142 lines (114 loc) · 3.22 KB
/
data-navigator.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
// StructureOptions is still under development!
// Our next major step is to build functions to automatically produce Structure
export type StructureOptions = {
[key: string | number]: any
}
export type InputOptions = {
structure: Structure,
navigationRules: NavigationRules,
entryPoint?: NodeId,
exitPoint?: RenderId
}
export type RenderingOptions = {
elementData: ElementData | Nodes,
suffixId: string,
root: RootObject,
defaults?: RenderObject,
entryButton?: EntryObject,
exitElement?: ExitObject
}
export type Structure = {
nodes: Nodes,
edges: Edges,
navigationRules?: NavigationRules,
elementData?: ElementData
}
export type Nodes = Record<NodeId, NodeObject>
export type Edges = Record<EdgeId, EdgeObject>
export type NavigationRules = Record<NavId, NavObject>
export type ElementData = Record<RenderId, RenderObject>
export type EdgeList = Array<EdgeId>
export type NavigationList = Array<NavId>
export type Semantics = ((RenderObject?,DatumObject?) => SemanticsObject) | SemanticsObject
export type Dimensions = ((RenderObject?,DatumObject?) => DimensionsObject) | DimensionsObject
export type Attributes = ((RenderObject?,DatumObject?) => AttributesObject) | AttributesObject
export type NodeObject = {
id: NodeId,
edges: EdgeList,
renderId?: RenderId,
[key: string | number]: any // NodeObjects can be lazily used as generic objects (like ElementObjects) too
}
export type EdgeObject = {
source: (() => EdgeId) | EdgeId;
target: (() => EdgeId) | EdgeId;
navigationRules: NavigationList;
}
export type NavObject = {
direction: Direction;
key?: string;
}
export type RenderObject = {
cssClass?: DynamicString,
dimensions?: Dimensions,
semantics?: Semantics,
parentSemantics?: Semantics,
existingElement?: ExistingElement,
showText?: boolean
}
export type RootObject = {
id: string,
cssClass?: string,
description?: string,
width?: string | number,
height?: string | number
}
export type EntryObject = {
include: boolean,
callbacks?: EntryCallbacks
}
export type ExitObject = {
include: boolean,
callbacks?: ExitCallbacks
}
export type SemanticsObject = {
label?: DynamicString,
elementType?: DynamicString,
role?: DynamicString,
attributes?: Attributes
}
export type DimensionsObject = {
x?: DynamicNumber,
y?: DynamicNumber,
width?: DynamicNumber,
height?: DynamicNumber,
path?: DynamicString
}
export type DescriptionOptions = {
omitKeyNames?: boolean,
semanticLabel?: string
}
export type ExistingElement = {
useForDimensions: boolean,
dimensions?: Dimensions
}
export type EntryCallbacks = {
focus?: Function,
click?: Function
}
export type ExitCallbacks = {
focus?: Function,
blur?: Function
}
export type DatumObject = {
[key: string | number]: any
}
export type AttributesObject = {
[key: string]: string
}
export type DynamicNumber = ((RenderObject?,DatumObject?) => number) | number
export type DynamicString = ((RenderObject?,DatumObject?) => string) | string
export type NodeId = string
export type EdgeId = string
export type RenderId = string
export type NavId = string
export type Direction = "target" | "source"