basyx-typescript-sdk 2.2.3 → 2.2.5

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 (59) hide show
  1. package/README.md +115 -0
  2. package/bundle/index.cjs +2854 -2052
  3. package/bundle/index.cjs.map +1 -1
  4. package/bundle/index.mjs +2854 -2052
  5. package/bundle/index.mjs.map +1 -1
  6. package/dist/clients/AasDiscoveryClient.d.ts +3 -2
  7. package/dist/clients/AasDiscoveryClient.js +78 -20
  8. package/dist/clients/AasRegistryClient.d.ts +4 -2
  9. package/dist/clients/AasRegistryClient.js +153 -45
  10. package/dist/clients/AasRepositoryClient.d.ts +73 -16
  11. package/dist/clients/AasRepositoryClient.js +682 -263
  12. package/dist/clients/AasxFileClient.d.ts +18 -0
  13. package/dist/clients/AasxFileClient.js +100 -25
  14. package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +3 -1
  15. package/dist/clients/ConceptDescriptionRepositoryClient.js +93 -29
  16. package/dist/clients/SubmodelRegistryClient.d.ts +3 -1
  17. package/dist/clients/SubmodelRegistryClient.js +91 -21
  18. package/dist/clients/SubmodelRepositoryClient.d.ts +229 -22
  19. package/dist/clients/SubmodelRepositoryClient.js +689 -201
  20. package/dist/generated/AasDiscoveryService/models/index.d.ts +2 -2
  21. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.d.ts +1 -1
  22. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.js +1 -1
  23. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.d.ts +1 -1
  24. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.js +1 -1
  25. package/dist/generated/AasRegistryService/index.d.ts +1 -1
  26. package/dist/generated/AasRegistryService/index.js +1 -1
  27. package/dist/generated/AasRegistryService/models/index.d.ts +3 -3
  28. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.d.ts +3 -3
  29. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.js +1 -1
  30. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.d.ts +1 -1
  31. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.js +1 -1
  32. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.d.ts +1 -1
  33. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.js +1 -1
  34. package/dist/generated/AasRepositoryService/index.d.ts +1 -1
  35. package/dist/generated/AasRepositoryService/index.js +1 -1
  36. package/dist/generated/AasRepositoryService/models/index.d.ts +7 -7
  37. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.d.ts +5 -3
  38. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.js +6 -0
  39. package/dist/generated/AasxFileService/apis/DescriptionAPIApi.d.ts +26 -0
  40. package/dist/generated/AasxFileService/apis/DescriptionAPIApi.js +40 -0
  41. package/dist/generated/AasxFileService/apis/index.d.ts +1 -0
  42. package/dist/generated/AasxFileService/apis/index.js +1 -0
  43. package/dist/generated/AasxFileService/models/index.d.ts +45 -0
  44. package/dist/generated/ConceptDescriptionRepositoryService/models/index.d.ts +2 -2
  45. package/dist/generated/SubmodelRegistryService/models/index.d.ts +2 -2
  46. package/dist/generated/SubmodelRepositoryService/models/index.d.ts +9 -9
  47. package/dist/generated/runtime.js +7 -0
  48. package/dist/lib/aas-dataformat-xml/xmlization.js +1 -1
  49. package/dist/lib/errorHandler.js +13 -2
  50. package/dist/models/api.d.ts +4 -2
  51. package/dist/services/AasService.d.ts +21 -1
  52. package/dist/services/AasService.js +114 -26
  53. package/dist/services/SubmodelService.d.ts +21 -1
  54. package/dist/services/SubmodelService.js +119 -21
  55. package/package.json +23 -12
  56. package/dist/generated/AasRegistryService/runtime.d.ts +0 -181
  57. package/dist/generated/AasRegistryService/runtime.js +0 -326
  58. package/dist/generated/AasRepositoryService/runtime.d.ts +0 -181
  59. package/dist/generated/AasRepositoryService/runtime.js +0 -326
@@ -4,6 +4,8 @@ import type { AssetId } from '../models/AssetId';
4
4
  import { AasRepositoryService } from '../generated';
5
5
  import { Configuration } from '../generated/runtime';
6
6
  export declare class AasRepositoryClient {
7
+ private static requireIdentifier;
8
+ private static extractStatusCode;
7
9
  /**
8
10
  * Returns all Asset Administration Shells
9
11
  *
@@ -12,7 +14,7 @@ export declare class AasRepositoryClient {
12
14
  * - assetIds?: A list of specific Asset identifiers
13
15
  * - idShort?: The Asset Administration Shell’s IdShort
14
16
  * - limit?: The maximum number of elements in the response array
15
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
17
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
16
18
  *
17
19
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
18
20
  */
@@ -34,7 +36,7 @@ export declare class AasRepositoryClient {
34
36
  * - assetIds?: A list of specific Asset identifiers
35
37
  * - idShort?: The Asset Administration Shell’s IdShort
36
38
  * - limit?: The maximum number of elements in the response array
37
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
39
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
38
40
  *
39
41
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
40
42
  */
@@ -102,6 +104,19 @@ export declare class AasRepositoryClient {
102
104
  aasIdentifier: string;
103
105
  assetAdministrationShell: AssetAdministrationShell;
104
106
  }): Promise<ApiResult<AssetAdministrationShell | void, AasRepositoryService.Result>>;
107
+ /**
108
+ * Returns a specific Asset Administration Shell in reference representation
109
+ *
110
+ * @param options Object containing:
111
+ * - configuration: The http request options
112
+ * - aasIdentifier: The Asset Administration Shell’s unique id
113
+ *
114
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
115
+ */
116
+ getAssetAdministrationShellByIdReferenceAasRepository(options: {
117
+ configuration: Configuration;
118
+ aasIdentifier: string;
119
+ }): Promise<ApiResult<Reference, AasRepositoryService.Result>>;
105
120
  /**
106
121
  * Returns the Asset Information
107
122
  *
@@ -111,7 +126,7 @@ export declare class AasRepositoryClient {
111
126
  *
112
127
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
113
128
  */
114
- getAssetInformation(options: {
129
+ getAssetInformationAasRepository(options: {
115
130
  configuration: Configuration;
116
131
  aasIdentifier: string;
117
132
  }): Promise<ApiResult<AssetInformation, AasRepositoryService.Result>>;
@@ -125,7 +140,7 @@ export declare class AasRepositoryClient {
125
140
  *
126
141
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
127
142
  */
128
- putAssetInformation(options: {
143
+ putAssetInformationAasRepository(options: {
129
144
  configuration: Configuration;
130
145
  aasIdentifier: string;
131
146
  assetInformation: AssetInformation;
@@ -139,7 +154,7 @@ export declare class AasRepositoryClient {
139
154
  *
140
155
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
141
156
  */
142
- deleteThumbnail(options: {
157
+ deleteThumbnailAasRepository(options: {
143
158
  configuration: Configuration;
144
159
  aasIdentifier: string;
145
160
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
@@ -152,7 +167,7 @@ export declare class AasRepositoryClient {
152
167
  *
153
168
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
154
169
  */
155
- getThumbnail(options: {
170
+ getThumbnailAasRepository(options: {
156
171
  configuration: Configuration;
157
172
  aasIdentifier: string;
158
173
  }): Promise<ApiResult<Blob, AasRepositoryService.Result>>;
@@ -167,7 +182,7 @@ export declare class AasRepositoryClient {
167
182
  *
168
183
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
169
184
  */
170
- putThumbnail(options: {
185
+ putThumbnailAasRepository(options: {
171
186
  configuration: Configuration;
172
187
  aasIdentifier: string;
173
188
  fileName: string;
@@ -180,11 +195,11 @@ export declare class AasRepositoryClient {
180
195
  * - configuration: The http request options
181
196
  * - aasIdentifier: The Asset Administration Shell’s unique id
182
197
  * - limit?: The maximum number of elements in the response array
183
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
198
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
184
199
  *
185
200
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
186
201
  */
187
- getAllSubmodelReferences(options: {
202
+ getAllSubmodelReferencesAasRepository(options: {
188
203
  configuration: Configuration;
189
204
  aasIdentifier: string;
190
205
  limit?: number;
@@ -203,7 +218,7 @@ export declare class AasRepositoryClient {
203
218
  *
204
219
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
205
220
  */
206
- postSubmodelReference(options: {
221
+ postSubmodelReferenceAasRepository(options: {
207
222
  configuration: Configuration;
208
223
  aasIdentifier: string;
209
224
  submodelReference: Reference;
@@ -218,6 +233,48 @@ export declare class AasRepositoryClient {
218
233
  *
219
234
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
220
235
  */
236
+ deleteSubmodelReferenceAasRepository(options: {
237
+ configuration: Configuration;
238
+ aasIdentifier: string;
239
+ submodelIdentifier: string;
240
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
241
+ getAssetInformation(options: {
242
+ configuration: Configuration;
243
+ aasIdentifier: string;
244
+ }): Promise<ApiResult<AssetInformation, AasRepositoryService.Result>>;
245
+ putAssetInformation(options: {
246
+ configuration: Configuration;
247
+ aasIdentifier: string;
248
+ assetInformation: AssetInformation;
249
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
250
+ deleteThumbnail(options: {
251
+ configuration: Configuration;
252
+ aasIdentifier: string;
253
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
254
+ getThumbnail(options: {
255
+ configuration: Configuration;
256
+ aasIdentifier: string;
257
+ }): Promise<ApiResult<Blob, AasRepositoryService.Result>>;
258
+ putThumbnail(options: {
259
+ configuration: Configuration;
260
+ aasIdentifier: string;
261
+ fileName: string;
262
+ file: Blob;
263
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
264
+ getAllSubmodelReferences(options: {
265
+ configuration: Configuration;
266
+ aasIdentifier: string;
267
+ limit?: number;
268
+ cursor?: string;
269
+ }): Promise<ApiResult<{
270
+ pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
271
+ result: Reference[];
272
+ }, AasRepositoryService.Result>>;
273
+ postSubmodelReference(options: {
274
+ configuration: Configuration;
275
+ aasIdentifier: string;
276
+ submodelReference: Reference;
277
+ }): Promise<ApiResult<Reference, AasRepositoryService.Result>>;
221
278
  deleteSubmodelReferenceById(options: {
222
279
  configuration: Configuration;
223
280
  aasIdentifier: string;
@@ -258,7 +315,7 @@ export declare class AasRepositoryClient {
258
315
  aasIdentifier: string;
259
316
  submodelIdentifier: string;
260
317
  submodel: Submodel;
261
- }): Promise<ApiResult<Reference | void, AasRepositoryService.Result>>;
318
+ }): Promise<ApiResult<Submodel | void, AasRepositoryService.Result>>;
262
319
  /**
263
320
  * Deletes the submodel from the Asset Administration Shell and the Repository.
264
321
  *
@@ -402,7 +459,7 @@ export declare class AasRepositoryClient {
402
459
  * - aasIdentifier: The Asset Administration Shell’s unique id
403
460
  * - submodelIdentifier: The Submodel’s unique id
404
461
  * - limit?: The maximum number of elements in the response array
405
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
462
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
406
463
  * - level?: Determines the structural depth of the respective resource content
407
464
  * - extent?: Determines to which extent the resource is being serialized
408
465
  *
@@ -445,7 +502,7 @@ export declare class AasRepositoryClient {
445
502
  * - aasIdentifier: The Asset Administration Shell’s unique id
446
503
  * - submodelIdentifier: The Submodel’s unique id
447
504
  * - limit?: The maximum number of elements in the response array
448
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
505
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
449
506
  *
450
507
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
451
508
  */
@@ -467,7 +524,7 @@ export declare class AasRepositoryClient {
467
524
  * - aasIdentifier: The Asset Administration Shell’s unique id
468
525
  * - submodelIdentifier: The Submodel’s unique id
469
526
  * - limit?: The maximum number of elements in the response array
470
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
527
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
471
528
  * - level?: Determines the structural depth of the respective resource content
472
529
  *
473
530
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
@@ -491,7 +548,7 @@ export declare class AasRepositoryClient {
491
548
  * - aasIdentifier: The Asset Administration Shell’s unique id
492
549
  * - submodelIdentifier: The Submodel’s unique id
493
550
  * - limit?: The maximum number of elements in the response array
494
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
551
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
495
552
  * - level?: Determines the structural depth of the respective resource content
496
553
  *
497
554
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
@@ -515,7 +572,7 @@ export declare class AasRepositoryClient {
515
572
  * - aasIdentifier: The Asset Administration Shell’s unique id
516
573
  * - submodelIdentifier: The Submodel’s unique id
517
574
  * - limit?: The maximum number of elements in the response array
518
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
575
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
519
576
  * - level?: Determines the structural depth of the respective resource content
520
577
  * - extent?: Determines to which extent the resource is being serialized
521
578
  *