@mytmpvpn/mytmpvpn-common 2.1.2 → 2.3.0

package/dist/src/models/peanuts.js

@@ -3,6 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PEANUTS_CONFIG = void 0;
 const PEANUTS_CONFIG = {
     min: 5,
-    max: 100
+    max: 1000
 };
 exports.PEANUTS_CONFIG = PEANUTS_CONFIG;

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

@@ -15,6 +15,7 @@ declare enum VpnType {
 interface VpnConfig {
     type: VpnType;
     maxPeanuts: number;
+    terminationDate?: Date;
 }
 interface VpnMetrics {
     duration: number;

package/dist/src/models/vpn.js

@@ -35,6 +35,12 @@ function throwIfNotValidVpnId(vpnId) {
         throw new Error(`Incorrect vpnId: \'${vpnId}\'`);
     }
 }
+function throwIfNotValidTerminationDate(terminationDate) {
+    // Make sure the given date is not in the past
+    if (terminationDate.getTime() < new Date().getTime()) {
+        throw new Error(`TerminationDate must be in the future: \'${terminationDate}\'`);
+    }
+}
 function newVpn(region, config, state) {
     // e.g: ap-northeast-3
     if (!/[a-z]{2}-[a-z]+-[1-9]+/.test(region)) {
@@ -44,6 +50,9 @@ function newVpn(region, config, state) {
     const vpnId = `${dateToId(createdAt)}@${region}`;
     // Assert we will be able to deserialize later on...
     throwIfNotValidVpnId(vpnId);
+    if (config.terminationDate) {
+        throwIfNotValidTerminationDate(config.terminationDate);
+    }
     return {
         vpnId,
         createdAt,

package/dist/test/models.test.js

@@ -20,7 +20,7 @@ describe('Testing Vpn constructors', () => {
         expect(() => (0, vpn_1.newVpn)('foo', { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard }, vpn_1.VpnState.Created))
             .toThrow(new Error("Incorrect region: \'foo\'"));
     });
-    it('Should create vpn with all fields set', async () => {
+    it('Should create vpn with all mandatory fields set', async () => {
         const vpn = (0, vpn_1.newVpn)('az-test-7', { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard }, vpn_1.VpnState.Created);
         expect(vpn.createdAt).toBeDefined();
         expect(vpn.region).toEqual('az-test-7');
@@ -28,12 +28,26 @@ describe('Testing Vpn constructors', () => {
         expect(vpn.config).toEqual({ maxPeanuts: -1, type: vpn_1.VpnType.WireGuard });
         expect(vpn.vpnId).toBeDefined();
     });
-    it('Should deserialize a vpn with all fields set', async () => {
-        const vpn = (0, vpn_1.getVpnFrom)('20030902012345678@az-test-7', vpn_1.VpnState.Created, { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard });
+    it('Should create vpn with optional fields set', async () => {
+        const terminationDate = new Date(new Date().getTime() + 3600 * 1000);
+        const vpn = (0, vpn_1.newVpn)('az-test-7', {
+            maxPeanuts: -1,
+            type: vpn_1.VpnType.WireGuard,
+            terminationDate
+        }, vpn_1.VpnState.Created);
+        expect(vpn.createdAt).toBeDefined();
+        expect(vpn.region).toEqual('az-test-7');
+        expect(vpn.state).toEqual(vpn_1.VpnState.Created);
+        expect(vpn.config).toEqual({ maxPeanuts: -1, type: vpn_1.VpnType.WireGuard, terminationDate });
+        expect(vpn.vpnId).toBeDefined();
+    });
+    it('Should deserialize a vpn with all mandatory fields set', async () => {
+        const terminationDate = new Date(new Date().getTime() + 3600 * 1000);
+        const vpn = (0, vpn_1.getVpnFrom)('20030902012345678@az-test-7', vpn_1.VpnState.Created, { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard, terminationDate });
         expect(vpn.createdAt).toEqual(new Date('2003-09-02T01:23:45.678Z'));
         expect(vpn.region).toEqual('az-test-7');
         expect(vpn.state).toEqual(vpn_1.VpnState.Created);
-        expect(vpn.config).toEqual({ maxPeanuts: -1, type: vpn_1.VpnType.WireGuard });
+        expect(vpn.config).toEqual({ maxPeanuts: -1, type: vpn_1.VpnType.WireGuard, terminationDate });
         expect(vpn.vpnId).toBeDefined();
     });
     it('Should shout when vpnId is empty', async () => {
@@ -48,6 +62,11 @@ describe('Testing Vpn constructors', () => {
         expect(() => (0, vpn_1.getVpnFrom)('20030902012345678@test', vpn_1.VpnState.Created, { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard }))
             .toThrow(new Error("Incorrect vpnId: \'20030902012345678@test\'"));
     });
+    it('Should shout when termination is in the past', async () => {
+        const wrongTerminationDate = new Date(new Date().getTime() - 3600 * 1000);
+        expect(() => (0, vpn_1.newVpn)('az-test-7', { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard, terminationDate: wrongTerminationDate }, vpn_1.VpnState.Created))
+            .toThrow(new Error(`TerminationDate must be in the future: \'${wrongTerminationDate}\'`));
+    });
 });
 describe('Testing vpnId to Wireguard file name functions ', () => {
     it('Should shout when vpnId is empty', async () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mytmpvpn/mytmpvpn-common",
-  "version": "2.1.2",
+  "version": "2.3.0",
   "description": "Common library for all MyTmpVpn related projects",
   "types": "dist/index.d.ts",
   "files": [
@@ -18,6 +18,7 @@
   },
   "scripts": {
     "build": "tsc --build",
+    "lint": "eslint",
     "watch": "tsc -w",
     "test": "jest",
     "link-deps": "echo \"No dependencies, noop; that's fine\"",