@itwin/core-backend 5.11.0-dev.3 → 5.11.0-dev.5

package/lib/esm/Entity.d.ts

@@ -119,7 +119,7 @@ export declare class Entity {
      * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
      * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
      * @throws Error if metadata for the class cannot be retrieved.
-     * @deprecated in 5.10.0. Obtain a `SchemaView` via `iModel.getSchemaView()` and iterate `view.findClass(entity.classFullName)?.getProperties()` yourself. SchemaView does not expose the `BisCore.CustomHandledProperty` custom attribute, so the `includeCustom: false` filter must be replicated by the caller (query the custom-handled property set via ECSql) if needed.
+     * @deprecated in 5.10.0 - will not be removed until after 2026-09-03. Obtain a `SchemaView` via `iModel.getSchemaView()` and iterate `view.findClass(entity.classFullName)?.getProperties()` yourself. SchemaView does not expose the `BisCore.CustomHandledProperty` custom attribute, so the `includeCustom: false` filter must be replicated by the caller (query the custom-handled property set via ECSql) if needed.
      *
      * @example
      * ```typescript
@@ -146,11 +146,11 @@ export declare class Entity {
      * @throws [[IModelError]] if there is a problem querying the schema
      * @returns The metadata for the current entity
      * @public @preview
-     * @deprecated in 5.10.0. Obtain a `SchemaView` via `iModel.getSchemaView()` and call `view.findClass(entity.classFullName)` to retrieve a `SchemaView.Class`. The returned type differs from `EntityClass | RelationshipClass` and offers a synchronous, snapshot-style API.
+     * @deprecated in 5.10.0 - will not be removed until after 2026-09-03. Obtain a `SchemaView` via `iModel.getSchemaView()` and call `view.findClass(entity.classFullName)` to retrieve a `SchemaView.Class`. The returned type differs from `EntityClass | RelationshipClass` and offers a synchronous, snapshot-style API.
      */
     getMetaData(): Promise<EntityClass | RelationshipClass>;
     /** @internal
-     * @deprecated in 5.10.0. Internal callers should obtain a `SchemaView` via `iModel.getSchemaView()` (or retain a pre-loaded one) and call `view.findClass(...)` instead. Note that `getSchemaView()` is async.
+     * @deprecated in 5.10.0 - will not be removed until after 2026-09-03. Internal callers should obtain a `SchemaView` via `iModel.getSchemaView()` (or retain a pre-loaded one) and call `view.findClass(...)` instead. Note that `getSchemaView()` is async.
      */
     getMetaDataSync(): EntityClass | RelationshipClass;
     /** @internal */

package/lib/esm/Entity.js

@@ -162,7 +162,7 @@ export class Entity {
      * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
      * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
      * @throws Error if metadata for the class cannot be retrieved.
-     * @deprecated in 5.10.0. Obtain a `SchemaView` via `iModel.getSchemaView()` and iterate `view.findClass(entity.classFullName)?.getProperties()` yourself. SchemaView does not expose the `BisCore.CustomHandledProperty` custom attribute, so the `includeCustom: false` filter must be replicated by the caller (query the custom-handled property set via ECSql) if needed.
+     * @deprecated in 5.10.0 - will not be removed until after 2026-09-03. Obtain a `SchemaView` via `iModel.getSchemaView()` and iterate `view.findClass(entity.classFullName)?.getProperties()` yourself. SchemaView does not expose the `BisCore.CustomHandledProperty` custom attribute, so the `includeCustom: false` filter must be replicated by the caller (query the custom-handled property set via ECSql) if needed.
      *
      * @example
      * ```typescript
@@ -200,7 +200,7 @@ export class Entity {
      * @throws [[IModelError]] if there is a problem querying the schema
      * @returns The metadata for the current entity
      * @public @preview
-     * @deprecated in 5.10.0. Obtain a `SchemaView` via `iModel.getSchemaView()` and call `view.findClass(entity.classFullName)` to retrieve a `SchemaView.Class`. The returned type differs from `EntityClass | RelationshipClass` and offers a synchronous, snapshot-style API.
+     * @deprecated in 5.10.0 - will not be removed until after 2026-09-03. Obtain a `SchemaView` via `iModel.getSchemaView()` and call `view.findClass(entity.classFullName)` to retrieve a `SchemaView.Class`. The returned type differs from `EntityClass | RelationshipClass` and offers a synchronous, snapshot-style API.
      */
     async getMetaData() {
         if (this._metadata) {
@@ -216,7 +216,7 @@ export class Entity {
         }
     }
     /** @internal
-     * @deprecated in 5.10.0. Internal callers should obtain a `SchemaView` via `iModel.getSchemaView()` (or retain a pre-loaded one) and call `view.findClass(...)` instead. Note that `getSchemaView()` is async.
+     * @deprecated in 5.10.0 - will not be removed until after 2026-09-03. Internal callers should obtain a `SchemaView` via `iModel.getSchemaView()` (or retain a pre-loaded one) and call `view.findClass(...)` instead. Note that `getSchemaView()` is async.
      */
     getMetaDataSync() {
         if (this._metadata) {

package/lib/esm/Entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"Entity.js","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAmC,kBAAkB,EAAsC,MAAM,oBAAoB,CAAC;AAG7H,OAAO,EAAE,OAAO,EAAE,WAAW,EAAY,iBAAiB,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAC5G,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAgC/C;;;;GAIG;AACH,MAAM,OAAO,MAAM;IACjB;;OAEG;IACa,kBAAkB,GAAG,IAAa,CAAC;IACnD,0CAA0C;IACnC,MAAM,CAAC,MAAM,CAAgB,CAAC,mGAAmG;IAExI,IAAY,KAAK,KAAoB,OAAO,IAAI,CAAC,WAA4B,CAAC,CAAC,CAAC;IAEhF;;;;OAIG;IACI,MAAM,KAAK,SAAS,KAAa,OAAO,QAAQ,CAAC,CAAC,CAAC;IAE1D;;OAEG;IACI,MAAM,KAAK,aAAa;QAC7B,gFAAgF;QAChF,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAClE,CAAC;IAED,sCAAsC;IAC5B,SAAS,CAAmC;IAEtD;;;OAGG;IACH,IAAW,KAAK,KAAU,OAAO,IAAI,CAAC,CAAC,CAAC;IAExC,yDAAyD;IACzD,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAExE,4DAA4D;IAC5D,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IAE/D,iDAAiD;IAC1C,MAAM,CAAW;IAExB,kGAAkG;IAC3F,EAAE,CAAa;IAGtB,YAAsB,KAAkB,EAAE,MAAgB;QACxD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,8EAA8E;QAC9E,4DAA4D;QAC5D,IAAI,CAAC,eAAe,CAAC,CAAC,QAAgB,EAAE,IAAsB,EAAE,EAAE,CAAE,IAAY,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,cAAc,CAAE,KAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACrJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,WAAW,CAAC,QAAuB,EAAE,KAAkB,EAAE,MAAgB;QACrF,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;eAEW;IACD,MAAM,CAAU,mBAAmB,GAA4B;QACvE,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;QACvC,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE;QAC9C,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,EAAE;KACpD,CAAC;IAEF;mBACe;IACP,MAAM,CAAC,0BAA0B;QACvC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,mBAAmB,CAAC;QAClC,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAkB,CAAC;QAChE,OAAO;YACL,GAAG,UAAU,CAAC,0BAA0B,EAAE;YAC1C,GAAG,IAAI,CAAC,mBAAmB;SAC5B,CAAC;IACJ,CAAC;IAED;eACW;IACJ,MAAM,CAAC,WAAW,CAAC,KAA4B;QACpD,MAAM,OAAO,GAAgB;YAC3B,aAAa,EAAE,KAAK,CAAC,GAAG,CAAC,aAAa;YACtC,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE;SACjB,CAAA;QAED,gIAAgI;QAChI,IAAI,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;YAC7B,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;QAC7G,CAAC;QACD,iFAAiF;QACjF,MAAM,uBAAuB,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAClE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;aACnB,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,KAAK,YAAY,CAAC,KAAK,SAAS,CAAC;aAChH,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,CAAE,OAAoB,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CACvF,CAAC;QACJ,yDAAyD;QACzD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YAC5C,IAAK,OAAoB,CAAC,YAAY,CAAC,CAAC,YAAY,KAAK,SAAS,IAAI,YAAY,KAAK,gBAAgB,IAAI,YAAY,KAAK,aAAa,EAAE,CAAC;gBACzI,OAAoB,CAAC,YAAY,CAAC,CAAC,YAAY,GAAI,OAAoB,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YACxH,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;eACW;IACJ,MAAM,CAAC,SAAS,CAAC,KAAkB,EAAE,OAAiB;QAC3D,MAAM,IAAI,GAAa;YACrB,aAAa,EAAE,KAAK,CAAC,aAAa;YAClC,EAAE,EAAE,KAAK,CAAC,EAAE;SACb,CAAA;QAED,MAAM,uBAAuB,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAClE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;aACf,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,KAAK,YAAY,CAAC,KAAK,SAAS,CAAC;aAChH,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,GAAI,KAAkB,CAAC,YAAY,CAAC,CAChF,CAAC;QACJ,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACvC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QACnB,4DAA4D;QAC5D,IAAI,CAAC,eAAe,CAAC,CAAC,QAAgB,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAI,IAAY,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;QAC3F,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,4DAA4D;IACrD,eAAe,CAAC,IAAsB,EAAE,gBAAyB,IAAI;QAC1E,4DAA4D;QAC5D,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,OAAO,CAAC,IAAqB,EAAE,gBAAyB,IAAI;QACjE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE/F,IAAI,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;YACnF,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;gBAChD,IAAI,aAAa,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC,+BAA+B,CAAC;oBACnF,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAClC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,qDAAqD,CAAC,CAAC;QACtH,CAAC;IACH,CAAC;IAED,4EAA4E;IACrE,MAAM,KAAK,aAAa,KAAa,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAEnG,6EAA6E;IAC7E,IAAW,aAAa,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IACvE;;;OAGG;IACH,IAAW,aAAa,KAAoB,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IAE9E;;;;;OAKG;IACI,KAAK,CAAC,WAAW;QACtB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC3F,IAAI,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;YACzF,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;YACzB,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED;;OAEG;IACI,eAAe;QACpB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QACzF,IAAI,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;YACzF,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;YACzB,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,MAAM,KAAK,mBAAmB,KAAe,OAAO,EAAE,CAAC,CAAC,CAAC;IAEhE;;;;;OAKG;IACI,MAAM,CAAC,EAAE,CAAC,UAAyB;QACxC,6EAA6E;QAC7E,OAAO,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,SAAS,YAAY,UAAU,CAAC;IACrE,CAAC;IAED;;;OAGG;IACI,MAAM,KAAK,gBAAgB,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IAEtD;;;;;OAKG;IACI,eAAe;QACpB,MAAM,YAAY,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAC9C,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACvC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;OAOG;IACO,mBAAmB,CAAC,aAAiC;QAC7D,OAAO,CAAC,2BAA2B;IACrC,CAAC","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 Schema\r\n */\r\n\r\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { ElementLoadOptions, EntityProps, EntityReferenceSet, PropertyCallback, PropertyMetaData } from \"@itwin/core-common\";\r\nimport type { IModelDb } from \"./IModelDb\";\r\nimport { Schema } from \"./Schema\";\r\nimport { ECClass, EntityClass, Property, RelationshipClass, SchemaItemKey } from \"@itwin/ecschema-metadata\";\r\nimport { _nativeDb } from \"./internal/Symbols\";\r\n\r\n/** Represents a row returned by an ECSql query. The row is returned as a map of property names to values.\r\n * ECSqlRow has same schema as declared in ECSchema for the class and similar to if ECSQL SELECT * FROM <schema>:<class> were executed.\r\n * @beta */\r\nexport interface ECSqlRow {\r\n  [key: string]: any\r\n}\r\n\r\n/** Set of properties that are used to deserialize an [[EntityProps]] from an ECSqlRow.\r\n * @beta */\r\nexport interface DeserializeEntityArgs {\r\n  /** Row to deserialize */\r\n  row: ECSqlRow;\r\n  /** The IModel that contains this Entity */\r\n  iModel: IModelDb;\r\n  /** The options used when loading */\r\n  options?: {\r\n    /** Options used when loading an element */\r\n    element?: ElementLoadOptions;\r\n  }\r\n}\r\n\r\n/** A property of an [[Entity]] that needs to be custom handled during deserialization and serialization.\r\n * @beta */\r\nexport interface CustomHandledProperty {\r\n  /** The name of the property as it appears in the ECSqlRow */\r\n  readonly propertyName: string;\r\n  /** Where the property is defined */\r\n  readonly source: \"Class\" | \"Computed\";\r\n}\r\n\r\n/** Represents one of the fundamental building block in an [[IModelDb]]: as an [[Element]], [[Model]], or [[Relationship]].\r\n * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).\r\n * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].\r\n * @public @preview\r\n */\r\nexport class Entity {\r\n  /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types\r\n   * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].\r\n   */\r\n  public readonly isInstanceOfEntity = true as const;\r\n  /** The Schema that defines this class. */\r\n  public static schema: typeof Schema; // TODO: Schema key on the static level, but it requires a version which may differ between imodels\r\n\r\n  private get _ctor(): typeof Entity { return this.constructor as typeof Entity; }\r\n\r\n  /** The name of the BIS class associated with this class.\r\n   * @note Every subclass of Entity **MUST** override this method to identify its BIS class.\r\n   * Failure to do so will ordinarily result in an error when the class is registered, since there may only\r\n   * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)\r\n   */\r\n  public static get className(): string { return \"Entity\"; }\r\n\r\n  /** Serves as a unique identifier for this class. Typed variant of [[classFullName]].\r\n   * @public @preview\r\n   */\r\n  public static get schemaItemKey(): SchemaItemKey {\r\n    // We cannot cache this here because the className gets overridden in subclasses\r\n    return new SchemaItemKey(this.className, this.schema.schemaKey);\r\n  }\r\n\r\n  /** Cached Metadata for the ECClass */\r\n  protected _metadata?: EntityClass | RelationshipClass;\r\n\r\n  /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.\r\n   * This property makes such code slightly less tedious to read and write.\r\n   * @internal\r\n   */\r\n  public get asAny(): any { return this; }\r\n\r\n  /** The name of the BIS Schema that defines this class */\r\n  public get schemaName(): string { return this._ctor.schema.schemaName; }\r\n\r\n  /** The name of the BIS class associated with this class. */\r\n  public get className(): string { return this._ctor.className; }\r\n\r\n  /** The [[IModelDb]] that contains this Entity */\r\n  public iModel: IModelDb;\r\n\r\n  /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */\r\n  public id: Id64String;\r\n\r\n\r\n  protected constructor(props: EntityProps, iModel: IModelDb) {\r\n    this.iModel = iModel;\r\n    this.id = Id64.fromJSON(props.id);\r\n    // copy all auto-handled properties from input to the object being constructed\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.forEachProperty((propName: string, meta: PropertyMetaData) => (this as any)[propName] = meta.createProperty((props as any)[propName]), false);\r\n  }\r\n\r\n  /** Invoke the constructor of the specified `Entity` subclass.\r\n   * @internal\r\n   */\r\n  public static instantiate(subclass: typeof Entity, props: EntityProps, iModel: IModelDb): Entity {\r\n    return new subclass(props, iModel);\r\n  }\r\n\r\n  /** List of properties that are need to be custom handled during deserialization and serialization.\r\n   * These properties differ between the ECSql instance of an Entity and the Entity itself.\r\n   * @beta */\r\n  protected static readonly _customHandledProps: CustomHandledProperty[] = [\r\n    { propertyName: \"id\", source: \"Class\" },\r\n    { propertyName: \"className\", source: \"Class\" },\r\n    { propertyName: \"jsonProperties\", source: \"Class\" }\r\n  ];\r\n\r\n  /** Get the list of properties that are custom handled by this class and its superclasses.\r\n   * @internal */\r\n  private static getCustomHandledProperties(): readonly CustomHandledProperty[] {\r\n    if (this.name === \"Entity\") {\r\n      return this._customHandledProps;\r\n    }\r\n\r\n    const superClass = Object.getPrototypeOf(this) as typeof Entity;\r\n    return [\r\n      ...superClass.getCustomHandledProperties(),\r\n      ...this._customHandledProps,\r\n    ];\r\n  }\r\n\r\n  /** Converts an ECSqlRow of an Entity to an EntityProps. This is used to deserialize an Entity from the database.\r\n   * @beta */\r\n  public static deserialize(props: DeserializeEntityArgs): EntityProps {\r\n    const enProps: EntityProps = {\r\n      classFullName: props.row.classFullName,\r\n      id: props.row.id,\r\n    }\r\n\r\n    // Handles cases where id64 ints are stored in the jsonProperties and converts them to hex before parsing as a json object in js\r\n    if (props.row.jsonProperties) {\r\n      enProps.jsonProperties = JSON.parse(props.iModel[_nativeDb].patchJsonProperties(props.row.jsonProperties));\r\n    }\r\n    // Auto handles all properties that are not in the 'customHandledProperties' list\r\n    const customHandledProperties = this.getCustomHandledProperties();\r\n    Object.keys(props.row)\r\n      .filter((propertyName) => customHandledProperties.find((val) => val.propertyName === propertyName) === undefined)\r\n      .forEach((propertyName) => (enProps as ECSqlRow)[propertyName] = props.row[propertyName]\r\n      );\r\n    // Handles custom relClassNames to use '.' instead of ':'\r\n    Object.keys(enProps).forEach((propertyName) => {\r\n      if ((enProps as ECSqlRow)[propertyName].relClassName !== undefined && propertyName !== \"modeledElement\" && propertyName !== \"parentModel\") {\r\n        (enProps as ECSqlRow)[propertyName].relClassName = (enProps as ECSqlRow)[propertyName].relClassName.replace(':', '.');\r\n      }\r\n    });\r\n    return enProps;\r\n  }\r\n\r\n  /** Converts an EntityProps to an ECSqlRow. This is used to serialize an Entity to prepare to write it to the database.\r\n   * @beta */\r\n  public static serialize(props: EntityProps, _iModel: IModelDb): ECSqlRow {\r\n    const inst: ECSqlRow = {\r\n      classFullName: props.classFullName,\r\n      id: props.id,\r\n    }\r\n\r\n    const customHandledProperties = this.getCustomHandledProperties();\r\n    Object.keys(props)\r\n      .filter((propertyName) => customHandledProperties.find((val) => val.propertyName === propertyName) === undefined)\r\n      .forEach((propertyName) => inst[propertyName] = (props as ECSqlRow)[propertyName]\r\n      );\r\n    return inst;\r\n  }\r\n\r\n  /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -\r\n   * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).\r\n   */\r\n  public toJSON(): EntityProps {\r\n    const val: any = {};\r\n    val.classFullName = this.classFullName;\r\n    if (Id64.isValid(this.id))\r\n      val.id = this.id;\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.forEachProperty((propName: string) => val[propName] = (this as any)[propName], false);\r\n    return val;\r\n  }\r\n\r\n  /** Call a function for each property of this Entity.\r\n   * @param func The callback to be invoked on each property\r\n   * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\r\n   * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\r\n   * @deprecated in 5.0 - will not be removed until after 2026-06-13. Obtain a `SchemaView` via `iModel.getSchemaView()` and iterate `view.findClass(entity.classFullName)?.getProperties()` instead. (`forEach` is also deprecated.)\r\n   *\r\n   * @example\r\n   * ```typescript\r\n   * // Deprecated method\r\n   * entity.forEachProperty((name, propMetaData) => {\r\n   *   console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);\r\n   * });\r\n   *\r\n   * // New method\r\n   * entity.forEach((name, property) => {\r\n   *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);\r\n   * });\r\n   * ```\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  public forEachProperty(func: PropertyCallback, includeCustom: boolean = true) {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.iModel.forEachMetaData(this.classFullName, true, func, includeCustom);\r\n  }\r\n\r\n  /**\r\n   * Call a function for each property of this Entity.\r\n   * @param func The callback to be invoked on each property.\r\n   * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\r\n   * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\r\n   * @throws Error if metadata for the class cannot be retrieved.\r\n   * @deprecated in 5.10.0. Obtain a `SchemaView` via `iModel.getSchemaView()` and iterate `view.findClass(entity.classFullName)?.getProperties()` yourself. SchemaView does not expose the `BisCore.CustomHandledProperty` custom attribute, so the `includeCustom: false` filter must be replicated by the caller (query the custom-handled property set via ECSql) if needed.\r\n   *\r\n   * @example\r\n   * ```typescript\r\n   * const view = await entity.iModel.getSchemaView();\r\n   * const cls = view.findClass(entity.classFullName);\r\n   * if (cls) {\r\n   *   for (const property of cls.getProperties()) {\r\n   *     console.log(`Property name: ${property.name}, Kind: ${property.kind}`);\r\n   *   }\r\n   * }\r\n   * ```\r\n   */\r\n  public forEach(func: PropertyHandler, includeCustom: boolean = true) {\r\n    const item = this._metadata ?? this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey);\r\n\r\n    if (EntityClass.isEntityClass(item) || RelationshipClass.isRelationshipClass(item)) {\r\n      for (const property of item.getPropertiesSync()) {\r\n        if (includeCustom || !property.customAttributes?.has(`BisCore.CustomHandledProperty`))\r\n          func(property.name, property);\r\n      }\r\n    } else {\r\n      throw new Error(`Cannot get metadata for ${this.classFullName}. Class is not an EntityClass or RelationshipClass.`);\r\n    }\r\n  }\r\n\r\n  /** Get the full BIS class name of this Entity in the form \"schema:class\" */\r\n  public static get classFullName(): string { return `${this.schema.schemaName}:${this.className}`; }\r\n\r\n  /** Get the full BIS class name of this Entity in the form \"schema:class\". */\r\n  public get classFullName(): string { return this._ctor.classFullName; }\r\n  /**\r\n   * Get the item key used by the ecschema-metadata package to identify this entity class\r\n   * @public @preview\r\n   */\r\n  public get schemaItemKey(): SchemaItemKey { return this._ctor.schemaItemKey; }\r\n\r\n  /** Query metadata for this entity class from the iModel's schema. Returns cached metadata if available.\r\n   * @throws [[IModelError]] if there is a problem querying the schema\r\n   * @returns The metadata for the current entity\r\n   * @public @preview\r\n   * @deprecated in 5.10.0. Obtain a `SchemaView` via `iModel.getSchemaView()` and call `view.findClass(entity.classFullName)` to retrieve a `SchemaView.Class`. The returned type differs from `EntityClass | RelationshipClass` and offers a synchronous, snapshot-style API.\r\n   */\r\n  public async getMetaData(): Promise<EntityClass | RelationshipClass> {\r\n    if (this._metadata) {\r\n      return this._metadata;\r\n    }\r\n\r\n    const ecClass = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, ECClass);\r\n    if (EntityClass.isEntityClass(ecClass) || RelationshipClass.isRelationshipClass(ecClass)) {\r\n      this._metadata = ecClass;\r\n      return this._metadata;\r\n    } else {\r\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\r\n    }\r\n  }\r\n\r\n  /** @internal\r\n   * @deprecated in 5.10.0. Internal callers should obtain a `SchemaView` via `iModel.getSchemaView()` (or retain a pre-loaded one) and call `view.findClass(...)` instead. Note that `getSchemaView()` is async.\r\n   */\r\n  public getMetaDataSync(): EntityClass | RelationshipClass {\r\n    if (this._metadata) {\r\n      return this._metadata;\r\n    }\r\n\r\n    const ecClass = this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey, ECClass);\r\n    if (EntityClass.isEntityClass(ecClass) || RelationshipClass.isRelationshipClass(ecClass)) {\r\n      this._metadata = ecClass;\r\n      return this._metadata;\r\n    } else {\r\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\r\n    }\r\n  }\r\n  \r\n  /** @internal */\r\n  public static get protectedOperations(): string[] { return []; }\r\n\r\n  /** return whether this Entity class is a subclass of another Entity class\r\n   * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's\r\n   * inheritance, you can use [ECClass.is]($ecschema-metadata)\r\n   * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of\r\n   * typescript's restriction on the `this` type in static methods\r\n   */\r\n  public static is(otherClass: typeof Entity): boolean {\r\n    // inline of @itwin/core-bentley's isSubclassOf due to protected constructor.\r\n    return this === otherClass || this.prototype instanceof otherClass;\r\n  }\r\n\r\n  /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation\r\n   * ClassRegistry overrides this when generating a class\r\n   * @internal\r\n   */\r\n  public static get isGeneratedClass() { return false; }\r\n\r\n  /** Get the set of this entity's *entity references*, [EntityReferenceSet]($backend). An *entity reference* is any id\r\n   * stored on the entity, in its EC properties or json fields.\r\n   * This is important for cloning operations but can be useful in other situations as well.\r\n   * @see this.collectReferenceIds\r\n   * @beta\r\n   */\r\n  public getReferenceIds(): EntityReferenceSet {\r\n    const referenceIds = new EntityReferenceSet();\r\n    this.collectReferenceIds(referenceIds);\r\n    return referenceIds;\r\n  }\r\n\r\n  /** Collect the Ids of this entity's *references* at this level of the class hierarchy.\r\n   * A *reference* is any entity referenced by this entity's EC Data, including json fields.\r\n   * This is important for cloning operations but can be useful in other situations as well.\r\n   * @param _referenceIds The Id64Set to populate with reference Ids.\r\n   * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.\r\n   * @see getReferenceIds\r\n   * @beta\r\n   */\r\n  protected collectReferenceIds(_referenceIds: EntityReferenceSet): void {\r\n    return; // no references by default\r\n  }\r\n}\r\n\r\n/** A callback function to process properties of an Entity\r\n * @public @preview\r\n */\r\nexport type PropertyHandler = (name: string, property: Property) => void;\r\n\r\n/** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.\r\n * @public @preview\r\n */\r\nexport type EntityClassType<T> = Function & { prototype: T }; // eslint-disable-line @typescript-eslint/no-unsafe-function-type\r\n"]}
+{"version":3,"file":"Entity.js","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAmC,kBAAkB,EAAsC,MAAM,oBAAoB,CAAC;AAG7H,OAAO,EAAE,OAAO,EAAE,WAAW,EAAY,iBAAiB,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAC5G,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAgC/C;;;;GAIG;AACH,MAAM,OAAO,MAAM;IACjB;;OAEG;IACa,kBAAkB,GAAG,IAAa,CAAC;IACnD,0CAA0C;IACnC,MAAM,CAAC,MAAM,CAAgB,CAAC,mGAAmG;IAExI,IAAY,KAAK,KAAoB,OAAO,IAAI,CAAC,WAA4B,CAAC,CAAC,CAAC;IAEhF;;;;OAIG;IACI,MAAM,KAAK,SAAS,KAAa,OAAO,QAAQ,CAAC,CAAC,CAAC;IAE1D;;OAEG;IACI,MAAM,KAAK,aAAa;QAC7B,gFAAgF;QAChF,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAClE,CAAC;IAED,sCAAsC;IAC5B,SAAS,CAAmC;IAEtD;;;OAGG;IACH,IAAW,KAAK,KAAU,OAAO,IAAI,CAAC,CAAC,CAAC;IAExC,yDAAyD;IACzD,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAExE,4DAA4D;IAC5D,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IAE/D,iDAAiD;IAC1C,MAAM,CAAW;IAExB,kGAAkG;IAC3F,EAAE,CAAa;IAGtB,YAAsB,KAAkB,EAAE,MAAgB;QACxD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,8EAA8E;QAC9E,4DAA4D;QAC5D,IAAI,CAAC,eAAe,CAAC,CAAC,QAAgB,EAAE,IAAsB,EAAE,EAAE,CAAE,IAAY,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,cAAc,CAAE,KAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACrJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,WAAW,CAAC,QAAuB,EAAE,KAAkB,EAAE,MAAgB;QACrF,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;eAEW;IACD,MAAM,CAAU,mBAAmB,GAA4B;QACvE,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;QACvC,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE;QAC9C,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,EAAE;KACpD,CAAC;IAEF;mBACe;IACP,MAAM,CAAC,0BAA0B;QACvC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,mBAAmB,CAAC;QAClC,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAkB,CAAC;QAChE,OAAO;YACL,GAAG,UAAU,CAAC,0BAA0B,EAAE;YAC1C,GAAG,IAAI,CAAC,mBAAmB;SAC5B,CAAC;IACJ,CAAC;IAED;eACW;IACJ,MAAM,CAAC,WAAW,CAAC,KAA4B;QACpD,MAAM,OAAO,GAAgB;YAC3B,aAAa,EAAE,KAAK,CAAC,GAAG,CAAC,aAAa;YACtC,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE;SACjB,CAAA;QAED,gIAAgI;QAChI,IAAI,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;YAC7B,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;QAC7G,CAAC;QACD,iFAAiF;QACjF,MAAM,uBAAuB,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAClE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;aACnB,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,KAAK,YAAY,CAAC,KAAK,SAAS,CAAC;aAChH,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,CAAE,OAAoB,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CACvF,CAAC;QACJ,yDAAyD;QACzD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YAC5C,IAAK,OAAoB,CAAC,YAAY,CAAC,CAAC,YAAY,KAAK,SAAS,IAAI,YAAY,KAAK,gBAAgB,IAAI,YAAY,KAAK,aAAa,EAAE,CAAC;gBACzI,OAAoB,CAAC,YAAY,CAAC,CAAC,YAAY,GAAI,OAAoB,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YACxH,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;eACW;IACJ,MAAM,CAAC,SAAS,CAAC,KAAkB,EAAE,OAAiB;QAC3D,MAAM,IAAI,GAAa;YACrB,aAAa,EAAE,KAAK,CAAC,aAAa;YAClC,EAAE,EAAE,KAAK,CAAC,EAAE;SACb,CAAA;QAED,MAAM,uBAAuB,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAClE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;aACf,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,KAAK,YAAY,CAAC,KAAK,SAAS,CAAC;aAChH,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,GAAI,KAAkB,CAAC,YAAY,CAAC,CAChF,CAAC;QACJ,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACvC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QACnB,4DAA4D;QAC5D,IAAI,CAAC,eAAe,CAAC,CAAC,QAAgB,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAI,IAAY,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;QAC3F,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,4DAA4D;IACrD,eAAe,CAAC,IAAsB,EAAE,gBAAyB,IAAI;QAC1E,4DAA4D;QAC5D,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,OAAO,CAAC,IAAqB,EAAE,gBAAyB,IAAI;QACjE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE/F,IAAI,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;YACnF,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;gBAChD,IAAI,aAAa,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC,+BAA+B,CAAC;oBACnF,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAClC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,qDAAqD,CAAC,CAAC;QACtH,CAAC;IACH,CAAC;IAED,4EAA4E;IACrE,MAAM,KAAK,aAAa,KAAa,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAEnG,6EAA6E;IAC7E,IAAW,aAAa,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IACvE;;;OAGG;IACH,IAAW,aAAa,KAAoB,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IAE9E;;;;;OAKG;IACI,KAAK,CAAC,WAAW;QACtB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC3F,IAAI,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;YACzF,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;YACzB,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED;;OAEG;IACI,eAAe;QACpB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QACzF,IAAI,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;YACzF,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;YACzB,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,MAAM,KAAK,mBAAmB,KAAe,OAAO,EAAE,CAAC,CAAC,CAAC;IAEhE;;;;;OAKG;IACI,MAAM,CAAC,EAAE,CAAC,UAAyB;QACxC,6EAA6E;QAC7E,OAAO,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,SAAS,YAAY,UAAU,CAAC;IACrE,CAAC;IAED;;;OAGG;IACI,MAAM,KAAK,gBAAgB,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IAEtD;;;;;OAKG;IACI,eAAe;QACpB,MAAM,YAAY,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAC9C,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACvC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;OAOG;IACO,mBAAmB,CAAC,aAAiC;QAC7D,OAAO,CAAC,2BAA2B;IACrC,CAAC","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 Schema\r\n */\r\n\r\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { ElementLoadOptions, EntityProps, EntityReferenceSet, PropertyCallback, PropertyMetaData } from \"@itwin/core-common\";\r\nimport type { IModelDb } from \"./IModelDb\";\r\nimport { Schema } from \"./Schema\";\r\nimport { ECClass, EntityClass, Property, RelationshipClass, SchemaItemKey } from \"@itwin/ecschema-metadata\";\r\nimport { _nativeDb } from \"./internal/Symbols\";\r\n\r\n/** Represents a row returned by an ECSql query. The row is returned as a map of property names to values.\r\n * ECSqlRow has same schema as declared in ECSchema for the class and similar to if ECSQL SELECT * FROM <schema>:<class> were executed.\r\n * @beta */\r\nexport interface ECSqlRow {\r\n  [key: string]: any\r\n}\r\n\r\n/** Set of properties that are used to deserialize an [[EntityProps]] from an ECSqlRow.\r\n * @beta */\r\nexport interface DeserializeEntityArgs {\r\n  /** Row to deserialize */\r\n  row: ECSqlRow;\r\n  /** The IModel that contains this Entity */\r\n  iModel: IModelDb;\r\n  /** The options used when loading */\r\n  options?: {\r\n    /** Options used when loading an element */\r\n    element?: ElementLoadOptions;\r\n  }\r\n}\r\n\r\n/** A property of an [[Entity]] that needs to be custom handled during deserialization and serialization.\r\n * @beta */\r\nexport interface CustomHandledProperty {\r\n  /** The name of the property as it appears in the ECSqlRow */\r\n  readonly propertyName: string;\r\n  /** Where the property is defined */\r\n  readonly source: \"Class\" | \"Computed\";\r\n}\r\n\r\n/** Represents one of the fundamental building block in an [[IModelDb]]: as an [[Element]], [[Model]], or [[Relationship]].\r\n * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).\r\n * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].\r\n * @public @preview\r\n */\r\nexport class Entity {\r\n  /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types\r\n   * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].\r\n   */\r\n  public readonly isInstanceOfEntity = true as const;\r\n  /** The Schema that defines this class. */\r\n  public static schema: typeof Schema; // TODO: Schema key on the static level, but it requires a version which may differ between imodels\r\n\r\n  private get _ctor(): typeof Entity { return this.constructor as typeof Entity; }\r\n\r\n  /** The name of the BIS class associated with this class.\r\n   * @note Every subclass of Entity **MUST** override this method to identify its BIS class.\r\n   * Failure to do so will ordinarily result in an error when the class is registered, since there may only\r\n   * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)\r\n   */\r\n  public static get className(): string { return \"Entity\"; }\r\n\r\n  /** Serves as a unique identifier for this class. Typed variant of [[classFullName]].\r\n   * @public @preview\r\n   */\r\n  public static get schemaItemKey(): SchemaItemKey {\r\n    // We cannot cache this here because the className gets overridden in subclasses\r\n    return new SchemaItemKey(this.className, this.schema.schemaKey);\r\n  }\r\n\r\n  /** Cached Metadata for the ECClass */\r\n  protected _metadata?: EntityClass | RelationshipClass;\r\n\r\n  /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.\r\n   * This property makes such code slightly less tedious to read and write.\r\n   * @internal\r\n   */\r\n  public get asAny(): any { return this; }\r\n\r\n  /** The name of the BIS Schema that defines this class */\r\n  public get schemaName(): string { return this._ctor.schema.schemaName; }\r\n\r\n  /** The name of the BIS class associated with this class. */\r\n  public get className(): string { return this._ctor.className; }\r\n\r\n  /** The [[IModelDb]] that contains this Entity */\r\n  public iModel: IModelDb;\r\n\r\n  /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */\r\n  public id: Id64String;\r\n\r\n\r\n  protected constructor(props: EntityProps, iModel: IModelDb) {\r\n    this.iModel = iModel;\r\n    this.id = Id64.fromJSON(props.id);\r\n    // copy all auto-handled properties from input to the object being constructed\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.forEachProperty((propName: string, meta: PropertyMetaData) => (this as any)[propName] = meta.createProperty((props as any)[propName]), false);\r\n  }\r\n\r\n  /** Invoke the constructor of the specified `Entity` subclass.\r\n   * @internal\r\n   */\r\n  public static instantiate(subclass: typeof Entity, props: EntityProps, iModel: IModelDb): Entity {\r\n    return new subclass(props, iModel);\r\n  }\r\n\r\n  /** List of properties that are need to be custom handled during deserialization and serialization.\r\n   * These properties differ between the ECSql instance of an Entity and the Entity itself.\r\n   * @beta */\r\n  protected static readonly _customHandledProps: CustomHandledProperty[] = [\r\n    { propertyName: \"id\", source: \"Class\" },\r\n    { propertyName: \"className\", source: \"Class\" },\r\n    { propertyName: \"jsonProperties\", source: \"Class\" }\r\n  ];\r\n\r\n  /** Get the list of properties that are custom handled by this class and its superclasses.\r\n   * @internal */\r\n  private static getCustomHandledProperties(): readonly CustomHandledProperty[] {\r\n    if (this.name === \"Entity\") {\r\n      return this._customHandledProps;\r\n    }\r\n\r\n    const superClass = Object.getPrototypeOf(this) as typeof Entity;\r\n    return [\r\n      ...superClass.getCustomHandledProperties(),\r\n      ...this._customHandledProps,\r\n    ];\r\n  }\r\n\r\n  /** Converts an ECSqlRow of an Entity to an EntityProps. This is used to deserialize an Entity from the database.\r\n   * @beta */\r\n  public static deserialize(props: DeserializeEntityArgs): EntityProps {\r\n    const enProps: EntityProps = {\r\n      classFullName: props.row.classFullName,\r\n      id: props.row.id,\r\n    }\r\n\r\n    // Handles cases where id64 ints are stored in the jsonProperties and converts them to hex before parsing as a json object in js\r\n    if (props.row.jsonProperties) {\r\n      enProps.jsonProperties = JSON.parse(props.iModel[_nativeDb].patchJsonProperties(props.row.jsonProperties));\r\n    }\r\n    // Auto handles all properties that are not in the 'customHandledProperties' list\r\n    const customHandledProperties = this.getCustomHandledProperties();\r\n    Object.keys(props.row)\r\n      .filter((propertyName) => customHandledProperties.find((val) => val.propertyName === propertyName) === undefined)\r\n      .forEach((propertyName) => (enProps as ECSqlRow)[propertyName] = props.row[propertyName]\r\n      );\r\n    // Handles custom relClassNames to use '.' instead of ':'\r\n    Object.keys(enProps).forEach((propertyName) => {\r\n      if ((enProps as ECSqlRow)[propertyName].relClassName !== undefined && propertyName !== \"modeledElement\" && propertyName !== \"parentModel\") {\r\n        (enProps as ECSqlRow)[propertyName].relClassName = (enProps as ECSqlRow)[propertyName].relClassName.replace(':', '.');\r\n      }\r\n    });\r\n    return enProps;\r\n  }\r\n\r\n  /** Converts an EntityProps to an ECSqlRow. This is used to serialize an Entity to prepare to write it to the database.\r\n   * @beta */\r\n  public static serialize(props: EntityProps, _iModel: IModelDb): ECSqlRow {\r\n    const inst: ECSqlRow = {\r\n      classFullName: props.classFullName,\r\n      id: props.id,\r\n    }\r\n\r\n    const customHandledProperties = this.getCustomHandledProperties();\r\n    Object.keys(props)\r\n      .filter((propertyName) => customHandledProperties.find((val) => val.propertyName === propertyName) === undefined)\r\n      .forEach((propertyName) => inst[propertyName] = (props as ECSqlRow)[propertyName]\r\n      );\r\n    return inst;\r\n  }\r\n\r\n  /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -\r\n   * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).\r\n   */\r\n  public toJSON(): EntityProps {\r\n    const val: any = {};\r\n    val.classFullName = this.classFullName;\r\n    if (Id64.isValid(this.id))\r\n      val.id = this.id;\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.forEachProperty((propName: string) => val[propName] = (this as any)[propName], false);\r\n    return val;\r\n  }\r\n\r\n  /** Call a function for each property of this Entity.\r\n   * @param func The callback to be invoked on each property\r\n   * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\r\n   * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\r\n   * @deprecated in 5.0 - will not be removed until after 2026-06-13. Obtain a `SchemaView` via `iModel.getSchemaView()` and iterate `view.findClass(entity.classFullName)?.getProperties()` instead. (`forEach` is also deprecated.)\r\n   *\r\n   * @example\r\n   * ```typescript\r\n   * // Deprecated method\r\n   * entity.forEachProperty((name, propMetaData) => {\r\n   *   console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);\r\n   * });\r\n   *\r\n   * // New method\r\n   * entity.forEach((name, property) => {\r\n   *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);\r\n   * });\r\n   * ```\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  public forEachProperty(func: PropertyCallback, includeCustom: boolean = true) {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.iModel.forEachMetaData(this.classFullName, true, func, includeCustom);\r\n  }\r\n\r\n  /**\r\n   * Call a function for each property of this Entity.\r\n   * @param func The callback to be invoked on each property.\r\n   * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\r\n   * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\r\n   * @throws Error if metadata for the class cannot be retrieved.\r\n   * @deprecated in 5.10.0 - will not be removed until after 2026-09-03. Obtain a `SchemaView` via `iModel.getSchemaView()` and iterate `view.findClass(entity.classFullName)?.getProperties()` yourself. SchemaView does not expose the `BisCore.CustomHandledProperty` custom attribute, so the `includeCustom: false` filter must be replicated by the caller (query the custom-handled property set via ECSql) if needed.\r\n   *\r\n   * @example\r\n   * ```typescript\r\n   * const view = await entity.iModel.getSchemaView();\r\n   * const cls = view.findClass(entity.classFullName);\r\n   * if (cls) {\r\n   *   for (const property of cls.getProperties()) {\r\n   *     console.log(`Property name: ${property.name}, Kind: ${property.kind}`);\r\n   *   }\r\n   * }\r\n   * ```\r\n   */\r\n  public forEach(func: PropertyHandler, includeCustom: boolean = true) {\r\n    const item = this._metadata ?? this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey);\r\n\r\n    if (EntityClass.isEntityClass(item) || RelationshipClass.isRelationshipClass(item)) {\r\n      for (const property of item.getPropertiesSync()) {\r\n        if (includeCustom || !property.customAttributes?.has(`BisCore.CustomHandledProperty`))\r\n          func(property.name, property);\r\n      }\r\n    } else {\r\n      throw new Error(`Cannot get metadata for ${this.classFullName}. Class is not an EntityClass or RelationshipClass.`);\r\n    }\r\n  }\r\n\r\n  /** Get the full BIS class name of this Entity in the form \"schema:class\" */\r\n  public static get classFullName(): string { return `${this.schema.schemaName}:${this.className}`; }\r\n\r\n  /** Get the full BIS class name of this Entity in the form \"schema:class\". */\r\n  public get classFullName(): string { return this._ctor.classFullName; }\r\n  /**\r\n   * Get the item key used by the ecschema-metadata package to identify this entity class\r\n   * @public @preview\r\n   */\r\n  public get schemaItemKey(): SchemaItemKey { return this._ctor.schemaItemKey; }\r\n\r\n  /** Query metadata for this entity class from the iModel's schema. Returns cached metadata if available.\r\n   * @throws [[IModelError]] if there is a problem querying the schema\r\n   * @returns The metadata for the current entity\r\n   * @public @preview\r\n   * @deprecated in 5.10.0 - will not be removed until after 2026-09-03. Obtain a `SchemaView` via `iModel.getSchemaView()` and call `view.findClass(entity.classFullName)` to retrieve a `SchemaView.Class`. The returned type differs from `EntityClass | RelationshipClass` and offers a synchronous, snapshot-style API.\r\n   */\r\n  public async getMetaData(): Promise<EntityClass | RelationshipClass> {\r\n    if (this._metadata) {\r\n      return this._metadata;\r\n    }\r\n\r\n    const ecClass = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, ECClass);\r\n    if (EntityClass.isEntityClass(ecClass) || RelationshipClass.isRelationshipClass(ecClass)) {\r\n      this._metadata = ecClass;\r\n      return this._metadata;\r\n    } else {\r\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\r\n    }\r\n  }\r\n\r\n  /** @internal\r\n   * @deprecated in 5.10.0 - will not be removed until after 2026-09-03. Internal callers should obtain a `SchemaView` via `iModel.getSchemaView()` (or retain a pre-loaded one) and call `view.findClass(...)` instead. Note that `getSchemaView()` is async.\r\n   */\r\n  public getMetaDataSync(): EntityClass | RelationshipClass {\r\n    if (this._metadata) {\r\n      return this._metadata;\r\n    }\r\n\r\n    const ecClass = this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey, ECClass);\r\n    if (EntityClass.isEntityClass(ecClass) || RelationshipClass.isRelationshipClass(ecClass)) {\r\n      this._metadata = ecClass;\r\n      return this._metadata;\r\n    } else {\r\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\r\n    }\r\n  }\r\n  \r\n  /** @internal */\r\n  public static get protectedOperations(): string[] { return []; }\r\n\r\n  /** return whether this Entity class is a subclass of another Entity class\r\n   * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's\r\n   * inheritance, you can use [ECClass.is]($ecschema-metadata)\r\n   * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of\r\n   * typescript's restriction on the `this` type in static methods\r\n   */\r\n  public static is(otherClass: typeof Entity): boolean {\r\n    // inline of @itwin/core-bentley's isSubclassOf due to protected constructor.\r\n    return this === otherClass || this.prototype instanceof otherClass;\r\n  }\r\n\r\n  /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation\r\n   * ClassRegistry overrides this when generating a class\r\n   * @internal\r\n   */\r\n  public static get isGeneratedClass() { return false; }\r\n\r\n  /** Get the set of this entity's *entity references*, [EntityReferenceSet]($backend). An *entity reference* is any id\r\n   * stored on the entity, in its EC properties or json fields.\r\n   * This is important for cloning operations but can be useful in other situations as well.\r\n   * @see this.collectReferenceIds\r\n   * @beta\r\n   */\r\n  public getReferenceIds(): EntityReferenceSet {\r\n    const referenceIds = new EntityReferenceSet();\r\n    this.collectReferenceIds(referenceIds);\r\n    return referenceIds;\r\n  }\r\n\r\n  /** Collect the Ids of this entity's *references* at this level of the class hierarchy.\r\n   * A *reference* is any entity referenced by this entity's EC Data, including json fields.\r\n   * This is important for cloning operations but can be useful in other situations as well.\r\n   * @param _referenceIds The Id64Set to populate with reference Ids.\r\n   * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.\r\n   * @see getReferenceIds\r\n   * @beta\r\n   */\r\n  protected collectReferenceIds(_referenceIds: EntityReferenceSet): void {\r\n    return; // no references by default\r\n  }\r\n}\r\n\r\n/** A callback function to process properties of an Entity\r\n * @public @preview\r\n */\r\nexport type PropertyHandler = (name: string, property: Property) => void;\r\n\r\n/** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.\r\n * @public @preview\r\n */\r\nexport type EntityClassType<T> = Function & { prototype: T }; // eslint-disable-line @typescript-eslint/no-unsafe-function-type\r\n"]}

package/lib/esm/Relationship.d.ts

@@ -29,7 +29,7 @@ export declare class Relationship extends Entity {
     protected constructor(props: RelationshipProps, iModel: IModelDb);
     toJSON(): RelationshipProps;
     /** Query metadata for this relationship class from the iModel's schema. Returns cached metadata if available.
-     * @deprecated in 5.10.0. Obtain a `SchemaView` via `iModel.getSchemaView()` and call `view.findClass(relationship.classFullName)` to retrieve a `SchemaView.Class`. The returned type differs from `RelationshipClass` and offers a synchronous, snapshot-style API.
+     * @deprecated in 5.10.0 - will not be removed until after 2027-06-03. Obtain a `SchemaView` via `iModel.getSchemaView()` and call `view.findClass(relationship.classFullName)` to retrieve a `SchemaView.Class`. The returned type differs from `RelationshipClass` and offers a synchronous, snapshot-style API.
      */
     getMetaData(): Promise<RelationshipClass>;
     /**

package/lib/esm/Relationship.js

@@ -30,7 +30,7 @@ export class Relationship extends Entity {
         return val;
     }
     /** Query metadata for this relationship class from the iModel's schema. Returns cached metadata if available.
-     * @deprecated in 5.10.0. Obtain a `SchemaView` via `iModel.getSchemaView()` and call `view.findClass(relationship.classFullName)` to retrieve a `SchemaView.Class`. The returned type differs from `RelationshipClass` and offers a synchronous, snapshot-style API.
+     * @deprecated in 5.10.0 - will not be removed until after 2027-06-03. Obtain a `SchemaView` via `iModel.getSchemaView()` and call `view.findClass(relationship.classFullName)` to retrieve a `SchemaView.Class`. The returned type differs from `RelationshipClass` and offers a synchronous, snapshot-style API.
      */
     async getMetaData() {
         if (this._metadata && RelationshipClass.isRelationshipClass(this._metadata)) {

package/lib/esm/Relationship.js.map

@@ -1 +1 @@
-{"version":3,"file":"Relationship.js","sourceRoot":"","sources":["../../src/Relationship.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAc,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAsB,WAAW,EAAsC,MAAM,oBAAoB,CAAC;AAEzG,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAgB7D;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,MAAM;IAC/B,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IACzD,QAAQ,CAAa;IACrB,QAAQ,CAAa;IAErC,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAuB,CAAC;QAChD,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;OAEG;IACa,KAAK,CAAC,WAAW;QAC/B,IAAI,IAAI,CAAC,SAAS,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5E,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;QAC1G,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC;YAC9B,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAAC,GAAoB;QACjD,4DAA4D;QAC5D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,aAAa,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAEnF;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,CAAC,GAAoB;QACvD,4DAA4D;QAC5D,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAYlF,MAAM,CAAC,GAAa,IAAgB,OAAO,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAY5H,MAAM,CAAC,GAAa,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAY/F,MAAM,CAAC,GAAa,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAE/F,MAAM,CAAC,WAAW,CAAyB,MAAgB,EAAE,QAAsC,IAAO,OAAO,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CAC1L;AAED;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,YAAY;IAChD,MAAM,KAAc,SAAS,KAAa,OAAO,yBAAyB,CAAC,CAAC,CAAC;IACpF;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAoC,MAAgB,EAAE,QAAoB,EAAE,QAAoB;QAClH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAM,CAAC;IAC7G,CAAC;IAkBM,MAAM,CAAC,MAAM,CAAC,WAA+B,EAAE,QAAoB,EAAE,QAAoB;QAC9F,MAAM,GAAG,GAAG,WAAW,YAAY,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACrF,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACjE,OAAO,GAAG,CAAC,kBAAkB,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,+BAAgC,SAAQ,uBAAuB;IACnE,MAAM,KAAc,SAAS,KAAa,OAAO,iCAAiC,CAAC,CAAC,CAAC;CAC7F;AAED;;GAEG;AACH,MAAM,OAAO,mCAAoC,SAAQ,uBAAuB;IACvE,MAAM,KAAc,SAAS,KAAa,OAAO,qCAAqC,CAAC,CAAC,CAAC;CACjG;AAED;;;;GAIG;AACH,MAAM,OAAO,qCAAsC,SAAQ,uBAAuB;IACzE,MAAM,KAAc,SAAS,KAAa,OAAO,uCAAuC,CAAC,CAAC,CAAC;CACnG;AAED;;;GAGG;AACH,MAAM,OAAO,yCAA0C,SAAQ,qCAAqC;IAC3F,MAAM,KAAc,SAAS,KAAa,OAAO,2CAA2C,CAAC,CAAC,CAAC;CACvG;AASD;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,uBAAuB;IACxD,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IAC1E,cAAc,CAAS;IAE9B,YAAY,KAAgC,EAAE,MAAgB;QAC5D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;IAC7C,CAAC;IAEM,MAAM,CAAU,MAAM,CAAoC,MAAgB,EAAE,QAAoB,EAAE,QAAoB,EAAE,iBAAyB,CAAC;QACvJ,MAAM,KAAK,GAA8B,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;QACnH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAM,CAAC;IACzD,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,gCAAiC,SAAQ,oBAAoB;IACjE,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAED;;;;GAIG;AACH,MAAM,OAAO,qBAAsB,SAAQ,oBAAoB;IACtD,MAAM,KAAc,SAAS,KAAa,OAAO,uBAAuB,CAAC,CAAC,CAAC;CACnF;AAED;;;GAGG;AACH,MAAM,OAAO,gCAAiC,SAAQ,oBAAoB;IACjE,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAUD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuLG;AACH,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IAC7C,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IACjF;;;;OAIG;IACI,MAAM,CAAS;IACtB,uHAAuH;IAChH,QAAQ,CAAS;IAExB,YAAsB,KAAgC,EAAE,MAAgB;QACtE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,MAAM,CAAiC,MAAgB,EAAE,QAAoB,EAAE,QAAoB,EAAE,WAAmB,CAAC;QACrI,MAAM,KAAK,GAA8B,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;QACxH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAM,CAAC;IACzD,CAAC;IAEe,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAA+B,CAAC;QAC1D,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,2BAA4B,SAAQ,YAAY;IACpD,MAAM,KAAc,SAAS,KAAa,OAAO,6BAA6B,CAAC,CAAC,CAAC;IACrE,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,aAAa;IAChB,OAAO,CAAW;IAE1B,gBAAgB;IAChB,YAAmB,MAAgB,IAAI,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IAE/D;;;OAGG;IACI,cAAc,CAAC,KAAwB,IAAkB,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAe,KAAK,CAAC,CAAC,CAAC,CAAC;IAE3H,2EAA2E;IACnE,sBAAsB,CAAC,aAAqB;QAClD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;YACtF,MAAM,IAAI,WAAW,CAAC,QAAQ,CAAC,eAAe,EAAE,UAAU,aAAa,8HAA8H,CAAC,CAAC;QACzM,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,KAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,KAAuC;QAC5D,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAA8B,gBAAwB,EAAE,QAAsC;QACnH,MAAM,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAI,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAClF,IAAI,SAAS,KAAK,iBAAiB,EAAE,CAAC;YACpC,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CAA8B,gBAAwB,EAAE,QAAsC;QACtH,IAAI,KAAoB,CAAC;QACzB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,4DAA4D;YAC5D,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,iBAAiB,gBAAgB,uBAAuB,EAAE,CAAC,IAAoB,EAAE,EAAE;gBAC5H,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;gBACzB,OAAO,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YACjF,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,4DAA4D;YAC5D,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,iBAAiB,gBAAgB,sDAAsD,EAAE,CAAC,IAAoB,EAAE,EAAE;gBAC3J,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAClC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAClC,OAAO,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YACjF,CAAC,CAAC,CAAC;QACL,CAAC;QACD,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;YACxB,KAAK,CAAC,aAAa,GAAI,KAAa,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAyB,eAAuB,EAAE,QAAsC;QACxG,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAI,IAAI,CAAC,gBAAgB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAyB,gBAAwB,EAAE,QAAsC;QAC5G,MAAM,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAoB,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAClG,OAAO,SAAS,KAAK,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1G,CAAC;CACF","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 Relationships\r\n */\r\n\r\nimport { DbResult, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { EntityReferenceSet, IModelError, RelationshipProps, SourceAndTarget } from \"@itwin/core-common\";\r\nimport { ECSqlStatement } from \"./ECSqlStatement\";\r\nimport { Entity } from \"./Entity\";\r\nimport { EditTxn } from \"./EditTxn\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { _implicitTxn, _nativeDb } from \"./internal/Symbols\";\r\nimport { RelationshipClass } from \"@itwin/ecschema-metadata\";\r\n\r\nexport type { SourceAndTarget, RelationshipProps } from \"@itwin/core-common\"; // for backwards compatibility\r\n\r\n/** Argument for relationship dependency callbacks.\r\n * @beta\r\n */\r\nexport interface OnDependencyArg {\r\n  /** The iModel for the relationship affected by this method. */\r\n  iModel: IModelDb;\r\n  /** The ElementDrivesElement relationship instance affected by this method. */\r\n  props: RelationshipProps;\r\n  /** The transaction for indirect processing. */\r\n  indirectEditTxn: EditTxn;\r\n}\r\n\r\n/** Base class for all link table ECRelationships\r\n * @public\r\n */\r\nexport class Relationship extends Entity {\r\n  public static override get className(): string { return \"Relationship\"; }\r\n  public readonly sourceId: Id64String;\r\n  public readonly targetId: Id64String;\r\n\r\n  protected constructor(props: RelationshipProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.sourceId = Id64.fromJSON(props.sourceId);\r\n    this.targetId = Id64.fromJSON(props.targetId);\r\n  }\r\n\r\n  public override toJSON(): RelationshipProps {\r\n    const val = super.toJSON() as RelationshipProps;\r\n    val.sourceId = this.sourceId;\r\n    val.targetId = this.targetId;\r\n    return val;\r\n  }\r\n\r\n  /** Query metadata for this relationship class from the iModel's schema. Returns cached metadata if available.\r\n   * @deprecated in 5.10.0. Obtain a `SchemaView` via `iModel.getSchemaView()` and call `view.findClass(relationship.classFullName)` to retrieve a `SchemaView.Class`. The returned type differs from `RelationshipClass` and offers a synchronous, snapshot-style API.\r\n   */\r\n  public override async getMetaData(): Promise<RelationshipClass> {\r\n    if (this._metadata && RelationshipClass.isRelationshipClass(this._metadata)) {\r\n      return this._metadata;\r\n    }\r\n\r\n    const relationship = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, RelationshipClass);\r\n    if (relationship !== undefined) {\r\n      this._metadata = relationship;\r\n      return this._metadata;\r\n    } else {\r\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when its input has changed or is the output of some upstream relationship whose input has changed.\r\n   * This callback is invoked after the input element has been processed by upstream relationships.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.\r\n   * @beta\r\n   */\r\n  public static onRootChangedArg(arg: OnDependencyArg): void {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.onRootChanged(arg.props, arg.iModel);\r\n  }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when its input has changed or is the output of some upstream relationship whose input has changed.\r\n   * This callback is invoked after the input element has been processed by upstream relationships.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.\r\n   * @param _props The ElementDrivesElement relationship instance.\r\n   * @param _iModel The iModel\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use onRootChangedArg instead.\r\n   */\r\n  public static onRootChanged(_props: RelationshipProps, _iModel: IModelDb): void { }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action.\r\n   * @beta\r\n   */\r\n  public static onDeletedDependencyArg(arg: OnDependencyArg): void {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.onDeletedDependency(arg.props, arg.iModel);\r\n  }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action.\r\n   * @param _props The deleted ElementDrivesElement relationship instance.\r\n   * @param _iModel The iModel\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use onDeletedDependencyArg instead.\r\n   */\r\n  public static onDeletedDependency(_props: RelationshipProps, _iModel: IModelDb): void { }\r\n\r\n  /**\r\n   * Insert this Relationship into the iModel using the supplied EditTxn.\r\n   * @beta\r\n   */\r\n  public insert(txn: EditTxn): Id64String;\r\n  /**\r\n   * Insert this Relationship into the iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use Relationship.insert(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public insert(): Id64String;\r\n  public insert(txn?: EditTxn): Id64String { return this.id = (txn ?? this.iModel[_implicitTxn]).insertRelationship(this.toJSON()); }\r\n\r\n  /**\r\n   * Update this Relationship in the iModel using the supplied EditTxn.\r\n   * @beta\r\n   */\r\n  public update(txn: EditTxn): void;\r\n  /**\r\n   * Update this Relationship in the iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use Relationship.update(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public update(): void;\r\n  public update(txn?: EditTxn) { (txn ?? this.iModel[_implicitTxn]).updateRelationship(this.toJSON()); }\r\n\r\n  /**\r\n   * Delete this Relationship from the iModel using the supplied EditTxn.\r\n   * @beta\r\n   */\r\n  public delete(txn: EditTxn): void;\r\n  /**\r\n   * Delete this Relationship from the iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use Relationship.delete(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public delete(): void;\r\n  public delete(txn?: EditTxn) { (txn ?? this.iModel[_implicitTxn]).deleteRelationship(this.toJSON()); }\r\n\r\n  public static getInstance<T extends Relationship>(iModel: IModelDb, criteria: Id64String | SourceAndTarget): T { return iModel.relationships.getInstance(this.classFullName, criteria); }\r\n}\r\n\r\n/** A Relationship where one Element refers to another Element\r\n * @public\r\n */\r\nexport class ElementRefersToElements extends Relationship {\r\n  public static override get className(): string { return \"ElementRefersToElements\"; }\r\n  /** Create an instance of the Relationship.\r\n   * @param iModel The iModel that will contain the relationship\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element\r\n   * @param targetId The targetId of the relationship, that is, the driven element\r\n   * @return an instance of the specified class.\r\n   */\r\n  public static create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): T {\r\n    return iModel.relationships.createInstance({ sourceId, targetId, classFullName: this.classFullName }) as T;\r\n  }\r\n\r\n  /** Insert a new instance of the Relationship using an explicit transaction.\r\n   * @param txn The EditTxn used to perform the insert.\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element\r\n   * @param targetId The targetId of the relationship, that is, the driven element\r\n   * @return The Id of the inserted Relationship.\r\n   * @beta\r\n   */\r\n  public static insert(txn: EditTxn, sourceId: Id64String, targetId: Id64String): Id64String;\r\n  /** Insert a new instance of the Relationship.\r\n   * @param iModel The iModel that will contain the relationship.\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element.\r\n   * @param targetId The targetId of the relationship, that is, the driven element.\r\n   * @return The Id of the inserted Relationship.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use ElementRefersToElements.insert(txn, ...) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public static insert(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): Id64String;\r\n  public static insert(txnOrIModel: EditTxn | IModelDb, sourceId: Id64String, targetId: Id64String): Id64String {\r\n    const txn = txnOrIModel instanceof EditTxn ? txnOrIModel : txnOrIModel[_implicitTxn];\r\n    const relationship = this.create(txn.iModel, sourceId, targetId);\r\n    return txn.insertRelationship(relationship.toJSON());\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addElement(this.targetId);\r\n  }\r\n}\r\n\r\n/** Relates a [[DrawingGraphic]] to the [[Element]] that it represents\r\n * @public\r\n */\r\nexport class DrawingGraphicRepresentsElement extends ElementRefersToElements {\r\n  public static override get className(): string { return \"DrawingGraphicRepresentsElement\"; }\r\n}\r\n\r\n/** Relates a [[GraphicalElement3d]] to the [[Element]] that it represents\r\n * @public\r\n */\r\nexport class GraphicalElement3dRepresentsElement extends ElementRefersToElements {\r\n  public static override get className(): string { return \"GraphicalElement3dRepresentsElement\"; }\r\n}\r\n\r\n/** Relates a [[SynchronizationConfigLink]] to N [[ExternalSource]] instances.\r\n * Each relationship instance represents an external source processed by the synchronization configuration.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class SynchronizationConfigProcessesSources extends ElementRefersToElements {\r\n  public static override get className(): string { return \"SynchronizationConfigProcessesSources\"; }\r\n}\r\n\r\n/** Relates a [[SynchronizationConfigLink]] to *root* [[ExternalSource]] instances.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class SynchronizationConfigSpecifiesRootSources extends SynchronizationConfigProcessesSources {\r\n  public static override get className(): string { return \"SynchronizationConfigSpecifiesRootSources\"; }\r\n}\r\n\r\n/** Properties that are common to all types of link table ECRelationships\r\n * @public\r\n */\r\nexport interface ElementGroupsMembersProps extends RelationshipProps {\r\n  memberPriority: number;\r\n}\r\n\r\n/** An ElementRefersToElements relationship where one Element *groups* a set of other Elements.\r\n * @public\r\n */\r\nexport class ElementGroupsMembers extends ElementRefersToElements {\r\n  public static override get className(): string { return \"ElementGroupsMembers\"; }\r\n  public memberPriority: number;\r\n\r\n  constructor(props: ElementGroupsMembersProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.memberPriority = props.memberPriority;\r\n  }\r\n\r\n  public static override create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, memberPriority: number = 0): T {\r\n    const props: ElementGroupsMembersProps = { sourceId, targetId, memberPriority, classFullName: this.classFullName };\r\n    return iModel.relationships.createInstance(props) as T;\r\n  }\r\n}\r\n\r\n/** Relates a [[DefinitionGroup]] to its [[DefinitionElement]] members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.10\r\n * @public\r\n */\r\nexport class DefinitionGroupGroupsDefinitions extends ElementGroupsMembers {\r\n  public static override get className(): string { return \"DefinitionGroupGroupsDefinitions\"; }\r\n}\r\n\r\n/** Represents group membership where the group Element (and its properties) impart information about the member Elements above mere membership.\r\n * Implies that properties of the group should be considered as properties of its members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.11\r\n * @public\r\n */\r\nexport class GroupImpartsToMembers extends ElementGroupsMembers {\r\n  public static override get className(): string { return \"GroupImpartsToMembers\"; }\r\n}\r\n\r\n/** Relates an [[ExternalSourceGroup]] to its [[ExternalSource]] members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class ExternalSourceGroupGroupsSources extends ElementGroupsMembers {\r\n  public static override get className(): string { return \"ExternalSourceGroupGroupsSources\"; }\r\n}\r\n\r\n/** Properties that are common to all types of ElementDrivesElements\r\n * @beta\r\n */\r\nexport interface ElementDrivesElementProps extends RelationshipProps {\r\n  status: number;\r\n  priority: number;\r\n}\r\n\r\n/** A Relationship indicating that one Element *drives* another Element.\r\n * An ElementDrivesElement relationship defines a one-way \"driving\" relationship from the source to the target.\r\n * When the source of an ElementDrivesElement relationship changes, the ElementDrivesElement itself can get a callback, and both the source and target elements can get callbacks.\r\n * By inserting ElementDrivesElement relationships, an app can create and store an acyclic directed graph of dependencies between elements.\r\n *\r\n * # Defining dependencies\r\n * Create an ElementDrivesElement relationship to specify that the source element drives the target element.\r\n * For example, to specify that element e1 drives element e2, create a relationship between them like this:\r\n * ```ts\r\n *  const ede = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  ede.insert();\r\n * ```\r\n * This creates a persistent relationship. The fact that e1 drives e2 is persisted in the iModel.\r\n *\r\n * # Defining dependency graphs\r\n * When you create multiple ElementDrivesElement relationships, you create a network of dependencies. The target of one may be the source of another.\r\n * A change in the content of an DgnElement can therefore trigger changes to many downstream elements.\r\n *\r\n * For example, to make element e1 drive element e2 and e2 drive another element, e3, create two relationships like this:\r\n * ```ts\r\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\r\n *  ede12.insert();\r\n *  ede23.insert();\r\n * ```\r\n * Those two relationships create this graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n * Where the \"-->\" is meant to represent a driving relationship.\r\n *\r\n * The order in which you create the relationships does not matter.\r\n * The graph indicates that e3 depends on e2 and e2 depends on e1.\r\n *\r\n * An ElementDrivesElement relationship is between one source element and one target element.\r\n * Many ElementDrivesElement relationships can point to a given element, and many can point out of it.\r\n * Thus, you can define many:many relationships.\r\n * For example:\r\n * ```ts\r\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  const ede112 = ElementDrivesElement.create(iModel, e11id, e2id);\r\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\r\n *  const ede231 = ElementDrivesElement.create(iModel, e2id, e31id);\r\n *  ede12.insert();\r\n *  ede112.insert();\r\n *  ede23.insert();\r\n *  ede231.insert();\r\n * ```\r\n * Creates this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * e2 depends on both e1 and e11. e2 then drives e3 and e31.\r\n *\r\n * In an ElementDrivesElement dependency graph, the relationships are the \"edges\" and the Elements are the \"nodes\".\r\n * The following terms are used when referring to the elements (nodes) in a dependency graph:\r\n * * Inputs - The sources of all edges that point to the element. This includes all upstream elements that flow into the element.\r\n * * Outputs - The targets of all edges that point out of the element. This includes all downstream elements.\r\n *\r\n * # Subgraph Processing\r\n * When changes are made, only the part of the overall graph that is affected will be processed. So, for example,\r\n * suppose we have this graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n * If e1 changes, then the subgraph to be processed is equal to the full graph, as shown.\r\n *\r\n * If only e2 changes, then the subgraph to be processed is just:\r\n * ```\r\n *       e2 --> e3\r\n * ```\r\n * If only e3 changes, then the subgraph consists of e3 by itself.\r\n *\r\n * Returning to the second example above, suppose we have this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * If e1 is changed, the affected subgraph is:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * If e2 is changed, the affected subgraph is:\r\n * ```\r\n *           e3\r\n *         /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * # Callbacks\r\n * Once the affected subgraph to process is found, it propagates changes through it by making callbacks.\r\n * Classes for both elements (nodes) and ElementDrivesElements relationships (edges) can receive callbacks.\r\n *\r\n * ## ElementDrivesElement Callbacks\r\n * The following callbacks are invoked on ElementDrivesElement relationship classes (edges):\r\n * * onRootChanged\r\n * * onDeletedDependency\r\n *\r\n * Note that these are static methods. Their default implementations do nothing.\r\n * To receive and act on these callbacks, a domain should define a subclass of ElementDrivesElement and use that to create relationships.\r\n * The subclass should then implement the callbacks that it would like to act on.\r\n *\r\n * A ElementDrivesElement subclass callback is expected to make changes to the output element only!\r\n *\r\n * ## Element Callbacks\r\n * The following callbacks are invoked on Element classes (nodes):\r\n * * Element.onBeforeOutputsHandled\r\n * * Element.onAllInputsHandled\r\n *\r\n * ## Order\r\n * Callbacks are invoked by BriefcaseDb.saveChanges.\r\n * They are invoked in dependency (topological) order: driving elements first, then driven elements.\r\n *\r\n * Each callback is invoked only once. No matter how many times a given element was changed during the transaction,\r\n * a callback such as ElementDrivesElement.onRootChanged will be invoked only once.\r\n * In the same way, no matter how many of its inputs were changed, a callback such as Element.onAllInputsHandled will be\r\n * invoked only once.\r\n *\r\n * For example, suppose we have a graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n *\r\n * Suppose that e1 is directly modified. No callbacks are made at that time.\r\n * Later, when BriefcaseDb.saveChanges is called, the following callbacks are made, in order:\r\n * 1. Element.onBeforeOutputsHandled e1\r\n * 1. ElementDrivesElement.onRootChanged e1->e2\r\n * 1. Element.onAllInputsHandled e2\r\n * 1. ElementDrivesElement.onRootChanged e2->e3\r\n * 1. Element.onAllInputsHandled e3\r\n *\r\n * Suppose that e3 is modified directly and BriefcaseDb.saveChanges is called.\r\n * Since no input to a relationship was changed, the sub-graph will be empty, and no callbacks will be made.\r\n *\r\n * Returning to the second example above, suppose we have this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * If e1 is changed and BriefcaseDb.saveChanges is called, the subgraph is:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * The callbacks are:\r\n * 1. Element.onBeforeOutputsHandled e1\r\n * 1. ElementDrivesElement.onRootChanged e1->e2\r\n * 1. Element.onAllInputsHandled e2\r\n * 1. ElementDrivesElement.onRootChanged e2->e3\r\n * 1. Element.onAllInputsHandled e3\r\n * 1. ElementDrivesElement.onRootChanged e2->e31\r\n * 1. Element.onAllInputsHandled e31\r\n *\r\n * (The ElementDrivesElement.)\r\n *\r\n * #Errors\r\n * Circular dependencies are not permitted. If a cycle is detected, that is treated as a fatal error. All ElementDrivesElement relationships\r\n * involved in a cycle will have their status set to 1, indicating a failure.\r\n *\r\n * A callback may call txnManager.reportError to reject an invalid change. It can classify the error as fatal or just a warning.\r\n * A callback make set the status value of an ElementDrivesElement instance to 1 to indicate a processing failure in that edge.\r\n *\r\n * After BriefcaseDb.saveChanges is called, an app should check db.txns.validationErrors and db.txns.hasFatalError to find out if graph-evaluation failed.\r\n *\r\n * @beta\r\n */\r\nexport class ElementDrivesElement extends Relationship {\r\n  public static override get className(): string { return \"ElementDrivesElement\"; }\r\n  /** Relationship status\r\n   * * 0 indicates no errors. Set after a successful evaluation.\r\n   * * 1 indicates that this driving relationship could not be evaluated. The callback itself can set this to indicate that it failed to process the input changes. Also, it is set if the relationship is part of a circular dependency.\r\n   * * 0x80 The app or callback can set this to indicate to not propagate changes through this relationship.\r\n   */\r\n  public status: number;\r\n  /** Affects the order in which relationships are processed in the case where two relationships have the same output. */\r\n  public priority: number;\r\n\r\n  protected constructor(props: ElementDrivesElementProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.status = props.status;\r\n    this.priority = props.priority;\r\n  }\r\n\r\n  public static create<T extends ElementDrivesElement>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, priority: number = 0): T {\r\n    const props: ElementDrivesElementProps = { sourceId, targetId, priority, status: 0, classFullName: this.classFullName };\r\n    return iModel.relationships.createInstance(props) as T;\r\n  }\r\n\r\n  public override toJSON(): ElementDrivesElementProps {\r\n    const props = super.toJSON() as ElementDrivesElementProps;\r\n    props.status = this.status;\r\n    props.priority = this.priority;\r\n    return props;\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addElement(this.targetId);\r\n  }\r\n}\r\n\r\n/** The third (and last) possible link-table relationship base class in an iModel.\r\n * Has no external use, but is included for completeness of the [Entity.collectReferenceIds]($backend)\r\n * implementations for link-table relationships. Generating the types of the source and target automatically would require\r\n * coupling this package with ecschema-metadata which we do not want to do.\r\n * @internal\r\n */\r\nexport class ModelSelectorRefersToModels extends Relationship {\r\n  public static override get className(): string { return \"ModelSelectorRefersToModels\"; }\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addModel(this.targetId);\r\n  }\r\n}\r\n\r\n/** Manages [[Relationship]]s.\r\n * @public\r\n */\r\nexport class Relationships {\r\n  private _iModel: IModelDb;\r\n\r\n  /** @internal */\r\n  public constructor(iModel: IModelDb) { this._iModel = iModel; }\r\n\r\n  /** Create a new instance of a Relationship.\r\n   * @param props The properties of the new Relationship.\r\n   * @throws [[IModelError]] if there is a problem creating the Relationship.\r\n   */\r\n  public createInstance(props: RelationshipProps): Relationship { return this._iModel.constructEntity<Relationship>(props); }\r\n\r\n  /** Check classFullName to ensure it is a link table relationship class. */\r\n  private checkRelationshipClass(classFullName: string) {\r\n    if (!this._iModel[_nativeDb].isLinkTableRelationship(classFullName.replace(\".\", \":\"))) {\r\n      throw new IModelError(DbResult.BE_SQLITE_ERROR, `Class '${classFullName}' must be a relationship class and it should be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.`);\r\n    }\r\n  }\r\n\r\n  /** Insert a new relationship instance into the iModel. The relationship provided must be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.\r\n   * @param props The properties of the new relationship.\r\n   * @returns The Id of the newly inserted relationship.\r\n   * @note The id property of the props object is set as a side effect of this function.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.insertRelationship instead.\r\n   */\r\n  public insertInstance(props: RelationshipProps): Id64String {\r\n    return this._iModel[_implicitTxn].insertRelationship(props);\r\n  }\r\n\r\n  /** Update the properties of an existing relationship instance in the iModel.\r\n   * @param props the properties of the relationship instance to update. Any properties that are not present will be left unchanged.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.updateRelationship instead.\r\n   */\r\n  public updateInstance(props: RelationshipProps): void {\r\n    this._iModel[_implicitTxn].updateRelationship(props);\r\n  }\r\n\r\n  /** Delete an Relationship instance from this iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.deleteRelationship instead.\r\n   */\r\n  public deleteInstance(props: RelationshipProps): void {\r\n    this._iModel[_implicitTxn].deleteRelationship(props);\r\n  }\r\n\r\n  /** Delete multiple Relationship instances from this iModel.\r\n   * @param props The properties of the relationship instances to delete.\r\n   * @remarks This method handles bulk deletion of relationships and supports mixed collections containing instances from different relationship classes.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.deleteRelationships instead.\r\n   */\r\n  public deleteInstances(props: ReadonlyArray<RelationshipProps>): void {\r\n    this._iModel[_implicitTxn].deleteRelationships(props);\r\n  }\r\n\r\n  /** Get the props of a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\r\n   * @see tryGetInstanceProps\r\n   */\r\n  public getInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T {\r\n    const relationshipProps = this.tryGetInstanceProps<T>(relClassFullName, criteria);\r\n    if (undefined === relationshipProps) {\r\n      throw new IModelError(IModelStatus.NotFound, \"Relationship not found\");\r\n    }\r\n    return relationshipProps;\r\n  }\r\n\r\n  /** Get the props of a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @returns The RelationshipProps or `undefined` if the relationship is not found.\r\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\r\n   * @see getInstanceProps\r\n   */\r\n  public tryGetInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\r\n    let props: T | undefined;\r\n    if (typeof criteria === \"string\") {\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE ecinstanceid=?`, (stmt: ECSqlStatement) => {\r\n        stmt.bindId(1, criteria);\r\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() as T : undefined;\r\n      });\r\n    } else {\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE SourceECInstanceId=? AND TargetECInstanceId=?`, (stmt: ECSqlStatement) => {\r\n        stmt.bindId(1, criteria.sourceId);\r\n        stmt.bindId(2, criteria.targetId);\r\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() as T : undefined;\r\n      });\r\n    }\r\n    if (undefined !== props) {\r\n      props.classFullName = (props as any).className.replace(\".\", \":\");\r\n    }\r\n    return props;\r\n  }\r\n\r\n  /** Get a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\r\n   * @see tryGetInstance\r\n   */\r\n  public getInstance<T extends Relationship>(relClassSqlName: string, criteria: Id64String | SourceAndTarget): T {\r\n    return this._iModel.constructEntity<T>(this.getInstanceProps(relClassSqlName, criteria));\r\n  }\r\n\r\n  /** Get a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @returns The relationship or `undefined` if the relationship is not found.\r\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\r\n   * @see getInstance\r\n   */\r\n  public tryGetInstance<T extends Relationship>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\r\n    const relationshipProps = this.tryGetInstanceProps<RelationshipProps>(relClassFullName, criteria);\r\n    return undefined !== relationshipProps ? this._iModel.constructEntity<T>(relationshipProps) : undefined;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Relationship.js","sourceRoot":"","sources":["../../src/Relationship.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAc,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAsB,WAAW,EAAsC,MAAM,oBAAoB,CAAC;AAEzG,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAgB7D;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,MAAM;IAC/B,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IACzD,QAAQ,CAAa;IACrB,QAAQ,CAAa;IAErC,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAuB,CAAC;QAChD,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;OAEG;IACa,KAAK,CAAC,WAAW;QAC/B,IAAI,IAAI,CAAC,SAAS,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5E,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;QAC1G,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC;YAC9B,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAAC,GAAoB;QACjD,4DAA4D;QAC5D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,aAAa,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAEnF;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,CAAC,GAAoB;QACvD,4DAA4D;QAC5D,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAYlF,MAAM,CAAC,GAAa,IAAgB,OAAO,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAY5H,MAAM,CAAC,GAAa,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAY/F,MAAM,CAAC,GAAa,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAE/F,MAAM,CAAC,WAAW,CAAyB,MAAgB,EAAE,QAAsC,IAAO,OAAO,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CAC1L;AAED;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,YAAY;IAChD,MAAM,KAAc,SAAS,KAAa,OAAO,yBAAyB,CAAC,CAAC,CAAC;IACpF;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAoC,MAAgB,EAAE,QAAoB,EAAE,QAAoB;QAClH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAM,CAAC;IAC7G,CAAC;IAkBM,MAAM,CAAC,MAAM,CAAC,WAA+B,EAAE,QAAoB,EAAE,QAAoB;QAC9F,MAAM,GAAG,GAAG,WAAW,YAAY,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACrF,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACjE,OAAO,GAAG,CAAC,kBAAkB,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,+BAAgC,SAAQ,uBAAuB;IACnE,MAAM,KAAc,SAAS,KAAa,OAAO,iCAAiC,CAAC,CAAC,CAAC;CAC7F;AAED;;GAEG;AACH,MAAM,OAAO,mCAAoC,SAAQ,uBAAuB;IACvE,MAAM,KAAc,SAAS,KAAa,OAAO,qCAAqC,CAAC,CAAC,CAAC;CACjG;AAED;;;;GAIG;AACH,MAAM,OAAO,qCAAsC,SAAQ,uBAAuB;IACzE,MAAM,KAAc,SAAS,KAAa,OAAO,uCAAuC,CAAC,CAAC,CAAC;CACnG;AAED;;;GAGG;AACH,MAAM,OAAO,yCAA0C,SAAQ,qCAAqC;IAC3F,MAAM,KAAc,SAAS,KAAa,OAAO,2CAA2C,CAAC,CAAC,CAAC;CACvG;AASD;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,uBAAuB;IACxD,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IAC1E,cAAc,CAAS;IAE9B,YAAY,KAAgC,EAAE,MAAgB;QAC5D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;IAC7C,CAAC;IAEM,MAAM,CAAU,MAAM,CAAoC,MAAgB,EAAE,QAAoB,EAAE,QAAoB,EAAE,iBAAyB,CAAC;QACvJ,MAAM,KAAK,GAA8B,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;QACnH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAM,CAAC;IACzD,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,gCAAiC,SAAQ,oBAAoB;IACjE,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAED;;;;GAIG;AACH,MAAM,OAAO,qBAAsB,SAAQ,oBAAoB;IACtD,MAAM,KAAc,SAAS,KAAa,OAAO,uBAAuB,CAAC,CAAC,CAAC;CACnF;AAED;;;GAGG;AACH,MAAM,OAAO,gCAAiC,SAAQ,oBAAoB;IACjE,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAUD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuLG;AACH,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IAC7C,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IACjF;;;;OAIG;IACI,MAAM,CAAS;IACtB,uHAAuH;IAChH,QAAQ,CAAS;IAExB,YAAsB,KAAgC,EAAE,MAAgB;QACtE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,MAAM,CAAiC,MAAgB,EAAE,QAAoB,EAAE,QAAoB,EAAE,WAAmB,CAAC;QACrI,MAAM,KAAK,GAA8B,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;QACxH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAM,CAAC;IACzD,CAAC;IAEe,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAA+B,CAAC;QAC1D,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,2BAA4B,SAAQ,YAAY;IACpD,MAAM,KAAc,SAAS,KAAa,OAAO,6BAA6B,CAAC,CAAC,CAAC;IACrE,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,aAAa;IAChB,OAAO,CAAW;IAE1B,gBAAgB;IAChB,YAAmB,MAAgB,IAAI,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IAE/D;;;OAGG;IACI,cAAc,CAAC,KAAwB,IAAkB,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAe,KAAK,CAAC,CAAC,CAAC,CAAC;IAE3H,2EAA2E;IACnE,sBAAsB,CAAC,aAAqB;QAClD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;YACtF,MAAM,IAAI,WAAW,CAAC,QAAQ,CAAC,eAAe,EAAE,UAAU,aAAa,8HAA8H,CAAC,CAAC;QACzM,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,KAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,KAAuC;QAC5D,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAA8B,gBAAwB,EAAE,QAAsC;QACnH,MAAM,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAI,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAClF,IAAI,SAAS,KAAK,iBAAiB,EAAE,CAAC;YACpC,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CAA8B,gBAAwB,EAAE,QAAsC;QACtH,IAAI,KAAoB,CAAC;QACzB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,4DAA4D;YAC5D,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,iBAAiB,gBAAgB,uBAAuB,EAAE,CAAC,IAAoB,EAAE,EAAE;gBAC5H,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;gBACzB,OAAO,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YACjF,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,4DAA4D;YAC5D,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,iBAAiB,gBAAgB,sDAAsD,EAAE,CAAC,IAAoB,EAAE,EAAE;gBAC3J,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAClC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAClC,OAAO,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YACjF,CAAC,CAAC,CAAC;QACL,CAAC;QACD,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;YACxB,KAAK,CAAC,aAAa,GAAI,KAAa,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAyB,eAAuB,EAAE,QAAsC;QACxG,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAI,IAAI,CAAC,gBAAgB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAyB,gBAAwB,EAAE,QAAsC;QAC5G,MAAM,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAoB,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAClG,OAAO,SAAS,KAAK,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1G,CAAC;CACF","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 Relationships\r\n */\r\n\r\nimport { DbResult, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { EntityReferenceSet, IModelError, RelationshipProps, SourceAndTarget } from \"@itwin/core-common\";\r\nimport { ECSqlStatement } from \"./ECSqlStatement\";\r\nimport { Entity } from \"./Entity\";\r\nimport { EditTxn } from \"./EditTxn\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { _implicitTxn, _nativeDb } from \"./internal/Symbols\";\r\nimport { RelationshipClass } from \"@itwin/ecschema-metadata\";\r\n\r\nexport type { SourceAndTarget, RelationshipProps } from \"@itwin/core-common\"; // for backwards compatibility\r\n\r\n/** Argument for relationship dependency callbacks.\r\n * @beta\r\n */\r\nexport interface OnDependencyArg {\r\n  /** The iModel for the relationship affected by this method. */\r\n  iModel: IModelDb;\r\n  /** The ElementDrivesElement relationship instance affected by this method. */\r\n  props: RelationshipProps;\r\n  /** The transaction for indirect processing. */\r\n  indirectEditTxn: EditTxn;\r\n}\r\n\r\n/** Base class for all link table ECRelationships\r\n * @public\r\n */\r\nexport class Relationship extends Entity {\r\n  public static override get className(): string { return \"Relationship\"; }\r\n  public readonly sourceId: Id64String;\r\n  public readonly targetId: Id64String;\r\n\r\n  protected constructor(props: RelationshipProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.sourceId = Id64.fromJSON(props.sourceId);\r\n    this.targetId = Id64.fromJSON(props.targetId);\r\n  }\r\n\r\n  public override toJSON(): RelationshipProps {\r\n    const val = super.toJSON() as RelationshipProps;\r\n    val.sourceId = this.sourceId;\r\n    val.targetId = this.targetId;\r\n    return val;\r\n  }\r\n\r\n  /** Query metadata for this relationship class from the iModel's schema. Returns cached metadata if available.\r\n   * @deprecated in 5.10.0 - will not be removed until after 2027-06-03. Obtain a `SchemaView` via `iModel.getSchemaView()` and call `view.findClass(relationship.classFullName)` to retrieve a `SchemaView.Class`. The returned type differs from `RelationshipClass` and offers a synchronous, snapshot-style API.\r\n   */\r\n  public override async getMetaData(): Promise<RelationshipClass> {\r\n    if (this._metadata && RelationshipClass.isRelationshipClass(this._metadata)) {\r\n      return this._metadata;\r\n    }\r\n\r\n    const relationship = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, RelationshipClass);\r\n    if (relationship !== undefined) {\r\n      this._metadata = relationship;\r\n      return this._metadata;\r\n    } else {\r\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when its input has changed or is the output of some upstream relationship whose input has changed.\r\n   * This callback is invoked after the input element has been processed by upstream relationships.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.\r\n   * @beta\r\n   */\r\n  public static onRootChangedArg(arg: OnDependencyArg): void {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.onRootChanged(arg.props, arg.iModel);\r\n  }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when its input has changed or is the output of some upstream relationship whose input has changed.\r\n   * This callback is invoked after the input element has been processed by upstream relationships.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.\r\n   * @param _props The ElementDrivesElement relationship instance.\r\n   * @param _iModel The iModel\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use onRootChangedArg instead.\r\n   */\r\n  public static onRootChanged(_props: RelationshipProps, _iModel: IModelDb): void { }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action.\r\n   * @beta\r\n   */\r\n  public static onDeletedDependencyArg(arg: OnDependencyArg): void {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.onDeletedDependency(arg.props, arg.iModel);\r\n  }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action.\r\n   * @param _props The deleted ElementDrivesElement relationship instance.\r\n   * @param _iModel The iModel\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use onDeletedDependencyArg instead.\r\n   */\r\n  public static onDeletedDependency(_props: RelationshipProps, _iModel: IModelDb): void { }\r\n\r\n  /**\r\n   * Insert this Relationship into the iModel using the supplied EditTxn.\r\n   * @beta\r\n   */\r\n  public insert(txn: EditTxn): Id64String;\r\n  /**\r\n   * Insert this Relationship into the iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use Relationship.insert(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public insert(): Id64String;\r\n  public insert(txn?: EditTxn): Id64String { return this.id = (txn ?? this.iModel[_implicitTxn]).insertRelationship(this.toJSON()); }\r\n\r\n  /**\r\n   * Update this Relationship in the iModel using the supplied EditTxn.\r\n   * @beta\r\n   */\r\n  public update(txn: EditTxn): void;\r\n  /**\r\n   * Update this Relationship in the iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use Relationship.update(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public update(): void;\r\n  public update(txn?: EditTxn) { (txn ?? this.iModel[_implicitTxn]).updateRelationship(this.toJSON()); }\r\n\r\n  /**\r\n   * Delete this Relationship from the iModel using the supplied EditTxn.\r\n   * @beta\r\n   */\r\n  public delete(txn: EditTxn): void;\r\n  /**\r\n   * Delete this Relationship from the iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use Relationship.delete(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public delete(): void;\r\n  public delete(txn?: EditTxn) { (txn ?? this.iModel[_implicitTxn]).deleteRelationship(this.toJSON()); }\r\n\r\n  public static getInstance<T extends Relationship>(iModel: IModelDb, criteria: Id64String | SourceAndTarget): T { return iModel.relationships.getInstance(this.classFullName, criteria); }\r\n}\r\n\r\n/** A Relationship where one Element refers to another Element\r\n * @public\r\n */\r\nexport class ElementRefersToElements extends Relationship {\r\n  public static override get className(): string { return \"ElementRefersToElements\"; }\r\n  /** Create an instance of the Relationship.\r\n   * @param iModel The iModel that will contain the relationship\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element\r\n   * @param targetId The targetId of the relationship, that is, the driven element\r\n   * @return an instance of the specified class.\r\n   */\r\n  public static create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): T {\r\n    return iModel.relationships.createInstance({ sourceId, targetId, classFullName: this.classFullName }) as T;\r\n  }\r\n\r\n  /** Insert a new instance of the Relationship using an explicit transaction.\r\n   * @param txn The EditTxn used to perform the insert.\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element\r\n   * @param targetId The targetId of the relationship, that is, the driven element\r\n   * @return The Id of the inserted Relationship.\r\n   * @beta\r\n   */\r\n  public static insert(txn: EditTxn, sourceId: Id64String, targetId: Id64String): Id64String;\r\n  /** Insert a new instance of the Relationship.\r\n   * @param iModel The iModel that will contain the relationship.\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element.\r\n   * @param targetId The targetId of the relationship, that is, the driven element.\r\n   * @return The Id of the inserted Relationship.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use ElementRefersToElements.insert(txn, ...) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public static insert(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): Id64String;\r\n  public static insert(txnOrIModel: EditTxn | IModelDb, sourceId: Id64String, targetId: Id64String): Id64String {\r\n    const txn = txnOrIModel instanceof EditTxn ? txnOrIModel : txnOrIModel[_implicitTxn];\r\n    const relationship = this.create(txn.iModel, sourceId, targetId);\r\n    return txn.insertRelationship(relationship.toJSON());\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addElement(this.targetId);\r\n  }\r\n}\r\n\r\n/** Relates a [[DrawingGraphic]] to the [[Element]] that it represents\r\n * @public\r\n */\r\nexport class DrawingGraphicRepresentsElement extends ElementRefersToElements {\r\n  public static override get className(): string { return \"DrawingGraphicRepresentsElement\"; }\r\n}\r\n\r\n/** Relates a [[GraphicalElement3d]] to the [[Element]] that it represents\r\n * @public\r\n */\r\nexport class GraphicalElement3dRepresentsElement extends ElementRefersToElements {\r\n  public static override get className(): string { return \"GraphicalElement3dRepresentsElement\"; }\r\n}\r\n\r\n/** Relates a [[SynchronizationConfigLink]] to N [[ExternalSource]] instances.\r\n * Each relationship instance represents an external source processed by the synchronization configuration.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class SynchronizationConfigProcessesSources extends ElementRefersToElements {\r\n  public static override get className(): string { return \"SynchronizationConfigProcessesSources\"; }\r\n}\r\n\r\n/** Relates a [[SynchronizationConfigLink]] to *root* [[ExternalSource]] instances.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class SynchronizationConfigSpecifiesRootSources extends SynchronizationConfigProcessesSources {\r\n  public static override get className(): string { return \"SynchronizationConfigSpecifiesRootSources\"; }\r\n}\r\n\r\n/** Properties that are common to all types of link table ECRelationships\r\n * @public\r\n */\r\nexport interface ElementGroupsMembersProps extends RelationshipProps {\r\n  memberPriority: number;\r\n}\r\n\r\n/** An ElementRefersToElements relationship where one Element *groups* a set of other Elements.\r\n * @public\r\n */\r\nexport class ElementGroupsMembers extends ElementRefersToElements {\r\n  public static override get className(): string { return \"ElementGroupsMembers\"; }\r\n  public memberPriority: number;\r\n\r\n  constructor(props: ElementGroupsMembersProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.memberPriority = props.memberPriority;\r\n  }\r\n\r\n  public static override create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, memberPriority: number = 0): T {\r\n    const props: ElementGroupsMembersProps = { sourceId, targetId, memberPriority, classFullName: this.classFullName };\r\n    return iModel.relationships.createInstance(props) as T;\r\n  }\r\n}\r\n\r\n/** Relates a [[DefinitionGroup]] to its [[DefinitionElement]] members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.10\r\n * @public\r\n */\r\nexport class DefinitionGroupGroupsDefinitions extends ElementGroupsMembers {\r\n  public static override get className(): string { return \"DefinitionGroupGroupsDefinitions\"; }\r\n}\r\n\r\n/** Represents group membership where the group Element (and its properties) impart information about the member Elements above mere membership.\r\n * Implies that properties of the group should be considered as properties of its members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.11\r\n * @public\r\n */\r\nexport class GroupImpartsToMembers extends ElementGroupsMembers {\r\n  public static override get className(): string { return \"GroupImpartsToMembers\"; }\r\n}\r\n\r\n/** Relates an [[ExternalSourceGroup]] to its [[ExternalSource]] members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class ExternalSourceGroupGroupsSources extends ElementGroupsMembers {\r\n  public static override get className(): string { return \"ExternalSourceGroupGroupsSources\"; }\r\n}\r\n\r\n/** Properties that are common to all types of ElementDrivesElements\r\n * @beta\r\n */\r\nexport interface ElementDrivesElementProps extends RelationshipProps {\r\n  status: number;\r\n  priority: number;\r\n}\r\n\r\n/** A Relationship indicating that one Element *drives* another Element.\r\n * An ElementDrivesElement relationship defines a one-way \"driving\" relationship from the source to the target.\r\n * When the source of an ElementDrivesElement relationship changes, the ElementDrivesElement itself can get a callback, and both the source and target elements can get callbacks.\r\n * By inserting ElementDrivesElement relationships, an app can create and store an acyclic directed graph of dependencies between elements.\r\n *\r\n * # Defining dependencies\r\n * Create an ElementDrivesElement relationship to specify that the source element drives the target element.\r\n * For example, to specify that element e1 drives element e2, create a relationship between them like this:\r\n * ```ts\r\n *  const ede = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  ede.insert();\r\n * ```\r\n * This creates a persistent relationship. The fact that e1 drives e2 is persisted in the iModel.\r\n *\r\n * # Defining dependency graphs\r\n * When you create multiple ElementDrivesElement relationships, you create a network of dependencies. The target of one may be the source of another.\r\n * A change in the content of an DgnElement can therefore trigger changes to many downstream elements.\r\n *\r\n * For example, to make element e1 drive element e2 and e2 drive another element, e3, create two relationships like this:\r\n * ```ts\r\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\r\n *  ede12.insert();\r\n *  ede23.insert();\r\n * ```\r\n * Those two relationships create this graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n * Where the \"-->\" is meant to represent a driving relationship.\r\n *\r\n * The order in which you create the relationships does not matter.\r\n * The graph indicates that e3 depends on e2 and e2 depends on e1.\r\n *\r\n * An ElementDrivesElement relationship is between one source element and one target element.\r\n * Many ElementDrivesElement relationships can point to a given element, and many can point out of it.\r\n * Thus, you can define many:many relationships.\r\n * For example:\r\n * ```ts\r\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  const ede112 = ElementDrivesElement.create(iModel, e11id, e2id);\r\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\r\n *  const ede231 = ElementDrivesElement.create(iModel, e2id, e31id);\r\n *  ede12.insert();\r\n *  ede112.insert();\r\n *  ede23.insert();\r\n *  ede231.insert();\r\n * ```\r\n * Creates this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * e2 depends on both e1 and e11. e2 then drives e3 and e31.\r\n *\r\n * In an ElementDrivesElement dependency graph, the relationships are the \"edges\" and the Elements are the \"nodes\".\r\n * The following terms are used when referring to the elements (nodes) in a dependency graph:\r\n * * Inputs - The sources of all edges that point to the element. This includes all upstream elements that flow into the element.\r\n * * Outputs - The targets of all edges that point out of the element. This includes all downstream elements.\r\n *\r\n * # Subgraph Processing\r\n * When changes are made, only the part of the overall graph that is affected will be processed. So, for example,\r\n * suppose we have this graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n * If e1 changes, then the subgraph to be processed is equal to the full graph, as shown.\r\n *\r\n * If only e2 changes, then the subgraph to be processed is just:\r\n * ```\r\n *       e2 --> e3\r\n * ```\r\n * If only e3 changes, then the subgraph consists of e3 by itself.\r\n *\r\n * Returning to the second example above, suppose we have this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * If e1 is changed, the affected subgraph is:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * If e2 is changed, the affected subgraph is:\r\n * ```\r\n *           e3\r\n *         /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * # Callbacks\r\n * Once the affected subgraph to process is found, it propagates changes through it by making callbacks.\r\n * Classes for both elements (nodes) and ElementDrivesElements relationships (edges) can receive callbacks.\r\n *\r\n * ## ElementDrivesElement Callbacks\r\n * The following callbacks are invoked on ElementDrivesElement relationship classes (edges):\r\n * * onRootChanged\r\n * * onDeletedDependency\r\n *\r\n * Note that these are static methods. Their default implementations do nothing.\r\n * To receive and act on these callbacks, a domain should define a subclass of ElementDrivesElement and use that to create relationships.\r\n * The subclass should then implement the callbacks that it would like to act on.\r\n *\r\n * A ElementDrivesElement subclass callback is expected to make changes to the output element only!\r\n *\r\n * ## Element Callbacks\r\n * The following callbacks are invoked on Element classes (nodes):\r\n * * Element.onBeforeOutputsHandled\r\n * * Element.onAllInputsHandled\r\n *\r\n * ## Order\r\n * Callbacks are invoked by BriefcaseDb.saveChanges.\r\n * They are invoked in dependency (topological) order: driving elements first, then driven elements.\r\n *\r\n * Each callback is invoked only once. No matter how many times a given element was changed during the transaction,\r\n * a callback such as ElementDrivesElement.onRootChanged will be invoked only once.\r\n * In the same way, no matter how many of its inputs were changed, a callback such as Element.onAllInputsHandled will be\r\n * invoked only once.\r\n *\r\n * For example, suppose we have a graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n *\r\n * Suppose that e1 is directly modified. No callbacks are made at that time.\r\n * Later, when BriefcaseDb.saveChanges is called, the following callbacks are made, in order:\r\n * 1. Element.onBeforeOutputsHandled e1\r\n * 1. ElementDrivesElement.onRootChanged e1->e2\r\n * 1. Element.onAllInputsHandled e2\r\n * 1. ElementDrivesElement.onRootChanged e2->e3\r\n * 1. Element.onAllInputsHandled e3\r\n *\r\n * Suppose that e3 is modified directly and BriefcaseDb.saveChanges is called.\r\n * Since no input to a relationship was changed, the sub-graph will be empty, and no callbacks will be made.\r\n *\r\n * Returning to the second example above, suppose we have this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * If e1 is changed and BriefcaseDb.saveChanges is called, the subgraph is:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * The callbacks are:\r\n * 1. Element.onBeforeOutputsHandled e1\r\n * 1. ElementDrivesElement.onRootChanged e1->e2\r\n * 1. Element.onAllInputsHandled e2\r\n * 1. ElementDrivesElement.onRootChanged e2->e3\r\n * 1. Element.onAllInputsHandled e3\r\n * 1. ElementDrivesElement.onRootChanged e2->e31\r\n * 1. Element.onAllInputsHandled e31\r\n *\r\n * (The ElementDrivesElement.)\r\n *\r\n * #Errors\r\n * Circular dependencies are not permitted. If a cycle is detected, that is treated as a fatal error. All ElementDrivesElement relationships\r\n * involved in a cycle will have their status set to 1, indicating a failure.\r\n *\r\n * A callback may call txnManager.reportError to reject an invalid change. It can classify the error as fatal or just a warning.\r\n * A callback make set the status value of an ElementDrivesElement instance to 1 to indicate a processing failure in that edge.\r\n *\r\n * After BriefcaseDb.saveChanges is called, an app should check db.txns.validationErrors and db.txns.hasFatalError to find out if graph-evaluation failed.\r\n *\r\n * @beta\r\n */\r\nexport class ElementDrivesElement extends Relationship {\r\n  public static override get className(): string { return \"ElementDrivesElement\"; }\r\n  /** Relationship status\r\n   * * 0 indicates no errors. Set after a successful evaluation.\r\n   * * 1 indicates that this driving relationship could not be evaluated. The callback itself can set this to indicate that it failed to process the input changes. Also, it is set if the relationship is part of a circular dependency.\r\n   * * 0x80 The app or callback can set this to indicate to not propagate changes through this relationship.\r\n   */\r\n  public status: number;\r\n  /** Affects the order in which relationships are processed in the case where two relationships have the same output. */\r\n  public priority: number;\r\n\r\n  protected constructor(props: ElementDrivesElementProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.status = props.status;\r\n    this.priority = props.priority;\r\n  }\r\n\r\n  public static create<T extends ElementDrivesElement>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, priority: number = 0): T {\r\n    const props: ElementDrivesElementProps = { sourceId, targetId, priority, status: 0, classFullName: this.classFullName };\r\n    return iModel.relationships.createInstance(props) as T;\r\n  }\r\n\r\n  public override toJSON(): ElementDrivesElementProps {\r\n    const props = super.toJSON() as ElementDrivesElementProps;\r\n    props.status = this.status;\r\n    props.priority = this.priority;\r\n    return props;\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addElement(this.targetId);\r\n  }\r\n}\r\n\r\n/** The third (and last) possible link-table relationship base class in an iModel.\r\n * Has no external use, but is included for completeness of the [Entity.collectReferenceIds]($backend)\r\n * implementations for link-table relationships. Generating the types of the source and target automatically would require\r\n * coupling this package with ecschema-metadata which we do not want to do.\r\n * @internal\r\n */\r\nexport class ModelSelectorRefersToModels extends Relationship {\r\n  public static override get className(): string { return \"ModelSelectorRefersToModels\"; }\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addModel(this.targetId);\r\n  }\r\n}\r\n\r\n/** Manages [[Relationship]]s.\r\n * @public\r\n */\r\nexport class Relationships {\r\n  private _iModel: IModelDb;\r\n\r\n  /** @internal */\r\n  public constructor(iModel: IModelDb) { this._iModel = iModel; }\r\n\r\n  /** Create a new instance of a Relationship.\r\n   * @param props The properties of the new Relationship.\r\n   * @throws [[IModelError]] if there is a problem creating the Relationship.\r\n   */\r\n  public createInstance(props: RelationshipProps): Relationship { return this._iModel.constructEntity<Relationship>(props); }\r\n\r\n  /** Check classFullName to ensure it is a link table relationship class. */\r\n  private checkRelationshipClass(classFullName: string) {\r\n    if (!this._iModel[_nativeDb].isLinkTableRelationship(classFullName.replace(\".\", \":\"))) {\r\n      throw new IModelError(DbResult.BE_SQLITE_ERROR, `Class '${classFullName}' must be a relationship class and it should be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.`);\r\n    }\r\n  }\r\n\r\n  /** Insert a new relationship instance into the iModel. The relationship provided must be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.\r\n   * @param props The properties of the new relationship.\r\n   * @returns The Id of the newly inserted relationship.\r\n   * @note The id property of the props object is set as a side effect of this function.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.insertRelationship instead.\r\n   */\r\n  public insertInstance(props: RelationshipProps): Id64String {\r\n    return this._iModel[_implicitTxn].insertRelationship(props);\r\n  }\r\n\r\n  /** Update the properties of an existing relationship instance in the iModel.\r\n   * @param props the properties of the relationship instance to update. Any properties that are not present will be left unchanged.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.updateRelationship instead.\r\n   */\r\n  public updateInstance(props: RelationshipProps): void {\r\n    this._iModel[_implicitTxn].updateRelationship(props);\r\n  }\r\n\r\n  /** Delete an Relationship instance from this iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.deleteRelationship instead.\r\n   */\r\n  public deleteInstance(props: RelationshipProps): void {\r\n    this._iModel[_implicitTxn].deleteRelationship(props);\r\n  }\r\n\r\n  /** Delete multiple Relationship instances from this iModel.\r\n   * @param props The properties of the relationship instances to delete.\r\n   * @remarks This method handles bulk deletion of relationships and supports mixed collections containing instances from different relationship classes.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.deleteRelationships instead.\r\n   */\r\n  public deleteInstances(props: ReadonlyArray<RelationshipProps>): void {\r\n    this._iModel[_implicitTxn].deleteRelationships(props);\r\n  }\r\n\r\n  /** Get the props of a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\r\n   * @see tryGetInstanceProps\r\n   */\r\n  public getInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T {\r\n    const relationshipProps = this.tryGetInstanceProps<T>(relClassFullName, criteria);\r\n    if (undefined === relationshipProps) {\r\n      throw new IModelError(IModelStatus.NotFound, \"Relationship not found\");\r\n    }\r\n    return relationshipProps;\r\n  }\r\n\r\n  /** Get the props of a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @returns The RelationshipProps or `undefined` if the relationship is not found.\r\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\r\n   * @see getInstanceProps\r\n   */\r\n  public tryGetInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\r\n    let props: T | undefined;\r\n    if (typeof criteria === \"string\") {\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE ecinstanceid=?`, (stmt: ECSqlStatement) => {\r\n        stmt.bindId(1, criteria);\r\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() as T : undefined;\r\n      });\r\n    } else {\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE SourceECInstanceId=? AND TargetECInstanceId=?`, (stmt: ECSqlStatement) => {\r\n        stmt.bindId(1, criteria.sourceId);\r\n        stmt.bindId(2, criteria.targetId);\r\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() as T : undefined;\r\n      });\r\n    }\r\n    if (undefined !== props) {\r\n      props.classFullName = (props as any).className.replace(\".\", \":\");\r\n    }\r\n    return props;\r\n  }\r\n\r\n  /** Get a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\r\n   * @see tryGetInstance\r\n   */\r\n  public getInstance<T extends Relationship>(relClassSqlName: string, criteria: Id64String | SourceAndTarget): T {\r\n    return this._iModel.constructEntity<T>(this.getInstanceProps(relClassSqlName, criteria));\r\n  }\r\n\r\n  /** Get a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @returns The relationship or `undefined` if the relationship is not found.\r\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\r\n   * @see getInstance\r\n   */\r\n  public tryGetInstance<T extends Relationship>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\r\n    const relationshipProps = this.tryGetInstanceProps<RelationshipProps>(relClassFullName, criteria);\r\n    return undefined !== relationshipProps ? this._iModel.constructEntity<T>(relationshipProps) : undefined;\r\n  }\r\n}\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-backend",
-  "version": "5.11.0-dev.3",
+  "version": "5.11.0-dev.5",
   "description": "iTwin.js backend components",
   "main": "lib/cjs/core-backend.js",
   "module": "lib/esm/core-backend.js",
@@ -27,10 +27,10 @@
   },
   "peerDependencies": {
     "@opentelemetry/api": "^1.0.4",
-    "@itwin/core-common": "5.11.0-dev.3",
-    "@itwin/core-bentley": "5.11.0-dev.3",
-    "@itwin/core-geometry": "5.11.0-dev.3",
-    "@itwin/ecschema-metadata": "5.11.0-dev.3"
+    "@itwin/core-bentley": "5.11.0-dev.5",
+    "@itwin/core-common": "5.11.0-dev.5",
+    "@itwin/core-geometry": "5.11.0-dev.5",
+    "@itwin/ecschema-metadata": "5.11.0-dev.5"
   },
   "peerDependenciesMeta": {
     "@opentelemetry/api": {
@@ -77,13 +77,13 @@
     "marked": "^14.1.3",
     "sql-formatter": "^15.4.6",
     "webpack": "^5.97.1",
-    "@itwin/build-tools": "5.11.0-dev.3",
-    "@itwin/core-bentley": "5.11.0-dev.3",
-    "@itwin/core-common": "5.11.0-dev.3",
-    "@itwin/ecschema-locaters": "5.11.0-dev.3",
-    "@itwin/core-geometry": "5.11.0-dev.3",
-    "@itwin/ecsql-common": "5.11.0-dev.3",
-    "@itwin/ecschema-metadata": "5.11.0-dev.3",
+    "@itwin/core-common": "5.11.0-dev.5",
+    "@itwin/build-tools": "5.11.0-dev.5",
+    "@itwin/core-bentley": "5.11.0-dev.5",
+    "@itwin/ecschema-metadata": "5.11.0-dev.5",
+    "@itwin/core-geometry": "5.11.0-dev.5",
+    "@itwin/ecsql-common": "5.11.0-dev.5",
+    "@itwin/ecschema-locaters": "5.11.0-dev.5",
     "internal-tools": "3.0.0-dev.69"
   },
   "dependencies": {