sentinel-kafka-manager 1.0.2 → 1.0.3

package/README.md

@@ -48,6 +48,64 @@ npm run build
 - Kafka cluster reachable from the service
 - `kafkajs` is included automatically as a dependency of this package
 
+## Full Service Example
+
+```ts
+import { KafkaManager } from 'sentinel-kafka-manager'
+
+const kafkaManager = KafkaManager.fromEnv({
+  clientId: 'claims-api',
+  mode: 'external',
+})
+
+async function bootstrap(): Promise<void> {
+  await kafkaManager.provisionTopics([
+    {
+      topic: 'claims.created',
+      numPartitions: 6,
+      replicationFactor: 3,
+    },
+  ])
+
+  await kafkaManager.publish({
+    topic: 'claims.created',
+    key: 'claim-1001',
+    payload: {
+      claimId: 'claim-1001',
+      source: 'claims-api',
+    },
+  })
+
+  await kafkaManager.runConsumer({
+    groupId: 'claims-api-group',
+    topic: 'claims.created',
+    dlqTopic: 'claims.created.dlq',
+    onMessage: async ({ message, headers }) => {
+      console.log('Received event:', {
+        traceId: headers['x-trace-id'],
+        payload: message,
+      })
+    },
+  })
+}
+
+bootstrap().catch(async (error) => {
+  console.error('Kafka bootstrap failed:', error)
+  await kafkaManager.disconnect()
+  process.exit(1)
+})
+
+process.on('SIGINT', async () => {
+  await kafkaManager.disconnect()
+  process.exit(0)
+})
+
+process.on('SIGTERM', async () => {
+  await kafkaManager.disconnect()
+  process.exit(0)
+})
+```
+
 ## Create A Kafka Server With This Repo
 
 This repository already includes a full local Kafka server setup in [docker-compose.yml](/var/www/html/matrix-project/sentinel-kafka-manager/docker-compose.yml) and sample environment values in [.env.local.example](/var/www/html/matrix-project/sentinel-kafka-manager/.env.local.example).
@@ -830,64 +888,6 @@ const kafkaManager = KafkaManager.fromEnv({
 
 This package is designed to work with that exact broker layout.
 
-## Full Service Example
-
-```ts
-import { KafkaManager } from 'sentinel-kafka-manager'
-
-const kafkaManager = KafkaManager.fromEnv({
-  clientId: 'claims-api',
-  mode: 'external',
-})
-
-async function bootstrap(): Promise<void> {
-  await kafkaManager.provisionTopics([
-    {
-      topic: 'claims.created',
-      numPartitions: 6,
-      replicationFactor: 3,
-    },
-  ])
-
-  await kafkaManager.publish({
-    topic: 'claims.created',
-    key: 'claim-1001',
-    payload: {
-      claimId: 'claim-1001',
-      source: 'claims-api',
-    },
-  })
-
-  await kafkaManager.runConsumer({
-    groupId: 'claims-api-group',
-    topic: 'claims.created',
-    dlqTopic: 'claims.created.dlq',
-    onMessage: async ({ message, headers }) => {
-      console.log('Received event:', {
-        traceId: headers['x-trace-id'],
-        payload: message,
-      })
-    },
-  })
-}
-
-bootstrap().catch(async (error) => {
-  console.error('Kafka bootstrap failed:', error)
-  await kafkaManager.disconnect()
-  process.exit(1)
-})
-
-process.on('SIGINT', async () => {
-  await kafkaManager.disconnect()
-  process.exit(0)
-})
-
-process.on('SIGTERM', async () => {
-  await kafkaManager.disconnect()
-  process.exit(0)
-})
-```
-
 ## API Summary
 
 ### `new KafkaManager(options)`
@@ -1160,31 +1160,6 @@ For most SaaS services, the cleanest pattern is:
 5. Catch `KafkaManagerError` and branch on `error.code`.
 6. Wrap service outcomes in `OperationResponse<T>` where useful.
 
-## Publishing This Package
-
-Build:
-
-```bash
-npm run build
-```
-
-Publish:
-
-```bash
-npm publish
-```
-
-If npm rejects the publish:
-
-- `403` usually means authentication, 2FA, or token permission issues
-- `404` usually means the package name is unavailable or not publishable by your account
-
-Useful check:
-
-```bash
-npm whoami
-```
-
 ## Notes
 
 - Your current Kafka cluster works fine with PLAINTEXT, so SSL and SASL are optional unless your environment changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sentinel-kafka-manager",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Reusable Kafka manager for Node.js microservices",
   "main": "dist/index.js",
   "module": "dist/index.mjs",