[WIP] - Aquire locks during onElement and onModel api's

.github/workflows/ci.yml

@@ -2,13 +2,14 @@ name: CI
 
 on:
   pull_request:
-    branches: [ "main" ]
+    branches: [ "main", "itwinjs-v5" ]
   workflow_dispatch:
 
 jobs:
   check-change-files:
+    if: github.bas_ref == 'main'
     runs-on: ubuntu-latest
-    name: Check change files
+    name: Check change files 
 
     steps:
     - name: Checkout
@@ -21,10 +22,10 @@ jobs:
       with:
         version: 9.14.2
 
-    - name: Use Node.js 20
+    - name: Use Node.js 22
       uses: actions/setup-node@v3
       with:
-        node-version: 20.18.1
+        node-version: 22.12.0
         cache: 'pnpm'
 
     - name: Install dependencies
@@ -48,10 +49,10 @@ jobs:
       with:
         version: 9.14.2
 
-    - name: Use Node.js 20
+    - name: Use Node.js 22
       uses: actions/setup-node@v3
       with:
-        node-version: 20.18.1
+        node-version: 22.12.0
         cache: 'pnpm'
 
     - id: set-matrix
@@ -104,10 +105,10 @@ jobs:
       with:
         version: 9.14.2
 
-    - name: Use Node.js 20
+    - name: Use Node.js 22
       uses: actions/setup-node@v3
       with:
-        node-version: 20.18.1
+        node-version: 22.12.0
         cache: 'pnpm'
 
     - name: Force dependency resolution
@@ -161,6 +162,7 @@ jobs:
         CORE_VERSION: ${{ matrix.version }}
 
     - name: Lint
+      if: github.ref == 'refs/heads/main'
       run: pnpm run lint
 
     - name: Build

.github/workflows/extract-api.yaml

@@ -35,10 +35,10 @@ jobs:
         with:
           version: 9.14.2
 
-      - name: Use Node.js 20
+      - name: Use Node.js 22
         uses: actions/setup-node@v3
         with:
-          node-version: 20.18.1
+          node-version: 22.12.0
           cache: 'pnpm'
 
       - name: Pnpm install

.github/workflows/release-dev.yml

@@ -31,10 +31,10 @@ jobs:
       with:
         version: 9.14.2
 
-    - name: Use Node.js 20
+    - name: Use Node.js 22
       uses: actions/setup-node@v3
       with:
-        node-version: 20.18.1
+        node-version: 22.12.0
         registry-url: https://registry.npmjs.org/
 
     - name: Install dependencies

.github/workflows/release.yml

@@ -19,10 +19,10 @@ jobs:
       with:
         version: 9.14.2
 
-    - name: Use Node.js 20
+    - name: Use Node.js 22
       uses: actions/setup-node@v3
       with:
-        node-version: 20.18.1
+        node-version: 22.12.0
         registry-url: https://registry.npmjs.org/
 
     - name: Install dependencies

.husky/pre-commit

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npm run pre-commit
+lint-staged

change/@itwin-imodel-transformer-6aca5427-b509-472e-8478-7883e75f326f.json

@@ -0,0 +1,7 @@
+{
+  "type": "major",
+  "comment": "Upgrade to iTwin.js 5.0.",
+  "packageName": "@itwin/imodel-transformer",
+  "email": "22944042+pmconne@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}

common/api/imodel-transformer.api.md

@@ -21,6 +21,7 @@ import { EntityProps } from '@itwin/core-common';
 import { EntityReference } from '@itwin/core-common';
 import { ExternalSourceAspect } from '@itwin/core-backend';
 import { ExternalSourceAspectProps } from '@itwin/core-common';
+import { FontFamilyDescriptor } from '@itwin/core-common';
 import { FontProps } from '@itwin/core-common';
 import { Helmert2DWithZOffset } from '@itwin/core-common';
 import { Id64Arg } from '@itwin/core-bentley';
@@ -149,6 +150,8 @@ export class IModelExporter {
     exportCodeSpecByName(codeSpecName: string): Promise<void>;
     exportCodeSpecs(): Promise<void>;
     exportElement(elementId: Id64String): Promise<void>;
+    exportFontByFontFamilyDescriptor(fontFamily: FontFamilyDescriptor): Promise<void>;
+    exportFontByFontProps(fontProps: FontProps): Promise<void>;
     exportFontByName(fontName: string): Promise<void>;
     exportFontByNumber(fontNumber: number): Promise<void>;
     exportFonts(): Promise<void>;
@@ -175,15 +178,15 @@ export class IModelExporter {
 // @beta
 export abstract class IModelExportHandler {
     onDeleteElement(_elementId: Id64String): void;
-    onDeleteModel(_modelId: Id64String): void;
+    onDeleteModel(_modelId: Id64String): Promise<void>;
     onDeleteRelationship(_relInstanceId: Id64String): void;
     onExportCodeSpec(_codeSpec: CodeSpec, _isUpdate: boolean | undefined): void;
-    onExportElement(_element: Element_2, _isUpdate: boolean | undefined): void;
-    onExportElementMultiAspects(_aspects: ElementMultiAspect[]): void;
-    onExportElementUniqueAspect(_aspect: ElementUniqueAspect, _isUpdate: boolean | undefined): void;
+    onExportElement(_element: Element_2, _isUpdate: boolean | undefined): Promise<void>;
+    onExportElementMultiAspects(_aspects: ElementMultiAspect[]): Promise<void>;
+    onExportElementUniqueAspect(_aspect: ElementUniqueAspect, _isUpdate: boolean | undefined): Promise<void>;
     onExportFont(_font: FontProps, _isUpdate: boolean | undefined): void;
-    onExportModel(_model: Model, _isUpdate: boolean | undefined): void;
-    onExportRelationship(_relationship: Relationship, _isUpdate: boolean | undefined): void;
+    onExportModel(_model: Model, _isUpdate: boolean | undefined): Promise<void>;
+    onExportRelationship(_relationship: Relationship, _isUpdate: boolean | undefined): Promise<void>;
     onExportSchema(_schema: Schema): Promise<void | ExportSchemaResult>;
     onProgress(): Promise<void>;
     onSkipElement(_elementId: Id64String): void;
@@ -200,30 +203,30 @@ export abstract class IModelExportHandler {
 export class IModelImporter {
     constructor(targetDb: IModelDb, options?: IModelImportOptions);
     computeProjectExtents(): void;
-    deleteElement(elementId: Id64String): void;
-    deleteModel(modelId: Id64String): void;
+    deleteElement(elementId: Id64String): Promise<void>;
+    deleteModel(modelId: Id64String): Promise<void>;
     deleteRelationship(relationshipProps: RelationshipPropsForDelete): void;
     readonly doNotUpdateElementIds: Set<string>;
     finalize(): void;
-    importElement(elementProps: ElementProps): Id64String;
+    importElement(elementProps: ElementProps): Promise<Id64String>;
     importElementMultiAspects(aspectPropsArray: ElementAspectProps[],
-    filterFunc?: (a: ElementMultiAspect) => boolean): Id64String[];
-    importElementUniqueAspect(aspectProps: ElementAspectProps): Id64String;
-    importModel(modelProps: ModelProps): void;
+    filterFunc?: (a: ElementMultiAspect) => boolean): Promise<Id64String[]>;
+    importElementUniqueAspect(aspectProps: ElementAspectProps): Promise<Id64String>;
+    importModel(modelProps: ModelProps): Promise<void>;
     importRelationship(relationshipProps: RelationshipProps): Id64String;
     markElementToUpdateDuringPreserveIds(elementId: Id64String): void;
-    protected onDeleteElement(elementId: Id64String): void;
-    protected onDeleteElementAspect(targetElementAspect: ElementAspect): void;
-    protected onDeleteModel(modelId: Id64String): void;
+    protected onDeleteElement(elementId: Id64String): Promise<void>;
+    protected onDeleteElementAspect(targetElementAspect: ElementAspect): Promise<void>;
+    protected onDeleteModel(modelId: Id64String): Promise<void>;
     protected onDeleteRelationship(relationshipProps: RelationshipPropsForDelete): void;
-    protected onInsertElement(elementProps: ElementProps): Id64String;
-    protected onInsertElementAspect(aspectProps: ElementAspectProps): Id64String;
-    protected onInsertModel(modelProps: ModelProps): Id64String;
+    protected onInsertElement(elementProps: ElementProps): Promise<Id64String>;
+    protected onInsertElementAspect(aspectProps: ElementAspectProps): Promise<Id64String>;
+    protected onInsertModel(modelProps: ModelProps): Promise<Id64String>;
     protected onInsertRelationship(relationshipProps: RelationshipProps): Id64String;
     protected onProgress(): void;
-    protected onUpdateElement(elementProps: ElementProps): void;
-    protected onUpdateElementAspect(aspectProps: ElementAspectProps): void;
-    protected onUpdateModel(modelProps: ModelProps): void;
+    protected onUpdateElement(elementProps: ElementProps): Promise<void>;
+    protected onUpdateElementAspect(aspectProps: ElementAspectProps): Promise<void>;
+    protected onUpdateModel(modelProps: ModelProps): Promise<void>;
     protected onUpdateRelationship(relationshipProps: RelationshipProps): void;
     optimizeGeometry(options: OptimizeGeometryOptions): void;
     readonly options: Required<IModelImportOptions>;
@@ -233,6 +236,7 @@ export class IModelImporter {
 
 // @beta
 export interface IModelImportOptions {
+    acquireElementLocks?: boolean;
     autoExtendProjectExtents?: boolean | {
         excludeOutliers: boolean;
     };
@@ -250,18 +254,14 @@ export class IModelTransformer extends IModelExportHandler {
     calculateTransformFromHelmertTransforms(): Transform | undefined;
     combineElements(sourceElementIds: Id64Array, targetElementId: Id64String): void;
     // (undocumented)
-    protected completePartiallyCommittedAspects(): void;
+    protected completePartiallyCommittedAspects(): Promise<void>;
     // (undocumented)
-    protected completePartiallyCommittedElements(): void;
+    protected completePartiallyCommittedElements(): Promise<void>;
     readonly context: IModelCloneContext;
     // (undocumented)
     static convertHelmertToTransform(helmert: Helmert2DWithZOffset | undefined): Transform;
-    // @deprecated
-    detectElementDeletes(): Promise<void>;
-    // @deprecated
-    detectRelationshipDeletes(): Promise<void>;
     static determineSyncType(sourceDb: IModelDb, targetDb: IModelDb,
-    targetScopeElementId: Id64String): "forward" | "reverse";
+    targetScopeElementId: Id64String): Promise<"forward" | "reverse">;
     dispose(): void;
     protected _elementsWithExplicitlyTrackedProvenance: Set<string>;
     readonly exporter: IModelExporter;
@@ -272,11 +272,17 @@ export class IModelTransformer extends IModelExportHandler {
         isReverseSynchronization: boolean;
         fn: (sourceElementId: Id64String, targetElementId: Id64String) => void;
         skipPropagateChangesToRootElements: boolean;
-    }): void;
-    protected get hasDefinitionContainerDeletionFeature(): boolean;
+    }): Promise<void>;
+    // (undocumented)
+    getIsForwardSynchronization(): Promise<boolean>;
+    // (undocumented)
+    getIsReverseSynchronization(): Promise<boolean>;
+    getProvenanceDb(): Promise<IModelDb>;
+    getProvenanceSourceDb(): Promise<IModelDb>;
+    protected getSynchronizationVersion(): Promise<ChangesetIndexAndId>;
     protected hasElementChanged(sourceElement: Element_2): boolean;
     readonly importer: IModelImporter;
-    initElementProvenance(sourceElementId: Id64String, targetElementId: Id64String): ExternalSourceAspectProps;
+    initElementProvenance(sourceElementId: Id64String, targetElementId: Id64String): Promise<ExternalSourceAspectProps>;
     static initElementProvenanceOptions(sourceElementId: Id64String, targetElementId: Id64String, args: {
         sourceDb: IModelDb;
         targetDb: IModelDb;
@@ -291,27 +297,23 @@ export class IModelTransformer extends IModelExportHandler {
         isReverseSynchronization: boolean;
         targetScopeElementId: Id64String;
         forceOldRelationshipProvenanceMethod: boolean;
-    }): ExternalSourceAspectProps;
-    protected initScopeProvenance(): void;
-    // (undocumented)
-    get isForwardSynchronization(): boolean;
-    // (undocumented)
-    get isReverseSynchronization(): boolean;
+    }): Promise<ExternalSourceAspectProps>;
+    protected initScopeProvenance(): Promise<void>;
     // (undocumented)
     static noEsaSyncDirectionErrorMessage: string;
-    onDeleteElement(sourceElementId: Id64String): void;
-    onDeleteModel(sourceModelId: Id64String): void;
-    onDeleteRelationship(sourceRelInstanceId: Id64String): void;
+    onDeleteElement(sourceElementId: Id64String): Promise<void>;
+    onDeleteModel(sourceModelId: Id64String): Promise<void>;
+    onDeleteRelationship(sourceRelInstanceId: Id64String): Promise<void>;
     onExportCodeSpec(sourceCodeSpec: CodeSpec): void;
-    onExportElement(sourceElement: Element_2): void;
-    onExportElementMultiAspects(sourceAspects: ElementMultiAspect[]): void;
-    onExportElementUniqueAspect(sourceAspect: ElementUniqueAspect): void;
+    onExportElement(sourceElement: Element_2): Promise<void>;
+    onExportElementMultiAspects(sourceAspects: ElementMultiAspect[]): Promise<void>;
+    onExportElementUniqueAspect(sourceAspect: ElementUniqueAspect): Promise<void>;
     onExportFont(font: FontProps, _isUpdate: boolean | undefined): void;
-    onExportModel(sourceModel: Model): void;
-    onExportRelationship(sourceRelationship: Relationship): void;
+    onExportModel(sourceModel: Model): Promise<void>;
+    onExportRelationship(sourceRelationship: Relationship): Promise<void>;
     onExportSchema(schema: ECSchemaMetaData.Schema): Promise<void | ExportSchemaResult>;
-    onTransformElement(sourceElement: Element_2): ElementProps;
-    protected onTransformElementAspect(sourceElementAspect: ElementAspect): ElementAspectProps;
+    onTransformElement(sourceElement: Element_2): Promise<ElementProps>;
+    protected onTransformElementAspect(sourceElementAspect: ElementAspect): Promise<ElementAspectProps>;
     onTransformModel(sourceModel: Model, targetModeledElementId: Id64String): ModelProps;
     protected onTransformRelationship(sourceRelationship: Relationship): RelationshipProps;
     // (undocumented)
@@ -331,15 +333,13 @@ export class IModelTransformer extends IModelExportHandler {
     processRelationships(baseRelClassFullName: string): Promise<void>;
     processSchemas(): Promise<void>;
     processSubject(sourceSubjectId: Id64String, targetSubjectId: Id64String): Promise<void>;
-    get provenanceDb(): IModelDb;
     static get provenanceElementAspectClasses(): (typeof Entity)[];
     static get provenanceElementClasses(): (typeof Entity)[];
-    get provenanceSourceDb(): IModelDb;
-    static queryScopeExternalSourceAspect(dbToQuery: IModelDb, aspectProps: ExternalSourceAspectProps): {
+    static queryScopeExternalSourceAspect(dbToQuery: IModelDb, aspectProps: ExternalSourceAspectProps): Promise<{
         aspectId: Id64String;
         version?: string;
         jsonProperties?: string;
-    } | undefined;
+    } | undefined>;
     protected _schemaExportDir: string;
     protected shouldDetectDeletes(): boolean;
     shouldExportCodeSpec(_sourceCodeSpec: CodeSpec): boolean;
@@ -349,18 +349,18 @@ export class IModelTransformer extends IModelExportHandler {
     shouldExportRelationship(_sourceRelationship: Relationship): boolean;
     shouldExportSchema(schemaKey: ECSchemaMetaData.SchemaKey): boolean;
     readonly sourceDb: IModelDb;
-    protected get synchronizationVersion(): ChangesetIndexAndId;
     readonly targetDb: IModelDb;
     get targetScopeElementId(): Id64String;
     // (undocumented)
-    protected tryGetProvenanceScopeAspect(): ExternalSourceAspect | undefined;
-    updateSynchronizationVersion({ initializeReverseSyncVersion, }?: {
+    protected tryGetProvenanceScopeAspect(): Promise<ExternalSourceAspect | undefined>;
+    updateSynchronizationVersion(input?: {
         initializeReverseSyncVersion?: boolean | undefined;
-    }): void;
+    }): Promise<void>;
 }
 
 // @beta
 export interface IModelTransformOptions {
+    acquireElementLocks?: boolean;
     argsForProcessChanges?: ProcessChangesOptions;
     branchRelationshipDataBehavior?: "unsafe-migrate" | "reject";
     cloneUsingBinaryGeometry?: boolean;
@@ -440,21 +440,23 @@ export interface TargetScopeProvenanceJsonProps {
 // @beta
 export class TemplateModelCloner extends IModelTransformer {
     constructor(sourceDb: IModelDb, targetDb?: IModelDb);
-    onTransformElement(sourceElement: Element_2): ElementProps;
+    onTransformElement(sourceElement: Element_2): Promise<ElementProps>;
     placeTemplate2d(sourceTemplateModelId: Id64String, targetModelId: Id64String, placement: Placement2d): Promise<Map<Id64String, Id64String>>;
     placeTemplate3d(sourceTemplateModelId: Id64String, targetModelId: Id64String, placement: Placement3d): Promise<Map<Id64String, Id64String>>;
 }
 
 // @public
 export enum TransformerLoggerCategory {
+    // (undocumented)
+    ECReferenceTypesCache = "imodel-transformer.ECReferenceTypesCache",
     // @beta
-    IModelCloneContext = "core-backend.IModelCloneContext",
+    IModelCloneContext = "imodel-transformer.IModelCloneContext",
     // @beta
-    IModelExporter = "core-backend.IModelExporter",
+    IModelExporter = "imodel-transformer.IModelExporter",
     // @beta
-    IModelImporter = "core-backend.IModelImporter",
+    IModelImporter = "imodel-transformer.IModelImporter",
     // @beta
-    IModelTransformer = "core-backend.IModelTransformer"
+    IModelTransformer = "imodel-transformer.IModelTransformer"
 }
 
 // (No @packageDocumentation comment for this package)