@itwin/imodel-transformer 2.0.0-dev.34 → 2.0.0-dev.36

package/lib/cjs/IModelTransformer.js

@@ -80,8 +80,12 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
     sourceDb;
     /** The read/write target iModel. */
     targetDb;
-    /** The IModelTransformContext for this IModelTransformer. */
-    context;
+    /** The supported transformation context for this transformer. */
+    get context() {
+        return this._cloneContext;
+    }
+    /** The clone context used by the transformer implementation. */
+    _cloneContext;
     /** The transform to be applied to the placement of spatial elements
      * This transform should be applied when:
      * - source and target db have different ECEF locations
@@ -196,8 +200,9 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
         this.targetDb = this.importer.targetDb;
         this._targetEditTxn = this.importer.editTxn;
         this._sourceEditTxn = options?.sourceEditTxn;
+        this.exporter.elementAspectExportCoordinator.setPreparation(async (excludedClasses, elementIds) => this.prepareElementAspects(excludedClasses, elementIds));
         // create the IModelCloneContext, it must be initialized later
-        this.context = new IModelCloneContext_1.IModelCloneContext(this.sourceDb, this.targetDb);
+        this._cloneContext = new IModelCloneContext_1.IModelCloneContext(this.sourceDb, this.targetDb);
         // this internal is guaranteed stable for just transformer usage
         /* eslint-disable @itwin/no-internal */
         if (("codeValueBehavior" in this.sourceDb)) {
@@ -205,8 +210,8 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
             this.targetDb.codeValueBehavior = "exact";
         }
         /* eslint-enable @itwin/no-internal */
-        this._syncTypeResolver = new SyncTypeResolver_1.SyncTypeResolver(this.context, this._options.targetScopeElementId, !!this._isProvenanceInitTransform, !!this._options.argsForProcessChanges);
-        this._provenanceManager = new ProvenanceManager_1.ProvenanceManager(this._options.targetScopeElementId, this._options, this._syncTypeResolver, this._targetEditTxn, this._sourceEditTxn);
+        this._syncTypeResolver = new SyncTypeResolver_1.SyncTypeResolver(this.sourceDb, this.targetDb, this._options.targetScopeElementId, !!this._isProvenanceInitTransform, !!this._options.argsForProcessChanges);
+        this._provenanceManager = new ProvenanceManager_1.ProvenanceManager(this._options.targetScopeElementId, this._options, this._cloneContext, this._syncTypeResolver, this._targetEditTxn, this._sourceEditTxn);
         if (this._options.tryAlignGeolocation) {
             if (this.sourceDb.geographicCoordinateSystem ||
                 this.targetDb.geographicCoordinateSystem) {
@@ -250,7 +255,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
     /** Dispose any native resources associated with this IModelTransformer. */
     dispose() {
         core_bentley_1.Logger.logTrace(loggerCategory, "dispose()");
-        this.context[Symbol.dispose]();
+        this._cloneContext[Symbol.dispose]();
     }
     /** Log current settings that affect IModelTransformer's behavior. */
     logSettings() {
@@ -347,7 +352,9 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
      */
     async onTransformElement(sourceElement) {
         core_bentley_1.Logger.logTrace(loggerCategory, `onTransformElement(${sourceElement.id}) "${sourceElement.getDisplayLabel()}"`);
-        const targetElementProps = await this.context.cloneElement(sourceElement, { binaryGeometry: this._options.cloneUsingBinaryGeometry });
+        const targetElementProps = await this._cloneContext.cloneElement(sourceElement, {
+            binaryGeometry: this._options.cloneUsingBinaryGeometry,
+        });
         // Special case: source element is the root subject
         if (sourceElement.id === core_common_1.IModel.rootSubjectId) {
             const targetElementId = this.context.findTargetElementId(sourceElement.id);
@@ -592,7 +599,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
                 message: "The root Subject should not be directly imported",
             });
         }
-        return this.exporter.exportElement(sourceElementId);
+        return this.processScopedElementExport(async () => this.exporter.exportElement(sourceElementId));
     }
     /** Import child elements into the target IModelDb
      * @param sourceElementId Import the child elements of this element in the source IModelDb.
@@ -600,7 +607,10 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
      */
     async processChildElements(sourceElementId) {
         await this.initialize();
-        return this.exporter.exportChildElements(sourceElementId);
+        return this.processScopedElementExport(async () => this.exporter.exportChildElements(sourceElementId));
+    }
+    async processScopedElementExport(exportElements) {
+        await this.exporter.elementAspectExportCoordinator.run(exportElements);
     }
     /** Override of [IModelExportHandler.shouldExportElement]($transformer) that is called to determine if an element should be exported from the source iModel.
      * @note Reaching this point means that the element has passed the standard exclusion checks in IModelExporter.
@@ -927,7 +937,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
      */
     async processModel(sourceModeledElementId) {
         await this.initialize();
-        return this.exporter.exportModel(sourceModeledElementId);
+        return this.processScopedElementExport(async () => this.exporter.exportModel(sourceModeledElementId));
     }
     /** Cause the model contents to be exported from the source iModel and imported into the target iModel.
      * @param sourceModelId Import the contents of this model from the source IModelDb.
@@ -939,7 +949,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
         await this.initialize();
         this.targetDb.models.getModel(targetModelId); // throws if Model does not exist
         this.context.remapElement(sourceModelId, targetModelId); // set remapping in case importModelContents is called directly
-        return this.exporter.exportModelContents(sourceModelId, elementClassFullName);
+        return this.processScopedElementExport(async () => this.exporter.exportModelContents(sourceModelId, elementClassFullName));
     }
     /** Cause all sub-models that recursively descend from the specified Subject to be exported from the source iModel and imported into the target iModel. */
     async processSubjectSubModels(sourceSubjectId) {
@@ -1107,10 +1117,24 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
         return targetRelationshipProps;
     }
     async shouldExportElementAspect(aspect) {
-        // This override is needed to ensure that aspects are not exported if their element is not exported.
-        // This is needed in case DetachedExportElementAspectsStrategy is used.
+        // An aspect cannot be exported when its owner has no source-to-target
+        // mapping.
         return this.context.findTargetElementId(aspect.element.id) !== core_bentley_1.Id64.invalid;
     }
+    async prepareElementAspects(excludedElementAspectClassFullNames, elementIds) {
+        if (!this.exporter.visitElements)
+            return;
+        if (elementIds === undefined)
+            return;
+        const targetElementIds = new Set();
+        for (const sourceElementId of elementIds) {
+            const targetElementId = this.context.findTargetElementId(sourceElementId);
+            if (core_bentley_1.Id64.isValid(targetElementId)) {
+                targetElementIds.add(targetElementId);
+            }
+        }
+        await this.importer.elementAspectCleanup.delete(targetElementIds, excludedElementAspectClassFullNames, this.targetScopeElementId);
+    }
     /** Override of [IModelExportHandler.onExportElementUniqueAspect]($transformer) that imports an ElementUniqueAspect into the target iModel when it is exported from the source iModel.
      * This override calls [[onTransformElementAspect]] and then [IModelImporter.importElementUniqueAspect]($transformer) to update the target iModel.
      */
@@ -1151,7 +1175,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
      * @note A subclass can override this method to provide custom transform behavior.
      */
     async onTransformElementAspect(sourceElementAspect) {
-        const targetElementAspectProps = await this.context.cloneElementAspect(sourceElementAspect);
+        const targetElementAspectProps = await this._cloneContext.cloneElementAspect(sourceElementAspect);
         return targetElementAspectProps;
     }
     /** The directory where schemas will be exported, a random temporary directory */
@@ -1246,7 +1270,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
     }
     /** Override of [IModelExportHandler.onExportFont]($transformer) that imports a font into the target iModel when it is exported from the source iModel. */
     async onExportFont(font, _isUpdate) {
-        this.context.importFont(font.id);
+        this._cloneContext.importFont(font.id);
     }
     /** Cause all CodeSpecs to be exported from the source iModel and imported into the target iModel.
      * @note This method is called from [[process]], so it only needs to be called directly when processing a subset of an iModel.
@@ -1270,7 +1294,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
     }
     /** Override of [IModelExportHandler.onExportCodeSpec]($transformer) that imports a CodeSpec into the target iModel when it is exported from the source iModel. */
     async onExportCodeSpec(sourceCodeSpec) {
-        this.context.importCodeSpec(sourceCodeSpec.id);
+        this._cloneContext.importCodeSpec(sourceCodeSpec.id);
     }
     /** Recursively import all Elements and sub-Models that descend from the specified Subject */
     async processSubject(sourceSubjectId, targetSubjectId) {
@@ -1278,8 +1302,10 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
         this.sourceDb.elements.getElement(sourceSubjectId, core_backend_1.Subject); // throws if sourceSubjectId is not a Subject
         this.targetDb.elements.getElement(targetSubjectId, core_backend_1.Subject); // throws if targetSubjectId is not a Subject
         this.context.remapElement(sourceSubjectId, targetSubjectId);
-        await this.processChildElements(sourceSubjectId);
-        await this.processSubjectSubModels(sourceSubjectId);
+        await this.processScopedElementExport(async () => {
+            await this.processChildElements(sourceSubjectId);
+            await this.processSubjectSubModels(sourceSubjectId);
+        });
         await this.completePartiallyCommittedElements();
         await this.completePartiallyCommittedAspects();
     }
@@ -1301,7 +1327,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
         this.assertEditTxnActive();
         await this.initScopeProvenance();
         await this._tryInitChangesetData(this._options.argsForProcessChanges);
-        await this.context.initialize();
+        await this._cloneContext.initialize();
         const exporterInitOptions = await this.getExportInitOpts(this._options.argsForProcessChanges ?? {});
         await this.initializeChangesetScanAndExporter(exporterInitOptions);
         // Exporter must be initialized prior to processing changesets in order to properly handle entity recreations (an entity delete followed by an insert of that same entity).
@@ -1653,17 +1679,18 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
         this._sourceChangeDataState = "has-changes";
         await this.exporter.exportCodeSpecs();
         await this.exporter.exportFonts();
-        if (this._options.skipPropagateChangesToRootElements) {
-            // The RepositoryModel and root Subject of the target iModel should not be transformed.
-            await this.exporter.exportChildElements(core_common_1.IModel.rootSubjectId); // start below the root Subject
-            await this.exporter.exportModelContents(core_common_1.IModel.repositoryModelId, core_backend_1.Element.classFullName, true); // after the Subject hierarchy, process the other elements of the RepositoryModel
-            await this.exporter.exportSubModels(core_common_1.IModel.repositoryModelId); // start below the RepositoryModel
-        }
-        else {
-            await this.exporter.exportModel(core_common_1.IModel.repositoryModelId);
-        }
-        await this.completePartiallyCommittedElements();
-        await this.exporter["exportAllAspects"](); // eslint-disable-line @typescript-eslint/dot-notation
+        await this.exporter.elementAspectExportCoordinator.run(async () => {
+            if (this._options.skipPropagateChangesToRootElements) {
+                // The RepositoryModel and root Subject of the target iModel should not be transformed.
+                await this.exporter.exportChildElements(core_common_1.IModel.rootSubjectId); // start below the root Subject
+                await this.exporter.exportModelContents(core_common_1.IModel.repositoryModelId, core_backend_1.Element.classFullName, true); // after the Subject hierarchy, process the other elements of the RepositoryModel
+                await this.exporter.exportSubModels(core_common_1.IModel.repositoryModelId); // start below the RepositoryModel
+            }
+            else {
+                await this.exporter.exportModel(core_common_1.IModel.repositoryModelId);
+            }
+            await this.completePartiallyCommittedElements();
+        });
         await this.completePartiallyCommittedAspects();
         await this.exporter.exportRelationships(core_backend_1.ElementRefersToElements.classFullName);
         if (this._options.forceExternalSourceAspectProvenance &&