@theia/plugin-ext 1.34.0 → 1.35.0

package/package.json

@@ -1,34 +1,35 @@
 {
   "name": "@theia/plugin-ext",
-  "version": "1.34.0",
+  "version": "1.35.0",
   "description": "Theia - Plugin Extension",
   "main": "lib/common/index.js",
   "typings": "lib/common/index.d.ts",
   "dependencies": {
-    "@theia/bulk-edit": "1.34.0",
-    "@theia/callhierarchy": "1.34.0",
-    "@theia/console": "1.34.0",
-    "@theia/core": "1.34.0",
-    "@theia/debug": "1.34.0",
-    "@theia/editor": "1.34.0",
-    "@theia/file-search": "1.34.0",
-    "@theia/filesystem": "1.34.0",
-    "@theia/markers": "1.34.0",
-    "@theia/messages": "1.34.0",
-    "@theia/monaco": "1.34.0",
+    "@theia/bulk-edit": "1.35.0",
+    "@theia/callhierarchy": "1.35.0",
+    "@theia/console": "1.35.0",
+    "@theia/core": "1.35.0",
+    "@theia/debug": "1.35.0",
+    "@theia/editor": "1.35.0",
+    "@theia/editor-preview": "1.35.0",
+    "@theia/file-search": "1.35.0",
+    "@theia/filesystem": "1.35.0",
+    "@theia/markers": "1.35.0",
+    "@theia/messages": "1.35.0",
+    "@theia/monaco": "1.35.0",
     "@theia/monaco-editor-core": "1.72.3",
-    "@theia/navigator": "1.34.0",
-    "@theia/output": "1.34.0",
-    "@theia/plugin": "1.34.0",
-    "@theia/preferences": "1.34.0",
-    "@theia/scm": "1.34.0",
-    "@theia/search-in-workspace": "1.34.0",
-    "@theia/task": "1.34.0",
-    "@theia/terminal": "1.34.0",
-    "@theia/timeline": "1.34.0",
-    "@theia/typehierarchy": "1.34.0",
-    "@theia/variable-resolver": "1.34.0",
-    "@theia/workspace": "1.34.0",
+    "@theia/navigator": "1.35.0",
+    "@theia/output": "1.35.0",
+    "@theia/plugin": "1.35.0",
+    "@theia/preferences": "1.35.0",
+    "@theia/scm": "1.35.0",
+    "@theia/search-in-workspace": "1.35.0",
+    "@theia/task": "1.35.0",
+    "@theia/terminal": "1.35.0",
+    "@theia/timeline": "1.35.0",
+    "@theia/typehierarchy": "1.35.0",
+    "@theia/variable-resolver": "1.35.0",
+    "@theia/workspace": "1.35.0",
     "@types/mime": "^2.0.1",
     "@vscode/debugprotocol": "^1.51.0",
     "decompress": "^4.2.1",
@@ -85,7 +86,7 @@
     "watch": "theiaext watch"
   },
   "devDependencies": {
-    "@theia/ext-scripts": "1.34.0",
+    "@theia/ext-scripts": "1.35.0",
     "@types/decompress": "^4.2.2",
     "@types/escape-html": "^0.0.20",
     "@types/lodash.clonedeep": "^4.5.3",
@@ -95,5 +96,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "a8c403b103829a1b8b092ce741ef3826804f773b"
+  "gitHead": "5b1e4f9b913cf1b0d27acd4bc435cb2570f164d8"
 }

package/src/common/plugin-api-rpc-model.ts

@@ -18,7 +18,7 @@ import * as theia from '@theia/plugin';
 import type * as monaco from '@theia/monaco-editor-core';
 import { MarkdownString as MarkdownStringDTO } from '@theia/core/lib/common/markdown-rendering';
 import { UriComponents } from './uri-components';
-import { CompletionItemTag } from '../plugin/types-impl';
+import { CompletionItemTag, SnippetString } from '../plugin/types-impl';
 import { Event as TheiaEvent } from '@theia/core/lib/common/event';
 import { URI } from '@theia/core/shared/vscode-uri';
 import { SerializedRegExp } from './plugin-api-rpc';
@@ -324,6 +324,27 @@ export interface TextEdit {
     eol?: monaco.editor.EndOfLineSequence;
 }
 
+export interface DocumentDropEdit {
+    insertText: string | SnippetString;
+    additionalEdit?: WorkspaceEdit;
+}
+
+export interface DataTransferFileDTO {
+    readonly name: string;
+    readonly uri?: UriComponents;
+}
+
+export interface DataTransferItemDTO {
+    readonly id: string;
+    readonly asString: string;
+    readonly fileData: DataTransferFileDTO | undefined;
+    readonly uriListData?: ReadonlyArray<string | UriComponents>;
+}
+
+export interface DataTransferDTO {
+    readonly items: Array<[/* type */string, DataTransferItemDTO]>;
+}
+
 export interface Location {
     uri: UriComponents;
     range: Range;

package/src/common/plugin-api-rpc.ts

@@ -84,7 +84,9 @@ import {
     TypeHierarchyItem,
     InlineCompletion,
     InlineCompletions,
-    InlineCompletionContext
+    InlineCompletionContext,
+    DocumentDropEdit,
+    DataTransferDTO
 } from './plugin-api-rpc-model';
 import { ExtPluginApi } from './plugin-ext-api-contribution';
 import { KeysToAnyValues, KeysToKeysToAnyValue } from './types';
@@ -1244,7 +1246,7 @@ export interface TextEditorsMain {
     $tryRevealRange(id: string, range: Range, revealType: TextEditorRevealType): Promise<void>;
     $trySetSelections(id: string, selections: Selection[]): Promise<void>;
     $tryApplyEdits(id: string, modelVersionId: number, edits: SingleEditOperation[], opts: ApplyEditsOptions): Promise<boolean>;
-    $tryApplyWorkspaceEdit(workspaceEditDto: WorkspaceEditDto): Promise<boolean>;
+    $tryApplyWorkspaceEdit(workspaceEditDto: WorkspaceEditDto, metadata?: WorkspaceEditMetadataDto): Promise<boolean>;
     $tryInsertSnippet(id: string, template: string, selections: Range[], opts: UndoStopOptions): Promise<boolean>;
     $saveAll(includeUntitled?: boolean): Promise<boolean>;
     // $getDiffInformation(id: string): Promise<editorCommon.ILineChange[]>;
@@ -1416,7 +1418,7 @@ export interface CodeActionDto {
     disabled?: string;
 }
 
-export interface WorkspaceEditMetadataDto {
+export interface WorkspaceEditEntryMetadataDto {
     needsConfirmation: boolean;
     label: string;
     description?: string;
@@ -1432,14 +1434,14 @@ export interface WorkspaceFileEditDto {
     oldResource?: UriComponents;
     newResource?: UriComponents;
     options?: FileOperationOptions;
-    metadata?: WorkspaceEditMetadataDto;
+    metadata?: WorkspaceEditEntryMetadataDto;
 }
 
 export interface WorkspaceTextEditDto {
     resource: UriComponents;
     modelVersionId?: number;
     textEdit: TextEdit & { insertAsSnippet?: boolean };
-    metadata?: WorkspaceEditMetadataDto;
+    metadata?: WorkspaceEditEntryMetadataDto;
 }
 export namespace WorkspaceTextEditDto {
     export function is(arg: WorkspaceTextEditDto | WorkspaceFileEditDto): arg is WorkspaceTextEditDto {
@@ -1450,6 +1452,9 @@ export namespace WorkspaceTextEditDto {
             && typeof arg.textEdit === 'object';
     }
 }
+export interface WorkspaceEditMetadataDto {
+    isRefactoring?: boolean;
+}
 
 export interface WorkspaceEditDto {
     edits: Array<WorkspaceTextEditDto | WorkspaceFileEditDto>;
@@ -1557,6 +1562,13 @@ export interface LanguagesExt {
         options: FormattingOptions,
         token: CancellationToken
     ): Promise<TextEdit[] | undefined>;
+    $provideDocumentDropEdits(
+        handle: number,
+        resource: UriComponents,
+        position: Position,
+        dataTransfer: DataTransferDTO,
+        token: CancellationToken
+    ): Promise<DocumentDropEdit | undefined>;
     $provideDocumentLinks(handle: number, resource: UriComponents, token: CancellationToken): Promise<DocumentLink[] | undefined>;
     $resolveDocumentLink(handle: number, link: DocumentLink, token: CancellationToken): Promise<DocumentLink | undefined>;
     $releaseDocumentLinks(handle: number, ids: number[]): void;
@@ -1637,6 +1649,7 @@ export interface LanguagesMain {
     $clearDiagnostics(id: string): void;
     $changeDiagnostics(id: string, delta: [string, MarkerData[]][]): void;
     $registerDocumentFormattingSupport(handle: number, pluginInfo: PluginInfo, selector: SerializedDocumentFilter[]): void;
+    $registerDocumentDropEditProvider(handle: number, selector: SerializedDocumentFilter[]): void
     $registerRangeFormattingSupport(handle: number, pluginInfo: PluginInfo, selector: SerializedDocumentFilter[]): void;
     $registerOnTypeFormattingProvider(handle: number, pluginInfo: PluginInfo, selector: SerializedDocumentFilter[], autoFormatTriggerCharacters: string[]): void;
     $registerDocumentLinkProvider(handle: number, pluginInfo: PluginInfo, selector: SerializedDocumentFilter[]): void;
@@ -2037,7 +2050,7 @@ export interface TabOperation {
 export interface TabDto {
     id: string;
     label: string;
-    input: any;
+    input: AnyInputDto;
     editorId?: string;
     isActive: boolean;
     isPinned: boolean;

package/src/common/plugin-protocol.ts

@@ -72,6 +72,7 @@ export namespace PluginPackage {
  * This interface describes a package.json contribution section object.
  */
 export interface PluginPackageContribution {
+    authentication?: PluginPackageAuthenticationProvider[];
     configuration?: RecursivePartial<PreferenceSchema> | RecursivePartial<PreferenceSchema>[];
     configurationDefaults?: RecursivePartial<PreferenceSchemaProperties>;
     languages?: PluginPackageLanguageContribution[];
@@ -96,16 +97,29 @@ export interface PluginPackageContribution {
     resourceLabelFormatters?: ResourceLabelFormatter[];
     localizations?: PluginPackageLocalization[];
     terminal?: PluginPackageTerminal;
+    notebooks?: PluginPackageNotebook[];
+}
+
+export interface PluginPackageNotebook {
+    type: string;
+    displayName: string;
+    selector?: readonly { filenamePattern?: string; excludeFileNamePattern?: string }[];
+    priority?: string;
+}
+
+export interface PluginPackageAuthenticationProvider {
+    id: string;
+    label: string;
 }
 
 export interface PluginPackageTerminalProfile {
-    title: string,
-    id: string,
-    icon?: string
+    title: string;
+    id: string;
+    icon?: string;
 }
 
 export interface PluginPackageTerminal {
-    profiles: PluginPackageTerminalProfile[]
+    profiles: PluginPackageTerminalProfile[];
 }
 
 export interface PluginPackageLocalization {
@@ -544,6 +558,7 @@ export interface PluginEntryPoint {
  */
 export interface PluginContribution {
     activationEvents?: string[];
+    authentication?: AuthenticationProviderInformation[];
     configuration?: PreferenceSchema[];
     configurationDefaults?: PreferenceSchemaProperties;
     languages?: LanguageContribution[];
@@ -567,6 +582,19 @@ export interface PluginContribution {
     resourceLabelFormatters?: ResourceLabelFormatter[];
     localizations?: Localization[];
     terminalProfiles?: TerminalProfile[];
+    notebooks?: NotebookContribution[];
+}
+
+export interface NotebookContribution {
+    type: string;
+    displayName: string;
+    selector?: readonly { filenamePattern?: string; excludeFileNamePattern?: string }[];
+    priority?: string;
+}
+
+export interface AuthenticationProviderInformation {
+    id: string;
+    label: string;
 }
 
 export interface TerminalProfile {

package/src/hosted/browser/hosted-plugin.ts

@@ -778,22 +778,15 @@ export class HostedPluginSupport {
     protected async restoreWebview(webview: WebviewWidget): Promise<void> {
         await this.activateByEvent(`onWebviewPanel:${webview.viewType}`);
         const restore = this.webviewRevivers.get(webview.viewType);
-        if (!restore) {
-            /* eslint-disable max-len */
-            webview.setHTML(this.getDeserializationFailedContents(`
-            <p>The extension providing '${webview.viewType}' view is not capable of restoring it.</p>
-            <p>Want to help fix this? Please inform the extension developer to register a <a href="https://code.visualstudio.com/api/extension-guides/webview#serialization">reviver</a>.</p>
-            `));
-            /* eslint-enable max-len */
-            return;
-        }
-        try {
-            await restore(webview);
-        } catch (e) {
-            webview.setHTML(this.getDeserializationFailedContents(`
-            An error occurred while restoring '${webview.viewType}' view. Please check logs.
-            `));
-            console.error('Failed to restore the webview', e);
+        if (restore) {
+            try {
+                await restore(webview);
+            } catch (e) {
+                webview.setHTML(this.getDeserializationFailedContents(`
+                An error occurred while restoring '${webview.viewType}' view. Please check logs.
+                `));
+                console.error('Failed to restore the webview', e);
+            }
         }
     }
 

package/src/hosted/node/hosted-plugin-process.ts

@@ -126,7 +126,7 @@ export class HostedPluginProcess implements ServerPluginRunner {
             await waitForTerminated.promise;
         }
 
-        this.killProcessTree(cp.pid);
+        this.killProcessTree(cp.pid!);
     }
 
     killProcessTree(parentPid: number): void {
@@ -206,7 +206,7 @@ export class HostedPluginProcess implements ServerPluginRunner {
         childProcess.stderr!.on('data', data => this.logger.error(`[${options.serverName}: ${childProcess.pid}] ${data.toString().trim()}`));
 
         this.logger.debug(`[${options.serverName}: ${childProcess.pid}] IPC started`);
-        childProcess.once('exit', (code: number, signal: string) => this.onChildProcessExit(options.serverName, childProcess.pid, code, signal));
+        childProcess.once('exit', (code: number, signal: string) => this.onChildProcessExit(options.serverName, childProcess.pid!, code, signal));
         childProcess.on('error', err => this.onChildProcessError(err));
         return childProcess;
     }

package/src/hosted/node/plugin-activation-events.ts

@@ -0,0 +1,111 @@
+// *****************************************************************************
+// 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 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { flatten } from '../../common/arrays';
+import { isStringArray, isObject } from '@theia/core/lib/common/types';
+import {
+    PluginPackage,
+    PluginPackageAuthenticationProvider,
+    PluginPackageCommand,
+    PluginPackageCustomEditor,
+    PluginPackageLanguageContribution,
+    PluginPackageNotebook,
+    PluginPackageView
+} from '../../common/plugin-protocol';
+
+/**
+ * Most activation events can be automatically deduced from the package manifest.
+ * This function will update the manifest based on the plugin contributions.
+ */
+export function updateActivationEvents(manifest: PluginPackage): void {
+    if (!isObject(manifest) || !isObject(manifest.contributes) || !manifest.contributes) {
+        return;
+    }
+
+    const activationEvents = new Set(isStringArray(manifest.activationEvents) ? manifest.activationEvents : []);
+
+    if (manifest.contributes.commands) {
+        const value = manifest.contributes.commands;
+        const commands = Array.isArray(value) ? value : [value];
+        updateCommandsContributions(commands, activationEvents);
+    }
+    if (Array.isArray(manifest.contributes.views)) {
+        const views = flatten(Object.values(manifest.contributes.views)) as PluginPackageView[];
+        updateViewsContribution(views, activationEvents);
+    }
+    if (Array.isArray(manifest.contributes.customEditors)) {
+        updateCustomEditorsContribution(manifest.contributes.customEditors, activationEvents);
+    }
+    if (Array.isArray(manifest.contributes.authentication)) {
+        updateAuthenticationProviderContributions(manifest.contributes.authentication, activationEvents);
+    }
+    if (Array.isArray(manifest.contributes.languages)) {
+        updateLanguageContributions(manifest.contributes.languages, activationEvents);
+    }
+    if (Array.isArray(manifest.contributes.notebooks)) {
+        updateNotebookContributions(manifest.contributes.notebooks, activationEvents);
+    }
+
+    manifest.activationEvents = Array.from(activationEvents);
+}
+
+function updateViewsContribution(views: PluginPackageView[], activationEvents: Set<string>): void {
+    for (const view of views) {
+        if (isObject(view) && typeof view.id === 'string') {
+            activationEvents.add(`onView:${view.id}`);
+        }
+    }
+}
+
+function updateCustomEditorsContribution(customEditors: PluginPackageCustomEditor[], activationEvents: Set<string>): void {
+    for (const customEditor of customEditors) {
+        if (isObject(customEditor) && typeof customEditor.viewType === 'string') {
+            activationEvents.add(`onCustomEditor:${customEditor.viewType}`);
+        }
+    }
+}
+
+function updateCommandsContributions(commands: PluginPackageCommand[], activationEvents: Set<string>): void {
+    for (const command of commands) {
+        if (isObject(command) && typeof command.command === 'string') {
+            activationEvents.add(`onCommand:${command.command}`);
+        }
+    }
+}
+
+function updateAuthenticationProviderContributions(authProviders: PluginPackageAuthenticationProvider[], activationEvents: Set<string>): void {
+    for (const authProvider of authProviders) {
+        if (isObject(authProvider) && typeof authProvider.id === 'string') {
+            activationEvents.add(`onAuthenticationRequest:${authProvider.id}`);
+        }
+    }
+}
+
+function updateLanguageContributions(languages: PluginPackageLanguageContribution[], activationEvents: Set<string>): void {
+    for (const language of languages) {
+        if (isObject(language) && typeof language.id === 'string') {
+            activationEvents.add(`onLanguage:${language.id}`);
+        }
+    }
+}
+
+function updateNotebookContributions(notebooks: PluginPackageNotebook[], activationEvents: Set<string>): void {
+    for (const notebook of notebooks) {
+        if (isObject(notebook) && typeof notebook.type === 'string') {
+            activationEvents.add(`onNotebookSerializer:${notebook.type}`);
+        }
+    }
+}

package/src/hosted/node/plugin-manifest-loader.ts

@@ -16,10 +16,10 @@
 
 import * as path from 'path';
 import * as fs from '@theia/core/shared/fs-extra';
-import { PluginIdentifiers } from '../../common';
+import { PluginIdentifiers, PluginPackage } from '../../common';
+import { updateActivationEvents } from './plugin-activation-events';
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export async function loadManifest(pluginPath: string): Promise<any> {
+export async function loadManifest(pluginPath: string): Promise<PluginPackage> {
     const manifest = await fs.readJson(path.join(pluginPath, 'package.json'));
     // translate vscode builtins, as they are published with a prefix. See https://github.com/theia-ide/vscode-builtin-extensions/blob/master/src/republish.js#L50
     const built_prefix = '@theia/vscode-builtin-';
@@ -27,5 +27,6 @@ export async function loadManifest(pluginPath: string): Promise<any> {
         manifest.name = manifest.name.substr(built_prefix.length);
     }
     manifest.publisher ??= PluginIdentifiers.UNPUBLISHED;
+    updateActivationEvents(manifest);
     return manifest;
 }