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.
- package/README.md +19 -12
- package/bundle/index.js +15444 -866
- package/bundle/index.js.map +1 -1
- package/dist/clients/AasDiscoveryClient.d.ts +68 -0
- package/dist/clients/AasDiscoveryClient.js +115 -0
- package/dist/clients/AasRegistryClient.d.ts +164 -0
- package/dist/clients/AasRegistryClient.js +287 -0
- package/dist/clients/AasRepositoryClient.d.ts +791 -103
- package/dist/clients/AasRepositoryClient.js +1323 -215
- package/dist/clients/AasxFileClient.d.ts +82 -0
- package/dist/clients/AasxFileClient.js +148 -0
- package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +84 -0
- package/dist/clients/ConceptDescriptionRepositoryClient.js +143 -0
- package/dist/clients/SubmodelRegistryClient.d.ts +78 -0
- package/dist/clients/SubmodelRegistryClient.js +138 -0
- package/dist/clients/SubmodelRepositoryClient.d.ts +355 -0
- package/dist/clients/SubmodelRepositoryClient.js +585 -0
- package/dist/clients/index.d.ts +6 -0
- package/dist/clients/index.js +6 -0
- package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.d.ts +80 -0
- package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.js +156 -0
- package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/AasDiscoveryService/apis/index.d.ts +2 -0
- package/dist/generated/AasDiscoveryService/apis/index.js +4 -0
- package/dist/generated/AasDiscoveryService/index.d.ts +2 -0
- package/dist/generated/AasDiscoveryService/index.js +4 -0
- package/dist/generated/AasDiscoveryService/models/index.d.ts +297 -0
- package/dist/generated/AasDiscoveryService/models/index.js +48 -0
- package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.d.ts +139 -0
- package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.js +312 -0
- package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/AasRegistryService/apis/index.d.ts +2 -0
- package/dist/generated/AasRegistryService/apis/index.js +4 -0
- package/dist/generated/AasRegistryService/index.d.ts +2 -0
- package/dist/generated/AasRegistryService/index.js +4 -0
- package/dist/generated/AasRegistryService/models/index.d.ts +1070 -0
- package/dist/generated/AasRegistryService/models/index.js +151 -0
- package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.d.ts +870 -0
- package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.js +1842 -0
- package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
- package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.js +49 -0
- package/dist/generated/AasRepositoryService/apis/index.d.ts +3 -0
- package/dist/generated/AasRepositoryService/apis/index.js +5 -0
- package/dist/generated/AasRepositoryService/index.d.ts +2 -0
- package/dist/generated/AasRepositoryService/index.js +4 -0
- package/dist/generated/AasRepositoryService/models/index.d.ts +4585 -0
- package/dist/generated/AasRepositoryService/models/index.js +221 -0
- package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.d.ts +78 -0
- package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.js +184 -0
- package/dist/generated/AasxFileService/apis/index.d.ts +1 -0
- package/dist/generated/AasxFileService/apis/index.js +3 -0
- package/dist/generated/AasxFileService/index.d.ts +2 -0
- package/dist/generated/AasxFileService/index.js +4 -0
- package/dist/generated/AasxFileService/models/index.d.ts +80 -0
- package/dist/generated/AasxFileService/models/index.js +10 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.d.ts +78 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.js +164 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.js +49 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/index.d.ts +3 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/index.js +5 -0
- package/dist/generated/ConceptDescriptionRepositoryService/index.d.ts +2 -0
- package/dist/generated/ConceptDescriptionRepositoryService/index.js +3 -0
- package/dist/generated/ConceptDescriptionRepositoryService/models/index.d.ts +2869 -0
- package/dist/generated/ConceptDescriptionRepositoryService/models/index.js +209 -0
- package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.d.ts +75 -0
- package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.js +155 -0
- package/dist/generated/SubmodelRegistryService/apis/index.d.ts +2 -0
- package/dist/generated/SubmodelRegistryService/apis/index.js +4 -0
- package/dist/generated/SubmodelRegistryService/index.d.ts +2 -0
- package/dist/generated/SubmodelRegistryService/index.js +4 -0
- package/dist/generated/SubmodelRegistryService/models/index.d.ts +924 -0
- package/dist/generated/SubmodelRegistryService/models/index.js +141 -0
- package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
- package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.js +49 -0
- package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.d.ts +802 -0
- package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.js +1572 -0
- package/dist/generated/SubmodelRepositoryService/apis/index.d.ts +3 -0
- package/dist/generated/SubmodelRepositoryService/apis/index.js +5 -0
- package/dist/generated/SubmodelRepositoryService/index.d.ts +2 -0
- package/dist/generated/SubmodelRepositoryService/index.js +4 -0
- package/dist/generated/SubmodelRepositoryService/models/index.d.ts +4623 -0
- package/dist/generated/SubmodelRepositoryService/models/index.js +221 -0
- package/dist/generated/index.d.ts +9 -2
- package/dist/generated/index.js +9 -3
- package/dist/generated/runtime.d.ts +181 -0
- package/dist/generated/runtime.js +326 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/lib/apiConfig.d.ts +2 -0
- package/dist/lib/apiConfig.js +23 -0
- package/dist/lib/base64Url.js +4 -0
- package/dist/lib/convertAasDescriptorTypes.d.ts +34 -0
- package/dist/lib/convertAasDescriptorTypes.js +76 -0
- package/dist/lib/convertAasDiscoveryTypes.d.ts +18 -0
- package/dist/lib/convertAasDiscoveryTypes.js +39 -0
- package/dist/lib/convertAasTypes.d.ts +7 -7
- package/dist/lib/convertAasTypes.js +5 -0
- package/dist/lib/convertConceptDescriptionTypes.d.ts +18 -0
- package/dist/lib/convertConceptDescriptionTypes.js +39 -0
- package/dist/lib/convertSubmodelTypes.d.ts +34 -0
- package/dist/lib/convertSubmodelTypes.js +69 -0
- package/dist/lib/descriptorJsonization.d.ts +12 -0
- package/dist/lib/descriptorJsonization.js +172 -0
- package/dist/lib/errorHandler.d.ts +9 -0
- package/dist/lib/errorHandler.js +94 -0
- package/dist/models/Descriptors.d.ts +51 -0
- package/dist/models/Descriptors.js +56 -0
- package/dist/models/index.d.ts +0 -1
- package/dist/models/index.js +0 -1
- package/dist/utils/DescriptorUtils.d.ts +9 -0
- package/dist/utils/DescriptorUtils.js +37 -0
- package/dist/utils/KeyTypesUtil.d.ts +24 -0
- package/dist/utils/KeyTypesUtil.js +55 -0
- package/dist/utils/MultiLanguagePropertyUtils.d.ts +24 -0
- package/dist/utils/MultiLanguagePropertyUtils.js +46 -0
- package/dist/utils/ReferableUtils.d.ts +69 -0
- package/dist/utils/ReferableUtils.js +220 -0
- package/dist/utils/ReferenceUtil.d.ts +9 -0
- package/dist/utils/ReferenceUtil.js +22 -0
- package/dist/utils/SemanticIdUtils.d.ts +119 -0
- package/dist/utils/SemanticIdUtils.js +363 -0
- package/package.json +14 -11
- package/dist/generated/schemas.gen.d.ts +0 -2357
- package/dist/generated/schemas.gen.js +0 -2789
- package/dist/generated/sdk.gen.d.ts +0 -822
- package/dist/generated/sdk.gen.js +0 -2225
- package/dist/generated/types.gen.d.ts +0 -10829
- package/dist/generated/types.gen.js +0 -2
- package/dist/lib/createAasRepoClient.d.ts +0 -9
- package/dist/lib/createAasRepoClient.js +0 -15
- package/dist/models/aas-repository.d.ts +0 -65
- package/dist/models/aas-repository.js +0 -1
|
@@ -0,0 +1,363 @@
|
|
|
1
|
+
import { ModelType, } from '@aas-core-works/aas-core3.0-typescript/types';
|
|
2
|
+
const versionRevisionRegex = /\/(\d{1,})\/(\d{1,})(\/|$)/; // This regex matches the version/revision string of a semanticId ".../version/revision"
|
|
3
|
+
/**
|
|
4
|
+
* Checks if the `semanticId` of a SubmodelElement (SME) matches the given `semanticId`.
|
|
5
|
+
* The function verifies that the `semanticId` is non-empty and that the SubmodelElement
|
|
6
|
+
* contains a valid array of semantic ID keys. It also determines the matching strategy
|
|
7
|
+
* based on the prefix of the keys in the SubmodelElement's semantic ID.
|
|
8
|
+
*
|
|
9
|
+
* @param {ISubmodelElement} submodelElement - The SubmodelElement object containing semantic ID keys.
|
|
10
|
+
* @param {string} semanticId - The `semanticId` string to compare against the SME's `semanticId`.
|
|
11
|
+
* @returns {boolean} Returns true if a matching `semanticId` is found, false otherwise.
|
|
12
|
+
*/
|
|
13
|
+
export function checkSemanticId(submodelElement, semanticId) {
|
|
14
|
+
if (semanticId.trim() == '')
|
|
15
|
+
return false;
|
|
16
|
+
semanticId = semanticId.trim();
|
|
17
|
+
if (!Array.isArray(submodelElement?.semanticId?.keys) || submodelElement.semanticId.keys.length == 0)
|
|
18
|
+
return false;
|
|
19
|
+
for (const key of submodelElement.semanticId.keys) {
|
|
20
|
+
// console.log('checkSemanticId: ', 'key of submodelElement', key.value, 'semanticId', semanticId);
|
|
21
|
+
if (key.value.startsWith('0112/')) {
|
|
22
|
+
return checkSemanticIdIecCdd(key.value, semanticId);
|
|
23
|
+
}
|
|
24
|
+
else if (key.value.startsWith('0173-1#') || key.value.startsWith('0173/1///')) {
|
|
25
|
+
return checkSemanticIdEclassIrdi(key.value, semanticId);
|
|
26
|
+
}
|
|
27
|
+
else if (key.value.startsWith('https://api.eclass-cdp.com/0173-1')) {
|
|
28
|
+
return checkSemanticIdEclassIrdiUrl(key.value, semanticId);
|
|
29
|
+
}
|
|
30
|
+
else if (key.value.startsWith('http://') || key.value.startsWith('https://')) {
|
|
31
|
+
return checkSemanticIdIri(key.value, semanticId);
|
|
32
|
+
}
|
|
33
|
+
else {
|
|
34
|
+
if (key.value === semanticId)
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
return false;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Checks whether a given EClass IRDI semantic ID matches an equivalent key value.
|
|
42
|
+
* The function validates that both `keyValue` and `semanticId` are non-empty. It verifies that the `keyValue`
|
|
43
|
+
* starts with either "0173-1#" or "0173/1///" and compares the two IDs based on specific criteria for
|
|
44
|
+
* versioned and non-versioned IDs.
|
|
45
|
+
*
|
|
46
|
+
* @param {string} keyValue - The key value representing the original EClass IRDI ID to compare against.
|
|
47
|
+
* @param {string} semanticId - The EClass semantic ID to be checked for equivalence.
|
|
48
|
+
* @returns {boolean} Returns true if the `semanticId` matches the `keyValue`, false otherwise.
|
|
49
|
+
*/
|
|
50
|
+
export function checkSemanticIdEclassIrdi(keyValue, semanticId) {
|
|
51
|
+
if (semanticId.trim() == '')
|
|
52
|
+
return false;
|
|
53
|
+
semanticId = semanticId.trim();
|
|
54
|
+
if (!keyValue.startsWith('0173-1#') && !keyValue.startsWith('0173/1///'))
|
|
55
|
+
return false;
|
|
56
|
+
if (keyValue.startsWith('0173-1#')) {
|
|
57
|
+
// Eclass IRDI like 0173-1#01-AHF578#001
|
|
58
|
+
if (new RegExp(/\*\d{2}$/).test(keyValue)) {
|
|
59
|
+
keyValue = keyValue.slice(0, -3);
|
|
60
|
+
semanticId = semanticId.slice(0, -3);
|
|
61
|
+
}
|
|
62
|
+
if (new RegExp(/[#-]{1}\d{3}$/).test(semanticId) || new RegExp(/[#-]{1}\d{3}\*\d{1,}$/).test(semanticId)) {
|
|
63
|
+
return getEquivalentEclassSemanticIds(keyValue).includes(semanticId);
|
|
64
|
+
}
|
|
65
|
+
// Eclass IRDI without version; like 0173-1#01-AHF578
|
|
66
|
+
return (getEquivalentEclassSemanticIds(keyValue).findIndex((equivalentSemanticId) => {
|
|
67
|
+
return equivalentSemanticId.startsWith(semanticId);
|
|
68
|
+
}, semanticId) != -1);
|
|
69
|
+
}
|
|
70
|
+
else if (keyValue.startsWith('0173/1///')) {
|
|
71
|
+
if (new RegExp(/[#-]{1}\d{3}$/).test(semanticId) || new RegExp(/[#-]{1}\d{3}\*\d{1,}$/).test(semanticId)) {
|
|
72
|
+
// Eclass IRDI with version; like 0173/1///01#AHF578#001
|
|
73
|
+
return getEquivalentEclassSemanticIds(keyValue).includes(semanticId);
|
|
74
|
+
}
|
|
75
|
+
// Eclass IRDI without version; like 0173/1///01#AHF578
|
|
76
|
+
return (getEquivalentEclassSemanticIds(keyValue).findIndex((equivalentSemanticId) => {
|
|
77
|
+
return equivalentSemanticId.startsWith(semanticId);
|
|
78
|
+
}, semanticId) != -1);
|
|
79
|
+
}
|
|
80
|
+
return false;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Checks whether a given EClass IRDI URL semantic ID matches an equivalent key value.
|
|
84
|
+
* The function validates that both `keyValue` and `semanticId` are non-empty and that the `keyValue`
|
|
85
|
+
* starts with the specified base URL. It then checks if the `semanticId` has a version and
|
|
86
|
+
* compares it accordingly.
|
|
87
|
+
*
|
|
88
|
+
* @param {string} keyValue - The key value representing the original EClass IRDI URL to compare against.
|
|
89
|
+
* @param {string} semanticId - The EClass semantic ID to be checked for equivalence.
|
|
90
|
+
* @returns {boolean} Returns true if the `semanticId` matches the `keyValue`, false otherwise.
|
|
91
|
+
*/
|
|
92
|
+
export function checkSemanticIdEclassIrdiUrl(keyValue, semanticId) {
|
|
93
|
+
if (semanticId.trim() == '')
|
|
94
|
+
return false;
|
|
95
|
+
semanticId = semanticId.trim();
|
|
96
|
+
if (!keyValue.startsWith('https://api.eclass-cdp.com/0173-1'))
|
|
97
|
+
return false;
|
|
98
|
+
// Eclass URL like https://api.eclass-cdp.com/0173-1-01-AHF578-001
|
|
99
|
+
if (new RegExp(/[#-]{1}\d{3}$/).test(semanticId) || new RegExp(/[#-]{1}\d{3}~\d{1,}$/).test(semanticId)) {
|
|
100
|
+
// Eclass URL with version (like https://api.eclass-cdp.com/0173-1-01-AHF578-001)
|
|
101
|
+
return getEquivalentEclassSemanticIds(semanticId).includes(keyValue);
|
|
102
|
+
}
|
|
103
|
+
// Eclass URL without version (like https://api.eclass-cdp.com/0173-1-01-AHF578)
|
|
104
|
+
return (getEquivalentEclassSemanticIds(keyValue).findIndex((equivalentSemanticId) => {
|
|
105
|
+
return equivalentSemanticId.startsWith(semanticId);
|
|
106
|
+
}, semanticId) != -1);
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Checks whether a given IEC CDD semantic ID matches the equivalent key value.
|
|
110
|
+
* The function validates that both `keyValue` and `semanticId` are non-empty and start with "0112/".
|
|
111
|
+
* It then determines if the two values are equivalent based on specific criteria for versioned and non-versioned IDs.
|
|
112
|
+
*
|
|
113
|
+
* @param {string} keyValue - The key value representing the original IEC CDD semantic ID to compare against.
|
|
114
|
+
* @param {string} semanticId - The IEC CDD semantic ID to be checked for equivalence.
|
|
115
|
+
* @returns {boolean} Returns true if the `semanticId` matches the `keyValue`, false otherwise.
|
|
116
|
+
*/
|
|
117
|
+
export function checkSemanticIdIecCdd(keyValue, semanticId) {
|
|
118
|
+
if (semanticId.trim() == '')
|
|
119
|
+
return false;
|
|
120
|
+
semanticId = semanticId.trim();
|
|
121
|
+
if (!semanticId.startsWith('0112/'))
|
|
122
|
+
return false;
|
|
123
|
+
if (!keyValue.startsWith('0112/'))
|
|
124
|
+
return false;
|
|
125
|
+
// IEC CDD like 0112/2///61987#ABN590#002
|
|
126
|
+
if (new RegExp(/[#-]{1}\d{3}$/).test(semanticId)) {
|
|
127
|
+
// IEC CDD with version; like 0112/2///61987#ABN590#002
|
|
128
|
+
if (keyValue === semanticId) {
|
|
129
|
+
return true;
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
// IEC CDD without version; like 0112/2///61987#ABN590
|
|
133
|
+
return keyValue.startsWith(semanticId);
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* Checks whether a given semantic ID matches the equivalent IRI derived from a key value.
|
|
137
|
+
* The function verifies both the validity of the semantic ID and key value, and compares them.
|
|
138
|
+
*
|
|
139
|
+
* It considers:
|
|
140
|
+
* - Validity checks for the `semanticId` and `keyValue` (they must be non-empty and start with http/https).
|
|
141
|
+
* - Normalization of the `keyValue` and `semanticId` by removing any trailing slashes.
|
|
142
|
+
* - Different comparison strategies depending on whether the `semanticId` indicates a versioned or non-versioned IRI.
|
|
143
|
+
*
|
|
144
|
+
* @param {string} keyValue - The key value representing the original IRI to compare against.
|
|
145
|
+
* @param {string} semanticId - The semantic ID IRI to be checked for equivalence.
|
|
146
|
+
* @returns {boolean} Returns true if the `semanticId` matches the equivalent IRI derived from `keyValue`, false otherwise.
|
|
147
|
+
*/
|
|
148
|
+
export function checkSemanticIdIri(keyValue, semanticId) {
|
|
149
|
+
if (semanticId.trim() == '')
|
|
150
|
+
return false;
|
|
151
|
+
semanticId = semanticId.trim();
|
|
152
|
+
if (!semanticId.startsWith('http://') && !semanticId.startsWith('https://'))
|
|
153
|
+
return false;
|
|
154
|
+
if (!keyValue.startsWith('http://') && !keyValue.startsWith('https://'))
|
|
155
|
+
return false;
|
|
156
|
+
if (keyValue.endsWith('/'))
|
|
157
|
+
keyValue = keyValue.substring(0, keyValue.length - 1);
|
|
158
|
+
if (semanticId.endsWith('/'))
|
|
159
|
+
semanticId = semanticId.substring(0, semanticId.length - 1);
|
|
160
|
+
if (new RegExp(/\/\d{1,}\/\d{1,}\/{0,1}$/).test(semanticId) || new RegExp(/\/\d{1,}\/\d{1,}\//).test(semanticId)) {
|
|
161
|
+
// IRI with version like https://admin-shell.io/idta/CarbonFootprint/ProductCarbonFootprint/0/9
|
|
162
|
+
// IRI with version like https://admin-shell.io/zvei/nameplate/1/0/ContactInformations
|
|
163
|
+
return (getEquivalentIriSemanticIds(keyValue).findIndex((equivalentSemanticId) => {
|
|
164
|
+
return equivalentSemanticId.toLowerCase() === semanticId.toLowerCase();
|
|
165
|
+
}, semanticId) != -1);
|
|
166
|
+
}
|
|
167
|
+
// IRI without version like https://admin-shell.io/idta/CarbonFootprint/ProductCarbonFootprint/
|
|
168
|
+
return (getEquivalentIriSemanticIds(keyValue).findIndex((equivalentSemanticId) => {
|
|
169
|
+
return equivalentSemanticId.toLowerCase().startsWith(semanticId.toLowerCase());
|
|
170
|
+
}, semanticId) != -1);
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* Generates an array of equivalent EClass semantic IDs based on the provided `semanticId`.
|
|
174
|
+
* The function checks if the input `semanticId` is valid before generating its equivalents.
|
|
175
|
+
* Valid formats are:
|
|
176
|
+
* - "0173-1#..."
|
|
177
|
+
* - "0173/1///..."
|
|
178
|
+
* - "https://api.eclass-cdp.com/0173-1..."
|
|
179
|
+
*
|
|
180
|
+
* Returns the original `semanticId` and its variations based on specific rules depending on its format:
|
|
181
|
+
* - Converts "0173-1#" to "0173/1///" and an API URL format.
|
|
182
|
+
* - Converts "0173/1///" to "0173-1#" and the corresponding API URL format.
|
|
183
|
+
* - Converts the API URL format back to "0173-1#" and "0173/1///".
|
|
184
|
+
*
|
|
185
|
+
* @param {string} semanticId - The EClass semantic ID to evaluate and convert.
|
|
186
|
+
* @returns {any[]} An array of the original `semanticId` and its equivalent variations,
|
|
187
|
+
* or an empty array if the input is invalid.
|
|
188
|
+
*/
|
|
189
|
+
export function getEquivalentEclassSemanticIds(semanticId) {
|
|
190
|
+
if (semanticId.trim() === '' ||
|
|
191
|
+
(!semanticId.startsWith('0173-1#') &&
|
|
192
|
+
!semanticId.startsWith('0173/1///') &&
|
|
193
|
+
!semanticId.startsWith('https://api.eclass-cdp.com/0173-1'))) {
|
|
194
|
+
return [];
|
|
195
|
+
}
|
|
196
|
+
semanticId = semanticId.trim();
|
|
197
|
+
const semanticIds = [semanticId];
|
|
198
|
+
if (semanticId.startsWith('0173-1#')) {
|
|
199
|
+
// e.g. 0173-1#01-AHF578#001
|
|
200
|
+
semanticIds.push(semanticId.replace(/-1#(\d{2})-/, '/1///$1#')); // 0173-1#01-AHF578#001 --> 0173/1///01#AHF578#001
|
|
201
|
+
semanticIds.push('https://api.eclass-cdp.com/' + semanticId.replaceAll('#', '-')); // 0173-1#01-AHF578#001 --> https://api.eclass-cdp.com/0173-1-01-AHF578-001
|
|
202
|
+
}
|
|
203
|
+
else if (semanticId.startsWith('0173/1///')) {
|
|
204
|
+
// e.g. 0173/1///01#AHF578#001
|
|
205
|
+
semanticIds.push(semanticId.replace(/\/1\/\/\/(\d{2})#/, '-1#$1-')); // 0173/1///01#AHF578#001 --> 0173-1#01-AHF578#001
|
|
206
|
+
semanticIds.push('https://api.eclass-cdp.com/' + semanticId.replace(/\/1\/\/\/(\d{2})#/, '-1-$1-').replaceAll('#', '-') // 0173/1///01#AHF578#001 --> https://api.eclass-cdp.com/0173-1-01-AHF578-001
|
|
207
|
+
);
|
|
208
|
+
}
|
|
209
|
+
else if (semanticId.startsWith('https://api.eclass-cdp.com/0173-1')) {
|
|
210
|
+
// e.g. https://api.eclass-cdp.com/0173-1-01-AHF578-001
|
|
211
|
+
semanticIds.push(semanticId
|
|
212
|
+
.replaceAll('https://api.eclass-cdp.com/', '')
|
|
213
|
+
.replace(/-1-(\d{2})-/, '-1#$1-')
|
|
214
|
+
.replace(/-(\d{3})$/, '#$1') // https://api.eclass-cdp.com/0173-1-01-AHF578-001 --> 0173-1#01-AHF578#001
|
|
215
|
+
);
|
|
216
|
+
semanticIds.push(semanticId
|
|
217
|
+
.replaceAll('https://api.eclass-cdp.com/', '')
|
|
218
|
+
.replace(/-1-(\d{2})-/, '/1///$1#')
|
|
219
|
+
.replace(/-(\d{3})$/, '#$1') // https://api.eclass-cdp.com/0173-1-01-AHF578-001 --> 0173/1///01#AHF578#001
|
|
220
|
+
);
|
|
221
|
+
}
|
|
222
|
+
return semanticIds;
|
|
223
|
+
}
|
|
224
|
+
/**
|
|
225
|
+
* Generates an array of equivalent IRI (Internationalized Resource Identifier) semantic IDs
|
|
226
|
+
* based on the given `semanticId`.
|
|
227
|
+
*
|
|
228
|
+
* The function checks if the `semanticId` is a valid IRI (i.e., it starts with "http://" or "https://").
|
|
229
|
+
* It will return an empty array if the `semanticId` is invalid. If the `semanticId` is valid,
|
|
230
|
+
* it will also include variations with a trailing slash or without one in the resultant array.
|
|
231
|
+
*
|
|
232
|
+
* @param {string} semanticId - The semantic ID to evaluate.
|
|
233
|
+
* @returns {any[]} An array containing the original `semanticId` and its equivalent variations,
|
|
234
|
+
* or an empty array if the input is invalid.
|
|
235
|
+
*/
|
|
236
|
+
export function getEquivalentIriSemanticIds(semanticId) {
|
|
237
|
+
if (semanticId.trim() === '' || !(semanticId.startsWith('http://') || semanticId.startsWith('https://'))) {
|
|
238
|
+
return [];
|
|
239
|
+
}
|
|
240
|
+
semanticId = semanticId.trim();
|
|
241
|
+
const semanticIds = [semanticId];
|
|
242
|
+
// e.g. IRI
|
|
243
|
+
if (semanticId.endsWith('/')) {
|
|
244
|
+
semanticIds.push(semanticId.substring(0, semanticId.length - 1));
|
|
245
|
+
}
|
|
246
|
+
else {
|
|
247
|
+
semanticIds.push(semanticId + '/');
|
|
248
|
+
}
|
|
249
|
+
return semanticIds;
|
|
250
|
+
}
|
|
251
|
+
/**
|
|
252
|
+
* Retrieves a SubmodelElement (SME) by its `semanticId` from a given Submodel (SM) or SubmodelElement (SME).
|
|
253
|
+
* If the `semanticId` is not found or if the input is invalid, an empty object is returned.
|
|
254
|
+
*
|
|
255
|
+
* The function supports the following types of elements:
|
|
256
|
+
* - **Submodel (SM)**: Searches through `submodelElements`.
|
|
257
|
+
* - **SubmodelElementCollection (SMC)** and **SubmodelElementList (SML)**: Searches through their `value` arrays.
|
|
258
|
+
*
|
|
259
|
+
* @param {string} semanticId - The `semanticId` of the SME to search for.
|
|
260
|
+
* @param {Submodel | ISubmodelElement} submodelElement - The parent SM/SME to search within.
|
|
261
|
+
* @returns {ISubmodelElement | undefined} The found SME or an empty object if not found or input is invalid.
|
|
262
|
+
*/
|
|
263
|
+
export function getSubmodelElementBySemanticId(semanticId, submodelElement) {
|
|
264
|
+
if (semanticId.trim() == '')
|
|
265
|
+
return undefined;
|
|
266
|
+
semanticId = semanticId.trim();
|
|
267
|
+
if (!submodelElement?.modelType)
|
|
268
|
+
return undefined;
|
|
269
|
+
switch (submodelElement.modelType()) {
|
|
270
|
+
case ModelType.Submodel: {
|
|
271
|
+
const submodel = submodelElement;
|
|
272
|
+
if (submodel.submodelElements && submodel.submodelElements.length > 0) {
|
|
273
|
+
return submodel.submodelElements.find((sme) => {
|
|
274
|
+
return checkSemanticId(sme, semanticId);
|
|
275
|
+
});
|
|
276
|
+
}
|
|
277
|
+
break;
|
|
278
|
+
}
|
|
279
|
+
case ModelType.SubmodelElementCollection: {
|
|
280
|
+
const collection = submodelElement;
|
|
281
|
+
if (collection.value && collection.value.length > 0) {
|
|
282
|
+
return collection.value.find((sme) => {
|
|
283
|
+
return checkSemanticId(sme, semanticId);
|
|
284
|
+
});
|
|
285
|
+
}
|
|
286
|
+
break;
|
|
287
|
+
}
|
|
288
|
+
case ModelType.SubmodelElementList: {
|
|
289
|
+
const list = submodelElement;
|
|
290
|
+
if (list.value && list.value.length > 0) {
|
|
291
|
+
return list.value.find((sme) => {
|
|
292
|
+
return checkSemanticId(sme, semanticId);
|
|
293
|
+
});
|
|
294
|
+
}
|
|
295
|
+
break;
|
|
296
|
+
}
|
|
297
|
+
}
|
|
298
|
+
return undefined;
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* Retrieves an array of SubmodelElements (SMEs) by their `semanticId` from a given Submodel (SM) or SubmodelElement (SME).
|
|
302
|
+
* If the `semanticId` is not found or if the input is invalid, an empty array is returned.
|
|
303
|
+
*
|
|
304
|
+
* The function supports the following types of elements:
|
|
305
|
+
* - **Submodel (SM)**: Filters through `submodelElements`.
|
|
306
|
+
* - **SubmodelElementCollection (SMC)** and **SubmodelElementList (SML)**: Filters through their `value` arrays.
|
|
307
|
+
*
|
|
308
|
+
* @param {string} semanticId - The `semanticId` of the SMEs to search for.
|
|
309
|
+
* @param {Submodel | ISubmodelElement} submodelElement - The parent SM/SME to search within.
|
|
310
|
+
* @returns {ISubmodelElement[]} An array of found SMEs matching the `idShort`, or an empty array if not found or input is invalid.
|
|
311
|
+
*/
|
|
312
|
+
export function getSubmodelElementsBySemanticId(semanticId, submodelElement) {
|
|
313
|
+
if (semanticId.trim() == '')
|
|
314
|
+
return [];
|
|
315
|
+
semanticId = semanticId.trim();
|
|
316
|
+
if (!submodelElement?.modelType)
|
|
317
|
+
return [];
|
|
318
|
+
switch (submodelElement.modelType()) {
|
|
319
|
+
case ModelType.Submodel: {
|
|
320
|
+
const submodel = submodelElement;
|
|
321
|
+
if (submodel.submodelElements && submodel.submodelElements.length > 0) {
|
|
322
|
+
return submodel.submodelElements.filter((sme) => {
|
|
323
|
+
return checkSemanticId(sme, semanticId);
|
|
324
|
+
});
|
|
325
|
+
}
|
|
326
|
+
break;
|
|
327
|
+
}
|
|
328
|
+
case ModelType.SubmodelElementCollection: {
|
|
329
|
+
const collection = submodelElement;
|
|
330
|
+
if (collection.value && collection.value.length > 0) {
|
|
331
|
+
return collection.value.filter((sme) => {
|
|
332
|
+
return checkSemanticId(sme, semanticId);
|
|
333
|
+
});
|
|
334
|
+
}
|
|
335
|
+
break;
|
|
336
|
+
}
|
|
337
|
+
case ModelType.SubmodelElementList: {
|
|
338
|
+
const list = submodelElement;
|
|
339
|
+
if (list.value && list.value.length > 0) {
|
|
340
|
+
return list.value.filter((sme) => {
|
|
341
|
+
return checkSemanticId(sme, semanticId);
|
|
342
|
+
});
|
|
343
|
+
}
|
|
344
|
+
break;
|
|
345
|
+
}
|
|
346
|
+
}
|
|
347
|
+
return [];
|
|
348
|
+
}
|
|
349
|
+
export function extractVersionRevision(semanticId) {
|
|
350
|
+
const failResponse = { version: '', revision: '' };
|
|
351
|
+
if (semanticId.trim() == '')
|
|
352
|
+
return failResponse;
|
|
353
|
+
semanticId = semanticId.trim();
|
|
354
|
+
const match = semanticId.match(versionRevisionRegex);
|
|
355
|
+
if (match) {
|
|
356
|
+
const response = {
|
|
357
|
+
version: match && match[1] ? match[1] : '',
|
|
358
|
+
revision: match && match[2] ? match[2] : '',
|
|
359
|
+
};
|
|
360
|
+
return response;
|
|
361
|
+
}
|
|
362
|
+
return failResponse;
|
|
363
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "basyx-typescript-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "BaSyx TypeScript SDK for developing applications and components for the Asset Administration Shell (AAS)",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "bundle/index.js",
|
|
@@ -21,35 +21,38 @@
|
|
|
21
21
|
"LICENSE"
|
|
22
22
|
],
|
|
23
23
|
"scripts": {
|
|
24
|
-
"openapi-ts": "openapi-ts",
|
|
25
24
|
"build": "tsc",
|
|
26
25
|
"bundle": "rollup -c",
|
|
27
26
|
"lint:check": "eslint ./",
|
|
28
27
|
"lint:fix": "eslint --fix ./",
|
|
29
28
|
"test": "jest --coverage",
|
|
30
|
-
"docs": "typedoc --options typedoc.json"
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
"
|
|
29
|
+
"docs": "typedoc --options typedoc.json",
|
|
30
|
+
"gen-aasrepo": "openapi-generator-cli generate -i openapi/aasrepository.yaml -g typescript-fetch -o src/generated/AasRepositoryService --additional-properties=withoutRuntimeChecks=true",
|
|
31
|
+
"gen-submodelrepo": "openapi-generator-cli generate -i openapi/smrepository.yaml -g typescript-fetch -o src/generated/SubmodelRepositoryService --additional-properties=withoutRuntimeChecks=true",
|
|
32
|
+
"gen-conceptdescriptionrepo": "openapi-generator-cli generate -i openapi/cdrepository.yaml -g typescript-fetch -o src/generated/ConceptDescriptionRepositoryService --additional-properties=withoutRuntimeChecks=true",
|
|
33
|
+
"gen-aasregistry": "openapi-generator-cli generate -i openapi/aasregistry.yaml -g typescript-fetch -o src/generated/AasRegistryService --additional-properties=withoutRuntimeChecks=true",
|
|
34
|
+
"gen-smregistry": "openapi-generator-cli generate -i openapi/smregistry.yaml -g typescript-fetch -o src/generated/SubmodelRegistryService --additional-properties=withoutRuntimeChecks=true",
|
|
35
|
+
"gen-aasdiscovery": "openapi-generator-cli generate -i openapi/aasdiscovery.yaml -g typescript-fetch -o src/generated/AasDiscoveryService --additional-properties=withoutRuntimeChecks=true",
|
|
36
|
+
"gen-aasxfileserver": "openapi-generator-cli generate -i openapi/aasxfileserver.yaml -g typescript-fetch -o src/generated/AasxFileService --additional-properties=withoutRuntimeChecks=true"
|
|
37
|
+
|
|
34
38
|
},
|
|
35
39
|
"peerDependencies": {
|
|
36
40
|
"@aas-core-works/aas-core3.0-typescript": "^1.0.3"
|
|
37
41
|
},
|
|
38
42
|
"devDependencies": {
|
|
39
43
|
"@aas-core-works/aas-core3.0-typescript": "^1.0.3",
|
|
40
|
-
"@
|
|
44
|
+
"@openapitools/openapi-generator-cli": "^2.18.4",
|
|
41
45
|
"@rollup/plugin-node-resolve": "^16.0.0",
|
|
42
|
-
"@types/jest": "^
|
|
43
|
-
"@types/node": "^
|
|
46
|
+
"@types/jest": "^30.0.0",
|
|
47
|
+
"@types/node": "^24.0.0",
|
|
44
48
|
"@typescript-eslint/eslint-plugin": "^8.21.0",
|
|
45
49
|
"@typescript-eslint/parser": "^8.20.0",
|
|
46
50
|
"eslint": "^9.18.0",
|
|
47
51
|
"eslint-config-prettier": "^10.0.1",
|
|
48
52
|
"eslint-plugin-prettier": "^5.2.3",
|
|
49
53
|
"eslint-plugin-simple-import-sort": "^12.1.1",
|
|
50
|
-
"jest": "^
|
|
54
|
+
"jest": "^30.0.0",
|
|
51
55
|
"jiti": "^2.4.2",
|
|
52
|
-
"openapi-typescript-codegen": "^0.29.0",
|
|
53
56
|
"prettier": "^3.4.2",
|
|
54
57
|
"rollup": "^4.34.6",
|
|
55
58
|
"ts-jest": "^29.2.5",
|