@itwin/core-backend 4.0.0-dev.6 → 4.0.0-dev.61

package/lib/cjs/ClassRegistry.js

@@ -1,251 +1,255 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Schema
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MetaDataRegistry = exports.ClassRegistry = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_common_1 = require("@itwin/core-common");
-const Entity_1 = require("./Entity");
-const Schema_1 = require("./Schema");
-const EntityReferences_1 = require("./EntityReferences");
-const assert = require("assert");
-const isGeneratedClassTag = Symbol("isGeneratedClassTag");
-/** The mapping between a BIS class name (in the form "schema:class") and its JavaScript constructor function
- * @public
- */
-class ClassRegistry {
-    /** @internal */
-    static isNotFoundError(err) { return (err instanceof core_common_1.IModelError) && (err.errorNumber === core_bentley_1.IModelStatus.NotFound); }
-    /** @internal */
-    static makeMetaDataNotFoundError(className) { return new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `metadata not found for ${className}`); }
-    /** @internal */
-    static register(entityClass, schema) {
-        entityClass.schema = schema;
-        const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();
-        if (this._classMap.has(key)) {
-            const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;
-            core_bentley_1.Logger.logError("core-frontend.classRegistry", errMsg);
-            throw new Error(errMsg);
-        }
-        this._classMap.set(key, entityClass);
-    }
-    /** Generate a proxy Schema for a domain that has not been registered. */
-    static generateProxySchema(domain, iModel) {
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Schema
+ */
+var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
+    if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
+    return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetaDataRegistry = exports.ClassRegistry = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const Entity_1 = require("./Entity");
+const Schema_1 = require("./Schema");
+const EntityReferences_1 = require("./EntityReferences");
+const assert = require("assert");
+const isGeneratedClassTag = Symbol("isGeneratedClassTag");
+/** The mapping between a BIS class name (in the form "schema:class") and its JavaScript constructor function
+ * @public
+ */
+class ClassRegistry {
+    /** @internal */
+    static isNotFoundError(err) { return (err instanceof core_common_1.IModelError) && (err.errorNumber === core_bentley_1.IModelStatus.NotFound); }
+    /** @internal */
+    static makeMetaDataNotFoundError(className) { return new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `metadata not found for ${className}`); }
+    /** @internal */
+    static register(entityClass, schema) {
+        entityClass.schema = schema;
+        const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();
+        if (this._classMap.has(key)) {
+            const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;
+            core_bentley_1.Logger.logError("core-frontend.classRegistry", errMsg);
+            throw new Error(errMsg);
+        }
+        this._classMap.set(key, entityClass);
+    }
+    /** Generate a proxy Schema for a domain that has not been registered. */
+    static generateProxySchema(domain, iModel) {
         const hasBehavior = iModel.withPreparedSqliteStatement(`
       SELECT NULL FROM [ec_CustomAttribute] [c]
         JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]
         JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]
         JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]
-      WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {
-            stmt.bindString(1, domain);
-            stmt.bindString(2, "BisCore.SchemaHasBehavior");
-            return stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW;
-        });
-        const schemaClass = class extends Schema_1.Schema {
-            static get schemaName() { return domain; }
-            static get missingRequiredBehavior() { return hasBehavior; }
-        };
-        Schema_1.Schemas.registerSchema(schemaClass); // register the class before we return it.
-        return schemaClass;
-    }
-    /** First, finds the root BisCore entity class for an entity, by traversing base classes and mixin targets (AppliesTo).
-     * Then, gets its metadata and returns that.
-     * @param iModel - iModel containing the metadata for this type
-     * @param ecTypeQualifier - a full name of an ECEntityClass to find the root of
-     * @returns the qualified full name of an ECEntityClass
-     * @internal public for testing only
-     */
-    static getRootEntity(iModel, ecTypeQualifier) {
-        var _a;
-        const [classSchema, className] = ecTypeQualifier.split(".");
-        const schemaItemJson = iModel.nativeDb.getSchemaItem(classSchema, className);
-        if (schemaItemJson.error)
-            throw new core_common_1.IModelError(schemaItemJson.error.status, `failed to get schema item '${ecTypeQualifier}'`);
-        assert(undefined !== schemaItemJson.result);
-        const schemaItem = JSON.parse(schemaItemJson.result);
-        if (!("appliesTo" in schemaItem) && schemaItem.baseClass === undefined) {
-            return ecTypeQualifier;
-        }
-        // typescript doesn't understand that the inverse of the above condition is
-        // ("appliesTo" in rootclassMetaData || rootClassMetaData.baseClass !== undefined)
-        const parentItemQualifier = (_a = schemaItem.appliesTo) !== null && _a !== void 0 ? _a : schemaItem.baseClass;
-        return this.getRootEntity(iModel, parentItemQualifier);
-    }
-    /** Generate a JavaScript class from Entity metadata.
-     * @param entityMetaData The Entity metadata that defines the class
-     */
-    static generateClassForEntity(entityMetaData, iModel) {
-        var _a, _b;
-        const name = entityMetaData.ecclass.split(":");
-        const domainName = name[0];
-        const className = name[1];
-        if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass
-            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `class ${name} has no superclass`);
-        // make sure schema exists
-        let schema = Schema_1.Schemas.getRegisteredSchema(domainName);
-        if (undefined === schema)
-            schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too
-        const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());
-        if (undefined === superclass)
-            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `cannot find superclass for class ${name}`);
-        // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot
-        // be used to tell if there are any generated classes in the hierarchy
-        let generatedClassHasNonGeneratedNonCoreAncestor = false;
-        let currentSuperclass = superclass;
-        const MAX_ITERS = 1000;
-        for (let i = 0; i < MAX_ITERS; ++i) {
-            if (currentSuperclass.schema.schemaName === "BisCore")
-                break;
-            if (!currentSuperclass.isGeneratedClass) {
-                generatedClassHasNonGeneratedNonCoreAncestor = true;
-                break;
-            }
-            const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);
-            if (superclassMetaData === undefined)
-                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);
-            const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);
-            if (maybeNextSuperclass === undefined)
-                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);
-            currentSuperclass = maybeNextSuperclass;
-        }
-        const generatedClass = (_b = class extends superclass {
-                static get className() { return className; }
-                static get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }
-            },
-            _a = isGeneratedClassTag,
-            _b[_a] = true,
-            _b);
-        // the above creates an anonymous class. For help debugging, set the "constructor.name" property to be the same as the bisClassName.
-        Object.defineProperty(generatedClass, "name", { get: () => className }); // this is the (only) way to change that readonly property.
-        // a class only gets an automatic `collectReferenceConcreteIds` implementation if:
-        // - it is not in the `BisCore` schema
-        // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)
-        if (!generatedClassHasNonGeneratedNonCoreAncestor) {
-            const navigationProps = Object.entries(entityMetaData.properties)
-                .filter(([_name, prop]) => prop.isNavigation)
-                // eslint-disable-next-line @typescript-eslint/no-shadow
-                .map(([name, prop]) => {
-                assert(prop.relationshipClass);
-                const maybeMetaData = iModel.nativeDb.getSchemaItem(...prop.relationshipClass.split(":"));
-                assert(maybeMetaData.result !== undefined, "The nav props relationship metadata was not found");
-                const relMetaData = JSON.parse(maybeMetaData.result);
-                const rootClassMetaData = ClassRegistry.getRootEntity(iModel, relMetaData.target.constraintClasses[0]);
-                // root class must be in BisCore so should be loaded since biscore classes will never get this
-                // generated implementation
-                const normalizeClassName = (clsName) => clsName.replace(".", ":");
-                const rootClass = ClassRegistry.findRegisteredClass(normalizeClassName(rootClassMetaData));
-                assert(rootClass, `The root class for ${prop.relationshipClass} was not in BisCore.`);
-                return { name, concreteEntityType: EntityReferences_1.EntityReferences.typeFromClass(rootClass) };
-            });
-            Object.defineProperty(generatedClass.prototype, "collectReferenceConcreteIds", {
-                value(referenceIds) {
-                    // eslint-disable-next-line @typescript-eslint/dot-notation
-                    const superImpl = superclass.prototype["collectReferenceConcreteIds"];
-                    superImpl.call(this, referenceIds);
-                    for (const navProp of navigationProps) {
-                        const relatedElem = this[navProp.name]; // cast to any since subclass can have any extensions
-                        if (!relatedElem || !core_bentley_1.Id64.isValid(relatedElem.id))
-                            continue;
-                        const referenceId = EntityReferences_1.EntityReferences.fromEntityType(relatedElem.id, navProp.concreteEntityType);
-                        referenceIds.add(referenceId);
-                    }
-                },
-                // defaults for methods on a prototype (required for sinon to stub out methods on tests)
-                writable: true,
-                configurable: true,
-            });
-        }
-        // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations
-        if (schema.missingRequiredBehavior) {
-            const throwError = () => {
-                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`);
-            };
-            superclass.protectedOperations.forEach((operation) => generatedClass[operation] = throwError);
-        }
-        this.register(generatedClass, schema); // register it before returning
-        return generatedClass;
-    }
-    /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]
-     * @param moduleObj The module to search for subclasses of Entity
-     * @param schema The schema for all found classes
-     */
-    static registerModule(moduleObj, schema) {
-        for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in
-            const thisClass = moduleObj[thisMember];
-            if (thisClass.prototype instanceof Entity_1.Entity)
-                this.register(thisClass, schema);
-        }
-    }
-    /**
-     * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated
-     * class. This function also ensures that all of the base classes of the Entity exist and are registered.
-     */
-    static generateClass(classFullName, iModel) {
-        const metadata = iModel.classMetaDataRegistry.find(classFullName);
-        if (metadata === undefined || metadata.ecclass === undefined)
-            throw this.makeMetaDataNotFoundError(classFullName);
-        // Make sure we have all base classes registered.
-        if (metadata.baseClasses && (0 !== metadata.baseClasses.length))
-            this.getClass(metadata.baseClasses[0], iModel);
-        // Now we can generate the class from the classDef.
-        return this.generateClassForEntity(metadata, iModel);
-    }
-    /** Find a registered class by classFullName.
-     * @param classFullName class to find
-     * @param iModel The IModel that contains the class definitions
-     * @returns The Entity class or undefined
-     */
-    static findRegisteredClass(classFullName) {
-        return this._classMap.get(classFullName.toLowerCase());
-    }
-    /** Get the Entity class for the specified Entity className.
-     * @param classFullName The full BIS class name of the Entity
-     * @param iModel The IModel that contains the class definitions
-     * @returns The Entity class
-     */
-    static getClass(classFullName, iModel) {
-        const key = classFullName.toLowerCase();
-        const ctor = this._classMap.get(key);
-        return ctor ? ctor : this.generateClass(key, iModel);
-    }
-    /** Unregister a class, by name, if one is already registered.
-     * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.
-     * @param classFullName Name of the class to unregister
-     * @return true if the class was unregistered
-     * @internal
-     */
-    static unregisterCLass(classFullName) { return this._classMap.delete(classFullName.toLowerCase()); }
-    /** Unregister all classes from a schema.
-     * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.
-     * @param schema Name of the schema to unregister
-     * @internal
-     */
-    static unregisterClassesFrom(schema) {
-        for (const entry of Array.from(this._classMap)) {
-            if (entry[1].schema === schema)
-                this.unregisterCLass(entry[0]);
-        }
-    }
-}
-exports.ClassRegistry = ClassRegistry;
-ClassRegistry._classMap = new Map();
-/**
- * A cache that records the mapping between class names and class metadata
- * @internal
- */
-class MetaDataRegistry {
-    constructor() {
-        this._registry = new Map();
-    }
-    /** Get the specified Entity metadata */
-    find(classFullName) { return this._registry.get(classFullName.toLowerCase()); }
-    /** Add metadata to the cache */
-    add(classFullName, metaData) { this._registry.set(classFullName.toLowerCase(), metaData); }
-}
-exports.MetaDataRegistry = MetaDataRegistry;
+      WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {
+            stmt.bindString(1, domain);
+            stmt.bindString(2, "BisCore.SchemaHasBehavior");
+            return stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW;
+        });
+        const schemaClass = class extends Schema_1.Schema {
+            static get schemaName() { return domain; }
+            static get missingRequiredBehavior() { return hasBehavior; }
+        };
+        Schema_1.Schemas.registerSchema(schemaClass); // register the class before we return it.
+        return schemaClass;
+    }
+    /** First, finds the root BisCore entity class for an entity, by traversing base classes and mixin targets (AppliesTo).
+     * Then, gets its metadata and returns that.
+     * @param iModel - iModel containing the metadata for this type
+     * @param ecTypeQualifier - a full name of an ECEntityClass to find the root of
+     * @returns the qualified full name of an ECEntityClass
+     * @internal public for testing only
+     */
+    static getRootEntity(iModel, ecTypeQualifier) {
+        const [classSchema, className] = ecTypeQualifier.split(".");
+        const schemaItemJson = iModel.nativeDb.getSchemaItem(classSchema, className);
+        if (schemaItemJson.error)
+            throw new core_common_1.IModelError(schemaItemJson.error.status, `failed to get schema item '${ecTypeQualifier}'`);
+        assert(undefined !== schemaItemJson.result);
+        const schemaItem = JSON.parse(schemaItemJson.result);
+        if (!("appliesTo" in schemaItem) && schemaItem.baseClass === undefined) {
+            return ecTypeQualifier;
+        }
+        // typescript doesn't understand that the inverse of the above condition is
+        // ("appliesTo" in rootclassMetaData || rootClassMetaData.baseClass !== undefined)
+        const parentItemQualifier = schemaItem.appliesTo ?? schemaItem.baseClass;
+        return this.getRootEntity(iModel, parentItemQualifier);
+    }
+    /** Generate a JavaScript class from Entity metadata.
+     * @param entityMetaData The Entity metadata that defines the class
+     */
+    static generateClassForEntity(entityMetaData, iModel) {
+        var _a, _b;
+        const name = entityMetaData.ecclass.split(":");
+        const domainName = name[0];
+        const className = name[1];
+        if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `class ${name} has no superclass`);
+        // make sure schema exists
+        let schema = Schema_1.Schemas.getRegisteredSchema(domainName);
+        if (undefined === schema)
+            schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too
+        const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());
+        if (undefined === superclass)
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `cannot find superclass for class ${name}`);
+        // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot
+        // be used to tell if there are any generated classes in the hierarchy
+        let generatedClassHasNonGeneratedNonCoreAncestor = false;
+        let currentSuperclass = superclass;
+        const MAX_ITERS = 1000;
+        for (let i = 0; i < MAX_ITERS; ++i) {
+            if (currentSuperclass.schema.schemaName === "BisCore")
+                break;
+            if (!currentSuperclass.isGeneratedClass) {
+                generatedClassHasNonGeneratedNonCoreAncestor = true;
+                break;
+            }
+            const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);
+            if (superclassMetaData === undefined)
+                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);
+            const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);
+            if (maybeNextSuperclass === undefined)
+                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);
+            currentSuperclass = maybeNextSuperclass;
+        }
+        const generatedClass = (_b = class extends superclass {
+                static get className() { return className; }
+                static get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }
+            },
+            _a = isGeneratedClassTag,
+            __setFunctionName(_b, "generatedClass"),
+            _b[_a] = true,
+            _b);
+        // the above creates an anonymous class. For help debugging, set the "constructor.name" property to be the same as the bisClassName.
+        Object.defineProperty(generatedClass, "name", { get: () => className }); // this is the (only) way to change that readonly property.
+        // a class only gets an automatic `collectReferenceConcreteIds` implementation if:
+        // - it is not in the `BisCore` schema
+        // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)
+        if (!generatedClassHasNonGeneratedNonCoreAncestor) {
+            const navigationProps = Object.entries(entityMetaData.properties)
+                .filter(([_name, prop]) => prop.isNavigation)
+                // eslint-disable-next-line @typescript-eslint/no-shadow
+                .map(([name, prop]) => {
+                assert(prop.relationshipClass);
+                const maybeMetaData = iModel.nativeDb.getSchemaItem(...prop.relationshipClass.split(":"));
+                assert(maybeMetaData.result !== undefined, "The nav props relationship metadata was not found");
+                const relMetaData = JSON.parse(maybeMetaData.result);
+                const rootClassMetaData = ClassRegistry.getRootEntity(iModel, relMetaData.target.constraintClasses[0]);
+                // root class must be in BisCore so should be loaded since biscore classes will never get this
+                // generated implementation
+                const normalizeClassName = (clsName) => clsName.replace(".", ":");
+                const rootClass = ClassRegistry.findRegisteredClass(normalizeClassName(rootClassMetaData));
+                assert(rootClass, `The root class for ${prop.relationshipClass} was not in BisCore.`);
+                return { name, concreteEntityType: EntityReferences_1.EntityReferences.typeFromClass(rootClass) };
+            });
+            Object.defineProperty(generatedClass.prototype, "collectReferenceConcreteIds", {
+                value(referenceIds) {
+                    // eslint-disable-next-line @typescript-eslint/dot-notation
+                    const superImpl = superclass.prototype["collectReferenceConcreteIds"];
+                    superImpl.call(this, referenceIds);
+                    for (const navProp of navigationProps) {
+                        const relatedElem = this[navProp.name]; // cast to any since subclass can have any extensions
+                        if (!relatedElem || !core_bentley_1.Id64.isValid(relatedElem.id))
+                            continue;
+                        const referenceId = EntityReferences_1.EntityReferences.fromEntityType(relatedElem.id, navProp.concreteEntityType);
+                        referenceIds.add(referenceId);
+                    }
+                },
+                // defaults for methods on a prototype (required for sinon to stub out methods on tests)
+                writable: true,
+                configurable: true,
+            });
+        }
+        // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations
+        if (schema.missingRequiredBehavior) {
+            const throwError = () => {
+                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`);
+            };
+            superclass.protectedOperations.forEach((operation) => generatedClass[operation] = throwError);
+        }
+        this.register(generatedClass, schema); // register it before returning
+        return generatedClass;
+    }
+    /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]
+     * @param moduleObj The module to search for subclasses of Entity
+     * @param schema The schema for all found classes
+     */
+    static registerModule(moduleObj, schema) {
+        for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in
+            const thisClass = moduleObj[thisMember];
+            if (thisClass.prototype instanceof Entity_1.Entity)
+                this.register(thisClass, schema);
+        }
+    }
+    /**
+     * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated
+     * class. This function also ensures that all of the base classes of the Entity exist and are registered.
+     */
+    static generateClass(classFullName, iModel) {
+        const metadata = iModel.classMetaDataRegistry.find(classFullName);
+        if (metadata === undefined || metadata.ecclass === undefined)
+            throw this.makeMetaDataNotFoundError(classFullName);
+        // Make sure we have all base classes registered.
+        if (metadata.baseClasses && (0 !== metadata.baseClasses.length))
+            this.getClass(metadata.baseClasses[0], iModel);
+        // Now we can generate the class from the classDef.
+        return this.generateClassForEntity(metadata, iModel);
+    }
+    /** Find a registered class by classFullName.
+     * @param classFullName class to find
+     * @param iModel The IModel that contains the class definitions
+     * @returns The Entity class or undefined
+     */
+    static findRegisteredClass(classFullName) {
+        return this._classMap.get(classFullName.toLowerCase());
+    }
+    /** Get the Entity class for the specified Entity className.
+     * @param classFullName The full BIS class name of the Entity
+     * @param iModel The IModel that contains the class definitions
+     * @returns The Entity class
+     */
+    static getClass(classFullName, iModel) {
+        const key = classFullName.toLowerCase();
+        const ctor = this._classMap.get(key);
+        return ctor ? ctor : this.generateClass(key, iModel);
+    }
+    /** Unregister a class, by name, if one is already registered.
+     * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.
+     * @param classFullName Name of the class to unregister
+     * @return true if the class was unregistered
+     * @internal
+     */
+    static unregisterCLass(classFullName) { return this._classMap.delete(classFullName.toLowerCase()); }
+    /** Unregister all classes from a schema.
+     * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.
+     * @param schema Name of the schema to unregister
+     * @internal
+     */
+    static unregisterClassesFrom(schema) {
+        for (const entry of Array.from(this._classMap)) {
+            if (entry[1].schema === schema)
+                this.unregisterCLass(entry[0]);
+        }
+    }
+}
+ClassRegistry._classMap = new Map();
+exports.ClassRegistry = ClassRegistry;
+/**
+ * A cache that records the mapping between class names and class metadata
+ * @internal
+ */
+class MetaDataRegistry {
+    constructor() {
+        this._registry = new Map();
+    }
+    /** Get the specified Entity metadata */
+    find(classFullName) { return this._registry.get(classFullName.toLowerCase()); }
+    /** Add metadata to the cache */
+    add(classFullName, metaData) { this._registry.set(classFullName.toLowerCase(), metaData); }
+}
+exports.MetaDataRegistry = MetaDataRegistry;
 //# sourceMappingURL=ClassRegistry.js.map

package/lib/cjs/ClassRegistry.js.map

@@ -1 +1 @@
-{"version":3,"file":"ClassRegistry.js","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA2E;AAC3E,oDAAqG;AACrG,qCAAkC;AAElC,qCAA2C;AAC3C,yDAAsD;AACtD,iCAAiC;AAEjC,MAAM,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAa,aAAa;IAExB,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,GAAQ,IAAI,OAAO,CAAC,GAAG,YAAY,yBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,2BAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/H,gBAAgB;IACT,MAAM,CAAC,yBAAyB,CAAC,SAAiB,IAAiB,OAAO,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,0BAA0B,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACjK,gBAAgB;IACT,MAAM,CAAC,QAAQ,CAAC,WAA0B,EAAE,MAAqB;QACtE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;QAC5B,MAAM,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,MAAM,GAAG,SAAS,GAAG,4FAA4F,WAAW,CAAC,IAAI,EAAE,CAAC;YAC1I,qBAAM,CAAC,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;SACzB;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACvC,CAAC;IAED,yEAAyE;IACjE,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,MAAgB;QACjE,MAAM,WAAW,GAAG,MAAM,CAAC,2BAA2B,CAAC;;;;;+FAKoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACpG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,KAAM,SAAQ,eAAM;YAC/B,MAAM,KAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;YACnD,MAAM,KAAc,uBAAuB,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC;SAC7E,CAAC;QAEF,gBAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,0CAA0C;QAC/E,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,MAAgB,EAAE,eAAuB;;QACnE,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5D,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QAC7E,IAAI,cAAc,CAAC,KAAK;YACtB,MAAM,IAAI,yBAAW,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,8BAA8B,eAAe,GAAG,CAAC,CAAC;QAEvG,MAAM,CAAC,SAAS,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,CAAC,CAAC,WAAW,IAAI,UAAU,CAAC,IAAI,UAAU,CAAC,SAAS,KAAK,SAAS,EAAE;YACtE,OAAO,eAAe,CAAC;SACxB;QAED,2EAA2E;QAC3E,kFAAkF;QAClF,MAAM,mBAAmB,GAAG,MAAA,UAAU,CAAC,SAAS,mCAAI,UAAU,CAAC,SAAmB,CAAC;QACnF,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,sBAAsB,CAAC,cAA8B,EAAE,MAAgB;;QACpF,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,CAAC,KAAK,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,qCAAqC;YAChF,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,SAAS,IAAI,oBAAoB,CAAC,CAAC;QAEhF,0BAA0B;QAC1B,IAAI,MAAM,GAAG,gBAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,iCAAiC;QAE1F,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QACnF,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,oCAAoC,IAAI,EAAE,CAAC,CAAC;QAE3F,6GAA6G;QAC7G,sEAAsE;QACtE,IAAI,4CAA4C,GAAG,KAAK,CAAC;QACzD,IAAI,iBAAiB,GAAG,UAAU,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC,EAAE;YAClC,IAAI,iBAAiB,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS;gBACnD,MAAM;YAER,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE;gBACvC,4CAA4C,GAAG,IAAI,CAAC;gBACpD,MAAM;aACP;YACD,MAAM,kBAAkB,GAAG,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAC9F,IAAI,kBAAkB,KAAK,SAAS;gBAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,0CAA0C,iBAAiB,CAAC,IAAI,2CAA2C,CAAC,CAAC;YAC7J,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YACrF,IAAI,mBAAmB,KAAK,SAAS;gBACnC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,qCAAqC,iBAAiB,CAAC,IAAI,iDAAiD,CAAC,CAAC;YAC9J,iBAAiB,GAAG,mBAAmB,CAAC;SACzC;QAED,MAAM,cAAc,SAAG,KAAM,SAAQ,UAAU;gBACtC,MAAM,KAAc,SAAS,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;gBAErD,MAAM,KAAc,gBAAgB,KAAK,OAAO,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;aACnG;iBAFiB,mBAAmB;YAApB,MAAqB,GAAG,IAAK;eAE7C,CAAC;QAEF,oIAAoI;QACpI,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAE,2DAA2D;QAErI,kFAAkF;QAClF,sCAAsC;QACtC,yGAAyG;QACzG,IAAI,CAAC,4CAA4C,EAAE;YACjD,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC;iBAC9D,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;gBAC7C,wDAAwD;iBACvD,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;gBACpB,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAqB,CAAC,CAAC;gBAC9G,MAAM,CAAC,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE,mDAAmD,CAAC,CAAC;gBAChG,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBACrD,MAAM,iBAAiB,GAAG,aAAa,CAAC,aAAa,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvG,8FAA8F;gBAC9F,2BAA2B;gBAC3B,MAAM,kBAAkB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBAC1E,MAAM,SAAS,GAAG,aAAa,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,CAAC;gBAC3F,MAAM,CAAC,SAAS,EAAE,sBAAsB,IAAI,CAAC,iBAAiB,sBAAsB,CAAC,CAAC;gBACtF,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,mCAAgB,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;YACjF,CAAC,CAAC,CAAC;YAEL,MAAM,CAAC,cAAc,CACnB,cAAc,CAAC,SAAS,EACxB,6BAA6B,EAC7B;gBACE,KAAK,CAA8B,YAAgC;oBACjE,2DAA2D;oBAC3D,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;oBACtE,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;oBACnC,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE;wBACrC,MAAM,WAAW,GAAgC,IAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,qDAAqD;wBAClI,IAAI,CAAC,WAAW,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;4BAC/C,SAAS;wBACX,MAAM,WAAW,GAAG,mCAAgB,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;wBAChG,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;qBAC/B;gBACH,CAAC;gBACD,wFAAwF;gBACxF,QAAQ,EAAE,IAAI;gBACd,YAAY,EAAE,IAAI;aACnB,CACF,CAAC;SACH;QAED,qGAAqG;QACrG,IAAI,MAAM,CAAC,uBAAuB,EAAE;YAClC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACtB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,WAAW,UAAU,wDAAwD,CAAC,CAAC;YAClI,CAAC,CAAC;YAEF,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAE,cAAsB,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,CAAC;SACxG;QAED,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,+BAA+B;QACtE,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,SAAc,EAAE,MAAqB;QAChE,KAAK,MAAM,UAAU,IAAI,SAAS,EAAE,EAAE,mCAAmC;YACvE,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,SAAS,CAAC,SAAS,YAAY,eAAM;gBACvC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SACpC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,aAAa,CAAC,aAAqB,EAAE,MAAgB;QAClE,MAAM,QAAQ,GAA+B,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9F,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS;YAC1D,MAAM,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAEtD,iDAAiD;QACjD,IAAI,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,KAAK,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAEjD,mDAAmD;QACnD,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,aAAqB;QACrD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAqB,EAAE,MAAgB;QAC5D,MAAM,GAAG,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,aAAqB,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IACnH;;;;OAIG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAqB;QACvD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC9C,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM;gBAC5B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAClC;IACH,CAAC;;AAhPH,sCAiPC;AAhPyB,uBAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;AAkPvE;;;GAGG;AACH,MAAa,gBAAgB;IAA7B;QACU,cAAS,GAAgC,IAAI,GAAG,EAA0B,CAAC;IAOrF,CAAC;IALC,wCAAwC;IACjC,IAAI,CAAC,aAAqB,IAAgC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IAE1H,gCAAgC;IACzB,GAAG,CAAC,aAAqB,EAAE,QAAwB,IAAU,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACjI;AARD,4CAQC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Schema\r\n */\r\n\r\nimport { DbResult, Id64, IModelStatus, Logger } from \"@itwin/core-bentley\";\r\nimport { EntityMetaData, EntityReferenceSet, IModelError, RelatedElement } from \"@itwin/core-common\";\r\nimport { Entity } from \"./Entity\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Schema, Schemas } from \"./Schema\";\r\nimport { EntityReferences } from \"./EntityReferences\";\r\nimport * as assert from \"assert\";\r\n\r\nconst isGeneratedClassTag = Symbol(\"isGeneratedClassTag\");\r\n\r\n/** The mapping between a BIS class name (in the form \"schema:class\") and its JavaScript constructor function\r\n * @public\r\n */\r\nexport class ClassRegistry {\r\n  private static readonly _classMap = new Map<string, typeof Entity>();\r\n  /** @internal */\r\n  public static isNotFoundError(err: any) { return (err instanceof IModelError) && (err.errorNumber === IModelStatus.NotFound); }\r\n  /** @internal */\r\n  public static makeMetaDataNotFoundError(className: string): IModelError { return new IModelError(IModelStatus.NotFound, `metadata not found for ${className}`); }\r\n  /** @internal */\r\n  public static register(entityClass: typeof Entity, schema: typeof Schema) {\r\n    entityClass.schema = schema;\r\n    const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();\r\n    if (this._classMap.has(key)) {\r\n      const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;\r\n      Logger.logError(\"core-frontend.classRegistry\", errMsg);\r\n      throw new Error(errMsg);\r\n    }\r\n\r\n    this._classMap.set(key, entityClass);\r\n  }\r\n\r\n  /** Generate a proxy Schema for a domain that has not been registered. */\r\n  private static generateProxySchema(domain: string, iModel: IModelDb): typeof Schema {\r\n    const hasBehavior = iModel.withPreparedSqliteStatement(`\r\n      SELECT NULL FROM [ec_CustomAttribute] [c]\r\n        JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]\r\n        JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]\r\n        JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]\r\n      WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {\r\n      stmt.bindString(1, domain);\r\n      stmt.bindString(2, \"BisCore.SchemaHasBehavior\");\r\n      return stmt.step() === DbResult.BE_SQLITE_ROW;\r\n    });\r\n\r\n    const schemaClass = class extends Schema {\r\n      public static override get schemaName() { return domain; }\r\n      public static override get missingRequiredBehavior() { return hasBehavior; }\r\n    };\r\n\r\n    Schemas.registerSchema(schemaClass); // register the class before we return it.\r\n    return schemaClass;\r\n  }\r\n\r\n  /** First, finds the root BisCore entity class for an entity, by traversing base classes and mixin targets (AppliesTo).\r\n   * Then, gets its metadata and returns that.\r\n   * @param iModel - iModel containing the metadata for this type\r\n   * @param ecTypeQualifier - a full name of an ECEntityClass to find the root of\r\n   * @returns the qualified full name of an ECEntityClass\r\n   * @internal public for testing only\r\n   */\r\n  public static getRootEntity(iModel: IModelDb, ecTypeQualifier: string): string {\r\n    const [classSchema, className] = ecTypeQualifier.split(\".\");\r\n    const schemaItemJson = iModel.nativeDb.getSchemaItem(classSchema, className);\r\n    if (schemaItemJson.error)\r\n      throw new IModelError(schemaItemJson.error.status, `failed to get schema item '${ecTypeQualifier}'`);\r\n\r\n    assert(undefined !== schemaItemJson.result);\r\n    const schemaItem = JSON.parse(schemaItemJson.result);\r\n    if (!(\"appliesTo\" in schemaItem) && schemaItem.baseClass === undefined) {\r\n      return ecTypeQualifier;\r\n    }\r\n\r\n    // typescript doesn't understand that the inverse of the above condition is\r\n    // (\"appliesTo\" in rootclassMetaData || rootClassMetaData.baseClass !== undefined)\r\n    const parentItemQualifier = schemaItem.appliesTo ?? schemaItem.baseClass as string;\r\n    return this.getRootEntity(iModel, parentItemQualifier);\r\n  }\r\n\r\n  /** Generate a JavaScript class from Entity metadata.\r\n   * @param entityMetaData The Entity metadata that defines the class\r\n   */\r\n  private static generateClassForEntity(entityMetaData: EntityMetaData, iModel: IModelDb): typeof Entity {\r\n    const name = entityMetaData.ecclass.split(\":\");\r\n    const domainName = name[0];\r\n    const className = name[1];\r\n\r\n    if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass\r\n      throw new IModelError(IModelStatus.BadArg, `class ${name} has no superclass`);\r\n\r\n    // make sure schema exists\r\n    let schema = Schemas.getRegisteredSchema(domainName);\r\n    if (undefined === schema)\r\n      schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too\r\n\r\n    const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());\r\n    if (undefined === superclass)\r\n      throw new IModelError(IModelStatus.NotFound, `cannot find superclass for class ${name}`);\r\n\r\n    // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot\r\n    // be used to tell if there are any generated classes in the hierarchy\r\n    let generatedClassHasNonGeneratedNonCoreAncestor = false;\r\n    let currentSuperclass = superclass;\r\n    const MAX_ITERS = 1000;\r\n    for (let i = 0; i < MAX_ITERS; ++i) {\r\n      if (currentSuperclass.schema.schemaName === \"BisCore\")\r\n        break;\r\n\r\n      if (!currentSuperclass.isGeneratedClass) {\r\n        generatedClassHasNonGeneratedNonCoreAncestor = true;\r\n        break;\r\n      }\r\n      const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);\r\n      if (superclassMetaData === undefined)\r\n        throw new IModelError(IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);\r\n      const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);\r\n      if (maybeNextSuperclass === undefined)\r\n        throw new IModelError(IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);\r\n      currentSuperclass = maybeNextSuperclass;\r\n    }\r\n\r\n    const generatedClass = class extends superclass {\r\n      public static override get className() { return className; }\r\n      private static [isGeneratedClassTag] = true;\r\n      public static override get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }\r\n    };\r\n\r\n    // the above creates an anonymous class. For help debugging, set the \"constructor.name\" property to be the same as the bisClassName.\r\n    Object.defineProperty(generatedClass, \"name\", { get: () => className });  // this is the (only) way to change that readonly property.\r\n\r\n    // a class only gets an automatic `collectReferenceConcreteIds` implementation if:\r\n    // - it is not in the `BisCore` schema\r\n    // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)\r\n    if (!generatedClassHasNonGeneratedNonCoreAncestor) {\r\n      const navigationProps = Object.entries(entityMetaData.properties)\r\n        .filter(([_name, prop]) => prop.isNavigation)\r\n        // eslint-disable-next-line @typescript-eslint/no-shadow\r\n        .map(([name, prop]) => {\r\n          assert(prop.relationshipClass);\r\n          const maybeMetaData = iModel.nativeDb.getSchemaItem(...prop.relationshipClass.split(\":\") as [string, string]);\r\n          assert(maybeMetaData.result !== undefined, \"The nav props relationship metadata was not found\");\r\n          const relMetaData = JSON.parse(maybeMetaData.result);\r\n          const rootClassMetaData = ClassRegistry.getRootEntity(iModel, relMetaData.target.constraintClasses[0]);\r\n          // root class must be in BisCore so should be loaded since biscore classes will never get this\r\n          // generated implementation\r\n          const normalizeClassName = (clsName: string) => clsName.replace(\".\", \":\");\r\n          const rootClass = ClassRegistry.findRegisteredClass(normalizeClassName(rootClassMetaData));\r\n          assert(rootClass, `The root class for ${prop.relationshipClass} was not in BisCore.`);\r\n          return { name, concreteEntityType: EntityReferences.typeFromClass(rootClass) };\r\n        });\r\n\r\n      Object.defineProperty(\r\n        generatedClass.prototype,\r\n        \"collectReferenceConcreteIds\",\r\n        {\r\n          value(this: typeof generatedClass, referenceIds: EntityReferenceSet) {\r\n            // eslint-disable-next-line @typescript-eslint/dot-notation\r\n            const superImpl = superclass.prototype[\"collectReferenceConcreteIds\"];\r\n            superImpl.call(this, referenceIds);\r\n            for (const navProp of navigationProps) {\r\n              const relatedElem: RelatedElement | undefined = (this as any)[navProp.name]; // cast to any since subclass can have any extensions\r\n              if (!relatedElem || !Id64.isValid(relatedElem.id))\r\n                continue;\r\n              const referenceId = EntityReferences.fromEntityType(relatedElem.id, navProp.concreteEntityType);\r\n              referenceIds.add(referenceId);\r\n            }\r\n          },\r\n          // defaults for methods on a prototype (required for sinon to stub out methods on tests)\r\n          writable: true,\r\n          configurable: true,\r\n        }\r\n      );\r\n    }\r\n\r\n    // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations\r\n    if (schema.missingRequiredBehavior) {\r\n      const throwError = () => {\r\n        throw new IModelError(IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`);\r\n      };\r\n\r\n      superclass.protectedOperations.forEach((operation) => (generatedClass as any)[operation] = throwError);\r\n    }\r\n\r\n    this.register(generatedClass, schema); // register it before returning\r\n    return generatedClass;\r\n  }\r\n\r\n  /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]\r\n   * @param moduleObj The module to search for subclasses of Entity\r\n   * @param schema The schema for all found classes\r\n   */\r\n  public static registerModule(moduleObj: any, schema: typeof Schema) {\r\n    for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in\r\n      const thisClass = moduleObj[thisMember];\r\n      if (thisClass.prototype instanceof Entity)\r\n        this.register(thisClass, schema);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated\r\n   * class. This function also ensures that all of the base classes of the Entity exist and are registered.\r\n   */\r\n  private static generateClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const metadata: EntityMetaData | undefined = iModel.classMetaDataRegistry.find(classFullName);\r\n    if (metadata === undefined || metadata.ecclass === undefined)\r\n      throw this.makeMetaDataNotFoundError(classFullName);\r\n\r\n    // Make sure we have all base classes registered.\r\n    if (metadata.baseClasses && (0 !== metadata.baseClasses.length))\r\n      this.getClass(metadata.baseClasses[0], iModel);\r\n\r\n    // Now we can generate the class from the classDef.\r\n    return this.generateClassForEntity(metadata, iModel);\r\n  }\r\n\r\n  /** Find a registered class by classFullName.\r\n   * @param classFullName class to find\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class or undefined\r\n   */\r\n  public static findRegisteredClass(classFullName: string): typeof Entity | undefined {\r\n    return this._classMap.get(classFullName.toLowerCase());\r\n  }\r\n\r\n  /** Get the Entity class for the specified Entity className.\r\n   * @param classFullName The full BIS class name of the Entity\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class\r\n   */\r\n  public static getClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const key = classFullName.toLowerCase();\r\n    const ctor = this._classMap.get(key);\r\n    return ctor ? ctor : this.generateClass(key, iModel);\r\n  }\r\n\r\n  /** Unregister a class, by name, if one is already registered.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.\r\n   * @param classFullName Name of the class to unregister\r\n   * @return true if the class was unregistered\r\n   * @internal\r\n   */\r\n  public static unregisterCLass(classFullName: string) { return this._classMap.delete(classFullName.toLowerCase()); }\r\n  /** Unregister all classes from a schema.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\r\n   * @param schema Name of the schema to unregister\r\n   * @internal\r\n   */\r\n  public static unregisterClassesFrom(schema: typeof Schema) {\r\n    for (const entry of Array.from(this._classMap)) {\r\n      if (entry[1].schema === schema)\r\n        this.unregisterCLass(entry[0]);\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * A cache that records the mapping between class names and class metadata\r\n * @internal\r\n */\r\nexport class MetaDataRegistry {\r\n  private _registry: Map<string, EntityMetaData> = new Map<string, EntityMetaData>();\r\n\r\n  /** Get the specified Entity metadata */\r\n  public find(classFullName: string): EntityMetaData | undefined { return this._registry.get(classFullName.toLowerCase()); }\r\n\r\n  /** Add metadata to the cache */\r\n  public add(classFullName: string, metaData: EntityMetaData): void { this._registry.set(classFullName.toLowerCase(), metaData); }\r\n}\r\n"]}
+{"version":3,"file":"ClassRegistry.js","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;AAEH,sDAA2E;AAC3E,oDAAqG;AACrG,qCAAkC;AAElC,qCAA2C;AAC3C,yDAAsD;AACtD,iCAAiC;AAEjC,MAAM,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAa,aAAa;IAExB,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,GAAQ,IAAI,OAAO,CAAC,GAAG,YAAY,yBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,2BAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/H,gBAAgB;IACT,MAAM,CAAC,yBAAyB,CAAC,SAAiB,IAAiB,OAAO,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,0BAA0B,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACjK,gBAAgB;IACT,MAAM,CAAC,QAAQ,CAAC,WAA0B,EAAE,MAAqB;QACtE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;QAC5B,MAAM,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,MAAM,GAAG,SAAS,GAAG,4FAA4F,WAAW,CAAC,IAAI,EAAE,CAAC;YAC1I,qBAAM,CAAC,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;SACzB;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACvC,CAAC;IAED,yEAAyE;IACjE,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,MAAgB;QACjE,MAAM,WAAW,GAAG,MAAM,CAAC,2BAA2B,CAAC;;;;;+FAKoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACpG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,KAAM,SAAQ,eAAM;YAC/B,MAAM,KAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;YACnD,MAAM,KAAc,uBAAuB,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC;SAC7E,CAAC;QAEF,gBAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,0CAA0C;QAC/E,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,MAAgB,EAAE,eAAuB;QACnE,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5D,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QAC7E,IAAI,cAAc,CAAC,KAAK;YACtB,MAAM,IAAI,yBAAW,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,8BAA8B,eAAe,GAAG,CAAC,CAAC;QAEvG,MAAM,CAAC,SAAS,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,CAAC,CAAC,WAAW,IAAI,UAAU,CAAC,IAAI,UAAU,CAAC,SAAS,KAAK,SAAS,EAAE;YACtE,OAAO,eAAe,CAAC;SACxB;QAED,2EAA2E;QAC3E,kFAAkF;QAClF,MAAM,mBAAmB,GAAG,UAAU,CAAC,SAAS,IAAI,UAAU,CAAC,SAAmB,CAAC;QACnF,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,sBAAsB,CAAC,cAA8B,EAAE,MAAgB;;QACpF,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,CAAC,KAAK,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,qCAAqC;YAChF,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,SAAS,IAAI,oBAAoB,CAAC,CAAC;QAEhF,0BAA0B;QAC1B,IAAI,MAAM,GAAG,gBAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,iCAAiC;QAE1F,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QACnF,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,oCAAoC,IAAI,EAAE,CAAC,CAAC;QAE3F,6GAA6G;QAC7G,sEAAsE;QACtE,IAAI,4CAA4C,GAAG,KAAK,CAAC;QACzD,IAAI,iBAAiB,GAAG,UAAU,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC,EAAE;YAClC,IAAI,iBAAiB,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS;gBACnD,MAAM;YAER,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE;gBACvC,4CAA4C,GAAG,IAAI,CAAC;gBACpD,MAAM;aACP;YACD,MAAM,kBAAkB,GAAG,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAC9F,IAAI,kBAAkB,KAAK,SAAS;gBAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,0CAA0C,iBAAiB,CAAC,IAAI,2CAA2C,CAAC,CAAC;YAC7J,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YACrF,IAAI,mBAAmB,KAAK,SAAS;gBACnC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,qCAAqC,iBAAiB,CAAC,IAAI,iDAAiD,CAAC,CAAC;YAC9J,iBAAiB,GAAG,mBAAmB,CAAC;SACzC;QAED,MAAM,cAAc,SAAG,KAAM,SAAQ,UAAU;gBACtC,MAAM,KAAc,SAAS,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;gBAErD,MAAM,KAAc,gBAAgB,KAAK,OAAO,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;aACnG;iBAFiB,mBAAmB;;YAApB,MAAqB,GAAG,IAAK;eAE7C,CAAC;QAEF,oIAAoI;QACpI,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAE,2DAA2D;QAErI,kFAAkF;QAClF,sCAAsC;QACtC,yGAAyG;QACzG,IAAI,CAAC,4CAA4C,EAAE;YACjD,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC;iBAC9D,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;gBAC7C,wDAAwD;iBACvD,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;gBACpB,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAqB,CAAC,CAAC;gBAC9G,MAAM,CAAC,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE,mDAAmD,CAAC,CAAC;gBAChG,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBACrD,MAAM,iBAAiB,GAAG,aAAa,CAAC,aAAa,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvG,8FAA8F;gBAC9F,2BAA2B;gBAC3B,MAAM,kBAAkB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBAC1E,MAAM,SAAS,GAAG,aAAa,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,CAAC;gBAC3F,MAAM,CAAC,SAAS,EAAE,sBAAsB,IAAI,CAAC,iBAAiB,sBAAsB,CAAC,CAAC;gBACtF,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,mCAAgB,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;YACjF,CAAC,CAAC,CAAC;YAEL,MAAM,CAAC,cAAc,CACnB,cAAc,CAAC,SAAS,EACxB,6BAA6B,EAC7B;gBACE,KAAK,CAA8B,YAAgC;oBACjE,2DAA2D;oBAC3D,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;oBACtE,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;oBACnC,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE;wBACrC,MAAM,WAAW,GAAgC,IAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,qDAAqD;wBAClI,IAAI,CAAC,WAAW,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;4BAC/C,SAAS;wBACX,MAAM,WAAW,GAAG,mCAAgB,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;wBAChG,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;qBAC/B;gBACH,CAAC;gBACD,wFAAwF;gBACxF,QAAQ,EAAE,IAAI;gBACd,YAAY,EAAE,IAAI;aACnB,CACF,CAAC;SACH;QAED,qGAAqG;QACrG,IAAI,MAAM,CAAC,uBAAuB,EAAE;YAClC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACtB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,WAAW,UAAU,wDAAwD,CAAC,CAAC;YAClI,CAAC,CAAC;YAEF,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAE,cAAsB,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,CAAC;SACxG;QAED,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,+BAA+B;QACtE,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,SAAc,EAAE,MAAqB;QAChE,KAAK,MAAM,UAAU,IAAI,SAAS,EAAE,EAAE,mCAAmC;YACvE,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,SAAS,CAAC,SAAS,YAAY,eAAM;gBACvC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SACpC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,aAAa,CAAC,aAAqB,EAAE,MAAgB;QAClE,MAAM,QAAQ,GAA+B,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9F,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS;YAC1D,MAAM,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAEtD,iDAAiD;QACjD,IAAI,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,KAAK,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAEjD,mDAAmD;QACnD,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,aAAqB;QACrD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAqB,EAAE,MAAgB;QAC5D,MAAM,GAAG,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,aAAqB,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IACnH;;;;OAIG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAqB;QACvD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC9C,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM;gBAC5B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAClC;IACH,CAAC;;AA/OuB,uBAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;AAD1D,sCAAa;AAmP1B;;;GAGG;AACH,MAAa,gBAAgB;IAA7B;QACU,cAAS,GAAgC,IAAI,GAAG,EAA0B,CAAC;IAOrF,CAAC;IALC,wCAAwC;IACjC,IAAI,CAAC,aAAqB,IAAgC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IAE1H,gCAAgC;IACzB,GAAG,CAAC,aAAqB,EAAE,QAAwB,IAAU,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACjI;AARD,4CAQC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Schema\r\n */\r\n\r\nimport { DbResult, Id64, IModelStatus, Logger } from \"@itwin/core-bentley\";\r\nimport { EntityMetaData, EntityReferenceSet, IModelError, RelatedElement } from \"@itwin/core-common\";\r\nimport { Entity } from \"./Entity\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Schema, Schemas } from \"./Schema\";\r\nimport { EntityReferences } from \"./EntityReferences\";\r\nimport * as assert from \"assert\";\r\n\r\nconst isGeneratedClassTag = Symbol(\"isGeneratedClassTag\");\r\n\r\n/** The mapping between a BIS class name (in the form \"schema:class\") and its JavaScript constructor function\r\n * @public\r\n */\r\nexport class ClassRegistry {\r\n  private static readonly _classMap = new Map<string, typeof Entity>();\r\n  /** @internal */\r\n  public static isNotFoundError(err: any) { return (err instanceof IModelError) && (err.errorNumber === IModelStatus.NotFound); }\r\n  /** @internal */\r\n  public static makeMetaDataNotFoundError(className: string): IModelError { return new IModelError(IModelStatus.NotFound, `metadata not found for ${className}`); }\r\n  /** @internal */\r\n  public static register(entityClass: typeof Entity, schema: typeof Schema) {\r\n    entityClass.schema = schema;\r\n    const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();\r\n    if (this._classMap.has(key)) {\r\n      const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;\r\n      Logger.logError(\"core-frontend.classRegistry\", errMsg);\r\n      throw new Error(errMsg);\r\n    }\r\n\r\n    this._classMap.set(key, entityClass);\r\n  }\r\n\r\n  /** Generate a proxy Schema for a domain that has not been registered. */\r\n  private static generateProxySchema(domain: string, iModel: IModelDb): typeof Schema {\r\n    const hasBehavior = iModel.withPreparedSqliteStatement(`\r\n      SELECT NULL FROM [ec_CustomAttribute] [c]\r\n        JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]\r\n        JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]\r\n        JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]\r\n      WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {\r\n      stmt.bindString(1, domain);\r\n      stmt.bindString(2, \"BisCore.SchemaHasBehavior\");\r\n      return stmt.step() === DbResult.BE_SQLITE_ROW;\r\n    });\r\n\r\n    const schemaClass = class extends Schema {\r\n      public static override get schemaName() { return domain; }\r\n      public static override get missingRequiredBehavior() { return hasBehavior; }\r\n    };\r\n\r\n    Schemas.registerSchema(schemaClass); // register the class before we return it.\r\n    return schemaClass;\r\n  }\r\n\r\n  /** First, finds the root BisCore entity class for an entity, by traversing base classes and mixin targets (AppliesTo).\r\n   * Then, gets its metadata and returns that.\r\n   * @param iModel - iModel containing the metadata for this type\r\n   * @param ecTypeQualifier - a full name of an ECEntityClass to find the root of\r\n   * @returns the qualified full name of an ECEntityClass\r\n   * @internal public for testing only\r\n   */\r\n  public static getRootEntity(iModel: IModelDb, ecTypeQualifier: string): string {\r\n    const [classSchema, className] = ecTypeQualifier.split(\".\");\r\n    const schemaItemJson = iModel.nativeDb.getSchemaItem(classSchema, className);\r\n    if (schemaItemJson.error)\r\n      throw new IModelError(schemaItemJson.error.status, `failed to get schema item '${ecTypeQualifier}'`);\r\n\r\n    assert(undefined !== schemaItemJson.result);\r\n    const schemaItem = JSON.parse(schemaItemJson.result);\r\n    if (!(\"appliesTo\" in schemaItem) && schemaItem.baseClass === undefined) {\r\n      return ecTypeQualifier;\r\n    }\r\n\r\n    // typescript doesn't understand that the inverse of the above condition is\r\n    // (\"appliesTo\" in rootclassMetaData || rootClassMetaData.baseClass !== undefined)\r\n    const parentItemQualifier = schemaItem.appliesTo ?? schemaItem.baseClass as string;\r\n    return this.getRootEntity(iModel, parentItemQualifier);\r\n  }\r\n\r\n  /** Generate a JavaScript class from Entity metadata.\r\n   * @param entityMetaData The Entity metadata that defines the class\r\n   */\r\n  private static generateClassForEntity(entityMetaData: EntityMetaData, iModel: IModelDb): typeof Entity {\r\n    const name = entityMetaData.ecclass.split(\":\");\r\n    const domainName = name[0];\r\n    const className = name[1];\r\n\r\n    if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass\r\n      throw new IModelError(IModelStatus.BadArg, `class ${name} has no superclass`);\r\n\r\n    // make sure schema exists\r\n    let schema = Schemas.getRegisteredSchema(domainName);\r\n    if (undefined === schema)\r\n      schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too\r\n\r\n    const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());\r\n    if (undefined === superclass)\r\n      throw new IModelError(IModelStatus.NotFound, `cannot find superclass for class ${name}`);\r\n\r\n    // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot\r\n    // be used to tell if there are any generated classes in the hierarchy\r\n    let generatedClassHasNonGeneratedNonCoreAncestor = false;\r\n    let currentSuperclass = superclass;\r\n    const MAX_ITERS = 1000;\r\n    for (let i = 0; i < MAX_ITERS; ++i) {\r\n      if (currentSuperclass.schema.schemaName === \"BisCore\")\r\n        break;\r\n\r\n      if (!currentSuperclass.isGeneratedClass) {\r\n        generatedClassHasNonGeneratedNonCoreAncestor = true;\r\n        break;\r\n      }\r\n      const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);\r\n      if (superclassMetaData === undefined)\r\n        throw new IModelError(IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);\r\n      const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);\r\n      if (maybeNextSuperclass === undefined)\r\n        throw new IModelError(IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);\r\n      currentSuperclass = maybeNextSuperclass;\r\n    }\r\n\r\n    const generatedClass = class extends superclass {\r\n      public static override get className() { return className; }\r\n      private static [isGeneratedClassTag] = true;\r\n      public static override get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }\r\n    };\r\n\r\n    // the above creates an anonymous class. For help debugging, set the \"constructor.name\" property to be the same as the bisClassName.\r\n    Object.defineProperty(generatedClass, \"name\", { get: () => className });  // this is the (only) way to change that readonly property.\r\n\r\n    // a class only gets an automatic `collectReferenceConcreteIds` implementation if:\r\n    // - it is not in the `BisCore` schema\r\n    // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)\r\n    if (!generatedClassHasNonGeneratedNonCoreAncestor) {\r\n      const navigationProps = Object.entries(entityMetaData.properties)\r\n        .filter(([_name, prop]) => prop.isNavigation)\r\n        // eslint-disable-next-line @typescript-eslint/no-shadow\r\n        .map(([name, prop]) => {\r\n          assert(prop.relationshipClass);\r\n          const maybeMetaData = iModel.nativeDb.getSchemaItem(...prop.relationshipClass.split(\":\") as [string, string]);\r\n          assert(maybeMetaData.result !== undefined, \"The nav props relationship metadata was not found\");\r\n          const relMetaData = JSON.parse(maybeMetaData.result);\r\n          const rootClassMetaData = ClassRegistry.getRootEntity(iModel, relMetaData.target.constraintClasses[0]);\r\n          // root class must be in BisCore so should be loaded since biscore classes will never get this\r\n          // generated implementation\r\n          const normalizeClassName = (clsName: string) => clsName.replace(\".\", \":\");\r\n          const rootClass = ClassRegistry.findRegisteredClass(normalizeClassName(rootClassMetaData));\r\n          assert(rootClass, `The root class for ${prop.relationshipClass} was not in BisCore.`);\r\n          return { name, concreteEntityType: EntityReferences.typeFromClass(rootClass) };\r\n        });\r\n\r\n      Object.defineProperty(\r\n        generatedClass.prototype,\r\n        \"collectReferenceConcreteIds\",\r\n        {\r\n          value(this: typeof generatedClass, referenceIds: EntityReferenceSet) {\r\n            // eslint-disable-next-line @typescript-eslint/dot-notation\r\n            const superImpl = superclass.prototype[\"collectReferenceConcreteIds\"];\r\n            superImpl.call(this, referenceIds);\r\n            for (const navProp of navigationProps) {\r\n              const relatedElem: RelatedElement | undefined = (this as any)[navProp.name]; // cast to any since subclass can have any extensions\r\n              if (!relatedElem || !Id64.isValid(relatedElem.id))\r\n                continue;\r\n              const referenceId = EntityReferences.fromEntityType(relatedElem.id, navProp.concreteEntityType);\r\n              referenceIds.add(referenceId);\r\n            }\r\n          },\r\n          // defaults for methods on a prototype (required for sinon to stub out methods on tests)\r\n          writable: true,\r\n          configurable: true,\r\n        }\r\n      );\r\n    }\r\n\r\n    // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations\r\n    if (schema.missingRequiredBehavior) {\r\n      const throwError = () => {\r\n        throw new IModelError(IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`);\r\n      };\r\n\r\n      superclass.protectedOperations.forEach((operation) => (generatedClass as any)[operation] = throwError);\r\n    }\r\n\r\n    this.register(generatedClass, schema); // register it before returning\r\n    return generatedClass;\r\n  }\r\n\r\n  /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]\r\n   * @param moduleObj The module to search for subclasses of Entity\r\n   * @param schema The schema for all found classes\r\n   */\r\n  public static registerModule(moduleObj: any, schema: typeof Schema) {\r\n    for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in\r\n      const thisClass = moduleObj[thisMember];\r\n      if (thisClass.prototype instanceof Entity)\r\n        this.register(thisClass, schema);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated\r\n   * class. This function also ensures that all of the base classes of the Entity exist and are registered.\r\n   */\r\n  private static generateClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const metadata: EntityMetaData | undefined = iModel.classMetaDataRegistry.find(classFullName);\r\n    if (metadata === undefined || metadata.ecclass === undefined)\r\n      throw this.makeMetaDataNotFoundError(classFullName);\r\n\r\n    // Make sure we have all base classes registered.\r\n    if (metadata.baseClasses && (0 !== metadata.baseClasses.length))\r\n      this.getClass(metadata.baseClasses[0], iModel);\r\n\r\n    // Now we can generate the class from the classDef.\r\n    return this.generateClassForEntity(metadata, iModel);\r\n  }\r\n\r\n  /** Find a registered class by classFullName.\r\n   * @param classFullName class to find\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class or undefined\r\n   */\r\n  public static findRegisteredClass(classFullName: string): typeof Entity | undefined {\r\n    return this._classMap.get(classFullName.toLowerCase());\r\n  }\r\n\r\n  /** Get the Entity class for the specified Entity className.\r\n   * @param classFullName The full BIS class name of the Entity\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class\r\n   */\r\n  public static getClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const key = classFullName.toLowerCase();\r\n    const ctor = this._classMap.get(key);\r\n    return ctor ? ctor : this.generateClass(key, iModel);\r\n  }\r\n\r\n  /** Unregister a class, by name, if one is already registered.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.\r\n   * @param classFullName Name of the class to unregister\r\n   * @return true if the class was unregistered\r\n   * @internal\r\n   */\r\n  public static unregisterCLass(classFullName: string) { return this._classMap.delete(classFullName.toLowerCase()); }\r\n  /** Unregister all classes from a schema.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\r\n   * @param schema Name of the schema to unregister\r\n   * @internal\r\n   */\r\n  public static unregisterClassesFrom(schema: typeof Schema) {\r\n    for (const entry of Array.from(this._classMap)) {\r\n      if (entry[1].schema === schema)\r\n        this.unregisterCLass(entry[0]);\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * A cache that records the mapping between class names and class metadata\r\n * @internal\r\n */\r\nexport class MetaDataRegistry {\r\n  private _registry: Map<string, EntityMetaData> = new Map<string, EntityMetaData>();\r\n\r\n  /** Get the specified Entity metadata */\r\n  public find(classFullName: string): EntityMetaData | undefined { return this._registry.get(classFullName.toLowerCase()); }\r\n\r\n  /** Add metadata to the cache */\r\n  public add(classFullName: string, metaData: EntityMetaData): void { this._registry.set(classFullName.toLowerCase(), metaData); }\r\n}\r\n"]}