specmatic 0.70.3 → 0.70.4

package/README.md

@@ -16,6 +16,8 @@ This node module is a thin wrapper over the [specmatic executable jar](https://s
 - [Contract as Test (For API Providers / Service)](#contract-as-test-for-api-providers--service)
 - [Sample Repo](#sample-repo)
 - [Programmatic Access](#programmatic-access)
+  - [Core APIs](#core-apis)
+  - [Kafka APIs](#kafka-apis)
 - [IDE Support](#ide-support)
   - [Jest Framework](#jest-framework)
 - [Logging](#logging)
@@ -54,9 +56,13 @@ import {
     test,
     setExpecations,
     showTestResults,
-    printJarVersion
+    printJarVersion,
+    startKafkaStub,
+    stopKafkaStub,
+    verifyKafkaStub
 } from 'specmatic';
 ```
+### Core APIs
 
 `startStub(host?: string, port?: number, args?: (string | number)[]): Promise<Stub>` <br />
 Start the stub server. Argument `args` values are passed directly to specmatic jar executable.
@@ -76,6 +82,17 @@ View test results in any framework so that it shows up in IDE specific test resu
 `printJarVersion()` <br />
 method to print the version of specmatic.jar
 
+### Kafka APIs
+
+`startKafkaStub(port?: number, args?: (string | number)[]): Promise<KafkaStub>` <br />
+Start kafka stub. Requires an OpenAPI kafka spec in specmatic.json
+
+`stopKafkaStub(stub: KafkaStub)` <br />
+Stop a running kafka stub
+
+`verifyKafkaStub(stub: KafkaStub, topic: string, key: string, value: string)` <br />
+Verify kafka message. This is invoked in tests to check on kafka side if a message expected to by pushed by a BFF api is  recieved by Kafka. The Kafka stub starts a verification end point for this purpose which is invoked internally by this api.
+
 ## IDE Support
 
 Specmatic tests can be displayed in IDE specific test result view by using `showTestResults` method coupled with `test` method. Test framework specific steps are below.

package/dist/common/runner.js

@@ -17,7 +17,7 @@ var callSpecmatic = (args, done, onOutput) => {
 };
 exports.callSpecmatic = callSpecmatic;
 var callKafka = (args, done, onOutput) => {
-  var rootPath = _path.default.resolve(__dirname, '..', '..', '..', 'specmatic-node-beta', 'kafka');
+  var rootPath = _path.default.resolve(__dirname, '..', '..', '..', 'specmatic-beta', 'kafka');
   var specmaticJarPath = _path.default.resolve(rootPath, _config.specmaticKafkaJarName);
   _logger.default.debug("CLI: Specmatic jar path: ".concat(specmaticJarPath));
   return callJar(specmaticJarPath, args, done, onOutput);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "specmatic",
-  "version": "0.70.3",
+  "version": "0.70.4",
   "description": "Node wrapper for Specmatic",
   "main": "dist/index.js",
   "scripts": {

package/src/common/runner.ts

@@ -12,7 +12,7 @@ const callSpecmatic = (args: string, done: (error: any) => void, onOutput: (mess
 };
 
 const callKafka = (args: string, done: (error: any) => void, onOutput: (message: string, error: boolean) => void): ChildProcess => {
-    const rootPath = path.resolve(__dirname, '..', '..', '..', 'specmatic-node-beta', 'kafka');
+    const rootPath = path.resolve(__dirname, '..', '..', '..', 'specmatic-beta', 'kafka');
     const specmaticJarPath = path.resolve(rootPath, specmaticKafkaJarName);
     logger.debug(`CLI: Specmatic jar path: ${specmaticJarPath}`);
     return callJar(specmaticJarPath, args, done, onOutput);