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

package/lib/cjs/ChangesetScanner.d.ts

@@ -0,0 +1,141 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { IModelDb } from "@itwin/core-backend";
+import { Id64String } from "@itwin/core-bentley";
+import { ChangesetFileProps } from "@itwin/core-common";
+import type { ChangedInstanceIds } from "./IModelExporter";
+import { SourceClassKinds } from "./SourceClassKinds";
+/**
+ * Identity shared by all deletion records.
+ * @beta
+ */
+export interface DeletionRecordBase {
+    /** ID of the deleted source instance. */
+    ecInstanceId: Id64String;
+    /** EC class ID of the deleted source instance. */
+    ecClassId: Id64String;
+}
+/**
+ * A deleted source element.
+ * @beta
+ */
+export interface ElementDeletionRecord extends DeletionRecordBase {
+    /** Federation GUID used to find the corresponding target element. Undefined when the element had none. */
+    federationGuid?: string;
+}
+/**
+ * A deleted source model.
+ * @beta
+ */
+export type ModelDeletionRecord = DeletionRecordBase;
+/**
+ * A deleted source relationship derived from `BisCore:ElementRefersToElements`, excluding `BisCore:ElementDrivesElement`.
+ * @beta
+ */
+export interface RelationshipDeletionRecord extends DeletionRecordBase {
+    /** Source endpoint of the deleted relationship. */
+    sourceECInstanceId: Id64String;
+    /** Target endpoint of the deleted relationship. */
+    targetECInstanceId: Id64String;
+}
+/**
+ * A deleted source ExternalSourceAspect, used to find the target of an element deleted in the same batch.
+ * Only aspects of kind `Element` with a scope and identifier are recorded, because only those identify a target element.
+ * @beta
+ */
+export interface ExternalSourceAspectDeletionRecord extends DeletionRecordBase {
+    /** Element that owned the deleted aspect. */
+    elementId: Id64String;
+    /** Scope of the deleted aspect. */
+    scopeId: Id64String;
+    /** Kind of the deleted aspect. */
+    kind: string;
+    /** Identifier of the deleted aspect. */
+    identifier: string;
+}
+/**
+ * Deleted source instances from one batch of changes.
+ * @note Batches are processed in order. An `Element`-kind ExternalSourceAspect deletion is used to identify element deletions in the same batch. An empty array means nothing of that kind was deleted.
+ * @beta
+ */
+export interface DeletionBatch {
+    /** Deleted elements. */
+    elements: ElementDeletionRecord[];
+    /** Deleted models. */
+    models: ModelDeletionRecord[];
+    /** Deleted relationships derived from `BisCore:ElementRefersToElements`, excluding `BisCore:ElementDrivesElement`. */
+    relationships: RelationshipDeletionRecord[];
+    /** Deleted `Element`-kind ExternalSourceAspects with a scope and identifier. Aspects of other kinds can be omitted. */
+    externalSourceAspects: ExternalSourceAspectDeletionRecord[];
+}
+/**
+ * Changes read for [[IModelTransformer.collectChanges]].
+ * @note The result must describe every change in the given ranges, as the default implementation does. Changes missing from
+ * `changedInstanceIds`, including CodeSpec changes, aren't exported. Every relationship in
+ * `changedInstanceIds.relationship.deleteIds` needs a matching deletion record, or its deletion is skipped with a warning.
+ * An element or model deletion whose target can't be found through its record or the transformation's provenance is ignored.
+ * @beta
+ */
+export interface CollectedChanges {
+    /** Changed instance IDs, including the owning elements of changed aspects. */
+    changedInstanceIds: ChangedInstanceIds;
+    /** Deletion batches of any granularity: one per changeset, one per range, or one for all ranges. */
+    deletionBatches: DeletionBatch[];
+}
+/**
+ * The identifiers of a deleted instance that deletion records are built from, as read from a changeset with
+ * `PropertyFilter.InstanceKeyAndIdentifiers`.
+ * @internal
+ */
+export interface DeletedInstance {
+    ecInstanceId: Id64String;
+    ecClassId: Id64String;
+    federationGuid?: string;
+    sourceECInstanceId?: Id64String;
+    targetECInstanceId?: Id64String;
+    /** Owner of a deleted aspect. */
+    elementId?: Id64String;
+    scopeId?: Id64String;
+    kind?: string;
+    identifier?: string;
+}
+interface ScanOptions {
+    /** Receives the changes. When undefined, changes are read only for their deletion records. */
+    changedInstanceIds?: ChangedInstanceIds;
+    /** Whether to collect deletion records. Defaults to true. */
+    collectDeletionRecords?: boolean;
+}
+/**
+ * Adds a deleted instance to the deletion batch for its class.
+ * @note Throws `IModelStatus.NotFound` when the instance's class is missing from the current schemas, because such a
+ * deletion can't be classified.
+ * @internal
+ */
+export declare function addDeletionRecord(batch: DeletionBatch, deleted: DeletedInstance, classKinds: SourceClassKinds, iModel: IModelDb): void;
+/**
+ * Reads each changeset once, unifies table changes into EC instance changes,
+ * normalizes overflow-only inserts and deletes to updates, writes all operations
+ * to [[ChangedInstanceIds]], and records the deleted instances needed to process deletions.
+ * @internal
+ */
+export declare class ChangesetScanner {
+    /**
+     * Downloads the changesets in each range of an iModel.
+     * @param iModel the iModel to download changesets for.
+     * @param ranges inclusive ranges of changeset indices.
+     * @returns one group of changeset files per range, in the order of `ranges`.
+     */
+    static download(iModel: IModelDb, ranges: readonly (readonly [number, number])[]): Promise<ChangesetFileProps[][]>;
+    /**
+     * Scans each group of changeset files in order with one reader and unifier per file.
+     * @param iModel Database used to resolve EC classes.
+     * @param csFileGroups Ordered groups of changeset files. Each group produces one deletion batch.
+     * @param options Where to write the changes, and whether to collect deletion records.
+     * @returns One deletion batch per group, empty when deletion records aren't collected.
+     */
+    static scan(iModel: IModelDb, csFileGroups: ChangesetFileProps[][], { changedInstanceIds, collectDeletionRecords }: ScanOptions): Promise<DeletionBatch[]>;
+    private static readFiles;
+}
+export {};
+//# sourceMappingURL=ChangesetScanner.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ChangesetScanner.d.ts","sourceRoot":"","sources":["../../src/ChangesetScanner.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAKL,QAAQ,EAGT,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAc,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAK3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,yCAAyC;IACzC,YAAY,EAAE,UAAU,CAAC;IACzB,kDAAkD;IAClD,SAAS,EAAE,UAAU,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAC/D,0GAA0G;IAC1G,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,kBAAkB,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACpE,mDAAmD;IACnD,kBAAkB,EAAE,UAAU,CAAC;IAC/B,mDAAmD;IACnD,kBAAkB,EAAE,UAAU,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,kCAAmC,SAAQ,kBAAkB;IAC5E,6CAA6C;IAC7C,SAAS,EAAE,UAAU,CAAC;IACtB,mCAAmC;IACnC,OAAO,EAAE,UAAU,CAAC;IACpB,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,wBAAwB;IACxB,QAAQ,EAAE,qBAAqB,EAAE,CAAC;IAClC,sBAAsB;IACtB,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B,sHAAsH;IACtH,aAAa,EAAE,0BAA0B,EAAE,CAAC;IAC5C,uHAAuH;IACvH,qBAAqB,EAAE,kCAAkC,EAAE,CAAC;CAC7D;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B,8EAA8E;IAC9E,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,oGAAoG;IACpG,eAAe,EAAE,aAAa,EAAE,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,UAAU,CAAC;IACzB,SAAS,EAAE,UAAU,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,kBAAkB,CAAC,EAAE,UAAU,CAAC;IAChC,kBAAkB,CAAC,EAAE,UAAU,CAAC;IAChC,iCAAiC;IACjC,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,WAAW;IACnB,8FAA8F;IAC9F,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,6DAA6D;IAC7D,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,aAAa,EACpB,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,gBAAgB,EAC5B,MAAM,EAAE,QAAQ,GACf,IAAI,CA2DN;AAED;;;;;GAKG;AACH,qBAAa,gBAAgB;IAC3B;;;;;OAKG;IACH,OAAoB,QAAQ,CAC1B,MAAM,EAAE,QAAQ,EAChB,MAAM,EAAE,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,GAC7C,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAWjC;IAED;;;;;;OAMG;IACH,OAAoB,IAAI,CACtB,MAAM,EAAE,QAAQ,EAChB,YAAY,EAAE,kBAAkB,EAAE,EAAE,EACpC,EAAE,kBAAkB,EAAE,sBAA6B,EAAE,EAAE,WAAW,GACjE,OAAO,CAAC,aAAa,EAAE,CAAC,CAuC1B;IAED,OAAO,CAAC,MAAM,CAAE,SAAS;CA0C1B"}

package/lib/cjs/ChangesetScanner.js

@@ -0,0 +1,187 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChangesetScanner = void 0;
+exports.addDeletionRecord = addDeletionRecord;
+const core_backend_1 = require("@itwin/core-backend");
+const core_bentley_1 = require("@itwin/core-bentley");
+const IModelTransformerError_1 = require("./IModelTransformerError");
+const SourceClassKinds_1 = require("./SourceClassKinds");
+/**
+ * Adds a deleted instance to the deletion batch for its class.
+ * @note Throws `IModelStatus.NotFound` when the instance's class is missing from the current schemas, because such a
+ * deletion can't be classified.
+ * @internal
+ */
+function addDeletionRecord(batch, deleted, classKinds, iModel) {
+    const { ecInstanceId, ecClassId } = deleted;
+    switch (classKinds.kindOf(ecClassId)) {
+        case "element":
+            batch.elements.push({
+                ecInstanceId,
+                ecClassId,
+                federationGuid: deleted.federationGuid,
+            });
+            return;
+        case "model":
+            batch.models.push({ ecInstanceId, ecClassId });
+            return;
+        case "relationship": {
+            const { sourceECInstanceId, targetECInstanceId } = deleted;
+            if (sourceECInstanceId === undefined || targetECInstanceId === undefined)
+                core_bentley_1.ITwinError.throwError({
+                    iTwinErrorId: {
+                        scope: IModelTransformerError_1.IModelTransformerErrorScope,
+                        key: IModelTransformerError_1.IModelTransformerError.ChangedInstanceMetadataMissing,
+                    },
+                    message: `Relationship deletion ${ecInstanceId} is missing an endpoint.`,
+                });
+            batch.relationships.push({
+                ecInstanceId,
+                ecClassId,
+                sourceECInstanceId,
+                targetECInstanceId,
+            });
+            return;
+        }
+        case "externalSourceAspect": {
+            const { elementId, scopeId, kind, identifier } = deleted;
+            // Only an Element-kind aspect with these set can identify a target element.
+            if (elementId !== undefined &&
+                scopeId !== undefined &&
+                kind === core_backend_1.ExternalSourceAspect.Kind.Element &&
+                identifier !== undefined)
+                batch.externalSourceAspects.push({
+                    ecInstanceId,
+                    ecClassId,
+                    elementId,
+                    scopeId,
+                    kind,
+                    identifier,
+                });
+            return;
+        }
+        case "aspect":
+        case "codeSpec":
+        case "skippedRelationship":
+            return;
+        case undefined:
+            // Throws NotFound for a class missing from the current schemas. Other unhandled classes need no records.
+            iModel.getClassNameFromId(ecClassId);
+            return;
+    }
+}
+/**
+ * Reads each changeset once, unifies table changes into EC instance changes,
+ * normalizes overflow-only inserts and deletes to updates, writes all operations
+ * to [[ChangedInstanceIds]], and records the deleted instances needed to process deletions.
+ * @internal
+ */
+class ChangesetScanner {
+    /**
+     * Downloads the changesets in each range of an iModel.
+     * @param iModel the iModel to download changesets for.
+     * @param ranges inclusive ranges of changeset indices.
+     * @returns one group of changeset files per range, in the order of `ranges`.
+     */
+    static async download(iModel, ranges) {
+        const iModelId = iModel.iModelId;
+        return Promise.all(ranges.map(async ([first, end]) => core_backend_1.BriefcaseManager.downloadChangesets({
+            iModelId,
+            range: { first, end },
+            targetDir: core_backend_1.BriefcaseManager.getChangeSetsPath(iModelId),
+        })));
+    }
+    /**
+     * Scans each group of changeset files in order with one reader and unifier per file.
+     * @param iModel Database used to resolve EC classes.
+     * @param csFileGroups Ordered groups of changeset files. Each group produces one deletion batch.
+     * @param options Where to write the changes, and whether to collect deletion records.
+     * @returns One deletion batch per group, empty when deletion records aren't collected.
+     */
+    static async scan(iModel, csFileGroups, { changedInstanceIds, collectDeletionRecords = true }) {
+        const classKinds = collectDeletionRecords
+            ? await SourceClassKinds_1.SourceClassKinds.query(iModel)
+            : undefined;
+        const batches = csFileGroups.map(() => ({
+            elements: [],
+            models: [],
+            relationships: [],
+            externalSourceAspects: [],
+        }));
+        const readChanges = function* () {
+            for (const [index, csFiles] of csFileGroups.entries()) {
+                for (const change of ChangesetScanner.readFiles(iModel, csFiles)) {
+                    if (classKinds !== undefined && change.$meta.op === "Deleted")
+                        addDeletionRecord(batches[index], {
+                            ecInstanceId: change.ECInstanceId,
+                            ecClassId: change.ECClassId,
+                            federationGuid: change.FederationGuid,
+                            sourceECInstanceId: change.SourceECInstanceId,
+                            targetECInstanceId: change.TargetECInstanceId,
+                            elementId: change.Element?.Id,
+                            scopeId: change.Scope?.Id,
+                            kind: change.Kind,
+                            identifier: change.Identifier,
+                        }, classKinds, iModel);
+                    yield change;
+                }
+            }
+        };
+        if (changedInstanceIds !== undefined)
+            await changedInstanceIds.addChanges(readChanges());
+        // Without an aggregate, the changes are read only to record their deletions.
+        else
+            for (const _change of readChanges())
+                ;
+        return batches;
+    }
+    static *readFiles(iModel, csFiles) {
+        for (const csFile of csFiles) {
+            const csReader = core_backend_1.ChangesetReader.openFile({
+                fileName: csFile.pathname,
+                db: iModel,
+                propFilter: core_backend_1.PropertyFilter.InstanceKeyAndIdentifiers,
+            });
+            const changeUnifier = new core_backend_1.PartialChangeUnifier();
+            try {
+                while (csReader.step())
+                    changeUnifier.appendFrom(csReader);
+                for (const change of changeUnifier.instances) {
+                    if (change.ECClassId === undefined)
+                        core_bentley_1.ITwinError.throwError({
+                            iTwinErrorId: {
+                                scope: IModelTransformerError_1.IModelTransformerErrorScope,
+                                key: IModelTransformerError_1.IModelTransformerError.ChangedInstanceMetadataMissing,
+                            },
+                            message: `ECClassId was not found for id: ${change.ECInstanceId}! Table is : ${change.$meta.tables}`,
+                        });
+                    // Change is recorded at table level, not EC entity level.
+                    // This normalizes overflow-table expansion records so they do not
+                    // appear as element inserts or deletes.
+                    if ((change.$meta.op === "Inserted" || change.$meta.op === "Deleted") &&
+                        change.$meta.tables.every((table) => table.endsWith("Overflow"))) {
+                        change.$meta.op = "Updated";
+                    }
+                    yield change;
+                }
+            }
+            finally {
+                try {
+                    changeUnifier[Symbol.dispose]();
+                }
+                finally {
+                    csReader[Symbol.dispose]();
+                }
+            }
+        }
+    }
+}
+exports.ChangesetScanner = ChangesetScanner;
+//# sourceMappingURL=ChangesetScanner.js.map

package/lib/cjs/ChangesetScanner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangesetScanner.js","sourceRoot":"","sources":["../../src/ChangesetScanner.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;;AAEH,sDAQ6B;AAC7B,sDAA6D;AAG7D,qEAGkC;AAClC,yDAAsD;AA+GtD;;;;;GAKG;AACH,2BACE,KAAoB,EACpB,OAAwB,EACxB,UAA4B,EAC5B,MAAgB;IAEhB,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IAC5C,QAAQ,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;QACrC,KAAK,SAAS;YACZ,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAClB,YAAY;gBACZ,SAAS;gBACT,cAAc,EAAE,OAAO,CAAC,cAAc;aACvC,CAAC,CAAC;YACH,OAAO;QACT,KAAK,OAAO;YACV,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC,CAAC;YAC/C,OAAO;QACT,KAAK,cAAc,EAAE,CAAC;YACpB,MAAM,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC;YAC3D,IAAI,kBAAkB,KAAK,SAAS,IAAI,kBAAkB,KAAK,SAAS;gBACtE,yBAAU,CAAC,UAAU,CAAC;oBACpB,YAAY,EAAE;wBACZ,KAAK,EAAE,oDAA2B;wBAClC,GAAG,EAAE,+CAAsB,CAAC,8BAA8B;qBAC3D;oBACD,OAAO,EAAE,yBAAyB,YAAY,0BAA0B;iBACzE,CAAC,CAAC;YACL,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC;gBACvB,YAAY;gBACZ,SAAS;gBACT,kBAAkB;gBAClB,kBAAkB;aACnB,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QACD,KAAK,sBAAsB,EAAE,CAAC;YAC5B,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;YACzD,4EAA4E;YAC5E,IACE,SAAS,KAAK,SAAS;gBACvB,OAAO,KAAK,SAAS;gBACrB,IAAI,KAAK,mCAAoB,CAAC,IAAI,CAAC,OAAO;gBAC1C,UAAU,KAAK,SAAS;gBAExB,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC;oBAC/B,YAAY;oBACZ,SAAS;oBACT,SAAS;oBACT,OAAO;oBACP,IAAI;oBACJ,UAAU;iBACX,CAAC,CAAC;YACL,OAAO;QACT,CAAC;QACD,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU,CAAC;QAChB,KAAK,qBAAqB;YACxB,OAAO;QACT,KAAK,SAAS;YACZ,yGAAyG;YACzG,MAAM,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;YACrC,OAAO;IACX,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH;IACE;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAC1B,MAAgB,EAChB,MAA8C;QAE9C,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QACjC,OAAO,OAAO,CAAC,GAAG,CAChB,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,EAAE,CAChC,+BAAgB,CAAC,kBAAkB,CAAC;YAClC,QAAQ;YACR,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;YACrB,SAAS,EAAE,+BAAgB,CAAC,iBAAiB,CAAC,QAAQ,CAAC;SACxD,CAAC,CACH,CACF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CACtB,MAAgB,EAChB,YAAoC,EACpC,EAAE,kBAAkB,EAAE,sBAAsB,GAAG,IAAI,EAAe;QAElE,MAAM,UAAU,GAAG,sBAAsB;YACvC,CAAC,CAAC,MAAM,mCAAgB,CAAC,KAAK,CAAC,MAAM,CAAC;YACtC,CAAC,CAAC,SAAS,CAAC;QACd,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,GAAkB,EAAE,CAAC,CAAC;YACrD,QAAQ,EAAE,EAAE;YACZ,MAAM,EAAE,EAAE;YACV,aAAa,EAAE,EAAE;YACjB,qBAAqB,EAAE,EAAE;SAC1B,CAAC,CAAC,CAAC;QACJ,MAAM,WAAW,GAAG,QAAQ,CAAC;YAC3B,KAAK,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,YAAY,CAAC,OAAO,EAAE,EAAE,CAAC;gBACtD,KAAK,MAAM,MAAM,IAAI,gBAAgB,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;oBACjE,IAAI,UAAU,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,SAAS;wBAC3D,iBAAiB,CACf,OAAO,CAAC,KAAK,CAAC,EACd;4BACE,YAAY,EAAE,MAAM,CAAC,YAAY;4BACjC,SAAS,EAAE,MAAM,CAAC,SAAS;4BAC3B,cAAc,EAAE,MAAM,CAAC,cAAc;4BACrC,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;4BAC7C,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;4BAC7C,SAAS,EAAE,MAAM,CAAC,OAAO,EAAE,EAAE;4BAC7B,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,EAAE;4BACzB,IAAI,EAAE,MAAM,CAAC,IAAI;4BACjB,UAAU,EAAE,MAAM,CAAC,UAAU;yBAC9B,EACD,UAAU,EACV,MAAM,CACP,CAAC;oBACJ,MAAM,MAAM,CAAC;gBACf,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QACF,IAAI,kBAAkB,KAAK,SAAS;YAClC,MAAM,kBAAkB,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;QACrD,6EAA6E;;YACxE,KAAK,MAAM,OAAO,IAAI,WAAW,EAAE;gBAAC,CAAC;QAC1C,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,MAAM,CAAC,CAAC,SAAS,CACvB,MAAgB,EAChB,OAA6B;QAE7B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAG,8BAAe,CAAC,QAAQ,CAAC;gBACxC,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,EAAE,EAAE,MAAM;gBACV,UAAU,EAAE,6BAAc,CAAC,yBAAyB;aACrD,CAAC,CAAC;YACH,MAAM,aAAa,GAAG,IAAI,mCAAoB,EAAE,CAAC;YACjD,IAAI,CAAC;gBACH,OAAO,QAAQ,CAAC,IAAI,EAAE;oBAAE,aAAa,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;gBAC3D,KAAK,MAAM,MAAM,IAAI,aAAa,CAAC,SAAS,EAAE,CAAC;oBAC7C,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS;wBAChC,yBAAU,CAAC,UAAU,CAAC;4BACpB,YAAY,EAAE;gCACZ,KAAK,EAAE,oDAA2B;gCAClC,GAAG,EAAE,+CAAsB,CAAC,8BAA8B;6BAC3D;4BACD,OAAO,EAAE,mCAAmC,MAAM,CAAC,YAAY,gBAAgB,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE;yBACrG,CAAC,CAAC;oBACL,0DAA0D;oBAC1D,kEAAkE;oBAClE,wCAAwC;oBACxC,IACE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,UAAU,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,SAAS,CAAC;wBACjE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,EAChE,CAAC;wBACD,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,SAAS,CAAC;oBAC9B,CAAC;oBACD,MAAM,MAAM,CAAC;gBACf,CAAC;YACH,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC;oBACH,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBAClC,CAAC;wBAAS,CAAC;oBACT,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC7B,CAAC;YACH,CAAC;QACH,CAAC;IACH,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/** @packageDocumentation\n * @module iModels\n */\n\nimport {\n  BriefcaseManager,\n  ChangeInstance,\n  ChangesetReader,\n  ExternalSourceAspect,\n  IModelDb,\n  PartialChangeUnifier,\n  PropertyFilter,\n} from \"@itwin/core-backend\";\nimport { Id64String, ITwinError } from \"@itwin/core-bentley\";\nimport { ChangesetFileProps } from \"@itwin/core-common\";\nimport type { ChangedInstanceIds } from \"./IModelExporter\";\nimport {\n  IModelTransformerError,\n  IModelTransformerErrorScope,\n} from \"./IModelTransformerError\";\nimport { SourceClassKinds } from \"./SourceClassKinds\";\n\n/**\n * Identity shared by all deletion records.\n * @beta\n */\nexport interface DeletionRecordBase {\n  /** ID of the deleted source instance. */\n  ecInstanceId: Id64String;\n  /** EC class ID of the deleted source instance. */\n  ecClassId: Id64String;\n}\n\n/**\n * A deleted source element.\n * @beta\n */\nexport interface ElementDeletionRecord extends DeletionRecordBase {\n  /** Federation GUID used to find the corresponding target element. Undefined when the element had none. */\n  federationGuid?: string;\n}\n\n/**\n * A deleted source model.\n * @beta\n */\nexport type ModelDeletionRecord = DeletionRecordBase;\n\n/**\n * A deleted source relationship derived from `BisCore:ElementRefersToElements`, excluding `BisCore:ElementDrivesElement`.\n * @beta\n */\nexport interface RelationshipDeletionRecord extends DeletionRecordBase {\n  /** Source endpoint of the deleted relationship. */\n  sourceECInstanceId: Id64String;\n  /** Target endpoint of the deleted relationship. */\n  targetECInstanceId: Id64String;\n}\n\n/**\n * A deleted source ExternalSourceAspect, used to find the target of an element deleted in the same batch.\n * Only aspects of kind `Element` with a scope and identifier are recorded, because only those identify a target element.\n * @beta\n */\nexport interface ExternalSourceAspectDeletionRecord extends DeletionRecordBase {\n  /** Element that owned the deleted aspect. */\n  elementId: Id64String;\n  /** Scope of the deleted aspect. */\n  scopeId: Id64String;\n  /** Kind of the deleted aspect. */\n  kind: string;\n  /** Identifier of the deleted aspect. */\n  identifier: string;\n}\n\n/**\n * Deleted source instances from one batch of changes.\n * @note Batches are processed in order. An `Element`-kind ExternalSourceAspect deletion is used to identify element deletions in the same batch. An empty array means nothing of that kind was deleted.\n * @beta\n */\nexport interface DeletionBatch {\n  /** Deleted elements. */\n  elements: ElementDeletionRecord[];\n  /** Deleted models. */\n  models: ModelDeletionRecord[];\n  /** Deleted relationships derived from `BisCore:ElementRefersToElements`, excluding `BisCore:ElementDrivesElement`. */\n  relationships: RelationshipDeletionRecord[];\n  /** Deleted `Element`-kind ExternalSourceAspects with a scope and identifier. Aspects of other kinds can be omitted. */\n  externalSourceAspects: ExternalSourceAspectDeletionRecord[];\n}\n\n/**\n * Changes read for [[IModelTransformer.collectChanges]].\n * @note The result must describe every change in the given ranges, as the default implementation does. Changes missing from\n * `changedInstanceIds`, including CodeSpec changes, aren't exported. Every relationship in\n * `changedInstanceIds.relationship.deleteIds` needs a matching deletion record, or its deletion is skipped with a warning.\n * An element or model deletion whose target can't be found through its record or the transformation's provenance is ignored.\n * @beta\n */\nexport interface CollectedChanges {\n  /** Changed instance IDs, including the owning elements of changed aspects. */\n  changedInstanceIds: ChangedInstanceIds;\n  /** Deletion batches of any granularity: one per changeset, one per range, or one for all ranges. */\n  deletionBatches: DeletionBatch[];\n}\n\n/**\n * The identifiers of a deleted instance that deletion records are built from, as read from a changeset with\n * `PropertyFilter.InstanceKeyAndIdentifiers`.\n * @internal\n */\nexport interface DeletedInstance {\n  ecInstanceId: Id64String;\n  ecClassId: Id64String;\n  federationGuid?: string;\n  sourceECInstanceId?: Id64String;\n  targetECInstanceId?: Id64String;\n  /** Owner of a deleted aspect. */\n  elementId?: Id64String;\n  scopeId?: Id64String;\n  kind?: string;\n  identifier?: string;\n}\n\ninterface ScanOptions {\n  /** Receives the changes. When undefined, changes are read only for their deletion records. */\n  changedInstanceIds?: ChangedInstanceIds;\n  /** Whether to collect deletion records. Defaults to true. */\n  collectDeletionRecords?: boolean;\n}\n\n/**\n * Adds a deleted instance to the deletion batch for its class.\n * @note Throws `IModelStatus.NotFound` when the instance's class is missing from the current schemas, because such a\n * deletion can't be classified.\n * @internal\n */\nexport function addDeletionRecord(\n  batch: DeletionBatch,\n  deleted: DeletedInstance,\n  classKinds: SourceClassKinds,\n  iModel: IModelDb\n): void {\n  const { ecInstanceId, ecClassId } = deleted;\n  switch (classKinds.kindOf(ecClassId)) {\n    case \"element\":\n      batch.elements.push({\n        ecInstanceId,\n        ecClassId,\n        federationGuid: deleted.federationGuid,\n      });\n      return;\n    case \"model\":\n      batch.models.push({ ecInstanceId, ecClassId });\n      return;\n    case \"relationship\": {\n      const { sourceECInstanceId, targetECInstanceId } = deleted;\n      if (sourceECInstanceId === undefined || targetECInstanceId === undefined)\n        ITwinError.throwError({\n          iTwinErrorId: {\n            scope: IModelTransformerErrorScope,\n            key: IModelTransformerError.ChangedInstanceMetadataMissing,\n          },\n          message: `Relationship deletion ${ecInstanceId} is missing an endpoint.`,\n        });\n      batch.relationships.push({\n        ecInstanceId,\n        ecClassId,\n        sourceECInstanceId,\n        targetECInstanceId,\n      });\n      return;\n    }\n    case \"externalSourceAspect\": {\n      const { elementId, scopeId, kind, identifier } = deleted;\n      // Only an Element-kind aspect with these set can identify a target element.\n      if (\n        elementId !== undefined &&\n        scopeId !== undefined &&\n        kind === ExternalSourceAspect.Kind.Element &&\n        identifier !== undefined\n      )\n        batch.externalSourceAspects.push({\n          ecInstanceId,\n          ecClassId,\n          elementId,\n          scopeId,\n          kind,\n          identifier,\n        });\n      return;\n    }\n    case \"aspect\":\n    case \"codeSpec\":\n    case \"skippedRelationship\":\n      return;\n    case undefined:\n      // Throws NotFound for a class missing from the current schemas. Other unhandled classes need no records.\n      iModel.getClassNameFromId(ecClassId);\n      return;\n  }\n}\n\n/**\n * Reads each changeset once, unifies table changes into EC instance changes,\n * normalizes overflow-only inserts and deletes to updates, writes all operations\n * to [[ChangedInstanceIds]], and records the deleted instances needed to process deletions.\n * @internal\n */\nexport class ChangesetScanner {\n  /**\n   * Downloads the changesets in each range of an iModel.\n   * @param iModel the iModel to download changesets for.\n   * @param ranges inclusive ranges of changeset indices.\n   * @returns one group of changeset files per range, in the order of `ranges`.\n   */\n  public static async download(\n    iModel: IModelDb,\n    ranges: readonly (readonly [number, number])[]\n  ): Promise<ChangesetFileProps[][]> {\n    const iModelId = iModel.iModelId;\n    return Promise.all(\n      ranges.map(async ([first, end]) =>\n        BriefcaseManager.downloadChangesets({\n          iModelId,\n          range: { first, end },\n          targetDir: BriefcaseManager.getChangeSetsPath(iModelId),\n        })\n      )\n    );\n  }\n\n  /**\n   * Scans each group of changeset files in order with one reader and unifier per file.\n   * @param iModel Database used to resolve EC classes.\n   * @param csFileGroups Ordered groups of changeset files. Each group produces one deletion batch.\n   * @param options Where to write the changes, and whether to collect deletion records.\n   * @returns One deletion batch per group, empty when deletion records aren't collected.\n   */\n  public static async scan(\n    iModel: IModelDb,\n    csFileGroups: ChangesetFileProps[][],\n    { changedInstanceIds, collectDeletionRecords = true }: ScanOptions\n  ): Promise<DeletionBatch[]> {\n    const classKinds = collectDeletionRecords\n      ? await SourceClassKinds.query(iModel)\n      : undefined;\n    const batches = csFileGroups.map((): DeletionBatch => ({\n      elements: [],\n      models: [],\n      relationships: [],\n      externalSourceAspects: [],\n    }));\n    const readChanges = function* (): Generator<ChangeInstance> {\n      for (const [index, csFiles] of csFileGroups.entries()) {\n        for (const change of ChangesetScanner.readFiles(iModel, csFiles)) {\n          if (classKinds !== undefined && change.$meta.op === \"Deleted\")\n            addDeletionRecord(\n              batches[index],\n              {\n                ecInstanceId: change.ECInstanceId,\n                ecClassId: change.ECClassId,\n                federationGuid: change.FederationGuid,\n                sourceECInstanceId: change.SourceECInstanceId,\n                targetECInstanceId: change.TargetECInstanceId,\n                elementId: change.Element?.Id,\n                scopeId: change.Scope?.Id,\n                kind: change.Kind,\n                identifier: change.Identifier,\n              },\n              classKinds,\n              iModel\n            );\n          yield change;\n        }\n      }\n    };\n    if (changedInstanceIds !== undefined)\n      await changedInstanceIds.addChanges(readChanges());\n    // Without an aggregate, the changes are read only to record their deletions.\n    else for (const _change of readChanges());\n    return batches;\n  }\n\n  private static *readFiles(\n    iModel: IModelDb,\n    csFiles: ChangesetFileProps[]\n  ): Generator<ChangeInstance> {\n    for (const csFile of csFiles) {\n      const csReader = ChangesetReader.openFile({\n        fileName: csFile.pathname,\n        db: iModel,\n        propFilter: PropertyFilter.InstanceKeyAndIdentifiers,\n      });\n      const changeUnifier = new PartialChangeUnifier();\n      try {\n        while (csReader.step()) changeUnifier.appendFrom(csReader);\n        for (const change of changeUnifier.instances) {\n          if (change.ECClassId === undefined)\n            ITwinError.throwError({\n              iTwinErrorId: {\n                scope: IModelTransformerErrorScope,\n                key: IModelTransformerError.ChangedInstanceMetadataMissing,\n              },\n              message: `ECClassId was not found for id: ${change.ECInstanceId}! Table is : ${change.$meta.tables}`,\n            });\n          // Change is recorded at table level, not EC entity level.\n          // This normalizes overflow-table expansion records so they do not\n          // appear as element inserts or deletes.\n          if (\n            (change.$meta.op === \"Inserted\" || change.$meta.op === \"Deleted\") &&\n            change.$meta.tables.every((table) => table.endsWith(\"Overflow\"))\n          ) {\n            change.$meta.op = \"Updated\";\n          }\n          yield change;\n        }\n      } finally {\n        try {\n          changeUnifier[Symbol.dispose]();\n        } finally {\n          csReader[Symbol.dispose]();\n        }\n      }\n    }\n  }\n}\n"]}

package/lib/cjs/ECReferenceTypesCache.d.ts

@@ -22,9 +22,6 @@ export declare class ECReferenceTypesCache {
     private _propQualifierToRefType;
     private _relClassNameEndToRefTypes;
     private _initedSchemas;
-    private _rootBisClassCache;
-    private _relationshipInfoCache;
-    private _constraintClassCache;
     private static bisRootClassToRefType;
     private getRootBisClass;
     private getAbstractConstraintClass;
@@ -35,6 +32,5 @@ export declare class ECReferenceTypesCache {
     private relInfoFromRelClass;
     getNavPropRefType(schemaName: string, className: string, propName: string): undefined | ConcreteEntityTypes;
     getRelationshipEndType(schemaName: string, className: string): undefined | RelTypeInfo;
-    clear(): void;
 }
 //# sourceMappingURL=ECReferenceTypesCache.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ECReferenceTypesCache.d.ts","sourceRoot":"","sources":["../../src/ECReferenceTypesCache.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAWtE,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAG/C;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,KAAK;;CAI7C;AAED;;;;;;;GAOG;AACH,qBAAa,qBAAqB;IAChC,uGAAuG;IACvG,OAAO,CAAC,uBAAuB,CAG3B;IACJ,OAAO,CAAC,0BAA0B,CAG9B;IACJ,OAAO,CAAC,cAAc,CAAgC;IAGtD,OAAO,CAAC,kBAAkB,CAA8B;IACxD,OAAO,CAAC,sBAAsB,CAA8C;IAC5E,OAAO,CAAC,qBAAqB,CAA8B;IAE3D,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAalC;YAEY,eAAe;YAmCf,0BAA0B;IAqBxC,8CAA8C;IACjC,sBAAsB,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;YAuDtD,kBAAkB;YAalB,UAAU;YA4FV,mBAAmB;IA4D1B,iBAAiB,CACtB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,GACf,SAAS,GAAG,mBAAmB;IAS3B,sBAAsB,CAC3B,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,GAChB,SAAS,GAAG,WAAW;IAQnB,KAAK;CAQb"}
+{"version":3,"file":"ECReferenceTypesCache.d.ts","sourceRoot":"","sources":["../../src/ECReferenceTypesCache.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAYtE,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAO/C;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,KAAK;IAC5C,cAEC;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,qBAAqB;IAChC,uGAAuG;IACvG,OAAO,CAAC,uBAAuB,CAG3B;IACJ,OAAO,CAAC,0BAA0B,CAG9B;IACJ,OAAO,CAAC,cAAc,CAAgC;IAEtD,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAWlC;YAEY,eAAe;YA2Bf,0BAA0B;IAaxC,8CAA8C;IACjC,sBAAsB,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CA+BnE;YAEa,kBAAkB;YAalB,UAAU;YAoEV,mBAAmB;IA4D1B,iBAAiB,CACtB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,GACf,SAAS,GAAG,mBAAmB,CAOjC;IAEM,sBAAsB,CAC3B,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,GAChB,SAAS,GAAG,WAAW,CAMzB;CACF"}