@itwin/core-backend 5.0.0-dev.9 → 5.0.0-dev.92

package/lib/esm/IModelDbFonts.d.ts

@@ -0,0 +1,54 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { FontFamilyDescriptor, FontFamilySelector, FontId, FontProps } from "@itwin/core-common";
+import { _implementationProhibited } from "./internal/Symbols";
+import { FontFile } from "./FontFile";
+/** Arguments supplied to [[IModelDbFonts.embedFontFile]].
+ * @beta
+ */
+export interface EmbedFontFileArgs {
+    /** The file to embed. */
+    file: FontFile;
+    /** Unless true, [[IModelDbFonts.acquireId]] will be used to ensure that every font family in [[file]] is assigned a [FontId]($common). */
+    skipFontIdAllocation?: boolean;
+}
+/** Arguments supplied to [[IModelDbFonts.queryMappedFamilies]].
+ * @beta
+ */
+export interface QueryMappedFamiliesArgs {
+    /** If true, include families that have been assigned a [FontId]($common) but for which no [FontFace]($common)s have been embedded. */
+    includeNonEmbedded?: boolean;
+}
+/** Provides read-write access to the [font-related information]($docs/learning/backend/Fonts.md) stored in an [[IModelDb]].
+ * @see [[IModelDb.fonts]] to access the fonts for a specific iModel.
+ * @beta
+ */
+export interface IModelDbFonts {
+    /** @internal */
+    readonly [_implementationProhibited]: unknown;
+    /** Obtain the collection of font families that have been assigned a [FontId]($common).
+     * By default, font families with no corresponding embedded font faces are omitted.
+     */
+    queryMappedFamilies(args?: QueryMappedFamiliesArgs): Iterable<FontProps>;
+    /** Obtain the collection of [[FontFile]]s embedded in the iModel.
+     * A FontFile obtained from one iModel can be embedded into another iModel using [[embedFontFile]], but the source iModel must remain open
+     */
+    queryEmbeddedFontFiles(): Iterable<FontFile>;
+    /** Store a [[FontFile]] in the iModel. By default, this method also ensures a [FontId]($common) is assigned to each font family in the file. */
+    embedFontFile(args: EmbedFontFileArgs): Promise<void>;
+    /** Returns the Id assigned to the specified font family, or `undefined` if no Id has been assigned.
+     * If only a name is supplied instead of a descriptor, and more than one family with the same name but different types exist, then
+     * [FontType.TrueType]($common) will be preferred over [FontType.Rsc]($common), and [FontType.Rsc]($common) over [FontType.Shx]($common).
+     * @see [[acquireId]] to assign an Id.
+     * @see [[findDescriptor]] to perform a reverse lookup.
+     */
+    findId(selector: FontFamilySelector): FontId | undefined;
+    /** Returns the font family associated with the specified Id, or `undefined` if no such mapping exists.
+     * @see [[findId]] to perform a reverse lookup.
+     */
+    findDescriptor(id: FontId): FontFamilyDescriptor | undefined;
+    /** Look up the Id assigned to the specified font family, allocating a new Id if one has not already been assigned. */
+    acquireId(descriptor: FontFamilyDescriptor): Promise<FontId>;
+}
+//# sourceMappingURL=IModelDbFonts.d.ts.map

package/lib/esm/IModelDbFonts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelDbFonts.d.ts","sourceRoot":"","sources":["../../src/IModelDbFonts.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACjG,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,yBAAyB;IACzB,IAAI,EAAE,QAAQ,CAAC;IACf,0IAA0I;IAC1I,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,sIAAsI;IACtI,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,gBAAgB;IAChB,QAAQ,CAAC,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAE9C;;OAEG;IACH,mBAAmB,CAAC,IAAI,CAAC,EAAE,uBAAuB,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IAEzE;;OAEG;IACH,sBAAsB,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAE7C,gJAAgJ;IAChJ,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,kBAAkB,GAAG,MAAM,GAAG,SAAS,CAAC;IAEzD;;OAEG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,oBAAoB,GAAG,SAAS,CAAC;IAE7D,sHAAsH;IACtH,SAAS,CAAC,UAAU,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC9D"}

package/lib/esm/IModelDbFonts.js

@@ -0,0 +1,9 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { _implementationProhibited } from "./internal/Symbols";
+//# sourceMappingURL=IModelDbFonts.js.map

package/lib/esm/IModelDbFonts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelDbFonts.js","sourceRoot":"","sources":["../../src/IModelDbFonts.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC","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 { FontFamilyDescriptor, FontFamilySelector, FontId, FontProps } from \"@itwin/core-common\";\nimport { _implementationProhibited } from \"./internal/Symbols\";\nimport { FontFile } from \"./FontFile\";\n\n/** Arguments supplied to [[IModelDbFonts.embedFontFile]].\n * @beta\n */\nexport interface EmbedFontFileArgs {\n  /** The file to embed. */\n  file: FontFile;\n  /** Unless true, [[IModelDbFonts.acquireId]] will be used to ensure that every font family in [[file]] is assigned a [FontId]($common). */\n  skipFontIdAllocation?: boolean;\n}\n\n/** Arguments supplied to [[IModelDbFonts.queryMappedFamilies]].\n * @beta\n */\nexport interface QueryMappedFamiliesArgs {\n  /** If true, include families that have been assigned a [FontId]($common) but for which no [FontFace]($common)s have been embedded. */\n  includeNonEmbedded?: boolean;\n}\n\n/** Provides read-write access to the [font-related information]($docs/learning/backend/Fonts.md) stored in an [[IModelDb]].\n * @see [[IModelDb.fonts]] to access the fonts for a specific iModel.\n * @beta\n */\nexport interface IModelDbFonts {\n  /** @internal */\n  readonly [_implementationProhibited]: unknown;\n\n  /** Obtain the collection of font families that have been assigned a [FontId]($common).\n   * By default, font families with no corresponding embedded font faces are omitted.\n   */\n  queryMappedFamilies(args?: QueryMappedFamiliesArgs): Iterable<FontProps>;\n\n  /** Obtain the collection of [[FontFile]]s embedded in the iModel.\n   * A FontFile obtained from one iModel can be embedded into another iModel using [[embedFontFile]], but the source iModel must remain open\n   */\n  queryEmbeddedFontFiles(): Iterable<FontFile>;\n\n  /** Store a [[FontFile]] in the iModel. By default, this method also ensures a [FontId]($common) is assigned to each font family in the file. */\n  embedFontFile(args: EmbedFontFileArgs): Promise<void>;\n\n  /** Returns the Id assigned to the specified font family, or `undefined` if no Id has been assigned.\n   * If only a name is supplied instead of a descriptor, and more than one family with the same name but different types exist, then\n   * [FontType.TrueType]($common) will be preferred over [FontType.Rsc]($common), and [FontType.Rsc]($common) over [FontType.Shx]($common).\n   * @see [[acquireId]] to assign an Id.\n   * @see [[findDescriptor]] to perform a reverse lookup.\n   */\n  findId(selector: FontFamilySelector): FontId | undefined;\n\n  /** Returns the font family associated with the specified Id, or `undefined` if no such mapping exists.\n   * @see [[findId]] to perform a reverse lookup.\n   */\n  findDescriptor(id: FontId): FontFamilyDescriptor | undefined;\n\n  /** Look up the Id assigned to the specified font family, allocating a new Id if one has not already been assigned. */\n  acquireId(descriptor: FontFamilyDescriptor): Promise<FontId>;\n}\n"]}

package/lib/esm/IModelElementCloneContext.d.ts

@@ -0,0 +1,92 @@
+/** @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. */
+    [Symbol.dispose](): void;
+    /** @deprecated in 5.0 Use [Symbol.dispose] instead. */
+    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/esm/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;AAGtC;;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,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;IAE/B,uDAAuD;IAChD,OAAO;IAId;;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;IA0B5G;;;;OAIG;IACI,aAAa,CAAC,EAAE,EAAE,QAAQ,GAAG,IAAI;IAIxC;;;OAGG;IACI,eAAe,CAAC,EAAE,EAAE,QAAQ,GAAG,IAAI;CAG3C"}

package/lib/esm/IModelElementCloneContext.js

@@ -0,0 +1,168 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { Id64 } from "@itwin/core-bentley";
+import { Code, CodeScopeSpec, IModel, RelatedElement } from "@itwin/core-common";
+import { SubCategory } from "./Category";
+import { IModelNative } from "./internal/NativePlatform";
+import { _nativeDb } from "./internal/Symbols";
+/** The context for transforming a *source* Element to a *target* Element and remapping internal identifiers to the target iModel.
+ * @beta
+ */
+export class IModelElementCloneContext {
+    /** The source IModelDb. */
+    sourceDb;
+    /** The target IModelDb. */
+    targetDb;
+    /** The native import context */
+    _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, targetDb) {
+        this.sourceDb = sourceDb;
+        this.targetDb = (undefined !== targetDb) ? targetDb : sourceDb;
+        this._nativeContext = new IModelNative.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. */
+    [Symbol.dispose]() { this._nativeContext.dispose(); }
+    /** @deprecated in 5.0 Use [Symbol.dispose] instead. */
+    dispose() {
+        this[Symbol.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 (Id64.invalid === sourceId) {
+            return 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 (Id64.invalid === sourceElementId) {
+            return 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, 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
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        sourceElement.forEachProperty((propertyName, meta) => {
+            if ((meta.isNavigation) && (undefined === sourceElement[propertyName])) {
+                targetElementProps[propertyName] = 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 (CodeScopeSpec.Type.Repository === this.targetDb.codeSpecs.getById(targetElementProps.code.spec).scopeType) {
+                targetElementProps.code.scope = IModel.rootSubjectId;
+            }
+        }
+        // unlike other references, code cannot be null. If it is null, use an empty code instead
+        if (targetElementProps.code.scope === Id64.invalid || targetElementProps.code.spec === Id64.invalid) {
+            targetElementProps.code = 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]);
+    }
+}
+//# sourceMappingURL=IModelElementCloneContext.js.map

package/lib/esm/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,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,aAAa,EAA0B,MAAM,EAAoB,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAE3H,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C;;GAEG;AACH,MAAM,OAAO,yBAAyB;IACpC,2BAA2B;IACX,QAAQ,CAAW;IACnC,2BAA2B;IACX,QAAQ,CAAW;IACnC,gCAAgC;IACxB,cAAc,CAA+B;IAErD;;;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,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IACpH,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,CAAC,MAAM,CAAC,OAAO,CAAC,KAAW,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IAElE,uDAAuD;IAChD,OAAO;QACZ,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED;;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,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,mBAAmB,CAAC,eAA2B;QACpD,IAAI,IAAI,CAAC,OAAO,KAAK,eAAe,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;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,WAAW,CAAC,CAAC;QAC9G,IAAI,iBAAiB,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,EAAE,CAAC;YACjE,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;QAC/D,CAAC;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,4DAA4D;QAC5D,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,CAAC;gBAC/E,kBAA0B,CAAC,YAAY,CAAC,GAAG,cAAc,CAAC,IAAI,CAAC;YAClE,CAAC;QACH,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,sDAAsD;QACjE,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,kHAAkH;YAClH,kBAAkB,CAAC,cAAc,GAAG,aAAa,CAAC,cAAc,CAAC;YACjE,IAAI,aAAa,CAAC,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;gBAC9G,kBAAkB,CAAC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,aAAa,CAAC;YACvD,CAAC;QACH,CAAC;QACD,yFAAyF;QACzF,IAAI,kBAAkB,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;YACpG,kBAAkB,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAC/C,CAAC;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,SAAS,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,EAAY;QACjC,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IACrD,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 */\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { Code, CodeScopeSpec, CodeSpec, ElementProps, IModel, PropertyMetaData, RelatedElement } from \"@itwin/core-common\";\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\nimport { SubCategory } from \"./Category\";\nimport { Element } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { SQLiteDb } from \"./SQLiteDb\";\nimport { _nativeDb } from \"./internal/Symbols\";\n\n/** The context for transforming a *source* Element to a *target* Element and remapping internal identifiers to the target iModel.\n * @beta\n */\nexport class IModelElementCloneContext {\n  /** The source IModelDb. */\n  public readonly sourceDb: IModelDb;\n  /** The target IModelDb. */\n  public readonly targetDb: IModelDb;\n  /** The native import context */\n  private _nativeContext: IModelJsNative.ImportContext;\n\n  /** Construct a new IModelElementCloneContext. It must be initialized with `initialize`, consider using [[IModelElementCloneContext.create]] instead\n   * @param sourceDb The source IModelDb.\n   * @param targetDb If provided the target IModelDb. If not provided, the source and target are the same IModelDb.\n   */\n  public constructor(sourceDb: IModelDb, targetDb?: IModelDb) {\n    this.sourceDb = sourceDb;\n    this.targetDb = (undefined !== targetDb) ? targetDb : sourceDb;\n    this._nativeContext = new IModelNative.platform.ImportContext(this.sourceDb[_nativeDb], this.targetDb[_nativeDb]);\n  }\n\n  /** perform necessary initialization to use a clone context, namely caching the reference types in the source's schemas */\n  public async initialize() {\n  }\n\n  /** construct and initialize an IModelElementCloneContext at once, for where you construct in an async context */\n  public static async create(...args: ConstructorParameters<typeof IModelElementCloneContext>): Promise<IModelElementCloneContext> {\n    const instance = new this(...args);\n    await instance.initialize();\n    return instance;\n  }\n\n  /** Returns `true` if this context is for transforming between 2 iModels and `false` if it for transforming within the same iModel. */\n  public get isBetweenIModels(): boolean { return this.sourceDb !== this.targetDb; }\n\n  /** Dispose any native resources associated with this IModelElementCloneContext. */\n  public [Symbol.dispose](): void { this._nativeContext.dispose(); }\n\n  /** @deprecated in 5.0 Use [Symbol.dispose] instead. */\n  public dispose() {\n    this[Symbol.dispose]();\n  }\n\n  /** Debugging aid that dumps the Id remapping details and other information to the specified output file.\n   * @internal\n   */\n  public dump(outputFileName: string): void { this._nativeContext.dump(outputFileName); }\n\n  /** Add a rule that remaps the specified source [CodeSpec]($common) to the specified target [CodeSpec]($common).\n   * @param sourceCodeSpecName The name of the CodeSpec from the source iModel.\n   * @param targetCodeSpecName The name of the CodeSpec from the target iModel.\n   * @throws [[IModelError]] if either CodeSpec could not be found.\n   */\n  public remapCodeSpec(sourceCodeSpecName: string, targetCodeSpecName: string): void {\n    const sourceCodeSpec: CodeSpec = this.sourceDb.codeSpecs.getByName(sourceCodeSpecName);\n    const targetCodeSpec: CodeSpec = this.targetDb.codeSpecs.getByName(targetCodeSpecName);\n    this._nativeContext.addCodeSpecId(sourceCodeSpec.id, targetCodeSpec.id);\n  }\n\n  /** Add a rule that remaps the specified source class to the specified target class. */\n  public remapElementClass(sourceClassFullName: string, targetClassFullName: string): void {\n    this._nativeContext.addClass(sourceClassFullName, targetClassFullName);\n  }\n\n  /** Add a rule that remaps the specified source Element to the specified target Element. */\n  public remapElement(sourceId: Id64String, targetId: Id64String): void {\n    this._nativeContext.addElementId(sourceId, targetId);\n  }\n\n  /** Remove a rule that remaps the specified source Element. */\n  public removeElement(sourceId: Id64String): void {\n    this._nativeContext.removeElementId(sourceId);\n  }\n\n  /** Look up a target CodeSpecId from the source CodeSpecId.\n   * @returns the target CodeSpecId or [Id64.invalid]($bentley) if a mapping not found.\n   */\n  public findTargetCodeSpecId(sourceId: Id64String): Id64String {\n    if (Id64.invalid === sourceId) {\n      return Id64.invalid;\n    }\n    return this._nativeContext.findCodeSpecId(sourceId);\n  }\n\n  /** Look up a target ElementId from the source ElementId.\n   * @returns the target ElementId or [Id64.invalid]($bentley) if a mapping not found.\n   */\n  public findTargetElementId(sourceElementId: Id64String): Id64String {\n    if (Id64.invalid === sourceElementId) {\n      return Id64.invalid;\n    }\n    return this._nativeContext.findElementId(sourceElementId);\n  }\n\n  /** Filter out geometry entries in the specified SubCategory from GeometryStreams in the target iModel.\n   * @note It is not possible to filter out a *default* SubCategory. A request to do so will be ignored.\n   * @see [SubCategory.isDefaultSubCategory]($backend)\n   */\n  public filterSubCategory(sourceSubCategoryId: Id64String): void {\n    const sourceSubCategory = this.sourceDb.elements.tryGetElement<SubCategory>(sourceSubCategoryId, SubCategory);\n    if (sourceSubCategory && !sourceSubCategory.isDefaultSubCategory) {\n      this._nativeContext.filterSubCategoryId(sourceSubCategoryId);\n    }\n  }\n\n  /** Returns `true` if there are any SubCategories being filtered. */\n  public get hasSubCategoryFilter(): boolean {\n    return this._nativeContext.hasSubCategoryFilter();\n  }\n\n  /** Returns `true` if this SubCategory is being filtered. */\n  public isSubCategoryFiltered(subCategoryId: Id64String): boolean {\n    return this._nativeContext.isSubCategoryFiltered(subCategoryId);\n  }\n\n  /** Import the specified font from the source iModel into the target iModel.\n   * @internal\n   */\n  public importFont(sourceFontNumber: number): void {\n    this.targetDb.clearFontMap(); // so it will be reloaded with new font info\n    this._nativeContext.importFont(sourceFontNumber);\n  }\n\n  /** Import a single CodeSpec from the source iModel into the target iModel.\n   * @internal\n   */\n  public importCodeSpec(sourceCodeSpecId: Id64String): void {\n    this._nativeContext.importCodeSpec(sourceCodeSpecId);\n  }\n\n  /** Clone the specified source Element into ElementProps for the target iModel.\n   * @internal\n   */\n  public cloneElement(sourceElement: Element, cloneOptions?: IModelJsNative.CloneElementOptions): ElementProps {\n    const targetElementProps: ElementProps = this._nativeContext.cloneElement(sourceElement.id, cloneOptions);\n    // Ensure that all NavigationProperties in targetElementProps have a defined value so \"clearing\" changes will be part of the JSON used for update\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    sourceElement.forEachProperty((propertyName: string, meta: PropertyMetaData) => {\n      if ((meta.isNavigation) && (undefined === (sourceElement as any)[propertyName])) {\n        (targetElementProps as any)[propertyName] = RelatedElement.none;\n      }\n    }, false); // exclude custom because C++ has already handled them\n    if (this.isBetweenIModels) {\n      // The native C++ cloneElement strips off federationGuid, want to put it back if transformation is between iModels\n      targetElementProps.federationGuid = sourceElement.federationGuid;\n      if (CodeScopeSpec.Type.Repository === this.targetDb.codeSpecs.getById(targetElementProps.code.spec).scopeType) {\n        targetElementProps.code.scope = IModel.rootSubjectId;\n      }\n    }\n    // unlike other references, code cannot be null. If it is null, use an empty code instead\n    if (targetElementProps.code.scope === Id64.invalid || targetElementProps.code.spec === Id64.invalid) {\n      targetElementProps.code = Code.createEmpty();\n    }\n    const jsClass = this.sourceDb.getJsClass<typeof Element>(sourceElement.classFullName);\n    // eslint-disable-next-line @typescript-eslint/dot-notation\n    jsClass[\"onCloned\"](this, sourceElement.toJSON(), targetElementProps);\n    return targetElementProps;\n  }\n\n  /**\n   * serialize state to a sqlite database at a given path\n   * assumes the database has not already had any context state serialized to it\n   * @internal\n   */\n  public saveStateToDb(db: SQLiteDb): void {\n    this._nativeContext.saveStateToDb(db[_nativeDb]);\n  }\n\n  /**\n   * load state from a sqlite database at a given path\n   * @internal\n   */\n  public loadStateFromDb(db: SQLiteDb): void {\n    this._nativeContext.loadStateFromDb(db[_nativeDb]);\n  }\n}\n"]}