@platformatic/foundation 3.15.0 → 3.17.0

package/index.d.ts

@@ -101,6 +101,13 @@ export declare function replaceEnv (
   onMissingEnv?: (key: string) => string | undefined,
   ignore?: string[]
 ): RawConfiguration
+export declare function validate (
+  schema: JSONSchemaType<any>,
+  config: RawConfiguration,
+  validationOptions?: object,
+  fixPaths?: boolean,
+  root?: string
+): void
 export declare function loadConfiguration (
   source: string | RawConfiguration,
   schema?: any,

package/index.js

@@ -1,5 +1,6 @@
 export * from './lib/cli.js'
 export * from './lib/configuration.js'
+export * from './lib/env-file-tool.js'
 export * from './lib/errors.js'
 export * as errors from './lib/errors.js'
 export * from './lib/execution.js'

package/lib/cli.js

@@ -88,6 +88,7 @@ export function logo (color = true) {
 export function createCliLogger (level, noPretty) {
   let pretty
 
+  /* c8 ignore next 3 - Covered elsewhere */
   if (noPretty) {
     setPrettyPrint(false)
   } else {

package/lib/configuration.js

@@ -1,11 +1,11 @@
 import toml from '@iarna/toml'
 import Ajv from 'ajv'
-import { parse as parseEnvFile } from 'dotenv'
 import jsonPatch from 'fast-json-patch'
 import JSON5 from 'json5'
 import { readFile, writeFile } from 'node:fs/promises'
 import { createRequire } from 'node:module'
 import { dirname, extname, isAbsolute, parse, resolve } from 'node:path'
+import { parseEnv } from 'node:util'
 import { parse as rawParseYAML, stringify as stringifyYAML } from 'yaml'
 import {
   AddAModulePropertyToTheConfigOrAddAKnownSchemaError,
@@ -316,6 +316,30 @@ export function createValidator (schema, validationOptions, context = {}) {
   return ajv.compile(schema)
 }
 
+export function validate (schema, config, validationOptions = {}, fixPaths = true, root = '') {
+  const validator = createValidator(schema, validationOptions, { root, fixPaths })
+  const valid = validator(config)
+
+  if (!valid) {
+    const validationErrors = []
+    let errors = ':'
+
+    for (const validationError of validator.errors) {
+      /* c8 ignore next - else */
+      const path = validationError.instancePath === '' ? '/' : validationError.instancePath
+
+      validationErrors.push({ path, message: validationError.message, params: validationError.params })
+      errors += `\n  - ${path}: ${validationError.message}`
+    }
+
+    const error = new ConfigurationDoesNotValidateAgainstSchemaError()
+    error.message += errors + '\n'
+    Object.defineProperty(error, 'validationErrors', { value: validationErrors })
+
+    throw error
+  }
+}
+
 export async function loadEnv (root, ignoreProcessEnv = false, additionalEnv = {}) {
   if (!isAbsolute(root)) {
     root = resolve(process.cwd(), root)
@@ -347,7 +371,7 @@ export async function loadEnv (root, ignoreProcessEnv = false, additionalEnv = {
   }
 
   const baseEnv = ignoreProcessEnv ? {} : process.env
-  const envFromFile = envFile ? parseEnvFile(await readFile(envFile, 'utf-8')) : {}
+  const envFromFile = envFile ? parseEnv(await readFile(envFile, 'utf-8')) : {}
 
   return {
     ...baseEnv,
@@ -411,7 +435,7 @@ export function replaceEnv (config, env, onMissingEnv, ignore) {
 
 export async function loadConfiguration (source, schema, options = {}) {
   const {
-    validate,
+    validate: shouldValidate,
     validationOptions,
     transform,
     upgrade,
@@ -470,32 +494,12 @@ export async function loadConfiguration (source, schema, options = {}) {
     }
   }
 
-  if (validate) {
+  if (shouldValidate) {
     if (typeof schema === 'undefined') {
       throw new SourceMissingError()
     }
 
-    const validator = createValidator(schema, validationOptions, { root, fixPaths })
-    const valid = validator(config)
-
-    if (!valid) {
-      const validationErrors = []
-      let errors = ':'
-
-      for (const validationError of validator.errors) {
-        /* c8 ignore next - else */
-        const path = validationError.instancePath === '' ? '/' : validationError.instancePath
-
-        validationErrors.push({ path, message: validationError.message, params: validationError.params })
-        errors += `\n  - ${path}: ${validationError.message}`
-      }
-
-      const error = new ConfigurationDoesNotValidateAgainstSchemaError()
-      error.message += errors + '\n'
-      Object.defineProperty(error, 'validationErrors', { value: validationErrors })
-
-      throw error
-    }
+    validate(schema, config, validationOptions, fixPaths, root)
   }
 
   if (!skipMetadata) {

package/lib/env-file-tool.js

@@ -0,0 +1,107 @@
+import { existsSync } from 'node:fs'
+import { readFile, writeFile } from 'node:fs/promises'
+import { parseEnv } from 'node:util'
+
+/**
+ * A utility class for programmatically manipulating .env files.
+ * This is a replacement for the dotenv-tool package using native Node.js APIs.
+ */
+export class EnvFileTool {
+  constructor (options = {}) {
+    this.path = options.path
+    this.env = {}
+    this.loaded = false
+  }
+
+  /**
+   * Load the .env file and parse its contents
+   */
+  async load () {
+    if (!existsSync(this.path)) {
+      this.env = {}
+      this.loaded = true
+      return
+    }
+
+    const contents = await readFile(this.path, 'utf-8')
+    this.env = parseEnv(contents)
+    this.loaded = true
+  }
+
+  /**
+   * Save the current environment variables to the .env file
+   */
+  async save () {
+    const lines = []
+    for (const [key, value] of Object.entries(this.env)) {
+      // Escape values that contain special characters
+      const escapedValue = this._escapeValue(value)
+      lines.push(`${key}=${escapedValue}`)
+    }
+    await writeFile(this.path, lines.join('\n') + '\n', { encoding: 'utf-8', flush: true })
+  }
+
+  /**
+   * Get all environment variable keys
+   */
+  getKeys () {
+    return Object.keys(this.env)
+  }
+
+  /**
+   * Check if a key exists
+   */
+  hasKey (key) {
+    return key in this.env
+  }
+
+  /**
+   * Add a new key-value pair
+   */
+  addKey (key, value) {
+    this.env[key] = value
+  }
+
+  /**
+   * Update an existing key's value
+   */
+  updateKey (key, value) {
+    this.env[key] = value
+  }
+
+  /**
+   * Delete a key
+   */
+  deleteKey (key) {
+    delete this.env[key]
+  }
+
+  /**
+   * Get a value by key
+   */
+  getValue (key) {
+    return this.env[key]
+  }
+
+  /**
+   * Escape special characters in environment variable values
+   */
+  _escapeValue (value) {
+    if (typeof value !== 'string') {
+      return value
+    }
+
+    // If the value contains spaces, newlines, or special characters, wrap it in quotes
+    if (/[\s\n\r"'#\\]/.test(value)) {
+      // Escape existing quotes and backslashes
+      const escaped = value.replace(/\\/g, '\\\\').replace(/"/g, '\\"')
+      return `"${escaped}"`
+    }
+
+    return value
+  }
+}
+
+export function createEnvFileTool (options) {
+  return new EnvFileTool(options)
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/foundation",
-  "version": "3.15.0",
+  "version": "3.17.0",
   "description": "Platformatic Foundation",
   "main": "index.js",
   "types": "index.d.ts",
@@ -23,7 +23,6 @@
     "ajv": "^8.12.0",
     "boring-name-generator": "^1.0.3",
     "colorette": "^2.0.19",
-    "dotenv": "^16.4.5",
     "fast-json-patch": "^3.1.1",
     "json5": "^2.2.3",
     "leven": "~3.1.0",