@dotenvx/dotenvx 1.25.1 → 1.26.0

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.1...main)
+[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.26.0...main)
+
+## [1.26.0](https://github.com/dotenvx/dotenvx/compare/v1.25.2...v1.26.0)
+
+### Added
+
+* add `privateKey` option to `main.parse` method ([#474](https://github.com/dotenvx/dotenvx/pull/474))
+
+## [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)
 

package/README.md

@@ -1859,8 +1859,59 @@ More examples
   ```
 
   </details>
+* <details><summary>`parse(src)`</summary><br>
 
+  Parse a `.env` string directly in node.js code.
 
+  ```js
+  // index.js
+  const dotenvx = require('@dotenvx/dotenvx')
+  const src = 'HELLO=World'
+  const parsed = dotenvx.parse(src)
+  console.log(`Hello ${parsed.HELLO}`)
+  ```
+
+  ```sh
+  $ node index.js
+  Hello World
+  ```
+
+  </details>
+* <details><summary>`parse(src, {processEnv:})`</summary><br>
+
+  Sometimes, you want to run `parse` without it accessing `process.env`. (You can pass a fake processEnv this way as well - sometimes useful.)
+
+  ```js
+  // index.js
+  const dotenvx = require('@dotenvx/dotenvx')
+  const src = 'USER=Me'
+  const parsed = dotenvx.parse(src, { processEnv: {} })
+  console.log(`Hello ${parsed.USER}`)
+  ```
+
+  ```sh
+  $ node index.js
+  Hello Me
+  ```
+
+  </details>
+* <details><summary>`parse(src, {privateKey:})`</summary><br>
+
+  Decrypt an encrypted `.env` string with `privateKey`.
+
+  ```js
+  // index.js
+  const dotenvx = require('@dotenvx/dotenvx')
+  const src = 'HELLO="encrypted:BE9Y7LKANx77X1pv1HnEoil93fPa5c9rpL/1ps48uaRT9zM8VR6mHx9yM+HktKdsPGIZELuZ7rr2mn1gScsmWitppAgE/1lVprNYBCqiYeaTcKXjDUXU5LfsEsflnAsDhT/kWG1l"'
+  const parsed = dotenvx.parse(src, { privateKey: 'a4547dcd9d3429615a3649bb79e87edb62ee6a74b007075e9141ae44f5fb412c' })
+  console.log(`Hello ${parsed.HELLO}`)
+  ```
+
+  ```sh
+  $ node index.js
+  Hello World
+  ```
+  </details>
 
 &nbsp;
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.25.1",
+  "version": "1.26.0",
   "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/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/main.js

@@ -154,12 +154,20 @@ const parse = function (src, options = {}) {
   }
 
   // private decryption key
-  const privateKey = null // implement later
+  const privateKey = options.privateKey || null
 
   // overload
   const overload = options.overload || options.override
 
-  const { parsed } = new Parse(src, privateKey, processEnv, overload).run()
+  const { parsed, errors } = new Parse(src, privateKey, processEnv, overload).run()
+
+  // display any errors
+  for (const error of errors) {
+    console.error(error.message)
+    if (error.help) {
+      console.error(error.help)
+    }
+  }
 
   return parsed
 }