@gitpod/gitpod-protocol 0.1.5-me-test04251.1 → 0.1.5-me-fixheader.1

package/src/util/tracing.spec.ts

@@ -1,7 +1,7 @@
 /**
  * Copyright (c) 2021 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 { suite, test } from "mocha-typescript";

package/src/util/tracing.ts

@@ -1,7 +1,7 @@
 /**
  * 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 * as opentracing from "opentracing";

package/src/util/workspace-port-authentication.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
  */
 
 /**

package/src/webhook-event.ts

@@ -0,0 +1,55 @@
+/**
+ * Copyright (c) 2022 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.
+ */
+
+export interface WebhookEvent {
+    id: string;
+    creationTime: string;
+    type: "push" | string;
+
+    /**
+     * Typically the webhook installer is referenced here.
+     */
+    authorizedUserId?: string;
+
+    /**
+     * webhook event's payload
+     */
+    rawEvent: string;
+
+    /**
+     * The general status of the received webhook event.
+     */
+    status: WebhookEvent.Status;
+
+    /**
+     * Optional message to help understand errors with handling events.
+     */
+    message?: string;
+
+    /**
+     * If the webhook event is considered to trigger a prebuild, the `prebuildStatus`
+     * contains a more specific status.
+     */
+    prebuildStatus?: WebhookEvent.PrebuildStatus;
+
+    /**
+     * If `prebuildStatus` is `prebuild_triggered` this points to a prebuild.
+     */
+    prebuildId?: string;
+
+    projectId?: string;
+
+    cloneUrl?: string;
+
+    branch?: string;
+
+    commit?: string;
+}
+
+export namespace WebhookEvent {
+    export type Status = "received" | "dismissed_unauthorized" | "ignored" | "processed";
+    export type PrebuildStatus = "ignored_unconfigured" | "prebuild_trigger_failed" | "prebuild_triggered";
+}

package/src/workspace-class.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) 2022 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.
+ */
+
+export interface SupportedWorkspaceClass {
+    id: string;
+    category: string;
+    displayName: string;
+    description: string;
+    powerups: number;
+    isSelected: boolean;
+}

package/src/workspace-cluster.ts

@@ -1,7 +1,7 @@
 /**
  * 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 * as fs from "fs";
@@ -15,6 +15,10 @@ export interface WorkspaceCluster {
     // Must be identical to the installationShortname of the cluster it represents!
     name: string;
 
+    // The name of the application cluster to which this cluster should be registered.
+    // The name can be at most 60 characters.
+    applicationCluster: string;
+
     // URL of the cluster's ws-manager API
     url: string;
 
@@ -56,12 +60,10 @@ export type WorkspaceManagerConnectionInfo = Pick<WorkspaceCluster, "name" | "ur
 export type AdmissionConstraint =
     | AdmissionConstraintFeaturePreview
     | AdmissionConstraintHasPermission
-    | AdmissionConstraintHasUserLevel
-    | AdmissionConstraintHasMoreResources;
+    | AdmissionConstraintHasClass;
 export type AdmissionConstraintFeaturePreview = { type: "has-feature-preview" };
 export type AdmissionConstraintHasPermission = { type: "has-permission"; permission: PermissionName };
-export type AdmissionConstraintHasUserLevel = { type: "has-user-level"; level: string };
-export type AdmissionConstraintHasMoreResources = { type: "has-more-resources" };
+export type AdmissionConstraintHasClass = { type: "has-class"; id: string; displayName: string };
 
 export namespace AdmissionConstraint {
     export function is(o: any): o is AdmissionConstraint {

package/src/workspace-instance.ts

@@ -1,7 +1,7 @@
 /**
  * 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 { NamedWorkspaceFeatureFlag } from "./protocol";
@@ -56,10 +56,27 @@ export interface WorkspaceInstance {
      * Contains information about the image build, if there was any
      */
     imageBuildInfo?: ImageBuildInfo;
+
+    /**
+     * workspace class, also known as workspace size, determines the type of
+     * resources that are provided to the workspace.
+     */
+    workspaceClass?: string;
+
+    /**
+     * Identifies the team or user to which this instance's runtime should be attributed to
+     * (e.g. for usage analytics or billing purposes).
+     */
+    usageAttributionId?: string;
 }
 
 // WorkspaceInstanceStatus describes the current state of a workspace instance
 export interface WorkspaceInstanceStatus {
+    // version is the current version of the workspace instance status
+    // Note: consider this value opague. The only guarantee given is that it imposes
+    //       a partial order on status updates, i.e. a.version > b.version -> a newer than b.
+    version?: number;
+
     // phase describes a high-level state of the workspace instance
     phase: WorkspaceInstancePhase;
 
@@ -98,9 +115,13 @@ export type WorkspaceInstancePhase =
     | "unknown"
 
     // Preparing means that we haven't actually started the workspace instance just yet, but rather
-    // are still preparing for launch. This means we're building the Docker image for the workspace.
+    // are still preparing for launch.
     | "preparing"
 
+    // Building means that we are building the Docker image for the workspace. A workspace will enter this phase only
+    // if an image build is required for that workspace.
+    | "building"
+
     // Pending means the workspace does not yet consume resources in the cluster, but rather is looking for
     // some space within the cluster. If for example the cluster needs to scale up to accomodate the
     // workspace, the workspace will be in Pending state until that happened.
@@ -225,6 +246,9 @@ export interface WorkspaceInstanceConfiguration {
     // desktopIdeImage is the ref of the desktop IDE image this instance uses.
     desktopIdeImage?: string;
 
+    // desktopIdePluginImage is the ref of the desktop IDE plugin image this instance uses.
+    desktopIdePluginImage?: string;
+
     // supervisorImage is the ref of the supervisor image this instance uses.
     supervisorImage?: string;
 

package/src/wsready.ts

@@ -1,10 +1,10 @@
 /**
  * Copyright (c) 2022 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.
  */
 
-// generated using github.com/32leaves/bel on 2022-03-29 17:08:06.113873917 +0000 UTC m=+0.010035965
+// generated using github.com/32leaves/bel on 2022-10-10 21:41:56.018177383 +0000 UTC m=+0.010324839
 // DO NOT MODIFY
 
 export enum WorkspaceInitSource {

package/lib/email-protocol.d.ts

@@ -1,49 +0,0 @@
-/**
- * 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.
- */
-export declare type EMailState = "scheduledInternal" | "scheduledSendgrid";
-export interface EMailStatus {
-    /** The time the email entry was inserted into the DB */
-    scheduledInternalTime: string;
-    /** The time the email state transitioned to "scheduledSendgrid" */
-    scheduledSendgridTime?: string;
-    /** In case of any errors during sending with Sendgrid it gets noted here */
-    error?: string;
-}
-export declare namespace EMailStatus {
-    function getState(status: EMailStatus): EMailState;
-}
-export interface EmailAddress {
-    name?: string;
-    email: string;
-}
-export interface EMailParameters {
-    /** undefined means default from template */
-    subject?: string;
-    /** The sender address */
-    senderAddress: string | EmailAddress;
-    /** The replyTo address */
-    replyToAddress?: string | EmailAddress;
-    /** The SendGrid template id */
-    templateId: string;
-    /** The parameters for the SendGrid template */
-    templateParams: {};
-}
-export declare type EMail = {
-    /** The unique id of this email (uuid/v4 for now) */
-    uid: string;
-    /** The id of the user this email was sent to */
-    userId: string;
-    /** The address this email was sent to */
-    recipientAddress: string;
-    /** Which campaign scheduled this email  */
-    campaignId: string;
-    /** The parameters this email was sent with (template id, template params, etc) */
-    params: EMailParameters;
-} & EMailStatus;
-export declare namespace EMail {
-    const create: (ts: Omit<EMail, "uid">) => EMail;
-}
-//# sourceMappingURL=email-protocol.d.ts.map

package/lib/email-protocol.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"email-protocol.d.ts","sourceRoot":"","sources":["../src/email-protocol.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,oBAAY,UAAU,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAEnE,MAAM,WAAW,WAAW;IACxB,wDAAwD;IACxD,qBAAqB,EAAE,MAAM,CAAC;IAC9B,mEAAmE;IACnE,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,4EAA4E;IAC5E,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AACD,yBAAiB,WAAW,CAAC;IACzB,SAAgB,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,UAAU,CAKxD;CACJ;AAED,MAAM,WAAW,YAAY;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC5B,4CAA4C;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,aAAa,EAAE,MAAM,GAAG,YAAY,CAAC;IACrC,0BAA0B;IAC1B,cAAc,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;IACvC,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,cAAc,EAAE,EAAE,CAAC;CACtB;AAED,oBAAY,KAAK,GAAG;IAChB,oDAAoD;IACpD,GAAG,EAAE,MAAM,CAAC;IACZ,gDAAgD;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,gBAAgB,EAAE,MAAM,CAAC;IACzB,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,kFAAkF;IAClF,MAAM,EAAE,eAAe,CAAC;CAC3B,GAAG,WAAW,CAAC;AAEhB,yBAAiB,KAAK,CAAC;IACZ,MAAM,MAAM,OAAQ,KAAK,KAAK,EAAE,KAAK,CAAC,KAAG,KAI/C,CAAC;CACL"}

package/lib/email-protocol.js

@@ -1,28 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EMail = exports.EMailStatus = void 0;
-const uuid_1 = require("uuid");
-var EMailStatus;
-(function (EMailStatus) {
-    function getState(status) {
-        if (status.scheduledSendgridTime) {
-            return "scheduledSendgrid";
-        }
-        return "scheduledInternal";
-    }
-    EMailStatus.getState = getState;
-})(EMailStatus = exports.EMailStatus || (exports.EMailStatus = {}));
-var EMail;
-(function (EMail) {
-    EMail.create = (ts) => {
-        const withId = ts;
-        withId.uid = (0, uuid_1.v4)();
-        return withId;
-    };
-})(EMail = exports.EMail || (exports.EMail = {}));
-//# sourceMappingURL=email-protocol.js.map

package/lib/email-protocol.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"email-protocol.js","sourceRoot":"","sources":["../src/email-protocol.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,+BAAoC;AAYpC,IAAiB,WAAW,CAO3B;AAPD,WAAiB,WAAW;IACxB,SAAgB,QAAQ,CAAC,MAAmB;QACxC,IAAI,MAAM,CAAC,qBAAqB,EAAE;YAC9B,OAAO,mBAAmB,CAAC;SAC9B;QACD,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IALe,oBAAQ,WAKvB,CAAA;AACL,CAAC,EAPgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAO3B;AAiCD,IAAiB,KAAK,CAMrB;AAND,WAAiB,KAAK;IACL,YAAM,GAAG,CAAC,EAAsB,EAAS,EAAE;QACpD,MAAM,MAAM,GAAG,EAAW,CAAC;QAC3B,MAAM,CAAC,GAAG,GAAG,IAAA,SAAM,GAAE,CAAC;QACtB,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC;AACN,CAAC,EANgB,KAAK,GAAL,aAAK,KAAL,aAAK,QAMrB"}

package/src/email-protocol.ts

@@ -1,65 +0,0 @@
-/**
- * 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.
- */
-
-import { v4 as uuidv4 } from "uuid";
-
-export type EMailState = "scheduledInternal" | "scheduledSendgrid";
-
-export interface EMailStatus {
-    /** The time the email entry was inserted into the DB */
-    scheduledInternalTime: string;
-    /** The time the email state transitioned to "scheduledSendgrid" */
-    scheduledSendgridTime?: string;
-    /** In case of any errors during sending with Sendgrid it gets noted here */
-    error?: string;
-}
-export namespace EMailStatus {
-    export function getState(status: EMailStatus): EMailState {
-        if (status.scheduledSendgridTime) {
-            return "scheduledSendgrid";
-        }
-        return "scheduledInternal";
-    }
-}
-
-export interface EmailAddress {
-    name?: string;
-    email: string;
-}
-
-export interface EMailParameters {
-    /** undefined means default from template */
-    subject?: string;
-    /** The sender address */
-    senderAddress: string | EmailAddress;
-    /** The replyTo address */
-    replyToAddress?: string | EmailAddress;
-    /** The SendGrid template id */
-    templateId: string;
-    /** The parameters for the SendGrid template */
-    templateParams: {};
-}
-
-export type EMail = {
-    /** The unique id of this email (uuid/v4 for now) */
-    uid: string;
-    /** The id of the user this email was sent to */
-    userId: string;
-    /** The address this email was sent to */
-    recipientAddress: string;
-    /** Which campaign scheduled this email  */
-    campaignId: string;
-    /** The parameters this email was sent with (template id, template params, etc) */
-    params: EMailParameters;
-} & EMailStatus;
-
-export namespace EMail {
-    export const create = (ts: Omit<EMail, "uid">): EMail => {
-        const withId = ts as EMail;
-        withId.uid = uuidv4();
-        return withId;
-    };
-}