Cencosud X kafka client plugin (wrapping kafkajs)

Installation

To get started just install the dependencies using Yarn or the npm client.

# install the plugin
npm install @cencosud-x/cencosud-x-kafka-plugin

Usage and documentation

You can check for mocks folder for examples of usage.

import KafkaPlugin from '@cencosud-x/cencosud-x-kafka-plugin';

subscriber.boot((): void => {
  // Always execute a method plugin after the hydration process ^^.
  const manifiest = KafkaPlugin.getManifiest();
  console.log(manifiest);
});

Notes: Remember that the only class which need to be imported is the manifiest, which have all the available methods.

see requirements section: https://kafka.js.org/

## npm scripts

We use npm scripts in order to operate with the plugin code:

"lint": Apply code styles and formatting
"build": Compile and build distribution folder for publishing
  "prebuild": Prepare things for building
"dev": Develop with life reloading feedback
"dev:single": Develop without live reloading feedback
"prepare": Runs before publishing new versions of the package
"prepublishOnly": Runs before prepare
"version": Runs after bumping versions. You should update versions with cmd `npm version [patch | minor | major | ...]`
  "preversion": Runs before version script
  "postversion": Runs after version script is executed, pushes changes to github repo

Plugin Manifiest

| package | plugin | version | latest build | | --- | --- | --- | --- | | @cencosud-x/cencosud-x-kafka-plugin | KafkaPlugin | 0.1.1 | 2022-08-26T15:50:09.985Z |

Dependencies

| name | description | type | required | default | | --- | --- | --- | --- | --- | | env | Environment where the app is running | 'production', 'staging', 'development', 'test' | true | | | clientName | Name for the kafka client | string | true | | | brokers | Broker list | (host1:port1), (host2:port2) | true | | | saslAuthParams | Auth params when running with security params | {username: string; password: string} | false | |