@hyphen/sdk 1.6.0 → 1.8.0

package/README.md

@@ -7,7 +7,7 @@
 
 # Hyphen Node.js SDK
 
-The Hyphen Node.js SDK is a JavaScript library that allows developers to easily integrate Hyphen's feature flag service [Toggle](https://hyphen.ai/toggle) into their Node.js applications. In addition to Toggle, the SDK also provides ENV management capabilities such as loading environment variables from `.env` files, managing environment variables.
+The Hyphen Node.js SDK is a JavaScript library that allows developers to easily integrate Hyphen's feature flag service [Toggle](https://hyphen.ai/toggle), secret management service [ENV](https://hyphen.ai/env), and geo information service [Net Info](https://hyphen.ai/net-info) into their Node.js applications.
 
 # Table of Contents
 - [Installation](#installation)
@@ -20,6 +20,9 @@ The Hyphen Node.js SDK is a JavaScript library that allows developers to easily
 	- [Toggle Caching](#toggle-caching)
 	- [Toggle Environment Variables](#toggle-environment-variables)
 	- [Toggle Self-Hosted](#toggle-self-hosted)
+- [ENV](#env)
+	- [Loading Environment Variables](#loading-environment-variables)
+- [Net Info](#net-info)
 - [Contributing](#contributing)
 - [Testing Your Changes](#testing-your-changes)
 - [License and Copyright](#license-and-copyright)
@@ -529,6 +532,40 @@ import { loadEnv } from '@hyphen/sdk';
 loadEnv({ local: false });
 ```
 
+# Net Info
+
+The Hyphen Node.js SDK also provides a `NetInfo` class that allows you to fetch geo information about an IP address. This can be useful for debugging or logging purposes. You can read more about it:
+
+* [Website](https://hyphen.ai/net-info)
+* [https://net.info](https://net.info) - webservice uri used by the SDK
+* [Quick Start Guide](https://docs.hyphen.ai/docs/netinfo-quickstart)
+
+To use the `NetInfo` class, you can do the following:
+
+```javascript
+import { NetInfo } from '@hyphen/sdk';
+const netInfo = new NetInfo({
+  apiKey: 'your_api_key',
+});
+
+const ipInfo = await netInfo.getIpInfo('8.8.8.8');
+console.log('IP Info:', ipInfo);
+```
+
+If you want to fetch information for multiple IP addresses, you can do it like this:
+
+```javascript
+import { NetInfo } from '@hyphen/sdk';
+const netInfo = new NetInfo({
+  apiKey: 'your_api_key',
+});
+const ips = ['8.8.8.8', '1.1.1.1'];
+const ipInfos = await netInfo.getIpInfos(ips);
+console.log('IP Infos:', ipInfos);
+```
+
+You can also set the API key using the `HYPHEN_API_KEY` environment variable. This is useful for keeping your API key secure and not hardcoding it in your code.
+
 # Contributing
 
 We welcome contributions to the Hyphen Node.js SDK! If you have an idea for a new feature, bug fix, or improvement, please follow these steps:
@@ -566,10 +603,13 @@ Once you have created the project, added the toggles, and created your applicati
 
 
 ```bash
-HYPHEN_PUBLIC_API_KEY=your_api_key
+HYPHEN_PUBLIC_API_KEY=your_public_api_key
+HYPHEN_API_KEY=your_api_key
 HYPHEN_APPLICATION_ID=your_project_id
 ```
 
+The `HYPHEN_PUBLIC_API_KEY` is the public API key for your Hyphen project, `HYPHEN_API_KEY` is the API key used for things such as `NetInfo` and is located under settings in the dashboard, and `HYPHEN_APPLICATION_ID` is the application ID for your Hyphen project.
+
 Then run the tests with the following command:
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyphen/sdk",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "description": "Hyphen SDK for Node.js",
   "type": "module",
   "main": "dist/index.cjs",
@@ -46,7 +46,10 @@
   "dependencies": {
     "@hyphen/openfeature-server-provider": "^1.0.7",
     "@openfeature/server-sdk": "^1.18.0",
+    "axios": "^1.10.0",
+    "cacheable": "^1.10.0",
     "dotenv": "^16.5.0",
-    "hookified": "^1.9.0"
+    "hookified": "^1.9.0",
+    "pino": "^9.7.0"
   }
 }