@theia/core 1.65.0-next.19 → 1.65.0-next.28

package/lib/common/preferences/preference-schema-service.js

@@ -0,0 +1,402 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2025 STMicroelectronics and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PreferenceSchemaServiceImpl = void 0;
+const tslib_1 = require("tslib");
+const inversify_1 = require("inversify");
+const disposable_1 = require("../disposable");
+const event_1 = require("../event");
+const preference_schema_1 = require("./preference-schema");
+const preference_scope_1 = require("./preference-scope");
+const preference_provider_1 = require("./preference-provider");
+const contribution_provider_1 = require("../contribution-provider");
+const promise_util_1 = require("../promise-util");
+const NO_OVERRIDE = {};
+const OVERRIDE_PROPERTY = '\\[(.*)\\]$';
+let PreferenceSchemaServiceImpl = class PreferenceSchemaServiceImpl {
+    constructor() {
+        // Storage structures
+        this.schemas = new Set();
+        this.properties = new Map();
+        /**
+         * This map stores default overrides. The primary map key is the base preference name.
+         * The preference name maps to a second map keyed by the override identifier or a special object value `NO_OVERRIDE',
+         * representing default overrides for the base property. The value in this second map is an array
+         * of entries in reverse order of their insertion. This is necessary becuaus multiple clients might register
+         * overrides for the same preference key/override combination. The elements in this array consist of a unique, generated
+         * identifier and the actual override value. This allows us to always return the last registerd override even
+         * when overrides are later removed.
+         */
+        this.defaultOverrides = new Map();
+        this._overrideIdentifiers = new Set();
+        this.jsonSchemas = [];
+        this._ready = new promise_util_1.Deferred();
+        this.nextSchemaTitle = 1;
+        this.nextOverrideValueId = 1;
+        // Event emitters
+        this.defaultValueChangedEmitter = new event_1.Emitter();
+        this.schemaChangedEmitter = new event_1.Emitter();
+        // Public events
+        this.onDidChangeDefaultValue = this.defaultValueChangedEmitter.event;
+        this.onDidChangeSchema = this.schemaChangedEmitter.event;
+    }
+    get ready() {
+        return this._ready.promise;
+    }
+    get overrideIdentifiers() {
+        return this._overrideIdentifiers;
+    }
+    getSchemaProperties() {
+        return this.properties;
+    }
+    init() {
+        for (const scope of this.validScopes) {
+            this.jsonSchemas[scope] = {
+                type: 'object',
+                properties: {},
+                patternProperties: {},
+                additionalProperties: false
+            };
+        }
+        const promises = [];
+        this.preferenceContributions.getContributions().forEach(contrib => {
+            if (contrib.schema) {
+                this.addSchema(contrib.schema);
+            }
+            if (contrib.initSchema) {
+                promises.push(contrib.initSchema(this));
+            }
+        });
+        Promise.all(promises).then(() => this._ready.resolve());
+    }
+    dispose() {
+        this.defaultValueChangedEmitter.dispose();
+        this.schemaChangedEmitter.dispose();
+    }
+    registerOverrideIdentifier(overrideIdentifier) {
+        if (!this._overrideIdentifiers.has(overrideIdentifier)) {
+            this.addOverrideToJsonSchema(overrideIdentifier);
+            this._overrideIdentifiers.add(overrideIdentifier);
+            this.schemaChangedEmitter.fire();
+            return disposable_1.Disposable.create(() => {
+                if (this._overrideIdentifiers.delete(overrideIdentifier)) {
+                    this.schemaChangedEmitter.fire();
+                }
+            });
+        }
+        return disposable_1.Disposable.NULL;
+    }
+    addSchema(schema) {
+        this.schemas.add(schema);
+        for (const [key, property] of Object.entries(schema.properties)) {
+            if (this.properties.has(key)) {
+                throw new Error(`Property with id '${key}' already exists`);
+            }
+            if (property.scope === undefined) {
+                property.scope = schema.scope;
+            }
+            if (property.overridable === undefined) {
+                property.overridable = schema.defaultOverridable;
+            }
+            this.properties.set(key, property);
+            this.setJSONSchemasProperty(key, property);
+            if (property.default !== undefined) {
+                this.defaultValueChangedEmitter.fire(this.changeFor(key, undefined, this.defaultOverrides.get(key), undefined, property.default));
+            }
+        }
+        this.schemaChangedEmitter.fire();
+        return disposable_1.Disposable.create(() => {
+            if (this.schemas.delete(schema)) {
+                for (const [key, property] of Object.entries(schema.properties)) {
+                    this.deleteFromJSONSchemas(key, property);
+                    this.properties.delete(key);
+                    const overrides = this.defaultOverrides.get(key);
+                    const baseOverride = overrides === null || overrides === void 0 ? void 0 : overrides.get(NO_OVERRIDE);
+                    if (baseOverride !== undefined) {
+                        this.defaultValueChangedEmitter.fire(this.changeFor(key, undefined, overrides, baseOverride, undefined));
+                    }
+                    else if (property.default !== undefined) {
+                        this.defaultValueChangedEmitter.fire(this.changeFor(key, undefined, overrides, property.default, undefined));
+                    }
+                    if (overrides) {
+                        for (const [overrideKey, value] of overrides) {
+                            if (typeof overrideKey === 'string') {
+                                this.defaultValueChangedEmitter.fire(this.changeFor(key, overrideKey, overrides, value[0][1], undefined));
+                            }
+                        }
+                    }
+                }
+                this.schemaChangedEmitter.fire();
+            }
+        });
+    }
+    isValidInScope(preferenceName, scope) {
+        const property = this.properties.get(preferenceName);
+        if (!property) {
+            return false;
+        }
+        // A property is valid in a scope if:
+        // 1. It is included (undefined or true)
+        // 2. Its scope is not defined (valid in all scopes) or its scope includes the given scope
+        return (property.included !== false) &&
+            (property.scope === undefined || property.scope >= scope);
+    }
+    getSchemaProperty(key) {
+        return this.properties.get(key);
+    }
+    updateSchemaProperty(key, property) {
+        var _a;
+        const existing = this.properties.get(key);
+        if (existing) {
+            // Update the property with new values
+            const updatedProperty = { ...existing, ...property };
+            this.properties.set(key, updatedProperty);
+            const hasNoBaseOverrideValue = ((_a = this.defaultOverrides.get(key)) === null || _a === void 0 ? void 0 : _a.get(NO_OVERRIDE)) === undefined;
+            if (hasNoBaseOverrideValue && !preference_provider_1.PreferenceUtils.deepEqual(property.default, existing.default)) {
+                this.defaultValueChangedEmitter.fire(this.changeFor(key, undefined, this.defaultOverrides.get(key), undefined, property.default));
+            }
+            this.setJSONSchemasProperty(key, updatedProperty);
+            this.schemaChangedEmitter.fire();
+        }
+        else {
+            console.warn(`Trying to update non-existent property ${key}`);
+        }
+    }
+    registerOverride(key, overrideIdentifier, value) {
+        const overrideId = overrideIdentifier || NO_OVERRIDE;
+        const property = this.properties.get(key);
+        if (!property) {
+            console.warn(`Trying to register default override for non-existent preference: ${key}`);
+        }
+        else if (!property.overridable && overrideIdentifier) {
+            console.warn(`Trying to register default override for identifier ${overrideIdentifier} for non-overridable preference: ${key}`);
+        }
+        let overrides = this.defaultOverrides.get(key);
+        if (!overrides) {
+            overrides = new Map();
+            this.defaultOverrides.set(key, overrides);
+        }
+        const oldValue = this.getDefaultValue(key, overrideIdentifier);
+        const overrideValueId = this.nextOverrideValueId;
+        let override = overrides.get(overrideId);
+        if (!override) {
+            override = [];
+            overrides.set(overrideId, override);
+        }
+        override.unshift([overrideValueId, value]);
+        // Fire event only if the value actually changed
+        if (!preference_provider_1.PreferenceUtils.deepEqual(oldValue, value)) {
+            const evt = this.changeFor(key, overrideIdentifier, overrides, oldValue, value);
+            this.defaultValueChangedEmitter.fire(evt);
+        }
+        if (property) {
+            this.setJSONSchemasProperty(key, property);
+        }
+        return disposable_1.Disposable.create(() => {
+            this.removeOverride(key, overrideIdentifier, overrideValueId);
+        });
+    }
+    changeFor(key, overrideIdentifier, overrides, oldValue, newValue) {
+        const affectedOverrides = [];
+        if (!overrideIdentifier) {
+            for (const id of this._overrideIdentifiers) {
+                if (!(overrides === null || overrides === void 0 ? void 0 : overrides.has(id))) {
+                    affectedOverrides.push(id);
+                }
+            }
+        }
+        return {
+            key,
+            overrideIdentifier: overrideIdentifier,
+            otherAffectedOverrides: affectedOverrides,
+            oldValue,
+            newValue
+        };
+    }
+    removeOverride(key, overrideIdentifier, overrideValueId) {
+        const overrideId = overrideIdentifier || NO_OVERRIDE;
+        const overrides = this.defaultOverrides.get(key);
+        if (overrides) {
+            const values = overrides.get(overrideId);
+            if (values) {
+                const index = values.findIndex(v => v[0] === overrideValueId);
+                if (index) {
+                    const oldValue = this.getDefaultValue(key, overrideIdentifier);
+                    values.splice(index, 1);
+                    const newValue = this.getDefaultValue(key, overrideIdentifier);
+                    if (!preference_provider_1.PreferenceUtils.deepEqual(oldValue, newValue)) {
+                        const affectedOverrides = [];
+                        if (!overrideIdentifier) {
+                            for (const id of this._overrideIdentifiers) {
+                                if (!overrides.has(id)) {
+                                    affectedOverrides.push(id);
+                                }
+                            }
+                        }
+                        this.defaultValueChangedEmitter.fire({
+                            key,
+                            overrideIdentifier,
+                            otherAffectedOverrides: affectedOverrides,
+                            oldValue,
+                            newValue
+                        });
+                    }
+                }
+                if (values.length === 0) {
+                    overrides.delete(overrideId);
+                }
+            }
+            if (overrides.size === 0) {
+                this.defaultOverrides.delete(key);
+            }
+        }
+    }
+    getDefaultValue(key, overrideIdentifier) {
+        const overrideId = overrideIdentifier || NO_OVERRIDE;
+        const overrides = this.defaultOverrides.get(key);
+        if (overrides) {
+            const values = overrides.get(overrideId);
+            if (values) {
+                return values[0][1]; // there will be no empty values arrays in the data structure
+            }
+        }
+        const property = this.properties.get(key);
+        return property === null || property === void 0 ? void 0 : property.default;
+    }
+    inspectDefaultValue(key, overrideIdentifier) {
+        const overrideId = overrideIdentifier || NO_OVERRIDE;
+        const overrides = this.defaultOverrides.get(key);
+        if (overrides) {
+            const values = overrides.get(overrideId);
+            if (values) {
+                return values[0][1]; // there will be no empty values arrays in the data structure
+            }
+        }
+        if (!overrideIdentifier) {
+            const property = this.properties.get(key);
+            return property === null || property === void 0 ? void 0 : property.default;
+        }
+        return undefined;
+    }
+    getJSONSchema(scope) {
+        return this.jsonSchemas[scope];
+    }
+    setJSONSchemasProperty(key, property) {
+        for (const scope of this.validScopes) {
+            if (this.isValidInScope(key, scope)) {
+                this.setJSONSchemaProperty(this.jsonSchemas[scope], key, property);
+            }
+        }
+    }
+    deleteFromJSONSchemas(key, property) {
+        for (const scope of this.validScopes) {
+            if (this.isValidInScope(key, scope)) {
+                const schema = this.jsonSchemas[scope];
+                for (const name of Object.keys(schema.properties)) {
+                    if (name.match(OVERRIDE_PROPERTY)) {
+                        const value = schema.properties[name];
+                        delete value.properties[key];
+                    }
+                    else {
+                        delete schema.properties[key];
+                    }
+                }
+            }
+        }
+    }
+    setJSONSchemaProperty(schema, key, property) {
+        // Add property to the schema
+        const prop = { ...property, default: this.getDefaultValue(key, undefined) };
+        schema.properties[key] = prop;
+        delete prop['scope'];
+        delete prop['overridable'];
+        if (property.overridable) {
+            for (const overrideIdentifier of this._overrideIdentifiers) {
+                const overrideSchema = schema.properties[`[${overrideIdentifier}]`] || {
+                    type: 'object',
+                    properties: {},
+                    patternProperties: {},
+                    additionalProperties: false
+                };
+                schema.properties[`[${overrideIdentifier}]`] = overrideSchema;
+                overrideSchema.properties[key] = { ...property, default: this.getDefaultValue(key, overrideIdentifier) };
+            }
+        }
+    }
+    addOverrideToJsonSchema(overrideIdentifier) {
+        for (const scope of this.validScopes) {
+            const schema = this.jsonSchemas[scope];
+            const overrideSchema = {
+                type: 'object',
+                properties: {},
+                patternProperties: {},
+                additionalProperties: false
+            };
+            schema.properties[`[${overrideIdentifier}]`] = overrideSchema;
+            for (const [key, property] of this.properties.entries()) {
+                if (property.overridable && this.isValidInScope(key, scope)) {
+                    overrideSchema.properties[key] = { ...property, default: this.getDefaultValue(key, overrideIdentifier) };
+                }
+            }
+        }
+    }
+    getDefaultValues() {
+        const result = {};
+        for (const [key, property] of this.properties.entries()) {
+            if (this.isValidInScope(key, preference_scope_1.PreferenceScope.Default)) {
+                if (property.default !== undefined) {
+                    result[key] = property.default;
+                }
+                const overrides = this.defaultOverrides.get(key);
+                if (overrides) {
+                    for (const [overrideId, values] of overrides.entries()) {
+                        if (overrideId === NO_OVERRIDE) {
+                            result[key] = values[0][1];
+                        }
+                        else {
+                            const overrideKey = `[${overrideId}]`;
+                            const target = result[overrideKey] || {};
+                            target[key] = values[0][1];
+                            result[overrideKey] = target;
+                        }
+                    }
+                }
+            }
+        }
+        return result;
+    }
+};
+exports.PreferenceSchemaServiceImpl = PreferenceSchemaServiceImpl;
+tslib_1.__decorate([
+    (0, inversify_1.inject)(preference_scope_1.ValidPreferenceScopes),
+    tslib_1.__metadata("design:type", Array)
+], PreferenceSchemaServiceImpl.prototype, "validScopes", void 0);
+tslib_1.__decorate([
+    (0, inversify_1.inject)(contribution_provider_1.ContributionProvider),
+    (0, inversify_1.named)(preference_schema_1.PreferenceContribution),
+    tslib_1.__metadata("design:type", Object)
+], PreferenceSchemaServiceImpl.prototype, "preferenceContributions", void 0);
+tslib_1.__decorate([
+    (0, inversify_1.postConstruct)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", void 0)
+], PreferenceSchemaServiceImpl.prototype, "init", null);
+exports.PreferenceSchemaServiceImpl = PreferenceSchemaServiceImpl = tslib_1.__decorate([
+    (0, inversify_1.injectable)()
+], PreferenceSchemaServiceImpl);
+//# sourceMappingURL=preference-schema-service.js.map

package/lib/common/preferences/preference-schema-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"preference-schema-service.js","sourceRoot":"","sources":["../../../src/common/preferences/preference-schema-service.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,oDAAoD;AACpD,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;;;AAEhF,yCAAqE;AACrE,8CAA2C;AAC3C,oCAAmC;AAGnC,2DAA0J;AAC1J,yDAA4E;AAC5E,+DAAwD;AACxD,oEAAgE;AAChE,kDAA2C;AAE3C,MAAM,WAAW,GAAG,EAAE,CAAC;AACvB,MAAM,iBAAiB,GAAG,aAAa,CAAC;AAGjC,IAAM,2BAA2B,GAAjC,MAAM,2BAA2B;IAAjC;QACH,qBAAqB;QACF,YAAO,GAAG,IAAI,GAAG,EAAoB,CAAC;QACtC,eAAU,GAAG,IAAI,GAAG,EAAkC,CAAC;QAC1E;;;;;;;;WAQG;QACgB,qBAAgB,GAAG,IAAI,GAAG,EAAuD,CAAC;QAClF,yBAAoB,GAAG,IAAI,GAAG,EAAU,CAAC;QAEzC,gBAAW,GAAkB,EAAE,CAAC;QAEhC,WAAM,GAAG,IAAI,uBAAQ,EAAE,CAAC;QAcjC,oBAAe,GAAG,CAAC,CAAC;QACpB,wBAAmB,GAAG,CAAC,CAAC;QAElC,iBAAiB;QACE,+BAA0B,GAAG,IAAI,eAAO,EAA4B,CAAC;QACrE,yBAAoB,GAAG,IAAI,eAAO,EAAQ,CAAC;QAE9D,gBAAgB;QACP,4BAAuB,GAAG,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC;QAChE,sBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC;IAyWjE,CAAC;IA9XG,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC/B,CAAC;IAED,IAAI,mBAAmB;QACnB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACrC,CAAC;IAED,mBAAmB;QACf,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAoBS,IAAI;QACV,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG;gBACtB,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;gBACd,iBAAiB,EAAE,EAAE;gBACrB,oBAAoB,EAAE,KAAK;aAC9B,CAAC;QACN,CAAC;QACD,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,IAAI,CAAC,uBAAuB,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC9D,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACjB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACnC,CAAC;YACD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBACrB,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5C,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO;QACH,IAAI,CAAC,0BAA0B,CAAC,OAAO,EAAE,CAAC;QAC1C,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC;IACxC,CAAC;IAED,0BAA0B,CAAC,kBAA0B;QACjD,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACrD,IAAI,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,CAAC;YACjD,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;YAClD,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,CAAC;YAEjC,OAAO,uBAAU,CAAC,MAAM,CAAC,GAAG,EAAE;gBAC1B,IAAI,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBACvD,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,CAAC;gBACrC,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC;QACD,OAAO,uBAAU,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,SAAS,CAAC,MAAwB;QAC9B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEzB,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9D,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3B,MAAM,IAAI,KAAK,CAAC,qBAAqB,GAAG,kBAAkB,CAAC,CAAC;YAChE,CAAC;YAED,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC/B,QAAQ,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;YAClC,CAAC;YAED,IAAI,QAAQ,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACrC,QAAQ,CAAC,WAAW,GAAG,MAAM,CAAC,kBAAkB,CAAC;YACrD,CAAC;YAED,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YACnC,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YAC3C,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBACjC,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,OAAQ,CAAC,CAAC,CAAC;YACvI,CAAC;QAEL,CAAC;QAED,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,CAAC;QAEjC,OAAO,uBAAU,CAAC,MAAM,CAAC,GAAG,EAAE;YAC1B,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC9D,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;oBAC1C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;oBAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBAEjD,MAAM,YAAY,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,WAAW,CAAC,CAAC;oBACjD,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;wBAC7B,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;oBAC7G,CAAC;yBAAM,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;wBACxC,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;oBACjH,CAAC;oBACD,IAAI,SAAS,EAAE,CAAC;wBACZ,KAAK,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,SAAS,EAAE,CAAC;4BAC3C,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;gCAClC,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;4BAC9G,CAAC;wBACL,CAAC;oBACL,CAAC;gBACL,CAAC;gBAED,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,CAAC;YACrC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED,cAAc,CAAC,cAAsB,EAAE,KAAsB;QACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAErD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,qCAAqC;QACrC,wCAAwC;QACxC,0FAA0F;QAC1F,OAAO,CAAC,QAAQ,CAAC,QAAQ,KAAK,KAAK,CAAC;YAChC,CAAC,QAAQ,CAAC,KAAK,KAAK,SAAS,IAAI,QAAQ,CAAC,KAAK,IAAI,KAAK,CAAC,CAAC;IAClE,CAAC;IAED,iBAAiB,CAAC,GAAW;QACzB,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,oBAAoB,CAAC,GAAW,EAAE,QAAgC;;QAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,QAAQ,EAAE,CAAC;YACX,sCAAsC;YACtC,MAAM,eAAe,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAAC;YACrD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;YAC1C,MAAM,sBAAsB,GAAG,CAAA,MAAA,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,0CAAE,GAAG,CAAC,WAAW,CAAC,MAAK,SAAS,CAAC;YAC9F,IAAI,sBAAsB,IAAI,CAAC,qCAAe,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC3F,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,OAAQ,CAAC,CAAC,CAAC;YACvI,CAAC;YAED,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;YAClD,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,CAAC;QACrC,CAAC;aAAM,CAAC;YACJ,OAAO,CAAC,IAAI,CAAC,0CAA0C,GAAG,EAAE,CAAC,CAAC;QAClE,CAAC;IACL,CAAC;IAED,gBAAgB,CAAC,GAAW,EAAE,kBAAsC,EAAE,KAAgB;QAClF,MAAM,UAAU,GAAG,kBAAkB,IAAI,WAAW,CAAC;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,oEAAoE,GAAG,EAAE,CAAC,CAAC;QAC5F,CAAC;aAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,IAAI,kBAAkB,EAAE,CAAC;YACrD,OAAO,CAAC,IAAI,CAAC,sDAAsD,kBAAkB,oCAAoC,GAAG,EAAE,CAAC,CAAC;QACpI,CAAC;QAED,IAAI,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;YACtB,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;QAE/D,MAAM,eAAe,GAAG,IAAI,CAAC,mBAAmB,CAAC;QACjD,IAAI,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,QAAQ,GAAG,EAAE,CAAC;YACd,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACxC,CAAC;QACD,QAAQ,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC;QAE3C,gDAAgD;QAChD,IAAI,CAAC,qCAAe,CAAC,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC;YAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,kBAAkB,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;YAChF,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACX,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,uBAAU,CAAC,MAAM,CAAC,GAAG,EAAE;YAC1B,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,kBAAkB,EAAE,eAAe,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;IACP,CAAC;IAES,SAAS,CAAC,GAAW,EAAE,kBAAsC,EACnE,SAAkE,EAAE,QAA+B,EAAE,QAA+B;QACpI,MAAM,iBAAiB,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACtB,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBACzC,IAAI,CAAC,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,EAAE,CAAC,CAAA,EAAE,CAAC;oBACtB,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAC/B,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO;YACH,GAAG;YACH,kBAAkB,EAAE,kBAAkB;YACtC,sBAAsB,EAAE,iBAAiB;YACzC,QAAQ;YACR,QAAQ;SACX,CAAC;IACN,CAAC;IAES,cAAc,CAAC,GAAW,EAAE,kBAAsC,EAAE,eAAuB;QACjG,MAAM,UAAU,GAAG,kBAAkB,IAAI,WAAW,CAAC;QACrD,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,SAAS,EAAE,CAAC;YACZ,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACzC,IAAI,MAAM,EAAE,CAAC;gBACT,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,eAAe,CAAC,CAAC;gBAC9D,IAAI,KAAK,EAAE,CAAC;oBACR,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;oBAC/D,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;oBACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;oBAC/D,IAAI,CAAC,qCAAe,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC;wBAEjD,MAAM,iBAAiB,GAAG,EAAE,CAAC;wBAC7B,IAAI,CAAC,kBAAkB,EAAE,CAAC;4BACtB,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;gCACzC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;oCACrB,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gCAC/B,CAAC;4BACL,CAAC;wBACL,CAAC;wBAED,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC;4BACjC,GAAG;4BACH,kBAAkB;4BAClB,sBAAsB,EAAE,iBAAiB;4BACzC,QAAQ;4BACR,QAAQ;yBACX,CAAC,CAAC;oBACP,CAAC;gBACL,CAAC;gBACD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACtB,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;gBACjC,CAAC;YACL,CAAC;YACD,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;gBACvB,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACtC,CAAC;QACL,CAAC;IACL,CAAC;IAED,eAAe,CAAC,GAAW,EAAE,kBAAsC;QAC/D,MAAM,UAAU,GAAG,kBAAkB,IAAI,WAAW,CAAC;QACrD,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,SAAS,EAAE,CAAC;YACZ,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACzC,IAAI,MAAM,EAAE,CAAC;gBACT,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,6DAA6D;YACtF,CAAC;QACL,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1C,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,CAAC;IAC7B,CAAC;IAED,mBAAmB,CAAC,GAAW,EAAE,kBAAsC;QACnE,MAAM,UAAU,GAAG,kBAAkB,IAAI,WAAW,CAAC;QACrD,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,SAAS,EAAE,CAAC;YACZ,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACzC,IAAI,MAAM,EAAE,CAAC;gBACT,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,6DAA6D;YACtF,CAAC;QACL,CAAC;QAED,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC1C,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,CAAC;QAC7B,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,aAAa,CAAC,KAAsB;QAChC,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAEO,sBAAsB,CAAC,GAAW,EAAE,QAAgC;QACxE,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnC,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;YACvE,CAAC;QACL,CAAC;IACL,CAAC;IACO,qBAAqB,CAAC,GAAW,EAAE,QAAgC;QACvE,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnC,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC;gBAClC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;gBACvC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAW,CAAC,EAAE,CAAC;oBACjD,IAAI,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC;wBAChC,MAAM,KAAK,GAAG,MAAM,CAAC,UAAW,CAAC,IAAI,CAAgB,CAAC;wBACtD,OAAO,KAAK,CAAC,UAAW,CAAC,GAAG,CAAC,CAAC;oBAClC,CAAC;yBAAM,CAAC;wBACJ,OAAO,MAAM,CAAC,UAAW,CAAC,GAAG,CAAC,CAAC;oBACnC,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAEO,qBAAqB,CAAC,MAAmB,EAAE,GAAW,EAAE,QAAgC;QAC5F,6BAA6B;QAC7B,MAAM,IAAI,GAAG,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,CAAC;QAC5E,MAAM,CAAC,UAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3B,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;YACvB,KAAK,MAAM,kBAAkB,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBACzD,MAAM,cAAc,GAAgB,MAAM,CAAC,UAAW,CAAC,IAAI,kBAAkB,GAAG,CAAC,IAAI;oBACjF,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE,EAAE;oBACd,iBAAiB,EAAE,EAAE;oBACrB,oBAAoB,EAAE,KAAK;iBAC9B,CAAC;gBACF,MAAM,CAAC,UAAW,CAAC,IAAI,kBAAkB,GAAG,CAAC,GAAG,cAAc,CAAC;gBAC/D,cAAc,CAAC,UAAW,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,kBAAkB,CAAC,EAAE,CAAC;YAC9G,CAAC;QACL,CAAC;IACL,CAAC;IAED,uBAAuB,CAAC,kBAA0B;QAC9C,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YACvC,MAAM,cAAc,GAAgB;gBAChC,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;gBACd,iBAAiB,EAAE,EAAE;gBACrB,oBAAoB,EAAE,KAAK;aAC9B,CAAC;YACF,MAAM,CAAC,UAAW,CAAC,IAAI,kBAAkB,GAAG,CAAC,GAAG,cAAc,CAAC;YAC/D,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;gBACtD,IAAI,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC;oBAC1D,cAAc,CAAC,UAAW,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,kBAAkB,CAAC,EAAE,CAAC;gBAC9G,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,gBAAgB;QACZ,MAAM,MAAM,GAAe,EAAE,CAAC;QAE9B,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;YACtD,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,kCAAe,CAAC,OAAO,CAAC,EAAE,CAAC;gBACpD,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;oBACjC,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC;gBACnC,CAAC;gBACD,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACjD,IAAI,SAAS,EAAE,CAAC;oBACZ,KAAK,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,SAAS,CAAC,OAAO,EAAE,EAAE,CAAC;wBACrD,IAAI,UAAU,KAAK,WAAW,EAAE,CAAC;4BAC7B,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;wBAC/B,CAAC;6BAAM,CAAC;4BACJ,MAAM,WAAW,GAAG,IAAI,UAAU,GAAG,CAAC;4BACtC,MAAM,MAAM,GAAe,MAAM,CAAC,WAAW,CAAe,IAAI,EAAE,CAAC;4BACnE,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;4BAC3B,MAAM,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC;wBACjC,CAAC;oBACL,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ,CAAA;AAlZY,kEAA2B;AA4C3B;IADR,IAAA,kBAAM,EAAC,wCAAqB,CAAC;;gEACmB;AAG9B;IADlB,IAAA,kBAAM,EAAC,4CAAoB,CAAC;IAAE,IAAA,iBAAK,EAAC,0CAAsB,CAAC;;4EAC6B;AAG/E;IADT,IAAA,yBAAa,GAAE;;;;uDAoBf;sCArEQ,2BAA2B;IADvC,IAAA,sBAAU,GAAE;GACA,2BAA2B,CAkZvC"}

package/lib/common/preferences/preference-schema.d.ts

@@ -1,62 +1,164 @@
-import { JSONValue } from '@lumino/coreutils';
+import { JSONObject, JSONValue } from '@lumino/coreutils';
 import { IJSONSchema } from '../json-schema';
 import { PreferenceScope } from './preference-scope';
-export interface PreferenceSchema {
-    [name: string]: any;
-    scope?: 'application' | 'window' | 'resource' | PreferenceScope;
-    overridable?: boolean;
+import { Event } from '../event';
+import { Disposable } from '../disposable';
+export declare const PreferenceContribution: unique symbol;
+/**
+ * A {@link PreferenceContribution} allows adding additional custom preferences.
+ * For this, the {@link PreferenceContribution} has to provide a valid `PrefernceSchema` specifying which preferences
+ * are available including their types and description.
+ *
+ * ### Example usage
+ * ```typescript
+ * const MyPreferencesSchema: PreferenceSchema = {
+ *     'scope': PreferenceScope.Folder,
+ *     'properties': {
+ *         'myext.decorations.enabled': {
+ *             'type': 'boolean',
+ *             'description': 'Show file status',
+ *             'default': true
+ *         },
+ *         // [...]
+ *     }
+ * }
+ * @injectable()
+ * export class MyPreferenceContribution implements PreferenceContribution{
+ *     schema= MyPreferencesSchema;
+ * }
+ * ```
+ */
+export interface PreferenceContribution {
+    readonly schema?: PreferenceSchema;
     /**
-     * The title of the preference schema.
-     * It is used in the preference UI to associate a localized group of preferences.
+     * Allows to do additional intialisation of the preference schema, for example registering overrides
+     * @param service the preference schema service
      */
-    title?: string;
-    properties: PreferenceSchemaProperties;
-}
-export declare namespace PreferenceSchema {
-    function is(obj: unknown): obj is PreferenceSchema;
-    function getDefaultScope(schema: PreferenceSchema): PreferenceScope;
-}
-export interface PreferenceSchemaProperties {
-    [name: string]: PreferenceSchemaProperty;
+    initSchema?(service: PreferenceSchemaService): Promise<void>;
 }
-export declare namespace PreferenceSchemaProperties {
-    function is(obj: unknown): obj is PreferenceSchemaProperties;
+export interface IndexedAccess<T> {
+    [name: string]: T;
 }
-export interface PreferenceDataSchema {
-    [name: string]: any;
+export interface PreferenceSchema {
+    /** The default scope for properties in this schema */
     scope?: PreferenceScope;
-    properties: {
-        [name: string]: PreferenceDataProperty;
-    };
-    patternProperties: {
-        [name: string]: PreferenceDataProperty;
-    };
+    /** Optional title to be used in UI */
+    title?: string;
+    /** Whether properties in this schema are overridable by default. Defaults to false. */
+    defaultOverridable?: boolean;
+    properties: IndexedAccess<PreferenceDataProperty>;
 }
-export interface PreferenceItem extends IJSONSchema {
+export interface PreferenceDataProperty extends IJSONSchema {
     /**
-     * preference default value, if `undefined` then `default`
+     * Whether distinct values can be defined for language override identifers. E.g. values valid when editing typescript files vs.
+     * when editing Java files
      */
-    defaultValue?: JSONValue;
     overridable?: boolean;
-    /** If false, the preference will not be included in the schema or the UI. */
+    /** If false, the preference will not be included in the schema or the UI. E.g. OS-Specific prefs */
     included?: boolean;
     /** If true, this item will registered as part of the preference schema, but hidden in the preference editor UI. */
     hidden?: boolean;
-    [key: string]: any;
-}
-export interface PreferenceSchemaProperty extends PreferenceItem {
-    description?: string;
-    markdownDescription?: string;
-    scope?: 'application' | 'machine' | 'window' | 'resource' | 'language-overridable' | 'machine-overridable' | PreferenceScope;
-    tags?: string[];
-}
-export interface PreferenceDataProperty extends PreferenceItem {
-    description?: string;
-    markdownDescription?: string;
+    /** The maximum scope where values for this property can be set. */
     scope?: PreferenceScope;
+    /** Metadata intended for custom renderers */
     typeDetails?: any;
+    /** Tags can be searched for in the UI */
+    tags?: string[];
+}
+export interface DefaultValueChangedEvent {
+    /** The preference key */
+    key: string;
+    /** The override identifier that the default changed for */
+    overrideIdentifier?: string;
+    /**
+     * When the default for the base property changes, indicates which override identifiers will be affected
+     */
+    otherAffectedOverrides: string[];
+    oldValue: JSONValue | undefined;
+    newValue: JSONValue | undefined;
 }
-export declare namespace PreferenceDataProperty {
-    function fromPreferenceSchemaProperty(schemaProps: PreferenceSchemaProperty, defaultScope?: PreferenceScope): PreferenceDataProperty;
+export declare const PreferenceSchemaService: unique symbol;
+export interface PreferenceSchemaService {
+    /**
+     * Resolves after static contributions have been processed
+     */
+    readonly ready: Promise<void>;
+    /**
+     * Register an override identifier for language specific preferences
+     * @param overrideIdentifier The identifier to register
+     * @returns A disposable to unregister the identifier
+     */
+    registerOverrideIdentifier(overrideIdentifier: string): Disposable;
+    readonly overrideIdentifiers: ReadonlySet<string>;
+    /**
+     * Add a preference schema. It is an error to register the same property in two different schemas
+     * @param schema The schema to add
+     * @returns A disposable to remove the schema
+     */
+    addSchema(schema: PreferenceSchema): Disposable;
+    /**
+     * The scopes which this preference schema service handles. Any properties that are not applicable within the
+     * valid scopes will be ignored
+     */
+    readonly validScopes: readonly PreferenceScope[];
+    /**
+     * Check if a preference is valid in a specific scope
+     * @param preferenceName The preference name
+     * @param scope The scope to check
+     * @returns True if the preference is valid in the given scope
+     */
+    isValidInScope(preferenceName: string, scope: PreferenceScope): boolean;
+    getSchemaProperty(key: string): PreferenceDataProperty | undefined;
+    getSchemaProperties(): ReadonlyMap<string, PreferenceDataProperty>;
+    /**
+     * Update a property in the schema. The corresponding JSON Schemas, etc. will be updated
+     * @param key The property key
+     * @param property The updated property
+     */
+    updateSchemaProperty(key: string, property: PreferenceDataProperty): void;
+    /**
+     * Register an override for a preference default value. If multiple overrides are registered for the same value,
+     * the last override will be in effect. Removing the last override will make the second-to-last override active, etc.
+     * @param key The preference key
+     * @param overrideIdentifier The override identifier, undefined for global default
+     * @param value The default value
+     * @returns A disposable to unregister the override
+     */
+    registerOverride(key: string, overrideIdentifier: string | undefined, value: JSONValue): Disposable;
+    /**
+     * Get the default value for a preference. This is the value a client will see for the given key/override
+     * @param key The preference key
+     * @param overrideIdentifier The override identifier, undefined for global default
+     * @returns The default value or undefined if not found
+     */
+    getDefaultValue(key: string, overrideIdentifier: string | undefined): JSONValue | undefined;
+    /**
+     * Gets the default value for a preference. This method not fall back to the global value if no override is given
+     * @param key The preference key
+     * @param overrideIdentifier The override identifier, undefined for global default
+     * @returns The default value or undefined if not found
+     */
+    inspectDefaultValue(key: string, overrideIdentifier: string | undefined): JSONValue | undefined;
+    /**
+     * Gets a JSON schema a preference.json file for the given scope.
+     * @param scope The scope to generate schema for
+     * @returns The JSON schema
+     */
+    getJSONSchema(scope: PreferenceScope): IJSONSchema;
+    /**
+     * Get the collection of all defined default values as JSONObject of the form like in a preferences.json
+     *
+     * #### Example usage
+     * ```json
+     * {
+     *   "my.preference": "a string default",
+     *   "[typescript]": {
+     *      "another.preference": 39
+     *   }
+     * }
+     */
+    getDefaultValues(): JSONObject;
+    onDidChangeDefaultValue: Event<DefaultValueChangedEvent>;
+    onDidChangeSchema: Event<void>;
 }
 //# sourceMappingURL=preference-schema.d.ts.map

package/lib/common/preferences/preference-schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"preference-schema.d.ts","sourceRoot":"","sources":["../../../src/common/preferences/preference-schema.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAGrD,MAAM,WAAW,gBAAgB;IAC7B,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC;IACpB,KAAK,CAAC,EAAE,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,eAAe,CAAC;IAChE,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,0BAA0B,CAAA;CACzC;AACD,yBAAiB,gBAAgB,CAAC;IAC9B,SAAgB,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,gBAAgB,CAExD;IACD,SAAgB,eAAe,CAAC,MAAM,EAAE,gBAAgB,GAAG,eAAe,CAQzE;CACJ;AAED,MAAM,WAAW,0BAA0B;IACvC,CAAC,IAAI,EAAE,MAAM,GAAG,wBAAwB,CAAA;CAC3C;AACD,yBAAiB,0BAA0B,CAAC;IACxC,SAAgB,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,0BAA0B,CAElE;CACJ;AAED,MAAM,WAAW,oBAAoB;IACjC,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC;IACpB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,UAAU,EAAE;QACR,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB,CAAA;KACzC,CAAA;IACD,iBAAiB,EAAE;QACf,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB,CAAA;KACzC,CAAC;CACL;AAED,MAAM,WAAW,cAAe,SAAQ,WAAW;IAC/C;;OAEG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,mHAAmH;IACnH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AACD,MAAM,WAAW,wBAAyB,SAAQ,cAAc;IAC5D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,KAAK,CAAC,EAAE,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,sBAAsB,GAAG,qBAAqB,GAAG,eAAe,CAAC;IAC7H,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,sBAAuB,SAAQ,cAAc;IAC1D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,WAAW,CAAC,EAAE,GAAG,CAAC;CACrB;AACD,yBAAiB,sBAAsB,CAAC;IACpC,SAAgB,4BAA4B,CAAC,WAAW,EAAE,wBAAwB,EAAE,YAAY,GAAE,eAA2C,GAAG,sBAAsB,CAOrK;CACJ"}
+{"version":3,"file":"preference-schema.d.ts","sourceRoot":"","sources":["../../../src/common/preferences/preference-schema.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,eAAO,MAAM,sBAAsB,eAAmC,CAAC;AACvE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,sBAAsB;IACnC,QAAQ,CAAC,MAAM,CAAC,EAAE,gBAAgB,CAAC;IACnC;;;OAGG;IACH,UAAU,CAAC,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC/D;AAED,MAAM,WAAW,aAAa,CAAC,CAAC;IAC5B,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC7B,sDAAsD;IACtD,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uFAAuF;IACvF,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,UAAU,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,sBAAuB,SAAQ,WAAW;IACvD;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oGAAoG;IACpG,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,mHAAmH;IACnH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,mEAAmE;IACnE,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,yCAAyC;IACzC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,wBAAwB;IACrC,yBAAyB;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,2DAA2D;IAC3D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,QAAQ,EAAE,SAAS,GAAG,SAAS,CAAC;IAChC,QAAQ,EAAE,SAAS,GAAG,SAAS,CAAC;CACnC;AAED,eAAO,MAAM,uBAAuB,eAAoC,CAAC;AAEzE,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B;;;;OAIG;IACH,0BAA0B,CAAC,kBAAkB,EAAE,MAAM,GAAG,UAAU,CAAC;IACnE,QAAQ,CAAC,mBAAmB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAElD;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,UAAU,CAAC;IAEhD;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,SAAS,eAAe,EAAE,CAAC;IACjD;;;;;OAKG;IACH,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC;IACxE,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS,CAAC;IACnE,mBAAmB,IAAI,WAAW,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IAEnE;;;;OAIG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAE1E;;;;;;;OAOG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,SAAS,GAAG,UAAU,CAAC;IACpG;;;;;OAKG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;IAC5F;;;;;OAKG;IACH,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;IAEhG;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,eAAe,GAAG,WAAW,CAAC;IACnD;;;;;;;;;;;OAWG;IACH,gBAAgB,IAAI,UAAU,CAAC;IAG/B,uBAAuB,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;IACzD,iBAAiB,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;CAClC"}