@theia/plugin 1.24.0-next.7 → 1.24.0-next.71

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.24.0-next.7+481d2cf0edd",
+  "version": "1.24.0-next.71+b3d41033c29",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "481d2cf0edd33d8495662b9589b9232dcd6c8b34"
+  "gitHead": "b3d41033c29cb4f0ed8efbe969cfce41986c48e0"
 }

package/src/theia.d.ts

@@ -1296,6 +1296,15 @@ export module '@theia/plugin' {
          */
         static parse(value: string): Uri;
 
+        /**
+         * Create an URI from its component parts
+         *
+         * @see {@link Uri.toString}
+         * @param components The component parts of an Uri.
+         * @return A new Uri instance.
+         */
+        static from(components: { readonly scheme: string; readonly authority?: string; readonly path?: string; readonly query?: string; readonly fragment?: string }): Uri;
+
         /**
          * Use the `file` and `parse` factory functions to create new `Uri` objects.
          */
@@ -2070,7 +2079,11 @@ export module '@theia/plugin' {
      * Represents an item that can be selected from a list of items.
      */
     export interface QuickPickItem {
-        type?: 'item' | 'separator';
+        /**
+         * Defaults to {@link QuickPickItemKind.Default}. If set to {@link QUickPickItemKind.Separator}, the item will not be displayed as a row but only as a separator,
+         * and all fields other than {@link QuickPickItem.label label} will be ignored.
+         */
+        kind?: QuickPickItemKind;
         /**
          * The item label
          */
@@ -2097,6 +2110,14 @@ export module '@theia/plugin' {
         alwaysShow?: boolean;
     }
 
+    /**
+     * The type of a {@link QuickPickItem quitk pick item}. If `Separator` is set, all fields other than {@link QuickPickItem.label label} will be ignored.
+     */
+    export enum QuickPickItemKind {
+        Separator = -1,
+        Default = 0,
+    }
+
     /**
      * A concrete [QuickInput](#QuickInput) to let the user pick an item from a
      * list of items of type T. The items can be filtered through a filter text field and
@@ -2237,6 +2258,11 @@ export module '@theia/plugin' {
      */
     export interface InputBoxOptions {
 
+        /**
+         * An optional string that represents the title of the input box.
+         */
+        title?: string;
+
         /**
          * The value to prefill in the input box.
          */
@@ -2533,6 +2559,13 @@ export module '@theia/plugin' {
          */
         appendLine(value: string): void;
 
+        /**
+         * Replaces all output from the channel with the given value.
+         *
+         * @param value A string, falsy values will not be printed.
+         */
+        replace(value: string): void;
+
         /**
          * Removes all output from the channel.
          */
@@ -6198,7 +6231,7 @@ export module '@theia/plugin' {
          * @return true if the operation was successfully started and false otherwise if arguments were used that would result
          * in invalid workspace folder state (e.g. 2 folders with the same URI).
          */
-        export function updateWorkspaceFolders(start: number, deleteCount: number | undefined | null, ...workspaceFoldersToAdd: { uri: Uri, name?: string }[]): boolean;
+        export function updateWorkspaceFolders(start: number, deleteCount: number | undefined | null, ...workspaceFoldersToAdd: { readonly uri: Uri, readonly name?: string }[]): boolean;
 
         /**
          * ~~Register a task provider.~~
@@ -7310,6 +7343,31 @@ export module '@theia/plugin' {
         Deprecated = 1
     }
 
+    /**
+     * A structured label for a {@link CompletionItem completion item}.
+     */
+    export interface CompletionItemLabel {
+
+        /**
+         * The label of this completion item.
+         *
+         * By default this is also the text that is inserted when this completion is selected.
+         */
+        label: string;
+
+        /**
+         * An optional string which is rendered less prominently directly after {@link CompletionItemLabel.label label},
+         * without any spacing. Should be used for function signatures or type annotations.
+         */
+        detail?: string;
+
+        /**
+         * An optional string which is rendered less prominently after {@link CompletionItemLabel.detail}. Should be used
+         * for fully qualified names or file path.
+         */
+        description?: string;
+    }
+
     /**
      * A completion item represents a text snippet that is proposed to complete text that is being typed.
      *
@@ -7332,7 +7390,7 @@ export module '@theia/plugin' {
          * this is also the text that is inserted when selecting
          * this completion.
          */
-        label: string;
+        label: string | CompletionItemLabel;
 
         /**
          * The kind of this completion item. Based on the kind
@@ -7451,7 +7509,7 @@ export module '@theia/plugin' {
          * @param label The label of the completion.
          * @param kind The [kind](#CompletionItemKind) of the completion.
          */
-        constructor(label: string, kind?: CompletionItemKind);
+        constructor(label: string | CompletionItemLabel, kind?: CompletionItemKind);
     }
 
     /**
@@ -8047,6 +8105,14 @@ export module '@theia/plugin' {
          */
         static readonly SourceOrganizeImports: CodeActionKind;
 
+        /**
+         * Base kind for auto-fix source actions: `source.fixAll`.
+         *
+         * Fix all actions automatically fix errors that have a clear fix that do not require user input.
+         * They should not suppress errors or perform unsafe fixes such as generating new types or classes.
+         */
+        static readonly SourceFixAll: CodeActionKind;
+
         private constructor(value: string);
 
         /**
@@ -10040,14 +10106,14 @@ export module '@theia/plugin' {
          * @param breakpoints The breakpoints to add.
          */
         // eslint-disable-next-line @typescript-eslint/no-shadow
-        export function addBreakpoints(breakpoints: Breakpoint[]): void;
+        export function addBreakpoints(breakpoints: readonly Breakpoint[]): void;
 
         /**
          * Remove breakpoints.
          * @param breakpoints The breakpoints to remove.
          */
         // eslint-disable-next-line @typescript-eslint/no-shadow
-        export function removeBreakpoints(breakpoints: Breakpoint[]): void;
+        export function removeBreakpoints(breakpoints: readonly Breakpoint[]): void;
     }
 
     /**
@@ -10444,6 +10510,13 @@ export module '@theia/plugin' {
          */
         source?: string;
 
+        /**
+         * A human-readable string which is rendered less prominently on a separate line in places
+         * where the task's name is displayed. Supports rendering of {@link ThemeIcon theme icons}
+         * via the `$(<name>)`-syntax.
+         */
+        detail?: string;
+
         /**
          * The task group this tasks belongs to. See TaskGroup
          * for a predefined set of available groups.
@@ -10462,9 +10535,10 @@ export module '@theia/plugin' {
         problemMatchers?: string[];
     }
 
-    export class Task2 extends Task {
-        detail?: string;
-    }
+    /**
+     * Task2 is kept for compatibility reasons.
+     */
+    export class Task2 extends Task { }
 
     export interface TaskProvider<T extends Task = Task> {
         /**
@@ -11388,7 +11462,7 @@ export module '@theia/plugin' {
          * @param options The [getSessionOptions](#GetSessionOptions) to use
          * @returns A thenable that resolves to an authentication session
          */
-        export function getSession(providerId: string, scopes: string[], options: AuthenticationGetSessionOptions & { createIfNone: true }): Thenable<AuthenticationSession>;
+        export function getSession(providerId: string, scopes: readonly string[], options: AuthenticationGetSessionOptions & { createIfNone: true }): Thenable<AuthenticationSession>;
 
         /**
          * Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
@@ -11416,7 +11490,7 @@ export module '@theia/plugin' {
          * @param options The [getSessionOptions](#GetSessionOptions) to use
          * @returns A thenable that resolves to an authentication session if available, or undefined if there are no sessions
          */
-        export function getSession(providerId: string, scopes: string[], options?: AuthenticationGetSessionOptions): Thenable<AuthenticationSession | undefined>;
+        export function getSession(providerId: string, scopes: readonly string[], options?: AuthenticationGetSessionOptions): Thenable<AuthenticationSession | undefined>;
 
         /**
          * An [event](#Event) which fires when the authentication sessions of an authentication provider have