node-consul-service 1.0.44 → 1.0.46

package/README.md

@@ -6,7 +6,7 @@ A robust Node.js service that integrates with HashiCorp Consul for service disco
 - [Features](#features)
 - [Prerequisites](#prerequisites)
 - [Installation](#installation)
-- [Configuration](#configuration)
+- [Initialization](#initialization)
 - [API Documentation](#api-documentation)
 - [Examples](#examples)
 - [Contributing](#contributing)
@@ -35,16 +35,62 @@ npm install node-consul-service
 yarn add node-consul-service
 ```
 
-## Configuration
+## Initialization
 
-Create a `.env` file in your project root with the following variables:
+### Service Initialization
 
-```env
-CONSUL_HOST=your-consul-host
-CONSUL_PORT=8500
-CONSUL_SECURE=false
-CONSUL_TOKEN=your-consul-token  # Optional
-CONSUL_DC=your-datacenter      # Optional
+Before using any functions from the library, you must initialize the client first. You can initialize the client by passing configuration options:
+
+```javascript
+const { initClient } = require('node-consul-service');
+
+await initClient({
+  host: 'localhost',
+  port: 8500,
+  secure: false,
+  token: 'your-token',           // Optional
+  datacenter: 'dc1',            // Optional
+  retryAttempts: 3,             // Number of connection retry attempts
+  retryDelay: 1000              // Delay between retries in milliseconds
+});
+```
+
+### Initialization Features
+
+- **Automatic Retry**: Attempts to connect multiple times on failure
+- **Connection Verification**: Verifies successful connection before proceeding
+- **State Management**: Tracks initialization state to prevent multiple initializations
+- **Error Handling**: Clear and helpful error messages
+
+### Complete Usage Example
+
+```javascript
+const { initClient, registerService } = require('node-consul-service');
+
+async function startService() {
+  try {
+    // Initialize client
+    await initClient({
+      host: 'localhost',
+      port: 8500,
+      retryAttempts: 3
+    });
+
+    // Register service
+    await registerService({
+      name: 'my-service',
+      id: 'my-service-1',
+      port: 3000
+    });
+
+    console.log('✅ Service started successfully');
+  } catch (error) {
+    console.error('❌ Failed to start service:', error);
+    process.exit(1);
+  }
+}
+
+startService();
 ```
 
 ## API Documentation

package/dist/index.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-require('consul');
+var Consul = require('consul');
 var require$$1 = require('util');
 var stream = require('stream');
 var require$$1$1 = require('path');
@@ -14,10 +14,29 @@ var zlib = require('zlib');
 var events = require('events');
 
 // src/lib/client.ts
+let consulClient = null;
+function initClient(config) {
+    var _a;
+    consulClient = new Consul({
+        host: config.host,
+        port: config.port,
+        secure: (_a = config.secure) !== null && _a !== void 0 ? _a : true,
+    });
+    // optional test connection
+    consulClient.agent.self((err) => {
+        if (err) {
+            console.error("❌ Failed to connect to Consul:", err.message);
+        }
+        else {
+            console.log("✅ Connected to Consul successfully");
+        }
+    });
+}
 function getClient() {
-    {
+    if (!consulClient) {
         throw new Error("Consul client not initialized. Call initClient() first.");
     }
+    return consulClient;
 }
 
 const registeredServices = new Set();
@@ -19156,9 +19175,11 @@ exports.DataLinkError = DataLinkError;
 exports.callService = callService;
 exports.dataLink = dataLink;
 exports.deregisterService = deregisterService;
+exports.getClient = getClient;
 exports.getRandomServiceInstance = getRandomServiceInstance;
 exports.getServiceInstances = getServiceInstances;
 exports.getServiceUrl = getServiceUrl;
+exports.initClient = initClient;
 exports.listServices = listServices;
 exports.registerService = registerService;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export * from './consul/client';
 export * from './consul/registry';
 export * from './consul/discovery';
 export * from './consul/httpCaller';

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-import 'consul';
+import Consul from 'consul';
 import require$$1 from 'util';
 import stream, { Readable } from 'stream';
 import require$$1$1 from 'path';
@@ -12,10 +12,29 @@ import zlib from 'zlib';
 import { EventEmitter } from 'events';
 
 // src/lib/client.ts
+let consulClient = null;
+function initClient(config) {
+    var _a;
+    consulClient = new Consul({
+        host: config.host,
+        port: config.port,
+        secure: (_a = config.secure) !== null && _a !== void 0 ? _a : true,
+    });
+    // optional test connection
+    consulClient.agent.self((err) => {
+        if (err) {
+            console.error("❌ Failed to connect to Consul:", err.message);
+        }
+        else {
+            console.log("✅ Connected to Consul successfully");
+        }
+    });
+}
 function getClient() {
-    {
+    if (!consulClient) {
         throw new Error("Consul client not initialized. Call initClient() first.");
     }
+    return consulClient;
 }
 
 const registeredServices = new Set();
@@ -19150,5 +19169,5 @@ async function dataLink(data, schema) {
     return isArray ? result : result[0];
 }
 
-export { DataLinkError, callService, dataLink, deregisterService, getRandomServiceInstance, getServiceInstances, getServiceUrl, listServices, registerService };
+export { DataLinkError, callService, dataLink, deregisterService, getClient, getRandomServiceInstance, getServiceInstances, getServiceUrl, initClient, listServices, registerService };
 //# sourceMappingURL=index.esm.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-consul-service",
-  "version": "1.0.44",
+  "version": "1.0.46",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",