@itwin/imodel-transformer 2.0.0-dev.8 → 2.0.0-experimental.0

package/lib/cjs/ExportElementAspectsStrategy.js

@@ -1,52 +0,0 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExportElementAspectsStrategy = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const TransformerLoggerCategory_1 = require("./TransformerLoggerCategory");
-const loggerCategory = TransformerLoggerCategory_1.TransformerLoggerCategory.IModelExporter;
-/**
- * Base ElementAspect export strategy. Base export strategy includes state saving and loading and
- * ElementAspect filtering.
- * @internal
- */
-class ExportElementAspectsStrategy {
-    /** The set of classes of ElementAspects that will be excluded (polymorphically) from transformation to the target iModel. */
-    _excludedElementAspectClasses = new Set();
-    /** The set of classFullNames for ElementAspects that will be excluded from transformation to the target iModel. */
-    excludedElementAspectClassFullNames = new Set();
-    sourceDb;
-    aspectChanges;
-    handler;
-    constructor(sourceDb, handler) {
-        this.sourceDb = sourceDb;
-        this.handler = handler;
-    }
-    shouldExportElementAspect(aspect) {
-        for (const excludedElementAspectClass of this
-            ._excludedElementAspectClasses) {
-            if (aspect instanceof excludedElementAspectClass) {
-                core_bentley_1.Logger.logInfo(loggerCategory, `Excluded ElementAspect by class: ${aspect.classFullName}`);
-                return false;
-            }
-        }
-        // ElementAspect has passed standard exclusion rules, now give handler a chance to accept/reject
-        return this.handler.shouldExportElementAspect(aspect);
-    }
-    setAspectChanges(aspectChanges) {
-        this.aspectChanges = aspectChanges;
-    }
-    loadExcludedElementAspectClasses(excludedElementAspectClassFullNames) {
-        this.excludedElementAspectClassFullNames = new Set(excludedElementAspectClassFullNames);
-        this._excludedElementAspectClasses = new Set(excludedElementAspectClassFullNames.map((c) => this.sourceDb.getJsClass(c)));
-    }
-    excludeElementAspectClass(classFullName) {
-        this.excludedElementAspectClassFullNames.add(classFullName); // allows non-polymorphic exclusion before query
-        this._excludedElementAspectClasses.add(this.sourceDb.getJsClass(classFullName)); // allows polymorphic exclusion after query/load
-    }
-}
-exports.ExportElementAspectsStrategy = ExportElementAspectsStrategy;
-//# sourceMappingURL=ExportElementAspectsStrategy.js.map

package/lib/cjs/ExportElementAspectsStrategy.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ExportElementAspectsStrategy.js","sourceRoot":"","sources":["../../src/ExportElementAspectsStrategy.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAQhG,sDAAyD;AACzD,2EAAwE;AAGxE,MAAM,cAAc,GAAG,qDAAyB,CAAC,cAAc,CAAC;AAkBhE;;;;GAIG;AACH,MAAsB,4BAA4B;IAChD,6HAA6H;IACnH,6BAA6B,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC1E,mHAAmH;IACnG,mCAAmC,GAAG,IAAI,GAAG,EAAU,CAAC;IAE9D,QAAQ,CAAW;IAEnB,aAAa,CAAiC;IAE9C,OAAO,CAAwB;IAEzC,YAAmB,QAAkB,EAAE,OAA8B;QACnE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAOS,yBAAyB,CAAC,MAAqB;QACvD,KAAK,MAAM,0BAA0B,IAAI,IAAI;aAC1C,6BAA6B,EAAE,CAAC;YACjC,IAAI,MAAM,YAAY,0BAA0B,EAAE,CAAC;gBACjD,qBAAM,CAAC,OAAO,CACZ,cAAc,EACd,oCAAoC,MAAM,CAAC,aAAa,EAAE,CAC3D,CAAC;gBACF,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QACD,gGAAgG;QAChG,OAAO,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAEM,gBAAgB,CAAC,aAAkC;QACxD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAEM,gCAAgC,CACrC,mCAA6C;QAE5C,IAAI,CAAC,mCAA2C,GAAG,IAAI,GAAG,CACzD,mCAAmC,CACpC,CAAC;QACF,IAAI,CAAC,6BAA6B,GAAG,IAAI,GAAG,CAC1C,mCAAmC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC5C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAC5B,CACF,CAAC;IACJ,CAAC;IAEM,yBAAyB,CAAC,aAAqB;QACpD,IAAI,CAAC,mCAAmC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,gDAAgD;QAC7G,IAAI,CAAC,6BAA6B,CAAC,GAAG,CACpC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAuB,aAAa,CAAC,CAC9D,CAAC,CAAC,gDAAgD;IACrD,CAAC;CACF;AA5DD,oEA4DC","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\nimport {\n  ElementAspect,\n  ElementMultiAspect,\n  ElementUniqueAspect,\n  IModelDb,\n} from \"@itwin/core-backend\";\nimport { Id64String, Logger } from \"@itwin/core-bentley\";\nimport { TransformerLoggerCategory } from \"./TransformerLoggerCategory\";\nimport { ChangedInstanceOps } from \"./IModelExporter\";\n\nconst loggerCategory = TransformerLoggerCategory.IModelExporter;\n\n/**\n * Handler for [[ExportElementAspectsStrategy]]\n * @internal\n */\nexport interface ElementAspectsHandler {\n  shouldExportElementAspect(aspect: ElementAspect): boolean;\n  onExportElementUniqueAspect(\n    uniqueAspect: ElementUniqueAspect,\n    isUpdate?: boolean | undefined\n  ): Promise<void>;\n  onExportElementMultiAspects(\n    multiAspects: ElementMultiAspect[]\n  ): Promise<void>;\n  trackProgress: () => Promise<void>;\n}\n\n/**\n * Base ElementAspect export strategy. Base export strategy includes state saving and loading and\n * ElementAspect filtering.\n * @internal\n */\nexport abstract class ExportElementAspectsStrategy {\n  /** The set of classes of ElementAspects that will be excluded (polymorphically) from transformation to the target iModel. */\n  protected _excludedElementAspectClasses = new Set<typeof ElementAspect>();\n  /** The set of classFullNames for ElementAspects that will be excluded from transformation to the target iModel. */\n  public readonly excludedElementAspectClassFullNames = new Set<string>();\n\n  protected sourceDb: IModelDb;\n\n  protected aspectChanges: ChangedInstanceOps | undefined;\n\n  protected handler: ElementAspectsHandler;\n\n  public constructor(sourceDb: IModelDb, handler: ElementAspectsHandler) {\n    this.sourceDb = sourceDb;\n    this.handler = handler;\n  }\n\n  public abstract exportElementAspectsForElement(\n    _elementId: Id64String\n  ): Promise<void>;\n  public abstract exportAllElementAspects(): Promise<void>;\n\n  protected shouldExportElementAspect(aspect: ElementAspect): boolean {\n    for (const excludedElementAspectClass of this\n      ._excludedElementAspectClasses) {\n      if (aspect instanceof excludedElementAspectClass) {\n        Logger.logInfo(\n          loggerCategory,\n          `Excluded ElementAspect by class: ${aspect.classFullName}`\n        );\n        return false;\n      }\n    }\n    // ElementAspect has passed standard exclusion rules, now give handler a chance to accept/reject\n    return this.handler.shouldExportElementAspect(aspect);\n  }\n\n  public setAspectChanges(aspectChanges?: ChangedInstanceOps) {\n    this.aspectChanges = aspectChanges;\n  }\n\n  public loadExcludedElementAspectClasses(\n    excludedElementAspectClassFullNames: string[]\n  ): void {\n    (this.excludedElementAspectClassFullNames as any) = new Set(\n      excludedElementAspectClassFullNames\n    );\n    this._excludedElementAspectClasses = new Set(\n      excludedElementAspectClassFullNames.map((c) =>\n        this.sourceDb.getJsClass(c)\n      )\n    );\n  }\n\n  public excludeElementAspectClass(classFullName: string): void {\n    this.excludedElementAspectClassFullNames.add(classFullName); // allows non-polymorphic exclusion before query\n    this._excludedElementAspectClasses.add(\n      this.sourceDb.getJsClass<typeof ElementAspect>(classFullName)\n    ); // allows polymorphic exclusion after query/load\n  }\n}\n"]}

package/lib/cjs/ExportElementAspectsWithElementsStrategy.d.ts

@@ -1,12 +0,0 @@
-import { Id64String } from "@itwin/core-bentley";
-import { ExportElementAspectsStrategy } from "./ExportElementAspectsStrategy";
-/**
- * ElementAspect export strategy for [[IModelExporter]].
- * This strategy exports ElementAspects together with their Elements.
- * @internal
- */
-export declare class ExportElementAspectsWithElementsStrategy extends ExportElementAspectsStrategy {
-    exportElementAspectsForElement(elementId: Id64String): Promise<void>;
-    exportAllElementAspects(): Promise<void>;
-}
-//# sourceMappingURL=ExportElementAspectsWithElementsStrategy.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"ExportElementAspectsWithElementsStrategy.d.ts","sourceRoot":"","sources":["../../src/ExportElementAspectsWithElementsStrategy.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAE9E;;;;GAIG;AACH,qBAAa,wCAAyC,SAAQ,4BAA4B;IAClE,8BAA8B,CAClD,SAAS,EAAE,UAAU,GACpB,OAAO,CAAC,IAAI,CAAC;IA6CM,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC;CAG/D"}

package/lib/cjs/ExportElementAspectsWithElementsStrategy.js

@@ -1,47 +0,0 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExportElementAspectsWithElementsStrategy = void 0;
-const core_backend_1 = require("@itwin/core-backend");
-const ExportElementAspectsStrategy_1 = require("./ExportElementAspectsStrategy");
-/**
- * ElementAspect export strategy for [[IModelExporter]].
- * This strategy exports ElementAspects together with their Elements.
- * @internal
- */
-class ExportElementAspectsWithElementsStrategy extends ExportElementAspectsStrategy_1.ExportElementAspectsStrategy {
-    async exportElementAspectsForElement(elementId) {
-        const _uniqueAspects = await Promise.all(this.sourceDb.elements
-            ._queryAspects(elementId, core_backend_1.ElementUniqueAspect.classFullName, this.excludedElementAspectClassFullNames)
-            .filter((a) => this.shouldExportElementAspect(a))
-            .map(async (uniqueAspect) => {
-            const isInsertChange = this.aspectChanges?.insertIds.has(uniqueAspect.id) ?? false;
-            const isUpdateChange = this.aspectChanges?.updateIds.has(uniqueAspect.id) ?? false;
-            const doExport = this.aspectChanges === undefined ||
-                isInsertChange ||
-                isUpdateChange;
-            if (doExport) {
-                const isKnownUpdate = this.aspectChanges
-                    ? isUpdateChange
-                    : undefined;
-                await this.handler.onExportElementUniqueAspect(uniqueAspect, isKnownUpdate);
-                await this.handler.trackProgress();
-            }
-        }));
-        const multiAspects = this.sourceDb.elements
-            ._queryAspects(elementId, core_backend_1.ElementMultiAspect.classFullName, this.excludedElementAspectClassFullNames)
-            .filter((a) => this.shouldExportElementAspect(a));
-        if (multiAspects.length > 0) {
-            await this.handler.onExportElementMultiAspects(multiAspects);
-            return this.handler.trackProgress();
-        }
-    }
-    async exportAllElementAspects() {
-        // All aspects are exported with their owning elements and don't need to be exported separately.
-    }
-}
-exports.ExportElementAspectsWithElementsStrategy = ExportElementAspectsWithElementsStrategy;
-//# sourceMappingURL=ExportElementAspectsWithElementsStrategy.js.map

package/lib/cjs/ExportElementAspectsWithElementsStrategy.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ExportElementAspectsWithElementsStrategy.js","sourceRoot":"","sources":["../../src/ExportElementAspectsWithElementsStrategy.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,sDAA8E;AAE9E,iFAA8E;AAE9E;;;;GAIG;AACH,MAAa,wCAAyC,SAAQ,2DAA4B;IACxE,KAAK,CAAC,8BAA8B,CAClD,SAAqB;QAErB,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,GAAG,CACtC,IAAI,CAAC,QAAQ,CAAC,QAAQ;aACnB,aAAa,CACZ,SAAS,EACT,kCAAmB,CAAC,aAAa,EACjC,IAAI,CAAC,mCAAmC,CACzC;aACA,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;aAChD,GAAG,CAAC,KAAK,EAAE,YAAiC,EAAE,EAAE;YAC/C,MAAM,cAAc,GAClB,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC;YAC9D,MAAM,cAAc,GAClB,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC;YAC9D,MAAM,QAAQ,GACZ,IAAI,CAAC,aAAa,KAAK,SAAS;gBAChC,cAAc;gBACd,cAAc,CAAC;YACjB,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa;oBACtC,CAAC,CAAC,cAAc;oBAChB,CAAC,CAAC,SAAS,CAAC;gBACd,MAAM,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAC5C,YAAY,EACZ,aAAa,CACd,CAAC;gBACF,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YACrC,CAAC;QACH,CAAC,CAAC,CACL,CAAC;QAEF,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ;aACxC,aAAa,CACZ,SAAS,EACT,iCAAkB,CAAC,aAAa,EAChC,IAAI,CAAC,mCAAmC,CACzC;aACA,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,CAAC;QAEpD,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;QACtC,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,uBAAuB;QAC3C,gGAAgG;IAClG,CAAC;CACF;AAnDD,4FAmDC","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\nimport { ElementMultiAspect, ElementUniqueAspect } from \"@itwin/core-backend\";\nimport { Id64String } from \"@itwin/core-bentley\";\nimport { ExportElementAspectsStrategy } from \"./ExportElementAspectsStrategy\";\n\n/**\n * ElementAspect export strategy for [[IModelExporter]].\n * This strategy exports ElementAspects together with their Elements.\n * @internal\n */\nexport class ExportElementAspectsWithElementsStrategy extends ExportElementAspectsStrategy {\n  public override async exportElementAspectsForElement(\n    elementId: Id64String\n  ): Promise<void> {\n    const _uniqueAspects = await Promise.all(\n      this.sourceDb.elements\n        ._queryAspects(\n          elementId,\n          ElementUniqueAspect.classFullName,\n          this.excludedElementAspectClassFullNames\n        )\n        .filter((a) => this.shouldExportElementAspect(a))\n        .map(async (uniqueAspect: ElementUniqueAspect) => {\n          const isInsertChange =\n            this.aspectChanges?.insertIds.has(uniqueAspect.id) ?? false;\n          const isUpdateChange =\n            this.aspectChanges?.updateIds.has(uniqueAspect.id) ?? false;\n          const doExport =\n            this.aspectChanges === undefined ||\n            isInsertChange ||\n            isUpdateChange;\n          if (doExport) {\n            const isKnownUpdate = this.aspectChanges\n              ? isUpdateChange\n              : undefined;\n            await this.handler.onExportElementUniqueAspect(\n              uniqueAspect,\n              isKnownUpdate\n            );\n            await this.handler.trackProgress();\n          }\n        })\n    );\n\n    const multiAspects = this.sourceDb.elements\n      ._queryAspects(\n        elementId,\n        ElementMultiAspect.classFullName,\n        this.excludedElementAspectClassFullNames\n      )\n      .filter((a) => this.shouldExportElementAspect(a));\n\n    if (multiAspects.length > 0) {\n      await this.handler.onExportElementMultiAspects(multiAspects);\n      return this.handler.trackProgress();\n    }\n  }\n\n  public override async exportAllElementAspects(): Promise<void> {\n    // All aspects are exported with their owning elements and don't need to be exported separately.\n  }\n}\n"]}