aboutsummaryrefslogtreecommitdiffstats
path: root/sdnr/wt/odlux/apps/configurationApp/src/models/uiModels.ts
blob: 441d1281d494b9aedb350dc66a4140805fa70073 (plain)
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
export type ViewElementBase = {
  "id": string;
  "label": string;
  "config": boolean;
  "ifFeature"?: string;
  "when"?: string;
  "mandatory"?: boolean;
  "description"?: string;
  "isList"?: boolean;
  "default"?: string;
  "status"?: "current" | "deprecated" | "obsolete",
  "reference"?: string, // https://tools.ietf.org/html/rfc7950#section-7.21.4
}

// https://tools.ietf.org/html/rfc7950#section-9.8
export type ViewElementBinary = ViewElementBase & {
  "uiType": "binary";
  "length"?: number;  // number of octets
}

// https://tools.ietf.org/html/rfc7950#section-9.7.4
export type ViewElementBits = ViewElementBase & {
  "uiType": "bits";
  "flags": {
    [name: string]: number | undefined;    // 0 - 4294967295
  }
}

// https://tools.ietf.org/html/rfc7950#section-9
export type ViewElementString = ViewElementBase & {
  "uiType": "string";
  "pattern"?: string[];
  "length"?: string;
  "invertMatch"?: true;
}

// https://tools.ietf.org/html/rfc7950#section-9.3
export type ViewElementNumber = ViewElementBase & {
  "uiType": "number";
  "min"?: number;
  "max"?: number;
  "units"?: string;
  "format"?: string;
  "fDigits"?: number;
}

// https://tools.ietf.org/html/rfc7950#section-9.5
export type ViewElementBoolean = ViewElementBase & {
  "uiType": "boolean";
  "trueValue"?: string;
  "falseValue"?: string;
}

// https://tools.ietf.org/html/rfc7950#section-9.6.4
export type ViewElementSelection = ViewElementBase & {
  "uiType": "selection";
  "multiSelect"?: boolean
  "options": {
    "key": string;
    "value": string;
    "description"?: string,
    "status"?: "current" | "deprecated" | "obsolete",
    "reference"?: string,
  }[];
}

// is a list if isList is true ;-)
export type ViewElementObject = ViewElementBase & {
  "uiType": "object";
  "isList"?: false;
  "viewId": string;
}

// Hint: read only lists do not need a key
export type ViewElementList = (ViewElementBase & {
  "uiType": "object";
  "isList": true;
  "viewId": string;
  "key"?: string;
});

export type ViewElementReference = ViewElementBase & {
  "uiType": "reference";
  "referencePath": string;
  "ref": (currentPath: string) => ViewElement | null;
}

export type ViewElement =
  | ViewElementBits
  | ViewElementBinary
  | ViewElementString
  | ViewElementNumber
  | ViewElementBoolean
  | ViewElementObject
  | ViewElementList
  | ViewElementSelection
  | ViewElementReference;

export const isViewElementString = (viewElement: ViewElement): viewElement is ViewElementString => {
  return viewElement && viewElement.uiType === "string";
}

export const isViewElementNumber = (viewElement: ViewElement): viewElement is ViewElementNumber => {
  return viewElement && viewElement.uiType === "number" ;
}

export const isViewElementBoolean = (viewElement: ViewElement): viewElement is ViewElementBoolean => {
  return viewElement && viewElement.uiType === "boolean";
}

export const isViewElementObject = (viewElement: ViewElement): viewElement is ViewElementObject => {
  return viewElement && viewElement.uiType === "object" && viewElement.isList === false;
}

export const isViewElementList = (viewElement: ViewElement): viewElement is ViewElementList => {
  return viewElement && viewElement.uiType === "object" && viewElement.isList === true;
}

export const isViewElementObjectOrList = (viewElement: ViewElement): viewElement is ViewElementObject | ViewElementList => {
  return viewElement && viewElement.uiType === "object";
}

export const isViewElementSelection = (viewElement: ViewElement): viewElement is ViewElementSelection => {
  return viewElement && viewElement.uiType === "selection";
}

export const isViewElementReference = (viewElement: ViewElement): viewElement is ViewElementReference => {
  return viewElement && viewElement.uiType === "reference";
}

export type ViewSpecification = {
  "id": string;
  "name": string;
  "title"?: string;
  "parentView"?: string;
  "language": string;
  "ifFeature"?: string;
  "when"?: string;
  "uses"?: string[];
  "elements": { [name: string]: ViewElement };
  readonly "canEdit": boolean;
}