@mytmpvpn/mytmpvpn-common 4.0.1 → 5.0.0

package/dist/src/errors.d.ts

@@ -1,3 +1,18 @@
 export declare class MyTmpVpnError extends Error {
     constructor(msg: string);
 }
+export declare class InvalidUserConfigError extends MyTmpVpnError {
+    constructor(msg: string);
+}
+export declare class InvalidVpnConfigError extends MyTmpVpnError {
+    constructor(msg: string);
+}
+export declare class MinPeanutsError extends InvalidVpnConfigError {
+    constructor(given: number, balance: number);
+}
+export declare class MaxPeanutsError extends InvalidVpnConfigError {
+    constructor(given: number, balance: number);
+}
+export declare class NotEnoughPeanutsError extends InvalidVpnConfigError {
+    constructor(given: number, balance: number);
+}

package/dist/src/errors.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MyTmpVpnError = void 0;
+exports.NotEnoughPeanutsError = exports.MaxPeanutsError = exports.MinPeanutsError = exports.InvalidVpnConfigError = exports.InvalidUserConfigError = exports.MyTmpVpnError = void 0;
+const peanuts_1 = require("./models/peanuts");
 class MyTmpVpnError extends Error {
     constructor(msg) {
         super(msg); // 'Error' breaks prototype chain here
@@ -9,3 +10,43 @@ class MyTmpVpnError extends Error {
     }
 }
 exports.MyTmpVpnError = MyTmpVpnError;
+class InvalidUserConfigError extends MyTmpVpnError {
+    constructor(msg) {
+        super(msg);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, InvalidUserConfigError.prototype);
+    }
+}
+exports.InvalidUserConfigError = InvalidUserConfigError;
+class InvalidVpnConfigError extends MyTmpVpnError {
+    constructor(msg) {
+        super(msg);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, InvalidVpnConfigError.prototype);
+    }
+}
+exports.InvalidVpnConfigError = InvalidVpnConfigError;
+class MinPeanutsError extends InvalidVpnConfigError {
+    constructor(given, balance) {
+        super(`Minimum number of peanuts should be ${peanuts_1.PEANUTS_CONFIG.min}, you specified: ${(0, peanuts_1.peanutsToClient)(given)} and you have ${(0, peanuts_1.peanutsToClient)(balance)}.`);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, MinPeanutsError.prototype);
+    }
+}
+exports.MinPeanutsError = MinPeanutsError;
+class MaxPeanutsError extends InvalidVpnConfigError {
+    constructor(given, balance) {
+        super(`Maximum number of peanuts should be ${peanuts_1.PEANUTS_CONFIG.max}, you specified: ${(0, peanuts_1.peanutsToClient)(given)} and you have ${(0, peanuts_1.peanutsToClient)(balance)}.`);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, MaxPeanutsError.prototype);
+    }
+}
+exports.MaxPeanutsError = MaxPeanutsError;
+class NotEnoughPeanutsError extends InvalidVpnConfigError {
+    constructor(given, balance) {
+        super(`Not enough peanuts, you specified: ${(0, peanuts_1.peanutsToClient)(given)} and you have ${(0, peanuts_1.peanutsToClient)(balance)}.`);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, NotEnoughPeanutsError.prototype);
+    }
+}
+exports.NotEnoughPeanutsError = NotEnoughPeanutsError;

package/dist/src/models/peanuts.d.ts

@@ -10,4 +10,5 @@ interface PeanutsPack {
     price: number;
     description: string[];
 }
-export { PEANUTS_CONFIG, PeanutsPack };
+declare function peanutsToClient(peanuts: number): number;
+export { PEANUTS_CONFIG, PeanutsPack, peanutsToClient };

package/dist/src/models/peanuts.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PEANUTS_CONFIG = void 0;
+exports.peanutsToClient = exports.PEANUTS_CONFIG = void 0;
 const PEANUTS_CONFIG = {
     min: 1,
     max: 1000
 };
 exports.PEANUTS_CONFIG = PEANUTS_CONFIG;
+function peanutsToClient(peanuts) {
+    return Number.parseFloat(peanuts.toFixed(2));
+}
+exports.peanutsToClient = peanutsToClient;

package/dist/src/models/vpn.d.ts

@@ -1,4 +1,5 @@
-declare enum VpnState {
+import { UserVpn } from "./uservpn";
+export declare enum VpnState {
     Failed = "Failed",
     Creating = "Creating",
     Created = "Created",
@@ -8,32 +9,36 @@ declare enum VpnState {
     Deprovisioning = "Deprovisioning",
     Deleted = "Deleted"
 }
-declare function rank(state: VpnState): number;
-declare enum VpnType {
+export declare function toRank(state: VpnState): number;
+export declare function fromRank(rank: number): VpnState;
+export declare enum VpnType {
     WireGuard = "wireguard"
 }
-declare const MIN_DELETE_AFTER: number;
-declare const MAX_DELETE_AFTER: number;
-interface VpnConfig {
+export declare const MIN_DELETE_AFTER: number;
+export declare const MAX_DELETE_AFTER: number;
+export interface VpnConfig {
     type: VpnType;
     maxPeanuts: number;
     deleteAfter?: number;
 }
-interface VpnMetrics {
+export interface VpnMetrics {
     duration: number;
     bytes: number;
     peanuts: number;
 }
-interface Vpn {
+export interface Vpn {
     vpnId: string;
     createdAt: Date;
     region: string;
     config: VpnConfig;
     state: VpnState;
 }
-declare function getVpnConfigTypes(): VpnType[];
-declare function throwIfNotValidDeleteAfter(deleteAfter: number | undefined): void;
-declare function newVpn(region: string, config: VpnConfig, state: VpnState): Vpn;
-declare function getVpnFrom(vpnId: string, state: VpnState, config: VpnConfig): Vpn;
-declare function vpnIdToWgFileName(vpnId: string): string;
-export { VpnState, type VpnMetrics, VpnType, type VpnConfig, type Vpn, rank, newVpn, getVpnFrom, getVpnConfigTypes, vpnIdToWgFileName, MIN_DELETE_AFTER, MAX_DELETE_AFTER, throwIfNotValidDeleteAfter };
+export declare function getVpnConfigTypes(): VpnType[];
+export declare function vpnAgainstQuotaPredicate(uservpn: UserVpn): boolean;
+export declare function validateVpnNbAgainstQuota(vpnNb: number, quota: number): number;
+export declare function checkValidConfig(userId: string, currentBalance: number, vpnConfig: any): VpnConfig;
+export declare function newVpn(region: string, config: VpnConfig, state: VpnState): Vpn;
+export declare function getVpnFrom(vpnId: string, state: VpnState, config: VpnConfig): Vpn;
+export declare function vpnIdToWgFileName(vpnId: string): string;
+export declare function vpnToClient(vpn: Vpn): Vpn;
+export declare function metricsToClient(metrics: VpnMetrics | undefined): VpnMetrics;

package/dist/src/models/vpn.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.throwIfNotValidDeleteAfter = exports.MAX_DELETE_AFTER = exports.MIN_DELETE_AFTER = exports.vpnIdToWgFileName = exports.getVpnConfigTypes = exports.getVpnFrom = exports.newVpn = exports.rank = exports.VpnType = exports.VpnState = void 0;
+exports.metricsToClient = exports.vpnToClient = exports.vpnIdToWgFileName = exports.getVpnFrom = exports.newVpn = exports.checkValidConfig = exports.validateVpnNbAgainstQuota = exports.vpnAgainstQuotaPredicate = exports.getVpnConfigTypes = exports.MAX_DELETE_AFTER = exports.MIN_DELETE_AFTER = exports.VpnType = exports.fromRank = exports.toRank = exports.VpnState = void 0;
 const errors_1 = require("../errors");
+const peanuts_1 = require("./peanuts");
 var VpnState;
 (function (VpnState) {
     VpnState["Failed"] = "Failed";
@@ -12,52 +13,120 @@ var VpnState;
     VpnState["Running"] = "Running";
     VpnState["Deprovisioning"] = "Deprovisioning";
     VpnState["Deleted"] = "Deleted";
-})(VpnState || (VpnState = {}));
-exports.VpnState = VpnState;
+})(VpnState = exports.VpnState || (exports.VpnState = {}));
 const vpnStateRank = Object.values(VpnState);
-function rank(state) {
+function toRank(state) {
     return vpnStateRank.indexOf(state);
 }
-exports.rank = rank;
+exports.toRank = toRank;
+function fromRank(rank) {
+    return vpnStateRank[rank];
+}
+exports.fromRank = fromRank;
 var VpnType;
 (function (VpnType) {
     VpnType["WireGuard"] = "wireguard";
-})(VpnType || (VpnType = {}));
-exports.VpnType = VpnType;
-const MIN_DELETE_AFTER = 5 * 60; // Minimum is 5 minutes
-exports.MIN_DELETE_AFTER = MIN_DELETE_AFTER;
-const MAX_DELETE_AFTER = 24 * 60 * 60; // Maximum is 24 hours
-exports.MAX_DELETE_AFTER = MAX_DELETE_AFTER;
+})(VpnType = exports.VpnType || (exports.VpnType = {}));
+exports.MIN_DELETE_AFTER = 5 * 60; // Minimum is 5 minutes
+exports.MAX_DELETE_AFTER = 24 * 60 * 60; // Maximum is 24 hours
 function getVpnConfigTypes() {
     return Object.values(VpnType).filter((item) => {
         return isNaN(Number(item));
     });
 }
 exports.getVpnConfigTypes = getVpnConfigTypes;
-function throwIfNotValidVpnId(vpnId) {
+function validateVpnId(vpnId) {
     // e.g: YYYYMMDDHHmmssmss@az-test-7
     if (!/\d{4}[01]\d[0-3]\d[0-2]\d[0-5]\d[0-5]\d\d{3}@[a-z]{2}-[a-z]+-\d/.test(vpnId)) {
         throw new errors_1.MyTmpVpnError(`Incorrect vpnId: \'${vpnId}\'`);
     }
+    return vpnId;
+}
+function validateMaxPeanuts(peanuts, currentBalance) {
+    let result = peanuts;
+    if (peanuts <= 0) {
+        result = Math.min(currentBalance, peanuts_1.PEANUTS_CONFIG.max);
+    }
+    if (result > currentBalance) {
+        throw new errors_1.NotEnoughPeanutsError(result, currentBalance);
+    }
+    if (result < peanuts_1.PEANUTS_CONFIG.min) {
+        throw new errors_1.MinPeanutsError(result, currentBalance);
+    }
+    if (result > peanuts_1.PEANUTS_CONFIG.max) {
+        throw new errors_1.MaxPeanutsError(result, currentBalance);
+    }
+    return result;
 }
-function throwIfNotValidDeleteAfter(deleteAfter) {
+function validateDeleteAfter(deleteAfter) {
     if (deleteAfter === undefined) {
-        return;
+        return undefined;
     }
     if (isNaN(deleteAfter)) {
-        return;
+        return undefined;
     }
     if (!isFinite(deleteAfter)) {
-        throw new errors_1.MyTmpVpnError(`deleteAfter must be finite: ${deleteAfter}`);
+        throw new errors_1.InvalidVpnConfigError(`deleteAfter must be finite: ${deleteAfter}`);
+    }
+    if (deleteAfter < exports.MIN_DELETE_AFTER) {
+        throw new errors_1.InvalidVpnConfigError(`deleteAfter must be greater than ${exports.MIN_DELETE_AFTER}: ${deleteAfter}`);
     }
-    if (deleteAfter < MIN_DELETE_AFTER) {
-        throw new errors_1.MyTmpVpnError(`deleteAfter must be greater than ${MIN_DELETE_AFTER}: ${deleteAfter}`);
+    if (deleteAfter > exports.MAX_DELETE_AFTER) {
+        throw new errors_1.InvalidVpnConfigError(`deleteAfter must be lesser than ${exports.MAX_DELETE_AFTER}: ${deleteAfter}`);
     }
-    if (deleteAfter > MAX_DELETE_AFTER) {
-        throw new errors_1.MyTmpVpnError(`deleteAfter must be lesser than ${MAX_DELETE_AFTER}: ${deleteAfter}`);
+    return deleteAfter;
+}
+// Return whether the given vpn should be taken into account when computing
+// whether a given user has reached its quota or not
+function vpnAgainstQuotaPredicate(uservpn) {
+    // We return true only when the vpn is in a state that is below Running, and not Failed.
+    // The idea is that those ones are either already running or will soon, so they have to be 
+    // part of the quota. Others (Failed, and Deprovisioning, Deleted) are gone, so they should not count.
+    return (uservpn.vpn.state !== VpnState.Failed) && (toRank(uservpn.vpn.state) <= toRank(VpnState.Running));
+}
+exports.vpnAgainstQuotaPredicate = vpnAgainstQuotaPredicate;
+function validateVpnNbAgainstQuota(vpnNb, quota) {
+    if (vpnNb >= quota) {
+        throw new errors_1.InvalidUserConfigError(`User already has ${quota} active vpns. Quota reached.`);
     }
+    return vpnNb;
+}
+exports.validateVpnNbAgainstQuota = validateVpnNbAgainstQuota;
+// vpnConfig is of type any here because it could come from user input such as json
+function checkValidConfig(userId, currentBalance, vpnConfig) {
+    const maxPeanuts = checkValidMaxPeanuts(userId, currentBalance, vpnConfig.maxPeanuts);
+    const type = checkValidVpnType(vpnConfig.type);
+    const deleteAfter = checkValidDeleteAfter(vpnConfig.deleteAfter);
+    const result = {
+        maxPeanuts,
+        type,
+        deleteAfter
+    };
+    return result;
+}
+exports.checkValidConfig = checkValidConfig;
+function checkValidMaxPeanuts(userId, currentBalance, maxPeanuts) {
+    const peanuts = Number.parseFloat(maxPeanuts);
+    if (Number.isNaN(peanuts)) {
+        throw new errors_1.InvalidVpnConfigError(`Config maxPeanuts is invalid: ${maxPeanuts}`);
+    }
+    console.log(`Validating peanuts for ${userId}, peanuts: ${peanuts}, currentBalance: ${currentBalance}`);
+    return validateMaxPeanuts(peanuts, currentBalance);
+}
+function checkValidVpnType(jsonType) {
+    if (!jsonType) {
+        throw new errors_1.InvalidVpnConfigError(`Config type is null or undefined: ${jsonType}`);
+    }
+    const type = jsonType;
+    if (!type || !Object.values(VpnType).includes(type)) {
+        throw new errors_1.InvalidVpnConfigError(`Config type is invalid: ${jsonType}`);
+    }
+    return type;
+}
+function checkValidDeleteAfter(jsonDeleteAfter) {
+    const deleteAfter = Number.parseInt(jsonDeleteAfter);
+    return validateDeleteAfter(deleteAfter);
 }
-exports.throwIfNotValidDeleteAfter = throwIfNotValidDeleteAfter;
 function newVpn(region, config, state) {
     // e.g: ap-northeast-3
     if (!/[a-z]{2}-[a-z]+-[1-9]+/.test(region)) {
@@ -66,8 +135,8 @@ function newVpn(region, config, state) {
     const createdAt = new Date();
     const vpnId = `${dateToId(createdAt)}@${region}`;
     // Assert we will be able to deserialize later on...
-    throwIfNotValidVpnId(vpnId);
-    throwIfNotValidDeleteAfter(config.deleteAfter);
+    validateVpnId(vpnId);
+    validateDeleteAfter(config.deleteAfter);
     return {
         vpnId,
         createdAt,
@@ -78,8 +147,8 @@ function newVpn(region, config, state) {
 }
 exports.newVpn = newVpn;
 function getVpnFrom(vpnId, state, config) {
-    throwIfNotValidVpnId(vpnId);
-    throwIfNotValidDeleteAfter(config.deleteAfter);
+    validateVpnId(vpnId);
+    validateDeleteAfter(config.deleteAfter);
     const tokens = vpnId.split('@');
     if (tokens.length !== 2) {
         throw new errors_1.MyTmpVpnError(`Incorrect vpnId: ${vpnId}`);
@@ -122,7 +191,7 @@ function idToDate(id) {
 // https://git.zx2c4.com/wireguard-android/tree/tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java#n19
 // This function is to transform from vpnIn to Wireguard mobile application requirements
 function vpnIdToWgFileName(vpnId) {
-    throwIfNotValidVpnId(vpnId);
+    validateVpnId(vpnId);
     // The vpnId is made of YYYYMMDDHHmmssmss@region
     // Let's keep it simple: vpn is mostly temporary, so keeping 
     // the year is useless. 
@@ -173,3 +242,35 @@ function vpnIdToWgFileName(vpnId) {
     return result;
 }
 exports.vpnIdToWgFileName = vpnIdToWgFileName;
+function vpnToClient(vpn) {
+    return {
+        vpnId: vpn.vpnId,
+        state: vpn.state,
+        region: vpn.region,
+        createdAt: vpn.createdAt,
+        config: {
+            type: vpn.config.type,
+            deleteAfter: vpn.config.deleteAfter,
+            maxPeanuts: (0, peanuts_1.peanutsToClient)(vpn.config.maxPeanuts),
+            // terminationReason: userVpn.vpn.config.terminationReason,
+            // terminationMessage: userVpn.vpn.config.terminationMessage,
+            // terminationCode: userVpn.vpn.config.terminationCode,
+            // terminationType: userVpn.vpn.config.terminationType,
+        }
+    };
+}
+exports.vpnToClient = vpnToClient;
+function metricsToClient(metrics) {
+    return (metrics != null)
+        ? {
+            duration: metrics.duration,
+            bytes: metrics.bytes,
+            peanuts: (0, peanuts_1.peanutsToClient)(metrics.peanuts)
+        }
+        : {
+            duration: Number.NaN,
+            bytes: Number.NaN,
+            peanuts: Number.NaN,
+        };
+}
+exports.metricsToClient = metricsToClient;

package/dist/test/models.test.js

@@ -5,12 +5,17 @@ const errors_1 = require("../src/errors");
 const vpn_1 = require("../src/models/vpn");
 describe('Testing VpnState', () => {
     it('should check that all VpnState are ordered properly', async () => {
-        expect((0, vpn_1.rank)(vpn_1.VpnState.Creating) <= (0, vpn_1.rank)(vpn_1.VpnState.Created)).toBe(true);
-        expect((0, vpn_1.rank)(vpn_1.VpnState.Created) <= (0, vpn_1.rank)(vpn_1.VpnState.Provisioning)).toBe(true);
-        expect((0, vpn_1.rank)(vpn_1.VpnState.Provisioning) <= (0, vpn_1.rank)(vpn_1.VpnState.Running)).toBe(true);
-        expect((0, vpn_1.rank)(vpn_1.VpnState.Paused) <= (0, vpn_1.rank)(vpn_1.VpnState.Running)).toBe(true);
-        expect((0, vpn_1.rank)(vpn_1.VpnState.Running) <= (0, vpn_1.rank)(vpn_1.VpnState.Deprovisioning)).toBe(true);
-        expect((0, vpn_1.rank)(vpn_1.VpnState.Deprovisioning) <= (0, vpn_1.rank)(vpn_1.VpnState.Deleted)).toBe(true);
+        expect((0, vpn_1.toRank)(vpn_1.VpnState.Creating) <= (0, vpn_1.toRank)(vpn_1.VpnState.Created)).toBe(true);
+        expect((0, vpn_1.toRank)(vpn_1.VpnState.Created) <= (0, vpn_1.toRank)(vpn_1.VpnState.Provisioning)).toBe(true);
+        expect((0, vpn_1.toRank)(vpn_1.VpnState.Provisioning) <= (0, vpn_1.toRank)(vpn_1.VpnState.Running)).toBe(true);
+        expect((0, vpn_1.toRank)(vpn_1.VpnState.Paused) <= (0, vpn_1.toRank)(vpn_1.VpnState.Running)).toBe(true);
+        expect((0, vpn_1.toRank)(vpn_1.VpnState.Running) <= (0, vpn_1.toRank)(vpn_1.VpnState.Deprovisioning)).toBe(true);
+        expect((0, vpn_1.toRank)(vpn_1.VpnState.Deprovisioning) <= (0, vpn_1.toRank)(vpn_1.VpnState.Deleted)).toBe(true);
+    });
+    it('should check that state == fromRank(toRank(state))', async () => {
+        Object.values(vpn_1.VpnState).forEach(state => {
+            expect(state === (0, vpn_1.fromRank)((0, vpn_1.toRank)(state))).toBe(true);
+        });
     });
 });
 describe('Testing Vpn constructors', () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mytmpvpn/mytmpvpn-common",
-  "version": "4.0.1",
+  "version": "5.0.0",
   "description": "Common library for all MyTmpVpn related projects",
   "types": "dist/index.d.ts",
   "files": [