hcloud-sdk 0.0.11 → 0.0.12

package/lib/dto/IDP.d.ts

@@ -8,7 +8,6 @@ export interface Token {
     token: string;
 }
 export interface ErrorMessage {
-    code: string;
-    error: string;
+    status: number;
     message: string;
 }

package/lib/service/IDP.js

@@ -20,7 +20,7 @@ class IDP extends base_1.default {
          * @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) => {
+            const resp = yield axios_1.default.post(this.getEndpoint("/v1/authorize"), {}, {}).catch((err) => {
                 throw err;
             });
             return resp.data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hcloud-sdk",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "hcloud platform sdk",
   "main": "index.js",
   "types": "index.d.ts",
@@ -46,5 +46,6 @@
     "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/src/lib/base.d.ts

@@ -1,5 +1,10 @@
 export interface Options {
     api: string;
+    auditor?: {
+        queue?: {
+            executionInterval?: number;
+        };
+    };
 }
 export default abstract class Base {
     protected opts: Options;

package/src/lib/hcloud.d.ts

@@ -1,9 +1,11 @@
 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 {
-    IDP: IDPService;
+    Auditor: AuditorService;
     High5: High5Service;
+    IDP: IDPService;
     constructor(opts: Options);
-    setAuthToken(token: string): void;
+    setAuthToken(token: string): hcloud;
 }

package/src/lib/hcloud.js

@@ -2,6 +2,7 @@
 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");
@@ -9,8 +10,9 @@ const package_json_1 = require("../../package.json");
 class hcloud extends base_1.default {
     constructor(opts) {
         super(opts);
-        this.IDP = new IDP_1.default(this.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,
         };
@@ -19,6 +21,7 @@ class hcloud extends base_1.default {
         axios_1.default.defaults.headers.common = Object.assign(axios_1.default.defaults.headers.common, {
             Authorization: token,
         });
+        return this;
     }
 }
 exports.default = hcloud;

package/src/lib/interfaces/Auditor.d.ts

@@ -0,0 +1,40 @@
+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/src/lib/interfaces/Auditor.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Type = exports.Event = exports.Origin = exports.Level = void 0;
+var Level;
+(function (Level) {
+    Level["INFO"] = "info";
+    Level["WARN"] = "warn";
+    Level["ERROR"] = "error";
+    Level["DEBUG"] = "debug";
+})(Level = exports.Level || (exports.Level = {}));
+var Origin;
+(function (Origin) {
+    Origin["IDP"] = "idp";
+    Origin["High5"] = "high5";
+})(Origin = exports.Origin || (exports.Origin = {}));
+var Event;
+(function (Event) {
+    Event["Login"] = "login";
+    Event["Logout"] = "logout";
+    Event["User"] = "user";
+    Event["Organization"] = "organization";
+    Event["App"] = "app";
+    Event["Event"] = "event";
+    Event["Stream"] = "stream";
+})(Event = exports.Event || (exports.Event = {}));
+var Type;
+(function (Type) {
+    Type["Read"] = "read";
+    Type["Create"] = "create";
+    Type["Update"] = "update";
+    Type["Delete"] = "delete";
+    Type["Execute"] = "execute";
+    Type["Connect"] = "connect";
+    Type["Disconnect"] = "disconnect";
+    Type["Add"] = "add";
+    Type["Remove"] = "remove";
+})(Type = exports.Type || (exports.Type = {}));

package/src/lib/interfaces/Global.d.ts

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

package/src/lib/{dto → interfaces}/IDP.d.ts

@@ -7,8 +7,3 @@ export interface User {
 export interface Token {
     token: string;
 }
-export interface ErrorMessage {
-    code: string;
-    error: string;
-    message: string;
-}

package/src/lib/interfaces/IDP.js

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

package/src/lib/service/Auditor.d.ts

@@ -0,0 +1,42 @@
+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/src/lib/service/Auditor.js

@@ -0,0 +1,101 @@
+"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/src/lib/service/IDP.d.ts

@@ -1,6 +1,12 @@
 import base from "../base";
-import { Token, User } from "../dto/IDP";
+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

package/src/lib/service/IDP.js

@@ -14,6 +14,16 @@ 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

package/lib/Axios.d.ts

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

package/lib/Axios.js

@@ -1,23 +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);
-        });
-        this.post = (url, body) => __awaiter(this, void 0, void 0, function* () {
-            return axios_1.default.post(url, body, {});
-        });
-    }
-}
-exports.default = AxiosService;

package/lib/common.d.ts

@@ -1,9 +0,0 @@
-import AxiosService from './Axios';
-export interface options {
-    api: string;
-}
-export default abstract class common {
-    protected opts: options;
-    protected axios: AxiosService;
-    constructor(opts: options);
-}

package/lib/common.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const Axios_1 = require("./Axios");
-// tslint:disable-next-line
-class common {
-    constructor(opts) {
-        this.opts = opts;
-        this.axios = new Axios_1.default();
-    }
-}
-exports.default = common;