@theia/plugin 1.49.0 → 1.50.0

package/package.json

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

package/src/theia.d.ts

@@ -26,10 +26,10 @@ 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';
+import './theia.proposed.mappedEditsProvider';
 import './theia.proposed.notebookCellExecutionState';
 import './theia.proposed.notebookKernelSource';
 import './theia.proposed.notebookMessaging';
@@ -2740,6 +2740,12 @@ export module '@theia/plugin' {
          * Whether the current window is focused.
          */
         readonly focused: boolean;
+
+        /**
+         * Whether the window has been interacted with recently. This will change
+         * immediately on activity, or after a short time of user inactivity.
+         */
+        readonly active: boolean;
     }
 
     /**
@@ -7909,7 +7915,7 @@ export module '@theia/plugin' {
          * @param pattern A file glob pattern like `*.{ts,js}` that will be matched on file paths
          * relative to the base path.
          */
-        constructor(base: WorkspaceFolder | Uri | string, pattern: string)
+        constructor(base: WorkspaceFolder | Uri | string, pattern: string);
     }
 
     /**

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

@@ -22,6 +22,47 @@
 
 export module '@theia/plugin' {
 
+    /**
+     * Identifies a {@linkcode DocumentDropEdit} or {@linkcode DocumentPasteEdit}
+     */
+    class DocumentDropOrPasteEditKind {
+        static readonly Empty: DocumentDropOrPasteEditKind;
+
+        private constructor(value: string);
+
+        /**
+         * The raw string value of the kind.
+         */
+        readonly value: string;
+
+        /**
+         * Create a new kind by appending additional scopes to the current kind.
+         *
+         * Does not modify the current kind.
+         */
+        append(...parts: string[]): DocumentDropOrPasteEditKind;
+
+        /**
+         * Checks if this kind intersects `other`.
+         *
+         * The kind `"text.plain"` for example intersects `text`, `"text.plain"` and `"text.plain.list"`,
+         * but not `"unicorn"`, or `"textUnicorn.plain"`.
+         *
+         * @param other Kind to check.
+         */
+        intersects(other: DocumentDropOrPasteEditKind): boolean;
+
+        /**
+         * Checks if `other` is a sub-kind of this `DocumentDropOrPasteEditKind`.
+         *
+         * The kind `"text.plain"` for example contains `"text.plain"` and `"text.plain.list"`,
+         * but not `"text"` or `"unicorn.text.plain"`.
+         *
+         * @param other Kind to check.
+         */
+        contains(other: DocumentDropOrPasteEditKind): boolean;
+    }
+
     /**
      * The reason why paste edits were requested.
      */
@@ -45,7 +86,7 @@ export module '@theia/plugin' {
         /**
          * Requested kind of paste edits to return.
          */
-        readonly only: DocumentPasteEditKind | undefined;
+        readonly only: DocumentDropOrPasteEditKind | undefined;
 
         /**
          * The reason why paste edits were requested.
@@ -59,18 +100,18 @@ export module '@theia/plugin' {
     interface DocumentPasteEditProvider<T extends DocumentPasteEdit = DocumentPasteEdit> {
 
         /**
-         * Optional method invoked after the user copies text in a file.
+         * Optional method invoked after the user copies from a {@link TextEditor text editor}.
          *
-         * This allows the provider to attach copy metadata to the {@link DataTransfer}
-         * which is then passed back to providers in {@linkcode provideDocumentPasteEdits}.
+         * This allows the provider to attach metadata about the copied text to the {@link DataTransfer}. This data
+         * transfer is then passed back to providers in {@linkcode provideDocumentPasteEdits}.
          *
-         * Note that currently any changes to the {@linkcode DataTransfer} are isolated to the current editor session.
-         * This means that added metadata cannot be seen by other applications.
+         * Note that currently any changes to the {@linkcode DataTransfer} are isolated to the current editor window.
+         * This means that any added metadata cannot be seen by other editor windows or by other applications.
          *
-         * @param document Document where the copy took place.
+         * @param document Text document where the copy took place.
          * @param ranges Ranges being copied in {@linkcode document}.
-         * @param dataTransfer The data transfer associated with the copy. You can store additional values on this for later use in  {@linkcode provideDocumentPasteEdits}.
-         * This object is only valid for the duration of this method.
+         * @param dataTransfer The data transfer associated with the copy. You can store additional values on this for
+         * later use in  {@linkcode provideDocumentPasteEdits}. This object is only valid for the duration of this method.
          * @param token A cancellation token.
          *
          * @return Optional thenable that resolves when all changes to the `dataTransfer` are complete.
@@ -78,26 +119,29 @@ export module '@theia/plugin' {
         prepareDocumentPaste?(document: TextDocument, ranges: readonly Range[], dataTransfer: DataTransfer, token: CancellationToken): void | Thenable<void>;
 
         /**
-         * Invoked before the user pastes into a document.
+         * Invoked before the user pastes into a {@link TextEditor text editor}.
          *
          * Returned edits can replace the standard pasting behavior.
          *
          * @param document Document being pasted into
          * @param ranges Range in the {@linkcode document} to paste into.
-         * @param dataTransfer The {@link DataTransfer data transfer} associated with the paste. This object is only valid for the duration of the paste operation.
+         * @param dataTransfer The {@link DataTransfer data transfer} associated with the paste. This object is only
+         * valid for the duration of the paste operation.
          * @param context Additional context for the paste.
          * @param token A cancellation token.
          *
-         * @return Set of potential {@link DocumentPasteEdit edits} that apply the paste. Return `undefined` to use standard pasting.
+         * @return Set of potential {@link DocumentPasteEdit edits} that can apply the paste. Only a single returned
+         * {@linkcode DocumentPasteEdit} is applied at a time. If multiple edits are returned from all providers, then
+         * the first is automatically applied and a widget is shown that lets the user switch to the other edits.
          */
-        provideDocumentPasteEdits?(document: TextDocument, ranges: readonly Range[], dataTransfer: DataTransfer, context: DocumentPasteEditContext,
-            token: CancellationToken): ProviderResult<T[]>;
+        provideDocumentPasteEdits?(document: TextDocument, ranges: readonly Range[], dataTransfer: DataTransfer, context: DocumentPasteEditContext, token: CancellationToken):
+            ProviderResult<T[]>;
 
         /**
          * Optional method which fills in the {@linkcode DocumentPasteEdit.additionalEdit} before the edit is applied.
          *
          * This is called once per edit and should be used if generating the complete edit may take a long time.
-         * Resolve can only be used to change {@link DocumentPasteEdit.additionalEdit}.
+         * Resolve can only be used to change {@linkcode DocumentPasteEdit.additionalEdit}.
          *
          * @param pasteEdit The {@linkcode DocumentPasteEdit} to resolve.
          * @param token A cancellation token.
@@ -109,7 +153,7 @@ export module '@theia/plugin' {
     }
 
     /**
-     * An edit applied on paste.
+     * An edit the applies a paste operation.
      */
     class DocumentPasteEdit {
 
@@ -119,14 +163,14 @@ export module '@theia/plugin' {
         title: string;
 
         /**
-         * {@link DocumentPasteEditKind Kind} of the edit.
-         *
-         * Used to identify specific types of edits.
+         * {@link DocumentDropOrPasteEditKind Kind} of the edit.
          */
-        kind: DocumentPasteEditKind;
+        kind: DocumentDropOrPasteEditKind;
 
         /**
          * The text or snippet to insert at the pasted locations.
+         *
+         * If your edit requires more advanced insertion logic, set this to an empty string and provide an {@link DocumentPasteEdit.additionalEdit additional edit} instead.
          */
         insertText: string | SnippetString;
 
@@ -136,46 +180,33 @@ export module '@theia/plugin' {
         additionalEdit?: WorkspaceEdit;
 
         /**
-         * Controls the ordering of paste edits provided by multiple providers.
+         * Controls ordering when multiple paste edits can potentially be applied.
          *
-         * If this edit yields to another, it will be shown lower in the list of paste edit.
+         * If this edit yields to another, it will be shown lower in the list of possible paste edits shown to the user.
          */
-        yieldTo?: readonly DocumentPasteEditKind[];
+        yieldTo?: readonly DocumentDropOrPasteEditKind[];
 
         /**
          * Create a new paste edit.
          *
          * @param insertText The text or snippet to insert at the pasted locations.
          * @param title Human readable label that describes the edit.
-         * @param kind {@link DocumentPasteEditKind Kind} of the edit.
+         * @param kind {@link DocumentDropOrPasteEditKind Kind} of the edit.
          */
-        constructor(insertText: string | SnippetString, title: string, kind: DocumentPasteEditKind);
+        constructor(insertText: string | SnippetString, title: string, kind: DocumentDropOrPasteEditKind);
     }
 
     /**
-     * TODO: Share with code action kind?
+     * Provides additional metadata about how a {@linkcode DocumentPasteEditProvider} works.
      */
-    class DocumentPasteEditKind {
-        static readonly Empty: DocumentPasteEditKind;
-
-        // TODO: Add `Text` any others?
-
-        private constructor(value: string);
-
-        readonly value: string;
-
-        append(...parts: string[]): CodeActionKind;
-        intersects(other: CodeActionKind): boolean;
-        contains(other: CodeActionKind): boolean;
-    }
-
     interface DocumentPasteProviderMetadata {
         /**
-         * List of {@link DocumentPasteEditKind kinds} that the provider may return in {@linkcode DocumentPasteEditProvider.provideDocumentPasteEdits provideDocumentPasteEdits}.
+         * List of {@link DocumentDropOrPasteEditKind kinds} that the provider may return in
+         * {@linkcode DocumentPasteEditProvider.provideDocumentPasteEdits provideDocumentPasteEdits}.
          *
-         * The provider will only be invoked when one of these kinds is being requested. For normal pasting, all providers will be invoked.
+         * This is used to filter out providers when a specific {@link DocumentDropOrPasteEditKind kind} of edit is requested.
          */
-        readonly providedPasteEditKinds: readonly DocumentPasteEditKind[];
+        readonly providedPasteEditKinds: readonly DocumentDropOrPasteEditKind[];
 
         /**
          * Mime types that {@linkcode DocumentPasteEditProvider.prepareDocumentPaste prepareDocumentPaste} may add on copy.
@@ -190,12 +221,80 @@ export module '@theia/plugin' {
          * 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 {@linkcode DataTransfer}.
-         * Note that {@linkcode DataTransferFile} entries are only created when dropping content from outside the editor, such as
+         * Note that {@linkcode DataTransferFile} entries are only created when pasting content from outside the editor, such as
          * from the operating system.
          */
         readonly pasteMimeTypes?: readonly string[];
     }
 
+    /**
+     * TODO on finalization:
+     * - Add ctor(insertText: string | SnippetString, title?: string, kind?: DocumentDropOrPasteEditKind); Can't be done as this is an extension to an existing class
+     */
+
+    export interface DocumentDropEdit {
+        /**
+         * Human readable label that describes the edit.
+         */
+        title?: string;
+
+        /**
+         * {@link DocumentDropOrPasteEditKind Kind} of the edit.
+         */
+        kind: DocumentDropOrPasteEditKind;
+
+        /**
+         * Controls the ordering or multiple edits. If this provider yield to edits, it will be shown lower in the list.
+         */
+        yieldTo?: readonly DocumentDropOrPasteEditKind[];
+    }
+
+    export interface DocumentDropEditProvider<T extends DocumentDropEdit = DocumentDropEdit> {
+        // Overload that allows returning multiple edits
+        // Will be merged in on finalization
+        provideDocumentDropEdits(document: TextDocument, position: Position, dataTransfer: DataTransfer, token: CancellationToken):
+            ProviderResult<DocumentDropEdit | DocumentDropEdit[]>;
+
+        /**
+         * Optional method which fills in the {@linkcode DocumentDropEdit.additionalEdit} before the edit is applied.
+         *
+         * This is called once per edit and should be used if generating the complete edit may take a long time.
+         * Resolve can only be used to change {@link DocumentDropEdit.additionalEdit}.
+         *
+         * @param pasteEdit The {@linkcode DocumentDropEdit} to resolve.
+         * @param token A cancellation token.
+         *
+         * @returns The resolved edit or a thenable that resolves to such. It is OK to return the given
+         * `edit`. If no result is returned, the given `edit` is used.
+         */
+        resolveDocumentDropEdit?(edit: T, token: CancellationToken): ProviderResult<T>;
+    }
+
+    /**
+     * Provides additional metadata about how a {@linkcode DocumentDropEditProvider} works.
+     */
+    export interface DocumentDropEditProviderMetadata {
+        /**
+         * List of {@link DocumentDropOrPasteEditKind kinds} that the provider may return in {@linkcode DocumentDropEditProvider.provideDocumentDropEdits provideDocumentDropEdits}.
+         *
+         * This is used to filter out providers when a specific {@link DocumentDropOrPasteEditKind kind} of edit is requested.
+         */
+        readonly providedDropEditKinds?: readonly DocumentDropOrPasteEditKind[];
+
+        /**
+         * List of {@link DataTransfer} mime types that the provider can handle.
+         *
+         * 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[];
+    }
+
     namespace languages {
         /**
          * Registers a new {@linkcode DocumentPasteEditProvider}.
@@ -208,5 +307,10 @@ export module '@theia/plugin' {
          * @stubbed
          */
         export function registerDocumentPasteEditProvider(selector: DocumentSelector, provider: DocumentPasteEditProvider, metadata: DocumentPasteProviderMetadata): Disposable;
+
+        /**
+         * Overload which adds extra metadata. Will be removed on finalization.
+         */
+        export function registerDocumentDropEditProvider(selector: DocumentSelector, provider: DocumentDropEditProvider, metadata?: DocumentDropEditProviderMetadata): Disposable;
     }
 }

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

@@ -0,0 +1,59 @@
+// *****************************************************************************
+// Copyright (C) 2024 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.
+ *--------------------------------------------------------------------------------------------*/
+
+export module '@theia/plugin' {
+
+    export interface DocumentContextItem {
+        readonly uri: Uri;
+        readonly version: number;
+        readonly ranges: Range[];
+    }
+
+    export interface MappedEditsContext {
+        documents: DocumentContextItem[][];
+    }
+
+    /**
+     * Interface for providing mapped edits for a given document.
+     */
+    export interface MappedEditsProvider {
+        /**
+         * Provide mapped edits for a given document.
+         * @param document The document to provide mapped edits for.
+         * @param codeBlocks Code blocks that come from an LLM's reply.
+         *                  "Insert at cursor" in the panel chat only sends one edit that the user clicks on, but inline chat can send multiple blocks
+         *                  and let the lang server decide what to do with them.
+         * @param context The context for providing mapped edits.
+         * @param token A cancellation token.
+         * @returns A provider result of text edits.
+         */
+        provideMappedEdits(
+            document: TextDocument,
+            codeBlocks: string[],
+            context: MappedEditsContext,
+            token: CancellationToken
+        ): ProviderResult<WorkspaceEdit | null>;
+    }
+
+    export namespace chat {
+        export function registerMappedEditsProvider(documentSelector: DocumentSelector, provider: MappedEditsProvider): Disposable;
+    }
+}

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

@@ -1,74 +0,0 @@
-// *****************************************************************************
-// 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 {
-
-        /**
-         * Human readable label that describes the edit.
-         */
-        title?: string;
-
-        /**
-         * {@link DocumentPasteEditKind Kind} of the edit.
-         *
-         * Used to identify specific types of edits.
-         *
-         * TODO: use own type?
-         */
-        kind: DocumentPasteEditKind;
-
-        /**
-         * The mime type from the {@link DataTransfer} that this edit applies.
-         */
-        handledMimeType?: string;
-
-        /**
-         * Controls the ordering or multiple paste edits. If this provider yield to edits, it will be shown lower in the list.
-         */
-        yieldTo?: ReadonlyArray<DocumentPasteEditKind>;
-    }
-
-    export interface DocumentDropEditProviderMetadata {
-        readonly providedDropEditKinds?: readonly DocumentPasteEditKind[];
-
-        /**
-         * 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;
-    }
-}