hcloud-sdk 0.0.16 → 14.13.2

package/index.d.ts

@@ -1,2 +1,3 @@
-import hcloud from "./lib/hcloud";
-export default hcloud;
+import { HCloud } from "./lib/Hcloud";
+import { isHCloudError } from "./lib/helper/ErrorHelper";
+export { HCloud as default, isHCloudError };

package/index.js

@@ -1,4 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const hcloud_1 = require("./lib/hcloud");
-exports.default = hcloud_1.default;
+exports.isHCloudError = exports.default = void 0;
+const Hcloud_1 = require("./lib/Hcloud");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return Hcloud_1.HCloud; } });
+const ErrorHelper_1 = require("./lib/helper/ErrorHelper");
+Object.defineProperty(exports, "isHCloudError", { enumerable: true, get: function () { return ErrorHelper_1.isHCloudError; } });

package/lib/Base.d.ts

@@ -0,0 +1,26 @@
+import { AxiosInstance } from "axios";
+export interface HcloudLogger {
+    info(msg: string, ...args: any): void;
+    debug(msg: string, ...args: any): void;
+    warn(msg: string, ...args: any): void;
+    error(msg: string, ...args: any): void;
+}
+export interface Options {
+    server: string;
+    auditor?: {
+        queue?: {
+            executionInterval?: number;
+        };
+    };
+    agent?: {
+        server: string;
+    };
+    logger?: HcloudLogger;
+}
+export default abstract class Base {
+    protected options: Options;
+    protected axios: AxiosInstance;
+    constructor(options: Options, axios: AxiosInstance);
+    protected abstract getEndpoint(endpoint: string): string;
+    protected get logger(): HcloudLogger | undefined;
+}

package/lib/Base.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Base {
+    constructor(options, axios) {
+        this.options = options;
+        this.axios = axios;
+    }
+    get logger() {
+        return this.options.logger;
+    }
+}
+exports.default = Base;

package/lib/Hcloud.d.ts

@@ -0,0 +1,80 @@
+import { AxiosInstance } from "axios";
+import { HcloudLogger, Options } from "./Base";
+import AgentService from "./service/agent";
+import AuditorService from "./service/auditor";
+import BouncerService from "./service/bouncer";
+import DaliService from "./service/dali";
+import FuseService from "./service/fuse";
+import High5Service from "./service/high5";
+import IdpService from "./service/idp";
+import MailerService from "./service/mailer";
+import MothershipService from "./service/mothership";
+import NatsService from "./service/nats";
+export declare class HCloud {
+    Agent: AgentService;
+    Auditor: AuditorService;
+    Bouncer: BouncerService;
+    High5: High5Service;
+    Idp: IdpService;
+    Fuse: FuseService;
+    Dali: DaliService;
+    Mailer: MailerService;
+    Mothership: MothershipService;
+    Nats: NatsService;
+    private options;
+    private axios;
+    constructor(options: Options);
+    /**
+     * Sets the server url that the SDK shall do a request to.
+     */
+    setServer(server: string): HCloud;
+    /**
+     * Returns the currently set server url that the SDK will make requests to.
+     */
+    getServer(): string;
+    /**
+     * Authenticate against hcloud with username and password, as an alternative to using a bearer auth token.
+     */
+    setBasicAuth(username: string, password: string): HCloud;
+    /**
+     * Sets the auth token used for authentication against hcloud. The provided token must be a bearer token.
+     */
+    setAuthToken(token: string): HCloud;
+    /**
+     * Returns the currently set auth token.
+     */
+    getAuthToken(): string | undefined;
+    /**
+     * Sets the correlationID which will be sent to hcloud with each request and appears in all
+     * logs that are made on behalf of this request, making it easier to debug the application.
+     */
+    setCorrelationId(correlationId: string): HCloud;
+    /**
+     * Returns the currently set correlationID.
+     */
+    getCorrelationId(): string | undefined;
+    /**
+     * Returns the currently set logger.
+     */
+    getLogger(): HcloudLogger | undefined;
+    /**
+     * Sets a logger used to receive logs from hcloud.
+     */
+    setLogger(logger: HcloudLogger): this;
+    /**
+     * Send various no-cache headers globally with every request
+     */
+    disableCachingGlobally(): HCloud;
+    /**
+     * getAxios returns the active axios instance
+     * Use it to add additional request/response interceptors
+     * @returns {AxiosInstance} AxiosInstance
+     */
+    getAxios(): AxiosInstance;
+    /**
+     * setAxios overwrites the existing axios instance
+     * Use it to add a caching layer to axios
+     * @returns {AxiosInstance} The new AxiosInstance
+     */
+    setAxios(axios: AxiosInstance): AxiosInstance;
+}

package/lib/Hcloud.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HCloud = void 0;
+const axios_1 = require("axios");
+const package_json_1 = require("../package.json");
+const ErrorHelper_1 = require("./helper/ErrorHelper");
+const axios_2 = require("./interfaces/axios");
+const agent_1 = require("./service/agent");
+const auditor_1 = require("./service/auditor");
+const bouncer_1 = require("./service/bouncer");
+const dali_1 = require("./service/dali");
+const fuse_1 = require("./service/fuse");
+const high5_1 = require("./service/high5");
+const idp_1 = require("./service/idp");
+const mailer_1 = require("./service/mailer");
+const mothership_1 = require("./service/mothership");
+const nats_1 = require("./service/nats");
+// tslint:disable-next-line
+class HCloud {
+    constructor(options) {
+        this.options = options;
+        this.axios = axios_1.default.create({
+            transformRequest: axios_1.default.defaults.transformRequest,
+            transformResponse: axios_1.default.defaults.transformResponse,
+        });
+        // we set a custom header here as chrome does not allow to set the 'user-agent' header
+        this.axios.defaults.headers.common["x-hcloud-user-agent"] = "hcloud-sdk-js/v" + package_json_1.version;
+        if (typeof window === "undefined") {
+            // also set 'user-agent' header in non-browser environments
+            this.axios.defaults.headers.common["user-agent"] = "hcloud-sdk-js/v" + package_json_1.version;
+        }
+        this.axios.interceptors.response.use(response => response, error => {
+            var _a;
+            (_a = this.options.logger) === null || _a === void 0 ? void 0 : _a.error(String(error), error);
+            return Promise.reject((0, ErrorHelper_1.default)(error));
+        });
+        this.Agent = new agent_1.default(this.options, this.axios);
+        this.Auditor = new auditor_1.default(this.options, this.axios);
+        this.Bouncer = new bouncer_1.default(this.options, this.axios);
+        this.High5 = new high5_1.default(this.options, this.axios);
+        this.Idp = new idp_1.default(this.options, this.axios);
+        this.Fuse = new fuse_1.default(this.options, this.axios);
+        this.Dali = new dali_1.default(this.options, this.axios);
+        this.Mailer = new mailer_1.default(this.options, this.axios);
+        this.Mothership = new mothership_1.default(this.options, this.axios);
+        this.Nats = new nats_1.default(this.options, this.axios);
+    }
+    /**
+     * Sets the server url that the SDK shall do a request to.
+     */
+    setServer(server) {
+        this.options.server = server;
+        return this;
+    }
+    /**
+     * Returns the currently set server url that the SDK will make requests to.
+     */
+    getServer() {
+        return this.options.server;
+    }
+    /**
+     * Authenticate against hcloud with username and password, as an alternative to using a bearer auth token.
+     */
+    setBasicAuth(username, password) {
+        this.axios.defaults.headers.common["authorization"] = `Basic ${Buffer.from(username + ":" + password).toString("base64")}`;
+        return this;
+    }
+    /**
+     * Sets the auth token used for authentication against hcloud. The provided token must be a bearer token.
+     */
+    setAuthToken(token) {
+        this.axios.defaults.headers.common["authorization"] = token;
+        return this;
+    }
+    /**
+     * Returns the currently set auth token.
+     */
+    getAuthToken() {
+        var _a;
+        return (_a = this.axios.defaults.headers.common["authorization"]) === null || _a === void 0 ? void 0 : _a.toString();
+    }
+    /**
+     * Sets the correlationID which will be sent to hcloud with each request and appears in all
+     * logs that are made on behalf of this request, making it easier to debug the application.
+     */
+    setCorrelationId(correlationId) {
+        this.axios.defaults.headers.common["X-Hcloud-Correlation-ID"] = correlationId;
+        return this;
+    }
+    /**
+     * Returns the currently set correlationID.
+     */
+    getCorrelationId() {
+        var _a;
+        return (_a = this.axios.defaults.headers.common["X-Hcloud-Correlation-ID"]) === null || _a === void 0 ? void 0 : _a.toString();
+    }
+    /**
+     * Returns the currently set logger.
+     */
+    getLogger() {
+        return this.options.logger;
+    }
+    /**
+     * Sets a logger used to receive logs from hcloud.
+     */
+    setLogger(logger) {
+        this.options.logger = logger;
+        return this;
+    }
+    /**
+     * Send various no-cache headers globally with every request
+     */
+    disableCachingGlobally() {
+        this.axios.defaults.headers.common = Object.assign(Object.assign({}, this.axios.defaults.headers.common), axios_2.disableCacheHeaders);
+        return this;
+    }
+    /**
+     * getAxios returns the active axios instance
+     * Use it to add additional request/response interceptors
+     * @returns {AxiosInstance} AxiosInstance
+     */
+    getAxios() {
+        return this.axios;
+    }
+    /**
+     * setAxios overwrites the existing axios instance
+     * Use it to add a caching layer to axios
+     * @returns {AxiosInstance} The new AxiosInstance
+     */
+    setAxios(axios) {
+        return (this.axios = axios);
+    }
+}
+exports.HCloud = HCloud;

package/lib/helper/ErrorHelper.d.ts

@@ -0,0 +1,7 @@
+import HCloudError from "../interfaces/global/HCloudError";
+export default function wrapError<T>(error: T): T | HCloudError;
+/**
+ * Checks if error is of type HCloudError. An HCloudError is comming from the SDK and holds
+ * the information of a custom error that was initially thrown in a hcloud backend.
+ */
+export declare function isHCloudError(obj: unknown): obj is HCloudError;

package/lib/helper/ErrorHelper.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = wrapError;
+exports.isHCloudError = isHCloudError;
+const axios_1 = require("axios");
+const HCloudError_1 = require("../interfaces/global/HCloudError");
+function wrapError(error) {
+    if (axios_1.default.isAxiosError(error) && error.response) {
+        return new HCloudError_1.default(error.response.status, error.response.statusText, error.response.data.code, error.response.data.error, error.response.data.message);
+    }
+    return error;
+}
+/**
+ * Checks if error is of type HCloudError. An HCloudError is comming from the SDK and holds
+ * the information of a custom error that was initially thrown in a hcloud backend.
+ */
+function isHCloudError(obj) {
+    return typeof obj === "object" && obj instanceof HCloudError_1.default;
+}

package/lib/helper/paginatedResponseHelper.d.ts

@@ -0,0 +1,3 @@
+import { AxiosResponse } from "axios";
+import { PaginatedResponse } from "../interfaces/global/PaginatedResponse";
+export declare function createPaginatedResponse<T>(response: AxiosResponse<T[]>): PaginatedResponse<T>;

package/lib/helper/paginatedResponseHelper.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPaginatedResponse = createPaginatedResponse;
+function createPaginatedResponse(response) {
+    return {
+        items: response.data,
+        total: parseInt(String(response.headers["total"]), 10),
+    };
+}

package/lib/helper/searchFilter.d.ts

@@ -0,0 +1,9 @@
+import { SearchFilter } from "../interfaces/global/SearchFilters";
+declare class SearchFilterDTO {
+    private type;
+    private key;
+    private comparator;
+    private value;
+    constructor(searchFilter: SearchFilter);
+}
+export { SearchFilterDTO };

package/lib/helper/searchFilter.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchFilterDTO = void 0;
+class SearchFilterDTO {
+    constructor(searchFilter) {
+        this.type = searchFilter.type;
+        this.key = searchFilter.key;
+        this.comparator = searchFilter.comparator;
+        this.value = searchFilter.value;
+    }
+}
+exports.SearchFilterDTO = SearchFilterDTO;

package/lib/interfaces/agent/bundle/dev/index.d.ts

@@ -0,0 +1,3 @@
+export interface ToggleDevBundle {
+    allowDev: boolean;
+}

package/lib/interfaces/agent/context/index.d.ts

@@ -0,0 +1,19 @@
+import { ReducedOrganization } from "../../idp";
+export interface Context {
+    uuid: string;
+    email: string;
+    server: string;
+    enabled: boolean;
+    connections: (ActiveConnection | InactiveConnection)[];
+    busy: boolean;
+}
+export type ActiveConnection = {
+    connected: true;
+    organization: ReducedOrganization;
+    runningStreams: string[];
+};
+export type InactiveConnection = {
+    connected: false;
+    organization: ReducedOrganization;
+    cause: string;
+};

package/lib/interfaces/agent/index.d.ts

@@ -0,0 +1,21 @@
+export interface Version {
+    path: string;
+    md5: string;
+    "dev-release": boolean;
+    date: number;
+}
+export interface InstallerVersion {
+    path: string;
+    published_date: number;
+    version: string;
+    os: "darwin" | "windows";
+    dev: boolean;
+}
+export interface AgentVersions {
+    latest: string;
+    versions: Record<string, Version>;
+}
+export interface AgentInstallerVersions {
+    latest: string;
+    versions: Record<string, InstallerVersion[]>;
+}

package/lib/interfaces/agent/index.js

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

package/lib/interfaces/{Auditor.d.ts → auditor/index.d.ts}

@@ -1,3 +1,4 @@
+import { Organization } from "../idp";
 export declare enum Level {
     INFO = "info",
     WARN = "warn",
@@ -8,17 +9,27 @@ export declare enum Origin {
     IDP = "idp",
     High5 = "high5",
     Auditor = "auditor",
-    Mailer = "mailer"
+    Mailer = "mailer",
+    Fuse = "fuse",
+    Mothership = "mothership",
+    Dali = "dali"
 }
 export declare enum Event {
     Login = "login",
     Logout = "logout",
     User = "user",
     Organization = "organization",
-    App = "app",
+    OrganizationMember = "organizationMember",
+    Team = "team",
+    Space = "space",
     Event = "event",
     Stream = "stream",
-    Mail = "mail"
+    Mail = "mail",
+    Webhook = "webhook",
+    Cronjob = "cronjob",
+    Secret = "secret",
+    Agent = "agent",
+    Avatar = "avatar"
 }
 export declare enum Type {
     Read = "read",
@@ -35,12 +46,27 @@ export declare enum Type {
     Receive = "receive"
 }
 export interface AuditLog {
+    _id: string;
+    correlationId: string;
     level: Level;
     origin: Origin;
-    organization?: string;
+    organizationId: string;
     event: Event;
+    space?: string;
     user: string;
     type?: Type;
     timestamp: number;
-    message?: any;
+    message?: unknown;
+    expireAt: Date;
+    requestorIp: string;
+}
+export interface AuditLogCreate {
+    level: Level;
+    origin: Origin;
+    organization: Pick<Organization, "_id" | "name">;
+    event: Event;
+    space?: string;
+    type?: Type;
+    message?: unknown;
+    requestorIp: string;
 }

package/lib/interfaces/{Auditor.js → auditor/index.js}

@@ -7,25 +7,35 @@ var Level;
     Level["WARN"] = "warn";
     Level["ERROR"] = "error";
     Level["DEBUG"] = "debug";
-})(Level = exports.Level || (exports.Level = {}));
+})(Level || (exports.Level = Level = {}));
 var Origin;
 (function (Origin) {
     Origin["IDP"] = "idp";
     Origin["High5"] = "high5";
     Origin["Auditor"] = "auditor";
     Origin["Mailer"] = "mailer";
-})(Origin = exports.Origin || (exports.Origin = {}));
+    Origin["Fuse"] = "fuse";
+    Origin["Mothership"] = "mothership";
+    Origin["Dali"] = "dali";
+})(Origin || (exports.Origin = Origin = {}));
 var Event;
 (function (Event) {
     Event["Login"] = "login";
     Event["Logout"] = "logout";
     Event["User"] = "user";
     Event["Organization"] = "organization";
-    Event["App"] = "app";
+    Event["OrganizationMember"] = "organizationMember";
+    Event["Team"] = "team";
+    Event["Space"] = "space";
     Event["Event"] = "event";
     Event["Stream"] = "stream";
     Event["Mail"] = "mail";
-})(Event = exports.Event || (exports.Event = {}));
+    Event["Webhook"] = "webhook";
+    Event["Cronjob"] = "cronjob";
+    Event["Secret"] = "secret";
+    Event["Agent"] = "agent";
+    Event["Avatar"] = "avatar";
+})(Event || (exports.Event = Event = {}));
 var Type;
 (function (Type) {
     Type["Read"] = "read";
@@ -40,4 +50,4 @@ var Type;
     Type["Remove"] = "remove";
     Type["Send"] = "send";
     Type["Receive"] = "receive";
-})(Type = exports.Type || (exports.Type = {}));
+})(Type || (exports.Type = Type = {}));

package/lib/interfaces/axios/index.d.ts

@@ -0,0 +1,5 @@
+export declare const disableCacheHeaders: {
+    "Cache-Control": string;
+    Pragma: string;
+    Expires: string;
+};

package/lib/interfaces/axios/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.disableCacheHeaders = void 0;
+exports.disableCacheHeaders = {
+    "Cache-Control": "no-cache",
+    Pragma: "no-cache",
+    Expires: "0",
+};

package/lib/interfaces/bouncer/features/index.d.ts

@@ -0,0 +1,10 @@
+export interface HcloudFeature {
+    feature: {
+        name: string;
+        enabled: boolean;
+    };
+    id?: string;
+    regions: string[];
+    users: string[];
+    organizations: string[];
+}

package/lib/interfaces/bouncer/features/index.js

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

package/lib/interfaces/bouncer/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./features";
+export interface BouncerContext {
+    email?: string;
+    organization?: string;
+    region?: string;
+}

package/lib/interfaces/bouncer/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./features"), exports);

package/lib/interfaces/dali/index.d.ts

@@ -0,0 +1,3 @@
+export interface AvatarCreated {
+    url: string;
+}

package/lib/interfaces/dali/index.js

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

package/lib/interfaces/frontend/config/index.d.ts

@@ -0,0 +1,33 @@
+export declare enum AnnouncementType {
+    INFO = "info",
+    SUCCESS = "success",
+    WARNING = "warning",
+    ERROR = "error"
+}
+export interface OIDCProvider {
+    identifier: "github" | "microsoft" | "google" | "discord" | "apple";
+    icon: string;
+    enabled: boolean;
+}
+export interface Announcement {
+    type: AnnouncementType;
+    message: string;
+    showWarning?: boolean;
+}
+export interface Region {
+    name: string;
+    id: string;
+    server: string;
+    icon?: string;
+    enabled?: boolean;
+    dev?: boolean;
+    umami?: {
+        id: string;
+    };
+    announcement?: Announcement;
+}
+export interface Config {
+    reCAPTCHA: string;
+    regions: Region[];
+    oidc: OIDCProvider[];
+}

package/lib/interfaces/frontend/config/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnnouncementType = void 0;
+var AnnouncementType;
+(function (AnnouncementType) {
+    AnnouncementType["INFO"] = "info";
+    AnnouncementType["SUCCESS"] = "success";
+    AnnouncementType["WARNING"] = "warning";
+    AnnouncementType["ERROR"] = "error";
+})(AnnouncementType || (exports.AnnouncementType = AnnouncementType = {}));

package/lib/interfaces/fuse/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./space";
+export * from "./space/cronjob/Cronjob";
+export * from "./space/cronjob/CronjobLog";

package/lib/interfaces/fuse/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./space"), exports);
+__exportStar(require("./space/cronjob/Cronjob"), exports);
+__exportStar(require("./space/cronjob/CronjobLog"), exports);