@theia/plugin 1.29.0-next.4 → 1.29.0-next.41

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.29.0-next.4+0c0f8c7a7ae",
+  "version": "1.29.0-next.41+3f98d628b3c",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "0c0f8c7a7aedd67930bf65d6f63d827721707d60"
+  "gitHead": "3f98d628b3c0f76cddde3d7194a2c931ac06931a"
 }

package/src/theia-proposed.d.ts

@@ -21,130 +21,6 @@
  * These API are NOT stable and subject to change. Use it on own risk.
  */
 export module '@theia/plugin' {
-    // #region auth provider
-
-    /**
-     * An [event](#Event) which fires when an [AuthenticationProvider](#AuthenticationProvider) is added or removed.
-     */
-    export interface AuthenticationProvidersChangeEvent {
-        /**
-         * The ids of the [authenticationProvider](#AuthenticationProvider)s that have been added.
-         */
-        readonly added: ReadonlyArray<AuthenticationProviderInformation>;
-
-        /**
-         * The ids of the [authenticationProvider](#AuthenticationProvider)s that have been removed.
-         */
-        readonly removed: ReadonlyArray<AuthenticationProviderInformation>;
-    }
-
-    /**
-     * An [event](#Event) which fires when an [AuthenticationSession](#AuthenticationSession) is added, removed, or changed.
-     */
-    export interface AuthenticationProviderAuthenticationSessionsChangeEvent {
-        /**
-         * The ids of the [AuthenticationSession](#AuthenticationSession)s that have been added.
-         */
-        readonly added: ReadonlyArray<string>;
-
-        /**
-         * The ids of the [AuthenticationSession](#AuthenticationSession)s that have been removed.
-         */
-        readonly removed: ReadonlyArray<string>;
-
-        /**
-         * The ids of the [AuthenticationSession](#AuthenticationSession)s that have been changed.
-         */
-        readonly changed: ReadonlyArray<string>;
-    }
-
-    /**
-     * **WARNING** When writing an AuthenticationProvider, `id` should be treated as part of your extension's
-     * API, changing it is a breaking change for all extensions relying on the provider. The id is
-     * treated case-sensitively.
-     */
-    export interface AuthenticationProvider {
-        /**
-         * Used as an identifier for extensions trying to work with a particular
-         * provider: 'microsoft', 'github', etc. id must be unique, registering
-         * another provider with the same id will fail.
-         */
-        readonly id: string;
-
-        /**
-         * The human-readable name of the provider.
-         */
-        readonly label: string;
-
-        /**
-         * Whether it is possible to be signed into multiple accounts at once with this provider
-         */
-        readonly supportsMultipleAccounts: boolean;
-
-        /**
-         * Returns an array of current sessions.
-         */
-        getSessions(): Thenable<ReadonlyArray<AuthenticationSession>>;
-
-        /**
-         * Prompts a user to login.
-         */
-        login(scopes: string[]): Thenable<AuthenticationSession>;
-
-        /**
-         * Removes the session corresponding to session id.
-         * @param sessionId The session id to log out of
-         */
-        logout(sessionId: string): Thenable<void>;
-    }
-
-    export namespace authentication {
-        /**
-         * Register an authentication provider.
-         *
-         * There can only be one provider per id and an error is being thrown when an id
-         * has already been used by another provider.
-         *
-         * @param provider The authentication provider provider.
-         * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
-         */
-        export function registerAuthenticationProvider(provider: AuthenticationProvider): Disposable;
-
-        /**
-         * Fires with the provider id that was registered or unregistered.
-         */
-        export const onDidChangeAuthenticationProviders: Event<AuthenticationProvidersChangeEvent>;
-
-        /**
-         * @deprecated
-         * The ids of the currently registered authentication providers.
-         * @returns An array of the ids of authentication providers that are currently registered.
-         */
-        export function getProviderIds(): Thenable<ReadonlyArray<string>>;
-
-        /**
-         * @deprecated
-         * An array of the ids of authentication providers that are currently registered.
-         */
-        export const providerIds: ReadonlyArray<string>;
-
-        /**
-         * An array of the information of authentication providers that are currently registered.
-         */
-        export const providers: ReadonlyArray<AuthenticationProviderInformation>;
-
-        /**
-         * @deprecated
-         * Logout of a specific session.
-         * @param providerId The id of the provider to use
-         * @param sessionId The session id to remove
-         * provider
-         */
-        export function logout(providerId: string, sessionId: string): Thenable<void>;
-    }
-
-    // #endregion
-
     /**
      * The contiguous set of modified lines in a diff.
      */

package/src/theia.d.ts

@@ -2353,6 +2353,32 @@ export module '@theia/plugin' {
         ignoreFocusOut?: boolean;
     }
 
+    /**
+     * Impacts the behavior and appearance of the validation message.
+     */
+    export enum InputBoxValidationSeverity {
+        Info = 1,
+        Warning = 2,
+        Error = 3
+    }
+
+    /**
+     * Object to configure the behavior of the validation message.
+     */
+    export interface InputBoxValidationMessage {
+        /**
+         * The validation message to display.
+         */
+        readonly message: string;
+
+        /**
+         * The severity of the validation message.
+         * NOTE: When using `InputBoxValidationSeverity.Error`, the user will not be allowed to accept (hit ENTER) the input.
+         * `Info` and `Warning` will still allow the InputBox to accept the input.
+         */
+        readonly severity: InputBoxValidationSeverity;
+    }
+
     /**
      * Options to configure the behavior of the input box UI.
      */
@@ -2401,10 +2427,10 @@ export module '@theia/plugin' {
          * to the user.
          *
          * @param value The current value of the input box.
-         * @return A human readable string which is presented as diagnostic message.
-         * Return `undefined`, or the empty string when 'value' is valid.
+         * @return Either a human-readable string which is presented as an error message or an {@link InputBoxValidationMessage}
+         *  which can provide a specific message severity. Return `undefined`, `null`, or the empty string when 'value' is valid.
          */
-        validateInput?: (input: string) => Promise<string | null | undefined> | undefined;
+        validateInput?: (input: string) => Promise<string | InputBoxValidationMessage | null | undefined> | undefined;
 
         /**
          * An optional function that will be called on Enter key.
@@ -3469,6 +3495,13 @@ export module '@theia/plugin' {
      */
     export interface Memento {
 
+        /**
+         * Returns the stored keys.
+         *
+         * @return The stored keys.
+         */
+        keys(): readonly string[];
+
         /**
          * Return a value.
          *
@@ -4458,7 +4491,7 @@ export module '@theia/plugin' {
          * @param token A token that can be used to signal cancellation.
          * @return A promise that resolves to the selection or `undefined`.
          */
-        export function showQuickPick(readonly items: string[] | Thenable<readonly string[]>, options: QuickPickOptions, token?: CancellationToken): Thenable<string | undefined>;
+        export function showQuickPick(items: readonly string[] | Thenable<readonly string[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<string | undefined>;
 
         /**
          * Shows a selection list allowing multiple selections.
@@ -4468,7 +4501,7 @@ export module '@theia/plugin' {
          * @param token A token that can be used to signal cancellation.
          * @return A promise that resolves to the selected items or `undefined`.
          */
-        export function showQuickPick(readonly items: string[] | Thenable<readonly string[]>, options: QuickPickOptions & { canPickMany: true }, token?: CancellationToken): Thenable<string[] | undefined>;
+        export function showQuickPick(items: readonly string[] | Thenable<readonly string[]>, options: QuickPickOptions & { canPickMany: true }, token?: CancellationToken): Thenable<string[] | undefined>;
 
         /**
          * Shows a selection list.
@@ -4478,7 +4511,7 @@ export module '@theia/plugin' {
          * @param token A token that can be used to signal cancellation.
          * @return A promise that resolves to the selected item or `undefined`.
          */
-        export function showQuickPick<T extends QuickPickItem>(items: readonly T[] | Thenable<readonly T[]>, options: QuickPickOptions, token?: CancellationToken): Thenable<T | undefined>;
+        export function showQuickPick<T extends QuickPickItem>(items: readonly T[] | Thenable<readonly T[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<T | undefined>;
 
         /**
          * Shows a selection list allowing multiple selections.
@@ -5058,8 +5091,10 @@ export module '@theia/plugin' {
 
         /**
          * An optional validation message indicating a problem with the current input value.
+         * By returning a string, the InputBox will use a default {@link InputBoxValidationSeverity} of Error.
+         * Returning undefined clears the validation message.
          */
-        validationMessage: string | undefined;
+        validationMessage: string | InputBoxValidationMessage | undefined;
     }
 
     /**
@@ -5640,12 +5675,14 @@ export module '@theia/plugin' {
          * Returns `true` if the given section for the given resource (if provided) is affected.
          *
          * @param section Configuration name, supports _dotted_ names.
-         * @param resource A resource Uri.
+         * @param scope a {@link ConfigurationScope}
          * @return `true` if the given section for the given resource (if provided) is affected.
          */
-        affectsConfiguration(section: string, resource?: Uri): boolean;
+        affectsConfiguration(section: string, scope?: ConfigurationScope): boolean;
     }
 
+    export type ConfigurationScope = Uri | WorkspaceFolder | TextDocument | { uri?: Uri, languageId: string };
+
     /**
      * An event describing a change to the set of [workspace folders](#workspace.workspaceFolders).
      */
@@ -6300,13 +6337,13 @@ export module '@theia/plugin' {
          * is returned. Dots in the section-identifier are interpreted as child-access,
          * like `{ myExt: { setting: { doIt: true }}}` and `getConfiguration('myExt.setting').get('doIt') === true`.
          *
-         * When a resource is provided, configuration scoped to that resource is returned.
+         * When a scope is provided configuration confined to that scope is returned. Scope can be a resource or a language identifier or both.
          *
          * @param section A dot-separated identifier.
-         * @param resource A resource for which the configuration is asked for
+         * @param scope A scope for which the configuration is asked for.
          * @return The full configuration or a subset.
          */
-        export function getConfiguration(section?: string, resource?: Uri | null): WorkspaceConfiguration;
+        export function getConfiguration(section?: string, scope?: ConfigurationScope | null): WorkspaceConfiguration;
 
         /**
          * An event that is emitted when the [configuration](#WorkspaceConfiguration) changed.
@@ -9267,6 +9304,18 @@ export module '@theia/plugin' {
          */
         export function registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable;
 
+        /**
+         * Register a provider that locates evaluatable expressions in text documents.
+         * The editor will evaluate the expression in the active debug session and will show the result in the debug hover.
+         *
+         * If multiple providers are registered for a language an arbitrary provider will be used.
+         *
+         * @param selector A selector that defines the documents this provider is applicable to.
+         * @param provider An evaluatable expression provider.
+         * @return A {@link Disposable} that unregisters this provider when being disposed.
+         */
+        export function registerEvaluatableExpressionProvider(selector: DocumentSelector, provider: EvaluatableExpressionProvider): Disposable;
+
         /**
          * Register a workspace symbol provider.
          *
@@ -9580,6 +9629,54 @@ export module '@theia/plugin' {
         provideHover(document: TextDocument, position: Position, token: CancellationToken | undefined): ProviderResult<Hover>;
     }
 
+    /**
+     * An EvaluatableExpression represents an expression in a document that can be evaluated by an active debugger or runtime.
+     * The result of this evaluation is shown in a tooltip-like widget.
+     * If only a range is specified, the expression will be extracted from the underlying document.
+     * An optional expression can be used to override the extracted expression.
+     * In this case the range is still used to highlight the range in the document.
+     */
+    export class EvaluatableExpression {
+
+        /*
+         * The range is used to extract the evaluatable expression from the underlying document and to highlight it.
+         */
+        readonly range: Range;
+
+        /*
+         * If specified the expression overrides the extracted expression.
+         */
+        readonly expression?: string | undefined;
+
+        /**
+         * Creates a new evaluatable expression object.
+         *
+         * @param range The range in the underlying document from which the evaluatable expression is extracted.
+         * @param expression If specified overrides the extracted expression.
+         */
+        constructor(range: Range, expression?: string);
+    }
+
+    /**
+     * The evaluatable expression provider interface defines the contract between extensions and
+     * the debug hover. In this contract the provider returns an evaluatable expression for a given position
+     * in a document and the editor evaluates this expression in the active debug session and shows the result in a debug hover.
+     */
+    export interface EvaluatableExpressionProvider {
+        /**
+         * Provide an evaluatable expression for the given document and position.
+         * The editor will evaluate this expression in the active debug session and will show the result in the debug hover.
+         * The expression can be implicitly specified by the range in the underlying document or by explicitly returning an expression.
+         *
+         * @param document The document for which the debug hover is about to appear.
+         * @param position The line and character position in the document where the debug hover is about to appear.
+         * @param token A cancellation token.
+         * @return An EvaluatableExpression or a thenable that resolves to such. The lack of a result can be
+         * signaled by returning `undefined` or `null`.
+         */
+        provideEvaluatableExpression(document: TextDocument, position: Position, token: CancellationToken | undefined): ProviderResult<EvaluatableExpression>;
+    }
+
     /**
      * A document highlight kind.
      */
@@ -11746,7 +11843,7 @@ export module '@theia/plugin' {
          * The permissions granted by the session's access token. Available scopes
          * are defined by the [AuthenticationProvider](#AuthenticationProvider).
          */
-        readonly scopes: ReadonlyArray<string>;
+        readonly scopes: readonly string[];
     }
 
     /**
@@ -11981,12 +12078,6 @@ export module '@theia/plugin' {
          * @return A {@link Disposable} that unregisters this provider when being disposed.
          */
         export function registerAuthenticationProvider(id: string, label: string, provider: AuthenticationProvider, options?: AuthenticationProviderOptions): Disposable;
-
-        /**
-         * @deprecated Use {@link getSession()} {@link AuthenticationGetSessionOptions.silent} instead.
-         */
-        export function hasSession(providerId: string, scopes: readonly string[]): Thenable<boolean>;
-
     }
 }