@hyphen/sdk 1.5.0 → 1.7.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)
@@ -489,7 +492,14 @@ console.log('Boolean toggle value:', result); // true
 Hyphens secret management service known as [ENV](https://hyphen.ai/env) allows you to manage your environment variables in a secure way. The Hyphen Node.js SDK provides a simple way to access your environment variables.
 
 ## Loading Environment Variables
-To load your environment variables, you can use the `loadEnv` function from the SDK. This function will automatically load your environment variables from the `.env` file and then override them with the environment based environment file if it exists (ex: `.env.development`). This is useful for managing different environments such as development, staging, and production.
+To load your environment variables, you can use the `loadEnv` function from the SDK. This function will automatically load your environment variables from the `.env` file and then override them with the environment based environment file if it exists (ex: `.env.development`). This is useful for managing different environments such as development, staging, and production. 
+
+The following override path is:
+```
+.env -> .env.local -> .env.<environment> -> .env.<environment>.local
+```
+
+Here is an example of how to use the `loadEnv` function:
 
 ```javascript
 import { loadEnv } from '@hyphen/sdk';
@@ -514,6 +524,35 @@ import { loadEnv } from '@hyphen/sdk';
 loadEnv({ environment: 'development' });
 ```
 
+if you want to turn off the local environment variables you can do it like this:
+
+```javascript
+import { loadEnv } from '@hyphen/sdk';
+//load your default environment variables and envrionment variables
+loadEnv({ local: false });
+```
+
+# Net Info (https://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)
+* [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);
+```
+
+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:
@@ -551,10 +590,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/dist/index.cjs

@@ -404,6 +404,7 @@ var import_node_fs = __toESM(require("fs"), 1);
 var import_node_path = __toESM(require("path"), 1);
 var import_dotenv2 = require("dotenv");
 function loadEnv(options) {
+  const local = options?.local ?? true;
   const currentWorkingDirectory = options?.path ?? import_node_process2.default.cwd();
   const envPath = import_node_path.default.resolve(currentWorkingDirectory, ".env");
   if (import_node_fs.default.existsSync(envPath)) {
@@ -411,6 +412,15 @@ function loadEnv(options) {
       path: envPath
     });
   }
+  if (local) {
+    const localEnvPath = import_node_path.default.resolve(currentWorkingDirectory, ".env.local");
+    if (import_node_fs.default.existsSync(localEnvPath)) {
+      (0, import_dotenv2.config)({
+        path: localEnvPath,
+        override: true
+      });
+    }
+  }
   const environment = options?.environment ?? import_node_process2.default.env.NODE_ENV;
   if (environment) {
     const envSpecificPath = import_node_path.default.resolve(currentWorkingDirectory, `.env.${environment}`);
@@ -420,6 +430,15 @@ function loadEnv(options) {
         override: true
       });
     }
+    if (local) {
+      const envLocalPath = import_node_path.default.resolve(currentWorkingDirectory, `.env.${environment}.local`);
+      if (import_node_fs.default.existsSync(envLocalPath)) {
+        (0, import_dotenv2.config)({
+          path: envLocalPath,
+          override: true
+        });
+      }
+    }
   }
 }
 __name(loadEnv, "loadEnv");

package/dist/index.d.cts

@@ -205,6 +205,7 @@ declare class Toggle extends Hookified {
 type LoadEnvOptions = {
     path?: string;
     environment?: string;
+    local?: boolean;
 };
 /**
  * @description Helper function to load your environment variables based on your default .env file

package/dist/index.d.ts

@@ -205,6 +205,7 @@ declare class Toggle extends Hookified {
 type LoadEnvOptions = {
     path?: string;
     environment?: string;
+    local?: boolean;
 };
 /**
  * @description Helper function to load your environment variables based on your default .env file

package/dist/index.js

@@ -368,6 +368,7 @@ import fs from "fs";
 import path from "path";
 import { config } from "dotenv";
 function loadEnv(options) {
+  const local = options?.local ?? true;
   const currentWorkingDirectory = options?.path ?? process2.cwd();
   const envPath = path.resolve(currentWorkingDirectory, ".env");
   if (fs.existsSync(envPath)) {
@@ -375,6 +376,15 @@ function loadEnv(options) {
       path: envPath
     });
   }
+  if (local) {
+    const localEnvPath = path.resolve(currentWorkingDirectory, ".env.local");
+    if (fs.existsSync(localEnvPath)) {
+      config({
+        path: localEnvPath,
+        override: true
+      });
+    }
+  }
   const environment = options?.environment ?? process2.env.NODE_ENV;
   if (environment) {
     const envSpecificPath = path.resolve(currentWorkingDirectory, `.env.${environment}`);
@@ -384,6 +394,15 @@ function loadEnv(options) {
         override: true
       });
     }
+    if (local) {
+      const envLocalPath = path.resolve(currentWorkingDirectory, `.env.${environment}.local`);
+      if (fs.existsSync(envLocalPath)) {
+        config({
+          path: envLocalPath,
+          override: true
+        });
+      }
+    }
   }
 }
 __name(loadEnv, "loadEnv");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyphen/sdk",
-  "version": "1.5.0",
+  "version": "1.7.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"
   }
 }