@mytmpvpn/mytmpvpn-common 1.1.0

package/README.md

@@ -0,0 +1,47 @@
+# mytmpvpn-common
+
+Common library for the [`MyTmpVpn`](https://gitlab.com/mytmpvpn/) project. 
+
+## Getting started
+
+Follow instructions from [`mytmpvpn-cli`](https://gitlab.com/mytmpvpn/mytmpvpn-cli)
+
+## TODO: write down remaining sections
+
+
+## Description
+Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+## Badges
+On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+
+## Visuals
+Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+
+## Installation
+Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+
+## Usage
+Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+
+## Support
+Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## Project status
+If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

package/dist/src/index.d.ts

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

package/dist/src/index.js

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

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

@@ -0,0 +1,2 @@
+export * as vpn from './vpn';
+export * as uservpn from './uservpn';

package/dist/src/models/index.js

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

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

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+declare const PEANUTS_CONFIG: {
+    min: number;
+    max: number;
+};
+interface PeanutsPack {
+    name: string;
+    url: URL;
+    peanuts: number;
+    price: number;
+}
+export { PEANUTS_CONFIG, PeanutsPack };

package/dist/src/models/peanuts.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PEANUTS_CONFIG = void 0;
+const PEANUTS_CONFIG = {
+    min: 5,
+    max: 100,
+};
+exports.PEANUTS_CONFIG = PEANUTS_CONFIG;

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

@@ -0,0 +1,23 @@
+import * as vpn from './vpn';
+interface UserVpn {
+    userId: string;
+    version: number;
+    vpn: vpn.Vpn;
+}
+type newUserVpnParams = {
+    userId: string;
+    region: string;
+    version?: number;
+    config?: any;
+    state?: any;
+};
+type getUserVpnFromParams = {
+    userId: string;
+    vpnId: string;
+    version?: number;
+    config?: any;
+    state?: any;
+};
+declare function newUserVpn({ userId, region, version, ...rest }: newUserVpnParams): UserVpn;
+declare function getUserVpnFrom({ userId, vpnId, version, ...rest }: getUserVpnFromParams): UserVpn;
+export { UserVpn, newUserVpn, getUserVpnFrom };

package/dist/src/models/uservpn.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserVpnFrom = exports.newUserVpn = void 0;
+const vpn = require("./vpn");
+const INITIAL_VERSION = 0;
+function newUserVpn({ userId, region, version = INITIAL_VERSION, ...rest }) {
+    return {
+        userId: userId,
+        version: 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,
+        vpn: vpn.getVpnFrom(vpnId, rest.state, rest.config)
+    };
+}
+exports.getUserVpnFrom = getUserVpnFrom;

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

@@ -0,0 +1,35 @@
+declare enum VpnState {
+    Failed = "Failed",
+    Creating = "Creating",
+    Created = "Created",
+    Provisioning = "Provisioning",
+    Paused = "Paused",
+    Running = "Running",
+    Deprovisioning = "Deprovisioning",
+    Deleted = "Deleted"
+}
+declare function rank(state: VpnState): number;
+declare enum VpnType {
+    OpenVpn = "openvpn",
+    WireGuard = "wireguard"
+}
+interface VpnConfig {
+    type: VpnType;
+    maxPeanuts: number;
+}
+interface VpnMetrics {
+    duration: number;
+    bytes: number;
+    peanuts: number;
+}
+interface Vpn {
+    vpnId: string;
+    createdAt: Date;
+    region: string;
+    config: VpnConfig;
+    state: VpnState;
+}
+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 };

package/dist/src/models/vpn.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVpnConfigTypes = exports.getVpnFrom = exports.newVpn = exports.rank = exports.VpnType = exports.VpnState = void 0;
+var VpnState;
+(function (VpnState) {
+    VpnState["Failed"] = "Failed";
+    VpnState["Creating"] = "Creating";
+    VpnState["Created"] = "Created";
+    VpnState["Provisioning"] = "Provisioning";
+    VpnState["Paused"] = "Paused";
+    VpnState["Running"] = "Running";
+    VpnState["Deprovisioning"] = "Deprovisioning";
+    VpnState["Deleted"] = "Deleted";
+})(VpnState || (VpnState = {}));
+exports.VpnState = VpnState;
+const vpnStateRank = Object.values(VpnState);
+function rank(state) {
+    return vpnStateRank.indexOf(state);
+}
+exports.rank = rank;
+var VpnType;
+(function (VpnType) {
+    VpnType["OpenVpn"] = "openvpn";
+    VpnType["WireGuard"] = "wireguard";
+})(VpnType || (VpnType = {}));
+exports.VpnType = VpnType;
+function getVpnConfigTypes() {
+    return Object.values(VpnType).filter((item) => {
+        return isNaN(Number(item));
+    });
+}
+exports.getVpnConfigTypes = getVpnConfigTypes;
+function newVpn(region, config, state) {
+    const createdAt = new Date();
+    // 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,
+    };
+}
+exports.newVpn = newVpn;
+function getVpnFrom(vpnId, state, config) {
+    const tokens = vpnId.split('@');
+    if (tokens.length !== 2) {
+        throw new Error(`Bad vpnId format: ${vpnId}`);
+    }
+    const createdAt = idToDate(tokens[0]);
+    const region = tokens[1];
+    return {
+        vpnId: vpnId,
+        createdAt: createdAt,
+        region: region,
+        config: config,
+        state: 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 
+// E.g: SFn refuse the ':'
+// So we need convertor back and forth
+function dateToId(date) {
+    // YYYY-MM-DDTHH:mm:ss.uuuZ -> YYYYMMDDHHmmssuuu
+    return date.toISOString().replace(/[^\d]/g, '');
+}
+function idToDate(id) {
+    // YYYYMMDDHHmmssuuu -> YYYY-MM-DDTHH:mm:ss.uuuZ
+    const year = id.substring(0, 4);
+    const month = id.substring(4, 6);
+    const day = id.substring(6, 8);
+    const hour = id.substring(8, 10);
+    const minute = id.substring(10, 12);
+    const second = id.substring(12, 14);
+    const millis = id.substring(14);
+    return new Date(`${year}-${month}-${day}T${hour}:${minute}:${second}.${millis}Z`);
+}

package/dist/src/utils.d.ts

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

package/dist/src/utils.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sleep = exports.choose = exports.getFromEnvOrThrow = void 0;
+const log = require("loglevel");
+function getFromEnvOrThrow(env) {
+    const result = process.env[env];
+    if (!result) {
+        throw new Error(`${env} unset in environment!`);
+    }
+    log.debug(`Using ${env} = ${result}`);
+    return result;
+}
+exports.getFromEnvOrThrow = getFromEnvOrThrow;
+function choose(choices) {
+    var index = Math.floor(Math.random() * choices.length);
+    return choices[index];
+}
+exports.choose = choose;
+function sleep(millis) {
+    return new Promise(resolve => setTimeout(resolve, millis));
+}
+exports.sleep = sleep;

package/dist/test/models.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/models.test.js

@@ -0,0 +1,13 @@
+"use strict";
+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 () => {
+        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);
+    });
+});

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@mytmpvpn/mytmpvpn-common",
+  "version": "1.1.0",
+  "description": "Common library for all MyTmpVpn related projects",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "exports": {
+    "./*": "./dist/src/*.js"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/src/*"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "watch": "tsc -w",
+    "test": "jest",
+    "link-deps": "echo \"No dependencies, noop; that's fine\"",
+    "clean": "rm -rf dist/"
+  },
+  "keywords": [],
+  "author": "pierre.vigneras@gmail.com",
+  "license": "GNU AGPL",
+  "devDependencies": {
+    "@types/jest": "^27.5.2",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.5",
+    "typescript": "^4.8.4"
+  },
+  "dependencies": {
+    "loglevel": "^1.8.1"
+  }
+}