basyx-typescript-sdk 0.2.2 → 1.0.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 (143) hide show
  1. package/README.md +19 -12
  2. package/bundle/index.js +15444 -866
  3. package/bundle/index.js.map +1 -1
  4. package/dist/clients/AasDiscoveryClient.d.ts +68 -0
  5. package/dist/clients/AasDiscoveryClient.js +115 -0
  6. package/dist/clients/AasRegistryClient.d.ts +164 -0
  7. package/dist/clients/AasRegistryClient.js +287 -0
  8. package/dist/clients/AasRepositoryClient.d.ts +791 -103
  9. package/dist/clients/AasRepositoryClient.js +1323 -215
  10. package/dist/clients/AasxFileClient.d.ts +82 -0
  11. package/dist/clients/AasxFileClient.js +148 -0
  12. package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +84 -0
  13. package/dist/clients/ConceptDescriptionRepositoryClient.js +143 -0
  14. package/dist/clients/SubmodelRegistryClient.d.ts +78 -0
  15. package/dist/clients/SubmodelRegistryClient.js +138 -0
  16. package/dist/clients/SubmodelRepositoryClient.d.ts +355 -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 +2 -0
  27. package/dist/generated/AasDiscoveryService/index.js +4 -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/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.d.ts +139 -0
  31. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.js +312 -0
  32. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
  33. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.js +40 -0
  34. package/dist/generated/AasRegistryService/apis/index.d.ts +2 -0
  35. package/dist/generated/AasRegistryService/apis/index.js +4 -0
  36. package/dist/generated/AasRegistryService/index.d.ts +2 -0
  37. package/dist/generated/AasRegistryService/index.js +4 -0
  38. package/dist/generated/AasRegistryService/models/index.d.ts +1070 -0
  39. package/dist/generated/AasRegistryService/models/index.js +151 -0
  40. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.d.ts +870 -0
  41. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.js +1842 -0
  42. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  43. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.js +40 -0
  44. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  45. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.js +49 -0
  46. package/dist/generated/AasRepositoryService/apis/index.d.ts +3 -0
  47. package/dist/generated/AasRepositoryService/apis/index.js +5 -0
  48. package/dist/generated/AasRepositoryService/index.d.ts +2 -0
  49. package/dist/generated/AasRepositoryService/index.js +4 -0
  50. package/dist/generated/AasRepositoryService/models/index.d.ts +4585 -0
  51. package/dist/generated/AasRepositoryService/models/index.js +221 -0
  52. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.d.ts +78 -0
  53. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.js +184 -0
  54. package/dist/generated/AasxFileService/apis/index.d.ts +1 -0
  55. package/dist/generated/AasxFileService/apis/index.js +3 -0
  56. package/dist/generated/AasxFileService/index.d.ts +2 -0
  57. package/dist/generated/AasxFileService/index.js +4 -0
  58. package/dist/generated/AasxFileService/models/index.d.ts +80 -0
  59. package/dist/generated/AasxFileService/models/index.js +10 -0
  60. package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.d.ts +78 -0
  61. package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.js +164 -0
  62. package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  63. package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.js +40 -0
  64. package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  65. package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.js +49 -0
  66. package/dist/generated/ConceptDescriptionRepositoryService/apis/index.d.ts +3 -0
  67. package/dist/generated/ConceptDescriptionRepositoryService/apis/index.js +5 -0
  68. package/dist/generated/ConceptDescriptionRepositoryService/index.d.ts +2 -0
  69. package/dist/generated/ConceptDescriptionRepositoryService/index.js +3 -0
  70. package/dist/generated/ConceptDescriptionRepositoryService/models/index.d.ts +2869 -0
  71. package/dist/generated/ConceptDescriptionRepositoryService/models/index.js +209 -0
  72. package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
  73. package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.js +40 -0
  74. package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.d.ts +75 -0
  75. package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.js +155 -0
  76. package/dist/generated/SubmodelRegistryService/apis/index.d.ts +2 -0
  77. package/dist/generated/SubmodelRegistryService/apis/index.js +4 -0
  78. package/dist/generated/SubmodelRegistryService/index.d.ts +2 -0
  79. package/dist/generated/SubmodelRegistryService/index.js +4 -0
  80. package/dist/generated/SubmodelRegistryService/models/index.d.ts +924 -0
  81. package/dist/generated/SubmodelRegistryService/models/index.js +141 -0
  82. package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  83. package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.js +40 -0
  84. package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  85. package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.js +49 -0
  86. package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.d.ts +802 -0
  87. package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.js +1572 -0
  88. package/dist/generated/SubmodelRepositoryService/apis/index.d.ts +3 -0
  89. package/dist/generated/SubmodelRepositoryService/apis/index.js +5 -0
  90. package/dist/generated/SubmodelRepositoryService/index.d.ts +2 -0
  91. package/dist/generated/SubmodelRepositoryService/index.js +4 -0
  92. package/dist/generated/SubmodelRepositoryService/models/index.d.ts +4623 -0
  93. package/dist/generated/SubmodelRepositoryService/models/index.js +221 -0
  94. package/dist/generated/index.d.ts +9 -2
  95. package/dist/generated/index.js +9 -3
  96. package/dist/generated/runtime.d.ts +181 -0
  97. package/dist/generated/runtime.js +326 -0
  98. package/dist/index.d.ts +1 -1
  99. package/dist/index.js +1 -1
  100. package/dist/lib/apiConfig.d.ts +2 -0
  101. package/dist/lib/apiConfig.js +23 -0
  102. package/dist/lib/base64Url.js +4 -0
  103. package/dist/lib/convertAasDescriptorTypes.d.ts +34 -0
  104. package/dist/lib/convertAasDescriptorTypes.js +76 -0
  105. package/dist/lib/convertAasDiscoveryTypes.d.ts +18 -0
  106. package/dist/lib/convertAasDiscoveryTypes.js +39 -0
  107. package/dist/lib/convertAasTypes.d.ts +7 -7
  108. package/dist/lib/convertAasTypes.js +5 -0
  109. package/dist/lib/convertConceptDescriptionTypes.d.ts +18 -0
  110. package/dist/lib/convertConceptDescriptionTypes.js +39 -0
  111. package/dist/lib/convertSubmodelTypes.d.ts +34 -0
  112. package/dist/lib/convertSubmodelTypes.js +69 -0
  113. package/dist/lib/descriptorJsonization.d.ts +12 -0
  114. package/dist/lib/descriptorJsonization.js +172 -0
  115. package/dist/lib/errorHandler.d.ts +9 -0
  116. package/dist/lib/errorHandler.js +94 -0
  117. package/dist/models/Descriptors.d.ts +51 -0
  118. package/dist/models/Descriptors.js +56 -0
  119. package/dist/models/index.d.ts +0 -1
  120. package/dist/models/index.js +0 -1
  121. package/dist/utils/DescriptorUtils.d.ts +9 -0
  122. package/dist/utils/DescriptorUtils.js +37 -0
  123. package/dist/utils/KeyTypesUtil.d.ts +24 -0
  124. package/dist/utils/KeyTypesUtil.js +55 -0
  125. package/dist/utils/MultiLanguagePropertyUtils.d.ts +24 -0
  126. package/dist/utils/MultiLanguagePropertyUtils.js +46 -0
  127. package/dist/utils/ReferableUtils.d.ts +69 -0
  128. package/dist/utils/ReferableUtils.js +220 -0
  129. package/dist/utils/ReferenceUtil.d.ts +9 -0
  130. package/dist/utils/ReferenceUtil.js +22 -0
  131. package/dist/utils/SemanticIdUtils.d.ts +119 -0
  132. package/dist/utils/SemanticIdUtils.js +363 -0
  133. package/package.json +14 -11
  134. package/dist/generated/schemas.gen.d.ts +0 -2357
  135. package/dist/generated/schemas.gen.js +0 -2789
  136. package/dist/generated/sdk.gen.d.ts +0 -822
  137. package/dist/generated/sdk.gen.js +0 -2225
  138. package/dist/generated/types.gen.d.ts +0 -10829
  139. package/dist/generated/types.gen.js +0 -2
  140. package/dist/lib/createAasRepoClient.d.ts +0 -9
  141. package/dist/lib/createAasRepoClient.js +0 -15
  142. package/dist/models/aas-repository.d.ts +0 -65
  143. package/dist/models/aas-repository.js +0 -1
package/README.md CHANGED
@@ -11,15 +11,20 @@ BaSyx TypeScript SDK for developing applications and components for the Asset Ad
11
11
 
12
12
  Clients for the AAS API components:
13
13
  - AAS Repository
14
- - Submodel Repository (coming soon)
15
- - Concept Description Repository (coming soon)
16
- - AAS Registry (coming soon)
17
- - Submodel Registry (coming soon)
18
- - AAS Discovery Service (coming soon)
19
- - AASX File Service (coming soon)
14
+ - Submodel Repository
15
+ - Concept Description Repository
16
+ - AAS Registry
17
+ - Submodel Registry
18
+ - AAS Discovery Service
19
+ - AASX File Service
20
20
 
21
21
  Utility functions for working with AAS data:
22
- - Coming soon
22
+ - Utils for Descriptors
23
+ - Utils for KeyTypes
24
+ - Utils for MultiLanguageProperties
25
+ - Utils for Referables
26
+ - Utils for References
27
+ - Utils for SemanticIds
23
28
 
24
29
  ## Installation
25
30
 
@@ -34,7 +39,7 @@ yarn add basyx-typescript-sdk
34
39
  ---
35
40
 
36
41
  > [!IMPORTANT]
37
- > Make sure to install `@aas-core-works/aas-core3.0-typescript` in your project:
42
+ > Make sure to also install `@aas-core-works/aas-core3.0-typescript` in your project:
38
43
 
39
44
  ```bash
40
45
  npm install @aas-core-works/aas-core3.0-typescript
@@ -42,17 +47,19 @@ npm install @aas-core-works/aas-core3.0-typescript
42
47
  yarn add @aas-core-works/aas-core3.0-typescript
43
48
  ```
44
49
 
45
- ## Usage
50
+ ## Usage Example
46
51
 
47
52
  ```typescript
48
- import { AasRepositoryClient } from 'basyx-typescript-sdk';
53
+ import { AasRepositoryClient, Configuration } from 'basyx-typescript-sdk';
49
54
 
50
55
  async function getAllShells() {
51
- const baseURL = 'http://localhost:8081';
52
56
  const client = new AasRepositoryClient();
57
+ const configuration = new Configuration({
58
+ basePath: 'http://localhost:8081',
59
+ });
53
60
 
54
61
  try {
55
- const response = await client.getAllAssetAdministrationShells({ baseUrl: baseURL });
62
+ const response = await client.getAllAssetAdministrationShells({ configuration });
56
63
  console.log('Asset Administration Shells fetched successfully:', response);
57
64
  // You can now use the response as needed
58
65
  } catch (error) {