@gitpod/gitpod-protocol 0.1.5-mp-content-service-gen.0 → 0.1.5-mp-server-errors.4

package/src/protocol.ts

@@ -8,6 +8,7 @@ import { WorkspaceInstance, PortVisibility } from "./workspace-instance";
 import { RoleOrPermission } from "./permission";
 import { Project } from "./teams-projects-protocol";
 import { createHash } from "crypto";
+import { AttributionId } from "./attribution";
 
 export interface UserInfo {
     name?: string;
@@ -152,12 +153,21 @@ export namespace User {
         user.additionalData.ideSettings = newIDESettings;
     }
 
+    // TODO: make it more explicit that these field names are relied for our tracking purposes
+    // and decouple frontend from relying on them - instead use user.additionalData.profile object directly in FE
     export function getProfile(user: User): Profile {
         return {
             name: User.getName(user!) || "",
             email: User.getPrimaryEmail(user!) || "",
             company: user?.additionalData?.profile?.companyName,
             avatarURL: user?.avatarUrl,
+            companyWebsite: user?.additionalData?.profile?.companyWebsite,
+            jobRole: user?.additionalData?.profile?.jobRole,
+            jobRoleOther: user?.additionalData?.profile?.jobRoleOther,
+            explorationReasons: user?.additionalData?.profile?.explorationReasons,
+            signupGoals: user?.additionalData?.profile?.signupGoals,
+            signupGoalsOther: user?.additionalData?.profile?.signupGoalsOther,
+            onboardedTimestamp: user?.additionalData?.profile?.onboardedTimestamp,
         };
     }
 
@@ -178,12 +188,32 @@ export namespace User {
         return user;
     }
 
+    export function getDefaultAttributionId(user: User): AttributionId {
+        if (user.usageAttributionId) {
+            const result = AttributionId.parse(user.usageAttributionId);
+            if (!result) {
+                throw new Error("Invalid attribution ID: " + user.usageAttributionId);
+            }
+            return result;
+        }
+        return AttributionId.create(user);
+    }
+
+    // TODO: refactor where this is referenced so it's more clearly tied to just analytics-tracking
+    // Let other places rely on the ProfileDetails type since that's what we store
     // The actual Profile of a User
     export interface Profile {
         name: string;
         email: string;
         company?: string;
         avatarURL?: string;
+        companyWebsite?: string;
+        jobRole?: string;
+        jobRoleOther?: string;
+        explorationReasons?: string[];
+        signupGoals?: string[];
+        signupGoalsOther?: string;
+        onboardedTimestamp?: string;
     }
     export namespace Profile {
         export function hasChanges(before: Profile, after: Profile) {
@@ -191,7 +221,13 @@ export namespace User {
                 before.name !== after.name ||
                 before.email !== after.email ||
                 before.company !== after.company ||
-                before.avatarURL !== after.avatarURL
+                before.avatarURL !== after.avatarURL ||
+                before.companyWebsite !== after.companyWebsite ||
+                before.jobRole !== after.jobRole ||
+                before.jobRoleOther !== after.jobRoleOther ||
+                // not checking explorationReasons or signupGoals atm as it's an array - need to check deep equality
+                before.signupGoalsOther !== after.signupGoalsOther ||
+                before.onboardedTimestamp !== after.onboardedTimestamp
             );
         }
     }
@@ -242,6 +278,20 @@ export interface ProfileDetails {
     companyName?: string;
     // the user's email
     emailAddress?: string;
+    // the user's company website
+    companyWebsite?: string;
+    // type of role user has in their job
+    jobRole?: string;
+    // freeform entry for job role user works in (when jobRole is "other")
+    jobRoleOther?: string;
+    // Reasons user is exploring Gitpod when they signed up
+    explorationReasons?: string[];
+    // what user hopes to accomplish when they signed up
+    signupGoals?: string[];
+    // freeform entry for signup goals (when signupGoals is "other")
+    signupGoalsOther?: string;
+    // Set after a user completes the onboarding flow
+    onboardedTimestamp?: string;
 }
 
 export interface EmailNotificationSettings {
@@ -311,6 +361,8 @@ export namespace NamedWorkspaceFeatureFlag {
     }
 }
 
+export type EnvVar = UserEnvVar | ProjectEnvVarWithValue | EnvVarWithValue;
+
 export interface EnvVarWithValue {
     name: string;
     value: string;
@@ -830,6 +882,7 @@ export interface WorkspaceConfig {
     vscode?: VSCodeConfig;
     jetbrains?: JetBrainsConfig;
     coreDump?: CoreDumpConfig;
+    ideCredentials?: string;
 
     /** deprecated. Enabled by default **/
     experimentalNetwork?: boolean;
@@ -1404,6 +1457,7 @@ export interface AuthProviderInfo {
     readonly authProviderType: string;
     readonly host: string;
     readonly ownerId?: string;
+    readonly organizationId?: string;
     readonly verified: boolean;
     readonly isReadonly?: boolean;
     readonly hiddenOnDashboard?: boolean;

package/src/typings/globals.ts

@@ -11,5 +11,9 @@ interface Window {
         loggedUserID?: string;
 
         openDesktopIDE(url: string): void;
+
+        encrypt(content: string): string;
+        decrypt(content: string): string;
+        isEncryptedData(content: string): boolean;
     };
 }