@dotenvx/dotenvx 1.6.1 → 1.6.2

package/CHANGELOG.md

@@ -2,13 +2,19 @@
 
 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.6.1...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.6.2...main)
+
+## 1.6.2
+
+### Added
+
+* add more detailed type definitions ([#313](https://github.com/dotenvx/dotenvx/pull/313)) 
 
 ## 1.6.1
 
 ### Added
 
-* added support for `.env1` (`.env*`) file format. (private key expands to `DOTENV_PRIVATE_KEY_DEVELOPMENT1`) ([#312](https://github.com/dotenvx/dotenvx/pull/312))
+* add support for `.env1` (`.env*`) file format. (private key expands to `DOTENV_PRIVATE_KEY_DEVELOPMENT1`) ([#312](https://github.com/dotenvx/dotenvx/pull/312))
 
 ## 1.6.0
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.6.1",
+  "version": "1.6.2",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",

package/src/lib/main.d.ts

@@ -35,14 +35,6 @@ export interface DotenvConfigOptions {
    */
   encoding?: string;
 
-  /**
-   * Turn on logging to help debug why certain keys or values are not being set as you expect.
-   *
-   * @default false
-   * @example require('@dotenvx/dotenvx').config({ debug: process.env.DEBUG })
-   */
-  debug?: boolean;
-
   /**
    * Override any environment variables that have already been set on your machine with values from your .env file.
    * @default false
@@ -77,6 +69,40 @@ export interface DotenvConfigOptions {
    * Do not warn for missing .env files
    */
   convention?: string;
+
+  /**
+   * Turn on logging to help debug why certain keys or values are not being set as you expect.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').config({ debug: process.env.DEBUG })
+   */
+  debug?: boolean;
+
+  verbose?: boolean;
+
+  quiet?: boolean;
+
+  logLevel?:
+    | 'error'
+    | 'errorv'
+    | 'errorvp'
+    | 'errorvpb'
+    | 'errornocolor'
+    | 'warn'
+    | 'warnv'
+    | 'warnvp'
+    | 'warnvpb'
+    | 'success'
+    | 'successv'
+    | 'successvp'
+    | 'successvpb'
+    | 'info'
+    | 'help'
+    | 'help2'
+    | 'http'
+    | 'verbose'
+    | 'debug'
+    | 'blank';
 }
 
 export interface DotenvConfigOutput {
@@ -115,10 +141,13 @@ export function configDotenv(options?: DotenvConfigOptions): DotenvConfigOutput;
  *
  * @see https://dotenvx.com/docs
  *
- * @param encrypted - the encrypted ciphertext string
- * @param keyStr - the decryption key string
+ * @param envFile - the encrypted ciphertext string
+ * @param key - the decryption key(s)
  */
-export function decrypt(encrypted: string, keyStr: string): string;
+export function decrypt(
+  envFile?: string | string[],
+  key?: string | string[]
+): string;
 
 export type EncryptRowOutput = {
   keys: string[];
@@ -143,10 +172,13 @@ export type EncryptOutput = {
  * Encrypt plaintext
  *
  * @see https://dotenvx.com/docs
- * @param envFile - path to the .env file
- * @param key - keys(s) to encrypt (default: all keys in .env file)
+ * @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, key: string): EncryptOutput;
+export function encrypt(
+  envFile?: string | string[],
+  key?: string | string[]
+): EncryptOutput;
 
 export type VaultEncryptOutput = {
   dotenvKeys: Record<string, string>;
@@ -158,21 +190,8 @@ export type VaultEncryptOutput = {
   existingVaults: string[];
   addedDotenvFilenames: string[];
   envFile: string | string[];
-  key: string | string[];
 };
 
-/**
- * Encrypt plaintext
- *
- * @see https://dotenvx.com/docs
- * @param directory - current working directory
- * @param envFile - path to the .env file(s)
- */
-export function vaultEncrypt(
-  directory: string,
-  envFile: string | string[]
-): VaultEncryptOutput;
-
 /**
  * List all env files in the current working directory
  *
@@ -284,3 +303,22 @@ type KeyOfSettings = Extract<keyof Settings, string>;
 export function settings(
   key: KeyOfSettings | undefined | null = null
 ): Settings;
+
+/**
+ * Decrypt ciphertext
+ * @param encrypted - the encrypted ciphertext string
+ * @param keyStr - the decryption key string
+ */
+export function vaultDecrypt(encrypted: string, keyStr: string): string;
+
+/**
+ * Encrypt plaintext
+ *
+ * @see https://dotenvx.com/docs
+ * @param directory - current working directory
+ * @param envFile - path to the .env file(s)
+ */
+export function vaultEncrypt(
+  directory?: string,
+  envFile?: string | string[]
+): VaultEncryptOutput;

package/src/lib/services/decrypt.js

@@ -11,6 +11,10 @@ const replace = require('./../helpers/replace')
 const ENCODING = 'utf8'
 
 class Decrypt {
+  /**
+   * @param {string|string[]} [envFile]
+   * @param {string|string[]} [key]
+   **/
   constructor (envFile = '.env', key = []) {
     this.envFile = envFile
     this.key = key

package/src/lib/services/encrypt.js

@@ -12,6 +12,10 @@ const replace = require('./../helpers/replace')
 const ENCODING = 'utf8'
 
 class Encrypt {
+  /**
+   * @param {string|string[]} [envFile]
+   * @param {string|string[]} [key]
+   **/
   constructor (envFile = '.env', key = []) {
     this.envFile = envFile
     this.key = key
@@ -59,8 +63,10 @@ class Encrypt {
         // iterate over all non-encrypted values and encrypt them
         const parsed = dotenv.parse(src)
         for (const [key, value] of Object.entries(parsed)) {
-          if (keys.length < 1 || keys.includes(key)) { // optionally control which key to encrypt
-            const encrypted = isEncrypted(key, value) || isPublicKey(key, value)
+          if (keys.length < 1 || keys.includes(key)) {
+            // optionally control which key to encrypt
+            const encrypted =
+              isEncrypted(key, value) || isPublicKey(key, value)
             if (!encrypted) {
               row.keys.push(key) // track key(s)