@adminide-stack/core 3.1.2-alpha.13 → 3.1.2-alpha.136

package/lib/interfaces/configuration/configurationRegistry.d.ts

@@ -0,0 +1,144 @@
+import { IStringDictionary } from "@vscode-alt/monaco-editor/esm/vs/base/common/collections";
+import { IJSONSchema } from "@vscode-alt/monaco-editor/esm/vs/base/common/jsonSchema";
+import { Event } from '@vscode-alt/monaco-editor/esm/vs/base/common/event';
+import { ConfigurationScope, EditPresentationTypes } from '@workbench-stack/core';
+import { IConfigurationNode, IExtensionInfo, IConfigurationDelta, IConfigurationDefaults, IConfigurationDefaultOverride } from "./configuration";
+export declare type PolicyName = string;
+export interface IPolicy {
+    /**
+     * The policy name.
+     */
+    readonly name: PolicyName;
+    /**
+     * The Code version in which this policy was introduced.
+     */
+    readonly minimumVersion: `${number}.${number}`;
+}
+export interface IConfigurationPropertySchema extends IJSONSchema {
+    scope?: ConfigurationScope;
+    /**
+     * When restricted, value of this configuration will be read only from trusted sources.
+     * For eg., If the workspace is not trusted, then the value of this configuration is not read from workspace settings file.
+     */
+    restricted?: boolean;
+    /**
+     * When `false` this property is excluded from the registry. Default is to include.
+     */
+    included?: boolean;
+    /**
+     * List of tags associated to the property.
+     *  - A tag can be used for filtering
+     *  - Use `experimental` tag for marking the setting as experimental. **Note:** Defaults of experimental settings can be changed by the running experiments.
+     */
+    tags?: string[];
+    /**
+     * When enabled this setting is ignored during sync and user can override this.
+     */
+    ignoreSync?: boolean;
+    /**
+     * When enabled this setting is ignored during sync and user cannot override this.
+     */
+    disallowSyncIgnore?: boolean;
+    /**
+     * Labels for enumeration items
+     */
+    enumItemLabels?: string[];
+    /**
+     * When specified, controls the presentation format of string settings.
+     * Otherwise, the presentation format defaults to `singleline`.
+     */
+    editPresentation?: EditPresentationTypes;
+    /**
+     * When specified, gives an order number for the setting
+     * within the settings editor. Otherwise, the setting is placed at the end.
+     */
+    order?: number;
+    /**
+     * When specified, this setting's value can always be overwritten by
+     * a system-wide policy.
+     */
+    policy?: IPolicy;
+}
+export declare type IRegisteredConfigurationPropertySchema = IConfigurationPropertySchema & {
+    defaultDefaultValue?: any;
+    source?: IExtensionInfo;
+    defaultValueSource?: IExtensionInfo | string;
+};
+export interface IConfigurationRegistry {
+    /**
+     * Register a configuration to the registry.
+     */
+    registerConfiguration(configuration: IConfigurationNode): void;
+    /**
+     * Register multiple configurations to the registry.
+     */
+    registerConfigurations(configurations: IConfigurationNode[], validate?: boolean): void;
+    /**
+     * Deregister multiple configurations from the registry.
+     */
+    deregisterConfigurations(configurations: IConfigurationNode[]): void;
+    /**
+     * update the configuration registry by
+     * 	- registering the configurations to add
+     * 	- dereigstering the configurations to remove
+     */
+    updateConfigurations(configurations: {
+        add: IConfigurationNode[];
+        remove: IConfigurationNode[];
+    }): void;
+    /**
+     * Register multiple default configurations to the registry.
+     */
+    registerDefaultConfigurations(defaultConfigurations: IConfigurationDefaults[]): void;
+    /**
+     * Deregister multiple default configurations from the registry.
+     */
+    deregisterDefaultConfigurations(defaultConfigurations: IConfigurationDefaults[]): void;
+    /**
+     * Bulk update of the configuration registry (default and configurations, remove and add)
+     * @param delta
+     */
+    deltaConfiguration(delta: IConfigurationDelta): void;
+    /**
+     * Return the registered configuration defaults overrides
+     */
+    getConfigurationDefaultsOverrides(): Map<string, IConfigurationDefaultOverride>;
+    /**
+     * Signal that the schema of a configuration setting has changes. It is currently only supported to change enumeration values.
+     * Property or default value changes are not allowed.
+     */
+    notifyConfigurationSchemaUpdated(...configurations: IConfigurationNode[]): void;
+    /**
+     * Event that fires whenever a configuration has been
+     * registered.
+     */
+    readonly onDidSchemaChange: Event<void>;
+    /**
+     * Event that fires whenever a configuration has been
+     * registered.
+     */
+    readonly onDidUpdateConfiguration: Event<{
+        properties: ReadonlySet<string>;
+        defaultsOverrides?: boolean;
+    }>;
+    /**
+     * Returns all configuration nodes contributed to this registry.
+     */
+    getConfigurations(): IConfigurationNode[];
+    /**
+     * Returns all configurations settings of all configuration nodes contributed to this registry.
+     */
+    getConfigurationProperties(): IStringDictionary<IRegisteredConfigurationPropertySchema>;
+    /**
+     * Return all configurations by policy name
+     */
+    getPolicyConfigurations(): Map<PolicyName, string>;
+    /**
+     * Returns all excluded configurations settings of all configuration nodes contributed to this registry.
+     */
+    getExcludedConfigurationProperties(): IStringDictionary<IRegisteredConfigurationPropertySchema>;
+    /**
+     * Register the identifiers for editor configurations
+     */
+    registerOverrideIdentifiers(identifiers: string[]): void;
+}

package/lib/interfaces/configuration/configurationRegistry.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=configurationRegistry.js.map

package/lib/interfaces/configuration/configurationRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configurationRegistry.js","sourceRoot":"","sources":["../../../src/interfaces/configuration/configurationRegistry.ts"],"names":[],"mappings":""}

package/lib/interfaces/configuration/configuraton-service.d.ts

@@ -1,10 +1,10 @@
 import { Event } from '@vscode-alt/monaco-editor/esm/vs/base/common/event';
-import { ConfigurationTarget } from './configuration';
+import { IDisposable } from '@vscode-alt/monaco-editor/esm/vs/base/common/lifecycle';
+import { URI } from '@vscode-alt/monaco-editor/esm/vs/base/common/uri';
+import { ConfigurationTarget, IConfigurationValue } from './configuration';
 import { IConfigurationChangeEvent } from './event';
 import { IConfigurationOverrides, IConfigurationData, IConfigurationModel, IIResourceData, IIConfigurationModel } from '../generated';
-import { IDisposable } from '@vscode-alt/monaco-editor/esm/vs/base/common/lifecycle';
 import { IOrganizationContext } from '../organization';
-import { URI } from '@vscode-alt/monaco-editor/esm/vs/base/common/uri';
 export interface IConfigurationService extends IDisposable {
     onDidChangeConfiguration: Event<IConfigurationChangeEvent>;
     getConfigurationData(): IConfigurationData;
@@ -35,14 +35,7 @@ export interface IConfigurationService extends IDisposable {
      */
     reloadConfiguration(resource: any): Promise<void>;
     initialize(organizationContext: IOrganizationContext): Promise<void>;
-    inspect<T>(key: string, overrides?: IConfigurationOverrides): {
-        default: T;
-        user: T;
-        organization?: T;
-        organizationResource?: T;
-        memory?: T;
-        value: T;
-    };
+    inspect<T>(key: string, overrides?: IConfigurationOverrides): IConfigurationValue<T>;
     keys(): {
         default: string[];
         user: string[];
@@ -55,6 +48,9 @@ export interface IClientConfigurationService extends IConfigurationService {
     externalConfiguration?(resource: URI): IConfigurationModel;
     extAcceptConfigurationChanged(data: IConfigurationData, event: IConfigurationChangeEvent): void;
 }
+export interface IUserClientConfigurationService extends IClientConfigurationService {
+    userId: string;
+}
 export interface IConfigurationMicroserviceEvent {
     onDidChangeConfiguration: (event: IConfigurationChangeEvent) => Promise<void>;
 }

package/lib/interfaces/configuration/event.d.ts

@@ -1,12 +1,9 @@
-import { ConfigurationTarget } from './configuration';
-import { URI } from '@vscode-alt/monaco-editor/esm/vs/base/common/uri';
-import { ResourceMap } from '@vscode-alt/monaco-editor/esm/vs/base/common/map';
-import { IConfigurationModel } from '../generated';
+import { IConfigurationOverrides } from '../generated';
+import { ConfigurationTarget, IConfigurationChange } from './configuration';
 export interface IConfigurationChangeEvent {
-    source: ConfigurationTarget;
-    affectedKeys: string[];
-    affectsConfiguration(configuration: string, resource?: URI): boolean;
-    sourceConfig: any;
-    changedConfiguration: IConfigurationModel;
-    changedConfigurationByResource: ResourceMap<IConfigurationModel>;
+    readonly source: ConfigurationTarget;
+    readonly affectedKeys: string[];
+    readonly change: IConfigurationChange;
+    affectsConfiguration(configuration: string, overrides?: IConfigurationOverrides): boolean;
+    readonly sourceConfig: any;
 }

package/lib/interfaces/configuration/index.d.ts

@@ -3,3 +3,4 @@ export * from './event';
 export * from './configuraton-service';
 export * from './configuration-server-service';
 export * from './configuration-file-service';
+export * from './configurationRegistry';

package/lib/interfaces/configuration/index.js

@@ -19,4 +19,5 @@ __exportStar(require("./event"), exports);
 __exportStar(require("./configuraton-service"), exports);
 __exportStar(require("./configuration-server-service"), exports);
 __exportStar(require("./configuration-file-service"), exports);
+__exportStar(require("./configurationRegistry"), exports);
 //# sourceMappingURL=index.js.map

package/lib/interfaces/configuration/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/configuration/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,0CAAwB;AACxB,yDAAuC;AACvC,iEAA+C;AAC/C,+DAA6C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/configuration/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,0CAAwB;AACxB,yDAAuC;AACvC,iEAA+C;AAC/C,+DAA6C;AAC7C,0DAAwC"}