Two-Layer Config Editor for JSON, JSONC & YAML

import { patchContent, setContentValue } from "@powerduck/conf-patch/core";
import { detectFormat } from "@powerduck/conf-patch";

// Patch a config string (works in browser, no fs dependency)
const original = `{"name": "app", "version": "1.0.0"}`;
const patched = patchContent(original, [
  { op: "replace", path: ["version"], value: "2.0.0" },
  { op: "add", path: ["author"], value: "Powerduck" },
], "json");

// Or use the convenience setter
const updated = setContentValue(original, ["version"], "3.0.0", "json");

// Detect format from a file path (by extension)
const format = detectFormat("./config.yaml"); // "yaml"

import { readConfigFile, writeConfigFile, setConfigValue, deleteConfigValue, patchConfigFile, withFileLock } from "@powerduck/conf-patch";

// Read raw config file content (returns string, not parsed object)
const raw = await readConfigFile("./config.yaml");

// Write config file (full WriteConfigOptions shown)
await writeConfigFile("./config.yaml", raw, {
  lock: true,                          // Enable file locking (default: true)
  lockTimeoutMs: 10000,                 // Max wait for lock
  lockRetryDelayMs: 25,                 // Delay between retries
  lockStaleThresholdMs: 30000,          // Lock age before stale
  allowStaleRecovery: false,          // Auto-reclaim stale locks
});

// Set a value by path (auto-detects format from extension)
await setConfigValue("./config.yaml", ["server", "port"], 8080, {
  format: "yaml",                      // Override auto-detection: "json" | "jsonc" | "yaml"
  strict: true,                        // Throw on failed ops (default: true)
  lock: true,                          // Use file lock during write
});

// Delete a value by path
await deleteConfigValue("./config.yaml", ["server", "host"]);

// Batch patch with explicit file lock (full FileLockOptions shown)
await withFileLock(["./config.yaml", "./secrets.json"], async () => {
  await patchConfigFile("./config.yaml", [
    { op: "replace", path: ["server", "port"], value: 9090 },
    { op: "add", path: ["server", "host"], value: "0.0.0.0" },
    { op: "remove", path: ["features", 0] },
  ], { strict: false }); // Non-strict: skip failed ops
}, {
  timeoutMs: 10000,                      // Max wait for all locks
  retryDelayMs: 25,                      // Initial retry delay
  staleThresholdMs: 30000,               // Lock age before stale
  allowStaleRecovery: false,           // Auto-reclaim stale locks
});

import { patchContent } from "@powerduck/conf-patch/core";

const yaml = `server:
  port: 3000
  host: localhost
features:
  - auth
  - logging`;

const result = patchContent(yaml, [
  { op: "replace", path: ["server", "port"], value: 8080 },
  { op: "replace", path: ["features", 1], value: "caching" },
  { op: "remove", path: ["server", "host"] },
], "yaml");

console.log(result);

import { validateOpenAPISpec, validateOpenAPIFile, OpenApiValidationError } from "@powerduck/conf-patch";

// Validate from content string — full ValidateOpenApiOptions shown
const spec = JSON.stringify({ openapi: "3.1.0", info: { title: "API", version: "1.0.0" }, paths: {} });
try {
  const document = await validateOpenAPISpec(spec, {
    inputKind: "content",              // "content" | "file" — auto-detected
    timeoutMs: 30000,                     // Total operation deadline
    maxInputBytes: 10 * 1024 * 1024,     // Max raw input size (10 MB)
    maxDocumentNodes: 100000,             // Max nodes in parsed document
    maxDocumentDepth: 100,                 // Max nested object/array depth
    maxValidationErrors: 100,              // Max errors in error message
    maxErrorMessageLength: 500,            // Max chars per error
  });
  console.log("Valid:", document.openapi);
} catch (error) {
  if (error instanceof OpenApiValidationError) {
    console.error("Invalid spec:", error.code, error.message);
  }
}

// Validate from file — allowedRootDirectory is REQUIRED for security
const fromFile = await validateOpenAPIFile("./openapi.yaml", {
  allowedRootDirectory: "/path/to/project",  // REQUIRED: root dir for file access
  baseFilePath: "/path/to/project/openapi.yaml", // Base for $ref resolution
  timeoutMs: 30000,
});