@orion-js/env 3.11.8 → 3.12.0

package/package.json

@@ -1,36 +1,43 @@
 {
   "name": "@orion-js/env",
-  "version": "3.11.8",
-  "main": "lib/index.js",
+  "version": "3.12.0",
+  "main": "./dist/index.cjs",
   "author": "nicolaslopezj",
   "license": "MIT",
   "bin": {
     "orion-env": "./lib/cli/index.js"
   },
   "scripts": {
-    "test": "ORION_DEV=1 jest",
-    "prepare": "yarn run build",
-    "clean": "rm -rf ./lib",
-    "build": "yarn run clean && tsc",
-    "watch": "tsc -w",
-    "upgrade-interactive": "yarn upgrade-interactive"
+    "test": "bun test",
+    "clean": "rm -rf ./dist",
+    "build": "bun run build.ts",
+    "dev": "bun --watch src/index.ts"
   },
   "dependencies": {
     "colors": "^1.4.0",
-    "commander": "^9.1.0",
+    "commander": "^9.5.0",
     "prompts": "^2.4.2",
     "tweetnacl": "^1.0.3",
     "tweetnacl-util": "0.15.1",
-    "yaml": "^2.0.0"
+    "yaml": "^2.7.0"
   },
   "devDependencies": {
-    "@types/jest": "^27.0.2",
-    "jest": "27.3.1",
-    "ts-jest": "27.0.7",
-    "typescript": "^4.4.4"
+    "@types/bun": "^1.2.4",
+    "typescript": "^5.8.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "78d70ac414964ec657cc000cedfad8a5efff5cc3"
-}
+  "gitHead": "9d85ab24776533db109843c277324e42c65ddedd",
+  "type": "module",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  },
+  "files": [
+    "dist"
+  ]
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Orionjs Team
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/jest.config.js

@@ -1,8 +0,0 @@
-module.exports = {
-  roots: ['./src'],
-  testMatch: ['**/__tests__/**/*.+(ts|tsx|js)', '**/?(*.)+(spec|test).+(ts|tsx|js)'],
-  transform: {
-    '^.+\\.(ts|tsx)$': 'ts-jest'
-  },
-  verbose: true
-}

package/lib/cli/add/encryptValue.d.ts

@@ -1,2 +0,0 @@
-import { Config } from '../../environment/getVariables';
-export declare const encryptValue: (key: string, value: string, config: Config) => void;

package/lib/cli/add/encryptValue.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.encryptValue = void 0;
-const crypto_1 = require("../../crypto");
-const encryptValue = (key, value, config) => {
-    config.encryptedKeys[key] = (0, crypto_1.encrypt)(config.publicKey, value);
-};
-exports.encryptValue = encryptValue;

package/lib/cli/add/getConfig.d.ts

@@ -1,2 +0,0 @@
-import { Config } from '../../environment/getVariables';
-export declare const getConfig: (envPath: string) => Config;

package/lib/cli/add/getConfig.js

@@ -1,16 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getConfig = void 0;
-const yaml_1 = __importDefault(require("yaml"));
-const files_1 = require("../../files");
-const getConfig = (envPath) => {
-    const configFile = (0, files_1.readFile)(envPath);
-    if (!configFile) {
-        throw new Error('No config file found at path ' + envPath);
-    }
-    return yaml_1.default.parse(configFile);
-};
-exports.getConfig = getConfig;

package/lib/cli/add/getParams.d.ts

@@ -1,5 +0,0 @@
-import { Config } from '../../environment/getVariables';
-export declare const getParams: (config: Config) => Promise<{
-    key: string;
-    value: string;
-}>;

package/lib/cli/add/getParams.js

@@ -1,26 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getParams = void 0;
-const prompts_1 = __importDefault(require("prompts"));
-const getParams = async (config) => {
-    const response = await (0, prompts_1.default)([
-        {
-            type: 'text',
-            name: 'key',
-            message: 'Key'
-        },
-        {
-            type: 'text',
-            name: 'value',
-            message: 'Value'
-        }
-    ]);
-    return {
-        key: response.key,
-        value: response.value
-    };
-};
-exports.getParams = getParams;

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

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

package/lib/cli/add/index.js

@@ -1,38 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const encryptValue_1 = require("./encryptValue");
-const getConfig_1 = require("./getConfig");
-const getParams_1 = require("./getParams");
-const yaml_1 = __importDefault(require("yaml"));
-const files_1 = require("../../files");
-const sortObjectByKeys = (object) => {
-    if (!object)
-        return {};
-    const sorted = {};
-    Object.keys(object)
-        .sort()
-        .forEach(key => {
-        sorted[key] = object[key];
-    });
-    return sorted;
-};
-async function envAdd({ path }) {
-    if (!path) {
-        path = '.env.local.yml';
-    }
-    const config = (0, getConfig_1.getConfig)(path);
-    const { key, value } = await (0, getParams_1.getParams)(config);
-    if (!value)
-        return;
-    (0, encryptValue_1.encryptValue)(key, value, config);
-    // sort keys alphabetically
-    config.cleanKeys = sortObjectByKeys(config.cleanKeys);
-    config.encryptedKeys = sortObjectByKeys(config.encryptedKeys);
-    config.readFromSecret = sortObjectByKeys(config.readFromSecret);
-    const text = yaml_1.default.stringify(config);
-    (0, files_1.writeFile)(path, text);
-}
-exports.default = envAdd;

package/lib/cli/index.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/lib/cli/index.js

@@ -1,43 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const safe_1 = __importDefault(require("colors/safe"));
-const init_1 = __importDefault(require("./init"));
-const add_1 = __importDefault(require("./add"));
-const read_1 = __importDefault(require("./read"));
-const program = new commander_1.Command();
-const run = function (action) {
-    return async function (...args) {
-        try {
-            await action(...args);
-        }
-        catch (e) {
-            console.error(safe_1.default.red('Error: ' + e.message));
-        }
-    };
-};
-program
-    .command('init')
-    .description('Creates a new encrypted env file')
-    .option('--path <path>', 'Specify the env file name')
-    .action(run(init_1.default));
-program
-    .command('add')
-    .description('Adds a new environment to the encrypted env file')
-    .option('--path <path>', 'Specify the env file name')
-    .action(run(add_1.default));
-program
-    .command('read')
-    .description('Prints the value of the env file in JSON or a specific variable in plain text')
-    .option('--path <path>', 'Specify the env file name')
-    .option('--key <key>', 'Prints the value of a specific variable in plain text')
-    .option('--secret <secret>', 'The password to decrypt the keys')
-    .action(run(read_1.default));
-program.parse(process.argv);
-if (!process.argv.slice(2).length) {
-    program.outputHelp();
-}

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

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

package/lib/cli/init/index.js

@@ -1,29 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-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({ path }) {
-    if (!path) {
-        path = '.env.local.yml';
-    }
-    const keypair = (0, crypto_1.generateKeys)();
-    const envFile = {
-        version: '1.0',
-        publicKey: keypair.encryptKey,
-        cleanKeys: {},
-        encryptedKeys: {},
-        readFromSecret: {}
-    };
-    const text = yaml_1.default.stringify(envFile);
-    (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('');
-    console.log(keypair.decryptKey);
-    console.log('');
-}
-exports.default = envInit;

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

@@ -1,5 +0,0 @@
-export default function envRead({ path, key, secret }: {
-    path: any;
-    key: any;
-    secret: any;
-}): Promise<void>;

package/lib/cli/read/index.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const getVariables_1 = require("../../environment/getVariables");
-const getConfig_1 = require("../add/getConfig");
-async function envRead({ path, key, secret }) {
-    if (!path) {
-        path = '.env.local.yml';
-    }
-    if (!secret) {
-        throw new Error('Secret is required');
-    }
-    const config = (0, getConfig_1.getConfig)(path);
-    const variables = (0, getVariables_1.getVariables)(config, secret);
-    if (key) {
-        console.log(variables[key]);
-    }
-    else {
-        console.log(JSON.stringify(variables, null, 2));
-    }
-}
-exports.default = envRead;

package/lib/crypto/index.d.ts

@@ -1,13 +0,0 @@
-export declare function generateKeys(): {
-    encryptKey: string;
-    decryptKey: string;
-};
-/**
- * Creates a temporal keypair just to encrypt one message.
- * Saves the public key in the result so that the message can be decrypted.
- */
-export declare function encrypt(encryptKey: string, message: string): string;
-/**
- * Ecrypts a message using the decrypt key
- */
-export declare function decrypt(decryptKey: string, encrypted: string): string;

package/lib/crypto/index.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.decrypt = exports.encrypt = exports.generateKeys = void 0;
-const tweetnacl_1 = require("./tweetnacl");
-const tweetnacl_util_1 = require("tweetnacl-util");
-function generateKeys() {
-    const { publicKey, secretKey } = (0, tweetnacl_1.generateKeyPair)();
-    const encryptKeyHex = (0, tweetnacl_util_1.encodeBase64)(publicKey);
-    const decryptKeyHex = (0, tweetnacl_util_1.encodeBase64)(secretKey);
-    return {
-        encryptKey: encryptKeyHex,
-        decryptKey: decryptKeyHex
-    };
-}
-exports.generateKeys = generateKeys;
-/**
- * Creates a temporal keypair just to encrypt one message.
- * Saves the public key in the result so that the message can be decrypted.
- */
-function encrypt(encryptKey, message) {
-    const encryptPublicKey = (0, tweetnacl_util_1.decodeBase64)(encryptKey);
-    const tempPair = (0, tweetnacl_1.generateKeyPair)();
-    const encrypted = (0, tweetnacl_1.encrypt)(tempPair.secretKey, encryptPublicKey, message);
-    const hexTempPublic = (0, tweetnacl_util_1.encodeBase64)(tempPair.publicKey);
-    return `${hexTempPublic}:${encrypted}`;
-}
-exports.encrypt = encrypt;
-/**
- * Ecrypts a message using the decrypt key
- */
-function decrypt(decryptKey, encrypted) {
-    const decryptSecretKey = (0, tweetnacl_util_1.decodeBase64)(decryptKey);
-    const [messagePubKeyHex, encryptedMessage] = encrypted.split(':');
-    const messagePubKey = (0, tweetnacl_util_1.decodeBase64)(messagePubKeyHex);
-    return (0, tweetnacl_1.decrypt)(decryptSecretKey, messagePubKey, encryptedMessage);
-}
-exports.decrypt = decrypt;

package/lib/crypto/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/crypto/index.test.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require(".");
-describe('Asymetric encryption lib', () => {
-    it('should generate public and private keys', async () => {
-        const { decryptKey, encryptKey } = (0, _1.generateKeys)();
-        expect(decryptKey.length).toBeGreaterThan(0);
-        expect(encryptKey.length).toBeGreaterThan(0);
-        expect(decryptKey).not.toEqual(encryptKey);
-    });
-    it('should encrypt a message using the encrypt key', async () => {
-        const { encryptKey } = (0, _1.generateKeys)();
-        const encrypted = (0, _1.encrypt)(encryptKey, 'hello');
-        expect(encrypted).toBeTruthy();
-        expect(encrypted.length).toBeGreaterThan(0);
-    });
-    it('should decrypt a message using de decrypt key', async () => {
-        const message = 'hello';
-        const { encryptKey, decryptKey } = (0, _1.generateKeys)();
-        const encrypted = (0, _1.encrypt)(encryptKey, message);
-        const decrypted = (0, _1.decrypt)(decryptKey, encrypted);
-        expect(decrypted).toEqual(message);
-    });
-    it('should not produce two equal encryptions for the same message', async () => {
-        const { encryptKey } = (0, _1.generateKeys)();
-        const encrypted = (0, _1.encrypt)(encryptKey, 'hello');
-        const encrypted2 = (0, _1.encrypt)(encryptKey, 'hello');
-        expect(encrypted).not.toEqual(encrypted2);
-    });
-});

package/lib/crypto/tweetnacl.d.ts

@@ -1,3 +0,0 @@
-export declare const generateKeyPair: () => import("tweetnacl").BoxKeyPair;
-export declare const encrypt: (bSecretKey: Uint8Array, aPublicKey: Uint8Array, message: string) => string;
-export declare const decrypt: (aSecretKey: Uint8Array, bPublicKey: Uint8Array, messageWithNonce: string) => string;

package/lib/crypto/tweetnacl.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.decrypt = exports.encrypt = exports.generateKeyPair = void 0;
-const tweetnacl_1 = require("tweetnacl");
-const tweetnacl_util_1 = require("tweetnacl-util");
-const newNonce = () => (0, tweetnacl_1.randomBytes)(tweetnacl_1.box.nonceLength);
-const generateKeyPair = () => tweetnacl_1.box.keyPair();
-exports.generateKeyPair = generateKeyPair;
-const encrypt = (bSecretKey, aPublicKey, message) => {
-    const nonce = newNonce();
-    const messageUint8 = (0, tweetnacl_util_1.decodeUTF8)(message);
-    const encrypted = (0, tweetnacl_1.box)(messageUint8, nonce, aPublicKey, bSecretKey);
-    const fullMessage = new Uint8Array(nonce.length + encrypted.length);
-    fullMessage.set(nonce);
-    fullMessage.set(encrypted, nonce.length);
-    const base64FullMessage = (0, tweetnacl_util_1.encodeBase64)(fullMessage);
-    return base64FullMessage;
-};
-exports.encrypt = encrypt;
-const decrypt = (aSecretKey, bPublicKey, messageWithNonce) => {
-    const messageWithNonceAsUint8Array = (0, tweetnacl_util_1.decodeBase64)(messageWithNonce);
-    const nonce = messageWithNonceAsUint8Array.slice(0, tweetnacl_1.box.nonceLength);
-    const message = messageWithNonceAsUint8Array.slice(tweetnacl_1.box.nonceLength, messageWithNonce.length);
-    const decrypted = tweetnacl_1.box.open(message, nonce, bPublicKey, aSecretKey);
-    if (!decrypted) {
-        throw new Error('Could not decrypt message');
-    }
-    const base64DecryptedMessage = (0, tweetnacl_util_1.encodeUTF8)(decrypted);
-    return base64DecryptedMessage;
-};
-exports.decrypt = decrypt;

package/lib/environment/getDts.d.ts

@@ -1,4 +0,0 @@
-import { Config } from './getVariables';
-export declare function getDts(config: Config): string;
-export declare function writeDtsFile(config: Config, path: string): void;
-export declare function writeDtsFileFromConfigFile(configFilePath: string, path: string): void;

package/lib/environment/getDts.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeDtsFileFromConfigFile = exports.writeDtsFile = exports.getDts = void 0;
-const getConfig_1 = require("../cli/add/getConfig");
-const files_1 = require("../files");
-function getDts(config) {
-    const keys = [
-        ...Object.keys(config.cleanKeys),
-        ...Object.keys(config.encryptedKeys),
-        ...Object.values(config.readFromSecret).flat()
-    ];
-    return `declare module '@orion-js/env' {
-  export const env: {
-${keys.map(key => `    ${key}: string`).join('\n')}
-  }
-}
-`;
-}
-exports.getDts = getDts;
-function writeDtsFile(config, path) {
-    const currentFile = (0, files_1.readFile)(path);
-    const dts = getDts(config);
-    if (currentFile !== dts) {
-        (0, files_1.writeFile)(path, dts);
-    }
-}
-exports.writeDtsFile = writeDtsFile;
-function writeDtsFileFromConfigFile(configFilePath, path) {
-    const config = (0, getConfig_1.getConfig)(configFilePath);
-    writeDtsFile(config, path);
-}
-exports.writeDtsFileFromConfigFile = writeDtsFileFromConfigFile;

package/lib/environment/getVariables.d.ts

@@ -1,17 +0,0 @@
-export interface Config {
-    version: string;
-    publicKey: string;
-    cleanKeys: {
-        [key: string]: string;
-    };
-    encryptedKeys: {
-        [key: string]: string;
-    };
-    readFromSecret?: {
-        [key: string]: string[];
-    };
-}
-export interface Variables {
-    [key: string]: string;
-}
-export declare function getVariables(config: Config, secretKey?: string): Variables;

package/lib/environment/getVariables.js

@@ -1,58 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getVariables = void 0;
-const crypto_1 = require("../crypto");
-function readSecrets(readFromSecret) {
-    const variables = {};
-    let secretKey = null;
-    if (!readFromSecret)
-        return { variables, secretKey };
-    for (const secretName in readFromSecret) {
-        const keys = readFromSecret[secretName];
-        if (!process.env[secretName]) {
-            console.warn(`@orion/env could not find the secret "${secretName}" in the environment. Related variables will be undefined.`);
-            continue;
-        }
-        try {
-            const values = JSON.parse(process.env[secretName]);
-            if (values.ORION_ENV_SECRET_KEY) {
-                secretKey = values.ORION_ENV_SECRET_KEY;
-            }
-            for (const key of keys) {
-                if (values[key]) {
-                    variables[key] = values[key];
-                }
-                else {
-                    console.warn(`@orion/env could not find the variable "${key}" in the secret "${secretName}". Related variables will be undefined.`);
-                }
-            }
-        }
-        catch (error) {
-            console.warn(`'@orion/env found a the secret "${secretName}" variable in the environment but it is not a valid JSON. Related variables will be undefined.'`);
-        }
-    }
-    return { variables, secretKey: secretKey };
-}
-function getVariables(config, secretKey) {
-    const { cleanKeys, encryptedKeys, readFromSecret } = config;
-    const { variables, secretKey: foundSecretKey } = readSecrets(readFromSecret);
-    let decryptKey = foundSecretKey || secretKey;
-    if (!decryptKey) {
-        throw new Error('Orion encrypted env was passed but process.env.ORION_ENV_SECRET_KEY is not defined');
-    }
-    for (const key in cleanKeys) {
-        const value = cleanKeys[key];
-        variables[key] = value;
-    }
-    for (const key in encryptedKeys) {
-        const encrypted = encryptedKeys[key];
-        try {
-            variables[key] = (0, crypto_1.decrypt)(decryptKey, encrypted);
-        }
-        catch (error) {
-            throw new Error(`Orion encrypted env was passed but process.env.ORION_ENV_SECRET_KEY is not the right key for "${key}"`);
-        }
-    }
-    return variables;
-}
-exports.getVariables = getVariables;

package/lib/environment/index.d.ts

@@ -1,8 +0,0 @@
-export * from './getDts';
-export * from './load';
-export interface Variables {
-    [key: string]: string;
-}
-export declare const readEnv: () => import("./getVariables").Variables;
-declare const env: Variables;
-export { env };

package/lib/environment/index.js

@@ -1,35 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-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;
-const envFilePath = process.env.ORION_ENV_FILE_PATH;
-const readEnv = () => {
-    const data = (0, getConfig_1.getConfig)(envFilePath);
-    return (0, getVariables_1.getVariables)(data, secretKey);
-};
-exports.readEnv = readEnv;
-if (g.__orion_env_final__) {
-    variables = g.__orion_env_final__;
-}
-else if (envFilePath) {
-    variables = (0, exports.readEnv)();
-}
-g.__orion_env_final__ = variables;
-const env = variables;
-exports.env = env;

package/lib/environment/index.test.d.ts

@@ -1 +0,0 @@
-export {};