@itwin/core-common 3.5.0-dev.5 → 3.5.0-dev.52

package/lib/esm/EntityReference.d.ts

@@ -0,0 +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;
+}
+//# sourceMappingURL=EntityReference.d.ts.map

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

@@ -0,0 +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"}

package/lib/esm/EntityReference.js

@@ -0,0 +1,53 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/**
+ * 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 var ConcreteEntityTypes;
+(function (ConcreteEntityTypes) {
+    ConcreteEntityTypes["Model"] = "m";
+    ConcreteEntityTypes["Element"] = "e";
+    ConcreteEntityTypes["ElementAspect"] = "a";
+    ConcreteEntityTypes["Relationship"] = "r";
+})(ConcreteEntityTypes || (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 || (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
+ */
+export 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}`); }
+}
+//# sourceMappingURL=EntityReference.js.map

package/lib/esm/EntityReference.js.map

@@ -0,0 +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"]}

package/lib/esm/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 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;
+}
 //# sourceMappingURL=Environment.d.ts.map

package/lib/esm/Environment.js

@@ -1,70 +1,70 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-import { GroundPlane } from "./GroundPlane";
-import { SkyBox } from "./SkyBox";
-/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the
- * outdoor environment.
- * @see [[DisplayStyle3dSettings.environment]].
- * @public
- */
-export class Environment {
-    constructor(props) {
-        var _a, _b, _c, _d;
-        this.displaySky = (_a = props === null || props === void 0 ? void 0 : props.displaySky) !== null && _a !== void 0 ? _a : false;
-        this.displayGround = (_b = props === null || props === void 0 ? void 0 : props.displayGround) !== null && _b !== void 0 ? _b : false;
-        this.sky = (_c = props === null || props === void 0 ? void 0 : props.sky) !== null && _c !== void 0 ? _c : SkyBox.defaults;
-        this.ground = (_d = props === null || props === void 0 ? void 0 : props.ground) !== null && _d !== void 0 ? _d : 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) {
-        var _a, _b;
-        const displaySky = (_a = display.sky) !== null && _a !== void 0 ? _a : this.displaySky;
-        const displayGround = (_b = display.ground) !== null && _b !== void 0 ? _b : this.displayGround;
-        if (displaySky === this.displaySky && displayGround === this.displayGround)
-            return this;
-        return Environment.create({
-            ...this,
-            displaySky: displaySky !== null && displaySky !== void 0 ? displaySky : this.displaySky,
-            displayGround: displayGround !== null && displayGround !== void 0 ? 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) {
-        var _a, _b;
-        if (!props)
-            return this.defaults;
-        return new this({
-            displaySky: (_a = props === null || props === void 0 ? void 0 : props.sky) === null || _a === void 0 ? void 0 : _a.display,
-            displayGround: (_b = props === null || props === void 0 ? void 0 : props.ground) === null || _b === void 0 ? void 0 : _b.display,
-            sky: (props === null || props === void 0 ? void 0 : props.sky) ? SkyBox.fromJSON(props.sky) : undefined,
-            ground: (props === null || props === void 0 ? void 0 : props.ground) ? 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();
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { GroundPlane } from "./GroundPlane";
+import { SkyBox } from "./SkyBox";
+/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the
+ * outdoor environment.
+ * @see [[DisplayStyle3dSettings.environment]].
+ * @public
+ */
+export class Environment {
+    constructor(props) {
+        var _a, _b, _c, _d;
+        this.displaySky = (_a = props === null || props === void 0 ? void 0 : props.displaySky) !== null && _a !== void 0 ? _a : false;
+        this.displayGround = (_b = props === null || props === void 0 ? void 0 : props.displayGround) !== null && _b !== void 0 ? _b : false;
+        this.sky = (_c = props === null || props === void 0 ? void 0 : props.sky) !== null && _c !== void 0 ? _c : SkyBox.defaults;
+        this.ground = (_d = props === null || props === void 0 ? void 0 : props.ground) !== null && _d !== void 0 ? _d : 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) {
+        var _a, _b;
+        const displaySky = (_a = display.sky) !== null && _a !== void 0 ? _a : this.displaySky;
+        const displayGround = (_b = display.ground) !== null && _b !== void 0 ? _b : this.displayGround;
+        if (displaySky === this.displaySky && displayGround === this.displayGround)
+            return this;
+        return Environment.create({
+            ...this,
+            displaySky: displaySky !== null && displaySky !== void 0 ? displaySky : this.displaySky,
+            displayGround: displayGround !== null && displayGround !== void 0 ? 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) {
+        var _a, _b;
+        if (!props)
+            return this.defaults;
+        return new this({
+            displaySky: (_a = props === null || props === void 0 ? void 0 : props.sky) === null || _a === void 0 ? void 0 : _a.display,
+            displayGround: (_b = props === null || props === void 0 ? void 0 : props.ground) === null || _b === void 0 ? void 0 : _b.display,
+            sky: (props === null || props === void 0 ? void 0 : props.sky) ? SkyBox.fromJSON(props.sky) : undefined,
+            ground: (props === null || props === void 0 ? void 0 : props.ground) ? 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();
 //# 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,WAAW,EAAoB,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAe,MAAM,UAAU,CAAC;AAoB/C;;;;GAIG;AACH,MAAM,OAAO,WAAW;IAgBtB,YAAsB,KAAsC;;QAC1D,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,mCAAI,KAAK,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,aAAa,mCAAI,KAAK,CAAC;QACnD,IAAI,CAAC,GAAG,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,mCAAI,MAAM,CAAC,QAAQ,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,mCAAI,WAAW,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,MAAA,OAAO,CAAC,GAAG,mCAAI,IAAI,CAAC,UAAU,CAAC;QAClD,MAAM,aAAa,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,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,aAAV,UAAU,cAAV,UAAU,GAAI,IAAI,CAAC,UAAU;YACzC,aAAa,EAAE,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,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,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,0CAAE,OAAO;YAC/B,aAAa,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,0CAAE,OAAO;YACrC,GAAG,EAAE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,EAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;YACxD,MAAM,EAAE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,EAAC,CAAC,CAAC,WAAW,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","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"]}
+{"version":3,"file":"Environment.js","sourceRoot":"","sources":["../../src/Environment.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,WAAW,EAAoB,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAe,MAAM,UAAU,CAAC;AAoB/C;;;;GAIG;AACH,MAAM,OAAO,WAAW;IAgBtB,YAAsB,KAAsC;;QAC1D,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,mCAAI,KAAK,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,aAAa,mCAAI,KAAK,CAAC;QACnD,IAAI,CAAC,GAAG,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,mCAAI,MAAM,CAAC,QAAQ,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,mCAAI,WAAW,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,MAAA,OAAO,CAAC,GAAG,mCAAI,IAAI,CAAC,UAAU,CAAC;QAClD,MAAM,aAAa,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,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,aAAV,UAAU,cAAV,UAAU,GAAI,IAAI,CAAC,UAAU;YACzC,aAAa,EAAE,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,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,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,0CAAE,OAAO;YAC/B,aAAa,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,0CAAE,OAAO;YACrC,GAAG,EAAE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,EAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;YACxD,MAAM,EAAE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,EAAC,CAAC,CAAC,WAAW,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","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"]}

package/lib/esm/FeatureGates.d.ts

@@ -1,32 +1,32 @@
-import { BeEvent } from "@itwin/core-bentley";
-/** @internal */
-export declare type GateValue = number | boolean | string | undefined;
-/** A set of "gates" that can enable or disable features at runtime.
- * @internal
- */
-export declare class FeatureGates {
-    /** Event raised every time any feature changes. */
-    onChanged: BeEvent<(feature: string, val: GateValue) => void>;
-    /** A map of the current set of features. */
-    readonly gates: Map<string, GateValue>;
-    /** Get the value of a potentially gated feature.
-     * @param feature The name of the feature to check. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
-     *       Feature names are case-sensitive.
-     * @param defaultVal Optionally, value to return if feature is undefined.
-     */
-    check(feature: string, defaultVal?: GateValue): GateValue;
-    /** Gate access to a feature.
-     * @param feature The name of the feature to gate. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
-     *  Feature names are case-sensitive.
-     * @param val Value to set. If undefined, feature is deleted.
-     */
-    setGate(feature: string, val: GateValue): void;
-    /** Register a listener to be called whenever the value of a specific gate changes.
-     * @param feature The name of the feature to monitor
-     * @param monitor The listener to call when `feature` changes. Receives a single argument holding the new value of the feature (may be undefined).
-     * @returns A function that may be called to remove the listener.
-     * @note Use [[onChanged]] to listen to changes for *all* gates.
-     */
-    addMonitor(feature: string, monitor: (val: GateValue) => void): () => void;
-}
+import { BeEvent } from "@itwin/core-bentley";
+/** @internal */
+export declare type GateValue = number | boolean | string | undefined;
+/** A set of "gates" that can enable or disable features at runtime.
+ * @internal
+ */
+export declare class FeatureGates {
+    /** Event raised every time any feature changes. */
+    onChanged: BeEvent<(feature: string, val: GateValue) => void>;
+    /** A map of the current set of features. */
+    readonly gates: Map<string, GateValue>;
+    /** Get the value of a potentially gated feature.
+     * @param feature The name of the feature to check. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
+     *       Feature names are case-sensitive.
+     * @param defaultVal Optionally, value to return if feature is undefined.
+     */
+    check(feature: string, defaultVal?: GateValue): GateValue;
+    /** Gate access to a feature.
+     * @param feature The name of the feature to gate. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
+     *  Feature names are case-sensitive.
+     * @param val Value to set. If undefined, feature is deleted.
+     */
+    setGate(feature: string, val: GateValue): void;
+    /** Register a listener to be called whenever the value of a specific gate changes.
+     * @param feature The name of the feature to monitor
+     * @param monitor The listener to call when `feature` changes. Receives a single argument holding the new value of the feature (may be undefined).
+     * @returns A function that may be called to remove the listener.
+     * @note Use [[onChanged]] to listen to changes for *all* gates.
+     */
+    addMonitor(feature: string, monitor: (val: GateValue) => void): () => void;
+}
 //# sourceMappingURL=FeatureGates.d.ts.map

package/lib/esm/FeatureGates.js

@@ -1,52 +1,52 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-import { BeEvent } from "@itwin/core-bentley";
-/** A set of "gates" that can enable or disable features at runtime.
- * @internal
- */
-export class FeatureGates {
-    constructor() {
-        /** Event raised every time any feature changes. */
-        this.onChanged = new BeEvent();
-        /** A map of the current set of features. */
-        this.gates = new Map();
-    }
-    /** Get the value of a potentially gated feature.
-     * @param feature The name of the feature to check. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
-     *       Feature names are case-sensitive.
-     * @param defaultVal Optionally, value to return if feature is undefined.
-     */
-    check(feature, defaultVal) {
-        const val = this.gates.get(feature);
-        return val === undefined ? defaultVal : val;
-    }
-    /** Gate access to a feature.
-     * @param feature The name of the feature to gate. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
-     *  Feature names are case-sensitive.
-     * @param val Value to set. If undefined, feature is deleted.
-     */
-    setGate(feature, val) {
-        if (feature.length === 0)
-            return;
-        if (val === undefined)
-            this.gates.delete(feature);
-        else
-            this.gates.set(feature, val);
-        this.onChanged.raiseEvent(feature, val);
-    }
-    /** Register a listener to be called whenever the value of a specific gate changes.
-     * @param feature The name of the feature to monitor
-     * @param monitor The listener to call when `feature` changes. Receives a single argument holding the new value of the feature (may be undefined).
-     * @returns A function that may be called to remove the listener.
-     * @note Use [[onChanged]] to listen to changes for *all* gates.
-     */
-    addMonitor(feature, monitor) {
-        return this.onChanged.addListener((changed, val) => {
-            if (changed === feature)
-                monitor(val);
-        });
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { BeEvent } from "@itwin/core-bentley";
+/** A set of "gates" that can enable or disable features at runtime.
+ * @internal
+ */
+export class FeatureGates {
+    constructor() {
+        /** Event raised every time any feature changes. */
+        this.onChanged = new BeEvent();
+        /** A map of the current set of features. */
+        this.gates = new Map();
+    }
+    /** Get the value of a potentially gated feature.
+     * @param feature The name of the feature to check. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
+     *       Feature names are case-sensitive.
+     * @param defaultVal Optionally, value to return if feature is undefined.
+     */
+    check(feature, defaultVal) {
+        const val = this.gates.get(feature);
+        return val === undefined ? defaultVal : val;
+    }
+    /** Gate access to a feature.
+     * @param feature The name of the feature to gate. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
+     *  Feature names are case-sensitive.
+     * @param val Value to set. If undefined, feature is deleted.
+     */
+    setGate(feature, val) {
+        if (feature.length === 0)
+            return;
+        if (val === undefined)
+            this.gates.delete(feature);
+        else
+            this.gates.set(feature, val);
+        this.onChanged.raiseEvent(feature, val);
+    }
+    /** Register a listener to be called whenever the value of a specific gate changes.
+     * @param feature The name of the feature to monitor
+     * @param monitor The listener to call when `feature` changes. Receives a single argument holding the new value of the feature (may be undefined).
+     * @returns A function that may be called to remove the listener.
+     * @note Use [[onChanged]] to listen to changes for *all* gates.
+     */
+    addMonitor(feature, monitor) {
+        return this.onChanged.addListener((changed, val) => {
+            if (changed === feature)
+                monitor(val);
+        });
+    }
+}
 //# sourceMappingURL=FeatureGates.js.map

package/lib/esm/FeatureGates.js.map

@@ -1 +1 @@
-{"version":3,"file":"FeatureGates.js","sourceRoot":"","sources":["../../src/FeatureGates.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAK9C;;GAEG;AACH,MAAM,OAAO,YAAY;IAAzB;QACE,mDAAmD;QAC5C,cAAS,GAAG,IAAI,OAAO,EAA6C,CAAC;QAE5E,4CAA4C;QAC5B,UAAK,GAAG,IAAI,GAAG,EAAqB,CAAC;IAwCvD,CAAC;IAtCC;;;;OAIG;IACI,KAAK,CAAC,OAAe,EAAE,UAAsB;QAClD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACpC,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,OAAe,EAAE,GAAc;QAC5C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YACtB,OAAO;QACT,IAAI,GAAG,KAAK,SAAS;YACnB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;;YAE3B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAE/B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,OAAe,EAAE,OAAiC;QAClE,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;YACjD,IAAI,OAAO,KAAK,OAAO;gBACrB,OAAO,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,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*--------------------------------------------------------------------------------------------*/\nimport { BeEvent } from \"@itwin/core-bentley\";\n\n/** @internal */\nexport type GateValue = number | boolean | string | undefined;\n\n/** A set of \"gates\" that can enable or disable features at runtime.\n * @internal\n */\nexport class FeatureGates {\n  /** Event raised every time any feature changes. */\n  public onChanged = new BeEvent<(feature: string, val: GateValue) => void>();\n\n  /** A map of the current set of features. */\n  public readonly gates = new Map<string, GateValue>();\n\n  /** Get the value of a potentially gated feature.\n   * @param feature The name of the feature to check. May be a \"path\" of period-separated feature sub-groups (e.g. \"feature1.groupA.showMe\").\n   *       Feature names are case-sensitive.\n   * @param defaultVal Optionally, value to return if feature is undefined.\n   */\n  public check(feature: string, defaultVal?: GateValue): GateValue {\n    const val = this.gates.get(feature);\n    return val === undefined ? defaultVal : val;\n  }\n\n  /** Gate access to a feature.\n   * @param feature The name of the feature to gate. May be a \"path\" of period-separated feature sub-groups (e.g. \"feature1.groupA.showMe\").\n   *  Feature names are case-sensitive.\n   * @param val Value to set. If undefined, feature is deleted.\n   */\n  public setGate(feature: string, val: GateValue): void {\n    if (feature.length === 0)\n      return;\n    if (val === undefined)\n      this.gates.delete(feature);\n    else\n      this.gates.set(feature, val);\n\n    this.onChanged.raiseEvent(feature, val);\n  }\n\n  /** Register a listener to be called whenever the value of a specific gate changes.\n   * @param feature The name of the feature to monitor\n   * @param monitor The listener to call when `feature` changes. Receives a single argument holding the new value of the feature (may be undefined).\n   * @returns A function that may be called to remove the listener.\n   * @note Use [[onChanged]] to listen to changes for *all* gates.\n   */\n  public addMonitor(feature: string, monitor: (val: GateValue) => void): () => void {\n    return this.onChanged.addListener((changed, val) => {\n      if (changed === feature)\n        monitor(val);\n    });\n  }\n}\n"]}
+{"version":3,"file":"FeatureGates.js","sourceRoot":"","sources":["../../src/FeatureGates.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAK9C;;GAEG;AACH,MAAM,OAAO,YAAY;IAAzB;QACE,mDAAmD;QAC5C,cAAS,GAAG,IAAI,OAAO,EAA6C,CAAC;QAE5E,4CAA4C;QAC5B,UAAK,GAAG,IAAI,GAAG,EAAqB,CAAC;IAwCvD,CAAC;IAtCC;;;;OAIG;IACI,KAAK,CAAC,OAAe,EAAE,UAAsB;QAClD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACpC,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,OAAe,EAAE,GAAc;QAC5C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YACtB,OAAO;QACT,IAAI,GAAG,KAAK,SAAS;YACnB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;;YAE3B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAE/B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,OAAe,EAAE,OAAiC;QAClE,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;YACjD,IAAI,OAAO,KAAK,OAAO;gBACrB,OAAO,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,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\nimport { BeEvent } from \"@itwin/core-bentley\";\r\n\r\n/** @internal */\r\nexport type GateValue = number | boolean | string | undefined;\r\n\r\n/** A set of \"gates\" that can enable or disable features at runtime.\r\n * @internal\r\n */\r\nexport class FeatureGates {\r\n  /** Event raised every time any feature changes. */\r\n  public onChanged = new BeEvent<(feature: string, val: GateValue) => void>();\r\n\r\n  /** A map of the current set of features. */\r\n  public readonly gates = new Map<string, GateValue>();\r\n\r\n  /** Get the value of a potentially gated feature.\r\n   * @param feature The name of the feature to check. May be a \"path\" of period-separated feature sub-groups (e.g. \"feature1.groupA.showMe\").\r\n   *       Feature names are case-sensitive.\r\n   * @param defaultVal Optionally, value to return if feature is undefined.\r\n   */\r\n  public check(feature: string, defaultVal?: GateValue): GateValue {\r\n    const val = this.gates.get(feature);\r\n    return val === undefined ? defaultVal : val;\r\n  }\r\n\r\n  /** Gate access to a feature.\r\n   * @param feature The name of the feature to gate. May be a \"path\" of period-separated feature sub-groups (e.g. \"feature1.groupA.showMe\").\r\n   *  Feature names are case-sensitive.\r\n   * @param val Value to set. If undefined, feature is deleted.\r\n   */\r\n  public setGate(feature: string, val: GateValue): void {\r\n    if (feature.length === 0)\r\n      return;\r\n    if (val === undefined)\r\n      this.gates.delete(feature);\r\n    else\r\n      this.gates.set(feature, val);\r\n\r\n    this.onChanged.raiseEvent(feature, val);\r\n  }\r\n\r\n  /** Register a listener to be called whenever the value of a specific gate changes.\r\n   * @param feature The name of the feature to monitor\r\n   * @param monitor The listener to call when `feature` changes. Receives a single argument holding the new value of the feature (may be undefined).\r\n   * @returns A function that may be called to remove the listener.\r\n   * @note Use [[onChanged]] to listen to changes for *all* gates.\r\n   */\r\n  public addMonitor(feature: string, monitor: (val: GateValue) => void): () => void {\r\n    return this.onChanged.addListener((changed, val) => {\r\n      if (changed === feature)\r\n        monitor(val);\r\n    });\r\n  }\r\n}\r\n"]}