@dvelop-sdk/identityprovider 3.1.0 → 4.0.2

package/README.md

@@ -1,30 +1,30 @@
-<div align="center">
-  <h1>@dvelop-sdk/identityprovider</h1>
-  <a href="https://www.npmjs.com/package/@dvelop-sdk/identityprovider">
-    <img alt="npm (scoped)" src="https://img.shields.io/npm/v/@dvelop-sdk/identityprovider?style=for-the-badge">
-  </a>
-  <a href="https://www.npmjs.com/package/@dvelop-sdk/identityprovider">
-    <img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/min/@dvelop-sdk/identityprovider?style=for-the-badge">
-  </a>
-  <a href="https://github.com/d-velop/dvelop-sdk-node">
-    <img alt="GitHub" src="https://img.shields.io/badge/GitHub-dvelop--sdk--node-%23ff0844?logo=github&style=for-the-badge">
-  </a>
-  <a href="https://github.com/d-velop/dvelop-sdk-node/blob/master/LICENSE">
-    <img alt="license" src="https://img.shields.io/github/license/d-velop/dvelop-sdk-node?style=for-the-badge">
-  </a
-
-  </br>
-
-  <p>This package contains functionality for the <a href="https://developer.d-velop.de/documentation/idpapi/en">Identityprovider-App</a> in the d.velop cloud.</p>
-
-  <a href="https://d-velop.github.io/dvelop-sdk-node/modules/identityprovider.html"><strong>Explore the docs »</strong></a>
-
-  </br>
-
-  <a href="https://www.npmjs.com/package/@dvelop-sdk/identityprovider"><strong>Install via npm »</strong></a>
-
-  </br>
-
-  <a href="https://github.com/d-velop/dvelop-sdk-node"><strong>Check us out on GitHub »</strong></a>
-
+<div align="center">
+  <h1>@dvelop-sdk/identityprovider</h1>
+  <a href="https://www.npmjs.com/package/@dvelop-sdk/identityprovider">
+    <img alt="npm (scoped)" src="https://img.shields.io/npm/v/@dvelop-sdk/identityprovider?style=for-the-badge">
+  </a>
+  <a href="https://www.npmjs.com/package/@dvelop-sdk/identityprovider">
+    <img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/min/@dvelop-sdk/identityprovider?style=for-the-badge">
+  </a>
+  <a href="https://github.com/d-velop/dvelop-sdk-node">
+    <img alt="GitHub" src="https://img.shields.io/badge/GitHub-dvelop--sdk--node-%23ff0844?logo=github&style=for-the-badge">
+  </a>
+  <a href="https://github.com/d-velop/dvelop-sdk-node/blob/master/LICENSE">
+    <img alt="license" src="https://img.shields.io/github/license/d-velop/dvelop-sdk-node?style=for-the-badge">
+  </a
+
+  </br>
+
+  <p>This package contains functionality for the <a href="https://developer.d-velop.de/documentation/idpapi/en">Identityprovider-App</a> in the d.velop cloud.</p>
+
+  <a href="https://d-velop.github.io/dvelop-sdk-node/modules/identityprovider.html"><strong>Explore the docs »</strong></a>
+
+  </br>
+
+  <a href="https://www.npmjs.com/package/@dvelop-sdk/identityprovider"><strong>Install via npm »</strong></a>
+
+  </br>
+
+  <a href="https://github.com/d-velop/dvelop-sdk-node"><strong>Check us out on GitHub »</strong></a>
+
 </div>

package/lib/authentication/get-auth-session/get-auth-session.d.ts

@@ -1,45 +1,45 @@
-import { DvelopContext } from "../../../../core/lib";
-import { HttpConfig, HttpResponse } from "../../utils/http";
-/**
- * Used for authentication in the d.velop cloud. Refer to the [documentation](https://developer.d-velop.de/documentation/idpapi/en/identityprovider-app-201523580.html#validating-the-login) for further information.
- * @category Authentication
- */
-export interface AuthSession {
-    /** This key will validate your requests (usually sent as Bearer-Token). **The AuthSessionId should be kept secret and never be publicly available** */
-    id: string;
-    /** Date at which the AuthSessionId will no longer be valid. */
-    expire: Date;
-}
-/**
- * Default transform-function provided to the {@link getAuthSession}-function. See [Advanced Topics](https://github.com/d-velop/dvelop-sdk-node#advanced-topics) for more information.
- * @internal
- * @category Authentication
- */
-export declare function _getAuthSessionDefaultTransformFunction(response: HttpResponse, _: DvelopContext): AuthSession;
-/**
- * Factory for the {@link getAuthSession}-function. See internals for more information. See [Advanced Topics](https://github.com/d-velop/dvelop-sdk-node#advanced-topics) for more information.
- * @typeparam T Return type of the {@link getAuthSession}-function. A corresponding transformFuntion has to be supplied.
- * @internal
- * @category Authentication
- */
-export declare function _getAuthSessionFactory<T>(httpRequestFunction: (context: DvelopContext, config: HttpConfig) => Promise<HttpResponse>, transformFunction: (response: HttpResponse, context: DvelopContext) => T): (context: DvelopContext) => Promise<T>;
-/**
- * Returns an {@link AuthSession} based on an API-Key. API-Keys can be generated by d.velop cloud tenant administrators.
- * **The AuthSessionId should be kept secret and never be publicly available.**
- *
- *
- * ```typescript
- * import { getAuthSession } from "@dvelop-sdk/identityprovider";
- *
- * const authSession = await getAuthSession({
- *   systemBaseUri: "https://monster-ag.d-velop.cloud",
- *   authSessionId: "dQw4w9WgXcQ"
- * });
- *
-  console.log(authSession);
- * ```
- *
- * @category Authentication
- */
-export declare function getAuthSession(context: DvelopContext): Promise<AuthSession>;
+import { DvelopContext } from "../../../../core/lib";
+import { HttpConfig, HttpResponse } from "../../utils/http";
+/**
+ * Used for authentication in the d.velop cloud. Refer to the [documentation](https://developer.d-velop.de/documentation/idpapi/en/identityprovider-app-201523580.html#validating-the-login) for further information.
+ * @category Authentication
+ */
+export interface AuthSession {
+    /** This key will validate your requests (usually sent as Bearer-Token). **The AuthSessionId should be kept secret and never be publicly available** */
+    id: string;
+    /** Date at which the AuthSessionId will no longer be valid. */
+    expire: Date;
+}
+/**
+ * Default transform-function provided to the {@link getAuthSession}-function. See [Advanced Topics](https://github.com/d-velop/dvelop-sdk-node#advanced-topics) for more information.
+ * @internal
+ * @category Authentication
+ */
+export declare function _getAuthSessionDefaultTransformFunction(response: HttpResponse, _: DvelopContext): AuthSession;
+/**
+ * Factory for the {@link getAuthSession}-function. See internals for more information. See [Advanced Topics](https://github.com/d-velop/dvelop-sdk-node#advanced-topics) for more information.
+ * @typeparam T Return type of the {@link getAuthSession}-function. A corresponding transformFuntion has to be supplied.
+ * @internal
+ * @category Authentication
+ */
+export declare function _getAuthSessionFactory<T>(httpRequestFunction: (context: DvelopContext, config: HttpConfig) => Promise<HttpResponse>, transformFunction: (response: HttpResponse, context: DvelopContext) => T): (context: DvelopContext) => Promise<T>;
+/**
+ * Returns an {@link AuthSession} based on an API-Key. API-Keys can be generated by d.velop cloud tenant administrators.
+ * **The AuthSessionId should be kept secret and never be publicly available.**
+ *
+ *
+ * ```typescript
+ * import { getAuthSession } from "@dvelop-sdk/identityprovider";
+ *
+ * const authSession = await getAuthSession({
+ *   systemBaseUri: "https://monster-ag.d-velop.cloud",
+ *   authSessionId: "dQw4w9WgXcQ"
+ * });
+ *
+  console.log(authSession);
+ * ```
+ *
+ * @category Authentication
+ */
+export declare function getAuthSession(context: DvelopContext): Promise<AuthSession>;
 //# sourceMappingURL=get-auth-session.d.ts.map

package/lib/authentication/get-auth-session/get-auth-session.js

@@ -1,105 +1,105 @@
-"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());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAuthSession = exports._getAuthSessionFactory = exports._getAuthSessionDefaultTransformFunction = void 0;
-var http_1 = require("../../utils/http");
-/**
- * Default transform-function provided to the {@link getAuthSession}-function. See [Advanced Topics](https://github.com/d-velop/dvelop-sdk-node#advanced-topics) for more information.
- * @internal
- * @category Authentication
- */
-function _getAuthSessionDefaultTransformFunction(response, _) {
-    return {
-        id: response.data.AuthSessionId,
-        expire: new Date(response.data.Expire)
-    };
-}
-exports._getAuthSessionDefaultTransformFunction = _getAuthSessionDefaultTransformFunction;
-/**
- * Factory for the {@link getAuthSession}-function. See internals for more information. See [Advanced Topics](https://github.com/d-velop/dvelop-sdk-node#advanced-topics) for more information.
- * @typeparam T Return type of the {@link getAuthSession}-function. A corresponding transformFuntion has to be supplied.
- * @internal
- * @category Authentication
- */
-function _getAuthSessionFactory(httpRequestFunction, transformFunction) {
-    var _this = this;
-    return function (context) { return __awaiter(_this, void 0, void 0, function () {
-        var response;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, httpRequestFunction(context, {
-                        method: "GET",
-                        url: "/identityprovider",
-                        follows: ["login"],
-                    })];
-                case 1:
-                    response = _a.sent();
-                    return [2 /*return*/, transformFunction(response, context)];
-            }
-        });
-    }); };
-}
-exports._getAuthSessionFactory = _getAuthSessionFactory;
-/**
- * Returns an {@link AuthSession} based on an API-Key. API-Keys can be generated by d.velop cloud tenant administrators.
- * **The AuthSessionId should be kept secret and never be publicly available.**
- *
- *
- * ```typescript
- * import { getAuthSession } from "@dvelop-sdk/identityprovider";
- *
- * const authSession = await getAuthSession({
- *   systemBaseUri: "https://monster-ag.d-velop.cloud",
- *   authSessionId: "dQw4w9WgXcQ"
- * });
- *
-  console.log(authSession);
- * ```
- *
- * @category Authentication
- */
-/* istanbul ignore next */
-function getAuthSession(context) {
-    return __awaiter(this, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            return [2 /*return*/, _getAuthSessionFactory(http_1._defaultHttpRequestFunction, _getAuthSessionDefaultTransformFunction)(context)];
-        });
-    });
-}
-exports.getAuthSession = getAuthSession;
+"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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAuthSession = exports._getAuthSessionFactory = exports._getAuthSessionDefaultTransformFunction = void 0;
+var http_1 = require("../../utils/http");
+/**
+ * Default transform-function provided to the {@link getAuthSession}-function. See [Advanced Topics](https://github.com/d-velop/dvelop-sdk-node#advanced-topics) for more information.
+ * @internal
+ * @category Authentication
+ */
+function _getAuthSessionDefaultTransformFunction(response, _) {
+    return {
+        id: response.data.AuthSessionId,
+        expire: new Date(response.data.Expire)
+    };
+}
+exports._getAuthSessionDefaultTransformFunction = _getAuthSessionDefaultTransformFunction;
+/**
+ * Factory for the {@link getAuthSession}-function. See internals for more information. See [Advanced Topics](https://github.com/d-velop/dvelop-sdk-node#advanced-topics) for more information.
+ * @typeparam T Return type of the {@link getAuthSession}-function. A corresponding transformFuntion has to be supplied.
+ * @internal
+ * @category Authentication
+ */
+function _getAuthSessionFactory(httpRequestFunction, transformFunction) {
+    var _this = this;
+    return function (context) { return __awaiter(_this, void 0, void 0, function () {
+        var response;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, httpRequestFunction(context, {
+                        method: "GET",
+                        url: "/identityprovider",
+                        follows: ["login"],
+                    })];
+                case 1:
+                    response = _a.sent();
+                    return [2 /*return*/, transformFunction(response, context)];
+            }
+        });
+    }); };
+}
+exports._getAuthSessionFactory = _getAuthSessionFactory;
+/**
+ * Returns an {@link AuthSession} based on an API-Key. API-Keys can be generated by d.velop cloud tenant administrators.
+ * **The AuthSessionId should be kept secret and never be publicly available.**
+ *
+ *
+ * ```typescript
+ * import { getAuthSession } from "@dvelop-sdk/identityprovider";
+ *
+ * const authSession = await getAuthSession({
+ *   systemBaseUri: "https://monster-ag.d-velop.cloud",
+ *   authSessionId: "dQw4w9WgXcQ"
+ * });
+ *
+  console.log(authSession);
+ * ```
+ *
+ * @category Authentication
+ */
+/* istanbul ignore next */
+function getAuthSession(context) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            return [2 /*return*/, _getAuthSessionFactory(http_1._defaultHttpRequestFunction, _getAuthSessionDefaultTransformFunction)(context)];
+        });
+    });
+}
+exports.getAuthSession = getAuthSession;
 //# sourceMappingURL=get-auth-session.js.map

package/lib/authentication/get-impersonated-auth-session-id/get-impersonated-auth-session-id.d.ts

@@ -1,42 +1,42 @@
-import { DvelopContext } from "@dvelop-sdk/core";
-import { HttpConfig, HttpResponse } from "../../utils/http";
-/**
- * Parameters for the {@link getImpersonatedAuthSessionId}-function.
- * @category Authentication
- */
-export interface GetImpersonatedAuthSessionIdParams {
-    userId: string;
-}
-/**
- * Default transform-function provided to the {@link getImpersontedAuthSessionId}-function. See [Advanced Topics](https://github.com/d-velop/dvelop-sdk-node#advanced-topics) for more information.
- * @internal
- * @category Authentication
- */
-export declare function _getImpersonatedAuthSessionIdDefaultTransformFunction(response: HttpResponse, _: DvelopContext, __: GetImpersonatedAuthSessionIdParams): string;
-/**
- * Factory for the {@link getImpersonatedAuthSessionId}}-function. See [Advanced Topics](https://github.com/d-velop/dvelop-sdk-node#advanced-topics) for more information.
- * @typeparam T Return type of the {@link getImpersonatedAuthSessionId}-function. A corresponding transformFuntion has to be supplied.
- * @internal
- * @category Authentication
- */
-export declare function _getImpersonatedAuthSessionIdFactory<T>(httpRequestFunction: (context: DvelopContext, config: HttpConfig) => Promise<HttpResponse>, transformFunction: (response: HttpResponse, context: DvelopContext, params: GetImpersonatedAuthSessionIdParams) => T): (context: DvelopContext, params: GetImpersonatedAuthSessionIdParams) => Promise<T>;
-/**
- * Returns an authSessionId for the given user. All requests with this authSessionId will be in that users name.
- * **The AuthSessionId should be kept secret and never be publicly available.**
- *
- * ```typescript
- *  import { getImpersonatedAuthSessionId } from "@dvelop-sdk/identityprovider";
- *
- * const authSessionId = await getImpersonatedAuthSessionId({
- *   systemBaseUri: "https://monster-ag.d-velop.cloud",
- *   authSessionId: "dQw4w9WgXcQ" // has to be an AppSession
- * }, {
- *   userId: "XiFkyR35v2Y"
- * });
- *
- * console.log(authSessionId);
- * ```
- * @category Authentication
- */
-export declare function getImpersonatedAuthSessionId(context: DvelopContext, params: GetImpersonatedAuthSessionIdParams): Promise<string>;
+import { DvelopContext } from "@dvelop-sdk/core";
+import { HttpConfig, HttpResponse } from "../../utils/http";
+/**
+ * Parameters for the {@link getImpersonatedAuthSessionId}-function.
+ * @category Authentication
+ */
+export interface GetImpersonatedAuthSessionIdParams {
+    userId: string;
+}
+/**
+ * Default transform-function provided to the {@link getImpersontedAuthSessionId}-function. See [Advanced Topics](https://github.com/d-velop/dvelop-sdk-node#advanced-topics) for more information.
+ * @internal
+ * @category Authentication
+ */
+export declare function _getImpersonatedAuthSessionIdDefaultTransformFunction(response: HttpResponse, _: DvelopContext, __: GetImpersonatedAuthSessionIdParams): string;
+/**
+ * Factory for the {@link getImpersonatedAuthSessionId}}-function. See [Advanced Topics](https://github.com/d-velop/dvelop-sdk-node#advanced-topics) for more information.
+ * @typeparam T Return type of the {@link getImpersonatedAuthSessionId}-function. A corresponding transformFuntion has to be supplied.
+ * @internal
+ * @category Authentication
+ */
+export declare function _getImpersonatedAuthSessionIdFactory<T>(httpRequestFunction: (context: DvelopContext, config: HttpConfig) => Promise<HttpResponse>, transformFunction: (response: HttpResponse, context: DvelopContext, params: GetImpersonatedAuthSessionIdParams) => T): (context: DvelopContext, params: GetImpersonatedAuthSessionIdParams) => Promise<T>;
+/**
+ * Returns an authSessionId for the given user. All requests with this authSessionId will be in that users name.
+ * **The AuthSessionId should be kept secret and never be publicly available.**
+ *
+ * ```typescript
+ *  import { getImpersonatedAuthSessionId } from "@dvelop-sdk/identityprovider";
+ *
+ * const authSessionId = await getImpersonatedAuthSessionId({
+ *   systemBaseUri: "https://monster-ag.d-velop.cloud",
+ *   authSessionId: "dQw4w9WgXcQ" // has to be an AppSession
+ * }, {
+ *   userId: "XiFkyR35v2Y"
+ * });
+ *
+ * console.log(authSessionId);
+ * ```
+ * @category Authentication
+ */
+export declare function getImpersonatedAuthSessionId(context: DvelopContext, params: GetImpersonatedAuthSessionIdParams): Promise<string>;
 //# sourceMappingURL=get-impersonated-auth-session-id.d.ts.map