@mytmpvpn/mytmpvpn-common 1.3.0 → 2.0.0

package/dist/.eslintrc.d.ts

@@ -0,0 +1,24 @@
+export declare namespace env {
+    const browser: boolean;
+    const es2021: boolean;
+}
+declare const _extends: string[];
+export { _extends as extends };
+export declare const parser: string;
+export declare const plugins: string[];
+export declare const root: boolean;
+export declare const overrides: {
+    env: {
+        node: boolean;
+    };
+    files: string[];
+    parserOptions: {
+        sourceType: string;
+    };
+}[];
+export declare namespace parserOptions {
+    const ecmaVersion: string;
+    const project: string;
+    const sourceType: string;
+}
+export declare const rules: {};

package/dist/.eslintrc.js

@@ -0,0 +1,30 @@
+"use strict";
+module.exports = {
+    env: {
+        browser: true,
+        es2021: true
+    },
+    extends: ['standard-with-typescript', 'eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+    parser: '@typescript-eslint/parser',
+    plugins: ['@typescript-eslint'],
+    root: true,
+    overrides: [
+        {
+            env: {
+                node: true
+            },
+            files: [
+                '.eslintrc.{js,cjs}'
+            ],
+            parserOptions: {
+                sourceType: 'script'
+            }
+        }
+    ],
+    parserOptions: {
+        ecmaVersion: 'latest',
+        project: './tsconfig.json',
+        sourceType: 'module'
+    },
+    rules: {}
+};

package/dist/jest.config.d.ts

@@ -0,0 +1,6 @@
+export const testEnvironment: string;
+export const roots: string[];
+export const testMatch: string[];
+export const transform: {
+    '^.+\\.tsx?$': string;
+};

package/dist/jest.config.js

@@ -0,0 +1,9 @@
+"use strict";
+module.exports = {
+    testEnvironment: 'node',
+    roots: ['<rootDir>/test'],
+    testMatch: ['**/*.test.ts'],
+    transform: {
+        '^.+\\.tsx?$': 'ts-jest'
+    }
+};

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: 100
 };
 exports.PEANUTS_CONFIG = PEANUTS_CONFIG;

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

@@ -4,20 +4,20 @@ interface UserVpn {
     version: number;
     vpn: vpn.Vpn;
 }
-type newUserVpnParams = {
+interface newUserVpnParams {
     userId: string;
     region: string;
     version?: number;
-    config?: any;
-    state?: any;
-};
-type getUserVpnFromParams = {
+    config: vpn.VpnConfig;
+    state: vpn.VpnState;
+}
+interface getUserVpnFromParams {
     userId: string;
     vpnId: string;
     version?: number;
-    config?: any;
-    state?: any;
-};
+    config: vpn.VpnConfig;
+    state: vpn.VpnState;
+}
 declare function newUserVpn({ userId, region, version, ...rest }: newUserVpnParams): UserVpn;
 declare function getUserVpnFrom({ userId, vpnId, version, ...rest }: getUserVpnFromParams): UserVpn;
-export { UserVpn, newUserVpn, getUserVpnFrom };
+export { type UserVpn, newUserVpn, getUserVpnFrom };

package/dist/src/models/uservpn.js

@@ -5,16 +5,16 @@ const vpn = require("./vpn");
 const INITIAL_VERSION = 0;
 function newUserVpn({ userId, region, version = INITIAL_VERSION, ...rest }) {
     return {
-        userId: userId,
-        version: version,
+        userId,
+        version,
         vpn: vpn.newVpn(region, rest.config, rest.state)
     };
 }
 exports.newUserVpn = newUserVpn;
 function getUserVpnFrom({ userId, vpnId, version = INITIAL_VERSION, ...rest }) {
     return {
-        userId: userId,
-        version: version,
+        userId,
+        version,
         vpn: vpn.getVpnFrom(vpnId, rest.state, rest.config)
     };
 }

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

@@ -10,7 +10,6 @@ declare enum VpnState {
 }
 declare function rank(state: VpnState): number;
 declare enum VpnType {
-    OpenVpn = "openvpn",
     WireGuard = "wireguard"
 }
 interface VpnConfig {
@@ -32,4 +31,4 @@ interface Vpn {
 declare function getVpnConfigTypes(): VpnType[];
 declare function newVpn(region: string, config: VpnConfig, state: VpnState): Vpn;
 declare function getVpnFrom(vpnId: string, state: VpnState, config: VpnConfig): Vpn;
-export { VpnState, VpnMetrics, VpnType, VpnConfig, Vpn, rank, newVpn, getVpnFrom, getVpnConfigTypes };
+export { VpnState, type VpnMetrics, VpnType, type VpnConfig, type Vpn, rank, newVpn, getVpnFrom, getVpnConfigTypes };

package/dist/src/models/vpn.js

@@ -20,7 +20,6 @@ function rank(state) {
 exports.rank = rank;
 var VpnType;
 (function (VpnType) {
-    VpnType["OpenVpn"] = "openvpn";
     VpnType["WireGuard"] = "wireguard";
 })(VpnType || (VpnType = {}));
 exports.VpnType = VpnType;
@@ -35,11 +34,11 @@ function newVpn(region, config, state) {
     // Replace ':' in the id as it's forbiden in DDB
     const vpnId = `${dateToId(createdAt)}@${region}`;
     return {
-        vpnId: vpnId,
-        createdAt: createdAt,
-        region: region,
-        config: config,
-        state: state,
+        vpnId,
+        createdAt,
+        region,
+        config,
+        state
     };
 }
 exports.newVpn = newVpn;
@@ -48,19 +47,21 @@ function getVpnFrom(vpnId, state, config) {
     if (tokens.length !== 2) {
         throw new Error(`Bad vpnId format: ${vpnId}`);
     }
+    /* eslint-disable @typescript-eslint/no-non-null-assertion */
     const createdAt = idToDate(tokens[0]);
     const region = tokens[1];
+    /* eslint-enable @typescript-eslint/no-non-null-assertion */
     return {
-        vpnId: vpnId,
-        createdAt: createdAt,
-        region: region,
-        config: config,
-        state: state,
+        vpnId,
+        createdAt,
+        region,
+        config,
+        state
     };
 }
 exports.getVpnFrom = getVpnFrom;
-// Using a date from an id is convenient for debugging. 
-// We can't use Date.toISOString() because some characters are forbidden 
+// Using a date from an id is convenient for debugging.
+// We can't use Date.toISOString() because some characters are forbidden
 // E.g: SFn refuse the ':'
 // So we need convertor back and forth
 function dateToId(date) {

package/dist/src/utils.d.ts

@@ -1,4 +1,4 @@
 declare function getFromEnvOrThrow(env: string): string;
 declare function choose(choices: any[]): any;
-declare function sleep(millis: number): Promise<unknown>;
+declare function sleep(millis: number): Promise<void>;
 export { getFromEnvOrThrow, choose, sleep };

package/dist/src/utils.js

@@ -4,19 +4,20 @@ exports.sleep = exports.choose = exports.getFromEnvOrThrow = void 0;
 const log = require("loglevel");
 function getFromEnvOrThrow(env) {
     const result = process.env[env];
-    if (!result) {
+    if (result === null || result === undefined || result.trim() === '') {
         throw new Error(`${env} unset in environment!`);
     }
     log.debug(`Using ${env} = ${result}`);
     return result;
 }
 exports.getFromEnvOrThrow = getFromEnvOrThrow;
+/* eslint-disable-next-line @typescript-eslint/no-explicit-any */
 function choose(choices) {
-    var index = Math.floor(Math.random() * choices.length);
+    const index = Math.floor(Math.random() * choices.length);
     return choices[index];
 }
 exports.choose = choose;
-function sleep(millis) {
-    return new Promise(resolve => setTimeout(resolve, millis));
+async function sleep(millis) {
+    await new Promise(resolve => setTimeout(resolve, millis));
 }
 exports.sleep = sleep;

package/dist/test/models.test.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const vpn_1 = require("../src/models/vpn");
 describe('Testing VpnState', () => {
-    it("should check that all VpnState are ordered properly", async () => {
+    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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mytmpvpn/mytmpvpn-common",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "description": "Common library for all MyTmpVpn related projects",
   "types": "dist/index.d.ts",
   "files": [
@@ -28,9 +28,15 @@
   "license": "GNU AGPL",
   "devDependencies": {
     "@types/jest": "^27.5.2",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "eslint": "^8.46.0",
+    "eslint-config-standard-with-typescript": "^37.0.0",
+    "eslint-plugin-import": "^2.28.0",
+    "eslint-plugin-n": "^16.0.1",
+    "eslint-plugin-promise": "^6.1.1",
     "jest": "^27.5.1",
     "ts-jest": "^27.1.5",
-    "typescript": "^4.8.4"
+    "typescript": "^4.9.5"
   },
   "dependencies": {
     "loglevel": "^1.8.1"