hcloud-sdk 0.0.15 → 14.13.2

package/package.json

@@ -1,9 +1,18 @@
 {
   "name": "hcloud-sdk",
-  "version": "0.0.15",
+  "version": "14.13.2",
   "description": "hcloud platform sdk",
   "main": "index.js",
   "types": "index.d.ts",
+  "scripts": {
+    "test": "mocha -r ts-node/register tests/**/*.test.ts",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.test.ts\"",
+    "lint": "eslint --max-warnings=0 --fix src/ tests/ --ext .ts",
+    "doc:build": "vuepress build _docs/src",
+    "doc:dev": "vuepress dev _docs/src",
+    "doc:export": "vuepress export _docs/src",
+    "build": "tsc"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/moovit-sp-gmbh/hcloud-sdk-js.git"
@@ -19,32 +28,32 @@
   "author": "moovit-sp-gmbh",
   "homepage": "https://github.com/moovit-sp-gmbh/hcloud-sdk-js#readme",
   "devDependencies": {
-    "@types/chai": "^4.3.1",
-    "@types/mocha": "^9.1.1",
-    "@types/uuid": "^8.3.4",
-    "@types/node": "^18.0.0",
-    "chai": "^4.3.6",
-    "dayjs": "^1.11.3",
-    "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",
-    "uuid": "^8.3.2",
-    "vuepress": "^1.9.7",
-    "vuepress-theme-default-prefers-color-scheme": "^2.0.0"
+    "@commitlint/cli": "^18.6.1",
+    "@commitlint/config-conventional": "^18.6.3",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "@types/chai": "^4.3.17",
+    "@types/mocha": "^10.0.7",
+    "@types/node": "^20.14.8",
+    "@typescript-eslint/eslint-plugin": "^7.0.2",
+    "@typescript-eslint/parser": "^7.0.2",
+    "chai": "^4.5.0",
+    "conventional-changelog-conventionalcommits": "^8.0.0",
+    "dayjs": "^1.11.12",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^8.10.0",
+    "eslint-plugin-import": "^2.29.1",
+    "mocha": "^10.7.3",
+    "prettier": "^3.3.3",
+    "semantic-release": "^23.1.1",
+    "semantic-release-telegram": "^1.6.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.4"
   },
   "dependencies": {
-    "axios": "^0.27.2"
-  },
-  "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"
+    "axios": "^1.7.3",
+    "nats": "^2.28.2",
+    "nats.ws": "^1.29.2"
   }
-}
+}

package/lib/base.d.ts

@@ -1,12 +0,0 @@
-export interface Options {
-    api: string;
-    auditor?: {
-        queue?: {
-            executionInterval?: number;
-        };
-    };
-}
-export default abstract class Base {
-    protected opts: Options;
-    constructor(opts: Options);
-}

package/lib/base.js

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

package/lib/hcloud.d.ts

@@ -1,11 +0,0 @@
-import base, { Options } from "./base";
-import IDPService from "./service/IDP";
-import AuditorService from "./service/Auditor";
-import High5Service from "./service/High5";
-export default class hcloud extends base {
-    Auditor: AuditorService;
-    High5: High5Service;
-    IDP: IDPService;
-    constructor(opts: Options);
-    setAuthToken(token: string): hcloud;
-}

package/lib/hcloud.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const base_1 = require("./base");
-const IDP_1 = require("./service/IDP");
-const Auditor_1 = require("./service/Auditor");
-const High5_1 = require("./service/High5");
-const axios_1 = require("axios");
-const package_json_1 = require("../package.json");
-// tslint:disable-next-line
-class hcloud extends base_1.default {
-    constructor(opts) {
-        super(opts);
-        this.Auditor = new Auditor_1.default(this.opts);
-        this.High5 = new High5_1.default(this.opts);
-        this.IDP = new IDP_1.default(this.opts);
-        axios_1.default.defaults.headers.common = {
-            "User-Agent": "hcloud-sdk-js/v" + package_json_1.version,
-        };
-    }
-    setAuthToken(token) {
-        axios_1.default.defaults.headers.common = Object.assign(axios_1.default.defaults.headers.common, {
-            Authorization: token,
-        });
-        return this;
-    }
-}
-exports.default = hcloud;

package/lib/interfaces/Auditor.d.ts

@@ -1,40 +0,0 @@
-export declare enum Level {
-    INFO = "info",
-    WARN = "warn",
-    ERROR = "error",
-    DEBUG = "debug"
-}
-export declare enum Origin {
-    IDP = "idp",
-    High5 = "high5"
-}
-export declare enum Event {
-    Login = "login",
-    Logout = "logout",
-    User = "user",
-    Organization = "organization",
-    App = "app",
-    Event = "event",
-    Stream = "stream"
-}
-export declare enum Type {
-    Read = "read",
-    Create = "create",
-    Update = "update",
-    Delete = "delete",
-    Execute = "execute",
-    Connect = "connect",
-    Disconnect = "disconnect",
-    Add = "add",
-    Remove = "remove"
-}
-export interface AuditLog {
-    level: Level;
-    origin: Origin;
-    organization?: string;
-    event: Event;
-    user: string;
-    type?: Type;
-    timestamp: number;
-    message?: any;
-}

package/lib/interfaces/Global.d.ts

@@ -1,8 +0,0 @@
-export interface Version {
-    version: string;
-}
-export interface ErrorMessage {
-    code: string;
-    error: string;
-    message: string;
-}

package/lib/interfaces/IDP.d.ts

@@ -1,9 +0,0 @@
-export interface User {
-    _id: string;
-    name: string;
-    email: string;
-    company: string;
-}
-export interface Token {
-    token: string;
-}

package/lib/service/Auditor.d.ts

@@ -1,42 +0,0 @@
-import base from "../base";
-import { AuditLog } from "../interfaces/Auditor";
-import { Version } from "../interfaces/Global";
-export default class Auditor extends base {
-    private queueExecutionInterval;
-    private logQueue;
-    private logQueueTimer;
-    /**
-     * Version requests the endpoint version
-     * @returns Version object
-     */
-    version: () => Promise<Version>;
-    /**
-     * GetAuditLog requests logs from
-     * @param organizationId an optional organization ID to receive audit logs for
-     * @param limit an opitional response limit (1-1000; dafaults to 500)
-     * @param page an opitional page to skip certain results (page * limit; defaults to 0)
-     * @returns User object
-     */
-    getAuditLogs: (organizationId: string | null, limit: number | null, page: number | null) => Promise<AuditLog[]>;
-    /**
-     * AddAuditLogs adds log entries
-     *
-     * THIS ENDPOINT WORKS INTERNALLY ONLY
-     *
-     * CAN ONLY BE USED FROM BACKENDS WITHIN THE hcloud DEPLOYMENT AS THE ENDPOINT IS NOT PUBLICLY EXPOSED
-     * @param logs array (add multiple logs entries at once)
-     * @returns AuditLog array
-     */
-    addAuditLogs: (logs: AuditLog[]) => Promise<AuditLog[]>;
-    /**
-     * QueueAuditLogs adds log entries to a queue that will be processed periodically
-     *
-     * THIS COMES WITH DOWNSIDE OF LOG TIMESTAMPS BEING INACCURATE AS THEY ARE CREATED BY THE Auditor SERVER
-     *
-     * TIMESTAMPS MIGHT DIFFER AS MUCH AS: this.opts.auditor.queue.executionInterval || 500
-     * @param logs array (add multiple logs entries at once)
-     */
-    queueAuditLogs: (logs: AuditLog[]) => Promise<void>;
-    private startQueue;
-    private getEndpoint;
-}

package/lib/service/Auditor.js

@@ -1,101 +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 base_1 = require("../base");
-const axios_1 = require("axios");
-class Auditor extends base_1.default {
-    constructor() {
-        var _a, _b;
-        super(...arguments);
-        this.queueExecutionInterval = ((_b = (_a = this.opts.auditor) === null || _a === void 0 ? void 0 : _a.queue) === null || _b === void 0 ? void 0 : _b.executionInterval) || 500;
-        this.logQueue = [];
-        /**
-         * Version requests the endpoint version
-         * @returns Version object
-         */
-        this.version = () => __awaiter(this, void 0, void 0, function* () {
-            const resp = yield axios_1.default.get(this.getEndpoint("/v1/version"), {}).catch((err) => {
-                throw err;
-            });
-            return resp.data;
-        });
-        /**
-         * GetAuditLog requests logs from
-         * @param organizationId an optional organization ID to receive audit logs for
-         * @param limit an opitional response limit (1-1000; dafaults to 500)
-         * @param page an opitional page to skip certain results (page * limit; defaults to 0)
-         * @returns User object
-         */
-        this.getAuditLogs = (organizationId, limit, page) => __awaiter(this, void 0, void 0, function* () {
-            const parameters = [];
-            let url = "";
-            if (organizationId !== null) {
-                parameters.push("organization=" + organizationId);
-            }
-            if (limit !== null) {
-                parameters.push("limit=" + limit);
-            }
-            if (page !== null) {
-                parameters.push("page=" + page);
-            }
-            if (parameters.length > 0) {
-                url = "?" + parameters.join("&");
-            }
-            const resp = yield axios_1.default.get(this.getEndpoint("/v1/logs") + url, {}).catch((err) => {
-                throw err;
-            });
-            return resp.data;
-        });
-        /**
-         * AddAuditLogs adds log entries
-         *
-         * THIS ENDPOINT WORKS INTERNALLY ONLY
-         *
-         * CAN ONLY BE USED FROM BACKENDS WITHIN THE hcloud DEPLOYMENT AS THE ENDPOINT IS NOT PUBLICLY EXPOSED
-         * @param logs array (add multiple logs entries at once)
-         * @returns AuditLog array
-         */
-        this.addAuditLogs = (logs) => __awaiter(this, void 0, void 0, function* () {
-            const resp = yield axios_1.default.post(this.getEndpoint("/logs"), logs).catch((err) => {
-                throw err;
-            });
-            return resp.data;
-        });
-        /**
-         * QueueAuditLogs adds log entries to a queue that will be processed periodically
-         *
-         * THIS COMES WITH DOWNSIDE OF LOG TIMESTAMPS BEING INACCURATE AS THEY ARE CREATED BY THE Auditor SERVER
-         *
-         * TIMESTAMPS MIGHT DIFFER AS MUCH AS: this.opts.auditor.queue.executionInterval || 500
-         * @param logs array (add multiple logs entries at once)
-         */
-        this.queueAuditLogs = (logs) => __awaiter(this, void 0, void 0, function* () {
-            if (!this.logQueueTimer) {
-                this.startQueue();
-            }
-            this.logQueue = this.logQueue.concat(logs);
-        });
-    }
-    startQueue() {
-        if (!this.logQueueTimer) {
-            this.logQueueTimer = setTimeout(() => {
-                if (this.logQueue.length > 0) {
-                    this.addAuditLogs(this.logQueue);
-                    this.logQueue = [];
-                }
-            }, this.queueExecutionInterval);
-        }
-    }
-    getEndpoint(endpoint) {
-        return `${this.opts.api}/api/auditor${endpoint}`;
-    }
-}
-exports.default = Auditor;

package/lib/service/High5.d.ts

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

package/lib/service/High5.js

@@ -1,9 +0,0 @@
-"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

@@ -1,39 +0,0 @@
-import base from "../base";
-import { Token, User } from "../interfaces/IDP";
-import { Version } from "../interfaces/Global";
-export default class IDP extends base {
-    /**
-     * Version requests the endpoint version
-     * @returns Version object
-     */
-    version: () => Promise<Version>;
-    /**
-     * 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

@@ -1,84 +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 base_1 = require("../base");
-const axios_1 = require("axios");
-class IDP extends base_1.default {
-    constructor() {
-        super(...arguments);
-        /**
-         * Version requests the endpoint version
-         * @returns Version object
-         */
-        this.version = () => __awaiter(this, void 0, void 0, function* () {
-            const resp = yield axios_1.default.get(this.getEndpoint("/v1/version"), {}).catch((err) => {
-                throw err;
-            });
-            return resp.data;
-        });
-        /**
-         * Authorize validates a token
-         * @param token
-         * @returns User object
-         */
-        this.authorize = () => __awaiter(this, void 0, void 0, function* () {
-            const resp = yield axios_1.default.get(this.getEndpoint("/v1/authorize"), {}).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/authenticate"), { 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/authenticate"), { email: email, password: password }).catch((err) => {
-                throw err;
-            });
-            return resp.data;
-        });
-    }
-    getEndpoint(endpoint) {
-        return `${this.opts.api}/api/account${endpoint}`;
-    }
-}
-exports.default = IDP;