@itwin/core-backend 4.1.0-dev.8 → 4.1.0-dev.81

package/lib/cjs/ElementAspect.js

@@ -19,12 +19,11 @@ const core_bentley_1 = require("@itwin/core-bentley");
 class ElementAspect extends Entity_1.Entity {
     /** @internal */
     static get className() { return "ElementAspect"; }
-    /** @internal */
+    /** Construct an aspect from its JSON representation and its containing iModel. */
     constructor(props, iModel) {
         super(props, iModel);
         this.element = core_common_1.RelatedElement.fromJSON(props.element); // eslint-disable-line @typescript-eslint/no-non-null-assertion
     }
-    /** @internal */
     toJSON() {
         const val = super.toJSON();
         val.element = this.element;
@@ -109,7 +108,7 @@ exports.ChannelRootAspect = ChannelRootAspect;
 class ExternalSourceAspect extends ElementMultiAspect {
     /** @internal */
     static get className() { return "ExternalSourceAspect"; }
-    /** @internal */
+    /** Construct an aspect from its JSON representation and its containing iModel. */
     constructor(props, iModel) {
         super(props, iModel);
         this.scope = core_common_1.RelatedElement.fromJSON(props.scope); // eslint-disable-line @typescript-eslint/no-non-null-assertion
@@ -161,7 +160,6 @@ class ExternalSourceAspect extends ElementMultiAspect {
         });
         return found;
     }
-    /** @internal */
     toJSON() {
         const val = super.toJSON();
         val.scope = this.scope;

package/lib/cjs/ElementAspect.js.map

@@ -1 +1 @@
-{"version":3,"file":"ElementAspect.js","sourceRoot":"","sources":["../../src/ElementAspect.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAA+I;AAC/I,qCAAkC;AAGlC,sDAA2D;AA0B3D;;;;GAIG;AACH,MAAa,aAAc,SAAQ,eAAM;IACvC,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,eAAe,CAAC,CAAC,CAAC;IAG1E,gBAAgB;IAChB,YAAY,KAAyB,EAAE,MAAgB;QACrD,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,4BAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAE,CAAC,CAAC,+DAA+D;IACzH,CAAC;IAED,gBAAgB;IACA,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAwB,CAAC;QACjD,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3B,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAqB;QAC7C,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,UAAU,CAAC,IAAsB,IAAU,CAAC;IAE7D;;;;OAIG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAqB;QAC7C,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,SAAS,CAAC,IAAsB,IAAU,CAAC;IAE5D;;;;OAIG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAkB;QAC1C,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,SAAS,CAAC,IAAmB,IAAU,CAAC;CAC1D;AA9DD,sCA8DC;AAED;;GAEG;AACH,MAAa,mBAAoB,SAAQ,aAAa;IACpD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;CACjF;AAHD,kDAGC;AAED;;GAEG;AACH,MAAa,kBAAmB,SAAQ,aAAa;IACnD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,oBAAoB,CAAC,CAAC,CAAC;CAChF;AAHD,gDAGC;AAED;;GAEG;AACH,MAAa,iBAAkB,SAAQ,mBAAmB;IACxD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,mBAAmB,CAAC,CAAC,CAAC;IAC9E;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,MAAgB,EAAE,OAAmB,EAAE,WAAmB;QAC7E,MAAM,KAAK,GAA2B,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;QAC1H,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;CACF;AAVD,8CAUC;AAED;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,kBAAkB;IAC1D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IA0BjF,gBAAgB;IAChB,YAAY,KAAgC,EAAE,MAAgB;QAC5D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,4BAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAE,CAAC,CAAC,+DAA+D;QACnH,IAAI,CAAC,MAAM,GAAG,4BAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;IAC7C,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,YAAY,CAAC,QAAkB,EAAE,KAAiB,EAAE,IAAY,EAAE,UAAkB;QAChG,MAAM,GAAG,GAAG,wCAAwC,oBAAoB,CAAC,aAAa,oEAAoE,CAAC;QAC3J,IAAI,SAAiC,CAAC;QACtC,IAAI,QAAgC,CAAC;QACrC,QAAQ,CAAC,qBAAqB,CAAC,GAAG,EAAE,CAAC,SAAyB,EAAE,EAAE;YAChE,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACjC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACnC,SAAS,CAAC,UAAU,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;YAC/C,IAAI,uBAAQ,CAAC,aAAa,KAAK,SAAS,CAAC,IAAI,EAAE,EAAE;gBAC/C,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;gBAC1C,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;aAC1C;QACH,CAAC,CAAC,CAAC;QACH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;MAWE;IACK,MAAM,CAAC,eAAe,CAAC,QAAkB,EAAE,KAAiB,EAAE,IAAY,EAAE,UAAkB;QACnG,MAAM,GAAG,GAAG,wCAAwC,oBAAoB,CAAC,aAAa,oEAAoE,CAAC;QAC3J,MAAM,KAAK,GAA2D,EAAE,CAAC;QACzE,QAAQ,CAAC,qBAAqB,CAAC,GAAG,EAAE,CAAC,SAAyB,EAAE,EAAE;YAChE,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACjC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACnC,SAAS,CAAC,UAAU,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;YAC/C,OAAO,uBAAQ,CAAC,aAAa,KAAK,SAAS,CAAC,IAAI,EAAE,EAAE;gBAClD,KAAK,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;aACnG;QACH,CAAC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAA+B,CAAC;QACxD,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACvB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACjC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3B,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QACzC,OAAO,GAAG,CAAC;IACb,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,KAAK;YACZ,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACzC,IAAI,IAAI,CAAC,MAAM;YACb,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC5C,CAAC;CACF;AAxGD,oDAwGC;AAED,cAAc;AACd,WAAiB,oBAAoB;IACnC;;OAEG;IACH,IAAY,IASX;IATD,WAAY,IAAI;QACd,oFAAoF;QACpF,2BAAmB,CAAA;QACnB,yFAAyF;QACzF,qCAA6B,CAAA;QAC7B;;WAEG;QACH,uBAAe,CAAA;IACjB,CAAC,EATW,IAAI,GAAJ,yBAAI,KAAJ,yBAAI,QASf;AACH,CAAC,EAdgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAcpC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module ElementAspects\r\n */\r\n\r\nimport { ChannelRootAspectProps, ElementAspectProps, EntityReferenceSet, ExternalSourceAspectProps, RelatedElement } from \"@itwin/core-common\";\r\nimport { Entity } from \"./Entity\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { ECSqlStatement } from \"./ECSqlStatement\";\r\nimport { DbResult, Id64String } from \"@itwin/core-bentley\";\r\n\r\n/** Argument for the `ElementAspect.onXxx` static methods\r\n * @beta\r\n */\r\nexport interface OnAspectArg {\r\n  /** The iModel for the aspect affected by this event. */\r\n  iModel: IModelDb;\r\n  /** The model for the aspect affected by this event */\r\n  model: Id64String;\r\n}\r\n/** Argument for the `ElementAspect.onXxx` static methods that supply the properties of an aspect to be inserted or updated.\r\n * @beta\r\n */\r\nexport interface OnAspectPropsArg extends OnAspectArg {\r\n  /** The new properties of the aspect affected by this event. */\r\n  props: Readonly<ElementAspectProps>;\r\n}\r\n/** Argument for the `ElementAspect.onXxx` static methods that only supply the Id of the affected aspect.\r\n * @beta\r\n */\r\nexport interface OnAspectIdArg extends OnAspectArg {\r\n  /** The Id of the aspect affected by this event */\r\n  aspectId: Id64String;\r\n}\r\n\r\n/** An Element Aspect is a class that defines a set of properties that are related to (and owned by) a single element.\r\n * Semantically, an ElementAspect can be considered part of the Element. Thus, an ElementAspect is deleted if its owning Element is deleted.\r\n * BIS Guideline: Subclass ElementUniqueAspect or ElementMultiAspect rather than subclassing ElementAspect directly.\r\n * @public\r\n */\r\nexport class ElementAspect extends Entity {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ElementAspect\"; }\r\n  public element: RelatedElement;\r\n\r\n  /** @internal */\r\n  constructor(props: ElementAspectProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.element = RelatedElement.fromJSON(props.element)!; // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n  }\r\n\r\n  /** @internal */\r\n  public override toJSON(): ElementAspectProps {\r\n    const val = super.toJSON() as ElementAspectProps;\r\n    val.element = this.element;\r\n    return val;\r\n  }\r\n\r\n  /** Called before a new ElementAspect is inserted.\r\n   * @note throw an exception to disallow the insert\r\n   * @note If you override this method, you must call super.\r\n   * @beta\r\n   */\r\n  protected static onInsert(arg: OnAspectPropsArg): void {\r\n    arg.iModel.channels.verifyChannel(arg.model);\r\n  }\r\n\r\n  /** Called after a new ElementAspect was inserted.\r\n   * @note If you override this method, you must call super.\r\n   * @beta\r\n   */\r\n  protected static onInserted(_arg: OnAspectPropsArg): void { }\r\n\r\n  /** Called before an ElementAspect is updated.\r\n   * @note throw an exception to disallow the update\r\n   * @note If you override this method, you must call super.\r\n   * @beta\r\n   */\r\n  protected static onUpdate(arg: OnAspectPropsArg): void {\r\n    arg.iModel.channels.verifyChannel(arg.model);\r\n  }\r\n\r\n  /** Called after an ElementAspect was updated.\r\n   * @note If you override this method, you must call super.\r\n   * @beta\r\n   */\r\n  protected static onUpdated(_arg: OnAspectPropsArg): void { }\r\n\r\n  /** Called before an ElementAspect is deleted.\r\n   * @note throw an exception to disallow the delete\r\n   * @note If you override this method, you must call super.\r\n   * @beta\r\n   */\r\n  protected static onDelete(arg: OnAspectIdArg): void {\r\n    arg.iModel.channels.verifyChannel(arg.model);\r\n  }\r\n\r\n  /** Called after an ElementAspect was deleted.\r\n   * @note If you override this method, you must call super.\r\n   * @beta\r\n   */\r\n  protected static onDeleted(_arg: OnAspectIdArg): void { }\r\n}\r\n\r\n/** An Element Unique Aspect is an ElementAspect where there can be only zero or one instance of the Element Aspect class per Element.\r\n * @public\r\n */\r\nexport class ElementUniqueAspect extends ElementAspect {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ElementUniqueAspect\"; }\r\n}\r\n\r\n/** An Element Multi-Aspect is an ElementAspect where there can be **n** instances of the Element Aspect class per Element.\r\n * @public\r\n */\r\nexport class ElementMultiAspect extends ElementAspect {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ElementMultiAspect\"; }\r\n}\r\n\r\n/**\r\n * @public\r\n */\r\nexport class ChannelRootAspect extends ElementUniqueAspect {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ChannelRootAspect\"; }\r\n  /** Insert a ChannelRootAspect on the specified element.\r\n   * @deprecated in 4.0 use [[ChannelControl.makeChannelRoot]]. This method does not enforce the rule that channels may not nest and is therefore dangerous.\r\n   */\r\n  public static insert(iModel: IModelDb, ownerId: Id64String, channelName: string) {\r\n    const props: ChannelRootAspectProps = { classFullName: this.classFullName, element: { id: ownerId }, owner: channelName };\r\n    iModel.elements.insertAspect(props);\r\n  }\r\n}\r\n\r\n/** An ElementMultiAspect that stores synchronization information for an Element originating from an external source.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.2\r\n * @public\r\n */\r\nexport class ExternalSourceAspect extends ElementMultiAspect {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ExternalSourceAspect\"; }\r\n\r\n  /** An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source.\r\n   * @note Warning: in a future major release the `scope` property will be optional, since the scope is intended to be potentially invalid.\r\n   *       all references should treat it as potentially undefined, but we cannot change the type yet since that is a breaking change.\r\n   */\r\n  public scope: RelatedElement;\r\n  /** The identifier of the object in the source repository. */\r\n  public identifier: string;\r\n  /** The kind of object within the source repository. */\r\n  public kind: string;\r\n  /** The cryptographic hash (any algorithm) of the source object's content. If defined, it must be guaranteed to change when the source object's content changes. */\r\n  public checksum?: string;\r\n  /** An optional value that is typically a version number or a pseudo version number like last modified time.\r\n   * It will be used by the synchronization process to detect that a source object is unchanged so that computing a cryptographic hash can be avoided.\r\n   * If present, this value must be guaranteed to change when any of the source object's content changes.\r\n   */\r\n  public version?: string;\r\n  /** A place where additional JSON properties can be stored. For example, provenance information or properties relating to the synchronization process.\r\n   * @note Warning: in a future major release, the type of `jsonProperties` will be changed to object, and itwin.js will automatically stringify it when writing to the iModel.\r\n   * This will be a breaking change, since application code will have to change from supplying a string to supplying an object.\r\n   */\r\n  public jsonProperties?: string;\r\n  /** The source of the imported/synchronized object. Should point to an instance of [ExternalSource]($backend). */\r\n  public source?: RelatedElement;\r\n\r\n  /** @internal */\r\n  constructor(props: ExternalSourceAspectProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.scope = RelatedElement.fromJSON(props.scope)!; // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n    this.source = RelatedElement.fromJSON(props.source);\r\n    this.identifier = props.identifier;\r\n    this.kind = props.kind;\r\n    this.checksum = props.checksum;\r\n    this.version = props.version;\r\n    this.jsonProperties = props.jsonProperties;\r\n  }\r\n\r\n  /** @deprecated in 3.x. findAllBySource */\r\n  public static findBySource(iModelDb: IModelDb, scope: Id64String, kind: string, identifier: string): { elementId?: Id64String, aspectId?: Id64String } {\r\n    const sql = `SELECT Element.Id, ECInstanceId FROM ${ExternalSourceAspect.classFullName} WHERE (Scope.Id=:scope AND Kind=:kind AND Identifier=:identifier)`;\r\n    let elementId: Id64String | undefined;\r\n    let aspectId: Id64String | undefined;\r\n    iModelDb.withPreparedStatement(sql, (statement: ECSqlStatement) => {\r\n      statement.bindId(\"scope\", scope);\r\n      statement.bindString(\"kind\", kind);\r\n      statement.bindString(\"identifier\", identifier);\r\n      if (DbResult.BE_SQLITE_ROW === statement.step()) {\r\n        elementId = statement.getValue(0).getId();\r\n        aspectId = statement.getValue(1).getId();\r\n      }\r\n    });\r\n    return { elementId, aspectId };\r\n  }\r\n\r\n  /** Look up the elements that contain one or more ExternalSourceAspect with the specified Scope, Kind, and Identifier.\r\n   * The result of this function is an array of all of the ExternalSourceAspects that were found, each associated with the owning element.\r\n   * A given element could have more than one ExternalSourceAspect with the given scope, kind, and identifier.\r\n   * Also, many elements could have ExternalSourceAspect with the same scope, kind, and identifier.\r\n   * Therefore, the result array could have more than one entry with the same elementId.\r\n   * Aspects are never shared. Each aspect has its own unique ECInstanceId.\r\n   * @param iModelDb The iModel to query\r\n   * @param scope    The scope of the ExternalSourceAspects to find\r\n   * @param kind     The kind of the ExternalSourceAspects to find\r\n   * @param identifier The identifier of the ExternalSourceAspects to find\r\n   * @returns the query results\r\n  */\r\n  public static findAllBySource(iModelDb: IModelDb, scope: Id64String, kind: string, identifier: string): Array<{ elementId: Id64String, aspectId: Id64String }> {\r\n    const sql = `SELECT Element.Id, ECInstanceId FROM ${ExternalSourceAspect.classFullName} WHERE (Scope.Id=:scope AND Kind=:kind AND Identifier=:identifier)`;\r\n    const found: Array<{ elementId: Id64String, aspectId: Id64String }> = [];\r\n    iModelDb.withPreparedStatement(sql, (statement: ECSqlStatement) => {\r\n      statement.bindId(\"scope\", scope);\r\n      statement.bindString(\"kind\", kind);\r\n      statement.bindString(\"identifier\", identifier);\r\n      while (DbResult.BE_SQLITE_ROW === statement.step()) {\r\n        found.push({ elementId: statement.getValue(0).getId(), aspectId: statement.getValue(1).getId() });\r\n      }\r\n    });\r\n    return found;\r\n  }\r\n\r\n  /** @internal */\r\n  public override toJSON(): ExternalSourceAspectProps {\r\n    const val = super.toJSON() as ExternalSourceAspectProps;\r\n    val.scope = this.scope;\r\n    val.source = this.source;\r\n    val.identifier = this.identifier;\r\n    val.kind = this.kind;\r\n    val.checksum = this.checksum;\r\n    val.version = this.version;\r\n    val.jsonProperties = this.jsonProperties;\r\n    return val;\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    if (this.scope)\r\n      referenceIds.addElement(this.scope.id);\r\n    referenceIds.addElement(this.element.id);\r\n    if (this.source)\r\n      referenceIds.addElement(this.source.id);\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace ExternalSourceAspect { // eslint-disable-line no-redeclare\r\n  /** Standard values for the `Kind` property of `ExternalSourceAspect`.\r\n   * @public\r\n   */\r\n  export enum Kind {\r\n    /** Indicates that the [[ExternalSourceAspect]] is storing [[Element]] provenance */\r\n    Element = \"Element\",\r\n    /** Indicates that the [[ExternalSourceAspect]] is storing [[Relationship]] provenance */\r\n    Relationship = \"Relationship\",\r\n    /** Indicates that the [[ExternalSourceAspect]] is storing *scope* provenance\r\n     * @see [[ExternalSourceAspect.scope]]\r\n     */\r\n    Scope = \"Scope\",\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ElementAspect.js","sourceRoot":"","sources":["../../src/ElementAspect.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAA+I;AAC/I,qCAAkC;AAGlC,sDAA2D;AA0B3D;;;;GAIG;AACH,MAAa,aAAc,SAAQ,eAAM;IACvC,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,eAAe,CAAC,CAAC,CAAC;IAG1E,kFAAkF;IAClF,YAAY,KAAyB,EAAE,MAAgB;QACrD,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,4BAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAE,CAAC,CAAC,+DAA+D;IACzH,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAwB,CAAC;QACjD,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3B,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAqB;QAC7C,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,UAAU,CAAC,IAAsB,IAAU,CAAC;IAE7D;;;;OAIG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAqB;QAC7C,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,SAAS,CAAC,IAAsB,IAAU,CAAC;IAE5D;;;;OAIG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAkB;QAC1C,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,SAAS,CAAC,IAAmB,IAAU,CAAC;CAC1D;AA7DD,sCA6DC;AAED;;GAEG;AACH,MAAa,mBAAoB,SAAQ,aAAa;IACpD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;CACjF;AAHD,kDAGC;AAED;;GAEG;AACH,MAAa,kBAAmB,SAAQ,aAAa;IACnD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,oBAAoB,CAAC,CAAC,CAAC;CAChF;AAHD,gDAGC;AAED;;GAEG;AACH,MAAa,iBAAkB,SAAQ,mBAAmB;IACxD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,mBAAmB,CAAC,CAAC,CAAC;IAC9E;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,MAAgB,EAAE,OAAmB,EAAE,WAAmB;QAC7E,MAAM,KAAK,GAA2B,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;QAC1H,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;CACF;AAVD,8CAUC;AAED;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,kBAAkB;IAC1D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IA0BjF,kFAAkF;IAClF,YAAY,KAAgC,EAAE,MAAgB;QAC5D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,4BAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAE,CAAC,CAAC,+DAA+D;QACnH,IAAI,CAAC,MAAM,GAAG,4BAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;IAC7C,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,YAAY,CAAC,QAAkB,EAAE,KAAiB,EAAE,IAAY,EAAE,UAAkB;QAChG,MAAM,GAAG,GAAG,wCAAwC,oBAAoB,CAAC,aAAa,oEAAoE,CAAC;QAC3J,IAAI,SAAiC,CAAC;QACtC,IAAI,QAAgC,CAAC;QACrC,QAAQ,CAAC,qBAAqB,CAAC,GAAG,EAAE,CAAC,SAAyB,EAAE,EAAE;YAChE,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACjC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACnC,SAAS,CAAC,UAAU,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;YAC/C,IAAI,uBAAQ,CAAC,aAAa,KAAK,SAAS,CAAC,IAAI,EAAE,EAAE;gBAC/C,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;gBAC1C,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;aAC1C;QACH,CAAC,CAAC,CAAC;QACH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;MAWE;IACK,MAAM,CAAC,eAAe,CAAC,QAAkB,EAAE,KAAiB,EAAE,IAAY,EAAE,UAAkB;QACnG,MAAM,GAAG,GAAG,wCAAwC,oBAAoB,CAAC,aAAa,oEAAoE,CAAC;QAC3J,MAAM,KAAK,GAA2D,EAAE,CAAC;QACzE,QAAQ,CAAC,qBAAqB,CAAC,GAAG,EAAE,CAAC,SAAyB,EAAE,EAAE;YAChE,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACjC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACnC,SAAS,CAAC,UAAU,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;YAC/C,OAAO,uBAAQ,CAAC,aAAa,KAAK,SAAS,CAAC,IAAI,EAAE,EAAE;gBAClD,KAAK,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;aACnG;QACH,CAAC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAA+B,CAAC;QACxD,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACvB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACjC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3B,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QACzC,OAAO,GAAG,CAAC;IACb,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,KAAK;YACZ,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACzC,IAAI,IAAI,CAAC,MAAM;YACb,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC5C,CAAC;CACF;AAvGD,oDAuGC;AAED,cAAc;AACd,WAAiB,oBAAoB;IACnC;;OAEG;IACH,IAAY,IASX;IATD,WAAY,IAAI;QACd,oFAAoF;QACpF,2BAAmB,CAAA;QACnB,yFAAyF;QACzF,qCAA6B,CAAA;QAC7B;;WAEG;QACH,uBAAe,CAAA;IACjB,CAAC,EATW,IAAI,GAAJ,yBAAI,KAAJ,yBAAI,QASf;AACH,CAAC,EAdgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAcpC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module ElementAspects\r\n */\r\n\r\nimport { ChannelRootAspectProps, ElementAspectProps, EntityReferenceSet, ExternalSourceAspectProps, RelatedElement } from \"@itwin/core-common\";\r\nimport { Entity } from \"./Entity\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { ECSqlStatement } from \"./ECSqlStatement\";\r\nimport { DbResult, Id64String } from \"@itwin/core-bentley\";\r\n\r\n/** Argument for the `ElementAspect.onXxx` static methods\r\n * @beta\r\n */\r\nexport interface OnAspectArg {\r\n  /** The iModel for the aspect affected by this event. */\r\n  iModel: IModelDb;\r\n  /** The model for the aspect affected by this event */\r\n  model: Id64String;\r\n}\r\n/** Argument for the `ElementAspect.onXxx` static methods that supply the properties of an aspect to be inserted or updated.\r\n * @beta\r\n */\r\nexport interface OnAspectPropsArg extends OnAspectArg {\r\n  /** The new properties of the aspect affected by this event. */\r\n  props: Readonly<ElementAspectProps>;\r\n}\r\n/** Argument for the `ElementAspect.onXxx` static methods that only supply the Id of the affected aspect.\r\n * @beta\r\n */\r\nexport interface OnAspectIdArg extends OnAspectArg {\r\n  /** The Id of the aspect affected by this event */\r\n  aspectId: Id64String;\r\n}\r\n\r\n/** An Element Aspect is a class that defines a set of properties that are related to (and owned by) a single element.\r\n * Semantically, an ElementAspect can be considered part of the Element. Thus, an ElementAspect is deleted if its owning Element is deleted.\r\n * BIS Guideline: Subclass ElementUniqueAspect or ElementMultiAspect rather than subclassing ElementAspect directly.\r\n * @public\r\n */\r\nexport class ElementAspect extends Entity {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ElementAspect\"; }\r\n  public element: RelatedElement;\r\n\r\n  /** Construct an aspect from its JSON representation and its containing iModel. */\r\n  constructor(props: ElementAspectProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.element = RelatedElement.fromJSON(props.element)!; // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n  }\r\n\r\n  public override toJSON(): ElementAspectProps {\r\n    const val = super.toJSON() as ElementAspectProps;\r\n    val.element = this.element;\r\n    return val;\r\n  }\r\n\r\n  /** Called before a new ElementAspect is inserted.\r\n   * @note throw an exception to disallow the insert\r\n   * @note If you override this method, you must call super.\r\n   * @beta\r\n   */\r\n  protected static onInsert(arg: OnAspectPropsArg): void {\r\n    arg.iModel.channels.verifyChannel(arg.model);\r\n  }\r\n\r\n  /** Called after a new ElementAspect was inserted.\r\n   * @note If you override this method, you must call super.\r\n   * @beta\r\n   */\r\n  protected static onInserted(_arg: OnAspectPropsArg): void { }\r\n\r\n  /** Called before an ElementAspect is updated.\r\n   * @note throw an exception to disallow the update\r\n   * @note If you override this method, you must call super.\r\n   * @beta\r\n   */\r\n  protected static onUpdate(arg: OnAspectPropsArg): void {\r\n    arg.iModel.channels.verifyChannel(arg.model);\r\n  }\r\n\r\n  /** Called after an ElementAspect was updated.\r\n   * @note If you override this method, you must call super.\r\n   * @beta\r\n   */\r\n  protected static onUpdated(_arg: OnAspectPropsArg): void { }\r\n\r\n  /** Called before an ElementAspect is deleted.\r\n   * @note throw an exception to disallow the delete\r\n   * @note If you override this method, you must call super.\r\n   * @beta\r\n   */\r\n  protected static onDelete(arg: OnAspectIdArg): void {\r\n    arg.iModel.channels.verifyChannel(arg.model);\r\n  }\r\n\r\n  /** Called after an ElementAspect was deleted.\r\n   * @note If you override this method, you must call super.\r\n   * @beta\r\n   */\r\n  protected static onDeleted(_arg: OnAspectIdArg): void { }\r\n}\r\n\r\n/** An Element Unique Aspect is an ElementAspect where there can be only zero or one instance of the Element Aspect class per Element.\r\n * @public\r\n */\r\nexport class ElementUniqueAspect extends ElementAspect {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ElementUniqueAspect\"; }\r\n}\r\n\r\n/** An Element Multi-Aspect is an ElementAspect where there can be **n** instances of the Element Aspect class per Element.\r\n * @public\r\n */\r\nexport class ElementMultiAspect extends ElementAspect {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ElementMultiAspect\"; }\r\n}\r\n\r\n/**\r\n * @public\r\n */\r\nexport class ChannelRootAspect extends ElementUniqueAspect {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ChannelRootAspect\"; }\r\n  /** Insert a ChannelRootAspect on the specified element.\r\n   * @deprecated in 4.0 use [[ChannelControl.makeChannelRoot]]. This method does not enforce the rule that channels may not nest and is therefore dangerous.\r\n   */\r\n  public static insert(iModel: IModelDb, ownerId: Id64String, channelName: string) {\r\n    const props: ChannelRootAspectProps = { classFullName: this.classFullName, element: { id: ownerId }, owner: channelName };\r\n    iModel.elements.insertAspect(props);\r\n  }\r\n}\r\n\r\n/** An ElementMultiAspect that stores synchronization information for an Element originating from an external source.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.2\r\n * @public\r\n */\r\nexport class ExternalSourceAspect extends ElementMultiAspect {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ExternalSourceAspect\"; }\r\n\r\n  /** An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source.\r\n   * @note Warning: in a future major release the `scope` property will be optional, since the scope is intended to be potentially invalid.\r\n   *       all references should treat it as potentially undefined, but we cannot change the type yet since that is a breaking change.\r\n   */\r\n  public scope: RelatedElement;\r\n  /** The identifier of the object in the source repository. */\r\n  public identifier: string;\r\n  /** The kind of object within the source repository. */\r\n  public kind: string;\r\n  /** The cryptographic hash (any algorithm) of the source object's content. If defined, it must be guaranteed to change when the source object's content changes. */\r\n  public checksum?: string;\r\n  /** An optional value that is typically a version number or a pseudo version number like last modified time.\r\n   * It will be used by the synchronization process to detect that a source object is unchanged so that computing a cryptographic hash can be avoided.\r\n   * If present, this value must be guaranteed to change when any of the source object's content changes.\r\n   */\r\n  public version?: string;\r\n  /** A place where additional JSON properties can be stored. For example, provenance information or properties relating to the synchronization process.\r\n   * @note Warning: in a future major release, the type of `jsonProperties` will be changed to object, and itwin.js will automatically stringify it when writing to the iModel.\r\n   * This will be a breaking change, since application code will have to change from supplying a string to supplying an object.\r\n   */\r\n  public jsonProperties?: string;\r\n  /** The source of the imported/synchronized object. Should point to an instance of [ExternalSource]($backend). */\r\n  public source?: RelatedElement;\r\n\r\n  /** Construct an aspect from its JSON representation and its containing iModel. */\r\n  constructor(props: ExternalSourceAspectProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.scope = RelatedElement.fromJSON(props.scope)!; // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n    this.source = RelatedElement.fromJSON(props.source);\r\n    this.identifier = props.identifier;\r\n    this.kind = props.kind;\r\n    this.checksum = props.checksum;\r\n    this.version = props.version;\r\n    this.jsonProperties = props.jsonProperties;\r\n  }\r\n\r\n  /** @deprecated in 3.x. findAllBySource */\r\n  public static findBySource(iModelDb: IModelDb, scope: Id64String, kind: string, identifier: string): { elementId?: Id64String, aspectId?: Id64String } {\r\n    const sql = `SELECT Element.Id, ECInstanceId FROM ${ExternalSourceAspect.classFullName} WHERE (Scope.Id=:scope AND Kind=:kind AND Identifier=:identifier)`;\r\n    let elementId: Id64String | undefined;\r\n    let aspectId: Id64String | undefined;\r\n    iModelDb.withPreparedStatement(sql, (statement: ECSqlStatement) => {\r\n      statement.bindId(\"scope\", scope);\r\n      statement.bindString(\"kind\", kind);\r\n      statement.bindString(\"identifier\", identifier);\r\n      if (DbResult.BE_SQLITE_ROW === statement.step()) {\r\n        elementId = statement.getValue(0).getId();\r\n        aspectId = statement.getValue(1).getId();\r\n      }\r\n    });\r\n    return { elementId, aspectId };\r\n  }\r\n\r\n  /** Look up the elements that contain one or more ExternalSourceAspect with the specified Scope, Kind, and Identifier.\r\n   * The result of this function is an array of all of the ExternalSourceAspects that were found, each associated with the owning element.\r\n   * A given element could have more than one ExternalSourceAspect with the given scope, kind, and identifier.\r\n   * Also, many elements could have ExternalSourceAspect with the same scope, kind, and identifier.\r\n   * Therefore, the result array could have more than one entry with the same elementId.\r\n   * Aspects are never shared. Each aspect has its own unique ECInstanceId.\r\n   * @param iModelDb The iModel to query\r\n   * @param scope    The scope of the ExternalSourceAspects to find\r\n   * @param kind     The kind of the ExternalSourceAspects to find\r\n   * @param identifier The identifier of the ExternalSourceAspects to find\r\n   * @returns the query results\r\n  */\r\n  public static findAllBySource(iModelDb: IModelDb, scope: Id64String, kind: string, identifier: string): Array<{ elementId: Id64String, aspectId: Id64String }> {\r\n    const sql = `SELECT Element.Id, ECInstanceId FROM ${ExternalSourceAspect.classFullName} WHERE (Scope.Id=:scope AND Kind=:kind AND Identifier=:identifier)`;\r\n    const found: Array<{ elementId: Id64String, aspectId: Id64String }> = [];\r\n    iModelDb.withPreparedStatement(sql, (statement: ECSqlStatement) => {\r\n      statement.bindId(\"scope\", scope);\r\n      statement.bindString(\"kind\", kind);\r\n      statement.bindString(\"identifier\", identifier);\r\n      while (DbResult.BE_SQLITE_ROW === statement.step()) {\r\n        found.push({ elementId: statement.getValue(0).getId(), aspectId: statement.getValue(1).getId() });\r\n      }\r\n    });\r\n    return found;\r\n  }\r\n\r\n  public override toJSON(): ExternalSourceAspectProps {\r\n    const val = super.toJSON() as ExternalSourceAspectProps;\r\n    val.scope = this.scope;\r\n    val.source = this.source;\r\n    val.identifier = this.identifier;\r\n    val.kind = this.kind;\r\n    val.checksum = this.checksum;\r\n    val.version = this.version;\r\n    val.jsonProperties = this.jsonProperties;\r\n    return val;\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    if (this.scope)\r\n      referenceIds.addElement(this.scope.id);\r\n    referenceIds.addElement(this.element.id);\r\n    if (this.source)\r\n      referenceIds.addElement(this.source.id);\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace ExternalSourceAspect { // eslint-disable-line no-redeclare\r\n  /** Standard values for the `Kind` property of `ExternalSourceAspect`.\r\n   * @public\r\n   */\r\n  export enum Kind {\r\n    /** Indicates that the [[ExternalSourceAspect]] is storing [[Element]] provenance */\r\n    Element = \"Element\",\r\n    /** Indicates that the [[ExternalSourceAspect]] is storing [[Relationship]] provenance */\r\n    Relationship = \"Relationship\",\r\n    /** Indicates that the [[ExternalSourceAspect]] is storing *scope* provenance\r\n     * @see [[ExternalSourceAspect.scope]]\r\n     */\r\n    Scope = \"Scope\",\r\n  }\r\n}\r\n"]}

package/lib/cjs/Entity.d.ts

@@ -37,8 +37,11 @@ export declare class Entity {
     iModel: IModelDb;
     /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */
     id: Id64String;
-    /** @internal */
-    constructor(props: EntityProps, iModel: IModelDb);
+    protected constructor(props: EntityProps, iModel: IModelDb);
+    /** Invoke the constructor of the specified `Entity` subclass.
+     * @internal
+     */
+    static instantiate(subclass: typeof Entity, props: EntityProps, iModel: IModelDb): Entity;
     /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -
      * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).
      */

package/lib/cjs/Entity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,gBAAgB,EAAoB,MAAM,oBAAoB,CAAC;AACzG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;GAIG;AACH,qBAAa,MAAM;IACjB;;OAEG;IACH,SAAgB,kBAAkB,OAAiB;IACnD,0CAA0C;IAC1C,OAAc,MAAM,EAAE,OAAO,MAAM,CAAC;IAEpC,OAAO,KAAK,KAAK,GAA+D;IAEhF;;;;OAIG;IACH,WAAkB,SAAS,IAAI,MAAM,CAAqB;IAE1D;;;OAGG;IACH,IAAW,KAAK,IAAI,GAAG,CAAiB;IAExC,yDAAyD;IACzD,IAAW,UAAU,IAAI,MAAM,CAAyC;IAExE,4DAA4D;IAC5D,IAAW,SAAS,IAAI,MAAM,CAAiC;IAE/D,iDAAiD;IAC1C,MAAM,EAAE,QAAQ,CAAC;IAExB,kGAAkG;IAC3F,EAAE,EAAE,UAAU,CAAC;IAEtB,gBAAgB;gBACJ,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ;IAOhD;;OAEG;IACI,MAAM,IAAI,WAAW;IAS5B;;;;OAIG;IACI,eAAe,CAAC,IAAI,EAAE,gBAAgB,EAAE,aAAa,GAAE,OAAc;IAI5E,4EAA4E;IAC5E,WAAkB,aAAa,IAAI,MAAM,CAA0D;IAEnG,6EAA6E;IAC7E,IAAW,aAAa,IAAI,MAAM,CAAqC;IAEvE,gBAAgB;IAChB,WAAkB,mBAAmB,IAAI,MAAM,EAAE,CAAe;IAEhE;;;;;OAKG;WACW,EAAE,CAAC,UAAU,EAAE,OAAO,MAAM,GAAG,OAAO;IAEpD;;;OAGG;IACH,WAAkB,gBAAgB,YAAoB;IAEtD;;;;;OAKG;IACI,eAAe,IAAI,kBAAkB;IAM5C;;;OAGG;IAEI,uBAAuB,QAXJ,kBAAkB,CAWU;IAEtD;;;;;;;OAOG;IACH,SAAS,CAAC,mBAAmB,CAAC,aAAa,EAAE,kBAAkB,GAAG,IAAI;IAItE;;;OAGG;IAEH,SAAS,CAAC,2BAA2B,kBATQ,kBAAkB,KAAG,IAAI,CASL;CAClE;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,QAAQ,GAAG;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,CAAC"}
+{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,gBAAgB,EAAoB,MAAM,oBAAoB,CAAC;AACzG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;GAIG;AACH,qBAAa,MAAM;IACjB;;OAEG;IACH,SAAgB,kBAAkB,OAAiB;IACnD,0CAA0C;IAC1C,OAAc,MAAM,EAAE,OAAO,MAAM,CAAC;IAEpC,OAAO,KAAK,KAAK,GAA+D;IAEhF;;;;OAIG;IACH,WAAkB,SAAS,IAAI,MAAM,CAAqB;IAE1D;;;OAGG;IACH,IAAW,KAAK,IAAI,GAAG,CAAiB;IAExC,yDAAyD;IACzD,IAAW,UAAU,IAAI,MAAM,CAAyC;IAExE,4DAA4D;IAC5D,IAAW,SAAS,IAAI,MAAM,CAAiC;IAE/D,iDAAiD;IAC1C,MAAM,EAAE,QAAQ,CAAC;IAExB,kGAAkG;IAC3F,EAAE,EAAE,UAAU,CAAC;IAEtB,SAAS,aAAa,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ;IAO1D;;OAEG;WACW,WAAW,CAAC,QAAQ,EAAE,OAAO,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,GAAG,MAAM;IAIhG;;OAEG;IACI,MAAM,IAAI,WAAW;IAS5B;;;;OAIG;IACI,eAAe,CAAC,IAAI,EAAE,gBAAgB,EAAE,aAAa,GAAE,OAAc;IAI5E,4EAA4E;IAC5E,WAAkB,aAAa,IAAI,MAAM,CAA0D;IAEnG,6EAA6E;IAC7E,IAAW,aAAa,IAAI,MAAM,CAAqC;IAEvE,gBAAgB;IAChB,WAAkB,mBAAmB,IAAI,MAAM,EAAE,CAAe;IAEhE;;;;;OAKG;WACW,EAAE,CAAC,UAAU,EAAE,OAAO,MAAM,GAAG,OAAO;IAKpD;;;OAGG;IACH,WAAkB,gBAAgB,YAAoB;IAEtD;;;;;OAKG;IACI,eAAe,IAAI,kBAAkB;IAM5C;;;OAGG;IAEI,uBAAuB,QAXJ,kBAAkB,CAWU;IAEtD;;;;;;;OAOG;IACH,SAAS,CAAC,mBAAmB,CAAC,aAAa,EAAE,kBAAkB,GAAG,IAAI;IAItE;;;OAGG;IAEH,SAAS,CAAC,2BAA2B,kBATQ,kBAAkB,KAAG,IAAI,CASL;CAClE;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,QAAQ,GAAG;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,CAAC"}

package/lib/cjs/Entity.js

@@ -32,7 +32,6 @@ class Entity {
     get schemaName() { return this._ctor.schema.schemaName; }
     /** The name of the BIS class associated with this class. */
     get className() { return this._ctor.className; }
-    /** @internal */
     constructor(props, iModel) {
         /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types
          * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].
@@ -55,6 +54,12 @@ class Entity {
         // copy all auto-handled properties from input to the object being constructed
         this.forEachProperty((propName, meta) => this[propName] = meta.createProperty(props[propName]), false);
     }
+    /** Invoke the constructor of the specified `Entity` subclass.
+     * @internal
+     */
+    static instantiate(subclass, props, iModel) {
+        return new subclass(props, iModel);
+    }
     /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -
      * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).
      */
@@ -86,7 +91,10 @@ class Entity {
      * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of
      * typescript's restriction on the `this` type in static methods
      */
-    static is(otherClass) { return (0, core_bentley_1.isSubclassOf)(this, otherClass); }
+    static is(otherClass) {
+        // inline of @itwin/core-bentley's isSubclassOf due to protected constructor.
+        return this === otherClass || this.prototype instanceof otherClass;
+    }
     /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation
      * ClassRegistry overrides this when generating a class
      * @internal

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,sDAAqE;AACrE,oDAAyG;AAIzG;;;;GAIG;AACH,MAAa,MAAM;IAQjB,IAAY,KAAK,KAAoB,OAAO,IAAI,CAAC,WAA4B,CAAC,CAAC,CAAC;IAEhF;;;;OAIG;IACI,MAAM,KAAK,SAAS,KAAa,OAAO,QAAQ,CAAC,CAAC,CAAC;IAE1D;;;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;IAQ/D,gBAAgB;IAChB,YAAY,KAAkB,EAAE,MAAgB;QAnChD;;WAEG;QACa,uBAAkB,GAAG,IAAa,CAAC;QA+FnD;;;WAGG;QACH,6DAA6D;QACtD,4BAAuB,GAAG,IAAI,CAAC,eAAe,CAAC;QActD;;;WAGG;QACH,6DAA6D;QACnD,gCAA2B,GAAG,IAAI,CAAC,mBAAmB,CAAC;QAtF/D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,8EAA8E;QAC9E,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;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,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;;;;OAIG;IACI,eAAe,CAAC,IAAsB,EAAE,gBAAyB,IAAI;QAC1E,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IAC7E,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;IAEvE,gBAAgB;IACT,MAAM,KAAK,mBAAmB,KAAe,OAAO,EAAE,CAAC,CAAC,CAAC;IAEhE;;;;;OAKG;IACI,MAAM,CAAC,EAAE,CAAC,UAAyB,IAAa,OAAO,IAAA,2BAAY,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAE/F;;;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;IASD;;;;;;;OAOG;IACO,mBAAmB,CAAC,aAAiC;QAC7D,OAAO,CAAC,2BAA2B;IACrC,CAAC;CAQF;AA5HD,wBA4HC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Schema\r\n */\r\n\r\nimport { Id64, Id64String, isSubclassOf } from \"@itwin/core-bentley\";\r\nimport { EntityProps, EntityReferenceSet, PropertyCallback, PropertyMetaData } from \"@itwin/core-common\";\r\nimport type { IModelDb } from \"./IModelDb\";\r\nimport { Schema } from \"./Schema\";\r\n\r\n/** Represents an entity in an [[IModelDb]] such as an [[Element]], [[Model]], or [[Relationship]].\r\n * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).\r\n * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].\r\n * @public\r\n */\r\nexport class Entity {\r\n  /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types\r\n   * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].\r\n   */\r\n  public readonly isInstanceOfEntity = true as const;\r\n  /** The Schema that defines this class. */\r\n  public static schema: typeof Schema;\r\n\r\n  private get _ctor(): typeof Entity { return this.constructor as typeof Entity; }\r\n\r\n  /** The name of the BIS class associated with this class.\r\n   * @note Every subclass of Entity **MUST** override this method to identify its BIS class.\r\n   * Failure to do so will ordinarily result in an error when the class is registered, since there may only\r\n   * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)\r\n   */\r\n  public static get className(): string { return \"Entity\"; }\r\n\r\n  /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.\r\n   * This property makes such code slightly less tedious to read and write.\r\n   * @internal\r\n   */\r\n  public get asAny(): any { return this; }\r\n\r\n  /** The name of the BIS Schema that defines this class */\r\n  public get schemaName(): string { return this._ctor.schema.schemaName; }\r\n\r\n  /** The name of the BIS class associated with this class. */\r\n  public get className(): string { return this._ctor.className; }\r\n\r\n  /** The [[IModelDb]] that contains this Entity */\r\n  public iModel: IModelDb;\r\n\r\n  /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */\r\n  public id: Id64String;\r\n\r\n  /** @internal */\r\n  constructor(props: EntityProps, iModel: IModelDb) {\r\n    this.iModel = iModel;\r\n    this.id = Id64.fromJSON(props.id);\r\n    // copy all auto-handled properties from input to the object being constructed\r\n    this.forEachProperty((propName: string, meta: PropertyMetaData) => (this as any)[propName] = meta.createProperty((props as any)[propName]), false);\r\n  }\r\n\r\n  /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -\r\n   * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).\r\n   */\r\n  public toJSON(): EntityProps {\r\n    const val: any = {};\r\n    val.classFullName = this.classFullName;\r\n    if (Id64.isValid(this.id))\r\n      val.id = this.id;\r\n    this.forEachProperty((propName: string) => val[propName] = (this as any)[propName], false);\r\n    return val;\r\n  }\r\n\r\n  /** Call a function for each property of this Entity.\r\n   * @param func The callback to be invoked on each property\r\n   * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\r\n   * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\r\n   */\r\n  public forEachProperty(func: PropertyCallback, includeCustom: boolean = true) {\r\n    this.iModel.forEachMetaData(this.classFullName, true, func, includeCustom);\r\n  }\r\n\r\n  /** Get the full BIS class name of this Entity in the form \"schema:class\" */\r\n  public static get classFullName(): string { return `${this.schema.schemaName}:${this.className}`; }\r\n\r\n  /** Get the full BIS class name of this Entity in the form \"schema:class\". */\r\n  public get classFullName(): string { return this._ctor.classFullName; }\r\n\r\n  /** @internal */\r\n  public static get protectedOperations(): string[] { return []; }\r\n\r\n  /** return whether this Entity class is a subclass of another Entity class\r\n   * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's\r\n   * inheritance, you can use [ECClass.is]($ecschema-metadata)\r\n   * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of\r\n   * typescript's restriction on the `this` type in static methods\r\n   */\r\n  public static is(otherClass: typeof Entity): boolean { return isSubclassOf(this, otherClass); }\r\n\r\n  /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation\r\n   * ClassRegistry overrides this when generating a class\r\n   * @internal\r\n   */\r\n  public static get isGeneratedClass() { return false; }\r\n\r\n  /** Get the set of this entity's *entity references*, [EntityReferenceSet]($backend). An *entity reference* is any id\r\n   * stored on the entity, in its EC properties or json fields.\r\n   * This is important for cloning operations but can be useful in other situations as well.\r\n   * @see this.collectReferenceIds\r\n   * @beta\r\n   */\r\n  public getReferenceIds(): EntityReferenceSet {\r\n    const referenceIds = new EntityReferenceSet();\r\n    this.collectReferenceIds(referenceIds);\r\n    return referenceIds;\r\n  }\r\n\r\n  /** kept rename for older transformer versions\r\n   * @deprecated in 3.x . Use [[getReferenceIds]] instead\r\n   * @internal\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/unbound-method\r\n  public getReferenceConcreteIds = this.getReferenceIds;\r\n\r\n  /** Collect the Ids of this entity's *references* at this level of the class hierarchy.\r\n   * A *reference* is any entity referenced by this entity's EC Data, including json fields.\r\n   * This is important for cloning operations but can be useful in other situations as well.\r\n   * @param _referenceIds The Id64Set to populate with reference Ids.\r\n   * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.\r\n   * @see getReferenceIds\r\n   * @beta\r\n   */\r\n  protected collectReferenceIds(_referenceIds: EntityReferenceSet): void {\r\n    return; // no references by default\r\n  }\r\n\r\n  /** kept rename for older transformer versions\r\n   * @deprecated in 3.x . Use [[collectReferenceIds]] instead\r\n   * @internal\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/unbound-method\r\n  protected collectReferenceConcreteIds = this.collectReferenceIds;\r\n}\r\n\r\n/** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.\r\n * @public\r\n */\r\nexport type EntityClassType<T> = Function & { prototype: T };\r\n"]}
+{"version":3,"file":"Entity.js","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAuD;AACvD,oDAAyG;AAIzG;;;;GAIG;AACH,MAAa,MAAM;IAQjB,IAAY,KAAK,KAAoB,OAAO,IAAI,CAAC,WAA4B,CAAC,CAAC,CAAC;IAEhF;;;;OAIG;IACI,MAAM,KAAK,SAAS,KAAa,OAAO,QAAQ,CAAC,CAAC,CAAC;IAE1D;;;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;IAQ/D,YAAsB,KAAkB,EAAE,MAAgB;QAlC1D;;WAEG;QACa,uBAAkB,GAAG,IAAa,CAAC;QAwGnD;;;WAGG;QACH,6DAA6D;QACtD,4BAAuB,GAAG,IAAI,CAAC,eAAe,CAAC;QActD;;;WAGG;QACH,6DAA6D;QACnD,gCAA2B,GAAG,IAAI,CAAC,mBAAmB,CAAC;QAhG/D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,8EAA8E;QAC9E,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;;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,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;;;;OAIG;IACI,eAAe,CAAC,IAAsB,EAAE,gBAAyB,IAAI;QAC1E,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IAC7E,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;IAEvE,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;IASD;;;;;;;OAOG;IACO,mBAAmB,CAAC,aAAiC;QAC7D,OAAO,CAAC,2BAA2B;IACrC,CAAC;CAQF;AArID,wBAqIC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Schema\r\n */\r\n\r\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { EntityProps, EntityReferenceSet, PropertyCallback, PropertyMetaData } from \"@itwin/core-common\";\r\nimport type { IModelDb } from \"./IModelDb\";\r\nimport { Schema } from \"./Schema\";\r\n\r\n/** Represents an entity in an [[IModelDb]] such as an [[Element]], [[Model]], or [[Relationship]].\r\n * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).\r\n * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].\r\n * @public\r\n */\r\nexport class Entity {\r\n  /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types\r\n   * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].\r\n   */\r\n  public readonly isInstanceOfEntity = true as const;\r\n  /** The Schema that defines this class. */\r\n  public static schema: typeof Schema;\r\n\r\n  private get _ctor(): typeof Entity { return this.constructor as typeof Entity; }\r\n\r\n  /** The name of the BIS class associated with this class.\r\n   * @note Every subclass of Entity **MUST** override this method to identify its BIS class.\r\n   * Failure to do so will ordinarily result in an error when the class is registered, since there may only\r\n   * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)\r\n   */\r\n  public static get className(): string { return \"Entity\"; }\r\n\r\n  /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.\r\n   * This property makes such code slightly less tedious to read and write.\r\n   * @internal\r\n   */\r\n  public get asAny(): any { return this; }\r\n\r\n  /** The name of the BIS Schema that defines this class */\r\n  public get schemaName(): string { return this._ctor.schema.schemaName; }\r\n\r\n  /** The name of the BIS class associated with this class. */\r\n  public get className(): string { return this._ctor.className; }\r\n\r\n  /** The [[IModelDb]] that contains this Entity */\r\n  public iModel: IModelDb;\r\n\r\n  /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */\r\n  public id: Id64String;\r\n\r\n  protected constructor(props: EntityProps, iModel: IModelDb) {\r\n    this.iModel = iModel;\r\n    this.id = Id64.fromJSON(props.id);\r\n    // copy all auto-handled properties from input to the object being constructed\r\n    this.forEachProperty((propName: string, meta: PropertyMetaData) => (this as any)[propName] = meta.createProperty((props as any)[propName]), false);\r\n  }\r\n\r\n  /** Invoke the constructor of the specified `Entity` subclass.\r\n   * @internal\r\n   */\r\n  public static instantiate(subclass: typeof Entity, props: EntityProps, iModel: IModelDb): Entity {\r\n    return new subclass(props, iModel);\r\n  }\r\n\r\n  /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -\r\n   * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).\r\n   */\r\n  public toJSON(): EntityProps {\r\n    const val: any = {};\r\n    val.classFullName = this.classFullName;\r\n    if (Id64.isValid(this.id))\r\n      val.id = this.id;\r\n    this.forEachProperty((propName: string) => val[propName] = (this as any)[propName], false);\r\n    return val;\r\n  }\r\n\r\n  /** Call a function for each property of this Entity.\r\n   * @param func The callback to be invoked on each property\r\n   * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\r\n   * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\r\n   */\r\n  public forEachProperty(func: PropertyCallback, includeCustom: boolean = true) {\r\n    this.iModel.forEachMetaData(this.classFullName, true, func, includeCustom);\r\n  }\r\n\r\n  /** Get the full BIS class name of this Entity in the form \"schema:class\" */\r\n  public static get classFullName(): string { return `${this.schema.schemaName}:${this.className}`; }\r\n\r\n  /** Get the full BIS class name of this Entity in the form \"schema:class\". */\r\n  public get classFullName(): string { return this._ctor.classFullName; }\r\n\r\n  /** @internal */\r\n  public static get protectedOperations(): string[] { return []; }\r\n\r\n  /** return whether this Entity class is a subclass of another Entity class\r\n   * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's\r\n   * inheritance, you can use [ECClass.is]($ecschema-metadata)\r\n   * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of\r\n   * typescript's restriction on the `this` type in static methods\r\n   */\r\n  public static is(otherClass: typeof Entity): boolean {\r\n    // inline of @itwin/core-bentley's isSubclassOf due to protected constructor.\r\n    return this === otherClass || this.prototype instanceof otherClass;\r\n  }\r\n\r\n  /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation\r\n   * ClassRegistry overrides this when generating a class\r\n   * @internal\r\n   */\r\n  public static get isGeneratedClass() { return false; }\r\n\r\n  /** Get the set of this entity's *entity references*, [EntityReferenceSet]($backend). An *entity reference* is any id\r\n   * stored on the entity, in its EC properties or json fields.\r\n   * This is important for cloning operations but can be useful in other situations as well.\r\n   * @see this.collectReferenceIds\r\n   * @beta\r\n   */\r\n  public getReferenceIds(): EntityReferenceSet {\r\n    const referenceIds = new EntityReferenceSet();\r\n    this.collectReferenceIds(referenceIds);\r\n    return referenceIds;\r\n  }\r\n\r\n  /** kept rename for older transformer versions\r\n   * @deprecated in 3.x . Use [[getReferenceIds]] instead\r\n   * @internal\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/unbound-method\r\n  public getReferenceConcreteIds = this.getReferenceIds;\r\n\r\n  /** Collect the Ids of this entity's *references* at this level of the class hierarchy.\r\n   * A *reference* is any entity referenced by this entity's EC Data, including json fields.\r\n   * This is important for cloning operations but can be useful in other situations as well.\r\n   * @param _referenceIds The Id64Set to populate with reference Ids.\r\n   * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.\r\n   * @see getReferenceIds\r\n   * @beta\r\n   */\r\n  protected collectReferenceIds(_referenceIds: EntityReferenceSet): void {\r\n    return; // no references by default\r\n  }\r\n\r\n  /** kept rename for older transformer versions\r\n   * @deprecated in 3.x . Use [[collectReferenceIds]] instead\r\n   * @internal\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/unbound-method\r\n  protected collectReferenceConcreteIds = this.collectReferenceIds;\r\n}\r\n\r\n/** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.\r\n * @public\r\n */\r\nexport type EntityClassType<T> = Function & { prototype: T };\r\n"]}

package/lib/cjs/ExternalSource.d.ts

@@ -20,9 +20,7 @@ export declare class ExternalSource extends InformationReferenceElement {
     connectorVersion?: string;
     /** @internal */
     static get className(): string;
-    /** @internal */
-    constructor(props: ExternalSourceProps, iModel: IModelDb);
-    /** @internal */
+    protected constructor(props: ExternalSourceProps, iModel: IModelDb);
     toJSON(): ExternalSourceProps;
     /** The [[CodeSpec]] for ExternalSource elements is not automatically created, so this method ensures that it exists. */
     static ensureCodeSpec(iModelDb: IModelDb): Id64String;
@@ -55,9 +53,7 @@ export declare class ExternalSourceAttachment extends InformationReferenceElemen
     scale?: Point3d;
     /** @internal */
     static get className(): string;
-    /** @internal */
-    constructor(props: ExternalSourceAttachmentProps, iModel: IModelDb);
-    /** @internal */
+    protected constructor(props: ExternalSourceAttachmentProps, iModel: IModelDb);
     toJSON(): ExternalSourceAttachmentProps;
     /** The [[CodeSpec]] for ExternalSourceAttachment elements is not automatically created, so this method ensures that it exists. */
     static ensureCodeSpec(iModelDb: IModelDb): Id64String;
@@ -76,8 +72,7 @@ export declare class ExternalSourceAttachment extends InformationReferenceElemen
 export declare class ExternalSourceGroup extends ExternalSource {
     /** @internal */
     static get className(): string;
-    /** @internal */
-    constructor(props: ExternalSourceProps, iModel: IModelDb);
+    protected constructor(props: ExternalSourceProps, iModel: IModelDb);
 }
 /** Link to the Configuration for an iModel Synchronization Job
  * @note The associated ECClass was added to the BisCore schema in version 1.0.13
@@ -88,9 +83,7 @@ export declare class SynchronizationConfigLink extends UrlLink {
     lastSuccessfulRun?: string;
     /** @internal */
     static get className(): string;
-    /** @internal */
-    constructor(props: SynchronizationConfigLinkProps, iModel: IModelDb);
-    /** @internal */
+    protected constructor(props: SynchronizationConfigLinkProps, iModel: IModelDb);
     toJSON(): SynchronizationConfigLinkProps;
 }
 //# sourceMappingURL=ExternalSource.d.ts.map

package/lib/cjs/ExternalSource.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExternalSource.d.ts","sourceRoot":"","sources":["../../src/ExternalSource.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EACQ,IAAI,EAAiB,kBAAkB,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,mBAAmB,EACtI,8BAA8B,EAC/B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,2BAA2B,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,sCAAsC,EAAE,4BAA4B,EAAE,MAAM,0BAA0B,CAAC;AAEhH;;;GAGG;AACH,qBAAa,cAAe,SAAQ,2BAA2B;IAC7D,wDAAwD;IACjD,UAAU,CAAC,EAAE,4BAA4B,CAAC;IACjD,2EAA2E;IACpE,aAAa,CAAC,EAAE,MAAM,CAAC;IAC9B,8EAA8E;IACvE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACjC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,gBAAgB;gBACG,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAK/D,gBAAgB;IACA,MAAM,IAAI,mBAAmB;IAG7C,wHAAwH;WAC1G,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,UAAU;IAQ5D;;;;OAIG;WACW,UAAU,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;cAKlD,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E;AAED;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,2BAA2B;IACvE,gFAAgF;IACzE,QAAQ,CAAC,EAAE,sCAAsC,CAAC;IACzD,wGAAwG;IACjG,IAAI,CAAC,EAAE,4BAA4B,CAAC;IAC3C,0IAA0I;IACnI,WAAW,CAAC,EAAE,OAAO,CAAC;IAC7B,qHAAqH;IAC9G,GAAG,CAAC,EAAE,MAAM,CAAC;IACpB,uHAAuH;IAChH,KAAK,CAAC,EAAE,MAAM,CAAC;IACtB,sHAAsH;IAC/G,IAAI,CAAC,EAAE,MAAM,CAAC;IACrB,oGAAoG;IAC7F,KAAK,CAAC,EAAE,OAAO,CAAC;IACvB,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAuC;IACrF,gBAAgB;gBACG,KAAK,EAAE,6BAA6B,EAAE,MAAM,EAAE,QAAQ;IAWzE,gBAAgB;IACA,MAAM,IAAI,6BAA6B;IAGvD,kIAAkI;WACpH,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,UAAU;IAQ5D;;;;;OAKG;WACW,UAAU,CAAC,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIlG;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,cAAc;IACrD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAkC;IAChF,gBAAgB;gBACG,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;CAGhE;AAED;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,OAAO;IACpD,6EAA6E;IACtE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAClC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAwC;IACtF,gBAAgB;gBACG,KAAK,EAAE,8BAA8B,EAAE,MAAM,EAAE,QAAQ;IAG1E,gBAAgB;IACA,MAAM,IAAI,8BAA8B;CAGzD"}
+{"version":3,"file":"ExternalSource.d.ts","sourceRoot":"","sources":["../../src/ExternalSource.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EACQ,IAAI,EAAiB,kBAAkB,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,mBAAmB,EACtI,8BAA8B,EAC/B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,2BAA2B,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,sCAAsC,EAAE,4BAA4B,EAAE,MAAM,0BAA0B,CAAC;AAEhH;;;GAGG;AACH,qBAAa,cAAe,SAAQ,2BAA2B;IAC7D,wDAAwD;IACjD,UAAU,CAAC,EAAE,4BAA4B,CAAC;IACjD,2EAA2E;IACpE,aAAa,CAAC,EAAE,MAAM,CAAC;IAC9B,8EAA8E;IACvE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACjC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAE3E,SAAS,aAAa,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAMlD,MAAM,IAAI,mBAAmB;IAG7C,wHAAwH;WAC1G,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,UAAU;IAQ5D;;;;OAIG;WACW,UAAU,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;cAKlD,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E;AAED;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,2BAA2B;IACvE,gFAAgF;IACzE,QAAQ,CAAC,EAAE,sCAAsC,CAAC;IACzD,wGAAwG;IACjG,IAAI,CAAC,EAAE,4BAA4B,CAAC;IAC3C,0IAA0I;IACnI,WAAW,CAAC,EAAE,OAAO,CAAC;IAC7B,qHAAqH;IAC9G,GAAG,CAAC,EAAE,MAAM,CAAC;IACpB,uHAAuH;IAChH,KAAK,CAAC,EAAE,MAAM,CAAC;IACtB,sHAAsH;IAC/G,IAAI,CAAC,EAAE,MAAM,CAAC;IACrB,oGAAoG;IAC7F,KAAK,CAAC,EAAE,OAAO,CAAC;IACvB,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAuC;IAErF,SAAS,aAAa,KAAK,EAAE,6BAA6B,EAAE,MAAM,EAAE,QAAQ;IAY5D,MAAM,IAAI,6BAA6B;IAGvD,kIAAkI;WACpH,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,UAAU;IAQ5D;;;;;OAKG;WACW,UAAU,CAAC,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIlG;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,cAAc;IACrD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAkC;IAEhF,SAAS,aAAa,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;CAGnE;AAED;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,OAAO;IACpD,6EAA6E;IACtE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAClC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAwC;IAEtF,SAAS,aAAa,KAAK,EAAE,8BAA8B,EAAE,MAAM,EAAE,QAAQ;IAI7D,MAAM,IAAI,8BAA8B;CAGzD"}

package/lib/cjs/ExternalSource.js

@@ -19,13 +19,11 @@ const NavigationRelationship_1 = require("./NavigationRelationship");
 class ExternalSource extends Element_1.InformationReferenceElement {
     /** @internal */
     static get className() { return "ExternalSource"; }
-    /** @internal */
     constructor(props, iModel) {
         super(props, iModel);
         if (props.repository)
             this.repository = new NavigationRelationship_1.ExternalSourceIsInRepository(core_common_1.RelatedElement.idFromJson(props.repository));
     }
-    /** @internal */
     toJSON() {
         return super.toJSON(); // Entity.toJSON takes care of auto-handled properties
     }
@@ -62,7 +60,6 @@ exports.ExternalSource = ExternalSource;
 class ExternalSourceAttachment extends Element_1.InformationReferenceElement {
     /** @internal */
     static get className() { return "ExternalSourceAttachment"; }
-    /** @internal */
     constructor(props, iModel) {
         super(props, iModel);
         if (props.attaches)
@@ -72,7 +69,6 @@ class ExternalSourceAttachment extends Element_1.InformationReferenceElement {
         if (props.scale)
             this.scale = core_geometry_1.Point3d.fromJSON(props.scale);
     }
-    /** @internal */
     toJSON() {
         return super.toJSON(); // Entity.toJSON takes care of auto-handled properties
     }
@@ -105,7 +101,6 @@ exports.ExternalSourceAttachment = ExternalSourceAttachment;
 class ExternalSourceGroup extends ExternalSource {
     /** @internal */
     static get className() { return "ExternalSourceGroup"; }
-    /** @internal */
     constructor(props, iModel) {
         super(props, iModel);
     }
@@ -118,11 +113,9 @@ exports.ExternalSourceGroup = ExternalSourceGroup;
 class SynchronizationConfigLink extends Element_1.UrlLink {
     /** @internal */
     static get className() { return "SynchronizationConfigLink"; }
-    /** @internal */
     constructor(props, iModel) {
         super(props, iModel);
     }
-    /** @internal */
     toJSON() {
         return super.toJSON(); // Entity.toJSON takes care of auto-handled properties
     }

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;AAEjE,qEAAgH;AAEhH;;;GAGG;AACH,MAAa,cAAe,SAAQ,qCAA2B;IAO7D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAC3E,gBAAgB;IAChB,YAAmB,KAA0B,EAAE,MAAgB;QAC7D,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;IACD,gBAAgB;IACA,MAAM;QACpB,OAAO,KAAK,CAAC,MAAM,EAAyB,CAAC,CAAC,sDAAsD;IACtG,CAAC;IACD,wHAAwH;IACjH,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC7C,IAAI;YACF,MAAM,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,cAAc,CAAC,CAAC;YAC1E,OAAO,QAAQ,CAAC,EAAE,CAAC;SACpB;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,yBAAW,CAAC,cAAc,EAAE,2BAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAC7F;IACH,CAAC;IACD;;;;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;AA3CD,wCA2CC;AAED;;;GAGG;AACH,MAAa,wBAAyB,SAAQ,qCAA2B;IAevE,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,0BAA0B,CAAC,CAAC,CAAC;IACrF,gBAAgB;IAChB,YAAmB,KAAoC,EAAE,MAAgB;QACvE,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;IACD,gBAAgB;IACA,MAAM;QACpB,OAAO,KAAK,CAAC,MAAM,EAAmC,CAAC,CAAC,sDAAsD;IAChH,CAAC;IACD,kIAAkI;IAC3H,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC7C,IAAI;YACF,MAAM,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,wBAAwB,CAAC,CAAC;YACpF,OAAO,QAAQ,CAAC,EAAE,CAAC;SACpB;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,yBAAW,CAAC,wBAAwB,EAAE,2BAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SAC1G;IACH,CAAC;IACD;;;;;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;AApDD,4DAoDC;AAED;;;GAGG;AACH,MAAa,mBAAoB,SAAQ,cAAc;IACrD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;IAChF,gBAAgB;IAChB,YAAmB,KAA0B,EAAE,MAAgB;QAC7D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;CACF;AAPD,kDAOC;AAED;;;GAGG;AACH,MAAa,yBAA0B,SAAQ,iBAAO;IAGpD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,2BAA2B,CAAC,CAAC,CAAC;IACtF,gBAAgB;IAChB,YAAmB,KAAqC,EAAE,MAAgB;QACxE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;IACD,gBAAgB;IACA,MAAM;QACpB,OAAO,KAAK,CAAC,MAAM,EAAoC,CAAC,CAAC,sDAAsD;IACjH,CAAC;CACF;AAbD,8DAaC","sourcesContent":["\r\n/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Elements\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { Point3d } from \"@itwin/core-geometry\";\r\nimport {\r\n  BisCodeSpec, Code, CodeScopeSpec, EntityReferenceSet, ExternalSourceAttachmentProps, ExternalSourceAttachmentRole, ExternalSourceProps, IModel, RelatedElement,\r\n  SynchronizationConfigLinkProps,\r\n} from \"@itwin/core-common\";\r\nimport { InformationReferenceElement, UrlLink } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { ExternalSourceAttachmentAttachesSource, ExternalSourceIsInRepository } from \"./NavigationRelationship\";\r\n\r\n/** An ExternalSource refers to an 'information container' found in a repository. In some cases, the container is the entire repository.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class ExternalSource extends InformationReferenceElement {\r\n  /** The repository that contains this ExternalSource. */\r\n  public repository?: ExternalSourceIsInRepository;\r\n  /** The name of the iModel Connecter that processed this ExternalSource. */\r\n  public connectorName?: string;\r\n  /** The version of the iModel Connecter that processed this ExternalSource. */\r\n  public connectorVersion?: string;\r\n  /** @internal */\r\n  public static override get className(): string { return \"ExternalSource\"; }\r\n  /** @internal */\r\n  public constructor(props: ExternalSourceProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    if (props.repository)\r\n      this.repository = new ExternalSourceIsInRepository(RelatedElement.idFromJson(props.repository));\r\n  }\r\n  /** @internal */\r\n  public override toJSON(): ExternalSourceProps { // This override only specializes the return type\r\n    return super.toJSON() as ExternalSourceProps; // Entity.toJSON takes care of auto-handled properties\r\n  }\r\n  /** The [[CodeSpec]] for ExternalSource elements is not automatically created, so this method ensures that it exists. */\r\n  public static ensureCodeSpec(iModelDb: IModelDb): Id64String {\r\n    try {\r\n      const codeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.externalSource);\r\n      return codeSpec.id;\r\n    } catch (e) {\r\n      return iModelDb.codeSpecs.insert(BisCodeSpec.externalSource, CodeScopeSpec.Type.Repository);\r\n    }\r\n  }\r\n  /** Create a Code for an ExternalSource element given a name that is meant to be unique within the scope of the iModel.\r\n   * @param iModelDb  The IModelDb\r\n   * @param codeValue The ExternalSource name\r\n   * @see [[ensureCodeSpec]]\r\n   */\r\n  public static createCode(iModelDb: IModelDb, codeValue: string): Code {\r\n    const codeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.externalSource);\r\n    return new Code({ spec: codeSpec.id, scope: IModel.rootSubjectId, value: codeValue });\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    if (this.repository)\r\n      referenceIds.addElement(this.repository.id);\r\n  }\r\n}\r\n\r\n/** Attachment of an ExternalSource\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class ExternalSourceAttachment extends InformationReferenceElement {\r\n  /** The [[ExternalSource]] that is attached by this ExternalSourceAttachment. */\r\n  public attaches?: ExternalSourceAttachmentAttachesSource;\r\n  /** Specifies whether the attached [[ExternalSource]] provides context or models a part of the whole. */\r\n  public role?: ExternalSourceAttachmentRole;\r\n  /** The translation or offset in global coordinates of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\r\n  public translation?: Point3d;\r\n  /** The Yaw angle (in degrees) of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\r\n  public yaw?: number;\r\n  /** The Pitch angle (in degrees) of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\r\n  public pitch?: number;\r\n  /** The Roll angle (in degrees) of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\r\n  public roll?: number;\r\n  /** The scale of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\r\n  public scale?: Point3d;\r\n  /** @internal */\r\n  public static override get className(): string { return \"ExternalSourceAttachment\"; }\r\n  /** @internal */\r\n  public constructor(props: ExternalSourceAttachmentProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    if (props.attaches)\r\n      this.attaches = new ExternalSourceAttachmentAttachesSource(RelatedElement.idFromJson(props.attaches));\r\n\r\n    if (props.translation)\r\n      this.translation = Point3d.fromJSON(props.translation);\r\n\r\n    if (props.scale)\r\n      this.scale = Point3d.fromJSON(props.scale);\r\n  }\r\n  /** @internal */\r\n  public override toJSON(): ExternalSourceAttachmentProps { // This override only specializes the return type\r\n    return super.toJSON() as ExternalSourceAttachmentProps; // Entity.toJSON takes care of auto-handled properties\r\n  }\r\n  /** The [[CodeSpec]] for ExternalSourceAttachment elements is not automatically created, so this method ensures that it exists. */\r\n  public static ensureCodeSpec(iModelDb: IModelDb): Id64String {\r\n    try {\r\n      const codeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.externalSourceAttachment);\r\n      return codeSpec.id;\r\n    } catch (e) {\r\n      return iModelDb.codeSpecs.insert(BisCodeSpec.externalSourceAttachment, CodeScopeSpec.Type.ParentElement);\r\n    }\r\n  }\r\n  /** Create a Code for an ExternalSourceAttachment element given a name that is meant to be unique within the scope of its parent [[ExternalSource]].\r\n   * @param iModelDb  The IModelDb\r\n   * @param scopeElementId The parent ExternalSource\r\n   * @param codeValue The ExternalSourceAttachment name\r\n   * @see [[ensureCodeSpec]]\r\n   */\r\n  public static createCode(iModelDb: IModelDb, scopeElementId: Id64String, codeValue: string): Code {\r\n    const codeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.externalSourceAttachment);\r\n    return new Code({ spec: codeSpec.id, scope: scopeElementId, value: codeValue });\r\n  }\r\n}\r\n\r\n/** A group of ExternalSources that are collectively a source of information for one or more elements.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class ExternalSourceGroup extends ExternalSource {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ExternalSourceGroup\"; }\r\n  /** @internal */\r\n  public constructor(props: ExternalSourceProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n  }\r\n}\r\n\r\n/** Link to the Configuration for an iModel Synchronization Job\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class SynchronizationConfigLink extends UrlLink {\r\n  /** Date/Time of last successful run of this synchronization configuration */\r\n  public lastSuccessfulRun?: string;\r\n  /** @internal */\r\n  public static override get className(): string { return \"SynchronizationConfigLink\"; }\r\n  /** @internal */\r\n  public constructor(props: SynchronizationConfigLinkProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n  }\r\n  /** @internal */\r\n  public override toJSON(): SynchronizationConfigLinkProps { // This override only specializes the return type\r\n    return super.toJSON() as SynchronizationConfigLinkProps; // Entity.toJSON takes care of auto-handled properties\r\n  }\r\n}\r\n\r\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;AAEjE,qEAAgH;AAEhH;;;GAGG;AACH,MAAa,cAAe,SAAQ,qCAA2B;IAO7D,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,EAAyB,CAAC,CAAC,sDAAsD;IACtG,CAAC;IACD,wHAAwH;IACjH,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC7C,IAAI;YACF,MAAM,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,cAAc,CAAC,CAAC;YAC1E,OAAO,QAAQ,CAAC,EAAE,CAAC;SACpB;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,yBAAW,CAAC,cAAc,EAAE,2BAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAC7F;IACH,CAAC;IACD;;;;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;AA3CD,wCA2CC;AAED;;;GAGG;AACH,MAAa,wBAAyB,SAAQ,qCAA2B;IAevE,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,EAAmC,CAAC,CAAC,sDAAsD;IAChH,CAAC;IACD,kIAAkI;IAC3H,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC7C,IAAI;YACF,MAAM,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,wBAAwB,CAAC,CAAC;YACpF,OAAO,QAAQ,CAAC,EAAE,CAAC;SACpB;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,yBAAW,CAAC,wBAAwB,EAAE,2BAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SAC1G;IACH,CAAC;IACD;;;;;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;AApDD,4DAoDC;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;IAGpD,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,EAAoC,CAAC,CAAC,sDAAsD;IACjH,CAAC;CACF;AAbD,8DAaC","sourcesContent":["\r\n/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Elements\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { Point3d } from \"@itwin/core-geometry\";\r\nimport {\r\n  BisCodeSpec, Code, CodeScopeSpec, EntityReferenceSet, ExternalSourceAttachmentProps, ExternalSourceAttachmentRole, ExternalSourceProps, IModel, RelatedElement,\r\n  SynchronizationConfigLinkProps,\r\n} from \"@itwin/core-common\";\r\nimport { InformationReferenceElement, UrlLink } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { ExternalSourceAttachmentAttachesSource, ExternalSourceIsInRepository } from \"./NavigationRelationship\";\r\n\r\n/** An ExternalSource refers to an 'information container' found in a repository. In some cases, the container is the entire repository.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class ExternalSource extends InformationReferenceElement {\r\n  /** The repository that contains this ExternalSource. */\r\n  public repository?: ExternalSourceIsInRepository;\r\n  /** The name of the iModel Connecter that processed this ExternalSource. */\r\n  public connectorName?: string;\r\n  /** The version of the iModel Connecter that processed this ExternalSource. */\r\n  public connectorVersion?: string;\r\n  /** @internal */\r\n  public static override get className(): string { return \"ExternalSource\"; }\r\n\r\n  protected constructor(props: ExternalSourceProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    if (props.repository)\r\n      this.repository = new ExternalSourceIsInRepository(RelatedElement.idFromJson(props.repository));\r\n  }\r\n\r\n  public override toJSON(): ExternalSourceProps { // This override only specializes the return type\r\n    return super.toJSON() as ExternalSourceProps; // Entity.toJSON takes care of auto-handled properties\r\n  }\r\n  /** The [[CodeSpec]] for ExternalSource elements is not automatically created, so this method ensures that it exists. */\r\n  public static ensureCodeSpec(iModelDb: IModelDb): Id64String {\r\n    try {\r\n      const codeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.externalSource);\r\n      return codeSpec.id;\r\n    } catch (e) {\r\n      return iModelDb.codeSpecs.insert(BisCodeSpec.externalSource, CodeScopeSpec.Type.Repository);\r\n    }\r\n  }\r\n  /** Create a Code for an ExternalSource element given a name that is meant to be unique within the scope of the iModel.\r\n   * @param iModelDb  The IModelDb\r\n   * @param codeValue The ExternalSource name\r\n   * @see [[ensureCodeSpec]]\r\n   */\r\n  public static createCode(iModelDb: IModelDb, codeValue: string): Code {\r\n    const codeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.externalSource);\r\n    return new Code({ spec: codeSpec.id, scope: IModel.rootSubjectId, value: codeValue });\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    if (this.repository)\r\n      referenceIds.addElement(this.repository.id);\r\n  }\r\n}\r\n\r\n/** Attachment of an ExternalSource\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class ExternalSourceAttachment extends InformationReferenceElement {\r\n  /** The [[ExternalSource]] that is attached by this ExternalSourceAttachment. */\r\n  public attaches?: ExternalSourceAttachmentAttachesSource;\r\n  /** Specifies whether the attached [[ExternalSource]] provides context or models a part of the whole. */\r\n  public role?: ExternalSourceAttachmentRole;\r\n  /** The translation or offset in global coordinates of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\r\n  public translation?: Point3d;\r\n  /** The Yaw angle (in degrees) of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\r\n  public yaw?: number;\r\n  /** The Pitch angle (in degrees) of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\r\n  public pitch?: number;\r\n  /** The Roll angle (in degrees) of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\r\n  public roll?: number;\r\n  /** The scale of the attached [[ExternalSource]] relative to the ExternalSource that attaches it. */\r\n  public scale?: Point3d;\r\n  /** @internal */\r\n  public static override get className(): string { return \"ExternalSourceAttachment\"; }\r\n\r\n  protected constructor(props: ExternalSourceAttachmentProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    if (props.attaches)\r\n      this.attaches = new ExternalSourceAttachmentAttachesSource(RelatedElement.idFromJson(props.attaches));\r\n\r\n    if (props.translation)\r\n      this.translation = Point3d.fromJSON(props.translation);\r\n\r\n    if (props.scale)\r\n      this.scale = Point3d.fromJSON(props.scale);\r\n  }\r\n\r\n  public override toJSON(): ExternalSourceAttachmentProps { // This override only specializes the return type\r\n    return super.toJSON() as ExternalSourceAttachmentProps; // Entity.toJSON takes care of auto-handled properties\r\n  }\r\n  /** The [[CodeSpec]] for ExternalSourceAttachment elements is not automatically created, so this method ensures that it exists. */\r\n  public static ensureCodeSpec(iModelDb: IModelDb): Id64String {\r\n    try {\r\n      const codeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.externalSourceAttachment);\r\n      return codeSpec.id;\r\n    } catch (e) {\r\n      return iModelDb.codeSpecs.insert(BisCodeSpec.externalSourceAttachment, CodeScopeSpec.Type.ParentElement);\r\n    }\r\n  }\r\n  /** Create a Code for an ExternalSourceAttachment element given a name that is meant to be unique within the scope of its parent [[ExternalSource]].\r\n   * @param iModelDb  The IModelDb\r\n   * @param scopeElementId The parent ExternalSource\r\n   * @param codeValue The ExternalSourceAttachment name\r\n   * @see [[ensureCodeSpec]]\r\n   */\r\n  public static createCode(iModelDb: IModelDb, scopeElementId: Id64String, codeValue: string): Code {\r\n    const codeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.externalSourceAttachment);\r\n    return new Code({ spec: codeSpec.id, scope: scopeElementId, value: codeValue });\r\n  }\r\n}\r\n\r\n/** A group of ExternalSources that are collectively a source of information for one or more elements.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class ExternalSourceGroup extends ExternalSource {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ExternalSourceGroup\"; }\r\n\r\n  protected constructor(props: ExternalSourceProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n  }\r\n}\r\n\r\n/** Link to the Configuration for an iModel Synchronization Job\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class SynchronizationConfigLink extends UrlLink {\r\n  /** Date/Time of last successful run of this synchronization configuration */\r\n  public lastSuccessfulRun?: string;\r\n  /** @internal */\r\n  public static override get className(): string { return \"SynchronizationConfigLink\"; }\r\n\r\n  protected constructor(props: SynchronizationConfigLinkProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n  }\r\n\r\n  public override toJSON(): SynchronizationConfigLinkProps { // This override only specializes the return type\r\n    return super.toJSON() as SynchronizationConfigLinkProps; // Entity.toJSON takes care of auto-handled properties\r\n  }\r\n}\r\n\r\n"]}

package/lib/cjs/IModelDb.d.ts

@@ -3,14 +3,16 @@
  */
 import { IModelJsNative } from "@bentley/imodeljs-native";
 import { AccessToken, BeEvent, DbResult, GuidString, Id64Arg, Id64Array, Id64Set, Id64String, IModelStatus, OpenMode } from "@itwin/core-bentley";
-import { AxisAlignedBox3d, BRepGeometryCreate, BriefcaseId, ChangesetIdWithIndex, Code, CodeProps, CreateEmptySnapshotIModelProps, CreateEmptyStandaloneIModelProps, CreateSnapshotIModelProps, EcefLocation, ECSchemaProps, ECSqlReader, ElementAspectProps, ElementGeometryRequest, ElementGraphicsRequestProps, ElementLoadProps, ElementProps, EntityMetaData, EntityProps, EntityQueryParams, FilePropertyProps, FontId, FontMap, FontType, GeoCoordinatesRequestProps, GeoCoordinatesResponseProps, GeometryContainmentRequestProps, GeometryContainmentResponseProps, IModel, IModelCoordinatesRequestProps, IModelCoordinatesResponseProps, IModelTileTreeProps, LocalFileName, MassPropertiesRequestProps, MassPropertiesResponseProps, ModelExtentsProps, ModelLoadProps, ModelProps, OpenBriefcaseProps, PropertyCallback, QueryBinder, QueryOptions, SchemaState, SnapRequestProps, SnapResponseProps, SnapshotOpenOptions, SubCategoryResultRow, TextureData, TextureLoadProps, ThumbnailProps, UpgradeOptions, ViewDefinitionProps, ViewQueryParams, ViewStateLoadProps, ViewStateProps } from "@itwin/core-common";
+import { AxisAlignedBox3d, BRepGeometryCreate, BriefcaseId, ChangesetIdWithIndex, Code, CodeProps, CreateEmptySnapshotIModelProps, CreateEmptyStandaloneIModelProps, CreateSnapshotIModelProps, EcefLocation, ECSchemaProps, ECSqlReader, ElementAspectProps, ElementGeometryRequest, ElementGraphicsRequestProps, ElementLoadProps, ElementProps, EntityMetaData, EntityProps, EntityQueryParams, FilePropertyProps, FontId, FontMap, FontType, GeoCoordinatesRequestProps, GeoCoordinatesResponseProps, GeometryContainmentRequestProps, GeometryContainmentResponseProps, IModel, IModelCoordinatesRequestProps, IModelCoordinatesResponseProps, IModelTileTreeProps, LocalFileName, MassPropertiesRequestProps, MassPropertiesResponseProps, ModelExtentsProps, ModelLoadProps, ModelProps, OpenBriefcaseProps, PropertyCallback, QueryBinder, QueryOptions, SchemaState, SnapRequestProps, SnapResponseProps, SnapshotOpenOptions, SubCategoryResultRow, TextureData, TextureLoadProps, ThumbnailProps, UpgradeOptions, ViewDefinitionProps, ViewIdString, ViewQueryParams, ViewStateLoadProps, ViewStateProps } from "@itwin/core-common";
 import { Range3d } from "@itwin/core-geometry";
 import { PullChangesArgs, PushChangesArgs } from "./BriefcaseManager";
+import { ChannelControl } from "./ChannelControl";
 import { CheckpointProps } from "./CheckpointManager";
 import { MetaDataRegistry } from "./ClassRegistry";
 import { CloudSqlite } from "./CloudSqlite";
 import { CodeService } from "./CodeService";
 import { CodeSpecs } from "./CodeSpecs";
+import { ECSchemaXmlContext } from "./ECSchemaXmlContext";
 import { ECSqlStatement } from "./ECSqlStatement";
 import { Element, Subject } from "./Element";
 import { ElementAspect } from "./ElementAspect";
@@ -21,10 +23,10 @@ import { Relationships } from "./Relationship";
 import { SqliteStatement } from "./SqliteStatement";
 import { TxnManager } from "./TxnManager";
 import { ViewDefinition } from "./ViewDefinition";
+import { ViewStore } from "./ViewStore";
 import { SettingDictionary } from "./workspace/Settings";
 import { Workspace } from "./workspace/Workspace";
-import { ECSchemaXmlContext } from "./ECSchemaXmlContext";
-import { ChannelControl } from "./ChannelControl";
+import type { BlobContainer } from "./BlobContainerService";
 /** Options for [[IModelDb.Models.updateModel]]
  * @note To mark *only* the geometry as changed, use [[IModelDb.Models.updateGeometryGuid]] instead.
  * @public
@@ -242,9 +244,7 @@ export declare abstract class IModelDb extends IModel {
      * @internal
      */
     get isStandalone(): boolean;
-    /** Type guard for instanceof [[StandaloneDb]]
-     * @internal
-     */
+    /** Type guard for instanceof [[StandaloneDb]]. */
     isStandaloneDb(): this is StandaloneDb;
     /** Return `true` if the underlying nativeDb is open and valid.
      * @internal
@@ -279,6 +279,12 @@ export declare abstract class IModelDb extends IModel {
      */
     withStatement<T>(ecsql: string, callback: (stmt: ECSqlStatement) => T, logErrors?: boolean): T;
     /** Allow to execute query and read results along with meta data. The result are streamed.
+     *
+     * See also:
+     * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)
+     * - [Code Examples]($docs/learning/backend/ECSQLCodeExamples)
+     * - [ECSQL Row Format]($docs/learning/ECSQLRowFormat)
+     *
      * @param params The values to bind to the parameters (if the ECSQL has any).
      * @param config Allow to specify certain flags which control how query is executed.
      * @returns Returns an [ECSqlReader]($common) which helps iterate over the result set and also give access to metadata.
@@ -478,7 +484,7 @@ export declare abstract class IModelDb extends IModel {
      * @see ($docs/learning/backend/IModelDb.md#upgrading-schemas-in-an-imodel)
      */
     static validateSchemas(filePath: LocalFileName, forReadWrite: boolean): SchemaState;
-    /** Get the ClassMetaDataRegistry for this iModel.
+    /** The registry of entity metadata for this iModel.
      * @internal
      */
     get classMetaDataRegistry(): MetaDataRegistry;
@@ -500,7 +506,7 @@ export declare abstract class IModelDb extends IModel {
     /** Construct an entity (Element or Model) from an iModel.
      * @throws [[IModelError]] if the entity cannot be constructed.
      */
-    constructEntity<T extends Entity>(props: EntityProps): T;
+    constructEntity<T extends Entity, P extends EntityProps = EntityProps>(props: P): T;
     /** Get the JavaScript class that handles a given entity class.  */
     getJsClass<T extends typeof Entity>(classFullName: string): T;
     /** Get metadata for a class. This method will load the metadata from the iModel into the cache as a side-effect, if necessary.
@@ -633,7 +639,7 @@ export declare abstract class IModelDb extends IModel {
     exportPartGraphics(exportProps: ExportPartGraphicsOptions): DbResult;
     /** Request geometry stream information from an element in binary format instead of json.
      * @returns IModelStatus.Success if successful
-     * @alpha
+     * @beta
      */
     elementGeometryRequest(requestProps: ElementGeometryRequest): IModelStatus;
     /** Create brep geometry for inclusion in an element's geometry stream.
@@ -685,8 +691,9 @@ export declare namespace IModelDb {
          * @see getModelProps
          */
         tryGetModelProps<T extends ModelProps>(id: Id64String): T | undefined;
-        /** Query for the last modified time of the specified Model.
-         * @internal
+        /** Query for the last modified time for a [[Model]].
+         * @param modelId The Id of the model.
+         * @throws IModelError if `modelId` does not identify a model in the iModel.
          */
         queryLastModifiedTime(modelId: Id64String): string;
         /** Get the Model with the specified identifier.
@@ -780,13 +787,19 @@ export declare namespace IModelDb {
          */
         queryRange(ids: Id64String | Id64String[]): Promise<AxisAlignedBox3d>;
     }
+    interface GuidMapper {
+        getFederationGuidFromId(id: Id64String): GuidString | undefined;
+        getIdFromFederationGuid(guid?: GuidString): Id64String | undefined;
+    }
     /** The collection of elements in an [[IModelDb]].
      * @public
      */
-    class Elements {
+    class Elements implements GuidMapper {
         private _iModel;
         /** @internal */
         constructor(_iModel: IModelDb);
+        getFederationGuidFromId(id: Id64String): GuidString | undefined;
+        getIdFromFederationGuid(guid?: GuidString): Id64String | undefined;
         /** Read element data from the iModel as JSON
          * @param elementIdArg a json string with the identity of the element to load. Must have one of "id", "federationGuid", or "code".
          * @returns The JSON properties of the element.
@@ -842,8 +855,9 @@ export declare namespace IModelDb {
          * @throws IModelError if the code is invalid
          */
         queryElementIdByCode(code: Required<CodeProps>): Id64String | undefined;
-        /** Query for the last modified time of the specified element.
-         * @internal
+        /** Query for an [[Element]]'s last modified time.
+         * @param elementId The Id of the element.
+         * @throws IModelError if `elementId` does not identify an element in the iModel.
          */
         queryLastModifiedTime(elementId: Id64String): string;
         /** Create a new instance of an element.
@@ -949,6 +963,20 @@ export declare namespace IModelDb {
         private _iModel;
         /** @internal */
         constructor(_iModel: IModelDb);
+        private static viewStoreProperty;
+        private _viewStore?;
+        get hasViewStore(): boolean;
+        /** @beta */
+        get viewStore(): ViewStore.CloudAccess;
+        set viewStore(viewStore: ViewStore.CloudAccess);
+        /** @beta */
+        accessViewStore(args: {
+            userToken?: AccessToken;
+            props?: CloudSqlite.ContainerProps;
+            accessLevel?: BlobContainer.RequestAccessLevel;
+        }): Promise<ViewStore.CloudAccess>;
+        /** @beta */
+        saveDefaultViewStore(arg: CloudSqlite.ContainerProps): void;
         /** Query for the array of ViewDefinitionProps of the specified class and matching the specified IsPrivate setting.
          * @param className Query for view definitions of this class.
          * @param wantPrivate If true, include private view definitions.
@@ -960,18 +988,13 @@ export declare namespace IModelDb {
          * @param params Specifies the query by which views are selected.
          * @param callback Function invoked for each ViewDefinition matching the query. Return false to terminate iteration, true to continue.
          * @returns true if all views were iterated, false if iteration was terminated early due to callback returning false.
-         *
-         * **Example: Finding all views of a specific DrawingModel**
-         * ``` ts
-         * [[include:IModelDb.Views.iterateViews]]
-         * ```
          */
         iterateViews(params: ViewQueryParams, callback: (view: ViewDefinition) => boolean): boolean;
-        private loadViewStateProps;
+        private loadViewData;
         /** @deprecated in 3.x. use [[getViewStateProps]]. */
-        getViewStateData(viewDefinitionId: string, options?: ViewStateLoadProps): ViewStateProps;
-        /** Obtain a [ViewStateProps]($common) for a [[ViewDefinition]] specified by element Id. */
-        getViewStateProps(viewDefinitionId: string, options?: ViewStateLoadProps): Promise<ViewStateProps>;
+        getViewStateData(viewDefinitionId: ViewIdString, options?: ViewStateLoadProps): ViewStateProps;
+        /** Obtain a [ViewStateProps]($common) for a [[ViewDefinition]] specified by ViewIdString. */
+        getViewStateProps(viewDefinitionId: ViewIdString, options?: ViewStateLoadProps): Promise<ViewStateProps>;
         private getViewThumbnailArg;
         /** Get the thumbnail for a view.
          * @param viewDefinitionId The Id of the view for thumbnail
@@ -990,9 +1013,9 @@ export declare namespace IModelDb {
         setDefaultViewId(viewId: Id64String): void;
     }
     /** Represents the current state of a pollable tile content request.
-     * Note: lack of a "completed" state because polling a completed request returns the content as a Uint8Array.
-     * @internal
-     */
+   * Note: lack of a "completed" state because polling a completed request returns the content as a Uint8Array.
+   * @internal
+   */
     enum TileContentState {
         New = 0,
         Pending = 1,
@@ -1067,6 +1090,8 @@ export declare class BriefcaseDb extends IModelDb {
      * ```
      */
     static readonly onOpened: BeEvent<(_iModelDb: BriefcaseDb, _args: OpenBriefcaseArgs) => void>;
+    /** Event raised after a BriefcaseDb has been closed. */
+    readonly onClosed: BeEvent<() => void>;
     /** @alpha */
     static readonly onCodeServiceCreated: BeEvent<(briefcase: BriefcaseDb) => void>;
     static findByKey(key: string): BriefcaseDb;
@@ -1110,6 +1135,7 @@ export declare class BriefcaseDb extends IModelDb {
     pullChanges(arg?: PullChangesArgs): Promise<void>;
     /** Push changes to iModelHub. */
     pushChanges(arg: PushChangesArgs): Promise<void>;
+    close(): void;
 }
 /** A *snapshot* iModel database file that is used for archival and data transfer purposes.
  * @see [Snapshot iModels]($docs/learning/backend/AccessingIModels.md#snapshot-imodels)
@@ -1120,6 +1146,8 @@ export declare class SnapshotDb extends IModelDb {
     get isSnapshot(): boolean;
     private _refreshSas;
     private _createClassViewsOnClose?;
+    static readonly onOpen: BeEvent<(path: LocalFileName, opts?: SnapshotDbOpenArgs) => void>;
+    static readonly onOpened: BeEvent<(_iModelDb: SnapshotDb) => void>;
     private constructor();
     static findByKey(key: string): SnapshotDb;
     static tryFindByKey(key: string): SnapshotDb | undefined;
@@ -1212,6 +1240,13 @@ export declare class StandaloneDb extends BriefcaseDb {
      * @see [[StandaloneDb.validateSchemas]]
      */
     static upgradeStandaloneSchemas(filePath: LocalFileName): void;
+    /** Creates or updates views in the iModel to permit visualizing the EC content as ECClasses and ECProperties rather than raw database tables and columns.
+     * This can be helpful when debugging the EC data, especially when the raw tables make use of shared columns or spread data across multiple tables.
+     * @throws IModelError if view creation failed.
+     * @note The views are strictly intended for developers and debugging purposes only - they should not be used in application code.
+     * @beta
+     */
+    createClassViews(): void;
     /** Open a standalone iModel file.
      * @param filePath The path of the standalone iModel file.
      * @param openMode Optional open mode for the standalone iModel. The default is read/write.