@hyphen/sdk 1.3.0 → 1.5.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)
@@ -18,6 +18,7 @@ The Hyphen Node.js SDK is a JavaScript library that allows developers to easily
 	- [Toggle Hooks](#toggle-hooks)
 	- [Toggle Error Handling](#toggle-error-handling)
 	- [Toggle Caching](#toggle-caching)
+	- [Toggle Environment Variables](#toggle-environment-variables)
 	- [Toggle Self-Hosted](#toggle-self-hosted)
 - [Contributing](#contributing)
 - [Testing Your Changes](#testing-your-changes)
@@ -395,6 +396,17 @@ const result = await toggle.getBoolean('hyphen-sdk-boolean', false);
 console.log('Boolean toggle value:', result); // true
 ```
 
+# Toggle Environment Variables
+
+You can also use environment variables to set the `publicApiKey` and `applicationId`. This is useful for keeping your API keys secure and not hardcoding them in your code. To do this just set your `.env` file with the following variables:
+
+```bash
+HYPHEN_PUBLIC_API_KEY=your_public_api_key
+HYPHEN_APPLICATION_ID=your_application_id
+```
+
+On initialization of the `Toggle` class, the SDK will automatically check for these environment variables and use them if they are set. If they are not set, you will need to provide them in the constructor.
+
 ## Toggle Self-Hosted
 
 Toggle uses [Horizon](https://hyphen.ai/horizon) to fetch the feature flags. If you are using a self-hosted version of Hyphen you can use the `uris` option in the constructor to set the url of your self-hosted version:
@@ -472,6 +484,36 @@ 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.
+
+```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' });
+```
+
 # 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,15 +32,18 @@ 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);
 
 // src/toggle.ts
 var import_node_process = __toESM(require("process"), 1);
 var import_hookified = require("hookified");
+var import_dotenv = __toESM(require("dotenv"), 1);
 var import_server_sdk = require("@openfeature/server-sdk");
 var import_openfeature_server_provider = require("@hyphen/openfeature-server-provider");
+import_dotenv.default.config();
 var ToggleHooks = /* @__PURE__ */ function(ToggleHooks2) {
   ToggleHooks2["beforeGetBoolean"] = "beforeGetBoolean";
   ToggleHooks2["afterGetBoolean"] = "afterGetBoolean";
@@ -56,8 +59,8 @@ var Toggle = class extends import_hookified.Hookified {
   static {
     __name(this, "Toggle");
   }
-  _applicationId;
-  _publicApiKey = "";
+  _applicationId = import_node_process.default.env.HYPHEN_APPLICATION_ID;
+  _publicApiKey = import_node_process.default.env.HYPHEN_PUBLIC_API_KEY;
   _environment;
   _client;
   _context;
@@ -70,24 +73,26 @@ var Toggle = class extends import_hookified.Hookified {
   */
   constructor(options) {
     super();
-    this._applicationId = options.applicationId;
-    this.setPublicApiKey(options.publicApiKey);
-    this._environment = options.environment ?? import_node_process.default.env.NODE_ENV ?? "development";
-    this._context = options.context;
-    this._throwErrors = options.throwErrors ?? false;
-    this._uris = options.uris;
-    this._caching = options.caching;
+    this._throwErrors = options?.throwErrors ?? false;
+    this._applicationId = options?.applicationId;
+    if (options?.publicApiKey) {
+      this.setPublicApiKey(options.publicApiKey);
+    }
+    this._environment = options?.environment ?? import_node_process.default.env.NODE_ENV ?? "development";
+    this._context = options?.context;
+    this._uris = options?.uris;
+    this._caching = options?.caching;
   }
   /**
   * Get the application ID
-  * @returns {string}
+  * @returns {string | undefined}
   */
   get applicationId() {
     return this._applicationId;
   }
   /**
   * Set the application ID
-  * @param {string} value
+  * @param {string | undefined} value
   */
   set applicationId(value) {
     this._applicationId = value;
@@ -104,6 +109,11 @@ var Toggle = class extends import_hookified.Hookified {
   * @param {string} value
   */
   set publicApiKey(value) {
+    if (!value) {
+      this._publicApiKey = void 0;
+      this._client = void 0;
+      return;
+    }
     this.setPublicApiKey(value);
   }
   /**
@@ -210,13 +220,27 @@ var Toggle = class extends import_hookified.Hookified {
   */
   async getClient() {
     if (!this._client) {
+      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));
+        if (this._throwErrors) {
+          throw new Error(errorMessage);
+        }
+      }
       const options = {
         application: this._applicationId,
         environment: this._environment,
         horizonUrls: this._uris,
         cache: this._caching
       };
-      await import_server_sdk.OpenFeature.setProviderAndWait(new import_openfeature_server_provider.HyphenProvider(this._publicApiKey, options));
+      if (this._publicApiKey && this._publicApiKey.length > 0) {
+        await import_server_sdk.OpenFeature.setProviderAndWait(new import_openfeature_server_provider.HyphenProvider(this._publicApiKey, options));
+      } else {
+        this.emit("error", new Error("Public API key is not set. You must set it before using the client or have the HYPHEN_PUBLIC_API_KEY environment variable set."));
+        if (this._throwErrors) {
+          throw new Error("Public API key is not set");
+        }
+      }
       this._client = import_server_sdk.OpenFeature.getClient(this._context);
     }
     return this._client;
@@ -373,8 +397,35 @@ 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 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
+    });
+  }
+  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
+      });
+    }
+  }
+}
+__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

@@ -18,15 +18,15 @@ type ToggleCachingOptions = {
 };
 type ToggleOptions = {
     /**
-     * Your application name
+     * Your application name. If this is not set it will look for the HYPHEN_APPLICATION_ID environment variable.
      * @type {string}
      */
-    applicationId: string;
+    applicationId?: string;
     /**
-     * Your Hyphen Public API key
+     * Your Hyphen Public API key. If this is not set it will look for the HYPHEN_PUBLIC_API_KEY environment variable.
      * @type {string}
      */
-    publicApiKey: string;
+    publicApiKey?: string;
     /**
      * Your environment name such as development, production. Default is what is set at NODE_ENV
      * @type {string}
@@ -73,27 +73,27 @@ declare class Toggle extends Hookified {
     private _throwErrors;
     private _uris;
     private _caching;
-    constructor(options: ToggleOptions);
+    constructor(options?: ToggleOptions);
     /**
      * Get the application ID
-     * @returns {string}
+     * @returns {string | undefined}
      */
-    get applicationId(): string;
+    get applicationId(): string | undefined;
     /**
      * Set the application ID
-     * @param {string} value
+     * @param {string | undefined} value
      */
-    set applicationId(value: string);
+    set applicationId(value: string | undefined);
     /**
      * Get the public API key
      * @returns {string}
      */
-    get publicApiKey(): string;
+    get publicApiKey(): string | undefined;
     /**
      * Set the public API key
      * @param {string} value
      */
-    set publicApiKey(value: string);
+    set publicApiKey(value: string | undefined);
     /**
      * Get the environment
      * @returns {string}
@@ -202,4 +202,19 @@ 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;
+};
+/**
+ * @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

@@ -18,15 +18,15 @@ type ToggleCachingOptions = {
 };
 type ToggleOptions = {
     /**
-     * Your application name
+     * Your application name. If this is not set it will look for the HYPHEN_APPLICATION_ID environment variable.
      * @type {string}
      */
-    applicationId: string;
+    applicationId?: string;
     /**
-     * Your Hyphen Public API key
+     * Your Hyphen Public API key. If this is not set it will look for the HYPHEN_PUBLIC_API_KEY environment variable.
      * @type {string}
      */
-    publicApiKey: string;
+    publicApiKey?: string;
     /**
      * Your environment name such as development, production. Default is what is set at NODE_ENV
      * @type {string}
@@ -73,27 +73,27 @@ declare class Toggle extends Hookified {
     private _throwErrors;
     private _uris;
     private _caching;
-    constructor(options: ToggleOptions);
+    constructor(options?: ToggleOptions);
     /**
      * Get the application ID
-     * @returns {string}
+     * @returns {string | undefined}
      */
-    get applicationId(): string;
+    get applicationId(): string | undefined;
     /**
      * Set the application ID
-     * @param {string} value
+     * @param {string | undefined} value
      */
-    set applicationId(value: string);
+    set applicationId(value: string | undefined);
     /**
      * Get the public API key
      * @returns {string}
      */
-    get publicApiKey(): string;
+    get publicApiKey(): string | undefined;
     /**
      * Set the public API key
      * @param {string} value
      */
-    set publicApiKey(value: string);
+    set publicApiKey(value: string | undefined);
     /**
      * Get the environment
      * @returns {string}
@@ -202,4 +202,19 @@ 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;
+};
+/**
+ * @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

@@ -4,8 +4,10 @@ var __name = (target, value) => __defProp(target, "name", { value, configurable:
 // src/toggle.ts
 import process from "process";
 import { Hookified } from "hookified";
+import dotenv from "dotenv";
 import { OpenFeature } from "@openfeature/server-sdk";
 import { HyphenProvider } from "@hyphen/openfeature-server-provider";
+dotenv.config();
 var ToggleHooks = /* @__PURE__ */ function(ToggleHooks2) {
   ToggleHooks2["beforeGetBoolean"] = "beforeGetBoolean";
   ToggleHooks2["afterGetBoolean"] = "afterGetBoolean";
@@ -21,8 +23,8 @@ var Toggle = class extends Hookified {
   static {
     __name(this, "Toggle");
   }
-  _applicationId;
-  _publicApiKey = "";
+  _applicationId = process.env.HYPHEN_APPLICATION_ID;
+  _publicApiKey = process.env.HYPHEN_PUBLIC_API_KEY;
   _environment;
   _client;
   _context;
@@ -35,24 +37,26 @@ var Toggle = class extends Hookified {
   */
   constructor(options) {
     super();
-    this._applicationId = options.applicationId;
-    this.setPublicApiKey(options.publicApiKey);
-    this._environment = options.environment ?? process.env.NODE_ENV ?? "development";
-    this._context = options.context;
-    this._throwErrors = options.throwErrors ?? false;
-    this._uris = options.uris;
-    this._caching = options.caching;
+    this._throwErrors = options?.throwErrors ?? false;
+    this._applicationId = options?.applicationId;
+    if (options?.publicApiKey) {
+      this.setPublicApiKey(options.publicApiKey);
+    }
+    this._environment = options?.environment ?? process.env.NODE_ENV ?? "development";
+    this._context = options?.context;
+    this._uris = options?.uris;
+    this._caching = options?.caching;
   }
   /**
   * Get the application ID
-  * @returns {string}
+  * @returns {string | undefined}
   */
   get applicationId() {
     return this._applicationId;
   }
   /**
   * Set the application ID
-  * @param {string} value
+  * @param {string | undefined} value
   */
   set applicationId(value) {
     this._applicationId = value;
@@ -69,6 +73,11 @@ var Toggle = class extends Hookified {
   * @param {string} value
   */
   set publicApiKey(value) {
+    if (!value) {
+      this._publicApiKey = void 0;
+      this._client = void 0;
+      return;
+    }
     this.setPublicApiKey(value);
   }
   /**
@@ -175,13 +184,27 @@ var Toggle = class extends Hookified {
   */
   async getClient() {
     if (!this._client) {
+      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));
+        if (this._throwErrors) {
+          throw new Error(errorMessage);
+        }
+      }
       const options = {
         application: this._applicationId,
         environment: this._environment,
         horizonUrls: this._uris,
         cache: this._caching
       };
-      await OpenFeature.setProviderAndWait(new HyphenProvider(this._publicApiKey, options));
+      if (this._publicApiKey && this._publicApiKey.length > 0) {
+        await OpenFeature.setProviderAndWait(new HyphenProvider(this._publicApiKey, options));
+      } else {
+        this.emit("error", new Error("Public API key is not set. You must set it before using the client or have the HYPHEN_PUBLIC_API_KEY environment variable set."));
+        if (this._throwErrors) {
+          throw new Error("Public API key is not set");
+        }
+      }
       this._client = OpenFeature.getClient(this._context);
     }
     return this._client;
@@ -338,7 +361,34 @@ 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 currentWorkingDirectory = options?.path ?? process2.cwd();
+  const envPath = path.resolve(currentWorkingDirectory, ".env");
+  if (fs.existsSync(envPath)) {
+    config({
+      path: envPath
+    });
+  }
+  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
+      });
+    }
+  }
+}
+__name(loadEnv, "loadEnv");
 export {
   Toggle,
-  ToggleHooks
+  ToggleHooks,
+  loadEnv
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyphen/sdk",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Hyphen SDK for Node.js",
   "type": "module",
   "main": "dist/index.cjs",
@@ -11,12 +11,12 @@
       "require": "./dist/index.cjs"
     }
   },
-  "types": "dist/node/index.d.ts",
+  "types": "dist/index.d.ts",
   "scripts": {
     "test": "xo --fix && vitest run --coverage",
     "test:ci": "xo && vitest run --coverage",
     "build": "rimraf ./dist && tsup src/index.ts --format esm,cjs --dts --clean",
-    "clean": "rimraf ./dist",
+    "clean": "rimraf ./dist pnpm-lock.yaml node_modules coverage",
     "prepublishOnly": "rimraf ./dist && tsup src/index.ts --format esm,cjs --dts --clean"
   },
   "keywords": [
@@ -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",