hcloud-sdk 0.0.15 → 0.0.16

package/lib/hcloud.d.ts

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

package/lib/hcloud.js

@@ -4,6 +4,7 @@ const base_1 = require("./base");
 const IDP_1 = require("./service/IDP");
 const Auditor_1 = require("./service/Auditor");
 const High5_1 = require("./service/High5");
+const Mailer_1 = require("./service/Mailer");
 const axios_1 = require("axios");
 const package_json_1 = require("../package.json");
 // tslint:disable-next-line
@@ -13,6 +14,7 @@ class hcloud extends base_1.default {
         this.Auditor = new Auditor_1.default(this.opts);
         this.High5 = new High5_1.default(this.opts);
         this.IDP = new IDP_1.default(this.opts);
+        this.Mailer = new Mailer_1.default(this.opts);
         axios_1.default.defaults.headers.common = {
             "User-Agent": "hcloud-sdk-js/v" + package_json_1.version,
         };

package/lib/interfaces/Auditor.d.ts

@@ -6,7 +6,9 @@ export declare enum Level {
 }
 export declare enum Origin {
     IDP = "idp",
-    High5 = "high5"
+    High5 = "high5",
+    Auditor = "auditor",
+    Mailer = "mailer"
 }
 export declare enum Event {
     Login = "login",
@@ -15,10 +17,12 @@ export declare enum Event {
     Organization = "organization",
     App = "app",
     Event = "event",
-    Stream = "stream"
+    Stream = "stream",
+    Mail = "mail"
 }
 export declare enum Type {
     Read = "read",
+    Write = "write",
     Create = "create",
     Update = "update",
     Delete = "delete",
@@ -26,7 +30,9 @@ export declare enum Type {
     Connect = "connect",
     Disconnect = "disconnect",
     Add = "add",
-    Remove = "remove"
+    Remove = "remove",
+    Send = "send",
+    Receive = "receive"
 }
 export interface AuditLog {
     level: Level;

package/lib/interfaces/Auditor.js

@@ -12,6 +12,8 @@ var Origin;
 (function (Origin) {
     Origin["IDP"] = "idp";
     Origin["High5"] = "high5";
+    Origin["Auditor"] = "auditor";
+    Origin["Mailer"] = "mailer";
 })(Origin = exports.Origin || (exports.Origin = {}));
 var Event;
 (function (Event) {
@@ -22,10 +24,12 @@ var Event;
     Event["App"] = "app";
     Event["Event"] = "event";
     Event["Stream"] = "stream";
+    Event["Mail"] = "mail";
 })(Event = exports.Event || (exports.Event = {}));
 var Type;
 (function (Type) {
     Type["Read"] = "read";
+    Type["Write"] = "write";
     Type["Create"] = "create";
     Type["Update"] = "update";
     Type["Delete"] = "delete";
@@ -34,4 +38,6 @@ var Type;
     Type["Disconnect"] = "disconnect";
     Type["Add"] = "add";
     Type["Remove"] = "remove";
+    Type["Send"] = "send";
+    Type["Receive"] = "receive";
 })(Type = exports.Type || (exports.Type = {}));

package/lib/interfaces/Mail.d.ts

@@ -0,0 +1,29 @@
+export declare enum Template {
+    REGISTER = "register",
+    RESET_PASSWORD = "reset_password"
+}
+export interface Mail {
+    recipients: string[];
+    subject: string;
+}
+export interface MailReplacement {
+    key: string;
+    value: string;
+}
+export interface TemplateMail extends Mail {
+    template: Template;
+    replacements: MailReplacement[];
+}
+/**
+ * @param html base64 encoded html string
+ */
+export interface HtmlMail extends Mail {
+    html: string;
+}
+/**
+ * @param html base64 encoded html string
+ */
+export interface MustacheMail extends Mail {
+    html: string;
+    replacements: MailReplacement[];
+}

package/lib/interfaces/Mail.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Template = void 0;
+var Template;
+(function (Template) {
+    Template["REGISTER"] = "register";
+    Template["RESET_PASSWORD"] = "reset_password";
+})(Template = exports.Template || (exports.Template = {}));

package/lib/service/Auditor.d.ts

@@ -1,10 +1,10 @@
-import base from "../base";
+import base, { Options } from "../base";
 import { AuditLog } from "../interfaces/Auditor";
 import { Version } from "../interfaces/Global";
+import { AuditorInternal } from "./AuditorInternal";
 export default class Auditor extends base {
-    private queueExecutionInterval;
-    private logQueue;
-    private logQueueTimer;
+    internal: AuditorInternal;
+    constructor(opts: Options);
     /**
      * Version requests the endpoint version
      * @returns Version object
@@ -18,25 +18,5 @@ export default class Auditor extends base {
      * @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

@@ -11,12 +11,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const base_1 = require("../base");
 const axios_1 = require("axios");
+const AuditorInternal_1 = require("./AuditorInternal");
 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 = [];
+    constructor(opts) {
+        super(opts);
         /**
          * Version requests the endpoint version
          * @returns Version object
@@ -54,45 +52,7 @@ class Auditor extends base_1.default {
             });
             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);
-        }
+        this.internal = new AuditorInternal_1.AuditorInternal(opts);
     }
     getEndpoint(endpoint) {
         return `${this.opts.api}/api/auditor${endpoint}`;

package/lib/service/AuditorInternal.d.ts

@@ -0,0 +1,28 @@
+import base from "../base";
+import { AuditLog } from "../interfaces/Auditor";
+export declare class AuditorInternal extends base {
+    private queueExecutionInterval;
+    private logQueue;
+    private logQueueTimer;
+    /**
+     * 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/AuditorInternal.js

@@ -0,0 +1,65 @@
+"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 });
+exports.AuditorInternal = void 0;
+const axios_1 = require("axios");
+const base_1 = require("../base");
+class AuditorInternal 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 = [];
+        /**
+         * 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("/v1/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/internal${endpoint}`;
+    }
+}
+exports.AuditorInternal = AuditorInternal;

package/lib/service/Mailer.d.ts

@@ -0,0 +1,13 @@
+import base, { Options } from "../base";
+import { Version } from "../interfaces/Global";
+import MailerInternal from "./MailerInternal";
+export default class Mailer extends base {
+    interal: MailerInternal;
+    constructor(opts: Options);
+    /**
+     * Version requests the endpoint version
+     * @returns Version object
+     */
+    version: () => Promise<Version>;
+    private getEndpoint;
+}

package/lib/service/Mailer.js

@@ -0,0 +1,34 @@
+"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");
+const MailerInternal_1 = require("./MailerInternal");
+class Mailer extends base_1.default {
+    constructor(opts) {
+        super(opts);
+        /**
+         * 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;
+        });
+        this.interal = new MailerInternal_1.default(opts);
+    }
+    getEndpoint(endpoint) {
+        return `${this.opts.api}/api/mailer${endpoint}`;
+    }
+}
+exports.default = Mailer;

package/lib/service/MailerInternal.d.ts

@@ -0,0 +1,32 @@
+import base from "../base";
+import { HtmlMail, MustacheMail, TemplateMail } from "../interfaces/Mail";
+export default class MailerInternal extends base {
+    /**
+     * sendMailMustache sends a new mail based on a mustache html body
+     *
+     * THIS ENDPOINT WORKS INTERNALLY ONLY
+     *
+     * CAN ONLY BE USED FROM BACKENDS WITHIN THE hcloud DEPLOYMENT AS THE ENDPOINT IS NOT PUBLICLY EXPOSED
+     * @param mail TemplateMail
+     */
+    sendMailMustache: (mail: MustacheMail) => Promise<void>;
+    /**
+     * sendMailHtml sends a new mail based on a html body
+     *
+     * THIS ENDPOINT WORKS INTERNALLY ONLY
+     *
+     * CAN ONLY BE USED FROM BACKENDS WITHIN THE hcloud DEPLOYMENT AS THE ENDPOINT IS NOT PUBLICLY EXPOSED
+     * @param mail TemplateMail
+     */
+    sendMailHtml: (mail: HtmlMail) => Promise<void>;
+    /**
+     * sendMailTemplate sends a new mail based on an existing template
+     *
+     * THIS ENDPOINT WORKS INTERNALLY ONLY
+     *
+     * CAN ONLY BE USED FROM BACKENDS WITHIN THE hcloud DEPLOYMENT AS THE ENDPOINT IS NOT PUBLICLY EXPOSED
+     * @param mail TemplateMail
+     */
+    sendMailTemplate: (mail: TemplateMail) => Promise<void>;
+    private getEndpoint;
+}

package/lib/service/MailerInternal.js

@@ -0,0 +1,64 @@
+"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 MailerInternal extends base_1.default {
+    constructor() {
+        super(...arguments);
+        /**
+         * sendMailMustache sends a new mail based on a mustache html body
+         *
+         * THIS ENDPOINT WORKS INTERNALLY ONLY
+         *
+         * CAN ONLY BE USED FROM BACKENDS WITHIN THE hcloud DEPLOYMENT AS THE ENDPOINT IS NOT PUBLICLY EXPOSED
+         * @param mail TemplateMail
+         */
+        this.sendMailMustache = (mail) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield axios_1.default.post(this.getEndpoint("/v1/send/mustache"), mail).catch((err) => {
+                throw err;
+            });
+            return resp.data;
+        });
+        /**
+         * sendMailHtml sends a new mail based on a html body
+         *
+         * THIS ENDPOINT WORKS INTERNALLY ONLY
+         *
+         * CAN ONLY BE USED FROM BACKENDS WITHIN THE hcloud DEPLOYMENT AS THE ENDPOINT IS NOT PUBLICLY EXPOSED
+         * @param mail TemplateMail
+         */
+        this.sendMailHtml = (mail) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield axios_1.default.post(this.getEndpoint("/v1/send/html"), mail).catch((err) => {
+                throw err;
+            });
+            return resp.data;
+        });
+        /**
+         * sendMailTemplate sends a new mail based on an existing template
+         *
+         * THIS ENDPOINT WORKS INTERNALLY ONLY
+         *
+         * CAN ONLY BE USED FROM BACKENDS WITHIN THE hcloud DEPLOYMENT AS THE ENDPOINT IS NOT PUBLICLY EXPOSED
+         * @param mail TemplateMail
+         */
+        this.sendMailTemplate = (mail) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield axios_1.default.post(this.getEndpoint("/v1/send/template"), mail).catch((err) => {
+                throw err;
+            });
+            return resp.data;
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.opts.api}/api/mailer/internal${endpoint}`;
+    }
+}
+exports.default = MailerInternal;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hcloud-sdk",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "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"
 }