@orion-js/env 3.1.22 → 3.1.25

package/README.md

@@ -0,0 +1,48 @@
+# Orion Env
+
+Orion Env is a utility for managing a collection of secrets in source control. The secrets are encrypted using public key, elliptic curve cryptography.
+
+> This package works as standlaone package. It does not depend on any other orionjs package.
+
+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/cli/add/index.d.ts

@@ -1,3 +1,3 @@
-export default function envAdd({ envPath }: {
-    envPath: any;
+export default function envAdd({ path }: {
+    path: any;
 }): Promise<void>;

package/lib/cli/add/index.js

@@ -17,11 +17,11 @@ const sortObjectByKeys = (object) => {
     });
     return sorted;
 };
-async function envAdd({ envPath }) {
-    if (!envPath) {
-        envPath = '.env.local.yml';
+async function envAdd({ path }) {
+    if (!path) {
+        path = '.env.local.yml';
     }
-    const config = (0, getConfig_1.getConfig)(envPath);
+    const config = (0, getConfig_1.getConfig)(path);
     const { key, value } = await (0, getParams_1.getParams)(config);
     if (!value)
         return;
@@ -30,6 +30,6 @@ async function envAdd({ envPath }) {
     config.cleanKeys = sortObjectByKeys(config.cleanKeys);
     config.encryptedKeys = sortObjectByKeys(config.encryptedKeys);
     const text = yaml_1.default.stringify(config);
-    (0, files_1.writeFile)(envPath, text);
+    (0, files_1.writeFile)(path, text);
 }
 exports.default = envAdd;

package/lib/cli/init/index.d.ts

@@ -1,3 +1,3 @@
-export default function envInit({ envPath }: {
-    envPath: any;
+export default function envInit({ path }: {
+    path: any;
 }): Promise<void>;

package/lib/cli/init/index.js

@@ -6,9 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const yaml_1 = __importDefault(require("yaml"));
 const crypto_1 = require("../../crypto");
 const files_1 = require("../../files");
-async function envInit({ envPath }) {
-    if (!envPath) {
-        envPath = '.env.local.yml';
+async function envInit({ path }) {
+    if (!path) {
+        path = '.env.local.yml';
     }
     const keypair = (0, crypto_1.generateKeys)();
     const envFile = {
@@ -18,7 +18,7 @@ async function envInit({ envPath }) {
         encryptedKeys: {}
     };
     const text = yaml_1.default.stringify(envFile);
-    (0, files_1.writeFile)(envPath, text);
+    (0, files_1.writeFile)(path, text);
     console.log('');
     console.log(`Environment file created. You need to use the following key to decrypt the environment variables:`);
     console.log('');

package/lib/environment/getDts.js

@@ -7,7 +7,7 @@ function getDts(config) {
     const keys = [...Object.keys(config.cleanKeys), ...Object.keys(config.encryptedKeys)];
     return `declare module '@orion-js/env' {
   export const env: {
-${keys.map(key => `    ${key}: string;`).join('\n')}
+${keys.map(key => `    ${key}: string`).join('\n')}
   }
 }
 `;

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.25",
   "main": "lib/index.js",
   "author": "nicolaslopezj",
   "license": "MIT",
@@ -31,5 +31,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "51b5af5952a486e40392381f769c69cfdfdc7b5e"
+  "gitHead": "48f30c51fea96518fab7fedf7643d6493f4f56bc"
 }