@itwin/core-backend 5.1.0-dev.9 → 5.2.0-dev.1

package/lib/cjs/ElementAspect.d.ts

@@ -31,7 +31,7 @@ export interface OnAspectIdArg extends OnAspectArg {
 /** An Element Aspect is a class that defines a set of properties that are related to (and owned by) a single element.
  * Semantically, an ElementAspect can be considered part of the Element. Thus, an ElementAspect is deleted if its owning Element is deleted.
  * BIS Guideline: Subclass ElementUniqueAspect or ElementMultiAspect rather than subclassing ElementAspect directly.
- * @public
+ * @public @preview
  */
 export declare class ElementAspect extends Entity {
     static get className(): string;
@@ -74,30 +74,30 @@ export declare class ElementAspect extends Entity {
     protected static onDeleted(_arg: OnAspectIdArg): void;
 }
 /** An Element Unique Aspect is an ElementAspect where there can be only zero or one instance of the Element Aspect class per Element.
- * @public
+ * @public @preview
  */
 export declare class ElementUniqueAspect extends ElementAspect {
     static get className(): string;
 }
 /** An Element Multi-Aspect is an ElementAspect where there can be **n** instances of the Element Aspect class per Element.
- * @public
+ * @public @preview
  */
 export declare class ElementMultiAspect extends ElementAspect {
     static get className(): string;
 }
 /**
- * @public
+ * @public @preview
  */
 export declare class ChannelRootAspect extends ElementUniqueAspect {
     static get className(): string;
     /** Insert a ChannelRootAspect on the specified element.
-     * @deprecated in 4.0 use [[ChannelControl.makeChannelRoot]]. This method does not enforce the rule that channels may not nest and is therefore dangerous.
+     * @deprecated in 4.0 - will not be removed until after 2026-06-13. Use [[ChannelControl.makeChannelRoot]]. This method does not enforce the rule that channels may not nest and is therefore dangerous.
      */
     static insert(iModel: IModelDb, ownerId: Id64String, channelName: string): void;
 }
 /** An ElementMultiAspect that stores synchronization information for an Element originating from an external source.
  * @note The associated ECClass was added to the BisCore schema in version 1.0.2
- * @public
+ * @public @preview
  */
 export declare class ExternalSourceAspect extends ElementMultiAspect {
     static get className(): string;
@@ -145,10 +145,10 @@ export declare class ExternalSourceAspect extends ElementMultiAspect {
     toJSON(): ExternalSourceAspectProps;
     protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
 }
-/** @public */
+/** @public @preview */
 export declare namespace ExternalSourceAspect {
     /** Standard values for the `Kind` property of `ExternalSourceAspect`.
-     * @public
+     * @public @preview
      */
     enum Kind {
         /** Indicates that the [[ExternalSourceAspect]] is storing [[Element]] provenance */

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

@@ -1 +1 @@
-{"version":3,"file":"ElementAspect.d.ts","sourceRoot":"","sources":["../../src/ElementAspect.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAA0B,kBAAkB,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC/I,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAY,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAG3D;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,wDAAwD;IACxD,MAAM,EAAE,QAAQ,CAAC;IACjB,sDAAsD;IACtD,KAAK,EAAE,UAAU,CAAC;CACnB;AACD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,+DAA+D;IAC/D,KAAK,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;CACrC;AACD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,kDAAkD;IAClD,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,MAAM;IACvC,WAA2B,SAAS,IAAI,MAAM,CAA4B;IACnE,OAAO,EAAE,cAAc,CAAC;IAE/B,kFAAkF;gBACtE,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ;IAKvC,MAAM,IAAI,kBAAkB;IAM5C;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,gBAAgB,GAAG,IAAI;IAMtD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAEzD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,gBAAgB,GAAG,IAAI;IAMtD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAExD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,aAAa,GAAG,IAAI;IAOnD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;CACtD;AACD;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,aAAa;IACpD,WAA2B,SAAS,IAAI,MAAM,CAAkC;CACjF;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,aAAa;IACnD,WAA2B,SAAS,IAAI,MAAM,CAAiC;CAChF;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,mBAAmB;IACxD,WAA2B,SAAS,IAAI,MAAM,CAAgC;IAC9E;;OAEG;WACW,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM;CAIhF;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,kBAAkB;IAC1D,WAA2B,SAAS,IAAI,MAAM,CAAmC;IAEjF;;;OAGG;IACI,KAAK,EAAE,cAAc,CAAC;IAC7B,6DAA6D;IACtD,UAAU,EAAE,MAAM,CAAC;IAC1B,uDAAuD;IAChD,IAAI,EAAE,MAAM,CAAC;IACpB,mKAAmK;IAC5J,QAAQ,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACI,OAAO,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACI,cAAc,CAAC,EAAE,MAAM,CAAC;IAC/B,iHAAiH;IAC1G,MAAM,CAAC,EAAE,cAAc,CAAC;IAE/B,kFAAkF;gBACtE,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,QAAQ;IAW9D;;;;;;;;;;;MAWE;WACY,eAAe,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAAC;QAAE,SAAS,EAAE,UAAU,CAAC;QAAC,QAAQ,EAAE,UAAU,CAAA;KAAE,CAAC;IAe9I,MAAM,IAAI,yBAAyB;cAYhC,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAQ/E;AAED,cAAc;AACd,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,KAAY,IAAI;QACd,oFAAoF;QACpF,OAAO,YAAY;QACnB,yFAAyF;QACzF,YAAY,iBAAiB;QAC7B;;WAEG;QACH,KAAK,UAAU;KAChB;CACF"}
+{"version":3,"file":"ElementAspect.d.ts","sourceRoot":"","sources":["../../src/ElementAspect.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAA0B,kBAAkB,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC/I,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAY,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAG3D;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,wDAAwD;IACxD,MAAM,EAAE,QAAQ,CAAC;IACjB,sDAAsD;IACtD,KAAK,EAAE,UAAU,CAAC;CACnB;AACD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,+DAA+D;IAC/D,KAAK,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;CACrC;AACD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,kDAAkD;IAClD,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,MAAM;IACvC,WAA2B,SAAS,IAAI,MAAM,CAA4B;IACnE,OAAO,EAAE,cAAc,CAAC;IAE/B,kFAAkF;gBACtE,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ;IAKvC,MAAM,IAAI,kBAAkB;IAM5C;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,gBAAgB,GAAG,IAAI;IAMtD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAEzD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,gBAAgB,GAAG,IAAI;IAMtD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAExD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,aAAa,GAAG,IAAI;IAOnD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;CACtD;AACD;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,aAAa;IACpD,WAA2B,SAAS,IAAI,MAAM,CAAkC;CACjF;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,aAAa;IACnD,WAA2B,SAAS,IAAI,MAAM,CAAiC;CAChF;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,mBAAmB;IACxD,WAA2B,SAAS,IAAI,MAAM,CAAgC;IAC9E;;OAEG;WACW,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM;CAIhF;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,kBAAkB;IAC1D,WAA2B,SAAS,IAAI,MAAM,CAAmC;IAEjF;;;OAGG;IACI,KAAK,EAAE,cAAc,CAAC;IAC7B,6DAA6D;IACtD,UAAU,EAAE,MAAM,CAAC;IAC1B,uDAAuD;IAChD,IAAI,EAAE,MAAM,CAAC;IACpB,mKAAmK;IAC5J,QAAQ,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACI,OAAO,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACI,cAAc,CAAC,EAAE,MAAM,CAAC;IAC/B,iHAAiH;IAC1G,MAAM,CAAC,EAAE,cAAc,CAAC;IAE/B,kFAAkF;gBACtE,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,QAAQ;IAW9D;;;;;;;;;;;MAWE;WACY,eAAe,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAAC;QAAE,SAAS,EAAE,UAAU,CAAC;QAAC,QAAQ,EAAE,UAAU,CAAA;KAAE,CAAC;IAe9I,MAAM,IAAI,yBAAyB;cAYhC,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAQ/E;AAED,uBAAuB;AACvB,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,KAAY,IAAI;QACd,oFAAoF;QACpF,OAAO,YAAY;QACnB,yFAAyF;QACzF,YAAY,iBAAiB;QAC7B;;WAEG;QACH,KAAK,UAAU;KAChB;CACF"}

package/lib/cjs/ElementAspect.js

@@ -15,7 +15,7 @@ const Symbols_1 = require("./internal/Symbols");
 /** An Element Aspect is a class that defines a set of properties that are related to (and owned by) a single element.
  * Semantically, an ElementAspect can be considered part of the Element. Thus, an ElementAspect is deleted if its owning Element is deleted.
  * BIS Guideline: Subclass ElementUniqueAspect or ElementMultiAspect rather than subclassing ElementAspect directly.
- * @public
+ * @public @preview
  */
 class ElementAspect extends Entity_1.Entity {
     static get className() { return "ElementAspect"; }
@@ -79,26 +79,26 @@ class ElementAspect extends Entity_1.Entity {
 }
 exports.ElementAspect = ElementAspect;
 /** An Element Unique Aspect is an ElementAspect where there can be only zero or one instance of the Element Aspect class per Element.
- * @public
+ * @public @preview
  */
 class ElementUniqueAspect extends ElementAspect {
     static get className() { return "ElementUniqueAspect"; }
 }
 exports.ElementUniqueAspect = ElementUniqueAspect;
 /** An Element Multi-Aspect is an ElementAspect where there can be **n** instances of the Element Aspect class per Element.
- * @public
+ * @public @preview
  */
 class ElementMultiAspect extends ElementAspect {
     static get className() { return "ElementMultiAspect"; }
 }
 exports.ElementMultiAspect = ElementMultiAspect;
 /**
- * @public
+ * @public @preview
  */
 class ChannelRootAspect extends ElementUniqueAspect {
     static get className() { return "ChannelRootAspect"; }
     /** Insert a ChannelRootAspect on the specified element.
-     * @deprecated in 4.0 use [[ChannelControl.makeChannelRoot]]. This method does not enforce the rule that channels may not nest and is therefore dangerous.
+     * @deprecated in 4.0 - will not be removed until after 2026-06-13. Use [[ChannelControl.makeChannelRoot]]. This method does not enforce the rule that channels may not nest and is therefore dangerous.
      */
     static insert(iModel, ownerId, channelName) {
         const props = { classFullName: this.classFullName, element: { id: ownerId }, owner: channelName };
@@ -108,7 +108,7 @@ class ChannelRootAspect extends ElementUniqueAspect {
 exports.ChannelRootAspect = ChannelRootAspect;
 /** An ElementMultiAspect that stores synchronization information for an Element originating from an external source.
  * @note The associated ECClass was added to the BisCore schema in version 1.0.2
- * @public
+ * @public @preview
  */
 class ExternalSourceAspect extends ElementMultiAspect {
     static get className() { return "ExternalSourceAspect"; }
@@ -193,10 +193,10 @@ class ExternalSourceAspect extends ElementMultiAspect {
     }
 }
 exports.ExternalSourceAspect = ExternalSourceAspect;
-/** @public */
+/** @public @preview */
 (function (ExternalSourceAspect) {
     /** Standard values for the `Kind` property of `ExternalSourceAspect`.
-     * @public
+     * @public @preview
      */
     let Kind;
     (function (Kind) {

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;AAC3D,gDAAoD;AA0BpD;;;;GAIG;AACH,MAAa,aAAc,SAAQ,eAAM;IAChC,MAAM,KAAc,SAAS,KAAa,OAAO,eAAe,CAAC,CAAC,CAAC;IACnE,OAAO,CAAiB;IAE/B,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,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;QAC9B,MAAM,CAAC,QAAQ,CAAC,wBAAc,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,UAAU,CAAC,IAAsB,IAAU,CAAC;IAE7D;;;;OAIG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAqB;QAC7C,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;QAC9B,MAAM,CAAC,QAAQ,CAAC,wBAAc,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,SAAS,CAAC,IAAsB,IAAU,CAAC;IAE5D;;;;OAIG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAkB;QAC1C,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;QACjC,MAAM,CAAC,QAAQ,CAAC,wBAAc,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;IAC1E,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,SAAS,CAAC,IAAmB,IAAU,CAAC;CAC1D;AAnED,sCAmEC;AACD;;GAEG;AACH,MAAa,mBAAoB,SAAQ,aAAa;IAC7C,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;CACjF;AAFD,kDAEC;AAED;;GAEG;AACH,MAAa,kBAAmB,SAAQ,aAAa;IAC5C,MAAM,KAAc,SAAS,KAAa,OAAO,oBAAoB,CAAC,CAAC,CAAC;CAChF;AAFD,gDAEC;AAED;;GAEG;AACH,MAAa,iBAAkB,SAAQ,mBAAmB;IACjD,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;AATD,8CASC;AAED;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,kBAAkB;IACnD,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IAEjF;;;OAGG;IACI,KAAK,CAAiB;IAC7B,6DAA6D;IACtD,UAAU,CAAS;IAC1B,uDAAuD;IAChD,IAAI,CAAS;IACpB,mKAAmK;IAC5J,QAAQ,CAAU;IACzB;;;OAGG;IACI,OAAO,CAAU;IACxB;;;OAGG;IACI,cAAc,CAAU;IAC/B,iHAAiH;IAC1G,MAAM,CAAkB;IAE/B,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;;;;;;;;;;;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,4DAA4D;QAC5D,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,CAAC;gBACnD,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;YACpG,CAAC;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;AAtFD,oDAsFC;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,oCAApB,oBAAoB,QAcpC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module ElementAspects\n */\n\nimport { ChannelRootAspectProps, ElementAspectProps, EntityReferenceSet, ExternalSourceAspectProps, RelatedElement } from \"@itwin/core-common\";\nimport { Entity } from \"./Entity\";\nimport { IModelDb } from \"./IModelDb\";\nimport { ECSqlStatement } from \"./ECSqlStatement\";\nimport { DbResult, Id64String } from \"@itwin/core-bentley\";\nimport { _verifyChannel } from \"./internal/Symbols\";\n\n/** Argument for the `ElementAspect.onXxx` static methods\n * @beta\n */\nexport interface OnAspectArg {\n  /** The iModel for the aspect affected by this event. */\n  iModel: IModelDb;\n  /** The model for the aspect affected by this event */\n  model: Id64String;\n}\n/** Argument for the `ElementAspect.onXxx` static methods that supply the properties of an aspect to be inserted or updated.\n * @beta\n */\nexport interface OnAspectPropsArg extends OnAspectArg {\n  /** The new properties of the aspect affected by this event. */\n  props: Readonly<ElementAspectProps>;\n}\n/** Argument for the `ElementAspect.onXxx` static methods that only supply the Id of the affected aspect.\n * @beta\n */\nexport interface OnAspectIdArg extends OnAspectArg {\n  /** The Id of the aspect affected by this event */\n  aspectId: Id64String;\n}\n\n/** An Element Aspect is a class that defines a set of properties that are related to (and owned by) a single element.\n * Semantically, an ElementAspect can be considered part of the Element. Thus, an ElementAspect is deleted if its owning Element is deleted.\n * BIS Guideline: Subclass ElementUniqueAspect or ElementMultiAspect rather than subclassing ElementAspect directly.\n * @public\n */\nexport class ElementAspect extends Entity {\n  public static override get className(): string { return \"ElementAspect\"; }\n  public element: RelatedElement;\n\n  /** Construct an aspect from its JSON representation and its containing iModel. */\n  constructor(props: ElementAspectProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.element = RelatedElement.fromJSON(props.element)!; // eslint-disable-line @typescript-eslint/no-non-null-assertion\n  }\n\n  public override toJSON(): ElementAspectProps {\n    const val = super.toJSON() as ElementAspectProps;\n    val.element = this.element;\n    return val;\n  }\n\n  /** Called before a new ElementAspect is inserted.\n   * @note throw an exception to disallow the insert\n   * @note If you override this method, you must call super.\n   * @beta\n   */\n  protected static onInsert(arg: OnAspectPropsArg): void {\n    const { props, iModel } = arg;\n    iModel.channels[_verifyChannel](arg.model);\n    iModel.locks.checkExclusiveLock(props.element.id, \"element\", \"insert aspect\");\n  }\n\n  /** Called after a new ElementAspect was inserted.\n   * @note If you override this method, you must call super.\n   * @beta\n   */\n  protected static onInserted(_arg: OnAspectPropsArg): void { }\n\n  /** Called before an ElementAspect is updated.\n   * @note throw an exception to disallow the update\n   * @note If you override this method, you must call super.\n   * @beta\n   */\n  protected static onUpdate(arg: OnAspectPropsArg): void {\n    const { props, iModel } = arg;\n    iModel.channels[_verifyChannel](arg.model);\n    iModel.locks.checkExclusiveLock(props.element.id, \"element\", \"update aspect\");\n  }\n\n  /** Called after an ElementAspect was updated.\n   * @note If you override this method, you must call super.\n   * @beta\n   */\n  protected static onUpdated(_arg: OnAspectPropsArg): void { }\n\n  /** Called before an ElementAspect is deleted.\n   * @note throw an exception to disallow the delete\n   * @note If you override this method, you must call super.\n   * @beta\n   */\n  protected static onDelete(arg: OnAspectIdArg): void {\n    const { aspectId, iModel } = arg;\n    iModel.channels[_verifyChannel](arg.model);\n    const { element } = iModel.elements.getAspect(aspectId);\n    iModel.locks.checkExclusiveLock(element.id, \"element\", \"delete aspect\");\n  }\n\n  /** Called after an ElementAspect was deleted.\n   * @note If you override this method, you must call super.\n   * @beta\n   */\n  protected static onDeleted(_arg: OnAspectIdArg): void { }\n}\n/** An Element Unique Aspect is an ElementAspect where there can be only zero or one instance of the Element Aspect class per Element.\n * @public\n */\nexport class ElementUniqueAspect extends ElementAspect {\n  public static override get className(): string { return \"ElementUniqueAspect\"; }\n}\n\n/** An Element Multi-Aspect is an ElementAspect where there can be **n** instances of the Element Aspect class per Element.\n * @public\n */\nexport class ElementMultiAspect extends ElementAspect {\n  public static override get className(): string { return \"ElementMultiAspect\"; }\n}\n\n/**\n * @public\n */\nexport class ChannelRootAspect extends ElementUniqueAspect {\n  public static override get className(): string { return \"ChannelRootAspect\"; }\n  /** Insert a ChannelRootAspect on the specified element.\n   * @deprecated in 4.0 use [[ChannelControl.makeChannelRoot]]. This method does not enforce the rule that channels may not nest and is therefore dangerous.\n   */\n  public static insert(iModel: IModelDb, ownerId: Id64String, channelName: string) {\n    const props: ChannelRootAspectProps = { classFullName: this.classFullName, element: { id: ownerId }, owner: channelName };\n    iModel.elements.insertAspect(props);\n  }\n}\n\n/** An ElementMultiAspect that stores synchronization information for an Element originating from an external source.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.2\n * @public\n */\nexport class ExternalSourceAspect extends ElementMultiAspect {\n  public static override get className(): string { return \"ExternalSourceAspect\"; }\n\n  /** An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source.\n   * @note Warning: in a future major release the `scope` property will be optional, since the scope is intended to be potentially invalid.\n   *       all references should treat it as potentially undefined, but we cannot change the type yet since that is a breaking change.\n   */\n  public scope: RelatedElement;\n  /** The identifier of the object in the source repository. */\n  public identifier: string;\n  /** The kind of object within the source repository. */\n  public kind: string;\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. */\n  public checksum?: string;\n  /** An optional value that is typically a version number or a pseudo version number like last modified time.\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.\n   * If present, this value must be guaranteed to change when any of the source object's content changes.\n   */\n  public version?: string;\n  /** A place where additional JSON properties can be stored. For example, provenance information or properties relating to the synchronization process.\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.\n   * This will be a breaking change, since application code will have to change from supplying a string to supplying an object.\n   */\n  public jsonProperties?: string;\n  /** The source of the imported/synchronized object. Should point to an instance of [ExternalSource]($backend). */\n  public source?: RelatedElement;\n\n  /** Construct an aspect from its JSON representation and its containing iModel. */\n  constructor(props: ExternalSourceAspectProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.scope = RelatedElement.fromJSON(props.scope)!; // eslint-disable-line @typescript-eslint/no-non-null-assertion\n    this.source = RelatedElement.fromJSON(props.source);\n    this.identifier = props.identifier;\n    this.kind = props.kind;\n    this.checksum = props.checksum;\n    this.version = props.version;\n    this.jsonProperties = props.jsonProperties;\n  }\n\n  /** Look up the elements that contain one or more ExternalSourceAspect with the specified Scope, Kind, and Identifier.\n   * The result of this function is an array of all of the ExternalSourceAspects that were found, each associated with the owning element.\n   * A given element could have more than one ExternalSourceAspect with the given scope, kind, and identifier.\n   * Also, many elements could have ExternalSourceAspect with the same scope, kind, and identifier.\n   * Therefore, the result array could have more than one entry with the same elementId.\n   * Aspects are never shared. Each aspect has its own unique ECInstanceId.\n   * @param iModelDb The iModel to query\n   * @param scope    The scope of the ExternalSourceAspects to find\n   * @param kind     The kind of the ExternalSourceAspects to find\n   * @param identifier The identifier of the ExternalSourceAspects to find\n   * @returns the query results\n  */\n  public static findAllBySource(iModelDb: IModelDb, scope: Id64String, kind: string, identifier: string): Array<{ elementId: Id64String, aspectId: Id64String }> {\n    const sql = `SELECT Element.Id, ECInstanceId FROM ${ExternalSourceAspect.classFullName} WHERE (Scope.Id=:scope AND Kind=:kind AND Identifier=:identifier)`;\n    const found: Array<{ elementId: Id64String, aspectId: Id64String }> = [];\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    iModelDb.withPreparedStatement(sql, (statement: ECSqlStatement) => {\n      statement.bindId(\"scope\", scope);\n      statement.bindString(\"kind\", kind);\n      statement.bindString(\"identifier\", identifier);\n      while (DbResult.BE_SQLITE_ROW === statement.step()) {\n        found.push({ elementId: statement.getValue(0).getId(), aspectId: statement.getValue(1).getId() });\n      }\n    });\n    return found;\n  }\n\n  public override toJSON(): ExternalSourceAspectProps {\n    const val = super.toJSON() as ExternalSourceAspectProps;\n    val.scope = this.scope;\n    val.source = this.source;\n    val.identifier = this.identifier;\n    val.kind = this.kind;\n    val.checksum = this.checksum;\n    val.version = this.version;\n    val.jsonProperties = this.jsonProperties;\n    return val;\n  }\n\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    if (this.scope)\n      referenceIds.addElement(this.scope.id);\n    referenceIds.addElement(this.element.id);\n    if (this.source)\n      referenceIds.addElement(this.source.id);\n  }\n}\n\n/** @public */\nexport namespace ExternalSourceAspect {\n  /** Standard values for the `Kind` property of `ExternalSourceAspect`.\n   * @public\n   */\n  export enum Kind {\n    /** Indicates that the [[ExternalSourceAspect]] is storing [[Element]] provenance */\n    Element = \"Element\",\n    /** Indicates that the [[ExternalSourceAspect]] is storing [[Relationship]] provenance */\n    Relationship = \"Relationship\",\n    /** Indicates that the [[ExternalSourceAspect]] is storing *scope* provenance\n     * @see [[ExternalSourceAspect.scope]]\n     */\n    Scope = \"Scope\",\n  }\n}\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;AAC3D,gDAAoD;AA0BpD;;;;GAIG;AACH,MAAa,aAAc,SAAQ,eAAM;IAChC,MAAM,KAAc,SAAS,KAAa,OAAO,eAAe,CAAC,CAAC,CAAC;IACnE,OAAO,CAAiB;IAE/B,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,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;QAC9B,MAAM,CAAC,QAAQ,CAAC,wBAAc,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,UAAU,CAAC,IAAsB,IAAU,CAAC;IAE7D;;;;OAIG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAqB;QAC7C,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;QAC9B,MAAM,CAAC,QAAQ,CAAC,wBAAc,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,SAAS,CAAC,IAAsB,IAAU,CAAC;IAE5D;;;;OAIG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAkB;QAC1C,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;QACjC,MAAM,CAAC,QAAQ,CAAC,wBAAc,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;IAC1E,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,SAAS,CAAC,IAAmB,IAAU,CAAC;CAC1D;AAnED,sCAmEC;AACD;;GAEG;AACH,MAAa,mBAAoB,SAAQ,aAAa;IAC7C,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;CACjF;AAFD,kDAEC;AAED;;GAEG;AACH,MAAa,kBAAmB,SAAQ,aAAa;IAC5C,MAAM,KAAc,SAAS,KAAa,OAAO,oBAAoB,CAAC,CAAC,CAAC;CAChF;AAFD,gDAEC;AAED;;GAEG;AACH,MAAa,iBAAkB,SAAQ,mBAAmB;IACjD,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;AATD,8CASC;AAED;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,kBAAkB;IACnD,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IAEjF;;;OAGG;IACI,KAAK,CAAiB;IAC7B,6DAA6D;IACtD,UAAU,CAAS;IAC1B,uDAAuD;IAChD,IAAI,CAAS;IACpB,mKAAmK;IAC5J,QAAQ,CAAU;IACzB;;;OAGG;IACI,OAAO,CAAU;IACxB;;;OAGG;IACI,cAAc,CAAU;IAC/B,iHAAiH;IAC1G,MAAM,CAAkB;IAE/B,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;;;;;;;;;;;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,4DAA4D;QAC5D,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,CAAC;gBACnD,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;YACpG,CAAC;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;AAtFD,oDAsFC;AAED,uBAAuB;AACvB,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,oCAApB,oBAAoB,QAcpC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module ElementAspects\n */\n\nimport { ChannelRootAspectProps, ElementAspectProps, EntityReferenceSet, ExternalSourceAspectProps, RelatedElement } from \"@itwin/core-common\";\nimport { Entity } from \"./Entity\";\nimport { IModelDb } from \"./IModelDb\";\nimport { ECSqlStatement } from \"./ECSqlStatement\";\nimport { DbResult, Id64String } from \"@itwin/core-bentley\";\nimport { _verifyChannel } from \"./internal/Symbols\";\n\n/** Argument for the `ElementAspect.onXxx` static methods\n * @beta\n */\nexport interface OnAspectArg {\n  /** The iModel for the aspect affected by this event. */\n  iModel: IModelDb;\n  /** The model for the aspect affected by this event */\n  model: Id64String;\n}\n/** Argument for the `ElementAspect.onXxx` static methods that supply the properties of an aspect to be inserted or updated.\n * @beta\n */\nexport interface OnAspectPropsArg extends OnAspectArg {\n  /** The new properties of the aspect affected by this event. */\n  props: Readonly<ElementAspectProps>;\n}\n/** Argument for the `ElementAspect.onXxx` static methods that only supply the Id of the affected aspect.\n * @beta\n */\nexport interface OnAspectIdArg extends OnAspectArg {\n  /** The Id of the aspect affected by this event */\n  aspectId: Id64String;\n}\n\n/** An Element Aspect is a class that defines a set of properties that are related to (and owned by) a single element.\n * Semantically, an ElementAspect can be considered part of the Element. Thus, an ElementAspect is deleted if its owning Element is deleted.\n * BIS Guideline: Subclass ElementUniqueAspect or ElementMultiAspect rather than subclassing ElementAspect directly.\n * @public @preview\n */\nexport class ElementAspect extends Entity {\n  public static override get className(): string { return \"ElementAspect\"; }\n  public element: RelatedElement;\n\n  /** Construct an aspect from its JSON representation and its containing iModel. */\n  constructor(props: ElementAspectProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.element = RelatedElement.fromJSON(props.element)!; // eslint-disable-line @typescript-eslint/no-non-null-assertion\n  }\n\n  public override toJSON(): ElementAspectProps {\n    const val = super.toJSON() as ElementAspectProps;\n    val.element = this.element;\n    return val;\n  }\n\n  /** Called before a new ElementAspect is inserted.\n   * @note throw an exception to disallow the insert\n   * @note If you override this method, you must call super.\n   * @beta\n   */\n  protected static onInsert(arg: OnAspectPropsArg): void {\n    const { props, iModel } = arg;\n    iModel.channels[_verifyChannel](arg.model);\n    iModel.locks.checkExclusiveLock(props.element.id, \"element\", \"insert aspect\");\n  }\n\n  /** Called after a new ElementAspect was inserted.\n   * @note If you override this method, you must call super.\n   * @beta\n   */\n  protected static onInserted(_arg: OnAspectPropsArg): void { }\n\n  /** Called before an ElementAspect is updated.\n   * @note throw an exception to disallow the update\n   * @note If you override this method, you must call super.\n   * @beta\n   */\n  protected static onUpdate(arg: OnAspectPropsArg): void {\n    const { props, iModel } = arg;\n    iModel.channels[_verifyChannel](arg.model);\n    iModel.locks.checkExclusiveLock(props.element.id, \"element\", \"update aspect\");\n  }\n\n  /** Called after an ElementAspect was updated.\n   * @note If you override this method, you must call super.\n   * @beta\n   */\n  protected static onUpdated(_arg: OnAspectPropsArg): void { }\n\n  /** Called before an ElementAspect is deleted.\n   * @note throw an exception to disallow the delete\n   * @note If you override this method, you must call super.\n   * @beta\n   */\n  protected static onDelete(arg: OnAspectIdArg): void {\n    const { aspectId, iModel } = arg;\n    iModel.channels[_verifyChannel](arg.model);\n    const { element } = iModel.elements.getAspect(aspectId);\n    iModel.locks.checkExclusiveLock(element.id, \"element\", \"delete aspect\");\n  }\n\n  /** Called after an ElementAspect was deleted.\n   * @note If you override this method, you must call super.\n   * @beta\n   */\n  protected static onDeleted(_arg: OnAspectIdArg): void { }\n}\n/** An Element Unique Aspect is an ElementAspect where there can be only zero or one instance of the Element Aspect class per Element.\n * @public @preview\n */\nexport class ElementUniqueAspect extends ElementAspect {\n  public static override get className(): string { return \"ElementUniqueAspect\"; }\n}\n\n/** An Element Multi-Aspect is an ElementAspect where there can be **n** instances of the Element Aspect class per Element.\n * @public @preview\n */\nexport class ElementMultiAspect extends ElementAspect {\n  public static override get className(): string { return \"ElementMultiAspect\"; }\n}\n\n/**\n * @public @preview\n */\nexport class ChannelRootAspect extends ElementUniqueAspect {\n  public static override get className(): string { return \"ChannelRootAspect\"; }\n  /** Insert a ChannelRootAspect on the specified element.\n   * @deprecated in 4.0 - will not be removed until after 2026-06-13. Use [[ChannelControl.makeChannelRoot]]. This method does not enforce the rule that channels may not nest and is therefore dangerous.\n   */\n  public static insert(iModel: IModelDb, ownerId: Id64String, channelName: string) {\n    const props: ChannelRootAspectProps = { classFullName: this.classFullName, element: { id: ownerId }, owner: channelName };\n    iModel.elements.insertAspect(props);\n  }\n}\n\n/** An ElementMultiAspect that stores synchronization information for an Element originating from an external source.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.2\n * @public @preview\n */\nexport class ExternalSourceAspect extends ElementMultiAspect {\n  public static override get className(): string { return \"ExternalSourceAspect\"; }\n\n  /** An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source.\n   * @note Warning: in a future major release the `scope` property will be optional, since the scope is intended to be potentially invalid.\n   *       all references should treat it as potentially undefined, but we cannot change the type yet since that is a breaking change.\n   */\n  public scope: RelatedElement;\n  /** The identifier of the object in the source repository. */\n  public identifier: string;\n  /** The kind of object within the source repository. */\n  public kind: string;\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. */\n  public checksum?: string;\n  /** An optional value that is typically a version number or a pseudo version number like last modified time.\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.\n   * If present, this value must be guaranteed to change when any of the source object's content changes.\n   */\n  public version?: string;\n  /** A place where additional JSON properties can be stored. For example, provenance information or properties relating to the synchronization process.\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.\n   * This will be a breaking change, since application code will have to change from supplying a string to supplying an object.\n   */\n  public jsonProperties?: string;\n  /** The source of the imported/synchronized object. Should point to an instance of [ExternalSource]($backend). */\n  public source?: RelatedElement;\n\n  /** Construct an aspect from its JSON representation and its containing iModel. */\n  constructor(props: ExternalSourceAspectProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.scope = RelatedElement.fromJSON(props.scope)!; // eslint-disable-line @typescript-eslint/no-non-null-assertion\n    this.source = RelatedElement.fromJSON(props.source);\n    this.identifier = props.identifier;\n    this.kind = props.kind;\n    this.checksum = props.checksum;\n    this.version = props.version;\n    this.jsonProperties = props.jsonProperties;\n  }\n\n  /** Look up the elements that contain one or more ExternalSourceAspect with the specified Scope, Kind, and Identifier.\n   * The result of this function is an array of all of the ExternalSourceAspects that were found, each associated with the owning element.\n   * A given element could have more than one ExternalSourceAspect with the given scope, kind, and identifier.\n   * Also, many elements could have ExternalSourceAspect with the same scope, kind, and identifier.\n   * Therefore, the result array could have more than one entry with the same elementId.\n   * Aspects are never shared. Each aspect has its own unique ECInstanceId.\n   * @param iModelDb The iModel to query\n   * @param scope    The scope of the ExternalSourceAspects to find\n   * @param kind     The kind of the ExternalSourceAspects to find\n   * @param identifier The identifier of the ExternalSourceAspects to find\n   * @returns the query results\n  */\n  public static findAllBySource(iModelDb: IModelDb, scope: Id64String, kind: string, identifier: string): Array<{ elementId: Id64String, aspectId: Id64String }> {\n    const sql = `SELECT Element.Id, ECInstanceId FROM ${ExternalSourceAspect.classFullName} WHERE (Scope.Id=:scope AND Kind=:kind AND Identifier=:identifier)`;\n    const found: Array<{ elementId: Id64String, aspectId: Id64String }> = [];\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    iModelDb.withPreparedStatement(sql, (statement: ECSqlStatement) => {\n      statement.bindId(\"scope\", scope);\n      statement.bindString(\"kind\", kind);\n      statement.bindString(\"identifier\", identifier);\n      while (DbResult.BE_SQLITE_ROW === statement.step()) {\n        found.push({ elementId: statement.getValue(0).getId(), aspectId: statement.getValue(1).getId() });\n      }\n    });\n    return found;\n  }\n\n  public override toJSON(): ExternalSourceAspectProps {\n    const val = super.toJSON() as ExternalSourceAspectProps;\n    val.scope = this.scope;\n    val.source = this.source;\n    val.identifier = this.identifier;\n    val.kind = this.kind;\n    val.checksum = this.checksum;\n    val.version = this.version;\n    val.jsonProperties = this.jsonProperties;\n    return val;\n  }\n\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    if (this.scope)\n      referenceIds.addElement(this.scope.id);\n    referenceIds.addElement(this.element.id);\n    if (this.source)\n      referenceIds.addElement(this.source.id);\n  }\n}\n\n/** @public @preview */\nexport namespace ExternalSourceAspect {\n  /** Standard values for the `Kind` property of `ExternalSourceAspect`.\n   * @public @preview\n   */\n  export enum Kind {\n    /** Indicates that the [[ExternalSourceAspect]] is storing [[Element]] provenance */\n    Element = \"Element\",\n    /** Indicates that the [[ExternalSourceAspect]] is storing [[Relationship]] provenance */\n    Relationship = \"Relationship\",\n    /** Indicates that the [[ExternalSourceAspect]] is storing *scope* provenance\n     * @see [[ExternalSourceAspect.scope]]\n     */\n    Scope = \"Scope\",\n  }\n}\n"]}

package/lib/cjs/Entity.d.ts

@@ -5,7 +5,7 @@ import { Id64String } from "@itwin/core-bentley";
 import { ElementLoadOptions, EntityProps, EntityReferenceSet, PropertyCallback } from "@itwin/core-common";
 import type { IModelDb } from "./IModelDb";
 import { Schema } from "./Schema";
-import { EntityClass, Property, SchemaItemKey } from "@itwin/ecschema-metadata";
+import { EntityClass, Property, RelationshipClass, SchemaItemKey } from "@itwin/ecschema-metadata";
 /** Represents a row returned by an ECSql query. The row is returned as a map of property names to values.
  * ECSqlRow has same schema as declared in ECSchema for the class and similar to if ECSQL SELECT * FROM <schema>:<class> were executed.
  * @beta */
@@ -36,7 +36,7 @@ export interface CustomHandledProperty {
 /** Represents one of the fundamental building block in an [[IModelDb]]: as an [[Element]], [[Model]], or [[Relationship]].
  * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).
  * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].
- * @public
+ * @public @preview
  */
 export declare class Entity {
     /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types
@@ -56,7 +56,8 @@ export declare class Entity {
      * @public @preview
      */
     static get schemaItemKey(): SchemaItemKey;
-    private _metadata?;
+    /** Cached Metadata for the ECClass */
+    protected _metadata?: EntityClass | RelationshipClass;
     /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.
      * This property makes such code slightly less tedious to read and write.
      * @internal
@@ -96,7 +97,7 @@ export declare class Entity {
      * @param func The callback to be invoked on each property
      * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
      * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
-     * @deprecated in 5.0. Please use `forEach` to get the metadata and iterate over the properties instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `forEach` to get the metadata and iterate over the properties instead.
      *
      * @example
      * ```typescript
@@ -136,12 +137,14 @@ export declare class Entity {
      * @public @preview
      */
     get schemaItemKey(): SchemaItemKey;
-    /** query metadata for this entity class from the iModel's schema
+    /** Query metadata for this entity class from the iModel's schema. Returns cached metadata if available.
      * @throws [[IModelError]] if there is a problem querying the schema
      * @returns The metadata for the current entity
      * @public @preview
      */
-    getMetaData(): Promise<EntityClass>;
+    getMetaData(): Promise<EntityClass | RelationshipClass>;
+    /** @internal */
+    getMetaDataSync(): EntityClass | RelationshipClass;
     /** @internal */
     static get protectedOperations(): string[];
     /** return whether this Entity class is a subclass of another Entity class
@@ -178,7 +181,7 @@ export declare class Entity {
  */
 export type PropertyHandler = (name: string, property: Property) => void;
 /** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.
- * @public
+ * @public @preview
  */
 export type EntityClassType<T> = Function & {
     prototype: T;

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,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,kBAAkB,EAAE,gBAAgB,EAAoB,MAAM,oBAAoB,CAAC;AAC7H,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAGhF;;WAEW;AACX,MAAM,WAAW,QAAQ;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED;WACW;AACX,MAAM,WAAW,qBAAqB;IACpC,yBAAyB;IACzB,GAAG,EAAE,QAAQ,CAAC;IACd,2CAA2C;IAC3C,MAAM,EAAE,QAAQ,CAAC;IACjB,oCAAoC;IACpC,OAAO,CAAC,EAAE;QACR,2CAA2C;QAC3C,OAAO,CAAC,EAAE,kBAAkB,CAAC;KAC9B,CAAA;CACF;AAED;WACW;AACX,MAAM,WAAW,qBAAqB;IACpC,6DAA6D;IAC7D,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,oCAAoC;IACpC,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,UAAU,CAAC;CACvC;AAED;;;;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;;OAEG;IACH,WAAkB,aAAa,IAAI,aAAa,CAG/C;IAED,OAAO,CAAC,SAAS,CAAC,CAAc;IAEhC;;;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;IAGtB,SAAS,aAAa,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ;IAQ1D;;OAEG;WACW,WAAW,CAAC,QAAQ,EAAE,OAAO,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,GAAG,MAAM;IAIhG;;eAEW;IACX,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,qBAAqB,EAAE,CAIpE;IAEF;mBACe;IACf,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAYzC;eACW;WACG,WAAW,CAAC,KAAK,EAAE,qBAAqB,GAAG,WAAW;IAyBpE;eACW;WACG,SAAS,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,GAAG,QAAQ;IAcxE;;OAEG;IACI,MAAM,IAAI,WAAW;IAU5B;;;;;;;;;;;;;;;;;;OAkBG;IAEI,eAAe,CAAC,IAAI,EAAE,gBAAgB,EAAE,aAAa,GAAE,OAAc;IAK5E;;;;;;;;;;;;;OAaG;IACI,OAAO,CAAC,IAAI,EAAE,eAAe,EAAE,aAAa,GAAE,OAAc;IAWnE,4EAA4E;IAC5E,WAAkB,aAAa,IAAI,MAAM,CAA0D;IAEnG,6EAA6E;IAC7E,IAAW,aAAa,IAAI,MAAM,CAAqC;IACvE;;;OAGG;IACH,IAAW,aAAa,IAAI,aAAa,CAAqC;IAE9E;;;;OAIG;IACU,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC;IAahD,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;;;;;;;OAOG;IACH,SAAS,CAAC,mBAAmB,CAAC,aAAa,EAAE,kBAAkB,GAAG,IAAI;CAGvE;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;AAEzE;;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,kBAAkB,EAAE,WAAW,EAAE,kBAAkB,EAAE,gBAAgB,EAAoB,MAAM,oBAAoB,CAAC;AAC7H,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAW,WAAW,EAAE,QAAQ,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAG5G;;WAEW;AACX,MAAM,WAAW,QAAQ;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED;WACW;AACX,MAAM,WAAW,qBAAqB;IACpC,yBAAyB;IACzB,GAAG,EAAE,QAAQ,CAAC;IACd,2CAA2C;IAC3C,MAAM,EAAE,QAAQ,CAAC;IACjB,oCAAoC;IACpC,OAAO,CAAC,EAAE;QACR,2CAA2C;QAC3C,OAAO,CAAC,EAAE,kBAAkB,CAAC;KAC9B,CAAA;CACF;AAED;WACW;AACX,MAAM,WAAW,qBAAqB;IACpC,6DAA6D;IAC7D,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,oCAAoC;IACpC,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,UAAU,CAAC;CACvC;AAED;;;;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;;OAEG;IACH,WAAkB,aAAa,IAAI,aAAa,CAG/C;IAED,sCAAsC;IACtC,SAAS,CAAC,SAAS,CAAC,EAAE,WAAW,GAAG,iBAAiB,CAAC;IAEtD;;;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;IAGtB,SAAS,aAAa,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ;IAQ1D;;OAEG;WACW,WAAW,CAAC,QAAQ,EAAE,OAAO,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,GAAG,MAAM;IAIhG;;eAEW;IACX,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,qBAAqB,EAAE,CAIpE;IAEF;mBACe;IACf,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAYzC;eACW;WACG,WAAW,CAAC,KAAK,EAAE,qBAAqB,GAAG,WAAW;IAyBpE;eACW;WACG,SAAS,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,GAAG,QAAQ;IAcxE;;OAEG;IACI,MAAM,IAAI,WAAW;IAU5B;;;;;;;;;;;;;;;;;;OAkBG;IAEI,eAAe,CAAC,IAAI,EAAE,gBAAgB,EAAE,aAAa,GAAE,OAAc;IAK5E;;;;;;;;;;;;;OAaG;IACI,OAAO,CAAC,IAAI,EAAE,eAAe,EAAE,aAAa,GAAE,OAAc;IAanE,4EAA4E;IAC5E,WAAkB,aAAa,IAAI,MAAM,CAA0D;IAEnG,6EAA6E;IAC7E,IAAW,aAAa,IAAI,MAAM,CAAqC;IACvE;;;OAGG;IACH,IAAW,aAAa,IAAI,aAAa,CAAqC;IAE9E;;;;OAIG;IACU,WAAW,IAAI,OAAO,CAAC,WAAW,GAAG,iBAAiB,CAAC;IAcpE,gBAAgB;IACT,eAAe,IAAI,WAAW,GAAG,iBAAiB;IAczD,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;;;;;;;OAOG;IACH,SAAS,CAAC,mBAAmB,CAAC,aAAa,EAAE,kBAAkB,GAAG,IAAI;CAGvE;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,QAAQ,GAAG;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,CAAC"}

package/lib/cjs/Entity.js

@@ -15,7 +15,7 @@ const Symbols_1 = require("./internal/Symbols");
 /** Represents one of the fundamental building block in an [[IModelDb]]: as an [[Element]], [[Model]], or [[Relationship]].
  * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).
  * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].
- * @public
+ * @public @preview
  */
 class Entity {
     /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types
@@ -38,6 +38,7 @@ class Entity {
         // We cannot cache this here because the className gets overridden in subclasses
         return new ecschema_metadata_1.SchemaItemKey(this.className, this.schema.schemaKey);
     }
+    /** Cached Metadata for the ECClass */
     _metadata;
     /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.
      * This property makes such code slightly less tedious to read and write.
@@ -138,7 +139,7 @@ class Entity {
      * @param func The callback to be invoked on each property
      * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
      * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
-     * @deprecated in 5.0. Please use `forEach` to get the metadata and iterate over the properties instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `forEach` to get the metadata and iterate over the properties instead.
      *
      * @example
      * ```typescript
@@ -173,12 +174,15 @@ class Entity {
      * ```
      */
     forEach(func, includeCustom = true) {
-        const metaData = this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey, ecschema_metadata_1.EntityClass);
-        if (!metaData)
-            throw new Error(`Cannot get metadata for ${this.classFullName}`);
-        for (const property of metaData.getPropertiesSync()) {
-            if (includeCustom || !property.customAttributes?.has(`BisCore.CustomHandledProperty`))
-                func(property.name, property);
+        const item = this._metadata ?? this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey);
+        if (ecschema_metadata_1.EntityClass.isEntityClass(item) || ecschema_metadata_1.RelationshipClass.isRelationshipClass(item)) {
+            for (const property of item.getPropertiesSync()) {
+                if (includeCustom || !property.customAttributes?.has(`BisCore.CustomHandledProperty`))
+                    func(property.name, property);
+            }
+        }
+        else {
+            throw new Error(`Cannot get metadata for ${this.classFullName}. Class is not an EntityClass or RelationshipClass.`);
         }
     }
     /** Get the full BIS class name of this Entity in the form "schema:class" */
@@ -190,19 +194,37 @@ class Entity {
      * @public @preview
      */
     get schemaItemKey() { return this._ctor.schemaItemKey; }
-    /** query metadata for this entity class from the iModel's schema
+    /** Query metadata for this entity class from the iModel's schema. Returns cached metadata if available.
      * @throws [[IModelError]] if there is a problem querying the schema
      * @returns The metadata for the current entity
      * @public @preview
      */
     async getMetaData() {
-        if (!this._metadata) {
-            this._metadata = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, ecschema_metadata_1.EntityClass);
+        if (this._metadata) {
+            return this._metadata;
+        }
+        const ecClass = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, ecschema_metadata_1.ECClass);
+        if (ecschema_metadata_1.EntityClass.isEntityClass(ecClass) || ecschema_metadata_1.RelationshipClass.isRelationshipClass(ecClass)) {
+            this._metadata = ecClass;
+            return this._metadata;
+        }
+        else {
+            throw new Error(`Cannot get metadata for ${this.classFullName}`);
+        }
+    }
+    /** @internal */
+    getMetaDataSync() {
+        if (this._metadata) {
+            return this._metadata;
+        }
+        const ecClass = this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey, ecschema_metadata_1.ECClass);
+        if (ecschema_metadata_1.EntityClass.isEntityClass(ecClass) || ecschema_metadata_1.RelationshipClass.isRelationshipClass(ecClass)) {
+            this._metadata = ecClass;
+            return this._metadata;
         }
-        if (!this._metadata) {
+        else {
             throw new Error(`Cannot get metadata for ${this.classFullName}`);
         }
-        return this._metadata;
     }
     /** @internal */
     static get protectedOperations() { return []; }

package/lib/cjs/Entity.js.map

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

package/lib/cjs/ExportGraphics.d.ts

@@ -49,7 +49,7 @@ export interface ExportGraphicsMesh {
     normals: Float32Array;
     /** Parameters (uvs) for this mesh, laid out in the pattern XYXY */
     params: Float32Array;
-    /** If true, clients should assume both sides of the mesh are visible and not cull backfaces. */
+    /** If true, clients should assume both sides of the mesh are visible and not cull back faces. */
     isTwoSided: boolean;
 }
 /** Info provided to ExportGraphicsFunction about graphics.
@@ -273,18 +273,19 @@ export declare class ExportGraphicsMeshVisitor extends PolyfaceData implements P
     private _nextFacetIndex;
     private _numWrap;
     private _polyface;
-    private constructor();
+    protected constructor(facets: ExportGraphicsMesh, numWrap: number);
     /** Create a visitor for iterating the facets of `polyface`, with indicated number of points to be added to each facet to produce closed point arrays
      * Typical wrap counts are:
-     * * 0 -- leave the point arrays with "missing final edge"
+     * * 0 -- leave the point arrays with "missing final edge" (default)
      * * 1 -- add point 0 as closure point
      * * 2 -- add points 0 and 1 as closure and wrap point.  This is useful when vertex visit requires two adjacent vectors, e.g. for cross products.
      */
-    static create(polyface: ExportGraphicsMesh, numWrap: number): ExportGraphicsMeshVisitor;
-    /** Reset the iterator to start at the first facet of the polyface. */
+    static create(polyface: ExportGraphicsMesh, numWrap?: number): ExportGraphicsMeshVisitor;
+    /** Restart the visitor at the first facet. */
     reset(): void;
     /** Select a facet by simple index. */
     moveToReadIndex(facetIndex: number): boolean;
+    /** Load data for the next facet. */
     moveToNextFacet(): boolean;
     /** Set the number of vertices to replicate in visitor arrays. */
     setNumWrap(numWrap: number): void;
@@ -300,12 +301,12 @@ export declare class ExportGraphicsMeshVisitor extends PolyfaceData implements P
      * Use the artificial paramIndex, which matches pointIndex.
      */
     clientNormalIndex(i: number): number;
-    /** Return the color index of vertex i within the currently loaded facet */
+    /** Always returns -1 since we never have colors. */
     clientColorIndex(_i: number): number;
-    /** Return the aux data index of vertex i within the currently loaded facet */
+    /** Always returns -1 since we never have auxiliary data. */
     clientAuxIndex(_i: number): number;
     /** return the client polyface */
-    clientPolyface(): Polyface;
+    clientPolyface(): Polyface | undefined;
     /** clear the contents of all arrays.  Use this along with transferDataFrom methods to build up new facets */
     clearArrays(): void;
     /** transfer interpolated data from the other visitor.
@@ -314,5 +315,50 @@ export declare class ExportGraphicsMeshVisitor extends PolyfaceData implements P
     pushInterpolatedDataFrom(other: PolyfaceVisitor, index0: number, fraction: number, index1: number): void;
     /** transfer data from a specified index of the other visitor as new data in this visitor. */
     pushDataFrom(other: PolyfaceVisitor, index: number): void;
+    /** Return the number of facets this visitor is able to visit */
+    getVisitableFacetCount(): number;
+    /** Create a visitor for a subset of the facets visitable by the instance. */
+    createSubsetVisitor(facetIndices: number[], numWrap?: number): ExportGraphicsMeshSubsetVisitor;
+}
+/**
+ * An `ExportGraphicsMeshSubsetVisitor` is an `ExportGraphicsMeshVisitor` which only visits a subset of the facets.
+ * * The subset is defined by an array of facet indices provided when this visitor is created.
+ * * Input indices (e.g., for `moveToReadIndex`) are understood to be indices into the subset array.
+ * @public
+ */
+export declare class ExportGraphicsMeshSubsetVisitor extends ExportGraphicsMeshVisitor {
+    private _facetIndices;
+    private _currentSubsetIndex;
+    private _nextSubsetIndex;
+    private constructor();
+    private isValidSubsetIndex;
+    /**
+     * Create a visitor for iterating a subset of the facets of `polyface`.
+     * @param polyface reference to the client polyface, supplying facets
+     * @param facetIndices array of indices of facets in the client polyface to visit. This array is cloned.
+     * @param numWrap number of vertices replicated in the visitor arrays to facilitate simpler caller code. Default is zero.
+     */
+    static createSubsetVisitor(polyface: ExportGraphicsMesh, facetIndices: number[], numWrap?: number): ExportGraphicsMeshSubsetVisitor;
+    /**
+     * Advance the iterator to a particular facet in the subset of client polyface facets.
+     * @param subsetIndex index into the subset array, not to be confused with the client facet index.
+     * @return whether the iterator was successfully moved.
+     */
+    moveToReadIndex(subsetIndex: number): boolean;
+    /**
+     * Advance the iterator to the next facet in the subset of client polyface facets.
+     * @return whether the iterator was successfully moved.
+     */
+    moveToNextFacet(): boolean;
+    /** Restart the visitor at the first facet. */
+    reset(): void;
+    /**
+     * Return the client polyface facet index (aka "readIndex") for the given subset index.
+     * @param subsetIndex index into the subset array. Default is the subset index of the currently visited facet.
+     * @return valid client polyface facet index, or `undefined` if invalid subset index.
+     */
+    parentFacetIndex(subsetIndex?: number): number | undefined;
+    /** Return the number of facets this visitor is able to visit. */
+    getVisitableFacetCount(): number;
 }
 //# sourceMappingURL=ExportGraphics.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ExportGraphics.d.ts","sourceRoot":"","sources":["../../src/ExportGraphics.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAElE;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,4EAA4E;IAC5E,OAAO,EAAE,UAAU,CAAC;IACpB,+DAA+D;IAC/D,MAAM,EAAE,YAAY,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,kEAAkE;IAClE,SAAS,EAAE,UAAU,CAAC;IACtB,kEAAkE;IAClE,WAAW,EAAE,UAAU,CAAC;IACxB,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,sCAAsC;IACtC,KAAK,EAAE,mBAAmB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAC;AAElE;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,0EAA0E;IAC1E,OAAO,EAAE,UAAU,CAAC;IACpB,6DAA6D;IAC7D,MAAM,EAAE,YAAY,CAAC;IACrB,4DAA4D;IAC5D,OAAO,EAAE,YAAY,CAAC;IACtB,mEAAmE;IACnE,MAAM,EAAE,YAAY,CAAC;IACrB,gGAAgG;IAChG,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,kEAAkE;IAClE,SAAS,EAAE,UAAU,CAAC;IACtB,kEAAkE;IAClE,WAAW,EAAE,UAAU,CAAC;IACxB,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,uFAAuF;IACvF,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,kCAAkC;IAClC,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAC;IACvB,aAAa,EAAE,UAAU,CAAC;IAC1B,aAAa,EAAE,aAAa,CAAC;IAC7B,UAAU,EAAE,UAAU,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,+CAA+C;IAC/C,MAAM,EAAE,UAAU,CAAC;IACnB,2FAA2F;IAC3F,cAAc,EAAE,UAAU,CAAC;IAC3B,yFAAyF;IACzF,YAAY,EAAE,qBAAqB,CAAC;IACpC;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,oDAAoD;IACpD,cAAc,EAAE,SAAS,CAAC;IAC1B,mFAAmF;IACnF,UAAU,EAAE,sBAAsB,CAAC;IACnC,iEAAiE;IACjE,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACrC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAC7C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,uFAAuF;IACvF,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,kCAAkC;IAClC,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,sCAAsC;IACtC,KAAK,EAAE,mBAAmB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,IAAI,EAAE,mBAAmB,KAAK,IAAI,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0DAA0D;IAC1D,SAAS,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,YAAY,EAAE,qBAAqB,CAAC;IACpC,wEAAwE;IACxE,cAAc,EAAE,kBAAkB,CAAC;IACnC,iEAAiE;IACjE,kBAAkB,CAAC,EAAE,uBAAuB,CAAC;IAC7C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,SAAgB,wBAAwB,CAAC,GAAG,EAAE,qBAAqB,EAAE,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAYxG;IAED;;;;OAIG;IACH,SAAgB,wBAAwB,CAAC,IAAI,EAAE,kBAAkB,GAAG,eAAe,CA+BlF;CACF;AACD;;;;;;;GAOG;AACH,qBAAa,yBAA0B,SAAQ,YAAa,YAAW,eAAe;IACpF,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAqB;IAEtC,OAAO;IAUP;;;;;OAKG;WACW,MAAM,CAAC,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,GAAG,yBAAyB;IAG9F,sEAAsE;IAC/D,KAAK,IAAI,IAAI;IAIpB,sCAAsC;IAC/B,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAqD5C,eAAe,IAAI,OAAO;IAGjC,iEAAiE;IAC1D,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAExC,qEAAqE;IAC9D,gBAAgB,IAAI,MAAM;IACjC,2EAA2E;IACpE,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAC1C;;OAEG;IACI,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAC1C;;OAEG;IACI,iBAAiB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAC3C,2EAA2E;IACpE,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAC3C,8EAA8E;IACvE,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAEzC,iCAAiC;IAC1B,cAAc,IAAI,QAAQ;IACjC,6GAA6G;IACtG,WAAW,IAAI,IAAI;IAS1B;;OAEG;IACI,wBAAwB,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAO/G,6FAA6F;IACtF,YAAY,CAAC,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;CAUjE"}
+{"version":3,"file":"ExportGraphics.d.ts","sourceRoot":"","sources":["../../src/ExportGraphics.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAElE;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,4EAA4E;IAC5E,OAAO,EAAE,UAAU,CAAC;IACpB,+DAA+D;IAC/D,MAAM,EAAE,YAAY,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,kEAAkE;IAClE,SAAS,EAAE,UAAU,CAAC;IACtB,kEAAkE;IAClE,WAAW,EAAE,UAAU,CAAC;IACxB,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,sCAAsC;IACtC,KAAK,EAAE,mBAAmB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAC;AAElE;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,0EAA0E;IAC1E,OAAO,EAAE,UAAU,CAAC;IACpB,6DAA6D;IAC7D,MAAM,EAAE,YAAY,CAAC;IACrB,4DAA4D;IAC5D,OAAO,EAAE,YAAY,CAAC;IACtB,mEAAmE;IACnE,MAAM,EAAE,YAAY,CAAC;IACrB,iGAAiG;IACjG,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,kEAAkE;IAClE,SAAS,EAAE,UAAU,CAAC;IACtB,kEAAkE;IAClE,WAAW,EAAE,UAAU,CAAC;IACxB,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,uFAAuF;IACvF,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,kCAAkC;IAClC,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAC;IACvB,aAAa,EAAE,UAAU,CAAC;IAC1B,aAAa,EAAE,aAAa,CAAC;IAC7B,UAAU,EAAE,UAAU,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,+CAA+C;IAC/C,MAAM,EAAE,UAAU,CAAC;IACnB,2FAA2F;IAC3F,cAAc,EAAE,UAAU,CAAC;IAC3B,yFAAyF;IACzF,YAAY,EAAE,qBAAqB,CAAC;IACpC;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,oDAAoD;IACpD,cAAc,EAAE,SAAS,CAAC;IAC1B,mFAAmF;IACnF,UAAU,EAAE,sBAAsB,CAAC;IACnC,iEAAiE;IACjE,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACrC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAC7C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,uFAAuF;IACvF,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,kCAAkC;IAClC,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,sCAAsC;IACtC,KAAK,EAAE,mBAAmB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,IAAI,EAAE,mBAAmB,KAAK,IAAI,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0DAA0D;IAC1D,SAAS,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,YAAY,EAAE,qBAAqB,CAAC;IACpC,wEAAwE;IACxE,cAAc,EAAE,kBAAkB,CAAC;IACnC,iEAAiE;IACjE,kBAAkB,CAAC,EAAE,uBAAuB,CAAC;IAC7C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,SAAgB,wBAAwB,CAAC,GAAG,EAAE,qBAAqB,EAAE,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAYxG;IAED;;;;OAIG;IACH,SAAgB,wBAAwB,CAAC,IAAI,EAAE,kBAAkB,GAAG,eAAe,CA+BlF;CACF;AACD;;;;;;;GAOG;AACH,qBAAa,yBAA0B,SAAQ,YAAa,YAAW,eAAe;IACpF,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAqB;IACtC,SAAS,aAAa,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM;IAQjE;;;;;OAKG;WACW,MAAM,CAAC,QAAQ,EAAE,kBAAkB,EAAE,OAAO,GAAE,MAAU,GAAG,yBAAyB;IAGlG,8CAA8C;IACvC,KAAK,IAAI,IAAI;IAIpB,sCAAsC;IAC/B,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAoDnD,oCAAoC;IAC7B,eAAe,IAAI,OAAO;IAMjC,iEAAiE;IAC1D,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAIxC,qEAAqE;IAC9D,gBAAgB,IAAI,MAAM;IAGjC,2EAA2E;IACpE,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG1C;;OAEG;IACI,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG1C;;OAEG;IACI,iBAAiB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG3C,oDAAoD;IAC7C,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAG3C,4DAA4D;IACrD,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAGzC,iCAAiC;IAC1B,cAAc,IAAI,QAAQ,GAAG,SAAS;IAG7C,6GAA6G;IACtG,WAAW,IAAI,IAAI;IAS1B;;OAEG;IACI,wBAAwB,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAO/G,6FAA6F;IACtF,YAAY,CAAC,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAQhE,gEAAgE;IACzD,sBAAsB,IAAI,MAAM;IAGvC,6EAA6E;IACtE,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,MAAU,GAAG,+BAA+B;CAGzG;AAED;;;;;GAKG;AACH,qBAAa,+BAAgC,SAAQ,yBAAyB;IAC5E,OAAO,CAAC,aAAa,CAAW;IAChC,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,gBAAgB,CAAS;IAEjC,OAAO;IAOP,OAAO,CAAC,kBAAkB;IAG1B;;;;;OAKG;WACW,mBAAmB,CAC/B,QAAQ,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,MAAU,GACxE,+BAA+B;IAGlC;;;;OAIG;IACa,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAQ7D;;;OAGG;IACa,eAAe,IAAI,OAAO;IAM1C,8CAA8C;IAC9B,KAAK,IAAI,IAAI;IAM7B;;;;OAIG;IACI,gBAAgB,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAKjE,iEAAiE;IACjD,sBAAsB,IAAI,MAAM;CAGjD"}