@itwin/imodel-transformer 0.0.1-dev.0

package/lib/cjs/IModelCloneContext.js

@@ -0,0 +1,195 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IModelCloneContext = 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 iModels
+ */
+const assert = require("assert");
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const core_backend_1 = require("@itwin/core-backend");
+const ECReferenceTypesCache_1 = require("./ECReferenceTypesCache");
+const EntityUnifier_1 = require("./EntityUnifier");
+/** The context for transforming a *source* Element to a *target* Element and remapping internal identifiers to the target iModel.
+ * @beta
+ */
+class IModelCloneContext extends core_backend_1.IModelElementCloneContext {
+    constructor() {
+        super(...arguments);
+        this._refTypesCache = new ECReferenceTypesCache_1.ECReferenceTypesCache();
+        this._aspectRemapTable = new Map();
+    }
+    /** perform necessary initialization to use a clone context, namely caching the reference types in the source's schemas */
+    async initialize() {
+        await this._refTypesCache.initAllSchemasInIModel(this.sourceDb);
+    }
+    /** Add a rule that remaps the specified source ElementAspect to the specified target ElementAspect. */
+    remapElementAspect(aspectSourceId, aspectTargetId) {
+        this._aspectRemapTable.set(aspectSourceId, aspectTargetId);
+    }
+    /** Remove a rule that remaps the specified source ElementAspect */
+    removeElementAspect(aspectSourceId) {
+        this._aspectRemapTable.delete(aspectSourceId);
+    }
+    /** Look up a target AspectId from the source AspectId.
+     * @returns the target AspectId or [Id64.invalid]($bentley) if a mapping not found.
+     */
+    findTargetAspectId(sourceAspectId) {
+        var _a;
+        return (_a = this._aspectRemapTable.get(sourceAspectId)) !== null && _a !== void 0 ? _a : core_bentley_1.Id64.invalid;
+    }
+    /** 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) {
+        const [type, rawId] = core_backend_1.EntityReferences.split(sourceEntityId);
+        if (core_bentley_1.Id64.isValid(rawId)) {
+            switch (type) {
+                case core_common_1.ConcreteEntityTypes.Model: {
+                    const targetId = `m${this.findTargetElementId(rawId)}`;
+                    // Check if the model exists, `findTargetElementId` may have worked because the element exists when the model doesn't.
+                    // That can occur in the transformer since a submodeled element is imported before its submodel.
+                    if (EntityUnifier_1.EntityUnifier.exists(this.targetDb, { entityReference: targetId }))
+                        return targetId;
+                    break;
+                }
+                case core_common_1.ConcreteEntityTypes.Element:
+                    return `e${this.findTargetElementId(rawId)}`;
+                case core_common_1.ConcreteEntityTypes.ElementAspect:
+                    return `a${this.findTargetAspectId(rawId)}`;
+                case core_common_1.ConcreteEntityTypes.Relationship: {
+                    const makeGetConcreteEntityTypeSql = (property) => `
+            CASE
+              WHEN [${property}] IS (BisCore.ElementUniqueAspect) OR [${property}] IS (BisCore.ElementMultiAspect)
+                THEN 'a'
+              WHEN [${property}] IS (BisCore.Element)
+                THEN 'e'
+              WHEN [${property}] IS (BisCore.Model)
+                THEN 'm'
+              WHEN [${property}] IS (BisCore.CodeSpec)
+                THEN 'c'
+              WHEN [${property}] IS (BisCore.ElementRefersToElements) -- TODO: ElementDrivesElement still not handled by the transformer
+                THEN 'r'
+              ELSE 'error'
+            END
+          `;
+                    const relInSource = this.sourceDb.withPreparedStatement(`
+            SELECT
+              SourceECInstanceId,
+              TargetECInstanceId,
+              (${makeGetConcreteEntityTypeSql("SourceECClassId")}) AS SourceType,
+              (${makeGetConcreteEntityTypeSql("TargetECClassId")}) AS TargetType
+            FROM BisCore:ElementRefersToElements
+            WHERE ECInstanceId=?
+            `, (stmt) => {
+                        stmt.bindId(1, rawId);
+                        let status;
+                        while ((status = stmt.step()) === core_bentley_1.DbResult.BE_SQLITE_ROW) {
+                            const sourceId = stmt.getValue(0).getId();
+                            const targetId = stmt.getValue(1).getId();
+                            const sourceType = stmt.getValue(2).getString();
+                            const targetType = stmt.getValue(3).getString();
+                            if (sourceType === "error" || targetType === "error")
+                                throw Error("relationship end had unknown root class");
+                            return {
+                                sourceId: `${sourceType}${sourceId}`,
+                                targetId: `${targetType}${targetId}`,
+                            };
+                        }
+                        if (status !== core_bentley_1.DbResult.BE_SQLITE_DONE)
+                            throw new core_common_1.IModelError(status, "unexpected query failure");
+                        return undefined;
+                    });
+                    if (relInSource === undefined)
+                        break;
+                    // just in case prevent recursion
+                    if (relInSource.sourceId === sourceEntityId || relInSource.targetId === sourceEntityId)
+                        throw Error("link table relationship end was resolved to itself. This should be impossible");
+                    const relInTarget = {
+                        sourceId: this.findTargetEntityId(relInSource.sourceId),
+                        targetId: this.findTargetEntityId(relInSource.targetId),
+                    };
+                    // return a null
+                    if (core_bentley_1.Id64.isInvalid(relInTarget.sourceId) || core_bentley_1.Id64.isInvalid(relInTarget.targetId))
+                        break;
+                    const relInTargetId = this.sourceDb.withPreparedStatement(`
+            SELECT ECInstanceId
+            FROM BisCore:ElementRefersToElements
+            WHERE SourceECInstanceId=?
+              AND TargetECInstanceId=?
+            `, (stmt) => {
+                        stmt.bindId(1, core_backend_1.EntityReferences.toId64(relInTarget.sourceId));
+                        stmt.bindId(2, core_backend_1.EntityReferences.toId64(relInTarget.targetId));
+                        let status;
+                        if ((status = stmt.step()) === core_bentley_1.DbResult.BE_SQLITE_ROW)
+                            return stmt.getValue(0).getId();
+                        if (status !== core_bentley_1.DbResult.BE_SQLITE_DONE)
+                            throw new core_common_1.IModelError(status, "unexpected query failure");
+                        return core_bentley_1.Id64.invalid;
+                    });
+                    return `r${relInTargetId}`;
+                }
+            }
+        }
+        return `${type}${core_bentley_1.Id64.invalid}`;
+    }
+    /** Clone the specified source Element into ElementProps for the target iModel.
+     * @internal
+     */
+    cloneElementAspect(sourceElementAspect) {
+        const targetElementAspectProps = sourceElementAspect.toJSON();
+        targetElementAspectProps.id = undefined;
+        sourceElementAspect.forEachProperty((propertyName, propertyMetaData) => {
+            if (propertyMetaData.isNavigation) {
+                const sourceNavProp = sourceElementAspect.asAny[propertyName];
+                if (sourceNavProp === null || sourceNavProp === void 0 ? void 0 : sourceNavProp.id) {
+                    const navPropRefType = this._refTypesCache.getNavPropRefType(sourceElementAspect.schemaName, sourceElementAspect.className, propertyName);
+                    assert(navPropRefType !== undefined, `nav prop ref type for '${propertyName}' was not in the cache, this is a bug.`);
+                    const targetEntityReference = this.findTargetEntityId(core_backend_1.EntityReferences.fromEntityType(sourceNavProp.id, navPropRefType));
+                    const targetEntityId = core_backend_1.EntityReferences.toId64(targetEntityReference);
+                    // spread the property in case toJSON did not deep-clone
+                    targetElementAspectProps[propertyName] = { ...targetElementAspectProps[propertyName], id: targetEntityId };
+                }
+            }
+            else if ((core_common_1.PrimitiveTypeCode.Long === propertyMetaData.primitiveType) && ("Id" === propertyMetaData.extendedType)) {
+                targetElementAspectProps[propertyName] = this.findTargetElementId(sourceElementAspect.asAny[propertyName]);
+            }
+        });
+        return targetElementAspectProps;
+    }
+    saveStateToDb(db) {
+        super.saveStateToDb(db);
+        if (core_bentley_1.DbResult.BE_SQLITE_DONE !== db.executeSQL(`CREATE TABLE ${IModelCloneContext.aspectRemapTableName} (Source INTEGER, Target INTEGER)`))
+            throw Error("Failed to create the aspect remap table in the state database");
+        db.saveChanges();
+        db.withPreparedSqliteStatement(`INSERT INTO ${IModelCloneContext.aspectRemapTableName} (Source, Target) VALUES (?, ?)`, (stmt) => {
+            for (const [source, target] of this._aspectRemapTable) {
+                stmt.reset();
+                stmt.bindId(1, source);
+                stmt.bindId(2, target);
+                if (core_bentley_1.DbResult.BE_SQLITE_DONE !== stmt.step())
+                    throw Error("Failed to insert aspect remapping into the state database");
+            }
+        });
+    }
+    loadStateFromDb(db) {
+        super.loadStateFromDb(db);
+        // FIXME: test this
+        db.withSqliteStatement(`SELECT Source, Target FROM ${IModelCloneContext.aspectRemapTableName}`, (stmt) => {
+            let status = core_bentley_1.DbResult.BE_SQLITE_ERROR;
+            while ((status = stmt.step()) === core_bentley_1.DbResult.BE_SQLITE_ROW) {
+                const source = stmt.getValue(0).getId();
+                const target = stmt.getValue(1).getId();
+                this._aspectRemapTable.set(source, target);
+            }
+            assert(status === core_bentley_1.DbResult.BE_SQLITE_DONE);
+        });
+    }
+}
+exports.IModelCloneContext = IModelCloneContext;
+IModelCloneContext.aspectRemapTableName = "AspectIdRemaps";
+//# sourceMappingURL=IModelCloneContext.js.map

package/lib/cjs/IModelCloneContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelCloneContext.js","sourceRoot":"","sources":["../../src/IModelCloneContext.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,iCAAiC;AACjC,sDAAiE;AACjE,oDAG4B;AAC5B,sDAE6B;AAC7B,mEAAgE;AAChE,mDAAgD;AAEhD;;GAEG;AACH,MAAa,kBAAmB,SAAQ,wCAAyB;IAAjE;;QAEU,mBAAc,GAAG,IAAI,6CAAqB,EAAE,CAAC;QAO7C,sBAAiB,GAAG,IAAI,GAAG,EAA0B,CAAC;IAoLhE,CAAC;IAzLC,0HAA0H;IAC1G,KAAK,CAAC,UAAU;QAC9B,MAAM,IAAI,CAAC,cAAc,CAAC,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAClE,CAAC;IAID,uGAAuG;IAChG,kBAAkB,CAAC,cAA0B,EAAE,cAA0B;QAC9E,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IAC7D,CAAC;IAED,mEAAmE;IAC5D,mBAAmB,CAAC,cAA0B;QACnD,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,cAA0B;;QAClD,OAAO,MAAA,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,cAAc,CAAC,mCAAI,mBAAI,CAAC,OAAO,CAAC;IACpE,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,cAA+B;QACvD,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,+BAAgB,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC7D,IAAI,mBAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACvB,QAAQ,IAAI,EAAE;gBACZ,KAAK,iCAAmB,CAAC,KAAK,CAAC,CAAC;oBAC9B,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAW,CAAC;oBAChE,sHAAsH;oBACtH,gGAAgG;oBAChG,IAAI,6BAAa,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC;wBACpE,OAAO,QAAQ,CAAC;oBAClB,MAAM;iBACP;gBACD,KAAK,iCAAmB,CAAC,OAAO;oBAC9B,OAAO,IAAI,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/C,KAAK,iCAAmB,CAAC,aAAa;oBACpC,OAAO,IAAI,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9C,KAAK,iCAAmB,CAAC,YAAY,CAAC,CAAC;oBACrC,MAAM,4BAA4B,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC;;sBAE/C,QAAQ,0CAA0C,QAAQ;;sBAE1D,QAAQ;;sBAER,QAAQ;;sBAER,QAAQ;;sBAER,QAAQ;;;;WAInB,CAAC;oBACF,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CACrD;;;;iBAIK,4BAA4B,CAAC,iBAAiB,CAAC;iBAC/C,4BAA4B,CAAC,iBAAiB,CAAC;;;aAGnD,EAAE,CAAC,IAAI,EAAE,EAAE;wBACV,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;wBACtB,IAAI,MAAgB,CAAC;wBACrB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,uBAAQ,CAAC,aAAa,EAAE;4BACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;4BAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;4BAC1C,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAmC,CAAC;4BACjF,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAmC,CAAC;4BACjF,IAAI,UAAU,KAAK,OAAO,IAAI,UAAU,KAAK,OAAO;gCAClD,MAAM,KAAK,CAAC,yCAAyC,CAAC,CAAC;4BACzD,OAAO;gCACL,QAAQ,EAAE,GAAG,UAAU,GAAG,QAAQ,EAAE;gCACpC,QAAQ,EAAE,GAAG,UAAU,GAAG,QAAQ,EAAE;6BAC5B,CAAC;yBACZ;wBACD,IAAI,MAAM,KAAK,uBAAQ,CAAC,cAAc;4BACpC,MAAM,IAAI,yBAAW,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;wBAC5D,OAAO,SAAS,CAAC;oBACnB,CAAC,CAAC,CAAC;oBACL,IAAI,WAAW,KAAK,SAAS;wBAC3B,MAAM;oBACR,iCAAiC;oBACjC,IAAI,WAAW,CAAC,QAAQ,KAAK,cAAc,IAAI,WAAW,CAAC,QAAQ,KAAK,cAAc;wBACpF,MAAM,KAAK,CAAC,+EAA+E,CAAC,CAAC;oBAC/F,MAAM,WAAW,GAAG;wBAClB,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,QAAQ,CAAC;wBACvD,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,QAAQ,CAAC;qBACxD,CAAC;oBACF,gBAAgB;oBAChB,IAAI,mBAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,mBAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC;wBAC9E,MAAM;oBACR,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CACvD;;;;;aAKC,EAAE,CAAC,IAAI,EAAE,EAAE;wBACV,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,+BAAgB,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;wBAC9D,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,+BAAgB,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;wBAC9D,IAAI,MAAgB,CAAC;wBACrB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,uBAAQ,CAAC,aAAa;4BACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;wBAClC,IAAI,MAAM,KAAK,uBAAQ,CAAC,cAAc;4BACpC,MAAM,IAAI,yBAAW,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;wBAC5D,OAAO,mBAAI,CAAC,OAAO,CAAC;oBACtB,CAAC,CAAC,CAAC;oBACL,OAAO,IAAI,aAAa,EAAE,CAAC;iBAC5B;aACF;SACF;QACD,OAAO,GAAG,IAAI,GAAG,mBAAI,CAAC,OAAO,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,mBAAkC;QAC1D,MAAM,wBAAwB,GAAuB,mBAAmB,CAAC,MAAM,EAAE,CAAC;QAClF,wBAAwB,CAAC,EAAE,GAAG,SAAS,CAAC;QACxC,mBAAmB,CAAC,eAAe,CAAC,CAAC,YAAY,EAAE,gBAAgB,EAAE,EAAE;YACrE,IAAI,gBAAgB,CAAC,YAAY,EAAE;gBACjC,MAAM,aAAa,GAAoC,mBAAmB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBAC/F,IAAI,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,EAAE,EAAE;oBACrB,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAC1D,mBAAmB,CAAC,UAAU,EAC9B,mBAAmB,CAAC,SAAS,EAC7B,YAAY,CACb,CAAC;oBACF,MAAM,CAAC,cAAc,KAAK,SAAS,EAAC,0BAA0B,YAAY,wCAAwC,CAAC,CAAC;oBACpH,MAAM,qBAAqB,GAAG,IAAI,CAAC,kBAAkB,CAAC,+BAAgB,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;oBACzH,MAAM,cAAc,GAAG,+BAAgB,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;oBACtE,wDAAwD;oBACvD,wBAAgC,CAAC,YAAY,CAAC,GAAG,EAAE,GAAI,wBAAgC,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC;iBAC9H;aACF;iBAAM,IAAI,CAAC,+BAAiB,CAAC,IAAI,KAAK,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,YAAY,CAAC,EAAE;gBACjH,wBAAgC,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;aACrH;QACH,CAAC,CAAC,CAAC;QACH,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAIe,aAAa,CAAC,EAAY;QACxC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QACxB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE,CAAC,UAAU,CAC3C,gBAAgB,kBAAkB,CAAC,oBAAoB,mCAAmC,CAC3F;YACC,MAAM,KAAK,CAAC,+DAA+D,CAAC,CAAC;QAC/E,EAAE,CAAC,WAAW,EAAE,CAAC;QACjB,EAAE,CAAC,2BAA2B,CAC5B,eAAe,kBAAkB,CAAC,oBAAoB,iCAAiC,EACvF,CAAC,IAAI,EAAE,EAAE;YACP,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,iBAAiB,EAAE;gBACrD,IAAI,CAAC,KAAK,EAAE,CAAC;gBACb,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;gBACvB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;gBACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,IAAI,CAAC,IAAI,EAAE;oBACzC,MAAM,KAAK,CAAC,2DAA2D,CAAC,CAAC;aAC5E;QACH,CAAC,CAAC,CAAC;IACP,CAAC;IAEe,eAAe,CAAC,EAAY;QAC1C,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAC1B,mBAAmB;QACnB,EAAE,CAAC,mBAAmB,CAAC,8BAA8B,kBAAkB,CAAC,oBAAoB,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;YACvG,IAAI,MAAM,GAAG,uBAAQ,CAAC,eAAe,CAAC;YACtC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,uBAAQ,CAAC,aAAa,EAAE;gBACxD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;gBACxC,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;gBACxC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;aAC5C;YACD,MAAM,CAAC,MAAM,KAAK,uBAAQ,CAAC,cAAc,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC;;AA5LH,gDA6LC;AAnCgB,uCAAoB,GAAG,gBAAgB,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 */\nimport * as assert from \"assert\";\nimport { DbResult, Id64, Id64String } from \"@itwin/core-bentley\";\nimport {\n  ConcreteEntityTypes, ElementAspectProps, EntityReference, IModelError,\n  PrimitiveTypeCode, RelatedElementProps,\n} from \"@itwin/core-common\";\nimport {\n  ElementAspect, EntityReferences, IModelElementCloneContext, SQLiteDb,\n} from \"@itwin/core-backend\";\nimport { ECReferenceTypesCache } from \"./ECReferenceTypesCache\";\nimport { EntityUnifier } from \"./EntityUnifier\";\n\n/** The context for transforming a *source* Element to a *target* Element and remapping internal identifiers to the target iModel.\n * @beta\n */\nexport class IModelCloneContext extends IModelElementCloneContext {\n\n  private _refTypesCache = new ECReferenceTypesCache();\n\n  /** perform necessary initialization to use a clone context, namely caching the reference types in the source's schemas */\n  public override async initialize() {\n    await this._refTypesCache.initAllSchemasInIModel(this.sourceDb);\n  }\n\n  private _aspectRemapTable = new Map<Id64String, Id64String>();\n\n  /** Add a rule that remaps the specified source ElementAspect to the specified target ElementAspect. */\n  public remapElementAspect(aspectSourceId: Id64String, aspectTargetId: Id64String): void {\n    this._aspectRemapTable.set(aspectSourceId, aspectTargetId);\n  }\n\n  /** Remove a rule that remaps the specified source ElementAspect */\n  public removeElementAspect(aspectSourceId: Id64String): void {\n    this._aspectRemapTable.delete(aspectSourceId);\n  }\n\n  /** Look up a target AspectId from the source AspectId.\n   * @returns the target AspectId or [Id64.invalid]($bentley) if a mapping not found.\n   */\n  public findTargetAspectId(sourceAspectId: Id64String): Id64String {\n    return this._aspectRemapTable.get(sourceAspectId) ?? Id64.invalid;\n  }\n\n  /** Look up a target [EntityReference]($bentley) from a source [EntityReference]($bentley)\n   * @returns the target CodeSpecId or a [EntityReference]($bentley) containing [Id64.invalid]($bentley) if a mapping is not found.\n   */\n  public findTargetEntityId(sourceEntityId: EntityReference): EntityReference {\n    const [type, rawId] = EntityReferences.split(sourceEntityId);\n    if (Id64.isValid(rawId)) {\n      switch (type) {\n        case ConcreteEntityTypes.Model: {\n          const targetId = `m${this.findTargetElementId(rawId)}` as const;\n          // Check if the model exists, `findTargetElementId` may have worked because the element exists when the model doesn't.\n          // That can occur in the transformer since a submodeled element is imported before its submodel.\n          if (EntityUnifier.exists(this.targetDb, { entityReference: targetId }))\n            return targetId;\n          break;\n        }\n        case ConcreteEntityTypes.Element:\n          return `e${this.findTargetElementId(rawId)}`;\n        case ConcreteEntityTypes.ElementAspect:\n          return `a${this.findTargetAspectId(rawId)}`;\n        case ConcreteEntityTypes.Relationship: {\n          const makeGetConcreteEntityTypeSql = (property: string) => `\n            CASE\n              WHEN [${property}] IS (BisCore.ElementUniqueAspect) OR [${property}] IS (BisCore.ElementMultiAspect)\n                THEN 'a'\n              WHEN [${property}] IS (BisCore.Element)\n                THEN 'e'\n              WHEN [${property}] IS (BisCore.Model)\n                THEN 'm'\n              WHEN [${property}] IS (BisCore.CodeSpec)\n                THEN 'c'\n              WHEN [${property}] IS (BisCore.ElementRefersToElements) -- TODO: ElementDrivesElement still not handled by the transformer\n                THEN 'r'\n              ELSE 'error'\n            END\n          `;\n          const relInSource = this.sourceDb.withPreparedStatement(\n            `\n            SELECT\n              SourceECInstanceId,\n              TargetECInstanceId,\n              (${makeGetConcreteEntityTypeSql(\"SourceECClassId\")}) AS SourceType,\n              (${makeGetConcreteEntityTypeSql(\"TargetECClassId\")}) AS TargetType\n            FROM BisCore:ElementRefersToElements\n            WHERE ECInstanceId=?\n            `, (stmt) => {\n              stmt.bindId(1, rawId);\n              let status: DbResult;\n              while ((status = stmt.step()) === DbResult.BE_SQLITE_ROW) {\n                const sourceId = stmt.getValue(0).getId();\n                const targetId = stmt.getValue(1).getId();\n                const sourceType = stmt.getValue(2).getString() as ConcreteEntityTypes | \"error\";\n                const targetType = stmt.getValue(3).getString() as ConcreteEntityTypes | \"error\";\n                if (sourceType === \"error\" || targetType === \"error\")\n                  throw Error(\"relationship end had unknown root class\");\n                return {\n                  sourceId: `${sourceType}${sourceId}`,\n                  targetId: `${targetType}${targetId}`,\n                } as const;\n              }\n              if (status !== DbResult.BE_SQLITE_DONE)\n                throw new IModelError(status, \"unexpected query failure\");\n              return undefined;\n            });\n          if (relInSource === undefined)\n            break;\n          // just in case prevent recursion\n          if (relInSource.sourceId === sourceEntityId || relInSource.targetId === sourceEntityId)\n            throw Error(\"link table relationship end was resolved to itself. This should be impossible\");\n          const relInTarget = {\n            sourceId: this.findTargetEntityId(relInSource.sourceId),\n            targetId: this.findTargetEntityId(relInSource.targetId),\n          };\n          // return a null\n          if (Id64.isInvalid(relInTarget.sourceId) || Id64.isInvalid(relInTarget.targetId))\n            break;\n          const relInTargetId = this.sourceDb.withPreparedStatement(\n            `\n            SELECT ECInstanceId\n            FROM BisCore:ElementRefersToElements\n            WHERE SourceECInstanceId=?\n              AND TargetECInstanceId=?\n            `, (stmt) => {\n              stmt.bindId(1, EntityReferences.toId64(relInTarget.sourceId));\n              stmt.bindId(2, EntityReferences.toId64(relInTarget.targetId));\n              let status: DbResult;\n              if ((status = stmt.step()) === DbResult.BE_SQLITE_ROW)\n                return stmt.getValue(0).getId();\n              if (status !== DbResult.BE_SQLITE_DONE)\n                throw new IModelError(status, \"unexpected query failure\");\n              return Id64.invalid;\n            });\n          return `r${relInTargetId}`;\n        }\n      }\n    }\n    return `${type}${Id64.invalid}`;\n  }\n\n  /** Clone the specified source Element into ElementProps for the target iModel.\n   * @internal\n   */\n  public cloneElementAspect(sourceElementAspect: ElementAspect): ElementAspectProps {\n    const targetElementAspectProps: ElementAspectProps = sourceElementAspect.toJSON();\n    targetElementAspectProps.id = undefined;\n    sourceElementAspect.forEachProperty((propertyName, propertyMetaData) => {\n      if (propertyMetaData.isNavigation) {\n        const sourceNavProp: RelatedElementProps | undefined = sourceElementAspect.asAny[propertyName];\n        if (sourceNavProp?.id) {\n          const navPropRefType = this._refTypesCache.getNavPropRefType(\n            sourceElementAspect.schemaName,\n            sourceElementAspect.className,\n            propertyName\n          );\n          assert(navPropRefType !== undefined,`nav prop ref type for '${propertyName}' was not in the cache, this is a bug.`);\n          const targetEntityReference = this.findTargetEntityId(EntityReferences.fromEntityType(sourceNavProp.id, navPropRefType));\n          const targetEntityId = EntityReferences.toId64(targetEntityReference);\n          // spread the property in case toJSON did not deep-clone\n          (targetElementAspectProps as any)[propertyName] = { ...(targetElementAspectProps as any)[propertyName], id: targetEntityId };\n        }\n      } else if ((PrimitiveTypeCode.Long === propertyMetaData.primitiveType) && (\"Id\" === propertyMetaData.extendedType)) {\n        (targetElementAspectProps as any)[propertyName] = this.findTargetElementId(sourceElementAspect.asAny[propertyName]);\n      }\n    });\n    return targetElementAspectProps;\n  }\n\n  private static aspectRemapTableName = \"AspectIdRemaps\";\n\n  public override saveStateToDb(db: SQLiteDb): void {\n    super.saveStateToDb(db);\n    if (DbResult.BE_SQLITE_DONE !== db.executeSQL(\n      `CREATE TABLE ${IModelCloneContext.aspectRemapTableName} (Source INTEGER, Target INTEGER)`\n    ))\n      throw Error(\"Failed to create the aspect remap table in the state database\");\n    db.saveChanges();\n    db.withPreparedSqliteStatement(\n      `INSERT INTO ${IModelCloneContext.aspectRemapTableName} (Source, Target) VALUES (?, ?)`,\n      (stmt) => {\n        for (const [source, target] of this._aspectRemapTable) {\n          stmt.reset();\n          stmt.bindId(1, source);\n          stmt.bindId(2, target);\n          if (DbResult.BE_SQLITE_DONE !== stmt.step())\n            throw Error(\"Failed to insert aspect remapping into the state database\");\n        }\n      });\n  }\n\n  public override loadStateFromDb(db: SQLiteDb): void {\n    super.loadStateFromDb(db);\n    // FIXME: test this\n    db.withSqliteStatement(`SELECT Source, Target FROM ${IModelCloneContext.aspectRemapTableName}`, (stmt) => {\n      let status = DbResult.BE_SQLITE_ERROR;\n      while ((status = stmt.step()) === DbResult.BE_SQLITE_ROW) {\n        const source = stmt.getValue(0).getId();\n        const target = stmt.getValue(1).getId();\n        this._aspectRemapTable.set(source, target);\n      }\n      assert(status === DbResult.BE_SQLITE_DONE);\n    });\n  }\n}\n"]}

package/lib/cjs/IModelExporter.d.ts

@@ -0,0 +1,353 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { AccessToken, CompressedId64Set, Id64String } from "@itwin/core-bentley";
+import { Schema, SchemaKey } from "@itwin/ecschema-metadata";
+import { CodeSpec, FontProps } from "@itwin/core-common";
+import { BriefcaseDb, Element, ElementAspect, ElementMultiAspect, ElementUniqueAspect, IModelDb, IModelJsNative, Model, Relationship } from "@itwin/core-backend";
+/**
+ * @beta
+ * The (optional) result of [[IModelExportHandler.onExportSchema]]
+ */
+export interface ExportSchemaResult {
+    /** set this property to notify subclasses where you wrote a schema for later import */
+    schemaPath?: string;
+}
+/** Handles the events generated by IModelExporter.
+ * @note Change information is available when `IModelExportHandler` methods are invoked via [IModelExporter.exportChanges]($transformer), but not available when invoked via [IModelExporter.exportAll]($transformer).
+ * @note The handler is intended to be owned by (registered with) and called from the IModelExporter exclusively
+ * @see [iModel Transformation and Data Exchange]($docs/learning/transformer/index.md), [IModelExporter]($transformer)
+ * @beta
+ */
+export declare abstract class IModelExportHandler {
+    /** If `true` is returned, then the CodeSpec will be exported.
+     * @note This method can optionally be overridden to exclude an individual CodeSpec from the export. The base implementation always returns `true`.
+     */
+    shouldExportCodeSpec(_codeSpec: CodeSpec): boolean;
+    /** Called when a CodeSpec should be exported.
+     * @param codeSpec The CodeSpec to export
+     * @param isUpdate If defined, then `true` indicates an UPDATE operation while `false` indicates an INSERT operation. If not defined, then INSERT vs. UPDATE is not known.
+     * @note This should be overridden to actually do the export.
+     */
+    onExportCodeSpec(_codeSpec: CodeSpec, _isUpdate: boolean | undefined): void;
+    /** Called when a font should be exported.
+     * @param font The font to export
+     * @param isUpdate If defined, then `true` indicates an UPDATE operation while `false` indicates an INSERT operation. If not defined, then INSERT vs. UPDATE is not known.
+     * @note This should be overridden to actually do the export.
+     */
+    onExportFont(_font: FontProps, _isUpdate: boolean | undefined): void;
+    /** Called when a model should be exported.
+     * @param model The model to export
+     * @param isUpdate If defined, then `true` indicates an UPDATE operation while `false` indicates an INSERT operation. If not defined, then INSERT vs. UPDATE is not known.
+     * @note This should be overridden to actually do the export.
+     */
+    onExportModel(_model: Model, _isUpdate: boolean | undefined): void;
+    /** Called when a model should be deleted. */
+    onDeleteModel(_modelId: Id64String): void;
+    /** If `true` is returned, then the element will be exported.
+     * @note This method can optionally be overridden to exclude an individual Element (and its children and ElementAspects) from the export. The base implementation always returns `true`.
+     */
+    shouldExportElement(_element: Element): boolean;
+    /** Called when an element should be exported.
+     * @param element The element to export
+     * @param isUpdate If defined, then `true` indicates an UPDATE operation while `false` indicates an INSERT operation. If not defined, then INSERT vs. UPDATE is not known.
+     * @note This should be overridden to actually do the export.
+     */
+    onExportElement(_element: Element, _isUpdate: boolean | undefined): void;
+    /**
+     * Do any asynchronous actions before exporting an element
+     * @note Do not implement this handler manually, it is internal, it will be removed.
+     *       This will become a part of onExportElement once that becomes async
+     * @internal
+     */
+    preExportElement(_element: Element): Promise<void>;
+    /** Called when an element should be deleted. */
+    onDeleteElement(_elementId: Id64String): void;
+    /** If `true` is returned, then the ElementAspect will be exported.
+     * @note This method can optionally be overridden to exclude an individual ElementAspect from the export. The base implementation always returns `true`.
+     */
+    shouldExportElementAspect(_aspect: ElementAspect): boolean;
+    /** Called when an ElementUniqueAspect should be exported.
+     * @param aspect The ElementUniqueAspect to export
+     * @param isUpdate If defined, then `true` indicates an UPDATE operation while `false` indicates an INSERT operation. If not defined, then INSERT vs. UPDATE is not known.
+     * @note This should be overridden to actually do the export.
+     */
+    onExportElementUniqueAspect(_aspect: ElementUniqueAspect, _isUpdate: boolean | undefined): void;
+    /** Called when ElementMultiAspects should be exported.
+     * @note This should be overridden to actually do the export.
+     */
+    onExportElementMultiAspects(_aspects: ElementMultiAspect[]): void;
+    /** If `true` is returned, then the relationship will be exported.
+     * @note This method can optionally be overridden to exclude an individual CodeSpec from the export. The base implementation always returns `true`.
+     */
+    shouldExportRelationship(_relationship: Relationship): boolean;
+    /** Called when a Relationship should be exported.
+     * @param relationship The Relationship to export
+     * @param isUpdate If defined, then `true` indicates an UPDATE operation while `false` indicates an INSERT operation. If not defined, then INSERT vs. UPDATE is not known.
+     * @note This should be overridden to actually do the export.
+     */
+    onExportRelationship(_relationship: Relationship, _isUpdate: boolean | undefined): void;
+    /** Called when a relationship should be deleted. */
+    onDeleteRelationship(_relInstanceId: Id64String): void;
+    /** If `true` is returned, then the schema will be exported.
+     * @note This method can optionally be overridden to exclude an individual schema from the export. The base implementation always returns `true`.
+     */
+    shouldExportSchema(_schemaKey: SchemaKey): boolean;
+    /** Called when a schema should be exported.
+     * @param schema The schema to export
+     * @note This should be overridden to actually do the export.
+     * @note return an [[ExportSchemaResult]] with a `schemaPath` property to notify overrides that call `super`
+     *       where a schema was written for import.
+     */
+    onExportSchema(_schema: Schema): Promise<void | ExportSchemaResult>;
+    /** This method is called when IModelExporter has made incremental progress based on the [[IModelExporter.progressInterval]] setting.
+     * This method is `async` to make it easier to integrate with asynchronous status and health reporting services.
+     * @note A subclass may override this method to report custom progress. The base implementation does nothing.
+     */
+    onProgress(): Promise<void>;
+}
+/** Base class for exporting data from an iModel.
+ * @note Most uses cases will not require a custom subclass of `IModelExporter`. Instead, it is more typical to subclass/customize [IModelExportHandler]($transformer).
+ * @see [iModel Transformation and Data Exchange]($docs/learning/transformer/index.md), [[registerHandler]], [IModelTransformer]($transformer), [IModelImporter]($transformer)
+ * @beta
+ */
+export declare class IModelExporter {
+    /** The read-only source iModel. */
+    readonly sourceDb: IModelDb;
+    /** A flag that indicates whether element GeometryStreams are loaded or not.
+     * @note As an optimization, exporters that don't need geometry can set this flag to `false`. The default is `true`.
+     * @note The transformer by default sets this to `false` as an optimization.
+     * @note This implies the `wantBRepData` option when loading elements.
+     * @see [ElementLoadProps.wantGeometry]($common)
+     */
+    wantGeometry: boolean;
+    /** A flag that indicates whether template models should be exported or not. The default is `true`.
+     * @note If only exporting *instances* then template models can be skipped since they are just definitions that are cloned to create new instances.
+     * @see [Model.isTemplate]($backend)
+     */
+    wantTemplateModels: boolean;
+    /** A flag that indicates whether *system* schemas should be exported or not. The default is `true` (previously false).
+     * This can be set to false for the legacy default behavior, but it may cause errors during schema processing in some cases.
+     * @see [[exportSchemas]]
+     */
+    wantSystemSchemas: boolean;
+    /** A flag that determines whether this IModelExporter should visit Elements or not. The default is `true`.
+     * @note This flag is available as an optimization when the exporter doesn't need to visit elements, so can skip loading them.
+     */
+    visitElements: boolean;
+    /** A flag that determines whether this IModelExporter should visit Relationships or not. The default is `true`.
+     * @note This flag is available as an optimization when the exporter doesn't need to visit relationships, so can skip loading them.
+     */
+    visitRelationships: boolean;
+    /** The number of entities exported before incremental progress should be reported via the [[onProgress]] callback. */
+    progressInterval: number;
+    /** Tracks the current total number of entities exported. */
+    private _progressCounter;
+    /** Optionally cached entity change information */
+    private _sourceDbChanges?;
+    /**
+     * Retrieve the cached entity change information.
+     * @note This will only be initialized after [IModelExporter.exportChanges] is invoked.
+    */
+    get sourceDbChanges(): ChangedInstanceIds | undefined;
+    /** The handler called by this IModelExporter. */
+    private _handler;
+    /** The handler called by this IModelExporter. */
+    protected get handler(): IModelExportHandler;
+    /** The set of CodeSpecs to exclude from the export. */
+    private _excludedCodeSpecNames;
+    /** The set of specific Elements to exclude from the export. */
+    private _excludedElementIds;
+    /** The set of Categories where Elements in that Category will be excluded from transformation to the target iModel. */
+    private _excludedElementCategoryIds;
+    /** The set of classes of Elements that will be excluded (polymorphically) from transformation to the target iModel. */
+    private _excludedElementClasses;
+    /** The set of classes of ElementAspects that will be excluded (polymorphically) from transformation to the target iModel. */
+    private _excludedElementAspectClasses;
+    /** The set of classFullNames for ElementAspects that will be excluded from transformation to the target iModel. */
+    private _excludedElementAspectClassFullNames;
+    /** The set of classes of Relationships that will be excluded (polymorphically) from transformation to the target iModel. */
+    private _excludedRelationshipClasses;
+    /** Construct a new IModelExporter
+     * @param sourceDb The source IModelDb
+     * @see registerHandler
+     */
+    constructor(sourceDb: IModelDb);
+    /** Register the handler that will be called by IModelExporter. */
+    registerHandler(handler: IModelExportHandler): void;
+    /** Add a rule to exclude a CodeSpec */
+    excludeCodeSpec(codeSpecName: string): void;
+    /** Add a rule to exclude a specific Element. */
+    excludeElement(elementId: Id64String): void;
+    /** Add a rule to exclude all Elements in a specified Category. */
+    excludeElementsInCategory(categoryId: Id64String): void;
+    /** Add a rule to exclude all Elements of a specified class. */
+    excludeElementClass(classFullName: string): void;
+    /** Add a rule to exclude all ElementAspects of a specified class. */
+    excludeElementAspectClass(classFullName: string): void;
+    /** Add a rule to exclude all Relationships of a specified class. */
+    excludeRelationshipClass(classFullName: string): void;
+    /** Export all entity instance types from the source iModel.
+     * @note [[exportSchemas]] must be called separately.
+     */
+    exportAll(): Promise<void>;
+    /** Export changes from the source iModel.
+     * @param user The user
+     * @param startChangesetId Include changes from this changeset up through and including the current changeset.
+     * If this parameter is not provided, then just the current changeset will be exported.
+     * @note To form a range of versions to export, set `startChangesetId` for the start (inclusive) of the desired range and open the source iModel as of the end (inclusive) of the desired range.
+     */
+    exportChanges(user?: AccessToken, startChangesetId?: string): Promise<void>;
+    /** Export schemas from the source iModel.
+     * @note This must be called separately from [[exportAll]] or [[exportChanges]].
+     */
+    exportSchemas(): Promise<void>;
+    /** For logging, indicate the change type if known. */
+    private getChangeOpSuffix;
+    /** Export all CodeSpecs from the source iModel.
+     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     */
+    exportCodeSpecs(): Promise<void>;
+    /** Export a single CodeSpec from the source iModel.
+     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     */
+    exportCodeSpecByName(codeSpecName: string): Promise<void>;
+    /** Export a single CodeSpec from the source iModel.
+     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     */
+    exportCodeSpecById(codeSpecId: Id64String): Promise<void>;
+    /** Export all fonts from the source iModel.
+     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     */
+    exportFonts(): Promise<void>;
+    /** Export a single font from the source iModel.
+     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     */
+    exportFontByName(fontName: string): Promise<void>;
+    /** Export a single font from the source iModel.
+     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     */
+    exportFontByNumber(fontNumber: number): Promise<void>;
+    /** Export the model container, contents, and sub-models from the source iModel.
+     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     */
+    exportModel(modeledElementId: Id64String): Promise<void>;
+    /** Export the model (the container only) from the source iModel. */
+    private exportModelContainer;
+    private _yieldManager;
+    /** Export the model contents.
+     * @param modelId The only required parameter
+     * @param elementClassFullName Can be optionally specified if the goal is to export a subset of the model contents
+     * @param skipRootSubject Decides whether or not to export the root Subject. It is normally left undefined except for internal implementation purposes.
+     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     */
+    exportModelContents(modelId: Id64String, elementClassFullName?: string, skipRootSubject?: boolean): Promise<void>;
+    /** Export the sub-models directly below the specified model.
+     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     */
+    exportSubModels(parentModelId: Id64String): Promise<void>;
+    /** Returns true if the specified element should be exported.
+     * This considers the standard IModelExporter exclusion rules plus calls [IModelExportHandler.shouldExportElement]($transformer) for any custom exclusion rules.
+     * @note This method is called from within [[exportChanges]] and [[exportAll]], so usually does not need to be called directly.
+     */
+    shouldExportElement(element: Element): boolean;
+    /** Export the specified element, its child elements (if applicable), and any owned ElementAspects.
+     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     */
+    exportElement(elementId: Id64String): Promise<void>;
+    /** Export the child elements of the specified element from the source iModel.
+     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     */
+    exportChildElements(elementId: Id64String): Promise<void>;
+    /** Returns `true` if the specified ElementAspect should be exported or `false` if if should be excluded. */
+    private shouldExportElementAspect;
+    /** Export ElementAspects from the specified element from the source iModel. */
+    private exportElementAspects;
+    /** Exports all relationships that subclass from the specified base class.
+     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     */
+    exportRelationships(baseRelClassFullName: string): Promise<void>;
+    /** Export a relationship from the source iModel. */
+    exportRelationship(relClassFullName: string, relInstanceId: Id64String): Promise<void>;
+    /** Tracks incremental progress */
+    private trackProgress;
+    /**
+     * You may override this to store arbitrary json state in a exporter state dump, useful for some resumptions
+     * @see [[IModelTransformer.saveStateToFile]]
+     */
+    protected getAdditionalStateJson(): any;
+    /**
+     * You may override this to load arbitrary json state in a transformer state dump, useful for some resumptions
+     * @see [[IModelTransformer.loadStateFromFile]]
+     */
+    protected loadAdditionalStateJson(_additionalState: any): void;
+    /**
+     * Reload our state from a JSON object
+     * Intended for [[IModelTransformer.resumeTransformation]]
+     * @internal
+     * You can load custom json from the exporter save state for custom exporters by overriding [[IModelExporter.loadAdditionalStateJson]]
+     */
+    loadStateFromJson(state: IModelExporterState): void;
+    /**
+     * Serialize state to a JSON object
+     * Intended for [[IModelTransformer.resumeTransformation]]
+     * @internal
+     * You can add custom json to the exporter save state for custom exporters by overriding [[IModelExporter.getAdditionalStateJson]]
+     */
+    saveStateToJson(): IModelExporterState;
+}
+/**
+ * The JSON format of a serialized IModelExporter instance
+ * Used for starting an exporter in the middle of an export operation,
+ * such as resuming a crashed transformation
+ *
+ * @note Must be kept synchronized with IModelExporter
+ * @internal
+ */
+export interface IModelExporterState {
+    exporterClass: string;
+    wantGeometry: boolean;
+    wantTemplateModels: boolean;
+    wantSystemSchemas: boolean;
+    visitElements: boolean;
+    visitRelationships: boolean;
+    excludedCodeSpecNames: string[];
+    excludedElementIds: CompressedId64Set;
+    excludedElementCategoryIds: CompressedId64Set;
+    excludedElementClassNames: string[];
+    excludedElementAspectClassFullNames: string[];
+    excludedRelationshipClassNames: string[];
+    additionalState?: any;
+}
+/** Class for holding change information.
+ * @beta
+*/
+export declare class ChangedInstanceOps {
+    insertIds: Set<string>;
+    updateIds: Set<string>;
+    deleteIds: Set<string>;
+    /** Initializes the object from IModelJsNative.ChangedInstanceOpsProps. */
+    addFromJson(val: IModelJsNative.ChangedInstanceOpsProps | undefined): void;
+}
+/**
+ * Class for discovering modified elements between 2 versions of an iModel.
+ * @beta
+ */
+export declare class ChangedInstanceIds {
+    codeSpec: ChangedInstanceOps;
+    model: ChangedInstanceOps;
+    element: ChangedInstanceOps;
+    aspect: ChangedInstanceOps;
+    relationship: ChangedInstanceOps;
+    font: ChangedInstanceOps;
+    private constructor();
+    /**
+     * Initializes a new ChangedInstanceIds object with information taken from a range of changesets.
+     * @param accessToken Access token.
+     * @param iModel IModel briefcase whose changesets will be queried.
+     * @param firstChangesetId Changeset id.
+     * @note Modified element information will be taken from a range of changesets. First changeset in a range will be the 'firstChangesetId', the last will be whichever changeset the 'iModel' briefcase is currently opened on.
+     */
+    static initialize(accessToken: AccessToken | undefined, iModel: BriefcaseDb, firstChangesetId: string): Promise<ChangedInstanceIds>;
+}
+//# sourceMappingURL=IModelExporter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IModelExporter.d.ts","sourceRoot":"","sources":["../../src/IModelExporter.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAU,iBAAiB,EAAkB,UAAU,EAAsC,MAAM,qBAAqB,CAAC;AAC7I,OAAO,EAAa,MAAM,EAAE,SAAS,EAAgB,MAAM,0BAA0B,CAAC;AACtF,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAuB,MAAM,oBAAoB,CAAC;AAE9E,OAAO,EACL,WAAW,EAAqD,OAAO,EAAE,aAAa,EACtF,kBAAkB,EAA2B,mBAAmB,EAAoB,QAAQ,EAChF,cAAc,EAAE,KAAK,EAA2B,YAAY,EACzE,MAAM,qBAAqB,CAAC;AAI7B;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,uFAAuF;IACvF,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,8BAAsB,mBAAmB;IACvC;;OAEG;IACI,oBAAoB,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO;IAEzD;;;;OAIG;IACI,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI;IAElF;;;;OAIG;IACI,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI;IAE3E;;;;OAIG;IACI,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI;IAEzE,6CAA6C;IACtC,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,IAAI;IAEhD;;OAEG;IACI,mBAAmB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO;IAEtD;;;;OAIG;IACI,eAAe,CAAC,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI;IAE/E;;;;;OAKG;IACU,gBAAgB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/D,gDAAgD;IACzC,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAEpD;;OAEG;IACI,yBAAyB,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO;IAEjE;;;;OAIG;IACI,2BAA2B,CAAC,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI;IAEtG;;OAEG;IACI,2BAA2B,CAAC,QAAQ,EAAE,kBAAkB,EAAE,GAAG,IAAI;IAExE;;OAEG;IACI,wBAAwB,CAAC,aAAa,EAAE,YAAY,GAAG,OAAO;IAErE;;;;OAIG;IACI,oBAAoB,CAAC,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI;IAE9F,oDAAoD;IAC7C,oBAAoB,CAAC,cAAc,EAAE,UAAU,GAAG,IAAI;IAE7D;;OAEG;IACI,kBAAkB,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO;IAEzD;;;;;OAKG;IACU,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,kBAAkB,CAAC;IAEhF;;;OAGG;IACU,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;CACzC;AAED;;;;GAIG;AACH,qBAAa,cAAc;IACzB,mCAAmC;IACnC,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC;;;;;OAKG;IACI,YAAY,EAAE,OAAO,CAAQ;IACpC;;;OAGG;IACI,kBAAkB,EAAE,OAAO,CAAQ;IAC1C;;;OAGG;IACI,iBAAiB,EAAE,OAAO,CAAQ;IACzC;;OAEG;IACI,aAAa,EAAE,OAAO,CAAQ;IACrC;;OAEG;IACI,kBAAkB,EAAE,OAAO,CAAQ;IAC1C,sHAAsH;IAC/G,gBAAgB,EAAE,MAAM,CAAQ;IACvC,4DAA4D;IAC5D,OAAO,CAAC,gBAAgB,CAAa;IACrC,kDAAkD;IAClD,OAAO,CAAC,gBAAgB,CAAC,CAAqB;IAC9C;;;MAGE;IACF,IAAW,eAAe,IAAI,kBAAkB,GAAG,SAAS,CAE3D;IACD,iDAAiD;IACjD,OAAO,CAAC,QAAQ,CAAkC;IAClD,iDAAiD;IACjD,SAAS,KAAK,OAAO,IAAI,mBAAmB,CAM3C;IAED,uDAAuD;IACvD,OAAO,CAAC,sBAAsB,CAAqB;IACnD,+DAA+D;IAC/D,OAAO,CAAC,mBAAmB,CAAyB;IACpD,uHAAuH;IACvH,OAAO,CAAC,2BAA2B,CAAyB;IAC5D,uHAAuH;IACvH,OAAO,CAAC,uBAAuB,CAA6B;IAC5D,6HAA6H;IAC7H,OAAO,CAAC,6BAA6B,CAAmC;IACxE,mHAAmH;IACnH,OAAO,CAAC,oCAAoC,CAAqB;IACjE,4HAA4H;IAC5H,OAAO,CAAC,4BAA4B,CAAkC;IAEtE;;;OAGG;gBACgB,QAAQ,EAAE,QAAQ;IAIrC,kEAAkE;IAC3D,eAAe,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI;IAI1D,uCAAuC;IAChC,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAIlD,gDAAgD;IACzC,cAAc,CAAC,SAAS,EAAE,UAAU,GAAG,IAAI;IAIlD,kEAAkE;IAC3D,yBAAyB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAI9D,+DAA+D;IACxD,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAIvD,qEAAqE;IAC9D,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAK7D,oEAAoE;IAC7D,wBAAwB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAI5D;;OAEG;IACU,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAOvC;;;;;OAKG;IACU,aAAa,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA8CxF;;OAEG;IACU,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAoC3C,sDAAsD;IACtD,OAAO,CAAC,iBAAiB;IAIzB;;OAEG;IACU,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAW7C;;OAEG;IACU,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAyBtE;;OAEG;IACU,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAKtE;;OAEG;IACU,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAOzC;;OAEG;IACU,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ9D;;OAEG;IACU,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBlE;;OAEG;IACU,WAAW,CAAC,gBAAgB,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBrE,oEAAoE;YACtD,oBAAoB;IAelC,OAAO,CAAC,aAAa,CAAsB;IAE3C;;;;;OAKG;IACU,mBAAmB,CAAC,OAAO,EAAE,UAAU,EAAE,oBAAoB,GAAE,MAA8B,EAAE,eAAe,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAkCrJ;;OAEG;IACU,eAAe,CAAC,aAAa,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BtE;;;OAGG;IACI,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO;IAyBrD;;OAEG;IACU,aAAa,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BhE;;OAEG;IACU,mBAAmB,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IActE,4GAA4G;IAC5G,OAAO,CAAC,yBAAyB;IAWjC,+EAA+E;YACjE,oBAAoB;IAyBlC;;OAEG;IACU,mBAAmB,CAAC,oBAAoB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB7E,oDAAoD;IACvC,kBAAkB,CAAC,gBAAgB,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IA+BnG,kCAAkC;YACpB,aAAa;IAO3B;;;OAGG;IACH,SAAS,CAAC,sBAAsB,IAAI,GAAG;IAIvC;;;OAGG;IACH,SAAS,CAAC,uBAAuB,CAAC,gBAAgB,EAAE,GAAG,GAAG,IAAI;IAE9D;;;;;OAKG;IACI,iBAAiB,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAkB1D;;;;;OAKG;IACI,eAAe,IAAI,mBAAmB;CAiB9C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,aAAa,EAAE,OAAO,CAAC;IACvB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,kBAAkB,EAAE,iBAAiB,CAAC;IACtC,0BAA0B,EAAE,iBAAiB,CAAC;IAC9C,yBAAyB,EAAE,MAAM,EAAE,CAAC;IACpC,mCAAmC,EAAE,MAAM,EAAE,CAAC;IAC9C,8BAA8B,EAAE,MAAM,EAAE,CAAC;IACzC,eAAe,CAAC,EAAE,GAAG,CAAC;CACvB;AAED;;EAEE;AACF,qBAAa,kBAAkB;IACtB,SAAS,cAAyB;IAClC,SAAS,cAAyB;IAClC,SAAS,cAAyB;IAEzC,0EAA0E;IACnE,WAAW,CAAC,GAAG,EAAE,cAAc,CAAC,uBAAuB,GAAG,SAAS,GAAG,IAAI;CAYlF;AAED;;;GAGG;AACH,qBAAa,kBAAkB;IACtB,QAAQ,qBAA4B;IACpC,KAAK,qBAA4B;IACjC,OAAO,qBAA4B;IACnC,MAAM,qBAA4B;IAClC,YAAY,qBAA4B;IACxC,IAAI,qBAA4B;IACvC,OAAO;IAEP;;;;;;OAMG;WACiB,UAAU,CAAC,WAAW,EAAE,WAAW,GAAG,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAsBjJ"}