@theia/core 1.34.2 → 1.34.3

package/lib/browser/frontend-application-state.d.ts

@@ -1,20 +1,20 @@
-import { Emitter, Event } from '../common/event';
-import { Deferred } from '../common/promise-util';
-import { ILogger } from '../common/logger';
-import { FrontendApplicationState } from '../common/frontend-application-state';
-export { FrontendApplicationState };
-export declare class FrontendApplicationStateService {
-    protected readonly logger: ILogger;
-    private _state;
-    protected deferred: {
-        [state: string]: Deferred<void>;
-    };
-    protected readonly stateChanged: Emitter<FrontendApplicationState>;
-    get state(): FrontendApplicationState;
-    set state(state: FrontendApplicationState);
-    get onStateChanged(): Event<FrontendApplicationState>;
-    protected doSetState(state: FrontendApplicationState): void;
-    reachedState(state: FrontendApplicationState): Promise<void>;
-    reachedAnyState(...states: FrontendApplicationState[]): Promise<void>;
-}
+import { Emitter, Event } from '../common/event';
+import { Deferred } from '../common/promise-util';
+import { ILogger } from '../common/logger';
+import { FrontendApplicationState } from '../common/frontend-application-state';
+export { FrontendApplicationState };
+export declare class FrontendApplicationStateService {
+    protected readonly logger: ILogger;
+    private _state;
+    protected deferred: {
+        [state: string]: Deferred<void>;
+    };
+    protected readonly stateChanged: Emitter<FrontendApplicationState>;
+    get state(): FrontendApplicationState;
+    set state(state: FrontendApplicationState);
+    get onStateChanged(): Event<FrontendApplicationState>;
+    protected doSetState(state: FrontendApplicationState): void;
+    reachedState(state: FrontendApplicationState): Promise<void>;
+    reachedAnyState(...states: FrontendApplicationState[]): Promise<void>;
+}
 //# sourceMappingURL=frontend-application-state.d.ts.map

package/lib/browser/frontend-application-state.js

@@ -1,80 +1,80 @@
-"use strict";
-// *****************************************************************************
-// Copyright (C) 2018 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
-// *****************************************************************************
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FrontendApplicationStateService = void 0;
-const inversify_1 = require("inversify");
-const event_1 = require("../common/event");
-const promise_util_1 = require("../common/promise-util");
-const logger_1 = require("../common/logger");
-let FrontendApplicationStateService = class FrontendApplicationStateService {
-    constructor() {
-        this._state = 'init';
-        this.deferred = {};
-        this.stateChanged = new event_1.Emitter();
-    }
-    get state() {
-        return this._state;
-    }
-    set state(state) {
-        if (state !== this._state) {
-            this.doSetState(state);
-        }
-    }
-    get onStateChanged() {
-        return this.stateChanged.event;
-    }
-    doSetState(state) {
-        if (this.deferred[this._state] === undefined) {
-            this.deferred[this._state] = new promise_util_1.Deferred();
-        }
-        const oldState = this._state;
-        this._state = state;
-        if (this.deferred[state] === undefined) {
-            this.deferred[state] = new promise_util_1.Deferred();
-        }
-        this.deferred[state].resolve();
-        this.logger.info(`Changed application state from '${oldState}' to '${this._state}'.`);
-        this.stateChanged.fire(state);
-    }
-    reachedState(state) {
-        if (this.deferred[state] === undefined) {
-            this.deferred[state] = new promise_util_1.Deferred();
-        }
-        return this.deferred[state].promise;
-    }
-    reachedAnyState(...states) {
-        return Promise.race(states.map(s => this.reachedState(s)));
-    }
-};
-__decorate([
-    (0, inversify_1.inject)(logger_1.ILogger),
-    __metadata("design:type", Object)
-], FrontendApplicationStateService.prototype, "logger", void 0);
-FrontendApplicationStateService = __decorate([
-    (0, inversify_1.injectable)()
-], FrontendApplicationStateService);
-exports.FrontendApplicationStateService = FrontendApplicationStateService;
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2018 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
+// *****************************************************************************
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FrontendApplicationStateService = void 0;
+const inversify_1 = require("inversify");
+const event_1 = require("../common/event");
+const promise_util_1 = require("../common/promise-util");
+const logger_1 = require("../common/logger");
+let FrontendApplicationStateService = class FrontendApplicationStateService {
+    constructor() {
+        this._state = 'init';
+        this.deferred = {};
+        this.stateChanged = new event_1.Emitter();
+    }
+    get state() {
+        return this._state;
+    }
+    set state(state) {
+        if (state !== this._state) {
+            this.doSetState(state);
+        }
+    }
+    get onStateChanged() {
+        return this.stateChanged.event;
+    }
+    doSetState(state) {
+        if (this.deferred[this._state] === undefined) {
+            this.deferred[this._state] = new promise_util_1.Deferred();
+        }
+        const oldState = this._state;
+        this._state = state;
+        if (this.deferred[state] === undefined) {
+            this.deferred[state] = new promise_util_1.Deferred();
+        }
+        this.deferred[state].resolve();
+        this.logger.info(`Changed application state from '${oldState}' to '${this._state}'.`);
+        this.stateChanged.fire(state);
+    }
+    reachedState(state) {
+        if (this.deferred[state] === undefined) {
+            this.deferred[state] = new promise_util_1.Deferred();
+        }
+        return this.deferred[state].promise;
+    }
+    reachedAnyState(...states) {
+        return Promise.race(states.map(s => this.reachedState(s)));
+    }
+};
+__decorate([
+    (0, inversify_1.inject)(logger_1.ILogger),
+    __metadata("design:type", Object)
+], FrontendApplicationStateService.prototype, "logger", void 0);
+FrontendApplicationStateService = __decorate([
+    (0, inversify_1.injectable)()
+], FrontendApplicationStateService);
+exports.FrontendApplicationStateService = FrontendApplicationStateService;
 //# sourceMappingURL=frontend-application-state.js.map

package/lib/browser/frontend-application.d.ts

@@ -1,159 +1,159 @@
-import { ContributionProvider, CommandRegistry, MenuModelRegistry, BackendStopwatch, Stopwatch } from '../common';
-import { MaybePromise } from '../common/types';
-import { KeybindingRegistry } from './keybinding';
-import { ApplicationShell } from './shell/application-shell';
-import { ShellLayoutRestorer } from './shell/shell-layout-restorer';
-import { FrontendApplicationStateService } from './frontend-application-state';
-import { CorePreferences } from './core-preferences';
-import { WindowService } from './window/window-service';
-import { TooltipService } from './tooltip-service';
-import { StopReason } from '../common/frontend-application-state';
-/**
- * Clients can implement to get a callback for contributing widgets to a shell on start.
- */
-export declare const FrontendApplicationContribution: unique symbol;
-export interface FrontendApplicationContribution {
-    /**
-     * Called on application startup before configure is called.
-     */
-    initialize?(): void;
-    /**
-     * Called before commands, key bindings and menus are initialized.
-     * Should return a promise if it runs asynchronously.
-     */
-    configure?(app: FrontendApplication): MaybePromise<void>;
-    /**
-     * Called when the application is started. The application shell is not attached yet when this method runs.
-     * Should return a promise if it runs asynchronously.
-     */
-    onStart?(app: FrontendApplication): MaybePromise<void>;
-    /**
-     * Called on `beforeunload` event, right before the window closes.
-     * Return `true` or an OnWillStopAction in order to prevent exit.
-     * Note: No async code allowed, this function has to run on one tick.
-     */
-    onWillStop?(app: FrontendApplication): boolean | undefined | OnWillStopAction<unknown>;
-    /**
-     * Called when an application is stopped or unloaded.
-     *
-     * Note that this is implemented using `window.beforeunload` which doesn't allow any asynchronous code anymore.
-     * I.e. this is the last tick.
-     */
-    onStop?(app: FrontendApplication): void;
-    /**
-     * Called after the application shell has been attached in case there is no previous workbench layout state.
-     * Should return a promise if it runs asynchronously.
-     */
-    initializeLayout?(app: FrontendApplication): MaybePromise<void>;
-    /**
-     * An event is emitted when a layout is initialized, but before the shell is attached.
-     */
-    onDidInitializeLayout?(app: FrontendApplication): MaybePromise<void>;
-}
-export interface OnWillStopAction<T = unknown> {
-    /**
-     * @resolves to a prepared value to be passed into the `action` function.
-     */
-    prepare?: (stopReason?: StopReason) => MaybePromise<T>;
-    /**
-     * @resolves to `true` if it is safe to close the application; `false` otherwise.
-     */
-    action: (prepared: T, stopReason?: StopReason) => MaybePromise<boolean>;
-    /**
-     * A descriptive string for the reason preventing close.
-     */
-    reason: string;
-    /**
-     * A number representing priority. Higher priority items are run later.
-     * High priority implies that some options of this check will have negative impacts if
-     * the user subsequently cancels the shutdown.
-     */
-    priority?: number;
-}
-export declare namespace OnWillStopAction {
-    function is(candidate: unknown): candidate is OnWillStopAction;
-}
-/**
- * Default frontend contribution that can be extended by clients if they do not want to implement any of the
- * methods from the interface but still want to contribute to the frontend application.
- */
-export declare abstract class DefaultFrontendApplicationContribution implements FrontendApplicationContribution {
-    initialize(): void;
-}
-export declare class FrontendApplication {
-    protected readonly commands: CommandRegistry;
-    protected readonly menus: MenuModelRegistry;
-    protected readonly keybindings: KeybindingRegistry;
-    protected readonly layoutRestorer: ShellLayoutRestorer;
-    protected readonly contributions: ContributionProvider<FrontendApplicationContribution>;
-    protected readonly _shell: ApplicationShell;
-    protected readonly stateService: FrontendApplicationStateService;
-    protected readonly corePreferences: CorePreferences;
-    protected readonly windowsService: WindowService;
-    protected readonly tooltipService: TooltipService;
-    protected readonly stopwatch: Stopwatch;
-    protected readonly backendStopwatch: BackendStopwatch;
-    constructor(commands: CommandRegistry, menus: MenuModelRegistry, keybindings: KeybindingRegistry, layoutRestorer: ShellLayoutRestorer, contributions: ContributionProvider<FrontendApplicationContribution>, _shell: ApplicationShell, stateService: FrontendApplicationStateService);
-    get shell(): ApplicationShell;
-    /**
-     * Start the frontend application.
-     *
-     * Start up consists of the following steps:
-     * - start frontend contributions
-     * - attach the application shell to the host element
-     * - initialize the application shell layout
-     * - reveal the application shell if it was hidden by a startup indicator
-     */
-    start(): Promise<void>;
-    /**
-     * Return a promise to the host element to which the application shell is attached.
-     */
-    protected getHost(): Promise<HTMLElement>;
-    /**
-     * Return an HTML element that indicates the startup phase, e.g. with an animation or a splash screen.
-     */
-    protected getStartupIndicator(host: HTMLElement): HTMLElement | undefined;
-    /**
-     * Register global event listeners.
-     */
-    protected registerEventListeners(): void;
-    /**
-     * Attach the application shell to the host element. If a startup indicator is present, the shell is
-     * inserted before that indicator so it is not visible yet.
-     */
-    protected attachShell(host: HTMLElement): void;
-    /**
-     * Attach the tooltip container to the host element.
-     */
-    protected attachTooltip(host: HTMLElement): void;
-    /**
-     * If a startup indicator is present, it is first hidden with the `theia-hidden` CSS class and then
-     * removed after a while. The delay until removal is taken from the CSS transition duration.
-     */
-    protected revealShell(host: HTMLElement): Promise<void>;
-    /**
-     * Initialize the shell layout either using the layout restorer service or, if no layout has
-     * been stored, by creating the default layout.
-     */
-    protected initializeLayout(): Promise<void>;
-    /**
-     * Try to restore the shell layout from the storage service. Resolves to `true` if successful.
-     */
-    protected restoreLayout(): Promise<boolean>;
-    /**
-     * Let the frontend application contributions initialize the shell layout. Override this
-     * method in order to create an application-specific custom layout.
-     */
-    protected createDefaultLayout(): Promise<void>;
-    protected fireOnDidInitializeLayout(): Promise<void>;
-    /**
-     * Initialize and start the frontend application contributions.
-     */
-    protected startContributions(): Promise<void>;
-    /**
-     * Stop the frontend application contributions. This is called when the window is unloaded.
-     */
-    protected stopContributions(): void;
-    protected measure<T>(name: string, fn: () => MaybePromise<T>, message?: string, threshold?: boolean): Promise<T>;
-}
+import { ContributionProvider, CommandRegistry, MenuModelRegistry, BackendStopwatch, Stopwatch } from '../common';
+import { MaybePromise } from '../common/types';
+import { KeybindingRegistry } from './keybinding';
+import { ApplicationShell } from './shell/application-shell';
+import { ShellLayoutRestorer } from './shell/shell-layout-restorer';
+import { FrontendApplicationStateService } from './frontend-application-state';
+import { CorePreferences } from './core-preferences';
+import { WindowService } from './window/window-service';
+import { TooltipService } from './tooltip-service';
+import { StopReason } from '../common/frontend-application-state';
+/**
+ * Clients can implement to get a callback for contributing widgets to a shell on start.
+ */
+export declare const FrontendApplicationContribution: unique symbol;
+export interface FrontendApplicationContribution {
+    /**
+     * Called on application startup before configure is called.
+     */
+    initialize?(): void;
+    /**
+     * Called before commands, key bindings and menus are initialized.
+     * Should return a promise if it runs asynchronously.
+     */
+    configure?(app: FrontendApplication): MaybePromise<void>;
+    /**
+     * Called when the application is started. The application shell is not attached yet when this method runs.
+     * Should return a promise if it runs asynchronously.
+     */
+    onStart?(app: FrontendApplication): MaybePromise<void>;
+    /**
+     * Called on `beforeunload` event, right before the window closes.
+     * Return `true` or an OnWillStopAction in order to prevent exit.
+     * Note: No async code allowed, this function has to run on one tick.
+     */
+    onWillStop?(app: FrontendApplication): boolean | undefined | OnWillStopAction<unknown>;
+    /**
+     * Called when an application is stopped or unloaded.
+     *
+     * Note that this is implemented using `window.beforeunload` which doesn't allow any asynchronous code anymore.
+     * I.e. this is the last tick.
+     */
+    onStop?(app: FrontendApplication): void;
+    /**
+     * Called after the application shell has been attached in case there is no previous workbench layout state.
+     * Should return a promise if it runs asynchronously.
+     */
+    initializeLayout?(app: FrontendApplication): MaybePromise<void>;
+    /**
+     * An event is emitted when a layout is initialized, but before the shell is attached.
+     */
+    onDidInitializeLayout?(app: FrontendApplication): MaybePromise<void>;
+}
+export interface OnWillStopAction<T = unknown> {
+    /**
+     * @resolves to a prepared value to be passed into the `action` function.
+     */
+    prepare?: (stopReason?: StopReason) => MaybePromise<T>;
+    /**
+     * @resolves to `true` if it is safe to close the application; `false` otherwise.
+     */
+    action: (prepared: T, stopReason?: StopReason) => MaybePromise<boolean>;
+    /**
+     * A descriptive string for the reason preventing close.
+     */
+    reason: string;
+    /**
+     * A number representing priority. Higher priority items are run later.
+     * High priority implies that some options of this check will have negative impacts if
+     * the user subsequently cancels the shutdown.
+     */
+    priority?: number;
+}
+export declare namespace OnWillStopAction {
+    function is(candidate: unknown): candidate is OnWillStopAction;
+}
+/**
+ * Default frontend contribution that can be extended by clients if they do not want to implement any of the
+ * methods from the interface but still want to contribute to the frontend application.
+ */
+export declare abstract class DefaultFrontendApplicationContribution implements FrontendApplicationContribution {
+    initialize(): void;
+}
+export declare class FrontendApplication {
+    protected readonly commands: CommandRegistry;
+    protected readonly menus: MenuModelRegistry;
+    protected readonly keybindings: KeybindingRegistry;
+    protected readonly layoutRestorer: ShellLayoutRestorer;
+    protected readonly contributions: ContributionProvider<FrontendApplicationContribution>;
+    protected readonly _shell: ApplicationShell;
+    protected readonly stateService: FrontendApplicationStateService;
+    protected readonly corePreferences: CorePreferences;
+    protected readonly windowsService: WindowService;
+    protected readonly tooltipService: TooltipService;
+    protected readonly stopwatch: Stopwatch;
+    protected readonly backendStopwatch: BackendStopwatch;
+    constructor(commands: CommandRegistry, menus: MenuModelRegistry, keybindings: KeybindingRegistry, layoutRestorer: ShellLayoutRestorer, contributions: ContributionProvider<FrontendApplicationContribution>, _shell: ApplicationShell, stateService: FrontendApplicationStateService);
+    get shell(): ApplicationShell;
+    /**
+     * Start the frontend application.
+     *
+     * Start up consists of the following steps:
+     * - start frontend contributions
+     * - attach the application shell to the host element
+     * - initialize the application shell layout
+     * - reveal the application shell if it was hidden by a startup indicator
+     */
+    start(): Promise<void>;
+    /**
+     * Return a promise to the host element to which the application shell is attached.
+     */
+    protected getHost(): Promise<HTMLElement>;
+    /**
+     * Return an HTML element that indicates the startup phase, e.g. with an animation or a splash screen.
+     */
+    protected getStartupIndicator(host: HTMLElement): HTMLElement | undefined;
+    /**
+     * Register global event listeners.
+     */
+    protected registerEventListeners(): void;
+    /**
+     * Attach the application shell to the host element. If a startup indicator is present, the shell is
+     * inserted before that indicator so it is not visible yet.
+     */
+    protected attachShell(host: HTMLElement): void;
+    /**
+     * Attach the tooltip container to the host element.
+     */
+    protected attachTooltip(host: HTMLElement): void;
+    /**
+     * If a startup indicator is present, it is first hidden with the `theia-hidden` CSS class and then
+     * removed after a while. The delay until removal is taken from the CSS transition duration.
+     */
+    protected revealShell(host: HTMLElement): Promise<void>;
+    /**
+     * Initialize the shell layout either using the layout restorer service or, if no layout has
+     * been stored, by creating the default layout.
+     */
+    protected initializeLayout(): Promise<void>;
+    /**
+     * Try to restore the shell layout from the storage service. Resolves to `true` if successful.
+     */
+    protected restoreLayout(): Promise<boolean>;
+    /**
+     * Let the frontend application contributions initialize the shell layout. Override this
+     * method in order to create an application-specific custom layout.
+     */
+    protected createDefaultLayout(): Promise<void>;
+    protected fireOnDidInitializeLayout(): Promise<void>;
+    /**
+     * Initialize and start the frontend application contributions.
+     */
+    protected startContributions(): Promise<void>;
+    /**
+     * Stop the frontend application contributions. This is called when the window is unloaded.
+     */
+    protected stopContributions(): void;
+    protected measure<T>(name: string, fn: () => MaybePromise<T>, message?: string, threshold?: boolean): Promise<T>;
+}
 //# sourceMappingURL=frontend-application.d.ts.map