@itwin/ecschema-metadata 5.0.0-dev.11 → 5.0.0-dev.111

package/lib/cjs/Deserialization/Helper.js

@@ -20,6 +20,14 @@ const SchemaGraph_1 = require("../utils/SchemaGraph");
  * @internal
  */
 class SchemaReadHelper {
+    _context;
+    _visitorHelper;
+    _parserType;
+    _parser;
+    // Cache of the schema currently being loaded. This schema is in the _context but to
+    // avoid going back to the context every time, the cache is used.
+    _schema;
+    _schemaInfo;
     constructor(parserType, context, visitor) {
         this._context = (undefined !== context) ? context : new Context_1.SchemaContext();
         this._visitorHelper = visitor ? new SchemaPartVisitorDelegate_1.SchemaPartVisitorDelegate(visitor) : undefined;
@@ -36,7 +44,7 @@ class SchemaReadHelper {
         // Ensure context matches schema context
         if (schema.context) {
             if (this._context !== schema.context)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.DifferentSchemaContexts, "The SchemaContext of the schema must be the same SchemaContext held by the SchemaReadHelper.");
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.DifferentSchemaContexts, "The SchemaContext of the schema must be the same SchemaContext held by the SchemaReadHelper.");
         }
         else {
             schema.setContext(this._context);
@@ -45,10 +53,11 @@ class SchemaReadHelper {
         // Loads all of the properties on the Schema object
         await schema.fromJSON(this._parser.parseSchema());
         this._schema = schema;
-        const schemaInfo = { schemaKey: schema.schemaKey, references: [] };
+        const schemaInfoReferences = [];
+        const schemaInfo = { schemaKey: schema.schemaKey, alias: schema.alias, references: schemaInfoReferences };
         for (const reference of this._parser.getReferences()) {
             const refKey = new SchemaKey_1.SchemaKey(reference.name, SchemaKey_1.ECVersion.fromString(reference.version));
-            schemaInfo.references.push({ schemaKey: refKey });
+            schemaInfoReferences.push({ schemaKey: refKey });
         }
         this._schemaInfo = schemaInfo;
         // Need to add this schema to the context to be able to locate schemaItems within the context.
@@ -68,7 +77,7 @@ class SchemaReadHelper {
         }
         const cachedSchema = await this._context.getCachedSchema(this._schemaInfo.schemaKey, ECObjects_1.SchemaMatchType.Latest);
         if (undefined === cachedSchema)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.UnableToLoadSchema, `Could not load schema ${schema.schemaKey.toString()}`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.UnableToLoadSchema, `Could not load schema ${schema.schemaKey.toString()}`);
         return cachedSchema;
     }
     /* Finish loading the rest of the schema */
@@ -139,7 +148,7 @@ class SchemaReadHelper {
     async loadSchemaReference(schemaInfo, refKey) {
         const refSchema = await this._context.getSchema(refKey, ECObjects_1.SchemaMatchType.LatestWriteCompatible);
         if (undefined === refSchema)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.UnableToLocateSchema, `Could not locate the referenced schema, ${refKey.name}.${refKey.version.toString()}, of ${schemaInfo.schemaKey.name}`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.UnableToLocateSchema, `Could not locate the referenced schema, ${refKey.name}.${refKey.version.toString()}, of ${schemaInfo.schemaKey.name}`);
         await this._schema.addReference(refSchema);
         const results = this.validateSchemaReferences(this._schema);
         let errorMessage = "";
@@ -147,7 +156,7 @@ class SchemaReadHelper {
             errorMessage += `${result}\r\n`;
         }
         if (errorMessage) {
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `${errorMessage}`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `${errorMessage}`);
         }
     }
     /**
@@ -158,7 +167,7 @@ class SchemaReadHelper {
         const schemaKey = new SchemaKey_1.SchemaKey(ref.name, SchemaKey_1.ECVersion.fromString(ref.version));
         const refSchema = this._context.getSchemaSync(schemaKey, ECObjects_1.SchemaMatchType.LatestWriteCompatible);
         if (!refSchema)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.UnableToLocateSchema, `Could not locate the referenced schema, ${ref.name}.${ref.version}, of ${this._schema.schemaKey.name}`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.UnableToLocateSchema, `Could not locate the referenced schema, ${ref.name}.${ref.version}, of ${this._schema.schemaKey.name}`);
         this._schema.addReferenceSync(refSchema);
         SchemaGraph_1.SchemaGraph.generateGraphSync(this._schema).throwIfCycles();
         const results = this.validateSchemaReferences(this._schema);
@@ -167,7 +176,7 @@ class SchemaReadHelper {
             errorMessage += `${result}\r\n`;
         }
         if (errorMessage) {
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `${errorMessage}`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `${errorMessage}`);
         }
     }
     /**
@@ -353,7 +362,7 @@ class SchemaReadHelper {
         if (undefined !== schema && -1 !== fullOrQualifiedName.indexOf(":")) {
             const refName = schema.getReferenceNameByAlias(schemaName);
             if (undefined === refName)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.UnableToLocateSchema, `Could not resolve schema alias '${schemaName}' for schema item '${itemName}.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.UnableToLocateSchema, `Could not resolve schema alias '${schemaName}' for schema item '${itemName}.`);
             return [refName, itemName];
         }
         return [schemaName, itemName];
@@ -372,7 +381,7 @@ class SchemaReadHelper {
         const [schemaName, itemName] = SchemaReadHelper.resolveSchemaAndItemName(name, this._schema);
         const isInThisSchema = (this._schema && this._schema.name.toLowerCase() === schemaName.toLowerCase());
         if (undefined === schemaName || 0 === schemaName.length)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The SchemaItem ${name} is invalid without a schema name`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The SchemaItem ${name} is invalid without a schema name`);
         if (isInThisSchema) {
             schemaItem = await this._schema.getItem(itemName);
             if (schemaItem)
@@ -387,11 +396,11 @@ class SchemaReadHelper {
                     loadCallBack(schemaItem);
                 return schemaItem;
             }
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
         }
         schemaItem = await this._context.getSchemaItem(new SchemaKey_1.SchemaItemKey(itemName, new SchemaKey_1.SchemaKey(schemaName)));
         if (undefined === schemaItem)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
         return schemaItem;
     }
     /**
@@ -408,7 +417,7 @@ class SchemaReadHelper {
         const [schemaName, itemName] = SchemaReadHelper.resolveSchemaAndItemName(name, this._schema);
         const isInThisSchema = (this._schema && this._schema.name.toLowerCase() === schemaName.toLowerCase());
         if (undefined === schemaName || schemaName.length === 0)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The SchemaItem ${name} is invalid without a schema name`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The SchemaItem ${name} is invalid without a schema name`);
         if (isInThisSchema && undefined === this._schema.getItemSync(itemName)) {
             const foundItem = this._parser.findItem(itemName);
             if (foundItem) {
@@ -420,11 +429,11 @@ class SchemaReadHelper {
                     loadCallBack(schemaItem);
                 return schemaItem;
             }
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
         }
         schemaItem = this._context.getSchemaItemSync(new SchemaKey_1.SchemaItemKey(itemName, new SchemaKey_1.SchemaKey(schemaName)));
         if (undefined === schemaItem)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
         return schemaItem;
     }
     /**
@@ -728,16 +737,16 @@ class SchemaReadHelper {
         const loadTypeName = async (typeName) => {
             if (undefined === (0, ECObjects_1.parsePrimitiveType)(typeName)) {
                 if (SchemaReadHelper.isECSpecVersionNewer(this._parser.getECSpecVersion))
-                    return Exception_1.ECObjectsStatus.NewerECSpecVersion;
+                    return Exception_1.ECSchemaStatus.NewerECSpecVersion;
                 await this.findSchemaItem(typeName);
             }
-            return Exception_1.ECObjectsStatus.Success;
+            return Exception_1.ECSchemaStatus.Success;
         };
         const lowerCasePropType = propType.toLowerCase();
         switch (lowerCasePropType) {
             case "primitiveproperty":
                 const primPropertyProps = this._parser.parsePrimitiveProperty(rawProperty);
-                if (await loadTypeName(primPropertyProps.typeName) === Exception_1.ECObjectsStatus.NewerECSpecVersion)
+                if (await loadTypeName(primPropertyProps.typeName) === Exception_1.ECSchemaStatus.NewerECSpecVersion)
                     primPropertyProps.typeName = "string";
                 const primProp = await classObj.createPrimitiveProperty(propName, primPropertyProps.typeName);
                 return this.loadProperty(primProp, primPropertyProps, rawProperty);
@@ -748,7 +757,7 @@ class SchemaReadHelper {
                 return this.loadProperty(structProp, structPropertyProps, rawProperty);
             case "primitivearrayproperty":
                 const primArrPropertyProps = this._parser.parsePrimitiveArrayProperty(rawProperty);
-                if (await loadTypeName(primArrPropertyProps.typeName) === Exception_1.ECObjectsStatus.NewerECSpecVersion)
+                if (await loadTypeName(primArrPropertyProps.typeName) === Exception_1.ECSchemaStatus.NewerECSpecVersion)
                     primArrPropertyProps.typeName = "string";
                 const primArrProp = await classObj.createPrimitiveArrayProperty(propName, primArrPropertyProps.typeName);
                 return this.loadProperty(primArrProp, primArrPropertyProps, rawProperty);
@@ -759,7 +768,7 @@ class SchemaReadHelper {
                 return this.loadProperty(structArrProp, structArrPropertyProps, rawProperty);
             case "navigationproperty":
                 if (classObj.schemaItemType !== ECObjects_1.SchemaItemType.EntityClass && classObj.schemaItemType !== ECObjects_1.SchemaItemType.RelationshipClass && classObj.schemaItemType !== ECObjects_1.SchemaItemType.Mixin)
-                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Navigation Property ${classObj.name}.${propName} is invalid, because only EntityClasses, Mixins, and RelationshipClasses can have NavigationProperties.`);
+                    throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Navigation Property ${classObj.name}.${propName} is invalid, because only EntityClasses, Mixins, and RelationshipClasses can have NavigationProperties.`);
                 const navPropertyProps = this._parser.parseNavigationProperty(rawProperty);
                 await this.findSchemaItem(navPropertyProps.relationshipName);
                 const navProp = await classObj.createNavigationProperty(propName, navPropertyProps.relationshipName, navPropertyProps.direction);
@@ -777,16 +786,16 @@ class SchemaReadHelper {
         const loadTypeName = (typeName) => {
             if (undefined === (0, ECObjects_1.parsePrimitiveType)(typeName)) {
                 if (SchemaReadHelper.isECSpecVersionNewer(this._parser.getECSpecVersion))
-                    return Exception_1.ECObjectsStatus.NewerECSpecVersion;
+                    return Exception_1.ECSchemaStatus.NewerECSpecVersion;
                 this.findSchemaItemSync(typeName);
             }
-            return Exception_1.ECObjectsStatus.Success;
+            return Exception_1.ECSchemaStatus.Success;
         };
         const lowerCasePropType = propType.toLowerCase();
         switch (lowerCasePropType) {
             case "primitiveproperty":
                 const primPropertyProps = this._parser.parsePrimitiveProperty(rawProperty);
-                if (loadTypeName(primPropertyProps.typeName) === Exception_1.ECObjectsStatus.NewerECSpecVersion)
+                if (loadTypeName(primPropertyProps.typeName) === Exception_1.ECSchemaStatus.NewerECSpecVersion)
                     primPropertyProps.typeName = "string";
                 const primProp = classObj.createPrimitivePropertySync(propName, primPropertyProps.typeName);
                 return this.loadPropertySync(primProp, primPropertyProps, rawProperty);
@@ -797,7 +806,7 @@ class SchemaReadHelper {
                 return this.loadPropertySync(structProp, structPropertyProps, rawProperty);
             case "primitivearrayproperty":
                 const primArrPropertyProps = this._parser.parsePrimitiveArrayProperty(rawProperty);
-                if (loadTypeName(primArrPropertyProps.typeName) === Exception_1.ECObjectsStatus.NewerECSpecVersion)
+                if (loadTypeName(primArrPropertyProps.typeName) === Exception_1.ECSchemaStatus.NewerECSpecVersion)
                     primArrPropertyProps.typeName = "string";
                 const primArrProp = classObj.createPrimitiveArrayPropertySync(propName, primArrPropertyProps.typeName);
                 return this.loadPropertySync(primArrProp, primArrPropertyProps, rawProperty);
@@ -808,7 +817,7 @@ class SchemaReadHelper {
                 return this.loadPropertySync(structArrProp, structArrPropertyProps, rawProperty);
             case "navigationproperty":
                 if (classObj.schemaItemType !== ECObjects_1.SchemaItemType.EntityClass && classObj.schemaItemType !== ECObjects_1.SchemaItemType.RelationshipClass && classObj.schemaItemType !== ECObjects_1.SchemaItemType.Mixin)
-                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Navigation Property ${classObj.name}.${propName} is invalid, because only EntityClasses, Mixins, and RelationshipClasses can have NavigationProperties.`);
+                    throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Navigation Property ${classObj.name}.${propName} is invalid, because only EntityClasses, Mixins, and RelationshipClasses can have NavigationProperties.`);
                 const navPropertyProps = this._parser.parseNavigationProperty(rawProperty);
                 this.findSchemaItemSync(navPropertyProps.relationshipName);
                 const navProp = classObj.createNavigationPropertySync(propName, navPropertyProps.relationshipName, navPropertyProps.direction);
@@ -860,7 +869,7 @@ class SchemaReadHelper {
             // If custom attribute exist within the context and is referenced, validate the reference is defined in the container's schema
             if (caClass && caClass.key.schemaName !== container.schema.name &&
                 !container.schema.getReferenceSync(caClass.key.schemaName)) {
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to load custom attribute ${caClass.fullName} from container ${container.fullName}, ${caClass.key.schemaName} reference not defined`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to load custom attribute ${caClass.fullName} from container ${container.fullName}, ${caClass.key.schemaName} reference not defined`);
             }
             // Second tuple entry ia a function that provides the CA instance.
             const provider = providerTuple[1];