@itwin/ecschema-metadata 3.4.0-dev.8 → 3.5.0-dev.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (153) hide show
  1. package/CHANGELOG.md +25 -1
  2. package/lib/cjs/Constants.d.ts +23 -23
  3. package/lib/cjs/Constants.js +33 -33
  4. package/lib/cjs/Constants.js.map +1 -1
  5. package/lib/cjs/Context.d.ts +139 -139
  6. package/lib/cjs/Context.js +204 -204
  7. package/lib/cjs/DelayedPromise.d.ts +88 -88
  8. package/lib/cjs/DelayedPromise.js +91 -91
  9. package/lib/cjs/DelayedPromise.js.map +1 -1
  10. package/lib/cjs/Deserialization/AbstractParser.d.ts +45 -45
  11. package/lib/cjs/Deserialization/AbstractParser.js +11 -11
  12. package/lib/cjs/Deserialization/AbstractParser.js.map +1 -1
  13. package/lib/cjs/Deserialization/Helper.d.ts +251 -251
  14. package/lib/cjs/Deserialization/Helper.js +843 -843
  15. package/lib/cjs/Deserialization/Helper.js.map +1 -1
  16. package/lib/cjs/Deserialization/JsonParser.d.ts +165 -165
  17. package/lib/cjs/Deserialization/JsonParser.js +680 -680
  18. package/lib/cjs/Deserialization/JsonParser.js.map +1 -1
  19. package/lib/cjs/Deserialization/JsonProps.d.ts +282 -282
  20. package/lib/cjs/Deserialization/JsonProps.js +9 -9
  21. package/lib/cjs/Deserialization/JsonProps.js.map +1 -1
  22. package/lib/cjs/Deserialization/SchemaGraphUtil.d.ts +34 -34
  23. package/lib/cjs/Deserialization/SchemaGraphUtil.js +77 -77
  24. package/lib/cjs/Deserialization/SchemaGraphUtil.js.map +1 -1
  25. package/lib/cjs/Deserialization/XmlParser.d.ts +85 -85
  26. package/lib/cjs/Deserialization/XmlParser.d.ts.map +1 -1
  27. package/lib/cjs/Deserialization/XmlParser.js +973 -973
  28. package/lib/cjs/Deserialization/XmlParser.js.map +1 -1
  29. package/lib/cjs/Deserialization/XmlSerializationUtils.d.ts +54 -54
  30. package/lib/cjs/Deserialization/XmlSerializationUtils.js +174 -174
  31. package/lib/cjs/Deserialization/XmlSerializationUtils.js.map +1 -1
  32. package/lib/cjs/ECName.d.ts +30 -30
  33. package/lib/cjs/ECName.js +85 -85
  34. package/lib/cjs/ECName.js.map +1 -1
  35. package/lib/cjs/ECObjects.d.ts +162 -162
  36. package/lib/cjs/ECObjects.js +453 -453
  37. package/lib/cjs/ECObjects.js.map +1 -1
  38. package/lib/cjs/Exception.d.ts +43 -43
  39. package/lib/cjs/Exception.js +86 -86
  40. package/lib/cjs/Exception.js.map +1 -1
  41. package/lib/cjs/Interfaces.d.ts +66 -66
  42. package/lib/cjs/Interfaces.js +9 -9
  43. package/lib/cjs/Interfaces.js.map +1 -1
  44. package/lib/cjs/Metadata/Class.d.ts +243 -243
  45. package/lib/cjs/Metadata/Class.js +558 -558
  46. package/lib/cjs/Metadata/Class.js.map +1 -1
  47. package/lib/cjs/Metadata/Constant.d.ts +64 -64
  48. package/lib/cjs/Metadata/Constant.js +123 -123
  49. package/lib/cjs/Metadata/Constant.js.map +1 -1
  50. package/lib/cjs/Metadata/CustomAttribute.d.ts +23 -23
  51. package/lib/cjs/Metadata/CustomAttribute.d.ts.map +1 -1
  52. package/lib/cjs/Metadata/CustomAttribute.js +27 -27
  53. package/lib/cjs/Metadata/CustomAttribute.js.map +1 -1
  54. package/lib/cjs/Metadata/CustomAttributeClass.d.ts +39 -39
  55. package/lib/cjs/Metadata/CustomAttributeClass.js +68 -68
  56. package/lib/cjs/Metadata/CustomAttributeClass.js.map +1 -1
  57. package/lib/cjs/Metadata/EntityClass.d.ts +77 -77
  58. package/lib/cjs/Metadata/EntityClass.js +230 -230
  59. package/lib/cjs/Metadata/EntityClass.js.map +1 -1
  60. package/lib/cjs/Metadata/Enumeration.d.ts +86 -86
  61. package/lib/cjs/Metadata/Enumeration.js +159 -159
  62. package/lib/cjs/Metadata/Enumeration.js.map +1 -1
  63. package/lib/cjs/Metadata/Format.d.ts +98 -98
  64. package/lib/cjs/Metadata/Format.d.ts.map +1 -1
  65. package/lib/cjs/Metadata/Format.js +242 -242
  66. package/lib/cjs/Metadata/Format.js.map +1 -1
  67. package/lib/cjs/Metadata/InvertedUnit.d.ts +49 -49
  68. package/lib/cjs/Metadata/InvertedUnit.js +97 -97
  69. package/lib/cjs/Metadata/InvertedUnit.js.map +1 -1
  70. package/lib/cjs/Metadata/KindOfQuantity.d.ts +65 -65
  71. package/lib/cjs/Metadata/KindOfQuantity.js +225 -225
  72. package/lib/cjs/Metadata/KindOfQuantity.js.map +1 -1
  73. package/lib/cjs/Metadata/Mixin.d.ts +54 -54
  74. package/lib/cjs/Metadata/Mixin.js +113 -113
  75. package/lib/cjs/Metadata/Mixin.js.map +1 -1
  76. package/lib/cjs/Metadata/OverrideFormat.d.ts +55 -55
  77. package/lib/cjs/Metadata/OverrideFormat.js +88 -88
  78. package/lib/cjs/Metadata/OverrideFormat.js.map +1 -1
  79. package/lib/cjs/Metadata/Phenomenon.d.ts +33 -33
  80. package/lib/cjs/Metadata/Phenomenon.js +59 -59
  81. package/lib/cjs/Metadata/Phenomenon.js.map +1 -1
  82. package/lib/cjs/Metadata/Property.d.ts +197 -197
  83. package/lib/cjs/Metadata/Property.js +491 -491
  84. package/lib/cjs/Metadata/Property.js.map +1 -1
  85. package/lib/cjs/Metadata/PropertyCategory.d.ts +39 -39
  86. package/lib/cjs/Metadata/PropertyCategory.js +61 -61
  87. package/lib/cjs/Metadata/PropertyCategory.js.map +1 -1
  88. package/lib/cjs/Metadata/RelationshipClass.d.ts +152 -152
  89. package/lib/cjs/Metadata/RelationshipClass.js +349 -349
  90. package/lib/cjs/Metadata/RelationshipClass.js.map +1 -1
  91. package/lib/cjs/Metadata/Schema.d.ts +291 -291
  92. package/lib/cjs/Metadata/Schema.js +520 -520
  93. package/lib/cjs/Metadata/Schema.js.map +1 -1
  94. package/lib/cjs/Metadata/SchemaItem.d.ts +61 -61
  95. package/lib/cjs/Metadata/SchemaItem.js +136 -136
  96. package/lib/cjs/Metadata/SchemaItem.js.map +1 -1
  97. package/lib/cjs/Metadata/Unit.d.ts +76 -76
  98. package/lib/cjs/Metadata/Unit.js +162 -162
  99. package/lib/cjs/Metadata/UnitSystem.d.ts +20 -20
  100. package/lib/cjs/Metadata/UnitSystem.js +29 -29
  101. package/lib/cjs/Metadata/UnitSystem.js.map +1 -1
  102. package/lib/cjs/PropertyTypes.d.ts +49 -49
  103. package/lib/cjs/PropertyTypes.d.ts.map +1 -1
  104. package/lib/cjs/PropertyTypes.js +91 -75
  105. package/lib/cjs/PropertyTypes.js.map +1 -1
  106. package/lib/cjs/SchemaJsonLocater.d.ts +35 -0
  107. package/lib/cjs/SchemaJsonLocater.d.ts.map +1 -0
  108. package/lib/cjs/SchemaJsonLocater.js +43 -0
  109. package/lib/cjs/SchemaJsonLocater.js.map +1 -0
  110. package/lib/cjs/SchemaKey.d.ts +110 -110
  111. package/lib/cjs/SchemaKey.d.ts.map +1 -1
  112. package/lib/cjs/SchemaKey.js +219 -220
  113. package/lib/cjs/SchemaKey.js.map +1 -1
  114. package/lib/cjs/SchemaLoader.d.ts +24 -0
  115. package/lib/cjs/SchemaLoader.d.ts.map +1 -0
  116. package/lib/cjs/SchemaLoader.js +48 -0
  117. package/lib/cjs/SchemaLoader.js.map +1 -0
  118. package/lib/cjs/SchemaPartVisitorDelegate.d.ts +274 -274
  119. package/lib/cjs/SchemaPartVisitorDelegate.js +212 -212
  120. package/lib/cjs/SchemaPartVisitorDelegate.js.map +1 -1
  121. package/lib/cjs/UnitConversion/Graph.d.ts +34 -34
  122. package/lib/cjs/UnitConversion/Graph.js +83 -83
  123. package/lib/cjs/UnitConversion/Graph.js.map +1 -1
  124. package/lib/cjs/UnitConversion/Parser.d.ts +8 -8
  125. package/lib/cjs/UnitConversion/Parser.d.ts.map +1 -1
  126. package/lib/cjs/UnitConversion/Parser.js +42 -41
  127. package/lib/cjs/UnitConversion/Parser.js.map +1 -1
  128. package/lib/cjs/UnitConversion/UnitConversion.d.ts +45 -45
  129. package/lib/cjs/UnitConversion/UnitConversion.js +77 -77
  130. package/lib/cjs/UnitConversion/UnitConversion.js.map +1 -1
  131. package/lib/cjs/UnitConversion/UnitConverter.d.ts +39 -39
  132. package/lib/cjs/UnitConversion/UnitConverter.d.ts.map +1 -1
  133. package/lib/cjs/UnitConversion/UnitConverter.js +116 -116
  134. package/lib/cjs/UnitConversion/UnitConverter.js.map +1 -1
  135. package/lib/cjs/UnitConversion/UnitTree.d.ts +43 -43
  136. package/lib/cjs/UnitConversion/UnitTree.d.ts.map +1 -1
  137. package/lib/cjs/UnitConversion/UnitTree.js +169 -169
  138. package/lib/cjs/UnitConversion/UnitTree.js.map +1 -1
  139. package/lib/cjs/UnitProvider/SchemaUnitProvider.d.ts +77 -77
  140. package/lib/cjs/UnitProvider/SchemaUnitProvider.js +236 -236
  141. package/lib/cjs/UnitProvider/SchemaUnitProvider.js.map +1 -1
  142. package/lib/cjs/Validation/SchemaWalker.d.ts +23 -23
  143. package/lib/cjs/Validation/SchemaWalker.js +53 -53
  144. package/lib/cjs/Validation/SchemaWalker.js.map +1 -1
  145. package/lib/cjs/ecschema-metadata.d.ts +51 -49
  146. package/lib/cjs/ecschema-metadata.d.ts.map +1 -1
  147. package/lib/cjs/ecschema-metadata.js +96 -94
  148. package/lib/cjs/ecschema-metadata.js.map +1 -1
  149. package/lib/cjs/utils/SchemaGraph.d.ts +25 -25
  150. package/lib/cjs/utils/SchemaGraph.d.ts.map +1 -1
  151. package/lib/cjs/utils/SchemaGraph.js +65 -65
  152. package/lib/cjs/utils/SchemaGraph.js.map +1 -1
  153. package/package.json +8 -8
@@ -1,283 +1,283 @@
1
- /** @packageDocumentation
2
- * @module Metadata
3
- */
4
- /**
5
- * @beta
6
- */
7
- export declare type AnyPropertyProps = PrimitivePropertyProps | StructPropertyProps | PrimitiveArrayPropertyProps | StructArrayPropertyProps | NavigationPropertyProps;
8
- /**
9
- * @beta
10
- */
11
- export declare type AnyClassProps = EntityClassProps | MixinProps | CustomAttributeClassProps | RelationshipClassProps;
12
- /**
13
- * @beta
14
- */
15
- export declare type AnySchemaItemProps = AnyClassProps | EnumerationProps | KindOfQuantityProps | PropertyCategoryProps | UnitProps | InvertedUnitProps | ConstantProps | PhenomenonProps | FormatProps;
16
- /**
17
- * @beta
18
- */
19
- export interface SchemaProps {
20
- readonly $schema: string;
21
- readonly name: string;
22
- readonly version: string;
23
- readonly alias: string;
24
- readonly label?: string;
25
- readonly description?: string;
26
- readonly references?: SchemaReferenceProps[];
27
- readonly items?: {
28
- [name: string]: SchemaItemProps;
29
- };
30
- readonly customAttributes?: Array<{
31
- [value: string]: any;
32
- }>;
33
- }
34
- /**
35
- * JSON Object interface used to deserialize into a [[SchemaKey]].
36
- * @beta
37
- */
38
- export interface SchemaKeyProps {
39
- /** The schema name */
40
- readonly name: string;
41
- /** Read version of the schema */
42
- readonly read: number;
43
- /** Write version of the schema */
44
- readonly write: number;
45
- /** Minor version of the schema */
46
- readonly minor: number;
47
- }
48
- /**
49
- * @beta
50
- */
51
- export interface SchemaReferenceProps {
52
- readonly name: string;
53
- readonly version: string;
54
- }
55
- /**
56
- * @beta
57
- */
58
- export interface SchemaItemProps {
59
- readonly $schema?: string;
60
- readonly schema?: string;
61
- readonly schemaVersion?: string;
62
- readonly name?: string;
63
- readonly schemaItemType?: string;
64
- readonly label?: string;
65
- readonly description?: string;
66
- readonly customAttributes?: Array<{
67
- [value: string]: any;
68
- }>;
69
- }
70
- /**
71
- * @beta
72
- */
73
- export interface ClassProps extends SchemaItemProps {
74
- readonly modifier?: string;
75
- readonly baseClass?: string;
76
- readonly properties?: AnyPropertyProps[];
77
- }
78
- /**
79
- * @beta
80
- */
81
- export interface EntityClassProps extends ClassProps {
82
- readonly mixins?: string[];
83
- }
84
- /**
85
- * @beta
86
- */
87
- export interface MixinProps extends ClassProps {
88
- readonly appliesTo: string;
89
- }
90
- /**
91
- * @beta
92
- */
93
- export declare type StructClassProps = ClassProps;
94
- /**
95
- * @beta
96
- */
97
- export interface CustomAttributeClassProps extends ClassProps {
98
- readonly appliesTo: string;
99
- }
100
- /**
101
- * @beta
102
- */
103
- export interface RelationshipClassProps extends ClassProps {
104
- readonly strength: string;
105
- readonly strengthDirection: string;
106
- readonly source: RelationshipConstraintProps;
107
- readonly target: RelationshipConstraintProps;
108
- }
109
- /**
110
- * @beta
111
- */
112
- export interface RelationshipConstraintProps {
113
- readonly multiplicity: string;
114
- readonly roleLabel: string;
115
- readonly polymorphic: boolean;
116
- readonly abstractConstraint?: string;
117
- readonly constraintClasses: string[];
118
- }
119
- /**
120
- * @beta
121
- */
122
- export interface EnumerationProps extends SchemaItemProps {
123
- readonly type: string;
124
- readonly isStrict: boolean;
125
- readonly enumerators: EnumeratorProps[];
126
- }
127
- /**
128
- * @beta
129
- */
130
- export interface EnumeratorProps {
131
- readonly name: string;
132
- readonly value: string | number;
133
- readonly label?: string;
134
- readonly description?: string;
135
- }
136
- /**
137
- * @beta
138
- */
139
- export interface KindOfQuantityProps extends SchemaItemProps {
140
- readonly persistenceUnit: string;
141
- readonly presentationUnits?: string | string[];
142
- readonly relativeError: number;
143
- }
144
- /**
145
- * @beta
146
- */
147
- export interface PropertyCategoryProps extends SchemaItemProps {
148
- readonly priority: number;
149
- }
150
- /**
151
- * @beta
152
- */
153
- export interface PropertyProps {
154
- readonly name: string;
155
- readonly type: string;
156
- readonly description?: string;
157
- readonly label?: string;
158
- readonly isReadOnly?: boolean;
159
- readonly category?: string;
160
- readonly priority?: number;
161
- readonly inherited?: boolean;
162
- readonly kindOfQuantity?: string;
163
- readonly customAttributes?: Array<{
164
- [value: string]: any;
165
- }>;
166
- }
167
- /**
168
- * @beta
169
- */
170
- export interface PrimitiveOrEnumPropertyBaseProps extends PropertyProps {
171
- readonly extendedTypeName?: string;
172
- readonly minLength?: number;
173
- readonly maxLength?: number;
174
- readonly minValue?: number;
175
- readonly maxValue?: number;
176
- }
177
- /**
178
- * @beta
179
- */
180
- export interface PrimitivePropertyProps extends PrimitiveOrEnumPropertyBaseProps {
181
- readonly typeName: string;
182
- }
183
- /**
184
- * @beta
185
- */
186
- export interface StructPropertyProps extends PropertyProps {
187
- readonly typeName: string;
188
- }
189
- /**
190
- * @beta
191
- */
192
- export interface EnumerationPropertyProps extends PrimitiveOrEnumPropertyBaseProps {
193
- readonly typeName: string;
194
- }
195
- /**
196
- * @beta
197
- */
198
- export interface ArrayPropertyProps extends PrimitiveOrEnumPropertyBaseProps {
199
- readonly minOccurs?: number;
200
- readonly maxOccurs?: number;
201
- }
202
- /**
203
- * @beta
204
- */
205
- export interface PrimitiveArrayPropertyProps extends ArrayPropertyProps {
206
- readonly typeName: string;
207
- }
208
- /**
209
- * @beta
210
- */
211
- export interface StructArrayPropertyProps extends ArrayPropertyProps {
212
- readonly typeName: string;
213
- }
214
- /**
215
- * @beta
216
- */
217
- export interface NavigationPropertyProps extends PropertyProps {
218
- readonly relationshipName: string;
219
- readonly direction: string;
220
- }
221
- /**
222
- * @beta
223
- */
224
- export interface ConstantProps extends SchemaItemProps {
225
- readonly phenomenon: string;
226
- readonly definition: string;
227
- readonly numerator?: number;
228
- readonly denominator?: number;
229
- }
230
- /**
231
- * @beta
232
- */
233
- export interface FormatProps extends SchemaItemProps {
234
- readonly type: string;
235
- readonly precision?: number;
236
- readonly roundFactor?: number;
237
- readonly minWidth?: number;
238
- readonly showSignOption?: string;
239
- readonly formatTraits?: string | string[];
240
- readonly decimalSeparator?: string;
241
- readonly thousandSeparator?: string;
242
- readonly uomSeparator?: string;
243
- readonly scientificType?: string;
244
- readonly stationOffsetSize?: number;
245
- readonly stationSeparator?: string;
246
- readonly composite?: {
247
- readonly spacer?: string;
248
- readonly includeZero?: boolean;
249
- readonly units: Array<{
250
- readonly name: string;
251
- readonly label?: string;
252
- }>;
253
- };
254
- }
255
- /**
256
- * @beta
257
- */
258
- export interface InvertedUnitProps extends SchemaItemProps {
259
- readonly invertsUnit: string;
260
- readonly unitSystem: string;
261
- }
262
- /**
263
- * @beta
264
- */
265
- export interface PhenomenonProps extends SchemaItemProps {
266
- readonly definition: string;
267
- }
268
- /**
269
- * @beta
270
- */
271
- export declare type UnitSystemProps = SchemaItemProps;
272
- /**
273
- * @beta
274
- */
275
- export interface UnitProps extends SchemaItemProps {
276
- readonly phenomenon: string;
277
- readonly unitSystem: string;
278
- readonly definition: string;
279
- readonly numerator?: number;
280
- readonly denominator?: number;
281
- readonly offset?: number;
282
- }
1
+ /** @packageDocumentation
2
+ * @module Metadata
3
+ */
4
+ /**
5
+ * @beta
6
+ */
7
+ export declare type AnyPropertyProps = PrimitivePropertyProps | StructPropertyProps | PrimitiveArrayPropertyProps | StructArrayPropertyProps | NavigationPropertyProps;
8
+ /**
9
+ * @beta
10
+ */
11
+ export declare type AnyClassProps = EntityClassProps | MixinProps | CustomAttributeClassProps | RelationshipClassProps;
12
+ /**
13
+ * @beta
14
+ */
15
+ export declare type AnySchemaItemProps = AnyClassProps | EnumerationProps | KindOfQuantityProps | PropertyCategoryProps | UnitProps | InvertedUnitProps | ConstantProps | PhenomenonProps | FormatProps;
16
+ /**
17
+ * @beta
18
+ */
19
+ export interface SchemaProps {
20
+ readonly $schema: string;
21
+ readonly name: string;
22
+ readonly version: string;
23
+ readonly alias: string;
24
+ readonly label?: string;
25
+ readonly description?: string;
26
+ readonly references?: SchemaReferenceProps[];
27
+ readonly items?: {
28
+ [name: string]: SchemaItemProps;
29
+ };
30
+ readonly customAttributes?: Array<{
31
+ [value: string]: any;
32
+ }>;
33
+ }
34
+ /**
35
+ * JSON Object interface used to deserialize into a [[SchemaKey]].
36
+ * @beta
37
+ */
38
+ export interface SchemaKeyProps {
39
+ /** The schema name */
40
+ readonly name: string;
41
+ /** Read version of the schema */
42
+ readonly read: number;
43
+ /** Write version of the schema */
44
+ readonly write: number;
45
+ /** Minor version of the schema */
46
+ readonly minor: number;
47
+ }
48
+ /**
49
+ * @beta
50
+ */
51
+ export interface SchemaReferenceProps {
52
+ readonly name: string;
53
+ readonly version: string;
54
+ }
55
+ /**
56
+ * @beta
57
+ */
58
+ export interface SchemaItemProps {
59
+ readonly $schema?: string;
60
+ readonly schema?: string;
61
+ readonly schemaVersion?: string;
62
+ readonly name?: string;
63
+ readonly schemaItemType?: string;
64
+ readonly label?: string;
65
+ readonly description?: string;
66
+ readonly customAttributes?: Array<{
67
+ [value: string]: any;
68
+ }>;
69
+ }
70
+ /**
71
+ * @beta
72
+ */
73
+ export interface ClassProps extends SchemaItemProps {
74
+ readonly modifier?: string;
75
+ readonly baseClass?: string;
76
+ readonly properties?: AnyPropertyProps[];
77
+ }
78
+ /**
79
+ * @beta
80
+ */
81
+ export interface EntityClassProps extends ClassProps {
82
+ readonly mixins?: string[];
83
+ }
84
+ /**
85
+ * @beta
86
+ */
87
+ export interface MixinProps extends ClassProps {
88
+ readonly appliesTo: string;
89
+ }
90
+ /**
91
+ * @beta
92
+ */
93
+ export declare type StructClassProps = ClassProps;
94
+ /**
95
+ * @beta
96
+ */
97
+ export interface CustomAttributeClassProps extends ClassProps {
98
+ readonly appliesTo: string;
99
+ }
100
+ /**
101
+ * @beta
102
+ */
103
+ export interface RelationshipClassProps extends ClassProps {
104
+ readonly strength: string;
105
+ readonly strengthDirection: string;
106
+ readonly source: RelationshipConstraintProps;
107
+ readonly target: RelationshipConstraintProps;
108
+ }
109
+ /**
110
+ * @beta
111
+ */
112
+ export interface RelationshipConstraintProps {
113
+ readonly multiplicity: string;
114
+ readonly roleLabel: string;
115
+ readonly polymorphic: boolean;
116
+ readonly abstractConstraint?: string;
117
+ readonly constraintClasses: string[];
118
+ }
119
+ /**
120
+ * @beta
121
+ */
122
+ export interface EnumerationProps extends SchemaItemProps {
123
+ readonly type: string;
124
+ readonly isStrict: boolean;
125
+ readonly enumerators: EnumeratorProps[];
126
+ }
127
+ /**
128
+ * @beta
129
+ */
130
+ export interface EnumeratorProps {
131
+ readonly name: string;
132
+ readonly value: string | number;
133
+ readonly label?: string;
134
+ readonly description?: string;
135
+ }
136
+ /**
137
+ * @beta
138
+ */
139
+ export interface KindOfQuantityProps extends SchemaItemProps {
140
+ readonly persistenceUnit: string;
141
+ readonly presentationUnits?: string | string[];
142
+ readonly relativeError: number;
143
+ }
144
+ /**
145
+ * @beta
146
+ */
147
+ export interface PropertyCategoryProps extends SchemaItemProps {
148
+ readonly priority: number;
149
+ }
150
+ /**
151
+ * @beta
152
+ */
153
+ export interface PropertyProps {
154
+ readonly name: string;
155
+ readonly type: string;
156
+ readonly description?: string;
157
+ readonly label?: string;
158
+ readonly isReadOnly?: boolean;
159
+ readonly category?: string;
160
+ readonly priority?: number;
161
+ readonly inherited?: boolean;
162
+ readonly kindOfQuantity?: string;
163
+ readonly customAttributes?: Array<{
164
+ [value: string]: any;
165
+ }>;
166
+ }
167
+ /**
168
+ * @beta
169
+ */
170
+ export interface PrimitiveOrEnumPropertyBaseProps extends PropertyProps {
171
+ readonly extendedTypeName?: string;
172
+ readonly minLength?: number;
173
+ readonly maxLength?: number;
174
+ readonly minValue?: number;
175
+ readonly maxValue?: number;
176
+ }
177
+ /**
178
+ * @beta
179
+ */
180
+ export interface PrimitivePropertyProps extends PrimitiveOrEnumPropertyBaseProps {
181
+ readonly typeName: string;
182
+ }
183
+ /**
184
+ * @beta
185
+ */
186
+ export interface StructPropertyProps extends PropertyProps {
187
+ readonly typeName: string;
188
+ }
189
+ /**
190
+ * @beta
191
+ */
192
+ export interface EnumerationPropertyProps extends PrimitiveOrEnumPropertyBaseProps {
193
+ readonly typeName: string;
194
+ }
195
+ /**
196
+ * @beta
197
+ */
198
+ export interface ArrayPropertyProps extends PrimitiveOrEnumPropertyBaseProps {
199
+ readonly minOccurs?: number;
200
+ readonly maxOccurs?: number;
201
+ }
202
+ /**
203
+ * @beta
204
+ */
205
+ export interface PrimitiveArrayPropertyProps extends ArrayPropertyProps {
206
+ readonly typeName: string;
207
+ }
208
+ /**
209
+ * @beta
210
+ */
211
+ export interface StructArrayPropertyProps extends ArrayPropertyProps {
212
+ readonly typeName: string;
213
+ }
214
+ /**
215
+ * @beta
216
+ */
217
+ export interface NavigationPropertyProps extends PropertyProps {
218
+ readonly relationshipName: string;
219
+ readonly direction: string;
220
+ }
221
+ /**
222
+ * @beta
223
+ */
224
+ export interface ConstantProps extends SchemaItemProps {
225
+ readonly phenomenon: string;
226
+ readonly definition: string;
227
+ readonly numerator?: number;
228
+ readonly denominator?: number;
229
+ }
230
+ /**
231
+ * @beta
232
+ */
233
+ export interface FormatProps extends SchemaItemProps {
234
+ readonly type: string;
235
+ readonly precision?: number;
236
+ readonly roundFactor?: number;
237
+ readonly minWidth?: number;
238
+ readonly showSignOption?: string;
239
+ readonly formatTraits?: string | string[];
240
+ readonly decimalSeparator?: string;
241
+ readonly thousandSeparator?: string;
242
+ readonly uomSeparator?: string;
243
+ readonly scientificType?: string;
244
+ readonly stationOffsetSize?: number;
245
+ readonly stationSeparator?: string;
246
+ readonly composite?: {
247
+ readonly spacer?: string;
248
+ readonly includeZero?: boolean;
249
+ readonly units: Array<{
250
+ readonly name: string;
251
+ readonly label?: string;
252
+ }>;
253
+ };
254
+ }
255
+ /**
256
+ * @beta
257
+ */
258
+ export interface InvertedUnitProps extends SchemaItemProps {
259
+ readonly invertsUnit: string;
260
+ readonly unitSystem: string;
261
+ }
262
+ /**
263
+ * @beta
264
+ */
265
+ export interface PhenomenonProps extends SchemaItemProps {
266
+ readonly definition: string;
267
+ }
268
+ /**
269
+ * @beta
270
+ */
271
+ export declare type UnitSystemProps = SchemaItemProps;
272
+ /**
273
+ * @beta
274
+ */
275
+ export interface UnitProps extends SchemaItemProps {
276
+ readonly phenomenon: string;
277
+ readonly unitSystem: string;
278
+ readonly definition: string;
279
+ readonly numerator?: number;
280
+ readonly denominator?: number;
281
+ readonly offset?: number;
282
+ }
283
283
  //# sourceMappingURL=JsonProps.d.ts.map
@@ -1,10 +1,10 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- /** @packageDocumentation
7
- * @module Metadata
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ /** @packageDocumentation
7
+ * @module Metadata
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
10
  //# sourceMappingURL=JsonProps.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"JsonProps.js","sourceRoot":"","sources":["../../../src/Deserialization/JsonProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\n/**\r\n * @beta\r\n */\r\nexport type AnyPropertyProps = PrimitivePropertyProps | StructPropertyProps | PrimitiveArrayPropertyProps | StructArrayPropertyProps | NavigationPropertyProps;\r\n/**\r\n * @beta\r\n */\r\nexport type AnyClassProps = EntityClassProps | MixinProps | CustomAttributeClassProps | RelationshipClassProps;\r\n/**\r\n * @beta\r\n */\r\nexport type AnySchemaItemProps = AnyClassProps | EnumerationProps | KindOfQuantityProps | PropertyCategoryProps | UnitProps | InvertedUnitProps | ConstantProps | PhenomenonProps | FormatProps;\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface SchemaProps {\r\n readonly $schema: string;\r\n readonly name: string;\r\n readonly version: string;\r\n readonly alias: string;\r\n readonly label?: string;\r\n readonly description?: string;\r\n readonly references?: SchemaReferenceProps[];\r\n readonly items?: { [name: string]: SchemaItemProps };\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n}\r\n\r\n/**\r\n * JSON Object interface used to deserialize into a [[SchemaKey]].\r\n * @beta\r\n */\r\nexport interface SchemaKeyProps {\r\n /** The schema name */\r\n readonly name: string;\r\n /** Read version of the schema */\r\n readonly read: number;\r\n /** Write version of the schema */\r\n readonly write: number;\r\n /** Minor version of the schema */\r\n readonly minor: number;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface SchemaReferenceProps {\r\n readonly name: string;\r\n readonly version: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface SchemaItemProps {\r\n // NEEDSWORK: Still need to clarify how single-item deserialization works...\r\n readonly $schema?: string;\r\n readonly schema?: string; // conditionally required\r\n readonly schemaVersion?: string;\r\n readonly name?: string;\r\n readonly schemaItemType?: string;\r\n readonly label?: string;\r\n readonly description?: string;\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface ClassProps extends SchemaItemProps {\r\n readonly modifier?: string;\r\n readonly baseClass?: string;\r\n readonly properties?: AnyPropertyProps[];\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface EntityClassProps extends ClassProps {\r\n readonly mixins?: string[];\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface MixinProps extends ClassProps {\r\n readonly appliesTo: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport type StructClassProps = ClassProps;\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface CustomAttributeClassProps extends ClassProps {\r\n readonly appliesTo: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface RelationshipClassProps extends ClassProps {\r\n readonly strength: string;\r\n readonly strengthDirection: string;\r\n readonly source: RelationshipConstraintProps;\r\n readonly target: RelationshipConstraintProps;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface RelationshipConstraintProps {\r\n readonly multiplicity: string;\r\n readonly roleLabel: string;\r\n readonly polymorphic: boolean;\r\n readonly abstractConstraint?: string;\r\n readonly constraintClasses: string[];\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface EnumerationProps extends SchemaItemProps {\r\n readonly type: string;\r\n readonly isStrict: boolean;\r\n readonly enumerators: EnumeratorProps[];\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface EnumeratorProps {\r\n readonly name: string;\r\n readonly value: string | number;\r\n readonly label?: string;\r\n readonly description?: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface KindOfQuantityProps extends SchemaItemProps {\r\n readonly persistenceUnit: string;\r\n readonly presentationUnits?: string | string[];\r\n readonly relativeError: number;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface PropertyCategoryProps extends SchemaItemProps {\r\n readonly priority: number;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface PropertyProps {\r\n readonly name: string;\r\n readonly type: string;\r\n readonly description?: string;\r\n readonly label?: string;\r\n readonly isReadOnly?: boolean;\r\n readonly category?: string;\r\n readonly priority?: number;\r\n readonly inherited?: boolean;\r\n readonly kindOfQuantity?: string;\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface PrimitiveOrEnumPropertyBaseProps extends PropertyProps {\r\n readonly extendedTypeName?: string;\r\n readonly minLength?: number;\r\n readonly maxLength?: number;\r\n readonly minValue?: number;\r\n readonly maxValue?: number;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface PrimitivePropertyProps extends PrimitiveOrEnumPropertyBaseProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface StructPropertyProps extends PropertyProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface EnumerationPropertyProps extends PrimitiveOrEnumPropertyBaseProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface ArrayPropertyProps extends PrimitiveOrEnumPropertyBaseProps {\r\n readonly minOccurs?: number;\r\n readonly maxOccurs?: number;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface PrimitiveArrayPropertyProps extends ArrayPropertyProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface StructArrayPropertyProps extends ArrayPropertyProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface NavigationPropertyProps extends PropertyProps {\r\n readonly relationshipName: string;\r\n readonly direction: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface ConstantProps extends SchemaItemProps {\r\n readonly phenomenon: string;\r\n readonly definition: string;\r\n readonly numerator?: number;\r\n readonly denominator?: number;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface FormatProps extends SchemaItemProps {\r\n readonly type: string;\r\n readonly precision?: number;\r\n readonly roundFactor?: number;\r\n readonly minWidth?: number;\r\n readonly showSignOption?: string;\r\n readonly formatTraits?: string | string[];\r\n readonly decimalSeparator?: string;\r\n readonly thousandSeparator?: string;\r\n readonly uomSeparator?: string;\r\n readonly scientificType?: string; // conditionally required\r\n readonly stationOffsetSize?: number; // conditionally required\r\n readonly stationSeparator?: string;\r\n readonly composite?: {\r\n readonly spacer?: string;\r\n readonly includeZero?: boolean;\r\n readonly units: Array<{\r\n readonly name: string;\r\n readonly label?: string;\r\n }>;\r\n };\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface InvertedUnitProps extends SchemaItemProps {\r\n readonly invertsUnit: string;\r\n readonly unitSystem: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface PhenomenonProps extends SchemaItemProps {\r\n readonly definition: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport type UnitSystemProps = SchemaItemProps;\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface UnitProps extends SchemaItemProps {\r\n readonly phenomenon: string;\r\n readonly unitSystem: string;\r\n readonly definition: string;\r\n readonly numerator?: number;\r\n readonly denominator?: number;\r\n readonly offset?: number;\r\n}\r\n"]}
1
+ {"version":3,"file":"JsonProps.js","sourceRoot":"","sources":["../../../src/Deserialization/JsonProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\n/**\n * @beta\n */\nexport type AnyPropertyProps = PrimitivePropertyProps | StructPropertyProps | PrimitiveArrayPropertyProps | StructArrayPropertyProps | NavigationPropertyProps;\n/**\n * @beta\n */\nexport type AnyClassProps = EntityClassProps | MixinProps | CustomAttributeClassProps | RelationshipClassProps;\n/**\n * @beta\n */\nexport type AnySchemaItemProps = AnyClassProps | EnumerationProps | KindOfQuantityProps | PropertyCategoryProps | UnitProps | InvertedUnitProps | ConstantProps | PhenomenonProps | FormatProps;\n\n/**\n * @beta\n */\nexport interface SchemaProps {\n readonly $schema: string;\n readonly name: string;\n readonly version: string;\n readonly alias: string;\n readonly label?: string;\n readonly description?: string;\n readonly references?: SchemaReferenceProps[];\n readonly items?: { [name: string]: SchemaItemProps };\n readonly customAttributes?: Array<{ [value: string]: any }>;\n}\n\n/**\n * JSON Object interface used to deserialize into a [[SchemaKey]].\n * @beta\n */\nexport interface SchemaKeyProps {\n /** The schema name */\n readonly name: string;\n /** Read version of the schema */\n readonly read: number;\n /** Write version of the schema */\n readonly write: number;\n /** Minor version of the schema */\n readonly minor: number;\n}\n\n/**\n * @beta\n */\nexport interface SchemaReferenceProps {\n readonly name: string;\n readonly version: string;\n}\n\n/**\n * @beta\n */\nexport interface SchemaItemProps {\n // NEEDSWORK: Still need to clarify how single-item deserialization works...\n readonly $schema?: string;\n readonly schema?: string; // conditionally required\n readonly schemaVersion?: string;\n readonly name?: string;\n readonly schemaItemType?: string;\n readonly label?: string;\n readonly description?: string;\n readonly customAttributes?: Array<{ [value: string]: any }>;\n}\n\n/**\n * @beta\n */\nexport interface ClassProps extends SchemaItemProps {\n readonly modifier?: string;\n readonly baseClass?: string;\n readonly properties?: AnyPropertyProps[];\n}\n\n/**\n * @beta\n */\nexport interface EntityClassProps extends ClassProps {\n readonly mixins?: string[];\n}\n\n/**\n * @beta\n */\nexport interface MixinProps extends ClassProps {\n readonly appliesTo: string;\n}\n\n/**\n * @beta\n */\nexport type StructClassProps = ClassProps;\n\n/**\n * @beta\n */\nexport interface CustomAttributeClassProps extends ClassProps {\n readonly appliesTo: string;\n}\n\n/**\n * @beta\n */\nexport interface RelationshipClassProps extends ClassProps {\n readonly strength: string;\n readonly strengthDirection: string;\n readonly source: RelationshipConstraintProps;\n readonly target: RelationshipConstraintProps;\n}\n\n/**\n * @beta\n */\nexport interface RelationshipConstraintProps {\n readonly multiplicity: string;\n readonly roleLabel: string;\n readonly polymorphic: boolean;\n readonly abstractConstraint?: string;\n readonly constraintClasses: string[];\n}\n\n/**\n * @beta\n */\nexport interface EnumerationProps extends SchemaItemProps {\n readonly type: string;\n readonly isStrict: boolean;\n readonly enumerators: EnumeratorProps[];\n}\n\n/**\n * @beta\n */\nexport interface EnumeratorProps {\n readonly name: string;\n readonly value: string | number;\n readonly label?: string;\n readonly description?: string;\n}\n\n/**\n * @beta\n */\nexport interface KindOfQuantityProps extends SchemaItemProps {\n readonly persistenceUnit: string;\n readonly presentationUnits?: string | string[];\n readonly relativeError: number;\n}\n\n/**\n * @beta\n */\nexport interface PropertyCategoryProps extends SchemaItemProps {\n readonly priority: number;\n}\n\n/**\n * @beta\n */\nexport interface PropertyProps {\n readonly name: string;\n readonly type: string;\n readonly description?: string;\n readonly label?: string;\n readonly isReadOnly?: boolean;\n readonly category?: string;\n readonly priority?: number;\n readonly inherited?: boolean;\n readonly kindOfQuantity?: string;\n readonly customAttributes?: Array<{ [value: string]: any }>;\n}\n\n/**\n * @beta\n */\nexport interface PrimitiveOrEnumPropertyBaseProps extends PropertyProps {\n readonly extendedTypeName?: string;\n readonly minLength?: number;\n readonly maxLength?: number;\n readonly minValue?: number;\n readonly maxValue?: number;\n}\n\n/**\n * @beta\n */\nexport interface PrimitivePropertyProps extends PrimitiveOrEnumPropertyBaseProps {\n readonly typeName: string;\n}\n\n/**\n * @beta\n */\nexport interface StructPropertyProps extends PropertyProps {\n readonly typeName: string;\n}\n\n/**\n * @beta\n */\nexport interface EnumerationPropertyProps extends PrimitiveOrEnumPropertyBaseProps {\n readonly typeName: string;\n}\n\n/**\n * @beta\n */\nexport interface ArrayPropertyProps extends PrimitiveOrEnumPropertyBaseProps {\n readonly minOccurs?: number;\n readonly maxOccurs?: number;\n}\n\n/**\n * @beta\n */\nexport interface PrimitiveArrayPropertyProps extends ArrayPropertyProps {\n readonly typeName: string;\n}\n\n/**\n * @beta\n */\nexport interface StructArrayPropertyProps extends ArrayPropertyProps {\n readonly typeName: string;\n}\n\n/**\n * @beta\n */\nexport interface NavigationPropertyProps extends PropertyProps {\n readonly relationshipName: string;\n readonly direction: string;\n}\n\n/**\n * @beta\n */\nexport interface ConstantProps extends SchemaItemProps {\n readonly phenomenon: string;\n readonly definition: string;\n readonly numerator?: number;\n readonly denominator?: number;\n}\n\n/**\n * @beta\n */\nexport interface FormatProps extends SchemaItemProps {\n readonly type: string;\n readonly precision?: number;\n readonly roundFactor?: number;\n readonly minWidth?: number;\n readonly showSignOption?: string;\n readonly formatTraits?: string | string[];\n readonly decimalSeparator?: string;\n readonly thousandSeparator?: string;\n readonly uomSeparator?: string;\n readonly scientificType?: string; // conditionally required\n readonly stationOffsetSize?: number; // conditionally required\n readonly stationSeparator?: string;\n readonly composite?: {\n readonly spacer?: string;\n readonly includeZero?: boolean;\n readonly units: Array<{\n readonly name: string;\n readonly label?: string;\n }>;\n };\n}\n\n/**\n * @beta\n */\nexport interface InvertedUnitProps extends SchemaItemProps {\n readonly invertsUnit: string;\n readonly unitSystem: string;\n}\n\n/**\n * @beta\n */\nexport interface PhenomenonProps extends SchemaItemProps {\n readonly definition: string;\n}\n\n/**\n * @beta\n */\nexport type UnitSystemProps = SchemaItemProps;\n\n/**\n * @beta\n */\nexport interface UnitProps extends SchemaItemProps {\n readonly phenomenon: string;\n readonly unitSystem: string;\n readonly definition: string;\n readonly numerator?: number;\n readonly denominator?: number;\n readonly offset?: number;\n}\n"]}