@hyphen/sdk 1.3.0 → 1.4.0

package/README.md

@@ -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:

package/dist/index.cjs

@@ -39,8 +39,10 @@ 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 +58,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 +72,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 +108,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 +219,28 @@ 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));
+        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;

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}

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}

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,28 @@ 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));
+        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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyphen/sdk",
-  "version": "1.3.0",
+  "version": "1.4.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": [