Mismatches between`types/kafkajs.d.ts` and documentation

[apeloquin-agilysys]

While working on a conversion from KafkaJS, I've encountered the following:

• Per MIGRATION.md: acks, compression and timeout are not set on a per-send basis, yet ProducerRecord interface still contains acks, compression, and timeout leading one to believe these can be set per message.
• According to MIGRATION.md retry option from existing KafkaJS config is supported, yet it is missing from KafkaConfig interface.
• No mention is made of supporting batch message handling in MIGRATION.md and ConsumerRunConfig type only includes eachMessage?: EachMessageHandler and not eachBatch?: EachBatchHandler, yet EachBatchHandler and its supporting types are still present.
• compression in producer config (and in kafkajs.d.ts) says to use the CompressionTypes enum. Doing so results in error message like: Error: Invalid value "3" for configuration property "compression.codec". To get this working, I had to use the native values from compression.codec: 'none' | 'gzip' | 'snappy' | 'lz4' | 'zstd' and in code as unknown as CompressionTypes to avoid compile-time errors.
• the consumer on event methods are present in kafkajs.d.ts, they are not mentioned in MIGRATION.md, but use of them throws a "not implemented" error. Is the goal to provide implementation for these?

[milindl]

Thanks for filing this issue - I'll fix the discrepancies. About the on methods, we don't plan to implement them yet. For the rest, I'll be updating the types.

[milindl]

I've updated the typing and the migration guide. There were a bunch of other places where there were issues like this, or discrepancies between the javascript, typing, and migration, so I've tried to fix those as well.