@theia/plugin 1.39.0 → 1.40.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.39.0",
+  "version": "1.40.0",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -27,10 +27,10 @@
     "watch": "theiaext watch"
   },
   "devDependencies": {
-    "@theia/ext-scripts": "1.39.0"
+    "@theia/ext-scripts": "1.40.0"
   },
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "a5e754cd31e74d50031449d42347d65a9f3581d9"
+  "gitHead": "b2c84f963c24bde22dbdecd8c506eccc0768f400"
 }

package/src/theia.d.ts

@@ -22,9 +22,11 @@
  *--------------------------------------------------------------------------------------------*/
 
 import './theia-extra';
+import './theia.proposed.canonicalUriProvider';
 import './theia.proposed.customEditorMove';
 import './theia.proposed.diffCommand';
 import './theia.proposed.documentPaste';
+import './theia.proposed.dropMetadata';
 import './theia.proposed.editSessionIdentityProvider';
 import './theia.proposed.extensionsAny';
 import './theia.proposed.externalUriOpener';
@@ -33,6 +35,7 @@ import './theia.proposed.fsChunks';
 import './theia.proposed.profileContentHandlers';
 import './theia.proposed.resolvers';
 import './theia.proposed.scmValidation';
+import './theia.proposed.shareProvider';
 import './theia.proposed.terminalQuickFixProvider';
 import './theia.proposed.textSearchProvider';
 import './theia.proposed.timeline';
@@ -12627,6 +12630,9 @@ export module '@theia/plugin' {
 
         /** Controls whether the terminal is cleared before executing the task. */
         clear?: boolean;
+
+        /** Controls whether the terminal is closed after executing the task. */
+        close?: boolean;
     }
 
     /**
@@ -13665,6 +13671,17 @@ export module '@theia/plugin' {
         readonly label: string;
     }
 
+    /**
+     * Optional options to be used when calling {@link authentication.getSession} with the flag `forceNewSession`.
+     */
+    export interface AuthenticationForceNewSessionOptions {
+        /**
+         * An optional message that will be displayed to the user when we ask to re-authenticate. Providing additional context
+         * as to why you are asking a user to re-authenticate can help increase the odds that they will accept.
+         */
+        detail?: string;
+    }
+
     /**
      * Options to be used when getting an {@link AuthenticationSession AuthenticationSession} from an {@link AuthenticationProvider AuthenticationProvider}.
      */
@@ -13699,7 +13716,7 @@ export module '@theia/plugin' {
          *
          * Defaults to false.
          */
-        forceNewSession?: boolean | { detail: string };
+        forceNewSession?: boolean | AuthenticationForceNewSessionOptions;
 
         /**
          * Whether we should show the indication to sign in in the Accounts menu.

package/src/theia.proposed.canonicalUriProvider.d.ts

@@ -0,0 +1,64 @@
+// *****************************************************************************
+// Copyright (C) 2023 STMicroelectronics and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+// code copied and modified from https://github.com/microsoft/vscode/blob/1.79.0/src/vscode-dts/vscode.proposed.canonicalUriProvider.d.ts
+
+export module '@theia/plugin' {
+
+    // https://github.com/microsoft/vscode/issues/180582
+
+    export namespace workspace {
+        /**
+         *
+         * @param scheme The URI scheme that this provider can provide canonical URIs for.
+         * A canonical URI represents the conversion of a resource's alias into a source of truth URI.
+         * Multiple aliases may convert to the same source of truth URI.
+         * @param provider A provider which can convert URIs of scheme @param scheme to
+         * a canonical URI which is stable across machines.
+         */
+        export function registerCanonicalUriProvider(scheme: string, provider: CanonicalUriProvider): Disposable;
+
+        /**
+         *
+         * @param uri The URI to provide a canonical URI for.
+         * @param token A cancellation token for the request.
+         */
+        export function getCanonicalUri(uri: Uri, options: CanonicalUriRequestOptions, token: CancellationToken): ProviderResult<Uri>;
+    }
+
+    export interface CanonicalUriProvider {
+        /**
+         *
+         * @param uri The URI to provide a canonical URI for.
+         * @param options Options that the provider should honor in the URI it returns.
+         * @param token A cancellation token for the request.
+         * @returns The canonical URI for the requested URI or undefined if no canonical URI can be provided.
+         */
+        provideCanonicalUri(uri: Uri, options: CanonicalUriRequestOptions, token: CancellationToken): ProviderResult<Uri>;
+    }
+
+    export interface CanonicalUriRequestOptions {
+        /**
+         *
+         * The desired scheme of the canonical URI.
+         */
+        targetScheme: string;
+    }
+}

package/src/theia.proposed.documentPaste.d.ts

@@ -18,7 +18,7 @@
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-// code copied and modified from https://github.com/microsoft/vscode/blob/1.77.0/src/vscode-dts/vscode.proposed.documentPaste.d.ts
+// code copied and modified from https://github.com/microsoft/vscode/blob/1.79.0/src/vscode-dts/vscode.proposed.documentPaste.d.ts
 
 export module '@theia/plugin' {
 
@@ -52,13 +52,32 @@ export module '@theia/plugin' {
          *
          * @return Optional workspace edit that applies the paste. Return undefined to use standard pasting.
          */
-        provideDocumentPasteEdits(document: TextDocument, ranges: readonly Range[], dataTransfer: DataTransfer, token: CancellationToken): ProviderResult<DocumentPasteEdit>;
+        provideDocumentPasteEdits?(document: TextDocument, ranges: readonly Range[], dataTransfer: DataTransfer, token: CancellationToken): ProviderResult<DocumentPasteEdit>;
     }
 
     /**
      * An operation applied on paste
      */
     class DocumentPasteEdit {
+        /**
+         * Identifies the type of edit.
+         *
+         * This id should be unique within the extension but does not need to be unique across extensions.
+         */
+        id: string;
+
+        /**
+         * Human readable label that describes the edit.
+         */
+        label: string;
+
+        /**
+         * The relative priority of this edit. Higher priority items are shown first in the UI.
+         *
+         * Defaults to `0`.
+         */
+        priority?: number;
+
         /**
          * The text or snippet to insert at the pasted locations.
          */
@@ -71,17 +90,30 @@ export module '@theia/plugin' {
 
         /**
          * @param insertText The text or snippet to insert at the pasted locations.
+         *
+         * TODO: Reverse args, but this will break existing consumers :(
          */
-        constructor(insertText: string | SnippetString);
+        constructor(insertText: string | SnippetString, id: string, label: string);
     }
 
     interface DocumentPasteProviderMetadata {
         /**
-         * Mime types that `provideDocumentPasteEdits` should be invoked for.
+         * Mime types that {@link DocumentPasteEditProvider.prepareDocumentPaste provideDocumentPasteEdits} may add on copy.
+         */
+        readonly copyMimeTypes?: readonly string[];
+
+        /**
+         * Mime types that {@link DocumentPasteEditProvider.provideDocumentPasteEdits provideDocumentPasteEdits} should be invoked for.
+         *
+         * This can either be an exact mime type such as `image/png`, or a wildcard pattern such as `image/*`.
+         *
+         * Use `text/uri-list` for resources dropped from the explorer or other tree views in the workbench.
          *
-         * Use the special `files` mimetype to indicate the provider should be invoked if any files are present in the `DataTransfer`.
+         * Use `files` to indicate that the provider should be invoked if any {@link DataTransferFile files} are present in the {@link DataTransfer}.
+         * Note that {@link DataTransferFile} entries are only created when dropping content from outside the editor, such as
+         * from the operating system.
          */
-        readonly pasteMimeTypes: readonly string[];
+        readonly pasteMimeTypes?: readonly string[];
     }
 
     namespace languages {

package/src/theia.proposed.dropMetadata.d.ts

@@ -0,0 +1,66 @@
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+// code copied and modified from https://github.com/microsoft/vscode/blob/1.79.0/src/vscode-dts/vscode.proposed.dropMetadata.d.ts
+
+export module '@theia/plugin' {
+
+    // https://github.com/microsoft/vscode/issues/179430
+
+    export interface DocumentDropEdit {
+        /**
+         * Identifies the type of edit.
+         *
+         * This id should be unique within the extension but does not need to be unique across extensions.
+         */
+        id?: string;
+
+        /**
+         * The relative priority of this edit. Higher priority items are shown first in the UI.
+         *
+         * Defaults to `0`.
+         */
+        priority?: number;
+
+        /**
+         * Human readable label that describes the edit.
+         */
+        label?: string;
+    }
+
+    export interface DocumentDropEditProviderMetadata {
+        /**
+         * List of data transfer types that the provider supports.
+         *
+         * This can either be an exact mime type such as `image/png`, or a wildcard pattern such as `image/*`.
+         *
+         * Use `text/uri-list` for resources dropped from the explorer or other tree views in the workbench.
+         *
+         * Use `files` to indicate that the provider should be invoked if any {@link DataTransferFile files} are present in the {@link DataTransfer}.
+         * Note that {@link DataTransferFile} entries are only created when dropping content from outside the editor, such as
+         * from the operating system.
+         */
+        readonly dropMimeTypes: readonly string[];
+    }
+
+    export namespace languages {
+        export function registerDocumentDropEditProvider(selector: DocumentSelector, provider: DocumentDropEditProvider, metadata?: DocumentDropEditProviderMetadata): Disposable;
+    }
+}

package/src/theia.proposed.shareProvider.d.ts

@@ -0,0 +1,92 @@
+// *****************************************************************************
+// Copyright (C) 2023 STMicroelectronics and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+// code copied and modified from https://github.com/microsoft/vscode/blob/release/1.79/src/vscode-dts/vscode.proposed.shareProvider.d.ts
+
+// https://github.com/microsoft/vscode/issues/176316 @joyceerhl
+
+export module '@theia/plugin' {
+
+    /**
+     * Data about an item which can be shared.
+     */
+    export interface ShareableItem {
+        /**
+         * A resource in the workspace that can be shared.
+         */
+        resourceUri: Uri;
+
+        /**
+         * If present, a selection within the `resourceUri`.
+         */
+        selection?: Range;
+    }
+
+    /**
+     * A provider which generates share links for resources in the editor.
+     */
+    export interface ShareProvider {
+
+        /**
+         * A unique ID for the provider.
+         * This will be used to activate specific extensions contributing share providers if necessary.
+         */
+        readonly id: string;
+
+        /**
+         * A label which will be used to present this provider's options in the UI.
+         */
+        readonly label: string;
+
+        /**
+         * The order in which the provider should be listed in the UI when there are multiple providers.
+         */
+        readonly priority: number;
+
+        /**
+         *
+         * @param item Data about an item which can be shared.
+         * @param token A cancellation token.
+         * @returns A {@link Uri} representing an external link or sharing text. The provider result
+         * will be copied to the user's clipboard and presented in a confirmation dialog.
+         */
+        provideShare(item: ShareableItem, token: CancellationToken): ProviderResult<Uri | string>;
+    }
+
+    export namespace window {
+
+        /**
+         * Register a share provider. An extension may register multiple share providers.
+         * There may be multiple share providers for the same {@link ShareableItem}.
+         * @param selector A document selector to filter whether the provider should be shown for a {@link ShareableItem}.
+         * @param provider A share provider.
+         */
+        export function registerShareProvider(selector: DocumentSelector, provider: ShareProvider): Disposable;
+    }
+
+    export interface TreeItem {
+
+        /**
+         * An optional property which, when set, inlines a `Share` option in the context menu for this tree item.
+         */
+        shareableItem?: ShareableItem;
+    }
+}