@itwin/core-backend 5.10.0-dev.8 → 5.10.0

package/lib/cjs/Entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"Entity.js","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAuD;AACvD,oDAA6H;AAG7H,gEAA4G;AAC5G,gDAA+C;AAgC/C;;;;GAIG;AACH,MAAa,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,iCAAa,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,mBAAI,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,mBAAS,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,mBAAI,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;;;;;;;;;;;;;OAaG;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,+BAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,qCAAiB,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;;;;OAIG;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,2BAAO,CAAC,CAAC;QAC3F,IAAI,+BAAW,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,qCAAiB,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,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,2BAAO,CAAC,CAAC;QACzF,IAAI,+BAAW,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,qCAAiB,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,gCAAkB,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;;AAxRH,wBAyRC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Schema\n */\n\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { ElementLoadOptions, EntityProps, EntityReferenceSet, PropertyCallback, PropertyMetaData } from \"@itwin/core-common\";\nimport type { IModelDb } from \"./IModelDb\";\nimport { Schema } from \"./Schema\";\nimport { ECClass, EntityClass, Property, RelationshipClass, SchemaItemKey } from \"@itwin/ecschema-metadata\";\nimport { _nativeDb } from \"./internal/Symbols\";\n\n/** Represents a row returned by an ECSql query. The row is returned as a map of property names to values.\n * ECSqlRow has same schema as declared in ECSchema for the class and similar to if ECSQL SELECT * FROM <schema>:<class> were executed.\n * @beta */\nexport interface ECSqlRow {\n  [key: string]: any\n}\n\n/** Set of properties that are used to deserialize an [[EntityProps]] from an ECSqlRow.\n * @beta */\nexport interface DeserializeEntityArgs {\n  /** Row to deserialize */\n  row: ECSqlRow;\n  /** The IModel that contains this Entity */\n  iModel: IModelDb;\n  /** The options used when loading */\n  options?: {\n    /** Options used when loading an element */\n    element?: ElementLoadOptions;\n  }\n}\n\n/** A property of an [[Entity]] that needs to be custom handled during deserialization and serialization.\n * @beta */\nexport interface CustomHandledProperty {\n  /** The name of the property as it appears in the ECSqlRow */\n  readonly propertyName: string;\n  /** Where the property is defined */\n  readonly source: \"Class\" | \"Computed\";\n}\n\n/** Represents one of the fundamental building block in an [[IModelDb]]: as an [[Element]], [[Model]], or [[Relationship]].\n * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).\n * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].\n * @public @preview\n */\nexport class Entity {\n  /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types\n   * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].\n   */\n  public readonly isInstanceOfEntity = true as const;\n  /** The Schema that defines this class. */\n  public static schema: typeof Schema; // TODO: Schema key on the static level, but it requires a version which may differ between imodels\n\n  private get _ctor(): typeof Entity { return this.constructor as typeof Entity; }\n\n  /** The name of the BIS class associated with this class.\n   * @note Every subclass of Entity **MUST** override this method to identify its BIS class.\n   * Failure to do so will ordinarily result in an error when the class is registered, since there may only\n   * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)\n   */\n  public static get className(): string { return \"Entity\"; }\n\n  /** Serves as a unique identifier for this class. Typed variant of [[classFullName]].\n   * @public @preview\n   */\n  public static get schemaItemKey(): SchemaItemKey {\n    // We cannot cache this here because the className gets overridden in subclasses\n    return new SchemaItemKey(this.className, this.schema.schemaKey);\n  }\n\n  /** Cached Metadata for the ECClass */\n  protected _metadata?: EntityClass | RelationshipClass;\n\n  /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.\n   * This property makes such code slightly less tedious to read and write.\n   * @internal\n   */\n  public get asAny(): any { return this; }\n\n  /** The name of the BIS Schema that defines this class */\n  public get schemaName(): string { return this._ctor.schema.schemaName; }\n\n  /** The name of the BIS class associated with this class. */\n  public get className(): string { return this._ctor.className; }\n\n  /** The [[IModelDb]] that contains this Entity */\n  public iModel: IModelDb;\n\n  /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */\n  public id: Id64String;\n\n\n  protected constructor(props: EntityProps, iModel: IModelDb) {\n    this.iModel = iModel;\n    this.id = Id64.fromJSON(props.id);\n    // copy all auto-handled properties from input to the object being constructed\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    this.forEachProperty((propName: string, meta: PropertyMetaData) => (this as any)[propName] = meta.createProperty((props as any)[propName]), false);\n  }\n\n  /** Invoke the constructor of the specified `Entity` subclass.\n   * @internal\n   */\n  public static instantiate(subclass: typeof Entity, props: EntityProps, iModel: IModelDb): Entity {\n    return new subclass(props, iModel);\n  }\n\n  /** List of properties that are need to be custom handled during deserialization and serialization.\n   * These properties differ between the ECSql instance of an Entity and the Entity itself.\n   * @beta */\n  protected static readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"id\", source: \"Class\" },\n    { propertyName: \"className\", source: \"Class\" },\n    { propertyName: \"jsonProperties\", source: \"Class\" }\n  ];\n\n  /** Get the list of properties that are custom handled by this class and its superclasses.\n   * @internal */\n  private static getCustomHandledProperties(): readonly CustomHandledProperty[] {\n    if (this.name === \"Entity\") {\n      return this._customHandledProps;\n    }\n\n    const superClass = Object.getPrototypeOf(this) as typeof Entity;\n    return [\n      ...superClass.getCustomHandledProperties(),\n      ...this._customHandledProps,\n    ];\n  }\n\n  /** Converts an ECSqlRow of an Entity to an EntityProps. This is used to deserialize an Entity from the database.\n   * @beta */\n  public static deserialize(props: DeserializeEntityArgs): EntityProps {\n    const enProps: EntityProps = {\n      classFullName: props.row.classFullName,\n      id: props.row.id,\n    }\n\n    // Handles cases where id64 ints are stored in the jsonProperties and converts them to hex before parsing as a json object in js\n    if (props.row.jsonProperties) {\n      enProps.jsonProperties = JSON.parse(props.iModel[_nativeDb].patchJsonProperties(props.row.jsonProperties));\n    }\n    // Auto handles all properties that are not in the 'customHandledProperties' list\n    const customHandledProperties = this.getCustomHandledProperties();\n    Object.keys(props.row)\n      .filter((propertyName) => customHandledProperties.find((val) => val.propertyName === propertyName) === undefined)\n      .forEach((propertyName) => (enProps as ECSqlRow)[propertyName] = props.row[propertyName]\n      );\n    // Handles custom relClassNames to use '.' instead of ':'\n    Object.keys(enProps).forEach((propertyName) => {\n      if ((enProps as ECSqlRow)[propertyName].relClassName !== undefined && propertyName !== \"modeledElement\" && propertyName !== \"parentModel\") {\n        (enProps as ECSqlRow)[propertyName].relClassName = (enProps as ECSqlRow)[propertyName].relClassName.replace(':', '.');\n      }\n    });\n    return enProps;\n  }\n\n  /** Converts an EntityProps to an ECSqlRow. This is used to serialize an Entity to prepare to write it to the database.\n   * @beta */\n  public static serialize(props: EntityProps, _iModel: IModelDb): ECSqlRow {\n    const inst: ECSqlRow = {\n      classFullName: props.classFullName,\n      id: props.id,\n    }\n\n    const customHandledProperties = this.getCustomHandledProperties();\n    Object.keys(props)\n      .filter((propertyName) => customHandledProperties.find((val) => val.propertyName === propertyName) === undefined)\n      .forEach((propertyName) => inst[propertyName] = (props as ECSqlRow)[propertyName]\n      );\n    return inst;\n  }\n\n  /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -\n   * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).\n   */\n  public toJSON(): EntityProps {\n    const val: any = {};\n    val.classFullName = this.classFullName;\n    if (Id64.isValid(this.id))\n      val.id = this.id;\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    this.forEachProperty((propName: string) => val[propName] = (this as any)[propName], false);\n    return val;\n  }\n\n  /** Call a function for each property of this Entity.\n   * @param func The callback to be invoked on each property\n   * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\n   * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\n   * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `forEach` to get the metadata and iterate over the properties instead.\n   *\n   * @example\n   * ```typescript\n   * // Deprecated method\n   * entity.forEachProperty((name, propMetaData) => {\n   *   console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);\n   * });\n   *\n   * // New method\n   * entity.forEach((name, property) => {\n   *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);\n   * });\n   * ```\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public forEachProperty(func: PropertyCallback, includeCustom: boolean = true) {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    this.iModel.forEachMetaData(this.classFullName, true, func, includeCustom);\n  }\n\n  /**\n   * Call a function for each property of this Entity.\n   * @param func The callback to be invoked on each property.\n   * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\n   * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\n   * @throws Error if metadata for the class cannot be retrieved.\n   *\n   * @example\n   * ```typescript\n   * entity.forEach((name, property) => {\n   *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);\n   * });\n   * ```\n   */\n  public forEach(func: PropertyHandler, includeCustom: boolean = true) {\n    const item = this._metadata ?? this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey);\n\n    if (EntityClass.isEntityClass(item) || RelationshipClass.isRelationshipClass(item)) {\n      for (const property of item.getPropertiesSync()) {\n        if (includeCustom || !property.customAttributes?.has(`BisCore.CustomHandledProperty`))\n          func(property.name, property);\n      }\n    } else {\n      throw new Error(`Cannot get metadata for ${this.classFullName}. Class is not an EntityClass or RelationshipClass.`);\n    }\n  }\n\n  /** Get the full BIS class name of this Entity in the form \"schema:class\" */\n  public static get classFullName(): string { return `${this.schema.schemaName}:${this.className}`; }\n\n  /** Get the full BIS class name of this Entity in the form \"schema:class\". */\n  public get classFullName(): string { return this._ctor.classFullName; }\n  /**\n   * Get the item key used by the ecschema-metadata package to identify this entity class\n   * @public @preview\n   */\n  public get schemaItemKey(): SchemaItemKey { return this._ctor.schemaItemKey; }\n\n  /** Query metadata for this entity class from the iModel's schema. Returns cached metadata if available.\n   * @throws [[IModelError]] if there is a problem querying the schema\n   * @returns The metadata for the current entity\n   * @public @preview\n   */\n  public async getMetaData(): Promise<EntityClass | RelationshipClass> {\n    if (this._metadata) {\n      return this._metadata;\n    }\n\n    const ecClass = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, ECClass);\n    if (EntityClass.isEntityClass(ecClass) || RelationshipClass.isRelationshipClass(ecClass)) {\n      this._metadata = ecClass;\n      return this._metadata;\n    } else {\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\n    }\n  }\n\n  /** @internal */\n  public getMetaDataSync(): EntityClass | RelationshipClass {\n    if (this._metadata) {\n      return this._metadata;\n    }\n\n    const ecClass = this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey, ECClass);\n    if (EntityClass.isEntityClass(ecClass) || RelationshipClass.isRelationshipClass(ecClass)) {\n      this._metadata = ecClass;\n      return this._metadata;\n    } else {\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\n    }\n  }\n  \n  /** @internal */\n  public static get protectedOperations(): string[] { return []; }\n\n  /** return whether this Entity class is a subclass of another Entity class\n   * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's\n   * inheritance, you can use [ECClass.is]($ecschema-metadata)\n   * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of\n   * typescript's restriction on the `this` type in static methods\n   */\n  public static is(otherClass: typeof Entity): boolean {\n    // inline of @itwin/core-bentley's isSubclassOf due to protected constructor.\n    return this === otherClass || this.prototype instanceof otherClass;\n  }\n\n  /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation\n   * ClassRegistry overrides this when generating a class\n   * @internal\n   */\n  public static get isGeneratedClass() { return false; }\n\n  /** Get the set of this entity's *entity references*, [EntityReferenceSet]($backend). An *entity reference* is any id\n   * stored on the entity, in its EC properties or json fields.\n   * This is important for cloning operations but can be useful in other situations as well.\n   * @see this.collectReferenceIds\n   * @beta\n   */\n  public getReferenceIds(): EntityReferenceSet {\n    const referenceIds = new EntityReferenceSet();\n    this.collectReferenceIds(referenceIds);\n    return referenceIds;\n  }\n\n  /** Collect the Ids of this entity's *references* at this level of the class hierarchy.\n   * A *reference* is any entity referenced by this entity's EC Data, including json fields.\n   * This is important for cloning operations but can be useful in other situations as well.\n   * @param _referenceIds The Id64Set to populate with reference Ids.\n   * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.\n   * @see getReferenceIds\n   * @beta\n   */\n  protected collectReferenceIds(_referenceIds: EntityReferenceSet): void {\n    return; // no references by default\n  }\n}\n\n/** A callback function to process properties of an Entity\n * @public @preview\n */\nexport type PropertyHandler = (name: string, property: Property) => void;\n\n/** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.\n * @public @preview\n */\nexport type EntityClassType<T> = Function & { prototype: T }; // eslint-disable-line @typescript-eslint/no-unsafe-function-type\n"]}
+{"version":3,"file":"Entity.js","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAuD;AACvD,oDAA6H;AAG7H,gEAA4G;AAC5G,gDAA+C;AAgC/C;;;;GAIG;AACH,MAAa,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,iCAAa,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,mBAAI,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,mBAAS,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,mBAAI,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,+BAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,qCAAiB,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,2BAAO,CAAC,CAAC;QAC3F,IAAI,+BAAW,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,qCAAiB,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,2BAAO,CAAC,CAAC;QACzF,IAAI,+BAAW,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,qCAAiB,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,gCAAkB,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;;AAhSH,wBAiSC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Schema\n */\n\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { ElementLoadOptions, EntityProps, EntityReferenceSet, PropertyCallback, PropertyMetaData } from \"@itwin/core-common\";\nimport type { IModelDb } from \"./IModelDb\";\nimport { Schema } from \"./Schema\";\nimport { ECClass, EntityClass, Property, RelationshipClass, SchemaItemKey } from \"@itwin/ecschema-metadata\";\nimport { _nativeDb } from \"./internal/Symbols\";\n\n/** Represents a row returned by an ECSql query. The row is returned as a map of property names to values.\n * ECSqlRow has same schema as declared in ECSchema for the class and similar to if ECSQL SELECT * FROM <schema>:<class> were executed.\n * @beta */\nexport interface ECSqlRow {\n  [key: string]: any\n}\n\n/** Set of properties that are used to deserialize an [[EntityProps]] from an ECSqlRow.\n * @beta */\nexport interface DeserializeEntityArgs {\n  /** Row to deserialize */\n  row: ECSqlRow;\n  /** The IModel that contains this Entity */\n  iModel: IModelDb;\n  /** The options used when loading */\n  options?: {\n    /** Options used when loading an element */\n    element?: ElementLoadOptions;\n  }\n}\n\n/** A property of an [[Entity]] that needs to be custom handled during deserialization and serialization.\n * @beta */\nexport interface CustomHandledProperty {\n  /** The name of the property as it appears in the ECSqlRow */\n  readonly propertyName: string;\n  /** Where the property is defined */\n  readonly source: \"Class\" | \"Computed\";\n}\n\n/** Represents one of the fundamental building block in an [[IModelDb]]: as an [[Element]], [[Model]], or [[Relationship]].\n * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).\n * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].\n * @public @preview\n */\nexport class Entity {\n  /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types\n   * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].\n   */\n  public readonly isInstanceOfEntity = true as const;\n  /** The Schema that defines this class. */\n  public static schema: typeof Schema; // TODO: Schema key on the static level, but it requires a version which may differ between imodels\n\n  private get _ctor(): typeof Entity { return this.constructor as typeof Entity; }\n\n  /** The name of the BIS class associated with this class.\n   * @note Every subclass of Entity **MUST** override this method to identify its BIS class.\n   * Failure to do so will ordinarily result in an error when the class is registered, since there may only\n   * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)\n   */\n  public static get className(): string { return \"Entity\"; }\n\n  /** Serves as a unique identifier for this class. Typed variant of [[classFullName]].\n   * @public @preview\n   */\n  public static get schemaItemKey(): SchemaItemKey {\n    // We cannot cache this here because the className gets overridden in subclasses\n    return new SchemaItemKey(this.className, this.schema.schemaKey);\n  }\n\n  /** Cached Metadata for the ECClass */\n  protected _metadata?: EntityClass | RelationshipClass;\n\n  /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.\n   * This property makes such code slightly less tedious to read and write.\n   * @internal\n   */\n  public get asAny(): any { return this; }\n\n  /** The name of the BIS Schema that defines this class */\n  public get schemaName(): string { return this._ctor.schema.schemaName; }\n\n  /** The name of the BIS class associated with this class. */\n  public get className(): string { return this._ctor.className; }\n\n  /** The [[IModelDb]] that contains this Entity */\n  public iModel: IModelDb;\n\n  /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */\n  public id: Id64String;\n\n\n  protected constructor(props: EntityProps, iModel: IModelDb) {\n    this.iModel = iModel;\n    this.id = Id64.fromJSON(props.id);\n    // copy all auto-handled properties from input to the object being constructed\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    this.forEachProperty((propName: string, meta: PropertyMetaData) => (this as any)[propName] = meta.createProperty((props as any)[propName]), false);\n  }\n\n  /** Invoke the constructor of the specified `Entity` subclass.\n   * @internal\n   */\n  public static instantiate(subclass: typeof Entity, props: EntityProps, iModel: IModelDb): Entity {\n    return new subclass(props, iModel);\n  }\n\n  /** List of properties that are need to be custom handled during deserialization and serialization.\n   * These properties differ between the ECSql instance of an Entity and the Entity itself.\n   * @beta */\n  protected static readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"id\", source: \"Class\" },\n    { propertyName: \"className\", source: \"Class\" },\n    { propertyName: \"jsonProperties\", source: \"Class\" }\n  ];\n\n  /** Get the list of properties that are custom handled by this class and its superclasses.\n   * @internal */\n  private static getCustomHandledProperties(): readonly CustomHandledProperty[] {\n    if (this.name === \"Entity\") {\n      return this._customHandledProps;\n    }\n\n    const superClass = Object.getPrototypeOf(this) as typeof Entity;\n    return [\n      ...superClass.getCustomHandledProperties(),\n      ...this._customHandledProps,\n    ];\n  }\n\n  /** Converts an ECSqlRow of an Entity to an EntityProps. This is used to deserialize an Entity from the database.\n   * @beta */\n  public static deserialize(props: DeserializeEntityArgs): EntityProps {\n    const enProps: EntityProps = {\n      classFullName: props.row.classFullName,\n      id: props.row.id,\n    }\n\n    // Handles cases where id64 ints are stored in the jsonProperties and converts them to hex before parsing as a json object in js\n    if (props.row.jsonProperties) {\n      enProps.jsonProperties = JSON.parse(props.iModel[_nativeDb].patchJsonProperties(props.row.jsonProperties));\n    }\n    // Auto handles all properties that are not in the 'customHandledProperties' list\n    const customHandledProperties = this.getCustomHandledProperties();\n    Object.keys(props.row)\n      .filter((propertyName) => customHandledProperties.find((val) => val.propertyName === propertyName) === undefined)\n      .forEach((propertyName) => (enProps as ECSqlRow)[propertyName] = props.row[propertyName]\n      );\n    // Handles custom relClassNames to use '.' instead of ':'\n    Object.keys(enProps).forEach((propertyName) => {\n      if ((enProps as ECSqlRow)[propertyName].relClassName !== undefined && propertyName !== \"modeledElement\" && propertyName !== \"parentModel\") {\n        (enProps as ECSqlRow)[propertyName].relClassName = (enProps as ECSqlRow)[propertyName].relClassName.replace(':', '.');\n      }\n    });\n    return enProps;\n  }\n\n  /** Converts an EntityProps to an ECSqlRow. This is used to serialize an Entity to prepare to write it to the database.\n   * @beta */\n  public static serialize(props: EntityProps, _iModel: IModelDb): ECSqlRow {\n    const inst: ECSqlRow = {\n      classFullName: props.classFullName,\n      id: props.id,\n    }\n\n    const customHandledProperties = this.getCustomHandledProperties();\n    Object.keys(props)\n      .filter((propertyName) => customHandledProperties.find((val) => val.propertyName === propertyName) === undefined)\n      .forEach((propertyName) => inst[propertyName] = (props as ECSqlRow)[propertyName]\n      );\n    return inst;\n  }\n\n  /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -\n   * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).\n   */\n  public toJSON(): EntityProps {\n    const val: any = {};\n    val.classFullName = this.classFullName;\n    if (Id64.isValid(this.id))\n      val.id = this.id;\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    this.forEachProperty((propName: string) => val[propName] = (this as any)[propName], false);\n    return val;\n  }\n\n  /** Call a function for each property of this Entity.\n   * @param func The callback to be invoked on each property\n   * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\n   * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\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.)\n   *\n   * @example\n   * ```typescript\n   * // Deprecated method\n   * entity.forEachProperty((name, propMetaData) => {\n   *   console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);\n   * });\n   *\n   * // New method\n   * entity.forEach((name, property) => {\n   *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);\n   * });\n   * ```\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public forEachProperty(func: PropertyCallback, includeCustom: boolean = true) {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    this.iModel.forEachMetaData(this.classFullName, true, func, includeCustom);\n  }\n\n  /**\n   * Call a function for each property of this Entity.\n   * @param func The callback to be invoked on each property.\n   * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\n   * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\n   * @throws Error if metadata for the class cannot be retrieved.\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.\n   *\n   * @example\n   * ```typescript\n   * const view = await entity.iModel.getSchemaView();\n   * const cls = view.findClass(entity.classFullName);\n   * if (cls) {\n   *   for (const property of cls.getProperties()) {\n   *     console.log(`Property name: ${property.name}, Kind: ${property.kind}`);\n   *   }\n   * }\n   * ```\n   */\n  public forEach(func: PropertyHandler, includeCustom: boolean = true) {\n    const item = this._metadata ?? this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey);\n\n    if (EntityClass.isEntityClass(item) || RelationshipClass.isRelationshipClass(item)) {\n      for (const property of item.getPropertiesSync()) {\n        if (includeCustom || !property.customAttributes?.has(`BisCore.CustomHandledProperty`))\n          func(property.name, property);\n      }\n    } else {\n      throw new Error(`Cannot get metadata for ${this.classFullName}. Class is not an EntityClass or RelationshipClass.`);\n    }\n  }\n\n  /** Get the full BIS class name of this Entity in the form \"schema:class\" */\n  public static get classFullName(): string { return `${this.schema.schemaName}:${this.className}`; }\n\n  /** Get the full BIS class name of this Entity in the form \"schema:class\". */\n  public get classFullName(): string { return this._ctor.classFullName; }\n  /**\n   * Get the item key used by the ecschema-metadata package to identify this entity class\n   * @public @preview\n   */\n  public get schemaItemKey(): SchemaItemKey { return this._ctor.schemaItemKey; }\n\n  /** Query metadata for this entity class from the iModel's schema. Returns cached metadata if available.\n   * @throws [[IModelError]] if there is a problem querying the schema\n   * @returns The metadata for the current entity\n   * @public @preview\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.\n   */\n  public async getMetaData(): Promise<EntityClass | RelationshipClass> {\n    if (this._metadata) {\n      return this._metadata;\n    }\n\n    const ecClass = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, ECClass);\n    if (EntityClass.isEntityClass(ecClass) || RelationshipClass.isRelationshipClass(ecClass)) {\n      this._metadata = ecClass;\n      return this._metadata;\n    } else {\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\n    }\n  }\n\n  /** @internal\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.\n   */\n  public getMetaDataSync(): EntityClass | RelationshipClass {\n    if (this._metadata) {\n      return this._metadata;\n    }\n\n    const ecClass = this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey, ECClass);\n    if (EntityClass.isEntityClass(ecClass) || RelationshipClass.isRelationshipClass(ecClass)) {\n      this._metadata = ecClass;\n      return this._metadata;\n    } else {\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\n    }\n  }\n  \n  /** @internal */\n  public static get protectedOperations(): string[] { return []; }\n\n  /** return whether this Entity class is a subclass of another Entity class\n   * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's\n   * inheritance, you can use [ECClass.is]($ecschema-metadata)\n   * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of\n   * typescript's restriction on the `this` type in static methods\n   */\n  public static is(otherClass: typeof Entity): boolean {\n    // inline of @itwin/core-bentley's isSubclassOf due to protected constructor.\n    return this === otherClass || this.prototype instanceof otherClass;\n  }\n\n  /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation\n   * ClassRegistry overrides this when generating a class\n   * @internal\n   */\n  public static get isGeneratedClass() { return false; }\n\n  /** Get the set of this entity's *entity references*, [EntityReferenceSet]($backend). An *entity reference* is any id\n   * stored on the entity, in its EC properties or json fields.\n   * This is important for cloning operations but can be useful in other situations as well.\n   * @see this.collectReferenceIds\n   * @beta\n   */\n  public getReferenceIds(): EntityReferenceSet {\n    const referenceIds = new EntityReferenceSet();\n    this.collectReferenceIds(referenceIds);\n    return referenceIds;\n  }\n\n  /** Collect the Ids of this entity's *references* at this level of the class hierarchy.\n   * A *reference* is any entity referenced by this entity's EC Data, including json fields.\n   * This is important for cloning operations but can be useful in other situations as well.\n   * @param _referenceIds The Id64Set to populate with reference Ids.\n   * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.\n   * @see getReferenceIds\n   * @beta\n   */\n  protected collectReferenceIds(_referenceIds: EntityReferenceSet): void {\n    return; // no references by default\n  }\n}\n\n/** A callback function to process properties of an Entity\n * @public @preview\n */\nexport type PropertyHandler = (name: string, property: Property) => void;\n\n/** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.\n * @public @preview\n */\nexport type EntityClassType<T> = Function & { prototype: T }; // eslint-disable-line @typescript-eslint/no-unsafe-function-type\n"]}

package/lib/cjs/ExternalSource.d.ts

@@ -27,7 +27,7 @@ export declare class ExternalSource extends InformationReferenceElement {
      * @param txn The active EditTxn.
      */
     static ensureCodeSpec(txn: EditTxn): Id64String;
-    /** @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use ExternalSource.ensureCodeSpec(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help. */
+    /** @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use ExternalSource.ensureCodeSpec(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help. */
     static ensureCodeSpec(iModelDb: IModelDb): Id64String;
     /** Create a Code for an ExternalSource element given a name that is meant to be unique within the scope of the iModel.
      * @param iModelDb  The IModelDb
@@ -64,7 +64,7 @@ export declare class ExternalSourceAttachment extends InformationReferenceElemen
      * @param txn The active EditTxn.
      */
     static ensureCodeSpec(txn: EditTxn): Id64String;
-    /** @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use ExternalSourceAttachment.ensureCodeSpec(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help. */
+    /** @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use ExternalSourceAttachment.ensureCodeSpec(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help. */
     static ensureCodeSpec(iModelDb: IModelDb): Id64String;
     /** Create a Code for an ExternalSourceAttachment element given a name that is meant to be unique within the scope of its parent [[ExternalSource]].
      * @param iModelDb  The IModelDb

package/lib/cjs/ExternalSource.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExternalSource.js","sourceRoot":"","sources":["../../src/ExternalSource.ts"],"names":[],"mappings":";AACA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAA+C;AAC/C,oDAG4B;AAC5B,uCAAiE;AACjE,uCAAoC;AAEpC,qEAAgH;AAChH,gDAAkD;AAElD;;;GAGG;AACH,MAAa,cAAe,SAAQ,qCAA2B;IAC7D,wDAAwD;IACjD,UAAU,CAAgC;IACjD,2EAA2E;IACpE,aAAa,CAAU;IAC9B,8EAA8E;IACvE,gBAAgB,CAAU;IACjC,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAE3E,YAAsB,KAA0B,EAAE,MAAgB;QAChE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,KAAK,CAAC,UAAU;YAClB,IAAI,CAAC,UAAU,GAAG,IAAI,qDAA4B,CAAC,4BAAc,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IACpG,CAAC;IAEe,MAAM;QACpB,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,sDAAsD;IAC/E,CAAC;IAOM,MAAM,CAAC,cAAc,CAAC,WAA+B;QAC1D,MAAM,GAAG,GAAG,WAAW,YAAY,iBAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,sBAAY,CAAC,CAAC;QACrF,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,cAAc,CAAC,CAAC;YAC5E,OAAO,QAAQ,CAAC,EAAE,CAAC;QACrB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,yBAAW,CAAC,cAAc,EAAE,2BAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrG,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,QAAkB,EAAE,SAAiB;QAC5D,MAAM,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,cAAc,CAAC,CAAC;QAC1E,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,oBAAM,CAAC,aAAa,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACxF,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,UAAU;YACjB,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAChD,CAAC;CACF;AAlDD,wCAkDC;AAED;;;GAGG;AACH,MAAa,wBAAyB,SAAQ,qCAA2B;IACvE,gFAAgF;IACzE,QAAQ,CAA0C;IACzD,wGAAwG;IACjG,IAAI,CAAgC;IAC3C,0IAA0I;IACnI,WAAW,CAAW;IAC7B,qHAAqH;IAC9G,GAAG,CAAU;IACpB,uHAAuH;IAChH,KAAK,CAAU;IACtB,sHAAsH;IAC/G,IAAI,CAAU;IACrB,oGAAoG;IAC7F,KAAK,CAAW;IACvB,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,0BAA0B,CAAC,CAAC,CAAC;IAErF,YAAsB,KAAoC,EAAE,MAAgB;QAC1E,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,KAAK,CAAC,QAAQ;YAChB,IAAI,CAAC,QAAQ,GAAG,IAAI,+DAAsC,CAAC,4BAAc,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAExG,IAAI,KAAK,CAAC,WAAW;YACnB,IAAI,CAAC,WAAW,GAAG,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAEzD,IAAI,KAAK,CAAC,KAAK;YACb,IAAI,CAAC,KAAK,GAAG,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;IAEe,MAAM;QACpB,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,sDAAsD;IAC/E,CAAC;IAOM,MAAM,CAAC,cAAc,CAAC,WAA+B;QAC1D,MAAM,GAAG,GAAG,WAAW,YAAY,iBAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,sBAAY,CAAC,CAAC;QACrF,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,wBAAwB,CAAC,CAAC;YACtF,OAAO,QAAQ,CAAC,EAAE,CAAC;QACrB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,yBAAW,CAAC,wBAAwB,EAAE,2BAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAClH,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,QAAkB,EAAE,cAA0B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,wBAAwB,CAAC,CAAC;QACpF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAClF,CAAC;CACF;AA3DD,4DA2DC;AAED;;;GAGG;AACH,MAAa,mBAAoB,SAAQ,cAAc;IACrD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;IAEhF,YAAsB,KAA0B,EAAE,MAAgB;QAChE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;CACF;AAPD,kDAOC;AAED;;;GAGG;AACH,MAAa,yBAA0B,SAAQ,iBAAO;IACpD,6EAA6E;IACtE,iBAAiB,CAAU;IAClC,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,2BAA2B,CAAC,CAAC,CAAC;IAEtF,YAAsB,KAAqC,EAAE,MAAgB;QAC3E,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;IAEe,MAAM;QACpB,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,sDAAsD;IAC/E,CAAC;CACF;AAbD,8DAaC","sourcesContent":["\n/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Elements\n */\n\nimport { Id64String } from \"@itwin/core-bentley\";\nimport { Point3d } from \"@itwin/core-geometry\";\nimport {\n  BisCodeSpec, Code, CodeScopeSpec, EntityReferenceSet, ExternalSourceAttachmentProps, ExternalSourceAttachmentRole, ExternalSourceProps, IModel, RelatedElement,\n  SynchronizationConfigLinkProps,\n} from \"@itwin/core-common\";\nimport { InformationReferenceElement, UrlLink } from \"./Element\";\nimport { EditTxn } from \"./EditTxn\";\nimport { IModelDb } from \"./IModelDb\";\nimport { ExternalSourceAttachmentAttachesSource, ExternalSourceIsInRepository } from \"./NavigationRelationship\";\nimport { _implicitTxn } from \"./internal/Symbols\";\n\n/** An ExternalSource refers to an 'information container' found in a repository. In some cases, the container is the entire repository.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class ExternalSource extends InformationReferenceElement {\n  /** The repository that contains this ExternalSource. */\n  public repository?: ExternalSourceIsInRepository;\n  /** The name of the iModel Connecter that processed this ExternalSource. */\n  public connectorName?: string;\n  /** The version of the iModel Connecter that processed this ExternalSource. */\n  public connectorVersion?: string;\n  /** @internal */\n  public static override get className(): string { return \"ExternalSource\"; }\n\n  protected constructor(props: ExternalSourceProps, iModel: IModelDb) {\n    super(props, iModel);\n    if (props.repository)\n      this.repository = new ExternalSourceIsInRepository(RelatedElement.idFromJson(props.repository));\n  }\n\n  public override toJSON(): ExternalSourceProps { // This override only specializes the return type\n    return super.toJSON(); // Entity.toJSON takes care of auto-handled properties\n  }\n  /** Ensure the [[CodeSpec]] for ExternalSource elements exists, using an explicit transaction.\n   * @param txn The active EditTxn.\n   */\n  public static ensureCodeSpec(txn: EditTxn): Id64String;\n  /** @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use ExternalSource.ensureCodeSpec(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help. */\n  public static ensureCodeSpec(iModelDb: IModelDb): Id64String;\n  public static ensureCodeSpec(txnOrIModel: EditTxn | IModelDb): Id64String {\n    const txn = txnOrIModel instanceof EditTxn ? txnOrIModel : txnOrIModel[_implicitTxn];\n    try {\n      const codeSpec = txn.iModel.codeSpecs.getByName(BisCodeSpec.externalSource);\n      return codeSpec.id;\n    } catch {\n      return txn.iModel.codeSpecs.insert(txn, BisCodeSpec.externalSource, CodeScopeSpec.Type.Repository);\n    }\n  }\n\n  /** Create a Code for an ExternalSource element given a name that is meant to be unique within the scope of the iModel.\n   * @param iModelDb  The IModelDb\n   * @param codeValue The ExternalSource name\n   * @see [[ensureCodeSpec]]\n   */\n  public static createCode(iModelDb: IModelDb, codeValue: string): Code {\n    const codeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.externalSource);\n    return new Code({ spec: codeSpec.id, scope: IModel.rootSubjectId, value: codeValue });\n  }\n\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    if (this.repository)\n      referenceIds.addElement(this.repository.id);\n  }\n}\n\n/** Attachment of an ExternalSource\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class ExternalSourceAttachment extends InformationReferenceElement {\n  /** The [[ExternalSource]] that is attached by this ExternalSourceAttachment. */\n  public attaches?: ExternalSourceAttachmentAttachesSource;\n  /** Specifies whether the attached [[ExternalSource]] provides context or models a part of the whole. */\n  public role?: ExternalSourceAttachmentRole;\n  /** The translation or offset in global coordinates of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\n  public translation?: Point3d;\n  /** The Yaw angle (in degrees) of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\n  public yaw?: number;\n  /** The Pitch angle (in degrees) of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\n  public pitch?: number;\n  /** The Roll angle (in degrees) of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\n  public roll?: number;\n  /** The scale of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\n  public scale?: Point3d;\n  /** @internal */\n  public static override get className(): string { return \"ExternalSourceAttachment\"; }\n\n  protected constructor(props: ExternalSourceAttachmentProps, iModel: IModelDb) {\n    super(props, iModel);\n    if (props.attaches)\n      this.attaches = new ExternalSourceAttachmentAttachesSource(RelatedElement.idFromJson(props.attaches));\n\n    if (props.translation)\n      this.translation = Point3d.fromJSON(props.translation);\n\n    if (props.scale)\n      this.scale = Point3d.fromJSON(props.scale);\n  }\n\n  public override toJSON(): ExternalSourceAttachmentProps { // This override only specializes the return type\n    return super.toJSON(); // Entity.toJSON takes care of auto-handled properties\n  }\n  /** Ensure the [[CodeSpec]] for ExternalSourceAttachment elements exists, using an explicit transaction.\n   * @param txn The active EditTxn.\n   */\n  public static ensureCodeSpec(txn: EditTxn): Id64String;\n  /** @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use ExternalSourceAttachment.ensureCodeSpec(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help. */\n  public static ensureCodeSpec(iModelDb: IModelDb): Id64String;\n  public static ensureCodeSpec(txnOrIModel: EditTxn | IModelDb): Id64String {\n    const txn = txnOrIModel instanceof EditTxn ? txnOrIModel : txnOrIModel[_implicitTxn];\n    try {\n      const codeSpec = txn.iModel.codeSpecs.getByName(BisCodeSpec.externalSourceAttachment);\n      return codeSpec.id;\n    } catch {\n      return txn.iModel.codeSpecs.insert(txn, BisCodeSpec.externalSourceAttachment, CodeScopeSpec.Type.ParentElement);\n    }\n  }\n\n  /** Create a Code for an ExternalSourceAttachment element given a name that is meant to be unique within the scope of its parent [[ExternalSource]].\n   * @param iModelDb  The IModelDb\n   * @param scopeElementId The parent ExternalSource\n   * @param codeValue The ExternalSourceAttachment name\n   * @see [[ensureCodeSpec]]\n   */\n  public static createCode(iModelDb: IModelDb, scopeElementId: Id64String, codeValue: string): Code {\n    const codeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.externalSourceAttachment);\n    return new Code({ spec: codeSpec.id, scope: scopeElementId, value: codeValue });\n  }\n}\n\n/** A group of ExternalSources that are collectively a source of information for one or more elements.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class ExternalSourceGroup extends ExternalSource {\n  /** @internal */\n  public static override get className(): string { return \"ExternalSourceGroup\"; }\n\n  protected constructor(props: ExternalSourceProps, iModel: IModelDb) {\n    super(props, iModel);\n  }\n}\n\n/** Link to the Configuration for an iModel Synchronization Job\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class SynchronizationConfigLink extends UrlLink {\n  /** Date/Time of last successful run of this synchronization configuration */\n  public lastSuccessfulRun?: string;\n  /** @internal */\n  public static override get className(): string { return \"SynchronizationConfigLink\"; }\n\n  protected constructor(props: SynchronizationConfigLinkProps, iModel: IModelDb) {\n    super(props, iModel);\n  }\n\n  public override toJSON(): SynchronizationConfigLinkProps { // This override only specializes the return type\n    return super.toJSON(); // Entity.toJSON takes care of auto-handled properties\n  }\n}\n\n"]}
+{"version":3,"file":"ExternalSource.js","sourceRoot":"","sources":["../../src/ExternalSource.ts"],"names":[],"mappings":";AACA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAA+C;AAC/C,oDAG4B;AAC5B,uCAAiE;AACjE,uCAAoC;AAEpC,qEAAgH;AAChH,gDAAkD;AAElD;;;GAGG;AACH,MAAa,cAAe,SAAQ,qCAA2B;IAC7D,wDAAwD;IACjD,UAAU,CAAgC;IACjD,2EAA2E;IACpE,aAAa,CAAU;IAC9B,8EAA8E;IACvE,gBAAgB,CAAU;IACjC,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAE3E,YAAsB,KAA0B,EAAE,MAAgB;QAChE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,KAAK,CAAC,UAAU;YAClB,IAAI,CAAC,UAAU,GAAG,IAAI,qDAA4B,CAAC,4BAAc,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IACpG,CAAC;IAEe,MAAM;QACpB,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,sDAAsD;IAC/E,CAAC;IAOM,MAAM,CAAC,cAAc,CAAC,WAA+B;QAC1D,MAAM,GAAG,GAAG,WAAW,YAAY,iBAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,sBAAY,CAAC,CAAC;QACrF,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,cAAc,CAAC,CAAC;YAC5E,OAAO,QAAQ,CAAC,EAAE,CAAC;QACrB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,yBAAW,CAAC,cAAc,EAAE,2BAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrG,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,QAAkB,EAAE,SAAiB;QAC5D,MAAM,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,cAAc,CAAC,CAAC;QAC1E,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,oBAAM,CAAC,aAAa,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACxF,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,UAAU;YACjB,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAChD,CAAC;CACF;AAlDD,wCAkDC;AAED;;;GAGG;AACH,MAAa,wBAAyB,SAAQ,qCAA2B;IACvE,gFAAgF;IACzE,QAAQ,CAA0C;IACzD,wGAAwG;IACjG,IAAI,CAAgC;IAC3C,0IAA0I;IACnI,WAAW,CAAW;IAC7B,qHAAqH;IAC9G,GAAG,CAAU;IACpB,uHAAuH;IAChH,KAAK,CAAU;IACtB,sHAAsH;IAC/G,IAAI,CAAU;IACrB,oGAAoG;IAC7F,KAAK,CAAW;IACvB,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,0BAA0B,CAAC,CAAC,CAAC;IAErF,YAAsB,KAAoC,EAAE,MAAgB;QAC1E,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,KAAK,CAAC,QAAQ;YAChB,IAAI,CAAC,QAAQ,GAAG,IAAI,+DAAsC,CAAC,4BAAc,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAExG,IAAI,KAAK,CAAC,WAAW;YACnB,IAAI,CAAC,WAAW,GAAG,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAEzD,IAAI,KAAK,CAAC,KAAK;YACb,IAAI,CAAC,KAAK,GAAG,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;IAEe,MAAM;QACpB,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,sDAAsD;IAC/E,CAAC;IAOM,MAAM,CAAC,cAAc,CAAC,WAA+B;QAC1D,MAAM,GAAG,GAAG,WAAW,YAAY,iBAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,sBAAY,CAAC,CAAC;QACrF,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,wBAAwB,CAAC,CAAC;YACtF,OAAO,QAAQ,CAAC,EAAE,CAAC;QACrB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,yBAAW,CAAC,wBAAwB,EAAE,2BAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAClH,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,QAAkB,EAAE,cAA0B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,wBAAwB,CAAC,CAAC;QACpF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAClF,CAAC;CACF;AA3DD,4DA2DC;AAED;;;GAGG;AACH,MAAa,mBAAoB,SAAQ,cAAc;IACrD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;IAEhF,YAAsB,KAA0B,EAAE,MAAgB;QAChE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;CACF;AAPD,kDAOC;AAED;;;GAGG;AACH,MAAa,yBAA0B,SAAQ,iBAAO;IACpD,6EAA6E;IACtE,iBAAiB,CAAU;IAClC,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,2BAA2B,CAAC,CAAC,CAAC;IAEtF,YAAsB,KAAqC,EAAE,MAAgB;QAC3E,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;IAEe,MAAM;QACpB,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,sDAAsD;IAC/E,CAAC;CACF;AAbD,8DAaC","sourcesContent":["\n/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Elements\n */\n\nimport { Id64String } from \"@itwin/core-bentley\";\nimport { Point3d } from \"@itwin/core-geometry\";\nimport {\n  BisCodeSpec, Code, CodeScopeSpec, EntityReferenceSet, ExternalSourceAttachmentProps, ExternalSourceAttachmentRole, ExternalSourceProps, IModel, RelatedElement,\n  SynchronizationConfigLinkProps,\n} from \"@itwin/core-common\";\nimport { InformationReferenceElement, UrlLink } from \"./Element\";\nimport { EditTxn } from \"./EditTxn\";\nimport { IModelDb } from \"./IModelDb\";\nimport { ExternalSourceAttachmentAttachesSource, ExternalSourceIsInRepository } from \"./NavigationRelationship\";\nimport { _implicitTxn } from \"./internal/Symbols\";\n\n/** An ExternalSource refers to an 'information container' found in a repository. In some cases, the container is the entire repository.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class ExternalSource extends InformationReferenceElement {\n  /** The repository that contains this ExternalSource. */\n  public repository?: ExternalSourceIsInRepository;\n  /** The name of the iModel Connecter that processed this ExternalSource. */\n  public connectorName?: string;\n  /** The version of the iModel Connecter that processed this ExternalSource. */\n  public connectorVersion?: string;\n  /** @internal */\n  public static override get className(): string { return \"ExternalSource\"; }\n\n  protected constructor(props: ExternalSourceProps, iModel: IModelDb) {\n    super(props, iModel);\n    if (props.repository)\n      this.repository = new ExternalSourceIsInRepository(RelatedElement.idFromJson(props.repository));\n  }\n\n  public override toJSON(): ExternalSourceProps { // This override only specializes the return type\n    return super.toJSON(); // Entity.toJSON takes care of auto-handled properties\n  }\n  /** Ensure the [[CodeSpec]] for ExternalSource elements exists, using an explicit transaction.\n   * @param txn The active EditTxn.\n   */\n  public static ensureCodeSpec(txn: EditTxn): Id64String;\n  /** @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use ExternalSource.ensureCodeSpec(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help. */\n  public static ensureCodeSpec(iModelDb: IModelDb): Id64String;\n  public static ensureCodeSpec(txnOrIModel: EditTxn | IModelDb): Id64String {\n    const txn = txnOrIModel instanceof EditTxn ? txnOrIModel : txnOrIModel[_implicitTxn];\n    try {\n      const codeSpec = txn.iModel.codeSpecs.getByName(BisCodeSpec.externalSource);\n      return codeSpec.id;\n    } catch {\n      return txn.iModel.codeSpecs.insert(txn, BisCodeSpec.externalSource, CodeScopeSpec.Type.Repository);\n    }\n  }\n\n  /** Create a Code for an ExternalSource element given a name that is meant to be unique within the scope of the iModel.\n   * @param iModelDb  The IModelDb\n   * @param codeValue The ExternalSource name\n   * @see [[ensureCodeSpec]]\n   */\n  public static createCode(iModelDb: IModelDb, codeValue: string): Code {\n    const codeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.externalSource);\n    return new Code({ spec: codeSpec.id, scope: IModel.rootSubjectId, value: codeValue });\n  }\n\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    if (this.repository)\n      referenceIds.addElement(this.repository.id);\n  }\n}\n\n/** Attachment of an ExternalSource\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class ExternalSourceAttachment extends InformationReferenceElement {\n  /** The [[ExternalSource]] that is attached by this ExternalSourceAttachment. */\n  public attaches?: ExternalSourceAttachmentAttachesSource;\n  /** Specifies whether the attached [[ExternalSource]] provides context or models a part of the whole. */\n  public role?: ExternalSourceAttachmentRole;\n  /** The translation or offset in global coordinates of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\n  public translation?: Point3d;\n  /** The Yaw angle (in degrees) of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\n  public yaw?: number;\n  /** The Pitch angle (in degrees) of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\n  public pitch?: number;\n  /** The Roll angle (in degrees) of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\n  public roll?: number;\n  /** The scale of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\n  public scale?: Point3d;\n  /** @internal */\n  public static override get className(): string { return \"ExternalSourceAttachment\"; }\n\n  protected constructor(props: ExternalSourceAttachmentProps, iModel: IModelDb) {\n    super(props, iModel);\n    if (props.attaches)\n      this.attaches = new ExternalSourceAttachmentAttachesSource(RelatedElement.idFromJson(props.attaches));\n\n    if (props.translation)\n      this.translation = Point3d.fromJSON(props.translation);\n\n    if (props.scale)\n      this.scale = Point3d.fromJSON(props.scale);\n  }\n\n  public override toJSON(): ExternalSourceAttachmentProps { // This override only specializes the return type\n    return super.toJSON(); // Entity.toJSON takes care of auto-handled properties\n  }\n  /** Ensure the [[CodeSpec]] for ExternalSourceAttachment elements exists, using an explicit transaction.\n   * @param txn The active EditTxn.\n   */\n  public static ensureCodeSpec(txn: EditTxn): Id64String;\n  /** @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use ExternalSourceAttachment.ensureCodeSpec(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help. */\n  public static ensureCodeSpec(iModelDb: IModelDb): Id64String;\n  public static ensureCodeSpec(txnOrIModel: EditTxn | IModelDb): Id64String {\n    const txn = txnOrIModel instanceof EditTxn ? txnOrIModel : txnOrIModel[_implicitTxn];\n    try {\n      const codeSpec = txn.iModel.codeSpecs.getByName(BisCodeSpec.externalSourceAttachment);\n      return codeSpec.id;\n    } catch {\n      return txn.iModel.codeSpecs.insert(txn, BisCodeSpec.externalSourceAttachment, CodeScopeSpec.Type.ParentElement);\n    }\n  }\n\n  /** Create a Code for an ExternalSourceAttachment element given a name that is meant to be unique within the scope of its parent [[ExternalSource]].\n   * @param iModelDb  The IModelDb\n   * @param scopeElementId The parent ExternalSource\n   * @param codeValue The ExternalSourceAttachment name\n   * @see [[ensureCodeSpec]]\n   */\n  public static createCode(iModelDb: IModelDb, scopeElementId: Id64String, codeValue: string): Code {\n    const codeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.externalSourceAttachment);\n    return new Code({ spec: codeSpec.id, scope: scopeElementId, value: codeValue });\n  }\n}\n\n/** A group of ExternalSources that are collectively a source of information for one or more elements.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class ExternalSourceGroup extends ExternalSource {\n  /** @internal */\n  public static override get className(): string { return \"ExternalSourceGroup\"; }\n\n  protected constructor(props: ExternalSourceProps, iModel: IModelDb) {\n    super(props, iModel);\n  }\n}\n\n/** Link to the Configuration for an iModel Synchronization Job\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class SynchronizationConfigLink extends UrlLink {\n  /** Date/Time of last successful run of this synchronization configuration */\n  public lastSuccessfulRun?: string;\n  /** @internal */\n  public static override get className(): string { return \"SynchronizationConfigLink\"; }\n\n  protected constructor(props: SynchronizationConfigLinkProps, iModel: IModelDb) {\n    super(props, iModel);\n  }\n\n  public override toJSON(): SynchronizationConfigLinkProps { // This override only specializes the return type\n    return super.toJSON(); // Entity.toJSON takes care of auto-handled properties\n  }\n}\n\n"]}

package/lib/cjs/IModelDb.d.ts

@@ -23,7 +23,7 @@ import { Relationships } from "./Relationship";
 import { SqliteStatement } from "./SqliteStatement";
 import { ComputeRangesForTextLayoutArgs, TextLayoutRanges } from "./annotations/TextBlockLayout";
 import { TxnManager } from "./TxnManager";
-import { EditTxn } from "./EditTxn";
+import { BulkDeleteElementsArgs, BulkDeleteElementsResult, EditTxn } from "./EditTxn";
 import { ViewDefinition } from "./ViewDefinition";
 import { ViewStore } from "./ViewStore";
 import { SettingsContainer } from "./workspace/Settings";
@@ -32,7 +32,7 @@ import { LockControl } from "./LockControl";
 import type { BlobContainer } from "./BlobContainerService";
 import { IModelDbFonts } from "./IModelDbFonts";
 import { _activeTxn, _cache, _implicitTxn, _instanceKeyCache, _nativeDb, _resetIModelDb } from "./internal/Symbols";
-import { ECSpecVersion, ECVersion, SchemaContext } from "@itwin/ecschema-metadata";
+import { ECSpecVersion, ECVersion, SchemaContext, SchemaView } from "@itwin/ecschema-metadata";
 import { SchemaMap } from "./Schema";
 import { ElementLRUCache, InstanceKeyLRUCache } from "./internal/ElementLRUCache";
 import { IntegrityCheckResult } from "./internal/IntegrityCheck";
@@ -306,6 +306,7 @@ export declare abstract class IModelDb extends IModel {
     private _jsClassMap?;
     private _schemaMap?;
     private _schemaContext?;
+    private _schemasPromise?;
     /** @deprecated in 5.0.0 - will not be removed until after 2026-06-13. Use [[fonts]]. */
     protected _fontMap?: FontMap;
     private readonly _fonts;
@@ -626,7 +627,7 @@ export declare abstract class IModelDb extends IModel {
      * ``` ts
      * [[include:IModelDb.updateProjectExtents]]
      * ```
-     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.updateProjectExtents instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+     * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.updateProjectExtents instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
      */
     updateProjectExtents(newExtents: AxisAlignedBox3d): void;
     /** Compute an appropriate project extents for this iModel based on the ranges of all spatial elements.
@@ -639,11 +640,11 @@ export declare abstract class IModelDb extends IModel {
      */
     computeProjectExtents(options?: ComputeProjectExtentsOptions): ComputedProjectExtents;
     /** Update the [EcefLocation]($docs/learning/glossary#eceflocation) of this iModel.
-     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.updateEcefLocation instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+     * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.updateEcefLocation instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
      */
     updateEcefLocation(ecef: EcefLocation): void;
     /** Update the IModelProps of this iModel in the database.
-     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.updateIModelProps instead, within an explicit EditTxn scope (or via withEditTxn).
+     * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.updateIModelProps instead, within an explicit EditTxn scope (or via withEditTxn).
      */
     updateIModelProps(): void;
     /** Commit unsaved changes in memory as a Txn to this iModelDb.
@@ -652,7 +653,7 @@ export declare abstract class IModelDb extends IModel {
      * @note This will not push changes to the iModelHub.
      * @note This method should not be called from {TxnManager.withIndirectTxnModeAsync}, {TxnManager.withIndirectTxnMode} or {RebaseHandler.recompute}.
      * @see [[IModelDb.pushChanges]] to push changes to the iModelHub.
-     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.saveChanges instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+     * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.saveChanges instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
      */
     saveChanges(description?: string): void;
     /** Commit unsaved changes in memory as a Txn to this iModelDb. This is preferable for case where application like to store additional structured information with the change that could be useful later when rebasing.
@@ -662,11 +663,11 @@ export declare abstract class IModelDb extends IModel {
      * @note This will not push changes to the iModelHub.
      * @note This method should not be called from {TxnManager.withIndirectTxnModeAsync}, {TxnManager.withIndirectTxnMode} or {RebaseHandler.recompute}.
      * @see [[IModelDb.pushChanges]] to push changes to the iModelHub.
-     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.saveChanges instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+     * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.saveChanges instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
      */
     saveChanges(args: SaveChangesArgs): void;
     /** Abandon changes in memory that have not been saved as a Txn to this iModelDb.
-     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.abandonChanges instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+     * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.abandonChanges instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
     */
     abandonChanges(): void;
     /**
@@ -770,7 +771,7 @@ export declare abstract class IModelDb extends IModel {
     static validateSchemas(filePath: LocalFileName, forReadWrite: boolean): SchemaState;
     /** The registry of entity metadata for this iModel.
      * @internal
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `schemaContext` from the `iModel` instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `getSchemaView()` from the `iModel` instead.
      *
      * @example
      * ```typescript
@@ -778,7 +779,8 @@ export declare abstract class IModelDb extends IModel {
      * const classMetaData: EntityMetaData | undefined = iModel.classMetaDataRegistry.find("SchemaName:ClassName");
      *
      * // Replacement:
-     * const metaData: EntityClass | undefined = imodel.schemaContext.getSchemaItemSync("SchemaName.ClassName", EntityClass);
+     * const view = await imodel.getSchemaView();
+     * const cls = view.findClass("SchemaName:ClassName");
      * ```
      */
     get classMetaDataRegistry(): MetaDataRegistry;
@@ -791,10 +793,28 @@ export declare abstract class IModelDb extends IModel {
      */
     get schemaMap(): SchemaMap;
     /**
-     * Gets the context that allows accessing the metadata (ecschema-metadata package) of this iModel
+     * Gets the context that allows accessing the metadata (`@itwin/ecschema-metadata` package) of this iModel.
+     *
+     * For runtime read-only access - class/property iteration, IS-A checks, navigating relationships, KOQ lookups -
+     * prefer [[getSchemaView]]. `schemaContext` remains the right choice when you need schema authoring
+     * (via `@itwin/ecschema-editing`), custom-attribute deserialization, or the full ecschema-metadata object graph.
      * @public @preview
      */
     get schemaContext(): SchemaContext;
+    /** Get the schema view for this iModel. The view is built lazily on
+     * first call by fetching compact binary schema data via `PRAGMA schema_view` through
+     * the ConcurrentQuery thread pool. Subsequent calls return the cached view. Multiple
+     * concurrent callers share a single in-flight build.
+     *
+     * The returned `SchemaView` is a lightweight, read-only, synchronous API for
+     * navigating schema metadata - classes, properties, relationships, enumerations, etc.
+     * It is the recommended default for runtime read-only metadata access and is significantly
+     * faster and lower-memory than [[schemaContext]]. Use [[schemaContext]] for schema authoring,
+     * custom-attribute deserialization, or anywhere you need the full ecschema-metadata object graph.
+     * @beta
+     */
+    getSchemaView(): Promise<SchemaView>;
+    private _hydrateSchemas;
     /** Get the linkTableRelationships for this IModel */
     get relationships(): Relationships;
     /** Get the CodeSpecs in this IModel. */
@@ -825,7 +845,7 @@ export declare abstract class IModelDb extends IModel {
     getInstanceArgs(instanceId?: Id64String, baseClassName?: string, federationGuid?: GuidString, code?: CodeProps): IModelJsNative.ResolveInstanceKeyArgs;
     /** Get metadata for a class. This method will load the metadata from the iModel into the cache as a side-effect, if necessary.
      * @throws [[IModelError]] if the metadata cannot be found nor loaded.
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `getSchemaItem` from `SchemaContext` class instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `getSchemaView()` on the iModel and call `view.findClass(...)` instead.
      *
      * @example
      *  * ```typescript
@@ -833,12 +853,13 @@ export declare abstract class IModelDb extends IModel {
      * const metaData: EntityMetaData = imodel.getMetaData("SchemaName:ClassName");
      *
      * // Replacement:
-     * const metaData: EntityClass | undefined = imodel.schemaContext.getSchemaItemSync("SchemaName", "ClassName", EntityClass);
+     * const view = await imodel.getSchemaView();
+     * const cls = view.findClass("SchemaName:ClassName");
      * ```
      */
     getMetaData(classFullName: string): EntityMetaData;
     /** Identical to [[getMetaData]], except it returns `undefined` instead of throwing an error if the metadata cannot be found nor loaded.
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `getSchemaItem` from `SchemaContext` class instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `getSchemaView()` on the iModel and call `view.findClass(...)` instead.
      *
      * @example
      *  * ```typescript
@@ -846,7 +867,8 @@ export declare abstract class IModelDb extends IModel {
      * const metaData: EntityMetaData | undefined = imodel.tryGetMetaData("SchemaName:ClassName");
      *
      * // Replacement:
-     * const metaData: EntityClass | undefined = imodel.schemaContext.getSchemaItemSync("SchemaName.ClassName", EntityClass);
+     * const view = await imodel.getSchemaView();
+     * const cls = view.findClass("SchemaName:ClassName");
      * ```
      */
     tryGetMetaData(classFullName: string): EntityMetaData | undefined;
@@ -857,7 +879,7 @@ export declare abstract class IModelDb extends IModel {
      * @param func The callback to be invoked on each property
      * @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.
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `forEachProperty` instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `getSchemaView()` on the iModel and iterate `view.findClass(classFullName)?.getProperties()` instead.
      *
      * @example
      * ```typescript
@@ -867,9 +889,10 @@ export declare abstract class IModelDb extends IModel {
      * }, false);
      *
      * // Replacement:
-     * await IModelDb.forEachProperty(imodel, "TestDomain.TestDomainClass", true, (propName: string, property: Property) => {
-     *   console.log(`Property name: ${propName}, Property type: ${property.propertyType}`);
-     * }, false);
+     * const view = await imodel.getSchemaView();
+     * for (const property of view.findClass("BisCore:Element")?.getProperties() ?? []) {
+     *   console.log(`Property name: ${property.name}, Kind: ${property.kind}`);
+     * }
      * ```
      */
     static forEachMetaData(iModel: IModelDb, classFullName: string, wantSuper: boolean, func: PropertyCallback, includeCustom?: boolean): void;
@@ -879,7 +902,7 @@ export declare abstract class IModelDb extends IModel {
      * @param func The callback to be invoked on each property
      * @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.
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `forEachProperty` from `SchemaContext` class instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `getSchemaView()` on the iModel and iterate `view.findClass(classFullName)?.getProperties()` instead.
      *
      * @example
      * ```typescript
@@ -889,9 +912,10 @@ export declare abstract class IModelDb extends IModel {
      * });
      *
      * // Replacement:
-     * imodel.schemaContext.forEachProperty("BisCore:Element", true, (propName: string, property: Property) => {
-     *   console.log(`Property name: ${propName}, Property type: ${property.propertyType}`);
-     * });
+     * const view = await imodel.getSchemaView();
+     * for (const property of view.findClass("BisCore:Element")?.getProperties() ?? []) {
+     *   console.log(`Property name: ${property.name}, Kind: ${property.kind}`);
+     * }
      * ```
      */
     forEachMetaData(classFullName: string, wantSuper: boolean, func: PropertyCallback, includeCustom?: boolean): void;
@@ -950,13 +974,13 @@ export declare abstract class IModelDb extends IModel {
      * @param prop the FilePropertyProps that describes the new property
      * @param value either a string or a blob to save as the file property
      * @note This method should not be called from {TxnManager.withIndirectTxnModeAsync} or {TxnManager.withIndirectTxnMode}.
-     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.saveFileProperty instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+     * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.saveFileProperty instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
      */
     saveFileProperty(prop: FilePropertyProps, strValue: string | undefined, blobVal?: Uint8Array): void;
     /** delete a "file property" from this iModel
      * @param prop the FilePropertyProps that describes the property
      * @note This method should not be called from {TxnManager.withIndirectTxnModeAsync} or {TxnManager.withIndirectTxnMode}.
-     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.deleteFileProperty instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+     * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.deleteFileProperty instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
      */
     deleteFileProperty(prop: FilePropertyProps): void;
     /** Query for the next available major id for a "file property" from this iModel.
@@ -1106,12 +1130,12 @@ export declare abstract class IModelDb extends IModel {
      * @param dict The SettingDictionary object to stringify and save.
      * @note All saved `SettingDictionary`s are loaded into [[workspace.settings]] every time an iModel is opened.
      * @see [[Settings.addDictionary]] to register a dictionary for the current session only without persisting it.
-     * @beta @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.saveSettingDictionary instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+     * @beta @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.saveSettingDictionary instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
      */
     saveSettingDictionary(name: string, dict: SettingsContainer): void;
     /** Delete a SettingDictionary, previously added with [[saveSettingDictionary]], from this iModel.
      * @param name The name of the dictionary to delete.
-     * @beta @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.deleteSettingDictionary instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+     * @beta @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.deleteSettingDictionary instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
      */
     deleteSettingDictionary(name: string): void;
     /** Load all setting dictionaries in this iModel into `this.workspace.settings` */
@@ -1238,13 +1262,13 @@ export declare namespace IModelDb {
          * @param props The data for the new model.
          * @returns The newly inserted model's Id.
          * @throws [[IModelError]] if insertion fails.
-         * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.insertModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+         * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.insertModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
          */
         insertModel(props: ModelProps): Id64String;
         /** Update an existing model.
          * @param props the properties of the model to change
          * @throws [[IModelError]] if update fails.
-         * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.updateModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+         * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.updateModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
          */
         updateModel(props: UpdateModelOptions): void;
         /** Mark the geometry of [[GeometricModel]] as having changed, by recording an indirect change to its GeometryGuid property.
@@ -1254,14 +1278,14 @@ export declare namespace IModelDb {
          * Cached [Tile]($frontend)s are only invalidated after the geometry guid of the model changes.
          * @note This will throw IModelError with [IModelStatus.VersionTooOld]($core-bentley) if a version of the BisCore schema older than 1.0.11 is present in the iModel.
          * @throws [[IModelError]] if the update fails.
-         * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.updateGeometryGuid instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+         * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.updateGeometryGuid instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
          * @see [[TxnManager.onModelGeometryChanged]] for the event emitted in response to such a change.
          */
         updateGeometryGuid(modelId: Id64String): void;
         /** Delete one or more existing models.
          * @param ids The Ids of the models to be deleted
          * @throws [[IModelError]] if deletion fails.
-         * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.deleteModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+         * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.deleteModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
          */
         deleteModel(ids: Id64Arg): void;
         /** For each specified [[GeometricModel]], attempts to obtain the union of the volumes of all geometric elements within that model.
@@ -1354,7 +1378,7 @@ export declare namespace IModelDb {
          * However when `elProps.federationGuid` is not present or undefined, a new Guid will be generated and stored on the resultant element. But
          * the value of `elProps.federationGuid` is *not* updated. Generally, it is best to re-read the element after inserting (e.g. via [[getElementProps]])
          * if you intend to continue working with it. That will ensure its values reflect the persistent state.
-         * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.insertElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+         * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.insertElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
          */
         insertElement(elProps: ElementProps, options?: InsertElementOptions): Id64String;
         /**
@@ -1367,16 +1391,26 @@ export declare namespace IModelDb {
          * @note The values of `classFullName` and `model` *may not be changed* by this method. Further, it will permute the `elProps` object by adding or
          * overwriting their values to the correct values.
          * @throws [[ITwinError]] if update fails.
-         * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.updateElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+         * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.updateElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
          */
         updateElement<T extends ElementProps>(elProps: Partial<T>): void;
         /** Delete one or more elements from this iModel.
          * @param ids The set of Ids of the element(s) to be deleted
          * @throws [[ITwinError]]
          * @see deleteDefinitionElements
-         * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.deleteElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+         * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.deleteElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
          */
         deleteElement(ids: Id64Arg): void;
+        /**
+         * Delete multiple elements from the iModel.
+         * @param ids The ids of the elements to delete. All ids must be well-formed and valid [[Id64String]]s.
+         * @param deleteOptions Options for the delete operation.
+         * @returns A result object containing information about the deletion operation success and the element ids that failed to delete (if any).
+         * @throws [[ITwinError]] if any of the supplied ids are not well-formed/valid [[Id64String]]s.
+         * @deprecated in 5.1.9 - will not be removed until after 2026-08-15. Use EditTxn.deleteElements instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+         * @beta
+         */
+        deleteElements(ids: Id64Array, deleteOptions?: BulkDeleteElementsArgs): BulkDeleteElementsResult;
         /** DefinitionElements can only be deleted if it can be determined that they are not referenced by other Elements.
          * This *usage query* can be expensive since it may involve scanning the GeometryStreams of all GeometricElements.
          * Since [[deleteElement]] does not perform these additional checks, it fails in order to prevent potentially referenced DefinitionElements from being deleted.
@@ -1385,7 +1419,7 @@ export declare namespace IModelDb {
          * DefinitionElements rather than calling this method separately for each one. Ids that are not valid DefinitionElements will be ignored.
          * @returns An IdSet of the DefinitionElements that are used and were therefore not deleted.
          * @see deleteElement
-         * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.deleteDefinitionElements instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+         * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.deleteDefinitionElements instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
          */
         deleteDefinitionElements(definitionElementIds: Id64Array): Id64Set;
         /** Query for the child elements of the specified element.
@@ -1434,19 +1468,19 @@ export declare namespace IModelDb {
          * @returns the id of the newly inserted aspect.
          * @note Aspect Ids may collide with element Ids, so don't put both in a container like Set or Map
          *       use [EntityReference]($common) for that instead.
-         * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.insertAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+         * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.insertAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
          */
         insertAspect(aspectProps: ElementAspectProps): Id64String;
         /** Update an exist ElementAspect within the iModel.
          * @param aspectProps The properties to use to update the ElementAspect.
          * @throws [[IModelError]] if unable to update the ElementAspect.
-         * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.updateAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+         * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.updateAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
          */
         updateAspect(aspectProps: ElementAspectProps): void;
         /** Delete one or more ElementAspects from this iModel.
          * @param aspectInstanceIds The set of instance Ids of the ElementAspect(s) to be deleted
          * @throws [[IModelError]] if unable to delete the ElementAspect.
-         * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.deleteAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+         * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.deleteAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
          */
         deleteAspect(aspectInstanceIds: Id64Arg): void;
     }
@@ -1469,7 +1503,7 @@ export declare namespace IModelDb {
             accessLevel?: BlobContainer.RequestAccessLevel;
         }): Promise<ViewStore.CloudAccess>;
         /**
-         * @beta @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.saveDefaultViewStore instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+         * @beta @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.saveDefaultViewStore instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
          */
         saveDefaultViewStore(arg: CloudSqlite.ContainerProps): void;
         /** Query for the array of ViewDefinitionProps of the specified class and matching the specified IsPrivate setting.
@@ -1667,7 +1701,45 @@ export declare class BriefcaseDb extends IModelDb {
     enableChangesetStatTracking(): Promise<void>;
     disableChangesetStatTracking(): Promise<void>;
     getAllChangesetHealthData(): Promise<ChangesetHealthStats[]>;
-    /** Revert timeline changes and then push resulting changeset */
+    /**
+     * Whether file-based transactions are enabled for this briefcase.
+     *
+     * When enabled, transaction data is stored in separate temporary `.txn` files rather than in the
+     * briefcase's internal transaction table. This avoids SQLite blob size limits and reduces memory
+     * pressure for very large changesets, at the cost of additional disk I/O.
+     * @see [[enableFileBasedTxns]] to enable, [[disableFileBasedTxns]] to disable.
+     * @internal
+     */
+    get isFileBasedTxnsEnabled(): boolean;
+    /**
+     * Enable file-based transactions for this briefcase.
+     * @throws IModelError with [[ChangeSetStatus.HasUncommittedChanges]] if there are unsaved changes.
+     * @throws IModelError with [[ChangeSetStatus.HasLocalChanges]] if there are pending transactions.
+     * @internal
+     */
+    enableFileBasedTxns(): void;
+    /**
+     * Disable file-based transactions for this briefcase, reverting to the default storage mode
+     * (transactions stored within the briefcase's internal transaction table).
+     * @throws IModelError with [[ChangeSetStatus.HasUncommittedChanges]] if there are unsaved changes.
+     * @throws IModelError with [[ChangeSetStatus.HasLocalChanges]] if there are pending transactions.
+     * @internal
+     */
+    disableFileBasedTxns(): void;
+    private _setFileBasedTxnsSetting;
+    /**
+     * Revert timeline changes and push the resulting changeset.
+     *
+     * Pulls the latest changes, acquires the schema lock, reverts the inclusive range of
+     * changesets `[toIndex..current]`, and pushes the revert as a new changeset. On failure,
+     * follow the behavior specified by `arg.inCaseOfFailure`, which may discard local changes,
+     * retain local changes, or delete the briefcase.
+     *
+     * @param arg - Arguments specifying the target changeset index, push options, access token, and failure handling behavior.
+     * @throws IModelError with [[ChangeSetStatus.ApplyError]] if `toIndex` is not specified.
+     * @throws IModelError with [[ChangeSetStatus.HasUncommittedChanges]] if there are unsaved changes.
+     * @throws IModelError with [[ChangeSetStatus.HasLocalChanges]] if there are pending transactions.
+     */
     revertAndPushChanges(arg: RevertChangesArgs): Promise<void>;
     /**
      * Push changes to iModelHub.