basyx-typescript-sdk 2.0.0 → 2.1.1

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.
@@ -1,44 +1,29 @@
1
1
  import { jsonization } from '@aas-core-works/aas-core3.1-typescript';
2
- import { AdministrativeInformation, AnnotatedRelationshipElement, AssetAdministrationShell, AssetInformation, AssetKind, BasicEventElement, Blob, Capability, ConceptDescription, DataSpecificationIec61360, DataTypeDefXsd, EmbeddedDataSpecification, Entity, Extension, File, Key, KeyTypes, LangStringDefinitionTypeIec61360, LangStringNameType, LangStringPreferredNameTypeIec61360, LangStringShortNameTypeIec61360, LangStringTextType, LevelType, MultiLanguageProperty, Operation, OperationVariable, Property, Qualifier, Range, Reference, ReferenceElement, ReferenceTypes, RelationshipElement, Resource, SpecificAssetId, Submodel, SubmodelElementCollection, SubmodelElementList, ValueList, ValueReferencePair, } from '@aas-core-works/aas-core3.1-typescript/types';
3
- import { XMLBuilder, XMLParser } from 'fast-xml-parser';
2
+ import { AdministrativeInformation, AnnotatedRelationshipElement, AssetAdministrationShell, AssetInformation, AssetKind, BasicEventElement, Blob, Capability, ConceptDescription, DataSpecificationIec61360, EmbeddedDataSpecification, Entity, Extension, File, Key, KeyTypes, LangStringDefinitionTypeIec61360, LangStringNameType, LangStringPreferredNameTypeIec61360, LangStringShortNameTypeIec61360, LangStringTextType, LevelType, MultiLanguageProperty, Operation, OperationVariable, Property, Qualifier, Range, Reference, ReferenceElement, ReferenceTypes, RelationshipElement, Resource, SpecificAssetId, Submodel, SubmodelElementCollection, SubmodelElementList, ValueList, ValueReferencePair, } from '@aas-core-works/aas-core3.1-typescript/types';
3
+ import { buildObject, buildXmlNode, parseXmlString, serializeXml as serializeXmlNode } from 'xml-sax-ts';
4
4
  import { BaSyxEnvironment } from '../../models/BaSyxEnvironment';
5
5
  export function serializeXml(data, namespacePrefix = 'aas') {
6
6
  // Return empty string for empty environment
7
7
  if (!data.assetAdministrationShells?.length && !data.submodels?.length && !data.conceptDescriptions?.length) {
8
8
  return '';
9
9
  }
10
- const builder = new XMLBuilder({
11
- ignoreAttributes: false,
12
- attributeNamePrefix: '@_',
13
- attributeValueProcessor: (name, val) => val,
14
- format: true,
15
- indentBy: ' ',
16
- suppressEmptyNode: true,
17
- suppressBooleanAttributes: false,
18
- processEntities: false,
19
- cdataPropName: '__cdata',
20
- arrayNodeName: 'element',
21
- suppressUnpairedNode: false,
22
- unpairedTags: [],
23
- tagValueProcessor: (name, val) => val,
24
- });
25
10
  // Transform and add namespace prefix to all elements
26
11
  const envData = transformEnvironmentToXmlStructure(data);
27
12
  const prefixedData = addNamespacePrefix(envData, namespacePrefix);
28
- // Wrap the environment data with proper XML declaration and namespace
29
- const xmlObject = {
30
- '?xml': {
31
- '@_version': '1.0',
32
- '@_encoding': 'UTF-8',
33
- },
13
+ const rootNode = buildXmlNode({
34
14
  [`${namespacePrefix}:environment`]: {
35
15
  [`@_xmlns:${namespacePrefix}`]: 'https://admin-shell.io/aas/3/1',
36
16
  '@_xmlns:xsi': 'http://www.w3.org/2001/XMLSchema-instance',
37
17
  '@_xsi:schemaLocation': 'https://admin-shell.io/aas/3/1 AAS.xsd',
38
18
  ...prefixedData,
39
19
  },
40
- };
41
- let xml = builder.build(xmlObject);
20
+ });
21
+ let xml = serializeXmlNode(rootNode, {
22
+ pretty: true,
23
+ xmlDeclaration: true,
24
+ indent: ' ',
25
+ newline: '\n',
26
+ });
42
27
  // Format the root element attributes to be on separate lines
43
28
  const escapedPrefix = namespacePrefix.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
44
29
  const regex = new RegExp(`<${escapedPrefix}:environment xmlns:${escapedPrefix}="https:\\/\\/admin-shell\\.io\\/aas\\/3\\/1" xmlns:xsi="http:\\/\\/www\\.w3\\.org\\/2001\\/XMLSchema-instance" xsi:schemaLocation="https:\\/\\/admin-shell\\.io\\/aas\\/3\\/1 AAS\\.xsd">`, 'g');
@@ -897,40 +882,14 @@ export function deserializeXml(xmlString) {
897
882
  if (!xmlString || xmlString.trim() === '') {
898
883
  return new BaSyxEnvironment();
899
884
  }
900
- const parser = new XMLParser({
901
- ignoreAttributes: false,
902
- attributeNamePrefix: '@_',
903
- parseAttributeValue: false,
904
- parseTagValue: false,
905
- trimValues: true,
906
- removeNSPrefix: true, // Remove namespace prefixes like aas:
907
- isArray: (name) => {
908
- // Define which elements should always be treated as arrays
909
- const arrayElements = [
910
- 'extension',
911
- 'langStringNameType',
912
- 'langStringTextType',
913
- 'langStringPreferredNameTypeIec61360',
914
- 'langStringShortNameTypeIec61360',
915
- 'langStringDefinitionTypeIec61360',
916
- 'reference',
917
- 'key',
918
- 'valueReferencePair',
919
- 'embeddedDataSpecification',
920
- 'specificAssetId',
921
- 'assetAdministrationShell',
922
- 'submodel',
923
- 'conceptDescription',
924
- 'qualifier',
925
- 'operationVariable',
926
- ];
927
- return arrayElements.includes(name);
928
- },
885
+ const rootNode = parseXmlString(xmlString);
886
+ const parsed = buildObject(rootNode, {
887
+ stripNamespaces: true,
888
+ arrayElements: ARRAY_ELEMENTS,
929
889
  });
930
- const parsed = parser.parse(xmlString);
931
890
  const env = new BaSyxEnvironment();
932
891
  // Extract the environment data
933
- const envData = parsed.environment;
892
+ const envData = parsed.environment ?? parsed;
934
893
  if (!envData) {
935
894
  return env;
936
895
  }
@@ -953,6 +912,42 @@ export function deserializeXml(xmlString) {
953
912
  }
954
913
  return env;
955
914
  }
915
+ const ARRAY_ELEMENTS = new Set([
916
+ 'extension',
917
+ 'langStringNameType',
918
+ 'langStringTextType',
919
+ 'langStringPreferredNameTypeIec61360',
920
+ 'langStringShortNameTypeIec61360',
921
+ 'langStringDefinitionTypeIec61360',
922
+ 'reference',
923
+ 'key',
924
+ 'valueReferencePair',
925
+ 'embeddedDataSpecification',
926
+ 'specificAssetId',
927
+ 'assetAdministrationShell',
928
+ 'submodel',
929
+ 'conceptDescription',
930
+ 'qualifier',
931
+ 'operationVariable',
932
+ ]);
933
+ function parseDataTypeDefXsd(dataType) {
934
+ if (dataType === undefined || dataType === null || dataType === '') {
935
+ return undefined;
936
+ }
937
+ if (typeof dataType !== 'string' || !dataType.startsWith('xs:')) {
938
+ throw new Error(`Invalid literal of DataTypeDefXsd: ${String(dataType)}`);
939
+ }
940
+ const result = jsonization.dataTypeDefXsdFromJsonable(dataType);
941
+ if (result.error !== null || result.value === null) {
942
+ const errorMessage = typeof result.error === 'string'
943
+ ? result.error
944
+ : typeof result.error?.message === 'string'
945
+ ? result.error.message
946
+ : `Invalid literal of DataTypeDefXsd: ${dataType}`;
947
+ throw new Error(errorMessage);
948
+ }
949
+ return result.value;
950
+ }
956
951
  function parseAssetAdministrationShell(data) {
957
952
  return new AssetAdministrationShell(data.id, parseAssetInformation(data.assetInformation), data.extensions?.extension ? data.extensions.extension.map(parseExtension) : undefined, data.category || undefined, data.idShort || undefined, data.displayName?.langStringNameType
958
953
  ? data.displayName.langStringNameType.map(parseLangStringNameType)
@@ -963,15 +958,7 @@ function parseAssetAdministrationShell(data) {
963
958
  : undefined, data.derivedFrom ? parseReference(data.derivedFrom) : undefined, data.submodels?.reference ? data.submodels.reference.map(parseReference) : undefined);
964
959
  }
965
960
  function parseExtension(data) {
966
- // Map XML valueType string to DataTypeDefXsd enum
967
- let valueType = data.valueType || undefined;
968
- if (valueType && typeof valueType === 'string' && valueType.startsWith('xs:')) {
969
- // Extract the type after 'xs:' prefix and map to enum
970
- const typeValue = valueType.substring(3);
971
- const capitalizedType = typeValue.charAt(0).toUpperCase() + typeValue.slice(1);
972
- // Map string to DataTypeDefXsd enum value
973
- valueType = DataTypeDefXsd[capitalizedType];
974
- }
961
+ const valueType = parseDataTypeDefXsd(data.valueType);
975
962
  return new Extension(data.name, data.semanticId ? parseReference(data.semanticId) : undefined, data.supplementalSemanticIds?.reference
976
963
  ? data.supplementalSemanticIds.reference.map(parseReference)
977
964
  : undefined, valueType, data.value || undefined, data.refersTo?.reference ? data.refersTo.reference.map(parseReference) : undefined);
@@ -1079,15 +1066,7 @@ function parseSubmodel(data) {
1079
1066
  : undefined, data.submodelElements ? parseSubmodelElements(data.submodelElements) : undefined);
1080
1067
  }
1081
1068
  function parseQualifier(data) {
1082
- // Map XML valueType string to DataTypeDefXsd enum
1083
- let valueType = data.valueType || undefined;
1084
- if (valueType && typeof valueType === 'string') {
1085
- // Convert string to enum value using jsonization (expects xs: prefix)
1086
- const result = jsonization.dataTypeDefXsdFromJsonable(valueType);
1087
- if (result.error === null && result.value !== null) {
1088
- valueType = result.value;
1089
- }
1090
- }
1069
+ const valueType = parseDataTypeDefXsd(data.valueType);
1091
1070
  return new Qualifier(data.type, valueType, data.semanticId ? parseReference(data.semanticId) : undefined, data.supplementalSemanticIds?.reference
1092
1071
  ? data.supplementalSemanticIds.reference.map(parseReference)
1093
1072
  : undefined, data.kind ? (jsonization.qualifierKindFromJsonable(data.kind).value ?? data.kind) : undefined, data.value || undefined, data.valueId ? parseReference(data.valueId) : undefined);
@@ -1120,15 +1099,7 @@ function parseSubmodelElements(data) {
1120
1099
  return elements;
1121
1100
  }
1122
1101
  function parseProperty(data) {
1123
- // Map XML valueType string to DataTypeDefXsd enum
1124
- let valueType = data.valueType || undefined;
1125
- if (valueType && typeof valueType === 'string') {
1126
- // Convert string to enum value using jsonization (expects xs: prefix)
1127
- const result = jsonization.dataTypeDefXsdFromJsonable(valueType);
1128
- if (result.error === null && result.value !== null) {
1129
- valueType = result.value;
1130
- }
1131
- }
1102
+ const valueType = parseDataTypeDefXsd(data.valueType);
1132
1103
  return new Property(valueType, data.extensions?.extension ? ensureArray(data.extensions.extension).map(parseExtension) : undefined, data.category || undefined, data.idShort || undefined, data.displayName?.langStringNameType
1133
1104
  ? ensureArray(data.displayName.langStringNameType).map(parseLangStringNameType)
1134
1105
  : undefined, data.description?.langStringTextType
@@ -1151,15 +1122,7 @@ function parseMultiLanguageProperty(data) {
1151
1122
  : undefined, data.value?.langStringTextType ? data.value.langStringTextType.map(parseLangStringTextType) : undefined, data.valueId ? parseReference(data.valueId) : undefined);
1152
1123
  }
1153
1124
  function parseRange(data) {
1154
- // Map XML valueType string to DataTypeDefXsd enum
1155
- let valueType = data.valueType || undefined;
1156
- if (valueType && typeof valueType === 'string') {
1157
- // Convert string to enum value using jsonization (expects xs: prefix)
1158
- const result = jsonization.dataTypeDefXsdFromJsonable(valueType);
1159
- if (result.error === null && result.value !== null) {
1160
- valueType = result.value;
1161
- }
1162
- }
1125
+ const valueType = parseDataTypeDefXsd(data.valueType);
1163
1126
  return new Range(valueType, data.extensions?.extension ? data.extensions.extension.map(parseExtension) : undefined, data.category || undefined, data.idShort || undefined, data.displayName?.langStringNameType
1164
1127
  ? data.displayName.langStringNameType.map(parseLangStringNameType)
1165
1128
  : undefined, data.description?.langStringTextType
@@ -1265,7 +1228,7 @@ function parseSubmodelElementList(data) {
1265
1228
  ? data.supplementalSemanticIds.reference.map(parseReference)
1266
1229
  : undefined, data.qualifiers?.qualifier ? data.qualifiers.qualifier.map(parseQualifier) : undefined, data.embeddedDataSpecifications?.embeddedDataSpecification
1267
1230
  ? data.embeddedDataSpecifications.embeddedDataSpecification.map(parseEmbeddedDataSpecification)
1268
- : undefined, data.orderRelevant !== undefined ? data.orderRelevant === 'true' || data.orderRelevant === true : undefined, data.semanticIdListElement ? parseReference(data.semanticIdListElement) : undefined, data.valueTypeListElement || undefined, data.value ? parseSubmodelElements(data.value) : undefined);
1231
+ : undefined, data.orderRelevant !== undefined ? data.orderRelevant === 'true' || data.orderRelevant === true : undefined, data.semanticIdListElement ? parseReference(data.semanticIdListElement) : undefined, parseDataTypeDefXsd(data.valueTypeListElement), data.value ? parseSubmodelElements(data.value) : undefined);
1269
1232
  }
1270
1233
  function parseOperation(data) {
1271
1234
  const ensureArray = (val) => (Array.isArray(val) ? val : val ? [val] : []);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "basyx-typescript-sdk",
3
- "version": "2.0.0",
3
+ "version": "2.1.1",
4
4
  "description": "BaSyx TypeScript SDK for developing applications and components for the Asset Administration Shell (AAS)",
5
5
  "main": "bundle/index.cjs",
6
6
  "module": "bundle/index.mjs",
@@ -64,6 +64,6 @@
64
64
  "typescript-eslint": "^8.21.0"
65
65
  },
66
66
  "dependencies": {
67
- "fast-xml-parser": "^5.3.3"
67
+ "xml-sax-ts": "^0.3.0"
68
68
  }
69
69
  }