@gitpod/gitpod-protocol 0.1.5-pd-ide-service.13 → 0.1.5-pd-add-grpc-sec.0

package/src/experiments/types.ts

@@ -4,8 +4,7 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import { User } from "../protocol";
-import { Team } from "../teams-projects-protocol";
+import { BillingTier, User } from "../protocol";
 
 export const Client = Symbol("Client");
 
@@ -15,6 +14,9 @@ export interface Attributes {
     // user.id is mapped to ConfigCat's "identifier" + "custom.user_id"
     user?: User | { id: string; email?: string };
 
+    // The BillingTier of this particular user
+    billingTier?: BillingTier;
+
     // Currently selected Gitpod Project ID (mapped to "custom.project_id")
     projectId?: string;
 
@@ -22,9 +24,6 @@ export interface Attributes {
     teamId?: string;
     // Currently selected Gitpod Team Name (mapped to "custom.team_name")
     teamName?: string;
-
-    // All the Gitpod Teams that the user is a member (or owner) of (mapped to "custom.team_names" and "custom.team_ids")
-    teams?: Team[];
 }
 
 export interface Client {

package/src/gitpod-service.ts

@@ -12,7 +12,6 @@ import {
     WhitelistedRepository,
     WorkspaceImageBuild,
     AuthProviderInfo,
-    CreateWorkspaceMode,
     Token,
     UserEnvVarValue,
     Terms,
@@ -59,8 +58,7 @@ import {
 } from "./team-subscription-protocol";
 import { RemotePageMessage, RemoteTrackMessage, RemoteIdentifyMessage } from "./analytics";
 import { IDEServer } from "./ide-protocol";
-import { InstallationAdminSettings, TelemetryData } from "./installation-admin-protocol";
-import { ListUsageRequest, ListUsageResponse } from "./usage";
+import { ListUsageRequest, ListUsageResponse, CostCenterJSON } from "./usage";
 import { SupportedWorkspaceClass } from "./workspace-class";
 import { BillingMode } from "./billing-mode";
 
@@ -165,6 +163,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     deleteSSHPublicKey(id: string): Promise<void>;
 
     // Teams
+    getTeam(teamId: string): Promise<Team>;
     getTeams(): Promise<Team[]>;
     getTeamMembers(teamId: string): Promise<TeamMemberInfo[]>;
     createTeam(name: string): Promise<Team>;
@@ -173,12 +172,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     removeTeamMember(teamId: string, userId: string): Promise<void>;
     getGenericInvite(teamId: string): Promise<TeamMembershipInvite>;
     resetGenericInvite(inviteId: string): Promise<TeamMembershipInvite>;
-    deleteTeam(teamId: string, userId: string): Promise<void>;
-
-    // Admin Settings
-    adminGetSettings(): Promise<InstallationAdminSettings>;
-    adminUpdateSettings(settings: InstallationAdminSettings): Promise<void>;
-    adminGetTelemetryData(): Promise<TelemetryData>;
+    deleteTeam(teamId: string): Promise<void>;
 
     // Projects
     getProviderRepositoriesForUser(params: GetProviderRepositoriesParams): Promise<ProviderRepository[]>;
@@ -227,16 +221,6 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
      */
     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>;
-
     guessGitTokenScopes(params: GuessGitTokenScopesParams): Promise<GuessedGitTokenScopes>;
 
     /**
@@ -288,14 +272,16 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     getStripeSetupIntentClientSecret(): Promise<string>;
     findStripeSubscriptionId(attributionId: string): Promise<string | undefined>;
     createStripeCustomerIfNeeded(attributionId: string, currency: string): Promise<void>;
-    subscribeToStripe(attributionId: string, setupIntentId: string): Promise<void>;
+    subscribeToStripe(attributionId: string, setupIntentId: string, usageLimit: number): Promise<number | undefined>;
     getStripePortalUrl(attributionId: string): Promise<string>;
-    getUsageLimit(attributionId: string): Promise<number | undefined>;
+    getCostCenter(attributionId: string): Promise<CostCenterJSON | undefined>;
     setUsageLimit(attributionId: string, usageLimit: number): Promise<void>;
+    getUsageBalance(attributionId: string): Promise<number>;
 
     listUsage(req: ListUsageRequest): Promise<ListUsageResponse>;
 
     setUsageAttribution(usageAttribution: string): Promise<void>;
+    listAvailableUsageAttributionIds(): Promise<string[]>;
 
     getBillingModeForUser(): Promise<BillingMode>;
     getBillingModeForTeam(teamId: string): Promise<BillingMode>;
@@ -430,7 +416,10 @@ export namespace GitpodServer {
     }
     export interface CreateWorkspaceOptions {
         contextUrl: string;
-        mode?: CreateWorkspaceMode;
+        // whether running workspaces on the same context should be ignored. If false (default) users will be asked.
+        ignoreRunningWorkspaceOnSameCommit?: boolean;
+        ignoreRunningPrebuild?: boolean;
+        allowUsingPreviousPrebuilds?: boolean;
         forceDefaultConfig?: boolean;
     }
     export interface StartWorkspaceOptions {
@@ -438,7 +427,6 @@ export namespace GitpodServer {
     }
     export interface TakeSnapshotOptions {
         workspaceId: string;
-        layoutData?: string;
         /* this is here to enable backwards-compatibility and untangling rollout between workspace, IDE and meta */
         dontWait?: boolean;
     }

package/src/ide-protocol.ts

@@ -87,7 +87,7 @@ export interface IDEOption {
     label?: string;
 
     /**
-     * Notes to the IDE option that are renderd in the preferences when a user
+     * Notes to the IDE option that are rendered in the preferences when a user
      * chooses this IDE.
      */
     notes?: string[];
@@ -126,4 +126,14 @@ export interface IDEOption {
      * The latest plugin image ref for the latest IDE image, this image ref always resolve to digest.
      */
     pluginLatestImage?: string;
+
+    /**
+     * ImageVersion the semantic version of the IDE image.
+     */
+    imageVersion?: string;
+
+    /**
+     * LatestImageVersion the semantic version of the latest IDE image.
+     */
+    latestImageVersion?: string;
 }

package/src/index.ts

@@ -13,7 +13,6 @@ export * from "./license-protocol";
 export * from "./workspace-instance";
 export * from "./permission";
 export * from "./admin-protocol";
-export * from "./email-protocol";
 export * from "./headless-workspace-log";
 export * from "./context-url";
 export * from "./teams-projects-protocol";

package/src/messaging/client-call-metrics.ts

@@ -14,6 +14,7 @@ export class PrometheusClientCallMetrics implements IClientCallMetrics {
     readonly sentCounter: prometheusClient.Counter<string>;
     readonly receivedCounter: prometheusClient.Counter<string>;
     readonly handledCounter: prometheusClient.Counter<string>;
+    readonly handledSecondsHistogram: prometheusClient.Histogram<string>;
 
     constructor() {
         this.startedCounter = new prometheusClient.Counter({
@@ -40,6 +41,12 @@ export class PrometheusClientCallMetrics implements IClientCallMetrics {
             labelNames: ["grpc_service", "grpc_method", "grpc_type", "grpc_code"],
             registers: [prometheusClient.register],
         });
+        this.handledSecondsHistogram = new prometheusClient.Histogram({
+            name: "grpc_client_handling_seconds",
+            help: "Histogram of response latency (seconds) of the gRPC until it is finished by the application.",
+            labelNames: ["grpc_service", "grpc_method", "grpc_type", "grpc_code"],
+            registers: [prometheusClient.register],
+        });
     }
 
     started(labels: IGrpcCallMetricsLabels): void {
@@ -74,4 +81,14 @@ export class PrometheusClientCallMetrics implements IClientCallMetrics {
             grpc_code: labels.code,
         });
     }
+
+    startHandleTimer(
+        labels: IGrpcCallMetricsLabelsWithCode,
+    ): (labels?: Partial<Record<string, string | number>> | undefined) => number {
+        return this.handledSecondsHistogram.startTimer({
+            grpc_service: labels.service,
+            grpc_method: labels.method,
+            grpc_type: labels.type,
+        });
+    }
 }

package/src/messaging/error.ts

@@ -35,12 +35,18 @@ export namespace ErrorCodes {
     // 430 Repository not whitelisted (custom status code)
     export const REPOSITORY_NOT_WHITELISTED = 430;
 
+    // 440 Prebuilds now always require a project (custom status code)
+    export const PROJECT_REQUIRED = 440;
+
     // 450 Payment error
     export const PAYMENT_ERROR = 450;
 
     // 451 Out of credits
     export const PAYMENT_SPENDING_LIMIT_REACHED = 451;
 
+    // 451 Error creating a subscription
+    export const SUBSCRIPTION_ERROR = 452;
+
     // 455 Invalid cost center (custom status code)
     export const INVALID_COST_CENTER = 455;
 

package/src/plans.ts

@@ -131,7 +131,7 @@ export namespace Plans {
         githubPlanNumber: 1,
 
         type: "free",
-        name: "Open Source",
+        name: "Free",
         currency: "USD",
         pricePerMonth: 0,
         hoursPerMonth: 100,
@@ -146,7 +146,7 @@ export namespace Plans {
         githubPlanNumber: 5,
 
         type: "free-50",
-        name: "Open Source",
+        name: "Free",
         currency: "USD",
         pricePerMonth: 0,
         hoursPerMonth: 50,

package/src/protocol.ts

@@ -8,7 +8,6 @@ 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;
@@ -286,23 +285,21 @@ export interface UserFeatureSettings {
     permanentWSFeatureFlags?: NamedWorkspaceFeatureFlag[];
 }
 
+export 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 const WorkspaceFeatureFlags = {
     full_workspace_backup: undefined,
-    persistent_volume_claim: undefined,
-    protected_secrets: undefined,
     workspace_class_limiting: undefined,
     workspace_connection_limiting: undefined,
+    workspace_psi: undefined,
 };
 export type NamedWorkspaceFeatureFlag = keyof typeof WorkspaceFeatureFlags;
 export namespace NamedWorkspaceFeatureFlag {
-    export const WORKSPACE_PERSISTED_FEATTURE_FLAGS: NamedWorkspaceFeatureFlag[] = [
-        "full_workspace_backup",
-        "persistent_volume_claim",
-    ];
+    export const WORKSPACE_PERSISTED_FEATTURE_FLAGS: NamedWorkspaceFeatureFlag[] = ["full_workspace_backup"];
     export function isWorkspacePersisted(ff: NamedWorkspaceFeatureFlag): boolean {
         return WORKSPACE_PERSISTED_FEATTURE_FLAGS.includes(ff);
     }
@@ -469,7 +466,7 @@ export interface UserSSHPublicKey extends SSHPublicKeyValue {
     lastUsedTime?: string;
 }
 
-export type UserSSHPublicKeyValue = Omit<UserSSHPublicKey, "key" | "userId">;
+export type UserSSHPublicKeyValue = Omit<UserSSHPublicKey, "userId">;
 
 export namespace SSHPublicKeyValue {
     export function validate(value: SSHPublicKeyValue): string | undefined {
@@ -637,6 +634,7 @@ export interface PendingGithubEvent {
     creationDate: Date;
     type: string;
     event: string;
+    deleted: boolean;
 }
 
 export interface Snapshot {
@@ -645,26 +643,12 @@ export interface Snapshot {
     availableTime?: string;
     originalWorkspaceId: string;
     bucketId: string;
-    layoutData?: string;
     state: SnapshotState;
     message?: string;
 }
 
-export interface VolumeSnapshot {
-    id: string;
-    workspaceId: string;
-    creationTime: string;
-    volumeHandle: string;
-}
-
 export type SnapshotState = "pending" | "available" | "error";
 
-export interface LayoutData {
-    workspaceId: string;
-    lastUpdatedTime: string;
-    layoutData: string;
-}
-
 export interface Workspace {
     id: string;
     creationTime: string;
@@ -726,7 +710,7 @@ export interface Workspace {
 
 export type WorkspaceSoftDeletion = "user" | "gc";
 
-export type WorkspaceType = "regular" | "prebuild" | "probe"; // TODO(gpl) Removed prove here
+export type WorkspaceType = "regular" | "prebuild";
 
 export namespace Workspace {
     export function getFullRepositoryName(ws: Workspace): string | undefined {
@@ -799,6 +783,10 @@ export interface JetBrainsConfig {
     goland?: JetBrainsProductConfig;
     pycharm?: JetBrainsProductConfig;
     phpstorm?: JetBrainsProductConfig;
+    rubymine?: JetBrainsProductConfig;
+    webstorm?: JetBrainsProductConfig;
+    rider?: JetBrainsProductConfig;
+    clion?: JetBrainsProductConfig;
 }
 export interface JetBrainsProductConfig {
     prebuilds?: JetBrainsPrebuilds;
@@ -815,8 +803,8 @@ export interface RepositoryCloneInformation {
 
 export interface CoreDumpConfig {
     enabled?: boolean;
-	softLimit?: number;
-	hardLimit?: number;
+    softLimit?: number;
+    hardLimit?: number;
 }
 
 export interface WorkspaceConfig {
@@ -1113,14 +1101,17 @@ export namespace SnapshotContext {
     }
 }
 
-export interface StartPrebuildContext extends WorkspaceContext {
-    actual: WorkspaceContext;
+export interface WithCommitHistory {
     commitHistory?: string[];
     additionalRepositoryCommitHistories?: {
         cloneUrl: string;
         commitHistory: string[];
     }[];
-    project?: Project;
+}
+
+export interface StartPrebuildContext extends WorkspaceContext, WithCommitHistory {
+    actual: WorkspaceContext;
+    project: Project;
     branch?: string;
 }
 
@@ -1163,17 +1154,6 @@ export namespace WithEnvvarsContext {
     }
 }
 
-export interface WorkspaceProbeContext extends WorkspaceContext {
-    responseURL: string;
-    responseToken: string;
-}
-
-export namespace WorkspaceProbeContext {
-    export function is(context: any): context is WorkspaceProbeContext {
-        return context && "responseURL" in context && "responseToken" in context;
-    }
-}
-
 export type RefType = "branch" | "tag" | "revision";
 export namespace RefType {
     export const getRefType = (commit: Commit): RefType => {
@@ -1213,6 +1193,16 @@ export namespace AdditionalContentContext {
     }
 }
 
+export interface OpenPrebuildContext extends WorkspaceContext {
+    openPrebuildID: string;
+}
+
+export namespace OpenPrebuildContext {
+    export function is(ctx: any): ctx is OpenPrebuildContext {
+        return "openPrebuildID" in ctx;
+    }
+}
+
 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;
@@ -1376,17 +1366,6 @@ export interface WorkspaceCreationResult {
 }
 export type RunningWorkspacePrebuildStarting = "queued" | "starting" | "running";
 
-export enum CreateWorkspaceMode {
-    // Default returns a running prebuild if there is any, otherwise creates a new workspace (using a prebuild if one is available)
-    Default = "default",
-    // ForceNew creates a new workspace irrespective of any running prebuilds. This mode is guaranteed to actually create a workspace - but may degrade user experience as currently runnig prebuilds are ignored.
-    ForceNew = "force-new",
-    // UsePrebuild polls the database waiting for a currently running prebuild to become available. This mode exists to handle the db-sync delay.
-    UsePrebuild = "use-prebuild",
-    // SelectIfRunning returns a list of currently running workspaces for the context URL if there are any, otherwise falls back to Default mode
-    SelectIfRunning = "select-if-running",
-}
-
 export namespace WorkspaceCreationResult {
     export function is(data: any): data is WorkspaceCreationResult {
         return (
@@ -1520,12 +1499,7 @@ export interface Terms {
     readonly formElements?: object;
 }
 
-export type BillingStrategy = "other" | "stripe";
-export interface CostCenter {
-    readonly id: AttributionId;
-    /**
-     * Unit: credits
-     */
-    spendingLimit: number;
-    billingStrategy: BillingStrategy;
+export interface StripeConfig {
+    individualUsagePriceIds: { [currency: string]: string };
+    teamUsagePriceIds: { [currency: string]: string };
 }

package/src/teams-projects-protocol.ts

@@ -4,7 +4,7 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import { PrebuiltWorkspaceState } from "./protocol";
+import { PrebuiltWorkspaceState, WorkspaceClasses } from "./protocol";
 import { v4 as uuidv4 } from "uuid";
 import { DeepPartial } from "./util/deep-partial";
 import { WebhookEvent } from "./webhook-event";
@@ -15,8 +15,13 @@ export interface ProjectConfig {
 
 export interface ProjectSettings {
     useIncrementalPrebuilds?: boolean;
-    usePersistentVolumeClaim?: boolean;
     keepOutdatedPrebuildsRunning?: boolean;
+    // whether new workspaces can start on older prebuilds and incrementally update
+    allowUsingPreviousPrebuilds?: boolean;
+    // how many commits in the commit history a prebuild is good (undefined and 0 means every commit is prebuilt)
+    prebuildEveryNthCommit?: number;
+    // preferred workspace classes
+    workspaceClasses?: WorkspaceClasses;
 }
 
 export interface Project {
@@ -45,6 +50,7 @@ export namespace Project {
 
     export interface Overview {
         branches: BranchDetails[];
+        isConsideredInactive?: boolean;
     }
 
     export namespace Overview {
@@ -119,7 +125,6 @@ export interface StartPrebuildResult {
     wsid: string;
     done: boolean;
 }
-
 export interface Team {
     id: string;
     name: string;

package/src/usage.ts

@@ -69,3 +69,17 @@ export interface InvoiceUsageData {
     startDate: string;
     endDate: string;
 }
+
+export interface CostCenterJSON {
+    attributionId: string;
+    spendingLimit: number;
+    billingStrategy: CostCenter_BillingStrategy;
+    nextBillingTime?: string;
+    billingCycleStart?: string;
+}
+
+export enum CostCenter_BillingStrategy {
+    BILLING_STRATEGY_STRIPE = "BILLING_STRATEGY_STRIPE",
+    BILLING_STRATEGY_OTHER = "BILLING_STRATEGY_OTHER",
+    UNRECOGNIZED = "UNRECOGNIZED",
+}

package/src/util/grpc.ts

@@ -36,6 +36,9 @@ export interface IClientCallMetrics {
     sent(labels: IGrpcCallMetricsLabels): void;
     received(labels: IGrpcCallMetricsLabels): void;
     handled(labels: IGrpcCallMetricsLabelsWithCode): void;
+    startHandleTimer(
+        labels: IGrpcCallMetricsLabels,
+    ): (labels?: Partial<Record<string, string | number>> | undefined) => number;
 }
 
 export function getGrpcMethodType(requestStream: boolean, responseStream: boolean): GrpcMethodType {

package/src/util/nice-grpc.ts

@@ -49,6 +49,8 @@ export function prometheusClientMiddleware(metrics: IClientCallMetrics): ClientM
 
         metrics.started(labels);
 
+        const stopTimer = metrics.startHandleTimer(labels);
+
         let settled = false;
         let status: Status = Status.OK;
 
@@ -87,6 +89,7 @@ export function prometheusClientMiddleware(metrics: IClientCallMetrics): ClientM
             if (!settled) {
                 status = Status.CANCELLED;
             }
+            stopTimer({ grpc_code: Status[status] });
             metrics.handled({ ...labels, code: Status[status] });
         }
     };

package/src/workspace-class.ts

@@ -10,5 +10,5 @@ export interface SupportedWorkspaceClass {
     displayName: string;
     description: string;
     powerups: number;
-    isSelected: boolean;
+    isDefault: boolean;
 }

package/src/workspace-cluster.ts

@@ -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;
 
@@ -86,20 +90,21 @@ export interface WorkspaceClusterDB {
      * Deletes the cluster identified by this name, if any.
      * @param name
      */
-    deleteByName(name: string): Promise<void>;
+    deleteByName(name: string, applicationCluster: string): Promise<void>;
 
     /**
      * Finds a WorkspaceCluster with the given name. If there is none, `undefined` is returned.
      * @param name
      */
-    findByName(name: string): Promise<WorkspaceCluster | undefined>;
+    findByName(name: string, applicationCluster: string): Promise<WorkspaceCluster | undefined>;
 
     /**
      * Lists all WorkspaceClusterWoTls for which the given predicate is true (does not return TLS for size/speed concerns)
      * @param predicate
      */
-    findFiltered(predicate: DeepPartial<WorkspaceClusterFilter>): Promise<WorkspaceClusterWoTLS[]>;
-}
-export interface WorkspaceClusterFilter extends Pick<WorkspaceCluster, "state" | "govern" | "url"> {
-    minScore: number;
+    findFiltered(predicate: WorkspaceClusterFilter): Promise<WorkspaceClusterWoTLS[]>;
 }
+
+export type WorkspaceClusterFilter = Pick<WorkspaceCluster, "applicationCluster"> &
+    DeepPartial<Pick<WorkspaceCluster, "name" | "state" | "govern" | "url">> &
+    Partial<{ minScore: number }>;

package/src/workspace-instance.ts

@@ -243,10 +243,16 @@ export interface WorkspaceInstanceConfiguration {
     // ideImage is the ref of the IDE image this instance uses.
     ideImage: string;
 
+    // ideImageLayers are images needed for the ide to run,
+    // including ide-desktop, desktop-plugin and so on
+    ideImageLayers?: string[];
+
     // desktopIdeImage is the ref of the desktop IDE image this instance uses.
+    // @deprected: replaced with the ideImageLayers field
     desktopIdeImage?: string;
 
     // desktopIdePluginImage is the ref of the desktop IDE plugin image this instance uses.
+    // @deprected: replaced with the desktopIdePluginImage field
     desktopIdePluginImage?: string;
 
     // supervisorImage is the ref of the supervisor image this instance uses.

package/src/wsready.ts

@@ -4,15 +4,21 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-// generated using github.com/32leaves/bel on 2022-07-21 07:41:48.081573085 +0000 UTC m=+0.009109470
+// generated using github.com/32leaves/bel on 2022-11-25 13:39:08.995865257 +0000 UTC m=+0.015035221
 // DO NOT MODIFY
 
-export interface WorkspaceReadyMessage {
-    source: WorkspaceInitSource;
-}
-
 export enum WorkspaceInitSource {
     WorkspaceInitFromBackup = "from-backup",
     WorkspaceInitFromPrebuild = "from-prebuild",
     WorkspaceInitFromOther = "from-other",
 }
+export interface WorkspaceReadyMessage {
+    source: WorkspaceInitSource;
+    metrics: InitializerMetric[];
+}
+
+export interface InitializerMetric {
+    type: string;
+    duration: number;
+    size: number;
+}

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"}