@axway/api-builder-plugin-ft-kafka

Publish and subscribe to Kafka topics

Usage no npm install needed!

<script type="module">
  import axwayApiBuilderPluginFtKafka from 'https://cdn.skypack.dev/@axway/api-builder-plugin-ft-kafka';
</script>

README

@axway/api-builder-plugin-ft-kafka

This is a plugin for API Builder that provides a Kafka flow-trigger for consuming messages from Kafka topics, and a flow-node for producing messages.

Installation

You can install this plugin into an existing API Builder project. Follow the Getting Started Guide to create an API Builder service if you do not already have one.

$ npm install @axway/api-builder-plugin-ft-kafka

See Flow Triggers for more information about how to use and manage this plugin.

Changes

1.1.4

  • 7010: Internal refactor of unit-tests.

1.1.3

  • 6934: Internal refactoring around code style.

1.1.2

  • 6815: Internal tooling changes.

1.1.1

  • 6878: Fixed broken link to the documentation.

1.1.0

  • 6855: Logs most kafkajs messages using the debug module. See these logs by setting DEBUG=api-builder:kafka-ft.

  • 6855: Kafka channel configuration errors now log 'connection' instead of 'channel'.

1.0.0

  • 6560: Official release.

  • 6560: Breaking change: Minimum API Builder version is now Lyon.

0.6.1

  • 6839: Fixed typo in description of Message parameter for Publish JSON flow-node method.

0.6.0

  • 6806: Breaking change: Updated to use new flow-trigger interface. Minimum @axway/api-builder-runtime version is now 4.62.0.

  • 6806: Fixed issue where the partitionsConsumedConcurrently option was being incorrectly passed to the Kafka connection.

0.5.3

  • 6796: Changed flow-node's description for the Connection ID parameter to be more descriptive.

0.5.2

  • 6802: Kafka Producer advanced options are now taken into account when constructing the connection.

0.5.1

  • 6780: Kafka Consumer now waits for connection to be destroyed on shutdown.

0.5.0

  • 6655: Breaking change: Now requires at least @axway/api-builder-runtime Ibiza.

  • 6655: Updated flow-trigger to use invokeLogger.

  • 6655: Added new debug logs when a message is recieved.

0.4.1

  • 6714: The "Kafka" flow-trigger is renamed to "Kafka Consumer" in the UI.

  • 6714: The flow-node is now in the "Core" category and is renamed to "Kafka Producer".

  • 6714: Sample flow and trigger config are no longer installed on plugin installation.

0.4.0

  • 6643: Added parameter retries to Connection parameters in Kafka flow-trigger.

0.3.0

  • 6667: breaking change: Added minLength: 1 to CA certificate, Client key and Client certificate Connection parameters in Kafka flow-trigger.

  • 6667: breaking change: Added minLength: 1 to Connection ID, Topic and Key Connection parameters in Kafka flow-node.

0.2.1

  • 6625: Ensured that the Kafka trigger doesn't throw undefined errors when connecting.

  • 6625: Changed trigger Channel ID parameter name to Connection ID.

0.2.0

  • 6562: breaking change: Changed channel parameters ca, key and cert to be relative to the API Builder project directory rather than the CWD. This ensures consistency regardless of where the project is started from.

  • 6562: Updated flow-trigger definition to include more metadata (description, name, requestSchema, icon) and enhanced parameter schemas with more validation.

  • 6562: Fixed issue where the channel destroy function was not awaiting destruction before resolving.

  • 6562: Temporarily pinned the kafkajs dependency to 1.13.0 due to internal limitations related to the version of NodeJS being used in CI.

0.1.0

  • 6490: Initial release of Kafka flow-trigger and flow-node.

License

This code is proprietary, closed source software licensed to you by Axway. All Rights Reserved. You may not modify Axway’s code without express written permission of Axway. You are licensed to use and distribute your services developed with the use of this software and dependencies, including distributing reasonable and appropriate portions of the Axway code and dependencies. Except as set forth above, this code MUST not be copied or otherwise redistributed without express written permission of Axway. This module is licensed as part of the Axway Platform and governed under the terms of the Axway license agreement (General Conditions) located here: https://support.axway.com/en/auth/general-conditions; EXCEPT THAT IF YOU RECEIVED A FREE SUBSCRIPTION, LICENSE, OR SUPPORT SUBSCRIPTION FOR THIS CODE, NOTWITHSTANDING THE LANGUAGE OF THE GENERAL CONDITIONS, AXWAY HEREBY DISCLAIMS ALL SUPPORT AND MAINTENANCE OBLIGATIONS, AS WELL AS ALL EXPRESS AND IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO IMPLIED INFRINGEMENT WARRANTIES, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, AND YOU ACCEPT THE PRODUCT AS-IS AND WITH ALL FAULTS, SOLELY AT YOUR OWN RISK. Your right to use this software is strictly limited to the term (if any) of the license or subscription originally granted to you.