@hyphen/sdk 1.4.0 → 1.6.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 flagging and experimentation capabilities into their Node.js applications. With this SDK, you can manage feature flags more effectively, enabling you to control the rollout of new features and conduct A/B testing with ease.
+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.
 
 # Table of Contents
 - [Installation](#installation)
@@ -484,6 +484,51 @@ const result = await toggle.getBoolean('hyphen-sdk-boolean', false);
 console.log('Boolean toggle value:', result); // true
 ```
 
+# ENV
+
+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. 
+
+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';
+
+//load your default environment variables and envrionment variables
+loadEnv();
+```
+
+If your environment variables are not stored in the root of your project you can specify the path to your `.env` file:
+
+```javascript
+import { loadEnv } from '@hyphen/sdk';
+//load your default environment variables and envrionment variables
+loadEnv({ path: '/path/to/your/env/files/' });
+```
+
+You can also specify the environment variables to load by passing an array of variable names:
+
+```javascript
+import { loadEnv } from '@hyphen/sdk';
+//load your default environment variables and envrionment variables
+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 });
+```
+
 # 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:

package/dist/index.cjs

@@ -32,7 +32,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   Toggle: () => Toggle,
-  ToggleHooks: () => ToggleHooks
+  ToggleHooks: () => ToggleHooks,
+  loadEnv: () => loadEnv
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -219,7 +220,6 @@ var Toggle = class extends import_hookified.Hookified {
   */
   async getClient() {
     if (!this._client) {
-      console.log("Application ID:", this._applicationId);
       if (this._applicationId === void 0 || this._applicationId.length === 0) {
         const errorMessage = "Application ID is not set. You must set it before using the client or have the HYPHEN_APPLICATION_ID environment variable set.";
         this.emit("error", new Error(errorMessage));
@@ -397,8 +397,54 @@ var Toggle = class extends import_hookified.Hookified {
     return defaultValue;
   }
 };
+
+// src/env.ts
+var import_node_process2 = __toESM(require("process"), 1);
+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)) {
+    (0, import_dotenv2.config)({
+      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}`);
+    if (import_node_fs.default.existsSync(envSpecificPath)) {
+      (0, import_dotenv2.config)({
+        path: envSpecificPath,
+        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");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Toggle,
-  ToggleHooks
+  ToggleHooks,
+  loadEnv
 });

package/dist/index.d.cts

@@ -202,4 +202,20 @@ declare class Toggle extends Hookified {
     getObject<T>(key: string, defaultValue: T, options?: ToggleGetOptions): Promise<T>;
 }
 
-export { Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions };
+type LoadEnvOptions = {
+    path?: string;
+    environment?: string;
+    local?: boolean;
+};
+/**
+ * @description Helper function to load your environment variables based on your default .env file
+ * and the current environment.
+ * @param {LoadEnvOptions} [options] - Options to customize the loading of environment variables.
+ * @returns {void}
+ * @example
+ * import { loadEnv } from '@hyphen/sdk';
+ * loadEnv();
+ */
+declare function loadEnv(options?: LoadEnvOptions): void;
+
+export { Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, loadEnv };

package/dist/index.d.ts

@@ -202,4 +202,20 @@ declare class Toggle extends Hookified {
     getObject<T>(key: string, defaultValue: T, options?: ToggleGetOptions): Promise<T>;
 }
 
-export { Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions };
+type LoadEnvOptions = {
+    path?: string;
+    environment?: string;
+    local?: boolean;
+};
+/**
+ * @description Helper function to load your environment variables based on your default .env file
+ * and the current environment.
+ * @param {LoadEnvOptions} [options] - Options to customize the loading of environment variables.
+ * @returns {void}
+ * @example
+ * import { loadEnv } from '@hyphen/sdk';
+ * loadEnv();
+ */
+declare function loadEnv(options?: LoadEnvOptions): void;
+
+export { Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, loadEnv };

package/dist/index.js

@@ -184,7 +184,6 @@ var Toggle = class extends Hookified {
   */
   async getClient() {
     if (!this._client) {
-      console.log("Application ID:", this._applicationId);
       if (this._applicationId === void 0 || this._applicationId.length === 0) {
         const errorMessage = "Application ID is not set. You must set it before using the client or have the HYPHEN_APPLICATION_ID environment variable set.";
         this.emit("error", new Error(errorMessage));
@@ -362,7 +361,53 @@ var Toggle = class extends Hookified {
     return defaultValue;
   }
 };
+
+// src/env.ts
+import process2 from "process";
+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)) {
+    config({
+      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}`);
+    if (fs.existsSync(envSpecificPath)) {
+      config({
+        path: envSpecificPath,
+        override: true
+      });
+    }
+    if (local) {
+      const envLocalPath = path.resolve(currentWorkingDirectory, `.env.${environment}.local`);
+      if (fs.existsSync(envLocalPath)) {
+        config({
+          path: envLocalPath,
+          override: true
+        });
+      }
+    }
+  }
+}
+__name(loadEnv, "loadEnv");
 export {
   Toggle,
-  ToggleHooks
+  ToggleHooks,
+  loadEnv
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyphen/sdk",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "Hyphen SDK for Node.js",
   "type": "module",
   "main": "dist/index.cjs",
@@ -37,7 +37,7 @@
     "tsup": "^8.5.0",
     "typescript": "^5.8.3",
     "vitest": "^3.1.4",
-    "xo": "^1.0.0"
+    "xo": "^1.1.0"
   },
   "files": [
     "dist",