@theia/plugin 1.34.0 → 1.34.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +3 -3
  2. package/src/theia.d.ts +285 -330
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@theia/plugin",
3
- "version": "1.34.0",
3
+ "version": "1.34.2",
4
4
  "description": "Theia - Plugin API",
5
5
  "types": "./src/theia.d.ts",
6
6
  "publishConfig": {
@@ -27,10 +27,10 @@
27
27
  "watch": "theiaext watch"
28
28
  },
29
29
  "devDependencies": {
30
- "@theia/ext-scripts": "1.34.0"
30
+ "@theia/ext-scripts": "1.34.2"
31
31
  },
32
32
  "nyc": {
33
33
  "extends": "../../configs/nyc.json"
34
34
  },
35
- "gitHead": "a8c403b103829a1b8b092ce741ef3826804f773b"
35
+ "gitHead": "dba940bd8c0f9f4b324dad0e90d570d499456f60"
36
36
  }
package/src/theia.d.ts CHANGED
@@ -13471,331 +13471,291 @@ export module '@theia/plugin' {
13471
13471
  /**
13472
13472
  * The tab represents a single text based resource.
13473
13473
  */
13474
- export class TabInputText {
13475
- /**
13476
- * The uri represented by the tab.
13477
- * @stubbed
13478
- */
13479
- readonly uri: Uri;
13480
- /**
13481
- * Constructs a text tab input with the given URI.
13482
- * @param uri The URI of the tab.
13483
- * @stubbed
13484
- */
13485
- constructor(uri: Uri);
13486
- }
13487
-
13488
- /**
13489
- * The tab represents two text based resources
13490
- * being rendered as a diff.
13491
- */
13492
- export class TabInputTextDiff {
13493
- /**
13494
- * The uri of the original text resource.
13495
- * @stubbed
13496
- */
13497
- readonly original: Uri;
13498
- /**
13499
- * The uri of the modified text resource.
13500
- * @stubbed
13501
- */
13502
- readonly modified: Uri;
13503
- /**
13504
- * Constructs a new text diff tab input with the given URIs.
13505
- * @param original The uri of the original text resource.
13506
- * @param modified The uri of the modified text resource.
13507
- * @stubbed
13508
- */
13509
- constructor(original: Uri, modified: Uri);
13510
- }
13511
-
13512
- /**
13513
- * The tab represents a custom editor.
13514
- */
13515
- export class TabInputCustom {
13516
- /**
13517
- * The uri that the tab is representing.
13518
- * @stubbed
13519
- */
13520
- readonly uri: Uri;
13521
- /**
13522
- * The type of custom editor.
13523
- * @stubbed
13524
- */
13525
- readonly viewType: string;
13526
- /**
13527
- * Constructs a custom editor tab input.
13528
- * @param uri The uri of the tab.
13529
- * @param viewType The viewtype of the custom editor.
13530
- * @stubbed
13531
- */
13532
- constructor(uri: Uri, viewType: string);
13533
- }
13534
-
13535
- /**
13536
- * The tab represents a webview.
13537
- */
13538
- export class TabInputWebview {
13539
- /**
13540
- * The type of webview. Maps to WebviewPanel's viewType
13541
- * @stubbed
13542
- */
13543
- readonly viewType: string;
13544
- /**
13545
- * Constructs a webview tab input with the given view type.
13546
- * @param viewType The type of webview. Maps to WebviewPanel's viewType
13547
- * @stubbed
13548
- */
13549
- constructor(viewType: string);
13550
- }
13551
-
13552
- /**
13553
- * The tab represents a notebook.
13554
- */
13555
- export class TabInputNotebook {
13556
- /**
13557
- * The uri that the tab is representing.
13558
- * @stubbed
13559
- */
13560
- readonly uri: Uri;
13561
- /**
13562
- * The type of notebook. Maps to NotebookDocuments's notebookType
13563
- * @stubbed
13564
- */
13565
- readonly notebookType: string;
13566
- /**
13567
- * Constructs a new tab input for a notebook.
13568
- * @param uri The uri of the notebook.
13569
- * @param notebookType The type of notebook. Maps to NotebookDocuments's notebookType
13570
- * @stubbed
13571
- */
13572
- constructor(uri: Uri, notebookType: string);
13573
- }
13574
-
13575
- /**
13576
- * The tabs represents two notebooks in a diff configuration.
13577
- */
13578
- export class TabInputNotebookDiff {
13579
- /**
13580
- * The uri of the original notebook.
13581
- * @stubbed
13582
- */
13583
- readonly original: Uri;
13584
- /**
13585
- * The uri of the modified notebook.
13586
- * @stubbed
13587
- */
13588
- readonly modified: Uri;
13589
- /**
13590
- * The type of notebook. Maps to NotebookDocuments's notebookType
13591
- * @stubbed
13592
- */
13593
- readonly notebookType: string;
13594
- /**
13595
- * Constructs a notebook diff tab input.
13596
- * @param original The uri of the original unmodified notebook.
13597
- * @param modified The uri of the modified notebook.
13598
- * @param notebookType The type of notebook. Maps to NotebookDocuments's notebookType
13599
- * @stubbed
13600
- */
13601
- constructor(original: Uri, modified: Uri, notebookType: string);
13602
- }
13603
-
13604
- /**
13605
- * The tab represents a terminal in the editor area.
13606
- */
13607
- export class TabInputTerminal {
13608
- /**
13609
- * Constructs a terminal tab input.
13610
- * @stubbed
13611
- */
13612
- constructor();
13613
- }
13614
-
13615
- /**
13616
- * Represents a tab within a {@link TabGroup group of tabs}.
13617
- * Tabs are merely the graphical representation within the editor area.
13618
- * A backing editor is not a guarantee.
13619
- */
13620
- export interface Tab {
13621
-
13622
- /**
13623
- * The text displayed on the tab.
13624
- * @stubbed
13625
- */
13626
- readonly label: string;
13627
-
13628
- /**
13629
- * The group which the tab belongs to.
13630
- * @stubbed
13631
- */
13632
- readonly group: TabGroup;
13633
-
13634
- /**
13635
- * Defines the structure of the tab i.e. text, notebook, custom, etc.
13636
- * Resource and other useful properties are defined on the tab kind.
13637
- * @stubbed
13638
- */
13639
- readonly input: TabInputText | TabInputTextDiff | TabInputCustom | TabInputWebview | TabInputNotebook | TabInputNotebookDiff | TabInputTerminal | unknown;
13640
-
13641
- /**
13642
- * Whether or not the tab is currently active.
13643
- * This is dictated by being the selected tab in the group.
13644
- * @stubbed
13645
- */
13646
- readonly isActive: boolean;
13647
-
13648
- /**
13649
- * Whether or not the dirty indicator is present on the tab.
13650
- * @stubbed
13651
- */
13652
- readonly isDirty: boolean;
13653
-
13654
- /**
13655
- * Whether or not the tab is pinned (pin icon is present).
13656
- * @stubbed
13657
- */
13658
- readonly isPinned: boolean;
13659
-
13660
- /**
13661
- * Whether or not the tab is in preview mode.
13662
- * @stubbed
13663
- */
13664
- readonly isPreview: boolean;
13665
- }
13666
-
13667
- /**
13668
- * An event describing change to tabs.
13669
- */
13670
- export interface TabChangeEvent {
13671
- /**
13672
- * The tabs that have been opened.
13673
- * @stubbed
13674
- */
13675
- readonly opened: readonly Tab[];
13676
- /**
13677
- * The tabs that have been closed.
13678
- * @stubbed
13679
- */
13680
- readonly closed: readonly Tab[];
13681
- /**
13682
- * Tabs that have changed, e.g have changed
13683
- * their {@link Tab.isActive active} state.
13684
- * @stubbed
13685
- */
13686
- readonly changed: readonly Tab[];
13687
- }
13688
-
13689
- /**
13690
- * An event describing changes to tab groups.
13691
- */
13692
- export interface TabGroupChangeEvent {
13693
- /**
13694
- * Tab groups that have been opened.
13695
- * @stubbed
13696
- */
13697
- readonly opened: readonly TabGroup[];
13698
- /**
13699
- * Tab groups that have been closed.
13700
- * @stubbed
13701
- */
13702
- readonly closed: readonly TabGroup[];
13703
- /**
13704
- * Tab groups that have changed, e.g have changed
13705
- * their {@link TabGroup.isActive active} state.
13706
- * @stubbed
13707
- */
13708
- readonly changed: readonly TabGroup[];
13709
- }
13710
-
13711
- /**
13712
- * Represents a group of tabs. A tab group itself consists of multiple tabs.
13713
- */
13714
- export interface TabGroup {
13715
- /**
13716
- * Whether or not the group is currently active.
13717
- *
13718
- * *Note* that only one tab group is active at a time, but that multiple tab
13719
- * groups can have an {@link TabGroup.aciveTab active tab}.
13720
- *
13721
- * @see {@link Tab.isActive}
13722
- * @stubbed
13723
- */
13724
- readonly isActive: boolean;
13725
-
13726
- /**
13727
- * The view column of the group.
13728
- * @stubbed
13729
- */
13730
- readonly viewColumn: ViewColumn;
13731
-
13732
- /**
13733
- * The active {@link Tab tab} in the group. This is the tab whose contents are currently
13734
- * being rendered.
13735
- *
13736
- * *Note* that there can be one active tab per group but there can only be one {@link TabGroups.activeTabGroup active group}.
13737
- * @stubbed
13738
- */
13739
- readonly activeTab: Tab | undefined;
13740
-
13741
- /**
13742
- * The list of tabs contained within the group.
13743
- * This can be empty if the group has no tabs open.
13744
- * @stubbed
13745
- */
13746
- readonly tabs: readonly Tab[];
13747
- }
13748
-
13749
- /**
13750
- * Represents the main editor area which consists of multple groups which contain tabs.
13751
- */
13752
- export interface TabGroups {
13753
- /**
13754
- * All the groups within the group container.
13755
- * @stubbed
13756
- */
13757
- readonly all: readonly TabGroup[];
13758
-
13759
- /**
13760
- * The currently active group.
13761
- * @stubbed
13762
- */
13763
- readonly activeTabGroup: TabGroup;
13764
-
13765
- /**
13766
- * An {@link Event event} which fires when {@link TabGroup tab groups} have changed.
13767
- * @stubbed
13768
- */
13769
- readonly onDidChangeTabGroups: Event<TabGroupChangeEvent>;
13770
-
13771
- /**
13772
- * An {@link Event event} which fires when {@link Tab tabs} have changed.
13773
- * @stubbed
13774
- */
13775
- readonly onDidChangeTabs: Event<TabChangeEvent>;
13776
-
13777
- /**
13778
- * Closes the tab. This makes the tab object invalid and the tab
13779
- * should no longer be used for further actions.
13780
- * 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
13781
- *
13782
- * @param tab The tab to close.
13783
- * @param preserveFocus When `true` focus will remain in its current position. If `false` it will jump to the next tab.
13784
- * @returns A promise that resolves to `true` when all tabs have been closed.
13785
- * @stubbed
13786
- */
13787
- close(tab: Tab | readonly Tab[], preserveFocus?: boolean): Thenable<boolean>;
13788
-
13789
- /**
13790
- * Closes the tab group. This makes the tab group object invalid and the tab group
13791
- * should no longer be used for further actions.
13792
- * @param tabGroup The tab group to close.
13793
- * @param preserveFocus When `true` focus will remain in its current position.
13794
- * @returns A promise that resolves to `true` when all tab groups have been closed.
13795
- * @stubbed
13796
- */
13797
- close(tabGroup: TabGroup | readonly TabGroup[], preserveFocus?: boolean): Thenable<boolean>;
13798
- }
13474
+ export class TabInputText {
13475
+ /**
13476
+ * The uri represented by the tab.
13477
+ */
13478
+ readonly uri: Uri;
13479
+ /**
13480
+ * Constructs a text tab input with the given URI.
13481
+ * @param uri The URI of the tab.
13482
+ */
13483
+ constructor(uri: Uri);
13484
+ }
13485
+
13486
+ /**
13487
+ * The tab represents two text based resources
13488
+ * being rendered as a diff.
13489
+ */
13490
+ export class TabInputTextDiff {
13491
+ /**
13492
+ * The uri of the original text resource.
13493
+ */
13494
+ readonly original: Uri;
13495
+ /**
13496
+ * The uri of the modified text resource.
13497
+ */
13498
+ readonly modified: Uri;
13499
+ /**
13500
+ * Constructs a new text diff tab input with the given URIs.
13501
+ * @param original The uri of the original text resource.
13502
+ * @param modified The uri of the modified text resource.
13503
+ */
13504
+ constructor(original: Uri, modified: Uri);
13505
+ }
13506
+
13507
+ /**
13508
+ * The tab represents a custom editor.
13509
+ */
13510
+ export class TabInputCustom {
13511
+ /**
13512
+ * The uri that the tab is representing.
13513
+ */
13514
+ readonly uri: Uri;
13515
+ /**
13516
+ * The type of custom editor.
13517
+ */
13518
+ readonly viewType: string;
13519
+ /**
13520
+ * Constructs a custom editor tab input.
13521
+ * @param uri The uri of the tab.
13522
+ * @param viewType The viewtype of the custom editor.
13523
+ */
13524
+ constructor(uri: Uri, viewType: string);
13525
+ }
13526
+
13527
+ /**
13528
+ * The tab represents a webview.
13529
+ */
13530
+ export class TabInputWebview {
13531
+ /**
13532
+ * The type of webview. Maps to WebviewPanel's viewType
13533
+ */
13534
+ readonly viewType: string;
13535
+ /**
13536
+ * Constructs a webview tab input with the given view type.
13537
+ * @param viewType The type of webview. Maps to WebviewPanel's viewType
13538
+ */
13539
+ constructor(viewType: string);
13540
+ }
13541
+
13542
+ /**
13543
+ * The tab represents a notebook.
13544
+ */
13545
+ export class TabInputNotebook {
13546
+ /**
13547
+ * The uri that the tab is representing.
13548
+ */
13549
+ readonly uri: Uri;
13550
+ /**
13551
+ * The type of notebook. Maps to NotebookDocuments's notebookType
13552
+ */
13553
+ readonly notebookType: string;
13554
+ /**
13555
+ * Constructs a new tab input for a notebook.
13556
+ * @param uri The uri of the notebook.
13557
+ * @param notebookType The type of notebook. Maps to NotebookDocuments's notebookType
13558
+ */
13559
+ constructor(uri: Uri, notebookType: string);
13560
+ }
13561
+
13562
+ /**
13563
+ * The tabs represents two notebooks in a diff configuration.
13564
+ */
13565
+ export class TabInputNotebookDiff {
13566
+ /**
13567
+ * The uri of the original notebook.
13568
+ */
13569
+ readonly original: Uri;
13570
+ /**
13571
+ * The uri of the modified notebook.
13572
+ */
13573
+ readonly modified: Uri;
13574
+ /**
13575
+ * The type of notebook. Maps to NotebookDocuments's notebookType
13576
+ */
13577
+ readonly notebookType: string;
13578
+ /**
13579
+ * Constructs a notebook diff tab input.
13580
+ * @param original The uri of the original unmodified notebook.
13581
+ * @param modified The uri of the modified notebook.
13582
+ * @param notebookType The type of notebook. Maps to NotebookDocuments's notebookType
13583
+ */
13584
+ constructor(original: Uri, modified: Uri, notebookType: string);
13585
+ }
13586
+
13587
+ /**
13588
+ * The tab represents a terminal in the editor area.
13589
+ */
13590
+ export class TabInputTerminal {
13591
+ /**
13592
+ * Constructs a terminal tab input.
13593
+ */
13594
+ constructor();
13595
+ }
13596
+
13597
+ /**
13598
+ * Represents a tab within a {@link TabGroup group of tabs}.
13599
+ * Tabs are merely the graphical representation within the editor area.
13600
+ * A backing editor is not a guarantee.
13601
+ */
13602
+ export interface Tab {
13603
+
13604
+ /**
13605
+ * The text displayed on the tab.
13606
+ */
13607
+ readonly label: string;
13608
+
13609
+ /**
13610
+ * The group which the tab belongs to.
13611
+ */
13612
+ readonly group: TabGroup;
13613
+
13614
+ /**
13615
+ * Defines the structure of the tab i.e. text, notebook, custom, etc.
13616
+ * Resource and other useful properties are defined on the tab kind.
13617
+ */
13618
+ readonly input: TabInputText | TabInputTextDiff | TabInputCustom | TabInputWebview | TabInputNotebook | TabInputNotebookDiff | TabInputTerminal | unknown;
13619
+
13620
+ /**
13621
+ * Whether or not the tab is currently active.
13622
+ * This is dictated by being the selected tab in the group.
13623
+ */
13624
+ readonly isActive: boolean;
13625
+
13626
+ /**
13627
+ * Whether or not the dirty indicator is present on the tab.
13628
+ */
13629
+ readonly isDirty: boolean;
13630
+
13631
+ /**
13632
+ * Whether or not the tab is pinned (pin icon is present).
13633
+ */
13634
+ readonly isPinned: boolean;
13635
+
13636
+ /**
13637
+ * Whether or not the tab is in preview mode.
13638
+ */
13639
+ readonly isPreview: boolean;
13640
+ }
13641
+
13642
+ /**
13643
+ * An event describing change to tabs.
13644
+ */
13645
+ export interface TabChangeEvent {
13646
+ /**
13647
+ * The tabs that have been opened.
13648
+ */
13649
+ readonly opened: readonly Tab[];
13650
+ /**
13651
+ * The tabs that have been closed.
13652
+ */
13653
+ readonly closed: readonly Tab[];
13654
+ /**
13655
+ * Tabs that have changed, e.g have changed
13656
+ * their {@link Tab.isActive active} state.
13657
+ */
13658
+ readonly changed: readonly Tab[];
13659
+ }
13660
+
13661
+ /**
13662
+ * An event describing changes to tab groups.
13663
+ */
13664
+ export interface TabGroupChangeEvent {
13665
+ /**
13666
+ * Tab groups that have been opened.
13667
+ */
13668
+ readonly opened: readonly TabGroup[];
13669
+ /**
13670
+ * Tab groups that have been closed.
13671
+ */
13672
+ readonly closed: readonly TabGroup[];
13673
+ /**
13674
+ * Tab groups that have changed, e.g have changed
13675
+ * their {@link TabGroup.isActive active} state.
13676
+ */
13677
+ readonly changed: readonly TabGroup[];
13678
+ }
13679
+
13680
+ /**
13681
+ * Represents a group of tabs. A tab group itself consists of multiple tabs.
13682
+ */
13683
+ export interface TabGroup {
13684
+ /**
13685
+ * Whether or not the group is currently active.
13686
+ *
13687
+ * *Note* that only one tab group is active at a time, but that multiple tab
13688
+ * groups can have an {@link TabGroup.aciveTab active tab}.
13689
+ *
13690
+ * @see {@link Tab.isActive}
13691
+ */
13692
+ readonly isActive: boolean;
13693
+
13694
+ /**
13695
+ * The view column of the group.
13696
+ */
13697
+ readonly viewColumn: ViewColumn;
13698
+
13699
+ /**
13700
+ * The active {@link Tab tab} in the group. This is the tab whose contents are currently
13701
+ * being rendered.
13702
+ *
13703
+ * *Note* that there can be one active tab per group but there can only be one {@link TabGroups.activeTabGroup active group}.
13704
+ */
13705
+ readonly activeTab: Tab | undefined;
13706
+
13707
+ /**
13708
+ * The list of tabs contained within the group.
13709
+ * This can be empty if the group has no tabs open.
13710
+ */
13711
+ readonly tabs: readonly Tab[];
13712
+ }
13713
+
13714
+ /**
13715
+ * Represents the main editor area which consists of multple groups which contain tabs.
13716
+ */
13717
+ export interface TabGroups {
13718
+ /**
13719
+ * All the groups within the group container.
13720
+ */
13721
+ readonly all: readonly TabGroup[];
13722
+
13723
+ /**
13724
+ * The currently active group.
13725
+ */
13726
+ readonly activeTabGroup: TabGroup;
13727
+
13728
+ /**
13729
+ * An {@link Event event} which fires when {@link TabGroup tab groups} have changed.
13730
+ */
13731
+ readonly onDidChangeTabGroups: Event<TabGroupChangeEvent>;
13732
+
13733
+ /**
13734
+ * An {@link Event event} which fires when {@link Tab tabs} have changed.
13735
+ */
13736
+ readonly onDidChangeTabs: Event<TabChangeEvent>;
13737
+
13738
+ /**
13739
+ * Closes the tab. This makes the tab object invalid and the tab
13740
+ * should no longer be used for further actions.
13741
+ * 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
13742
+ *
13743
+ * @param tab The tab to close.
13744
+ * @param preserveFocus When `true` focus will remain in its current position. If `false` it will jump to the next tab.
13745
+ * @returns A promise that resolves to `true` when all tabs have been closed.
13746
+ */
13747
+ close(tab: Tab | readonly Tab[], preserveFocus?: boolean): Thenable<boolean>;
13748
+
13749
+ /**
13750
+ * Closes the tab group. This makes the tab group object invalid and the tab group
13751
+ * should no longer be used for further actions.
13752
+ * @param tabGroup The tab group to close.
13753
+ * @param preserveFocus When `true` focus will remain in its current position.
13754
+ * @returns A promise that resolves to `true` when all tab groups have been closed.
13755
+ * @stubbed
13756
+ */
13757
+ close(tabGroup: TabGroup | readonly TabGroup[], preserveFocus?: boolean): Thenable<boolean>;
13758
+ }
13799
13759
 
13800
13760
  /**
13801
13761
  * Represents a notebook editor that is attached to a {@link NotebookDocument notebook}.
@@ -13933,7 +13893,6 @@ export module '@theia/plugin' {
13933
13893
 
13934
13894
  /**
13935
13895
  * The {@link NotebookDocument notebook} that contains this cell.
13936
- * @stubbed
13937
13896
  */
13938
13897
  readonly notebook: NotebookDocument;
13939
13898
 
@@ -13994,26 +13953,22 @@ export module '@theia/plugin' {
13994
13953
  /**
13995
13954
  * The version number of this notebook (it will strictly increase after each
13996
13955
  * change, including undo/redo).
13997
- * @stubbed
13998
13956
  */
13999
13957
  readonly version: number;
14000
13958
 
14001
13959
  /**
14002
13960
  * `true` if there are unpersisted changes.
14003
- * @stubbed
14004
13961
  */
14005
13962
  readonly isDirty: boolean;
14006
13963
 
14007
13964
  /**
14008
13965
  * Is this notebook representing an untitled file which has not been saved yet.
14009
- * @stubbed
14010
13966
  */
14011
13967
  readonly isUntitled: boolean;
14012
13968
 
14013
13969
  /**
14014
13970
  * `true` if the notebook has been closed. A closed notebook isn't synchronized anymore
14015
13971
  * and won't be re-used when the same resource is opened again.
14016
- * @stubbed
14017
13972
  */
14018
13973
  readonly isClosed: boolean;
14019
13974