@itwin/imodel-transformer 2.0.0-dev.7 → 2.0.0-dev.71

package/lib/cjs/ElementAspectExportCoordinator.js

@@ -0,0 +1,148 @@
+"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.ElementAspectExportCoordinator = void 0;
+/** Coordinates scoped batches of accepted ElementAspect owners, including preparation before aspect export.
+ * @internal
+ */
+class ElementAspectExportCoordinator {
+    _defaultBatchSize;
+    _excludedClassFullNames;
+    _exportAspects;
+    _resetCaches;
+    _acceptedOwnerIds = new Set();
+    _processedOwnerIds = new Set();
+    _batchSize;
+    _depth = 0;
+    _prepare;
+    constructor(_defaultBatchSize, _excludedClassFullNames, _exportAspects, _resetCaches = () => { }) {
+        this._defaultBatchSize = _defaultBatchSize;
+        this._excludedClassFullNames = _excludedClassFullNames;
+        this._exportAspects = _exportAspects;
+        this._resetCaches = _resetCaches;
+        this._batchSize = _defaultBatchSize;
+    }
+    /** Whether an accepted-owner collection scope is active. */
+    get isActive() {
+        return this._depth > 0;
+    }
+    /** Sets the callback that prepares each accepted-owner group before its aspects are exported. */
+    setPreparation(prepare) {
+        this._prepare = prepare;
+    }
+    /** Begins an accepted-owner collection scope.
+     * Nested scopes share the outer scope's state and batch size.
+     */
+    begin(batchSize = this._defaultBatchSize) {
+        if (this._depth === 0) {
+            this.resetScopeState();
+            this._resetCaches();
+            this._batchSize = batchSize;
+        }
+        this._depth++;
+    }
+    /** Ends an accepted-owner collection scope.
+     * Ending the outermost scope exports pending owners and resets all scope state.
+     */
+    async end() {
+        if (this._depth === 0) {
+            throw new Error("No scoped element export is active.");
+        }
+        this._depth--;
+        if (this._depth > 0)
+            return;
+        try {
+            if (this._acceptedOwnerIds.size > 0) {
+                await this.flush();
+            }
+        }
+        finally {
+            this.reset();
+        }
+    }
+    /** Discards the active scope and its pending owner state without exporting it. */
+    abort() {
+        this.reset();
+    }
+    /** Runs element export within an accepted-owner collection scope.
+     * A scope created by this call is aborted if element export fails; an existing outer scope remains responsible for its own failure handling.
+     */
+    async run(exportElements) {
+        if (this.isActive) {
+            await exportElements();
+            return;
+        }
+        this.begin();
+        try {
+            await exportElements();
+        }
+        catch (error) {
+            this.abort();
+            throw error;
+        }
+        await this.end();
+    }
+    /** Adds an accepted source owner to the current group and exports the group when it reaches the configured batch size. */
+    async addAcceptedOwner(elementId) {
+        if (!this.isActive || this._processedOwnerIds.has(elementId))
+            return;
+        this._acceptedOwnerIds.add(elementId);
+        if (this._acceptedOwnerIds.size >= this._batchSize) {
+            await this.flush();
+        }
+    }
+    /** Runs preparation and aspect export for an explicit owner set in bounded groups. */
+    async exportOwners(ownerElementIds) {
+        let ownerIds = ownerElementIds;
+        if (this.isActive && ownerElementIds.size > 0) {
+            const unprocessedOwnerIds = new Set();
+            for (const elementId of ownerElementIds) {
+                if (!this._processedOwnerIds.has(elementId)) {
+                    unprocessedOwnerIds.add(elementId);
+                    this._processedOwnerIds.add(elementId);
+                }
+            }
+            if (unprocessedOwnerIds.size === 0)
+                return;
+            ownerIds = unprocessedOwnerIds;
+        }
+        if (ownerIds.size <= this._defaultBatchSize) {
+            await this.exportOwnerBatch(ownerIds);
+            return;
+        }
+        let ownerBatch = new Set();
+        for (const elementId of ownerIds) {
+            ownerBatch.add(elementId);
+            if (ownerBatch.size === this._defaultBatchSize) {
+                await this.exportOwnerBatch(ownerBatch);
+                ownerBatch = new Set();
+            }
+        }
+        if (ownerBatch.size > 0) {
+            await this.exportOwnerBatch(ownerBatch);
+        }
+    }
+    async exportOwnerBatch(ownerElementIds) {
+        await this._prepare?.(this._excludedClassFullNames(), ownerElementIds);
+        await this._exportAspects(ownerElementIds);
+    }
+    async flush() {
+        const ownerElementIds = new Set(this._acceptedOwnerIds);
+        this._acceptedOwnerIds.clear();
+        await this.exportOwners(ownerElementIds);
+    }
+    resetScopeState() {
+        this._acceptedOwnerIds.clear();
+        this._processedOwnerIds.clear();
+    }
+    reset() {
+        this._depth = 0;
+        this.resetScopeState();
+        this._batchSize = this._defaultBatchSize;
+    }
+}
+exports.ElementAspectExportCoordinator = ElementAspectExportCoordinator;
+//# sourceMappingURL=ElementAspectExportCoordinator.js.map

package/lib/cjs/ElementAspectExportCoordinator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ElementAspectExportCoordinator.js","sourceRoot":"","sources":["../../src/ElementAspectExportCoordinator.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAShG;;GAEG;AACH;IAQqB,iBAAiB;IACjB,uBAAuB;IACvB,cAAc;IAGd,YAAY;IAZd,iBAAiB,GAAG,IAAI,GAAG,EAAc,CAAC;IAC1C,kBAAkB,GAAG,IAAI,GAAG,EAAc,CAAC;IACpD,UAAU,CAAS;IACnB,MAAM,GAAG,CAAC,CAAC;IACX,QAAQ,CAAkC;IAElD,YACmB,iBAAyB,EACzB,uBAAkD,EAClD,cAEC,EACD,YAAY,GAAe,GAAG,EAAE,GAAE,CAAC;iCALnC,iBAAiB;uCACjB,uBAAuB;8BACvB,cAAc;4BAGd,YAAY;QAE7B,IAAI,CAAC,UAAU,GAAG,iBAAiB,CAAC;IACtC,CAAC;IAED,4DAA4D;IAC5D,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IACzB,CAAC;IAED,iGAAiG;IAC1F,cAAc,CAAC,OAAuC;QAC3D,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,iBAAiB;QAC7C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,IAAI,CAAC,eAAe,EAAE,CAAC;YACvB,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC9B,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAG;QACd,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO;QAE5B,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,iBAAiB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBACpC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;YACrB,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;IACH,CAAC;IAED,kFAAkF;IAC3E,KAAK;QACV,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAG,CAAC,cAAmC;QAClD,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,cAAc,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC;YACH,MAAM,cAAc,EAAE,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,MAAM,KAAK,CAAC;QACd,CAAC;QACD,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;IACnB,CAAC;IAED,0HAA0H;IACnH,KAAK,CAAC,gBAAgB,CAAC,SAAqB;QACjD,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAC;YAAE,OAAO;QAErE,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACtC,IAAI,IAAI,CAAC,iBAAiB,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACnD,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACrB,CAAC;IACH,CAAC;IAED,sFAAsF;IAC/E,KAAK,CAAC,YAAY,CACvB,eAAwC;QAExC,IAAI,QAAQ,GAAG,eAAe,CAAC;QAC/B,IAAI,IAAI,CAAC,QAAQ,IAAI,eAAe,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC9C,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAc,CAAC;YAClD,KAAK,MAAM,SAAS,IAAI,eAAe,EAAE,CAAC;gBACxC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC5C,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;oBACnC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;YACD,IAAI,mBAAmB,CAAC,IAAI,KAAK,CAAC;gBAAE,OAAO;YAC3C,QAAQ,GAAG,mBAAmB,CAAC;QACjC,CAAC;QAED,IAAI,QAAQ,CAAC,IAAI,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC5C,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACtC,OAAO;QACT,CAAC;QAED,IAAI,UAAU,GAAG,IAAI,GAAG,EAAc,CAAC;QACvC,KAAK,MAAM,SAAS,IAAI,QAAQ,EAAE,CAAC;YACjC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAC1B,IAAI,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAC/C,MAAM,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;gBACxC,UAAU,GAAG,IAAI,GAAG,EAAc,CAAC;YACrC,CAAC;QACH,CAAC;QACD,IAAI,UAAU,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAC5B,eAAwC;QAExC,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,eAAe,CAAC,CAAC;QACvE,MAAM,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IAC7C,CAAC;IAEO,KAAK,CAAC,KAAK;QACjB,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACxD,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IAC3C,CAAC;IAEO,eAAe;QACrB,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAEO,KAAK;QACX,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QAChB,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC;IAC3C,CAAC;CACF","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 { Id64String } from \"@itwin/core-bentley\";\n\nexport type ElementAspectExportPreparation = (\n  excludedElementAspectClassFullNames: ReadonlySet<string>,\n  ownerElementIds: ReadonlySet<Id64String>\n) => Promise<void>;\n\n/** Coordinates scoped batches of accepted ElementAspect owners, including preparation before aspect export.\n * @internal\n */\nexport class ElementAspectExportCoordinator {\n  private readonly _acceptedOwnerIds = new Set<Id64String>();\n  private readonly _processedOwnerIds = new Set<Id64String>();\n  private _batchSize: number;\n  private _depth = 0;\n  private _prepare?: ElementAspectExportPreparation;\n\n  public constructor(\n    private readonly _defaultBatchSize: number,\n    private readonly _excludedClassFullNames: () => ReadonlySet<string>,\n    private readonly _exportAspects: (\n      ownerElementIds: ReadonlySet<Id64String>\n    ) => Promise<void>,\n    private readonly _resetCaches: () => void = () => {}\n  ) {\n    this._batchSize = _defaultBatchSize;\n  }\n\n  /** Whether an accepted-owner collection scope is active. */\n  public get isActive(): boolean {\n    return this._depth > 0;\n  }\n\n  /** Sets the callback that prepares each accepted-owner group before its aspects are exported. */\n  public setPreparation(prepare: ElementAspectExportPreparation): void {\n    this._prepare = prepare;\n  }\n\n  /** Begins an accepted-owner collection scope.\n   * Nested scopes share the outer scope's state and batch size.\n   */\n  public begin(batchSize = this._defaultBatchSize): void {\n    if (this._depth === 0) {\n      this.resetScopeState();\n      this._resetCaches();\n      this._batchSize = batchSize;\n    }\n    this._depth++;\n  }\n\n  /** Ends an accepted-owner collection scope.\n   * Ending the outermost scope exports pending owners and resets all scope state.\n   */\n  public async end(): Promise<void> {\n    if (this._depth === 0) {\n      throw new Error(\"No scoped element export is active.\");\n    }\n\n    this._depth--;\n    if (this._depth > 0) return;\n\n    try {\n      if (this._acceptedOwnerIds.size > 0) {\n        await this.flush();\n      }\n    } finally {\n      this.reset();\n    }\n  }\n\n  /** Discards the active scope and its pending owner state without exporting it. */\n  public abort(): void {\n    this.reset();\n  }\n\n  /** Runs element export within an accepted-owner collection scope.\n   * A scope created by this call is aborted if element export fails; an existing outer scope remains responsible for its own failure handling.\n   */\n  public async run(exportElements: () => Promise<void>): Promise<void> {\n    if (this.isActive) {\n      await exportElements();\n      return;\n    }\n\n    this.begin();\n    try {\n      await exportElements();\n    } catch (error) {\n      this.abort();\n      throw error;\n    }\n    await this.end();\n  }\n\n  /** Adds an accepted source owner to the current group and exports the group when it reaches the configured batch size. */\n  public async addAcceptedOwner(elementId: Id64String): Promise<void> {\n    if (!this.isActive || this._processedOwnerIds.has(elementId)) return;\n\n    this._acceptedOwnerIds.add(elementId);\n    if (this._acceptedOwnerIds.size >= this._batchSize) {\n      await this.flush();\n    }\n  }\n\n  /** Runs preparation and aspect export for an explicit owner set in bounded groups. */\n  public async exportOwners(\n    ownerElementIds: ReadonlySet<Id64String>\n  ): Promise<void> {\n    let ownerIds = ownerElementIds;\n    if (this.isActive && ownerElementIds.size > 0) {\n      const unprocessedOwnerIds = new Set<Id64String>();\n      for (const elementId of ownerElementIds) {\n        if (!this._processedOwnerIds.has(elementId)) {\n          unprocessedOwnerIds.add(elementId);\n          this._processedOwnerIds.add(elementId);\n        }\n      }\n      if (unprocessedOwnerIds.size === 0) return;\n      ownerIds = unprocessedOwnerIds;\n    }\n\n    if (ownerIds.size <= this._defaultBatchSize) {\n      await this.exportOwnerBatch(ownerIds);\n      return;\n    }\n\n    let ownerBatch = new Set<Id64String>();\n    for (const elementId of ownerIds) {\n      ownerBatch.add(elementId);\n      if (ownerBatch.size === this._defaultBatchSize) {\n        await this.exportOwnerBatch(ownerBatch);\n        ownerBatch = new Set<Id64String>();\n      }\n    }\n    if (ownerBatch.size > 0) {\n      await this.exportOwnerBatch(ownerBatch);\n    }\n  }\n\n  private async exportOwnerBatch(\n    ownerElementIds: ReadonlySet<Id64String>\n  ): Promise<void> {\n    await this._prepare?.(this._excludedClassFullNames(), ownerElementIds);\n    await this._exportAspects(ownerElementIds);\n  }\n\n  private async flush(): Promise<void> {\n    const ownerElementIds = new Set(this._acceptedOwnerIds);\n    this._acceptedOwnerIds.clear();\n    await this.exportOwners(ownerElementIds);\n  }\n\n  private resetScopeState(): void {\n    this._acceptedOwnerIds.clear();\n    this._processedOwnerIds.clear();\n  }\n\n  private reset(): void {\n    this._depth = 0;\n    this.resetScopeState();\n    this._batchSize = this._defaultBatchSize;\n  }\n}\n"]}

package/lib/cjs/ElementAspectExportProcessor.d.ts

@@ -0,0 +1,44 @@
+import { ElementAspect, ElementMultiAspect, ElementUniqueAspect, IModelDb } from "@itwin/core-backend";
+import { Id64String } from "@itwin/core-bentley";
+interface AspectChanges {
+    readonly insertIds: ReadonlySet<Id64String>;
+    readonly updateIds: ReadonlySet<Id64String>;
+}
+export interface ElementAspectExportProcessorHandler {
+    shouldExportElementAspect(aspect: ElementAspect): Promise<boolean>;
+    onExportElementUniqueAspect(uniqueAspect: ElementUniqueAspect, isUpdate?: boolean | undefined): Promise<void>;
+    onExportElementMultiAspects(multiAspects: ElementMultiAspect[]): Promise<void>;
+    trackProgress: () => Promise<void>;
+}
+/** Queries and exports ElementAspects for accepted source owners, applying class and handler filters and grouping multi-aspects by owner.
+ * @internal
+ */
+export declare class ElementAspectExportProcessor {
+    /** ElementAspect classes excluded from source queries. */
+    private readonly _excludedElementAspectClassFullNames;
+    private _hasExportableAspects;
+    private _expandedExcludedElementAspectClassFullNames;
+    private _aspectChanges;
+    /** ElementAspect class names excluded from source queries. */
+    get excludedElementAspectClassFullNames(): ReadonlySet<string>;
+    private readonly _sourceDb;
+    private readonly _handler;
+    constructor(sourceDb: IModelDb, handler: ElementAspectExportProcessorHandler);
+    /** Exports ElementAspects owned by the supplied elements.
+     * Multi-aspects are emitted in one callback group per owner.
+     */
+    exportAllElementAspects(ownerElementIds: ReadonlySet<Id64String>): Promise<void>;
+    /** Sets the aspect changes used to distinguish inserted and updated unique aspects during change export. */
+    setAspectChanges(aspectChanges?: AspectChanges): void;
+    /** Clears source schema and content caches at an outer export-scope boundary. */
+    resetCaches(): void;
+    /** Excludes an ElementAspect class from subsequent queries and export callbacks. */
+    excludeElementAspectClass(classFullName: string): void;
+    private getExcludedClassFilter;
+    private getHasExportableAspects;
+    private queryHasExportableAspects;
+    private getExpandedExcludedElementAspectClassFullNames;
+    private queryExpandedExcludedElementAspectClassFullNames;
+}
+export {};
+//# sourceMappingURL=ElementAspectExportProcessor.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ElementAspectExportProcessor.d.ts","sourceRoot":"","sources":["../../src/ElementAspectExportProcessor.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,aAAa,EACb,kBAAkB,EAClB,mBAAmB,EACnB,QAAQ,EACT,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAIjD,UAAU,aAAa;IACrB,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5C,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,mCAAmC;IAClD,yBAAyB,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACnE,2BAA2B,CACzB,YAAY,EAAE,mBAAmB,EACjC,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,GAC7B,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,2BAA2B,CACzB,YAAY,EAAE,kBAAkB,EAAE,GACjC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,qBAAa,4BAA4B;IACvC,0DAA0D;IAC1D,OAAO,CAAC,QAAQ,CAAC,oCAAoC,CAAqB;IAC1E,OAAO,CAAC,qBAAqB,CAA+B;IAC5D,OAAO,CAAC,4CAA4C,CACT;IAC3C,OAAO,CAAC,cAAc,CAA4B;IAElD,8DAA8D;IAC9D,IAAW,mCAAmC,IAAI,WAAW,CAAC,MAAM,CAAC,CAEpE;IACD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAsC;IAE/D,YACE,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,mCAAmC,EAI7C;IAED;;OAEG;IACU,uBAAuB,CAClC,eAAe,EAAE,WAAW,CAAC,UAAU,CAAC,GACvC,OAAO,CAAC,IAAI,CAAC,CAkDf;IAED,4GAA4G;IACrG,gBAAgB,CAAC,aAAa,CAAC,EAAE,aAAa,GAAG,IAAI,CAE3D;IAED,iFAAiF;IAC1E,WAAW,IAAI,IAAI,CAGzB;IAED,oFAAoF;IAC7E,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAM5D;IAED,OAAO,CAAC,sBAAsB;YAkBhB,uBAAuB;YAKvB,yBAAyB;YAuBzB,8CAA8C;YAQ9C,gDAAgD;CAmB/D"}

package/lib/cjs/ElementAspectExportProcessor.js

@@ -0,0 +1,152 @@
+"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.ElementAspectExportProcessor = void 0;
+const core_backend_1 = require("@itwin/core-backend");
+const ECSqlReaderAsyncIterableIteratorAdapter_1 = require("./ECSqlReaderAsyncIterableIteratorAdapter");
+const core_common_1 = require("@itwin/core-common");
+/** Queries and exports ElementAspects for accepted source owners, applying class and handler filters and grouping multi-aspects by owner.
+ * @internal
+ */
+class ElementAspectExportProcessor {
+    /** ElementAspect classes excluded from source queries. */
+    _excludedElementAspectClassFullNames = new Set();
+    _hasExportableAspects;
+    _expandedExcludedElementAspectClassFullNames;
+    _aspectChanges;
+    /** ElementAspect class names excluded from source queries. */
+    get excludedElementAspectClassFullNames() {
+        return this._excludedElementAspectClassFullNames;
+    }
+    _sourceDb;
+    _handler;
+    constructor(sourceDb, handler) {
+        this._sourceDb = sourceDb;
+        this._handler = handler;
+    }
+    /** Exports ElementAspects owned by the supplied elements.
+     * Multi-aspects are emitted in one callback group per owner.
+     */
+    async exportAllElementAspects(ownerElementIds) {
+        if (ownerElementIds.size === 0 || !(await this.getHasExportableAspects()))
+            return;
+        let multiAspectOwnerId;
+        let multiAspects = [];
+        const exportMultiAspects = async () => {
+            if (multiAspects.length === 0)
+                return;
+            await this._handler.onExportElementMultiAspects(multiAspects);
+            await this._handler.trackProgress();
+            multiAspects = [];
+            multiAspectOwnerId = undefined;
+        };
+        const excludedAspectClassFullNames = await this.getExpandedExcludedElementAspectClassFullNames();
+        for await (const aspect of this._sourceDb.elements.queryAspects({
+            elementIds: new Set(ownerElementIds),
+            excludedAspectClassFullNames,
+            groupByOwner: true,
+            usePrimaryConn: true,
+        })) {
+            if (!(await this._handler.shouldExportElementAspect(aspect)))
+                continue;
+            if (multiAspectOwnerId !== undefined &&
+                multiAspectOwnerId !== aspect.element.id) {
+                await exportMultiAspects();
+            }
+            if (aspect instanceof core_backend_1.ElementUniqueAspect) {
+                const isUpdate = this._aspectChanges?.updateIds.has(aspect.id)
+                    ? true
+                    : this._aspectChanges?.insertIds.has(aspect.id)
+                        ? false
+                        : undefined;
+                await this._handler.onExportElementUniqueAspect(aspect, isUpdate);
+                await this._handler.trackProgress();
+            }
+            else if (aspect instanceof core_backend_1.ElementMultiAspect) {
+                multiAspectOwnerId = aspect.element.id;
+                multiAspects.push(aspect);
+            }
+            else {
+                throw new Error(`Unexpected ElementAspect type ${aspect.classFullName}`);
+            }
+        }
+        await exportMultiAspects();
+    }
+    /** Sets the aspect changes used to distinguish inserted and updated unique aspects during change export. */
+    setAspectChanges(aspectChanges) {
+        this._aspectChanges = aspectChanges;
+    }
+    /** Clears source schema and content caches at an outer export-scope boundary. */
+    resetCaches() {
+        this._hasExportableAspects = undefined;
+        this._expandedExcludedElementAspectClassFullNames = undefined;
+    }
+    /** Excludes an ElementAspect class from subsequent queries and export callbacks. */
+    excludeElementAspectClass(classFullName) {
+        const normalizedClassFullName = classFullName.replace(".", ":");
+        if (this._excludedElementAspectClassFullNames.has(normalizedClassFullName))
+            return;
+        this._excludedElementAspectClassFullNames.add(normalizedClassFullName);
+        this.resetCaches();
+    }
+    getExcludedClassFilter(queryParams) {
+        const excludedClassParameters = [];
+        let excludedClassIndex = 0;
+        for (const classFullName of this._excludedElementAspectClassFullNames) {
+            const parameterName = `excludedAspectClass${excludedClassIndex++}`;
+            excludedClassParameters.push(`ec_classid(:${parameterName})`);
+            queryParams.bindString(parameterName, classFullName);
+        }
+        return excludedClassParameters.length === 0
+            ? ""
+            : `AND NOT EXISTS (
+          SELECT 1 FROM meta.ClassHasAllBaseClasses excluded
+          WHERE excluded.SourceECInstanceId = aspect.ECClassId
+            AND excluded.TargetECInstanceId IN (${excludedClassParameters.join(",")})
+        )`;
+    }
+    async getHasExportableAspects() {
+        this._hasExportableAspects ??= this.queryHasExportableAspects();
+        return this._hasExportableAspects;
+    }
+    async queryHasExportableAspects() {
+        const queryParams = new core_common_1.QueryBinder();
+        const excludedClassFilter = this.getExcludedClassFilter(queryParams);
+        const reader = this._sourceDb.createQueryReader(`SELECT ECInstanceId FROM (
+         SELECT aspect.ECInstanceId
+         FROM Bis.ElementMultiAspect aspect
+         WHERE TRUE ${excludedClassFilter}
+         UNION ALL
+         SELECT aspect.ECInstanceId
+         FROM Bis.ElementUniqueAspect aspect
+         WHERE TRUE ${excludedClassFilter}
+       )
+       LIMIT 1`, queryParams, { usePrimaryConn: true });
+        for await (const _row of (0, ECSqlReaderAsyncIterableIteratorAdapter_1.ensureECSqlReaderIsAsyncIterableIterator)(reader))
+            return true;
+        return false;
+    }
+    async getExpandedExcludedElementAspectClassFullNames() {
+        this._expandedExcludedElementAspectClassFullNames ??=
+            this.queryExpandedExcludedElementAspectClassFullNames();
+        return this._expandedExcludedElementAspectClassFullNames;
+    }
+    async queryExpandedExcludedElementAspectClassFullNames() {
+        const excludedClassFullNames = new Set();
+        for (const classFullName of this._excludedElementAspectClassFullNames) {
+            const reader = this._sourceDb.createQueryReader(`SELECT ec_classname(classes.ECInstanceId, 's:c') AS classFullName
+         FROM meta.ClassHasAllBaseClasses inheritance
+         JOIN meta.ECClassDef classes
+           ON classes.ECInstanceId = inheritance.SourceECInstanceId
+         WHERE inheritance.TargetECInstanceId = ec_classid(:excludedClassName)`, new core_common_1.QueryBinder().bindString("excludedClassName", classFullName), { usePrimaryConn: true });
+            for await (const row of (0, ECSqlReaderAsyncIterableIteratorAdapter_1.ensureECSqlReaderIsAsyncIterableIterator)(reader))
+                excludedClassFullNames.add(row.classFullName);
+        }
+        return excludedClassFullNames;
+    }
+}
+exports.ElementAspectExportProcessor = ElementAspectExportProcessor;
+//# sourceMappingURL=ElementAspectExportProcessor.js.map

package/lib/cjs/ElementAspectExportProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ElementAspectExportProcessor.js","sourceRoot":"","sources":["../../src/ElementAspectExportProcessor.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,sDAK6B;AAE7B,uGAAqG;AACrG,oDAAiD;AAmBjD;;GAEG;AACH;IACE,0DAA0D;IACzC,oCAAoC,GAAG,IAAI,GAAG,EAAU,CAAC;IAClE,qBAAqB,CAA+B;IACpD,4CAA4C,CACT;IACnC,cAAc,CAA4B;IAElD,8DAA8D;IAC9D,IAAW,mCAAmC;QAC5C,OAAO,IAAI,CAAC,oCAAoC,CAAC;IACnD,CAAC;IACgB,SAAS,CAAW;IACpB,QAAQ,CAAsC;IAE/D,YACE,QAAkB,EAClB,OAA4C;QAE5C,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,uBAAuB,CAClC,eAAwC;QAExC,IAAI,eAAe,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC;YACvE,OAAO;QAET,IAAI,kBAA0C,CAAC;QAC/C,IAAI,YAAY,GAAyB,EAAE,CAAC;QAC5C,MAAM,kBAAkB,GAAG,KAAK,IAAI,EAAE;YACpC,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO;YACtC,MAAM,IAAI,CAAC,QAAQ,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;YAC9D,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;YACpC,YAAY,GAAG,EAAE,CAAC;YAClB,kBAAkB,GAAG,SAAS,CAAC;QACjC,CAAC,CAAC;QAEF,MAAM,4BAA4B,GAChC,MAAM,IAAI,CAAC,8CAA8C,EAAE,CAAC;QAC9D,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC;YAC9D,UAAU,EAAE,IAAI,GAAG,CAAC,eAAe,CAAC;YACpC,4BAA4B;YAC5B,YAAY,EAAE,IAAI;YAClB,cAAc,EAAE,IAAI;SACrB,CAAC,EAAE,CAAC;YACH,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;gBAAE,SAAS;YAEvE,IACE,kBAAkB,KAAK,SAAS;gBAChC,kBAAkB,KAAK,MAAM,CAAC,OAAO,CAAC,EAAE,EACxC,CAAC;gBACD,MAAM,kBAAkB,EAAE,CAAC;YAC7B,CAAC;YAED,IAAI,MAAM,YAAY,kCAAmB,EAAE,CAAC;gBAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC5D,CAAC,CAAC,IAAI;oBACN,CAAC,CAAC,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;wBAC7C,CAAC,CAAC,KAAK;wBACP,CAAC,CAAC,SAAS,CAAC;gBAChB,MAAM,IAAI,CAAC,QAAQ,CAAC,2BAA2B,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;gBAClE,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;YACtC,CAAC;iBAAM,IAAI,MAAM,YAAY,iCAAkB,EAAE,CAAC;gBAChD,kBAAkB,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBACvC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CACb,iCAAiC,MAAM,CAAC,aAAa,EAAE,CACxD,CAAC;YACJ,CAAC;QACH,CAAC;QAED,MAAM,kBAAkB,EAAE,CAAC;IAC7B,CAAC;IAED,4GAA4G;IACrG,gBAAgB,CAAC,aAA6B;QACnD,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAED,iFAAiF;IAC1E,WAAW;QAChB,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;QACvC,IAAI,CAAC,4CAA4C,GAAG,SAAS,CAAC;IAChE,CAAC;IAED,oFAAoF;IAC7E,yBAAyB,CAAC,aAAqB;QACpD,MAAM,uBAAuB,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAChE,IAAI,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,uBAAuB,CAAC;YACxE,OAAO;QACT,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QACvE,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAEO,sBAAsB,CAAC,WAAwB;QACrD,MAAM,uBAAuB,GAAa,EAAE,CAAC;QAC7C,IAAI,kBAAkB,GAAG,CAAC,CAAC;QAC3B,KAAK,MAAM,aAAa,IAAI,IAAI,CAAC,oCAAoC,EAAE,CAAC;YACtE,MAAM,aAAa,GAAG,sBAAsB,kBAAkB,EAAE,EAAE,CAAC;YACnE,uBAAuB,CAAC,IAAI,CAAC,eAAe,aAAa,GAAG,CAAC,CAAC;YAC9D,WAAW,CAAC,UAAU,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;QACvD,CAAC;QAED,OAAO,uBAAuB,CAAC,MAAM,KAAK,CAAC;YACzC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC;;;kDAG0C,uBAAuB,CAAC,IAAI,CAAC,GAAG,CAAC;UACzE,CAAC;IACT,CAAC;IAEO,KAAK,CAAC,uBAAuB;QACnC,IAAI,CAAC,qBAAqB,KAAK,IAAI,CAAC,yBAAyB,EAAE,CAAC;QAChE,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACpC,CAAC;IAEO,KAAK,CAAC,yBAAyB;QACrC,MAAM,WAAW,GAAG,IAAI,yBAAW,EAAE,CAAC;QACtC,MAAM,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QACrE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAC7C;;;sBAGgB,mBAAmB;;;;sBAInB,mBAAmB;;eAE1B,EACT,WAAW,EACX,EAAE,cAAc,EAAE,IAAI,EAAE,CACzB,CAAC;QAEF,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAA,kFAAwC,EAAC,MAAM,CAAC;YACvE,OAAO,IAAI,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,KAAK,CAAC,8CAA8C;QAG1D,IAAI,CAAC,4CAA4C;YAC/C,IAAI,CAAC,gDAAgD,EAAE,CAAC;QAC1D,OAAO,IAAI,CAAC,4CAA4C,CAAC;IAC3D,CAAC;IAEO,KAAK,CAAC,gDAAgD;QAG5D,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAU,CAAC;QACjD,KAAK,MAAM,aAAa,IAAI,IAAI,CAAC,oCAAoC,EAAE,CAAC;YACtE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAC7C;;;;+EAIuE,EACvE,IAAI,yBAAW,EAAE,CAAC,UAAU,CAAC,mBAAmB,EAAE,aAAa,CAAC,EAChE,EAAE,cAAc,EAAE,IAAI,EAAE,CACzB,CAAC;YACF,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,IAAA,kFAAwC,EAAC,MAAM,CAAC;gBACtE,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,sBAAsB,CAAC;IAChC,CAAC;CACF","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 } from \"@itwin/core-bentley\";\nimport { ensureECSqlReaderIsAsyncIterableIterator } from \"./ECSqlReaderAsyncIterableIteratorAdapter\";\nimport { QueryBinder } from \"@itwin/core-common\";\n\ninterface AspectChanges {\n  readonly insertIds: ReadonlySet<Id64String>;\n  readonly updateIds: ReadonlySet<Id64String>;\n}\n\nexport interface ElementAspectExportProcessorHandler {\n  shouldExportElementAspect(aspect: ElementAspect): Promise<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/** Queries and exports ElementAspects for accepted source owners, applying class and handler filters and grouping multi-aspects by owner.\n * @internal\n */\nexport class ElementAspectExportProcessor {\n  /** ElementAspect classes excluded from source queries. */\n  private readonly _excludedElementAspectClassFullNames = new Set<string>();\n  private _hasExportableAspects: Promise<boolean> | undefined;\n  private _expandedExcludedElementAspectClassFullNames:\n    Promise<ReadonlySet<string>> | undefined;\n  private _aspectChanges: AspectChanges | undefined;\n\n  /** ElementAspect class names excluded from source queries. */\n  public get excludedElementAspectClassFullNames(): ReadonlySet<string> {\n    return this._excludedElementAspectClassFullNames;\n  }\n  private readonly _sourceDb: IModelDb;\n  private readonly _handler: ElementAspectExportProcessorHandler;\n\n  public constructor(\n    sourceDb: IModelDb,\n    handler: ElementAspectExportProcessorHandler\n  ) {\n    this._sourceDb = sourceDb;\n    this._handler = handler;\n  }\n\n  /** Exports ElementAspects owned by the supplied elements.\n   * Multi-aspects are emitted in one callback group per owner.\n   */\n  public async exportAllElementAspects(\n    ownerElementIds: ReadonlySet<Id64String>\n  ): Promise<void> {\n    if (ownerElementIds.size === 0 || !(await this.getHasExportableAspects()))\n      return;\n\n    let multiAspectOwnerId: Id64String | undefined;\n    let multiAspects: ElementMultiAspect[] = [];\n    const exportMultiAspects = async () => {\n      if (multiAspects.length === 0) return;\n      await this._handler.onExportElementMultiAspects(multiAspects);\n      await this._handler.trackProgress();\n      multiAspects = [];\n      multiAspectOwnerId = undefined;\n    };\n\n    const excludedAspectClassFullNames =\n      await this.getExpandedExcludedElementAspectClassFullNames();\n    for await (const aspect of this._sourceDb.elements.queryAspects({\n      elementIds: new Set(ownerElementIds),\n      excludedAspectClassFullNames,\n      groupByOwner: true,\n      usePrimaryConn: true,\n    })) {\n      if (!(await this._handler.shouldExportElementAspect(aspect))) continue;\n\n      if (\n        multiAspectOwnerId !== undefined &&\n        multiAspectOwnerId !== aspect.element.id\n      ) {\n        await exportMultiAspects();\n      }\n\n      if (aspect instanceof ElementUniqueAspect) {\n        const isUpdate = this._aspectChanges?.updateIds.has(aspect.id)\n          ? true\n          : this._aspectChanges?.insertIds.has(aspect.id)\n            ? false\n            : undefined;\n        await this._handler.onExportElementUniqueAspect(aspect, isUpdate);\n        await this._handler.trackProgress();\n      } else if (aspect instanceof ElementMultiAspect) {\n        multiAspectOwnerId = aspect.element.id;\n        multiAspects.push(aspect);\n      } else {\n        throw new Error(\n          `Unexpected ElementAspect type ${aspect.classFullName}`\n        );\n      }\n    }\n\n    await exportMultiAspects();\n  }\n\n  /** Sets the aspect changes used to distinguish inserted and updated unique aspects during change export. */\n  public setAspectChanges(aspectChanges?: AspectChanges): void {\n    this._aspectChanges = aspectChanges;\n  }\n\n  /** Clears source schema and content caches at an outer export-scope boundary. */\n  public resetCaches(): void {\n    this._hasExportableAspects = undefined;\n    this._expandedExcludedElementAspectClassFullNames = undefined;\n  }\n\n  /** Excludes an ElementAspect class from subsequent queries and export callbacks. */\n  public excludeElementAspectClass(classFullName: string): void {\n    const normalizedClassFullName = classFullName.replace(\".\", \":\");\n    if (this._excludedElementAspectClassFullNames.has(normalizedClassFullName))\n      return;\n    this._excludedElementAspectClassFullNames.add(normalizedClassFullName);\n    this.resetCaches();\n  }\n\n  private getExcludedClassFilter(queryParams: QueryBinder): string {\n    const excludedClassParameters: string[] = [];\n    let excludedClassIndex = 0;\n    for (const classFullName of this._excludedElementAspectClassFullNames) {\n      const parameterName = `excludedAspectClass${excludedClassIndex++}`;\n      excludedClassParameters.push(`ec_classid(:${parameterName})`);\n      queryParams.bindString(parameterName, classFullName);\n    }\n\n    return excludedClassParameters.length === 0\n      ? \"\"\n      : `AND NOT EXISTS (\n          SELECT 1 FROM meta.ClassHasAllBaseClasses excluded\n          WHERE excluded.SourceECInstanceId = aspect.ECClassId\n            AND excluded.TargetECInstanceId IN (${excludedClassParameters.join(\",\")})\n        )`;\n  }\n\n  private async getHasExportableAspects(): Promise<boolean> {\n    this._hasExportableAspects ??= this.queryHasExportableAspects();\n    return this._hasExportableAspects;\n  }\n\n  private async queryHasExportableAspects(): Promise<boolean> {\n    const queryParams = new QueryBinder();\n    const excludedClassFilter = this.getExcludedClassFilter(queryParams);\n    const reader = this._sourceDb.createQueryReader(\n      `SELECT ECInstanceId FROM (\n         SELECT aspect.ECInstanceId\n         FROM Bis.ElementMultiAspect aspect\n         WHERE TRUE ${excludedClassFilter}\n         UNION ALL\n         SELECT aspect.ECInstanceId\n         FROM Bis.ElementUniqueAspect aspect\n         WHERE TRUE ${excludedClassFilter}\n       )\n       LIMIT 1`,\n      queryParams,\n      { usePrimaryConn: true }\n    );\n\n    for await (const _row of ensureECSqlReaderIsAsyncIterableIterator(reader))\n      return true;\n    return false;\n  }\n\n  private async getExpandedExcludedElementAspectClassFullNames(): Promise<\n    ReadonlySet<string>\n  > {\n    this._expandedExcludedElementAspectClassFullNames ??=\n      this.queryExpandedExcludedElementAspectClassFullNames();\n    return this._expandedExcludedElementAspectClassFullNames;\n  }\n\n  private async queryExpandedExcludedElementAspectClassFullNames(): Promise<\n    ReadonlySet<string>\n  > {\n    const excludedClassFullNames = new Set<string>();\n    for (const classFullName of this._excludedElementAspectClassFullNames) {\n      const reader = this._sourceDb.createQueryReader(\n        `SELECT ec_classname(classes.ECInstanceId, 's:c') AS classFullName\n         FROM meta.ClassHasAllBaseClasses inheritance\n         JOIN meta.ECClassDef classes\n           ON classes.ECInstanceId = inheritance.SourceECInstanceId\n         WHERE inheritance.TargetECInstanceId = ec_classid(:excludedClassName)`,\n        new QueryBinder().bindString(\"excludedClassName\", classFullName),\n        { usePrimaryConn: true }\n      );\n      for await (const row of ensureECSqlReaderIsAsyncIterableIterator(reader))\n        excludedClassFullNames.add(row.classFullName);\n    }\n    return excludedClassFullNames;\n  }\n}\n"]}

package/lib/cjs/ElementBulkDelete.d.ts

@@ -0,0 +1,30 @@
+import { Id64Array, Id64String } from "@itwin/core-bentley";
+import { IModelDb } from "@itwin/core-backend";
+/** Native deletion calls needed to delete a set of element trees without a partial result.
+ * @internal
+ */
+export interface BulkDeletePlan {
+    /** Roots for each native deletion call, in execution order. Empty when nothing needs deleting. */
+    readonly phases: readonly Id64Array[];
+    /** Elements kept because an element outside the deleted trees still references them, each mapped to one such
+     * referencing element. Their child elements and sub-models, and the elements whose deletion would delete them,
+     * are kept too.
+     */
+    readonly keptReferences: ReadonlyMap<Id64String, Id64String>;
+}
+/** Plans native bulk deletion of the specified element trees.
+ *
+ * An element that something outside the deleted trees still references is kept, together with what it
+ * needs to stay valid, and the rest is deleted. Keeping elements can leave new outside references, so the
+ * plan repeats until none remain.
+ *
+ * Native validation checks each root against the iModel before the call, so a root is refused when its tree
+ * contains a definition, such as a category or a view, that a non-definition element in the same call still
+ * uses. The plan deletes those users in an earlier call than the definitions they use. Validation stays enabled
+ * for every call, so a reference this plan does not know about fails loudly instead of leaving a dangling
+ * reference. That includes elements outside the trees whose geometry uses a definition in them, such as a
+ * geometry part: only native code can read geometry, so those uses are not checked in advance.
+ * @internal
+ */
+export declare function planBulkDelete(targetDb: IModelDb, elementIds: ReadonlySet<Id64String>): Promise<BulkDeletePlan>;
+//# sourceMappingURL=ElementBulkDelete.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ElementBulkDelete.d.ts","sourceRoot":"","sources":["../../src/ElementBulkDelete.ts"],"names":[],"mappings":"AAKA,OAAO,EAAU,SAAS,EAAW,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE7E,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,kGAAkG;IAClG,QAAQ,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;IACtC;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,WAAW,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;CAC9D;AASD;;;;;;;;;;;;;GAaG;AACH,wBAAsB,cAAc,CAClC,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC,GAClC,OAAO,CAAC,cAAc,CAAC,CAkCzB"}