hcloud-sdk 0.0.16 → 14.13.2

package/lib/service/high5/space/webhook/index.d.ts

@@ -0,0 +1,83 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../../Base";
+import { PaginatedResponse, SearchParams } from "../../../../interfaces/global";
+import { KeyValuePair, Webhook, WebhookCreate, WebhookUpdate } from "../../../../interfaces/high5/space/webhook";
+import { High5WebhookLog } from "./log";
+export declare class High5Webhook extends Base {
+    log: High5WebhookLog;
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * Retrieves all Webhooks of the specified space that match the provided search filter(s). Will return all Webhooks if no search filter is provided.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of Webhooks and the total number of results found in the database (independent of limit and page)
+     */
+    searchWebhooks: ({ orgName, spaceName, filters, sorting, limit, page, }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+    }) => Promise<PaginatedResponse<Webhook>>;
+    /**
+     * Requests a Webhhok by its ID.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the Webhook
+     * @returns The requested Webhook
+     */
+    getWebhook: (orgName: string, spaceName: string, webhookId: string) => Promise<Webhook>;
+    /**
+     * Generates a new URL for the specified Webhook. This is suggested if a leak of the current URL is likely.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the Webhook
+     * @returns The updated Webhook
+     */
+    regenerateWebhookUrl: (orgName: string, spaceName: string, webhookId: string) => Promise<Webhook>;
+    /**
+     * Creates a new Webhook in the specified High5 space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param WebhookCreate Object/JSON containing the name, token, eventId, spaceId, target and (optionally) security headers for the new webhook
+     * @returns The created Webhook
+     */
+    createWebhook: (orgName: string, spaceName: string, WebhookCreate: WebhookCreate) => Promise<Webhook>;
+    /**
+     * Updates an existing Webhook.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the Webhook to be updated
+     * @param WebhookCreate Object/JSON containing the name, token, eventId, spaceId, target and (optionally) security headers for the updated webhook
+     * @returns the updated Webhook
+     */
+    updateWebhook: (orgName: string, spaceName: string, webhookId: string, webhookUpdate: WebhookUpdate) => Promise<Webhook>;
+    /**
+     * Deletes a Webhook by its ID.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the webhook to be deleted
+     */
+    deleteWebhook: (orgName: string, spaceName: string, webhookId: string) => Promise<void>;
+    /**
+     * Executes all Events and Streams connected to the specified Webhook.
+     * @param webhookUrl URL of the webhook to be triggered / executed
+     */
+    triggerWebhook: (webhookUrl: string) => Promise<void>;
+    /**
+     * Executes a webhook by its URL.
+     * @param webhookUrl Webhook URL to be triggered / executed (your hcloud domain + webhook.relativeUrl)
+     * @param payload Payload to be used in the event execution that will be triggered by the webhook, as JSON.
+     * @param headers (optional) Security headers.
+     */
+    executeWebhookByUrl: (webhookUrl: string, payload: unknown, headers?: KeyValuePair<string>) => Promise<void>;
+    /**
+     * Validates the provided webhook URL by sending a challenge query parameter.
+     * @param url Webhook URL to be validated (your hcloud domain + webhook.relativeUrl)
+     * @param challenge String to be returned
+     * @returns The provided challenge string as plaint text
+     */
+    validateWebhookUrl: (webhookUrl: string, challenge: string) => Promise<string>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/high5/space/webhook/index.js

@@ -0,0 +1,132 @@
+"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.High5Webhook = void 0;
+const Base_1 = require("../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../../helper/searchFilter");
+const log_1 = require("./log");
+class High5Webhook extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        /**
+         * Retrieves all Webhooks of the specified space that match the provided search filter(s). Will return all Webhooks if no search filter is provided.
+         * @param orgName Name of the organization
+         * @param spaceName Name of the space
+         * @param filters (optional) Array of search filters
+         * @param sorting (optional) Sorting object
+         * @param limit (optional) Max number of results (1-100; defaults to 25)
+         * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+         * @returns Object containing an array of Webhooks and the total number of results found in the database (independent of limit and page)
+         */
+        this.searchWebhooks = (_a) => __awaiter(this, [_a], void 0, function* ({ orgName, spaceName, filters, sorting, limit = 25, page = 0, }) {
+            const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => new searchFilter_1.SearchFilterDTO(f));
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/search?limit=${limit}&page=${page}`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+        /**
+         * Requests a Webhhok by its ID.
+         * @param orgName Name of the Organization
+         * @param spaceName Name of the Space
+         * @param webhookId ID of the Webhook
+         * @returns The requested Webhook
+         */
+        this.getWebhook = (orgName, spaceName, webhookId) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}`));
+            return resp.data;
+        });
+        /**
+         * Generates a new URL for the specified Webhook. This is suggested if a leak of the current URL is likely.
+         * @param orgName Name of the Organization
+         * @param spaceName Name of the Space
+         * @param webhookId ID of the Webhook
+         * @returns The updated Webhook
+         */
+        this.regenerateWebhookUrl = (orgName, spaceName, webhookId) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}/regenerateUrl`));
+            return resp.data;
+        });
+        /**
+         * Creates a new Webhook in the specified High5 space.
+         * @param orgName Name of the Organization
+         * @param spaceName Name of the Space
+         * @param WebhookCreate Object/JSON containing the name, token, eventId, spaceId, target and (optionally) security headers for the new webhook
+         * @returns The created Webhook
+         */
+        this.createWebhook = (orgName, spaceName, WebhookCreate) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks`), WebhookCreate);
+            return resp.data;
+        });
+        /**
+         * Updates an existing Webhook.
+         * @param orgName Name of the Organization
+         * @param spaceName Name of the Space
+         * @param webhookId ID of the Webhook to be updated
+         * @param WebhookCreate Object/JSON containing the name, token, eventId, spaceId, target and (optionally) security headers for the updated webhook
+         * @returns the updated Webhook
+         */
+        this.updateWebhook = (orgName, spaceName, webhookId, webhookUpdate) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}`), webhookUpdate);
+            return resp.data;
+        });
+        /**
+         * Deletes a Webhook by its ID.
+         * @param orgName Name of the Organization
+         * @param spaceName Name of the Space
+         * @param webhookId ID of the webhook to be deleted
+         */
+        this.deleteWebhook = (orgName, spaceName, webhookId) => __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}`));
+        });
+        /**
+         * Executes all Events and Streams connected to the specified Webhook.
+         * @param webhookUrl URL of the webhook to be triggered / executed
+         */
+        this.triggerWebhook = (webhookUrl) => __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.post(this.getEndpoint(webhookUrl));
+        });
+        /**
+         * Executes a webhook by its URL.
+         * @param webhookUrl Webhook URL to be triggered / executed (your hcloud domain + webhook.relativeUrl)
+         * @param payload Payload to be used in the event execution that will be triggered by the webhook, as JSON.
+         * @param headers (optional) Security headers.
+         */
+        this.executeWebhookByUrl = (webhookUrl, payload, headers) => __awaiter(this, void 0, void 0, function* () {
+            const h = {};
+            if (headers) {
+                Object.keys(headers).forEach((key) => {
+                    h[key] = headers[key];
+                });
+            }
+            yield this.axios.post(this.getEndpoint(webhookUrl), payload, {
+                headers: h,
+            });
+        });
+        /**
+         * Validates the provided webhook URL by sending a challenge query parameter.
+         * @param url Webhook URL to be validated (your hcloud domain + webhook.relativeUrl)
+         * @param challenge String to be returned
+         * @returns The provided challenge string as plaint text
+         */
+        this.validateWebhookUrl = (webhookUrl, challenge) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`${webhookUrl}?challenge=${challenge}`));
+            return resp.data;
+        });
+        this.log = new log_1.High5WebhookLog(this.options, this.axios);
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5Webhook = High5Webhook;

package/lib/service/high5/space/webhook/log/index.d.ts

@@ -0,0 +1,18 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../../../Base";
+import { PaginatedResponse } from "../../../../../interfaces/global";
+import { WebhookLog } from "../../../../../interfaces/high5/space/webhook";
+export declare class High5WebhookLog extends Base {
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * Retrieves all Webhook logs for the specified Webhook.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the Webhook
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of Webhook logs and the total number of results found in the database (independent of limit and page)
+     */
+    getWebhookLogs: (orgName: string, spaceName: string, webhookId: string, limit?: number, page?: number) => Promise<PaginatedResponse<WebhookLog>>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/high5/space/webhook/log/index.js

@@ -0,0 +1,38 @@
+"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.High5WebhookLog = void 0;
+const Base_1 = require("../../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../../helper/paginatedResponseHelper");
+class High5WebhookLog extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        /**
+         * Retrieves all Webhook logs for the specified Webhook.
+         * @param orgName Name of the Organization
+         * @param spaceName Name of the Space
+         * @param webhookId ID of the Webhook
+         * @param limit (optional) Max number of results (1-100; defaults to 25)
+         * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+         * @returns Object containing an array of Webhook logs and the total number of results found in the database (independent of limit and page)
+         */
+        this.getWebhookLogs = (orgName, spaceName, webhookId, limit, page) => __awaiter(this, void 0, void 0, function* () {
+            limit = limit || 25;
+            page = page || 0;
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}/logs?limit=${limit}&page=${page}`));
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5WebhookLog = High5WebhookLog;

package/lib/service/high5/wave/index.d.ts

@@ -0,0 +1,8 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../Base";
+import { S3 } from "./s3";
+export declare class High5Wave extends Base {
+    s3: S3;
+    constructor(options: Options, axios: AxiosInstance);
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/high5/wave/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.High5Wave = void 0;
+const Base_1 = require("../../../Base");
+const s3_1 = require("./s3");
+class High5Wave extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        this.s3 = new s3_1.S3(this.options, this.axios);
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5Wave = High5Wave;

package/lib/service/high5/wave/s3/index.d.ts

@@ -0,0 +1,48 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../../Base";
+import { Catalog, CatalogRegistry, Engine, EngineRegistry, StreamNodeSpecifications, StreamNodeSpecificationWrappedWithEngineVersion } from "../../../../interfaces/high5";
+/**
+ * Class for reading the S3 bucket of a wave engine and catalogs
+ */
+export declare class S3 extends Base {
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * Get the registry.json of the default wave catalog from the S3 bucket
+     * @param waveBucketUrl Public base url to S3 bucket
+     * @returns registry.json
+     */
+    getCatalogRegistry: (waveBucketUrl: string) => Promise<CatalogRegistry>;
+    /**
+     * Get the registry.json of the default wave engine from the S3 bucket
+     * @param waveBucketUrl Public base url to S3 bucket
+     * @returns registry.json
+     */
+    getEngineRegistry: (waveBucketUrl: string) => Promise<EngineRegistry>;
+    /**
+     * Get the catalog.json from the S3 bucket
+     * @param catalogUrl Public url of the catalog
+     * @returns index.json of catalog
+     */
+    getCatalog: (catalogUrl: string) => Promise<Catalog>;
+    /**
+     * Get the catalog.json from the S3 bucket
+     * @param catalogUrl Public url of the catalog
+     * @returns index.json of catalog
+     */
+    getEngine: (engineUrl: string) => Promise<Engine>;
+    /**
+     * Get the node specifications of all nodes of a specific catalog version from the S3 bucket
+     * @param catalogUrl Public url of the catalog
+     * @param version The catalog version
+     * @returns StreamNodeSpecification[] | StreamNodeSpecificationWrappedWithEngineVersion an array of all node specification of that catalog version, maybe wrapped in an object with the engine version
+     */
+    getCatalogVersion: (catalogUrl: string, version: string) => Promise<StreamNodeSpecifications[] | StreamNodeSpecificationWrappedWithEngineVersion>;
+    /**
+     * Get the node documentation from the S3 bucket
+     * @param catalogUrl Public url of the catalog
+     * @param version The catalog version
+     * @returns string the markdown documentation of the node
+     */
+    getNodeDocumentation: (catalogUrl: string, version: string, nodeName: string) => Promise<string>;
+    protected getEndpoint(): string;
+}

package/lib/service/high5/wave/s3/index.js

@@ -0,0 +1,88 @@
+"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.S3 = void 0;
+const Base_1 = require("../../../../Base");
+const axios_1 = require("../../../../interfaces/axios");
+/**
+ * Class for reading the S3 bucket of a wave engine and catalogs
+ */
+class S3 extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        /**
+         * Get the registry.json of the default wave catalog from the S3 bucket
+         * @param waveBucketUrl Public base url to S3 bucket
+         * @returns registry.json
+         */
+        this.getCatalogRegistry = (waveBucketUrl) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(`${waveBucketUrl}/catalogs/registry.json`, { headers: axios_1.disableCacheHeaders });
+            return resp.data;
+        });
+        /**
+         * Get the registry.json of the default wave engine from the S3 bucket
+         * @param waveBucketUrl Public base url to S3 bucket
+         * @returns registry.json
+         */
+        this.getEngineRegistry = (waveBucketUrl) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(`${waveBucketUrl}/engines/registry.json`, { headers: axios_1.disableCacheHeaders });
+            return resp.data;
+        });
+        /**
+         * Get the catalog.json from the S3 bucket
+         * @param catalogUrl Public url of the catalog
+         * @returns index.json of catalog
+         */
+        this.getCatalog = (catalogUrl) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(`${catalogUrl}`, { headers: axios_1.disableCacheHeaders });
+            return resp.data;
+        });
+        /**
+         * Get the catalog.json from the S3 bucket
+         * @param catalogUrl Public url of the catalog
+         * @returns index.json of catalog
+         */
+        this.getEngine = (engineUrl) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(`${engineUrl}`, { headers: axios_1.disableCacheHeaders });
+            return resp.data;
+        });
+        /**
+         * Get the node specifications of all nodes of a specific catalog version from the S3 bucket
+         * @param catalogUrl Public url of the catalog
+         * @param version The catalog version
+         * @returns StreamNodeSpecification[] | StreamNodeSpecificationWrappedWithEngineVersion an array of all node specification of that catalog version, maybe wrapped in an object with the engine version
+         */
+        this.getCatalogVersion = (catalogUrl, version) => __awaiter(this, void 0, void 0, function* () {
+            const specificationUrl = catalogUrl.split("/").slice(0, -1).join("/") + "/" + version + "/specification.json";
+            const resp = yield this.axios.get(specificationUrl, {
+                headers: axios_1.disableCacheHeaders,
+            });
+            return resp.data;
+        });
+        /**
+         * Get the node documentation from the S3 bucket
+         * @param catalogUrl Public url of the catalog
+         * @param version The catalog version
+         * @returns string the markdown documentation of the node
+         */
+        this.getNodeDocumentation = (catalogUrl, version, nodeName) => __awaiter(this, void 0, void 0, function* () {
+            const specificationUrl = catalogUrl.split("/").slice(0, -1).join("/") + `/${version}/docs/${nodeName}.md`;
+            const resp = yield this.axios.get(specificationUrl).catch(err => {
+                throw new Error(`Node documentation not found: ${err}`);
+            });
+            return resp.data;
+        });
+    }
+    getEndpoint() {
+        throw new Error("Method not implemented.");
+    }
+}
+exports.S3 = S3;

package/lib/service/idp/index.d.ts

@@ -0,0 +1,82 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../Base";
+import { Version } from "../../interfaces/global";
+import { PreLoginResponse } from "../../interfaces/idp";
+import { SuccessfulAuth } from "../../interfaces/idp/user/SuccessfulAuth";
+import { IdpInternal } from "./internal";
+import { IdpOAuth } from "./oauth";
+import { IdpOrganization } from "./organization";
+import { IdpRegistration } from "./registration";
+import { IdpUser } from "./user";
+export default class Idp extends Base {
+    /**
+     * Handles everything around organizations
+     */
+    organization: IdpOrganization;
+    /**
+     * Handles everything around registration
+     */
+    registration: IdpRegistration;
+    /**
+     * Handles everything around open authorization and openId requests
+     */
+    oAuth: IdpOAuth;
+    /**
+     * Handles everything around a user
+     */
+    user: IdpUser;
+    /**
+     * Handles everything around idp's internal endpoints
+     */
+    internal: IdpInternal;
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * Requests the endpoint version
+     * @returns Version object
+     */
+    version: () => Promise<Version>;
+    /**
+     * Authenticates against the identity provider with a given email and password.
+     * @param email Email of the user
+     * @param password Password of the user
+     * @param token (optional) token if 2FA-TOTP is enabled
+     * @returns SuccessfulAuth object holding the token and the user
+     */
+    login: (email: string, password: string, token?: string) => Promise<SuccessfulAuth>;
+    /**
+     * Starts the login process via OIDC
+     * @param origin The starting URL of the process. After obtaining the credentials, the user will be redirected back to this url.
+     * @param oidcProvider The provider to use for the process. Only optional if the user is part of an organization that has a preferred
+     * OIDC provider and an associated email that matches the user's. The list of available providers can be found in the public config endpoint.
+     * @param hint Valid email address of the user that wants to login. Hint must be defined when provider is not.
+     * @returns URL that must be accessed via a browser to continue the login process.
+     */
+    loginWithOIDC: (origin: string, oidcProvider?: string, hint?: string) => Promise<string>;
+    /**
+     * Starts the login process via SAML 2.0
+     * @param origin The starting URL of the process. After obtaining the credentials, the user will be redirected back to this url.
+     * @param email  Email of the user. The email domain will be used to determine the appropriate SAML 2.0 provider to use going forward.
+     * @returns URL that must be accessed via a browser to continue the login process.
+     */
+    loginWithSAML: (origin: string, email: string) => Promise<string>;
+    /**
+     * Determine if/how the given email can authenticate.
+     *
+     * @param email  Email of the user
+     * @param origin The starting URL of the process. If the authentication process bound to this email is SAML or OIDC,
+     *               then the response's location property will include this origin.
+     * @returns object that dictates if: the user needs to REGISTER; the user needs to VERIFY_EMAIL; the user can LOGIN using this email;
+     *          or the authentication process should continue via an EXTERNAL provider that can be found via the location property.
+     */
+    preLogin: (email: string, origin: string) => Promise<PreLoginResponse>;
+    /**
+     * Initiate the password reset process. An email will be sent to the user to move to the next phase.
+     *
+     * @param email Email of the user
+     * @param captcha Valid google reCAPTCHAV2
+     * @param regionId Optional region id to use for the password reset email
+     * @param targetUrl Optional url the link in the mail will point to
+     */
+    resetPassword: (email: string, captcha: string, regionId?: string, targetUrl?: string) => Promise<void>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/idp/index.js

@@ -0,0 +1,137 @@
+"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 internal_1 = require("./internal");
+const oauth_1 = require("./oauth");
+const organization_1 = require("./organization");
+const registration_1 = require("./registration");
+const user_1 = require("./user");
+class Idp extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        /**
+         * Requests the endpoint version
+         * @returns Version object
+         */
+        this.version = () => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint("/v1/version"));
+            return resp.data;
+        });
+        /**
+         * Authenticates against the identity provider with a given email and password.
+         * @param email Email of the user
+         * @param password Password of the user
+         * @param token (optional) token if 2FA-TOTP is enabled
+         * @returns SuccessfulAuth object holding the token and the user
+         */
+        this.login = (email, password, token) => __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            let body = { email: email, password: password };
+            if (token) {
+                body = Object.assign(Object.assign({}, body), { token: token });
+            }
+            const resp = yield this.axios.post(this.getEndpoint("/v1/login"), body);
+            const authed = {
+                token: ((_a = resp.headers["authorization"]) === null || _a === void 0 ? void 0 : _a.toString()) || "",
+                user: resp.data,
+            };
+            return authed;
+        });
+        /**
+         * Starts the login process via OIDC
+         * @param origin The starting URL of the process. After obtaining the credentials, the user will be redirected back to this url.
+         * @param oidcProvider The provider to use for the process. Only optional if the user is part of an organization that has a preferred
+         * OIDC provider and an associated email that matches the user's. The list of available providers can be found in the public config endpoint.
+         * @param hint Valid email address of the user that wants to login. Hint must be defined when provider is not.
+         * @returns URL that must be accessed via a browser to continue the login process.
+         */
+        this.loginWithOIDC = (origin, oidcProvider, hint) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint("/v1/login/oidc"), {
+                params: {
+                    origin,
+                    provider: oidcProvider,
+                    hint,
+                },
+                maxRedirects: 0,
+                validateStatus: status => {
+                    return status >= 300 && status < 400;
+                },
+            });
+            const location = resp.headers.location;
+            if (!location) {
+                throw new Error("Location header is undefined.");
+            }
+            return location;
+        });
+        /**
+         * Starts the login process via SAML 2.0
+         * @param origin The starting URL of the process. After obtaining the credentials, the user will be redirected back to this url.
+         * @param email  Email of the user. The email domain will be used to determine the appropriate SAML 2.0 provider to use going forward.
+         * @returns URL that must be accessed via a browser to continue the login process.
+         */
+        this.loginWithSAML = (origin, email) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint("/v1/login/saml"), {
+                params: {
+                    origin,
+                    email,
+                },
+                maxRedirects: 0,
+                validateStatus: status => {
+                    return status >= 300 && status < 400;
+                },
+            });
+            const location = resp.headers.location;
+            if (!location) {
+                throw new Error("Location header is undefined.");
+            }
+            return location;
+        });
+        /**
+         * Determine if/how the given email can authenticate.
+         *
+         * @param email  Email of the user
+         * @param origin The starting URL of the process. If the authentication process bound to this email is SAML or OIDC,
+         *               then the response's location property will include this origin.
+         * @returns object that dictates if: the user needs to REGISTER; the user needs to VERIFY_EMAIL; the user can LOGIN using this email;
+         *          or the authentication process should continue via an EXTERNAL provider that can be found via the location property.
+         */
+        this.preLogin = (email, origin) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint("/v1/login/pre"), {
+                params: {
+                    origin,
+                    email,
+                },
+            });
+            return resp.data;
+        });
+        /**
+         * Initiate the password reset process. An email will be sent to the user to move to the next phase.
+         *
+         * @param email Email of the user
+         * @param captcha Valid google reCAPTCHAV2
+         * @param regionId Optional region id to use for the password reset email
+         * @param targetUrl Optional url the link in the mail will point to
+         */
+        this.resetPassword = (email, captcha, regionId, targetUrl) => __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.post(this.getEndpoint("/v1/login/forgot_password"), { email, captcha, regionId, targetUrl });
+        });
+        this.organization = new organization_1.IdpOrganization(this.options, this.axios);
+        this.user = new user_1.IdpUser(this.options, this.axios);
+        this.registration = new registration_1.IdpRegistration(this.options, this.axios);
+        this.oAuth = new oauth_1.IdpOAuth(this.options, this.axios);
+        this.internal = new internal_1.IdpInternal(this.options, this.axios);
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/account${endpoint}`;
+    }
+}
+exports.default = Idp;