/**
 * Copyright (c) 2020 TypeFox GmbH. All rights reserved.
 * Licensed under the GNU Affero General Public License (AGPL).
 * See License-AGPL.txt in the project root for license information.
 */
import { User, WorkspaceInfo, WorkspaceCreationResult, UserMessage, WorkspaceInstanceUser, WhitelistedRepository, WorkspaceImageBuild, AuthProviderInfo, Branding, CreateWorkspaceMode, Token, UserEnvVarValue, ResolvePluginsParams, PreparePluginUploadParams, ResolvedPlugins, Configuration, InstallPluginsParams, UninstallPluginParams, UserInfo, GitpodTokenType, GitpodToken, AuthProviderEntry } from './protocol';
import { JsonRpcProxy, JsonRpcServer } from './messaging/proxy-factory';
import { Disposable } from 'vscode-jsonrpc';
import { HeadlessLogEvent } from './headless-workspace-log';
import { WorkspaceInstance, WorkspaceInstancePort } from './workspace-instance';
import { AdminServer } from './admin-protocol';
import { PermissionName } from './permission';
import { LicenseService } from './license-protocol';
export interface GitpodClient {
    onInstanceUpdate(instance: WorkspaceInstance): void;
    onWorkspaceImageBuildLogs: WorkspaceImageBuild.LogCallback;
    onHeadlessWorkspaceLogs(evt: HeadlessLogEvent): void;
}
export declare const GitpodServer: unique symbol;
export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer, LicenseService {
    getLoggedInUser(): Promise<User>;
    updateLoggedInUser(user: Partial<User>): Promise<User>;
    getAuthProviders(): Promise<AuthProviderInfo[]>;
    getOwnAuthProviders(): Promise<AuthProviderEntry[]>;
    updateOwnAuthProvider(params: GitpodServer.UpdateOwnAuthProviderParams): Promise<void>;
    deleteOwnAuthProvider(params: GitpodServer.DeleteOwnAuthProviderParams): Promise<void>;
    getBranding(): Promise<Branding>;
    getConfiguration(): Promise<Configuration>;
    getToken(query: GitpodServer.GetTokenSearchOptions): Promise<Token | undefined>;
    getPortAuthenticationToken(workspaceId: string): Promise<Token>;
    deleteAccount(): Promise<void>;
    getClientRegion(): Promise<string | undefined>;
    hasPermission(permission: PermissionName): Promise<boolean>;
    getWorkspaces(options: GitpodServer.GetWorkspacesOptions): Promise<WorkspaceInfo[]>;
    getWorkspaceOwner(workspaceId: string): Promise<UserInfo | undefined>;
    getWorkspaceUsers(workspaceId: string): Promise<WorkspaceInstanceUser[]>;
    getFeaturedRepositories(): Promise<WhitelistedRepository[]>;
    getWorkspace(id: string): Promise<WorkspaceInfo>;
    isWorkspaceOwner(workspaceId: string): Promise<boolean>;
    /**
     * Creates and starts a workspace for the given context URL.
     * @param options GitpodServer.CreateWorkspaceOptions
     * @return WorkspaceCreationResult
     */
    createWorkspace(options: GitpodServer.CreateWorkspaceOptions): Promise<WorkspaceCreationResult>;
    startWorkspace(id: string, options: {
        forceDefaultImage: boolean;
    }): Promise<StartWorkspaceResult>;
    stopWorkspace(id: string): Promise<void>;
    deleteWorkspace(id: string): Promise<void>;
    setWorkspaceDescription(id: string, desc: string): Promise<void>;
    controlAdmission(id: string, level: "owner" | "everyone"): Promise<void>;
    updateWorkspaceUserPin(id: string, action: "pin" | "unpin" | "toggle"): Promise<void>;
    sendHeartBeat(options: GitpodServer.SendHeartBeatOptions): Promise<void>;
    watchWorkspaceImageBuildLogs(workspaceId: string): Promise<void>;
    watchHeadlessWorkspaceLogs(workspaceId: string): Promise<void>;
    isPrebuildAvailable(pwsid: string): Promise<boolean>;
    setWorkspaceTimeout(workspaceId: string, duration: WorkspaceTimeoutDuration): Promise<SetWorkspaceTimeoutResult>;
    getWorkspaceTimeout(workspaceId: string): Promise<GetWorkspaceTimeoutResult>;
    sendHeartBeat(options: GitpodServer.SendHeartBeatOptions): Promise<void>;
    updateWorkspaceUserPin(id: string, action: "pin" | "unpin" | "toggle"): Promise<void>;
    getOpenPorts(workspaceId: string): Promise<WorkspaceInstancePort[]>;
    openPort(workspaceId: string, port: WorkspaceInstancePort): Promise<WorkspaceInstancePort | undefined>;
    closePort(workspaceId: string, port: number): Promise<void>;
    getUserMessages(options: GitpodServer.GetUserMessagesOptions): Promise<UserMessage[]>;
    updateUserMessages(options: GitpodServer.UpdateUserMessagesOptions): Promise<void>;
    getUserStorageResource(options: GitpodServer.GetUserStorageResourceOptions): Promise<string>;
    updateUserStorageResource(options: GitpodServer.UpdateUserStorageResourceOptions): Promise<void>;
    getEnvVars(): Promise<UserEnvVarValue[]>;
    setEnvVar(variable: UserEnvVarValue): Promise<void>;
    deleteEnvVar(variable: UserEnvVarValue): Promise<void>;
    getGitpodTokens(): Promise<GitpodToken[]>;
    generateNewGitpodToken(options: {
        name?: string;
        type: GitpodTokenType;
        scopes?: [];
    }): Promise<string>;
    deleteGitpodToken(tokenHash: string): Promise<void>;
    sendFeedback(feedback: string): Promise<string | undefined>;
    registerGithubApp(installationId: string): Promise<void>;
    /**
     * Stores a new snapshot for the given workspace and bucketId
     * @return the snapshot id
     */
    takeSnapshot(options: GitpodServer.TakeSnapshotOptions): Promise<string>;
    /**
     * Returns the list of snapshots that exist for a workspace.
     */
    getSnapshots(workspaceID: string): Promise<string[]>;
    /**
     * stores/updates layout information for the given workspace
     */
    storeLayout(workspaceId: string, layoutData: string): Promise<void>;
    /**
     * retrieves layout information for the given workspace
     */
    getLayout(workspaceId: string): Promise<string | undefined>;
    /**
     * @param params
     * @returns promise resolves to an URL to be used for the upload
     */
    preparePluginUpload(params: PreparePluginUploadParams): Promise<string>;
    resolvePlugins(workspaceId: string, params: ResolvePluginsParams): Promise<ResolvedPlugins>;
    installUserPlugins(params: InstallPluginsParams): Promise<boolean>;
    uninstallUserPlugin(params: UninstallPluginParams): Promise<boolean>;
}
export declare const WorkspaceTimeoutValues: readonly ["30m", "60m", "180m"];
export declare const createServiceMock: <C extends GitpodClient, S extends GitpodServer>(methods: Partial<JsonRpcProxy<S>>) => GitpodServiceImpl<C, S>;
export declare const createServerMock: <C extends GitpodClient, S extends GitpodServer>(methods: Partial<JsonRpcProxy<S>>) => JsonRpcProxy<S>;
declare type WorkspaceTimeoutDurationTuple = typeof WorkspaceTimeoutValues;
export declare type WorkspaceTimeoutDuration = WorkspaceTimeoutDurationTuple[number];
export interface SetWorkspaceTimeoutResult {
    resetTimeoutOnWorkspaces: string[];
}
export interface GetWorkspaceTimeoutResult {
    duration: WorkspaceTimeoutDuration;
    canChange: boolean;
}
export interface StartWorkspaceResult {
    instanceID: string;
    workspaceURL?: string;
}
export declare namespace GitpodServer {
    interface GetWorkspacesOptions {
        limit?: number;
        searchString?: string;
        pinnedOnly?: boolean;
    }
    interface GetAccountStatementOptions {
        date?: string;
    }
    interface CreateWorkspaceOptions {
        contextUrl: string;
        mode?: CreateWorkspaceMode;
    }
    interface TakeSnapshotOptions {
        workspaceId: string;
        layoutData?: string;
    }
    interface GetUserMessagesOptions {
        readonly releaseNotes?: boolean;
        readonly workspaceInstanceId: string;
    }
    interface UpdateUserMessagesOptions {
        readonly messageIds: string[];
    }
    interface GetUserStorageResourceOptions {
        readonly uri: string;
    }
    interface UpdateUserStorageResourceOptions {
        readonly uri: string;
        readonly content: string;
    }
    interface GetTokenSearchOptions {
        readonly host: string;
    }
    interface SendHeartBeatOptions {
        readonly instanceId: string;
        readonly wasClosed?: boolean;
        readonly roundTripTime?: number;
    }
    interface UpdateOwnAuthProviderParams {
        readonly entry: AuthProviderEntry.UpdateEntry | AuthProviderEntry.NewEntry;
    }
    interface DeleteOwnAuthProviderParams {
        readonly id: string;
    }
}
export declare const GitpodServerPath = "/gitpod";
export declare const GitpodServerProxy: unique symbol;
export declare type GitpodServerProxy<S extends GitpodServer> = JsonRpcProxy<S>;
export declare class GitpodCompositeClient<Client extends GitpodClient> implements GitpodClient {
    protected clients: Partial<Client>[];
    registerClient(client: Partial<Client>): Disposable;
    onInstanceUpdate(instance: WorkspaceInstance): void;
    onWorkspaceImageBuildLogs(info: WorkspaceImageBuild.StateInfo, content: WorkspaceImageBuild.LogContent | undefined): void;
    onHeadlessWorkspaceLogs(evt: HeadlessLogEvent): void;
}
export declare const GitpodService: unique symbol;
export declare type GitpodService = GitpodServiceImpl<GitpodClient, GitpodServer>;
export declare class GitpodServiceImpl<Client extends GitpodClient, Server extends GitpodServer> {
    readonly server: JsonRpcProxy<Server>;
    protected compositeClient: GitpodCompositeClient<Client>;
    constructor(server: JsonRpcProxy<Server>);
    registerClient(client: Partial<Client>): Disposable;
}
export declare function createGitpodService<C extends GitpodClient, S extends GitpodServer>(serverUrl: string): GitpodServiceImpl<C, S>;
export {};
//# sourceMappingURL=gitpod-service.d.ts.map