@itwin/core-backend 5.8.0-dev.1 → 5.8.0-dev.11

package/lib/esm/test/workspace/SettingsDb.test.js

@@ -0,0 +1,372 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { expect } from "chai";
+import { WorkspaceError } from "@itwin/core-common";
+import { IModelHost } from "../../IModelHost";
+import { SettingsPriority } from "../../workspace/Settings";
+import { SettingsEditor } from "../../workspace/SettingsEditor";
+import { SettingsDbImpl } from "../../internal/workspace/SettingsDbImpl";
+import { BlobContainer } from "../../BlobContainerService";
+describe("SettingsDb", () => {
+    let editor;
+    before(async () => {
+        await IModelHost.startup();
+        editor = SettingsEditor.construct();
+    });
+    after(() => {
+        editor.close();
+    });
+    function getContainer(containerId) {
+        return editor.getContainer({ containerId, baseUri: "", storageType: "azure", accessToken: "" });
+    }
+    it("SettingsDbImpl construction", async () => {
+        const container = getContainer("construct-test");
+        await container.createDb({ dbName: "test-db", manifest: { settingsName: "construct-test" } });
+        const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.application);
+        expect(settingsDb.dbName).to.equal("test-db");
+        expect(settingsDb.priority).to.equal(SettingsPriority.application);
+        expect(settingsDb.isOpen).to.be.false;
+        expect(settingsDb.container).to.equal(container);
+        expect(settingsDb.version).to.equal("0.0.0");
+    });
+    it("open and close", async () => {
+        const container = getContainer("open-close-test");
+        await container.createDb({ dbName: "test-db", manifest: { settingsName: "open-close-test" } });
+        const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.application);
+        expect(settingsDb.isOpen).to.be.false;
+        settingsDb.open();
+        expect(settingsDb.isOpen).to.be.true;
+        settingsDb.close();
+        expect(settingsDb.isOpen).to.be.false;
+        // closing an already-closed db is safe
+        settingsDb.close();
+        expect(settingsDb.isOpen).to.be.false;
+    });
+    it("getSetting reads a written setting", async () => {
+        const container = getContainer("get-setting-test");
+        const editableDb = await container.createDb({ dbName: "test-db", manifest: { settingsName: "get-setting-test" } });
+        editableDb.open();
+        editableDb.updateSettings({
+            "setting1": "value1",
+            "setting2": 42,
+            "setting3": true,
+        });
+        editableDb.close();
+        const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.iTwin);
+        settingsDb.open();
+        expect(settingsDb.getSetting("setting1")).to.equal("value1");
+        expect(settingsDb.getSetting("setting2")).to.equal(42);
+        expect(settingsDb.getSetting("setting3")).to.equal(true);
+        settingsDb.close();
+    });
+    it("getSettings reads all settings", async () => {
+        const container = getContainer("get-settings-test");
+        const editableDb = await container.createDb({ dbName: "test-db", manifest: { settingsName: "get-settings-test" } });
+        editableDb.open();
+        editableDb.updateSettings({
+            "keyA": "valA",
+            "keyB": 100,
+            "keyC": [1, 2, 3],
+        });
+        editableDb.close();
+        const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.organization);
+        settingsDb.open();
+        const all = settingsDb.getSettings();
+        expect(all.keyA).to.equal("valA");
+        expect(all.keyB).to.equal(100);
+        expect(all.keyC).to.deep.equal([1, 2, 3]);
+        settingsDb.close();
+    });
+    it("getSetting returns undefined for non-existent setting", async () => {
+        const container = getContainer("no-setting-test");
+        await container.createDb({ dbName: "test-db", manifest: { settingsName: "no-setting-test" } });
+        const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.defaults);
+        settingsDb.open();
+        expect(settingsDb.getSetting("nonExistentSetting")).to.be.undefined;
+        settingsDb.close();
+    });
+    it("manifest reads stored manifest", async () => {
+        const container = getContainer("manifest-test");
+        await container.createDb({
+            dbName: "test-db",
+            manifest: { settingsName: "My Settings DB", description: "A test settings database" },
+        });
+        const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.application);
+        // manifest auto-opens the db via withOpenDb when not explicitly opened
+        const manifest = settingsDb.manifest;
+        expect(manifest.settingsName).to.equal("My Settings DB");
+        expect(manifest.description).to.equal("A test settings database");
+        expect(settingsDb.isOpen).to.be.false;
+    });
+    it("getSetting auto-opens and auto-closes when db is not open", async () => {
+        const container = getContainer("auto-open-test");
+        const editableDb = await container.createDb({ dbName: "test-db", manifest: { settingsName: "auto-open-test" } });
+        editableDb.open();
+        editableDb.updateSettings({ "key": "auto-value" });
+        editableDb.close();
+        const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.application);
+        expect(settingsDb.isOpen).to.be.false;
+        // getSetting should auto-open, read, and auto-close
+        expect(settingsDb.getSetting("key")).to.equal("auto-value");
+        expect(settingsDb.isOpen).to.be.false;
+    });
+    it("removeSetting removes a setting", async () => {
+        const container = getContainer("remove-setting-test");
+        const editableDb = await container.createDb({ dbName: "test-db", manifest: { settingsName: "remove-setting-test" } });
+        editableDb.open();
+        editableDb.updateSettings({ "toKeep": 1, "toRemove": 2 });
+        editableDb.close();
+        // Verify both exist
+        const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.application);
+        settingsDb.open();
+        expect(settingsDb.getSetting("toKeep")).to.equal(1);
+        expect(settingsDb.getSetting("toRemove")).to.equal(2);
+        settingsDb.close();
+        // Remove one
+        editableDb.open();
+        editableDb.removeSetting("toRemove");
+        editableDb.close();
+        // Verify only one remains
+        settingsDb.open();
+        const all = settingsDb.getSettings();
+        expect(all.toKeep).to.equal(1);
+        expect(all.toRemove).to.be.undefined;
+        expect(settingsDb.getSetting("toRemove")).to.be.undefined;
+        settingsDb.close();
+    });
+    it("close updates lastEditedBy in manifest when write lock is held", async () => {
+        const container = getContainer("manifest-update-test");
+        const editableDb = await container.createDb({
+            dbName: "test-db",
+            manifest: { settingsName: "manifest-update-test", contactName: "Original Author" },
+        });
+        // For local (non-cloud) containers, acquireWriteLock is a no-op,
+        // so lastEditedBy should remain unchanged after close.
+        container.acquireWriteLock("Jane Admin");
+        editableDb.open();
+        editableDb.updateSettings({ "key": "value" });
+        editableDb.close();
+        container.releaseWriteLock();
+        const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.application);
+        const manifest = settingsDb.manifest;
+        expect(manifest.settingsName).to.equal("manifest-update-test");
+        expect(manifest.contactName).to.equal("Original Author");
+        // lastEditedBy is only auto-set for cloud containers (where acquireWriteLock actually tracks the user)
+        expect(manifest.lastEditedBy).to.be.undefined;
+    });
+    it("getSettingsDb returns a SettingsDb from a loaded container", async () => {
+        const container = getContainer("getsettingsdb-test");
+        await container.createDb({ dbName: "settings-db", manifest: { settingsName: "getsettingsdb-test" } });
+        const settingsDb = editor.workspace.getSettingsDb({ containerId: "getsettingsdb-test", priority: SettingsPriority.iTwin });
+        expect(settingsDb).to.not.be.undefined;
+        expect(settingsDb.dbName).to.equal("settings-db");
+        expect(settingsDb.manifest.settingsName).to.equal("getsettingsdb-test");
+    });
+    it("getSettingsDb throws for unloaded container", () => {
+        expect(() => editor.workspace.getSettingsDb({ containerId: "nonexistent-container-id", priority: SettingsPriority.iTwin }))
+            .to.throw()
+            .and.satisfy((e) => WorkspaceError.isError(e, "does-not-exist"));
+    });
+    it("getSettingsDb uses caller-supplied priority", async () => {
+        const container = getContainer("imodel-scope-test");
+        await container.createDb({ dbName: "settings-db", manifest: { settingsName: "imodel-scope-test" } });
+        const settingsDb = editor.workspace.getSettingsDb({ containerId: "imodel-scope-test", priority: SettingsPriority.iModel });
+        expect(settingsDb).to.not.be.undefined;
+        expect(settingsDb.priority).to.equal(SettingsPriority.iModel);
+    });
+    it("getSettingsDb respects iTwin priority", async () => {
+        const container = getContainer("itwin-priority-test");
+        await container.createDb({ dbName: "settings-db", manifest: { settingsName: "itwin-priority-test" } });
+        const settingsDb = editor.workspace.getSettingsDb({ containerId: "itwin-priority-test", priority: SettingsPriority.iTwin });
+        expect(settingsDb.priority).to.equal(SettingsPriority.iTwin);
+    });
+    it("hasSettingsManifestProperty returns true for SettingsDb containers", async () => {
+        const container = getContainer("has-manifest-test");
+        await container.createDb({ dbName: "settings-db", manifest: { settingsName: "has-manifest-test" } });
+        const settingsDb = new SettingsDbImpl({ dbName: "settings-db" }, container, SettingsPriority.application);
+        expect(settingsDb.hasSettingsManifestProperty).to.be.true;
+    });
+    it("getSetting returns undefined on empty db", async () => {
+        const container = getContainer("missing-setting-test");
+        await container.createDb({ dbName: "test-db", manifest: { settingsName: "missing-setting-test" } });
+        const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.application);
+        settingsDb.open();
+        expect(settingsDb.getSetting("does-not-exist")).to.be.undefined;
+        settingsDb.close();
+    });
+    it("editor close is resilient to container cleanup failures", () => {
+        // Verify that closing an editor with no containers doesn't throw
+        const freshEditor = SettingsEditor.construct();
+        expect(() => freshEditor.close()).to.not.throw();
+    });
+    it("getSettingsDb with custom dbName", async () => {
+        const container = getContainer("custom-dbname-test");
+        await container.createDb({ dbName: "my-custom-db", manifest: { settingsName: "custom-dbname" } });
+        const settingsDb = editor.workspace.getSettingsDb({ containerId: "custom-dbname-test", priority: SettingsPriority.application, dbName: "my-custom-db" });
+        expect(settingsDb.dbName).to.equal("my-custom-db");
+    });
+    it("iTwin and iModel settings containers coexist with correct priorities", async () => {
+        // Simulate the real scenario: an iTwin has its own settings container, and one of its
+        // iModels also has a settings container. Both are loaded into the workspace with separate
+        // containerId GUIDs (assigned by the storage container service) and different priorities.
+        const itwinContainer = getContainer("itwin-container-guid");
+        const imodelContainer = getContainer("imodel-container-guid");
+        const itwinDb = await itwinContainer.createDb({ dbName: "settings-db", manifest: { settingsName: "iTwin Settings" } });
+        const imodelDb = await imodelContainer.createDb({ dbName: "settings-db", manifest: { settingsName: "iModel Settings" } });
+        // Write the same setting name to both, with different values
+        itwinDb.open();
+        itwinDb.updateSettings({ "theme": "light", "itwinOnly": true });
+        itwinDb.close();
+        imodelDb.open();
+        imodelDb.updateSettings({ "theme": "dark", "imodelOnly": true });
+        imodelDb.close();
+        // Retrieve both via getSettingsDb with the priorities a real caller would assign
+        const itwinSettingsDb = editor.workspace.getSettingsDb({ containerId: "itwin-container-guid", priority: SettingsPriority.iTwin });
+        const imodelSettingsDb = editor.workspace.getSettingsDb({ containerId: "imodel-container-guid", priority: SettingsPriority.iModel });
+        // Verify they are independent dbs with correct priorities
+        expect(itwinSettingsDb.priority).to.equal(SettingsPriority.iTwin);
+        expect(imodelSettingsDb.priority).to.equal(SettingsPriority.iModel);
+        expect(imodelSettingsDb.priority).to.be.greaterThan(itwinSettingsDb.priority);
+        // Verify each db returns its own setting values
+        expect(itwinSettingsDb.getSetting("theme")).to.equal("light");
+        expect(itwinSettingsDb.getSetting("itwinOnly")).to.equal(true);
+        expect(imodelSettingsDb.getSetting("theme")).to.equal("dark");
+        expect(imodelSettingsDb.getSetting("imodelOnly")).to.equal(true);
+    });
+    it("SettingsEditor uses a separate cloud cache from the read-only Workspace", () => {
+        const editorCache = editor.workspace.getCloudCache();
+        const workspaceCache = IModelHost.appWorkspace.getCloudCache();
+        expect(editorCache.name).to.equal("SettingsEditor");
+        expect(workspaceCache.name).to.equal("Workspace");
+        expect(editorCache).to.not.equal(workspaceCache);
+    });
+    describe("findContainers", () => {
+        const testContainerId = "mock-settings-container-id";
+        const testITwinId = "mock-itwin-id";
+        const testIModelId = "mock-imodel-id";
+        let savedService;
+        function createMockService(containers) {
+            return {
+                create: async () => ({ containerId: testContainerId, baseUri: "https://mock.blob.core/", provider: "azure" }),
+                delete: async () => { },
+                queryScope: async () => ({ iTwinId: testITwinId }),
+                queryMetadata: async () => ({ containerType: "settings", label: "mock" }),
+                queryContainersMetadata: async (_userToken, args) => {
+                    // Filter by containerType and iTwinId like the real service would
+                    return containers.filter((c) => (args.containerType === undefined || c.containerType === args.containerType) &&
+                        (args.iTwinId === testITwinId || args.iTwinId === undefined));
+                },
+                updateJson: async () => { },
+                requestToken: async (_props) => ({
+                    token: "",
+                    scope: { iTwinId: testITwinId },
+                    provider: "azure",
+                    expiration: new Date(Date.now() + 3600000),
+                    metadata: { containerType: "settings", label: "mock" },
+                    baseUri: "",
+                }),
+            };
+        }
+        before(() => {
+            savedService = BlobContainer.service;
+        });
+        afterEach(() => {
+            BlobContainer.service = savedService;
+        });
+        it("finds containers by iTwinId", async () => {
+            BlobContainer.service = createMockService([
+                { containerId: testContainerId, containerType: "settings", label: "Test Settings" },
+            ]);
+            const containers = await editor.findContainers({ iTwinId: testITwinId });
+            expect(containers).to.have.length(1);
+            expect(containers[0].fromProps.containerId).to.equal(testContainerId);
+        });
+        it("finds a container by iTwinId and iModelId", async () => {
+            BlobContainer.service = createMockService([
+                { containerId: "imodel-scoped-container", containerType: "settings", label: "iModel Settings" },
+            ]);
+            const containers = await editor.findContainers({ iTwinId: testITwinId, iModelId: testIModelId });
+            expect(containers).to.have.length(1);
+            expect(containers[0].fromProps.containerId).to.equal("imodel-scoped-container");
+        });
+        it("returns empty array when no settings containers are found", async () => {
+            BlobContainer.service = createMockService([]);
+            const containers = await editor.findContainers({ iTwinId: "nonexistent-itwin" });
+            expect(containers).to.have.length(0);
+        });
+        it("throws when BlobContainer.service is not available", async () => {
+            BlobContainer.service = undefined;
+            await expect(editor.findContainers({ iTwinId: testITwinId }))
+                .to.be.rejectedWith(/BlobContainer.service is not available/);
+        });
+    });
+    describe("getSettings", () => {
+        it("returns a deep copy of all settings", async () => {
+            const container = getContainer("getsettings-deep-copy-test");
+            const editableDb = await container.createDb({ dbName: "test-db", manifest: { settingsName: "getsettings-deep-copy-test" } });
+            editableDb.open();
+            editableDb.updateSettings({
+                "theme": "dark",
+                "fontSize": 14,
+                "nested": { "a": 1, "b": [2, 3] },
+            });
+            editableDb.close();
+            const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.application);
+            const all = settingsDb.getSettings();
+            expect(all).to.deep.equal({ "theme": "dark", "fontSize": 14, "nested": { "a": 1, "b": [2, 3] } });
+            // Mutating the copy should not affect the stored settings
+            all.theme = "light";
+            all.nested.a = 999;
+            expect(settingsDb.getSetting("theme")).to.equal("dark");
+            expect(settingsDb.getSetting("nested")).to.deep.equal({ "a": 1, "b": [2, 3] });
+        });
+        it("returns empty object for empty db", async () => {
+            const container = getContainer("getsettings-empty-test");
+            await container.createDb({ dbName: "test-db", manifest: { settingsName: "getsettings-empty-test" } });
+            const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.application);
+            expect(settingsDb.getSettings()).to.deep.equal({});
+        });
+    });
+    describe("updateSetting", () => {
+        it("adds a setting to an empty db", async () => {
+            const container = getContainer("updatesetting-new-test");
+            const editableDb = await container.createDb({ dbName: "test-db", manifest: { settingsName: "updatesetting-new-test" } });
+            editableDb.open();
+            editableDb.updateSetting({ settingName: "myKey", value: "myValue" });
+            editableDb.close();
+            const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.application);
+            expect(settingsDb.getSetting("myKey")).to.equal("myValue");
+        });
+        it("patches existing settings without losing other keys", async () => {
+            const container = getContainer("updatesetting-patch-test");
+            const editableDb = await container.createDb({ dbName: "test-db", manifest: { settingsName: "updatesetting-patch-test" } });
+            editableDb.open();
+            editableDb.updateSettings({
+                "theme": "light",
+                "fontSize": 12,
+                "showGrid": true,
+            });
+            // Patch just one key
+            editableDb.updateSetting({ settingName: "theme", value: "dark" });
+            editableDb.close();
+            const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.application);
+            expect(settingsDb.getSetting("theme")).to.equal("dark");
+            expect(settingsDb.getSetting("fontSize")).to.equal(12);
+            expect(settingsDb.getSetting("showGrid")).to.equal(true);
+        });
+        it("adds a new key to existing settings", async () => {
+            const container = getContainer("updatesetting-addkey-test");
+            const editableDb = await container.createDb({ dbName: "test-db", manifest: { settingsName: "updatesetting-addkey-test" } });
+            editableDb.open();
+            editableDb.updateSettings({ "existing": "value" });
+            editableDb.updateSetting({ settingName: "newKey", value: 42 });
+            editableDb.close();
+            const settingsDb = new SettingsDbImpl({ dbName: "test-db" }, container, SettingsPriority.application);
+            expect(settingsDb.getSetting("existing")).to.equal("value");
+            expect(settingsDb.getSetting("newKey")).to.equal(42);
+        });
+    });
+});
+//# sourceMappingURL=SettingsDb.test.js.map

package/lib/esm/test/workspace/SettingsDb.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsDb.test.js","sourceRoot":"","sources":["../../../../src/test/workspace/SettingsDb.test.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAkC,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChG,OAAO,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3D,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,IAAI,MAAsB,CAAC;IAE3B,MAAM,CAAC,KAAK,IAAI,EAAE;QAChB,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;QAC3B,MAAM,GAAG,cAAc,CAAC,SAAS,EAAE,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,GAAG,EAAE;QACT,MAAM,CAAC,KAAK,EAAE,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,SAAS,YAAY,CAAC,WAAmB;QACvC,OAAO,MAAM,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;IAClG,CAAC;IAED,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,SAAS,GAAG,YAAY,CAAC,gBAAgB,CAAC,CAAC;QACjD,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,gBAAgB,EAAE,EAAE,CAAC,CAAC;QAE9F,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACtG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC9C,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACnE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QACtC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;QAC9B,MAAM,SAAS,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAAC;QAClD,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,iBAAiB,EAAE,EAAE,CAAC,CAAC;QAE/F,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACtG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAEtC,UAAU,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAErC,UAAU,CAAC,KAAK,EAAE,CAAC;QACnB,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAEtC,uCAAuC;QACvC,UAAU,CAAC,KAAK,EAAE,CAAC;QACnB,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,SAAS,GAAG,YAAY,CAAC,kBAAkB,CAAC,CAAC;QACnD,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,kBAAkB,EAAE,EAAE,CAAC,CAAC;QAEnH,UAAU,CAAC,IAAI,EAAE,CAAC;QAClB,UAAU,CAAC,cAAc,CAAC;YACxB,UAAU,EAAE,QAAQ;YACpB,UAAU,EAAE,EAAE;YACd,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QACH,UAAU,CAAC,KAAK,EAAE,CAAC;QAEnB,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAChG,UAAU,CAAC,IAAI,EAAE,CAAC;QAElB,MAAM,CAAC,UAAU,CAAC,UAAU,CAAS,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACrE,MAAM,CAAC,UAAU,CAAC,UAAU,CAAS,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC/D,MAAM,CAAC,UAAU,CAAC,UAAU,CAAU,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAElE,UAAU,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC9C,MAAM,SAAS,GAAG,YAAY,CAAC,mBAAmB,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,mBAAmB,EAAE,EAAE,CAAC,CAAC;QAEpH,UAAU,CAAC,IAAI,EAAE,CAAC;QAClB,UAAU,CAAC,cAAc,CAAC;YACxB,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,GAAG;YACX,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;SAClB,CAAC,CAAC;QACH,UAAU,CAAC,KAAK,EAAE,CAAC;QAEnB,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;QACvG,UAAU,CAAC,IAAI,EAAE,CAAC;QAElB,MAAM,GAAG,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;QACrC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAE1C,UAAU,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,SAAS,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAAC;QAClD,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,iBAAiB,EAAE,EAAE,CAAC,CAAC;QAE/F,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACnG,UAAU,CAAC,IAAI,EAAE,CAAC;QAElB,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QAEpE,UAAU,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC9C,MAAM,SAAS,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;QAChD,MAAM,SAAS,CAAC,QAAQ,CAAC;YACvB,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,EAAE,YAAY,EAAE,gBAAgB,EAAE,WAAW,EAAE,0BAA0B,EAAE;SACtF,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAEtG,uEAAuE;QACvE,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACrC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACzD,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAClE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,SAAS,GAAG,YAAY,CAAC,gBAAgB,CAAC,CAAC;QACjD,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,gBAAgB,EAAE,EAAE,CAAC,CAAC;QAEjH,UAAU,CAAC,IAAI,EAAE,CAAC;QAClB,UAAU,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;QACnD,UAAU,CAAC,KAAK,EAAE,CAAC;QAEnB,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACtG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAEtC,oDAAoD;QACpD,MAAM,CAAC,UAAU,CAAC,UAAU,CAAS,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACpE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,SAAS,GAAG,YAAY,CAAC,qBAAqB,CAAC,CAAC;QACtD,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,qBAAqB,EAAE,EAAE,CAAC,CAAC;QAEtH,UAAU,CAAC,IAAI,EAAE,CAAC;QAClB,UAAU,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;QAC1D,UAAU,CAAC,KAAK,EAAE,CAAC;QAEnB,oBAAoB;QACpB,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACtG,UAAU,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpD,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACtD,UAAU,CAAC,KAAK,EAAE,CAAC;QAEnB,aAAa;QACb,UAAU,CAAC,IAAI,EAAE,CAAC;QAClB,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACrC,UAAU,CAAC,KAAK,EAAE,CAAC;QAEnB,0BAA0B;QAC1B,UAAU,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,GAAG,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;QACrC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QACrC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QAC1D,UAAU,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,SAAS,GAAG,YAAY,CAAC,sBAAsB,CAAC,CAAC;QACvD,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC;YAC1C,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,EAAE,YAAY,EAAE,sBAAsB,EAAE,WAAW,EAAE,iBAAiB,EAAE;SACnF,CAAC,CAAC;QAEH,iEAAiE;QACjE,uDAAuD;QACvD,SAAS,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QACzC,UAAU,CAAC,IAAI,EAAE,CAAC;QAClB,UAAU,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QAC9C,UAAU,CAAC,KAAK,EAAE,CAAC;QACnB,SAAS,CAAC,gBAAgB,EAAE,CAAC;QAE7B,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACtG,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACrC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC/D,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACzD,uGAAuG;QACvG,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,SAAS,GAAG,YAAY,CAAC,oBAAoB,CAAC,CAAC;QACrD,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,oBAAoB,EAAE,EAAE,CAAC,CAAC;QAEtG,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,oBAAoB,EAAE,QAAQ,EAAE,gBAAgB,CAAC,KAAK,EAAE,CAAC,CAAC;QAC3H,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QACvC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAClD,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,0BAA0B,EAAE,QAAQ,EAAE,gBAAgB,CAAC,KAAK,EAAE,CAAC,CAAC;aACxH,EAAE,CAAC,KAAK,EAAE;aACV,GAAG,CAAC,OAAO,CAAC,CAAC,CAAU,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,SAAS,GAAG,YAAY,CAAC,mBAAmB,CAAC,CAAC;QACpD,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,mBAAmB,EAAE,EAAE,CAAC,CAAC;QAErG,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,mBAAmB,EAAE,QAAQ,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3H,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QACvC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,SAAS,GAAG,YAAY,CAAC,qBAAqB,CAAC,CAAC;QACtD,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,qBAAqB,EAAE,EAAE,CAAC,CAAC;QAEvG,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,qBAAqB,EAAE,QAAQ,EAAE,gBAAgB,CAAC,KAAK,EAAE,CAAC,CAAC;QAC5H,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;QAClF,MAAM,SAAS,GAAG,YAAY,CAAC,mBAAmB,CAAC,CAAC;QACpD,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,mBAAmB,EAAE,EAAE,CAAC,CAAC;QAErG,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAC1G,MAAM,CAAC,UAAU,CAAC,2BAA2B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,SAAS,GAAG,YAAY,CAAC,sBAAsB,CAAC,CAAC;QACvD,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,sBAAsB,EAAE,EAAE,CAAC,CAAC;QAEpG,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACtG,UAAU,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QAChE,UAAU,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,iEAAiE;QACjE,MAAM,WAAW,GAAG,cAAc,CAAC,SAAS,EAAE,CAAC;QAC/C,MAAM,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,SAAS,GAAG,YAAY,CAAC,oBAAoB,CAAC,CAAC;QACrD,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,eAAe,EAAE,EAAE,CAAC,CAAC;QAElG,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,oBAAoB,EAAE,QAAQ,EAAE,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;QACzJ,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACpF,sFAAsF;QACtF,0FAA0F;QAC1F,0FAA0F;QAC1F,MAAM,cAAc,GAAG,YAAY,CAAC,sBAAsB,CAAC,CAAC;QAC5D,MAAM,eAAe,GAAG,YAAY,CAAC,uBAAuB,CAAC,CAAC;QAE9D,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,gBAAgB,EAAE,EAAE,CAAC,CAAC;QACvH,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,iBAAiB,EAAE,EAAE,CAAC,CAAC;QAE1H,6DAA6D;QAC7D,OAAO,CAAC,IAAI,EAAE,CAAC;QACf,OAAO,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QAChE,OAAO,CAAC,KAAK,EAAE,CAAC;QAEhB,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChB,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;QACjE,QAAQ,CAAC,KAAK,EAAE,CAAC;QAEjB,iFAAiF;QACjF,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,sBAAsB,EAAE,QAAQ,EAAE,gBAAgB,CAAC,KAAK,EAAE,CAAC,CAAC;QAClI,MAAM,gBAAgB,GAAG,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,uBAAuB,EAAE,QAAQ,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC,CAAC;QAErI,0DAA0D;QAC1D,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAClE,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACpE,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAE9E,gDAAgD;QAChD,MAAM,CAAC,eAAe,CAAC,UAAU,CAAS,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtE,MAAM,CAAC,eAAe,CAAC,UAAU,CAAU,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAExE,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAS,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACtE,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAU,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yEAAyE,EAAE,GAAG,EAAE;QACjF,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC;QACrD,MAAM,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/D,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACpD,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAClD,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,MAAM,eAAe,GAAG,4BAA4B,CAAC;QACrD,MAAM,WAAW,GAAG,eAAe,CAAC;QACpC,MAAM,YAAY,GAAG,gBAAgB,CAAC;QACtC,IAAI,YAAwD,CAAC;QAE7D,SAAS,iBAAiB,CAAC,UAA4C;YACrE,OAAO;gBACL,MAAM,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,eAAe,EAAE,OAAO,EAAE,yBAAyB,EAAE,QAAQ,EAAE,OAAgB,EAAE,CAAC;gBACtH,MAAM,EAAE,KAAK,IAAI,EAAE,GAAE,CAAC;gBACtB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;gBAClD,aAAa,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;gBACzE,uBAAuB,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE;oBAClD,kEAAkE;oBAClE,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAC7B,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS,IAAI,CAAC,CAAC,aAAa,KAAK,IAAI,CAAC,aAAa,CAAC;wBAC5E,CAAC,IAAI,CAAC,OAAO,KAAK,WAAW,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAC7D,CAAC;gBACJ,CAAC;gBACD,UAAU,EAAE,KAAK,IAAI,EAAE,GAAE,CAAC;gBAC1B,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;oBAC/B,KAAK,EAAE,EAAE;oBACT,KAAK,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE;oBAC/B,QAAQ,EAAE,OAAgB;oBAC1B,UAAU,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC;oBAC1C,QAAQ,EAAE,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE;oBACtD,OAAO,EAAE,EAAE;iBACZ,CAAC;aACH,CAAC;QACJ,CAAC;QAED,MAAM,CAAC,GAAG,EAAE;YACV,YAAY,GAAG,aAAa,CAAC,OAAO,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,aAAa,CAAC,OAAO,GAAG,YAAY,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;YAC3C,aAAa,CAAC,OAAO,GAAG,iBAAiB,CAAC;gBACxC,EAAE,WAAW,EAAE,eAAe,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAE,eAAe,EAAE;aACpF,CAAC,CAAC;YAEH,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAAC;YACzE,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YACzD,aAAa,CAAC,OAAO,GAAG,iBAAiB,CAAC;gBACxC,EAAE,WAAW,EAAE,yBAAyB,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAE,iBAAiB,EAAE;aAChG,CAAC,CAAC;YAEH,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;YACjG,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;YACzE,aAAa,CAAC,OAAO,GAAG,iBAAiB,CAAC,EAAE,CAAC,CAAC;YAE9C,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC;YACjF,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;YAClE,aAAa,CAAC,OAAO,GAAG,SAAS,CAAC;YAElC,MAAM,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAAC;iBAC1D,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC,wCAAwC,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;YACnD,MAAM,SAAS,GAAG,YAAY,CAAC,4BAA4B,CAAC,CAAC;YAC7D,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,4BAA4B,EAAE,EAAE,CAAC,CAAC;YAE7H,UAAU,CAAC,IAAI,EAAE,CAAC;YAClB,UAAU,CAAC,cAAc,CAAC;gBACxB,OAAO,EAAE,MAAM;gBACf,UAAU,EAAE,EAAE;gBACd,QAAQ,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;aAClC,CAAC,CAAC;YACH,UAAU,CAAC,KAAK,EAAE,CAAC;YAEnB,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;YACtG,MAAM,GAAG,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;YACrC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAElG,0DAA0D;YACzD,GAAW,CAAC,KAAK,GAAG,OAAO,CAAC;YAC5B,GAAW,CAAC,MAAM,CAAC,CAAC,GAAG,GAAG,CAAC;YAC5B,MAAM,CAAC,UAAU,CAAC,UAAU,CAAS,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAChE,MAAM,CAAC,UAAU,CAAC,UAAU,CAAgB,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAChG,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;YACjD,MAAM,SAAS,GAAG,YAAY,CAAC,wBAAwB,CAAC,CAAC;YACzD,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,wBAAwB,EAAE,EAAE,CAAC,CAAC;YAEtG,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;YACtG,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;YAC7C,MAAM,SAAS,GAAG,YAAY,CAAC,wBAAwB,CAAC,CAAC;YACzD,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,wBAAwB,EAAE,EAAE,CAAC,CAAC;YAEzH,UAAU,CAAC,IAAI,EAAE,CAAC;YAClB,UAAU,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YACrE,UAAU,CAAC,KAAK,EAAE,CAAC;YAEnB,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;YACtG,MAAM,CAAC,UAAU,CAAC,UAAU,CAAS,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,SAAS,GAAG,YAAY,CAAC,0BAA0B,CAAC,CAAC;YAC3D,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,0BAA0B,EAAE,EAAE,CAAC,CAAC;YAE3H,UAAU,CAAC,IAAI,EAAE,CAAC;YAClB,UAAU,CAAC,cAAc,CAAC;gBACxB,OAAO,EAAE,OAAO;gBAChB,UAAU,EAAE,EAAE;gBACd,UAAU,EAAE,IAAI;aACjB,CAAC,CAAC;YAEH,qBAAqB;YACrB,UAAU,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;YAClE,UAAU,CAAC,KAAK,EAAE,CAAC;YAEnB,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;YACtG,MAAM,CAAC,UAAU,CAAC,UAAU,CAAS,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAChE,MAAM,CAAC,UAAU,CAAC,UAAU,CAAS,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC/D,MAAM,CAAC,UAAU,CAAC,UAAU,CAAU,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;YACnD,MAAM,SAAS,GAAG,YAAY,CAAC,2BAA2B,CAAC,CAAC;YAC5D,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,2BAA2B,EAAE,EAAE,CAAC,CAAC;YAE5H,UAAU,CAAC,IAAI,EAAE,CAAC;YAClB,UAAU,CAAC,cAAc,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;YAEnD,UAAU,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;YAC/D,UAAU,CAAC,KAAK,EAAE,CAAC;YAEnB,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;YACtG,MAAM,CAAC,UAAU,CAAC,UAAU,CAAS,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACpE,MAAM,CAAC,UAAU,CAAC,UAAU,CAAS,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,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\r\nimport { expect } from \"chai\";\r\nimport { WorkspaceError } from \"@itwin/core-common\";\r\nimport { IModelHost } from \"../../IModelHost\";\r\nimport { SettingsPriority } from \"../../workspace/Settings\";\r\nimport { EditableSettingsCloudContainer, SettingsEditor } from \"../../workspace/SettingsEditor\";\r\nimport { SettingsDbImpl } from \"../../internal/workspace/SettingsDbImpl\";\r\nimport { BlobContainer } from \"../../BlobContainerService\";\r\n\r\ndescribe(\"SettingsDb\", () => {\r\n  let editor: SettingsEditor;\r\n\r\n  before(async () => {\r\n    await IModelHost.startup();\r\n    editor = SettingsEditor.construct();\r\n  });\r\n\r\n  after(() => {\r\n    editor.close();\r\n  });\r\n\r\n  function getContainer(containerId: string): EditableSettingsCloudContainer {\r\n    return editor.getContainer({ containerId, baseUri: \"\", storageType: \"azure\", accessToken: \"\" });\r\n  }\r\n\r\n  it(\"SettingsDbImpl construction\", async () => {\r\n    const container = getContainer(\"construct-test\");\r\n    await container.createDb({ dbName: \"test-db\", manifest: { settingsName: \"construct-test\" } });\r\n\r\n    const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.application);\r\n    expect(settingsDb.dbName).to.equal(\"test-db\");\r\n    expect(settingsDb.priority).to.equal(SettingsPriority.application);\r\n    expect(settingsDb.isOpen).to.be.false;\r\n    expect(settingsDb.container).to.equal(container);\r\n    expect(settingsDb.version).to.equal(\"0.0.0\");\r\n  });\r\n\r\n  it(\"open and close\", async () => {\r\n    const container = getContainer(\"open-close-test\");\r\n    await container.createDb({ dbName: \"test-db\", manifest: { settingsName: \"open-close-test\" } });\r\n\r\n    const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.application);\r\n    expect(settingsDb.isOpen).to.be.false;\r\n\r\n    settingsDb.open();\r\n    expect(settingsDb.isOpen).to.be.true;\r\n\r\n    settingsDb.close();\r\n    expect(settingsDb.isOpen).to.be.false;\r\n\r\n    // closing an already-closed db is safe\r\n    settingsDb.close();\r\n    expect(settingsDb.isOpen).to.be.false;\r\n  });\r\n\r\n  it(\"getSetting reads a written setting\", async () => {\r\n    const container = getContainer(\"get-setting-test\");\r\n    const editableDb = await container.createDb({ dbName: \"test-db\", manifest: { settingsName: \"get-setting-test\" } });\r\n\r\n    editableDb.open();\r\n    editableDb.updateSettings({\r\n      \"setting1\": \"value1\",\r\n      \"setting2\": 42,\r\n      \"setting3\": true,\r\n    });\r\n    editableDb.close();\r\n\r\n    const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.iTwin);\r\n    settingsDb.open();\r\n\r\n    expect(settingsDb.getSetting<string>(\"setting1\")).to.equal(\"value1\");\r\n    expect(settingsDb.getSetting<number>(\"setting2\")).to.equal(42);\r\n    expect(settingsDb.getSetting<boolean>(\"setting3\")).to.equal(true);\r\n\r\n    settingsDb.close();\r\n  });\r\n\r\n  it(\"getSettings reads all settings\", async () => {\r\n    const container = getContainer(\"get-settings-test\");\r\n    const editableDb = await container.createDb({ dbName: \"test-db\", manifest: { settingsName: \"get-settings-test\" } });\r\n\r\n    editableDb.open();\r\n    editableDb.updateSettings({\r\n      \"keyA\": \"valA\",\r\n      \"keyB\": 100,\r\n      \"keyC\": [1, 2, 3],\r\n    });\r\n    editableDb.close();\r\n\r\n    const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.organization);\r\n    settingsDb.open();\r\n\r\n    const all = settingsDb.getSettings();\r\n    expect(all.keyA).to.equal(\"valA\");\r\n    expect(all.keyB).to.equal(100);\r\n    expect(all.keyC).to.deep.equal([1, 2, 3]);\r\n\r\n    settingsDb.close();\r\n  });\r\n\r\n  it(\"getSetting returns undefined for non-existent setting\", async () => {\r\n    const container = getContainer(\"no-setting-test\");\r\n    await container.createDb({ dbName: \"test-db\", manifest: { settingsName: \"no-setting-test\" } });\r\n\r\n    const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.defaults);\r\n    settingsDb.open();\r\n\r\n    expect(settingsDb.getSetting(\"nonExistentSetting\")).to.be.undefined;\r\n\r\n    settingsDb.close();\r\n  });\r\n\r\n  it(\"manifest reads stored manifest\", async () => {\r\n    const container = getContainer(\"manifest-test\");\r\n    await container.createDb({\r\n      dbName: \"test-db\",\r\n      manifest: { settingsName: \"My Settings DB\", description: \"A test settings database\" },\r\n    });\r\n\r\n    const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.application);\r\n\r\n    // manifest auto-opens the db via withOpenDb when not explicitly opened\r\n    const manifest = settingsDb.manifest;\r\n    expect(manifest.settingsName).to.equal(\"My Settings DB\");\r\n    expect(manifest.description).to.equal(\"A test settings database\");\r\n    expect(settingsDb.isOpen).to.be.false;\r\n  });\r\n\r\n  it(\"getSetting auto-opens and auto-closes when db is not open\", async () => {\r\n    const container = getContainer(\"auto-open-test\");\r\n    const editableDb = await container.createDb({ dbName: \"test-db\", manifest: { settingsName: \"auto-open-test\" } });\r\n\r\n    editableDb.open();\r\n    editableDb.updateSettings({ \"key\": \"auto-value\" });\r\n    editableDb.close();\r\n\r\n    const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.application);\r\n    expect(settingsDb.isOpen).to.be.false;\r\n\r\n    // getSetting should auto-open, read, and auto-close\r\n    expect(settingsDb.getSetting<string>(\"key\")).to.equal(\"auto-value\");\r\n    expect(settingsDb.isOpen).to.be.false;\r\n  });\r\n\r\n  it(\"removeSetting removes a setting\", async () => {\r\n    const container = getContainer(\"remove-setting-test\");\r\n    const editableDb = await container.createDb({ dbName: \"test-db\", manifest: { settingsName: \"remove-setting-test\" } });\r\n\r\n    editableDb.open();\r\n    editableDb.updateSettings({ \"toKeep\": 1, \"toRemove\": 2 });\r\n    editableDb.close();\r\n\r\n    // Verify both exist\r\n    const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.application);\r\n    settingsDb.open();\r\n    expect(settingsDb.getSetting(\"toKeep\")).to.equal(1);\r\n    expect(settingsDb.getSetting(\"toRemove\")).to.equal(2);\r\n    settingsDb.close();\r\n\r\n    // Remove one\r\n    editableDb.open();\r\n    editableDb.removeSetting(\"toRemove\");\r\n    editableDb.close();\r\n\r\n    // Verify only one remains\r\n    settingsDb.open();\r\n    const all = settingsDb.getSettings();\r\n    expect(all.toKeep).to.equal(1);\r\n    expect(all.toRemove).to.be.undefined;\r\n    expect(settingsDb.getSetting(\"toRemove\")).to.be.undefined;\r\n    settingsDb.close();\r\n  });\r\n\r\n  it(\"close updates lastEditedBy in manifest when write lock is held\", async () => {\r\n    const container = getContainer(\"manifest-update-test\");\r\n    const editableDb = await container.createDb({\r\n      dbName: \"test-db\",\r\n      manifest: { settingsName: \"manifest-update-test\", contactName: \"Original Author\" },\r\n    });\r\n\r\n    // For local (non-cloud) containers, acquireWriteLock is a no-op,\r\n    // so lastEditedBy should remain unchanged after close.\r\n    container.acquireWriteLock(\"Jane Admin\");\r\n    editableDb.open();\r\n    editableDb.updateSettings({ \"key\": \"value\" });\r\n    editableDb.close();\r\n    container.releaseWriteLock();\r\n\r\n    const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.application);\r\n    const manifest = settingsDb.manifest;\r\n    expect(manifest.settingsName).to.equal(\"manifest-update-test\");\r\n    expect(manifest.contactName).to.equal(\"Original Author\");\r\n    // lastEditedBy is only auto-set for cloud containers (where acquireWriteLock actually tracks the user)\r\n    expect(manifest.lastEditedBy).to.be.undefined;\r\n  });\r\n\r\n  it(\"getSettingsDb returns a SettingsDb from a loaded container\", async () => {\r\n    const container = getContainer(\"getsettingsdb-test\");\r\n    await container.createDb({ dbName: \"settings-db\", manifest: { settingsName: \"getsettingsdb-test\" } });\r\n\r\n    const settingsDb = editor.workspace.getSettingsDb({ containerId: \"getsettingsdb-test\", priority: SettingsPriority.iTwin });\r\n    expect(settingsDb).to.not.be.undefined;\r\n    expect(settingsDb.dbName).to.equal(\"settings-db\");\r\n    expect(settingsDb.manifest.settingsName).to.equal(\"getsettingsdb-test\");\r\n  });\r\n\r\n  it(\"getSettingsDb throws for unloaded container\", () => {\r\n    expect(() => editor.workspace.getSettingsDb({ containerId: \"nonexistent-container-id\", priority: SettingsPriority.iTwin }))\r\n      .to.throw()\r\n      .and.satisfy((e: unknown) => WorkspaceError.isError(e, \"does-not-exist\"));\r\n  });\r\n\r\n  it(\"getSettingsDb uses caller-supplied priority\", async () => {\r\n    const container = getContainer(\"imodel-scope-test\");\r\n    await container.createDb({ dbName: \"settings-db\", manifest: { settingsName: \"imodel-scope-test\" } });\r\n\r\n    const settingsDb = editor.workspace.getSettingsDb({ containerId: \"imodel-scope-test\", priority: SettingsPriority.iModel });\r\n    expect(settingsDb).to.not.be.undefined;\r\n    expect(settingsDb.priority).to.equal(SettingsPriority.iModel);\r\n  });\r\n\r\n  it(\"getSettingsDb respects iTwin priority\", async () => {\r\n    const container = getContainer(\"itwin-priority-test\");\r\n    await container.createDb({ dbName: \"settings-db\", manifest: { settingsName: \"itwin-priority-test\" } });\r\n\r\n    const settingsDb = editor.workspace.getSettingsDb({ containerId: \"itwin-priority-test\", priority: SettingsPriority.iTwin });\r\n    expect(settingsDb.priority).to.equal(SettingsPriority.iTwin);\r\n  });\r\n\r\n  it(\"hasSettingsManifestProperty returns true for SettingsDb containers\", async () => {\r\n    const container = getContainer(\"has-manifest-test\");\r\n    await container.createDb({ dbName: \"settings-db\", manifest: { settingsName: \"has-manifest-test\" } });\r\n\r\n    const settingsDb = new SettingsDbImpl({ dbName: \"settings-db\" }, container, SettingsPriority.application);\r\n    expect(settingsDb.hasSettingsManifestProperty).to.be.true;\r\n  });\r\n\r\n  it(\"getSetting returns undefined on empty db\", async () => {\r\n    const container = getContainer(\"missing-setting-test\");\r\n    await container.createDb({ dbName: \"test-db\", manifest: { settingsName: \"missing-setting-test\" } });\r\n\r\n    const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.application);\r\n    settingsDb.open();\r\n    expect(settingsDb.getSetting(\"does-not-exist\")).to.be.undefined;\r\n    settingsDb.close();\r\n  });\r\n\r\n  it(\"editor close is resilient to container cleanup failures\", () => {\r\n    // Verify that closing an editor with no containers doesn't throw\r\n    const freshEditor = SettingsEditor.construct();\r\n    expect(() => freshEditor.close()).to.not.throw();\r\n  });\r\n\r\n  it(\"getSettingsDb with custom dbName\", async () => {\r\n    const container = getContainer(\"custom-dbname-test\");\r\n    await container.createDb({ dbName: \"my-custom-db\", manifest: { settingsName: \"custom-dbname\" } });\r\n\r\n    const settingsDb = editor.workspace.getSettingsDb({ containerId: \"custom-dbname-test\", priority: SettingsPriority.application, dbName: \"my-custom-db\" });\r\n    expect(settingsDb.dbName).to.equal(\"my-custom-db\");\r\n  });\r\n\r\n  it(\"iTwin and iModel settings containers coexist with correct priorities\", async () => {\r\n    // Simulate the real scenario: an iTwin has its own settings container, and one of its\r\n    // iModels also has a settings container. Both are loaded into the workspace with separate\r\n    // containerId GUIDs (assigned by the storage container service) and different priorities.\r\n    const itwinContainer = getContainer(\"itwin-container-guid\");\r\n    const imodelContainer = getContainer(\"imodel-container-guid\");\r\n\r\n    const itwinDb = await itwinContainer.createDb({ dbName: \"settings-db\", manifest: { settingsName: \"iTwin Settings\" } });\r\n    const imodelDb = await imodelContainer.createDb({ dbName: \"settings-db\", manifest: { settingsName: \"iModel Settings\" } });\r\n\r\n    // Write the same setting name to both, with different values\r\n    itwinDb.open();\r\n    itwinDb.updateSettings({ \"theme\": \"light\", \"itwinOnly\": true });\r\n    itwinDb.close();\r\n\r\n    imodelDb.open();\r\n    imodelDb.updateSettings({ \"theme\": \"dark\", \"imodelOnly\": true });\r\n    imodelDb.close();\r\n\r\n    // Retrieve both via getSettingsDb with the priorities a real caller would assign\r\n    const itwinSettingsDb = editor.workspace.getSettingsDb({ containerId: \"itwin-container-guid\", priority: SettingsPriority.iTwin });\r\n    const imodelSettingsDb = editor.workspace.getSettingsDb({ containerId: \"imodel-container-guid\", priority: SettingsPriority.iModel });\r\n\r\n    // Verify they are independent dbs with correct priorities\r\n    expect(itwinSettingsDb.priority).to.equal(SettingsPriority.iTwin);\r\n    expect(imodelSettingsDb.priority).to.equal(SettingsPriority.iModel);\r\n    expect(imodelSettingsDb.priority).to.be.greaterThan(itwinSettingsDb.priority);\r\n\r\n    // Verify each db returns its own setting values\r\n    expect(itwinSettingsDb.getSetting<string>(\"theme\")).to.equal(\"light\");\r\n    expect(itwinSettingsDb.getSetting<boolean>(\"itwinOnly\")).to.equal(true);\r\n\r\n    expect(imodelSettingsDb.getSetting<string>(\"theme\")).to.equal(\"dark\");\r\n    expect(imodelSettingsDb.getSetting<boolean>(\"imodelOnly\")).to.equal(true);\r\n  });\r\n\r\n  it(\"SettingsEditor uses a separate cloud cache from the read-only Workspace\", () => {\r\n    const editorCache = editor.workspace.getCloudCache();\r\n    const workspaceCache = IModelHost.appWorkspace.getCloudCache();\r\n    expect(editorCache.name).to.equal(\"SettingsEditor\");\r\n    expect(workspaceCache.name).to.equal(\"Workspace\");\r\n    expect(editorCache).to.not.equal(workspaceCache);\r\n  });\r\n\r\n  describe(\"findContainers\", () => {\r\n    const testContainerId = \"mock-settings-container-id\";\r\n    const testITwinId = \"mock-itwin-id\";\r\n    const testIModelId = \"mock-imodel-id\";\r\n    let savedService: BlobContainer.ContainerService | undefined;\r\n\r\n    function createMockService(containers: BlobContainer.MetadataResponse[]): BlobContainer.ContainerService {\r\n      return {\r\n        create: async () => ({ containerId: testContainerId, baseUri: \"https://mock.blob.core/\", provider: \"azure\" as const }),\r\n        delete: async () => {},\r\n        queryScope: async () => ({ iTwinId: testITwinId }),\r\n        queryMetadata: async () => ({ containerType: \"settings\", label: \"mock\" }),\r\n        queryContainersMetadata: async (_userToken, args) => {\r\n          // Filter by containerType and iTwinId like the real service would\r\n          return containers.filter((c) =>\r\n            (args.containerType === undefined || c.containerType === args.containerType) &&\r\n            (args.iTwinId === testITwinId || args.iTwinId === undefined),\r\n          );\r\n        },\r\n        updateJson: async () => {},\r\n        requestToken: async (_props) => ({\r\n          token: \"\",\r\n          scope: { iTwinId: testITwinId },\r\n          provider: \"azure\" as const,\r\n          expiration: new Date(Date.now() + 3600000),\r\n          metadata: { containerType: \"settings\", label: \"mock\" },\r\n          baseUri: \"\",\r\n        }),\r\n      };\r\n    }\r\n\r\n    before(() => {\r\n      savedService = BlobContainer.service;\r\n    });\r\n\r\n    afterEach(() => {\r\n      BlobContainer.service = savedService;\r\n    });\r\n\r\n    it(\"finds containers by iTwinId\", async () => {\r\n      BlobContainer.service = createMockService([\r\n        { containerId: testContainerId, containerType: \"settings\", label: \"Test Settings\" },\r\n      ]);\r\n\r\n      const containers = await editor.findContainers({ iTwinId: testITwinId });\r\n      expect(containers).to.have.length(1);\r\n      expect(containers[0].fromProps.containerId).to.equal(testContainerId);\r\n    });\r\n\r\n    it(\"finds a container by iTwinId and iModelId\", async () => {\r\n      BlobContainer.service = createMockService([\r\n        { containerId: \"imodel-scoped-container\", containerType: \"settings\", label: \"iModel Settings\" },\r\n      ]);\r\n\r\n      const containers = await editor.findContainers({ iTwinId: testITwinId, iModelId: testIModelId });\r\n      expect(containers).to.have.length(1);\r\n      expect(containers[0].fromProps.containerId).to.equal(\"imodel-scoped-container\");\r\n    });\r\n\r\n    it(\"returns empty array when no settings containers are found\", async () => {\r\n      BlobContainer.service = createMockService([]);\r\n\r\n      const containers = await editor.findContainers({ iTwinId: \"nonexistent-itwin\" });\r\n      expect(containers).to.have.length(0);\r\n    });\r\n\r\n    it(\"throws when BlobContainer.service is not available\", async () => {\r\n      BlobContainer.service = undefined;\r\n\r\n      await expect(editor.findContainers({ iTwinId: testITwinId }))\r\n        .to.be.rejectedWith(/BlobContainer.service is not available/);\r\n    });\r\n  });\r\n\r\n  describe(\"getSettings\", () => {\r\n    it(\"returns a deep copy of all settings\", async () => {\r\n      const container = getContainer(\"getsettings-deep-copy-test\");\r\n      const editableDb = await container.createDb({ dbName: \"test-db\", manifest: { settingsName: \"getsettings-deep-copy-test\" } });\r\n\r\n      editableDb.open();\r\n      editableDb.updateSettings({\r\n        \"theme\": \"dark\",\r\n        \"fontSize\": 14,\r\n        \"nested\": { \"a\": 1, \"b\": [2, 3] },\r\n      });\r\n      editableDb.close();\r\n\r\n      const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.application);\r\n      const all = settingsDb.getSettings();\r\n      expect(all).to.deep.equal({ \"theme\": \"dark\", \"fontSize\": 14, \"nested\": { \"a\": 1, \"b\": [2, 3] } });\r\n\r\n      // Mutating the copy should not affect the stored settings\r\n      (all as any).theme = \"light\";\r\n      (all as any).nested.a = 999;\r\n      expect(settingsDb.getSetting<string>(\"theme\")).to.equal(\"dark\");\r\n      expect(settingsDb.getSetting<{ a: number }>(\"nested\")).to.deep.equal({ \"a\": 1, \"b\": [2, 3] });\r\n    });\r\n\r\n    it(\"returns empty object for empty db\", async () => {\r\n      const container = getContainer(\"getsettings-empty-test\");\r\n      await container.createDb({ dbName: \"test-db\", manifest: { settingsName: \"getsettings-empty-test\" } });\r\n\r\n      const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.application);\r\n      expect(settingsDb.getSettings()).to.deep.equal({});\r\n    });\r\n  });\r\n\r\n  describe(\"updateSetting\", () => {\r\n    it(\"adds a setting to an empty db\", async () => {\r\n      const container = getContainer(\"updatesetting-new-test\");\r\n      const editableDb = await container.createDb({ dbName: \"test-db\", manifest: { settingsName: \"updatesetting-new-test\" } });\r\n\r\n      editableDb.open();\r\n      editableDb.updateSetting({ settingName: \"myKey\", value: \"myValue\" });\r\n      editableDb.close();\r\n\r\n      const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.application);\r\n      expect(settingsDb.getSetting<string>(\"myKey\")).to.equal(\"myValue\");\r\n    });\r\n\r\n    it(\"patches existing settings without losing other keys\", async () => {\r\n      const container = getContainer(\"updatesetting-patch-test\");\r\n      const editableDb = await container.createDb({ dbName: \"test-db\", manifest: { settingsName: \"updatesetting-patch-test\" } });\r\n\r\n      editableDb.open();\r\n      editableDb.updateSettings({\r\n        \"theme\": \"light\",\r\n        \"fontSize\": 12,\r\n        \"showGrid\": true,\r\n      });\r\n\r\n      // Patch just one key\r\n      editableDb.updateSetting({ settingName: \"theme\", value: \"dark\" });\r\n      editableDb.close();\r\n\r\n      const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.application);\r\n      expect(settingsDb.getSetting<string>(\"theme\")).to.equal(\"dark\");\r\n      expect(settingsDb.getSetting<number>(\"fontSize\")).to.equal(12);\r\n      expect(settingsDb.getSetting<boolean>(\"showGrid\")).to.equal(true);\r\n    });\r\n\r\n    it(\"adds a new key to existing settings\", async () => {\r\n      const container = getContainer(\"updatesetting-addkey-test\");\r\n      const editableDb = await container.createDb({ dbName: \"test-db\", manifest: { settingsName: \"updatesetting-addkey-test\" } });\r\n\r\n      editableDb.open();\r\n      editableDb.updateSettings({ \"existing\": \"value\" });\r\n\r\n      editableDb.updateSetting({ settingName: \"newKey\", value: 42 });\r\n      editableDb.close();\r\n\r\n      const settingsDb = new SettingsDbImpl({ dbName: \"test-db\" }, container, SettingsPriority.application);\r\n      expect(settingsDb.getSetting<string>(\"existing\")).to.equal(\"value\");\r\n      expect(settingsDb.getSetting<number>(\"newKey\")).to.equal(42);\r\n    });\r\n  });\r\n});\r\n"]}

package/lib/esm/workspace/Settings.d.ts

@@ -90,6 +90,14 @@ export interface SettingsDictionary {
      * dictionaries. Those methods - unlike this one - also validate that `settingName` is of type `T` as defined by its [[SettingSchema]].
      */
     getSetting<T extends Setting>(settingName: SettingName): T | undefined;
+    /** Return a deep copy of all settings in this dictionary as a [[SettingsContainer]].
+     * This is useful for inspecting the full contents of the dictionary or for building a modified copy
+     * to pass to [[EditableSettingsDb.updateSettingsDictionary]].
+     * The returned container is cloned using [[Setting.clone]], so callers may freely mutate it without
+     * affecting this dictionary's internal state.
+     * @beta
+     */
+    toJSON(): SettingsContainer;
 }
 /** Uniquely identifies a [[SettingsDictionary]].
  * @beta

package/lib/esm/workspace/Settings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Settings.d.ts","sourceRoot":"","sources":["../../../src/workspace/Settings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAEhE;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,cAAc,CAAC;AAErC,YAAY;AACZ,yBAAiB,OAAO,CAAC;IACvB,2CAA2C;IAC3C,SAAgB,KAAK,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAOtD;IAED;;;;;;OAMG;IACH,SAAgB,QAAQ,CAAC,CAAC,EAAE,OAAO,GAAG,SAAS,EAAE,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,CA4ChF;CACF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,wCAAwC;IACxC,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,GAAG,SAAS,CAAC;CAC1C;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC,YAAY;AACZ,yBAAiB,gBAAgB,CAAC;IAChC,yGAAyG;IAClG,MAAM,QAAQ,MAAM,CAAC;IAC5B,sDAAsD;IAC/C,MAAM,WAAW,MAAM,CAAC;IAC/B,6DAA6D;IACtD,MAAM,YAAY,MAAM,CAAC;IAChC,sDAAsD;IAC/C,MAAM,KAAK,MAAM,CAAC;IACzB,wDAAwD;IACjD,MAAM,MAAM,MAAM,CAAC;IAC1B,gDAAgD;IACzC,MAAM,MAAM,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAErC,0CAA0C;IAC1C,QAAQ,CAAC,KAAK,EAAE,uBAAuB,CAAC;IAExC;;;;OAIG;IACH,UAAU,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,GAAG,CAAC,GAAG,SAAS,CAAC;CACxE;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,iMAAiM;IACjM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,gEAAgE;IAChE,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,wBAAwB;IACvE,qIAAqI;IACrI,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;CACrC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,QAAQ;IACvB,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAErC,gBAAgB;IAChB,KAAK,IAAI,IAAI,CAAC;IAEd;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,SAAS,kBAAkB,EAAE,CAAC;IAErD,0EAA0E;IAC1E,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;IAEhD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEnE,+FAA+F;IAC/F,YAAY,CAAC,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAExE;;OAEG;IACH,OAAO,CAAC,KAAK,EAAE,uBAAuB,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpE,wFAAwF;IACxF,aAAa,CAAC,MAAM,EAAE,wBAAwB,GAAG,kBAAkB,GAAG,SAAS,CAAC;IAEhF;;;OAGG;IACH,aAAa,CAAC,KAAK,EAAE,uBAAuB,EAAE,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEjF,yDAAyD;IACzD,cAAc,CAAC,KAAK,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEtD;;;;;;;;;OASG;IACH,UAAU,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAEzF,0JAA0J;IAC1J,iBAAiB,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,GAAG,QAAQ,CAAC;QAAE,KAAK,EAAE,CAAC,CAAC;QAAC,UAAU,EAAE,kBAAkB,CAAA;KAAC,CAAC,CAAC;IAEtH,0JAA0J;IAC1J,gBAAgB,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAE3E;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAClE,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IAE/E;;OAEG;IACH,UAAU,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC;IACrE,UAAU,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS,CAAC;IAElF;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAClE,SAAS,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;IAExD;;OAEG;IACH,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC;IAC1E,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,WAAW,EAAE,WAAW,GAAG,CAAC,GAAG,SAAS,CAAC;IAErE;;OAEG;IACH,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACxF,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;CAC7E"}
+{"version":3,"file":"Settings.d.ts","sourceRoot":"","sources":["../../../src/workspace/Settings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAEhE;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,cAAc,CAAC;AAErC,YAAY;AACZ,yBAAiB,OAAO,CAAC;IACvB,2CAA2C;IAC3C,SAAgB,KAAK,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAOtD;IAED;;;;;;OAMG;IACH,SAAgB,QAAQ,CAAC,CAAC,EAAE,OAAO,GAAG,SAAS,EAAE,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,CA4ChF;CACF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,wCAAwC;IACxC,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,GAAG,SAAS,CAAC;CAC1C;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC,YAAY;AACZ,yBAAiB,gBAAgB,CAAC;IAChC,yGAAyG;IAClG,MAAM,QAAQ,MAAM,CAAC;IAC5B,sDAAsD;IAC/C,MAAM,WAAW,MAAM,CAAC;IAC/B,6DAA6D;IACtD,MAAM,YAAY,MAAM,CAAC;IAChC,sDAAsD;IAC/C,MAAM,KAAK,MAAM,CAAC;IACzB,wDAAwD;IACjD,MAAM,MAAM,MAAM,CAAC;IAC1B,gDAAgD;IACzC,MAAM,MAAM,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAErC,0CAA0C;IAC1C,QAAQ,CAAC,KAAK,EAAE,uBAAuB,CAAC;IAExC;;;;OAIG;IACH,UAAU,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,GAAG,CAAC,GAAG,SAAS,CAAC;IAEvE;;;;;;OAMG;IACH,MAAM,IAAI,iBAAiB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,iMAAiM;IACjM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,gEAAgE;IAChE,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,wBAAwB;IACvE,qIAAqI;IACrI,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;CACrC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,QAAQ;IACvB,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAErC,gBAAgB;IAChB,KAAK,IAAI,IAAI,CAAC;IAEd;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,SAAS,kBAAkB,EAAE,CAAC;IAErD,0EAA0E;IAC1E,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;IAEhD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEnE,+FAA+F;IAC/F,YAAY,CAAC,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAExE;;OAEG;IACH,OAAO,CAAC,KAAK,EAAE,uBAAuB,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpE,wFAAwF;IACxF,aAAa,CAAC,MAAM,EAAE,wBAAwB,GAAG,kBAAkB,GAAG,SAAS,CAAC;IAEhF;;;OAGG;IACH,aAAa,CAAC,KAAK,EAAE,uBAAuB,EAAE,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEjF,yDAAyD;IACzD,cAAc,CAAC,KAAK,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEtD;;;;;;;;;OASG;IACH,UAAU,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAEzF,0JAA0J;IAC1J,iBAAiB,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,GAAG,QAAQ,CAAC;QAAE,KAAK,EAAE,CAAC,CAAC;QAAC,UAAU,EAAE,kBAAkB,CAAA;KAAC,CAAC,CAAC;IAEtH,0JAA0J;IAC1J,gBAAgB,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAE3E;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAClE,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IAE/E;;OAEG;IACH,UAAU,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC;IACrE,UAAU,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS,CAAC;IAElF;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAClE,SAAS,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;IAExD;;OAEG;IACH,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC;IAC1E,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,WAAW,EAAE,WAAW,GAAG,CAAC,GAAG,SAAS,CAAC;IAErE;;OAEG;IACH,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACxF,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;CAC7E"}

package/lib/esm/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;AAKH,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAQhE,YAAY;AACZ,MAAM,KAAW,OAAO,CA+DvB;AA/DD,WAAiB,OAAO;IACtB,2CAA2C;IAC3C,SAAgB,KAAK,CAAoB,OAAU;QACjD,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ;YACzC,OAAO,OAAO,CAAC;QAEjB,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAS,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAE,OAAe,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1F,OAAO,MAAM,CAAC;IAChB,CAAC;IAPe,aAAK,QAOpB,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,QAAQ,CAAC,CAAsB,EAAE,CAAsB;QACrE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QAED,qCAAqC;QACrC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YACnD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;gBACpE,OAAO,KAAK,CAAC;YACf,CAAC;YAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC1B,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACrB,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrB,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,CAAC,QAAQ,CAAE,CAAuB,CAAC,GAAG,CAAC,EAAG,CAAuB,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBAC5E,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IA5Ce,gBAAQ,WA4CvB,CAAA;AACH,CAAC,EA/DgB,OAAO,KAAP,OAAO,QA+DvB;AA0CD,YAAY;AACZ,MAAM,KAAW,gBAAgB,CAahC;AAbD,WAAiB,gBAAgB;IAC/B,yGAAyG;IAC5F,yBAAQ,GAAG,GAAG,CAAC;IAC5B,sDAAsD;IACzC,4BAAW,GAAG,GAAG,CAAC;IAC/B,6DAA6D;IAChD,6BAAY,GAAG,GAAG,CAAC;IAChC,sDAAsD;IACzC,sBAAK,GAAG,GAAG,CAAC;IACzB,wDAAwD;IAC3C,uBAAM,GAAG,GAAG,CAAC;IAC1B,gDAAgD;IACnC,uBAAM,GAAG,GAAG,CAAC;AAC5B,CAAC,EAbgB,gBAAgB,KAAhB,gBAAgB,QAahC","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 { BeEvent, JSONSchemaType } from \"@itwin/core-bentley\";\r\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { WorkspaceDb } from \"./Workspace\";\r\nimport { _implementationProhibited } from \"../internal/Symbols\";\r\n\r\n/** The value of a single named parameter within a [[Workspace.settings]] that configures some aspect of the applications run-time behavior.\r\n * Settings are stored in a [[SettingsDictionary]]. A setting is described by its [[SettingSchema]].\r\n * @beta\r\n */\r\nexport type Setting = JSONSchemaType;\r\n\r\n/** @beta */\r\nexport namespace Setting { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  /** Create a deep copy of a [[Setting]]. */\r\n  export function clone<T extends Setting>(setting: T): T {\r\n    if (!setting || typeof setting !== \"object\")\r\n      return setting;\r\n\r\n    const result = Array.isArray(setting) ? [] : {} as any;\r\n    Object.keys(setting).forEach((key: string) => result[key] = clone((setting as any)[key]));\r\n    return result;\r\n  }\r\n\r\n  /** Returns true if `a` and `b` are considered equivalent [[Setting]] values.\r\n   * Settings of primitive types like `number` and `string` are compared using `===`.\r\n   * Settings of type \"object\" are compared by comparing each property using `areEqual`; the objects are considered\r\n   * equal if they have the exact same set of property names with equivalent values.\r\n   * Settings of type \"array\" are compared by comparing each element of the arrays use `areEqual`; the arrays are considered\r\n   * equal if they have the same number of elements with equivalent values in the same exact order.\r\n   */\r\n  export function areEqual(a: Setting | undefined, b: Setting | undefined): boolean {\r\n    if (a === b) {\r\n      return true;\r\n    }\r\n\r\n    // For primitive types, === suffices.\r\n    if (typeof a !== \"object\" || typeof b !== \"object\") {\r\n      return false;\r\n    }\r\n\r\n    if (Array.isArray(a) || Array.isArray(b)) {\r\n      if (!Array.isArray(a) || !Array.isArray(b) || a.length !== b.length) {\r\n        return false;\r\n      }\r\n\r\n      for (let i = 0; i < a.length; i++) {\r\n        if (!areEqual(a[i], b[i])) {\r\n          return false;\r\n        }\r\n      }\r\n\r\n      return true;\r\n    }\r\n\r\n    const aKeys = Object.keys(a);\r\n    const bKeys = Object.keys(b);\r\n    if (aKeys.length !== bKeys.length) {\r\n      return false;\r\n    }\r\n\r\n    aKeys.sort();\r\n    bKeys.sort();\r\n    for (let i = 0; i < aKeys.length; i++) {\r\n      const key = aKeys[i];\r\n      if (key !== bKeys[i]) {\r\n        return false;\r\n      }\r\n\r\n      if (!areEqual((a as SettingsContainer)[key], (b as SettingsContainer)[key])) {\r\n        return false;\r\n      }\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/**\r\n * The name of a [[Setting]].\r\n * Setting names must be [valid JavaScript property names](https://developer.mozilla.org/en-US/docs/Glossary/property/JavaScript) containing no spaces or periods.\r\n * The name of a setting begins with the schema prefix of the [[SettingGroupSchema]] in which its [[SettingSchema]] is defined.\r\n * A setting name therefore forms a path like file names in a file system.\r\n * For example, the following are setting names defined in the `energyAnalysis`, `iot-scan-visualization`, and `vibration-map` schemas.\r\n *\r\n * ```ts\r\n * \"energyAnalysis/formats/totalWork\"\r\n * \"energyAnalysis/formats/totalHours\"\r\n * \"energyAnalysis/units/power\"\r\n * \"energyAnalysis/units/temperature\"\r\n * \"energyAnalysis/startupMode\"\r\n * \"iot-scan-visualization/ports/cameras\"\r\n * \"vibration-map/filters/scope\"\r\n * \"vibration-map/filters/prefabricated\"\r\n * ```\r\n *\r\n * @beta\r\n */\r\nexport type SettingName = string;\r\n\r\n/** An object that defines the values for any number of [[Setting]]s. Each of its properties' names must conform to the semantics of a [[SettingName]].\r\n * @beta\r\n */\r\nexport interface SettingsContainer {\r\n  /** Accesses settings by their names. */\r\n  [name: SettingName]: Setting | undefined;\r\n}\r\n\r\n/** Defines the precedence of a [[SettingsDictionary]].\r\n * [[Settings]] may contain multiple dictionaries containing different values for the same [[SettingName]].\r\n * When resolving the value of a [[Setting]], the value from the highest-priority dictionary is used.\r\n * Priorities are grouped into coarse categories like [[SettingsPriority.application]] and [[SettingsPriority.iModel]].\r\n * Settings with priorities less than or equal to [[SettingsPriority.application]] are stored in [[IModelHost.appWorkspace]], while\r\n * those with priorities higher than [[SettingsPriority.application]] are stored inside [[IModelDb.workspace]].\r\n * @beta\r\n */\r\nexport type SettingsPriority = number;\r\n\r\n/** @beta */\r\nexport namespace SettingsPriority { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  /** Settings that originate from default setting files loaded automatically at the start of a session. */\r\n  export const defaults = 100;\r\n  /** Settings supplied by an application at runtime. */\r\n  export const application = 200;\r\n  /** Settings that apply to all iTwins for an organization. */\r\n  export const organization = 300;\r\n  /** Settings that apply to all iModels in an iTwin. */\r\n  export const iTwin = 400;\r\n  /** Settings that apply to all branches of an iModel. */\r\n  export const branch = 500;\r\n  /** Settings that apply to a specific iModel. */\r\n  export const iModel = 600;\r\n}\r\n\r\n/** A named container that supplies values for [[Setting]]s.\r\n * @see [[Settings.addDictionary]] to register a new settings dictionary.\r\n * @beta\r\n */\r\nexport interface SettingsDictionary {\r\n  /** @internal */\r\n  [_implementationProhibited]: unknown;\r\n\r\n  /** Metadata describing the dictionary. */\r\n  readonly props: SettingsDictionaryProps;\r\n\r\n  /** Obtain a copy of the value of the setting named `settingName` stored in this dictionary, or `undefined` if no such setting exists.\r\n   * The returned value is always cloned using [[Setting.clone]].\r\n   * @note Generally, applications use methods like [[Settings.getString]] and [[Setting.getArray]] to resolve a setting value from multiple\r\n   * dictionaries. Those methods - unlike this one - also validate that `settingName` is of type `T` as defined by its [[SettingSchema]].\r\n   */\r\n  getSetting<T extends Setting>(settingName: SettingName): T | undefined;\r\n}\r\n\r\n/** Uniquely identifies a [[SettingsDictionary]].\r\n * @beta\r\n */\r\nexport interface SettingsDictionarySource {\r\n  /** The name of the dictionary, which must be unique within its [[workspaceDb]], or - if [[workspaceDb]] is undefined - unique among all dictionaries not associated with any [[WorkspaceDb]]. */\r\n  readonly name: string;\r\n  /** The [[WorkspaceDb]] from which the dictionary originated. */\r\n  readonly workspaceDb?: WorkspaceDb;\r\n}\r\n\r\n/** Properties of a [[SettingsDictionary]], defining its name, the [[WorkspaceDb]] (if any) from which it originated, and its [[priority]] relative to other dictionaries.\r\n * @beta\r\n */\r\nexport interface SettingsDictionaryProps extends SettingsDictionarySource {\r\n  /** Precedence value determining which setting value to use when multiple dictionaries supply values for the same [[SettingName]]. */\r\n  readonly priority: SettingsPriority;\r\n}\r\n\r\n/**\r\n * The collection of [[Setting]]s that supply the run-time configuration of a [[Workspace]].\r\n * The `Settings` object comprises a collection of named [[SettingsDictionary]] objects.\r\n * Methods like [[getSetting]], [[getString]], and [[getArray]] provide access to the value of an individual [[Setting]] by searching\r\n * the [[dictionaries]] in order by their [[SettingsPriority]] to find the highest-priority setting with the requested [[SettingName]].\r\n * Most methods that retrieve [[Setting]] values validate them against their [[SettingSchema]]s to ensure that they are of the correct type.\r\n * A [[SettingsDictionary]] can be added or removed using [[addDictionary]] and [[dropDictionary]].\r\n * Because [[Setting]]s can change at any time during the session, you should avoid caching their values wherever possible.\r\n * If you must cache them (for example, to display in a user interface), you should listen for the [[onSettingsChanged]] event to be\r\n * notified of potential changes.\r\n *\r\n * Settings are accessed via [[Workspace.settings]]. They are defined at the application level by [[IModelHost.appWorkspace]], but individual iModels may supply\r\n * additional iModel-specific settings or overrides for application-level settings. When working in the context of a specific iModel, use [[IModelDb.workspace]]'s `settings`\r\n * property. Any settings not overridden by the iModel will fall back to the settings defined in [[IModelHost.appWorkspace]].\r\n *\r\n * Application settings are loaded into [[IModelHost.appWorkspace]] when the session begins (i.e., when [[IModelHost.startup]] is invoked), and unloaded when it ends (in [[IModelHost.shutdown]]).\r\n * They are read from [JSON5](https://json5.org/) files delivered with the application. The application should register any additional [[SettingsDictionary]]'s '(and their corresponding\r\n * [[SettingGroupSchema]]s) at this time.\r\n *\r\n * iModel-specific settings are stored in the iModel's property table and loaded into [[IModelDb.workspace]] when the iModel is first opened.\r\n * You can add and remove a [[SettingsDictionary]] from the property table using [[IModelDb.saveSettingDictionary]] and [[IModelDb.deleteSettingDictionary]].\r\n *\r\n * See the [learning article]($docs/learning/backend/Workspace) for a detailed overiew and examples.\r\n *\r\n * @see [[IModelHost.appWorkspace]] application-wide settings, and [[IModelDb.workspace]] for settings specific to a given iModel.\r\n * @beta\r\n */\r\nexport interface Settings {\r\n  /** @internal */\r\n  [_implementationProhibited]: unknown;\r\n\r\n  /** @internal */\r\n  close(): void;\r\n\r\n  /** The set of settings dictionaries from which [[Setting]] values are obtained, sorted by [[SettingsPriority]].\r\n   * The set can contain at most one dictionary for each unique combination of name and [[WorkspaceDb]].\r\n   * @see [[addDictionary]], [[addFile]], [[addJson]], and [[addDirectory]] to add a new dictionary.\r\n   * @see [[dropDictionary]] to remove a dictionary.\r\n   * @see [[getDictionary]] to look up a dictionary.\r\n   */\r\n  readonly dictionaries: readonly SettingsDictionary[];\r\n\r\n  /** Event raised whenever a [[SettingsDictionary]] is added or removed. */\r\n  readonly onSettingsChanged: BeEvent<() => void>;\r\n\r\n  /** Parses the contents of a local [JSON5](https://json5.org/) file as a [[SettingsContainer]] and invokes [[addDictionary]] to\r\n   * add a [[SettingsDictionary]] named `fileName` with the specified priority.\r\n   * @param fileName the name of a local settings file containing the dictionary.\r\n   * @param priority the priority for the dictionary.\r\n   */\r\n  addFile(fileName: LocalFileName, priority: SettingsPriority): void;\r\n\r\n  /** Invokes [[addFile]] for all files in `directory` with the extension \".json\" or \".json5\". */\r\n  addDirectory(directory: LocalDirName, priority: SettingsPriority): void;\r\n\r\n  /** Parses `settingsJson` as a [[SettingsContainer]] and invokes [[addDictionary]] to add a [[SettingsDictionary]] with the specified `props`.\r\n   * This is typically used when reading dictionaries out of a [[WorkspaceDb]], where they are stored as stringified JSON.\r\n   */\r\n  addJson(props: SettingsDictionaryProps, settingsJson: string): void;\r\n\r\n  /** Find a [[SettingsDictionary]] with the same name and [[WorkspaceDb]] as `source`. */\r\n  getDictionary(source: SettingsDictionarySource): SettingsDictionary | undefined;\r\n\r\n  /** Add a new [[SettingsDictionary]] with the priority, name, and [[WorkspaceDb]] specified by `props` and setting values supplied by `settings`.\r\n   * @note If a dictionary with the same name and [[WorkspaceDb]] already exists, it will be replaced.\r\n   * @see [[addFile]], [[addJson]], and [[addDirectory]] for convenient ways to add dictionaries from various sources.\r\n   */\r\n  addDictionary(props: SettingsDictionaryProps, settings: SettingsContainer): void;\r\n\r\n  /** Removes a previously-added [[SettingsDictionary]]. */\r\n  dropDictionary(props: SettingsDictionarySource): void;\r\n\r\n  /** Looks up the highest priority setting value for a SettingName, falling back to a default value if no value for the setting is found.\r\n   * The [[dictionaries]] are searched in order by [[SettingsPriority]]; the first one that provides a value for `settingName` wins.\r\n   * @param settingName The name of the setting.\r\n   * @param defaultValue value returned if settingName is not present in any [[SettingsDictionary]].\r\n   * @note This method is generic on [[Setting]] type, 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 like [[getString]] and [[getArray]] if you only want the value\r\n   * if its type is correct.\r\n   * @note Unlike [[getArray]], this method does not combine arrays - it ignores [[SettingsSchema.combineArrays]].\r\n   */\r\n  getSetting<T extends Setting>(settingName: SettingName, defaultValue?: T): T | undefined;\r\n\r\n  /** Obtain an iterator over all of the values in the [[dictionaries]] for the [[Setting]] identified by `settingName`, ordered by [[SettingsPriority]]. */\r\n  getSettingEntries<T extends Setting>(settingName: SettingName): Iterable<{ value: T, dictionary: SettingsDictionary}>;\r\n\r\n  /** Obtain an iterator over all of the values in the [[dictionaries]] for the [[Setting]] identified by `settingName`, ordered by [[SettingsPriority]]. */\r\n  getSettingValues<T extends Setting>(settingName: SettingName): Iterable<T>;\r\n\r\n  /** Look up the value of a string [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but 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  /** Look up the value of a boolean [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but 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  /** Look up the value of a numeric [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but 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  /** Look up the value of an object [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but 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  /** Look up the value of an array [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but is not an array.\r\n   */\r\n  getArray<T extends Setting>(settingName: SettingName, defaultValue: Array<T>): Array<T>;\r\n  getArray<T extends Setting>(settingName: SettingName): Array<T> | undefined;\r\n}\r\n"]}
+{"version":3,"file":"Settings.js","sourceRoot":"","sources":["../../../src/workspace/Settings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAQhE,YAAY;AACZ,MAAM,KAAW,OAAO,CA+DvB;AA/DD,WAAiB,OAAO;IACtB,2CAA2C;IAC3C,SAAgB,KAAK,CAAoB,OAAU;QACjD,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ;YACzC,OAAO,OAAO,CAAC;QAEjB,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAS,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAE,OAAe,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1F,OAAO,MAAM,CAAC;IAChB,CAAC;IAPe,aAAK,QAOpB,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,QAAQ,CAAC,CAAsB,EAAE,CAAsB;QACrE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QAED,qCAAqC;QACrC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YACnD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;gBACpE,OAAO,KAAK,CAAC;YACf,CAAC;YAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC1B,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACrB,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrB,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,CAAC,QAAQ,CAAE,CAAuB,CAAC,GAAG,CAAC,EAAG,CAAuB,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBAC5E,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IA5Ce,gBAAQ,WA4CvB,CAAA;AACH,CAAC,EA/DgB,OAAO,KAAP,OAAO,QA+DvB;AA0CD,YAAY;AACZ,MAAM,KAAW,gBAAgB,CAahC;AAbD,WAAiB,gBAAgB;IAC/B,yGAAyG;IAC5F,yBAAQ,GAAG,GAAG,CAAC;IAC5B,sDAAsD;IACzC,4BAAW,GAAG,GAAG,CAAC;IAC/B,6DAA6D;IAChD,6BAAY,GAAG,GAAG,CAAC;IAChC,sDAAsD;IACzC,sBAAK,GAAG,GAAG,CAAC;IACzB,wDAAwD;IAC3C,uBAAM,GAAG,GAAG,CAAC;IAC1B,gDAAgD;IACnC,uBAAM,GAAG,GAAG,CAAC;AAC5B,CAAC,EAbgB,gBAAgB,KAAhB,gBAAgB,QAahC","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 { BeEvent, JSONSchemaType } from \"@itwin/core-bentley\";\r\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { WorkspaceDb } from \"./Workspace\";\r\nimport { _implementationProhibited } from \"../internal/Symbols\";\r\n\r\n/** The value of a single named parameter within a [[Workspace.settings]] that configures some aspect of the applications run-time behavior.\r\n * Settings are stored in a [[SettingsDictionary]]. A setting is described by its [[SettingSchema]].\r\n * @beta\r\n */\r\nexport type Setting = JSONSchemaType;\r\n\r\n/** @beta */\r\nexport namespace Setting { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  /** Create a deep copy of a [[Setting]]. */\r\n  export function clone<T extends Setting>(setting: T): T {\r\n    if (!setting || typeof setting !== \"object\")\r\n      return setting;\r\n\r\n    const result = Array.isArray(setting) ? [] : {} as any;\r\n    Object.keys(setting).forEach((key: string) => result[key] = clone((setting as any)[key]));\r\n    return result;\r\n  }\r\n\r\n  /** Returns true if `a` and `b` are considered equivalent [[Setting]] values.\r\n   * Settings of primitive types like `number` and `string` are compared using `===`.\r\n   * Settings of type \"object\" are compared by comparing each property using `areEqual`; the objects are considered\r\n   * equal if they have the exact same set of property names with equivalent values.\r\n   * Settings of type \"array\" are compared by comparing each element of the arrays use `areEqual`; the arrays are considered\r\n   * equal if they have the same number of elements with equivalent values in the same exact order.\r\n   */\r\n  export function areEqual(a: Setting | undefined, b: Setting | undefined): boolean {\r\n    if (a === b) {\r\n      return true;\r\n    }\r\n\r\n    // For primitive types, === suffices.\r\n    if (typeof a !== \"object\" || typeof b !== \"object\") {\r\n      return false;\r\n    }\r\n\r\n    if (Array.isArray(a) || Array.isArray(b)) {\r\n      if (!Array.isArray(a) || !Array.isArray(b) || a.length !== b.length) {\r\n        return false;\r\n      }\r\n\r\n      for (let i = 0; i < a.length; i++) {\r\n        if (!areEqual(a[i], b[i])) {\r\n          return false;\r\n        }\r\n      }\r\n\r\n      return true;\r\n    }\r\n\r\n    const aKeys = Object.keys(a);\r\n    const bKeys = Object.keys(b);\r\n    if (aKeys.length !== bKeys.length) {\r\n      return false;\r\n    }\r\n\r\n    aKeys.sort();\r\n    bKeys.sort();\r\n    for (let i = 0; i < aKeys.length; i++) {\r\n      const key = aKeys[i];\r\n      if (key !== bKeys[i]) {\r\n        return false;\r\n      }\r\n\r\n      if (!areEqual((a as SettingsContainer)[key], (b as SettingsContainer)[key])) {\r\n        return false;\r\n      }\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/**\r\n * The name of a [[Setting]].\r\n * Setting names must be [valid JavaScript property names](https://developer.mozilla.org/en-US/docs/Glossary/property/JavaScript) containing no spaces or periods.\r\n * The name of a setting begins with the schema prefix of the [[SettingGroupSchema]] in which its [[SettingSchema]] is defined.\r\n * A setting name therefore forms a path like file names in a file system.\r\n * For example, the following are setting names defined in the `energyAnalysis`, `iot-scan-visualization`, and `vibration-map` schemas.\r\n *\r\n * ```ts\r\n * \"energyAnalysis/formats/totalWork\"\r\n * \"energyAnalysis/formats/totalHours\"\r\n * \"energyAnalysis/units/power\"\r\n * \"energyAnalysis/units/temperature\"\r\n * \"energyAnalysis/startupMode\"\r\n * \"iot-scan-visualization/ports/cameras\"\r\n * \"vibration-map/filters/scope\"\r\n * \"vibration-map/filters/prefabricated\"\r\n * ```\r\n *\r\n * @beta\r\n */\r\nexport type SettingName = string;\r\n\r\n/** An object that defines the values for any number of [[Setting]]s. Each of its properties' names must conform to the semantics of a [[SettingName]].\r\n * @beta\r\n */\r\nexport interface SettingsContainer {\r\n  /** Accesses settings by their names. */\r\n  [name: SettingName]: Setting | undefined;\r\n}\r\n\r\n/** Defines the precedence of a [[SettingsDictionary]].\r\n * [[Settings]] may contain multiple dictionaries containing different values for the same [[SettingName]].\r\n * When resolving the value of a [[Setting]], the value from the highest-priority dictionary is used.\r\n * Priorities are grouped into coarse categories like [[SettingsPriority.application]] and [[SettingsPriority.iModel]].\r\n * Settings with priorities less than or equal to [[SettingsPriority.application]] are stored in [[IModelHost.appWorkspace]], while\r\n * those with priorities higher than [[SettingsPriority.application]] are stored inside [[IModelDb.workspace]].\r\n * @beta\r\n */\r\nexport type SettingsPriority = number;\r\n\r\n/** @beta */\r\nexport namespace SettingsPriority { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  /** Settings that originate from default setting files loaded automatically at the start of a session. */\r\n  export const defaults = 100;\r\n  /** Settings supplied by an application at runtime. */\r\n  export const application = 200;\r\n  /** Settings that apply to all iTwins for an organization. */\r\n  export const organization = 300;\r\n  /** Settings that apply to all iModels in an iTwin. */\r\n  export const iTwin = 400;\r\n  /** Settings that apply to all branches of an iModel. */\r\n  export const branch = 500;\r\n  /** Settings that apply to a specific iModel. */\r\n  export const iModel = 600;\r\n}\r\n\r\n/** A named container that supplies values for [[Setting]]s.\r\n * @see [[Settings.addDictionary]] to register a new settings dictionary.\r\n * @beta\r\n */\r\nexport interface SettingsDictionary {\r\n  /** @internal */\r\n  [_implementationProhibited]: unknown;\r\n\r\n  /** Metadata describing the dictionary. */\r\n  readonly props: SettingsDictionaryProps;\r\n\r\n  /** Obtain a copy of the value of the setting named `settingName` stored in this dictionary, or `undefined` if no such setting exists.\r\n   * The returned value is always cloned using [[Setting.clone]].\r\n   * @note Generally, applications use methods like [[Settings.getString]] and [[Setting.getArray]] to resolve a setting value from multiple\r\n   * dictionaries. Those methods - unlike this one - also validate that `settingName` is of type `T` as defined by its [[SettingSchema]].\r\n   */\r\n  getSetting<T extends Setting>(settingName: SettingName): T | undefined;\r\n\r\n  /** Return a deep copy of all settings in this dictionary as a [[SettingsContainer]].\r\n   * This is useful for inspecting the full contents of the dictionary or for building a modified copy\r\n   * to pass to [[EditableSettingsDb.updateSettingsDictionary]].\r\n   * The returned container is cloned using [[Setting.clone]], so callers may freely mutate it without\r\n   * affecting this dictionary's internal state.\r\n   * @beta\r\n   */\r\n  toJSON(): SettingsContainer;\r\n}\r\n\r\n/** Uniquely identifies a [[SettingsDictionary]].\r\n * @beta\r\n */\r\nexport interface SettingsDictionarySource {\r\n  /** The name of the dictionary, which must be unique within its [[workspaceDb]], or - if [[workspaceDb]] is undefined - unique among all dictionaries not associated with any [[WorkspaceDb]]. */\r\n  readonly name: string;\r\n  /** The [[WorkspaceDb]] from which the dictionary originated. */\r\n  readonly workspaceDb?: WorkspaceDb;\r\n}\r\n\r\n/** Properties of a [[SettingsDictionary]], defining its name, the [[WorkspaceDb]] (if any) from which it originated, and its [[priority]] relative to other dictionaries.\r\n * @beta\r\n */\r\nexport interface SettingsDictionaryProps extends SettingsDictionarySource {\r\n  /** Precedence value determining which setting value to use when multiple dictionaries supply values for the same [[SettingName]]. */\r\n  readonly priority: SettingsPriority;\r\n}\r\n\r\n/**\r\n * The collection of [[Setting]]s that supply the run-time configuration of a [[Workspace]].\r\n * The `Settings` object comprises a collection of named [[SettingsDictionary]] objects.\r\n * Methods like [[getSetting]], [[getString]], and [[getArray]] provide access to the value of an individual [[Setting]] by searching\r\n * the [[dictionaries]] in order by their [[SettingsPriority]] to find the highest-priority setting with the requested [[SettingName]].\r\n * Most methods that retrieve [[Setting]] values validate them against their [[SettingSchema]]s to ensure that they are of the correct type.\r\n * A [[SettingsDictionary]] can be added or removed using [[addDictionary]] and [[dropDictionary]].\r\n * Because [[Setting]]s can change at any time during the session, you should avoid caching their values wherever possible.\r\n * If you must cache them (for example, to display in a user interface), you should listen for the [[onSettingsChanged]] event to be\r\n * notified of potential changes.\r\n *\r\n * Settings are accessed via [[Workspace.settings]]. They are defined at the application level by [[IModelHost.appWorkspace]], but individual iModels may supply\r\n * additional iModel-specific settings or overrides for application-level settings. When working in the context of a specific iModel, use [[IModelDb.workspace]]'s `settings`\r\n * property. Any settings not overridden by the iModel will fall back to the settings defined in [[IModelHost.appWorkspace]].\r\n *\r\n * Application settings are loaded into [[IModelHost.appWorkspace]] when the session begins (i.e., when [[IModelHost.startup]] is invoked), and unloaded when it ends (in [[IModelHost.shutdown]]).\r\n * They are read from [JSON5](https://json5.org/) files delivered with the application. The application should register any additional [[SettingsDictionary]]'s '(and their corresponding\r\n * [[SettingGroupSchema]]s) at this time.\r\n *\r\n * iModel-specific settings are stored in the iModel's property table and loaded into [[IModelDb.workspace]] when the iModel is first opened.\r\n * You can add and remove a [[SettingsDictionary]] from the property table using [[IModelDb.saveSettingDictionary]] and [[IModelDb.deleteSettingDictionary]].\r\n *\r\n * See the [learning article]($docs/learning/backend/Workspace) for a detailed overiew and examples.\r\n *\r\n * @see [[IModelHost.appWorkspace]] application-wide settings, and [[IModelDb.workspace]] for settings specific to a given iModel.\r\n * @beta\r\n */\r\nexport interface Settings {\r\n  /** @internal */\r\n  [_implementationProhibited]: unknown;\r\n\r\n  /** @internal */\r\n  close(): void;\r\n\r\n  /** The set of settings dictionaries from which [[Setting]] values are obtained, sorted by [[SettingsPriority]].\r\n   * The set can contain at most one dictionary for each unique combination of name and [[WorkspaceDb]].\r\n   * @see [[addDictionary]], [[addFile]], [[addJson]], and [[addDirectory]] to add a new dictionary.\r\n   * @see [[dropDictionary]] to remove a dictionary.\r\n   * @see [[getDictionary]] to look up a dictionary.\r\n   */\r\n  readonly dictionaries: readonly SettingsDictionary[];\r\n\r\n  /** Event raised whenever a [[SettingsDictionary]] is added or removed. */\r\n  readonly onSettingsChanged: BeEvent<() => void>;\r\n\r\n  /** Parses the contents of a local [JSON5](https://json5.org/) file as a [[SettingsContainer]] and invokes [[addDictionary]] to\r\n   * add a [[SettingsDictionary]] named `fileName` with the specified priority.\r\n   * @param fileName the name of a local settings file containing the dictionary.\r\n   * @param priority the priority for the dictionary.\r\n   */\r\n  addFile(fileName: LocalFileName, priority: SettingsPriority): void;\r\n\r\n  /** Invokes [[addFile]] for all files in `directory` with the extension \".json\" or \".json5\". */\r\n  addDirectory(directory: LocalDirName, priority: SettingsPriority): void;\r\n\r\n  /** Parses `settingsJson` as a [[SettingsContainer]] and invokes [[addDictionary]] to add a [[SettingsDictionary]] with the specified `props`.\r\n   * This is typically used when reading dictionaries out of a [[WorkspaceDb]], where they are stored as stringified JSON.\r\n   */\r\n  addJson(props: SettingsDictionaryProps, settingsJson: string): void;\r\n\r\n  /** Find a [[SettingsDictionary]] with the same name and [[WorkspaceDb]] as `source`. */\r\n  getDictionary(source: SettingsDictionarySource): SettingsDictionary | undefined;\r\n\r\n  /** Add a new [[SettingsDictionary]] with the priority, name, and [[WorkspaceDb]] specified by `props` and setting values supplied by `settings`.\r\n   * @note If a dictionary with the same name and [[WorkspaceDb]] already exists, it will be replaced.\r\n   * @see [[addFile]], [[addJson]], and [[addDirectory]] for convenient ways to add dictionaries from various sources.\r\n   */\r\n  addDictionary(props: SettingsDictionaryProps, settings: SettingsContainer): void;\r\n\r\n  /** Removes a previously-added [[SettingsDictionary]]. */\r\n  dropDictionary(props: SettingsDictionarySource): void;\r\n\r\n  /** Looks up the highest priority setting value for a SettingName, falling back to a default value if no value for the setting is found.\r\n   * The [[dictionaries]] are searched in order by [[SettingsPriority]]; the first one that provides a value for `settingName` wins.\r\n   * @param settingName The name of the setting.\r\n   * @param defaultValue value returned if settingName is not present in any [[SettingsDictionary]].\r\n   * @note This method is generic on [[Setting]] type, 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 like [[getString]] and [[getArray]] if you only want the value\r\n   * if its type is correct.\r\n   * @note Unlike [[getArray]], this method does not combine arrays - it ignores [[SettingsSchema.combineArrays]].\r\n   */\r\n  getSetting<T extends Setting>(settingName: SettingName, defaultValue?: T): T | undefined;\r\n\r\n  /** Obtain an iterator over all of the values in the [[dictionaries]] for the [[Setting]] identified by `settingName`, ordered by [[SettingsPriority]]. */\r\n  getSettingEntries<T extends Setting>(settingName: SettingName): Iterable<{ value: T, dictionary: SettingsDictionary}>;\r\n\r\n  /** Obtain an iterator over all of the values in the [[dictionaries]] for the [[Setting]] identified by `settingName`, ordered by [[SettingsPriority]]. */\r\n  getSettingValues<T extends Setting>(settingName: SettingName): Iterable<T>;\r\n\r\n  /** Look up the value of a string [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but 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  /** Look up the value of a boolean [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but 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  /** Look up the value of a numeric [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but 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  /** Look up the value of an object [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but 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  /** Look up the value of an array [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but is not an array.\r\n   */\r\n  getArray<T extends Setting>(settingName: SettingName, defaultValue: Array<T>): Array<T>;\r\n  getArray<T extends Setting>(settingName: SettingName): Array<T> | undefined;\r\n}\r\n"]}