@hyphen/sdk 1.5.0 → 1.6.0

package/README.md

@@ -489,7 +489,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 +521,14 @@ 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 });
+```
+
 # 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

@@ -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.6.0",
   "description": "Hyphen SDK for Node.js",
   "type": "module",
   "main": "dist/index.cjs",