@itwin/core-backend 3.5.0-dev.19 → 3.5.0-dev.21

package/lib/cjs/IModelElementCloneContext.d.ts

@@ -0,0 +1,90 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { ElementProps } from "@itwin/core-common";
+import { IModelJsNative } from "@bentley/imodeljs-native";
+import { Element } from "./Element";
+import { IModelDb } from "./IModelDb";
+import { SQLiteDb } from "./SQLiteDb";
+/** The context for transforming a *source* Element to a *target* Element and remapping internal identifiers to the target iModel.
+ * @beta
+ */
+export declare class IModelElementCloneContext {
+    /** The source IModelDb. */
+    readonly sourceDb: IModelDb;
+    /** The target IModelDb. */
+    readonly targetDb: IModelDb;
+    /** The native import context */
+    private _nativeContext;
+    /** Construct a new IModelElementCloneContext. It must be initialized with `initialize`, consider using [[IModelElementCloneContext.create]] instead
+     * @param sourceDb The source IModelDb.
+     * @param targetDb If provided the target IModelDb. If not provided, the source and target are the same IModelDb.
+     */
+    constructor(sourceDb: IModelDb, targetDb?: IModelDb);
+    /** perform necessary initialization to use a clone context, namely caching the reference types in the source's schemas */
+    initialize(): Promise<void>;
+    /** construct and initialize an IModelElementCloneContext at once, for where you construct in an async context */
+    static create(...args: ConstructorParameters<typeof IModelElementCloneContext>): Promise<IModelElementCloneContext>;
+    /** Returns `true` if this context is for transforming between 2 iModels and `false` if it for transforming within the same iModel. */
+    get isBetweenIModels(): boolean;
+    /** Dispose any native resources associated with this IModelElementCloneContext. */
+    dispose(): void;
+    /** Debugging aid that dumps the Id remapping details and other information to the specified output file.
+     * @internal
+     */
+    dump(outputFileName: string): void;
+    /** Add a rule that remaps the specified source [CodeSpec]($common) to the specified target [CodeSpec]($common).
+     * @param sourceCodeSpecName The name of the CodeSpec from the source iModel.
+     * @param targetCodeSpecName The name of the CodeSpec from the target iModel.
+     * @throws [[IModelError]] if either CodeSpec could not be found.
+     */
+    remapCodeSpec(sourceCodeSpecName: string, targetCodeSpecName: string): void;
+    /** Add a rule that remaps the specified source class to the specified target class. */
+    remapElementClass(sourceClassFullName: string, targetClassFullName: string): void;
+    /** Add a rule that remaps the specified source Element to the specified target Element. */
+    remapElement(sourceId: Id64String, targetId: Id64String): void;
+    /** Remove a rule that remaps the specified source Element. */
+    removeElement(sourceId: Id64String): void;
+    /** Look up a target CodeSpecId from the source CodeSpecId.
+     * @returns the target CodeSpecId or [Id64.invalid]($bentley) if a mapping not found.
+     */
+    findTargetCodeSpecId(sourceId: Id64String): Id64String;
+    /** Look up a target ElementId from the source ElementId.
+     * @returns the target ElementId or [Id64.invalid]($bentley) if a mapping not found.
+     */
+    findTargetElementId(sourceElementId: Id64String): Id64String;
+    /** Filter out geometry entries in the specified SubCategory from GeometryStreams in the target iModel.
+     * @note It is not possible to filter out a *default* SubCategory. A request to do so will be ignored.
+     * @see [SubCategory.isDefaultSubCategory]($backend)
+     */
+    filterSubCategory(sourceSubCategoryId: Id64String): void;
+    /** Returns `true` if there are any SubCategories being filtered. */
+    get hasSubCategoryFilter(): boolean;
+    /** Returns `true` if this SubCategory is being filtered. */
+    isSubCategoryFiltered(subCategoryId: Id64String): boolean;
+    /** Import the specified font from the source iModel into the target iModel.
+     * @internal
+     */
+    importFont(sourceFontNumber: number): void;
+    /** Import a single CodeSpec from the source iModel into the target iModel.
+     * @internal
+     */
+    importCodeSpec(sourceCodeSpecId: Id64String): void;
+    /** Clone the specified source Element into ElementProps for the target iModel.
+     * @internal
+     */
+    cloneElement(sourceElement: Element, cloneOptions?: IModelJsNative.CloneElementOptions): ElementProps;
+    /**
+     * serialize state to a sqlite database at a given path
+     * assumes the database has not already had any context state serialized to it
+     * @internal
+     */
+    saveStateToDb(db: SQLiteDb): void;
+    /**
+     * load state from a sqlite database at a given path
+     * @internal
+     */
+    loadStateFromDb(db: SQLiteDb): void;
+}
+//# sourceMappingURL=IModelElementCloneContext.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IModelElementCloneContext.d.ts","sourceRoot":"","sources":["../../src/IModelElementCloneContext.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAiC,YAAY,EAA4C,MAAM,oBAAoB,CAAC;AAC3H,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;GAEG;AACH,qBAAa,yBAAyB;IACpC,2BAA2B;IAC3B,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,2BAA2B;IAC3B,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,gCAAgC;IAChC,OAAO,CAAC,cAAc,CAA+B;IAErD;;;OAGG;gBACgB,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,QAAQ;IAM1D,0HAA0H;IAC7G,UAAU;IAGvB,iHAAiH;WAC7F,MAAM,CAAC,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,yBAAyB,CAAC,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAMhI,sIAAsI;IACtI,IAAW,gBAAgB,IAAI,OAAO,CAA4C;IAElF,mFAAmF;IAC5E,OAAO,IAAI,IAAI;IAEtB;;OAEG;IACI,IAAI,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAEzC;;;;OAIG;IACI,aAAa,CAAC,kBAAkB,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,IAAI;IAMlF,uFAAuF;IAChF,iBAAiB,CAAC,mBAAmB,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,GAAG,IAAI;IAIxF,2FAA2F;IACpF,YAAY,CAAC,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,IAAI;IAIrE,8DAA8D;IACvD,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,IAAI;IAIhD;;OAEG;IACI,oBAAoB,CAAC,QAAQ,EAAE,UAAU,GAAG,UAAU;IAO7D;;OAEG;IACI,mBAAmB,CAAC,eAAe,EAAE,UAAU,GAAG,UAAU;IAOnE;;;OAGG;IACI,iBAAiB,CAAC,mBAAmB,EAAE,UAAU,GAAG,IAAI;IAO/D,oEAAoE;IACpE,IAAW,oBAAoB,IAAI,OAAO,CAEzC;IAED,4DAA4D;IACrD,qBAAqB,CAAC,aAAa,EAAE,UAAU,GAAG,OAAO;IAIhE;;OAEG;IACI,UAAU,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI;IAKjD;;OAEG;IACI,cAAc,CAAC,gBAAgB,EAAE,UAAU,GAAG,IAAI;IAIzD;;OAEG;IACI,YAAY,CAAC,aAAa,EAAE,OAAO,EAAE,YAAY,CAAC,EAAE,cAAc,CAAC,mBAAmB,GAAG,YAAY;IAyB5G;;;;OAIG;IACI,aAAa,CAAC,EAAE,EAAE,QAAQ,GAAG,IAAI;IAIxC;;;OAGG;IACI,eAAe,CAAC,EAAE,EAAE,QAAQ,GAAG,IAAI;CAG3C"}

package/lib/cjs/IModelElementCloneContext.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IModelElementCloneContext = void 0;
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const Category_1 = require("./Category");
+const IModelHost_1 = require("./IModelHost");
+/** The context for transforming a *source* Element to a *target* Element and remapping internal identifiers to the target iModel.
+ * @beta
+ */
+class IModelElementCloneContext {
+    /** Construct a new IModelElementCloneContext. It must be initialized with `initialize`, consider using [[IModelElementCloneContext.create]] instead
+     * @param sourceDb The source IModelDb.
+     * @param targetDb If provided the target IModelDb. If not provided, the source and target are the same IModelDb.
+     */
+    constructor(sourceDb, targetDb) {
+        this.sourceDb = sourceDb;
+        this.targetDb = (undefined !== targetDb) ? targetDb : sourceDb;
+        this._nativeContext = new IModelHost_1.IModelHost.platform.ImportContext(this.sourceDb.nativeDb, this.targetDb.nativeDb);
+    }
+    /** perform necessary initialization to use a clone context, namely caching the reference types in the source's schemas */
+    async initialize() {
+    }
+    /** construct and initialize an IModelElementCloneContext at once, for where you construct in an async context */
+    static async create(...args) {
+        const instance = new this(...args);
+        await instance.initialize();
+        return instance;
+    }
+    /** Returns `true` if this context is for transforming between 2 iModels and `false` if it for transforming within the same iModel. */
+    get isBetweenIModels() { return this.sourceDb !== this.targetDb; }
+    /** Dispose any native resources associated with this IModelElementCloneContext. */
+    dispose() { this._nativeContext.dispose(); }
+    /** Debugging aid that dumps the Id remapping details and other information to the specified output file.
+     * @internal
+     */
+    dump(outputFileName) { this._nativeContext.dump(outputFileName); }
+    /** Add a rule that remaps the specified source [CodeSpec]($common) to the specified target [CodeSpec]($common).
+     * @param sourceCodeSpecName The name of the CodeSpec from the source iModel.
+     * @param targetCodeSpecName The name of the CodeSpec from the target iModel.
+     * @throws [[IModelError]] if either CodeSpec could not be found.
+     */
+    remapCodeSpec(sourceCodeSpecName, targetCodeSpecName) {
+        const sourceCodeSpec = this.sourceDb.codeSpecs.getByName(sourceCodeSpecName);
+        const targetCodeSpec = this.targetDb.codeSpecs.getByName(targetCodeSpecName);
+        this._nativeContext.addCodeSpecId(sourceCodeSpec.id, targetCodeSpec.id);
+    }
+    /** Add a rule that remaps the specified source class to the specified target class. */
+    remapElementClass(sourceClassFullName, targetClassFullName) {
+        this._nativeContext.addClass(sourceClassFullName, targetClassFullName);
+    }
+    /** Add a rule that remaps the specified source Element to the specified target Element. */
+    remapElement(sourceId, targetId) {
+        this._nativeContext.addElementId(sourceId, targetId);
+    }
+    /** Remove a rule that remaps the specified source Element. */
+    removeElement(sourceId) {
+        this._nativeContext.removeElementId(sourceId);
+    }
+    /** Look up a target CodeSpecId from the source CodeSpecId.
+     * @returns the target CodeSpecId or [Id64.invalid]($bentley) if a mapping not found.
+     */
+    findTargetCodeSpecId(sourceId) {
+        if (core_bentley_1.Id64.invalid === sourceId) {
+            return core_bentley_1.Id64.invalid;
+        }
+        return this._nativeContext.findCodeSpecId(sourceId);
+    }
+    /** Look up a target ElementId from the source ElementId.
+     * @returns the target ElementId or [Id64.invalid]($bentley) if a mapping not found.
+     */
+    findTargetElementId(sourceElementId) {
+        if (core_bentley_1.Id64.invalid === sourceElementId) {
+            return core_bentley_1.Id64.invalid;
+        }
+        return this._nativeContext.findElementId(sourceElementId);
+    }
+    /** Filter out geometry entries in the specified SubCategory from GeometryStreams in the target iModel.
+     * @note It is not possible to filter out a *default* SubCategory. A request to do so will be ignored.
+     * @see [SubCategory.isDefaultSubCategory]($backend)
+     */
+    filterSubCategory(sourceSubCategoryId) {
+        const sourceSubCategory = this.sourceDb.elements.tryGetElement(sourceSubCategoryId, Category_1.SubCategory);
+        if (sourceSubCategory && !sourceSubCategory.isDefaultSubCategory) {
+            this._nativeContext.filterSubCategoryId(sourceSubCategoryId);
+        }
+    }
+    /** Returns `true` if there are any SubCategories being filtered. */
+    get hasSubCategoryFilter() {
+        return this._nativeContext.hasSubCategoryFilter();
+    }
+    /** Returns `true` if this SubCategory is being filtered. */
+    isSubCategoryFiltered(subCategoryId) {
+        return this._nativeContext.isSubCategoryFiltered(subCategoryId);
+    }
+    /** Import the specified font from the source iModel into the target iModel.
+     * @internal
+     */
+    importFont(sourceFontNumber) {
+        this.targetDb.clearFontMap(); // so it will be reloaded with new font info
+        this._nativeContext.importFont(sourceFontNumber);
+    }
+    /** Import a single CodeSpec from the source iModel into the target iModel.
+     * @internal
+     */
+    importCodeSpec(sourceCodeSpecId) {
+        this._nativeContext.importCodeSpec(sourceCodeSpecId);
+    }
+    /** Clone the specified source Element into ElementProps for the target iModel.
+     * @internal
+     */
+    cloneElement(sourceElement, cloneOptions) {
+        const targetElementProps = this._nativeContext.cloneElement(sourceElement.id, cloneOptions);
+        // Ensure that all NavigationProperties in targetElementProps have a defined value so "clearing" changes will be part of the JSON used for update
+        sourceElement.forEachProperty((propertyName, meta) => {
+            if ((meta.isNavigation) && (undefined === sourceElement[propertyName])) {
+                targetElementProps[propertyName] = core_common_1.RelatedElement.none;
+            }
+        }, false); // exclude custom because C++ has already handled them
+        if (this.isBetweenIModels) {
+            // The native C++ cloneElement strips off federationGuid, want to put it back if transformation is between iModels
+            targetElementProps.federationGuid = sourceElement.federationGuid;
+            if (core_common_1.CodeScopeSpec.Type.Repository === this.targetDb.codeSpecs.getById(targetElementProps.code.spec).scopeType) {
+                targetElementProps.code.scope = core_common_1.IModel.rootSubjectId;
+            }
+        }
+        // unlike other references, code cannot be null. If it is null, use an empty code instead
+        if (targetElementProps.code.scope === core_bentley_1.Id64.invalid || targetElementProps.code.spec === core_bentley_1.Id64.invalid) {
+            targetElementProps.code = core_common_1.Code.createEmpty();
+        }
+        const jsClass = this.sourceDb.getJsClass(sourceElement.classFullName);
+        // eslint-disable-next-line @typescript-eslint/dot-notation
+        jsClass["onCloned"](this, sourceElement.toJSON(), targetElementProps);
+        return targetElementProps;
+    }
+    /**
+     * serialize state to a sqlite database at a given path
+     * assumes the database has not already had any context state serialized to it
+     * @internal
+     */
+    saveStateToDb(db) {
+        this._nativeContext.saveStateToDb(db.nativeDb);
+    }
+    /**
+     * load state from a sqlite database at a given path
+     * @internal
+     */
+    loadStateFromDb(db) {
+        this._nativeContext.loadStateFromDb(db.nativeDb);
+    }
+}
+exports.IModelElementCloneContext = IModelElementCloneContext;
+//# sourceMappingURL=IModelElementCloneContext.js.map

package/lib/cjs/IModelElementCloneContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelElementCloneContext.js","sourceRoot":"","sources":["../../src/IModelElementCloneContext.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,sDAAuD;AACvD,oDAA2H;AAE3H,yCAAyC;AAGzC,6CAA0C;AAG1C;;GAEG;AACH,MAAa,yBAAyB;IAQpC;;;OAGG;IACH,YAAmB,QAAkB,EAAE,QAAmB;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC/D,IAAI,CAAC,cAAc,GAAG,IAAI,uBAAU,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC9G,CAAC;IAED,0HAA0H;IACnH,KAAK,CAAC,UAAU;IACvB,CAAC;IAED,iHAAiH;IAC1G,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAA6D;QACzF,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACnC,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC5B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,sIAAsI;IACtI,IAAW,gBAAgB,KAAc,OAAO,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAElF,mFAAmF;IAC5E,OAAO,KAAW,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IAEzD;;OAEG;IACI,IAAI,CAAC,cAAsB,IAAU,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAEvF;;;;OAIG;IACI,aAAa,CAAC,kBAA0B,EAAE,kBAA0B;QACzE,MAAM,cAAc,GAAa,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QACvF,MAAM,cAAc,GAAa,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QACvF,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,uFAAuF;IAChF,iBAAiB,CAAC,mBAA2B,EAAE,mBAA2B;QAC/E,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAC;IACzE,CAAC;IAED,2FAA2F;IACpF,YAAY,CAAC,QAAoB,EAAE,QAAoB;QAC5D,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;IAED,8DAA8D;IACvD,aAAa,CAAC,QAAoB;QACvC,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACI,oBAAoB,CAAC,QAAoB;QAC9C,IAAI,mBAAI,CAAC,OAAO,KAAK,QAAQ,EAAE;YAC7B,OAAO,mBAAI,CAAC,OAAO,CAAC;SACrB;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,mBAAmB,CAAC,eAA2B;QACpD,IAAI,mBAAI,CAAC,OAAO,KAAK,eAAe,EAAE;YACpC,OAAO,mBAAI,CAAC,OAAO,CAAC;SACrB;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,mBAA+B;QACtD,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAc,mBAAmB,EAAE,sBAAW,CAAC,CAAC;QAC9G,IAAI,iBAAiB,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,EAAE;YAChE,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;SAC9D;IACH,CAAC;IAED,oEAAoE;IACpE,IAAW,oBAAoB;QAC7B,OAAO,IAAI,CAAC,cAAc,CAAC,oBAAoB,EAAE,CAAC;IACpD,CAAC;IAED,4DAA4D;IACrD,qBAAqB,CAAC,aAAyB;QACpD,OAAO,IAAI,CAAC,cAAc,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,gBAAwB;QACxC,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,4CAA4C;QAC1E,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,gBAA4B;QAChD,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,YAAY,CAAC,aAAsB,EAAE,YAAiD;QAC3F,MAAM,kBAAkB,GAAiB,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;QAC1G,iJAAiJ;QACjJ,aAAa,CAAC,eAAe,CAAC,CAAC,YAAoB,EAAE,IAAsB,EAAE,EAAE;YAC7E,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,KAAM,aAAqB,CAAC,YAAY,CAAC,CAAC,EAAE;gBAC9E,kBAA0B,CAAC,YAAY,CAAC,GAAG,4BAAc,CAAC,IAAI,CAAC;aACjE;QACH,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,sDAAsD;QACjE,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,kHAAkH;YAClH,kBAAkB,CAAC,cAAc,GAAG,aAAa,CAAC,cAAc,CAAC;YACjE,IAAI,2BAAa,CAAC,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE;gBAC7G,kBAAkB,CAAC,IAAI,CAAC,KAAK,GAAG,oBAAM,CAAC,aAAa,CAAC;aACtD;SACF;QACD,yFAAyF;QACzF,IAAI,kBAAkB,CAAC,IAAI,CAAC,KAAK,KAAK,mBAAI,CAAC,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,KAAK,mBAAI,CAAC,OAAO,EAAE;YACnG,kBAAkB,CAAC,IAAI,GAAG,kBAAI,CAAC,WAAW,EAAE,CAAC;SAC9C;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAiB,aAAa,CAAC,aAAa,CAAC,CAAC;QACtF,2DAA2D;QAC3D,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,CAAC;QACtE,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,EAAY;QAC/B,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,EAAY;QACjC,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;CACF;AAtKD,8DAsKC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { Code, CodeScopeSpec, CodeSpec, ElementProps, IModel, PropertyMetaData, RelatedElement } from \"@itwin/core-common\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { SubCategory } from \"./Category\";\r\nimport { Element } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { SQLiteDb } from \"./SQLiteDb\";\r\n\r\n/** The context for transforming a *source* Element to a *target* Element and remapping internal identifiers to the target iModel.\r\n * @beta\r\n */\r\nexport class IModelElementCloneContext {\r\n  /** The source IModelDb. */\r\n  public readonly sourceDb: IModelDb;\r\n  /** The target IModelDb. */\r\n  public readonly targetDb: IModelDb;\r\n  /** The native import context */\r\n  private _nativeContext: IModelJsNative.ImportContext;\r\n\r\n  /** Construct a new IModelElementCloneContext. It must be initialized with `initialize`, consider using [[IModelElementCloneContext.create]] instead\r\n   * @param sourceDb The source IModelDb.\r\n   * @param targetDb If provided the target IModelDb. If not provided, the source and target are the same IModelDb.\r\n   */\r\n  public constructor(sourceDb: IModelDb, targetDb?: IModelDb) {\r\n    this.sourceDb = sourceDb;\r\n    this.targetDb = (undefined !== targetDb) ? targetDb : sourceDb;\r\n    this._nativeContext = new IModelHost.platform.ImportContext(this.sourceDb.nativeDb, this.targetDb.nativeDb);\r\n  }\r\n\r\n  /** perform necessary initialization to use a clone context, namely caching the reference types in the source's schemas */\r\n  public async initialize() {\r\n  }\r\n\r\n  /** construct and initialize an IModelElementCloneContext at once, for where you construct in an async context */\r\n  public static async create(...args: ConstructorParameters<typeof IModelElementCloneContext>): Promise<IModelElementCloneContext> {\r\n    const instance = new this(...args);\r\n    await instance.initialize();\r\n    return instance;\r\n  }\r\n\r\n  /** Returns `true` if this context is for transforming between 2 iModels and `false` if it for transforming within the same iModel. */\r\n  public get isBetweenIModels(): boolean { return this.sourceDb !== this.targetDb; }\r\n\r\n  /** Dispose any native resources associated with this IModelElementCloneContext. */\r\n  public dispose(): void { this._nativeContext.dispose(); }\r\n\r\n  /** Debugging aid that dumps the Id remapping details and other information to the specified output file.\r\n   * @internal\r\n   */\r\n  public dump(outputFileName: string): void { this._nativeContext.dump(outputFileName); }\r\n\r\n  /** Add a rule that remaps the specified source [CodeSpec]($common) to the specified target [CodeSpec]($common).\r\n   * @param sourceCodeSpecName The name of the CodeSpec from the source iModel.\r\n   * @param targetCodeSpecName The name of the CodeSpec from the target iModel.\r\n   * @throws [[IModelError]] if either CodeSpec could not be found.\r\n   */\r\n  public remapCodeSpec(sourceCodeSpecName: string, targetCodeSpecName: string): void {\r\n    const sourceCodeSpec: CodeSpec = this.sourceDb.codeSpecs.getByName(sourceCodeSpecName);\r\n    const targetCodeSpec: CodeSpec = this.targetDb.codeSpecs.getByName(targetCodeSpecName);\r\n    this._nativeContext.addCodeSpecId(sourceCodeSpec.id, targetCodeSpec.id);\r\n  }\r\n\r\n  /** Add a rule that remaps the specified source class to the specified target class. */\r\n  public remapElementClass(sourceClassFullName: string, targetClassFullName: string): void {\r\n    this._nativeContext.addClass(sourceClassFullName, targetClassFullName);\r\n  }\r\n\r\n  /** Add a rule that remaps the specified source Element to the specified target Element. */\r\n  public remapElement(sourceId: Id64String, targetId: Id64String): void {\r\n    this._nativeContext.addElementId(sourceId, targetId);\r\n  }\r\n\r\n  /** Remove a rule that remaps the specified source Element. */\r\n  public removeElement(sourceId: Id64String): void {\r\n    this._nativeContext.removeElementId(sourceId);\r\n  }\r\n\r\n  /** Look up a target CodeSpecId from the source CodeSpecId.\r\n   * @returns the target CodeSpecId or [Id64.invalid]($bentley) if a mapping not found.\r\n   */\r\n  public findTargetCodeSpecId(sourceId: Id64String): Id64String {\r\n    if (Id64.invalid === sourceId) {\r\n      return Id64.invalid;\r\n    }\r\n    return this._nativeContext.findCodeSpecId(sourceId);\r\n  }\r\n\r\n  /** Look up a target ElementId from the source ElementId.\r\n   * @returns the target ElementId or [Id64.invalid]($bentley) if a mapping not found.\r\n   */\r\n  public findTargetElementId(sourceElementId: Id64String): Id64String {\r\n    if (Id64.invalid === sourceElementId) {\r\n      return Id64.invalid;\r\n    }\r\n    return this._nativeContext.findElementId(sourceElementId);\r\n  }\r\n\r\n  /** Filter out geometry entries in the specified SubCategory from GeometryStreams in the target iModel.\r\n   * @note It is not possible to filter out a *default* SubCategory. A request to do so will be ignored.\r\n   * @see [SubCategory.isDefaultSubCategory]($backend)\r\n   */\r\n  public filterSubCategory(sourceSubCategoryId: Id64String): void {\r\n    const sourceSubCategory = this.sourceDb.elements.tryGetElement<SubCategory>(sourceSubCategoryId, SubCategory);\r\n    if (sourceSubCategory && !sourceSubCategory.isDefaultSubCategory) {\r\n      this._nativeContext.filterSubCategoryId(sourceSubCategoryId);\r\n    }\r\n  }\r\n\r\n  /** Returns `true` if there are any SubCategories being filtered. */\r\n  public get hasSubCategoryFilter(): boolean {\r\n    return this._nativeContext.hasSubCategoryFilter();\r\n  }\r\n\r\n  /** Returns `true` if this SubCategory is being filtered. */\r\n  public isSubCategoryFiltered(subCategoryId: Id64String): boolean {\r\n    return this._nativeContext.isSubCategoryFiltered(subCategoryId);\r\n  }\r\n\r\n  /** Import the specified font from the source iModel into the target iModel.\r\n   * @internal\r\n   */\r\n  public importFont(sourceFontNumber: number): void {\r\n    this.targetDb.clearFontMap(); // so it will be reloaded with new font info\r\n    this._nativeContext.importFont(sourceFontNumber);\r\n  }\r\n\r\n  /** Import a single CodeSpec from the source iModel into the target iModel.\r\n   * @internal\r\n   */\r\n  public importCodeSpec(sourceCodeSpecId: Id64String): void {\r\n    this._nativeContext.importCodeSpec(sourceCodeSpecId);\r\n  }\r\n\r\n  /** Clone the specified source Element into ElementProps for the target iModel.\r\n   * @internal\r\n   */\r\n  public cloneElement(sourceElement: Element, cloneOptions?: IModelJsNative.CloneElementOptions): ElementProps {\r\n    const targetElementProps: ElementProps = this._nativeContext.cloneElement(sourceElement.id, cloneOptions);\r\n    // Ensure that all NavigationProperties in targetElementProps have a defined value so \"clearing\" changes will be part of the JSON used for update\r\n    sourceElement.forEachProperty((propertyName: string, meta: PropertyMetaData) => {\r\n      if ((meta.isNavigation) && (undefined === (sourceElement as any)[propertyName])) {\r\n        (targetElementProps as any)[propertyName] = RelatedElement.none;\r\n      }\r\n    }, false); // exclude custom because C++ has already handled them\r\n    if (this.isBetweenIModels) {\r\n      // The native C++ cloneElement strips off federationGuid, want to put it back if transformation is between iModels\r\n      targetElementProps.federationGuid = sourceElement.federationGuid;\r\n      if (CodeScopeSpec.Type.Repository === this.targetDb.codeSpecs.getById(targetElementProps.code.spec).scopeType) {\r\n        targetElementProps.code.scope = IModel.rootSubjectId;\r\n      }\r\n    }\r\n    // unlike other references, code cannot be null. If it is null, use an empty code instead\r\n    if (targetElementProps.code.scope === Id64.invalid || targetElementProps.code.spec === Id64.invalid) {\r\n      targetElementProps.code = Code.createEmpty();\r\n    }\r\n    const jsClass = this.sourceDb.getJsClass<typeof Element>(sourceElement.classFullName);\r\n    // eslint-disable-next-line @typescript-eslint/dot-notation\r\n    jsClass[\"onCloned\"](this, sourceElement.toJSON(), targetElementProps);\r\n    return targetElementProps;\r\n  }\r\n\r\n  /**\r\n   * serialize state to a sqlite database at a given path\r\n   * assumes the database has not already had any context state serialized to it\r\n   * @internal\r\n   */\r\n  public saveStateToDb(db: SQLiteDb): void {\r\n    this._nativeContext.saveStateToDb(db.nativeDb);\r\n  }\r\n\r\n  /**\r\n   * load state from a sqlite database at a given path\r\n   * @internal\r\n   */\r\n  public loadStateFromDb(db: SQLiteDb): void {\r\n    this._nativeContext.loadStateFromDb(db.nativeDb);\r\n  }\r\n}\r\n"]}