Merge branch 'master' into saeed-torabi/spiral-close-approach

Author: saeeedtorabi

.github/workflows/copilot-setup-steps.yml

@@ -0,0 +1,42 @@
+name: "Copilot Setup Steps"
+
+# Automatically run the setup steps when they are changed to allow for easy validation, and
+# allow manual testing through the repository's "Actions" tab
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+  pull_request:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+
+jobs:
+  # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
+  copilot-setup-steps:
+    runs-on: ubuntu-latest
+
+    # Set the permissions to the lowest permissions possible needed for your steps.
+    # Copilot will be given its own token for its operations.
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "24"
+
+      - name: Configure Git identity
+        run: |
+          git config --local user.name "imodeljs-admin"
+          git config --local user.email "imodeljs-admin@users.noreply.github.com"
+
+      - name: Install Rush
+        run: npm install -g @microsoft/rush@5.162.0
+
+      - name: Install dependencies
+        run: rush install

.gitignore

@@ -58,3 +58,4 @@ common/api/summary/summary.exports.csv
 
 *.log
 *.error.log
+**/tsconfig.tsbuildinfo

common/api/core-backend.api.md

@@ -2986,6 +2986,30 @@ export interface EditingScopeNotifications {
     notifyGeometryChanged: (modelProps: ModelGeometryChangesProps[]) => void;
 }
 
+// @beta
+export interface EditTxnError extends ITwinError {
+    readonly description?: string;
+    readonly iModelKey?: string;
+}
+
+// @beta (undocumented)
+export namespace EditTxnError {
+    const scope = "itwin-EditTxn";
+    export function isError(error: unknown, key?: Key): error is EditTxnError;
+    export type Key =
+    /** an attempt to start an EditTxn when one is already active */
+    "already-active" |
+    /** an attempt to modify an iModel through the implicit transaction when explicit transactions are enforced */
+    "implicit-txn-write-disallowed" |
+    /** an attempt to start an EditTxn when unsaved changes are already present */
+    "unsaved-changes" |
+    /** an attempt to perform an operation that requires an active EditTxn when none is active */
+    "not-active" |
+    /** an attempt to use an EditTxn with the wrong iModel */
+    "wrong-imodel";
+    export function throwError(key: Key, message: string, iModelKey?: string, description?: string): never;
+}
+
 // @public
 export type ElementAlignedBox2d = Range2d;
 
@@ -5563,6 +5587,7 @@ export const ipcAppChannels: {
 
 // @internal
 export interface IpcAppFunctions {
+    // @deprecated (undocumented)
     abandonChanges: (key: string) => Promise<void>;
     cancelElementGraphicsRequests: (key: string, _requestIds: string[]) => Promise<void>;
     cancelPullChangesRequest: (key: string) => Promise<void>;
@@ -5591,6 +5616,7 @@ export interface IpcAppFunctions {
     reverseAllTxn: (key: string) => Promise<IModelStatus>;
     // (undocumented)
     reverseTxns: (key: string, numOperations: number) => Promise<IModelStatus>;
+    // @deprecated (undocumented)
     saveChanges: (key: string, description?: string) => Promise<void>;
     // (undocumented)
     toggleGraphicalEditingScope: (key: string, _startSession: boolean) => Promise<boolean>;
@@ -9402,7 +9428,7 @@ export interface RunLayoutResult {
 // @beta
 export type RunProps = TextRunProps | FractionRunProps | TabRunProps | LineBreakRunProps | FieldRunProps;
 
-// @alpha
+// @beta
 export interface SaveChangesArgs {
     appData?: {
         [key: string]: any;

common/api/core-common.api.md

@@ -1728,6 +1728,7 @@ export interface BlankConnectionProps {
 // @public
 export class BriefcaseConnection extends IModelConnection {
     protected constructor(props: BriefcaseConnectionProps, openMode: OpenMode);
+    // @deprecated
     abandonChanges(): Promise<void>;
     // @beta
     readonly briefcaseId?: number;
@@ -1756,6 +1757,7 @@ export class BriefcaseConnection extends IModelConnection {
     pushChanges(description: string): Promise<ChangesetIndexAndId>;
     // (undocumented)
     protected requireTimeline(): void;
+    // @deprecated
     saveChanges(description?: string): Promise<void>;
     supportsGraphicalEditing(): Promise<boolean>;
     readonly txns: BriefcaseTxns;
@@ -2155,6 +2157,8 @@ export class ContextRealityModelState extends ContextRealityModel {
     // @internal
     constructor(props: ContextRealityModelProps, iModel: IModelConnection, displayStyle: DisplayStyleState);
     get classifiers(): SpatialClassifiersState;
+    // @internal (undocumented)
+    detachLayerListeners(): void;
     readonly iModel: IModelConnection;
     get isGlobal(): boolean;
     get modelId(): Id64String | undefined;
@@ -5652,6 +5656,8 @@ export class LayerTileTreeReferenceHandler {
     // (undocumented)
     clearLayers(): void;
     // (undocumented)
+    detachFromDisplayStyle(): void;
+    // (undocumented)
     discloseTileTrees(trees: DisclosedTileTreeSet): void;
     // (undocumented)
     initializeLayers(context: SceneContext): boolean;
@@ -7988,6 +7994,7 @@ export abstract class PrimitiveTool extends InteractiveTool {
     redoPreviousStep(): Promise<boolean>;
     requireWriteableTarget(): boolean;
     run(..._args: any[]): Promise<boolean>;
+    // @deprecated
     saveChanges(): Promise<void>;
     // (undocumented)
     targetIsLocked: boolean;

common/api/core-frontend.api.md

@@ -8,6 +8,7 @@ import { BasicManipulationCommandIpc } from '@itwin/editor-common';
 import { CompressedId64Set } from '@itwin/core-bentley';
 import { EcefLocationProps } from '@itwin/core-common';
 import { EditCommandIpc } from '@itwin/editor-common';
+import { EditTxn } from '@itwin/core-backend';
 import { ElementGeometryBuilderParams } from '@itwin/core-common';
 import { ElementGeometryInfo } from '@itwin/core-common';
 import { FlatBufferGeometryFilter } from '@itwin/editor-common';
@@ -18,6 +19,7 @@ import { IModelDb } from '@itwin/core-backend';
 import { IModelStatus } from '@itwin/core-bentley';
 import { Matrix3dProps } from '@itwin/core-geometry';
 import { Range3dProps } from '@itwin/core-geometry';
+import { SaveChangesArgs } from '@itwin/core-common';
 import { TransformProps } from '@itwin/core-geometry';
 
 // @beta
@@ -56,10 +58,16 @@ export class BasicManipulationCommand extends EditCommand implements BasicManipu
 // @beta
 export class EditCommand implements EditCommandIpc {
     constructor(iModel: IModelDb, ..._args: any[]);
+    abandonChanges(): Promise<void>;
+    abandonEdits(): Promise<void>;
+    protected appData?: SaveChangesArgs["appData"];
+    protected beginEditing(): void;
     static commandId: string;
     // (undocumented)
     get ctor(): EditCommandType;
+    endEdits(description?: string): Promise<void>;
     readonly iModel: IModelDb;
+    get isTxnActive(): boolean;
     // (undocumented)
     onStart(): Promise<any>;
     // (undocumented)
@@ -69,6 +77,8 @@ export class EditCommand implements EditCommandIpc {
         [propName: string]: any;
     }>;
     requestFinish(): Promise<"done" | string>;
+    saveChanges(description?: string): Promise<void>;
+    protected readonly txn: EditTxn;
     // (undocumented)
     static version: string;
 }

common/api/editor-backend.api.md

@@ -39,11 +39,13 @@ export interface BasicManipulationCommandIpc extends EditCommandIpc {
 
 // @beta
 export interface EditCommandIpc {
+    abandonChanges: () => Promise<void>;
     ping: () => Promise<{
         commandId: string;
         version: string;
         [propName: string]: any;
     }>;
+    saveChanges: (description?: string) => Promise<void>;
 }
 
 // @beta

common/api/editor-common.api.md

@@ -5,6 +5,7 @@
 ```ts
 
 import { DistanceExpressionProps } from '@itwin/linear-referencing-common';
+import { EditTxn } from '@itwin/core-backend';
 import { ElementMultiAspect } from '@itwin/core-backend';
 import { ElementProps } from '@itwin/core-common';
 import { ElementRefersToElements } from '@itwin/core-backend';
@@ -85,13 +86,17 @@ export class LinearLocation extends LinearLocationElement implements LinearlyLoc
     static get className(): string;
     // (undocumented)
     static create(iModel: IModelDb, modelId: Id64String, categoryId: Id64String): LinearLocation;
-    // (undocumented)
+    static insertAt(txn: EditTxn, modelId: Id64String, categoryId: Id64String, linearElementId: Id64String, atPosition: LinearlyReferencedAtLocationProps, locatedElementId: Id64String): Id64String;
+    // @deprecated
     static insertAt(iModel: IModelDb, modelId: Id64String, categoryId: Id64String, linearElementId: Id64String, atPosition: LinearlyReferencedAtLocationProps, locatedElementId: Id64String): Id64String;
-    // (undocumented)
+    insertAt(txn: EditTxn, linearElementId: Id64String, atPosition: LinearlyReferencedAtLocationProps, locatedElementId: Id64String): Id64String;
+    // @deprecated
     insertAt(iModel: IModelDb, linearElementId: Id64String, atPosition: LinearlyReferencedAtLocationProps, locatedElementId: Id64String): Id64String;
-    // (undocumented)
+    static insertFromTo(txn: EditTxn, modelId: Id64String, categoryId: Id64String, linearElementId: Id64String, fromToPosition: LinearlyReferencedFromToLocationProps, locatedElementId: Id64String): Id64String;
+    // @deprecated
     static insertFromTo(iModel: IModelDb, modelId: Id64String, categoryId: Id64String, linearElementId: Id64String, fromToPosition: LinearlyReferencedFromToLocationProps, locatedElementId: Id64String): Id64String;
-    // (undocumented)
+    insertFromTo(txn: EditTxn, linearElementId: Id64String, fromToPosition: LinearlyReferencedFromToLocationProps, locatedElementId: Id64String): Id64String;
+    // @deprecated
     insertFromTo(iModel: IModelDb, linearElementId: Id64String, fromToPosition: LinearlyReferencedFromToLocationProps, locatedElementId: Id64String): Id64String;
 }
 
@@ -111,10 +116,20 @@ export class LinearlyLocated {
     static getFromToLocation(iModel: IModelDb, linearlyLocatedElementId: Id64String): LinearlyReferencedFromToLocation | undefined;
     static getFromToLocations(iModel: IModelDb, linearlyLocatedElementId: Id64String): LinearlyReferencedFromToLocation[];
     static getLinearElementId(iModel: IModelDb, linearlyLocatedElementId: Id64String): Id64String | undefined;
+    static insertAt(txn: EditTxn, elProps: ElementProps, linearElementId: Id64String, atPosition: LinearlyReferencedAtLocationProps): Id64String;
+    // @deprecated
     static insertAt(iModel: IModelDb, elProps: ElementProps, linearElementId: Id64String, atPosition: LinearlyReferencedAtLocationProps): Id64String;
+    static insertFromTo(txn: EditTxn, elProps: ElementProps, linearElementId: Id64String, fromToPosition: LinearlyReferencedFromToLocationProps): Id64String;
+    // @deprecated
     static insertFromTo(iModel: IModelDb, elProps: ElementProps, linearElementId: Id64String, fromToPosition: LinearlyReferencedFromToLocationProps): Id64String;
+    // @deprecated
     static updateAtLocation(iModel: IModelDb, linearlyLocatedElementId: Id64String, linearLocationProps: LinearlyReferencedAtLocationProps, aspectId?: Id64String): void;
+    // (undocumented)
+    static updateAtLocation(txn: EditTxn, linearlyLocatedElementId: Id64String, linearLocationProps: LinearlyReferencedAtLocationProps, aspectId?: Id64String): void;
+    // @deprecated
     static updateFromToLocation(iModel: IModelDb, linearlyLocatedElementId: Id64String, linearLocationProps: LinearlyReferencedFromToLocationProps, aspectId?: Id64String): void;
+    // (undocumented)
+    static updateFromToLocation(txn: EditTxn, linearlyLocatedElementId: Id64String, linearLocationProps: LinearlyReferencedFromToLocationProps, aspectId?: Id64String): void;
 }
 
 // @beta
@@ -177,7 +192,8 @@ export class LinearlyReferencedAtLocation extends LinearlyReferencedLocation {
     static create(iModel: IModelDb, locatedElementId: Id64String, at: DistanceExpression, fromReferentId?: Id64String): LinearlyReferencedAtLocation;
     // (undocumented)
     fromReferent?: LinearlyReferencedAtPositionRefersToReferent;
-    // (undocumented)
+    static insert(txn: EditTxn, locatedElementId: Id64String, at: DistanceExpression, fromReferentId?: Id64String): void;
+    // @deprecated
     static insert(iModel: IModelDb, locatedElementId: Id64String, at: DistanceExpression, fromReferentId?: Id64String): void;
 }
 
@@ -206,7 +222,8 @@ export class LinearlyReferencedFromToLocation extends LinearlyReferencedLocation
     fromPosition: DistanceExpression;
     // (undocumented)
     fromPositionFromReferent?: LinearlyReferencedFromPositionRefersToReferent;
-    // (undocumented)
+    static insert(txn: EditTxn, locatedElementId: Id64String, from: DistanceExpression, to: DistanceExpression, fromReferentId?: Id64String, toReferentId?: Id64String): void;
+    // @deprecated
     static insert(iModel: IModelDb, locatedElementId: Id64String, from: DistanceExpression, to: DistanceExpression, fromReferentId?: Id64String, toReferentId?: Id64String): void;
     // (undocumented)
     toPosition: DistanceExpression;
@@ -250,9 +267,11 @@ export class Referent extends ReferentElement {
     static get className(): string;
     // (undocumented)
     static create(iModel: IModelDb, modelId: Id64String, categoryId: Id64String, referencedElementId: Id64String): Referent;
-    // (undocumented)
+    static insertAt(txn: EditTxn, modelId: Id64String, categoryId: Id64String, linearElementId: Id64String, atPosition: LinearlyReferencedAtLocationProps, referencedElementId: Id64String): Id64String;
+    // @deprecated
     static insertAt(iModel: IModelDb, modelId: Id64String, categoryId: Id64String, linearElementId: Id64String, atPosition: LinearlyReferencedAtLocationProps, referencedElementId: Id64String): Id64String;
-    // (undocumented)
+    insertAt(txn: EditTxn, linearElementId: Id64String, atPosition: LinearlyReferencedAtLocationProps): Id64String;
+    // @deprecated
     insertAt(iModel: IModelDb, linearElementId: Id64String, atPosition: LinearlyReferencedAtLocationProps): Id64String;
 }
 

common/api/linear-referencing-backend.api.md

@@ -119,8 +119,14 @@ preview;class;DefinitionPartition
 public;class;DefinitionSet
 preview;class;DefinitionSet
 beta;function;deleteElementSubTrees
+beta;function;deleteElementSubTrees
+deprecated;function;deleteElementSubTrees
+beta;function;deleteElementTree
+beta;function;deleteElementTree
+deprecated;function;deleteElementTree
 beta;function;deleteElementTree
 beta;function;deleteElementTree
+deprecated;function;deleteElementTree
 beta;interface;DeleteElementTreeArgs
 beta;interface;DeserializeEntityArgs
 public;class;DetailCallout
@@ -188,6 +194,7 @@ public;class;ECSqlWriteStatement
 beta;interface;EditableCatalogDb
 beta;interface;EditableWorkspaceContainer
 beta;interface;EditableWorkspaceDb
+beta;class;EditTxn
 public;class;ElementAspect
 preview;class;ElementAspect
 beta;class;ElementDrivesElement
@@ -344,6 +351,7 @@ public;class;IModelJsFs
 public;class;IModelJsFsStats
 public;interface;IModelNameArg
 internal;class;IModelNative
+beta;type;ImplicitWriteEnforcement
 public;class;InformationContentElement
 preview;class;InformationContentElement
 public;class;InformationModel
@@ -415,7 +423,9 @@ beta;interface;OnAspectPropsArg
 beta;interface;OnChildElementArg
 beta;interface;OnChildElementIdArg
 beta;interface;OnChildElementPropsArg
+beta;interface;OnDependencyArg
 beta;interface;OnElementArg
+beta;interface;OnElementDependencyArg
 beta;interface;OnElementIdArg
 beta;interface;OnElementInModelIdArg
 beta;interface;OnElementInModelPropsArg
@@ -658,6 +668,10 @@ public;class;VolumeElement
 preview;class;VolumeElement
 public;class;WebMercatorModel
 preview;class;WebMercatorModel
+beta;function;withEditTxn
+beta;function;withEditTxn
+beta;function;withEditTxn
+beta;function;withEditTxn
 beta;interface;Workspace
 beta;namespace;Workspace
 beta;interface;WorkspaceContainer

common/api/summary/core-backend.exports.csv

@@ -255,6 +255,8 @@ internal;interface;EdgeAppearanceOverrides
 internal;class;EdgeArgs
 internal;interface;EdgeOptions
 internal;interface;EditingScopeNotifications
+beta;interface;EditTxnError
+beta;namespace;EditTxnError
 public;type;ElementAlignedBox2d
 public;type;ElementAlignedBox3d
 public;interface;ElementAspectProps
@@ -849,7 +851,7 @@ beta;type;Run
 beta;namespace;Run
 beta;interface;RunLayoutResult
 beta;type;RunProps
-alpha;interface;SaveChangesArgs
+beta;interface;SaveChangesArgs
 public;enum;SchemaState
 public;interface;SectionDrawingLocationProps
 preview;interface;SectionDrawingLocationProps