@theia/plugin 1.53.0-next.55 → 1.53.0-next.64

package/src/theia.proposed.multiDocumentHighlightProvider.ts

@@ -1,82 +1,82 @@
-// *****************************************************************************
-// 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.85.1/src/vscode-dts/vscode.proposed.multiDocumentHighlightProvider.d.ts
-
-declare module '@theia/plugin' {
-
-    /**
-     * Represents a collection of document highlights from multiple documents.
-     */
-    export class MultiDocumentHighlight {
-
-        /**
-         * The URI of the document containing the highlights.
-         */
-        uri: Uri;
-
-        /**
-         * The highlights for the document.
-         */
-        highlights: DocumentHighlight[];
-
-        /**
-         * Creates a new instance of MultiDocumentHighlight.
-         * @param uri The URI of the document containing the highlights.
-         * @param highlights The highlights for the document.
-         */
-        constructor(uri: Uri, highlights: DocumentHighlight[]);
-    }
-
-    export interface MultiDocumentHighlightProvider {
-
-        /**
-         * Provide a set of document highlights, like all occurrences of a variable or
-         * all exit-points of a function.
-         *
-         * @param document The document in which the command was invoked.
-         * @param position The position at which the command was invoked.
-         * @param otherDocuments An array of additional valid documents for which highlights should be provided.
-         * @param token A cancellation token.
-         * @returns A Map containing a mapping of the Uri of a document to the document highlights or a thenable that resolves to such. The lack of a result can be
-         * signaled by returning `undefined`, `null`, or an empty map.
-         */
-        provideMultiDocumentHighlights(document: TextDocument, position: Position, otherDocuments: TextDocument[], token: CancellationToken):
-            ProviderResult<MultiDocumentHighlight[]>;
-    }
-
-    namespace languages {
-
-        /**
-         * Register a multi document highlight provider.
-         *
-         * Multiple providers can be registered for a language. In that case providers are sorted
-         * by their {@link languages.match score} and groups sequentially asked for document highlights.
-         * The process stops when a provider returns a `non-falsy` or `non-failure` result.
-         *
-         * @param selector A selector that defines the documents this provider is applicable to.
-         * @param provider A multi-document highlight provider.
-         * @returns A {@link Disposable} that unregisters this provider when being disposed.
-         * @stubbed
-         */
-        export function registerMultiDocumentHighlightProvider(selector: DocumentSelector, provider: MultiDocumentHighlightProvider): Disposable;
-    }
-
-}
+// *****************************************************************************
+// 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.85.1/src/vscode-dts/vscode.proposed.multiDocumentHighlightProvider.d.ts
+
+declare module '@theia/plugin' {
+
+    /**
+     * Represents a collection of document highlights from multiple documents.
+     */
+    export class MultiDocumentHighlight {
+
+        /**
+         * The URI of the document containing the highlights.
+         */
+        uri: Uri;
+
+        /**
+         * The highlights for the document.
+         */
+        highlights: DocumentHighlight[];
+
+        /**
+         * Creates a new instance of MultiDocumentHighlight.
+         * @param uri The URI of the document containing the highlights.
+         * @param highlights The highlights for the document.
+         */
+        constructor(uri: Uri, highlights: DocumentHighlight[]);
+    }
+
+    export interface MultiDocumentHighlightProvider {
+
+        /**
+         * Provide a set of document highlights, like all occurrences of a variable or
+         * all exit-points of a function.
+         *
+         * @param document The document in which the command was invoked.
+         * @param position The position at which the command was invoked.
+         * @param otherDocuments An array of additional valid documents for which highlights should be provided.
+         * @param token A cancellation token.
+         * @returns A Map containing a mapping of the Uri of a document to the document highlights or a thenable that resolves to such. The lack of a result can be
+         * signaled by returning `undefined`, `null`, or an empty map.
+         */
+        provideMultiDocumentHighlights(document: TextDocument, position: Position, otherDocuments: TextDocument[], token: CancellationToken):
+            ProviderResult<MultiDocumentHighlight[]>;
+    }
+
+    namespace languages {
+
+        /**
+         * Register a multi document highlight provider.
+         *
+         * Multiple providers can be registered for a language. In that case providers are sorted
+         * by their {@link languages.match score} and groups sequentially asked for document highlights.
+         * The process stops when a provider returns a `non-falsy` or `non-failure` result.
+         *
+         * @param selector A selector that defines the documents this provider is applicable to.
+         * @param provider A multi-document highlight provider.
+         * @returns A {@link Disposable} that unregisters this provider when being disposed.
+         * @stubbed
+         */
+        export function registerMultiDocumentHighlightProvider(selector: DocumentSelector, provider: MultiDocumentHighlightProvider): Disposable;
+    }
+
+}

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

@@ -1,68 +1,68 @@
-// *****************************************************************************
-// 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.
- *--------------------------------------------------------------------------------------------*/
-
-declare module '@theia/plugin' {
-
-    // https://github.com/microsoft/vscode/issues/124970
-
-    /**
-     * The execution state of a notebook cell.
-     */
-    export enum NotebookCellExecutionState {
-        /**
-         * The cell is idle.
-         */
-        Idle = 1,
-        /**
-         * Execution for the cell is pending.
-         */
-        Pending = 2,
-        /**
-         * The cell is currently executing.
-         */
-        Executing = 3,
-    }
-
-    /**
-     * An event describing a cell execution state change.
-     */
-    export interface NotebookCellExecutionStateChangeEvent {
-        /**
-         * The {@link NotebookCell cell} for which the execution state has changed.
-         */
-        readonly cell: NotebookCell;
-
-        /**
-         * The new execution state of the cell.
-         */
-        readonly state: NotebookCellExecutionState;
-    }
-
-    export namespace notebooks {
-
-        /**
-         * An {@link Event} which fires when the execution state of a cell has changed.
-         */
-        // todo@API this is an event that is fired for a property that cells don't have and that makes me wonder
-        // how a correct consumer works, e.g the consumer could have been late and missed an event?
-        export const onDidChangeNotebookCellExecutionState: Event<NotebookCellExecutionStateChangeEvent>;
-    }
-}
+// *****************************************************************************
+// 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.
+ *--------------------------------------------------------------------------------------------*/
+
+declare module '@theia/plugin' {
+
+    // https://github.com/microsoft/vscode/issues/124970
+
+    /**
+     * The execution state of a notebook cell.
+     */
+    export enum NotebookCellExecutionState {
+        /**
+         * The cell is idle.
+         */
+        Idle = 1,
+        /**
+         * Execution for the cell is pending.
+         */
+        Pending = 2,
+        /**
+         * The cell is currently executing.
+         */
+        Executing = 3,
+    }
+
+    /**
+     * An event describing a cell execution state change.
+     */
+    export interface NotebookCellExecutionStateChangeEvent {
+        /**
+         * The {@link NotebookCell cell} for which the execution state has changed.
+         */
+        readonly cell: NotebookCell;
+
+        /**
+         * The new execution state of the cell.
+         */
+        readonly state: NotebookCellExecutionState;
+    }
+
+    export namespace notebooks {
+
+        /**
+         * An {@link Event} which fires when the execution state of a cell has changed.
+         */
+        // todo@API this is an event that is fired for a property that cells don't have and that makes me wonder
+        // how a correct consumer works, e.g the consumer could have been late and missed an event?
+        export const onDidChangeNotebookCellExecutionState: Event<NotebookCellExecutionStateChangeEvent>;
+    }
+}

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

@@ -1,62 +1,62 @@
-// *****************************************************************************
-// 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.
- *--------------------------------------------------------------------------------------------*/
-
-declare module '@theia/plugin' {
-    export interface NotebookControllerDetectionTask {
-        /**
-         * Dispose and remove the detection task.
-         */
-        dispose(): void;
-    }
-
-    export class NotebookKernelSourceAction {
-        readonly label: string;
-        readonly description?: string;
-        readonly detail?: string;
-        readonly command: string | Command;
-        readonly documentation?: Uri;
-
-        constructor(label: string);
-    }
-
-    export interface NotebookKernelSourceActionProvider {
-        /**
-         * An optional event to signal that the kernel source actions have changed.
-         */
-        onDidChangeNotebookKernelSourceActions?: Event<void>;
-        /**
-         * Provide kernel source actions
-         */
-        provideNotebookKernelSourceActions(token: CancellationToken): ProviderResult<NotebookKernelSourceAction[]>;
-    }
-
-    export namespace notebooks {
-        /**
-         * Create notebook controller detection task
-         */
-        export function createNotebookControllerDetectionTask(notebookType: string): NotebookControllerDetectionTask;
-
-        /**
-         * Register a notebook kernel source action provider
-         */
-        export function registerKernelSourceActionProvider(notebookType: string, provider: NotebookKernelSourceActionProvider): Disposable;
-    }
-}
+// *****************************************************************************
+// 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.
+ *--------------------------------------------------------------------------------------------*/
+
+declare module '@theia/plugin' {
+    export interface NotebookControllerDetectionTask {
+        /**
+         * Dispose and remove the detection task.
+         */
+        dispose(): void;
+    }
+
+    export class NotebookKernelSourceAction {
+        readonly label: string;
+        readonly description?: string;
+        readonly detail?: string;
+        readonly command: string | Command;
+        readonly documentation?: Uri;
+
+        constructor(label: string);
+    }
+
+    export interface NotebookKernelSourceActionProvider {
+        /**
+         * An optional event to signal that the kernel source actions have changed.
+         */
+        onDidChangeNotebookKernelSourceActions?: Event<void>;
+        /**
+         * Provide kernel source actions
+         */
+        provideNotebookKernelSourceActions(token: CancellationToken): ProviderResult<NotebookKernelSourceAction[]>;
+    }
+
+    export namespace notebooks {
+        /**
+         * Create notebook controller detection task
+         */
+        export function createNotebookControllerDetectionTask(notebookType: string): NotebookControllerDetectionTask;
+
+        /**
+         * Register a notebook kernel source action provider
+         */
+        export function registerKernelSourceActionProvider(notebookType: string, provider: NotebookKernelSourceActionProvider): Disposable;
+    }
+}

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

@@ -1,84 +1,84 @@
-// *****************************************************************************
-// 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.
- *--------------------------------------------------------------------------------------------*/
-
-declare module '@theia/plugin' {
-
-    // https://github.com/microsoft/vscode/issues/123601
-
-    /**
-     * Represents a script that is loaded into the notebook renderer before rendering output. This allows
-     * to provide and share functionality for notebook markup and notebook output renderers.
-     */
-    export class NotebookRendererScript {
-
-        /**
-         * APIs that the preload provides to the renderer. These are matched
-         * against the `dependencies` and `optionalDependencies` arrays in the
-         * notebook renderer contribution point.
-         */
-        provides: readonly string[];
-
-        /**
-         * URI of the JavaScript module to preload.
-         *
-         * This module must export an `activate` function that takes a context object that contains the notebook API.
-         */
-        uri: Uri;
-
-        /**
-         * @param uri URI of the JavaScript module to preload
-         * @param provides Value for the `provides` property
-         */
-        constructor(uri: Uri, provides?: string | readonly string[]);
-    }
-
-    export interface NotebookController {
-
-        // todo@API allow add, not remove
-        readonly rendererScripts: NotebookRendererScript[];
-
-        /**
-         * An event that fires when a {@link NotebookController.rendererScripts renderer script} has send a message to
-         * the controller.
-         */
-        readonly onDidReceiveMessage: Event<{ readonly editor: NotebookEditor; readonly message: unknown }>;
-
-        /**
-         * Send a message to the renderer of notebook editors.
-         *
-         * Note that only editors showing documents that are bound to this controller
-         * are receiving the message.
-         *
-         * @param message The message to send.
-         * @param editor A specific editor to send the message to. When `undefined` all applicable editors are receiving the message.
-         * @returns A promise that resolves to a boolean indicating if the message has been send or not.
-         */
-        postMessage(message: unknown, editor?: NotebookEditor): Thenable<boolean>;
-
-        asWebviewUri(localResource: Uri): Uri;
-    }
-
-    export namespace notebooks {
-
-        export function createNotebookController(id: string, viewType: string, label: string, handler?: (cells: NotebookCell[], notebook: NotebookDocument,
-            controller: NotebookController) => void | Thenable<void>, rendererScripts?: NotebookRendererScript[]): NotebookController;
-    }
-}
+// *****************************************************************************
+// 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.
+ *--------------------------------------------------------------------------------------------*/
+
+declare module '@theia/plugin' {
+
+    // https://github.com/microsoft/vscode/issues/123601
+
+    /**
+     * Represents a script that is loaded into the notebook renderer before rendering output. This allows
+     * to provide and share functionality for notebook markup and notebook output renderers.
+     */
+    export class NotebookRendererScript {
+
+        /**
+         * APIs that the preload provides to the renderer. These are matched
+         * against the `dependencies` and `optionalDependencies` arrays in the
+         * notebook renderer contribution point.
+         */
+        provides: readonly string[];
+
+        /**
+         * URI of the JavaScript module to preload.
+         *
+         * This module must export an `activate` function that takes a context object that contains the notebook API.
+         */
+        uri: Uri;
+
+        /**
+         * @param uri URI of the JavaScript module to preload
+         * @param provides Value for the `provides` property
+         */
+        constructor(uri: Uri, provides?: string | readonly string[]);
+    }
+
+    export interface NotebookController {
+
+        // todo@API allow add, not remove
+        readonly rendererScripts: NotebookRendererScript[];
+
+        /**
+         * An event that fires when a {@link NotebookController.rendererScripts renderer script} has send a message to
+         * the controller.
+         */
+        readonly onDidReceiveMessage: Event<{ readonly editor: NotebookEditor; readonly message: unknown }>;
+
+        /**
+         * Send a message to the renderer of notebook editors.
+         *
+         * Note that only editors showing documents that are bound to this controller
+         * are receiving the message.
+         *
+         * @param message The message to send.
+         * @param editor A specific editor to send the message to. When `undefined` all applicable editors are receiving the message.
+         * @returns A promise that resolves to a boolean indicating if the message has been send or not.
+         */
+        postMessage(message: unknown, editor?: NotebookEditor): Thenable<boolean>;
+
+        asWebviewUri(localResource: Uri): Uri;
+    }
+
+    export namespace notebooks {
+
+        export function createNotebookController(id: string, viewType: string, label: string, handler?: (cells: NotebookCell[], notebook: NotebookDocument,
+            controller: NotebookController) => void | Thenable<void>, rendererScripts?: NotebookRendererScript[]): NotebookController;
+    }
+}