@itwin/core-common 4.0.0-dev.52 → 4.0.0-dev.54

package/lib/cjs/EntityProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntityProps.js","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAuD;AACvD,wDAAwD;AACxD,iDAAgD;AA6DhD;;GAEG;AACH,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,GAAjB,yBAAiB,KAAjB,yBAAiB,QAY5B;AAyCD;;GAEG;AACH,MAAa,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;YACpC,QAAQ,IAAI,CAAC,aAAa,EAAE;gBAC1B,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,uBAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAE5D,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,uBAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;aAC7D;SACF;QACD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO,OAAO,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,6BAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,mBAAI,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;AAvFD,4CAuFC;AAgBD;;GAEG;AACH,MAAa,cAAc;IAazB,YAAmB,OAA4B;QAC7C,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,EAAE,mCAAmC;YAC9E,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;SAChF;IACH,CAAC;CACF;AA1BD,wCA0BC","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(Point2d.fromJSON, jsonObj);\r\n\r\n        case PrimitiveTypeCode.Point3d:\r\n          return this.createValueOrArray(Point3d.fromJSON, 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  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 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.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,sDAAuD;AACvD,wDAAwD;AACxD,iDAAgD;AA6DhD;;GAEG;AACH,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,GAAjB,yBAAiB,KAAjB,yBAAiB,QAY5B;AAyCD;;GAEG;AACH,MAAa,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;YACpC,QAAQ,IAAI,CAAC,aAAa,EAAE;gBAC1B,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,uBAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAE5D,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,uBAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;aAC7D;SACF;QACD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO,OAAO,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,6BAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,mBAAI,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;AAvFD,4CAuFC;AAgBD;;GAEG;AACH,MAAa,cAAc;IAazB,YAAmB,OAA4B;QAC7C,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,EAAE,mCAAmC;YAC9E,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;SAChF;IACH,CAAC;CACF;AA1BD,wCA0BC","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 */\nexport type PropertyCallback = (name: string, meta: PropertyMetaData) => void;\n\n/** A custom attribute instance\n * @beta\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/** @beta */\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  customAttributes?: CustomAttribute[];\n}\n\n/** Metadata for a property.\n * @beta\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  public customAttributes?: CustomAttribute[];\n\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(Point2d.fromJSON, jsonObj);\n\n        case PrimitiveTypeCode.Point3d:\n          return this.createValueOrArray(Point3d.fromJSON, 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/** @beta */\nexport interface EntityMetaDataProps {\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  customAttributes?: CustomAttribute[];\n  /** An object whose properties correspond by name to the properties of this class. */\n  properties: { [propName: string]: PropertyMetaData };\n}\n\n/** Metadata for an Entity.\n * @beta\n */\nexport class EntityMetaData implements EntityMetaDataProps {\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  public readonly customAttributes?: CustomAttribute[];\n  /** An object whose properties correspond by name to the properties of this class. */\n  public readonly properties: { [propName: string]: PropertyMetaData };\n\n  public constructor(jsonObj: EntityMetaDataProps) {\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      this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);\n    }\n  }\n}\n"]}

package/lib/cjs/EntityReference.d.ts

@@ -1,52 +1,52 @@
-/** @packageDocumentation
- * @module Schema
- */
-import { Id64String } from "@itwin/core-bentley";
-/**
- * Types of concrete entities. Used for storing strings in JavaScript reference-equality containers which encode
- * low-level entity information.
- * @note the values of this enum are unstable, do not depend upon their values between versions of iTwin.js
- *       (e.g. do not serialize them and load them in another version of iTwin.js and expect them to work)
- * CodeSpecs are excepted since their JavaScript representation does not derive from [Entity]($backend)
- * @note the string value of each variant is required/guaranteed to be 1 character
- * @see EntityReference
- * @alpha
- */
-export declare enum ConcreteEntityTypes {
-    Model = "m",
-    Element = "e",
-    ElementAspect = "a",
-    Relationship = "r"
-}
-/**
- * Adds some utilities to the [[ConcreteEntityTypes]] enum
- * @alpha
- */
-export declare namespace ConcreteEntityTypes {
-    /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
-     * @internal
-     */
-    function toBisCoreRootClassFullName(type: ConcreteEntityTypes): string;
-}
-/**
- * This id format can be used for storing a unique key for an entity in containers like `Map`.
- * Elements and non-element entities have different id sequences, they can collide with each other, but not within themselves.
- * @note for utilities that require runtime backend classes, see [EntityReferences]($backend)
- * @alpha
- */
-export declare type EntityReference = `${ConcreteEntityTypes}${Id64String}`;
-/** 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
- * @alpha
- */
-export declare class EntityReferenceSet extends Set<EntityReference> {
-    addElement(id: Id64String): void;
-    addModel(id: Id64String): void;
-    addAspect(id: Id64String): void;
-    addRelationship(id: Id64String): void;
-}
-/** @internal entity reference type information of a relationship */
-export interface RelTypeInfo {
-    source: ConcreteEntityTypes;
-    target: ConcreteEntityTypes;
-}
+/** @packageDocumentation
+ * @module Schema
+ */
+import { Id64String } from "@itwin/core-bentley";
+/**
+ * Types of concrete entities. Used for storing strings in JavaScript reference-equality containers which encode
+ * low-level entity information.
+ * @note the values of this enum are unstable, do not depend upon their values between versions of iTwin.js
+ *       (e.g. do not serialize them and load them in another version of iTwin.js and expect them to work)
+ * CodeSpecs are excepted since their JavaScript representation does not derive from [Entity]($backend)
+ * @note the string value of each variant is required/guaranteed to be 1 character
+ * @see EntityReference
+ * @alpha
+ */
+export declare enum ConcreteEntityTypes {
+    Model = "m",
+    Element = "e",
+    ElementAspect = "a",
+    Relationship = "r"
+}
+/**
+ * Adds some utilities to the [[ConcreteEntityTypes]] enum
+ * @alpha
+ */
+export declare namespace ConcreteEntityTypes {
+    /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
+     * @internal
+     */
+    function toBisCoreRootClassFullName(type: ConcreteEntityTypes): string;
+}
+/**
+ * This id format can be used for storing a unique key for an entity in containers like `Map`.
+ * Elements and non-element entities have different id sequences, they can collide with each other, but not within themselves.
+ * @note for utilities that require runtime backend classes, see [EntityReferences]($backend)
+ * @alpha
+ */
+export type EntityReference = `${ConcreteEntityTypes}${Id64String}`;
+/** 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
+ * @alpha
+ */
+export declare class EntityReferenceSet extends Set<EntityReference> {
+    addElement(id: Id64String): void;
+    addModel(id: Id64String): void;
+    addAspect(id: Id64String): void;
+    addRelationship(id: Id64String): void;
+}
+/** @internal entity reference type information of a relationship */
+export interface RelTypeInfo {
+    source: ConcreteEntityTypes;
+    target: ConcreteEntityTypes;
+}
 //# sourceMappingURL=EntityReference.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"EntityReference.d.ts","sourceRoot":"","sources":["../../src/EntityReference.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD;;;;;;;;;GASG;AACH,oBAAY,mBAAmB;IAC7B,KAAK,MAAM;IACX,OAAO,MAAM;IACb,aAAa,MAAM;IACnB,YAAY,MAAM;CACnB;AAED;;;GAGG;AACH,yBAAiB,mBAAmB,CAAC;IAQnC;;OAEG;IACH,SAAgB,0BAA0B,CAAC,IAAI,EAAE,mBAAmB,GAAG,MAAM,CAE5E;CACF;AAED;;;;;GAKG;AACH,oBAAY,eAAe,GAAG,GAAG,mBAAmB,GAAG,UAAU,EAAE,CAAC;AAEpE;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,GAAG,CAAC,eAAe,CAAC;IACnD,UAAU,CAAC,EAAE,EAAE,UAAU;IACzB,QAAQ,CAAC,EAAE,EAAE,UAAU;IACvB,SAAS,CAAC,EAAE,EAAE,UAAU;IACxB,eAAe,CAAC,EAAE,EAAE,UAAU;CACtC;AAED,oEAAoE;AACpE,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,mBAAmB,CAAC;IAC5B,MAAM,EAAE,mBAAmB,CAAC;CAC7B"}
+{"version":3,"file":"EntityReference.d.ts","sourceRoot":"","sources":["../../src/EntityReference.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD;;;;;;;;;GASG;AACH,oBAAY,mBAAmB;IAC7B,KAAK,MAAM;IACX,OAAO,MAAM;IACb,aAAa,MAAM;IACnB,YAAY,MAAM;CACnB;AAED;;;GAGG;AACH,yBAAiB,mBAAmB,CAAC;IAQnC;;OAEG;IACH,SAAgB,0BAA0B,CAAC,IAAI,EAAE,mBAAmB,GAAG,MAAM,CAE5E;CACF;AAED;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,GAAG,mBAAmB,GAAG,UAAU,EAAE,CAAC;AAEpE;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,GAAG,CAAC,eAAe,CAAC;IACnD,UAAU,CAAC,EAAE,EAAE,UAAU;IACzB,QAAQ,CAAC,EAAE,EAAE,UAAU;IACvB,SAAS,CAAC,EAAE,EAAE,UAAU;IACxB,eAAe,CAAC,EAAE,EAAE,UAAU;CACtC;AAED,oEAAoE;AACpE,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,mBAAmB,CAAC;IAC5B,MAAM,EAAE,mBAAmB,CAAC;CAC7B"}

package/lib/cjs/EntityReference.js

@@ -1,57 +1,57 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Schema
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EntityReferenceSet = exports.ConcreteEntityTypes = void 0;
-/**
- * Types of concrete entities. Used for storing strings in JavaScript reference-equality containers which encode
- * low-level entity information.
- * @note the values of this enum are unstable, do not depend upon their values between versions of iTwin.js
- *       (e.g. do not serialize them and load them in another version of iTwin.js and expect them to work)
- * CodeSpecs are excepted since their JavaScript representation does not derive from [Entity]($backend)
- * @note the string value of each variant is required/guaranteed to be 1 character
- * @see EntityReference
- * @alpha
- */
-var ConcreteEntityTypes;
-(function (ConcreteEntityTypes) {
-    ConcreteEntityTypes["Model"] = "m";
-    ConcreteEntityTypes["Element"] = "e";
-    ConcreteEntityTypes["ElementAspect"] = "a";
-    ConcreteEntityTypes["Relationship"] = "r";
-})(ConcreteEntityTypes = exports.ConcreteEntityTypes || (exports.ConcreteEntityTypes = {}));
-/**
- * Adds some utilities to the [[ConcreteEntityTypes]] enum
- * @alpha
- */
-(function (ConcreteEntityTypes) {
-    const toBisCoreRootClassFullNameMap = {
-        [ConcreteEntityTypes.Model]: "BisCore:Model",
-        [ConcreteEntityTypes.Element]: "BisCore:Element",
-        [ConcreteEntityTypes.ElementAspect]: "BisCore:ElementAspect",
-        [ConcreteEntityTypes.Relationship]: "BisCore:Relationship",
-    };
-    /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
-     * @internal
-     */
-    function toBisCoreRootClassFullName(type) {
-        return toBisCoreRootClassFullNameMap[type];
-    }
-    ConcreteEntityTypes.toBisCoreRootClassFullName = toBisCoreRootClassFullName;
-})(ConcreteEntityTypes = exports.ConcreteEntityTypes || (exports.ConcreteEntityTypes = {}));
-/** 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
- * @alpha
- */
-class EntityReferenceSet extends Set {
-    addElement(id) { this.add(`e${id}`); }
-    addModel(id) { this.add(`m${id}`); }
-    addAspect(id) { this.add(`a${id}`); }
-    addRelationship(id) { this.add(`r${id}`); }
-}
-exports.EntityReferenceSet = EntityReferenceSet;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Schema
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityReferenceSet = exports.ConcreteEntityTypes = void 0;
+/**
+ * Types of concrete entities. Used for storing strings in JavaScript reference-equality containers which encode
+ * low-level entity information.
+ * @note the values of this enum are unstable, do not depend upon their values between versions of iTwin.js
+ *       (e.g. do not serialize them and load them in another version of iTwin.js and expect them to work)
+ * CodeSpecs are excepted since their JavaScript representation does not derive from [Entity]($backend)
+ * @note the string value of each variant is required/guaranteed to be 1 character
+ * @see EntityReference
+ * @alpha
+ */
+var ConcreteEntityTypes;
+(function (ConcreteEntityTypes) {
+    ConcreteEntityTypes["Model"] = "m";
+    ConcreteEntityTypes["Element"] = "e";
+    ConcreteEntityTypes["ElementAspect"] = "a";
+    ConcreteEntityTypes["Relationship"] = "r";
+})(ConcreteEntityTypes = exports.ConcreteEntityTypes || (exports.ConcreteEntityTypes = {}));
+/**
+ * Adds some utilities to the [[ConcreteEntityTypes]] enum
+ * @alpha
+ */
+(function (ConcreteEntityTypes) {
+    const toBisCoreRootClassFullNameMap = {
+        [ConcreteEntityTypes.Model]: "BisCore:Model",
+        [ConcreteEntityTypes.Element]: "BisCore:Element",
+        [ConcreteEntityTypes.ElementAspect]: "BisCore:ElementAspect",
+        [ConcreteEntityTypes.Relationship]: "BisCore:Relationship",
+    };
+    /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
+     * @internal
+     */
+    function toBisCoreRootClassFullName(type) {
+        return toBisCoreRootClassFullNameMap[type];
+    }
+    ConcreteEntityTypes.toBisCoreRootClassFullName = toBisCoreRootClassFullName;
+})(ConcreteEntityTypes = exports.ConcreteEntityTypes || (exports.ConcreteEntityTypes = {}));
+/** 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
+ * @alpha
+ */
+class EntityReferenceSet extends Set {
+    addElement(id) { this.add(`e${id}`); }
+    addModel(id) { this.add(`m${id}`); }
+    addAspect(id) { this.add(`a${id}`); }
+    addRelationship(id) { this.add(`r${id}`); }
+}
+exports.EntityReferenceSet = EntityReferenceSet;
 //# sourceMappingURL=EntityReference.js.map

package/lib/cjs/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,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,kCAAW,CAAA;IACX,oCAAa,CAAA;IACb,0CAAmB,CAAA;IACnB,yCAAkB,CAAA;AACpB,CAAC,EALW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,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,GAAnB,2BAAmB,KAAnB,2BAAmB,QAcnC;AAUD;;GAEG;AACH,MAAa,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;AALD,gDAKC","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,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,kCAAW,CAAA;IACX,oCAAa,CAAA;IACb,0CAAmB,CAAA;IACnB,yCAAkB,CAAA;AACpB,CAAC,EALW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,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,GAAnB,2BAAmB,KAAnB,2BAAmB,QAcnC;AAUD;;GAEG;AACH,MAAa,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;AALD,gDAKC","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/cjs/Environment.d.ts

@@ -1,62 +1,62 @@
-/** @packageDocumentation
- * @module DisplayStyles
- */
-import { NonFunctionPropertiesOf } from "@itwin/core-bentley";
-import { GroundPlane, GroundPlaneProps } from "./GroundPlane";
-import { SkyBox, SkyBoxProps } from "./SkyBox";
-/** JSON representation of an [[Environment]].
- * @see [[DisplayStyle3dSettingsProps.environment]].
- * @public
- * @extensions
- */
-export interface EnvironmentProps {
-    /** See [[Environment.ground]] and [[Environment.displayGround]]. */
-    ground?: GroundPlaneProps;
-    /** See [[Environment.sky]] and [[Environment.displaySky]]. */
-    sky?: SkyBoxProps;
-}
-/** A type containing all of the properties of [[Environment]] with none of the methods and with the `readonly` modifiers removed.
- * @see [[Environment.create]] and [[Environment.clone]].
- * @public
- */
-export declare type EnvironmentProperties = NonFunctionPropertiesOf<Environment>;
-/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the
- * outdoor environment.
- * @see [[DisplayStyle3dSettings.environment]].
- * @public
- */
-export declare class Environment {
-    /** If true, the sky box will be displayed.
-     * Default: false.
-     * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleSkyBox]] to change this.
-     */
-    readonly displaySky: boolean;
-    /** If true, the ground plane will be displayed.
-     * Default: false.
-     * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleGroundPlane]] to change this.
-     */
-    readonly displayGround: boolean;
-    /** Describes how the sky box should be drawn. */
-    readonly sky: SkyBox;
-    /** Describes how the ground plane should be drawn. */
-    readonly ground: GroundPlane;
-    protected constructor(props?: Partial<EnvironmentProperties>);
-    /** Default settings with neither ground plane nor sky box displayed. */
-    static readonly defaults: Environment;
-    /** Create a new Environment. Any properties not specified by `props` will be initialized to their default values. */
-    static create(props?: Partial<EnvironmentProperties>): Environment;
-    /** Create a copy of this environment, changing the `displayGround` and/or `displaySky` flags. */
-    withDisplay(display: {
-        sky?: boolean;
-        ground?: boolean;
-    }): Environment;
-    /** Convert to JSON representation. */
-    toJSON(): EnvironmentProps;
-    /** Create from JSON representation. */
-    static fromJSON(props?: EnvironmentProps): Environment;
-    /** Create a copy of this environment, identical except for any properties specified by `changedProps`.
-     * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.
-     */
-    clone(changedProps?: Partial<EnvironmentProperties>): Environment;
-}
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+import { NonFunctionPropertiesOf } from "@itwin/core-bentley";
+import { GroundPlane, GroundPlaneProps } from "./GroundPlane";
+import { SkyBox, SkyBoxProps } from "./SkyBox";
+/** JSON representation of an [[Environment]].
+ * @see [[DisplayStyle3dSettingsProps.environment]].
+ * @public
+ * @extensions
+ */
+export interface EnvironmentProps {
+    /** See [[Environment.ground]] and [[Environment.displayGround]]. */
+    ground?: GroundPlaneProps;
+    /** See [[Environment.sky]] and [[Environment.displaySky]]. */
+    sky?: SkyBoxProps;
+}
+/** A type containing all of the properties of [[Environment]] with none of the methods and with the `readonly` modifiers removed.
+ * @see [[Environment.create]] and [[Environment.clone]].
+ * @public
+ */
+export type EnvironmentProperties = NonFunctionPropertiesOf<Environment>;
+/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the
+ * outdoor environment.
+ * @see [[DisplayStyle3dSettings.environment]].
+ * @public
+ */
+export declare class Environment {
+    /** If true, the sky box will be displayed.
+     * Default: false.
+     * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleSkyBox]] to change this.
+     */
+    readonly displaySky: boolean;
+    /** If true, the ground plane will be displayed.
+     * Default: false.
+     * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleGroundPlane]] to change this.
+     */
+    readonly displayGround: boolean;
+    /** Describes how the sky box should be drawn. */
+    readonly sky: SkyBox;
+    /** Describes how the ground plane should be drawn. */
+    readonly ground: GroundPlane;
+    protected constructor(props?: Partial<EnvironmentProperties>);
+    /** Default settings with neither ground plane nor sky box displayed. */
+    static readonly defaults: Environment;
+    /** Create a new Environment. Any properties not specified by `props` will be initialized to their default values. */
+    static create(props?: Partial<EnvironmentProperties>): Environment;
+    /** Create a copy of this environment, changing the `displayGround` and/or `displaySky` flags. */
+    withDisplay(display: {
+        sky?: boolean;
+        ground?: boolean;
+    }): Environment;
+    /** Convert to JSON representation. */
+    toJSON(): EnvironmentProps;
+    /** Create from JSON representation. */
+    static fromJSON(props?: EnvironmentProps): Environment;
+    /** Create a copy of this environment, identical except for any properties specified by `changedProps`.
+     * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.
+     */
+    clone(changedProps?: Partial<EnvironmentProperties>): Environment;
+}
 //# sourceMappingURL=Environment.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Environment.d.ts","sourceRoot":"","sources":["../../src/Environment.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE/C;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,oEAAoE;IACpE,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,8DAA8D;IAC9D,GAAG,CAAC,EAAE,WAAW,CAAC;CACnB;AAED;;;GAGG;AACH,oBAAY,qBAAqB,GAAG,uBAAuB,CAAC,WAAW,CAAC,CAAC;AAEzE;;;;GAIG;AACH,qBAAa,WAAW;IACtB;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;;OAGG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,iDAAiD;IACjD,SAAgB,GAAG,EAAE,MAAM,CAAC;IAC5B,sDAAsD;IACtD,SAAgB,MAAM,EAAE,WAAW,CAAC;IAEpC,SAAS,aAAa,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC;IAO5D,wEAAwE;IACxE,gBAAuB,QAAQ,cAAqB;IAEpD,qHAAqH;WACvG,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,WAAW;IAIzE,iGAAiG;IAC1F,WAAW,CAAC,OAAO,EAAE;QAAE,GAAG,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,WAAW;IAa7E,sCAAsC;IAC/B,MAAM,IAAI,gBAAgB;IAOjC,uCAAuC;WACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,gBAAgB,GAAG,WAAW;IAY7D;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,WAAW;CAMzE"}
+{"version":3,"file":"Environment.d.ts","sourceRoot":"","sources":["../../src/Environment.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE/C;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,oEAAoE;IACpE,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,8DAA8D;IAC9D,GAAG,CAAC,EAAE,WAAW,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,CAAC,WAAW,CAAC,CAAC;AAEzE;;;;GAIG;AACH,qBAAa,WAAW;IACtB;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;;OAGG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,iDAAiD;IACjD,SAAgB,GAAG,EAAE,MAAM,CAAC;IAC5B,sDAAsD;IACtD,SAAgB,MAAM,EAAE,WAAW,CAAC;IAEpC,SAAS,aAAa,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC;IAO5D,wEAAwE;IACxE,gBAAuB,QAAQ,cAAqB;IAEpD,qHAAqH;WACvG,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,WAAW;IAIzE,iGAAiG;IAC1F,WAAW,CAAC,OAAO,EAAE;QAAE,GAAG,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,WAAW;IAa7E,sCAAsC;IAC/B,MAAM,IAAI,gBAAgB;IAOjC,uCAAuC;WACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,gBAAgB,GAAG,WAAW;IAY7D;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,WAAW;CAMzE"}

package/lib/cjs/Environment.js

@@ -1,71 +1,71 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module DisplayStyles
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Environment = void 0;
-const GroundPlane_1 = require("./GroundPlane");
-const SkyBox_1 = require("./SkyBox");
-/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the
- * outdoor environment.
- * @see [[DisplayStyle3dSettings.environment]].
- * @public
- */
-class Environment {
-    constructor(props) {
-        this.displaySky = props?.displaySky ?? false;
-        this.displayGround = props?.displayGround ?? false;
-        this.sky = props?.sky ?? SkyBox_1.SkyBox.defaults;
-        this.ground = props?.ground ?? GroundPlane_1.GroundPlane.defaults;
-    }
-    /** 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;
-    }
-    /** Create a copy of this environment, changing the `displayGround` and/or `displaySky` flags. */
-    withDisplay(display) {
-        const displaySky = display.sky ?? this.displaySky;
-        const displayGround = display.ground ?? this.displayGround;
-        if (displaySky === this.displaySky && displayGround === this.displayGround)
-            return this;
-        return Environment.create({
-            ...this,
-            displaySky: displaySky ?? this.displaySky,
-            displayGround: displayGround ?? this.displayGround,
-        });
-    }
-    /** Convert to JSON representation. */
-    toJSON() {
-        return {
-            sky: this.sky.toJSON(this.displaySky),
-            ground: this.ground.toJSON(this.displayGround),
-        };
-    }
-    /** Create from JSON representation. */
-    static fromJSON(props) {
-        if (!props)
-            return this.defaults;
-        return new this({
-            displaySky: props?.sky?.display,
-            displayGround: props?.ground?.display,
-            sky: props?.sky ? SkyBox_1.SkyBox.fromJSON(props.sky) : undefined,
-            ground: props?.ground ? GroundPlane_1.GroundPlane.fromJSON(props.ground) : undefined,
-        });
-    }
-    /** Create a copy of this environment, identical except for any properties specified by `changedProps`.
-     * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.
-     */
-    clone(changedProps) {
-        if (!changedProps)
-            return this;
-        return Environment.create({ ...this, ...changedProps });
-    }
-}
-exports.Environment = Environment;
-/** Default settings with neither ground plane nor sky box displayed. */
-Environment.defaults = new Environment();
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Environment = void 0;
+const GroundPlane_1 = require("./GroundPlane");
+const SkyBox_1 = require("./SkyBox");
+/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the
+ * outdoor environment.
+ * @see [[DisplayStyle3dSettings.environment]].
+ * @public
+ */
+class Environment {
+    constructor(props) {
+        this.displaySky = props?.displaySky ?? false;
+        this.displayGround = props?.displayGround ?? false;
+        this.sky = props?.sky ?? SkyBox_1.SkyBox.defaults;
+        this.ground = props?.ground ?? GroundPlane_1.GroundPlane.defaults;
+    }
+    /** 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;
+    }
+    /** Create a copy of this environment, changing the `displayGround` and/or `displaySky` flags. */
+    withDisplay(display) {
+        const displaySky = display.sky ?? this.displaySky;
+        const displayGround = display.ground ?? this.displayGround;
+        if (displaySky === this.displaySky && displayGround === this.displayGround)
+            return this;
+        return Environment.create({
+            ...this,
+            displaySky: displaySky ?? this.displaySky,
+            displayGround: displayGround ?? this.displayGround,
+        });
+    }
+    /** Convert to JSON representation. */
+    toJSON() {
+        return {
+            sky: this.sky.toJSON(this.displaySky),
+            ground: this.ground.toJSON(this.displayGround),
+        };
+    }
+    /** Create from JSON representation. */
+    static fromJSON(props) {
+        if (!props)
+            return this.defaults;
+        return new this({
+            displaySky: props?.sky?.display,
+            displayGround: props?.ground?.display,
+            sky: props?.sky ? SkyBox_1.SkyBox.fromJSON(props.sky) : undefined,
+            ground: props?.ground ? GroundPlane_1.GroundPlane.fromJSON(props.ground) : undefined,
+        });
+    }
+    /** Create a copy of this environment, identical except for any properties specified by `changedProps`.
+     * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.
+     */
+    clone(changedProps) {
+        if (!changedProps)
+            return this;
+        return Environment.create({ ...this, ...changedProps });
+    }
+}
+/** Default settings with neither ground plane nor sky box displayed. */
+Environment.defaults = new Environment();
+exports.Environment = Environment;
 //# sourceMappingURL=Environment.js.map

package/lib/cjs/Environment.js.map

@@ -1 +1 @@
-{"version":3,"file":"Environment.js","sourceRoot":"","sources":["../../src/Environment.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,+CAA8D;AAC9D,qCAA+C;AAoB/C;;;;GAIG;AACH,MAAa,WAAW;IAgBtB,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,GAAG,GAAG,KAAK,EAAE,GAAG,IAAI,eAAM,CAAC,QAAQ,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,KAAK,EAAE,MAAM,IAAI,yBAAW,CAAC,QAAQ,CAAC;IACtD,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,iGAAiG;IAC1F,WAAW,CAAC,OAA4C;QAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC;QAClD,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,aAAa,CAAC;QAC3D,IAAI,UAAU,KAAK,IAAI,CAAC,UAAU,IAAI,aAAa,KAAK,IAAI,CAAC,aAAa;YACxE,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;SACnD,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;SAC/C,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,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,eAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;YACxD,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,yBAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;SACvE,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;;AA1EH,kCA2EC;AApDC,wEAAwE;AACjD,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 { 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}\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  /** 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\r\n  protected constructor(props?: Partial<EnvironmentProperties>) {\r\n    this.displaySky = props?.displaySky ?? false;\r\n    this.displayGround = props?.displayGround ?? false;\r\n    this.sky = props?.sky ?? SkyBox.defaults;\r\n    this.ground = props?.ground ?? GroundPlane.defaults;\r\n  }\r\n\r\n  /** Default settings with neither ground plane nor sky box 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` and/or `displaySky` flags. */\r\n  public withDisplay(display: { sky?: boolean, ground?: boolean }): Environment {\r\n    const displaySky = display.sky ?? this.displaySky;\r\n    const displayGround = display.ground ?? this.displayGround;\r\n    if (displaySky === this.displaySky && displayGround === this.displayGround)\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    });\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    };\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      sky: props?.sky ? SkyBox.fromJSON(props.sky) : undefined,\r\n      ground: props?.ground ? GroundPlane.fromJSON(props.ground) : 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,+CAA8D;AAC9D,qCAA+C;AAoB/C;;;;GAIG;AACH,MAAa,WAAW;IAgBtB,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,GAAG,GAAG,KAAK,EAAE,GAAG,IAAI,eAAM,CAAC,QAAQ,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,KAAK,EAAE,MAAM,IAAI,yBAAW,CAAC,QAAQ,CAAC;IACtD,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,iGAAiG;IAC1F,WAAW,CAAC,OAA4C;QAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC;QAClD,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,aAAa,CAAC;QAC3D,IAAI,UAAU,KAAK,IAAI,CAAC,UAAU,IAAI,aAAa,KAAK,IAAI,CAAC,aAAa;YACxE,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;SACnD,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;SAC/C,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,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,eAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;YACxD,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,yBAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;SACvE,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;;AAnDD,wEAAwE;AACjD,oBAAQ,GAAG,IAAI,WAAW,EAAE,CAAC;AAxBzC,kCAAW","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 { 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}\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  /** 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\n  protected constructor(props?: Partial<EnvironmentProperties>) {\n    this.displaySky = props?.displaySky ?? false;\n    this.displayGround = props?.displayGround ?? false;\n    this.sky = props?.sky ?? SkyBox.defaults;\n    this.ground = props?.ground ?? GroundPlane.defaults;\n  }\n\n  /** Default settings with neither ground plane nor sky box 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` and/or `displaySky` flags. */\n  public withDisplay(display: { sky?: boolean, ground?: boolean }): Environment {\n    const displaySky = display.sky ?? this.displaySky;\n    const displayGround = display.ground ?? this.displayGround;\n    if (displaySky === this.displaySky && displayGround === this.displayGround)\n      return this;\n\n    return Environment.create({\n      ...this,\n      displaySky: displaySky ?? this.displaySky,\n      displayGround: displayGround ?? this.displayGround,\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    };\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      sky: props?.sky ? SkyBox.fromJSON(props.sky) : undefined,\n      ground: props?.ground ? GroundPlane.fromJSON(props.ground) : 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"]}