@itwin/imodel-transformer 0.0.1-dev.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright © 2017-2023 Bentley Systems, Incorporated. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,33 @@
+# @itwin/imodel-transformer
+
+Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.
+
+## Description
+
+The __@itwin/imodel-transformer__ package contains classes that handle traversing iModels for exporting and importing their parts.
+
+## Documentation
+
+See the [iTwin.js](https://www.itwinjs.org) documentation for more information.
+
+## Versioning
+
+This package, for the time being, relies on @internal APIs in iTwin.js, and therefore has very strict peerDependencies versions.
+We perform a version check at runtime to ensure this. Every new iTwin.js version must be validated, and fixes are rarely ported
+to old versions currently, you must request this in an issue. Removing Dependencies on internal APIs is ongoing.
+You can find the latest @itwin/imodel-transformer version for your iTwin.js version by copy and pasting this into a bash shell
+
+(use git bash on windows).
+
+```sh
+MY_ITWINJS_VERSION="3.6.0" # edit me
+pnpm -s --package=semver -c dlx node <<EOF
+json=""
+require("https").get("https://registry.npmjs.org/@itwin/imodel-transformer", r=>r.setEncoding("utf8").on("data", d=>json+=d).on("end", ()=>{
+  semver=require(process.env.PATH.split(":").find(x=>x.includes(".bin"))+"/../semver")
+  console.log(Object.entries(JSON.parse(json).versions)
+              .filter(([,v])=>semver.satisfies("$MY_ITWINJS_VERSION", v.peerDependencies["@itwin/core-backend"]))
+              .map(([k,v])=>k).reverse())
+}))
+EOF
+```

package/lib/cjs/ECReferenceTypesCache.d.ts

@@ -0,0 +1,37 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { ConcreteEntityTypes, RelTypeInfo } from "@itwin/core-common";
+import { IModelDb } from "@itwin/core-backend";
+/** The context for transforming a *source* Element to a *target* Element and remapping internal identifiers to the target iModel.
+ * @internal
+ */
+export declare class SchemaNotInCacheErr extends Error {
+    constructor();
+}
+/**
+ * A cache of the entity types referenced by navprops in ecchemas, as well as the source and target entity types of
+ * The transformer needs the referenced type to determine how to resolve references.
+ *
+ * Using multiple of these usually performs redundant computation, for static schemas at least. A possible future optimization
+ * would be to seed the computation from a global cache of non-dynamic schemas, but dynamic schemas can collide willy-nilly
+ * @internal
+ */
+export declare class ECReferenceTypesCache {
+    /** nesting based tuple map keyed by qualified property path tuple [schemaName, className, propName] */
+    private _propQualifierToRefType;
+    private _relClassNameEndToRefTypes;
+    private _initedSchemas;
+    private static bisRootClassToRefType;
+    private getRootBisClass;
+    private getAbstractConstraintClass;
+    /** initialize from an imodel with metadata */
+    initAllSchemasInIModel(imodel: IModelDb): Promise<void>;
+    private considerInitSchema;
+    private initSchema;
+    private relInfoFromRelClass;
+    getNavPropRefType(schemaName: string, className: string, propName: string): undefined | ConcreteEntityTypes;
+    getRelationshipEndType(schemaName: string, className: string): undefined | RelTypeInfo;
+    clear(): void;
+}
+//# sourceMappingURL=ECReferenceTypesCache.d.ts.map

package/lib/cjs/ECReferenceTypesCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ECReferenceTypesCache.d.ts","sourceRoot":"","sources":["../../src/ECReferenceTypesCache.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,mBAAmB,EAAe,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGnF,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,KAAK;;CAE7C;AAED;;;;;;;GAOG;AACH,qBAAa,qBAAqB;IAChC,uGAAuG;IACvG,OAAO,CAAC,uBAAuB,CAAsE;IACrG,OAAO,CAAC,0BAA0B,CAAsD;IACxF,OAAO,CAAC,cAAc,CAAgC;IAEtD,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAUlC;YAEY,eAAe;YAsBf,0BAA0B;IAOxC,8CAA8C;IACjC,sBAAsB,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;YA2BtD,kBAAkB;YAYlB,UAAU;YAuBV,mBAAmB;IAwB1B,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,mBAAmB;IAU3G,sBAAsB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,WAAW;IAStF,KAAK;CAIb"}

package/lib/cjs/ECReferenceTypesCache.js

@@ -0,0 +1,180 @@
+"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 iModels
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ECReferenceTypesCache = exports.SchemaNotInCacheErr = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const assert = require("assert");
+/** The context for transforming a *source* Element to a *target* Element and remapping internal identifiers to the target iModel.
+ * @internal
+ */
+class SchemaNotInCacheErr extends Error {
+    constructor() { super("Schema was not in cache, initialize that schema"); }
+}
+exports.SchemaNotInCacheErr = SchemaNotInCacheErr;
+/**
+ * A cache of the entity types referenced by navprops in ecchemas, as well as the source and target entity types of
+ * The transformer needs the referenced type to determine how to resolve references.
+ *
+ * Using multiple of these usually performs redundant computation, for static schemas at least. A possible future optimization
+ * would be to seed the computation from a global cache of non-dynamic schemas, but dynamic schemas can collide willy-nilly
+ * @internal
+ */
+class ECReferenceTypesCache {
+    constructor() {
+        /** nesting based tuple map keyed by qualified property path tuple [schemaName, className, propName] */
+        this._propQualifierToRefType = new core_bentley_1.TupleKeyedMap();
+        this._relClassNameEndToRefTypes = new core_bentley_1.TupleKeyedMap();
+        this._initedSchemas = new Map();
+    }
+    async getRootBisClass(ecclass) {
+        let bisRootForConstraint = ecclass;
+        await ecclass.traverseBaseClasses((baseClass) => {
+            var _a;
+            // The depth first traversal will descend all the way to the root class before making any lateral traversal
+            // of mixin hierarchies, (or if the constraint is a mixin, it will traverse to the root of the mixin hierarchy)
+            // Once we see that we've moved laterally, we can terminate early
+            const isFirstTest = bisRootForConstraint === ecclass;
+            const traversalSwitchedRootPath = baseClass.name !== ((_a = bisRootForConstraint.baseClass) === null || _a === void 0 ? void 0 : _a.name);
+            const stillTraversingRootPath = isFirstTest || !traversalSwitchedRootPath;
+            if (!stillTraversingRootPath)
+                return true; // stop traversal early
+            bisRootForConstraint = baseClass;
+            return false;
+        });
+        // if the root class of the constraint was a mixin, use its AppliesToEntityClass
+        if (bisRootForConstraint instanceof ecschema_metadata_1.Mixin) {
+            assert(bisRootForConstraint.appliesTo !== undefined, "The referenced AppliesToEntityClass could not be found, how did it pass schema validation?");
+            bisRootForConstraint = await this.getRootBisClass(await bisRootForConstraint.appliesTo);
+        }
+        return bisRootForConstraint;
+    }
+    async getAbstractConstraintClass(constraint) {
+        var _a;
+        // constraint classes must share a base so we can get the root from any of them, just use the first
+        const ecclass = await (((_a = constraint.constraintClasses) === null || _a === void 0 ? void 0 : _a[0]) || constraint.abstractConstraint);
+        assert(ecclass !== undefined, "At least one constraint class or an abstract constraint must have been defined, the constraint is not valid");
+        return ecclass;
+    }
+    /** initialize from an imodel with metadata */
+    async initAllSchemasInIModel(imodel) {
+        const schemaLoader = new ecschema_metadata_1.SchemaLoader((name) => imodel.getSchemaProps(name));
+        await imodel.withPreparedStatement(`
+      WITH RECURSIVE refs(SchemaId) AS (
+        SELECT ECInstanceId FROM ECDbMeta.ECSchemaDef WHERE Name='BisCore'
+        UNION ALL
+        SELECT sr.SourceECInstanceId
+        FROM ECDbMeta.SchemaHasSchemaReferences sr
+        JOIN refs ON sr.TargetECInstanceId = refs.SchemaId
+      )
+      SELECT s.Name
+      FROM refs
+      JOIN ECDbMeta.ECSchemaDef s ON refs.SchemaId=s.ECInstanceId
+      -- ensure schema dependency order
+      ORDER BY ECInstanceId
+    `, async (stmt) => {
+            let status;
+            while ((status = stmt.step()) === core_bentley_1.DbResult.BE_SQLITE_ROW) {
+                const schemaName = stmt.getValue(0).getString();
+                const schema = schemaLoader.getSchema(schemaName);
+                await this.considerInitSchema(schema);
+            }
+            if (status !== core_bentley_1.DbResult.BE_SQLITE_DONE)
+                throw new core_common_1.IModelError(status, "unexpected query failure");
+        });
+    }
+    async considerInitSchema(schema) {
+        if (this._initedSchemas.has(schema.name)) {
+            const cachedSchemaKey = this._initedSchemas.get(schema.name);
+            assert(cachedSchemaKey !== undefined);
+            const incomingSchemaIsEqualOrOlder = schema.schemaKey.compareByVersion(cachedSchemaKey) <= 0;
+            if (incomingSchemaIsEqualOrOlder) {
+                return;
+            }
+        }
+        return this.initSchema(schema);
+    }
+    async initSchema(schema) {
+        for (const ecclass of schema.getClasses()) {
+            for (const prop of await ecclass.getProperties()) {
+                if (!prop.isNavigation())
+                    continue;
+                const relClass = await prop.relationshipClass;
+                const relInfo = await this.relInfoFromRelClass(relClass);
+                if (relInfo === undefined)
+                    continue;
+                const navPropRefType = prop.direction === ecschema_metadata_1.StrengthDirection.Forward ? relInfo.target : relInfo.source;
+                this._propQualifierToRefType.set([schema.name.toLowerCase(), ecclass.name.toLowerCase(), prop.name.toLowerCase()], navPropRefType);
+            }
+            if (ecclass instanceof ecschema_metadata_1.RelationshipClass) {
+                const relInfo = await this.relInfoFromRelClass(ecclass);
+                if (relInfo)
+                    this._relClassNameEndToRefTypes.set([schema.name.toLowerCase(), ecclass.name.toLowerCase()], relInfo);
+            }
+        }
+        this._initedSchemas.set(schema.name, schema.schemaKey);
+    }
+    async relInfoFromRelClass(ecclass) {
+        assert(ecclass.source.constraintClasses !== undefined);
+        assert(ecclass.target.constraintClasses !== undefined);
+        const [[sourceClass, sourceRootBisClass], [targetClass, targetRootBisClass]] = await Promise.all([
+            this.getAbstractConstraintClass(ecclass.source)
+                .then(async (constraintClass) => [constraintClass, await this.getRootBisClass(constraintClass)]),
+            this.getAbstractConstraintClass(ecclass.target)
+                .then(async (constraintClass) => [constraintClass, await this.getRootBisClass(constraintClass)]),
+        ]);
+        if (sourceRootBisClass.name === "CodeSpec" || targetRootBisClass.name === "CodeSpec")
+            return undefined;
+        const sourceType = ECReferenceTypesCache.bisRootClassToRefType[sourceRootBisClass.name];
+        const targetType = ECReferenceTypesCache.bisRootClassToRefType[targetRootBisClass.name];
+        const makeAssertMsg = (root, cls) => [
+            `An unknown root class '${root.fullName}' was encountered while populating`,
+            `the nav prop reference type cache for ${cls.fullName}.`,
+            "This is a bug.",
+        ].join("\n");
+        assert(sourceType !== undefined, makeAssertMsg(sourceRootBisClass, sourceClass));
+        assert(targetType !== undefined, makeAssertMsg(targetRootBisClass, targetClass));
+        return { source: sourceType, target: targetType };
+    }
+    getNavPropRefType(schemaName, className, propName) {
+        if (!this._initedSchemas.has(schemaName))
+            throw new SchemaNotInCacheErr();
+        return this._propQualifierToRefType.get([
+            schemaName.toLowerCase(),
+            className.toLowerCase(),
+            propName.toLowerCase(),
+        ]);
+    }
+    getRelationshipEndType(schemaName, className) {
+        if (!this._initedSchemas.has(schemaName))
+            throw new SchemaNotInCacheErr();
+        return this._relClassNameEndToRefTypes.get([
+            schemaName.toLowerCase(),
+            className.toLowerCase(),
+        ]);
+    }
+    clear() {
+        this._initedSchemas.clear();
+        this._propQualifierToRefType.clear();
+    }
+}
+exports.ECReferenceTypesCache = ECReferenceTypesCache;
+ECReferenceTypesCache.bisRootClassToRefType = {
+    /* eslint-disable quote-props, @typescript-eslint/naming-convention */
+    "Element": core_common_1.ConcreteEntityTypes.Element,
+    "Model": core_common_1.ConcreteEntityTypes.Model,
+    "ElementAspect": core_common_1.ConcreteEntityTypes.ElementAspect,
+    "ElementRefersToElements": core_common_1.ConcreteEntityTypes.Relationship,
+    "ElementDrivesElement": core_common_1.ConcreteEntityTypes.Relationship,
+    // code spec is technically a potential root class but it is ignored currently
+    // see [ConcreteEntityTypes]($common)
+    /* eslint-enable quote-props, @typescript-eslint/naming-convention */
+};
+//# sourceMappingURL=ECReferenceTypesCache.js.map

package/lib/cjs/ECReferenceTypesCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ECReferenceTypesCache.js","sourceRoot":"","sources":["../../src/ECReferenceTypesCache.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA8D;AAC9D,oDAAmF;AACnF,gEAAyJ;AACzJ,iCAAiC;AAGjC;;GAEG;AACH,MAAa,mBAAoB,SAAQ,KAAK;IAC5C,gBAAuB,KAAK,CAAC,iDAAiD,CAAC,CAAC,CAAC,CAAC;CACnF;AAFD,kDAEC;AAED;;;;;;;GAOG;AACH,MAAa,qBAAqB;IAAlC;QACE,uGAAuG;QAC/F,4BAAuB,GAAG,IAAI,4BAAa,EAAiD,CAAC;QAC7F,+BAA0B,GAAG,IAAI,4BAAa,EAAiC,CAAC;QAChF,mBAAc,GAAG,IAAI,GAAG,EAAqB,CAAC;IAyJxD,CAAC;IA3IS,KAAK,CAAC,eAAe,CAAC,OAAgB;QAC5C,IAAI,oBAAoB,GAAY,OAAO,CAAC;QAC5C,MAAM,OAAO,CAAC,mBAAmB,CAAC,CAAC,SAAS,EAAE,EAAE;;YAC9C,2GAA2G;YAC3G,+GAA+G;YAC/G,iEAAiE;YACjE,MAAM,WAAW,GAAG,oBAAoB,KAAK,OAAO,CAAC;YACrD,MAAM,yBAAyB,GAAG,SAAS,CAAC,IAAI,MAAK,MAAA,oBAAoB,CAAC,SAAS,0CAAE,IAAI,CAAA,CAAC;YAC1F,MAAM,uBAAuB,GAAG,WAAW,IAAI,CAAC,yBAAyB,CAAC;YAC1E,IAAI,CAAC,uBAAuB;gBAC1B,OAAO,IAAI,CAAC,CAAC,uBAAuB;YACtC,oBAAoB,GAAG,SAAS,CAAC;YACjC,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;QACH,gFAAgF;QAChF,IAAI,oBAAoB,YAAY,yBAAK,EAAE;YACzC,MAAM,CAAC,oBAAoB,CAAC,SAAS,KAAK,SAAS,EAAE,4FAA4F,CAAC,CAAC;YACnJ,oBAAoB,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,oBAAoB,CAAC,SAAS,CAAC,CAAC;SACzF;QACD,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAEO,KAAK,CAAC,0BAA0B,CAAC,UAAkC;;QACzE,mGAAmG;QACnG,MAAM,OAAO,GAAG,MAAM,CAAC,CAAA,MAAA,UAAU,CAAC,iBAAiB,0CAAG,CAAC,CAAC,KAAI,UAAU,CAAC,kBAAkB,CAAC,CAAC;QAC3F,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,6GAA6G,CAAC,CAAC;QAC7I,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,8CAA8C;IACvC,KAAK,CAAC,sBAAsB,CAAC,MAAgB;QAClD,MAAM,YAAY,GAAG,IAAI,gCAAY,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QACrF,MAAM,MAAM,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;KAalC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAChB,IAAI,MAAgB,CAAC;YACrB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,uBAAQ,CAAC,aAAa,EAAE;gBACxD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;gBAChD,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;gBAClD,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;aACvC;YACD,IAAI,MAAM,KAAK,uBAAQ,CAAC,cAAc;gBACpC,MAAM,IAAI,yBAAW,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,MAAc;QAC7C,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YACxC,MAAM,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC7D,MAAM,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC;YACtC,MAAM,4BAA4B,GAAG,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;YAC7F,IAAI,4BAA4B,EAAE;gBAChC,OAAO;aACR;SACF;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,MAAc;QACrC,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,UAAU,EAAE,EAAE;YACzC,KAAK,MAAM,IAAI,IAAI,MAAM,OAAO,CAAC,aAAa,EAAE,EAAE;gBAChD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;oBACtB,SAAS;gBACX,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC;gBAC9C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;gBACzD,IAAI,OAAO,KAAK,SAAS;oBACvB,SAAS;gBACX,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,KAAK,qCAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;gBACtG,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC;aACpI;YAED,IAAI,OAAO,YAAY,qCAAiB,EAAE;gBACxC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;gBACxD,IAAI,OAAO;oBACT,IAAI,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;aACzG;SACF;QAED,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAAC,OAA0B;QAC1D,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC;QACvD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC;QACvD,MAAM,CAAC,CAAC,WAAW,EAAE,kBAAkB,CAAC,EAAE,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC/F,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,MAAM,CAAC;iBAC5C,IAAI,CAAC,KAAK,EAAE,eAAe,EAAE,EAAE,CAAC,CAAC,eAAe,EAAE,MAAM,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC,CAAC;YAClG,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,MAAM,CAAC;iBAC5C,IAAI,CAAC,KAAK,EAAE,eAAe,EAAE,EAAE,CAAC,CAAC,eAAe,EAAE,MAAM,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC,CAAC;SACnG,CAAC,CAAC;QAEH,IAAI,kBAAkB,CAAC,IAAI,KAAK,UAAU,IAAI,kBAAkB,CAAC,IAAI,KAAK,UAAU;YAClF,OAAO,SAAS,CAAC;QACnB,MAAM,UAAU,GAAG,qBAAqB,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACxF,MAAM,UAAU,GAAG,qBAAqB,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACxF,MAAM,aAAa,GAAG,CAAC,IAAa,EAAE,GAAY,EAAE,EAAE,CAAC;YACrD,0BAA0B,IAAI,CAAC,QAAQ,oCAAoC;YAC3E,yCAAyC,GAAG,CAAC,QAAQ,GAAG;YACxD,gBAAgB;SACjB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACb,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE,aAAa,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC,CAAC;QACjF,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE,aAAa,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC,CAAC;QACjF,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;IACpD,CAAC;IAEM,iBAAiB,CAAC,UAAkB,EAAE,SAAiB,EAAE,QAAgB;QAC9E,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC;YACtC,MAAM,IAAI,mBAAmB,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC;YACtC,UAAU,CAAC,WAAW,EAAE;YACxB,SAAS,CAAC,WAAW,EAAE;YACvB,QAAQ,CAAC,WAAW,EAAE;SACvB,CAAC,CAAC;IACL,CAAC;IAEM,sBAAsB,CAAC,UAAkB,EAAE,SAAiB;QACjE,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC;YACtC,MAAM,IAAI,mBAAmB,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC,0BAA0B,CAAC,GAAG,CAAC;YACzC,UAAU,CAAC,WAAW,EAAE;YACxB,SAAS,CAAC,WAAW,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAC5B,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,CAAC;IACvC,CAAC;;AA5JH,sDA6JC;AAvJgB,2CAAqB,GAAoD;IACtF,sEAAsE;IACtE,SAAS,EAAE,iCAAmB,CAAC,OAAO;IACtC,OAAO,EAAE,iCAAmB,CAAC,KAAK;IAClC,eAAe,EAAE,iCAAmB,CAAC,aAAa;IAClD,yBAAyB,EAAE,iCAAmB,CAAC,YAAY;IAC3D,sBAAsB,EAAE,iCAAmB,CAAC,YAAY;IACxD,8EAA8E;IAC9E,qCAAqC;IACrC,qEAAqE;CACtE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { DbResult, TupleKeyedMap } from \"@itwin/core-bentley\";\nimport { ConcreteEntityTypes, IModelError, RelTypeInfo } from \"@itwin/core-common\";\nimport { ECClass, Mixin, RelationshipClass, RelationshipConstraint, Schema, SchemaKey, SchemaLoader, StrengthDirection } from \"@itwin/ecschema-metadata\";\nimport * as assert from \"assert\";\nimport { IModelDb } from \"@itwin/core-backend\";\n\n/** The context for transforming a *source* Element to a *target* Element and remapping internal identifiers to the target iModel.\n * @internal\n */\nexport class SchemaNotInCacheErr extends Error {\n  public constructor() { super(\"Schema was not in cache, initialize that schema\"); }\n}\n\n/**\n * A cache of the entity types referenced by navprops in ecchemas, as well as the source and target entity types of\n * The transformer needs the referenced type to determine how to resolve references.\n *\n * Using multiple of these usually performs redundant computation, for static schemas at least. A possible future optimization\n * would be to seed the computation from a global cache of non-dynamic schemas, but dynamic schemas can collide willy-nilly\n * @internal\n */\nexport class ECReferenceTypesCache {\n  /** nesting based tuple map keyed by qualified property path tuple [schemaName, className, propName] */\n  private _propQualifierToRefType = new TupleKeyedMap<[string, string, string], ConcreteEntityTypes>();\n  private _relClassNameEndToRefTypes = new TupleKeyedMap<[string, string], RelTypeInfo>();\n  private _initedSchemas = new Map<string, SchemaKey>();\n\n  private static bisRootClassToRefType: Record<string, ConcreteEntityTypes | undefined> = {\n    /* eslint-disable quote-props, @typescript-eslint/naming-convention */\n    \"Element\": ConcreteEntityTypes.Element,\n    \"Model\": ConcreteEntityTypes.Model,\n    \"ElementAspect\": ConcreteEntityTypes.ElementAspect,\n    \"ElementRefersToElements\": ConcreteEntityTypes.Relationship,\n    \"ElementDrivesElement\": ConcreteEntityTypes.Relationship,\n    // code spec is technically a potential root class but it is ignored currently\n    // see [ConcreteEntityTypes]($common)\n    /* eslint-enable quote-props, @typescript-eslint/naming-convention */\n  };\n\n  private async getRootBisClass(ecclass: ECClass) {\n    let bisRootForConstraint: ECClass = ecclass;\n    await ecclass.traverseBaseClasses((baseClass) => {\n      // The depth first traversal will descend all the way to the root class before making any lateral traversal\n      // of mixin hierarchies, (or if the constraint is a mixin, it will traverse to the root of the mixin hierarchy)\n      // Once we see that we've moved laterally, we can terminate early\n      const isFirstTest = bisRootForConstraint === ecclass;\n      const traversalSwitchedRootPath = baseClass.name !== bisRootForConstraint.baseClass?.name;\n      const stillTraversingRootPath = isFirstTest || !traversalSwitchedRootPath;\n      if (!stillTraversingRootPath)\n        return true; // stop traversal early\n      bisRootForConstraint = baseClass;\n      return false;\n    });\n    // if the root class of the constraint was a mixin, use its AppliesToEntityClass\n    if (bisRootForConstraint instanceof Mixin) {\n      assert(bisRootForConstraint.appliesTo !== undefined, \"The referenced AppliesToEntityClass could not be found, how did it pass schema validation?\");\n      bisRootForConstraint = await this.getRootBisClass(await bisRootForConstraint.appliesTo);\n    }\n    return bisRootForConstraint;\n  }\n\n  private async getAbstractConstraintClass(constraint: RelationshipConstraint): Promise<ECClass> {\n    // constraint classes must share a base so we can get the root from any of them, just use the first\n    const ecclass = await (constraint.constraintClasses?.[0] || constraint.abstractConstraint);\n    assert(ecclass !== undefined, \"At least one constraint class or an abstract constraint must have been defined, the constraint is not valid\");\n    return ecclass;\n  }\n\n  /** initialize from an imodel with metadata */\n  public async initAllSchemasInIModel(imodel: IModelDb): Promise<void> {\n    const schemaLoader = new SchemaLoader((name: string) => imodel.getSchemaProps(name));\n    await imodel.withPreparedStatement(`\n      WITH RECURSIVE refs(SchemaId) AS (\n        SELECT ECInstanceId FROM ECDbMeta.ECSchemaDef WHERE Name='BisCore'\n        UNION ALL\n        SELECT sr.SourceECInstanceId\n        FROM ECDbMeta.SchemaHasSchemaReferences sr\n        JOIN refs ON sr.TargetECInstanceId = refs.SchemaId\n      )\n      SELECT s.Name\n      FROM refs\n      JOIN ECDbMeta.ECSchemaDef s ON refs.SchemaId=s.ECInstanceId\n      -- ensure schema dependency order\n      ORDER BY ECInstanceId\n    `, async (stmt) => {\n      let status: DbResult;\n      while ((status = stmt.step()) === DbResult.BE_SQLITE_ROW) {\n        const schemaName = stmt.getValue(0).getString();\n        const schema = schemaLoader.getSchema(schemaName);\n        await this.considerInitSchema(schema);\n      }\n      if (status !== DbResult.BE_SQLITE_DONE)\n        throw new IModelError(status, \"unexpected query failure\");\n    });\n  }\n\n  private async considerInitSchema(schema: Schema): Promise<void> {\n    if (this._initedSchemas.has(schema.name)) {\n      const cachedSchemaKey = this._initedSchemas.get(schema.name);\n      assert(cachedSchemaKey !== undefined);\n      const incomingSchemaIsEqualOrOlder = schema.schemaKey.compareByVersion(cachedSchemaKey) <= 0;\n      if (incomingSchemaIsEqualOrOlder) {\n        return;\n      }\n    }\n    return this.initSchema(schema);\n  }\n\n  private async initSchema(schema: Schema): Promise<void> {\n    for (const ecclass of schema.getClasses()) {\n      for (const prop of await ecclass.getProperties()) {\n        if (!prop.isNavigation())\n          continue;\n        const relClass = await prop.relationshipClass;\n        const relInfo = await this.relInfoFromRelClass(relClass);\n        if (relInfo === undefined)\n          continue;\n        const navPropRefType = prop.direction === StrengthDirection.Forward ? relInfo.target : relInfo.source;\n        this._propQualifierToRefType.set([schema.name.toLowerCase(), ecclass.name.toLowerCase(), prop.name.toLowerCase()], navPropRefType);\n      }\n\n      if (ecclass instanceof RelationshipClass) {\n        const relInfo = await this.relInfoFromRelClass(ecclass);\n        if (relInfo)\n          this._relClassNameEndToRefTypes.set([schema.name.toLowerCase(), ecclass.name.toLowerCase()], relInfo);\n      }\n    }\n\n    this._initedSchemas.set(schema.name, schema.schemaKey);\n  }\n\n  private async relInfoFromRelClass(ecclass: RelationshipClass): Promise<RelTypeInfo | undefined> {\n    assert(ecclass.source.constraintClasses !== undefined);\n    assert(ecclass.target.constraintClasses !== undefined);\n    const [[sourceClass, sourceRootBisClass], [targetClass, targetRootBisClass]] = await Promise.all([\n      this.getAbstractConstraintClass(ecclass.source)\n        .then(async (constraintClass) => [constraintClass, await this.getRootBisClass(constraintClass)]),\n      this.getAbstractConstraintClass(ecclass.target)\n        .then(async (constraintClass) => [constraintClass, await this.getRootBisClass(constraintClass)]),\n    ]);\n\n    if (sourceRootBisClass.name === \"CodeSpec\" || targetRootBisClass.name === \"CodeSpec\")\n      return undefined;\n    const sourceType = ECReferenceTypesCache.bisRootClassToRefType[sourceRootBisClass.name];\n    const targetType = ECReferenceTypesCache.bisRootClassToRefType[targetRootBisClass.name];\n    const makeAssertMsg = (root: ECClass, cls: ECClass) => [\n      `An unknown root class '${root.fullName}' was encountered while populating`,\n      `the nav prop reference type cache for ${cls.fullName}.`,\n      \"This is a bug.\",\n    ].join(\"\\n\");\n    assert(sourceType !== undefined, makeAssertMsg(sourceRootBisClass, sourceClass));\n    assert(targetType !== undefined, makeAssertMsg(targetRootBisClass, targetClass));\n    return { source: sourceType, target: targetType };\n  }\n\n  public getNavPropRefType(schemaName: string, className: string, propName: string): undefined | ConcreteEntityTypes {\n    if (!this._initedSchemas.has(schemaName))\n      throw new SchemaNotInCacheErr();\n    return this._propQualifierToRefType.get([\n      schemaName.toLowerCase(),\n      className.toLowerCase(),\n      propName.toLowerCase(),\n    ]);\n  }\n\n  public getRelationshipEndType(schemaName: string, className: string): undefined | RelTypeInfo {\n    if (!this._initedSchemas.has(schemaName))\n      throw new SchemaNotInCacheErr();\n    return this._relClassNameEndToRefTypes.get([\n      schemaName.toLowerCase(),\n      className.toLowerCase(),\n    ]);\n  }\n\n  public clear() {\n    this._initedSchemas.clear();\n    this._propQualifierToRefType.clear();\n  }\n}\n"]}

package/lib/cjs/EntityMap.d.ts

@@ -0,0 +1,26 @@
+/** @packageDocumentation
+ * @module Utils
+ */
+import { EntityReference } from "@itwin/core-common";
+import { ConcreteEntity } from "@itwin/core-backend";
+/** @internal */
+export declare type EntityKey = EntityReference;
+/** @internal */
+export declare class EntityMap<V> {
+    private _map;
+    static makeKey(entity: ConcreteEntity): EntityKey;
+    clear(): void;
+    has(entity: ConcreteEntity): boolean;
+    set(entity: ConcreteEntity, val: V): EntityMap<V>;
+    setByKey(k: EntityKey, val: V): EntityMap<V>;
+    get(entity: ConcreteEntity): V | undefined;
+    getByKey(k: EntityKey): V | undefined;
+    delete(entity: ConcreteEntity): boolean;
+    deleteByKey(k: EntityKey): boolean;
+    keys(): IterableIterator<`m${string}` | `e${string}` | `a${string}` | `r${string}`>;
+    values(): IterableIterator<V>;
+    entries(): IterableIterator<[`m${string}` | `e${string}` | `a${string}` | `r${string}`, V]>;
+    [Symbol.iterator](): IterableIterator<[`m${string}` | `e${string}` | `a${string}` | `r${string}`, V]>;
+    get size(): number;
+}
+//# sourceMappingURL=EntityMap.d.ts.map

package/lib/cjs/EntityMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityMap.d.ts","sourceRoot":"","sources":["../../src/EntityMap.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAoB,MAAM,qBAAqB,CAAC;AAEvE,gBAAgB;AAChB,oBAAY,SAAS,GAAG,eAAe,CAAC;AAExC,gBAAgB;AAChB,qBAAa,SAAS,CAAC,CAAC;IACtB,OAAO,CAAC,IAAI,CAA2B;WAEzB,OAAO,CAAC,MAAM,EAAE,cAAc,GAAG,SAAS;IAIjD,KAAK,IAAI,IAAI;IAIb,GAAG,CAAC,MAAM,EAAE,cAAc;IAK1B,GAAG,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAIjD,QAAQ,CAAC,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAK5C,GAAG,CAAC,MAAM,EAAE,cAAc,GAAG,CAAC,GAAG,SAAS;IAI1C,QAAQ,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,GAAG,SAAS;IAIrC,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO;IAIvC,WAAW,CAAC,CAAC,EAAE,SAAS,GAAG,OAAO;IAIlC,IAAI;IAIJ,MAAM;IAIN,OAAO;IAIP,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIxB,IAAW,IAAI,WAEd;CACF"}

package/lib/cjs/EntityMap.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityMap = void 0;
+const core_backend_1 = require("@itwin/core-backend");
+/** @internal */
+class EntityMap {
+    constructor() {
+        this._map = new Map();
+    }
+    static makeKey(entity) {
+        return core_backend_1.EntityReferences.from(entity);
+    }
+    clear() {
+        return this._map.clear();
+    }
+    has(entity) {
+        return this._map.has(EntityMap.makeKey(entity));
+    }
+    set(entity, val) {
+        return this.setByKey(EntityMap.makeKey(entity), val);
+    }
+    setByKey(k, val) {
+        this._map.set(k, val);
+        return this;
+    }
+    get(entity) {
+        return this.getByKey(EntityMap.makeKey(entity));
+    }
+    getByKey(k) {
+        return this._map.get(k);
+    }
+    delete(entity) {
+        return this.deleteByKey(EntityMap.makeKey(entity));
+    }
+    deleteByKey(k) {
+        return this._map.delete(k);
+    }
+    keys() {
+        return this._map.keys();
+    }
+    values() {
+        return this._map.values();
+    }
+    entries() {
+        return this._map.entries();
+    }
+    [Symbol.iterator]() {
+        return this._map[Symbol.iterator]();
+    }
+    get size() {
+        return this._map.size;
+    }
+}
+exports.EntityMap = EntityMap;
+//# sourceMappingURL=EntityMap.js.map

package/lib/cjs/EntityMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityMap.js","sourceRoot":"","sources":["../../src/EntityMap.ts"],"names":[],"mappings":";;;AAQA,sDAAuE;AAKvE,gBAAgB;AAChB,MAAa,SAAS;IAAtB;QACU,SAAI,GAAG,IAAI,GAAG,EAAgB,CAAC;IA2DzC,CAAC;IAzDQ,MAAM,CAAC,OAAO,CAAC,MAAsB;QAC1C,OAAO,+BAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAEM,KAAK;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;IAEM,GAAG,CAAC,MAAsB;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAC7C,CAAC;IACJ,CAAC;IAEM,GAAG,CAAC,MAAsB,EAAE,GAAM;QACvC,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC;IACvD,CAAC;IAEM,QAAQ,CAAC,CAAY,EAAE,GAAM;QAClC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,GAAG,CAAC,MAAsB;QAC/B,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAClD,CAAC;IAEM,QAAQ,CAAC,CAAY;QAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC1B,CAAC;IAEM,MAAM,CAAC,MAAsB;QAClC,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IACrD,CAAC;IAEM,WAAW,CAAC,CAAY;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IAEM,IAAI;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;IAC5B,CAAC;IAEM,OAAO;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IACtC,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACxB,CAAC;CACF;AA5DD,8BA4DC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Utils\n */\nimport { EntityReference } from \"@itwin/core-common\";\nimport { ConcreteEntity, EntityReferences } from \"@itwin/core-backend\";\n\n/** @internal */\nexport type EntityKey = EntityReference;\n\n/** @internal */\nexport class EntityMap<V> {\n  private _map = new Map<EntityKey, V>();\n\n  public static makeKey(entity: ConcreteEntity): EntityKey {\n    return EntityReferences.from(entity);\n  }\n\n  public clear(): void {\n    return this._map.clear();\n  }\n\n  public has(entity: ConcreteEntity) {\n    return this._map.has(EntityMap.makeKey(entity)\n    );\n  }\n\n  public set(entity: ConcreteEntity, val: V): EntityMap<V> {\n    return this.setByKey(EntityMap.makeKey(entity), val);\n  }\n\n  public setByKey(k: EntityKey, val: V): EntityMap<V> {\n    this._map.set(k, val);\n    return this;\n  }\n\n  public get(entity: ConcreteEntity): V | undefined {\n    return this.getByKey(EntityMap.makeKey(entity));\n  }\n\n  public getByKey(k: EntityKey): V | undefined {\n    return this._map.get(k);\n  }\n\n  public delete(entity: ConcreteEntity): boolean {\n    return this.deleteByKey(EntityMap.makeKey(entity));\n  }\n\n  public deleteByKey(k: EntityKey): boolean {\n    return this._map.delete(k);\n  }\n\n  public keys() {\n    return this._map.keys();\n  }\n\n  public values() {\n    return this._map.values();\n  }\n\n  public entries() {\n    return this._map.entries();\n  }\n\n  public [Symbol.iterator]() {\n    return this._map[Symbol.iterator]();\n  }\n\n  public get size() {\n    return this._map.size;\n  }\n}\n\n"]}

package/lib/cjs/EntityUnifier.d.ts

@@ -0,0 +1,16 @@
+import { EntityReference } from "@itwin/core-common";
+import { ConcreteEntity, ConcreteEntityProps, IModelDb } from "@itwin/core-backend";
+/** @internal */
+export declare namespace EntityUnifier {
+    export function getReadableType(entity: ConcreteEntity): "element" | "element aspect" | "relationship" | "unknown entity type";
+    type EntityUpdater = (entityProps: ConcreteEntityProps) => void;
+    /** needs to return a widened type otherwise typescript complains when result is used with a narrow type */
+    export function updaterFor(db: IModelDb, entity: ConcreteEntity): EntityUpdater;
+    export function exists(db: IModelDb, arg: {
+        entity: ConcreteEntity;
+    } | {
+        entityReference: EntityReference;
+    }): boolean;
+    export {};
+}
+//# sourceMappingURL=EntityUnifier.d.ts.map

package/lib/cjs/EntityUnifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityUnifier.d.ts","sourceRoot":"","sources":["../../src/EntityUnifier.ts"],"names":[],"mappings":"AAUA,OAAO,EAAkC,eAAe,EAAe,MAAM,oBAAoB,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAA4C,QAAQ,EAAgB,MAAM,qBAAqB,CAAC;AAE5I,gBAAgB;AAChB,yBAAiB,aAAa,CAAC;IAC7B,MAAM,UAAU,eAAe,CAAC,MAAM,EAAE,cAAc,yEASrD;IAED,KAAK,aAAa,GAAG,CAAC,WAAW,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAEhE,2GAA2G;IAC3G,MAAM,UAAU,UAAU,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,iBAS9D;IAED,MAAM,UAAU,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE;QAAE,MAAM,EAAE,cAAc,CAAA;KAAE,GAAG;QAAE,eAAe,EAAE,eAAe,CAAA;KAAE,WA0B1G;;CACF"}

package/lib/cjs/EntityUnifier.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityUnifier = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utils
+ * utilities that unify operations, especially CRUD operations, on entities
+ * for entity-generic operations in the transformer
+ */
+const assert = require("assert");
+const core_common_1 = require("@itwin/core-common");
+const core_backend_1 = require("@itwin/core-backend");
+/** @internal */
+var EntityUnifier;
+(function (EntityUnifier) {
+    function getReadableType(entity) {
+        if (entity instanceof core_backend_1.Element)
+            return "element";
+        else if (entity instanceof core_backend_1.ElementAspect)
+            return "element aspect";
+        else if (entity instanceof core_backend_1.Relationship)
+            return "relationship";
+        else
+            return "unknown entity type";
+    }
+    EntityUnifier.getReadableType = getReadableType;
+    /** needs to return a widened type otherwise typescript complains when result is used with a narrow type */
+    function updaterFor(db, entity) {
+        if (entity instanceof core_backend_1.Element)
+            return db.elements.updateElement.bind(db.elements);
+        else if (entity instanceof core_backend_1.Relationship)
+            return db.relationships.updateInstance.bind(db.relationships);
+        else if (entity instanceof core_backend_1.ElementAspect)
+            return db.elements.updateAspect.bind(db.elements);
+        else
+            assert(false, `unreachable; entity was '${entity.constructor.name}' not an Element, Relationship, or ElementAspect`);
+    }
+    EntityUnifier.updaterFor = updaterFor;
+    function exists(db, arg) {
+        if ("entityReference" in arg) {
+            const [type, id] = core_backend_1.EntityReferences.split(arg.entityReference);
+            const bisCoreRootClassName = core_common_1.ConcreteEntityTypes.toBisCoreRootClassFullName(type);
+            return db.withPreparedStatement(`SELECT 1 FROM ${bisCoreRootClassName} WHERE ECInstanceId=?`, (stmt) => {
+                stmt.bindId(1, id);
+                const matchesResult = stmt.step();
+                if (matchesResult === core_common_1.DbResult.BE_SQLITE_ROW)
+                    return true;
+                if (matchesResult === core_common_1.DbResult.BE_SQLITE_DONE)
+                    return false;
+                else
+                    throw new core_common_1.IModelError(matchesResult, "query failed");
+            });
+        }
+        else {
+            return db.withPreparedStatement(`SELECT 1 FROM [${arg.entity.schemaName}].[${arg.entity.className}] WHERE ECInstanceId=?`, (stmt) => {
+                stmt.bindId(1, arg.entity.id);
+                const matchesResult = stmt.step();
+                if (matchesResult === core_common_1.DbResult.BE_SQLITE_ROW)
+                    return true;
+                if (matchesResult === core_common_1.DbResult.BE_SQLITE_DONE)
+                    return false;
+                else
+                    throw new core_common_1.IModelError(matchesResult, "query failed");
+            });
+        }
+    }
+    EntityUnifier.exists = exists;
+})(EntityUnifier = exports.EntityUnifier || (exports.EntityUnifier = {}));
+//# sourceMappingURL=EntityUnifier.js.map

package/lib/cjs/EntityUnifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityUnifier.js","sourceRoot":"","sources":["../../src/EntityUnifier.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;;;GAIG;AACH,iCAAiC;AACjC,oDAAkG;AAClG,sDAA4I;AAE5I,gBAAgB;AAChB,IAAiB,aAAa,CAqD7B;AArDD,WAAiB,aAAa;IAC5B,SAAgB,eAAe,CAAC,MAAsB;QACpD,IAAI,MAAM,YAAY,sBAAO;YAC3B,OAAO,SAAS,CAAC;aACd,IAAI,MAAM,YAAY,4BAAa;YACtC,OAAO,gBAAgB,CAAC;aACrB,IAAI,MAAM,YAAY,2BAAY;YACrC,OAAO,cAAc,CAAC;;YAEtB,OAAO,qBAAqB,CAAC;IACjC,CAAC;IATe,6BAAe,kBAS9B,CAAA;IAID,2GAA2G;IAC3G,SAAgB,UAAU,CAAC,EAAY,EAAE,MAAsB;QAC7D,IAAI,MAAM,YAAY,sBAAO;YAC3B,OAAO,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAkB,CAAC;aACjE,IAAI,MAAM,YAAY,2BAAY;YACrC,OAAO,EAAE,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAkB,CAAC;aAC5E,IAAI,MAAM,YAAY,4BAAa;YACtC,OAAO,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAkB,CAAC;;YAEnE,MAAM,CAAC,KAAK,EAAE,4BAA4B,MAAM,CAAC,WAAW,CAAC,IAAI,kDAAkD,CAAC,CAAC;IACzH,CAAC;IATe,wBAAU,aASzB,CAAA;IAED,SAAgB,MAAM,CAAC,EAAY,EAAE,GAAsE;QACzG,IAAI,iBAAiB,IAAI,GAAG,EAAE;YAC5B,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,+BAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAC/D,MAAM,oBAAoB,GAAG,iCAAmB,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAC;YAClF,OAAO,EAAE,CAAC,qBAAqB,CAAC,iBAAiB,oBAAoB,uBAAuB,EAAE,CAAC,IAAI,EAAE,EAAE;gBACrG,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACnB,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClC,IAAI,aAAa,KAAK,sBAAQ,CAAC,aAAa;oBAC1C,OAAO,IAAI,CAAC;gBACd,IAAI,aAAa,KAAK,sBAAQ,CAAC,cAAc;oBAC3C,OAAO,KAAK,CAAC;;oBAEb,MAAM,IAAI,yBAAW,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;YACzD,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,OAAO,EAAE,CAAC,qBAAqB,CAAC,kBAAkB,GAAG,CAAC,MAAM,CAAC,UAAU,MAAM,GAAG,CAAC,MAAM,CAAC,SAAS,wBAAwB,EAAE,CAAC,IAAI,EAAE,EAAE;gBAClI,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBAC9B,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClC,IAAI,aAAa,KAAK,sBAAQ,CAAC,aAAa;oBAC1C,OAAO,IAAI,CAAC;gBACd,IAAI,aAAa,KAAK,sBAAQ,CAAC,cAAc;oBAC3C,OAAO,KAAK,CAAC;;oBAEb,MAAM,IAAI,yBAAW,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;YACzD,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IA1Be,oBAAM,SA0BrB,CAAA;AACH,CAAC,EArDgB,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAqD7B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Utils\n * utilities that unify operations, especially CRUD operations, on entities\n * for entity-generic operations in the transformer\n */\nimport * as assert from \"assert\";\nimport { ConcreteEntityTypes, DbResult,  EntityReference, IModelError } from \"@itwin/core-common\";\nimport { ConcreteEntity, ConcreteEntityProps, Element, ElementAspect, EntityReferences, IModelDb, Relationship } from \"@itwin/core-backend\";\n\n/** @internal */\nexport namespace EntityUnifier {\n  export function getReadableType(entity: ConcreteEntity) {\n    if (entity instanceof Element)\n      return \"element\";\n    else if (entity instanceof ElementAspect)\n      return \"element aspect\";\n    else if (entity instanceof Relationship)\n      return \"relationship\";\n    else\n      return \"unknown entity type\";\n  }\n\n  type EntityUpdater = (entityProps: ConcreteEntityProps) => void;\n\n  /** needs to return a widened type otherwise typescript complains when result is used with a narrow type */\n  export function updaterFor(db: IModelDb, entity: ConcreteEntity) {\n    if (entity instanceof Element)\n      return db.elements.updateElement.bind(db.elements) as EntityUpdater;\n    else if (entity instanceof Relationship)\n      return db.relationships.updateInstance.bind(db.relationships) as EntityUpdater;\n    else if (entity instanceof ElementAspect)\n      return db.elements.updateAspect.bind(db.elements) as EntityUpdater;\n    else\n      assert(false, `unreachable; entity was '${entity.constructor.name}' not an Element, Relationship, or ElementAspect`);\n  }\n\n  export function exists(db: IModelDb, arg: { entity: ConcreteEntity } | { entityReference: EntityReference }) {\n    if (\"entityReference\" in arg) {\n      const [type, id] = EntityReferences.split(arg.entityReference);\n      const bisCoreRootClassName = ConcreteEntityTypes.toBisCoreRootClassFullName(type);\n      return db.withPreparedStatement(`SELECT 1 FROM ${bisCoreRootClassName} WHERE ECInstanceId=?`, (stmt) => {\n        stmt.bindId(1, id);\n        const matchesResult = stmt.step();\n        if (matchesResult === DbResult.BE_SQLITE_ROW)\n          return true;\n        if (matchesResult === DbResult.BE_SQLITE_DONE)\n          return false;\n        else\n          throw new IModelError(matchesResult, \"query failed\");\n      });\n    } else {\n      return db.withPreparedStatement(`SELECT 1 FROM [${arg.entity.schemaName}].[${arg.entity.className}] WHERE ECInstanceId=?`, (stmt) => {\n        stmt.bindId(1, arg.entity.id);\n        const matchesResult = stmt.step();\n        if (matchesResult === DbResult.BE_SQLITE_ROW)\n          return true;\n        if (matchesResult === DbResult.BE_SQLITE_DONE)\n          return false;\n        else\n          throw new IModelError(matchesResult, \"query failed\");\n      });\n    }\n  }\n}\n"]}

package/lib/cjs/IModelCloneContext.d.ts

@@ -0,0 +1,32 @@
+import { Id64String } from "@itwin/core-bentley";
+import { ElementAspectProps, EntityReference } from "@itwin/core-common";
+import { ElementAspect, IModelElementCloneContext, SQLiteDb } from "@itwin/core-backend";
+/** The context for transforming a *source* Element to a *target* Element and remapping internal identifiers to the target iModel.
+ * @beta
+ */
+export declare class IModelCloneContext extends IModelElementCloneContext {
+    private _refTypesCache;
+    /** perform necessary initialization to use a clone context, namely caching the reference types in the source's schemas */
+    initialize(): Promise<void>;
+    private _aspectRemapTable;
+    /** Add a rule that remaps the specified source ElementAspect to the specified target ElementAspect. */
+    remapElementAspect(aspectSourceId: Id64String, aspectTargetId: Id64String): void;
+    /** Remove a rule that remaps the specified source ElementAspect */
+    removeElementAspect(aspectSourceId: Id64String): void;
+    /** Look up a target AspectId from the source AspectId.
+     * @returns the target AspectId or [Id64.invalid]($bentley) if a mapping not found.
+     */
+    findTargetAspectId(sourceAspectId: Id64String): Id64String;
+    /** Look up a target [EntityReference]($bentley) from a source [EntityReference]($bentley)
+     * @returns the target CodeSpecId or a [EntityReference]($bentley) containing [Id64.invalid]($bentley) if a mapping is not found.
+     */
+    findTargetEntityId(sourceEntityId: EntityReference): EntityReference;
+    /** Clone the specified source Element into ElementProps for the target iModel.
+     * @internal
+     */
+    cloneElementAspect(sourceElementAspect: ElementAspect): ElementAspectProps;
+    private static aspectRemapTableName;
+    saveStateToDb(db: SQLiteDb): void;
+    loadStateFromDb(db: SQLiteDb): void;
+}
+//# sourceMappingURL=IModelCloneContext.d.ts.map

package/lib/cjs/IModelCloneContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelCloneContext.d.ts","sourceRoot":"","sources":["../../src/IModelCloneContext.ts"],"names":[],"mappings":"AAQA,OAAO,EAAkB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,EACgB,kBAAkB,EAAE,eAAe,EAEzD,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,aAAa,EAAoB,yBAAyB,EAAE,QAAQ,EACrE,MAAM,qBAAqB,CAAC;AAI7B;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,yBAAyB;IAE/D,OAAO,CAAC,cAAc,CAA+B;IAErD,0HAA0H;IACpG,UAAU;IAIhC,OAAO,CAAC,iBAAiB,CAAqC;IAE9D,uGAAuG;IAChG,kBAAkB,CAAC,cAAc,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,GAAG,IAAI;IAIvF,mEAAmE;IAC5D,mBAAmB,CAAC,cAAc,EAAE,UAAU,GAAG,IAAI;IAI5D;;OAEG;IACI,kBAAkB,CAAC,cAAc,EAAE,UAAU,GAAG,UAAU;IAIjE;;OAEG;IACI,kBAAkB,CAAC,cAAc,EAAE,eAAe,GAAG,eAAe;IA+F3E;;OAEG;IACI,kBAAkB,CAAC,mBAAmB,EAAE,aAAa,GAAG,kBAAkB;IAyBjF,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAoB;IAEvC,aAAa,CAAC,EAAE,EAAE,QAAQ,GAAG,IAAI;IAoBjC,eAAe,CAAC,EAAE,EAAE,QAAQ,GAAG,IAAI;CAapD"}