@theia/plugin 1.30.0-next.33 → 1.30.0-next.36

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.30.0-next.33+b75b6144b",
+  "version": "1.30.0-next.36+cd2f08124",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "b75b6144b0ffea06a549294903c374fa642135e4"
+  "gitHead": "cd2f0812424d91561be7cc53aa303488113ed59d"
 }

package/src/theia.d.ts

@@ -1727,6 +1727,11 @@ export module '@theia/plugin' {
      */
     export interface FileWillCreateEvent {
 
+        /**
+         * A cancellation token.
+         */
+        readonly token: CancellationToken;
+
         /**
          * The files that are going to be created.
          */
@@ -1782,6 +1787,11 @@ export module '@theia/plugin' {
      */
     export interface FileWillDeleteEvent {
 
+        /**
+         * A cancellation token.
+         */
+        readonly token: CancellationToken;
+
         /**
          * The files that are going to be deleted.
          */
@@ -1837,6 +1847,11 @@ export module '@theia/plugin' {
      */
     export interface FileWillRenameEvent {
 
+        /**
+         * A cancellation token.
+         */
+        readonly token: CancellationToken;
+
         /**
          * The files that are going to be renamed.
          */
@@ -2201,35 +2216,63 @@ export module '@theia/plugin' {
      * Represents an item that can be selected from a list of items.
      */
     export interface QuickPickItem {
+
+        /**
+         * A human-readable string which is rendered prominent. Supports rendering of {@link ThemeIcon theme icons} via
+         * the `$(<name>)`-syntax.
+         */
+        label: string;
+
         /**
          * 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
-         */
-        label: string;
 
         /**
-         * The item description
+         * A human-readable string which is rendered less prominent in the same line. Supports rendering of
+         * {@link ThemeIcon theme icons} via the `$(<name>)`-syntax.
+         *
+         * Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator}
          */
         description?: string;
 
         /**
-         * The item detail
+         * A human-readable string which is rendered less prominent in a separate line. Supports rendering of
+         * {@link ThemeIcon theme icons} via the `$(<name>)`-syntax.
+         *
+         * Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator}
          */
         detail?: string;
 
         /**
-         * Used for [QuickPickOptions.canPickMany](#QuickPickOptions.canPickMany)
-         * not implemented yet
+         * Optional flag indicating if this item is picked initially. This is only honored when using
+         * the {@link window.showQuickPick()} API. To do the same thing with the {@link window.createQuickPick()} API,
+         * simply set the {@link QuickPick.selectedItems} to the items you want picked initially.
+         * (*Note:* This is only honored when the picker allows multiple selections.)
+         *
+         * @see {@link QuickPickOptions.canPickMany}
+         *
+         * Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator}
          */
         picked?: boolean;
+
         /**
          * Always show this item.
+         *
+         * Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator}
          */
         alwaysShow?: boolean;
+
+        /**
+         * Optional buttons that will be rendered on this particular item. These buttons will trigger
+         * an {@link QuickPickItemButtonEvent} when clicked. Buttons are only rendered when using a quickpick
+         * created by the {@link window.createQuickPick()} API. Buttons are not rendered when using
+         * the {@link window.showQuickPick()} API.
+         *
+         * Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator}
+         */
+        buttons?: readonly QuickInputButton[];
     }
 
     /**
@@ -2282,6 +2325,12 @@ export module '@theia/plugin' {
          */
         readonly onDidTriggerButton: Event<QuickInputButton>;
 
+        /**
+         * An event signaling when a button in a particular {@link QuickPickItem} was triggered.
+         * This event does not fire for buttons in the title bar.
+         */
+        readonly onDidTriggerItemButton: Event<QuickPickItemButtonEvent<T>>;
+
         /**
          * Items to pick from.
          */
@@ -5118,6 +5167,21 @@ export module '@theia/plugin' {
         private constructor();
     }
 
+    /**
+     * An event signaling when a button in a particular {@link QuickPickItem} was triggered.
+     * This event does not fire for buttons in the title bar.
+     */
+    export interface QuickPickItemButtonEvent<T extends QuickPickItem> {
+        /**
+         * The button that was clicked.
+         */
+        readonly button: QuickInputButton;
+        /**
+         * The item that the button belongs to.
+         */
+        readonly item: T;
+    }
+
     /**
      * A concrete {@link QuickInput QuickInput} to let the user input a text value.
      *