@itwin/core-common 5.0.0-dev.9 → 5.0.0-dev.92

package/lib/esm/EntityProps.d.ts

@@ -77,10 +77,25 @@ export declare enum PrimitiveTypeCode {
 }
 /** A callback function to process properties of an Entity
  * @beta
+ * @deprecated in 5.0. Use `PropertyHandler` from `@itwin/ecschema-metadata` instead.
+ *
+ * @example
+ * ```typescript
+ * // Current usage:
+ * const callback: PropertyCallback = (name: string, propMetaData: PropertyMetaData) => {
+ *  console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);
+ * };
+ *
+ * // Replacement:
+ * const callback: PropertyHandler = (propName: string, property: Property) => {
+ *  console.log(`Property name: ${propName}, Property type: ${property.propertyType}`);
+ * };
+ * ```
  */
 export type PropertyCallback = (name: string, meta: PropertyMetaData) => void;
 /** A custom attribute instance
  * @beta
+ * @deprecated in 5.0. Use `CustomAttribute` interface from `@itwin/ecschema-metadata` instead.
  */
 export interface CustomAttribute {
     /** The class of the CustomAttribute */
@@ -90,7 +105,10 @@ export interface CustomAttribute {
         [propName: string]: any;
     };
 }
-/** @beta */
+/**
+ * @beta
+ * @deprecated in 5.0. Use `@itwin/ecschema-metadata` instead.
+ */
 export interface PropertyMetaDataProps {
     primitiveType?: number;
     structName?: string;
@@ -113,6 +131,7 @@ export interface PropertyMetaDataProps {
 }
 /** Metadata for a property.
  * @beta
+ * @deprecated in 5.0. Use the `Property` class from @itwin/ecschema-metadata` instead.
  */
 export declare class PropertyMetaData implements PropertyMetaDataProps {
     primitiveType?: PrimitiveTypeCode;
@@ -141,7 +160,10 @@ export declare class PropertyMetaData implements PropertyMetaDataProps {
     /** Return `true` if this property is a NavigationProperty. */
     get isNavigation(): boolean;
 }
-/** @beta */
+/**
+ * @beta
+ * @deprecated in 5.0. Use `@itwin/ecschema-metadata` instead.
+ */
 export interface EntityMetaDataProps {
     classId: Id64String;
     ecclass: string;
@@ -159,6 +181,7 @@ export interface EntityMetaDataProps {
 }
 /** Metadata for an Entity.
  * @beta
+ * @deprecated in 5.0. Use `EntityClass` class from `@itwin/ecschema-metadata` instead.
  */
 export declare class EntityMetaData implements EntityMetaDataProps {
     /** The Id of the class in the [[IModelDb]] from which the metadata was obtained. */

package/lib/esm/EntityProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EntityProps.d.ts","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAIvD;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,KAAK,CAAC;IACpC,mIAAmI;IACnI,aAAa,EAAE,MAAM,CAAC;IACtB,+FAA+F;IAC/F,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB,sHAAsH;IACtH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,UAAU,CAAC;IACrB,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW,EAAE,eAAe;CACtE;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gFAAgF;IAChF,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,8FAA8F;IAC9F,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+FAA+F;IAC/F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oEAAoE;IACpE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,aAAa,IAAO;IACpB,MAAM,MAAQ;IACd,OAAO,MAAQ;IACf,QAAQ,MAAQ;IAChB,MAAM,OAAQ;IACd,OAAO,OAAQ;IACf,IAAI,OAAQ;IACZ,OAAO,OAAQ,CAAE,mDAAmD;IACpE,OAAO,OAAQ,CAAE,mDAAmD;IACpE,MAAM,OAAQ;IACd,SAAS,OAAQ;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,yGAAyG;IACzG,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC;AAID,YAAY;AACZ,MAAM,WAAW,qBAAqB;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;CACtC;AAED;;GAEG;AACH,qBAAa,gBAAiB,YAAW,qBAAqB;IACrD,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;gBAEzB,OAAO,EAAE,qBAAqB;IA2BjD,mFAAmF;IACnF,OAAO,CAAC,kBAAkB;IAS1B,kFAAkF;IAC3E,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;IAyBxC,8DAA8D;IAC9D,IAAW,YAAY,IAAI,OAAO,CAEjC;CACF;AAED,YAAY;AACZ,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,UAAU,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gKAAgK;IAChK,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,qFAAqF;IACrF,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;CACtD;AAED;;GAEG;AACH,qBAAa,cAAe,YAAW,mBAAmB;IACxD,oFAAoF;IACpF,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,sBAAsB;IACtB,SAAgB,OAAO,EAAE,MAAM,CAAC;IAChC,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrC,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClC,SAAgB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtC,uIAAuI;IACvI,SAAgB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtC,2CAA2C;IAC3C,SAAgB,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrD,qFAAqF;IACrF,SAAgB,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;gBAElD,OAAO,EAAE,mBAAmB;CAchD"}
+{"version":3,"file":"EntityProps.d.ts","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAIvD;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,KAAK,CAAC;IACpC,mIAAmI;IACnI,aAAa,EAAE,MAAM,CAAC;IACtB,+FAA+F;IAC/F,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB,sHAAsH;IACtH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,UAAU,CAAC;IACrB,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW,EAAE,eAAe;CACtE;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gFAAgF;IAChF,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,8FAA8F;IAC9F,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+FAA+F;IAC/F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oEAAoE;IACpE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,aAAa,IAAO;IACpB,MAAM,MAAQ;IACd,OAAO,MAAQ;IACf,QAAQ,MAAQ;IAChB,MAAM,OAAQ;IACd,OAAO,OAAQ;IACf,IAAI,OAAQ;IACZ,OAAO,OAAQ,CAAE,mDAAmD;IACpE,OAAO,OAAQ,CAAE,mDAAmD;IACpE,MAAM,OAAQ;IACd,SAAS,OAAQ;CAClB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;AAE9E;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,yGAAyG;IACzG,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC;AAID;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;CACtC;AAED;;;GAGG;AACH,qBAAa,gBAAiB,YAAW,qBAAqB;IACrD,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;gBAGzB,OAAO,EAAE,qBAAqB;IA2BjD,mFAAmF;IACnF,OAAO,CAAC,kBAAkB;IAS1B,kFAAkF;IAC3E,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;IAyBxC,8DAA8D;IAC9D,IAAW,YAAY,IAAI,OAAO,CAEjC;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,UAAU,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gKAAgK;IAChK,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,2CAA2C;IAE3C,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,qFAAqF;IAErF,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;CACtD;AAED;;;GAGG;AACH,qBAAa,cAAe,YAAW,mBAAmB;IACxD,oFAAoF;IACpF,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,sBAAsB;IACtB,SAAgB,OAAO,EAAE,MAAM,CAAC;IAChC,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrC,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClC,SAAgB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtC,uIAAuI;IACvI,SAAgB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtC,2CAA2C;IAE3C,SAAgB,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrD,qFAAqF;IAErF,SAAgB,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;gBAGlD,OAAO,EAAE,mBAAmB;CAehD"}

package/lib/esm/EntityProps.js

@@ -27,8 +27,29 @@ export var PrimitiveTypeCode;
 })(PrimitiveTypeCode || (PrimitiveTypeCode = {}));
 /** Metadata for a property.
  * @beta
+ * @deprecated in 5.0. Use the `Property` class from @itwin/ecschema-metadata` instead.
  */
 export class PropertyMetaData {
+    primitiveType;
+    structName;
+    extendedType;
+    description;
+    displayLabel;
+    minimumValue;
+    maximumValue;
+    minimumLength;
+    maximumLength;
+    readOnly;
+    kindOfQuantity;
+    isCustomHandled;
+    isCustomHandledOrphan;
+    minOccurs;
+    maxOccurs;
+    direction;
+    relationshipClass;
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    customAttributes;
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     constructor(jsonObj) {
         this.primitiveType = jsonObj.primitiveType;
         if (jsonObj.structName)
@@ -91,8 +112,25 @@ export class PropertyMetaData {
 }
 /** Metadata for an Entity.
  * @beta
+ * @deprecated in 5.0. Use `EntityClass` class from `@itwin/ecschema-metadata` instead.
  */
 export class EntityMetaData {
+    /** The Id of the class in the [[IModelDb]] from which the metadata was obtained. */
+    classId;
+    /** The Entity name */
+    ecclass;
+    description;
+    modifier;
+    displayLabel;
+    /** The  base class that this class is derives from. If more than one, the first is the actual base class and the others are mixins. */
+    baseClasses;
+    /** The Custom Attributes for this class */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    customAttributes;
+    /** An object whose properties correspond by name to the properties of this class. */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    properties;
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     constructor(jsonObj) {
         this.classId = jsonObj.classId;
         this.ecclass = jsonObj.ecclass;
@@ -103,6 +141,7 @@ export class EntityMetaData {
         this.customAttributes = jsonObj.customAttributes;
         this.properties = {};
         for (const propName in jsonObj.properties) { // eslint-disable-line guard-for-in
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
             this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);
         }
     }

package/lib/esm/EntityProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntityProps.js","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AA6DhD;;GAEG;AACH,MAAM,CAAN,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,2EAAoB,CAAA;IACpB,+DAAc,CAAA;IACd,iEAAe,CAAA;IACf,mEAAgB,CAAA;IAChB,gEAAc,CAAA;IACd,kEAAe,CAAA;IACf,4DAAY,CAAA;IACZ,kEAAe,CAAA;IACf,kEAAe,CAAA;IACf,gEAAc,CAAA;IACd,sEAAiB,CAAA;AACnB,CAAC,EAZW,iBAAiB,KAAjB,iBAAiB,QAY5B;AAyCD;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAoB3B,YAAmB,OAA8B;QAC/C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC3C,IAAI,OAAO,CAAC,UAAU;YACpB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IACnD,CAAC;IAED,mFAAmF;IAC3E,kBAAkB,CAAC,IAAiB,EAAE,OAAY;QACxD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;QAEvC,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,OAAO,CAAC,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3D,OAAO,GAAG,CAAC;IACb,CAAC;IAED,kFAAkF;IAC3E,cAAc,CAAC,OAAY;QAChC,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;YACrC,QAAQ,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC3B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM,CAAC;gBAC9B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM;oBAC3B,OAAO,OAAO,CAAC,CAAC,wGAAwG;gBAE1H,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;gBAE1E,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO,OAAO,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEzF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,8DAA8D;IAC9D,IAAW,YAAY;QACrB,OAAO,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,gEAAgE;IACzG,CAAC;CACF;AAiBD;;GAEG;AACH,MAAM,OAAO,cAAc;IAezB,YAAmB,OAA4B;QAC7C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QAErB,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,mCAAmC;YAC9E,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Entities\r\n */\r\n\r\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\r\nimport { RelatedElement } from \"./ElementProps\";\r\n\r\n/** The persistent format of an [Entity]($backend), also used as the \"wire format\" when transmitting information about entities\r\n * between the backend and frontend.\r\n * EntityProps and all of its sub-types like [[ElementProps]] are \"plain old Javascript objects\" - that is, objects containing\r\n * no methods and no properties of `class` type.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface EntityProps {\r\n  /** A non-existent property used to discriminate between [[EntityProps]] and [Entity]($backend).\r\n   * @see [Entity.isInstanceOfEntity]($backend).\r\n   */\r\n  readonly isInstanceOfEntity?: never;\r\n  /** The full name of the [ECClass]($docs/bis/guide/references/glossary/#ecclass) for this entity, in the form \"Schema:ClassName\" */\r\n  classFullName: string;\r\n  /** The Id of the entity. Must be present for SELECT, UPDATE, or DELETE, ignored for INSERT. */\r\n  id?: Id64String;\r\n  /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this Entity. */\r\n  jsonProperties?: { [key: string]: any };\r\n}\r\n\r\n/** Specifies the source and target elements of a [[Relationship]] instance.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SourceAndTarget {\r\n  sourceId: Id64String;\r\n  targetId: Id64String;\r\n}\r\n\r\n/** Properties that are common to all types of link table ECRelationships\r\n * @public\r\n * @extensions\r\n */\r\nexport interface RelationshipProps extends EntityProps, SourceAndTarget {\r\n}\r\n\r\n/** Parameters for performing a query on [Entity]($backend) classes.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface EntityQueryParams {\r\n  /** The sql className, in the form \"Schema.ClassName\", of the class to search. */\r\n  from?: string;\r\n  /** Set to true to limit results to *not* include sub-classes of \"from\" class */\r\n  only?: boolean;\r\n  /** Optional \"WHERE\" clause to filter entities. Note: do *not* include the \"WHERE\" keyword. */\r\n  where?: string;\r\n  /** Optional \"ORDERBY\" clause to sort results. Note: do *not* include the \"ORDERBY\" keyword. */\r\n  orderBy?: string;\r\n  /** Optional \"LIMIT\" clause to limit the number of rows returned. */\r\n  limit?: number;\r\n  /** Optional \"OFFSET\" clause. Only valid if Limit is also present. */\r\n  offset?: number;\r\n  /** Bindings for parameterized values.\r\n   * @see [[ECSqlStatement.bindValues]]\r\n   */\r\n  bindings?: any[] | object;\r\n}\r\n\r\n/** The primitive types of an Entity property.\r\n * @beta\r\n */\r\nexport enum PrimitiveTypeCode {\r\n  Uninitialized = 0x00,\r\n  Binary = 0x101,\r\n  Boolean = 0x201,\r\n  DateTime = 0x301,\r\n  Double = 0x401,\r\n  Integer = 0x501,\r\n  Long = 0x601,\r\n  Point2d = 0x701, // eslint-disable-line @typescript-eslint/no-shadow\r\n  Point3d = 0x801, // eslint-disable-line @typescript-eslint/no-shadow\r\n  String = 0x901,\r\n  IGeometry = 0xa01, // Used for Bentley.Geometry.Common.IGeometry types\r\n}\r\n\r\n/** A callback function to process properties of an Entity\r\n * @beta\r\n */\r\nexport type PropertyCallback = (name: string, meta: PropertyMetaData) => void;\r\n\r\n/** A custom attribute instance\r\n * @beta\r\n */\r\nexport interface CustomAttribute {\r\n  /** The class of the CustomAttribute */\r\n  ecclass: string;\r\n  /** An object whose properties correspond by name to the properties of this custom attribute instance. */\r\n  properties: { [propName: string]: any };\r\n}\r\n\r\ntype FactoryFunc = (jsonObj: any) => any;\r\n\r\n/** @beta */\r\nexport interface PropertyMetaDataProps {\r\n  primitiveType?: number;\r\n  structName?: string;\r\n  extendedType?: string;\r\n  description?: string;\r\n  displayLabel?: string;\r\n  minimumValue?: any;\r\n  maximumValue?: any;\r\n  minimumLength?: number;\r\n  maximumLength?: number;\r\n  readOnly?: boolean;\r\n  kindOfQuantity?: string;\r\n  isCustomHandled?: boolean;\r\n  isCustomHandledOrphan?: boolean;\r\n  minOccurs?: number;\r\n  maxOccurs?: number;\r\n  direction?: string;\r\n  relationshipClass?: string;\r\n  customAttributes?: CustomAttribute[];\r\n}\r\n\r\n/** Metadata for a property.\r\n * @beta\r\n */\r\nexport class PropertyMetaData implements PropertyMetaDataProps {\r\n  public primitiveType?: PrimitiveTypeCode;\r\n  public structName?: string;\r\n  public extendedType?: string;\r\n  public description?: string;\r\n  public displayLabel?: string;\r\n  public minimumValue?: any;\r\n  public maximumValue?: any;\r\n  public minimumLength?: number;\r\n  public maximumLength?: number;\r\n  public readOnly?: boolean;\r\n  public kindOfQuantity?: string;\r\n  public isCustomHandled?: boolean;\r\n  public isCustomHandledOrphan?: boolean;\r\n  public minOccurs?: number;\r\n  public maxOccurs?: number;\r\n  public direction?: string;\r\n  public relationshipClass?: string;\r\n  public customAttributes?: CustomAttribute[];\r\n\r\n  public constructor(jsonObj: PropertyMetaDataProps) {\r\n    this.primitiveType = jsonObj.primitiveType;\r\n    if (jsonObj.structName)\r\n      this.structName = jsonObj.structName;\r\n    this.extendedType = jsonObj.extendedType;\r\n    this.description = jsonObj.description;\r\n    this.displayLabel = jsonObj.displayLabel;\r\n    if (undefined !== jsonObj.minimumValue)\r\n      this.minimumValue = jsonObj.minimumValue;\r\n    if (undefined !== jsonObj.maximumValue)\r\n      this.maximumValue = jsonObj.maximumValue;\r\n    if (undefined !== jsonObj.minimumLength)\r\n      this.minimumLength = jsonObj.minimumLength;\r\n    if (undefined !== jsonObj.maximumLength)\r\n      this.maximumLength = jsonObj.maximumLength;\r\n    this.readOnly = jsonObj.readOnly;\r\n    this.kindOfQuantity = jsonObj.kindOfQuantity;\r\n    this.isCustomHandled = jsonObj.isCustomHandled;\r\n    if (undefined !== jsonObj.minOccurs)\r\n      this.minOccurs = jsonObj.minOccurs;\r\n    if (undefined !== jsonObj.maxOccurs)\r\n      this.maxOccurs = jsonObj.maxOccurs;\r\n    this.direction = jsonObj.direction;\r\n    this.relationshipClass = jsonObj.relationshipClass;\r\n    this.customAttributes = jsonObj.customAttributes;\r\n  }\r\n\r\n  /** Create a typed value, or array of values, from a factory and an input object */\r\n  private createValueOrArray(func: FactoryFunc, jsonObj: any) {\r\n    if (undefined === this.minOccurs)\r\n      return func(jsonObj); // not an array\r\n\r\n    const val: any = [];\r\n    jsonObj.forEach((element: any) => val.push(func(element)));\r\n    return val;\r\n  }\r\n\r\n  /** construct a single property from an input object according to this metadata */\r\n  public createProperty(jsonObj: any): any {\r\n    if (jsonObj === undefined)\r\n      return undefined;\r\n\r\n    if (undefined !== this.primitiveType) {\r\n      switch (this.primitiveType) {\r\n        case PrimitiveTypeCode.Boolean:\r\n        case PrimitiveTypeCode.Double:\r\n        case PrimitiveTypeCode.Integer:\r\n        case PrimitiveTypeCode.String:\r\n          return jsonObj; // this works even for arrays or strings that are JSON because the parsed JSON is already the right type\r\n\r\n        case PrimitiveTypeCode.Point2d:\r\n          return this.createValueOrArray((obj) => Point2d.fromJSON(obj), jsonObj);\r\n\r\n        case PrimitiveTypeCode.Point3d:\r\n          return this.createValueOrArray((obj) => Point3d.fromJSON(obj), jsonObj);\r\n      }\r\n    }\r\n    if (this.isNavigation)\r\n      return jsonObj.id !== undefined ? new RelatedElement(jsonObj) : Id64.fromJSON(jsonObj);\r\n\r\n    return jsonObj;\r\n  }\r\n\r\n  /** Return `true` if this property is a NavigationProperty. */\r\n  public get isNavigation(): boolean {\r\n    return (this.direction !== undefined); // the presence of `direction` means it is a navigation property\r\n  }\r\n}\r\n\r\n/** @beta */\r\nexport interface EntityMetaDataProps {\r\n  classId: Id64String;\r\n  ecclass: string;\r\n  description?: string;\r\n  modifier?: string;\r\n  displayLabel?: string;\r\n  /** The  base classes from which this class derives. If more than one, the first is the super class and the others are [mixins]($docs/bis/ec/ec-mixin-class). */\r\n  baseClasses: string[];\r\n  /** The Custom Attributes for this class */\r\n  customAttributes?: CustomAttribute[];\r\n  /** An object whose properties correspond by name to the properties of this class. */\r\n  properties: { [propName: string]: PropertyMetaData };\r\n}\r\n\r\n/** Metadata for an Entity.\r\n * @beta\r\n */\r\nexport class EntityMetaData implements EntityMetaDataProps {\r\n  /** The Id of the class in the [[IModelDb]] from which the metadata was obtained. */\r\n  public readonly classId: Id64String;\r\n  /** The Entity name */\r\n  public readonly ecclass: string;\r\n  public readonly description?: string;\r\n  public readonly modifier?: string;\r\n  public readonly displayLabel?: string;\r\n  /** The  base class that this class is derives from. If more than one, the first is the actual base class and the others are mixins. */\r\n  public readonly baseClasses: string[];\r\n  /** The Custom Attributes for this class */\r\n  public readonly customAttributes?: CustomAttribute[];\r\n  /** An object whose properties correspond by name to the properties of this class. */\r\n  public readonly properties: { [propName: string]: PropertyMetaData };\r\n\r\n  public constructor(jsonObj: EntityMetaDataProps) {\r\n    this.classId = jsonObj.classId;\r\n    this.ecclass = jsonObj.ecclass;\r\n    this.description = jsonObj.description;\r\n    this.modifier = jsonObj.modifier;\r\n    this.displayLabel = jsonObj.displayLabel;\r\n    this.baseClasses = jsonObj.baseClasses;\r\n    this.customAttributes = jsonObj.customAttributes;\r\n    this.properties = {};\r\n\r\n    for (const propName in jsonObj.properties) { // eslint-disable-line guard-for-in\r\n      this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"EntityProps.js","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AA6DhD;;GAEG;AACH,MAAM,CAAN,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,2EAAoB,CAAA;IACpB,+DAAc,CAAA;IACd,iEAAe,CAAA;IACf,mEAAgB,CAAA;IAChB,gEAAc,CAAA;IACd,kEAAe,CAAA;IACf,4DAAY,CAAA;IACZ,kEAAe,CAAA;IACf,kEAAe,CAAA;IACf,gEAAc,CAAA;IACd,sEAAiB,CAAA;AACnB,CAAC,EAZW,iBAAiB,KAAjB,iBAAiB,QAY5B;AA4DD;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IACpB,aAAa,CAAqB;IAClC,UAAU,CAAU;IACpB,YAAY,CAAU;IACtB,WAAW,CAAU;IACrB,YAAY,CAAU;IACtB,YAAY,CAAO;IACnB,YAAY,CAAO;IACnB,aAAa,CAAU;IACvB,aAAa,CAAU;IACvB,QAAQ,CAAW;IACnB,cAAc,CAAU;IACxB,eAAe,CAAW;IAC1B,qBAAqB,CAAW;IAChC,SAAS,CAAU;IACnB,SAAS,CAAU;IACnB,SAAS,CAAU;IACnB,iBAAiB,CAAU;IAClC,4DAA4D;IACrD,gBAAgB,CAAqB;IAE5C,4DAA4D;IAC5D,YAAmB,OAA8B;QAC/C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC3C,IAAI,OAAO,CAAC,UAAU;YACpB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IACnD,CAAC;IAED,mFAAmF;IAC3E,kBAAkB,CAAC,IAAiB,EAAE,OAAY;QACxD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;QAEvC,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,OAAO,CAAC,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3D,OAAO,GAAG,CAAC;IACb,CAAC;IAED,kFAAkF;IAC3E,cAAc,CAAC,OAAY;QAChC,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;YACrC,QAAQ,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC3B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM,CAAC;gBAC9B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM;oBAC3B,OAAO,OAAO,CAAC,CAAC,wGAAwG;gBAE1H,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;gBAE1E,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO,OAAO,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEzF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,8DAA8D;IAC9D,IAAW,YAAY;QACrB,OAAO,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,gEAAgE;IACzG,CAAC;CACF;AAsBD;;;GAGG;AACH,MAAM,OAAO,cAAc;IACzB,oFAAoF;IACpE,OAAO,CAAa;IACpC,sBAAsB;IACN,OAAO,CAAS;IAChB,WAAW,CAAU;IACrB,QAAQ,CAAU;IAClB,YAAY,CAAU;IACtC,uIAAuI;IACvH,WAAW,CAAW;IACtC,2CAA2C;IAC3C,4DAA4D;IAC5C,gBAAgB,CAAqB;IACrD,qFAAqF;IACrF,4DAA4D;IAC5C,UAAU,CAA2C;IAErE,4DAA4D;IAC5D,YAAmB,OAA4B;QAC7C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QAErB,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,mCAAmC;YAC9E,4DAA4D;YAC5D,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;CACF","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 Entities\n */\n\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\nimport { RelatedElement } from \"./ElementProps\";\n\n/** The persistent format of an [Entity]($backend), also used as the \"wire format\" when transmitting information about entities\n * between the backend and frontend.\n * EntityProps and all of its sub-types like [[ElementProps]] are \"plain old Javascript objects\" - that is, objects containing\n * no methods and no properties of `class` type.\n * @public\n * @extensions\n */\nexport interface EntityProps {\n  /** A non-existent property used to discriminate between [[EntityProps]] and [Entity]($backend).\n   * @see [Entity.isInstanceOfEntity]($backend).\n   */\n  readonly isInstanceOfEntity?: never;\n  /** The full name of the [ECClass]($docs/bis/guide/references/glossary/#ecclass) for this entity, in the form \"Schema:ClassName\" */\n  classFullName: string;\n  /** The Id of the entity. Must be present for SELECT, UPDATE, or DELETE, ignored for INSERT. */\n  id?: Id64String;\n  /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this Entity. */\n  jsonProperties?: { [key: string]: any };\n}\n\n/** Specifies the source and target elements of a [[Relationship]] instance.\n * @public\n * @extensions\n */\nexport interface SourceAndTarget {\n  sourceId: Id64String;\n  targetId: Id64String;\n}\n\n/** Properties that are common to all types of link table ECRelationships\n * @public\n * @extensions\n */\nexport interface RelationshipProps extends EntityProps, SourceAndTarget {\n}\n\n/** Parameters for performing a query on [Entity]($backend) classes.\n * @public\n * @extensions\n */\nexport interface EntityQueryParams {\n  /** The sql className, in the form \"Schema.ClassName\", of the class to search. */\n  from?: string;\n  /** Set to true to limit results to *not* include sub-classes of \"from\" class */\n  only?: boolean;\n  /** Optional \"WHERE\" clause to filter entities. Note: do *not* include the \"WHERE\" keyword. */\n  where?: string;\n  /** Optional \"ORDERBY\" clause to sort results. Note: do *not* include the \"ORDERBY\" keyword. */\n  orderBy?: string;\n  /** Optional \"LIMIT\" clause to limit the number of rows returned. */\n  limit?: number;\n  /** Optional \"OFFSET\" clause. Only valid if Limit is also present. */\n  offset?: number;\n  /** Bindings for parameterized values.\n   * @see [[ECSqlStatement.bindValues]]\n   */\n  bindings?: any[] | object;\n}\n\n/** The primitive types of an Entity property.\n * @beta\n */\nexport enum PrimitiveTypeCode {\n  Uninitialized = 0x00,\n  Binary = 0x101,\n  Boolean = 0x201,\n  DateTime = 0x301,\n  Double = 0x401,\n  Integer = 0x501,\n  Long = 0x601,\n  Point2d = 0x701, // eslint-disable-line @typescript-eslint/no-shadow\n  Point3d = 0x801, // eslint-disable-line @typescript-eslint/no-shadow\n  String = 0x901,\n  IGeometry = 0xa01, // Used for Bentley.Geometry.Common.IGeometry types\n}\n\n/** A callback function to process properties of an Entity\n * @beta\n * @deprecated in 5.0. Use `PropertyHandler` from `@itwin/ecschema-metadata` instead.\n *\n * @example\n * ```typescript\n * // Current usage:\n * const callback: PropertyCallback = (name: string, propMetaData: PropertyMetaData) => {\n *  console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);\n * };\n *\n * // Replacement:\n * const callback: PropertyHandler = (propName: string, property: Property) => {\n *  console.log(`Property name: ${propName}, Property type: ${property.propertyType}`);\n * };\n * ```\n */\nexport type PropertyCallback = (name: string, meta: PropertyMetaData) => void;\n\n/** A custom attribute instance\n * @beta\n * @deprecated in 5.0. Use `CustomAttribute` interface from `@itwin/ecschema-metadata` instead.\n */\nexport interface CustomAttribute {\n  /** The class of the CustomAttribute */\n  ecclass: string;\n  /** An object whose properties correspond by name to the properties of this custom attribute instance. */\n  properties: { [propName: string]: any };\n}\n\ntype FactoryFunc = (jsonObj: any) => any;\n\n/**\n * @beta\n * @deprecated in 5.0. Use `@itwin/ecschema-metadata` instead.\n */\nexport interface PropertyMetaDataProps {\n  primitiveType?: number;\n  structName?: string;\n  extendedType?: string;\n  description?: string;\n  displayLabel?: string;\n  minimumValue?: any;\n  maximumValue?: any;\n  minimumLength?: number;\n  maximumLength?: number;\n  readOnly?: boolean;\n  kindOfQuantity?: string;\n  isCustomHandled?: boolean;\n  isCustomHandledOrphan?: boolean;\n  minOccurs?: number;\n  maxOccurs?: number;\n  direction?: string;\n  relationshipClass?: string;\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  customAttributes?: CustomAttribute[];\n}\n\n/** Metadata for a property.\n * @beta\n * @deprecated in 5.0. Use the `Property` class from @itwin/ecschema-metadata` instead.\n */\nexport class PropertyMetaData implements PropertyMetaDataProps {\n  public primitiveType?: PrimitiveTypeCode;\n  public structName?: string;\n  public extendedType?: string;\n  public description?: string;\n  public displayLabel?: string;\n  public minimumValue?: any;\n  public maximumValue?: any;\n  public minimumLength?: number;\n  public maximumLength?: number;\n  public readOnly?: boolean;\n  public kindOfQuantity?: string;\n  public isCustomHandled?: boolean;\n  public isCustomHandledOrphan?: boolean;\n  public minOccurs?: number;\n  public maxOccurs?: number;\n  public direction?: string;\n  public relationshipClass?: string;\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public customAttributes?: CustomAttribute[];\n\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public constructor(jsonObj: PropertyMetaDataProps) {\n    this.primitiveType = jsonObj.primitiveType;\n    if (jsonObj.structName)\n      this.structName = jsonObj.structName;\n    this.extendedType = jsonObj.extendedType;\n    this.description = jsonObj.description;\n    this.displayLabel = jsonObj.displayLabel;\n    if (undefined !== jsonObj.minimumValue)\n      this.minimumValue = jsonObj.minimumValue;\n    if (undefined !== jsonObj.maximumValue)\n      this.maximumValue = jsonObj.maximumValue;\n    if (undefined !== jsonObj.minimumLength)\n      this.minimumLength = jsonObj.minimumLength;\n    if (undefined !== jsonObj.maximumLength)\n      this.maximumLength = jsonObj.maximumLength;\n    this.readOnly = jsonObj.readOnly;\n    this.kindOfQuantity = jsonObj.kindOfQuantity;\n    this.isCustomHandled = jsonObj.isCustomHandled;\n    if (undefined !== jsonObj.minOccurs)\n      this.minOccurs = jsonObj.minOccurs;\n    if (undefined !== jsonObj.maxOccurs)\n      this.maxOccurs = jsonObj.maxOccurs;\n    this.direction = jsonObj.direction;\n    this.relationshipClass = jsonObj.relationshipClass;\n    this.customAttributes = jsonObj.customAttributes;\n  }\n\n  /** Create a typed value, or array of values, from a factory and an input object */\n  private createValueOrArray(func: FactoryFunc, jsonObj: any) {\n    if (undefined === this.minOccurs)\n      return func(jsonObj); // not an array\n\n    const val: any = [];\n    jsonObj.forEach((element: any) => val.push(func(element)));\n    return val;\n  }\n\n  /** construct a single property from an input object according to this metadata */\n  public createProperty(jsonObj: any): any {\n    if (jsonObj === undefined)\n      return undefined;\n\n    if (undefined !== this.primitiveType) {\n      switch (this.primitiveType) {\n        case PrimitiveTypeCode.Boolean:\n        case PrimitiveTypeCode.Double:\n        case PrimitiveTypeCode.Integer:\n        case PrimitiveTypeCode.String:\n          return jsonObj; // this works even for arrays or strings that are JSON because the parsed JSON is already the right type\n\n        case PrimitiveTypeCode.Point2d:\n          return this.createValueOrArray((obj) => Point2d.fromJSON(obj), jsonObj);\n\n        case PrimitiveTypeCode.Point3d:\n          return this.createValueOrArray((obj) => Point3d.fromJSON(obj), jsonObj);\n      }\n    }\n    if (this.isNavigation)\n      return jsonObj.id !== undefined ? new RelatedElement(jsonObj) : Id64.fromJSON(jsonObj);\n\n    return jsonObj;\n  }\n\n  /** Return `true` if this property is a NavigationProperty. */\n  public get isNavigation(): boolean {\n    return (this.direction !== undefined); // the presence of `direction` means it is a navigation property\n  }\n}\n\n/**\n * @beta\n * @deprecated in 5.0. Use `@itwin/ecschema-metadata` instead.\n */\nexport interface EntityMetaDataProps {\n  classId: Id64String;\n  ecclass: string;\n  description?: string;\n  modifier?: string;\n  displayLabel?: string;\n  /** The  base classes from which this class derives. If more than one, the first is the super class and the others are [mixins]($docs/bis/ec/ec-mixin-class). */\n  baseClasses: string[];\n  /** The Custom Attributes for this class */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  customAttributes?: CustomAttribute[];\n  /** An object whose properties correspond by name to the properties of this class. */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  properties: { [propName: string]: PropertyMetaData };\n}\n\n/** Metadata for an Entity.\n * @beta\n * @deprecated in 5.0. Use `EntityClass` class from `@itwin/ecschema-metadata` instead.\n */\nexport class EntityMetaData implements EntityMetaDataProps {\n  /** The Id of the class in the [[IModelDb]] from which the metadata was obtained. */\n  public readonly classId: Id64String;\n  /** The Entity name */\n  public readonly ecclass: string;\n  public readonly description?: string;\n  public readonly modifier?: string;\n  public readonly displayLabel?: string;\n  /** The  base class that this class is derives from. If more than one, the first is the actual base class and the others are mixins. */\n  public readonly baseClasses: string[];\n  /** The Custom Attributes for this class */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public readonly customAttributes?: CustomAttribute[];\n  /** An object whose properties correspond by name to the properties of this class. */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public readonly properties: { [propName: string]: PropertyMetaData };\n\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public constructor(jsonObj: EntityMetaDataProps) {\n    this.classId = jsonObj.classId;\n    this.ecclass = jsonObj.ecclass;\n    this.description = jsonObj.description;\n    this.modifier = jsonObj.modifier;\n    this.displayLabel = jsonObj.displayLabel;\n    this.baseClasses = jsonObj.baseClasses;\n    this.customAttributes = jsonObj.customAttributes;\n    this.properties = {};\n\n    for (const propName in jsonObj.properties) { // eslint-disable-line guard-for-in\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);\n    }\n  }\n}\n"]}

package/lib/esm/EntityReference.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntityReference.js","sourceRoot":"","sources":["../../src/EntityReference.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH;;;;;;;;;GASG;AACH,MAAM,CAAN,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,kCAAW,CAAA;IACX,oCAAa,CAAA;IACb,0CAAmB,CAAA;IACnB,yCAAkB,CAAA;AACpB,CAAC,EALW,mBAAmB,KAAnB,mBAAmB,QAK9B;AAED;;;GAGG;AACH,WAAiB,mBAAmB;IAClC,MAAM,6BAA6B,GAAG;QACpC,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,eAAe;QAC5C,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,iBAAiB;QAChD,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,uBAAuB;QAC5D,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAE,sBAAsB;KAClD,CAAC;IAEX;;OAEG;IACH,SAAgB,0BAA0B,CAAC,IAAyB;QAClE,OAAO,6BAA6B,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAFe,8CAA0B,6BAEzC,CAAA;AACH,CAAC,EAdgB,mBAAmB,KAAnB,mBAAmB,QAcnC;AAUD;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,GAAoB;IACnD,UAAU,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAClD,QAAQ,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAChD,SAAS,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IACjD,eAAe,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;CAC/D","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Schema\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\n\r\n/**\r\n * Types of concrete entities. Used for storing strings in JavaScript reference-equality containers which encode\r\n * low-level entity information.\r\n * @note the values of this enum are unstable, do not depend upon their values between versions of iTwin.js\r\n *       (e.g. do not serialize them and load them in another version of iTwin.js and expect them to work)\r\n * CodeSpecs are excepted since their JavaScript representation does not derive from [Entity]($backend)\r\n * @note the string value of each variant is required/guaranteed to be 1 character\r\n * @see EntityReference\r\n * @alpha\r\n */\r\nexport enum ConcreteEntityTypes {\r\n  Model = \"m\",\r\n  Element = \"e\",\r\n  ElementAspect = \"a\",\r\n  Relationship = \"r\",\r\n}\r\n\r\n/**\r\n * Adds some utilities to the [[ConcreteEntityTypes]] enum\r\n * @alpha\r\n */\r\nexport namespace ConcreteEntityTypes {\r\n  const toBisCoreRootClassFullNameMap = {\r\n    [ConcreteEntityTypes.Model]: \"BisCore:Model\",\r\n    [ConcreteEntityTypes.Element]: \"BisCore:Element\",\r\n    [ConcreteEntityTypes.ElementAspect]: \"BisCore:ElementAspect\",\r\n    [ConcreteEntityTypes.Relationship]: \"BisCore:Relationship\",\r\n  } as const;\r\n\r\n  /** used by the transformer to figure out where to check for the existence in a db of a concrete element id\r\n   * @internal\r\n   */\r\n  export function toBisCoreRootClassFullName(type: ConcreteEntityTypes): string {\r\n    return toBisCoreRootClassFullNameMap[type];\r\n  }\r\n}\r\n\r\n/**\r\n * This id format can be used for storing a unique key for an entity in containers like `Map`.\r\n * Elements and non-element entities have different id sequences, they can collide with each other, but not within themselves.\r\n * @note for utilities that require runtime backend classes, see [EntityReferences]($backend)\r\n * @alpha\r\n */\r\nexport type EntityReference = `${ConcreteEntityTypes}${Id64String}`;\r\n\r\n/** A set of concrete entity ids, with additional functions to more literately add ids where you have the raw id and know what type it is\r\n * @alpha\r\n */\r\nexport class EntityReferenceSet extends Set<EntityReference> {\r\n  public addElement(id: Id64String) { this.add(`e${id}`); }\r\n  public addModel(id: Id64String) { this.add(`m${id}`); }\r\n  public addAspect(id: Id64String) { this.add(`a${id}`); }\r\n  public addRelationship(id: Id64String) { this.add(`r${id}`); }\r\n}\r\n\r\n/** @internal entity reference type information of a relationship */\r\nexport interface RelTypeInfo {\r\n  source: ConcreteEntityTypes;\r\n  target: ConcreteEntityTypes;\r\n}\r\n"]}
+{"version":3,"file":"EntityReference.js","sourceRoot":"","sources":["../../src/EntityReference.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH;;;;;;;;;GASG;AACH,MAAM,CAAN,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,kCAAW,CAAA;IACX,oCAAa,CAAA;IACb,0CAAmB,CAAA;IACnB,yCAAkB,CAAA;AACpB,CAAC,EALW,mBAAmB,KAAnB,mBAAmB,QAK9B;AAED;;;GAGG;AACH,WAAiB,mBAAmB;IAClC,MAAM,6BAA6B,GAAG;QACpC,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,eAAe;QAC5C,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,iBAAiB;QAChD,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,uBAAuB;QAC5D,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAE,sBAAsB;KAClD,CAAC;IAEX;;OAEG;IACH,SAAgB,0BAA0B,CAAC,IAAyB;QAClE,OAAO,6BAA6B,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAFe,8CAA0B,6BAEzC,CAAA;AACH,CAAC,EAdgB,mBAAmB,KAAnB,mBAAmB,QAcnC;AAUD;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,GAAoB;IACnD,UAAU,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAClD,QAAQ,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAChD,SAAS,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IACjD,eAAe,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;CAC/D","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 { Id64String } from \"@itwin/core-bentley\";\n\n/**\n * Types of concrete entities. Used for storing strings in JavaScript reference-equality containers which encode\n * low-level entity information.\n * @note the values of this enum are unstable, do not depend upon their values between versions of iTwin.js\n *       (e.g. do not serialize them and load them in another version of iTwin.js and expect them to work)\n * CodeSpecs are excepted since their JavaScript representation does not derive from [Entity]($backend)\n * @note the string value of each variant is required/guaranteed to be 1 character\n * @see EntityReference\n * @alpha\n */\nexport enum ConcreteEntityTypes {\n  Model = \"m\",\n  Element = \"e\",\n  ElementAspect = \"a\",\n  Relationship = \"r\",\n}\n\n/**\n * Adds some utilities to the [[ConcreteEntityTypes]] enum\n * @alpha\n */\nexport namespace ConcreteEntityTypes {\n  const toBisCoreRootClassFullNameMap = {\n    [ConcreteEntityTypes.Model]: \"BisCore:Model\",\n    [ConcreteEntityTypes.Element]: \"BisCore:Element\",\n    [ConcreteEntityTypes.ElementAspect]: \"BisCore:ElementAspect\",\n    [ConcreteEntityTypes.Relationship]: \"BisCore:Relationship\",\n  } as const;\n\n  /** used by the transformer to figure out where to check for the existence in a db of a concrete element id\n   * @internal\n   */\n  export function toBisCoreRootClassFullName(type: ConcreteEntityTypes): string {\n    return toBisCoreRootClassFullNameMap[type];\n  }\n}\n\n/**\n * This id format can be used for storing a unique key for an entity in containers like `Map`.\n * Elements and non-element entities have different id sequences, they can collide with each other, but not within themselves.\n * @note for utilities that require runtime backend classes, see [EntityReferences]($backend)\n * @alpha\n */\nexport type EntityReference = `${ConcreteEntityTypes}${Id64String}`;\n\n/** A set of concrete entity ids, with additional functions to more literately add ids where you have the raw id and know what type it is\n * @alpha\n */\nexport class EntityReferenceSet extends Set<EntityReference> {\n  public addElement(id: Id64String) { this.add(`e${id}`); }\n  public addModel(id: Id64String) { this.add(`m${id}`); }\n  public addAspect(id: Id64String) { this.add(`a${id}`); }\n  public addRelationship(id: Id64String) { this.add(`r${id}`); }\n}\n\n/** @internal entity reference type information of a relationship */\nexport interface RelTypeInfo {\n  source: ConcreteEntityTypes;\n  target: ConcreteEntityTypes;\n}\n"]}

package/lib/esm/Environment.js

@@ -14,6 +14,29 @@ import { SkyBox } from "./SkyBox";
  * @public
  */
 export class Environment {
+    /** If true, the sky box will be displayed.
+     * Default: false.
+     * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleSkyBox]] to change this.
+     */
+    displaySky;
+    /** If true, the ground plane will be displayed.
+     * Default: false.
+     * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleGroundPlane]] to change this.
+     */
+    displayGround;
+    /**
+     * @beta
+     * If true, the atmosphere will be displayed. Enabling this will override any color information provided to the sky box.
+     * Default: false.
+     * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleAtmosphere]] to change this.
+     */
+    displayAtmosphere;
+    /** Describes how the sky box should be drawn. */
+    sky;
+    /** Describes how the ground plane should be drawn. */
+    ground;
+    /** @beta Describes how the atmosphere should be drawn */
+    atmosphere;
     constructor(props) {
         this.displaySky = props?.displaySky ?? false;
         this.displayGround = props?.displayGround ?? false;
@@ -22,6 +45,8 @@ export class Environment {
         this.ground = props?.ground ?? GroundPlane.defaults;
         this.atmosphere = props?.atmosphere ?? Atmosphere.Settings.defaults;
     }
+    /** Default settings without a ground plane, sky box, or atmosphere displayed. */
+    static defaults = new Environment();
     /** Create a new Environment. Any properties not specified by `props` will be initialized to their default values. */
     static create(props) {
         return props ? new this(props) : this.defaults;
@@ -70,6 +95,4 @@ export class Environment {
         return Environment.create({ ...this, ...changedProps });
     }
 }
-/** Default settings without a ground plane, sky box, or atmosphere displayed. */
-Environment.defaults = new Environment();
 //# sourceMappingURL=Environment.js.map

package/lib/esm/Environment.js.map

@@ -1 +1 @@
-{"version":3,"file":"Environment.js","sourceRoot":"","sources":["../../src/Environment.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAoB,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAe,MAAM,UAAU,CAAC;AAsB/C;;;;GAIG;AACH,MAAM,OAAO,WAAW;IA0BtB,YAAsB,KAAsC;QAC1D,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,KAAK,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,KAAK,CAAC;QACnD,IAAI,CAAC,iBAAiB,GAAG,KAAK,EAAE,iBAAiB,IAAI,KAAK,CAAC;QAC3D,IAAI,CAAC,GAAG,GAAG,KAAK,EAAE,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,KAAK,EAAE,MAAM,IAAI,WAAW,CAAC,QAAQ,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACtE,CAAC;IAKD,qHAAqH;IAC9G,MAAM,CAAC,MAAM,CAAC,KAAsC;QACzD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjD,CAAC;IAED,sHAAsH;IAC/G,WAAW,CAAC,OAAkE;QACnF,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC;QAClD,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,aAAa,CAAC;QAC3D,MAAM,iBAAiB,GAAG,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC,iBAAiB,CAAC;QACvE,IAAI,UAAU,KAAK,IAAI,CAAC,UAAU,IAAI,aAAa,KAAK,IAAI,CAAC,aAAa,IAAI,iBAAiB,KAAK,IAAI,CAAC,iBAAiB;YACxH,OAAO,IAAI,CAAC;QAEd,OAAO,WAAW,CAAC,MAAM,CAAC;YACxB,GAAG,IAAI;YACP,UAAU,EAAE,UAAU,IAAI,IAAI,CAAC,UAAU;YACzC,aAAa,EAAE,aAAa,IAAI,IAAI,CAAC,aAAa;YAClD,iBAAiB,EAAE,iBAAiB,IAAI,IAAI,CAAC,iBAAiB;SAC/D,CAAC,CAAC;IACL,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;YACrC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;YAC9C,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC;SAC3D,CAAC;IACJ,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAwB;QAC7C,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,IAAI,CAAC;YACd,UAAU,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO;YAC/B,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO;YACrC,iBAAiB,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO;YAC7C,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;YACxD,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;YACtE,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAA6C;QACxD,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC;QAEd,OAAO,WAAW,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IAC1D,CAAC;;AAxDD,iFAAiF;AAC1D,oBAAQ,GAAG,IAAI,WAAW,EAAE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { NonFunctionPropertiesOf } from \"@itwin/core-bentley\";\r\nimport { Atmosphere } from \"./Atmosphere\";\r\nimport { GroundPlane, GroundPlaneProps } from \"./GroundPlane\";\r\nimport { SkyBox, SkyBoxProps } from \"./SkyBox\";\r\n\r\n/** JSON representation of an [[Environment]].\r\n * @see [[DisplayStyle3dSettingsProps.environment]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface EnvironmentProps {\r\n  /** See [[Environment.ground]] and [[Environment.displayGround]]. */\r\n  ground?: GroundPlaneProps;\r\n  /** See [[Environment.sky]] and [[Environment.displaySky]]. */\r\n  sky?: SkyBoxProps;\r\n  /** @beta See [[Environment.atmosphere]] and [[Environment.displayAtmosphere]]. */\r\n  atmosphere?: Atmosphere.Props;\r\n}\r\n\r\n/** A type containing all of the properties of [[Environment]] with none of the methods and with the `readonly` modifiers removed.\r\n * @see [[Environment.create]] and [[Environment.clone]].\r\n * @public\r\n */\r\nexport type EnvironmentProperties = NonFunctionPropertiesOf<Environment>;\r\n\r\n/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the\r\n * outdoor environment.\r\n * @see [[DisplayStyle3dSettings.environment]].\r\n * @public\r\n */\r\nexport class Environment {\r\n  /** If true, the sky box will be displayed.\r\n   * Default: false.\r\n   * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleSkyBox]] to change this.\r\n   */\r\n  public readonly displaySky: boolean;\r\n  /** If true, the ground plane will be displayed.\r\n   * Default: false.\r\n   * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleGroundPlane]] to change this.\r\n   */\r\n  public readonly displayGround: boolean;\r\n  /**\r\n   * @beta\r\n   * If true, the atmosphere will be displayed. Enabling this will override any color information provided to the sky box.\r\n   * Default: false.\r\n   * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleAtmosphere]] to change this.\r\n   */\r\n  public readonly displayAtmosphere: boolean;\r\n\r\n  /** Describes how the sky box should be drawn. */\r\n  public readonly sky: SkyBox;\r\n  /** Describes how the ground plane should be drawn. */\r\n  public readonly ground: GroundPlane;\r\n  /** @beta Describes how the atmosphere should be drawn */\r\n  public readonly atmosphere: Atmosphere.Settings;\r\n\r\n  protected constructor(props?: Partial<EnvironmentProperties>) {\r\n    this.displaySky = props?.displaySky ?? false;\r\n    this.displayGround = props?.displayGround ?? false;\r\n    this.displayAtmosphere = props?.displayAtmosphere ?? false;\r\n    this.sky = props?.sky ?? SkyBox.defaults;\r\n    this.ground = props?.ground ?? GroundPlane.defaults;\r\n    this.atmosphere = props?.atmosphere ?? Atmosphere.Settings.defaults;\r\n  }\r\n\r\n  /** Default settings without a ground plane, sky box, or atmosphere displayed. */\r\n  public static readonly defaults = new Environment();\r\n\r\n  /** Create a new Environment. Any properties not specified by `props` will be initialized to their default values. */\r\n  public static create(props?: Partial<EnvironmentProperties>): Environment {\r\n    return props ? new this(props) : this.defaults;\r\n  }\r\n\r\n  /** Create a copy of this environment, changing the `displayGround`, `displaySky` and/or `displayAtmosphere` flags. */\r\n  public withDisplay(display: { sky?: boolean, ground?: boolean, atmosphere?: boolean }): Environment {\r\n    const displaySky = display.sky ?? this.displaySky;\r\n    const displayGround = display.ground ?? this.displayGround;\r\n    const displayAtmosphere = display.atmosphere ?? this.displayAtmosphere;\r\n    if (displaySky === this.displaySky && displayGround === this.displayGround && displayAtmosphere === this.displayAtmosphere)\r\n      return this;\r\n\r\n    return Environment.create({\r\n      ...this,\r\n      displaySky: displaySky ?? this.displaySky,\r\n      displayGround: displayGround ?? this.displayGround,\r\n      displayAtmosphere: displayAtmosphere ?? this.displayAtmosphere,\r\n    });\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): EnvironmentProps {\r\n    return {\r\n      sky: this.sky.toJSON(this.displaySky),\r\n      ground: this.ground.toJSON(this.displayGround),\r\n      atmosphere: this.atmosphere.toJSON(this.displayAtmosphere),\r\n    };\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: EnvironmentProps): Environment {\r\n    if (!props)\r\n      return this.defaults;\r\n\r\n    return new this({\r\n      displaySky: props?.sky?.display,\r\n      displayGround: props?.ground?.display,\r\n      displayAtmosphere: props?.atmosphere?.display,\r\n      sky: props?.sky ? SkyBox.fromJSON(props.sky) : undefined,\r\n      ground: props?.ground ? GroundPlane.fromJSON(props.ground) : undefined,\r\n      atmosphere: props?.atmosphere ? Atmosphere.Settings.fromJSON(props.atmosphere) : undefined,\r\n    });\r\n  }\r\n\r\n  /** Create a copy of this environment, identical except for any properties specified by `changedProps`.\r\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\r\n   */\r\n  public clone(changedProps?: Partial<EnvironmentProperties>): Environment {\r\n    if (!changedProps)\r\n      return this;\r\n\r\n    return Environment.create({ ...this, ...changedProps });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Environment.js","sourceRoot":"","sources":["../../src/Environment.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAoB,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAe,MAAM,UAAU,CAAC;AAsB/C;;;;GAIG;AACH,MAAM,OAAO,WAAW;IACtB;;;OAGG;IACa,UAAU,CAAU;IACpC;;;OAGG;IACa,aAAa,CAAU;IACvC;;;;;OAKG;IACa,iBAAiB,CAAU;IAE3C,iDAAiD;IACjC,GAAG,CAAS;IAC5B,sDAAsD;IACtC,MAAM,CAAc;IACpC,yDAAyD;IACzC,UAAU,CAAsB;IAEhD,YAAsB,KAAsC;QAC1D,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,KAAK,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,KAAK,CAAC;QACnD,IAAI,CAAC,iBAAiB,GAAG,KAAK,EAAE,iBAAiB,IAAI,KAAK,CAAC;QAC3D,IAAI,CAAC,GAAG,GAAG,KAAK,EAAE,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,KAAK,EAAE,MAAM,IAAI,WAAW,CAAC,QAAQ,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACtE,CAAC;IAED,iFAAiF;IAC1E,MAAM,CAAU,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC;IAEpD,qHAAqH;IAC9G,MAAM,CAAC,MAAM,CAAC,KAAsC;QACzD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjD,CAAC;IAED,sHAAsH;IAC/G,WAAW,CAAC,OAAkE;QACnF,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC;QAClD,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,aAAa,CAAC;QAC3D,MAAM,iBAAiB,GAAG,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC,iBAAiB,CAAC;QACvE,IAAI,UAAU,KAAK,IAAI,CAAC,UAAU,IAAI,aAAa,KAAK,IAAI,CAAC,aAAa,IAAI,iBAAiB,KAAK,IAAI,CAAC,iBAAiB;YACxH,OAAO,IAAI,CAAC;QAEd,OAAO,WAAW,CAAC,MAAM,CAAC;YACxB,GAAG,IAAI;YACP,UAAU,EAAE,UAAU,IAAI,IAAI,CAAC,UAAU;YACzC,aAAa,EAAE,aAAa,IAAI,IAAI,CAAC,aAAa;YAClD,iBAAiB,EAAE,iBAAiB,IAAI,IAAI,CAAC,iBAAiB;SAC/D,CAAC,CAAC;IACL,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;YACrC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;YAC9C,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC;SAC3D,CAAC;IACJ,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAwB;QAC7C,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,IAAI,CAAC;YACd,UAAU,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO;YAC/B,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO;YACrC,iBAAiB,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO;YAC7C,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;YACxD,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;YACtE,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAA6C;QACxD,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC;QAEd,OAAO,WAAW,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IAC1D,CAAC","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 DisplayStyles\n */\n\nimport { NonFunctionPropertiesOf } from \"@itwin/core-bentley\";\nimport { Atmosphere } from \"./Atmosphere\";\nimport { GroundPlane, GroundPlaneProps } from \"./GroundPlane\";\nimport { SkyBox, SkyBoxProps } from \"./SkyBox\";\n\n/** JSON representation of an [[Environment]].\n * @see [[DisplayStyle3dSettingsProps.environment]].\n * @public\n * @extensions\n */\nexport interface EnvironmentProps {\n  /** See [[Environment.ground]] and [[Environment.displayGround]]. */\n  ground?: GroundPlaneProps;\n  /** See [[Environment.sky]] and [[Environment.displaySky]]. */\n  sky?: SkyBoxProps;\n  /** @beta See [[Environment.atmosphere]] and [[Environment.displayAtmosphere]]. */\n  atmosphere?: Atmosphere.Props;\n}\n\n/** A type containing all of the properties of [[Environment]] with none of the methods and with the `readonly` modifiers removed.\n * @see [[Environment.create]] and [[Environment.clone]].\n * @public\n */\nexport type EnvironmentProperties = NonFunctionPropertiesOf<Environment>;\n\n/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the\n * outdoor environment.\n * @see [[DisplayStyle3dSettings.environment]].\n * @public\n */\nexport class Environment {\n  /** If true, the sky box will be displayed.\n   * Default: false.\n   * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleSkyBox]] to change this.\n   */\n  public readonly displaySky: boolean;\n  /** If true, the ground plane will be displayed.\n   * Default: false.\n   * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleGroundPlane]] to change this.\n   */\n  public readonly displayGround: boolean;\n  /**\n   * @beta\n   * If true, the atmosphere will be displayed. Enabling this will override any color information provided to the sky box.\n   * Default: false.\n   * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleAtmosphere]] to change this.\n   */\n  public readonly displayAtmosphere: boolean;\n\n  /** Describes how the sky box should be drawn. */\n  public readonly sky: SkyBox;\n  /** Describes how the ground plane should be drawn. */\n  public readonly ground: GroundPlane;\n  /** @beta Describes how the atmosphere should be drawn */\n  public readonly atmosphere: Atmosphere.Settings;\n\n  protected constructor(props?: Partial<EnvironmentProperties>) {\n    this.displaySky = props?.displaySky ?? false;\n    this.displayGround = props?.displayGround ?? false;\n    this.displayAtmosphere = props?.displayAtmosphere ?? false;\n    this.sky = props?.sky ?? SkyBox.defaults;\n    this.ground = props?.ground ?? GroundPlane.defaults;\n    this.atmosphere = props?.atmosphere ?? Atmosphere.Settings.defaults;\n  }\n\n  /** Default settings without a ground plane, sky box, or atmosphere displayed. */\n  public static readonly defaults = new Environment();\n\n  /** Create a new Environment. Any properties not specified by `props` will be initialized to their default values. */\n  public static create(props?: Partial<EnvironmentProperties>): Environment {\n    return props ? new this(props) : this.defaults;\n  }\n\n  /** Create a copy of this environment, changing the `displayGround`, `displaySky` and/or `displayAtmosphere` flags. */\n  public withDisplay(display: { sky?: boolean, ground?: boolean, atmosphere?: boolean }): Environment {\n    const displaySky = display.sky ?? this.displaySky;\n    const displayGround = display.ground ?? this.displayGround;\n    const displayAtmosphere = display.atmosphere ?? this.displayAtmosphere;\n    if (displaySky === this.displaySky && displayGround === this.displayGround && displayAtmosphere === this.displayAtmosphere)\n      return this;\n\n    return Environment.create({\n      ...this,\n      displaySky: displaySky ?? this.displaySky,\n      displayGround: displayGround ?? this.displayGround,\n      displayAtmosphere: displayAtmosphere ?? this.displayAtmosphere,\n    });\n  }\n\n  /** Convert to JSON representation. */\n  public toJSON(): EnvironmentProps {\n    return {\n      sky: this.sky.toJSON(this.displaySky),\n      ground: this.ground.toJSON(this.displayGround),\n      atmosphere: this.atmosphere.toJSON(this.displayAtmosphere),\n    };\n  }\n\n  /** Create from JSON representation. */\n  public static fromJSON(props?: EnvironmentProps): Environment {\n    if (!props)\n      return this.defaults;\n\n    return new this({\n      displaySky: props?.sky?.display,\n      displayGround: props?.ground?.display,\n      displayAtmosphere: props?.atmosphere?.display,\n      sky: props?.sky ? SkyBox.fromJSON(props.sky) : undefined,\n      ground: props?.ground ? GroundPlane.fromJSON(props.ground) : undefined,\n      atmosphere: props?.atmosphere ? Atmosphere.Settings.fromJSON(props.atmosphere) : undefined,\n    });\n  }\n\n  /** Create a copy of this environment, identical except for any properties specified by `changedProps`.\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\n   */\n  public clone(changedProps?: Partial<EnvironmentProperties>): Environment {\n    if (!changedProps)\n      return this;\n\n    return Environment.create({ ...this, ...changedProps });\n  }\n}\n"]}

package/lib/esm/FeatureIndex.js

@@ -13,6 +13,14 @@ import { ColorDef } from "./ColorDef";
  * @public
  */
 export class NonUniformColor {
+    /** An array of 32-bit [[ColorDef]] values in `tbgr` format, indexed by [[indices]]. */
+    colors;
+    /** For each vertex, an index into [[colors]] indicating the color of that vertex. */
+    indices;
+    /** If `true`, indicates none of the [[colors]] have a transparency greater than zero; otherwise, all of
+     * the colors have a transparency greater than zero.
+     */
+    isOpaque;
     /** Constructor.
      * @param colors See [[colors]].
      * @param indices See [[indices]]
@@ -29,6 +37,7 @@ export class NonUniformColor {
  * @public
  */
 export class ColorIndex {
+    _color;
     /** Whether the color(s) in this index have transparency. */
     get hasAlpha() { return !this._color.isOpaque; }
     /** Whether this index specifies a single uniform color for the entire mesh or polyline. */
@@ -78,12 +87,12 @@ export var FeatureIndexType;
  * @public
  */
 export class FeatureIndex {
-    constructor() {
-        /** Describes the quantity (zero, one, or more than one) of features in this index. */
-        this.type = FeatureIndexType.Empty;
-        /** If [[type]] is [[FeatureIndexType.Uniform]], the Id of the single feature. */
-        this.featureID = 0;
-    }
+    /** Describes the quantity (zero, one, or more than one) of features in this index. */
+    type = FeatureIndexType.Empty;
+    /** If [[type]] is [[FeatureIndexType.Uniform]], the Id of the single feature. */
+    featureID = 0;
+    /** If [[type]] is [[FeatureIndexType.NonUniform]], the per-vertex feature Ids, indexed by the mesh or polyline's vertex indices. */
+    featureIDs;
     /** True if [[type]] is [[FeatureIndexType.Uniform]]. */
     get isUniform() { return FeatureIndexType.Uniform === this.type; }
     /** True if [[type]] is [[FeatureIndexType.Empty]]. */

package/lib/esm/FeatureIndex.js.map

@@ -1 +1 @@
-{"version":3,"file":"FeatureIndex.js","sourceRoot":"","sources":["../../src/FeatureIndex.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,OAAO,eAAe;IAU1B;;;;OAIG;IACH,YAAmB,MAAmB,EAAE,OAAiB,EAAE,QAAiB;QAC1E,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,GAAG,CAAC,QAAQ,CAAC;IAC5B,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,UAAU;IAGrB,4DAA4D;IAC5D,IAAW,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvD,2FAA2F;IAC3F,IAAW,SAAS,KAAK,OAAO,IAAI,CAAC,MAAM,YAAY,QAAQ,CAAC,CAAC,CAAC;IAClE,0CAA0C;IAC1C,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAE9F,kEAAkE;IAClE,gBAAuB,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAEtD,yDAAyD;IAClD,KAAK,KAAK,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAEhD,oHAAoH;IACpH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9D,CAAC;IAED,6DAA6D;IACtD,WAAW,CAAC,KAAwB;QACzC,IAAI,CAAC,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC7E,CAAC;IAED,4FAA4F;IAC5F,IAAW,UAAU;QACnB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAyB,CAAC,CAAC,CAAC,SAAS,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,MAAmB,EAAE,OAAiB,EAAE,QAAiB;QAC7E,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,qDAAqD;IACrD,yDAAK,CAAA;IACL,6DAA6D;IAC7D,6DAAO,CAAA;IACP,+DAA+D;IAC/D,mEAAU,CAAA;AACZ,CAAC,EAPW,gBAAgB,KAAhB,gBAAgB,QAO3B;AAED;;;;GAIG;AACH,MAAM,OAAO,YAAY;IAAzB;QACE,sFAAsF;QAC/E,SAAI,GAAqB,gBAAgB,CAAC,KAAK,CAAC;QAEvD,iFAAiF;QAC1E,cAAS,GAAW,CAAC,CAAC;IAgB/B,CAAC;IAZC,wDAAwD;IACxD,IAAW,SAAS,KAAc,OAAO,gBAAgB,CAAC,OAAO,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAElF,sDAAsD;IACtD,IAAW,OAAO,KAAc,OAAO,gBAAgB,CAAC,KAAK,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAE9E,+BAA+B;IACxB,KAAK;QACV,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Rendering\r\n */\r\n\r\nimport { ColorDef } from \"./ColorDef\";\r\n\r\n/** As part of a [[ColorIndex]], describes per-vertex colors for a [MeshArgs]($frontend) or [PolylineArgs]($frontend).\r\n * The [[colors]] array holds the set of unique colors. The [[indices]] array describes the color of each vertex as an index into [[colors]].\r\n * @note A `NonUniformColor` table cannot contain a mix of opaque and translucent colors. If any color in [[colors]] has a transparency greater\r\n * than zero, all of them must have a transparency greater than zero.\r\n * @public\r\n */\r\nexport class NonUniformColor {\r\n  /** An array of 32-bit [[ColorDef]] values in `tbgr` format, indexed by [[indices]]. */\r\n  public readonly colors: Uint32Array;\r\n  /** For each vertex, an index into [[colors]] indicating the color of that vertex. */\r\n  public readonly indices: Uint16Array;\r\n  /** If `true`, indicates none of the [[colors]] have a transparency greater than zero; otherwise, all of\r\n   * the colors have a transparency greater than zero.\r\n   */\r\n  public readonly isOpaque: boolean;\r\n\r\n  /** Constructor.\r\n   * @param colors See [[colors]].\r\n   * @param indices See [[indices]]\r\n   * @param hasAlpha `true` if all `colors` have a transparency greater than zero, or `false` if they all have a transparency of zero.\r\n   */\r\n  public constructor(colors: Uint32Array, indices: number[], hasAlpha: boolean) {\r\n    this.colors = new Uint32Array(colors.buffer);\r\n    this.indices = Uint16Array.from(indices);\r\n    this.isOpaque = !hasAlpha;\r\n  }\r\n}\r\n\r\n/** Describes the color(s) of the vertices of a [MeshArgs]($frontend) or [PolylineArgs]($frontend).\r\n * This may be a uniform color to be applied to every vertex, or a table specifying individual per-vertex colors.\r\n * @public\r\n */\r\nexport class ColorIndex {\r\n  private _color: ColorDef | NonUniformColor;\r\n\r\n  /** Whether the color(s) in this index have transparency. */\r\n  public get hasAlpha() { return !this._color.isOpaque; }\r\n  /** Whether this index specifies a single uniform color for the entire mesh or polyline. */\r\n  public get isUniform() { return this._color instanceof ColorDef; }\r\n  /** The number of colors in this index. */\r\n  public get numColors(): number { return this.isUniform ? 1 : this.nonUniform!.colors.length; }\r\n\r\n  /** Construct a default index specifying a uniform white color. */\r\n  public constructor() { this._color = ColorDef.white; }\r\n\r\n  /** Reset this index to specify a uniform white color. */\r\n  public reset() { this._color = ColorDef.white; }\r\n\r\n  /** Returns the single color to be applied to all vertices, if [[isUniform]] is `true`; or `undefined` otherwise. */\r\n  public get uniform(): ColorDef | undefined {\r\n    return this.isUniform ? this._color as ColorDef : undefined;\r\n  }\r\n\r\n  /** Set the specified color to be applied to all vertices. */\r\n  public initUniform(color: ColorDef | number) {\r\n    this._color = typeof color === \"number\" ? ColorDef.fromJSON(color) : color;\r\n  }\r\n\r\n  /** Returns the per-vertex colors, if [[isUniform]] is `false`; or `undefined` otherwise. */\r\n  public get nonUniform(): NonUniformColor | undefined {\r\n    return !this.isUniform ? this._color as NonUniformColor : undefined;\r\n  }\r\n\r\n  /** Set the per-vertex colors.\r\n   * @param colors See [[NonUniformColor.colors]].\r\n   * @param indices See [[NonUniformColor.indices]].\r\n   * @param hasAlpha `true` if all `colors` have a transparency greater than zero, or `false` if they all have a transparency of zero.\r\n   */\r\n  public initNonUniform(colors: Uint32Array, indices: number[], hasAlpha: boolean) {\r\n    this._color = new NonUniformColor(colors, indices, hasAlpha);\r\n  }\r\n}\r\n\r\n/** Describes the type of a [[FeatureIndex]].\r\n * @public\r\n */\r\nexport enum FeatureIndexType {\r\n  /** Indicates that the index contains no features. */\r\n  Empty,\r\n  /** Indicates that the index contains exactly one feature. */\r\n  Uniform,\r\n  /** Indicates that the index contains more than one feature. */\r\n  NonUniform,\r\n}\r\n\r\n/** Describes the set of [[Feature]]s associated with a [MeshArgs]($frontend) or [PolylineArgs]($frontend).\r\n * The mesh or polyline may have zero or one features; or, individual vertices may be associated with different features.\r\n * The features are expressed as unsigned 32-bit integer Ids of [[Feature]]s within a [[FeatureTable]].\r\n * @public\r\n */\r\nexport class FeatureIndex {\r\n  /** Describes the quantity (zero, one, or more than one) of features in this index. */\r\n  public type: FeatureIndexType = FeatureIndexType.Empty;\r\n\r\n  /** If [[type]] is [[FeatureIndexType.Uniform]], the Id of the single feature. */\r\n  public featureID: number = 0;\r\n  /** If [[type]] is [[FeatureIndexType.NonUniform]], the per-vertex feature Ids, indexed by the mesh or polyline's vertex indices. */\r\n  public featureIDs?: Uint32Array;\r\n\r\n  /** True if [[type]] is [[FeatureIndexType.Uniform]]. */\r\n  public get isUniform(): boolean { return FeatureIndexType.Uniform === this.type; }\r\n\r\n  /** True if [[type]] is [[FeatureIndexType.Empty]]. */\r\n  public get isEmpty(): boolean { return FeatureIndexType.Empty === this.type; }\r\n\r\n  /** Reset to an empty index. */\r\n  public reset(): void {\r\n    this.type = FeatureIndexType.Empty;\r\n    this.featureID = 0;\r\n    this.featureIDs = undefined;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"FeatureIndex.js","sourceRoot":"","sources":["../../src/FeatureIndex.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,OAAO,eAAe;IAC1B,uFAAuF;IACvE,MAAM,CAAc;IACpC,qFAAqF;IACrE,OAAO,CAAc;IACrC;;OAEG;IACa,QAAQ,CAAU;IAElC;;;;OAIG;IACH,YAAmB,MAAmB,EAAE,OAAiB,EAAE,QAAiB;QAC1E,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,GAAG,CAAC,QAAQ,CAAC;IAC5B,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,UAAU;IACb,MAAM,CAA6B;IAE3C,4DAA4D;IAC5D,IAAW,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvD,2FAA2F;IAC3F,IAAW,SAAS,KAAK,OAAO,IAAI,CAAC,MAAM,YAAY,QAAQ,CAAC,CAAC,CAAC;IAClE,0CAA0C;IAC1C,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAE9F,kEAAkE;IAClE,gBAAuB,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAEtD,yDAAyD;IAClD,KAAK,KAAK,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAEhD,oHAAoH;IACpH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9D,CAAC;IAED,6DAA6D;IACtD,WAAW,CAAC,KAAwB;QACzC,IAAI,CAAC,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC7E,CAAC;IAED,4FAA4F;IAC5F,IAAW,UAAU;QACnB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAyB,CAAC,CAAC,CAAC,SAAS,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,MAAmB,EAAE,OAAiB,EAAE,QAAiB;QAC7E,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,qDAAqD;IACrD,yDAAK,CAAA;IACL,6DAA6D;IAC7D,6DAAO,CAAA;IACP,+DAA+D;IAC/D,mEAAU,CAAA;AACZ,CAAC,EAPW,gBAAgB,KAAhB,gBAAgB,QAO3B;AAED;;;;GAIG;AACH,MAAM,OAAO,YAAY;IACvB,sFAAsF;IAC/E,IAAI,GAAqB,gBAAgB,CAAC,KAAK,CAAC;IAEvD,iFAAiF;IAC1E,SAAS,GAAW,CAAC,CAAC;IAC7B,oIAAoI;IAC7H,UAAU,CAAe;IAEhC,wDAAwD;IACxD,IAAW,SAAS,KAAc,OAAO,gBAAgB,CAAC,OAAO,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAElF,sDAAsD;IACtD,IAAW,OAAO,KAAc,OAAO,gBAAgB,CAAC,KAAK,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAE9E,+BAA+B;IACxB,KAAK;QACV,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;CACF","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 Rendering\n */\n\nimport { ColorDef } from \"./ColorDef\";\n\n/** As part of a [[ColorIndex]], describes per-vertex colors for a [MeshArgs]($frontend) or [PolylineArgs]($frontend).\n * The [[colors]] array holds the set of unique colors. The [[indices]] array describes the color of each vertex as an index into [[colors]].\n * @note A `NonUniformColor` table cannot contain a mix of opaque and translucent colors. If any color in [[colors]] has a transparency greater\n * than zero, all of them must have a transparency greater than zero.\n * @public\n */\nexport class NonUniformColor {\n  /** An array of 32-bit [[ColorDef]] values in `tbgr` format, indexed by [[indices]]. */\n  public readonly colors: Uint32Array;\n  /** For each vertex, an index into [[colors]] indicating the color of that vertex. */\n  public readonly indices: Uint16Array;\n  /** If `true`, indicates none of the [[colors]] have a transparency greater than zero; otherwise, all of\n   * the colors have a transparency greater than zero.\n   */\n  public readonly isOpaque: boolean;\n\n  /** Constructor.\n   * @param colors See [[colors]].\n   * @param indices See [[indices]]\n   * @param hasAlpha `true` if all `colors` have a transparency greater than zero, or `false` if they all have a transparency of zero.\n   */\n  public constructor(colors: Uint32Array, indices: number[], hasAlpha: boolean) {\n    this.colors = new Uint32Array(colors.buffer);\n    this.indices = Uint16Array.from(indices);\n    this.isOpaque = !hasAlpha;\n  }\n}\n\n/** Describes the color(s) of the vertices of a [MeshArgs]($frontend) or [PolylineArgs]($frontend).\n * This may be a uniform color to be applied to every vertex, or a table specifying individual per-vertex colors.\n * @public\n */\nexport class ColorIndex {\n  private _color: ColorDef | NonUniformColor;\n\n  /** Whether the color(s) in this index have transparency. */\n  public get hasAlpha() { return !this._color.isOpaque; }\n  /** Whether this index specifies a single uniform color for the entire mesh or polyline. */\n  public get isUniform() { return this._color instanceof ColorDef; }\n  /** The number of colors in this index. */\n  public get numColors(): number { return this.isUniform ? 1 : this.nonUniform!.colors.length; }\n\n  /** Construct a default index specifying a uniform white color. */\n  public constructor() { this._color = ColorDef.white; }\n\n  /** Reset this index to specify a uniform white color. */\n  public reset() { this._color = ColorDef.white; }\n\n  /** Returns the single color to be applied to all vertices, if [[isUniform]] is `true`; or `undefined` otherwise. */\n  public get uniform(): ColorDef | undefined {\n    return this.isUniform ? this._color as ColorDef : undefined;\n  }\n\n  /** Set the specified color to be applied to all vertices. */\n  public initUniform(color: ColorDef | number) {\n    this._color = typeof color === \"number\" ? ColorDef.fromJSON(color) : color;\n  }\n\n  /** Returns the per-vertex colors, if [[isUniform]] is `false`; or `undefined` otherwise. */\n  public get nonUniform(): NonUniformColor | undefined {\n    return !this.isUniform ? this._color as NonUniformColor : undefined;\n  }\n\n  /** Set the per-vertex colors.\n   * @param colors See [[NonUniformColor.colors]].\n   * @param indices See [[NonUniformColor.indices]].\n   * @param hasAlpha `true` if all `colors` have a transparency greater than zero, or `false` if they all have a transparency of zero.\n   */\n  public initNonUniform(colors: Uint32Array, indices: number[], hasAlpha: boolean) {\n    this._color = new NonUniformColor(colors, indices, hasAlpha);\n  }\n}\n\n/** Describes the type of a [[FeatureIndex]].\n * @public\n */\nexport enum FeatureIndexType {\n  /** Indicates that the index contains no features. */\n  Empty,\n  /** Indicates that the index contains exactly one feature. */\n  Uniform,\n  /** Indicates that the index contains more than one feature. */\n  NonUniform,\n}\n\n/** Describes the set of [[Feature]]s associated with a [MeshArgs]($frontend) or [PolylineArgs]($frontend).\n * The mesh or polyline may have zero or one features; or, individual vertices may be associated with different features.\n * The features are expressed as unsigned 32-bit integer Ids of [[Feature]]s within a [[FeatureTable]].\n * @public\n */\nexport class FeatureIndex {\n  /** Describes the quantity (zero, one, or more than one) of features in this index. */\n  public type: FeatureIndexType = FeatureIndexType.Empty;\n\n  /** If [[type]] is [[FeatureIndexType.Uniform]], the Id of the single feature. */\n  public featureID: number = 0;\n  /** If [[type]] is [[FeatureIndexType.NonUniform]], the per-vertex feature Ids, indexed by the mesh or polyline's vertex indices. */\n  public featureIDs?: Uint32Array;\n\n  /** True if [[type]] is [[FeatureIndexType.Uniform]]. */\n  public get isUniform(): boolean { return FeatureIndexType.Uniform === this.type; }\n\n  /** True if [[type]] is [[FeatureIndexType.Empty]]. */\n  public get isEmpty(): boolean { return FeatureIndexType.Empty === this.type; }\n\n  /** Reset to an empty index. */\n  public reset(): void {\n    this.type = FeatureIndexType.Empty;\n    this.featureID = 0;\n    this.featureIDs = undefined;\n  }\n}\n"]}

package/lib/esm/FeatureSymbology.d.ts

@@ -189,9 +189,7 @@ export interface OverrideFeatureAppearanceOptions {
 export interface OverrideModelAppearanceOptions extends OverrideFeatureAppearanceOptions {
     /** The Id of the model whose appearance is to be overridden. */
     modelId: Id64String;
-    /** @internal */
     elementId?: never;
-    /** @internal */
     subCategoryId?: never;
 }
 /** Options for using [[FeatureOverrides.override]] to override the appearance of a [GeometricElement]($backend).
@@ -200,9 +198,7 @@ export interface OverrideModelAppearanceOptions extends OverrideFeatureAppearanc
 export interface OverrideElementAppearanceOptions extends OverrideFeatureAppearanceOptions {
     /** The Id of the element whose appearance is to be overridden. */
     elementId: Id64String;
-    /** @internal */
     modelId?: never;
-    /** @internal */
     subCategoryId?: never;
 }
 /** Options for using [[FeatureOverrides.override]] to override the appearance of a [SubCategory]($backend).
@@ -211,9 +207,7 @@ export interface OverrideElementAppearanceOptions extends OverrideFeatureAppeara
 export interface OverrideSubCategoryAppearanceOptions extends OverrideFeatureAppearanceOptions {
     /** The Id of the subcategory whose appearance is to be overridden. */
     subCategoryId: Id64String;
-    /** @internal */
     modelId?: never;
-    /** @internal */
     elementId?: never;
 }
 /** Arguments supplied to [[FeatureOverrides.override]].
@@ -265,11 +259,11 @@ export type IgnoreAnimationOverrides = (args: IgnoreAnimationOverridesArgs) => b
  */
 export declare class FeatureOverrides implements FeatureAppearanceSource {
     /** @internal */
-    protected readonly _ignoreAnimationOverrides: IgnoreAnimationOverrides[];
+    private readonly _ignoreAnimationOverrides;
     /** Ids of elements that should never be drawn. This takes precedence over [[alwaysDrawn]]. @internal */
-    protected readonly _neverDrawn: Id64.Uint32Set;
+    private readonly _neverDrawn;
     /** Ids of elements that should always be drawn. [[neverDrawn]] takes precedence over this set. @internal */
-    protected readonly _alwaysDrawn: Id64.Uint32Set;
+    private readonly _alwaysDrawn;
     /** If true, no elements *except* those defined in the "always drawn" set will be drawn.
      * @see [[setAlwaysDrawn]]
      */
@@ -279,37 +273,33 @@ export declare class FeatureOverrides implements FeatureAppearanceSource {
      */
     alwaysDrawnIgnoresSubCategory: boolean;
     /** If true, all subcategories are considered visible. This is used for drawing sheets via section callouts in the absence of an actual sheet view.
-     * @internal
      */
     ignoreSubCategory: boolean;
     /** Overrides applied to any feature not explicitly overridden. @internal */
-    protected _defaultOverrides: FeatureAppearance;
-    /** Whether construction geometry should be drawn. @internal */
+    private _defaultOverrides;
+    /** Whether construction geometry should be drawn. */
     protected _constructions: boolean;
-    /** Whether dimensions should be drawn. @internal */
+    /** Whether dimensions should be drawn. */
     protected _dimensions: boolean;
-    /** Whether area patterns should be drawn. @internal */
+    /** Whether area patterns should be drawn. */
     protected _patterns: boolean;
-    /** Whether line weights should be applied. If false, all lines are rendered 1-pixel wide. @internal */
+    /** Whether line weights should be applied. If false, all lines are rendered 1-pixel wide. */
     protected _lineWeights: boolean;
     /** Overrides applied to all elements belonging to each model. @internal */
-    protected readonly _modelOverrides: Id64.Uint32Map<FeatureAppearance>;
-    /** Overrides applied to specific elements. @internal */
+    private readonly _modelOverrides;
+    /** Overrides applied to specific elements. */
     protected readonly _elementOverrides: Id64.Uint32Map<FeatureAppearance>;
-    /** Overrides applied to geometry belonging to each subcategory. @internal */
+    /** Overrides applied to geometry belonging to each subcategory. */
     protected readonly _subCategoryOverrides: Id64.Uint32Map<FeatureAppearance>;
-    /** The set of displayed subcategories. Geometry belonging to subcategories not included in this set will not be drawn. @internal */
+    /** The set of displayed subcategories. Geometry belonging to subcategories not included in this set will not be drawn. */
     protected readonly _visibleSubCategories: Id64.Uint32Set;
-    /** Display priorities assigned to subcategories, possibly overridden by display style. Only applicable for plan projection models. @internal */
+    /** Display priorities assigned to subcategories, possibly overridden by display style. Only applicable for plan projection models. */
     protected readonly _subCategoryPriorities: Id64.Uint32Map<number>;
     /** Per-model, a set of subcategories whose visibility should be inverted for elements within that model.
      * Populated by Viewport.
-     * @internal
      */
     protected readonly _modelSubCategoryOverrides: Id64.Uint32Map<Id64.Uint32Set>;
-    /** Ids of animation nodes that should never be drawn.
-     * @internal
-     */
+    /** Ids of animation nodes that should never be drawn. */
     readonly neverDrawnAnimationNodes: Set<number>;
     /** Mapping of animation node Ids to overrides applied to the corresponding animation nodes.
      * @internal
@@ -337,21 +327,16 @@ export declare class FeatureOverrides implements FeatureAppearanceSource {
      * @note If an element is present in both `alwaysDrawn` and [[neverDrawn]], it will not be displayed - `neverDrawn` takes precedence.
      */
     get alwaysDrawn(): Id64.Uint32Set;
-    /** @internal */
-    protected isNeverDrawn(elemIdLo: number, elemIdHi: number, animationNodeId: number): boolean;
-    /** @internal */
-    protected isAlwaysDrawn(idLo: number, idHi: number): boolean;
-    /** Returns true if the [SubCategory]($backend) specified by Id is in the set of visible subcategories. @internal */
+    private isNeverDrawn;
+    private isAlwaysDrawn;
+    /** Returns true if the [SubCategory]($backend) specified by Id is in the set of visible subcategories. */
     isSubCategoryVisible(idLo: number, idHi: number): boolean;
-    /** @internal */
+    /** Returns true if the [SubCategory]($backend) specified by Id is in the set of visible subcategories in the context of the specified model. */
     isSubCategoryVisibleInModel(subcatLo: number, subcatHi: number, modelLo: number, modelHi: number): boolean;
-    /** @internal */
-    protected getModelOverrides(idLo: number, idHi: number): FeatureAppearance | undefined;
+    private getModelOverrides;
     private getElementAnimationOverrides;
-    /** @internal */
-    protected getElementOverrides(idLo: number, idHi: number, animationNodeId: number): FeatureAppearance | undefined;
-    /** @internal */
-    protected getSubCategoryOverrides(idLo: number, idHi: number): FeatureAppearance | undefined;
+    private getElementOverrides;
+    private getSubCategoryOverrides;
     /** Add a [SubCategory]($backend) to the set of visible subcategories. */
     setVisibleSubCategory(id: Id64String): void;
     /** Specify the Id of an element that should never be drawn. */
@@ -372,43 +357,14 @@ export declare class FeatureOverrides implements FeatureAppearanceSource {
      * @see [[getFeatureAppearance]] for an equivalent function that accepts [Id64String]($core-bentley)s instead of integer pairs.
      */
     getAppearance(elemLo: number, elemHi: number, subcatLo: number, subcatHi: number, geomClass: GeometryClass, modelLo: number, modelHi: number, type: BatchType, animationNodeId: number): FeatureAppearance | undefined;
-    /** Classifiers behave totally differently...in particular they are never invisible unless fully-transparent.
-     * @internal
-     */
-    protected getClassifierAppearance(elemLo: number, elemHi: number, subcatLo: number, subcatHi: number, modelLo: number, modelHi: number, animationNodeId: number): FeatureAppearance | undefined;
+    /** Classifiers behave totally differently...in particular they are never invisible unless fully-transparent. */
+    private getClassifierAppearance;
     /** Return whether geometry of the specified class should be drawn.
      * @see [[ViewFlags.constructions]], [[ViewFlags.dimensions]], and [[ViewFlags.patterns]].
      */
     isClassVisible(geomClass: GeometryClass): boolean;
     /** Specify overrides for all elements belonging to a specified [GeometricModel]($backend), or all geometry belonging to a specified [GeometricElement]($backend) or [SubCategory]($backend). */
     override(args: OverrideFeatureAppearanceArgs): void;
-    /** Specify overrides for all elements within the specified model.
-     * @param id The Id of the model.
-     * @param app The symbology overrides.
-     * @param replaceExisting Specifies whether to replace a pre-existing override for the same model.
-     * @note These overrides take priority over all other overrides.
-     * @note If [[defaultOverrides]] are defined, they will not apply to any element within this model, even if the supplied appearance overrides nothing.
-     * @deprecated in 3.x. Use [[FeatureOverrides.override]].
-     */
-    overrideModel(id: Id64String, app: FeatureAppearance, replaceExisting?: boolean): void;
-    /** Specify overrides for all geometry belonging to the specified [SubCategory]($backend).
-     * @param id The Id of the subcategory.
-     * @param app The symbology overrides.
-     * @param replaceExisting Specifies whether to replace a pre-existing override for the same subcategory.
-     * @note These overrides have lower priority than element and model overrides.
-     * @note If [[defaultOverrides]] are defined, they will not apply to any geometry within this subcategory, even if the supplied appearance overrides nothing.
-     * @deprecated in 3.x. Use [[FeatureOverrides.override]].
-     */
-    overrideSubCategory(id: Id64String, app: FeatureAppearance, replaceExisting?: boolean): void;
-    /** Specify overrides for all geometry originating from the specified element.
-     * @param id The Id of the element.
-     * @param app The symbology overrides.
-     * @param replaceExisting Specifies whether to replace a pre-existing override for the same element.
-     * @note These overrides take precedence over subcategory overrides, but not over model overrides.
-     * @note If [[defaultOverrides]] are defined, they will not apply to this element, even if the supplied appearance overrides nothing.
-     * @deprecated in 3.x. Use [[FeatureOverrides.override]].
-     */
-    overrideElement(id: Id64String, app: FeatureAppearance, replaceExisting?: boolean): void;
     /** Specify overrides for all geometry originating from the specified animation node.
      * @param id The Id of the animation node.
      * @param app The symbology overrides.
@@ -420,13 +376,9 @@ export declare class FeatureOverrides implements FeatureAppearanceSource {
      * @param replaceExisting Specifies whether to replace the current default overrides if they are already defined.
      */
     setDefaultOverrides(appearance: FeatureAppearance, replaceExisting?: boolean): void;
-    /** Get the display priority of a subcategory. This is only relevant when using [[PlanProjectionSettings]].
-     * @internal
-     */
+    /** Get the display priority of a subcategory. This is only relevant when using [[PlanProjectionSettings]]. */
     getSubCategoryPriority(idLo: number, idHi: number): number;
-    /** Adds all fully transparent elements to the _neverDrawn set.  This is used for BatchedModels planar masks.
-     * @internal
-     */
+    /** Adds all fully transparent elements to the _neverDrawn set.  This is used for BatchedModels planar masks. */
     addInvisibleElementOverridesToNeverDrawn(): void;
     /** Construct a new Overrides that overrides nothing.
      * @see [FeatureSymbology.Overrides]($frontend) to construct overrides based on a [ViewState]($frontend) or [Viewport]($frontend).