@theia/plugin 1.33.0 → 1.34.0-next.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.33.0",
+  "version": "1.34.0-next.7+a73305748",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "d66562f95639027021574e130d20bb9459d89534"
+  "gitHead": "a73305748c89f9608c5f94ecc6d15924b49aaa0c"
 }

package/src/theia.d.ts

@@ -4554,6 +4554,11 @@ export module '@theia/plugin' {
      */
     export namespace window {
 
+        /**
+         * Represents the grid widget within the main editor area
+         */
+        export const tabGroups: TabGroups;
+
         /**
          * The currently active terminal or undefined. The active terminal is the one
          * that currently has focus or most recently had focus.
@@ -9179,6 +9184,17 @@ export module '@theia/plugin' {
          */
         static readonly RefactorInline: CodeActionKind;
 
+        /**
+         * Base kind for refactoring inline actions: `refactor.move`
+         *
+         * Example move actions:
+         *
+         * - Move a function to a new file
+         * - Move a property between classes
+         * - Move method to base class
+         */
+        static readonly RefactorMove: CodeActionKind;
+
         /**
          * Base kind for refactoring rewrite actions: `refactor.rewrite`
          *
@@ -12415,6 +12431,11 @@ export module '@theia/plugin' {
          * Label will be rendered next to authorName if exists.
          */
         label?: string;
+
+        /**
+         * Optional timestamp.
+         */
+        timestamp?: Date;
     }
 
     /**
@@ -13114,6 +13135,335 @@ export module '@theia/plugin' {
         export function registerAuthenticationProvider(id: string, label: string, provider: AuthenticationProvider, options?: AuthenticationProviderOptions): Disposable;
     }
 
+    /**
+     * The tab represents a single text based resource.
+     */
+   export class TabInputText {
+       /**
+        * The uri represented by the tab.
+        * @stubbed
+        */
+       readonly uri: Uri;
+       /**
+        * Constructs a text tab input with the given URI.
+        * @param uri The URI of the tab.
+        * @stubbed
+        */
+       constructor(uri: Uri);
+   }
+
+   /**
+    * The tab represents two text based resources
+    * being rendered as a diff.
+    */
+   export class TabInputTextDiff {
+       /**
+        * The uri of the original text resource.
+        * @stubbed
+        */
+       readonly original: Uri;
+       /**
+        * The uri of the modified text resource.
+        * @stubbed
+        */
+       readonly modified: Uri;
+       /**
+        * Constructs a new text diff tab input with the given URIs.
+        * @param original The uri of the original text resource.
+        * @param modified The uri of the modified text resource.
+        * @stubbed
+        */
+       constructor(original: Uri, modified: Uri);
+   }
+
+   /**
+    * The tab represents a custom editor.
+    */
+   export class TabInputCustom {
+       /**
+        * The uri that the tab is representing.
+        * @stubbed
+        */
+       readonly uri: Uri;
+       /**
+        * The type of custom editor.
+        * @stubbed
+        */
+       readonly viewType: string;
+       /**
+        * Constructs a custom editor tab input.
+        * @param uri The uri of the tab.
+        * @param viewType The viewtype of the custom editor.
+        * @stubbed
+        */
+       constructor(uri: Uri, viewType: string);
+   }
+
+   /**
+    * The tab represents a webview.
+    */
+   export class TabInputWebview {
+       /**
+        * The type of webview. Maps to WebviewPanel's viewType
+        * @stubbed
+        */
+       readonly viewType: string;
+       /**
+        * Constructs a webview tab input with the given view type.
+        * @param viewType The type of webview. Maps to WebviewPanel's viewType
+        * @stubbed
+        */
+       constructor(viewType: string);
+   }
+
+   /**
+    * The tab represents a notebook.
+    */
+   export class TabInputNotebook {
+       /**
+        * The uri that the tab is representing.
+        * @stubbed
+        */
+       readonly uri: Uri;
+       /**
+        * The type of notebook. Maps to NotebookDocuments's notebookType
+        * @stubbed
+        */
+       readonly notebookType: string;
+       /**
+        * Constructs a new tab input for a notebook.
+        * @param uri The uri of the notebook.
+        * @param notebookType The type of notebook. Maps to NotebookDocuments's notebookType
+        * @stubbed
+        */
+       constructor(uri: Uri, notebookType: string);
+   }
+
+   /**
+    * The tabs represents two notebooks in a diff configuration.
+    */
+   export class TabInputNotebookDiff {
+       /**
+        * The uri of the original notebook.
+        * @stubbed
+        */
+       readonly original: Uri;
+       /**
+        * The uri of the modified notebook.
+        * @stubbed
+        */
+       readonly modified: Uri;
+       /**
+        * The type of notebook. Maps to NotebookDocuments's notebookType
+        * @stubbed
+        */
+       readonly notebookType: string;
+       /**
+        * Constructs a notebook diff tab input.
+        * @param original The uri of the original unmodified notebook.
+        * @param modified The uri of the modified notebook.
+        * @param notebookType The type of notebook. Maps to NotebookDocuments's notebookType
+        * @stubbed
+        */
+       constructor(original: Uri, modified: Uri, notebookType: string);
+   }
+
+   /**
+    * The tab represents a terminal in the editor area.
+    */
+   export class TabInputTerminal {
+       /**
+        * Constructs a terminal tab input.
+        * @stubbed
+        */
+       constructor();
+   }
+
+   /**
+    * Represents a tab within a {@link TabGroup group of tabs}.
+    * Tabs are merely the graphical representation within the editor area.
+    * A backing editor is not a guarantee.
+    */
+   export interface Tab {
+
+       /**
+        * The text displayed on the tab.
+        * @stubbed
+        */
+       readonly label: string;
+
+       /**
+        * The group which the tab belongs to.
+        * @stubbed
+        */
+       readonly group: TabGroup;
+
+       /**
+        * Defines the structure of the tab i.e. text, notebook, custom, etc.
+        * Resource and other useful properties are defined on the tab kind.
+        * @stubbed
+        */
+       readonly input: TabInputText | TabInputTextDiff | TabInputCustom | TabInputWebview | TabInputNotebook | TabInputNotebookDiff | TabInputTerminal | unknown;
+
+       /**
+        * Whether or not the tab is currently active.
+        * This is dictated by being the selected tab in the group.
+        * @stubbed
+        */
+       readonly isActive: boolean;
+
+       /**
+        * Whether or not the dirty indicator is present on the tab.
+        * @stubbed
+        */
+       readonly isDirty: boolean;
+
+       /**
+        * Whether or not the tab is pinned (pin icon is present).
+        * @stubbed
+        */
+       readonly isPinned: boolean;
+
+       /**
+        * Whether or not the tab is in preview mode.
+        * @stubbed
+        */
+       readonly isPreview: boolean;
+   }
+
+   /**
+    * An event describing change to tabs.
+    */
+   export interface TabChangeEvent {
+       /**
+        * The tabs that have been opened.
+        * @stubbed
+        */
+       readonly opened: readonly Tab[];
+       /**
+        * The tabs that have been closed.
+        * @stubbed
+        */
+       readonly closed: readonly Tab[];
+       /**
+        * Tabs that have changed, e.g have changed
+        * their {@link Tab.isActive active} state.
+        * @stubbed
+        */
+       readonly changed: readonly Tab[];
+   }
+
+   /**
+    * An event describing changes to tab groups.
+    */
+   export interface TabGroupChangeEvent {
+       /**
+        * Tab groups that have been opened.
+        * @stubbed
+        */
+       readonly opened: readonly TabGroup[];
+       /**
+        * Tab groups that have been closed.
+        * @stubbed
+        */
+       readonly closed: readonly TabGroup[];
+       /**
+        * Tab groups that have changed, e.g have changed
+        * their {@link TabGroup.isActive active} state.
+        * @stubbed
+        */
+       readonly changed: readonly TabGroup[];
+   }
+
+   /**
+    * Represents a group of tabs. A tab group itself consists of multiple tabs.
+    */
+   export interface TabGroup {
+       /**
+        * Whether or not the group is currently active.
+        *
+        * *Note* that only one tab group is active at a time, but that multiple tab
+        * groups can have an {@link TabGroup.aciveTab active tab}.
+        *
+        * @see {@link Tab.isActive}
+        * @stubbed
+        */
+       readonly isActive: boolean;
+
+       /**
+        * The view column of the group.
+        * @stubbed
+        */
+       readonly viewColumn: ViewColumn;
+
+       /**
+        * The active {@link Tab tab} in the group. This is the tab whose contents are currently
+        * being rendered.
+        *
+        * *Note* that there can be one active tab per group but there can only be one {@link TabGroups.activeTabGroup active group}.
+        * @stubbed
+        */
+       readonly activeTab: Tab | undefined;
+
+       /**
+        * The list of tabs contained within the group.
+        * This can be empty if the group has no tabs open.
+        * @stubbed
+        */
+       readonly tabs: readonly Tab[];
+   }
+
+   /**
+    * Represents the main editor area which consists of multple groups which contain tabs.
+    */
+   export interface TabGroups {
+       /**
+        * All the groups within the group container.
+        * @stubbed
+        */
+       readonly all: readonly TabGroup[];
+
+       /**
+        * The currently active group.
+        * @stubbed
+        */
+       readonly activeTabGroup: TabGroup;
+
+       /**
+        * An {@link Event event} which fires when {@link TabGroup tab groups} have changed.
+        * @stubbed
+        */
+       readonly onDidChangeTabGroups: Event<TabGroupChangeEvent>;
+
+       /**
+        * An {@link Event event} which fires when {@link Tab tabs} have changed.
+        * @stubbed
+        */
+       readonly onDidChangeTabs: Event<TabChangeEvent>;
+
+       /**
+        * Closes the tab. This makes the tab object invalid and the tab
+        * should no longer be used for further actions.
+        * Note: In the case of a dirty tab, a confirmation dialog will be shown which may be cancelled. If cancelled the tab is still valid
+        *
+        * @param tab The tab to close.
+        * @param preserveFocus When `true` focus will remain in its current position. If `false` it will jump to the next tab.
+        * @returns A promise that resolves to `true` when all tabs have been closed.
+        * @stubbed
+        */
+       close(tab: Tab | readonly Tab[], preserveFocus?: boolean): Thenable<boolean>;
+
+       /**
+        * Closes the tab group. This makes the tab group object invalid and the tab group
+        * should no longer be used for further actions.
+        * @param tabGroup The tab group to close.
+        * @param preserveFocus When `true` focus will remain in its current position.
+        * @returns A promise that resolves to `true` when all tab groups have been closed.
+        * @stubbed
+        */
+       close(tabGroup: TabGroup | readonly TabGroup[], preserveFocus?: boolean): Thenable<boolean>;
+   }
+
     /**
      * Represents a notebook editor that is attached to a {@link NotebookDocument notebook}.
      */