basyx-typescript-sdk 0.2.1 → 0.9.0

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 (155) hide show
  1. package/README.md +5 -3
  2. package/bundle/index.js +17522 -841
  3. package/bundle/index.js.map +1 -1
  4. package/dist/clients/AasDiscoveryClient.d.ts +67 -0
  5. package/dist/clients/AasDiscoveryClient.js +115 -0
  6. package/dist/clients/AasRegistryClient.d.ts +163 -0
  7. package/dist/clients/AasRegistryClient.js +287 -0
  8. package/dist/clients/AasRepositoryClient.d.ts +790 -103
  9. package/dist/clients/AasRepositoryClient.js +1323 -211
  10. package/dist/clients/AasxFileClient.d.ts +81 -0
  11. package/dist/clients/AasxFileClient.js +148 -0
  12. package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +83 -0
  13. package/dist/clients/ConceptDescriptionRepositoryClient.js +143 -0
  14. package/dist/clients/SubmodelRegistryClient.d.ts +77 -0
  15. package/dist/clients/SubmodelRegistryClient.js +138 -0
  16. package/dist/clients/SubmodelRepositoryClient.d.ts +354 -0
  17. package/dist/clients/SubmodelRepositoryClient.js +585 -0
  18. package/dist/clients/index.d.ts +6 -0
  19. package/dist/clients/index.js +6 -0
  20. package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.d.ts +80 -0
  21. package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.js +156 -0
  22. package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.d.ts +26 -0
  23. package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.js +40 -0
  24. package/dist/generated/AasDiscoveryService/apis/index.d.ts +2 -0
  25. package/dist/generated/AasDiscoveryService/apis/index.js +4 -0
  26. package/dist/generated/AasDiscoveryService/index.d.ts +3 -0
  27. package/dist/generated/AasDiscoveryService/index.js +5 -0
  28. package/dist/generated/AasDiscoveryService/models/index.d.ts +297 -0
  29. package/dist/generated/AasDiscoveryService/models/index.js +48 -0
  30. package/dist/generated/AasDiscoveryService/runtime.d.ts +181 -0
  31. package/dist/generated/AasDiscoveryService/runtime.js +326 -0
  32. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.d.ts +139 -0
  33. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.js +312 -0
  34. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
  35. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.js +40 -0
  36. package/dist/generated/AasRegistryService/apis/index.d.ts +2 -0
  37. package/dist/generated/AasRegistryService/apis/index.js +4 -0
  38. package/dist/generated/AasRegistryService/index.d.ts +3 -0
  39. package/dist/generated/AasRegistryService/index.js +5 -0
  40. package/dist/generated/AasRegistryService/models/index.d.ts +1070 -0
  41. package/dist/generated/AasRegistryService/models/index.js +151 -0
  42. package/dist/generated/AasRegistryService/runtime.d.ts +181 -0
  43. package/dist/generated/AasRegistryService/runtime.js +326 -0
  44. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.d.ts +870 -0
  45. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.js +1842 -0
  46. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  47. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.js +40 -0
  48. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  49. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.js +49 -0
  50. package/dist/generated/AasRepositoryService/apis/index.d.ts +3 -0
  51. package/dist/generated/AasRepositoryService/apis/index.js +5 -0
  52. package/dist/generated/AasRepositoryService/index.d.ts +3 -0
  53. package/dist/generated/AasRepositoryService/index.js +5 -0
  54. package/dist/generated/AasRepositoryService/models/index.d.ts +4585 -0
  55. package/dist/generated/AasRepositoryService/models/index.js +221 -0
  56. package/dist/generated/AasRepositoryService/runtime.d.ts +181 -0
  57. package/dist/generated/AasRepositoryService/runtime.js +326 -0
  58. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.d.ts +78 -0
  59. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.js +184 -0
  60. package/dist/generated/AasxFileService/apis/index.d.ts +1 -0
  61. package/dist/generated/AasxFileService/apis/index.js +3 -0
  62. package/dist/generated/AasxFileService/index.d.ts +3 -0
  63. package/dist/generated/AasxFileService/index.js +5 -0
  64. package/dist/generated/AasxFileService/models/index.d.ts +80 -0
  65. package/dist/generated/AasxFileService/models/index.js +10 -0
  66. package/dist/generated/AasxFileService/runtime.d.ts +181 -0
  67. package/dist/generated/AasxFileService/runtime.js +326 -0
  68. package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.d.ts +78 -0
  69. package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.js +164 -0
  70. package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  71. package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.js +40 -0
  72. package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  73. package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.js +49 -0
  74. package/dist/generated/ConceptDescriptionRepositoryService/apis/index.d.ts +3 -0
  75. package/dist/generated/ConceptDescriptionRepositoryService/apis/index.js +5 -0
  76. package/dist/generated/ConceptDescriptionRepositoryService/index.d.ts +3 -0
  77. package/dist/generated/ConceptDescriptionRepositoryService/index.js +5 -0
  78. package/dist/generated/ConceptDescriptionRepositoryService/models/index.d.ts +2869 -0
  79. package/dist/generated/ConceptDescriptionRepositoryService/models/index.js +209 -0
  80. package/dist/generated/ConceptDescriptionRepositoryService/runtime.d.ts +181 -0
  81. package/dist/generated/ConceptDescriptionRepositoryService/runtime.js +326 -0
  82. package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
  83. package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.js +40 -0
  84. package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.d.ts +75 -0
  85. package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.js +155 -0
  86. package/dist/generated/SubmodelRegistryService/apis/index.d.ts +2 -0
  87. package/dist/generated/SubmodelRegistryService/apis/index.js +4 -0
  88. package/dist/generated/SubmodelRegistryService/index.d.ts +3 -0
  89. package/dist/generated/SubmodelRegistryService/index.js +5 -0
  90. package/dist/generated/SubmodelRegistryService/models/index.d.ts +924 -0
  91. package/dist/generated/SubmodelRegistryService/models/index.js +141 -0
  92. package/dist/generated/SubmodelRegistryService/runtime.d.ts +181 -0
  93. package/dist/generated/SubmodelRegistryService/runtime.js +326 -0
  94. package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  95. package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.js +40 -0
  96. package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  97. package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.js +49 -0
  98. package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.d.ts +802 -0
  99. package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.js +1572 -0
  100. package/dist/generated/SubmodelRepositoryService/apis/index.d.ts +3 -0
  101. package/dist/generated/SubmodelRepositoryService/apis/index.js +5 -0
  102. package/dist/generated/SubmodelRepositoryService/index.d.ts +3 -0
  103. package/dist/generated/SubmodelRepositoryService/index.js +5 -0
  104. package/dist/generated/SubmodelRepositoryService/models/index.d.ts +4623 -0
  105. package/dist/generated/SubmodelRepositoryService/models/index.js +221 -0
  106. package/dist/generated/SubmodelRepositoryService/runtime.d.ts +181 -0
  107. package/dist/generated/SubmodelRepositoryService/runtime.js +326 -0
  108. package/dist/generated/index.d.ts +8 -2
  109. package/dist/generated/index.js +8 -3
  110. package/dist/index.d.ts +1 -1
  111. package/dist/index.js +1 -1
  112. package/dist/lib/apiConfig.d.ts +2 -0
  113. package/dist/lib/apiConfig.js +41 -0
  114. package/dist/lib/base64Url.js +4 -0
  115. package/dist/lib/convertAasDescriptorTypes.d.ts +34 -0
  116. package/dist/lib/convertAasDescriptorTypes.js +76 -0
  117. package/dist/lib/convertAasDiscoveryTypes.d.ts +18 -0
  118. package/dist/lib/convertAasDiscoveryTypes.js +39 -0
  119. package/dist/lib/convertAasTypes.d.ts +7 -7
  120. package/dist/lib/convertAasTypes.js +5 -0
  121. package/dist/lib/convertConceptDescriptionTypes.d.ts +18 -0
  122. package/dist/lib/convertConceptDescriptionTypes.js +39 -0
  123. package/dist/lib/convertSubmodelTypes.d.ts +34 -0
  124. package/dist/lib/convertSubmodelTypes.js +69 -0
  125. package/dist/lib/descriptorJsonization.d.ts +12 -0
  126. package/dist/lib/descriptorJsonization.js +172 -0
  127. package/dist/lib/errorHandler.d.ts +9 -0
  128. package/dist/lib/errorHandler.js +113 -0
  129. package/dist/models/Descriptors.d.ts +51 -0
  130. package/dist/models/Descriptors.js +56 -0
  131. package/dist/models/index.d.ts +0 -1
  132. package/dist/models/index.js +0 -1
  133. package/dist/utils/DescriptorUtils.d.ts +9 -0
  134. package/dist/utils/DescriptorUtils.js +37 -0
  135. package/dist/utils/KeyTypesUtil.d.ts +24 -0
  136. package/dist/utils/KeyTypesUtil.js +55 -0
  137. package/dist/utils/MultiLanguagePropertyUtils.d.ts +24 -0
  138. package/dist/utils/MultiLanguagePropertyUtils.js +46 -0
  139. package/dist/utils/ReferableUtils.d.ts +69 -0
  140. package/dist/utils/ReferableUtils.js +220 -0
  141. package/dist/utils/ReferenceUtil.d.ts +9 -0
  142. package/dist/utils/ReferenceUtil.js +22 -0
  143. package/dist/utils/SemanticIdUtils.d.ts +119 -0
  144. package/dist/utils/SemanticIdUtils.js +363 -0
  145. package/package.json +14 -11
  146. package/dist/generated/schemas.gen.d.ts +0 -2357
  147. package/dist/generated/schemas.gen.js +0 -2789
  148. package/dist/generated/sdk.gen.d.ts +0 -822
  149. package/dist/generated/sdk.gen.js +0 -2225
  150. package/dist/generated/types.gen.d.ts +0 -10829
  151. package/dist/generated/types.gen.js +0 -2
  152. package/dist/lib/createAasRepoClient.d.ts +0 -9
  153. package/dist/lib/createAasRepoClient.js +0 -15
  154. package/dist/models/aas-repository.d.ts +0 -65
  155. package/dist/models/aas-repository.js +0 -1
@@ -0,0 +1,924 @@
1
+ /**
2
+ *
3
+ * @export
4
+ * @interface AbstractLangString
5
+ */
6
+ export interface AbstractLangString {
7
+ /**
8
+ *
9
+ * @type {string}
10
+ * @memberof AbstractLangString
11
+ */
12
+ language: string;
13
+ /**
14
+ *
15
+ * @type {string}
16
+ * @memberof AbstractLangString
17
+ */
18
+ text: string;
19
+ }
20
+ /**
21
+ *
22
+ * @export
23
+ * @interface AdministrativeInformation
24
+ */
25
+ export interface AdministrativeInformation {
26
+ /**
27
+ *
28
+ * @type {Array<EmbeddedDataSpecification>}
29
+ * @memberof AdministrativeInformation
30
+ */
31
+ embeddedDataSpecifications?: Array<EmbeddedDataSpecification>;
32
+ /**
33
+ *
34
+ * @type {AdministrativeInformationAllOfVersion}
35
+ * @memberof AdministrativeInformation
36
+ */
37
+ version?: AdministrativeInformationAllOfVersion;
38
+ /**
39
+ *
40
+ * @type {AdministrativeInformationAllOfRevision}
41
+ * @memberof AdministrativeInformation
42
+ */
43
+ revision?: AdministrativeInformationAllOfRevision;
44
+ /**
45
+ *
46
+ * @type {Reference}
47
+ * @memberof AdministrativeInformation
48
+ */
49
+ creator?: Reference;
50
+ /**
51
+ *
52
+ * @type {string}
53
+ * @memberof AdministrativeInformation
54
+ */
55
+ templateId?: string;
56
+ }
57
+ /**
58
+ *
59
+ * @export
60
+ * @interface AdministrativeInformationAllOfRevision
61
+ */
62
+ export interface AdministrativeInformationAllOfRevision {
63
+ }
64
+ /**
65
+ *
66
+ * @export
67
+ * @interface AdministrativeInformationAllOfVersion
68
+ */
69
+ export interface AdministrativeInformationAllOfVersion {
70
+ }
71
+ /**
72
+ *
73
+ * @export
74
+ * @interface DataSpecificationContent
75
+ */
76
+ export interface DataSpecificationContent {
77
+ /**
78
+ *
79
+ * @type {ModelType}
80
+ * @memberof DataSpecificationContent
81
+ */
82
+ modelType: ModelType;
83
+ }
84
+ /**
85
+ * @type DataSpecificationContentChoice
86
+ *
87
+ * @export
88
+ */
89
+ export type DataSpecificationContentChoice = DataSpecificationIec61360;
90
+ /**
91
+ *
92
+ * @export
93
+ * @interface DataSpecificationIec61360
94
+ */
95
+ export interface DataSpecificationIec61360 {
96
+ /**
97
+ *
98
+ * @type {any}
99
+ * @memberof DataSpecificationIec61360
100
+ */
101
+ modelType: any | null;
102
+ /**
103
+ *
104
+ * @type {Array<LangStringPreferredNameTypeIec61360>}
105
+ * @memberof DataSpecificationIec61360
106
+ */
107
+ preferredName: Array<LangStringPreferredNameTypeIec61360>;
108
+ /**
109
+ *
110
+ * @type {Array<LangStringShortNameTypeIec61360>}
111
+ * @memberof DataSpecificationIec61360
112
+ */
113
+ shortName?: Array<LangStringShortNameTypeIec61360>;
114
+ /**
115
+ *
116
+ * @type {string}
117
+ * @memberof DataSpecificationIec61360
118
+ */
119
+ unit?: string;
120
+ /**
121
+ *
122
+ * @type {Reference}
123
+ * @memberof DataSpecificationIec61360
124
+ */
125
+ unitId?: Reference;
126
+ /**
127
+ *
128
+ * @type {string}
129
+ * @memberof DataSpecificationIec61360
130
+ */
131
+ sourceOfDefinition?: string;
132
+ /**
133
+ *
134
+ * @type {string}
135
+ * @memberof DataSpecificationIec61360
136
+ */
137
+ symbol?: string;
138
+ /**
139
+ *
140
+ * @type {DataTypeIec61360}
141
+ * @memberof DataSpecificationIec61360
142
+ */
143
+ dataType?: DataTypeIec61360;
144
+ /**
145
+ *
146
+ * @type {Array<LangStringDefinitionTypeIec61360>}
147
+ * @memberof DataSpecificationIec61360
148
+ */
149
+ definition?: Array<LangStringDefinitionTypeIec61360>;
150
+ /**
151
+ *
152
+ * @type {string}
153
+ * @memberof DataSpecificationIec61360
154
+ */
155
+ valueFormat?: string;
156
+ /**
157
+ *
158
+ * @type {ValueList}
159
+ * @memberof DataSpecificationIec61360
160
+ */
161
+ valueList?: ValueList;
162
+ /**
163
+ *
164
+ * @type {string}
165
+ * @memberof DataSpecificationIec61360
166
+ */
167
+ value?: string;
168
+ /**
169
+ *
170
+ * @type {LevelType}
171
+ * @memberof DataSpecificationIec61360
172
+ */
173
+ levelType?: LevelType;
174
+ }
175
+ /**
176
+ *
177
+ * @export
178
+ */
179
+ export declare const DataTypeDefXsd: {
180
+ readonly XsAnyUri: "xs:anyURI";
181
+ readonly XsBase64Binary: "xs:base64Binary";
182
+ readonly XsBoolean: "xs:boolean";
183
+ readonly XsByte: "xs:byte";
184
+ readonly XsDate: "xs:date";
185
+ readonly XsDateTime: "xs:dateTime";
186
+ readonly XsDecimal: "xs:decimal";
187
+ readonly XsDouble: "xs:double";
188
+ readonly XsDuration: "xs:duration";
189
+ readonly XsFloat: "xs:float";
190
+ readonly XsGDay: "xs:gDay";
191
+ readonly XsGMonth: "xs:gMonth";
192
+ readonly XsGMonthDay: "xs:gMonthDay";
193
+ readonly XsGYear: "xs:gYear";
194
+ readonly XsGYearMonth: "xs:gYearMonth";
195
+ readonly XsHexBinary: "xs:hexBinary";
196
+ readonly XsInt: "xs:int";
197
+ readonly XsInteger: "xs:integer";
198
+ readonly XsLong: "xs:long";
199
+ readonly XsNegativeInteger: "xs:negativeInteger";
200
+ readonly XsNonNegativeInteger: "xs:nonNegativeInteger";
201
+ readonly XsNonPositiveInteger: "xs:nonPositiveInteger";
202
+ readonly XsPositiveInteger: "xs:positiveInteger";
203
+ readonly XsShort: "xs:short";
204
+ readonly XsString: "xs:string";
205
+ readonly XsTime: "xs:time";
206
+ readonly XsUnsignedByte: "xs:unsignedByte";
207
+ readonly XsUnsignedInt: "xs:unsignedInt";
208
+ readonly XsUnsignedLong: "xs:unsignedLong";
209
+ readonly XsUnsignedShort: "xs:unsignedShort";
210
+ };
211
+ export type DataTypeDefXsd = typeof DataTypeDefXsd[keyof typeof DataTypeDefXsd];
212
+ /**
213
+ *
214
+ * @export
215
+ */
216
+ export declare const DataTypeIec61360: {
217
+ readonly Blob: "BLOB";
218
+ readonly Boolean: "BOOLEAN";
219
+ readonly Date: "DATE";
220
+ readonly File: "FILE";
221
+ readonly Html: "HTML";
222
+ readonly IntegerCount: "INTEGER_COUNT";
223
+ readonly IntegerCurrency: "INTEGER_CURRENCY";
224
+ readonly IntegerMeasure: "INTEGER_MEASURE";
225
+ readonly Irdi: "IRDI";
226
+ readonly Iri: "IRI";
227
+ readonly Rational: "RATIONAL";
228
+ readonly RationalMeasure: "RATIONAL_MEASURE";
229
+ readonly RealCount: "REAL_COUNT";
230
+ readonly RealCurrency: "REAL_CURRENCY";
231
+ readonly RealMeasure: "REAL_MEASURE";
232
+ readonly String: "STRING";
233
+ readonly StringTranslatable: "STRING_TRANSLATABLE";
234
+ readonly Time: "TIME";
235
+ readonly Timestamp: "TIMESTAMP";
236
+ };
237
+ export type DataTypeIec61360 = typeof DataTypeIec61360[keyof typeof DataTypeIec61360];
238
+ /**
239
+ *
240
+ * @export
241
+ * @interface Descriptor
242
+ */
243
+ export interface Descriptor {
244
+ /**
245
+ *
246
+ * @type {Array<LangStringTextType>}
247
+ * @memberof Descriptor
248
+ */
249
+ description?: Array<LangStringTextType>;
250
+ /**
251
+ *
252
+ * @type {Array<LangStringNameType>}
253
+ * @memberof Descriptor
254
+ */
255
+ displayName?: Array<LangStringNameType>;
256
+ /**
257
+ *
258
+ * @type {Array<Extension>}
259
+ * @memberof Descriptor
260
+ */
261
+ extensions?: Array<Extension>;
262
+ }
263
+ /**
264
+ *
265
+ * @export
266
+ * @interface EmbeddedDataSpecification
267
+ */
268
+ export interface EmbeddedDataSpecification {
269
+ /**
270
+ *
271
+ * @type {DataSpecificationContentChoice}
272
+ * @memberof EmbeddedDataSpecification
273
+ */
274
+ dataSpecificationContent: DataSpecificationContentChoice;
275
+ /**
276
+ *
277
+ * @type {Reference}
278
+ * @memberof EmbeddedDataSpecification
279
+ */
280
+ dataSpecification: Reference;
281
+ }
282
+ /**
283
+ *
284
+ * @export
285
+ * @interface Endpoint
286
+ */
287
+ export interface Endpoint {
288
+ /**
289
+ *
290
+ * @type {string}
291
+ * @memberof Endpoint
292
+ */
293
+ _interface: string;
294
+ /**
295
+ *
296
+ * @type {ProtocolInformation}
297
+ * @memberof Endpoint
298
+ */
299
+ protocolInformation: ProtocolInformation;
300
+ }
301
+ /**
302
+ *
303
+ * @export
304
+ * @interface Extension
305
+ */
306
+ export interface Extension {
307
+ /**
308
+ *
309
+ * @type {Reference}
310
+ * @memberof Extension
311
+ */
312
+ semanticId?: Reference;
313
+ /**
314
+ *
315
+ * @type {Array<Reference>}
316
+ * @memberof Extension
317
+ */
318
+ supplementalSemanticIds?: Array<Reference>;
319
+ /**
320
+ *
321
+ * @type {string}
322
+ * @memberof Extension
323
+ */
324
+ name: string;
325
+ /**
326
+ *
327
+ * @type {DataTypeDefXsd}
328
+ * @memberof Extension
329
+ */
330
+ valueType?: DataTypeDefXsd;
331
+ /**
332
+ *
333
+ * @type {string}
334
+ * @memberof Extension
335
+ */
336
+ value?: string;
337
+ /**
338
+ *
339
+ * @type {Array<Reference>}
340
+ * @memberof Extension
341
+ */
342
+ refersTo?: Array<Reference>;
343
+ }
344
+ /**
345
+ *
346
+ * @export
347
+ * @interface GetSubmodelDescriptorsResult
348
+ */
349
+ export interface GetSubmodelDescriptorsResult {
350
+ /**
351
+ *
352
+ * @type {PagedResultPagingMetadata}
353
+ * @memberof GetSubmodelDescriptorsResult
354
+ */
355
+ pagingMetadata: PagedResultPagingMetadata;
356
+ /**
357
+ *
358
+ * @type {Array<SubmodelDescriptor>}
359
+ * @memberof GetSubmodelDescriptorsResult
360
+ */
361
+ result?: Array<SubmodelDescriptor>;
362
+ }
363
+ /**
364
+ *
365
+ * @export
366
+ * @interface HasDataSpecification
367
+ */
368
+ export interface HasDataSpecification {
369
+ /**
370
+ *
371
+ * @type {Array<EmbeddedDataSpecification>}
372
+ * @memberof HasDataSpecification
373
+ */
374
+ embeddedDataSpecifications?: Array<EmbeddedDataSpecification>;
375
+ }
376
+ /**
377
+ *
378
+ * @export
379
+ * @interface HasSemantics
380
+ */
381
+ export interface HasSemantics {
382
+ /**
383
+ *
384
+ * @type {Reference}
385
+ * @memberof HasSemantics
386
+ */
387
+ semanticId?: Reference;
388
+ /**
389
+ *
390
+ * @type {Array<Reference>}
391
+ * @memberof HasSemantics
392
+ */
393
+ supplementalSemanticIds?: Array<Reference>;
394
+ }
395
+ /**
396
+ *
397
+ * @export
398
+ * @interface Key
399
+ */
400
+ export interface Key {
401
+ /**
402
+ *
403
+ * @type {KeyTypes}
404
+ * @memberof Key
405
+ */
406
+ type: KeyTypes;
407
+ /**
408
+ *
409
+ * @type {string}
410
+ * @memberof Key
411
+ */
412
+ value: string;
413
+ }
414
+ /**
415
+ *
416
+ * @export
417
+ */
418
+ export declare const KeyTypes: {
419
+ readonly AnnotatedRelationshipElement: "AnnotatedRelationshipElement";
420
+ readonly AssetAdministrationShell: "AssetAdministrationShell";
421
+ readonly BasicEventElement: "BasicEventElement";
422
+ readonly Blob: "Blob";
423
+ readonly Capability: "Capability";
424
+ readonly ConceptDescription: "ConceptDescription";
425
+ readonly DataElement: "DataElement";
426
+ readonly Entity: "Entity";
427
+ readonly EventElement: "EventElement";
428
+ readonly File: "File";
429
+ readonly FragmentReference: "FragmentReference";
430
+ readonly GlobalReference: "GlobalReference";
431
+ readonly Identifiable: "Identifiable";
432
+ readonly MultiLanguageProperty: "MultiLanguageProperty";
433
+ readonly Operation: "Operation";
434
+ readonly Property: "Property";
435
+ readonly Range: "Range";
436
+ readonly Referable: "Referable";
437
+ readonly ReferenceElement: "ReferenceElement";
438
+ readonly RelationshipElement: "RelationshipElement";
439
+ readonly Submodel: "Submodel";
440
+ readonly SubmodelElement: "SubmodelElement";
441
+ readonly SubmodelElementCollection: "SubmodelElementCollection";
442
+ readonly SubmodelElementList: "SubmodelElementList";
443
+ };
444
+ export type KeyTypes = typeof KeyTypes[keyof typeof KeyTypes];
445
+ /**
446
+ *
447
+ * @export
448
+ * @interface LangStringDefinitionTypeIec61360
449
+ */
450
+ export interface LangStringDefinitionTypeIec61360 {
451
+ /**
452
+ *
453
+ * @type {string}
454
+ * @memberof LangStringDefinitionTypeIec61360
455
+ */
456
+ language: string;
457
+ /**
458
+ *
459
+ * @type {any}
460
+ * @memberof LangStringDefinitionTypeIec61360
461
+ */
462
+ text: any | null;
463
+ }
464
+ /**
465
+ *
466
+ * @export
467
+ * @interface LangStringNameType
468
+ */
469
+ export interface LangStringNameType {
470
+ /**
471
+ *
472
+ * @type {string}
473
+ * @memberof LangStringNameType
474
+ */
475
+ language: string;
476
+ /**
477
+ *
478
+ * @type {any}
479
+ * @memberof LangStringNameType
480
+ */
481
+ text: any | null;
482
+ }
483
+ /**
484
+ *
485
+ * @export
486
+ * @interface LangStringPreferredNameTypeIec61360
487
+ */
488
+ export interface LangStringPreferredNameTypeIec61360 {
489
+ /**
490
+ *
491
+ * @type {string}
492
+ * @memberof LangStringPreferredNameTypeIec61360
493
+ */
494
+ language: string;
495
+ /**
496
+ *
497
+ * @type {any}
498
+ * @memberof LangStringPreferredNameTypeIec61360
499
+ */
500
+ text: any | null;
501
+ }
502
+ /**
503
+ *
504
+ * @export
505
+ * @interface LangStringShortNameTypeIec61360
506
+ */
507
+ export interface LangStringShortNameTypeIec61360 {
508
+ /**
509
+ *
510
+ * @type {string}
511
+ * @memberof LangStringShortNameTypeIec61360
512
+ */
513
+ language: string;
514
+ /**
515
+ *
516
+ * @type {any}
517
+ * @memberof LangStringShortNameTypeIec61360
518
+ */
519
+ text: any | null;
520
+ }
521
+ /**
522
+ *
523
+ * @export
524
+ * @interface LangStringTextType
525
+ */
526
+ export interface LangStringTextType {
527
+ /**
528
+ *
529
+ * @type {string}
530
+ * @memberof LangStringTextType
531
+ */
532
+ language: string;
533
+ /**
534
+ *
535
+ * @type {any}
536
+ * @memberof LangStringTextType
537
+ */
538
+ text: any | null;
539
+ }
540
+ /**
541
+ *
542
+ * @export
543
+ * @interface LevelType
544
+ */
545
+ export interface LevelType {
546
+ /**
547
+ *
548
+ * @type {boolean}
549
+ * @memberof LevelType
550
+ */
551
+ min: boolean;
552
+ /**
553
+ *
554
+ * @type {boolean}
555
+ * @memberof LevelType
556
+ */
557
+ nom: boolean;
558
+ /**
559
+ *
560
+ * @type {boolean}
561
+ * @memberof LevelType
562
+ */
563
+ typ: boolean;
564
+ /**
565
+ *
566
+ * @type {boolean}
567
+ * @memberof LevelType
568
+ */
569
+ max: boolean;
570
+ }
571
+ /**
572
+ *
573
+ * @export
574
+ * @interface Message
575
+ */
576
+ export interface Message {
577
+ /**
578
+ *
579
+ * @type {string}
580
+ * @memberof Message
581
+ */
582
+ code?: string;
583
+ /**
584
+ *
585
+ * @type {string}
586
+ * @memberof Message
587
+ */
588
+ correlationId?: string;
589
+ /**
590
+ *
591
+ * @type {string}
592
+ * @memberof Message
593
+ */
594
+ messageType?: MessageMessageTypeEnum;
595
+ /**
596
+ *
597
+ * @type {string}
598
+ * @memberof Message
599
+ */
600
+ text?: string;
601
+ /**
602
+ *
603
+ * @type {string}
604
+ * @memberof Message
605
+ */
606
+ timestamp?: string;
607
+ }
608
+ /**
609
+ * @export
610
+ */
611
+ export declare const MessageMessageTypeEnum: {
612
+ readonly Undefined: "Undefined";
613
+ readonly Info: "Info";
614
+ readonly Warning: "Warning";
615
+ readonly Error: "Error";
616
+ readonly Exception: "Exception";
617
+ };
618
+ export type MessageMessageTypeEnum = typeof MessageMessageTypeEnum[keyof typeof MessageMessageTypeEnum];
619
+ /**
620
+ *
621
+ * @export
622
+ */
623
+ export declare const ModelType: {
624
+ readonly AnnotatedRelationshipElement: "AnnotatedRelationshipElement";
625
+ readonly AssetAdministrationShell: "AssetAdministrationShell";
626
+ readonly BasicEventElement: "BasicEventElement";
627
+ readonly Blob: "Blob";
628
+ readonly Capability: "Capability";
629
+ readonly ConceptDescription: "ConceptDescription";
630
+ readonly DataSpecificationIec61360: "DataSpecificationIec61360";
631
+ readonly Entity: "Entity";
632
+ readonly File: "File";
633
+ readonly MultiLanguageProperty: "MultiLanguageProperty";
634
+ readonly Operation: "Operation";
635
+ readonly Property: "Property";
636
+ readonly Range: "Range";
637
+ readonly ReferenceElement: "ReferenceElement";
638
+ readonly RelationshipElement: "RelationshipElement";
639
+ readonly Submodel: "Submodel";
640
+ readonly SubmodelElementCollection: "SubmodelElementCollection";
641
+ readonly SubmodelElementList: "SubmodelElementList";
642
+ };
643
+ export type ModelType = typeof ModelType[keyof typeof ModelType];
644
+ /**
645
+ *
646
+ * @export
647
+ * @interface PagedResult
648
+ */
649
+ export interface PagedResult {
650
+ /**
651
+ *
652
+ * @type {PagedResultPagingMetadata}
653
+ * @memberof PagedResult
654
+ */
655
+ pagingMetadata: PagedResultPagingMetadata;
656
+ }
657
+ /**
658
+ *
659
+ * @export
660
+ * @interface PagedResultPagingMetadata
661
+ */
662
+ export interface PagedResultPagingMetadata {
663
+ /**
664
+ *
665
+ * @type {string}
666
+ * @memberof PagedResultPagingMetadata
667
+ */
668
+ cursor?: string;
669
+ }
670
+ /**
671
+ *
672
+ * @export
673
+ * @interface ProtocolInformation
674
+ */
675
+ export interface ProtocolInformation {
676
+ /**
677
+ *
678
+ * @type {string}
679
+ * @memberof ProtocolInformation
680
+ */
681
+ href: string;
682
+ /**
683
+ *
684
+ * @type {string}
685
+ * @memberof ProtocolInformation
686
+ */
687
+ endpointProtocol?: string;
688
+ /**
689
+ *
690
+ * @type {Array<string>}
691
+ * @memberof ProtocolInformation
692
+ */
693
+ endpointProtocolVersion?: Array<string>;
694
+ /**
695
+ *
696
+ * @type {string}
697
+ * @memberof ProtocolInformation
698
+ */
699
+ subprotocol?: string;
700
+ /**
701
+ *
702
+ * @type {string}
703
+ * @memberof ProtocolInformation
704
+ */
705
+ subprotocolBody?: string;
706
+ /**
707
+ *
708
+ * @type {string}
709
+ * @memberof ProtocolInformation
710
+ */
711
+ subprotocolBodyEncoding?: string;
712
+ /**
713
+ *
714
+ * @type {Array<ProtocolInformationSecurityAttributes>}
715
+ * @memberof ProtocolInformation
716
+ */
717
+ securityAttributes?: Array<ProtocolInformationSecurityAttributes>;
718
+ }
719
+ /**
720
+ *
721
+ * @export
722
+ * @interface ProtocolInformationSecurityAttributes
723
+ */
724
+ export interface ProtocolInformationSecurityAttributes {
725
+ /**
726
+ *
727
+ * @type {string}
728
+ * @memberof ProtocolInformationSecurityAttributes
729
+ */
730
+ type: ProtocolInformationSecurityAttributesTypeEnum;
731
+ /**
732
+ *
733
+ * @type {string}
734
+ * @memberof ProtocolInformationSecurityAttributes
735
+ */
736
+ key: string;
737
+ /**
738
+ *
739
+ * @type {string}
740
+ * @memberof ProtocolInformationSecurityAttributes
741
+ */
742
+ value: string;
743
+ }
744
+ /**
745
+ * @export
746
+ */
747
+ export declare const ProtocolInformationSecurityAttributesTypeEnum: {
748
+ readonly None: "NONE";
749
+ readonly RfcTlsa: "RFC_TLSA";
750
+ readonly W3CDid: "W3C_DID";
751
+ };
752
+ export type ProtocolInformationSecurityAttributesTypeEnum = typeof ProtocolInformationSecurityAttributesTypeEnum[keyof typeof ProtocolInformationSecurityAttributesTypeEnum];
753
+ /**
754
+ *
755
+ * @export
756
+ * @interface Reference
757
+ */
758
+ export interface Reference {
759
+ /**
760
+ *
761
+ * @type {ReferenceTypes}
762
+ * @memberof Reference
763
+ */
764
+ type: ReferenceTypes;
765
+ /**
766
+ *
767
+ * @type {Array<Key>}
768
+ * @memberof Reference
769
+ */
770
+ keys: Array<Key>;
771
+ /**
772
+ *
773
+ * @type {ReferenceParent}
774
+ * @memberof Reference
775
+ */
776
+ referredSemanticId?: ReferenceParent;
777
+ }
778
+ /**
779
+ *
780
+ * @export
781
+ * @interface ReferenceParent
782
+ */
783
+ export interface ReferenceParent {
784
+ /**
785
+ *
786
+ * @type {ReferenceTypes}
787
+ * @memberof ReferenceParent
788
+ */
789
+ type: ReferenceTypes;
790
+ /**
791
+ *
792
+ * @type {Array<Key>}
793
+ * @memberof ReferenceParent
794
+ */
795
+ keys: Array<Key>;
796
+ }
797
+ /**
798
+ *
799
+ * @export
800
+ */
801
+ export declare const ReferenceTypes: {
802
+ readonly ExternalReference: "ExternalReference";
803
+ readonly ModelReference: "ModelReference";
804
+ };
805
+ export type ReferenceTypes = typeof ReferenceTypes[keyof typeof ReferenceTypes];
806
+ /**
807
+ *
808
+ * @export
809
+ * @interface Result
810
+ */
811
+ export interface Result {
812
+ /**
813
+ *
814
+ * @type {Array<Message>}
815
+ * @memberof Result
816
+ */
817
+ messages?: Array<Message>;
818
+ }
819
+ /**
820
+ * The Description object enables servers to present their capabilities to the clients, in particular which profiles they implement. At least one defined profile is required. Additional, proprietary attributes might be included. Nevertheless, the server must not expect that a regular client understands them.
821
+ * @export
822
+ * @interface ServiceDescription
823
+ */
824
+ export interface ServiceDescription {
825
+ /**
826
+ *
827
+ * @type {Array<string>}
828
+ * @memberof ServiceDescription
829
+ */
830
+ profiles?: Array<string>;
831
+ }
832
+ /**
833
+ *
834
+ * @export
835
+ * @interface SubmodelDescriptor
836
+ */
837
+ export interface SubmodelDescriptor {
838
+ /**
839
+ *
840
+ * @type {AdministrativeInformation}
841
+ * @memberof SubmodelDescriptor
842
+ */
843
+ administration?: AdministrativeInformation;
844
+ /**
845
+ *
846
+ * @type {Array<Endpoint>}
847
+ * @memberof SubmodelDescriptor
848
+ */
849
+ endpoints: Array<Endpoint>;
850
+ /**
851
+ *
852
+ * @type {string}
853
+ * @memberof SubmodelDescriptor
854
+ */
855
+ idShort?: string;
856
+ /**
857
+ *
858
+ * @type {string}
859
+ * @memberof SubmodelDescriptor
860
+ */
861
+ id: string;
862
+ /**
863
+ *
864
+ * @type {Reference}
865
+ * @memberof SubmodelDescriptor
866
+ */
867
+ semanticId?: Reference;
868
+ /**
869
+ *
870
+ * @type {Array<Reference>}
871
+ * @memberof SubmodelDescriptor
872
+ */
873
+ supplementalSemanticId?: Array<Reference>;
874
+ /**
875
+ *
876
+ * @type {Array<LangStringTextType>}
877
+ * @memberof SubmodelDescriptor
878
+ */
879
+ description?: Array<LangStringTextType>;
880
+ /**
881
+ *
882
+ * @type {Array<LangStringNameType>}
883
+ * @memberof SubmodelDescriptor
884
+ */
885
+ displayName?: Array<LangStringNameType>;
886
+ /**
887
+ *
888
+ * @type {Array<Extension>}
889
+ * @memberof SubmodelDescriptor
890
+ */
891
+ extensions?: Array<Extension>;
892
+ }
893
+ /**
894
+ *
895
+ * @export
896
+ * @interface ValueList
897
+ */
898
+ export interface ValueList {
899
+ /**
900
+ *
901
+ * @type {Array<ValueReferencePair>}
902
+ * @memberof ValueList
903
+ */
904
+ valueReferencePairs: Array<ValueReferencePair>;
905
+ }
906
+ /**
907
+ *
908
+ * @export
909
+ * @interface ValueReferencePair
910
+ */
911
+ export interface ValueReferencePair {
912
+ /**
913
+ *
914
+ * @type {string}
915
+ * @memberof ValueReferencePair
916
+ */
917
+ value: string;
918
+ /**
919
+ *
920
+ * @type {Reference}
921
+ * @memberof ValueReferencePair
922
+ */
923
+ valueId?: Reference;
924
+ }