-
Notifications
You must be signed in to change notification settings - Fork 208
/
Value.ts
453 lines (416 loc) · 14.3 KB
/
Value.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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
/*---------------------------------------------------------------------------------------------
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
* See LICENSE.md in the project root for license terms and full copyright notice.
*--------------------------------------------------------------------------------------------*/
/** @packageDocumentation
* @module Content
*/
import { InstanceId, InstanceKey } from "../EC";
import { LabelDefinition } from "../LabelDefinition";
import { ValuesDictionary } from "../Utils";
/**
* Raw value type
* @public
*/
export type Value = string | number | boolean | undefined | ValuesMap | ValuesArray | NavigationPropertyValue | NestedContentValue[];
/** @public */
// eslint-disable-next-line @typescript-eslint/no-redeclare
export namespace Value {
/** Is the value a primitive */
export function isPrimitive(value: Value): value is string | number | boolean | undefined {
return isPrimitiveValue(value);
}
/** Is the value an array */
export function isArray(value: Value): value is ValuesArray {
return isArrayValue(value);
}
/** Is the value a map / struct */
export function isMap(value: Value): value is ValuesMap {
return isMapValue(value);
}
/** Is the value a nested content value */
export function isNestedContent(value: Value): value is NestedContentValue[] {
return isNestedContentValue(value);
}
/** Is the value a navigation value */
export function isNavigationValue(value: Value): value is NavigationPropertyValue {
return (
value !== undefined &&
(value as NavigationPropertyValue).id !== undefined &&
(value as NavigationPropertyValue).className !== undefined &&
(value as NavigationPropertyValue).label !== undefined
);
}
/**
* Serialize [[Value]] to JSON
* @deprecated in 3.x. Use [[Value]]
*/
// eslint-disable-next-line deprecation/deprecation
export function fromJSON(json: ValueJSON): Value {
if (json === null) {
return undefined;
}
if (isNestedContentValue(json)) {
// eslint-disable-next-line deprecation/deprecation
return json.map(NestedContentValue.fromJSON);
}
if (isArrayValue(json)) {
return valuesArrayFromJSON(json);
}
if (isMapValue(json)) {
return valuesMapFromJSON(json);
}
return json;
}
/**
* Deserialize [[Value]] from JSON
* @deprecated in 3.x. Use [[Value]]
*/
// eslint-disable-next-line deprecation/deprecation
export function toJSON(value: Value): ValueJSON {
if (undefined === value) {
return null;
}
if (isNestedContentValue(value)) {
// eslint-disable-next-line deprecation/deprecation
return value.map(NestedContentValue.toJSON);
}
if (isArrayValue(value)) {
return valuesArrayToJSON(value);
}
if (isMapValue(value)) {
return valuesMapToJSON(value);
}
return value;
}
}
/**
* A map of raw values
* @public
*/
export interface ValuesMap extends ValuesDictionary<Value> {} // eslint-disable-line @typescript-eslint/no-empty-interface
/**
* An array of raw values
* @public
*/
export interface ValuesArray extends Array<Value> {} // eslint-disable-line @typescript-eslint/no-empty-interface
/**
* Display value type.
* @public
*/
export type DisplayValue = string | undefined | DisplayValuesMap | DisplayValuesArray;
/** @public */
// eslint-disable-next-line @typescript-eslint/no-redeclare
export namespace DisplayValue {
/** Is the value a primitive */
export function isPrimitive(value: DisplayValue): value is string | undefined {
return isPrimitiveValue(value);
}
/** Is the value an array */
export function isArray(value: DisplayValue): value is DisplayValuesArray {
return isArrayValue(value);
}
/** Is the value a map / struct */
export function isMap(value: DisplayValue): value is DisplayValuesMap {
return isMapValue(value);
}
/**
* Serialize [[DisplayValue]] to JSON
* @deprecated in 3.x. Use [[DisplayValue]]
*/
// eslint-disable-next-line deprecation/deprecation
export function fromJSON(json: DisplayValueJSON): DisplayValue {
if (json === null) {
return undefined;
}
if (isArrayValue(json)) {
return displayValuesArrayFromJSON(json);
}
if (isMapValue(json)) {
return displayValuesMapFromJSON(json);
}
return json;
}
/**
* Deserialize [[DisplayValue]] from JSON
* @deprecated in 3.x. Use [[DisplayValue]]
*/
// eslint-disable-next-line deprecation/deprecation
export function toJSON(value: DisplayValue): DisplayValueJSON {
if (undefined === value) {
return null;
}
if (isArrayValue(value)) {
return displayValuesArrayToJSON(value);
}
if (isMapValue(value)) {
return displayValuesMapToJSON(value);
}
return value;
}
}
/**
* A map of display values
* @public
*/
export interface DisplayValuesMap extends ValuesDictionary<DisplayValue> {} // eslint-disable-line @typescript-eslint/no-empty-interface
/**
* An array of display values
* @public
*/
export interface DisplayValuesArray extends Array<DisplayValue> {} // eslint-disable-line @typescript-eslint/no-empty-interface
/**
* Data structure that describes nested content value.
* @public
*/
export interface NestedContentValue {
/** Keys of instances whose content is contained in this value */
primaryKeys: InstanceKey[];
/** Content values map */
values: ValuesDictionary<Value>;
/** Content display values map */
displayValues: ValuesDictionary<DisplayValue>;
/** Names of fields whose values are merged */
mergedFieldNames: string[];
}
/**
* Data structure that describes value of the navigation property.
* @public
*/
export interface NavigationPropertyValue {
/** Label of target instance. */
label: LabelDefinition;
/** Full class name of target instance in format `SchemaName:ClassName` */
className: string;
/** Id of target instance. */
id: InstanceId;
}
/** @public */
export namespace NestedContentValue {
/**
* Serialize [[NestedContentValue]] to JSON
* @deprecated in 3.x. Use [[NestedContentValue]]
*/
// eslint-disable-next-line deprecation/deprecation
export function toJSON(value: NestedContentValue): NestedContentValueJSON {
return {
...value,
values: valuesMapToJSON(value.values),
displayValues: displayValuesMapToJSON(value.displayValues),
};
}
/**
* Deserialize [[NestedContentValue]] from JSON
* @deprecated in 3.x. Use [[NestedContentValue]]
*/
// eslint-disable-next-line deprecation/deprecation
export function fromJSON(json: NestedContentValueJSON): NestedContentValue {
return {
...json,
values: valuesMapFromJSON(json.values),
displayValues: displayValuesMapFromJSON(json.displayValues),
};
}
}
/**
* JSON representation of [[Value]]
* @public
* @deprecated in 3.x. Use [[Value]]
*/
// eslint-disable-next-line deprecation/deprecation
export type ValueJSON = string | number | boolean | null | ValuesMapJSON | ValuesArrayJSON | NavigationPropertyValue | NestedContentValueJSON[];
/**
* JSON representation of [[ValuesMap]]
* @public
* @deprecated in 3.x. Use [[ValuesMap]]
*/
// eslint-disable-next-line deprecation/deprecation
export interface ValuesMapJSON extends ValuesDictionary<ValueJSON> {} // eslint-disable-line @typescript-eslint/no-empty-interface
/**
* JSON representation of [[ValuesArray]]
* @public
* @deprecated in 3.x. Use [[ValuesArray]]
*/
// eslint-disable-next-line deprecation/deprecation
export interface ValuesArrayJSON extends Array<ValueJSON> {} // eslint-disable-line @typescript-eslint/no-empty-interface
/**
* JSON representation of [[DisplayValue]]
* @public
* @deprecated in 3.x. Use [[DisplayValue]]
*/
// eslint-disable-next-line deprecation/deprecation
export type DisplayValueJSON = string | null | DisplayValuesMapJSON | DisplayValuesArrayJSON;
/**
* JSON representation of [[DisplayValuesMap]]
* @public
* @deprecated in 3.x. Use [[DisplayValuesMap]]
*/
// eslint-disable-next-line deprecation/deprecation
export interface DisplayValuesMapJSON extends ValuesDictionary<DisplayValueJSON> {} // eslint-disable-line @typescript-eslint/no-empty-interface
/**
* JSON representation of [[DisplayValuesArray]]
* @public
* @deprecated in 3.x. Use [[DisplayValuesArray]]
*/
// eslint-disable-next-line deprecation/deprecation
export interface DisplayValuesArrayJSON extends Array<DisplayValueJSON> {} // eslint-disable-line @typescript-eslint/no-empty-interface
/**
* JSON representation of [[NestedContentValue]]
* @public
* @deprecated in 3.x. Use [[NestedContentValue]]
*/
export interface NestedContentValueJSON {
primaryKeys: InstanceKey[];
// eslint-disable-next-line deprecation/deprecation
values: ValuesDictionary<ValueJSON>;
// eslint-disable-next-line deprecation/deprecation
displayValues: ValuesDictionary<DisplayValueJSON>;
mergedFieldNames: string[];
}
/**
* A group of raw values and their common display value.
* @public
*/
export interface DisplayValueGroup {
/** Common display value for all grouped raw values */
displayValue: DisplayValue;
/** A list of grouped raw values */
groupedRawValues: Value[];
}
/**
* JSON representation of [[DisplayValueGroup]].
* @public
* @deprecated in 3.x. Use [[DisplayValueGroup]]
*/
export interface DisplayValueGroupJSON {
// eslint-disable-next-line deprecation/deprecation
displayValue: DisplayValueJSON;
// eslint-disable-next-line deprecation/deprecation
groupedRawValues: ValueJSON[];
}
/** @public */
export namespace DisplayValueGroup {
/**
* Serialize [[DisplayValueGroup]] to JSON
* @deprecated in 3.x. Use [[DisplayValueGroup]]
*/
// eslint-disable-next-line deprecation/deprecation
export function toJSON(group: DisplayValueGroup): DisplayValueGroupJSON {
return {
// eslint-disable-next-line deprecation/deprecation
displayValue: DisplayValue.toJSON(group.displayValue),
// eslint-disable-next-line deprecation/deprecation
groupedRawValues: group.groupedRawValues.map(Value.toJSON),
};
}
/**
* Deserialize [[DisplayValueGroup]] from JSON
* @deprecated in 3.x. Use [[DisplayValueGroup]]
*/
// eslint-disable-next-line deprecation/deprecation
export function fromJSON(json: DisplayValueGroupJSON): DisplayValueGroup {
return {
// eslint-disable-next-line deprecation/deprecation
displayValue: DisplayValue.fromJSON(json.displayValue),
// eslint-disable-next-line deprecation/deprecation
groupedRawValues: json.groupedRawValues.map(Value.fromJSON),
};
}
}
// eslint-disable-next-line deprecation/deprecation
function isNestedContentValue(v: Value | ValueJSON): v is NestedContentValue[] | NestedContentValueJSON[] {
return (
v !== undefined &&
Array.isArray(v) &&
(v.length === 0 ||
((v[0] as NestedContentValue).primaryKeys !== undefined &&
(v[0] as NestedContentValue).values !== undefined &&
(v[0] as NestedContentValue).displayValues !== undefined &&
(v[0] as NestedContentValue).mergedFieldNames !== undefined))
);
}
function isArrayValue(
v: Value | ValueJSON | DisplayValue | DisplayValueJSON, // eslint-disable-line deprecation/deprecation
// eslint-disable-next-line deprecation/deprecation
): v is ValuesArray | ValuesArrayJSON | DisplayValuesArray | DisplayValuesArrayJSON {
// note: we don't guarantee by 100% that v is ValuesArray | DisplayValuesArray, but merely make compiler happy.
// we have other means to determine the type of value.
return v !== undefined && Array.isArray(v);
}
// eslint-disable-next-line deprecation/deprecation
function isMapValue(v: Value | ValueJSON | DisplayValue | DisplayValueJSON): v is ValuesMap | ValuesMapJSON | DisplayValuesMap | DisplayValuesMapJSON {
return v !== undefined && typeof v === "object" && !Array.isArray(v);
}
function isPrimitiveValue(v: Value | DisplayValue): v is string | number | boolean | undefined {
return !isArrayValue(v) && !isMapValue(v);
}
// eslint-disable-next-line deprecation/deprecation
function valuesArrayFromJSON(json: ValuesArrayJSON): ValuesArray {
// eslint-disable-next-line deprecation/deprecation
return json.map(Value.fromJSON);
}
// eslint-disable-next-line deprecation/deprecation
function valuesArrayToJSON(values: ValuesArray): ValuesArrayJSON {
// eslint-disable-next-line deprecation/deprecation
return values.map(Value.toJSON);
}
// eslint-disable-next-line deprecation/deprecation
function valuesMapFromJSON(json: ValuesMapJSON): ValuesMap {
const map: ValuesMap = {};
for (const key in json) {
/* istanbul ignore else */
if (json.hasOwnProperty(key)) {
// eslint-disable-next-line deprecation/deprecation
map[key] = Value.fromJSON(json[key]);
}
}
return map;
}
// eslint-disable-next-line deprecation/deprecation
function valuesMapToJSON(values: ValuesMap): ValuesMapJSON {
// eslint-disable-next-line deprecation/deprecation
const map: ValuesMapJSON = {};
for (const key in values) {
/* istanbul ignore else */
if (values.hasOwnProperty(key)) {
// eslint-disable-next-line deprecation/deprecation
map[key] = Value.toJSON(values[key]);
}
}
return map;
}
// eslint-disable-next-line deprecation/deprecation
function displayValuesArrayFromJSON(json: DisplayValuesArrayJSON): DisplayValuesArray {
// eslint-disable-next-line deprecation/deprecation
return json.map(DisplayValue.fromJSON);
}
// eslint-disable-next-line deprecation/deprecation
function displayValuesArrayToJSON(values: DisplayValuesArray): DisplayValuesArrayJSON {
// eslint-disable-next-line deprecation/deprecation
return values.map(DisplayValue.toJSON);
}
// eslint-disable-next-line deprecation/deprecation
function displayValuesMapFromJSON(json: DisplayValuesMapJSON): DisplayValuesMap {
const map: DisplayValuesMap = {};
for (const key in json) {
/* istanbul ignore else */
if (json.hasOwnProperty(key)) {
// eslint-disable-next-line deprecation/deprecation
map[key] = DisplayValue.fromJSON(json[key]);
}
}
return map;
}
// eslint-disable-next-line deprecation/deprecation
function displayValuesMapToJSON(values: DisplayValuesMap): DisplayValuesMapJSON {
// eslint-disable-next-line deprecation/deprecation
const map: DisplayValuesMapJSON = {};
for (const key in values) {
/* istanbul ignore else */
if (values.hasOwnProperty(key)) {
// eslint-disable-next-line deprecation/deprecation
map[key] = DisplayValue.toJSON(values[key]);
}
}
return map;
}