feat: message broker (#289)

* chore: bump all dependencies

* chore: 3.16.0 version

* feat: message broker client

* feat: messagebroker client

* feat: add support to messagebroker service #288

* chore: tests

* chore: fixed unit tests for nock + README

Author: sn0wcat

CHANGELOG.md

@@ -1,12 +1,17 @@
 # Changelog
 
+## 3.16.0 - (Tyrian Vienna) - September 2021
+
+- CLI: new `mc message-broker` command - manage message broker subscriptions and webhooks
+- SDK: message broker client
+- Bumped all dependencies
+
 ## 3.15.0 - (Pineapple) Vienna) - August 2021
 
 - changed generated code for the mindconnect agent and agent management client to support BIG_STRING AND TIMESTAMP see MDS-329054
 - Upgraded validation to newest ajv - the validation of the timeseries had to be rewritten due to deprecation of addKeyword interface in ajv
 - Bumped all dependencies
 
-
 ## 3.14.0 - (Cool Grey Vienna) - June 2021
 
 ### Announcement 3.14.0

README.md

@@ -327,8 +327,11 @@ It implements support for both frontend (browser e.g. angular, react...) and bac
 | Oauth Authorization  | :heavy_check_mark: | :heavy_check_mark: |
 | Tenant Management  | :heavy_check_mark: | :heavy_check_mark: |
 | Token Management  | :heavy_check_mark: | :heavy_check_mark: |
+| Message Broker* (preview)  | :heavy_check_mark: | :heavy_check_mark: |
 | Usage Transparency  | :heavy_check_mark: |  |
 
+*) Message Broker is only available on preview tenants
+
 ### IoT and Storage
 
 | Name |SDK - Client | Command |

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@mindconnect/mindconnect-nodejs",
-    "version": "3.15.0",
+    "version": "3.16.0",
     "description": "NodeJS Library for MindSphere Connectivity - TypeScript SDK for MindSphere - MindSphere Command Line Interface - MindSphere Development Proxy",
     "main": "./dist/src/index.js",
     "browser": "./dist/src/index.bundle.js",
@@ -75,26 +75,26 @@
         "@types/jsonwebtoken": "^8.5.5",
         "@types/lodash": "^4.14.172",
         "@types/mocha": "^9.0.0",
-        "@types/node": "^16.6.2",
+        "@types/node": "^16.7.13",
         "@types/update-notifier": "^5.1.0",
         "@types/uuid": "^8.3.1",
         "chai": "^4.3.4",
         "concurrently": "^6.2.1",
         "copyfiles": "^2.4.1",
         "cross-env": "^7.0.3",
         "license-checker": "^25.0.1",
-        "mocha": "^9.0.3",
+        "mocha": "^9.1.1",
         "mocha-jenkins-reporter": "^0.4.6",
-        "nock": "^12.0.3",
+        "nock": "^13.1.3",
         "pkg": "^5.3.1",
         "rimraf": "^3.0.2",
-        "rollup": "^2.56.2",
+        "rollup": "^2.56.3",
         "rollup-plugin-node-polyfills": "^0.2.1",
         "rollup-plugin-terser": "^7.0.2",
         "ts-node": "^10.2.1",
         "tslib": "^2.3.1",
         "tslint": "^6.1.2",
-        "typescript": "^4.3.5",
+        "typescript": "^4.4.2",
         "typescript-tslint-plugin": "^1.0.1"
     },
     "repository": {

package.json

@@ -3,13 +3,6 @@ import { AnomalyDetectionClient } from "../anomaly-detection/anomaly-detection";
 import { AssetManagementClient } from "../asset/asset-management";
 import { DataExchangeClient } from "../data-exchange/data-exchange";
 import { DataLakeClient } from "../data-lake/data-lake";
-import { DeviceStatusManagementClient } from "../open-edge/open-edge";
-import { DeviceManagementClient } from "../open-edge/open-edge";
-import { DeviceConfigurationClient } from "../open-edge/open-edge";
-import { DeploymentWorkflowClient } from "../open-edge/open-edge";
-import { EdgeAppInstanceManagementClient } from "../open-edge/open-edge";
-import { EdgeAppDeploymentClient } from "../open-edge/open-edge";
-import { FirmwareDeploymentClient } from "../open-edge/open-edge";
 import { EventAnalyticsClient } from "../event-analytics/eventanalytics";
 import { EventManagementClient } from "../event/event-management";
 import { IdentityManagementClient } from "../identity/identity";
@@ -21,8 +14,18 @@ import { IotFileClient } from "../iotfile/iot-file";
 import { JobManagerClient } from "../jobmanager/jobmanager";
 import { KPICalculationClient } from "../kpi/kpi";
 import { MindConnectApiClient } from "../mcapi/mcapi";
+import { MessageBrokerClient } from "../messagebroker/messagebroker";
 import { ModelManagementClient } from "../model/model-management";
 import { NotificationClientV4 } from "../notification-v4/notification-v4";
+import {
+    DeploymentWorkflowClient,
+    DeviceConfigurationClient,
+    DeviceManagementClient,
+    DeviceStatusManagementClient,
+    EdgeAppDeploymentClient,
+    EdgeAppInstanceManagementClient,
+    FirmwareDeploymentClient,
+} from "../open-edge/open-edge";
 import { SemanticDataInterconnectClient } from "../sdi/sdi-v4";
 import { SignalCalculationClient } from "../signal-calculation/signal-calculation";
 import { SignalValidationClient } from "../signal-validation/signal-validation";
@@ -507,4 +510,18 @@ export class MindSphereSdk extends SdkClient {
             this._semanticDataInterConnectClient || new SemanticDataInterconnectClient(this._authenticator);
         return this._semanticDataInterConnectClient;
     }
+
+    private _messageBrokerClient?: MessageBrokerClient;
+
+    /**
+     * * Message Broker Client
+     *
+     * @returns {MessageBrokerClient}
+     *
+     * @memberOf MindSphereSdk
+     */
+    public GetMessageBrokerClient(): MessageBrokerClient {
+        this._messageBrokerClient = this._messageBrokerClient || new MessageBrokerClient(this._authenticator);
+        return this._messageBrokerClient;
+    }
 }

src/api/sdk/common/mindsphere-sdk.ts

@@ -32,6 +32,8 @@ export * from "./jobmanager/jobmanager";
 export * from "./jobmanager/jobmanager-models";
 export * from "./mcapi/mcapi";
 export * from "./mcapi/mcapi-models";
+export * from "./messagebroker/messagebroker";
+export * from "./messagebroker/messagebroker-models";
 export * from "./model/model-management";
 export * from "./model/model-models";
 export * from "./notification-v4/notification-v4";

src/api/sdk/index.ts

@@ -0,0 +1,92 @@
+export namespace MessageBrokerModels {
+    /**
+     *
+     * @export
+     * @class RequiredError
+     * @extends {Error}
+     */
+    export class RequiredError extends Error {
+        name: "RequiredError" = "RequiredError";
+        constructor(public field: string, msg?: string) {
+            super(msg);
+        }
+    }
+
+    /**
+     * Error response body model.
+     * @export
+     * @interface Errors
+     */
+    export interface Errors {
+        /**
+         * Concrete error codes and messages are defined at operation error response descriptions in this API specification.
+         * @type {Array<ErrorsErrors>}
+         * @memberof Errors
+         */
+        errors?: Array<ErrorsErrors>;
+    }
+    /**
+     *
+     * @export
+     * @interface ErrorsErrors
+     */
+    export interface ErrorsErrors {
+        /**
+         * Unique error code. Every code is bound to one message.
+         * @type {string}
+         * @memberof ErrorsErrors
+         */
+        code: string;
+        /**
+         * Logging correlation ID for debugging purposes.
+         * @type {string}
+         * @memberof ErrorsErrors
+         */
+        logref: string;
+        /**
+         * Human readable error message in English.
+         * @type {string}
+         * @memberof ErrorsErrors
+         */
+        message: string;
+    }
+    /**
+     *
+     * @export
+     * @interface Messages
+     */
+    export interface Messages {
+        /**
+         * Message to publish.
+         * @type {string}
+         * @memberof Messages
+         */
+        content?: string;
+
+        //! fix: manual fix for the type as the OpenAPI spec was not complete
+        [x: string]: any | undefined;
+    }
+    /**
+     *
+     * @export
+     * @interface SubscriberTopicInput
+     */
+    export interface SubscriberTopicInput {
+        /**
+         *
+         * @type {WebHookURL}
+         * @memberof SubscriberTopicInput
+         */
+        uri: WebHookURL;
+    }
+    /**
+     * Id of the topic. Format: mdsp.{tenant}.{service}.v{version}.{type}.{additional}
+     * @export
+     */
+    export type TopicId = string;
+    /**
+     * Gateway uri on which the app will receive notifications.
+     * @export
+     */
+    export type WebHookURL = string;
+}