hcloud-sdk 0.0.6 → 0.0.9

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 MoovIT Software Products GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1 +1,3 @@
-# hcloud-sdk-js
+# hcloud-sdk
+[![MIT License](https://img.shields.io/badge/license-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Latest Release](https://img.shields.io/npm/v/hcloud-sdk.svg)](https://www.npmjs.com/package/hcloud-sdk)

package/index.d.ts

@@ -1,2 +1,2 @@
-import hcloud from './lib/hcloud';
+import hcloud from "./lib/hcloud";
 export default hcloud;

package/lib/base.d.ts

@@ -0,0 +1,7 @@
+export interface Options {
+    api: string;
+}
+export default abstract class Base {
+    protected opts: Options;
+    constructor(opts: Options);
+}

package/lib/base.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Base {
+    constructor(opts) {
+        this.opts = opts;
+    }
+}
+exports.default = Base;

package/lib/dto/IDP.d.ts

@@ -0,0 +1,13 @@
+export interface User {
+    _id: string;
+    name: string;
+    email: string;
+    company: string;
+}
+export interface Token {
+    token: string;
+}
+export interface ErrorMessage {
+    status: number;
+    message: string;
+}

package/lib/dto/IDP.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/hcloud.d.ts

@@ -1,11 +1,9 @@
-import IDPService from './IDP';
-import AxiosService from './Axios';
-export interface options {
-    api: string;
-}
-export default class hcloud {
-    protected opts: options;
-    protected axios: AxiosService;
+import base, { Options } from "./base";
+import IDPService from "./service/IDP";
+import High5Service from "./service/High5";
+export default class hcloud extends base {
     IDP: IDPService;
-    constructor(opts: options);
+    High5: High5Service;
+    constructor(opts: Options);
+    setAuthToken(token: string): void;
 }

package/lib/hcloud.js

@@ -1,13 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const IDP_1 = require("./IDP");
-const Axios_1 = require("./Axios");
+const base_1 = require("./base");
+const IDP_1 = require("./service/IDP");
+const High5_1 = require("./service/High5");
+const axios_1 = require("axios");
 // tslint:disable-next-line
-class hcloud {
+class hcloud extends base_1.default {
     constructor(opts) {
-        this.opts = opts;
-        this.axios = new Axios_1.default();
+        super(opts);
         this.IDP = new IDP_1.default(this.opts);
+        this.High5 = new High5_1.default(this.opts);
+    }
+    setAuthToken(token) {
+        axios_1.default.defaults.headers.common = {
+            Authorization: token,
+        };
     }
 }
 exports.default = hcloud;

package/lib/service/High5.d.ts

@@ -0,0 +1,4 @@
+import base from "../base";
+export default class High5 extends base {
+    private getEndpoint;
+}

package/lib/service/High5.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const base_1 = require("../base");
+class High5 extends base_1.default {
+    getEndpoint(endpoint) {
+        return `${this.opts.api}/api/high5${endpoint}`;
+    }
+}
+exports.default = High5;

package/lib/service/IDP.d.ts

@@ -0,0 +1,33 @@
+import base from "../base";
+import { Token, User } from "../dto/IDP";
+export default class IDP extends base {
+    /**
+     * Authorize validates a token
+     * @param token
+     * @returns User object
+     */
+    authorize: () => Promise<User>;
+    /**
+     * Register against the identity provider
+     * @param name
+     * @param email
+     * @param password
+     * @returns Bearer Token
+     */
+    register: (name: string, email: string, password: string) => Promise<User>;
+    /**
+     * Authenticate against the identity provider with a given email and password.
+     * @param email
+     * @param password
+     * @returns Bearer Token
+     */
+    authenticate: (email: string, password: string) => Promise<Token>;
+    /**
+     * authenticateReturnUser against the identity provider with a given email and password.
+     * @param email
+     * @param password
+     * @returns User object
+     */
+    authenticateReturnUser: (email: string, password: string) => Promise<User>;
+    private getEndpoint;
+}

package/lib/service/IDP.js

@@ -0,0 +1,74 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const base_1 = require("../base");
+const axios_1 = require("axios");
+class IDP extends base_1.default {
+    constructor() {
+        super(...arguments);
+        /**
+         * Authorize validates a token
+         * @param token
+         * @returns User object
+         */
+        this.authorize = () => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield axios_1.default.post(this.getEndpoint("/v1/authenticate"), {}, {}).catch((err) => {
+                throw err;
+            });
+            return resp.data;
+        });
+        /**
+         * Register against the identity provider
+         * @param name
+         * @param email
+         * @param password
+         * @returns Bearer Token
+         */
+        this.register = (name, email, password) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield axios_1.default
+                .post(this.getEndpoint("/v1/registration"), { name: name, email: email, password: password })
+                .catch((err) => {
+                throw err;
+            });
+            return resp.data;
+        });
+        /**
+         * Authenticate against the identity provider with a given email and password.
+         * @param email
+         * @param password
+         * @returns Bearer Token
+         */
+        this.authenticate = (email, password) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield axios_1.default.post(this.getEndpoint("/v1/authorize"), { email: email, password: password }).catch((err) => {
+                throw err;
+            });
+            // tslint-disable: no-string-literal
+            const token = { token: resp.headers.authorization };
+            return token;
+        });
+        /**
+         * authenticateReturnUser against the identity provider with a given email and password.
+         * @param email
+         * @param password
+         * @returns User object
+         */
+        this.authenticateReturnUser = (email, password) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield axios_1.default.post(this.getEndpoint("/v1/authorize"), { email: email, password: password }).catch((err) => {
+                throw err;
+            });
+            return resp.data;
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.opts.api}/api/account${endpoint}`;
+    }
+}
+exports.default = IDP;

package/package.json

@@ -1,15 +1,9 @@
 {
   "name": "hcloud-sdk",
-  "version": "0.0.6",
+  "version": "0.0.9",
   "description": "hcloud platform sdk",
   "main": "index.js",
   "types": "index.d.ts",
-  "scripts": {
-    "test": "mocha -r ts-node/register test/**/*.test.ts",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "lint": "tslint -p tsconfig.json",
-    "build": "tsc"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/moovit-sp-gmbh/hcloud-sdk-js.git"
@@ -18,7 +12,7 @@
     "hcloud",
     "sdk"
   ],
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/moovit-sp-gmbh/hcloud-sdk-js/issues"
   },
@@ -27,15 +21,30 @@
   "devDependencies": {
     "@types/chai": "^4.3.1",
     "@types/mocha": "^9.1.1",
+    "@types/uuid": "^8.3.4",
     "chai": "^4.3.6",
     "mocha": "^10.0.0",
     "prettier": "^2.6.2",
     "ts-node": "^10.8.0",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typescript": "^4.7.2"
+    "typescript": "^4.7.2",
+    "uuid": "^8.3.2"
   },
   "dependencies": {
-    "axios": "^0.27.2"
-  }
-}
+    "axios": "^0.27.2",
+    "dayjs": "^1.11.3",
+    "vuepress": "^1.9.7",
+    "vuepress-theme-default-prefers-color-scheme": "^2.0.0"
+  },
+  "scripts": {
+    "test": "mocha -r ts-node/register tests/**/*.test.ts",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.test.ts\"",
+    "lint": "tslint -p tsconfig.json",
+    "doc:build": "vuepress build _docs/src",
+    "doc:dev": "vuepress dev _docs/src",
+    "doc:export": "vuepress export _docs/src",
+    "build": "tsc"
+  },
+  "readme": "# hcloud-sdk\n[![MIT License](https://img.shields.io/badge/license-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Latest Release](https://img.shields.io/npm/v/hcloud-sdk.svg)](https://www.npmjs.com/package/hcloud-sdk)\n"
+}

package/lib/Axios.d.ts

@@ -1,4 +0,0 @@
-import { AxiosPromise } from 'axios';
-export default class AxiosService {
-    get: (url: string) => Promise<AxiosPromise>;
-}

package/lib/Axios.js

@@ -1,20 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const axios_1 = require("axios");
-class AxiosService {
-    constructor() {
-        this.get = (url) => __awaiter(this, void 0, void 0, function* () {
-            return axios_1.default.get(url);
-        });
-    }
-}
-exports.default = AxiosService;

package/lib/IDP.d.ts

@@ -1,4 +0,0 @@
-import hcloud from './hcloud';
-export default class IDPService extends hcloud {
-    authenticate: () => Promise<string>;
-}

package/lib/IDP.js

@@ -1,22 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const hcloud_1 = require("./hcloud");
-class IDPService extends hcloud_1.default {
-    constructor() {
-        super(...arguments);
-        this.authenticate = () => __awaiter(this, void 0, void 0, function* () {
-            // const resp = await this.axios.get('https://google.com');
-            return this.opts.api;
-        });
-    }
-}
-exports.default = IDPService;