@theia/core 1.67.0-next.56 → 1.67.0-next.59

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

@@ -0,0 +1,151 @@
+import { Disposable, Event, MaybePromise } from '../../common';
+import { PreferenceService } from './preference-service';
+import { IJSONSchema } from '../../common/json-schema';
+/**
+ * It is worth explaining the type for `PreferenceChangeEvent`:
+ *
+ * // Given T:
+ * type T = { a: string, b: number }
+ *
+ * // We construct a new type such as:
+ * type U = {
+ *     a: {
+ *         preferenceName: 'a'
+ *         newValue: string
+ *         oldValue?: string
+ *     }
+ *     b: {
+ *        preferenceName: 'b'
+ *        newValue: number
+ *        oldValue?: number
+ *     }
+ * }
+ *
+ * // Then we get the union of all values of U by selecting by `keyof T`:
+ * type V = U[keyof T]
+ *
+ * // Implementation:
+ * type PreferenceChangeEvent<T> = {
+ *     // Create a mapping where each key is a key from T,
+ *     // -? normalizes optional typings to avoid getting
+ *     // `undefined` as part of the final union:
+ *     [K in keyof T]-?: {
+ *         // In this object, K will take the value of each
+ *         // independent key from T:
+ *         preferenceName: K
+ *         newValue: T[K]
+ *         oldValue?: T[K]
+ *     // Finally we create the union by doing so:
+ *     }[keyof T]
+ * }
+ */
+/**
+ * Union of all possible key/value pairs for a type `T`
+ */
+export type PreferenceChangeEvent<T> = {
+    affects(resourceUri?: string, overrideIdentifier?: string): boolean;
+} & {
+    [K in keyof T]-?: {
+        readonly preferenceName: K;
+        readonly newValue: T[K];
+        /**
+         * Undefined if the preference is set for the first time.
+         */
+        readonly oldValue?: T[K];
+    };
+}[keyof T];
+export interface PreferenceEventEmitter<T> {
+    readonly onPreferenceChanged: Event<PreferenceChangeEvent<T>>;
+    readonly ready: Promise<void>;
+}
+/**
+ * Generic interface to declare a typesafe get function based on the given
+ * configuration type.
+ *
+ * ### Illustration
+ *
+ * ```ts
+ * interface PreferenceConfiguration {
+ *  'myext.enabled': boolean,
+ * }
+ * const enabled : boolean = prefs.get('myext.enabled'); // valid
+ * const debug : string = prefs.get('myext.enabled'); // invalid
+ * prefs.get('foobar'); // invalid
+ * ```
+ */
+export interface PreferenceRetrieval<T> {
+    get<K extends keyof T>(preferenceName: K | {
+        preferenceName: K;
+        overrideIdentifier?: string;
+    }, defaultValue?: T[K], resourceUri?: string): T[K];
+}
+/**
+ * Typesafe schema-based preferences utility based on the {@link PreferenceService}.
+ * Can be used to get preferences as well as listen to preference changes.
+ *
+ * See {@link createPreferenceProxy} on how to instantiate preference proxies.
+ *
+ * ### Example usage
+ *
+ * ```ts
+ * preferences.onPreferenceChanged(({ preferenceName, newValue }) => { ... });
+ * const enabled = preferences['myext.enabled'];
+ * ```
+ */
+export type PreferenceProxy<T> = Readonly<T> & Disposable & PreferenceEventEmitter<T> & PreferenceRetrieval<T>;
+export declare const PreferenceProxyOptions: unique symbol;
+/**
+ * Proxy configuration parameters.
+ */
+export interface PreferenceProxyOptions {
+    /**
+     * Prefix which is transparently added to all preference identifiers.
+     */
+    prefix?: string;
+    /**
+     * The default resourceUri to use if none was specified when calling "set" or "get".
+     */
+    resourceUri?: string;
+    /**
+     * The overrideIdentifier to use with the underlying preferenceService.
+     * Useful to potentially override existing values while keeping both values in store.
+     *
+     * For example to store different editor settings, e.g. "[markdown].editor.autoIndent",
+     * "[json].editor.autoIndent" and "editor.autoIndent"
+     */
+    overrideIdentifier?: string;
+    /**
+     * Indicates whether '.' in schema properties shall be interpreted as regular names (flat),
+     * as declaring nested objects (deep) or both. Default is flat.
+     *
+     * When 'deep' or 'both' is given, nested preference proxies can be retrieved.
+     */
+    style?: 'flat' | 'deep' | 'both';
+    /**
+     * Indicates whether the proxy should be disposable. Proxies that are shared between multiple callers should not be disposable.
+     */
+    isDisposable?: boolean;
+}
+/**
+ * Creates a preference proxy for typesafe preference handling.
+ *
+ * @param preferences the underlying preference service to use for preference handling.
+ * @param promisedSchema the JSON Schema which describes which preferences are available including types and descriptions. Can be a promise.
+ * @param options configuration options.
+ *
+ * @returns the created preference proxy.
+ *
+ * ### Usage
+ *
+ *  1. Create JSON Schema specifying your preferences
+ *  2. Create Configuration type based on the JSON Schema
+ *  3. Bind the return value of `createPreferenceProxy` to make your preferences available wherever needed.
+ *
+ * See {@link CorePreferences} for an example.
+ *
+ * Note that if `schema` is a Promise, most actions will be no-ops until the promise is resolved.
+ *
+ * @deprecated @since 1.23.0 use `PreferenceProxyFactory` instead.
+ */
+export declare function createPreferenceProxy<T>(preferences: PreferenceService, promisedSchema: MaybePromise<IJSONSchema>, options?: PreferenceProxyOptions): PreferenceProxy<T>;
+//# sourceMappingURL=preference-proxy.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"preference-proxy.d.ts","sourceRoot":"","sources":["../../../src/common/preferences/preference-proxy.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAY,YAAY,EAAE,MAAM,cAAc,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAIvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAAC,CAAC,IAAI;IACnC,OAAO,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACvE,GAAG;KACC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG;QACd,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAC;QAC3B,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACxB;;WAEG;QAEH,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;KAC5B;CACJ,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACrC,QAAQ,CAAC,mBAAmB,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CACjC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC;IAClC,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG;QACvC,cAAc,EAAE,CAAC,CAAC;QAClB,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAC9B,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;CACvD;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,UAAU,GAAG,sBAAsB,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;AAC/G,eAAO,MAAM,sBAAsB,eAAmC,CAAC;AACvE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACjC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,WAAW,EAAE,iBAAiB,EAAE,cAAc,EAAE,YAAY,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,eAAe,CAAC,CAAC,CAAC,CA8LxK"}

package/lib/common/preferences/preference-proxy.js

@@ -0,0 +1,230 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2018 TypeFox 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.createPreferenceProxy = exports.PreferenceProxyOptions = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const common_1 = require("../../common");
+const preference_scope_1 = require("./preference-scope");
+const promise_util_1 = require("../../common/promise-util");
+const preference_language_override_service_1 = require("../../common/preferences/preference-language-override-service");
+exports.PreferenceProxyOptions = Symbol('PreferenceProxyOptions');
+/**
+ * Creates a preference proxy for typesafe preference handling.
+ *
+ * @param preferences the underlying preference service to use for preference handling.
+ * @param promisedSchema the JSON Schema which describes which preferences are available including types and descriptions. Can be a promise.
+ * @param options configuration options.
+ *
+ * @returns the created preference proxy.
+ *
+ * ### Usage
+ *
+ *  1. Create JSON Schema specifying your preferences
+ *  2. Create Configuration type based on the JSON Schema
+ *  3. Bind the return value of `createPreferenceProxy` to make your preferences available wherever needed.
+ *
+ * See {@link CorePreferences} for an example.
+ *
+ * Note that if `schema` is a Promise, most actions will be no-ops until the promise is resolved.
+ *
+ * @deprecated @since 1.23.0 use `PreferenceProxyFactory` instead.
+ */
+function createPreferenceProxy(preferences, promisedSchema, options) {
+    const opts = options || {};
+    const prefix = opts.prefix || '';
+    const style = opts.style || 'flat';
+    const isDeep = style === 'deep' || style === 'both';
+    const isFlat = style === 'both' || style === 'flat';
+    let schema;
+    if (!(0, promise_util_1.isThenable)(promisedSchema)) {
+        schema = promisedSchema;
+    }
+    else {
+        promisedSchema.then((s) => schema = s);
+    }
+    const onPreferenceChanged = (listener, thisArgs, disposables) => preferences.onPreferencesChanged(changes => {
+        if (schema) {
+            for (const key of Object.keys(changes)) {
+                const e = changes[key];
+                const overridden = preferences.overriddenPreferenceName(e.preferenceName);
+                const preferenceName = overridden ? overridden.preferenceName : e.preferenceName;
+                if (preferenceName.startsWith(prefix) && (!opts.overrideIdentifier || (overridden === null || overridden === void 0 ? void 0 : overridden.overrideIdentifier) === opts.overrideIdentifier)) {
+                    if (schema.properties && schema.properties[preferenceName]) {
+                        const { newValue, oldValue } = e;
+                        listener({
+                            newValue: newValue, oldValue: oldValue, preferenceName: preferenceName,
+                            affects: (resourceUri, overrideIdentifier) => {
+                                if (overrideIdentifier !== (overridden === null || overridden === void 0 ? void 0 : overridden.overrideIdentifier)) {
+                                    return false;
+                                }
+                                return e.affects(resourceUri);
+                            }
+                        });
+                    }
+                }
+            }
+        }
+    }, thisArgs, disposables);
+    const unsupportedOperation = (_, __) => {
+        throw new Error('Unsupported operation');
+    };
+    const getValue = (arg, defaultValue, resourceUri) => {
+        const preferenceName = preference_language_override_service_1.OverridePreferenceName.is(arg) ?
+            preferences.overridePreferenceName(arg) :
+            arg;
+        return preferences.get(preferenceName, defaultValue, resourceUri || opts.resourceUri);
+    };
+    const ownKeys = () => {
+        const properties = [];
+        if (schema && schema.properties) {
+            for (const p of Object.keys(schema.properties)) {
+                if (p.startsWith(prefix)) {
+                    const idx = p.indexOf('.', prefix.length);
+                    if (idx !== -1 && isDeep) {
+                        const pre = p.substring(prefix.length, idx);
+                        if (properties.indexOf(pre) === -1) {
+                            properties.push(pre);
+                        }
+                    }
+                    const prop = p.substring(prefix.length);
+                    if (isFlat || prop.indexOf('.') === -1) {
+                        properties.push(prop);
+                    }
+                }
+            }
+        }
+        return properties;
+    };
+    const set = (_, property, value) => {
+        if (typeof property !== 'string') {
+            throw new Error(`unexpected property: ${String(property)}`);
+        }
+        if (style === 'deep' && property.indexOf('.') !== -1) {
+            return false;
+        }
+        if (schema && schema.properties) {
+            const fullProperty = prefix ? prefix + property : property;
+            if (schema.properties[fullProperty]) {
+                preferences.set(fullProperty, value, preference_scope_1.PreferenceScope.Default);
+                return true;
+            }
+            const newPrefix = fullProperty + '.';
+            for (const p of Object.keys(schema.properties)) {
+                if (p.startsWith(newPrefix)) {
+                    const subProxy = createPreferenceProxy(preferences, schema, {
+                        prefix: newPrefix,
+                        resourceUri: opts.resourceUri,
+                        overrideIdentifier: opts.overrideIdentifier,
+                        style
+                    });
+                    for (const k of Object.keys(value)) {
+                        subProxy[k] = value[k];
+                    }
+                }
+            }
+        }
+        return false;
+    };
+    const get = (_, property) => {
+        if (typeof property !== 'string') {
+            throw new Error(`unexpected property: ${String(property)}`);
+        }
+        const fullProperty = prefix ? prefix + property : property;
+        if (schema && schema.properties) {
+            if (isFlat || property.indexOf('.') === -1) {
+                if (schema.properties[fullProperty]) {
+                    let value;
+                    if (opts.overrideIdentifier) {
+                        value = preferences.get(preferences.overridePreferenceName({
+                            overrideIdentifier: opts.overrideIdentifier,
+                            preferenceName: fullProperty
+                        }), undefined, opts.resourceUri);
+                    }
+                    if (value === undefined) {
+                        value = preferences.get(fullProperty, undefined, opts.resourceUri);
+                    }
+                    return value;
+                }
+            }
+        }
+        if (property === 'onPreferenceChanged') {
+            return onPreferenceChanged;
+        }
+        if (property === 'dispose') {
+            return () => { };
+        }
+        if (property === 'ready') {
+            return preferences.ready;
+        }
+        if (property === 'get') {
+            return getValue;
+        }
+        if (property === 'toJSON') {
+            return toJSON();
+        }
+        if (schema && schema.properties && isDeep) {
+            const newPrefix = fullProperty + '.';
+            for (const p of Object.keys(schema.properties)) {
+                if (p.startsWith(newPrefix)) {
+                    return createPreferenceProxy(preferences, schema, { prefix: newPrefix, resourceUri: opts.resourceUri, overrideIdentifier: opts.overrideIdentifier, style });
+                }
+            }
+            let value;
+            let parentSegment = fullProperty;
+            const segments = [];
+            do {
+                const index = parentSegment.lastIndexOf('.');
+                segments.push(parentSegment.substring(index + 1));
+                parentSegment = parentSegment.substring(0, index);
+                if (parentSegment in schema.properties) {
+                    value = get(_, parentSegment);
+                }
+            } while (parentSegment && value === undefined);
+            let segment;
+            while ((0, common_1.isObject)(value) && (segment = segments.pop())) {
+                value = value[segment];
+            }
+            return segments.length ? undefined : value;
+        }
+        return undefined;
+    };
+    const toJSON = () => {
+        const result = {};
+        for (const k of ownKeys()) {
+            result[k] = get(undefined, k);
+        }
+        return result;
+    };
+    return new Proxy({}, {
+        get,
+        ownKeys,
+        getOwnPropertyDescriptor: (_, property) => {
+            if (ownKeys().indexOf(property) !== -1) {
+                return {
+                    enumerable: true,
+                    configurable: true
+                };
+            }
+            return {};
+        },
+        set,
+        deleteProperty: unsupportedOperation,
+        defineProperty: unsupportedOperation
+    });
+}
+exports.createPreferenceProxy = createPreferenceProxy;
+//# sourceMappingURL=preference-proxy.js.map

package/lib/common/preferences/preference-proxy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"preference-proxy.js","sourceRoot":"","sources":["../../../src/common/preferences/preference-proxy.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yCAAyC;AACzC,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,uDAAuD;AAEvD,yCAAyE;AAEzE,yDAAqD;AAErD,4DAAuD;AACvD,wHAAuG;AAmG1F,QAAA,sBAAsB,GAAG,MAAM,CAAC,wBAAwB,CAAC,CAAC;AAkCvE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,qBAAqB,CAAI,WAA8B,EAAE,cAAyC,EAAE,OAAgC;IAChJ,MAAM,IAAI,GAAG,OAAO,IAAI,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;IACjC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC;IACnC,MAAM,MAAM,GAAG,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,MAAM,CAAC;IACpD,MAAM,MAAM,GAAG,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,MAAM,CAAC;IACpD,IAAI,MAA+B,CAAC;IACpC,IAAI,CAAC,IAAA,yBAAU,EAAC,cAAc,CAAC,EAAE,CAAC;QAC9B,MAAM,GAAG,cAA6B,CAAC;IAC3C,CAAC;SAAM,CAAC;QACJ,cAAc,CAAC,IAAI,CAAC,CAAC,CAAc,EAAE,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACxD,CAAC;IACD,MAAM,mBAAmB,GAAG,CAAC,QAA8C,EAAE,QAAc,EAAE,WAA0B,EAAE,EAAE,CAAC,WAAW,CAAC,oBAAoB,CAAC,OAAO,CAAC,EAAE;QACnK,IAAI,MAAM,EAAE,CAAC;YACT,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;gBACrC,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;gBACvB,MAAM,UAAU,GAAG,WAAW,CAAC,wBAAwB,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;gBAC1E,MAAM,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;gBACjF,IAAI,cAAc,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,kBAAkB,MAAK,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBAChI,IAAI,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;wBACzD,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;wBACjC,QAAQ,CAAC;4BACL,QAAQ,EAAE,QAAsB,EAAE,QAAQ,EAAE,QAAsB,EAAE,cAAc,EAAE,cAAyB;4BAC7G,OAAO,EAAE,CAAC,WAAW,EAAE,kBAAkB,EAAE,EAAE;gCACzC,IAAI,kBAAkB,MAAK,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,kBAAkB,CAAA,EAAE,CAAC;oCACxD,OAAO,KAAK,CAAC;gCACjB,CAAC;gCACD,OAAO,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;4BAClC,CAAC;yBACJ,CAAC,CAAC;oBACP,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;IAE1B,MAAM,oBAAoB,GAAG,CAAC,CAAM,EAAE,EAAU,EAAE,EAAE;QAChD,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAC7C,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAoC,CAAC,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,EAAE;QACjF,MAAM,cAAc,GAAG,6DAAsB,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YACnD,WAAW,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC;YACjC,GAAG,CAAC;QAChB,OAAO,WAAW,CAAC,GAAG,CAAC,cAAc,EAAE,YAAY,EAAE,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC;IAC1F,CAAC,CAAC;IAEF,MAAM,OAAO,GAAmB,GAAG,EAAE;QACjC,MAAM,UAAU,GAAG,EAAE,CAAC;QACtB,IAAI,MAAM,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YAC9B,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7C,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;oBACvB,MAAM,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;oBAC1C,IAAI,GAAG,KAAK,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC;wBACvB,MAAM,GAAG,GAAG,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;wBAC5C,IAAI,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;4BACjC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;wBACzB,CAAC;oBACL,CAAC;oBACD,MAAM,IAAI,GAAG,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBACxC,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;wBACrC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC1B,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;IAEF,MAAM,GAAG,GAAsE,CAAC,CAAC,EAAE,QAAkC,EAAE,KAAU,EAAE,EAAE;QACjI,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,wBAAwB,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,KAAK,KAAK,MAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YACnD,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,IAAI,MAAM,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YAC9B,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;YAC3D,IAAI,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;gBAClC,WAAW,CAAC,GAAG,CAAC,YAAY,EAAE,KAAK,EAAE,kCAAe,CAAC,OAAO,CAAC,CAAC;gBAC9D,OAAO,IAAI,CAAC;YAChB,CAAC;YACD,MAAM,SAAS,GAAG,YAAY,GAAG,GAAG,CAAC;YACrC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7C,IAAI,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC1B,MAAM,QAAQ,GAAyB,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE;wBAC9E,MAAM,EAAE,SAAS;wBACjB,WAAW,EAAE,IAAI,CAAC,WAAW;wBAC7B,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;wBAC3C,KAAK;qBACR,CAAC,CAAC;oBACH,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;wBACjC,QAAQ,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;oBAC3B,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC,CAAC;IAEF,MAAM,GAAG,GAAuC,CAAC,CAAC,EAAE,QAAkC,EAAE,EAAE;QACtF,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,wBAAwB,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAChE,CAAC;QACD,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC3D,IAAI,MAAM,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YAC9B,IAAI,MAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACzC,IAAI,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;oBAClC,IAAI,KAAK,CAAC;oBACV,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;wBAC1B,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,sBAAsB,CAAC;4BACvD,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;4BAC3C,cAAc,EAAE,YAAY;yBAC/B,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;oBACrC,CAAC;oBACD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;wBACtB,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,YAAY,EAAE,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;oBACvE,CAAC;oBACD,OAAO,KAAK,CAAC;gBACjB,CAAC;YACL,CAAC;QACL,CAAC;QACD,IAAI,QAAQ,KAAK,qBAAqB,EAAE,CAAC;YACrC,OAAO,mBAAmB,CAAC;QAC/B,CAAC;QACD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,GAAG,EAAE,GAAoB,CAAC,CAAC;QACtC,CAAC;QACD,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;YACvB,OAAO,WAAW,CAAC,KAAK,CAAC;QAC7B,CAAC;QACD,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACrB,OAAO,QAAQ,CAAC;QACpB,CAAC;QACD,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACxB,OAAO,MAAM,EAAE,CAAC;QACpB,CAAC;QACD,IAAI,MAAM,IAAI,MAAM,CAAC,UAAU,IAAI,MAAM,EAAE,CAAC;YACxC,MAAM,SAAS,GAAG,YAAY,GAAG,GAAG,CAAC;YACrC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7C,IAAI,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC1B,OAAO,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,EAAE,KAAK,EAAE,CAAC,CAAC;gBAChK,CAAC;YACL,CAAC;YAED,IAAI,KAAK,CAAC;YACV,IAAI,aAAa,GAAG,YAAY,CAAC;YACjC,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,GAAG,CAAC;gBACA,MAAM,KAAK,GAAG,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC7C,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;gBAClD,aAAa,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBAClD,IAAI,aAAa,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;oBACrC,KAAK,GAAG,GAAG,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;gBAClC,CAAC;YACL,CAAC,QAAQ,aAAa,IAAI,KAAK,KAAK,SAAS,EAAE;YAE/C,IAAI,OAAO,CAAC;YACZ,OAAO,IAAA,iBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;gBACnD,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;YAC3B,CAAC;YACD,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;QAC/C,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,GAAG,EAAE;QAChB,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,EAAE,CAAC;YACxB,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC;IAEF,OAAO,IAAI,KAAK,CAAC,EAAE,EAAE;QACjB,GAAG;QACH,OAAO;QACP,wBAAwB,EAAE,CAAC,CAAC,EAAE,QAAgB,EAAE,EAAE;YAC9C,IAAI,OAAO,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACrC,OAAO;oBACH,UAAU,EAAE,IAAI;oBAChB,YAAY,EAAE,IAAI;iBACrB,CAAC;YACN,CAAC;YACD,OAAO,EAAE,CAAC;QACd,CAAC;QACD,GAAG;QACH,cAAc,EAAE,oBAAoB;QACpC,cAAc,EAAE,oBAAoB;KACvC,CAAC,CAAC;AACP,CAAC;AA9LD,sDA8LC"}

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

@@ -0,0 +1,57 @@
+import { Disposable } from '../disposable';
+import { Emitter } from '../event';
+import { IJSONSchema } from '../json-schema';
+import { JSONObject, JSONValue } from '@lumino/coreutils';
+import { PreferenceDataProperty, PreferenceSchema, PreferenceSchemaService, DefaultValueChangedEvent, PreferenceContribution } from './preference-schema';
+import { PreferenceScope } from './preference-scope';
+import { ContributionProvider } from '../contribution-provider';
+import { Deferred } from '../promise-util';
+export declare const NO_OVERRIDE: {};
+export declare const OVERRIDE_PROPERTY = "\\[(.*)\\]$";
+export declare class PreferenceSchemaServiceImpl implements PreferenceSchemaService {
+    protected readonly schemas: Set<PreferenceSchema>;
+    protected readonly properties: Map<string, PreferenceDataProperty>;
+    /**
+     * 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.
+     */
+    protected readonly defaultOverrides: Map<string, Map<string | object, [number, JSONValue][]>>;
+    protected readonly _overrideIdentifiers: Set<string>;
+    protected readonly jsonSchemas: IJSONSchema[];
+    protected readonly _ready: Deferred<void>;
+    get ready(): Promise<void>;
+    get overrideIdentifiers(): ReadonlySet<string>;
+    getSchemaProperties(): ReadonlyMap<string, PreferenceDataProperty>;
+    protected nextSchemaTitle: number;
+    protected nextOverrideValueId: number;
+    protected readonly defaultValueChangedEmitter: Emitter<DefaultValueChangedEvent>;
+    protected readonly schemaChangedEmitter: Emitter<void>;
+    readonly onDidChangeDefaultValue: import("../event").Event<DefaultValueChangedEvent>;
+    readonly onDidChangeSchema: import("../event").Event<void>;
+    readonly validScopes: readonly PreferenceScope[];
+    protected readonly preferenceContributions: ContributionProvider<PreferenceContribution>;
+    protected init(): void;
+    dispose(): void;
+    registerOverrideIdentifier(overrideIdentifier: string): Disposable;
+    addSchema(schema: PreferenceSchema): Disposable;
+    isValidInScope(preferenceName: string, scope: PreferenceScope): boolean;
+    getSchemaProperty(key: string): PreferenceDataProperty | undefined;
+    updateSchemaProperty(key: string, property: PreferenceDataProperty): void;
+    registerOverride(key: string, overrideIdentifier: string | undefined, value: JSONValue): Disposable;
+    protected changeFor(key: string, overrideIdentifier: string | undefined, overrides: Map<string | object, [number, JSONValue][]> | undefined, oldValue: JSONValue | undefined, newValue: JSONValue | undefined): DefaultValueChangedEvent;
+    protected removeOverride(key: string, overrideIdentifier: string | undefined, overrideValueId: number): void;
+    getDefaultValue(key: string, overrideIdentifier: string | undefined): JSONValue | undefined;
+    inspectDefaultValue(key: string, overrideIdentifier: string | undefined): JSONValue | undefined;
+    getJSONSchema(scope: PreferenceScope): IJSONSchema;
+    protected setJSONSchemasProperty(key: string, property: PreferenceDataProperty): void;
+    protected deleteFromJSONSchemas(key: string, property: PreferenceDataProperty): void;
+    protected setJSONSchemaProperty(schema: IJSONSchema, key: string, property: PreferenceDataProperty): void;
+    addOverrideToJsonSchema(overrideIdentifier: string): void;
+    getDefaultValues(): JSONObject;
+}
+//# sourceMappingURL=preference-schema-service.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"preference-schema-service.d.ts","sourceRoot":"","sources":["../../../src/common/preferences/preference-schema-service.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAC1J,OAAO,EAAE,eAAe,EAAyB,MAAM,oBAAoB,CAAC;AAE5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,eAAO,MAAM,WAAW,IAAK,CAAC;AAC9B,eAAO,MAAM,iBAAiB,gBAAgB,CAAC;AAE/C,qBACa,2BAA4B,YAAW,uBAAuB;IAEvE,SAAS,CAAC,QAAQ,CAAC,OAAO,wBAA+B;IACzD,SAAS,CAAC,QAAQ,CAAC,UAAU,sCAA6C;IAC1E;;;;;;;;OAQG;IACH,SAAS,CAAC,QAAQ,CAAC,gBAAgB,2DAAkE;IACrG,SAAS,CAAC,QAAQ,CAAC,oBAAoB,cAAqB;IAE5D,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,WAAW,EAAE,CAAM;IAEnD,SAAS,CAAC,QAAQ,CAAC,MAAM,iBAAkB;IAE3C,IAAI,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAEzB;IAED,IAAI,mBAAmB,IAAI,WAAW,CAAC,MAAM,CAAC,CAE7C;IAED,mBAAmB,IAAI,WAAW,CAAC,MAAM,EAAE,sBAAsB,CAAC;IAIlE,SAAS,CAAC,eAAe,SAAK;IAC9B,SAAS,CAAC,mBAAmB,SAAK;IAGlC,SAAS,CAAC,QAAQ,CAAC,0BAA0B,oCAA2C;IACxF,SAAS,CAAC,QAAQ,CAAC,oBAAoB,gBAAuB;IAG9D,QAAQ,CAAC,uBAAuB,qDAAyC;IACzE,QAAQ,CAAC,iBAAiB,iCAAmC;IAG7D,QAAQ,CAAC,WAAW,EAAE,SAAS,eAAe,EAAE,CAAC;IAGjD,SAAS,CAAC,QAAQ,CAAC,uBAAuB,EAAE,oBAAoB,CAAC,sBAAsB,CAAC,CAAC;IAGzF,SAAS,CAAC,IAAI,IAAI,IAAI;IAqBtB,OAAO,IAAI,IAAI;IAKf,0BAA0B,CAAC,kBAAkB,EAAE,MAAM,GAAG,UAAU;IAelE,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,UAAU;IAsD/C,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO;IAcvE,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS;IAIlE,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,sBAAsB,GAAG,IAAI;IAkBzE,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,SAAS,GAAG,UAAU;IAwCnG,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,SAAS,EACnE,SAAS,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,SAAS,GAAG,SAAS,EAAE,QAAQ,EAAE,SAAS,GAAG,SAAS,GAAG,wBAAwB;IAkBnK,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,SAAS,EAAE,eAAe,EAAE,MAAM,GAAG,IAAI;IAyC5G,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS;IAc3F,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS;IAiB/F,aAAa,CAAC,KAAK,EAAE,eAAe,GAAG,WAAW;IAIlD,SAAS,CAAC,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,sBAAsB,GAAG,IAAI;IAOrF,SAAS,CAAC,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,sBAAsB,GAAG,IAAI;IAgBpF,SAAS,CAAC,qBAAqB,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,sBAAsB,GAAG,IAAI;IAoBzG,uBAAuB,CAAC,kBAAkB,EAAE,MAAM,GAAG,IAAI;IAkBzD,gBAAgB,IAAI,UAAU;CA0BjC"}