@itwin/core-backend 3.4.0-dev.48 → 3.4.0-dev.50

package/lib/cjs/workspace/Settings.js

@@ -1,153 +1,153 @@
-"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 Workspace
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseSettings = exports.SettingsPriority = void 0;
-const fs = require("fs-extra");
-const json5_1 = require("json5");
-const path_1 = require("path");
-const core_bentley_1 = require("@itwin/core-bentley");
-const IModelJsFs_1 = require("../IModelJsFs");
-/**
- * Values for SettingsPriority determine the sort order for Settings. Higher values take precedence over lower values.
- * @beta
-*/
-var SettingsPriority;
-(function (SettingsPriority) {
-    /** values supplied default-settings files */
-    SettingsPriority[SettingsPriority["defaults"] = 100] = "defaults";
-    /** values supplied by applications at runtime */
-    SettingsPriority[SettingsPriority["application"] = 200] = "application";
-    /** values that apply to all iTwins for an organization. */
-    SettingsPriority[SettingsPriority["organization"] = 300] = "organization";
-    /** values that apply to all iModels in an iTwin. */
-    SettingsPriority[SettingsPriority["iTwin"] = 400] = "iTwin";
-    /** values that apply to a single iModel. */
-    SettingsPriority[SettingsPriority["iModel"] = 500] = "iModel";
-})(SettingsPriority = exports.SettingsPriority || (exports.SettingsPriority = {}));
-/** @internal */
-function deepClone(obj) {
-    if (!obj || typeof obj !== "object")
-        return obj;
-    const result = Array.isArray(obj) ? [] : {};
-    Object.keys(obj).forEach((key) => {
-        const val = obj[key];
-        if (val && typeof val === "object") {
-            result[key] = deepClone(val);
-        }
-        else {
-            result[key] = val;
-        }
-    });
-    return result;
-}
-class SettingsDictionary {
-    constructor(name, priority, settings) {
-        this.name = name;
-        this.priority = priority;
-        this.settings = settings;
-    }
-    getSetting(settingName) {
-        return this.settings[settingName];
-    }
-}
-/**
- * Internal implementation of Settings interface.
- * @internal
- */
-class BaseSettings {
-    constructor() {
-        this._dictionaries = [];
-        this.onSettingsChanged = new core_bentley_1.BeEvent();
-    }
-    verifyPriority(_priority) { }
-    close() { }
-    addFile(fileName, priority) {
-        this.addJson(fileName, priority, fs.readFileSync(fileName, "utf-8"));
-    }
-    addDirectory(dirName, priority) {
-        for (const fileName of IModelJsFs_1.IModelJsFs.readdirSync(dirName)) {
-            const ext = (0, path_1.extname)(fileName);
-            if (ext === ".json5" || ext === ".json")
-                this.addFile((0, path_1.join)(dirName, fileName), priority);
-        }
-    }
-    addJson(dictionaryName, priority, settingsJson) {
-        this.addDictionary(dictionaryName, priority, (0, json5_1.parse)(settingsJson));
-    }
-    addDictionary(dictionaryName, priority, settings) {
-        this.verifyPriority(priority);
-        this.dropDictionary(dictionaryName, false); // make sure we don't have the same dictionary twice
-        const file = new SettingsDictionary(dictionaryName, priority, settings);
-        const doAdd = () => {
-            for (let i = 0; i < this._dictionaries.length; ++i) {
-                if (this._dictionaries[i].priority <= file.priority) {
-                    this._dictionaries.splice(i, 0, file);
-                    return;
-                }
-            }
-            this._dictionaries.push(file);
-        };
-        doAdd();
-        this.onSettingsChanged.raiseEvent();
-    }
-    dropDictionary(dictionaryName, raiseEvent = true) {
-        for (let i = 0; i < this._dictionaries.length; ++i) {
-            if (this._dictionaries[i].name === dictionaryName) {
-                this._dictionaries.splice(i, 1);
-                if (raiseEvent)
-                    this.onSettingsChanged.raiseEvent();
-                return true;
-            }
-        }
-        return false;
-    }
-    resolveSetting(name, resolver, defaultValue) {
-        for (const dict of this._dictionaries) {
-            const val = dict.getSetting(name);
-            const resolved = val && resolver(val, dict.name, dict.priority);
-            if (undefined !== resolved)
-                return resolved;
-        }
-        return defaultValue;
-    }
-    getSetting(name, defaultValue) {
-        var _a;
-        return (_a = this.resolveSetting(name, (val) => deepClone(val))) !== null && _a !== void 0 ? _a : defaultValue;
-    }
-    /** for debugging. Returns an array of all values for a setting, sorted by priority.
-     * @note values are not cloned. Do not modify objects or arrays.
-     */
-    inspectSetting(name) {
-        const all = [];
-        this.resolveSetting(name, (value, dictionary, priority) => { all.push({ value, dictionary, priority }); return undefined; });
-        return all;
-    }
-    getString(name, defaultValue) {
-        const out = this.getSetting(name);
-        return typeof out === "string" ? out : defaultValue;
-    }
-    getBoolean(name, defaultValue) {
-        const out = this.getSetting(name);
-        return typeof out === "boolean" ? out : defaultValue;
-    }
-    getNumber(name, defaultValue) {
-        const out = this.getSetting(name);
-        return typeof out === "number" ? out : defaultValue;
-    }
-    getObject(name, defaultValue) {
-        const out = this.getSetting(name);
-        return typeof out === "object" ? out : defaultValue;
-    }
-    getArray(name, defaultValue) {
-        const out = this.getSetting(name);
-        return Array.isArray(out) ? out : defaultValue;
-    }
-}
-exports.BaseSettings = BaseSettings;
+"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 Workspace
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseSettings = exports.SettingsPriority = void 0;
+const fs = require("fs-extra");
+const json5_1 = require("json5");
+const path_1 = require("path");
+const core_bentley_1 = require("@itwin/core-bentley");
+const IModelJsFs_1 = require("../IModelJsFs");
+/**
+ * Values for SettingsPriority determine the sort order for Settings. Higher values take precedence over lower values.
+ * @beta
+*/
+var SettingsPriority;
+(function (SettingsPriority) {
+    /** values supplied default-settings files */
+    SettingsPriority[SettingsPriority["defaults"] = 100] = "defaults";
+    /** values supplied by applications at runtime */
+    SettingsPriority[SettingsPriority["application"] = 200] = "application";
+    /** values that apply to all iTwins for an organization. */
+    SettingsPriority[SettingsPriority["organization"] = 300] = "organization";
+    /** values that apply to all iModels in an iTwin. */
+    SettingsPriority[SettingsPriority["iTwin"] = 400] = "iTwin";
+    /** values that apply to a single iModel. */
+    SettingsPriority[SettingsPriority["iModel"] = 500] = "iModel";
+})(SettingsPriority = exports.SettingsPriority || (exports.SettingsPriority = {}));
+/** @internal */
+function deepClone(obj) {
+    if (!obj || typeof obj !== "object")
+        return obj;
+    const result = Array.isArray(obj) ? [] : {};
+    Object.keys(obj).forEach((key) => {
+        const val = obj[key];
+        if (val && typeof val === "object") {
+            result[key] = deepClone(val);
+        }
+        else {
+            result[key] = val;
+        }
+    });
+    return result;
+}
+class SettingsDictionary {
+    constructor(name, priority, settings) {
+        this.name = name;
+        this.priority = priority;
+        this.settings = settings;
+    }
+    getSetting(settingName) {
+        return this.settings[settingName];
+    }
+}
+/**
+ * Internal implementation of Settings interface.
+ * @internal
+ */
+class BaseSettings {
+    constructor() {
+        this._dictionaries = [];
+        this.onSettingsChanged = new core_bentley_1.BeEvent();
+    }
+    verifyPriority(_priority) { }
+    close() { }
+    addFile(fileName, priority) {
+        this.addJson(fileName, priority, fs.readFileSync(fileName, "utf-8"));
+    }
+    addDirectory(dirName, priority) {
+        for (const fileName of IModelJsFs_1.IModelJsFs.readdirSync(dirName)) {
+            const ext = (0, path_1.extname)(fileName);
+            if (ext === ".json5" || ext === ".json")
+                this.addFile((0, path_1.join)(dirName, fileName), priority);
+        }
+    }
+    addJson(dictionaryName, priority, settingsJson) {
+        this.addDictionary(dictionaryName, priority, (0, json5_1.parse)(settingsJson));
+    }
+    addDictionary(dictionaryName, priority, settings) {
+        this.verifyPriority(priority);
+        this.dropDictionary(dictionaryName, false); // make sure we don't have the same dictionary twice
+        const file = new SettingsDictionary(dictionaryName, priority, settings);
+        const doAdd = () => {
+            for (let i = 0; i < this._dictionaries.length; ++i) {
+                if (this._dictionaries[i].priority <= file.priority) {
+                    this._dictionaries.splice(i, 0, file);
+                    return;
+                }
+            }
+            this._dictionaries.push(file);
+        };
+        doAdd();
+        this.onSettingsChanged.raiseEvent();
+    }
+    dropDictionary(dictionaryName, raiseEvent = true) {
+        for (let i = 0; i < this._dictionaries.length; ++i) {
+            if (this._dictionaries[i].name === dictionaryName) {
+                this._dictionaries.splice(i, 1);
+                if (raiseEvent)
+                    this.onSettingsChanged.raiseEvent();
+                return true;
+            }
+        }
+        return false;
+    }
+    resolveSetting(name, resolver, defaultValue) {
+        for (const dict of this._dictionaries) {
+            const val = dict.getSetting(name);
+            const resolved = val && resolver(val, dict.name, dict.priority);
+            if (undefined !== resolved)
+                return resolved;
+        }
+        return defaultValue;
+    }
+    getSetting(name, defaultValue) {
+        var _a;
+        return (_a = this.resolveSetting(name, (val) => deepClone(val))) !== null && _a !== void 0 ? _a : defaultValue;
+    }
+    /** for debugging. Returns an array of all values for a setting, sorted by priority.
+     * @note values are not cloned. Do not modify objects or arrays.
+     */
+    inspectSetting(name) {
+        const all = [];
+        this.resolveSetting(name, (value, dictionary, priority) => { all.push({ value, dictionary, priority }); return undefined; });
+        return all;
+    }
+    getString(name, defaultValue) {
+        const out = this.getSetting(name);
+        return typeof out === "string" ? out : defaultValue;
+    }
+    getBoolean(name, defaultValue) {
+        const out = this.getSetting(name);
+        return typeof out === "boolean" ? out : defaultValue;
+    }
+    getNumber(name, defaultValue) {
+        const out = this.getSetting(name);
+        return typeof out === "number" ? out : defaultValue;
+    }
+    getObject(name, defaultValue) {
+        const out = this.getSetting(name);
+        return typeof out === "object" ? out : defaultValue;
+    }
+    getArray(name, defaultValue) {
+        const out = this.getSetting(name);
+        return Array.isArray(out) ? out : defaultValue;
+    }
+}
+exports.BaseSettings = BaseSettings;
 //# sourceMappingURL=Settings.js.map

package/lib/cjs/workspace/Settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"Settings.js","sourceRoot":"","sources":["../../../src/workspace/Settings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,iCAA8B;AAC9B,+BAAqC;AACrC,sDAA8D;AAE9D,8CAA2C;AAmD3C;;;EAGE;AACF,IAAY,gBAWX;AAXD,WAAY,gBAAgB;IAC1B,6CAA6C;IAC7C,iEAAc,CAAA;IACd,iDAAiD;IACjD,uEAAiB,CAAA;IACjB,2DAA2D;IAC3D,yEAAkB,CAAA;IAClB,oDAAoD;IACpD,2DAAW,CAAA;IACX,4CAA4C;IAC5C,6DAAY,CAAA;AACd,CAAC,EAXW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAW3B;AAyGD,gBAAgB;AAChB,SAAS,SAAS,CAAwB,GAAQ;IAChD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QACjC,OAAO,GAAG,CAAC;IAEb,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAS,CAAC;IACnD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;QACvC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAClC,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;SAC9B;aAAM;YACL,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;SACnB;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,kBAAkB;IACtB,YAAmC,IAAY,EAAkB,QAA0B,EAAkB,QAA2B;QAArG,SAAI,GAAJ,IAAI,CAAQ;QAAkB,aAAQ,GAAR,QAAQ,CAAkB;QAAkB,aAAQ,GAAR,QAAQ,CAAmB;IAAI,CAAC;IACtI,UAAU,CAAwB,WAAmB;QAC1D,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAkB,CAAC;IACrD,CAAC;CACF;AAED;;;GAGG;AACH,MAAa,YAAY;IAAzB;QACU,kBAAa,GAAyB,EAAE,CAAC;QAGjC,sBAAiB,GAAG,IAAI,sBAAO,EAAc,CAAC;IAoGhE,CAAC;IAtGW,cAAc,CAAC,SAA2B,IAAI,CAAC;IAClD,KAAK,KAAK,CAAC;IAGX,OAAO,CAAC,QAAuB,EAAE,QAA0B;QAChE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACvE,CAAC;IAEM,YAAY,CAAC,OAAqB,EAAE,QAA0B;QACnE,KAAK,MAAM,QAAQ,IAAI,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YACtD,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;YAC9B,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,OAAO;gBACrC,IAAI,CAAC,OAAO,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;SACnD;IACH,CAAC;IAEM,OAAO,CAAC,cAAsB,EAAE,QAA0B,EAAE,YAAoB;QACrF,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,QAAQ,EAAE,IAAA,aAAK,EAAC,YAAY,CAAC,CAAC,CAAC;IACpE,CAAC;IAEM,aAAa,CAAC,cAAsB,EAAE,QAA0B,EAAE,QAA2B;QAClG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC,oDAAoD;QAChG,MAAM,IAAI,GAAG,IAAI,kBAAkB,CAAC,cAAc,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACxE,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAClD,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE;oBACnD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;oBACtC,OAAO;iBACR;aACF;YACD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC;QACF,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;IACtC,CAAC;IAEM,cAAc,CAAC,cAA8B,EAAE,UAAU,GAAG,IAAI;QACrE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YAClD,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,EAAE;gBACjD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAChC,IAAI,UAAU;oBACZ,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;gBACtC,OAAO,IAAI,CAAC;aACb;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,cAAc,CAAwB,IAAiB,EAAE,QAA4B,EAAE,YAAgB;QAC5G,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAkB,CAAC;YACnD,MAAM,QAAQ,GAAG,GAAG,IAAI,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChE,IAAI,SAAS,KAAK,QAAQ;gBACxB,OAAO,QAAQ,CAAC;SACnB;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAEM,UAAU,CAAwB,IAAiB,EAAE,YAAgB;;QAC1E,OAAO,MAAA,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAI,GAAG,CAAC,CAAC,mCAAI,YAAY,CAAC;IAC/E,CAAC;IAED;;OAEG;IACI,cAAc,CAAwB,IAAiB;QAC5D,MAAM,GAAG,GAA0B,EAAE,CAAC;QACtC,IAAI,CAAC,cAAc,CAAI,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAChI,OAAO,GAAG,CAAC;IACb,CAAC;IAIM,SAAS,CAAC,IAAiB,EAAE,YAAqB;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAS,IAAI,CAAC,CAAC;QAC1C,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACtD,CAAC;IAGM,UAAU,CAAC,IAAiB,EAAE,YAAsB;QACzD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAU,IAAI,CAAC,CAAC;QAC3C,OAAO,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACvD,CAAC;IAGM,SAAS,CAAC,IAAiB,EAAE,YAAqB;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAS,IAAI,CAAC,CAAC;QAC1C,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACtD,CAAC;IAGM,SAAS,CAAmB,IAAiB,EAAE,YAAgB;QACpE,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAgB,IAAI,CAAC,CAAC;QACjD,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;IAC3D,CAAC;IAGM,QAAQ,CAAwB,IAAiB,EAAE,YAAuB;QAC/E,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAW,IAAI,CAAC,CAAC;QAC5C,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACjD,CAAC;CACF;AAxGD,oCAwGC","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 Workspace\n */\n\nimport * as fs from \"fs-extra\";\nimport { parse } from \"json5\";\nimport { extname, join } from \"path\";\nimport { BeEvent, JSONSchemaType } from \"@itwin/core-bentley\";\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\nimport { IModelJsFs } from \"../IModelJsFs\";\n\n/** The type of a Setting, according to its schema\n * @beta\n */\nexport type SettingType = JSONSchemaType;\n\n/**\n * The name of a Setting. SettingNames must be valid JavaScript property names, defined in a [[SettingSchema]].\n * @see [SettingName]($docs/learning/backend/Workspace#settingnames)\n * @beta\n */\nexport type SettingName = string;\n\n/** The name of a [[SettingDictionary]]. `SettingDictionary`s are stored in [[Settings]] and may be removed by DictionaryName.\n * DictionaryNames must be valid JavaScript property names.\n * @beta\n */\nexport type DictionaryName = string;\n\n/**\n * A function called by [[Settings.resolveSetting]] for every SettingDictionary with a Setting that matches a name. The\n * SettingDictionaries are sorted by priority and this function is called in priority order with the highest priority first.\n * When this function returns a non-undefined value, the iteration is stopped and that value is returned. In this way,\n * applications can \"combine\" the prioritized Setting values as appropriate. The default implementation of this function\n * used by [[Settings.getSetting]] merely returns a clone of the value the first time it is called, so the highest priority\n * value is returned.\n * @beta\n */\nexport type SettingResolver<T> = (val: T, dict: DictionaryName, priority: SettingsPriority) => T | undefined;\n\n/** An entry in the array returned by [[Settings.inspectSetting]]\n * @beta\n *\n */\nexport interface SettingInspector<T> { value: T, dictionary: DictionaryName, priority: number }\n\n/** An object with string-named members (as opposed to an array object).\n * @beta\n */\nexport interface SettingObject {\n  [name: string]: SettingType;\n}\n\n/**\n * An object with Settings as its members. A SettingDictionary also has a name and generally comes from a parsed JSON file, but\n * may also be created in memory by applications\n * @beta\n */\nexport type SettingDictionary = SettingObject;\n\n/**\n * Values for SettingsPriority determine the sort order for Settings. Higher values take precedence over lower values.\n * @beta\n*/\nexport enum SettingsPriority {\n  /** values supplied default-settings files */\n  defaults = 100,\n  /** values supplied by applications at runtime */\n  application = 200,\n  /** values that apply to all iTwins for an organization. */\n  organization = 300,\n  /** values that apply to all iModels in an iTwin. */\n  iTwin = 400,\n  /** values that apply to a single iModel. */\n  iModel = 500,\n}\n\n/** The current set of Settings for a Workspace.\n * @beta\n */\nexport interface Settings {\n  /** @internal */\n  close(): void;\n\n  /** Event raised whenever a SettingsDictionary is added or removed. */\n  readonly onSettingsChanged: BeEvent<() => void>;\n\n  /** Add a SettingDictionary from a local settings file. The file should be in [JSON5](https://json5.org/) format. It is read\n   * and parsed and the fileName is used as the DictionaryName.\n   * @param fileName the name of a local settings file of the SettingDictionary. This becomes the DictionaryName.\n   * @param priority the SettingsPriority for the SettingDictionary\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\n   */\n  addFile(fileName: LocalFileName, priority: SettingsPriority): void;\n\n  /** Add all files in the supplied directory with the extension \".json\" or \".json5\"\n   * @param dirName the name of a local settings directory\n   */\n  addDirectory(dirName: LocalDirName, priority: SettingsPriority): void;\n\n  /** Add a SettingDictionary from a JSON5 stringified string. The string is parsed and the resultant object is added as a SettingDictionary.\n   * @param dictionaryName the name of the SettingDictionary\n   * @param priority the SettingsPriority for the SettingDictionary\n   * @param settingsJson the JSON5 stringified string to be parsed.\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\n   */\n  addJson(dictionaryName: DictionaryName, priority: SettingsPriority, settingsJson: string): void;\n\n  /** Add a SettingDictionary object.\n   * @param dictionaryName the name of the SettingDictionary\n   * @param priority the SettingsPriority for the SettingDictionary\n   * @param settings the SettingDictionary object to be added.\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\n   */\n  addDictionary(dictionaryName: DictionaryName, priority: SettingsPriority, settings: SettingDictionary): void;\n\n  /** Remove a SettingDictionary by name. */\n  dropDictionary(dictionaryName: DictionaryName): void;\n\n  /**\n   * Resolve a setting, by name, using a SettingResolver.\n   * @param settingName The name of the setting to resolve\n   * @param resolver function to be called for each SettingDictionary with a matching Setting. Iteration stops when it returns a non-undefined value.\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary or resolver never returned a value.\n   * @returns the resolved setting value.\n   */\n  resolveSetting<T extends SettingType>(settingName: SettingName, resolver: SettingResolver<T>, defaultValue: T): T;\n  resolveSetting<T extends SettingType>(settingName: SettingName, resolver: SettingResolver<T>, defaultValue?: T): T | undefined;\n\n  /** Get the highest priority setting for a SettingName.\n   * @param settingName The name of the setting\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary.\n   * @note This method is generic on SettingType, but no type checking is actually performed at run time. So, if you\n   * use this method to get a setting with an expected type, but its value is a different type, the return type of this method will be wrong.\n   * You must always type check the result. Use the non-generic \"get\" methods (e.g. [[getString]]) if you only want the value\n   * if its type is correct.\n   */\n  getSetting<T extends SettingType>(settingName: SettingName, defaultValue?: T): T | undefined;\n\n  /** Get a string setting by SettingName.\n   * @param settingName The name of the setting\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a string.\n   */\n  getString(settingName: SettingName, defaultValue: string): string;\n  getString(settingName: SettingName, defaultValue?: string): string | undefined;\n\n  /** Get a boolean setting by SettingName.\n  * @param settingName The name of the setting\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a boolean.\n  */\n  getBoolean(settingName: SettingName, defaultValue: boolean): boolean;\n  getBoolean(settingName: SettingName, defaultValue?: boolean): boolean | undefined;\n\n  /** Get a number setting by SettingName.\n  * @param settingName The name of the setting\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a number.\n  */\n  getNumber(settingName: SettingName, defaultValue: number): number;\n  getNumber(settingName: SettingName): number | undefined;\n\n  /** Get an object setting by SettingName.\n  * @param settingName The name of the setting\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not an object.\n  */\n  getObject<T extends object>(settingName: SettingName, defaultValue: T): T;\n  getObject<T extends object>(settingName: SettingName): T | undefined;\n\n  /** Get an array setting by SettingName.\n  * @param settingName The name of the setting\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not an array.\n  */\n  getArray<T extends SettingType>(settingName: SettingName, defaultValue: Array<T>): Array<T>;\n  getArray<T extends SettingType>(settingName: SettingName): Array<T> | undefined;\n\n  /** Get an array of [[SettingInspector] objects, sorted in priority order, for all Settings that match a SettingName.\n   * @note this method is mainly for debugging and diagnostics.\n   */\n  inspectSetting<T extends SettingType>(name: SettingName): SettingInspector<T>[];\n}\n\n/** @internal */\nfunction deepClone<T extends SettingType>(obj: any): T {\n  if (!obj || typeof obj !== \"object\")\n    return obj;\n\n  const result = Array.isArray(obj) ? [] : {} as any;\n  Object.keys(obj).forEach((key: string) => {\n    const val = obj[key];\n    if (val && typeof val === \"object\") {\n      result[key] = deepClone(val);\n    } else {\n      result[key] = val;\n    }\n  });\n  return result;\n}\n\nclass SettingsDictionary {\n  public constructor(public readonly name: string, public readonly priority: SettingsPriority, public readonly settings: SettingDictionary) { }\n  public getSetting<T extends SettingType>(settingName: string): SettingType | undefined {\n    return this.settings[settingName] as T | undefined;\n  }\n}\n\n/**\n * Internal implementation of Settings interface.\n * @internal\n */\nexport class BaseSettings implements Settings {\n  private _dictionaries: SettingsDictionary[] = [];\n  protected verifyPriority(_priority: SettingsPriority) { }\n  public close() { }\n  public readonly onSettingsChanged = new BeEvent<() => void>();\n\n  public addFile(fileName: LocalFileName, priority: SettingsPriority) {\n    this.addJson(fileName, priority, fs.readFileSync(fileName, \"utf-8\"));\n  }\n\n  public addDirectory(dirName: LocalDirName, priority: SettingsPriority) {\n    for (const fileName of IModelJsFs.readdirSync(dirName)) {\n      const ext = extname(fileName);\n      if (ext === \".json5\" || ext === \".json\")\n        this.addFile(join(dirName, fileName), priority);\n    }\n  }\n\n  public addJson(dictionaryName: string, priority: SettingsPriority, settingsJson: string) {\n    this.addDictionary(dictionaryName, priority, parse(settingsJson));\n  }\n\n  public addDictionary(dictionaryName: string, priority: SettingsPriority, settings: SettingDictionary) {\n    this.verifyPriority(priority);\n    this.dropDictionary(dictionaryName, false); // make sure we don't have the same dictionary twice\n    const file = new SettingsDictionary(dictionaryName, priority, settings);\n    const doAdd = () => {\n      for (let i = 0; i < this._dictionaries.length; ++i) {\n        if (this._dictionaries[i].priority <= file.priority) {\n          this._dictionaries.splice(i, 0, file);\n          return;\n        }\n      }\n      this._dictionaries.push(file);\n    };\n    doAdd();\n    this.onSettingsChanged.raiseEvent();\n  }\n\n  public dropDictionary(dictionaryName: DictionaryName, raiseEvent = true) {\n    for (let i = 0; i < this._dictionaries.length; ++i) {\n      if (this._dictionaries[i].name === dictionaryName) {\n        this._dictionaries.splice(i, 1);\n        if (raiseEvent)\n          this.onSettingsChanged.raiseEvent();\n        return true;\n      }\n    }\n    return false;\n  }\n\n  public resolveSetting<T extends SettingType>(name: SettingName, resolver: SettingResolver<T>, defaultValue?: T): T | undefined {\n    for (const dict of this._dictionaries) {\n      const val = dict.getSetting(name) as T | undefined;\n      const resolved = val && resolver(val, dict.name, dict.priority);\n      if (undefined !== resolved)\n        return resolved;\n    }\n    return defaultValue;\n  }\n\n  public getSetting<T extends SettingType>(name: SettingName, defaultValue?: T): T | undefined {\n    return this.resolveSetting(name, (val) => deepClone<T>(val)) ?? defaultValue;\n  }\n\n  /** for debugging. Returns an array of all values for a setting, sorted by priority.\n   * @note values are not cloned. Do not modify objects or arrays.\n   */\n  public inspectSetting<T extends SettingType>(name: SettingName): SettingInspector<T>[] {\n    const all: SettingInspector<T>[] = [];\n    this.resolveSetting<T>(name, (value, dictionary, priority) => { all.push({ value, dictionary, priority }); return undefined; });\n    return all;\n  }\n\n  public getString(name: SettingName, defaultValue: string): string;\n  public getString(name: SettingName): string | undefined;\n  public getString(name: SettingName, defaultValue?: string): string | undefined {\n    const out = this.getSetting<string>(name);\n    return typeof out === \"string\" ? out : defaultValue;\n  }\n  public getBoolean(name: SettingName, defaultValue: boolean): boolean;\n  public getBoolean(name: SettingName): boolean | undefined;\n  public getBoolean(name: SettingName, defaultValue?: boolean): boolean | undefined {\n    const out = this.getSetting<boolean>(name);\n    return typeof out === \"boolean\" ? out : defaultValue;\n  }\n  public getNumber(name: SettingName, defaultValue: number): number;\n  public getNumber(name: SettingName): number | undefined;\n  public getNumber(name: SettingName, defaultValue?: number): number | undefined {\n    const out = this.getSetting<number>(name);\n    return typeof out === \"number\" ? out : defaultValue;\n  }\n  public getObject<T extends object>(name: SettingName, defaultValue: T): T;\n  public getObject<T extends object>(name: SettingName): T | undefined;\n  public getObject<T extends object>(name: SettingName, defaultValue?: T): T | undefined {\n    const out = this.getSetting<SettingObject>(name);\n    return typeof out === \"object\" ? out as T : defaultValue;\n  }\n  public getArray<T extends SettingType>(name: SettingName, defaultValue: Array<T>): Array<T>;\n  public getArray<T extends SettingType>(name: SettingName): Array<T> | undefined;\n  public getArray<T extends SettingType>(name: SettingName, defaultValue?: Array<T>): Array<T> | undefined {\n    const out = this.getSetting<Array<T>>(name);\n    return Array.isArray(out) ? out : defaultValue;\n  }\n}\n"]}
+{"version":3,"file":"Settings.js","sourceRoot":"","sources":["../../../src/workspace/Settings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,iCAA8B;AAC9B,+BAAqC;AACrC,sDAA8D;AAE9D,8CAA2C;AAmD3C;;;EAGE;AACF,IAAY,gBAWX;AAXD,WAAY,gBAAgB;IAC1B,6CAA6C;IAC7C,iEAAc,CAAA;IACd,iDAAiD;IACjD,uEAAiB,CAAA;IACjB,2DAA2D;IAC3D,yEAAkB,CAAA;IAClB,oDAAoD;IACpD,2DAAW,CAAA;IACX,4CAA4C;IAC5C,6DAAY,CAAA;AACd,CAAC,EAXW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAW3B;AAyGD,gBAAgB;AAChB,SAAS,SAAS,CAAwB,GAAQ;IAChD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QACjC,OAAO,GAAG,CAAC;IAEb,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAS,CAAC;IACnD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;QACvC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAClC,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;SAC9B;aAAM;YACL,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;SACnB;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,kBAAkB;IACtB,YAAmC,IAAY,EAAkB,QAA0B,EAAkB,QAA2B;QAArG,SAAI,GAAJ,IAAI,CAAQ;QAAkB,aAAQ,GAAR,QAAQ,CAAkB;QAAkB,aAAQ,GAAR,QAAQ,CAAmB;IAAI,CAAC;IACtI,UAAU,CAAwB,WAAmB;QAC1D,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAkB,CAAC;IACrD,CAAC;CACF;AAED;;;GAGG;AACH,MAAa,YAAY;IAAzB;QACU,kBAAa,GAAyB,EAAE,CAAC;QAGjC,sBAAiB,GAAG,IAAI,sBAAO,EAAc,CAAC;IAoGhE,CAAC;IAtGW,cAAc,CAAC,SAA2B,IAAI,CAAC;IAClD,KAAK,KAAK,CAAC;IAGX,OAAO,CAAC,QAAuB,EAAE,QAA0B;QAChE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACvE,CAAC;IAEM,YAAY,CAAC,OAAqB,EAAE,QAA0B;QACnE,KAAK,MAAM,QAAQ,IAAI,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YACtD,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;YAC9B,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,OAAO;gBACrC,IAAI,CAAC,OAAO,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;SACnD;IACH,CAAC;IAEM,OAAO,CAAC,cAAsB,EAAE,QAA0B,EAAE,YAAoB;QACrF,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,QAAQ,EAAE,IAAA,aAAK,EAAC,YAAY,CAAC,CAAC,CAAC;IACpE,CAAC;IAEM,aAAa,CAAC,cAAsB,EAAE,QAA0B,EAAE,QAA2B;QAClG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC,oDAAoD;QAChG,MAAM,IAAI,GAAG,IAAI,kBAAkB,CAAC,cAAc,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACxE,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAClD,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE;oBACnD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;oBACtC,OAAO;iBACR;aACF;YACD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC;QACF,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;IACtC,CAAC;IAEM,cAAc,CAAC,cAA8B,EAAE,UAAU,GAAG,IAAI;QACrE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YAClD,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,EAAE;gBACjD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAChC,IAAI,UAAU;oBACZ,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;gBACtC,OAAO,IAAI,CAAC;aACb;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,cAAc,CAAwB,IAAiB,EAAE,QAA4B,EAAE,YAAgB;QAC5G,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAkB,CAAC;YACnD,MAAM,QAAQ,GAAG,GAAG,IAAI,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChE,IAAI,SAAS,KAAK,QAAQ;gBACxB,OAAO,QAAQ,CAAC;SACnB;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAEM,UAAU,CAAwB,IAAiB,EAAE,YAAgB;;QAC1E,OAAO,MAAA,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAI,GAAG,CAAC,CAAC,mCAAI,YAAY,CAAC;IAC/E,CAAC;IAED;;OAEG;IACI,cAAc,CAAwB,IAAiB;QAC5D,MAAM,GAAG,GAA0B,EAAE,CAAC;QACtC,IAAI,CAAC,cAAc,CAAI,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAChI,OAAO,GAAG,CAAC;IACb,CAAC;IAIM,SAAS,CAAC,IAAiB,EAAE,YAAqB;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAS,IAAI,CAAC,CAAC;QAC1C,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACtD,CAAC;IAGM,UAAU,CAAC,IAAiB,EAAE,YAAsB;QACzD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAU,IAAI,CAAC,CAAC;QAC3C,OAAO,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACvD,CAAC;IAGM,SAAS,CAAC,IAAiB,EAAE,YAAqB;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAS,IAAI,CAAC,CAAC;QAC1C,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACtD,CAAC;IAGM,SAAS,CAAmB,IAAiB,EAAE,YAAgB;QACpE,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAgB,IAAI,CAAC,CAAC;QACjD,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;IAC3D,CAAC;IAGM,QAAQ,CAAwB,IAAiB,EAAE,YAAuB;QAC/E,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAW,IAAI,CAAC,CAAC;QAC5C,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACjD,CAAC;CACF;AAxGD,oCAwGC","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 Workspace\r\n */\r\n\r\nimport * as fs from \"fs-extra\";\r\nimport { parse } from \"json5\";\r\nimport { extname, join } from \"path\";\r\nimport { BeEvent, JSONSchemaType } from \"@itwin/core-bentley\";\r\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { IModelJsFs } from \"../IModelJsFs\";\r\n\r\n/** The type of a Setting, according to its schema\r\n * @beta\r\n */\r\nexport type SettingType = JSONSchemaType;\r\n\r\n/**\r\n * The name of a Setting. SettingNames must be valid JavaScript property names, defined in a [[SettingSchema]].\r\n * @see [SettingName]($docs/learning/backend/Workspace#settingnames)\r\n * @beta\r\n */\r\nexport type SettingName = string;\r\n\r\n/** The name of a [[SettingDictionary]]. `SettingDictionary`s are stored in [[Settings]] and may be removed by DictionaryName.\r\n * DictionaryNames must be valid JavaScript property names.\r\n * @beta\r\n */\r\nexport type DictionaryName = string;\r\n\r\n/**\r\n * A function called by [[Settings.resolveSetting]] for every SettingDictionary with a Setting that matches a name. The\r\n * SettingDictionaries are sorted by priority and this function is called in priority order with the highest priority first.\r\n * When this function returns a non-undefined value, the iteration is stopped and that value is returned. In this way,\r\n * applications can \"combine\" the prioritized Setting values as appropriate. The default implementation of this function\r\n * used by [[Settings.getSetting]] merely returns a clone of the value the first time it is called, so the highest priority\r\n * value is returned.\r\n * @beta\r\n */\r\nexport type SettingResolver<T> = (val: T, dict: DictionaryName, priority: SettingsPriority) => T | undefined;\r\n\r\n/** An entry in the array returned by [[Settings.inspectSetting]]\r\n * @beta\r\n *\r\n */\r\nexport interface SettingInspector<T> { value: T, dictionary: DictionaryName, priority: number }\r\n\r\n/** An object with string-named members (as opposed to an array object).\r\n * @beta\r\n */\r\nexport interface SettingObject {\r\n  [name: string]: SettingType;\r\n}\r\n\r\n/**\r\n * An object with Settings as its members. A SettingDictionary also has a name and generally comes from a parsed JSON file, but\r\n * may also be created in memory by applications\r\n * @beta\r\n */\r\nexport type SettingDictionary = SettingObject;\r\n\r\n/**\r\n * Values for SettingsPriority determine the sort order for Settings. Higher values take precedence over lower values.\r\n * @beta\r\n*/\r\nexport enum SettingsPriority {\r\n  /** values supplied default-settings files */\r\n  defaults = 100,\r\n  /** values supplied by applications at runtime */\r\n  application = 200,\r\n  /** values that apply to all iTwins for an organization. */\r\n  organization = 300,\r\n  /** values that apply to all iModels in an iTwin. */\r\n  iTwin = 400,\r\n  /** values that apply to a single iModel. */\r\n  iModel = 500,\r\n}\r\n\r\n/** The current set of Settings for a Workspace.\r\n * @beta\r\n */\r\nexport interface Settings {\r\n  /** @internal */\r\n  close(): void;\r\n\r\n  /** Event raised whenever a SettingsDictionary is added or removed. */\r\n  readonly onSettingsChanged: BeEvent<() => void>;\r\n\r\n  /** Add a SettingDictionary from a local settings file. The file should be in [JSON5](https://json5.org/) format. It is read\r\n   * and parsed and the fileName is used as the DictionaryName.\r\n   * @param fileName the name of a local settings file of the SettingDictionary. This becomes the DictionaryName.\r\n   * @param priority the SettingsPriority for the SettingDictionary\r\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\r\n   */\r\n  addFile(fileName: LocalFileName, priority: SettingsPriority): void;\r\n\r\n  /** Add all files in the supplied directory with the extension \".json\" or \".json5\"\r\n   * @param dirName the name of a local settings directory\r\n   */\r\n  addDirectory(dirName: LocalDirName, priority: SettingsPriority): void;\r\n\r\n  /** Add a SettingDictionary from a JSON5 stringified string. The string is parsed and the resultant object is added as a SettingDictionary.\r\n   * @param dictionaryName the name of the SettingDictionary\r\n   * @param priority the SettingsPriority for the SettingDictionary\r\n   * @param settingsJson the JSON5 stringified string to be parsed.\r\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\r\n   */\r\n  addJson(dictionaryName: DictionaryName, priority: SettingsPriority, settingsJson: string): void;\r\n\r\n  /** Add a SettingDictionary object.\r\n   * @param dictionaryName the name of the SettingDictionary\r\n   * @param priority the SettingsPriority for the SettingDictionary\r\n   * @param settings the SettingDictionary object to be added.\r\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\r\n   */\r\n  addDictionary(dictionaryName: DictionaryName, priority: SettingsPriority, settings: SettingDictionary): void;\r\n\r\n  /** Remove a SettingDictionary by name. */\r\n  dropDictionary(dictionaryName: DictionaryName): void;\r\n\r\n  /**\r\n   * Resolve a setting, by name, using a SettingResolver.\r\n   * @param settingName The name of the setting to resolve\r\n   * @param resolver function to be called for each SettingDictionary with a matching Setting. Iteration stops when it returns a non-undefined value.\r\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary or resolver never returned a value.\r\n   * @returns the resolved setting value.\r\n   */\r\n  resolveSetting<T extends SettingType>(settingName: SettingName, resolver: SettingResolver<T>, defaultValue: T): T;\r\n  resolveSetting<T extends SettingType>(settingName: SettingName, resolver: SettingResolver<T>, defaultValue?: T): T | undefined;\r\n\r\n  /** Get the highest priority setting for a SettingName.\r\n   * @param settingName The name of the setting\r\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary.\r\n   * @note This method is generic on SettingType, but no type checking is actually performed at run time. So, if you\r\n   * use this method to get a setting with an expected type, but its value is a different type, the return type of this method will be wrong.\r\n   * You must always type check the result. Use the non-generic \"get\" methods (e.g. [[getString]]) if you only want the value\r\n   * if its type is correct.\r\n   */\r\n  getSetting<T extends SettingType>(settingName: SettingName, defaultValue?: T): T | undefined;\r\n\r\n  /** Get a string setting by SettingName.\r\n   * @param settingName The name of the setting\r\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a string.\r\n   */\r\n  getString(settingName: SettingName, defaultValue: string): string;\r\n  getString(settingName: SettingName, defaultValue?: string): string | undefined;\r\n\r\n  /** Get a boolean setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a boolean.\r\n  */\r\n  getBoolean(settingName: SettingName, defaultValue: boolean): boolean;\r\n  getBoolean(settingName: SettingName, defaultValue?: boolean): boolean | undefined;\r\n\r\n  /** Get a number setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a number.\r\n  */\r\n  getNumber(settingName: SettingName, defaultValue: number): number;\r\n  getNumber(settingName: SettingName): number | undefined;\r\n\r\n  /** Get an object setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not an object.\r\n  */\r\n  getObject<T extends object>(settingName: SettingName, defaultValue: T): T;\r\n  getObject<T extends object>(settingName: SettingName): T | undefined;\r\n\r\n  /** Get an array setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not an array.\r\n  */\r\n  getArray<T extends SettingType>(settingName: SettingName, defaultValue: Array<T>): Array<T>;\r\n  getArray<T extends SettingType>(settingName: SettingName): Array<T> | undefined;\r\n\r\n  /** Get an array of [[SettingInspector] objects, sorted in priority order, for all Settings that match a SettingName.\r\n   * @note this method is mainly for debugging and diagnostics.\r\n   */\r\n  inspectSetting<T extends SettingType>(name: SettingName): SettingInspector<T>[];\r\n}\r\n\r\n/** @internal */\r\nfunction deepClone<T extends SettingType>(obj: any): T {\r\n  if (!obj || typeof obj !== \"object\")\r\n    return obj;\r\n\r\n  const result = Array.isArray(obj) ? [] : {} as any;\r\n  Object.keys(obj).forEach((key: string) => {\r\n    const val = obj[key];\r\n    if (val && typeof val === \"object\") {\r\n      result[key] = deepClone(val);\r\n    } else {\r\n      result[key] = val;\r\n    }\r\n  });\r\n  return result;\r\n}\r\n\r\nclass SettingsDictionary {\r\n  public constructor(public readonly name: string, public readonly priority: SettingsPriority, public readonly settings: SettingDictionary) { }\r\n  public getSetting<T extends SettingType>(settingName: string): SettingType | undefined {\r\n    return this.settings[settingName] as T | undefined;\r\n  }\r\n}\r\n\r\n/**\r\n * Internal implementation of Settings interface.\r\n * @internal\r\n */\r\nexport class BaseSettings implements Settings {\r\n  private _dictionaries: SettingsDictionary[] = [];\r\n  protected verifyPriority(_priority: SettingsPriority) { }\r\n  public close() { }\r\n  public readonly onSettingsChanged = new BeEvent<() => void>();\r\n\r\n  public addFile(fileName: LocalFileName, priority: SettingsPriority) {\r\n    this.addJson(fileName, priority, fs.readFileSync(fileName, \"utf-8\"));\r\n  }\r\n\r\n  public addDirectory(dirName: LocalDirName, priority: SettingsPriority) {\r\n    for (const fileName of IModelJsFs.readdirSync(dirName)) {\r\n      const ext = extname(fileName);\r\n      if (ext === \".json5\" || ext === \".json\")\r\n        this.addFile(join(dirName, fileName), priority);\r\n    }\r\n  }\r\n\r\n  public addJson(dictionaryName: string, priority: SettingsPriority, settingsJson: string) {\r\n    this.addDictionary(dictionaryName, priority, parse(settingsJson));\r\n  }\r\n\r\n  public addDictionary(dictionaryName: string, priority: SettingsPriority, settings: SettingDictionary) {\r\n    this.verifyPriority(priority);\r\n    this.dropDictionary(dictionaryName, false); // make sure we don't have the same dictionary twice\r\n    const file = new SettingsDictionary(dictionaryName, priority, settings);\r\n    const doAdd = () => {\r\n      for (let i = 0; i < this._dictionaries.length; ++i) {\r\n        if (this._dictionaries[i].priority <= file.priority) {\r\n          this._dictionaries.splice(i, 0, file);\r\n          return;\r\n        }\r\n      }\r\n      this._dictionaries.push(file);\r\n    };\r\n    doAdd();\r\n    this.onSettingsChanged.raiseEvent();\r\n  }\r\n\r\n  public dropDictionary(dictionaryName: DictionaryName, raiseEvent = true) {\r\n    for (let i = 0; i < this._dictionaries.length; ++i) {\r\n      if (this._dictionaries[i].name === dictionaryName) {\r\n        this._dictionaries.splice(i, 1);\r\n        if (raiseEvent)\r\n          this.onSettingsChanged.raiseEvent();\r\n        return true;\r\n      }\r\n    }\r\n    return false;\r\n  }\r\n\r\n  public resolveSetting<T extends SettingType>(name: SettingName, resolver: SettingResolver<T>, defaultValue?: T): T | undefined {\r\n    for (const dict of this._dictionaries) {\r\n      const val = dict.getSetting(name) as T | undefined;\r\n      const resolved = val && resolver(val, dict.name, dict.priority);\r\n      if (undefined !== resolved)\r\n        return resolved;\r\n    }\r\n    return defaultValue;\r\n  }\r\n\r\n  public getSetting<T extends SettingType>(name: SettingName, defaultValue?: T): T | undefined {\r\n    return this.resolveSetting(name, (val) => deepClone<T>(val)) ?? defaultValue;\r\n  }\r\n\r\n  /** for debugging. Returns an array of all values for a setting, sorted by priority.\r\n   * @note values are not cloned. Do not modify objects or arrays.\r\n   */\r\n  public inspectSetting<T extends SettingType>(name: SettingName): SettingInspector<T>[] {\r\n    const all: SettingInspector<T>[] = [];\r\n    this.resolveSetting<T>(name, (value, dictionary, priority) => { all.push({ value, dictionary, priority }); return undefined; });\r\n    return all;\r\n  }\r\n\r\n  public getString(name: SettingName, defaultValue: string): string;\r\n  public getString(name: SettingName): string | undefined;\r\n  public getString(name: SettingName, defaultValue?: string): string | undefined {\r\n    const out = this.getSetting<string>(name);\r\n    return typeof out === \"string\" ? out : defaultValue;\r\n  }\r\n  public getBoolean(name: SettingName, defaultValue: boolean): boolean;\r\n  public getBoolean(name: SettingName): boolean | undefined;\r\n  public getBoolean(name: SettingName, defaultValue?: boolean): boolean | undefined {\r\n    const out = this.getSetting<boolean>(name);\r\n    return typeof out === \"boolean\" ? out : defaultValue;\r\n  }\r\n  public getNumber(name: SettingName, defaultValue: number): number;\r\n  public getNumber(name: SettingName): number | undefined;\r\n  public getNumber(name: SettingName, defaultValue?: number): number | undefined {\r\n    const out = this.getSetting<number>(name);\r\n    return typeof out === \"number\" ? out : defaultValue;\r\n  }\r\n  public getObject<T extends object>(name: SettingName, defaultValue: T): T;\r\n  public getObject<T extends object>(name: SettingName): T | undefined;\r\n  public getObject<T extends object>(name: SettingName, defaultValue?: T): T | undefined {\r\n    const out = this.getSetting<SettingObject>(name);\r\n    return typeof out === \"object\" ? out as T : defaultValue;\r\n  }\r\n  public getArray<T extends SettingType>(name: SettingName, defaultValue: Array<T>): Array<T>;\r\n  public getArray<T extends SettingType>(name: SettingName): Array<T> | undefined;\r\n  public getArray<T extends SettingType>(name: SettingName, defaultValue?: Array<T>): Array<T> | undefined {\r\n    const out = this.getSetting<Array<T>>(name);\r\n    return Array.isArray(out) ? out : defaultValue;\r\n  }\r\n}\r\n"]}

package/lib/cjs/workspace/SettingsSchemas.d.ts

@@ -1,76 +1,76 @@
-/** @packageDocumentation
- * @module Workspace
- */
-import { BeEvent, JSONSchema, JSONSchemaTypeName } from "@itwin/core-bentley";
-import { LocalDirName, LocalFileName } from "@itwin/core-common";
-/**
- * The properties of a single Setting, used by the settings editor. This interface also includes the
- * default value if it is not specified in any Settings file.
- * This interface includes all members of [JSONSchema]($bentley) with the extensions added by VSCode.
- * @note the `type` member is marked optional in JSONSchema but is required for Settings.
- * @beta
- */
-export interface SettingSchema extends Readonly<JSONSchema> {
-    readonly items?: SettingSchema;
-    readonly type: JSONSchemaTypeName;
-    readonly properties?: {
-        [name: string]: SettingSchema;
-    };
-    /** whether the setting replaces lower priority entries with the same name or combines with them. */
-    readonly cumulative?: true;
-}
-/**
- * The properties of a group of [[SettingSchema]]s for an application. Groups can be added and removed from [[SettingsSchemas]]
- * and are identified by their (required) `groupName` member
- * @beta
- */
-export interface SettingSchemaGroup {
-    readonly groupName: string;
-    readonly properties: {
-        [name: string]: SettingSchema;
-    };
-    readonly order?: number;
-    readonly title?: string;
-    readonly description?: string;
-    readonly extensionId?: string;
-}
-/**
- * The registry of available [[SettingSchemaGroup]]s.
- * The registry is used for editing Settings files and for finding default values for settings.
- * @beta
- */
-export declare class SettingsSchemas {
-    private constructor();
-    private static readonly _allGroups;
-    /** a map of all registered [[SettingSchema]]s */
-    static readonly allSchemas: Map<string, SettingSchema>;
-    /** event that signals that the values in [[allSchemas]] have changed in some way. */
-    static readonly onSchemaChanged: BeEvent<() => void>;
-    /** Clear the contents of the registry and remove all event listeners.
-     * @note This is really only necessary for tests of the Settings system.
-     * @internal
-     */
-    static reset(): void;
-    /** @internal */
-    static validateArrayObject<T>(val: T, schemaName: string, msg: string): T;
-    /**
-     * Add one or more [[SettingSchemaGroup]]s. `SettingSchemaGroup`s must include a `groupName` member that is used
-     * to identify the group. If a group with the same name is already registered, the old values are first removed and then the new group is added.
-     */
-    static addGroup(settingsGroup: SettingSchemaGroup | SettingSchemaGroup[]): void;
-    /** Add a [[SettingSchemaGroup]] from stringified json5. */
-    static addJson(settingSchema: string): void;
-    /** Add a [[SettingSchemaGroup]] from a json5 file. */
-    static addFile(fileName: LocalFileName): void;
-    /** Add all files with a either ".json" or ".json5" extension from a supplied directory. */
-    static addDirectory(dirName: LocalDirName): void;
-    /** Remove a previously added [[SettingSchemaGroup]] by groupName */
-    static removeGroup(groupName: string): void;
-    private static doAdd;
-    private static doRemove;
-    private static validateName;
-    private static validateProperty;
-    private static validateAndAdd;
-    private static getDefaultValue;
-}
+/** @packageDocumentation
+ * @module Workspace
+ */
+import { BeEvent, JSONSchema, JSONSchemaTypeName } from "@itwin/core-bentley";
+import { LocalDirName, LocalFileName } from "@itwin/core-common";
+/**
+ * The properties of a single Setting, used by the settings editor. This interface also includes the
+ * default value if it is not specified in any Settings file.
+ * This interface includes all members of [JSONSchema]($bentley) with the extensions added by VSCode.
+ * @note the `type` member is marked optional in JSONSchema but is required for Settings.
+ * @beta
+ */
+export interface SettingSchema extends Readonly<JSONSchema> {
+    readonly items?: SettingSchema;
+    readonly type: JSONSchemaTypeName;
+    readonly properties?: {
+        [name: string]: SettingSchema;
+    };
+    /** whether the setting replaces lower priority entries with the same name or combines with them. */
+    readonly cumulative?: true;
+}
+/**
+ * The properties of a group of [[SettingSchema]]s for an application. Groups can be added and removed from [[SettingsSchemas]]
+ * and are identified by their (required) `groupName` member
+ * @beta
+ */
+export interface SettingSchemaGroup {
+    readonly groupName: string;
+    readonly properties: {
+        [name: string]: SettingSchema;
+    };
+    readonly order?: number;
+    readonly title?: string;
+    readonly description?: string;
+    readonly extensionId?: string;
+}
+/**
+ * The registry of available [[SettingSchemaGroup]]s.
+ * The registry is used for editing Settings files and for finding default values for settings.
+ * @beta
+ */
+export declare class SettingsSchemas {
+    private constructor();
+    private static readonly _allGroups;
+    /** a map of all registered [[SettingSchema]]s */
+    static readonly allSchemas: Map<string, SettingSchema>;
+    /** event that signals that the values in [[allSchemas]] have changed in some way. */
+    static readonly onSchemaChanged: BeEvent<() => void>;
+    /** Clear the contents of the registry and remove all event listeners.
+     * @note This is really only necessary for tests of the Settings system.
+     * @internal
+     */
+    static reset(): void;
+    /** @internal */
+    static validateArrayObject<T>(val: T, schemaName: string, msg: string): T;
+    /**
+     * Add one or more [[SettingSchemaGroup]]s. `SettingSchemaGroup`s must include a `groupName` member that is used
+     * to identify the group. If a group with the same name is already registered, the old values are first removed and then the new group is added.
+     */
+    static addGroup(settingsGroup: SettingSchemaGroup | SettingSchemaGroup[]): void;
+    /** Add a [[SettingSchemaGroup]] from stringified json5. */
+    static addJson(settingSchema: string): void;
+    /** Add a [[SettingSchemaGroup]] from a json5 file. */
+    static addFile(fileName: LocalFileName): void;
+    /** Add all files with a either ".json" or ".json5" extension from a supplied directory. */
+    static addDirectory(dirName: LocalDirName): void;
+    /** Remove a previously added [[SettingSchemaGroup]] by groupName */
+    static removeGroup(groupName: string): void;
+    private static doAdd;
+    private static doRemove;
+    private static validateName;
+    private static validateProperty;
+    private static validateAndAdd;
+    private static getDefaultValue;
+}
 //# sourceMappingURL=SettingsSchemas.d.ts.map