@itwin/ecschema-metadata 4.10.0-dev.9 → 5.0.0-dev.0

package/lib/cjs/Deserialization/XmlParser.js

@@ -10,6 +10,7 @@ const ECObjects_1 = require("../ECObjects");
 const Exception_1 = require("../Exception");
 const ECName_1 = require("../ECName");
 const AbstractParser_1 = require("./AbstractParser");
+const Helper_1 = require("./Helper");
 const NON_ITEM_SCHEMA_ELEMENTS = ["ECSchemaReference", "ECCustomAttributes"];
 const ECXML_URI = "http://www\\.bentley\\.com/schemas/Bentley\\.ECXML";
 /** @internal */
@@ -32,11 +33,12 @@ class XmlParser extends AbstractParser_1.AbstractParser {
         const xmlNamespace = schemaInfo.getAttribute("xmlns");
         if (xmlNamespace) {
             this._xmlNamespace = xmlNamespace;
-            this._ecXmlVersion = this.parseXmlNamespace(this._xmlNamespace);
+            this._ecSpecVersion = XmlParser.parseXmlNamespace(this._xmlNamespace);
         }
         this._schemaItems = new Map();
         this._mapIsPopulated = false;
     }
+    get getECSpecVersion() { return this._ecSpecVersion; }
     parseSchema() {
         const schemaMetadata = this._rawSchema.documentElement;
         if ("ECSchema" !== schemaMetadata.nodeName)
@@ -50,7 +52,7 @@ class XmlParser extends AbstractParser_1.AbstractParser {
             throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaXML, `The ECSchema ${this._schemaName} is missing a required 'version' attribute`);
         if (this._xmlNamespace === undefined)
             throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaXML, `The ECSchema ${this._schemaName} is missing a required 'xmlns' attribute`);
-        if (this._ecXmlVersion === undefined)
+        if (this._ecSpecVersion === undefined)
             throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaXML, `The ECSchema ${this._schemaName} has an invalid 'xmlns' attribute`);
         const alias = this.getRequiredAttribute(schemaMetadata, "alias", `The ECSchema ${this._schemaName} is missing a required 'alias' attribute`);
         const description = this.getOptionalAttribute(schemaMetadata, "description");
@@ -62,6 +64,8 @@ class XmlParser extends AbstractParser_1.AbstractParser {
             alias,
             label: displayLabel,
             description,
+            ecSpecMajorVersion: this._ecSpecVersion.readVersion,
+            ecSpecMinorVersion: this._ecSpecVersion.writeVersion,
         };
         return schemaProps;
     }
@@ -87,8 +91,11 @@ class XmlParser extends AbstractParser_1.AbstractParser {
                         rawItemType = "Mixin";
                 }
                 const itemType = this.getSchemaItemType(rawItemType);
-                if (itemType === undefined)
+                if (itemType === undefined) {
+                    if (Helper_1.SchemaReadHelper.isECSpecVersionNewer(this._ecSpecVersion))
+                        continue;
                     throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaXML, `A SchemaItem in ${this._schemaName} has an invalid type. '${rawItemType}' is not a valid SchemaItem type.`);
+                }
                 const itemName = this.getRequiredAttribute(item, "typeName", `A SchemaItem in ${this._schemaName} is missing the required 'typeName' attribute.`);
                 if (!ECName_1.ECName.validate(itemName))
                     throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECName, `A SchemaItem in ${this._schemaName} has an invalid 'typeName' attribute. '${itemName}' is not a valid ECName.`);
@@ -221,12 +228,18 @@ class XmlParser extends AbstractParser_1.AbstractParser {
         // TODO: This shouldn't be verified here.  It's for the deserialize method to handle.  The only reason it's currently done here so that the xml
         // value can be put in the correct type, number or string.
         let tempBackingType;
-        if (/int/i.test(enumType))
+        if (/int/i.test(enumType)) {
             tempBackingType = ECObjects_1.PrimitiveType.Integer;
-        else if (/string/i.test(enumType))
+        }
+        else if (/string/i.test(enumType)) {
             tempBackingType = ECObjects_1.PrimitiveType.String;
-        else
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Enumeration ${this._currentItemFullName} has an invalid 'backingTypeName' attribute. It should be either "int" or "string".`);
+        }
+        else {
+            if (Helper_1.SchemaReadHelper.isECSpecVersionNewer(this._ecSpecVersion))
+                tempBackingType = ECObjects_1.PrimitiveType.String;
+            else
+                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Enumeration ${this._currentItemFullName} has an invalid 'backingTypeName' attribute. It should be either "int" or "string".`);
+        }
         let isStrictString = this.getOptionalAttribute(xmlElement, "isStrict");
         if (isStrictString === undefined)
             isStrictString = "true";
@@ -257,6 +270,8 @@ class XmlParser extends AbstractParser_1.AbstractParser {
             type: enumType,
             isStrict,
             enumerators,
+            originalECSpecMajorVersion: this._ecSpecVersion?.readVersion,
+            originalECSpecMinorVersion: this._ecSpecVersion?.writeVersion,
         };
     }
     parseKindOfQuantity(xmlElement) {
@@ -619,6 +634,8 @@ class XmlParser extends AbstractParser_1.AbstractParser {
             ...itemProps,
             modifier,
             baseClass,
+            originalECSpecMajorVersion: this._ecSpecVersion?.readVersion,
+            originalECSpecMinorVersion: this._ecSpecVersion?.writeVersion,
         };
     }
     getRelationshipConstraintProps(xmlElement, isSource) {
@@ -750,14 +767,14 @@ class XmlParser extends AbstractParser_1.AbstractParser {
         }
     }
     getCustomAttributeProvider(xmlCustomAttribute) {
-        (0, core_bentley_1.assert)(this._ecXmlVersion !== undefined);
+        (0, core_bentley_1.assert)(this._ecSpecVersion !== undefined);
         let ns = xmlCustomAttribute.getAttribute("xmlns");
         if (!ns) {
             (0, core_bentley_1.assert)(this._schemaName !== undefined);
             (0, core_bentley_1.assert)(this._schemaVersion !== undefined);
             ns = `${this._schemaName}.${this._schemaVersion}`;
         }
-        if (null === ns || !this.isSchemaFullNameValidForVersion(ns, this._ecXmlVersion))
+        if (null === ns || !this.isSchemaFullNameValidForVersion(ns, this._ecSpecVersion))
             throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaXML, `Custom attribute namespaces must contain a valid 3.2 full schema name in the form <schemaName>.RR.ww.mm.`);
         const schemaNameParts = ns.split(".");
         const className = `${schemaNameParts[0]}.${xmlCustomAttribute.tagName}`;
@@ -835,7 +852,9 @@ class XmlParser extends AbstractParser_1.AbstractParser {
         return structObj;
     }
     readPrimitivePropertyValue(propElement, primitiveType) {
-        if (!propElement.textContent)
+        if (undefined === propElement.textContent || null === propElement.textContent)
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaXML, `Primitive property '${propElement.tagName}' has an invalid property value.`);
+        if (propElement.textContent === "" && primitiveType !== ECObjects_1.PrimitiveType.String)
             throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaXML, `Primitive property '${propElement.tagName}' has an invalid property value.`);
         // TODO: Mapping all primitive types to string, number and boolean
         // for now.  Need to review with IModelJs.
@@ -913,9 +932,9 @@ class XmlParser extends AbstractParser_1.AbstractParser {
             throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaXML, `Property '${propName}' has an invalid property value. A Point 3D value was expected.`);
         return { x, y, z };
     }
-    isSchemaFullNameValidForVersion(schemaFullName, ecXmlVersion) {
+    isSchemaFullNameValidForVersion(schemaFullName, ecSpecVersion) {
         const schemaNameParts = schemaFullName.split(".");
-        if ((ecXmlVersion.readVersion >= 3 && ecXmlVersion.writeVersion >= 2) || ecXmlVersion.readVersion > 3) {
+        if ((ecSpecVersion.readVersion >= 3 && ecSpecVersion.writeVersion >= 2) || ecSpecVersion.readVersion > 3) {
             if (schemaNameParts.length < 4)
                 return false;
         }
@@ -925,7 +944,7 @@ class XmlParser extends AbstractParser_1.AbstractParser {
         }
         return true;
     }
-    parseXmlNamespace(xmlNamespace) {
+    static parseXmlNamespace(xmlNamespace) {
         const regEx = new RegExp(`^${ECXML_URI}\\.([0-9]+)\\.([0-9]+)$`);
         const match = xmlNamespace.match(regEx);
         if (!match)