@itwin/imodel-transformer 2.0.0-dev.10 → 2.0.0-dev.12

package/lib/cjs/IModelExporter.js

@@ -26,7 +26,7 @@ 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) {
+    async shouldExportCodeSpec(_codeSpec) {
         return true;
     }
     /** Called when a CodeSpec should be exported.
@@ -34,31 +34,31 @@ class IModelExportHandler {
      * @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, _isUpdate) { }
+    async onExportCodeSpec(_codeSpec, _isUpdate) { }
     /** 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, _isUpdate) { }
+    async onExportFont(_font, _isUpdate) { }
     /** 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, _isUpdate) { }
+    async onExportModel(_model, _isUpdate) { }
     /** Called when a model should be deleted. */
     async onDeleteModel(_modelId) { }
     /** 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) {
+    async shouldExportElement(_element) {
         return true;
     }
     /** Called when element is skipped instead of exported.
      * @note When an element is skipped, exporter will not export any of its child elements. Because of this, [[onSkipElement]] will not be invoked for any children of a "skipped" element.
      */
-    onSkipElement(_elementId) { }
+    async onSkipElement(_elementId) { }
     /** 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.
@@ -73,11 +73,11 @@ class IModelExportHandler {
      */
     async preExportElement(_element) { }
     /** Called when an element should be deleted. */
-    onDeleteElement(_elementId) { }
+    async onDeleteElement(_elementId) { }
     /** 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) {
+    async shouldExportElementAspect(_aspect) {
         return true;
     }
     /** Called when an ElementUniqueAspect should be exported.
@@ -93,7 +93,7 @@ class IModelExportHandler {
     /** 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) {
+    async shouldExportRelationship(_relationship) {
         return true;
     }
     /** Called when a Relationship should be exported.
@@ -103,11 +103,11 @@ class IModelExportHandler {
      */
     async onExportRelationship(_relationship, _isUpdate) { }
     /** Called when a relationship should be deleted. */
-    onDeleteRelationship(_relInstanceId) { }
+    async onDeleteRelationship(_relInstanceId) { }
     /** 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) {
+    async shouldExportSchema(_schemaKey) {
         return true;
     }
     /** Called when a schema should be exported.
@@ -200,7 +200,7 @@ class IModelExporter {
         this._exportElementAspectsStrategy = new elementAspectsStrategy(this.sourceDb, {
             onExportElementMultiAspects: async (aspects) => this.handler.onExportElementMultiAspects(aspects),
             onExportElementUniqueAspect: async (aspect, isUpdate) => this.handler.onExportElementUniqueAspect(aspect, isUpdate),
-            shouldExportElementAspect: (aspect) => this.handler.shouldExportElementAspect(aspect),
+            shouldExportElementAspect: async (aspect) => this.handler.shouldExportElementAspect(aspect),
             trackProgress: async () => this.trackProgress(),
         });
     }
@@ -307,7 +307,7 @@ class IModelExporter {
                 // In the future, the handler may be responsible for doing the work of finding out which elements were cascade deleted,
                 // and returning them for the exporter to use to avoid double-deleting with error ignoring
                 try {
-                    this.handler.onDeleteElement(elementId);
+                    await this.handler.onDeleteElement(elementId);
                 }
                 catch (err) {
                     const isMissingErr = err instanceof core_common_1.IModelError &&
@@ -320,7 +320,7 @@ class IModelExporter {
         if (this.visitRelationships) {
             for (const relInstanceId of this._sourceDbChanges.relationship
                 .deleteIds) {
-                this.handler.onDeleteRelationship(relInstanceId);
+                await this.handler.onDeleteRelationship(relInstanceId);
             }
         }
         // Enable consecutive exportChanges runs without the need to re-instantiate the exporter.
@@ -354,7 +354,7 @@ class IModelExporter {
             const versionWrite = row[2];
             const versionMinor = row[3];
             const schemaKey = new ecschema_metadata_1.SchemaKey(schemaName, new ecschema_metadata_1.ECVersion(versionMajor, versionWrite, versionMinor));
-            if (this.handler.shouldExportSchema(schemaKey)) {
+            if (await this.handler.shouldExportSchema(schemaKey)) {
                 schemaKeysToExport.push(schemaKey);
             }
         }
@@ -409,9 +409,9 @@ class IModelExporter {
             return;
         }
         // CodeSpec has passed standard exclusion rules, now give handler a chance to accept/reject export
-        if (this.handler.shouldExportCodeSpec(codeSpec)) {
+        if (await this.handler.shouldExportCodeSpec(codeSpec)) {
             core_bentley_1.Logger.logTrace(loggerCategory, `exportCodeSpec(${codeSpecName})${this.getChangeOpSuffix(isUpdate)}`);
-            this.handler.onExportCodeSpec(codeSpec, isUpdate);
+            await this.handler.onExportCodeSpec(codeSpec, isUpdate);
             return this.trackProgress();
         }
     }
@@ -449,7 +449,7 @@ class IModelExporter {
      */
     async exportFontByFontProps(fontProps) {
         core_bentley_1.Logger.logTrace(loggerCategory, `exportFontByFamily(${fontProps.name}, ${fontProps.type})`);
-        this.handler.onExportFont(fontProps, true);
+        await this.handler.onExportFont(fontProps, true);
         return this.trackProgress();
     }
     /** Export a single font from the source iModel.
@@ -491,7 +491,7 @@ class IModelExporter {
             wantBRepData: this.wantGeometry,
         });
         core_bentley_1.Logger.logTrace(loggerCategory, `exportModel(${modeledElementId})`);
-        if (this.shouldExportElement(modeledElement)) {
+        if (await this.shouldExportElement(modeledElement)) {
             await this.exportModelContainer(model);
             if (this.visitElements) {
                 await this.exportModelContents(modeledElementId);
@@ -514,7 +514,7 @@ class IModelExporter {
                 return; // not in changeset, don't export
             }
         }
-        this.handler.onExportModel(model, isUpdate);
+        await this.handler.onExportModel(model, isUpdate);
         return this.trackProgress();
     }
     _yieldManager = new core_bentley_1.YieldManager();
@@ -593,7 +593,7 @@ class IModelExporter {
      * 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) {
+    async shouldExportElement(element) {
         if (this._excludedElementIds.has(element.id)) {
             core_bentley_1.Logger.logInfo(loggerCategory, `Excluded element ${element.id} by Id`);
             return false;
@@ -629,7 +629,7 @@ class IModelExporter {
         // Return early if the elementId is already in the excludedElementIds, that way we don't need to load the element from the db.
         if (this._excludedElementIds.has(elementId)) {
             core_bentley_1.Logger.logInfo(loggerCategory, `Excluded element ${elementId} by Id`);
-            this.handler.onSkipElement(elementId);
+            await this.handler.onSkipElement(elementId);
             return;
         }
         // are we processing changes?
@@ -645,7 +645,7 @@ class IModelExporter {
         });
         core_bentley_1.Logger.logTrace(loggerCategory, `exportElement(${element.id}, "${element.getDisplayLabel()}")${this.getChangeOpSuffix(isUpdate)}`);
         // the order and `await`ing of calls beyond here is depended upon by the IModelTransformer for a current bug workaround
-        if (this.shouldExportElement(element)) {
+        if (await this.shouldExportElement(element)) {
             await this.handler.preExportElement(element);
             await this.handler.onExportElement(element, isUpdate);
             await this.trackProgress();
@@ -653,7 +653,7 @@ class IModelExporter {
             return this.exportChildElements(elementId);
         }
         else {
-            this.handler.onSkipElement(element.id);
+            await this.handler.onSkipElement(element.id);
         }
     }
     /** Export the child elements of the specified element from the source iModel.
@@ -728,7 +728,7 @@ class IModelExporter {
             }
         }
         // relationship has passed standard exclusion rules, now give handler a chance to accept/reject export
-        if (this.handler.shouldExportRelationship(relationship)) {
+        if (await this.handler.shouldExportRelationship(relationship)) {
             await this.handler.onExportRelationship(relationship, isUpdate);
             await this.trackProgress();
         }