@dvelop-sdk/app-router 3.1.5 → 3.2.2

package/README.md

@@ -9,7 +9,7 @@
   <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">
+  <a href="https://github.com/d-velop/dvelop-sdk-node/blob/main/LICENSE">
     <img alt="license" src="https://img.shields.io/github/license/d-velop/dvelop-sdk-node?style=for-the-badge">
   </a>
 

package/lib/index.d.ts

@@ -10,7 +10,7 @@
   <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">
+  <a href="https://github.com/d-velop/dvelop-sdk-node/blob/main/LICENSE">
     <img alt="license" src="https://img.shields.io/github/license/d-velop/dvelop-sdk-node?style=for-the-badge">
   </a>
   </br>
@@ -25,4 +25,5 @@
  */
 export { DvelopContext } from "@dvelop-sdk/core";
 export { validateRequestSignature, validateDvelopContext, InvalidRequestSignatureError } from "./validate-request-signature/validate-request-signature";
+export { validateCloudCenterEventSignature, InvalidCloudCenterEventSignatureError } from "./validate-cloud-center-event-signature/validate-cloud-center-event-signature";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,4BAA4B,EAAE,MAAM,yDAAyD,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,4BAA4B,EAAE,MAAM,yDAAyD,CAAC;AACxJ,OAAO,EAAE,iCAAiC,EAAE,qCAAqC,EAAE,MAAM,+EAA+E,CAAC"}

package/lib/index.js

@@ -11,7 +11,7 @@
   <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">
+  <a href="https://github.com/d-velop/dvelop-sdk-node/blob/main/LICENSE">
     <img alt="license" src="https://img.shields.io/github/license/d-velop/dvelop-sdk-node?style=for-the-badge">
   </a>
   </br>
@@ -25,9 +25,12 @@
  * @module app-router
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidRequestSignatureError = exports.validateDvelopContext = exports.validateRequestSignature = void 0;
+exports.InvalidCloudCenterEventSignatureError = exports.validateCloudCenterEventSignature = exports.InvalidRequestSignatureError = exports.validateDvelopContext = exports.validateRequestSignature = void 0;
 var validate_request_signature_1 = require("./validate-request-signature/validate-request-signature");
 Object.defineProperty(exports, "validateRequestSignature", { enumerable: true, get: function () { return validate_request_signature_1.validateRequestSignature; } });
 Object.defineProperty(exports, "validateDvelopContext", { enumerable: true, get: function () { return validate_request_signature_1.validateDvelopContext; } });
 Object.defineProperty(exports, "InvalidRequestSignatureError", { enumerable: true, get: function () { return validate_request_signature_1.InvalidRequestSignatureError; } });
+var validate_cloud_center_event_signature_1 = require("./validate-cloud-center-event-signature/validate-cloud-center-event-signature");
+Object.defineProperty(exports, "validateCloudCenterEventSignature", { enumerable: true, get: function () { return validate_cloud_center_event_signature_1.validateCloudCenterEventSignature; } });
+Object.defineProperty(exports, "InvalidCloudCenterEventSignatureError", { enumerable: true, get: function () { return validate_cloud_center_event_signature_1.InvalidCloudCenterEventSignatureError; } });
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;;;AAGH,sGAAwJ;AAA/I,sIAAA,wBAAwB,OAAA;AAAE,mIAAA,qBAAqB,OAAA;AAAE,0IAAA,4BAA4B,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;;;AAGH,sGAAwJ;AAA/I,sIAAA,wBAAwB,OAAA;AAAE,mIAAA,qBAAqB,OAAA;AAAE,0IAAA,4BAA4B,OAAA;AACtF,uIAAyK;AAAhK,0JAAA,iCAAiC,OAAA;AAAE,8JAAA,qCAAqC,OAAA"}

package/lib/validate-cloud-center-event-signature/validate-cloud-center-event-signature.d.ts

@@ -0,0 +1,51 @@
+import { DvelopSdkError } from "@dvelop-sdk/core";
+/**
+ * RequestSignature is invalid for given appSecret.
+ * @category Error
+ */
+export declare class InvalidCloudCenterEventSignatureError extends DvelopSdkError {
+    constructor();
+}
+/**
+ * RequestSignature is invalid for given appSecret.
+ * @category Error
+ */
+export interface ValidateCloudCenterEventSignatureParams {
+    httpMethod: string;
+    resourcePath: string;
+    queryString: string | undefined;
+    headers: {
+        [key: string]: string | undefined;
+    };
+    payload: any;
+    cloudCenterEventSignature: string;
+}
+/**
+ * Validate a cloud-center-event-signature against your appSecret.
+ *
+ * **The cloud-center-event-signature should be validated for every cloud-center-event.
+ * Refer to the [d.velop cloud center API](https://developer.d-velop.de/documentation/ccapi/en) for more information.**
+ *
+ * @throws {@link InvalidCloudCenterEventSignatureError} indicates that a cloud-center-event had an invalid signature.
+ *
+ * ```typescript
+ * validateCloudCenterEventSignature(
+ *   process.env.APP_SECRET,
+ *   "POST",
+ *   "/myapp/dvelop-cloud-lifecycle-event",
+ *   "",
+ *   {
+ *     "x-dv-signature-algorithm": "DV1-HMAC-SHA256",
+ *     "x-dv-signature-headers": "x-dv-signature-algorithm,x-dv-signature-headers,x-dv-signature-timestamp",
+ *     "x-dv-signature-timestamp": "2019-08-09T08:49:42Z"
+ *   }, {
+ *     "type": "subscribe",
+ *     "tenantId": "id",
+ *     "baseUri": "https://someone.d-velop.cloud"
+ *   },
+ *   "02783453441665bf27aa465cbbac9b98507ae94c54b6be2b1882fe9a05ec104c"
+ * );
+ * ```
+ */
+export declare function validateCloudCenterEventSignature(appSecret: string, params: ValidateCloudCenterEventSignatureParams): void;
+//# sourceMappingURL=validate-cloud-center-event-signature.d.ts.map

package/lib/validate-cloud-center-event-signature/validate-cloud-center-event-signature.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-cloud-center-event-signature.d.ts","sourceRoot":"","sources":["../../src/validate-cloud-center-event-signature/validate-cloud-center-event-signature.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;GAGG;AACH,qBAAa,qCAAsC,SAAQ,cAAc;;CAMxE;AAED;;;GAGG;AACH,MAAM,WAAW,uCAAuC;IACtD,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;KAAE,CAAC;IAC/C,OAAO,EAAE,GAAG,CAAC;IACb,yBAAyB,EAAE,MAAM,CAAA;CAClC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,iCAAiC,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,uCAAuC,GAAG,IAAI,CAmB1H"}

package/lib/validate-cloud-center-event-signature/validate-cloud-center-event-signature.js

@@ -0,0 +1,85 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateCloudCenterEventSignature = exports.InvalidCloudCenterEventSignatureError = void 0;
+var crypto_1 = require("crypto");
+var core_1 = require("@dvelop-sdk/core");
+/**
+ * RequestSignature is invalid for given appSecret.
+ * @category Error
+ */
+var InvalidCloudCenterEventSignatureError = /** @class */ (function (_super) {
+    __extends(InvalidCloudCenterEventSignatureError, _super);
+    // eslint-disable-next-line no-unused-vars
+    function InvalidCloudCenterEventSignatureError() {
+        var _this = _super.call(this, "Invalid CloudCenterEvent-signature: A cloud center event was recieved but signature was invalid.") || this;
+        Object.setPrototypeOf(_this, InvalidCloudCenterEventSignatureError.prototype);
+        return _this;
+    }
+    return InvalidCloudCenterEventSignatureError;
+}(core_1.DvelopSdkError));
+exports.InvalidCloudCenterEventSignatureError = InvalidCloudCenterEventSignatureError;
+/**
+ * Validate a cloud-center-event-signature against your appSecret.
+ *
+ * **The cloud-center-event-signature should be validated for every cloud-center-event.
+ * Refer to the [d.velop cloud center API](https://developer.d-velop.de/documentation/ccapi/en) for more information.**
+ *
+ * @throws {@link InvalidCloudCenterEventSignatureError} indicates that a cloud-center-event had an invalid signature.
+ *
+ * ```typescript
+ * validateCloudCenterEventSignature(
+ *   process.env.APP_SECRET,
+ *   "POST",
+ *   "/myapp/dvelop-cloud-lifecycle-event",
+ *   "",
+ *   {
+ *     "x-dv-signature-algorithm": "DV1-HMAC-SHA256",
+ *     "x-dv-signature-headers": "x-dv-signature-algorithm,x-dv-signature-headers,x-dv-signature-timestamp",
+ *     "x-dv-signature-timestamp": "2019-08-09T08:49:42Z"
+ *   }, {
+ *     "type": "subscribe",
+ *     "tenantId": "id",
+ *     "baseUri": "https://someone.d-velop.cloud"
+ *   },
+ *   "02783453441665bf27aa465cbbac9b98507ae94c54b6be2b1882fe9a05ec104c"
+ * );
+ * ```
+ */
+function validateCloudCenterEventSignature(appSecret, params) {
+    var _a;
+    var validSignature = false;
+    try {
+        var normalizedHeaderString = (_a = params.headers["x-dv-signature-headers"]) === null || _a === void 0 ? void 0 : _a.split(",").reduce(function (headerString, header) {
+            var _a;
+            return headerString + header.toLowerCase() + ":" + ((_a = params.headers[header]) === null || _a === void 0 ? void 0 : _a.trim()) + "\n";
+        }, "");
+        var sha256Payload = crypto_1.createHash("sha256").update(JSON.stringify(params.payload) + "\n").digest("hex");
+        var normalizedRequestString = params.httpMethod.toUpperCase() + "\n" + params.resourcePath + "\n" + (params.queryString || "") + "\n" + normalizedHeaderString + "\n" + sha256Payload;
+        var sha256RequestString = crypto_1.createHash("sha256").update(normalizedRequestString).digest("hex");
+        var calculatedSignature = crypto_1.createHmac("sha256", Buffer.from(appSecret, "base64")).update(sha256RequestString).digest("hex");
+        validSignature = crypto_1.timingSafeEqual(Buffer.from(params.cloudCenterEventSignature), Buffer.from(calculatedSignature));
+    }
+    catch (e) {
+        throw new InvalidCloudCenterEventSignatureError();
+    }
+    if (!validSignature) {
+        throw new InvalidCloudCenterEventSignatureError();
+    }
+}
+exports.validateCloudCenterEventSignature = validateCloudCenterEventSignature;
+//# sourceMappingURL=validate-cloud-center-event-signature.js.map

package/lib/validate-cloud-center-event-signature/validate-cloud-center-event-signature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-cloud-center-event-signature.js","sourceRoot":"","sources":["../../src/validate-cloud-center-event-signature/validate-cloud-center-event-signature.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,iCAAiE;AACjE,yCAAkD;AAElD;;;GAGG;AACH;IAA2D,yDAAc;IACvE,0CAA0C;IAC1C;QAAA,YACE,kBAAM,kGAAkG,CAAC,SAE1G;QADC,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,qCAAqC,CAAC,SAAS,CAAC,CAAC;;IAC/E,CAAC;IACH,4CAAC;AAAD,CAAC,AAND,CAA2D,qBAAc,GAMxE;AANY,sFAAqC;AAqBlD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAgB,iCAAiC,CAAC,SAAiB,EAAE,MAA+C;;IAElH,IAAI,cAAc,GAAY,KAAK,CAAC;IAEpC,IAAI;QACF,IAAM,sBAAsB,GAAuB,MAAA,MAAM,CAAC,OAAO,CAAC,wBAAwB,CAAC,0CAAE,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,UAAC,YAAoB,EAAE,MAAc;;YAClJ,OAAO,YAAY,GAAG,MAAM,CAAC,WAAW,EAAE,GAAG,GAAG,IAAG,MAAA,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,0CAAE,IAAI,EAAE,CAAA,GAAG,IAAI,CAAC;QAC3F,CAAC,EAAE,EAAE,CAAC,CAAC;QACP,IAAM,aAAa,GAAW,mBAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,OAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC/G,IAAM,uBAAuB,GAAc,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,UAAK,MAAM,CAAC,YAAY,WAAK,MAAM,CAAC,WAAW,IAAI,EAAE,WAAK,sBAAsB,UAAK,aAAe,CAAC;QAC/K,IAAM,mBAAmB,GAAW,mBAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvG,IAAM,mBAAmB,GAAW,mBAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACrI,cAAc,GAAG,wBAAe,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,yBAAyB,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC;KACnH;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,IAAI,qCAAqC,EAAE,CAAC;KACnD;IACD,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,qCAAqC,EAAE,CAAC;KACnD;AACH,CAAC;AAnBD,8EAmBC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dvelop-sdk/app-router",
   "description": "This package contains functionality for the App-Router in the d.velop cloud.",
-  "version": "3.1.5",
+  "version": "3.2.2",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -23,6 +23,6 @@
     "license": "license-checker --production --onlyAllow Apache-2.0;MIT;ISC;BSD-2-Clause;BSD-3-Clause"
   },
   "dependencies": {
-    "@dvelop-sdk/core": "^2.0.0"
+    "@dvelop-sdk/core": "^2.1.2"
   }
-}
+}