@theia/workspace 1.67.0-next.56 → 1.67.0-next.59

package/lib/browser/workspace-service.d.ts

@@ -0,0 +1,201 @@
+import URI from '@theia/core/lib/common/uri';
+import { WorkspaceServer, UntitledWorkspaceService, WorkspaceFileService } from '../common';
+import { WindowService } from '@theia/core/lib/browser/window/window-service';
+import { FrontendApplicationContribution, LabelProvider } from '@theia/core/lib/browser';
+import { Deferred } from '@theia/core/lib/common/promise-util';
+import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
+import { ILogger, Disposable, DisposableCollection, Emitter, Event, MaybePromise, MessageService, ContributionProvider } from '@theia/core';
+import { WorkspacePreferences } from '../common/workspace-preferences';
+import { FileStat, BaseStat } from '@theia/filesystem/lib/common/files';
+import { FileService } from '@theia/filesystem/lib/browser/file-service';
+import { WindowTitleService } from '@theia/core/lib/browser/window/window-title-service';
+import { FileSystemPreferences } from '@theia/filesystem/lib/common';
+import { WorkspaceSchemaUpdater } from './workspace-schema-updater';
+import { IJSONSchema } from '@theia/core/lib/common/json-schema';
+import { PreferenceSchemaService, PreferenceService } from '@theia/core/lib/common/preferences';
+export declare const WorkspaceOpenHandlerContribution: unique symbol;
+export interface WorkspaceOpenHandlerContribution {
+    canHandle(uri: URI): MaybePromise<boolean>;
+    openWorkspace(uri: URI, options?: WorkspaceInput): MaybePromise<void>;
+    getWorkspaceLabel?(uri: URI): MaybePromise<string | undefined>;
+}
+/**
+ * The workspace service.
+ */
+export declare class WorkspaceService implements FrontendApplicationContribution, WorkspaceOpenHandlerContribution {
+    protected _workspace: FileStat | undefined;
+    protected _roots: FileStat[];
+    protected deferredRoots: Deferred<FileStat[]>;
+    protected readonly fileService: FileService;
+    protected readonly server: WorkspaceServer;
+    protected readonly windowService: WindowService;
+    protected logger: ILogger;
+    protected preferences: WorkspacePreferences;
+    protected readonly preferenceImpl: PreferenceService;
+    protected readonly schemaService: PreferenceSchemaService;
+    protected readonly envVariableServer: EnvVariablesServer;
+    protected readonly messageService: MessageService;
+    protected readonly labelProvider: LabelProvider;
+    protected readonly fsPreferences: FileSystemPreferences;
+    protected readonly schemaUpdater: WorkspaceSchemaUpdater;
+    protected readonly untitledWorkspaceService: UntitledWorkspaceService;
+    protected readonly workspaceFileService: WorkspaceFileService;
+    protected readonly windowTitleService: WindowTitleService;
+    protected readonly openHandlerContribution: ContributionProvider<WorkspaceOpenHandlerContribution>;
+    protected _ready: Deferred<void>;
+    get ready(): Promise<void>;
+    protected init(): void;
+    protected doInit(): Promise<void>;
+    /**
+     * Resolves to the default workspace URI as string.
+     *
+     * The default implementation tries to extract the default workspace location
+     * from the `window.location.hash`, then falls-back to the most recently
+     * used workspace root from the server.
+     *
+     * It is not ensured that the resolved workspace URI is valid, it can point
+     * to a non-existing location.
+     */
+    protected getDefaultWorkspaceUri(): MaybePromise<string | undefined>;
+    protected doGetDefaultWorkspaceUri(): Promise<string | undefined>;
+    /**
+     * Set the URL fragment to the given workspace path.
+     */
+    protected setURLFragment(workspacePath: string): void;
+    get roots(): Promise<FileStat[]>;
+    tryGetRoots(): FileStat[];
+    get workspace(): FileStat | undefined;
+    protected readonly onWorkspaceChangeEmitter: Emitter<FileStat[]>;
+    get onWorkspaceChanged(): Event<FileStat[]>;
+    protected readonly onWorkspaceLocationChangedEmitter: Emitter<FileStat | undefined>;
+    get onWorkspaceLocationChanged(): Event<FileStat | undefined>;
+    protected readonly toDisposeOnWorkspace: DisposableCollection;
+    protected setWorkspace(workspaceStat: FileStat | undefined): Promise<void>;
+    protected updateWorkspace(): Promise<void>;
+    protected updateRoots(): Promise<void>;
+    protected computeRoots(): Promise<FileStat[]>;
+    protected getWorkspaceDataFromFile(): Promise<WorkspaceData | undefined>;
+    protected updateTitle(): void;
+    /**
+     * on unload, we set our workspace root as the last recently used on the backend.
+     */
+    onStop(): void;
+    recentWorkspaces(): Promise<string[]>;
+    removeRecentWorkspace(uri: string): Promise<void>;
+    /**
+     * Returns `true` if theia has an opened workspace or folder
+     * @returns {boolean}
+     */
+    get opened(): boolean;
+    /**
+     * Returns `true` if a multiple-root workspace is currently open.
+     * @returns {boolean}
+     */
+    get isMultiRootWorkspaceOpened(): boolean;
+    /**
+     * Opens directory, or recreates a workspace from the file that `uri` points to.
+     */
+    open(uri: URI, options?: WorkspaceInput): void;
+    protected doOpen(uri: URI, options?: WorkspaceInput): Promise<void>;
+    canHandle(uri: URI): Promise<boolean>;
+    openWorkspace(uri: URI, options?: WorkspaceInput): Promise<void>;
+    /**
+     * Adds root folder(s) to the workspace
+     * @param uris URI or URIs of the root folder(s) to add
+     */
+    addRoot(uris: URI[] | URI): Promise<void>;
+    /**
+     * Removes root folder(s) from workspace.
+     */
+    removeRoots(uris: URI[]): Promise<void>;
+    spliceRoots(start: number, deleteCount?: number, ...rootsToAdd: URI[]): Promise<URI[]>;
+    getUntitledWorkspace(): Promise<URI>;
+    protected writeWorkspaceFile(workspaceFile: FileStat | undefined, workspaceData: WorkspaceData): Promise<FileStat | undefined>;
+    /**
+     * Clears current workspace root.
+     */
+    close(): Promise<void>;
+    /**
+     * returns a FileStat if the argument URI points to an existing directory. Otherwise, `undefined`.
+     */
+    protected toValidRoot(uri: URI | string | undefined): Promise<FileStat | undefined>;
+    /**
+     * returns a FileStat if the argument URI points to a file or directory. Otherwise, `undefined`.
+     */
+    protected toFileStat(uri: URI | string | undefined): Promise<FileStat | undefined>;
+    protected openWindow(uri: FileStat, options?: WorkspaceInput): void;
+    protected reloadWindow(workspacePath: string, options?: WorkspaceInput): void;
+    protected openNewWindow(workspacePath: string, options?: WorkspaceInput): void;
+    protected shouldPreserveWindow(options?: WorkspaceInput): boolean;
+    /**
+     * Return true if one of the paths in paths array is present in the workspace
+     * NOTE: You should always explicitly use `/` as the separator between the path segments.
+     */
+    containsSome(paths: string[]): Promise<boolean>;
+    /**
+     * `true` if the current workspace is configured using a configuration file.
+     *
+     * `false` if there is no workspace or the workspace is simply a folder.
+     */
+    get saved(): boolean;
+    /**
+     * Save workspace data into a file
+     * @param uri URI or FileStat of the workspace file
+     */
+    save(uri: URI | FileStat): Promise<void>;
+    protected readonly rootWatchers: Map<string, Disposable>;
+    protected watchRoots(): Promise<void>;
+    protected refreshRootWatchers(): Promise<void>;
+    protected watchRoot(root: FileStat): Promise<void>;
+    protected getExcludes(uri: string): string[];
+    /**
+     * Returns the workspace root uri that the given file belongs to.
+     * In case that the file is found in more than one workspace roots, returns the root that is closest to the file.
+     * If the file is not from the current workspace, returns `undefined`.
+     * @param uri URI of the file
+     */
+    getWorkspaceRootUri(uri: URI | undefined): URI | undefined;
+    /**
+     * Returns the relative path of the given file to the workspace root.
+     * @param uri URI of the file
+     * @see getWorkspaceRootUri(uri)
+     */
+    getWorkspaceRelativePath(uri: URI): Promise<string>;
+    areWorkspaceRoots(uris: URI[]): boolean;
+    /**
+     * Check if the file should be considered as a workspace file.
+     *
+     * Example: We should not try to read the contents of an .exe file.
+     */
+    protected isWorkspaceFile(candidate: FileStat | URI): boolean;
+    isUntitledWorkspace(candidate?: URI): boolean;
+    isSafeToReload(withURI?: URI): Promise<boolean>;
+    /**
+     *
+     * @param key the property key under which to store the schema (e.g. tasks, launch)
+     * @param schema the schema for the property. If none is supplied, the update is treated as a deletion.
+     */
+    updateSchema(key: string, schema?: IJSONSchema): Promise<boolean>;
+}
+export interface WorkspaceInput {
+    /**
+     * Tests whether the same window should be used or a new one has to be opened after setting the workspace root. By default it is `false`.
+     */
+    preserveWindow?: boolean;
+}
+export interface WorkspaceData {
+    folders: Array<{
+        path: string;
+        name?: string;
+    }>;
+    [key: string]: {
+        [id: string]: any;
+    };
+}
+export declare namespace WorkspaceData {
+    function is(data: unknown): data is WorkspaceData;
+    function buildWorkspaceData(folders: string[] | FileStat[], additionalFields?: Partial<WorkspaceData>): WorkspaceData;
+    function transformToRelative(data: WorkspaceData, workspaceFile?: FileStat): WorkspaceData;
+    function transformToAbsolute(data: WorkspaceData, workspaceFile?: BaseStat): WorkspaceData;
+}
+//# sourceMappingURL=workspace-service.d.ts.map

package/lib/browser/workspace-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-service.d.ts","sourceRoot":"","sources":["../../src/browser/workspace-service.ts"],"names":[],"mappings":"AAiBA,OAAO,GAAG,MAAM,4BAA4B,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAC5F,OAAO,EAAE,aAAa,EAAE,MAAM,+CAA+C,CAAC;AAE9E,OAAO,EACH,+BAA+B,EAAE,aAAa,EACjD,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,cAAc,EAAO,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACjJ,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAGvE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,4CAA4C,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,qDAAqD,CAAC;AACzF,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAmB,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAEjE,OAAO,EAAE,uBAAuB,EAAmB,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAEjH,eAAO,MAAM,gCAAgC,eAA6C,CAAC;AAE3F,MAAM,WAAW,gCAAgC;IAC7C,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAC3C,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACtE,iBAAiB,CAAC,CAAC,GAAG,EAAE,GAAG,GAAG,YAAY,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAClE;AAED;;GAEG;AACH,qBACa,gBAAiB,YAAW,+BAA+B,EAAE,gCAAgC;IAEtG,SAAS,CAAC,UAAU,EAAE,QAAQ,GAAG,SAAS,CAAC;IAE3C,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAM;IAClC,SAAS,CAAC,aAAa,uBAA8B;IAGrD,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAG5C,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IAG3C,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IAGhD,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;IAG1B,SAAS,CAAC,WAAW,EAAE,oBAAoB,CAAC;IAG5C,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,iBAAiB,CAAC;IAGrD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,uBAAuB,CAAC;IAG1D,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,kBAAkB,CAAC;IAGzD,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IAGlD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IAGhD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,qBAAqB,CAAC;IAGxD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,sBAAsB,CAAC;IAGzD,SAAS,CAAC,QAAQ,CAAC,wBAAwB,EAAE,wBAAwB,CAAC;IAGtE,SAAS,CAAC,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,CAAC;IAG9D,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAG1D,SAAS,CAAC,QAAQ,CAAC,uBAAuB,EAAE,oBAAoB,CAAC,gCAAgC,CAAC,CAAC;IAEnG,SAAS,CAAC,MAAM,iBAAwB;IACxC,IAAI,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAEzB;IAGD,SAAS,CAAC,IAAI,IAAI,IAAI;cAIN,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAkBvC;;;;;;;;;OASG;IACH,SAAS,CAAC,sBAAsB,IAAI,YAAY,CAAC,MAAM,GAAG,SAAS,CAAC;cAIpD,wBAAwB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IA8BvE;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAIrD,IAAI,KAAK,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAE/B;IACD,WAAW,IAAI,QAAQ,EAAE;IAGzB,IAAI,SAAS,IAAI,QAAQ,GAAG,SAAS,CAEpC;IAED,SAAS,CAAC,QAAQ,CAAC,wBAAwB,sBAA6B;IACxE,IAAI,kBAAkB,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC,CAE1C;IAED,SAAS,CAAC,QAAQ,CAAC,iCAAiC,gCAAuC;IAC3F,IAAI,0BAA0B,IAAI,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC,CAE5D;IAED,SAAS,CAAC,QAAQ,CAAC,oBAAoB,uBAA8B;cACrD,YAAY,CAAC,aAAa,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;cAyBhE,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;cAKhC,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;cAsB5B,YAAY,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;cAsBnC,wBAAwB,IAAI,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAoB9E,SAAS,CAAC,WAAW,IAAI,IAAI;IA0B7B;;OAEG;IACH,MAAM,IAAI,IAAI;IAIR,gBAAgB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAIrC,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD;;;OAGG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;OAGG;IACH,IAAI,0BAA0B,IAAI,OAAO,CAExC;IAED;;OAEG;IACH,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,IAAI;cAI9B,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAUnE,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAIrC,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBtE;;;OAGG;IACG,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAK/C;;OAEG;IACG,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBvC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IA8BtF,oBAAoB,IAAI,OAAO,CAAC,GAAG,CAAC;cAa1B,kBAAkB,CAAC,aAAa,EAAE,QAAQ,GAAG,SAAS,EAAE,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IAUpI;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAW5B;;OAEG;cACa,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IAQzF;;OAEG;cACa,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IAgBxF,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,IAAI;IAenE,SAAS,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,IAAI;IAO7E,SAAS,CAAC,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,IAAI;IAM9E,SAAS,CAAC,oBAAoB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO;IAIjE;;;OAGG;IACG,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBrD;;;;OAIG;IACH,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED;;;OAGG;IACG,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAgC9C,SAAS,CAAC,QAAQ,CAAC,YAAY,0BAAiC;cAEhD,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;cAY3B,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;cAOpC,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBxD,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE;IAK5C;;;;;OAKG;IACH,mBAAmB,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS,GAAG,GAAG,GAAG,SAAS;IAkB1D;;;;OAIG;IACG,wBAAwB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IAWzD,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IAQvC;;;;OAIG;IACH,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,QAAQ,GAAG,GAAG,GAAG,OAAO;IAI7D,mBAAmB,CAAC,SAAS,CAAC,EAAE,GAAG,GAAG,OAAO;IAIvC,cAAc,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAIrD;;;;OAIG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;CAG1E;AAED,MAAM,WAAW,cAAc;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAE5B;AAED,MAAM,WAAW,aAAa;IAC1B,OAAO,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAEhD,CAAC,GAAG,EAAE,MAAM,GAAG;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACxC;AAED,yBAAiB,aAAa,CAAC;IAG3B,SAAgB,EAAE,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,aAAa,CAEvD;IAED,SAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,QAAQ,EAAE,EAAE,gBAAgB,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,aAAa,CAiB3H;IAED,SAAgB,mBAAmB,CAAC,IAAI,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,QAAQ,GAAG,aAAa,CAahG;IAED,SAAgB,mBAAmB,CAAC,IAAI,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,QAAQ,GAAG,aAAa,CAkBhG;CACJ"}