@theia/core 1.53.0-next.4 → 1.53.0-next.55

package/src/electron-browser/window/external-app-open-handler.ts

@@ -1,42 +1,42 @@
-// *****************************************************************************
-// Copyright (C) 2024 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
-// *****************************************************************************
-
-import { injectable } from 'inversify';
-import { OpenHandler } from '../../browser/opener-service';
-import URI from '../../common/uri';
-import { HttpOpenHandler } from '../../browser/http-open-handler';
-
-export interface ExternalAppOpenHandlerOptions {
-    openExternalApp?: boolean
-}
-
-@injectable()
-export class ExternalAppOpenHandler implements OpenHandler {
-
-    static readonly PRIORITY: number = HttpOpenHandler.PRIORITY + 100;
-    readonly id = 'external-app';
-
-    canHandle(uri: URI, options?: ExternalAppOpenHandlerOptions): number {
-        return (options && options.openExternalApp) ? ExternalAppOpenHandler.PRIORITY : -1;
-    }
-
-    async open(uri: URI): Promise<undefined> {
-        // For files 'file:' scheme, system accepts only the path.
-        // For other protocols e.g. 'vscode:' we use the full URI to propagate target app information.
-        window.electronTheiaCore.openWithSystemApp(uri.scheme === 'file' ? uri.path.fsPath() : uri.toString(true));
-        return undefined;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2024 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
+// *****************************************************************************
+
+import { injectable } from 'inversify';
+import { OpenHandler } from '../../browser/opener-service';
+import URI from '../../common/uri';
+import { HttpOpenHandler } from '../../browser/http-open-handler';
+
+export interface ExternalAppOpenHandlerOptions {
+    openExternalApp?: boolean
+}
+
+@injectable()
+export class ExternalAppOpenHandler implements OpenHandler {
+
+    static readonly PRIORITY: number = HttpOpenHandler.PRIORITY + 100;
+    readonly id = 'external-app';
+
+    canHandle(uri: URI, options?: ExternalAppOpenHandlerOptions): number {
+        return (options && options.openExternalApp) ? ExternalAppOpenHandler.PRIORITY : -1;
+    }
+
+    async open(uri: URI): Promise<undefined> {
+        // For files 'file:' scheme, system accepts only the path.
+        // For other protocols e.g. 'vscode:' we use the full URI to propagate target app information.
+        window.electronTheiaCore.openWithSystemApp(uri.toString(true));
+        return undefined;
+    }
+}

package/src/electron-common/electron-api.ts

@@ -1,154 +1,157 @@
-// *****************************************************************************
-// 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
-// *****************************************************************************
-
-import { NativeKeyboardLayout } from '../common/keyboard/keyboard-layout-provider';
-import { Disposable } from '../common';
-import { FrontendApplicationState, StopReason } from '../common/frontend-application-state';
-
-export type MenuRole = ('undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'about' | 'services' | 'hide' | 'hideOthers' | 'unhide' | 'quit');
-
-export interface MenuDto {
-    id?: string,
-    label?: string,
-    submenu?: MenuDto[],
-    type?: ('normal' | 'separator' | 'submenu' | 'checkbox' | 'radio');
-    checked?: boolean,
-    enabled?: boolean,
-    visible?: boolean;
-    role?: MenuRole;
-    accelerator?: string,
-    execute?: () => void
-}
-
-export type InternalMenuDto = Omit<MenuDto, 'execute' | 'submenu'> & {
-    submenu?: InternalMenuDto[],
-    handlerId?: number
-};
-
-export type WindowEvent = 'maximize' | 'unmaximize' | 'focus';
-
-export interface TheiaCoreAPI {
-    WindowMetadata: {
-        webcontentId: string;
-    }
-    getSecurityToken: () => string;
-    attachSecurityToken: (endpoint: string) => Promise<void>;
-
-    setMenuBarVisible(visible: boolean, windowName?: string): void;
-    setMenu(menu: MenuDto[] | undefined): void;
-
-    popup(menu: MenuDto[], x: number, y: number, onClosed: () => void, windowName?: string): Promise<number>;
-    closePopup(handle: number): void;
-
-    focusWindow(name?: string): void;
-
-    showItemInFolder(fsPath: string): void;
-
-    /**
-     * @param location The location to open with the system app. This can be a file path or a URL.
-     */
-    openWithSystemApp(location: string): void;
-
-    getTitleBarStyleAtStartup(): Promise<string>;
-    setTitleBarStyle(style: string): void;
-    setBackgroundColor(backgroundColor: string): void;
-    minimize(): void;
-    isMaximized(): boolean; // TODO: this should really be async, since it blocks the renderer process
-    maximize(): void;
-    unMaximize(): void;
-    close(): void;
-    onWindowEvent(event: WindowEvent, handler: () => void): Disposable;
-    onAboutToClose(handler: () => void): Disposable;
-    setCloseRequestHandler(handler: (reason: StopReason) => Promise<boolean>): void;
-
-    setSecondaryWindowCloseRequestHandler(windowName: string, handler: () => Promise<boolean>): void;
-
-    toggleDevTools(): void;
-    getZoomLevel(): Promise<number>;
-    setZoomLevel(desired: number): void;
-
-    isFullScreenable(): boolean; // TODO: this should really be async, since it blocks the renderer process
-    isFullScreen(): boolean; // TODO: this should really be async, since it blocks the renderer process
-    toggleFullScreen(): void;
-
-    requestReload(newUrl?: string): void;
-    restart(): void;
-
-    applicationStateChanged(state: FrontendApplicationState): void;
-
-    readClipboard(): string;
-    writeClipboard(text: string): void;
-
-    onKeyboardLayoutChanged(handler: (newLayout: NativeKeyboardLayout) => void): Disposable;
-
-    sendData(data: Uint8Array): void;
-    onData(handler: (data: Uint8Array) => void): Disposable;
-    useNativeElements: boolean;
-}
-
-declare global {
-    interface Window {
-        electronTheiaCore: TheiaCoreAPI
-    }
-}
-
-export const CHANNEL_WC_METADATA = 'WebContentMetadata';
-export const CHANNEL_SET_MENU = 'SetMenu';
-export const CHANNEL_SET_MENU_BAR_VISIBLE = 'SetMenuBarVisible';
-export const CHANNEL_INVOKE_MENU = 'InvokeMenu';
-export const CHANNEL_OPEN_POPUP = 'OpenPopup';
-export const CHANNEL_ON_CLOSE_POPUP = 'OnClosePopup';
-export const CHANNEL_CLOSE_POPUP = 'ClosePopup';
-export const CHANNEL_GET_SECURITY_TOKEN = 'GetSecurityToken';
-export const CHANNEL_FOCUS_WINDOW = 'FocusWindow';
-export const CHANNEL_SHOW_OPEN = 'ShowOpenDialog';
-export const CHANNEL_SHOW_SAVE = 'ShowSaveDialog';
-export const CHANNEL_SHOW_ITEM_IN_FOLDER = 'ShowItemInFolder';
-export const CHANNEL_OPEN_WITH_SYSTEM_APP = 'OpenWithSystemApp';
-export const CHANNEL_ATTACH_SECURITY_TOKEN = 'AttachSecurityToken';
-
-export const CHANNEL_GET_TITLE_STYLE_AT_STARTUP = 'GetTitleStyleAtStartup';
-export const CHANNEL_SET_TITLE_STYLE = 'SetTitleStyle';
-export const CHANNEL_SET_BACKGROUND_COLOR = 'SetBackgroundColor';
-export const CHANNEL_CLOSE = 'Close';
-export const CHANNEL_MINIMIZE = 'Minimize';
-export const CHANNEL_MAXIMIZE = 'Maximize';
-export const CHANNEL_IS_MAXIMIZED = 'IsMaximized';
-
-export const CHANNEL_ABOUT_TO_CLOSE = 'AboutToClose';
-
-export const CHANNEL_UNMAXIMIZE = 'UnMaximize';
-export const CHANNEL_ON_WINDOW_EVENT = 'OnWindowEvent';
-export const CHANNEL_TOGGLE_DEVTOOLS = 'ToggleDevtools';
-export const CHANNEL_GET_ZOOM_LEVEL = 'GetZoomLevel';
-export const CHANNEL_SET_ZOOM_LEVEL = 'SetZoomLevel';
-export const CHANNEL_IS_FULL_SCREENABLE = 'IsFullScreenable';
-export const CHANNEL_IS_FULL_SCREEN = 'IsFullScreen';
-export const CHANNEL_TOGGLE_FULL_SCREEN = 'ToggleFullScreen';
-
-export const CHANNEL_REQUEST_SECONDARY_CLOSE = 'RequestSecondaryClose';
-
-export const CHANNEL_REQUEST_CLOSE = 'RequestClose';
-export const CHANNEL_REQUEST_RELOAD = 'RequestReload';
-export const CHANNEL_RESTART = 'Restart';
-
-export const CHANNEL_APP_STATE_CHANGED = 'ApplicationStateChanged';
-
-export const CHANNEL_READ_CLIPBOARD = 'ReadClipboard';
-export const CHANNEL_WRITE_CLIPBOARD = 'WriteClipboard';
-
-export const CHANNEL_KEYBOARD_LAYOUT_CHANGED = 'KeyboardLayoutChanged';
-export const CHANNEL_IPC_CONNECTION = 'IpcConnection';
+// *****************************************************************************
+// 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
+// *****************************************************************************
+
+import { NativeKeyboardLayout } from '../common/keyboard/keyboard-layout-provider';
+import { Disposable } from '../common';
+import { FrontendApplicationState, StopReason } from '../common/frontend-application-state';
+
+export type MenuRole = ('undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'about' | 'services' | 'hide' | 'hideOthers' | 'unhide' | 'quit');
+
+export interface MenuDto {
+    id?: string,
+    label?: string,
+    submenu?: MenuDto[],
+    type?: ('normal' | 'separator' | 'submenu' | 'checkbox' | 'radio');
+    checked?: boolean,
+    enabled?: boolean,
+    visible?: boolean;
+    role?: MenuRole;
+    accelerator?: string,
+    execute?: () => void
+}
+
+export type InternalMenuDto = Omit<MenuDto, 'execute' | 'submenu'> & {
+    submenu?: InternalMenuDto[],
+    handlerId?: number
+};
+
+export type WindowEvent = 'maximize' | 'unmaximize' | 'focus';
+
+export interface TheiaCoreAPI {
+    WindowMetadata: {
+        webcontentId: string;
+    }
+    getSecurityToken: () => string;
+    attachSecurityToken: (endpoint: string) => Promise<void>;
+
+    setMenuBarVisible(visible: boolean, windowName?: string): void;
+    setMenu(menu: MenuDto[] | undefined): void;
+
+    popup(menu: MenuDto[], x: number, y: number, onClosed: () => void, windowName?: string): Promise<number>;
+    closePopup(handle: number): void;
+
+    focusWindow(name?: string): void;
+
+    showItemInFolder(fsPath: string): void;
+
+    /**
+     * @param location The location to open with the system app. This can be a file path or a URL.
+     */
+    openWithSystemApp(location: string): void;
+
+    getTitleBarStyleAtStartup(): Promise<string>;
+    setTitleBarStyle(style: string): void;
+    setBackgroundColor(backgroundColor: string): void;
+    minimize(): void;
+    isMaximized(): boolean; // TODO: this should really be async, since it blocks the renderer process
+    maximize(): void;
+    unMaximize(): void;
+    close(): void;
+    onWindowEvent(event: WindowEvent, handler: () => void): Disposable;
+    onAboutToClose(handler: () => void): Disposable;
+    setCloseRequestHandler(handler: (reason: StopReason) => Promise<boolean>): void;
+
+    setOpenUrlHandler(handler: (url: string) => Promise<boolean>): void;
+
+    setSecondaryWindowCloseRequestHandler(windowName: string, handler: () => Promise<boolean>): void;
+
+    toggleDevTools(): void;
+    getZoomLevel(): Promise<number>;
+    setZoomLevel(desired: number): void;
+
+    isFullScreenable(): boolean; // TODO: this should really be async, since it blocks the renderer process
+    isFullScreen(): boolean; // TODO: this should really be async, since it blocks the renderer process
+    toggleFullScreen(): void;
+
+    requestReload(newUrl?: string): void;
+    restart(): void;
+
+    applicationStateChanged(state: FrontendApplicationState): void;
+
+    readClipboard(): string;
+    writeClipboard(text: string): void;
+
+    onKeyboardLayoutChanged(handler: (newLayout: NativeKeyboardLayout) => void): Disposable;
+
+    sendData(data: Uint8Array): void;
+    onData(handler: (data: Uint8Array) => void): Disposable;
+    useNativeElements: boolean;
+}
+
+declare global {
+    interface Window {
+        electronTheiaCore: TheiaCoreAPI
+    }
+}
+
+export const CHANNEL_WC_METADATA = 'WebContentMetadata';
+export const CHANNEL_SET_MENU = 'SetMenu';
+export const CHANNEL_SET_MENU_BAR_VISIBLE = 'SetMenuBarVisible';
+export const CHANNEL_INVOKE_MENU = 'InvokeMenu';
+export const CHANNEL_OPEN_POPUP = 'OpenPopup';
+export const CHANNEL_ON_CLOSE_POPUP = 'OnClosePopup';
+export const CHANNEL_CLOSE_POPUP = 'ClosePopup';
+export const CHANNEL_GET_SECURITY_TOKEN = 'GetSecurityToken';
+export const CHANNEL_FOCUS_WINDOW = 'FocusWindow';
+export const CHANNEL_SHOW_OPEN = 'ShowOpenDialog';
+export const CHANNEL_SHOW_SAVE = 'ShowSaveDialog';
+export const CHANNEL_SHOW_ITEM_IN_FOLDER = 'ShowItemInFolder';
+export const CHANNEL_OPEN_WITH_SYSTEM_APP = 'OpenWithSystemApp';
+export const CHANNEL_ATTACH_SECURITY_TOKEN = 'AttachSecurityToken';
+
+export const CHANNEL_GET_TITLE_STYLE_AT_STARTUP = 'GetTitleStyleAtStartup';
+export const CHANNEL_SET_TITLE_STYLE = 'SetTitleStyle';
+export const CHANNEL_SET_BACKGROUND_COLOR = 'SetBackgroundColor';
+export const CHANNEL_CLOSE = 'Close';
+export const CHANNEL_MINIMIZE = 'Minimize';
+export const CHANNEL_MAXIMIZE = 'Maximize';
+export const CHANNEL_IS_MAXIMIZED = 'IsMaximized';
+
+export const CHANNEL_ABOUT_TO_CLOSE = 'AboutToClose';
+export const CHANNEL_OPEN_URL = 'OpenUrl';
+
+export const CHANNEL_UNMAXIMIZE = 'UnMaximize';
+export const CHANNEL_ON_WINDOW_EVENT = 'OnWindowEvent';
+export const CHANNEL_TOGGLE_DEVTOOLS = 'ToggleDevtools';
+export const CHANNEL_GET_ZOOM_LEVEL = 'GetZoomLevel';
+export const CHANNEL_SET_ZOOM_LEVEL = 'SetZoomLevel';
+export const CHANNEL_IS_FULL_SCREENABLE = 'IsFullScreenable';
+export const CHANNEL_IS_FULL_SCREEN = 'IsFullScreen';
+export const CHANNEL_TOGGLE_FULL_SCREEN = 'ToggleFullScreen';
+
+export const CHANNEL_REQUEST_SECONDARY_CLOSE = 'RequestSecondaryClose';
+
+export const CHANNEL_REQUEST_CLOSE = 'RequestClose';
+export const CHANNEL_REQUEST_RELOAD = 'RequestReload';
+export const CHANNEL_RESTART = 'Restart';
+
+export const CHANNEL_APP_STATE_CHANGED = 'ApplicationStateChanged';
+
+export const CHANNEL_READ_CLIPBOARD = 'ReadClipboard';
+export const CHANNEL_WRITE_CLIPBOARD = 'WriteClipboard';
+
+export const CHANNEL_KEYBOARD_LAYOUT_CHANGED = 'KeyboardLayoutChanged';
+export const CHANNEL_IPC_CONNECTION = 'IpcConnection';

package/src/electron-common/electron-main-window-service.ts

@@ -1,24 +1,24 @@
-// *****************************************************************************
-// Copyright (C) 2020 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
-// *****************************************************************************
-
-import { NewWindowOptions, WindowSearchParams } from '../common/window';
-
-export const electronMainWindowServicePath = '/services/electron-window';
-export const ElectronMainWindowService = Symbol('ElectronMainWindowService');
-export interface ElectronMainWindowService {
-    openNewWindow(url: string, options?: NewWindowOptions): undefined;
-    openNewDefaultWindow(params?: WindowSearchParams): void;
-}
+// *****************************************************************************
+// Copyright (C) 2020 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
+// *****************************************************************************
+
+import { NewWindowOptions, WindowSearchParams } from '../common/window';
+
+export const electronMainWindowServicePath = '/services/electron-window';
+export const ElectronMainWindowService = Symbol('ElectronMainWindowService');
+export interface ElectronMainWindowService {
+    openNewWindow(url: string, options?: NewWindowOptions): undefined;
+    openNewDefaultWindow(params?: WindowSearchParams): void;
+}

package/src/electron-common/electron-token.ts

@@ -1,27 +1,27 @@
-// *****************************************************************************
-// Copyright (C) 2020 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
-// *****************************************************************************
-
-/**
- * This token is unique to the current running instance. It is used by the backend
- * to make sure it is an electron browser window that is connecting to its services.
- *
- * The identifier is a string, which makes it usable as a key for cookies, environments, etc.
- */
-// Note that it needs to be uppercase for it to work properly in Windows environments.
-export const ElectronSecurityToken: string = 'THEIA_ELECTRON_TOKEN';
-export interface ElectronSecurityToken {
-    value: string;
-};
+// *****************************************************************************
+// Copyright (C) 2020 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
+// *****************************************************************************
+
+/**
+ * This token is unique to the current running instance. It is used by the backend
+ * to make sure it is an electron browser window that is connecting to its services.
+ *
+ * The identifier is a string, which makes it usable as a key for cookies, environments, etc.
+ */
+// Note that it needs to be uppercase for it to work properly in Windows environments.
+export const ElectronSecurityToken: string = 'THEIA_ELECTRON_TOKEN';
+export interface ElectronSecurityToken {
+    value: string;
+};