@orion-js/env 3.1.22 → 3.1.23

package/README.md

@@ -0,0 +1,48 @@
+# Orion Env
+
+> This package works as standlaone package. It does not depend on any other orionjs package.
+
+Orion Env is a utility for managing a collection of secrets in source control. The secrets are encrypted using public key, elliptic curve cryptography.
+
+It's like dotEnv but saved in source control.
+
+## Creating a new Env config file
+
+Run the following script in a project that has the package installed. Save the password output because you will need to use it to decrypt the keys.
+
+    yarn orion-env init --path=<path>
+
+## Adding a new env variable
+
+Run the following script in a project that has the package installed and you will be prompted for the variable name and value.
+
+    yarn orion-env add --path=<path>
+
+## Using in your app
+
+Define the following environment variables (in the old way):
+
+- `ORION_ENV_FILE_PATH=<path>` The path to the env file.
+- `ORION_ENV_SECRET_KEY=<password>` The password to decrypt the keys.
+
+Then you can access the variables by importing the package and all the env variables defined will be the env object.
+
+    import {env} from '@orion-js/env'
+
+    env.XX
+
+## Setting environment variables (process.env)
+
+To add backwards compatibility you can also use this libary to set the environment variables.
+
+    import {loadEnv} from '@orion-js/env'
+
+    loadEnv(options)
+
+This will set the environment variables for the current process.
+
+Options:
+
+- `secretKey` Secret password used to decrypt the encrypted env file. Default: process.env.ORION_ENV_SECRET_KEY
+- `envFilePath` Location of the file to read. Default: process.env.ORION_ENV_FILE_PATH
+- `override` Set to true to set the environment variables even if the variable was already set. Default: process.env.ORION_ENV_OVERRIDE

package/lib/environment/index.d.ts

@@ -1,4 +1,5 @@
 export * from './getDts';
+export * from './load';
 export interface Variables {
     [key: string]: string;
 }

package/lib/environment/index.js

@@ -14,6 +14,7 @@ exports.env = exports.readEnv = void 0;
 const getConfig_1 = require("../cli/add/getConfig");
 const getVariables_1 = require("./getVariables");
 __exportStar(require("./getDts"), exports);
+__exportStar(require("./load"), exports);
 let variables = {};
 const g = global;
 const secretKey = process.env.ORION_ENV_SECRET_KEY;

package/lib/environment/load.d.ts

@@ -0,0 +1,6 @@
+export interface LoadEnvOptions {
+    secretKey?: string;
+    envFilePath?: string;
+    override?: boolean;
+}
+export declare function loadEnv(passedOptions?: LoadEnvOptions): void;

package/lib/environment/load.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadEnv = void 0;
+const getConfig_1 = require("../cli/add/getConfig");
+const getVariables_1 = require("./getVariables");
+const defaultOptions = {
+    secretKey: process.env.ORION_ENV_SECRET_KEY,
+    envFilePath: process.env.ORION_ENV_FILE_PATH,
+    override: !!process.env.ORION_ENV_OVERRIDE
+};
+function loadEnv(passedOptions = {}) {
+    const options = { ...defaultOptions, ...passedOptions };
+    const data = (0, getConfig_1.getConfig)(options.envFilePath);
+    const variables = (0, getVariables_1.getVariables)(data, options.secretKey);
+    for (const key in variables) {
+        const variable = variables[key];
+        if (!Object.prototype.hasOwnProperty.call(process.env, key)) {
+            process.env[key] = variable;
+        }
+        else {
+            if (options.override) {
+                process.env[key] = variable;
+            }
+            if (options.override) {
+                console.log(`"${key}" is already defined in \`process.env\` and WAS overwritten`);
+            }
+            else {
+                console.log(`"${key}" is already defined in \`process.env\` and was NOT overwritten`);
+            }
+        }
+    }
+}
+exports.loadEnv = loadEnv;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orion-js/env",
-  "version": "3.1.22",
+  "version": "3.1.23",
   "main": "lib/index.js",
   "author": "nicolaslopezj",
   "license": "MIT",
@@ -31,5 +31,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "51b5af5952a486e40392381f769c69cfdfdc7b5e"
+  "gitHead": "0194171f6f326dfa921cf6e9f341e5b733b7d11e"
 }