@gitpod/gitpod-protocol 0.1.5-sh-jupyter.0 → 0.1.5-siddhant-k-code-allow-github-prebuilds-10358.2

package/data/gitpod-schema.json

@@ -1,25 +1,15 @@
 {
-    "$id": "https://gitpod.io/gitpod.schema.json",
+    "$id": "https://gitpod.io/schemas/gitpod-schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "title": "Gitpod Config",
     "type": "object",
     "properties": {
-        "ide": {
-            "type": "string",
-            "enum": [
-                "theia",
-                "code"
-            ],
-            "default": "theia"
-        },
         "ports": {
             "type": "array",
             "description": "List of exposed ports.",
             "items": {
                 "type": "object",
-                "required": [
-                    "port"
-                ],
+                "required": ["port"],
                 "properties": {
                     "port": {
                         "type": ["number", "string"],
@@ -28,36 +18,28 @@
                     },
                     "onOpen": {
                         "type": "string",
-                        "enum": [
-                            "open-browser",
-                            "open-preview",
-                            "notify",
-                            "ignore"
-                        ],
+                        "enum": ["open-browser", "open-preview", "notify", "ignore"],
                         "description": "What to do when a service on this port was detected. 'notify' (default) will show a notification asking the user what to do. 'open-browser' will open a new browser tab. 'open-preview' will open in the preview on the right of the IDE. 'ignore' will do nothing."
                     },
                     "visibility": {
                         "type": "string",
-                        "enum": [
-                            "private",
-                            "public"
-                        ],
-                        "description": "Whether the port visibility should be private or public. 'public' (default) will allow everyone with the port URL to access the port. 'private' will only allow users with workspace access to access the port."
+                        "enum": ["private", "public"],
+                        "default": "private",
+                        "description": "Whether the port visibility should be private or public. 'private' (default) will only allow users with workspace access to access the port. 'public' will allow everyone with the port URL to access the port."
                     },
                     "name": {
                         "type": "string",
-                        "deprecationMessage": "The 'name' property is deprecated.",
-                        "description": "Port name (deprecated)."
+                        "description": "Port name."
                     },
                     "protocol": {
                         "type": "string",
-                        "enum": [
-                            "http",
-                            "TCP",
-                            "UDP"
-                        ],
+                        "enum": ["http", "TCP", "UDP"],
                         "deprecationMessage": "The 'protocol' property is deprecated.",
                         "description": "The protocol to be used. (deprecated)"
+                    },
+                    "description": {
+                        "type": "string",
+                        "description": "A description to identify what is this port used for."
                     }
                 },
                 "additionalProperties": false
@@ -83,7 +65,8 @@
                     },
                     "prebuild": {
                         "type": "string",
-                        "description": "A shell command to run after `before`. This command is executed only on during workspace prebuilds. This command is expected to terminate. If it fails, the workspace build fails."
+                        "description": "A shell command to run after `before`. This command is executed only on during workspace prebuilds. This command is expected to terminate. If it fails, the workspace build fails.",
+                        "deprecationMessage": "Deprecated. Please use `init` task instead. See https://www.gitpod.io/docs/config-start-tasks."
                     },
                     "command": {
                         "type": "string",
@@ -95,24 +78,12 @@
                     },
                     "openIn": {
                         "type": "string",
-                        "enum": [
-                            "bottom",
-                            "main",
-                            "left",
-                            "right"
-                        ],
+                        "enum": ["bottom", "main", "left", "right"],
                         "description": "The panel/area where to open the terminal. Default is 'bottom' panel."
                     },
                     "openMode": {
                         "type": "string",
-                        "enum": [
-                            "split-top",
-                            "split-left",
-                            "split-right",
-                            "split-bottom",
-                            "tab-before",
-                            "tab-after"
-                        ],
+                        "enum": ["split-left", "split-right", "tab-before", "tab-after"],
                         "description": "The opening mode. Default is 'tab-after'."
                     }
                 },
@@ -120,14 +91,10 @@
             }
         },
         "image": {
-            "type": [
-                "object",
-                "string"
-            ],
-            "description": "List of tasks to run on start.",
-            "required": [
-                "file"
-            ],
+            "type": ["object", "string"],
+            "description": "The Docker image to run your workspace in.",
+            "default": "gitpod/workspace-full",
+            "required": ["file"],
             "properties": {
                 "file": {
                     "type": "string",
@@ -140,23 +107,39 @@
             },
             "additionalProperties": false
         },
+        "additionalRepositories": {
+            "type": "array",
+            "description": "List of additional repositories that are part of this project.",
+            "items": {
+                "type": "object",
+                "required": ["url"],
+                "properties": {
+                    "url": {
+                        "type": ["string"],
+                        "description": "The url of the git repository to clone. Supports any context URLs."
+                    },
+                    "checkoutLocation": {
+                        "type": "string",
+                        "description": "Path to where the repository should be checked out relative to `/workspace`. Defaults to the simple repository name."
+                    }
+                },
+                "additionalProperties": false
+            }
+        },
+        "mainConfiguration": {
+            "type": "string",
+            "description": "The main repository, containing the dev environment configuration."
+        },
         "checkoutLocation": {
             "type": "string",
-            "description": "Path to where the repository should be checked out."
+            "description": "Path to where the repository should be checked out relative to `/workspace`. Defaults to the simple repository name."
         },
         "workspaceLocation": {
             "type": "string",
-            "description": "Path to where the IDE's workspace should be opened."
-        },
-        "privileged": {
-            "type": "boolean",
-            "deprecationMessage": "The 'privileged' property only works for privileged users.",
-            "description": "Whether the workspace is started in privileged mode."
+            "description": "Path to where the IDE's workspace should be opened. Supports vscode's `*.code-workspace` files."
         },
         "gitConfig": {
-            "type": [
-                "object"
-            ],
+            "type": ["object"],
             "description": "Git config values should be provided in pairs. E.g. `core.autocrlf: input`. See https://git-scm.com/docs/git-config#_values.",
             "additionalProperties": {
                 "type": "string"
@@ -167,15 +150,17 @@
             "description": "Configures Gitpod's GitHub app",
             "properties": {
                 "prebuilds": {
-                    "type": [
-                        "boolean",
-                        "object"
-                    ],
+                    "type": ["boolean", "object"],
                     "description": "Set to true to enable workspace prebuilds, false to disable them. Defaults to true.",
                     "properties": {
                         "master": {
                             "type": "boolean",
-                            "description": "Enable prebuilds for the default branch (typically master). Defaults to true."
+                            "description": "Enable prebuilds for the default branch (typically master). Defaults to true.",
+                            "deprecationMessage": "Deprecated. Please use `defaultBranch` instead. See https://www.gitpod.io/docs/configure/projects/prebuilds#github-specific-configuration."
+                        },
+                        "defaultBranch": {
+                            "type": "boolean",
+                            "description": "Enable prebuilds for the default branch (typically main). Defaults to true."
                         },
                         "branches": {
                             "type": "boolean",
@@ -193,11 +178,13 @@
                             "type": "boolean",
                             "description": "Add a Review in Gitpod badge to pull requests. Defaults to true."
                         },
+                        "addCheck": {
+                            "type": ["boolean", "string"],
+                            "enum": [true, false, "prevent-merge-on-error"],
+                            "description": "Add a commit check to pull requests. Set to 'fail-on-error' if you want broken prebuilds to block merging. Defaults to true."
+                        },
                         "addLabel": {
-                            "type": [
-                                "boolean",
-                                "string"
-                            ],
+                            "type": ["boolean", "string"],
                             "description": "Add a label to a PR when it's prebuilt. Set to true to use the default label (prebuilt-in-gitpod) or set to a string to use a different label name. This is a beta feature and may be unreliable. Defaults to false."
                         }
                     }
@@ -218,7 +205,109 @@
                     }
                 }
             }
+        },
+        "jetbrains": {
+            "type": "object",
+            "description": "Configure JetBrains integration",
+            "deprecationMessage": "The 'jetbrains' property is experimental.",
+            "additionalProperties": false,
+            "properties": {
+                "plugins": {
+                    "type": "array",
+                    "description": "List of plugins which should be installed for all JetBrains product for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "intellij": {
+                    "$ref": "#/definitions/jetbrainsProduct",
+                    "description": "Configure IntelliJ integration"
+                },
+                "goland": {
+                    "$ref": "#/definitions/jetbrainsProduct",
+                    "description": "Configure GoLand integration"
+                },
+                "pycharm": {
+                    "$ref": "#/definitions/jetbrainsProduct",
+                    "description": "Configure PyCharm integration"
+                },
+                "phpstorm": {
+                    "$ref": "#/definitions/jetbrainsProduct",
+                    "description": "Configure PhpStorm integration"
+                },
+                "rubymine": {
+                    "$ref": "#/definitions/jetbrainsProduct",
+                    "description": "Configure RubyMine integration"
+                },
+                "webstorm": {
+                    "$ref": "#/definitions/jetbrainsProduct",
+                    "description": "Configure WebStorm integration"
+                },
+                "rider": {
+                    "$ref": "#/definitions/jetbrainsProduct",
+                    "description": "Configure Rider integration"
+                },
+                "clion": {
+                    "$ref": "#/definitions/jetbrainsProduct",
+                    "description": "Configure CLion integration"
+                }
+            }
+        },
+        "experimentalNetwork": {
+            "type": "boolean",
+            "deprecationMessage": "The 'experimentalNetwork' property is deprecated.",
+            "description": "Experimental network configuration in workspaces (deprecated). Enabled by default"
+        },
+        "coreDump": {
+            "type": "object",
+            "description": "Configure the default action of certain signals is to cause a process to terminate and produce a core dump file, a file containing an image of the process's memory at the time of termination. Disabled by default.",
+            "deprecationMessage": "The 'coreDump' property is experimental.",
+            "additionalProperties": false,
+            "properties": {
+                "enabled": {
+                    "type": "boolean"
+                },
+                "softLimit": {
+                    "type": "number",
+                    "description": "upper limit on the size of the core dump file that will be produced if it receives a core dump signal"
+                },
+                "hardLimit": {
+                    "type": "number",
+                    "description": "the hard limit acts as a ceiling for the soft limit. For more details please check https://man7.org/linux/man-pages/man2/getrlimit.2.html"
+                }
+            }
         }
     },
-    "additionalProperties": false
-}
+    "additionalProperties": false,
+    "definitions": {
+        "jetbrainsProduct": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "plugins": {
+                    "type": "array",
+                    "description": "List of plugins which should be installed for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "prebuilds": {
+                    "type": "object",
+                    "description": "Enable warming up of JetBrains backend in prebuilds.",
+                    "additionalProperties": false,
+                    "properties": {
+                        "version": {
+                            "type": "string",
+                            "enum": ["stable", "latest", "both"],
+                            "description": "Whether only stable, latest or both versions should be warmed up. Default is stable only."
+                        }
+                    }
+                },
+                "vmoptions": {
+                    "type": "string",
+                    "description": "Configure JVM options, for instance '-Xmx=4096m'."
+                }
+            }
+        }
+    }
+}

package/lib/accounting-protocol.d.ts

@@ -0,0 +1,163 @@
+/**
+ * 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.
+ */
+import { User } from "./protocol";
+export interface AccountEntry {
+    uid: string;
+    userId: string;
+    /** [hours] */
+    amount: number;
+    /**
+     * credit: start of validity,
+     * session: end of (split-) session
+     */
+    date: string;
+    /**
+     * debits (session, expiry, loss): relation to credit
+     */
+    creditId?: string;
+    /**
+     * credit: end of validity
+     */
+    expiryDate?: string;
+    kind: AccountEntryKind;
+    /**
+     * credit: amount - accounted debits
+     * [hours]
+     */
+    remainingAmount?: number;
+    description?: object;
+}
+export declare namespace AccountEntry {
+    function create<T extends AccountEntry>(entry: Omit<T, "uid">): T;
+}
+export declare type DebitAccountEntryKind = "session" | "expiry" | "loss";
+export declare type AccountEntryKind = "credit" | DebitAccountEntryKind | "carry" | "open";
+export interface Credit extends AccountEntry {
+    kind: "credit";
+    expiryDate: string;
+}
+export declare type Debit = LossDebit | ExpiryDebit | SessionDebit;
+export interface LossDebit extends AccountEntry {
+    kind: "loss";
+}
+export interface ExpiryDebit extends AccountEntry {
+    kind: "expiry";
+    creditId: undefined;
+}
+export interface SessionDebit extends AccountEntry {
+    kind: DebitAccountEntryKind;
+    creditId: string;
+}
+export declare type AccountEntryDescription = SessionDescription | CreditDescription;
+export interface CreditDescription {
+    subscriptionId: string;
+    planId: string;
+}
+export declare namespace CreditDescription {
+    function is(obj: any): obj is CreditDescription;
+}
+export interface SessionDescription {
+    contextTitle: string;
+    contextUrl: string;
+    workspaceId: string;
+    workspaceInstanceId: string;
+}
+export declare namespace SessionDescription {
+    function is(obj: any): obj is SessionDescription;
+}
+/**
+ * - The earliest subscription may start with User.creationDate
+ * - There may be multiple Gitpod subscriptions for a user at any given time
+ * - The dates form an interval of the form: [startDate, endDate)
+ * - Subscriptions that directly map to a Chargebee plan have their paymentReference set and MAY carry additional paymentData (UserPaidSubscription)
+ * - Subscriptions that are assigned to a user through a Team Subscription carry a teamSubscriptionSlotId (AssignedTeamSubscription)
+ */
+export interface Subscription {
+    uid: string;
+    userId: string;
+    startDate: string;
+    /** When the subscription will end (must be >= cancellationDate!) */
+    endDate?: string;
+    /** When the subscription was cancelled */
+    cancellationDate?: string;
+    /** Number of granted hours */
+    amount: number;
+    /** Number of granted hours for the first month: If this is set, use this value for the first month */
+    firstMonthAmount?: number;
+    planId?: string;
+    paymentReference?: string;
+    paymentData?: PaymentData;
+    teamSubscriptionSlotId?: string;
+    teamMembershipId?: string;
+    /** marks the subscription as deleted */
+    deleted?: boolean;
+}
+export interface SubscriptionAndUser extends Subscription {
+    user: User;
+}
+export interface PaymentData {
+    /** Marks the date as of which the _switch_ is effective. */
+    downgradeDate?: string;
+    /** Determines the new plan the dowgrade is targeted against (optional for backwards compatibility) */
+    newPlan?: string;
+}
+export interface UserPaidSubscription extends Subscription {
+    paymentReference: string;
+    paymentData?: PaymentData;
+}
+export declare namespace UserPaidSubscription {
+    function is(data: any): data is UserPaidSubscription;
+}
+export interface AssignedTeamSubscription extends Subscription {
+    teamSubscriptionSlotId: string;
+}
+export declare namespace AssignedTeamSubscription {
+    function is(data: any): data is AssignedTeamSubscription;
+}
+export interface AssignedTeamSubscription2 extends Subscription {
+    teamMembershipId: string;
+}
+export declare namespace AssignedTeamSubscription2 {
+    function is(data: any): data is AssignedTeamSubscription2;
+}
+export declare namespace Subscription {
+    function create(newSubscription: Omit<Subscription, "uid">): Subscription;
+    function cancelSubscription(s: Subscription, cancellationDate: string, endDate?: string): void;
+    function isSame(s1: Subscription | undefined, s2: Subscription | undefined): boolean;
+    function isActive(s: Subscription, date: string): boolean;
+    function isCancelled(s: Subscription, date: string): boolean;
+    function isDowngraded(s: Subscription): string | undefined;
+    function calculateCurrentPeriod(startDate: string, now: Date): {
+        startDate: string;
+        endDate: string;
+    };
+}
+export declare type MaybeSubscription = Subscription | undefined;
+export interface Period {
+    startDate: string;
+    endDate: string;
+}
+export declare type MaybePeriod = Period | undefined;
+export declare type AccountEntryFixedPeriod = Omit<AccountEntry, "uid"> & {
+    expiryDate: string;
+};
+export interface AccountStatement extends Period {
+    userId: string;
+    /**
+     * The subscriptions that have not been cancelled yet at the end of the period
+     */
+    subscriptions: Subscription[];
+    credits: Credit[];
+    debits: Debit[];
+    /** Remaining valid hours (accumulated from credits) */
+    remainingHours: RemainingHours;
+}
+export declare type RemainingHours = number | "unlimited";
+export interface CreditAlert {
+    userId: string;
+    remainingUsageHours: number;
+}
+//# sourceMappingURL=accounting-protocol.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"accounting-protocol.d.ts","sourceRoot":"","sources":["../src/accounting-protocol.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAMlC,MAAM,WAAW,YAAY;IACzB,GAAG,EAAE,MAAM,CAAC;IAEZ,MAAM,EAAE,MAAM,CAAC;IAEf,cAAc;IACd,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,gBAAgB,CAAC;IAEvB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AACD,yBAAiB,YAAY,CAAC;IAC1B,SAAgB,MAAM,CAAC,CAAC,SAAS,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAIvE;CACJ;AAED,oBAAY,qBAAqB,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;AAClE,oBAAY,gBAAgB,GAAG,QAAQ,GAAG,qBAAqB,GAAG,OAAO,GAAG,MAAM,CAAC;AAEnF,MAAM,WAAW,MAAO,SAAQ,YAAY;IACxC,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACtB;AACD,oBAAY,KAAK,GAAG,SAAS,GAAG,WAAW,GAAG,YAAY,CAAC;AAC3D,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC3C,IAAI,EAAE,MAAM,CAAC;CAChB;AACD,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC7C,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,EAAE,SAAS,CAAC;CACvB;AACD,MAAM,WAAW,YAAa,SAAQ,YAAY;IAC9C,IAAI,EAAE,qBAAqB,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,oBAAY,uBAAuB,GAAG,kBAAkB,GAAG,iBAAiB,CAAC;AAC7E,MAAM,WAAW,iBAAiB;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;CAClB;AACD,yBAAiB,iBAAiB,CAAC;IAC/B,SAAgB,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,iBAAiB,CAErD;CACJ;AACD,MAAM,WAAW,kBAAkB;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;CAC/B;AACD,yBAAiB,kBAAkB,CAAC;IAChC,SAAgB,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,kBAAkB,CAQtD;CACJ;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,8BAA8B;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,sGAAsG;IACtG,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,wCAAwC;IACxC,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACrD,IAAI,EAAE,IAAI,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IACxB,4DAA4D;IAC5D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,sGAAsG;IACtG,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACtD,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,WAAW,CAAC;CAC7B;AACD,yBAAiB,oBAAoB,CAAC;IAClC,SAAgB,EAAE,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,IAAI,oBAAoB,CAE1D;CACJ;AAED,MAAM,WAAW,wBAAyB,SAAQ,YAAY;IAC1D,sBAAsB,EAAE,MAAM,CAAC;CAClC;AACD,yBAAiB,wBAAwB,CAAC;IACtC,SAAgB,EAAE,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,IAAI,wBAAwB,CAE9D;CACJ;AAED,MAAM,WAAW,yBAA0B,SAAQ,YAAY;IAC3D,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AACD,yBAAiB,yBAAyB,CAAC;IACvC,SAAgB,EAAE,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,IAAI,yBAAyB,CAE/D;CACJ;AAED,yBAAiB,YAAY,CAAC;IAC1B,SAAgB,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,gBAIhE;IACD,SAAgB,kBAAkB,CAAC,CAAC,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,QAG7F;IACD,SAAgB,MAAM,CAAC,EAAE,EAAE,YAAY,GAAG,SAAS,EAAE,EAAE,EAAE,YAAY,GAAG,SAAS,GAAG,OAAO,CAiB1F;IACD,SAAgB,QAAQ,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAE/D;IACD,SAAgB,WAAW,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAElE;IACD,SAAgB,YAAY,CAAC,CAAC,EAAE,YAAY,sBAE3C;IACD,SAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI;;;MAOlE;CACJ;AAED,oBAAY,iBAAiB,GAAG,YAAY,GAAG,SAAS,CAAC;AAEzD,MAAM,WAAW,MAAM;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,oBAAY,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;AAE7C,oBAAY,uBAAuB,GAAG,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,GAAG;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC;AACzF,MAAM,WAAW,gBAAiB,SAAQ,MAAM;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,uDAAuD;IACvD,cAAc,EAAE,cAAc,CAAC;CAClC;AACD,oBAAY,cAAc,GAAG,MAAM,GAAG,WAAW,CAAC;AAElD,MAAM,WAAW,WAAW;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,MAAM,CAAC;CAC/B"}

package/lib/accounting-protocol.js

@@ -0,0 +1,111 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subscription = exports.AssignedTeamSubscription2 = exports.AssignedTeamSubscription = exports.UserPaidSubscription = exports.SessionDescription = exports.CreditDescription = exports.AccountEntry = void 0;
+const uuid_1 = require("uuid");
+const timeutil_1 = require("./util/timeutil");
+var AccountEntry;
+(function (AccountEntry) {
+    function create(entry) {
+        const result = entry;
+        result.uid = (0, uuid_1.v4)();
+        return result;
+    }
+    AccountEntry.create = create;
+})(AccountEntry = exports.AccountEntry || (exports.AccountEntry = {}));
+var CreditDescription;
+(function (CreditDescription) {
+    function is(obj) {
+        return !!obj && obj.hasOwnProperty("subscriptionId") && obj.hasOwnProperty("planId");
+    }
+    CreditDescription.is = is;
+})(CreditDescription = exports.CreditDescription || (exports.CreditDescription = {}));
+var SessionDescription;
+(function (SessionDescription) {
+    function is(obj) {
+        return (!!obj &&
+            obj.hasOwnProperty("contextTitle") &&
+            obj.hasOwnProperty("contextUrl") &&
+            obj.hasOwnProperty("workspaceId") &&
+            obj.hasOwnProperty("workspaceInstanceId"));
+    }
+    SessionDescription.is = is;
+})(SessionDescription = exports.SessionDescription || (exports.SessionDescription = {}));
+var UserPaidSubscription;
+(function (UserPaidSubscription) {
+    function is(data) {
+        return !!data && data.hasOwnProperty("paymentReference");
+    }
+    UserPaidSubscription.is = is;
+})(UserPaidSubscription = exports.UserPaidSubscription || (exports.UserPaidSubscription = {}));
+var AssignedTeamSubscription;
+(function (AssignedTeamSubscription) {
+    function is(data) {
+        return !!data && data.hasOwnProperty("teamSubscriptionSlotId");
+    }
+    AssignedTeamSubscription.is = is;
+})(AssignedTeamSubscription = exports.AssignedTeamSubscription || (exports.AssignedTeamSubscription = {}));
+var AssignedTeamSubscription2;
+(function (AssignedTeamSubscription2) {
+    function is(data) {
+        return typeof data === "object" && data.hasOwnProperty("teamMembershipId");
+    }
+    AssignedTeamSubscription2.is = is;
+})(AssignedTeamSubscription2 = exports.AssignedTeamSubscription2 || (exports.AssignedTeamSubscription2 = {}));
+var Subscription;
+(function (Subscription) {
+    function create(newSubscription) {
+        const subscription = newSubscription;
+        subscription.uid = (0, uuid_1.v4)();
+        return subscription;
+    }
+    Subscription.create = create;
+    function cancelSubscription(s, cancellationDate, endDate) {
+        s.endDate = endDate || cancellationDate;
+        s.cancellationDate = cancellationDate;
+    }
+    Subscription.cancelSubscription = cancelSubscription;
+    function isSame(s1, s2) {
+        return (!!s1 &&
+            !!s2 &&
+            s1.userId === s2.userId &&
+            s1.planId === s2.planId &&
+            s1.startDate === s2.startDate &&
+            s1.endDate === s2.endDate &&
+            s1.amount === s2.amount &&
+            s1.cancellationDate === s2.cancellationDate &&
+            s1.deleted === s2.deleted &&
+            ((s1.paymentData === undefined && s2.paymentData === undefined) ||
+                (!!s1.paymentData &&
+                    !!s2.paymentData &&
+                    s1.paymentData.downgradeDate === s2.paymentData.downgradeDate &&
+                    s1.paymentData.newPlan === s2.paymentData.newPlan)));
+    }
+    Subscription.isSame = isSame;
+    function isActive(s, date) {
+        return s.startDate <= date && (s.endDate === undefined || date < s.endDate);
+    }
+    Subscription.isActive = isActive;
+    function isCancelled(s, date) {
+        return (!!s.cancellationDate && s.cancellationDate < date) || (!!s.endDate && s.endDate < date); // This edge case is meant to handle bad data: If for whatever reason cancellationDate has not been set: treat endDate as such
+    }
+    Subscription.isCancelled = isCancelled;
+    function isDowngraded(s) {
+        return s.paymentData && s.paymentData.downgradeDate;
+    }
+    Subscription.isDowngraded = isDowngraded;
+    function calculateCurrentPeriod(startDate, now) {
+        let nextStartDate = startDate;
+        do {
+            startDate = nextStartDate;
+            nextStartDate = (0, timeutil_1.oneMonthLater)(startDate, new Date(startDate).getDate());
+        } while (nextStartDate < now.toISOString());
+        return { startDate, endDate: nextStartDate };
+    }
+    Subscription.calculateCurrentPeriod = calculateCurrentPeriod;
+})(Subscription = exports.Subscription || (exports.Subscription = {}));
+//# sourceMappingURL=accounting-protocol.js.map

package/lib/accounting-protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accounting-protocol.js","sourceRoot":"","sources":["../src/accounting-protocol.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,+BAAoC;AAEpC,8CAAgD;AAuChD,IAAiB,YAAY,CAM5B;AAND,WAAiB,YAAY;IACzB,SAAgB,MAAM,CAAyB,KAAqB;QAChE,MAAM,MAAM,GAAG,KAAU,CAAC;QAC1B,MAAM,CAAC,GAAG,GAAG,IAAA,SAAM,GAAE,CAAC;QACtB,OAAO,MAAM,CAAC;IAClB,CAAC;IAJe,mBAAM,SAIrB,CAAA;AACL,CAAC,EANgB,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAM5B;AA2BD,IAAiB,iBAAiB,CAIjC;AAJD,WAAiB,iBAAiB;IAC9B,SAAgB,EAAE,CAAC,GAAQ;QACvB,OAAO,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACzF,CAAC;IAFe,oBAAE,KAEjB,CAAA;AACL,CAAC,EAJgB,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAIjC;AAOD,IAAiB,kBAAkB,CAUlC;AAVD,WAAiB,kBAAkB;IAC/B,SAAgB,EAAE,CAAC,GAAQ;QACvB,OAAO,CACH,CAAC,CAAC,GAAG;YACL,GAAG,CAAC,cAAc,CAAC,cAAc,CAAC;YAClC,GAAG,CAAC,cAAc,CAAC,YAAY,CAAC;YAChC,GAAG,CAAC,cAAc,CAAC,aAAa,CAAC;YACjC,GAAG,CAAC,cAAc,CAAC,qBAAqB,CAAC,CAC5C,CAAC;IACN,CAAC;IARe,qBAAE,KAQjB,CAAA;AACL,CAAC,EAVgB,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAUlC;AA6CD,IAAiB,oBAAoB,CAIpC;AAJD,WAAiB,oBAAoB;IACjC,SAAgB,EAAE,CAAC,IAAS;QACxB,OAAO,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IAC7D,CAAC;IAFe,uBAAE,KAEjB,CAAA;AACL,CAAC,EAJgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAIpC;AAKD,IAAiB,wBAAwB,CAIxC;AAJD,WAAiB,wBAAwB;IACrC,SAAgB,EAAE,CAAC,IAAS;QACxB,OAAO,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,wBAAwB,CAAC,CAAC;IACnE,CAAC;IAFe,2BAAE,KAEjB,CAAA;AACL,CAAC,EAJgB,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAIxC;AAKD,IAAiB,yBAAyB,CAIzC;AAJD,WAAiB,yBAAyB;IACtC,SAAgB,EAAE,CAAC,IAAS;QACxB,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IAC/E,CAAC;IAFe,4BAAE,KAEjB,CAAA;AACL,CAAC,EAJgB,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAIzC;AAED,IAAiB,YAAY,CA6C5B;AA7CD,WAAiB,YAAY;IACzB,SAAgB,MAAM,CAAC,eAA0C;QAC7D,MAAM,YAAY,GAAG,eAA+B,CAAC;QACrD,YAAY,CAAC,GAAG,GAAG,IAAA,SAAM,GAAE,CAAC;QAC5B,OAAO,YAAY,CAAC;IACxB,CAAC;IAJe,mBAAM,SAIrB,CAAA;IACD,SAAgB,kBAAkB,CAAC,CAAe,EAAE,gBAAwB,EAAE,OAAgB;QAC1F,CAAC,CAAC,OAAO,GAAG,OAAO,IAAI,gBAAgB,CAAC;QACxC,CAAC,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IAC1C,CAAC;IAHe,+BAAkB,qBAGjC,CAAA;IACD,SAAgB,MAAM,CAAC,EAA4B,EAAE,EAA4B;QAC7E,OAAO,CACH,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE;YACJ,EAAE,CAAC,MAAM,KAAK,EAAE,CAAC,MAAM;YACvB,EAAE,CAAC,MAAM,KAAK,EAAE,CAAC,MAAM;YACvB,EAAE,CAAC,SAAS,KAAK,EAAE,CAAC,SAAS;YAC7B,EAAE,CAAC,OAAO,KAAK,EAAE,CAAC,OAAO;YACzB,EAAE,CAAC,MAAM,KAAK,EAAE,CAAC,MAAM;YACvB,EAAE,CAAC,gBAAgB,KAAK,EAAE,CAAC,gBAAgB;YAC3C,EAAE,CAAC,OAAO,KAAK,EAAE,CAAC,OAAO;YACzB,CAAC,CAAC,EAAE,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,CAAC,WAAW,KAAK,SAAS,CAAC;gBAC3D,CAAC,CAAC,CAAC,EAAE,CAAC,WAAW;oBACb,CAAC,CAAC,EAAE,CAAC,WAAW;oBAChB,EAAE,CAAC,WAAW,CAAC,aAAa,KAAK,EAAE,CAAC,WAAW,CAAC,aAAa;oBAC7D,EAAE,CAAC,WAAW,CAAC,OAAO,KAAK,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAC9D,CAAC;IACN,CAAC;IAjBe,mBAAM,SAiBrB,CAAA;IACD,SAAgB,QAAQ,CAAC,CAAe,EAAE,IAAY;QAClD,OAAO,CAAC,CAAC,SAAS,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;IAChF,CAAC;IAFe,qBAAQ,WAEvB,CAAA;IACD,SAAgB,WAAW,CAAC,CAAe,EAAE,IAAY;QACrD,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAgB,IAAI,CAAC,CAAC,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,8HAA8H;IACnO,CAAC;IAFe,wBAAW,cAE1B,CAAA;IACD,SAAgB,YAAY,CAAC,CAAe;QACxC,OAAO,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC;IACxD,CAAC;IAFe,yBAAY,eAE3B,CAAA;IACD,SAAgB,sBAAsB,CAAC,SAAiB,EAAE,GAAS;QAC/D,IAAI,aAAa,GAAG,SAAS,CAAC;QAC9B,GAAG;YACC,SAAS,GAAG,aAAa,CAAC;YAC1B,aAAa,GAAG,IAAA,wBAAa,EAAC,SAAS,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC3E,QAAQ,aAAa,GAAG,GAAG,CAAC,WAAW,EAAE,EAAE;QAC5C,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;IACjD,CAAC;IAPe,mCAAsB,yBAOrC,CAAA;AACL,CAAC,EA7CgB,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QA6C5B"}