@itwin/core-backend 3.4.0 → 3.4.1

package/lib/cjs/workspace/SettingsSchemas.js

@@ -1,192 +1,192 @@
-"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.SettingsSchemas = 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");
-/**
- * The registry of available [[SettingSchemaGroup]]s.
- * The registry is used for editing Settings files and for finding default values for settings.
- * @beta
- */
-class SettingsSchemas {
-    constructor() { } // singleton
-    /** 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() {
-        this._allGroups.clear();
-        this.allSchemas.clear();
-        this.onSchemaChanged.clear();
-    }
-    /** @internal */
-    static validateArrayObject(val, schemaName, msg) {
-        const schema = this.allSchemas.get(schemaName);
-        const items = schema === null || schema === void 0 ? void 0 : schema.items;
-        if (undefined === items)
-            return val;
-        const required = items.required;
-        const properties = items.properties;
-        if (undefined === required || undefined === properties)
-            return val;
-        for (const entry of required) {
-            const entryType = properties[entry].type;
-            const value = val[entry];
-            if (entryType === "array" && Array.isArray(value))
-                continue;
-            if (typeof value !== entryType)
-                throw new Error(`invalid "${schemaName}" setting entry for "${msg}": ${entry} is ${value}`);
-        }
-        return val;
-    }
-    /**
-     * 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) {
-        if (!Array.isArray(settingsGroup))
-            settingsGroup = [settingsGroup];
-        this.doAdd(settingsGroup);
-        this.onSchemaChanged.raiseEvent();
-    }
-    /** Add a [[SettingSchemaGroup]] from stringified json5. */
-    static addJson(settingSchema) {
-        this.addGroup((0, json5_1.parse)(settingSchema));
-    }
-    /** Add a [[SettingSchemaGroup]] from a json5 file. */
-    static addFile(fileName) {
-        try {
-            this.addJson(fs.readFileSync(fileName, "utf-8"));
-        }
-        catch (e) {
-            throw new Error(`parsing SettingSchema file "${fileName}": ${e.message}"`);
-        }
-    }
-    /** Add all files with a either ".json" or ".json5" extension from a supplied directory. */
-    static addDirectory(dirName) {
-        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));
-        }
-    }
-    /** Remove a previously added [[SettingSchemaGroup]] by groupName */
-    static removeGroup(groupName) {
-        this.doRemove(groupName);
-        this.onSchemaChanged.raiseEvent();
-    }
-    static doAdd(settingsGroup) {
-        settingsGroup.forEach((group) => {
-            if (undefined === group.groupName)
-                throw new Error(`settings group has no "groupName" member`);
-            this.doRemove(group.groupName);
-            this.validateAndAdd(group);
-            this._allGroups.set(group.groupName, group);
-        });
-    }
-    static doRemove(groupName) {
-        const group = this._allGroups.get(groupName);
-        if (undefined !== (group === null || group === void 0 ? void 0 : group.properties)) {
-            for (const key of Object.keys(group.properties))
-                this.allSchemas.delete(key);
-        }
-        this._allGroups.delete(groupName);
-    }
-    static validateName(name) {
-        if (!name.trim())
-            throw new Error(`empty property name`);
-        if (this.allSchemas.has(name))
-            throw new Error(`property "${name}" is already defined`);
-    }
-    static validateProperty(name, property) {
-        if (!property)
-            throw new Error(`missing required property ${name}`);
-        if (!property.type)
-            throw new Error(`property ${name} has no type`);
-        switch (property.type) {
-            case "boolean":
-            case "integer":
-            case "null":
-            case "number":
-            case "string":
-                return;
-            case "object":
-                const required = property.required;
-                const props = property.properties;
-                if (required && props) {
-                    for (const entry of required)
-                        this.validateProperty(entry, props[entry]);
-                }
-                if (props) {
-                    for (const key of Object.keys(props))
-                        try {
-                            this.validateProperty(key, props[key]);
-                        }
-                        catch (e) {
-                            throw new Error(`property ${key} of ${name}: ${e.message}`);
-                        }
-                }
-                return;
-            case "array":
-                if (typeof property.items !== "object")
-                    throw new Error(`array property ${name} has no items member`);
-                try {
-                    this.validateProperty("items", property.items);
-                }
-                catch (e) {
-                    throw new Error(`array property ${name}: ${e.message}`);
-                }
-                return;
-            default:
-                throw new Error(`property ${name} has illegal type "${property.type}"`);
-        }
-    }
-    static validateAndAdd(group) {
-        var _a;
-        const properties = group.properties;
-        if (undefined === properties)
-            throw new Error(`group ${group.groupName} has no properties`);
-        for (const key of Object.keys(properties)) {
-            this.validateName(key);
-            this.validateProperty(key, properties[key]);
-            const property = properties[key];
-            property.default = (_a = property.default) !== null && _a !== void 0 ? _a : this.getDefaultValue(property.type);
-            this.allSchemas.set(key, property);
-        }
-    }
-    static getDefaultValue(type) {
-        type = Array.isArray(type) ? type[0] : type;
-        switch (type) {
-            case "boolean":
-                return false;
-            case "integer":
-            case "number":
-                return 0;
-            case "string":
-                return "";
-            case "array":
-                return [];
-            case "object":
-                return {};
-            default:
-                return undefined;
-        }
-    }
-}
-exports.SettingsSchemas = SettingsSchemas;
-SettingsSchemas._allGroups = new Map();
-/** a map of all registered [[SettingSchema]]s */
-SettingsSchemas.allSchemas = new Map();
-/** event that signals that the values in [[allSchemas]] have changed in some way. */
-SettingsSchemas.onSchemaChanged = new core_bentley_1.BeEvent();
+"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.SettingsSchemas = 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");
+/**
+ * The registry of available [[SettingSchemaGroup]]s.
+ * The registry is used for editing Settings files and for finding default values for settings.
+ * @beta
+ */
+class SettingsSchemas {
+    constructor() { } // singleton
+    /** 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() {
+        this._allGroups.clear();
+        this.allSchemas.clear();
+        this.onSchemaChanged.clear();
+    }
+    /** @internal */
+    static validateArrayObject(val, schemaName, msg) {
+        const schema = this.allSchemas.get(schemaName);
+        const items = schema === null || schema === void 0 ? void 0 : schema.items;
+        if (undefined === items)
+            return val;
+        const required = items.required;
+        const properties = items.properties;
+        if (undefined === required || undefined === properties)
+            return val;
+        for (const entry of required) {
+            const entryType = properties[entry].type;
+            const value = val[entry];
+            if (entryType === "array" && Array.isArray(value))
+                continue;
+            if (typeof value !== entryType)
+                throw new Error(`invalid "${schemaName}" setting entry for "${msg}": ${entry} is ${value}`);
+        }
+        return val;
+    }
+    /**
+     * 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) {
+        if (!Array.isArray(settingsGroup))
+            settingsGroup = [settingsGroup];
+        this.doAdd(settingsGroup);
+        this.onSchemaChanged.raiseEvent();
+    }
+    /** Add a [[SettingSchemaGroup]] from stringified json5. */
+    static addJson(settingSchema) {
+        this.addGroup((0, json5_1.parse)(settingSchema));
+    }
+    /** Add a [[SettingSchemaGroup]] from a json5 file. */
+    static addFile(fileName) {
+        try {
+            this.addJson(fs.readFileSync(fileName, "utf-8"));
+        }
+        catch (e) {
+            throw new Error(`parsing SettingSchema file "${fileName}": ${e.message}"`);
+        }
+    }
+    /** Add all files with a either ".json" or ".json5" extension from a supplied directory. */
+    static addDirectory(dirName) {
+        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));
+        }
+    }
+    /** Remove a previously added [[SettingSchemaGroup]] by groupName */
+    static removeGroup(groupName) {
+        this.doRemove(groupName);
+        this.onSchemaChanged.raiseEvent();
+    }
+    static doAdd(settingsGroup) {
+        settingsGroup.forEach((group) => {
+            if (undefined === group.groupName)
+                throw new Error(`settings group has no "groupName" member`);
+            this.doRemove(group.groupName);
+            this.validateAndAdd(group);
+            this._allGroups.set(group.groupName, group);
+        });
+    }
+    static doRemove(groupName) {
+        const group = this._allGroups.get(groupName);
+        if (undefined !== (group === null || group === void 0 ? void 0 : group.properties)) {
+            for (const key of Object.keys(group.properties))
+                this.allSchemas.delete(key);
+        }
+        this._allGroups.delete(groupName);
+    }
+    static validateName(name) {
+        if (!name.trim())
+            throw new Error(`empty property name`);
+        if (this.allSchemas.has(name))
+            throw new Error(`property "${name}" is already defined`);
+    }
+    static validateProperty(name, property) {
+        if (!property)
+            throw new Error(`missing required property ${name}`);
+        if (!property.type)
+            throw new Error(`property ${name} has no type`);
+        switch (property.type) {
+            case "boolean":
+            case "integer":
+            case "null":
+            case "number":
+            case "string":
+                return;
+            case "object":
+                const required = property.required;
+                const props = property.properties;
+                if (required && props) {
+                    for (const entry of required)
+                        this.validateProperty(entry, props[entry]);
+                }
+                if (props) {
+                    for (const key of Object.keys(props))
+                        try {
+                            this.validateProperty(key, props[key]);
+                        }
+                        catch (e) {
+                            throw new Error(`property ${key} of ${name}: ${e.message}`);
+                        }
+                }
+                return;
+            case "array":
+                if (typeof property.items !== "object")
+                    throw new Error(`array property ${name} has no items member`);
+                try {
+                    this.validateProperty("items", property.items);
+                }
+                catch (e) {
+                    throw new Error(`array property ${name}: ${e.message}`);
+                }
+                return;
+            default:
+                throw new Error(`property ${name} has illegal type "${property.type}"`);
+        }
+    }
+    static validateAndAdd(group) {
+        var _a;
+        const properties = group.properties;
+        if (undefined === properties)
+            throw new Error(`group ${group.groupName} has no properties`);
+        for (const key of Object.keys(properties)) {
+            this.validateName(key);
+            this.validateProperty(key, properties[key]);
+            const property = properties[key];
+            property.default = (_a = property.default) !== null && _a !== void 0 ? _a : this.getDefaultValue(property.type);
+            this.allSchemas.set(key, property);
+        }
+    }
+    static getDefaultValue(type) {
+        type = Array.isArray(type) ? type[0] : type;
+        switch (type) {
+            case "boolean":
+                return false;
+            case "integer":
+            case "number":
+                return 0;
+            case "string":
+                return "";
+            case "array":
+                return [];
+            case "object":
+                return {};
+            default:
+                return undefined;
+        }
+    }
+}
+exports.SettingsSchemas = SettingsSchemas;
+SettingsSchemas._allGroups = new Map();
+/** a map of all registered [[SettingSchema]]s */
+SettingsSchemas.allSchemas = new Map();
+/** event that signals that the values in [[allSchemas]] have changed in some way. */
+SettingsSchemas.onSchemaChanged = new core_bentley_1.BeEvent();
 //# sourceMappingURL=SettingsSchemas.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"SettingsSchemas.js","sourceRoot":"","sources":["../../../src/workspace/SettingsSchemas.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,iCAA8B;AAC9B,+BAAqC;AACrC,sDAAuG;AAEvG,8CAA2C;AAgC3C;;;;GAIG;AACH,MAAa,eAAe;IAC1B,gBAAwB,CAAC,CAAC,YAAY;IAOtC;;;OAGG;IACI,MAAM,CAAC,KAAK;QACjB,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACxB,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACxB,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,mBAAmB,CAAI,GAAM,EAAE,UAAkB,EAAE,GAAW;QAC1E,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,CAAC;QAC5B,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO,GAAG,CAAC;QACb,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,UAAU;YACpD,OAAO,GAAG,CAAC;QAEb,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE;YAC5B,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;YACzC,MAAM,KAAK,GAAI,GAAW,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,SAAS,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC/C,SAAS;YACX,IAAI,OAAO,KAAK,KAAK,SAAS;gBAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,UAAU,wBAAwB,GAAG,MAAM,KAAK,OAAO,KAAK,EAAE,CAAC,CAAC;SAC/F;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAwD;QAC7E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;YAC/B,aAAa,GAAG,CAAC,aAAa,CAAC,CAAC;QAElC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC1B,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACpC,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,OAAO,CAAC,aAAqB;QACzC,IAAI,CAAC,QAAQ,CAAC,IAAA,aAAK,EAAC,aAAa,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,OAAO,CAAC,QAAuB;QAC3C,IAAI;YACF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;SAClD;QAAC,OAAO,CAAM,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,MAAM,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;SAC5E;IACH,CAAC;IAED,2FAA2F;IACpF,MAAM,CAAC,YAAY,CAAC,OAAqB;QAC9C,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,CAAC,CAAC;SACzC;IACH,CAAC;IAED,oEAAoE;IAC7D,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACzB,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,aAAmC;QACtD,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS;gBAC/B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;YAE9D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAC/B,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,SAAiB;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,SAAS,MAAK,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,CAAA,EAAE;YACnC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBAC7C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC/B;QACD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,IAAY;QACtC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,sBAAsB,CAAC,CAAC;IAC7D,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,IAAY,EAAE,QAAmC;QAC/E,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC;QAEvD,IAAI,CAAC,QAAQ,CAAC,IAAI;YAChB,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,cAAc,CAAC,CAAC;QAElD,QAAQ,QAAQ,CAAC,IAAI,EAAE;YACrB,KAAK,SAAS,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC;YACZ,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ;gBACX,OAAO;YAET,KAAK,QAAQ;gBACX,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;gBACnC,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC;gBAClC,IAAI,QAAQ,IAAI,KAAK,EAAE;oBACrB,KAAK,MAAM,KAAK,IAAI,QAAQ;wBAC1B,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;iBAC9C;gBACD,IAAI,KAAK,EAAE;oBACT,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;wBAClC,IAAI;4BACF,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;yBACxC;wBAAC,OAAO,CAAM,EAAE;4BACf,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,OAAO,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;yBAC7D;iBACJ;gBACD,OAAO;YAET,KAAK,OAAO;gBACV,IAAI,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ;oBACpC,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,sBAAsB,CAAC,CAAC;gBAChE,IAAI;oBACF,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;iBAChD;gBAAC,OAAO,CAAM,EAAE;oBACf,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;iBACzD;gBACD,OAAO;YAET;gBACE,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,sBAAsB,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;SAC3E;IACH,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,KAAyB;;QACrD,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,KAAK,CAAC,SAAS,KAAK,CAAC,SAAS,oBAAoB,CAAC,CAAC;QAEhE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACzC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5C,MAAM,QAAQ,GAA2B,UAAU,CAAC,GAAG,CAAC,CAAC;YACzD,QAAQ,CAAC,OAAO,GAAG,MAAA,QAAQ,CAAC,OAAO,mCAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3E,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;SACpC;IACH,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,IAA+C;QAC5E,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5C,QAAQ,IAAI,EAAE;YACZ,KAAK,SAAS;gBACZ,OAAO,KAAK,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ;gBACX,OAAO,CAAC,CAAC;YACX,KAAK,QAAQ;gBACX,OAAO,EAAE,CAAC;YACZ,KAAK,OAAO;gBACV,OAAO,EAAE,CAAC;YACZ,KAAK,QAAQ;gBACX,OAAO,EAAE,CAAC;YACZ;gBACE,OAAO,SAAS,CAAC;SACpB;IACH,CAAC;;AA1LH,0CA2LC;AAzLyB,0BAAU,GAAG,IAAI,GAAG,EAA8B,CAAC;AAC3E,iDAAiD;AAC1B,0BAAU,GAAG,IAAI,GAAG,EAAyB,CAAC;AACrE,qFAAqF;AAC9D,+BAAe,GAAG,IAAI,sBAAO,EAAc,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 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, JSONSchema, JSONSchemaType, JSONSchemaTypeName, Mutable } from \"@itwin/core-bentley\";\r\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { IModelJsFs } from \"../IModelJsFs\";\r\n\r\n/**\r\n * The properties of a single Setting, used by the settings editor. This interface also includes the\r\n * default value if it is not specified in any Settings file.\r\n * This interface includes all members of [JSONSchema]($bentley) with the extensions added by VSCode.\r\n * @note the `type` member is marked optional in JSONSchema but is required for Settings.\r\n * @beta\r\n */\r\nexport interface SettingSchema extends Readonly<JSONSchema> {\r\n  readonly items?: SettingSchema; // must be single object, not array\r\n  readonly type: JSONSchemaTypeName; // type is required for settings\r\n  readonly properties?: { [name: string]: SettingSchema };\r\n\r\n  /** whether the setting replaces lower priority entries with the same name or combines with them. */\r\n  readonly cumulative?: true;\r\n}\r\n\r\n/**\r\n * The properties of a group of [[SettingSchema]]s for an application. Groups can be added and removed from [[SettingsSchemas]]\r\n * and are identified by their (required) `groupName` member\r\n * @beta\r\n */\r\nexport interface SettingSchemaGroup {\r\n  readonly groupName: string;\r\n  readonly properties: { [name: string]: SettingSchema };\r\n  readonly order?: number;\r\n  readonly title?: string;\r\n  readonly description?: string;\r\n  readonly extensionId?: string;\r\n}\r\n\r\n/**\r\n * The registry of available [[SettingSchemaGroup]]s.\r\n * The registry is used for editing Settings files and for finding default values for settings.\r\n * @beta\r\n */\r\nexport class SettingsSchemas {\r\n  private constructor() { } // singleton\r\n  private static readonly _allGroups = new Map<string, SettingSchemaGroup>();\r\n  /** a map of all registered [[SettingSchema]]s */\r\n  public static readonly allSchemas = new Map<string, SettingSchema>();\r\n  /** event that signals that the values in [[allSchemas]] have changed in some way. */\r\n  public static readonly onSchemaChanged = new BeEvent<() => void>();\r\n\r\n  /** Clear the contents of the registry and remove all event listeners.\r\n   * @note This is really only necessary for tests of the Settings system.\r\n   * @internal\r\n   */\r\n  public static reset() {\r\n    this._allGroups.clear();\r\n    this.allSchemas.clear();\r\n    this.onSchemaChanged.clear();\r\n  }\r\n\r\n  /** @internal */\r\n  public static validateArrayObject<T>(val: T, schemaName: string, msg: string): T {\r\n    const schema = this.allSchemas.get(schemaName);\r\n    const items = schema?.items;\r\n    if (undefined === items)\r\n      return val;\r\n    const required = items.required;\r\n    const properties = items.properties;\r\n    if (undefined === required || undefined === properties)\r\n      return val;\r\n\r\n    for (const entry of required) {\r\n      const entryType = properties[entry].type;\r\n      const value = (val as any)[entry];\r\n      if (entryType === \"array\" && Array.isArray(value))\r\n        continue;\r\n      if (typeof value !== entryType)\r\n        throw new Error(`invalid \"${schemaName}\" setting entry for \"${msg}\": ${entry} is ${value}`);\r\n    }\r\n    return val;\r\n  }\r\n\r\n  /**\r\n   * Add one or more [[SettingSchemaGroup]]s. `SettingSchemaGroup`s must include a `groupName` member that is used\r\n   * 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.\r\n   */\r\n  public static addGroup(settingsGroup: SettingSchemaGroup | SettingSchemaGroup[]): void {\r\n    if (!Array.isArray(settingsGroup))\r\n      settingsGroup = [settingsGroup];\r\n\r\n    this.doAdd(settingsGroup);\r\n    this.onSchemaChanged.raiseEvent();\r\n  }\r\n\r\n  /** Add a [[SettingSchemaGroup]] from stringified json5. */\r\n  public static addJson(settingSchema: string): void {\r\n    this.addGroup(parse(settingSchema));\r\n  }\r\n\r\n  /** Add a [[SettingSchemaGroup]] from a json5 file. */\r\n  public static addFile(fileName: LocalFileName): void {\r\n    try {\r\n      this.addJson(fs.readFileSync(fileName, \"utf-8\"));\r\n    } catch (e: any) {\r\n      throw new Error(`parsing SettingSchema file \"${fileName}\": ${e.message}\"`);\r\n    }\r\n  }\r\n\r\n  /** Add all files with a either \".json\" or \".json5\" extension from a supplied directory. */\r\n  public static addDirectory(dirName: LocalDirName) {\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));\r\n    }\r\n  }\r\n\r\n  /** Remove a previously added [[SettingSchemaGroup]] by groupName */\r\n  public static removeGroup(groupName: string): void {\r\n    this.doRemove(groupName);\r\n    this.onSchemaChanged.raiseEvent();\r\n  }\r\n\r\n  private static doAdd(settingsGroup: SettingSchemaGroup[]) {\r\n    settingsGroup.forEach((group) => {\r\n      if (undefined === group.groupName)\r\n        throw new Error(`settings group has no \"groupName\" member`);\r\n\r\n      this.doRemove(group.groupName);\r\n      this.validateAndAdd(group);\r\n      this._allGroups.set(group.groupName, group);\r\n    });\r\n  }\r\n\r\n  private static doRemove(groupName: string) {\r\n    const group = this._allGroups.get(groupName);\r\n    if (undefined !== group?.properties) {\r\n      for (const key of Object.keys(group.properties))\r\n        this.allSchemas.delete(key);\r\n    }\r\n    this._allGroups.delete(groupName);\r\n  }\r\n\r\n  private static validateName(name: string) {\r\n    if (!name.trim())\r\n      throw new Error(`empty property name`);\r\n    if (this.allSchemas.has(name))\r\n      throw new Error(`property \"${name}\" is already defined`);\r\n  }\r\n\r\n  private static validateProperty(name: string, property: SettingSchema | undefined) {\r\n    if (!property)\r\n      throw new Error(`missing required property ${name}`);\r\n\r\n    if (!property.type)\r\n      throw new Error(`property ${name} has no type`);\r\n\r\n    switch (property.type) {\r\n      case \"boolean\":\r\n      case \"integer\":\r\n      case \"null\":\r\n      case \"number\":\r\n      case \"string\":\r\n        return;\r\n\r\n      case \"object\":\r\n        const required = property.required;\r\n        const props = property.properties;\r\n        if (required && props) {\r\n          for (const entry of required)\r\n            this.validateProperty(entry, props[entry]);\r\n        }\r\n        if (props) {\r\n          for (const key of Object.keys(props))\r\n            try {\r\n              this.validateProperty(key, props[key]);\r\n            } catch (e: any) {\r\n              throw new Error(`property ${key} of ${name}: ${e.message}`);\r\n            }\r\n        }\r\n        return;\r\n\r\n      case \"array\":\r\n        if (typeof property.items !== \"object\")\r\n          throw new Error(`array property ${name} has no items member`);\r\n        try {\r\n          this.validateProperty(\"items\", property.items);\r\n        } catch (e: any) {\r\n          throw new Error(`array property ${name}: ${e.message}`);\r\n        }\r\n        return;\r\n\r\n      default:\r\n        throw new Error(`property ${name} has illegal type \"${property.type}\"`);\r\n    }\r\n  }\r\n\r\n  private static validateAndAdd(group: SettingSchemaGroup) {\r\n    const properties = group.properties;\r\n    if (undefined === properties)\r\n      throw new Error(`group ${group.groupName} has no properties`);\r\n\r\n    for (const key of Object.keys(properties)) {\r\n      this.validateName(key);\r\n      this.validateProperty(key, properties[key]);\r\n      const property: Mutable<SettingSchema> = properties[key];\r\n      property.default = property.default ?? this.getDefaultValue(property.type);\r\n      this.allSchemas.set(key, property);\r\n    }\r\n  }\r\n\r\n  private static getDefaultValue(type: JSONSchemaTypeName | JSONSchemaTypeName[]): JSONSchemaType | undefined {\r\n    type = Array.isArray(type) ? type[0] : type;\r\n    switch (type) {\r\n      case \"boolean\":\r\n        return false;\r\n      case \"integer\":\r\n      case \"number\":\r\n        return 0;\r\n      case \"string\":\r\n        return \"\";\r\n      case \"array\":\r\n        return [];\r\n      case \"object\":\r\n        return {};\r\n      default:\r\n        return undefined;\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SettingsSchemas.js","sourceRoot":"","sources":["../../../src/workspace/SettingsSchemas.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,iCAA8B;AAC9B,+BAAqC;AACrC,sDAAuG;AAEvG,8CAA2C;AAgC3C;;;;GAIG;AACH,MAAa,eAAe;IAC1B,gBAAwB,CAAC,CAAC,YAAY;IAOtC;;;OAGG;IACI,MAAM,CAAC,KAAK;QACjB,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACxB,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACxB,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,mBAAmB,CAAI,GAAM,EAAE,UAAkB,EAAE,GAAW;QAC1E,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,CAAC;QAC5B,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO,GAAG,CAAC;QACb,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,UAAU;YACpD,OAAO,GAAG,CAAC;QAEb,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE;YAC5B,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;YACzC,MAAM,KAAK,GAAI,GAAW,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,SAAS,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC/C,SAAS;YACX,IAAI,OAAO,KAAK,KAAK,SAAS;gBAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,UAAU,wBAAwB,GAAG,MAAM,KAAK,OAAO,KAAK,EAAE,CAAC,CAAC;SAC/F;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAwD;QAC7E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;YAC/B,aAAa,GAAG,CAAC,aAAa,CAAC,CAAC;QAElC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC1B,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACpC,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,OAAO,CAAC,aAAqB;QACzC,IAAI,CAAC,QAAQ,CAAC,IAAA,aAAK,EAAC,aAAa,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,OAAO,CAAC,QAAuB;QAC3C,IAAI;YACF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;SAClD;QAAC,OAAO,CAAM,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,MAAM,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;SAC5E;IACH,CAAC;IAED,2FAA2F;IACpF,MAAM,CAAC,YAAY,CAAC,OAAqB;QAC9C,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,CAAC,CAAC;SACzC;IACH,CAAC;IAED,oEAAoE;IAC7D,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACzB,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,aAAmC;QACtD,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS;gBAC/B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;YAE9D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAC/B,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,SAAiB;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,SAAS,MAAK,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,CAAA,EAAE;YACnC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBAC7C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC/B;QACD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,IAAY;QACtC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,sBAAsB,CAAC,CAAC;IAC7D,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,IAAY,EAAE,QAAmC;QAC/E,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC;QAEvD,IAAI,CAAC,QAAQ,CAAC,IAAI;YAChB,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,cAAc,CAAC,CAAC;QAElD,QAAQ,QAAQ,CAAC,IAAI,EAAE;YACrB,KAAK,SAAS,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC;YACZ,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ;gBACX,OAAO;YAET,KAAK,QAAQ;gBACX,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;gBACnC,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC;gBAClC,IAAI,QAAQ,IAAI,KAAK,EAAE;oBACrB,KAAK,MAAM,KAAK,IAAI,QAAQ;wBAC1B,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;iBAC9C;gBACD,IAAI,KAAK,EAAE;oBACT,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;wBAClC,IAAI;4BACF,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;yBACxC;wBAAC,OAAO,CAAM,EAAE;4BACf,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,OAAO,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;yBAC7D;iBACJ;gBACD,OAAO;YAET,KAAK,OAAO;gBACV,IAAI,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ;oBACpC,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,sBAAsB,CAAC,CAAC;gBAChE,IAAI;oBACF,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;iBAChD;gBAAC,OAAO,CAAM,EAAE;oBACf,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;iBACzD;gBACD,OAAO;YAET;gBACE,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,sBAAsB,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;SAC3E;IACH,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,KAAyB;;QACrD,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,KAAK,CAAC,SAAS,KAAK,CAAC,SAAS,oBAAoB,CAAC,CAAC;QAEhE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACzC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5C,MAAM,QAAQ,GAA2B,UAAU,CAAC,GAAG,CAAC,CAAC;YACzD,QAAQ,CAAC,OAAO,GAAG,MAAA,QAAQ,CAAC,OAAO,mCAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3E,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;SACpC;IACH,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,IAA+C;QAC5E,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5C,QAAQ,IAAI,EAAE;YACZ,KAAK,SAAS;gBACZ,OAAO,KAAK,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ;gBACX,OAAO,CAAC,CAAC;YACX,KAAK,QAAQ;gBACX,OAAO,EAAE,CAAC;YACZ,KAAK,OAAO;gBACV,OAAO,EAAE,CAAC;YACZ,KAAK,QAAQ;gBACX,OAAO,EAAE,CAAC;YACZ;gBACE,OAAO,SAAS,CAAC;SACpB;IACH,CAAC;;AA1LH,0CA2LC;AAzLyB,0BAAU,GAAG,IAAI,GAAG,EAA8B,CAAC;AAC3E,iDAAiD;AAC1B,0BAAU,GAAG,IAAI,GAAG,EAAyB,CAAC;AACrE,qFAAqF;AAC9D,+BAAe,GAAG,IAAI,sBAAO,EAAc,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 Workspace\n */\n\nimport * as fs from \"fs-extra\";\nimport { parse } from \"json5\";\nimport { extname, join } from \"path\";\nimport { BeEvent, JSONSchema, JSONSchemaType, JSONSchemaTypeName, Mutable } from \"@itwin/core-bentley\";\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\nimport { IModelJsFs } from \"../IModelJsFs\";\n\n/**\n * The properties of a single Setting, used by the settings editor. This interface also includes the\n * default value if it is not specified in any Settings file.\n * This interface includes all members of [JSONSchema]($bentley) with the extensions added by VSCode.\n * @note the `type` member is marked optional in JSONSchema but is required for Settings.\n * @beta\n */\nexport interface SettingSchema extends Readonly<JSONSchema> {\n  readonly items?: SettingSchema; // must be single object, not array\n  readonly type: JSONSchemaTypeName; // type is required for settings\n  readonly properties?: { [name: string]: SettingSchema };\n\n  /** whether the setting replaces lower priority entries with the same name or combines with them. */\n  readonly cumulative?: true;\n}\n\n/**\n * The properties of a group of [[SettingSchema]]s for an application. Groups can be added and removed from [[SettingsSchemas]]\n * and are identified by their (required) `groupName` member\n * @beta\n */\nexport interface SettingSchemaGroup {\n  readonly groupName: string;\n  readonly properties: { [name: string]: SettingSchema };\n  readonly order?: number;\n  readonly title?: string;\n  readonly description?: string;\n  readonly extensionId?: string;\n}\n\n/**\n * The registry of available [[SettingSchemaGroup]]s.\n * The registry is used for editing Settings files and for finding default values for settings.\n * @beta\n */\nexport class SettingsSchemas {\n  private constructor() { } // singleton\n  private static readonly _allGroups = new Map<string, SettingSchemaGroup>();\n  /** a map of all registered [[SettingSchema]]s */\n  public static readonly allSchemas = new Map<string, SettingSchema>();\n  /** event that signals that the values in [[allSchemas]] have changed in some way. */\n  public static readonly onSchemaChanged = new BeEvent<() => void>();\n\n  /** Clear the contents of the registry and remove all event listeners.\n   * @note This is really only necessary for tests of the Settings system.\n   * @internal\n   */\n  public static reset() {\n    this._allGroups.clear();\n    this.allSchemas.clear();\n    this.onSchemaChanged.clear();\n  }\n\n  /** @internal */\n  public static validateArrayObject<T>(val: T, schemaName: string, msg: string): T {\n    const schema = this.allSchemas.get(schemaName);\n    const items = schema?.items;\n    if (undefined === items)\n      return val;\n    const required = items.required;\n    const properties = items.properties;\n    if (undefined === required || undefined === properties)\n      return val;\n\n    for (const entry of required) {\n      const entryType = properties[entry].type;\n      const value = (val as any)[entry];\n      if (entryType === \"array\" && Array.isArray(value))\n        continue;\n      if (typeof value !== entryType)\n        throw new Error(`invalid \"${schemaName}\" setting entry for \"${msg}\": ${entry} is ${value}`);\n    }\n    return val;\n  }\n\n  /**\n   * Add one or more [[SettingSchemaGroup]]s. `SettingSchemaGroup`s must include a `groupName` member that is used\n   * 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.\n   */\n  public static addGroup(settingsGroup: SettingSchemaGroup | SettingSchemaGroup[]): void {\n    if (!Array.isArray(settingsGroup))\n      settingsGroup = [settingsGroup];\n\n    this.doAdd(settingsGroup);\n    this.onSchemaChanged.raiseEvent();\n  }\n\n  /** Add a [[SettingSchemaGroup]] from stringified json5. */\n  public static addJson(settingSchema: string): void {\n    this.addGroup(parse(settingSchema));\n  }\n\n  /** Add a [[SettingSchemaGroup]] from a json5 file. */\n  public static addFile(fileName: LocalFileName): void {\n    try {\n      this.addJson(fs.readFileSync(fileName, \"utf-8\"));\n    } catch (e: any) {\n      throw new Error(`parsing SettingSchema file \"${fileName}\": ${e.message}\"`);\n    }\n  }\n\n  /** Add all files with a either \".json\" or \".json5\" extension from a supplied directory. */\n  public static addDirectory(dirName: LocalDirName) {\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));\n    }\n  }\n\n  /** Remove a previously added [[SettingSchemaGroup]] by groupName */\n  public static removeGroup(groupName: string): void {\n    this.doRemove(groupName);\n    this.onSchemaChanged.raiseEvent();\n  }\n\n  private static doAdd(settingsGroup: SettingSchemaGroup[]) {\n    settingsGroup.forEach((group) => {\n      if (undefined === group.groupName)\n        throw new Error(`settings group has no \"groupName\" member`);\n\n      this.doRemove(group.groupName);\n      this.validateAndAdd(group);\n      this._allGroups.set(group.groupName, group);\n    });\n  }\n\n  private static doRemove(groupName: string) {\n    const group = this._allGroups.get(groupName);\n    if (undefined !== group?.properties) {\n      for (const key of Object.keys(group.properties))\n        this.allSchemas.delete(key);\n    }\n    this._allGroups.delete(groupName);\n  }\n\n  private static validateName(name: string) {\n    if (!name.trim())\n      throw new Error(`empty property name`);\n    if (this.allSchemas.has(name))\n      throw new Error(`property \"${name}\" is already defined`);\n  }\n\n  private static validateProperty(name: string, property: SettingSchema | undefined) {\n    if (!property)\n      throw new Error(`missing required property ${name}`);\n\n    if (!property.type)\n      throw new Error(`property ${name} has no type`);\n\n    switch (property.type) {\n      case \"boolean\":\n      case \"integer\":\n      case \"null\":\n      case \"number\":\n      case \"string\":\n        return;\n\n      case \"object\":\n        const required = property.required;\n        const props = property.properties;\n        if (required && props) {\n          for (const entry of required)\n            this.validateProperty(entry, props[entry]);\n        }\n        if (props) {\n          for (const key of Object.keys(props))\n            try {\n              this.validateProperty(key, props[key]);\n            } catch (e: any) {\n              throw new Error(`property ${key} of ${name}: ${e.message}`);\n            }\n        }\n        return;\n\n      case \"array\":\n        if (typeof property.items !== \"object\")\n          throw new Error(`array property ${name} has no items member`);\n        try {\n          this.validateProperty(\"items\", property.items);\n        } catch (e: any) {\n          throw new Error(`array property ${name}: ${e.message}`);\n        }\n        return;\n\n      default:\n        throw new Error(`property ${name} has illegal type \"${property.type}\"`);\n    }\n  }\n\n  private static validateAndAdd(group: SettingSchemaGroup) {\n    const properties = group.properties;\n    if (undefined === properties)\n      throw new Error(`group ${group.groupName} has no properties`);\n\n    for (const key of Object.keys(properties)) {\n      this.validateName(key);\n      this.validateProperty(key, properties[key]);\n      const property: Mutable<SettingSchema> = properties[key];\n      property.default = property.default ?? this.getDefaultValue(property.type);\n      this.allSchemas.set(key, property);\n    }\n  }\n\n  private static getDefaultValue(type: JSONSchemaTypeName | JSONSchemaTypeName[]): JSONSchemaType | undefined {\n    type = Array.isArray(type) ? type[0] : type;\n    switch (type) {\n      case \"boolean\":\n        return false;\n      case \"integer\":\n      case \"number\":\n        return 0;\n      case \"string\":\n        return \"\";\n      case \"array\":\n        return [];\n      case \"object\":\n        return {};\n      default:\n        return undefined;\n    }\n  }\n}\n"]}