@mytmpvpn/mytmpvpn-common 2.3.0 → 3.1.0

package/dist/src/errors.d.ts

@@ -0,0 +1,3 @@
+export declare class MyTmpVpnError extends Error {
+    constructor(msg: string);
+}

package/dist/src/errors.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MyTmpVpnError = void 0;
+class MyTmpVpnError extends Error {
+    constructor(msg) {
+        super(msg); // 'Error' breaks prototype chain here
+        // See: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
+        Object.setPrototypeOf(this, new.target.prototype); // restore prototype chain
+    }
+}
+exports.MyTmpVpnError = MyTmpVpnError;

package/dist/src/index.d.ts

@@ -1,2 +1,3 @@
 export * as utils from './utils';
 export * as models from './models';
+export * as errors from './errors';

package/dist/src/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.models = exports.utils = void 0;
+exports.errors = exports.models = exports.utils = void 0;
 exports.utils = require("./utils");
 exports.models = require("./models");
+exports.errors = require("./errors");

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

@@ -20,4 +20,5 @@ interface getUserVpnFromParams {
 }
 declare function newUserVpn({ userId, region, version, ...rest }: newUserVpnParams): UserVpn;
 declare function getUserVpnFrom({ userId, vpnId, version, ...rest }: getUserVpnFromParams): UserVpn;
-export { type UserVpn, newUserVpn, getUserVpnFrom };
+declare function jsonToUserVpn(json: any): UserVpn;
+export { type UserVpn, newUserVpn, getUserVpnFrom, jsonToUserVpn };

package/dist/src/models/uservpn.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUserVpnFrom = exports.newUserVpn = void 0;
+exports.jsonToUserVpn = exports.getUserVpnFrom = exports.newUserVpn = void 0;
 const vpn = require("./vpn");
 const INITIAL_VERSION = 0;
 function newUserVpn({ userId, region, version = INITIAL_VERSION, ...rest }) {
@@ -19,3 +19,18 @@ function getUserVpnFrom({ userId, vpnId, version = INITIAL_VERSION, ...rest }) {
     };
 }
 exports.getUserVpnFrom = getUserVpnFrom;
+function jsonToUserVpn(json) {
+    const parsed = JSON.parse(json, (key, value) => {
+        if (key === 'createdAt') {
+            return new Date(value);
+        }
+        return value;
+    });
+    const result = {
+        userId: parsed.userId,
+        version: parsed.version,
+        vpn: parsed.vpn
+    };
+    return parsed;
+}
+exports.jsonToUserVpn = jsonToUserVpn;

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

@@ -12,10 +12,12 @@ declare function rank(state: VpnState): number;
 declare enum VpnType {
     WireGuard = "wireguard"
 }
+declare const MIN_DELETE_AFTER: number;
+declare const MAX_DELETE_AFTER: number;
 interface VpnConfig {
     type: VpnType;
     maxPeanuts: number;
-    terminationDate?: Date;
+    deleteAfter?: number;
 }
 interface VpnMetrics {
     duration: number;
@@ -30,7 +32,8 @@ interface Vpn {
     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 };
+export { VpnState, type VpnMetrics, VpnType, type VpnConfig, type Vpn, rank, newVpn, getVpnFrom, getVpnConfigTypes, vpnIdToWgFileName, MIN_DELETE_AFTER, MAX_DELETE_AFTER, throwIfNotValidDeleteAfter };

package/dist/src/models/vpn.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.vpnIdToWgFileName = exports.getVpnConfigTypes = exports.getVpnFrom = exports.newVpn = exports.rank = exports.VpnType = exports.VpnState = void 0;
+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;
+const errors_1 = require("../errors");
 var VpnState;
 (function (VpnState) {
     VpnState["Failed"] = "Failed";
@@ -23,6 +24,10 @@ var 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;
 function getVpnConfigTypes() {
     return Object.values(VpnType).filter((item) => {
         return isNaN(Number(item));
@@ -32,27 +37,37 @@ exports.getVpnConfigTypes = getVpnConfigTypes;
 function throwIfNotValidVpnId(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 Error(`Incorrect vpnId: \'${vpnId}\'`);
+        throw new errors_1.MyTmpVpnError(`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 throwIfNotValidDeleteAfter(deleteAfter) {
+    if (deleteAfter === undefined) {
+        return;
+    }
+    if (isNaN(deleteAfter)) {
+        return;
+    }
+    if (!isFinite(deleteAfter)) {
+        throw new errors_1.MyTmpVpnError(`deleteAfter must be finite: ${deleteAfter}`);
+    }
+    if (deleteAfter < MIN_DELETE_AFTER) {
+        throw new errors_1.MyTmpVpnError(`deleteAfter must be greater than ${MIN_DELETE_AFTER}: ${deleteAfter}`);
+    }
+    if (deleteAfter > MAX_DELETE_AFTER) {
+        throw new errors_1.MyTmpVpnError(`deleteAfter must be lesser than ${MAX_DELETE_AFTER}: ${deleteAfter}`);
     }
 }
+exports.throwIfNotValidDeleteAfter = throwIfNotValidDeleteAfter;
 function newVpn(region, config, state) {
     // e.g: ap-northeast-3
     if (!/[a-z]{2}-[a-z]+-[1-9]+/.test(region)) {
-        throw new Error(`Incorrect region: \'${region}\'`);
+        throw new errors_1.MyTmpVpnError(`Incorrect region: \'${region}\'`);
     }
     const createdAt = new Date();
     const vpnId = `${dateToId(createdAt)}@${region}`;
     // Assert we will be able to deserialize later on...
     throwIfNotValidVpnId(vpnId);
-    if (config.terminationDate) {
-        throwIfNotValidTerminationDate(config.terminationDate);
-    }
+    throwIfNotValidDeleteAfter(config.deleteAfter);
     return {
         vpnId,
         createdAt,
@@ -64,9 +79,10 @@ function newVpn(region, config, state) {
 exports.newVpn = newVpn;
 function getVpnFrom(vpnId, state, config) {
     throwIfNotValidVpnId(vpnId);
+    throwIfNotValidDeleteAfter(config.deleteAfter);
     const tokens = vpnId.split('@');
     if (tokens.length !== 2) {
-        throw new Error(`Incorrect vpnId: ${vpnId}`);
+        throw new errors_1.MyTmpVpnError(`Incorrect vpnId: ${vpnId}`);
     }
     /* eslint-disable @typescript-eslint/no-non-null-assertion */
     const createdAt = idToDate(tokens[0]);

package/dist/test/models.test.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const uservpn_1 = require("../src/models/uservpn");
+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 () => {
@@ -14,11 +16,11 @@ describe('Testing VpnState', () => {
 describe('Testing Vpn constructors', () => {
     it('Should shout when regions is empty', async () => {
         expect(() => (0, vpn_1.newVpn)('', { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard }, vpn_1.VpnState.Created))
-            .toThrow(new Error("Incorrect region: \'\'"));
+            .toThrow(new errors_1.MyTmpVpnError("Incorrect region: \'\'"));
     });
     it('Should shout when regions is bad format', async () => {
         expect(() => (0, vpn_1.newVpn)('foo', { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard }, vpn_1.VpnState.Created))
-            .toThrow(new Error("Incorrect region: \'foo\'"));
+            .toThrow(new errors_1.MyTmpVpnError("Incorrect region: \'foo\'"));
     });
     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);
@@ -29,56 +31,109 @@ describe('Testing Vpn constructors', () => {
         expect(vpn.vpnId).toBeDefined();
     });
     it('Should create vpn with optional fields set', async () => {
-        const terminationDate = new Date(new Date().getTime() + 3600 * 1000);
+        const deleteAfter = vpn_1.MIN_DELETE_AFTER;
         const vpn = (0, vpn_1.newVpn)('az-test-7', {
             maxPeanuts: -1,
             type: vpn_1.VpnType.WireGuard,
-            terminationDate
+            deleteAfter: deleteAfter
         }, 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.config).toEqual({ maxPeanuts: -1, type: vpn_1.VpnType.WireGuard, deleteAfter: deleteAfter });
+        expect(vpn.vpnId).toBeDefined();
+    });
+    it('Should create vpn with deleteAfter set to NaN', async () => {
+        const deleteAfter = Number.NaN;
+        const vpn = (0, vpn_1.newVpn)('az-test-7', {
+            maxPeanuts: -1,
+            type: vpn_1.VpnType.WireGuard,
+            deleteAfter: deleteAfter
+        }, 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, deleteAfter: deleteAfter });
         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 });
+        const deleteAfter = vpn_1.MIN_DELETE_AFTER;
+        const vpn = (0, vpn_1.getVpnFrom)('20030902012345678@az-test-7', vpn_1.VpnState.Created, { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard, deleteAfter: deleteAfter });
         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, terminationDate });
+        expect(vpn.config).toEqual({ maxPeanuts: -1, type: vpn_1.VpnType.WireGuard, deleteAfter: deleteAfter });
         expect(vpn.vpnId).toBeDefined();
     });
+    it('Should deserialize a vpn with deleteAfter set to NaN', async () => {
+        const deleteAfter = Number.NaN;
+        const vpn = (0, vpn_1.getVpnFrom)('20030902012345678@az-test-7', vpn_1.VpnState.Created, { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard, deleteAfter: deleteAfter });
+        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, deleteAfter: deleteAfter });
+        expect(vpn.vpnId).toBeDefined();
+    });
+    it('Should deserialize a json vpn with all fields set', async () => {
+        const originalVpn = (0, uservpn_1.newUserVpn)({
+            userId: 'myId',
+            region: 'az-test-7',
+            version: 1,
+            config: {
+                maxPeanuts: -1,
+                type: vpn_1.VpnType.WireGuard,
+                deleteAfter: vpn_1.MIN_DELETE_AFTER
+            },
+            state: vpn_1.VpnState.Created,
+        });
+        const json = JSON.stringify(originalVpn);
+        const userVpn = (0, uservpn_1.jsonToUserVpn)(json);
+        expect(userVpn).toEqual(originalVpn);
+    });
     it('Should shout when vpnId is empty', async () => {
         expect(() => (0, vpn_1.getVpnFrom)('', vpn_1.VpnState.Created, { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard }))
-            .toThrow(new Error("Incorrect vpnId: \'\'"));
+            .toThrow(new errors_1.MyTmpVpnError("Incorrect vpnId: \'\'"));
     });
     it('Should shout when vpnId has bad format', async () => {
         expect(() => (0, vpn_1.getVpnFrom)('foo', vpn_1.VpnState.Created, { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard }))
-            .toThrow(new Error("Incorrect vpnId: \'foo\'"));
+            .toThrow(new errors_1.MyTmpVpnError("Incorrect vpnId: \'foo\'"));
     });
     it('Should shout when vpnId does not hold a region in good format', async () => {
         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\'"));
+            .toThrow(new errors_1.MyTmpVpnError("Incorrect vpnId: \'20030902012345678@test\'"));
+    });
+    it('Should shout when deleteAfter is lower than MIN', async () => {
+        const wrongDeleteAfter = vpn_1.MIN_DELETE_AFTER - 1;
+        expect(() => (0, vpn_1.newVpn)('az-test-7', { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard, deleteAfter: wrongDeleteAfter }, vpn_1.VpnState.Created))
+            .toThrow(new errors_1.MyTmpVpnError(`deleteAfter must be greater than ${vpn_1.MIN_DELETE_AFTER}: ${wrongDeleteAfter}`));
+    });
+    it('Should shout when deleteAfter is greater than MAX', async () => {
+        const wrongDeleteAfter = vpn_1.MAX_DELETE_AFTER + 1;
+        expect(() => (0, vpn_1.newVpn)('az-test-7', { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard, deleteAfter: wrongDeleteAfter }, vpn_1.VpnState.Created))
+            .toThrow(new errors_1.MyTmpVpnError(`deleteAfter must be lesser than ${vpn_1.MAX_DELETE_AFTER}: ${wrongDeleteAfter}`));
+    });
+    it('Should shout when deleteAfter is positive infinity', async () => {
+        const wrongdeleteAfter = Number.POSITIVE_INFINITY;
+        expect(() => (0, vpn_1.newVpn)('az-test-7', { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard, deleteAfter: wrongdeleteAfter }, vpn_1.VpnState.Created))
+            .toThrow(new errors_1.MyTmpVpnError(`deleteAfter must be finite: ${wrongdeleteAfter}`));
     });
-    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}\'`));
+    it('Should shout when deleteAfter is negative infinity', async () => {
+        const wrongdeleteAfter = Number.NEGATIVE_INFINITY;
+        expect(() => (0, vpn_1.newVpn)('az-test-7', { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard, deleteAfter: wrongdeleteAfter }, vpn_1.VpnState.Created))
+            .toThrow(new errors_1.MyTmpVpnError(`deleteAfter must be finite: ${wrongdeleteAfter}`));
     });
 });
 describe('Testing vpnId to Wireguard file name functions ', () => {
     it('Should shout when vpnId is empty', async () => {
         expect(() => (0, vpn_1.vpnIdToWgFileName)(''))
-            .toThrow(new Error("Incorrect vpnId: \'\'"));
+            .toThrow(new errors_1.MyTmpVpnError("Incorrect vpnId: \'\'"));
     });
     it('Should shout when vpnId is bad format', async () => {
         expect(() => (0, vpn_1.vpnIdToWgFileName)('foo'))
-            .toThrow(new Error("Incorrect vpnId: \'foo\'"));
+            .toThrow(new errors_1.MyTmpVpnError("Incorrect vpnId: \'foo\'"));
     });
     it('Should shout when region has bad format', async () => {
         expect(() => (0, vpn_1.vpnIdToWgFileName)('20030902012345678@test'))
-            .toThrow(new Error("Incorrect vpnId: \'20030902012345678@test\'"));
+            .toThrow(new errors_1.MyTmpVpnError("Incorrect vpnId: \'20030902012345678@test\'"));
     });
 });

package/package.json

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