@gitpod/gitpod-protocol 0.1.5-main.648 → 0.1.5-main.6480

package/lib/protocol.d.ts

@@ -1,10 +1,11 @@
 /**
  * Copyright (c) 2020 Gitpod GmbH. All rights reserved.
  * Licensed under the GNU Affero General Public License (AGPL).
- * See License-AGPL.txt in the project root for license information.
+ * See License.AGPL.txt in the project root for license information.
  */
 import { WorkspaceInstance, PortVisibility } from "./workspace-instance";
 import { RoleOrPermission } from "./permission";
+import { Project } from "./teams-projects-protocol";
 export interface UserInfo {
     name?: string;
 }
@@ -18,7 +19,6 @@ export interface User {
     /** Optional for backwards compatibility */
     fullName?: string;
     identities: Identity[];
-    allowsMarketingCommunication: boolean;
     /**
      * Whether the user has been blocked to use our service, because of TOS violation for example.
      * Optional for backwards compatibility.
@@ -31,13 +31,35 @@ export interface User {
     /** Whether the user is logical deleted. This flag is respected by all queries in UserDB */
     markedDeleted?: boolean;
     additionalData?: AdditionalUserData;
+    usageAttributionId?: string;
+    lastVerificationTime?: string;
+    verificationPhoneNumber?: string;
 }
 export declare namespace User {
     function is(data: any): data is User;
     function getIdentity(user: User, authProviderId: string): Identity | undefined;
     function censor(user: User): User;
-    function getPrimaryEmail(user: User): string;
+    /**
+     * Returns the stored email or if it doesn't exist returns the primaryEmail of the first identity this user signed up with.
+     * @param user
+     * @returns A primaryEmail, or undefined if there is none.
+     */
+    function getPrimaryEmail(user: User): string | undefined;
     function getName(user: User): string | undefined;
+    function hasPreferredIde(user: User): boolean;
+    function isOnboardingUser(user: User): boolean;
+    function migrationIDESettings(user: User): void;
+    function getProfile(user: User): Profile;
+    function setProfile(user: User, profile: Profile): User;
+    interface Profile {
+        name: string;
+        email: string;
+        company?: string;
+        avatarURL?: string;
+    }
+    namespace Profile {
+        function hasChanges(before: Profile, after: Profile): boolean;
+    }
 }
 export interface AdditionalUserData {
     platforms?: UserPlatform[];
@@ -47,13 +69,39 @@ export interface AdditionalUserData {
     whatsNewSeen?: {
         [key: string]: string;
     };
+    oauthClientsApproved?: {
+        [key: string]: string;
+    };
+    knownGitHubOrgs?: string[];
+    dotfileRepo?: string;
+    workspaceClasses?: WorkspaceClasses;
+    profile?: ProfileDetails;
+    isMigratedToTeamOnlyAttribution?: boolean;
+}
+export declare namespace AdditionalUserData {
+    function set(user: User, partialData: Partial<AdditionalUserData>): User;
+}
+export interface ProfileDetails {
+    lastUpdatedDetailsNudge?: string;
+    companyName?: string;
+    emailAddress?: string;
 }
 export interface EmailNotificationSettings {
-    disallowTransactionalEmails?: boolean;
+    allowsChangelogMail?: boolean;
+    allowsDevXMail?: boolean;
+    allowsOnboardingMail?: boolean;
 }
 export declare type IDESettings = {
+    settingVersion?: string;
     defaultIde?: string;
+    useDesktopIde?: boolean;
+    defaultDesktopIde?: string;
+    useLatestVersion?: boolean;
 };
+export interface WorkspaceClasses {
+    regular?: string;
+    prebuild?: string;
+}
 export interface UserPlatform {
     uid: string;
     userAgent: string;
@@ -71,45 +119,81 @@ export interface UserPlatform {
     browserExtensionUninstalledSince?: string;
 }
 export interface UserFeatureSettings {
-    /**
-     * This field is used as marker to grant users a free trial for using private repositories,
-     * independent of any subscription or Chargebee.
-     *  - it is set when the user uses their first private repo
-     *  - whether the trial is expired or not is juged by the UserService
-     */
-    privateRepoTrialStartDate?: string;
     /**
      * Permanent feature flags are added to each and every workspace instance
      * this user starts.
      */
     permanentWSFeatureFlags?: NamedWorkspaceFeatureFlag[];
 }
+export declare type BillingTier = "paid" | "free";
 /**
  * The values of this type MUST MATCH enum values in WorkspaceFeatureFlag from ws-manager/client/core_pb.d.ts
  * If they don't we'll break things during workspace startup.
  */
 export declare const WorkspaceFeatureFlags: {
     full_workspace_backup: undefined;
-    fixed_resources: undefined;
+    workspace_class_limiting: undefined;
+    workspace_connection_limiting: undefined;
+    workspace_psi: undefined;
 };
-export declare type NamedWorkspaceFeatureFlag = keyof (typeof WorkspaceFeatureFlags);
-export interface UserEnvVarValue {
-    id?: string;
+export declare type NamedWorkspaceFeatureFlag = keyof typeof WorkspaceFeatureFlags;
+export declare namespace NamedWorkspaceFeatureFlag {
+    const WORKSPACE_PERSISTED_FEATTURE_FLAGS: NamedWorkspaceFeatureFlag[];
+    function isWorkspacePersisted(ff: NamedWorkspaceFeatureFlag): boolean;
+}
+export interface EnvVarWithValue {
     name: string;
-    repositoryPattern: string;
     value: string;
 }
+export interface ProjectEnvVarWithValue extends EnvVarWithValue {
+    id: string;
+    projectId: string;
+    censored: boolean;
+}
+export declare type ProjectEnvVar = Omit<ProjectEnvVarWithValue, "value">;
+export interface UserEnvVarValue extends EnvVarWithValue {
+    id?: string;
+    repositoryPattern: string;
+}
 export interface UserEnvVar extends UserEnvVarValue {
     id: string;
     userId: string;
     deleted?: boolean;
 }
 export declare namespace UserEnvVar {
+    /**
+     * @param variable
+     * @returns Either a string containing an error message or undefined.
+     */
+    function validate(variable: UserEnvVarValue): string | undefined;
     function normalizeRepoPattern(pattern: string): string;
     function score(value: UserEnvVarValue): number;
     function filter<T extends UserEnvVarValue>(vars: T[], owner: string, repo: string): T[];
     function splitRepositoryPattern(repositoryPattern: string): string[];
 }
+export interface SSHPublicKeyValue {
+    name: string;
+    key: string;
+}
+export interface UserSSHPublicKey extends SSHPublicKeyValue {
+    id: string;
+    key: string;
+    userId: string;
+    fingerprint: string;
+    creationTime: string;
+    lastUsedTime?: string;
+}
+export declare type UserSSHPublicKeyValue = Omit<UserSSHPublicKey, "userId">;
+export declare namespace SSHPublicKeyValue {
+    function validate(value: SSHPublicKeyValue): string | undefined;
+    function getData(value: SSHPublicKeyValue): {
+        type: string;
+        key: string;
+        email: string | undefined;
+    };
+    function getFingerprint(value: SSHPublicKeyValue): string;
+    const MAXIMUM_KEY_LENGTH = 5;
+}
 export interface GitpodToken {
     /** Hash value (SHA256) of the token (primary key). */
     tokenHash: string;
@@ -201,25 +285,25 @@ export interface PendingGithubEvent {
     creationDate: Date;
     type: string;
     event: string;
+    deleted: boolean;
 }
 export interface Snapshot {
     id: string;
     creationTime: string;
+    availableTime?: string;
     originalWorkspaceId: string;
     bucketId: string;
-    layoutData?: string;
-}
-export interface LayoutData {
-    workspaceId: string;
-    lastUpdatedTime: string;
-    layoutData: string;
+    state: SnapshotState;
+    message?: string;
 }
+export declare type SnapshotState = "pending" | "available" | "error";
 export interface Workspace {
     id: string;
     creationTime: string;
     contextURL: string;
     description: string;
     ownerId: string;
+    projectId?: string;
     context: WorkspaceContext;
     config: WorkspaceConfig;
     /**
@@ -260,7 +344,7 @@ export interface Workspace {
     basedOnSnapshotId?: string;
 }
 export declare type WorkspaceSoftDeletion = "user" | "gc";
-export declare type WorkspaceType = "regular" | "prebuild" | "probe";
+export declare type WorkspaceType = "regular" | "prebuild";
 export declare namespace Workspace {
     function getFullRepositoryName(ws: Workspace): string | undefined;
     function getFullRepositoryUrl(ws: Workspace): string | undefined;
@@ -269,20 +353,6 @@ export declare namespace Workspace {
     function getBranchName(ws: Workspace): string | undefined;
     function getCommit(ws: Workspace): string | undefined;
 }
-export interface PreparePluginUploadParams {
-    fullPluginName: string;
-}
-export interface ResolvePluginsParams {
-    config?: WorkspaceConfig;
-    builtins?: ResolvedPlugins;
-    vsxRegistryUrl?: string;
-}
-export interface InstallPluginsParams {
-    pluginIds: string[];
-}
-export interface UninstallPluginParams {
-    pluginId: string;
-}
 export interface GuessGitTokenScopesParams {
     host: string;
     repoUrl: string;
@@ -298,19 +368,38 @@ export interface GuessedGitTokenScopes {
     message?: string;
     scopes?: string[];
 }
-export declare type ResolvedPluginKind = 'user' | 'workspace' | 'builtin';
-export interface ResolvedPlugins {
-    [pluginId: string]: ResolvedPlugin | undefined;
+export interface VSCodeConfig {
+    extensions?: string[];
+}
+export interface JetBrainsConfig {
+    intellij?: JetBrainsProductConfig;
+    goland?: JetBrainsProductConfig;
+    pycharm?: JetBrainsProductConfig;
+    phpstorm?: JetBrainsProductConfig;
+    rubymine?: JetBrainsProductConfig;
+    webstorm?: JetBrainsProductConfig;
+    rider?: JetBrainsProductConfig;
+    clion?: JetBrainsProductConfig;
+}
+export interface JetBrainsProductConfig {
+    prebuilds?: JetBrainsPrebuilds;
+    vmoptions?: string;
 }
-export interface ResolvedPlugin {
-    fullPluginName: string;
+export interface JetBrainsPrebuilds {
+    version?: "stable" | "latest" | "both";
+}
+export interface RepositoryCloneInformation {
     url: string;
-    kind: ResolvedPluginKind;
+    checkoutLocation?: string;
 }
-export interface VSCodeConfig {
-    extensions?: string[];
+export interface CoreDumpConfig {
+    enabled?: boolean;
+    softLimit?: number;
+    hardLimit?: number;
 }
 export interface WorkspaceConfig {
+    mainConfiguration?: string;
+    additionalRepositories?: RepositoryCloneInformation[];
     image?: ImageConfig;
     ports?: PortConfig[];
     tasks?: TaskConfig[];
@@ -321,15 +410,20 @@ export interface WorkspaceConfig {
     };
     github?: GithubAppConfig;
     vscode?: VSCodeConfig;
+    jetbrains?: JetBrainsConfig;
+    coreDump?: CoreDumpConfig;
+    /** deprecated. Enabled by default **/
+    experimentalNetwork?: boolean;
     /**
      * Where the config object originates from.
      *
      * repo - from the repository
      * definitly-gp - from github.com/gitpod-io/definitely-gp
      * derived - computed based on analyzing the repository
+     * additional-content - config comes from additional content, usually provided through the project's configuration
      * default - our static catch-all default config
      */
-    _origin?: 'repo' | 'definitely-gp' | 'derived' | 'default';
+    _origin?: "repo" | "definitely-gp" | "derived" | "additional-content" | "default";
     /**
      * Set of automatically infered feature flags. That's not something the user can set, but
      * that is set by gitpod at workspace creation time.
@@ -344,7 +438,7 @@ export interface GithubAppPrebuildConfig {
     branches?: boolean;
     pullRequests?: boolean;
     pullRequestsFromForks?: boolean;
-    addCheck?: boolean;
+    addCheck?: boolean | "prevent-merge-on-error";
     addBadge?: boolean;
     addLabel?: boolean | string;
     addComment?: boolean;
@@ -354,9 +448,9 @@ export declare namespace GithubAppPrebuildConfig {
 }
 export declare type WorkspaceImageSource = WorkspaceImageSourceDocker | WorkspaceImageSourceReference;
 export interface WorkspaceImageSourceDocker {
-    dockerFileHash: string;
-    dockerFileSource: Commit;
     dockerFilePath: string;
+    dockerFileHash: string;
+    dockerFileSource?: Commit;
 }
 export declare namespace WorkspaceImageSourceDocker {
     function is(obj: object): obj is WorkspaceImageSourceDocker;
@@ -368,14 +462,17 @@ export interface WorkspaceImageSourceReference {
 export declare namespace WorkspaceImageSourceReference {
     function is(obj: object): obj is WorkspaceImageSourceReference;
 }
-export declare type PrebuiltWorkspaceState = "queued" | "building" | "aborted" | "timeout" | "available";
+export declare type PrebuiltWorkspaceState = "queued" | "building" | "aborted" | "timeout" | "available" | "failed";
 export interface PrebuiltWorkspace {
     id: string;
     cloneURL: string;
+    branch?: string;
+    projectId?: string;
     commit: string;
     buildWorkspaceId: string;
     creationTime: string;
     state: PrebuiltWorkspaceState;
+    statusVersion: number;
     error?: string;
     snapshot?: string;
 }
@@ -391,6 +488,10 @@ export interface PrebuiltWorkspaceUpdatable {
     repo: string;
     isResolved: boolean;
     installationId: string;
+    /**
+     * the commitSHA of the commit that triggered the prebuild
+     */
+    commitSHA?: string;
     issue?: string;
     contextUrl?: string;
 }
@@ -400,11 +501,13 @@ export interface WhitelistedRepository {
     description?: string;
     avatar?: string;
 }
-export declare type PortOnOpen = 'open-browser' | 'open-preview' | 'notify' | 'ignore';
+export declare type PortOnOpen = "open-browser" | "open-preview" | "notify" | "ignore";
 export interface PortConfig {
     port: number;
     onOpen?: PortOnOpen;
     visibility?: PortVisibility;
+    description?: string;
+    name?: string;
 }
 export declare namespace PortConfig {
     function is(config: any): config is PortConfig;
@@ -423,16 +526,16 @@ export interface TaskConfig {
     prebuild?: string;
     command?: string;
     env?: {
-        [env: string]: string;
+        [env: string]: any;
     };
-    openIn?: 'bottom' | 'main' | 'left' | 'right';
-    openMode?: 'split-top' | 'split-left' | 'split-right' | 'split-bottom' | 'tab-before' | 'tab-after';
+    openIn?: "bottom" | "main" | "left" | "right";
+    openMode?: "split-top" | "split-left" | "split-right" | "split-bottom" | "tab-before" | "tab-after";
 }
 export declare namespace TaskConfig {
     function is(config: any): config is TaskConfig;
 }
 export declare namespace WorkspaceImageBuild {
-    type Phase = 'BaseImage' | 'GitpodLayer' | 'Error' | 'Done';
+    type Phase = "BaseImage" | "GitpodLayer" | "Error" | "Done";
     interface StateInfo {
         phase: Phase;
         currentStep?: number;
@@ -469,8 +572,11 @@ export declare namespace ExternalImageConfigFile {
 }
 export interface WorkspaceContext {
     title: string;
+    ref?: string;
+    /** This contains the URL portion of the contextURL (which might contain other modifiers as well). It's optional because it's not set for older workspaces. */
     normalizedContextURL?: string;
     forceCreateNewWorkspace?: boolean;
+    forceImageBuild?: boolean;
 }
 export declare namespace WorkspaceContext {
     function is(context: any): context is WorkspaceContext;
@@ -481,22 +587,41 @@ export interface WithSnapshot {
 export declare namespace WithSnapshot {
     function is(context: any): context is WithSnapshot;
 }
-export interface WithPrebuild {
-    snapshotBucketId: string;
+export interface WithPrebuild extends WithSnapshot {
     prebuildWorkspaceId: string;
     wasPrebuilt: true;
 }
 export declare namespace WithPrebuild {
     function is(context: any): context is WithPrebuild;
 }
+/**
+ * WithDefaultConfig contexts disable the download of the gitpod.yml from the repository
+ * and fall back to the built-in configuration.
+ */
+export interface WithDefaultConfig {
+    withDefaultConfig: true;
+}
+export declare namespace WithDefaultConfig {
+    function is(context: any): context is WithDefaultConfig;
+    function mark(ctx: WorkspaceContext): WorkspaceContext & WithDefaultConfig;
+}
 export interface SnapshotContext extends WorkspaceContext, WithSnapshot {
     snapshotId: string;
 }
 export declare namespace SnapshotContext {
     function is(context: any): context is SnapshotContext;
 }
-export interface StartPrebuildContext extends WorkspaceContext {
+export interface WithCommitHistory {
+    commitHistory?: string[];
+    additionalRepositoryCommitHistories?: {
+        cloneUrl: string;
+        commitHistory: string[];
+    }[];
+}
+export interface StartPrebuildContext extends WorkspaceContext, WithCommitHistory {
     actual: WorkspaceContext;
+    project: Project;
+    branch?: string;
 }
 export declare namespace StartPrebuildContext {
     function is(context: any): context is StartPrebuildContext;
@@ -509,19 +634,19 @@ export interface PrebuiltWorkspaceContext extends WorkspaceContext {
 export declare namespace PrebuiltWorkspaceContext {
     function is(context: any): context is PrebuiltWorkspaceContext;
 }
+export interface WithReferrerContext extends WorkspaceContext {
+    referrer: string;
+    referrerIde?: string;
+}
+export declare namespace WithReferrerContext {
+    function is(context: any): context is WithReferrerContext;
+}
 export interface WithEnvvarsContext extends WorkspaceContext {
-    envvars: UserEnvVarValue[];
+    envvars: EnvVarWithValue[];
 }
 export declare namespace WithEnvvarsContext {
     function is(context: any): context is WithEnvvarsContext;
 }
-export interface WorkspaceProbeContext extends WorkspaceContext {
-    responseURL: string;
-    responseToken: string;
-}
-export declare namespace WorkspaceProbeContext {
-    function is(context: any): context is WorkspaceProbeContext;
-}
 export declare type RefType = "branch" | "tag" | "revision";
 export declare namespace RefType {
     const getRefType: (commit: Commit) => RefType;
@@ -532,9 +657,45 @@ export interface Commit {
     ref?: string;
     refType?: RefType;
 }
-export interface CommitContext extends WorkspaceContext, Commit {
+export interface AdditionalContentContext extends WorkspaceContext {
+    /**
+     * utf-8 encoded contents that will be copied on top of the workspace's filesystem
+     */
+    additionalFiles: {
+        [filePath: string]: string;
+    };
+}
+export declare namespace AdditionalContentContext {
+    function is(ctx: any): ctx is AdditionalContentContext;
+    function hasDockerConfig(ctx: any, config: WorkspaceConfig): boolean;
+}
+export interface OpenPrebuildContext extends WorkspaceContext {
+    openPrebuildID: string;
+}
+export declare namespace OpenPrebuildContext {
+    function is(ctx: any): ctx is OpenPrebuildContext;
+}
+export interface CommitContext extends WorkspaceContext, GitCheckoutInfo {
     /** @deprecated Moved to .repository.cloneUrl, left here for backwards-compatibility for old workspace contextes in the DB */
     cloneUrl?: string;
+    /**
+     * The clone and checkout information for additional repositories in case of multi-repo projects.
+     */
+    additionalRepositoryCheckoutInfo?: GitCheckoutInfo[];
+}
+export declare namespace CommitContext {
+    /**
+     * Creates a hash for all the commits of the CommitContext and all sub-repo commit infos.
+     * The hash is max 255 chars long.
+     * @param commitContext
+     * @returns hash for commitcontext
+     */
+    function computeHash(commitContext: CommitContext): string;
+}
+export interface GitCheckoutInfo extends Commit {
+    checkoutLocation?: string;
+    upstreamRemoteURI?: string;
+    localBranch?: string;
 }
 export declare namespace CommitContext {
     function is(commit: any): commit is CommitContext;
@@ -570,6 +731,7 @@ export interface Repository {
     owner: string;
     name: string;
     cloneUrl: string;
+    repoKind?: string;
     description?: string;
     avatarUrl?: string;
     webUrl?: string;
@@ -580,6 +742,18 @@ export interface Repository {
         parent: Repository;
     };
 }
+export interface Branch {
+    name: string;
+    commit: CommitInfo;
+    htmlUrl: string;
+}
+export interface CommitInfo {
+    author: string;
+    sha: string;
+    commitMessage: string;
+    authorAvatarUrl?: string;
+    authorDate?: string;
+}
 export declare namespace Repository {
     function fullRepoName(repo: Repository): string;
 }
@@ -609,18 +783,13 @@ export interface WorkspaceCreationResult {
     runningWorkspacePrebuild?: {
         prebuildID: string;
         workspaceID: string;
+        instanceID: string;
         starting: RunningWorkspacePrebuildStarting;
         sameCluster: boolean;
     };
     runningPrebuildWorkspaceID?: string;
 }
-export declare type RunningWorkspacePrebuildStarting = 'queued' | 'starting' | 'running';
-export declare enum CreateWorkspaceMode {
-    Default = "default",
-    ForceNew = "force-new",
-    UsePrebuild = "use-prebuild",
-    SelectIfRunning = "select-if-running"
-}
+export declare type RunningWorkspacePrebuildStarting = "queued" | "starting" | "running";
 export declare namespace WorkspaceCreationResult {
     function is(data: any): data is WorkspaceCreationResult;
 }
@@ -659,8 +828,11 @@ export interface AuthProviderEntry {
     readonly type: AuthProviderEntry.Type;
     readonly host: string;
     readonly ownerId: string;
+    readonly organizationId?: string;
     readonly status: AuthProviderEntry.Status;
     readonly oauth: OAuth2Config;
+    /** A random string that is to change whenever oauth changes (enforced on DB level) */
+    readonly oauthRevision?: string;
 }
 export interface OAuth2Config {
     readonly clientId: string;
@@ -684,39 +856,15 @@ export declare namespace AuthProviderEntry {
         clientSecret?: string;
     };
     type UpdateEntry = Pick<AuthProviderEntry, "id" | "ownerId"> & Pick<OAuth2Config, "clientId" | "clientSecret">;
-    function redact(entry: AuthProviderEntry): AuthProviderEntry;
-}
-export interface Branding {
-    readonly name: string;
-    readonly favicon?: string;
-    /** Either including domain OR absolute path (interpreted relative to host URL) */
-    readonly logo: string;
-    readonly startupLogo: string;
-    readonly showProductivityTips: boolean;
-    readonly redirectUrlIfNotAuthenticated?: string;
-    readonly redirectUrlAfterLogout?: string;
-    readonly homepage: string;
-    readonly ide?: {
-        readonly logo: string;
-        readonly showReleaseNotes: boolean;
-        readonly helpMenu: Branding.Link[];
+    type NewOrgEntry = NewEntry & {
+        organizationId: string;
     };
-    readonly links: {
-        readonly header: Branding.Link[];
-        readonly footer: Branding.Link[];
-        readonly social: Branding.SocialLink[];
-        readonly legal: Branding.Link[];
+    type UpdateOrgEntry = Pick<AuthProviderEntry, "id"> & {
+        clientId: string;
+        clientSecret: string;
+        organizationId: string;
     };
-}
-export declare namespace Branding {
-    interface Link {
-        readonly name: string;
-        readonly url: string;
-    }
-    interface SocialLink {
-        readonly type: string;
-        readonly url: string;
-    }
+    function redact(entry: AuthProviderEntry): AuthProviderEntry;
 }
 export interface Configuration {
     readonly daysBeforeGarbageCollection: number;
@@ -755,4 +903,12 @@ export interface Terms {
     readonly content: string;
     readonly formElements?: object;
 }
+export interface StripeConfig {
+    individualUsagePriceIds: {
+        [currency: string]: string;
+    };
+    teamUsagePriceIds: {
+        [currency: string]: string;
+    };
+}
 //# sourceMappingURL=protocol.d.ts.map