@itwin/core-backend 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/cjs/workspace/Settings.js

@@ -1,155 +1,155 @@
-"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) {
-        return this.resolveSetting(name, (val) => deepClone(val)) ?? 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) {
+        return this.resolveSetting(name, (val) => deepClone(val)) ?? 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/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