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

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

@@ -1,89 +1,89 @@
-// *****************************************************************************
-// Copyright (C) 2023 Ericsson 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.77.0/src/vscode-dts/vscode.proposed.editSessionIdentityProvider.d.ts
-
-export module '@theia/plugin' {
-
-    // https://github.com/microsoft/vscode/issues/157734
-
-    export namespace workspace {
-        /**
-         * An event that is emitted when an edit session identity is about to be requested.
-         */
-        export const onWillCreateEditSessionIdentity: Event<EditSessionIdentityWillCreateEvent>;
-
-        /**
-         *
-         * @param scheme The URI scheme that this provider can provide edit session identities for.
-         * @param provider A provider which can convert URIs for workspace folders of scheme @param scheme to
-         * an edit session identifier which is stable across machines. This enables edit sessions to be resolved.
-         */
-        export function registerEditSessionIdentityProvider(scheme: string, provider: EditSessionIdentityProvider): Disposable;
-    }
-
-    export interface EditSessionIdentityProvider {
-        /**
-         *
-         * @param workspaceFolder The workspace folder to provide an edit session identity for.
-         * @param token A cancellation token for the request.
-         * @returns A string representing the edit session identity for the requested workspace folder.
-         */
-        provideEditSessionIdentity(workspaceFolder: WorkspaceFolder, token: CancellationToken): ProviderResult<string>;
-
-        /**
-         *
-         * @param identity1 An edit session identity.
-         * @param identity2 A second edit session identity to compare to @param identity1.
-         * @param token A cancellation token for the request.
-         * @returns An {@link EditSessionIdentityMatch} representing the edit session identity match confidence for the provided identities.
-         */
-        provideEditSessionIdentityMatch(identity1: string, identity2: string, token: CancellationToken): ProviderResult<EditSessionIdentityMatch>;
-    }
-
-    export enum EditSessionIdentityMatch {
-        Complete = 100,
-        Partial = 50,
-        None = 0
-    }
-
-    export interface EditSessionIdentityWillCreateEvent {
-
-        /**
-         * A cancellation token.
-         */
-        readonly token: CancellationToken;
-
-        /**
-         * The workspace folder to create an edit session identity for.
-         */
-        readonly workspaceFolder: WorkspaceFolder;
-
-        /**
-         * Allows to pause the event until the provided thenable resolves.
-         *
-         * *Note:* This function can only be called during event dispatch.
-         *
-         * @param thenable A thenable that delays saving.
-         */
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        waitUntil(thenable: Thenable<any>): void;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 Ericsson 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.77.0/src/vscode-dts/vscode.proposed.editSessionIdentityProvider.d.ts
+
+export module '@theia/plugin' {
+
+    // https://github.com/microsoft/vscode/issues/157734
+
+    export namespace workspace {
+        /**
+         * An event that is emitted when an edit session identity is about to be requested.
+         */
+        export const onWillCreateEditSessionIdentity: Event<EditSessionIdentityWillCreateEvent>;
+
+        /**
+         *
+         * @param scheme The URI scheme that this provider can provide edit session identities for.
+         * @param provider A provider which can convert URIs for workspace folders of scheme @param scheme to
+         * an edit session identifier which is stable across machines. This enables edit sessions to be resolved.
+         */
+        export function registerEditSessionIdentityProvider(scheme: string, provider: EditSessionIdentityProvider): Disposable;
+    }
+
+    export interface EditSessionIdentityProvider {
+        /**
+         *
+         * @param workspaceFolder The workspace folder to provide an edit session identity for.
+         * @param token A cancellation token for the request.
+         * @returns A string representing the edit session identity for the requested workspace folder.
+         */
+        provideEditSessionIdentity(workspaceFolder: WorkspaceFolder, token: CancellationToken): ProviderResult<string>;
+
+        /**
+         *
+         * @param identity1 An edit session identity.
+         * @param identity2 A second edit session identity to compare to @param identity1.
+         * @param token A cancellation token for the request.
+         * @returns An {@link EditSessionIdentityMatch} representing the edit session identity match confidence for the provided identities.
+         */
+        provideEditSessionIdentityMatch(identity1: string, identity2: string, token: CancellationToken): ProviderResult<EditSessionIdentityMatch>;
+    }
+
+    export enum EditSessionIdentityMatch {
+        Complete = 100,
+        Partial = 50,
+        None = 0
+    }
+
+    export interface EditSessionIdentityWillCreateEvent {
+
+        /**
+         * A cancellation token.
+         */
+        readonly token: CancellationToken;
+
+        /**
+         * The workspace folder to create an edit session identity for.
+         */
+        readonly workspaceFolder: WorkspaceFolder;
+
+        /**
+         * Allows to pause the event until the provided thenable resolves.
+         *
+         * *Note:* This function can only be called during event dispatch.
+         *
+         * @param thenable A thenable that delays saving.
+         */
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        waitUntil(thenable: Thenable<any>): void;
+    }
+}

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

@@ -1,57 +1,57 @@
-// *****************************************************************************
-// Copyright (C) 2023 Ericsson 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.77.0/src/vscode-dts/vscode.proposed.extensionsAny.d.ts
-
-export module '@theia/plugin' {
-
-    export interface Extension<T> {
-
-        /**
-         * `true` when the extension is associated to another extension host.
-         *
-         * *Note* that an extension from another extension host cannot export
-         * API, e.g {@link Extension.exports its exports} are always `undefined`.
-         */
-        readonly isFromDifferentExtensionHost: boolean;
-    }
-
-    export namespace extensions {
-
-        /**
-         * Get an extension by its full identifier in the form of: `publisher.name`.
-         *
-         * @param extensionId An extension identifier.
-         * @param includeDifferentExtensionHosts Include extensions from different extension host
-         * @return An extension or `undefined`.
-         */
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        export function getExtension<T = any>(extensionId: string, includeDifferentExtensionHosts: boolean): Extension<T> | undefined;
-
-        /**
-         * All extensions across all extension hosts.
-         *
-         * @see {@link Extension.isFromDifferentExtensionHost}
-         */
-        export const allAcrossExtensionHosts: readonly Extension<void>[];
-
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2023 Ericsson 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.77.0/src/vscode-dts/vscode.proposed.extensionsAny.d.ts
+
+export module '@theia/plugin' {
+
+    export interface Extension<T> {
+
+        /**
+         * `true` when the extension is associated to another extension host.
+         *
+         * *Note* that an extension from another extension host cannot export
+         * API, e.g {@link Extension.exports its exports} are always `undefined`.
+         */
+        readonly isFromDifferentExtensionHost: boolean;
+    }
+
+    export namespace extensions {
+
+        /**
+         * Get an extension by its full identifier in the form of: `publisher.name`.
+         *
+         * @param extensionId An extension identifier.
+         * @param includeDifferentExtensionHosts Include extensions from different extension host
+         * @return An extension or `undefined`.
+         */
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        export function getExtension<T = any>(extensionId: string, includeDifferentExtensionHosts: boolean): Extension<T> | undefined;
+
+        /**
+         * All extensions across all extension hosts.
+         *
+         * @see {@link Extension.isFromDifferentExtensionHost}
+         */
+        export const allAcrossExtensionHosts: readonly Extension<void>[];
+
+    }
+
+}

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

@@ -1,158 +1,158 @@
-// *****************************************************************************
-// Copyright (C) 2023 Ericsson 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.77.0/src/vscode-dts/vscode.proposed.externalUriOpener.d.ts
-
-export module '@theia/plugin' {
-    /**
-     * Details if an `ExternalUriOpener` can open a uri.
-     *
-     * The priority is also used to rank multiple openers against each other and determine
-     * if an opener should be selected automatically or if the user should be prompted to
-     * select an opener.
-     *
-     * The editor will try to use the best available opener, as sorted by `ExternalUriOpenerPriority`.
-     * If there are multiple potential "best" openers for a URI, then the user will be prompted
-     * to select an opener.
-     */
-    export enum ExternalUriOpenerPriority {
-        /**
-         * The opener is disabled and will never be shown to users.
-         *
-         * Note that the opener can still be used if the user specifically
-         * configures it in their settings.
-         */
-        None = 0,
-
-        /**
-         * The opener can open the uri but will not cause a prompt on its own
-         * since the editor always contributes a built-in `Default` opener.
-         */
-        Option = 1,
-
-        /**
-         * The opener can open the uri.
-         *
-         * The editor's built-in opener has `Default` priority. This means that any additional `Default`
-         * openers will cause the user to be prompted to select from a list of all potential openers.
-         */
-        Default = 2,
-
-        /**
-         * The opener can open the uri and should be automatically selected over any
-         * default openers, include the built-in one from the editor.
-         *
-         * A preferred opener will be automatically selected if no other preferred openers
-         * are available. If multiple preferred openers are available, then the user
-         * is shown a prompt with all potential openers (not just preferred openers).
-         */
-        Preferred = 3,
-    }
-
-    /**
-     * Handles opening uris to external resources, such as http(s) links.
-     *
-     * Extensions can implement an `ExternalUriOpener` to open `http` links to a webserver
-     * inside of the editor instead of having the link be opened by the web browser.
-     *
-     * Currently openers may only be registered for `http` and `https` uris.
-     */
-    export interface ExternalUriOpener {
-
-        /**
-         * Check if the opener can open a uri.
-         *
-         * @param uri The uri being opened. This is the uri that the user clicked on. It has
-         * not yet gone through port forwarding.
-         * @param token Cancellation token indicating that the result is no longer needed.
-         *
-         * @return Priority indicating if the opener can open the external uri.
-         */
-        canOpenExternalUri(uri: Uri, token: CancellationToken): ExternalUriOpenerPriority | Thenable<ExternalUriOpenerPriority>;
-
-        /**
-         * Open a uri.
-         *
-         * This is invoked when:
-         *
-         * - The user clicks a link which does not have an assigned opener. In this case, first `canOpenExternalUri`
-         *   is called and if the user selects this opener, then `openExternalUri` is called.
-         * - The user sets the default opener for a link in their settings and then visits a link.
-         *
-         * @param resolvedUri The uri to open. This uri may have been transformed by port forwarding, so it
-         * may not match the original uri passed to `canOpenExternalUri`. Use `ctx.originalUri` to check the
-         * original uri.
-         * @param ctx Additional information about the uri being opened.
-         * @param token Cancellation token indicating that opening has been canceled.
-         *
-         * @return Thenable indicating that the opening has completed.
-         */
-        openExternalUri(resolvedUri: Uri, ctx: OpenExternalUriContext, token: CancellationToken): Thenable<void> | void;
-    }
-
-    /**
-     * Additional information about the uri being opened.
-     */
-    export interface OpenExternalUriContext {
-        /**
-         * The uri that triggered the open.
-         *
-         * This is the original uri that the user clicked on or that was passed to `openExternal.`
-         * Due to port forwarding, this may not match the `resolvedUri` passed to `openExternalUri`.
-         */
-        readonly sourceUri: Uri;
-    }
-
-    /**
-     * Additional metadata about a registered `ExternalUriOpener`.
-     */
-    interface ExternalUriOpenerMetadata {
-
-        /**
-         * List of uri schemes the opener is triggered for.
-         *
-         * Currently only `http` and `https` are supported.
-         */
-        readonly schemes: readonly string[];
-
-        /**
-         * Text displayed to the user that explains what the opener does.
-         *
-         * For example, 'Open in browser preview'
-         */
-        readonly label: string;
-    }
-
-    export namespace window {
-        /**
-         * Register a new `ExternalUriOpener`.
-         *
-         * When a uri is about to be opened, an `onOpenExternalUri:SCHEME` activation event is fired.
-         *
-         * @param id Unique id of the opener, such as `myExtension.browserPreview`. This is used in settings
-         *   and commands to identify the opener.
-         * @param opener Opener to register.
-         * @param metadata Additional information about the opener.
-         *
-         * @returns Disposable that unregisters the opener.
-         */
-        export function registerExternalUriOpener(id: string, opener: ExternalUriOpener, metadata: ExternalUriOpenerMetadata): Disposable;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 Ericsson 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.77.0/src/vscode-dts/vscode.proposed.externalUriOpener.d.ts
+
+export module '@theia/plugin' {
+    /**
+     * Details if an `ExternalUriOpener` can open a uri.
+     *
+     * The priority is also used to rank multiple openers against each other and determine
+     * if an opener should be selected automatically or if the user should be prompted to
+     * select an opener.
+     *
+     * The editor will try to use the best available opener, as sorted by `ExternalUriOpenerPriority`.
+     * If there are multiple potential "best" openers for a URI, then the user will be prompted
+     * to select an opener.
+     */
+    export enum ExternalUriOpenerPriority {
+        /**
+         * The opener is disabled and will never be shown to users.
+         *
+         * Note that the opener can still be used if the user specifically
+         * configures it in their settings.
+         */
+        None = 0,
+
+        /**
+         * The opener can open the uri but will not cause a prompt on its own
+         * since the editor always contributes a built-in `Default` opener.
+         */
+        Option = 1,
+
+        /**
+         * The opener can open the uri.
+         *
+         * The editor's built-in opener has `Default` priority. This means that any additional `Default`
+         * openers will cause the user to be prompted to select from a list of all potential openers.
+         */
+        Default = 2,
+
+        /**
+         * The opener can open the uri and should be automatically selected over any
+         * default openers, include the built-in one from the editor.
+         *
+         * A preferred opener will be automatically selected if no other preferred openers
+         * are available. If multiple preferred openers are available, then the user
+         * is shown a prompt with all potential openers (not just preferred openers).
+         */
+        Preferred = 3,
+    }
+
+    /**
+     * Handles opening uris to external resources, such as http(s) links.
+     *
+     * Extensions can implement an `ExternalUriOpener` to open `http` links to a webserver
+     * inside of the editor instead of having the link be opened by the web browser.
+     *
+     * Currently openers may only be registered for `http` and `https` uris.
+     */
+    export interface ExternalUriOpener {
+
+        /**
+         * Check if the opener can open a uri.
+         *
+         * @param uri The uri being opened. This is the uri that the user clicked on. It has
+         * not yet gone through port forwarding.
+         * @param token Cancellation token indicating that the result is no longer needed.
+         *
+         * @return Priority indicating if the opener can open the external uri.
+         */
+        canOpenExternalUri(uri: Uri, token: CancellationToken): ExternalUriOpenerPriority | Thenable<ExternalUriOpenerPriority>;
+
+        /**
+         * Open a uri.
+         *
+         * This is invoked when:
+         *
+         * - The user clicks a link which does not have an assigned opener. In this case, first `canOpenExternalUri`
+         *   is called and if the user selects this opener, then `openExternalUri` is called.
+         * - The user sets the default opener for a link in their settings and then visits a link.
+         *
+         * @param resolvedUri The uri to open. This uri may have been transformed by port forwarding, so it
+         * may not match the original uri passed to `canOpenExternalUri`. Use `ctx.originalUri` to check the
+         * original uri.
+         * @param ctx Additional information about the uri being opened.
+         * @param token Cancellation token indicating that opening has been canceled.
+         *
+         * @return Thenable indicating that the opening has completed.
+         */
+        openExternalUri(resolvedUri: Uri, ctx: OpenExternalUriContext, token: CancellationToken): Thenable<void> | void;
+    }
+
+    /**
+     * Additional information about the uri being opened.
+     */
+    export interface OpenExternalUriContext {
+        /**
+         * The uri that triggered the open.
+         *
+         * This is the original uri that the user clicked on or that was passed to `openExternal.`
+         * Due to port forwarding, this may not match the `resolvedUri` passed to `openExternalUri`.
+         */
+        readonly sourceUri: Uri;
+    }
+
+    /**
+     * Additional metadata about a registered `ExternalUriOpener`.
+     */
+    interface ExternalUriOpenerMetadata {
+
+        /**
+         * List of uri schemes the opener is triggered for.
+         *
+         * Currently only `http` and `https` are supported.
+         */
+        readonly schemes: readonly string[];
+
+        /**
+         * Text displayed to the user that explains what the opener does.
+         *
+         * For example, 'Open in browser preview'
+         */
+        readonly label: string;
+    }
+
+    export namespace window {
+        /**
+         * Register a new `ExternalUriOpener`.
+         *
+         * When a uri is about to be opened, an `onOpenExternalUri:SCHEME` activation event is fired.
+         *
+         * @param id Unique id of the opener, such as `myExtension.browserPreview`. This is used in settings
+         *   and commands to identify the opener.
+         * @param opener Opener to register.
+         * @param metadata Additional information about the opener.
+         *
+         * @returns Disposable that unregisters the opener.
+         */
+        export function registerExternalUriOpener(id: string, opener: ExternalUriOpener, metadata: ExternalUriOpenerMetadata): Disposable;
+    }
+}