@dotenvx/dotenvx 1.25.0 → 1.25.2

package/CHANGELOG.md

@@ -2,7 +2,23 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.25.0...main)
+[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.25.2...main)
+
+## [1.25.2](https://github.com/dotenvx/dotenvx/compare/v1.25.1...v1.25.2)
+
+### Added
+
+* for binaries add pre-build step using esbuild ([#471](https://github.com/dotenvx/dotenvx/pull/471))
+
+### Removed
+
+* remove types for functions that were removed a while back ([2aa660](https://github.com/dotenvx/dotenvx/commit/2aa660695757143f65751a201115f074b81942a8))
+
+## [1.25.1](https://github.com/dotenvx/dotenvx/compare/v1.25.0...v1.25.1)
+
+### Changed
+
+* improve helpful error messaging around decryption failures by specifying specific key and private key name ([#463](https://github.com/dotenvx/dotenvx/pull/463))
 
 ## [1.25.0](https://github.com/dotenvx/dotenvx/compare/v1.24.5...v1.25.0)
 

package/README.md

@@ -1632,110 +1632,6 @@ More examples
 
   </details>
 
-### config() 📦
-
-* <details><summary>`config()`</summary><br>
-
-  Use directly in node.js code.
-
-  ```ini
-  # .env
-  HELLO="World"
-  ```
-
-  ```js
-  // index.js
-  require('@dotenvx/dotenvx').config()
-
-  console.log(`Hello ${process.env.HELLO}`)
-  ```
-
-  ```sh
-  $ node index.js
-  [dotenvx@1.24.5] injecting env (1) from .env
-  Hello World
-  ```
-
-  </details>
-* <details><summary>`config(path: ['.env.local', '.env'])` - multiple files</summary><br>
-
-  Specify path(s) to multiple .env files.
-
-  ```ini
-  # .env.local
-  HELLO="Me"
-  ```
-
-  ```ini
-  # .env
-  HELLO="World"
-  ```
-
-  ```js
-  // index.js
-  require('@dotenvx/dotenvx').config({path: ['.env.local', '.env']})
-
-  console.log(`Hello ${process.env.HELLO}`)
-  ```
-
-  ```sh
-  $ node index.js
-  [dotenvx@1.24.5] injecting env (1) from .env.local, .env
-  Hello Me
-  ```
-
-  </details>
-* <details><summary>`config(overload: true)` - overload</summary><br>
-
-  User `overload` to overwrite the prior set value.
-
-  ```ini
-  # .env.local
-  HELLO="Me"
-  ```
-
-  ```ini
-  # .env
-  HELLO="World"
-  ```
-
-  ```js
-  // index.js
-  require('@dotenvx/dotenvx').config({path: ['.env.local', '.env'], overload: true})
-
-  console.log(`Hello ${process.env.HELLO}`)
-  ```
-
-  ```sh
-  $ node index.js
-  [dotenvx@1.24.5] injecting env (1) from .env.local, .env
-  Hello World
-  ```
-
-  </details>
-* <details><summary>`config(strict: true)` - strict</summary><br>
-
-  Use `strict` to throw if an error is encountered - like a missing .env file.
-
-  ```ini
-  # .env
-  HELLO="World"
-  ```
-
-  ```js
-  // index.js
-  require('@dotenvx/dotenvx').config({path: ['.env.missing', '.env'], strict: true})
-
-  console.log(`Hello ${process.env.HELLO}`)
-  ```
-
-  ```sh
-  $ node index.js
-  Error: [MISSING_ENV_FILE] missing .env.missing file (/path/to/.env.missing)
-  ```
-
-  </details>
-
 ### Extensions 🔌
 
 * <details><summary>`ext genexample`</summary><br>
@@ -1860,6 +1756,112 @@ More examples
 
   </details>
 
+### config() 📦
+
+* <details><summary>`config()`</summary><br>
+
+  Use directly in node.js code.
+
+  ```ini
+  # .env
+  HELLO="World"
+  ```
+
+  ```js
+  // index.js
+  require('@dotenvx/dotenvx').config()
+
+  console.log(`Hello ${process.env.HELLO}`)
+  ```
+
+  ```sh
+  $ node index.js
+  [dotenvx@1.24.5] injecting env (1) from .env
+  Hello World
+  ```
+
+  </details>
+* <details><summary>`config(path: ['.env.local', '.env'])` - multiple files</summary><br>
+
+  Specify path(s) to multiple .env files.
+
+  ```ini
+  # .env.local
+  HELLO="Me"
+  ```
+
+  ```ini
+  # .env
+  HELLO="World"
+  ```
+
+  ```js
+  // index.js
+  require('@dotenvx/dotenvx').config({path: ['.env.local', '.env']})
+
+  console.log(`Hello ${process.env.HELLO}`)
+  ```
+
+  ```sh
+  $ node index.js
+  [dotenvx@1.24.5] injecting env (1) from .env.local, .env
+  Hello Me
+  ```
+
+  </details>
+* <details><summary>`config(overload: true)` - overload</summary><br>
+
+  User `overload` to overwrite the prior set value.
+
+  ```ini
+  # .env.local
+  HELLO="Me"
+  ```
+
+  ```ini
+  # .env
+  HELLO="World"
+  ```
+
+  ```js
+  // index.js
+  require('@dotenvx/dotenvx').config({path: ['.env.local', '.env'], overload: true})
+
+  console.log(`Hello ${process.env.HELLO}`)
+  ```
+
+  ```sh
+  $ node index.js
+  [dotenvx@1.24.5] injecting env (1) from .env.local, .env
+  Hello World
+  ```
+
+  </details>
+* <details><summary>`config(strict: true)` - strict</summary><br>
+
+  Use `strict` to throw if an error is encountered - like a missing .env file.
+
+  ```ini
+  # .env
+  HELLO="World"
+  ```
+
+  ```js
+  // index.js
+  require('@dotenvx/dotenvx').config({path: ['.env.missing', '.env'], strict: true})
+
+  console.log(`Hello ${process.env.HELLO}`)
+  ```
+
+  ```sh
+  $ node index.js
+  Error: [MISSING_ENV_FILE] missing .env.missing file (/path/to/.env.missing)
+  ```
+
+  </details>
+
+
+
 &nbsp;
 
 ## Guides

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.25.0",
+  "version": "1.25.2",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",
@@ -48,6 +48,7 @@
   "devDependencies": {
     "@yao-pkg/pkg": "^5.14.2",
     "capture-console": "^1.0.2",
+    "esbuild": "^0.24.0",
     "proxyquire": "^2.1.3",
     "sinon": "^14.0.1",
     "standard": "^17.1.0",

package/src/lib/helpers/{decryptValue.js → decryptKeyValue.js}

@@ -1,10 +1,10 @@
 const { decrypt } = require('eciesjs')
 
-const truncate = require('./truncate')
+const Errors = require('./errors')
 
 const PREFIX = 'encrypted:'
 
-function decryptValue (value, privateKey) {
+function decryptKeyValue (key, value, privateKeyName, privateKey) {
   let decryptedValue
   let decryptionError
 
@@ -14,12 +14,11 @@ function decryptValue (value, privateKey) {
 
   privateKey = privateKey || ''
   if (privateKey.length <= 0) {
-    decryptionError = new Error('private key missing or blank')
-    decryptionError.code = 'DECRYPTION_FAILED'
+    decryptionError = new Errors({ key, privateKeyName, privateKey }).missingPrivateKey()
   } else {
     const privateKeys = privateKey.split(',')
-    for (const key of privateKeys) {
-      const secret = Buffer.from(key, 'hex')
+    for (const privKey of privateKeys) {
+      const secret = Buffer.from(privKey, 'hex')
       const encoded = value.substring(PREFIX.length)
       const ciphertext = Buffer.from(encoded, 'base64')
 
@@ -29,16 +28,14 @@ function decryptValue (value, privateKey) {
         break
       } catch (e) {
         if (e.message === 'Invalid private key') {
-          decryptionError = new Error(`private key [${truncate(privateKey)}] looks invalid`)
+          decryptionError = new Errors({ key, privateKeyName, privateKey }).invalidPrivateKey()
         } else if (e.message === 'Unsupported state or unable to authenticate data') {
-          decryptionError = new Error(`private key [${truncate(privateKey)}] looks wrong`)
+          decryptionError = new Errors({ key, privateKeyName, privateKey }).looksWrongPrivateKey()
         } else if (e.message === 'Point of length 65 was invalid. Expected 33 compressed bytes or 65 uncompressed bytes') {
-          decryptionError = new Error('encrypted data looks malformed')
+          decryptionError = new Errors({ key, privateKeyName, privateKey }).malformedEncryptedData()
         } else {
-          decryptionError = new Error(`${e.message}`)
+          decryptionError = new Errors({ key, privateKeyName, privateKey, message: e.message }).decryptionFailed()
         }
-
-        decryptionError.code = 'DECRYPTION_FAILED'
       }
     }
   }
@@ -50,4 +47,4 @@ function decryptValue (value, privateKey) {
   return decryptedValue
 }
 
-module.exports = decryptValue
+module.exports = decryptKeyValue

package/src/lib/helpers/errors.js

@@ -1,9 +1,15 @@
+const truncate = require('./truncate')
+
 class Errors {
   constructor (options = {}) {
     this.filepath = options.filepath
     this.envFilepath = options.envFilepath
 
     this.key = options.key
+    this.privateKey = options.privateKey
+    this.privateKeyName = options.privateKeyName
+
+    this.message = options.message
   }
 
   missingEnvFile () {
@@ -25,6 +31,59 @@ class Errors {
     e.code = code
     return e
   }
+
+  missingPrivateKey () {
+    const code = 'MISSING_PRIVATE_KEY'
+    const message = `[${code}] could not decrypt ${this.key} using private key '${this.privateKeyName}=${truncate(this.privateKey)}'`
+    const help = `[${code}] https://github.com/dotenvx/dotenvx/issues/464`
+
+    const e = new Error(message)
+    e.code = code
+    e.help = help
+    return e
+  }
+
+  invalidPrivateKey () {
+    const code = 'INVALID_PRIVATE_KEY'
+    const message = `[${code}] could not decrypt ${this.key} using private key '${this.privateKeyName}=${truncate(this.privateKey)}'`
+    const help = `[${code}] https://github.com/dotenvx/dotenvx/issues/465`
+
+    const e = new Error(message)
+    e.code = code
+    e.help = help
+    return e
+  }
+
+  looksWrongPrivateKey () {
+    const code = 'WRONG_PRIVATE_KEY'
+    const message = `[${code}] could not decrypt ${this.key} using private key '${this.privateKeyName}=${truncate(this.privateKey)}'`
+    const help = `[${code}] https://github.com/dotenvx/dotenvx/issues/466`
+
+    const e = new Error(message)
+    e.code = code
+    e.help = help
+    return e
+  }
+
+  malformedEncryptedData () {
+    const code = 'MALFORMED_ENCRYPTED_DATA'
+    const message = `[${code}] could not decrypt ${this.key} because encrypted data appears malformed`
+    const help = `[${code}] https://github.com/dotenvx/dotenvx/issues/467`
+
+    const e = new Error(message)
+    e.code = code
+    e.help = help
+    return e
+  }
+
+  decryptionFailed () {
+    const code = 'DECRYPTION_FAILED'
+    const message = this.message
+
+    const e = new Error(message)
+    e.code = code
+    return e
+  }
 }
 
 module.exports = Errors

package/src/lib/helpers/parse.js

@@ -1,15 +1,15 @@
 const chomp = require('./chomp')
-const truncate = require('./truncate')
-const decryptValue = require('./decryptValue')
+const decryptKeyValue = require('./decryptKeyValue')
 const resolveEscapeSequences = require('./resolveEscapeSequences')
 const { execSync } = require('child_process')
 
 class Parse {
   static LINE = /(?:^|^)\s*(?:export\s+)?([\w.-]+)(?:\s*=\s*?|:\s+?)(\s*'(?:\\'|[^'])*'|\s*"(?:\\"|[^"])*"|\s*`(?:\\`|[^`])*`|[^#\r\n]+)?\s*(?:#.*)?(?:$|$)/mg
 
-  constructor (src, privateKey = null, processEnv = process.env, overload = false) {
+  constructor (src, privateKey = null, processEnv = process.env, overload = false, privateKeyName = null) {
     this.src = src
     this.privateKey = privateKey
+    this.privateKeyName = privateKeyName
     this.processEnv = processEnv
     this.overload = overload
 
@@ -40,9 +40,9 @@ class Parse {
 
       // decrypt
       try {
-        this.parsed[key] = this.decrypt(this.parsed[key])
+        this.parsed[key] = this.decrypt(key, this.parsed[key])
       } catch (e) {
-        this.errors.push(this.error(e, key))
+        this.errors.push(e)
       }
 
       // eval empty, double, or backticks
@@ -128,8 +128,8 @@ class Parse {
     return v
   }
 
-  decrypt (value) {
-    return decryptValue(value, this.privateKey)
+  decrypt (key, value) {
+    return decryptKeyValue(key, value, this.privateKeyName, this.privateKey)
   }
 
   eval (value) {
@@ -207,14 +207,6 @@ class Parse {
   getLines () {
     return (this.src || '').toString().replace(/\r\n?/mg, '\n') // Convert buffer to string and Convert line breaks to same format
   }
-
-  error (e, key) {
-    const error = new Error(`[${e.code}] could not decrypt ${key} using private key '${truncate(this.privateKey)}'`)
-    error.code = e.code
-    error.help = `[${e.code}] ? ${e.message}`
-
-    return error
-  }
 }
 
 module.exports = Parse

package/src/lib/main.d.ts

@@ -124,50 +124,6 @@ export interface DotenvPopulateInput {
  */
 export function config(options?: DotenvConfigOptions): DotenvConfigOutput;
 
-/**
- * Decrypt ciphertext
- *
- * @see https://dotenvx.com/docs
- *
- * @param envFile - the encrypted ciphertext string
- * @param key - the decryption key(s)
- */
-export function decrypt(
-  envFile?: string | string[],
-  key?: string | string[]
-): string;
-
-export type EncryptRowOutput = {
-  keys: string[];
-  filepath: string;
-  envFilepath: string;
-  publicKey: string;
-  privateKey: string;
-  privateKeyName: string;
-  privateKeyAdded: boolean;
-  envSrc: string;
-  changed: boolean;
-  error?: Error;
-};
-
-export type EncryptOutput = {
-  processedEnvFiles: EncryptRowOutput[];
-  changedFilepaths: string[];
-  unchangedFilepaths: string[];
-};
-
-/**
- * Encrypt plaintext
- *
- * @see https://dotenvx.com/docs
- * @param envFile - path to the .env file(s)
- * @param key - keys(s) to encrypt env file(s) (default: all keys in .env file)
- */
-export function encrypt(
-  envFile?: string | string[],
-  key?: string | string[]
-): EncryptOutput;
-
 /**
  * List all env files in the current working directory
  *
@@ -181,53 +137,6 @@ export function ls(
   excludeEnvFile: string | string[]
 ): string[];
 
-/**
- * Get the value of a key from the .env file
- *
- * @param [key] - the key to get the value of
- * @param [envs] - the environment(s) to get the value from
- * @param [overload] - whether to overload the value from the .env file
- * @param [DOTENV_KEY] - the decryption key string
- * @param [all] - whether to return all values
- */
-export function get(
-  key?: string,
-  envs?: string[],
-  overload?: boolean,
-  DOTENV_KEY?: string,
-  all?: boolean
-): Record<string, string | undefined> | string | undefined;
-
-export type SetOutput = {
-  key: string;
-  value: string;
-  filepath: string;
-  envFilepath: string;
-  envSrc: string;
-  changed: boolean;
-  encryptedValue?: string;
-  publicKey?: string;
-  privateKey?: string;
-  privateKeyAdded?: boolean;
-  privateKeyName?: string;
-  error?: Error;
-};
-
-/**
- * Set the value of a key in the .env file
- *
- * @param key - the key to set the value of
- * @param value - the value to set
- * @param envFile - the path to the .env file
- * @param [encrypt] - whether to encrypt the value
- */
-export function set(
-  key: string,
-  value: string,
-  envFile: string | string,
-  encrypt?: boolean
-): EncryptOutput;
-
 export type GenExampleOutput = {
   envExampleFile: string;
   envFile: string | string[];

package/src/lib/services/decrypt.js

@@ -8,7 +8,7 @@ const TYPE_ENV_FILE = 'envFile'
 const Errors = require('./../helpers/errors')
 const guessPrivateKeyName = require('./../helpers/guessPrivateKeyName')
 const findPrivateKey = require('./../helpers/findPrivateKey')
-const decryptValue = require('./../helpers/decryptValue')
+const decryptKeyValue = require('./../helpers/decryptKeyValue')
 const isEncrypted = require('./../helpers/isEncrypted')
 const replace = require('./../helpers/replace')
 const detectEncoding = require('./../helpers/detectEncoding')
@@ -86,7 +86,7 @@ class Decrypt {
         if (encrypted) {
           row.keys.push(key) // track key(s)
 
-          const decryptedValue = decryptValue(value, privateKey)
+          const decryptedValue = decryptKeyValue(key, value, privateKeyName, privateKey)
           // once newSrc is built write it out
           envSrc = replace(envSrc, key, decryptedValue)
 

package/src/lib/services/run.js

@@ -12,6 +12,7 @@ const Errors = require('./../helpers/errors')
 const parseEnvironmentFromDotenvKey = require('./../helpers/parseEnvironmentFromDotenvKey')
 const detectEncoding = require('./../helpers/detectEncoding')
 const findPrivateKey = require('./../helpers/findPrivateKey')
+const guessPrivateKeyName = require('./../helpers/guessPrivateKeyName')
 const determineEnvs = require('./../helpers/determineEnvs')
 
 class Run {
@@ -92,7 +93,8 @@ class Run {
       this.readableFilepaths.add(envFilepath)
 
       const privateKey = findPrivateKey(envFilepath)
-      const { parsed, errors, injected, preExisted } = new Parse(src, privateKey, this.processEnv, this.overload).run()
+      const privateKeyName = guessPrivateKeyName(envFilepath)
+      const { parsed, errors, injected, preExisted } = new Parse(src, privateKey, this.processEnv, this.overload, privateKeyName).run()
 
       row.parsed = parsed
       row.errors = errors

package/src/lib/services/sets.js

@@ -8,7 +8,7 @@ const Errors = require('./../helpers/errors')
 const guessPrivateKeyName = require('./../helpers/guessPrivateKeyName')
 const guessPublicKeyName = require('./../helpers/guessPublicKeyName')
 const encryptValue = require('./../helpers/encryptValue')
-const decryptValue = require('./../helpers/decryptValue')
+const decryptKeyValue = require('./../helpers/decryptKeyValue')
 const replace = require('./../helpers/replace')
 const detectEncoding = require('./../helpers/detectEncoding')
 const determineEnvs = require('./../helpers/determineEnvs')
@@ -85,7 +85,7 @@ class Sets {
           privateKey = kp.privateKey
 
           if (row.originalValue) {
-            row.originalValue = decryptValue(row.originalValue, privateKey)
+            row.originalValue = decryptKeyValue(row.key, row.originalValue, privateKeyName, privateKey)
           }
 
           // if derivation doesn't match what's in the file (or preset in env)